diff --git a/app/composer.json b/app/composer.json index a9bf7fe28..7d24106bb 100644 --- a/app/composer.json +++ b/app/composer.json @@ -5,27 +5,29 @@ "type": "project", "license": "Apache 2", "require": { - "php": ">=8.1", + "php": ">=8.2", "ext-intl": "*", "ext-json": "*", "ext-mbstring": "*", "cakephp/authentication": "~3.0", - "cakephp/cakephp": "5.2.*", - "cakephp/migrations": "^4.0.0", + "cakephp/cakephp": "5.3.*", + "cakephp/migrations": "^5.0", "cakephp/plugin-installer": "^2.0", "doctrine/dbal": "^3.10.1", - "league/container": "^4.2.0", + "league/container": "^5.1", "mobiledetect/mobiledetectlib": "^4.8.03", "psr/log": "^3.0", - "symfony/html-sanitizer": "^7.2" + "symfony/html-sanitizer": "^7.4.13" }, "require-dev": { - "cakephp/bake": "^3.0.0", - "cakephp/cakephp-codesniffer": "^5.0", - "cakephp/debug_kit": "^5.0.0", + "cakephp/bake": "^3.6", + "cakephp/cakephp-codesniffer": "^5.3", + "cakephp/debug_kit": "^5.2", + "composer/composer": "^2.9.8", "josegonzalez/dotenv": "^4.0", - "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.1", - "psy/psysh": "@stable" + "phpunit/phpunit": "^11.5.50 || ^12.5.8 || ^13.0", + "psy/psysh": "^0.12.19", + "twig/twig": "^3.27" }, "suggest": { "markstory/asset_compress": "An asset compression plugin which provides file concatenation and a flexible filter system for preprocessing and minification.", diff --git a/app/composer.lock b/app/composer.lock index e457db029..b5b158d69 100644 --- a/app/composer.lock +++ b/app/composer.lock @@ -4,20 +4,20 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "9fe7a17129cc9dbf9c3ad66bbd6c6814", + "content-hash": "3d2092107eba5bf1e3825d696b5903e1", "packages": [ { "name": "cakephp/authentication", - "version": "3.3.2", + "version": "3.3.5", "source": { "type": "git", "url": "https://github.com/cakephp/authentication.git", - "reference": "76e859261832866884b8b8d78dc14e6d22fb3451" + "reference": "9a12edc97de43f95eb4fecf033b623d5b17b436c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/authentication/zipball/76e859261832866884b8b8d78dc14e6d22fb3451", - "reference": "76e859261832866884b8b8d78dc14e6d22fb3451", + "url": "https://api.github.com/repos/cakephp/authentication/zipball/9a12edc97de43f95eb4fecf033b623d5b17b436c", + "reference": "9a12edc97de43f95eb4fecf033b623d5b17b436c", "shasum": "" }, "require": { @@ -33,7 +33,7 @@ "cakephp/cakephp": "^5.1.0", "cakephp/cakephp-codesniffer": "^5.0", "firebase/php-jwt": "^6.2", - "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.0.9" + "phpunit/phpunit": "^10.5.58 || ^11.5.3 || ^12.4" }, "suggest": { "cakephp/cakephp": "Install full core to use \"CookieAuthenticator\".", @@ -72,32 +72,32 @@ "issues": "https://github.com/cakephp/authentication/issues", "source": "https://github.com/cakephp/authentication" }, - "time": "2025-07-30T20:38:32+00:00" + "time": "2026-01-31T00:28:31+00:00" }, { "name": "cakephp/cakephp", - "version": "5.2.7", + "version": "5.3.6", "source": { "type": "git", "url": "https://github.com/cakephp/cakephp.git", - "reference": "6912570c76b7c27410ab7524d119e5a97f851508" + "reference": "cdaca8c3b710789e8545bff5a83194a6b19cad46" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/cakephp/zipball/6912570c76b7c27410ab7524d119e5a97f851508", - "reference": "6912570c76b7c27410ab7524d119e5a97f851508", + "url": "https://api.github.com/repos/cakephp/cakephp/zipball/cdaca8c3b710789e8545bff5a83194a6b19cad46", + "reference": "cdaca8c3b710789e8545bff5a83194a6b19cad46", "shasum": "" }, "require": { - "cakephp/chronos": "^3.1", + "cakephp/chronos": "^3.3", "composer/ca-bundle": "^1.5", "ext-intl": "*", "ext-json": "*", "ext-mbstring": "*", - "laminas/laminas-diactoros": "^3.3", + "laminas/laminas-diactoros": "^3.8", "laminas/laminas-httphandlerrunner": "^2.6", - "league/container": "^4.2", - "php": ">=8.1", + "league/container": "^5.1", + "php": ">=8.2", "psr/container": "^1.1 || ^2.0", "psr/http-client": "^1.0.2", "psr/http-factory": "^1.1", @@ -133,12 +133,12 @@ "cakephp/validation": "self.version" }, "require-dev": { - "cakephp/cakephp-codesniffer": "^5.2", - "http-interop/http-factory-tests": "dev-main", - "mikey179/vfsstream": "^1.6.10", + "cakephp/cakephp-codesniffer": "^5.3", + "http-interop/http-factory-tests": "^2.0", + "mikey179/vfsstream": "^1.6.12", "mockery/mockery": "^1.6", "paragonie/csp-builder": "^2.3 || ^3.0", - "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.0.9" + "phpunit/phpunit": "^11.5.3 || ^12.1.3 || ^13.0" }, "suggest": { "ext-curl": "To enable more efficient network calls in Http\\Client.", @@ -148,7 +148,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-5.next": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } }, "autoload": { @@ -193,20 +193,20 @@ "issues": "https://github.com/cakephp/cakephp/issues", "source": "https://github.com/cakephp/cakephp" }, - "time": "2025-08-31T02:18:16+00:00" + "time": "2026-05-23T16:55:57+00:00" }, { "name": "cakephp/chronos", - "version": "3.2.0", + "version": "3.5.0", "source": { "type": "git", "url": "https://github.com/cakephp/chronos.git", - "reference": "6c820947bc1372a250288ab164ec1b3bb7afab39" + "reference": "e6e777b534244911566face8a5dbdbd7f7bda5a6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/chronos/zipball/6c820947bc1372a250288ab164ec1b3bb7afab39", - "reference": "6c820947bc1372a250288ab164ec1b3bb7afab39", + "url": "https://api.github.com/repos/cakephp/chronos/zipball/e6e777b534244911566face8a5dbdbd7f7bda5a6", + "reference": "e6e777b534244911566face8a5dbdbd7f7bda5a6", "shasum": "" }, "require": { @@ -218,7 +218,7 @@ }, "require-dev": { "cakephp/cakephp-codesniffer": "^5.0", - "phpunit/phpunit": "^10.1.0 || ^11.1.3" + "phpunit/phpunit": "^10.5.58 || ^11.5.3 || ^12.1.3" }, "type": "library", "autoload": { @@ -252,33 +252,33 @@ "issues": "https://github.com/cakephp/chronos/issues", "source": "https://github.com/cakephp/chronos" }, - "time": "2025-06-28T11:35:59+00:00" + "time": "2026-04-10T02:50:39+00:00" }, { "name": "cakephp/migrations", - "version": "4.7.2", + "version": "5.2.0", "source": { "type": "git", "url": "https://github.com/cakephp/migrations.git", - "reference": "69732d98d84b99f9b0a8af94de7dd9ac242aeaff" + "reference": "369d849a540a6815f402447119351ad6fe7894ac" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/migrations/zipball/69732d98d84b99f9b0a8af94de7dd9ac242aeaff", - "reference": "69732d98d84b99f9b0a8af94de7dd9ac242aeaff", + "url": "https://api.github.com/repos/cakephp/migrations/zipball/369d849a540a6815f402447119351ad6fe7894ac", + "reference": "369d849a540a6815f402447119351ad6fe7894ac", "shasum": "" }, "require": { - "cakephp/cache": "^5.2", - "cakephp/orm": "^5.2", - "php": ">=8.1", - "robmorgan/phinx": "^0.16.10" + "cakephp/cache": "^5.3.0", + "cakephp/database": "^5.3.2", + "cakephp/orm": "^5.3.0", + "php": ">=8.2" }, "require-dev": { "cakephp/bake": "^3.3", - "cakephp/cakephp": "^5.2.5", + "cakephp/cakephp": "^5.3.0", "cakephp/cakephp-codesniffer": "^5.0", - "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.2.4" + "phpunit/phpunit": "^11.5.3 || ^12.1.3 || ^13.0" }, "suggest": { "cakephp/bake": "If you want to generate migrations.", @@ -300,7 +300,7 @@ "homepage": "https://github.com/cakephp/migrations/graphs/contributors" } ], - "description": "Database Migration plugin for CakePHP based on Phinx", + "description": "Database Migration plugin for CakePHP", "homepage": "https://github.com/cakephp/migrations", "keywords": [ "cakephp", @@ -313,20 +313,20 @@ "issues": "https://github.com/cakephp/migrations/issues", "source": "https://github.com/cakephp/migrations" }, - "time": "2025-09-01T04:46:50+00:00" + "time": "2026-05-13T14:46:37+00:00" }, { "name": "cakephp/plugin-installer", - "version": "2.0.1", + "version": "2.0.2", "source": { "type": "git", "url": "https://github.com/cakephp/plugin-installer.git", - "reference": "5420701fd47d82fe81805ebee34fbbcef34c52ba" + "reference": "40bfecb4565ab29cd8c34b0d02d0007d2d5ebd2b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/plugin-installer/zipball/5420701fd47d82fe81805ebee34fbbcef34c52ba", - "reference": "5420701fd47d82fe81805ebee34fbbcef34c52ba", + "url": "https://api.github.com/repos/cakephp/plugin-installer/zipball/40bfecb4565ab29cd8c34b0d02d0007d2d5ebd2b", + "reference": "40bfecb4565ab29cd8c34b0d02d0007d2d5ebd2b", "shasum": "" }, "require": { @@ -336,7 +336,7 @@ "require-dev": { "cakephp/cakephp-codesniffer": "^5.0", "composer/composer": "^2.0", - "phpunit/phpunit": "^10.1.0" + "phpunit/phpunit": "^10.1.0 || ^11.1.3 || ^12.0 || ^13.0" }, "type": "composer-plugin", "extra": { @@ -357,25 +357,25 @@ "homepage": "https://cakephp.org" } ], - "description": "A composer installer for CakePHP 3.0+ plugins.", + "description": "A composer installer for CakePHP plugins.", "support": { "issues": "https://github.com/cakephp/plugin-installer/issues", - "source": "https://github.com/cakephp/plugin-installer/tree/2.0.1" + "source": "https://github.com/cakephp/plugin-installer/tree/2.0.2" }, - "time": "2023-09-10T10:02:44+00:00" + "time": "2026-04-10T02:55:04+00:00" }, { "name": "composer/ca-bundle", - "version": "1.5.8", + "version": "1.5.12", "source": { "type": "git", "url": "https://github.com/composer/ca-bundle.git", - "reference": "719026bb30813accb68271fee7e39552a58e9f65" + "reference": "00a2f4201641d5c53f7fc0195e6c8d9fcc321a78" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/composer/ca-bundle/zipball/719026bb30813accb68271fee7e39552a58e9f65", - "reference": "719026bb30813accb68271fee7e39552a58e9f65", + "url": "https://api.github.com/repos/composer/ca-bundle/zipball/00a2f4201641d5c53f7fc0195e6c8d9fcc321a78", + "reference": "00a2f4201641d5c53f7fc0195e6c8d9fcc321a78", "shasum": "" }, "require": { @@ -422,7 +422,7 @@ "support": { "irc": "irc://irc.freenode.org/composer", "issues": "https://github.com/composer/ca-bundle/issues", - "source": "https://github.com/composer/ca-bundle/tree/1.5.8" + "source": "https://github.com/composer/ca-bundle/tree/1.5.12" }, "funding": [ { @@ -434,20 +434,20 @@ "type": "github" } ], - "time": "2025-08-20T18:49:47+00:00" + "time": "2026-05-19T11:26:22+00:00" }, { "name": "doctrine/dbal", - "version": "3.10.2", + "version": "3.10.5", "source": { "type": "git", "url": "https://github.com/doctrine/dbal.git", - "reference": "c6c16cf787eaba3112203dfcd715fa2059c62282" + "reference": "95d84866bf3c04b2ddca1df7c049714660959aef" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/doctrine/dbal/zipball/c6c16cf787eaba3112203dfcd715fa2059c62282", - "reference": "c6c16cf787eaba3112203dfcd715fa2059c62282", + "url": "https://api.github.com/repos/doctrine/dbal/zipball/95d84866bf3c04b2ddca1df7c049714660959aef", + "reference": "95d84866bf3c04b2ddca1df7c049714660959aef", "shasum": "" }, "require": { @@ -463,16 +463,16 @@ }, "require-dev": { "doctrine/cache": "^1.11|^2.0", - "doctrine/coding-standard": "13.0.1", + "doctrine/coding-standard": "14.0.0", "fig/log-test": "^1", "jetbrains/phpstorm-stubs": "2023.1", - "phpstan/phpstan": "2.1.22", + "phpstan/phpstan": "2.1.30", "phpstan/phpstan-strict-rules": "^2", - "phpunit/phpunit": "9.6.23", - "slevomat/coding-standard": "8.16.2", - "squizlabs/php_codesniffer": "3.13.1", - "symfony/cache": "^5.4|^6.0|^7.0", - "symfony/console": "^4.4|^5.4|^6.0|^7.0" + "phpunit/phpunit": "9.6.34", + "slevomat/coding-standard": "8.27.1", + "squizlabs/php_codesniffer": "4.0.1", + "symfony/cache": "^5.4|^6.0|^7.0|^8.0", + "symfony/console": "^4.4|^5.4|^6.0|^7.0|^8.0" }, "suggest": { "symfony/console": "For helpful console commands such as SQL execution and import of files." @@ -532,7 +532,7 @@ ], "support": { "issues": "https://github.com/doctrine/dbal/issues", - "source": "https://github.com/doctrine/dbal/tree/3.10.2" + "source": "https://github.com/doctrine/dbal/tree/3.10.5" }, "funding": [ { @@ -548,33 +548,33 @@ "type": "tidelift" } ], - "time": "2025-09-04T23:51:27+00:00" + "time": "2026-02-24T08:03:57+00:00" }, { "name": "doctrine/deprecations", - "version": "1.1.5", + "version": "1.1.6", "source": { "type": "git", "url": "https://github.com/doctrine/deprecations.git", - "reference": "459c2f5dd3d6a4633d3b5f46ee2b1c40f57d3f38" + "reference": "d4fe3e6fd9bb9e72557a19674f44d8ac7db4c6ca" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/doctrine/deprecations/zipball/459c2f5dd3d6a4633d3b5f46ee2b1c40f57d3f38", - "reference": "459c2f5dd3d6a4633d3b5f46ee2b1c40f57d3f38", + "url": "https://api.github.com/repos/doctrine/deprecations/zipball/d4fe3e6fd9bb9e72557a19674f44d8ac7db4c6ca", + "reference": "d4fe3e6fd9bb9e72557a19674f44d8ac7db4c6ca", "shasum": "" }, "require": { "php": "^7.1 || ^8.0" }, "conflict": { - "phpunit/phpunit": "<=7.5 || >=13" + "phpunit/phpunit": "<=7.5 || >=14" }, "require-dev": { - "doctrine/coding-standard": "^9 || ^12 || ^13", - "phpstan/phpstan": "1.4.10 || 2.1.11", + "doctrine/coding-standard": "^9 || ^12 || ^14", + "phpstan/phpstan": "1.4.10 || 2.1.30", "phpstan/phpstan-phpunit": "^1.0 || ^2", - "phpunit/phpunit": "^7.5 || ^8.5 || ^9.6 || ^10.5 || ^11.5 || ^12", + "phpunit/phpunit": "^7.5 || ^8.5 || ^9.6 || ^10.5 || ^11.5 || ^12.4 || ^13.0", "psr/log": "^1 || ^2 || ^3" }, "suggest": { @@ -594,22 +594,22 @@ "homepage": "https://www.doctrine-project.org/", "support": { "issues": "https://github.com/doctrine/deprecations/issues", - "source": "https://github.com/doctrine/deprecations/tree/1.1.5" + "source": "https://github.com/doctrine/deprecations/tree/1.1.6" }, - "time": "2025-04-07T20:06:18+00:00" + "time": "2026-02-07T07:09:04+00:00" }, { "name": "doctrine/event-manager", - "version": "2.0.1", + "version": "2.1.1", "source": { "type": "git", "url": "https://github.com/doctrine/event-manager.git", - "reference": "b680156fa328f1dfd874fd48c7026c41570b9c6e" + "reference": "dda33921b198841ca8dbad2eaa5d4d34769d18cf" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/doctrine/event-manager/zipball/b680156fa328f1dfd874fd48c7026c41570b9c6e", - "reference": "b680156fa328f1dfd874fd48c7026c41570b9c6e", + "url": "https://api.github.com/repos/doctrine/event-manager/zipball/dda33921b198841ca8dbad2eaa5d4d34769d18cf", + "reference": "dda33921b198841ca8dbad2eaa5d4d34769d18cf", "shasum": "" }, "require": { @@ -619,10 +619,10 @@ "doctrine/common": "<2.9" }, "require-dev": { - "doctrine/coding-standard": "^12", - "phpstan/phpstan": "^1.8.8", - "phpunit/phpunit": "^10.5", - "vimeo/psalm": "^5.24" + "doctrine/coding-standard": "^14", + "phpdocumentor/guides-cli": "^1.4", + "phpstan/phpstan": "^2.1.32", + "phpunit/phpunit": "^10.5.58" }, "type": "library", "autoload": { @@ -671,7 +671,7 @@ ], "support": { "issues": "https://github.com/doctrine/event-manager/issues", - "source": "https://github.com/doctrine/event-manager/tree/2.0.1" + "source": "https://github.com/doctrine/event-manager/tree/2.1.1" }, "funding": [ { @@ -687,24 +687,24 @@ "type": "tidelift" } ], - "time": "2024-05-22T20:47:39+00:00" + "time": "2026-01-29T07:11:08+00:00" }, { "name": "laminas/laminas-diactoros", - "version": "3.6.0", + "version": "3.8.0", "source": { "type": "git", "url": "https://github.com/laminas/laminas-diactoros.git", - "reference": "b068eac123f21c0e592de41deeb7403b88e0a89f" + "reference": "60c182916b2749480895601649563970f3f12ec4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/laminas/laminas-diactoros/zipball/b068eac123f21c0e592de41deeb7403b88e0a89f", - "reference": "b068eac123f21c0e592de41deeb7403b88e0a89f", + "url": "https://api.github.com/repos/laminas/laminas-diactoros/zipball/60c182916b2749480895601649563970f3f12ec4", + "reference": "60c182916b2749480895601649563970f3f12ec4", "shasum": "" }, "require": { - "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0", + "php": "~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0", "psr/http-factory": "^1.1", "psr/http-message": "^1.1 || ^2.0" }, @@ -721,11 +721,11 @@ "ext-gd": "*", "ext-libxml": "*", "http-interop/http-factory-tests": "^2.2.0", - "laminas/laminas-coding-standard": "~3.0.0", + "laminas/laminas-coding-standard": "~3.1.0", "php-http/psr7-integration-tests": "^1.4.0", "phpunit/phpunit": "^10.5.36", - "psalm/plugin-phpunit": "^0.19.0", - "vimeo/psalm": "^5.26.1" + "psalm/plugin-phpunit": "^0.19.5", + "vimeo/psalm": "^6.13" }, "type": "library", "extra": { @@ -775,24 +775,24 @@ "type": "community_bridge" } ], - "time": "2025-05-05T16:03:34+00:00" + "time": "2025-10-12T15:31:36+00:00" }, { "name": "laminas/laminas-httphandlerrunner", - "version": "2.12.0", + "version": "2.13.0", "source": { "type": "git", "url": "https://github.com/laminas/laminas-httphandlerrunner.git", - "reference": "b14da3519c650e9436e410cfedee6f860312eff9" + "reference": "181eaeeb838ad3d80fbbcfb0657a46bc212bbd4e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/laminas/laminas-httphandlerrunner/zipball/b14da3519c650e9436e410cfedee6f860312eff9", - "reference": "b14da3519c650e9436e410cfedee6f860312eff9", + "url": "https://api.github.com/repos/laminas/laminas-httphandlerrunner/zipball/181eaeeb838ad3d80fbbcfb0657a46bc212bbd4e", + "reference": "181eaeeb838ad3d80fbbcfb0657a46bc212bbd4e", "shasum": "" }, "require": { - "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0", + "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0 || ~8.5.0", "psr/http-message": "^1.0 || ^2.0", "psr/http-message-implementation": "^1.0 || ^2.0", "psr/http-server-handler": "^1.0" @@ -842,25 +842,26 @@ "type": "community_bridge" } ], - "time": "2025-05-13T21:21:16+00:00" + "time": "2025-10-12T20:58:29+00:00" }, { "name": "league/container", - "version": "4.2.5", + "version": "5.2.0", "source": { "type": "git", "url": "https://github.com/thephpleague/container.git", - "reference": "d3cebb0ff4685ff61c749e54b27db49319e2ec00" + "reference": "58accbc032f0090a9bd08326f93062c5a658b2c5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/thephpleague/container/zipball/d3cebb0ff4685ff61c749e54b27db49319e2ec00", - "reference": "d3cebb0ff4685ff61c749e54b27db49319e2ec00", + "url": "https://api.github.com/repos/thephpleague/container/zipball/58accbc032f0090a9bd08326f93062c5a658b2c5", + "reference": "58accbc032f0090a9bd08326f93062c5a658b2c5", "shasum": "" }, "require": { - "php": "^7.2 || ^8.0", - "psr/container": "^1.1 || ^2.0" + "php": "^8.1", + "psr/container": "^2.0.2", + "psr/event-dispatcher": "^1.0" }, "provide": { "psr/container-implementation": "^1.0" @@ -869,13 +870,13 @@ "orno/di": "~2.0" }, "require-dev": { - "nette/php-generator": "^3.4", - "nikic/php-parser": "^4.10", - "phpstan/phpstan": "^0.12.47", - "phpunit/phpunit": "^8.5.17", + "nette/php-generator": "^4.1", + "nikic/php-parser": "^5.0", + "phpstan/phpstan": "^2.1.11", + "phpunit/phpunit": "^10.5.45|^11.5.15|^12.0", "roave/security-advisories": "dev-latest", - "scrutinizer/ocular": "^1.8", - "squizlabs/php_codesniffer": "^3.6" + "scrutinizer/ocular": "^1.9", + "squizlabs/php_codesniffer": "^3.9" }, "type": "library", "extra": { @@ -884,7 +885,8 @@ "dev-2.x": "2.x-dev", "dev-3.x": "3.x-dev", "dev-4.x": "4.x-dev", - "dev-master": "4.x-dev" + "dev-5.x": "5.x-dev", + "dev-master": "5.x-dev" } }, "autoload": { @@ -916,7 +918,7 @@ ], "support": { "issues": "https://github.com/thephpleague/container/issues", - "source": "https://github.com/thephpleague/container/tree/4.2.5" + "source": "https://github.com/thephpleague/container/tree/5.2.0" }, "funding": [ { @@ -924,37 +926,42 @@ "type": "github" } ], - "time": "2025-05-20T12:55:37+00:00" + "time": "2026-03-19T18:52:39+00:00" }, { "name": "league/uri", - "version": "7.5.1", + "version": "7.8.1", "source": { "type": "git", "url": "https://github.com/thephpleague/uri.git", - "reference": "81fb5145d2644324614cc532b28efd0215bda430" + "reference": "08cf38e3924d4f56238125547b5720496fac8fd4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/thephpleague/uri/zipball/81fb5145d2644324614cc532b28efd0215bda430", - "reference": "81fb5145d2644324614cc532b28efd0215bda430", + "url": "https://api.github.com/repos/thephpleague/uri/zipball/08cf38e3924d4f56238125547b5720496fac8fd4", + "reference": "08cf38e3924d4f56238125547b5720496fac8fd4", "shasum": "" }, "require": { - "league/uri-interfaces": "^7.5", - "php": "^8.1" + "league/uri-interfaces": "^7.8.1", + "php": "^8.1", + "psr/http-factory": "^1" }, "conflict": { "league/uri-schemes": "^1.0" }, "suggest": { "ext-bcmath": "to improve IPV4 host parsing", + "ext-dom": "to convert the URI into an HTML anchor tag", "ext-fileinfo": "to create Data URI from file contennts", "ext-gmp": "to improve IPV4 host parsing", "ext-intl": "to handle IDN host with the best performance", - "jeremykendall/php-domain-parser": "to resolve Public Suffix and Top Level Domain", - "league/uri-components": "Needed to easily manipulate URI objects components", + "ext-uri": "to use the PHP native URI class", + "jeremykendall/php-domain-parser": "to further parse the URI host and resolve its Public Suffix and Top Level Domain", + "league/uri-components": "to provide additional tools to manipulate URI objects components", + "league/uri-polyfill": "to backport the PHP URI extension for older versions of PHP", "php-64bit": "to improve IPV4 host parsing", + "rowbot/url": "to handle URLs using the WHATWG URL Living Standard specification", "symfony/polyfill-intl-idn": "to handle IDN host via the Symfony polyfill if ext-intl is not present" }, "type": "library", @@ -982,6 +989,7 @@ "description": "URI manipulation library", "homepage": "https://uri.thephpleague.com", "keywords": [ + "URN", "data-uri", "file-uri", "ftp", @@ -994,9 +1002,11 @@ "psr-7", "query-string", "querystring", + "rfc2141", "rfc3986", "rfc3987", "rfc6570", + "rfc8141", "uri", "uri-template", "url", @@ -1006,7 +1016,7 @@ "docs": "https://uri.thephpleague.com", "forum": "https://thephpleague.slack.com", "issues": "https://github.com/thephpleague/uri-src/issues", - "source": "https://github.com/thephpleague/uri/tree/7.5.1" + "source": "https://github.com/thephpleague/uri/tree/7.8.1" }, "funding": [ { @@ -1014,26 +1024,25 @@ "type": "github" } ], - "time": "2024-12-08T08:40:02+00:00" + "time": "2026-03-15T20:22:25+00:00" }, { "name": "league/uri-interfaces", - "version": "7.5.0", + "version": "7.8.1", "source": { "type": "git", "url": "https://github.com/thephpleague/uri-interfaces.git", - "reference": "08cfc6c4f3d811584fb09c37e2849e6a7f9b0742" + "reference": "85d5c77c5d6d3af6c54db4a78246364908f3c928" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/thephpleague/uri-interfaces/zipball/08cfc6c4f3d811584fb09c37e2849e6a7f9b0742", - "reference": "08cfc6c4f3d811584fb09c37e2849e6a7f9b0742", + "url": "https://api.github.com/repos/thephpleague/uri-interfaces/zipball/85d5c77c5d6d3af6c54db4a78246364908f3c928", + "reference": "85d5c77c5d6d3af6c54db4a78246364908f3c928", "shasum": "" }, "require": { "ext-filter": "*", "php": "^8.1", - "psr/http-factory": "^1", "psr/http-message": "^1.1 || ^2.0" }, "suggest": { @@ -1041,6 +1050,7 @@ "ext-gmp": "to improve IPV4 host parsing", "ext-intl": "to handle IDN host with the best performance", "php-64bit": "to improve IPV4 host parsing", + "rowbot/url": "to handle URLs using the WHATWG URL Living Standard specification", "symfony/polyfill-intl-idn": "to handle IDN host via the Symfony polyfill if ext-intl is not present" }, "type": "library", @@ -1065,7 +1075,7 @@ "homepage": "https://nyamsprod.com" } ], - "description": "Common interfaces and classes for URI representation and interaction", + "description": "Common tools for parsing and resolving RFC3987/RFC3986 URI", "homepage": "https://uri.thephpleague.com", "keywords": [ "data-uri", @@ -1090,7 +1100,7 @@ "docs": "https://uri.thephpleague.com", "forum": "https://thephpleague.slack.com", "issues": "https://github.com/thephpleague/uri-src/issues", - "source": "https://github.com/thephpleague/uri-interfaces/tree/7.5.0" + "source": "https://github.com/thephpleague/uri-interfaces/tree/7.8.1" }, "funding": [ { @@ -1098,7 +1108,7 @@ "type": "github" } ], - "time": "2024-12-08T08:18:47+00:00" + "time": "2026-03-08T20:05:35+00:00" }, { "name": "masterminds/html5", @@ -1169,29 +1179,28 @@ }, { "name": "mobiledetect/mobiledetectlib", - "version": "4.8.09", + "version": "4.10.0", "source": { "type": "git", "url": "https://github.com/serbanghita/Mobile-Detect.git", - "reference": "a06fe2e546a06bb8c2639d6823d5250b2efb3209" + "reference": "1473bd9d6aa40158f75f1e05116e6dd081148b2c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/serbanghita/Mobile-Detect/zipball/a06fe2e546a06bb8c2639d6823d5250b2efb3209", - "reference": "a06fe2e546a06bb8c2639d6823d5250b2efb3209", + "url": "https://api.github.com/repos/serbanghita/Mobile-Detect/zipball/1473bd9d6aa40158f75f1e05116e6dd081148b2c", + "reference": "1473bd9d6aa40158f75f1e05116e6dd081148b2c", "shasum": "" }, "require": { - "php": ">=8.0", - "psr/cache": "^3.0", - "psr/simple-cache": "^3" + "php": ">=8.2", + "psr/simple-cache": "^1.0 || ^2.0 || ^3.0" }, "require-dev": { - "friendsofphp/php-cs-fixer": "^v3.65.0", - "phpbench/phpbench": "^1.2", - "phpstan/phpstan": "^1.12.x-dev", - "phpunit/phpunit": "^9.6.18", - "squizlabs/php_codesniffer": "^3.11.1" + "friendsofphp/php-cs-fixer": "3.95.1", + "phpbench/phpbench": "1.6.1", + "phpstan/phpstan": "2.1.47", + "phpunit/phpunit": "9.6.34", + "squizlabs/php_codesniffer": "3.13.5" }, "type": "library", "autoload": { @@ -1222,7 +1231,7 @@ ], "support": { "issues": "https://github.com/serbanghita/Mobile-Detect/issues", - "source": "https://github.com/serbanghita/Mobile-Detect/tree/4.8.09" + "source": "https://github.com/serbanghita/Mobile-Detect/tree/4.10.0" }, "funding": [ { @@ -1230,7 +1239,7 @@ "type": "github" } ], - "time": "2024-12-10T15:32:06+00:00" + "time": "2026-04-23T13:05:57+00:00" }, { "name": "psr/cache", @@ -1382,6 +1391,56 @@ }, "time": "2021-11-05T16:47:00+00:00" }, + { + "name": "psr/event-dispatcher", + "version": "1.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/event-dispatcher.git", + "reference": "dbefd12671e8a14ec7f180cab83036ed26714bb0" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/event-dispatcher/zipball/dbefd12671e8a14ec7f180cab83036ed26714bb0", + "reference": "dbefd12671e8a14ec7f180cab83036ed26714bb0", + "shasum": "" + }, + "require": { + "php": ">=7.2.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\EventDispatcher\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "description": "Standard interfaces for event handling.", + "keywords": [ + "events", + "psr", + "psr-14" + ], + "support": { + "issues": "https://github.com/php-fig/event-dispatcher/issues", + "source": "https://github.com/php-fig/event-dispatcher/tree/1.0.0" + }, + "time": "2019-01-08T18:20:26+00:00" + }, { "name": "psr/http-client", "version": "1.0.3", @@ -1757,130 +1816,35 @@ "time": "2021-10-29T13:26:27+00:00" }, { - "name": "robmorgan/phinx", - "version": "0.16.10", + "name": "symfony/deprecation-contracts", + "version": "v3.7.0", "source": { "type": "git", - "url": "https://github.com/cakephp/phinx.git", - "reference": "83f83ec105e55e3abba7acc23c0272b5fcf66929" + "url": "https://github.com/symfony/deprecation-contracts.git", + "reference": "50f59d1f3ca46d41ac911f97a78626b6756af35b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/phinx/zipball/83f83ec105e55e3abba7acc23c0272b5fcf66929", - "reference": "83f83ec105e55e3abba7acc23c0272b5fcf66929", + "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/50f59d1f3ca46d41ac911f97a78626b6756af35b", + "reference": "50f59d1f3ca46d41ac911f97a78626b6756af35b", "shasum": "" }, "require": { - "cakephp/database": "^5.0.2", - "composer-runtime-api": "^2.0", - "php-64bit": ">=8.1", - "psr/container": "^1.1|^2.0", - "symfony/config": "^4.0|^5.0|^6.0|^7.0", - "symfony/console": "^6.0|^7.0" - }, - "require-dev": { - "cakephp/cakephp-codesniffer": "^5.0", - "cakephp/i18n": "^5.0", - "ext-json": "*", - "ext-pdo": "*", - "phpunit/phpunit": "^9.5.19", - "symfony/yaml": "^4.0|^5.0|^6.0|^7.0" - }, - "suggest": { - "ext-json": "Install if using JSON configuration format", - "ext-pdo": "PDO extension is needed", - "symfony/yaml": "Install if using YAML configuration format" + "php": ">=8.1" }, - "bin": [ - "bin/phinx" - ], "type": "library", - "autoload": { - "psr-4": { - "Phinx\\": "src/Phinx/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Rob Morgan", - "email": "robbym@gmail.com", - "homepage": "https://robmorgan.id.au", - "role": "Lead Developer" - }, - { - "name": "Woody Gilk", - "email": "woody.gilk@gmail.com", - "homepage": "https://shadowhand.me", - "role": "Developer" - }, - { - "name": "Richard Quadling", - "email": "rquadling@gmail.com", - "role": "Developer" + "extra": { + "thanks": { + "url": "https://github.com/symfony/contracts", + "name": "symfony/contracts" }, - { - "name": "CakePHP Community", - "homepage": "https://github.com/cakephp/phinx/graphs/contributors", - "role": "Developer" + "branch-alias": { + "dev-main": "3.7-dev" } - ], - "description": "Phinx makes it ridiculously easy to manage the database migrations for your PHP app.", - "homepage": "https://phinx.org", - "keywords": [ - "database", - "database migrations", - "db", - "migrations", - "phinx" - ], - "support": { - "issues": "https://github.com/cakephp/phinx/issues", - "source": "https://github.com/cakephp/phinx/tree/0.16.10" - }, - "time": "2025-07-08T18:55:28+00:00" - }, - { - "name": "symfony/config", - "version": "v7.3.2", - "source": { - "type": "git", - "url": "https://github.com/symfony/config.git", - "reference": "faef36e271bbeb74a9d733be4b56419b157762e2" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/config/zipball/faef36e271bbeb74a9d733be4b56419b157762e2", - "reference": "faef36e271bbeb74a9d733be4b56419b157762e2", - "shasum": "" - }, - "require": { - "php": ">=8.2", - "symfony/deprecation-contracts": "^2.5|^3", - "symfony/filesystem": "^7.1", - "symfony/polyfill-ctype": "~1.8" - }, - "conflict": { - "symfony/finder": "<6.4", - "symfony/service-contracts": "<2.5" - }, - "require-dev": { - "symfony/event-dispatcher": "^6.4|^7.0", - "symfony/finder": "^6.4|^7.0", - "symfony/messenger": "^6.4|^7.0", - "symfony/service-contracts": "^2.5|^3", - "symfony/yaml": "^6.4|^7.0" }, - "type": "library", "autoload": { - "psr-4": { - "Symfony\\Component\\Config\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" + "files": [ + "function.php" ] }, "notification-url": "https://packagist.org/downloads/", @@ -1889,18 +1853,18 @@ ], "authors": [ { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" + "name": "Nicolas Grekas", + "email": "p@tchwork.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], - "description": "Helps you find, load, combine, autofill and validate configuration values of any kind", + "description": "A generic function and convention to trigger deprecation notices", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/config/tree/v7.3.2" + "source": "https://github.com/symfony/deprecation-contracts/tree/v3.7.0" }, "funding": [ { @@ -1920,56 +1884,33 @@ "type": "tidelift" } ], - "time": "2025-07-26T13:55:06+00:00" + "time": "2026-04-13T15:52:40+00:00" }, { - "name": "symfony/console", - "version": "v7.3.3", + "name": "symfony/html-sanitizer", + "version": "v7.4.13", "source": { "type": "git", - "url": "https://github.com/symfony/console.git", - "reference": "cb0102a1c5ac3807cf3fdf8bea96007df7fdbea7" + "url": "https://github.com/symfony/html-sanitizer.git", + "reference": "761f6c49dfd103ee08b3cd09ece588b069e18ec9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/console/zipball/cb0102a1c5ac3807cf3fdf8bea96007df7fdbea7", - "reference": "cb0102a1c5ac3807cf3fdf8bea96007df7fdbea7", + "url": "https://api.github.com/repos/symfony/html-sanitizer/zipball/761f6c49dfd103ee08b3cd09ece588b069e18ec9", + "reference": "761f6c49dfd103ee08b3cd09ece588b069e18ec9", "shasum": "" }, "require": { + "ext-dom": "*", + "league/uri": "^6.5|^7.0", + "masterminds/html5": "^2.7.2", "php": ">=8.2", - "symfony/deprecation-contracts": "^2.5|^3", - "symfony/polyfill-mbstring": "~1.0", - "symfony/service-contracts": "^2.5|^3", - "symfony/string": "^7.2" - }, - "conflict": { - "symfony/dependency-injection": "<6.4", - "symfony/dotenv": "<6.4", - "symfony/event-dispatcher": "<6.4", - "symfony/lock": "<6.4", - "symfony/process": "<6.4" - }, - "provide": { - "psr/log-implementation": "1.0|2.0|3.0" - }, - "require-dev": { - "psr/log": "^1|^2|^3", - "symfony/config": "^6.4|^7.0", - "symfony/dependency-injection": "^6.4|^7.0", - "symfony/event-dispatcher": "^6.4|^7.0", - "symfony/http-foundation": "^6.4|^7.0", - "symfony/http-kernel": "^6.4|^7.0", - "symfony/lock": "^6.4|^7.0", - "symfony/messenger": "^6.4|^7.0", - "symfony/process": "^6.4|^7.0", - "symfony/stopwatch": "^6.4|^7.0", - "symfony/var-dumper": "^6.4|^7.0" + "symfony/deprecation-contracts": "^2.5|^3" }, "type": "library", "autoload": { "psr-4": { - "Symfony\\Component\\Console\\": "" + "Symfony\\Component\\HtmlSanitizer\\": "" }, "exclude-from-classmap": [ "/Tests/" @@ -1981,24 +1922,23 @@ ], "authors": [ { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" + "name": "Titouan Galopin", + "email": "galopintitouan@gmail.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], - "description": "Eases the creation of beautiful and testable command line interfaces", + "description": "Provides an object-oriented API to sanitize untrusted HTML input for safe insertion into a document's DOM.", "homepage": "https://symfony.com", "keywords": [ - "cli", - "command-line", - "console", - "terminal" + "Purifier", + "html", + "sanitizer" ], "support": { - "source": "https://github.com/symfony/console/tree/v7.3.3" + "source": "https://github.com/symfony/html-sanitizer/tree/v7.4.13" }, "funding": [ { @@ -2018,105 +1958,90 @@ "type": "tidelift" } ], - "time": "2025-08-25T06:35:40+00:00" - }, + "time": "2026-05-24T11:20:33+00:00" + } + ], + "packages-dev": [ { - "name": "symfony/deprecation-contracts", - "version": "v3.6.0", + "name": "brick/varexporter", + "version": "0.7.0", "source": { "type": "git", - "url": "https://github.com/symfony/deprecation-contracts.git", - "reference": "63afe740e99a13ba87ec199bb07bbdee937a5b62" + "url": "https://github.com/brick/varexporter.git", + "reference": "b3a50b8f630a9ed5015ea3e1f00479af261ed80d" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/63afe740e99a13ba87ec199bb07bbdee937a5b62", - "reference": "63afe740e99a13ba87ec199bb07bbdee937a5b62", + "url": "https://api.github.com/repos/brick/varexporter/zipball/b3a50b8f630a9ed5015ea3e1f00479af261ed80d", + "reference": "b3a50b8f630a9ed5015ea3e1f00479af261ed80d", "shasum": "" }, "require": { - "php": ">=8.1" + "nikic/php-parser": "^5.0", + "php": "^8.2" }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/symfony/contracts", - "name": "symfony/contracts" - }, - "branch-alias": { - "dev-main": "3.6-dev" - } + "require-dev": { + "php-coveralls/php-coveralls": "^2.2", + "phpunit/phpunit": "^11.0", + "vimeo/psalm": "6.14.3" }, + "type": "library", "autoload": { - "files": [ - "function.php" - ] + "psr-4": { + "Brick\\VarExporter\\": "src/" + } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } + "description": "A powerful alternative to var_export(), which can export closures and objects without __set_state()", + "keywords": [ + "var_export" ], - "description": "A generic function and convention to trigger deprecation notices", - "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/deprecation-contracts/tree/v3.6.0" + "issues": "https://github.com/brick/varexporter/issues", + "source": "https://github.com/brick/varexporter/tree/0.7.0" }, "funding": [ { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", + "url": "https://github.com/BenMorel", "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" } ], - "time": "2024-09-25T14:21:43+00:00" + "time": "2026-01-06T22:56:00+00:00" }, { - "name": "symfony/filesystem", - "version": "v7.3.2", + "name": "cakephp/bake", + "version": "3.6.4", "source": { "type": "git", - "url": "https://github.com/symfony/filesystem.git", - "reference": "edcbb768a186b5c3f25d0643159a787d3e63b7fd" + "url": "https://github.com/cakephp/bake.git", + "reference": "45139a702f039b64dcfb758bff60910861486060" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/filesystem/zipball/edcbb768a186b5c3f25d0643159a787d3e63b7fd", - "reference": "edcbb768a186b5c3f25d0643159a787d3e63b7fd", + "url": "https://api.github.com/repos/cakephp/bake/zipball/45139a702f039b64dcfb758bff60910861486060", + "reference": "45139a702f039b64dcfb758bff60910861486060", "shasum": "" }, "require": { - "php": ">=8.2", - "symfony/polyfill-ctype": "~1.8", - "symfony/polyfill-mbstring": "~1.8" + "brick/varexporter": "^0.6.0 || ^0.7.0", + "cakephp/cakephp": "^5.1", + "cakephp/twig-view": "^2.0.2", + "nikic/php-parser": "^5.0.0", + "php": ">=8.1" }, "require-dev": { - "symfony/process": "^6.4|^7.0" + "cakephp/cakephp-codesniffer": "^5.0.0", + "cakephp/debug_kit": "^5.0.0", + "phpunit/phpunit": "^10.5.40 || ^11.5.20 || ^12.2.4" }, - "type": "library", + "type": "cakephp-plugin", "autoload": { "psr-4": { - "Symfony\\Component\\Filesystem\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" - ] + "Bake\\": "src/" + } }, "notification-url": "https://packagist.org/downloads/", "license": [ @@ -2124,751 +2049,48 @@ ], "authors": [ { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" + "name": "CakePHP Community", + "homepage": "https://github.com/cakephp/bake/graphs/contributors" } ], - "description": "Provides basic utilities for the filesystem", - "homepage": "https://symfony.com", + "description": "Bake plugin for CakePHP", + "homepage": "https://github.com/cakephp/bake", + "keywords": [ + "bake", + "cakephp", + "cli", + "dev" + ], "support": { - "source": "https://github.com/symfony/filesystem/tree/v7.3.2" + "forum": "https://stackoverflow.com/tags/cakephp", + "issues": "https://github.com/cakephp/bake/issues", + "source": "https://github.com/cakephp/bake" }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2025-07-07T08:17:47+00:00" - }, - { - "name": "symfony/html-sanitizer", - "version": "v7.3.3", - "source": { - "type": "git", - "url": "https://github.com/symfony/html-sanitizer.git", - "reference": "8740fc48979f649dee8b8fc51a2698e5c190bf12" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/html-sanitizer/zipball/8740fc48979f649dee8b8fc51a2698e5c190bf12", - "reference": "8740fc48979f649dee8b8fc51a2698e5c190bf12", - "shasum": "" - }, - "require": { - "ext-dom": "*", - "league/uri": "^6.5|^7.0", - "masterminds/html5": "^2.7.2", - "php": ">=8.2" - }, - "type": "library", - "autoload": { - "psr-4": { - "Symfony\\Component\\HtmlSanitizer\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Titouan Galopin", - "email": "galopintitouan@gmail.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Provides an object-oriented API to sanitize untrusted HTML input for safe insertion into a document's DOM.", - "homepage": "https://symfony.com", - "keywords": [ - "Purifier", - "html", - "sanitizer" - ], - "support": { - "source": "https://github.com/symfony/html-sanitizer/tree/v7.3.3" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2025-08-12T10:34:03+00:00" - }, - { - "name": "symfony/polyfill-ctype", - "version": "v1.33.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-ctype.git", - "reference": "a3cc8b044a6ea513310cbd48ef7333b384945638" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/a3cc8b044a6ea513310cbd48ef7333b384945638", - "reference": "a3cc8b044a6ea513310cbd48ef7333b384945638", - "shasum": "" - }, - "require": { - "php": ">=7.2" - }, - "provide": { - "ext-ctype": "*" - }, - "suggest": { - "ext-ctype": "For best performance" - }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/symfony/polyfill", - "name": "symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Ctype\\": "" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Gert de Pagter", - "email": "BackEndTea@gmail.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for ctype functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "ctype", - "polyfill", - "portable" - ], - "support": { - "source": "https://github.com/symfony/polyfill-ctype/tree/v1.33.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2024-09-09T11:45:10+00:00" - }, - { - "name": "symfony/polyfill-intl-grapheme", - "version": "v1.33.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-intl-grapheme.git", - "reference": "380872130d3a5dd3ace2f4010d95125fde5d5c70" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-grapheme/zipball/380872130d3a5dd3ace2f4010d95125fde5d5c70", - "reference": "380872130d3a5dd3ace2f4010d95125fde5d5c70", - "shasum": "" - }, - "require": { - "php": ">=7.2" - }, - "suggest": { - "ext-intl": "For best performance" - }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/symfony/polyfill", - "name": "symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Intl\\Grapheme\\": "" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for intl's grapheme_* functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "grapheme", - "intl", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-intl-grapheme/tree/v1.33.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2025-06-27T09:58:17+00:00" - }, - { - "name": "symfony/polyfill-intl-normalizer", - "version": "v1.33.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-intl-normalizer.git", - "reference": "3833d7255cc303546435cb650316bff708a1c75c" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/3833d7255cc303546435cb650316bff708a1c75c", - "reference": "3833d7255cc303546435cb650316bff708a1c75c", - "shasum": "" - }, - "require": { - "php": ">=7.2" - }, - "suggest": { - "ext-intl": "For best performance" - }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/symfony/polyfill", - "name": "symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Intl\\Normalizer\\": "" - }, - "classmap": [ - "Resources/stubs" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for intl's Normalizer class and related functions", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "intl", - "normalizer", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.33.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2024-09-09T11:45:10+00:00" - }, - { - "name": "symfony/polyfill-mbstring", - "version": "v1.33.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/polyfill-mbstring.git", - "reference": "6d857f4d76bd4b343eac26d6b539585d2bc56493" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/6d857f4d76bd4b343eac26d6b539585d2bc56493", - "reference": "6d857f4d76bd4b343eac26d6b539585d2bc56493", - "shasum": "" - }, - "require": { - "ext-iconv": "*", - "php": ">=7.2" - }, - "provide": { - "ext-mbstring": "*" - }, - "suggest": { - "ext-mbstring": "For best performance" - }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/symfony/polyfill", - "name": "symfony/polyfill" - } - }, - "autoload": { - "files": [ - "bootstrap.php" - ], - "psr-4": { - "Symfony\\Polyfill\\Mbstring\\": "" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Symfony polyfill for the Mbstring extension", - "homepage": "https://symfony.com", - "keywords": [ - "compatibility", - "mbstring", - "polyfill", - "portable", - "shim" - ], - "support": { - "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.33.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2024-12-23T08:48:59+00:00" - }, - { - "name": "symfony/service-contracts", - "version": "v3.6.0", - "source": { - "type": "git", - "url": "https://github.com/symfony/service-contracts.git", - "reference": "f021b05a130d35510bd6b25fe9053c2a8a15d5d4" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/service-contracts/zipball/f021b05a130d35510bd6b25fe9053c2a8a15d5d4", - "reference": "f021b05a130d35510bd6b25fe9053c2a8a15d5d4", - "shasum": "" - }, - "require": { - "php": ">=8.1", - "psr/container": "^1.1|^2.0", - "symfony/deprecation-contracts": "^2.5|^3" - }, - "conflict": { - "ext-psr": "<1.1|>=2" - }, - "type": "library", - "extra": { - "thanks": { - "url": "https://github.com/symfony/contracts", - "name": "symfony/contracts" - }, - "branch-alias": { - "dev-main": "3.6-dev" - } - }, - "autoload": { - "psr-4": { - "Symfony\\Contracts\\Service\\": "" - }, - "exclude-from-classmap": [ - "/Test/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Generic abstractions related to writing services", - "homepage": "https://symfony.com", - "keywords": [ - "abstractions", - "contracts", - "decoupling", - "interfaces", - "interoperability", - "standards" - ], - "support": { - "source": "https://github.com/symfony/service-contracts/tree/v3.6.0" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2025-04-25T09:37:31+00:00" - }, - { - "name": "symfony/string", - "version": "v7.3.3", - "source": { - "type": "git", - "url": "https://github.com/symfony/string.git", - "reference": "17a426cce5fd1f0901fefa9b2a490d0038fd3c9c" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/symfony/string/zipball/17a426cce5fd1f0901fefa9b2a490d0038fd3c9c", - "reference": "17a426cce5fd1f0901fefa9b2a490d0038fd3c9c", - "shasum": "" - }, - "require": { - "php": ">=8.2", - "symfony/polyfill-ctype": "~1.8", - "symfony/polyfill-intl-grapheme": "~1.0", - "symfony/polyfill-intl-normalizer": "~1.0", - "symfony/polyfill-mbstring": "~1.0" - }, - "conflict": { - "symfony/translation-contracts": "<2.5" - }, - "require-dev": { - "symfony/emoji": "^7.1", - "symfony/error-handler": "^6.4|^7.0", - "symfony/http-client": "^6.4|^7.0", - "symfony/intl": "^6.4|^7.0", - "symfony/translation-contracts": "^2.5|^3.0", - "symfony/var-exporter": "^6.4|^7.0" - }, - "type": "library", - "autoload": { - "files": [ - "Resources/functions.php" - ], - "psr-4": { - "Symfony\\Component\\String\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" - ] - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "Nicolas Grekas", - "email": "p@tchwork.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "description": "Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way", - "homepage": "https://symfony.com", - "keywords": [ - "grapheme", - "i18n", - "string", - "unicode", - "utf-8", - "utf8" - ], - "support": { - "source": "https://github.com/symfony/string/tree/v7.3.3" - }, - "funding": [ - { - "url": "https://symfony.com/sponsor", - "type": "custom" - }, - { - "url": "https://github.com/fabpot", - "type": "github" - }, - { - "url": "https://github.com/nicolas-grekas", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", - "type": "tidelift" - } - ], - "time": "2025-08-25T06:35:40+00:00" - } - ], - "packages-dev": [ - { - "name": "brick/varexporter", - "version": "0.6.0", - "source": { - "type": "git", - "url": "https://github.com/brick/varexporter.git", - "reference": "af98bfc2b702a312abbcaff37656dbe419cec5bc" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/brick/varexporter/zipball/af98bfc2b702a312abbcaff37656dbe419cec5bc", - "reference": "af98bfc2b702a312abbcaff37656dbe419cec5bc", - "shasum": "" - }, - "require": { - "nikic/php-parser": "^5.0", - "php": "^8.1" - }, - "require-dev": { - "php-coveralls/php-coveralls": "^2.2", - "phpunit/phpunit": "^10.5", - "vimeo/psalm": "6.8.4" - }, - "type": "library", - "autoload": { - "psr-4": { - "Brick\\VarExporter\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "description": "A powerful alternative to var_export(), which can export closures and objects without __set_state()", - "keywords": [ - "var_export" - ], - "support": { - "issues": "https://github.com/brick/varexporter/issues", - "source": "https://github.com/brick/varexporter/tree/0.6.0" - }, - "funding": [ - { - "url": "https://github.com/BenMorel", - "type": "github" - } - ], - "time": "2025-02-20T17:42:39+00:00" - }, - { - "name": "cakephp/bake", - "version": "3.4.0", - "source": { - "type": "git", - "url": "https://github.com/cakephp/bake.git", - "reference": "a0d2b96486dc5b8547b8e358cd1e218b9ed07d9d" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/cakephp/bake/zipball/a0d2b96486dc5b8547b8e358cd1e218b9ed07d9d", - "reference": "a0d2b96486dc5b8547b8e358cd1e218b9ed07d9d", - "shasum": "" - }, - "require": { - "brick/varexporter": "^0.6.0", - "cakephp/cakephp": "^5.1", - "cakephp/twig-view": "^2.0.0", - "nikic/php-parser": "^5.0.0", - "php": ">=8.1" - }, - "require-dev": { - "cakephp/cakephp-codesniffer": "^5.0.0", - "cakephp/debug_kit": "^5.0.0", - "phpunit/phpunit": "^10.5.5 || ^11.1.3" - }, - "type": "cakephp-plugin", - "autoload": { - "psr-4": { - "Bake\\": "src/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "MIT" - ], - "authors": [ - { - "name": "CakePHP Community", - "homepage": "https://github.com/cakephp/bake/graphs/contributors" - } - ], - "description": "Bake plugin for CakePHP", - "homepage": "https://github.com/cakephp/bake", - "keywords": [ - "bake", - "cakephp", - "cli", - "dev" - ], - "support": { - "forum": "https://stackoverflow.com/tags/cakephp", - "issues": "https://github.com/cakephp/bake/issues", - "source": "https://github.com/cakephp/bake" - }, - "time": "2025-06-25T19:18:09+00:00" + "time": "2026-05-08T13:56:13+00:00" }, { "name": "cakephp/cakephp-codesniffer", - "version": "5.2.2", + "version": "5.3.0", "source": { "type": "git", "url": "https://github.com/cakephp/cakephp-codesniffer.git", - "reference": "3c62979556e98d0330f8af8b103ad1ade0a7067e" + "reference": "8c9481165b0f2819ac58894c9a7e5599a55ad678" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/cakephp-codesniffer/zipball/3c62979556e98d0330f8af8b103ad1ade0a7067e", - "reference": "3c62979556e98d0330f8af8b103ad1ade0a7067e", + "url": "https://api.github.com/repos/cakephp/cakephp-codesniffer/zipball/8c9481165b0f2819ac58894c9a7e5599a55ad678", + "reference": "8c9481165b0f2819ac58894c9a7e5599a55ad678", "shasum": "" }, "require": { - "php": ">=8.1.0", - "phpstan/phpdoc-parser": "^2.1.0", - "slevomat/coding-standard": "^8.16", - "squizlabs/php_codesniffer": "^3.9" + "dealerdirect/phpcodesniffer-composer-installer": "^1.1.2", + "php": ">=8.1", + "phpstan/phpdoc-parser": "^2.1", + "slevomat/coding-standard": "^8.23", + "squizlabs/php_codesniffer": "^4.0" }, "require-dev": { - "phpunit/phpunit": "^9.3.4" + "phpunit/phpunit": "^10.5.32 || ^11.3.3" }, "type": "phpcodesniffer-standard", "autoload": { @@ -2898,32 +2120,32 @@ "issues": "https://github.com/cakephp/cakephp-codesniffer/issues", "source": "https://github.com/cakephp/cakephp-codesniffer" }, - "time": "2025-06-07T17:04:07+00:00" + "time": "2025-09-19T15:47:28+00:00" }, { "name": "cakephp/debug_kit", - "version": "5.1.3", + "version": "5.2.2", "source": { "type": "git", "url": "https://github.com/cakephp/debug_kit.git", - "reference": "6c33eb2993d790d98a27a47a74a10330d699ac07" + "reference": "72cc1b7a4ad9aaa2b841ade1d22aa649955bf017" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/debug_kit/zipball/6c33eb2993d790d98a27a47a74a10330d699ac07", - "reference": "6c33eb2993d790d98a27a47a74a10330d699ac07", + "url": "https://api.github.com/repos/cakephp/debug_kit/zipball/72cc1b7a4ad9aaa2b841ade1d22aa649955bf017", + "reference": "72cc1b7a4ad9aaa2b841ade1d22aa649955bf017", "shasum": "" }, "require": { "cakephp/cakephp": "^5.1", - "composer/composer": "^2.0", + "composer/composer": "^2.7.7", "doctrine/sql-formatter": "^1.1.3", "php": ">=8.1" }, "require-dev": { "cakephp/authorization": "^3.0", "cakephp/cakephp-codesniffer": "^5.0", - "phpunit/phpunit": "^10.5.5 || ^11.1.3" + "phpunit/phpunit": "^10.5.32 || ^11.1.3 || ^12.0.9" }, "suggest": { "ext-pdo_sqlite": "DebugKit needs to store panel data in a database. SQLite is simple and easy to use." @@ -2963,25 +2185,26 @@ "issues": "https://github.com/cakephp/debug_kit/issues", "source": "https://github.com/cakephp/debug_kit" }, - "time": "2025-08-03T15:06:57+00:00" + "time": "2026-05-01T06:20:22+00:00" }, { "name": "cakephp/twig-view", - "version": "2.0.3", + "version": "2.1.0", "source": { "type": "git", "url": "https://github.com/cakephp/twig-view.git", - "reference": "b11df8e8734ae556d98b143192377dbc6a6f5360" + "reference": "db51ee49c0cb9be4af39497f1724393b7ce51211" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/cakephp/twig-view/zipball/b11df8e8734ae556d98b143192377dbc6a6f5360", - "reference": "b11df8e8734ae556d98b143192377dbc6a6f5360", + "url": "https://api.github.com/repos/cakephp/twig-view/zipball/db51ee49c0cb9be4af39497f1724393b7ce51211", + "reference": "db51ee49c0cb9be4af39497f1724393b7ce51211", "shasum": "" }, "require": { "cakephp/cakephp": "^5.0.0", "jasny/twig-extensions": "^1.3", + "php": ">=8.1", "twig/markdown-extra": "^3.0", "twig/twig": "^3.11.1" }, @@ -2993,7 +2216,7 @@ "cakephp/debug_kit": "^5.0", "michelf/php-markdown": "^1.9", "mikey179/vfsstream": "^1.6.10", - "phpunit/phpunit": "^10.5.5 || ^11.1.3" + "phpunit/phpunit": "^11.5.3 | ^12.1.3" }, "type": "cakephp-plugin", "autoload": { @@ -3024,26 +2247,26 @@ "issues": "https://github.com/cakephp/twig-view/issues", "source": "https://github.com/cakephp/twig-view" }, - "time": "2024-10-11T07:53:08+00:00" + "time": "2026-01-05T22:35:06+00:00" }, { "name": "composer/class-map-generator", - "version": "1.6.2", + "version": "1.7.3", "source": { "type": "git", "url": "https://github.com/composer/class-map-generator.git", - "reference": "ba9f089655d4cdd64e762a6044f411ccdaec0076" + "reference": "86d8208fc3c649a3a999daf1a63c25201be2990f" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/composer/class-map-generator/zipball/ba9f089655d4cdd64e762a6044f411ccdaec0076", - "reference": "ba9f089655d4cdd64e762a6044f411ccdaec0076", + "url": "https://api.github.com/repos/composer/class-map-generator/zipball/86d8208fc3c649a3a999daf1a63c25201be2990f", + "reference": "86d8208fc3c649a3a999daf1a63c25201be2990f", "shasum": "" }, "require": { "composer/pcre": "^2.1 || ^3.1", "php": "^7.2 || ^8.0", - "symfony/finder": "^4.4 || ^5.3 || ^6 || ^7" + "symfony/finder": "^4.4 || ^5.3 || ^6 || ^7 || ^8" }, "require-dev": { "phpstan/phpstan": "^1.12 || ^2", @@ -3051,7 +2274,7 @@ "phpstan/phpstan-phpunit": "^1 || ^2", "phpstan/phpstan-strict-rules": "^1.1 || ^2", "phpunit/phpunit": "^8", - "symfony/filesystem": "^5.4 || ^6" + "symfony/filesystem": "^5.4 || ^6 || ^7 || ^8" }, "type": "library", "extra": { @@ -3081,7 +2304,7 @@ ], "support": { "issues": "https://github.com/composer/class-map-generator/issues", - "source": "https://github.com/composer/class-map-generator/tree/1.6.2" + "source": "https://github.com/composer/class-map-generator/tree/1.7.3" }, "funding": [ { @@ -3093,44 +2316,46 @@ "type": "github" } ], - "time": "2025-08-20T18:52:43+00:00" + "time": "2026-05-05T09:17:07+00:00" }, { "name": "composer/composer", - "version": "2.8.11", + "version": "2.9.8", "source": { "type": "git", "url": "https://github.com/composer/composer.git", - "reference": "00e1a3396eea67033775c4a49c772376f45acd73" + "reference": "39ee8baff8e97a1b657bbfcd6a236ff93a5efbb2" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/composer/composer/zipball/00e1a3396eea67033775c4a49c772376f45acd73", - "reference": "00e1a3396eea67033775c4a49c772376f45acd73", + "url": "https://api.github.com/repos/composer/composer/zipball/39ee8baff8e97a1b657bbfcd6a236ff93a5efbb2", + "reference": "39ee8baff8e97a1b657bbfcd6a236ff93a5efbb2", "shasum": "" }, "require": { "composer/ca-bundle": "^1.5", "composer/class-map-generator": "^1.4.0", "composer/metadata-minifier": "^1.0", - "composer/pcre": "^2.2 || ^3.2", + "composer/pcre": "^2.3 || ^3.3", "composer/semver": "^3.3", "composer/spdx-licenses": "^1.5.7", "composer/xdebug-handler": "^2.0.2 || ^3.0.3", - "justinrainbow/json-schema": "^6.3.1", + "ext-json": "*", + "justinrainbow/json-schema": "^6.5.1", "php": "^7.2.5 || ^8.0", "psr/log": "^1.0 || ^2.0 || ^3.0", - "react/promise": "^2.11 || ^3.3", + "react/promise": "^3.3", "seld/jsonlint": "^1.4", "seld/phar-utils": "^1.2", "seld/signal-handler": "^2.0", - "symfony/console": "^5.4.35 || ^6.3.12 || ^7.0.3", - "symfony/filesystem": "^5.4.35 || ^6.3.12 || ^7.0.3", - "symfony/finder": "^5.4.35 || ^6.3.12 || ^7.0.3", + "symfony/console": "^5.4.47 || ^6.4.25 || ^7.1.10 || ^8.0", + "symfony/filesystem": "^5.4.45 || ^6.4.24 || ^7.1.10 || ^8.0", + "symfony/finder": "^5.4.45 || ^6.4.24 || ^7.1.10 || ^8.0", "symfony/polyfill-php73": "^1.24", "symfony/polyfill-php80": "^1.24", "symfony/polyfill-php81": "^1.24", - "symfony/process": "^5.4.35 || ^6.3.12 || ^7.0.3" + "symfony/polyfill-php84": "^1.30", + "symfony/process": "^5.4.47 || ^6.4.25 || ^7.1.10 || ^8.0" }, "require-dev": { "phpstan/phpstan": "^1.11.8", @@ -3138,12 +2363,13 @@ "phpstan/phpstan-phpunit": "^1.4.0", "phpstan/phpstan-strict-rules": "^1.6.0", "phpstan/phpstan-symfony": "^1.4.0", - "symfony/phpunit-bridge": "^6.4.3 || ^7.0.1" + "symfony/phpunit-bridge": "^6.4.25 || ^7.3.3 || ^8.0" }, "suggest": { - "ext-openssl": "Enabling the openssl extension allows you to access https URLs for repositories and packages", - "ext-zip": "Enabling the zip extension allows you to unzip archives", - "ext-zlib": "Allow gzip compression of HTTP requests" + "ext-curl": "Provides HTTP support (will fallback to PHP streams if missing)", + "ext-openssl": "Enables access to repositories and packages over HTTPS", + "ext-zip": "Allows direct extraction of ZIP archives (unzip/7z binaries will be used instead if available)", + "ext-zlib": "Enables gzip for HTTP requests" }, "bin": [ "bin/composer" @@ -3156,7 +2382,7 @@ ] }, "branch-alias": { - "dev-main": "2.8-dev" + "dev-main": "2.9-dev" } }, "autoload": { @@ -3191,7 +2417,7 @@ "irc": "ircs://irc.libera.chat:6697/composer", "issues": "https://github.com/composer/composer/issues", "security": "https://github.com/composer/composer/security/policy", - "source": "https://github.com/composer/composer/tree/2.8.11" + "source": "https://github.com/composer/composer/tree/2.9.8" }, "funding": [ { @@ -3203,7 +2429,7 @@ "type": "github" } ], - "time": "2025-08-21T09:29:39+00:00" + "time": "2026-05-13T07:28:38+00:00" }, { "name": "composer/metadata-minifier", @@ -3432,24 +2658,24 @@ }, { "name": "composer/spdx-licenses", - "version": "1.5.9", + "version": "1.6.0", "source": { "type": "git", "url": "https://github.com/composer/spdx-licenses.git", - "reference": "edf364cefe8c43501e21e88110aac10b284c3c9f" + "reference": "5ecd0cb4177696f9fd48f1605dda81db3dee7889" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/composer/spdx-licenses/zipball/edf364cefe8c43501e21e88110aac10b284c3c9f", - "reference": "edf364cefe8c43501e21e88110aac10b284c3c9f", + "url": "https://api.github.com/repos/composer/spdx-licenses/zipball/5ecd0cb4177696f9fd48f1605dda81db3dee7889", + "reference": "5ecd0cb4177696f9fd48f1605dda81db3dee7889", "shasum": "" }, "require": { - "php": "^5.3.2 || ^7.0 || ^8.0" + "php": "^7.2 || ^8.0" }, "require-dev": { "phpstan/phpstan": "^1.11", - "symfony/phpunit-bridge": "^3 || ^7" + "symfony/phpunit-bridge": "^6.4.25 || ^7.3.3 || ^8.0" }, "type": "library", "extra": { @@ -3492,7 +2718,7 @@ "support": { "irc": "ircs://irc.libera.chat:6697/composer", "issues": "https://github.com/composer/spdx-licenses/issues", - "source": "https://github.com/composer/spdx-licenses/tree/1.5.9" + "source": "https://github.com/composer/spdx-licenses/tree/1.6.0" }, "funding": [ { @@ -3502,13 +2728,9 @@ { "url": "https://github.com/composer", "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/composer/composer", - "type": "tidelift" } ], - "time": "2025-05-12T21:07:07+00:00" + "time": "2026-04-08T20:18:39+00:00" }, { "name": "composer/xdebug-handler", @@ -3578,29 +2800,29 @@ }, { "name": "dealerdirect/phpcodesniffer-composer-installer", - "version": "v1.1.2", + "version": "v1.2.1", "source": { "type": "git", "url": "https://github.com/PHPCSStandards/composer-installer.git", - "reference": "e9cf5e4bbf7eeaf9ef5db34938942602838fc2b1" + "reference": "963f0c67bffde0eac41b56be71ac0e8ba132f0bd" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHPCSStandards/composer-installer/zipball/e9cf5e4bbf7eeaf9ef5db34938942602838fc2b1", - "reference": "e9cf5e4bbf7eeaf9ef5db34938942602838fc2b1", + "url": "https://api.github.com/repos/PHPCSStandards/composer-installer/zipball/963f0c67bffde0eac41b56be71ac0e8ba132f0bd", + "reference": "963f0c67bffde0eac41b56be71ac0e8ba132f0bd", "shasum": "" }, "require": { "composer-plugin-api": "^2.2", "php": ">=5.4", - "squizlabs/php_codesniffer": "^2.0 || ^3.1.0 || ^4.0" + "squizlabs/php_codesniffer": "^3.1.0 || ^4.0" }, "require-dev": { "composer/composer": "^2.2", "ext-json": "*", "ext-zip": "*", "php-parallel-lint/php-parallel-lint": "^1.4.0", - "phpcompatibility/php-compatibility": "^9.0", + "phpcompatibility/php-compatibility": "^9.0 || ^10.0.0@dev", "yoast/phpunit-polyfills": "^1.0" }, "type": "composer-plugin", @@ -3670,30 +2892,30 @@ "type": "thanks_dev" } ], - "time": "2025-07-17T20:45:56+00:00" + "time": "2026-05-06T08:26:05+00:00" }, { "name": "doctrine/sql-formatter", - "version": "1.5.2", + "version": "1.5.4", "source": { "type": "git", "url": "https://github.com/doctrine/sql-formatter.git", - "reference": "d6d00aba6fd2957fe5216fe2b7673e9985db20c8" + "reference": "9563949f5cd3bd12a17d12fb980528bc141c5806" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/doctrine/sql-formatter/zipball/d6d00aba6fd2957fe5216fe2b7673e9985db20c8", - "reference": "d6d00aba6fd2957fe5216fe2b7673e9985db20c8", + "url": "https://api.github.com/repos/doctrine/sql-formatter/zipball/9563949f5cd3bd12a17d12fb980528bc141c5806", + "reference": "9563949f5cd3bd12a17d12fb980528bc141c5806", "shasum": "" }, "require": { "php": "^8.1" }, "require-dev": { - "doctrine/coding-standard": "^12", - "ergebnis/phpunit-slow-test-detector": "^2.14", - "phpstan/phpstan": "^1.10", - "phpunit/phpunit": "^10.5" + "doctrine/coding-standard": "^14", + "ergebnis/phpunit-slow-test-detector": "^2.20", + "phpstan/phpstan": "^2.1.31", + "phpunit/phpunit": "^10.5.58" }, "bin": [ "bin/sql-formatter" @@ -3723,9 +2945,9 @@ ], "support": { "issues": "https://github.com/doctrine/sql-formatter/issues", - "source": "https://github.com/doctrine/sql-formatter/tree/1.5.2" + "source": "https://github.com/doctrine/sql-formatter/tree/1.5.4" }, - "time": "2025-01-24T11:45:48+00:00" + "time": "2026-02-08T16:21:46+00:00" }, { "name": "jasny/twig-extensions", @@ -3852,26 +3074,26 @@ }, { "name": "justinrainbow/json-schema", - "version": "6.5.2", + "version": "6.8.2", "source": { "type": "git", "url": "https://github.com/jsonrainbow/json-schema.git", - "reference": "ac0d369c09653cf7af561f6d91a705bc617a87b8" + "reference": "2c89ebb95ca9cedc9347f780333f7b25792dcb76" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/jsonrainbow/json-schema/zipball/ac0d369c09653cf7af561f6d91a705bc617a87b8", - "reference": "ac0d369c09653cf7af561f6d91a705bc617a87b8", + "url": "https://api.github.com/repos/jsonrainbow/json-schema/zipball/2c89ebb95ca9cedc9347f780333f7b25792dcb76", + "reference": "2c89ebb95ca9cedc9347f780333f7b25792dcb76", "shasum": "" }, "require": { "ext-json": "*", - "marc-mabe/php-enum": "^4.0", + "marc-mabe/php-enum": "^4.4", "php": "^7.2 || ^8.0" }, "require-dev": { "friendsofphp/php-cs-fixer": "3.3.0", - "json-schema/json-schema-test-suite": "^23.2", + "json-schema/json-schema-test-suite": "dev-main", "marc-mabe/php-enum-phpstan": "^2.0", "phpspec/prophecy": "^1.19", "phpstan/phpstan": "^1.12", @@ -3921,9 +3143,9 @@ ], "support": { "issues": "https://github.com/jsonrainbow/json-schema/issues", - "source": "https://github.com/jsonrainbow/json-schema/tree/6.5.2" + "source": "https://github.com/jsonrainbow/json-schema/tree/6.8.2" }, - "time": "2025-09-09T09:42:27+00:00" + "time": "2026-05-05T05:39:01+00:00" }, { "name": "m1/env", @@ -3989,16 +3211,16 @@ }, { "name": "marc-mabe/php-enum", - "version": "v4.7.1", + "version": "v4.7.2", "source": { "type": "git", "url": "https://github.com/marc-mabe/php-enum.git", - "reference": "7159809e5cfa041dca28e61f7f7ae58063aae8ed" + "reference": "bb426fcdd65c60fb3638ef741e8782508fda7eef" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/marc-mabe/php-enum/zipball/7159809e5cfa041dca28e61f7f7ae58063aae8ed", - "reference": "7159809e5cfa041dca28e61f7f7ae58063aae8ed", + "url": "https://api.github.com/repos/marc-mabe/php-enum/zipball/bb426fcdd65c60fb3638ef741e8782508fda7eef", + "reference": "bb426fcdd65c60fb3638ef741e8782508fda7eef", "shasum": "" }, "require": { @@ -4056,9 +3278,9 @@ ], "support": { "issues": "https://github.com/marc-mabe/php-enum/issues", - "source": "https://github.com/marc-mabe/php-enum/tree/v4.7.1" + "source": "https://github.com/marc-mabe/php-enum/tree/v4.7.2" }, - "time": "2024-11-28T04:54:44+00:00" + "time": "2025-09-14T11:18:39+00:00" }, { "name": "myclabs/deep-copy", @@ -4122,16 +3344,16 @@ }, { "name": "nikic/php-parser", - "version": "v5.6.1", + "version": "v5.7.0", "source": { "type": "git", "url": "https://github.com/nikic/PHP-Parser.git", - "reference": "f103601b29efebd7ff4a1ca7b3eeea9e3336a2a2" + "reference": "dca41cd15c2ac9d055ad70dbfd011130757d1f82" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/f103601b29efebd7ff4a1ca7b3eeea9e3336a2a2", - "reference": "f103601b29efebd7ff4a1ca7b3eeea9e3336a2a2", + "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/dca41cd15c2ac9d055ad70dbfd011130757d1f82", + "reference": "dca41cd15c2ac9d055ad70dbfd011130757d1f82", "shasum": "" }, "require": { @@ -4174,9 +3396,9 @@ ], "support": { "issues": "https://github.com/nikic/PHP-Parser/issues", - "source": "https://github.com/nikic/PHP-Parser/tree/v5.6.1" + "source": "https://github.com/nikic/PHP-Parser/tree/v5.7.0" }, - "time": "2025-08-13T20:13:15+00:00" + "time": "2025-12-06T11:56:16+00:00" }, { "name": "phar-io/manifest", @@ -4298,16 +3520,16 @@ }, { "name": "phpstan/phpdoc-parser", - "version": "2.3.0", + "version": "2.3.2", "source": { "type": "git", "url": "https://github.com/phpstan/phpdoc-parser.git", - "reference": "1e0cd5370df5dd2e556a36b9c62f62e555870495" + "reference": "a004701b11273a26cd7955a61d67a7f1e525a45a" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpstan/phpdoc-parser/zipball/1e0cd5370df5dd2e556a36b9c62f62e555870495", - "reference": "1e0cd5370df5dd2e556a36b9c62f62e555870495", + "url": "https://api.github.com/repos/phpstan/phpdoc-parser/zipball/a004701b11273a26cd7955a61d67a7f1e525a45a", + "reference": "a004701b11273a26cd7955a61d67a7f1e525a45a", "shasum": "" }, "require": { @@ -4334,54 +3556,350 @@ }, "notification-url": "https://packagist.org/downloads/", "license": [ - "MIT" + "MIT" + ], + "description": "PHPDoc parser with support for nullable, intersection and generic types", + "support": { + "issues": "https://github.com/phpstan/phpdoc-parser/issues", + "source": "https://github.com/phpstan/phpdoc-parser/tree/2.3.2" + }, + "time": "2026-01-25T14:56:51+00:00" + }, + { + "name": "phpunit/php-code-coverage", + "version": "14.1.9", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-code-coverage.git", + "reference": "655533a65696bbc4231cd8027af150dadc40ec88" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/655533a65696bbc4231cd8027af150dadc40ec88", + "reference": "655533a65696bbc4231cd8027af150dadc40ec88", + "shasum": "" + }, + "require": { + "ext-dom": "*", + "ext-libxml": "*", + "ext-mbstring": "*", + "ext-xmlwriter": "*", + "nikic/php-parser": "^5.7.0", + "php": ">=8.4", + "phpunit/php-text-template": "^6.0", + "sebastian/complexity": "^6.0", + "sebastian/environment": "^9.2", + "sebastian/git-state": "^1.0", + "sebastian/lines-of-code": "^5.0", + "sebastian/version": "^7.0", + "theseer/tokenizer": "^2.0.1" + }, + "require-dev": { + "phpunit/phpunit": "^13.1" + }, + "suggest": { + "ext-pcov": "PHP extension that provides line coverage", + "ext-xdebug": "PHP extension that provides line coverage as well as branch and path coverage" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "14.1.x-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.", + "homepage": "https://github.com/sebastianbergmann/php-code-coverage", + "keywords": [ + "coverage", + "testing", + "xunit" + ], + "support": { + "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", + "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", + "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/14.1.9" + }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-code-coverage", + "type": "tidelift" + } + ], + "time": "2026-05-16T05:16:14+00:00" + }, + { + "name": "phpunit/php-file-iterator", + "version": "7.0.0", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-file-iterator.git", + "reference": "6e5aa1fb0a95b1703d83e721299ee18bb4e2de50" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/6e5aa1fb0a95b1703d83e721299ee18bb4e2de50", + "reference": "6e5aa1fb0a95b1703d83e721299ee18bb4e2de50", + "shasum": "" + }, + "require": { + "php": ">=8.4" + }, + "require-dev": { + "phpunit/phpunit": "^13.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "7.0-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "description": "FilterIterator implementation that filters files based on a list of suffixes.", + "homepage": "https://github.com/sebastianbergmann/php-file-iterator/", + "keywords": [ + "filesystem", + "iterator" + ], + "support": { + "issues": "https://github.com/sebastianbergmann/php-file-iterator/issues", + "security": "https://github.com/sebastianbergmann/php-file-iterator/security/policy", + "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/7.0.0" + }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-file-iterator", + "type": "tidelift" + } + ], + "time": "2026-02-06T04:33:26+00:00" + }, + { + "name": "phpunit/php-invoker", + "version": "7.0.0", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-invoker.git", + "reference": "42e5c5cae0c65df12d1b1a3ab52bf3f50f244d88" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-invoker/zipball/42e5c5cae0c65df12d1b1a3ab52bf3f50f244d88", + "reference": "42e5c5cae0c65df12d1b1a3ab52bf3f50f244d88", + "shasum": "" + }, + "require": { + "php": ">=8.4" + }, + "require-dev": { + "ext-pcntl": "*", + "phpunit/phpunit": "^13.0" + }, + "suggest": { + "ext-pcntl": "*" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "7.0-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "description": "Invoke callables with a timeout", + "homepage": "https://github.com/sebastianbergmann/php-invoker/", + "keywords": [ + "process" + ], + "support": { + "issues": "https://github.com/sebastianbergmann/php-invoker/issues", + "security": "https://github.com/sebastianbergmann/php-invoker/security/policy", + "source": "https://github.com/sebastianbergmann/php-invoker/tree/7.0.0" + }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-invoker", + "type": "tidelift" + } + ], + "time": "2026-02-06T04:34:47+00:00" + }, + { + "name": "phpunit/php-text-template", + "version": "6.0.0", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/php-text-template.git", + "reference": "a47af19f93f76aa3368303d752aa5272ca3299f4" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/a47af19f93f76aa3368303d752aa5272ca3299f4", + "reference": "a47af19f93f76aa3368303d752aa5272ca3299f4", + "shasum": "" + }, + "require": { + "php": ">=8.4" + }, + "require-dev": { + "phpunit/phpunit": "^13.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "6.0-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "description": "Simple template engine.", + "homepage": "https://github.com/sebastianbergmann/php-text-template/", + "keywords": [ + "template" ], - "description": "PHPDoc parser with support for nullable, intersection and generic types", "support": { - "issues": "https://github.com/phpstan/phpdoc-parser/issues", - "source": "https://github.com/phpstan/phpdoc-parser/tree/2.3.0" + "issues": "https://github.com/sebastianbergmann/php-text-template/issues", + "security": "https://github.com/sebastianbergmann/php-text-template/security/policy", + "source": "https://github.com/sebastianbergmann/php-text-template/tree/6.0.0" }, - "time": "2025-08-30T15:50:23+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-text-template", + "type": "tidelift" + } + ], + "time": "2026-02-06T04:36:37+00:00" }, { - "name": "phpunit/php-code-coverage", - "version": "12.3.6", + "name": "phpunit/php-timer", + "version": "9.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "da2cdaff87220fa641e7652364281b736e4347e0" + "url": "https://github.com/sebastianbergmann/php-timer.git", + "reference": "a0e12065831f6ab0d83120dc61513eb8d9a966f6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/da2cdaff87220fa641e7652364281b736e4347e0", - "reference": "da2cdaff87220fa641e7652364281b736e4347e0", + "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/a0e12065831f6ab0d83120dc61513eb8d9a966f6", + "reference": "a0e12065831f6ab0d83120dc61513eb8d9a966f6", "shasum": "" }, "require": { - "ext-dom": "*", - "ext-libxml": "*", - "ext-xmlwriter": "*", - "nikic/php-parser": "^5.6.1", - "php": ">=8.3", - "phpunit/php-file-iterator": "^6.0", - "phpunit/php-text-template": "^5.0", - "sebastian/complexity": "^5.0", - "sebastian/environment": "^8.0.3", - "sebastian/lines-of-code": "^4.0", - "sebastian/version": "^6.0", - "theseer/tokenizer": "^1.2.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.3.7" - }, - "suggest": { - "ext-pcov": "PHP extension that provides line coverage", - "ext-xdebug": "PHP extension that provides line coverage as well as branch and path coverage" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "12.3.x-dev" + "dev-main": "9.0-dev" } }, "autoload": { @@ -4400,17 +3918,15 @@ "role": "lead" } ], - "description": "Library that provides collection, processing, and rendering functionality for PHP code coverage information.", - "homepage": "https://github.com/sebastianbergmann/php-code-coverage", + "description": "Utility class for timing", + "homepage": "https://github.com/sebastianbergmann/php-timer/", "keywords": [ - "coverage", - "testing", - "xunit" + "timer" ], "support": { - "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", - "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.3.6" + "issues": "https://github.com/sebastianbergmann/php-timer/issues", + "security": "https://github.com/sebastianbergmann/php-timer/security/policy", + "source": "https://github.com/sebastianbergmann/php-timer/tree/9.0.0" }, "funding": [ { @@ -4426,39 +3942,68 @@ "type": "thanks_dev" }, { - "url": "https://tidelift.com/funding/github/packagist/phpunit/php-code-coverage", + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-timer", "type": "tidelift" } ], - "time": "2025-09-02T05:23:14+00:00" + "time": "2026-02-06T04:37:53+00:00" }, { - "name": "phpunit/php-file-iterator", - "version": "6.0.0", + "name": "phpunit/phpunit", + "version": "13.1.11", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/php-file-iterator.git", - "reference": "961bc913d42fe24a257bfff826a5068079ac7782" + "url": "https://github.com/sebastianbergmann/phpunit.git", + "reference": "0f540976373361d1b4549adcb87913ce2116e904" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/961bc913d42fe24a257bfff826a5068079ac7782", - "reference": "961bc913d42fe24a257bfff826a5068079ac7782", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/0f540976373361d1b4549adcb87913ce2116e904", + "reference": "0f540976373361d1b4549adcb87913ce2116e904", "shasum": "" }, "require": { - "php": ">=8.3" - }, - "require-dev": { - "phpunit/phpunit": "^12.0" + "ext-dom": "*", + "ext-json": "*", + "ext-libxml": "*", + "ext-mbstring": "*", + "ext-xml": "*", + "ext-xmlwriter": "*", + "myclabs/deep-copy": "^1.13.4", + "phar-io/manifest": "^2.0.4", + "phar-io/version": "^3.2.1", + "php": ">=8.4.1", + "phpunit/php-code-coverage": "^14.1.9", + "phpunit/php-file-iterator": "^7.0.0", + "phpunit/php-invoker": "^7.0.0", + "phpunit/php-text-template": "^6.0.0", + "phpunit/php-timer": "^9.0.0", + "sebastian/cli-parser": "^5.0.0", + "sebastian/comparator": "^8.2.1", + "sebastian/diff": "^8.3.0", + "sebastian/environment": "^9.3.1", + "sebastian/exporter": "^8.1.0", + "sebastian/git-state": "^1.0", + "sebastian/global-state": "^9.0.0", + "sebastian/object-enumerator": "^8.0.0", + "sebastian/recursion-context": "^8.0.0", + "sebastian/type": "^7.0.1", + "sebastian/version": "^7.0.0", + "staabm/side-effects-detector": "^1.0.5" }, + "bin": [ + "phpunit" + ], "type": "library", "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "13.1-dev" } }, "autoload": { + "files": [ + "src/Framework/Assert/Functions.php" + ], "classmap": [ "src/" ] @@ -4474,53 +4019,202 @@ "role": "lead" } ], - "description": "FilterIterator implementation that filters files based on a list of suffixes.", - "homepage": "https://github.com/sebastianbergmann/php-file-iterator/", + "description": "The PHP Unit Testing framework.", + "homepage": "https://phpunit.de/", "keywords": [ - "filesystem", - "iterator" + "phpunit", + "testing", + "xunit" ], "support": { - "issues": "https://github.com/sebastianbergmann/php-file-iterator/issues", - "security": "https://github.com/sebastianbergmann/php-file-iterator/security/policy", - "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/6.0.0" + "issues": "https://github.com/sebastianbergmann/phpunit/issues", + "security": "https://github.com/sebastianbergmann/phpunit/security/policy", + "source": "https://github.com/sebastianbergmann/phpunit/tree/13.1.11" }, "funding": [ { - "url": "https://github.com/sebastianbergmann", - "type": "github" + "url": "https://phpunit.de/sponsoring.html", + "type": "other" } ], - "time": "2025-02-07T04:58:37+00:00" + "time": "2026-05-21T12:38:47+00:00" }, { - "name": "phpunit/php-invoker", - "version": "6.0.0", + "name": "psy/psysh", + "version": "v0.12.23", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/php-invoker.git", - "reference": "12b54e689b07a25a9b41e57736dfab6ec9ae5406" + "url": "https://github.com/bobthecow/psysh.git", + "reference": "4dcc0f08047d52bbde475eda481146fd8e27e1a4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-invoker/zipball/12b54e689b07a25a9b41e57736dfab6ec9ae5406", - "reference": "12b54e689b07a25a9b41e57736dfab6ec9ae5406", + "url": "https://api.github.com/repos/bobthecow/psysh/zipball/4dcc0f08047d52bbde475eda481146fd8e27e1a4", + "reference": "4dcc0f08047d52bbde475eda481146fd8e27e1a4", "shasum": "" }, "require": { - "php": ">=8.3" + "ext-json": "*", + "ext-tokenizer": "*", + "nikic/php-parser": "^5.0 || ^4.0", + "php": "^8.0 || ^7.4", + "symfony/console": "^8.0 || ^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4", + "symfony/var-dumper": "^8.0 || ^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4" + }, + "conflict": { + "symfony/console": "4.4.37 || 5.3.14 || 5.3.15 || 5.4.3 || 5.4.4 || 6.0.3 || 6.0.4" }, "require-dev": { - "ext-pcntl": "*", - "phpunit/phpunit": "^12.0" + "bamarni/composer-bin-plugin": "^1.2", + "composer/class-map-generator": "^1.6" }, "suggest": { - "ext-pcntl": "*" + "composer/class-map-generator": "Improved tab completion performance with better class discovery.", + "ext-pcntl": "Enabling the PCNTL extension makes PsySH a lot happier :)", + "ext-posix": "If you have PCNTL, you'll want the POSIX extension as well." }, + "bin": [ + "bin/psysh" + ], "type": "library", "extra": { + "bamarni-bin": { + "bin-links": false, + "forward-command": false + }, "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "0.12.x-dev" + } + }, + "autoload": { + "files": [ + "src/functions.php" + ], + "psr-4": { + "Psy\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Justin Hileman", + "email": "justin@justinhileman.info" + } + ], + "description": "An interactive shell for modern PHP.", + "homepage": "https://psysh.org", + "keywords": [ + "REPL", + "console", + "interactive", + "shell" + ], + "support": { + "issues": "https://github.com/bobthecow/psysh/issues", + "source": "https://github.com/bobthecow/psysh/tree/v0.12.23" + }, + "time": "2026-05-23T13:41:31+00:00" + }, + { + "name": "react/promise", + "version": "v3.3.0", + "source": { + "type": "git", + "url": "https://github.com/reactphp/promise.git", + "reference": "23444f53a813a3296c1368bb104793ce8d88f04a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/reactphp/promise/zipball/23444f53a813a3296c1368bb104793ce8d88f04a", + "reference": "23444f53a813a3296c1368bb104793ce8d88f04a", + "shasum": "" + }, + "require": { + "php": ">=7.1.0" + }, + "require-dev": { + "phpstan/phpstan": "1.12.28 || 1.4.10", + "phpunit/phpunit": "^9.6 || ^7.5" + }, + "type": "library", + "autoload": { + "files": [ + "src/functions_include.php" + ], + "psr-4": { + "React\\Promise\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Jan Sorgalla", + "email": "jsorgalla@gmail.com", + "homepage": "https://sorgalla.com/" + }, + { + "name": "Christian Lück", + "email": "christian@clue.engineering", + "homepage": "https://clue.engineering/" + }, + { + "name": "Cees-Jan Kiewiet", + "email": "reactphp@ceesjankiewiet.nl", + "homepage": "https://wyrihaximus.net/" + }, + { + "name": "Chris Boden", + "email": "cboden@gmail.com", + "homepage": "https://cboden.dev/" + } + ], + "description": "A lightweight implementation of CommonJS Promises/A for PHP", + "keywords": [ + "promise", + "promises" + ], + "support": { + "issues": "https://github.com/reactphp/promise/issues", + "source": "https://github.com/reactphp/promise/tree/v3.3.0" + }, + "funding": [ + { + "url": "https://opencollective.com/reactphp", + "type": "open_collective" + } + ], + "time": "2025-08-19T18:57:03+00:00" + }, + { + "name": "sebastian/cli-parser", + "version": "5.0.0", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/cli-parser.git", + "reference": "48a4654fa5e48c1c81214e9930048a572d4b23ca" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/cli-parser/zipball/48a4654fa5e48c1c81214e9930048a572d4b23ca", + "reference": "48a4654fa5e48c1c81214e9930048a572d4b23ca", + "shasum": "" + }, + "require": { + "php": ">=8.4" + }, + "require-dev": { + "phpunit/phpunit": "^13.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "5.0-dev" } }, "autoload": { @@ -4539,48 +4233,64 @@ "role": "lead" } ], - "description": "Invoke callables with a timeout", - "homepage": "https://github.com/sebastianbergmann/php-invoker/", - "keywords": [ - "process" - ], + "description": "Library for parsing CLI options", + "homepage": "https://github.com/sebastianbergmann/cli-parser", "support": { - "issues": "https://github.com/sebastianbergmann/php-invoker/issues", - "security": "https://github.com/sebastianbergmann/php-invoker/security/policy", - "source": "https://github.com/sebastianbergmann/php-invoker/tree/6.0.0" + "issues": "https://github.com/sebastianbergmann/cli-parser/issues", + "security": "https://github.com/sebastianbergmann/cli-parser/security/policy", + "source": "https://github.com/sebastianbergmann/cli-parser/tree/5.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/cli-parser", + "type": "tidelift" } ], - "time": "2025-02-07T04:58:58+00:00" + "time": "2026-02-06T04:39:44+00:00" }, { - "name": "phpunit/php-text-template", - "version": "5.0.0", + "name": "sebastian/comparator", + "version": "8.2.1", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/php-text-template.git", - "reference": "e1367a453f0eda562eedb4f659e13aa900d66c53" + "url": "https://github.com/sebastianbergmann/comparator.git", + "reference": "ce999bf08b2c387a5423fe56961c32eed3f88089" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/e1367a453f0eda562eedb4f659e13aa900d66c53", - "reference": "e1367a453f0eda562eedb4f659e13aa900d66c53", + "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/ce999bf08b2c387a5423fe56961c32eed3f88089", + "reference": "ce999bf08b2c387a5423fe56961c32eed3f88089", "shasum": "" }, "require": { - "php": ">=8.3" + "ext-dom": "*", + "ext-mbstring": "*", + "php": ">=8.4", + "sebastian/diff": "^8.3", + "sebastian/exporter": "^8.0.3" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" + }, + "suggest": { + "ext-bcmath": "For comparing BcMath\\Number objects" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "8.2-dev" } }, "autoload": { @@ -4595,52 +4305,78 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" + "email": "sebastian@phpunit.de" + }, + { + "name": "Jeff Welch", + "email": "whatthejeff@gmail.com" + }, + { + "name": "Volker Dusch", + "email": "github@wallbash.com" + }, + { + "name": "Bernhard Schussek", + "email": "bschussek@2bepublished.at" } ], - "description": "Simple template engine.", - "homepage": "https://github.com/sebastianbergmann/php-text-template/", + "description": "Provides the functionality to compare PHP values for equality", + "homepage": "https://github.com/sebastianbergmann/comparator", "keywords": [ - "template" + "comparator", + "compare", + "equality" ], "support": { - "issues": "https://github.com/sebastianbergmann/php-text-template/issues", - "security": "https://github.com/sebastianbergmann/php-text-template/security/policy", - "source": "https://github.com/sebastianbergmann/php-text-template/tree/5.0.0" + "issues": "https://github.com/sebastianbergmann/comparator/issues", + "security": "https://github.com/sebastianbergmann/comparator/security/policy", + "source": "https://github.com/sebastianbergmann/comparator/tree/8.2.1" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/comparator", + "type": "tidelift" } ], - "time": "2025-02-07T04:59:16+00:00" + "time": "2026-05-21T04:46:40+00:00" }, { - "name": "phpunit/php-timer", - "version": "8.0.0", + "name": "sebastian/complexity", + "version": "6.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/php-timer.git", - "reference": "f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc" + "url": "https://github.com/sebastianbergmann/complexity.git", + "reference": "c5651c795c98093480df79350cb050813fc7a2f3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc", - "reference": "f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc", + "url": "https://api.github.com/repos/sebastianbergmann/complexity/zipball/c5651c795c98093480df79350cb050813fc7a2f3", + "reference": "c5651c795c98093480df79350cb050813fc7a2f3", "shasum": "" }, "require": { - "php": ">=8.3" + "nikic/php-parser": "^5.0", + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "6.0-dev" } }, "autoload": { @@ -4659,78 +4395,61 @@ "role": "lead" } ], - "description": "Utility class for timing", - "homepage": "https://github.com/sebastianbergmann/php-timer/", - "keywords": [ - "timer" - ], + "description": "Library for calculating the complexity of PHP code units", + "homepage": "https://github.com/sebastianbergmann/complexity", "support": { - "issues": "https://github.com/sebastianbergmann/php-timer/issues", - "security": "https://github.com/sebastianbergmann/php-timer/security/policy", - "source": "https://github.com/sebastianbergmann/php-timer/tree/8.0.0" + "issues": "https://github.com/sebastianbergmann/complexity/issues", + "security": "https://github.com/sebastianbergmann/complexity/security/policy", + "source": "https://github.com/sebastianbergmann/complexity/tree/6.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/complexity", + "type": "tidelift" } ], - "time": "2025-02-07T04:59:38+00:00" + "time": "2026-02-06T04:41:32+00:00" }, { - "name": "phpunit/phpunit", - "version": "12.3.8", + "name": "sebastian/diff", + "version": "8.3.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "9d68c1b41fc21aac106c71cde4669fe7b99fca10" + "url": "https://github.com/sebastianbergmann/diff.git", + "reference": "b36d33b6e796513de7cb7df053afb3f55eefcd47" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/9d68c1b41fc21aac106c71cde4669fe7b99fca10", - "reference": "9d68c1b41fc21aac106c71cde4669fe7b99fca10", + "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/b36d33b6e796513de7cb7df053afb3f55eefcd47", + "reference": "b36d33b6e796513de7cb7df053afb3f55eefcd47", "shasum": "" }, "require": { - "ext-dom": "*", - "ext-json": "*", - "ext-libxml": "*", - "ext-mbstring": "*", - "ext-xml": "*", - "ext-xmlwriter": "*", - "myclabs/deep-copy": "^1.13.4", - "phar-io/manifest": "^2.0.4", - "phar-io/version": "^3.2.1", - "php": ">=8.3", - "phpunit/php-code-coverage": "^12.3.6", - "phpunit/php-file-iterator": "^6.0.0", - "phpunit/php-invoker": "^6.0.0", - "phpunit/php-text-template": "^5.0.0", - "phpunit/php-timer": "^8.0.0", - "sebastian/cli-parser": "^4.0.0", - "sebastian/comparator": "^7.1.3", - "sebastian/diff": "^7.0.0", - "sebastian/environment": "^8.0.3", - "sebastian/exporter": "^7.0.0", - "sebastian/global-state": "^8.0.2", - "sebastian/object-enumerator": "^7.0.0", - "sebastian/type": "^6.0.3", - "sebastian/version": "^6.0.0", - "staabm/side-effects-detector": "^1.0.5" + "php": ">=8.4" + }, + "require-dev": { + "phpunit/phpunit": "^13.0", + "symfony/process": "^7.2" }, - "bin": [ - "phpunit" - ], "type": "library", "extra": { "branch-alias": { - "dev-main": "12.3-dev" + "dev-main": "8.3-dev" } }, "autoload": { - "files": [ - "src/Framework/Assert/Functions.php" - ], "classmap": [ "src/" ] @@ -4742,27 +4461,27 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" + "email": "sebastian@phpunit.de" + }, + { + "name": "Kore Nordmann", + "email": "mail@kore-nordmann.de" } ], - "description": "The PHP Unit Testing framework.", - "homepage": "https://phpunit.de/", + "description": "Diff implementation", + "homepage": "https://github.com/sebastianbergmann/diff", "keywords": [ - "phpunit", - "testing", - "xunit" + "diff", + "udiff", + "unidiff", + "unified diff" ], "support": { - "issues": "https://github.com/sebastianbergmann/phpunit/issues", - "security": "https://github.com/sebastianbergmann/phpunit/security/policy", - "source": "https://github.com/sebastianbergmann/phpunit/tree/12.3.8" + "issues": "https://github.com/sebastianbergmann/diff/issues", + "security": "https://github.com/sebastianbergmann/diff/security/policy", + "source": "https://github.com/sebastianbergmann/diff/tree/8.3.0" }, "funding": [ - { - "url": "https://phpunit.de/sponsors.html", - "type": "custom" - }, { "url": "https://github.com/sebastianbergmann", "type": "github" @@ -4776,187 +4495,202 @@ "type": "thanks_dev" }, { - "url": "https://tidelift.com/funding/github/packagist/phpunit/phpunit", + "url": "https://tidelift.com/funding/github/packagist/sebastian/diff", "type": "tidelift" } ], - "time": "2025-09-03T06:25:17+00:00" + "time": "2026-05-15T04:58:09+00:00" }, { - "name": "psy/psysh", - "version": "v0.12.10", + "name": "sebastian/environment", + "version": "9.3.1", "source": { "type": "git", - "url": "https://github.com/bobthecow/psysh.git", - "reference": "6e80abe6f2257121f1eb9a4c55bf29d921025b22" + "url": "https://github.com/sebastianbergmann/environment.git", + "reference": "a15fa79a5f5cfd0e9f6817dbcdb0048e99efa146" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/bobthecow/psysh/zipball/6e80abe6f2257121f1eb9a4c55bf29d921025b22", - "reference": "6e80abe6f2257121f1eb9a4c55bf29d921025b22", + "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/a15fa79a5f5cfd0e9f6817dbcdb0048e99efa146", + "reference": "a15fa79a5f5cfd0e9f6817dbcdb0048e99efa146", "shasum": "" }, "require": { - "ext-json": "*", - "ext-tokenizer": "*", - "nikic/php-parser": "^5.0 || ^4.0", - "php": "^8.0 || ^7.4", - "symfony/console": "^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4", - "symfony/var-dumper": "^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4" - }, - "conflict": { - "symfony/console": "4.4.37 || 5.3.14 || 5.3.15 || 5.4.3 || 5.4.4 || 6.0.3 || 6.0.4" + "php": ">=8.4" }, "require-dev": { - "bamarni/composer-bin-plugin": "^1.2" + "phpunit/phpunit": "^13.1.10" }, "suggest": { - "ext-pcntl": "Enabling the PCNTL extension makes PsySH a lot happier :)", - "ext-pdo-sqlite": "The doc command requires SQLite to work.", - "ext-posix": "If you have PCNTL, you'll want the POSIX extension as well." + "ext-posix": "*" }, - "bin": [ - "bin/psysh" - ], "type": "library", "extra": { - "bamarni-bin": { - "bin-links": false, - "forward-command": false - }, "branch-alias": { - "dev-main": "0.12.x-dev" + "dev-main": "9.3-dev" } }, "autoload": { - "files": [ - "src/functions.php" - ], - "psr-4": { - "Psy\\": "src/" - } + "classmap": [ + "src/" + ] }, "notification-url": "https://packagist.org/downloads/", "license": [ - "MIT" + "BSD-3-Clause" ], "authors": [ { - "name": "Justin Hileman", - "email": "justin@justinhileman.info" + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" } ], - "description": "An interactive shell for modern PHP.", - "homepage": "https://psysh.org", + "description": "Provides functionality to handle HHVM/PHP environments", + "homepage": "https://github.com/sebastianbergmann/environment", "keywords": [ - "REPL", - "console", - "interactive", - "shell" + "Xdebug", + "environment", + "hhvm" ], "support": { - "issues": "https://github.com/bobthecow/psysh/issues", - "source": "https://github.com/bobthecow/psysh/tree/v0.12.10" + "issues": "https://github.com/sebastianbergmann/environment/issues", + "security": "https://github.com/sebastianbergmann/environment/security/policy", + "source": "https://github.com/sebastianbergmann/environment/tree/9.3.1" }, - "time": "2025-08-04T12:39:37+00:00" + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/environment", + "type": "tidelift" + } + ], + "time": "2026-05-21T08:47:00+00:00" }, { - "name": "react/promise", - "version": "v3.3.0", + "name": "sebastian/exporter", + "version": "8.1.0", "source": { "type": "git", - "url": "https://github.com/reactphp/promise.git", - "reference": "23444f53a813a3296c1368bb104793ce8d88f04a" + "url": "https://github.com/sebastianbergmann/exporter.git", + "reference": "c0d29a945f8cf82f300a05e69874508e307ca4c6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/reactphp/promise/zipball/23444f53a813a3296c1368bb104793ce8d88f04a", - "reference": "23444f53a813a3296c1368bb104793ce8d88f04a", + "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/c0d29a945f8cf82f300a05e69874508e307ca4c6", + "reference": "c0d29a945f8cf82f300a05e69874508e307ca4c6", "shasum": "" }, "require": { - "php": ">=7.1.0" + "ext-mbstring": "*", + "php": ">=8.4", + "sebastian/recursion-context": "^8.0" }, "require-dev": { - "phpstan/phpstan": "1.12.28 || 1.4.10", - "phpunit/phpunit": "^9.6 || ^7.5" + "phpunit/phpunit": "^13.1.10" }, "type": "library", - "autoload": { - "files": [ - "src/functions_include.php" - ], - "psr-4": { - "React\\Promise\\": "src/" + "extra": { + "branch-alias": { + "dev-main": "8.1-dev" } }, + "autoload": { + "classmap": [ + "src/" + ] + }, "notification-url": "https://packagist.org/downloads/", "license": [ - "MIT" + "BSD-3-Clause" ], "authors": [ { - "name": "Jan Sorgalla", - "email": "jsorgalla@gmail.com", - "homepage": "https://sorgalla.com/" + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de" }, { - "name": "Christian Lück", - "email": "christian@clue.engineering", - "homepage": "https://clue.engineering/" + "name": "Jeff Welch", + "email": "whatthejeff@gmail.com" }, { - "name": "Cees-Jan Kiewiet", - "email": "reactphp@ceesjankiewiet.nl", - "homepage": "https://wyrihaximus.net/" + "name": "Volker Dusch", + "email": "github@wallbash.com" + }, + { + "name": "Adam Harvey", + "email": "aharvey@php.net" }, { - "name": "Chris Boden", - "email": "cboden@gmail.com", - "homepage": "https://cboden.dev/" + "name": "Bernhard Schussek", + "email": "bschussek@gmail.com" } ], - "description": "A lightweight implementation of CommonJS Promises/A for PHP", + "description": "Provides the functionality to export PHP variables for visualization", + "homepage": "https://www.github.com/sebastianbergmann/exporter", "keywords": [ - "promise", - "promises" + "export", + "exporter" ], "support": { - "issues": "https://github.com/reactphp/promise/issues", - "source": "https://github.com/reactphp/promise/tree/v3.3.0" + "issues": "https://github.com/sebastianbergmann/exporter/issues", + "security": "https://github.com/sebastianbergmann/exporter/security/policy", + "source": "https://github.com/sebastianbergmann/exporter/tree/8.1.0" }, "funding": [ { - "url": "https://opencollective.com/reactphp", - "type": "open_collective" + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/exporter", + "type": "tidelift" } ], - "time": "2025-08-19T18:57:03+00:00" + "time": "2026-05-21T11:50:56+00:00" }, { - "name": "sebastian/cli-parser", - "version": "4.0.0", + "name": "sebastian/git-state", + "version": "1.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/cli-parser.git", - "reference": "6d584c727d9114bcdc14c86711cd1cad51778e7c" + "url": "https://github.com/sebastianbergmann/git-state.git", + "reference": "792a952e0eba55b6960a48aeceb9f371aad1f76b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/cli-parser/zipball/6d584c727d9114bcdc14c86711cd1cad51778e7c", - "reference": "6d584c727d9114bcdc14c86711cd1cad51778e7c", + "url": "https://api.github.com/repos/sebastianbergmann/git-state/zipball/792a952e0eba55b6960a48aeceb9f371aad1f76b", + "reference": "792a952e0eba55b6960a48aeceb9f371aad1f76b", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "4.0-dev" + "dev-main": "1.0-dev" } }, "autoload": { @@ -4975,52 +4709,60 @@ "role": "lead" } ], - "description": "Library for parsing CLI options", - "homepage": "https://github.com/sebastianbergmann/cli-parser", + "description": "Library for describing the state of a Git checkout", + "homepage": "https://github.com/sebastianbergmann/git-state", "support": { - "issues": "https://github.com/sebastianbergmann/cli-parser/issues", - "security": "https://github.com/sebastianbergmann/cli-parser/security/policy", - "source": "https://github.com/sebastianbergmann/cli-parser/tree/4.0.0" + "issues": "https://github.com/sebastianbergmann/git-state/issues", + "security": "https://github.com/sebastianbergmann/git-state/security/policy", + "source": "https://github.com/sebastianbergmann/git-state/tree/1.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/git-state", + "type": "tidelift" } ], - "time": "2025-02-07T04:53:50+00:00" + "time": "2026-03-21T12:54:28+00:00" }, { - "name": "sebastian/comparator", - "version": "7.1.3", + "name": "sebastian/global-state", + "version": "9.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/comparator.git", - "reference": "dc904b4bb3ab070865fa4068cd84f3da8b945148" + "url": "https://github.com/sebastianbergmann/global-state.git", + "reference": "e52e3dc22441e6218c710afe72c3042f8fc41ea7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/dc904b4bb3ab070865fa4068cd84f3da8b945148", - "reference": "dc904b4bb3ab070865fa4068cd84f3da8b945148", + "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/e52e3dc22441e6218c710afe72c3042f8fc41ea7", + "reference": "e52e3dc22441e6218c710afe72c3042f8fc41ea7", "shasum": "" }, "require": { - "ext-dom": "*", - "ext-mbstring": "*", - "php": ">=8.3", - "sebastian/diff": "^7.0", - "sebastian/exporter": "^7.0" + "php": ">=8.4", + "sebastian/object-reflector": "^6.0", + "sebastian/recursion-context": "^8.0" }, "require-dev": { - "phpunit/phpunit": "^12.2" - }, - "suggest": { - "ext-bcmath": "For comparing BcMath\\Number objects" + "ext-dom": "*", + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.1-dev" + "dev-main": "9.0-dev" } }, "autoload": { @@ -5036,31 +4778,17 @@ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" - }, - { - "name": "Jeff Welch", - "email": "whatthejeff@gmail.com" - }, - { - "name": "Volker Dusch", - "email": "github@wallbash.com" - }, - { - "name": "Bernhard Schussek", - "email": "bschussek@2bepublished.at" } ], - "description": "Provides the functionality to compare PHP values for equality", - "homepage": "https://github.com/sebastianbergmann/comparator", + "description": "Snapshotting of global state", + "homepage": "https://www.github.com/sebastianbergmann/global-state", "keywords": [ - "comparator", - "compare", - "equality" + "global state" ], "support": { - "issues": "https://github.com/sebastianbergmann/comparator/issues", - "security": "https://github.com/sebastianbergmann/comparator/security/policy", - "source": "https://github.com/sebastianbergmann/comparator/tree/7.1.3" + "issues": "https://github.com/sebastianbergmann/global-state/issues", + "security": "https://github.com/sebastianbergmann/global-state/security/policy", + "source": "https://github.com/sebastianbergmann/global-state/tree/9.0.0" }, "funding": [ { @@ -5076,32 +4804,32 @@ "type": "thanks_dev" }, { - "url": "https://tidelift.com/funding/github/packagist/sebastian/comparator", + "url": "https://tidelift.com/funding/github/packagist/sebastian/global-state", "type": "tidelift" } ], - "time": "2025-08-20T11:27:00+00:00" + "time": "2026-02-06T04:45:13+00:00" }, { - "name": "sebastian/complexity", - "version": "5.0.0", + "name": "sebastian/lines-of-code", + "version": "5.0.1", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/complexity.git", - "reference": "bad4316aba5303d0221f43f8cee37eb58d384bbb" + "url": "https://github.com/sebastianbergmann/lines-of-code.git", + "reference": "d2cff273a90c79b0eb590baa682d4b5c318bdbb7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/complexity/zipball/bad4316aba5303d0221f43f8cee37eb58d384bbb", - "reference": "bad4316aba5303d0221f43f8cee37eb58d384bbb", + "url": "https://api.github.com/repos/sebastianbergmann/lines-of-code/zipball/d2cff273a90c79b0eb590baa682d4b5c318bdbb7", + "reference": "d2cff273a90c79b0eb590baa682d4b5c318bdbb7", "shasum": "" }, "require": { - "nikic/php-parser": "^5.0", - "php": ">=8.3" + "nikic/php-parser": "^5.7.0", + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "type": "library", "extra": { @@ -5125,46 +4853,59 @@ "role": "lead" } ], - "description": "Library for calculating the complexity of PHP code units", - "homepage": "https://github.com/sebastianbergmann/complexity", + "description": "Library for counting the lines of code in PHP source code", + "homepage": "https://github.com/sebastianbergmann/lines-of-code", "support": { - "issues": "https://github.com/sebastianbergmann/complexity/issues", - "security": "https://github.com/sebastianbergmann/complexity/security/policy", - "source": "https://github.com/sebastianbergmann/complexity/tree/5.0.0" + "issues": "https://github.com/sebastianbergmann/lines-of-code/issues", + "security": "https://github.com/sebastianbergmann/lines-of-code/security/policy", + "source": "https://github.com/sebastianbergmann/lines-of-code/tree/5.0.1" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/lines-of-code", + "type": "tidelift" } ], - "time": "2025-02-07T04:55:25+00:00" + "time": "2026-05-19T16:23:37+00:00" }, { - "name": "sebastian/diff", - "version": "7.0.0", + "name": "sebastian/object-enumerator", + "version": "8.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/diff.git", - "reference": "7ab1ea946c012266ca32390913653d844ecd085f" + "url": "https://github.com/sebastianbergmann/object-enumerator.git", + "reference": "b39ab125fd9a7434b0ecbc4202eebce11a98cfc5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7ab1ea946c012266ca32390913653d844ecd085f", - "reference": "7ab1ea946c012266ca32390913653d844ecd085f", + "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/b39ab125fd9a7434b0ecbc4202eebce11a98cfc5", + "reference": "b39ab125fd9a7434b0ecbc4202eebce11a98cfc5", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4", + "sebastian/object-reflector": "^6.0", + "sebastian/recursion-context": "^8.0" }, "require-dev": { - "phpunit/phpunit": "^12.0", - "symfony/process": "^7.2" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.0-dev" } }, "autoload": { @@ -5180,60 +4921,59 @@ { "name": "Sebastian Bergmann", "email": "sebastian@phpunit.de" - }, - { - "name": "Kore Nordmann", - "email": "mail@kore-nordmann.de" } ], - "description": "Diff implementation", - "homepage": "https://github.com/sebastianbergmann/diff", - "keywords": [ - "diff", - "udiff", - "unidiff", - "unified diff" - ], + "description": "Traverses array structures and object graphs to enumerate all referenced objects", + "homepage": "https://github.com/sebastianbergmann/object-enumerator/", "support": { - "issues": "https://github.com/sebastianbergmann/diff/issues", - "security": "https://github.com/sebastianbergmann/diff/security/policy", - "source": "https://github.com/sebastianbergmann/diff/tree/7.0.0" + "issues": "https://github.com/sebastianbergmann/object-enumerator/issues", + "security": "https://github.com/sebastianbergmann/object-enumerator/security/policy", + "source": "https://github.com/sebastianbergmann/object-enumerator/tree/8.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/object-enumerator", + "type": "tidelift" } ], - "time": "2025-02-07T04:55:46+00:00" + "time": "2026-02-06T04:46:36+00:00" }, { - "name": "sebastian/environment", - "version": "8.0.3", + "name": "sebastian/object-reflector", + "version": "6.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/environment.git", - "reference": "24a711b5c916efc6d6e62aa65aa2ec98fef77f68" + "url": "https://github.com/sebastianbergmann/object-reflector.git", + "reference": "3ca042c2c60b0eab094f8a1b6a7093f4d4c72200" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/24a711b5c916efc6d6e62aa65aa2ec98fef77f68", - "reference": "24a711b5c916efc6d6e62aa65aa2ec98fef77f68", + "url": "https://api.github.com/repos/sebastianbergmann/object-reflector/zipball/3ca042c2c60b0eab094f8a1b6a7093f4d4c72200", + "reference": "3ca042c2c60b0eab094f8a1b6a7093f4d4c72200", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" - }, - "suggest": { - "ext-posix": "*" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "6.0-dev" } }, "autoload": { @@ -5251,17 +4991,12 @@ "email": "sebastian@phpunit.de" } ], - "description": "Provides functionality to handle HHVM/PHP environments", - "homepage": "https://github.com/sebastianbergmann/environment", - "keywords": [ - "Xdebug", - "environment", - "hhvm" - ], + "description": "Allows reflection of object attributes, including inherited and non-public ones", + "homepage": "https://github.com/sebastianbergmann/object-reflector/", "support": { - "issues": "https://github.com/sebastianbergmann/environment/issues", - "security": "https://github.com/sebastianbergmann/environment/security/policy", - "source": "https://github.com/sebastianbergmann/environment/tree/8.0.3" + "issues": "https://github.com/sebastianbergmann/object-reflector/issues", + "security": "https://github.com/sebastianbergmann/object-reflector/security/policy", + "source": "https://github.com/sebastianbergmann/object-reflector/tree/6.0.0" }, "funding": [ { @@ -5277,38 +5012,36 @@ "type": "thanks_dev" }, { - "url": "https://tidelift.com/funding/github/packagist/sebastian/environment", + "url": "https://tidelift.com/funding/github/packagist/sebastian/object-reflector", "type": "tidelift" } ], - "time": "2025-08-12T14:11:56+00:00" + "time": "2026-02-06T04:47:13+00:00" }, { - "name": "sebastian/exporter", - "version": "7.0.0", + "name": "sebastian/recursion-context", + "version": "8.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/exporter.git", - "reference": "76432aafc58d50691a00d86d0632f1217a47b688" + "url": "https://github.com/sebastianbergmann/recursion-context.git", + "reference": "74c5af21f6a5833e91767ca068c4d3dfec15317e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/76432aafc58d50691a00d86d0632f1217a47b688", - "reference": "76432aafc58d50691a00d86d0632f1217a47b688", + "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/74c5af21f6a5833e91767ca068c4d3dfec15317e", + "reference": "74c5af21f6a5833e91767ca068c4d3dfec15317e", "shasum": "" }, "require": { - "ext-mbstring": "*", - "php": ">=8.3", - "sebastian/recursion-context": "^7.0" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.0-dev" } }, "autoload": { @@ -5329,65 +5062,128 @@ "name": "Jeff Welch", "email": "whatthejeff@gmail.com" }, - { - "name": "Volker Dusch", - "email": "github@wallbash.com" - }, { "name": "Adam Harvey", "email": "aharvey@php.net" + } + ], + "description": "Provides functionality to recursively process PHP variables", + "homepage": "https://github.com/sebastianbergmann/recursion-context", + "support": { + "issues": "https://github.com/sebastianbergmann/recursion-context/issues", + "security": "https://github.com/sebastianbergmann/recursion-context/security/policy", + "source": "https://github.com/sebastianbergmann/recursion-context/tree/8.0.0" + }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" }, { - "name": "Bernhard Schussek", - "email": "bschussek@gmail.com" + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/recursion-context", + "type": "tidelift" } ], - "description": "Provides the functionality to export PHP variables for visualization", - "homepage": "https://www.github.com/sebastianbergmann/exporter", - "keywords": [ - "export", - "exporter" + "time": "2026-02-06T04:51:28+00:00" + }, + { + "name": "sebastian/type", + "version": "7.0.1", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/type.git", + "reference": "fee0309275847fefd7636167085e379c1dbf6990" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/type/zipball/fee0309275847fefd7636167085e379c1dbf6990", + "reference": "fee0309275847fefd7636167085e379c1dbf6990", + "shasum": "" + }, + "require": { + "php": ">=8.4" + }, + "require-dev": { + "phpunit/phpunit": "^13.1.10" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "7.0-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } ], + "description": "Collection of value objects that represent the types of the PHP type system", + "homepage": "https://github.com/sebastianbergmann/type", "support": { - "issues": "https://github.com/sebastianbergmann/exporter/issues", - "security": "https://github.com/sebastianbergmann/exporter/security/policy", - "source": "https://github.com/sebastianbergmann/exporter/tree/7.0.0" + "issues": "https://github.com/sebastianbergmann/type/issues", + "security": "https://github.com/sebastianbergmann/type/security/policy", + "source": "https://github.com/sebastianbergmann/type/tree/7.0.1" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/type", + "type": "tidelift" } ], - "time": "2025-02-07T04:56:42+00:00" + "time": "2026-05-20T06:49:11+00:00" }, { - "name": "sebastian/global-state", - "version": "8.0.2", + "name": "sebastian/version", + "version": "7.0.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/global-state.git", - "reference": "ef1377171613d09edd25b7816f05be8313f9115d" + "url": "https://github.com/sebastianbergmann/version.git", + "reference": "ad37a5552c8e2b88572249fdc19b6da7792e021b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/ef1377171613d09edd25b7816f05be8313f9115d", - "reference": "ef1377171613d09edd25b7816f05be8313f9115d", + "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/ad37a5552c8e2b88572249fdc19b6da7792e021b", + "reference": "ad37a5552c8e2b88572249fdc19b6da7792e021b", "shasum": "" }, "require": { - "php": ">=8.3", - "sebastian/object-reflector": "^5.0", - "sebastian/recursion-context": "^7.0" - }, - "require-dev": { - "ext-dom": "*", - "phpunit/phpunit": "^12.0" + "php": ">=8.4" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "7.0-dev" } }, "autoload": { @@ -5402,18 +5198,16 @@ "authors": [ { "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" + "email": "sebastian@phpunit.de", + "role": "lead" } ], - "description": "Snapshotting of global state", - "homepage": "https://www.github.com/sebastianbergmann/global-state", - "keywords": [ - "global state" - ], + "description": "Library that helps with managing the version number of Git-hosted PHP projects", + "homepage": "https://github.com/sebastianbergmann/version", "support": { - "issues": "https://github.com/sebastianbergmann/global-state/issues", - "security": "https://github.com/sebastianbergmann/global-state/security/policy", - "source": "https://github.com/sebastianbergmann/global-state/tree/8.0.2" + "issues": "https://github.com/sebastianbergmann/version/issues", + "security": "https://github.com/sebastianbergmann/version/security/policy", + "source": "https://github.com/sebastianbergmann/version/tree/7.0.0" }, "funding": [ { @@ -5429,412 +5223,425 @@ "type": "thanks_dev" }, { - "url": "https://tidelift.com/funding/github/packagist/sebastian/global-state", + "url": "https://tidelift.com/funding/github/packagist/sebastian/version", "type": "tidelift" } ], - "time": "2025-08-29T11:29:25+00:00" + "time": "2026-02-06T04:52:52+00:00" }, { - "name": "sebastian/lines-of-code", - "version": "4.0.0", + "name": "seld/jsonlint", + "version": "1.11.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/lines-of-code.git", - "reference": "97ffee3bcfb5805568d6af7f0f893678fc076d2f" + "url": "https://github.com/Seldaek/jsonlint.git", + "reference": "1748aaf847fc731cfad7725aec413ee46f0cc3a2" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/lines-of-code/zipball/97ffee3bcfb5805568d6af7f0f893678fc076d2f", - "reference": "97ffee3bcfb5805568d6af7f0f893678fc076d2f", + "url": "https://api.github.com/repos/Seldaek/jsonlint/zipball/1748aaf847fc731cfad7725aec413ee46f0cc3a2", + "reference": "1748aaf847fc731cfad7725aec413ee46f0cc3a2", "shasum": "" }, "require": { - "nikic/php-parser": "^5.0", - "php": ">=8.3" + "php": "^5.3 || ^7.0 || ^8.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpstan/phpstan": "^1.11", + "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0 || ^8.5.13" }, + "bin": [ + "bin/jsonlint" + ], "type": "library", - "extra": { - "branch-alias": { - "dev-main": "4.0-dev" - } - }, "autoload": { - "classmap": [ - "src/" - ] + "psr-4": { + "Seld\\JsonLint\\": "src/Seld/JsonLint/" + } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "MIT" ], "authors": [ { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" + "name": "Jordi Boggiano", + "email": "j.boggiano@seld.be", + "homepage": "https://seld.be" } ], - "description": "Library for counting the lines of code in PHP source code", - "homepage": "https://github.com/sebastianbergmann/lines-of-code", + "description": "JSON Linter", + "keywords": [ + "json", + "linter", + "parser", + "validator" + ], "support": { - "issues": "https://github.com/sebastianbergmann/lines-of-code/issues", - "security": "https://github.com/sebastianbergmann/lines-of-code/security/policy", - "source": "https://github.com/sebastianbergmann/lines-of-code/tree/4.0.0" + "issues": "https://github.com/Seldaek/jsonlint/issues", + "source": "https://github.com/Seldaek/jsonlint/tree/1.11.0" }, "funding": [ { - "url": "https://github.com/sebastianbergmann", + "url": "https://github.com/Seldaek", "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/seld/jsonlint", + "type": "tidelift" } ], - "time": "2025-02-07T04:57:28+00:00" + "time": "2024-07-11T14:55:45+00:00" }, { - "name": "sebastian/object-enumerator", - "version": "7.0.0", + "name": "seld/phar-utils", + "version": "1.2.1", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/object-enumerator.git", - "reference": "1effe8e9b8e068e9ae228e542d5d11b5d16db894" + "url": "https://github.com/Seldaek/phar-utils.git", + "reference": "ea2f4014f163c1be4c601b9b7bd6af81ba8d701c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/1effe8e9b8e068e9ae228e542d5d11b5d16db894", - "reference": "1effe8e9b8e068e9ae228e542d5d11b5d16db894", + "url": "https://api.github.com/repos/Seldaek/phar-utils/zipball/ea2f4014f163c1be4c601b9b7bd6af81ba8d701c", + "reference": "ea2f4014f163c1be4c601b9b7bd6af81ba8d701c", "shasum": "" }, "require": { - "php": ">=8.3", - "sebastian/object-reflector": "^5.0", - "sebastian/recursion-context": "^7.0" - }, - "require-dev": { - "phpunit/phpunit": "^12.0" + "php": ">=5.3" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-master": "1.x-dev" } }, "autoload": { - "classmap": [ - "src/" - ] + "psr-4": { + "Seld\\PharUtils\\": "src/" + } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "MIT" ], "authors": [ { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" + "name": "Jordi Boggiano", + "email": "j.boggiano@seld.be" } ], - "description": "Traverses array structures and object graphs to enumerate all referenced objects", - "homepage": "https://github.com/sebastianbergmann/object-enumerator/", + "description": "PHAR file format utilities, for when PHP phars you up", + "keywords": [ + "phar" + ], "support": { - "issues": "https://github.com/sebastianbergmann/object-enumerator/issues", - "security": "https://github.com/sebastianbergmann/object-enumerator/security/policy", - "source": "https://github.com/sebastianbergmann/object-enumerator/tree/7.0.0" + "issues": "https://github.com/Seldaek/phar-utils/issues", + "source": "https://github.com/Seldaek/phar-utils/tree/1.2.1" }, - "funding": [ - { - "url": "https://github.com/sebastianbergmann", - "type": "github" - } - ], - "time": "2025-02-07T04:57:48+00:00" + "time": "2022-08-31T10:31:18+00:00" }, { - "name": "sebastian/object-reflector", - "version": "5.0.0", + "name": "seld/signal-handler", + "version": "2.0.2", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/object-reflector.git", - "reference": "4bfa827c969c98be1e527abd576533293c634f6a" + "url": "https://github.com/Seldaek/signal-handler.git", + "reference": "04a6112e883ad76c0ada8e4a9f7520bbfdb6bb98" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/object-reflector/zipball/4bfa827c969c98be1e527abd576533293c634f6a", - "reference": "4bfa827c969c98be1e527abd576533293c634f6a", + "url": "https://api.github.com/repos/Seldaek/signal-handler/zipball/04a6112e883ad76c0ada8e4a9f7520bbfdb6bb98", + "reference": "04a6112e883ad76c0ada8e4a9f7520bbfdb6bb98", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=7.2.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpstan/phpstan": "^1", + "phpstan/phpstan-deprecation-rules": "^1.0", + "phpstan/phpstan-phpunit": "^1", + "phpstan/phpstan-strict-rules": "^1.3", + "phpunit/phpunit": "^7.5.20 || ^8.5.23", + "psr/log": "^1 || ^2 || ^3" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "2.x-dev" } }, "autoload": { - "classmap": [ - "src/" - ] + "psr-4": { + "Seld\\Signal\\": "src/" + } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "MIT" ], "authors": [ { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" + "name": "Jordi Boggiano", + "email": "j.boggiano@seld.be", + "homepage": "http://seld.be" } ], - "description": "Allows reflection of object attributes, including inherited and non-public ones", - "homepage": "https://github.com/sebastianbergmann/object-reflector/", + "description": "Simple unix signal handler that silently fails where signals are not supported for easy cross-platform development", + "keywords": [ + "posix", + "sigint", + "signal", + "sigterm", + "unix" + ], "support": { - "issues": "https://github.com/sebastianbergmann/object-reflector/issues", - "security": "https://github.com/sebastianbergmann/object-reflector/security/policy", - "source": "https://github.com/sebastianbergmann/object-reflector/tree/5.0.0" + "issues": "https://github.com/Seldaek/signal-handler/issues", + "source": "https://github.com/Seldaek/signal-handler/tree/2.0.2" }, - "funding": [ - { - "url": "https://github.com/sebastianbergmann", - "type": "github" - } - ], - "time": "2025-02-07T04:58:17+00:00" + "time": "2023-09-03T09:24:00+00:00" }, { - "name": "sebastian/recursion-context", - "version": "7.0.1", + "name": "slevomat/coding-standard", + "version": "8.29.0", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/recursion-context.git", - "reference": "0b01998a7d5b1f122911a66bebcb8d46f0c82d8c" + "url": "https://github.com/slevomat/coding-standard.git", + "reference": "81fce13c4ef4b53a03e5cfa6ce36afc191c1598e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/0b01998a7d5b1f122911a66bebcb8d46f0c82d8c", - "reference": "0b01998a7d5b1f122911a66bebcb8d46f0c82d8c", + "url": "https://api.github.com/repos/slevomat/coding-standard/zipball/81fce13c4ef4b53a03e5cfa6ce36afc191c1598e", + "reference": "81fce13c4ef4b53a03e5cfa6ce36afc191c1598e", "shasum": "" }, "require": { - "php": ">=8.3" + "dealerdirect/phpcodesniffer-composer-installer": "^0.7 || ^1.2.1", + "php": "^7.4 || ^8.0", + "phpstan/phpdoc-parser": "^2.3.2", + "squizlabs/php_codesniffer": "^4.0.1" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phing/phing": "3.0.1|3.1.2", + "php-parallel-lint/php-parallel-lint": "1.4.0", + "phpstan/phpstan": "2.1.54", + "phpstan/phpstan-deprecation-rules": "2.0.4", + "phpstan/phpstan-phpunit": "2.0.16", + "phpstan/phpstan-strict-rules": "2.0.11", + "phpunit/phpunit": "9.6.34|10.5.63|11.4.4|11.5.55|12.5.24" }, - "type": "library", + "type": "phpcodesniffer-standard", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-master": "8.x-dev" } }, "autoload": { - "classmap": [ - "src/" - ] + "psr-4": { + "SlevomatCodingStandard\\": "SlevomatCodingStandard/" + } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "MIT" ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de" - }, - { - "name": "Jeff Welch", - "email": "whatthejeff@gmail.com" - }, - { - "name": "Adam Harvey", - "email": "aharvey@php.net" - } + "description": "Slevomat Coding Standard for PHP_CodeSniffer complements Consistence Coding Standard by providing sniffs with additional checks.", + "keywords": [ + "dev", + "phpcs" ], - "description": "Provides functionality to recursively process PHP variables", - "homepage": "https://github.com/sebastianbergmann/recursion-context", "support": { - "issues": "https://github.com/sebastianbergmann/recursion-context/issues", - "security": "https://github.com/sebastianbergmann/recursion-context/security/policy", - "source": "https://github.com/sebastianbergmann/recursion-context/tree/7.0.1" + "issues": "https://github.com/slevomat/coding-standard/issues", + "source": "https://github.com/slevomat/coding-standard/tree/8.29.0" }, "funding": [ { - "url": "https://github.com/sebastianbergmann", + "url": "https://github.com/kukulich", "type": "github" }, { - "url": "https://liberapay.com/sebastianbergmann", - "type": "liberapay" - }, - { - "url": "https://thanks.dev/u/gh/sebastianbergmann", - "type": "thanks_dev" - }, - { - "url": "https://tidelift.com/funding/github/packagist/sebastian/recursion-context", + "url": "https://tidelift.com/funding/github/packagist/slevomat/coding-standard", "type": "tidelift" } ], - "time": "2025-08-13T04:44:59+00:00" + "time": "2026-05-07T05:48:08+00:00" }, { - "name": "sebastian/type", - "version": "6.0.3", + "name": "squizlabs/php_codesniffer", + "version": "4.0.1", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/type.git", - "reference": "e549163b9760b8f71f191651d22acf32d56d6d4d" + "url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git", + "reference": "0525c73950de35ded110cffafb9892946d7771b5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/type/zipball/e549163b9760b8f71f191651d22acf32d56d6d4d", - "reference": "e549163b9760b8f71f191651d22acf32d56d6d4d", + "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/0525c73950de35ded110cffafb9892946d7771b5", + "reference": "0525c73950de35ded110cffafb9892946d7771b5", "shasum": "" }, "require": { - "php": ">=8.3" - }, - "require-dev": { - "phpunit/phpunit": "^12.0" - }, - "type": "library", - "extra": { - "branch-alias": { - "dev-main": "6.0-dev" - } + "ext-simplexml": "*", + "ext-tokenizer": "*", + "ext-xmlwriter": "*", + "php": ">=7.2.0" }, - "autoload": { - "classmap": [ - "src/" - ] + "require-dev": { + "phpunit/phpunit": "^8.4.0 || ^9.3.4 || ^10.5.32 || 11.3.3 - 11.5.28 || ^11.5.31" }, + "bin": [ + "bin/phpcbf", + "bin/phpcs" + ], + "type": "library", "notification-url": "https://packagist.org/downloads/", "license": [ "BSD-3-Clause" ], "authors": [ { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" + "name": "Greg Sherwood", + "role": "Former lead" + }, + { + "name": "Juliette Reinders Folmer", + "role": "Current lead" + }, + { + "name": "Contributors", + "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer/graphs/contributors" } ], - "description": "Collection of value objects that represent the types of the PHP type system", - "homepage": "https://github.com/sebastianbergmann/type", + "description": "PHP_CodeSniffer tokenizes PHP files and detects violations of a defined set of coding standards.", + "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer", + "keywords": [ + "phpcs", + "standards", + "static analysis" + ], "support": { - "issues": "https://github.com/sebastianbergmann/type/issues", - "security": "https://github.com/sebastianbergmann/type/security/policy", - "source": "https://github.com/sebastianbergmann/type/tree/6.0.3" + "issues": "https://github.com/PHPCSStandards/PHP_CodeSniffer/issues", + "security": "https://github.com/PHPCSStandards/PHP_CodeSniffer/security/policy", + "source": "https://github.com/PHPCSStandards/PHP_CodeSniffer", + "wiki": "https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki" }, "funding": [ { - "url": "https://github.com/sebastianbergmann", + "url": "https://github.com/PHPCSStandards", "type": "github" }, { - "url": "https://liberapay.com/sebastianbergmann", - "type": "liberapay" + "url": "https://github.com/jrfnl", + "type": "github" }, { - "url": "https://thanks.dev/u/gh/sebastianbergmann", - "type": "thanks_dev" + "url": "https://opencollective.com/php_codesniffer", + "type": "open_collective" }, { - "url": "https://tidelift.com/funding/github/packagist/sebastian/type", - "type": "tidelift" + "url": "https://thanks.dev/u/gh/phpcsstandards", + "type": "thanks_dev" } ], - "time": "2025-08-09T06:57:12+00:00" + "time": "2025-11-10T16:43:36+00:00" }, { - "name": "sebastian/version", - "version": "6.0.0", + "name": "staabm/side-effects-detector", + "version": "1.0.5", "source": { "type": "git", - "url": "https://github.com/sebastianbergmann/version.git", - "reference": "3e6ccf7657d4f0a59200564b08cead899313b53c" + "url": "https://github.com/staabm/side-effects-detector.git", + "reference": "d8334211a140ce329c13726d4a715adbddd0a163" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/3e6ccf7657d4f0a59200564b08cead899313b53c", - "reference": "3e6ccf7657d4f0a59200564b08cead899313b53c", + "url": "https://api.github.com/repos/staabm/side-effects-detector/zipball/d8334211a140ce329c13726d4a715adbddd0a163", + "reference": "d8334211a140ce329c13726d4a715adbddd0a163", "shasum": "" }, "require": { - "php": ">=8.3" + "ext-tokenizer": "*", + "php": "^7.4 || ^8.0" }, - "type": "library", - "extra": { - "branch-alias": { - "dev-main": "6.0-dev" - } + "require-dev": { + "phpstan/extension-installer": "^1.4.3", + "phpstan/phpstan": "^1.12.6", + "phpunit/phpunit": "^9.6.21", + "symfony/var-dumper": "^5.4.43", + "tomasvotruba/type-coverage": "1.0.0", + "tomasvotruba/unused-public": "1.0.0" }, + "type": "library", "autoload": { "classmap": [ - "src/" + "lib/" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "MIT" ], - "authors": [ - { - "name": "Sebastian Bergmann", - "email": "sebastian@phpunit.de", - "role": "lead" - } + "description": "A static analysis tool to detect side effects in PHP code", + "keywords": [ + "static analysis" ], - "description": "Library that helps with managing the version number of Git-hosted PHP projects", - "homepage": "https://github.com/sebastianbergmann/version", "support": { - "issues": "https://github.com/sebastianbergmann/version/issues", - "security": "https://github.com/sebastianbergmann/version/security/policy", - "source": "https://github.com/sebastianbergmann/version/tree/6.0.0" + "issues": "https://github.com/staabm/side-effects-detector/issues", + "source": "https://github.com/staabm/side-effects-detector/tree/1.0.5" }, "funding": [ { - "url": "https://github.com/sebastianbergmann", + "url": "https://github.com/staabm", "type": "github" } ], - "time": "2025-02-07T05:00:38+00:00" + "time": "2024-10-20T05:08:20+00:00" }, { - "name": "seld/jsonlint", - "version": "1.11.0", + "name": "symfony/console", + "version": "v8.0.11", "source": { "type": "git", - "url": "https://github.com/Seldaek/jsonlint.git", - "reference": "1748aaf847fc731cfad7725aec413ee46f0cc3a2" + "url": "https://github.com/symfony/console.git", + "reference": "3156577f46a38aa1b9323aad223de7a9cd426782" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Seldaek/jsonlint/zipball/1748aaf847fc731cfad7725aec413ee46f0cc3a2", - "reference": "1748aaf847fc731cfad7725aec413ee46f0cc3a2", + "url": "https://api.github.com/repos/symfony/console/zipball/3156577f46a38aa1b9323aad223de7a9cd426782", + "reference": "3156577f46a38aa1b9323aad223de7a9cd426782", "shasum": "" }, "require": { - "php": "^5.3 || ^7.0 || ^8.0" + "php": ">=8.4", + "symfony/polyfill-mbstring": "^1.0", + "symfony/service-contracts": "^2.5|^3", + "symfony/string": "^7.4|^8.0" + }, + "provide": { + "psr/log-implementation": "1.0|2.0|3.0" }, "require-dev": { - "phpstan/phpstan": "^1.11", - "phpunit/phpunit": "^4.8.35 || ^5.7 || ^6.0 || ^8.5.13" + "psr/log": "^1|^2|^3", + "symfony/config": "^7.4|^8.0", + "symfony/dependency-injection": "^7.4|^8.0", + "symfony/event-dispatcher": "^7.4|^8.0", + "symfony/http-foundation": "^7.4|^8.0", + "symfony/http-kernel": "^7.4|^8.0", + "symfony/lock": "^7.4|^8.0", + "symfony/messenger": "^7.4|^8.0", + "symfony/process": "^7.4|^8.0", + "symfony/stopwatch": "^7.4|^8.0", + "symfony/var-dumper": "^7.4|^8.0" }, - "bin": [ - "bin/jsonlint" - ], "type": "library", "autoload": { "psr-4": { - "Seld\\JsonLint\\": "src/Seld/JsonLint/" - } + "Symfony\\Component\\Console\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] }, "notification-url": "https://packagist.org/downloads/", "license": [ @@ -5842,61 +5649,75 @@ ], "authors": [ { - "name": "Jordi Boggiano", - "email": "j.boggiano@seld.be", - "homepage": "https://seld.be" + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" } ], - "description": "JSON Linter", + "description": "Eases the creation of beautiful and testable command line interfaces", + "homepage": "https://symfony.com", "keywords": [ - "json", - "linter", - "parser", - "validator" + "cli", + "command-line", + "console", + "terminal" ], "support": { - "issues": "https://github.com/Seldaek/jsonlint/issues", - "source": "https://github.com/Seldaek/jsonlint/tree/1.11.0" + "source": "https://github.com/symfony/console/tree/v8.0.11" }, "funding": [ { - "url": "https://github.com/Seldaek", + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", "type": "github" }, { - "url": "https://tidelift.com/funding/github/packagist/seld/jsonlint", + "url": "https://github.com/nicolas-grekas", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", "type": "tidelift" } ], - "time": "2024-07-11T14:55:45+00:00" + "time": "2026-05-13T12:07:53+00:00" }, { - "name": "seld/phar-utils", - "version": "1.2.1", + "name": "symfony/filesystem", + "version": "v8.0.11", "source": { "type": "git", - "url": "https://github.com/Seldaek/phar-utils.git", - "reference": "ea2f4014f163c1be4c601b9b7bd6af81ba8d701c" + "url": "https://github.com/symfony/filesystem.git", + "reference": "224db910898ce1317b892a9a1338f1f8f17eb7c7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Seldaek/phar-utils/zipball/ea2f4014f163c1be4c601b9b7bd6af81ba8d701c", - "reference": "ea2f4014f163c1be4c601b9b7bd6af81ba8d701c", + "url": "https://api.github.com/repos/symfony/filesystem/zipball/224db910898ce1317b892a9a1338f1f8f17eb7c7", + "reference": "224db910898ce1317b892a9a1338f1f8f17eb7c7", "shasum": "" }, "require": { - "php": ">=5.3" + "php": ">=8.4", + "symfony/polyfill-ctype": "~1.8", + "symfony/polyfill-mbstring": "~1.8" }, - "type": "library", - "extra": { - "branch-alias": { - "dev-master": "1.x-dev" - } + "require-dev": { + "symfony/process": "^7.4|^8.0" }, + "type": "library", "autoload": { "psr-4": { - "Seld\\PharUtils\\": "src/" - } + "Symfony\\Component\\Filesystem\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] }, "notification-url": "https://packagist.org/downloads/", "license": [ @@ -5904,55 +5725,67 @@ ], "authors": [ { - "name": "Jordi Boggiano", - "email": "j.boggiano@seld.be" + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" } ], - "description": "PHAR file format utilities, for when PHP phars you up", - "keywords": [ - "phar" - ], + "description": "Provides basic utilities for the filesystem", + "homepage": "https://symfony.com", "support": { - "issues": "https://github.com/Seldaek/phar-utils/issues", - "source": "https://github.com/Seldaek/phar-utils/tree/1.2.1" + "source": "https://github.com/symfony/filesystem/tree/v8.0.11" }, - "time": "2022-08-31T10:31:18+00:00" + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://github.com/nicolas-grekas", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2026-05-11T16:39:47+00:00" }, { - "name": "seld/signal-handler", - "version": "2.0.2", + "name": "symfony/finder", + "version": "v8.0.8", "source": { "type": "git", - "url": "https://github.com/Seldaek/signal-handler.git", - "reference": "04a6112e883ad76c0ada8e4a9f7520bbfdb6bb98" + "url": "https://github.com/symfony/finder.git", + "reference": "8da41214757b87d97f181e3d14a4179286151007" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Seldaek/signal-handler/zipball/04a6112e883ad76c0ada8e4a9f7520bbfdb6bb98", - "reference": "04a6112e883ad76c0ada8e4a9f7520bbfdb6bb98", + "url": "https://api.github.com/repos/symfony/finder/zipball/8da41214757b87d97f181e3d14a4179286151007", + "reference": "8da41214757b87d97f181e3d14a4179286151007", "shasum": "" }, "require": { - "php": ">=7.2.0" + "php": ">=8.4" }, "require-dev": { - "phpstan/phpstan": "^1", - "phpstan/phpstan-deprecation-rules": "^1.0", - "phpstan/phpstan-phpunit": "^1", - "phpstan/phpstan-strict-rules": "^1.3", - "phpunit/phpunit": "^7.5.20 || ^8.5.23", - "psr/log": "^1 || ^2 || ^3" + "symfony/filesystem": "^7.4|^8.0" }, "type": "library", - "extra": { - "branch-alias": { - "dev-main": "2.x-dev" - } - }, "autoload": { "psr-4": { - "Seld\\Signal\\": "src/" - } + "Symfony\\Component\\Finder\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] }, "notification-url": "https://packagist.org/downloads/", "license": [ @@ -5960,254 +5793,327 @@ ], "authors": [ { - "name": "Jordi Boggiano", - "email": "j.boggiano@seld.be", - "homepage": "http://seld.be" + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" } ], - "description": "Simple unix signal handler that silently fails where signals are not supported for easy cross-platform development", - "keywords": [ - "posix", - "sigint", - "signal", - "sigterm", - "unix" - ], + "description": "Finds files and directories via an intuitive fluent interface", + "homepage": "https://symfony.com", "support": { - "issues": "https://github.com/Seldaek/signal-handler/issues", - "source": "https://github.com/Seldaek/signal-handler/tree/2.0.2" + "source": "https://github.com/symfony/finder/tree/v8.0.8" }, - "time": "2023-09-03T09:24:00+00:00" + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://github.com/nicolas-grekas", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2026-03-30T15:14:47+00:00" }, { - "name": "slevomat/coding-standard", - "version": "8.22.0", + "name": "symfony/polyfill-ctype", + "version": "v1.37.0", "source": { "type": "git", - "url": "https://github.com/slevomat/coding-standard.git", - "reference": "a4cef983bad2e70125612d22b2f6e2bd1333d5c2" + "url": "https://github.com/symfony/polyfill-ctype.git", + "reference": "141046a8f9477948ff284fa65be2095baafb94f2" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/slevomat/coding-standard/zipball/a4cef983bad2e70125612d22b2f6e2bd1333d5c2", - "reference": "a4cef983bad2e70125612d22b2f6e2bd1333d5c2", + "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/141046a8f9477948ff284fa65be2095baafb94f2", + "reference": "141046a8f9477948ff284fa65be2095baafb94f2", "shasum": "" }, "require": { - "dealerdirect/phpcodesniffer-composer-installer": "^0.6.2 || ^0.7 || ^1.1.2", - "php": "^7.4 || ^8.0", - "phpstan/phpdoc-parser": "^2.3.0", - "squizlabs/php_codesniffer": "^3.13.4" + "php": ">=7.2" }, - "require-dev": { - "phing/phing": "3.0.1|3.1.0", - "php-parallel-lint/php-parallel-lint": "1.4.0", - "phpstan/phpstan": "2.1.22", - "phpstan/phpstan-deprecation-rules": "2.0.3", - "phpstan/phpstan-phpunit": "2.0.7", - "phpstan/phpstan-strict-rules": "2.0.6", - "phpunit/phpunit": "9.6.8|10.5.48|11.4.4|11.5.36|12.3.8" + "provide": { + "ext-ctype": "*" }, - "type": "phpcodesniffer-standard", + "suggest": { + "ext-ctype": "For best performance" + }, + "type": "library", "extra": { - "branch-alias": { - "dev-master": "8.x-dev" + "thanks": { + "url": "https://github.com/symfony/polyfill", + "name": "symfony/polyfill" } }, "autoload": { + "files": [ + "bootstrap.php" + ], "psr-4": { - "SlevomatCodingStandard\\": "SlevomatCodingStandard/" + "Symfony\\Polyfill\\Ctype\\": "" } }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], - "description": "Slevomat Coding Standard for PHP_CodeSniffer complements Consistence Coding Standard by providing sniffs with additional checks.", + "authors": [ + { + "name": "Gert de Pagter", + "email": "BackEndTea@gmail.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill for ctype functions", + "homepage": "https://symfony.com", "keywords": [ - "dev", - "phpcs" + "compatibility", + "ctype", + "polyfill", + "portable" ], "support": { - "issues": "https://github.com/slevomat/coding-standard/issues", - "source": "https://github.com/slevomat/coding-standard/tree/8.22.0" + "source": "https://github.com/symfony/polyfill-ctype/tree/v1.37.0" }, "funding": [ { - "url": "https://github.com/kukulich", + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", "type": "github" }, { - "url": "https://tidelift.com/funding/github/packagist/slevomat/coding-standard", + "url": "https://github.com/nicolas-grekas", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", "type": "tidelift" } ], - "time": "2025-09-06T09:14:48+00:00" + "time": "2026-04-10T16:19:22+00:00" }, { - "name": "squizlabs/php_codesniffer", - "version": "3.13.4", + "name": "symfony/polyfill-intl-grapheme", + "version": "v1.37.0", "source": { "type": "git", - "url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git", - "reference": "ad545ea9c1b7d270ce0fc9cbfb884161cd706119" + "url": "https://github.com/symfony/polyfill-intl-grapheme.git", + "reference": "4864388bfbd3001ce88e234fab652acd91fdc57e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/ad545ea9c1b7d270ce0fc9cbfb884161cd706119", - "reference": "ad545ea9c1b7d270ce0fc9cbfb884161cd706119", + "url": "https://api.github.com/repos/symfony/polyfill-intl-grapheme/zipball/4864388bfbd3001ce88e234fab652acd91fdc57e", + "reference": "4864388bfbd3001ce88e234fab652acd91fdc57e", "shasum": "" }, "require": { - "ext-simplexml": "*", - "ext-tokenizer": "*", - "ext-xmlwriter": "*", - "php": ">=5.4.0" + "php": ">=7.2" }, - "require-dev": { - "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.3.4" + "suggest": { + "ext-intl": "For best performance" }, - "bin": [ - "bin/phpcbf", - "bin/phpcs" - ], "type": "library", "extra": { - "branch-alias": { - "dev-master": "3.x-dev" + "thanks": { + "url": "https://github.com/symfony/polyfill", + "name": "symfony/polyfill" + } + }, + "autoload": { + "files": [ + "bootstrap.php" + ], + "psr-4": { + "Symfony\\Polyfill\\Intl\\Grapheme\\": "" } }, "notification-url": "https://packagist.org/downloads/", "license": [ - "BSD-3-Clause" + "MIT" ], "authors": [ { - "name": "Greg Sherwood", - "role": "Former lead" - }, - { - "name": "Juliette Reinders Folmer", - "role": "Current lead" + "name": "Nicolas Grekas", + "email": "p@tchwork.com" }, { - "name": "Contributors", - "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer/graphs/contributors" + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" } ], - "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", - "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer", + "description": "Symfony polyfill for intl's grapheme_* functions", + "homepage": "https://symfony.com", "keywords": [ - "phpcs", - "standards", - "static analysis" + "compatibility", + "grapheme", + "intl", + "polyfill", + "portable", + "shim" ], "support": { - "issues": "https://github.com/PHPCSStandards/PHP_CodeSniffer/issues", - "security": "https://github.com/PHPCSStandards/PHP_CodeSniffer/security/policy", - "source": "https://github.com/PHPCSStandards/PHP_CodeSniffer", - "wiki": "https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki" + "source": "https://github.com/symfony/polyfill-intl-grapheme/tree/v1.37.0" }, "funding": [ { - "url": "https://github.com/PHPCSStandards", - "type": "github" + "url": "https://symfony.com/sponsor", + "type": "custom" }, { - "url": "https://github.com/jrfnl", + "url": "https://github.com/fabpot", "type": "github" }, { - "url": "https://opencollective.com/php_codesniffer", - "type": "open_collective" + "url": "https://github.com/nicolas-grekas", + "type": "github" }, { - "url": "https://thanks.dev/u/gh/phpcsstandards", - "type": "thanks_dev" + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" } ], - "time": "2025-09-05T05:47:09+00:00" + "time": "2026-04-26T13:13:48+00:00" }, { - "name": "staabm/side-effects-detector", - "version": "1.0.5", + "name": "symfony/polyfill-intl-normalizer", + "version": "v1.37.0", "source": { "type": "git", - "url": "https://github.com/staabm/side-effects-detector.git", - "reference": "d8334211a140ce329c13726d4a715adbddd0a163" + "url": "https://github.com/symfony/polyfill-intl-normalizer.git", + "reference": "3833d7255cc303546435cb650316bff708a1c75c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/staabm/side-effects-detector/zipball/d8334211a140ce329c13726d4a715adbddd0a163", - "reference": "d8334211a140ce329c13726d4a715adbddd0a163", + "url": "https://api.github.com/repos/symfony/polyfill-intl-normalizer/zipball/3833d7255cc303546435cb650316bff708a1c75c", + "reference": "3833d7255cc303546435cb650316bff708a1c75c", "shasum": "" }, "require": { - "ext-tokenizer": "*", - "php": "^7.4 || ^8.0" + "php": ">=7.2" }, - "require-dev": { - "phpstan/extension-installer": "^1.4.3", - "phpstan/phpstan": "^1.12.6", - "phpunit/phpunit": "^9.6.21", - "symfony/var-dumper": "^5.4.43", - "tomasvotruba/type-coverage": "1.0.0", - "tomasvotruba/unused-public": "1.0.0" + "suggest": { + "ext-intl": "For best performance" }, "type": "library", + "extra": { + "thanks": { + "url": "https://github.com/symfony/polyfill", + "name": "symfony/polyfill" + } + }, "autoload": { + "files": [ + "bootstrap.php" + ], + "psr-4": { + "Symfony\\Polyfill\\Intl\\Normalizer\\": "" + }, "classmap": [ - "lib/" + "Resources/stubs" ] }, "notification-url": "https://packagist.org/downloads/", "license": [ "MIT" ], - "description": "A static analysis tool to detect side effects in PHP code", + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill for intl's Normalizer class and related functions", + "homepage": "https://symfony.com", "keywords": [ - "static analysis" + "compatibility", + "intl", + "normalizer", + "polyfill", + "portable", + "shim" ], "support": { - "issues": "https://github.com/staabm/side-effects-detector/issues", - "source": "https://github.com/staabm/side-effects-detector/tree/1.0.5" + "source": "https://github.com/symfony/polyfill-intl-normalizer/tree/v1.37.0" }, "funding": [ { - "url": "https://github.com/staabm", + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://github.com/nicolas-grekas", "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" } ], - "time": "2024-10-20T05:08:20+00:00" + "time": "2024-09-09T11:45:10+00:00" }, { - "name": "symfony/finder", - "version": "v7.3.2", + "name": "symfony/polyfill-mbstring", + "version": "v1.38.1", "source": { "type": "git", - "url": "https://github.com/symfony/finder.git", - "reference": "2a6614966ba1074fa93dae0bc804227422df4dfe" + "url": "https://github.com/symfony/polyfill-mbstring.git", + "reference": "14c5439eec4ccff081ac14eca2dc57feb2a66d92" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/finder/zipball/2a6614966ba1074fa93dae0bc804227422df4dfe", - "reference": "2a6614966ba1074fa93dae0bc804227422df4dfe", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/14c5439eec4ccff081ac14eca2dc57feb2a66d92", + "reference": "14c5439eec4ccff081ac14eca2dc57feb2a66d92", "shasum": "" }, "require": { - "php": ">=8.2" + "ext-iconv": "*", + "php": ">=7.2" }, - "require-dev": { - "symfony/filesystem": "^6.4|^7.0" + "provide": { + "ext-mbstring": "*" + }, + "suggest": { + "ext-mbstring": "For best performance" }, "type": "library", + "extra": { + "thanks": { + "url": "https://github.com/symfony/polyfill", + "name": "symfony/polyfill" + } + }, "autoload": { + "files": [ + "bootstrap.php" + ], "psr-4": { - "Symfony\\Component\\Finder\\": "" - }, - "exclude-from-classmap": [ - "/Tests/" - ] + "Symfony\\Polyfill\\Mbstring\\": "" + } }, "notification-url": "https://packagist.org/downloads/", "license": [ @@ -6215,18 +6121,25 @@ ], "authors": [ { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" + "name": "Nicolas Grekas", + "email": "p@tchwork.com" }, { "name": "Symfony Community", "homepage": "https://symfony.com/contributors" } ], - "description": "Finds files and directories via an intuitive fluent interface", + "description": "Symfony polyfill for the Mbstring extension", "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "mbstring", + "polyfill", + "portable", + "shim" + ], "support": { - "source": "https://github.com/symfony/finder/tree/v7.3.2" + "source": "https://github.com/symfony/polyfill-mbstring/tree/v1.38.1" }, "funding": [ { @@ -6246,11 +6159,11 @@ "type": "tidelift" } ], - "time": "2025-07-15T13:41:35+00:00" + "time": "2026-05-26T12:51:13+00:00" }, { "name": "symfony/polyfill-php73", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php73.git", @@ -6306,7 +6219,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-php73/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-php73/tree/v1.37.0" }, "funding": [ { @@ -6330,16 +6243,16 @@ }, { "name": "symfony/polyfill-php80", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php80.git", - "reference": "0cc9dd0f17f61d8131e7df6b84bd344899fe2608" + "reference": "dfb55726c3a76ea3b6459fcfda1ec2d80a682411" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/0cc9dd0f17f61d8131e7df6b84bd344899fe2608", - "reference": "0cc9dd0f17f61d8131e7df6b84bd344899fe2608", + "url": "https://api.github.com/repos/symfony/polyfill-php80/zipball/dfb55726c3a76ea3b6459fcfda1ec2d80a682411", + "reference": "dfb55726c3a76ea3b6459fcfda1ec2d80a682411", "shasum": "" }, "require": { @@ -6390,7 +6303,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-php80/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-php80/tree/v1.37.0" }, "funding": [ { @@ -6410,11 +6323,11 @@ "type": "tidelift" } ], - "time": "2025-01-02T08:10:11+00:00" + "time": "2026-04-10T16:19:22+00:00" }, { "name": "symfony/polyfill-php81", - "version": "v1.33.0", + "version": "v1.37.0", "source": { "type": "git", "url": "https://github.com/symfony/polyfill-php81.git", @@ -6470,7 +6383,7 @@ "shim" ], "support": { - "source": "https://github.com/symfony/polyfill-php81/tree/v1.33.0" + "source": "https://github.com/symfony/polyfill-php81/tree/v1.37.0" }, "funding": [ { @@ -6492,22 +6405,102 @@ ], "time": "2024-09-09T11:45:10+00:00" }, + { + "name": "symfony/polyfill-php84", + "version": "v1.37.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-php84.git", + "reference": "88486db2c389b290bf87ff1de7ebc1e13e42bb06" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-php84/zipball/88486db2c389b290bf87ff1de7ebc1e13e42bb06", + "reference": "88486db2c389b290bf87ff1de7ebc1e13e42bb06", + "shasum": "" + }, + "require": { + "php": ">=7.2" + }, + "type": "library", + "extra": { + "thanks": { + "url": "https://github.com/symfony/polyfill", + "name": "symfony/polyfill" + } + }, + "autoload": { + "files": [ + "bootstrap.php" + ], + "psr-4": { + "Symfony\\Polyfill\\Php84\\": "" + }, + "classmap": [ + "Resources/stubs" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Symfony polyfill backporting some PHP 8.4+ features to lower PHP versions", + "homepage": "https://symfony.com", + "keywords": [ + "compatibility", + "polyfill", + "portable", + "shim" + ], + "support": { + "source": "https://github.com/symfony/polyfill-php84/tree/v1.37.0" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://github.com/nicolas-grekas", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2026-04-10T18:47:49+00:00" + }, { "name": "symfony/process", - "version": "v7.3.3", + "version": "v8.0.11", "source": { "type": "git", "url": "https://github.com/symfony/process.git", - "reference": "32241012d521e2e8a9d713adb0812bb773b907f1" + "reference": "26d89e459f037d2873300605d0a07e7a8ef84db0" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/process/zipball/32241012d521e2e8a9d713adb0812bb773b907f1", - "reference": "32241012d521e2e8a9d713adb0812bb773b907f1", + "url": "https://api.github.com/repos/symfony/process/zipball/26d89e459f037d2873300605d0a07e7a8ef84db0", + "reference": "26d89e459f037d2873300605d0a07e7a8ef84db0", "shasum": "" }, "require": { - "php": ">=8.2" + "php": ">=8.4" }, "type": "library", "autoload": { @@ -6535,7 +6528,184 @@ "description": "Executes commands in sub-processes", "homepage": "https://symfony.com", "support": { - "source": "https://github.com/symfony/process/tree/v7.3.3" + "source": "https://github.com/symfony/process/tree/v8.0.11" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://github.com/nicolas-grekas", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2026-05-11T16:56:32+00:00" + }, + { + "name": "symfony/service-contracts", + "version": "v3.7.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/service-contracts.git", + "reference": "d25d82433a80eba6aa0e6c24b61d7370d99e444a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/service-contracts/zipball/d25d82433a80eba6aa0e6c24b61d7370d99e444a", + "reference": "d25d82433a80eba6aa0e6c24b61d7370d99e444a", + "shasum": "" + }, + "require": { + "php": ">=8.1", + "psr/container": "^1.1|^2.0", + "symfony/deprecation-contracts": "^2.5|^3" + }, + "conflict": { + "ext-psr": "<1.1|>=2" + }, + "type": "library", + "extra": { + "thanks": { + "url": "https://github.com/symfony/contracts", + "name": "symfony/contracts" + }, + "branch-alias": { + "dev-main": "3.7-dev" + } + }, + "autoload": { + "psr-4": { + "Symfony\\Contracts\\Service\\": "" + }, + "exclude-from-classmap": [ + "/Test/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Generic abstractions related to writing services", + "homepage": "https://symfony.com", + "keywords": [ + "abstractions", + "contracts", + "decoupling", + "interfaces", + "interoperability", + "standards" + ], + "support": { + "source": "https://github.com/symfony/service-contracts/tree/v3.7.0" + }, + "funding": [ + { + "url": "https://symfony.com/sponsor", + "type": "custom" + }, + { + "url": "https://github.com/fabpot", + "type": "github" + }, + { + "url": "https://github.com/nicolas-grekas", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/symfony/symfony", + "type": "tidelift" + } + ], + "time": "2026-03-28T09:44:51+00:00" + }, + { + "name": "symfony/string", + "version": "v8.0.11", + "source": { + "type": "git", + "url": "https://github.com/symfony/string.git", + "reference": "39be2ad058a3c0bd558edca23e65f009865d75ff" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/string/zipball/39be2ad058a3c0bd558edca23e65f009865d75ff", + "reference": "39be2ad058a3c0bd558edca23e65f009865d75ff", + "shasum": "" + }, + "require": { + "php": ">=8.4", + "symfony/polyfill-ctype": "^1.8", + "symfony/polyfill-intl-grapheme": "^1.33", + "symfony/polyfill-intl-normalizer": "^1.0", + "symfony/polyfill-mbstring": "^1.0" + }, + "conflict": { + "symfony/translation-contracts": "<2.5" + }, + "require-dev": { + "symfony/emoji": "^7.4|^8.0", + "symfony/http-client": "^7.4|^8.0", + "symfony/intl": "^7.4|^8.0", + "symfony/translation-contracts": "^2.5|^3.0", + "symfony/var-exporter": "^7.4|^8.0" + }, + "type": "library", + "autoload": { + "files": [ + "Resources/functions.php" + ], + "psr-4": { + "Symfony\\Component\\String\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Nicolas Grekas", + "email": "p@tchwork.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides an object-oriented API to strings and deals with bytes, UTF-8 code points and grapheme clusters in a unified way", + "homepage": "https://symfony.com", + "keywords": [ + "grapheme", + "i18n", + "string", + "unicode", + "utf-8", + "utf8" + ], + "support": { + "source": "https://github.com/symfony/string/tree/v8.0.11" }, "funding": [ { @@ -6555,35 +6725,35 @@ "type": "tidelift" } ], - "time": "2025-08-18T09:42:54+00:00" + "time": "2026-05-13T12:07:53+00:00" }, { "name": "symfony/var-dumper", - "version": "v7.3.3", + "version": "v8.0.8", "source": { "type": "git", "url": "https://github.com/symfony/var-dumper.git", - "reference": "34d8d4c4b9597347306d1ec8eb4e1319b1e6986f" + "reference": "cfb7badd53bf4177f6e9416cfbbccc13c0e773a1" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/symfony/var-dumper/zipball/34d8d4c4b9597347306d1ec8eb4e1319b1e6986f", - "reference": "34d8d4c4b9597347306d1ec8eb4e1319b1e6986f", + "url": "https://api.github.com/repos/symfony/var-dumper/zipball/cfb7badd53bf4177f6e9416cfbbccc13c0e773a1", + "reference": "cfb7badd53bf4177f6e9416cfbbccc13c0e773a1", "shasum": "" }, "require": { - "php": ">=8.2", - "symfony/deprecation-contracts": "^2.5|^3", - "symfony/polyfill-mbstring": "~1.0" + "php": ">=8.4", + "symfony/polyfill-mbstring": "^1.0" }, "conflict": { - "symfony/console": "<6.4" + "symfony/console": "<7.4", + "symfony/error-handler": "<7.4" }, "require-dev": { - "symfony/console": "^6.4|^7.0", - "symfony/http-kernel": "^6.4|^7.0", - "symfony/process": "^6.4|^7.0", - "symfony/uid": "^6.4|^7.0", + "symfony/console": "^7.4|^8.0", + "symfony/http-kernel": "^7.4|^8.0", + "symfony/process": "^7.4|^8.0", + "symfony/uid": "^7.4|^8.0", "twig/twig": "^3.12" }, "bin": [ @@ -6622,7 +6792,7 @@ "dump" ], "support": { - "source": "https://github.com/symfony/var-dumper/tree/v7.3.3" + "source": "https://github.com/symfony/var-dumper/tree/v8.0.8" }, "funding": [ { @@ -6642,27 +6812,27 @@ "type": "tidelift" } ], - "time": "2025-08-13T11:49:31+00:00" + "time": "2026-03-31T07:15:36+00:00" }, { "name": "theseer/tokenizer", - "version": "1.2.3", + "version": "2.0.1", "source": { "type": "git", "url": "https://github.com/theseer/tokenizer.git", - "reference": "737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2" + "reference": "7989e43bf381af0eac72e4f0ca5bcbfa81658be4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/theseer/tokenizer/zipball/737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2", - "reference": "737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2", + "url": "https://api.github.com/repos/theseer/tokenizer/zipball/7989e43bf381af0eac72e4f0ca5bcbfa81658be4", + "reference": "7989e43bf381af0eac72e4f0ca5bcbfa81658be4", "shasum": "" }, "require": { "ext-dom": "*", "ext-tokenizer": "*", "ext-xmlwriter": "*", - "php": "^7.2 || ^8.0" + "php": "^8.1" }, "type": "library", "autoload": { @@ -6684,7 +6854,7 @@ "description": "A small library for converting tokenized PHP source code into XML and potentially other formats", "support": { "issues": "https://github.com/theseer/tokenizer/issues", - "source": "https://github.com/theseer/tokenizer/tree/1.2.3" + "source": "https://github.com/theseer/tokenizer/tree/2.0.1" }, "funding": [ { @@ -6692,20 +6862,20 @@ "type": "github" } ], - "time": "2024-03-03T12:36:25+00:00" + "time": "2025-12-08T11:19:18+00:00" }, { "name": "twig/markdown-extra", - "version": "v3.21.0", + "version": "v3.26.0", "source": { "type": "git", "url": "https://github.com/twigphp/markdown-extra.git", - "reference": "f4616e1dd375209dacf6026f846e6b537d036ce4" + "reference": "e3f3fd0836eb6c39457da22c8a76abaac62692b9" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/twigphp/markdown-extra/zipball/f4616e1dd375209dacf6026f846e6b537d036ce4", - "reference": "f4616e1dd375209dacf6026f846e6b537d036ce4", + "url": "https://api.github.com/repos/twigphp/markdown-extra/zipball/e3f3fd0836eb6c39457da22c8a76abaac62692b9", + "reference": "e3f3fd0836eb6c39457da22c8a76abaac62692b9", "shasum": "" }, "require": { @@ -6715,7 +6885,7 @@ }, "require-dev": { "erusev/parsedown": "dev-master as 1.x-dev", - "league/commonmark": "^1.0|^2.0", + "league/commonmark": "^2.7", "league/html-to-markdown": "^4.8|^5.0", "michelf/php-markdown": "^1.8|^2.0", "symfony/phpunit-bridge": "^6.4|^7.0" @@ -6752,7 +6922,7 @@ "twig" ], "support": { - "source": "https://github.com/twigphp/markdown-extra/tree/v3.21.0" + "source": "https://github.com/twigphp/markdown-extra/tree/v3.26.0" }, "funding": [ { @@ -6764,20 +6934,20 @@ "type": "tidelift" } ], - "time": "2025-01-31T20:45:36+00:00" + "time": "2026-05-15T13:14:02+00:00" }, { "name": "twig/twig", - "version": "v3.21.1", + "version": "v3.27.0", "source": { "type": "git", "url": "https://github.com/twigphp/Twig.git", - "reference": "285123877d4dd97dd7c11842ac5fb7e86e60d81d" + "reference": "04ae1bfe9463c816cf72ca0abe7eae2c77a9a9ed" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/twigphp/Twig/zipball/285123877d4dd97dd7c11842ac5fb7e86e60d81d", - "reference": "285123877d4dd97dd7c11842ac5fb7e86e60d81d", + "url": "https://api.github.com/repos/twigphp/Twig/zipball/04ae1bfe9463c816cf72ca0abe7eae2c77a9a9ed", + "reference": "04ae1bfe9463c816cf72ca0abe7eae2c77a9a9ed", "shasum": "" }, "require": { @@ -6787,7 +6957,8 @@ "symfony/polyfill-mbstring": "^1.3" }, "require-dev": { - "phpstan/phpstan": "^2.0", + "php-cs-fixer/shim": "^3.0@stable", + "phpstan/phpstan": "^2.0@stable", "psr/container": "^1.0|^2.0", "symfony/phpunit-bridge": "^5.4.9|^6.4|^7.0" }, @@ -6831,7 +7002,7 @@ ], "support": { "issues": "https://github.com/twigphp/Twig/issues", - "source": "https://github.com/twigphp/Twig/tree/v3.21.1" + "source": "https://github.com/twigphp/Twig/tree/v3.27.0" }, "funding": [ { @@ -6843,22 +7014,20 @@ "type": "tidelift" } ], - "time": "2025-05-03T07:21:55+00:00" + "time": "2026-05-27T13:05:51+00:00" } ], "aliases": [], "minimum-stability": "stable", - "stability-flags": { - "psy/psysh": 0 - }, + "stability-flags": {}, "prefer-stable": true, "prefer-lowest": false, "platform": { - "php": ">=8.1", + "php": ">=8.2", "ext-intl": "*", "ext-json": "*", "ext-mbstring": "*" }, "platform-dev": {}, - "plugin-api-version": "2.6.0" + "plugin-api-version": "2.9.0" } diff --git a/app/vendor/bin/phinx b/app/vendor/bin/phinx deleted file mode 100755 index 20ed10c9a..000000000 --- a/app/vendor/bin/phinx +++ /dev/null @@ -1,119 +0,0 @@ -#!/usr/bin/env php -realpath = realpath($opened_path) ?: $opened_path; - $opened_path = $this->realpath; - $this->handle = fopen($this->realpath, $mode); - $this->position = 0; - - return (bool) $this->handle; - } - - public function stream_read($count) - { - $data = fread($this->handle, $count); - - if ($this->position === 0) { - $data = preg_replace('{^#!.*\r?\n}', '', $data); - } - - $this->position += strlen($data); - - return $data; - } - - public function stream_cast($castAs) - { - return $this->handle; - } - - public function stream_close() - { - fclose($this->handle); - } - - public function stream_lock($operation) - { - return $operation ? flock($this->handle, $operation) : true; - } - - public function stream_seek($offset, $whence) - { - if (0 === fseek($this->handle, $offset, $whence)) { - $this->position = ftell($this->handle); - return true; - } - - return false; - } - - public function stream_tell() - { - return $this->position; - } - - public function stream_eof() - { - return feof($this->handle); - } - - public function stream_stat() - { - return array(); - } - - public function stream_set_option($option, $arg1, $arg2) - { - return true; - } - - public function url_stat($path, $flags) - { - $path = substr($path, 17); - if (file_exists($path)) { - return stat($path); - } - - return false; - } - } - } - - if ( - (function_exists('stream_get_wrappers') && in_array('phpvfscomposer', stream_get_wrappers(), true)) - || (function_exists('stream_wrapper_register') && stream_wrapper_register('phpvfscomposer', 'Composer\BinProxyWrapper')) - ) { - return include("phpvfscomposer://" . __DIR__ . '/..'.'/robmorgan/phinx/bin/phinx'); - } -} - -return include __DIR__ . '/..'.'/robmorgan/phinx/bin/phinx'; diff --git a/app/vendor/bin/sql-formatter b/app/vendor/bin/sql-formatter index de69b8ade..ed0a69d35 100755 --- a/app/vendor/bin/sql-formatter +++ b/app/vendor/bin/sql-formatter @@ -112,9 +112,8 @@ if (PHP_VERSION_ID < 80000) { (function_exists('stream_get_wrappers') && in_array('phpvfscomposer', stream_get_wrappers(), true)) || (function_exists('stream_wrapper_register') && stream_wrapper_register('phpvfscomposer', 'Composer\BinProxyWrapper')) ) { - include("phpvfscomposer://" . __DIR__ . '/..'.'/doctrine/sql-formatter/bin/sql-formatter'); - exit(0); + return include("phpvfscomposer://" . __DIR__ . '/..'.'/doctrine/sql-formatter/bin/sql-formatter'); } } -include __DIR__ . '/..'.'/doctrine/sql-formatter/bin/sql-formatter'; +return include __DIR__ . '/..'.'/doctrine/sql-formatter/bin/sql-formatter'; diff --git a/app/vendor/brick/varexporter/CHANGELOG.md b/app/vendor/brick/varexporter/CHANGELOG.md index 762b4fbe2..923e9c3b0 100644 --- a/app/vendor/brick/varexporter/CHANGELOG.md +++ b/app/vendor/brick/varexporter/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## [0.7.0](https://github.com/brick/varexporter/releases/tag/0.7.0) - 2026-01-06 + +✨ **New features** + +- Added `VarExporter::INLINE_LITERAL_LIST`, similar to `INLINE_SCALAR_LIST` but includes enum values + +💥 **BC breaks** + +- Minimum PHP version is now `8.2` + ## [0.6.0](https://github.com/brick/varexporter/releases/tag/0.6.0) - 2025-02-20 💥 **BC breaks** diff --git a/app/vendor/brick/varexporter/composer.json b/app/vendor/brick/varexporter/composer.json index 53554754b..682066f47 100644 --- a/app/vendor/brick/varexporter/composer.json +++ b/app/vendor/brick/varexporter/composer.json @@ -7,13 +7,13 @@ ], "license": "MIT", "require": { - "php": "^8.1", + "php": "^8.2", "nikic/php-parser": "^5.0" }, "require-dev": { - "phpunit/phpunit": "^10.5", + "phpunit/phpunit": "^11.0", "php-coveralls/php-coveralls": "^2.2", - "vimeo/psalm": "6.8.4" + "vimeo/psalm": "6.14.3" }, "autoload": { "psr-4": { diff --git a/app/vendor/brick/varexporter/src/ExportException.php b/app/vendor/brick/varexporter/src/ExportException.php index 662c32c2e..18049a67e 100644 --- a/app/vendor/brick/varexporter/src/ExportException.php +++ b/app/vendor/brick/varexporter/src/ExportException.php @@ -4,9 +4,12 @@ namespace Brick\VarExporter; +use Exception; use Throwable; -final class ExportException extends \Exception +use function implode; + +final class ExportException extends Exception { /** * @param string[] $path @@ -25,7 +28,7 @@ public function __construct(string $message, array $path, ?Throwable $previous = * * @param string[] $path */ - public static function pathToString(array $path) : string + public static function pathToString(array $path): string { return '[' . implode('][', $path) . ']'; } diff --git a/app/vendor/brick/varexporter/src/Internal/GenericExporter.php b/app/vendor/brick/varexporter/src/Internal/GenericExporter.php index 7757ccdbe..5f677edf6 100644 --- a/app/vendor/brick/varexporter/src/Internal/GenericExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/GenericExporter.php @@ -6,6 +6,21 @@ use Brick\VarExporter\ExportException; use Brick\VarExporter\VarExporter; +use ReflectionObject; +use UnitEnum; + +use function array_is_list; +use function array_merge; +use function array_unshift; +use function count; +use function gettype; +use function implode; +use function is_array; +use function is_object; +use function is_scalar; +use function spl_object_id; +use function sprintf; +use function var_export; /** * The main exporter implementation, that handles variables of any type. @@ -18,87 +33,73 @@ */ final class GenericExporter { - /** - * @var ObjectExporter[] - */ - private array $objectExporters = []; + public readonly bool $addTypeHints; - /** - * The visited objects, to detect circular references. - * - * This is a two-level map of parent object id => child object id => path where the object first appeared. - * - * @var array> - */ - private array $visitedObjects = []; + public readonly bool $skipDynamicProperties; - /** - * @psalm-readonly - */ - public bool $addTypeHints; + public readonly bool $inlineArray; - /** - * @psalm-readonly - */ - public bool $skipDynamicProperties; + public readonly bool $inlineScalarList; - /** - * @psalm-readonly - */ - public bool $inlineArray; + public readonly bool $inlineLiteralList; - /** - * @psalm-readonly - */ - public bool $inlineScalarList; + public readonly bool $closureSnapshotUses; - /** - * @psalm-readonly - */ - public bool $closureSnapshotUses; + public readonly bool $trailingCommaInArray; + + public readonly int $indentLevel; /** - * @psalm-readonly + * @var ObjectExporter[] */ - public bool $trailingCommaInArray; + private readonly array $objectExporters; /** - * @psalm-readonly + * The visited objects, to detect circular references. + * + * This is a two-level map of parent object id => child object id => path where the object first appeared. + * + * @var array> */ - public int $indentLevel; + private array $visitedObjects = []; public function __construct(int $options, int $indentLevel = 0) { - $this->objectExporters[] = new ObjectExporter\StdClassExporter($this); + $objectExporters = [ + new ObjectExporter\StdClassExporter($this), + ]; if (($options & VarExporter::NO_CLOSURES) === 0) { - $this->objectExporters[] = new ObjectExporter\ClosureExporter($this); + $objectExporters[] = new ObjectExporter\ClosureExporter($this); } if (($options & VarExporter::NO_SET_STATE) === 0) { - $this->objectExporters[] = new ObjectExporter\SetStateExporter($this); + $objectExporters[] = new ObjectExporter\SetStateExporter($this); } - $this->objectExporters[] = new ObjectExporter\InternalClassExporter($this); + $objectExporters[] = new ObjectExporter\InternalClassExporter($this); if (($options & VarExporter::NO_SERIALIZE) === 0) { - $this->objectExporters[] = new ObjectExporter\SerializeExporter($this); + $objectExporters[] = new ObjectExporter\SerializeExporter($this); } if (($options & VarExporter::NO_ENUMS) === 0) { - $this->objectExporters[] = new ObjectExporter\EnumExporter($this); + $objectExporters[] = new ObjectExporter\EnumExporter($this); } if (($options & VarExporter::NOT_ANY_OBJECT) === 0) { - $this->objectExporters[] = new ObjectExporter\AnyObjectExporter($this); + $objectExporters[] = new ObjectExporter\AnyObjectExporter($this); } - $this->addTypeHints = (bool) ($options & VarExporter::ADD_TYPE_HINTS); - $this->skipDynamicProperties = (bool) ($options & VarExporter::SKIP_DYNAMIC_PROPERTIES); - $this->inlineArray = (bool) ($options & VarExporter::INLINE_ARRAY); - $this->inlineScalarList = (bool) ($options & VarExporter::INLINE_SCALAR_LIST); - $this->closureSnapshotUses = (bool) ($options & VarExporter::CLOSURE_SNAPSHOT_USES); - $this->trailingCommaInArray = (bool) ($options & VarExporter::TRAILING_COMMA_IN_ARRAY); + $this->objectExporters = $objectExporters; + + $this->addTypeHints = (bool) ($options & VarExporter::ADD_TYPE_HINTS); + $this->skipDynamicProperties = (bool) ($options & VarExporter::SKIP_DYNAMIC_PROPERTIES); + $this->inlineArray = (bool) ($options & VarExporter::INLINE_ARRAY); + $this->inlineScalarList = (bool) ($options & VarExporter::INLINE_SCALAR_LIST); + $this->inlineLiteralList = (bool) ($options & VarExporter::INLINE_LITERAL_LIST); + $this->closureSnapshotUses = (bool) ($options & VarExporter::CLOSURE_SNAPSHOT_USES); + $this->trailingCommaInArray = (bool) ($options & VarExporter::TRAILING_COMMA_IN_ARRAY); $this->indentLevel = $indentLevel; } @@ -112,7 +113,7 @@ public function __construct(int $options, int $indentLevel = 0) * * @throws ExportException */ - public function export(mixed $var, array $path, array $parentIds) : array + public function export(mixed $var, array $path, array $parentIds): array { if ($var === null) { return ['null']; @@ -136,8 +137,6 @@ public function export(mixed $var, array $path, array $parentIds) : array } /** - * @psalm-suppress MixedAssignment - * * @param array $array The array to export. * @param string[] $path The path to the current array in the array/object graph. * @param int[] $parentIds The ids of all objects higher in the graph. @@ -145,8 +144,10 @@ public function export(mixed $var, array $path, array $parentIds) : array * @return string[] The lines of code. * * @throws ExportException + * + * @psalm-suppress MixedAssignment */ - public function exportArray(array $array, array $path, array $parentIds) : array + public function exportArray(array $array, array $path, array $parentIds): array { if (! $array) { return ['[]']; @@ -155,11 +156,13 @@ public function exportArray(array $array, array $path, array $parentIds) : array $result = []; $count = count($array); - $isList = array_keys($array) === range(0, $count - 1); + $isList = array_is_list($array); $current = 0; - $inline = $this->inlineArray || ($this->inlineScalarList && $isList && $this->isScalarList($array)); + $inline = $this->inlineArray + || ($this->inlineScalarList && $isList && $this->isScalarList($array)) + || ($this->inlineLiteralList && $isList && $this->isLiteralList($array)); foreach ($array as $key => $value) { $isLast = (++$current === $count); @@ -200,24 +203,6 @@ public function exportArray(array $array, array $path, array $parentIds) : array return $result; } - /** - * Returns whether the given array only contains scalar values. - * - * Types considered scalar here are int, bool, float, string and null. - * If the array is empty, this method returns true. - * - */ - private function isScalarList(array $array) : bool - { - foreach ($array as $value) { - if ($value !== null && ! is_scalar($value)) { - return false; - } - } - - return true; - } - /** * @param object $object The object to export. * @param string[] $path The path to the current object in the array/object graph. @@ -227,7 +212,7 @@ private function isScalarList(array $array) : bool * * @throws ExportException */ - public function exportObject(object $object, array $path, array $parentIds) : array + public function exportObject(object $object, array $path, array $parentIds): array { $id = spl_object_id($object); @@ -237,14 +222,14 @@ public function exportObject(object $object, array $path, array $parentIds) : ar 'Object of class "%s" has a circular reference at %s. ' . 'Circular references are currently not supported.', $object::class, - ExportException::pathToString($this->visitedObjects[$parentId][$id]) + ExportException::pathToString($this->visitedObjects[$parentId][$id]), ), $path); } $this->visitedObjects[$parentId][$id] = $path; } - $reflectionObject = new \ReflectionObject($object); + $reflectionObject = new ReflectionObject($object); foreach ($this->objectExporters as $objectExporter) { if ($objectExporter->supports($reflectionObject)) { @@ -266,9 +251,9 @@ public function exportObject(object $object, array $path, array $parentIds) : ar * * @return string[] The indented lines of code. */ - public function indent(array $lines) : array + public function indent(array $lines): array { - foreach ($lines as & $value) { + foreach ($lines as &$value) { if ($value !== '') { $value = ' ' . $value; } @@ -284,11 +269,45 @@ public function indent(array $lines) : array * * @return string[] */ - public function wrap(array $lines, string $prepend, string $append) : array + public function wrap(array $lines, string $prepend, string $append): array { $lines[0] = $prepend . $lines[0]; $lines[count($lines) - 1] .= $append; return $lines; } + + /** + * Returns whether the given array only contains scalar values. + * + * Types considered scalar here are int, bool, float, string and null. + * If the array is empty, this method returns true. + */ + private function isScalarList(array $array): bool + { + foreach ($array as $value) { + if ($value !== null && ! is_scalar($value)) { + return false; + } + } + + return true; + } + + /** + * Returns whether the given array only contains literal values. + * + * Values considered literal are: int, float, string, bool, null, and enum values. + * If the array is empty, this method returns true. + */ + private function isLiteralList(array $array): bool + { + foreach ($array as $value) { + if ($value !== null && ! is_scalar($value) && ! $value instanceof UnitEnum) { + return false; + } + } + + return true; + } } diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter.php index d3e7eee8a..02fb7c355 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter.php @@ -5,6 +5,10 @@ namespace Brick\VarExporter\Internal; use Brick\VarExporter\ExportException; +use ReflectionClass; +use ReflectionObject; + +use function array_merge; /** * An exporter that handles a specific type of object. @@ -13,33 +17,31 @@ */ abstract class ObjectExporter { - protected GenericExporter $exporter; - - public function __construct(GenericExporter $exporter) - { - $this->exporter = $exporter; + public function __construct( + protected readonly GenericExporter $exporter, + ) { } /** * Returns whether this exporter supports the given object. * - * @param \ReflectionObject $reflectionObject A reflection of the object. + * @param ReflectionObject $reflectionObject A reflection of the object. */ - abstract public function supports(\ReflectionObject $reflectionObject) : bool; + abstract public function supports(ReflectionObject $reflectionObject): bool; /** * Exports the given object. * - * @param object $object The object to export. - * @param \ReflectionObject $reflectionObject A reflection of the object. - * @param string[] $path The path to the current object in the array/object graph. - * @param int[] $parentIds The ids of all objects higher in the graph. + * @param object $object The object to export. + * @param ReflectionObject $reflectionObject A reflection of the object. + * @param string[] $path The path to the current object in the array/object graph. + * @param int[] $parentIds The ids of all objects higher in the graph. * * @return string[] The lines of code. * * @throws ExportException */ - abstract public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array; + abstract public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array; /** * Returns the code to create a new object of the given class. @@ -48,7 +50,7 @@ abstract public function export(object $object, \ReflectionObject $reflectionObj * * @return string[] The lines of code. */ - final protected function getCreateObjectCode(\ReflectionClass $class) : array + final protected function getCreateObjectCode(ReflectionClass $class): array { $className = '\\' . $class->getName(); @@ -75,12 +77,12 @@ final protected function getCreateObjectCode(\ReflectionClass $class) : array * * @return string[] The lines of code, wrapped in a closure. */ - final protected function wrapInClosure(array $code) : array + final protected function wrapInClosure(array $code): array { return array_merge( ['(static function() {'], $this->exporter->indent($code), - ['})()'] + ['})()'], ); } } diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/AnyObjectExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/AnyObjectExporter.php index 573d6c357..2ab0416d1 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/AnyObjectExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/AnyObjectExporter.php @@ -6,6 +6,16 @@ use Brick\VarExporter\Internal\ObjectExporter; use Override; +use ReflectionClass; +use ReflectionObject; +use ReflectionProperty; + +use function array_key_exists; +use function array_merge; +use function method_exists; +use function preg_match; +use function spl_object_id; +use function var_export; /** * Handles any class through direct property access and bound closures. @@ -18,7 +28,7 @@ final class AnyObjectExporter extends ObjectExporter { #[Override] - public function supports(\ReflectionObject $reflectionObject) : bool + public function supports(ReflectionObject $reflectionObject): bool { return true; } @@ -27,15 +37,15 @@ public function supports(\ReflectionObject $reflectionObject) : bool * @psalm-suppress MixedAssignment */ #[Override] - public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array + public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array { $lines = $this->getCreateObjectCode($reflectionObject); $objectAsArray = (array) $object; $current = $this->exporter->skipDynamicProperties - ? new \ReflectionClass($object) // properties from class definition only - : $reflectionObject; // properties from class definition + dynamic properties + ? new ReflectionClass($object) // properties from class definition only + : $reflectionObject; // properties from class definition + dynamic properties $isParentClass = false; @@ -68,13 +78,13 @@ public function export(object $object, \ReflectionObject $reflectionObject, arra if (array_key_exists($key, $objectAsArray)) { $value = $objectAsArray[$key]; - if ($property->isPublic() && !(method_exists($property, 'isReadOnly') && $property->isReadOnly())) { + if ($property->isPublic() && ! (method_exists($property, 'isReadOnly') && $property->isReadOnly())) { $publicNonReadonlyProperties[$name] = $value; } else { $nonPublicOrPublicReadonlyProperties[$name] = $value; } } else { - if ($property->isPublic() && !(method_exists($property, 'isReadOnly') && $property->isReadOnly())) { + if ($property->isPublic() && ! (method_exists($property, 'isReadOnly') && $property->isReadOnly())) { $unsetPublicNonReadonlyProperties[] = $name; } else { $unsetNonPublicOrPublicReadonlyProperties[] = $name; @@ -153,9 +163,8 @@ public function export(object $object, \ReflectionObject $reflectionObject, arra /** * Returns the key of the given property in the object-to-array cast. - * */ - private function getPropertyKey(\ReflectionProperty $property) : string + private function getPropertyKey(ReflectionProperty $property): string { $name = $property->getName(); @@ -170,7 +179,7 @@ private function getPropertyKey(\ReflectionProperty $property) : string return $name; } - private function escapePropName(string $var) : string + private function escapePropName(string $var): string { if (preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $var) === 1) { return $var; diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter.php index 1e6120e71..1c2ecb734 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter.php @@ -15,8 +15,20 @@ use PhpParser\NodeVisitor\NameResolver; use PhpParser\Parser; use PhpParser\ParserFactory; -use PhpParser\PhpVersion; use ReflectionFunction; +use ReflectionObject; + +use function array_keys; +use function array_merge; +use function assert; +use function count; +use function file_get_contents; +use function implode; +use function is_string; +use function sprintf; +use function str_ends_with; + +use const PHP_EOL; /** * Handles closures. @@ -28,17 +40,17 @@ final class ClosureExporter extends ObjectExporter private ?Parser $parser = null; #[Override] - public function supports(\ReflectionObject $reflectionObject) : bool + public function supports(ReflectionObject $reflectionObject): bool { - return $reflectionObject->getName() === \Closure::class; + return $reflectionObject->getName() === Closure::class; } #[Override] - public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array + public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array { assert($object instanceof Closure); - $reflectionFunction = new \ReflectionFunction($object); + $reflectionFunction = new ReflectionFunction($object); $file = $reflectionFunction->getFileName(); $line = $reflectionFunction->getStartLine(); @@ -62,7 +74,7 @@ public function export(object $object, \ReflectionObject $reflectionObject, arra private function getParser(): Parser { if ($this->parser === null) { - $this->parser = (new ParserFactory)->createForHostVersion(); + $this->parser = (new ParserFactory())->createForHostVersion(); } return $this->parser; @@ -78,13 +90,13 @@ private function getParser(): Parser * * @throws ExportException */ - private function parseFile(string $filename, array $path) : array + private function parseFile(string $filename, array $path): array { if (str_ends_with($filename, " : eval()'d code")) { throw new ExportException("Closure defined in eval()'d code cannot be exported.", $path); } - $source = @ file_get_contents($filename); + $source = @file_get_contents($filename); if ($source === false) { // @codeCoverageIgnoreStart @@ -113,7 +125,7 @@ private function parseFile(string $filename, array $path) : array * * @return Node[] */ - private function resolveNames(array $ast) : array + private function resolveNames(array $ast): array { $nameResolver = new NameResolver(); $nodeTraverser = new NodeTraverser(); @@ -138,11 +150,11 @@ private function getClosure( array $ast, string $file, int $line, - array $path - ) : Node\Expr\Closure { + array $path, + ): Node\Expr\Closure { $finder = new FindingVisitor( - fn(Node $node): bool => ($node instanceof Node\Expr\Closure || $node instanceof Node\Expr\ArrowFunction) - && $node->getStartLine() === $line + fn (Node $node): bool => ($node instanceof Node\Expr\Closure || $node instanceof Node\Expr\ArrowFunction) + && $node->getStartLine() === $line, ); $traverser = new NodeTraverser(); @@ -157,11 +169,11 @@ private function getClosure( 'Expected exactly 1 closure in %s on line %d, found %d.', $file, $line, - $count + $count, ), $path); } - /** @var Node\Expr\Closure|Node\Expr\ArrowFunction $closure */ + /** @var Node\Expr\ArrowFunction|Node\Expr\Closure $closure */ $closure = $closures[0]; if ($closure instanceof Node\Expr\ArrowFunction) { @@ -178,13 +190,13 @@ private function getClosure( /** * Convert a parsed arrow function to a closure. * - * @param ReflectionFunction $reflectionFunction Reflection of the closure. - * @param Node\Expr\ArrowFunction $arrowFunction Parsed arrow function. + * @param ReflectionFunction $reflectionFunction Reflection of the closure. + * @param Node\Expr\ArrowFunction $arrowFunction Parsed arrow function. */ private function convertArrowFunction( ReflectionFunction $reflectionFunction, - Node\Expr\ArrowFunction $arrowFunction - ) : Node\Expr\Closure { + Node\Expr\ArrowFunction $arrowFunction, + ): Node\Expr\Closure { $closure = new Node\Expr\Closure([], ['arrow_function' => true]); $closure->static = false; @@ -198,8 +210,8 @@ private function convertArrowFunction( foreach (array_keys($static) as $var) { assert(is_string($var)); - $closure->uses[] = new Node\Expr\ClosureUse( - new Node\Expr\Variable($var) + $closure->uses[] = new Node\ClosureUse( + new Node\Expr\Variable($var), ); } @@ -218,11 +230,11 @@ private function convertArrowFunction( private function closureHandleUses( ReflectionFunction $reflectionFunction, Node\Expr\Closure $closure, - array $path - ) : void { + array $path, + ): void { if (! $this->exporter->closureSnapshotUses) { $message = $closure->hasAttribute('arrow_function') - ? "The arrow function uses variables in the parent scope, this is not supported by default" + ? 'The arrow function uses variables in the parent scope, this is not supported by default' : "The closure has bound variables through 'use', this is not supported by default"; throw new ExportException("$message. Use the CLOSURE_SNAPSHOT_USE option to export them.", $path); @@ -249,7 +261,7 @@ private function closureHandleUses( $assign = new Node\Expr\Assign( new Node\Expr\Variable($var), - $expr->expr + $expr->expr, ); $stmts[] = new Node\Stmt\Expression($assign); } diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter/PrettyPrinter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter/PrettyPrinter.php index 97fd44245..7b89289ba 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter/PrettyPrinter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/ClosureExporter/PrettyPrinter.php @@ -7,6 +7,8 @@ use Override; use PhpParser\PrettyPrinter\Standard; +use function str_repeat; + /** * Extends the standard pretty-printer to allow for a base indent level. * @@ -16,13 +18,13 @@ final class PrettyPrinter extends Standard { private int $varExporterNestingLevel = 0; - public function setVarExporterNestingLevel(int $level) : void + public function setVarExporterNestingLevel(int $level): void { $this->varExporterNestingLevel = $level; } #[Override] - protected function resetState() : void + protected function resetState(): void { parent::resetState(); diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/EnumExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/EnumExporter.php index 86fc1cbae..77cda93e4 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/EnumExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/EnumExporter.php @@ -6,8 +6,11 @@ use Brick\VarExporter\Internal\ObjectExporter; use Override; +use ReflectionObject; use UnitEnum; +use function assert; + /** * Handles enums. * @@ -16,18 +19,18 @@ final class EnumExporter extends ObjectExporter { #[Override] - public function supports(\ReflectionObject $reflectionObject) : bool + public function supports(ReflectionObject $reflectionObject): bool { return $reflectionObject->isEnum(); } #[Override] - public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array + public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array { assert($object instanceof UnitEnum); return [ - $object::class . '::' . $object->name + $object::class . '::' . $object->name, ]; } } diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/InternalClassExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/InternalClassExporter.php index 79ce7cf05..62be3135d 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/InternalClassExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/InternalClassExporter.php @@ -7,6 +7,7 @@ use Brick\VarExporter\ExportException; use Brick\VarExporter\Internal\ObjectExporter; use Override; +use ReflectionObject; /** * Throws on internal classes. @@ -16,13 +17,13 @@ final class InternalClassExporter extends ObjectExporter { #[Override] - public function supports(\ReflectionObject $reflectionObject) : bool + public function supports(ReflectionObject $reflectionObject): bool { return $reflectionObject->isInternal(); } #[Override] - public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array + public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array { $className = $reflectionObject->getName(); diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SerializeExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SerializeExporter.php index 6953ae8b4..639ac40f9 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SerializeExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SerializeExporter.php @@ -6,6 +6,9 @@ use Brick\VarExporter\Internal\ObjectExporter; use Override; +use ReflectionObject; + +use function array_merge; /** * Handles instances of classes with __serialize() and __unserialize() methods. @@ -15,14 +18,14 @@ final class SerializeExporter extends ObjectExporter { #[Override] - public function supports(\ReflectionObject $reflectionObject) : bool + public function supports(ReflectionObject $reflectionObject): bool { return $reflectionObject->hasMethod('__serialize') && $reflectionObject->hasMethod('__unserialize'); } #[Override] - public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array + public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array { $lines = $this->getCreateObjectCode($reflectionObject); diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SetStateExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SetStateExporter.php index a33c79e38..d760c2117 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SetStateExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/SetStateExporter.php @@ -7,6 +7,12 @@ use Brick\VarExporter\ExportException; use Brick\VarExporter\Internal\ObjectExporter; use Override; +use ReflectionClass; +use ReflectionObject; + +use function array_key_exists; +use function strrpos; +use function substr; /** * Handles instances of classes with a __set_state() method. @@ -16,7 +22,7 @@ final class SetStateExporter extends ObjectExporter { #[Override] - public function supports(\ReflectionObject $reflectionObject) : bool + public function supports(ReflectionObject $reflectionObject): bool { if ($reflectionObject->hasMethod('__set_state')) { $method = $reflectionObject->getMethod('__set_state'); @@ -28,7 +34,7 @@ public function supports(\ReflectionObject $reflectionObject) : bool } #[Override] - public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array + public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array { $className = $reflectionObject->getName(); @@ -36,7 +42,7 @@ public function export(object $object, \ReflectionObject $reflectionObject, arra $exportedVars = $this->exporter->exportArray($vars, $path, $parentIds); - return $this->exporter->wrap($exportedVars, '\\' . $className . '::__set_state(', ')'); + return $this->exporter->wrap($exportedVars, '\\' . $className . '::__set_state(', ')'); } /** @@ -51,16 +57,16 @@ public function export(object $object, \ReflectionObject $reflectionObject, arra * * This way we offer a better safety guarantee, while staying compatible with var_export() in the output. * - * @psalm-suppress MixedAssignment - * * @param object $object The object to dump. * @param string[] $path The path to the object, in the array/object graph. * * @return array An associative array of property name to value. * * @throws ExportException + * + * @psalm-suppress MixedAssignment */ - private function getObjectVars(object $object, array $path) : array + private function getObjectVars(object $object, array $path): array { $result = []; @@ -78,7 +84,7 @@ private function getObjectVars(object $object, array $path) : array throw new ExportException( 'Class "' . $className . '" has overridden private property "' . $name . '". ' . 'This is not supported for exporting objects with __set_state().', - $path + $path, ); } @@ -92,10 +98,10 @@ private function getObjectVars(object $object, array $path) : array return $result; } - private function isDynamicProperty(object $object, string $name) : bool + private function isDynamicProperty(object $object, string $name): bool { - $reflectionClass = new \ReflectionClass($object); - $reflectionObject = new \ReflectionObject($object); + $reflectionClass = new ReflectionClass($object); + $reflectionObject = new ReflectionObject($object); return $reflectionObject->hasProperty($name) && ! $reflectionClass->hasProperty($name); } diff --git a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/StdClassExporter.php b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/StdClassExporter.php index 5c7e869d0..6e49dcddd 100644 --- a/app/vendor/brick/varexporter/src/Internal/ObjectExporter/StdClassExporter.php +++ b/app/vendor/brick/varexporter/src/Internal/ObjectExporter/StdClassExporter.php @@ -6,6 +6,8 @@ use Brick\VarExporter\Internal\ObjectExporter; use Override; +use ReflectionObject; +use stdClass; /** * Handles stdClass objects. @@ -15,13 +17,13 @@ final class StdClassExporter extends ObjectExporter { #[Override] - public function supports(\ReflectionObject $reflectionObject) : bool + public function supports(ReflectionObject $reflectionObject): bool { - return $reflectionObject->getName() === \stdClass::class; + return $reflectionObject->getName() === stdClass::class; } #[Override] - public function export(object $object, \ReflectionObject $reflectionObject, array $path, array $parentIds) : array + public function export(object $object, ReflectionObject $reflectionObject, array $path, array $parentIds): array { $exported = $this->exporter->exportArray((array) $object, $path, $parentIds); diff --git a/app/vendor/brick/varexporter/src/VarExporter.php b/app/vendor/brick/varexporter/src/VarExporter.php index 7258f337a..687a1cae7 100644 --- a/app/vendor/brick/varexporter/src/VarExporter.php +++ b/app/vendor/brick/varexporter/src/VarExporter.php @@ -6,6 +6,14 @@ use Brick\VarExporter\Internal\GenericExporter; +use function array_map; +use function array_shift; +use function count; +use function implode; +use function str_repeat; + +use const PHP_EOL; + final class VarExporter { /** @@ -50,7 +58,7 @@ final class VarExporter /** * Formats lists (0-based numeric arrays) containing only scalar values on a single line. * Types considered scalar here are int, bool, float, string and null. - * This option is a subset of INLINE_ARRAY, and has no effect when INLINE_ARRAY is used. + * This option is a subset of INLINE_ARRAY and INLINE_LITERAL_LIST and has no effect when either is used. */ public const INLINE_SCALAR_LIST = 1 << 7; @@ -75,14 +83,21 @@ final class VarExporter public const INLINE_ARRAY = 1 << 11; /** - * @param mixed $var The variable to export. - * @param int $options A bitmask of options. Possible values are `VarExporter::*` constants. - * Combine multiple options with a bitwise OR `|` operator. - * @param int $indentLevel The base output indentation level. + * Formats lists (0-based numeric arrays) containing only literal values on a single line. + * Values considered literal are: int, float, string, bool, null, and enum values. + * This option is a subset of INLINE_ARRAY and has no effect when INLINE_ARRAY is used. + */ + public const INLINE_LITERAL_LIST = 1 << 12; + + /** + * @param mixed $var The variable to export. + * @param int $options A bitmask of options. Possible values are `VarExporter::*` constants. + * Combine multiple options with a bitwise OR `|` operator. + * @param int $indentLevel The base output indentation level. * * @throws ExportException */ - public static function export(mixed $var, int $options = 0, int $indentLevel = 0) : string + public static function export(mixed $var, int $options = 0, int $indentLevel = 0): string { $exporter = new GenericExporter($options, $indentLevel); $lines = $exporter->export($var, [], []); @@ -92,7 +107,7 @@ public static function export(mixed $var, int $options = 0, int $indentLevel = 0 } else { $firstLine = array_shift($lines); $lines = array_map( - fn($line) => str_repeat(' ', $indentLevel) . $line, + fn ($line) => str_repeat(' ', $indentLevel) . $line, $lines, ); diff --git a/app/vendor/brick/varexporter/tools/ecs/composer.json b/app/vendor/brick/varexporter/tools/ecs/composer.json new file mode 100644 index 000000000..5298cfffd --- /dev/null +++ b/app/vendor/brick/varexporter/tools/ecs/composer.json @@ -0,0 +1,10 @@ +{ + "require": { + "brick/coding-standard": "v4" + }, + "config": { + "allow-plugins": { + "dealerdirect/phpcodesniffer-composer-installer": false + } + } +} diff --git a/app/vendor/brick/varexporter/tools/ecs/ecs.php b/app/vendor/brick/varexporter/tools/ecs/ecs.php new file mode 100644 index 000000000..9f00ee7a6 --- /dev/null +++ b/app/vendor/brick/varexporter/tools/ecs/ecs.php @@ -0,0 +1,32 @@ +import(__DIR__ . '/vendor/brick/coding-standard/ecs.php'); + + $libRootPath = realpath(__DIR__ . '/../../'); + + $ecsConfig->paths( + [ + $libRootPath . '/src', + $libRootPath . '/tests', + __FILE__, + ], + ); + + $ecsConfig->skip([ + // uses unknown functions etc., let's not touch it + $libRootPath . '/tests/ExportClosureTest.php', + + // tests expect a certain order of class elements + OrderedClassElementsFixer::class => $libRootPath . '/tests/Classes/Hierarchy/*.php', + + // assertEquals() is used intentionally in assertExportEquals() + PhpUnitStrictFixer::class => $libRootPath . 'tests/AbstractTestCase.php', + ]); +}; diff --git a/app/vendor/cakephp-plugins.php b/app/vendor/cakephp-plugins.php index baabe40de..7d415483c 100644 --- a/app/vendor/cakephp-plugins.php +++ b/app/vendor/cakephp-plugins.php @@ -6,7 +6,16 @@ 'Authentication' => $baseDir . '/vendor/cakephp/authentication/', 'Bake' => $baseDir . '/vendor/cakephp/bake/', 'Cake/TwigView' => $baseDir . '/vendor/cakephp/twig-view/', + 'CoreApi' => $baseDir . '/plugins/CoreApi/', + 'CoreAssigner' => $baseDir . '/plugins/CoreAssigner/', + 'CoreEnroller' => $baseDir . '/plugins/CoreEnroller/', + 'CoreJob' => $baseDir . '/plugins/CoreJob/', + 'CoreServer' => $baseDir . '/plugins/CoreServer/', 'DebugKit' => $baseDir . '/vendor/cakephp/debug_kit/', + 'EnvSource' => $baseDir . '/plugins/EnvSource/', 'Migrations' => $baseDir . '/vendor/cakephp/migrations/', + 'OrcidSource' => $baseDir . '/plugins/OrcidSource/', + 'SshKeyAuthenticator' => $baseDir . '/plugins/SshKeyAuthenticator/', + 'TermsAgreer' => $baseDir . '/plugins/TermsAgreer/', ], ]; diff --git a/app/vendor/cakephp/authentication/composer.json b/app/vendor/cakephp/authentication/composer.json index 22782b3d0..8f74bcc9d 100644 --- a/app/vendor/cakephp/authentication/composer.json +++ b/app/vendor/cakephp/authentication/composer.json @@ -35,7 +35,7 @@ "cakephp/cakephp": "^5.1.0", "cakephp/cakephp-codesniffer": "^5.0", "firebase/php-jwt": "^6.2", - "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.0.9" + "phpunit/phpunit": "^10.5.58 || ^11.5.3 || ^12.4" }, "suggest": { "ext-ldap": "Make sure this php extension is installed and enabled on your system if you want to use the built-in LDAP adapter for \"LdapIdentifier\".", diff --git a/app/vendor/cakephp/authentication/src/AuthenticationPlugin.php b/app/vendor/cakephp/authentication/src/AuthenticationPlugin.php new file mode 100644 index 000000000..3400bf096 --- /dev/null +++ b/app/vendor/cakephp/authentication/src/AuthenticationPlugin.php @@ -0,0 +1,45 @@ + [ + * 'enabled' => true, // Enable validation (default: false for BC) + * 'maxDepth' => 1, // Max nested "redirect=" parameters (default: 1) + * 'maxEncodingLevels' => 1, // Max percent-encoding levels (default: 1) + * 'maxLength' => 2000, // Max URL length in characters (default: 2000) + * ] + * ``` * * ### Example: * @@ -105,6 +117,12 @@ class AuthenticationService implements AuthenticationServiceInterface, Impersona 'identityAttribute' => 'identity', 'queryParam' => null, 'unauthenticatedRedirect' => null, + 'redirectValidation' => [ + 'enabled' => false, // Disabled by default for backward compatibility + 'maxDepth' => 1, + 'maxEncodingLevels' => 1, + 'maxLength' => 2000, + ], ]; /** @@ -383,14 +401,20 @@ public function buildIdentity(ArrayAccess|array $identityData): IdentityInterfac */ public function getUnauthenticatedRedirectUrl(ServerRequestInterface $request): ?string { - $param = $this->getConfig('queryParam'); $target = $this->getConfig('unauthenticatedRedirect'); if ($target === null) { return null; } + if (is_array($target) && class_exists(Router::class)) { $target = Router::url($target); } + + if ($request->getMethod() !== 'GET') { + return $target; + } + + $param = $this->getConfig('queryParam'); if ($param === null) { return $target; } @@ -451,7 +475,49 @@ public function getLoginRedirect(ServerRequestInterface $request): ?string $parsed['query'] = "?{$parsed['query']}"; } - return $parsed['path'] . $parsed['query']; + $redirect = $parsed['path'] . $parsed['query']; + + // Validate redirect to prevent loops if enabled + return $this->validateRedirect($redirect); + } + + /** + * Validates a redirect URL to prevent loops and malicious patterns + * + * This method can be overridden in subclasses to implement custom validation logic. + * + * @param string $redirect The redirect URL to validate + * @return string|null The validated URL or null if invalid + */ + protected function validateRedirect(string $redirect): ?string + { + $config = $this->getConfig('redirectValidation'); + + // If validation is disabled, return the URL as-is (backward compatibility) + if (!$config['enabled']) { + return $redirect; + } + + $decodedUrl = urldecode($redirect); + + // Check for nested redirect parameters + $redirectCount = substr_count($decodedUrl, 'redirect='); + if ($redirectCount >= $config['maxDepth']) { + return null; + } + + // Check for multiple encoding levels (e.g., %25 = percent-encoded %) + $encodingCount = substr_count($redirect, '%25'); + if ($encodingCount >= $config['maxEncodingLevels']) { + return null; + } + + // Check URL length to prevent DOS attacks + if (strlen($redirect) > $config['maxLength']) { + return null; + } + + return $redirect; } /** diff --git a/app/vendor/cakephp/authentication/src/Authenticator/AuthenticationRequiredException.php b/app/vendor/cakephp/authentication/src/Authenticator/AuthenticationRequiredException.php index 1bdd6370e..017074ce1 100644 --- a/app/vendor/cakephp/authentication/src/Authenticator/AuthenticationRequiredException.php +++ b/app/vendor/cakephp/authentication/src/Authenticator/AuthenticationRequiredException.php @@ -28,7 +28,7 @@ class AuthenticationRequiredException extends HttpException { /** - * @var array + * @var array|string> */ protected array $headers = []; diff --git a/app/vendor/cakephp/authentication/src/Authenticator/CookieAuthenticator.php b/app/vendor/cakephp/authentication/src/Authenticator/CookieAuthenticator.php index 6c16053f0..580aec6b3 100644 --- a/app/vendor/cakephp/authentication/src/Authenticator/CookieAuthenticator.php +++ b/app/vendor/cakephp/authentication/src/Authenticator/CookieAuthenticator.php @@ -18,6 +18,8 @@ use ArrayAccess; use Authentication\Identifier\AbstractIdentifier; +use Authentication\Identifier\IdentifierCollection; +use Authentication\Identifier\IdentifierInterface; use Authentication\PasswordHasher\PasswordHasherTrait; use Authentication\UrlChecker\UrlCheckerTrait; use Cake\Http\Cookie\Cookie; @@ -55,6 +57,26 @@ class CookieAuthenticator extends AbstractAuthenticator implements PersistenceIn 'salt' => true, ]; + /** + * Gets the identifier, loading a default Password identifier if none configured. + * + * This is done lazily to allow loadIdentifier() to be called after loadAuthenticator(). + * + * @return \Authentication\Identifier\IdentifierInterface + */ + public function getIdentifier(): IdentifierInterface + { + if ($this->_identifier instanceof IdentifierCollection && $this->_identifier->isEmpty()) { + $identifierConfig = []; + if ($this->getConfig('fields')) { + $identifierConfig['fields'] = $this->getConfig('fields'); + } + $this->_identifier->load('Authentication.Password', $identifierConfig); + } + + return $this->_identifier; + } + /** * @inheritDoc */ @@ -82,10 +104,11 @@ public function authenticate(ServerRequestInterface $request): ResultInterface [$username, $tokenHash] = $token; - $identity = $this->_identifier->identify(compact('username')); + $identifier = $this->getIdentifier(); + $identity = $identifier->identify(compact('username')); if (!$identity) { - return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $this->_identifier->getErrors()); + return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $identifier->getErrors()); } if (!$this->_checkToken($identity, $tokenHash)) { diff --git a/app/vendor/cakephp/authentication/src/Authenticator/FormAuthenticator.php b/app/vendor/cakephp/authentication/src/Authenticator/FormAuthenticator.php index 07bbe9d76..781b4e70e 100644 --- a/app/vendor/cakephp/authentication/src/Authenticator/FormAuthenticator.php +++ b/app/vendor/cakephp/authentication/src/Authenticator/FormAuthenticator.php @@ -17,6 +17,8 @@ namespace Authentication\Authenticator; use Authentication\Identifier\AbstractIdentifier; +use Authentication\Identifier\IdentifierCollection; +use Authentication\Identifier\IdentifierInterface; use Authentication\UrlChecker\UrlCheckerTrait; use Cake\Routing\Router; use Psr\Http\Message\ServerRequestInterface; @@ -47,6 +49,26 @@ class FormAuthenticator extends AbstractAuthenticator ], ]; + /** + * Gets the identifier, loading a default Password identifier if none configured. + * + * This is done lazily to allow loadIdentifier() to be called after loadAuthenticator(). + * + * @return \Authentication\Identifier\IdentifierInterface + */ + public function getIdentifier(): IdentifierInterface + { + if ($this->_identifier instanceof IdentifierCollection && $this->_identifier->isEmpty()) { + $identifierConfig = []; + if ($this->getConfig('fields')) { + $identifierConfig['fields'] = $this->getConfig('fields'); + } + $this->_identifier->load('Authentication.Password', $identifierConfig); + } + + return $this->_identifier; + } + /** * Checks the fields to ensure they are supplied. * @@ -116,9 +138,12 @@ protected function _buildLoginUrlErrorResult(ServerRequestInterface $request): R } /** - * Authenticates the identity contained in a request. Will use the `config.userModel`, and `config.fields` - * to find POST data that is used to find a matching record in the `config.userModel`. Will return false if - * there is no post data, either username or password is missing, or if the scope conditions have not been met. + * Authenticates the identity contained in a request. + * + * Will use the `config.userModel`, and `config.fields` to find POST data + * that is used to find a matching record in the `config.userModel`. + * Will return false if there is no post data, either username or password is missing, + * or if the scope conditions have not been met. * * @param \Psr\Http\Message\ServerRequestInterface $request The request that contains login information. * @return \Authentication\Authenticator\ResultInterface @@ -136,10 +161,11 @@ public function authenticate(ServerRequestInterface $request): ResultInterface ]); } - $user = $this->_identifier->identify($data); + $identifier = $this->getIdentifier(); + $user = $identifier->identify($data); if (!$user) { - return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $this->_identifier->getErrors()); + return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $identifier->getErrors()); } return new Result($user, Result::SUCCESS); diff --git a/app/vendor/cakephp/authentication/src/Authenticator/HttpBasicAuthenticator.php b/app/vendor/cakephp/authentication/src/Authenticator/HttpBasicAuthenticator.php index e98782433..7d5c2b8d7 100644 --- a/app/vendor/cakephp/authentication/src/Authenticator/HttpBasicAuthenticator.php +++ b/app/vendor/cakephp/authentication/src/Authenticator/HttpBasicAuthenticator.php @@ -16,6 +16,8 @@ namespace Authentication\Authenticator; use Authentication\Identifier\AbstractIdentifier; +use Authentication\Identifier\IdentifierCollection; +use Authentication\Identifier\IdentifierInterface; use Psr\Http\Message\ServerRequestInterface; /** @@ -41,6 +43,26 @@ class HttpBasicAuthenticator extends AbstractAuthenticator implements StatelessI 'skipChallenge' => false, ]; + /** + * Gets the identifier, loading a default Password identifier if none configured. + * + * This is done lazily to allow loadIdentifier() to be called after loadAuthenticator(). + * + * @return \Authentication\Identifier\IdentifierInterface + */ + public function getIdentifier(): IdentifierInterface + { + if ($this->_identifier instanceof IdentifierCollection && $this->_identifier->isEmpty()) { + $identifierConfig = []; + if ($this->getConfig('fields')) { + $identifierConfig['fields'] = $this->getConfig('fields'); + } + $this->_identifier->load('Authentication.Password', $identifierConfig); + } + + return $this->_identifier; + } + /** * Authenticate a user using HTTP auth. Will use the configured User model and attempt a * login using HTTP auth. @@ -58,7 +80,7 @@ public function authenticate(ServerRequestInterface $request): ResultInterface return new Result(null, Result::FAILURE_CREDENTIALS_MISSING); } - $user = $this->_identifier->identify([ + $user = $this->getIdentifier()->identify([ AbstractIdentifier::CREDENTIAL_USERNAME => $username, AbstractIdentifier::CREDENTIAL_PASSWORD => $password, ]); diff --git a/app/vendor/cakephp/authentication/src/Authenticator/JwtAuthenticator.php b/app/vendor/cakephp/authentication/src/Authenticator/JwtAuthenticator.php index 2afa82fe2..3ce212e35 100644 --- a/app/vendor/cakephp/authentication/src/Authenticator/JwtAuthenticator.php +++ b/app/vendor/cakephp/authentication/src/Authenticator/JwtAuthenticator.php @@ -17,6 +17,7 @@ namespace Authentication\Authenticator; use ArrayObject; +use Authentication\Identifier\IdentifierCollection; use Authentication\Identifier\IdentifierInterface; use Authentication\Identifier\JwtSubjectIdentifier; use Cake\Utility\Security; @@ -66,6 +67,22 @@ public function __construct(IdentifierInterface $identifier, array $config = []) } } + /** + * Gets the identifier, loading a default JwtSubject identifier if none configured. + * + * This is done lazily to allow loadIdentifier() to be called after loadAuthenticator(). + * + * @return \Authentication\Identifier\IdentifierInterface + */ + public function getIdentifier(): IdentifierInterface + { + if ($this->_identifier instanceof IdentifierCollection && $this->_identifier->isEmpty()) { + $this->_identifier->load('Authentication.JwtSubject'); + } + + return $this->_identifier; + } + /** * Authenticates the identity based on a JWT token contained in a request. * @@ -106,12 +123,13 @@ public function authenticate(ServerRequestInterface $request): ResultInterface return new Result($user, Result::SUCCESS); } - $user = $this->_identifier->identify([ + $identifier = $this->getIdentifier(); + $user = $identifier->identify([ $subjectKey => $result[$subjectKey], ]); if (!$user) { - return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $this->_identifier->getErrors()); + return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $identifier->getErrors()); } return new Result($user, Result::SUCCESS); diff --git a/app/vendor/cakephp/authentication/src/Authenticator/SessionAuthenticator.php b/app/vendor/cakephp/authentication/src/Authenticator/SessionAuthenticator.php index a6c98deaf..32c7f983e 100644 --- a/app/vendor/cakephp/authentication/src/Authenticator/SessionAuthenticator.php +++ b/app/vendor/cakephp/authentication/src/Authenticator/SessionAuthenticator.php @@ -21,6 +21,7 @@ use Cake\Http\Exception\UnauthorizedException; use Psr\Http\Message\ResponseInterface; use Psr\Http\Message\ServerRequestInterface; +use function Cake\Core\deprecationWarning; /** * Session Authenticator @@ -31,9 +32,9 @@ class SessionAuthenticator extends AbstractAuthenticator implements PersistenceI * Default config for this object. * - `fields` The fields to use to verify a user by. * - `sessionKey` Session key. - * - `identify` Whether to identify user data stored in a session. This is - * useful if you want to remotely end sessions that have a different password stored, - * or if your identification logic needs additional conditions before a user can login. + * - `identify` Whether to identify user data stored in a session. + * Deprecated: Use `PrimaryKeySessionAuthenticator` instead if you + * need to fetch fresh user data from the database on each request. * * @var array */ @@ -65,6 +66,11 @@ public function authenticate(ServerRequestInterface $request): ResultInterface } if ($this->getConfig('identify') === true) { + deprecationWarning( + '3.4.0', + 'The `identify` option is deprecated. ' . + 'Use `PrimaryKeySessionAuthenticator` instead to fetch fresh user data on each request.', + ); $credentials = []; foreach ($this->getConfig('fields') as $key => $field) { $credentials[$key] = $user[$field]; diff --git a/app/vendor/cakephp/authentication/src/Authenticator/TokenAuthenticator.php b/app/vendor/cakephp/authentication/src/Authenticator/TokenAuthenticator.php index 385a9c5c4..3751ac82d 100644 --- a/app/vendor/cakephp/authentication/src/Authenticator/TokenAuthenticator.php +++ b/app/vendor/cakephp/authentication/src/Authenticator/TokenAuthenticator.php @@ -16,6 +16,8 @@ */ namespace Authentication\Authenticator; +use Authentication\Identifier\IdentifierCollection; +use Authentication\Identifier\IdentifierInterface; use Authentication\Identifier\TokenIdentifier; use Psr\Http\Message\ServerRequestInterface; @@ -35,6 +37,22 @@ class TokenAuthenticator extends AbstractAuthenticator implements StatelessInter 'tokenPrefix' => null, ]; + /** + * Gets the identifier, loading a default Token identifier if none configured. + * + * This is done lazily to allow loadIdentifier() to be called after loadAuthenticator(). + * + * @return \Authentication\Identifier\IdentifierInterface + */ + public function getIdentifier(): IdentifierInterface + { + if ($this->_identifier instanceof IdentifierCollection && $this->_identifier->isEmpty()) { + $this->_identifier->load('Authentication.Token'); + } + + return $this->_identifier; + } + /** * Checks if the token is in the headers or a request parameter * @@ -124,12 +142,13 @@ public function authenticate(ServerRequestInterface $request): ResultInterface return new Result(null, Result::FAILURE_CREDENTIALS_MISSING); } - $user = $this->_identifier->identify([ + $identifier = $this->getIdentifier(); + $user = $identifier->identify([ TokenIdentifier::CREDENTIAL_TOKEN => $token, ]); if (!$user) { - return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $this->_identifier->getErrors()); + return new Result(null, Result::FAILURE_IDENTITY_NOT_FOUND, $identifier->getErrors()); } return new Result($user, Result::SUCCESS); diff --git a/app/vendor/cakephp/authentication/src/Identifier/IdentifierCollection.php b/app/vendor/cakephp/authentication/src/Identifier/IdentifierCollection.php index ec49d1dc0..257b25d8e 100644 --- a/app/vendor/cakephp/authentication/src/Identifier/IdentifierCollection.php +++ b/app/vendor/cakephp/authentication/src/Identifier/IdentifierCollection.php @@ -56,7 +56,11 @@ public function identify(array $credentials): ArrayAccess|array|null return $result; } - $this->_errors[$name] = $identifier->getErrors(); + + $errors = $identifier->getErrors(); + if ($errors) { + $this->_errors[$name] = $identifier->getErrors(); + } } $this->_successfulIdentifier = null; diff --git a/app/vendor/cakephp/authentication/src/Plugin.php b/app/vendor/cakephp/authentication/src/Plugin.php index 2e169f6b2..40c4da55a 100644 --- a/app/vendor/cakephp/authentication/src/Plugin.php +++ b/app/vendor/cakephp/authentication/src/Plugin.php @@ -15,31 +15,9 @@ */ namespace Authentication; -use Cake\Core\BasePlugin; - /** - * Plugin class for CakePHP. + * @deprecated 3.3.4 Use AuthenticationPlugin instead */ -class Plugin extends BasePlugin +class Plugin extends AuthenticationPlugin { - /** - * Do bootstrapping or not - * - * @var bool - */ - protected bool $bootstrapEnabled = false; - - /** - * Load routes or not - * - * @var bool - */ - protected bool $routesEnabled = false; - - /** - * Console middleware - * - * @var bool - */ - protected bool $consoleEnabled = false; } diff --git a/app/vendor/cakephp/bake/.phive/phars.xml b/app/vendor/cakephp/bake/.phive/phars.xml index f5aa33004..40973f754 100644 --- a/app/vendor/cakephp/bake/.phive/phars.xml +++ b/app/vendor/cakephp/bake/.phive/phars.xml @@ -1,4 +1,4 @@ - + diff --git a/app/vendor/cakephp/bake/Dockerfile b/app/vendor/cakephp/bake/Dockerfile index 7acfb27ee..d1f129524 100644 --- a/app/vendor/cakephp/bake/Dockerfile +++ b/app/vendor/cakephp/bake/Dockerfile @@ -1,26 +1,36 @@ -# Basic docker based environment -# Necessary to trick dokku into building the documentation -# using dockerfile instead of herokuish -FROM ubuntu:22.04 - -# Add basic tools -RUN apt-get update && \ - apt-get install -y build-essential \ - software-properties-common \ - curl \ - git \ - libxml2 \ - libffi-dev \ - libssl-dev - -# Prevent interactive timezone input -ENV DEBIAN_FRONTEND=noninteractive -RUN LC_ALL=C.UTF-8 add-apt-repository ppa:ondrej/php && \ - apt-get update && \ - apt-get install -y php8.1-cli php8.1-mbstring php8.1-xml php8.1-zip php8.1-intl php8.1-opcache php8.1-sqlite - -WORKDIR /code - -VOLUME ["/code"] - -CMD [ '/bin/bash' ] +# ---------------------- +# 1. Build stage +# ---------------------- +FROM node:24-alpine AS builder + +# Git is required because docs/package.json pulls a dependency from GitHub. +RUN apk add --no-cache git openssh-client + +WORKDIR /app/docs + +# Copy dependency manifests first to preserve Docker layer caching. +COPY docs/ ./ +RUN npm ci + +# Increase max-old-space-size to avoid memory issues during build +#ENV NODE_OPTIONS="--max-old-space-size=8192" + +# Build the site. +RUN npm run docs:build + +# ---------------------- +# 2. Runtime stage (angie) +# ---------------------- +FROM docker.angie.software/angie:latest AS runner + +# Copy built files +COPY --from=builder /app/docs/.vitepress/dist /usr/share/angie/html + +# Expose port +EXPOSE 80 + +# Health check (optional) +HEALTHCHECK CMD wget --quiet --tries=1 --spider http://localhost:80/ || exit 1 + +# Start angie +CMD ["angie", "-g", "daemon off;"] diff --git a/app/vendor/cakephp/bake/composer.json b/app/vendor/cakephp/bake/composer.json index fedab7a39..6ad33444a 100644 --- a/app/vendor/cakephp/bake/composer.json +++ b/app/vendor/cakephp/bake/composer.json @@ -23,15 +23,15 @@ }, "require": { "php": ">=8.1", - "brick/varexporter": "^0.6.0", + "brick/varexporter": "^0.6.0 || ^0.7.0", "cakephp/cakephp": "^5.1", - "cakephp/twig-view": "^2.0.0", + "cakephp/twig-view": "^2.0.2", "nikic/php-parser": "^5.0.0" }, "require-dev": { "cakephp/cakephp-codesniffer": "^5.0.0", "cakephp/debug_kit": "^5.0.0", - "phpunit/phpunit": "^10.5.5 || ^11.1.3" + "phpunit/phpunit": "^10.5.40 || ^11.5.20 || ^12.2.4" }, "autoload": { "psr-4": { @@ -40,10 +40,17 @@ }, "autoload-dev": { "psr-4": { + "Authentication\\": "tests/test_app/Plugin/Authentication/src/", + "Authorization\\": "tests/test_app/Plugin/Authorization/src/", "BakeTest\\": "tests/test_app/Plugin/BakeTest/src/", "Bake\\Test\\": "tests/", "Bake\\Test\\App\\": "tests/test_app/App/", "Company\\Pastry\\": "tests/test_app/Plugin/Company/Pastry/src/", + "FixtureTest\\": "tests/test_app/App/Plugin/FixtureTest/src/", + "TestBake\\": "tests/test_app/Plugin/TestBake/src/", + "TestBakeTheme\\": "tests/test_app/Plugin/TestBakeTheme/src/", + "TestTemplate\\": "tests/test_app/App/Plugin/TestTemplate/src/", + "TestTest\\": "tests/test_app/App/Plugin/TestTest/src/", "WithBakeSubFolder\\": "tests/test_app/Plugin/WithBakeSubFolder/src/" } }, @@ -58,12 +65,15 @@ "@test", "@cs-check" ], - "cs-check": "phpcs --parallel=16 -p src/ tests/", - "cs-fix": "phpcbf --parallel=16 -p src/ tests/", + "cs-check": "phpcs", + "cs-fix": "phpcbf", "phpstan": "tools/phpstan analyse", "stan": "@phpstan", "stan-baseline": "tools/phpstan --generate-baseline", "stan-setup": "phive install", + "rector-setup": "cp composer.json composer.backup && composer require --dev rector/rector:\"~2.3.1\" && mv composer.backup composer.json", + "rector-check": "vendor/bin/rector process --dry-run", + "rector-fix": "vendor/bin/rector process", "test": "phpunit", "test-coverage": "phpunit --coverage-clover=clover.xml" } diff --git a/app/vendor/cakephp/bake/docs.Dockerfile b/app/vendor/cakephp/bake/docs.Dockerfile deleted file mode 100644 index eb134b0ee..000000000 --- a/app/vendor/cakephp/bake/docs.Dockerfile +++ /dev/null @@ -1,24 +0,0 @@ -# Generate the HTML output. -FROM ghcr.io/cakephp/docs-builder as builder - -# Copy entire repo in with .git so we can build all versions in one image. -COPY docs /data/docs - -RUN cd /data/docs-builder \ - && make website LANGS="en es fr ja pt ru" SOURCE=/data/docs DEST=/data/website/ - -# Build a small nginx container with just the static site in it. -FROM ghcr.io/cakephp/docs-builder:runtime as runtime - -# Configure search index script -ENV LANGS="en es fr ja pt ru" -ENV SEARCH_SOURCE="/usr/share/nginx/html" -ENV SEARCH_URL_PREFIX="/bake/3" - -COPY --from=builder /data/docs /data/docs -COPY --from=builder /data/website /data/website -COPY --from=builder /data/docs-builder/nginx.conf /etc/nginx/conf.d/default.conf - -# Copy docs into place. -RUN cp -R /data/website/html/* /usr/share/nginx/html \ - && rm -rf /data/website diff --git a/app/vendor/cakephp/bake/docs/.vitepress/config.js b/app/vendor/cakephp/bake/docs/.vitepress/config.js new file mode 100644 index 000000000..5e8ac6185 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/config.js @@ -0,0 +1,94 @@ +import baseConfig from '@cakephp/docs-skeleton/config' +import { createRequire } from 'module' + +const require = createRequire(import.meta.url) +const tocEn = require('./toc_en.json') +const tocEs = require('./toc_es.json') +const tocFr = require('./toc_fr.json') +const tocJa = require('./toc_ja.json') +const tocPt = require('./toc_pt.json') +const tocRu = require('./toc_ru.json') + +const versions = { + text: '3.x', + items: [ + { text: '3.x (current)', link: 'https://book.cakephp.org/bake/3/', target: '_self' }, + { text: '2.x', link: 'https://book.cakephp.org/bake/2.x/', target: '_self' }, + { text: '1.x', link: 'https://book.cakephp.org/bake/1.x/', target: '_self' }, + ], +} + +export default { + extends: baseConfig, + srcDir: '.', + title: 'Bake', + description: 'CakePHP Bake Documentation', + base: '/bake/3/', + rewrites: { + 'en/:slug*': ':slug*', + }, + sitemap: { + hostname: 'https://book.cakephp.org/bake/3/', + }, + themeConfig: { + siteTitle: false, + pluginName: "Bake", + socialLinks: [ + { icon: 'github', link: 'https://github.com/cakephp/bake' }, + ], + editLink: { + pattern: 'https://github.com/cakephp/bake/edit/3.x/docs/:path', + text: 'Edit this page on GitHub', + }, + sidebar: tocEn, + nav: [ + { text: 'CakePHP', link: 'https://cakephp.org' }, + { text: 'API', link: 'https://api.cakephp.org/bake/' }, + { ...versions }, + ], + }, + locales: { + root: { + label: 'English', + lang: 'en', + themeConfig: { + sidebar: tocEn, + }, + }, + es: { + label: 'Español', + lang: 'es', + themeConfig: { + sidebar: tocEs, + }, + }, + fr: { + label: 'Français', + lang: 'fr', + themeConfig: { + sidebar: tocFr, + }, + }, + ja: { + label: '日本語', + lang: 'ja', + themeConfig: { + sidebar: tocJa, + }, + }, + pt: { + label: 'Português', + lang: 'pt', + themeConfig: { + sidebar: tocPt, + }, + }, + ru: { + label: 'Русский', + lang: 'ru', + themeConfig: { + sidebar: tocRu, + }, + }, + }, +} diff --git a/app/vendor/cakephp/bake/docs/.vitepress/theme/index.js b/app/vendor/cakephp/bake/docs/.vitepress/theme/index.js new file mode 100644 index 000000000..e33e19ec9 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/theme/index.js @@ -0,0 +1 @@ +export { default } from '@cakephp/docs-skeleton' diff --git a/app/vendor/cakephp/bake/docs/.vitepress/toc_en.json b/app/vendor/cakephp/bake/docs/.vitepress/toc_en.json new file mode 100644 index 000000000..ae8a22c60 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/toc_en.json @@ -0,0 +1,13 @@ +{ + "/": [ + { + "text": "CakePHP Bake", + "collapsed": false, + "items": [ + { "text": "Bake Console", "link": "/" }, + { "text": "Code Generation with Bake", "link": "/usage" }, + { "text": "Extending Bake", "link": "/development" } + ] + } + ] +} diff --git a/app/vendor/cakephp/bake/docs/.vitepress/toc_es.json b/app/vendor/cakephp/bake/docs/.vitepress/toc_es.json new file mode 100644 index 000000000..98b6e2cb0 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/toc_es.json @@ -0,0 +1,13 @@ +{ + "/es/": [ + { + "text": "CakePHP Bake", + "collapsed": false, + "items": [ + { "text": "Consola Bake", "link": "/es/" }, + { "text": "Crear código con Bake", "link": "/es/usage" }, + { "text": "Extending Bake", "link": "/es/development" } + ] + } + ] +} diff --git a/app/vendor/cakephp/bake/docs/.vitepress/toc_fr.json b/app/vendor/cakephp/bake/docs/.vitepress/toc_fr.json new file mode 100644 index 000000000..eceb87131 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/toc_fr.json @@ -0,0 +1,13 @@ +{ + "/fr/": [ + { + "text": "CakePHP Bake", + "collapsed": false, + "items": [ + { "text": "Console Bake", "link": "/fr/" }, + { "text": "Génération de code avec Bake", "link": "/fr/usage" }, + { "text": "Étendre Bake", "link": "/fr/development" } + ] + } + ] +} diff --git a/app/vendor/cakephp/bake/docs/.vitepress/toc_ja.json b/app/vendor/cakephp/bake/docs/.vitepress/toc_ja.json new file mode 100644 index 000000000..a459e238c --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/toc_ja.json @@ -0,0 +1,13 @@ +{ + "/ja/": [ + { + "text": "CakePHP Bake", + "collapsed": false, + "items": [ + { "text": "Bake コンソール", "link": "/ja/" }, + { "text": "Bake でコード生成", "link": "/ja/usage" }, + { "text": "Bake の拡張", "link": "/ja/development" } + ] + } + ] +} diff --git a/app/vendor/cakephp/bake/docs/.vitepress/toc_pt.json b/app/vendor/cakephp/bake/docs/.vitepress/toc_pt.json new file mode 100644 index 000000000..70af9e386 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/toc_pt.json @@ -0,0 +1,13 @@ +{ + "/pt/": [ + { + "text": "CakePHP Bake", + "collapsed": false, + "items": [ + { "text": "Console Bake", "link": "/pt/" }, + { "text": "Geração de Código com Bake", "link": "/pt/usage" }, + { "text": "Estendendo o Bake", "link": "/pt/development" } + ] + } + ] +} diff --git a/app/vendor/cakephp/bake/docs/.vitepress/toc_ru.json b/app/vendor/cakephp/bake/docs/.vitepress/toc_ru.json new file mode 100644 index 000000000..38d8ea36d --- /dev/null +++ b/app/vendor/cakephp/bake/docs/.vitepress/toc_ru.json @@ -0,0 +1,13 @@ +{ + "/ru/": [ + { + "text": "CakePHP Bake", + "collapsed": false, + "items": [ + { "text": "Консоль Bake", "link": "/ru/" }, + { "text": "Генерация кода с помощью Bake", "link": "/ru/usage" }, + { "text": "Расширение возможностей Bake", "link": "/ru/development" } + ] + } + ] +} diff --git a/app/vendor/cakephp/bake/docs/config/__init__.py b/app/vendor/cakephp/bake/docs/config/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/app/vendor/cakephp/bake/docs/config/all.py b/app/vendor/cakephp/bake/docs/config/all.py deleted file mode 100644 index cfeecdc20..000000000 --- a/app/vendor/cakephp/bake/docs/config/all.py +++ /dev/null @@ -1,50 +0,0 @@ -# Global configuration information used across all the -# translations of documentation. -# -# Import the base theme configuration -from cakephpsphinx.config.all import * - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# - -# The full version, including alpha/beta/rc tags. -release = '3.x' - -# The search index version. -search_version = 'bake-3' - -# The marketing display name for the book. -version_name = '' - -# Project name shown in the black header bar -project = 'CakePHP Bake' - -# Other versions that display in the version picker menu. -version_list = [ - {'name': '1.x', 'number': '/bake/1.x', 'title': '1.x'}, - {'name': '2.x', 'number': '/bake/2.x', 'title': '2.x'}, - {'name': '3.x', 'number': '/bake/3.x', 'title': '3.x', 'current': True}, -] - -# Languages available. -languages = ['en', 'es', 'fr', 'ja', 'pt', 'ru'] - -# The GitHub branch name for this version of the docs -# for edit links to point at. -branch = '2.x' - -# Current version being built -version = '2.x' - -# Language in use for this directory. -language = 'en' - -show_root_link = True - -repository = 'cakephp/bake' - -source_path = 'docs/' - -hide_page_contents = ('search', '404', 'contents') diff --git a/app/vendor/cakephp/bake/docs/en/conf.py b/app/vendor/cakephp/bake/docs/en/conf.py deleted file mode 100644 index f638bda22..000000000 --- a/app/vendor/cakephp/bake/docs/en/conf.py +++ /dev/null @@ -1,9 +0,0 @@ -import sys, os - -# Append the top level directory of the docs, so we can import from the config dir. -sys.path.insert(0, os.path.abspath('..')) - -# Pull in all the configuration options defined in the global config file.. -from config.all import * - -language = 'en' diff --git a/app/vendor/cakephp/bake/docs/en/contents.rst b/app/vendor/cakephp/bake/docs/en/contents.rst deleted file mode 100644 index 08c3e957c..000000000 --- a/app/vendor/cakephp/bake/docs/en/contents.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :maxdepth: 2 - :caption: CakePHP Bake - - /index - /usage - /development diff --git a/app/vendor/cakephp/bake/docs/en/development.md b/app/vendor/cakephp/bake/docs/en/development.md new file mode 100644 index 000000000..bc7d608a8 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/en/development.md @@ -0,0 +1,315 @@ +# Extending Bake + +Bake features an extensible architecture that allows your application or plugins +to modify or add to the base functionality. +Bake makes use of a dedicated view class that uses the [Twig](https://twig.symfony.com/) template engine. + +## Bake Events + +As a view class, `BakeView` emits the same events as any other view class, plus one extra initialize event. +However, whereas standard view classes use the event prefix `View.`, `BakeView` uses the event prefix `Bake.`. + +The initialize event can be used to make changes that apply to all baked output. +For example, to add another helper to the bake view class: + +```php +on('Bake.initialize', function (EventInterface $event) { + $view = $event->getSubject(); + + // In my bake templates, allow the use of the MySpecial helper + $view->loadHelper('MySpecial', ['some' => 'config']); + + // And add an $author variable so it's always available + $view->set('author', 'Andy'); +}); +``` + +Bake events can also be handy for making small changes to existing templates. +For example, to change the variable names used when baking controller and template files, listen for `Bake.beforeRender`: + +```php +on('Bake.beforeRender', function (EventInterface $event) { + $view = $event->getSubject(); + + // Use $rows for the main data variable in indexes + if ($view->get('pluralName')) { + $view->set('pluralName', 'rows'); + } + if ($view->get('pluralVar')) { + $view->set('pluralVar', 'rows'); + } + + // Use $theOne for the main data variable in view/edit + if ($view->get('singularName')) { + $view->set('singularName', 'theOne'); + } + if ($view->get('singularVar')) { + $view->set('singularVar', 'theOne'); + } +}); +``` + +You may also scope `Bake.beforeRender` and `Bake.afterRender` events to a specific generated file. +For instance, if you want to add specific actions to your `UsersController` when generating from a `Controller/controller.twig` file: + +```php +on( + 'Bake.beforeRender.Controller.controller', + function (EventInterface $event) { + $view = $event->getSubject(); + if ($view->get('name') === 'Users') { + // add the login and logout actions to the Users controller + $view->set('actions', [ + 'login', + 'logout', + 'index', + 'view', + 'add', + 'edit', + 'delete', + ]); + } + } +); +``` + +By scoping event listeners to specific bake templates, you can simplify your bake-related event logic and provide callbacks that are easier to test. + +## Bake Template Syntax + +Bake template files use the [Twig](https://twig.symfony.com/) template syntax. + +For example, when baking a command like this: + +```bash +bin/cake bake command Foo +``` + +The template used at `vendor/cakephp/bake/templates/bake/Command/command.twig` looks like this: + +```php +Test->classSuffixes[$this->name()])) { + $this->Test->classSuffixes[$this->name()] = 'Foo'; + } + + $name = ucfirst($this->name()); + if (!isset($this->Test->classTypes[$name])) { + $this->Test->classTypes[$name] = 'Foo'; + } + + parent::bakeTest($className, $args, $io); +} +``` + +- The **class suffix** is appended to the name provided in your `bake` call. In the example above, that would create `ExampleFooTest.php`. +- The **class type** is the sub-namespace used to reach your file relative to the app or plugin you are baking into. In the example above, that would create the test namespace `App\Test\TestCase\Foo`. + +## Configuring the BakeView Class + +Bake commands use the `BakeView` class to render templates. +You can access the instance by listening to the `Bake.initialize` event: + +```php +on( + 'Bake.initialize', + function ($event, $view) { + $view->loadHelper('Foo'); + } +); +``` diff --git a/app/vendor/cakephp/bake/docs/en/development.rst b/app/vendor/cakephp/bake/docs/en/development.rst deleted file mode 100644 index c7c7aa252..000000000 --- a/app/vendor/cakephp/bake/docs/en/development.rst +++ /dev/null @@ -1,343 +0,0 @@ -Extending Bake -############## - -Bake features an extensible architecture that allows your application or plugins -to modify or add-to the base functionality. Bake makes use of a dedicated -view class which uses the `Twig `_ template engine. - -Bake Events -=========== - -As a view class, ``BakeView`` emits the same events as any other view class, -plus one extra initialize event. However, whereas standard view classes use the -event prefix "View.", ``BakeView`` uses the event prefix "Bake.". - -The initialize event can be used to make changes which apply to all baked -output, for example to add another helper to the bake view class this event can -be used:: - - on('Bake.initialize', function (EventInterface $event) { - $view = $event->getSubject(); - - // In my bake templates, allow the use of the MySpecial helper - $view->loadHelper('MySpecial', ['some' => 'config']); - - // And add an $author variable so it's always available - $view->set('author', 'Andy'); - }); - -Bake events can be handy for making small changes to existing templates. -For example, to change the variable names used when baking controller/template -files one can use a function listening for ``Bake.beforeRender`` to modify the -variables used in the bake templates:: - - on('Bake.beforeRender', function (EventInterface $event) { - $view = $event->getSubject(); - - // Use $rows for the main data variable in indexes - if ($view->get('pluralName')) { - $view->set('pluralName', 'rows'); - } - if ($view->get('pluralVar')) { - $view->set('pluralVar', 'rows'); - } - - // Use $theOne for the main data variable in view/edit - if ($view->get('singularName')) { - $view->set('singularName', 'theOne'); - } - if ($view->get('singularVar')) { - $view->set('singularVar', 'theOne'); - } - }); - -You may also scope the ``Bake.beforeRender`` and ``Bake.afterRender`` events to -a specific generated file. For instance, if you want to add specific actions to -your UsersController when generating from a **Controller/controller.twig** file, -you can use the following event:: - - on( - 'Bake.beforeRender.Controller.controller', - function (EventInterface $event) { - $view = $event->getSubject(); - if ($view->get('name') === 'Users') { - // add the login and logout actions to the Users controller - $view->set('actions', [ - 'login', - 'logout', - 'index', - 'view', - 'add', - 'edit', - 'delete', - ]); - } - } - ); - -By scoping event listeners to specific bake templates, you can simplify your -bake related event logic and provide callbacks that are easier to test. - -Bake Template Syntax -==================== - -Bake template files use the `Twig `__ template syntax. - -So, for example, when baking a command like so: - -.. code-block:: bash - - bin/cake bake command Foo - -The template used (**vendor/cakephp/bake/templates/bake/Command/command.twig**) -looks like this:: - - Test->classSuffixes[$this->name()])) { - $this->Test->classSuffixes[$this->name()] = 'Foo'; - } - - $name = ucfirst($this->name()); - if (!isset($this->Test->classTypes[$name])) { - $this->Test->classTypes[$name] = 'Foo'; - } - - return parent::bakeTest($className); - } - -* The **class suffix** will be appened to the name provided in your ``bake`` - call. In the previous example, it would create a ``ExampleFooTest.php`` file. -* The **class type** will be the sub-namespace used that will lead to your - file (relative to the app or the plugin you are baking into). In the previous - example, it would create your test with the namespace ``App\Test\TestCase\Foo``. - -Configuring the BakeView class -============================== - -The bake commands use the ``BakeView`` class to render the templates. You can -access the instance by listening to the ``Bake.initialize`` event. For example, here's -how you can load your own helper so that it can be used in bake templates:: - - on( - 'Bake.initialize', - function ($event, $view) { - $view->loadHelper('Foo'); - } - ); - -.. meta:: - :title lang=en: Extending Bake - :keywords lang=en: command line interface, development, bake view, bake template syntax, twig, erb tags, percent tags diff --git a/app/vendor/cakephp/bake/docs/en/index.md b/app/vendor/cakephp/bake/docs/en/index.md new file mode 100644 index 000000000..4f8b7808b --- /dev/null +++ b/app/vendor/cakephp/bake/docs/en/index.md @@ -0,0 +1,25 @@ +# Bake Console + +CakePHP's bake console is another effort to get you up and running in CakePHP fast. +The bake console can create any of CakePHP's basic ingredients: models, +behaviors, views, helpers, controllers, components, test cases, fixtures, and plugins. +Bake can create far more than skeleton classes and is a natural next step once an application has been scaffolded. + +## Installation + +Before trying to use or extend Bake, make sure it is installed in your application. +Bake is provided as a plugin that you can install with Composer: + +```bash +composer require --dev cakephp/bake:"^3.0" +``` + +The above installs Bake as a development dependency, so it will not be installed during production deployments. + +When using Twig templates, make sure you are loading the `Cake/TwigView` plugin with its bootstrap. +You can also omit it completely, which makes the Bake plugin load it on demand. + +## Documentation Map + +- [Code Generation with Bake](/usage) covers running the console, listing commands, baking models and enums, and changing bake themes. +- [Extending Bake](/development) covers events, Twig templates, custom themes, application template overrides, and creating custom bake commands. diff --git a/app/vendor/cakephp/bake/docs/en/index.rst b/app/vendor/cakephp/bake/docs/en/index.rst deleted file mode 100644 index 38c7d2f89..000000000 --- a/app/vendor/cakephp/bake/docs/en/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -Bake Console -############ - -CakePHP's bake console is another effort to get you up and running in CakePHP -– fast. The bake console can create any of CakePHP's basic ingredients: models, -behaviors, views, helpers, controllers, components, test cases, fixtures and plugins. -And we aren't just talking skeleton classes: Bake can create a fully functional -application in just a few minutes. In fact, Bake is a natural step to take once -an application has been scaffolded. - -Installation -============ - -Before trying to use or extend bake, make sure it is installed in your -application. Bake is provided as a plugin that you can install with Composer:: - - composer require --dev cakephp/bake:"^3.0" - -The above will install bake as a development dependency. This means that it will -not be installed when you do production deployments. - -When using the Twig templates make sure you are loading the -``Cake/TwigView`` plugin with its bootstrap. You can also omit it -completely which then makes Bake plugin load this plugin on demand. - -.. meta:: - :title lang=en: Bake Console - :keywords lang=en: command line interface,development,bake view, bake template syntax,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/en/usage.md b/app/vendor/cakephp/bake/docs/en/usage.md new file mode 100644 index 000000000..76b226d9f --- /dev/null +++ b/app/vendor/cakephp/bake/docs/en/usage.md @@ -0,0 +1,124 @@ +# Code Generation with Bake + +The Bake console is run using the PHP CLI. +If you have problems running the script, ensure that: + +1. You have the PHP CLI installed and that it has the proper modules enabled, such as MySQL and `intl`. +2. If the database host is `localhost`, try `127.0.0.1` instead, as `localhost` can cause issues with PHP CLI. +3. Depending on how your computer is configured, you may need to set execute rights on the Cake shell script to call it using `bin/cake bake`. + +Before running Bake you should make sure you have at least one database connection configured. + +You can get the list of available bake commands by running `bin/cake bake --help`. +For Windows usage use `bin\cake bake --help`: + +```bash +$ bin/cake bake --help +Current Paths: + +* app: src/ +* root: /path/to/your/app/ +* core: /path/to/your/app/vendor/cakephp/cakephp/ + +Available Commands: + +Bake: +- bake all +- bake behavior +- bake cell +- bake command +- bake command_helper +- bake component +- bake controller +- bake controller all +- bake enum +- bake fixture +- bake fixture all +- bake form +- bake helper +- bake mailer +- bake middleware +- bake model +- bake model all +- bake plugin +- bake template +- bake template all +- bake test + +To run a command, type `cake command_name [args|options]` +To get help on a specific command, type `cake command_name --help` +``` + +## Bake Models + +Models are generically baked from existing database tables. +CakePHP conventions apply, so Bake detects relations based on `thing_id` foreign keys to `things` tables with their `id` primary keys. + +For non-conventional relations, you can use references in constraints or foreign key definitions for Bake to detect relations: + +```php +->addForeignKey('billing_country_id', 'countries') // defaults to `id` +->addForeignKey('shipping_country_id', 'countries', 'cid') +``` + +## Bake Enums + +You can use Bake to generate [backed enums](https://www.php.net/manual/en/language.enumerations.backed.php) for use in your models. +Enums are placed in `src/Model/Enum/` and implement `EnumLabelInterface`, which provides a `label()` method for human-readable display. + +To bake a string-backed enum: + +```bash +bin/cake bake enum ArticleStatus draft,published,archived +``` + +This generates `src/Model/Enum/ArticleStatus.php`: + +```php +namespace App\Model\Enum; + +use Cake\Database\Type\EnumLabelInterface; +use Cake\Utility\Inflector; + +enum ArticleStatus: string implements EnumLabelInterface +{ + case Draft = 'draft'; + case Published = 'published'; + case Archived = 'archived'; + + public function label(): string + { + return Inflector::humanize(Inflector::underscore($this->name)); + } +} +``` + +For int-backed enums, use the `-i` option and provide values with colons: + +```bash +bin/cake bake enum Priority low:1,medium:2,high:3 -i +``` + +This generates an int-backed enum: + +```php +enum Priority: int implements EnumLabelInterface +{ + case Low = 1; + case Medium = 2; + case High = 3; + + // ... +} +``` + +You can also bake enums into plugins: + +```bash +bin/cake bake enum MyPlugin.OrderStatus pending,processing,shipped +``` + +## Bake Themes + +The `theme` option is common to all bake commands and allows changing the bake template files used when baking. +To create your own templates, see [Creating a Bake Theme](/development#creating-a-bake-theme). diff --git a/app/vendor/cakephp/bake/docs/en/usage.rst b/app/vendor/cakephp/bake/docs/en/usage.rst deleted file mode 100644 index 8cf9da928..000000000 --- a/app/vendor/cakephp/bake/docs/en/usage.rst +++ /dev/null @@ -1,76 +0,0 @@ -Code Generation with Bake -######################### - -The Bake console is run using the PHP CLI (command line interface). -If you have problems running the script, ensure that: - -#. You have the PHP CLI installed and that it has the proper modules enabled - (eg: MySQL, intl). -#. Users also might have issues if the database host is 'localhost' and should - try '127.0.0.1' instead, as localhost can cause issues with PHP CLI. -#. Depending on how your computer is configured, you may have to set execute - rights on the cake bash script to call it using ``bin/cake bake``. - -Before running bake you should make sure you have at least one database -connection configured. - -You can get the list of available bake command by running ``bin/cake bake --help`` -(For Windows usage ``bin\cake bake --help``) :: - - $ bin/cake bake --help - Current Paths: - - * app: src/ - * root: /path/to/your/app/ - * core: /path/to/your/app/vendor/cakephp/cakephp/ - - Available Commands: - - Bake: - - bake all - - bake behavior - - bake cell - - bake command - - bake command_helper - - bake component - - bake controller - - bake controller all - - bake enum - - bake fixture - - bake fixture all - - bake form - - bake helper - - bake mailer - - bake middleware - - bake model - - bake model all - - bake plugin - - bake template - - bake template all - - bake test - - To run a command, type `cake command_name [args|options]` - To get help on a specific command, type `cake command_name --help` - -Bake Models -=========== - -Models are generically baked from the existing DB tables. -The conventions here apply, so it will detect relations based on ``thing_id`` foreign keys to ``things`` tables with their ``id`` primary keys. - -For non-conventional relations, you can use references in the constraints / foreign key definitions for Bake to detect the relations, e.g.:: - - ->addForeignKey('billing_country_id', 'countries') // defaults to `id` - ->addForeignKey('shipping_country_id', 'countries', 'cid') - - -Bake Themes -=========== - -The theme option is common to all bake commands, and allows changing the bake -template files used when baking. To create your own templates, see the -:ref:`bake theme creation documentation `. - -.. meta:: - :title lang=en: Code Generation with Bake - :keywords lang=en: command line interface,functional application,database,database configuration,bash script,basic ingredients,project,model,path path,code generation,scaffolding,windows users,configuration file,few minutes,config,view,models,running,mysql diff --git a/app/vendor/cakephp/bake/docs/es/conf.py b/app/vendor/cakephp/bake/docs/es/conf.py deleted file mode 100644 index 4691ece6a..000000000 --- a/app/vendor/cakephp/bake/docs/es/conf.py +++ /dev/null @@ -1,9 +0,0 @@ -import sys, os - -# Append the top level directory of the docs, so we can import from the config dir. -sys.path.insert(0, os.path.abspath('..')) - -# Pull in all the configuration options defined in the global config file.. -from config.all import * - -language = 'es' diff --git a/app/vendor/cakephp/bake/docs/es/contents.rst b/app/vendor/cakephp/bake/docs/es/contents.rst deleted file mode 100644 index 08c3e957c..000000000 --- a/app/vendor/cakephp/bake/docs/es/contents.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :maxdepth: 2 - :caption: CakePHP Bake - - /index - /usage - /development diff --git a/app/vendor/cakephp/bake/docs/es/development.md b/app/vendor/cakephp/bake/docs/es/development.md new file mode 100644 index 000000000..a6ecced69 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/es/development.md @@ -0,0 +1,9 @@ +# Extending Bake + +::: info +La documentación no es compatible actualmente con el idioma español en esta página. + +Por favor, siéntase libre de enviarnos un pull request en [GitHub](https://github.com/cakephp/bake) o utilizar el botón de edición de la documentación para proponer cambios. + +Puede consultar la versión en inglés desde el selector de idioma superior para obtener información sobre este tema. +::: diff --git a/app/vendor/cakephp/bake/docs/es/development.rst b/app/vendor/cakephp/bake/docs/es/development.rst deleted file mode 100644 index 7f717d051..000000000 --- a/app/vendor/cakephp/bake/docs/es/development.rst +++ /dev/null @@ -1,17 +0,0 @@ -Extending Bake -############## - -.. note:: - La documentación no es compatible actualmente con el idioma español en esta página. - - Por favor, siéntase libre de enviarnos un pull request en - `Github `_ o utilizar el botón **Improve this Doc** para proponer directamente los cambios. - - Usted puede hacer referencia a la versión en Inglés en el menú de selección superior - para obtener información sobre el tema de esta página. - -.. _creating-a-bake-theme: - -.. meta:: - :title lang=es: Extending Bake - :keywords lang=es: command line interface,development,bake view, bake template syntax,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/es/index.md b/app/vendor/cakephp/bake/docs/es/index.md new file mode 100644 index 000000000..6e7328672 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/es/index.md @@ -0,0 +1,24 @@ +# Consola Bake + +La consola Bake de CakePHP permite preparar y ejecutar CakePHP rápidamente. +Puede crear muchos de los ingredientes básicos de CakePHP, como modelos, +behaviours, vistas, helpers, controladores, componentes, casos de prueba, +fixtures y plugins. +Bake puede generar mucho más que esqueletos de clases y es un paso natural después de crear la base de la aplicación. + +## Instalación + +Antes de intentar utilizar o extender Bake, asegúrate de que está instalado en tu aplicación. +Bake se distribuye como un plugin que puedes instalar con Composer: + +```bash +composer require --dev cakephp/bake:~1.0 +``` + +La instrucción anterior instalará Bake como una dependencia de desarrollo. +Esto significa que no será instalado cuando hagas despliegues en producción. + +## Mapa de documentación + +- [Crear código con Bake](/es/usage) cubre la ejecución del CLI, el listado de tareas y los temas de Bake. +- [Extending Bake](/es/development) enlaza al contenido disponible para ampliaciones y personalización. diff --git a/app/vendor/cakephp/bake/docs/es/index.rst b/app/vendor/cakephp/bake/docs/es/index.rst deleted file mode 100644 index 80f1fa654..000000000 --- a/app/vendor/cakephp/bake/docs/es/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -Consola bake -############ - -La consola bake de CakePHP es otro esfuerzo para preparar y ejecutar CakePHP rápidamente. - -La consola bake puede crear cualquiera de los ingredientes básicos de CakePHP: -modelos, behaviours, vistas, helpers, controladores, componentes, casos de -prueba, fixtures y plugins. - -Y no hablamos sólo de esqueletos de clases: Bake puede crear una aplicación -totalmente funcional en solo un par de minutos. - -De hecho, Bake es un paso natural a dar una vez ha sido creado el esqueleto de -la aplicación. - -Instalación -=========== - -Antes de intentar utilizar o extender bake asegúrate de que está instalado en tu -aplicación. - -Bake está incluido como un plugin que puedes instalar con Composer:: - - composer require --dev cakephp/bake:~1.0 - -La instrucción anterior instalará bake como una dependencia de desarrollo. Esto -significa que no será instalado cuando hagas despliegues en producción. - -.. meta:: - :title lang=es: Consola Bake - :keywords lang=es: interfaz de línea de comando,desarrollo,bake vista, bake sintaxis plantilla,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/es/usage.md b/app/vendor/cakephp/bake/docs/es/usage.md new file mode 100644 index 000000000..c1862006d --- /dev/null +++ b/app/vendor/cakephp/bake/docs/es/usage.md @@ -0,0 +1,100 @@ +# Crear código con Bake + +La consola de Cake se ejecuta usando PHP CLI. +Si tiene problemas para ejecutar el script, asegúrese de: + +1. Tener instalado PHP CLI y los módulos correspondientes habilitados, por ejemplo MySQL e `intl`. +2. Si el host de la base de datos es `localhost`, intentar la conexión con `127.0.0.1`, ya que en algunos casos PHP CLI tiene problemas al usar `localhost`. +3. Dependiendo de cómo esté configurado su equipo, la ejecución de `bin/cake bake` puede requerir permisos de ejecución. + +Antes de comenzar, asegúrese de disponer al menos de una conexión a base de datos configurada. + +Para comenzar con la ejecución del comando puede abrir la consola y ejecutar `Cake bake`. + +1. Ir a Inicio > Ejecutar. +2. Escribir `cmd` y presionar Enter. +3. Navegar hasta la carpeta de instalación de Cake. +4. Acceder a la carpeta `bin`. +5. Escribir `Cake bake`, lo cual deberá devolver un listado con las tareas disponibles. + +El resultado debería ser algo similar a lo siguiente: + +```bash +$ bin/cake bake + +Welcome to CakePHP v3.1.6 Console +--------------------------------------------------------------- +App : src +Path: /var/www/cakephp.dev/src/ +PHP: 5.5.8 +--------------------------------------------------------------- +The following commands can be used to generate skeleton code for your application. + +Available bake commands: + +- all +- behavior +- cell +- component +- controller +- fixture +- form +- helper +- mailer +- migration +- migration_snapshot +- model +- plugin +- template +- test + +By using 'cake bake [name]' you can invoke a specific bake task. +``` + +Puede obtener más información sobre lo que realiza cada tarea y sus opciones usando `--help`: + +```bash +$ bin/cake bake controller --help + +Welcome to CakePHP v3.1.6 Console +--------------------------------------------------------------- +App : src +Path: /var/www/cakephp.dev/src/ +--------------------------------------------------------------- +Bake a controller skeleton. + +Usage: +cake bake controller [subcommand] [options] [] + +Subcommands: + +all Bake all controllers with CRUD methods. + +To see help on a subcommand use `cake bake controller [subcommand] --help` + +Options: + +--help, -h Display this help. +--verbose, -v Enable verbose output. +--quiet, -q Enable quiet output. +--plugin, -p Plugin to bake into. +--force, -f Force overwriting existing files without prompting. +--connection, -c The datasource connection to get data from. + (default: default) +--theme, -t The theme to use when baking code. +--components The comma separated list of components to use. +--helpers The comma separated list of helpers to use. +--prefix The namespace/routing prefix to use. +--no-test Do not generate a test skeleton. +--no-actions Do not generate basic CRUD action methods. + +Arguments: + +name Name of the controller to bake. Can use Plugin.name to bake + controllers into plugins. (optional) +``` + +## Temas Bake / Templates + +La opción `theme` es genérica para todos los comandos Bake y permite cambiar los templates utilizados para generar los archivos finales. +Para crear sus propios templates, vea [Creating a Bake Theme](/es/development#creating-a-bake-theme). diff --git a/app/vendor/cakephp/bake/docs/es/usage.rst b/app/vendor/cakephp/bake/docs/es/usage.rst deleted file mode 100644 index 40a6e43a3..000000000 --- a/app/vendor/cakephp/bake/docs/es/usage.rst +++ /dev/null @@ -1,113 +0,0 @@ -Crear código con Bake -##################### - -La consola de CAKE se ejecuta usando PHP CLI (command line interface). -Si tiene problemas para ejecutar el script, asegurese de: - -#. Tener instalado el PHP CLI y que estén los módulos correspondientes - habilitados (ej: MySQL y intl). -#. Si el host de base de datos es 'localhost', intente realizar la conexión con - el ip '127.0.0.1'. En algunos casos PHP CLI tiene problemas al referenciar - por nombre de host (localhost). -#. Dependiendo de como esté configurado su equipo, la ejecución del comando - CAKE BAKE (cake bash script) puede requerir permisos de ejecución al - lanzar ``bin/cake bake``. - -Antes de comenzar la ejecución, asegúrese de disponer al menos de una conexión -a una base de datos configurada. - -Para comenzar con la ejecución del comando debe abrir la consola de windows -y ejecutar "Cake Bake" - -#. Ir a Inicio (Start) > Ejecutar (Run) -#. Escribir "cmd" y presionar 'Enter' -#. Navegar hasta llegar a la carpeta de instalación de cake -#. Acceder a la carpeta 'bin' -#. Escribir 'Cake bake' lo cual deberá devolver un listado con todas las - tareas/actividades disponibles. - -El resultado debería ser algo similar a lo siguiente:: - - $ bin/cake bake - - Welcome to CakePHP v3.1.6 Console - --------------------------------------------------------------- - App : src - Path: /var/www/cakephp.dev/src/ - PHP: 5.5.8 - --------------------------------------------------------------- - The following commands can be used to generate skeleton code for your application. - - Available bake commands: - - - all - - behavior - - cell - - component - - controller - - fixture - - form - - helper - - mailer - - migration - - migration_snapshot - - model - - plugin - - template - - test - - By using 'cake bake [name]' you can invoke a specific bake task. - -Puede obtener más información sobre lo que realiza cada una de las actividades -y sus opciones usando el parametro '--help' option:: - - $ bin/cake bake controller --help - - Welcome to CakePHP v3.1.6 Console - --------------------------------------------------------------- - App : src - Path: /var/www/cakephp.dev/src/ - --------------------------------------------------------------- - Bake a controller skeleton. - - Usage: - cake bake controller [subcommand] [options] [] - - Subcommands: - - all Bake all controllers with CRUD methods. - - To see help on a subcommand use `cake bake controller [subcommand] --help` - - Options: - - --help, -h Display this help. - --verbose, -v Enable verbose output. - --quiet, -q Enable quiet output. - --plugin, -p Plugin to bake into. - --force, -f Force overwriting existing files without prompting. - --connection, -c The datasource connection to get data from. - (default: default) - --theme, -t The theme to use when baking code. - --components The comma separated list of components to use. - --helpers The comma separated list of helpers to use. - --prefix The namespace/routing prefix to use. - --no-test Do not generate a test skeleton. - --no-actions Do not generate basic CRUD action methods. - - Arguments: - - name Name of the controller to bake. Can use Plugin.name to bake - controllers into plugins. (optional) - -Temas Bake / Templates -====================== - -La opción ``theme`` es genérica para todos los comandos bake y permite cambiar los -templates de bake utilizados para generar los archivos finales. Para crear sus -propios templates, ver :ref:`bake theme creation documentation -`. - -.. meta:: - :title lang=es: Crear código con Bake - :keywords lang=es: interfaz de línea de comando, aplicación funcional, base de datos, configuración de base de datos, bash script, ingredientes básicos, proyecto, modelo, path, crear código, generación de código, scaffolding, usuarios windows, archivo de configuración, pocos minutos, configurar, view, modelos, running, mysql diff --git a/app/vendor/cakephp/bake/docs/fr/conf.py b/app/vendor/cakephp/bake/docs/fr/conf.py deleted file mode 100644 index b02032efa..000000000 --- a/app/vendor/cakephp/bake/docs/fr/conf.py +++ /dev/null @@ -1,9 +0,0 @@ -import sys, os - -# Append the top level directory of the docs, so we can import from the config dir. -sys.path.insert(0, os.path.abspath('..')) - -# Pull in all the configuration options defined in the global config file.. -from config.all import * - -language = 'fr' diff --git a/app/vendor/cakephp/bake/docs/fr/contents.rst b/app/vendor/cakephp/bake/docs/fr/contents.rst deleted file mode 100644 index 08c3e957c..000000000 --- a/app/vendor/cakephp/bake/docs/fr/contents.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :maxdepth: 2 - :caption: CakePHP Bake - - /index - /usage - /development diff --git a/app/vendor/cakephp/bake/docs/fr/development.md b/app/vendor/cakephp/bake/docs/fr/development.md new file mode 100644 index 000000000..8d08ce39d --- /dev/null +++ b/app/vendor/cakephp/bake/docs/fr/development.md @@ -0,0 +1,297 @@ +# Étendre Bake + +Bake dispose d'une architecture extensible qui permet à votre application ou à vos plugins de modifier ou d'ajouter des fonctionnalités de base. +Bake utilise une classe de vue dédiée fondée sur le moteur de template [Twig](https://twig.symfony.com/). + +## Events de Bake + +Comme une classe de vue, `BakeView` envoie les mêmes events que toute autre classe de vue, ainsi qu'un event `initialize` supplémentaire. +Alors que les classes de vue standard utilisent le préfixe `View.`, `BakeView` utilise le préfixe `Bake.`. + +L'event `initialize` peut être utilisé pour faire des changements qui s'appliquent à toutes les sorties générées par Bake. +Par exemple, pour ajouter un helper : + +```php +on('Bake.initialize', function (EventInterface $event) { + $view = $event->getSubject(); + + // Dans mes templates de bake, permet l'utilisation du helper MySpecial + $view->loadHelper('MySpecial', ['some' => 'config']); + + // Et ajoute une variable $author pour qu'elle soit toujours disponible + $view->set('author', 'Andy'); +}); +``` + +Les events de Bake peuvent aussi servir à faire de petits changements dans les templates existants. +Par exemple, pour changer les noms de variables utilisés lors de la création de fichiers de controller et de template : + +```php +on('Bake.beforeRender', function (EventInterface $event) { + $view = $event->getSubject(); + + // Utilise $rows pour la principale variable de données dans les index + if ($view->get('pluralName')) { + $view->set('pluralName', 'rows'); + } + if ($view->get('pluralVar')) { + $view->set('pluralVar', 'rows'); + } + + // Utilise $theOne pour la principale variable de données dans les view/edit + if ($view->get('singularName')) { + $view->set('singularName', 'theOne'); + } + if ($view->get('singularVar')) { + $view->set('singularVar', 'theOne'); + } +}); +``` + +Vous pouvez aussi scoper les events `Bake.beforeRender` et `Bake.afterRender` à un fichier généré spécifique. +Par exemple, pour ajouter des actions à `UsersController` lors de la génération depuis `Controller/controller.twig` : + +```php +on( + 'Bake.beforeRender.Controller.controller', + function (EventInterface $event) { + $view = $event->getSubject(); + if ($view->get('name') === 'Users') { + // ajouter les actions login et logout au controller Users + $view->set('actions', [ + 'login', + 'logout', + 'index', + 'view', + 'add', + 'edit', + 'delete', + ]); + } + } +); +``` + +En scopant les écouteurs d'event vers des templates de Bake spécifiques, vous simplifiez la logique liée à Bake et obtenez des callbacks plus faciles à tester. + +## Syntaxe de template de Bake + +Les fichiers de template de Bake utilisent la syntaxe [Twig](https://twig.symfony.com/). + +Par exemple, si vous générez une commande comme ceci : + +```bash +bin/cake bake command Foo +``` + +Le template utilisé dans `vendor/cakephp/bake/templates/bake/Command/command.twig` ressemble à ceci : + +```php +Test->classSuffixes[$this->name()])) { + $this->Test->classSuffixes[$this->name()] = 'Foo'; + } + + $name = ucfirst($this->name()); + if (!isset($this->Test->classTypes[$name])) { + $this->Test->classTypes[$name] = 'Foo'; + } + + return parent::bakeTest($className); +} +``` + +- Le **suffixe de classe** sera ajouté après le nom passé à `bake`. Dans l'exemple ci-dessus, cela créerait `ExempleFooTest.php`. +- Le **type de classe** sera le sous-namespace utilisé pour atteindre le fichier relatif à l'application ou au plugin. Dans l'exemple ci-dessus, cela créerait le namespace `App\Test\TestCase\Foo`. diff --git a/app/vendor/cakephp/bake/docs/fr/development.rst b/app/vendor/cakephp/bake/docs/fr/development.rst deleted file mode 100644 index 697a6301d..000000000 --- a/app/vendor/cakephp/bake/docs/fr/development.rst +++ /dev/null @@ -1,347 +0,0 @@ -Etendre Bake -############ - -Bake dispose d'une architecture extensible qui permet à votre application ou -à vos plugins de modifier ou ajouter la fonctionnalité de base. Bake utilise une -classe de vue dédiée qui utilise le moteur de template -`Twig `_. - -Events de Bake -============== - -Comme une classe de vue, ``BakeView`` envoie les mêmes events que toute autre -classe de vue, ainsi qu'un event initialize supplémentaire. Cependant, -alors que les classes de vue standard utilisent le préfixe d'event -"View.", ``BakeView`` utilise le préfixe d'event "Bake.". - -L'event initialize peut être utilisé pour faire des changements qui -s'appliquent à toutes les sorties fabriquées avec bake, par exemple pour ajouter -un autre helper à la classe de vue bake, cet event peut être utilisé:: - - on('Bake.initialize', function (EventInterface $event) { - $view = $event->getSubject(); - - // Dans mes templates de bake, permet l'utilisation du helper MySpecial - $view->loadHelper('MySpecial', ['some' => 'config']); - - // Et ajoute une variable $author pour qu'elle soit toujours disponible - $view->set('author', 'Andy'); - - }); - -Les events de bake peuvent être pratiques pour faire de petits changements dans -les templates existants. Par exemple, pour changer les noms de variables -utilisés lors de la création avec bake de fichiers de controller/template, on -pourra utiliser une fonction qui écoute ``Bake.beforeRender`` pour modifier les -variables utilisées dans les templates de bake:: - - on('Bake.beforeRender', function (EventInterface $event) { - $view = $event->getSubject(); - - // Utilise $rows pour la principale variable de données dans les index - if ($view->get('pluralName')) { - $view->set('pluralName', 'rows'); - } - if ($view->get('pluralVar')) { - $view->set('pluralVar', 'rows'); - } - - // Utilise $theOne pour la principale variable de données dans les view/edit - if ($view->get('singularName')) { - $view->set('singularName', 'theOne'); - } - if ($view->get('singularVar')) { - $view->set('singularVar', 'theOne'); - } - - }); - -Vous pouvez aussi scoper les events ``Bake.beforeRender`` et -``Bake.afterRender`` dans un fichier généré spécifique. Par exemple, si vous -souhaitez ajouter des actions spécifiques à votre UsersController quand vous le -générez à partir d'un fichier **Controller/controller.twig**, vous pouvez -utiliser l'event suivant:: - - on( - 'Bake.beforeRender.Controller.controller', - function (EventInterface $event) { - $view = $event->getSubject(); - if ($view->get('name') === 'Users') { - // ajouter les actions login et logout au controller Users - $view->set('actions', [ - 'login', - 'logout', - 'index', - 'view', - 'add', - 'edit', - 'delete' - ]; - } - } - ); - -En scopant les écouteurs d'event vers des templates de bake spécifiques, vous -pouvez simplifier votre logique d'event liée à bake et fournir des callbacks -qui sont plus faciles à tester. - -Syntaxe de Template de Bake -=========================== - -Les fichiers de template de Bake utilisent la syntaxe de template de -`Twig `__. - -Ainsi, par exemple, pour créer avec bake un shell comme ceci: - -.. code-block:: bash - - bin/cake bake command Foo - -Le template utilisé -(***vendor/cakephp/bake/templates/bake/Command/command.twig**) -ressemble à ceci:: - - declare(strict_types=1); - - namespace {{ namespace }}\Command; - - use Cake\Command\Command; - use Cake\Console\Arguments; - use Cake\Console\ConsoleIo; - use Cake\Console\ConsoleOptionParser; - - /** - * {{ name }} command. - */ - class {{ name }}Command extends Command - { - /** - * Méthode hook pour définir le parseur d'option de cette commande. - * - * @see https://book.cakephp.org/5/fr/console-commands/commands.html#defining-arguments-and-options - * @param \Cake\Console\ConsoleOptionParser $parser Le parseur à définir - * @return \Cake\Console\ConsoleOptionParser Le parseur construit. - */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser - { - $parser = parent::buildOptionParser($parser); - - return $parser; - } - - /** - * Implémentez cette méthode avec la logique de votre commande. - * - * @param \Cake\Console\Arguments $args Les arguments de la commande. - * @param \Cake\Console\ConsoleIo $io La console il - * @return int|null|void Le code de sortie ou null pour un succès - */ - public function execute(Arguments $args, ConsoleIo $io) - { - } - } - -Et la classe résultante construite avec bake (**src/Command/FooCommand.php**) -ressemble à ceci:: - - Test->classSuffixes[$this->name()])) { - $this->Test->classSuffixes[$this->name()] = 'Foo'; - } - - $name = ucfirst($this->name()); - if (!isset($this->Test->classTypes[$name])) { - $this->Test->classTypes[$name] = 'Foo'; - } - - return parent::bakeTest($className); - } - -* Le **suffixe de classe** sera ajouté après le nom passé à ``bake``. Dans le - cadre de l'exemple ci-dessus, cela créerait un fichier ``ExempleFooTest.php``. -* Le **type de classe** sera le sous-namespace utilisé pour atteindre votre - fichier (relatif à l'application ou au plugin dans lequel vous faites le - ``bake``). Dans le cadre de l'exemple ci-dessus, cela créerait le test avec le - namespace ``App\Test\TestCase\Foo``. - -.. meta:: - :title lang=fr: Etendre Bake - :keywords lang=fr: interface ligne de commande,development,bake view, bake template syntax,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/fr/index.md b/app/vendor/cakephp/bake/docs/fr/index.md new file mode 100644 index 000000000..07930646f --- /dev/null +++ b/app/vendor/cakephp/bake/docs/fr/index.md @@ -0,0 +1,25 @@ +# Console Bake + +La console Bake de CakePHP permet de lancer rapidement une application CakePHP. +Elle peut créer les éléments de base de CakePHP, comme les models, behaviors, views, +helpers, controllers, components, cas de tests, fixtures et plugins. +Bake peut aller bien au-delà des classes squelettes et constitue une étape naturelle après un premier prototypage. + +## Installation + +Avant d'utiliser ou d'étendre Bake, assurez-vous qu'il est installé dans votre application. +Bake est disponible sous forme de plugin que vous pouvez installer avec Composer : + +```bash +composer require --dev cakephp/bake:"^2.0" +``` + +Cela installe Bake comme dépendance de développement, et il ne sera donc pas déployé en production. + +Quand vous utilisez les templates Twig, vérifiez que vous chargez le plugin `Cake/TwigView` avec son bootstrap. +Vous pouvez aussi l'omettre complètement, ce qui fera charger ce plugin à la demande par Bake. + +## Plan de la documentation + +- [Génération de code avec Bake](/fr/usage) couvre l'exécution du CLI, les commandes disponibles et les thèmes Bake. +- [Étendre Bake](/fr/development) couvre les events, les templates Twig, les thèmes et les commandes Bake personnalisées. diff --git a/app/vendor/cakephp/bake/docs/fr/index.rst b/app/vendor/cakephp/bake/docs/fr/index.rst deleted file mode 100644 index 80e39229b..000000000 --- a/app/vendor/cakephp/bake/docs/fr/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -Console Bake -############ - -La console Bake de CakePHP est un autre outil permettant de réaliser son -application rapidement. La console Bake peut créer chacun des ingrédients -basiques de CakePHP : models, behaviors, views, helpers, controllers, -components, cas de tests, fixtures et plugins. Et nous ne parlons pas -seulement des squelettes de classes : Bake peut créer une application -fonctionnelle complète en seulement quelques minutes. En réalité, Bake est une -étape naturelle à suivre une fois qu'une application a été prototypée. - -Installation -============ - -Avant d'essayer d'utiliser ou d'étendre bake, assurez-vous qu'il est installé -dans votre application. Bake est disponible en tant que plugin que vous pouvez -installer avec Composer:: - - composer require --dev cakephp/bake:"^2.0" - -Ceci va installer bake en tant que dépendance de développement. Cela signifie -qu'il ne sera pas installé lors d'un déploiement en production. - -Quand vous utilisez les templates Twig, vérifiez que vous chargez le plugin -``Cake/TwigView`` avec son bootstrap. Vous pouvez aussi l'omettre complètement, -ce qui fait que Bake chargera ce plugin à la demande. - -.. meta:: - :title lang=fr: Console Bake - :keywords lang=fr: interface ligne de commande,development,bake view, bake template syntaxe,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/fr/usage.md b/app/vendor/cakephp/bake/docs/fr/usage.md new file mode 100644 index 000000000..3515cd8bf --- /dev/null +++ b/app/vendor/cakephp/bake/docs/fr/usage.md @@ -0,0 +1,53 @@ +# Génération de code avec Bake + +La console Bake est exécutée avec le CLI PHP. +Si vous avez des problèmes en exécutant ce script, vérifiez que : + +1. Le CLI PHP est installé et qu'il a les bons modules activés, par exemple MySQL et `intl`. +2. Si l'hôte de la base de données est `localhost`, essayez `127.0.0.1`, car `localhost` peut causer des problèmes avec PHP CLI. +3. Selon la configuration de votre ordinateur, vous devrez peut-être donner les permissions d'exécution au script `cake` pour autoriser le lancement via `bin/cake bake`. + +Avant de lancer Bake, vous devez vous assurer qu'au moins une connexion de base de données est configurée. + +Vous pouvez voir la liste des commandes disponibles en lançant `bin/cake bake --help`. +Pour Windows, utilisez `bin\cake bake --help` : + +```bash +$ bin/cake bake --help +Current Paths: + +* app: src/ +* root: /path/to/your/app/ +* core: /path/to/your/app/vendor/cakephp/cakephp/ + +Available Commands: + +Bake: +- bake all +- bake behavior +- bake cell +- bake command +- bake component +- bake controller +- bake controller all +- bake fixture +- bake fixture all +- bake form +- bake helper +- bake mailer +- bake middleware +- bake model +- bake model all +- bake plugin +- bake template +- bake template all +- bake test + +To run a command, type `cake command_name [args|options]` +To get help on a specific command, type `cake command_name --help` +``` + +## Thèmes de Bake + +L'option `theme` est commune à toutes les commandes Bake et permet de changer les fichiers de template utilisés lors de la génération. +Pour créer vos propres templates, référez-vous à [Créer un thème de Bake](/fr/development#creer-un-theme-de-bake). diff --git a/app/vendor/cakephp/bake/docs/fr/usage.rst b/app/vendor/cakephp/bake/docs/fr/usage.rst deleted file mode 100644 index 2a6e3d482..000000000 --- a/app/vendor/cakephp/bake/docs/fr/usage.rst +++ /dev/null @@ -1,65 +0,0 @@ -Génération de Code avec Bake -############################ - -La console Bake est exécutée en utilisant le CLI PHP -(Interface de Ligne de Commande). Si vous avez des problèmes en exécutant ce -script, vérifiez que : - -#. le CLI PHP est installé et qu'il a les bons modules activés (ex: MySQL, intl). -#. Certains utilisateurs peuvent aussi rencontrer des problèmes si l'hôte de la - base de données est 'localhost' et devront essayer '127.0.0.1' à la place, - car localhost peut causer des problèmes avec PHP CLI. -#. Selon la configuration de votre ordinateur, vous devrez peut-être donner les - permissions d'exécution sur le script bash cake pour autoriser le lancement - par ``bin/cake bake``. - -Avant de lancer bake, vous devrez vous assurer que vous avez au moins une -connexion de base de données configurée. - -Vous pouvez voir la liste des commandes bake disponibles en lançant -``bin/cake bake --help`` (pour Windows ``bin\cake bake --help``) :: - - $ bin/cake bake --help - Current Paths: - - * app: src/ - * root: /path/to/your/app/ - * core: /path/to/your/app/vendor/cakephp/cakephp/ - - Available Commands: - - Bake: - - bake all - - bake behavior - - bake cell - - bake command - - bake component - - bake controller - - bake controller all - - bake fixture - - bake fixture all - - bake form - - bake helper - - bake mailer - - bake middleware - - bake model - - bake model all - - bake plugin - - bake template - - bake template all - - bake test - - To run a command, type `cake command_name [args|options]` - To get help on a specific command, type `cake command_name --help` - -Thèmes de Bake -============== - -L'option theme est commune à toutes les commandes de bake, et permet de changer -les fichiers de template utilisés lors de la création avec bake. Pour créer vos -propres templates, référez-vous :ref:`à la documentation sur la création de -theme bake `. - -.. meta:: - :title lang=fr: Génération de Code avec Bake - :keywords lang=fr: interface ligne de commande,application fonctionnelle,base de données,configuration base de données,bash script,ingredients basiques,project,model,path path,génération de code,scaffolding,windows users,configuration file,few minutes,config,view,models,running,mysql diff --git a/app/vendor/cakephp/bake/docs/ja/conf.py b/app/vendor/cakephp/bake/docs/ja/conf.py deleted file mode 100644 index 5871da648..000000000 --- a/app/vendor/cakephp/bake/docs/ja/conf.py +++ /dev/null @@ -1,9 +0,0 @@ -import sys, os - -# Append the top level directory of the docs, so we can import from the config dir. -sys.path.insert(0, os.path.abspath('..')) - -# Pull in all the configuration options defined in the global config file.. -from config.all import * - -language = 'ja' diff --git a/app/vendor/cakephp/bake/docs/ja/contents.rst b/app/vendor/cakephp/bake/docs/ja/contents.rst deleted file mode 100644 index 08c3e957c..000000000 --- a/app/vendor/cakephp/bake/docs/ja/contents.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :maxdepth: 2 - :caption: CakePHP Bake - - /index - /usage - /development diff --git a/app/vendor/cakephp/bake/docs/ja/development.md b/app/vendor/cakephp/bake/docs/ja/development.md new file mode 100644 index 000000000..867c3d313 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/ja/development.md @@ -0,0 +1,315 @@ +# Bake の拡張 + +Bake は、アプリケーションやプラグインが基本機能を変更または追加できる拡張可能なアーキテクチャーを備えています。 +Bake は [Twig](https://twig.symfony.com/) テンプレートエンジンを使う専用のビュークラスを利用します。 + +## Bake イベント + +`BakeView` は、他のビュークラスと同様のイベントに加え、特別な initialize イベントを発します。 +標準ビュークラスはイベントプレフィックス `View.` を使いますが、`BakeView` は `Bake.` を使います。 + +initialize イベントは、すべての Bake 出力に対する変更に使用できます。 +たとえば、Bake ビュークラスに別のヘルパーを追加するには次のようにします。 + +```php +on('Bake.initialize', function (EventInterface $event) { + $view = $event->getSubject(); + + // bake テンプレートの中で MySpecial ヘルパーの使用を可能にします + $view->loadHelper('MySpecial', ['some' => 'config']); + + // そして、$author 変数を利用可能にするために追加 + $view->set('author', 'Andy'); +}); +``` + +別のプラグインの中から Bake を変更したい場合は、プラグインの `config/bootstrap.php` に Bake イベントを置くのが有効です。 + +Bake イベントは、既存テンプレートへの小さな変更にも役立ちます。 +たとえば、コントローラーやテンプレートファイルを Bake するときに使う変数名を変更するには `Bake.beforeRender` を利用します。 + +```php +on('Bake.beforeRender', function (EventInterface $event) { + $view = $event->getSubject(); + + // indexes の中のメインデータ変数に $rows を使用 + if ($view->get('pluralName')) { + $view->set('pluralName', 'rows'); + } + if ($view->get('pluralVar')) { + $view->set('pluralVar', 'rows'); + } + + // view と edit の中のメインデータ変数に $theOne を使用 + if ($view->get('singularName')) { + $view->set('singularName', 'theOne'); + } + if ($view->get('singularVar')) { + $view->set('singularVar', 'theOne'); + } +}); +``` + +`Bake.beforeRender` と `Bake.afterRender` を特定の生成ファイルに限定することもできます。 +たとえば `Controller/controller.twig` から生成する際に `UsersController` に特定アクションを追加したい場合は次のイベントを使用できます。 + +```php +on( + 'Bake.beforeRender.Controller.controller', + function (EventInterface $event) { + $view = $event->getSubject(); + if ($view->get('name') === 'Users') { + // Users コントローラーに login と logout を追加 + $view->set('actions', [ + 'login', + 'logout', + 'index', + 'view', + 'add', + 'edit', + 'delete', + ]); + } + } +); +``` + +特定の Bake テンプレートにイベントリスナーを絞ることで、Bake 関連のイベントロジックを単純にし、テストしやすいコールバックを提供できます。 + +## Bake テンプレート構文 + +Bake テンプレートファイルは [Twig](https://twig.symfony.com/doc/2.x/) 構文を使用します。 + +たとえば、次のようにコマンドを Bake した場合: + +```bash +bin/cake bake command Foo +``` + +`vendor/cakephp/bake/templates/bake/Command/command.twig` のテンプレートは次のようになります。 + +```php +Test->classSuffixes[$this->name()])) { + $this->Test->classSuffixes[$this->name()] = 'Foo'; + } + + $name = ucfirst($this->name()); + if (!isset($this->Test->classTypes[$name])) { + $this->Test->classTypes[$name] = 'Foo'; + } + + return parent::bakeTest($className); +} +``` + +- **class suffix** は `bake` 呼び出しで与えた名前に追加されます。前の例では `ExampleFooTest.php` を作成します。 +- **class type** はファイルに到達するためのサブ名前空間です。前の例では `App\Test\TestCase\Foo` という名前空間でテストを作成します。 + +## BakeView クラスの設定 + +Bake コマンドは、テンプレートをレンダリングするために `BakeView` クラスを使います。 +`Bake.initialize` イベントを監視するとインスタンスにアクセスできます。 + +```php +on( + 'Bake.initialize', + function ($event, $view) { + $view->loadHelper('Foo'); + } +); +``` diff --git a/app/vendor/cakephp/bake/docs/ja/development.rst b/app/vendor/cakephp/bake/docs/ja/development.rst deleted file mode 100644 index 070e43a5c..000000000 --- a/app/vendor/cakephp/bake/docs/ja/development.rst +++ /dev/null @@ -1,296 +0,0 @@ -Bake の拡張 -########### - -Bake は、アプリケーションやプラグインが基本機能に対して変更または追加を可能にする -拡張可能なアーキテクチャーを備えています。Bake は、 `Twig `_ -テンプレートエンジンを使用したビュークラスを利用します。 - -Bake イベント -============= - -``BakeView`` は、ビュークラスとして、他のビュークラスと同様のイベントに加え、 -1つの特別な初期化 (initialize) イベントを発します。しかし、一方で標準ビュークラスは、 -イベントのプレフィックス "View." を使用しますが、 ``BakeView`` は、 -イベントのプレフィックス "Bake." を使用しています。 - -初期化イベントは、すべての bake の出力に対して変更を加えるために使用できます。 -例えば、bake ビュークラスに他のヘルパーを追加するためにこのイベントは使用されます。 :: - - on('Bake.initialize', function (Event $event) { - $view = $event->getSubject(); - - // bake テンプレートの中で MySpecial ヘルパーの使用を可能にします - $view->loadHelper('MySpecial', ['some' => 'config']); - - // そして、$author 変数を利用可能にするために追加 - $view->set('author', 'Andy'); - - }); - -別のプラグインの中から bake を変更したい場合は、プラグインの ``config/bootstrap.php`` -ファイルでプラグインの Bake イベントを置くことは良いアイデアです。 - -Bake イベントは、既存のテンプレートに小さな変更を行うための便利なことができます。 -例えば、コントローラーやテンプレートファイルを bake する際に使用される変数名を -変更するために、bake テンプレートで使用される変数を変更するために -``Bake.beforeRender`` で呼び出される関数を使用することができます。 :: - - on('Bake.beforeRender', function (Event $event) { - $view = $event->getSubject(); - - // indexes の中のメインデータ変数に $rows を使用 - if ($view->get('pluralName')) { - $view->set('pluralName', 'rows'); - } - if ($view->get('pluralVar')) { - $view->set('pluralVar', 'rows'); - } - - // view と edit の中のメインデータ変数に $theOne を使用 - if ($view->get('singularName')) { - $view->set('singularName', 'theOne'); - } - if ($view->get('singularVar')) { - $view->set('singularVar', 'theOne'); - } - - }); - -特定の生成されたファイルへの ``Bake.beforeRender`` と ``Bake.afterRender`` -イベントを指定することもあるでしょう。例えば、 -**Controller/controller.twig** ファイルから生成する際、 UsersController -に特定のアクションを追加したい場合、以下のイベントを使用することができます。 :: - - on( - 'Bake.beforeRender.Controller.controller', - function (Event $event) { - $view = $event->getSubject(); - if ($view->viewVars['name'] == 'Users') { - // Users コントローラーに login と logout を追加 - $view->viewVars['actions'] = [ - 'login', - 'logout', - 'index', - 'view', - 'add', - 'edit', - 'delete' - ]; - } - } - ); - -特定の bake テンプレートのためのイベントリスナーを指定することによって、 -bake 関連のイベント・ロジックを簡素化し、テストするのが容易であるコールバックを -提供することができます。 - -Bake テンプレート構文 -===================== - -Bake テンプレートファイルは、 `Twig `__ -テンプレート構文を使用します。 - -だから、例えば、以下のようにシェルを bake した場合: - -.. code-block:: bash - - bin/cake bake shell Foo - -(**vendor/cakephp/bake/src/Template/Bake/Shell/shell.twig**) を使用した -テンプレートは、以下のようになります。 :: - - `` Bake テンプレートの PHP 終了タグ - * ``<%=`` Bake テンプレートの PHP ショートエコータグ - * ``<%-`` Bake テンプレートの PHP 開始タグ、タグの前に、先頭の空白を除去 - * ``-%>`` Bake テンプレートの PHP 終了タグ、タグの後に末尾の空白を除去 - -.. _creating-a-bake-theme: - -Bake テーマの作成 -================= - -"bake" コマンドによって生成された出力を変更したい場合、bake が使用するテンプレートの -一部または全部を置き換えることができる、独自の bake の「テーマ」を作成することができます。 -これを行うための最善の方法は、次のとおりです。 - -#. 新しいプラグインを bake します。プラグインの名前は bake の「テーマ」名になります。 -#. 新しいディレクトリー **plugins/[name]/src/Template/Bake/Template/** を作成します。 -#. **vendor/cakephp/bake/src/Template/Bake/Template** から上書きしたい - テンプレートをあなたのプラグインの中の適切なファイルにコピーしてください。 -#. bake を実行するときに、必要であれば、 bake のテーマを指定するための ``--theme`` - オプションを使用してください。各呼び出しでこのオプションを指定しなくても済むように、 - カスタムテーマをデフォルトテーマとして使用するように設定することもできます。 :: - - Test->classSuffixes[$this->name()])) { - $this->Test->classSuffixes[$this->name()] = 'Foo'; - } - - $name = ucfirst($this->name()); - if (!isset($this->Test->classTypes[$name])) { - $this->Test->classTypes[$name] = 'Foo'; - } - - return parent::bakeTest($className); - } - -* **class suffix** は ``bake`` 呼び出しで与えられた名前に追加します。前の例では、 - ``ExampleFooTest.php`` ファイルを作成します。 -* **class type** は、（あなたが bake するアプリやプラグインに関連する） - あなたのファイルを導くために使用されるサブ名前空間です。 - 前の例では、名前空間 ``App\Test\TestCase\Foo`` でテストを作成します。 - -.. meta:: - :title lang=ja: Bake の拡張 - :keywords lang=ja: command line interface,development,bake view, bake template syntax,twig,erb tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/ja/index.md b/app/vendor/cakephp/bake/docs/ja/index.md new file mode 100644 index 000000000..bad397c78 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/ja/index.md @@ -0,0 +1,26 @@ +# Bake コンソール + +CakePHP の Bake コンソールは、CakePHP を素早く使い始めるためのツールです。 +Bake コンソールは、モデル、ビヘイビアー、ビュー、ヘルパー、コントローラー、コンポーネント、 +テストケース、フィクスチャー、プラグインなど、CakePHP の基本的な素材を作成できます。 +単なるスケルトンクラスだけではなく、数分で完全に機能するアプリケーションを作成できます。 + +## インストール手順 + +Bake を使用したり拡張する前に、アプリケーションに Bake をインストールしてください。 +Bake は Composer を使ってインストールするプラグインとして提供されています。 + +```bash +composer require --dev cakephp/bake:"^3.0" +``` + +このコマンドは、Bake を開発用依存パッケージとしてインストールします。 +そのため、本番環境へのデプロイ時にはインストールされません。 + +Twig テンプレートを使用する場合、`Cake/TwigView` プラグインをブートストラップとともに読み込んでいることを確認してください。 +完全に省略し、Bake プラグインに必要時だけ読み込ませることもできます。 + +## ドキュメント一覧 + +- [Bake でコード生成](/ja/usage) では CLI の実行、利用可能なコマンド、モデル生成、テーマについて説明します。 +- [Bake の拡張](/ja/development) ではイベント、Twig テンプレート、テーマ、カスタム Bake コマンドについて説明します。 diff --git a/app/vendor/cakephp/bake/docs/ja/index.rst b/app/vendor/cakephp/bake/docs/ja/index.rst deleted file mode 100644 index a4e503963..000000000 --- a/app/vendor/cakephp/bake/docs/ja/index.rst +++ /dev/null @@ -1,28 +0,0 @@ -Bake コンソール -################ - -CakePHP の bake コンソールは、迅速に CakePHP を動作させるまでを支援します。 -bake コンソールは、CakePHP の基本的な素材(モデル、ビヘイビアー、ビュー、ヘルパー、 -コントローラー、コンポーネント、テストケース、フィクスチャー、プラグイン)を作成できます。 -その為のスケルトンクラスについては、ここでは省略しますが、 -bake は数分で完全に機能するアプリケーションを作成できます。 -要するに、bake は足場の組まれたアプリケーションをいっぺんに手に入れるためにうってつけの方法です。 - -インストール手順 -================= - -bake を使用したり拡張する前に、アプリケーションに bake をインストールしておいてください。 -bake は Composer を使ってインストールするプラグインとして提供されています。 :: - - composer require --dev cakephp/bake:"^2.0" - -上記のコマンドは、bake を開発環境で使用するパッケージとしてインストールします。 -この入れ方の場合、本番環境としてデプロイする際には、 bake はインストールされません。 - -Twig テンプレートを使用する場合、 ``Cake/TwigView`` プラグインをブートストラップとともに -読み込んでいることを確認してください。それを完全に省略して、 -Bake プラグインにこのプラグインを読み込ませることもできます。 - -.. meta:: - :title lang=ja: Bakeコンソール - :keywords lang=ja: コマンドライン,CLI,development,bake view, bake template syntax,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/ja/usage.md b/app/vendor/cakephp/bake/docs/ja/usage.md new file mode 100644 index 000000000..09f3ec27d --- /dev/null +++ b/app/vendor/cakephp/bake/docs/ja/usage.md @@ -0,0 +1,68 @@ +# Bake でコード生成 + +Bake コンソールは PHP CLI で実行します。 +スクリプトの実行に問題がある場合は、次を確認してください。 + +1. PHP CLI がインストールされていて、必要なモジュールが有効になっていること。例: MySQL、`intl`。 +2. データベースホストが `localhost` の場合は、代わりに `127.0.0.1` を試すこと。PHP CLI で問題になることがあります。 +3. コンピューターの設定によっては、`bin/cake bake` で使用する Cake スクリプトに実行権限を付ける必要があること。 + +Bake を実行する前に、少なくとも 1 つのデータベース接続が設定されていることを確認してください。 + +`bin/cake bake --help` を実行すると、利用可能な Bake コマンドを表示できます。 +Windows では `bin\cake bake --help` を使用します。 + +```bash +$ bin/cake bake --help +Current Paths: + +* app: src/ +* root: /path/to/your/app/ +* core: /path/to/your/app/vendor/cakephp/cakephp/ + +Available Commands: + +Bake: +- bake all +- bake behavior +- bake cell +- bake command +- bake command_helper +- bake component +- bake controller +- bake controller all +- bake enum +- bake fixture +- bake fixture all +- bake form +- bake helper +- bake mailer +- bake middleware +- bake model +- bake model all +- bake plugin +- bake template +- bake template all +- bake test + +To run a command, type `cake command_name [args|options]` +To get help on a specific command, type `cake command_name --help` +``` + +## Bake モデル + +モデルは既存のデータベーステーブルから生成されます。 +規約が適用されるため、外部キー `thing_id` とテーブル `things` の主キー `id` に基づいてリレーションが検出されます。 + +規約から外れたリレーションの場合は、制約や外部キー定義の参照を使って Bake にリレーションを検出させることができます。 + +```php +->addForeignKey('billing_country_id', 'countries') // defaults to `id` +->addForeignKey('shipping_country_id', 'countries', 'cid') +``` + +## Bake テーマ + +テーマオプションはすべての Bake コマンドで共通です。 +Bake 時に使用するテンプレートファイルを変更できます。 +テーマを作るには、[Bake テーマの作成](/ja/development#bake-テーマの作成) を参照してください。 diff --git a/app/vendor/cakephp/bake/docs/ja/usage.rst b/app/vendor/cakephp/bake/docs/ja/usage.rst deleted file mode 100644 index 9912102ef..000000000 --- a/app/vendor/cakephp/bake/docs/ja/usage.rst +++ /dev/null @@ -1,100 +0,0 @@ -Bake でコード生成 -################## - -cake コンソールは、 PHP CLI (command line interface) で実行します。 -もしスクリプトの実行に問題があるなら、以下を満たしてください。 - -#. PHP CLI がインストールされているか適切なモジュールが有効か確認してください (例：MySQL, intl)。 -#. データベースのホストが 'localhost' で問題があるなら、代わりに '127.0.0.1' を使って下さい。 - PHP CLI でこの問題がおこる可能性があります。 -#. 使っているコンピューターの設定に応じて、 ``bin/cake bake`` で使用する cake bash スクリプトの - 実行権限を設定する必要があります。 - -bake を実行する前にデータベースとの接続を確認しましょう。 - -``bin/cake bake`` を引数無しで実行すると可能なタスクを表示できます。 - -Windows システムの場合、 ``bin\cake bake`` を試してみてください。 - -それは以下のように表示されます。 :: - - $ bin/cake bake - - Welcome to CakePHP v3.1.6 Console - --------------------------------------------------------------- - App : src - Path: /var/www/cakephp.dev/src/ - PHP: 5.5.8 - --------------------------------------------------------------- - The following commands can be used to generate skeleton code for your application. - - Available bake commands: - - - all - - behavior - - cell - - component - - controller - - fixture - - form - - helper - - mailer - - migration - - migration_snapshot - - model - - plugin - - template - - test - - By using `cake bake [name]` you can invoke a specific bake task. - -より詳しい各コマンドの情報を得るには、 ``--help`` オプションをつけ実行してください。 :: - - $ bin/cake bake controller --help - - Welcome to CakePHP v3.1.6 Console - --------------------------------------------------------------- - App : src - Path: /var/www/cakephp.dev/src/ - --------------------------------------------------------------- - Bake a controller skeleton. - - Usage: - cake bake controller [subcommand] [options] [] - - Subcommands: - - all Bake all controllers with CRUD methods. - - To see help on a subcommand use `cake bake controller [subcommand] --help` - - Options: - - --help, -h Display this help. - --verbose, -v Enable verbose output. - --quiet, -q Enable quiet output. - --plugin, -p Plugin to bake into. - --force, -f Force overwriting existing files without prompting. - --connection, -c The datasource connection to get data from. - (default: default) - --theme, -t The theme to use when baking code. - --components The comma separated list of components to use. - --helpers The comma separated list of helpers to use. - --prefix The namespace/routing prefix to use. - --no-test Do not generate a test skeleton. - --no-actions Do not generate basic CRUD action methods. - - Arguments: - - name Name of the controller to bake. Can use Plugin.name to bake - controllers into plugins. (optional) - -Bake テーマオプション -===================== - -テーマオプションは全 bake コマンドで一般的です。また、bake テンプレートファイルを変更することができます。 -テーマを作るには、 :ref:`Bake テーマ作成ドキュメント ` をご覧ください。 - -.. meta:: - :title lang=ja: Code Generation with Bake - :keywords lang=ja: command line interface,functional application,database,database configuration,bash script,basic ingredients,project,model,path path,code generation,scaffolding,windows users,configuration file,few minutes,config,view,models,running,mysql diff --git a/app/vendor/cakephp/bake/docs/package-lock.json b/app/vendor/cakephp/bake/docs/package-lock.json new file mode 100644 index 000000000..8236c3b3d --- /dev/null +++ b/app/vendor/cakephp/bake/docs/package-lock.json @@ -0,0 +1,2099 @@ +{ + "name": "docs", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "docs", + "version": "1.0.0", + "license": "ISC", + "dependencies": { + "@cakephp/docs-skeleton": "https://github.com/cakephp/docs-skeleton.git#node-package", + "vitepress": "^2.0.0-alpha.16" + } + }, + "node_modules/@babel/helper-string-parser": { + "version": "7.27.1", + "resolved": "https://registry.npmjs.org/@babel/helper-string-parser/-/helper-string-parser-7.27.1.tgz", + "integrity": "sha512-qMlSxKbpRlAridDExk92nSobyDdpPijUq2DW6oDnUqd0iOGxmQjyqhMIihI9+zv4LPyZdRje2cavWPbCbWm3eA==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/helper-validator-identifier": { + "version": "7.28.5", + "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.28.5.tgz", + "integrity": "sha512-qSs4ifwzKJSV39ucNjsvc6WVHs6b7S03sOh2OcHF9UHfVPqWWALUsNUVzhSBiItjRZoLHx7nIarVjqKVusUZ1Q==", + "license": "MIT", + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@babel/parser": { + "version": "7.29.2", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.29.2.tgz", + "integrity": "sha512-4GgRzy/+fsBa72/RZVJmGKPmZu9Byn8o4MoLpmNe1m8ZfYnz5emHLQz3U4gLud6Zwl0RZIcgiLD7Uq7ySFuDLA==", + "license": "MIT", + "dependencies": { + "@babel/types": "^7.29.0" + }, + "bin": { + "parser": "bin/babel-parser.js" + }, + "engines": { + "node": ">=6.0.0" + } + }, + "node_modules/@babel/types": { + "version": "7.29.0", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.29.0.tgz", + "integrity": "sha512-LwdZHpScM4Qz8Xw2iKSzS+cfglZzJGvofQICy7W7v4caru4EaAmyUuO6BGrbyQ2mYV11W0U8j5mBhd14dd3B0A==", + "license": "MIT", + "dependencies": { + "@babel/helper-string-parser": "^7.27.1", + "@babel/helper-validator-identifier": "^7.28.5" + }, + "engines": { + "node": ">=6.9.0" + } + }, + "node_modules/@cakephp/docs-skeleton": { + "version": "1.0.0", + "resolved": "git+ssh://git@github.com/cakephp/docs-skeleton.git#9501c6d47a80645604fceb31328368eeb6a21bc6", + "bin": { + "cakedocs": "bin/cakedocs.js" + }, + "peerDependencies": { + "vitepress": "^2.0.0-alpha.15" + } + }, + "node_modules/@docsearch/css": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/css/-/css-4.6.2.tgz", + "integrity": "sha512-fH/cn8BjEEdM2nJdjNMHIvOVYupG6AIDtFVDgIZrNzdCSj4KXr9kd+hsehqsNGYjpUjObeKYKvgy/IwCb1jZYQ==", + "license": "MIT" + }, + "node_modules/@docsearch/js": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/js/-/js-4.6.2.tgz", + "integrity": "sha512-qj1yoxl3y4GKoK7+VM6fq/rQqPnvUmg3IKzJ9x0VzN14QVzdB/SG/J6VfV1BWT5RcPUFxIcVwoY1fwHM2fSRRw==", + "license": "MIT" + }, + "node_modules/@docsearch/sidepanel-js": { + "version": "4.6.2", + "resolved": "https://registry.npmjs.org/@docsearch/sidepanel-js/-/sidepanel-js-4.6.2.tgz", + "integrity": "sha512-Pni85AP/GwRj7fFg8cBJp0U04tzbueBvWSd3gysgnOsVnQVSZwSYncfErUScLE1CAtR+qocPDFjmYR9AMRNJtQ==", + "license": "MIT" + }, + "node_modules/@esbuild/aix-ppc64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/aix-ppc64/-/aix-ppc64-0.27.7.tgz", + "integrity": "sha512-EKX3Qwmhz1eMdEJokhALr0YiD0lhQNwDqkPYyPhiSwKrh7/4KRjQc04sZ8db+5DVVnZ1LmbNDI1uAMPEUBnQPg==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "aix" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm/-/android-arm-0.27.7.tgz", + "integrity": "sha512-jbPXvB4Yj2yBV7HUfE2KHe4GJX51QplCN1pGbYjvsyCZbQmies29EoJbkEc+vYuU5o45AfQn37vZlyXy4YJ8RQ==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-arm64/-/android-arm64-0.27.7.tgz", + "integrity": "sha512-62dPZHpIXzvChfvfLJow3q5dDtiNMkwiRzPylSCfriLvZeq0a1bWChrGx/BbUbPwOrsWKMn8idSllklzBy+dgQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/android-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/android-x64/-/android-x64-0.27.7.tgz", + "integrity": "sha512-x5VpMODneVDb70PYV2VQOmIUUiBtY3D3mPBG8NxVk5CogneYhkR7MmM3yR/uMdITLrC1ml/NV1rj4bMJuy9MCg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-arm64/-/darwin-arm64-0.27.7.tgz", + "integrity": "sha512-5lckdqeuBPlKUwvoCXIgI2D9/ABmPq3Rdp7IfL70393YgaASt7tbju3Ac+ePVi3KDH6N2RqePfHnXkaDtY9fkw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/darwin-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/darwin-x64/-/darwin-x64-0.27.7.tgz", + "integrity": "sha512-rYnXrKcXuT7Z+WL5K980jVFdvVKhCHhUwid+dDYQpH+qu+TefcomiMAJpIiC2EM3Rjtq0sO3StMV/+3w3MyyqQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-arm64/-/freebsd-arm64-0.27.7.tgz", + "integrity": "sha512-B48PqeCsEgOtzME2GbNM2roU29AMTuOIN91dsMO30t+Ydis3z/3Ngoj5hhnsOSSwNzS+6JppqWsuhTp6E82l2w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/freebsd-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/freebsd-x64/-/freebsd-x64-0.27.7.tgz", + "integrity": "sha512-jOBDK5XEjA4m5IJK3bpAQF9/Lelu/Z9ZcdhTRLf4cajlB+8VEhFFRjWgfy3M1O4rO2GQ/b2dLwCUGpiF/eATNQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm/-/linux-arm-0.27.7.tgz", + "integrity": "sha512-RkT/YXYBTSULo3+af8Ib0ykH8u2MBh57o7q/DAs3lTJlyVQkgQvlrPTnjIzzRPQyavxtPtfg0EopvDyIt0j1rA==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-arm64/-/linux-arm64-0.27.7.tgz", + "integrity": "sha512-RZPHBoxXuNnPQO9rvjh5jdkRmVizktkT7TCDkDmQ0W2SwHInKCAV95GRuvdSvA7w4VMwfCjUiPwDi0ZO6Nfe9A==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ia32": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ia32/-/linux-ia32-0.27.7.tgz", + "integrity": "sha512-GA48aKNkyQDbd3KtkplYWT102C5sn/EZTY4XROkxONgruHPU72l+gW+FfF8tf2cFjeHaRbWpOYa/uRBz/Xq1Pg==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-loong64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-loong64/-/linux-loong64-0.27.7.tgz", + "integrity": "sha512-a4POruNM2oWsD4WKvBSEKGIiWQF8fZOAsycHOt6JBpZ+JN2n2JH9WAv56SOyu9X5IqAjqSIPTaJkqN8F7XOQ5Q==", + "cpu": [ + "loong64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-mips64el": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-mips64el/-/linux-mips64el-0.27.7.tgz", + "integrity": "sha512-KabT5I6StirGfIz0FMgl1I+R1H73Gp0ofL9A3nG3i/cYFJzKHhouBV5VWK1CSgKvVaG4q1RNpCTR2LuTVB3fIw==", + "cpu": [ + "mips64el" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-ppc64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-ppc64/-/linux-ppc64-0.27.7.tgz", + "integrity": "sha512-gRsL4x6wsGHGRqhtI+ifpN/vpOFTQtnbsupUF5R5YTAg+y/lKelYR1hXbnBdzDjGbMYjVJLJTd2OFmMewAgwlQ==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-riscv64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-riscv64/-/linux-riscv64-0.27.7.tgz", + "integrity": "sha512-hL25LbxO1QOngGzu2U5xeXtxXcW+/GvMN3ejANqXkxZ/opySAZMrc+9LY/WyjAan41unrR3YrmtTsUpwT66InQ==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-s390x": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-s390x/-/linux-s390x-0.27.7.tgz", + "integrity": "sha512-2k8go8Ycu1Kb46vEelhu1vqEP+UeRVj2zY1pSuPdgvbd5ykAw82Lrro28vXUrRmzEsUV0NzCf54yARIK8r0fdw==", + "cpu": [ + "s390x" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/linux-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/linux-x64/-/linux-x64-0.27.7.tgz", + "integrity": "sha512-hzznmADPt+OmsYzw1EE33ccA+HPdIqiCRq7cQeL1Jlq2gb1+OyWBkMCrYGBJ+sxVzve2ZJEVeePbLM2iEIZSxA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-arm64/-/netbsd-arm64-0.27.7.tgz", + "integrity": "sha512-b6pqtrQdigZBwZxAn1UpazEisvwaIDvdbMbmrly7cDTMFnw/+3lVxxCTGOrkPVnsYIosJJXAsILG9XcQS+Yu6w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/netbsd-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/netbsd-x64/-/netbsd-x64-0.27.7.tgz", + "integrity": "sha512-OfatkLojr6U+WN5EDYuoQhtM+1xco+/6FSzJJnuWiUw5eVcicbyK3dq5EeV/QHT1uy6GoDhGbFpprUiHUYggrw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "netbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-arm64/-/openbsd-arm64-0.27.7.tgz", + "integrity": "sha512-AFuojMQTxAz75Fo8idVcqoQWEHIXFRbOc1TrVcFSgCZtQfSdc1RXgB3tjOn/krRHENUB4j00bfGjyl2mJrU37A==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openbsd-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openbsd-x64/-/openbsd-x64-0.27.7.tgz", + "integrity": "sha512-+A1NJmfM8WNDv5CLVQYJ5PshuRm/4cI6WMZRg1by1GwPIQPCTs1GLEUHwiiQGT5zDdyLiRM/l1G0Pv54gvtKIg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/openharmony-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/openharmony-arm64/-/openharmony-arm64-0.27.7.tgz", + "integrity": "sha512-+KrvYb/C8zA9CU/g0sR6w2RBw7IGc5J2BPnc3dYc5VJxHCSF1yNMxTV5LQ7GuKteQXZtspjFbiuW5/dOj7H4Yw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/sunos-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/sunos-x64/-/sunos-x64-0.27.7.tgz", + "integrity": "sha512-ikktIhFBzQNt/QDyOL580ti9+5mL/YZeUPKU2ivGtGjdTYoqz6jObj6nOMfhASpS4GU4Q/Clh1QtxWAvcYKamA==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "sunos" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-arm64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-arm64/-/win32-arm64-0.27.7.tgz", + "integrity": "sha512-7yRhbHvPqSpRUV7Q20VuDwbjW5kIMwTHpptuUzV+AA46kiPze5Z7qgt6CLCK3pWFrHeNfDd1VKgyP4O+ng17CA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-ia32": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-ia32/-/win32-ia32-0.27.7.tgz", + "integrity": "sha512-SmwKXe6VHIyZYbBLJrhOoCJRB/Z1tckzmgTLfFYOfpMAx63BJEaL9ExI8x7v0oAO3Zh6D/Oi1gVxEYr5oUCFhw==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@esbuild/win32-x64": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/@esbuild/win32-x64/-/win32-x64-0.27.7.tgz", + "integrity": "sha512-56hiAJPhwQ1R4i+21FVF7V8kSD5zZTdHcVuRFMW0hn753vVfQN8xlx4uOPT4xoGH0Z/oVATuR82AiqSTDIpaHg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ], + "engines": { + "node": ">=18" + } + }, + "node_modules/@iconify-json/simple-icons": { + "version": "1.2.76", + "resolved": "https://registry.npmjs.org/@iconify-json/simple-icons/-/simple-icons-1.2.76.tgz", + "integrity": "sha512-lLRlA8yaf+1L5VCPRvR9lynoSklsddKHEylchmZJKdj/q2xVQ1ZAEJ8SCQlv9cbgtMefnlyM98U+8Si2aoFZPA==", + "license": "CC0-1.0", + "dependencies": { + "@iconify/types": "*" + } + }, + "node_modules/@iconify/types": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@iconify/types/-/types-2.0.0.tgz", + "integrity": "sha512-+wluvCrRhXrhyOmRDJ3q8mux9JkKy5SJ/v8ol2tu4FVjyYvtEzkc/3pK15ET6RKg4b4w4BmTk1+gsCUhf21Ykg==", + "license": "MIT" + }, + "node_modules/@jridgewell/sourcemap-codec": { + "version": "1.5.5", + "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.5.5.tgz", + "integrity": "sha512-cYQ9310grqxueWbl+WuIUIaiUaDcj7WOq5fVhEljNVgRfOUhY9fy2zTvfoqWsnebh8Sl70VScFbICvJnLKB0Og==", + "license": "MIT" + }, + "node_modules/@rolldown/pluginutils": { + "version": "1.0.0-rc.2", + "resolved": "https://registry.npmjs.org/@rolldown/pluginutils/-/pluginutils-1.0.0-rc.2.tgz", + "integrity": "sha512-izyXV/v+cHiRfozX62W9htOAvwMo4/bXKDrQ+vom1L1qRuexPock/7VZDAhnpHCLNejd3NJ6hiab+tO0D44Rgw==", + "license": "MIT" + }, + "node_modules/@rollup/rollup-android-arm-eabi": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm-eabi/-/rollup-android-arm-eabi-4.60.1.tgz", + "integrity": "sha512-d6FinEBLdIiK+1uACUttJKfgZREXrF0Qc2SmLII7W2AD8FfiZ9Wjd+rD/iRuf5s5dWrr1GgwXCvPqOuDquOowA==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-android-arm64": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-android-arm64/-/rollup-android-arm64-4.60.1.tgz", + "integrity": "sha512-YjG/EwIDvvYI1YvYbHvDz/BYHtkY4ygUIXHnTdLhG+hKIQFBiosfWiACWortsKPKU/+dUwQQCKQM3qrDe8c9BA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "android" + ] + }, + "node_modules/@rollup/rollup-darwin-arm64": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-arm64/-/rollup-darwin-arm64-4.60.1.tgz", + "integrity": "sha512-mjCpF7GmkRtSJwon+Rq1N8+pI+8l7w5g9Z3vWj4T7abguC4Czwi3Yu/pFaLvA3TTeMVjnu3ctigusqWUfjZzvw==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-darwin-x64": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-darwin-x64/-/rollup-darwin-x64-4.60.1.tgz", + "integrity": "sha512-haZ7hJ1JT4e9hqkoT9R/19XW2QKqjfJVv+i5AGg57S+nLk9lQnJ1F/eZloRO3o9Scy9CM3wQ9l+dkXtcBgN5Ew==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ] + }, + "node_modules/@rollup/rollup-freebsd-arm64": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-arm64/-/rollup-freebsd-arm64-4.60.1.tgz", + "integrity": "sha512-czw90wpQq3ZsAVBlinZjAYTKduOjTywlG7fEeWKUA7oCmpA8xdTkxZZlwNJKWqILlq0wehoZcJYfBvOyhPTQ6w==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-freebsd-x64": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-freebsd-x64/-/rollup-freebsd-x64-4.60.1.tgz", + "integrity": "sha512-KVB2rqsxTHuBtfOeySEyzEOB7ltlB/ux38iu2rBQzkjbwRVlkhAGIEDiiYnO2kFOkJp+Z7pUXKyrRRFuFUKt+g==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "freebsd" + ] + }, + "node_modules/@rollup/rollup-linux-arm-gnueabihf": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-gnueabihf/-/rollup-linux-arm-gnueabihf-4.60.1.tgz", + "integrity": "sha512-L+34Qqil+v5uC0zEubW7uByo78WOCIrBvci69E7sFASRl0X7b/MB6Cqd1lky/CtcSVTydWa2WZwFuWexjS5o6g==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm-musleabihf": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm-musleabihf/-/rollup-linux-arm-musleabihf-4.60.1.tgz", + "integrity": "sha512-n83O8rt4v34hgFzlkb1ycniJh7IR5RCIqt6mz1VRJD6pmhRi0CXdmfnLu9dIUS6buzh60IvACM842Ffb3xd6Gg==", + "cpu": [ + "arm" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-gnu": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-gnu/-/rollup-linux-arm64-gnu-4.60.1.tgz", + "integrity": "sha512-Nql7sTeAzhTAja3QXeAI48+/+GjBJ+QmAH13snn0AJSNL50JsDqotyudHyMbO2RbJkskbMbFJfIJKWA6R1LCJQ==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-arm64-musl": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-arm64-musl/-/rollup-linux-arm64-musl-4.60.1.tgz", + "integrity": "sha512-+pUymDhd0ys9GcKZPPWlFiZ67sTWV5UU6zOJat02M1+PiuSGDziyRuI/pPue3hoUwm2uGfxdL+trT6Z9rxnlMA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-gnu": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-gnu/-/rollup-linux-loong64-gnu-4.60.1.tgz", + "integrity": "sha512-VSvgvQeIcsEvY4bKDHEDWcpW4Yw7BtlKG1GUT4FzBUlEKQK0rWHYBqQt6Fm2taXS+1bXvJT6kICu5ZwqKCnvlQ==", + "cpu": [ + "loong64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-loong64-musl": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-loong64-musl/-/rollup-linux-loong64-musl-4.60.1.tgz", + "integrity": "sha512-4LqhUomJqwe641gsPp6xLfhqWMbQV04KtPp7/dIp0nzPxAkNY1AbwL5W0MQpcalLYk07vaW9Kp1PBhdpZYYcEw==", + "cpu": [ + "loong64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-gnu": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-gnu/-/rollup-linux-ppc64-gnu-4.60.1.tgz", + "integrity": "sha512-tLQQ9aPvkBxOc/EUT6j3pyeMD6Hb8QF2BTBnCQWP/uu1lhc9AIrIjKnLYMEroIz/JvtGYgI9dF3AxHZNaEH0rw==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-ppc64-musl": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-ppc64-musl/-/rollup-linux-ppc64-musl-4.60.1.tgz", + "integrity": "sha512-RMxFhJwc9fSXP6PqmAz4cbv3kAyvD1etJFjTx4ONqFP9DkTkXsAMU4v3Vyc5BgzC+anz7nS/9tp4obsKfqkDHg==", + "cpu": [ + "ppc64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-gnu": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-gnu/-/rollup-linux-riscv64-gnu-4.60.1.tgz", + "integrity": "sha512-QKgFl+Yc1eEk6MmOBfRHYF6lTxiiiV3/z/BRrbSiW2I7AFTXoBFvdMEyglohPj//2mZS4hDOqeB0H1ACh3sBbg==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-riscv64-musl": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-riscv64-musl/-/rollup-linux-riscv64-musl-4.60.1.tgz", + "integrity": "sha512-RAjXjP/8c6ZtzatZcA1RaQr6O1TRhzC+adn8YZDnChliZHviqIjmvFwHcxi4JKPSDAt6Uhf/7vqcBzQJy0PDJg==", + "cpu": [ + "riscv64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-s390x-gnu": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-s390x-gnu/-/rollup-linux-s390x-gnu-4.60.1.tgz", + "integrity": "sha512-wcuocpaOlaL1COBYiA89O6yfjlp3RwKDeTIA0hM7OpmhR1Bjo9j31G1uQVpDlTvwxGn2nQs65fBFL5UFd76FcQ==", + "cpu": [ + "s390x" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-gnu": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-gnu/-/rollup-linux-x64-gnu-4.60.1.tgz", + "integrity": "sha512-77PpsFQUCOiZR9+LQEFg9GClyfkNXj1MP6wRnzYs0EeWbPcHs02AXu4xuUbM1zhwn3wqaizle3AEYg5aeoohhg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-linux-x64-musl": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-linux-x64-musl/-/rollup-linux-x64-musl-4.60.1.tgz", + "integrity": "sha512-5cIATbk5vynAjqqmyBjlciMJl1+R/CwX9oLk/EyiFXDWd95KpHdrOJT//rnUl4cUcskrd0jCCw3wpZnhIHdD9w==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "linux" + ] + }, + "node_modules/@rollup/rollup-openbsd-x64": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openbsd-x64/-/rollup-openbsd-x64-4.60.1.tgz", + "integrity": "sha512-cl0w09WsCi17mcmWqqglez9Gk8isgeWvoUZ3WiJFYSR3zjBQc2J5/ihSjpl+VLjPqjQ/1hJRcqBfLjssREQILw==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openbsd" + ] + }, + "node_modules/@rollup/rollup-openharmony-arm64": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-openharmony-arm64/-/rollup-openharmony-arm64-4.60.1.tgz", + "integrity": "sha512-4Cv23ZrONRbNtbZa37mLSueXUCtN7MXccChtKpUnQNgF010rjrjfHx3QxkS2PI7LqGT5xXyYs1a7LbzAwT0iCA==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "openharmony" + ] + }, + "node_modules/@rollup/rollup-win32-arm64-msvc": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-arm64-msvc/-/rollup-win32-arm64-msvc-4.60.1.tgz", + "integrity": "sha512-i1okWYkA4FJICtr7KpYzFpRTHgy5jdDbZiWfvny21iIKky5YExiDXP+zbXzm3dUcFpkEeYNHgQ5fuG236JPq0g==", + "cpu": [ + "arm64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-ia32-msvc": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-ia32-msvc/-/rollup-win32-ia32-msvc-4.60.1.tgz", + "integrity": "sha512-u09m3CuwLzShA0EYKMNiFgcjjzwqtUMLmuCJLeZWjjOYA3IT2Di09KaxGBTP9xVztWyIWjVdsB2E9goMjZvTQg==", + "cpu": [ + "ia32" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-gnu": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-gnu/-/rollup-win32-x64-gnu-4.60.1.tgz", + "integrity": "sha512-k+600V9Zl1CM7eZxJgMyTUzmrmhB/0XZnF4pRypKAlAgxmedUA+1v9R+XOFv56W4SlHEzfeMtzujLJD22Uz5zg==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@rollup/rollup-win32-x64-msvc": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/@rollup/rollup-win32-x64-msvc/-/rollup-win32-x64-msvc-4.60.1.tgz", + "integrity": "sha512-lWMnixq/QzxyhTV6NjQJ4SFo1J6PvOX8vUx5Wb4bBPsEb+8xZ89Bz6kOXpfXj9ak9AHTQVQzlgzBEc1SyM27xQ==", + "cpu": [ + "x64" + ], + "license": "MIT", + "optional": true, + "os": [ + "win32" + ] + }, + "node_modules/@shikijs/core": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/core/-/core-3.23.0.tgz", + "integrity": "sha512-NSWQz0riNb67xthdm5br6lAkvpDJRTgB36fxlo37ZzM2yq0PQFFzbd8psqC2XMPgCzo1fW6cVi18+ArJ44wqgA==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4", + "hast-util-to-html": "^9.0.5" + } + }, + "node_modules/@shikijs/engine-javascript": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-javascript/-/engine-javascript-3.23.0.tgz", + "integrity": "sha512-aHt9eiGFobmWR5uqJUViySI1bHMqrAgamWE1TYSUoftkAeCCAiGawPMwM+VCadylQtF4V3VNOZ5LmfItH5f3yA==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2", + "oniguruma-to-es": "^4.3.4" + } + }, + "node_modules/@shikijs/engine-oniguruma": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz", + "integrity": "sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2" + } + }, + "node_modules/@shikijs/langs": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/langs/-/langs-3.23.0.tgz", + "integrity": "sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/themes": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/themes/-/themes-3.23.0.tgz", + "integrity": "sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA==", + "license": "MIT", + "dependencies": { + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/transformers": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/transformers/-/transformers-3.23.0.tgz", + "integrity": "sha512-F9msZVxdF+krQNSdQ4V+Ja5QemeAoTQ2jxt7nJCwhDsdF1JWS3KxIQXA3lQbyKwS3J61oHRUSv4jYWv3CkaKTQ==", + "license": "MIT", + "dependencies": { + "@shikijs/core": "3.23.0", + "@shikijs/types": "3.23.0" + } + }, + "node_modules/@shikijs/types": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/@shikijs/types/-/types-3.23.0.tgz", + "integrity": "sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ==", + "license": "MIT", + "dependencies": { + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/@shikijs/vscode-textmate": { + "version": "10.0.2", + "resolved": "https://registry.npmjs.org/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz", + "integrity": "sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg==", + "license": "MIT" + }, + "node_modules/@types/estree": { + "version": "1.0.8", + "resolved": "https://registry.npmjs.org/@types/estree/-/estree-1.0.8.tgz", + "integrity": "sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w==", + "license": "MIT" + }, + "node_modules/@types/hast": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/@types/hast/-/hast-3.0.4.tgz", + "integrity": "sha512-WPs+bbQw5aCj+x6laNGWLH3wviHtoCv/P3+otBhbOhJgG8qtpdAMlTCxLtsTWA7LH1Oh/bFCHsBn0TPS5m30EQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/linkify-it": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-5.0.0.tgz", + "integrity": "sha512-sVDA58zAw4eWAffKOaQH5/5j3XeayukzDk+ewSsnv3p4yJEZHCCzMDiZM8e0OUrRvmpGZ85jf4yDHkHsgBNr9Q==", + "license": "MIT" + }, + "node_modules/@types/markdown-it": { + "version": "14.1.2", + "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-14.1.2.tgz", + "integrity": "sha512-promo4eFwuiW+TfGxhi+0x3czqTYJkG8qB17ZUJiVF10Xm7NLVRSLUsfRTU/6h1e24VvRnXCx+hG7li58lkzog==", + "license": "MIT", + "dependencies": { + "@types/linkify-it": "^5", + "@types/mdurl": "^2" + } + }, + "node_modules/@types/mdast": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/@types/mdast/-/mdast-4.0.4.tgz", + "integrity": "sha512-kGaNbPh1k7AFzgpud/gMdvIm5xuECykRR+JnWKQno9TAXVa6WIVCGTPvYGekIDL4uwCZQSYbUxNBSb1aUo79oA==", + "license": "MIT", + "dependencies": { + "@types/unist": "*" + } + }, + "node_modules/@types/mdurl": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-2.0.0.tgz", + "integrity": "sha512-RGdgjQUZba5p6QEFAVx2OGb8rQDL/cPRG7GiedRzMcJ1tYnUANBncjbSB1NRGwbvjcPeikRABz2nshyPk1bhWg==", + "license": "MIT" + }, + "node_modules/@types/unist": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/@types/unist/-/unist-3.0.3.tgz", + "integrity": "sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q==", + "license": "MIT" + }, + "node_modules/@types/web-bluetooth": { + "version": "0.0.21", + "resolved": "https://registry.npmjs.org/@types/web-bluetooth/-/web-bluetooth-0.0.21.tgz", + "integrity": "sha512-oIQLCGWtcFZy2JW77j9k8nHzAOpqMHLQejDA48XXMWH6tjCQHz5RCFz1bzsmROyL6PUm+LLnUiI4BCn221inxA==", + "license": "MIT" + }, + "node_modules/@ungap/structured-clone": { + "version": "1.3.0", + "resolved": "https://registry.npmjs.org/@ungap/structured-clone/-/structured-clone-1.3.0.tgz", + "integrity": "sha512-WmoN8qaIAo7WTYWbAZuG8PYEhn5fkz7dZrqTBZ7dtt//lL2Gwms1IcnQ5yHqjDfX8Ft5j4YzDM23f87zBfDe9g==", + "license": "ISC" + }, + "node_modules/@vitejs/plugin-vue": { + "version": "6.0.5", + "resolved": "https://registry.npmjs.org/@vitejs/plugin-vue/-/plugin-vue-6.0.5.tgz", + "integrity": "sha512-bL3AxKuQySfk1iGcBsQnoRVexTPJq0Z/ixFVM8OhVJAP6ZXXXLtM7NFKWhLl30Kg7uTBqIaPXbh+nuQCuBDedg==", + "license": "MIT", + "dependencies": { + "@rolldown/pluginutils": "1.0.0-rc.2" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "peerDependencies": { + "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0", + "vue": "^3.2.25" + } + }, + "node_modules/@vue/compiler-core": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/compiler-core/-/compiler-core-3.5.32.tgz", + "integrity": "sha512-4x74Tbtqnda8s/NSD6e1Dr5p1c8HdMU5RWSjMSUzb8RTcUQqevDCxVAitcLBKT+ie3o0Dl9crc/S/opJM7qBGQ==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.29.2", + "@vue/shared": "3.5.32", + "entities": "^7.0.1", + "estree-walker": "^2.0.2", + "source-map-js": "^1.2.1" + } + }, + "node_modules/@vue/compiler-dom": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/compiler-dom/-/compiler-dom-3.5.32.tgz", + "integrity": "sha512-ybHAu70NtiEI1fvAUz3oXZqkUYEe5J98GjMDpTGl5iHb0T15wQYLR4wE3h9xfuTNA+Cm2f4czfe8B4s+CCH57Q==", + "license": "MIT", + "dependencies": { + "@vue/compiler-core": "3.5.32", + "@vue/shared": "3.5.32" + } + }, + "node_modules/@vue/compiler-sfc": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/compiler-sfc/-/compiler-sfc-3.5.32.tgz", + "integrity": "sha512-8UYUYo71cP/0YHMO814TRZlPuUUw3oifHuMR7Wp9SNoRSrxRQnhMLNlCeaODNn6kNTJsjFoQ/kqIj4qGvya4Xg==", + "license": "MIT", + "dependencies": { + "@babel/parser": "^7.29.2", + "@vue/compiler-core": "3.5.32", + "@vue/compiler-dom": "3.5.32", + "@vue/compiler-ssr": "3.5.32", + "@vue/shared": "3.5.32", + "estree-walker": "^2.0.2", + "magic-string": "^0.30.21", + "postcss": "^8.5.8", + "source-map-js": "^1.2.1" + } + }, + "node_modules/@vue/compiler-ssr": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/compiler-ssr/-/compiler-ssr-3.5.32.tgz", + "integrity": "sha512-Gp4gTs22T3DgRotZ8aA/6m2jMR+GMztvBXUBEUOYOcST+giyGWJ4WvFd7QLHBkzTxkfOt8IELKNdpzITLbA2rw==", + "license": "MIT", + "dependencies": { + "@vue/compiler-dom": "3.5.32", + "@vue/shared": "3.5.32" + } + }, + "node_modules/@vue/devtools-api": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/@vue/devtools-api/-/devtools-api-8.1.1.tgz", + "integrity": "sha512-bsDMJ07b3GN1puVwJb/fyFnj/U2imyswK5UQVLZwVl7O05jDrt6BHxeG5XffmOOdasOj/bOmIjxJvGPxU7pcqw==", + "license": "MIT", + "dependencies": { + "@vue/devtools-kit": "^8.1.1" + } + }, + "node_modules/@vue/devtools-kit": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/@vue/devtools-kit/-/devtools-kit-8.1.1.tgz", + "integrity": "sha512-gVBaBv++i+adg4JpH71k9ppl4soyR7Y2McEqO5YNgv0BI1kMZ7BDX5gnwkZ5COYgiCyhejZG+yGNrBAjj6Coqg==", + "license": "MIT", + "dependencies": { + "@vue/devtools-shared": "^8.1.1", + "birpc": "^2.6.1", + "hookable": "^5.5.3", + "perfect-debounce": "^2.0.0" + } + }, + "node_modules/@vue/devtools-shared": { + "version": "8.1.1", + "resolved": "https://registry.npmjs.org/@vue/devtools-shared/-/devtools-shared-8.1.1.tgz", + "integrity": "sha512-+h4ttmJYl/txpxHKaoZcaKpC+pvckgLzIDiSQlaQ7kKthKh8KuwoLW2D8hPJEnqKzXOvu15UHEoGyngAXCz0EQ==", + "license": "MIT" + }, + "node_modules/@vue/reactivity": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/reactivity/-/reactivity-3.5.32.tgz", + "integrity": "sha512-/ORasxSGvZ6MN5gc+uE364SxFdJ0+WqVG0CENXaGW58TOCdrAW76WWaplDtECeS1qphvtBZtR+3/o1g1zL4xPQ==", + "license": "MIT", + "dependencies": { + "@vue/shared": "3.5.32" + } + }, + "node_modules/@vue/runtime-core": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/runtime-core/-/runtime-core-3.5.32.tgz", + "integrity": "sha512-pDrXCejn4UpFDFmMd27AcJEbHaLemaE5o4pbb7sLk79SRIhc6/t34BQA7SGNgYtbMnvbF/HHOftYBgFJtUoJUQ==", + "license": "MIT", + "dependencies": { + "@vue/reactivity": "3.5.32", + "@vue/shared": "3.5.32" + } + }, + "node_modules/@vue/runtime-dom": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/runtime-dom/-/runtime-dom-3.5.32.tgz", + "integrity": "sha512-1CDVv7tv/IV13V8Nip1k/aaObVbWqRlVCVezTwx3K07p7Vxossp5JU1dcPNhJk3w347gonIUT9jQOGutyJrSVQ==", + "license": "MIT", + "dependencies": { + "@vue/reactivity": "3.5.32", + "@vue/runtime-core": "3.5.32", + "@vue/shared": "3.5.32", + "csstype": "^3.2.3" + } + }, + "node_modules/@vue/server-renderer": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/server-renderer/-/server-renderer-3.5.32.tgz", + "integrity": "sha512-IOjm2+JQwRFS7W28HNuJeXQle9KdZbODFY7hFGVtnnghF51ta20EWAZJHX+zLGtsHhaU6uC9BGPV52KVpYryMQ==", + "license": "MIT", + "dependencies": { + "@vue/compiler-ssr": "3.5.32", + "@vue/shared": "3.5.32" + }, + "peerDependencies": { + "vue": "3.5.32" + } + }, + "node_modules/@vue/shared": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/@vue/shared/-/shared-3.5.32.tgz", + "integrity": "sha512-ksNyrmRQzWJJ8n3cRDuSF7zNNontuJg1YHnmWRJd2AMu8Ij2bqwiiri2lH5rHtYPZjj4STkNcgcmiQqlOjiYGg==", + "license": "MIT" + }, + "node_modules/@vueuse/core": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@vueuse/core/-/core-14.2.1.tgz", + "integrity": "sha512-3vwDzV+GDUNpdegRY6kzpLm4Igptq+GA0QkJ3W61Iv27YWwW/ufSlOfgQIpN6FZRMG0mkaz4gglJRtq5SeJyIQ==", + "license": "MIT", + "dependencies": { + "@types/web-bluetooth": "^0.0.21", + "@vueuse/metadata": "14.2.1", + "@vueuse/shared": "14.2.1" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + }, + "peerDependencies": { + "vue": "^3.5.0" + } + }, + "node_modules/@vueuse/integrations": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@vueuse/integrations/-/integrations-14.2.1.tgz", + "integrity": "sha512-2LIUpBi/67PoXJGqSDQUF0pgQWpNHh7beiA+KG2AbybcNm+pTGWT6oPGlBgUoDWmYwfeQqM/uzOHqcILpKL7nA==", + "license": "MIT", + "dependencies": { + "@vueuse/core": "14.2.1", + "@vueuse/shared": "14.2.1" + }, + "funding": { + "url": "https://github.com/sponsors/antfu" + }, + "peerDependencies": { + "async-validator": "^4", + "axios": "^1", + "change-case": "^5", + "drauu": "^0.4", + "focus-trap": "^7 || ^8", + "fuse.js": "^7", + "idb-keyval": "^6", + "jwt-decode": "^4", + "nprogress": "^0.2", + "qrcode": "^1.5", + "sortablejs": "^1", + "universal-cookie": "^7 || ^8", + "vue": "^3.5.0" + }, + "peerDependenciesMeta": { + "async-validator": { + "optional": true + }, + "axios": { + "optional": true + }, + "change-case": { + "optional": true + }, + "drauu": { + "optional": true + }, + "focus-trap": { + "optional": true + }, + "fuse.js": { + "optional": true + }, + "idb-keyval": { + "optional": true + }, + "jwt-decode": { + "optional": true + }, + "nprogress": { + "optional": true + }, + "qrcode": { + "optional": true + }, + "sortablejs": { + "optional": true + }, + "universal-cookie": { + "optional": true + } + } + }, + "node_modules/@vueuse/metadata": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@vueuse/metadata/-/metadata-14.2.1.tgz", + "integrity": "sha512-1ButlVtj5Sb/HDtIy1HFr1VqCP4G6Ypqt5MAo0lCgjokrk2mvQKsK2uuy0vqu/Ks+sHfuHo0B9Y9jn9xKdjZsw==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/@vueuse/shared": { + "version": "14.2.1", + "resolved": "https://registry.npmjs.org/@vueuse/shared/-/shared-14.2.1.tgz", + "integrity": "sha512-shTJncjV9JTI4oVNyF1FQonetYAiTBd+Qj7cY89SWbXSkx7gyhrgtEdF2ZAVWS1S3SHlaROO6F2IesJxQEkZBw==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/antfu" + }, + "peerDependencies": { + "vue": "^3.5.0" + } + }, + "node_modules/birpc": { + "version": "2.9.0", + "resolved": "https://registry.npmjs.org/birpc/-/birpc-2.9.0.tgz", + "integrity": "sha512-KrayHS5pBi69Xi9JmvoqrIgYGDkD6mcSe/i6YKi3w5kekCLzrX4+nawcXqrj2tIp50Kw/mT/s3p+GVK0A0sKxw==", + "license": "MIT", + "funding": { + "url": "https://github.com/sponsors/antfu" + } + }, + "node_modules/ccount": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/ccount/-/ccount-2.0.1.tgz", + "integrity": "sha512-eyrF0jiFpY+3drT6383f1qhkbGsLSifNAjA61IUjZjmLCWjItY6LB9ft9YhoDgwfmclB2zhu51Lc7+95b8NRAg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-html4": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/character-entities-html4/-/character-entities-html4-2.1.0.tgz", + "integrity": "sha512-1v7fgQRj6hnSwFpq1Eu0ynr/CDEw0rXo2B61qXrLNdHZmPKgb7fqS1a2JwF0rISo9q77jDI8VMEHoApn8qDoZA==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/character-entities-legacy": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/character-entities-legacy/-/character-entities-legacy-3.0.0.tgz", + "integrity": "sha512-RpPp0asT/6ufRm//AJVwpViZbGM/MkjQFxJccQRHmISF/22NBtsHqAWmL+/pmkPWoIUJdWyeVleTl1wydHATVQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/comma-separated-tokens": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/comma-separated-tokens/-/comma-separated-tokens-2.0.3.tgz", + "integrity": "sha512-Fu4hJdvzeylCfQPp9SGWidpzrMs7tTrlu6Vb8XGaRGck8QSNZJJp538Wrb60Lax4fPwR64ViY468OIUTbRlGZg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/csstype": { + "version": "3.2.3", + "resolved": "https://registry.npmjs.org/csstype/-/csstype-3.2.3.tgz", + "integrity": "sha512-z1HGKcYy2xA8AGQfwrn0PAy+PB7X/GSj3UVJW9qKyn43xWa+gl5nXmU4qqLMRzWVLFC8KusUX8T/0kCiOYpAIQ==", + "license": "MIT" + }, + "node_modules/dequal": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/dequal/-/dequal-2.0.3.tgz", + "integrity": "sha512-0je+qPKHEMohvfRTCEo3CrPG6cAzAYgmzKyxRiYSSDkS6eGJdyVJm7WaYA5ECaAD9wLB2T4EEeymA5aFVcYXCA==", + "license": "MIT", + "engines": { + "node": ">=6" + } + }, + "node_modules/devlop": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/devlop/-/devlop-1.1.0.tgz", + "integrity": "sha512-RWmIqhcFf1lRYBvNmr7qTNuyCt/7/ns2jbpp1+PalgE/rDQcBT0fioSMUpJ93irlUhC5hrg4cYqe6U+0ImW0rA==", + "license": "MIT", + "dependencies": { + "dequal": "^2.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/entities": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/entities/-/entities-7.0.1.tgz", + "integrity": "sha512-TWrgLOFUQTH994YUyl1yT4uyavY5nNB5muff+RtWaqNVCAK408b5ZnnbNAUEWLTCpum9w6arT70i1XdQ4UeOPA==", + "license": "BSD-2-Clause", + "engines": { + "node": ">=0.12" + }, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, + "node_modules/esbuild": { + "version": "0.27.7", + "resolved": "https://registry.npmjs.org/esbuild/-/esbuild-0.27.7.tgz", + "integrity": "sha512-IxpibTjyVnmrIQo5aqNpCgoACA/dTKLTlhMHihVHhdkxKyPO1uBBthumT0rdHmcsk9uMonIWS0m4FljWzILh3w==", + "hasInstallScript": true, + "license": "MIT", + "bin": { + "esbuild": "bin/esbuild" + }, + "engines": { + "node": ">=18" + }, + "optionalDependencies": { + "@esbuild/aix-ppc64": "0.27.7", + "@esbuild/android-arm": "0.27.7", + "@esbuild/android-arm64": "0.27.7", + "@esbuild/android-x64": "0.27.7", + "@esbuild/darwin-arm64": "0.27.7", + "@esbuild/darwin-x64": "0.27.7", + "@esbuild/freebsd-arm64": "0.27.7", + "@esbuild/freebsd-x64": "0.27.7", + "@esbuild/linux-arm": "0.27.7", + "@esbuild/linux-arm64": "0.27.7", + "@esbuild/linux-ia32": "0.27.7", + "@esbuild/linux-loong64": "0.27.7", + "@esbuild/linux-mips64el": "0.27.7", + "@esbuild/linux-ppc64": "0.27.7", + "@esbuild/linux-riscv64": "0.27.7", + "@esbuild/linux-s390x": "0.27.7", + "@esbuild/linux-x64": "0.27.7", + "@esbuild/netbsd-arm64": "0.27.7", + "@esbuild/netbsd-x64": "0.27.7", + "@esbuild/openbsd-arm64": "0.27.7", + "@esbuild/openbsd-x64": "0.27.7", + "@esbuild/openharmony-arm64": "0.27.7", + "@esbuild/sunos-x64": "0.27.7", + "@esbuild/win32-arm64": "0.27.7", + "@esbuild/win32-ia32": "0.27.7", + "@esbuild/win32-x64": "0.27.7" + } + }, + "node_modules/estree-walker": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/estree-walker/-/estree-walker-2.0.2.tgz", + "integrity": "sha512-Rfkk/Mp/DL7JVje3u18FxFujQlTNR2q6QfMSMB7AvCBx91NGj/ba3kCfza0f6dVDbw7YlRf/nDrn7pQrCCyQ/w==", + "license": "MIT" + }, + "node_modules/fdir": { + "version": "6.5.0", + "resolved": "https://registry.npmjs.org/fdir/-/fdir-6.5.0.tgz", + "integrity": "sha512-tIbYtZbucOs0BRGqPJkshJUYdL+SDH7dVM8gjy+ERp3WAUjLEFJE+02kanyHtwjWOnwrKYBiwAmM0p4kLJAnXg==", + "license": "MIT", + "engines": { + "node": ">=12.0.0" + }, + "peerDependencies": { + "picomatch": "^3 || ^4" + }, + "peerDependenciesMeta": { + "picomatch": { + "optional": true + } + } + }, + "node_modules/focus-trap": { + "version": "8.0.1", + "resolved": "https://registry.npmjs.org/focus-trap/-/focus-trap-8.0.1.tgz", + "integrity": "sha512-9ptSG6z51YQOstI/oN4XuVGP/03u2nh0g//qz7L6zX0i6PZiPnkcf3GenXq7N2hZnASXaMxTPpbKwdI+PFvxlw==", + "license": "MIT", + "dependencies": { + "tabbable": "^6.4.0" + } + }, + "node_modules/fsevents": { + "version": "2.3.3", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", + "integrity": "sha512-5xoDfX+fL7faATnagmWPpbFtwh/R77WmMMqqHGS65C3vvB0YHrgF+B1YmZ3441tMj5n63k0212XNoJwzlhffQw==", + "hasInstallScript": true, + "license": "MIT", + "optional": true, + "os": [ + "darwin" + ], + "engines": { + "node": "^8.16.0 || ^10.6.0 || >=11.0.0" + } + }, + "node_modules/hast-util-to-html": { + "version": "9.0.5", + "resolved": "https://registry.npmjs.org/hast-util-to-html/-/hast-util-to-html-9.0.5.tgz", + "integrity": "sha512-OguPdidb+fbHQSU4Q4ZiLKnzWo8Wwsf5bZfbvu7//a9oTYoqD/fWpe96NuHkoS9h0ccGOTe0C4NGXdtS0iObOw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/unist": "^3.0.0", + "ccount": "^2.0.0", + "comma-separated-tokens": "^2.0.0", + "hast-util-whitespace": "^3.0.0", + "html-void-elements": "^3.0.0", + "mdast-util-to-hast": "^13.0.0", + "property-information": "^7.0.0", + "space-separated-tokens": "^2.0.0", + "stringify-entities": "^4.0.0", + "zwitch": "^2.0.4" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hast-util-whitespace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/hast-util-whitespace/-/hast-util-whitespace-3.0.0.tgz", + "integrity": "sha512-88JUN06ipLwsnv+dVn+OIYOvAuvBMy/Qoi6O7mQHxdPXpjy+Cd6xRkWwux7DKO+4sYILtLBRIKgsdpS2gQc7qw==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/hookable": { + "version": "5.5.3", + "resolved": "https://registry.npmjs.org/hookable/-/hookable-5.5.3.tgz", + "integrity": "sha512-Yc+BQe8SvoXH1643Qez1zqLRmbA5rCL+sSmk6TVos0LWVfNIB7PGncdlId77WzLGSIB5KaWgTaNTs2lNVEI6VQ==", + "license": "MIT" + }, + "node_modules/html-void-elements": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/html-void-elements/-/html-void-elements-3.0.0.tgz", + "integrity": "sha512-bEqo66MRXsUGxWHV5IP0PUiAWwoEjba4VCzg0LjFJBpchPaTfyfCKTG6bc5F8ucKec3q5y6qOdGyYTSBEvhCrg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/magic-string": { + "version": "0.30.21", + "resolved": "https://registry.npmjs.org/magic-string/-/magic-string-0.30.21.tgz", + "integrity": "sha512-vd2F4YUyEXKGcLHoq+TEyCjxueSeHnFxyyjNp80yg0XV4vUhnDer/lvvlqM/arB5bXQN5K2/3oinyCRyx8T2CQ==", + "license": "MIT", + "dependencies": { + "@jridgewell/sourcemap-codec": "^1.5.5" + } + }, + "node_modules/mark.js": { + "version": "8.11.1", + "resolved": "https://registry.npmjs.org/mark.js/-/mark.js-8.11.1.tgz", + "integrity": "sha512-1I+1qpDt4idfgLQG+BNWmrqku+7/2bi5nLf4YwF8y8zXvmfiTBY3PV3ZibfrjBueCByROpuBjLLFCajqkgYoLQ==", + "license": "MIT" + }, + "node_modules/mdast-util-to-hast": { + "version": "13.2.1", + "resolved": "https://registry.npmjs.org/mdast-util-to-hast/-/mdast-util-to-hast-13.2.1.tgz", + "integrity": "sha512-cctsq2wp5vTsLIcaymblUriiTcZd0CwWtCbLvrOzYCDZoWyMNV8sZ7krj09FSnsiJi3WVsHLM4k6Dq/yaPyCXA==", + "license": "MIT", + "dependencies": { + "@types/hast": "^3.0.0", + "@types/mdast": "^4.0.0", + "@ungap/structured-clone": "^1.0.0", + "devlop": "^1.0.0", + "micromark-util-sanitize-uri": "^2.0.0", + "trim-lines": "^3.0.0", + "unist-util-position": "^5.0.0", + "unist-util-visit": "^5.0.0", + "vfile": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/micromark-util-character": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/micromark-util-character/-/micromark-util-character-2.1.1.tgz", + "integrity": "sha512-wv8tdUTJ3thSFFFJKtpYKOYiGP2+v96Hvk4Tu8KpCAsTMs6yi+nVmGh1syvSCsaxz45J6Jbw+9DD6g97+NV67Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-symbol": "^2.0.0", + "micromark-util-types": "^2.0.0" + } + }, + "node_modules/micromark-util-encode": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-encode/-/micromark-util-encode-2.0.1.tgz", + "integrity": "sha512-c3cVx2y4KqUnwopcO9b/SCdo2O67LwJJ/UyqGfbigahfegL9myoEFoDYZgkT7f36T0bLrM9hZTAaAyH+PCAXjw==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-sanitize-uri": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-sanitize-uri/-/micromark-util-sanitize-uri-2.0.1.tgz", + "integrity": "sha512-9N9IomZ/YuGGZZmQec1MbgxtlgougxTodVwDzzEouPKo3qFWvymFHWcnDi2vzV1ff6kas9ucW+o3yzJK9YB1AQ==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT", + "dependencies": { + "micromark-util-character": "^2.0.0", + "micromark-util-encode": "^2.0.0", + "micromark-util-symbol": "^2.0.0" + } + }, + "node_modules/micromark-util-symbol": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/micromark-util-symbol/-/micromark-util-symbol-2.0.1.tgz", + "integrity": "sha512-vs5t8Apaud9N28kgCrRUdEed4UJ+wWNvicHLPxCa9ENlYuAY31M0ETy5y1vA33YoNPDFTghEbnh6efaE8h4x0Q==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/micromark-util-types": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/micromark-util-types/-/micromark-util-types-2.0.2.tgz", + "integrity": "sha512-Yw0ECSpJoViF1qTU4DC6NwtC4aWGt1EkzaQB8KPPyCRR8z9TWeV0HbEFGTO+ZY1wB22zmxnJqhPyTpOVCpeHTA==", + "funding": [ + { + "type": "GitHub Sponsors", + "url": "https://github.com/sponsors/unifiedjs" + }, + { + "type": "OpenCollective", + "url": "https://opencollective.com/unified" + } + ], + "license": "MIT" + }, + "node_modules/minisearch": { + "version": "7.2.0", + "resolved": "https://registry.npmjs.org/minisearch/-/minisearch-7.2.0.tgz", + "integrity": "sha512-dqT2XBYUOZOiC5t2HRnwADjhNS2cecp9u+TJRiJ1Qp/f5qjkeT5APcGPjHw+bz89Ms8Jp+cG4AlE+QZ/QnDglg==", + "license": "MIT" + }, + "node_modules/nanoid": { + "version": "3.3.11", + "resolved": "https://registry.npmjs.org/nanoid/-/nanoid-3.3.11.tgz", + "integrity": "sha512-N8SpfPUnUp1bK+PMYW8qSWdl9U+wwNWI4QKxOYDy9JAro3WMX7p2OeVRF9v+347pnakNevPmiHhNmZ2HbFA76w==", + "funding": [ + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "bin": { + "nanoid": "bin/nanoid.cjs" + }, + "engines": { + "node": "^10 || ^12 || ^13.7 || ^14 || >=15.0.1" + } + }, + "node_modules/oniguruma-parser": { + "version": "0.12.1", + "resolved": "https://registry.npmjs.org/oniguruma-parser/-/oniguruma-parser-0.12.1.tgz", + "integrity": "sha512-8Unqkvk1RYc6yq2WBYRj4hdnsAxVze8i7iPfQr8e4uSP3tRv0rpZcbGUDvxfQQcdwHt/e9PrMvGCsa8OqG9X3w==", + "license": "MIT" + }, + "node_modules/oniguruma-to-es": { + "version": "4.3.5", + "resolved": "https://registry.npmjs.org/oniguruma-to-es/-/oniguruma-to-es-4.3.5.tgz", + "integrity": "sha512-Zjygswjpsewa0NLTsiizVuMQZbp0MDyM6lIt66OxsF21npUDlzpHi1Mgb/qhQdkb+dWFTzJmFbEWdvZgRho8eQ==", + "license": "MIT", + "dependencies": { + "oniguruma-parser": "^0.12.1", + "regex": "^6.1.0", + "regex-recursion": "^6.0.2" + } + }, + "node_modules/perfect-debounce": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/perfect-debounce/-/perfect-debounce-2.1.0.tgz", + "integrity": "sha512-LjgdTytVFXeUgtHZr9WYViYSM/g8MkcTPYDlPa3cDqMirHjKiSZPYd6DoL7pK8AJQr+uWkQvCjHNdiMqsrJs+g==", + "license": "MIT" + }, + "node_modules/picocolors": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", + "license": "ISC" + }, + "node_modules/picomatch": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-4.0.4.tgz", + "integrity": "sha512-QP88BAKvMam/3NxH6vj2o21R6MjxZUAd6nlwAS/pnGvN9IVLocLHxGYIzFhg6fUQ+5th6P4dv4eW9jX3DSIj7A==", + "license": "MIT", + "engines": { + "node": ">=12" + }, + "funding": { + "url": "https://github.com/sponsors/jonschlinkert" + } + }, + "node_modules/postcss": { + "version": "8.5.8", + "resolved": "https://registry.npmjs.org/postcss/-/postcss-8.5.8.tgz", + "integrity": "sha512-OW/rX8O/jXnm82Ey1k44pObPtdblfiuWnrd8X7GJ7emImCOstunGbXUpp7HdBrFQX6rJzn3sPT397Wp5aCwCHg==", + "funding": [ + { + "type": "opencollective", + "url": "https://opencollective.com/postcss/" + }, + { + "type": "tidelift", + "url": "https://tidelift.com/funding/github/npm/postcss" + }, + { + "type": "github", + "url": "https://github.com/sponsors/ai" + } + ], + "license": "MIT", + "dependencies": { + "nanoid": "^3.3.11", + "picocolors": "^1.1.1", + "source-map-js": "^1.2.1" + }, + "engines": { + "node": "^10 || ^12 || >=14" + } + }, + "node_modules/property-information": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/property-information/-/property-information-7.1.0.tgz", + "integrity": "sha512-TwEZ+X+yCJmYfL7TPUOcvBZ4QfoT5YenQiJuX//0th53DE6w0xxLEtfK3iyryQFddXuvkIk51EEgrJQ0WJkOmQ==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/regex": { + "version": "6.1.0", + "resolved": "https://registry.npmjs.org/regex/-/regex-6.1.0.tgz", + "integrity": "sha512-6VwtthbV4o/7+OaAF9I5L5V3llLEsoPyq9P1JVXkedTP33c7MfCG0/5NOPcSJn0TzXcG9YUrR0gQSWioew3LDg==", + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-recursion": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/regex-recursion/-/regex-recursion-6.0.2.tgz", + "integrity": "sha512-0YCaSCq2VRIebiaUviZNs0cBz1kg5kVS2UKUfNIx8YVs1cN3AV7NTctO5FOKBA+UT2BPJIWZauYHPqJODG50cg==", + "license": "MIT", + "dependencies": { + "regex-utilities": "^2.3.0" + } + }, + "node_modules/regex-utilities": { + "version": "2.3.0", + "resolved": "https://registry.npmjs.org/regex-utilities/-/regex-utilities-2.3.0.tgz", + "integrity": "sha512-8VhliFJAWRaUiVvREIiW2NXXTmHs4vMNnSzuJVhscgmGav3g9VDxLrQndI3dZZVVdp0ZO/5v0xmX516/7M9cng==", + "license": "MIT" + }, + "node_modules/rollup": { + "version": "4.60.1", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-4.60.1.tgz", + "integrity": "sha512-VmtB2rFU/GroZ4oL8+ZqXgSA38O6GR8KSIvWmEFv63pQ0G6KaBH9s07PO8XTXP4vI+3UJUEypOfjkGfmSBBR0w==", + "license": "MIT", + "dependencies": { + "@types/estree": "1.0.8" + }, + "bin": { + "rollup": "dist/bin/rollup" + }, + "engines": { + "node": ">=18.0.0", + "npm": ">=8.0.0" + }, + "optionalDependencies": { + "@rollup/rollup-android-arm-eabi": "4.60.1", + "@rollup/rollup-android-arm64": "4.60.1", + "@rollup/rollup-darwin-arm64": "4.60.1", + "@rollup/rollup-darwin-x64": "4.60.1", + "@rollup/rollup-freebsd-arm64": "4.60.1", + "@rollup/rollup-freebsd-x64": "4.60.1", + "@rollup/rollup-linux-arm-gnueabihf": "4.60.1", + "@rollup/rollup-linux-arm-musleabihf": "4.60.1", + "@rollup/rollup-linux-arm64-gnu": "4.60.1", + "@rollup/rollup-linux-arm64-musl": "4.60.1", + "@rollup/rollup-linux-loong64-gnu": "4.60.1", + "@rollup/rollup-linux-loong64-musl": "4.60.1", + "@rollup/rollup-linux-ppc64-gnu": "4.60.1", + "@rollup/rollup-linux-ppc64-musl": "4.60.1", + "@rollup/rollup-linux-riscv64-gnu": "4.60.1", + "@rollup/rollup-linux-riscv64-musl": "4.60.1", + "@rollup/rollup-linux-s390x-gnu": "4.60.1", + "@rollup/rollup-linux-x64-gnu": "4.60.1", + "@rollup/rollup-linux-x64-musl": "4.60.1", + "@rollup/rollup-openbsd-x64": "4.60.1", + "@rollup/rollup-openharmony-arm64": "4.60.1", + "@rollup/rollup-win32-arm64-msvc": "4.60.1", + "@rollup/rollup-win32-ia32-msvc": "4.60.1", + "@rollup/rollup-win32-x64-gnu": "4.60.1", + "@rollup/rollup-win32-x64-msvc": "4.60.1", + "fsevents": "~2.3.2" + } + }, + "node_modules/shiki": { + "version": "3.23.0", + "resolved": "https://registry.npmjs.org/shiki/-/shiki-3.23.0.tgz", + "integrity": "sha512-55Dj73uq9ZXL5zyeRPzHQsK7Nbyt6Y10k5s7OjuFZGMhpp4r/rsLBH0o/0fstIzX1Lep9VxefWljK/SKCzygIA==", + "license": "MIT", + "dependencies": { + "@shikijs/core": "3.23.0", + "@shikijs/engine-javascript": "3.23.0", + "@shikijs/engine-oniguruma": "3.23.0", + "@shikijs/langs": "3.23.0", + "@shikijs/themes": "3.23.0", + "@shikijs/types": "3.23.0", + "@shikijs/vscode-textmate": "^10.0.2", + "@types/hast": "^3.0.4" + } + }, + "node_modules/source-map-js": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/source-map-js/-/source-map-js-1.2.1.tgz", + "integrity": "sha512-UXWMKhLOwVKb728IUtQPXxfYU+usdybtUrK/8uGE8CQMvrhOpwvzDBwj0QhSL7MQc7vIsISBG8VQ8+IDQxpfQA==", + "license": "BSD-3-Clause", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/space-separated-tokens": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", + "integrity": "sha512-PEGlAwrG8yXGXRjW32fGbg66JAlOAwbObuqVoJpv/mRgoWDQfgH1wDPvtzWyUSNAXBGSk8h755YDbbcEy3SH2Q==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/stringify-entities": { + "version": "4.0.4", + "resolved": "https://registry.npmjs.org/stringify-entities/-/stringify-entities-4.0.4.tgz", + "integrity": "sha512-IwfBptatlO+QCJUo19AqvrPNqlVMpW9YEL2LIVY+Rpv2qsjCGxaDLNRgeGsQWJhfItebuJhsGSLjaBbNSQ+ieg==", + "license": "MIT", + "dependencies": { + "character-entities-html4": "^2.0.0", + "character-entities-legacy": "^3.0.0" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/tabbable": { + "version": "6.4.0", + "resolved": "https://registry.npmjs.org/tabbable/-/tabbable-6.4.0.tgz", + "integrity": "sha512-05PUHKSNE8ou2dwIxTngl4EzcnsCDZGJ/iCLtDflR/SHB/ny14rXc+qU5P4mG9JkusiV7EivzY9Mhm55AzAvCg==", + "license": "MIT" + }, + "node_modules/tinyglobby": { + "version": "0.2.15", + "resolved": "https://registry.npmjs.org/tinyglobby/-/tinyglobby-0.2.15.tgz", + "integrity": "sha512-j2Zq4NyQYG5XMST4cbs02Ak8iJUdxRM0XI5QyxXuZOzKOINmWurp3smXu3y5wDcJrptwpSjgXHzIQxR0omXljQ==", + "license": "MIT", + "dependencies": { + "fdir": "^6.5.0", + "picomatch": "^4.0.3" + }, + "engines": { + "node": ">=12.0.0" + }, + "funding": { + "url": "https://github.com/sponsors/SuperchupuDev" + } + }, + "node_modules/trim-lines": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/trim-lines/-/trim-lines-3.0.1.tgz", + "integrity": "sha512-kRj8B+YHZCc9kQYdWfJB2/oUl9rA99qbowYYBtr4ui4mZyAQ2JpvVBd/6U2YloATfqBhBTSMhTpgBHtU0Mf3Rg==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + }, + "node_modules/unist-util-is": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/unist-util-is/-/unist-util-is-6.0.1.tgz", + "integrity": "sha512-LsiILbtBETkDz8I9p1dQ0uyRUWuaQzd/cuEeS1hoRSyW5E5XGmTzlwY1OrNzzakGowI9Dr/I8HVaw4hTtnxy8g==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-position": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/unist-util-position/-/unist-util-position-5.0.0.tgz", + "integrity": "sha512-fucsC7HjXvkB5R3kTCO7kUjRdrS0BJt3M/FPxmHMBOm8JQi2BsHAHFsy27E0EolP8rp0NzXsJ+jNPyDWvOJZPA==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-stringify-position": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/unist-util-stringify-position/-/unist-util-stringify-position-4.0.0.tgz", + "integrity": "sha512-0ASV06AAoKCDkS2+xw5RXJywruurpbC4JZSm7nr7MOt1ojAzvyyaO+UxZf18j8FCF6kmzCZKcAgN/yu2gm2XgQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/unist-util-visit/-/unist-util-visit-5.1.0.tgz", + "integrity": "sha512-m+vIdyeCOpdr/QeQCu2EzxX/ohgS8KbnPDgFni4dQsfSCtpz8UqDyY5GjRru8PDKuYn7Fq19j1CQ+nJSsGKOzg==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0", + "unist-util-visit-parents": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/unist-util-visit-parents": { + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/unist-util-visit-parents/-/unist-util-visit-parents-6.0.2.tgz", + "integrity": "sha512-goh1s1TBrqSqukSc8wrjwWhL0hiJxgA8m4kFxGlQ+8FYQ3C/m11FcTs4YYem7V664AhHVvgoQLk890Ssdsr2IQ==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-is": "^6.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile": { + "version": "6.0.3", + "resolved": "https://registry.npmjs.org/vfile/-/vfile-6.0.3.tgz", + "integrity": "sha512-KzIbH/9tXat2u30jf+smMwFCsno4wHVdNmzFyL+T/L3UGqqk6JKfVqOFOZEpZSHADH1k40ab6NUIXZq422ov3Q==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "vfile-message": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vfile-message": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/vfile-message/-/vfile-message-4.0.3.tgz", + "integrity": "sha512-QTHzsGd1EhbZs4AsQ20JX1rC3cOlt/IWJruk893DfLRr57lcnOeMaWG4K0JrRta4mIJZKth2Au3mM3u03/JWKw==", + "license": "MIT", + "dependencies": { + "@types/unist": "^3.0.0", + "unist-util-stringify-position": "^4.0.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/unified" + } + }, + "node_modules/vite": { + "version": "7.3.2", + "resolved": "https://registry.npmjs.org/vite/-/vite-7.3.2.tgz", + "integrity": "sha512-Bby3NOsna2jsjfLVOHKes8sGwgl4TT0E6vvpYgnAYDIF/tie7MRaFthmKuHx1NSXjiTueXH3do80FMQgvEktRg==", + "license": "MIT", + "dependencies": { + "esbuild": "^0.27.0", + "fdir": "^6.5.0", + "picomatch": "^4.0.3", + "postcss": "^8.5.6", + "rollup": "^4.43.0", + "tinyglobby": "^0.2.15" + }, + "bin": { + "vite": "bin/vite.js" + }, + "engines": { + "node": "^20.19.0 || >=22.12.0" + }, + "funding": { + "url": "https://github.com/vitejs/vite?sponsor=1" + }, + "optionalDependencies": { + "fsevents": "~2.3.3" + }, + "peerDependencies": { + "@types/node": "^20.19.0 || >=22.12.0", + "jiti": ">=1.21.0", + "less": "^4.0.0", + "lightningcss": "^1.21.0", + "sass": "^1.70.0", + "sass-embedded": "^1.70.0", + "stylus": ">=0.54.8", + "sugarss": "^5.0.0", + "terser": "^5.16.0", + "tsx": "^4.8.1", + "yaml": "^2.4.2" + }, + "peerDependenciesMeta": { + "@types/node": { + "optional": true + }, + "jiti": { + "optional": true + }, + "less": { + "optional": true + }, + "lightningcss": { + "optional": true + }, + "sass": { + "optional": true + }, + "sass-embedded": { + "optional": true + }, + "stylus": { + "optional": true + }, + "sugarss": { + "optional": true + }, + "terser": { + "optional": true + }, + "tsx": { + "optional": true + }, + "yaml": { + "optional": true + } + } + }, + "node_modules/vitepress": { + "version": "2.0.0-alpha.17", + "resolved": "https://registry.npmjs.org/vitepress/-/vitepress-2.0.0-alpha.17.tgz", + "integrity": "sha512-Z3VPUpwk/bHYqt1uMVOOK1/4xFiWQov1GNc2FvMdz6kvje4JRXEOngVI9C+bi5jeedMSHiA4dwKkff1NCvbZ9Q==", + "license": "MIT", + "dependencies": { + "@docsearch/css": "^4.5.3", + "@docsearch/js": "^4.5.3", + "@docsearch/sidepanel-js": "^4.5.3", + "@iconify-json/simple-icons": "^1.2.69", + "@shikijs/core": "^3.22.0", + "@shikijs/transformers": "^3.22.0", + "@shikijs/types": "^3.22.0", + "@types/markdown-it": "^14.1.2", + "@vitejs/plugin-vue": "^6.0.4", + "@vue/devtools-api": "^8.0.5", + "@vue/shared": "^3.5.27", + "@vueuse/core": "^14.2.0", + "@vueuse/integrations": "^14.2.0", + "focus-trap": "^8.0.0", + "mark.js": "8.11.1", + "minisearch": "^7.2.0", + "shiki": "^3.22.0", + "vite": "^7.3.1", + "vue": "^3.5.27" + }, + "bin": { + "vitepress": "bin/vitepress.js" + }, + "peerDependencies": { + "markdown-it-mathjax3": "^4", + "oxc-minify": "*", + "postcss": "^8" + }, + "peerDependenciesMeta": { + "markdown-it-mathjax3": { + "optional": true + }, + "oxc-minify": { + "optional": true + }, + "postcss": { + "optional": true + } + } + }, + "node_modules/vue": { + "version": "3.5.32", + "resolved": "https://registry.npmjs.org/vue/-/vue-3.5.32.tgz", + "integrity": "sha512-vM4z4Q9tTafVfMAK7IVzmxg34rSzTFMyIe0UUEijUCkn9+23lj0WRfA83dg7eQZIUlgOSGrkViIaCfqSAUXsMw==", + "license": "MIT", + "dependencies": { + "@vue/compiler-dom": "3.5.32", + "@vue/compiler-sfc": "3.5.32", + "@vue/runtime-dom": "3.5.32", + "@vue/server-renderer": "3.5.32", + "@vue/shared": "3.5.32" + }, + "peerDependencies": { + "typescript": "*" + }, + "peerDependenciesMeta": { + "typescript": { + "optional": true + } + } + }, + "node_modules/zwitch": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", + "integrity": "sha512-bXE4cR/kVZhKZX/RjPEflHaKVhUVl85noU3v6b8apfQEc1x4A+zBxjZ4lN8LqGd6WZ3dl98pY4o717VFmoPp+A==", + "license": "MIT", + "funding": { + "type": "github", + "url": "https://github.com/sponsors/wooorm" + } + } + } +} diff --git a/app/vendor/cakephp/bake/docs/package.json b/app/vendor/cakephp/bake/docs/package.json new file mode 100644 index 000000000..f1407730a --- /dev/null +++ b/app/vendor/cakephp/bake/docs/package.json @@ -0,0 +1,19 @@ +{ + "name": "docs", + "version": "1.0.0", + "description": "", + "main": "config.js", + "scripts": { + "docs:dev": "vitepress dev", + "docs:build": "vitepress build", + "docs:preview": "vitepress preview" + }, + "keywords": [], + "author": "", + "license": "ISC", + "type": "module", + "dependencies": { + "@cakephp/docs-skeleton": "git+ssh://git@github.com:cakephp/docs-skeleton.git#node-package", + "vitepress": "^2.0.0-alpha.16" + } +} diff --git a/app/vendor/cakephp/bake/docs/pt/conf.py b/app/vendor/cakephp/bake/docs/pt/conf.py deleted file mode 100644 index 9e22cb017..000000000 --- a/app/vendor/cakephp/bake/docs/pt/conf.py +++ /dev/null @@ -1,9 +0,0 @@ -import sys, os - -# Append the top level directory of the docs, so we can import from the config dir. -sys.path.insert(0, os.path.abspath('..')) - -# Pull in all the configuration options defined in the global config file.. -from config.all import * - -language = 'pt' diff --git a/app/vendor/cakephp/bake/docs/pt/contents.rst b/app/vendor/cakephp/bake/docs/pt/contents.rst deleted file mode 100644 index 08c3e957c..000000000 --- a/app/vendor/cakephp/bake/docs/pt/contents.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :maxdepth: 2 - :caption: CakePHP Bake - - /index - /usage - /development diff --git a/app/vendor/cakephp/bake/docs/pt/development.md b/app/vendor/cakephp/bake/docs/pt/development.md new file mode 100644 index 000000000..4b724e3e9 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/pt/development.md @@ -0,0 +1,262 @@ +# Estendendo o Bake + +O Bake fornece uma arquitetura expansível que permite à sua aplicação ou plugin modificar ou adicionar funcionalidades às funções básicas. +Bake faz uso de uma classe view dedicada que usa o mecanismo de templates [Twig](https://twig.symfony.com/). + +## Eventos do Bake + +Como uma classe view, `BakeView` emite os mesmos eventos que qualquer outra classe view, mais um evento extra de inicialização. +Enquanto as classes view padrão usam o prefixo `View.`, `BakeView` usa o prefixo `Bake.`. + +O evento de inicialização pode ser usado para fazer mudanças que se aplicam a todas as saídas do Bake. +Por exemplo, ao adicionar outro helper à classe view do Bake: + +```php +on('Bake.initialize', function (Event $event) { + $view = $event->getSubject(); + + // In my bake templates, allow the use of the MySpecial helper + $view->loadHelper('MySpecial', ['some' => 'config']); + + // And add an $author variable so it's always available + $view->set('author', 'Andy'); +}); +``` + +Se você deseja modificar o Bake a partir de outro plugin, é recomendável colocar os eventos do plugin no arquivo `config/bootstrap.php`. + +Os eventos do Bake podem ser úteis para pequenas alterações nos templates existentes. +Por exemplo, para alterar os nomes das variáveis usados no controller e template quando executar o Bake: + +```php +on('Bake.beforeRender', function (Event $event) { + $view = $event->getSubject(); + + // Use $rows for the main data variable in indexes + if ($view->get('pluralName')) { + $view->set('pluralName', 'rows'); + } + if ($view->get('pluralVar')) { + $view->set('pluralVar', 'rows'); + } + + // Use $theOne for the main data variable in view/edit + if ($view->get('singularName')) { + $view->set('singularName', 'theOne'); + } + if ($view->get('singularVar')) { + $view->set('singularVar', 'theOne'); + } +}); +``` + +Você também pode aplicar os eventos `Bake.beforeRender` e `Bake.afterRender` a um arquivo específico. +Por exemplo, se quiser adicionar ações ao `UsersController` ao gerar a partir de `Controller/controller.twig`: + +```php +on( + 'Bake.beforeRender.Controller.controller', + function (Event $event) { + $view = $event->getSubject(); + if ($view->viewVars['name'] == 'Users') { + // add the login and logout actions to the Users controller + $view->set('actions', [ + 'login', + 'logout', + 'index', + 'view', + 'add', + 'edit', + 'delete', + ]); + } + } +); +``` + +Ao adicionar listeners específicos para determinados templates do Bake, você simplifica a lógica relacionada ao Bake e fornece callbacks fáceis de testar. + +## Sintaxe de Templates do Bake + +Os arquivos de template do Bake usam a sintaxe [Twig](https://twig.symfony.com/doc/2.x/). + +Então, por exemplo, quando você executar algo como: + +```bash +bin/cake bake shell Foo +``` + +O template usado em `vendor/cakephp/bake/src/Template/Bake/Shell/shell.twig` parece com isto: + +```php +` fecha uma tag PHP de template Bake. +- `<%=` é a forma short-echo do template Bake. +- `<%-` abre a tag removendo espaços em branco antes dela. +- `-%>` fecha a tag removendo espaços em branco após ela. +::: + +## Criando um Tema Bake + +Se você deseja modificar a saída produzida com o comando `bake`, pode criar seu próprio tema para substituir alguns ou todos os templates que o Bake usa. + +1. Gere um novo plugin. O nome do plugin é o nome do tema. +2. Crie uma nova pasta em `plugins/[name]/Template/Bake/Template/`. +3. Copie qualquer template que queira modificar de `vendor/cakephp/bake/src/Template/Bake/Template` para a pasta acima e altere conforme sua necessidade. +4. Ao executar o Bake, use a opção `--theme` para especificar o tema. Para evitar repetir isso a cada chamada, também é possível definir o tema padrão: + +```php +Test->classSuffixes[$this->name()])) { + $this->Test->classSuffixes[$this->name()] = 'Foo'; + } + + $name = ucfirst($this->name()); + if (!isset($this->Test->classTypes[$name])) { + $this->Test->classTypes[$name] = 'Foo'; + } + + return parent::bakeTest($className); +} +``` + +- O **sufixo da classe** será anexado ao nome fornecido na chamada ao Bake. No exemplo acima, isso criaria `ExampleFooTest.php`. +- O **tipo de classe** será o subnamespace usado para levar ao arquivo relativo à aplicação ou plugin. No exemplo acima, isso criaria o namespace `App\Test\TestCase\Foo`. diff --git a/app/vendor/cakephp/bake/docs/pt/development.rst b/app/vendor/cakephp/bake/docs/pt/development.rst deleted file mode 100644 index 9a24232be..000000000 --- a/app/vendor/cakephp/bake/docs/pt/development.rst +++ /dev/null @@ -1,298 +0,0 @@ -Estendendo o Bake -################# - -O Bake fornece uma arquitetura expansível que permite a sua aplicação ou plugin -modificar ou adicionar funcionalidades às suas funções básicas. Bake faz uso de -uma classe view dedicada que usa a ferramenta de templates `Twig -`_. - -Eventos do Bake -=============== - -Como uma class view , ``BakeView`` emite o mesmo evento como qualquer outra -classe view, mais uma extra que inicializa eventos. No entanto, onde as classes -view padrão usam o prefixo "View.", ``BakeView`` usa o prefixo "Bake.". - -O inicializador de eventos pode ser usado para fazer mudanças quando aplicado -a todas as saídas do Bake, por exemplo, ao adicionar outro helper à classe bake -view este evento pode ser usado:: - - on('Bake.initialize', function (Event $event) { - $view = $event->getSubject(); - - // In my bake templates, allow the use of the MySpecial helper - $view->loadHelper('MySpecial', ['some' => 'config']); - - // And add an $author variable so it's always available - $view->set('author', 'Andy'); - - }); - -Se você deseja modificar o bake de outro plugin, é recomendável colocar os -eventos do bake do seu plugin no arquivo **config/bootstrap.php**. - -Os eventos do Bake podem ser úteis para fazer pequenas alterações nos modelos -existentes. Por exemplo, para alterar os nomes das variáveis usados no -controller/template quando executar o bake, pode-se usar uma função esperando -o ``Bake.beforeRender`` para modificar as variáveis usadas no bake templates:: - - on('Bake.beforeRender', function (Event $event) { - $view = $event->getSubject(); - - // Use $rows for the main data variable in indexes - if ($view->get('pluralName')) { - $view->set('pluralName', 'rows'); - } - if ($view->get('pluralVar')) { - $view->set('pluralVar', 'rows'); - } - - // Use $theOne for the main data variable in view/edit - if ($view->get('singularName')) { - $view->set('singularName', 'theOne'); - } - if ($view->get('singularVar')) { - $view->set('singularVar', 'theOne'); - } - - }); - -Você também pode abranger os eventos ``Bake.beforeRender`` -e ``Bake.afterRender`` para um arquivo específico. Por exemplo, se você quiser -adicionar ações específicas para seu UsersController ao gerar a partir de um -arquivo **Controller/controller.twig**, você pode usar o seguinte evento:: - - on( - 'Bake.beforeRender.Controller.controller', - function (Event $event) { - $view = $event->getSubject(); - if ($view->viewVars['name'] == 'Users') { - // add the login and logout actions to the Users controller - $view->set('actions', [ - 'login', - 'logout', - 'index', - 'view', - 'add', - 'edit', - 'delete' - ]); - } - } - ); - -Ao adicionar eventos que escutam um bake templates específico, você pode -simplesmente relacionar a sua lógica de eventos com o bake e fornecer callbacks -que são facilmente testáveis. - -Sintaxe de Templates do Bake -============================ - -Os arquivos de templates do Bake usam a sintaxe `Twig `__. - -Então, por exemplo, quando você executar algo como:: - -.. code-block:: bash - - $ bin/cake bake shell Foo - -O template usado (**vendor/cakephp/bake/src/Template/Bake/Shell/shell.twig**) -parece com algo assim:: - - `` Um template bake php fecha a tag - * ``<%=`` Um template bake php short-echo tag - * ``<%-`` Um template bake php abre a tag, retirando qualquer espaço em branco antes da tag - * ``-%>`` Um template bake php fecha a tag, retirando qualqualquer espaço em branco após a tag - -.. _creating-a-bake-theme: - -Criando um Tema Bake -===================== - -Se você deseja modificar a saída produzida com o comando bake, você pode criar -o seu próprio tema para o bake que permitirá você substituir algum ou todos os -tempaltes que o bake usa. O mmelhor jeito de fazer isto é: - -#. Bake um novo plugin. O nome do plugin é o 'nome do tema' -#. Crie uma nova pasta em **plugins/[name]/Template/Bake/Template/**. -#. Copie qualquer template que você queira modificar de - **vendor/cakephp/bake/src/Template/Bake/Template** para a pasta acima e modificá-los conforme sua necessidade. -#. Quando executar o bake use a opção ``--theme`` para especificar qual o tema - que o bake deve usar. Para evitar problemas com esta opção, em cada chamada, - você também pode definir o seu template customizado para ser usado como - o template padrão:: - - Test->classSuffixes[$this->name()])) { - $this->Test->classSuffixes[$this->name()] = 'Foo'; - } - - $name = ucfirst($this->name()); - if (!isset($this->Test->classTypes[$name])) { - $this->Test->classTypes[$name] = 'Foo'; - } - - return parent::bakeTest($className); - } - -* O **sufixo da classe** será anexado ao nome fornecido em sua chamada bake. No - exemplo anterior, ele criaria um arquivo ExampleFooTest.php. -* O **tipo de classe** será o subdomínio usado que levará ao seu arquivo - (relativo ao aplicativo ou ao plugin em que você está inserindo). No exemplo - anterior, ele criaria seu teste com o namespace App\Test\TestCase\Foo. - - -.. meta:: - :title lang=en: Extending Bake - :keywords lang=en: command line interface,development,bake view, bake template syntax,twig,erb tags,percent tags - diff --git a/app/vendor/cakephp/bake/docs/pt/index.md b/app/vendor/cakephp/bake/docs/pt/index.md new file mode 100644 index 000000000..fb09a83d4 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/pt/index.md @@ -0,0 +1,25 @@ +# Console Bake + +O console do Bake é uma ferramenta para você sair produzindo em CakePHP rapidamente. +Ele pode criar os itens básicos do CakePHP, como models, behaviors, views, helpers, +controllers, components, test cases, fixtures e plugins. +Bake pode ir além de classes esqueleto e gerar uma base funcional em poucos minutos. + +## Instalação + +Antes de usar ou estender o Bake, tenha certeza de que ele está instalado em sua aplicação. +Bake é distribuído como um plugin que você pode instalar com Composer: + +```bash +composer require --dev cakephp/bake:~2.0 +``` + +Isso instala o Bake como dependência de desenvolvimento, portanto ele não será instalado em produção. + +Ao usar templates Twig, verifique se você está carregando o plugin `Cake/TwigView` com seu bootstrap. +Você também pode omiti-lo completamente, o que faz com que o plugin Bake carregue esse plugin sob demanda. + +## Mapa da documentação + +- [Geração de código com Bake](/pt/usage) cobre a execução do CLI, os comandos disponíveis e os temas do Bake. +- [Estendendo o Bake](/pt/development) cobre eventos, templates, temas e novos comandos de Bake. diff --git a/app/vendor/cakephp/bake/docs/pt/index.rst b/app/vendor/cakephp/bake/docs/pt/index.rst deleted file mode 100644 index 8d068757e..000000000 --- a/app/vendor/cakephp/bake/docs/pt/index.rst +++ /dev/null @@ -1,30 +0,0 @@ -Console Bake -############ - -O console do **Bake** é outra ferramenta disponível para você sair trabalhando -- e rápido! O console Bake pode criar qualquer ítem básico do CakePHP: models, -behaviors, views, helpers, controllers, components, test cases, fixtures -e plugins. E nós não estamos apenas falando do esqueleto da classes: O Bake -pode criar uma aplicação totalmente funcional em questão de minutos. De fato, -o Bake é um passo natural a se dar uma vez que a aplicação tem sua base -construída. - -Instalação -========== - -Antes de tentar usar ou estender o Bake, tenha certeza de que ele está instalado em -sua aplicação. O Bake é distribuído como um plugin que você pode instalar com o -Composer:: - - composer require --dev cakephp/bake:~2.0 - -Isto irá instalar o Bake como uma dependência de desenvolvimento, sendo assim, -não será instalado no ambiente de produção. - -Ao usar os modelos Twig, verifique se você está carregando o plugin -Cake/TwigView com seu bootstrap. Você também pode omiti-lo completamente, -o que faz com que o plugin Bake carregue esse plugin sob demanda. - -.. meta:: - :title lang=pt: Bake Console - :keywords lang=pt: cli,linha de comando,command line,dev,desenvolvimento,bake view, bake syntax,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/pt/usage.md b/app/vendor/cakephp/bake/docs/pt/usage.md new file mode 100644 index 000000000..fd89ed1ae --- /dev/null +++ b/app/vendor/cakephp/bake/docs/pt/usage.md @@ -0,0 +1,104 @@ +# Geração de Código com Bake + +O console do Bake é executado usando o PHP CLI. +Se você tiver problemas para executar o script, assegure-se de que: + +1. Você instalou o PHP CLI e possui os módulos apropriados habilitados, por exemplo MySQL e `intl`. +2. Se o host do banco de dados for `localhost`, tente `127.0.0.1`, pois `localhost` pode causar problemas no PHP CLI. +3. Dependendo de como o seu computador está configurado, pode ser necessário definir permissões de execução no script Cake para chamá-lo com `bin/cake bake`. + +Antes de executar o Bake, você deve ter pelo menos uma conexão de banco de dados configurada. + +Para ver as opções disponíveis no Bake, digite: + +```bash +$ bin/cake bake --help + +Current Paths: + +* app: src +* root: . +* core: .\vendor\cakephp\cakephp + +Available Commands: + +Bake: + - bake all + - bake behavior + - bake cell + - bake command + - bake component + - bake controller + - bake controller all + - bake fixture + - bake fixture all + - bake form + - bake helper + - bake mailer + - bake middleware + - bake model + - bake model all + - bake plugin + - bake task + - bake template + - bake template all + - bake test + +To run a command, type `cake command_name [args|options]` +To get help on a specific command, type `cake command_name --help` +``` + +Você pode obter mais informações sobre o que cada tarefa faz e quais são suas opções usando `--help`: + +```bash +$ bin/cake bake model --help + +Bake table and entity classes. + +Usage: +cake bake model [options] [] + +Options: + +--connection, -c The datasource connection to get data from. + (default: default) +--display-field The displayField if you would like to choose one. +--fields A comma separated list of fields to make + accessible. +--force, -f Force overwriting existing files without + prompting. +--help, -h Display this help. +--hidden A comma separated list of fields to hide. +--no-associations Disable generating associations. +--no-entity Disable generating an entity class. +--no-fields Disable generating accessible fields in the + entity. +--no-fixture Do not generate a test fixture skeleton. +--no-hidden Disable generating hidden fields in the entity. +--no-rules Disable generating a rules checker. +--no-table Disable generating a table class. +--no-test Do not generate a test case skeleton. +--no-validation Disable generating validation rules. +--plugin, -p Plugin to bake into. +--primary-key The primary key if you would like to manually set + one. Can be a comma separated list if you are + using a composite primary key. +--quiet, -q Enable quiet output. +--table The table name to use if you have + non-conventional table names. +--theme, -t The theme to use when baking code. +--verbose, -v Enable verbose output. + +Arguments: + +name Name of the model to bake (without the Table suffix). You can use + Plugin.name to bake plugin models. (optional) + +Omitting all arguments and options will list the table names you can +generate models for. +``` + +## Temas para o Bake + +A opção `theme` é comum a todos os comandos do Bake e permite mudar os arquivos de template usados por ele. +Para criar seus próprios templates, veja [Criando um Tema Bake](/pt/development#criando-um-tema-bake). diff --git a/app/vendor/cakephp/bake/docs/pt/usage.rst b/app/vendor/cakephp/bake/docs/pt/usage.rst deleted file mode 100644 index f8cf8b4aa..000000000 --- a/app/vendor/cakephp/bake/docs/pt/usage.rst +++ /dev/null @@ -1,115 +0,0 @@ -Geração de Código com Bake -########################## - -O console do **Bake** é executado usando o PHP CLI (interface da linha de comando). -Se você tiver problemas para executar o script, assegure-se de que: - -#. Você instalou o PHP CLI e possui os módulos apropriados habilitados (por - exemplo: MySQL, intl). -#. Os usuários também podem ter problemas se o host do banco de dados for - 'localhost' e devem tentar '127.0.0.1', em vez disso, como localhost pode - causar problemas no PHP CLI. -#. Dependendo de como o seu computador está configurado, você pode ter que - definir direitos de execução no script cake bash para chamá-lo usando - ``bin/cake bake``. - -Antes de executar o Bake você deve certificar-se de ter pelo menos um banco de dados com a conexão configurada. - -Para ver as opções disponíveis no Bake digite:: - - $ bin/cake bake --help - - Current Paths: - - * app: src - * root: . - * core: .\vendor\cakephp\cakephp - - Available Commands: - - Bake: - - bake all - - bake behavior - - bake cell - - bake command - - bake component - - bake controller - - bake controller all - - bake fixture - - bake fixture all - - bake form - - bake helper - - bake mailer - - bake middleware - - bake model - - bake model all - - bake plugin - - bake task - - bake template - - bake template all - - bake test - - To run a command, type `cake command_name [args|options]` - To get help on a specific command, type `cake command_name --help` - - -Você pode obter mais informações sobre o que cada tarefa faz e quais são suas opções -disponíveis usando a opção ``--help``:: - - $ bin/cake bake model --help - - Bake table and entity classes. - - Usage: - cake bake model [options] [] - - Options: - - --connection, -c The datasource connection to get data from. - (default: default) - --display-field The displayField if you would like to choose one. - --fields A comma separated list of fields to make - accessible. - --force, -f Force overwriting existing files without - prompting. - --help, -h Display this help. - --hidden A comma separated list of fields to hide. - --no-associations Disable generating associations. - --no-entity Disable generating an entity class. - --no-fields Disable generating accessible fields in the - entity. - --no-fixture Do not generate a test fixture skeleton. - --no-hidden Disable generating hidden fields in the entity. - --no-rules Disable generating a rules checker. - --no-table Disable generating a table class. - --no-test Do not generate a test case skeleton. - --no-validation Disable generating validation rules. - --plugin, -p Plugin to bake into. - --primary-key The primary key if you would like to manually set - one. Can be a comma separated list if you are - using a composite primary key. - --quiet, -q Enable quiet output. - --table The table name to use if you have - non-conventional table names. - --theme, -t The theme to use when baking code. - --verbose, -v Enable verbose output. - - Arguments: - - name Name of the model to bake (without the Table suffix). You can use - Plugin.name to bake plugin models. (optional) - - Omitting all arguments and options will list the table names you can - generate models for. - - - -Temas para o Bake -================= - -A opção de tema é comum a todos os comandos do Bake e permite mudar os arquivos de modelo usados por ele. Para criar seus próprios modelos, veja a -:ref:`documentação de criação de temas para o Bake `. - -.. meta:: - :title lang=pt: Geração de código com bake - :keywords lang=pt: command line interface,functional application,database,database configuration,bash script,basic ingredients,project,model,path path,code generation,scaffolding,windows users,configuration file,few minutes,config,iew,shell,models,running,mysql diff --git a/app/vendor/cakephp/bake/docs/public/favicon/apple-touch-icon.png b/app/vendor/cakephp/bake/docs/public/favicon/apple-touch-icon.png new file mode 100644 index 000000000..c6d073d7b Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/favicon/apple-touch-icon.png differ diff --git a/app/vendor/cakephp/bake/docs/public/favicon/favicon-96x96.png b/app/vendor/cakephp/bake/docs/public/favicon/favicon-96x96.png new file mode 100644 index 000000000..6642e0cda Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/favicon/favicon-96x96.png differ diff --git a/app/vendor/cakephp/bake/docs/public/favicon/favicon.ico b/app/vendor/cakephp/bake/docs/public/favicon/favicon.ico new file mode 100644 index 000000000..405aa94ce Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/favicon/favicon.ico differ diff --git a/app/vendor/cakephp/bake/docs/public/favicon/favicon.svg b/app/vendor/cakephp/bake/docs/public/favicon/favicon.svg new file mode 100644 index 000000000..805ef4b8f --- /dev/null +++ b/app/vendor/cakephp/bake/docs/public/favicon/favicon.svg @@ -0,0 +1,3 @@ + \ No newline at end of file diff --git a/app/vendor/cakephp/bake/docs/public/favicon/site.webmanifest b/app/vendor/cakephp/bake/docs/public/favicon/site.webmanifest new file mode 100644 index 000000000..4f23fb31d --- /dev/null +++ b/app/vendor/cakephp/bake/docs/public/favicon/site.webmanifest @@ -0,0 +1,21 @@ +{ + "name": "CakePHP", + "short_name": "CakePHP", + "icons": [ + { + "src": "/favicon/web-app-manifest-192x192.png", + "sizes": "192x192", + "type": "image/png", + "purpose": "maskable" + }, + { + "src": "/favicon/web-app-manifest-512x512.png", + "sizes": "512x512", + "type": "image/png", + "purpose": "maskable" + } + ], + "theme_color": "#ffffff", + "background_color": "#ffffff", + "display": "standalone" +} \ No newline at end of file diff --git a/app/vendor/cakephp/bake/docs/public/favicon/web-app-manifest-192x192.png b/app/vendor/cakephp/bake/docs/public/favicon/web-app-manifest-192x192.png new file mode 100644 index 000000000..b5df2990b Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/favicon/web-app-manifest-192x192.png differ diff --git a/app/vendor/cakephp/bake/docs/public/favicon/web-app-manifest-512x512.png b/app/vendor/cakephp/bake/docs/public/favicon/web-app-manifest-512x512.png new file mode 100644 index 000000000..6a522de35 Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/favicon/web-app-manifest-512x512.png differ diff --git a/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.eot b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.eot new file mode 100644 index 000000000..0800d1e7d Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.eot differ diff --git a/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.svg b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.svg new file mode 100644 index 000000000..d2afda5e2 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.svg @@ -0,0 +1,56 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.ttf b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.ttf new file mode 100644 index 000000000..78ad6c884 Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.ttf differ diff --git a/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.woff b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.woff new file mode 100644 index 000000000..a95e1b38b Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.woff differ diff --git a/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.woff2 b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.woff2 new file mode 100644 index 000000000..2cd9fdd0e Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/fonts/cakedingbats-webfont.woff2 differ diff --git a/app/vendor/cakephp/bake/docs/public/history-panel-use.mp4 b/app/vendor/cakephp/bake/docs/public/history-panel-use.mp4 new file mode 100644 index 000000000..d87dc65ab Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/history-panel-use.mp4 differ diff --git a/app/vendor/cakephp/bake/docs/public/history-panel.png b/app/vendor/cakephp/bake/docs/public/history-panel.png new file mode 100644 index 000000000..0c6b27e20 Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/history-panel.png differ diff --git a/app/vendor/cakephp/bake/docs/public/logo.svg b/app/vendor/cakephp/bake/docs/public/logo.svg new file mode 100644 index 000000000..829c8e98d --- /dev/null +++ b/app/vendor/cakephp/bake/docs/public/logo.svg @@ -0,0 +1,27 @@ + + + + diff --git a/app/vendor/cakephp/bake/docs/public/mail-panel.mp4 b/app/vendor/cakephp/bake/docs/public/mail-panel.mp4 new file mode 100644 index 000000000..02078c858 Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/mail-panel.mp4 differ diff --git a/app/vendor/cakephp/bake/docs/public/mail-previewer.mp4 b/app/vendor/cakephp/bake/docs/public/mail-previewer.mp4 new file mode 100644 index 000000000..66f9fdb97 Binary files /dev/null and b/app/vendor/cakephp/bake/docs/public/mail-previewer.mp4 differ diff --git a/app/vendor/cakephp/bake/docs/ru/conf.py b/app/vendor/cakephp/bake/docs/ru/conf.py deleted file mode 100644 index f8a170ee5..000000000 --- a/app/vendor/cakephp/bake/docs/ru/conf.py +++ /dev/null @@ -1,9 +0,0 @@ -import sys, os - -# Append the top level directory of the docs, so we can import from the config dir. -sys.path.insert(0, os.path.abspath('..')) - -# Pull in all the configuration options defined in the global config file.. -from config.all import * - -language = 'ru' diff --git a/app/vendor/cakephp/bake/docs/ru/contents.rst b/app/vendor/cakephp/bake/docs/ru/contents.rst deleted file mode 100644 index 08c3e957c..000000000 --- a/app/vendor/cakephp/bake/docs/ru/contents.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. toctree:: - :maxdepth: 2 - :caption: CakePHP Bake - - /index - /usage - /development diff --git a/app/vendor/cakephp/bake/docs/ru/development.md b/app/vendor/cakephp/bake/docs/ru/development.md new file mode 100644 index 000000000..47dda1b25 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/ru/development.md @@ -0,0 +1,263 @@ +# Расширение возможностей Bake + +Bake имеет расширяемую архитектуру, которая позволяет вашему приложению или плагинам изменять или дополнять базовую функциональность. +Bake использует специальный класс представления и механизм шаблонизатора [Twig](https://twig.symfony.com/). + +## События Bake + +`BakeView`, как и любой другой класс представления, генерирует стандартные события, а также дополнительное событие инициализации. +Стандартные классы представления используют префикс `View.`, а `BakeView` использует префикс `Bake.`. + +Событие `initialize` можно использовать для внесения изменений, которые применяются ко всему выводу Bake. +Например, чтобы добавить helper в класс представления Bake: + +```php +on('Bake.initialize', function (Event $event) { + $view = $event->getSubject(); + + // В моих шаблонах bake разрешить использование MySpecial helper + $view->loadHelper('MySpecial', ['some' => 'config']); + + // И добавить переменную $author, чтобы она всегда была доступна + $view->set('author', 'Andy'); +}); +``` + +Если вы хотите изменить Bake из другого плагина, удобнее всего разместить события плагина в `config/bootstrap.php`. + +События Bake полезны и для небольших изменений существующих шаблонов. +Например, чтобы изменить имена переменных, используемых при генерации controller и template файлов, можно слушать `Bake.beforeRender`: + +```php +on('Bake.beforeRender', function (Event $event) { + $view = $event->getSubject(); + + // Использовать $rows для основной переменной данных в index + if ($view->get('pluralName')) { + $view->set('pluralName', 'rows'); + } + if ($view->get('pluralVar')) { + $view->set('pluralVar', 'rows'); + } + + // Использовать $theOne для основной переменной данных в view/edit + if ($view->get('singularName')) { + $view->set('singularName', 'theOne'); + } + if ($view->get('singularVar')) { + $view->set('singularVar', 'theOne'); + } +}); +``` + +Вы также можете привязать события `Bake.beforeRender` и `Bake.afterRender` к конкретному генерируемому файлу. +Например, если вы хотите добавить действия в `UsersController` при генерации из `Controller/controller.twig`: + +```php +on( + 'Bake.beforeRender.Controller.controller', + function (Event $event) { + $view = $event->getSubject(); + if ($view->viewVars['name'] == 'Users') { + // добавим действия входа и выхода в контроллер Users + $view->viewVars['actions'] = [ + 'login', + 'logout', + 'index', + 'view', + 'add', + 'edit', + 'delete', + ]; + } + } +); +``` + +Фокусируя обработчики на конкретных шаблонах Bake, вы упрощаете связанную с Bake логику событий и получаете более удобные для тестирования callback-функции. + +## Синтаксис шаблонов Bake + +Файлы шаблонов Bake используют синтаксис [Twig](https://twig.symfony.com/doc/2.x/). + +Например, при генерации shell-команды: + +```bash +bin/cake bake shell Foo +``` + +Шаблон `vendor/cakephp/bake/src/Template/Bake/Shell/shell.twig` выглядит так: + +```php +` закрывающий PHP-тег шаблона Bake. +- `<%=` короткий echo-тег шаблона Bake. +- `<%-` открывающий тег с удалением пробелов перед тегом. +- `-%>` закрывающий тег с удалением пробелов после тега. +::: + +## Создание темы Bake + +Если вы хотите изменить вывод, создаваемый командой `bake`, вы можете создать собственную тему Bake, которая позволит заменить часть или все шаблоны. + +1. Сгенерируйте новый плагин. Имя плагина станет именем темы Bake. +2. Создайте директорию `plugins/[name]/src/Template/Bake/Template/`. +3. Скопируйте нужные шаблоны из `vendor/cakephp/bake/src/Template/Bake/Template` в соответствующие файлы вашего плагина. +4. При запуске Bake используйте параметр `--theme`, чтобы указать тему. Чтобы не передавать его каждый раз, можно настроить тему по умолчанию: + +```php +Test->classSuffixes[$this->name()])) { + $this->Test->classSuffixes[$this->name()] = 'Foo'; + } + + $name = ucfirst($this->name()); + if (!isset($this->Test->classTypes[$name])) { + $this->Test->classTypes[$name] = 'Foo'; + } + + return parent::bakeTest($className); +} +``` + +- **Суффикс класса** добавляется к имени, переданному в вызове `bake`. В примере выше это создаст `ExampleFooTest.php`. +- **Тип класса** определяет подпространство имён, ведущее к файлу относительно приложения или плагина. В примере выше это создаст тест с namespace `App\Test\TestCase\Foo`. diff --git a/app/vendor/cakephp/bake/docs/ru/development.rst b/app/vendor/cakephp/bake/docs/ru/development.rst deleted file mode 100644 index 568068dbf..000000000 --- a/app/vendor/cakephp/bake/docs/ru/development.rst +++ /dev/null @@ -1,288 +0,0 @@ -Расширение возможностей Bake -############################ - -Bake имеет расширяемую архитектуру, которая позволяет вашему приложению или плагинам -измененять или добавления его базовую функциональность. Bake использует специальный -класс, который использует механизм шаблонизатора `Twig `_. - -События Bake -============ - -В качестве класса представления ``BakeView`` генерирует те же события, что и любой другой класс представления, -плюс одно дополнительное событие инициализации. Однако, в то время как классы стандартного представления используют -префикс события "View.", ``BakeView`` использует префикс события "Bake.". - -Событие initialize можно использовать для внесения изменений, которые применяются ко всем 'испеченным' -выводам, например, чтобы добавить другого помощника в класс вида bake, это событие может -использовать следующее:: - - on('Bake.initialize', function (Event $event) { - $view = $event->getSubject(); - - // В моих шаблонах bake, разрешить использование MySpecial helper - $view->loadHelper('MySpecial', ['some' => 'config']); - - // И добавьте переменную $author, чтобы она всегда была доступна - $view->set('author', 'Andy'); - - }); - -Если вы хотите изменить выпечку из другого плагина, хорошей идеей будет - поместить -события своего плагина в файл ``config/bootstrap.php``. - -События Bake могут быть полезны для внесения небольших изменений в существующие шаблоны. -Например, чтобы изменить имена переменных, используемых для выпечки файлов контроллеров/шаблонов, -можно использовать прослушивающую функцию ``Bake.beforeRender``:: - - on('Bake.beforeRender', function (Event $event) { - $view = $event->getSubject(); - - // Использовать $rows для основной переменной данных для индекса (index) - if ($view->get('pluralName')) { - $view->set('pluralName', 'rows'); - } - if ($view->get('pluralVar')) { - $view->set('pluralVar', 'rows'); - } - - // Используйте $theOne для основной переменной данных для просмотра/редактирования (view/edit) - if ($view->get('singularName')) { - $view->set('singularName', 'theOne'); - } - if ($view->get('singularVar')) { - $view->set('singularVar', 'theOne'); - } - - }); - -Вы также можете использовать события ``Bake.beforeRender`` и ``Bake.afterRender`` для -генерирования специфичного файла. Например, если вы хотите добавить определенные действия для -вашего UserController при генерации из файла **Controller/controller.twig**, -вы можете использовать следующее событие:: - - on( - 'Bake.beforeRender.Controller.controller', - function (Event $event) { - $view = $event->getSubject(); - if ($view->viewVars['name'] == 'Users') { - // добавим действия входа и выхода из системы в контроллер пользователей - $view->viewVars['actions'] = [ - 'login', - 'logout', - 'index', - 'view', - 'add', - 'edit', - 'delete' - ]; - } - } - ); - -При просмотре прослушивателей событий для конкретных шаблонов выпечки вы можете упростить -выпечку связанной логики событий и обеспечить обратные вызовы, которые легче тестировать. - -Синтаксис шаблона выпечки -========================= - -Файлы шаблонов Bake используют синтаксис шаблонизатора `Twig `__. - -Так, например, при выпечке такой оболочки: - -.. code-block:: bash - - bin/cake bake shell Foo - -Используемый шаблон (**vendor/cakephp/bake/src/Template/Bake/Shell/shell.twig**) -будет выглядеть так:: - - `` Bake шаблон закрывающего тега php - * ``<%=`` Bake шаблон php короткого php тега echo - * ``<%-`` Bake шаблон php открытия тега, удаляющего любые введённые пробелы перед тегом - * ``-%>`` Bake шаблон php закрытия тега, любые введённые пробелы после тега - -.. _creating-a-bake-theme: - -Создание темы Bake -================== - -Если вы хотите изменить результат, полученный командой "bake", вы можете -создать свою собственную тему('theme') для "bake", которая позволит вам заменить некоторые или все -шаблоны, которые испекает bake. Лучше всего сделать это так: - -#. Выпечь новый плагин. Имя плагина - это название темы 'bake' -#. Создать новую диреткорию **plugins/[name]/src/Template/Bake/Template/**. -#. Скопируйте любые шаблоны, которые вы хотите переопределить - **vendor/cakephp/bake/src/Template/Bake/Template** для сопоставления файлов с вашим плагином. -#. При запуске выпечки используйте параметр ``--theme``, чтобы указать тему выпечки которую вы - хотите использовать. Чтобы избежать необходимости указывать этот параметр в каждом вызове, вы также можете - настроить свою тему в качестве темы по умолчанию:: - - Test->classSuffixes[$this->name()])) { - $this->Test->classSuffixes[$this->name()] = 'Foo'; - } - - $name = ucfirst($this->name()); - if (!isset($this->Test->classTypes[$name])) { - $this->Test->classTypes[$name] = 'Foo'; - } - - return parent::bakeTest($className); - } - -* **Суффикс класса** будет добавлен к имени, указанному в вашем вызове ``bake``. - В предыдущем примере он создал бы файл ``ExampleFooTest.php``. - -* **Тип файла** будет использовать пространство под-пространство имён(sub-namespace), которое приведёт к файлу (относительно приложения или подключаемого модуля). В предыдущем примере, он создаст ваш тест с пространством имен ``App\Test\TestCase\Foo``. - -.. meta:: - :title lang=ru: Расширение возможностей Bake - :keywords lang=ru: интерфейс командной строки, разработка, выпечка, синтаксис шаблона выпечки, твинг, метки erb, процентные теги diff --git a/app/vendor/cakephp/bake/docs/ru/index.md b/app/vendor/cakephp/bake/docs/ru/index.md new file mode 100644 index 000000000..d330e7319 --- /dev/null +++ b/app/vendor/cakephp/bake/docs/ru/index.md @@ -0,0 +1,23 @@ +# Консоль Bake + +Консоль Bake для CakePHP помогает быстро начать разработку. +Она может создать базовые компоненты CakePHP, включая models, behaviors, views, +helpers, controllers, components, test cases, fixtures и plugins. +Bake умеет создавать не только каркас приложения, но и полностью рабочую основу за считанные минуты. + +## Установка + +Перед тем как использовать Bake, убедитесь, что он установлен в вашем приложении. +Bake распространяется как отдельный плагин, который можно установить через Composer: + +```bash +composer require --dev cakephp/bake:~1.0 +``` + +Команда выше установит Bake как зависимость для разработки. +Это значит, что Bake не будет установлен при деплое на production. + +## Карта документации + +- [Генерация кода с помощью Bake](/ru/usage) описывает запуск CLI, список задач и темы Bake. +- [Расширение возможностей Bake](/ru/development) описывает события, шаблоны, темы и добавление собственных команд. diff --git a/app/vendor/cakephp/bake/docs/ru/index.rst b/app/vendor/cakephp/bake/docs/ru/index.rst deleted file mode 100644 index 0b9c1bc80..000000000 --- a/app/vendor/cakephp/bake/docs/ru/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -Консоль Bake -############ - -Bake консоль CakePHP - это еще один инструмент для быстрой разработки на фреймворке CakePHP. -Консоль Bake может создать любой из базовых компонентов или все сразу: models, -behaviors, views, helpers, controllers, components, test cases, fixtures и plugins. -Речь идет не только о каркасе приложения: Bake консоль создает полностью функционирующее приложение всего за пару минут. - -Bake это естественный шаг для статической генерации кода. - -Установка -========= - -Перед тем, как использовать Bake, убедитесь, что он установлен в вашем приложении. -Bake это отдельный плагин и вы можете установить его с помощью Composer:: - - composer require --dev cakephp/bake:~1.0 - -Команда выше установит Bake в зависимости от разработки. -Это значит, что Bake не будет установлен, когда вы делаете деплой на продакшн сервер. - -.. meta:: - :title lang=ru: Консоль Bake - :keywords lang=ru: интерфейс командной строки,разработка,bake view, bake template syntax,erb tags,asp tags,percent tags diff --git a/app/vendor/cakephp/bake/docs/ru/usage.md b/app/vendor/cakephp/bake/docs/ru/usage.md new file mode 100644 index 000000000..97207aefd --- /dev/null +++ b/app/vendor/cakephp/bake/docs/ru/usage.md @@ -0,0 +1,117 @@ +# Генерация кода с помощью Bake + +Консоль Cake запускается с использованием PHP CLI. +Если у вас возникли проблемы с запуском скрипта, убедитесь, что: + +1. У вас установлен PHP CLI и включены нужные модули, например MySQL и `intl`. +2. Если хост базы данных указан как `localhost`, попробуйте `127.0.0.1`, потому что `localhost` может вызывать проблемы в PHP CLI. +3. В зависимости от того, как настроен ваш компьютер, вам может потребоваться выдать права на выполнение скрипта, чтобы запускать `bin/cake bake`. + +Перед запуском Bake вы должны убедиться, что у вас настроено хотя бы одно соединение с базой данных. + +При запуске без аргументов `bin/cake bake` выводит список доступных задач. +Вы должны увидеть что-то вроде: + +```bash +$ bin/cake bake + +Welcome to CakePHP v3.4.6 Console +--------------------------------------------------------------- +App : src +Path: /var/www/cakephp.dev/src/ +PHP : 5.6.20 +--------------------------------------------------------------- +The following commands can be used to generate skeleton code for your application. + +Available bake commands: + +- all +- behavior +- cell +- component +- controller +- fixture +- form +- helper +- mailer +- migration +- migration_diff +- migration_snapshot +- model +- plugin +- seed +- task +- template +- test + +By using `cake bake [name]` you can invoke a specific bake task. +``` + +Дополнительную информацию о задачах и доступных параметрах можно получить через `--help`: + +```bash +$ bin/cake bake --help + +Welcome to CakePHP v3.4.6 Console +--------------------------------------------------------------- +App : src +Path: /var/www/cakephp.dev/src/ +PHP : 5.6.20 +--------------------------------------------------------------- +The Bake script generates controllers, models and template files for +your application. If run with no command line arguments, Bake guides the +user through the class creation process. You can customize the +generation process by telling Bake where different parts of your +application are using command line arguments. + +Usage: +cake bake.bake [subcommand] [options] + +Subcommands: + +all Bake a complete MVC skeleton. +behavior Bake a behavior class file. +cell Bake a cell class file. +component Bake a component class file. +controller Bake a controller skeleton. +fixture Generate fixtures for use with the test suite. You + can use `bake fixture all` to bake all fixtures. +form Bake a form class file. +helper Bake a helper class file. +mailer Bake a mailer class file. +migration Bake migration class. +migration_diff Bake migration class. +migration_snapshot Bake migration snapshot class. +model Bake table and entity classes. +plugin Create the directory structure, AppController class + and testing setup for a new plugin. Can create + plugins in any of your bootstrapped plugin paths. +seed Bake seed class. +task Bake a task class file. +template Bake views for a controller, using built-in or + custom templates. +test Bake test case skeletons for classes. + +To see help on a subcommand use `cake bake.bake [subcommand] --help` + +Options: + +--connection, -c Database connection to use in conjunction with `bake + all`. (default: default) +--everything Bake a complete MVC skeleton, using all the available + tables. Usage: "bake all --everything" +--force, -f Force overwriting existing files without prompting. +--help, -h Display this help. +--plugin, -p Plugin to bake into. +--prefix Prefix to bake controllers and templates into. +--quiet, -q Enable quiet output. +--tablePrefix Table prefix to be used in models. +--theme, -t The theme to use when baking code. (choices: + Bake|Migrations) +--verbose, -v Enable verbose output. +``` + +## Темы Bake + +Параметр `theme` является общим для всех команд Bake и позволяет изменять файлы шаблонов, используемые при генерации. +Чтобы создать свои шаблоны, см. [Создание темы Bake](/ru/development#создание-темы-bake). diff --git a/app/vendor/cakephp/bake/docs/ru/usage.rst b/app/vendor/cakephp/bake/docs/ru/usage.rst deleted file mode 100644 index 128936141..000000000 --- a/app/vendor/cakephp/bake/docs/ru/usage.rst +++ /dev/null @@ -1,127 +0,0 @@ -Генерация кода с помощью Bake -############################# - -Консоль cake запускается с использованием PHP CLI (интерфейса командной строки). -Если у вас возникли проблемы с запуском скрипта, убедитесь, что: - -#. У вас установлен PHP CLI и что у него есть соответствующие включённые модули - (например: MySQL, intl). -#. У пользователей также могут быть проблемы, если хост базы данных является - 'localhost' вмеcто этого можно попробовать '127.0.0.1', поскольку localhost - может вызвать проблемы с PHP CLI. -#. В зависимости от того, как настроен ваш компьютер, вам может потребоваться - установить права выполнения на скрипт bash, чтобы вызвать его, используя - ``bin/cake bake``. - -Перед запуском bake вы должны убедиться, что у вас есть хотя бы одна база данных и -соединение настроено. - -При запуске без аргументов ``bin/cake bake`` выводит список доступных -заданий. Вы должны увидеть что-то вроде:: - - $ bin/cake bake - - Welcome to CakePHP v3.4.6 Console - --------------------------------------------------------------- - App : src - Path: /var/www/cakephp.dev/src/ - PHP : 5.6.20 - --------------------------------------------------------------- - The following commands can be used to generate skeleton code for your application. - - Available bake commands: - - - all - - behavior - - cell - - component - - controller - - fixture - - form - - helper - - mailer - - migration - - migration_diff - - migration_snapshot - - model - - plugin - - seed - - task - - template - - test - - By using `cake bake [name]` you can invoke a specific bake task. - -Вы можете получить больше дополнительной информации о том, что делает каждая задача, и какие параметры -доступны, если используете ключ ``--help``:: - - $ bin/cake bake --help - - Welcome to CakePHP v3.4.6 Console - --------------------------------------------------------------- - App : src - Path: /var/www/cakephp.dev/src/ - PHP : 5.6.20 - --------------------------------------------------------------- - The Bake script generates controllers, models and template files for - your application. If run with no command line arguments, Bake guides the - user through the class creation process. You can customize the - generation process by telling Bake where different parts of your - application are using command line arguments. - - Usage: - cake bake.bake [subcommand] [options] - - Subcommands: - - all Bake a complete MVC skeleton. - behavior Bake a behavior class file. - cell Bake a cell class file. - component Bake a component class file. - controller Bake a controller skeleton. - fixture Generate fixtures for use with the test suite. You - can use `bake fixture all` to bake all fixtures. - form Bake a form class file. - helper Bake a helper class file. - mailer Bake a mailer class file. - migration Bake migration class. - migration_diff Bake migration class. - migration_snapshot Bake migration snapshot class. - model Bake table and entity classes. - plugin Create the directory structure, AppController class - and testing setup for a new plugin. Can create - plugins in any of your bootstrapped plugin paths. - seed Bake seed class. - task Bake a task class file. - template Bake views for a controller, using built-in or - custom templates. - test Bake test case skeletons for classes. - - To see help on a subcommand use `cake bake.bake [subcommand] --help` - - Options: - - --connection, -c Database connection to use in conjunction with `bake - all`. (default: default) - --everything Bake a complete MVC skeleton, using all the available - tables. Usage: "bake all --everything" - --force, -f Force overwriting existing files without prompting. - --help, -h Display this help. - --plugin, -p Plugin to bake into. - --prefix Prefix to bake controllers and templates into. - --quiet, -q Enable quiet output. - --tablePrefix Table prefix to be used in models. - --theme, -t The theme to use when baking code. (choices: - Bake|Migrations) - --verbose, -v Enable verbose output. - -Темы Bake -========= - -Параметр темы является общим для всех команд bake, так же bake позволяет изменять -файлы шаблонов, используемые при 'выпечке'. Чтобы создать свои собственные шаблоны см. -:ref:`документация по созданию темы`. - -.. meta:: - :title lang=ru: Генерация кода с помощью Bake - :keywords lang=en: command line interface,functional application,database,database configuration,bash script,basic ingredients,project,model,path path,code generation,scaffolding,windows users,configuration file,few minutes,config,view,models,running,mysql diff --git a/app/vendor/cakephp/bake/phpcs.xml b/app/vendor/cakephp/bake/phpcs.xml index d17484779..16a351cd6 100644 --- a/app/vendor/cakephp/bake/phpcs.xml +++ b/app/vendor/cakephp/bake/phpcs.xml @@ -1,12 +1,15 @@ - src/ tests/ + + + + */comparisons/* tests/test_app/* diff --git a/app/vendor/cakephp/bake/phpstan.neon b/app/vendor/cakephp/bake/phpstan.neon index 32434594a..49655075a 100644 --- a/app/vendor/cakephp/bake/phpstan.neon +++ b/app/vendor/cakephp/bake/phpstan.neon @@ -2,10 +2,10 @@ includes: - phpstan-baseline.neon parameters: - level: 6 - paths: - - src/ - bootstrapFiles: - - tests/bootstrap.php - ignoreErrors: - - identifier: missingType.iterableValue + level: 8 + paths: + - src/ + bootstrapFiles: + - tests/bootstrap.php + ignoreErrors: + - identifier: missingType.iterableValue diff --git a/app/vendor/cakephp/bake/rector.php b/app/vendor/cakephp/bake/rector.php new file mode 100644 index 000000000..1aaa408d3 --- /dev/null +++ b/app/vendor/cakephp/bake/rector.php @@ -0,0 +1,81 @@ +withPaths([ + __DIR__ . '/src', + __DIR__ . '/tests', + ]) + + ->withCache( + cacheClass: FileCacheStorage::class, + cacheDirectory: $cacheDir, + ) + + ->withPhpSets() + ->withAttributesSets() + + ->withSets([ + SetList::CODE_QUALITY, + SetList::CODING_STYLE, + SetList::DEAD_CODE, + SetList::EARLY_RETURN, + SetList::INSTANCEOF, + SetList::TYPE_DECLARATION, + ]) + + ->withSkip([ + __DIR__ . '/tests/comparisons', + __DIR__ . '/tests/test_app', + + ClassPropertyAssignToConstructorPromotionRector::class, + CatchExceptionNameMatchingTypeRector::class, + ClosureToArrowFunctionRector::class, + RemoveUselessReturnTagRector::class, + ReturnTypeFromStrictFluentReturnRector::class, + NewlineAfterStatementRector::class, + StringClassNameToClassConstantRector::class, + ReturnTypeFromStrictTypedCallRector::class, + ParamTypeByMethodCallTypeRector::class, + AddFunctionVoidReturnTypeWhereNoReturnRector::class, + StringableForToStringRector::class, + CompactToVariablesRector::class, + SplitDoubleAssignRector::class, + ChangeOrIfContinueToMultiContinueRector::class, + ExplicitBoolCompareRector::class, + NewlineBeforeNewAssignSetRector::class, + SimplifyEmptyCheckOnEmptyArrayRector::class, + DisallowedEmptyRuleFixerRector::class, + EncapsedStringsToSprintfRector::class, + + // these causes problems with the testsuite + UseClassKeywordForClassNameResolutionRector::class, + FunctionFirstClassCallableRector::class, + ]); diff --git a/app/vendor/cakephp/bake/src/BakePlugin.php b/app/vendor/cakephp/bake/src/BakePlugin.php index 0b02eaad3..e2ce6b656 100644 --- a/app/vendor/cakephp/bake/src/BakePlugin.php +++ b/app/vendor/cakephp/bake/src/BakePlugin.php @@ -26,7 +26,6 @@ use Cake\Http\BaseApplication; use DirectoryIterator; use ReflectionClass; -use ReflectionException; /** * Plugin class for bake @@ -35,15 +34,11 @@ class BakePlugin extends BasePlugin { /** * Plugin name. - * - * @var string|null */ protected ?string $name = 'Bake'; /** * Load routes or not - * - * @var bool */ protected bool $routesEnabled = false; @@ -96,13 +91,13 @@ protected function discoverCommands(CommandCollection $commands): CommandCollect $pluginPath = $plugin->getClassPath(); $found = $this->findInPath($namespace, $pluginPath); - if (count($found)) { + if ($found !== []) { $commands->addMany($found); } } $found = $this->findInPath(Configure::read('App.namespace'), APP); - if (count($found)) { + if ($found !== []) { $commands->addMany($found); } @@ -140,11 +135,11 @@ protected function findInPath(string $namespace, string $path): array $class = $namespace . $item->getBasename('.php'); if (!$hasSubfolder) { - try { - $reflection = new ReflectionClass($class); - } catch (ReflectionException) { + if (!class_exists($class)) { continue; } + + $reflection = new ReflectionClass($class); if (!$reflection->isInstantiable() || !$reflection->isSubclassOf(BakeCommand::class)) { continue; } diff --git a/app/vendor/cakephp/bake/src/CodeGen/ClassBuilder.php b/app/vendor/cakephp/bake/src/CodeGen/ClassBuilder.php index 1cf858b1c..68e481e68 100644 --- a/app/vendor/cakephp/bake/src/CodeGen/ClassBuilder.php +++ b/app/vendor/cakephp/bake/src/CodeGen/ClassBuilder.php @@ -18,9 +18,6 @@ class ClassBuilder { - /** - * @var \Bake\CodeGen\ParsedClass|null - */ protected ?ParsedClass $parsedClass; /** @@ -50,7 +47,7 @@ public function getImplements(array $generated = []): array */ public function getUserConstants(array $generated = []): array { - if ($this->parsedClass === null) { + if (!$this->parsedClass instanceof ParsedClass) { return []; } @@ -65,7 +62,7 @@ public function getUserConstants(array $generated = []): array */ public function getUserProperties(array $generated = []): array { - if ($this->parsedClass === null) { + if (!$this->parsedClass instanceof ParsedClass) { return []; } @@ -80,7 +77,7 @@ public function getUserProperties(array $generated = []): array */ public function getUserFunctions(array $generated = []): array { - if ($this->parsedClass === null) { + if (!$this->parsedClass instanceof ParsedClass) { return []; } diff --git a/app/vendor/cakephp/bake/src/CodeGen/CodeParser.php b/app/vendor/cakephp/bake/src/CodeGen/CodeParser.php index c48c8eecb..d3cc0e508 100644 --- a/app/vendor/cakephp/bake/src/CodeGen/CodeParser.php +++ b/app/vendor/cakephp/bake/src/CodeGen/CodeParser.php @@ -18,6 +18,8 @@ use PhpParser\Error; use PhpParser\Node; +use PhpParser\Node\Identifier; +use PhpParser\Node\Name; use PhpParser\Node\Stmt\Class_; use PhpParser\Node\Stmt\GroupUse; use PhpParser\Node\Stmt\Namespace_; @@ -41,24 +43,12 @@ class CodeParser extends NodeVisitorAbstract */ protected const INDENT = ' '; - /** - * @var \PhpParser\Parser - */ protected Parser $parser; - /** - * @var \PhpParser\NodeTraverser - */ protected NodeTraverser $traverser; - /** - * @var string - */ protected string $fileText = ''; - /** - * @var array - */ protected array $parsed = []; /** @@ -81,7 +71,11 @@ public function parseFile(string $code): ?ParsedFile { $this->fileText = $code; try { - $this->traverser->traverse($this->parser->parse($code)); + $ast = $this->parser->parse($code); + if ($ast === null) { + return null; + } + $this->traverser->traverse($ast); } catch (Error $e) { throw new ParseException($e->getMessage(), null, $e); } @@ -172,7 +166,11 @@ public function enterNode(Node $node) throw new ParseException('Multiple constants per line are not supported, update your file'); } - $name = (string)current($constant->consts)->name; + $const = current($constant->consts); + if ($const === false) { + continue; + } + $name = (string)$const->name; $constants[$name] = $this->getNodeCode($constant); } @@ -182,7 +180,11 @@ public function enterNode(Node $node) throw new ParseException('Multiple properties per line are not supported, update your file'); } - $name = (string)current($property->props)->name; + $prop = current($property->props); + if ($prop === false) { + continue; + } + $name = (string)$prop->name; $properties[$name] = $this->getNodeCode($property); } @@ -192,7 +194,7 @@ public function enterNode(Node $node) $methods[$name] = $this->getNodeCode($method); } - $implements = array_map(function ($name) { + $implements = array_map(function (Name $name): string { return (string)$name; }, $node->implements); @@ -225,9 +227,8 @@ protected function getNodeCode(NodeAbstract $node): string $startPos = $node->getStartFilePos(); $endPos = $node->getEndFilePos(); - $code .= static::INDENT . substr($this->fileText, $startPos, $endPos - $startPos + 1); - return $code; + return $code . static::INDENT . substr($this->fileText, $startPos, $endPos - $startPos + 1); } /** @@ -243,13 +244,9 @@ protected function normalizeUse(UseItem $use, ?string $prefix = null): array } $alias = $use->alias; - if (!$alias) { + if (!$alias instanceof Identifier) { $last = strrpos($name, '\\', -1); - if ($last !== false) { - $alias = substr($name, strrpos($name, '\\', -1) + 1); - } else { - $alias = $name; - } + $alias = $last !== false ? substr($name, strrpos($name, '\\', -1) + 1) : $name; } return [(string)$alias, $name]; diff --git a/app/vendor/cakephp/bake/src/CodeGen/ColumnTypeExtractor.php b/app/vendor/cakephp/bake/src/CodeGen/ColumnTypeExtractor.php new file mode 100644 index 000000000..074cd530c --- /dev/null +++ b/app/vendor/cakephp/bake/src/CodeGen/ColumnTypeExtractor.php @@ -0,0 +1,244 @@ + + */ + protected array $columnTypes = []; + + protected bool $inInitialize = false; + + /** + * Constructor + */ + public function __construct() + { + $version = PhpVersion::fromComponents(8, 1); + $this->parser = (new ParserFactory())->createForVersion($version); + } + + /** + * Extracts column type mappings from initialize method code + * + * @param string $code The initialize method code + * @return array Map of column names to type expressions + */ + public function extract(string $code): array + { + $this->columnTypes = []; + $this->inInitialize = false; + + try { + // Wrap code in a dummy class if needed for parsing + $wrappedCode = "parser->parse($wrappedCode); + if ($ast === null) { + return []; + } + + $traverser = new NodeTraverser(); + $traverser->addVisitor($this); + $traverser->traverse($ast); + } catch (Exception) { + // If parsing fails, return empty array + return []; + } + + return $this->columnTypes; + } + + /** + * @inheritDoc + */ + public function enterNode(Node $node) + { + // Check if we're entering the initialize method + if ($node instanceof Node\Stmt\ClassMethod && $node->name->name === 'initialize') { + $this->inInitialize = true; + + return null; + } + + // Only process nodes within initialize method + if (!$this->inInitialize) { + return null; + } + + // Look for $this->getSchema()->setColumnType() calls + if ($node instanceof Expression && $node->expr instanceof MethodCall) { + $this->processMethodCall($node->expr); + } elseif ($node instanceof MethodCall) { + $this->processMethodCall($node); + } + + return null; + } + + /** + * @inheritDoc + */ + public function leaveNode(Node $node) + { + if ($node instanceof Node\Stmt\ClassMethod && $node->name->name === 'initialize') { + $this->inInitialize = false; + } + + return null; + } + + /** + * Process a method call to check if it's setColumnType + * + * @param \PhpParser\Node\Expr\MethodCall $methodCall The method call to process + * @return void + */ + protected function processMethodCall(MethodCall $methodCall): void + { + $isSetColumnTypeCall = $methodCall->name instanceof Node\Identifier + && $methodCall->name->name === 'setColumnType'; + $schemaCall = $methodCall->var; + $isSchemaMethodCall = $schemaCall instanceof MethodCall; + $hasEnoughArguments = count($methodCall->args) >= 2; + + if (!$isSetColumnTypeCall || !$isSchemaMethodCall || !$hasEnoughArguments) { + return; + } + + $isGetSchemaCall = $schemaCall->name instanceof Node\Identifier + && $schemaCall->name->name === 'getSchema'; + $isCalledOnThis = $schemaCall->var instanceof Variable + && $schemaCall->var->name === 'this'; + + if (!$isGetSchemaCall || !$isCalledOnThis) { + return; + } + + $columnArgNode = $methodCall->args[0]; + $typeArgNode = $methodCall->args[1]; + if (!$columnArgNode instanceof Node\Arg || !$typeArgNode instanceof Node\Arg) { + return; + } + + $columnArg = $columnArgNode->value; + $typeArg = $typeArgNode->value; + + $columnName = $this->getStringValue($columnArg); + if ($columnName === null) { + return; + } + + $typeExpression = $this->getTypeExpression($typeArg); + if ($typeExpression !== null) { + $this->columnTypes[$columnName] = $typeExpression; + } + } + + /** + * Get string value from a node + * + * @param \PhpParser\Node $node The node to extract string from + * @return string|null The string value or null + */ + protected function getStringValue(Node $node): ?string + { + if ($node instanceof Node\Scalar\String_) { + return $node->value; + } + + return null; + } + + /** + * Convert a type expression node to string representation + * + * @param \PhpParser\Node $node The type expression node + * @return string|null String representation of the type expression + */ + protected function getTypeExpression(Node $node): ?string + { + if ($node instanceof Node\Expr\StaticCall) { + $staticCall = $node; + $calledClass = $staticCall->class; + $calledMethod = $staticCall->name; + + $hasNamedClass = $calledClass instanceof Node\Name; + $hasIdentifierMethod = $calledMethod instanceof Node\Identifier; + if (!$hasNamedClass || !$hasIdentifierMethod) { + return null; + } + + $className = $calledClass->toString(); + $methodName = $calledMethod->name; + $isEnumTypeClass = $className === 'EnumType' || str_ends_with($className, '\\EnumType'); + $isFromMethod = $methodName === 'from'; + $hasArguments = $staticCall->args !== []; + if (!$isEnumTypeClass || !$isFromMethod || !$hasArguments) { + return null; + } + + $argNode = $staticCall->args[0]; + if (!$argNode instanceof Node\Arg) { + return null; + } + + $arg = $argNode->value; + if (!$arg instanceof Node\Expr\ClassConstFetch) { + return null; + } + + $enumClassNode = $arg->class; + $constantName = $arg->name; + $hasNamedEnumClass = $enumClassNode instanceof Node\Name; + $isClassConstant = $constantName instanceof Node\Identifier + && $constantName->name === 'class'; + if (!$hasNamedEnumClass || !$isClassConstant) { + return null; + } + + $enumClass = $enumClassNode->toString(); + + return 'EnumType::from(' . $enumClass . '::class)'; + } + + if ($node instanceof Node\Scalar\String_) { + return '"' . $node->value . '"'; + } + + return null; + } +} diff --git a/app/vendor/cakephp/bake/src/CodeGen/FileBuilder.php b/app/vendor/cakephp/bake/src/CodeGen/FileBuilder.php index 1aee4e15d..ece3c8b11 100644 --- a/app/vendor/cakephp/bake/src/CodeGen/FileBuilder.php +++ b/app/vendor/cakephp/bake/src/CodeGen/FileBuilder.php @@ -20,24 +20,12 @@ class FileBuilder { - /** - * @var \Cake\Console\ConsoleIo - */ protected ConsoleIo $io; - /** - * @var string - */ protected string $namespace; - /** - * @var \Bake\CodeGen\ParsedFile|null - */ protected ?ParsedFile $parsedFile; - /** - * @var \Bake\CodeGen\ClassBuilder - */ protected ClassBuilder $classBuilder; /** @@ -47,7 +35,7 @@ class FileBuilder */ public function __construct(ConsoleIo $io, string $namespace, ?ParsedFile $parsedFile = null) { - if ($parsedFile && $parsedFile->namespace !== $namespace) { + if ($parsedFile instanceof ParsedFile && $parsedFile->namespace !== $namespace) { throw new ParseException(sprintf( 'Existing namespace `%s` does not match expected namespace `%s`, cannot update existing file', $parsedFile->namespace, diff --git a/app/vendor/cakephp/bake/src/CodeGen/ImportHelper.php b/app/vendor/cakephp/bake/src/CodeGen/ImportHelper.php index 3b786ffd8..40308c90d 100644 --- a/app/vendor/cakephp/bake/src/CodeGen/ImportHelper.php +++ b/app/vendor/cakephp/bake/src/CodeGen/ImportHelper.php @@ -32,11 +32,7 @@ public static function normalize(array $imports): array foreach ($imports as $alias => $class) { if (is_int($alias)) { $last = strrpos($class, '\\', -1); - if ($last !== false) { - $alias = substr($class, strrpos($class, '\\', -1) + 1); - } else { - $alias = $class; - } + $alias = $last !== false ? substr($class, strrpos($class, '\\', -1) + 1) : $class; } $normalized[$alias] = $class; @@ -58,7 +54,7 @@ public static function merge(array $existing, array $imports, ?ConsoleIo $io = n $existing = static::normalize($existing); foreach (static::normalize($imports) as $alias => $class) { if (isset($existing[$alias]) && $existing[$alias] !== $class) { - if ($io) { + if ($io instanceof ConsoleIo) { $io->warning(sprintf( 'Import `%s` conflicts with existing import, discarding.', $class, @@ -68,8 +64,8 @@ public static function merge(array $existing, array $imports, ?ConsoleIo $io = n } $existingAlias = array_search($class, $existing, true); - if ($existingAlias !== false && $existingAlias != $alias) { - if ($io) { + if ($existingAlias !== false && $existingAlias !== $alias) { + if ($io instanceof ConsoleIo) { $io->warning(sprintf( 'Import `%s` conflicts with existing import, discarding.', $class, diff --git a/app/vendor/cakephp/bake/src/CodeGen/ParsedClass.php b/app/vendor/cakephp/bake/src/CodeGen/ParsedClass.php index dcb9ba9d3..28cad4ded 100644 --- a/app/vendor/cakephp/bake/src/CodeGen/ParsedClass.php +++ b/app/vendor/cakephp/bake/src/CodeGen/ParsedClass.php @@ -21,9 +21,6 @@ */ class ParsedClass { - /** - * @var string - */ public string $name; /** diff --git a/app/vendor/cakephp/bake/src/CodeGen/ParsedFile.php b/app/vendor/cakephp/bake/src/CodeGen/ParsedFile.php index 2abed81fd..185032bf6 100644 --- a/app/vendor/cakephp/bake/src/CodeGen/ParsedFile.php +++ b/app/vendor/cakephp/bake/src/CodeGen/ParsedFile.php @@ -21,9 +21,6 @@ */ class ParsedFile { - /** - * @var string - */ public string $namespace; /** @@ -41,9 +38,6 @@ class ParsedFile */ public array $constImports; - /** - * @var \Bake\CodeGen\ParsedClass - */ public ParsedClass $class; /** diff --git a/app/vendor/cakephp/bake/src/Command/AllCommand.php b/app/vendor/cakephp/bake/src/Command/AllCommand.php index 0c0465021..cd0a5993e 100644 --- a/app/vendor/cakephp/bake/src/Command/AllCommand.php +++ b/app/vendor/cakephp/bake/src/Command/AllCommand.php @@ -45,7 +45,7 @@ class AllCommand extends BakeCommand * @param \Cake\Console\ConsoleOptionParser $parser Option parser to update. * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); @@ -124,16 +124,16 @@ public function execute(Arguments $args, ConsoleIo $io): ?int } $message = sprintf('Error generating %s for %s: %s', $commandName, $table, $e->getMessage()); - $io->err('' . $message . ''); + $io->error($message); $errors++; } } } if ($errors) { - $io->out(sprintf('Bake All completed, but with %s errors.', $errors), 1, ConsoleIo::NORMAL); + $io->warning(sprintf('Bake All completed, but with %s errors.', $errors)); } else { - $io->out('Bake All complete.', 1, ConsoleIo::NORMAL); + $io->success('Bake All complete.'); } return $errors ? static::CODE_ERROR : static::CODE_SUCCESS; diff --git a/app/vendor/cakephp/bake/src/Command/BakeCommand.php b/app/vendor/cakephp/bake/src/Command/BakeCommand.php index 930ac6b95..1c783b2e6 100644 --- a/app/vendor/cakephp/bake/src/Command/BakeCommand.php +++ b/app/vendor/cakephp/bake/src/Command/BakeCommand.php @@ -27,6 +27,7 @@ use Cake\Core\ConventionsTrait; use Cake\Event\Event; use Cake\Event\EventManager; +use Cake\ORM\Locator\TableLocator; use InvalidArgumentException; use function Cake\Core\pluginSplit; @@ -43,11 +44,25 @@ abstract class BakeCommand extends Command /** * The pathFragment appended to the plugin/app path. - * - * @var string */ protected string $pathFragment; + /** + * Initialize the command. + * + * @return void + */ + public function initialize(): void + { + parent::initialize(); + + $locator = $this->getTableLocator(); + if ($locator instanceof TableLocator) { + $locator->allowFallbackClass(true); + $this->setTableLocator($locator); + } + } + /** * Get the command name. * @@ -60,7 +75,7 @@ abstract class BakeCommand extends Command public static function defaultName(): string { $name = parent::defaultName(); - if (strpos($name, 'bake_') === 0) { + if (str_starts_with($name, 'bake_')) { $name = substr($name, 5); } @@ -95,13 +110,14 @@ protected function _getName(string $name): string */ protected function getPrefix(Arguments $args): string { + /** @var string|null $prefix */ $prefix = $args->getOption('prefix'); if (!$prefix) { return ''; } $parts = explode('/', $prefix); - return implode('/', array_map([$this, '_camelize'], $parts)); + return implode('/', array_map($this->_camelize(...), $parts)); } /** @@ -180,7 +196,7 @@ protected function deleteEmptyFile(string $path, ConsoleIo $io): void { if (file_exists($path)) { unlink($path); - $io->out(sprintf('Deleted `%s`', $path), 1, ConsoleIo::NORMAL); + $io->out(sprintf('Deleted `%s`', $path)); } } @@ -196,7 +212,7 @@ protected function deleteEmptyFile(string $path, ConsoleIo $io): void */ protected function isValidColumnName(string $name): bool { - return (bool)preg_match('/^[a-zA-Z_][a-zA-Z0-9_]*$/', $name); + return (bool)preg_match('/^[a-zA-Z_]\w*$/', $name); } /** @@ -208,7 +224,12 @@ protected function isValidColumnName(string $name): bool protected function parseFile(string $path): ?ParsedFile { if (file_exists($path)) { - return (new CodeParser())->parseFile(file_get_contents($path)); + $contents = file_get_contents($path); + if ($contents === false) { + return null; + } + + return (new CodeParser())->parseFile($contents); } return null; diff --git a/app/vendor/cakephp/bake/src/Command/BehaviorCommand.php b/app/vendor/cakephp/bake/src/Command/BehaviorCommand.php index 40968e9ea..c4a06a330 100644 --- a/app/vendor/cakephp/bake/src/Command/BehaviorCommand.php +++ b/app/vendor/cakephp/bake/src/Command/BehaviorCommand.php @@ -23,8 +23,6 @@ class BehaviorCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Model/Behavior/'; diff --git a/app/vendor/cakephp/bake/src/Command/CellCommand.php b/app/vendor/cakephp/bake/src/Command/CellCommand.php index 657e738b6..c0fb6dc5f 100644 --- a/app/vendor/cakephp/bake/src/Command/CellCommand.php +++ b/app/vendor/cakephp/bake/src/Command/CellCommand.php @@ -28,8 +28,6 @@ class CellCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'View/Cell/'; @@ -87,7 +85,7 @@ public function templateData(Arguments $arguments): array * @param \Cake\Console\ConsoleIo $io The console io * @return void */ - public function bake(string $name, Arguments $args, ConsoleIo $io): void + protected function bake(string $name, Arguments $args, ConsoleIo $io): void { $this->bakeTemplate($name, $args, $io); @@ -116,7 +114,7 @@ protected function bakeTemplate(string $name, Arguments $args, ConsoleIo $io): v * @param \Cake\Console\ConsoleOptionParser $parser Parser instance * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = parent::buildOptionParser($parser); $parser->addOption('prefix', [ diff --git a/app/vendor/cakephp/bake/src/Command/CommandCommand.php b/app/vendor/cakephp/bake/src/Command/CommandCommand.php index 580508e19..8612f330c 100644 --- a/app/vendor/cakephp/bake/src/Command/CommandCommand.php +++ b/app/vendor/cakephp/bake/src/Command/CommandCommand.php @@ -26,8 +26,6 @@ class CommandCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Command/'; @@ -69,7 +67,7 @@ public function templateData(Arguments $arguments): array $data['command_name'] = Inflector::underscore(str_replace( '.', ' ', - $arguments->getArgument('name'), + $arguments->getArgument('name') ?? '', )); return $data; diff --git a/app/vendor/cakephp/bake/src/Command/CommandHelperCommand.php b/app/vendor/cakephp/bake/src/Command/CommandHelperCommand.php index 542ac1809..643ed758a 100644 --- a/app/vendor/cakephp/bake/src/Command/CommandHelperCommand.php +++ b/app/vendor/cakephp/bake/src/Command/CommandHelperCommand.php @@ -23,8 +23,6 @@ class CommandHelperCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Command/Helper/'; diff --git a/app/vendor/cakephp/bake/src/Command/ComponentCommand.php b/app/vendor/cakephp/bake/src/Command/ComponentCommand.php index 3adace9b7..af1bbe80f 100644 --- a/app/vendor/cakephp/bake/src/Command/ComponentCommand.php +++ b/app/vendor/cakephp/bake/src/Command/ComponentCommand.php @@ -23,8 +23,6 @@ class ComponentCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Controller/Component/'; diff --git a/app/vendor/cakephp/bake/src/Command/ControllerAllCommand.php b/app/vendor/cakephp/bake/src/Command/ControllerAllCommand.php index 113e90061..43ffb3ca4 100644 --- a/app/vendor/cakephp/bake/src/Command/ControllerAllCommand.php +++ b/app/vendor/cakephp/bake/src/Command/ControllerAllCommand.php @@ -30,9 +30,6 @@ class ControllerAllCommand extends BakeCommand { use LocatorAwareTrait; - /** - * @var \Bake\Command\ControllerCommand - */ protected ControllerCommand $controllerCommand; /** @@ -83,7 +80,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int * @param \Cake\Console\ConsoleOptionParser $parser The console option parser * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->controllerCommand->buildOptionParser($parser); $parser diff --git a/app/vendor/cakephp/bake/src/Command/ControllerCommand.php b/app/vendor/cakephp/bake/src/Command/ControllerCommand.php index c78bc5df4..675a255ee 100644 --- a/app/vendor/cakephp/bake/src/Command/ControllerCommand.php +++ b/app/vendor/cakephp/bake/src/Command/ControllerCommand.php @@ -31,8 +31,6 @@ class ControllerCommand extends BakeCommand { /** * Path fragment for generated code. - * - * @var string */ public string $pathFragment = 'Controller/'; @@ -84,7 +82,7 @@ public function bake(string $controllerName, Arguments $args, ConsoleIo $io): vo $actions = ['index', 'view', 'add', 'edit', 'delete']; } if ($args->getOption('actions')) { - $actions = array_map('trim', explode(',', $args->getOption('actions'))); + $actions = array_map('trim', explode(',', (string)$args->getOption('actions'))); $actions = array_filter($actions); } if (!$args->getOption('actions') && Plugin::isLoaded('Authentication') && $controllerName === 'Users') { @@ -129,6 +127,12 @@ public function bake(string $controllerName, Arguments $args, ConsoleIo $io): vo $singularHumanName = $this->_singularHumanName($controllerName); $pluralHumanName = $this->_variableName($controllerName); + // Handle cases where singular and plural are identical (e.g., "news", "sheep") + // to avoid variable collisions in generated controller code + if ($singularName === $pluralName) { + $singularName .= 'Entity'; + } + $defaultModel = sprintf('%s\Model\Table\%sTable', $namespace, $controllerName); if (!class_exists($defaultModel)) { $defaultModel = null; @@ -221,12 +225,10 @@ public function getComponents(Arguments $args): array { $components = []; if ($args->getOption('components')) { - $components = explode(',', $args->getOption('components')); + $components = explode(',', (string)$args->getOption('components')); $components = array_values(array_filter(array_map('trim', $components))); - } else { - if (Plugin::isLoaded('Authorization')) { - $components[] = 'Authorization.Authorization'; - } + } elseif (Plugin::isLoaded('Authorization')) { + $components[] = 'Authorization.Authorization'; } return $components; @@ -242,7 +244,7 @@ public function getHelpers(Arguments $args): array { $helpers = []; if ($args->getOption('helpers')) { - $helpers = explode(',', $args->getOption('helpers')); + $helpers = explode(',', (string)$args->getOption('helpers')); $helpers = array_values(array_filter(array_map('trim', $helpers))); } @@ -255,7 +257,7 @@ public function getHelpers(Arguments $args): array * @param \Cake\Console\ConsoleOptionParser $parser The console option parser * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); $parser->setDescription( diff --git a/app/vendor/cakephp/bake/src/Command/EntryCommand.php b/app/vendor/cakephp/bake/src/Command/EntryCommand.php index 87b9dd759..7f8490ad4 100644 --- a/app/vendor/cakephp/bake/src/Command/EntryCommand.php +++ b/app/vendor/cakephp/bake/src/Command/EntryCommand.php @@ -32,15 +32,11 @@ class EntryCommand extends Command implements CommandCollectionAwareInterface { /** * The command collection to get help on. - * - * @var \Cake\Console\CommandCollection */ protected CommandCollection $commands; /** * The HelpCommand to get help. - * - * @var \Cake\Console\Command\HelpCommand */ protected HelpCommand $help; @@ -82,7 +78,7 @@ public function run(array $argv, ConsoleIo $io): ?int $parser->argumentNames(), ); } catch (ConsoleException $e) { - $io->err('Error: ' . $e->getMessage()); + $io->error('Error: ' . $e->getMessage()); return static::CODE_ERROR; } @@ -109,14 +105,14 @@ public function execute(Arguments $args, ConsoleIo $io): ?int { if ($args->hasArgumentAt(0)) { $name = $args->getArgumentAt(0); - $io->err( - "Could not find bake command named `$name`." - . ' Run `bake --help` to get a list of commands.', + $io->error( + "Could not find bake command named `{$name}`." + . ' Run `bake --help` to get a list of commands.', ); return static::CODE_ERROR; } - $io->err('No command provided. Run `bake --help` to get a list of commands.'); + $io->warning('No command provided. Run `bake --help` to get a list of commands.'); return static::CODE_ERROR; } @@ -127,7 +123,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int * @param \Cake\Console\ConsoleOptionParser $parser The console option parser * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $this->help = new HelpCommand(); $parser = $this->help->buildOptionParser($parser); @@ -139,12 +135,12 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar ); $commands = []; foreach ($this->commands as $command => $class) { - if (substr($command, 0, 4) === 'bake') { + if (str_starts_with($command, 'bake')) { $parts = explode(' ', $command); // Remove `bake` array_shift($parts); - if (count($parts) === 0) { + if ($parts === []) { continue; } $commands[$command] = $class; diff --git a/app/vendor/cakephp/bake/src/Command/EnumCommand.php b/app/vendor/cakephp/bake/src/Command/EnumCommand.php index b1f02f039..5eee0d0ef 100644 --- a/app/vendor/cakephp/bake/src/Command/EnumCommand.php +++ b/app/vendor/cakephp/bake/src/Command/EnumCommand.php @@ -30,8 +30,6 @@ class EnumCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Model/Enum/'; @@ -92,7 +90,7 @@ public function templateData(Arguments $arguments): array * @param \Cake\Console\ConsoleOptionParser $parser The option parser to update. * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); @@ -141,7 +139,7 @@ protected function formatCases(array $cases): array foreach ($cases as $case => $value) { $case = Inflector::camelize(Inflector::underscore($case)); if (is_string($value)) { - $value = '\'' . $value . '\''; + $value = "'" . $value . "'"; } $formatted[] = 'case ' . $case . ' = ' . $value . ';'; } diff --git a/app/vendor/cakephp/bake/src/Command/FixtureAllCommand.php b/app/vendor/cakephp/bake/src/Command/FixtureAllCommand.php index 83de359c3..241e7277c 100644 --- a/app/vendor/cakephp/bake/src/Command/FixtureAllCommand.php +++ b/app/vendor/cakephp/bake/src/Command/FixtureAllCommand.php @@ -44,7 +44,7 @@ public static function defaultName(): string * @param \Cake\Console\ConsoleOptionParser $parser The parser to update * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); @@ -83,7 +83,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $this->extractCommonProperties($args); /** @var \Cake\Database\Connection $connection */ - $connection = ConnectionManager::get($args->getOption('connection') ?? 'default'); + $connection = ConnectionManager::get((string)($args->getOption('connection') ?: 'default')); $scanner = new TableScanner($connection); $fixture = new FixtureCommand(); diff --git a/app/vendor/cakephp/bake/src/Command/FixtureCommand.php b/app/vendor/cakephp/bake/src/Command/FixtureCommand.php index b461cef26..1ae33678d 100644 --- a/app/vendor/cakephp/bake/src/Command/FixtureCommand.php +++ b/app/vendor/cakephp/bake/src/Command/FixtureCommand.php @@ -62,7 +62,7 @@ public function getPath(Arguments $args): string * @param \Cake\Console\ConsoleOptionParser $parser Option parser to update. * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); @@ -122,7 +122,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int return static::CODE_SUCCESS; } - $table = $args->getOption('table') ?? ''; + $table = (string)$args->getOption('table'); $model = $this->_camelize($name); $this->bake($model, $table, $args, $io); @@ -163,7 +163,7 @@ protected function bake(string $model, string $useTable, Arguments $args, Consol try { $data = $this->readSchema($model, $useTable); - } catch (CakeException $e) { + } catch (CakeException) { $this->getTableLocator()->remove($model); $useTable = Inflector::underscore($model); $table = $useTable; @@ -269,7 +269,7 @@ public function generateFixtureFile(Arguments $args, ConsoleIo $io, string $mode ->set($vars) ->generate('Bake.tests/fixture'); - $io->out("\n" . sprintf('Baking test fixture for %s...', $model), 1, ConsoleIo::NORMAL); + $io->out("\n" . sprintf('Baking test fixture for %s...', $model)); $io->createFile($path . $filename, $contents, $this->force); $emptyFile = $path . '.gitkeep'; $this->deleteEmptyFile($emptyFile, $io); @@ -285,19 +285,22 @@ protected function _generateSchema(TableSchemaInterface $table): string { $cols = $indexes = $constraints = []; foreach ($table->columns() as $field) { + /** @var array $fieldData */ $fieldData = $table->getColumn($field); $properties = implode(', ', $this->_values($fieldData)); - $cols[] = " '$field' => [$properties],"; + $cols[] = " '{$field}' => [{$properties}],"; } foreach ($table->indexes() as $index) { + /** @var array $fieldData */ $fieldData = $table->getIndex($index); $properties = implode(', ', $this->_values($fieldData)); - $indexes[] = " '$index' => [$properties],"; + $indexes[] = " '{$index}' => [{$properties}],"; } foreach ($table->constraints() as $index) { + /** @var array $fieldData */ $fieldData = $table->getConstraint($index); $properties = implode(', ', $this->_values($fieldData)); - $constraints[] = " '$index' => [$properties],"; + $constraints[] = " '{$index}' => [{$properties}],"; } $options = $this->_values($table->getOptions()); @@ -315,7 +318,7 @@ protected function _generateSchema(TableSchemaInterface $table): string $content .= " '_options' => [\n" . implode(",\n", $options) . "\n ],\n"; } - return "[\n$content ]"; + return "[\n{$content} ]"; } /** @@ -336,11 +339,7 @@ protected function _values(array $values): array if ($val === 'NULL') { $val = 'null'; } - if (!is_numeric($key)) { - $vals[] = "'{$key}' => {$val}"; - } else { - $vals[] = "{$val}"; - } + $vals[] = is_numeric($key) ? "{$val}" : "'{$key}' => {$val}"; } } @@ -360,6 +359,7 @@ protected function _generateRecords(TableSchemaInterface $table, int $recordCoun for ($i = 0; $i < $recordCount; $i++) { $record = []; foreach ($table->columns() as $field) { + /** @var array $fieldInfo */ $fieldInfo = $table->getColumn($field); $insert = ''; switch ($fieldInfo['type']) { @@ -421,7 +421,7 @@ protected function _generateRecords(TableSchemaInterface $table, int $recordCoun $insert = Text::uuid(); break; } - if (str_starts_with($fieldInfo['type'], 'enum-')) { + if (str_starts_with((string)$fieldInfo['type'], 'enum-')) { $insert = null; if ($fieldInfo['default'] || $fieldInfo['null'] === false) { $dbType = TypeFactory::build($fieldInfo['type']); diff --git a/app/vendor/cakephp/bake/src/Command/FormCommand.php b/app/vendor/cakephp/bake/src/Command/FormCommand.php index af9382591..95b680e8c 100644 --- a/app/vendor/cakephp/bake/src/Command/FormCommand.php +++ b/app/vendor/cakephp/bake/src/Command/FormCommand.php @@ -23,8 +23,6 @@ class FormCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Form/'; diff --git a/app/vendor/cakephp/bake/src/Command/HelperCommand.php b/app/vendor/cakephp/bake/src/Command/HelperCommand.php index 41a749558..81c43f5f4 100644 --- a/app/vendor/cakephp/bake/src/Command/HelperCommand.php +++ b/app/vendor/cakephp/bake/src/Command/HelperCommand.php @@ -23,8 +23,6 @@ class HelperCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'View/Helper/'; diff --git a/app/vendor/cakephp/bake/src/Command/MailerCommand.php b/app/vendor/cakephp/bake/src/Command/MailerCommand.php index beba98758..6cd9d187e 100644 --- a/app/vendor/cakephp/bake/src/Command/MailerCommand.php +++ b/app/vendor/cakephp/bake/src/Command/MailerCommand.php @@ -26,8 +26,6 @@ class MailerCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Mailer/'; @@ -63,7 +61,7 @@ public function template(): string * @param \Cake\Console\ConsoleIo $io The console io * @return void */ - public function bake(string $name, Arguments $args, ConsoleIo $io): void + protected function bake(string $name, Arguments $args, ConsoleIo $io): void { parent::bake($name, $args, $io); } diff --git a/app/vendor/cakephp/bake/src/Command/MiddlewareCommand.php b/app/vendor/cakephp/bake/src/Command/MiddlewareCommand.php index 9d376cd45..499c579b4 100644 --- a/app/vendor/cakephp/bake/src/Command/MiddlewareCommand.php +++ b/app/vendor/cakephp/bake/src/Command/MiddlewareCommand.php @@ -23,8 +23,6 @@ class MiddlewareCommand extends SimpleBakeCommand { /** * Task name used in path generation. - * - * @var string */ public string $pathFragment = 'Middleware/'; diff --git a/app/vendor/cakephp/bake/src/Command/ModelAllCommand.php b/app/vendor/cakephp/bake/src/Command/ModelAllCommand.php index a65f696cd..2bbae1a72 100644 --- a/app/vendor/cakephp/bake/src/Command/ModelAllCommand.php +++ b/app/vendor/cakephp/bake/src/Command/ModelAllCommand.php @@ -30,9 +30,6 @@ class ModelAllCommand extends BakeCommand { use LocatorAwareTrait; - /** - * @var \Bake\Command\ModelCommand - */ protected ModelCommand $modelCommand; /** @@ -60,7 +57,7 @@ public function initialize(): void * @param \Cake\Console\ConsoleOptionParser $parser The parser to configure * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->modelCommand->buildOptionParser($parser); $parser diff --git a/app/vendor/cakephp/bake/src/Command/ModelCommand.php b/app/vendor/cakephp/bake/src/Command/ModelCommand.php index 48c45204a..26e06102f 100644 --- a/app/vendor/cakephp/bake/src/Command/ModelCommand.php +++ b/app/vendor/cakephp/bake/src/Command/ModelCommand.php @@ -16,7 +16,9 @@ */ namespace Bake\Command; +use Bake\CodeGen\ColumnTypeExtractor; use Bake\CodeGen\FileBuilder; +use Bake\CodeGen\ParsedFile; use Bake\Utility\Model\EnumParser; use Bake\Utility\TableScanner; use Cake\Console\Arguments; @@ -44,8 +46,6 @@ class ModelCommand extends BakeCommand { /** * path to Model directory - * - * @var string */ public string $pathFragment = 'Model/'; @@ -53,8 +53,6 @@ class ModelCommand extends BakeCommand * Table prefix * * Can be replaced in application subclasses if necessary - * - * @var string */ public string $tablePrefix = ''; @@ -256,9 +254,7 @@ public function getAssociations(Table $table, Arguments $args, ConsoleIo $io): a $associations = $this->findHasMany($table, $associations); $associations = $this->findBelongsToMany($table, $associations); - $associations = $this->ensureAliasUniqueness($associations); - - return $associations; + return $this->ensureAliasUniqueness($associations); } /** @@ -274,7 +270,7 @@ public function getAssociations(Table $table, Arguments $args, ConsoleIo $io): a */ public function applyAssociations(Table $model, array $associations): void { - if (get_class($model) !== Table::class) { + if ($model::class !== Table::class) { return; } @@ -314,7 +310,7 @@ public function getAssociationInfo(Table $table): array foreach ($table->associations() as $association) { /** @var \Cake\ORM\Association $association */ - $tableClass = get_class($association->getTarget()); + $tableClass = $association->getTarget()::class; if ($tableClass === Table::class) { $namespace = $appNamespace; @@ -324,7 +320,7 @@ public function getAssociationInfo(Table $table): array $namespace = $plugin; } - $namespace = str_replace('/', '\\', trim($namespace, '\\')); + $namespace = str_replace('/', '\\', trim((string)$namespace, '\\')); $tableClass = $namespace . '\Model\Table\\' . $className . 'Table'; } @@ -373,10 +369,10 @@ public function findBelongsTo(Table $model, array $associations, ?Arguments $arg $tables = $this->listAll(); // Check if association model could not be instantiated as a subclass but a generic Table instance instead if ( - get_class($associationTable) === Table::class && + $associationTable::class === Table::class && !in_array(Inflector::tableize($tmpModelName), $tables, true) ) { - $allowAliasRelations = $args && $args->getOption('skip-relation-check'); + $allowAliasRelations = $args instanceof Arguments && $args->getOption('skip-relation-check'); $found = $this->findTableReferencedBy($schema, $fieldName); if ($found) { $className = ($this->plugin ? $this->plugin . '.' : '') . Inflector::camelize($found); @@ -391,7 +387,8 @@ public function findBelongsTo(Table $model, array $associations, ?Arguments $arg if ($className && $className !== $tmpModelName) { $assoc['className'] = $className; } - if ($schema->getColumn($fieldName)['null'] === false) { + $columnInfo = $schema->getColumn($fieldName); + if ($columnInfo !== null && ($columnInfo['null'] ?? true) === false) { $assoc['joinType'] = 'INNER'; } } @@ -423,7 +420,7 @@ public function findTableReferencedBy(TableSchemaInterface $schema, string $keyF foreach ($schema->constraints() as $constraint) { $constraintInfo = $schema->getConstraint($constraint); - if (!in_array($keyField, $constraintInfo['columns'])) { + if (!in_array($keyField, $constraintInfo['columns'] ?? [])) { continue; } @@ -431,8 +428,8 @@ public function findTableReferencedBy(TableSchemaInterface $schema, string $keyF continue; } $length = $this->tablePrefix ? mb_strlen($this->tablePrefix) : 0; - if ($length > 0 && mb_substr($constraintInfo['references'][0], 0, $length) === $this->tablePrefix) { - return mb_substr($constraintInfo['references'][0], $length); + if ($length > 0 && mb_substr((string)$constraintInfo['references'][0], 0, $length) === $this->tablePrefix) { + return mb_substr((string)$constraintInfo['references'][0], $length); } return $constraintInfo['references'][0]; @@ -483,8 +480,9 @@ public function hasUniqueConstraintFor(TableSchemaInterface $schema, string $key foreach ($schema->constraints() as $constraint) { $constraintInfo = $schema->getConstraint($constraint); if ( - $constraintInfo['type'] === TableSchema::CONSTRAINT_UNIQUE && - $constraintInfo['columns'] === [$keyField] + $constraintInfo !== null && + ($constraintInfo['type'] ?? null) === TableSchema::CONSTRAINT_UNIQUE && + ($constraintInfo['columns'] ?? []) === [$keyField] ) { return true; } @@ -641,15 +639,15 @@ public function findBelongsToMany(Table $model, array $associations): array * * @param \Cake\ORM\Table $model The model to introspect. * @param \Cake\Console\Arguments $args CLI Arguments - * @return array|string|null + * @return array|string */ - public function getDisplayField(Table $model, Arguments $args): array|string|null + public function getDisplayField(Table $model, Arguments $args): array|string { if ($args->getOption('display-field')) { return (string)$args->getOption('display-field'); } - return $model->getDisplayField(); + return $model->getDisplayField() ?? []; } /** @@ -662,7 +660,7 @@ public function getDisplayField(Table $model, Arguments $args): array|string|nul public function getPrimaryKey(Table $model, Arguments $args): array { if ($args->getOption('primary-key')) { - $fields = explode(',', $args->getOption('primary-key')); + $fields = explode(',', (string)$args->getOption('primary-key')); return array_values(array_filter(array_map('trim', $fields))); } @@ -701,6 +699,7 @@ public function getEntityPropertySchema(Table $model): array $schema = $model->getSchema(); foreach ($schema->columns() as $column) { + /** @var array $columnSchema */ $columnSchema = $schema->getColumn($column); $properties[$column] = [ @@ -720,7 +719,7 @@ public function getEntityPropertySchema(Table $model): array if ($plugin !== null) { $namespace = $plugin; } - $namespace = str_replace('/', '\\', trim($namespace, '\\')); + $namespace = str_replace('/', '\\', trim((string)$namespace, '\\')); $entityClass = $this->_entityName($association->getTarget()->getAlias()); $entityClass = '\\' . $namespace . '\Model\Entity\\' . $entityClass; @@ -756,7 +755,7 @@ public function getFields(Table $table, Arguments $args): array|false|null return false; } if ($args->getOption('fields')) { - $fields = explode(',', $args->getOption('fields')); + $fields = explode(',', (string)$args->getOption('fields')); return array_values(array_filter(array_map('trim', $fields))); } @@ -785,7 +784,7 @@ public function getHiddenFields(Table $model, Arguments $args): array return []; } if ($args->getOption('hidden')) { - $fields = explode(',', $args->getOption('hidden')); + $fields = explode(',', (string)$args->getOption('hidden')); return array_values(array_filter(array_map('trim', $fields))); } @@ -890,9 +889,9 @@ public function fieldValidation( $rules['date'] = []; } elseif ($metaData['type'] === 'time') { $rules['time'] = []; - } elseif (strpos($metaData['type'], 'datetime') === 0) { + } elseif (str_starts_with((string)$metaData['type'], 'datetime')) { $rules['dateTime'] = []; - } elseif (strpos($metaData['type'], 'timestamp') === 0) { + } elseif (str_starts_with((string)$metaData['type'], 'timestamp')) { $rules['dateTime'] = []; } elseif ($metaData['type'] === 'inet') { $rules['ip'] = []; @@ -931,8 +930,9 @@ public function fieldValidation( } foreach ($schema->constraints() as $constraint) { + /** @var array $constraint */ $constraint = $schema->getConstraint($constraint); - if (!in_array($fieldName, $constraint['columns'], true) || count($constraint['columns']) > 1) { + if (!in_array($fieldName, $constraint['columns'] ?? [], true) || count($constraint['columns']) > 1) { continue; } @@ -1009,6 +1009,7 @@ public function getRules(Table $model, array $associations, Arguments $args): ar $uniqueConstraintsColumns = []; foreach ($schema->constraints() as $name) { + /** @var array $constraint */ $constraint = $schema->getConstraint($name); if ($constraint['type'] !== TableSchema::CONSTRAINT_UNIQUE) { continue; @@ -1027,11 +1028,22 @@ public function getRules(Table $model, array $associations, Arguments $args): ar } } - $uniqueRules[] = ['name' => 'isUnique', 'fields' => $constraintFields, 'options' => $options]; + $rule = ['name' => 'isUnique', 'fields' => $constraintFields, 'options' => $options]; + + // Add descriptive message for composite unique constraints + if (count($constraintFields) > 1) { + $rule['message'] = sprintf( + 'This combination of %s and %s already exists', + implode(', ', array_slice($constraintFields, 0, -1)), + end($constraintFields), + ); + } + + $uniqueRules[] = $rule; } $possiblyUniqueColumns = ['username', 'login']; - if (in_array($model->getAlias(), ['Users', 'Accounts'])) { + if (in_array($model->getAlias(), ['Users', 'Accounts'], true)) { $possiblyUniqueColumns[] = 'email'; } @@ -1115,7 +1127,7 @@ public function getCounterCache(Table $model): array try { $otherSchema = $otherModel->getSchema(); - } catch (DatabaseException $e) { + } catch (DatabaseException) { continue; } @@ -1146,7 +1158,7 @@ public function bakeEntity(Table $model, array $data, Arguments $args, ConsoleIo } $name = $this->_entityName($model->getAlias()); - $io->out("\n" . sprintf('Baking entity class for %s...', $name), 1, ConsoleIo::NORMAL); + $io->out("\n" . sprintf('Baking entity class for %s...', $name)); $namespace = Configure::read('App.namespace'); $pluginPath = ''; @@ -1198,7 +1210,7 @@ public function bakeTable(Table $model, array $data, Arguments $args, ConsoleIo } $name = $model->getAlias(); - $io->out("\n" . sprintf('Baking table class for %s...', $name), 1, ConsoleIo::NORMAL); + $io->out("\n" . sprintf('Baking table class for %s...', $name)); $namespace = Configure::read('App.namespace'); $pluginPath = ''; @@ -1210,11 +1222,24 @@ public function bakeTable(Table $model, array $data, Arguments $args, ConsoleIo $filename = $path . 'Table' . DS . $name . 'Table.php'; $parsedFile = null; + $customColumnTypes = []; if ($args->getOption('update')) { $parsedFile = $this->parseFile($filename); + // Extract custom column types from existing file + if ($parsedFile instanceof ParsedFile && isset($parsedFile->class->methods['initialize'])) { + $customColumnTypes = $this->extractCustomColumnTypes($parsedFile->class->methods['initialize']); + } } $entity = $this->_entityName($model->getAlias()); + $enums = $this->enums($model, $entity, $namespace); + + // Merge custom column types with generated enums + // Remove custom types that are now handled by enums + foreach ($enums as $field => $enumClass) { + unset($customColumnTypes[$field]); + } + $data += [ 'plugin' => $this->plugin, 'pluginPath' => $pluginPath, @@ -1228,7 +1253,8 @@ public function bakeTable(Table $model, array $data, Arguments $args, ConsoleIo 'validation' => [], 'rulesChecker' => [], 'behaviors' => [], - 'enums' => $this->enums($model, $entity, $namespace), + 'enums' => $enums, + 'customColumnTypes' => $customColumnTypes, 'connection' => $this->connection, 'fileBuilder' => new FileBuilder($io, "{$namespace}\Model\Table", $parsedFile), ]; @@ -1237,7 +1263,7 @@ public function bakeTable(Table $model, array $data, Arguments $args, ConsoleIo ->set($data) ->generate('Bake.Model/table'); - $this->writefile($io, $filename, $contents, $this->force); + $this->writeFile($io, $filename, $contents, $this->force); // Work around composer caching that classes/files do not exist. // Check for the file as it might not exist in tests. @@ -1307,7 +1333,7 @@ public function getTable(string $name, Arguments $args): string * @param \Cake\Console\ConsoleOptionParser $parser The parser to configure * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); @@ -1318,7 +1344,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar 'You can use Plugin.name to bake plugin models.', ])->addOption('update', [ 'boolean' => true, - 'help' => 'Update generated methods in existing files. If the file doesn\'t exist it will be created.', + 'help' => "Update generated methods in existing files. If the file doesn't exist it will be created.", ])->addOption('table', [ 'help' => 'The table name to use if you have non-conventional table names.', ])->addOption('no-entity', [ @@ -1418,9 +1444,6 @@ public function bakeTest(string $className, Arguments $args, ConsoleIo $io): voi } /** - * @param \Cake\ORM\Table $table - * @param string $entity - * @param string $namespace * @return array */ protected function enums(Table $table, string $entity, string $namespace): array @@ -1442,7 +1465,6 @@ protected function enums(Table $table, string $entity, string $namespace): array } /** - * @param \Cake\Database\Schema\TableSchemaInterface $schema * @return array */ protected function possibleEnumFields(TableSchemaInterface $schema): array @@ -1450,8 +1472,9 @@ protected function possibleEnumFields(TableSchemaInterface $schema): array $fields = []; foreach ($schema->columns() as $column) { + /** @var array $columnSchema */ $columnSchema = $schema->getColumn($column); - if (str_starts_with($columnSchema['type'], 'enum-')) { + if (str_starts_with((string)$columnSchema['type'], 'enum-')) { $fields[] = $column; continue; @@ -1468,7 +1491,6 @@ protected function possibleEnumFields(TableSchemaInterface $schema): array } /** - * @param \Cake\Database\Schema\TableSchemaInterface $schema * @return array */ protected function getEnumDefinitions(TableSchemaInterface $schema): array @@ -1476,21 +1498,22 @@ protected function getEnumDefinitions(TableSchemaInterface $schema): array $enums = []; foreach ($schema->columns() as $column) { + /** @var array $columnSchema */ $columnSchema = $schema->getColumn($column); if ( !in_array($columnSchema['type'], ['string', 'integer', 'tinyinteger', 'smallinteger'], true) - && !str_starts_with($columnSchema['type'], 'enum-') + && !str_starts_with((string)$columnSchema['type'], 'enum-') ) { continue; } - if (empty($columnSchema['comment']) || !str_contains($columnSchema['comment'], '[enum]')) { + if (empty($columnSchema['comment']) || !str_contains((string)$columnSchema['comment'], '[enum]')) { continue; } $enumsDefinitionString = EnumParser::parseDefinitionString($columnSchema['comment']); $isInt = in_array($columnSchema['type'], ['integer', 'tinyinteger', 'smallinteger'], true); - if (str_starts_with($columnSchema['type'], 'enum-')) { + if (str_starts_with((string)$columnSchema['type'], 'enum-')) { $dbType = TypeFactory::build($columnSchema['type']); if ($dbType instanceof EnumType) { $class = $dbType->getEnumClassName(); @@ -1516,10 +1539,7 @@ protected function getEnumDefinitions(TableSchemaInterface $schema): array } /** - * @param \Cake\ORM\Table $model * @param array $data - * @param \Cake\Console\Arguments $args - * @param \Cake\Console\ConsoleIo $io * @return void */ protected function bakeEnums(Table $model, array $data, Arguments $args, ConsoleIo $io): void @@ -1593,4 +1613,17 @@ protected function createAssociationAlias(array $association): string return $this->_modelNameFromKey($foreignKey); } + + /** + * Extract custom column type mappings from existing initialize method + * + * @param string $initializeMethod The initialize method code + * @return array Map of column names to type expressions + */ + protected function extractCustomColumnTypes(string $initializeMethod): array + { + $extractor = new ColumnTypeExtractor(); + + return $extractor->extract($initializeMethod); + } } diff --git a/app/vendor/cakephp/bake/src/Command/PluginCommand.php b/app/vendor/cakephp/bake/src/Command/PluginCommand.php index 341f73e3d..73665d06e 100644 --- a/app/vendor/cakephp/bake/src/Command/PluginCommand.php +++ b/app/vendor/cakephp/bake/src/Command/PluginCommand.php @@ -38,8 +38,6 @@ class PluginCommand extends BakeCommand { /** * Plugin path. - * - * @var string */ public string $path; @@ -56,28 +54,28 @@ public function execute(Arguments $args, ConsoleIo $io): ?int { $name = $args->getArgument('name'); if (empty($name)) { - $io->err('You must provide a plugin name in CamelCase format.'); - $io->err('To make an "MyExample" plugin, run `cake bake plugin MyExample`.'); + $io->error('You must provide a plugin name in CamelCase format.'); + $io->out('To make an "MyExample" plugin, run `cake bake plugin MyExample`.'); return static::CODE_ERROR; } $parts = explode('/', $name); - $plugin = implode('/', array_map([Inflector::class, 'camelize'], $parts)); + $plugin = implode('/', array_map(Inflector::camelize(...), $parts)); if ($args->getOption('standalone-path')) { - $this->path = $args->getOption('standalone-path'); + $this->path = (string)$args->getOption('standalone-path'); $this->path = rtrim($this->path, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR; $this->isVendor = true; if (!is_dir($this->path)) { - $io->err(sprintf('Path `%s` does not exist.', $this->path)); + $io->error(sprintf('Path `%s` does not exist.', $this->path)); return static::CODE_ERROR; } } $pluginPath = $this->_pluginPath($plugin); - if (is_dir($pluginPath)) { + if (is_dir($pluginPath) && !$args->getOption('class-only')) { $io->out(sprintf('Plugin: %s already exists, no action taken', $plugin)); $io->out(sprintf('Path: %s', $pluginPath)); @@ -105,7 +103,8 @@ public function bake(string $plugin, Arguments $args, ConsoleIo $io): ?bool { if (!$this->isVendor) { $pathOptions = App::path('plugins'); - $this->path = current($pathOptions); + $currentPath = current($pathOptions); + $this->path = $currentPath !== false ? $currentPath : ''; if (count($pathOptions) > 1) { $this->findPath($pathOptions, $io); @@ -125,11 +124,18 @@ public function bake(string $plugin, Arguments $args, ConsoleIo $io): ?bool $this->_generateFiles($plugin, $this->path, $args, $io); if (!$this->isVendor) { - $this->_modifyApplication($plugin, $io); + if (!$args->getOption('class-only')) { + $this->_modifyApplication($plugin, $io); + } $composer = $this->findComposer($args, $io); + if ($composer === false) { + $io->error('Could not find composer executable.'); + $this->abort(); + } try { + /** @var non-empty-string $cwd */ $cwd = getcwd(); // Windows makes running multiple commands at once hard. @@ -198,7 +204,7 @@ protected function _generateFiles( $package = Inflector::dasherize($vendor) . '/' . Inflector::dasherize($name); $composerConfig = json_decode( - file_get_contents(ROOT . DS . 'composer.json'), + (string)file_get_contents(ROOT . DS . 'composer.json'), true, ); @@ -219,7 +225,7 @@ protected function _generateFiles( $paths = []; if ($args->hasOption('theme')) { - $paths[] = Plugin::templatePath($args->getOption('theme')); + $paths[] = Plugin::templatePath((string)$args->getOption('theme')); } $paths = array_merge($paths, Configure::read('App.paths.templates')); @@ -247,17 +253,23 @@ protected function _generateFiles( } } + if ($args->getOption('class-only')) { + $files = array_filter($files, function ($file): bool { + return $file->getFilename() === 'Plugin.php.twig'; + }); + } + $templates = array_keys($files); } } while (!$templates); sort($templates); foreach ($templates as $template) { - $template = substr($template, strrpos($template, 'Plugin' . DIRECTORY_SEPARATOR) + 7, -4); + $template = substr((string)$template, strrpos((string)$template, 'Plugin' . DIRECTORY_SEPARATOR) + 7, -4); $template = rtrim($template, '.'); $filename = $template; - if ($filename === 'src/Plugin.php') { - $filename = 'src/' . $name . 'Plugin.php'; + if ($filename === 'src' . DIRECTORY_SEPARATOR . 'Plugin.php') { + $filename = 'src' . DIRECTORY_SEPARATOR . $name . 'Plugin.php'; } $this->_generateFile($renderer, $template, $root, $filename, $io); } @@ -346,7 +358,7 @@ public function findPath(array $pathOptions, ConsoleIo $io): void * @param \Cake\Console\ConsoleOptionParser $parser The option parser * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser->setDescription( 'Create the directory structure, AppController class and testing setup for a new plugin. ' . @@ -370,6 +382,10 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar ->addOption('standalone-path', [ 'short' => 'p', 'help' => 'Generate a standalone plugin in the provided path.', + ])->addOption('class-only', [ + 'short' => 'c', + 'boolean' => true, + 'help' => 'Generate only the plugin class.', ]); return $parser; @@ -380,7 +396,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar * * @param \Cake\Console\Arguments $args The command arguments. * @param \Cake\Console\ConsoleIo $io The console io - * @return string|bool Either the path to composer or false if it cannot be found. + * @return string|false Either the path to composer or false if it cannot be found. */ public function findComposer(Arguments $args, ConsoleIo $io): string|bool { @@ -392,7 +408,7 @@ public function findComposer(Arguments $args, ConsoleIo $io): string|bool } } $composer = false; - $path = env('PATH'); + $path = (string)env('PATH'); if (!empty($path)) { $paths = explode(PATH_SEPARATOR, $path); $composer = $this->_searchPath($paths, $io); @@ -406,7 +422,7 @@ public function findComposer(Arguments $args, ConsoleIo $io): string|bool * * @param array $path The paths to search. * @param \Cake\Console\ConsoleIo $io The console io - * @return string|bool + * @return string|false */ protected function _searchPath(array $path, ConsoleIo $io): string|bool { diff --git a/app/vendor/cakephp/bake/src/Command/SimpleBakeCommand.php b/app/vendor/cakephp/bake/src/Command/SimpleBakeCommand.php index 35527749a..a9667a226 100644 --- a/app/vendor/cakephp/bake/src/Command/SimpleBakeCommand.php +++ b/app/vendor/cakephp/bake/src/Command/SimpleBakeCommand.php @@ -78,7 +78,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $this->extractCommonProperties($args); $name = $args->getArgumentAt(0); if (empty($name)) { - $io->err('You must provide a name to bake a ' . $this->name()); + $io->error('You must provide a name to bake a ' . $this->name()); $this->abort(); } $name = $this->_getName($name); @@ -135,7 +135,7 @@ public function bakeTest(string $className, Arguments $args, ConsoleIo $io): voi * @param \Cake\Console\ConsoleOptionParser $parser Option parser to update. * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); $name = $this->name(); diff --git a/app/vendor/cakephp/bake/src/Command/TemplateAllCommand.php b/app/vendor/cakephp/bake/src/Command/TemplateAllCommand.php index 45e14ef10..0a1c72e5e 100644 --- a/app/vendor/cakephp/bake/src/Command/TemplateAllCommand.php +++ b/app/vendor/cakephp/bake/src/Command/TemplateAllCommand.php @@ -27,9 +27,6 @@ */ class TemplateAllCommand extends BakeCommand { - /** - * @var \Bake\Command\TemplateCommand - */ protected TemplateCommand $templateCommand; /** @@ -86,7 +83,7 @@ public function execute(Arguments $args, ConsoleIo $io): int * @param \Cake\Console\ConsoleOptionParser $parser The option parser to update. * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); $parser diff --git a/app/vendor/cakephp/bake/src/Command/TemplateCommand.php b/app/vendor/cakephp/bake/src/Command/TemplateCommand.php index 558187ab9..b41707df3 100644 --- a/app/vendor/cakephp/bake/src/Command/TemplateCommand.php +++ b/app/vendor/cakephp/bake/src/Command/TemplateCommand.php @@ -39,22 +39,16 @@ class TemplateCommand extends BakeCommand { /** * Name of the controller being used - * - * @var string */ public string $controllerName; /** * Classname of the controller being used - * - * @var string */ public string $controllerClass; /** * Name with plugin of the model being used - * - * @var string */ public string $modelName; @@ -74,22 +68,16 @@ class TemplateCommand extends BakeCommand /** * AssociationFilter utility - * - * @var \Bake\Utility\Model\AssociationFilter|null */ protected ?AssociationFilter $_associationFilter = null; /** * Template path. - * - * @var string */ public string $path; /** * Output extension - * - * @var string */ public string $ext = 'php'; @@ -100,7 +88,17 @@ class TemplateCommand extends BakeCommand */ public function initialize(): void { - $this->path = current(App::path('templates')); + parent::initialize(); + + $templatePaths = App::path('templates'); + if ($templatePaths === []) { + throw new RuntimeException( + 'Could not read template paths. ' . + 'Ensure `App.paths.templates` is defined in your application configuration.', + ); + } + + $this->path = current($templatePaths); } /** @@ -130,8 +128,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $template = $args->getArgument('template'); $action = $args->getArgument('action'); - $controller = $args->getOption('controller'); - $this->controller($args, $name, $controller); + $this->controller($args, $name, (string)$args->getOption('controller')); $this->model($name); if ($template && $action === null) { @@ -171,7 +168,7 @@ public function model(string $table): void $tableName = $this->_camelize($table); $plugin = $this->plugin; if ($plugin) { - $plugin = $plugin . '.'; + $plugin .= '.'; } $this->modelName = $plugin . $tableName; } @@ -213,9 +210,8 @@ public function controller(Arguments $args, string $table, ?string $controller = public function getTemplatePath(Arguments $args, ?string $container = null): string { $path = parent::getTemplatePath($args, $container); - $path .= $this->controllerName . DS; - return $path; + return $path . $this->controllerName . DS; } /** @@ -316,6 +312,12 @@ protected function _loadController(ConsoleIo $io): array $pluralVar = Inflector::variable($this->controllerName); $pluralHumanName = $this->_pluralHumanName($this->controllerName); + // Handle cases where singular and plural are identical (e.g., "news", "sheep") + // to avoid generating invalid code like `foreach ($news as $news)` + if ($singularVar === $pluralVar) { + $singularVar .= 'Entity'; + } + return compact( 'modelObject', 'modelClass', @@ -360,14 +362,14 @@ public function bake( } if (empty($content)) { // phpcs:ignore Generic.Files.LineLength - $io->err("No generated content for '{$template}.{$this->ext}', not generating template."); + $io->warning("No generated content for '{$template}.{$this->ext}', not generating template."); return; } $path = $this->getTemplatePath($args); $filename = $path . Inflector::underscore($outputFile) . '.' . $this->ext; - $io->out("\n" . sprintf('Baking `%s` view template file...', $outputFile), 1, ConsoleIo::NORMAL); + $io->out("\n" . sprintf('Baking `%s` view template file...', $outputFile)); $io->createFile($filename, $content, $this->force); } @@ -406,7 +408,7 @@ public function getContent(Arguments $args, ConsoleIo $io, string $action, ?arra } $renderer->set('indexColumns', $indexColumns); - return $renderer->generate("Bake.Template/$action"); + return $renderer->generate("Bake.Template/{$action}"); } /** @@ -415,7 +417,7 @@ public function getContent(Arguments $args, ConsoleIo $io, string $action, ?arra * @param \Cake\Console\ConsoleOptionParser $parser The option parser to update. * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); @@ -448,7 +450,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar */ protected function _filteredAssociations(Table $model): array { - if ($this->_associationFilter === null) { + if (!$this->_associationFilter instanceof AssociationFilter) { $this->_associationFilter = new AssociationFilter(); } diff --git a/app/vendor/cakephp/bake/src/Command/TestCommand.php b/app/vendor/cakephp/bake/src/Command/TestCommand.php index dd5e6c301..c62c4c191 100644 --- a/app/vendor/cakephp/bake/src/Command/TestCommand.php +++ b/app/vendor/cakephp/bake/src/Command/TestCommand.php @@ -55,6 +55,7 @@ class TestCommand extends BakeCommand 'Command' => 'Command', 'CommandHelper' => 'Command\Helper', 'Middleware' => 'Middleware', + 'Class' => '', ]; /** @@ -75,6 +76,7 @@ class TestCommand extends BakeCommand 'Command' => 'Command', 'CommandHelper' => 'Helper', 'Middleware' => 'Middleware', + 'Class' => '', ]; /** @@ -108,7 +110,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int return null; } - $type = $this->normalize($args->getArgument('type')); + $type = $this->normalize((string)$args->getArgument('type')); if ($args->getOption('all')) { $this->_bakeAll($type, $args, $io); @@ -120,11 +122,15 @@ public function execute(Arguments $args, ConsoleIo $io): ?int return null; } - $name = $args->getArgument('name'); + $name = (string)$args->getArgument('name'); $name = $this->_getName($name); - if ($this->bake($type, $name, $args, $io)) { - $io->out('Done'); + $result = $this->bake($type, $name, $args, $io); + if ($result === static::CODE_ERROR) { + return static::CODE_ERROR; + } + if ($result) { + $io->success('Done'); } return static::CODE_SUCCESS; @@ -143,7 +149,7 @@ protected function outputTypeChoices(ConsoleIo $io): void 2, ); $i = 0; - foreach ($this->classTypes as $option => $package) { + foreach (array_keys($this->classTypes) as $option) { $io->out(++$i . '. ' . $option); } $io->out(''); @@ -188,13 +194,13 @@ protected function _bakeAll(string $type, Arguments $args, ConsoleIo $io): void foreach ($classes as $class) { if ($this->bake($type, $class, $args, $io)) { - $io->out('Done - ' . $class . ''); + $io->success('Done - ' . $class); } else { - $io->out('Failed - ' . $class . ''); + $io->error('Failed - ' . $class); } } - $io->out('Bake finished'); + $io->info('Bake finished'); } /** @@ -212,10 +218,26 @@ protected function _getClassOptions(string $namespace): array } $path = $base . str_replace('\\', DS, $namespace); - $files = (new Filesystem())->find($path); - foreach ($files as $fileObj) { - if ($fileObj->isFile()) { - $classes[] = substr($fileObj->getFileName(), 0, -4) ?: ''; + + // For generic Class type (empty namespace), search recursively + if ($namespace === '') { + $files = (new Filesystem())->findRecursive($path, '/\.php$/'); + foreach ($files as $fileObj) { + if ($fileObj->isFile() && $fileObj->getFileName() !== 'Application.php') { + // Build the namespace path relative to App directory + /** @var string $relativePath */ + $relativePath = str_replace($base, '', $fileObj->getPath()); + $relativePath = trim(str_replace(DIRECTORY_SEPARATOR, '\\', $relativePath), '\\'); + $className = substr((string)$fileObj->getFileName(), 0, -4) ?: ''; + $classes[] = $relativePath ? $relativePath . '\\' . $className : $className; + } + } + } else { + $files = (new Filesystem())->find($path); + foreach ($files as $fileObj) { + if ($fileObj->isFile()) { + $classes[] = substr((string)$fileObj->getFileName(), 0, -4) ?: ''; + } } } sort($classes); @@ -230,26 +252,58 @@ protected function _getClassOptions(string $namespace): array * @param string $className the 'cake name' for the class ie. Posts for the PostsController * @param \Cake\Console\Arguments $args Arguments * @param \Cake\Console\ConsoleIo $io ConsoleIo instance - * @return string|bool + * @return string|bool|int Returns the generated code as string on success, false on failure, or CODE_ERROR for validation errors */ - public function bake(string $type, string $className, Arguments $args, ConsoleIo $io): string|bool + public function bake(string $type, string $className, Arguments $args, ConsoleIo $io): string|bool|int { $type = $this->normalize($type); if (!isset($this->classSuffixes[$type]) || !isset($this->classTypes[$type])) { return false; } + // For Class type, validate that backslashes are properly escaped + if ($type === 'Class' && !str_contains($className, '\\')) { + $io->error('Class name appears to have no namespace separators.'); + $io->out(''); + $io->out('If you meant to specify a namespaced class, please use quotes:'); + $io->out(" bin/cake bake test class '{$className}'"); + $io->out(''); + $io->out('Or specify without the base namespace:'); + $io->out(' bin/cake bake test class YourNamespace\ClassName'); + + return static::CODE_ERROR; + } + $prefix = $this->getPrefix($args); $fullClassName = $this->getRealClassName($type, $className, $prefix); + // For Class type, validate that the class exists + if ($type === 'Class' && !class_exists($fullClassName)) { + $io->error("Class '{$fullClassName}' does not exist or cannot be loaded."); + $io->out(''); + $io->out('Please check:'); + $io->out(' - The class file exists in the correct location'); + $io->out(' - The class is properly autoloaded'); + $io->out(' - The namespace and class name are correct'); + + return static::CODE_ERROR; + } + + // Check if fixture factories plugin is available + $hasFixtureFactories = $this->hasFixtureFactories(); + if (!$args->getOption('no-fixture')) { - if ($args->getOption('fixtures')) { - $fixtures = array_map('trim', explode(',', $args->getOption('fixtures'))); + if ($hasFixtureFactories) { + $io->info('Fixture Factories plugin detected - skipping fixture property generation.'); + } elseif ($args->getOption('fixtures')) { + $fixtures = array_map('trim', explode(',', (string)$args->getOption('fixtures'))); $this->_fixtures = array_filter($fixtures); } elseif ($this->typeCanDetectFixtures($type) && class_exists($fullClassName)) { $io->out('Bake is detecting possible fixtures...'); $testSubject = $this->buildTestSubject($type, $fullClassName); - $this->generateFixtureList($testSubject); + if ($testSubject instanceof Table || $testSubject instanceof Controller) { + $this->generateFixtureList($testSubject); + } } } @@ -261,14 +315,20 @@ public function bake(string $type, string $className, Arguments $args, ConsoleIo [$preConstruct, $construction, $postConstruct] = $this->generateConstructor($type, $fullClassName); $uses = $this->generateUses($type, $fullClassName); - $subject = $className; - [$namespace, $className] = namespaceSplit($fullClassName); + // For generic Class type, extract just the class name for the subject + if ($type === 'Class') { + [$namespace, $className] = namespaceSplit($fullClassName); + $subject = $className; + } else { + $subject = $className; + [$namespace, $className] = namespaceSplit($fullClassName); + } $baseNamespace = Configure::read('App.namespace'); if ($this->plugin) { $baseNamespace = $this->_pluginNamespace($this->plugin); } - $subNamespace = substr($namespace, strlen($baseNamespace) + 1); + $subNamespace = substr($namespace, strlen((string)$baseNamespace) + 1); $properties = $this->generateProperties($type, $subject, $fullClassName); @@ -277,6 +337,7 @@ public function bake(string $type, string $className, Arguments $args, ConsoleIo $contents = $this->createTemplateRenderer() ->set('fixtures', $this->_fixtures) ->set('plugin', $this->plugin) + ->set('hasFixtureFactories', $hasFixtureFactories) ->set(compact( 'subject', 'className', @@ -305,6 +366,17 @@ public function bake(string $type, string $className, Arguments $args, ConsoleIo return false; } + /** + * Check if the CakePHP Fixture Factories plugin is available + * + * @return bool + */ + protected function hasFixtureFactories(): bool + { + return class_exists('CakephpFixtureFactories\Plugin') + || class_exists('CakephpFixtureFactories\CakephpFixtureFactoriesPlugin'); + } + /** * Checks whether the chosen type can find its own fixtures. * Currently only model, and controller are supported @@ -364,9 +436,20 @@ public function getRealClassName(string $type, string $class, ?string $prefix = if ($this->plugin) { $namespace = str_replace('/', '\\', $this->plugin); } + + // For generic Class type, the class name contains the full subnamespace path + if ($type === 'Class') { + // Strip base namespace if user included it + if (str_starts_with($class, $namespace . '\\')) { + $class = substr($class, strlen((string)$namespace) + 1); + } + + return $namespace . '\\' . $class; + } + $suffix = $this->classSuffixes[$type]; $subSpace = $this->mapType($type); - if ($suffix && strpos($class, $suffix) === false) { + if ($suffix && !str_contains($class, $suffix)) { $class .= $suffix; } if (in_array($type, ['Controller', 'Cell'], true) && $prefix) { @@ -398,7 +481,7 @@ public function getSubspacePath(string $type): string */ public function mapType(string $type): string { - if (empty($this->classTypes[$type])) { + if (!isset($this->classTypes[$type])) { throw new CakeException('Invalid object type: ' . $type); } @@ -409,7 +492,7 @@ public function mapType(string $type): string * Get methods declared in the class given. * No parent methods will be returned * - * @param string $className Name of class to look at. + * @param class-string $className Name of class to look at. * @return array Array of method names. * @throws \ReflectionException */ @@ -462,9 +545,9 @@ protected function _processModel(Table $subject): void $assoc = $subject->getAssociation($alias); $target = $assoc->getTarget(); $name = $target->getAlias(); - $subjectClass = get_class($subject); + $subjectClass = $subject::class; - if ($subjectClass !== Table::class && $subjectClass === get_class($target)) { + if ($subjectClass !== Table::class && $subjectClass === $target::class) { continue; } if (!isset($this->_fixtures[$name])) { @@ -484,7 +567,7 @@ protected function _processController(Controller $subject): void { try { $model = $subject->fetchTable(); - } catch (UnexpectedValueException $exception) { + } catch (UnexpectedValueException) { // No fixtures needed or possible return; } @@ -505,11 +588,7 @@ protected function _processController(Controller $subject): void */ protected function _addFixture(string $name): void { - if ($this->plugin) { - $prefix = 'plugin.' . $this->plugin . '.'; - } else { - $prefix = 'app.'; - } + $prefix = $this->plugin ? 'plugin.' . $this->plugin . '.' : 'app.'; $fixture = $prefix . $this->_fixtureName($name); $this->_fixtures[$name] = $fixture; } @@ -568,6 +647,18 @@ public function generateConstructor(string $type, string $fullClassName): array $pre .= ' $this->io = new ConsoleIo($this->stub);'; $construct = "new {$className}(\$this->io);"; } + if ($type === 'Class') { + // Check if class has required constructor parameters + if (class_exists($fullClassName)) { + $reflection = new ReflectionClass($fullClassName); + $constructor = $reflection->getConstructor(); + if (!$constructor || $constructor->getNumberOfRequiredParameters() === 0) { + $construct = "new {$className}();"; + } + } else { + $construct = "new {$className}();"; + } + } return [$pre, $construct, $post]; } @@ -618,7 +709,17 @@ public function generateProperties(string $type, string $subject, string $fullCl break; } - if (!in_array($type, ['Controller', 'Command'])) { + // Skip test subject property for Controller, Command, and Class types with required constructor params + $skipProperty = in_array($type, ['Controller', 'Command'], true); + if ($type === 'Class' && class_exists($fullClassName)) { + $reflection = new ReflectionClass($fullClassName); + $constructor = $reflection->getConstructor(); + if ($constructor && $constructor->getNumberOfRequiredParameters() > 0) { + $skipProperty = true; + } + } + + if (!$skipProperty) { $properties[] = [ 'description' => 'Test subject', 'type' => '\\' . $fullClassName, @@ -665,12 +766,11 @@ public function generateUses(string $type, string $fullClassName): array public function getBasePath(): string { $dir = 'TestCase/'; - $path = defined('TESTS') ? TESTS . $dir : ROOT . DS . 'tests' . DS . $dir; if ($this->plugin) { - $path = $this->_pluginPath($this->plugin) . 'tests/' . $dir; + return $this->_pluginPath($this->plugin) . 'tests/' . $dir; } - return $path; + return defined('TESTS') ? TESTS . $dir : ROOT . DS . 'tests' . DS . $dir; } /** @@ -689,7 +789,7 @@ public function testCaseFileName(string $type, string $className): string $namespace = $this->plugin; } - $classTail = substr($className, strlen($namespace) + 1); + $classTail = substr($className, strlen((string)$namespace) + 1); $path = $path . $classTail . 'Test.php'; return str_replace(['/', '\\'], DS, $path); @@ -701,12 +801,12 @@ public function testCaseFileName(string $type, string $className): string * @param \Cake\Console\ConsoleOptionParser $parser Option parser to update * @return \Cake\Console\ConsoleOptionParser */ - public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser + protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionParser { $parser = $this->_setCommonOptions($parser); $types = array_keys($this->classTypes); - $types = array_merge($types, array_map([$this, 'underscore'], $types)); + $types = array_merge($types, array_map($this->underscore(...), $types)); $parser->setDescription( 'Bake test case skeletons for classes.', diff --git a/app/vendor/cakephp/bake/src/Utility/CommonOptionsTrait.php b/app/vendor/cakephp/bake/src/Utility/CommonOptionsTrait.php index fde67f954..29541216d 100644 --- a/app/vendor/cakephp/bake/src/Utility/CommonOptionsTrait.php +++ b/app/vendor/cakephp/bake/src/Utility/CommonOptionsTrait.php @@ -30,24 +30,12 @@ */ trait CommonOptionsTrait { - /** - * @var string - */ public ?string $plugin = null; - /** - * @var string|null - */ public ?string $theme = null; - /** - * @var string - */ public string $connection; - /** - * @var bool - */ public bool $force = false; /** @@ -62,7 +50,7 @@ protected function extractCommonProperties(Arguments $args): void // These properties should ideally not exist, but until ConsoleOptionParser // gets validation and transform logic they will have to stay. if ($args->hasOption('plugin')) { - $plugin = $args->getOption('plugin'); + $plugin = (string)$args->getOption('plugin'); $parts = explode('/', $plugin); $this->plugin = implode('/', array_map([$this, '_camelize'], $parts)); @@ -73,9 +61,11 @@ protected function extractCommonProperties(Arguments $args): void } } - $this->theme = $args->getOption('theme'); - $this->connection = $args->getOption('connection'); - $this->force = $args->getOption('force'); + $theme = $args->getOption('theme'); + $this->theme = is_string($theme) ? $theme : null; + $connection = $args->getOption('connection'); + $this->connection = is_string($connection) ? $connection : 'default'; + $this->force = (bool)$args->getOption('force'); } /** diff --git a/app/vendor/cakephp/bake/src/Utility/Model/AssociationFilter.php b/app/vendor/cakephp/bake/src/Utility/Model/AssociationFilter.php index c6f6a47c5..db3d16923 100644 --- a/app/vendor/cakephp/bake/src/Utility/Model/AssociationFilter.php +++ b/app/vendor/cakephp/bake/src/Utility/Model/AssociationFilter.php @@ -78,11 +78,11 @@ public function filterAssociations(Table $model): array if ($type === 'HasMany' && in_array($alias, $belongsToManyJunctionsAliases)) { continue; } - $targetClass = get_class($target); + $targetClass = $target::class; [, $className] = namespaceSplit($targetClass); $navLink = true; - $modelClass = get_class($model); + $modelClass = $model::class; if ($modelClass !== Table::class && $targetClass === $modelClass) { $navLink = false; } @@ -93,6 +93,7 @@ public function filterAssociations(Table $model): array } try { + $foreignKey = (array)$assoc->getForeignKey(); $associations[$type][$assocName] = [ 'property' => $assoc->getProperty(), 'variable' => Inflector::variable($assocName), @@ -101,10 +102,10 @@ public function filterAssociations(Table $model): array 'foreignKey' => $assoc->getForeignKey(), 'alias' => $alias, 'controller' => $className, - 'fields' => $target->getSchema()->columns(), + 'fields' => array_values(array_diff($target->getSchema()->columns(), $foreignKey)), 'navLink' => $navLink, ]; - } catch (Exception $e) { + } catch (Exception) { // Do nothing it could be a bogus association name. } } diff --git a/app/vendor/cakephp/bake/src/Utility/Model/EnumParser.php b/app/vendor/cakephp/bake/src/Utility/Model/EnumParser.php index e559fe03e..ac80024b8 100644 --- a/app/vendor/cakephp/bake/src/Utility/Model/EnumParser.php +++ b/app/vendor/cakephp/bake/src/Utility/Model/EnumParser.php @@ -8,8 +8,6 @@ class EnumParser { /** - * @param string|null $casesString - * @param bool $int * @return array */ public static function parseCases(?string $casesString, bool $int): array @@ -23,9 +21,10 @@ public static function parseCases(?string $casesString, bool $int): array $definition = []; foreach ($enumCases as $k => $enumCase) { $case = $value = trim($enumCase); - if (str_contains($case, ':')) { - $value = trim(mb_substr($case, strpos($case, ':') + 1)); - $case = mb_substr($case, 0, strpos($case, ':')); + $pos = strpos($case, ':'); + if ($pos !== false) { + $value = trim(mb_substr($case, $pos + 1)); + $case = mb_substr($case, 0, $pos); } elseif ($int) { $value = $k; } @@ -33,8 +32,8 @@ public static function parseCases(?string $casesString, bool $int): array if (!preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $case)) { throw new InvalidArgumentException(sprintf('`%s` is not a valid enum case', $case)); } - if (is_string($value) && str_contains($value, '\'')) { - throw new InvalidArgumentException(sprintf('`%s` value cannot contain `\'` character', $case)); + if (is_string($value) && str_contains($value, "'")) { + throw new InvalidArgumentException(sprintf("`%s` value cannot contain `'` character", $case)); } $definition[$case] = $int ? (int)$value : $value; @@ -46,14 +45,14 @@ public static function parseCases(?string $casesString, bool $int): array /** * Parses an enum definition from a DB column comment. * - * @param string $comment * @return string */ public static function parseDefinitionString(string $comment): string { $string = trim(mb_substr($comment, strpos($comment, '[enum]') + 6)); - if (str_contains($string, ';')) { - $string = trim(mb_substr($string, 0, strpos($string, ';'))); + $pos = strpos($string, ';'); + if ($pos !== false) { + return trim(mb_substr($string, 0, $pos)); } return $string; diff --git a/app/vendor/cakephp/bake/src/Utility/Process.php b/app/vendor/cakephp/bake/src/Utility/Process.php index 78686c334..27c9cc155 100644 --- a/app/vendor/cakephp/bake/src/Utility/Process.php +++ b/app/vendor/cakephp/bake/src/Utility/Process.php @@ -26,9 +26,6 @@ */ class Process { - /** - * @var \Cake\Console\ConsoleIo - */ protected ConsoleIo $io; /** @@ -62,7 +59,7 @@ public function call(string $command): string $pipes, ); if (!is_resource($process)) { - throw new RuntimeException("Could not start subprocess for `$command`"); + throw new RuntimeException("Could not start subprocess for `{$command}`"); } fclose($pipes[0]); diff --git a/app/vendor/cakephp/bake/src/Utility/SubsetSchemaCollection.php b/app/vendor/cakephp/bake/src/Utility/SubsetSchemaCollection.php index 290332159..995a31e65 100644 --- a/app/vendor/cakephp/bake/src/Utility/SubsetSchemaCollection.php +++ b/app/vendor/cakephp/bake/src/Utility/SubsetSchemaCollection.php @@ -27,13 +27,10 @@ */ class SubsetSchemaCollection implements CollectionInterface { - /** - * @var \Cake\Database\Schema\CollectionInterface - */ protected CollectionInterface $collection; /** - * @var list + * @var array */ protected array $tables = []; @@ -60,7 +57,7 @@ public function getInnerCollection(): CollectionInterface /** * Get the list of tables in this schema collection. * - * @return list + * @return array */ public function listTables(): array { diff --git a/app/vendor/cakephp/bake/src/Utility/TableScanner.php b/app/vendor/cakephp/bake/src/Utility/TableScanner.php index b10be2c0e..ace2b00ca 100644 --- a/app/vendor/cakephp/bake/src/Utility/TableScanner.php +++ b/app/vendor/cakephp/bake/src/Utility/TableScanner.php @@ -29,9 +29,6 @@ */ class TableScanner { - /** - * @var \Cake\Database\Connection - */ protected Connection $connection; /** @@ -50,7 +47,7 @@ public function __construct(Connection $connection, ?array $ignore = null) { $this->connection = $connection; if ($ignore === null) { - $ignore = ['i18n', 'cake_sessions', 'sessions', '/phinxlog/']; + $ignore = ['i18n', 'cake_sessions', 'cake_migrations', 'cake_seeds', 'sessions', '/phinxlog/']; } $this->ignore = $ignore; } @@ -120,10 +117,8 @@ public function removeShadowTranslationTables(array $tables): array protected function shouldSkip(string $table): bool { foreach ($this->ignore as $ignore) { - if (str_starts_with($ignore, '/')) { - if ((bool)preg_match($ignore, $table)) { - return true; - } + if (str_starts_with($ignore, '/') && (bool)preg_match($ignore, $table)) { + return true; } if ($ignore === $table) { diff --git a/app/vendor/cakephp/bake/src/Utility/TemplateRenderer.php b/app/vendor/cakephp/bake/src/Utility/TemplateRenderer.php index d3f8eb633..7566cd070 100644 --- a/app/vendor/cakephp/bake/src/Utility/TemplateRenderer.php +++ b/app/vendor/cakephp/bake/src/Utility/TemplateRenderer.php @@ -34,15 +34,11 @@ class TemplateRenderer /** * BakeView instance - * - * @var \Bake\View\BakeView|null */ protected ?BakeView $view = null; /** * Template theme - * - * @var string|null */ protected ?string $theme; @@ -59,12 +55,12 @@ public function __construct(?string $theme = null) /** * Get view instance * - * @return \Cake\View\View + * @return \Bake\View\BakeView * @triggers Bake.initialize $view */ public function getView(): View { - if ($this->view) { + if ($this->view instanceof BakeView) { return $this->view; } @@ -99,7 +95,7 @@ public function generate(string $template, ?array $vars = null): string try { return $view->render($template); - } catch (MissingTemplateException $e) { + } catch (MissingTemplateException) { $message = sprintf('No bake template found for "%s" skipping file generation.', $template); throw new MissingTemplateException($message); } diff --git a/app/vendor/cakephp/bake/src/View/BakeView.php b/app/vendor/cakephp/bake/src/View/BakeView.php index 841865434..ebc623dfa 100644 --- a/app/vendor/cakephp/bake/src/View/BakeView.php +++ b/app/vendor/cakephp/bake/src/View/BakeView.php @@ -18,17 +18,12 @@ use Cake\Core\Configure; use Cake\Core\ConventionsTrait; -use Cake\Event\EventDispatcherTrait; use Cake\Event\EventInterface; use Cake\TwigView\View\TwigView; use function Cake\Core\pluginSplit; class BakeView extends TwigView { - /** - * @use \Cake\Event\EventDispatcherTrait<\Cake\View\View> - */ - use EventDispatcherTrait; use ConventionsTrait; /** @@ -81,6 +76,8 @@ public function initialize(): void */ public function render(?string $template = null, string|false|null $layout = null): string { + assert($template !== null, 'Template name must be provided.'); + $viewFileName = $this->_getTemplateFileName($template); [, $templateEventName] = pluginSplit($template); $templateEventName = str_replace(['/', '\\'], '.', $templateEventName); @@ -107,19 +104,19 @@ public function render(?string $template = null, string|false|null $layout = nul * * Use the Bake prefix for bake related view events * - * @template TSubject of \Cake\View\View * @param string $name Name of the event. * @param array $data Any value you wish to be transported with this event to * it can be read by listeners. - * - * @param TSubject|null $subject The object that this event applies to + * @param object|null $subject The object that this event applies to * ($this by default). - * @return \Cake\Event\EventInterface<\Cake\View\View> + * @return \Cake\Event\EventInterface + * @phpstan-ignore missingType.generics */ public function dispatchEvent(string $name, array $data = [], ?object $subject = null): EventInterface { - $name = preg_replace('/^View\./', 'Bake.', $name); + $name = (string)preg_replace('/^View\./', 'Bake.', $name); + /** @phpstan-ignore-next-line missingType.generics */ return parent::dispatchEvent($name, $data, $subject); } @@ -128,14 +125,14 @@ public function dispatchEvent(string $name, array $data = [], ?object $subject = * * @param ?string $plugin Optional plugin name to scan for view files. * @param bool $cached Set to false to force a refresh of view paths. Default true. - * @return list paths + * @return array paths */ protected function _paths(?string $plugin = null, bool $cached = true): array { $paths = parent::_paths($plugin, false); foreach ($paths as &$path) { // Append 'bake' to all directories that aren't the application override directory. - if (strpos($path, 'plugin' . DS . 'Bake') === false) { + if (!str_contains($path, 'plugin' . DS . 'Bake')) { $path .= static::BAKE_TEMPLATE_FOLDER . DS; } } diff --git a/app/vendor/cakephp/bake/src/View/Helper/BakeHelper.php b/app/vendor/cakephp/bake/src/View/Helper/BakeHelper.php index 41b48a9e7..e73388c64 100644 --- a/app/vendor/cakephp/bake/src/View/Helper/BakeHelper.php +++ b/app/vendor/cakephp/bake/src/View/Helper/BakeHelper.php @@ -21,6 +21,8 @@ /** * Bake helper + * + * @extends \Cake\View\Helper<\Cake\View\View> */ class BakeHelper extends Helper { @@ -35,8 +37,6 @@ class BakeHelper extends Helper /** * AssociationFilter utility - * - * @var \Bake\Utility\Model\AssociationFilter|null */ protected ?AssociationFilter $_associationFilter = null; @@ -150,7 +150,7 @@ public function classInfo(string $class, string $type, string $suffix): array if ($plugin !== null) { $base = $plugin; } - $base = str_replace('/', '\\', trim($base, '\\')); + $base = str_replace('/', '\\', trim((string)$base, '\\')); $sub = '\\' . str_replace('/', '\\', trim($type, '\\')); $qn = $sub . '\\' . $name . $suffix; @@ -196,12 +196,12 @@ public function filterFields( array $filterTypes = ['binary'], ): array { $fields = collection($fields) - ->filter(function ($field) use ($schema, $filterTypes) { + ->filter(function ($field) use ($schema, $filterTypes): bool { return !in_array($schema->getColumnType($field), $filterTypes); }); if (isset($modelObject) && $modelObject->hasBehavior('Tree')) { - $fields = $fields->reject(function ($field) { + $fields = $fields->reject(function ($field): bool { return $field === 'lft' || $field === 'rght'; }); } @@ -233,15 +233,15 @@ public function getViewFieldsData(array $fields, SchemaInterface $schema, array } }) ->filter() - ->reduce(function ($fields, $value) { + ->reduce(function ($fields, $value): float|int|array { return $fields + $value; }, []); $groupedFields = collection($fields) - ->filter(function ($field) use ($schema) { + ->filter(function ($field) use ($schema): bool { return $schema->getColumnType($field) !== 'binary'; }) - ->groupBy(function ($field) use ($schema, $associationFields) { + ->groupBy(function ($field) use ($schema, $associationFields): string { $type = $schema->getColumnType($field); if (isset($associationFields[$field])) { return 'string'; @@ -262,11 +262,11 @@ public function getViewFieldsData(array $fields, SchemaInterface $schema, array 'timestampfractional', 'timestamptimezone', ]; - if (in_array($type, $dateTypes)) { + if (in_array($type, $dateTypes, true)) { return 'date'; } - return in_array($type, ['text', 'boolean']) ? $type : 'string'; + return in_array($type, ['text', 'boolean'], true) ? $type : 'string'; }) ->toArray(); @@ -304,7 +304,7 @@ public function columnData(string $field, TableSchema $schema): ?array public function enumSupportsLabel(string $field, TableSchema $schema): bool { $typeName = $schema->getColumnType($field); - if (!str_starts_with($typeName, 'enum-')) { + if (!$typeName || !str_starts_with($typeName, 'enum-')) { return false; } $type = TypeFactory::build($typeName); @@ -365,7 +365,7 @@ public function getValidationMethods(string $field, array $rules): array continue; } - $rule['args'] = array_map(function ($item) { + $rule['args'] = array_map(function ($item): string { return $this->exportVar( $item, is_array($item) ? 3 : 0, @@ -421,7 +421,7 @@ public function escapeArguments(array $args): array return array_map(function ($v) { if (is_string($v)) { $v = strtr($v, ["'" => "\'"]); - $v = "'$v'"; + $v = "'{$v}'"; } return $v; @@ -494,7 +494,7 @@ public function getConstUses(array $imports): string */ protected function getUseType(string $alias, string $name): string { - if ($name == $alias || substr($name, -strlen("\\{$alias}")) === "\\{$alias}") { + if ($name === $alias || str_ends_with($name, "\\{$alias}")) { return $name; } @@ -518,7 +518,7 @@ public function concat( ): string { $output = implode( $delimiter, - array_map(function ($string) use ($delimiter) { + array_map(function ($string) use ($delimiter): string { if (is_string($string)) { return $string; } diff --git a/app/vendor/cakephp/bake/src/View/Helper/DocBlockHelper.php b/app/vendor/cakephp/bake/src/View/Helper/DocBlockHelper.php index 05b988f1a..014c3d9b4 100644 --- a/app/vendor/cakephp/bake/src/View/Helper/DocBlockHelper.php +++ b/app/vendor/cakephp/bake/src/View/Helper/DocBlockHelper.php @@ -13,6 +13,8 @@ /** * DocBlock helper + * + * @extends \Cake\View\Helper<\Cake\View\View> */ class DocBlockHelper extends Helper { @@ -57,7 +59,7 @@ public function classDescription(string $className, string $classType, array $an $lines[] = $annotation; } - $lines = array_merge(['/**'], (new Collection($lines))->map(function ($line) { + $lines = array_merge(['/**'], (new Collection($lines))->map(function ($line): string { return rtrim(" * {$line}"); })->toArray(), [' */']); @@ -305,7 +307,7 @@ public function buildTableAnnotations( $annotations[] = "@method iterable<\\{$namespace}\\Model\\Entity\\{$entity}>|\Cake\Datasource\ResultSetInterface<\\{$namespace}\\Model\\Entity\\{$entity}>|false deleteMany(iterable \$entities, array \$options = [])"; $annotations[] = "@method iterable<\\{$namespace}\\Model\\Entity\\{$entity}>|\Cake\Datasource\ResultSetInterface<\\{$namespace}\\Model\\Entity\\{$entity}> deleteManyOrFail(iterable \$entities, array \$options = [])"; // phpcs:enable - foreach ($behaviors as $behavior => $behaviorData) { + foreach (array_keys($behaviors) as $behavior) { $className = App::className($behavior, 'Model/Behavior', 'Behavior'); if (!$className) { $className = "Cake\ORM\Behavior\\{$behavior}Behavior"; @@ -329,12 +331,12 @@ public function buildTableAnnotations( */ protected function _insertAfter(array $target, string $key, mixed $value): array { - $index = array_search($key, array_keys($target)); + $index = array_search($key, array_keys($target), true); if ($index !== false) { $target = array_merge( array_slice($target, 0, $index + 1), $value, - array_slice($target, $index + 1, null), + array_slice($target, $index + 1), ); } else { $target += (array)$value; diff --git a/app/vendor/cakephp/bake/templates/bake/Command/command.twig b/app/vendor/cakephp/bake/templates/bake/Command/command.twig index 9580b3fa4..54aec5479 100644 --- a/app/vendor/cakephp/bake/templates/bake/Command/command.twig +++ b/app/vendor/cakephp/bake/templates/bake/Command/command.twig @@ -33,7 +33,7 @@ class {{ name }}Command extends Command * * @var string */ - protected string $name = '{{ command_name }}'; + protected string $name = 'cake {{ command_name }}'; /** * Get the default command name. @@ -58,7 +58,7 @@ class {{ name }}Command extends Command /** * Hook method for defining this command's option parser. * - * @see https://book.cakephp.org/5/en/console-commands/commands.html#defining-arguments-and-options + * @link https://book.cakephp.org/5/en/console-commands/commands.html#defining-arguments-and-options * @param \Cake\Console\ConsoleOptionParser $parser The parser to be defined * @return \Cake\Console\ConsoleOptionParser The built parser. */ diff --git a/app/vendor/cakephp/bake/templates/bake/Controller/controller.twig b/app/vendor/cakephp/bake/templates/bake/Controller/controller.twig index 83a843e1c..3212114f6 100644 --- a/app/vendor/cakephp/bake/templates/bake/Controller/controller.twig +++ b/app/vendor/cakephp/bake/templates/bake/Controller/controller.twig @@ -32,7 +32,7 @@ {% endif %} {%- for component in components %} -{% set classInfo = Bake.classInfo(component, 'Controller/Component', 'Component') %} + {%~ set classInfo = Bake.classInfo(component, 'Controller/Component', 'Component') %} * @property {{ classInfo.fqn }} ${{ classInfo.name }} {% endfor %} */ @@ -48,20 +48,20 @@ class {{ name }}Controller extends AppController { parent::initialize(); -{% for component in components %} + {%~ for component in components %} $this->loadComponent('{{ component }}'); -{% endfor %} -{% if helpers %} + {%~ endfor %} + {%~ if helpers %} $this->viewBuilder()->setHelpers({{ Bake.exportArray(helpers)|raw }}); -{% endif %} -{% if has_login %} + {%~ endif %} + {%~ if has_login %} $this->Authentication->allowUnauthenticated(['login']); -{% endif %} + {%~ endif %} } -{% if actions|length %}{{ "\n" }}{% endif %} + {%~ if actions|length %}{{ "\n" }}{% endif %} {% endif %} -{%- for action in actions %} -{% if loop.index > 1 %}{{ "\n" }}{% endif %} +{% for action in actions %} + {%~ if loop.index > 1 %}{{ "\n" }}{% endif %} {{- element('Bake.Controller/' ~ action) -}} {% endfor %} } diff --git a/app/vendor/cakephp/bake/templates/bake/Model/entity.twig b/app/vendor/cakephp/bake/templates/bake/Model/entity.twig index 2524788ee..ab924dd7b 100644 --- a/app/vendor/cakephp/bake/templates/bake/Model/entity.twig +++ b/app/vendor/cakephp/bake/templates/bake/Model/entity.twig @@ -18,8 +18,8 @@ {% set annotations = DocBlock.propertyHints(propertyHintMap) %} {%- if associationHintMap %} - {%- set annotations = annotations|merge(['']) %} - {%- set annotations = annotations|merge(DocBlock.propertyHints(associationHintMap)) %} + {%~ set annotations = annotations|merge(['']) %} + {%~ set annotations = annotations|merge(DocBlock.propertyHints(associationHintMap)) %} {% endif %} {%- set accessible = Bake.getFieldAccessibility(fields, primaryKey) %} @@ -39,7 +39,7 @@ class {{ name }} extends Entity{{ fileBuilder.classBuilder.implements ? ' implem {% endif %} {% if accessible %} -{%- set generatedProperties = generatedProperties|merge(['_accessible']) %} +{%~ set generatedProperties = generatedProperties|merge(['_accessible']) %} /** * Fields that can be mass assigned using newEntity() or patchEntity(). * @@ -54,12 +54,12 @@ class {{ name }} extends Entity{{ fileBuilder.classBuilder.implements ? ' implem {% if accessible and hidden %} {% endif %} -{%- if hidden %} -{%- set generatedProperties = generatedProperties|merge(['_hidden']) %} +{% if hidden %} + {%~ set generatedProperties = generatedProperties|merge(['_hidden']) %} /** * Fields that are excluded from JSON versions of the entity. * - * @var list + * @var array */ protected array $_hidden = {{ Bake.exportVar(hidden, 1)|raw }}; {% endif %} diff --git a/app/vendor/cakephp/bake/templates/bake/Model/table.twig b/app/vendor/cakephp/bake/templates/bake/Model/table.twig index acd786fae..76511babc 100644 --- a/app/vendor/cakephp/bake/templates/bake/Model/table.twig +++ b/app/vendor/cakephp/bake/templates/bake/Model/table.twig @@ -50,58 +50,49 @@ class {{ name }}Table extends Table{{ fileBuilder.classBuilder.implements ? ' im {%- if displayField %} $this->setDisplayField({{ (displayField is iterable ? Bake.exportArray(displayField) : Bake.exportVar(displayField))|raw }}); {% endif %} - -{%- if primaryKey %} - {%- if primaryKey is iterable and primaryKey|length > 1 %} +{% if primaryKey %} + {%~ if primaryKey is iterable and primaryKey|length > 1 %} $this->setPrimaryKey({{ Bake.exportArray(primaryKey)|raw }}); - {{- "\n" }} - {%- else %} + {%~ else %} $this->setPrimaryKey('{{ primaryKey|as_array|first }}'); - {{- "\n" }} - {%- endif %} -{% endif %} - -{%- if enums %} - + {%~ endif %} {% endif %} +{% if enums %} -{%- if enums %} - -{%- for name, className in enums %} + {%~ for name, className in enums %} $this->getSchema()->setColumnType('{{ name }}', \Cake\Database\Type\EnumType::from(\{{ className }}::class)); -{% endfor %} + {%~ endfor %} {% endif %} +{% if customColumnTypes is defined and customColumnTypes %} -{%- if behaviors %} - + {%~ for columnName, typeExpression in customColumnTypes %} + $this->getSchema()->setColumnType('{{ columnName }}', {{ typeExpression|raw }}); + {%~ endfor %} {% endif %} +{% if behaviors %} -{%- for behavior, behaviorData in behaviors %} + {%~ for behavior, behaviorData in behaviors %} $this->addBehavior('{{ behavior }}'{{ (behaviorData ? (", " ~ Bake.exportArray(behaviorData, 2)|raw ~ '') : '')|raw }}); -{% endfor %} - -{%- if associations.belongsTo or associations.hasMany or associations.belongsToMany %} - + {%~ endfor %} {% endif %} - -{%- for type, assocs in associations %} - {%- for assoc in assocs %} - {%- set assocData = [] %} - {%- for key, val in assoc %} - {%- if key is not same as('alias') %} - {%- set assocData = assocData|merge({(key): val}) %} - {%- endif %} - {%- endfor %} +{% if associations.belongsTo or associations.hasMany or associations.belongsToMany %} + + {%~ for type, assocs in associations %} + {%~ for assoc in assocs %} + {%~ set assocData = [] %} + {%~ for key, val in assoc %} + {%~ if key is not same as('alias') %} + {%~ set assocData = assocData|merge({(key): val}) %} + {%~ endif %} + {%~ endfor %} $this->{{ type }}('{{ assoc.alias }}', {{ Bake.exportArray(assocData, 2)|raw }}); - {{- "\n" }} - {%- endfor %} -{% endfor %} + {%~ endfor %} + {%~ endfor %} +{% endif %} } -{{- "\n" }} - -{%- if validation %} -{% set generatedFunctions = generatedFunctions|merge(['validationDefault']) %} +{% if validation %} + {%~ set generatedFunctions = generatedFunctions|merge(['validationDefault']) %} /** * Default validation rules. * @@ -110,25 +101,24 @@ class {{ name }}Table extends Table{{ fileBuilder.classBuilder.implements ? ' im */ public function validationDefault(Validator $validator): Validator { -{% for field, rules in validation %} -{% set validationMethods = Bake.getValidationMethods(field, rules) %} -{% if validationMethods %} + {%~ for field, rules in validation %} + {%~ set validationMethods = Bake.getValidationMethods(field, rules) %} + {%~ if validationMethods %} $validator -{% for validationMethod in validationMethods %} -{% if loop.last %} -{% set validationMethod = validationMethod ~ ';' %} -{% endif %} + {%~ for validationMethod in validationMethods %} + {%~ if loop.last %} + {%~ set validationMethod = validationMethod ~ ';' %} + {%~ endif %} {{ validationMethod|raw }} -{% endfor %} + {%~ endfor %} -{% endif %} -{% endfor %} + {%~ endif %} + {%~ endfor %} return $validator; } {% endif %} - {%- if rulesChecker %} -{% set generatedFunctions = generatedFunctions|merge(['buildRules']) %} + {%~ set generatedFunctions = generatedFunctions|merge(['buildRules']) %} /** * Returns a rules checker object that will be used for validating @@ -139,21 +129,24 @@ class {{ name }}Table extends Table{{ fileBuilder.classBuilder.implements ? ' im */ public function buildRules(RulesChecker $rules): RulesChecker { -{% for rule in rulesChecker %} -{% set fields = Bake.exportArray(rule.fields) %} -{% set options = '' %} -{% for optionName, optionValue in rule.options %} - {%~ set options = (loop.first ? '[' : options) ~ "'#{optionName}' => " ~ Bake.exportVar(optionValue) ~ (loop.last ? ']' : ', ') %} -{% endfor %} - $rules->add($rules->{{ rule.name }}({{ fields|raw }}{{ (rule.extra|default ? ", '#{rule.extra}'" : '')|raw }}{{ (options ? ', ' ~ options : '')|raw }}), ['errorField' => '{{ rule.fields[0] }}']); -{% endfor %} + {%~ for rule in rulesChecker %} + {%~ set fields = Bake.exportArray(rule.fields) %} + {%~ set options = '' %} + {%~ for optionName, optionValue in rule.options %} + {%~ set options = (loop.first ? '[' : options) ~ "'#{optionName}' => " ~ Bake.exportVar(optionValue) ~ (loop.last ? ']' : ', ') %} + {%~ endfor %} + {%~ set ruleOptions = "'errorField' => '" ~ rule.fields[0] ~ "'" %} + {%~ if rule.message is defined %} + {%~ set ruleOptions = ruleOptions ~ ", 'message' => __(" ~ Bake.exportVar(rule.message) ~ ")" %} + {%~ endif %} + $rules->add($rules->{{ rule.name }}({{ fields|raw }}{{ (rule.extra|default ? ", '#{rule.extra}'" : '')|raw }}{{ (options ? ', ' ~ options : '')|raw }}), [{{ ruleOptions|raw }}]); + {%~ endfor %} return $rules; } {% endif %} - -{%- if connection is not same as('default') %} -{% set generatedFunctions = generatedFunctions|merge(['defaultConnectionName']) %} +{% if connection is not same as('default') %} + {%~ set generatedFunctions = generatedFunctions|merge(['defaultConnectionName']) %} /** * Returns the database connection name to use by default. diff --git a/app/vendor/cakephp/bake/templates/bake/Template/add.twig b/app/vendor/cakephp/bake/templates/bake/Template/add.twig index c21d7c1d2..bfbfcbada 100644 --- a/app/vendor/cakephp/bake/templates/bake/Template/add.twig +++ b/app/vendor/cakephp/bake/templates/bake/Template/add.twig @@ -17,18 +17,15 @@ /** * @var \{{ namespace }}\View\AppView $this * @var \{{ entityClass }} ${{ singularVar }} - {{- "\n" }} -{%- if associations.BelongsTo is defined %} - {%- for assocName, assocData in associations.BelongsTo %} +{% if associations.BelongsTo is defined %} + {%~ for assocName, assocData in associations.BelongsTo %} * @var \Cake\Collection\CollectionInterface|string[] ${{ assocData.variable }} - {{- "\n" }} - {%- endfor %} + {%~ endfor %} {% endif %} -{%- if associations.BelongsToMany is defined %} - {%- for assocName, assocData in associations.BelongsToMany %} +{% if associations.BelongsToMany is defined %} + {%~ for assocName, assocData in associations.BelongsToMany %} * @var \Cake\Collection\CollectionInterface|string[] ${{ assocData.variable }} - {{- "\n" }} - {%- endfor %} + {%~ endfor %} {% endif %} */ ?> diff --git a/app/vendor/cakephp/bake/templates/bake/Template/edit.twig b/app/vendor/cakephp/bake/templates/bake/Template/edit.twig index 90fed4ec4..a7d57e8ff 100644 --- a/app/vendor/cakephp/bake/templates/bake/Template/edit.twig +++ b/app/vendor/cakephp/bake/templates/bake/Template/edit.twig @@ -17,18 +17,15 @@ /** * @var \{{ namespace }}\View\AppView $this * @var \{{ entityClass }} ${{ singularVar }} - {{- "\n" }} -{%- if associations.BelongsTo is defined %} - {%- for assocName, assocData in associations.BelongsTo %} +{% if associations.BelongsTo is defined %} + {%~ for assocName, assocData in associations.BelongsTo %} * @var string[]|\Cake\Collection\CollectionInterface ${{ assocData.variable }} - {{- "\n" }} - {%- endfor %} + {%~ endfor %} {% endif %} -{%- if associations.BelongsToMany is defined %} - {%- for assocName, assocData in associations.BelongsToMany %} +{% if associations.BelongsToMany is defined %} + {%~ for assocName, assocData in associations.BelongsToMany %} * @var string[]|\Cake\Collection\CollectionInterface ${{ assocData.variable }} - {{- "\n" }} - {%- endfor %} + {%~ endfor %} {% endif %} */ ?> diff --git a/app/vendor/cakephp/bake/templates/bake/Template/index.twig b/app/vendor/cakephp/bake/templates/bake/Template/index.twig index 7cab8aa11..4a81b76fe 100644 --- a/app/vendor/cakephp/bake/templates/bake/Template/index.twig +++ b/app/vendor/cakephp/bake/templates/bake/Template/index.twig @@ -38,28 +38,28 @@ {% for field in fields %} -{% set isKey = false %} -{% if associations.BelongsTo is defined %} -{% for alias, details in associations.BelongsTo %} -{% if field == details.foreignKey %} -{% set isKey = true %} + {%~ set isKey = false %} + {%~ if associations.BelongsTo is defined %} + {%~ for alias, details in associations.BelongsTo %} + {%~ if field == details.foreignKey %} + {%~ set isKey = true %} hasValue('{{ details.property }}') ? $this->Html->link(${{ singularVar }}->{{ details.property }}->{{ details.displayField }}, ['controller' => '{{ details.controller }}', 'action' => 'view', ${{ singularVar }}->{{ details.property }}->{{ details.primaryKey[0] }}]) : '' ?> -{% endif %} -{% endfor %} -{% endif %} -{% if isKey is not same as(true) %} -{% set columnData = Bake.columnData(field, schema) %} -{% set supportsLabel = Bake.enumSupportsLabel(field, schema) %} -{% if columnData.type starts with 'enum-' %} + {%~ endif %} + {%~ endfor %} + {%~ endif %} + {%~ if isKey is not same as(true) %} + {%~ set columnData = Bake.columnData(field, schema) %} + {%~ set supportsLabel = Bake.enumSupportsLabel(field, schema) %} + {%~ if columnData.type starts with 'enum-' %} {{ field }} === null ? '' : h(${{ singularVar }}->{{ field }}->{% if supportsLabel %}label(){% else %}value{% endif %}) ?> -{% elseif columnData.type not in ['integer', 'float', 'decimal', 'biginteger', 'smallinteger', 'tinyinteger'] %} + {%~ elseif columnData.type not in ['integer', 'float', 'decimal', 'biginteger', 'smallinteger', 'tinyinteger'] %} {{ field }}) ?> -{% elseif columnData.null %} + {%~ elseif columnData.null %} {{ field }} === null ? '' : $this->Number->format(${{ singularVar }}->{{ field }}) ?> -{% else %} + {%~ else %} Number->format(${{ singularVar }}->{{ field }}) ?> -{% endif %} -{% endif %} + {%~ endif %} + {%~ endif %} {% endfor %} {% set pk = '$' ~ singularVar ~ '->' ~ primaryKey[0] %} diff --git a/app/vendor/cakephp/bake/templates/bake/Template/view.twig b/app/vendor/cakephp/bake/templates/bake/Template/view.twig index de4141355..a6841f352 100644 --- a/app/vendor/cakephp/bake/templates/bake/Template/view.twig +++ b/app/vendor/cakephp/bake/templates/bake/Template/view.twig @@ -24,6 +24,7 @@ {% set associationFields = fieldsData.associationFields %} {% set groupedFields = fieldsData.groupedFields %} {% set pK = '$' ~ singularVar ~ '->' ~ primaryKey[0] %} +{% set done = [] %}
@@ -40,104 +40,107 @@

{{ displayField }}) ?>

{% if groupedFields['string'] %} -{% for field in groupedFields['string'] %} -{% if associationFields[field] is defined %} -{% set details = associationFields[field] %} + {%~ for field in groupedFields['string'] %} + {%~ if associationFields[field] is defined %} + {%~ set details = associationFields[field] %} -{% else %} + {%~ else %} -{% endif %} -{% endfor %} + {%~ endif %} + {%~ endfor %} {% endif %} {% if associations.HasOne %} -{% for alias, details in associations.HasOne %} + {%~ for alias, details in associations.HasOne %} -{% endfor %} + {%~ endfor %} {% endif %} {% if groupedFields.number %} -{% for field in groupedFields.number %} + {%~ for field in groupedFields.number %} -{% set columnData = Bake.columnData(field, schema) %} -{% if columnData.null %} + {%~ set columnData = Bake.columnData(field, schema) %} + {%~ if columnData.null %} -{% else %} + {%~ else %} -{% endif %} + {%~ endif %} -{% endfor %} + {%~ endfor %} {% endif %} {% if groupedFields.enum %} -{% for field in groupedFields.enum %} + {%~ for field in groupedFields.enum %} -{% set columnData = Bake.columnData(field, schema) %} -{% set supportsLabel = Bake.enumSupportsLabel(field, schema) %} -{% if columnData.null %} + {%~ set columnData = Bake.columnData(field, schema) %} + {%~ set supportsLabel = Bake.enumSupportsLabel(field, schema) %} + {%~ if columnData.null %} -{% else %} + {%~ else %} -{% endif %} + {%~ endif %} -{% endfor %} + {%~ endfor %} {% endif %} {% if groupedFields.date %} -{% for field in groupedFields.date %} + {%~ for field in groupedFields.date %} -{% endfor %} + {%~ endfor %} {% endif %} {% if groupedFields.boolean %} -{% for field in groupedFields.boolean %} + {%~ for field in groupedFields.boolean %} -{% endfor %} + {%~ endfor %} {% endif %}
hasValue('{{ details.property }}') ? $this->Html->link(${{ singularVar }}->{{ details.property }}->{{ details.displayField }}, ['controller' => '{{ details.controller }}', 'action' => 'view', ${{ singularVar }}->{{ details.property }}->{{ details.primaryKey[0] }}]) : '' ?>
{{ field }}) ?>
hasValue('{{ details.property }}') ? $this->Html->link(${{ singularVar }}->{{ details.property }}->{{ details.displayField }}, ['controller' => '{{ details.controller }}', 'action' => 'view', ${{ singularVar }}->{{ details.property }}->{{ details.primaryKey[0] }}]) : '' ?>
{{ field }} === null ? '' : $this->Number->format(${{ singularVar }}->{{ field }}) ?>Number->format(${{ singularVar }}->{{ field }}) ?>
{{ field }} === null ? '' : h(${{ singularVar }}->{{ field }}->{% if supportsLabel %}label(){% else %}value{% endif %}) ?>{{ field }}->{% if supportsLabel %}label(){% else %}value{% endif %}) ?>
{{ field }}) ?>
{{ field }} ? __('Yes') : __('No'); ?>
{% if groupedFields.text %} -{% for field in groupedFields.text %} + {%~ for field in groupedFields.text %}
Text->autoParagraph(h(${{ singularVar }}->{{ field }})); ?>
-{% endfor %} + {%~ endfor %} {% endif %} {% set relations = associations.BelongsToMany|merge(associations.HasMany) %} {% for alias, details in relations %} -{% set otherSingularVar = alias|singularize|variable %} -{% set otherPluralHumanName = details.controller|underscore|humanize %} + {%~ set otherSingularVar = alias|singularize|variable %} + {%~ if otherSingularVar == singularVar %} + {%~ set otherSingularVar = otherSingularVar ~ 'Related' %} + {%~ endif %} + {%~ set otherPluralHumanName = details.controller|underscore|humanize %}

{{ details.property }})) : ?>
-{% for field in details.fields %} + {%~ for field in details.fields %} -{% endfor %} + {%~ endfor %} {{ details.property }} as ${{ otherSingularVar }}) : ?> -{% for field in details.fields %} + {%~ for field in details.fields %} -{% endfor %} -{% set otherPk = '$' ~ otherSingularVar ~ '->' ~ details.primaryKey[0] %} + {%~ endfor %} + {%~ set otherPk = '$' ~ otherSingularVar ~ '->' ~ details.primaryKey[0] %} `:""})}if(!$t.ratio&&f.arcs&&(dt=["arc",o.$el.arcs.select(`path.${Ve.arc}-${$t.id}`).data()[0]],$t.ratio=o.getRatio(...dt)),dt=[$t.ratio,$t.id,$t.index],o.isAreaRangeType($t)){const[vt,Q]=["high","low"].map(ct=>N(o.getRangedData($t,ct),...dt));st=`Mid: ${N(w($t),...dt)} High: ${vt} Low: ${Q}`}else if(o.isCandlestickType($t)){const[vt,Q,St,ct,At]=["open","high","low","close","volume"].map(Gt=>o.getRangedData($t,Gt,"candlestick")?N(o.getRangedData($t,Gt,"candlestick"),...dt):void 0);st=`Open: ${vt} High: ${Q} Low: ${St} Close: ${ct}${At?` Volume: ${At}`:""}`}else if(o.isBarRangeType($t)){const{value:vt,id:Q,index:St}=$t;st=`${N(vt,void 0,Q,St)}`}else st=N(w($t),...dt);if(st!==void 0){if($t.name===null)continue;const vt=P((i=$t.name)!=null?i:$t.id,...dt),Q=X($t),St={CLASS_TOOLTIP_NAME:ei.tooltipName+o.getTargetSelectorSuffix($t.id),COLOR:H||!o.patterns?Q:``,NAME:vt,VALUE:st};if(H&&Be(W.text)){const ct=k.indexOf($t.id);Object.keys(W.text).forEach(At=>{St[At]=W.text[At][ct]})}ht+=bi(K[1],St)}}return`${ht}
{{ field }}) ?> Html->link(__('View'), ['controller' => '{{ details.controller }}', 'action' => 'view', {{ otherPk|raw }}]) ?> Html->link(__('Edit'), ['controller' => '{{ details.controller }}', 'action' => 'edit', {{ otherPk|raw }}]) ?> diff --git a/app/vendor/cakephp/bake/templates/bake/element/Controller/add.twig b/app/vendor/cakephp/bake/templates/bake/element/Controller/add.twig index 081d1c79f..4986c99c2 100644 --- a/app/vendor/cakephp/bake/templates/bake/element/Controller/add.twig +++ b/app/vendor/cakephp/bake/templates/bake/element/Controller/add.twig @@ -38,11 +38,13 @@ {% set associations = associations|merge(Bake.aliasExtractor(modelObj, 'BelongsToMany')) %} {%- for assoc in associations %} - {%- set otherName = Bake.getAssociatedTableAlias(modelObj, assoc) %} - {%- set otherPlural = otherName|variable %} + {%~ set otherName = Bake.getAssociatedTableAlias(modelObj, assoc) %} + {%~ set otherPlural = otherName|variable %} + {%~ if otherPlural == singularName %} + {%~ set otherPlural = otherPlural ~ 'List' %} + {%~ endif %} ${{ otherPlural }} = $this->{{ currentModelName }}->{{ otherName }}->find('list', limit: 200)->all(); - {{- "\n" }} - {%- set compact = compact|merge(["'#{otherPlural}'"]) %} + {%~ set compact = compact|merge(["'#{otherPlural}'"]) %} {% endfor %} $this->set(compact({{ compact|join(', ')|raw }})); } diff --git a/app/vendor/cakephp/bake/templates/bake/element/Controller/edit.twig b/app/vendor/cakephp/bake/templates/bake/element/Controller/edit.twig index 793f8515f..d68e4a39a 100644 --- a/app/vendor/cakephp/bake/templates/bake/element/Controller/edit.twig +++ b/app/vendor/cakephp/bake/templates/bake/element/Controller/edit.twig @@ -39,11 +39,13 @@ $this->Flash->error(__('The {{ singularHumanName|lower }} could not be saved. Please, try again.')); } {% for assoc in belongsTo|merge(belongsToMany) %} - {%- set otherName = Bake.getAssociatedTableAlias(modelObj, assoc) %} - {%- set otherPlural = otherName|variable %} + {%~ set otherName = Bake.getAssociatedTableAlias(modelObj, assoc) %} + {%~ set otherPlural = otherName|variable %} + {%~ if otherPlural == singularName %} + {%~ set otherPlural = otherPlural ~ 'List' %} + {%~ endif %} ${{ otherPlural }} = $this->{{ currentModelName }}->{{ otherName }}->find('list', limit: 200)->all(); - {{- "\n" }} - {%- set compact = compact|merge(["'#{otherPlural}'"]) %} + {%~ set compact = compact|merge(["'#{otherPlural}'"]) %} {% endfor %} $this->set(compact({{ compact|join(', ')|raw }})); } diff --git a/app/vendor/cakephp/bake/templates/bake/element/form.twig b/app/vendor/cakephp/bake/templates/bake/element/form.twig index f442cbd00..8036cfe61 100644 --- a/app/vendor/cakephp/bake/templates/bake/element/form.twig +++ b/app/vendor/cakephp/bake/templates/bake/element/form.twig @@ -26,8 +26,7 @@ ) ?> {% endif %} Html->link(__('List {{ pluralHumanName }}'), ['action' => 'index'], ['class' => 'side-nav-item']) ?> - {{- "\n" }} -{%- set done = [] %} +{% set done = [] %}
@@ -37,34 +36,28 @@ Form->control('{{ field }}', ['options' => ${{ keyFields[field] }}, 'empty' => true]); - {{- "\n" }} - {%- else %} + {%~ else %} echo $this->Form->control('{{ field }}', ['options' => ${{ keyFields[field] }}]); - {{- "\n" }} - {%- endif %} - {%- elseif field not in ['created', 'modified', 'updated'] %} - {%- set fieldData = Bake.columnData(field, schema) %} - {%- if fieldData.type in ['date', 'datetime', 'time'] and fieldData.null %} + {%~ endif %} + {%~ elseif field not in ['created', 'modified', 'updated'] %} + {%~ set fieldData = Bake.columnData(field, schema) %} + {%~ if fieldData.type in ['date', 'datetime', 'time'] and fieldData.null %} echo $this->Form->control('{{ field }}', ['empty' => true]); - {{- "\n" }} - {%- else %} + {%~ else %} echo $this->Form->control('{{ field }}'); - {{- "\n" }} - {%- endif %} - {%- endif %} -{%- endif %} -{%- endfor %} - -{%- if associations.BelongsToMany is defined %} -{%- for assocName, assocData in associations.BelongsToMany %} + {%~ endif %} + {%~ endif %} + {%~ endif %} +{% endfor %} +{% if associations.BelongsToMany is defined %} + {%~ for assocName, assocData in associations.BelongsToMany %} echo $this->Form->control('{{ assocData.property }}._ids', ['options' => ${{ assocData.variable }}]); - {{- "\n" }} -{%- endfor %} + {%~ endfor %} {% endif %} ?> diff --git a/app/vendor/cakephp/bake/templates/bake/tests/test_case.twig b/app/vendor/cakephp/bake/templates/bake/tests/test_case.twig index 464f308b7..2fcb90ff5 100644 --- a/app/vendor/cakephp/bake/templates/bake/tests/test_case.twig +++ b/app/vendor/cakephp/bake/templates/bake/tests/test_case.twig @@ -24,7 +24,7 @@ {%- set traitName = 'ConsoleIntegrationTestTrait' %} {%- set uses = uses|merge(['Cake\\Console\\TestSuite\\ConsoleIntegrationTestTrait']) %} {% endif %} -{%- set uses = uses|merge(["Cake\\TestSuite\\TestCase"]) %} +{% set uses = uses|merge(["Cake\\TestSuite\\TestCase"]) %} {{- element('Bake.file_header', { namespace: "#{baseNamespace}\\Test\\TestCase\\#{subNamespace}", @@ -42,37 +42,37 @@ class {{ className }}Test extends TestCase { {% if traitName is defined %} use {{ traitName }}; -{% if properties or fixtures or construction or methods %} + {%~ if properties or fixtures or construction or methods %} -{% endif %} + {%~ endif %} {% endif %} {% if properties %} -{% for propertyInfo in properties %} -{% if loop.index > 1 %} + {%~ for propertyInfo in properties %} + {%~ if loop.index > 1 %} -{% endif %} + {%~ endif %} /** * {{ propertyInfo.description }} * * @var {{ propertyInfo.type }} */ protected ${{ propertyInfo.name }}{% if propertyInfo.value is defined and propertyInfo.value %} = {{ propertyInfo.value }}{% endif %}; -{% if loop.last and (fixtures or construction or methods) %} + {%~ if loop.last and (fixtures or construction or methods) %} -{% endif %} -{% endfor %} + {%~ endif %} + {%~ endfor %} {% endif %} -{%- if fixtures %} +{%- if fixtures and not (hasFixtureFactories|default(false)) %} /** * Fixtures * - * @var list + * @var array */ protected array $fixtures = {{ Bake.exportVar(fixtures|values, 1)|raw }}; -{% if construction or methods %} + {%~ if construction or methods %} -{% endif %} + {%~ endif %} {% endif %} {%- if construction %} @@ -84,19 +84,19 @@ class {{ className }}Test extends TestCase protected function setUp(): void { parent::setUp(); -{% if preConstruct %} + {%~ if preConstruct %} {{ preConstruct|raw }} -{% endif %} -{% if isCommand %} + {%~ endif %} + {%~ if isCommand %} {{ construction|raw }} -{% else %} + {%~ else %} $this->{{ (subject ~ ' = ' ~ construction)|raw }} -{% endif %} -{% if postConstruct %} + {%~ endif %} + {%~ if postConstruct %} {{ postConstruct|raw }} -{% endif %} + {%~ endif %} } -{% if not isCommand %} + {%~ if not isCommand %} /** * tearDown method @@ -109,16 +109,16 @@ class {{ className }}Test extends TestCase parent::tearDown(); } -{% if methods %} + {%~ if methods %} -{% endif %} -{% endif %} -{% endif %} + {%~ endif %} + {%~ endif %} +{%~ endif %} {%- for method in methods %} -{% if loop.index > 1 %} + {%~ if loop.index > 1 %} -{% endif %} + {%~ endif %} /** * Test {{ method }} method * @@ -129,5 +129,5 @@ class {{ className }}Test extends TestCase { $this->markTestIncomplete('Not implemented yet.'); } -{% endfor %} +{%~ endfor %} } diff --git a/app/vendor/cakephp/bake/tests/Fixture/BakeCarFixture.php b/app/vendor/cakephp/bake/tests/Fixture/BakeCarFixture.php index 5fa12baa3..f3783dd42 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/BakeCarFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/BakeCarFixture.php @@ -21,8 +21,5 @@ */ class BakeCarFixture extends TestFixture { - /** - * @var string - */ public string $table = 'car'; } diff --git a/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateAuthorsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateAuthorsFixture.php index eaa86a684..50441ed27 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateAuthorsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateAuthorsFixture.php @@ -24,15 +24,11 @@ class BakeTemplateAuthorsFixture extends TestFixture { /** * Avoid overriding AuthorsFixture's table. - * - * @var string */ public string $table = 'bake_authors'; /** * records property - * - * @var array */ public array $records = [ ['name' => 'mariano', 'role_id' => 1], diff --git a/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateProfilesFixture.php b/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateProfilesFixture.php index 50fba6d80..8dfc8aa06 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateProfilesFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateProfilesFixture.php @@ -24,15 +24,10 @@ */ class BakeTemplateProfilesFixture extends TestFixture { - /** - * @var string - */ public string $table = 'profiles'; /** * records property - * - * @var array */ public array $records = [ ['author_id' => 1, 'nick' => 'The Comedian', 'avatar' => 'smiley.png'], diff --git a/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateRolesFixture.php b/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateRolesFixture.php index ed1cd3fc0..dd1887c98 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateRolesFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/BakeTemplateRolesFixture.php @@ -21,15 +21,10 @@ */ class BakeTemplateRolesFixture extends TestFixture { - /** - * @var string - */ public string $table = 'roles'; /** * records property - * - * @var array */ public array $records = [ ['name' => 'admin'], diff --git a/app/vendor/cakephp/bake/tests/Fixture/CategoriesFixture.php b/app/vendor/cakephp/bake/tests/Fixture/CategoriesFixture.php index 0ab0d4e16..f862a1f52 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/CategoriesFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/CategoriesFixture.php @@ -23,8 +23,6 @@ class CategoriesFixture extends TestFixture { /** * Records - * - * @var array */ public array $records = [ [ diff --git a/app/vendor/cakephp/bake/tests/Fixture/CategoriesProductsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/CategoriesProductsFixture.php index c66ac82ab..848242a23 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/CategoriesProductsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/CategoriesProductsFixture.php @@ -23,8 +23,6 @@ class CategoriesProductsFixture extends TestFixture { /** * Records - * - * @var array */ public array $records = [ [ diff --git a/app/vendor/cakephp/bake/tests/Fixture/CategoryThreadsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/CategoryThreadsFixture.php index 3142e3766..2c7f983a4 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/CategoryThreadsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/CategoryThreadsFixture.php @@ -23,8 +23,6 @@ class CategoryThreadsFixture extends TestFixture { /** * records property - * - * @var array */ public array $records = [ ['parent_id' => 0, 'name' => 'Category 1', 'lft' => 1, 'rght' => 14, 'created' => '2007-03-18 15:30:23', 'updated' => '2007-03-18 15:32:31'], diff --git a/app/vendor/cakephp/bake/tests/Fixture/DatatypesFixture.php b/app/vendor/cakephp/bake/tests/Fixture/DatatypesFixture.php index addc7cee2..7748da66e 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/DatatypesFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/DatatypesFixture.php @@ -23,8 +23,6 @@ class DatatypesFixture extends TestFixture { /** * Records property - * - * @var array */ public array $records = [ ['decimal_field' => '30.123', 'float_field' => 42.23, 'huge_int' => '1234567891234567891', 'small_int' => '1234', 'tiny_int' => '12', 'bool' => 0, 'timestamp_field' => '2007-03-17 01:16:23'], diff --git a/app/vendor/cakephp/bake/tests/Fixture/HiddenFieldsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/HiddenFieldsFixture.php index 7fd63501d..3e8da2610 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/HiddenFieldsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/HiddenFieldsFixture.php @@ -23,8 +23,6 @@ class HiddenFieldsFixture extends TestFixture { /** * records property - * - * @var array */ public array $records = [ ['password' => '$2a$10$u05j8FjsvLBNdfhBhc21LOuVMpzpabVXQ9OpC2wO3pSO0q6t7HHMO', 'auth_token' => '12345'], diff --git a/app/vendor/cakephp/bake/tests/Fixture/InvitationsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/InvitationsFixture.php index e6606917b..be1ee8bb0 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/InvitationsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/InvitationsFixture.php @@ -23,8 +23,6 @@ class InvitationsFixture extends TestFixture { /** * records property - * - * @var array */ public array $records = [ [ diff --git a/app/vendor/cakephp/bake/tests/Fixture/NewsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/NewsFixture.php new file mode 100644 index 000000000..030835c56 --- /dev/null +++ b/app/vendor/cakephp/bake/tests/Fixture/NewsFixture.php @@ -0,0 +1,28 @@ + 'First News', 'body' => 'First News Body'], + ['title' => 'Second News', 'body' => 'Second News Body'], + ]; +} diff --git a/app/vendor/cakephp/bake/tests/Fixture/OldProductsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/OldProductsFixture.php index 8e6d3ac86..7bf36fa6d 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/OldProductsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/OldProductsFixture.php @@ -23,8 +23,6 @@ class OldProductsFixture extends TestFixture { /** * Records - * - * @var array */ public array $records = [ [ diff --git a/app/vendor/cakephp/bake/tests/Fixture/ProductVersionsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/ProductVersionsFixture.php index bd04c6cf9..36d6334fd 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/ProductVersionsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/ProductVersionsFixture.php @@ -23,8 +23,6 @@ class ProductVersionsFixture extends TestFixture { /** * Records - * - * @var array */ public array $records = [ [ diff --git a/app/vendor/cakephp/bake/tests/Fixture/ProductsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/ProductsFixture.php index 381c45d19..83a59b5d8 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/ProductsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/ProductsFixture.php @@ -23,8 +23,6 @@ class ProductsFixture extends TestFixture { /** * Records - * - * @var array */ public array $records = [ [ diff --git a/app/vendor/cakephp/bake/tests/Fixture/RelationsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/RelationsFixture.php index d7b09a1f3..8daa7974c 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/RelationsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/RelationsFixture.php @@ -23,8 +23,6 @@ class RelationsFixture extends TestFixture { /** * records property - * - * @var array */ public array $records = [ [ diff --git a/app/vendor/cakephp/bake/tests/Fixture/UniqueFieldsFixture.php b/app/vendor/cakephp/bake/tests/Fixture/UniqueFieldsFixture.php index 34e0a37de..a9cd01549 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/UniqueFieldsFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/UniqueFieldsFixture.php @@ -23,8 +23,6 @@ class UniqueFieldsFixture extends TestFixture { /** * records property - * - * @var array */ public array $records = [ ['field_1' => 'unique_value_1', 'field_2' => 'unique_value_2'], diff --git a/app/vendor/cakephp/bake/tests/Fixture/UsersFixture.php b/app/vendor/cakephp/bake/tests/Fixture/UsersFixture.php index a98fb40bd..89fd55ce2 100644 --- a/app/vendor/cakephp/bake/tests/Fixture/UsersFixture.php +++ b/app/vendor/cakephp/bake/tests/Fixture/UsersFixture.php @@ -23,8 +23,6 @@ class UsersFixture extends TestFixture { /** * records property - * - * @var array */ public array $records = [ ['username' => 'mariano', 'password' => '$2a$10$u05j8FjsvLBNdfhBhc21LOuVMpzpabVXQ9OpC2wO3pSO0q6t7HHMO', 'created' => '2007-03-17 01:16:23', 'updated' => '2007-03-17 01:18:31'], diff --git a/app/vendor/cakephp/bake/tests/bootstrap.php b/app/vendor/cakephp/bake/tests/bootstrap.php index a031b40e6..6e3329f5c 100644 --- a/app/vendor/cakephp/bake/tests/bootstrap.php +++ b/app/vendor/cakephp/bake/tests/bootstrap.php @@ -25,10 +25,10 @@ use Cake\Error\Debug\TextFormatter; use Cake\TestSuite\Fixture\SchemaLoader; -$findRoot = function ($root) { +$findRoot = function ($root): string { do { $lastRoot = $root; - $root = dirname($root); + $root = dirname((string) $root); if (is_dir($root . '/vendor/cakephp/cakephp')) { return $root; } @@ -39,7 +39,7 @@ unset($findRoot); chdir($root); -require_once 'vendor/autoload.php'; +require_once __DIR__ . '/../vendor/autoload.php'; define('ROOT', $root . DS . 'tests' . DS . 'test_app' . DS); define('APP', ROOT . 'App' . DS); diff --git a/app/vendor/cakephp/bake/tests/schema.php b/app/vendor/cakephp/bake/tests/schema.php index b26ac345e..336c7d84f 100644 --- a/app/vendor/cakephp/bake/tests/schema.php +++ b/app/vendor/cakephp/bake/tests/schema.php @@ -340,8 +340,8 @@ 'table' => 'datatypes', 'columns' => [ 'id' => ['type' => 'integer', 'null' => false], - 'decimal_field' => ['type' => 'decimal', 'length' => '6', 'precision' => 3, 'default' => '0.000'], - 'float_field' => ['type' => 'float', 'length' => '5,2', 'null' => false, 'default' => null], + 'decimal_field' => ['type' => 'decimal', 'length' => 6, 'precision' => 3, 'default' => '0.000'], + 'float_field' => ['type' => 'float', 'length' => 5, 'precision' => 2, 'null' => false, 'default' => null], 'huge_int' => ['type' => 'biginteger'], 'small_int' => ['type' => 'smallinteger'], 'tiny_int' => ['type' => 'tinyinteger'], @@ -587,4 +587,16 @@ 'unique_self_referencing_parent' => ['type' => 'unique', 'columns' => ['parent_id']], ], ], + // "news" is both singular and plural - tests variable collision fix + [ + 'table' => 'news', + 'columns' => [ + 'id' => ['type' => 'integer'], + 'title' => ['type' => 'string', 'length' => 255, 'null' => false], + 'body' => ['type' => 'text'], + 'created' => ['type' => 'datetime'], + 'modified' => ['type' => 'datetime'], + ], + 'constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]], + ], ]; diff --git a/app/vendor/cakephp/cakephp-codesniffer/CakePHP/Sniffs/NamingConventions/ValidFunctionNameSniff.php b/app/vendor/cakephp/cakephp-codesniffer/CakePHP/Sniffs/NamingConventions/ValidFunctionNameSniff.php index c7dd3c033..65037bf79 100644 --- a/app/vendor/cakephp/cakephp-codesniffer/CakePHP/Sniffs/NamingConventions/ValidFunctionNameSniff.php +++ b/app/vendor/cakephp/cakephp-codesniffer/CakePHP/Sniffs/NamingConventions/ValidFunctionNameSniff.php @@ -63,7 +63,7 @@ public function __construct() protected function processTokenWithinScope(File $phpcsFile, $stackPtr, $currScope) { $methodName = $phpcsFile->getDeclarationName($stackPtr); - if ($methodName === null) { + if ($methodName === '') { return; } diff --git a/app/vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml b/app/vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml index b20fa1a0c..f41ec35f3 100644 --- a/app/vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml +++ b/app/vendor/cakephp/cakephp-codesniffer/CakePHP/ruleset.xml @@ -1,17 +1,22 @@ - + CakePHP coding standard - - \.git /*/tmp/ tests/*/templates/* - + + + + + + + + + diff --git a/app/vendor/cakephp/cakephp/src/Cache/Cache.php b/app/vendor/cakephp/cakephp/src/Cache/Cache.php index dab7c9be2..13f5b2566 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/Cache.php +++ b/app/vendor/cakephp/cakephp/src/Cache/Cache.php @@ -27,7 +27,7 @@ /** * Cache provides a consistent interface to Caching in your application. It allows you * to use several different Cache engines, without coupling your application to a specific - * implementation. It also allows you to change out cache storage or configuration without effecting + * implementation. It also allows you to change out cache storage or configuration without affecting * the rest of your application. * * ### Configuring Cache engines @@ -56,10 +56,9 @@ * - `FileEngine` - Uses simple files to store content. Poor performance, but good for * storing large objects, or things that are not IO sensitive. Well suited to development * as it is an easy cache to inspect and manually flush. - * - `MemcacheEngine` - Uses the PECL::Memcache extension and Memcached for storage. - * Fast reads/writes, and benefits from memcache being distributed. + * - `MemcachedEngine` - Uses the PECL::Memcached extension and Memcached for storage. + * Fast reads/writes, and benefits from memcached being distributed. * - `RedisEngine` - Uses redis and php-redis extension to store cache data. - * - `XcacheEngine` - Uses the Xcache extension, an alternative to APCu. * * See Cache engine documentation for expected configuration keys. * @@ -102,14 +101,14 @@ class Cache /** * Cache Registry used for creating and using cache adapters. * - * @var \Cake\Cache\CacheRegistry + * @var \Cake\Cache\CacheRegistry<\Cake\Cache\CacheEngine> */ protected static CacheRegistry $_registry; /** * Returns the Cache Registry instance used for creating and using cache adapters. * - * @return \Cake\Cache\CacheRegistry + * @return \Cake\Cache\CacheRegistry<\Cake\Cache\CacheEngine> */ public static function getRegistry(): CacheRegistry { @@ -121,7 +120,7 @@ public static function getRegistry(): CacheRegistry * * Also allows for injecting of a new registry instance. * - * @param \Cake\Cache\CacheRegistry $registry Injectable registry object. + * @param \Cake\Cache\CacheRegistry<\Cake\Cache\CacheEngine> $registry Injectable registry object. * @return void */ public static function setRegistry(CacheRegistry $registry): void @@ -153,6 +152,7 @@ protected static function _buildEngine(string $name): void $registry->load($name, $config); } catch (RuntimeException $e) { if (!array_key_exists('fallback', $config)) { + // @phpstan-ignore argument.type (NullEngine is valid fallback) $registry->set($name, new NullEngine()); trigger_error($e->getMessage(), E_USER_WARNING); @@ -209,13 +209,13 @@ public static function pool(string $config): CacheInterface&CacheEngineInterface $registry = static::getRegistry(); - if (isset($registry->{$config})) { - return $registry->{$config}; + if ($registry->has($config)) { + return $registry->get($config); } static::_buildEngine($config); - return $registry->{$config}; + return $registry->get($config); } /** @@ -331,7 +331,7 @@ public static function read(string $key, string $config = 'default'): mixed * Cache::readMany(['my_data_1', 'my_data_2], 'long_term'); * ``` * - * @param iterable $keys An array or Traversable of keys to fetch from the cache + * @param iterable $keys An array or Traversable of keys to fetch from the cache * @param string $config optional name of the configuration to use. Defaults to 'default' * @return iterable An array containing, for each of the given $keys, * the cached data or false if cached data could not be retrieved. @@ -423,7 +423,7 @@ public static function delete(string $key, string $config = 'default'): bool * Cache::deleteMany(['my_data_1', 'my_data_2], 'long_term'); * ``` * - * @param iterable $keys Array or Traversable of cache keys to be deleted + * @param iterable $keys Array or Traversable of cache keys to be deleted * @param string $config name of the configuration to use. Defaults to 'default' * @return bool True on success, false on failure. * @throws \Cake\Cache\Exception\InvalidArgumentException @@ -561,7 +561,7 @@ public static function enabled(): bool * @param string $config The cache configuration to use for this operation. * Defaults to default. * @return mixed If the key is found: the cached data. - * If the key is not found the value returned by the the default callback. + * If the key is not found the value returned by the default callback. */ public static function remember(string $key, Closure $default, string $config = 'default'): mixed { diff --git a/app/vendor/cakephp/cakephp/src/Cache/CacheEngine.php b/app/vendor/cakephp/cakephp/src/Cache/CacheEngine.php index 22a180fc0..31ec5fd45 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/CacheEngine.php +++ b/app/vendor/cakephp/cakephp/src/Cache/CacheEngine.php @@ -16,8 +16,12 @@ */ namespace Cake\Cache; +use Cake\Cache\Event\CacheAfterAddEvent; +use Cake\Cache\Event\CacheBeforeAddEvent; use Cake\Cache\Exception\InvalidArgumentException; use Cake\Core\InstanceConfigTrait; +use Cake\Event\EventDispatcherInterface; +use Cake\Event\EventDispatcherTrait; use DateInterval; use DateTime; use Psr\SimpleCache\CacheInterface; @@ -25,9 +29,16 @@ /** * Storage engine for CakePHP caching + * + * @template TSubject of object + * @implements \Cake\Event\EventDispatcherInterface */ -abstract class CacheEngine implements CacheInterface, CacheEngineInterface +abstract class CacheEngine implements CacheInterface, CacheEngineInterface, EventDispatcherInterface { + /** + * @use \Cake\Event\EventDispatcherTrait + */ + use EventDispatcherTrait; use InstanceConfigTrait; /** @@ -264,7 +275,7 @@ abstract public function increment(string $key, int $offset = 1): int|false; * * @param string $key Identifier for the data * @param int $offset How much to subtract - * @return int|false New incremented value, false otherwise + * @return int|false New decremented value, false otherwise */ abstract public function decrement(string $key, int $offset = 1): int|false; @@ -296,9 +307,29 @@ abstract public function clear(): bool; public function add(string $key, mixed $value): bool { $cachedValue = $this->get($key); + $prefixedKey = $this->_key($key); + $duration = $this->getConfig('duration'); + + $this->_eventClass = CacheBeforeAddEvent::class; + $this->dispatchEvent(CacheBeforeAddEvent::NAME, [ + 'key' => $prefixedKey, + 'value' => $value, + 'ttl' => $duration, + ]); + if ($cachedValue === null) { - return $this->set($key, $value); + $success = $this->set($key, $value); + $this->_eventClass = CacheAfterAddEvent::class; + $this->dispatchEvent(CacheAfterAddEvent::NAME, [ + 'key' => $prefixedKey, 'value' => $value, 'success' => $success, 'ttl' => $duration, + ]); + + return $success; } + $this->_eventClass = CacheAfterAddEvent::class; + $this->dispatchEvent(CacheAfterAddEvent::NAME, [ + 'key' => $prefixedKey, 'value' => $value, 'success' => false, 'ttl' => $duration, + ]); return false; } diff --git a/app/vendor/cakephp/cakephp/src/Cache/CacheEngineInterface.php b/app/vendor/cakephp/cakephp/src/Cache/CacheEngineInterface.php index d6e190646..9f6f2ce52 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/CacheEngineInterface.php +++ b/app/vendor/cakephp/cakephp/src/Cache/CacheEngineInterface.php @@ -51,7 +51,7 @@ public function increment(string $key, int $offset = 1): int|false; * * @param string $key Identifier for the data * @param int $offset How much to subtract - * @return int|false New incremented value, false otherwise + * @return int|false New decremented value, false otherwise */ public function decrement(string $key, int $offset = 1): int|false; diff --git a/app/vendor/cakephp/cakephp/src/Cache/CacheRegistry.php b/app/vendor/cakephp/cakephp/src/Cache/CacheRegistry.php index 5f7f78492..e8aa83c42 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/CacheRegistry.php +++ b/app/vendor/cakephp/cakephp/src/Cache/CacheRegistry.php @@ -26,7 +26,8 @@ * * Used by {@link \Cake\Cache\Cache} to load and manage cache engines. * - * @extends \Cake\Core\ObjectRegistry<\Cake\Cache\CacheEngine> + * @template TEngine of \Cake\Cache\CacheEngine + * @extends \Cake\Core\ObjectRegistry */ class CacheRegistry extends ObjectRegistry { @@ -36,11 +37,11 @@ class CacheRegistry extends ObjectRegistry * Part of the template method for Cake\Core\ObjectRegistry::load() * * @param string $class Partial classname to resolve. - * @return class-string<\Cake\Cache\CacheEngine>|null Either the correct classname or null. + * @return class-string|null Either the correct classname or null. */ protected function _resolveClassName(string $class): ?string { - /** @var class-string<\Cake\Cache\CacheEngine>|null */ + /** @var class-string|null */ return App::className($class, 'Cache/Engine', 'Engine'); } @@ -64,10 +65,10 @@ protected function _throwMissingClassError(string $class, ?string $plugin): void * * Part of the template method for Cake\Core\ObjectRegistry::load() * - * @param \Cake\Cache\CacheEngine|class-string<\Cake\Cache\CacheEngine> $class The classname or object to make. + * @param TEngine|class-string $class The classname or object to make. * @param string $alias The alias of the object. * @param array $config An array of settings to use for the cache engine. - * @return \Cake\Cache\CacheEngine The constructed CacheEngine class. + * @return TEngine The constructed CacheEngine class. * @throws \Cake\Core\Exception\CakeException When the cache engine cannot be initialized. */ protected function _create(object|string $class, string $alias, array $config): CacheEngine diff --git a/app/vendor/cakephp/cakephp/src/Cache/Engine/ApcuEngine.php b/app/vendor/cakephp/cakephp/src/Cache/Engine/ApcuEngine.php index 43d580c68..cb8c82805 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/Engine/ApcuEngine.php +++ b/app/vendor/cakephp/cakephp/src/Cache/Engine/ApcuEngine.php @@ -18,11 +18,27 @@ use APCUIterator; use Cake\Cache\CacheEngine; +use Cake\Cache\Event\CacheAfterAddEvent; +use Cake\Cache\Event\CacheAfterDecrementEvent; +use Cake\Cache\Event\CacheAfterDeleteEvent; +use Cake\Cache\Event\CacheAfterGetEvent; +use Cake\Cache\Event\CacheAfterIncrementEvent; +use Cake\Cache\Event\CacheAfterSetEvent; +use Cake\Cache\Event\CacheBeforeAddEvent; +use Cake\Cache\Event\CacheBeforeDecrementEvent; +use Cake\Cache\Event\CacheBeforeDeleteEvent; +use Cake\Cache\Event\CacheBeforeGetEvent; +use Cake\Cache\Event\CacheBeforeIncrementEvent; +use Cake\Cache\Event\CacheBeforeSetEvent; +use Cake\Cache\Event\CacheClearedEvent; +use Cake\Cache\Event\CacheGroupClearEvent; use Cake\Core\Exception\CakeException; use DateInterval; /** * APCu storage engine for cache + * + * @extends \Cake\Cache\CacheEngine<\Cake\Cache\Engine\ApcuEngine> */ class ApcuEngine extends CacheEngine { @@ -67,7 +83,17 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null $key = $this->_key($key); $duration = $this->duration($ttl); - return apcu_store($key, $value, $duration); + $this->_eventClass = CacheBeforeSetEvent::class; + $this->dispatchEvent(CacheBeforeSetEvent::NAME, ['key' => $key, 'value' => $value, 'ttl' => $duration]); + + $success = apcu_store($key, $value, $duration); + + $this->_eventClass = CacheAfterSetEvent::class; + $this->dispatchEvent(CacheAfterSetEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => $success, 'ttl' => $duration, + ]); + + return $success; } /** @@ -81,7 +107,14 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null */ public function get(string $key, mixed $default = null): mixed { - $value = apcu_fetch($this->_key($key), $success); + $key = $this->_key($key); + $this->_eventClass = CacheBeforeGetEvent::class; + $this->dispatchEvent(CacheBeforeGetEvent::NAME, ['key' => $key, 'default' => $default]); + + $value = apcu_fetch($key, $success); + + $this->_eventClass = CacheAfterGetEvent::class; + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => $value, 'success' => $success]); if ($success === false) { return $default; } @@ -100,8 +133,17 @@ public function get(string $key, mixed $default = null): mixed public function increment(string $key, int $offset = 1): int|false { $key = $this->_key($key); + $this->_eventClass = CacheBeforeIncrementEvent::class; + $this->dispatchEvent(CacheBeforeIncrementEvent::NAME, ['key' => $key, 'offset' => $offset]); + + $value = apcu_inc($key, $offset); - return apcu_inc($key, $offset); + $this->_eventClass = CacheAfterIncrementEvent::class; + $this->dispatchEvent(CacheAfterIncrementEvent::NAME, [ + 'key' => $key, 'offset' => $offset, 'success' => $value !== false, 'value' => $value, + ]); + + return $value; } /** @@ -115,8 +157,17 @@ public function increment(string $key, int $offset = 1): int|false public function decrement(string $key, int $offset = 1): int|false { $key = $this->_key($key); + $this->_eventClass = CacheBeforeDecrementEvent::class; + $this->dispatchEvent(CacheBeforeDecrementEvent::NAME, ['key' => $key, 'offset' => $offset]); - return apcu_dec($key, $offset); + $result = apcu_dec($key, $offset); + + $this->_eventClass = CacheAfterDecrementEvent::class; + $this->dispatchEvent(CacheAfterDecrementEvent::NAME, [ + 'key' => $key, 'offset' => $offset, 'success' => $result !== false, 'value' => $result, + ]); + + return $result; } /** @@ -129,14 +180,21 @@ public function decrement(string $key, int $offset = 1): int|false public function delete(string $key): bool { $key = $this->_key($key); + $this->_eventClass = CacheBeforeDeleteEvent::class; + $this->dispatchEvent(CacheBeforeDeleteEvent::NAME, ['key' => $key]); + + $result = apcu_delete($key); + + $this->_eventClass = CacheAfterDeleteEvent::class; + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => $result]); - return apcu_delete($key); + return $result; } /** - * Delete all keys from the cache. This will clear every cache config using APC. + * Delete all keys from the cache. This will clear every cache config using APCu. * - * @return bool True Returns true. + * @return bool True on success. * @link https://secure.php.net/manual/en/function.apcu-cache-info.php * @link https://secure.php.net/manual/en/function.apcu-delete.php */ @@ -148,6 +206,8 @@ public function clear(): bool APC_ITER_NONE, ); apcu_delete($iterator); + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return true; } @@ -159,6 +219,9 @@ public function clear(): bool } } + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); + return true; } @@ -175,8 +238,19 @@ public function add(string $key, mixed $value): bool { $key = $this->_key($key); $duration = $this->_config['duration']; + $this->_eventClass = CacheBeforeAddEvent::class; + $this->dispatchEvent(CacheBeforeAddEvent::NAME, [ + 'key' => $key, 'value' => $value, 'ttl' => $duration, + ]); + + $result = apcu_add($key, $value, $duration); - return apcu_add($key, $value, $duration); + $this->_eventClass = CacheAfterAddEvent::class; + $this->dispatchEvent(CacheAfterAddEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => $result, 'ttl' => $duration, + ]); + + return $result; } /** @@ -234,6 +308,8 @@ public function clearGroup(string $group): bool { $success = false; apcu_inc($this->_config['prefix'] . $group, 1, $success); + $this->_eventClass = CacheGroupClearEvent::class; + $this->dispatchEvent(CacheGroupClearEvent::NAME, ['group' => $group]); return $success; } diff --git a/app/vendor/cakephp/cakephp/src/Cache/Engine/ArrayEngine.php b/app/vendor/cakephp/cakephp/src/Cache/Engine/ArrayEngine.php index 6b1f2500c..ed8b6d4d5 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/Engine/ArrayEngine.php +++ b/app/vendor/cakephp/cakephp/src/Cache/Engine/ArrayEngine.php @@ -17,6 +17,18 @@ namespace Cake\Cache\Engine; use Cake\Cache\CacheEngine; +use Cake\Cache\Event\CacheAfterDecrementEvent; +use Cake\Cache\Event\CacheAfterDeleteEvent; +use Cake\Cache\Event\CacheAfterGetEvent; +use Cake\Cache\Event\CacheAfterIncrementEvent; +use Cake\Cache\Event\CacheAfterSetEvent; +use Cake\Cache\Event\CacheBeforeDecrementEvent; +use Cake\Cache\Event\CacheBeforeDeleteEvent; +use Cake\Cache\Event\CacheBeforeGetEvent; +use Cake\Cache\Event\CacheBeforeIncrementEvent; +use Cake\Cache\Event\CacheBeforeSetEvent; +use Cake\Cache\Event\CacheClearedEvent; +use Cake\Cache\Event\CacheGroupClearEvent; use DateInterval; /** @@ -28,6 +40,8 @@ * or console tools where you don't want the overhead of interacting * with a cache servers, but want the work saving properties a cache * provides. + * + * @extends \Cake\Cache\CacheEngine<\Cake\Cache\Engine\ArrayEngine> */ class ArrayEngine extends CacheEngine { @@ -54,8 +68,19 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null { $key = $this->_key($key); $expires = time() + $this->duration($ttl); + + $this->_eventClass = CacheBeforeSetEvent::class; + $this->dispatchEvent(CacheBeforeSetEvent::NAME, [ + 'key' => $key, 'value' => $value, 'ttl' => $this->duration($ttl), + ]); + $this->data[$key] = ['exp' => $expires, 'val' => $value]; + $this->_eventClass = CacheAfterSetEvent::class; + $this->dispatchEvent(CacheAfterSetEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => true, 'ttl' => $this->duration($ttl), + ]); + return true; } @@ -70,7 +95,13 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null public function get(string $key, mixed $default = null): mixed { $key = $this->_key($key); + $this->_eventClass = CacheBeforeGetEvent::class; + $this->dispatchEvent(CacheBeforeGetEvent::NAME, ['key' => $key, 'default' => $default]); + + $this->_eventClass = CacheAfterGetEvent::class; if (!isset($this->data[$key])) { + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => null, 'success' => false]); + return $default; } $data = $this->data[$key]; @@ -79,10 +110,13 @@ public function get(string $key, mixed $default = null): mixed $now = time(); if ($data['exp'] <= $now) { unset($this->data[$key]); + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => null, 'success' => false]); return $default; } + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => $data['val'], 'success' => true]); + return $data['val']; } @@ -99,9 +133,18 @@ public function increment(string $key, int $offset = 1): int|false $this->set($key, 0); } $key = $this->_key($key); + $this->_eventClass = CacheBeforeIncrementEvent::class; + $this->dispatchEvent(CacheBeforeIncrementEvent::NAME, ['key' => $key, 'offset' => $offset]); + $this->data[$key]['val'] += $offset; + $val = $this->data[$key]['val']; - return $this->data[$key]['val']; + $this->_eventClass = CacheAfterIncrementEvent::class; + $this->dispatchEvent('Cache.afterIncrement', [ + 'key' => $key, 'offset' => $offset, 'success' => true, 'value' => $val, + ]); + + return $val; } /** @@ -117,8 +160,16 @@ public function decrement(string $key, int $offset = 1): int|false $this->set($key, 0); } $key = $this->_key($key); + $this->_eventClass = CacheBeforeDecrementEvent::class; + $this->dispatchEvent(CacheBeforeDecrementEvent::NAME, ['key' => $key, 'offset' => $offset]); + $this->data[$key]['val'] -= $offset; + $this->_eventClass = CacheAfterDecrementEvent::class; + $this->dispatchEvent(CacheAfterDecrementEvent::NAME, [ + 'key' => $key, 'offset' => $offset, 'success' => true, 'value' => $this->data[$key]['val'], + ]); + return $this->data[$key]['val']; } @@ -131,19 +182,27 @@ public function decrement(string $key, int $offset = 1): int|false public function delete(string $key): bool { $key = $this->_key($key); + $this->_eventClass = CacheBeforeDeleteEvent::class; + $this->dispatchEvent(CacheBeforeDeleteEvent::NAME, ['key' => $key]); + unset($this->data[$key]); + $this->_eventClass = CacheAfterDeleteEvent::class; + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => true]); + return true; } /** - * Delete all keys from the cache. This will clear every cache config using APC. + * Delete all keys from the cache. * - * @return bool True Returns true. + * @return bool True on success. */ public function clear(): bool { $this->data = []; + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return true; } @@ -160,9 +219,7 @@ public function groups(): array $result = []; foreach ($this->_config['groups'] as $group) { $key = $this->_config['prefix'] . $group; - if (!isset($this->data[$key])) { - $this->data[$key] = ['exp' => PHP_INT_MAX, 'val' => 1]; - } + $this->data[$key] ??= ['exp' => PHP_INT_MAX, 'val' => 1]; $value = $this->data[$key]['val']; $result[] = $group . $value; } @@ -183,6 +240,8 @@ public function clearGroup(string $group): bool if (isset($this->data[$key])) { $this->data[$key]['val'] += 1; } + $this->_eventClass = CacheGroupClearEvent::class; + $this->dispatchEvent(CacheGroupClearEvent::NAME, ['group' => $group]); return true; } diff --git a/app/vendor/cakephp/cakephp/src/Cache/Engine/FileEngine.php b/app/vendor/cakephp/cakephp/src/Cache/Engine/FileEngine.php index 2e20d7952..fe9dd91d8 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/Engine/FileEngine.php +++ b/app/vendor/cakephp/cakephp/src/Cache/Engine/FileEngine.php @@ -17,6 +17,14 @@ namespace Cake\Cache\Engine; use Cake\Cache\CacheEngine; +use Cake\Cache\Event\CacheAfterDeleteEvent; +use Cake\Cache\Event\CacheAfterGetEvent; +use Cake\Cache\Event\CacheAfterSetEvent; +use Cake\Cache\Event\CacheBeforeDeleteEvent; +use Cake\Cache\Event\CacheBeforeGetEvent; +use Cake\Cache\Event\CacheBeforeSetEvent; +use Cake\Cache\Event\CacheClearedEvent; +use Cake\Cache\Event\CacheGroupClearEvent; use CallbackFilterIterator; use DateInterval; use Exception; @@ -33,6 +41,8 @@ * engine available, or have content which is not performance sensitive. * * You can configure a FileEngine cache, using Cache::config() + * + * @extends \Cake\Cache\CacheEngine<\Cake\Cache\Engine\FileEngine> */ class FileEngine extends CacheEngine { @@ -64,7 +74,7 @@ class FileEngine extends CacheEngine 'groups' => [], 'lock' => true, 'mask' => 0664, - 'dirMask' => 0770, + 'dirMask' => 0777, 'path' => null, 'prefix' => 'cake_', 'serialize' => true, @@ -116,17 +126,26 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null return false; } + $duration = $this->duration($ttl); $key = $this->_key($key); + $this->_eventClass = CacheBeforeSetEvent::class; + $this->dispatchEvent(CacheBeforeSetEvent::NAME, ['key' => $key, 'value' => $value, 'ttl' => $duration]); + $this->_eventClass = CacheAfterSetEvent::class; if ($this->_setKey($key, true) === false) { + $this->dispatchEvent(CacheAfterSetEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => false, 'ttl' => $duration, + ]); + return false; } + $origValue = $value; if (!empty($this->_config['serialize'])) { $value = serialize($value); } - $expires = time() + $this->duration($ttl); + $expires = time() + $duration; $contents = implode('', [$expires, PHP_EOL, $value, PHP_EOL]); if ($this->_config['lock']) { @@ -143,6 +162,10 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null } unset($this->_File); + $this->dispatchEvent(CacheAfterSetEvent::NAME, [ + 'key' => $key, 'value' => $origValue, 'success' => $success, 'ttl' => $duration, + ]); + return $success; } @@ -157,8 +180,13 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null public function get(string $key, mixed $default = null): mixed { $key = $this->_key($key); + $this->_eventClass = CacheBeforeGetEvent::class; + $this->dispatchEvent(CacheBeforeGetEvent::NAME, ['key' => $key, 'default' => $default]); + $this->_eventClass = CacheAfterGetEvent::class; if (!$this->_init || $this->_setKey($key) === false) { + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => null, 'success' => false]); + return $default; } @@ -174,6 +202,7 @@ public function get(string $key, mixed $default = null): mixed if ($this->_config['lock']) { $this->_File->flock(LOCK_UN); } + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => null, 'success' => false]); return $default; } @@ -192,9 +221,14 @@ public function get(string $key, mixed $default = null): mixed $data = trim($data); if ($data !== '' && !empty($this->_config['serialize'])) { - return unserialize($data); + $data = unserialize($data); + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => $data, 'success' => true]); + + return $data; } + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => $data, 'success' => true]); + return $data; } @@ -208,8 +242,13 @@ public function get(string $key, mixed $default = null): mixed public function delete(string $key): bool { $key = $this->_key($key); + $this->_eventClass = CacheBeforeDeleteEvent::class; + $this->dispatchEvent(CacheBeforeDeleteEvent::NAME, ['key' => $key]); + $this->_eventClass = CacheAfterDeleteEvent::class; if ($this->_setKey($key) === false || !$this->_init) { + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => false]); + return false; } @@ -217,9 +256,13 @@ public function delete(string $key): bool unset($this->_File); if ($path === false) { + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => false]); + return false; } + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => true]); + // phpcs:disable return @unlink($path); // phpcs:enable @@ -243,12 +286,12 @@ public function clear(): bool $this->_config['path'], FilesystemIterator::SKIP_DOTS, ); + /** @var iterable<\SplFileInfo> $iterator */ $iterator = new RecursiveIteratorIterator( $directory, RecursiveIteratorIterator::SELF_FIRST, ); $cleared = []; - /** @var \SplFileInfo $fileInfo */ foreach ($iterator as $fileInfo) { if ($fileInfo->isFile()) { unset($fileInfo); @@ -274,6 +317,8 @@ public function clear(): bool // unsetting iterators helps releasing possible locks in certain environments, // which could otherwise make `rmdir()` fail unset($directory, $iterator); + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return true; } @@ -312,9 +357,11 @@ protected function _clearDirectory(string $path): void $filePath = $file->getRealPath(); unset($file); - // phpcs:disable - @unlink($filePath); - // phpcs:enable + if ($filePath !== false) { + // phpcs:disable + @unlink($filePath); + // phpcs:enable + } } } @@ -364,7 +411,7 @@ protected function _setKey(string $key, bool $createKey = false): bool $dir = $this->_config['path'] . $groups; if (!is_dir($dir)) { - mkdir($dir, $this->_config['dirMask'], true); + mkdir($dir, $this->_config['dirMask'] ^ umask(), true); } $path = new SplFileInfo($dir . $key); @@ -390,8 +437,8 @@ protected function _setKey(string $key, bool $createKey = false): bool if (!$exists && !chmod($this->_File->getPathname(), (int)$this->_config['mask'])) { trigger_error(sprintf( 'Could not apply permission mask `%s` on cache file `%s`', - $this->_File->getPathname(), $this->_config['mask'], + $this->_File->getPathname(), ), E_USER_WARNING); } } @@ -411,7 +458,7 @@ protected function _active(): bool $success = true; if (!is_dir($path)) { // phpcs:disable - $success = @mkdir($path, $this->_config['dirMask'], true); + $success = @mkdir($path, $this->_config['dirMask'] ^ umask(), true); // phpcs:enable } @@ -454,6 +501,7 @@ public function clearGroup(string $group): bool $directoryIterator, RecursiveIteratorIterator::CHILD_FIRST, ); + /** @var iterable<\SplFileInfo> $filtered */ $filtered = new CallbackFilterIterator( $contents, function (SplFileInfo $current) use ($group, $prefix) { @@ -472,7 +520,6 @@ function (SplFileInfo $current) use ($group, $prefix) { ); }, ); - /** @var \SplFileInfo $object */ foreach ($filtered as $object) { $path = $object->getPathname(); unset($object); @@ -483,6 +530,8 @@ function (SplFileInfo $current) use ($group, $prefix) { // unsetting iterators helps releasing possible locks in certain environments, // which could otherwise make `rmdir()` fail unset($directoryIterator, $contents, $filtered); + $this->_eventClass = CacheGroupClearEvent::class; + $this->dispatchEvent(CacheGroupClearEvent::NAME, ['group' => $group]); return true; } diff --git a/app/vendor/cakephp/cakephp/src/Cache/Engine/MemcachedEngine.php b/app/vendor/cakephp/cakephp/src/Cache/Engine/MemcachedEngine.php index 6a2d19ec1..9a5e0f1ac 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/Engine/MemcachedEngine.php +++ b/app/vendor/cakephp/cakephp/src/Cache/Engine/MemcachedEngine.php @@ -17,6 +17,20 @@ namespace Cake\Cache\Engine; use Cake\Cache\CacheEngine; +use Cake\Cache\Event\CacheAfterAddEvent; +use Cake\Cache\Event\CacheAfterDecrementEvent; +use Cake\Cache\Event\CacheAfterDeleteEvent; +use Cake\Cache\Event\CacheAfterGetEvent; +use Cake\Cache\Event\CacheAfterIncrementEvent; +use Cake\Cache\Event\CacheAfterSetEvent; +use Cake\Cache\Event\CacheBeforeAddEvent; +use Cake\Cache\Event\CacheBeforeDecrementEvent; +use Cake\Cache\Event\CacheBeforeDeleteEvent; +use Cake\Cache\Event\CacheBeforeGetEvent; +use Cake\Cache\Event\CacheBeforeIncrementEvent; +use Cake\Cache\Event\CacheBeforeSetEvent; +use Cake\Cache\Event\CacheClearedEvent; +use Cake\Cache\Event\CacheGroupClearEvent; use Cake\Cache\Exception\InvalidArgumentException; use Cake\Core\Exception\CakeException; use DateInterval; @@ -30,6 +44,8 @@ * Memcached engine supports binary protocol and igbinary * serialization (if memcached extension is compiled with --enable-igbinary). * Compressed keys can also be incremented/decremented. + * + * @extends \Cake\Cache\CacheEngine<\Cake\Cache\Engine\MemcachedEngine> */ class MemcachedEngine extends CacheEngine { @@ -56,7 +72,7 @@ class MemcachedEngine extends CacheEngine * - `serialize` The serializer engine used to serialize data. Available engines are 'php', * 'igbinary' and 'json'. Besides 'php', the memcached extension must be compiled with the * appropriate serializer support. - * - `servers` String or array of memcached servers. If an array MemcacheEngine will use + * - `servers` String or array of memcached servers. If an array MemcachedEngine will use * them as a pool. * - `options` - Additional options for the memcached client. Should be an array of option => value. * Use the \Memcached::OPT_* constants as keys. @@ -185,6 +201,7 @@ public function init(array $config = []): bool } if ($this->_config['username'] !== null && $this->_config['password'] !== null) { + // @phpstan-ignore function.alreadyNarrowedType (check kept for SASL support detection) if (!method_exists($this->_Memcached, 'setSaslAuthData')) { throw new InvalidArgumentException( 'Memcached extension is not built with SASL support', @@ -201,7 +218,7 @@ public function init(array $config = []): bool } /** - * Settings the memcached instance + * Set the memcached instance options * * @return void * @throws \Cake\Cache\Exception\InvalidArgumentException When the Memcached extension is not built @@ -305,9 +322,19 @@ public function getOption(int $name): string|int|bool|null */ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null): bool { + $key = $this->_key($key); $duration = $this->duration($ttl); + $this->_eventClass = CacheBeforeSetEvent::class; + $this->dispatchEvent(CacheBeforeSetEvent::NAME, ['key' => $key, 'value' => $value, 'ttl' => $duration]); + + $success = $this->_Memcached->set($key, $value, $duration); + + $this->_eventClass = CacheAfterSetEvent::class; + $this->dispatchEvent(CacheAfterSetEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => $success, 'ttl' => $duration, + ]); - return $this->_Memcached->set($this->_key($key), $value, $duration); + return $success; } /** @@ -341,11 +368,20 @@ public function setMultiple(iterable $values, DateInterval|int|null $ttl = null) public function get(string $key, mixed $default = null): mixed { $key = $this->_key($key); + $this->_eventClass = CacheBeforeGetEvent::class; + $this->dispatchEvent(CacheBeforeGetEvent::NAME, ['key' => $key, 'default' => $default]); + $value = $this->_Memcached->get($key); - if ($this->_Memcached->getResultCode() == Memcached::RES_NOTFOUND) { + + $this->_eventClass = CacheAfterGetEvent::class; + if ($this->_Memcached->getResultCode() === Memcached::RES_NOTFOUND) { + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => null, 'success' => false]); + return $default; } + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => $value, 'success' => true]); + return $value; } @@ -386,7 +422,18 @@ public function getMultiple(iterable $keys, mixed $default = null): iterable */ public function increment(string $key, int $offset = 1): int|false { - return $this->_Memcached->increment($this->_key($key), $offset); + $key = $this->_key($key); + $this->_eventClass = CacheBeforeIncrementEvent::class; + $this->dispatchEvent(CacheBeforeIncrementEvent::NAME, ['key' => $key, 'offset' => $offset]); + + $value = $this->_Memcached->increment($key, $offset); + + $this->_eventClass = CacheAfterIncrementEvent::class; + $this->dispatchEvent(CacheAfterIncrementEvent::NAME, [ + 'key' => $key, 'offset' => $offset, 'success' => $value !== false, 'value' => $value, + ]); + + return $value; } /** @@ -398,7 +445,18 @@ public function increment(string $key, int $offset = 1): int|false */ public function decrement(string $key, int $offset = 1): int|false { - return $this->_Memcached->decrement($this->_key($key), $offset); + $key = $this->_key($key); + $this->_eventClass = CacheBeforeDecrementEvent::class; + $this->dispatchEvent(CacheBeforeDecrementEvent::NAME, ['key' => $key, 'offset' => $offset]); + + $value = $this->_Memcached->decrement($key, $offset); + + $this->_eventClass = CacheAfterDecrementEvent::class; + $this->dispatchEvent(CacheAfterDecrementEvent::NAME, [ + 'key' => $key, 'offset' => $offset, 'success' => $value !== false, 'value' => $value, + ]); + + return $value; } /** @@ -410,7 +468,16 @@ public function decrement(string $key, int $offset = 1): int|false */ public function delete(string $key): bool { - return $this->_Memcached->delete($this->_key($key)); + $key = $this->_key($key); + $this->_eventClass = CacheBeforeDeleteEvent::class; + $this->dispatchEvent(CacheBeforeDeleteEvent::NAME, ['key' => $key]); + + $success = $this->_Memcached->delete($key); + + $this->_eventClass = CacheAfterDeleteEvent::class; + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => $success]); + + return $success; } /** @@ -423,11 +490,18 @@ public function delete(string $key): bool public function deleteMultiple(iterable $keys): bool { $cacheKeys = []; + $this->_eventClass = CacheBeforeDeleteEvent::class; foreach ($keys as $key) { $cacheKeys[] = $this->_key($key); + $this->dispatchEvent(CacheBeforeDeleteEvent::NAME, ['key' => $key]); + } + $success = (bool)$this->_Memcached->deleteMulti($cacheKeys); + $this->_eventClass = CacheAfterDeleteEvent::class; + foreach ($cacheKeys as $key) { + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => $success]); } - return (bool)$this->_Memcached->deleteMulti($cacheKeys); + return $success; } /** @@ -447,6 +521,8 @@ public function clear(): bool $this->_Memcached->delete($key); } } + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return true; } @@ -463,7 +539,17 @@ public function add(string $key, mixed $value): bool $duration = $this->_config['duration']; $key = $this->_key($key); - return $this->_Memcached->add($key, $value, $duration); + $this->_eventClass = CacheBeforeAddEvent::class; + $this->dispatchEvent(CacheBeforeAddEvent::NAME, ['key' => $key, 'value' => $value, 'ttl' => $duration]); + + $success = $this->_Memcached->add($key, $value, $duration); + + $this->_eventClass = CacheAfterAddEvent::class; + $this->dispatchEvent(CacheAfterAddEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => $success, 'ttl' => $duration, + ]); + + return $success; } /** @@ -510,6 +596,10 @@ public function groups(): array */ public function clearGroup(string $group): bool { - return (bool)$this->_Memcached->increment($this->_config['prefix'] . $group); + $result = (bool)$this->_Memcached->increment($this->_config['prefix'] . $group); + $this->_eventClass = CacheGroupClearEvent::class; + $this->dispatchEvent(CacheGroupClearEvent::NAME, ['group' => $group]); + + return $result; } } diff --git a/app/vendor/cakephp/cakephp/src/Cache/Engine/NullEngine.php b/app/vendor/cakephp/cakephp/src/Cache/Engine/NullEngine.php index 4fc45ee6a..7a8e644c7 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/Engine/NullEngine.php +++ b/app/vendor/cakephp/cakephp/src/Cache/Engine/NullEngine.php @@ -23,6 +23,8 @@ * Null cache engine, all operations appear to work, but do nothing. * * This is used internally for when Cache::disable() has been called. + * + * @extends \Cake\Cache\CacheEngine<\Cake\Cache\Engine\NullEngine> */ class NullEngine extends CacheEngine { diff --git a/app/vendor/cakephp/cakephp/src/Cache/Engine/RedisEngine.php b/app/vendor/cakephp/cakephp/src/Cache/Engine/RedisEngine.php index 8e4fb4af1..f7d6f06ff 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/Engine/RedisEngine.php +++ b/app/vendor/cakephp/cakephp/src/Cache/Engine/RedisEngine.php @@ -18,14 +18,33 @@ namespace Cake\Cache\Engine; use Cake\Cache\CacheEngine; +use Cake\Cache\Event\CacheAfterAddEvent; +use Cake\Cache\Event\CacheAfterDecrementEvent; +use Cake\Cache\Event\CacheAfterDeleteEvent; +use Cake\Cache\Event\CacheAfterGetEvent; +use Cake\Cache\Event\CacheAfterIncrementEvent; +use Cake\Cache\Event\CacheAfterSetEvent; +use Cake\Cache\Event\CacheBeforeAddEvent; +use Cake\Cache\Event\CacheBeforeDecrementEvent; +use Cake\Cache\Event\CacheBeforeDeleteEvent; +use Cake\Cache\Event\CacheBeforeGetEvent; +use Cake\Cache\Event\CacheBeforeIncrementEvent; +use Cake\Cache\Event\CacheBeforeSetEvent; +use Cake\Cache\Event\CacheClearedEvent; +use Cake\Cache\Event\CacheGroupClearEvent; use Cake\Core\Exception\CakeException; use Cake\Log\Log; use DateInterval; +use Generator; use Redis; +use RedisCluster; +use RedisClusterException; use RedisException; /** * Redis storage engine for cache. + * + * @extends \Cake\Cache\CacheEngine<\Cake\Cache\Engine\RedisEngine> */ class RedisEngine extends CacheEngine { @@ -34,11 +53,12 @@ class RedisEngine extends CacheEngine * * @var \Redis */ - protected Redis $_Redis; + protected Redis|RedisCluster $_Redis; /** * The default config used unless overridden by runtime configuration * + * - `clusterName` Redis cluster name * - `database` database number to use for connection. * - `duration` Specify how long items in this cache configuration last. * - `groups` List of groups or 'tags' associated to every key stored in this config. @@ -53,6 +73,16 @@ class RedisEngine extends CacheEngine * - `server` URL or IP to the Redis server host. * - `timeout` timeout in seconds (float). * - `unix_socket` Path to the unix socket file (default: false) + * - `readTimeout` Read timeout in seconds (float). + * - `nodes` When using redis-cluster, the URL or IP addresses of the + * Redis cluster nodes. + * Format: an array of strings in the form `:`, like: + * [ + * ':', + * ':', + * ':', + * ] + * - `failover` Failover mode (distribute,distribute_slaves,error,none). Cluster mode only. * - `clearUsesFlushDb` Enable clear() and clearBlocking() to use FLUSHDB. This will be * faster than standard clear()/clearBlocking() but will ignore prefixes and will * cause dataloss if other applications are sharing a redis database. @@ -60,6 +90,7 @@ class RedisEngine extends CacheEngine * @var array */ protected array $_defaultConfig = [ + 'clusterName' => null, 'database' => 0, 'duration' => 3600, 'groups' => [], @@ -73,6 +104,9 @@ class RedisEngine extends CacheEngine 'timeout' => 0, 'unix_socket' => false, 'scanCount' => 10, + 'readTimeout' => 0, + 'nodes' => [], + 'failover' => null, 'clearUsesFlushDb' => false, ]; @@ -105,6 +139,96 @@ public function init(array $config = []): bool * @return bool True if Redis server was connected */ protected function _connect(): bool + { + if (!empty($this->_config['nodes']) || !empty($this->_config['clusterName'])) { + return $this->connectRedisCluster(); + } + + return $this->connectRedis(); + } + + /** + * Connects to a Redis cluster server + * + * @return bool True if Redis server was connected + */ + protected function connectRedisCluster(): bool + { + $connected = false; + + if (empty($this->_config['nodes'])) { + // @codeCoverageIgnoreStart + if (class_exists(Log::class)) { + Log::error('RedisEngine requires one or more nodes in cluster mode'); + } + // @codeCoverageIgnoreEnd + + return false; + } + + // @codeCoverageIgnoreStart + $ssl = []; + if ($this->_config['tls']) { + $map = [ + 'ssl_ca' => 'cafile', + 'ssl_key' => 'local_pk', + 'ssl_cert' => 'local_cert', + 'verify_peer' => 'verify_peer', + 'verify_peer_name' => 'verify_peer_name', + 'allow_self_signed' => 'allow_self_signed', + ]; + + foreach ($map as $configKey => $sslOption) { + if (array_key_exists($configKey, $this->_config)) { + $ssl[$sslOption] = $this->_config[$configKey]; + } + } + } + // @codeCoverageIgnoreEnd + + try { + $this->_Redis = new RedisCluster( + $this->_config['clusterName'], + $this->_config['nodes'], + (float)$this->_config['timeout'], + (float)$this->_config['readTimeout'], + $this->_config['persistent'], + $this->_config['password'], + $this->_config['tls'] ? ['ssl' => $ssl] : null, // @codeCoverageIgnore + ); + + $connected = true; + } catch (RedisClusterException $e) { + $connected = false; + + // @codeCoverageIgnoreStart + if (class_exists(Log::class)) { + Log::error('RedisEngine could not connect to the redis cluster. Got error: ' . $e->getMessage()); + } + // @codeCoverageIgnoreEnd + } + + $failover = match ($this->_config['failover']) { + RedisCluster::FAILOVER_DISTRIBUTE, 'distribute' => RedisCluster::FAILOVER_DISTRIBUTE, + RedisCluster::FAILOVER_DISTRIBUTE_SLAVES, 'distribute_slaves' => RedisCluster::FAILOVER_DISTRIBUTE_SLAVES, + RedisCluster::FAILOVER_ERROR, 'error' => RedisCluster::FAILOVER_ERROR, + RedisCluster::FAILOVER_NONE, 'none' => RedisCluster::FAILOVER_NONE, + default => null, + }; + + if ($failover !== null) { + $this->_Redis->setOption(RedisCluster::OPT_SLAVE_FAILOVER, $failover); + } + + return $connected; + } + + /** + * Connects to a Redis server + * + * @return bool True if Redis server was connected + */ + protected function connectRedis(): bool { $tls = $this->_config['tls'] === true ? 'tls://' : ''; @@ -137,6 +261,7 @@ protected function _connect(): bool return false; } + if ($return && $this->_config['password']) { $return = $this->_Redis->auth($this->_config['password']); } @@ -222,13 +347,26 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null { $key = $this->_key($key); $value = $this->serialize($value); - $duration = $this->duration($ttl); + $this->_eventClass = CacheBeforeSetEvent::class; + $this->dispatchEvent(CacheBeforeSetEvent::NAME, ['key' => $key, 'value' => $value, 'ttl' => $duration]); + + $this->_eventClass = CacheAfterSetEvent::class; if ($duration === 0) { - return $this->_Redis->set($key, $value); + $success = $this->_Redis->set($key, $value); + $this->dispatchEvent(CacheAfterSetEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => $success, 'ttl' => $duration, + ]); + + return $success; } - return $this->_Redis->setEx($key, $duration, $value); + $success = $this->_Redis->setEx($key, $duration, $value); + $this->dispatchEvent(CacheAfterSetEvent::NAME, [ + 'key' => $key, 'value' => $value, 'success' => $success, 'ttl' => $duration, + ]); + + return $success; } /** @@ -241,12 +379,33 @@ public function set(string $key, mixed $value, DateInterval|int|null $ttl = null */ public function get(string $key, mixed $default = null): mixed { - $value = $this->_Redis->get($this->_key($key)); + $key = $this->_key($key); + $this->_eventClass = CacheBeforeGetEvent::class; + $this->dispatchEvent(CacheBeforeGetEvent::NAME, ['key' => $key, 'default' => $default]); + + $value = $this->_Redis->get($key); + + $this->_eventClass = CacheAfterGetEvent::class; if ($value === false) { + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => null, 'success' => false]); + return $default; } - return $this->unserialize($value); + $data = $this->unserialize($value); + $this->dispatchEvent(CacheAfterGetEvent::NAME, ['key' => $key, 'value' => $value, 'success' => true]); + + return $data; + } + + /** + * @inheritDoc + */ + public function has(string $key): bool + { + $res = $this->_Redis->exists($this->_key($key)); + + return is_int($res) ? $res > 0 : $res === true; } /** @@ -261,7 +420,15 @@ public function increment(string $key, int $offset = 1): int|false $duration = $this->_config['duration']; $key = $this->_key($key); + $this->_eventClass = CacheBeforeIncrementEvent::class; + $this->dispatchEvent(CacheBeforeIncrementEvent::NAME, ['key' => $key, 'offset' => $offset]); + $value = $this->_Redis->incrBy($key, $offset); + + $this->_eventClass = CacheAfterIncrementEvent::class; + $this->dispatchEvent(CacheAfterIncrementEvent::NAME, [ + 'key' => $key, 'offset' => $offset, 'success' => $value !== false, 'value' => $value, + ]); if ($duration > 0) { $this->_Redis->expire($key, $duration); } @@ -280,8 +447,15 @@ public function decrement(string $key, int $offset = 1): int|false { $duration = $this->_config['duration']; $key = $this->_key($key); + $this->_eventClass = CacheBeforeDecrementEvent::class; + $this->dispatchEvent(CacheBeforeDecrementEvent::NAME, ['key' => $key, 'offset' => $offset]); $value = $this->_Redis->decrBy($key, $offset); + + $this->_eventClass = CacheAfterDecrementEvent::class; + $this->dispatchEvent(CacheAfterDecrementEvent::NAME, [ + 'key' => $key, 'offset' => $offset, 'success' => $value !== false, 'value' => $value, + ]); if ($duration > 0) { $this->_Redis->expire($key, $duration); } @@ -298,8 +472,15 @@ public function decrement(string $key, int $offset = 1): int|false public function delete(string $key): bool { $key = $this->_key($key); + $this->_eventClass = CacheBeforeDeleteEvent::class; + $this->dispatchEvent(CacheBeforeDeleteEvent::NAME, ['key' => $key]); + + $success = (int)$this->_Redis->del($key) > 0; + + $this->_eventClass = CacheAfterDeleteEvent::class; + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => $success]); - return (int)$this->_Redis->del($key) > 0; + return $success; } /** @@ -313,8 +494,16 @@ public function delete(string $key): bool public function deleteAsync(string $key): bool { $key = $this->_key($key); + $this->_eventClass = CacheBeforeDeleteEvent::class; + $this->dispatchEvent(CacheBeforeDeleteEvent::NAME, ['key' => $key]); - return (int)$this->_Redis->unlink($key) > 0; + $result = $this->_Redis->unlink($key); + $success = is_int($result) && $result > 0; + + $this->_eventClass = CacheAfterDeleteEvent::class; + $this->dispatchEvent(CacheAfterDeleteEvent::NAME, ['key' => $key, 'success' => $success]); + + return $success; } /** @@ -325,29 +514,23 @@ public function deleteAsync(string $key): bool public function clear(): bool { if ($this->getConfig('clearUsesFlushDb')) { - $this->_Redis->flushDB(false); + $this->flushDB(true); + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return true; } - $this->_Redis->setOption(Redis::OPT_SCAN, (string)Redis::SCAN_RETRY); - $isAllDeleted = true; - $iterator = null; $pattern = $this->_config['prefix'] . '*'; - while (true) { - $keys = $this->_Redis->scan($iterator, $pattern, (int)$this->_config['scanCount']); - - if ($keys === false) { - break; - } - - foreach ($keys as $key) { - $isDeleted = ((int)$this->_Redis->unlink($key) > 0); - $isAllDeleted = $isAllDeleted && $isDeleted; - } + foreach ($this->scanKeys($pattern) as $key) { + $result = $this->_Redis->unlink($key); + $isDeleted = is_int($result) && $result > 0; + $isAllDeleted = $isAllDeleted && $isDeleted; } + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return $isAllDeleted; } @@ -360,29 +543,23 @@ public function clear(): bool public function clearBlocking(): bool { if ($this->getConfig('clearUsesFlushDb')) { - $this->_Redis->flushDB(true); + $this->flushDB(false); + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return true; } - $this->_Redis->setOption(Redis::OPT_SCAN, (string)Redis::SCAN_RETRY); - $isAllDeleted = true; - $iterator = null; $pattern = $this->_config['prefix'] . '*'; - while (true) { - $keys = $this->_Redis->scan($iterator, $pattern, (int)$this->_config['scanCount']); - - if ($keys === false) { - break; - } - - foreach ($keys as $key) { - $isDeleted = ((int)$this->_Redis->del($key) > 0); - $isAllDeleted = $isAllDeleted && $isDeleted; - } + foreach ($this->scanKeys($pattern) as $key) { + // Blocking delete + $isDeleted = ((int)$this->_Redis->del($key) > 0); + $isAllDeleted = $isAllDeleted && $isDeleted; } + $this->_eventClass = CacheClearedEvent::class; + $this->dispatchEvent(CacheClearedEvent::NAME); return $isAllDeleted; } @@ -400,11 +577,25 @@ public function add(string $key, mixed $value): bool { $duration = $this->_config['duration']; $key = $this->_key($key); + $origValue = $value; $value = $this->serialize($value); + $this->_eventClass = CacheBeforeAddEvent::class; + $this->dispatchEvent(CacheBeforeAddEvent::NAME, [ + 'key' => $key, 'value' => $origValue, 'ttl' => $duration, + ]); + + $this->_eventClass = CacheAfterAddEvent::class; if ($this->_Redis->set($key, $value, ['nx', 'ex' => $duration])) { + $this->dispatchEvent(CacheAfterAddEvent::NAME, [ + 'key' => $key, 'value' => $origValue, 'success' => true, 'ttl' => $duration, + ]); + return true; } + $this->dispatchEvent(CacheAfterAddEvent::NAME, [ + 'key' => $key, 'value' => $origValue, 'success' => false, 'ttl' => $duration, + ]); return false; } @@ -440,7 +631,11 @@ public function groups(): array */ public function clearGroup(string $group): bool { - return (bool)$this->_Redis->incr($this->_config['prefix'] . $group); + $success = (bool)$this->_Redis->incr($this->_config['prefix'] . $group); + $this->_eventClass = CacheGroupClearEvent::class; + $this->dispatchEvent(CacheGroupClearEvent::NAME, ['group' => $group]); + + return $success; } /** @@ -487,12 +682,70 @@ protected function _createRedisInstance(): Redis return new Redis(); } + /** + * Unifies Redis and RedisCluster scan() calls and simplifies its use. + * + * @param string $pattern Pattern to scan + * @return \Generator + */ + private function scanKeys(string $pattern): Generator + { + $this->_Redis->setOption(Redis::OPT_SCAN, (string)Redis::SCAN_RETRY); + + if ($this->_Redis instanceof RedisCluster) { + foreach ($this->_Redis->_masters() as $node) { + $iterator = null; + while (true) { + $keys = $this->_Redis->scan($iterator, $node, $pattern, (int)$this->_config['scanCount']); + if ($keys === false) { + break; + } + + if (is_array($keys)) { + foreach ($keys as $key) { + yield $key; + } + } + } + } + } else { + $iterator = null; + while (true) { + $keys = $this->_Redis->scan($iterator, $pattern, (int)$this->_config['scanCount']); + if ($keys === false) { + break; + } + + foreach ($keys as $key) { + yield $key; + } + } + } + } + + /** + * Flushes DB + * + * @param bool $async Whether to use asynchronous mode + * @return void + */ + private function flushDB(bool $async): void + { + if ($this->_Redis instanceof RedisCluster) { + foreach ($this->_Redis->_masters() as $node) { + $this->_Redis->flushDB($node, $async); + } + } else { + $this->_Redis->flushDB($async); + } + } + /** * Disconnects from the redis server */ public function __destruct() { - if (empty($this->_config['persistent'])) { + if (isset($this->_Redis) && !($this->_config['persistent'] ?? true)) { $this->_Redis->close(); } } diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterAddEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterAddEvent.php new file mode 100644 index 000000000..d920b0bac --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterAddEvent.php @@ -0,0 +1,119 @@ + + */ +class CacheAfterAddEvent extends Event +{ + public const NAME = 'Cache.afterAdd'; + + protected string $key; + + protected mixed $value = null; + + protected DateInterval|int|null $ttl = null; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['value'])) { + $this->value = $data['value']; + unset($data['value']); + } + if (isset($data['success'])) { + $this->result = $data['success']; + unset($data['success']); + } + if (isset($data['ttl'])) { + $this->ttl = $data['ttl']; + unset($data['ttl']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * The result value of the event listeners + * + * @return bool|null + */ + public function getResult(): ?bool + { + return $this->result; + } + + /** + * Listeners can attach a result value to the event. + * + * @param mixed $value The value to set. + * @return $this + */ + public function setResult(mixed $value = null) + { + if ($value !== null && !is_bool($value)) { + throw new InvalidArgumentException( + 'The result for CacheEngine events must be a `bool`.', + ); + } + + return parent::setResult($value); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * @return mixed + */ + public function getValue(): mixed + { + return $this->value; + } + + /** + * @return \DateInterval|int|null + */ + public function getTtl(): DateInterval|int|null + { + return $this->ttl; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterDecrementEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterDecrementEvent.php new file mode 100644 index 000000000..fd14dcce4 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterDecrementEvent.php @@ -0,0 +1,124 @@ + + */ +class CacheAfterDecrementEvent extends Event +{ + public const NAME = 'Cache.afterDecrement'; + + protected string $key; + + protected int $offset; + + protected mixed $value; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['offset'])) { + $this->offset = $data['offset']; + unset($data['offset']); + } + if (isset($data['value'])) { + $this->value = $data['value']; + unset($data['value']); + } + if (isset($data['success'])) { + $this->result = $data['success']; + unset($data['success']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * The result value of the event listeners + * + * @return bool|null + */ + public function getResult(): ?bool + { + return $this->result; + } + + /** + * Listeners can attach a result value to the event. + * + * @param mixed $value The value to set. + * @return $this + */ + public function setResult(mixed $value = null) + { + if ($value !== null && !is_bool($value)) { + throw new InvalidArgumentException( + 'The result for CacheEngine events must be a `bool`.', + ); + } + + return parent::setResult($value); + } + + /** + * Get the cache key. + * + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * Get the decrement offset. + * + * @return int + */ + public function getOffset(): int + { + return $this->offset; + } + + /** + * Get the new value after decrement. + * + * @return mixed + */ + public function getValue(): mixed + { + return $this->value; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterDeleteEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterDeleteEvent.php new file mode 100644 index 000000000..05cf27a44 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterDeleteEvent.php @@ -0,0 +1,90 @@ + + */ +class CacheAfterDeleteEvent extends Event +{ + public const NAME = 'Cache.afterDelete'; + + protected string $key; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['success'])) { + $this->result = $data['success']; + unset($data['success']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * The result value of the event listeners + * + * @return bool|null + */ + public function getResult(): ?bool + { + return $this->result; + } + + /** + * Listeners can attach a result value to the event. + * + * @param mixed $value The value to set. + * @return $this + */ + public function setResult(mixed $value = null) + { + if ($value !== null && !is_bool($value)) { + throw new InvalidArgumentException( + 'The result for CacheEngine events must be a `bool`.', + ); + } + + return parent::setResult($value); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterGetEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterGetEvent.php new file mode 100644 index 000000000..6dfe3da5a --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterGetEvent.php @@ -0,0 +1,104 @@ + + */ +class CacheAfterGetEvent extends Event +{ + public const NAME = 'Cache.afterGet'; + + protected string $key; + + protected mixed $value = null; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['value'])) { + $this->value = $data['value']; + unset($data['value']); + } + if (isset($data['success'])) { + $this->result = $data['success']; + unset($data['success']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * The result value of the event listeners + * + * @return bool|null + */ + public function getResult(): ?bool + { + return $this->result; + } + + /** + * Listeners can attach a result value to the event. + * + * @param mixed $value The value to set. + * @return $this + */ + public function setResult(mixed $value = null) + { + if ($value !== null && !is_bool($value)) { + throw new InvalidArgumentException( + 'The result for CacheEngine events must be a `bool`.', + ); + } + + return parent::setResult($value); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * @return mixed + */ + public function getValue(): mixed + { + return $this->value; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterIncrementEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterIncrementEvent.php new file mode 100644 index 000000000..fb7b36a8a --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterIncrementEvent.php @@ -0,0 +1,124 @@ + + */ +class CacheAfterIncrementEvent extends Event +{ + public const NAME = 'Cache.afterIncrement'; + + protected string $key; + + protected int $offset; + + protected mixed $value; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['offset'])) { + $this->offset = $data['offset']; + unset($data['offset']); + } + if (isset($data['value'])) { + $this->value = $data['value']; + unset($data['value']); + } + if (isset($data['success'])) { + $this->result = $data['success']; + unset($data['success']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * The result value of the event listeners + * + * @return bool|null + */ + public function getResult(): ?bool + { + return $this->result; + } + + /** + * Listeners can attach a result value to the event. + * + * @param mixed $value The value to set. + * @return $this + */ + public function setResult(mixed $value = null) + { + if ($value !== null && !is_bool($value)) { + throw new InvalidArgumentException( + 'The result for CacheEngine events must be a `bool`.', + ); + } + + return parent::setResult($value); + } + + /** + * Get the cache key. + * + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * Get the increment offset. + * + * @return int + */ + public function getOffset(): int + { + return $this->offset; + } + + /** + * Get the new value after increment. + * + * @return mixed + */ + public function getValue(): mixed + { + return $this->value; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterSetEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterSetEvent.php new file mode 100644 index 000000000..0e7b73653 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheAfterSetEvent.php @@ -0,0 +1,119 @@ + + */ +class CacheAfterSetEvent extends Event +{ + public const NAME = 'Cache.afterSet'; + + protected string $key; + + protected mixed $value = null; + + protected DateInterval|int|null $ttl = null; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['value'])) { + $this->value = $data['value']; + unset($data['value']); + } + if (isset($data['success'])) { + $this->result = $data['success']; + unset($data['success']); + } + if (isset($data['ttl'])) { + $this->ttl = $data['ttl']; + unset($data['ttl']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * The result value of the event listeners + * + * @return bool|null + */ + public function getResult(): ?bool + { + return $this->result; + } + + /** + * Listeners can attach a result value to the event. + * + * @param mixed $value The value to set. + * @return $this + */ + public function setResult(mixed $value = null) + { + if ($value !== null && !is_bool($value)) { + throw new InvalidArgumentException( + 'The result for CacheEngine events must be a `bool`.', + ); + } + + return parent::setResult($value); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * @return mixed + */ + public function getValue(): mixed + { + return $this->value; + } + + /** + * @return \DateInterval|int|null + */ + public function getTtl(): DateInterval|int|null + { + return $this->ttl; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeAddEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeAddEvent.php new file mode 100644 index 000000000..6762045e1 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeAddEvent.php @@ -0,0 +1,87 @@ + + */ +class CacheBeforeAddEvent extends Event +{ + public const NAME = 'Cache.beforeAdd'; + + protected string $key; + + protected mixed $value = null; + + protected DateInterval|int|null $ttl = null; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['value'])) { + $this->value = $data['value']; + unset($data['value']); + } + if (isset($data['ttl'])) { + $this->ttl = $data['ttl']; + unset($data['ttl']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * @return mixed + */ + public function getValue(): mixed + { + return $this->value; + } + + /** + * @return \DateInterval|int|null + */ + public function getTtl(): DateInterval|int|null + { + return $this->ttl; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeDecrementEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeDecrementEvent.php new file mode 100644 index 000000000..2857b76e3 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeDecrementEvent.php @@ -0,0 +1,76 @@ + + */ +class CacheBeforeDecrementEvent extends Event +{ + public const NAME = 'Cache.beforeDecrement'; + + protected string $key; + + protected int $offset; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['offset'])) { + $this->offset = $data['offset']; + unset($data['offset']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * Get the cache key. + * + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * Get the decrement offset. + * + * @return int + */ + public function getOffset(): int + { + return $this->offset; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeDeleteEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeDeleteEvent.php new file mode 100644 index 000000000..0998d9199 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeDeleteEvent.php @@ -0,0 +1,58 @@ + + */ +class CacheBeforeDeleteEvent extends Event +{ + public const NAME = 'Cache.beforeDelete'; + + protected string $key; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeGetEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeGetEvent.php new file mode 100644 index 000000000..fa8cb6939 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeGetEvent.php @@ -0,0 +1,72 @@ + + */ +class CacheBeforeGetEvent extends Event +{ + public const NAME = 'Cache.beforeGet'; + + protected string $key; + + protected mixed $default = null; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['default'])) { + $this->default = $data['default']; + unset($data['default']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * @return mixed + */ + public function getDefault(): mixed + { + return $this->default; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeIncrementEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeIncrementEvent.php new file mode 100644 index 000000000..e5c2ef481 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeIncrementEvent.php @@ -0,0 +1,76 @@ + + */ +class CacheBeforeIncrementEvent extends Event +{ + public const NAME = 'Cache.beforeIncrement'; + + protected string $key; + + protected int $offset; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['offset'])) { + $this->offset = $data['offset']; + unset($data['offset']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * Get the cache key. + * + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * Get the increment offset. + * + * @return int + */ + public function getOffset(): int + { + return $this->offset; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeSetEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeSetEvent.php new file mode 100644 index 000000000..c3f50391b --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheBeforeSetEvent.php @@ -0,0 +1,87 @@ + + */ +class CacheBeforeSetEvent extends Event +{ + public const NAME = 'Cache.beforeSet'; + + protected string $key; + + protected mixed $value = null; + + protected DateInterval|int|null $ttl = null; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['key'])) { + $this->key = $data['key']; + unset($data['key']); + } + if (isset($data['value'])) { + $this->value = $data['value']; + unset($data['value']); + } + if (isset($data['ttl'])) { + $this->ttl = $data['ttl']; + unset($data['ttl']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * @return string + */ + public function getKey(): string + { + return $this->key; + } + + /** + * @return mixed + */ + public function getValue(): mixed + { + return $this->value; + } + + /** + * @return \DateInterval|int|null + */ + public function getTtl(): DateInterval|int|null + { + return $this->ttl; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheClearedEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheClearedEvent.php new file mode 100644 index 000000000..200cb3b06 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheClearedEvent.php @@ -0,0 +1,30 @@ + + */ +class CacheClearedEvent extends Event +{ + public const NAME = 'Cache.cleared'; +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/Event/CacheGroupClearEvent.php b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheGroupClearEvent.php new file mode 100644 index 000000000..a6991e87f --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Cache/Event/CacheGroupClearEvent.php @@ -0,0 +1,60 @@ + + */ +class CacheGroupClearEvent extends Event +{ + public const NAME = 'Cache.clearedGroup'; + + protected string $group; + + /** + * Constructor + * + * @param string $name Name of the event + * @param TEngine $subject The Cache engine instance this event applies to. + * @param array $data Any value you wish to be transported with this event to it can be read by listeners. + */ + public function __construct(string $name, CacheEngine $subject, array $data = []) + { + if (isset($data['group'])) { + $this->group = $data['group']; + unset($data['group']); + } + + parent::__construct($name, $subject, $data); + } + + /** + * Get the group name + * + * @return string + */ + public function getGroup(): string + { + return $this->group; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Cache/composer.json b/app/vendor/cakephp/cakephp/src/Cache/composer.json index e978f708c..e0b427085 100644 --- a/app/vendor/cakephp/cakephp/src/Cache/composer.json +++ b/app/vendor/cakephp/cakephp/src/Cache/composer.json @@ -22,8 +22,9 @@ "source": "https://github.com/cakephp/cache" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev", + "php": ">=8.2", + "cakephp/core": "^5.3.0", + "cakephp/event": "^5.3.0", "psr/simple-cache": "^2.0 || ^3.0" }, "provide": { @@ -34,10 +35,11 @@ "Cake\\Cache\\": "." } }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Collection/Collection.php b/app/vendor/cakephp/cakephp/src/Collection/Collection.php index eaceff476..9480197e2 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Collection.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Collection.php @@ -17,23 +17,34 @@ namespace Cake\Collection; use ArrayIterator; -use Exception; use IteratorIterator; +use SplFixedArray; /** * A collection is an immutable list of elements with a handful of functions to * iterate, group, transform and extract information from it. * - * @template-extends \IteratorIterator> + * @template TKey + * @template TValue + * @extends \IteratorIterator> + * @implements \Cake\Collection\CollectionInterface */ class Collection extends IteratorIterator implements CollectionInterface { + /** @use \Cake\Collection\CollectionTrait */ use CollectionTrait; + /** + * Whether or not the items in this collection are an array. + * + * @var bool + */ + protected bool $innerIsArray = false; + /** * Constructor. You can provide an array or any traversable object * - * @param iterable $items Items. + * @param iterable $items Items. * @throws \InvalidArgumentException If passed incorrect type for items. */ public function __construct(iterable $items) @@ -42,11 +53,13 @@ public function __construct(iterable $items) $items = new ArrayIterator($items); } + $this->innerIsArray = $items instanceof ArrayIterator || $items instanceof SplFixedArray; + parent::__construct($items); } /** - * Returns an array for serializing this of this object. + * Returns an array for serializing this object. * * @return array */ @@ -63,6 +76,7 @@ public function __serialize(): array */ public function __unserialize(array $data): void { + /** @phpstan-ignore argument.type (unserialize rebuilds from array) */ $this->__construct($data); } @@ -74,14 +88,23 @@ public function __unserialize(array $data): void */ public function __debugInfo(): array { - try { - $count = $this->count(); - } catch (Exception) { - $count = 'An exception occurred while getting count'; + if ($this->innerIsArray) { + $index = $this->key(); + $items = $this->toArray(); + + $this->rewind(); + while ($this->key() !== $index) { + $this->next(); + } + + return [ + 'count' => count($items), + 'items' => $items, + ]; } return [ - 'count' => $count, + 'innerIterator' => $this->unwrap(), ]; } } diff --git a/app/vendor/cakephp/cakephp/src/Collection/CollectionInterface.php b/app/vendor/cakephp/cakephp/src/Collection/CollectionInterface.php index 2c1767632..e28527760 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/CollectionInterface.php +++ b/app/vendor/cakephp/cakephp/src/Collection/CollectionInterface.php @@ -26,7 +26,10 @@ * list of elements exposing a number of traversing and extracting method for * generating other collections. * - * @template-extends \Iterator + * @template TKey + * @template-covariant TValue + * @template-extends \Iterator + * @method bool any(callable $callback) */ interface CollectionInterface extends Iterator, JsonSerializable, Countable { @@ -42,6 +45,7 @@ interface CollectionInterface extends Iterator, JsonSerializable, Countable * ``` * * @param callable $callback Callback to run for each element in collection. + * Receives `($value, $key)` as parameters. * @return $this */ public function each(callable $callback); @@ -66,10 +70,10 @@ public function each(callable $callback); * }); * ``` * - * @param callable|null $callback the method that will receive each of the elements and - * returns true whether they should be in the resulting collection. + * @param callable|null $callback A callback receiving `($value, $key, $iterator)` that + * returns true if the element should be included in the resulting collection. * If left null, a callback that filters out falsey values will be used. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function filter(?callable $callback = null): CollectionInterface; @@ -92,10 +96,10 @@ public function filter(?callable $callback = null): CollectionInterface; * }); * ``` * - * @param callable|null $callback the method that will receive each of the elements and - * returns true whether they should be out of the resulting collection. + * @param callable|null $callback A callback receiving `($value, $key, $iterator)` that + * returns true if the element should be excluded from the resulting collection. * If left null, a callback that filters out truthy values will be used. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function reject(?callable $callback = null): CollectionInterface; @@ -106,9 +110,9 @@ public function reject(?callable $callback = null): CollectionInterface; * The callback is passed the value as the first argument and the key as the * second argument. * - * @param callable|null $callback the method that will receive each of the elements and - * returns the value used to determine uniqueness. - * @return self + * @param callable|null $callback A callback receiving `($value, $key)` that returns + * the value used to determine uniqueness. If left null, the element values themselves are used. + * @return \Cake\Collection\CollectionInterface */ public function unique(?callable $callback = null): CollectionInterface; @@ -129,8 +133,9 @@ public function unique(?callable $callback = null): CollectionInterface; * * Empty collections always return true. * - * @param callable $callback a callback function - * @return bool true if for all elements in this collection the provided + * @param callable $callback A callback receiving `($value, $key)` that returns + * true if the test passed, false otherwise. + * @return bool True if for all elements in this collection the provided * callback returns true, false otherwise. */ public function every(callable $callback): bool; @@ -142,6 +147,8 @@ public function every(callable $callback): bool; * The callback is passed the value and key of the element being tested and should * return true if the test passed. * + * Alias of ``Collection::any()``. + * * ### Example: * * ``` @@ -150,9 +157,10 @@ public function every(callable $callback): bool; * }); * ``` * - * @param callable $callback a callback function - * @return bool true if the provided callback returns true for any element in this - * collection, false otherwise + * @param callable $callback A callback receiving `($value, $key)` that returns + * true if the test passed, false otherwise. + * @return bool True if the provided callback returns true for any element in this + * collection, false otherwise */ public function some(callable $callback): bool; @@ -183,9 +191,9 @@ public function contains(mixed $value): bool; * }); * ``` * - * @param callable $callback the method that will receive each of the elements and - * returns the new value for the key that is being iterated - * @return self + * @param callable $callback A callback receiving `($value, $key, $iterator)` that + * returns the transformed value for each element. + * @return \Cake\Collection\CollectionInterface */ public function map(callable $callback): CollectionInterface; @@ -197,8 +205,9 @@ public function map(callable $callback): CollectionInterface; * If $initial is omitted the first value of the collection will be used in its place * and reduction will start from the second item. * - * @param callable $callback The callback function to be called - * @param mixed $initial The state of reduction + * @param callable $callback A callback receiving `($accumulator, $value, $key, $iterator)` + * that returns the updated accumulator for each iteration. + * @param mixed $initial The initial state of reduction * @return mixed */ public function reduce(callable $callback, mixed $initial = null): mixed; @@ -244,7 +253,7 @@ public function reduce(callable $callback, mixed $initial = null): mixed; * @param callable|string $path A dot separated path of column to follow * so that the final one can be returned or a callable that will take care * of doing that. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function extract(callable|string $path): CollectionInterface; @@ -393,7 +402,7 @@ public function median(callable|string|null $path = null): float|int|null; * @param callable|string $path The column name to use for sorting or callback that returns the value. * @param int $order The sort order, either SORT_DESC or SORT_ASC * @param int $sort The sort type, one of SORT_STRING, SORT_NUMERIC or SORT_NATURAL - * @return self + * @return \Cake\Collection\CollectionInterface */ public function sortBy( callable|string $path, @@ -440,7 +449,7 @@ public function sortBy( * * @param callable|string $path The column name to use for grouping or callback that returns the value. * or a function returning the grouping key out of the provided element - * @return self + * @return \Cake\Collection\CollectionInterface */ public function groupBy(callable|string $path): CollectionInterface; @@ -479,7 +488,7 @@ public function groupBy(callable|string $path): CollectionInterface; * * @param callable|string $path The column name to use for indexing or callback that returns the value. * or a function returning the indexing key out of the provided element - * @return self + * @return \Cake\Collection\CollectionInterface */ public function indexBy(callable|string $path): CollectionInterface; @@ -517,7 +526,7 @@ public function indexBy(callable|string $path): CollectionInterface; * * @param callable|string $path The column name to use for indexing or callback that returns the value. * or a function returning the indexing key out of the provided element - * @return self + * @return \Cake\Collection\CollectionInterface */ public function countBy(callable|string $path): CollectionInterface; @@ -552,7 +561,7 @@ public function sumOf(callable|string|null $path = null): float|int; * Returns a new collection with the elements placed in a random order, * this function does not preserve the original keys in the collection. * - * @return self + * @return \Cake\Collection\CollectionInterface */ public function shuffle(): CollectionInterface; @@ -562,7 +571,7 @@ public function shuffle(): CollectionInterface; * * @param int $length the maximum number of elements to randomly * take from this collection - * @return self + * @return \Cake\Collection\CollectionInterface */ public function sample(int $length = 10): CollectionInterface; @@ -574,7 +583,7 @@ public function sample(int $length = 10): CollectionInterface; * @param int $length the maximum number of elements to take from * this collection * @param int $offset A positional offset from where to take the elements - * @return self + * @return \Cake\Collection\CollectionInterface */ public function take(int $length = 1, int $offset = 0): CollectionInterface; @@ -593,7 +602,7 @@ public function take(int $length = 1, int $offset = 0): CollectionInterface; * ``` * * @param int $length The number of elements at the end of the collection - * @return self + * @return \Cake\Collection\CollectionInterface */ public function takeLast(int $length): CollectionInterface; @@ -602,7 +611,7 @@ public function takeLast(int $length): CollectionInterface; * at the beginning of the iteration. * * @param int $length The number of elements to skip. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function skip(int $length): CollectionInterface; @@ -626,10 +635,10 @@ public function skip(int $length): CollectionInterface; * ] * ``` * - * @param array $conditions a key-value list of conditions where - * the key is a property path as accepted by `Collection::extract`, - * and the value the condition against with each element will be matched - * @return self + * @param array $conditions A key-value list of conditions where + * the key is a property path as accepted by `Collection::extract`, + * and the value is the expected value to match against. + * @return \Cake\Collection\CollectionInterface */ public function match(array $conditions): CollectionInterface; @@ -637,25 +646,25 @@ public function match(array $conditions): CollectionInterface; * Returns the first result matching all the key-value pairs listed in * conditions. * - * @param array $conditions a key-value list of conditions where the key is - * a property path as accepted by `Collection::extract`, and the value the - * condition against with each element will be matched + * @param array $conditions A key-value list of conditions where the key is + * a property path as accepted by `Collection::extract`, and the value is + * the expected value to match against. * @see \Cake\Collection\CollectionInterface::match() - * @return mixed + * @return TValue|null */ public function firstMatch(array $conditions): mixed; /** * Returns the first result in this collection * - * @return mixed The first value in the collection will be returned. + * @return TValue|null The first value in the collection will be returned. */ public function first(): mixed; /** * Returns the last result in this collection * - * @return mixed The last value in the collection will be returned. + * @return TValue|null The last value in the collection will be returned. */ public function last(): mixed; @@ -664,7 +673,7 @@ public function last(): mixed; * in this collection with the passed list of elements * * @param iterable $items Items list. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function append(iterable $items): CollectionInterface; @@ -673,7 +682,7 @@ public function append(iterable $items): CollectionInterface; * * @param mixed $item The item to append. * @param mixed $key The key to append the item with. If null a key will be generated. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function appendItem(mixed $item, mixed $key = null): CollectionInterface; @@ -681,7 +690,7 @@ public function appendItem(mixed $item, mixed $key = null): CollectionInterface; * Prepend a set of items to a collection creating a new collection * * @param iterable $items The items to prepend. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function prepend(iterable $items): CollectionInterface; @@ -690,7 +699,7 @@ public function prepend(iterable $items): CollectionInterface; * * @param mixed $item The item to prepend. * @param mixed $key The key to prepend the item with. If null a key will be generated. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function prependItem(mixed $item, mixed $key = null): CollectionInterface; @@ -732,7 +741,7 @@ public function prependItem(mixed $item, mixed $key = null): CollectionInterface * or a function returning the value out of the provided element * @param callable|string|null $groupPath the column name path to use as the parent * grouping key or a function returning the key out of the provided element - * @return self + * @return \Cake\Collection\CollectionInterface */ public function combine( callable|string $keyPath, @@ -749,7 +758,7 @@ public function combine( * @param callable|string $parentPath the column name path to use for determining * whether an element is a child of another * @param string $nestingKey The key name under which children are nested - * @return self + * @return \Cake\Collection\CollectionInterface */ public function nest( callable|string $idPath, @@ -791,7 +800,7 @@ public function nest( * inside the hierarchy of each value so that the value can be inserted * @param mixed $values The values to be inserted at the specified path, * values are matched with the elements in this collection by its positional index. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function insert(string $path, mixed $values): CollectionInterface; @@ -802,7 +811,8 @@ public function insert(string $path, mixed $values): CollectionInterface; * collection as the array keys. Keep in mind that it is valid for iterators * to return the same key for different elements, setting this value to false * can help getting all items if keys are not important in the result. - * @return array + * @phpstan-return ($keepKeys is true ? array : array) + * @return array|array */ public function toArray(bool $keepKeys = true): array; @@ -810,7 +820,7 @@ public function toArray(bool $keepKeys = true): array; * Returns an numerically-indexed array representation of the results. * This is equivalent to calling `toArray(false)` * - * @return array + * @return array */ public function toList(): array; @@ -854,7 +864,7 @@ public function jsonSerialize(): array; * collection as the array keys. Keep in mind that it is valid for iterators * to return the same key for different elements, setting this value to false * can help getting all items if keys are not important in the result. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function compile(bool $keepKeys = true): CollectionInterface; @@ -864,7 +874,7 @@ public function compile(bool $keepKeys = true): CollectionInterface; * * A lazy collection can only be iterated once. A second attempt results in an error. * - * @return self + * @return \Cake\Collection\CollectionInterface */ public function lazy(): CollectionInterface; @@ -875,7 +885,7 @@ public function lazy(): CollectionInterface; * * This can also be used to make any non-rewindable iterator rewindable. * - * @return self + * @return \Cake\Collection\CollectionInterface */ public function buffered(): CollectionInterface; @@ -916,7 +926,7 @@ public function buffered(): CollectionInterface; * @param string|int $order The order in which to return the elements * @param callable|string $nestingKey The key name under which children are nested * or a callable function that will return the children list - * @return self + * @return \Cake\Collection\CollectionInterface */ public function listNested( string|int $order = 'desc', @@ -949,12 +959,12 @@ public function listNested( * $comments = (new Collection($comments))->stopWhen(['is_approved' => false]); * ``` * - * @param callable|array $condition the method that will receive each of the elements and + * @param callable|array $condition the method that will receive each of the elements and * returns true when the iteration should be stopped. * If an array, it will be interpreted as a key-value list of conditions where * the key is a property path as accepted by `Collection::extract`, * and the value the condition against with each element will be matched. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function stopWhen(callable|array $condition): CollectionInterface; @@ -989,7 +999,7 @@ public function stopWhen(callable|array $condition): CollectionInterface; * * @param callable|null $callback A callable function that will receive each of * the items in the collection and should return an array or Traversable object - * @return self + * @return \Cake\Collection\CollectionInterface */ public function unfold(?callable $callback = null): CollectionInterface; @@ -1008,7 +1018,7 @@ public function unfold(?callable $callback = null): CollectionInterface; * * @param callable $callback A callable function that will receive * this collection as first argument. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function through(callable $callback): CollectionInterface; @@ -1024,7 +1034,7 @@ public function through(callable $callback): CollectionInterface; * ``` * * @param iterable ...$items The collections to zip. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function zip(iterable ...$items): CollectionInterface; @@ -1047,7 +1057,7 @@ public function zip(iterable ...$items): CollectionInterface; * * @param iterable ...$items The collections to zip. * @param callable $callback The function to use for zipping the elements together. - * @return self + * @return \Cake\Collection\CollectionInterface */ public function zipWith(iterable $items, $callback): CollectionInterface; // phpcs:enable @@ -1064,7 +1074,7 @@ public function zipWith(iterable $items, $callback): CollectionInterface; * ``` * * @param int $chunkSize The maximum size for each chunk - * @return self + * @return \Cake\Collection\CollectionInterface> */ public function chunk(int $chunkSize): CollectionInterface; @@ -1081,7 +1091,7 @@ public function chunk(int $chunkSize): CollectionInterface; * * @param int $chunkSize The maximum size for each chunk * @param bool $keepKeys If the keys of the array should be kept - * @return self + * @return \Cake\Collection\CollectionInterface> */ public function chunkWithKeys(int $chunkSize, bool $keepKeys = true): CollectionInterface; @@ -1136,7 +1146,7 @@ public function unwrap(): Iterator; * // ] * ``` * - * @return self + * @return \Cake\Collection\CollectionInterface> */ public function transpose(): CollectionInterface; @@ -1216,7 +1226,7 @@ public function countKeys(): int; * @param callable|null $operation A callable that allows you to customize the product result. * @param callable|null $filter A filtering callback that must return true for a result to be part * of the final results. - * @return self + * @return \Cake\Collection\CollectionInterface> */ public function cartesianProduct(?callable $operation = null, ?callable $filter = null): CollectionInterface; } diff --git a/app/vendor/cakephp/cakephp/src/Collection/CollectionTrait.php b/app/vendor/cakephp/cakephp/src/Collection/CollectionTrait.php index 07b0c7e7e..6712b3954 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/CollectionTrait.php +++ b/app/vendor/cakephp/cakephp/src/Collection/CollectionTrait.php @@ -46,6 +46,10 @@ /** * Offers a handful of methods to manipulate iterators + * + * @template TKey + * @template TValue + * @require-implements \Cake\Collection\CollectionInterface */ trait CollectionTrait { @@ -58,7 +62,7 @@ trait CollectionTrait * type of returned collection interface * * @param mixed ...$args Constructor arguments. - * @return \Cake\Collection\CollectionInterface + * @return \Cake\Collection\CollectionInterface */ protected function newCollection(mixed ...$args): CollectionInterface { @@ -78,7 +82,9 @@ public function each(callable $callback) } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function filter(?callable $callback = null): CollectionInterface { @@ -88,7 +94,9 @@ public function filter(?callable $callback = null): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function reject(?callable $callback = null): CollectionInterface { @@ -98,7 +106,9 @@ public function reject(?callable $callback = null): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function unique(?callable $callback = null): CollectionInterface { @@ -122,9 +132,22 @@ public function every(callable $callback): bool } /** - * @inheritDoc + * Returns true if the callback returns true for any element in the collection. + * + * The callback accepts the value and key of the element being tested. + * + * ### Example: + * + * ``` + * $hasYoungPeople = (new Collection([24, 45, 15]))->any(function ($value, $key) { + * return $value < 21; + * }); + * ``` + * + * @param callable $callback a callback function + * @return bool */ - public function some(callable $callback): bool + public function any(callable $callback): bool { foreach ($this->optimizeUnwrap() as $key => $value) { if ($callback($value, $key) === true) { @@ -135,6 +158,14 @@ public function some(callable $callback): bool return false; } + /** + * @inheritDoc + */ + public function some(callable $callback): bool + { + return $this->any($callback); + } + /** * @inheritDoc */ @@ -150,7 +181,9 @@ public function contains(mixed $value): bool } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function map(callable $callback): CollectionInterface { @@ -178,7 +211,9 @@ public function reduce(callable $callback, mixed $initial = null): mixed } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function extract(callable|string $path): CollectionInterface { @@ -220,10 +255,9 @@ public function avg(callable|string|null $path = null): float|int|null $result = $result->extract($path); } $result = $result - ->reduce(function ($acc, $current) { - [$count, $sum] = $acc; - - return [$count + 1, $sum + $current]; + ->reduce(function (array $acc, $current) { + // index 0 is the count, index 1 is the sum + return [$acc[0] + 1, $acc[1] + $current]; }, [0, 0]); if ($result[0] === 0) { @@ -260,7 +294,9 @@ public function median(callable|string|null $path = null): float|int|null } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function sortBy(callable|string $path, int $order = SORT_DESC, int $sort = SORT_NUMERIC): CollectionInterface { @@ -308,7 +344,7 @@ public function sortBy(callable|string $path, int $order = SORT_DESC, int $sort * or a function returning the grouping key out of the provided element * @param bool $preserveKeys Whether to preserve the keys of the existing * collection when the values are grouped. Defaults to false. - * @return \Cake\Collection\CollectionInterface + * @return \Cake\Collection\CollectionInterface */ public function groupBy(callable|string $path, bool $preserveKeys = false): CollectionInterface { @@ -340,7 +376,9 @@ public function groupBy(callable|string $path, bool $preserveKeys = false): Coll } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function indexBy(callable|string $path): CollectionInterface { @@ -367,7 +405,9 @@ public function indexBy(callable|string $path): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function countBy(callable|string $path): CollectionInterface { @@ -376,7 +416,7 @@ public function countBy(callable|string $path): CollectionInterface $mapper = fn($value, $key, MapReduce $mr) => $mr->emitIntermediate($value, $callback($value)); $reducer = fn($values, $key, MapReduce $mr) => $mr->emit(count($values), $key); - return $this->newCollection(new MapReduce($this->unwrap(), $mapper, $reducer)); + return $this->newCollection(new MapReduce($this->unwrap(), $mapper, $reducer)); // @phpstan-ignore return.type } /** @@ -398,26 +438,32 @@ public function sumOf(callable|string|null $path = null): float|int } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function shuffle(): CollectionInterface { $items = $this->toList(); shuffle($items); - return $this->newCollection($items); + return $this->newCollection($items); // @phpstan-ignore return.type } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function sample(int $length = 10): CollectionInterface { - return $this->newCollection(new LimitIterator($this->shuffle(), 0, $length)); + return $this->newCollection(new LimitIterator($this->shuffle(), 0, $length)); // @phpstan-ignore return.type } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function take(int $length = 1, int $offset = 0): CollectionInterface { @@ -425,7 +471,9 @@ public function take(int $length = 1, int $offset = 0): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function skip(int $length): CollectionInterface { @@ -433,7 +481,9 @@ public function skip(int $length): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function match(array $conditions): CollectionInterface { @@ -488,7 +538,9 @@ public function last(): mixed } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function takeLast(int $length): CollectionInterface { @@ -587,7 +639,9 @@ public function takeLast(int $length): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function append(iterable $items): CollectionInterface { @@ -599,7 +653,9 @@ public function append(iterable $items): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function appendItem(mixed $item, mixed $key = null): CollectionInterface { @@ -613,7 +669,9 @@ public function appendItem(mixed $item, mixed $key = null): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function prepend(mixed $items): CollectionInterface { @@ -621,7 +679,9 @@ public function prepend(mixed $items): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function prependItem(mixed $item, mixed $key = null): CollectionInterface { @@ -635,7 +695,9 @@ public function prependItem(mixed $item, mixed $key = null): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function combine( callable|string $keyPath, @@ -706,7 +768,9 @@ public function combine( } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function nest( callable|string $idPath, @@ -750,13 +814,15 @@ public function nest( return $this->newCollection(new MapReduce($this->unwrap(), $mapper, $reducer)) ->map(function ($value) use ($isObject) { - /** @var \ArrayIterator|\ArrayObject $value */ + /** @var \ArrayIterator|\ArrayObject $value */ return $isObject ? $value : $value->getArrayCopy(); }); } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function insert(string $path, mixed $values): CollectionInterface { @@ -800,7 +866,9 @@ public function jsonSerialize(): array } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function compile(bool $keepKeys = true): CollectionInterface { @@ -808,7 +876,9 @@ public function compile(bool $keepKeys = true): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function lazy(): CollectionInterface { @@ -822,7 +892,9 @@ public function lazy(): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function buffered(): CollectionInterface { @@ -830,7 +902,9 @@ public function buffered(): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function listNested( string|int $order = 'desc', @@ -854,9 +928,15 @@ public function listNested( } assert( - $order === RecursiveIteratorIterator::LEAVES_ONLY || - $order === RecursiveIteratorIterator::SELF_FIRST || - $order === RecursiveIteratorIterator::CHILD_FIRST, + in_array( + $order, + [ + RecursiveIteratorIterator::LEAVES_ONLY, + RecursiveIteratorIterator::SELF_FIRST, + RecursiveIteratorIterator::CHILD_FIRST, + ], + true, + ), ); return new TreeIterator( @@ -866,7 +946,9 @@ public function listNested( } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function stopWhen(callable|array $condition): CollectionInterface { @@ -878,7 +960,9 @@ public function stopWhen(callable|array $condition): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function unfold(?callable $callback = null): CollectionInterface { @@ -893,7 +977,9 @@ public function unfold(?callable $callback = null): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function through(callable $callback): CollectionInterface { @@ -903,7 +989,9 @@ public function through(callable $callback): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface */ public function zip(iterable ...$items): CollectionInterface { @@ -911,9 +999,13 @@ public function zip(iterable ...$items): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @param iterable $items Items to zip. + * @param callable $callback The callback to apply. + * @return \Cake\Collection\CollectionInterface */ - public function zipWith(iterable $items, $callback): CollectionInterface + public function zipWith(iterable $items, mixed $callback): CollectionInterface { if (func_num_args() > 2) { $items = func_get_args(); @@ -927,10 +1019,13 @@ public function zipWith(iterable $items, $callback): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface> */ public function chunk(int $chunkSize): CollectionInterface { + // @phpstan-ignore return.type return $this->map(function ($v, $k, Iterator $iterator) use ($chunkSize) { $values = [$v]; for ($i = 1; $i < $chunkSize; $i++) { @@ -946,10 +1041,13 @@ public function chunk(int $chunkSize): CollectionInterface } /** - * @inheritDoc + * {@inheritDoc} + * + * @return \Cake\Collection\CollectionInterface> */ public function chunkWithKeys(int $chunkSize, bool $keepKeys = true): CollectionInterface { + // @phpstan-ignore return.type return $this->map(function ($v, $k, Iterator $iterator) use ($chunkSize, $keepKeys) { $key = 0; if ($keepKeys) { @@ -991,7 +1089,18 @@ public function isEmpty(): bool public function unwrap(): Iterator { $iterator = $this; - while ($iterator::class === Collection::class) { + // Unwrap Collection class and simple user subclasses. + // Internal CakePHP iterators/result sets have their own unwrap() implementations. + // We unwrap if the class is Collection itself, or a non-Cake subclass, + // or an anonymous class extending Collection. + while ( + $iterator instanceof Collection && + ( + $iterator::class === Collection::class || + !str_starts_with($iterator::class, 'Cake\\') || + str_contains($iterator::class, '@anonymous') + ) + ) { $iterator = $iterator->getInnerIterator(); } @@ -1009,13 +1118,13 @@ public function unwrap(): Iterator * @param callable|null $operation A callable that allows you to customize the product result. * @param callable|null $filter A filtering callback that must return true for a result to be part * of the final results. - * @return \Cake\Collection\CollectionInterface + * @return \Cake\Collection\CollectionInterface> * @throws \LogicException */ public function cartesianProduct(?callable $operation = null, ?callable $filter = null): CollectionInterface { if ($this->isEmpty()) { - return $this->newCollection([]); + return $this->newCollection([]); // @phpstan-ignore return.type } $collectionArrays = []; @@ -1023,11 +1132,14 @@ public function cartesianProduct(?callable $operation = null, ?callable $filter $collectionArraysCounts = []; foreach ($this->toList() as $value) { + /** @phpstan-ignore argument.type (cartesianProduct requires array values) */ $valueCount = count($value); + /** @phpstan-ignore argument.type */ if ($valueCount !== count($value, COUNT_RECURSIVE)) { throw new LogicException('Cannot find the cartesian product of a multidimensional array'); } + /** @phpstan-ignore argument.type (cartesianProduct requires array values) */ $collectionArraysKeys[] = array_keys($value); $collectionArraysCounts[] = $valueCount; $collectionArrays[] = $value; @@ -1041,7 +1153,7 @@ public function cartesianProduct(?callable $operation = null, ?callable $filter $changeIndex = $lastIndex; while (!($changeIndex === 0 && $currentIndexes[0] === $collectionArraysCounts[0])) { - $currentCombination = array_map(function ($value, $keys, $index) { + $currentCombination = array_map(function ($value, array $keys, $index) { return $value[$keys[$index]]; }, $collectionArrays, $collectionArraysKeys, $currentIndexes); @@ -1061,21 +1173,23 @@ public function cartesianProduct(?callable $operation = null, ?callable $filter } } - return $this->newCollection($result); + return $this->newCollection($result); // @phpstan-ignore return.type } /** * {@inheritDoc} * - * @return \Cake\Collection\CollectionInterface + * @return \Cake\Collection\CollectionInterface> * @throws \LogicException */ public function transpose(): CollectionInterface { $arrayValue = $this->toList(); + /** @phpstan-ignore argument.type (transpose requires array values) */ $length = count(current($arrayValue)); $result = []; foreach ($arrayValue as $row) { + /** @phpstan-ignore argument.type (transpose requires array values) */ if (count($row) !== $length) { throw new LogicException('Child arrays do not have even length'); } @@ -1085,7 +1199,7 @@ public function transpose(): CollectionInterface $result[] = array_column($arrayValue, $column); } - return $this->newCollection($result); + return $this->newCollection($result); // @phpstan-ignore return.type } /** diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/BufferedIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/BufferedIterator.php index 079a4a320..fcd689fcd 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/BufferedIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/BufferedIterator.php @@ -22,6 +22,10 @@ /** * Creates an iterator from another iterator that will keep the results of the inner * iterator in memory, so that results don't have to be re-calculated. + * + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection */ class BufferedIterator extends Collection { @@ -72,7 +76,7 @@ class BufferedIterator extends Collection * Maintains an in-memory cache of the results yielded by the internal * iterator. * - * @param iterable $items The items to be filtered. + * @param iterable $items The items to be filtered. */ public function __construct(iterable $items) { diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/ExtractIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/ExtractIterator.php index 4c5f161c0..769d244fe 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/ExtractIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/ExtractIterator.php @@ -24,6 +24,9 @@ /** * Creates an iterator from another iterator that extract the requested column * or property based on a path + * + * @template TKey + * @extends \Cake\Collection\Collection */ class ExtractIterator extends Collection { @@ -51,7 +54,7 @@ class ExtractIterator extends Collection * $extractor = new ExtractIterator($items, 'comment.user.name'); * ``` * - * @param iterable $items The list of values to iterate + * @param iterable $items The list of values to iterate * @param callable|string $path A dot separated path of column to follow * so that the final one can be returned or a callable that will take care * of doing that. diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/FilterIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/FilterIterator.php index b72721b88..3095ac373 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/FilterIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/FilterIterator.php @@ -26,6 +26,10 @@ * Creates a filtered iterator from another iterator. The filtering is done by * passing a callback function to each of the elements and taking them out if * it does not return true. + * + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection */ class FilterIterator extends Collection { @@ -44,7 +48,7 @@ class FilterIterator extends Collection * in the current iteration, the key of the element and the passed $items iterator * as arguments, in that order. * - * @param iterable $items The items to be filtered. + * @param iterable $items The items to be filtered. * @param callable $callback Callback. */ public function __construct(iterable $items, callable $callback) @@ -63,7 +67,7 @@ public function __construct(iterable $items, callable $callback) */ public function unwrap(): Iterator { - /** @var \IteratorIterator $filter */ + /** @var \IteratorIterator> $filter */ $filter = $this->getInnerIterator(); $iterator = $filter->getInnerIterator(); diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/InsertIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/InsertIterator.php index 190128f82..36163f1c5 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/InsertIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/InsertIterator.php @@ -23,13 +23,17 @@ * The values to be inserted come out of another traversal object. This is useful * when you have two separate collections and want to merge them together by placing * each of the values from one collection into a property inside the other collection. + * + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection */ class InsertIterator extends Collection { /** * The collection from which to extract the values to be inserted * - * @var \Cake\Collection\Collection + * @var \Cake\Collection\Collection */ protected Collection $_values; @@ -59,11 +63,11 @@ class InsertIterator extends Collection * Constructs a new collection that will dynamically add properties to it out of * the values found in $values. * - * @param iterable $into The target collection to which the values will + * @param iterable $into The target collection to which the values will * be inserted at the specified path. * @param string $path A dot separated list of properties that need to be traversed * to insert the value into the target collection. - * @param iterable $values The source collection from which the values will + * @param iterable $values The source collection from which the values will * be inserted at the specified path. */ public function __construct(iterable $into, string $path, iterable $values) diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/MapReduce.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/MapReduce.php index feb56e076..e5b301bd5 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/MapReduce.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/MapReduce.php @@ -149,7 +149,7 @@ public function getIterator(): Traversable public function emitIntermediate(mixed $val, mixed $bucket, mixed $key = null): void { if ($key === null) { - $this->_intermediate[$bucket][] = $val; + $this->_intermediate[$bucket ?? ''][] = $val; return; } @@ -162,7 +162,7 @@ public function emitIntermediate(mixed $val, mixed $bucket, mixed $key = null): * for this record. * * @param mixed $val The value to be appended to the final list of results - * @param mixed $key and optional key to assign to the value + * @param mixed $key An optional key to assign to the value * @return void */ public function emit(mixed $val, mixed $key = null): void @@ -172,8 +172,8 @@ public function emit(mixed $val, mixed $key = null): void } /** - * Runs the actual Map-Reduce algorithm. This is iterate the original data - * and call the mapper function for each , then for each intermediate + * Runs the actual Map-Reduce algorithm. This iterates the original data + * and calls the mapper function for each record, then for each intermediate * bucket created during the Map phase call the reduce function. * * @return void diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/NestIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/NestIterator.php index 8e5b8abd1..2735cfdbf 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/NestIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/NestIterator.php @@ -24,7 +24,8 @@ * A type of collection that is aware of nested items and exposes methods to * check or retrieve them * - * @template-implements \RecursiveIterator + * @extends \Cake\Collection\Collection + * @implements \RecursiveIterator */ class NestIterator extends Collection implements RecursiveIterator { diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/NoChildrenIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/NoChildrenIterator.php index 23c7ce68c..dcd948b42 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/NoChildrenIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/NoChildrenIterator.php @@ -24,7 +24,10 @@ * a RecursiveIterator but do not want children. This iterator will * always behave as having no nested items. * - * @template-implements \RecursiveIterator + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection + * @implements \RecursiveIterator */ class NoChildrenIterator extends Collection implements RecursiveIterator { diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/ReplaceIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/ReplaceIterator.php index 15d39c953..1f2bb10ec 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/ReplaceIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/ReplaceIterator.php @@ -25,6 +25,9 @@ /** * Creates an iterator from another iterator that will modify each of the values * by converting them using a callback function. + * + * @template TKey + * @extends \Cake\Collection\Collection */ class ReplaceIterator extends Collection { @@ -50,7 +53,7 @@ class ReplaceIterator extends Collection * in the current iteration, the key of the element and the passed $items iterator * as arguments, in that order. * - * @param iterable $items The items to be filtered. + * @param iterable $items The items to be filtered. * @param callable $callback Callback. */ public function __construct(iterable $items, callable $callback) diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/SortIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/SortIterator.php index 4160a4bc4..d2e0d3c6c 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/SortIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/SortIterator.php @@ -43,6 +43,10 @@ * ``` * * This iterator does not preserve the keys passed in the original elements. + * + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection */ class SortIterator extends Collection { @@ -55,7 +59,7 @@ class SortIterator extends Collection * element. Please note that the callback function could be called more than once * per element. * - * @param iterable $items The values to sort + * @param iterable $items The values to sort * @param callable|string $callback A function used to return the actual value to * be compared. It can also be a string representing the path to use to fetch a * column or property in each element @@ -92,6 +96,7 @@ public function __construct( foreach (array_keys($results) as $key) { $results[$key] = $items[$key]; } + /** @phpstan-ignore argument.type (sorted array keys may differ from TKey) */ parent::__construct($results); } diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/StoppableIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/StoppableIterator.php index 44225c6bf..b148e1c65 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/StoppableIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/StoppableIterator.php @@ -29,6 +29,9 @@ * * @internal * @see \Cake\Collection\Collection::stopWhen() + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection */ class StoppableIterator extends Collection { @@ -53,7 +56,7 @@ class StoppableIterator extends Collection * in the current iteration, the key of the element and the passed $items iterator * as arguments, in that order. * - * @param iterable $items The list of values to iterate + * @param iterable $items The list of values to iterate * @param callable $condition A function that will be called for each item in * the collection, if the result evaluates to false, no more items will be * yielded from this iterator. diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreeIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreeIterator.php index ad8a9fb72..c4286fbf6 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreeIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreeIterator.php @@ -25,10 +25,14 @@ * A Recursive iterator used to flatten nested structures and also exposes * all Collection methods * - * @template-extends \RecursiveIteratorIterator<\RecursiveIterator> + * @template TKey + * @template TValue + * @template-extends \RecursiveIteratorIterator<\RecursiveIterator> + * @implements \Cake\Collection\CollectionInterface */ class TreeIterator extends RecursiveIteratorIterator implements CollectionInterface { + /** @use \Cake\Collection\CollectionTrait */ use CollectionTrait; /** @@ -93,7 +97,7 @@ public function __construct( * callable returning the key value. * @param string $spacer The string to use for prefixing the values according to * their depth in the tree - * @return \Cake\Collection\Iterator\TreePrinter + * @return \Cake\Collection\Iterator\TreePrinter */ public function printer( callable|string $valuePath, @@ -107,7 +111,7 @@ public function printer( }; } - /** @var \RecursiveIterator $iterator */ + /** @var \RecursiveIterator $iterator */ $iterator = $this->getInnerIterator(); return new TreePrinter( diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreePrinter.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreePrinter.php index 8a4c4bc2c..9bc6e7097 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreePrinter.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/TreePrinter.php @@ -25,10 +25,14 @@ * Iterator for flattening elements in a tree structure while adding some * visual markers for their relative position in the tree * - * @template-extends \RecursiveIteratorIterator<\RecursiveIterator> + * @template TKey + * @template TValue + * @template-extends \RecursiveIteratorIterator<\RecursiveIterator> + * @implements \Cake\Collection\CollectionInterface */ class TreePrinter extends RecursiveIteratorIterator implements CollectionInterface { + /** @use \Cake\Collection\CollectionTrait */ use CollectionTrait; /** diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/UnfoldIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/UnfoldIterator.php index 8827460ff..fdc706e73 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/UnfoldIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/UnfoldIterator.php @@ -22,7 +22,7 @@ /** * An iterator that can be used to generate nested iterators out of a collection - * of items by applying an function to each of the elements in this iterator. + * of items by applying a function to each of the elements in this iterator. * * @internal * @see \Cake\Collection\Collection::unfold() diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/UniqueIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/UniqueIterator.php index 49e7e4449..970f91d27 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/UniqueIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/UniqueIterator.php @@ -22,6 +22,10 @@ * Creates a filtered iterator from another iterator. The filtering is done by * passing a callback function to each of the elements and taking them out if * the value returned is not unique. + * + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection */ class UniqueIterator extends Collection { @@ -32,7 +36,7 @@ class UniqueIterator extends Collection * The callback is passed the value as the first argument and the key as the * second argument. * - * @param iterable $items The items to be filtered. + * @param iterable $items The items to be filtered. * @param callable $callback Callback. */ public function __construct(iterable $items, callable $callback) diff --git a/app/vendor/cakephp/cakephp/src/Collection/Iterator/ZipIterator.php b/app/vendor/cakephp/cakephp/src/Collection/Iterator/ZipIterator.php index 0288455c0..673067041 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/Iterator/ZipIterator.php +++ b/app/vendor/cakephp/cakephp/src/Collection/Iterator/ZipIterator.php @@ -42,9 +42,14 @@ * }); * $iterator->toList(); // Returns [4, 6] * ``` + * + * @template TKey + * @template TValue + * @implements \Cake\Collection\CollectionInterface */ class ZipIterator implements CollectionInterface { + /** @use \Cake\Collection\CollectionTrait */ use CollectionTrait; /** diff --git a/app/vendor/cakephp/cakephp/src/Collection/composer.json b/app/vendor/cakephp/cakephp/src/Collection/composer.json index aa4fe5cae..7dd09ba7d 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/composer.json +++ b/app/vendor/cakephp/cakephp/src/Collection/composer.json @@ -23,7 +23,7 @@ "source": "https://github.com/cakephp/collection" }, "require": { - "php": ">=8.1" + "php": ">=8.2" }, "autoload": { "psr-4": { @@ -35,7 +35,7 @@ }, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Collection/functions.php b/app/vendor/cakephp/cakephp/src/Collection/functions.php index e84369b1c..8cdcec5ac 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/functions.php +++ b/app/vendor/cakephp/cakephp/src/Collection/functions.php @@ -20,8 +20,10 @@ /** * Returns a new {@link \Cake\Collection\Collection} object wrapping the passed argument. * - * @param iterable $items The items from which the collection will be built. - * @return \Cake\Collection\Collection + * @template TKey + * @template TValue + * @param iterable $items The items from which the collection will be built. + * @return \Cake\Collection\Collection */ function collection(iterable $items): CollectionInterface { diff --git a/app/vendor/cakephp/cakephp/src/Collection/functions_global.php b/app/vendor/cakephp/cakephp/src/Collection/functions_global.php index 33371c2e7..a8f2c235b 100644 --- a/app/vendor/cakephp/cakephp/src/Collection/functions_global.php +++ b/app/vendor/cakephp/cakephp/src/Collection/functions_global.php @@ -23,8 +23,10 @@ /** * Returns a new {@link \Cake\Collection\Collection} object wrapping the passed argument. * - * @param iterable $items The items from which the collection will be built. - * @return \Cake\Collection\Collection + * @template TKey + * @template TValue + * @param iterable $items The items from which the collection will be built. + * @return \Cake\Collection\Collection */ function collection(iterable $items): CollectionInterface { diff --git a/app/vendor/cakephp/cakephp/src/Command/CacheClearallCommand.php b/app/vendor/cakephp/cakephp/src/Command/CacheClearallCommand.php index 79e897921..2d62ecf51 100644 --- a/app/vendor/cakephp/cakephp/src/Command/CacheClearallCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/CacheClearallCommand.php @@ -68,8 +68,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar */ public function execute(Arguments $args, ConsoleIo $io): ?int { - $engines = Cache::configured(); - foreach ($engines as $engine) { + foreach (Cache::configured() as $engine) { $this->executeCommand(CacheClearCommand::class, [$engine], $io); } diff --git a/app/vendor/cakephp/cakephp/src/Command/CacheListCommand.php b/app/vendor/cakephp/cakephp/src/Command/CacheListCommand.php index df885217c..46466c9ca 100644 --- a/app/vendor/cakephp/cakephp/src/Command/CacheListCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/CacheListCommand.php @@ -66,8 +66,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar */ public function execute(Arguments $args, ConsoleIo $io): ?int { - $engines = Cache::configured(); - foreach ($engines as $engine) { + foreach (Cache::configured() as $engine) { $io->out("- {$engine}"); } diff --git a/app/vendor/cakephp/cakephp/src/Command/Command.php b/app/vendor/cakephp/cakephp/src/Command/Command.php index 3ccff8713..546efc313 100644 --- a/app/vendor/cakephp/cakephp/src/Command/Command.php +++ b/app/vendor/cakephp/cakephp/src/Command/Command.php @@ -40,7 +40,6 @@ class Command extends BaseCommand * @param \Cake\Console\Arguments $args The command arguments. * @param \Cake\Console\ConsoleIo $io The console io * @return int|null|void The exit code or null for success - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint */ public function execute(Arguments $args, ConsoleIo $io) { diff --git a/app/vendor/cakephp/cakephp/src/Command/CompletionCommand.php b/app/vendor/cakephp/cakephp/src/Command/CompletionCommand.php index 54524abfb..3389d6d42 100644 --- a/app/vendor/cakephp/cakephp/src/Command/CompletionCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/CompletionCommand.php @@ -20,6 +20,7 @@ use Cake\Console\BaseCommand; use Cake\Console\CommandCollection; use Cake\Console\CommandCollectionAwareInterface; +use Cake\Console\CommandHiddenInterface; use Cake\Console\ConsoleIo; use Cake\Console\ConsoleOptionParser; use ReflectionClass; @@ -123,9 +124,43 @@ public function execute(Arguments $args, ConsoleIo $io): ?int protected function getCommands(Arguments $args, ConsoleIo $io): int { $options = []; + $verbose = $io->level() >= ConsoleIo::VERBOSE; + + // Build a map of command base names (without subcommands) to their classes + // to detect true duplicates (plugin-prefixed alias pointing to same command) + $commandClasses = []; foreach ($this->commands as $key => $value) { + if (is_subclass_of($value, CommandHiddenInterface::class)) { + continue; + } $parts = explode(' ', $key); - $options[] = $parts[0]; + $commandName = $parts[0]; + // Only track base commands (no subcommands) and prefer first occurrence + if (count($parts) === 1 && !isset($commandClasses[$commandName])) { + $commandClasses[$commandName] = $value; + } + } + + foreach ($this->commands as $key => $value) { + if (is_subclass_of($value, CommandHiddenInterface::class)) { + continue; + } + $parts = explode(' ', $key); + $commandName = $parts[0]; + + // Skip plugin-prefixed aliases only if they are true duplicates + // (i.e., a short form exists that resolves to the same command class) + if (!$verbose && str_contains($commandName, '.')) { + $shortName = explode('.', $commandName)[1]; + if ( + isset($commandClasses[$shortName]) && + isset($commandClasses[$commandName]) && + $commandClasses[$shortName] === $commandClasses[$commandName] + ) { + continue; + } + } + $options[] = $commandName; } $options = array_unique($options); $io->out(implode(' ', $options)); @@ -149,6 +184,9 @@ protected function getSubcommands(Arguments $args, ConsoleIo $io): int $options = []; foreach ($this->commands as $key => $value) { + if (is_subclass_of($value, CommandHiddenInterface::class)) { + continue; + } $parts = explode(' ', $key); if ($parts[0] !== $name) { continue; @@ -180,14 +218,14 @@ protected function getOptions(Arguments $args, ConsoleIo $io): ?int $options = []; foreach ($this->commands as $key => $value) { - $parts = explode(' ', $key); - if ($parts[0] !== $name) { + if (is_subclass_of($value, CommandHiddenInterface::class)) { continue; } - if ($subcommand && !isset($parts[1])) { + $parts = explode(' ', $key); + if ($parts[0] !== $name) { continue; } - if ($subcommand && isset($parts[1]) && $parts[1] !== $subcommand) { + if ($subcommand && (!isset($parts[1]) || $parts[1] !== $subcommand)) { continue; } diff --git a/app/vendor/cakephp/cakephp/src/Command/Helper/BannerHelper.php b/app/vendor/cakephp/cakephp/src/Command/Helper/BannerHelper.php index 4d404371c..840f44643 100644 --- a/app/vendor/cakephp/cakephp/src/Command/Helper/BannerHelper.php +++ b/app/vendor/cakephp/cakephp/src/Command/Helper/BannerHelper.php @@ -78,7 +78,7 @@ public function output(array $args): void throw new InvalidArgumentException('At least one argument is required'); } - $lengths = array_map(fn($i) => mb_strlen($i), $args); + $lengths = array_map(mb_strlen(...), $args); $maxLength = max($lengths); $bannerLength = $maxLength + $this->padding * 2; $start = "<{$this->style}>"; diff --git a/app/vendor/cakephp/cakephp/src/Command/Helper/TreeHelper.php b/app/vendor/cakephp/cakephp/src/Command/Helper/TreeHelper.php new file mode 100644 index 000000000..5820e4be0 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Command/Helper/TreeHelper.php @@ -0,0 +1,124 @@ + 0, + 'elementIndent' => 0, + ]; + + /** + * Outputs an array in tree form. + * + * @param array $args Tree array + * @return void + */ + public function output(array $args): void + { + $prefix = str_repeat(' ', $this->_config['baseIndent']); + $this->outputArray($args, $prefix, topLevel: true); + } + + /** + * Output an array in a tree. + * + * @param array $array + * @param string $prefix + * @param bool $topLevel + * @return void + */ + protected function outputArray(array $array, string $prefix, bool $topLevel): void + { + $i = 1; + $numValues = count($array); + $elementPrefix = $topLevel ? '' : str_repeat(' ', $this->_config['elementIndent']); + foreach ($array as $key => $value) { + $isLast = $i++ === $numValues; + $marker = $isLast ? '└── ' : '├── '; + $indent = $isLast ? ' ' : '│ '; + $this->outputElement($key, $value, $prefix . $elementPrefix, $marker, $indent); + } + } + + /** + * Output an array element. + * + * @param string|int $key + * @param mixed $value + * @param string $prefix + * @param string $marker + * @param string $indent + * @return void + */ + protected function outputElement( + string|int $key, + mixed $value, + string $prefix, + string $marker, + string $indent, + ): void { + if (is_array($value)) { + $this->_io->out($prefix . $marker . $key); + $this->outputArray($value, $prefix . $indent, topLevel: false); + } elseif (is_string($key)) { + $this->_io->out($prefix . $marker . $key); + $this->outputValue($value, $prefix . $indent . '└── '); + } else { + $this->outputValue($value, $prefix . $marker); + } + } + + /** + * Output a value in a tree. + * + * @param mixed $value + * @param string $prefix + * @return void + */ + protected function outputValue(mixed $value, string $prefix): void + { + if ($value instanceof Closure) { + $this->_io->out($prefix . $value()); + } elseif ($value instanceof EnumLabelInterface) { + $this->_io->out($prefix . $value->label()); + } elseif ($value instanceof BackedEnum) { + $this->_io->out($prefix . $value->value); + } elseif ($value instanceof UnitEnum) { + $this->_io->out($prefix . $value->name); + } elseif (is_bool($value)) { + $this->_io->out($prefix . ($value ? 'true' : 'false')); + } else { + $this->_io->out($prefix . $value); + } + } +} diff --git a/app/vendor/cakephp/cakephp/src/Command/I18nExtractCommand.php b/app/vendor/cakephp/cakephp/src/Command/I18nExtractCommand.php index 73d78cf2c..31a66abd9 100644 --- a/app/vendor/cakephp/cakephp/src/Command/I18nExtractCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/I18nExtractCommand.php @@ -154,7 +154,7 @@ protected function _getPaths(ConsoleIo $io): void ); $response = $io->ask($message, $defaultPaths[$defaultPathIndex] ?? 'D'); if (strtoupper($response) === 'Q') { - $io->err('Extract Aborted'); + $io->error('Extract Aborted'); $this->abort(); } if (strtoupper($response) === 'D' && count($this->_paths)) { @@ -168,7 +168,7 @@ protected function _getPaths(ConsoleIo $io): void $this->_paths[] = $response; $defaultPathIndex++; } else { - $io->err('The directory path you supplied was not found. Please try again.'); + $io->error('The directory path you supplied was not found. Please try again.'); } $io->out(); } @@ -241,7 +241,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $localePaths[0], ); if (strtoupper($response) === 'Q') { - $io->err('Extract Aborted'); + $io->error('Extract Aborted'); return static::CODE_ERROR; } @@ -251,9 +251,9 @@ public function execute(Arguments $args, ConsoleIo $io): ?int } $io->err(''); - $io->err( - 'The directory path you supplied was ' . - 'not found. Please try again.', + $io->error( + 'The directory path you supplied was ' . + 'not found. Please try again.', ); $io->err(''); } @@ -279,7 +279,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $this->_output = rtrim($this->_output, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR; if (!$this->_isPathUsable($this->_output)) { - $io->err(sprintf('The output directory `%s` was not found or writable.', $this->_output)); + $io->error(sprintf('The output directory `%s` was not found or writable.', $this->_output)); return static::CODE_ERROR; } @@ -348,7 +348,7 @@ protected function _extract(Arguments $args, ConsoleIo $io): void $this->_tokens = []; $io->out(); if ($this->_countMarkerError) { - $io->err("{$this->_countMarkerError} marker error(s) detected."); + $io->error("{$this->_countMarkerError} marker error(s) detected."); $io->err(' => Use the --marker-error option to display errors.'); } @@ -799,7 +799,7 @@ protected function _markerError(ConsoleIo $io, string $file, int $line, string $ return; } - $io->err(sprintf("Invalid marker content in %s:%s\n* %s(", $file, $line, $marker)); + $io->error(sprintf("Invalid marker content in %s:%s\n* %s(", $file, $line, $marker)); $count += 2; $tokenCount = count($this->_tokens); $parenthesis = 1; @@ -880,7 +880,7 @@ protected function _isExtractingApp(): bool protected function _isPathUsable(string $path): bool { if (!is_dir($path)) { - mkdir($path, 0755, true); + mkdir($path, 0777 ^ umask(), true); } return is_dir($path) && is_writable($path); diff --git a/app/vendor/cakephp/cakephp/src/Command/I18nInitCommand.php b/app/vendor/cakephp/cakephp/src/Command/I18nInitCommand.php index b9dd59798..f89e32a73 100644 --- a/app/vendor/cakephp/cakephp/src/Command/I18nInitCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/I18nInitCommand.php @@ -60,7 +60,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $language = $io->ask('Please specify language code, e.g. `en`, `eng`, `en_US` etc.'); } if (strlen($language) < 2) { - $io->err('Invalid language code. Valid is `en`, `eng`, `en_US` etc.'); + $io->error('Invalid language code. Valid is `en`, `eng`, `en_US` etc.'); return static::CODE_ERROR; } @@ -75,7 +75,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $sourceFolder = rtrim($response, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR; $targetFolder = $sourceFolder . $language . DIRECTORY_SEPARATOR; if (!is_dir($targetFolder)) { - mkdir($targetFolder, 0755, true); + mkdir($targetFolder, 0777 ^ umask(), true); } $count = 0; diff --git a/app/vendor/cakephp/cakephp/src/Command/PluginAssetsSymlinkCommand.php b/app/vendor/cakephp/cakephp/src/Command/PluginAssetsSymlinkCommand.php index ba49750f5..cf2ed4bc9 100644 --- a/app/vendor/cakephp/cakephp/src/Command/PluginAssetsSymlinkCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/PluginAssetsSymlinkCommand.php @@ -61,7 +61,8 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $name = $args->getArgument('name'); $overwrite = (bool)$args->getOption('overwrite'); - $this->_process($this->_list($name), false, $overwrite); + $relative = (bool)$args->getOption('relative'); + $this->_process($this->_list($name), false, $overwrite, $relative); return static::CODE_SUCCESS; } @@ -83,6 +84,10 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar 'help' => 'Overwrite existing symlink / folder / files.', 'default' => false, 'boolean' => true, + ])->addOption('relative', [ + 'help' => 'If symlink should be relative.', + 'default' => false, + 'boolean' => true, ]); return $parser; diff --git a/app/vendor/cakephp/cakephp/src/Command/PluginAssetsTrait.php b/app/vendor/cakephp/cakephp/src/Command/PluginAssetsTrait.php index 03feceb26..267a7acef 100644 --- a/app/vendor/cakephp/cakephp/src/Command/PluginAssetsTrait.php +++ b/app/vendor/cakephp/cakephp/src/Command/PluginAssetsTrait.php @@ -22,9 +22,10 @@ use Cake\Core\Plugin; use Cake\Utility\Filesystem; use Cake\Utility\Inflector; +use InvalidArgumentException; /** - * trait for symlinking / copying plugin assets to app's webroot. + * Trait for symlinking / copying plugin assets to app's webroot. * * @internal */ @@ -100,10 +101,15 @@ protected function _list(?string $name = null): array * @param array $plugins List of plugins to process * @param bool $copy Force copy mode. Default false. * @param bool $overwrite Overwrite existing files. + * @param bool $relative Relative. Default false. * @return void */ - protected function _process(array $plugins, bool $copy = false, bool $overwrite = false): void - { + protected function _process( + array $plugins, + bool $copy = false, + bool $overwrite = false, + bool $relative = false, + ): void { foreach ($plugins as $plugin => $config) { $this->io->out(); $this->io->out('For plugin: ' . $plugin); @@ -118,34 +124,40 @@ protected function _process(array $plugins, bool $copy = false, bool $overwrite } $dest = $config['destDir'] . $config['link']; - - if (file_exists($dest)) { - if ($overwrite && !$this->_remove($config)) { + if ($copy) { + if ((is_link($dest) || $overwrite) && !$this->_remove($config)) { continue; } - if (!$overwrite) { - $this->io->verbose( - $dest . ' already exists', - 1, - ); - continue; - } - } - if (!$copy) { - $result = $this->_createSymlink( - $config['srcPath'], - $dest, - ); - if ($result) { - continue; + if (file_exists($dest)) { + $this->io->verbose($dest . ' already exists', 1); + } else { + $this->_copyDirectory($config['srcPath'], $dest); } + continue; } - $this->_copyDirectory( + $result = $this->_createSymlink( $config['srcPath'], $dest, + $relative, ); + if ($result) { + continue; + } + + if ($this->_isSymlinkValid($config['srcPath'], $dest)) { + $this->io->verbose($dest . ' already exists', 1); + continue; + } + + if (!$this->_remove($config)) { + continue; + } + + if (!$this->_createSymlink($config['srcPath'], $dest)) { + continue; + } } $this->io->out(); @@ -161,25 +173,11 @@ protected function _process(array $plugins, bool $copy = false, bool $overwrite protected function _remove(array $config): bool { if ($config['namespaced'] && !is_dir($config['destDir'])) { - $this->io->verbose( - $config['destDir'] . $config['link'] . ' does not exist', - 1, - ); - - return false; + return true; } $dest = $config['destDir'] . $config['link']; - if (!file_exists($dest)) { - $this->io->verbose( - $dest . ' does not exist', - 1, - ); - - return false; - } - if (is_link($dest)) { // phpcs:ignore $success = DIRECTORY_SEPARATOR === '\\' ? @rmdir($dest) : @unlink($dest); @@ -188,20 +186,25 @@ protected function _remove(array $config): bool return true; } - $this->io->err('Failed to unlink ' . $dest); + $this->io->error('Failed to unlink ' . $dest); return false; } + if (!file_exists($dest)) { + return true; + } + $fs = new Filesystem(); - if ($fs->deleteDir($dest)) { - $this->io->out('Deleted ' . $dest); + if (!$fs->deleteDir($dest)) { + $this->io->error('Failed to delete ' . $dest); - return true; + return false; } - $this->io->err('Failed to delete ' . $dest); - return false; + $this->io->out('Deleted ' . $dest); + + return true; } /** @@ -212,11 +215,9 @@ protected function _remove(array $config): bool */ protected function _createDirectory(string $dir): bool { - $old = umask(0); // phpcs:disable - $result = @mkdir($dir, 0755, true); + $result = @mkdir($dir, 0777 ^ umask(), true); // phpcs:enable - umask($old); if ($result) { $this->io->out('Created directory ' . $dir); @@ -224,7 +225,7 @@ protected function _createDirectory(string $dir): bool return true; } - $this->io->err('Failed creating directory ' . $dir); + $this->io->error('Failed creating directory ' . $dir); return false; } @@ -234,10 +235,15 @@ protected function _createDirectory(string $dir): bool * * @param string $target Target directory * @param string $link Link name + * @param bool $relative Relative (true) or Absolute (false) * @return bool */ - protected function _createSymlink(string $target, string $link): bool + protected function _createSymlink(string $target, string $link, bool $relative = false): bool { + if ($relative) { + $target = $this->_makeRelativePath($link, $target); + } + // phpcs:disable $result = @symlink($target, $link); // phpcs:enable @@ -251,6 +257,61 @@ protected function _createSymlink(string $target, string $link): bool return false; } + /** + * Generate a relative path from one directory to another. + * + * @param string $from The symlink path + * @param string $to The target path + * @return string Relative path + */ + protected function _makeRelativePath(string $from, string $to): string + { + $from = is_dir($from) ? rtrim($from, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR : dirname($from); + $from = realpath($from); + $to = realpath($to); + + if ($from === false || $to === false) { + throw new InvalidArgumentException('Invalid path provided to _makeRelativePath.'); + } + + $fromParts = explode(DIRECTORY_SEPARATOR, $from); + $toParts = explode(DIRECTORY_SEPARATOR, $to); + + $fromCount = count($fromParts); + $toCount = count($toParts); + + // Remove common parts + while ($fromCount && $toCount && $fromParts[0] === $toParts[0]) { + array_shift($fromParts); + array_shift($toParts); + $fromCount--; + $toCount--; + } + + return str_repeat('..' . DIRECTORY_SEPARATOR, $fromCount) . implode(DIRECTORY_SEPARATOR, $toParts); + } + + /** + * Checks if symlink exist and points to the correct target. + * + * @param string $target + * @param string $link + * @return bool + */ + protected function _isSymlinkValid(string $target, string $link): bool + { + if (!is_link($link)) { + return false; + } + + $linkedPath = readlink($link); + if ($linkedPath === false) { + return false; + } + + return realpath($target) === realpath($linkedPath); + } + /** * Copy directory * @@ -267,7 +328,7 @@ protected function _copyDirectory(string $source, string $destination): bool return true; } - $this->io->err('Error copying assets to directory ' . $destination); + $this->io->error('Error copying assets to directory ' . $destination); return false; } diff --git a/app/vendor/cakephp/cakephp/src/Command/PluginLoadCommand.php b/app/vendor/cakephp/cakephp/src/Command/PluginLoadCommand.php index 469b79fd4..1d9cce1a5 100644 --- a/app/vendor/cakephp/cakephp/src/Command/PluginLoadCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/PluginLoadCommand.php @@ -30,6 +30,16 @@ */ class PluginLoadCommand extends Command { + /** + * @var array + */ + protected static array $devTags = ['dev', 'testing', 'static analysis']; + + /** + * @var array + */ + protected static array $cliTags = ['cli', 'command line', 'shell']; + /** * Config file * @@ -80,20 +90,38 @@ public function execute(Arguments $args, ConsoleIo $io): ?int } } + $path = null; try { - Plugin::getCollection()->findPath($plugin); + $path = Plugin::getCollection()->findPath($plugin); } catch (MissingPluginException $e) { if (empty($options['optional'])) { - $io->err($e->getMessage()); - $io->err('Ensure you have the correct spelling and casing.'); + $io->error($e->getMessage()); + $io->error('Ensure you have the correct spelling and casing.'); return static::CODE_ERROR; } } + $recommendations = $path ? $this->recommendations($path) : []; + foreach ($recommendations as $name => $v) { + if (isset($options[$name]) && $options[$name] === $v) { + continue; + } + + $option = $name . ': ' . ($v ? 'true' : 'false'); + $question = 'Based on the plugin composer keywords, this seems to be `' . $option . '`. '; + $question .= 'Do you want to change this?'; + $in = $io->askChoice($question, ['y', 'n'], 'y'); + if ($in !== 'y') { + continue; + } + + $options[$name] = $v; + } + $result = $this->modifyConfigFile($plugin, $options); if ($result === static::CODE_ERROR) { - $io->err('Failed to update `CONFIG/plugins.php`'); + $io->error('Failed to update `CONFIG/plugins.php`'); } $io->success('Plugin added successfully to `CONFIG/plugins.php`'); @@ -125,8 +153,8 @@ protected function modifyConfigFile(string $plugin, array $options): int } else { $array = var_export($config, true); } - $contents = 'configFile, $contents)) { return static::CODE_SUCCESS; } @@ -134,6 +162,43 @@ protected function modifyConfigFile(string $plugin, array $options): int return static::CODE_ERROR; } + /** + * @param string $path + * @return array + */ + protected function recommendations(string $path): array + { + $file = $path . 'composer.json'; + if (!file_exists($file)) { + return []; + } + + $content = file_get_contents($file); + $array = $content ? json_decode($content, true) : []; + $keywords = $array['keywords'] ?? []; + if (!$keywords) { + return []; + } + + $recommendations = []; + foreach (static::$devTags as $tag) { + if (in_array($tag, $keywords, true)) { + $recommendations['onlyDebug'] = true; + } + } + foreach (static::$cliTags as $tag) { + if (in_array($tag, $keywords, true)) { + $recommendations['onlyCli'] = true; + } + } + + if (!empty($recommendations['onlyDebug'])) { + $recommendations['optional'] = true; + } + + return $recommendations; + } + /** * Get the option parser. * @@ -170,7 +235,7 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar ]) ->addOption('no-middleware', [ 'boolean' => true, - 'help' => 'Do not run the `middleware()` hook..', + 'help' => 'Do not run the `middleware()` hook.', ]) ->addOption('no-routes', [ 'boolean' => true, diff --git a/app/vendor/cakephp/cakephp/src/Command/RoutesCommand.php b/app/vendor/cakephp/cakephp/src/Command/RoutesCommand.php index 12e3c4b60..15c23c5a7 100644 --- a/app/vendor/cakephp/cakephp/src/Command/RoutesCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/RoutesCommand.php @@ -80,16 +80,13 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $output[] = $item; foreach ($methods as $method) { - if (!isset($duplicateRoutesCounter[$route->template][$method])) { - $duplicateRoutesCounter[$route->template][$method] = 0; - } - + $duplicateRoutesCounter[$route->template][$method] ??= 0; $duplicateRoutesCounter[$route->template][$method]++; } } if ($args->getOption('sort')) { - usort($output, function ($a, $b) { + usort($output, function (array $a, array $b) { return strcasecmp($a[0], $b[0]); }); } diff --git a/app/vendor/cakephp/cakephp/src/Command/RoutesGenerateCommand.php b/app/vendor/cakephp/cakephp/src/Command/RoutesGenerateCommand.php index 483683174..6275919b8 100644 --- a/app/vendor/cakephp/cakephp/src/Command/RoutesGenerateCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/RoutesGenerateCommand.php @@ -58,7 +58,7 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $io->out("> {$url}"); $io->out(); } catch (MissingRouteException) { - $io->err('The provided parameters do not match any routes.'); + $io->warning('The provided parameters do not match any routes.'); $io->out(); return static::CODE_ERROR; diff --git a/app/vendor/cakephp/cakephp/src/Command/ServerCommand.php b/app/vendor/cakephp/cakephp/src/Command/ServerCommand.php index 831261718..b2be0e97b 100644 --- a/app/vendor/cakephp/cakephp/src/Command/ServerCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/ServerCommand.php @@ -70,12 +70,19 @@ class ServerCommand extends Command */ protected string $_iniPath = ''; + /** + * The server type. + * + * @var string + */ + protected string $server = 'php'; + /** * @inheritDoc */ public static function getDescription(): string { - return 'PHP Built-in Server for CakePHP'; + return "Start PHP's built-in server or FrankenPHP for CakePHP"; } /** @@ -85,7 +92,7 @@ public static function getDescription(): string * @param \Cake\Console\Arguments $args The command arguments. * @param \Cake\Console\ConsoleIo $io The console io * @return void - * @link https://book.cakephp.org/5/en/console-and-shells.html#hook-methods + * @link https://book.cakephp.org/5/en/console-commands/commands.html#lifecycle-callbacks */ protected function startup(Arguments $args, ConsoleIo $io): void { @@ -101,6 +108,9 @@ protected function startup(Arguments $args, ConsoleIo $io): void if ($args->getOption('ini_path')) { $this->_iniPath = (string)$args->getOption('ini_path'); } + if ($args->getOption('frankenphp')) { + $this->server = 'frankenphp'; + } // For Windows if (substr($this->_documentRoot, -1, 1) === DIRECTORY_SEPARATOR) { @@ -130,15 +140,48 @@ protected function startup(Arguments $args, ConsoleIo $io): void * * @param \Cake\Console\Arguments $args The command arguments. * @param \Cake\Console\ConsoleIo $io The console io - * @return int|null The exit code or null for success + * @return int The exit code */ - public function execute(Arguments $args, ConsoleIo $io): ?int + public function execute(Arguments $args, ConsoleIo $io): int { $this->startup($args, $io); - $phpBinary = (string)env('PHP', 'php'); + + $io->out(sprintf( + '%s server is running at http://%s:%s/', + $this->server, + $this->_host, + $this->_port, + )); + $io->out('You can exit with `CTRL-C`'); + + return $this->runCommand($this->{$this->server . 'Command'}()); + } + + /** + * Runs the command. + * + * @param string $command The command to run + * @return int The exit code + */ + protected function runCommand(string $command): int + { + if (system($command) === false) { + return static::CODE_ERROR; + } + + return static::CODE_SUCCESS; + } + + /** + * Returns the command to run PHP's built-in server. + * + * @return string + */ + protected function phpCommand(): string + { $command = sprintf( '%s -S %s:%d -t %s', - $phpBinary, + (string)env('PHP', 'php'), $this->_host, $this->_port, escapeshellarg($this->_documentRoot), @@ -148,14 +191,23 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $command = sprintf('%s -c %s', $command, $this->_iniPath); } - $command = sprintf('%s %s', $command, escapeshellarg($this->_documentRoot . '/index.php')); - - $port = ':' . $this->_port; - $io->out(sprintf('built-in server is running in http://%s%s/', $this->_host, $port)); - $io->out('You can exit with `CTRL-C`'); - system($command); + return sprintf('%s %s', $command, escapeshellarg($this->_documentRoot . '/index.php')); + } - return static::CODE_SUCCESS; + /** + * Returns the command to run frankenphp's server. + * + * @return string + */ + protected function frankenphpCommand(): string + { + return sprintf( + '%s php-server -a -l %s:%d -r %s', + (string)env('FRANKENPHP', 'frankenphp'), + $this->_host, + $this->_port, + escapeshellarg($this->_documentRoot), + ); } /** @@ -181,6 +233,10 @@ public function buildOptionParser(ConsoleOptionParser $parser): ConsoleOptionPar ])->addOption('document_root', [ 'short' => 'd', 'help' => 'DocumentRoot', + ])->addOption('frankenphp', [ + 'boolean' => true, + 'short' => 'f', + 'help' => "Use frankenphp instead of PHP's built-in server", ]); return $parser; diff --git a/app/vendor/cakephp/cakephp/src/Command/VersionCommand.php b/app/vendor/cakephp/cakephp/src/Command/VersionCommand.php index d56891a0f..629727047 100644 --- a/app/vendor/cakephp/cakephp/src/Command/VersionCommand.php +++ b/app/vendor/cakephp/cakephp/src/Command/VersionCommand.php @@ -42,8 +42,35 @@ public static function getDescription(): string */ public function execute(Arguments $args, ConsoleIo $io): ?int { - $io->out(Configure::version()); + $version = Configure::version(); + $io->out($version); + + if ($args->getOption('verbose')) { + $this->outputVerbose($io, $version); + } return static::CODE_SUCCESS; } + + /** + * Output verbose version information. + * + * @param \Cake\Console\ConsoleIo $io The console io + * @param string $version The CakePHP version + * @return void + */ + protected function outputVerbose(ConsoleIo $io, string $version): void + { + $io->out(); + + // Show release link for stable and RC versions, but not dev + if (!str_contains($version, '-dev')) { + $io->out(sprintf( + 'Release: https://github.com/cakephp/cakephp/releases/tag/%s', + $version, + )); + } + + $io->out(sprintf('PHP: %s (%s)', PHP_VERSION, PHP_SAPI)); + } } diff --git a/app/vendor/cakephp/cakephp/src/Console/BaseCommand.php b/app/vendor/cakephp/cakephp/src/Console/BaseCommand.php index 646db2984..7cb40cff5 100644 --- a/app/vendor/cakephp/cakephp/src/Console/BaseCommand.php +++ b/app/vendor/cakephp/cakephp/src/Console/BaseCommand.php @@ -20,6 +20,8 @@ use Cake\Console\Exception\StopException; use Cake\Event\EventDispatcherInterface; use Cake\Event\EventDispatcherTrait; +use Cake\Event\EventInterface; +use Cake\Event\EventListenerInterface; use Cake\Utility\Inflector; /** @@ -31,12 +33,24 @@ * - `buildOptionParser` Build/Configure the option parser for your command. * - `execute` Execute your command with parsed Arguments and ConsoleIo * - * @implements \Cake\Event\EventDispatcherInterface<\Cake\Command\Command> + * ### Life cycle callbacks + * + * CakePHP fires a number of life cycle callbacks during each command execution. + * By implementing a method you can receive the related events. The available + * callbacks are: + * + * - `beforeExecute(EventInterface $event)` + * Called immediately prior to the command's run method. This is a good place to do + * general logic that applies to command setup. + * - `afterExecute(EventInterface $event)` + * Called immediately after the command's run method, unless an exception occurs. + * + * @implements \Cake\Event\EventDispatcherInterface */ -abstract class BaseCommand implements CommandInterface, EventDispatcherInterface +abstract class BaseCommand implements CommandInterface, EventDispatcherInterface, EventListenerInterface { /** - * @use \Cake\Event\EventDispatcherTrait<\Cake\Command\Command> + * @use \Cake\Event\EventDispatcherTrait */ use EventDispatcherTrait; @@ -57,6 +71,7 @@ abstract class BaseCommand implements CommandInterface, EventDispatcherInterface public function __construct(?CommandFactoryInterface $factory = null) { $this->factory = $factory; + $this->getEventManager()->on($this); } /** @@ -164,6 +179,49 @@ public function initialize(): void { } + /** + * Returns a list of all events that will fire in the command during its lifecycle. + * You can override this function to add your own listener callbacks + * + * @return array + */ + public function implementedEvents(): array + { + return [ + 'Command.beforeExecute' => 'beforeExecute', + 'Command.afterExecute' => 'afterExecute', + ]; + } + + /** + * Called immediately prior to the command's run method. You can use this method to configure and customize the + * command or perform logic that needs to happen before the command runs. + * + * @param \Cake\Event\EventInterface $event An Event instance + * @param \Cake\Console\Arguments $args + * @param \Cake\Console\ConsoleIo $io + * @return void + * @link https://book.cakephp.org/5/en/console-commands/commands.html#lifecycle-callbacks + */ + public function beforeExecute(EventInterface $event, Arguments $args, ConsoleIo $io): void + { + } + + /** + * Called immediately after the command's run method, unless an exception occurs. You can use this method to + * perform logic that needs to happen after the command runs. + * + * @param \Cake\Event\EventInterface $event An Event instance + * @param \Cake\Console\Arguments $args + * @param \Cake\Console\ConsoleIo $io + * @param int|null $result + * @return void + * @link https://book.cakephp.org/5/en/console-commands/commands.html#lifecycle-callbacks + */ + public function afterExecute(EventInterface $event, Arguments $args, ConsoleIo $io, ?int $result): void + { + } + /** * @inheritDoc */ @@ -180,7 +238,7 @@ public function run(array $argv, ConsoleIo $io): ?int $parser->argumentNames(), ); } catch (ConsoleException $e) { - $io->err('Error: ' . $e->getMessage()); + $io->error('Error: ' . $e->getMessage()); return static::CODE_ERROR; } @@ -196,10 +254,9 @@ public function run(array $argv, ConsoleIo $io): ?int $io->setInteractive(false); } - $this->dispatchEvent('Command.beforeExecute', ['args' => $args]); - /** @var int|null $result */ + $this->dispatchEvent('Command.beforeExecute', ['args' => $args, 'io' => $io]); $result = $this->execute($args, $io); - $this->dispatchEvent('Command.afterExecute', ['args' => $args, 'result' => $result]); + $this->dispatchEvent('Command.afterExecute', ['args' => $args, 'io' => $io, 'result' => $result]); return $result; } @@ -249,7 +306,6 @@ protected function setOutputLevel(Arguments $args, ConsoleIo $io): void * @param \Cake\Console\Arguments $args The command arguments. * @param \Cake\Console\ConsoleIo $io The console io * @return int|null|void The exit code or null for success - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint */ abstract public function execute(Arguments $args, ConsoleIo $io); diff --git a/app/vendor/cakephp/cakephp/src/Console/Command/HelpCommand.php b/app/vendor/cakephp/cakephp/src/Console/Command/HelpCommand.php index 642bbe296..366d09b69 100644 --- a/app/vendor/cakephp/cakephp/src/Console/Command/HelpCommand.php +++ b/app/vendor/cakephp/cakephp/src/Console/Command/HelpCommand.php @@ -21,6 +21,7 @@ use Cake\Console\BaseCommand; use Cake\Console\CommandCollection; use Cake\Console\CommandCollectionAwareInterface; +use Cake\Console\CommandHiddenInterface; use Cake\Console\ConsoleIo; use Cake\Console\ConsoleOptionParser; use Cake\Console\ConsoleOutput; @@ -63,48 +64,128 @@ public function execute(Arguments $args, ConsoleIo $io): ?int $commands->ksort(); } + // Filter by command prefix if provided + $filter = $args->getArgument('command'); + if ($filter) { + $commands = $this->filterByPrefix($commands, $filter); + } + if ($args->getOption('xml')) { $this->asXml($io, $commands); return static::CODE_SUCCESS; } - $this->asText($io, $commands); + $verbose = $io->level() >= ConsoleIo::VERBOSE; + $this->asText($io, $commands, $verbose); return static::CODE_SUCCESS; } + /** + * Filter commands by prefix. + * + * @param iterable $commands The command collection. + * @param string $prefix The prefix to filter by. + * @return array Filtered commands. + */ + protected function filterByPrefix(iterable $commands, string $prefix): array + { + $filtered = []; + foreach ($commands as $name => $class) { + if (str_starts_with($name, $prefix . ' ') || $name === $prefix) { + $filtered[$name] = $class; + } + } + + return $filtered; + } + /** * Output text. * * @param \Cake\Console\ConsoleIo $io The console io * @param iterable $commands The command collection to output. + * @param bool $verbose Whether to show verbose output with descriptions. * @return void */ - protected function asText(ConsoleIo $io, iterable $commands): void + protected function asText(ConsoleIo $io, iterable $commands, bool $verbose = false): void { $invert = []; foreach ($commands as $name => $class) { + // Skip hidden commands + if (is_subclass_of($class, CommandHiddenInterface::class)) { + continue; + } if (is_object($class)) { $class = $class::class; } - if (!isset($invert[$class])) { - $invert[$class] = []; - } + $invert[$class] ??= []; $invert[$class][] = $name; } - $grouped = []; - $plugins = Plugin::loaded(); + + $commandList = []; foreach ($invert as $class => $names) { preg_match('/^(.+)\\\\Command\\\\/', $class, $matches); // Probably not a useful class if (!$matches) { continue; } + $shortestName = $this->getShortestName($names); + if (str_contains($shortestName, '.')) { + [, $shortestName] = explode('.', $shortestName, 2); + } + + $commandList[] = [ + 'name' => $shortestName, + 'description' => is_subclass_of($class, BaseCommand::class) ? $class::getDescription() : '', + ]; + } + sort($commandList); + + if ($verbose) { + $version = Configure::version(); + $debug = Configure::read('debug') ? 'true' : 'false'; + $io->out("CakePHP: {$version} (debug: {$debug})", 2); + $this->outputPaths($io); + $this->outputGrouped($io, $invert); + } else { + $this->outputCompactCommands($io, $commandList); + $io->out(''); + } + + $root = $this->getRootName(); + $io->out("To run a command, type `{$root} command_name [args|options]`"); + $io->out("To get help on a specific command, type `{$root} command_name --help`"); + if (!$verbose) { + $io->out("To see full descriptions and plugin grouping, use `{$root} --help -v`", 2); + } else { + $io->out('', 2); + } + } + + /** + * Output commands grouped by plugin/namespace (verbose mode). + * + * @param \Cake\Console\ConsoleIo $io The console io + * @param array> $invert Inverted command map (class => names). + * @return void + */ + protected function outputGrouped(ConsoleIo $io, array $invert): void + { + $grouped = []; + $plugins = Plugin::loaded(); + foreach ($invert as $class => $names) { + preg_match('/^(.+)\\\\Command\\\\/', $class, $matches); + if (!$matches || $names === []) { + continue; + } $namespace = str_replace('\\', '/', $matches[1]); $prefix = 'app'; if ($namespace === 'Cake') { $prefix = 'cakephp'; + } elseif (method_exists($class, 'getGroup')) { + $prefix = $class::getGroup(); } elseif (in_array($namespace, $plugins, true)) { $prefix = Inflector::underscore($namespace); } @@ -120,19 +201,13 @@ protected function asText(ConsoleIo $io, iterable $commands): void } ksort($grouped); - if (isset($grouped['CakePHP'])) { - $cakephp = $grouped['CakePHP']; - $grouped = ['CakePHP' => $cakephp] + $grouped; - } - - if (isset($grouped['App'])) { - $app = $grouped['App']; - $grouped = ['App' => $app] + $grouped; + if (isset($grouped['app'])) { + $app = $grouped['app']; + unset($grouped['app']); + $grouped = ['app' => $app] + $grouped; } - $this->outputPaths($io); $io->out('Available Commands:', 2); - foreach ($grouped as $prefix => $names) { $io->out("{$prefix}:"); sort($names); @@ -144,10 +219,188 @@ protected function asText(ConsoleIo $io, iterable $commands): void } $io->out(''); } - $root = $this->getRootName(); + } - $io->out("To run a command, type `{$root} command_name [args|options]`"); - $io->out("To get help on a specific command, type `{$root} command_name --help`", 2); + /** + * Output commands with inline descriptions, grouped by prefix. + * + * @param \Cake\Console\ConsoleIo $io The console io + * @param array $commands List of commands with names and descriptions. + * @return void + */ + protected function outputCompactCommands(ConsoleIo $io, array $commands): void + { + $maxWidth = $this->getTerminalWidth(); + + // Group commands by their first word (prefix) + $groups = []; + foreach ($commands as $data) { + $parts = explode(' ', $data['name'], 2); + $prefix = $parts[0]; + $subcommand = $parts[1] ?? null; + + $groups[$prefix] ??= []; + $groups[$prefix][] = [ + 'subcommand' => $subcommand, + 'description' => $data['description'], + ]; + } + + // Separate single commands from grouped commands + $singleCommands = []; + $groupedCommands = []; + + foreach ($groups as $prefix => $cmds) { + if (count($cmds) === 1 && $cmds[0]['subcommand'] === null) { + $singleCommands[$prefix] = $cmds[0]; + } else { + $groupedCommands[$prefix] = $cmds; + } + } + + // Find the longest full command name for padding + $maxNameLength = 0; + foreach ($commands as $data) { + $maxNameLength = max($maxNameLength, strlen($data['name'])); + } + $nameColumnWidth = $maxNameLength + 3; + + // Output single commands under "Available Commands:" header + $isFirst = true; + if ($singleCommands !== []) { + $io->out('Available Commands:'); + foreach ($singleCommands as $prefix => $cmd) { + $description = $cmd['description']; + $padding = str_repeat(' ', $nameColumnWidth - 2 - strlen($prefix)); + $linePrefix = ' ' . $prefix . '' . $padding; + + if ($description !== '') { + $description = strtok($description, "\n"); + $this->outputWrappedLine($io, $linePrefix, $description, $maxWidth); + } else { + $io->out($linePrefix); + } + } + $isFirst = false; + } + + // Output grouped commands with headers + foreach ($groupedCommands as $prefix => $cmds) { + if (!$isFirst) { + $io->out(''); + } + $io->out("{$prefix}:"); + + foreach ($cmds as $cmd) { + $fullName = $cmd['subcommand'] !== null ? $prefix . ' ' . $cmd['subcommand'] : $prefix; + $description = $cmd['description']; + + $padding = str_repeat(' ', $nameColumnWidth - 2 - strlen($fullName)); + $linePrefix = ' ' . $fullName . '' . $padding; + + if ($description !== '') { + $description = strtok($description, "\n"); + $this->outputWrappedLine($io, $linePrefix, $description, $maxWidth); + } else { + $io->out($linePrefix); + } + } + $isFirst = false; + } + } + + /** + * Output a line with description, wrapping based on terminal width. + * + * @param \Cake\Console\ConsoleIo $io The console io + * @param string $prefix The line prefix (command name with padding) + * @param string $description The description text + * @param int $maxWidth Maximum terminal width + * @param int $maxChars Maximum total description characters (0 = unlimited) + * @return void + */ + protected function outputWrappedLine( + ConsoleIo $io, + string $prefix, + string $description, + int $maxWidth, + int $maxChars = 200, + ): void { + $prefixLength = strlen($this->stripMarkup($prefix)); + $availableWidth = $maxWidth - $prefixLength; + + if ($availableWidth <= 10) { + $io->out($prefix); + + return; + } + + // Truncate description to max chars if set + if ($maxChars > 0 && strlen($description) > $maxChars) { + $description = substr($description, 0, $maxChars - 3) . '...'; + } + + if (strlen($description) <= $availableWidth) { + $io->out($prefix . $description); + + return; + } + + // Wrap description across multiple lines + $indent = str_repeat(' ', $prefixLength); + $remaining = $description; + $firstLine = true; + + while ($remaining !== '') { + $linePrefix = $firstLine ? $prefix : $indent; + $firstLine = false; + + if (strlen($remaining) <= $availableWidth) { + $io->out($linePrefix . $remaining); + break; + } + + // Find word break point + $breakPoint = strrpos(substr($remaining, 0, $availableWidth), ' '); + if ($breakPoint === false || $breakPoint < $availableWidth / 2) { + $breakPoint = $availableWidth; + } + + $io->out($linePrefix . substr($remaining, 0, $breakPoint)); + $remaining = ltrim(substr($remaining, $breakPoint)); + } + } + + /** + * Get terminal width for line wrapping. + * + * @return int Terminal width in columns + */ + protected function getTerminalWidth(): int + { + // Check COLUMNS environment variable (commonly set by shells) + $columns = getenv('COLUMNS'); + if ($columns !== false && is_numeric($columns) && (int)$columns > 0) { + return (int)$columns; + } + + // Try tput cols (Unix/Linux/macOS) + if (str_contains(strtolower(PHP_OS), 'win') === false) { + $result = null; + $output = exec('tput cols 2>/dev/null', result_code: $result); + if ($result === 0 && is_numeric($output) && (int)$output > 0) { + return (int)$output; + } + + // Try stty size (returns "rows cols") + $output = exec('stty size 2>/dev/null', result_code: $result); + if ($result === 0 && $output !== false && preg_match('/^\d+\s+(\d+)$/', $output, $matches)) { + return (int)$matches[1]; + } + } + + // Default to 120 columns (modern terminals) + return 120; } /** @@ -194,6 +447,17 @@ protected function getShortestName(array $names): string return array_shift($names); } + /** + * Strip ConsoleOutput markup tags from a string. + * + * @param string $text Text that may contain markup tags + * @return string Text with markup tags removed + */ + protected function stripMarkup(string $text): string + { + return preg_replace('/<\/?[a-z]+>/', '', $text) ?? $text; + } + /** * Output as XML * @@ -205,6 +469,10 @@ protected function asXml(ConsoleIo $io, iterable $commands): void { $shells = new SimpleXMLElement(''); foreach ($commands as $name => $class) { + // Skip hidden commands + if (is_subclass_of($class, CommandHiddenInterface::class)) { + continue; + } if (is_object($class)) { $class = $class::class; } @@ -228,7 +496,9 @@ protected function buildOptionParser(ConsoleOptionParser $parser): ConsoleOption { $parser->setDescription( 'Get the list of available commands for this application.', - )->addOption('xml', [ + )->addArgument('command', [ + 'help' => 'Filter commands by prefix (e.g., "cache" to show only cache commands).', + ])->addOption('xml', [ 'help' => 'Get the listing as XML.', 'boolean' => true, ]); diff --git a/app/vendor/cakephp/cakephp/src/Console/CommandCollection.php b/app/vendor/cakephp/cakephp/src/Console/CommandCollection.php index d656f29e8..cc816fba5 100644 --- a/app/vendor/cakephp/cakephp/src/Console/CommandCollection.php +++ b/app/vendor/cakephp/cakephp/src/Console/CommandCollection.php @@ -115,6 +115,23 @@ public function remove(string $name) return $this; } + /** + * Replace a command from the collection with another command if it exists. + * + * @param string $oldName Name of command to remove. + * @param string $newName The name of the command you want to map. + * @param \Cake\Console\CommandInterface|class-string<\Cake\Console\CommandInterface> $command The command to map. + * Can be a FQCN or CommandInterface instance. + * @return $this + */ + public function replace(string $oldName, string $newName, CommandInterface|string $command) + { + $this->remove($oldName); + $this->add($newName, $command); + + return $this; + } + /** * Check whether the named shell exists in the collection. * diff --git a/app/vendor/cakephp/cakephp/src/Console/CommandFactoryInterface.php b/app/vendor/cakephp/cakephp/src/Console/CommandFactoryInterface.php index 1a8bb995b..5d04472cf 100644 --- a/app/vendor/cakephp/cakephp/src/Console/CommandFactoryInterface.php +++ b/app/vendor/cakephp/cakephp/src/Console/CommandFactoryInterface.php @@ -22,7 +22,7 @@ interface CommandFactoryInterface /** * The factory method for creating Command instances. * - * @param string $className Command class name. + * @param class-string<\Cake\Console\CommandInterface> $className Command class name. * @return \Cake\Console\CommandInterface */ public function create(string $className): CommandInterface; diff --git a/app/vendor/cakephp/cakephp/src/Console/CommandHiddenInterface.php b/app/vendor/cakephp/cakephp/src/Console/CommandHiddenInterface.php new file mode 100644 index 000000000..3f48e9208 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Console/CommandHiddenInterface.php @@ -0,0 +1,37 @@ + 'version', '--help' => 'help', '-h' => 'help', + '-v' => 'help', + '--verbose' => 'help', ]; /** @@ -136,6 +138,13 @@ public function run(array $argv, ?ConsoleIo $io = null): int $this->bootstrap(); + if ($this->app instanceof EventAwareApplicationInterface) { + $eventManager = $this->getEventManager(); + $eventManager = $this->app->events($eventManager); + $eventManager = $this->app->pluginEvents($eventManager); + $this->setEventManager($eventManager); + } + $commands = new CommandCollection([ 'help' => HelpCommand::class, ]); @@ -155,8 +164,24 @@ public function run(array $argv, ?ConsoleIo $io = null): int $io = $io ?: new ConsoleIo(); + /** @var array{string|null, array} $resolved */ + $resolved = $this->longestCommandName($commands, $argv); + [$name, $argv] = $resolved; + + // If -v/--verbose is used as command, preserve it as flag for help command + if ($name === '-v' || $name === '--verbose') { + $argv = array_merge([$name], $argv); + $name = 'help'; + } + + // Check if this is a command prefix (e.g., "cache" has subcommands like "cache clear") + // Show help for that prefix instead of running the base command + if ($name !== null && !$commands->has($name) && $this->hasCommandsWithPrefix($commands, $name)) { + $argv = [$name]; + $name = 'help'; + } + try { - [$name, $argv] = $this->longestCommandName($commands, $argv); $name = $this->resolveName($commands, $io, $name); } catch (MissingOptionException $e) { $io->error($e->getFullMessage()); @@ -266,7 +291,7 @@ protected function longestCommandName(CommandCollection $commands, array $argv): } $firstChar = $name[0] ?? ''; - if ($firstChar == strtoupper($firstChar) && str_contains($name, '.')) { + if ($firstChar === strtoupper($firstChar) && str_contains($name, '.')) { $underName = Inflector::underscore($name); if ($commands->has($underName)) { return [$underName, array_slice($argv, $i)]; @@ -295,7 +320,7 @@ protected function longestCommandName(CommandCollection $commands, array $argv): protected function resolveName(CommandCollection $commands, ConsoleIo $io, ?string $name): string { if (!$name) { - $io->err('No command provided. Choose one of the available commands.', 2); + $io->error('No command provided. Choose one of the available commands.', 2); $name = 'help'; } $name = $this->aliases[$name] ?? $name; @@ -314,6 +339,24 @@ protected function resolveName(CommandCollection $commands, ConsoleIo $io, ?stri return $name; } + /** + * Check if there are commands that start with the given prefix. + * + * @param \Cake\Console\CommandCollection $commands The command collection. + * @param string $prefix The prefix to check. + * @return bool True if commands with this prefix exist. + */ + protected function hasCommandsWithPrefix(CommandCollection $commands, string $prefix): bool + { + foreach ($commands->keys() as $name) { + if (str_starts_with($name, $prefix . ' ')) { + return true; + } + } + + return false; + } + /** * Execute a Command class. * @@ -325,12 +368,6 @@ protected function resolveName(CommandCollection $commands, ConsoleIo $io, ?stri protected function runCommand(CommandInterface $command, array $argv, ConsoleIo $io): ?int { try { - $eventManager = $this->getEventManager(); - if ($this->app instanceof EventAwareApplicationInterface) { - $eventManager = $this->app->events($eventManager); - $eventManager = $this->app->pluginEvents($eventManager); - } - $this->setEventManager($eventManager); if ($command instanceof EventDispatcherInterface) { $command->setEventManager($this->getEventManager()); } @@ -344,7 +381,7 @@ protected function runCommand(CommandInterface $command, array $argv, ConsoleIo /** * The wrapper for creating command instances. * - * @param string $className Command class name. + * @param class-string<\Cake\Console\CommandInterface> $className Command class name. * @return \Cake\Console\CommandInterface */ protected function createCommand(string $className): CommandInterface diff --git a/app/vendor/cakephp/cakephp/src/Console/CommandScanner.php b/app/vendor/cakephp/cakephp/src/Console/CommandScanner.php index 3dd778838..25e5eb405 100644 --- a/app/vendor/cakephp/cakephp/src/Console/CommandScanner.php +++ b/app/vendor/cakephp/cakephp/src/Console/CommandScanner.php @@ -78,14 +78,14 @@ public function scanPlugin(string $plugin): array $namespace = str_replace('/', '\\', $plugin); $prefix = Inflector::underscore($plugin) . '.'; - return $this->scanDir($path . 'Command', $namespace . '\Command\\', $prefix, []); + return $this->scanDir($path . 'Command' . DIRECTORY_SEPARATOR, $namespace . '\Command\\', $prefix, []); } /** * Scan a directory for .php files and return the class names that * should be within them. * - * @param string $path The directory to read. + * @param string $path The directory to read. Must end with a trailing directory separator. * @param string $namespace The namespace the shells live in. * @param string $prefix The prefix to apply to commands for their full name. * @param array $hide A list of command names to hide as they are internal commands. diff --git a/app/vendor/cakephp/cakephp/src/Console/ConsoleInput.php b/app/vendor/cakephp/cakephp/src/Console/ConsoleInput.php index a1df57367..5621d6efb 100644 --- a/app/vendor/cakephp/cakephp/src/Console/ConsoleInput.php +++ b/app/vendor/cakephp/cakephp/src/Console/ConsoleInput.php @@ -60,11 +60,10 @@ public function __construct(string $handle = 'php://stdin') /** * Destruct and free resources - * - * @return void */ public function __destruct() { + // @phpstan-ignore isset.property (property may not be set if constructor throws) if (isset($this->_input) && is_resource($this->_input)) { fclose($this->_input); } diff --git a/app/vendor/cakephp/cakephp/src/Console/ConsoleInputArgument.php b/app/vendor/cakephp/cakephp/src/Console/ConsoleInputArgument.php index eb489698c..c59c96056 100644 --- a/app/vendor/cakephp/cakephp/src/Console/ConsoleInputArgument.php +++ b/app/vendor/cakephp/cakephp/src/Console/ConsoleInputArgument.php @@ -17,6 +17,7 @@ namespace Cake\Console; use Cake\Console\Exception\ConsoleException; +use Cake\Core\Exception\CakeException; use SimpleXMLElement; /** @@ -86,12 +87,15 @@ public function __construct( ?string $default = null, ?string $separator = null, ) { - if (is_array($name) && isset($name['name'])) { + if (is_array($name)) { + if (!isset($name['name'])) { + throw new CakeException('You must provide a `name` for the argument.'); + } + foreach ($name as $key => $value) { $this->{'_' . $key} = $value; } } else { - /** @var string $name */ $this->_name = $name; $this->_help = $help; $this->_required = $required; @@ -228,7 +232,7 @@ public function validChoice(string $value): bool $values = [$value]; } - $unwanted = array_filter($values, fn($value) => !in_array($value, $this->_choices, true)); + $unwanted = array_filter($values, fn(string $value) => !in_array($value, $this->_choices, true)); if ($unwanted) { throw new ConsoleException( sprintf( @@ -252,6 +256,7 @@ public function validChoice(string $value): bool public function xml(SimpleXMLElement $parent): SimpleXMLElement { $option = $parent->addChild('argument'); + assert($option !== null); $option->addAttribute('name', $this->_name); $option->addAttribute('help', $this->_help); $option->addAttribute('required', (string)(int)$this->isRequired()); diff --git a/app/vendor/cakephp/cakephp/src/Console/ConsoleInputOption.php b/app/vendor/cakephp/cakephp/src/Console/ConsoleInputOption.php index f7ec7718b..6d6d8c826 100644 --- a/app/vendor/cakephp/cakephp/src/Console/ConsoleInputOption.php +++ b/app/vendor/cakephp/cakephp/src/Console/ConsoleInputOption.php @@ -182,7 +182,7 @@ public function short(): string } /** - * Generate the help for this this option. + * Generate the help for this option. * * @param int $width The width to make the name of the option. * @return string @@ -300,7 +300,7 @@ public function validChoice(string|bool $value): bool $values = array_map('boolval', $values); } - $unwanted = array_filter($values, fn($value) => !in_array($value, $this->_choices, true)); + $unwanted = array_filter($values, fn(bool|string $value) => !in_array($value, $this->_choices, true)); if ($unwanted) { throw new ConsoleException( sprintf( diff --git a/app/vendor/cakephp/cakephp/src/Console/ConsoleIo.php b/app/vendor/cakephp/cakephp/src/Console/ConsoleIo.php index 60c3e84fe..202ab42fe 100644 --- a/app/vendor/cakephp/cakephp/src/Console/ConsoleIo.php +++ b/app/vendor/cakephp/cakephp/src/Console/ConsoleIo.php @@ -194,6 +194,7 @@ public function quiet(array|string $message, int $newlines = 1): ?int * @param int $level The message's output level, see above. * @return int|null The number of bytes returned from writing to stdout * or null if provided $level is greater than current level. + * @link https://book.cakephp.org/5/en/console-commands/input-output.html#creating-output */ public function out(array|string $message = '', int $newlines = 1, int $level = self::NORMAL): ?int { @@ -214,7 +215,7 @@ public function out(array|string $message = '', int $newlines = 1, int $level = * @param int $level The message's output level, see above. * @return int|null The number of bytes returned from writing to stdout * or null if provided $level is greater than current level. - * @link https://book.cakephp.org/5/en/console-and-shells.html#ConsoleIo::out + * @link https://book.cakephp.org/5/en/console-commands/input-output.html#creating-output */ public function info(array|string $message, int $newlines = 1, int $level = self::NORMAL): ?int { @@ -232,7 +233,7 @@ public function info(array|string $message, int $newlines = 1, int $level = self * @param int $level The message's output level, see above. * @return int|null The number of bytes returned from writing to stdout * or null if provided $level is greater than current level. - * @link https://book.cakephp.org/5/en/console-and-shells.html#ConsoleIo::out + * @link https://book.cakephp.org/5/en/console-commands/input-output.html#creating-output */ public function comment(array|string $message, int $newlines = 1, int $level = self::NORMAL): ?int { @@ -248,7 +249,7 @@ public function comment(array|string $message, int $newlines = 1, int $level = s * @param array|string $message A string or an array of strings to output * @param int $newlines Number of newlines to append * @return int The number of bytes returned from writing to stderr. - * @link https://book.cakephp.org/5/en/console-and-shells.html#ConsoleIo::err + * @link https://book.cakephp.org/5/en/console-commands/input-output.html#creating-output */ public function warning(array|string $message, int $newlines = 1): int { @@ -264,7 +265,7 @@ public function warning(array|string $message, int $newlines = 1): int * @param array|string $message A string or an array of strings to output * @param int $newlines Number of newlines to append * @return int The number of bytes returned from writing to stderr. - * @link https://book.cakephp.org/5/en/console-and-shells.html#ConsoleIo::err + * @link https://book.cakephp.org/5/en/console-commands/input-output.html#creating-output */ public function error(array|string $message, int $newlines = 1): int { @@ -282,7 +283,7 @@ public function error(array|string $message, int $newlines = 1): int * @param int $level The message's output level, see above. * @return int|null The number of bytes returned from writing to stdout * or null if provided $level is greater than current level. - * @link https://book.cakephp.org/5/en/console-and-shells.html#ConsoleIo::out + * @link https://book.cakephp.org/5/en/console-commands/input-output.html#creating-output */ public function success(array|string $message, int $newlines = 1, int $level = self::NORMAL): ?int { @@ -293,7 +294,7 @@ public function success(array|string $message, int $newlines = 1, int $level = s } /** - * Halts the the current process with a StopException. + * Halts the current process with a StopException. * * @param string $message Error message. * @param int $code Error code. @@ -374,6 +375,7 @@ public function overwrite(array|string $message, int $newlines = 1, ?int $size = * @param array|string $message A string or an array of strings to output * @param int $newlines Number of newlines to append * @return int The number of bytes returned from writing to stderr. + * @link https://book.cakephp.org/5/en/console-commands/input-output.html#creating-output */ public function err(array|string $message = '', int $newlines = 1): int { diff --git a/app/vendor/cakephp/cakephp/src/Console/ConsoleOptionParser.php b/app/vendor/cakephp/cakephp/src/Console/ConsoleOptionParser.php index 29a70f7fb..d8049d662 100644 --- a/app/vendor/cakephp/cakephp/src/Console/ConsoleOptionParser.php +++ b/app/vendor/cakephp/cakephp/src/Console/ConsoleOptionParser.php @@ -20,7 +20,6 @@ use Cake\Console\Exception\MissingOptionException; use Cake\Utility\Inflector; use LogicException; -use function Cake\Core\deprecationWarning; /** * Handles parsing the ARGV in the command line and provides support @@ -42,7 +41,7 @@ * only be one letter long. Using more than one letter for a short option will raise an exception. * * Calling options can be done using syntax similar to most *nix command line tools. Long options - * cane either include an `=` or leave it out. + * can either include an `=` or leave it out. * * `cake my_command --connection default --name=something` * @@ -79,7 +78,7 @@ class ConsoleOptionParser /** * Description text - displays before options when help is generated * - * @see \Cake\Console\ConsoleOptionParser::description() + * @see \Cake\Console\ConsoleOptionParser::setDescription() * @var string */ protected string $_description = ''; @@ -87,7 +86,7 @@ class ConsoleOptionParser /** * Epilog text - displays after options when help is generated * - * @see \Cake\Console\ConsoleOptionParser::epilog() + * @see \Cake\Console\ConsoleOptionParser::setEpilog() * @var string */ protected string $_epilog = ''; @@ -161,7 +160,7 @@ public function __construct(string $command = '', bool $defaultOptions = true) 'boolean' => true, ])->addOption('quiet', [ 'short' => 'q', - 'help' => 'Enable quiet output.', + 'help' => 'Enable quiet output and non-interactive mode.', 'boolean' => true, ]); } @@ -411,7 +410,11 @@ public function addOption(ConsoleInputOption|string $name, array $options = []) asort($this->_options); if ($option->short()) { if (isset($this->_shortOptions[$option->short()])) { - deprecationWarning('5.2.0', 'You cannot redefine short options. This will throw an error in 5.3.0+.'); + throw new LogicException(sprintf( + 'Short option `%s` is already defined for option `%s`. You cannot redefine short options.', + $option->short(), + $this->_shortOptions[$option->short()], + )); } $this->_shortOptions[$option->short()] = $name; @@ -771,7 +774,7 @@ protected function _parseOption(string $name, array $params): array $option = $this->_options[$name]; $isBoolean = $option->isBoolean(); $nextValue = $this->_nextToken(); - $emptyNextValue = (empty($nextValue) && $nextValue !== '0'); + $emptyNextValue = (!$nextValue && $nextValue !== '0'); if (!$isBoolean && !$emptyNextValue && !$this->_optionExists($nextValue)) { array_shift($this->_tokens); $value = $nextValue; @@ -833,8 +836,8 @@ protected function _parseArg(string $argument, array $args): array if (!isset($this->_args[$next])) { $expected = count($this->_args); throw new ConsoleException(sprintf( - 'Received too many arguments. Got `%s` but only `%s` arguments are defined.', - $next, + 'Received too many arguments. Got `%s` (or more) but only `%s` arguments are defined.', + $next + 1, $expected, )); } diff --git a/app/vendor/cakephp/cakephp/src/Console/ConsoleOutput.php b/app/vendor/cakephp/cakephp/src/Console/ConsoleOutput.php index 09485833a..2ed861963 100644 --- a/app/vendor/cakephp/cakephp/src/Console/ConsoleOutput.php +++ b/app/vendor/cakephp/cakephp/src/Console/ConsoleOutput.php @@ -92,7 +92,7 @@ class ConsoleOutput /** * The current output type. * - * @see setOutputAs() For manipulation. + * @see \Cake\Console\ConsoleOutput::setOutputAs() For manipulation. * @var int */ protected int $_outputAs = self::COLOR; @@ -192,7 +192,7 @@ public function __construct($stream = 'php://stdout') DIRECTORY_SEPARATOR === '\\' && !str_contains(strtolower(php_uname('v')), 'windows 10') && !str_contains(strtolower((string)env('SHELL')), 'bash.exe') && - !(bool)env('ANSICON') && + !env('ANSICON') && env('ConEmuANSI') !== 'ON' ) || ( @@ -236,7 +236,6 @@ public function styleText(string $text): string return $text; } if ($this->_outputAs !== static::PLAIN) { - /** @var \Closure $replaceTags */ $replaceTags = $this->_replaceTags(...); $output = preg_replace_callback( @@ -293,7 +292,8 @@ protected function _replaceTags(array $matches): string */ protected function _write(string $message): int { - if (!isset($this->_output)) { + // @phpstan-ignore isset.property (property may not be set: ConsoleOutput::__destruct() unsets _output) + if (!isset($this->_output) || !is_resource($this->_output)) { return 0; } @@ -327,7 +327,7 @@ public function getStyle(string $style): array * ``` * * @param string $style The style to set. - * @param array $definition The array definition of the style to change or create.. + * @param array $definition The array definition of the style to change or create. * @return void */ public function setStyle(string $style, array $definition): void @@ -382,6 +382,7 @@ public function setOutputAs(int $type): void */ public function __destruct() { + // @phpstan-ignore isset.property (property may not be set if constructor throws) if (isset($this->_output) && is_resource($this->_output)) { fclose($this->_output); } diff --git a/app/vendor/cakephp/cakephp/src/Console/Exception/ConsoleException.php b/app/vendor/cakephp/cakephp/src/Console/Exception/ConsoleException.php index 51158fe7d..054ce9c2e 100644 --- a/app/vendor/cakephp/cakephp/src/Console/Exception/ConsoleException.php +++ b/app/vendor/cakephp/cakephp/src/Console/Exception/ConsoleException.php @@ -9,7 +9,7 @@ * Redistributions of files must retain the above copyright notice. * * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org) - * @link https://book.cakephp.org/5/en/development/errors.html#error-exception-configuration + * @link https://book.cakephp.org/5/en/development/errors.html#configuration * @since 3.0.0 * @license https://opensource.org/licenses/mit-license.php MIT License */ diff --git a/app/vendor/cakephp/cakephp/src/Console/Exception/MissingOptionException.php b/app/vendor/cakephp/cakephp/src/Console/Exception/MissingOptionException.php index e6dda899e..1230dedf6 100644 --- a/app/vendor/cakephp/cakephp/src/Console/Exception/MissingOptionException.php +++ b/app/vendor/cakephp/cakephp/src/Console/Exception/MissingOptionException.php @@ -9,7 +9,7 @@ * Redistributions of files must retain the above copyright notice. * * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org) - * @link https://book.cakephp.org/5/en/development/errors.html#error-exception-configuration + * @link https://book.cakephp.org/5/en/development/errors.html#configuration * @since 4.0.0 * @license https://opensource.org/licenses/mit-license.php MIT License */ diff --git a/app/vendor/cakephp/cakephp/src/Console/Exception/StopException.php b/app/vendor/cakephp/cakephp/src/Console/Exception/StopException.php index 117774fa8..6afba3ded 100644 --- a/app/vendor/cakephp/cakephp/src/Console/Exception/StopException.php +++ b/app/vendor/cakephp/cakephp/src/Console/Exception/StopException.php @@ -9,7 +9,7 @@ * Redistributions of files must retain the above copyright notice. * * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org) - * @link https://book.cakephp.org/5/en/development/errors.html#error-exception-configuration + * @link https://book.cakephp.org/5/en/development/errors.html#configuration * @since 3.2.0 * @license https://opensource.org/licenses/mit-license.php MIT License */ @@ -18,7 +18,7 @@ /** * Exception class for halting errors in console tasks * - * @see \Cake\Command\BaseCommand::abort() + * @see \Cake\Console\BaseCommand::abort() */ class StopException extends ConsoleException { diff --git a/app/vendor/cakephp/cakephp/src/Console/HelperRegistry.php b/app/vendor/cakephp/cakephp/src/Console/HelperRegistry.php index b45cabc26..dc6be8b04 100644 --- a/app/vendor/cakephp/cakephp/src/Console/HelperRegistry.php +++ b/app/vendor/cakephp/cakephp/src/Console/HelperRegistry.php @@ -36,7 +36,7 @@ class HelperRegistry extends ObjectRegistry protected ConsoleIo $_io; /** - * Sets The IO instance that should be passed to the shell helpers + * Sets the IO instance that should be passed to the shell helpers * * @param \Cake\Console\ConsoleIo $io An io instance. * @return void diff --git a/app/vendor/cakephp/cakephp/src/Console/TestSuite/ConsoleIntegrationTestTrait.php b/app/vendor/cakephp/cakephp/src/Console/TestSuite/ConsoleIntegrationTestTrait.php index 3f9114519..5ab9b3e67 100644 --- a/app/vendor/cakephp/cakephp/src/Console/TestSuite/ConsoleIntegrationTestTrait.php +++ b/app/vendor/cakephp/cakephp/src/Console/TestSuite/ConsoleIntegrationTestTrait.php @@ -29,7 +29,6 @@ use Cake\Core\ConsoleApplicationInterface; use Cake\Core\TestSuite\ContainerStubTrait; use Cake\Error\Debugger; -use InvalidArgumentException; use PHPUnit\Framework\Attributes\After; /** @@ -38,6 +37,8 @@ * * Enables you to call commands/shells with a * full application context. + * + * @require-extends \Cake\TestSuite\TestCase */ trait ConsoleIntegrationTestTrait { @@ -86,12 +87,8 @@ public function exec(string $command, array $input = []): void $this->_out ??= new StubConsoleOutput(); $this->_err ??= new StubConsoleOutput(); - if ($this->_in === null) { + if ($this->_in === null || $input) { $this->_in = new StubConsoleInput($input); - } elseif ($input) { - throw new InvalidArgumentException( - 'You can use `$input` only if `$_in` property is null and will be reset.', - ); } $this->_out->clear(); $this->_err->clear(); diff --git a/app/vendor/cakephp/cakephp/src/Console/composer.json b/app/vendor/cakephp/cakephp/src/Console/composer.json index d3a061fe5..e66ee8814 100644 --- a/app/vendor/cakephp/cakephp/src/Console/composer.json +++ b/app/vendor/cakephp/cakephp/src/Console/composer.json @@ -23,11 +23,11 @@ "source": "https://github.com/cakephp/console" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev", - "cakephp/event": "5.2.*@dev", - "cakephp/log": "5.2.*@dev", - "cakephp/utility": "5.2.*@dev" + "php": ">=8.2", + "cakephp/core": "^5.3.0", + "cakephp/event": "^5.3.0", + "cakephp/log": "^5.3.0", + "cakephp/utility": "^5.3.0" }, "suggest": { "cakephp/datasource": "To use the Command base classes", @@ -38,10 +38,11 @@ "Cake\\Console\\": "." } }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Controller/Component.php b/app/vendor/cakephp/cakephp/src/Controller/Component.php index 695706b1d..9cfdf716a 100644 --- a/app/vendor/cakephp/cakephp/src/Controller/Component.php +++ b/app/vendor/cakephp/cakephp/src/Controller/Component.php @@ -66,7 +66,7 @@ class Component implements EventListenerInterface /** * Component registry class used to lazy load components. * - * @var \Cake\Controller\ComponentRegistry + * @var \Cake\Controller\ComponentRegistry<\Cake\Controller\Controller> */ protected ComponentRegistry $_registry; @@ -96,7 +96,7 @@ class Component implements EventListenerInterface /** * Constructor * - * @param \Cake\Controller\ComponentRegistry $registry A component registry + * @param \Cake\Controller\ComponentRegistry<\Cake\Controller\Controller> $registry A component registry * this component can use to lazy load its components. * @param array $config Array of configuration settings. */ diff --git a/app/vendor/cakephp/cakephp/src/Controller/ComponentRegistry.php b/app/vendor/cakephp/cakephp/src/Controller/ComponentRegistry.php index e6e4ac909..0e49f576a 100644 --- a/app/vendor/cakephp/cakephp/src/Controller/ComponentRegistry.php +++ b/app/vendor/cakephp/cakephp/src/Controller/ComponentRegistry.php @@ -23,9 +23,16 @@ use Cake\Core\ObjectRegistry; use Cake\Event\EventDispatcherInterface; use Cake\Event\EventDispatcherTrait; +use League\Container\Argument\ArgumentReflectorTrait; use League\Container\Argument\ArgumentResolverTrait; +use League\Container\Argument\LiteralArgument; +use League\Container\Argument\ResolvableArgument; use League\Container\Exception\NotFoundException; +use League\Container\ReflectionContainer; use ReflectionClass; +use ReflectionFunctionAbstract; +use ReflectionMethod; +use ReflectionNamedType; use RuntimeException; /** @@ -46,6 +53,8 @@ class ComponentRegistry extends ObjectRegistry implements EventDispatcherInterfa use ArgumentResolverTrait; + use ArgumentReflectorTrait; + /** * The controller that this collection is associated with. * @@ -139,6 +148,22 @@ protected function _throwMissingClassError(string $class, ?string $plugin): void * Part of the template method for {@link \Cake\Core\ObjectRegistry::load()} * Enabled components will be registered with the event manager. * + * ## Container Resolution + * + * When a container is available, this method attempts to resolve components from it. + * Components registered in the container will be resolved using dependency injection. + * If not registered, a new definition will be created with auto-wired constructor arguments. + * + * ## Edge Cases + * + * - **Shared instances**: Components registered as shared instances in the container + * will have their config merged via setConfig(). This means multiple controller + * instances may share the same component instance, which could lead to unexpected + * state sharing between requests. + * - **Manual registration**: Components manually registered in the container with + * specific constructor arguments will use those arguments. The `$config` parameter + * will be merged into the component after instantiation using setConfig(). + * * @param \Cake\Controller\Component|class-string<\Cake\Controller\Component> $class The classname to create. * @param string $alias The alias of the component. * @param array $config An array of config to use for the component. @@ -150,22 +175,31 @@ protected function _create(object|string $class, string $alias, array $config): return $class; } if ($this->container?->has($class)) { - $constructor = (new ReflectionClass($class))->getConstructor(); - - if ($constructor !== null) { - $args = $this->reflectArguments($constructor, ['config' => $config]); + // Check if definition already exists - if so, user has manually configured it + $hasDefinition = false; + try { + $this->container->extend($class); + $hasDefinition = true; + } catch (NotFoundException) { + // No definition exists yet + } - try { - $this->container->extend($class) - ->addArguments($args); - } catch (NotFoundException) { - $this->container->add($class) - ->addArguments($args); + if (!$hasDefinition) { + // No user-defined configuration - add auto-wired arguments + $constructor = (new ReflectionClass($class))->getConstructor(); + if ($constructor !== null) { + $args = $this->reflectArguments($constructor, ['config' => $config]); + $this->container->add($class)->addArguments($args); } } /** @var \Cake\Controller\Component $instance */ $instance = $this->container->get($class); + + // For manually configured components, merge runtime config + if ($hasDefinition && $config) { + $instance->setConfig($config); + } } else { $instance = new $class($this, $config); } @@ -190,4 +224,73 @@ protected function getContainer(): ContainerInterface return $this->container; } + + /** + * Reflect on constructor arguments and build argument list for container. + * + * This method inspects a constructor's parameters and builds a list of + * arguments that can be passed to the container's add() or extend() methods. + * + * @param \ReflectionFunctionAbstract $method The constructor to reflect on + * @param array $args Named arguments to pass as literals (e.g., ['config' => []]) + * @return array<\League\Container\Argument\LiteralArgument|\League\Container\Argument\ResolvableArgument> + */ + protected function reflectArguments(ReflectionFunctionAbstract $method, array $args = []): array + { + $arguments = []; + $params = $method->getParameters(); + + foreach ($params as $param) { + $name = $param->getName(); + + // If we have a literal value for this parameter, use it + if (array_key_exists($name, $args)) { + $arguments[] = new LiteralArgument($args[$name]); + continue; + } + + // Check if parameter has a type hint + $type = $param->getType(); + if ($type instanceof ReflectionNamedType && !$type->isBuiltin()) { + // Type-hinted parameter - resolve from container + $arguments[] = new ResolvableArgument($type->getName()); + continue; + } + + // Check for default value + if ($param->isDefaultValueAvailable()) { + $arguments[] = new LiteralArgument($param->getDefaultValue()); + continue; + } + + // No type hint, no default, no provided value - this will fail at runtime + $declaringClass = $method instanceof ReflectionMethod + ? $method->getDeclaringClass()->getName() + : 'unknown'; + + throw new CakeException( + sprintf( + 'Cannot auto-wire parameter $%s in %s - no type hint or default value', + $name, + $declaringClass, + ), + ); + } + + return $this->resolveArguments($arguments); + } + + /** + * Get the mode of the container. + * + * This method is used to determine how the container should resolve + * dependencies and arguments. + * + * @return int The mode of the container. + * @internal + */ + protected function getMode(): int + { + return ReflectionContainer::AUTO_WIRING; + } } diff --git a/app/vendor/cakephp/cakephp/src/Controller/Controller.php b/app/vendor/cakephp/cakephp/src/Controller/Controller.php index e67a6913e..151872916 100644 --- a/app/vendor/cakephp/cakephp/src/Controller/Controller.php +++ b/app/vendor/cakephp/cakephp/src/Controller/Controller.php @@ -161,7 +161,7 @@ class Controller implements EventListenerInterface, EventDispatcherInterface /** * Instance of ComponentRegistry used to create Components * - * @var \Cake\Controller\ComponentRegistry|null + * @var \Cake\Controller\ComponentRegistry<\Cake\Controller\Controller>|null */ protected ?ComponentRegistry $_components = null; @@ -197,7 +197,7 @@ class Controller implements EventListenerInterface, EventDispatcherInterface * but expect that features that use the request parameters will not work. * @param string|null $name Override the name useful in testing when using mocks. * @param \Cake\Event\EventManagerInterface|null $eventManager The event manager. Defaults to a new instance. - * @param \Cake\Controller\ComponentRegistry|null $components ComponentRegistry to use. Defaults to a new instance. + * @param \Cake\Controller\ComponentRegistry<\Cake\Controller\Controller>|null $components ComponentRegistry to use. Defaults to a new instance. */ public function __construct( ServerRequest $request, @@ -255,7 +255,7 @@ public function initialize(): void /** * Get the component registry for this controller. * - * @return \Cake\Controller\ComponentRegistry + * @return \Cake\Controller\ComponentRegistry<\Cake\Controller\Controller> */ public function components(): ComponentRegistry { @@ -265,7 +265,7 @@ public function components(): ComponentRegistry /** * Add a component to the controller's registry. * - * After loading a component it will be be accessible as a property through Controller::__get(). + * After loading a component it will be accessible as a property through Controller::__get(). * For example: * * ``` @@ -278,6 +278,7 @@ public function components(): ComponentRegistry * @param array $config The config for the component. * @return \Cake\Controller\Component * @throws \Exception + * @link https://book.cakephp.org/5/en/controllers.html#configuring-components-to-load */ public function loadComponent(string $name, array $config = []): Component { @@ -474,19 +475,16 @@ public function setResponse(Response $response) public function getAction(): Closure { $request = $this->request; + /** @var string $action */ $action = $request->getParam('action'); $controller = $this->name . 'Controller'; - if ($request->getParam('prefix')) { - $controller = $request->getParam('prefix') . '/' . $controller; - } - if ($this->plugin) { - $controller = $this->plugin . '.' . $controller; - } if (!$this->isAction($action)) { throw new MissingActionException([ 'controller' => $controller, 'action' => $action, + 'prefix' => $request->getParam('prefix') ?? null, + 'plugin' => $this->plugin ?? null, ]); } @@ -639,7 +637,7 @@ public function shutdownProcess(): ?ResponseInterface * @param \Psr\Http\Message\UriInterface|array|string $url A string, array-based URL or UriInterface instance. * @param int $status HTTP status code. Defaults to `302`. * @return \Cake\Http\Response|null - * @link https://book.cakephp.org/5/en/controllers.html#Controller::redirect + * @link https://book.cakephp.org/5/en/controllers.html#redirecting-to-other-pages */ public function redirect(UriInterface|array|string $url, int $status = 302): ?Response { @@ -858,7 +856,7 @@ public function referer(array|string|null $default = '/', bool $local = true): s * @param \Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface|string|null $object Table to paginate * (e.g: Table instance, 'TableName' or a Query object) * @param array $settings The settings/configuration used for pagination. See {@link \Cake\Controller\Controller::$paginate}. - * @return \Cake\Datasource\Paging\PaginatedInterface + * @return \Cake\Datasource\Paging\PaginatedInterface * @link https://book.cakephp.org/5/en/controllers.html#paginating-a-model * @throws \Cake\Http\Exception\NotFoundException When a page out of bounds is requested. */ diff --git a/app/vendor/cakephp/cakephp/src/Controller/ControllerFactory.php b/app/vendor/cakephp/cakephp/src/Controller/ControllerFactory.php index e6557d6a4..486f25112 100644 --- a/app/vendor/cakephp/cakephp/src/Controller/ControllerFactory.php +++ b/app/vendor/cakephp/cakephp/src/Controller/ControllerFactory.php @@ -100,8 +100,8 @@ public function create(ServerRequestInterface $request): Controller // TODO: In a future minor release it would be good to start requiring the components parameter if ( $parameter->getName() === 'components' && - $paramType !== null && - $paramType->getName() == ComponentRegistry::class + $paramType instanceof ReflectionNamedType && + $paramType->getName() === ComponentRegistry::class ) { $hasComponents = true; break; diff --git a/app/vendor/cakephp/cakephp/src/Controller/ErrorController.php b/app/vendor/cakephp/cakephp/src/Controller/ErrorController.php index d5dee1452..f153826c8 100644 --- a/app/vendor/cakephp/cakephp/src/Controller/ErrorController.php +++ b/app/vendor/cakephp/cakephp/src/Controller/ErrorController.php @@ -42,7 +42,6 @@ public function viewClasses(): array * * @param \Cake\Event\EventInterface<\Cake\Controller\Controller> $event Event. * @return \Cake\Http\Response|null|void - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint */ public function beforeRender(EventInterface $event) { diff --git a/app/vendor/cakephp/cakephp/src/Core/Attribute/Configure.php b/app/vendor/cakephp/cakephp/src/Core/Attribute/Configure.php new file mode 100644 index 000000000..92d9e4e7d --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Core/Attribute/Configure.php @@ -0,0 +1,61 @@ +name); + } +} diff --git a/app/vendor/cakephp/cakephp/src/Core/BasePlugin.php b/app/vendor/cakephp/cakephp/src/Core/BasePlugin.php index 67b556807..9630cdbb9 100644 --- a/app/vendor/cakephp/cakephp/src/Core/BasePlugin.php +++ b/app/vendor/cakephp/cakephp/src/Core/BasePlugin.php @@ -275,7 +275,9 @@ public function routes(RouteBuilder $routes): void } /** - * @inheritDoc + * {@inheritDoc} + * + * @param \Cake\Core\PluginApplicationInterface $app The host application */ public function bootstrap(PluginApplicationInterface $app): void { diff --git a/app/vendor/cakephp/cakephp/src/Core/Configure.php b/app/vendor/cakephp/cakephp/src/Core/Configure.php index 1fa44e8b9..cbb4bd070 100644 --- a/app/vendor/cakephp/cakephp/src/Core/Configure.php +++ b/app/vendor/cakephp/cakephp/src/Core/Configure.php @@ -214,7 +214,7 @@ public static function consumeOrFail(string $var): mixed * out of configure into the various other classes in CakePHP. * * @param string $var The key to read and remove. - * @return mixed + * @return mixed The value stored in Configure, or null if the key doesn't exist. */ public static function consume(string $var): mixed { @@ -274,7 +274,7 @@ public static function configured(): array { $engines = array_keys(static::$_engines); - return array_map(function ($key) { + return array_map(function (int|string $key) { return (string)$key; }, $engines); } diff --git a/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/IniConfig.php b/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/IniConfig.php index 13e2a5be9..af87cac41 100644 --- a/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/IniConfig.php +++ b/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/IniConfig.php @@ -43,7 +43,7 @@ * * Once loaded into Configure, the above would be accessed using: * - * `Configure::read('section.key'); + * `Configure::read('section.key');` * * You can also use `.` separated values in section names to create more deeply * nested structures. diff --git a/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/JsonConfig.php b/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/JsonConfig.php index 86f4bbba5..95388e53f 100644 --- a/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/JsonConfig.php +++ b/app/vendor/cakephp/cakephp/src/Core/Configure/Engine/JsonConfig.php @@ -111,6 +111,6 @@ public function dump(string $key, array $data): bool { $filename = $this->_getFilePath($key); - return file_put_contents($filename, json_encode($data, JSON_PRETTY_PRINT)) > 0; + return file_put_contents($filename, json_encode($data, JSON_PRETTY_PRINT)) !== false; } } diff --git a/app/vendor/cakephp/cakephp/src/Core/Configure/FileConfigTrait.php b/app/vendor/cakephp/cakephp/src/Core/Configure/FileConfigTrait.php index 67201951c..aae848dfc 100644 --- a/app/vendor/cakephp/cakephp/src/Core/Configure/FileConfigTrait.php +++ b/app/vendor/cakephp/cakephp/src/Core/Configure/FileConfigTrait.php @@ -45,7 +45,7 @@ trait FileConfigTrait protected function _getFilePath(string $key, bool $checkExists = false): string { if (str_contains($key, '..')) { - throw new CakeException('Cannot load/dump configuration files with ../ in them.'); + throw new CakeException('Cannot load/dump configuration files with .. in them.'); } [$plugin, $key] = pluginSplit($key); diff --git a/app/vendor/cakephp/cakephp/src/Core/InstanceConfigTrait.php b/app/vendor/cakephp/cakephp/src/Core/InstanceConfigTrait.php index cc850ba60..4a66d330b 100644 --- a/app/vendor/cakephp/cakephp/src/Core/InstanceConfigTrait.php +++ b/app/vendor/cakephp/cakephp/src/Core/InstanceConfigTrait.php @@ -72,11 +72,7 @@ trait InstanceConfigTrait */ public function setConfig(array|string $key, mixed $value = null, bool $merge = true) { - if (!$this->_configInitialized) { - $this->_config = $this->_defaultConfig; - $this->_configInitialized = true; - } - + $this->initCfg(); $this->_configWrite($key, $value, $merge); return $this; @@ -113,14 +109,11 @@ public function setConfig(array|string $key, mixed $value = null, bool $merge = * * @param string|null $key The key to get or null for the whole config. * @param mixed $default The return value when the key does not exist. - * @return mixed Configuration data at the named key or null if the key does not exist. + * @return ($key is null ? array : mixed) Configuration data at the named key or null if the key does not exist. */ public function getConfig(?string $key = null, mixed $default = null): mixed { - if (!$this->_configInitialized) { - $this->_config = $this->_defaultConfig; - $this->_configInitialized = true; - } + $this->initCfg(); return $this->_configRead($key) ?? $default; } @@ -171,22 +164,45 @@ public function getConfigOrFail(string $key): mixed * @return $this */ public function configShallow(array|string $key, mixed $value = null) + { + $this->initCfg(); + $this->_configWrite($key, $value, 'shallow'); + + return $this; + } + + /** + * Deletes a config key. + * + * @param string $key Key to delete. It can be a dot separated string to delete nested keys. + * @return $this + */ + public function deleteConfig(string $key) + { + $this->initCfg(); + $this->_configDelete($key); + + return $this; + } + + /** + * Initializes the config with the default config. + * + * @return void + */ + private function initCfg(): void { if (!$this->_configInitialized) { $this->_config = $this->_defaultConfig; $this->_configInitialized = true; } - - $this->_configWrite($key, $value, 'shallow'); - - return $this; } /** * Reads a config key. * * @param string|null $key Key to read. - * @return mixed + * @return ($key is null ? array : mixed) */ protected function _configRead(?string $key): mixed { diff --git a/app/vendor/cakephp/cakephp/src/Core/ObjectRegistry.php b/app/vendor/cakephp/cakephp/src/Core/ObjectRegistry.php index 36296af5b..f5082314d 100644 --- a/app/vendor/cakephp/cakephp/src/Core/ObjectRegistry.php +++ b/app/vendor/cakephp/cakephp/src/Core/ObjectRegistry.php @@ -38,7 +38,6 @@ * * @see \Cake\Controller\ComponentRegistry * @see \Cake\View\HelperRegistry - * @see \Cake\Console\TaskRegistry * @template TObject of object * @template-implements \IteratorAggregate */ @@ -47,8 +46,7 @@ abstract class ObjectRegistry implements Countable, IteratorAggregate /** * Map of loaded objects. * - * @var array - * @phpstan-var array + * @var array */ protected array $_loaded = []; @@ -74,16 +72,14 @@ abstract class ObjectRegistry implements Countable, IteratorAggregate * * @param string $name The name/class of the object to load. * @param array $config Additional settings to use when loading the object. - * @return object - * @phpstan-return TObject + * @return TObject * @throws \Exception If the class cannot be found. */ public function load(string $name, array $config = []): object { - $plugin = null; if (isset($config['className'])) { if ($name === $config['className']) { - [$plugin, $objName] = pluginSplit($name); + [, $objName] = pluginSplit($name); } else { $objName = $name; } @@ -173,8 +169,7 @@ protected function _checkDuplicate(string $name, array $config): void * Should resolve the classname for a given object type. * * @param string $class The class to resolve. - * @return class-string|null The resolved name or null for failure. - * @phpstan-return class-string|null + * @return class-string|null The resolved name or null for failure. */ abstract protected function _resolveClassName(string $class): ?string; @@ -194,12 +189,10 @@ abstract protected function _throwMissingClassError(string $class, ?string $plug * This method should construct and do any other initialization logic * required. * - * @param object|string $class The class to build. + * @param TObject|class-string $class The class to build. * @param string $alias The alias of the object. * @param array $config The Configuration settings for construction - * @return object - * @phpstan-param TObject|class-string $class - * @phpstan-return TObject + * @return TObject */ abstract protected function _create(object|string $class, string $alias, array $config): object; @@ -217,7 +210,7 @@ public function loaded(): array * Check whether a given object is loaded. * * @param string $name The object name to check for. - * @return bool True is object is loaded else false. + * @return bool True if object is loaded else false. */ public function has(string $name): bool { @@ -228,9 +221,8 @@ public function has(string $name): bool * Get loaded object instance. * * @param string $name Name of object. - * @return object Object instance. + * @return TObject Object instance. * @throws \Cake\Core\Exception\CakeException If not loaded or found. - * @phpstan-return TObject */ public function get(string $name): object { @@ -245,8 +237,7 @@ public function get(string $name): object * Provide public read access to the loaded objects * * @param string $name Name of property to read - * @return object|null - * @phpstan-return TObject|null + * @return TObject|null */ public function __get(string $name): ?object { @@ -268,8 +259,7 @@ public function __isset(string $name): bool * Sets an object. * * @param string $name Name of a property to set. - * @param object $object Object to set. - * @phpstan-param TObject $object + * @param TObject $object Object to set. * @return void */ public function __set(string $name, object $object): void @@ -338,9 +328,8 @@ public function reset() * be attached into the event manager * * @param string $name The name of the object to set in the registry. - * @param object $object instance to store in the registry + * @param TObject $object instance to store in the registry * @return $this - * @phpstan-param TObject $object */ public function set(string $name, object $object) { @@ -382,8 +371,7 @@ public function unload(string $name) /** * Returns an array iterator. * - * @return \Traversable - * @phpstan-return \Traversable + * @return \Traversable */ public function getIterator(): Traversable { diff --git a/app/vendor/cakephp/cakephp/src/Core/PluginCollection.php b/app/vendor/cakephp/cakephp/src/Core/PluginCollection.php index e97024ad0..51dd526f9 100644 --- a/app/vendor/cakephp/cakephp/src/Core/PluginCollection.php +++ b/app/vendor/cakephp/cakephp/src/Core/PluginCollection.php @@ -44,7 +44,7 @@ class PluginCollection implements Iterator, Countable /** * Plugin list * - * @var array<\Cake\Core\PluginInterface> + * @var array */ protected array $plugins = []; @@ -101,6 +101,7 @@ public function addFromConfig(array $config): void $notDebug = !Configure::read('debug'); $notCli = PHP_SAPI !== 'cli'; + /** @var array{onlyDebug?: bool, onlyCli?: bool, optional?: bool} $options */ foreach (Hash::normalize($config, default: []) as $name => $options) { $onlyDebug = $options['onlyDebug'] ?? false; $onlyCli = $options['onlyCli'] ?? false; @@ -144,6 +145,7 @@ public function findPath(string $name): string // wipes out all configuration including plugin paths config. PluginConfig::loadInstallerConfig(); + /** @var string|null $path */ $path = Configure::read('plugins.' . $name); if ($path) { return $path; @@ -250,43 +252,56 @@ public function get(string $name): PluginInterface * @param array $config Configuration options for the plugin. * @return \Cake\Core\PluginInterface * @throws \Cake\Core\Exception\MissingPluginException When plugin instance could not be created. - * @throws \InvalidArgumentException When class name cannot be found. + * @throws \InvalidArgumentException When class name cannot be found or an empty name is provided. * @phpstan-param class-string<\Cake\Core\PluginInterface>|string $name */ public function create(string $name, array $config = []): PluginInterface { if ($name === '') { - throw new CakeException('Cannot create a plugin with empty name'); + throw new InvalidArgumentException('Plugin name cannot be empty.'); } if (str_contains($name, '\\')) { - if (!class_exists($name)) { - throw new InvalidArgumentException(sprintf('Class `%s` does not exist.', $name)); + if (!is_subclass_of($name, PluginInterface::class)) { + throw new InvalidArgumentException(sprintf( + 'Class `%s` does not exist or does not extend `Cake\Core\PluginInterface`.', + $name, + )); } - /** @var \Cake\Core\PluginInterface */ return new $name($config); } $config += ['name' => $name]; $namespace = str_replace('/', '\\', $name); - $className = $namespace . '\\' . 'Plugin'; - // Check for [Vendor/]Foo/Plugin class + $pos = strpos($name, '/'); + $namePart = $pos === false ? $name : substr($name, $pos + 1); + + // Check for [Vendor/]Foo/FooPlugin class + $className = $namespace . '\\' . $namePart . 'Plugin'; + if (!class_exists($className)) { - $pos = strpos($name, '/'); - if ($pos === false) { - $className = $namespace . '\\' . $name . 'Plugin'; + // Check for [Vendor/]Foo/Plugin class + $className = $namespace . '\\' . 'Plugin'; + + if (class_exists($className)) { + deprecationWarning( + '5.3.0', + 'Loading plugins with a plugin class named `Plugin` is deprecated.' + . " Rename the class to `{$namePart}Plugin` instead.", + ); } else { - $className = $namespace . '\\' . substr($name, $pos + 1) . 'Plugin'; - } - - // Check for [Vendor/]Foo/FooPlugin - if (!class_exists($className)) { $className = BasePlugin::class; if (empty($config['path'])) { $config['path'] = $this->findPath($name); } + + deprecationWarning( + '5.3.0', + 'Loading plugins without a plugin class is deprecated.' + . " You can create the missing class using `bin/cake bake plugin {$name} --class-only`.", + ); } } diff --git a/app/vendor/cakephp/cakephp/src/Core/PluginConfig.php b/app/vendor/cakephp/cakephp/src/Core/PluginConfig.php index db9fb8118..5d02c0a82 100644 --- a/app/vendor/cakephp/cakephp/src/Core/PluginConfig.php +++ b/app/vendor/cakephp/cakephp/src/Core/PluginConfig.php @@ -176,7 +176,7 @@ protected static function getPackageNameFromPath(string $path): string $json = json_decode($jsonString, true); if (json_last_error() !== JSON_ERROR_NONE) { throw new CakeException(sprintf( - 'Error parsing %ss: %s', + 'Error parsing %s: %s', $jsonPath, json_last_error_msg(), )); diff --git a/app/vendor/cakephp/cakephp/src/Core/PluginInterface.php b/app/vendor/cakephp/cakephp/src/Core/PluginInterface.php index 3f7c3f7d6..56c6a9266 100644 --- a/app/vendor/cakephp/cakephp/src/Core/PluginInterface.php +++ b/app/vendor/cakephp/cakephp/src/Core/PluginInterface.php @@ -20,6 +20,8 @@ /** * Plugin Interface + * + * @method \Cake\Event\EventManagerInterface events(\Cake\Event\EventManagerInterface $eventManager) */ interface PluginInterface { @@ -74,7 +76,7 @@ public function getTemplatePath(): string; * The host application is provided as an argument. This allows you to load additional * plugin dependencies, or attach events. * - * @param \Cake\Core\PluginApplicationInterface $app The host application + * @param \Cake\Core\PluginApplicationInterface $app The host application * @return void */ public function bootstrap(PluginApplicationInterface $app): void; diff --git a/app/vendor/cakephp/cakephp/src/Core/StaticConfigTrait.php b/app/vendor/cakephp/cakephp/src/Core/StaticConfigTrait.php index 12843c981..717a6cbfb 100644 --- a/app/vendor/cakephp/cakephp/src/Core/StaticConfigTrait.php +++ b/app/vendor/cakephp/cakephp/src/Core/StaticConfigTrait.php @@ -175,7 +175,7 @@ public static function configured(): array { $configurations = array_keys(static::$_config); - return array_map(function ($key) { + return array_map(function (int|string $key) { return (string)$key; }, $configurations); } diff --git a/app/vendor/cakephp/cakephp/src/Core/TestSuite/ContainerStubTrait.php b/app/vendor/cakephp/cakephp/src/Core/TestSuite/ContainerStubTrait.php index b59dc846a..b58f7a19b 100644 --- a/app/vendor/cakephp/cakephp/src/Core/TestSuite/ContainerStubTrait.php +++ b/app/vendor/cakephp/cakephp/src/Core/TestSuite/ContainerStubTrait.php @@ -19,6 +19,8 @@ use Cake\Core\ConsoleApplicationInterface; use Cake\Core\ContainerInterface; use Cake\Core\HttpApplicationInterface; +use Cake\Core\PluginApplicationInterface; +use Cake\Event\EventDispatcherInterface; use Cake\Event\EventInterface; use Cake\Routing\Router; use Closure; @@ -39,8 +41,7 @@ trait ContainerStubTrait /** * The customized application class name. * - * @phpstan-var class-string<\Cake\Core\HttpApplicationInterface>|class-string<\Cake\Core\ConsoleApplicationInterface>|null - * @var string|null + * @var class-string<\Cake\Core\HttpApplicationInterface>|class-string<\Cake\Core\ConsoleApplicationInterface>|null */ protected ?string $_appClass = null; @@ -61,10 +62,9 @@ trait ContainerStubTrait /** * Configure the application class to use in integration tests. * - * @param string $class The application class name. + * @param class-string<\Cake\Core\HttpApplicationInterface>|class-string<\Cake\Core\ConsoleApplicationInterface> $class The application class name. * @param array|null $constructorArgs The constructor arguments for your application class. * @return void - * @phpstan-param class-string<\Cake\Core\HttpApplicationInterface>|class-string<\Cake\Core\ConsoleApplicationInterface> $class */ public function configApplication(string $class, ?array $constructorArgs): void { @@ -88,7 +88,7 @@ protected function createApp(): HttpApplicationInterface|ConsoleApplicationInter if ($this->_appClass) { $appClass = $this->_appClass; } else { - /** @var class-string<\Cake\Http\BaseApplication> $appClass */ + /** @var class-string<\Cake\Core\HttpApplicationInterface>|class-string<\Cake\Core\ConsoleApplicationInterface> $appClass */ $appClass = Configure::read('App.namespace') . '\Application'; } if (!class_exists($appClass)) { @@ -97,15 +97,17 @@ protected function createApp(): HttpApplicationInterface|ConsoleApplicationInter $appArgs = $this->_appArgs ?: [CONFIG]; $app = new $appClass(...$appArgs); - if ($this->containerServices && method_exists($app, 'getEventManager')) { + if ($this->containerServices && $app instanceof EventDispatcherInterface) { $app->getEventManager()->on('Application.buildContainer', [$this, 'modifyContainer']); } - foreach ($this->appPluginsToLoad as $pluginName => $config) { - if (is_array($config)) { - $app->addPlugin($pluginName, $config); - } else { - $app->addPlugin($config); + if ($app instanceof PluginApplicationInterface) { + foreach ($this->appPluginsToLoad as $pluginName => $config) { + if (is_array($config)) { + $app->addPlugin($pluginName, $config); + } else { + $app->addPlugin($config); + } } } diff --git a/app/vendor/cakephp/cakephp/src/Core/composer.json b/app/vendor/cakephp/cakephp/src/Core/composer.json index 55812cf18..68607d314 100644 --- a/app/vendor/cakephp/cakephp/src/Core/composer.json +++ b/app/vendor/cakephp/cakephp/src/Core/composer.json @@ -22,9 +22,9 @@ "source": "https://github.com/cakephp/core" }, "require": { - "php": ">=8.1", - "cakephp/utility": "5.2.*@dev", - "league/container": "^4.2", + "php": ">=8.2", + "cakephp/utility": "^5.3.0", + "league/container": "^5.1", "psr/container": "^1.1 || ^2.0" }, "autoload": { @@ -43,10 +43,11 @@ "cakephp/cache": "To use Configure::store() and restore().", "league/container": "To use Container and ServiceProvider classes" }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Core/functions.php b/app/vendor/cakephp/cakephp/src/Core/functions.php index fd9e99866..9285ac0bf 100644 --- a/app/vendor/cakephp/cakephp/src/Core/functions.php +++ b/app/vendor/cakephp/cakephp/src/Core/functions.php @@ -146,7 +146,7 @@ function h(mixed $text, bool $double = true, ?string $charset = null): mixed * @param bool $dotAppend Set to true if you want the plugin to have a '.' appended to it. * @param string|null $plugin Optional default plugin to use if no plugin is found. Defaults to null. * @return array Array with 2 indexes. 0 => plugin name, 1 => class name. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#pluginSplit + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#pluginsplit * @phpstan-return array{string|null, string} */ function pluginSplit(string $name, bool $dotAppend = false, ?string $plugin = null): array @@ -527,10 +527,10 @@ function toFloat(mixed $value): ?float */ function toBool(mixed $value): ?bool { - if ($value === '1' || $value === 1 || $value === 1.0 || $value === true) { + if (in_array($value, ['1', 1, 1.0, true], true)) { return true; } - if ($value === '0' || $value === 0 || $value === 0.0 || $value === false) { + if (in_array($value, ['0', 0, 0.0, false], true)) { return false; } diff --git a/app/vendor/cakephp/cakephp/src/Core/functions_global.php b/app/vendor/cakephp/cakephp/src/Core/functions_global.php index 022593cbd..6b466565b 100644 --- a/app/vendor/cakephp/cakephp/src/Core/functions_global.php +++ b/app/vendor/cakephp/cakephp/src/Core/functions_global.php @@ -83,7 +83,7 @@ function h(mixed $text, bool $double = true, ?string $charset = null): mixed * @param bool $dotAppend Set to true if you want the plugin to have a '.' appended to it. * @param string|null $plugin Optional default plugin to use if no plugin is found. Defaults to null. * @return array Array with 2 indexes. 0 => plugin name, 1 => class name. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#pluginSplit + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#pluginsplit * @phpstan-return array{string|null, string} */ function pluginSplit(string $name, bool $dotAppend = false, ?string $plugin = null): array diff --git a/app/vendor/cakephp/cakephp/src/Database/Connection.php b/app/vendor/cakephp/cakephp/src/Database/Connection.php index 4f91a1aad..119dfb9b6 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Connection.php +++ b/app/vendor/cakephp/cakephp/src/Database/Connection.php @@ -120,6 +120,8 @@ class Connection implements ConnectionInterface * - `cacheKeyPrefix` Custom prefix to use when generation cache keys. Defaults to connection name. * * @param array $config Configuration array. + * @throws \Cake\Database\Exception\MissingDriverException when the driver class cannot be found + * @throws \Cake\Database\Exception\MissingExtensionException when the database extension is not enabled */ public function __construct(array $config) { @@ -154,7 +156,6 @@ protected function createDrivers(array $config): array } $sharedConfig = array_diff_key($config, array_flip([ - 'name', 'className', 'driver', 'cacheMetaData', @@ -242,7 +243,7 @@ public function getDisconnectRetry(): CommandRetry } /** - * Gets the driver instance. + * Gets the role-specific driver instance. * * @param string $role Connection role ('read' or 'write') * @return \Cake\Database\Driver @@ -251,7 +252,27 @@ public function getDriver(string $role = self::ROLE_WRITE): Driver { assert($role === self::ROLE_READ || $role === self::ROLE_WRITE); - return $role === self::ROLE_READ ? $this->readDriver : $this->writeDriver; + return $role === self::ROLE_READ ? $this->getReadDriver() : $this->getWriteDriver(); + } + + /** + * Gets the read-role driver instance. + * + * @return \Cake\Database\Driver + */ + public function getReadDriver(): Driver + { + return $this->readDriver; + } + + /** + * Gets the write-role driver instance. + * + * @return \Cake\Database\Driver + */ + public function getWriteDriver(): Driver + { + return $this->writeDriver; } /** @@ -265,7 +286,7 @@ public function getDriver(string $role = self::ROLE_WRITE): Driver */ public function execute(string $sql, array $params = [], array $types = []): StatementInterface { - return $this->getDisconnectRetry()->run(fn() => $this->getDriver()->execute($sql, $params, $types)); + return $this->getDisconnectRetry()->run(fn() => $this->getWriteDriver()->execute($sql, $params, $types)); } /** @@ -434,7 +455,7 @@ public function begin(): void { if (!$this->_transactionStarted) { $this->getDisconnectRetry()->run(function (): void { - $this->getDriver()->beginTransaction(); + $this->getWriteDriver()->beginTransaction(); }); $this->_transactionLevel = 0; @@ -454,6 +475,7 @@ public function begin(): void * Commits current transaction. * * @return bool true on success, false otherwise + * @throws \Cake\Database\Exception\NestedTransactionRollbackException when a nested transaction was rolled back */ public function commit(): bool { @@ -472,7 +494,7 @@ public function commit(): bool $this->_transactionStarted = false; $this->nestedTransactionRollbackException = null; - return $this->getDriver()->commitTransaction(); + return $this->getWriteDriver()->commitTransaction(); } if ($this->isSavePointsEnabled()) { $this->releaseSavePoint((string)$this->_transactionLevel); @@ -502,7 +524,7 @@ public function rollback(?bool $toBeginning = null): bool $this->_transactionLevel = 0; $this->_transactionStarted = false; $this->nestedTransactionRollbackException = null; - $this->getDriver()->rollbackTransaction(); + $this->getWriteDriver()->rollbackTransaction(); return true; } @@ -518,7 +540,7 @@ public function rollback(?bool $toBeginning = null): bool } /** - * Enables/disables the usage of savepoints, enables only if driver the allows it. + * Enables/disables the usage of savepoints, enables only if the driver allows it. * * If you are trying to enable this feature, make sure you check * `isSavePointsEnabled()` to verify that savepoints were enabled successfully. @@ -531,7 +553,7 @@ public function enableSavePoints(bool $enable = true) if ($enable === false) { $this->_useSavePoints = false; } else { - $this->_useSavePoints = $this->getDriver()->supports(DriverFeatureEnum::SAVEPOINT); + $this->_useSavePoints = $this->getWriteDriver()->supports(DriverFeatureEnum::SAVEPOINT); } return $this; @@ -567,7 +589,7 @@ public function isSavePointsEnabled(): bool */ public function createSavePoint(string|int $name): void { - $this->execute($this->getDriver()->savePointSQL($name)); + $this->execute($this->getWriteDriver()->savePointSQL($name)); } /** @@ -578,7 +600,7 @@ public function createSavePoint(string|int $name): void */ public function releaseSavePoint(string|int $name): void { - $sql = $this->getDriver()->releaseSavePointSQL($name); + $sql = $this->getWriteDriver()->releaseSavePointSQL($name); if ($sql) { $this->execute($sql); } @@ -592,7 +614,7 @@ public function releaseSavePoint(string|int $name): void */ public function rollbackSavepoint(string|int $name): void { - $this->execute($this->getDriver()->rollbackSavePointSQL($name)); + $this->execute($this->getWriteDriver()->rollbackSavePointSQL($name)); } /** @@ -603,7 +625,7 @@ public function rollbackSavepoint(string|int $name): void public function disableForeignKeys(): void { $this->getDisconnectRetry()->run(function (): void { - $this->execute($this->getDriver()->disableForeignKeySQL()); + $this->execute($this->getWriteDriver()->disableForeignKeySQL()); }); } @@ -615,7 +637,7 @@ public function disableForeignKeys(): void public function enableForeignKeys(): void { $this->getDisconnectRetry()->run(function (): void { - $this->execute($this->getDriver()->enableForeignKeySQL()); + $this->execute($this->getWriteDriver()->enableForeignKeySQL()); }); } diff --git a/app/vendor/cakephp/cakephp/src/Database/Driver.php b/app/vendor/cakephp/cakephp/src/Database/Driver.php index 98d76ab16..552136c21 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Driver.php +++ b/app/vendor/cakephp/cakephp/src/Database/Driver.php @@ -261,14 +261,20 @@ protected function getPdo(): PDO * Execute the SQL query using the internal PDO instance. * * @param string $sql SQL query. - * @return int|false + * @return int|false Number of affected rows or false on failure + * @throws \Cake\Database\Exception\QueryException On database error */ public function exec(string $sql): int|false { try { return $this->getPdo()->exec($sql); } catch (PDOException $e) { - throw new QueryException($sql, $e); + $loggedQuery = new LoggedQuery(); + $loggedQuery->setContext([ + 'query' => $sql, + 'driver' => $this, + ]); + throw new QueryException($loggedQuery, $e); } } diff --git a/app/vendor/cakephp/cakephp/src/Database/Driver/Mysql.php b/app/vendor/cakephp/cakephp/src/Database/Driver/Mysql.php index 9f85d35d8..a43e478e8 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Driver/Mysql.php +++ b/app/vendor/cakephp/cakephp/src/Database/Driver/Mysql.php @@ -24,6 +24,7 @@ use Cake\Database\Schema\SchemaDialect; use Cake\Database\StatementInterface; use PDO; +use Pdo\Mysql as PdoMysql; /** * MySQL Driver @@ -103,6 +104,7 @@ class Mysql extends Driver 'window' => '8.0.0', 'intersect' => '8.0.31', 'intersect-all' => '8.0.31', + 'check-constraints' => '8.0.16', ], 'mariadb' => [ 'json' => '10.2.7', @@ -110,6 +112,7 @@ class Mysql extends Driver 'window' => '10.2.0', 'intersect' => '10.3.0', 'intersect-all' => '10.5.0', + 'check-constraints' => '10.2.1', ], ]; @@ -133,16 +136,16 @@ public function connect(): void $config['flags'] += [ PDO::ATTR_PERSISTENT => $config['persistent'], - PDO::MYSQL_ATTR_USE_BUFFERED_QUERY => true, + $this->attrUseBufferedQueryId() => true, PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION, ]; if (!empty($config['ssl_key']) && !empty($config['ssl_cert'])) { - $config['flags'][PDO::MYSQL_ATTR_SSL_KEY] = $config['ssl_key']; - $config['flags'][PDO::MYSQL_ATTR_SSL_CERT] = $config['ssl_cert']; + $config['flags'][$this->attrSslKeyId()] = $config['ssl_key']; + $config['flags'][$this->attrSslCertId()] = $config['ssl_cert']; } if (!empty($config['ssl_ca'])) { - $config['flags'][PDO::MYSQL_ATTR_SSL_CA] = $config['ssl_ca']; + $config['flags'][$this->attrSslCaId()] = $config['ssl_ca']; } if (empty($config['unix_socket'])) { @@ -174,10 +177,10 @@ public function run(Query $query): StatementInterface if ($query instanceof SelectQuery) { try { - $this->getPdo()->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, $query->isBufferedResultsEnabled()); + $this->getPdo()->setAttribute($this->attrUseBufferedQueryId(), $query->isBufferedResultsEnabled()); $this->executeStatement($statement); } finally { - $this->getPdo()->setAttribute(PDO::MYSQL_ATTR_USE_BUFFERED_QUERY, true); + $this->getPdo()->setAttribute($this->attrUseBufferedQueryId(), true); } } else { $this->executeStatement($statement); @@ -254,7 +257,9 @@ public function supports(DriverFeatureEnum $feature): bool DriverFeatureEnum::WINDOW => $versionCompare(), DriverFeatureEnum::INTERSECT => $versionCompare(), DriverFeatureEnum::INTERSECT_ALL => $versionCompare(), + DriverFeatureEnum::CHECK_CONSTRAINTS => $versionCompare(), DriverFeatureEnum::SET_OPERATIONS_ORDER_BY => true, + DriverFeatureEnum::OPTIMIZER_HINT_COMMENT => true, }; } @@ -280,13 +285,52 @@ public function version(): string if ($this->_version === null) { $this->_version = (string)$this->getPdo()->getAttribute(PDO::ATTR_SERVER_VERSION); - if (str_contains($this->_version, 'MariaDB')) { + if (preg_match('/^(?:5\.5\.5-)?(\d+\.\d+\.\d+.*-MariaDB[^:]*)/', $this->_version, $matches)) { $this->serverType = static::SERVER_TYPE_MARIADB; - preg_match('/^(?:5\.5\.5-)?(\d+\.\d+\.\d+.*-MariaDB[^:]*)/', $this->_version, $matches); $this->_version = $matches[1]; } } return $this->_version; } + + /** + * Get PDO ATTR_SSL_KEY id. + * + * @return int + */ + private function attrSslKeyId(): int + { + return PHP_VERSION_ID < 80400 ? PDO::MYSQL_ATTR_SSL_KEY : PdoMysql::ATTR_SSL_KEY; + } + + /** + * Get PDO ATTR_SSL_CERT id. + * + * @return int + */ + private function attrSslCertId(): int + { + return PHP_VERSION_ID < 80400 ? PDO::MYSQL_ATTR_SSL_CERT : PdoMysql::ATTR_SSL_CERT; + } + + /** + * Get PDO ATTR_SSL_CA id. + * + * @return int + */ + private function attrSslCaId(): int + { + return PHP_VERSION_ID < 80400 ? PDO::MYSQL_ATTR_SSL_CA : PdoMysql::ATTR_SSL_CA; + } + + /** + * Get PDO ATTR_USE_BUFFERED_QUERY id. + * + * @return int + */ + private function attrUseBufferedQueryId(): int + { + return PHP_VERSION_ID < 80400 ? PDO::MYSQL_ATTR_USE_BUFFERED_QUERY : PdoMysql::ATTR_USE_BUFFERED_QUERY; + } } diff --git a/app/vendor/cakephp/cakephp/src/Database/Driver/Postgres.php b/app/vendor/cakephp/cakephp/src/Database/Driver/Postgres.php index 678a43bda..78574daea 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Driver/Postgres.php +++ b/app/vendor/cakephp/cakephp/src/Database/Driver/Postgres.php @@ -210,6 +210,8 @@ public function supports(DriverFeatureEnum $feature): bool DriverFeatureEnum::INTERSECT_ALL => true, DriverFeatureEnum::SET_OPERATIONS_ORDER_BY => true, DriverFeatureEnum::DISABLE_CONSTRAINT_WITHOUT_TRANSACTION => false, + DriverFeatureEnum::OPTIMIZER_HINT_COMMENT => true, + DriverFeatureEnum::CHECK_CONSTRAINTS => true, }; } @@ -246,7 +248,7 @@ protected function _expressionTranslators(): array } /** - * Changes identifer expression into postgresql format. + * Changes identifier expression into postgresql format. * * @param \Cake\Database\Expression\IdentifierExpression $expression The expression to transform. * @return void diff --git a/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlite.php b/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlite.php index 286a5b3c1..2635dfb13 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlite.php +++ b/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlite.php @@ -207,6 +207,8 @@ public function supports(DriverFeatureEnum $feature): bool DriverFeatureEnum::INTERSECT => true, DriverFeatureEnum::INTERSECT_ALL => false, DriverFeatureEnum::SET_OPERATIONS_ORDER_BY => false, + DriverFeatureEnum::OPTIMIZER_HINT_COMMENT => false, + DriverFeatureEnum::CHECK_CONSTRAINTS => true, }; } diff --git a/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlserver.php b/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlserver.php index 6d579ce1f..b9d0fb77f 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlserver.php +++ b/app/vendor/cakephp/cakephp/src/Database/Driver/Sqlserver.php @@ -83,6 +83,8 @@ class Sqlserver extends Driver 'multiSubnetFailover' => null, 'encrypt' => null, 'trustServerCertificate' => null, + 'accessToken' => null, + 'authentication' => null, ]; /** @@ -158,6 +160,12 @@ public function connect(): void if ($config['trustServerCertificate'] !== null) { $dsn .= ";TrustServerCertificate={$config['trustServerCertificate']}"; } + if ($config['accessToken'] !== null) { + $dsn .= ";AccessToken={$config['accessToken']}"; + } + if ($config['authentication'] !== null) { + $dsn .= ";Authentication={$config['authentication']}"; + } $this->pdo = $this->createPdo($dsn, $config); if (!empty($config['init'])) { @@ -280,6 +288,8 @@ public function supports(DriverFeatureEnum $feature): bool DriverFeatureEnum::INTERSECT_ALL => false, DriverFeatureEnum::JSON => false, DriverFeatureEnum::SET_OPERATIONS_ORDER_BY => false, + DriverFeatureEnum::OPTIMIZER_HINT_COMMENT => false, + DriverFeatureEnum::CHECK_CONSTRAINTS => false, }; } @@ -314,7 +324,7 @@ protected function _selectQueryTranslator(SelectQuery $query): SelectQuery } if ($offset !== null && !$query->clause('order')) { - $query->orderBy($query->newExpr()->add('(SELECT NULL)')); + $query->orderBy($query->expr()->add('(SELECT NULL)')); } if ($this->version() < 11 && $offset !== null) { @@ -417,9 +427,9 @@ protected function _transformDistinct(SelectQuery $query): SelectQuery $order = new OrderByExpression($distinct); $query ->select(function (Query $q) use ($distinct, $order) { - $over = $q->newExpr('ROW_NUMBER() OVER') + $over = $q->expr('ROW_NUMBER() OVER') ->add('(PARTITION BY') - ->add($q->newExpr()->add($distinct)->setConjunction(',')) + ->add($q->expr()->add($distinct)->setConjunction(',')) ->add($order) ->add(')') ->setConjunction(' '); diff --git a/app/vendor/cakephp/cakephp/src/Database/Driver/TupleComparisonTranslatorTrait.php b/app/vendor/cakephp/cakephp/src/Database/Driver/TupleComparisonTranslatorTrait.php index ee0bd192a..be091ece2 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Driver/TupleComparisonTranslatorTrait.php +++ b/app/vendor/cakephp/cakephp/src/Database/Driver/TupleComparisonTranslatorTrait.php @@ -58,7 +58,7 @@ protected function _transformTupleComparison(TupleComparison $expression, Query } $operator = strtoupper($expression->getOperator()); - if (!in_array($operator, ['IN', '='])) { + if (!in_array($operator, ['IN', '='], true)) { throw new InvalidArgumentException( sprintf( 'Tuple comparison transform only supports the `IN` and `=` operators, `%s` given.', diff --git a/app/vendor/cakephp/cakephp/src/Database/DriverFeatureEnum.php b/app/vendor/cakephp/cakephp/src/Database/DriverFeatureEnum.php index 9d3723253..15219158c 100644 --- a/app/vendor/cakephp/cakephp/src/Database/DriverFeatureEnum.php +++ b/app/vendor/cakephp/cakephp/src/Database/DriverFeatureEnum.php @@ -62,4 +62,14 @@ enum DriverFeatureEnum: string * Support for order by in set operations (union, intersect) */ case SET_OPERATIONS_ORDER_BY = 'set-operations-order-by'; + + /** + * Support for optimizer hints in comment form after statement keyword (SELECT , etc) + */ + case OPTIMIZER_HINT_COMMENT = 'optimizer-hint-comment'; + + /** + * Support for CHECK constraints. + */ + case CHECK_CONSTRAINTS = 'check-constraints'; } diff --git a/app/vendor/cakephp/cakephp/src/Database/Exception/QueryException.php b/app/vendor/cakephp/cakephp/src/Database/Exception/QueryException.php index c014ffd1a..2ece743c4 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Exception/QueryException.php +++ b/app/vendor/cakephp/cakephp/src/Database/Exception/QueryException.php @@ -29,11 +29,33 @@ class QueryException extends PDOException */ public function __construct(protected LoggedQuery|string $query, PDOException $previous) { - $message = $previous->getMessage() . "\nQuery: " . $this->getQueryString(); + $message = $previous->getMessage(); + + // Prefix with connection name if available + $connectionName = $this->getConnectionName(); + if ($connectionName !== '') { + $message = "[{$connectionName}] " . $message; + } + + $message .= "\nQuery: " . $this->getQueryString(); parent::__construct($message, (int)$previous->getCode(), $previous); } + /** + * Get the connection name that caused this exception. + * + * @return string + */ + public function getConnectionName(): string + { + if ($this->query instanceof LoggedQuery) { + return $this->query->getConnectionName(); + } + + return ''; + } + /** * Get the query string that caused this exception. * diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/AggregateExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/AggregateExpression.php index 016147acc..582229d20 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/AggregateExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/AggregateExpression.php @@ -249,8 +249,6 @@ public function count(): int /** * Clone this object and its subtree of expressions. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/BetweenExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/BetweenExpression.php index e6443bbd3..253fc12be 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/BetweenExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/BetweenExpression.php @@ -130,8 +130,6 @@ protected function _bindValue(mixed $value, ValueBinder $binder, ?string $type): /** * Do a deep clone of this expression. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/CaseStatementExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/CaseStatementExpression.php index c68ccb01c..bf657b809 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/CaseStatementExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/CaseStatementExpression.php @@ -270,9 +270,9 @@ public function __construct(mixed $value = null, ?string $type = null) * ``` * $query * ->select([ - * 'val' => $query->newExpr() + * 'val' => $query->expr() * ->case() - * ->when($query->newExpr(':userData')) + * ->when($query->expr(':userData')) * ->then(123) * ]) * ->bind(':userData', $userData, 'integer') @@ -570,8 +570,6 @@ public function traverse(Closure $callback) /** * Clones the inner expression objects. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/CommonTableExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/CommonTableExpression.php index 86eeaab0b..bc63b312b 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/CommonTableExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/CommonTableExpression.php @@ -223,8 +223,6 @@ public function traverse(Closure $callback) /** * Clones the inner expression objects. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/ComparisonExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/ComparisonExpression.php index c57b1de5d..e3da2dfef 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/ComparisonExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/ComparisonExpression.php @@ -190,8 +190,6 @@ public function traverse(Closure $callback) * Create a deep clone. * * Clones the field and value if they are expression objects. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/OrderClauseExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/OrderClauseExpression.php index 8f5a7574c..280548eee 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/OrderClauseExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/OrderClauseExpression.php @@ -78,8 +78,6 @@ public function traverse(Closure $callback) /** * Create a deep clone of the order clause. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/QueryExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/QueryExpression.php index 2e4ef9c80..1140e623b 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/QueryExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/QueryExpression.php @@ -631,7 +631,7 @@ protected function _addConditions(array $conditions, array $types): void $isNot = false; if (!$numericKey) { $normalizedKey = strtolower($k); - $isOperator = in_array($normalizedKey, $operators); + $isOperator = in_array($normalizedKey, $operators, true); $isNot = $normalizedKey === 'not'; } @@ -697,7 +697,7 @@ protected function _parseCondition(string $condition, mixed $value): ExpressionI } $operator = array_pop($parts); $expression = implode(' ', $parts); - } elseif ($spaces == 1) { + } elseif ($spaces === 1) { $parts = explode(' ', $expression, 2); [$expression, $operator] = $parts; } @@ -705,7 +705,7 @@ protected function _parseCondition(string $condition, mixed $value): ExpressionI $type = $this->getTypeMap()->type($expression); $typeMultiple = (is_string($type) && str_contains($type, '[]')); - if (in_array($operator, ['IN', 'NOT IN']) || $typeMultiple) { + if (in_array($operator, ['IN', 'NOT IN'], true) || $typeMultiple) { $type = $type ?: 'string'; if (!$typeMultiple) { $type .= '[]'; @@ -774,8 +774,6 @@ protected function _calculateType(ExpressionInterface|string $field): ?string /** * Clone this object and its subtree of expressions. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/TupleComparison.php b/app/vendor/cakephp/cakephp/src/Database/Expression/TupleComparison.php index 39bbc0671..8859b282e 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/TupleComparison.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/TupleComparison.php @@ -226,6 +226,6 @@ protected function _traverseValue(mixed $value, Closure $callback): void */ public function isMulti(): bool { - return in_array(strtolower($this->_operator), ['in', 'not in']); + return in_array(strtolower($this->_operator), ['in', 'not in'], true); } } diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/UnaryExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/UnaryExpression.php index fdf1cff20..9675b3138 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/UnaryExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/UnaryExpression.php @@ -106,8 +106,6 @@ public function traverse(Closure $callback) /** * Perform a deep clone of the inner expression. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/WhenThenExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/WhenThenExpression.php index 4cfc3f136..cc6d51f88 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/WhenThenExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/WhenThenExpression.php @@ -304,8 +304,6 @@ public function traverse(Closure $callback) /** * Clones the inner expression objects. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Expression/WindowExpression.php b/app/vendor/cakephp/cakephp/src/Database/Expression/WindowExpression.php index f0f46ebe7..327afb22f 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Expression/WindowExpression.php +++ b/app/vendor/cakephp/cakephp/src/Database/Expression/WindowExpression.php @@ -334,8 +334,6 @@ protected function buildOffsetSql( /** * Clone this object and its subtree of expressions. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/IdentifierQuoter.php b/app/vendor/cakephp/cakephp/src/Database/IdentifierQuoter.php index f6efb2517..0b2f5262e 100644 --- a/app/vendor/cakephp/cakephp/src/Database/IdentifierQuoter.php +++ b/app/vendor/cakephp/cakephp/src/Database/IdentifierQuoter.php @@ -150,7 +150,7 @@ public function quoteExpression(ExpressionInterface $expression): void * Quotes all identifiers in each of the clauses/parts of a query * * @param \Cake\Database\Query $query The query to quote. - * @param array $parts Query clauses. + * @param array $parts Query clauses. * @return void */ protected function _quoteParts(Query $query, array $parts): void @@ -185,7 +185,7 @@ protected function _basicQuoter(array $part): array { $result = []; foreach ($part as $alias => $value) { - $value = !is_string($value) ? $value : $this->quoteIdentifier($value); + $value = is_string($value) ? $this->quoteIdentifier($value) : $value; $alias = is_numeric($alias) ? $alias : $this->quoteIdentifier($alias); $result[$alias] = $value; } @@ -197,7 +197,7 @@ protected function _basicQuoter(array $part): array * Quotes both the table and alias for an array of joins as stored in a Query * object * - * @param array $joins The joins to quote. + * @param array $joins The joins to quote. * @return array */ protected function _quoteJoins(array $joins): array @@ -262,6 +262,7 @@ protected function _quoteDelete(DeleteQuery $query): void */ protected function _quoteInsert(InsertQuery $query): void { + /** @var array{0?: string, 1?: array} $insert */ $insert = $query->clause('insert'); if (!isset($insert[0]) || !isset($insert[1])) { return; diff --git a/app/vendor/cakephp/cakephp/src/Database/Log/LoggedQuery.php b/app/vendor/cakephp/cakephp/src/Database/Log/LoggedQuery.php index 4617136df..a18a7d600 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Log/LoggedQuery.php +++ b/app/vendor/cakephp/cakephp/src/Database/Log/LoggedQuery.php @@ -130,18 +130,39 @@ protected function interpolate(): string */ public function getContext(): array { - return [ + $context = [ 'query' => $this->query, 'numRows' => $this->numRows, 'took' => $this->took, 'role' => $this->driver ? $this->driver->getRole() : '', ]; + + $connectionName = $this->getConnectionName(); + if ($connectionName !== '') { + $context['connection'] = $connectionName; + } + + return $context; + } + + /** + * Get the connection name from the driver config. + * + * @return string + */ + public function getConnectionName(): string + { + if ($this->driver === null) { + return ''; + } + + return $this->driver->config()['name'] ?? ''; } /** * Set logging context for this query. * - * @param array $context Context data. + * @param array $context Context data. * @return void */ public function setContext(array $context): void diff --git a/app/vendor/cakephp/cakephp/src/Database/Query.php b/app/vendor/cakephp/cakephp/src/Database/Query.php index d63904974..359907ce8 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Query.php +++ b/app/vendor/cakephp/cakephp/src/Database/Query.php @@ -107,6 +107,7 @@ abstract class Query implements ExpressionInterface, Stringable 'insert' => [], 'values' => [], 'with' => [], + 'optimizerHint' => [], 'select' => [], 'distinct' => false, 'modifier' => [], @@ -198,6 +199,19 @@ public function getConnectionRole(): string return $this->connectionRole; } + /** + * Returns driver for current connection role by default. + * + * See `Query::getConnectionRole()` for role options. + * + * @param string|null $role Connection role + * @return \Cake\Database\Driver + */ + public function getDriver(?string $role = null): Driver + { + return $this->_connection->getDriver($role ?? $this->connectionRole); + } + /** * Compiles the SQL representation of this query and executes it using the * configured connection object. Returns the resulting statement object. @@ -283,7 +297,7 @@ public function sql(?ValueBinder $binder = null): string $binder->resetCount(); } - return $this->getConnection()->getDriver()->compileQuery($this, $binder); + return $this->getDriver()->compileQuery($this, $binder); } /** @@ -329,7 +343,7 @@ public function traverse(Closure $callback) * ### Example * * ``` - * $query->select(['title'])->from('articles')->traverse(function ($value, $clause) { + * $query->select(['title'])->from('articles')->traverseParts(function ($value, $clause) { * if ($clause === 'select') { * var_dump($value); * } @@ -387,27 +401,45 @@ public function traverseParts(Closure $visitor, array $parts) * }); * ``` * - * @param \Cake\Database\Expression\CommonTableExpression|\Closure $cte The CTE to add. + * @param \Cake\Database\Expression\CommonTableExpression|\Closure|array<\Cake\Database\Expression\CommonTableExpression|\Closure> $cte The CTE to add. * @param bool $overwrite Whether to reset the list of CTEs. * @return $this */ - public function with(CommonTableExpression|Closure $cte, bool $overwrite = false) + public function with(CommonTableExpression|Closure|array $cte, bool $overwrite = false) { + $this->_dirty(); if ($overwrite) { $this->_parts['with'] = []; } - if ($cte instanceof Closure) { - $query = $this->getConnection()->selectQuery(); - $cte = $cte(new CommonTableExpression(), $query); - if (!($cte instanceof CommonTableExpression)) { - throw new CakeException( - 'You must return a `CommonTableExpression` from a Closure passed to `with()`.', - ); + $ctes = is_array($cte) ? $cte : [$cte]; + foreach ($ctes as $cte) { + if ($cte instanceof Closure) { + $query = $this->getConnection()->selectQuery(); + $cte = $cte(new CommonTableExpression(), $query); + if (!($cte instanceof CommonTableExpression)) { + throw new CakeException( + 'You must return a `CommonTableExpression` from a Closure passed to `with()`.', + ); + } } + $this->_parts['with'][] = $cte; } - $this->_parts['with'][] = $cte; + return $this; + } + + /** + * Add engine-specific optimizer hint. + * + * @param array|string $hint Optimizer hint + * @param bool $overwrite Whether to replace existing hints + * @return $this + */ + public function optimizerHint(array|string $hint, bool $overwrite = false) + { + $hints = array_values((array)$hint); + $this->_parts['optimizerHint'] = $overwrite ? $hints : array_merge($this->_parts['optimizerHint'], $hints); $this->_dirty(); return $this; @@ -589,15 +621,15 @@ public function join(array|string $tables, array $types = [], bool $overwrite = $i = count($this->_parts['join']); foreach ($tables as $alias => $t) { if (!is_array($t)) { - $t = ['table' => $t, 'conditions' => $this->newExpr()]; + $t = ['table' => $t, 'conditions' => $this->expr()]; } if ($t['conditions'] instanceof Closure) { - $t['conditions'] = $t['conditions']($this->newExpr(), $this); + $t['conditions'] = $t['conditions']($this->expr(), $this); } if (!($t['conditions'] instanceof ExpressionInterface)) { - $t['conditions'] = $this->newExpr()->add($t['conditions'], $types); + $t['conditions'] = $this->expr()->add($t['conditions'], $types); } $alias = is_string($alias) ? $alias : null; $joins[$alias ?: $i++] = $t + ['type' => static::JOIN_TYPE_INNER, 'alias' => $alias]; @@ -661,7 +693,7 @@ public function removeJoin(string $name) * * See `join()` for further details on conditions and types. * - * @param array|string $table The table to join with + * @param array>|string $table The table to join with * @param \Cake\Database\ExpressionInterface|\Closure|array|string $conditions The conditions * to use for joining. * @param array $types a list of types associated to the conditions used for converting @@ -686,7 +718,7 @@ public function leftJoin( * The arguments of this method are identical to the `leftJoin()` shorthand, please refer * to that methods description for further details. * - * @param array|string $table The table to join with + * @param array>|string $table The table to join with * @param \Cake\Database\ExpressionInterface|\Closure|array|string $conditions The conditions * to use for joining. * @param array $types a list of types associated to the conditions used for converting @@ -711,7 +743,7 @@ public function rightJoin( * The arguments of this method are identical to the `leftJoin()` shorthand, please refer * to that method's description for further details. * - * @param array|string $table The table to join with + * @param array>|string $table The table to join with * @param \Cake\Database\ExpressionInterface|\Closure|array|string $conditions The conditions * to use for joining. * @param array $types a list of types associated to the conditions used for converting @@ -731,11 +763,11 @@ public function innerJoin( /** * Returns an array that can be passed to the join method describing a single join clause * - * @param array|string $table The table to join with + * @param array>|string $table The table to join with * @param \Cake\Database\ExpressionInterface|\Closure|array|string $conditions The conditions * to use for joining. * @param string $type the join type to use - * @return array + * @return array, conditions: \Cake\Database\ExpressionInterface|\Closure|array|string, type: string}> */ protected function _makeJoin( array|string $table, @@ -823,7 +855,7 @@ protected function _makeJoin( * ### Using expressions objects: * * ``` - * $exp = $query->newExpr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR'); + * $exp = $query->expr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR'); * $query->where(['published' => true], ['published' => 'boolean'])->where($exp); * ``` * @@ -898,7 +930,7 @@ public function where( bool $overwrite = false, ) { if ($overwrite) { - $this->_parts['where'] = $this->newExpr(); + $this->_parts['where'] = $this->expr(); } $this->_conjugate('where', $conditions, 'AND', $types); @@ -918,7 +950,7 @@ public function whereNotNull(ExpressionInterface|array|string $fields) $fields = [$fields]; } - $exp = $this->newExpr(); + $exp = $this->expr(); foreach ($fields as $field) { $exp->isNotNull($field); @@ -940,7 +972,7 @@ public function whereNull(ExpressionInterface|array|string $fields) $fields = [$fields]; } - $exp = $this->newExpr(); + $exp = $this->expr(); foreach ($fields as $field) { $exp->isNull($field); @@ -1129,7 +1161,7 @@ public function andWhere(ExpressionInterface|Closure|array|string $conditions, a * * ``` * $query - * ->orderBy(['title' => $query->newExpr('DESC NULLS FIRST')]) + * ->orderBy(['title' => $query->expr('DESC NULLS FIRST')]) * ->orderBy('author_id'); * ``` * @@ -1138,7 +1170,7 @@ public function andWhere(ExpressionInterface|Closure|array|string $conditions, a * `ORDER BY title DESC NULLS FIRST, author_id` * * ``` - * $expression = $query->newExpr()->add(['id % 2 = 0']); + * $expression = $query->expr()->add(['id % 2 = 0']); * $query->orderBy($expression)->orderBy(['title' => 'ASC']); * ``` * @@ -1198,7 +1230,7 @@ public function order(ExpressionInterface|Closure|array|string $fields, bool $ov * * ``` * $query - * ->orderBy(['title' => $query->newExpr('DESC NULLS FIRST')]) + * ->orderBy(['title' => $query->expr('DESC NULLS FIRST')]) * ->orderBy('author_id'); * ``` * @@ -1207,7 +1239,7 @@ public function order(ExpressionInterface|Closure|array|string $fields, bool $ov * `ORDER BY title DESC NULLS FIRST, author_id` * * ``` - * $expression = $query->newExpr()->add(['id % 2 = 0']); + * $expression = $query->expr()->add(['id % 2 = 0']); * $query->orderBy($expression)->orderBy(['title' => 'ASC']); * ``` * @@ -1294,7 +1326,7 @@ public function orderByAsc(ExpressionInterface|Closure|string $field, bool $over } if ($field instanceof Closure) { - $field = $field($this->newExpr(), $this); + $field = $field($this->expr(), $this); } $this->_parts['order'] ??= new OrderByExpression(); @@ -1350,7 +1382,7 @@ public function orderByDesc(ExpressionInterface|Closure|string $field, bool $ove } if ($field instanceof Closure) { - $field = $field($this->newExpr(), $this); + $field = $field($this->expr(), $this); } $this->_parts['order'] ??= new OrderByExpression(); @@ -1365,17 +1397,14 @@ public function orderByDesc(ExpressionInterface|Closure|string $field, bool $ove /** * Set the page of results you want. * - * This method provides an easier to use interface to set the limit + offset - * in the record set you want as results. If empty the limit will default to - * the existing limit clause, and if that too is empty, then `25` will be used. - * - * Pages must start at 1. + * This method is not implemented in the base Query class and will throw an exception. + * It is implemented in subclasses like SelectQuery. * * @param int $num The page number you want. * @param int|null $limit The number of rows you want in the page. If null * the current limit clause will be used. * @return $this - * @throws \Cake\Core\Exception\CakeException If page number < 1. + * @throws \Cake\Core\Exception\CakeException Always thrown as this method is not implemented in the base class */ public function page(int $num, ?int $limit = null) { @@ -1392,7 +1421,7 @@ public function page(int $num, ?int $limit = null) * * ``` * $query->limit(10) // generates LIMIT 10 - * $query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1) + * $query->limit($query->expr()->add(['1 + 1'])); // LIMIT (1 + 1) * ``` * * @param \Cake\Database\ExpressionInterface|int|null $limit number of records to be returned @@ -1418,7 +1447,7 @@ public function limit(ExpressionInterface|int|null $limit) * * ``` * $query->offset(10) // generates OFFSET 10 - * $query->offset($query->newExpr()->add(['1 + 1'])); // OFFSET (1 + 1) + * $query->offset($query->expr()->add(['1 + 1'])); // OFFSET (1 + 1) * ``` * * @param \Cake\Database\ExpressionInterface|int|null $offset number of records to be skipped @@ -1442,7 +1471,7 @@ public function offset(ExpressionInterface|int|null $offset) * ### Example * * ``` - * $query->newExpr()->lte('count', $query->identifier('total')); + * $query->expr()->lte('count', $query->identifier('total')); * ``` * * @param string $identifier The identifier for an expression @@ -1525,9 +1554,12 @@ public function type(): string * * @param \Cake\Database\ExpressionInterface|array|string|null $rawExpression A string, array or anything you want wrapped in an expression object * @return \Cake\Database\Expression\QueryExpression + * @deprecated 5.3.0 Use `expr()` instead of `newExpr()`. */ public function newExpr(ExpressionInterface|array|string|null $rawExpression = null): QueryExpression { + deprecationWarning('5.3.0', 'Use `expr()` instead of `newExpr()`.'); + return $this->expr($rawExpression); } @@ -1614,7 +1646,7 @@ public function clause(string $name): mixed { if (!array_key_exists($name, $this->_parts)) { $clauses = array_keys($this->_parts); - array_walk($clauses, fn(&$x) => $x = "`{$x}`"); + array_walk($clauses, fn(string &$x) => $x = "`{$x}`"); $clauses = implode(', ', $clauses); throw new InvalidArgumentException(sprintf( 'The `%s` clause is not defined. Valid clauses are: %s.', @@ -1691,6 +1723,7 @@ protected function _expressionsVisitor(mixed $expression, Closure $callback): vo */ public function bind(string|int $param, mixed $value, string|int|null $type = null) { + $this->_dirty(); $this->getValueBinder()->bind($param, $value, $type); return $this; @@ -1744,7 +1777,7 @@ protected function _conjugate( array $types, ): void { /** @var \Cake\Database\Expression\QueryExpression $expression */ - $expression = $this->_parts[$part] ?: $this->newExpr(); + $expression = $this->_parts[$part] ?: $this->expr(); if (!$append) { $this->_parts[$part] = $expression; @@ -1752,13 +1785,13 @@ protected function _conjugate( } if ($append instanceof Closure) { - $append = $append($this->newExpr(), $this); + $append = $append($this->expr(), $this); } if ($expression->getConjunction() === $conjunction) { $expression->add($append, $types); } else { - $expression = $this->newExpr() + $expression = $this->expr() ->setConjunction($conjunction) ->add([$expression, $append], $types); } @@ -1784,8 +1817,6 @@ protected function _dirty(): void /** * Handles clearing iterator and cloning all expressions and value binders. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Query/DeleteQuery.php b/app/vendor/cakephp/cakephp/src/Database/Query/DeleteQuery.php index db1087cfb..bc1a63df6 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Query/DeleteQuery.php +++ b/app/vendor/cakephp/cakephp/src/Database/Query/DeleteQuery.php @@ -39,6 +39,7 @@ class DeleteQuery extends Query 'comment' => null, 'with' => [], 'delete' => true, + 'optimizerHint' => [], 'modifier' => [], 'from' => [], 'join' => [], diff --git a/app/vendor/cakephp/cakephp/src/Database/Query/InsertQuery.php b/app/vendor/cakephp/cakephp/src/Database/Query/InsertQuery.php index 93f8a8dbd..1e8f035be 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Query/InsertQuery.php +++ b/app/vendor/cakephp/cakephp/src/Database/Query/InsertQuery.php @@ -42,6 +42,7 @@ class InsertQuery extends Query 'comment' => null, 'with' => [], 'insert' => [], + 'optimizerHint' => [], 'modifier' => [], 'values' => [], 'epilog' => null, diff --git a/app/vendor/cakephp/cakephp/src/Database/Query/QueryFactory.php b/app/vendor/cakephp/cakephp/src/Database/Query/QueryFactory.php index 90a4346ba..64514bec3 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Query/QueryFactory.php +++ b/app/vendor/cakephp/cakephp/src/Database/Query/QueryFactory.php @@ -41,7 +41,7 @@ public function __construct( * @param \Cake\Database\ExpressionInterface|\Closure|array|string|float|int $fields Fields/columns list for the query. * @param array|string $table List of tables to query. * @param array $types Associative array containing the types to be used for casting. - * @return \Cake\Database\Query\SelectQuery + * @return \Cake\Database\Query\SelectQuery */ public function select( ExpressionInterface|Closure|array|string|float|int $fields = [], diff --git a/app/vendor/cakephp/cakephp/src/Database/Query/SelectQuery.php b/app/vendor/cakephp/cakephp/src/Database/Query/SelectQuery.php index 9e2d6ceba..7ea81e7d0 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Query/SelectQuery.php +++ b/app/vendor/cakephp/cakephp/src/Database/Query/SelectQuery.php @@ -34,7 +34,7 @@ /** * This class is used to generate SELECT queries for the relational database. * - * @template T of mixed + * @template-covariant T of mixed * @implements \IteratorAggregate */ class SelectQuery extends Query implements IteratorAggregate @@ -53,9 +53,10 @@ class SelectQuery extends Query implements IteratorAggregate */ protected array $_parts = [ 'comment' => null, - 'modifier' => [], 'with' => [], 'select' => [], + 'optimizerHint' => [], + 'modifier' => [], 'distinct' => false, 'from' => [], 'join' => [], @@ -153,9 +154,9 @@ public function all(): iterable * }) * ``` * - * By default no fields are selected, if you have an instance of `Cake\ORM\Query` and try to append - * fields you should also call `Cake\ORM\Query::enableAutoFields()` to select the default fields - * from the table. + * By default no fields are selected, if you have an instance of `Cake\ORM\Query\SelectQuery` and try to + * append fields you should also call `Cake\ORM\Query\SelectQuery::enableAutoFields()` to select the + * default fields from the table. * * @param \Cake\Database\ExpressionInterface|\Closure|array|string|float|int $fields fields to be added to the list. * @param bool $overwrite whether to reset fields with passed list or not @@ -327,7 +328,7 @@ public function having( bool $overwrite = false, ) { if ($overwrite) { - $this->_parts['having'] = $this->newExpr(); + $this->_parts['having'] = $this->expr(); } $this->_conjugate('having', $conditions, 'AND', $types); @@ -771,8 +772,6 @@ public function isResultsCastingEnabled(): bool /** * Handles clearing iterator and cloning all expressions and value binders. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Database/Query/UpdateQuery.php b/app/vendor/cakephp/cakephp/src/Database/Query/UpdateQuery.php index 4f72902d6..af5dccc8f 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Query/UpdateQuery.php +++ b/app/vendor/cakephp/cakephp/src/Database/Query/UpdateQuery.php @@ -43,6 +43,7 @@ class UpdateQuery extends Query 'comment' => null, 'with' => [], 'update' => [], + 'optimizerHint' => [], 'modifier' => [], 'join' => [], 'set' => [], @@ -105,11 +106,11 @@ public function update(ExpressionInterface|string $table) public function set(QueryExpression|Closure|array|string $key, mixed $value = null, array|string $types = []) { if (empty($this->_parts['set'])) { - $this->_parts['set'] = $this->newExpr()->setConjunction(','); + $this->_parts['set'] = $this->expr()->setConjunction(','); } if ($key instanceof Closure) { - $exp = $this->newExpr()->setConjunction(','); + $exp = $this->expr()->setConjunction(','); /** @var \Cake\Database\Expression\QueryExpression $setExpr */ $setExpr = $this->_parts['set']; $setExpr->add($key($exp)); diff --git a/app/vendor/cakephp/cakephp/src/Database/QueryCompiler.php b/app/vendor/cakephp/cakephp/src/Database/QueryCompiler.php index f4a44bc12..181e15c6c 100644 --- a/app/vendor/cakephp/cakephp/src/Database/QueryCompiler.php +++ b/app/vendor/cakephp/cakephp/src/Database/QueryCompiler.php @@ -37,8 +37,8 @@ class QueryCompiler protected array $_templates = [ 'delete' => 'DELETE', 'where' => ' WHERE %s', - 'group' => ' GROUP BY %s ', - 'having' => ' HAVING %s ', + 'group' => ' GROUP BY %s', + 'having' => ' HAVING %s', 'order' => ' %s', 'limit' => ' LIMIT %s', 'offset' => ' OFFSET %s', @@ -68,7 +68,8 @@ class QueryCompiler * * @var array */ - protected array $_deleteParts = ['comment', 'with', 'delete', 'modifier', 'from', 'where', 'epilog']; + protected array $_deleteParts = ['comment', 'with', 'delete', 'optimizerHint', 'modifier', 'from', 'where', + 'epilog']; /** * The list of query clauses to traverse for generating an INSERT statement @@ -102,11 +103,13 @@ public function compile(Query $query, ValueBinder $binder): string ); // Propagate bound parameters from sub-queries if the - // placeholders can be found in the SQL statement. + // placeholders can be found in the SQL statement. Only + // add new placeholders, as sub-queries may have been executed already. if ($query->getValueBinder() !== $binder) { + $existing = $binder->bindings(); foreach ($query->getValueBinder()->bindings() as $binding) { $placeholder = ':' . $binding['placeholder']; - if (preg_match('/' . $placeholder . '(?:\W|$)/', $sql) > 0) { + if (!isset($existing[$placeholder]) && preg_match('/' . $placeholder . '(?:\W|$)/', $sql) > 0) { $binder->bind($placeholder, $binding['value'], $binding['type']); } } @@ -185,15 +188,16 @@ protected function _buildWithPart(array $parts, Query $query, ValueBinder $binde */ protected function _buildSelectPart(array $parts, Query $query, ValueBinder $binder): string { - $driver = $query->getConnection()->getDriver($query->getConnectionRole()); - $select = 'SELECT%s %s%s'; + $driver = $query->getDriver(); + $select = 'SELECT%s%s %s%s'; if ( ($query->clause('union') || $query->clause('intersect')) && $driver->supports(DriverFeatureEnum::SET_OPERATIONS_ORDER_BY) ) { - $select = '(SELECT%s %s%s'; + $select = '(SELECT%s%s %s%s'; } - $distinct = $query->clause('distinct'); + + $hint = $this->_buildOptimizerHintPart($query->clause('optimizerHint'), $query, $binder); $modifiers = $this->_buildModifierPart($query->clause('modifier'), $query, $binder); $quoteIdentifiers = $driver->isAutoQuotingEnabled() || $this->_quotedSelectAliases; @@ -211,16 +215,15 @@ protected function _buildSelectPart(array $parts, Query $query, ValueBinder $bin $normalized[] = $p; } + $distinct = $query->clause('distinct'); if ($distinct === true) { $distinct = 'DISTINCT '; - } - - if (is_array($distinct)) { + } elseif (is_array($distinct)) { $distinct = $this->_stringifyExpressions($distinct, $binder); $distinct = sprintf('DISTINCT ON (%s) ', implode(', ', $distinct)); } - return sprintf($select, $modifiers, $distinct, implode(', ', $normalized)); + return sprintf($select, $hint, $modifiers, $distinct, implode(', ', $normalized)); } /** @@ -358,7 +361,7 @@ protected function _buildSetOperationPart( ->getDriver($query->getConnectionRole()) ->supports(DriverFeatureEnum::SET_OPERATIONS_ORDER_BY); - $parts = array_map(function ($p) use ($binder, $setOperationsOrderBy) { + $parts = array_map(function (array $p) use ($binder, $setOperationsOrderBy) { /** @var \Cake\Database\Expression\IdentifierExpression $expr */ $expr = $p['query']; $p['query'] = $expr->sql($binder); @@ -372,10 +375,10 @@ protected function _buildSetOperationPart( }, $parts); if ($setOperationsOrderBy) { - return sprintf(")\n$operation %s", implode("\n$operation ", $parts)); + return sprintf(")\n{$operation} %s", implode("\n{$operation} ", $parts)); } - return sprintf("\n$operation %s", implode("\n$operation ", $parts)); + return sprintf("\n{$operation} %s", implode("\n{$operation} ", $parts)); } /** @@ -426,9 +429,10 @@ protected function _buildInsertPart(array $parts, Query $query, ValueBinder $bin } $table = $parts[0]; $columns = $this->_stringifyExpressions($parts[1], $binder); + $hint = $this->_buildOptimizerHintPart($query->clause('optimizerHint'), $query, $binder); $modifiers = $this->_buildModifierPart($query->clause('modifier'), $query, $binder); - return sprintf('INSERT%s INTO %s (%s)', $modifiers, $table, implode(', ', $columns)); + return sprintf('INSERT%s%s INTO %s (%s)', $hint, $modifiers, $table, implode(', ', $columns)); } /** @@ -455,9 +459,27 @@ protected function _buildValuesPart(array $parts, Query $query, ValueBinder $bin protected function _buildUpdatePart(array $parts, Query $query, ValueBinder $binder): string { $table = $this->_stringifyExpressions($parts, $binder); + $hint = $this->_buildOptimizerHintPart($query->clause('optimizerHint'), $query, $binder); $modifiers = $this->_buildModifierPart($query->clause('modifier'), $query, $binder); - return sprintf('UPDATE%s %s', $modifiers, implode(',', $table)); + return sprintf('UPDATE%s%s %s', $hint, $modifiers, implode(',', $table)); + } + + /** + * Builds the optimizer hint comment part. + * + * @param list $parts The optmizer hints + * @param \Cake\Database\Query $query The query that is being compiled + * @param \Cake\Database\ValueBinder $binder Value binder used to generate parameter placeholder + * @return string Optimizer hint comment + */ + protected function _buildOptimizerHintPart(array $parts, Query $query, ValueBinder $binder): string + { + if ($parts === [] || !$query->getDriver()->supports(DriverFeatureEnum::OPTIMIZER_HINT_COMMENT)) { + return ''; + } + + return sprintf(' /*+ %s */', implode(' ', $parts)); } /** diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/CheckConstraint.php b/app/vendor/cakephp/cakephp/src/Database/Schema/CheckConstraint.php new file mode 100644 index 000000000..208818a94 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/CheckConstraint.php @@ -0,0 +1,84 @@ += 18") + */ + public function __construct( + protected string $name, + protected string $expression, + ) { + } + + /** + * Set the check constraint expression. + * + * @param string $expression The SQL expression for the check constraint + * @return $this + * @throws \InvalidArgumentException + */ + public function setExpression(string $expression) + { + if (trim($expression) === '') { + throw new InvalidArgumentException('Check constraint expression cannot be empty'); + } + + $this->expression = trim($expression); + + return $this; + } + + /** + * Get the check constraint expression. + * + * @return string + */ + public function getExpression(): string + { + return $this->expression; + } + + /** + * Converts a constraint to an array that is compatible + * with the constructor. + * + * @return array + */ + public function toArray(): array + { + return [ + 'name' => $this->name, + 'type' => $this->type, + 'expression' => $this->expression, + ]; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/Collection.php b/app/vendor/cakephp/cakephp/src/Database/Schema/Collection.php index 75e15369b..23ce2084a 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/Collection.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/Collection.php @@ -94,6 +94,6 @@ public function describe(string $name, array $options = []): TableSchemaInterfac */ protected function getDialect(): SchemaDialect { - return $this->_dialect ??= $this->_connection->getDriver()->schemaDialect(); + return $this->_dialect ??= $this->_connection->getWriteDriver()->schemaDialect(); } } diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/Column.php b/app/vendor/cakephp/cakephp/src/Database/Schema/Column.php new file mode 100644 index 000000000..3706ee675 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/Column.php @@ -0,0 +1,634 @@ +name = $name; + + return $this; + } + + /** + * Gets the column name. + * + * @return string|null + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * Get the base type if defined. Will fallback to `type` if not set. + * + * Used to get the base type of a column when the column type is a complex/custom type. + * + * @return string|null + */ + public function getBaseType(): ?string + { + if (isset($this->baseType)) { + return $this->baseType; + } + $type = $this->type; + if (TypeFactory::getMapped($type)) { + $type = TypeFactory::build($type)->getBaseType(); + } + + return $this->baseType = $type; + } + + /** + * Sets the base type of the column. + * + * Used to set the base type of a column when the column type is a complex/custom type. + * + * @param string|null $baseType Base type + * @return $this + */ + public function setBaseType(?string $baseType) + { + $this->baseType = $baseType; + + return $this; + } + + /** + * Sets the column type. + * + * Type names are not validated, as drivers and dialects may implement + * platform specific types that are not known by cakephp. + * + * Drivers are expected to handle unknown types gracefully. + * + * @param string $type Column type + * @return $this + */ + public function setType(string $type) + { + $this->type = $type; + + return $this; + } + + /** + * Gets the column type. + * + * @return string + */ + public function getType(): string + { + return $this->type; + } + + /** + * Sets the column length. + * + * @param int|null $length Length + * @return $this + */ + public function setLength(?int $length) + { + $this->length = $length; + + return $this; + } + + /** + * Gets the column length. + * + * @return int|null + */ + public function getLength(): ?int + { + return $this->length; + } + + /** + * Sets whether the column allows nulls. + * + * @param bool $null Null + * @return $this + */ + public function setNull(bool $null) + { + $this->null = $null; + + return $this; + } + + /** + * Gets whether the column allows nulls. + * + * @return bool|null + */ + public function getNull(): ?bool + { + return $this->null; + } + + /** + * Does the column allow nulls? + * + * @return bool + */ + public function isNull(): bool + { + return $this->getNull() === true; + } + + /** + * Sets the default column value. + * + * @param mixed $default Default + * @return $this + */ + public function setDefault(mixed $default) + { + $this->default = $default; + + return $this; + } + + /** + * Gets the default column value. + * + * @return mixed + */ + public function getDefault(): mixed + { + return $this->default; + } + + /** + * Sets generated option for identity columns. Ignored otherwise. + * + * @param string|null $generated Generated option + * @return $this + */ + public function setGenerated(?string $generated) + { + $this->generated = $generated; + + return $this; + } + + /** + * Gets generated option for identity columns. Null otherwise + * + * @return string|null + */ + public function getGenerated(): ?string + { + return $this->generated; + } + + /** + * Sets whether the column is an identity column. + * + * @param bool $identity Identity + * @return $this + */ + public function setIdentity(bool $identity) + { + $this->identity = $identity; + + return $this; + } + + /** + * Gets whether the column is an identity column. + * + * @return bool + */ + public function getIdentity(): bool + { + return $this->identity; + } + + /** + * Is the column an identity column? + * + * @return bool + */ + public function isIdentity(): bool + { + return $this->getIdentity(); + } + + /** + * Sets the name of the column to add this column after. + * + * @param string $after After + * @return $this + */ + public function setAfter(string $after) + { + $this->after = $after; + + return $this; + } + + /** + * Returns the name of the column to add this column after. + * + * Used by MySQL and MariaDB in ALTER TABLE statements. + * + * @return string|null + */ + public function getAfter(): ?string + { + return $this->after; + } + + /** + * Sets the 'ON UPDATE' mysql column function. + * + * Used by MySQL and MariaDB in ALTER TABLE statements. + * + * @param string $update On Update function + * @return $this + */ + public function setOnUpdate(string $update) + { + $this->onUpdate = $update; + + return $this; + } + + /** + * Returns the value of the ON UPDATE column function. + * + * @return string|null + */ + public function getOnUpdate(): ?string + { + return $this->onUpdate; + } + + /** + * Sets the number precision for decimal or float column. + * + * For example `DECIMAL(5,2)`, 5 is the length and 2 is the precision, + * and the column could store value from -999.99 to 999.99. + * + * @param int|null $precision Number precision + * @return $this + */ + public function setPrecision(?int $precision) + { + $this->precision = $precision; + + return $this; + } + + /** + * Gets the number precision for decimal or float column. + * + * For example `DECIMAL(5,2)`, 5 is the length and 2 is the precision, + * and the column could store value from -999.99 to 999.99. + * + * @return int|null + */ + public function getPrecision(): ?int + { + return $this->precision; + } + + /** + * Sets the column identity increment. + * + * @param int $increment Number increment + * @return $this + */ + public function setIncrement(int $increment) + { + $this->increment = $increment; + + return $this; + } + + /** + * Gets the column identity increment. + * + * @return int|null + */ + public function getIncrement(): ?int + { + return $this->increment; + } + + /** + * Sets the column comment. + * + * @param string|null $comment Comment + * @return $this + */ + public function setComment(?string $comment) + { + $this->comment = $comment; + + return $this; + } + + /** + * Gets the column comment. + * + * @return string + */ + public function getComment(): ?string + { + return $this->comment; + } + + /** + * Sets whether field should be unsigned. + * + * @param bool $unsigned Signed + * @return $this + */ + public function setUnsigned(bool $unsigned) + { + $this->unsigned = $unsigned; + + return $this; + } + + /** + * Gets whether field should be unsigned. + * + * @return bool|null + */ + public function getUnsigned(): ?bool + { + return $this->unsigned; + } + + /** + * Should the column be signed? + * + * @return bool + */ + public function isSigned(): bool + { + return !$this->getUnsigned(); + } + + /** + * Should the column be unsigned? + * + * @return bool + */ + public function isUnsigned(): bool + { + return $this->getUnsigned() === true; + } + + /** + * Sets the column collation. + * + * @param string $collation Collation + * @return $this + */ + public function setCollate(string $collation) + { + $this->collate = $collation; + + return $this; + } + + /** + * Gets the column collation. + * + * @return string|null + */ + public function getCollate(): ?string + { + return $this->collate; + } + + /** + * Sets the column SRID for geometry fields. + * + * @param int $srid SRID + * @return $this + */ + public function setSrid(int $srid) + { + $this->srid = $srid; + + return $this; + } + + /** + * Gets the column SRID from geometry fields. + * + * @return int|null + */ + public function getSrid(): ?int + { + return $this->srid; + } + + /** + * Sets whether the column is fixed-length. + * + * Used for binary columns to distinguish between BINARY and VARBINARY. + * + * @param bool $fixed Fixed + * @return $this + */ + public function setFixed(bool $fixed) + { + $this->fixed = $fixed; + + return $this; + } + + /** + * Gets whether the column is fixed-length. + * + * @return bool|null + */ + public function getFixed(): ?bool + { + return $this->fixed; + } + + /** + * Is the column fixed-length? + * + * @return bool + */ + public function isFixed(): bool + { + return $this->getFixed() === true; + } + + /** + * Gets all allowed options. Each option must have a corresponding `setFoo` method. + * + * @return array + */ + protected function getValidOptions(): array + { + return [ + 'name', + 'length', + 'precision', + 'default', + 'null', + 'identity', + 'after', + 'onUpdate', + 'comment', + 'unsigned', + 'type', + 'properties', + 'collate', + 'srid', + 'increment', + 'generated', + 'fixed', + ]; + } + + /** + * Utility method that maps an array of column attributes to this object's methods. + * + * @param array $attributes Attributes + * @throws \RuntimeException + * @return $this + */ + public function setAttributes(array $attributes) + { + $validOptions = $this->getValidOptions(); + if (isset($attributes['identity']) && $attributes['identity'] && !isset($attributes['null'])) { + $attributes['null'] = false; + } + + foreach ($attributes as $attribute => $value) { + if (!in_array($attribute, $validOptions, true)) { + throw new RuntimeException(sprintf('"%s" is not a valid column option.', $attribute)); + } + + $method = 'set' . ucfirst($attribute); + $this->$method($value); + } + + return $this; + } + + /** + * Convert an index into an array that is compatible with the Column constructor. + * + * @return array + */ + public function toArray(): array + { + $type = $this->getType(); + $length = $this->getLength(); + $precision = $this->getPrecision(); + if ($precision !== null && $precision > 0) { + if ($type === TableSchemaInterface::TYPE_TIMESTAMP) { + $type = 'timestampfractional'; + } elseif ($type === TableSchemaInterface::TYPE_DATETIME) { + $type = 'datetimefractional'; + } + } + + return [ + 'name' => $this->getName(), + 'baseType' => $this->getBaseType(), + 'type' => $type, + 'length' => $length, + 'null' => $this->getNull(), + 'default' => $this->getDefault(), + 'generated' => $this->getGenerated(), + 'unsigned' => $this->getUnsigned(), + 'onUpdate' => $this->getOnUpdate(), + 'collate' => $this->getCollate(), + 'precision' => $precision, + 'srid' => $this->getSrid(), + 'comment' => $this->getComment(), + 'autoIncrement' => $this->getIdentity(), + 'identity' => $this->getIdentity(), + 'fixed' => $this->getFixed(), + ]; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/Constraint.php b/app/vendor/cakephp/cakephp/src/Database/Schema/Constraint.php new file mode 100644 index 000000000..b695f7349 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/Constraint.php @@ -0,0 +1,145 @@ + $columns The columns to constraint. + * @param string $type The type of constraint, e.g. 'unique', 'primary'. + */ + public function __construct( + protected string $name, + protected array $columns, + protected string $type, + ) { + } + + /** + * Sets the constraint columns. + * + * @param array|string $columns Columns + * @return $this + */ + public function setColumns(string|array $columns) + { + $this->columns = (array)$columns; + + return $this; + } + + /** + * Gets the constraint columns. + * + * @return ?array + */ + public function getColumns(): ?array + { + return $this->columns; + } + + /** + * Sets the constraint type. + * + * @param string $type Type + * @return $this + */ + public function setType(string $type) + { + $this->type = $type; + + return $this; + } + + /** + * Gets the constraint type. + * + * @return string + */ + public function getType(): string + { + return $this->type; + } + + /** + * Sets the constraint name. + * + * @param string $name Name + * @return $this + */ + public function setName(string $name) + { + $this->name = $name; + + return $this; + } + + /** + * Gets the constraint name. + * + * @return ?string + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * Converts a constraint to an array that is compatible + * with the constructor. + * + * @return array + */ + public function toArray(): array + { + return [ + 'name' => $this->name, + 'type' => $this->type, + 'columns' => $this->columns, + ]; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/ForeignKey.php b/app/vendor/cakephp/cakephp/src/Database/Schema/ForeignKey.php new file mode 100644 index 000000000..2f6aadc0d --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/ForeignKey.php @@ -0,0 +1,267 @@ + + */ + protected array $validActions = [ + self::CASCADE, + self::RESTRICT, + self::SET_NULL, + self::NO_ACTION, + self::SET_DEFAULT, + ]; + + /** + * The action to take when the referenced row is deleted. + */ + protected ?string $delete = null; + + /** + * The action to take when the referenced row is updated. + */ + protected ?string $update = null; + + /** + * @var string|null + */ + protected ?string $deferrable = null; + + /** + * Constructor + * + * @param string $name The name of the index. + * @param array $columns The columns to index. + * @param ?string $referencedTable The columns to index. + * @param array $referencedColumns The columns in $referencedTable that this key references. + * @param ?string $delete The action to take when the referenced row is deleted. + * @param ?string $update The action to take when the referenced row is updated. + */ + public function __construct( + protected string $name, + protected array $columns, + protected ?string $referencedTable = null, + protected array $referencedColumns = [], + ?string $delete = null, + ?string $update = null, + ?string $deferrable = null, + ) { + $this->type = self::FOREIGN; + $this->delete = $this->normalizeAction($delete ?? self::NO_ACTION); + $this->update = $this->normalizeAction($update ?? self::NO_ACTION); + if ($deferrable) { + $this->deferrable = $this->normalizeDeferrable($deferrable); + } + } + + /** + * Sets the foreign key referenced table. + * + * @param string $table The table this KEY is pointing to + * @return $this + */ + public function setReferencedTable(string $table) + { + $this->referencedTable = $table; + + return $this; + } + + /** + * Gets the foreign key referenced table. + * + * @return ?string + */ + public function getReferencedTable(): ?string + { + return $this->referencedTable; + } + + /** + * Sets the foreign key referenced columns. + * + * @param array|string $referencedColumns Referenced columns + * @return $this + */ + public function setReferencedColumns(array|string $referencedColumns) + { + $referencedColumns = is_string($referencedColumns) ? [$referencedColumns] : $referencedColumns; + $this->referencedColumns = $referencedColumns; + + return $this; + } + + /** + * Gets the foreign key referenced columns. + * + * @return array + */ + public function getReferencedColumns(): array + { + return $this->referencedColumns; + } + + /** + * Converts the foreign key to an array that is compatible + * with the constructor. + * + * @return array + */ + public function toArray(): array + { + return [ + 'name' => $this->name, + 'type' => $this->type, + 'columns' => $this->columns, + 'referencedTable' => $this->referencedTable, + 'referencedColumns' => $this->referencedColumns, + 'delete' => $this->delete, + 'update' => $this->update, + 'deferrable' => $this->deferrable, + ]; + } + + /** + * Sets ON DELETE action for the foreign key. + * + * @param string $delete On Delete + * @return $this + */ + public function setDelete(string $delete) + { + $this->delete = $this->normalizeAction($delete); + + return $this; + } + + /** + * Gets ON DELETE action for the foreign key. + * + * @return string|null + */ + public function getDelete(): ?string + { + return $this->delete; + } + + /** + * Gets ON UPDATE action for the foreign key. + * + * @return string|null + */ + public function getUpdate(): ?string + { + return $this->update; + } + + /** + * Sets ON UPDATE action for the foreign key. + * + * @param string $update On Update + * @return $this + */ + public function setUpdate(string $update) + { + $this->update = $this->normalizeAction($update); + + return $this; + } + + /** + * From passed value checks if it's correct and fixes if needed + * + * @param string $action Action + * @throws \InvalidArgumentException + * @return string + */ + protected function normalizeAction(string $action): string + { + if (in_array($action, $this->validActions, true)) { + return $action; + } + throw new InvalidArgumentException('Unknown action passed: ' . $action); + } + + /** + * Sets deferrable mode for the foreign key. + * + * @param string $deferrable Constraint + * @return $this + */ + public function setDeferrable(string $deferrable) + { + $this->deferrable = $this->normalizeDeferrable($deferrable); + + return $this; + } + + /** + * Gets deferrable mode for the foreign key. + */ + public function getDeferrable(): ?string + { + return $this->deferrable; + } + + /** + * From passed value checks if it's correct and fixes if needed + * + * @param string $deferrable Deferrable + * @throws \InvalidArgumentException + * @return string + */ + protected function normalizeDeferrable(string $deferrable): string + { + $mapping = [ + 'DEFERRED' => ForeignKey::DEFERRED, + 'IMMEDIATE' => ForeignKey::IMMEDIATE, + 'NOT DEFERRED' => ForeignKey::NOT_DEFERRED, + ForeignKey::DEFERRED => ForeignKey::DEFERRED, + ForeignKey::IMMEDIATE => ForeignKey::IMMEDIATE, + ForeignKey::NOT_DEFERRED => ForeignKey::NOT_DEFERRED, + ]; + $normalized = strtoupper(str_replace('_', ' ', $deferrable)); + if (array_key_exists($normalized, $mapping)) { + return $mapping[$normalized]; + } + + throw new InvalidArgumentException('Unknown deferrable passed: ' . $deferrable); + } +} diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/Index.php b/app/vendor/cakephp/cakephp/src/Database/Schema/Index.php new file mode 100644 index 000000000..83111e655 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/Index.php @@ -0,0 +1,273 @@ + $columns The columns to index. + * @param string $type The type of index, e.g. 'index', 'fulltext'. + * @param array|int|null $length The length of the index. + * @param array|null $order The sort order of the index columns. + * @param array|null $include The included columns for covering indexes. + * @param ?string $where The where clause for partial indexes. + */ + public function __construct( + protected string $name, + protected array $columns, + protected string $type = self::INDEX, + protected array|int|null $length = null, + protected ?array $order = null, + protected ?array $include = null, + protected ?string $where = null, + ) { + } + + /** + * Sets the index columns. + * + * @param array|string $columns Columns + * @return $this + */ + public function setColumns(string|array $columns) + { + $this->columns = (array)$columns; + + return $this; + } + + /** + * Gets the index columns. + * + * @return ?array + */ + public function getColumns(): ?array + { + return $this->columns; + } + + /** + * Sets the index type. + * + * @param string $type Type + * @return $this + */ + public function setType(string $type) + { + $this->type = $type; + + return $this; + } + + /** + * Gets the index type. + * + * @return string + */ + public function getType(): string + { + return $this->type; + } + + /** + * Sets the index name. + * + * @param string $name Name + * @return $this + */ + public function setName(string $name) + { + $this->name = $name; + + return $this; + } + + /** + * Gets the index name. + * + * @return ?string + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * Sets the index length. + * + * In MySQL indexes can have limit clauses to control the number of + * characters indexed in text and char columns. + * + * @param array|int $length length value or array of length value + * @return $this + */ + public function setLength(int|array $length) + { + $this->length = $length; + + return $this; + } + + /** + * Gets the index length. + * + * Can be an array of column names and lengths under MySQL. + * + * @return array|int|null + */ + public function getLength(): array|int|null + { + return $this->length; + } + + /** + * Sets the index columns sort order. + * + * @param array $order column name sort order key value pair + * @return $this + */ + public function setOrder(array $order) + { + $this->order = $order; + + return $this; + } + + /** + * Gets the index columns sort order. + * + * @return ?array + */ + public function getOrder(): ?array + { + return $this->order; + } + + /** + * Sets the index included columns for a 'covering index'. + * + * In postgres and sqlserver, indexes can define additional non-key + * columns to build 'covering indexes'. This feature allows you to + * further optimize well-crafted queries that leverage specific + * indexes by reading all data from the index. + * + * @param array $includedColumns Columns + * @return $this + */ + public function setInclude(array $includedColumns) + { + $this->include = $includedColumns; + + return $this; + } + + /** + * Gets the index included columns. + * + * @return ?array + */ + public function getInclude(): ?array + { + return $this->include; + } + + /** + * Set the where clause for partial indexes. + * + * @param ?string $where The where clause for partial indexes. + * @return $this + */ + public function setWhere(?string $where) + { + $this->where = $where; + + return $this; + } + + /** + * Get the where clause for partial indexes. + * + * @return ?string + */ + public function getWhere(): ?string + { + return $this->where; + } + + /** + * Utility method that maps an array of index options to this object's methods. + * + * @param array $attributes Attributes to set. + * @throws \RuntimeException + * @return $this + */ + public function setAttributes(array $attributes) + { + // Valid Options + $validOptions = ['columns', 'type', 'name', 'length', 'order', 'include', 'where']; + foreach ($attributes as $attr => $value) { + if (!in_array($attr, $validOptions, true)) { + throw new RuntimeException(sprintf('"%s" is not a valid index option.', $attr)); + } + $method = 'set' . ucfirst($attr); + $this->$method($value); + } + + return $this; + } + + /** + * Convert an index into an array that is compatible with the Index constructor. + * + * @return array + */ + public function toArray(): array + { + return [ + 'name' => $this->getName(), + 'columns' => $this->getColumns(), + 'type' => $this->getType(), + 'length' => $this->getLength(), + 'order' => $this->getOrder(), + 'include' => $this->getInclude(), + 'where' => $this->getWhere(), + ]; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/MysqlSchemaDialect.php b/app/vendor/cakephp/cakephp/src/Database/Schema/MysqlSchemaDialect.php index 7773316ea..0c778a6be 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/MysqlSchemaDialect.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/MysqlSchemaDialect.php @@ -16,6 +16,7 @@ */ namespace Cake\Database\Schema; +use Cake\Database\Driver\Mysql; use Cake\Database\DriverFeatureEnum; use Cake\Database\Exception\DatabaseException; use PDOException; @@ -120,13 +121,19 @@ private function splitTableName(string $tableName): array public function describeColumns(string $tableName): array { $sql = $this->describeColumnQuery($tableName); - $columns = []; try { - $statement = $this->_driver->execute($sql); + $rows = $this->_driver->execute($sql)->fetchAll('assoc'); } catch (PDOException $e) { throw new DatabaseException("Could not describe columns on `{$tableName}`", null, $e); } - foreach ($statement->fetchAll('assoc') as $row) { + + $geometryColumns = []; + if (array_intersect(array_column($rows, 'Type'), TableSchemaInterface::GEOSPATIAL_TYPES)) { + $geometryColumns = $this->describeGeometryColumns($tableName); + } + + $columns = []; + foreach ($rows as $row) { $field = $this->_convertColumn($row['Type']); $default = $this->parseDefault($field['type'], $row); @@ -138,20 +145,58 @@ public function describeColumns(string $tableName): array 'comment' => $row['Comment'], 'length' => null, ]; - if (isset($row['Extra']) && $row['Extra'] === 'auto_increment') { + $extra = trim($row['Extra'] ?? ''); + if ($extra === 'auto_increment') { $field['autoIncrement'] = true; } - if ($row['Extra'] === 'on update CURRENT_TIMESTAMP') { - $field['onUpdate'] = 'CURRENT_TIMESTAMP'; - } elseif ($row['Extra'] === 'on update current_timestamp()') { + // Depending on the MySQL Version the extra column can contain/start with DEFAULT_GENERATED as well + if ( + str_ends_with($extra, 'on update CURRENT_TIMESTAMP') || + str_ends_with($extra, 'on update current_timestamp()') + ) { $field['onUpdate'] = 'CURRENT_TIMESTAMP'; } + + $srid = $geometryColumns[$field['name']]['srid'] ?? null; + if ($srid !== null) { + $field['srid'] = $srid; + } + $columns[] = $field; } return $columns; } + /** + * Describes geometry-specific column information. + * + * @param string $table The table name. + * @return array The column information. + */ + private function describeGeometryColumns(string $table): array + { + /** @var \Cake\Database\Driver\Mysql $driver */ + $driver = $this->_driver; + + if (!$driver->isMariaDb() && version_compare($driver->version(), '8.0.1', '>=')) { + $sql = <<config()['database']; + $columns = $this->_driver->execute($sql, [$table, $schema])->fetchAll('assoc'); + + return array_combine(array_column($columns, 'name'), $columns); + } + /** * Parse the default value if required. * @@ -170,6 +215,7 @@ protected function parseDefault(string $type, array $row): ?string TableSchema::GEOSPATIAL_TYPES, [TableSchema::TYPE_BINARY, TableSchema::TYPE_JSON, TableSchema::TYPE_TEXT], ), + true, ) ) { // The default that comes back from MySQL for these types prefixes the collation type and @@ -187,6 +233,14 @@ protected function parseDefault(string $type, array $row): ?string ); } + if ( + $this->_driver instanceof Mysql && + $this->_driver->isMariaDb() && + $default === 'current_timestamp()' + ) { + return 'CURRENT_TIMESTAMP'; + } + return $default; } @@ -326,10 +380,10 @@ protected function _convertColumn(string $column): array return $type; } - if (in_array($col, ['date', 'time'])) { + if (in_array($col, ['date', 'time', 'year'], true)) { return ['type' => $col, 'length' => null]; } - if (in_array($col, ['datetime', 'timestamp'])) { + if (in_array($col, ['datetime', 'timestamp'], true)) { $typeName = $col; if ($length > 0) { $typeName = $col . 'fractional'; @@ -342,8 +396,12 @@ protected function _convertColumn(string $column): array return ['type' => TableSchemaInterface::TYPE_BOOLEAN, 'length' => null]; } + if ($col === 'bit') { + return ['type' => TableSchemaInterface::TYPE_BIT, 'length' => $length]; + } + $unsigned = (isset($matches[3]) && strtolower($matches[3]) === 'unsigned'); - if (str_contains($col, 'bigint') || $col === 'bigint') { + if (str_contains($col, 'bigint')) { return ['type' => TableSchemaInterface::TYPE_BIGINTEGER, 'length' => null, 'unsigned' => $unsigned]; } if ($col === 'tinyint') { @@ -352,7 +410,7 @@ protected function _convertColumn(string $column): array if ($col === 'smallint') { return ['type' => TableSchemaInterface::TYPE_SMALLINTEGER, 'length' => null, 'unsigned' => $unsigned]; } - if (in_array($col, ['int', 'integer', 'mediumint'])) { + if (in_array($col, ['int', 'integer', 'mediumint'], true)) { return ['type' => TableSchemaInterface::TYPE_INTEGER, 'length' => null, 'unsigned' => $unsigned]; } if ($col === 'char' && $length === 36) { @@ -376,11 +434,16 @@ protected function _convertColumn(string $column): array if ($col === 'uuid') { return ['type' => TableSchemaInterface::TYPE_NATIVE_UUID, 'length' => null]; } - if (str_contains($col, 'blob') || in_array($col, ['binary', 'varbinary'])) { + if (str_contains($col, 'blob') || in_array($col, ['binary', 'varbinary'], true)) { $lengthName = substr($col, 0, -4); $length = TableSchema::$columnLengths[$lengthName] ?? $length; - return ['type' => TableSchemaInterface::TYPE_BINARY, 'length' => $length]; + $result = ['type' => TableSchemaInterface::TYPE_BINARY, 'length' => $length]; + if ($col === 'binary') { + $result['fixed'] = true; + } + + return $result; } if (str_contains($col, 'float') || str_contains($col, 'double')) { return [ @@ -402,7 +465,7 @@ protected function _convertColumn(string $column): array if (str_contains($col, 'json')) { return ['type' => TableSchemaInterface::TYPE_JSON, 'length' => null]; } - if (in_array($col, TableSchemaInterface::GEOSPATIAL_TYPES)) { + if (in_array($col, TableSchemaInterface::GEOSPATIAL_TYPES, true)) { // TODO how can srid be preserved? It doesn't come back // in the output of show full columns from ... return [ @@ -568,6 +631,41 @@ public function describeForeignKeys(string $tableName): array return array_values($keys); } + /** + * @inheritDoc + */ + public function describeCheckConstraints(string $tableName): array + { + if (!$this->_driver->supports(DriverFeatureEnum::CHECK_CONSTRAINTS)) { + return []; + } + + [$schema, $name] = $this->splitTablename($tableName); + $sql = <<_driver->execute($sql, [$schema, $name]); + foreach ($statement->fetchAll('assoc') as $row) { + $constraints[] = [ + 'name' => $row['name'], + 'type' => TableSchema::CONSTRAINT_CHECK, + 'expression' => $row['expression'], + ]; + } + + return $constraints; + } + /** * @inheritDoc */ @@ -639,6 +737,7 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_POINT => ' POINT', TableSchemaInterface::TYPE_LINESTRING => ' LINESTRING', TableSchemaInterface::TYPE_POLYGON => ' POLYGON', + TableSchemaInterface::TYPE_BIT => ' BIT', ]; $specialMap = [ 'string' => true, @@ -674,6 +773,7 @@ public function columnDefinitionSql(array $column): string if ($isKnownLength) { $length = array_search($column['length'], TableSchema::$columnLengths); assert(is_string($length)); + unset($column['length']); $out .= ' ' . strtoupper($length) . 'BLOB'; break; } @@ -683,10 +783,10 @@ public function columnDefinitionSql(array $column): string break; } - if ($column['length'] > 2) { - $out .= ' VARBINARY(' . $column['length'] . ')'; + if (!empty($column['fixed'])) { + $out .= ' BINARY'; } else { - $out .= ' BINARY(' . $column['length'] . ')'; + $out .= ' VARBINARY'; } break; } @@ -697,7 +797,13 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_SMALLINTEGER, TableSchemaInterface::TYPE_TINYINTEGER, TableSchemaInterface::TYPE_STRING, + TableSchemaInterface::TYPE_BINARY, + TableSchemaInterface::TYPE_BIT, ]; + if (!isset($typeMap[$column['type']]) && !isset($specialMap[$column['type']])) { + $out .= ' ' . strtoupper($column['type']); + $hasLength[] = $column['type']; + } if (in_array($column['type'], $hasLength, true) && isset($column['length'])) { $out .= '(' . $column['length'] . ')'; } @@ -742,6 +848,7 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_TEXT, TableSchemaInterface::TYPE_CHAR, TableSchemaInterface::TYPE_STRING, + TableSchemaInterface::TYPE_UUID, ]; if (in_array($column['type'], $hasCollate, true) && isset($column['collate']) && $column['collate'] !== '') { $out .= ' COLLATE ' . $column['collate']; @@ -822,7 +929,7 @@ public function columnSql(TableSchema $schema, string $name): string $data = $schema->getColumn($name); assert($data !== null); - // TODO deprecrate Type defined schema mappings? + // TODO deprecate Type defined schema mappings? $sql = $this->_getTypeSpecificColumnSql($data['type'], $schema, $name); if ($sql !== null) { return $sql; @@ -865,9 +972,10 @@ public function constraintSql(TableSchema $schema, string $name): string $out = ''; if ($data['type'] === TableSchema::CONSTRAINT_UNIQUE) { $out = 'UNIQUE KEY '; - } - if ($data['type'] === TableSchema::CONSTRAINT_FOREIGN) { + } elseif ($data['type'] === TableSchema::CONSTRAINT_FOREIGN) { $out = 'CONSTRAINT '; + } elseif ($data['type'] === TableSchema::CONSTRAINT_CHECK) { + return 'CONSTRAINT ' . $this->_driver->quoteIdentifier($name) . ' CHECK (' . $data['expression'] . ')'; } $out .= $this->_driver->quoteIdentifier($name); diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/PostgresSchemaDialect.php b/app/vendor/cakephp/cakephp/src/Database/Schema/PostgresSchemaDialect.php index dde174f89..0357240ba 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/PostgresSchemaDialect.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/PostgresSchemaDialect.php @@ -30,6 +30,11 @@ class PostgresSchemaDialect extends SchemaDialect */ public const DEFAULT_SRID = 4326; + /** + * @const string + */ + public const GENERATED_BY_DEFAULT = 'BY DEFAULT'; + /** * Generate the SQL to list the tables and views. * @@ -118,7 +123,7 @@ private function describeColumnQuery(): string */ protected function _convertColumn(string $column): array { - preg_match('/([a-z\s]+)(?:\(([a-z0-9,]+)(?:,\s*([0-9]+))?\))?/i', $column, $matches); + preg_match('/([a-z\s]+)(?:\(([0-9,]+)\))?/i', $column, $matches); if (!$matches) { throw new DatabaseException(sprintf('Unable to parse column type from `%s`', $column)); } @@ -139,7 +144,7 @@ protected function _convertColumn(string $column): array return $type; } - if (in_array($col, ['date', 'time', 'boolean'], true)) { + if (in_array($col, ['date', 'time', 'boolean', 'inet', 'cidr', 'macaddr', 'citext', 'interval'], true)) { return ['type' => $col, 'length' => null]; } if (in_array($col, ['timestamptz', 'timestamp with time zone'], true)) { @@ -160,9 +165,6 @@ protected function _convertColumn(string $column): array if ($col === 'smallint') { return ['type' => TableSchemaInterface::TYPE_SMALLINTEGER, 'length' => 5]; } - if ($col === 'inet') { - return ['type' => TableSchemaInterface::TYPE_STRING, 'length' => 39]; - } if ($col === 'uuid') { return ['type' => TableSchemaInterface::TYPE_UUID, 'length' => null]; } @@ -192,11 +194,9 @@ protected function _convertColumn(string $column): array if (str_contains($col, 'json')) { return ['type' => TableSchemaInterface::TYPE_JSON, 'length' => null]; } - if ($col === 'geography') { - $srid = (int)($matches[3] ?? self::DEFAULT_SRID); - $type = strtolower($matches[2] ?? 'point'); - return ['type' => $type, 'length' => null, 'srid' => $srid]; + if (in_array($col, ['geometry', 'geography'], true)) { + return ['type' => $col, 'length' => null]; } $length = is_numeric($length) ? $length : null; @@ -282,7 +282,11 @@ public function describeColumns(string $tableName): array $statement = $this->_driver->execute($sql, [$name, $schema, $config['database']]); $columns = []; foreach ($statement->fetchAll('assoc') as $row) { - $field = $this->_convertColumn($row['type']); + $type = $row['type']; + if ($type === 'USER-DEFINED') { + $type = $row['udt_name']; + } + $field = $this->_convertColumn($type); if ($field['type'] === TableSchemaInterface::TYPE_BOOLEAN) { if ($row['default'] === 'true') { $row['default'] = 1; @@ -370,7 +374,8 @@ private function describeIndexQuery(): string c2.relname, a.attname, i.indisprimary, - i.indisunique + i.indisunique, + i.indnkeyatts FROM pg_catalog.pg_namespace n INNER JOIN pg_catalog.pg_class c ON (n.oid = c.relnamespace) INNER JOIN pg_catalog.pg_index i ON (c.oid = i.indrelid) @@ -437,6 +442,7 @@ public function describeIndexes(string $tableName): array $type = TableSchema::INDEX_INDEX; $name = $row['relname']; $constraint = null; + $includeColumnIndex = $row['indnkeyatts']; if ($row['indisprimary']) { $constraint = $name; $name = TableSchema::CONSTRAINT_PRIMARY; @@ -456,7 +462,11 @@ public function describeIndexes(string $tableName): array if ($constraint) { $indexes[$name]['constraint'] = $constraint; } - $indexes[$name]['columns'][] = $row['attname']; + if (count($indexes[$name]['columns']) < $includeColumnIndex) { + $indexes[$name]['columns'][] = $row['attname']; + } else { + $indexes[$name]['include'][] = $row['attname']; + } } return array_values($indexes); @@ -506,6 +516,7 @@ public function convertForeignKeyDescription(TableSchema $schema, array $row): v 'references' => [$row['references_table'], $row['references_field']], 'update' => $this->_convertOnClause($row['on_update']), 'delete' => $this->_convertOnClause($row['on_delete']), + 'deferrable' => $this->convertDeferrable($row), ]; $schema->addConstraint($row['name'], $data); } @@ -529,6 +540,7 @@ public function describeForeignKeys(string $tableName): array 'references' => [$row['references_table'], []], 'update' => $this->_convertOnClause($row['on_update']), 'delete' => $this->_convertOnClause($row['on_delete']), + 'deferrable' => $this->convertDeferrable($row), ]; } // column indexes start at 1 @@ -567,7 +579,9 @@ private function describeForeignKeyQuery(): string c.confdeltype AS on_delete, c.confrelid::regclass AS references_table, ab.attname AS references_field, - array_position(c.confkey, ab.attnum) AS references_field_order + array_position(c.confkey, ab.attnum) AS references_field_order, + c.condeferrable AS deferrable, + c.condeferred AS initially_deferred FROM pg_catalog.pg_namespace n INNER JOIN pg_catalog.pg_class cl ON (n.oid = cl.relnamespace) INNER JOIN pg_catalog.pg_constraint c ON (n.oid = c.connamespace) @@ -581,6 +595,34 @@ private function describeForeignKeyQuery(): string return $sql; } + /** + * @inheritDoc + */ + public function describeCheckConstraints(string $tableName): array + { + [$schema, $name] = $this->splitTablename($tableName); + $sql = 'SELECT + con.conname AS name, + pg_get_constraintdef(con.oid) AS expression + FROM pg_catalog.pg_constraint AS con + INNER JOIN pg_catalog.pg_namespace AS ns ON (ns.oid = con.connamespace) + INNER JOIN pg_catalog.pg_class AS cls ON (cls.oid = con.conrelid) + WHERE ns.nspname = ? AND cls.relname = ? AND con.contype = \'c\''; + + $results = []; + $statement = $this->_driver->execute($sql, [$schema, $name]); + foreach ($statement->fetchAll('assoc') as $row) { + $expression = preg_replace('/^CHECK \(\((.*)\)\)$/i', '$1', $row['expression']); + $results[] = [ + 'name' => $row['name'], + 'type' => TableSchema::CONSTRAINT_CHECK, + 'expression' => $expression, + ]; + } + + return $results; + } + /** * @inheritDoc */ @@ -607,6 +649,27 @@ protected function _convertOnClause(string $clause): string return TableSchema::ACTION_SET_NULL; } + /** + * Convert deferrable option from the postgres metadata into a string + * + * @param array $row The row to convert. + * @return string|null The deferrable value or null if not deferrable. + */ + protected function convertDeferrable(array $row): ?string + { + if (!isset($row['deferrable'])) { + return null; + } + if (!$row['deferrable']) { + return ForeignKey::NOT_DEFERRED; + } + if (isset($row['initially_deferred']) && $row['initially_deferred']) { + return ForeignKey::DEFERRED; + } + + return ForeignKey::IMMEDIATE; + } + /** * @inheritDoc */ @@ -653,6 +716,7 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_SMALLINTEGER => ' SMALLINT', TableSchemaInterface::TYPE_INTEGER => ' INT', TableSchemaInterface::TYPE_BIGINTEGER => ' BIGINT', + TableSchemaInterface::TYPE_BINARY => ' BYTEA', TableSchemaInterface::TYPE_BINARY_UUID => ' UUID', TableSchemaInterface::TYPE_BOOLEAN => ' BOOLEAN', TableSchemaInterface::TYPE_FLOAT => ' FLOAT', @@ -667,11 +731,16 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_UUID => ' UUID', TableSchemaInterface::TYPE_NATIVE_UUID => ' UUID', TableSchemaInterface::TYPE_CHAR => ' CHAR', + TableSchemaInterface::TYPE_CITEXT => ' CITEXT', TableSchemaInterface::TYPE_JSON => ' JSONB', + TableSchemaInterface::TYPE_INTERVAL => ' INTERVAL', TableSchemaInterface::TYPE_GEOMETRY => ' GEOGRAPHY(GEOMETRY, %s)', TableSchemaInterface::TYPE_POINT => ' GEOGRAPHY(POINT, %s)', TableSchemaInterface::TYPE_LINESTRING => ' GEOGRAPHY(LINESTRING, %s)', TableSchemaInterface::TYPE_POLYGON => ' GEOGRAPHY(POLYGON, %s)', + TableSchemaInterface::TYPE_CIDR => ' CIDR', + TableSchemaInterface::TYPE_INET => ' INET', + TableSchemaInterface::TYPE_MACADDR => ' MACADDR', ]; $autoIncrementTypes = [ @@ -681,30 +750,32 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_BIGINTEGER, ]; $autoIncrement = (bool)($column['autoIncrement'] ?? false); - if ( + $isAutoincrement = ( in_array($column['type'], $autoIncrementTypes, true) && $autoIncrement - ) { + ); + $version = $this->_driver->version(); + $identityVersion = version_compare($version, '10.0', '>='); + + if ($isAutoincrement && !$identityVersion) { $typeMap[$column['type']] = str_replace('INT', 'SERIAL', $typeMap[$column['type']]); unset($column['default']); } + $foundType = false; if (isset($typeMap[$column['type']])) { $out .= $typeMap[$column['type']]; + $foundType = true; } + $hasLength = [ + TableSchemaInterface::TYPE_CHAR, + TableSchemaInterface::TYPE_STRING, + ]; if ($column['type'] === TableSchemaInterface::TYPE_TEXT && $column['length'] !== TableSchema::LENGTH_TINY) { $out .= ' TEXT'; - } - if ($column['type'] === TableSchemaInterface::TYPE_BINARY) { - $out .= ' BYTEA'; - } - - if ($column['type'] === TableSchemaInterface::TYPE_CHAR) { - $out .= '(' . $column['length'] . ')'; - } - - if ( + $foundType = true; + } elseif ( $column['type'] === TableSchemaInterface::TYPE_STRING || ( $column['type'] === TableSchemaInterface::TYPE_TEXT && @@ -712,9 +783,17 @@ public function columnDefinitionSql(array $column): string ) ) { $out .= ' VARCHAR'; - if (isset($column['length']) && $column['length'] !== '') { - $out .= '(' . $column['length'] . ')'; - } + $hasLength[] = $column['type']; + $foundType = true; + } + + if (!$foundType) { + $out .= ' ' . strtoupper($column['type']); + $hasLength[] = $column['type']; + } + + if (in_array($column['type'], $hasLength, true) && !empty($column['length'])) { + $out .= '(' . $column['length'] . ')'; } $hasCollate = [ @@ -755,6 +834,11 @@ public function columnDefinitionSql(array $column): string $out .= ' NOT NULL'; } + if ($isAutoincrement && $identityVersion) { + $generated = $column['generated'] ?? static::GENERATED_BY_DEFAULT; + $out .= ' GENERATED ' . $generated . ' AS IDENTITY'; + } + $datetimeTypes = [ TableSchemaInterface::TYPE_DATETIME, TableSchemaInterface::TYPE_DATETIME_FRACTIONAL, @@ -828,18 +912,26 @@ public function dropConstraintSql(TableSchema $schema): array */ public function indexSql(TableSchema $schema, string $name): string { - $data = $schema->getIndex($name); - assert($data !== null); + $index = $schema->index($name); $columns = array_map( $this->_driver->quoteIdentifier(...), - $data['columns'], + (array)$index->getColumns(), ); + $include = ''; + if ($index->getInclude()) { + $included = array_map( + $this->_driver->quoteIdentifier(...), + $index->getInclude(), + ); + $include = sprintf(' INCLUDE (%s)', implode(', ', $included)); + } return sprintf( - 'CREATE INDEX %s ON %s (%s)', + 'CREATE INDEX %s ON %s (%s)%s', $this->_driver->quoteIdentifier($name), $this->_driver->quoteIdentifier($schema->name()), implode(', ', $columns), + $include, ); } @@ -853,9 +945,10 @@ public function constraintSql(TableSchema $schema, string $name): string $out = 'CONSTRAINT ' . $this->_driver->quoteIdentifier($name); if ($data['type'] === TableSchema::CONSTRAINT_PRIMARY) { $out = 'PRIMARY KEY'; - } - if ($data['type'] === TableSchema::CONSTRAINT_UNIQUE) { + } elseif ($data['type'] === TableSchema::CONSTRAINT_UNIQUE) { $out .= ' UNIQUE'; + } elseif ($data['type'] === TableSchema::CONSTRAINT_CHECK) { + return $out . ' CHECK (' . $data['expression'] . ')'; } return $this->_keySql($out, $data); @@ -876,12 +969,14 @@ protected function _keySql(string $prefix, array $data): string ); if ($data['type'] === TableSchema::CONSTRAINT_FOREIGN) { return $prefix . sprintf( - ' FOREIGN KEY (%s) REFERENCES %s (%s) ON UPDATE %s ON DELETE %s DEFERRABLE INITIALLY IMMEDIATE', + ' FOREIGN KEY (%s) REFERENCES %s (%s) ON UPDATE %s ON DELETE %s %s', implode(', ', $columns), $this->_driver->quoteIdentifier($data['references'][0]), $this->_convertConstraintColumns($data['references'][1]), $this->_foreignOnClause($data['update']), $this->_foreignOnClause($data['delete']), + // Historically CakePHP used 'DEFERRABLE INITIALLY IMEDIATE, and this maintains backwards compat. + $data['deferrable'] ?? ForeignKey::IMMEDIATE, ); } diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/SchemaDialect.php b/app/vendor/cakephp/cakephp/src/Database/Schema/SchemaDialect.php index 400763ed8..bd6980420 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/SchemaDialect.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/SchemaDialect.php @@ -36,7 +36,7 @@ * of each result will be documented in this class. Subclasses * are free to include *additional* data that is not documented. * - * @method array listTablesWithoutViewsSql(array $config) Generate the SQL to list the tables, excluding all views. + * @method array listTablesWithoutViewsSql(array $config) Generate the SQL to list the tables, excluding all views. */ abstract class SchemaDialect { @@ -140,7 +140,7 @@ protected function _getTypeSpecificColumnSql( TableSchemaInterface $schema, string $column, ): ?string { - if (!TypeFactory::getMap($columnType)) { + if (!TypeFactory::getMapped($columnType)) { return null; } @@ -158,12 +158,12 @@ protected function _getTypeSpecificColumnSql( * * @param string $columnType The column type. * @param array $definition The column definition. - * @return array|null Array of column information, or `null` in case no corresponding type was found or the type - * didn't provide custom column information. + * @return array|null Array of column information, or `null` + * in case no corresponding type was found or the type didn't provide custom column information. */ protected function _applyTypeSpecificColumnConversion(string $columnType, array $definition): ?array { - if (!TypeFactory::getMap($columnType)) { + if (!TypeFactory::getMapped($columnType)) { return null; } @@ -394,11 +394,18 @@ public function listTablesWithoutViews(): array /** * Get the list of tables and views available in the current connection. * + * @param string|null $schema The schema to get the tables for. If null the default schema is used. * @return array The list of tables and views in the connected database/schema. */ - public function listTables(): array + public function listTables(?string $schema = null): array { - [$sql, $params] = $this->listTablesSql($this->_driver->config()); + $config = $this->_driver->config(); + if ($schema !== null) { + $config['schema'] = $schema; + // Set database for MySQL + $config['database'] = $schema; + } + [$sql, $params] = $this->listTablesSql($config); $result = []; $statement = $this->_driver->execute($sql, $params); while ($row = $statement->fetch()) { @@ -437,6 +444,9 @@ public function describe(string $name): TableSchemaInterface foreach ($this->describeForeignKeys($name) as $key) { $table->addConstraint($key['name'], $key); } + foreach ($this->describeCheckConstraints($name) as $key) { + $table->addConstraint($key['name'], $key); + } $options = $this->describeOptions($name); if ($options) { $table->setOptions($options); @@ -617,6 +627,22 @@ public function describeOptions(string $tableName): array return $table->getOptions(); } + /** + * Get a list of check constraint metadata as an array. + * + * Each item in the array will contain the following keys: + * + * - name - The name of the constraint. + * - expression - The check constraint expression as a SQL fragment. + * + * @param string $tableName The name of the table to describe options on. + * @return array + */ + public function describeCheckConstraints(string $tableName): array + { + return []; + } + /** * Check if a table has a column with a given name. * @@ -644,11 +670,12 @@ public function hasColumn(string $tableName, string $columnName): bool * Check if a table exists * * @param string $tableName The name of the table + * @param string|null $schema The schema look for table in. If null the default schema is used. * @return bool */ - public function hasTable(string $tableName): bool + public function hasTable(string $tableName, ?string $schema = null): bool { - $tables = $this->listTables(); + $tables = $this->listTables($schema); return in_array($tableName, $tables, true); } @@ -676,13 +703,19 @@ public function hasIndex(string $tableName, array $columns = [], ?string $name = $found = $index; break; } - if ($columns === [] && $name !== null && $index['name'] === $name) { - $found = $index; - break; + if ($columns === [] && $name !== null) { + if ($index['name'] === $name) { + $found = $index; + break; + } + if (isset($index['constraint']) && $index['constraint'] === $name) { + $found = $index; + break; + } } } // Both columns and name provided, both must match; - if ($found !== null && $name !== null && $found['name'] !== $name) { + if ($columns && $found && $name !== null && $found['name'] !== $name) { return false; } @@ -693,7 +726,7 @@ public function hasIndex(string $tableName, array $columns = [], ?string $name = * Check if a table has a foreign key with a given name. * * @param string $tableName The name of the table - * @param array $columns The columns in the foriegn key. Specific + * @param array $columns The columns in the foreign key. Specific * ordering matters. * @param string $name The name of the foreign key to match on. Can be used alone, * or with $columns to match keys more precisely. diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/SqliteSchemaDialect.php b/app/vendor/cakephp/cakephp/src/Database/Schema/SqliteSchemaDialect.php index 2e344fe4d..76aa4e234 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/SqliteSchemaDialect.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/SqliteSchemaDialect.php @@ -101,7 +101,7 @@ protected function _convertColumn(string $column): array 'unsigned' => $unsigned, ]; } - if (in_array($col, ['float', 'real', 'double'])) { + if (in_array($col, ['float', 'real', 'double'], true)) { return [ 'type' => TableSchemaInterface::TYPE_FLOAT, 'length' => $length, @@ -127,7 +127,7 @@ protected function _convertColumn(string $column): array return ['type' => TableSchemaInterface::TYPE_STRING, 'length' => $length]; } - if (in_array($col, ['blob', 'clob', 'binary', 'varbinary'])) { + if (in_array($col, ['blob', 'clob', 'binary', 'varbinary'], true)) { return ['type' => TableSchemaInterface::TYPE_BINARY, 'length' => $length]; } @@ -140,17 +140,21 @@ protected function _convertColumn(string $column): array 'datetime', 'datetimefractional', ]; - if (in_array($col, $datetimeTypes)) { + if (in_array($col, $datetimeTypes, true)) { return ['type' => $col, 'length' => null]; } - if (Configure::read('ORM.mapJsonTypeForSqlite') === true) { - if (str_contains($col, TableSchemaInterface::TYPE_JSON) && !str_contains($col, 'jsonb')) { - return ['type' => TableSchemaInterface::TYPE_JSON, 'length' => null]; - } + if ( + Configure::read('ORM.mapJsonTypeForSqlite') === true && + ( + str_contains($col, TableSchemaInterface::TYPE_JSON) && + !str_contains($col, 'jsonb') + ) + ) { + return ['type' => TableSchemaInterface::TYPE_JSON, 'length' => null]; } - if (in_array($col, TableSchemaInterface::GEOSPATIAL_TYPES)) { + if (in_array($col, TableSchemaInterface::GEOSPATIAL_TYPES, true)) { // TODO how can srid be preserved? It doesn't come back // in the output of show full columns from ... return [ @@ -213,7 +217,7 @@ public function convertColumnDescription(TableSchema $schema, array $row): void $field = $this->_convertColumn($row['type']); $field += [ 'null' => !$row['notnull'], - 'default' => $this->_defaultValue($row['dflt_value']), + 'default' => $this->_defaultValue($row['dflt_value'], $row['type']), ]; $primary = $schema->getConstraint('primary'); @@ -264,9 +268,8 @@ private function describeColumnQuery(string $tableName): string */ public function describeColumns(string $tableName): array { - $config = $this->_driver->config(); if (str_contains($tableName, '.')) { - [$config['schema'], $tableName] = explode('.', $tableName); + [, $tableName] = explode('.', $tableName); } $sql = $this->describeColumnQuery($tableName); $columns = []; @@ -278,7 +281,7 @@ public function describeColumns(string $tableName): array $field += [ 'name' => $name, 'null' => !$row['notnull'], - 'default' => $this->_defaultValue($row['dflt_value']), + 'default' => $this->_defaultValue($row['dflt_value'], $row['type']), 'comment' => null, 'length' => null, ]; @@ -304,14 +307,23 @@ public function describeColumns(string $tableName): array * We need to remove those. * * @param string|int|null $default The default value. + * @param string|null $type The column type. * @return string|int|null */ - protected function _defaultValue(string|int|null $default): string|int|null + protected function _defaultValue(string|int|null $default, ?string $type = null): string|int|null { if ($default === 'NULL' || $default === null) { return null; } + if ($type !== null && strtolower($type) === TableSchemaInterface::TYPE_BOOLEAN) { + if ($default === '0' || $default === '1') { + return (int)$default; + } + + return (int)filter_var($default, FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE); + } + // Remove quotes if (is_string($default) && preg_match("/^'(.*)'$/", $default, $matches)) { return str_replace("''", "'", $matches[1]); @@ -391,7 +403,7 @@ protected function normalizePossiblyQuotedIdentifier(string $value): string public function convertIndexDescription(TableSchema $schema, array $row): void { // Skip auto-indexes created for non-ROWID primary keys. - if ($row['origin'] === 'pk') { + if (($row['origin'] ?? null) === 'pk') { return; } @@ -405,7 +417,7 @@ public function convertIndexDescription(TableSchema $schema, array $row): void $columns[] = $column['name']; } if ($row['unique']) { - if ($row['origin'] === 'u') { + if (($row['origin'] ?? null) === 'u') { $createTableSql = $this->getCreateTableSql($schema->name()); $name = $this->extractIndexName($createTableSql, 'UNIQUE', $columns); if ($name !== null) { @@ -465,6 +477,37 @@ private function extractIndexName(string $tableSql, string $type, array $columns return null; } + /** + * Try to extract the deferrable clause from the table SQL. + * + * @param string $tableSql The create table statement + * @param array $columns The columns in the index. + * @return string|null The name of the unique index if it could be inferred. + */ + private function extractDeferrable(string $tableSql, array $columns): ?string + { + $columnsPattern = implode( + '\s*,\s*', + array_map( + fn($column) => '(?:' . $this->possiblyQuotedIdentifierRegex($column) . ')', + $columns, + ), + ); + $regex = "/CONSTRAINT\s*(?.+?)\s*FOREIGN\s+KEY\s*\(\s*{$columnsPattern}\s*\).*?' . + '(?((?:NOT\s+)?DEFERRABLE)?(?:\s+INITIALLY\s+(DEFERRED|IMMEDIATE)))?/i"; + + if (preg_match($regex, $tableSql, $matches)) { + return match ($matches['deferable']) { + 'NOT DEFERRABLE' => ForeignKey::NOT_DEFERRED, + 'DEFERRABLE INITIALLY DEFERRED' => ForeignKey::DEFERRED, + 'DEFERRABLE INITIALLY IMMEDIATE' => ForeignKey::IMMEDIATE, + default => null, + }; + } + + return null; + } + /** * Get the normalized SQL query used to create a table. * @@ -485,9 +528,8 @@ private function getCreateTableSql(string $tableName): string */ public function describeIndexes(string $tableName): array { - $config = $this->_driver->config(); if (str_contains($tableName, '.')) { - [$config['schema'], $tableName] = explode('.', $tableName); + [, $tableName] = explode('.', $tableName); } $sql = $this->describeIndexQuery($tableName); $statement = $this->_driver->execute($sql); @@ -511,7 +553,7 @@ public function describeIndexes(string $tableName): array if ($row['unique']) { $indexType = TableSchema::CONSTRAINT_UNIQUE; } - if ($row['origin'] === 'pk') { + if (($row['origin'] ?? null) === 'pk') { $indexType = TableSchema::CONSTRAINT_PRIMARY; $foundPrimary = true; } @@ -609,9 +651,8 @@ public function convertForeignKeyDescription(TableSchema $schema, array $row): v */ public function describeForeignKeys(string $tableName): array { - $config = $this->_driver->config(); if (str_contains($tableName, '.')) { - [$config['schema'], $tableName] = explode('.', $tableName); + [, $tableName] = explode('.', $tableName); } $keys = []; @@ -627,7 +668,7 @@ public function describeForeignKeys(string $tableName): array 'references' => [$row['table'], []], 'update' => $this->_convertOnClause($row['on_update'] ?? ''), 'delete' => $this->_convertOnClause($row['on_delete'] ?? ''), - 'length' => [], + 'deferrable' => null, ]; } $keys[$id]['columns'][$row['seq']] = $row['from']; @@ -649,11 +690,45 @@ public function describeForeignKeys(string $tableName): array if (count($data['references'][1]) === 1) { $keys[$id]['references'][1] = $data['references'][1][0]; } + + // sqlite doesn't provide a simple way to get foreign key names, but we + // can extract them from the normalized create table sql. + $keys[$id]['deferrable'] = $this->extractDeferrable($createTableSql, $data['columns']); } return array_values($keys); } + /** + * @inheritDoc + */ + public function describeCheckConstraints(string $tableName): array + { + $constraints = []; + $createSql = $this->getCreateTableSql($tableName); + + // Parse CHECK constraints from CREATE TABLE statement + // Match CONSTRAINT name CHECK (expression) or just CHECK (expression) + $pattern = '/(?:CONSTRAINT\s+([^\s]+)\s+)?CHECK\s*\(([^)]+(?:\([^)]*\)[^)]*)*)\)/is'; + + if (preg_match_all($pattern, $createSql, $matches, PREG_SET_ORDER)) { + foreach ($matches as $index => $match) { + $name = !empty($match[1]) + ? trim($match[1], '"`[]') + : 'check_' . $index; + $expression = trim($match[2]); + + $constraints[] = [ + 'name' => $name, + 'type' => TableSchema::CONSTRAINT_CHECK, + 'expression' => $expression, + ]; + } + } + + return $constraints; + } + /** * @inheritDoc */ @@ -718,8 +793,10 @@ public function columnDefinitionSql(array $column): string ]; $typeMap = [ TableSchemaInterface::TYPE_BINARY_UUID => ' BINARY(16)', + TableSchemaInterface::TYPE_BINARY => ' BLOB', TableSchemaInterface::TYPE_UUID => ' CHAR(36)', TableSchemaInterface::TYPE_CHAR => ' CHAR', + TableSchemaInterface::TYPE_STRING => ' VARCHAR', TableSchemaInterface::TYPE_TINYINTEGER => ' TINYINT', TableSchemaInterface::TYPE_SMALLINTEGER => ' SMALLINT', TableSchemaInterface::TYPE_INTEGER => ' INTEGER', @@ -753,56 +830,44 @@ public function columnDefinitionSql(array $column): string $autoIncrement = (bool)($column['autoIncrement'] ?? false); if ( - $autoIncrement !== true && + !$autoIncrement && isset($column['unsigned']) && $column['unsigned'] === true && in_array($column['type'], $hasUnsigned, true) ) { $out .= ' UNSIGNED'; } + $foundType = false; if (isset($typeMap[$column['type']])) { $out .= $typeMap[$column['type']]; + $foundType = true; } + $hasLength = [ + TableSchemaInterface::TYPE_BINARY, + TableSchemaInterface::TYPE_STRING, + TableSchemaInterface::TYPE_CHAR, + TableSchemaInterface::TYPE_TINYINTEGER, + TableSchemaInterface::TYPE_SMALLINTEGER, + TableSchemaInterface::TYPE_INTEGER, + ]; if ($column['type'] === TableSchemaInterface::TYPE_TEXT && $column['length'] !== TableSchema::LENGTH_TINY) { $out .= ' TEXT'; - } - - if ($column['type'] === TableSchemaInterface::TYPE_CHAR) { - $out .= '(' . $column['length'] . ')'; - } - - if ( - $column['type'] === TableSchemaInterface::TYPE_STRING || - ( - $column['type'] === TableSchemaInterface::TYPE_TEXT && - $column['length'] === TableSchema::LENGTH_TINY - ) + $foundType = true; + } elseif ( + $column['type'] === TableSchemaInterface::TYPE_TEXT && + $column['length'] === TableSchema::LENGTH_TINY ) { $out .= ' VARCHAR'; - - if (isset($column['length'])) { - $out .= '(' . $column['length'] . ')'; - } + $hasLength[] = $column['type']; + $foundType = true; } - - if ($column['type'] === TableSchemaInterface::TYPE_BINARY) { - if (isset($column['length'])) { - $out .= ' BLOB(' . $column['length'] . ')'; - } else { - $out .= ' BLOB'; - } + if (!$foundType) { + $out .= ' ' . strtoupper($column['type']); + $hasLength[] = $column['type']; } - $integerTypes = [ - TableSchemaInterface::TYPE_TINYINTEGER, - TableSchemaInterface::TYPE_SMALLINTEGER, - TableSchemaInterface::TYPE_INTEGER, - ]; - if ( - in_array($column['type'], $integerTypes, true) && - isset($column['length']) && $autoIncrement !== true - ) { + if (in_array($column['type'], $hasLength, true) && isset($column['length']) && !$autoIncrement) { $out .= '(' . (int)$column['length'] . ')'; } @@ -861,45 +926,53 @@ public function constraintSql(TableSchema $schema, string $name): string $data = $schema->getConstraint($name); assert($data !== null, 'Data does not exist'); - $column = $schema->getColumn($data['columns'][0]); - assert($column !== null, 'Data does not exist'); + $columns = ''; + if (isset($data['columns'])) { + $column = $schema->getColumn($data['columns'][0]); + assert($column !== null, 'Data does not exist'); + + if ( + $data['type'] === TableSchema::CONSTRAINT_PRIMARY && + count($data['columns']) === 1 && + $column['type'] === TableSchemaInterface::TYPE_INTEGER + ) { + return ''; + } - if ( - $data['type'] === TableSchema::CONSTRAINT_PRIMARY && - count($data['columns']) === 1 && - $column['type'] === TableSchemaInterface::TYPE_INTEGER - ) { - return ''; + $aliased = array_map( + $this->_driver->quoteIdentifier(...), + $data['columns'], + ); + $columns = implode(', ', $aliased); } + $clause = ''; $type = ''; if ($data['type'] === TableSchema::CONSTRAINT_PRIMARY) { $type = 'PRIMARY KEY'; - } - if ($data['type'] === TableSchema::CONSTRAINT_UNIQUE) { + } elseif ($data['type'] === TableSchema::CONSTRAINT_UNIQUE) { $type = 'UNIQUE'; - } - if ($data['type'] === TableSchema::CONSTRAINT_FOREIGN) { + } elseif ($data['type'] === TableSchema::CONSTRAINT_FOREIGN) { $type = 'FOREIGN KEY'; - $clause = sprintf( - ' REFERENCES %s (%s) ON UPDATE %s ON DELETE %s', + $clause = rtrim(sprintf( + ' REFERENCES %s (%s) ON UPDATE %s ON DELETE %s %s', $this->_driver->quoteIdentifier($data['references'][0]), $this->_convertConstraintColumns($data['references'][1]), $this->_foreignOnClause($data['update']), $this->_foreignOnClause($data['delete']), - ); + $data['deferrable'] ?? null, + )); + } elseif ($data['type'] === TableSchema::CONSTRAINT_CHECK) { + $type = 'CHECK'; + $columns = $data['expression']; } - $columns = array_map( - $this->_driver->quoteIdentifier(...), - $data['columns'], - ); return sprintf( 'CONSTRAINT %s %s (%s)%s', $this->_driver->quoteIdentifier($name), $type, - implode(', ', $columns), + $columns, $clause, ); } diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/SqlserverSchemaDialect.php b/app/vendor/cakephp/cakephp/src/Database/Schema/SqlserverSchemaDialect.php index 8d98ae4d1..ac5910ddb 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/SqlserverSchemaDialect.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/SqlserverSchemaDialect.php @@ -137,7 +137,7 @@ protected function _convertColumn( return $type; } - if (in_array($col, ['date', 'time'])) { + if (in_array($col, ['date', 'time'], true)) { return ['type' => $col, 'length' => null]; } @@ -186,7 +186,7 @@ protected function _convertColumn( } // SqlServer schema reflection returns double length for unicode // columns because internally it uses UTF16/UCS2 - if ($col === 'nvarchar' || $col === 'nchar' || $col === 'ntext') { + if (in_array($col, ['nvarchar', 'nchar', 'ntext'], true)) { $length /= 2; } if (str_contains($col, 'varchar') && $length < 0) { @@ -207,7 +207,7 @@ protected function _convertColumn( if ($col === 'image' || str_contains($col, 'binary')) { // -1 is the value for MAX which we treat as a 'long' binary - if ($length == -1) { + if ($length === -1) { $length = TableSchema::LENGTH_LONG; } @@ -368,7 +368,8 @@ private function describeIndexQuery(): string IC.[index_column_id] AS [index_order], AC.[name] AS [column_name], I.[is_unique], I.[is_primary_key], - I.[is_unique_constraint] + I.[is_unique_constraint], + IC.[is_included_column] FROM sys.[tables] AS T INNER JOIN sys.[schemas] S ON S.[schema_id] = T.[schema_id] INNER JOIN sys.[indexes] I ON T.[object_id] = I.[object_id] @@ -448,7 +449,11 @@ public function describeIndexes(string $tableName): array 'length' => [], ]; } - $indexes[$name]['columns'][] = $row['column_name']; + if ($row['is_included_column']) { + $indexes[$name]['include'][] = $row['column_name']; + } else { + $indexes[$name]['columns'][] = $row['column_name']; + } if ($constraint) { $indexes[$name]['constraint'] = $constraint; } @@ -629,6 +634,7 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_BINARY_UUID => ' UNIQUEIDENTIFIER', TableSchemaInterface::TYPE_BOOLEAN => ' BIT', TableSchemaInterface::TYPE_CHAR => ' NCHAR', + TableSchemaInterface::TYPE_STRING => ' NVARCHAR', TableSchemaInterface::TYPE_FLOAT => ' FLOAT', TableSchemaInterface::TYPE_DECIMAL => ' DECIMAL', TableSchemaInterface::TYPE_DATE => ' DATE', @@ -647,10 +653,17 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_POLYGON => ' GEOGRAPHY', ]; + $foundType = false; if (isset($typeMap[$column['type']])) { $out .= $typeMap[$column['type']]; + $foundType = true; } + $hasLength = [ + TableSchemaInterface::TYPE_CHAR, + TableSchemaInterface::TYPE_STRING, + TableSchemaInterface::TYPE_BINARY, + ]; $autoIncrementTypes = [ TableSchemaInterface::TYPE_TINYINTEGER, TableSchemaInterface::TYPE_SMALLINTEGER, @@ -658,20 +671,20 @@ public function columnDefinitionSql(array $column): string TableSchemaInterface::TYPE_BIGINTEGER, ]; $autoIncrement = (bool)($column['autoIncrement'] ?? false); - if ( - in_array($column['type'], $autoIncrementTypes, true) && - $autoIncrement - ) { + if (in_array($column['type'], $autoIncrementTypes, true) && $autoIncrement) { $out .= ' IDENTITY(1, 1)'; + $foundType = true; unset($column['default']); } - if ($column['type'] === TableSchemaInterface::TYPE_TEXT && $column['length'] !== TableSchema::LENGTH_TINY) { + if ($column['type'] === TableSchemaInterface::TYPE_STRING && !isset($column['length'])) { + $column['length'] = TableSchema::LENGTH_TINY; + } elseif ( + $column['type'] === TableSchemaInterface::TYPE_TEXT && + $column['length'] !== TableSchema::LENGTH_TINY + ) { $out .= ' NVARCHAR(MAX)'; - } - - if ($column['type'] === TableSchemaInterface::TYPE_CHAR) { - $out .= '(' . $column['length'] . ')'; + $foundType = true; } if ($column['type'] === TableSchemaInterface::TYPE_BINARY) { @@ -683,24 +696,24 @@ public function columnDefinitionSql(array $column): string } if ($column['length'] === 1) { - $out .= ' BINARY(1)'; + $out .= ' BINARY'; } else { $out .= ' VARBINARY'; - - $out .= sprintf('(%s)', $column['length']); } + $foundType = true; } - if ( - $column['type'] === TableSchemaInterface::TYPE_STRING || - ( - $column['type'] === TableSchemaInterface::TYPE_TEXT && - $column['length'] === TableSchema::LENGTH_TINY - ) - ) { - $type = ' NVARCHAR'; - $length = $column['length'] ?? TableSchema::LENGTH_TINY; - $out .= sprintf('%s(%d)', $type, $length); + if ($column['type'] === TableSchemaInterface::TYPE_TEXT && $column['length'] === TableSchema::LENGTH_TINY) { + $out .= ' NVARCHAR'; + $hasLength[] = $column['type']; + $foundType = true; + } + if (!$foundType) { + $out .= ' ' . strtoupper($column['type']); + $hasLength[] = $column['type']; + } + if (in_array($column['type'], $hasLength, true) && isset($column['length'])) { + $out .= '(' . $column['length'] . ')'; } $hasCollate = [ @@ -725,10 +738,7 @@ public function columnDefinitionSql(array $column): string if ( $column['type'] === TableSchemaInterface::TYPE_DECIMAL && - ( - isset($column['length']) || - isset($column['precision']) - ) + (isset($column['length']) || isset($column['precision'])) ) { $out .= '(' . (int)$column['length'] . ',' . (int)$column['precision'] . ')'; } @@ -816,18 +826,27 @@ public function dropConstraintSql(TableSchema $schema): array */ public function indexSql(TableSchema $schema, string $name): string { - $data = $schema->getIndex($name); - assert($data !== null); + $index = $schema->index($name); $columns = array_map( $this->_driver->quoteIdentifier(...), - $data['columns'], + (array)$index->getColumns(), ); + $include = ''; + $included = $index->getInclude(); + if ($included !== null) { + $included = array_map( + $this->_driver->quoteIdentifier(...), + $included, + ); + $include = sprintf(' INCLUDE (%s)', implode(', ', $included)); + } return sprintf( - 'CREATE INDEX %s ON %s (%s)', + 'CREATE INDEX %s ON %s (%s)%s', $this->_driver->quoteIdentifier($name), $this->_driver->quoteIdentifier($schema->name()), implode(', ', $columns), + $include, ); } diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchema.php b/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchema.php index 86dd2e442..49c7b4479 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchema.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchema.php @@ -18,7 +18,6 @@ use Cake\Database\Connection; use Cake\Database\Exception\DatabaseException; -use Cake\Database\TypeFactory; /** * Represents a single table in a database schema. @@ -43,7 +42,7 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface /** * Columns in the table. * - * @var array + * @var array */ protected array $_columns = []; @@ -57,14 +56,14 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface /** * Indexes in the table. * - * @var array + * @var array */ protected array $_indexes = []; /** * Constraints in the table. * - * @var array> + * @var array */ protected array $_constraints = []; @@ -145,6 +144,9 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface 'text' => [ 'collate' => null, ], + 'uuid' => [ + 'collate' => null, + ], 'tinyinteger' => [ 'unsigned' => null, 'autoIncrement' => null, @@ -156,10 +158,12 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface 'integer' => [ 'unsigned' => null, 'autoIncrement' => null, + 'generated' => null, ], 'biginteger' => [ 'unsigned' => null, 'autoIncrement' => null, + 'generated' => null, ], 'decimal' => [ 'unsigned' => null, @@ -194,6 +198,9 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface 'timestamptimezone' => [ 'onUpdate' => null, ], + 'binary' => [ + 'fixed' => null, + ], ]; /** @@ -207,8 +214,12 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface 'columns' => [], 'length' => [], 'references' => [], + 'include' => null, 'update' => 'restrict', 'delete' => 'restrict', + 'constraint' => null, + 'deferrable' => null, + 'expression' => null, ]; /** @@ -230,6 +241,7 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface self::CONSTRAINT_PRIMARY, self::CONSTRAINT_UNIQUE, self::CONSTRAINT_FOREIGN, + self::CONSTRAINT_CHECK, ]; /** @@ -266,54 +278,61 @@ class TableSchema implements TableSchemaInterface, SqlGeneratorInterface */ public const CONSTRAINT_FOREIGN = 'foreign'; + /** + * check constraint type + * + * @var string + */ + public const CONSTRAINT_CHECK = 'check'; + /** * Index - index type * * @var string */ - public const INDEX_INDEX = 'index'; + public const INDEX_INDEX = Index ::INDEX; /** * Fulltext index type * * @var string */ - public const INDEX_FULLTEXT = 'fulltext'; + public const INDEX_FULLTEXT = Index::FULLTEXT; /** * Foreign key cascade action * * @var string */ - public const ACTION_CASCADE = 'cascade'; + public const ACTION_CASCADE = ForeignKey::CASCADE; /** * Foreign key set null action * * @var string */ - public const ACTION_SET_NULL = 'setNull'; + public const ACTION_SET_NULL = ForeignKey::SET_NULL; /** * Foreign key no action * * @var string */ - public const ACTION_NO_ACTION = 'noAction'; + public const ACTION_NO_ACTION = ForeignKey::NO_ACTION; /** * Foreign key restrict action * * @var string */ - public const ACTION_RESTRICT = 'restrict'; + public const ACTION_RESTRICT = ForeignKey::RESTRICT; /** * Foreign key restrict default * * @var string */ - public const ACTION_SET_DEFAULT = 'setDefault'; + public const ACTION_SET_DEFAULT = ForeignKey::SET_DEFAULT; /** * Constructor. @@ -340,7 +359,7 @@ public function name(): string /** * @inheritDoc */ - public function addColumn(string $name, $attrs) + public function addColumn(string $name, array|string $attrs) { if (is_string($attrs)) { $attrs = ['type' => $attrs]; @@ -349,9 +368,36 @@ public function addColumn(string $name, $attrs) if (isset(static::$_columnExtras[$attrs['type']])) { $valid += static::$_columnExtras[$attrs['type']]; } + $attrs = array_intersect_key($attrs, $valid); - $this->_columns[$name] = $attrs + $valid; - $this->_typeMap[$name] = $this->_columns[$name]['type']; + $attrs['name'] = $name; + foreach (array_keys($attrs) as $key) { + $value = $attrs[$key]; + if ($value === null) { + unset($attrs[$key]); + continue; + } + if ($key === 'autoIncrement') { + $attrs['identity'] = $value; + unset($attrs[$key]); + continue; + } + $attrs[$key] = $value; + } + + // Cast numeric values that may come as floats from database drivers. + // PHP 8.4 is stricter about implicit float-to-int conversions. + // Known to affect SQLite on Windows x86. + foreach (['length', 'precision', 'srid'] as $key) { + if (isset($attrs[$key])) { + $attrs[$key] = (int)$attrs[$key]; + } + } + + $column = new Column(...$attrs); + + $this->_columns[$name] = $column; + $this->_typeMap[$name] = $column->getType(); return $this; } @@ -383,7 +429,45 @@ public function getColumn(string $name): ?array return null; } $column = $this->_columns[$name]; - unset($column['baseType']); + $attrs = $column->toArray(); + + $expected = static::$_columnKeys; + if (isset(static::$_columnExtras[$attrs['type']])) { + $expected += static::$_columnExtras[$attrs['type']]; + } + // Remove any attributes that weren't in the allow list. + // This is to provide backwards compatible keys + $remove = array_diff(array_keys($attrs), array_keys($expected)); + foreach ($remove as $key) { + unset($attrs[$key]); + } + + if (isset($attrs['baseType']) && $attrs['baseType'] === $attrs['type']) { + unset($attrs['baseType']); + } + + return $attrs; + } + + /** + * Get a column object for a given column name. + * + * Will raise an exception if the column does not exist. + * + * @param string $name The name of the column to get. + * @return \Cake\Database\Schema\Column + */ + public function column(string $name): Column + { + $column = $this->_columns[$name] ?? null; + if ($column === null) { + $message = sprintf( + 'Table `%s` does not contain a column named `%s`.', + $this->_table, + $name, + ); + throw new DatabaseException($message); + } return $column; } @@ -397,7 +481,7 @@ public function getColumnType(string $name): ?string return null; } - return $this->_columns[$name]['type']; + return $this->_columns[$name]->getType(); } /** @@ -417,11 +501,11 @@ public function setColumnType(string $name, string $type) throw new DatabaseException($message); } - $this->_columns[$name]['type'] = $type; + $this->_columns[$name] + ->setType($type) + ->setBaseType(null); $this->_typeMap[$name] = $type; - unset($this->_columns[$name]['baseType']); - return $this; } @@ -438,21 +522,11 @@ public function hasColumn(string $name): bool */ public function baseColumnType(string $column): ?string { - if (isset($this->_columns[$column]['baseType'])) { - return $this->_columns[$column]['baseType']; - } - - $type = $this->getColumnType($column); - - if ($type === null) { + if (!isset($this->_columns[$column])) { return null; } - if (TypeFactory::getMap($type)) { - $type = TypeFactory::build($type)->getBaseType(); - } - - return $this->_columns[$column]['baseType'] = $type; + return $this->_columns[$column]->getBaseType(); } /** @@ -472,7 +546,7 @@ public function isNullable(string $name): bool return true; } - return $this->_columns[$name]['null'] === true; + return $this->_columns[$name]->getNull() === true; } /** @@ -481,14 +555,12 @@ public function isNullable(string $name): bool public function defaultValues(): array { $defaults = []; - foreach ($this->_columns as $name => $data) { - if (!array_key_exists('default', $data)) { - continue; - } - if ($data['default'] === null && $data['null'] !== true) { + foreach ($this->_columns as $column) { + $default = $column->getDefault(); + if ($default === null && $column->getNull() !== true && $column->getName()) { continue; } - $defaults[$name] = $data['default']; + $defaults[$column->getName()] = $default; } return $defaults; @@ -497,14 +569,21 @@ public function defaultValues(): array /** * @inheritDoc */ - public function addIndex(string $name, $attrs) + public function addIndex(string $name, array|string $attrs) { if (is_string($attrs)) { $attrs = ['type' => $attrs]; } $attrs = array_intersect_key($attrs, static::$_indexKeys); $attrs += static::$_indexKeys; - unset($attrs['references'], $attrs['update'], $attrs['delete']); + unset( + $attrs['references'], + $attrs['update'], + $attrs['delete'], + $attrs['constraint'], + $attrs['deferrable'], + $attrs['expression'], + ); if (!in_array($attrs['type'], static::$_validIndexTypes, true)) { throw new DatabaseException(sprintf( @@ -527,7 +606,9 @@ public function addIndex(string $name, $attrs) throw new DatabaseException($msg); } } - $this->_indexes[$name] = $attrs; + $attrs['name'] = $name; + + $this->_indexes[$name] = new Index(...$attrs); return $this; } @@ -548,8 +629,41 @@ public function getIndex(string $name): ?array if (!isset($this->_indexes[$name])) { return null; } + $index = $this->_indexes[$name]; + $attrs = $index->toArray(); + + $optional = ['order', 'include', 'where']; + foreach ($optional as $key) { + if ($attrs[$key] === null) { + unset($attrs[$key]); + } + } + unset($attrs['name']); - return $this->_indexes[$name]; + return $attrs; + } + + /** + * Get a index object for a given index name. + * + * Will raise an exception if no index can be found. + * + * @param string $name The name of the index to get. + * @return \Cake\Database\Schema\Index + */ + public function index(string $name): Index + { + $index = $this->_indexes[$name] ?? null; + if ($index === null) { + $message = sprintf( + 'Table `%s` does not contain a index named `%s`.', + $this->_table, + $name, + ); + throw new DatabaseException($message); + } + + return $index; } /** @@ -558,8 +672,8 @@ public function getIndex(string $name): ?array public function getPrimaryKey(): array { foreach ($this->_constraints as $data) { - if ($data['type'] === static::CONSTRAINT_PRIMARY) { - return $data['columns']; + if ($data->getType() === static::CONSTRAINT_PRIMARY) { + return (array)$data->getColumns(); } } @@ -569,13 +683,17 @@ public function getPrimaryKey(): array /** * @inheritDoc */ - public function addConstraint(string $name, $attrs) + public function addConstraint(string $name, array|string $attrs) { if (is_string($attrs)) { $attrs = ['type' => $attrs]; } $attrs = array_intersect_key($attrs, static::$_indexKeys); $attrs += static::$_indexKeys; + if ($attrs['constraint'] === null) { + unset($attrs['constraint']); + } + if (!in_array($attrs['type'], static::$_validConstraintTypes, true)) { throw new DatabaseException(sprintf( 'Invalid constraint type `%s` in table `%s`.', @@ -583,48 +701,80 @@ public function addConstraint(string $name, $attrs) $this->_table, )); } - if (empty($attrs['columns'])) { - throw new DatabaseException(sprintf( - 'Constraints in table `%s` must have at least one column.', - $this->_table, - )); - } - $attrs['columns'] = (array)$attrs['columns']; - foreach ($attrs['columns'] as $field) { - if (empty($this->_columns[$field])) { - $msg = sprintf( - 'Columns used in constraints must be added to the Table schema first. ' . - 'The column `%s` was not found in table `%s`.', - $field, + if ($attrs['type'] !== TableSchema::CONSTRAINT_CHECK) { + if (empty($attrs['columns'])) { + throw new DatabaseException(sprintf( + 'Constraints in table `%s` must have at least one column.', $this->_table, - ); - throw new DatabaseException($msg); + )); + } + $attrs['columns'] = (array)$attrs['columns']; + foreach ($attrs['columns'] as $field) { + if (empty($this->_columns[$field])) { + $msg = sprintf( + 'Columns used in constraints must be added to the Table schema first. ' . + 'The column `%s` was not found in table `%s`.', + $field, + $this->_table, + ); + throw new DatabaseException($msg); + } } } - if ($attrs['type'] === static::CONSTRAINT_FOREIGN) { - $attrs = $this->_checkForeignKey($attrs); + $attrs['name'] = $attrs['constraint'] ?? $name; + unset($attrs['constraint'], $attrs['include']); - if (isset($this->_constraints[$name])) { - $this->_constraints[$name]['columns'] = array_unique(array_merge( - $this->_constraints[$name]['columns'], + $type = $attrs['type'] ?? null; + if ($type === static::CONSTRAINT_FOREIGN) { + $attrs = $this->_checkForeignKey($attrs); + } elseif ($type === static::CONSTRAINT_PRIMARY) { + $attrs = [ + 'type' => $type, + 'name' => $attrs['name'], + 'columns' => $attrs['columns'], + ]; + } elseif ($type === static::CONSTRAINT_CHECK) { + $attrs = [ + 'name' => $attrs['name'], + 'expression' => $attrs['expression'], + ]; + } elseif ($type === static::CONSTRAINT_UNIQUE) { + $attrs = [ + 'name' => $attrs['name'], + 'columns' => $attrs['columns'], + 'length' => $attrs['length'], + ]; + } + if ($type === static::CONSTRAINT_FOREIGN) { + $constraint = $this->_constraints[$name] ?? null; + if ($constraint instanceof ForeignKey) { + // Update an existing foreign key constraint. + // This is backwards compatible with the incremental + // build API that I would like to deprecate. + $constraint->setColumns(array_unique(array_merge( + (array)$constraint->getColumns(), $attrs['columns'], - )); + ))); - if (isset($this->_constraints[$name]['references'])) { - $this->_constraints[$name]['references'][1] = array_unique(array_merge( - (array)$this->_constraints[$name]['references'][1], + if ($constraint->getReferencedTable()) { + $constraint->setColumns(array_unique(array_merge( + (array)$constraint->getReferencedColumns(), [$attrs['references'][1]], - )); + ))); } return $this; } - } else { - unset($attrs['references'], $attrs['update'], $attrs['delete']); } - $this->_constraints[$name] = $attrs; + $this->_constraints[$name] = match ($type) { + static::CONSTRAINT_UNIQUE => new UniqueKey(...$attrs), + static::CONSTRAINT_FOREIGN => new ForeignKey(...$attrs), + static::CONSTRAINT_PRIMARY => new Constraint(...$attrs), + static::CONSTRAINT_CHECK => new CheckConstraint(...$attrs), + default => new Constraint(...$attrs), + }; return $this; } @@ -649,7 +799,7 @@ public function dropConstraint(string $name) public function hasAutoincrement(): bool { foreach ($this->_columns as $column) { - if (isset($column['autoIncrement']) && $column['autoIncrement']) { + if ($column->getIdentity()) { return true; } } @@ -682,6 +832,11 @@ protected function _checkForeignKey(array $attrs): array )); } + // Map the backwards compatible attributes in. Need to check for existing instance. + $attrs['referencedTable'] = $attrs['references'][0]; + $attrs['referencedColumns'] = (array)$attrs['references'][1]; + unset($attrs['type'], $attrs['references'], $attrs['length'], $attrs['expression']); + return $attrs; } @@ -698,7 +853,56 @@ public function constraints(): array */ public function getConstraint(string $name): ?array { - return $this->_constraints[$name] ?? null; + $constraint = $this->_constraints[$name] ?? null; + if ($constraint === null) { + return null; + } + + $data = $constraint->toArray(); + if ($constraint instanceof ForeignKey) { + $data['references'] = [ + $constraint->getReferencedTable(), + $constraint->getReferencedColumns(), + ]; + // If there is only one referenced column, we return it as a string. + // TODO this should be deprecated, but I don't know how to warn about it. + if (count($data['references'][1]) === 1) { + $data['references'][1] = $data['references'][1][0]; + } + unset($data['referencedTable'], $data['referencedColumns']); + } + if ($constraint->getType() === static::CONSTRAINT_PRIMARY && $name === 'primary') { + $alias = $constraint->getName(); + if ($alias !== 'primary') { + $data['constraint'] = $alias; + } + } + unset($data['name']); + + return $data; + } + + /** + * Get a constraint object for a given constraint name. + * + * Constraints have a few subtypes such as foreign keys and primary keys. + * You can either use `instanceof` or getType() to check for subclass types. + * + * @param string $name The name of the constraint to get. + * @return \Cake\Database\Schema\Constraint A constraint object. + */ + public function constraint(string $name): Constraint + { + if (!isset($this->_constraints[$name])) { + $message = sprintf( + 'Table `%s` does not contain a constraint named `%s`.', + $this->_table, + $name, + ); + throw new DatabaseException($message); + } + + return $this->_constraints[$name]; } /** @@ -742,7 +946,7 @@ public function isTemporary(): bool */ public function createSql(Connection $connection): array { - $dialect = $connection->getDriver()->schemaDialect(); + $dialect = $connection->getWriteDriver()->schemaDialect(); $columns = []; $constraints = []; $indexes = []; @@ -764,7 +968,7 @@ public function createSql(Connection $connection): array */ public function dropSql(Connection $connection): array { - $dialect = $connection->getDriver()->schemaDialect(); + $dialect = $connection->getWriteDriver()->schemaDialect(); return $dialect->dropTableSql($this); } @@ -774,7 +978,7 @@ public function dropSql(Connection $connection): array */ public function truncateSql(Connection $connection): array { - $dialect = $connection->getDriver()->schemaDialect(); + $dialect = $connection->getWriteDriver()->schemaDialect(); return $dialect->truncateTableSql($this); } @@ -784,7 +988,7 @@ public function truncateSql(Connection $connection): array */ public function addConstraintSql(Connection $connection): array { - $dialect = $connection->getDriver()->schemaDialect(); + $dialect = $connection->getWriteDriver()->schemaDialect(); return $dialect->addConstraintSql($this); } @@ -794,11 +998,58 @@ public function addConstraintSql(Connection $connection): array */ public function dropConstraintSql(Connection $connection): array { - $dialect = $connection->getDriver()->schemaDialect(); + $dialect = $connection->getWriteDriver()->schemaDialect(); return $dialect->dropConstraintSql($this); } + /** + * Custom unserialization that handles compatibility + * with older CakePHP versions. + * + * Previously the `_columns`, `_indexes`, and `_constraints` + * attributes contained array data. As of 5.3, those attributes + * contain arrays of objects. + * + * @param array $data The serialized data. + * @return void + */ + public function __unserialize(array $data): void + { + $this->_table = $data["\0*\0_table"] ?? ''; + + $columns = $data["\0*\0_columns"] ?? []; + foreach ($columns as $name => $column) { + $name = (string)$name; + if (is_array($column)) { + $this->addColumn($name, $column); + } else { + $this->_columns[$name] = $column; + } + } + $indexes = $data["\0*\0_indexes"] ?? []; + foreach ($indexes as $name => $index) { + $name = (string)$name; + if (is_array($index)) { + $this->addIndex($name, $index); + } else { + $this->_indexes[$name] = $index; + } + } + $constraints = $data["\0*\0_constraints"] ?? []; + foreach ($constraints as $name => $constraint) { + $name = (string)$name; + if (is_array($constraint)) { + $this->addConstraint($name, $constraint); + } else { + $this->_constraints[$name] = $constraint; + } + } + $this->_options = $data["\0*\0_options"] ?? []; + $this->_typeMap = $data["\0*\0_typeMap"] ?? []; + $this->_temporary = $data["\0*\0_temporary"] ?? false; + } + /** * Returns an array of the table schema. * diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchemaInterface.php b/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchemaInterface.php index 7548d168a..6f068c037 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchemaInterface.php +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/TableSchemaInterface.php @@ -20,6 +20,10 @@ /** * An interface used by database TableSchema objects. + * + * @method \Cake\Database\Schema\Column column(string $name) + * @method \Cake\Database\Schema\Index index(string $name) + * @method \Cake\Database\Schema\Constraint constraint(string $name) */ interface TableSchemaInterface extends SchemaInterface { @@ -65,6 +69,15 @@ interface TableSchemaInterface extends SchemaInterface */ public const TYPE_TIME = 'time'; + /** + * Year column type + * + * Currently only implemented in MySQL + * + * @var string + */ + public const TYPE_YEAR = 'year'; + /** * Timestamp column type * @@ -86,6 +99,13 @@ interface TableSchemaInterface extends SchemaInterface */ public const TYPE_TIMESTAMP_TIMEZONE = 'timestamptimezone'; + /** + * Datetime interval. Only implemented in postgres. + * + * @var string + */ + public const TYPE_INTERVAL = 'interval'; + /** * JSON column type * @@ -107,6 +127,15 @@ interface TableSchemaInterface extends SchemaInterface */ public const TYPE_CHAR = 'char'; + /** + * Case-insensitive text column type. + * + * Only implemented in postgres + * + * @var string + */ + public const TYPE_CITEXT = 'citext'; + /** * Text column type * @@ -205,6 +234,36 @@ interface TableSchemaInterface extends SchemaInterface */ public const TYPE_POLYGON = 'polygon'; + /** + * INET type. Only implemented in postgres. + * + * @var string + */ + public const TYPE_INET = 'inet'; + + /** + * CIDR type. Only implemented in postgres. + * + * @var string + */ + public const TYPE_CIDR = 'cidr'; + + /** + * Macaddr type. Only implemented in postgres. + * + * @var string + */ + public const TYPE_MACADDR = 'macaddr'; + + /** + * Bit type. + * + * Currently only implemented in MySQL. + * + * @var string + */ + public const TYPE_BIT = 'bit'; + /** * Geospatial column types * @@ -285,7 +344,7 @@ public function indexes(): array; * Add a constraint. * * Used to add constraints to a table. For example primary keys, unique - * keys and foreign keys. + * keys, check constraints and foreign keys. * * ### Attributes * @@ -294,6 +353,7 @@ public function indexes(): array; * - `references` The table, column a foreign key references. * - `update` The behavior on update. Options are 'restrict', 'setNull', 'cascade', 'noAction'. * - `delete` The behavior on delete. Options are 'restrict', 'setNull', 'cascade', 'noAction'. + * - `expression` The SQL expression for check constraints. * * The default for 'update' & 'delete' is 'cascade'. * diff --git a/app/vendor/cakephp/cakephp/src/Database/Schema/UniqueKey.php b/app/vendor/cakephp/cakephp/src/Database/Schema/UniqueKey.php new file mode 100644 index 000000000..070773e23 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Database/Schema/UniqueKey.php @@ -0,0 +1,155 @@ + $columns The columns to constraint. + * @param array|null $length The length of the columns, if applicable. + */ + public function __construct( + protected string $name, + protected array $columns, + protected ?array $length = null, + ) { + $this->type = self::UNIQUE; + } + + /** + * Sets the constraint columns. + * + * @param array|string $columns Columns + * @return $this + */ + public function setColumns(string|array $columns) + { + $this->columns = (array)$columns; + + return $this; + } + + /** + * Gets the constraint columns. + * + * @return ?array + */ + public function getColumns(): ?array + { + return $this->columns; + } + + /** + * Sets the constraint type. + * + * @param string $type Type + * @return $this + */ + public function setType(string $type) + { + $this->type = $type; + + return $this; + } + + /** + * Gets the constraint type. + * + * @return string + */ + public function getType(): string + { + return $this->type; + } + + /** + * Sets the constraint name. + * + * @param string $name Name + * @return $this + */ + public function setName(string $name) + { + $this->name = $name; + + return $this; + } + + /** + * Gets the constraint name. + * + * @return ?string + */ + public function getName(): ?string + { + return $this->name; + } + + /** + * Sets the constraint length. + * + * In MySQL unique constraints can have limit clauses to control the number of + * characters indexed in text and char columns. + * + * @param array $length array of length values + * @return $this + */ + public function setLength(array $length) + { + $this->length = $length; + + return $this; + } + + /** + * Gets the constraint length. + * + * Can be an array of column names and lengths under MySQL. + * + * @return array|null + */ + public function getLength(): ?array + { + return $this->length; + } + + /** + * Converts a constraint to an array that is compatible + * with the constructor. + * + * @return array + */ + public function toArray(): array + { + return [ + 'name' => $this->name, + 'type' => $this->type, + 'columns' => $this->columns, + 'length' => $this->length, + ]; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Database/Statement/Statement.php b/app/vendor/cakephp/cakephp/src/Database/Statement/Statement.php index 21912c788..9c751784f 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Statement/Statement.php +++ b/app/vendor/cakephp/cakephp/src/Database/Statement/Statement.php @@ -96,7 +96,7 @@ public function bindValue(string|int $column, mixed $value, string|int|null $typ } /** - * Converts a give value to a suitable database value based on type and + * Converts a given value to a suitable database value based on type and * return relevant internal statement type. * * @param mixed $value The value to cast. diff --git a/app/vendor/cakephp/cakephp/src/Database/Type/BoolType.php b/app/vendor/cakephp/cakephp/src/Database/Type/BoolType.php index e91c3a37d..7287237f4 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Type/BoolType.php +++ b/app/vendor/cakephp/cakephp/src/Database/Type/BoolType.php @@ -36,7 +36,7 @@ class BoolType extends BaseType implements BatchCastingInterface */ public function toDatabase(mixed $value, Driver $driver): ?bool { - if ($value === true || $value === false || $value === null) { + if (in_array($value, [true, false, null], true)) { return $value; } diff --git a/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeTimezoneType.php b/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeTimezoneType.php index b48e9a59a..2e2b31ddf 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeTimezoneType.php +++ b/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeTimezoneType.php @@ -43,5 +43,6 @@ class DateTimeTimezoneType extends DateTimeType 'Y-m-d\TH:i:sP', 'Y-m-d\TH:i:s.u', 'Y-m-d\TH:i:s.uP', + '!Y-m-d', ]; } diff --git a/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeType.php b/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeType.php index 4ec62659f..03009496f 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeType.php +++ b/app/vendor/cakephp/cakephp/src/Database/Type/DateTimeType.php @@ -56,6 +56,7 @@ class DateTimeType extends BaseType implements BatchCastingInterface 'Y-m-d\TH:i:sP', 'Y-m-d\TH:i:s.u', 'Y-m-d\TH:i:s.uP', + '!Y-m-d', ]; /** @@ -166,7 +167,7 @@ public function toDatabase(mixed $value, Driver $driver): ?string * This is the time zone used when converting database strings to DateTime * instances and converting DateTime instances to database strings. * - * @see DateTimeType::setKeepDatabaseTimezone + * @see \Cake\Database\Type\DateTimeType::setKeepDatabaseTimezone() * @param \DateTimeZone|string|null $timezone Database timezone. * @return $this */ @@ -401,7 +402,7 @@ public function useLocaleParser(bool $enable = true) * See `Cake\I18n\Time::parseDateTime()` for accepted formats. * * @param array|string $format The locale-aware format - * @see \Cake\I18n\Time::parseDateTime() + * @see \Cake\I18n\DateTime::parseDateTime() * @return $this */ public function setLocaleFormat(array|string $format) diff --git a/app/vendor/cakephp/cakephp/src/Database/Type/EnumType.php b/app/vendor/cakephp/cakephp/src/Database/Type/EnumType.php index 707aee0b1..05b16036e 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Type/EnumType.php +++ b/app/vendor/cakephp/cakephp/src/Database/Type/EnumType.php @@ -25,6 +25,8 @@ use PDO; use ReflectionEnum; use ReflectionException; +use TypeError; +use ValueError; /** * Enum type converter. @@ -70,7 +72,7 @@ public function __construct( } $namedType = $reflectionEnum->getBackingType(); - if ($namedType == null) { + if ($namedType === null) { throw new DatabaseException( sprintf('Unable to use enum `%s` for type `%s`, must be a backed enum.', $enumClassName, $name), ); @@ -85,6 +87,7 @@ public function __construct( * @param mixed $value The value to convert. * @param \Cake\Database\Driver $driver The driver instance to convert with. * @return string|int|null + * @throws \InvalidArgumentException When the given value is not a valid value for the associated enum */ public function toDatabase(mixed $value, Driver $driver): string|int|null { @@ -92,36 +95,36 @@ public function toDatabase(mixed $value, Driver $driver): string|int|null return null; } - if ($value instanceof BackedEnum) { - if (!$value instanceof $this->enumClassName) { + if ($value instanceof $this->enumClassName) { + return $value->value; + } + + if ($this->backingType === 'int' && is_string($value)) { + $intVal = filter_var($value, FILTER_VALIDATE_INT); + if ($intVal !== false) { + $value = $intVal; + } + } + + try { + return $this->enumClassName::from($value)->value; + } catch (ValueError | TypeError $exception) { + if ($exception instanceof TypeError) { throw new InvalidArgumentException(sprintf( - 'Given value type `%s` does not match associated `%s` backed enum in `%s`', + 'Given value `%s` of type `%s` does not match associated `%s` backed enum in `%s`', + print_r($value, true), get_debug_type($value), $this->backingType, $this->enumClassName, )); } - return $value->value; - } - - if (!is_string($value) && !is_int($value)) { - throw new InvalidArgumentException(sprintf( - 'Cannot convert value `%s` of type `%s` to string or int', - print_r($value, true), - get_debug_type($value), - )); - } - - if ($this->enumClassName::tryFrom($value) === null) { throw new InvalidArgumentException(sprintf( '`%s` is not a valid value for `%s`', $value, $this->enumClassName, )); } - - return $value; } /** @@ -175,15 +178,6 @@ public function marshal(mixed $value): ?BackedEnum return $value; } - if (!is_string($value) && !is_int($value)) { - throw new InvalidArgumentException(sprintf( - 'Unable to marshal value `%s` of type `%s` to `%s`', - print_r($value, true), - get_debug_type($value), - $this->enumClassName, - )); - } - if ($this->backingType === 'int') { if ($value === '') { return null; @@ -194,30 +188,11 @@ public function marshal(mixed $value): ?BackedEnum } } - if (get_debug_type($value) !== $this->backingType) { - throw new InvalidArgumentException(sprintf( - 'Given value type `%s` does not match associated `%s` backed enum in `%s`', - get_debug_type($value), - $this->backingType, - $this->enumClassName, - )); - } - - $enumInstance = $this->enumClassName::tryFrom($value); - if ($enumInstance === null) { - if ($value === '' && $this->backingType === 'string') { - return null; - } - - throw new InvalidArgumentException(sprintf( - 'Unable to marshal value `%s` of type `%s` to `%s`', - print_r($value, true), - get_debug_type($value), - $this->enumClassName, - )); + try { + return $this->enumClassName::from($value); + } catch (ValueError | TypeError) { + return null; } - - return $enumInstance; } /** diff --git a/app/vendor/cakephp/cakephp/src/Database/Type/UuidType.php b/app/vendor/cakephp/cakephp/src/Database/Type/UuidType.php index 8b48af830..294279497 100644 --- a/app/vendor/cakephp/cakephp/src/Database/Type/UuidType.php +++ b/app/vendor/cakephp/cakephp/src/Database/Type/UuidType.php @@ -33,7 +33,7 @@ class UuidType extends StringType */ public function toDatabase(mixed $value, Driver $driver): ?string { - if ($value === null || $value === '' || $value === false) { + if (in_array($value, [null, '', false], true)) { return null; } diff --git a/app/vendor/cakephp/cakephp/src/Database/TypeFactory.php b/app/vendor/cakephp/cakephp/src/Database/TypeFactory.php index ae373cc15..7c97a789f 100644 --- a/app/vendor/cakephp/cakephp/src/Database/TypeFactory.php +++ b/app/vendor/cakephp/cakephp/src/Database/TypeFactory.php @@ -16,15 +16,13 @@ */ namespace Cake\Database; -use InvalidArgumentException; - /** * Factory for building database type classes. */ class TypeFactory { /** - * List of supported database types. A human readable + * List of supported database types. A human-readable * identifier is used as key and a complete namespaced class name as value * representing the class that will do actual type conversions. * @@ -32,32 +30,37 @@ class TypeFactory * @phpstan-var array> */ protected static array $_types = [ - 'tinyinteger' => Type\IntegerType::class, - 'smallinteger' => Type\IntegerType::class, - 'integer' => Type\IntegerType::class, 'biginteger' => Type\IntegerType::class, 'binary' => Type\BinaryType::class, 'binaryuuid' => Type\BinaryUuidType::class, 'boolean' => Type\BoolType::class, + 'char' => Type\StringType::class, + 'cidr' => Type\StringType::class, + 'citext' => Type\StringType::class, 'date' => Type\DateType::class, 'datetime' => Type\DateTimeType::class, 'datetimefractional' => Type\DateTimeFractionalType::class, 'decimal' => Type\DecimalType::class, 'float' => Type\FloatType::class, + 'geometry' => Type\StringType::class, + 'integer' => Type\IntegerType::class, + 'inet' => Type\StringType::class, 'json' => Type\JsonType::class, + 'linestring' => Type\StringType::class, + 'macaddr' => Type\StringType::class, + 'nativeuuid' => Type\UuidType::class, + 'point' => Type\StringType::class, + 'polygon' => Type\StringType::class, + 'smallinteger' => Type\IntegerType::class, 'string' => Type\StringType::class, - 'char' => Type\StringType::class, 'text' => Type\StringType::class, 'time' => Type\TimeType::class, 'timestamp' => Type\DateTimeType::class, 'timestampfractional' => Type\DateTimeFractionalType::class, 'timestamptimezone' => Type\DateTimeTimezoneType::class, + 'tinyinteger' => Type\IntegerType::class, 'uuid' => Type\UuidType::class, - 'nativeuuid' => Type\UuidType::class, - 'linestring' => Type\StringType::class, - 'geometry' => Type\StringType::class, - 'point' => Type\StringType::class, - 'polygon' => Type\StringType::class, + 'year' => Type\IntegerType::class, ]; /** @@ -71,7 +74,6 @@ class TypeFactory * Returns a Type object capable of converting a type identified by name. * * @param string $name type identifier - * @throws \InvalidArgumentException If type identifier is unknown * @return \Cake\Database\TypeInterface */ public static function build(string $name): TypeInterface @@ -80,7 +82,7 @@ public static function build(string $name): TypeInterface return static::$_builtTypes[$name]; } if (!isset(static::$_types[$name])) { - throw new InvalidArgumentException(sprintf('Unknown type `%s`', $name)); + return static::$_builtTypes[$name] = new static::$_types['string']($name); } return static::$_builtTypes[$name] = new static::$_types[$name]($name); @@ -140,7 +142,10 @@ public static function setMap(array $map): void } /** - * Get mapped class name for given type or map array. + * Get the type mapping array. + * + * Deprecated 5.3.0: Argument $type has been deprecated. + * Use getMap() without arguments to get the full map, or getMapped($type) to get a specific type mapping. * * @param string|null $type Type name to get mapped class for or null to get map array. * @return array>|string|null Configured class name for given $type or map array. @@ -151,6 +156,23 @@ public static function getMap(?string $type = null): array|string|null return static::$_types; } + trigger_error( + 'Calling getMap() with a type argument is deprecated. Use getMapped() instead.', + E_USER_DEPRECATED, + ); + + return static::$_types[$type] ?? null; + } + + /** + * Get mapped class name for a specific type. + * + * @param string $type Type name to get mapped class for. + * @return string|null Configured class name for given $type or null if not found. + * @phpstan-return class-string<\Cake\Database\TypeInterface>|null + */ + public static function getMapped(string $type): ?string + { return static::$_types[$type] ?? null; } diff --git a/app/vendor/cakephp/cakephp/src/Database/TypeMapTrait.php b/app/vendor/cakephp/cakephp/src/Database/TypeMapTrait.php index ffb699fe7..ac0d8d941 100644 --- a/app/vendor/cakephp/cakephp/src/Database/TypeMapTrait.php +++ b/app/vendor/cakephp/cakephp/src/Database/TypeMapTrait.php @@ -32,7 +32,7 @@ trait TypeMapTrait /** * Creates a new TypeMap if $typeMap is an array, otherwise exchanges it for the given one. * - * @param \Cake\Database\TypeMap|array $typeMap Creates a TypeMap if array, otherwise sets the given TypeMap + * @param \Cake\Database\TypeMap|array $typeMap Creates a TypeMap if array, otherwise sets the given TypeMap * @return $this */ public function setTypeMap(TypeMap|array $typeMap) diff --git a/app/vendor/cakephp/cakephp/src/Database/composer.json b/app/vendor/cakephp/cakephp/src/Database/composer.json index 00b65f86f..405232f59 100644 --- a/app/vendor/cakephp/cakephp/src/Database/composer.json +++ b/app/vendor/cakephp/cakephp/src/Database/composer.json @@ -24,15 +24,15 @@ "source": "https://github.com/cakephp/database" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev", - "cakephp/chronos": "^3.1", - "cakephp/datasource": "5.2.*@dev", + "php": ">=8.2", + "cakephp/core": "^5.3.0", + "cakephp/chronos": "^3.3", + "cakephp/datasource": "^5.3.0", "psr/log": "^3.0" }, "require-dev": { - "cakephp/i18n": "5.2.*@dev", - "cakephp/log": "5.2.*@dev" + "cakephp/i18n": "^5.3.0", + "cakephp/log": "^5.3.0" }, "autoload": { "psr-4": { @@ -43,10 +43,11 @@ "cakephp/i18n": "If you are using locale-aware datetime formats.", "cakephp/log": "If you want to use query logging without providing a logger yourself." }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Datasource/ConnectionManager.php b/app/vendor/cakephp/cakephp/src/Datasource/ConnectionManager.php index 820d02fc2..20e990a27 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/ConnectionManager.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/ConnectionManager.php @@ -77,7 +77,7 @@ class ConnectionManager * @param \Cake\Datasource\ConnectionInterface|\Closure|array|null $config An array of name => config data for adapter. * @return void * @throws \Cake\Core\Exception\CakeException When trying to modify an existing config. - * @see \Cake\Core\StaticConfigTrait::config() + * @see \Cake\Core\StaticConfigTrait::setConfig() */ public static function setConfig(array|string $key, ConnectionInterface|Closure|array|null $config = null): void { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/EntityInterface.php b/app/vendor/cakephp/cakephp/src/Datasource/EntityInterface.php index c5105533e..8c3354e36 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/EntityInterface.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/EntityInterface.php @@ -27,7 +27,7 @@ * @property mixed $id Alias for commonly used primary key. * @template-extends \ArrayAccess * @method bool hasValue(string $field) - * @method static patch(array $values, array $options = []) + * @method static patch(array $values, array $options = []) */ interface EntityInterface extends ArrayAccess, JsonSerializable, Stringable { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/EntityTrait.php b/app/vendor/cakephp/cakephp/src/Datasource/EntityTrait.php index 0d903ecd2..5587d07d1 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/EntityTrait.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/EntityTrait.php @@ -27,6 +27,8 @@ /** * An entity represents a single result row from a repository. It exposes the * methods for retrieving and storing fields associated in this row. + * + * @require-implements \Cake\Datasource\EntityInterface */ trait EntityTrait { @@ -109,7 +111,7 @@ trait EntityTrait /** * Map of fields in this entity that can be safely mass assigned, each * field name points to a boolean indicating its status. An empty array - * means no fields are accessible for mass assigment. + * means no fields are accessible for mass assignment. * * The special field '\*' can also be mapped, meaning that any other field * not defined in the map will take its value. For example, `'*' => true` @@ -151,7 +153,7 @@ trait EntityTrait */ public function &__get(string $field): mixed { - return $this->get($field); + return $this->getRequiredOrFail($field, $this->requireFieldPresence); } /** @@ -224,7 +226,7 @@ public function __unset(string $field): void * @param array $options Options to be used for setting the field. Allowed option * keys are `setter`, `guard` and `asOriginal` * @return $this - * @throws \InvalidArgumentException + * @throws \InvalidArgumentException when an empty field name is provided */ public function set(array|string $field, mixed $value = null, array $options = []) { @@ -365,6 +367,7 @@ protected function isModified(string $field, mixed $value): bool if ( is_object($value) + && is_object($existing) && !($value instanceof EntityInterface) && $existing == $value ) { @@ -380,8 +383,25 @@ protected function isModified(string $field, mixed $value): bool * @param string $field the name of the field to retrieve * @return mixed * @throws \InvalidArgumentException if an empty field name is passed + * @throws \Cake\Datasource\Exception\MissingPropertyException when field does not exist and requireFieldPresence is enabled */ public function &get(string $field): mixed + { + return $this->getRequiredOrFail($field, false); + } + + /** + * Get field with option for requireFieldPresence. + * + * Note: The returned value might be null if the field is set to null. + * + * @param string $field the name of the field to retrieve + * @param bool $requireFieldPresence Whether to throw an exception if the field is not present + * @return mixed + * @throws \InvalidArgumentException if an empty field name is passed + * @throws \Cake\Datasource\Exception\MissingPropertyException If property does not exist and $requireFieldPresence + */ + public function &getRequiredOrFail(string $field, bool $requireFieldPresence = true): mixed { if ($field === '') { throw new InvalidArgumentException('Cannot get an empty field'); @@ -402,7 +422,7 @@ public function &get(string $field): mixed return $result; } - if (!$fieldIsPresent && $this->requireFieldPresence) { + if (!$fieldIsPresent && $requireFieldPresence) { throw new MissingPropertyException([ 'property' => $field, 'entity' => $this::class, @@ -441,7 +461,7 @@ public function hasOriginal(string $field): bool * @param string $field the name of the field for which original value is retrieved. * @param bool $allowFallback whether to allow falling back to the current field value if no original exists * @return mixed - * @throws \InvalidArgumentException if an empty field name is passed. + * @throws \InvalidArgumentException if an empty field name is passed or if the field has no original value and $allowFallback is false */ public function getOriginal(string $field, bool $allowFallback = true): mixed { @@ -531,21 +551,13 @@ public function has(array|string $field): bool * * @param string $field The field to check. * @return bool + * @deprecated 5.3.0 Use hasValue() instead. */ public function isEmpty(string $field): bool { - $value = $this->get($field); - if ( - $value === null || - ( - $value === [] || - $value === '' - ) - ) { - return true; - } + deprecationWarning('5.3.0', 'isEmpty() is deprecated. Use hasValue() instead.'); - return false; + return !$this->hasValue($field); } /** @@ -558,6 +570,7 @@ public function isEmpty(string $field): bool * - Any object * - Integer, even `0` * - Float, even 0.0 + * - Boolean, both `true` and `false` * * and false in all other cases. * @@ -566,7 +579,18 @@ public function isEmpty(string $field): bool */ public function hasValue(string $field): bool { - return !$this->isEmpty($field); + $value = $this->get($field); + if ( + $value === null || + ( + $value === [] || + $value === '' + ) + ) { + return false; + } + + return true; } /** @@ -775,7 +799,7 @@ protected static function _accessor(string $property, string $type): string return static::$_accessors[$class][$type][$property]; } - if (!empty(static::$_accessors[$class])) { + if (isset(static::$_accessors[$class])) { return static::$_accessors[$class][$type][$property] = ''; } @@ -1158,6 +1182,13 @@ public function setError(string $field, array|string $errors, bool $overwrite = $errors = [$errors]; } + // Handle dotted field paths by creating nested error structure + if (str_contains($field, '.')) { + $nested = Hash::insert([], $field, $errors); + + return $this->setErrors($nested, $overwrite); + } + return $this->setErrors([$field => $errors], $overwrite); } @@ -1357,7 +1388,7 @@ public function setInvalidField(string $field, mixed $value) public function setAccess(array|string $field, bool $set) { if ($field === '*') { - $this->_accessible = array_map(fn($p) => $set, $this->_accessible); + $this->_accessible = array_map(fn() => $set, $this->_accessible); $this->_accessible['*'] = $set; return $this; @@ -1424,7 +1455,7 @@ public function setSource(string $alias) } /** - * Returns a string representation of this object in a human readable format. + * Returns a string representation of this object in a human-readable format. * * @return string * @deprecated 5.2.0 Casting an entity to string is deprecated. Use json_encode() instead to get a string representation of the entity. diff --git a/app/vendor/cakephp/cakephp/src/Datasource/FactoryLocator.php b/app/vendor/cakephp/cakephp/src/Datasource/FactoryLocator.php index 1d7d67cff..c3dd06498 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/FactoryLocator.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/FactoryLocator.php @@ -27,7 +27,7 @@ class FactoryLocator /** * A list of model factory functions. * - * @var array + * @var array> */ protected static array $_modelFactories = []; @@ -35,7 +35,7 @@ class FactoryLocator * Register a locator to return repositories of a given type. * * @param string $type The name of the repository type the factory function is for. - * @param \Cake\Datasource\Locator\LocatorInterface $factory The factory function used to create instances. + * @param \Cake\Datasource\Locator\LocatorInterface $factory The factory function used to create instances. * @return void */ public static function add(string $type, LocatorInterface $factory): void @@ -59,7 +59,7 @@ public static function drop(string $type): void * * @param string $type The repository type to get the factory for. * @throws \InvalidArgumentException If the specified repository type has no factory. - * @return \Cake\Datasource\Locator\LocatorInterface The factory for the repository type. + * @return \Cake\Datasource\Locator\LocatorInterface The factory for the repository type. */ public static function get(string $type): LocatorInterface { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Locator/AbstractLocator.php b/app/vendor/cakephp/cakephp/src/Datasource/Locator/AbstractLocator.php index ff576234c..192ca68db 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/Locator/AbstractLocator.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/Locator/AbstractLocator.php @@ -21,13 +21,16 @@ /** * Provides an abstract registry/factory for repository objects. + * + * @template TRepo of \Cake\Datasource\RepositoryInterface + * @implements \Cake\Datasource\Locator\LocatorInterface */ abstract class AbstractLocator implements LocatorInterface { /** * Instances that belong to the registry. * - * @var array + * @var array */ protected array $instances = []; @@ -43,7 +46,7 @@ abstract class AbstractLocator implements LocatorInterface * * @param string $alias The alias name you want to get. * @param array $options The options you want to build the table with. - * @return \Cake\Datasource\RepositoryInterface + * @return TRepo * @throws \Cake\Core\Exception\CakeException When trying to get alias for which instance * has already been created with different options. */ @@ -73,7 +76,7 @@ public function get(string $alias, array $options = []): RepositoryInterface * * @param string $alias Repository alias. * @param array $options The options you want to build the instance with. - * @return \Cake\Datasource\RepositoryInterface + * @return TRepo */ abstract protected function createInstance(string $alias, array $options): RepositoryInterface; diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Locator/LocatorInterface.php b/app/vendor/cakephp/cakephp/src/Datasource/Locator/LocatorInterface.php index 7a7a2b000..c66ee8a02 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/Locator/LocatorInterface.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/Locator/LocatorInterface.php @@ -20,6 +20,8 @@ /** * Registries for repository objects should implement this interface. + * + * @template TRepo of \Cake\Datasource\RepositoryInterface */ interface LocatorInterface { @@ -28,7 +30,7 @@ interface LocatorInterface * * @param string $alias The alias name you want to get. * @param array $options The options you want to build the table with. - * @return \Cake\Datasource\RepositoryInterface + * @return TRepo * @throws \RuntimeException When trying to get alias for which instance * has already been created with different options. */ @@ -38,8 +40,8 @@ public function get(string $alias, array $options = []): RepositoryInterface; * Set a repository instance. * * @param string $alias The alias to set. - * @param \Cake\Datasource\RepositoryInterface $repository The repository to set. - * @return \Cake\Datasource\RepositoryInterface + * @param TRepo $repository The repository to set. + * @return TRepo */ public function set(string $alias, RepositoryInterface $repository): RepositoryInterface; @@ -52,7 +54,7 @@ public function set(string $alias, RepositoryInterface $repository): RepositoryI public function exists(string $alias): bool; /** - * Removes an repository instance from the registry. + * Removes a repository instance from the registry. * * @param string $alias The alias to remove. * @return void diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Paging/NumericPaginator.php b/app/vendor/cakephp/cakephp/src/Datasource/Paging/NumericPaginator.php index b65120795..900fc3f16 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/Paging/NumericPaginator.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/Paging/NumericPaginator.php @@ -43,12 +43,36 @@ class NumericPaginator implements PaginatorInterface * - `allowedParameters` - A list of parameters users are allowed to set using request * parameters. Modifying this list will allow users to have more influence * over pagination, be careful with what you permit. - * - `sortableFields` - A list of fields which can be used for sorting. By - * default all table columns can be used for sorting. You can use this option - * to restrict sorting only by particular fields. If you want to allow - * sorting on either associated columns or calculated fields then you will - * have to explicitly specify them (along with other fields). Using an empty - * array will disable sorting alltogether. + * - `sortableFields` - Controls which fields can be used for sorting. Accepts multiple formats: + * - Simple array: A list of field names that can be sorted. By default all table + * columns can be used. Use this to restrict sorting to specific fields. An empty + * array will disable sorting altogether. + * - Map with SortField objects: A map of sort keys to their corresponding database fields. + * Allows creating friendly sort keys that map to one or more actual fields. Supports + * simple mapping, multi-column sorting, locked directions, and default directions. + * Can accept a callable that receives a SortableFieldsBuilder instance. + * + * Examples: + * ``` + * // Simple array (traditional) + * 'sortableFields' => ['title', 'created', 'author_id'] + * + * // Map with SortField objects + * 'sortableFields' => [ + * 'name' => 'Users.name', + * 'newest' => [ + * SortField::desc('created'), + * SortField::asc('title'), + * ], + * ] + * + * // Callable with builder + * 'sortableFields' => function(SortableFieldsBuilder $builder) { + * return $builder + * ->add('name', SortField::asc('Users.name')) + * ->add('popularity', SortField::desc('score', locked: true), 'created'); + * } + * ``` * - `finder` - The table finder to use. Defaults to `all`. * - `scope` - If specified this scope will be used to get the paging options * from the query params passed to paginate(). Scopes allow namespacing the @@ -74,6 +98,7 @@ class NumericPaginator implements PaginatorInterface */ protected array $pagingParams = [ 'limit' => null, + 'maxLimit' => null, 'count' => null, 'totalCount' => null, 'perPage' => null, @@ -196,7 +221,7 @@ class NumericPaginator implements PaginatorInterface * to paginate. * @param array $params Request params * @param array $settings The settings/configuration used for pagination. - * @return \Cake\Datasource\Paging\PaginatedInterface + * @return \Cake\Datasource\Paging\PaginatedInterface * @throws \Cake\Datasource\Paging\Exception\PageOutOfBoundsException */ public function paginate( @@ -241,9 +266,9 @@ public function paginate( /** * Build paginated result set. * - * @param \Cake\Datasource\ResultSetInterface $items + * @param \Cake\Datasource\ResultSetInterface $items * @param array $pagingParams - * @return \Cake\Datasource\Paging\PaginatedInterface + * @return \Cake\Datasource\Paging\PaginatedInterface */ protected function buildPaginated(ResultSetInterface $items, array $pagingParams): PaginatedInterface { @@ -289,7 +314,7 @@ protected function getQuery(RepositoryInterface $object, ?QueryInterface $query, * * @param \Cake\Datasource\QueryInterface $query Query to fetch items. * @param array $data Paging data. - * @return \Cake\Datasource\ResultSetInterface + * @return \Cake\Datasource\ResultSetInterface */ protected function getItems(QueryInterface $query, array $data): ResultSetInterface { @@ -355,6 +380,7 @@ protected function buildParams(array $data): array 'requestedPage' => $data['options']['page'], 'alias' => $data['alias'], 'scope' => $data['options']['scope'], + 'maxLimit' => $data['options']['maxLimit'], ] + $this->pagingParams; $this->addPageCountParams($data); @@ -362,10 +388,18 @@ protected function buildParams(array $data): array $this->addPrevNextParams($data); $this->addSortingParams($data); - $this->pagingParams['limit'] = $data['defaults']['limit'] != $data['options']['limit'] + $this->pagingParams['limit'] = (int)$data['defaults']['limit'] !== (int)$data['options']['limit'] ? $data['options']['limit'] : null; + // Add sortableFields configuration for view helpers + if (isset($data['options']['sortableFields'])) { + $sortableFields = $data['options']['sortableFields']; + if ($sortableFields instanceof SortableFieldsBuilder) { + $this->pagingParams['sortableFields'] = $sortableFields->toArray(); + } + } + return $this->pagingParams; } @@ -444,10 +478,15 @@ protected function addSortingParams(array $data): void $sortDefault = key($defaults['order']); $directionDefault = current($defaults['order']); } + if (isset($data['options']['sortDirection'])) { + $direction = $data['options']['sortDirection']; + } else { + $direction = isset($data['options']['sort']) && count($order) ? current($order) : null; + } $this->pagingParams = [ 'sort' => $data['options']['sort'], - 'direction' => isset($data['options']['sort']) && count($order) ? current($order) : null, + 'direction' => $direction, 'sortDefault' => $sortDefault, 'directionDefault' => $directionDefault, 'completeSort' => $order, @@ -474,7 +513,7 @@ protected function mergeOptions(array $params, array $settings): array { if (!empty($settings['scope'])) { $scope = $settings['scope']; - $params = !empty($params[$scope]) ? (array)$params[$scope] : []; + $params = (array)($params[$scope] ?? []); } $params = array_intersect_key($params, array_flip($this->getConfig('allowedParameters'))); @@ -518,6 +557,7 @@ protected function getDefaults(string $alias, array $settings): array * also be sanitized. Lastly sort + direction keys will be converted into * the model friendly order key. * + /** * You can use the allowedParameters option to control which columns/fields are * available for sorting via URL parameters. This helps prevent users from ordering large * result sets on un-indexed values. @@ -539,24 +579,76 @@ protected function getDefaults(string $alias, array $settings): array */ protected function validateSort(RepositoryInterface $object, array $options): array { + // Check if we have sortableFields configured + $sortableFields = $options['sortableFields'] ?? null; + $builder = $sortableFields instanceof SortableFieldsBuilder + ? $sortableFields + : SortableFieldsBuilder::create($sortableFields); + + // Store the converted builder for later use in paging params + if ($builder !== null) { + $options['sortableFields'] = $builder; + } + + $sortAllowed = $builder !== null; + if (isset($options['sort'])) { - $direction = null; - if (isset($options['direction'])) { - $direction = strtolower($options['direction']); - } - if (!in_array($direction, ['asc', 'desc'], true)) { - $direction = 'asc'; - } + // Parse sort and direction parameters + $sortParams = $this->parseSortParams($options); + + // Update options with parsed sort key (handles combined format) + $options['sort'] = $sortParams['sortKey']; + + if ($builder !== null) { + // Use builder to resolve sort key + $order = $builder->resolve( + $sortParams['sortKey'], + $sortParams['direction'], + $sortParams['directionSpecified'], + ); + + if ($order === null) { + // Invalid sort key, clear sort + $options['order'] = []; + $options['sort'] = null; + unset($options['direction']); + + return $options; + } - $order = isset($options['order']) && is_array($options['order']) ? $options['order'] : []; - if ($order && $options['sort'] && !str_contains($options['sort'], '.')) { - $order = $this->_removeAliases($order, $object->getAlias()); - } + // Merge with existing order - existing order comes AFTER our resolved order + $existingOrder = isset($options['order']) && is_array($options['order']) ? $options['order'] : []; + $modelAlias = $object->getAlias(); + // Only keep fields from existing order that aren't already in our resolved order + // Account for prefixed vs unprefixed field names (e.g., 'modified' vs 'Alerts.modified') + foreach ($existingOrder as $field => $dir) { + // Check if this field (or its unprefixed version) is already in $order + $alreadyInOrder = isset($order[$field]); + if (!$alreadyInOrder && str_contains($field, '.')) { + [$alias, $fieldName] = explode('.', $field, 2); + if ($alias === $modelAlias && isset($order[$fieldName])) { + $alreadyInOrder = true; + } + } + if (!$alreadyInOrder) { + $order[$field] = $dir; + } + } + $options['order'] = $order; + $options['sortDirection'] = $sortParams['direction']; + } else { + // No sortableFields configured - allow any field (default behavior) + $order = isset($options['order']) && is_array($options['order']) ? $options['order'] : []; + if ($order && $sortParams['sortKey'] && !str_contains($sortParams['sortKey'], '.')) { + $order = $this->_removeAliases($order, $object->getAlias()); + } - $options['order'] = [$options['sort'] => $direction] + $order; + $options['order'] = [$sortParams['sortKey'] => $sortParams['direction']] + $order; + } } else { $options['sort'] = null; } + unset($options['direction']); if (empty($options['order'])) { @@ -566,18 +658,6 @@ protected function validateSort(RepositoryInterface $object, array $options): ar return $options; } - $sortAllowed = false; - if (isset($options['sortableFields'])) { - $field = key($options['order']); - $sortAllowed = in_array($field, $options['sortableFields'], true); - if (!$sortAllowed) { - $options['order'] = []; - $options['sort'] = null; - - return $options; - } - } - if ( $options['sort'] === null && count($options['order']) >= 1 @@ -668,6 +748,41 @@ protected function _prefix(RepositoryInterface $object, array $order, bool $allo return $tableOrder; } + /** + * Parse sort parameters from options. + * + * Extracts and normalizes sort key and direction from pagination options. + * Supports both traditional format (?sort=field&direction=asc) and + * combined format (?sort=field-asc). + * + * @param array $options The options array + * @return array{sortKey: string, direction: string, directionSpecified: bool} + */ + protected function parseSortParams(array $options): array + { + $sortKey = $options['sort']; + $direction = isset($options['direction']) ? strtolower($options['direction']) : SortField::ASC; + $directionSpecified = isset($options['direction']); + + // Check for combined sort-direction format (e.g., 'title-asc' or 'title-desc') + if (preg_match('/^(.+)-(asc|desc)$/i', $sortKey, $matches)) { + $sortKey = $matches[1]; + $direction = strtolower($matches[2]); + $directionSpecified = true; + } + + // Validate direction + if (!in_array($direction, [SortField::ASC, SortField::DESC], true)) { + $direction = SortField::ASC; + } + + return [ + 'sortKey' => $sortKey, + 'direction' => $direction, + 'directionSpecified' => $directionSpecified, + ]; + } + /** * Check the limit parameter and ensure it's within the maxLimit bounds. * diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedInterface.php b/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedInterface.php index 3f8ea9e18..7c1461d12 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedInterface.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedInterface.php @@ -22,7 +22,9 @@ /** * This interface describes the methods for pagination instance. * - * @template-extends \Traversable + * @template TKey + * @template-covariant TValue + * @template-extends \Traversable * @method array toArray() Get the paginated items as an array */ interface PaginatedInterface extends Countable, Traversable @@ -72,7 +74,7 @@ public function hasNextPage(): bool; /** * Get paginated items. * - * @return iterable + * @return iterable */ public function items(): iterable; diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedResultSet.php b/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedResultSet.php index bf1e8fd4b..a23b6c3a4 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedResultSet.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatedResultSet.php @@ -24,15 +24,17 @@ /** * Paginated result set. * - * @template T of mixed - * @template-implements \IteratorAggregate + * @template TKey + * @template TValue + * @implements \IteratorAggregate + * @implements \Cake\Datasource\Paging\PaginatedInterface */ class PaginatedResultSet implements IteratorAggregate, JsonSerializable, PaginatedInterface { /** * Resultset instance. * - * @var \Traversable + * @var \Traversable */ protected Traversable $results; @@ -46,7 +48,7 @@ class PaginatedResultSet implements IteratorAggregate, JsonSerializable, Paginat /** * Constructor * - * @param \Traversable $results Resultset instance. + * @param \Traversable $results Resultset instance. * @param array $params Paging params. */ public function __construct(Traversable $results, array $params) @@ -68,7 +70,7 @@ public function count(): int * * This will exhaust the iterator `items`. * - * @return array + * @return array */ public function toArray(): array { @@ -78,7 +80,7 @@ public function toArray(): array /** * Get paginated items. * - * @return \Traversable The paginated items result set. + * @return \Traversable The paginated items result set. */ public function items(): Traversable { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatorInterface.php b/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatorInterface.php index 96e7678d7..ec17ade2c 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatorInterface.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/Paging/PaginatorInterface.php @@ -27,7 +27,7 @@ interface PaginatorInterface * @param mixed $target Anything that needs to be paginated. * @param array $params Request params. * @param array $settings The settings/configuration used for pagination. - * @return \Cake\Datasource\Paging\PaginatedInterface + * @return \Cake\Datasource\Paging\PaginatedInterface */ public function paginate( mixed $target, diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Paging/SimplePaginator.php b/app/vendor/cakephp/cakephp/src/Datasource/Paging/SimplePaginator.php index 746d62955..078c0f6d3 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/Paging/SimplePaginator.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/Paging/SimplePaginator.php @@ -31,11 +31,11 @@ class SimplePaginator extends NumericPaginator /** * Get paginated items. * - * Get one additional record than the limit. This helps deduce if next page exits. + * Get one additional record than the limit. This helps deduce if next page exists. * * @param \Cake\Datasource\QueryInterface $query Query to fetch items. * @param array $data Paging data. - * @return \Cake\Datasource\ResultSetInterface + * @return \Cake\Datasource\ResultSetInterface */ protected function getItems(QueryInterface $query, array $data): ResultSetInterface { @@ -66,9 +66,9 @@ protected function buildParams(array $data): array * Since the query fetches an extra record, drop the last record if records * fetched exceeds the limit/per page. * - * @param \Cake\Datasource\ResultSetInterface $items + * @param \Cake\Datasource\ResultSetInterface $items * @param array $pagingParams - * @return \Cake\Datasource\Paging\PaginatedInterface + * @return \Cake\Datasource\Paging\PaginatedInterface */ protected function buildPaginated(ResultSetInterface $items, array $pagingParams): PaginatedInterface { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Paging/SortField.php b/app/vendor/cakephp/cakephp/src/Datasource/Paging/SortField.php new file mode 100644 index 000000000..2125bf04c --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Datasource/Paging/SortField.php @@ -0,0 +1,119 @@ +field; + } + + /** + * Get the sort direction to use. + * + * @param string $requestedDirection The direction requested by the user + * @param bool $directionSpecified Whether a direction was explicitly specified + * @return string + */ + public function getDirection(string $requestedDirection, bool $directionSpecified): string + { + if ($this->locked) { + return $this->defaultDirection ?? self::ASC; + } + + if (!$directionSpecified && $this->defaultDirection) { + return $this->defaultDirection; + } + + if ($this->defaultDirection === static::DESC) { + return $requestedDirection === static::DESC ? static::ASC : static::DESC; + } + + return $requestedDirection; + } + + /** + * Check if the sort direction is locked. + * + * @return bool + */ + public function isLocked(): bool + { + return $this->locked; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Datasource/Paging/SortableFieldsBuilder.php b/app/vendor/cakephp/cakephp/src/Datasource/Paging/SortableFieldsBuilder.php new file mode 100644 index 000000000..d81ac8474 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Datasource/Paging/SortableFieldsBuilder.php @@ -0,0 +1,270 @@ +|string> The sortable fields map being built + */ + protected array $map = []; + + /** + * @var bool Whether this builder represents a simple array format + */ + protected bool $isSimpleArray = false; + + /** + * Create builder from various sortableFields configurations. + * + * @param \Closure|array|null $config The sortableFields configuration + * @return static|null Builder instance or null if no config + */ + public static function create(array|Closure|null $config): ?static + { + if ($config === null) { + return null; + } + + if ($config instanceof Closure) { + return static::fromCallable($config); + } + + return static::fromArray($config); + } + + /** + * Create builder from array configuration. + * + * Handles both simple array format (['field1', 'field2']) and + * associative map format (['key' => 'field', ...]). + * + * @param array $config Array configuration + * @return static + */ + public static function fromArray(array $config): static + { + $builder = new static(); + $hasNumericKeys = false; + + // Check if it's a simple array format + foreach ($config as $key => $value) { + if (is_int($key)) { + $hasNumericKeys = true; + break; + } + } + + if ($hasNumericKeys) { + // Simple or mixed format - convert numeric keys + $builder->isSimpleArray = true; + foreach ($config as $key => $value) { + if (is_int($key) && is_string($value)) { + // Numeric key with string value: 'field' becomes 'field' => ['field'] + $builder->add($value, $value); + } else { + // String key: use as-is + $builder->set($key, $value); + } + } + } else { + // Associative map format + foreach ($config as $key => $value) { + $builder->set($key, $value); + } + } + + return $builder; + } + + /** + * Create builder from callable factory. + * + * @param \Closure $factory Closure that receives builder and returns it + * @return static + */ + public static function fromCallable(Closure $factory): static + { + $builder = new static(); + $builder = $factory($builder); + + return $builder; + } + + /** + * Add a sort key with its associated SortField objects. + * + * @param string $sortKey The sort key name + * @param \Cake\Datasource\Paging\SortField|string ...$fields The sort fields to add + * @return $this + */ + public function add(string $sortKey, SortField|string ...$fields) + { + if ($fields === []) { + // If no fields provided, use the key as the field name + $this->map[$sortKey] = [$sortKey]; + } else { + $this->map[$sortKey] = $fields; + } + + return $this; + } + + /** + * Set a sort key with type-safe validation. + * + * Internal method used by fromArray() to ensure type safety while preserving + * backward compatibility with string and array representations. + * + * @param string $sortKey The sort key name + * @param mixed $value The sort field(s) - can be string, SortField, or array + * @return $this + */ + protected function set(string $sortKey, mixed $value) + { + if (is_string($value)) { + $this->map[$sortKey] = $value; + } elseif ($value instanceof SortField) { + $this->map[$sortKey] = [$value]; + } elseif (is_array($value)) { + $this->add($sortKey, ...$value); + } else { + throw new InvalidArgumentException(sprintf( + 'Invalid sortable field value type for key `%s`. Expected string, array, or SortField, got `%s`.', + $sortKey, + get_debug_type($value), + )); + } + + return $this; + } + + /** + * Return the complete sortable fields map. + * + * @return array|string> + */ + public function toArray(): array + { + return $this->map; + } + + /** + * Resolve a sort key to its corresponding ORDER BY clause. + * + * @param string $sortKey The sort key from URL + * @param string $direction The requested direction (asc/desc) + * @param bool $directionSpecified Whether direction was explicitly specified + * @return array|null Array of field => direction pairs, or null if invalid + */ + public function resolve( + string $sortKey, + string $direction, + bool $directionSpecified = true, + ): ?array { + // Check if sort key exists in map + if (!isset($this->map[$sortKey])) { + return null; + } + + $mapping = $this->map[$sortKey]; + + // Empty array means use key as field + if ($mapping === []) { + return [$sortKey => $direction]; + } + + return $this->resolveMapping($mapping, $direction, $directionSpecified); + } + + /** + * Resolve a mapping configuration to ORDER BY clause. + * + * @param mixed $mapping The mapping to resolve + * @param string $direction The requested direction + * @param bool $directionSpecified Whether direction was explicitly specified + * @return array Array of field => direction pairs + */ + protected function resolveMapping(mixed $mapping, string $direction, bool $directionSpecified): array + { + // Single string: 'name' => 'Users.name' + if (is_string($mapping)) { + return [$mapping => $direction]; + } + + // Array of fields/SortField objects + if (is_array($mapping)) { + return $this->resolveArrayMapping($mapping, $direction, $directionSpecified); + } + + return []; + } + + /** + * Resolve an array mapping to ORDER BY clause. + * + * @param array $fields Array of fields or SortField objects + * @param string $direction The requested direction + * @param bool $directionSpecified Whether direction was explicitly specified + * @return array Array of field => direction pairs + */ + protected function resolveArrayMapping(array $fields, string $direction, bool $directionSpecified): array + { + $order = []; + $shouldInvert = $directionSpecified && $direction === SortField::DESC; + + foreach ($fields as $key => $value) { + if ($value instanceof SortField) { + // SortField object with locked/default directions + $field = $value->getField(); + $fieldDirection = $value->getDirection($direction, $directionSpecified); + $order[$field] = $fieldDirection; + } elseif (is_int($key)) { + // Numeric array: ['field1', 'field2'] - use requested direction + $order[$value] = $direction; + } elseif (is_string($value)) { + // Associative array with default directions per field + // Format: ['field1' => 'ASC', 'field2' => 'DESC'] + $defaultDirection = strtolower($value); + + if ($shouldInvert) { + // Invert the direction when toggling to desc + $fieldDirection = $defaultDirection === SortField::ASC ? SortField::DESC : SortField::ASC; + } else { + // Use default direction (for asc or no direction specified) + $fieldDirection = $defaultDirection; + } + + $order[$key] = $fieldDirection; + } else { + // Fallback for other cases + $order[$key] = $direction; + } + } + + return $order; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Datasource/QueryCacher.php b/app/vendor/cakephp/cakephp/src/Datasource/QueryCacher.php index 040ef3e86..1c9d05171 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/QueryCacher.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/QueryCacher.php @@ -25,10 +25,7 @@ /** * Handles caching queries and loading results from the cache. * - * Used by {@link \Cake\Datasource\QueryTrait} internally. - * * @internal - * @see \Cake\Datasource\QueryTrait::cache() for the public interface. */ class QueryCacher { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/QueryInterface.php b/app/vendor/cakephp/cakephp/src/Datasource/QueryInterface.php index f943adb5c..435126ec1 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/QueryInterface.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/QueryInterface.php @@ -25,7 +25,7 @@ * @method $this andWhere($conditions, array $types = []) Connects any previously defined set of conditions to the * provided list using the AND operator. {@see \Cake\Database\Query::andWhere()} * @method \Cake\Datasource\EntityInterface|array firstOrFail() Get the first result from the executing query or raise an exception. - * {@see \Cake\Database\Query::firstOrFail()} + * {@see \Cake\ORM\Query\SelectQuery::firstOrFail()} */ interface QueryInterface { @@ -77,8 +77,9 @@ public function aliasFields(array $fields, ?string $defaultAlias = null): array; * ResultSetDecorator is a traversable object that implements the methods found * on Cake\Collection\Collection. * - * @template T of mixed - * @return \Cake\Datasource\ResultSetInterface + * @template TKey of array-key + * @template TValue of mixed + * @return \Cake\Datasource\ResultSetInterface */ public function all(): ResultSetInterface; @@ -172,7 +173,7 @@ public function count(): int; * * ``` * $query->limit(10) // generates LIMIT 10 - * $query->limit($query->newExpr()->add(['1 + 1'])); // LIMIT (1 + 1) + * $query->limit($query->expr()->add(['1 + 1'])); // LIMIT (1 + 1) * ``` * * @param int|null $limit number of records to be returned @@ -192,7 +193,7 @@ public function limit(?int $limit); * * ``` * $query->offset(10) // generates OFFSET 10 - * $query->offset($query->newExpr()->add(['1 + 1'])); // OFFSET (1 + 1) + * $query->offset($query->expr()->add(['1 + 1'])); // OFFSET (1 + 1) * ``` * * @param int|null $offset number of records to be skipped @@ -225,7 +226,7 @@ public function offset(?int $offset); * * ``` * $query - * ->orderBy(['title' => $query->newExpr('DESC NULLS FIRST')]) + * ->orderBy(['title' => $query->expr('DESC NULLS FIRST')]) * ->orderBy('author_id'); * ``` * @@ -234,7 +235,7 @@ public function offset(?int $offset); * `ORDER BY title DESC NULLS FIRST, author_id` * * ``` - * $expression = $query->newExpr()->add(['id % 2 = 0']); + * $expression = $query->expr()->add(['id % 2 = 0']); * $query->orderBy($expression)->orderBy(['title' => 'ASC']); * ``` * @@ -277,7 +278,7 @@ public function order(Closure|array|string $fields, bool $overwrite = false); * * ``` * $query - * ->orderBy(['title' => $query->newExpr('DESC NULLS FIRST')]) + * ->orderBy(['title' => $query->expr('DESC NULLS FIRST')]) * ->orderBy('author_id'); * ``` * @@ -286,7 +287,7 @@ public function order(Closure|array|string $fields, bool $overwrite = false); * `ORDER BY title DESC NULLS FIRST, author_id` * * ``` - * $expression = $query->newExpr()->add(['id % 2 = 0']); + * $expression = $query->expr()->add(['id % 2 = 0']); * $query->orderBy($expression)->orderBy(['title' => 'ASC']); * ``` * @@ -404,7 +405,7 @@ public function getRepository(): ?RepositoryInterface; * ### Using expressions objects: * * ``` - * $exp = $query->newExpr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR'); + * $exp = $query->expr()->add(['id !=' => 100, 'author_id' != 1])->tieWith('OR'); * $query->where(['published' => true], ['published' => 'boolean'])->where($exp); * ``` * diff --git a/app/vendor/cakephp/cakephp/src/Datasource/ResultSetDecorator.php b/app/vendor/cakephp/cakephp/src/Datasource/ResultSetDecorator.php index 6be03e2ed..688cc6c8b 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/ResultSetDecorator.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/ResultSetDecorator.php @@ -23,8 +23,10 @@ * Generic ResultSet decorator. This will make any traversable object appear to * be a database result * - * @template T - * @implements \Cake\Datasource\ResultSetInterface + * @template TKey + * @template TValue + * @extends \Cake\Collection\Collection + * @implements \Cake\Datasource\ResultSetInterface */ class ResultSetDecorator extends Collection implements ResultSetInterface { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/ResultSetInterface.php b/app/vendor/cakephp/cakephp/src/Datasource/ResultSetInterface.php index 35a1b37e0..29a7813d3 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/ResultSetInterface.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/ResultSetInterface.php @@ -21,7 +21,9 @@ /** * Describes how a collection of datasource results should look like * - * @template T + * @template TKey + * @template-covariant TValue + * @extends \Cake\Collection\CollectionInterface */ interface ResultSetInterface extends CollectionInterface { diff --git a/app/vendor/cakephp/cakephp/src/Datasource/RulesChecker.php b/app/vendor/cakephp/cakephp/src/Datasource/RulesChecker.php index b22146796..83ef8edea 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/RulesChecker.php +++ b/app/vendor/cakephp/cakephp/src/Datasource/RulesChecker.php @@ -421,7 +421,7 @@ protected function _addError(callable $rule, array|string|null $name = null, arr protected function checkName(string $name, array $rules): void { if (array_key_exists($name, $rules)) { - throw new CakeException('A rule with the same name already exists'); + throw new CakeException("A rule with the name `{$name}` already exists"); } } } diff --git a/app/vendor/cakephp/cakephp/src/Datasource/composer.json b/app/vendor/cakephp/cakephp/src/Datasource/composer.json index 26f53418b..57273ee7c 100644 --- a/app/vendor/cakephp/cakephp/src/Datasource/composer.json +++ b/app/vendor/cakephp/cakephp/src/Datasource/composer.json @@ -24,14 +24,14 @@ "source": "https://github.com/cakephp/datasource" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev", + "php": ">=8.2", + "cakephp/core": "^5.3.0", "psr/simple-cache": "^2.0 || ^3.0" }, "require-dev": { - "cakephp/cache": "5.2.*@dev", - "cakephp/collection": "5.2.*@dev", - "cakephp/utility": "5.2.*@dev" + "cakephp/cache": "^5.3.0", + "cakephp/collection": "^5.3.0", + "cakephp/utility": "^5.3.0" }, "autoload": { "psr-4": { @@ -43,10 +43,11 @@ "cakephp/collection": "If you decide to use ResultSetInterface.", "cakephp/cache": "If you decide to use Query caching." }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Error/Debug/ConsoleFormatter.php b/app/vendor/cakephp/cakephp/src/Error/Debug/ConsoleFormatter.php index e738d4ec3..fffa965d2 100644 --- a/app/vendor/cakephp/cakephp/src/Error/Debug/ConsoleFormatter.php +++ b/app/vendor/cakephp/cakephp/src/Error/Debug/ConsoleFormatter.php @@ -69,7 +69,7 @@ public static function environmentMatches(): bool DIRECTORY_SEPARATOR === '\\' && !str_contains(strtolower(php_uname('v')), 'windows 10') && !str_contains(strtolower((string)env('SHELL')), 'bash.exe') && - !(bool)env('ANSICON') && + !env('ANSICON') && env('ConEmuANSI') !== 'ON' ) { return false; @@ -84,7 +84,7 @@ public static function environmentMatches(): bool public function formatWrapper(string $contents, array $location): string { $lineInfo = ''; - if (isset($location['file'], $location['file'])) { + if (isset($location['file'], $location['line'])) { $lineInfo = sprintf('%s (line %s)', $location['file'], $location['line']); } $parts = [ diff --git a/app/vendor/cakephp/cakephp/src/Error/Debug/HtmlFormatter.php b/app/vendor/cakephp/cakephp/src/Error/Debug/HtmlFormatter.php index d77d35827..ad5a2bde2 100644 --- a/app/vendor/cakephp/cakephp/src/Error/Debug/HtmlFormatter.php +++ b/app/vendor/cakephp/cakephp/src/Error/Debug/HtmlFormatter.php @@ -66,7 +66,7 @@ public static function environmentMatches(): bool public function formatWrapper(string $contents, array $location): string { $lineInfo = ''; - if (isset($location['file'], $location['file'])) { + if (isset($location['file'], $location['line'])) { $lineInfo = sprintf( '%s (line %s)', $location['file'], diff --git a/app/vendor/cakephp/cakephp/src/Error/Debug/TextFormatter.php b/app/vendor/cakephp/cakephp/src/Error/Debug/TextFormatter.php index 68adae161..02d495e0b 100644 --- a/app/vendor/cakephp/cakephp/src/Error/Debug/TextFormatter.php +++ b/app/vendor/cakephp/cakephp/src/Error/Debug/TextFormatter.php @@ -41,7 +41,7 @@ public function formatWrapper(string $contents, array $location): string TEXT; $lineInfo = ''; - if (isset($location['file'], $location['file'])) { + if (isset($location['file'], $location['line'])) { $lineInfo = sprintf('%s (line %s)', $location['file'], $location['line']); } diff --git a/app/vendor/cakephp/cakephp/src/Error/Debugger.php b/app/vendor/cakephp/cakephp/src/Error/Debugger.php index a8afa9693..b834e1bd0 100644 --- a/app/vendor/cakephp/cakephp/src/Error/Debugger.php +++ b/app/vendor/cakephp/cakephp/src/Error/Debugger.php @@ -50,7 +50,7 @@ * Debugger extends PHP's default error handling and gives * simpler to use more powerful interfaces. * - * @link https://book.cakephp.org/5/en/development/debugging.html#namespace-Cake\Error + * @link https://book.cakephp.org/5/en/development/debugging.html#using-the-debugger-class */ class Debugger { @@ -65,6 +65,7 @@ class Debugger 'outputMask' => [], 'exportFormatter' => null, 'editor' => 'phpstorm', + 'editorBasePath' => null, ]; /** @@ -231,6 +232,11 @@ public static function editorUrl(string $file, int $line): string )); } + $editorBasePath = $instance->getConfig('editorBasePath'); + if ($editorBasePath !== null && is_string($editorBasePath)) { + $file = str_replace(ROOT, $editorBasePath, $file); + } + $template = $instance->editors[$editor]; if (is_string($template)) { return str_replace(['{file}', '{line}'], [$file, (string)$line], $template); @@ -422,7 +428,7 @@ public static function formatTrace(Throwable|array $backtrace, array $options = $back[] = sprintf('%s - %s, line %d', $reference, $path, $frame['line']); } else { throw new InvalidArgumentException( - "Invalid trace format of `$format` chosen. Must be one of `array`, `points` or `text`.", + "Invalid trace format of `{$format}` chosen. Must be one of `array`, `points` or `text`.", ); } } diff --git a/app/vendor/cakephp/cakephp/src/Error/ErrorLogger.php b/app/vendor/cakephp/cakephp/src/Error/ErrorLogger.php index b5e92b6b2..1848dc0b1 100644 --- a/app/vendor/cakephp/cakephp/src/Error/ErrorLogger.php +++ b/app/vendor/cakephp/cakephp/src/Error/ErrorLogger.php @@ -19,6 +19,7 @@ use Cake\Core\Configure; use Cake\Core\Exception\CakeException; use Cake\Core\InstanceConfigTrait; +use Cake\Database\Exception\QueryException; use Cake\Http\ServerRequest; use Cake\Log\Log; use Psr\Http\Message\ServerRequestInterface; @@ -122,7 +123,32 @@ public function logException( if ($request !== null) { $message .= $this->getRequestContext($request); } - $this->error($message); + + $context = $this->getExceptionContext($exception); + $this->error($message, $context); + } + + /** + * Extract additional context from an exception. + * + * For database exceptions, this includes the connection name + * to help identify which database connection caused the error. + * + * @param \Throwable $exception The exception to extract context from. + * @return array Additional context data. + */ + protected function getExceptionContext(Throwable $exception): array + { + $context = []; + + if ($exception instanceof QueryException) { + $connectionName = $exception->getConnectionName(); + if ($connectionName !== '') { + $context['connection'] = $connectionName; + } + } + + return $context; } /** @@ -153,7 +179,10 @@ protected function getMessage(Throwable $exception, bool $isPrevious = false, bo } if ($includeTrace) { - $trace = Debugger::formatTrace($exception, ['format' => 'shortPoints']); + $trace = Debugger::formatTrace( + $exception, + ['format' => Configure::read('Error.traceFormat', 'shortPoints')], + ); assert(is_array($trace)); $message .= "\nStack Trace:\n"; foreach ($trace as $line) { diff --git a/app/vendor/cakephp/cakephp/src/Error/ErrorTrap.php b/app/vendor/cakephp/cakephp/src/Error/ErrorTrap.php index 1ae8d83e2..bc4ba655d 100644 --- a/app/vendor/cakephp/cakephp/src/Error/ErrorTrap.php +++ b/app/vendor/cakephp/cakephp/src/Error/ErrorTrap.php @@ -117,7 +117,7 @@ public function handleError( if (!(error_reporting() & $code)) { return false; } - if ($code === E_USER_ERROR || $code === E_ERROR || $code === E_PARSE) { + if (in_array($code, [E_USER_ERROR, E_ERROR, E_PARSE], true)) { throw new FatalErrorException($description, $code, $file, $line); } diff --git a/app/vendor/cakephp/cakephp/src/Error/ExceptionTrap.php b/app/vendor/cakephp/cakephp/src/Error/ExceptionTrap.php index 5b6e9e295..5e91d1c02 100644 --- a/app/vendor/cakephp/cakephp/src/Error/ExceptionTrap.php +++ b/app/vendor/cakephp/cakephp/src/Error/ExceptionTrap.php @@ -40,7 +40,7 @@ class ExceptionTrap * Configuration options. Generally these will be defined in your config/app.php * * - `exceptionRenderer` - string - The class responsible for rendering uncaught exceptions. - * The chosen class will be used for for both CLI and web environments. If you want different + * The chosen class will be used for both CLI and web environments. If you want different * classes used in CLI and web environments you'll need to write that conditional logic as well. * The conventional location for custom renderers is in `src/Error`. Your exception renderer needs to * implement the `render()` method and return either a string or Http\Response. @@ -187,7 +187,7 @@ public function register(): void */ public function unregister(): void { - if (static::$registeredTrap == $this) { + if (static::$registeredTrap === $this) { $this->disabled = true; static::$registeredTrap = null; restore_exception_handler(); @@ -271,6 +271,7 @@ public function handleShutdown(): void E_USER_ERROR, E_ERROR, E_PARSE, + E_COMPILE_ERROR, ]; if (!in_array($error['type'], $fatals, true)) { return; @@ -293,7 +294,7 @@ public function handleShutdown(): void public function increaseMemoryLimit(int $additionalKb): void { $limit = ini_get('memory_limit'); - if ($limit === false || $limit === '' || $limit === '-1') { + if (in_array($limit, [false, '', '-1'], true)) { return; } $limit = trim($limit); diff --git a/app/vendor/cakephp/cakephp/src/Error/Middleware/ErrorHandlerMiddleware.php b/app/vendor/cakephp/cakephp/src/Error/Middleware/ErrorHandlerMiddleware.php index ddf3ba19a..a0f0046e7 100644 --- a/app/vendor/cakephp/cakephp/src/Error/Middleware/ErrorHandlerMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Error/Middleware/ErrorHandlerMiddleware.php @@ -53,7 +53,7 @@ class ErrorHandlerMiddleware implements MiddlewareInterface /** * Default configuration values. * - * Ignored if contructor is passed an ExceptionTrap instance. + * Ignored if constructor is passed an ExceptionTrap instance. * * Configuration keys and values are shared with `ExceptionTrap`. * This class will pass its configuration onto the ExceptionTrap diff --git a/app/vendor/cakephp/cakephp/src/Error/Renderer/WebExceptionRenderer.php b/app/vendor/cakephp/cakephp/src/Error/Renderer/WebExceptionRenderer.php index 9b08d88af..0c10e1c3f 100644 --- a/app/vendor/cakephp/cakephp/src/Error/Renderer/WebExceptionRenderer.php +++ b/app/vendor/cakephp/cakephp/src/Error/Renderer/WebExceptionRenderer.php @@ -151,6 +151,7 @@ protected function _getController(): Controller $class = ''; try { + /** @var array $params */ $params = $request->getAttribute('params'); $params['controller'] = 'Error'; @@ -197,7 +198,7 @@ protected function _getController(): Controller */ protected function clearOutput(): void { - if (in_array(PHP_SAPI, ['cli', 'phpdbg'])) { + if (in_array(PHP_SAPI, ['cli', 'phpdbg'], true)) { return; } while (ob_get_level()) { @@ -235,7 +236,7 @@ public function render(): ResponseInterface $exceptions = [$exception]; $previous = $exception->getPrevious(); - while ($previous != null) { + while ($previous !== null) { $exceptions[] = $previous; $previous = $previous->getPrevious(); } @@ -447,6 +448,15 @@ protected function _outputMessage(string $template, bool $skipControllerCheck = return $this->_outputMessageSafe('error500'); } + // If we have a prefix/plugin and the template is error400 or error500, + // try to render from the base Error directory before falling back to error500 + if ( + ($template === 'error400' || $template === 'error500') && + ($this->controller->getRequest()->getParam('prefix') || $this->controller->getPlugin()) + ) { + return $this->_outputMessageSafe($template); + } + return $this->_outputMessage('error500', true); } catch (MissingPluginException $e) { Log::warning( diff --git a/app/vendor/cakephp/cakephp/src/Error/functions_global.php b/app/vendor/cakephp/cakephp/src/Error/functions_global.php index aecc1068a..9cb473074 100644 --- a/app/vendor/cakephp/cakephp/src/Error/functions_global.php +++ b/app/vendor/cakephp/cakephp/src/Error/functions_global.php @@ -65,7 +65,7 @@ function debug(mixed $var, ?bool $showHtml = null, bool $showFrom = true): mixed * will be displayed. * - `start` - The stack frame to start generating a trace from. Defaults to 1 * - * @param array $options Format for outputting stack trace + * @param array{depth?: int, args?: bool, start?: int} $options Format for outputting stack trace * @return void */ function stackTrace(array $options = []): void diff --git a/app/vendor/cakephp/cakephp/src/Event/Decorator/AbstractDecorator.php b/app/vendor/cakephp/cakephp/src/Event/Decorator/AbstractDecorator.php index 1f2242fae..f34d7a973 100644 --- a/app/vendor/cakephp/cakephp/src/Event/Decorator/AbstractDecorator.php +++ b/app/vendor/cakephp/cakephp/src/Event/Decorator/AbstractDecorator.php @@ -51,11 +51,12 @@ public function __construct(callable $callable, array $options = []) * Invoke * * @link https://secure.php.net/manual/en/language.oop5.magic.php#object.invoke + * @param mixed ...$args Arguments for the callable. * @return mixed */ - public function __invoke(): mixed + public function __invoke(mixed ...$args): mixed { - return $this->_call(func_get_args()); + return $this->_call($args); } /** diff --git a/app/vendor/cakephp/cakephp/src/Event/Event.php b/app/vendor/cakephp/cakephp/src/Event/Event.php index 85a114497..cc1163d45 100644 --- a/app/vendor/cakephp/cakephp/src/Event/Event.php +++ b/app/vendor/cakephp/cakephp/src/Event/Event.php @@ -36,8 +36,7 @@ class Event implements EventInterface /** * The object this event applies to (usually the same object that generates the event) * - * @var object|null - * @phpstan-var TSubject|null + * @var TSubject|null */ protected ?object $_subject = null; @@ -75,7 +74,7 @@ class Event implements EventInterface * ``` * * @param string $name Name of the event - * @param object|null $subject the object that this event applies to + * @param TSubject|null $subject the object that this event applies to * (usually the object that is generating the event). * @param array $data any value you wish to be transported * with this event to it can be read by listeners. @@ -103,9 +102,8 @@ public function getName(): string * * If the event has no subject an exception will be raised. * - * @return object + * @return TSubject * @throws \Cake\Core\Exception\CakeException - * @phpstan-return TSubject */ public function getSubject(): object { diff --git a/app/vendor/cakephp/cakephp/src/Event/EventDispatcherTrait.php b/app/vendor/cakephp/cakephp/src/Event/EventDispatcherTrait.php index 5eedc9d1f..0856b75ed 100644 --- a/app/vendor/cakephp/cakephp/src/Event/EventDispatcherTrait.php +++ b/app/vendor/cakephp/cakephp/src/Event/EventDispatcherTrait.php @@ -27,9 +27,9 @@ trait EventDispatcherTrait * Instance of the Cake\Event\EventManager this object is using * to dispatch inner events. * - * @var \Cake\Event\EventManagerInterface|null + * @var \Cake\Event\EventManagerInterface */ - protected ?EventManagerInterface $_eventManager = null; + protected EventManagerInterface $_eventManager; /** * Default class name for new event objects. @@ -78,12 +78,16 @@ public function setEventManager(EventManagerInterface $eventManager) * @param TSubject|null $subject The object that this event applies to * ($this by default). * @return \Cake\Event\EventInterface + * @phpstan-ignore missingType.generics */ - public function dispatchEvent(string $name, array $data = [], ?object $subject = null): EventInterface + public function dispatchEvent(string $name, array $data = [], ?object $subject = null): EventInterface // @phpstan-ignore missingType.generics { $subject ??= $this; - /** @var \Cake\Event\EventInterface $event Coerce for psalm/phpstan */ + /** + * @var \Cake\Event\EventInterface $event Coerce for psalm/phpstan + * @phpstan-ignore missingType.generics (TSubject may itself be generic) + */ $event = new $this->_eventClass($name, $subject, $data); $this->getEventManager()->dispatch($event); diff --git a/app/vendor/cakephp/cakephp/src/Event/EventInterface.php b/app/vendor/cakephp/cakephp/src/Event/EventInterface.php index 97673d78c..81dfd59e9 100644 --- a/app/vendor/cakephp/cakephp/src/Event/EventInterface.php +++ b/app/vendor/cakephp/cakephp/src/Event/EventInterface.php @@ -21,7 +21,7 @@ * payload. The name can be any string that uniquely identifies the event across the application, while the subject * represents the object that the event applies to. * - * @template TSubject of object + * @template-covariant TSubject of object */ interface EventInterface { @@ -35,8 +35,7 @@ public function getName(): string; /** * Returns the subject of this event. * - * @return object - * @phpstan-return TSubject + * @return TSubject */ public function getSubject(): object; diff --git a/app/vendor/cakephp/cakephp/src/Event/EventList.php b/app/vendor/cakephp/cakephp/src/Event/EventList.php index 6e22cfffd..174f81d3d 100644 --- a/app/vendor/cakephp/cakephp/src/Event/EventList.php +++ b/app/vendor/cakephp/cakephp/src/Event/EventList.php @@ -17,19 +17,25 @@ namespace Cake\Event; use ArrayAccess; +use ArrayIterator; use Countable; +use IteratorAggregate; +use Traversable; +use function Cake\Core\deprecationWarning; /** * The Event List * - * @template-implements \ArrayAccess + * @template Tsubject of object + * @implements \ArrayAccess> + * @implements \IteratorAggregate<\Cake\Event\EventInterface> */ -class EventList implements ArrayAccess, Countable +class EventList implements ArrayAccess, Countable, IteratorAggregate { /** * Events list * - * @var array<\Cake\Event\EventInterface> + * @var array<\Cake\Event\EventInterface> */ protected array $_events = []; @@ -46,7 +52,7 @@ public function flush(): void /** * Adds an event to the list when event listing is enabled. * - * @param \Cake\Event\EventInterface $event An event to the list of dispatched events. + * @param \Cake\Event\EventInterface $event An event to the list of dispatched events. * @return void */ public function add(EventInterface $event): void @@ -57,34 +63,43 @@ public function add(EventInterface $event): void /** * Whether a offset exists * + * @deprecated 5.3.0 Array access for `EventList` is deprecated, use `EventList::hasEvent()` instead. * @link https://secure.php.net/manual/en/arrayaccess.offsetexists.php * @param mixed $offset An offset to check for. * @return bool True on success or false on failure. */ public function offsetExists(mixed $offset): bool { + deprecationWarning( + '5.3.0', + 'Array access for `EventList` is deprecated, use `EventList::hasEvent()` instead.', + ); + return isset($this->_events[$offset]); } /** * Offset to retrieve * + * @deprecated 5.3.0 Array access for `EventList` is deprecated, you can iterate the instance instead. * @link https://secure.php.net/manual/en/arrayaccess.offsetget.php * @param mixed $offset The offset to retrieve. - * @return \Cake\Event\EventInterface|null + * @return \Cake\Event\EventInterface|null */ public function offsetGet(mixed $offset): ?EventInterface { - if (!$this->offsetExists($offset)) { - return null; - } + deprecationWarning( + '5.3.0', + 'Array access for `EventList` is deprecated, you can iterate the instance instead.', + ); - return $this->_events[$offset]; + return $this->_events[$offset] ?? null; } /** * Offset to set * + * @deprecated 5.3.0 Array access for `EventList` is deprecated, use `EventList::add() instead.`. * @link https://secure.php.net/manual/en/arrayaccess.offsetset.php * @param mixed $offset The offset to assign the value to. * @param mixed $value The value to set. @@ -92,21 +107,43 @@ public function offsetGet(mixed $offset): ?EventInterface */ public function offsetSet(mixed $offset, mixed $value): void { + deprecationWarning( + '5.3.0', + 'Array access for `EventList` is deprecated, use `EventList::add() instead.', + ); + $this->_events[$offset] = $value; } /** * Offset to unset * + * @deprecated 5.3.0 Array access for `EventList` is deprecated. + * Individual events cannot be unset anymore, use `EventList::flush()` to clear the list. * @link https://secure.php.net/manual/en/arrayaccess.offsetunset.php * @param mixed $offset The offset to unset. * @return void */ public function offsetUnset(mixed $offset): void { + deprecationWarning( + '5.3.0', + 'Array access for `EventList` is deprecated.' + . ' Individual events cannot be unset anymore, use `EventList::flush()` to clear the list.', + ); unset($this->_events[$offset]); } + /** + * Retrieve an external iterator + * + * @return \Traversable<\Cake\Event\EventInterface> + */ + public function getIterator(): Traversable + { + return new ArrayIterator($this->_events); + } + /** * Count elements of an object * diff --git a/app/vendor/cakephp/cakephp/src/Event/EventManager.php b/app/vendor/cakephp/cakephp/src/Event/EventManager.php index 88b16d9d1..1c2c652cd 100644 --- a/app/vendor/cakephp/cakephp/src/Event/EventManager.php +++ b/app/vendor/cakephp/cakephp/src/Event/EventManager.php @@ -61,7 +61,7 @@ class EventManager implements EventManagerInterface /** * The event list object. * - * @var \Cake\Event\EventList|null + * @var \Cake\Event\EventList|null */ protected ?EventList $_eventList = null; @@ -424,7 +424,7 @@ public function matchingListeners(string $eventKeyPattern): array /** * Returns the event list. * - * @return \Cake\Event\EventList|null + * @return \Cake\Event\EventList|null */ public function getEventList(): ?EventList { @@ -471,7 +471,7 @@ public function isTrackingEvents(): bool /** * Enables the listing of dispatched events. * - * @param \Cake\Event\EventList $eventList The event list object to use. + * @param \Cake\Event\EventList $eventList The event list object to use. * @return $this */ public function setEventList(EventList $eventList) @@ -512,12 +512,8 @@ public function __debugInfo(): array } $properties['_listeners'][$key] = $listenerCount . ' listener(s)'; } - if ($this->_eventList) { - $count = count($this->_eventList); - for ($i = 0; $i < $count; $i++) { - assert(!empty($this->_eventList[$i]), 'Given event item not present'); - - $event = $this->_eventList[$i]; + if ($this->_eventList !== null) { + foreach ($this->_eventList as $event) { try { $subject = $event->getSubject(); $properties['_dispatchedEvents'][] = $event->getName() . ' with subject ' . $subject::class; diff --git a/app/vendor/cakephp/cakephp/src/Event/composer.json b/app/vendor/cakephp/cakephp/src/Event/composer.json index 600b926c8..942616483 100644 --- a/app/vendor/cakephp/cakephp/src/Event/composer.json +++ b/app/vendor/cakephp/cakephp/src/Event/composer.json @@ -23,18 +23,19 @@ "source": "https://github.com/cakephp/event" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev" + "php": ">=8.2", + "cakephp/core": "^5.3.0" }, "autoload": { "psr-4": { "Cake\\Event\\": "." } }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Form/Form.php b/app/vendor/cakephp/cakephp/src/Form/Form.php index ff492c193..e5270cc49 100644 --- a/app/vendor/cakephp/cakephp/src/Form/Form.php +++ b/app/vendor/cakephp/cakephp/src/Form/Form.php @@ -23,6 +23,8 @@ use Cake\Utility\Hash; use Cake\Validation\ValidatorAwareInterface; use Cake\Validation\ValidatorAwareTrait; +use ReflectionMethod; +use function Cake\Core\deprecationWarning; /** * Form abstraction used to create forms not tied to ORM backed models, @@ -33,7 +35,7 @@ * * This class is most useful when subclassed. In a subclass you * should define the `_buildSchema`, `validationDefault` and optionally, - * the `_execute` methods. These allow you to declare your form's + * the `process` methods. These allow you to declare your form's * fields, validation and primary action respectively. * * Forms are conventionally placed in the `App\Form` namespace. @@ -211,12 +213,22 @@ public function getErrors(): array /** * Returns validation errors for the given field * - * @param string $field Field name to get the errors from. + * Supports dot notation for nested fields. For example: + * - `$form->getError('Common.field_name')` + * - `$form->getError('parent.level.deep_field')` + * + * @param string $field Field name to get the errors from. Supports dot notation for nested fields. * @return array The validation errors for the given field. */ public function getError(string $field): array { - return $this->_errors[$field] ?? []; + if (isset($this->_errors[$field])) { + return $this->_errors[$field]; + } + + $error = Hash::get($this->_errors, $field); + + return is_array($error) ? $error : []; } /** @@ -243,7 +255,7 @@ public function setErrors(array $errors) /** * Execute the form if it is valid. * - * First validates the form, then calls the `_execute()` hook method. + * First validates the form, then calls the `process()` hook method. * This hook method can be implemented in subclasses to perform * the action of the form. This may be sending email, interacting * with a remote API, or anything else you may need. @@ -256,21 +268,45 @@ public function setErrors(array $errors) * @param array $data Form data. * @param array $options List of options. * @return bool False on validation failure, otherwise returns the - * result of the `_execute()` method. + * result of the `process()` method. */ public function execute(array $data, array $options = []): bool { - $this->_data = $data; + // check for deprecated _execute() method - https://github.com/cakephp/cakephp/pull/18725 + $childClass = static::class; + $parentClass = self::class; + $method = new ReflectionMethod($childClass, '_execute'); + $hasOverwrittenExecute = $method->getDeclaringClass()->getName() !== $parentClass; + $this->_data = $data; $options += ['validate' => true]; if ($options['validate'] === false) { - return $this->_execute($data); + if ($hasOverwrittenExecute) { + deprecationWarning( + '5.3.0', + 'The _execute() method is deprecated. Override the process() method instead.', + ); + + return $this->_execute($data); + } + + return $this->process($data); } $validator = $options['validate'] === true ? static::DEFAULT_VALIDATOR : $options['validate']; + $validateResult = $this->validate($data, $validator); + + if ($hasOverwrittenExecute) { + deprecationWarning( + '5.3.0', + 'The _execute() method is deprecated. Override the process() method instead.', + ); + + return $validateResult && $this->_execute($data); + } - return $this->validate($data, $validator) && $this->_execute($data); + return $validateResult && $this->process($data); } /** @@ -280,8 +316,22 @@ public function execute(array $data, array $options = []): bool * * @param array $data Form data. * @return bool + * @deprecated 5.3.0 Override process() instead. */ protected function _execute(array $data): bool + { + return $this->process($data); + } + + /** + * Hook method to be implemented in subclasses. + * + * Used by `execute()` to execute the form's action. + * + * @param array $data Form data. + * @return bool + */ + protected function process(array $data): bool { return true; } diff --git a/app/vendor/cakephp/cakephp/src/Form/FormProtector.php b/app/vendor/cakephp/cakephp/src/Form/FormProtector.php index 77f7a6038..b303a3629 100644 --- a/app/vendor/cakephp/cakephp/src/Form/FormProtector.php +++ b/app/vendor/cakephp/cakephp/src/Form/FormProtector.php @@ -172,7 +172,7 @@ protected function getFieldNameArray(string $name): array return Hash::filter(explode('.', $name)); } $parts = explode('[', $name); - $parts = array_map(function ($el) { + $parts = array_map(function (string $el) { return trim($el, ']'); }, $parts); diff --git a/app/vendor/cakephp/cakephp/src/Form/Schema.php b/app/vendor/cakephp/cakephp/src/Form/Schema.php index 02a40e6e0..942e3aae3 100644 --- a/app/vendor/cakephp/cakephp/src/Form/Schema.php +++ b/app/vendor/cakephp/cakephp/src/Form/Schema.php @@ -75,7 +75,7 @@ public function addField(string $name, array|string $attrs) } /** - * Removes a field to the schema. + * Removes a field from the schema. * * @param string $name The field to remove. * @return $this diff --git a/app/vendor/cakephp/cakephp/src/Form/composer.json b/app/vendor/cakephp/cakephp/src/Form/composer.json index 9458465d8..fecc6fb0d 100644 --- a/app/vendor/cakephp/cakephp/src/Form/composer.json +++ b/app/vendor/cakephp/cakephp/src/Form/composer.json @@ -21,19 +21,20 @@ "source": "https://github.com/cakephp/form" }, "require": { - "php": ">=8.1", - "cakephp/event": "5.2.*@dev", - "cakephp/validation":"5.2.*@dev" + "php": ">=8.2", + "cakephp/event": "^5.3.0", + "cakephp/validation":"^5.3.0" }, "autoload": { "psr-4": { "Cake\\Form\\": "." } }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Http/BaseApplication.php b/app/vendor/cakephp/cakephp/src/Http/BaseApplication.php index 589b89c85..0a073bb04 100644 --- a/app/vendor/cakephp/cakephp/src/Http/BaseApplication.php +++ b/app/vendor/cakephp/cakephp/src/Http/BaseApplication.php @@ -85,7 +85,7 @@ abstract class BaseApplication implements /** * Controller factory * - * @var \Cake\Http\ControllerFactoryInterface|null + * @var \Cake\Http\ControllerFactoryInterface<\Cake\Controller\Controller>|null */ protected ?ControllerFactoryInterface $controllerFactory = null; @@ -101,7 +101,7 @@ abstract class BaseApplication implements * * @param string $configDir The directory the bootstrap configuration is held in. * @param \Cake\Event\EventManagerInterface|null $eventManager Application event manager instance. - * @param \Cake\Http\ControllerFactoryInterface|null $controllerFactory Controller factory. + * @param \Cake\Http\ControllerFactoryInterface<\Cake\Controller\Controller>|null $controllerFactory Controller factory. */ public function __construct( string $configDir, diff --git a/app/vendor/cakephp/cakephp/src/Http/Client.php b/app/vendor/cakephp/cakephp/src/Http/Client.php index 2fc653448..43ad1d454 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client.php @@ -204,7 +204,7 @@ public function __construct(array $config = []) $adapter = Stream::class; } } else { - $this->setConfig('adapter', null); + $this->deleteConfig('adapter'); } if (is_string($adapter)) { @@ -215,7 +215,7 @@ public function __construct(array $config = []) if (!empty($this->_config['cookieJar'])) { $this->_cookies = $this->_config['cookieJar']; - $this->setConfig('cookieJar', null); + $this->deleteConfig('cookieJar'); } else { $this->_cookies = new CookieCollection(); } @@ -554,7 +554,17 @@ public static function clearMockResponses(): void * * ### Matching Requests * - * TODO finish this. + * Request matching is done on the HTTP method and URL. If the URL is + * an exact match, the response will be returned. You can use `*` as + * a wildcard to match any suffix: + * + * ``` + * // Match any URL starting with https://example.com/api/ + * Client::addMockResponse('GET', 'https://example.com/api/*', $response); + * ``` + * + * For more complex matching, use the `match` option with a closure + * that receives the request and returns a boolean. * * ### Options * @@ -689,11 +699,9 @@ protected function _createRequest(string $method, string $url, mixed $data, arra * Returns headers for Accept/Content-Type based on a short type * or full mime-type. * - * @phpstan-param non-empty-string $type * @param string $type short type alias or full mimetype. - * @return array Headers to set on the request. + * @return array{'Accept': non-empty-string, 'Content-Type': non-empty-string} Headers to set on the request. * @throws \Cake\Core\Exception\CakeException When an unknown type alias is used. - * @phpstan-return array */ protected function _typeHeaders(string $type): array { diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Curl.php b/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Curl.php index 97437cfed..40aca2afe 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Curl.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Curl.php @@ -46,6 +46,10 @@ public function send(RequestInterface $request, array $options): array } $ch = curl_init(); + if ($ch === false) { + throw new ClientException('Could not initialize curl session.'); + } + $options = $this->buildOptions($request, $options); curl_setopt_array($ch, $options); diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Mock.php b/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Mock.php index 99391049d..5bb55a14b 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Mock.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Mock.php @@ -71,8 +71,9 @@ public function addResponse(RequestInterface $request, Response $response, array * Find a response if one exists. * * @param \Psr\Http\Message\RequestInterface $request The request to match - * @param array $options Unused. - * @return array<\Cake\Http\Client\Response> The matched response or an empty array for no matches. + * @param array $options The options are passed to match callbacks. + * @return array<\Cake\Http\Client\Response> The matched response. + * @throws \Cake\Http\Client\Exception\MissingResponseException When no mock response matches. */ public function send(RequestInterface $request, array $options): array { @@ -81,12 +82,12 @@ public function send(RequestInterface $request, array $options): array $requestUri = (string)$request->getUri(); foreach ($this->responses as $index => $mock) { - /** @var \Psr\Http\Message\RequestInterface $request */ - $request = $mock['request']; - if ($method !== $request->getMethod()) { + /** @var \Psr\Http\Message\RequestInterface $mockRequest */ + $mockRequest = $mock['request']; + if ($method !== $mockRequest->getMethod()) { continue; } - if (!$this->urlMatches($requestUri, $mock['request'])) { + if (!$this->urlMatches($requestUri, $mockRequest)) { continue; } if (isset($mock['options']['match'])) { diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Stream.php b/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Stream.php index 79139c829..ad1d28c55 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Stream.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Adapter/Stream.php @@ -88,7 +88,7 @@ public function send(RequestInterface $request, array $options): array * Creates one or many response objects based on the number * of redirects that occurred. * - * @param array $headers The list of headers from the request(s) + * @param list $headers The list of headers from the request(s) * @param string $content The response content. * @return array<\Cake\Http\Client\Response> The list of responses from the request(s) */ diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Digest.php b/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Digest.php index 101bfe24f..6014cdb70 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Digest.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Digest.php @@ -87,6 +87,8 @@ class Digest /** * Constructor * + * Deprecated: $options list is unused and will be removed in 6.0. + * * @param \Cake\Http\Client $client Http client object. * @param array|null $options Options list. */ diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Oauth.php b/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Oauth.php index d578534b9..895be98c0 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Oauth.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Auth/Oauth.php @@ -217,7 +217,6 @@ protected function _rsaSha1(Request $request, array $credentials): string rewind($resource); $credentials['privateKeyPassphrase'] = $passphrase; } - /** @var \OpenSSLAsymmetricKey|false $privateKey */ $privateKey = openssl_pkey_get_private($credentials['privateKey'], $credentials['privateKeyPassphrase']); $this->checkSslError(); @@ -382,7 +381,7 @@ protected function checkSslError(): void $error .= $text; } - if (strlen($error) > 0) { + if ($error !== '') { throw new CakeException('openssl error: ' . $error); } } diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/FormData.php b/app/vendor/cakephp/cakephp/src/Http/Client/FormData.php index e8597b9c8..9b0c87aca 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/FormData.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/FormData.php @@ -196,9 +196,9 @@ public function addFile(string $name, mixed $value): FormDataPart */ public function addRecursive(string $name, mixed $value): void { - foreach ($value as $key => $value) { + foreach ($value as $key => $item) { $key = $name . '[' . $key . ']'; - $this->add($key, $value); + $this->add($key, $item); } } diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Message.php b/app/vendor/cakephp/cakephp/src/Http/Client/Message.php index 30beaa23e..c3b978bb4 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Message.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Message.php @@ -15,6 +15,8 @@ */ namespace Cake\Http\Client; +use function Cake\Core\deprecationWarning; + /** * Base class for other HTTP requests/responses * @@ -153,6 +155,7 @@ class Message * The array of cookies in the response. * * @var array + * @deprecated 5.3.0 Use getCookies() instead. */ protected array $_cookies = []; @@ -160,9 +163,12 @@ class Message * Get all cookies * * @return array + * @deprecated 5.3.0 Use getCookies() instead. */ public function cookies(): array { + deprecationWarning('5.3.0', 'Use `getCookies()` instead.'); + return $this->_cookies; } } diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Request.php b/app/vendor/cakephp/cakephp/src/Http/Client/Request.php index 0e3ef10e2..16f2b7047 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Request.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Request.php @@ -55,7 +55,7 @@ public function __construct( 'User-Agent' => ini_get('user_agent') ?: 'CakePHP', ]; $this->addHeaders($headers); - if ($data === null || $data === '' || $data === []) { + if (in_array($data, [null, '', []], true)) { $this->stream = new Stream('php://memory', 'rw'); } else { $this->setContent($data); diff --git a/app/vendor/cakephp/cakephp/src/Http/Client/Response.php b/app/vendor/cakephp/cakephp/src/Http/Client/Response.php index 22adf538c..02ca14833 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Client/Response.php +++ b/app/vendor/cakephp/cakephp/src/Http/Client/Response.php @@ -177,8 +177,7 @@ protected function _decodeGzipBody(string $body): string protected function _parseHeaders(array $headers): void { foreach ($headers as $value) { - if (str_starts_with($value, 'HTTP/')) { - preg_match('/HTTP\/([\d.]+) ([0-9]+)(.*)/i', $value, $matches); + if (preg_match('/^HTTP\/([\d.]+) ([0-9]+)(.*)/i', $value, $matches)) { $this->protocol = $matches[1]; $this->code = (int)$matches[2]; $this->reasonPhrase = trim($matches[3]); diff --git a/app/vendor/cakephp/cakephp/src/Http/Cookie/Cookie.php b/app/vendor/cakephp/cakephp/src/Http/Cookie/Cookie.php index 0afba1384..4eae6cb8d 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Cookie/Cookie.php +++ b/app/vendor/cakephp/cakephp/src/Http/Cookie/Cookie.php @@ -214,7 +214,7 @@ public static function setDefaults(array $options): void * @param array|string|float|int|bool $value Value of the cookie * @param array $options Cookies options. * @return static - * @see \Cake\Cookie\Cookie::setDefaults() + * @see \Cake\Http\Cookie\Cookie::setDefaults() */ public static function create(string $name, array|string|float|int|bool $value, array $options = []): static { @@ -318,10 +318,9 @@ public static function createFromHeaderString(string $cookie, array $defaults = $name = $data['name']; $value = $data['value']; - assert(is_string($name) && is_string($value)); unset($data['name'], $data['value']); - /** @phpstan-ignore-next-line */ + /** @phpstan-ignore return.type */ return Cookie::create( $name, $value, diff --git a/app/vendor/cakephp/cakephp/src/Http/Exception/HttpException.php b/app/vendor/cakephp/cakephp/src/Http/Exception/HttpException.php index e91e5f67c..6c279b892 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Exception/HttpException.php +++ b/app/vendor/cakephp/cakephp/src/Http/Exception/HttpException.php @@ -33,26 +33,26 @@ class HttpException extends CakeException implements HttpErrorCodeInterface protected int $_defaultCode = 500; /** - * @var array + * @var array|string> */ protected array $headers = []; /** * Set a single HTTP response header. * - * @param string $header Header name + * @param non-empty-string $header Header name * @param array|string|null $value Header value * @return void */ public function setHeader(string $header, array|string|null $value = null): void { - $this->headers[$header] = $value; + $this->headers[$header] = $value ?? ''; } /** * Sets HTTP response headers. * - * @param array $headers Array of header name and value pairs. + * @param array|string> $headers Array of header name and value pairs. * @return void */ public function setHeaders(array $headers): void @@ -63,7 +63,7 @@ public function setHeaders(array $headers): void /** * Returns array of response headers. * - * @return array + * @return array|string> */ public function getHeaders(): array { diff --git a/app/vendor/cakephp/cakephp/src/Http/Exception/RedirectException.php b/app/vendor/cakephp/cakephp/src/Http/Exception/RedirectException.php index b651789d8..1b22b2fe8 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Exception/RedirectException.php +++ b/app/vendor/cakephp/cakephp/src/Http/Exception/RedirectException.php @@ -36,7 +36,7 @@ class RedirectException extends HttpException * * @param string $target The URL to redirect to. * @param int $code The exception code that will be used as a HTTP status code - * @param array $headers The headers that should be sent in the unauthorized challenge response. + * @param array|string> $headers The headers that should be sent in the unauthorized challenge response. */ public function __construct(string $target, int $code = 302, array $headers = []) { diff --git a/app/vendor/cakephp/cakephp/src/Http/Exception/TooManyRequestsException.php b/app/vendor/cakephp/cakephp/src/Http/Exception/TooManyRequestsException.php new file mode 100644 index 000000000..7dd8a18a4 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Http/Exception/TooManyRequestsException.php @@ -0,0 +1,42 @@ + $url]; - $params = $matches[2]; + $params = $matches[2] ?? null; if (!$params) { return $parsedParams; } @@ -97,9 +97,7 @@ public static function parseAccept(string $header): array } } - if (!isset($accept[$prefValue])) { - $accept[$prefValue] = []; - } + $accept[$prefValue] ??= []; if ($prefValue) { $accept[$prefValue][] = $value; } diff --git a/app/vendor/cakephp/cakephp/src/Http/Middleware/BodyParserMiddleware.php b/app/vendor/cakephp/cakephp/src/Http/Middleware/BodyParserMiddleware.php index ff2954bed..6d2ca272a 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Middleware/BodyParserMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Http/Middleware/BodyParserMiddleware.php @@ -202,7 +202,7 @@ protected function decodeXml(string $body): array try { $xml = Xml::build($body, ['return' => 'domdocument', 'readFile' => false]); // We might not get child nodes if there are nested inline entities. - /** @var \DOMNodeList $domNodeList */ + /** @var \DOMNodeList<\DOMNode> $domNodeList */ $domNodeList = $xml->childNodes; if ((int)$domNodeList->length > 0) { return Xml::toArray($xml); diff --git a/app/vendor/cakephp/cakephp/src/Http/Middleware/CspMiddleware.php b/app/vendor/cakephp/cakephp/src/Http/Middleware/CspMiddleware.php index 0a8748ee2..1b15a2c44 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Middleware/CspMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Http/Middleware/CspMiddleware.php @@ -86,7 +86,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface if ($this->getConfig('scriptNonce')) { $request = $request->withAttribute('cspScriptNonce', $this->csp->nonce('script-src')); } - if ($this->getconfig('styleNonce')) { + if ($this->getConfig('styleNonce')) { $request = $request->withAttribute('cspStyleNonce', $this->csp->nonce('style-src')); } $response = $handler->handle($request); diff --git a/app/vendor/cakephp/cakephp/src/Http/Middleware/CsrfProtectionMiddleware.php b/app/vendor/cakephp/cakephp/src/Http/Middleware/CsrfProtectionMiddleware.php index db00008da..17875c2ac 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Middleware/CsrfProtectionMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Http/Middleware/CsrfProtectionMiddleware.php @@ -53,7 +53,7 @@ class CsrfProtectionMiddleware implements MiddlewareInterface * Config for the CSRF handling. * * - `cookieName` The name of the cookie to send. - * - `expiry` A strotime compatible value of how long the CSRF token should last. + * - `expiry` A strtotime compatible value of how long the CSRF token should last. * Defaults to browser session. * - `secure` Whether the cookie will be set with the Secure flag. Defaults to false. * - `httponly` Whether the cookie will be set with the HttpOnly flag. Defaults to false. diff --git a/app/vendor/cakephp/cakephp/src/Http/Middleware/EncryptedCookieMiddleware.php b/app/vendor/cakephp/cakephp/src/Http/Middleware/EncryptedCookieMiddleware.php index 7cb24291a..fcd63f35c 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Middleware/EncryptedCookieMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Http/Middleware/EncryptedCookieMiddleware.php @@ -33,7 +33,7 @@ * * Cookies in request data will be decrypted, while cookies in response headers will * be encrypted automatically. If the response is a {@link \Cake\Http\Response}, the cookie - * data set with `withCookie()` and `cookie()`` will also be encrypted. + * data set with `withCookie()` and `cookie()` will also be encrypted. * * The encryption types and padding are compatible with those used by CookieComponent * for backwards compatibility. diff --git a/app/vendor/cakephp/cakephp/src/Http/Middleware/RateLimitMiddleware.php b/app/vendor/cakephp/cakephp/src/Http/Middleware/RateLimitMiddleware.php new file mode 100644 index 000000000..fe201b50b --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Http/Middleware/RateLimitMiddleware.php @@ -0,0 +1,461 @@ + + */ + protected array $defaultConfig = [ + 'limit' => 60, + 'window' => 60, + 'identifier' => self::IDENTIFIER_IP, + 'strategy' => self::STRATEGY_SLIDING_WINDOW, + 'strategyClass' => null, + 'cache' => 'default', + 'headers' => true, + 'message' => 'Rate limit exceeded. Please try again later.', + 'skipCheck' => null, + 'costCallback' => null, + 'identifierCallback' => null, + 'limitCallback' => null, + 'ipHeader' => 'x-forwarded-for', + 'includeRetryAfter' => true, + 'keyGenerator' => null, + 'tokenHeaders' => ['Authorization', 'X-API-Key'], + 'limiters' => [], + 'limiterResolver' => null, + ]; + + /** + * Configuration + * + * @var array + */ + protected array $config; + + /** + * Constructor + * + * @param array $config Configuration options + */ + public function __construct(array $config = []) + { + $this->config = $config + $this->defaultConfig; + } + + /** + * Process the request and add rate limiting + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @param \Psr\Http\Server\RequestHandlerInterface $handler The handler + * @return \Psr\Http\Message\ResponseInterface + */ + public function process(ServerRequestInterface $request, RequestHandlerInterface $handler): ResponseInterface + { + if ($this->shouldSkip($request)) { + return $handler->handle($request); + } + + $limiterConfig = $this->resolveLimiterConfig($request); + $identifier = $this->getIdentifier($request); + $limit = $limiterConfig['limit'] ?? $this->getLimit($request, $identifier); + $window = $limiterConfig['window'] ?? $this->config['window']; + $cost = $this->getCost($request); + $key = $this->generateKey($identifier, $request); + + $rateLimiter = $this->getRateLimiter($limiterConfig); + $result = $rateLimiter->attempt($key, $limit, $window, $cost); + + if (!$result['allowed']) { + $message = $limiterConfig['message'] ?? $this->config['message']; + $exception = new TooManyRequestsException($message); + if ($this->config['includeRetryAfter'] && isset($result['reset'])) { + $retryAfter = max(1, $result['reset'] - time()); + $exception->setHeader('Retry-After', (string)$retryAfter); + } + throw $exception; + } + + $response = $handler->handle($request); + + if ($this->config['headers']) { + return $this->addRateLimitHeaders($response, $result); + } + + return $response; + } + + /** + * Resolve limiter configuration for the current request + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return array + */ + protected function resolveLimiterConfig(ServerRequestInterface $request): array + { + $resolver = $this->config['limiterResolver']; + if ($resolver instanceof Closure) { + $name = $resolver($request); + if ($name && isset($this->config['limiters'][$name])) { + return $this->config['limiters'][$name]; + } + } + + $params = $request->getAttribute('params', []); + if (isset($params['_rateLimiter']) && isset($this->config['limiters'][$params['_rateLimiter']])) { + return $this->config['limiters'][$params['_rateLimiter']]; + } + + return []; + } + + /** + * Check if rate limiting should be skipped for this request + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return bool + */ + protected function shouldSkip(ServerRequestInterface $request): bool + { + $skipCheck = $this->config['skipCheck']; + if ($skipCheck instanceof Closure) { + return (bool)$skipCheck($request); + } + + return false; + } + + /** + * Get the identifier for rate limiting + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return string + */ + protected function getIdentifier(ServerRequestInterface $request): string + { + $callback = $this->config['identifierCallback']; + if ($callback instanceof Closure) { + return (string)$callback($request); + } + + $identifier = $this->config['identifier']; + + if (is_array($identifier)) { + $parts = []; + foreach ($identifier as $type) { + $parts[] = $this->getIdentifierByType($type, $request); + } + + return implode('_', $parts); + } + + return $this->getIdentifierByType($identifier, $request); + } + + /** + * Get identifier by type + * + * @param string $type The identifier type + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return string + */ + protected function getIdentifierByType(string $type, ServerRequestInterface $request): string + { + return match ($type) { + self::IDENTIFIER_IP => $this->getClientIp($request), + self::IDENTIFIER_USER => $this->getUserIdentifier($request), + self::IDENTIFIER_ROUTE => $this->getRouteIdentifier($request), + self::IDENTIFIER_API_KEY, self::IDENTIFIER_TOKEN => $this->getApiKeyIdentifier($request), + default => $this->getClientIp($request), + }; + } + + /** + * Get client IP address + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return string + */ + protected function getClientIp(ServerRequestInterface $request): string + { + $params = $request->getServerParams(); + + if (is_array($this->config['ipHeader'])) { + foreach ($this->config['ipHeader'] as $header) { + $headerKey = 'HTTP_' . strtoupper(str_replace('-', '_', $header)); + if (!empty($params[$headerKey])) { + $ips = explode(',', $params[$headerKey]); + + return trim($ips[0]); + } + } + } elseif (is_string($this->config['ipHeader'])) { + $headerKey = 'HTTP_' . strtoupper(str_replace('-', '_', $this->config['ipHeader'])); + if (!empty($params[$headerKey])) { + $ips = explode(',', $params[$headerKey]); + + return trim($ips[0]); + } + } + + return $params['REMOTE_ADDR'] ?? 'unknown'; + } + + /** + * Get user identifier + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return string + */ + protected function getUserIdentifier(ServerRequestInterface $request): string + { + $user = $request->getAttribute('identity'); + if ($user) { + if (interface_exists(IdentityInterface::class) && $user instanceof IdentityInterface) { + return 'user_' . $user->getIdentifier(); + } + if (isset($user->id)) { + return 'user_' . $user->id; + } + } + + return $this->getClientIp($request); + } + + /** + * Get route identifier + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return string + */ + protected function getRouteIdentifier(ServerRequestInterface $request): string + { + $params = $request->getAttribute('params', []); + $route = sprintf( + '%s::%s.%s', + $params['plugin'] ?? 'app', + $params['controller'] ?? 'unknown', + $params['action'] ?? 'unknown', + ); + + return $route . '_' . $this->getClientIp($request); + } + + /** + * Generate cache key for rate limiting + * + * @param string $identifier The identifier + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return string + */ + protected function generateKey(string $identifier, ServerRequestInterface $request): string + { + $generator = $this->config['keyGenerator']; + if ($generator instanceof Closure) { + return (string)$generator($identifier, $request); + } + + return 'rate_limit_' . hash('xxh3', $identifier); + } + + /** + * Get API key/token identifier + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return string + */ + protected function getApiKeyIdentifier(ServerRequestInterface $request): string + { + foreach ($this->config['tokenHeaders'] as $header) { + $value = $request->getHeaderLine($header); + if ($value) { + if ($header === 'Authorization') { + $parts = explode(' ', $value, 2); + if (count($parts) === 2) { + $scheme = strtolower($parts[0]); + $token = $parts[1]; + + return sprintf('%s_%s', $scheme, hash('xxh3', $token)); + } + } + + return 'token_' . hash('xxh3', $value); + } + } + + return $this->getClientIp($request); + } + + /** + * Get rate limit for the request + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @param string $identifier The identifier + * @return int + */ + protected function getLimit(ServerRequestInterface $request, string $identifier): int + { + $callback = $this->config['limitCallback']; + if ($callback instanceof Closure) { + return (int)$callback($request, $identifier); + } + + return (int)$this->config['limit']; + } + + /** + * Get the cost of the request + * + * @param \Psr\Http\Message\ServerRequestInterface $request The request + * @return int + */ + protected function getCost(ServerRequestInterface $request): int + { + $callback = $this->config['costCallback']; + if ($callback instanceof Closure) { + return (int)$callback($request); + } + + return 1; + } + + /** + * Get rate limiter instance based on strategy + * + * @param array $limiterConfig Optional limiter configuration override + * @return \Cake\Http\RateLimit\RateLimiterInterface + */ + protected function getRateLimiter(array $limiterConfig = []): RateLimiterInterface + { + $cache = Cache::pool($this->config['cache']); + + // Check if strategyClass is provided (takes precedence) + /** @var class-string<\Cake\Http\RateLimit\RateLimiterInterface>|null $strategyClass */ + $strategyClass = $limiterConfig['strategyClass'] ?? $this->config['strategyClass']; + if ($strategyClass !== null && class_exists($strategyClass)) { + return new $strategyClass($cache); + } + + // Fall back to strategy string mapping for backward compatibility + $strategy = $limiterConfig['strategy'] ?? $this->config['strategy']; + + return match ($strategy) { + self::STRATEGY_TOKEN_BUCKET => new TokenBucketRateLimiter($cache), + self::STRATEGY_FIXED_WINDOW => new FixedWindowRateLimiter($cache), + self::STRATEGY_SLIDING_WINDOW => new SlidingWindowRateLimiter($cache), + default => new SlidingWindowRateLimiter($cache), + }; + } + + /** + * Add rate limit headers to response + * + * @param \Psr\Http\Message\ResponseInterface $response The response + * @param array $result Rate limit result + * @return \Psr\Http\Message\ResponseInterface + */ + protected function addRateLimitHeaders(ResponseInterface $response, array $result): ResponseInterface + { + return $response + ->withHeader('X-RateLimit-Limit', (string)$result['limit']) + ->withHeader('X-RateLimit-Remaining', (string)$result['remaining']) + ->withHeader('X-RateLimit-Reset', (string)$result['reset']) + ->withHeader('X-RateLimit-Reset-Date', date('c', $result['reset'])); + } +} diff --git a/app/vendor/cakephp/cakephp/src/Http/Middleware/SecurityHeadersMiddleware.php b/app/vendor/cakephp/cakephp/src/Http/Middleware/SecurityHeadersMiddleware.php index d2a2e7591..26816621b 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Middleware/SecurityHeadersMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Http/Middleware/SecurityHeadersMiddleware.php @@ -25,7 +25,7 @@ /** * Handles common security headers in a convenient way * - * @link https://book.cakephp.org/5/en/controllers/middleware.html#security-header-middleware + * @link https://book.cakephp.org/5/en/security/security-headers.html */ class SecurityHeadersMiddleware implements MiddlewareInterface { @@ -253,7 +253,7 @@ public function setPermissionsPolicy(string $policy) protected function checkValues(string $value, array $allowed): void { if (!in_array($value, $allowed, true)) { - array_walk($allowed, fn(&$x) => $x = "`{$x}`"); + array_walk($allowed, fn(string &$x) => $x = "`{$x}`"); throw new InvalidArgumentException(sprintf( 'Invalid arg `%s`, use one of these: %s.', $value, diff --git a/app/vendor/cakephp/cakephp/src/Http/MimeType.php b/app/vendor/cakephp/cakephp/src/Http/MimeType.php index 6c0592221..687ed219a 100644 --- a/app/vendor/cakephp/cakephp/src/Http/MimeType.php +++ b/app/vendor/cakephp/cakephp/src/Http/MimeType.php @@ -160,6 +160,7 @@ class MimeType 'xlm' => ['application/vnd.ms-excel'], 'xls' => ['application/vnd.ms-excel'], 'xlsx' => ['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'], + 'xlsm' => ['application/vnd.ms-excel.sheet.macroEnabled.12'], 'xlw' => ['application/vnd.ms-excel'], 'zip' => ['application/zip'], 'aif' => ['audio/x-aiff'], @@ -289,11 +290,15 @@ class MimeType /** * Get the MIME types associated with a given file extension. * - * @param string $ext The file extension to look up. + * @param string|null $ext The file extension to look up. Use null to return the full list. * @return array|null An array of MIME types if found, or null if no MIME types are associated with the extension. */ - public static function getMimeTypes(string $ext): ?array + public static function getMimeTypes(?string $ext = null): ?array { + if ($ext === null) { + return static::$mimeTypes; + } + return static::$mimeTypes[$ext] ?? null; } @@ -306,7 +311,7 @@ public static function getMimeTypes(string $ext): ?array */ public static function getMimeType(string $ext, ?string $default = null): ?string { - return isset(static::$mimeTypes[$ext]) ? static::$mimeTypes[$ext][0] : null; + return isset(static::$mimeTypes[$ext]) ? static::$mimeTypes[$ext][0] : $default; } /** diff --git a/app/vendor/cakephp/cakephp/src/Http/RateLimit/FixedWindowRateLimiter.php b/app/vendor/cakephp/cakephp/src/Http/RateLimit/FixedWindowRateLimiter.php new file mode 100644 index 000000000..0f7610bbd --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Http/RateLimit/FixedWindowRateLimiter.php @@ -0,0 +1,79 @@ +cache = $cache; + } + + /** + * @inheritDoc + */ + public function attempt(string $identifier, int $limit, int $window, int $cost = 1): array + { + $now = time(); + $windowStart = (int)($now / $window) * $window; + $key = $identifier . '_' . $windowStart; + + $count = (int)$this->cache->get($key, 0); + $allowed = $count + $cost <= $limit; + + if ($allowed) { + $count += $cost; + $ttl = $windowStart + $window - $now; + $this->cache->set($key, $count, $ttl); + } + + return [ + 'allowed' => $allowed, + 'limit' => $limit, + 'remaining' => max(0, $limit - $count), + 'reset' => $windowStart + $window, + ]; + } + + /** + * @inheritDoc + */ + public function reset(string $identifier): void + { + $now = time(); + $window = 3600; // Assume max window of 1 hour for reset + $windowStart = (int)($now / $window) * $window; + $this->cache->delete($identifier . '_' . $windowStart); + } +} diff --git a/app/vendor/cakephp/cakephp/src/Http/RateLimit/RateLimiterInterface.php b/app/vendor/cakephp/cakephp/src/Http/RateLimit/RateLimiterInterface.php new file mode 100644 index 000000000..adb661342 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Http/RateLimit/RateLimiterInterface.php @@ -0,0 +1,57 @@ +reset($key); + * ``` + * + * @param string $identifier The identifier to reset + * @return void + */ + public function reset(string $identifier): void; +} diff --git a/app/vendor/cakephp/cakephp/src/Http/RateLimit/SlidingWindowRateLimiter.php b/app/vendor/cakephp/cakephp/src/Http/RateLimit/SlidingWindowRateLimiter.php new file mode 100644 index 000000000..3fdf3f94b --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Http/RateLimit/SlidingWindowRateLimiter.php @@ -0,0 +1,91 @@ +cache = $cache; + } + + /** + * @inheritDoc + */ + public function attempt(string $identifier, int $limit, int $window, int $cost = 1): array + { + $now = time(); + $key = $identifier; + + $data = $this->cache->get($key, [ + 'count' => 0, + 'reset' => $now + $window, + 'window_start' => $now, + ]); + + $elapsed = $now - $data['window_start']; + if ($elapsed >= $window) { + $data = [ + 'count' => 0, + 'reset' => $now + $window, + 'window_start' => $now, + ]; + } else { + $weight = 1 - ($elapsed / $window); + $data['count'] = (int)ceil($data['count'] * $weight); + } + + $allowed = $data['count'] + $cost <= $limit; + + if ($allowed) { + $data['count'] += $cost; + $this->cache->set($key, $data, $window); + } + + return [ + 'allowed' => $allowed, + 'limit' => $limit, + 'remaining' => max(0, $limit - (int)$data['count']), + 'reset' => $data['reset'], + ]; + } + + /** + * @inheritDoc + */ + public function reset(string $identifier): void + { + $this->cache->delete($identifier); + } +} diff --git a/app/vendor/cakephp/cakephp/src/Http/RateLimit/TokenBucketRateLimiter.php b/app/vendor/cakephp/cakephp/src/Http/RateLimit/TokenBucketRateLimiter.php new file mode 100644 index 000000000..9702e4926 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Http/RateLimit/TokenBucketRateLimiter.php @@ -0,0 +1,92 @@ +cache = $cache; + } + + /** + * @inheritDoc + */ + public function attempt(string $identifier, int $limit, int $window, int $cost = 1): array + { + $now = microtime(true); + $key = $identifier; + + $data = $this->cache->get($identifier, [ + 'tokens' => $limit, + 'last_update' => $now, + ]); + + // Refill tokens based on time elapsed + $elapsed = $now - $data['last_update']; + $refillRate = $limit / $window; + $tokensToAdd = $elapsed * $refillRate; + + $data['tokens'] = min($limit, $data['tokens'] + $tokensToAdd); + $data['last_update'] = $now; + + $allowed = $data['tokens'] >= $cost; + + if ($allowed) { + $data['tokens'] -= $cost; + } + + $this->cache->set($key, $data, $window); + + // Calculate when bucket will be full + $tokensNeeded = $limit - $data['tokens']; + $secondsToFull = $tokensNeeded / $refillRate; + $reset = (int)($now + $secondsToFull); + + return [ + 'allowed' => $allowed, + 'limit' => $limit, + 'remaining' => (int)$data['tokens'], + 'reset' => $reset, + ]; + } + + /** + * @inheritDoc + */ + public function reset(string $identifier): void + { + $this->cache->delete($identifier); + } +} diff --git a/app/vendor/cakephp/cakephp/src/Http/Response.php b/app/vendor/cakephp/cakephp/src/Http/Response.php index 60bcec0cb..29f84f624 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Response.php +++ b/app/vendor/cakephp/cakephp/src/Http/Response.php @@ -20,6 +20,7 @@ use Cake\Http\Cookie\CookieCollection; use Cake\Http\Cookie\CookieInterface; use Cake\Http\Exception\NotFoundException; +use Cake\I18n\DateTime as CakeDateTime; use DateTime; use DateTimeInterface; use DateTimeZone; @@ -39,7 +40,7 @@ * There are external packages such as `fig/http-message-util` that provide HTTP * status code constants. These can be used with any method that accepts or * returns a status code integer. Keep in mind that these constants might - * include status codes that are now allowed which will throw an + * include status codes that are not allowed which will throw an * `\InvalidArgumentException`. */ class Response implements ResponseInterface, Stringable @@ -159,7 +160,7 @@ class Response implements ResponseInterface, Stringable /** * Holds all the cache directives that will be converted - * into headers when sending the request + * into headers when sending the response * * @var array */ @@ -222,9 +223,7 @@ public function __construct(array $options = []) if (isset($options['status'])) { $this->_setStatus($options['status']); } - if (!isset($options['charset'])) { - $options['charset'] = Configure::read('App.encoding'); - } + $options['charset'] ??= Configure::read('App.encoding'); $this->_charset = $options['charset']; $type = 'text/html'; if (isset($options['type'])) { @@ -248,6 +247,9 @@ protected function _createStream(): void * Formats the Content-Type header based on the configured contentType and charset * the charset will only be set in the header if the response is of type text/* * + * Note: Content-Type header will be cleared for 304 and 204 status codes as these + * status codes must not have a Content-Type header. + * * @param string $type The type to set. * @return void */ @@ -361,7 +363,7 @@ public function getStatusCode(): int * There are external packages such as `fig/http-message-util` that provide HTTP * status code constants. These can be used with any method that accepts or * returns a status code integer. However, keep in mind that these constants - * might include status codes that are now allowed which will throw an + * might include status codes that are not allowed which will throw an * `\InvalidArgumentException`. * * @link https://tools.ietf.org/html/rfc7231#section-6 @@ -567,7 +569,7 @@ public function withCharset(string $charset): static public function withDisabledCache(): static { return $this->withHeader('Expires', 'Mon, 26 Jul 1997 05:00:00 GMT') - ->withHeader('Last-Modified', gmdate(CAKE_DATE_RFC7231)) + ->withHeader('Last-Modified', CakeDateTime::parse(time())->toRfc7231String()) ->withHeader('Cache-Control', 'no-store, no-cache, must-revalidate, post-check=0, pre-check=0'); } @@ -589,7 +591,7 @@ public function withCache(string|int $since, string|int $time = '+1 day'): stati } } - return $this->withHeader('Date', gmdate(CAKE_DATE_RFC7231, time())) + return $this->withHeader('Date', CakeDateTime::parse(time())->toRfc7231String()) ->withModified($since) ->withExpires($time) ->withSharable(true) @@ -597,7 +599,7 @@ public function withCache(string|int $since, string|int $time = '+1 day'): stati } /** - * Create a new instace with the public/private Cache-Control directive set. + * Create a new instance with the public/private Cache-Control directive set. * * @param bool $public If set to true, the Cache-Control header will be set as public * if set to false, the response will be set to private. @@ -700,6 +702,9 @@ protected function _setCacheControl(): void /** * Create a new instance with the Expires header set. * + * Strings without an explicit time zone will be converted + * from the default time zone to UTC. + * * ### Examples: * * ``` @@ -715,14 +720,15 @@ protected function _setCacheControl(): void */ public function withExpires(DateTimeInterface|string|int|null $time): static { - $date = $this->_getUTCDate($time); - - return $this->withHeader('Expires', $date->format(CAKE_DATE_RFC7231)); + return $this->withHeader('Expires', $this->getRfc7231($time)); } /** * Create a new instance with the Last-Modified header set. * + * Strings without an explicit time zone will be converted + * from the default time zone to UTC. + * * ### Examples: * * ``` @@ -738,9 +744,7 @@ public function withExpires(DateTimeInterface|string|int|null $time): static */ public function withModified(DateTimeInterface|string|int $time): static { - $date = $this->_getUTCDate($time); - - return $this->withHeader('Last-Modified', $date->format(CAKE_DATE_RFC7231)); + return $this->withHeader('Last-Modified', $this->getRfc7231($time)); } /** @@ -833,12 +837,22 @@ protected function _getUTCDate(DateTimeInterface|string|int|null $time = null): $result = new DateTime($time ?? 'now'); } - /** - * @phpstan-ignore-next-line - */ + /** @phpstan-ignore-next-line */ return $result->setTimezone(new DateTimeZone('UTC')); } + /** + * Converts the time zone to GMT and returns a string in RFC7231 format. + * This replaced the deprecated and broken ``DATE_RFC7231`` formatting constant. + * + * @param \DateTimeInterface|string|int|null $time + * @return string + */ + protected function getRfc7231(DateTimeInterface|string|int|null $time = null): string + { + return $this->_getUTCDate($time)->format('D, d M Y H:i:s \G\M\T'); + } + /** * Sets the correct output buffering handler to send a compressed response. Responses will * be compressed with zlib, if the extension is available. @@ -1077,7 +1091,7 @@ public function withCookieCollection(CookieCollection $cookieCollection): static * Get a CorsBuilder instance for defining CORS headers. * * @param \Cake\Http\ServerRequest $request Request object - * @return \Cake\Http\CorsBuilder A builder object the provides a fluent interface for defining + * @return \Cake\Http\CorsBuilder A builder object that provides a fluent interface for defining * additional CORS headers. */ public function cors(ServerRequest $request): CorsBuilder @@ -1214,6 +1228,7 @@ protected function _fileRange(SplFileInfo $file, string $httpRange): void preg_match('/^bytes\s*=\s*(\d+)?\s*-\s*(\d+)?$/', $httpRange, $matches); if ($matches) { + /** @phpstan-ignore offsetAccess.notFound */ $start = $matches[1]; $end = $matches[2] ?? ''; } diff --git a/app/vendor/cakephp/cakephp/src/Http/ResponseEmitter.php b/app/vendor/cakephp/cakephp/src/Http/ResponseEmitter.php index e2381b0e3..30f636820 100644 --- a/app/vendor/cakephp/cakephp/src/Http/ResponseEmitter.php +++ b/app/vendor/cakephp/cakephp/src/Http/ResponseEmitter.php @@ -67,7 +67,6 @@ public function emit(ResponseInterface $response): bool $this->emitStatusLine($response); $this->emitHeaders($response); - $this->flush(); $range = $this->parseContentRange($response->getHeaderLine('Content-Range')); if (is_array($range)) { @@ -229,22 +228,6 @@ protected function setCookie(CookieInterface|string $cookie): bool return setcookie($cookie->getName(), $cookie->getScalarValue(), $cookie->getOptions()); } - /** - * Loops through the output buffer, flushing each, before emitting - * the response. - * - * @param int|null $maxBufferLevel Flush up to this buffer level. - * @return void - */ - protected function flush(?int $maxBufferLevel = null): void - { - $maxBufferLevel ??= ob_get_level(); - - while (ob_get_level() > $maxBufferLevel) { - ob_end_flush(); - } - } - /** * Parse content-range header * https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.16 diff --git a/app/vendor/cakephp/cakephp/src/Http/Server.php b/app/vendor/cakephp/cakephp/src/Http/Server.php index c95ee4f21..7a41fe969 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Server.php +++ b/app/vendor/cakephp/cakephp/src/Http/Server.php @@ -45,21 +45,15 @@ class Server implements EventDispatcherInterface */ protected HttpApplicationInterface $app; - /** - * @var \Cake\Http\Runner - */ - protected Runner $runner; - /** * Constructor * * @param \Cake\Core\HttpApplicationInterface $app The application to use. - * @param \Cake\Http\Runner|null $runner Application runner. + * @param \Cake\Http\Runner $runner Application runner. */ - public function __construct(HttpApplicationInterface $app, ?Runner $runner = null) + public function __construct(HttpApplicationInterface $app, protected Runner $runner = new Runner()) { $this->app = $app; - $this->runner = $runner ?? new Runner(); } /** diff --git a/app/vendor/cakephp/cakephp/src/Http/ServerRequest.php b/app/vendor/cakephp/cakephp/src/Http/ServerRequest.php index 7ea82e4ad..1e29dd3b6 100644 --- a/app/vendor/cakephp/cakephp/src/Http/ServerRequest.php +++ b/app/vendor/cakephp/cakephp/src/Http/ServerRequest.php @@ -30,6 +30,7 @@ use Psr\Http\Message\StreamInterface; use Psr\Http\Message\UploadedFileInterface; use Psr\Http\Message\UriInterface; +use function Cake\Core\deprecationWarning; use function Cake\Core\env; /** @@ -622,7 +623,7 @@ protected function _paramDetector(array $detect): bool if (isset($detect['value'])) { $value = $detect['value']; - return isset($this->params[$key]) && $this->params[$key] == $value; + return isset($this->params[$key]) && $this->params[$key] === $value; } if (isset($detect['options'])) { return isset($this->params[$key]) && in_array($this->params[$key], $detect['options']); @@ -641,7 +642,7 @@ protected function _environmentDetector(array $detect): bool { if (isset($detect['env'])) { if (isset($detect['value'])) { - return $this->getEnv($detect['env']) == $detect['value']; + return $this->getEnv($detect['env']) === $detect['value']; } if (isset($detect['pattern'])) { return (bool)preg_match($detect['pattern'], (string)$this->getEnv($detect['env'])); @@ -841,7 +842,7 @@ public function hasHeader(string $name): bool * is not present, an empty array will be returned. * * @param string $name The header you want to get (case-insensitive) - * @return array An associative array of headers and their values. + * @return array An array of all the header values for a particular case-insensitive header by name. * If the header doesn't exist, an empty array will be returned. * @link https://www.php-fig.org/psr/psr-7/ This method is part of the PSR-7 server request interface. */ @@ -996,6 +997,32 @@ public function getQueryParams(): array return $this->query; } + /** + * Returns query parameters filtered to include only the specified keys or exclude specified keys. + * + * If the `$only` parameter is provided, only those keys will be returned. + * If the `$exclude` parameter is provided, all keys except those will be returned. + * Both parameters cannot be provided at the same time. + * + * @param array $only List of query parameter keys to include. Defaults to an empty array. + * @param array $exclude List of query parameter keys to exclude. Defaults to an empty array. + * @return array Filtered query parameters. + * @throws \InvalidArgumentException When both `$only` and `$exclude` are provided. + */ + public function getFilteredQueryParams(array $only = [], array $exclude = []): array + { + if ($only !== [] && $exclude !== []) { + throw new InvalidArgumentException('Specify either `$only` or `$exclude`, not both.'); + } + $params = $this->getQueryParams(); + + if ($only !== []) { + return array_intersect_key($params, array_flip($only)); + } + + return array_diff_key($params, array_flip($exclude)); + } + /** * Update the query string data and get a new instance. * @@ -1522,6 +1549,13 @@ public function withParam(string $name, mixed $value): static */ public function getParam(string $name, mixed $default = null): mixed { + if ($name === '?') { + deprecationWarning( + '5.3.0', + 'Using `$request->getParam("?")` is deprecated. Use `$request->getQueryParams()` instead.', + ); + } + return Hash::get($this->params, $name, $default); } diff --git a/app/vendor/cakephp/cakephp/src/Http/Session.php b/app/vendor/cakephp/cakephp/src/Http/Session.php index cdaec4093..6e6ff4c75 100644 --- a/app/vendor/cakephp/cakephp/src/Http/Session.php +++ b/app/vendor/cakephp/cakephp/src/Http/Session.php @@ -190,8 +190,8 @@ protected static function _defaultConfig(string $name): array )); } - if ($name !== 'php' || empty(ini_get('session.cookie_samesite'))) { - $defaults['php']['ini']['session.cookie_samesite'] = 'Lax'; + if (empty(ini_get('session.cookie_samesite'))) { + $defaults[$name]['ini']['session.cookie_samesite'] = 'Lax'; } return $defaults[$name]; diff --git a/app/vendor/cakephp/cakephp/src/Http/UriFactory.php b/app/vendor/cakephp/cakephp/src/Http/UriFactory.php index 64d011e29..0ba277139 100644 --- a/app/vendor/cakephp/cakephp/src/Http/UriFactory.php +++ b/app/vendor/cakephp/cakephp/src/Http/UriFactory.php @@ -90,7 +90,7 @@ protected static function updatePath(string $base, UriInterface $uri): UriInterf if ($path === '/index.php' && $uri->getQuery()) { $path = $uri->getQuery(); } - if ($path === '' || $path === '//' || $path === '/index.php') { + if (in_array($path, ['', '//', '/index.php'], true)) { $path = '/'; } diff --git a/app/vendor/cakephp/cakephp/src/Http/composer.json b/app/vendor/cakephp/cakephp/src/Http/composer.json index 2b58c6084..4478048f9 100644 --- a/app/vendor/cakephp/cakephp/src/Http/composer.json +++ b/app/vendor/cakephp/cakephp/src/Http/composer.json @@ -25,24 +25,24 @@ "source": "https://github.com/cakephp/http" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev", - "cakephp/event": "5.2.*@dev", - "cakephp/utility": "5.2.*@dev", + "php": ">=8.2", + "cakephp/core": "^5.3.0", + "cakephp/event": "^5.3.0", + "cakephp/utility": "^5.3.0", "composer/ca-bundle": "^1.5", "psr/http-client": "^1.0.2", "psr/http-factory": "^1.1", "psr/http-message": "^1.1 || ^2.0", "psr/http-server-handler": "^1.0.2", "psr/http-server-middleware": "^1.0.2", - "laminas/laminas-diactoros": "^3.3", + "laminas/laminas-diactoros": "^3.8", "laminas/laminas-httphandlerrunner": "^2.6" }, "require-dev": { - "cakephp/cache": "5.2.*@dev", - "cakephp/console": "5.2.*@dev", - "cakephp/orm": "5.2.*@dev", - "cakephp/i18n": "5.2.*@dev", + "cakephp/cache": "^5.3.0", + "cakephp/console": "^5.3.0", + "cakephp/orm": "^5.3.0", + "cakephp/i18n": "^5.3.0", "paragonie/csp-builder": "^3.0" }, "autoload": { @@ -61,10 +61,11 @@ "cakephp/orm": "To use database session storage", "paragonie/csp-builder": "To use CspMiddleware" }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/I18n/Date.php b/app/vendor/cakephp/cakephp/src/I18n/Date.php index 856c2435a..a1a699059 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/Date.php +++ b/app/vendor/cakephp/cakephp/src/I18n/Date.php @@ -317,6 +317,16 @@ public function jsonSerialize(): mixed return $this->i18nFormat(static::$_jsonEncodeFormat); } + /** + * Returns a UNIX timestamp as an integer. + * + * @return int UNIX timestamp + */ + public function getTimestamp(): int + { + return (int)$this->toUnixString(); + } + /** * @inheritDoc */ diff --git a/app/vendor/cakephp/cakephp/src/I18n/DatePeriod.php b/app/vendor/cakephp/cakephp/src/I18n/DatePeriod.php new file mode 100644 index 000000000..aeb3bc783 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/I18n/DatePeriod.php @@ -0,0 +1,37 @@ + + */ +class DatePeriod extends ChronosDatePeriod +{ + /** + * @return \Cake\I18n\Date + */ + public function current(): Date + { + return new Date($this->iterator->current()); + } +} diff --git a/app/vendor/cakephp/cakephp/src/I18n/DateTime.php b/app/vendor/cakephp/cakephp/src/I18n/DateTime.php index b21e02d4b..462bddffb 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/DateTime.php +++ b/app/vendor/cakephp/cakephp/src/I18n/DateTime.php @@ -597,6 +597,46 @@ public function jsonSerialize(): mixed return $this->i18nFormat(static::$_jsonEncodeFormat); } + /** + * Returns the quarter + * + * Deprecated 5.3.0 Argument $range. Use toQuarterRange() to get quarter date ranges instead of passing $range = true + * + * @param bool $range Range. Deprecated, use toQuarterRange() instead. + * @return array|int 1, 2, 3, or 4 quarter of year or array if $range true + */ + public function toQuarter(bool $range = false): int|array + { + if ($range) { + trigger_error( + 'Passing $range = true to toQuarter() is deprecated. Use toQuarterRange() instead.', + E_USER_DEPRECATED, + ); + + return $this->toQuarterRange(); + } + + return (int)ceil((int)$this->format('m') / 3); + } + + /** + * Returns the date range for the quarter this date falls in. + * + * @return array{0: string, 1: string} Array with start and end dates in 'Y-m-d' format + */ + public function toQuarterRange(): array + { + $quarter = $this->toQuarter(); + $year = $this->format('Y'); + + return match ($quarter) { + 1 => [$year . '-01-01', $year . '-03-31'], + 2 => [$year . '-04-01', $year . '-06-30'], + 3 => [$year . '-07-01', $year . '-09-30'], + default => [$year . '-10-01', $year . '-12-31'], + }; + } + /** * @inheritDoc */ diff --git a/app/vendor/cakephp/cakephp/src/I18n/DateTimePeriod.php b/app/vendor/cakephp/cakephp/src/I18n/DateTimePeriod.php new file mode 100644 index 000000000..8e7e68321 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/I18n/DateTimePeriod.php @@ -0,0 +1,37 @@ + + */ +class DateTimePeriod extends ChronosPeriod +{ + /** + * @return \Cake\I18n\DateTime + */ + public function current(): DateTime + { + return new DateTime($this->iterator->current()); + } +} diff --git a/app/vendor/cakephp/cakephp/src/I18n/I18n.php b/app/vendor/cakephp/cakephp/src/I18n/I18n.php index 03d5c92f9..f00c6afff 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/I18n.php +++ b/app/vendor/cakephp/cakephp/src/I18n/I18n.php @@ -52,7 +52,7 @@ class I18n /** * Returns the translators collection instance. It can be used - * for getting specific translators based of their name and locale + * for getting specific translators based on their name and locale * or to configure some aspect of future translations that are not yet constructed. * * @return \Cake\I18n\TranslatorRegistry The translator collection. @@ -180,7 +180,7 @@ public static function getTranslator(string $name = 'default', ?string $locale = * * Registering loaders is useful when you need to lazily use translations in multiple * different locales for the same domain, and don't want to use the built-in - * translation service based of `gettext` files. + * translation service based on `gettext` files. * * Loader objects will receive two arguments: The domain name that needs to be * built, and the locale that is requested. These objects can assemble the messages @@ -237,7 +237,7 @@ public static function setLocale(string $locale): void } /** - * Will return the currently configure locale as stored in the + * Will return the currently configured locale as stored in the * `intl.default_locale` PHP setting. * * @return string The name of the default locale. diff --git a/app/vendor/cakephp/cakephp/src/I18n/Number.php b/app/vendor/cakephp/cakephp/src/I18n/Number.php index 1cee7adb0..a264c871c 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/Number.php +++ b/app/vendor/cakephp/cakephp/src/I18n/Number.php @@ -347,9 +347,7 @@ public static function formatter(array $options = []): NumberFormatter } } - if (!isset(static::$_formatters[$locale][$type])) { - static::$_formatters[$locale][$type] = new NumberFormatter($locale, $type); - } + static::$_formatters[$locale][$type] ??= new NumberFormatter($locale, $type); /** @var \NumberFormatter $formatter */ $formatter = static::$_formatters[$locale][$type]; diff --git a/app/vendor/cakephp/cakephp/src/I18n/Parser/PoFileParser.php b/app/vendor/cakephp/cakephp/src/I18n/Parser/PoFileParser.php index 9f9f33bd1..8298db0f6 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/Parser/PoFileParser.php +++ b/app/vendor/cakephp/cakephp/src/I18n/Parser/PoFileParser.php @@ -174,8 +174,7 @@ protected function _addMessage(array &$messages, array $item): void ksort($plurals); // Make sure every index is filled. - end($plurals); - $count = (int)key($plurals); + $count = (int)array_key_last($plurals); // Fill missing spots with an empty string. $empties = array_fill(0, $count + 1, ''); diff --git a/app/vendor/cakephp/cakephp/src/I18n/PluralRules.php b/app/vendor/cakephp/cakephp/src/I18n/PluralRules.php index 114f530ec..a46d8f8f7 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/PluralRules.php +++ b/app/vendor/cakephp/cakephp/src/I18n/PluralRules.php @@ -22,7 +22,7 @@ /** * Utility class used to determine the plural number to be used for a variable - * base on the locale. + * based on the locale. * * @internal */ diff --git a/app/vendor/cakephp/cakephp/src/I18n/RelativeTimeFormatter.php b/app/vendor/cakephp/cakephp/src/I18n/RelativeTimeFormatter.php index 391cda743..b202daad0 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/RelativeTimeFormatter.php +++ b/app/vendor/cakephp/cakephp/src/I18n/RelativeTimeFormatter.php @@ -28,12 +28,12 @@ class RelativeTimeFormatter implements DifferenceFormatterInterface { /** - * Get the difference in a human readable format. + * Get the difference in a human-readable format. * * @param \Cake\Chronos\ChronosDate|\DateTimeInterface $first The datetime to start with. * @param \Cake\Chronos\ChronosDate|\DateTimeInterface|null $second The datetime to compare against. * @param bool $absolute Removes time difference modifiers ago, after, etc. - * @return string The difference between the two days in a human readable format. + * @return string The difference between the two days in a human-readable format. * @see \Cake\Chronos\Chronos::diffForHumans */ public function diffForHumans( @@ -99,17 +99,17 @@ public function diffForHumans( } /** - * Format a into a relative timestring. + * Format a time into a relative timestring. * * @param \Cake\I18n\DateTime|\Cake\I18n\Date $time The time instance to format. * @param array $options Array of options. * @return string Relative time string. - * @see \Cake\I18n\Time::timeAgoInWords() + * @see \Cake\I18n\DateTime::timeAgoInWords() */ public function timeAgoInWords(DateTime|Date $time, array $options = []): string { $options = $this->_options($options, DateTime::class); - if ($options['timezone']) { + if ($time instanceof DateTime && $options['timezone']) { $time = $time->setTimezone($options['timezone']); } @@ -329,7 +329,7 @@ protected function _diffData(string|int $futureTime, string|int $pastTime, bool } /** - * Format a into a relative date string. + * Format a date into a relative date string. * * @param \Cake\I18n\DateTime|\Cake\I18n\Date $date The date to format. * @param array $options Array of options. diff --git a/app/vendor/cakephp/cakephp/src/I18n/TranslatorRegistry.php b/app/vendor/cakephp/cakephp/src/I18n/TranslatorRegistry.php index bf3f7a819..c9743e94b 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/TranslatorRegistry.php +++ b/app/vendor/cakephp/cakephp/src/I18n/TranslatorRegistry.php @@ -18,6 +18,7 @@ use Cake\Cache\CacheEngineInterface; use Psr\SimpleCache\CacheInterface; +use function Cake\Core\deprecationWarning; /** * Constructs and stores instances of translators that can be @@ -234,6 +235,12 @@ protected function _getTranslator(string $name, string $locale): Translator // Support __invoke() wrapper classes if (!$package instanceof Package && is_callable($package)) { + deprecationWarning( + '5.3.0', + 'Using a callable as a package loader is deprecated. ' . + 'Please return an instance of \Cake\I18n\Package instead.', + ); + $package = $package(); } diff --git a/app/vendor/cakephp/cakephp/src/I18n/composer.json b/app/vendor/cakephp/cakephp/src/I18n/composer.json index 19a27250d..16755c4af 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/composer.json +++ b/app/vendor/cakephp/cakephp/src/I18n/composer.json @@ -28,10 +28,10 @@ "source": "https://github.com/cakephp/i18n" }, "require": { - "php": ">=8.1", + "php": ">=8.2", "ext-intl": "*", - "cakephp/core": "5.2.*@dev", - "cakephp/chronos": "^3.1" + "cakephp/core": "^5.3.0", + "cakephp/chronos": "^3.3" }, "autoload": { "psr-4": { @@ -44,10 +44,11 @@ "suggest": { "cakephp/cache": "Require this if you want automatic caching of translators" }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/I18n/functions.php b/app/vendor/cakephp/cakephp/src/I18n/functions.php index b971655d3..51d2f87b5 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/functions.php +++ b/app/vendor/cakephp/cakephp/src/I18n/functions.php @@ -26,7 +26,7 @@ * @param string $singular Text to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string The translated text. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__ + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#global-functions */ function __(string $singular, mixed ...$args): string { @@ -49,7 +49,7 @@ function __(string $singular, mixed ...$args): string * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__n + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#n */ function __n(string $singular, string $plural, int $count, mixed ...$args): string { @@ -73,7 +73,7 @@ function __n(string $singular, string $plural, int $count, mixed ...$args): stri * @param string $msg String to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__d + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#d */ function __d(string $domain, string $msg, mixed ...$args): string { @@ -98,7 +98,7 @@ function __d(string $domain, string $msg, mixed ...$args): string * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dn + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#dn */ function __dn(string $domain, string $singular, string $plural, int $count, mixed ...$args): string { @@ -124,7 +124,7 @@ function __dn(string $domain, string $singular, string $plural, int $count, mixe * @param string $singular Text to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__x + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#x */ function __x(string $context, string $singular, mixed ...$args): string { @@ -150,7 +150,7 @@ function __x(string $context, string $singular, mixed ...$args): string * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__xn + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#xn */ function __xn(string $context, string $singular, string $plural, int $count, mixed ...$args): string { @@ -177,7 +177,7 @@ function __xn(string $context, string $singular, string $plural, int $count, mix * @param string $msg String to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dx + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#dx */ function __dx(string $domain, string $context, string $msg, mixed ...$args): string { @@ -207,7 +207,7 @@ function __dx(string $domain, string $context, string $msg, mixed ...$args): str * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dxn + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#dxn */ function __dxn( string $domain, diff --git a/app/vendor/cakephp/cakephp/src/I18n/functions_global.php b/app/vendor/cakephp/cakephp/src/I18n/functions_global.php index 4bd2c1734..6ae993445 100644 --- a/app/vendor/cakephp/cakephp/src/I18n/functions_global.php +++ b/app/vendor/cakephp/cakephp/src/I18n/functions_global.php @@ -36,7 +36,7 @@ * @param string $singular Text to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string The translated text. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__ + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#global-functions */ function __(string $singular, mixed ...$args): string { @@ -54,7 +54,7 @@ function __(string $singular, mixed ...$args): string * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__n + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#n */ function __n(string $singular, string $plural, int $count, mixed ...$args): string { @@ -70,7 +70,7 @@ function __n(string $singular, string $plural, int $count, mixed ...$args): stri * @param string $msg String to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__d + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#d */ function __d(string $domain, string $msg, mixed ...$args): string { @@ -90,7 +90,7 @@ function __d(string $domain, string $msg, mixed ...$args): string * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dn + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#dn */ function __dn(string $domain, string $singular, string $plural, int $count, mixed ...$args): string { @@ -108,7 +108,7 @@ function __dn(string $domain, string $singular, string $plural, int $count, mixe * @param string $singular Text to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__x + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#x */ function __x(string $context, string $singular, mixed ...$args): string { @@ -129,7 +129,7 @@ function __x(string $context, string $singular, mixed ...$args): string * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__xn + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#xn */ function __xn(string $context, string $singular, string $plural, int $count, mixed ...$args): string { @@ -148,7 +148,7 @@ function __xn(string $context, string $singular, string $plural, int $count, mix * @param string $msg String to translate. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dx + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#dx */ function __dx(string $domain, string $context, string $msg, mixed ...$args): string { @@ -170,7 +170,7 @@ function __dx(string $domain, string $context, string $msg, mixed ...$args): str * @param int $count Count. * @param mixed ...$args Array with arguments or multiple arguments in function. * @return string Plural form of translated string. - * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#__dxn + * @link https://book.cakephp.org/5/en/core-libraries/global-constants-and-functions.html#dxn */ function __dxn( string $domain, diff --git a/app/vendor/cakephp/cakephp/src/Log/Engine/ArrayLog.php b/app/vendor/cakephp/cakephp/src/Log/Engine/ArrayLog.php index ece7799e5..2c14fd72d 100644 --- a/app/vendor/cakephp/cakephp/src/Log/Engine/ArrayLog.php +++ b/app/vendor/cakephp/cakephp/src/Log/Engine/ArrayLog.php @@ -55,7 +55,7 @@ class ArrayLog extends BaseLog * @param mixed $level The severity level of log you are making. * @param \Stringable|string $message The message you want to log. * @param array $context Additional information about the logged message - * @return void success of write. + * @return void * @see \Cake\Log\Log::$_levels * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ diff --git a/app/vendor/cakephp/cakephp/src/Log/Engine/ConsoleLog.php b/app/vendor/cakephp/cakephp/src/Log/Engine/ConsoleLog.php index 73db8a721..49dbc7fcd 100644 --- a/app/vendor/cakephp/cakephp/src/Log/Engine/ConsoleLog.php +++ b/app/vendor/cakephp/cakephp/src/Log/Engine/ConsoleLog.php @@ -87,7 +87,7 @@ public function __construct(array $config = []) * @param mixed $level The severity level of log you are making. * @param \Stringable|string $message The message you want to log. * @param array $context Additional information about the logged message - * @return void success of write. + * @return void * @see \Cake\Log\Log::$_levels * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ diff --git a/app/vendor/cakephp/cakephp/src/Log/Engine/FileLog.php b/app/vendor/cakephp/cakephp/src/Log/Engine/FileLog.php index d87fc270d..5538d1e54 100644 --- a/app/vendor/cakephp/cakephp/src/Log/Engine/FileLog.php +++ b/app/vendor/cakephp/cakephp/src/Log/Engine/FileLog.php @@ -36,7 +36,7 @@ class FileLog extends BaseLog * - `size` Used to implement basic log file rotation. If log file size * reaches specified size the existing file is renamed by appending timestamp * to filename and new log file is created. Can be integer bytes value or - * human readable string values like '10MB', '100KB' etc. + * human-readable string values like '10MB', '100KB' etc. * - `rotate` Log files are rotated specified times before being removed. * If value is 0, old versions are removed rather than rotated. * - `mask` A mask is applied when log files are created. Left empty no chmod @@ -54,7 +54,7 @@ class FileLog extends BaseLog 'rotate' => 10, 'size' => 10485760, // 10MB 'mask' => null, - 'dirMask' => 0770, + 'dirMask' => 0777, 'formatter' => [ 'className' => DefaultFormatter::class, ], @@ -92,7 +92,7 @@ public function __construct(array $config = []) $this->_path = $this->getConfig('path', sys_get_temp_dir() . DIRECTORY_SEPARATOR); if (!is_dir($this->_path)) { - mkdir($this->_path, $this->_config['dirMask'], true); + mkdir($this->_path, $this->_config['dirMask'] ^ umask(), true); } if (!empty($this->_config['file'])) { diff --git a/app/vendor/cakephp/cakephp/src/Log/Log.php b/app/vendor/cakephp/cakephp/src/Log/Log.php index 67ddd4665..0440836c1 100644 --- a/app/vendor/cakephp/cakephp/src/Log/Log.php +++ b/app/vendor/cakephp/cakephp/src/Log/Log.php @@ -24,7 +24,7 @@ /** * Logs messages to configured Log adapters. One or more adapters - * can be configured using Cake Logs's methods. If you don't + * can be configured using Cake Log's methods. If you don't * configure any adapters, and write to Log, the messages will be * ignored. * @@ -278,7 +278,7 @@ public static function setConfig(array|string $key, LoggerInterface|Closure|arra * Get a logging engine. * * @param string $name Key name of a configured adapter to get. - * @return \Psr\Log\LoggerInterface|null Instance of LoggerInterface or false if not found + * @return \Psr\Log\LoggerInterface|null Instance of LoggerInterface or null if not found */ public static function engine(string $name): ?LoggerInterface { @@ -338,7 +338,7 @@ public static function engine(string $name): ?LoggerInterface * @param \Stringable|string $message Message content to log * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success @@ -392,7 +392,7 @@ public static function write(string|int $level, Stringable|string $message, arra * @param \Stringable|string $message log message * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success @@ -408,7 +408,7 @@ public static function emergency(Stringable|string $message, array|string $conte * @param \Stringable|string $message log message * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success @@ -424,7 +424,7 @@ public static function alert(Stringable|string $message, array|string $context = * @param \Stringable|string $message log message * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success @@ -440,7 +440,7 @@ public static function critical(Stringable|string $message, array|string $contex * @param \Stringable|string $message log message * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success @@ -456,7 +456,7 @@ public static function error(Stringable|string $message, array|string $context = * @param \Stringable|string $message log message * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success @@ -472,7 +472,7 @@ public static function warning(Stringable|string $message, array|string $context * @param \Stringable|string $message log message * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success @@ -488,7 +488,7 @@ public static function notice(Stringable|string $message, array|string $context * @param \Stringable|string $message log message * @param array|string $context Additional data to be used for logging the message. * The special `scope` key can be passed to be used for further filtering of the - * log engines to be used. If a string or a numerically index array is passed, it + * log engines to be used. If a string or a numerically indexed array is passed, it * will be treated as the `scope` key. * See {@link \Cake\Log\Log::setConfig()} for more information on logging scopes. * @return bool Success diff --git a/app/vendor/cakephp/cakephp/src/Log/composer.json b/app/vendor/cakephp/cakephp/src/Log/composer.json index 593de4ff1..a794a5342 100644 --- a/app/vendor/cakephp/cakephp/src/Log/composer.json +++ b/app/vendor/cakephp/cakephp/src/Log/composer.json @@ -23,8 +23,8 @@ "source": "https://github.com/cakephp/log" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev", + "php": ">=8.2", + "cakephp/core": "^5.3.0", "psr/log": "^3.0" }, "autoload": { @@ -35,10 +35,11 @@ "provide": { "psr/log-implementation": "^3.0" }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Mailer/Mailer.php b/app/vendor/cakephp/cakephp/src/Mailer/Mailer.php index 5dc38ddc2..3f4b32c62 100644 --- a/app/vendor/cakephp/cakephp/src/Mailer/Mailer.php +++ b/app/vendor/cakephp/cakephp/src/Mailer/Mailer.php @@ -117,7 +117,7 @@ * @method string getSubject() Gets subject. {@see \Cake\Mailer\Message::getSubject()} * @method $this setHeaders(array $headers) Sets headers for the message. {@see \Cake\Mailer\Message::setHeaders()} * @method $this addHeaders(array $headers) Add header for the message. {@see \Cake\Mailer\Message::addHeaders()} - * @method $this getHeaders(array $include = []) Get list of headers. {@see \Cake\Mailer\Message::getHeaders()} + * @method array getHeaders(array $include = []) Get list of headers. {@see \Cake\Mailer\Message::getHeaders()} * @method $this setEmailFormat($format) Sets email format. {@see \Cake\Mailer\Message::setEmailFormat()} * @method string getEmailFormat() Gets email format. {@see \Cake\Mailer\Message::getEmailFormat()} * @method $this setMessageId($message) Sets message ID. {@see \Cake\Mailer\Message::setMessageId()} @@ -126,8 +126,9 @@ * @method string getDomain() Gets domain. {@see \Cake\Mailer\Message::getDomain()} * @method $this setAttachments($attachments) Add attachments to the email message. {@see \Cake\Mailer\Message::setAttachments()} * @method array getAttachments() Gets attachments to the email message. {@see \Cake\Mailer\Message::getAttachments()} + * @method $this addAttachment(\Psr\Http\Message\UploadedFileInterface|string $path, ?string $name, ?string $mimetype, ?string $contentId, ?bool $contentDisposition) Add an attachment. {@see \Cake\Mailer\Message::addAttachment()} * @method $this addAttachments($attachments) Add attachments. {@see \Cake\Mailer\Message::addAttachments()} - * @method array|string getBody(?string $type = null) Get generated message body as array. + * @method array getBody(?string $type = null) Get generated message body as array. * {@see \Cake\Mailer\Message::getBody()} */ class Mailer implements EventListenerInterface @@ -235,7 +236,7 @@ public function getRenderer(): Renderer /** * Set email renderer. * - * @param \Cake\Mailer\Renderer $renderer Render instance. + * @param \Cake\Mailer\Renderer $renderer Renderer instance. * @return $this */ public function setRenderer(Renderer $renderer) diff --git a/app/vendor/cakephp/cakephp/src/Mailer/Message.php b/app/vendor/cakephp/cakephp/src/Mailer/Message.php index 9e02bb3e4..a49e354d1 100644 --- a/app/vendor/cakephp/cakephp/src/Mailer/Message.php +++ b/app/vendor/cakephp/cakephp/src/Mailer/Message.php @@ -38,14 +38,14 @@ class Message implements JsonSerializable { /** - * Line length - no should more - RFC 2822 - 2.1.1 + * Line length - should not exceed - RFC 2822 - 2.1.1 * * @var int */ public const LINE_LENGTH_SHOULD = 78; /** - * Line length - no must more - RFC 2822 - 2.1.1 + * Line length - must not exceed - RFC 2822 - 2.1.1 * * @var int */ @@ -910,7 +910,7 @@ public function getHeaders(array $include = []): array $headersMultipleEmails = ['to', 'cc', 'bcc', 'replyTo']; foreach ($relation as $var => $header) { if ($include[$var]) { - if (in_array($var, $headersMultipleEmails)) { + if (in_array($var, $headersMultipleEmails, true)) { $headers[$header] = implode(', ', $this->formatAddress($this->{$var})); } else { $headers[$header] = (string)current($this->formatAddress($this->{$var})); @@ -926,9 +926,7 @@ public function getHeaders(array $include = []): array } $headers += $this->headers; - if (!isset($headers['Date'])) { - $headers['Date'] = date(DATE_RFC2822); - } + $headers['Date'] ??= date(DATE_RFC2822); if ($this->messageId !== false) { if ($this->messageId === true) { $this->messageId = '<' . str_replace('-', '', Text::uuid()) . '@' . $this->domain . '>'; @@ -999,9 +997,9 @@ public function getHeadersString(array $include = [], string $eol = "\r\n", ?Clo * in address header fields. * * @param array $address Addresses to format. - * @return array + * @return array */ - protected function formatAddress(array $address): array + public function formatAddress(array $address): array { $return = []; foreach ($address as $email => $alias) { @@ -1208,9 +1206,8 @@ public function setAttachments(array $attachments) ) { $fileInfo['mimetype'] = mime_content_type($fileInfo['file']); } - if (!isset($fileInfo['mimetype'])) { - $fileInfo['mimetype'] = 'application/octet-stream'; - } + $fileInfo['mimetype'] ??= 'application/octet-stream'; + $attach[$name] = $fileInfo; } $this->attachments = $attach; @@ -1228,13 +1225,42 @@ public function getAttachments(): array return $this->attachments; } + /** + * Add attachment. + * + * @param \Psr\Http\Message\UploadedFileInterface|string $path Path to the file or UploadedFileInterface instance. + * @param string|null $name Overrides the attachment name. + * @param string|null $mimetype Mimetype of the file. + * @param string|null $contentId Content ID for inline attachments. + * @param bool|null $contentDisposition Allows you to disable the `Content-Disposition` header + * @return $this + */ + public function addAttachment( + UploadedFileInterface|string $path, + ?string $name = null, + ?string $mimetype = null, + ?string $contentId = null, + ?bool $contentDisposition = null, + ) { + $name ??= 0; + + $this->addAttachments([$name => [ + 'file' => $path, + 'mimetype' => $mimetype, + 'contentId' => $contentId, + 'contentDisposition' => $contentDisposition, + ]]); + + return $this; + } + /** * Add attachments * * @param array $attachments Array of filenames. * @return $this * @throws \InvalidArgumentException - * @see \Cake\Mailer\Email::setAttachments() + * @see Message::setAttachments() */ public function addAttachments(array $attachments) { @@ -1862,7 +1888,7 @@ public function jsonSerialize(): array $array[$property] = $this->{$property}; } - array_walk($array['attachments'], function (&$item, $key): void { + array_walk($array['attachments'], function (array &$item): void { if (!empty($item['file'])) { $item['data'] = $this->readFile($item['file']); unset($item['file']); @@ -1897,7 +1923,7 @@ public function createFromArray(array $config) public function __serialize(): array { $array = $this->jsonSerialize(); - array_walk_recursive($array, function (&$item, $key): void { + array_walk_recursive($array, function (&$item): void { if ($item instanceof SimpleXMLElement) { $item = json_decode((string)json_encode((array)$item), true); } diff --git a/app/vendor/cakephp/cakephp/src/Mailer/Renderer.php b/app/vendor/cakephp/cakephp/src/Mailer/Renderer.php index dbb7e41da..d1d9f411f 100644 --- a/app/vendor/cakephp/cakephp/src/Mailer/Renderer.php +++ b/app/vendor/cakephp/cakephp/src/Mailer/Renderer.php @@ -109,8 +109,6 @@ public function reset() /** * Clone ViewBuilder instance when renderer is cloned. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/Mailer/Transport/SmtpTransport.php b/app/vendor/cakephp/cakephp/src/Mailer/Transport/SmtpTransport.php index 866dbd847..90f77292c 100644 --- a/app/vendor/cakephp/cakephp/src/Mailer/Transport/SmtpTransport.php +++ b/app/vendor/cakephp/cakephp/src/Mailer/Transport/SmtpTransport.php @@ -99,6 +99,16 @@ public function __destruct() } } + /** + * Returns only serializable properties + * + * @return array + */ + public function __serialize(): array + { + return array_diff_key(get_object_vars($this), ['_socket' => null]); + } + /** * Unserialize handler. * @@ -106,9 +116,13 @@ public function __destruct() * * @return void */ - public function __wakeup(): void + public function __unserialize(array $data): void { - unset($this->_socket); + unset($data['_socket']); + + foreach ($data as $key => $val) { + $this->{$key} = $val; + } } /** diff --git a/app/vendor/cakephp/cakephp/src/Mailer/TransportFactory.php b/app/vendor/cakephp/cakephp/src/Mailer/TransportFactory.php index 8bec1c39d..4794e899e 100644 --- a/app/vendor/cakephp/cakephp/src/Mailer/TransportFactory.php +++ b/app/vendor/cakephp/cakephp/src/Mailer/TransportFactory.php @@ -73,7 +73,7 @@ public static function setRegistry(TransportRegistry $registry): void * * @param string $name Name of the config array that needs a transport instance built * @return void - * @throws \InvalidArgumentException When a tranport cannot be created. + * @throws \InvalidArgumentException When a transport cannot be created. */ protected static function _buildTransport(string $name): void { diff --git a/app/vendor/cakephp/cakephp/src/Mailer/TransportRegistry.php b/app/vendor/cakephp/cakephp/src/Mailer/TransportRegistry.php index 00f7c2826..c251304f1 100644 --- a/app/vendor/cakephp/cakephp/src/Mailer/TransportRegistry.php +++ b/app/vendor/cakephp/cakephp/src/Mailer/TransportRegistry.php @@ -42,12 +42,12 @@ protected function _resolveClassName(string $class): ?string } /** - * Throws an exception when a cache engine is missing. + * Throws an exception when a transport is missing. * * Part of the template method for Cake\Core\ObjectRegistry::load() * * @param string $class The classname that is missing. - * @param string|null $plugin The plugin the cache is missing in. + * @param string|null $plugin The plugin the transport is missing in. * @return void * @throws \BadMethodCallException */ @@ -63,7 +63,7 @@ protected function _throwMissingClassError(string $class, ?string $plugin): void * * @param \Cake\Mailer\AbstractTransport|class-string<\Cake\Mailer\AbstractTransport> $class The classname or object to make. * @param string $alias The alias of the object. - * @param array $config An array of settings to use for the cache engine. + * @param array $config An array of settings to use for the transport. * @return \Cake\Mailer\AbstractTransport The constructed transport class. */ protected function _create(object|string $class, string $alias, array $config): AbstractTransport diff --git a/app/vendor/cakephp/cakephp/src/Network/Socket.php b/app/vendor/cakephp/cakephp/src/Network/Socket.php index d29a03270..f83a87b84 100644 --- a/app/vendor/cakephp/cakephp/src/Network/Socket.php +++ b/app/vendor/cakephp/cakephp/src/Network/Socket.php @@ -57,6 +57,7 @@ class Socket * This boolean contains the current state of the Socket class * * @var bool + * @deprecated 5.2.9 Use isConnected() instead. */ protected bool $connected = false; @@ -166,8 +167,8 @@ public function connect(): bool restore_error_handler(); if ($this->connection === null && (!$errNum || !$errStr)) { - $this->setLastError($errNum, $errStr); - throw new SocketException($errStr, $errNum); + $this->setLastError($errNum ?? 0, $errStr ?? ''); + throw new SocketException($errStr ?? '', $errNum ?? 0); } if ($this->connection === null && $this->_connectionErrors) { @@ -175,14 +176,15 @@ public function connect(): bool throw new SocketException($message, E_WARNING); } - $this->connected = is_resource($this->connection); - if ($this->connected) { + $connected = is_resource($this->connection); + $this->connected = $connected; + if ($connected) { assert($this->connection !== null); stream_set_timeout($this->connection, (int)$this->_config['timeout']); } - return $this->connected; + return $connected; } /** @@ -192,15 +194,15 @@ public function connect(): bool */ public function isConnected(): bool { - return $this->connected; + return is_resource($this->connection); } /** * Create a stream socket client. Mock utility. * * @param string $remoteSocketTarget remote socket - * @param int $errNum error number - * @param string $errStr error string + * @param int|null $errNum error number + * @param string|null $errStr error string * @param int $timeout timeout * @param int<0, 7> $connectAs flags * @param resource $context context @@ -208,8 +210,8 @@ public function isConnected(): bool */ protected function _getStreamSocketClient( string $remoteSocketTarget, - int &$errNum, - string &$errStr, + ?int &$errNum, + ?string &$errStr, int $timeout, int $connectAs, $context, @@ -248,9 +250,8 @@ protected function _setSslContext(string $host): void } unset($this->_config[$key]); } - if (!isset($this->_config['context']['ssl']['SNI_enabled'])) { - $this->_config['context']['ssl']['SNI_enabled'] = true; - } + $this->_config['context']['ssl']['SNI_enabled'] ??= true; + if (empty($this->_config['context']['ssl']['peer_name'])) { $this->_config['context']['ssl']['peer_name'] = $host; } @@ -264,7 +265,7 @@ protected function _setSslContext(string $host): void } /** - * socket_stream_client() does not populate errNum, or $errStr when there are + * stream_socket_client() does not populate errNum, or $errStr when there are * connection errors, as in the case of SSL verification failure. * * Instead, we need to handle those errors manually. @@ -368,7 +369,7 @@ public function setLastError(?int $errNum, string $errStr): void */ public function write(string $data): int { - if (!$this->connected && !$this->connect()) { + if (!$this->isConnected() && !$this->connect()) { return 0; } $totalBytes = strlen($data); @@ -399,7 +400,7 @@ public function read(int $length = 1024): ?string throw new InvalidArgumentException('Length must be greater than `0`'); } - if (!$this->connected && !$this->connect()) { + if (!$this->isConnected() && !$this->connect()) { return null; } @@ -449,7 +450,7 @@ public function __destruct() } /** - * Resets the state of this Socket instance to it's initial state (before Object::__construct got executed) + * Resets the state of this Socket instance to its initial state (before __construct() got executed) * * @param array|null $state Array with key and values to reset * @return void diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association.php b/app/vendor/cakephp/cakephp/src/ORM/Association.php index bc0f9bb9b..4ec9673ab 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association.php @@ -201,6 +201,11 @@ abstract class Association self::STRATEGY_SUBQUERY, ]; + /** + * Whether the property name needs to be checked for collisions with source table fields. + */ + private bool $checkPropertyName = true; + /** * Constructor. Subclasses can override _options function to get the original * list of passed options if expecting any other special key @@ -547,12 +552,13 @@ public function getJoinType(): string * Sets the property name that should be filled with data from the target table * in the source table record. * - * @param string $name The name of the association property. Use null to read the current value. + * @param string $name The name of the association property. * @return $this */ public function setProperty(string $name) { $this->_propertyName = $name; + $this->checkPropertyName = true; return $this; } @@ -566,15 +572,19 @@ public function setProperty(string $name) public function getProperty(): string { if (!isset($this->_propertyName)) { - $this->_propertyName = $this->_propertyName(); - if (in_array($this->_propertyName, $this->_sourceTable->getSchema()->columns(), true)) { - $msg = 'Association property name `%s` clashes with field of same name of table `%s`.' . - ' You should explicitly specify the `propertyName` option.'; - trigger_error( - sprintf($msg, $this->_propertyName, $this->_sourceTable->getTable()), - E_USER_WARNING, - ); - } + $this->setProperty($this->_propertyName()); + } + + if ( + $this->checkPropertyName + && in_array($this->_propertyName, $this->_sourceTable->getSchema()->columns(), true) + ) { + $msg = 'Association property name `%s` clashes with field of same name of table `%s`.' . + ' You should specify an alterate name using the `propertyName` option or `setProperty()` method.'; + trigger_error( + sprintf($msg, $this->_propertyName, $this->_sourceTable->getTable()), + E_USER_WARNING, + ); } return $this->_propertyName; @@ -593,13 +603,17 @@ protected function _propertyName(): string } /** - * Sets the strategy name to be used to fetch associated records. Keep in mind - * that some association types might not implement but a default strategy, - * rendering any changes to this setting void. + * Sets the strategy name to be used to fetch associated records. + * + * Valid strategies depend on the association type and are stored in $_validStrategies. + * Some association types might only implement a default strategy, making this setting + * ineffective. * - * @param string $name The strategy type. Use null to read the current value. + * @param string $name The strategy type (e.g., 'select', 'subquery', 'join'). + * Available strategies vary by association type. * @return $this * @throws \InvalidArgumentException When an invalid strategy is provided. + * @see Association::getStrategy() to retrieve the current strategy. */ public function setStrategy(string $name) { @@ -682,7 +696,7 @@ protected function _options(array $options): void * - negateMatch: Will append a condition to the passed query for excluding matches. * with this association. * - * @param \Cake\ORM\Query\SelectQuery $query the query to be altered to include the target table data + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query to be altered to include the target table data * @param array $options Any extra options or overrides to be taken into account * @return void * @throws \RuntimeException Unable to build the query or associations. @@ -721,6 +735,7 @@ public function attachTo(SelectQuery $query, array $options = []): void ->eagerLoaded(true); if (!empty($options['queryBuilder'])) { + assert(is_callable($options['queryBuilder'])); $dummy = $options['queryBuilder']($dummy); if (!($dummy instanceof SelectQuery)) { throw new DatabaseException(sprintf( @@ -760,7 +775,7 @@ public function attachTo(SelectQuery $query, array $options = []): void * Conditionally adds a condition to the passed Query that will make it find * records where there is no match with this association. * - * @param \Cake\ORM\Query\SelectQuery $query The query to modify + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query to modify * @param array $options Options array containing the `negateMatch` key. * @return void */ @@ -834,7 +849,7 @@ public function defaultRowValue(array $row, bool $joined): array * it will be interpreted as the `$args` parameter * @param mixed ...$args Arguments that match up to finder-specific parameters * @see \Cake\ORM\Table::find() - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ public function find(array|string|null $type = null, mixed ...$args): SelectQuery { @@ -920,7 +935,7 @@ public function requiresKeys(array $options = []): bool * Triggers `beforeFind` on the target table for the query this association is * attaching to * - * @param \Cake\ORM\Query\SelectQuery $query the query this association is attaching itself to + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query this association is attaching itself to * @return void */ protected function _dispatchBeforeFind(SelectQuery $query): void @@ -932,8 +947,8 @@ protected function _dispatchBeforeFind(SelectQuery $query): void * Helper function used to conditionally append fields to the select clause of * a query from the fields found in another query object. * - * @param \Cake\ORM\Query\SelectQuery $query the query that will get the fields appended to - * @param \Cake\ORM\Query\SelectQuery $surrogate the query having the fields to be copied from + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query that will get the fields appended to + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $surrogate the query having the fields to be copied from * @param array $options options passed to the method `attachTo` * @return void */ @@ -950,6 +965,34 @@ protected function _appendFields(SelectQuery $query, SelectQuery $surrogate, arr $surrogate->isAutoFieldsEnabled() ) { $fields = array_merge($fields, $this->getTarget()->getSchema()->columns()); + } elseif ($fields !== []) { + // Ensure primary key fields are always included when specific fields are selected + // This prevents issues with entity hydration when only nullable columns are selected + $primaryKey = $this->getTarget()->getPrimaryKey(); + $primaryKeyFields = is_array($primaryKey) ? $primaryKey : [$primaryKey]; + + $fieldsToAdd = []; + foreach ($primaryKeyFields as $pkField) { + $found = false; + foreach ($fields as $field) { + if ( + is_string($field) && ( + $field === $pkField || + str_ends_with($field, '.' . $pkField) + ) + ) { + $found = true; + break; + } + } + if (!$found) { + $fieldsToAdd[] = $pkField; + } + } + + if ($fieldsToAdd) { + $fields = array_merge($fields, $fieldsToAdd); + } } $query->select($query->aliasFields($fields, $this->_name)); @@ -963,8 +1006,8 @@ protected function _appendFields(SelectQuery $query, SelectQuery $surrogate, arr * applying the surrogate formatters to only the property corresponding to * such a table. * - * @param \Cake\ORM\Query\SelectQuery $query the query that will get the formatter applied to - * @param \Cake\ORM\Query\SelectQuery $surrogate the query having formatters for the associated + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query that will get the formatter applied to + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $surrogate the query having formatters for the associated * target table. * @param array $options options passed to the method `attachTo` * @return void @@ -1024,8 +1067,8 @@ function (CollectionInterface $results, SelectQuery $query) use ($formatters, $p * passed `$query`. Containments are altered so that they respect the association * chain from which they originated. * - * @param \Cake\ORM\Query\SelectQuery $query the query that will get the associations attached to - * @param \Cake\ORM\Query\SelectQuery $surrogate the query having the containments to be attached + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query that will get the associations attached to + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $surrogate the query having the containments to be attached * @param array $options options passed to the method `attachTo` * @return void */ @@ -1075,12 +1118,10 @@ protected function _joinCondition(array $options): array $foreignKey = (array)$options['foreignKey']; $bindingKey = (array)$this->getBindingKey(); + $targetOwns = $this->isOwningSide($this->getTarget()); if (count($foreignKey) !== count($bindingKey)) { if (!$bindingKey) { - $table = $this->getTarget()->getTable(); - if ($this->isOwningSide($this->getSource())) { - $table = $this->getSource()->getTable(); - } + $table = $targetOwns ? $this->getTarget()->getTable() : $this->getSource()->getTable(); $msg = 'The `%s` table does not define a primary key, and cannot have join conditions generated.'; throw new DatabaseException(sprintf($msg, $table)); } @@ -1095,8 +1136,12 @@ protected function _joinCondition(array $options): array } foreach ($foreignKey as $k => $f) { - $field = sprintf('%s.%s', $sAlias, $bindingKey[$k]); - $value = new IdentifierExpression(sprintf('%s.%s', $tAlias, $f)); + // Set foreign and binding aliases based on which side has the foreign key + $fAlias = $targetOwns ? $sAlias : $tAlias; + $bAlias = $targetOwns ? $tAlias : $sAlias; + + $field = sprintf('%s.%s', $bAlias, $bindingKey[$k]); + $value = new IdentifierExpression(sprintf('%s.%s', $fAlias, $f)); $conditions[$field] = $value; } @@ -1148,11 +1193,11 @@ public function __get(string $property): Association * target table has another association with the passed name * * @param string $property the property name - * @return bool true if the property exists + * @return bool true if the association exists */ public function __isset(string $property): bool { - return isset($this->getTarget()->{$property}); + return $this->getTarget()->hasAssociation($property); } /** diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsTo.php b/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsTo.php index 2ecfce120..908b2914d 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsTo.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsTo.php @@ -16,8 +16,6 @@ */ namespace Cake\ORM\Association; -use Cake\Database\Exception\DatabaseException; -use Cake\Database\Expression\IdentifierExpression; use Cake\Datasource\EntityInterface; use Cake\ORM\Association; use Cake\ORM\Association\Loader\SelectLoader; @@ -52,11 +50,7 @@ class BelongsTo extends Association */ public function getForeignKey(): array|string|false { - if (!isset($this->_foreignKey)) { - $this->_foreignKey = $this->_modelKey($this->getTarget()->getAlias()); - } - - return $this->_foreignKey; + return $this->_foreignKey ??= $this->_modelKey($this->getTarget()->getAlias()); } /** @@ -154,6 +148,7 @@ public function saveAssociated(EntityInterface $entity, array $options = []): En $targetEntity->extract((array)$this->getBindingKey()), ); + // @phpstan-ignore function.alreadyNarrowedType (patch method available on EntityInterface) if (method_exists($entity, 'patch')) { $entity = $entity->patch($properties, ['guard' => false]); } else { @@ -163,47 +158,6 @@ public function saveAssociated(EntityInterface $entity, array $options = []): En return $entity; } - /** - * Returns a single or multiple conditions to be appended to the generated join - * clause for getting the results on the target table. - * - * @param array $options list of options passed to attachTo method - * @return array<\Cake\Database\Expression\IdentifierExpression> - * @throws \Cake\Database\Exception\DatabaseException if the number of columns in the foreignKey do not - * match the number of columns in the target table primaryKey - */ - protected function _joinCondition(array $options): array - { - $conditions = []; - $tAlias = $this->_name; - $sAlias = $this->_sourceTable->getAlias(); - $foreignKey = (array)$options['foreignKey']; - $bindingKey = (array)$this->getBindingKey(); - - if (count($foreignKey) !== count($bindingKey)) { - if (!$bindingKey) { - $msg = 'The `%s` table does not define a primary key. Please set one.'; - throw new DatabaseException(sprintf($msg, $this->getTarget()->getTable())); - } - - $msg = 'Cannot match provided foreignKey for `%s`, got `(%s)` but expected foreign key for `(%s)`.'; - throw new DatabaseException(sprintf( - $msg, - $this->_name, - implode(', ', $foreignKey), - implode(', ', $bindingKey), - )); - } - - foreach ($foreignKey as $k => $f) { - $field = sprintf('%s.%s', $tAlias, $bindingKey[$k]); - $value = new IdentifierExpression(sprintf('%s.%s', $sAlias, $f)); - $conditions[$field] = $value; - } - - return $conditions; - } - /** * @inheritDoc */ diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsToMany.php b/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsToMany.php index 1ad935135..d9fd2c9ab 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsToMany.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association/BelongsToMany.php @@ -203,11 +203,7 @@ public function canBeJoined(array $options = []): bool */ public function getForeignKey(): array|string|false { - if (!isset($this->_foreignKey)) { - $this->_foreignKey = $this->_modelKey($this->getSource()->getTable()); - } - - return $this->_foreignKey; + return $this->_foreignKey ??= $this->_modelKey($this->getSource()->getTable()); } /** @@ -467,7 +463,7 @@ protected function _generateJunctionAssociations(Table $junction, Table $source, * - fields: a list of fields in the target table to include in the result * - type: The type of join to be used (e.g. INNER) * - * @param \Cake\ORM\Query\SelectQuery $query the query to be altered to include the target table data + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query to be altered to include the target table data * @param array $options Any extra options or overrides to be taken in account * @return void */ @@ -507,7 +503,9 @@ public function attachTo(SelectQuery $query, array $options = []): void } /** - * @inheritDoc + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query to append to. + * @param array $options The options for not matching. + * @return void */ protected function _appendNotMatching(SelectQuery $query, array $options): void { @@ -524,6 +522,8 @@ protected function _appendNotMatching(SelectQuery $query, array $options): void ->where($options['conditions']); if (!empty($options['queryBuilder'])) { + assert(is_callable($options['queryBuilder'])); + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $subquery */ $subquery = $options['queryBuilder']($subquery); } @@ -535,7 +535,7 @@ protected function _appendNotMatching(SelectQuery $query, array $options): void foreach (array_keys($conds) as $field) { $identifiers[] = new IdentifierExpression($field); } - $identifiers = $subquery->newExpr()->add($identifiers)->setConjunction(','); + $identifiers = $subquery->expr()->add($identifiers)->setConjunction(','); $nullExp = clone $exp; return $exp @@ -619,7 +619,8 @@ public function cascadeDelete(EntityInterface $entity, array $options = []): boo $table = $this->junction(); $hasMany = $this->getSource()->getAssociation($table->getAlias()); if ($this->_cascadeCallbacks) { - foreach ($hasMany->find('all')->where($conditions)->all()->toList() as $related) { + /** @var \Cake\Datasource\EntityInterface $related */ + foreach ($hasMany->find('all')->where($conditions)->toArray() as $related) { $success = $table->delete($related, $options); if (!$success) { return false; @@ -956,14 +957,11 @@ public function unlink(EntityInterface $sourceEntity, array $targetEntities, arr $this->_checkPersistenceStatus($sourceEntity, $targetEntities); $property = $this->getProperty(); - $this->junction()->getConnection()->transactional( - function () use ($sourceEntity, $targetEntities, $options): void { - $links = $this->_collectJointEntities($sourceEntity, $targetEntities); - foreach ($links as $entity) { - $this->_junctionTable->delete($entity, $options); - } - }, - ); + $links = $this->_collectJointEntities($sourceEntity, $targetEntities); + $return = $this->_junctionTable->deleteMany($links, $options); + if ($return === false) { + return false; + } /** @var array<\Cake\Datasource\EntityInterface> $existing */ $existing = $sourceEntity->get($property) ?: []; @@ -1101,7 +1099,7 @@ protected function junctionConditions(): array * it will be interpreted as the `$options` parameter * @param mixed ...$args Arguments that match up to finder-specific parameters * @see \Cake\ORM\Table::find() - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ public function find(array|string|null $type = null, mixed ...$args): SelectQuery { @@ -1125,9 +1123,9 @@ public function find(array|string|null $type = null, mixed ...$args): SelectQuer /** * Append a join to the junction table. * - * @param \Cake\ORM\Query\SelectQuery $query The query to append. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query to append. * @param array|null $conditions The query conditions to use. - * @return \Cake\ORM\Query\SelectQuery The modified query. + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> The modified query. */ protected function _appendJunctionJoin(SelectQuery $query, ?array $conditions = null): SelectQuery { @@ -1246,6 +1244,7 @@ function () use ($sourceEntity, $targetEntities, $primaryValue, $options) { // Create a subquery join to ensure we get // the correct entity passed to callbacks. + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $existing */ $existing = $junction->selectQuery() ->from([$junctionQueryAlias => $matches]) ->innerJoin( @@ -1287,7 +1286,7 @@ function () use ($sourceEntity, $targetEntities, $primaryValue, $options) { * `$existing` and `$jointEntities`. This method will return the values from * `$targetEntities` that were not deleted from calculating the difference. * - * @param \Cake\ORM\Query\SelectQuery $existing a query for getting existing links + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $existing a query for getting existing links * @param array<\Cake\Datasource\EntityInterface> $jointEntities link entities that should be persisted * @param array $targetEntities entities in target table that are related to * the `$jointEntities` @@ -1447,20 +1446,24 @@ protected function _collectJointEntities(EntityInterface $sourceEntity, array $t $hasMany = $source->getAssociation($junction->getAlias()); /** @var array $foreignKey */ $foreignKey = (array)$this->getForeignKey(); - $foreignKey = array_map(function ($key) { + $foreignKey = array_map(function (string $key) { return $key . ' IS'; }, $foreignKey); + /** @var array $assocForeignKey */ $assocForeignKey = (array)$belongsTo->getForeignKey(); - $assocForeignKey = array_map(function ($key) { + $assocForeignKey = array_map(function (string $key) { return $key . ' IS'; }, $assocForeignKey); $sourceKey = $sourceEntity->extract((array)$source->getPrimaryKey()); $unions = []; foreach ($missing as $key) { - $unions[] = $hasMany->find() + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface> $unionQuery */ + $unionQuery = $hasMany->find() ->where(array_combine($foreignKey, $sourceKey)) ->where(array_combine($assocForeignKey, $key)); + + $unions[] = $unionQuery; } $query = array_shift($unions); diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association/DependentDeleteHelper.php b/app/vendor/cakephp/cakephp/src/ORM/Association/DependentDeleteHelper.php index d33dea0f9..e26061508 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association/DependentDeleteHelper.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association/DependentDeleteHelper.php @@ -53,7 +53,8 @@ public function cascadeDelete(Association $association, EntityInterface $entity, $conditions = array_combine($foreignKey, $bindingValue); if ($association->getCascadeCallbacks()) { - foreach ($association->find()->where($conditions)->all()->toList() as $related) { + /** @var \Cake\Datasource\EntityInterface $related */ + foreach ($association->find()->where($conditions)->toArray() as $related) { $success = $table->delete($related, $options); if (!$success) { return false; diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association/HasMany.php b/app/vendor/cakephp/cakephp/src/ORM/Association/HasMany.php index 2e53236e9..3b352b1db 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association/HasMany.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association/HasMany.php @@ -228,6 +228,7 @@ protected function _saveTarget( } if ($foreignKeyReference !== $entity->extract($foreignKey)) { + // @phpstan-ignore function.alreadyNarrowedType (patch method available on EntityInterface) if (method_exists($entity, 'patch')) { $entity->patch($foreignKeyReference, ['guard' => false]); } else { @@ -277,7 +278,7 @@ protected function _saveTarget( * * @param \Cake\Datasource\EntityInterface $sourceEntity the row belonging to the `source` side * of this association - * @param array $targetEntities list of entities belonging to the `target` side + * @param array<\Cake\Datasource\EntityInterface> $targetEntities list of entities belonging to the `target` side * of this association * @param array $options list of options to be passed to the internal `save` call * @return bool true on success, false otherwise @@ -288,11 +289,13 @@ public function link(EntityInterface $sourceEntity, array $targetEntities, array $this->setSaveStrategy(self::SAVE_APPEND); $property = $this->getProperty(); + /** @var array<\Cake\Datasource\EntityInterface> $currentEntities */ $currentEntities = (array)$sourceEntity->get($property); if ($currentEntities === []) { $currentEntities = $targetEntities; } else { $pkFields = (array)$this->getTarget()->getPrimaryKey(); + /** @var array<\Cake\Datasource\EntityInterface> $currentEntities */ $targetEntities = (new Collection($targetEntities)) ->reject( function (EntityInterface $entity) use ($currentEntities, $pkFields) { @@ -367,9 +370,9 @@ function (EntityInterface $entity) use ($currentEntities, $pkFields) { * If boolean it will be used a value for "cleanProperty" option. * @throws \InvalidArgumentException if non persisted entities are passed or if * any of them is lacking a primary key value - * @return void + * @return bool */ - public function unlink(EntityInterface $sourceEntity, array $targetEntities, array|bool $options = []): void + public function unlink(EntityInterface $sourceEntity, array $targetEntities, array|bool $options = []): bool { if (is_bool($options)) { $options = [ @@ -379,7 +382,7 @@ public function unlink(EntityInterface $sourceEntity, array $targetEntities, arr $options += ['cleanProperty' => true]; } if ($targetEntities === []) { - return; + return true; } $foreignKey = (array)$this->getForeignKey(); @@ -396,7 +399,10 @@ public function unlink(EntityInterface $sourceEntity, array $targetEntities, arr ->toList(), ]; - $this->_unlink($foreignKey, $target, $conditions, $options); + $return = $this->_unlink($foreignKey, $target, $conditions, $options); + if (!$return) { + return false; + } $result = $sourceEntity->get($property); if ($options['cleanProperty'] && $result !== null) { @@ -405,7 +411,7 @@ public function unlink(EntityInterface $sourceEntity, array $targetEntities, arr (new Collection($sourceEntity->get($property))) ->reject( function ($assoc) use ($targetEntities) { - return in_array($assoc, $targetEntities); + return in_array($assoc, $targetEntities, true); }, ) ->toList(), @@ -413,6 +419,8 @@ function ($assoc) use ($targetEntities) { } $sourceEntity->setDirty($property, false); + + return true; } /** @@ -550,13 +558,15 @@ protected function _unlink(array $foreignKey, Table $target, array $conditions = } } }); + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface> $query */ $query = $this->find()->where($conditions); - $ok = true; - foreach ($query->all() as $assoc) { - $ok = $ok && $target->delete($assoc, $options); + + $return = $target->deleteMany($query->all(), $options); + if ($return === false) { + return false; } - return $ok; + return true; } $this->deleteAll($conditions); @@ -582,11 +592,10 @@ protected function _foreignKeyAcceptsNull(Table $table, array $properties): bool return !in_array( false, array_map( - function ($prop) use ($table) { - return $table->getSchema()->isNullable($prop); - }, + $table->getSchema()->isNullable(...), $properties, ), + true, ); } @@ -617,11 +626,7 @@ public function canBeJoined(array $options = []): bool */ public function getForeignKey(): array|string|false { - if (!isset($this->_foreignKey)) { - $this->_foreignKey = $this->_modelKey($this->getSource()->getTable()); - } - - return $this->_foreignKey; + return $this->_foreignKey ??= $this->_modelKey($this->getSource()->getTable()); } /** diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association/HasOne.php b/app/vendor/cakephp/cakephp/src/ORM/Association/HasOne.php index accdb1b99..71d7d4da7 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association/HasOne.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association/HasOne.php @@ -50,11 +50,7 @@ class HasOne extends Association */ public function getForeignKey(): array|string|false { - if (!isset($this->_foreignKey)) { - $this->_foreignKey = $this->_modelKey($this->getSource()->getAlias()); - } - - return $this->_foreignKey; + return $this->_foreignKey ??= $this->_modelKey($this->getSource()->getAlias()); } /** @@ -131,6 +127,7 @@ public function saveAssociated(EntityInterface $entity, array $options = []): En $foreignKeys, $entity->extract((array)$this->getBindingKey()), ); + // @phpstan-ignore function.alreadyNarrowedType (patch method available on EntityInterface) if (method_exists($targetEntity, 'patch')) { $targetEntity = $targetEntity->patch($properties, ['guard' => false]); } else { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectLoader.php b/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectLoader.php index 35113ab62..866e6ac7f 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectLoader.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectLoader.php @@ -24,7 +24,6 @@ use Cake\ORM\Association; use Cake\ORM\Query\SelectQuery; use Closure; -use InvalidArgumentException; /** * Implements the logic for loading an association using a SELECT query @@ -153,7 +152,7 @@ protected function _defaultOptions(): array * the source table * * @param array $options options accepted by eagerLoader() - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> * @throws \InvalidArgumentException When a key is required for associations but not selected. */ protected function _buildQuery(array $options): SelectQuery @@ -171,14 +170,18 @@ protected function _buildQuery(array $options): SelectQuery $query = $query->find($finderName, ...$opts); } - /** @var \Cake\ORM\Query\SelectQuery $selectQuery */ + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $selectQuery */ $selectQuery = $options['query']; + // Disable hydration for external queries when parent has DTO projection + // The DTO's setFromArray() expects arrays, not entities + $shouldHydrate = $selectQuery->isHydrationEnabled() && !$selectQuery->isDtoProjectionEnabled(); + $fetchQuery = $query ->select($options['fields']) ->where($options['conditions']) ->eagerLoaded(true) - ->enableHydration($selectQuery->isHydrationEnabled()) + ->enableHydration($shouldHydrate) ->setConnectionRole($selectQuery->getConnectionRole()); if ($selectQuery->isResultsCastingEnabled()) { $fetchQuery->enableResultsCasting(); @@ -202,6 +205,8 @@ protected function _buildQuery(array $options): SelectQuery } if (!empty($options['queryBuilder'])) { + assert(is_callable($options['queryBuilder'])); + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $fetchQuery */ $fetchQuery = $options['queryBuilder']($fetchQuery); } @@ -240,9 +245,10 @@ protected function _extractFinder(array|string $finderData): array /** * Checks that the fetching query either has auto fields on or * has the foreignKey fields selected. - * If the required fields are missing, throws an exception. + * If the required fields are missing, automatically adds them to ensure + * entities can be properly identified and loaded. * - * @param \Cake\ORM\Query\SelectQuery $fetchQuery The association fetching query + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $fetchQuery The association fetching query * @param array $key The foreign key fields to check * @return void * @throws \InvalidArgumentException @@ -257,30 +263,21 @@ protected function _assertFieldsPresent(SelectQuery $fetchQuery, array $key): vo if (!$select) { return; } - $missingKey = function ($fieldList, $key): bool { - foreach ($key as $keyField) { - if (!in_array($keyField, $fieldList, true)) { - return true; + + $missingFields = []; + foreach ($key as $keyField) { + if (!in_array($keyField, $select, true)) { + $driver = $fetchQuery->getDriver(); + $quoted = $driver->quoteIdentifier($keyField); + if (!in_array($quoted, $select, true)) { + $missingFields[] = $keyField; } } - - return false; - }; - - $missingFields = $missingKey($select, $key); - if ($missingFields) { - $driver = $fetchQuery->getConnection()->getDriver(); - $quoted = array_map($driver->quoteIdentifier(...), $key); - $missingFields = $missingKey($select, $quoted); } + // Automatically add missing primary key fields to the query if ($missingFields) { - throw new InvalidArgumentException( - sprintf( - 'You are required to select the "%s" field(s)', - implode(', ', $key), - ), - ); + $fetchQuery->select($missingFields); } } @@ -289,10 +286,10 @@ protected function _assertFieldsPresent(SelectQuery $fetchQuery, array $key): vo * target table query given a filter key and some filtering values when the * filtering needs to be done using a subquery. * - * @param \Cake\ORM\Query\SelectQuery $query Target table's query + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Target table's query * @param array|string $key the fields that should be used for filtering - * @param \Cake\ORM\Query\SelectQuery $subquery The Subquery to use for filtering - * @return \Cake\ORM\Query\SelectQuery + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $subquery The Subquery to use for filtering + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ protected function _addFilteringJoin(SelectQuery $query, array|string $key, SelectQuery $subquery): SelectQuery { @@ -312,7 +309,7 @@ protected function _addFilteringJoin(SelectQuery $query, array|string $key, Sele $conditions = $this->_createTupleCondition($query, $key, $filter, '='); } else { $filter = current($filter); - $conditions = $query->newExpr([$key => $filter]); + $conditions = $query->expr([$key => $filter]); } return $query->innerJoin( @@ -325,10 +322,10 @@ protected function _addFilteringJoin(SelectQuery $query, array|string $key, Sele * Appends any conditions required to load the relevant set of records in the * target table query given a filter key and some filtering values. * - * @param \Cake\ORM\Query\SelectQuery $query Target table's query + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Target table's query * @param array|string $key The fields that should be used for filtering * @param mixed $filter The value that should be used to match for $key - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ protected function _addFilteringCondition(SelectQuery $query, array|string $key, mixed $filter): SelectQuery { @@ -345,7 +342,7 @@ protected function _addFilteringCondition(SelectQuery $query, array|string $key, * Returns a TupleComparison object that can be used for matching all the fields * from $keys with the tuple values in $filter using the provided operator. * - * @param \Cake\ORM\Query\SelectQuery $query Target table's query + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Target table's query * @param array $keys the fields that should be used for filtering * @param mixed $filter the value that should be used to match for $key * @param string $operator The operator for comparing the tuples @@ -407,8 +404,8 @@ protected function _linkField(array $options): array|string * target table, it is constructed by cloning the original query that was used * to load records in the source table. * - * @param \Cake\ORM\Query\SelectQuery $query the original query used to load source records - * @return \Cake\ORM\Query\SelectQuery + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the original query used to load source records + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ protected function _buildSubquery(SelectQuery $query): SelectQuery { @@ -419,11 +416,19 @@ protected function _buildSubquery(SelectQuery $query): SelectQuery $filterQuery->contain([], true); $filterQuery->setValueBinder(new ValueBinder()); - // Ignore limit if there is no order since we need all rows to find matches - if (!$filterQuery->clause('limit') || !$filterQuery->clause('order')) { + // Only remove limit and order when BOTH are missing or when order exists without limit + // When limit exists with order, preserve both for proper subquery results + $hasLimit = $filterQuery->clause('limit') !== null; + $hasOrder = $filterQuery->clause('order') !== null; + + // Remove order if there's no limit to avoid SQL grouping errors + // But preserve both when they exist together + if (!$hasLimit) { $filterQuery->limit(null); - $filterQuery->orderBy([], true); $filterQuery->offset(null); + if ($hasOrder) { + $filterQuery->orderBy([], true); + } } $fields = $this->_subqueryFields($query); @@ -439,7 +444,7 @@ protected function _buildSubquery(SelectQuery $query): SelectQuery * those columns are also included as the fields may be calculated or constant values, * that need to be present to ensure the correct association data is loaded. * - * @param \Cake\ORM\Query\SelectQuery $query The query to get fields from. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query to get fields from. * @return array The list of fields for the subquery. */ protected function _subqueryFields(SelectQuery $query): array @@ -472,7 +477,7 @@ protected function _subqueryFields(SelectQuery $query): array * Builds an array containing the results from fetchQuery indexed by * the foreignKey value corresponding to this association. * - * @param \Cake\ORM\Query\SelectQuery $fetchQuery The query to get results from + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $fetchQuery The query to get results from * @param array $options The options passed to the eager loader * @return array */ @@ -513,7 +518,7 @@ protected function _buildResultMap(SelectQuery $fetchQuery, array $options): arr * Returns a callable to be used for each row in a query result set * for injecting the eager loaded rows * - * @param \Cake\ORM\Query\SelectQuery $fetchQuery the Query used to fetch results + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $fetchQuery the Query used to fetch results * @param array $resultMap an array with the foreignKey as keys and * the corresponding target table results as value. * @param array $options The options passed to the eagerLoader method diff --git a/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectWithPivotLoader.php b/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectWithPivotLoader.php index f3d5baf11..cc64ad954 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectWithPivotLoader.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Association/Loader/SelectWithPivotLoader.php @@ -46,7 +46,7 @@ class SelectWithPivotLoader extends SelectLoader /** * The junction association instance * - * @var \Cake\ORM\Association\HasMany + * @var \Cake\ORM\Association\HasMany<\Cake\ORM\Table> */ protected HasMany $junctionAssoc; @@ -77,7 +77,7 @@ public function __construct(array $options) * This is used for eager loading records on the target table based on conditions. * * @param array $options options accepted by eagerLoader() - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> * @throws \InvalidArgumentException When a key is required for associations but not selected. */ protected function _buildQuery(array $options): SelectQuery @@ -87,6 +87,7 @@ protected function _buildQuery(array $options): SelectQuery $queryBuilder = false; if (!empty($options['queryBuilder'])) { + assert(is_callable($options['queryBuilder'])); $queryBuilder = $options['queryBuilder']; unset($options['queryBuilder']); } @@ -94,7 +95,7 @@ protected function _buildQuery(array $options): SelectQuery $query = parent::_buildQuery($options); if ($queryBuilder) { - /** @var \Cake\ORM\Query\SelectQuery $query */ + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query */ $query = $queryBuilder($query); } @@ -135,7 +136,9 @@ protected function _buildQuery(array $options): SelectQuery } /** - * @inheritDoc + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $fetchQuery The association fetching query + * @param array $key The foreign key fields to check + * @return void */ protected function _assertFieldsPresent(SelectQuery $fetchQuery, array $key): void { @@ -159,7 +162,7 @@ protected function _linkField(array $options): array|string } if (count($links) === 1) { - return $links[0]; + return array_pop($links); } return $links; @@ -169,7 +172,7 @@ protected function _linkField(array $options): array|string * Builds an array containing the results from fetchQuery indexed by * the foreignKey value corresponding to this association. * - * @param \Cake\ORM\Query\SelectQuery $fetchQuery The query to get results from + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $fetchQuery The query to get results from * @param array $options The options passed to the eager loader * @return array * @throws \Cake\Database\Exception\DatabaseException when the association property is not part of the results set. diff --git a/app/vendor/cakephp/cakephp/src/ORM/AssociationCollection.php b/app/vendor/cakephp/cakephp/src/ORM/AssociationCollection.php index 0818746ba..a286d783f 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/AssociationCollection.php +++ b/app/vendor/cakephp/cakephp/src/ORM/AssociationCollection.php @@ -171,7 +171,7 @@ public function getByType(array|string $class): array { $class = array_map('strtolower', (array)$class); - $out = array_filter($this->_items, function ($assoc) use ($class) { + $out = array_filter($this->_items, function (Association $assoc) use ($class) { [, $name] = namespaceSplit($assoc::class); return in_array(strtolower($name), $class, true); diff --git a/app/vendor/cakephp/cakephp/src/ORM/Attribute/CollectionOf.php b/app/vendor/cakephp/cakephp/src/ORM/Attribute/CollectionOf.php new file mode 100644 index 000000000..7c60dbff5 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/ORM/Attribute/CollectionOf.php @@ -0,0 +1,50 @@ + $alias) { - if (!isset($indexedCustom[$method])) { - $indexedCustom[$method] = $alias; - } + $indexedCustom[$method] ??= $alias; } $this->setConfig($key, array_flip($indexedCustom), false); unset($config[$key]); @@ -353,6 +351,7 @@ public function implementedFinders(): array * * @return array * @throws \ReflectionException + * @deprecated 5.3.0 Calling behavior methods on the table instance is deprecated. */ public function implementedMethods(): array { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/CounterCacheBehavior.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/CounterCacheBehavior.php index 67464821b..811eb819b 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/CounterCacheBehavior.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/CounterCacheBehavior.php @@ -213,13 +213,13 @@ public function updateCounterCache(?string $assocName = null, int $limit = 100, } foreach ($config as $assoc => $settings) { - /** @var \Cake\ORM\Association\BelongsTo $belongsTo */ + /** @var \Cake\ORM\Association\BelongsTo<\Cake\ORM\Table> $belongsTo */ $belongsTo = $this->_table->getAssociation($assoc); foreach ($settings as $field => $config) { if ($config instanceof Closure) { - // Cannot update counter cache which use a closure - return; + // Skip counter cache fields that use a closure + continue; } if (is_int($field)) { @@ -235,7 +235,7 @@ public function updateCounterCache(?string $assocName = null, int $limit = 100, /** * Update counter cache for the given association. * - * @param \Cake\ORM\Association\BelongsTo $assoc The association object. + * @param \Cake\ORM\Association\BelongsTo<\Cake\ORM\Table> $assoc The association object. * @param string $field Counter cache field. * @param array $config Config array. * @param int $limit Limit. @@ -347,7 +347,7 @@ protected function _processAssociation( if ( isset($this->_ignoreDirty[$assoc->getTarget()->getRegistryAlias()][$field]) && - $this->_ignoreDirty[$assoc->getTarget()->getRegistryAlias()][$field] === true + $this->_ignoreDirty[$assoc->getTarget()->getRegistryAlias()][$field] ) { continue; } @@ -394,7 +394,7 @@ protected function _shouldUpdateCount(array $conditions): bool * * @param array $config The counter cache configuration for a single field * @param array $conditions Additional conditions given to the query - * @return \Cake\ORM\Query\SelectQuery|int The query to fetch the number of + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array>|int The query to fetch the number of * relations matching the given config and conditions or the number itself. */ protected function _getCount(array $config, array $conditions): SelectQuery|int diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/TimestampBehavior.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/TimestampBehavior.php index 99932bae5..24e99314b 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/TimestampBehavior.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/TimestampBehavior.php @@ -40,7 +40,7 @@ class TimestampBehavior extends Behavior * the field value always, only when a new record or only when an existing record. * * refreshTimestamp - if true (the default) the timestamp used will be the current time when - * the code is executed, to set to an explicit date time value - set refreshTimetamp to false + * the code is executed, to set to an explicit date time value - set refreshTimestamp to false * and call setTimestamp() on the behavior class before use. * * @var array diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/EavStrategy.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/EavStrategy.php index cc357d978..73023bd9c 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/EavStrategy.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/EavStrategy.php @@ -25,7 +25,6 @@ use Cake\ORM\Locator\LocatorAwareTrait; use Cake\ORM\Query\SelectQuery; use Cake\ORM\Table; -use Cake\Utility\Hash; /** * This class provides a way to translate dynamic data by keeping translations @@ -167,13 +166,13 @@ protected function setupAssociations(): void * and adding a formatter to copy the values into the main table records. * * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event The beforeFind event that was fired. - * @param \Cake\ORM\Query\SelectQuery $query Query + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Query * @param \ArrayObject $options The options for the query * @return void */ public function beforeFind(EventInterface $event, SelectQuery $query, ArrayObject $options): void { - $locale = Hash::get($options, 'locale', $this->getLocale()); + $locale = $options['locale'] ?? $this->getLocale(); if ($locale === $this->getConfig('defaultLocale')) { return; @@ -225,7 +224,7 @@ public function beforeFind(EventInterface $event, SelectQuery $query, ArrayObjec $query->contain($contain); $query->formatResults( fn(CollectionInterface $results) => $this->rowMapper($results, $locale), - $query::PREPEND, + SelectQuery::PREPEND, ); } @@ -252,6 +251,7 @@ public function beforeSave(EventInterface $event, EntityInterface $entity, Array } $this->bundleTranslatedFields($entity); + /** @var array $bundled */ $bundled = $entity->has('_i18n') ? $entity->get('_i18n') : []; $noBundled = count($bundled) === 0; @@ -361,9 +361,9 @@ public function translationField(string $field): string * Modifies the results from a table find in order to merge the translated fields * into each entity for a given locale. * - * @param \Cake\Collection\CollectionInterface $results Results to map. + * @param \Cake\Collection\CollectionInterface $results Results to map. * @param string $locale Locale string - * @return \Cake\Collection\CollectionInterface + * @return \Cake\Collection\CollectionInterface */ protected function rowMapper(CollectionInterface $results, string $locale): CollectionInterface { @@ -410,8 +410,8 @@ protected function rowMapper(CollectionInterface $results, string $locale): Coll * Modifies the results from a table find in order to merge full translation * records into each entity under the `_translations` key. * - * @param \Cake\Collection\CollectionInterface $results Results to modify. - * @return \Cake\Collection\CollectionInterface + * @param \Cake\Collection\CollectionInterface $results Results to modify. + * @return \Cake\Collection\CollectionInterface */ public function groupTranslations(CollectionInterface $results): CollectionInterface { @@ -479,6 +479,7 @@ protected function bundleTranslatedFields(EntityInterface $entity): void $key = $entity->get((string)current($primaryKey)); } $find = []; + /** @var array<\Cake\Datasource\EntityInterface> $contents */ $contents = []; $entityClass = $this->translationTable->getEntityClass(); diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/ShadowTableStrategy.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/ShadowTableStrategy.php index 4d7873785..b63ff19f0 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/ShadowTableStrategy.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/ShadowTableStrategy.php @@ -27,7 +27,6 @@ use Cake\ORM\Marshaller; use Cake\ORM\Query\SelectQuery; use Cake\ORM\Table; -use Cake\Utility\Hash; use function Cake\Core\pluginSplit; /** @@ -125,13 +124,13 @@ protected function setupAssociations(): void * and adding a formatter to copy the values into the main table records. * * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event The beforeFind event that was fired. - * @param \Cake\ORM\Query\SelectQuery $query Query. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Query. * @param \ArrayObject $options The options for the query. * @return void */ public function beforeFind(EventInterface $event, SelectQuery $query, ArrayObject $options): void { - $locale = Hash::get($options, 'locale', $this->getLocale()); + $locale = $options['locale'] ?? $this->getLocale(); $config = $this->getConfig(); if ($locale === $config['defaultLocale']) { @@ -155,7 +154,7 @@ public function beforeFind(EventInterface $event, SelectQuery $query, ArrayObjec $query->formatResults( fn(CollectionInterface $results) => $this->rowMapper($results, $locale), - $query::PREPEND, + SelectQuery::PREPEND, ); } @@ -213,7 +212,7 @@ protected function setupHasOneAssociation(string $locale, ArrayObject $options): * Only add translations for fields that are in the main table, always * add the locale field though. * - * @param \Cake\ORM\Query\SelectQuery $query The query to check. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query to check. * @param array $config The config to use for adding fields. * @return bool Whether a join to the translation table is required. */ @@ -223,9 +222,7 @@ protected function addFieldsToQuery(SelectQuery $query, array $config): bool return true; } - $select = array_filter($query->clause('select'), function ($field) { - return is_string($field); - }); + $select = array_filter($query->clause('select'), is_string(...)); if (!$select) { return true; @@ -254,7 +251,7 @@ protected function addFieldsToQuery(SelectQuery $query, array $config): bool * prefixing fields with the appropriate table alias. This method currently * expects to receive an order clause only. * - * @param \Cake\ORM\Query\SelectQuery $query the query to check. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query to check. * @param string $name The clause name. * @param array $config The config to use for adding fields. * @return bool Whether a join to the translation table is required. @@ -300,7 +297,7 @@ function ($c, &$field) use ($fields, $alias, $mainTableAlias, $mainTableFields, * prefixing fields with the appropriate table alias. This method currently * expects to receive a where clause only. * - * @param \Cake\ORM\Query\SelectQuery $query the query to check. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query the query to check. * @param string $name The clause name. * @param array $config The config to use for adding fields. * @return bool Whether a join to the translation table is required. @@ -369,7 +366,7 @@ public function beforeSave(EventInterface $event, EntityInterface $entity, Array $this->bundleTranslatedFields($entity); $bundled = $entity->has('_i18n') ? (array)$entity->get('_i18n') : []; - $noBundled = count($bundled) === 0; + $noBundled = $bundled === []; // No additional translation records need to be saved, // as the entity is in the default locale. @@ -482,15 +479,16 @@ public function translationField(string $field): string * Modifies the results from a table find in order to merge the translated * fields into each entity for a given locale. * - * @param \Cake\Collection\CollectionInterface $results Results to map. + * @param \Cake\Collection\CollectionInterface $results Results to map. * @param string $locale Locale string - * @return \Cake\Collection\CollectionInterface + * @return \Cake\Collection\CollectionInterface */ protected function rowMapper(CollectionInterface $results, string $locale): CollectionInterface { $allowEmpty = $this->_config['allowEmptyTranslations']; return $results->map(function ($row) use ($allowEmpty, $locale) { + /** @var \Cake\Datasource\EntityInterface|array|null $row */ if ($row === null) { return $row; } @@ -535,7 +533,6 @@ protected function rowMapper(CollectionInterface $results, string $locale): Coll } } - /** @var array $row */ unset($row['translation']); if ($hydrated) { @@ -551,8 +548,8 @@ protected function rowMapper(CollectionInterface $results, string $locale): Coll * Modifies the results from a table find in order to merge full translation * records into each entity under the `_translations` key. * - * @param \Cake\Collection\CollectionInterface $results Results to modify. - * @return \Cake\Collection\CollectionInterface + * @param \Cake\Collection\CollectionInterface $results Results to modify. + * @return \Cake\Collection\CollectionInterface */ public function groupTranslations(CollectionInterface $results): CollectionInterface { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyInterface.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyInterface.php index 7d36e11ff..aaf9aa4f5 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyInterface.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyInterface.php @@ -80,8 +80,8 @@ public function translationField(string $field): string; * Modifies the results from a table find in order to merge full translation records * into each entity under the `_translations` key * - * @param \Cake\Datasource\ResultSetInterface<\Cake\Datasource\EntityInterface|array> $results Results to modify. - * @return \Cake\Collection\CollectionInterface + * @param \Cake\Datasource\ResultSetInterface $results Results to modify. + * @return \Cake\Collection\CollectionInterface */ public function groupTranslations(ResultSetInterface $results): CollectionInterface; @@ -91,7 +91,7 @@ public function groupTranslations(ResultSetInterface $results): CollectionInterf * and adding a formatter to copy the values into the main table records. * * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event The beforeFind event that was fired. - * @param \Cake\ORM\Query\SelectQuery $query Query + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Query * @param \ArrayObject $options The options for the query * @return void */ diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyTrait.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyTrait.php index 197da6400..e381affcb 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyTrait.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateStrategyTrait.php @@ -24,6 +24,8 @@ /** * Contains common code needed by TranslateBehavior strategy classes. + * + * @require-implements \Cake\ORM\Behavior\Translate\TranslateStrategyInterface */ trait TranslateStrategyTrait { @@ -144,10 +146,10 @@ protected function unsetEmptyFields(EntityInterface $entity): void * of translations by setting `'translations' => false` in the options * provided to `Table::newEntity()` or `Table::patchEntity()`. * - * @param \Cake\ORM\Marshaller $marshaller The marshaler of the table the behavior is attached to. - * @param array $map The property map being built. + * @param \Cake\ORM\Marshaller<\Cake\Datasource\EntityInterface> $marshaller The marshaler of the table the behavior is attached to. + * @param array $map The property map being built. * @param array $options The options array used in the marshaling call. - * @return array A map of `[property => callable]` of additional properties to marshal. + * @return array A map of `[property => callable]` of additional properties to marshal. */ public function buildMarshalMap(Marshaller $marshaller, array $map, array $options): array { @@ -167,9 +169,7 @@ public function buildMarshalMap(Marshaller $marshaller, array $map, array $optio $options['validate'] = $this->_config['validator']; $errors = []; foreach ($value as $language => $fields) { - if (!isset($translations[$language])) { - $translations[$language] = $this->table->newEmptyEntity(); - } + $translations[$language] ??= $this->table->newEmptyEntity(); $marshaller->merge($translations[$language], $fields, $options); $translationErrors = $translations[$language]->getErrors(); diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateTrait.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateTrait.php index 69f25cc7a..2e5002956 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateTrait.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/Translate/TranslateTrait.php @@ -21,6 +21,8 @@ /** * Contains a translation method aimed to help managing multiple translations * for an entity. + * + * @require-implements \Cake\Datasource\EntityInterface */ trait TranslateTrait { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/TranslateBehavior.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/TranslateBehavior.php index 8b930c168..c1950963c 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/TranslateBehavior.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/TranslateBehavior.php @@ -166,11 +166,7 @@ public static function getDefaultStrategyClass(): string */ public function getStrategy(): TranslateStrategyInterface { - if ($this->strategy !== null) { - return $this->strategy; - } - - return $this->strategy = $this->createStrategy(); + return $this->strategy ??= $this->createStrategy(); } /** @@ -227,9 +223,9 @@ public function implementedEvents(): array * This allows `_translations.{locale}.field_name` type naming even for the * default locale in forms. * - * @param \Cake\Event\EventInterface $event - * @param \ArrayObject $data - * @param \ArrayObject $options + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event The event that was fired. + * @param \ArrayObject $data The data being marshalled. + * @param \ArrayObject $options The options for marshalling. * @return void */ public function beforeMarshal(EventInterface $event, ArrayObject $data, ArrayObject $options): void @@ -257,10 +253,10 @@ public function beforeMarshal(EventInterface $event, ArrayObject $data, ArrayObj * of translations by setting `'translations' => false` in the options * provided to `Table::newEntity()` or `Table::patchEntity()`. * - * @param \Cake\ORM\Marshaller $marshaller The marshaler of the table the behavior is attached to. - * @param array $map The property map being built. + * @param \Cake\ORM\Marshaller<\Cake\Datasource\EntityInterface> $marshaller The marshaler of the table the behavior is attached to. + * @param array $map The property map being built. * @param array $options The options array used in the marshaling call. - * @return array A map of `[property => callable]` of additional properties to marshal. + * @return array A map of `[property => callable]` of additional properties to marshal. */ public function buildMarshalMap(Marshaller $marshaller, array $map, array $options): array { @@ -284,7 +280,7 @@ public function buildMarshalMap(Marshaller $marshaller, array $map, array $optio * globally configured locale. * @return $this * @see \Cake\ORM\Behavior\TranslateBehavior::getLocale() - * @link https://book.cakephp.org/5/en/orm/behaviors/translate.html#retrieving-one-language-without-using-i18n-locale + * @link https://book.cakephp.org/5/en/orm/behaviors/translate.html#retrieving-one-language-without-using-i18n-setlocale * @link https://book.cakephp.org/5/en/orm/behaviors/translate.html#saving-in-another-language */ public function setLocale(?string $locale) @@ -342,9 +338,9 @@ public function translationField(string $field): string * If the `locales` array is not passed, it will bring all translations found * for each record. * - * @param \Cake\ORM\Query\SelectQuery $query The original query to modify + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The original query to modify * @param array $locales A list of locales or options with the `locales` key defined - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ public function findTranslations(SelectQuery $query, array $locales = []): SelectQuery { @@ -358,7 +354,7 @@ public function findTranslations(SelectQuery $query, array $locales = []): Selec return $query; }]) - ->formatResults($this->getStrategy()->groupTranslations(...), $query::PREPEND); + ->formatResults($this->getStrategy()->groupTranslations(...), SelectQuery::PREPEND); } /** @@ -370,7 +366,7 @@ public function findTranslations(SelectQuery $query, array $locales = []): Selec */ public function __call(string $method, array $args): mixed { - return $this->strategy->{$method}(...$args); + return $this->getStrategy()->{$method}(...$args); } /** @@ -387,7 +383,7 @@ public function __call(string $method, array $args): mixed protected function referenceName(Table $table): string { $name = namespaceSplit($table::class); - $name = substr((string)end($name), 0, -5); + $name = substr(end($name), 0, -5); if (!$name) { $name = $table->getTable() ?: $table->getAlias(); $name = Inflector::camelize($name); diff --git a/app/vendor/cakephp/cakephp/src/ORM/Behavior/TreeBehavior.php b/app/vendor/cakephp/cakephp/src/ORM/Behavior/TreeBehavior.php index c489af000..2a9ffde9b 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Behavior/TreeBehavior.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Behavior/TreeBehavior.php @@ -234,6 +234,7 @@ public function beforeDelete(EventInterface $event, EntityInterface $entity): vo if ($diff > 2) { if ($this->getConfig('cascadeCallbacks')) { + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface> $query */ $query = $this->_scope($this->_table->query()) ->where( fn(QueryExpression $exp) => $exp @@ -384,18 +385,16 @@ function (QueryExpression $exp) use ($config) { * to a specific node in the tree. This custom finder requires that the key 'for' * is passed in the options containing the id of the node to get its path for. * - * @param \Cake\ORM\Query\SelectQuery $query The constructed query to modify + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The constructed query to modify * @param string|int $for The path to find or an array of options with `for`. - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> * @throws \InvalidArgumentException If the 'for' key is missing in options */ public function findPath(SelectQuery $query, string|int $for): SelectQuery { $config = $this->getConfig(); [$left, $right] = array_map( - function ($field) { - return $this->_table->aliasField($field); - }, + $this->_table->aliasField(...), [$config['left'], $config['right']], ); @@ -439,19 +438,17 @@ public function childCount(EntityInterface $node, bool $direct = false): int * If the direct option is set to true, only the direct children are returned * (based upon the parent_id field). * - * @param \Cake\ORM\Query\SelectQuery $query Query. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Query. * @param string|int $for The id of the record to read. Can also be an array of options. * @param bool $direct Whether to return only the direct (true) or all children (false). - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> * @throws \InvalidArgumentException When the 'for' key is not passed in $options */ public function findChildren(SelectQuery $query, int|string $for, bool $direct = false): SelectQuery { $config = $this->getConfig(); [$parent, $left, $right] = array_map( - function ($field) { - return $this->_table->aliasField($field); - }, + $this->_table->aliasField(...), [$config['parent'], $config['left'], $config['right']], ); @@ -477,13 +474,13 @@ function ($field) { * the primary key for the table and the values are the display field for the table. * Values are prefixed to visually indicate relative depth in the tree. * - * @param \Cake\ORM\Query\SelectQuery $query Query. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query Query. * @param \Closure|string|null $keyPath A dot separated path to fetch the field to use for the array key, or a closure to * return the key out of the provided row. * @param \Closure|string|null $valuePath A dot separated path to fetch the field to use for the array value, or a closure to * return the value out of the provided row. * @param string|null $spacer A string to be used as prefix for denoting the depth in the tree for each item. - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ public function findTreeList( SelectQuery $query, @@ -504,13 +501,13 @@ public function findTreeList( * and the values are the display field for the table. Values are prefixed to visually * indicate relative depth in the tree. * - * @param \Cake\ORM\Query\SelectQuery $query The query object to format. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query object to format. * @param \Closure|string|null $keyPath A dot separated path to the field that will be the result array key, or a closure to * return the key from the provided row. * @param \Closure|string|null $valuePath A dot separated path to the field that is the array's value, or a closure to * return the value from the provided row. * @param string|null $spacer A string to be used as prefix for denoting the depth in the tree for each item. - * @return \Cake\ORM\Query\SelectQuery Augmented query. + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> Augmented query. */ public function formatTreeList( SelectQuery $query, @@ -567,7 +564,7 @@ protected function _removeFromTree(EntityInterface $node): EntityInterface|false $right = $node->get($config['right']); $parent = $node->get($config['parent']); - $node->set($config['parent'], null); + $node->set($config['parent']); if ($right - $left === 1) { return $this->_table->save($node); @@ -605,7 +602,7 @@ protected function _removeFromTree(EntityInterface $node): EntityInterface|false * @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found * @return \Cake\Datasource\EntityInterface|false $node The node after being moved or false if `$number` is < 1 */ - public function moveUp(EntityInterface $node, int|bool $number = 1): EntityInterface|false + public function moveUp(EntityInterface $node, int|true $number = 1): EntityInterface|false { if ($number < 1) { return false; @@ -626,7 +623,7 @@ public function moveUp(EntityInterface $node, int|bool $number = 1): EntityInter * @return \Cake\Datasource\EntityInterface $node The node after being moved * @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found */ - protected function _moveUp(EntityInterface $node, int|bool $number): EntityInterface + protected function _moveUp(EntityInterface $node, int|true $number): EntityInterface { $config = $this->getConfig(); [$parent, $left, $right] = [$config['parent'], $config['left'], $config['right']]; @@ -693,7 +690,7 @@ protected function _moveUp(EntityInterface $node, int|bool $number): EntityInter * @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found * @return \Cake\Datasource\EntityInterface|false the entity after being moved or false if `$number` is < 1 */ - public function moveDown(EntityInterface $node, int|bool $number = 1): EntityInterface|false + public function moveDown(EntityInterface $node, int|true $number = 1): EntityInterface|false { if ($number < 1) { return false; @@ -714,7 +711,7 @@ public function moveDown(EntityInterface $node, int|bool $number = 1): EntityInt * @return \Cake\Datasource\EntityInterface $node The node after being moved * @throws \Cake\Datasource\Exception\RecordNotFoundException When node was not found */ - protected function _moveDown(EntityInterface $node, int|bool $number): EntityInterface + protected function _moveDown(EntityInterface $node, int|true $number): EntityInterface { $config = $this->getConfig(); [$parent, $left, $right] = [$config['parent'], $config['left'], $config['right']]; @@ -791,7 +788,7 @@ protected function _getNode(mixed $id): EntityInterface ->where([$this->_table->aliasField($primaryKey) => $id]) ->first(); - if (!$node) { + if (!$node instanceof EntityInterface) { throw new RecordNotFoundException(sprintf('Node `%s` was not found in the tree.', $id)); } @@ -891,7 +888,7 @@ protected function _sync(int $shift, string $dir, string $conditions, bool $mark /** @var \Cake\Database\Expression\IdentifierExpression $field */ foreach ([$config['leftField'], $config['rightField']] as $field) { $query = $this->_scope($this->_table->updateQuery()); - $exp = $query->newExpr(); + $exp = $query->expr(); $movement = clone $exp; $movement->add($field)->add((string)$shift)->setConjunction($dir); @@ -915,11 +912,9 @@ protected function _sync(int $shift, string $dir, string $conditions, bool $mark * Alters the passed query so that it only returns scoped records as defined * in the tree configuration. * - * @param \Cake\ORM\Query\SelectQuery|\Cake\ORM\Query\UpdateQuery|\Cake\ORM\Query\DeleteQuery $query the Query to modify - * @return \Cake\ORM\Query\SelectQuery|\Cake\ORM\Query\UpdateQuery|\Cake\ORM\Query\DeleteQuery - * @template T of \Cake\ORM\Query\SelectQuery|\Cake\ORM\Query\UpdateQuery|\Cake\ORM\Query\DeleteQuery - * @phpstan-param T $query - * @phpstan-return T + * @template TQuery of \Cake\ORM\Query\SelectQuery|\Cake\ORM\Query\UpdateQuery|\Cake\ORM\Query\DeleteQuery + * @param TQuery $query the Query to modify + * @return TQuery */ protected function _scope(SelectQuery|UpdateQuery|DeleteQuery $query): SelectQuery|UpdateQuery|DeleteQuery { @@ -949,6 +944,7 @@ protected function _ensureFields(EntityInterface $entity): void } $fresh = $this->_table->get($entity->get($this->_getPrimaryKey())); + // @phpstan-ignore function.alreadyNarrowedType (patch method available on EntityInterface) if (method_exists($entity, 'patch')) { $entity->patch($fresh->extract($fields), ['guard' => false]); } else { diff --git a/app/vendor/cakephp/cakephp/src/ORM/BehaviorRegistry.php b/app/vendor/cakephp/cakephp/src/ORM/BehaviorRegistry.php index fe0c7c716..b32c93fc2 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/BehaviorRegistry.php +++ b/app/vendor/cakephp/cakephp/src/ORM/BehaviorRegistry.php @@ -24,6 +24,7 @@ use Cake\ORM\Exception\MissingBehaviorException; use Cake\ORM\Query\SelectQuery; use LogicException; +use function Cake\Core\deprecationWarning; /** * BehaviorRegistry is used as a registry for loaded behaviors and handles loading @@ -262,6 +263,7 @@ public function unload(string $name) * * @param string $method The method to check for. * @return bool + * @deprecated 5.3.0 Calling behavior methods on the table instance is deprecated. */ public function hasMethod(string $method): bool { @@ -293,9 +295,19 @@ public function hasFinder(string $method): bool * @param array $args The arguments you want to invoke the method with. * @return mixed The return value depends on the underlying behavior method. * @throws \BadMethodCallException When the method is unknown. + * @deprecated 5.3.0 Calling behavior methods on the table instance is deprecated. */ public function call(string $method, array $args = []): mixed { + deprecationWarning( + '5.3.0', + sprintf( + 'Calling behavior methods on the table instance is deprecated.' + . ' Use `$table->getBehavior(\'YourBehavior\')->%s()` instead.', + $method, + ), + ); + $method = strtolower($method); if ($this->hasMethod($method) && $this->has($this->_methodMap[$method][0])) { [$behavior, $callMethod] = $this->_methodMap[$method]; @@ -325,6 +337,7 @@ public function callFinder(string $type, SelectQuery $query, mixed ...$args): Se if ($this->hasFinder($type)) { [$behavior, $callMethod] = $this->_finderMap[$type]; + /** @var \Closure $callable */ $callable = $this->_loaded[$behavior]->$callMethod(...); return $this->_table->invokeFinder($callable, $query, $args); diff --git a/app/vendor/cakephp/cakephp/src/ORM/DtoMapper.php b/app/vendor/cakephp/cakephp/src/ORM/DtoMapper.php new file mode 100644 index 000000000..e3f18ba32 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/ORM/DtoMapper.php @@ -0,0 +1,192 @@ +Users->find() + * ->contain(['Roles', 'Comments']) + * ->projectAs(UserDto::class) + * ->all(); + * ``` + */ +class DtoMapper +{ + /** + * Cached reflection info per class. + * + * @var array}> + */ + protected static array $cache = []; + + /** + * Map array data to a DTO instance. + * + * @template T of object + * @param array $data The source data (typically from ORM) + * @param class-string $dtoClass The target DTO class + * @return T + */ + public function map(array $data, string $dtoClass): object + { + $info = $this->getClassInfo($dtoClass); + + $args = []; + foreach ($info['params'] as $name => $paramInfo) { + // isset() is faster than array_key_exists(), check for null separately + if (isset($data[$name])) { + $value = $data[$name]; + + // Handle nested DTO (type hint is a class) - only map arrays, pass objects through + if ($paramInfo['dtoClass'] !== null && is_array($value)) { + $value = $this->map($value, $paramInfo['dtoClass']); + } elseif ($paramInfo['collectionOf'] !== null) { + // Handle collection - inline loop avoids closure creation overhead + $collectionClass = $paramInfo['collectionOf']; + $mapped = []; + foreach ($value as $item) { + $mapped[] = is_array($item) ? $this->map($item, $collectionClass) : $item; + } + $value = $mapped; + } + + $args[$name] = $value; + } elseif (array_key_exists($name, $data)) { + // Value is explicitly null in data + $args[$name] = null; + } elseif ($paramInfo['hasDefault']) { + $args[$name] = $paramInfo['default']; + } elseif ($paramInfo['nullable']) { + $args[$name] = null; + } + // If required and not provided, let PHP throw the error + } + + return new $dtoClass(...$args); + } + + /** + * Get cached class info via reflection. + * + * @param class-string $class The class to analyze + * @return array{params: array} + */ + protected function getClassInfo(string $class): array + { + if (isset(static::$cache[$class])) { + return static::$cache[$class]; + } + + $reflection = new ReflectionClass($class); + $constructor = $reflection->getConstructor(); + + $params = []; + if ($constructor !== null) { + foreach ($constructor->getParameters() as $param) { + $params[$param->getName()] = $this->analyzeParameter($param); + } + } + + static::$cache[$class] = ['params' => $params]; + + return static::$cache[$class]; + } + + /** + * Analyze a constructor parameter for DTO mapping info. + * + * @param \ReflectionParameter $param The parameter to analyze + * @return array{name: string, nullable: bool, hasDefault: bool, default: mixed, dtoClass: class-string|null, collectionOf: class-string|null} + */ + protected function analyzeParameter(ReflectionParameter $param): array + { + $type = $param->getType(); + + $info = [ + 'name' => $param->getName(), + 'nullable' => $param->allowsNull(), + 'hasDefault' => $param->isDefaultValueAvailable(), + 'default' => $param->isDefaultValueAvailable() ? $param->getDefaultValue() : null, + 'dtoClass' => null, + 'collectionOf' => null, + ]; + + // Check if type is a class (potential nested DTO) + if ($type instanceof ReflectionNamedType && !$type->isBuiltin()) { + $typeName = $type->getName(); + // Exclude common non-DTO classes + if ( + !in_array($typeName, ['DateTime', 'DateTimeImmutable', 'DateTimeInterface', 'stdClass'], true) + && class_exists($typeName) + ) { + $info['dtoClass'] = $typeName; + } + } + + // Check for #[CollectionOf(SomeDto::class)] attribute + foreach ($param->getAttributes(CollectionOf::class) as $attr) { + /** @var class-string $collectionClass */ + $collectionClass = $attr->getArguments()[0]; + $info['collectionOf'] = $collectionClass; + $info['dtoClass'] = null; // Collection takes precedence + } + + return $info; + } + + /** + * Clear the reflection cache. + * + * Useful for testing or when classes are reloaded. + * + * @return void + */ + public static function clearCache(): void + { + static::$cache = []; + } +} diff --git a/app/vendor/cakephp/cakephp/src/ORM/EagerLoadable.php b/app/vendor/cakephp/cakephp/src/ORM/EagerLoadable.php index 80636dfad..65e455128 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/EagerLoadable.php +++ b/app/vendor/cakephp/cakephp/src/ORM/EagerLoadable.php @@ -38,7 +38,7 @@ class EagerLoadable /** * A list of other associations to load from this level. * - * @var array<\Cake\ORM\EagerLoadable> + * @var array */ protected array $_associations = []; @@ -159,7 +159,7 @@ public function addAssociation(string $name, EagerLoadable $association): void /** * Returns the Association class instance to use for loading the records. * - * @return array<\Cake\ORM\EagerLoadable> + * @return array */ public function associations(): array { @@ -316,8 +316,6 @@ public function asContainArray(): array /** * Handles cloning eager loadables. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/ORM/EagerLoader.php b/app/vendor/cakephp/cakephp/src/ORM/EagerLoader.php index 665483fe9..b035d6f97 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/EagerLoader.php +++ b/app/vendor/cakephp/cakephp/src/ORM/EagerLoader.php @@ -32,7 +32,7 @@ class EagerLoader * Nested array describing the association to be fetched * and the options to apply for each of them, if any * - * @var array + * @var array */ protected array $_containments = []; @@ -40,9 +40,9 @@ class EagerLoader * Contains a nested array with the compiled containments tree * This is a normalized version of the user provided containments array. * - * @var \Cake\ORM\EagerLoadable|array<\Cake\ORM\EagerLoadable>|null + * @var array|null */ - protected EagerLoadable|array|null $_normalized = null; + protected ?array $_normalized = null; /** * List of options accepted by associations in contain() @@ -68,14 +68,14 @@ class EagerLoader /** * A list of associations that should be loaded with a separate query. * - * @var array<\Cake\ORM\EagerLoadable> + * @var array */ protected array $_loadExternal = []; /** * Contains a list of the association names that are to be eagerly loaded. * - * @var array + * @var array>> */ protected array $_aliasList = []; @@ -255,7 +255,7 @@ public function setMatching(string $associationPath, ?Closure $builder = null, a } // Add all options to target association contain which is the last in nested chain - $nested = ['matching' => true, 'queryBuilder' => $builder] + $options; + $nested = ['matching' => true, 'queryBuilder' => $builder ?? fn($q) => $q] + $options; $this->_matching->contain($contains); return $this; @@ -287,25 +287,21 @@ public function getMatching(): array * * @param \Cake\ORM\Table $repository The table containing the association that * will be normalized. - * @return array + * @return array */ public function normalized(Table $repository): array { - if ($this->_normalized !== null || $this->_containments === []) { - return (array)$this->_normalized; + if ($this->_normalized !== null) { + return $this->_normalized; } $contain = []; foreach ($this->_containments as $alias => $options) { - if (!empty($options['instance'])) { - $contain = $this->_containments; - break; - } $contain[$alias] = $this->_normalizeContain( $repository, $alias, $options, - ['root' => null], + ['root' => ''], ); } @@ -320,7 +316,7 @@ public function normalized(Table $repository): array * @param array $associations User provided containments array. * @param array $original The original containments array to merge * with the new one. - * @return array + * @return array */ protected function _reformatContain(array $associations, array $original): array { @@ -354,13 +350,22 @@ protected function _reformatContain(array $associations, array $original): array } if (is_array($options)) { - $options = isset($options['config']) ? - $options['config'] + $options['associations'] : - $options; - $options = $this->_reformatContain( - $options, - $pointer[$table] ?? [], - ); + // When options come from asContainArray(), they have 'config' and 'associations' keys + // We need to keep them separate to avoid config options being treated as associations + if (isset($options['config'], $options['associations'])) { + // Process associations recursively, but keep config separate + $associations = $this->_reformatContain( + $options['associations'], + $pointer[$table] ?? [], + ); + // Merge config with associations, ensuring config options stay as options + $options = $options['config'] + $associations; + } else { + $options = $this->_reformatContain( + $options, + $pointer[$table] ?? [], + ); + } } if ($options instanceof Closure) { @@ -370,12 +375,14 @@ protected function _reformatContain(array $associations, array $original): array $pointer += [$table => []]; if (isset($options['queryBuilder'], $pointer[$table]['queryBuilder'])) { + assert(is_callable($pointer[$table]['queryBuilder'])); $first = $pointer[$table]['queryBuilder']; + assert(is_callable($options['queryBuilder'])); $second = $options['queryBuilder']; $options['queryBuilder'] = fn($query) => $second($first($query)); } - if (!is_array($options)) { + if (is_string($options)) { $options = [$options => []]; } @@ -391,7 +398,7 @@ protected function _reformatContain(array $associations, array $original): array * This method will not modify the query for loading external associations, i.e. * those that cannot be loaded without executing a separate query. * - * @param \Cake\ORM\Query\SelectQuery $query The query to be modified. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query to be modified. * @param \Cake\ORM\Table $repository The repository containing the associations * @param bool $includeFields whether to append all fields from the associations * to the passed query. This can be overridden according to the settings defined @@ -429,7 +436,7 @@ public function attachAssociations(SelectQuery $query, Table $repository, bool $ * * @param \Cake\ORM\Table $repository The table containing the associations to be * attached. - * @return array<\Cake\ORM\EagerLoadable> + * @return array */ public function attachableAssociations(Table $repository): array { @@ -538,7 +545,6 @@ protected function _fixStrategies(): void continue; } foreach ($configs as $loadable) { - assert($loadable instanceof EagerLoadable); if (str_contains($loadable->aliasPath(), '.')) { $this->_correctStrategy($loadable); } @@ -572,22 +578,22 @@ protected function _correctStrategy(EagerLoadable $loadable): void * Helper function used to compile a list of all associations that can be * joined in the query. * - * @param array<\Cake\ORM\EagerLoadable> $associations List of associations from which to obtain joins. - * @param array<\Cake\ORM\EagerLoadable> $matching List of associations that should be forcibly joined. - * @return array<\Cake\ORM\EagerLoadable> + * @param array $associations List of associations from which to obtain joins. + * @param array $matching List of associations that should be forcibly joined. + * @return array */ protected function _resolveJoins(array $associations, array $matching = []): array { $result = []; foreach ($matching as $table => $loadable) { $result[$table] = $loadable; - $result += $this->_resolveJoins($loadable->associations(), []); + $result = $this->mergeJoins($result, $this->_resolveJoins($loadable->associations(), [])); } foreach ($associations as $table => $loadable) { $inMatching = isset($matching[$table]); if (!$inMatching && $loadable->canBeJoined()) { $result[$table] = $loadable; - $result += $this->_resolveJoins($loadable->associations(), []); + $result = $this->mergeJoins($result, $this->_resolveJoins($loadable->associations(), [])); continue; } @@ -602,10 +608,33 @@ protected function _resolveJoins(array $associations, array $matching = []): arr return $result; } + /** + * Merges association joins and throws an exception if there are conflicts. + * + * @param array $a + * @param array $b + * @return array + */ + private function mergeJoins(array $a, array $b): array + { + foreach ($b as $alias => $loadable) { + if (isset($a[$alias])) { + assert(false, sprintf( + 'You cannot join with `%s` because it conflicts with the existing `%s` join.' + . ' The existing join will be lost.', + $loadable->aliasPath(), + $a[$alias]->aliasPath(), + )); + } + } + + return $a + $b; + } + /** * Inject data from associations that cannot be joined directly. * - * @param \Cake\ORM\Query\SelectQuery $query The query for which to eager load external. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query for which to eager load external. * associations. * @param iterable $results Results. * @return iterable @@ -771,7 +800,7 @@ public function addToJoinsMap( * to eagerly load associations. * * @param array<\Cake\ORM\EagerLoadable> $external The list of external associations to be loaded. - * @param \Cake\ORM\Query\SelectQuery $query The query from which the results where generated. + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query from which the results where generated. * @param array $results Results array. * @return array */ @@ -848,8 +877,6 @@ protected function _groupKeys(array $results, array $collectKeys): array /** * Handles cloning eager loaders and eager loadables. - * - * @return void */ public function __clone() { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Entity.php b/app/vendor/cakephp/cakephp/src/ORM/Entity.php index 48c55fac1..bd5de5494 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Entity.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Entity.php @@ -32,7 +32,7 @@ class Entity implements EntityInterface, InvalidPropertyInterface * Initializes the internal properties of this entity out of the * keys in an array. The following list of options can be used: * - * - useSetters: whether use internal setters for properties or not + * - useSetters: whether to use internal setters for properties or not * - markClean: whether to mark all properties as clean after setting them * - markNew: whether this instance has not yet been persisted * - guard: whether to prevent inaccessible properties from being set (default: false) diff --git a/app/vendor/cakephp/cakephp/src/ORM/LazyEagerLoader.php b/app/vendor/cakephp/cakephp/src/ORM/LazyEagerLoader.php index 431459f53..694978f79 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/LazyEagerLoader.php +++ b/app/vendor/cakephp/cakephp/src/ORM/LazyEagerLoader.php @@ -39,7 +39,7 @@ class LazyEagerLoader * * @param \Cake\Datasource\EntityInterface|array<\Cake\Datasource\EntityInterface> $entities a single entity or list of entities * @param array $contain A `contain()` compatible array. - * @see \Cake\ORM\Query::contain() + * @see \Cake\ORM\Query\SelectQuery::contain() * @param \Cake\ORM\Table $source The table to use for fetching the top level entities * @return \Cake\Datasource\EntityInterface|array<\Cake\Datasource\EntityInterface> */ @@ -68,7 +68,7 @@ public function loadInto(EntityInterface|array $entities, array $contain, Table * @param array<\Cake\Datasource\EntityInterface> $entities The original entities * @param array $contain The associations to be loaded * @param \Cake\ORM\Table $source The table to use for fetching the top level entities - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ protected function _getQuery(array $entities, array $contain, Table $source): SelectQuery { @@ -132,7 +132,7 @@ protected function _getPropertyMap(Table $source, array $associations): array * entities. * * @param array<\Cake\Datasource\EntityInterface> $entities The original list of entities - * @param \Cake\ORM\Query\SelectQuery $query The query to load results + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query to load results * @param array $associations The top level associations that were loaded * @param \Cake\ORM\Table $source The table where the entities came from * @return array<\Cake\Datasource\EntityInterface> diff --git a/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorAwareTrait.php b/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorAwareTrait.php index 204934cc7..850af30ae 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorAwareTrait.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorAwareTrait.php @@ -75,13 +75,14 @@ public function getTableLocator(): LocatorInterface /** * Convenience method to get a table instance. * - * @param string|null $alias The alias name you want to get. Should be in CamelCase format. + * @template T of \Cake\ORM\Table + * @param class-string|string|null $alias The alias name you want to get. Should be in CamelCase format. * If `null` then the value of $defaultTable property is used. * @param array $options The options you want to build the table with. * If a table has already been loaded the registry options will be ignored. - * @return \Cake\ORM\Table + * @return ($alias is class-string ? T : \Cake\ORM\Table) * @throws \Cake\Core\Exception\CakeException If `$alias` argument and `$defaultTable` property both are `null`. - * @see \Cake\ORM\TableLocator::get() + * @see \Cake\ORM\Locator\TableLocator::get() * @since 4.3.0 */ public function fetchTable(?string $alias = null, array $options = []): Table @@ -93,6 +94,8 @@ public function fetchTable(?string $alias = null, array $options = []): Table ); } + // phpcs:ignore + /** @var T */ return $this->getTableLocator()->get($alias, $options); } } diff --git a/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorInterface.php b/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorInterface.php index 15d0ba2c4..71b59cab7 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorInterface.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Locator/LocatorInterface.php @@ -22,6 +22,8 @@ /** * Registries for Table objects should implement this interface. + * + * @extends \Cake\Datasource\Locator\LocatorInterface<\Cake\ORM\Table> */ interface LocatorInterface extends BaseLocatorInterface { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Locator/TableContainer.php b/app/vendor/cakephp/cakephp/src/ORM/Locator/TableContainer.php new file mode 100644 index 000000000..c6a0dfdbe --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/ORM/Locator/TableContainer.php @@ -0,0 +1,48 @@ +fetchTable($id); + } + + /** + * @inheritDoc + */ + public function has(string $id): bool + { + return str_ends_with($id, 'Table') && is_subclass_of($id, Table::class); + } +} diff --git a/app/vendor/cakephp/cakephp/src/ORM/Locator/TableLocator.php b/app/vendor/cakephp/cakephp/src/ORM/Locator/TableLocator.php index 0f9a7f658..3b11f58ca 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Locator/TableLocator.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Locator/TableLocator.php @@ -30,6 +30,8 @@ /** * Provides a default registry/factory for Table objects. + * + * @extends \Cake\Datasource\Locator\AbstractLocator<\Cake\ORM\Table> */ class TableLocator extends AbstractLocator implements LocatorInterface { @@ -47,13 +49,6 @@ class TableLocator extends AbstractLocator implements LocatorInterface */ protected array $_config = []; - /** - * Instances that belong to the registry. - * - * @var array - */ - protected array $instances = []; - /** * Contains a list of Table objects that were created out of the * built-in Table class. The list is indexed by table alias @@ -65,8 +60,7 @@ class TableLocator extends AbstractLocator implements LocatorInterface /** * Fallback class to use * - * @var string - * @phpstan-var class-string<\Cake\ORM\Table> + * @var class-string<\Cake\ORM\Table> */ protected string $fallbackClassName = Table::class; @@ -123,9 +117,8 @@ public function allowFallbackClass(bool $allow) * class for alias used in `get()` could not be found. Defaults to * `Cake\ORM\Table`. * - * @param string $className Fallback class name + * @param class-string<\Cake\ORM\Table> $className Fallback class name * @return $this - * @phpstan-param class-string<\Cake\ORM\Table> $className */ public function setFallbackClassName(string $className) { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Marshaller.php b/app/vendor/cakephp/cakephp/src/ORM/Marshaller.php index 0a5f58db1..b21f9149a 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Marshaller.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Marshaller.php @@ -36,6 +36,7 @@ * @see \Cake\ORM\Table::newEntities() * @see \Cake\ORM\Table::patchEntity() * @see \Cake\ORM\Table::patchEntities() + * @template TEntity of \Cake\Datasource\EntityInterface */ class Marshaller { @@ -44,14 +45,14 @@ class Marshaller /** * The table instance this marshaller is for. * - * @var \Cake\ORM\Table + * @var \Cake\ORM\Table, TEntity> */ protected Table $_table; /** * Constructor. * - * @param \Cake\ORM\Table $table The table this marshaller is for. + * @param \Cake\ORM\Table, TEntity> $table The table this marshaller is for. */ public function __construct(Table $table) { @@ -64,7 +65,8 @@ public function __construct(Table $table) * @param array $data The data being marshaled. * @param array $options List of options containing the 'associated' key. * @throws \InvalidArgumentException When associations do not exist. - * @return array + * @return array Map of property names to marshaling callables. + * Each callable accepts the value and entity, and returns the marshaled result. */ protected function _buildPropertyMap(array $data, array $options): array { @@ -76,7 +78,7 @@ protected function _buildPropertyMap(array $data, array $options): array $prop = (string)$prop; $columnType = $schema->getColumnType($prop); if ($columnType) { - $map[$prop] = fn($value) => TypeFactory::build($columnType)->marshal($value); + $map[$prop] = TypeFactory::build($columnType)->marshal(...); } } @@ -128,7 +130,7 @@ protected function _buildPropertyMap(array $data, array $options): array ); }; } else { - $callback = function ($value, $entity) use ($assoc, $nested): array|EntityInterface|null { + $callback = function ($value) use ($assoc, $nested): array|EntityInterface|null { $options = $nested + ['associated' => []]; return $this->_marshalAssociation($assoc, $value, $options); @@ -193,7 +195,7 @@ protected function _buildPropertyMap(array $data, array $options): array * * @param array $data The data to hydrate. * @param array $options List of options - * @return \Cake\Datasource\EntityInterface + * @return TEntity * @see \Cake\ORM\Table::newEntity() * @see \Cake\ORM\Entity::$_accessible */ @@ -209,7 +211,13 @@ public function one(array $data, array $options = []): EntityInterface $entity->setAccess($key, $value); } } - $errors = $this->_validate($data, $options['validate'], true); + + $fieldsToValidate = $options['strictFields'] ? (array)$options['fields'] : []; + $context = [ + 'entity' => $entity, + 'fields' => $fieldsToValidate, + ]; + $errors = $this->_validate($data, $options['validate'], true, $context); $options['isMerge'] = false; $propertyMap = $this->_buildPropertyMap($data, $options); @@ -242,12 +250,11 @@ public function one(array $data, array $options = []): EntityInterface $entity->set($field, $properties[$field], ['asOriginal' => true]); } } + // @phpstan-ignore function.alreadyNarrowedType (patch method available on EntityInterface) + } elseif (method_exists($entity, 'patch')) { + $entity->patch($properties, ['asOriginal' => true]); } else { - if (method_exists($entity, 'patch')) { - $entity->patch($properties, ['asOriginal' => true]); - } else { - $entity->set($properties, ['asOriginal' => true]); - } + $entity->set($properties, ['asOriginal' => true]); } // Don't flag clean association entities as @@ -270,10 +277,11 @@ public function one(array $data, array $options = []): EntityInterface * @param array $data The data to validate. * @param string|bool $validator Validator name or `true` for default validator. * @param bool $isNew Whether it is a new entity or one to be updated. + * @param array $context Additional validation context. * @return array The list of validation errors. * @throws \RuntimeException If no validator can be created. */ - protected function _validate(array $data, string|bool $validator, bool $isNew): array + protected function _validate(array $data, string|bool $validator, bool $isNew, array $context = []): array { if (!$validator) { return []; @@ -283,7 +291,7 @@ protected function _validate(array $data, string|bool $validator, bool $isNew): $validator = null; } - return $this->_table->getValidator($validator)->validate($data, $isNew); + return $this->_table->getValidator($validator)->validate($data, $isNew, $context); } /** @@ -295,7 +303,7 @@ protected function _validate(array $data, string|bool $validator, bool $isNew): */ protected function _prepareDataAndOptions(array $data, array $options): array { - $options += ['validate' => true]; + $options += ['validate' => true, 'fields' => null, 'strictFields' => false]; $tableName = $this->_table->getAlias(); if (isset($data[$tableName]) && is_array($data[$tableName])) { @@ -367,7 +375,7 @@ protected function _marshalAssociation(Association $assoc, mixed $value, array $ * * @param array $data The data to hydrate. * @param array $options List of options - * @return array<\Cake\Datasource\EntityInterface> An array of hydrated records. + * @return array An array of hydrated records. * @see \Cake\ORM\Table::newEntities() * @see \Cake\ORM\Entity::$_accessible */ @@ -390,7 +398,7 @@ public function many(array $data, array $options = []): array * Builds the related entities and handles the special casing * for junction table entities. * - * @param \Cake\ORM\Association\BelongsToMany $assoc The association to marshal. + * @param \Cake\ORM\Association\BelongsToMany<\Cake\ORM\Table> $assoc The association to marshal. * @param array $data The data to convert into entities. * @param array $options List of options. * @return array<\Cake\Datasource\EntityInterface> An array of built entities. @@ -436,7 +444,7 @@ protected function _belongsToMany(BelongsToMany $assoc, array $data, array $opti } } - if ($conditions) { + if ($conditions !== []) { /** @var \Traversable<\Cake\Datasource\EntityInterface> $results */ $results = $target->find() ->andWhere(fn(QueryExpression $exp) => $exp->or($conditions)) @@ -517,7 +525,10 @@ protected function _loadAssociatedByIds(Association $assoc, array $ids): array $filter = [$primaryKey[0] . ' IN' => $ids]; } - return $target->find()->where($filter)->toArray(); + /** @var \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface> $query */ + $query = $target->find()->where($filter); + + return $query->toArray(); } /** @@ -560,11 +571,12 @@ protected function _loadAssociatedByIds(Association $assoc, array $ids): array * ]); * ``` * - * @param \Cake\Datasource\EntityInterface $entity the entity that will get the + * @template TMergedEntity of \Cake\Datasource\EntityInterface + * @param TMergedEntity $entity the entity that will get the * data merged in * @param array $data key value list of fields to be merged into the entity * @param array $options List of options. - * @return \Cake\Datasource\EntityInterface + * @return TMergedEntity * @see \Cake\ORM\Entity::$_accessible */ public function merge(EntityInterface $entity, array $data, array $options = []): EntityInterface @@ -584,7 +596,12 @@ public function merge(EntityInterface $entity, array $data, array $options = []) } } - $errors = $this->_validate($data + $keys, $options['validate'], $isNew); + $fieldsToValidate = $options['strictFields'] ? (array)$options['fields'] : []; + $context = [ + 'entity' => $entity, + 'fields' => $fieldsToValidate, + ]; + $errors = $this->_validate($data + $keys, $options['validate'], $isNew, $context); $options['isMerge'] = true; $propertyMap = $this->_buildPropertyMap($data, $options); $properties = []; @@ -607,6 +624,7 @@ public function merge(EntityInterface $entity, array $data, array $options = []) $entity->setErrors($errors); if (!isset($options['fields'])) { + // @phpstan-ignore function.alreadyNarrowedType (patch method available on EntityInterface) if (method_exists($entity, 'patch')) { $entity->patch($properties); } else { @@ -662,11 +680,12 @@ public function merge(EntityInterface $entity, array $data, array $options = []) * the accessible fields list in the entity will be used. * - accessibleFields: A list of fields to allow or deny in entity accessible fields. * - * @param iterable<\Cake\Datasource\EntityInterface> $entities the entities that will get the + * @template TMergedEntity of \Cake\Datasource\EntityInterface + * @param iterable $entities the entities that will get the * data merged in * @param array $data list of arrays to be merged into the entities * @param array $options List of options. - * @return array<\Cake\Datasource\EntityInterface> + * @return array * @see \Cake\ORM\Entity::$_accessible */ public function mergeMany(iterable $entities, array $data, array $options = []): array @@ -719,7 +738,10 @@ public function mergeMany(iterable $entities, array $data, array $options = []): $maybeExistentQuery = $this->_table->find()->where($conditions); if ($indexed && count($maybeExistentQuery->clause('where'))) { - /** @var \Traversable<\Cake\Datasource\EntityInterface> $existent */ + /** + * phpcs:ignore SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation.NonFullyQualifiedClassName + * @var \Traversable $existent + */ $existent = $maybeExistentQuery->all(); foreach ($existent as $entity) { $key = implode(';', $entity->extract($primary)); @@ -734,7 +756,12 @@ public function mergeMany(iterable $entities, array $data, array $options = []): if (!is_array($value)) { continue; } - $output[] = $this->one($value, $options); + /** + * phpcs:ignore SlevomatCodingStandard.Namespaces.FullyQualifiedClassNameInAnnotation.NonFullyQualifiedClassName + * @var TEntity $entity + */ + $entity = $this->one($value, $options); + $output[] = $entity; } return $output; @@ -798,7 +825,7 @@ protected function _mergeAssociation( * association. * * @param array<\Cake\Datasource\EntityInterface> $original The original entities list. - * @param \Cake\ORM\Association\BelongsToMany $assoc The association to marshall + * @param \Cake\ORM\Association\BelongsToMany<\Cake\ORM\Table> $assoc The association to marshall * @param array $value The data to hydrate * @param array $options List of options. * @return array<\Cake\Datasource\EntityInterface> @@ -829,7 +856,7 @@ protected function _mergeBelongsToMany(array $original, BelongsToMany $assoc, ar * Merge the special junction property (_joinData) into the entity set. * * @param array<\Cake\Datasource\EntityInterface> $original The original entities list. - * @param \Cake\ORM\Association\BelongsToMany $assoc The association to marshall + * @param \Cake\ORM\Association\BelongsToMany<\Cake\ORM\Table> $assoc The association to marshall * @param array $value The data to hydrate * @param array $options List of options. * @return array<\Cake\Datasource\EntityInterface> An array of entities diff --git a/app/vendor/cakephp/cakephp/src/ORM/PropertyMarshalInterface.php b/app/vendor/cakephp/cakephp/src/ORM/PropertyMarshalInterface.php index d7510ba88..93e4013f5 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/PropertyMarshalInterface.php +++ b/app/vendor/cakephp/cakephp/src/ORM/PropertyMarshalInterface.php @@ -27,10 +27,10 @@ interface PropertyMarshalInterface /** * Build a set of properties that should be included in the marshaling process. * - * @param \Cake\ORM\Marshaller $marshaller The marshaler of the table the behavior is attached to. - * @param array $map The property map being built. + * @param \Cake\ORM\Marshaller<\Cake\Datasource\EntityInterface> $marshaller The marshaler of the table the behavior is attached to. + * @param array $map The property map being built. * @param array $options The options array used in the marshaling call. - * @return array A map of `[property => callable]` of additional properties to marshal. + * @return array A map of `[property => callable]` of additional properties to marshal. */ public function buildMarshalMap(Marshaller $marshaller, array $map, array $options): array; } diff --git a/app/vendor/cakephp/cakephp/src/ORM/Query/CommonQueryTrait.php b/app/vendor/cakephp/cakephp/src/ORM/Query/CommonQueryTrait.php index 1b45f9923..08aa7cf13 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Query/CommonQueryTrait.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Query/CommonQueryTrait.php @@ -21,6 +21,8 @@ /** * Trait with common methods used by all ORM query classes. + * + * @require-extends \Cake\Database\Query */ trait CommonQueryTrait { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Query/QueryFactory.php b/app/vendor/cakephp/cakephp/src/ORM/Query/QueryFactory.php index b9d049938..2717ece7a 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Query/QueryFactory.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Query/QueryFactory.php @@ -27,7 +27,7 @@ class QueryFactory * Create a new Query instance. * * @param \Cake\ORM\Table $table The table this query is starting on. - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> */ public function select(Table $table): SelectQuery { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Query/SelectQuery.php b/app/vendor/cakephp/cakephp/src/ORM/Query/SelectQuery.php index 2f27ddc36..09373897b 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Query/SelectQuery.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Query/SelectQuery.php @@ -44,7 +44,7 @@ * into a specific iterator that will be responsible for hydrating results if * required. * - * @template TSubject of \Cake\Datasource\EntityInterface|array + * @template-covariant TSubject of \Cake\Datasource\EntityInterface|array * @extends \Cake\Database\Query\SelectQuery */ class SelectQuery extends DbSelectQuery implements JsonSerializable, QueryInterface @@ -95,6 +95,13 @@ class SelectQuery extends DbSelectQuery implements JsonSerializable, QueryInterf */ protected bool $_hydrate = true; + /** + * DTO class for projection instead of entity hydration + * + * @var class-string|null + */ + protected ?string $dtoClass = null; + /** * Whether aliases are generated for fields. * @@ -154,7 +161,7 @@ class SelectQuery extends DbSelectQuery implements JsonSerializable, QueryInterf * When set, SelectQuery execution will be bypassed. * * @var iterable|null - * @see \Cake\Datasource\QueryTrait::setResult() + * @see \Cake\ORM\Query\SelectQuery::setResult() */ protected ?iterable $_results = null; @@ -227,7 +234,7 @@ public function setResult(iterable $results) * iterated without having to call execute() manually, thus making it look like * a result set instead of the query itself. * - * @return \Cake\Datasource\ResultSetInterface<\Cake\Datasource\EntityInterface|array> + * @return \Cake\Datasource\ResultSetInterface */ public function getIterator(): ResultSetInterface { @@ -365,7 +372,7 @@ public function aliasFields(array $fields, ?string $defaultAlias = null): array * ResultSetDecorator is a traversable object that implements the methods found * on Cake\Collection\Collection. * - * @return \Cake\Datasource\ResultSetInterface + * @return \Cake\Datasource\ResultSetInterface */ public function all(): ResultSetInterface { @@ -390,7 +397,7 @@ public function all(): ResultSetInterface /** * Returns an array representation of the results after executing the query. * - * @return array + * @return array */ public function toArray(): array { @@ -575,7 +582,7 @@ public function getResultFormatters(): array * $singleUser = $query->select(['id', 'username'])->first(); * ``` * - * @return mixed The first result from the ResultSet. + * @return TSubject|null The first result from the ResultSet. */ public function first(): mixed { @@ -590,7 +597,7 @@ public function first(): mixed * Get the first result from the executing query or raise an exception. * * @throws \Cake\Datasource\Exception\RecordNotFoundException When there is no first record. - * @return mixed The first result from the ResultSet. + * @return TSubject The first result from the ResultSet. */ public function firstOrFail(): mixed { @@ -620,7 +627,7 @@ public function firstOrFail(): mixed * @see \Cake\Datasource\QueryInterface::applyOptions() to read about the options that will * be processed by this class and not returned by this function * @return array - * @see applyOptions() + * @see \Cake\ORM\Query\SelectQuery::applyOptions() */ public function getOptions(): array { @@ -688,7 +695,7 @@ public function getOptions(): array * * @param array $options The options to be applied * @return $this - * @see getOptions() + * @see \Cake\ORM\Query\SelectQuery::getOptions() */ public function applyOptions(array $options) { @@ -725,7 +732,7 @@ public function applyOptions(array $options) * Decorates the results iterator with MapReduce routines and formatters * * @param iterable $result Original results - * @return \Cake\Datasource\ResultSetInterface<\Cake\Datasource\EntityInterface|mixed> + * @return \Cake\Datasource\ResultSetInterface */ protected function _decorateResults(iterable $result): ResultSetInterface { @@ -752,6 +759,17 @@ protected function _decorateResults(iterable $result): ResultSetInterface } } + // DTO projection runs AFTER all other formatters so behaviors see arrays/entities + if ($this->dtoClass !== null) { + // Get the cached hydrator once, avoiding method_exists() check on every row + $hydrator = $this->resultSetFactory()->getDtoHydrator($this->dtoClass); + $result = $result->map($hydrator); + + if (!($result instanceof ResultSetInterface)) { + $result = new $resultSetClass($result); + } + } + return $result; } @@ -782,9 +800,9 @@ protected function _decorateResults(iterable $result): ResultSetInterface * }) * ``` * - * By default, no fields are selected, if you have an instance of `Cake\ORM\Query` and try to append - * fields you should also call `Cake\ORM\Query::enableAutoFields()` to select the default fields - * from the table. + * By default, no fields are selected, if you have an instance of `Cake\ORM\Query\SelectQuery` and try to + * append fields you should also call `Cake\ORM\Query\SelectQuery::enableAutoFields()` to select the + * default fields from the table. * * If you pass an instance of a `Cake\ORM\Table` or `Cake\ORM\Association` class, * all the fields in the schema of the table or the association will be added to @@ -1241,7 +1259,7 @@ public function leftJoinWith(string $assoc, ?Closure $builder = null) * @param \Closure|null $builder a function that will receive a pre-made query object * that can be used to add custom conditions or selecting some fields * @return $this - * @see \Cake\ORM\Query\SeletQuery::matching() + * @see \Cake\ORM\Query\SelectQuery::matching() */ public function innerJoinWith(string $assoc, ?Closure $builder = null) { @@ -1501,13 +1519,15 @@ public function enableHydration(bool $enable = true) * Disabling hydration will cause array results to be returned for the query * instead of entities. * - * @return $this + * @return static> + * @phpcsSuppress SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint */ public function disableHydration() { $this->_dirty(); $this->_hydrate = false; + /** @phpstan-ignore return.type */ return $this; } @@ -1521,6 +1541,43 @@ public function isHydrationEnabled(): bool return $this->_hydrate; } + /** + * Project results into a DTO class instead of entities. + * + * When DTO projection is enabled, results will be hydrated into + * the specified DTO class instead of entity objects. + * + * @param class-string $dtoClass The DTO class name + * @return $this + */ + public function projectAs(string $dtoClass) + { + $this->_dirty(); + $this->dtoClass = $dtoClass; + + return $this; + } + + /** + * Get the DTO class for projection. + * + * @return class-string|null + */ + public function getDtoClass(): ?string + { + return $this->dtoClass; + } + + /** + * Check if DTO projection is enabled. + * + * @return bool + */ + public function isDtoProjectionEnabled(): bool + { + return $this->dtoClass !== null; + } + /** * Trigger the beforeFind event on the query's repository object. * @@ -1579,7 +1636,7 @@ protected function _execute(): iterable /** * Get result set factory. * - * @return \Cake\ORM\ResultSetFactory + * @return \Cake\ORM\ResultSetFactory<\Cake\Datasource\EntityInterface|array> */ public function resultSetFactory(): ResultSetFactory { @@ -1728,7 +1785,7 @@ public function __debugInfo(): array * * Part of JsonSerializable interface. * - * @return \Cake\Datasource\ResultSetInterface<(\Cake\Datasource\EntityInterface|mixed)> The data to convert to JSON. + * @return \Cake\Datasource\ResultSetInterface The data to convert to JSON. */ public function jsonSerialize(): ResultSetInterface { diff --git a/app/vendor/cakephp/cakephp/src/ORM/ResultSet.php b/app/vendor/cakephp/cakephp/src/ORM/ResultSet.php index 103d913c0..5971bd86b 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/ResultSet.php +++ b/app/vendor/cakephp/cakephp/src/ORM/ResultSet.php @@ -25,31 +25,11 @@ * the query, casting each field to the correct type and executing the extra * queries required for eager loading external associations. * - * @template T - * @implements \Cake\Datasource\ResultSetInterface + * @template TKey + * @template TValue + * @implements \Cake\Datasource\ResultSetInterface + * @extends \Cake\Collection\Collection */ class ResultSet extends Collection implements ResultSetInterface { - /** - * Returns an array that can be used to describe the internal state of this - * object. - * - * @return array - */ - public function __debugInfo(): array - { - $key = $this->key(); - $items = $this->toArray(); - - $this->rewind(); - // Move the internal pointer to the previous position otherwise it creates problems with Xdebug - // https://github.com/cakephp/cakephp/issues/18234 - while ($this->key() !== $key) { - $this->next(); - } - - return [ - 'items' => $items, - ]; - } } diff --git a/app/vendor/cakephp/cakephp/src/ORM/ResultSetFactory.php b/app/vendor/cakephp/cakephp/src/ORM/ResultSetFactory.php index 072510db4..983848e0d 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/ResultSetFactory.php +++ b/app/vendor/cakephp/cakephp/src/ORM/ResultSetFactory.php @@ -24,7 +24,7 @@ use SplFixedArray; /** - * Factory class for generating ResulSet instances. + * Factory class for generating ResultSet instances. * * It is responsible for correctly nesting result keys reported from the query * and hydrating entities. @@ -34,7 +34,7 @@ class ResultSetFactory { /** - * @var class-string<\Cake\Datasource\ResultSetInterface> + * @var class-string<\Cake\Datasource\ResultSetInterface> */ protected string $resultSetClass = ResultSet::class; @@ -42,8 +42,8 @@ class ResultSetFactory * Create a result set instance. * * @param iterable $results Results. - * @param \Cake\ORM\Query\SelectQuery|null $query Query from where results came. - * @return \Cake\Datasource\ResultSetInterface + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array>|null $query Query from where results came. + * @return \Cake\Datasource\ResultSetInterface */ public function createResultSet(iterable $results, ?SelectQuery $query = null): ResultSetInterface { @@ -68,11 +68,11 @@ public function createResultSet(iterable $results, ?SelectQuery $query = null): } /** - * Get repository and it's associations data for nesting results key and + * Get repository and its associations data for nesting results key and * entity hydration. * - * @param \Cake\ORM\Query\SelectQuery $query The query from where to derive the data. - * @return array + * @param \Cake\ORM\Query\SelectQuery<\Cake\Datasource\EntityInterface|array> $query The query from where to derive the data. + * @return array{primaryAlias: string, registryAlias: string, entityClass: class-string<\Cake\Datasource\EntityInterface>, hydrate: bool, autoFields: bool|null, matchingColumns: array, dtoClass: class-string|null, matchingAssoc: array, containAssoc: array, fields: array} */ protected function collectData(SelectQuery $query): array { @@ -84,6 +84,7 @@ protected function collectData(SelectQuery $query): array 'hydrate' => $query->isHydrationEnabled(), 'autoFields' => $query->isAutoFieldsEnabled(), 'matchingColumns' => [], + 'dtoClass' => $query->getDtoClass(), ]; $assocMap = $query->getEagerLoader()->associationsMap($primaryTable); @@ -149,7 +150,7 @@ protected function groupResult(array $row, array $data): EntityInterface|array $keys, array_intersect_key($row, $keys), ); - if ($data['hydrate']) { + if ($data['hydrate'] && $data['dtoClass'] === null) { $table = $matching['instance']; assert($table instanceof Table || $table instanceof Association); @@ -211,7 +212,7 @@ protected function groupResult(array $row, array $data): EntityInterface|array } } - if ($data['hydrate'] && $results[$alias] !== null && $assoc['canBeJoined']) { + if ($data['hydrate'] && $data['dtoClass'] === null && $results[$alias] !== null && $assoc['canBeJoined']) { $entity = new $assoc['entityClass']($results[$alias], $options); $results[$alias] = $entity; } @@ -234,6 +235,12 @@ protected function groupResult(array $row, array $data): EntityInterface|array if (isset($results[$data['primaryAlias']])) { $results = $results[$data['primaryAlias']]; } + + // DTO projection returns arrays - DTO mapping happens in formatter phase + if ($data['dtoClass'] !== null) { + return $results; + } + if ($data['hydrate'] && !($results instanceof EntityInterface)) { /** @var \Cake\Datasource\EntityInterface */ return new $data['entityClass']($results, $options); @@ -242,15 +249,97 @@ protected function groupResult(array $row, array $data): EntityInterface|array return $results; } + /** + * Cached DtoMapper instance + * + * @var \Cake\ORM\DtoMapper|null + */ + protected ?DtoMapper $dtoMapper = null; + + /** + * Cached DTO hydrator callables by class name. + * Avoids method_exists() check on every row. + * + * @var array + */ + protected static array $dtoHydrators = []; + + /** + * Hydrate a row into a DTO. + * + * Supports two patterns: + * - Static `createFromArray($data, $nested)` factory method (cakephp-dto style) + * - Constructor with named parameters (DtoMapper reflection) + * + * @param array $row Nested array data + * @param class-string $dtoClass DTO class name + * @return object + */ + public function hydrateDto(array $row, string $dtoClass): object + { + return $this->getDtoHydrator($dtoClass)($row); + } + + /** + * Get a cached hydrator callable for a DTO class. + * + * The hydrator is determined once per class and cached to avoid + * method_exists() checks on every row. + * + * @param class-string $dtoClass DTO class name + * @return callable(array): object + */ + public function getDtoHydrator(string $dtoClass): callable + { + if (!isset(static::$dtoHydrators[$dtoClass])) { + // Check for array style static factory method (cakephp-dto style) + if (method_exists($dtoClass, 'createFromArray')) { + static::$dtoHydrators[$dtoClass] = static function (array $row) use ($dtoClass): object { + return $dtoClass::createFromArray($row, true); + }; + } else { + // Use DtoMapper for plain readonly DTOs with named constructor params + $mapper = $this->getDtoMapper(); + static::$dtoHydrators[$dtoClass] = static function (array $row) use ($mapper, $dtoClass): object { + return $mapper->map($row, $dtoClass); + }; + } + } + + return static::$dtoHydrators[$dtoClass]; + } + + /** + * Clear the DTO hydrator cache. + * + * Useful for testing or when classes are reloaded. + * + * @return void + */ + public static function clearDtoHydratorCache(): void + { + static::$dtoHydrators = []; + } + + /** + * Get or create the DtoMapper instance. + * + * @return \Cake\ORM\DtoMapper + */ + public function getDtoMapper(): DtoMapper + { + return $this->dtoMapper ??= new DtoMapper(); + } + /** * Set the ResultSet class to use. * - * @param class-string<\Cake\Datasource\ResultSetInterface> $resultSetClass Class name. + * @param class-string<\Cake\Datasource\ResultSetInterface> $resultSetClass Class name. * @return $this */ public function setResultSetClass(string $resultSetClass) { - if (!is_a($resultSetClass, ResultSetInterface::class, true)) { + if (!is_subclass_of($resultSetClass, ResultSetInterface::class)) { throw new InvalidArgumentException(sprintf( 'Invalid ResultSet class `%s`. It must implement `%s`', $resultSetClass, @@ -266,7 +355,7 @@ public function setResultSetClass(string $resultSetClass) /** * Get the ResultSet class to use. * - * @return class-string<\Cake\Datasource\ResultSetInterface> + * @return class-string<\Cake\Datasource\ResultSetInterface> */ public function getResultSetClass(): string { diff --git a/app/vendor/cakephp/cakephp/src/ORM/Rule/ExistsIn.php b/app/vendor/cakephp/cakephp/src/ORM/Rule/ExistsIn.php index a19c10302..32dea8af9 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Rule/ExistsIn.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Rule/ExistsIn.php @@ -98,7 +98,6 @@ public function __invoke(EntityInterface $entity, array $options): bool } $fields = $this->_fields; - $source = $this->_repository; $target = $this->_repository; if ($target instanceof Association) { $bindingKey = (array)$target->getBindingKey(); @@ -113,7 +112,10 @@ public function __invoke(EntityInterface $entity, array $options): bool } if (!empty($options['repository'])) { + /** @var \Cake\ORM\Table $source */ $source = $options['repository']; + } else { + $source = $this->_repository; } if ($source instanceof Association) { $source = $source->getSource(); @@ -128,17 +130,16 @@ public function __invoke(EntityInterface $entity, array $options): bool } if ($this->_options['allowNullableNulls']) { - /** @var \Cake\ORM\Table $source */ $schema = $source->getSchema(); foreach ($fields as $i => $field) { - if ($schema->getColumn($field) && $schema->isNullable($field) && $entity->get($field) === null) { + if ($schema->hasColumn($field) && $schema->isNullable($field) && $entity->get($field) === null) { unset($bindingKey[$i], $fields[$i]); } } } $primary = array_map( - fn($key) => $target->aliasField($key) . ' IS', + fn(string $key) => $target->aliasField($key) . ' IS', $bindingKey, ); $conditions = array_combine( @@ -161,7 +162,7 @@ protected function _fieldsAreNull(EntityInterface $entity, Table $source): bool $nulls = 0; $schema = $source->getSchema(); foreach ($this->_fields as $field) { - if ($schema->getColumn($field) && $schema->isNullable($field) && $entity->get($field) === null) { + if ($schema->hasColumn($field) && $schema->isNullable($field) && $entity->get($field) === null) { $nulls++; } } diff --git a/app/vendor/cakephp/cakephp/src/ORM/Rule/ExistsInNullable.php b/app/vendor/cakephp/cakephp/src/ORM/Rule/ExistsInNullable.php new file mode 100644 index 000000000..7f89ff8a5 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/ORM/Rule/ExistsInNullable.php @@ -0,0 +1,42 @@ +|string $fields The field or fields to check existence as primary key. + * @param \Cake\ORM\Table|\Cake\ORM\Association|string $repository The repository where the + * field will be looked for, or the association name for the repository. + * @param array $options The options that modify the rule's behavior. + */ + public function __construct(array|string $fields, Table|Association|string $repository, array $options = []) + { + $options += ['allowNullableNulls' => true]; + parent::__construct($fields, $repository, $options); + } +} diff --git a/app/vendor/cakephp/cakephp/src/ORM/Rule/LinkConstraint.php b/app/vendor/cakephp/cakephp/src/ORM/Rule/LinkConstraint.php index 1a512ab3e..4b18e8813 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Rule/LinkConstraint.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Rule/LinkConstraint.php @@ -162,7 +162,6 @@ protected function _countLinks(Association $association, EntityInterface $entity { $source = $association->getSource(); - /** @var array $primaryKey */ $primaryKey = (array)$source->getPrimaryKey(); if (!$entity->has($primaryKey)) { throw new DatabaseException(sprintf( diff --git a/app/vendor/cakephp/cakephp/src/ORM/RulesChecker.php b/app/vendor/cakephp/cakephp/src/ORM/RulesChecker.php index 7fef06357..b41553f7c 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/RulesChecker.php +++ b/app/vendor/cakephp/cakephp/src/ORM/RulesChecker.php @@ -19,6 +19,7 @@ use Cake\Datasource\RuleInvoker; use Cake\Datasource\RulesChecker as BaseRulesChecker; use Cake\ORM\Rule\ExistsIn; +use Cake\ORM\Rule\ExistsInNullable; use Cake\ORM\Rule\IsUnique; use Cake\ORM\Rule\LinkConstraint; use Cake\ORM\Rule\ValidCount; @@ -91,8 +92,9 @@ public function isUnique(array $fields, array|string|null $message = null): Rule * Set 'allowNullableNulls' to true to accept composite foreign keys where one or more nullable columns are null. * * @param array|string $field The field or list of fields to check for existence by - * primary key lookup in the other table. - * @param \Cake\ORM\Table|\Cake\ORM\Association|string $table The table name where the fields existence will be checked. + * primary key lookup in the other table. + * @param \Cake\ORM\Table|\Cake\ORM\Association|string $table The table object or association name for the table + * where the fields existence will be checked. * @param array|string|null $message The error message to show in case the rule does not pass. Can * also be an array of options. When an array, the 'message' key can be used to provide a message. * @return \Cake\Datasource\RuleInvoker @@ -122,6 +124,62 @@ public function existsIn( return $this->_addError(new ExistsIn($field, $table, $options), '_existsIn', compact('errorField', 'message')); } + /** + * Returns a callable that can be used as a rule for checking that the value provided in a + * field exists as the primary key of another table. Accepts composite foreign keys where + * one or more nullable columns are null. + * + * This is a convenience wrapper around `ExistsIn` with `allowNullableNulls` set to `true` by default. + * + * ### Example: + * + * ``` + * $rules->add($rules->existsInNullable(['author_id', 'site_id'], 'SiteAuthors')); + * ``` + * + * This is equivalent to: + * + * ``` + * $rules->add($rules->existsIn(['author_id', 'site_id'], 'SiteAuthors', ['allowNullableNulls' => true])); + * ``` + * + * @param array|string $field The field or fields to check existence as primary key. + * @param \Cake\ORM\Table|\Cake\ORM\Association|string $table The table object or association name for the table + * where the fields existence will be checked. + * @param array|string|null $message The error message to show in case the rule does not pass. Can + * also be an array of options. When an array, the 'message' key can be used to provide a message. + * @return \Cake\Datasource\RuleInvoker + * @since 5.3.0 + */ + public function existsInNullable( + array|string $field, + Table|Association|string $table, + array|string|null $message = null, + ): RuleInvoker { + $options = []; + if (is_array($message)) { + $options = $message + ['message' => null]; + $message = $options['message']; + unset($options['message']); + } + + if (!$message) { + if ($this->_useI18n) { + $message = __d('cake', 'This value does not exist'); + } else { + $message = 'This value does not exist'; + } + } + + $errorField = is_string($field) ? $field : current($field); + + return $this->_addError( + new ExistsInNullable($field, $table, $options), + '_existsIn', + compact('errorField', 'message'), + ); + } + /** * Validates whether links to the given association exist. * @@ -195,7 +253,7 @@ public function isNotLinkedTo( * @param string|null $errorField The name of the property to use for setting possible errors. When absent, * the name is inferred from `$association`. * @param string|null $message The error message to show in case the rule does not pass. - * @param string $linkStatus The ink status required for the check to pass. + * @param string $linkStatus The link status required for the check to pass. * @param string $ruleName The alias/name of the rule. * @return \Cake\Datasource\RuleInvoker * @throws \InvalidArgumentException In case the `$association` argument is of an invalid type. diff --git a/app/vendor/cakephp/cakephp/src/ORM/Table.php b/app/vendor/cakephp/cakephp/src/ORM/Table.php index f8df15f54..688f7d4a8 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/Table.php +++ b/app/vendor/cakephp/cakephp/src/ORM/Table.php @@ -110,7 +110,7 @@ * for the provided named validator. * * - `Model.buildRules` Allows listeners to modify the rules checker by adding more rules. - * Behaviors or custom listerners can subscribe to this even. For tables you don't + * Behaviors or custom listeners can subscribe to this event. For tables you don't * need to subscribe to this event, simply override the `Table::buildRules()` method. * * - `Model.beforeRules` Fired before an entity is validated using the rules checker. @@ -156,12 +156,13 @@ * @see \Cake\Event\EventManager for reference on the events system. * @link https://book.cakephp.org/5/en/orm/table-objects.html#event-list * @template TBehaviors of array = array{} - * @implements \Cake\Event\EventDispatcherInterface<\Cake\ORM\Table> + * @template TEntity of \Cake\Datasource\EntityInterface = \Cake\Datasource\EntityInterface + * @implements \Cake\Event\EventDispatcherInterface<\Cake\ORM\Table> */ class Table implements RepositoryInterface, EventListenerInterface, EventDispatcherInterface, ValidatorAwareInterface { /** - * @use \Cake\Event\EventDispatcherTrait<\Cake\ORM\Table> + * @use \Cake\Event\EventDispatcherTrait<\Cake\ORM\Table> */ use EventDispatcherTrait; use RulesAwareTrait; @@ -263,7 +264,7 @@ class Table implements RepositoryInterface, EventListenerInterface, EventDispatc * The name of the class that represent a single row for this table * * @var string|null - * @phpstan-var class-string<\Cake\Datasource\EntityInterface>|null + * @phpstan-var class-string|null */ protected ?string $_entityClass = null; @@ -329,9 +330,7 @@ public function __construct(array $config = []) $this->initialize($config); - assert($this->_eventManager !== null, 'EventManager not available'); - - $this->_eventManager->on($this); + $this->getEventManager()->on($this); $this->dispatchEvent('Model.initialize'); } @@ -552,7 +551,7 @@ public function setSchema(TableSchemaInterface|array $schema) unset($schema['_constraints']); } - $schema = $this->getConnection()->getDriver()->newTableSchema($this->getTable(), $schema); + $schema = $this->getConnection()->getWriteDriver()->newTableSchema($this->getTable(), $schema); foreach ($constraints as $name => $value) { $schema->addConstraint($name, $value); @@ -583,7 +582,7 @@ protected function checkAliasLengths(): void )); } - $maxLength = $this->getConnection()->getDriver()->getMaxAliasLength(); + $maxLength = $this->getConnection()->getWriteDriver()->getMaxAliasLength(); if ($maxLength === null) { return; } @@ -696,11 +695,12 @@ public function getDisplayField(): array|string|null /** * Returns the class used to hydrate rows for this table. * - * @return class-string<\Cake\Datasource\EntityInterface> + * @return class-string */ public function getEntityClass(): string { if (!$this->_entityClass) { + /** @var class-string $default */ $default = Entity::class; $self = static::class; $parts = explode('\\', $self); @@ -715,7 +715,7 @@ public function getEntityClass(): string return $this->_entityClass = $default; } - /** @var class-string<\Cake\Datasource\EntityInterface>|null $class */ + /** @var class-string|null $class */ $class = App::className($name, 'Model/Entity'); if (!$class) { throw new MissingEntityException([$name]); @@ -736,7 +736,7 @@ public function getEntityClass(): string */ public function setEntityClass(string $name) { - /** @var class-string<\Cake\Datasource\EntityInterface>|null $class */ + /** @var class-string|null $class */ $class = App::className($name, 'Model/Entity'); if ($class === null) { throw new MissingEntityException([$name]); @@ -845,9 +845,9 @@ public function behaviors(): BehaviorRegistry * * @param string $name The behavior alias to get from the registry. * @return \Cake\ORM\Behavior - * @template TName of key-of + * @template TName of string * @phpstan-param TName $name The behavior alias to get from the registry. - * @phpstan-return TBehaviors[TName] + * @phpstan-return (TName is key-of ? TBehaviors[TName] : \Cake\ORM\Behavior) * @throws \InvalidArgumentException If the behavior does not exist. */ public function getBehavior(string $name): Behavior @@ -986,7 +986,7 @@ public function associations(): AssociationCollection * are the aliases, and the values are association config data. If numeric * keys are used the values will be treated as association aliases. * - * @param array $params Set of associations to bind (indexed by association type) + * @param array> $params Set of associations to bind (indexed by association type) * @return $this * @see \Cake\ORM\Table::belongsTo() * @see \Cake\ORM\Table::hasOne() @@ -997,7 +997,7 @@ public function addAssociations(array $params) { foreach ($params as $assocType => $tables) { foreach ($tables as $associated => $options) { - if (is_numeric($associated)) { + if (is_int($associated)) { $associated = $options; $options = []; } @@ -1036,13 +1036,13 @@ public function addAssociations(array $params) * @param string $associated the alias for the target table. This is used to * uniquely identify the association * @param array $options list of options to configure the association definition - * @return \Cake\ORM\Association\BelongsTo + * @return \Cake\ORM\Association\BelongsTo<\Cake\ORM\Table> */ public function belongsTo(string $associated, array $options = []): BelongsTo { $options += ['sourceTable' => $this]; - /** @var \Cake\ORM\Association\BelongsTo */ + /** @var \Cake\ORM\Association\BelongsTo<\Cake\ORM\Table> */ return $this->_associations->load(BelongsTo::class, $associated, $options); } @@ -1080,13 +1080,13 @@ public function belongsTo(string $associated, array $options = []): BelongsTo * @param string $associated the alias for the target table. This is used to * uniquely identify the association * @param array $options list of options to configure the association definition - * @return \Cake\ORM\Association\HasOne + * @return \Cake\ORM\Association\HasOne<\Cake\ORM\Table> */ public function hasOne(string $associated, array $options = []): HasOne { $options += ['sourceTable' => $this]; - /** @var \Cake\ORM\Association\HasOne */ + /** @var \Cake\ORM\Association\HasOne<\Cake\ORM\Table> */ return $this->_associations->load(HasOne::class, $associated, $options); } @@ -1130,13 +1130,13 @@ public function hasOne(string $associated, array $options = []): HasOne * @param string $associated the alias for the target table. This is used to * uniquely identify the association * @param array $options list of options to configure the association definition - * @return \Cake\ORM\Association\HasMany + * @return \Cake\ORM\Association\HasMany<\Cake\ORM\Table> */ public function hasMany(string $associated, array $options = []): HasMany { $options += ['sourceTable' => $this]; - /** @var \Cake\ORM\Association\HasMany */ + /** @var \Cake\ORM\Association\HasMany<\Cake\ORM\Table> */ return $this->_associations->load(HasMany::class, $associated, $options); } @@ -1182,13 +1182,13 @@ public function hasMany(string $associated, array $options = []): HasMany * @param string $associated the alias for the target table. This is used to * uniquely identify the association * @param array $options list of options to configure the association definition - * @return \Cake\ORM\Association\BelongsToMany + * @return \Cake\ORM\Association\BelongsToMany<\Cake\ORM\Table> */ public function belongsToMany(string $associated, array $options = []): BelongsToMany { $options += ['sourceTable' => $this]; - /** @var \Cake\ORM\Association\BelongsToMany */ + /** @var \Cake\ORM\Association\BelongsToMany<\Cake\ORM\Table> */ return $this->_associations->load(BelongsToMany::class, $associated, $options); } @@ -1272,11 +1272,14 @@ public function belongsToMany(string $associated, array $options = []): BelongsT * * @param string $type the type of query to perform * @param mixed ...$args Arguments that match up to finder-specific parameters - * @return \Cake\ORM\Query\SelectQuery The query builder + * @return \Cake\ORM\Query\SelectQuery The query builder */ public function find(string $type = 'all', mixed ...$args): SelectQuery { - return $this->callFinder($type, $this->selectQuery(), ...$args); + /** @var \Cake\ORM\Query\SelectQuery $query */ + $query = $this->callFinder($type, $this->selectQuery(), ...$args); + + return $query; } /** @@ -1285,8 +1288,8 @@ public function find(string $type = 'all', mixed ...$args): SelectQuery * By default findAll() applies no query clauses, you can override this * method in subclasses to modify how `find('all')` works. * - * @param \Cake\ORM\Query\SelectQuery $query The query to find with - * @return \Cake\ORM\Query\SelectQuery The query builder + * @param \Cake\ORM\Query\SelectQuery $query The query to find with + * @return \Cake\ORM\Query\SelectQuery The query builder */ public function findAll(SelectQuery $query): SelectQuery { @@ -1357,8 +1360,8 @@ public function findAll(SelectQuery $query): SelectQuery * ] * ``` * - * @param \Cake\ORM\Query\SelectQuery $query The query to find with - * @return \Cake\ORM\Query\SelectQuery The query builder + * @param \Cake\ORM\Query\SelectQuery $query The query to find with + * @return \Cake\ORM\Query\SelectQuery The query builder */ public function findList( SelectQuery $query, @@ -1372,9 +1375,9 @@ public function findList( if ( !$query->clause('select') && - !is_object($keyField) && - !is_object($valueField) && - !is_object($groupField) + !$keyField instanceof Closure && + !$valueField instanceof Closure && + !$groupField instanceof Closure ) { $fields = array_merge( (array)$keyField, @@ -1415,11 +1418,11 @@ public function findList( * $table->find('threaded', keyField: 'id', parentField: 'ancestor_id', nestingKey: 'children'); * ``` * - * @param \Cake\ORM\Query\SelectQuery $query The query to find with + * @param \Cake\ORM\Query\SelectQuery $query The query to find with * @param \Closure|array|string|null $keyField The path to the key field. * @param \Closure|array|string $parentField The path to the parent field. * @param string $nestingKey The key to nest children under. - * @return \Cake\ORM\Query\SelectQuery The query builder + * @return \Cake\ORM\Query\SelectQuery The query builder */ public function findThreaded( SelectQuery $query, @@ -1496,7 +1499,7 @@ protected function _setFieldMatchers(array $options, array $keys): array * @param \Closure|string|null $cacheKey The cache key to use. If not provided * one will be autogenerated if `$cache` is not null. * @param mixed ...$args Arguments that query options or finder specific parameters. - * @return \Cake\Datasource\EntityInterface + * @return TEntity * @throws \Cake\Datasource\Exception\RecordNotFoundException if the record with such id * could not be found * @throws \Cake\Datasource\Exception\InvalidPrimaryKeyException When $primaryKey has an @@ -1571,7 +1574,10 @@ public function get( $query->cache($cacheKey, $cache); } - return $query->firstOrFail(); + /** @var TEntity $entity */ + $entity = $query->firstOrFail(); + + return $entity; } /** @@ -1584,7 +1590,7 @@ public function get( protected function _executeTransaction(callable $worker, bool $atomic = true): mixed { if ($atomic) { - return $this->getConnection()->transactional(fn() => $worker()); + return $this->getConnection()->transactional($worker(...)); } return $worker(); @@ -1626,14 +1632,14 @@ protected function _transactionCommitted(bool $atomic, bool $primary): bool * transaction (default: true) * - defaults: Whether to use the search criteria as default values for the new entity (default: true) * - * @param \Cake\ORM\Query\SelectQuery|callable|array $search The criteria to find existing + * @param \Cake\ORM\Query\SelectQuery|callable|array $search The criteria to find existing * records by. Note that when you pass a query object you'll have to use * the 2nd arg of the method to modify the entity data before saving. * @param callable|array|null $callback An array of data key/value pairs or a callback that will * be invoked for newly created entities. This callback will be called *before* the entity * is persisted. * @param array $options The options to use when saving. - * @return \Cake\Datasource\EntityInterface An entity. + * @return TEntity An entity. * @throws \Cake\ORM\Exception\PersistenceFailedException When the entity couldn't be saved */ public function findOrCreate( @@ -1661,13 +1667,13 @@ public function findOrCreate( /** * Performs the actual find and/or create of an entity based on the passed options. * - * @param \Cake\ORM\Query\SelectQuery|callable|array $search The criteria to find an existing record by, or a callable tha will + * @param \Cake\ORM\Query\SelectQuery|callable|array $search The criteria to find an existing record by, or a callable that will * customize the find query. * @param callable|array|null $callback Data or a callback that will be invoked for newly * created entities. This callback will be called *before* the entity * is persisted. * @param array $options The options to use when saving. - * @return \Cake\Datasource\EntityInterface|array An entity. + * @return TEntity|array An entity. * @throws \Cake\ORM\Exception\PersistenceFailedException When the entity couldn't be saved * @throws \InvalidArgumentException */ @@ -1695,6 +1701,7 @@ protected function _processFindOrCreate( $entity = $this->patchEntity($entity, $data, ['accessibleFields' => $accessibleFields]); } if ($callback !== null) { + /** @var TEntity $entity */ $entity = $callback($entity) ?: $entity; } unset($options['defaults']); @@ -1711,8 +1718,8 @@ protected function _processFindOrCreate( /** * Gets the query object for findOrCreate(). * - * @param \Cake\ORM\Query\SelectQuery|callable|array $search The criteria to find existing records by. - * @return \Cake\ORM\Query\SelectQuery + * @param \Cake\ORM\Query\SelectQuery|callable|array $search The criteria to find existing records by. + * @return \Cake\ORM\Query\SelectQuery */ protected function _getFindOrCreateQuery(SelectQuery|callable|array $search): SelectQuery { @@ -1731,7 +1738,7 @@ protected function _getFindOrCreateQuery(SelectQuery|callable|array $search): Se /** * Creates a new SelectQuery instance for a table. * - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery */ public function query(): SelectQuery { @@ -1741,11 +1748,14 @@ public function query(): SelectQuery /** * Creates a new select query * - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery */ public function selectQuery(): SelectQuery { - return $this->queryFactory->select($this); + /** @var \Cake\ORM\Query\SelectQuery $query */ + $query = $this->queryFactory->select($this); + + return $query; } /** @@ -1783,11 +1793,14 @@ public function deleteQuery(): DeleteQuery * * This is useful for subqueries. * - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery */ public function subquery(): SelectQuery { - return $this->queryFactory->select($this)->disableAutoAliasing(); + /** @var \Cake\ORM\Query\SelectQuery $query */ + $query = $this->queryFactory->select($this)->disableAutoAliasing(); + + return $query; } /** @@ -1932,9 +1945,12 @@ public function exists(QueryExpression|Closure|array|string|null $conditions): b * $articles->save($entity, ['associated' => false]); * ``` * - * @param \Cake\Datasource\EntityInterface $entity the entity to be saved + * @template TSavedEntity of \Cake\Datasource\EntityInterface + * @param TSavedEntity $entity the entity to be saved * @param array $options The options to use when saving. - * @return \Cake\Datasource\EntityInterface|false + * @return TSavedEntity|false Returns the entity on success. Returns false when the entity has errors, + * validation fails, rules checking fails, or the save operation fails. If the entity is not new + * and has no dirty fields, the entity is returned without performing any database operation. * @throws \Cake\ORM\Exception\RolledbackTransactionException If the transaction is aborted in the afterSave event. */ public function save( @@ -1983,9 +1999,10 @@ public function save( * Try to save an entity or throw a PersistenceFailedException if the application rules checks failed, * the entity contains errors or the save was aborted by a callback. * - * @param \Cake\Datasource\EntityInterface $entity the entity to be saved + * @template TSavedEntity of \Cake\Datasource\EntityInterface + * @param TSavedEntity $entity the entity to be saved * @param array $options The options to use when saving. - * @return \Cake\Datasource\EntityInterface + * @return TSavedEntity * @throws \Cake\ORM\Exception\PersistenceFailedException When the entity couldn't be saved * @see \Cake\ORM\Table::save() */ @@ -2178,6 +2195,7 @@ protected function _insert(EntityInterface $entity, array $data): EntityInterfac if ($statement->rowCount() !== 0) { $success = $entity; + // @phpstan-ignore function.alreadyNarrowedType (patch method available on EntityInterface) if (method_exists($entity, 'patch')) { $entity = $entity->patch($filteredKeys, ['guard' => false]); } else { @@ -2185,7 +2203,7 @@ protected function _insert(EntityInterface $entity, array $data): EntityInterfac } $schema = $this->getSchema(); - $driver = $this->getConnection()->getDriver(); + $driver = $this->getConnection()->getWriteDriver(); foreach ($primary as $key => $v) { if (!isset($data[$key])) { $id = $statement->lastInsertId($this->getTable(), $key); @@ -2211,7 +2229,7 @@ protected function _insert(EntityInterface $entity, array $data): EntityInterfac * You can overwrite _newId() in your table class. * * @param array $primary The primary key columns to get a new ID for. - * @return string|null Either null or the primary key value or a list of primary key values. + * @return string|null The primary key value when a single primary key is available, or null. */ protected function _newId(array $primary): ?string { @@ -2271,9 +2289,10 @@ protected function _update(EntityInterface $entity, array $data): EntityInterfac * any one of the records fails to save due to failed validation or database * error. * - * @param iterable<\Cake\Datasource\EntityInterface> $entities Entities to save. + * @template TSavedEntity of \Cake\Datasource\EntityInterface + * @param iterable $entities Entities to save. * @param array $options Options used when calling Table::save() for each entity. - * @return iterable<\Cake\Datasource\EntityInterface>|false False on failure, entities list on success. + * @return iterable|false False on failure, entities list on success. * @throws \Exception */ public function saveMany( @@ -2294,9 +2313,10 @@ public function saveMany( * any one of the records fails to save due to failed validation or database * error. * - * @param iterable<\Cake\Datasource\EntityInterface> $entities Entities to save. + * @template TSavedEntity of \Cake\Datasource\EntityInterface + * @param iterable $entities Entities to save. * @param array $options Options used when calling Table::save() for each entity. - * @return iterable<\Cake\Datasource\EntityInterface> Entities list. + * @return iterable Entities list. * @throws \Exception * @throws \Cake\ORM\Exception\PersistenceFailedException If an entity couldn't be saved. */ @@ -2306,11 +2326,12 @@ public function saveManyOrFail(iterable $entities, array $options = []): iterabl } /** - * @param iterable<\Cake\Datasource\EntityInterface> $entities Entities to save. + * @template TSavedEntity of \Cake\Datasource\EntityInterface + * @param iterable $entities Entities to save. * @param array $options Options used when calling Table::save() for each entity. * @throws \Cake\ORM\Exception\PersistenceFailedException If an entity couldn't be saved. * @throws \Exception If an entity couldn't be saved. - * @return iterable<\Cake\Datasource\EntityInterface> Entities list. + * @return iterable Entities list. */ protected function _saveMany( iterable $entities, @@ -2454,9 +2475,10 @@ public function delete(EntityInterface $entity, array $options = []): bool * any one of the records fails to delete due to failed validation or database * error. * - * @param iterable<\Cake\Datasource\EntityInterface> $entities Entities to delete. + * @template TDeletedEntity of \Cake\Datasource\EntityInterface + * @param iterable $entities Entities to delete. * @param array $options Options used when calling Table::save() for each entity. - * @return iterable<\Cake\Datasource\EntityInterface>|false Entities list + * @return iterable|false Entities list * on success, false on failure. * @see \Cake\ORM\Table::delete() for options and events related to this method. */ @@ -2478,9 +2500,10 @@ public function deleteMany(iterable $entities, array $options = []): iterable|fa * any one of the records fails to delete due to failed validation or database * error. * - * @param iterable<\Cake\Datasource\EntityInterface> $entities Entities to delete. + * @template TDeletedEntity of \Cake\Datasource\EntityInterface + * @param iterable $entities Entities to delete. * @param array $options Options used when calling Table::save() for each entity. - * @return iterable<\Cake\Datasource\EntityInterface> Entities list. + * @return iterable Entities list. * @throws \Cake\ORM\Exception\PersistenceFailedException * @see \Cake\ORM\Table::delete() for options and events related to this method. */ @@ -2720,9 +2743,19 @@ public function invokeFinder(Closure $callable, SelectQuery $query, array $args) } if ($args) { - $query->applyOptions($args); + $unNamedArgs = []; + $namedArgs = []; + foreach ($args as $key => $value) { + if (is_int($key)) { + $unNamedArgs[$key] = $value; + } else { + $namedArgs[$key] = $value; + } + } + + $query->applyOptions($namedArgs); // Fetch custom args without the query options. - $args = array_intersect_key($args, $query->getOptions()); + $args = $unNamedArgs + array_intersect_key($args, $query->getOptions()); unset($params[0]); $lastParam = end($params); @@ -2750,7 +2783,7 @@ public function invokeFinder(Closure $callable, SelectQuery $query, array $args) * * @param string $method The method name that was fired. * @param array $args List of arguments passed to the function. - * @return \Cake\ORM\Query\SelectQuery + * @return \Cake\ORM\Query\SelectQuery * @throws \BadMethodCallException when there are missing arguments, or when * and & or are combined. */ @@ -2873,7 +2906,7 @@ public function __isset(string $property): bool * Override this method if you want a table object to use custom * marshaling logic. * - * @return \Cake\ORM\Marshaller + * @return \Cake\ORM\Marshaller * @see \Cake\ORM\Marshaller */ public function marshaller(): Marshaller @@ -2884,13 +2917,15 @@ public function marshaller(): Marshaller /** * {@inheritDoc} * - * @return \Cake\Datasource\EntityInterface + * @return TEntity */ public function newEmptyEntity(): EntityInterface { $class = $this->getEntityClass(); + /** @var TEntity $entity */ + $entity = new $class([], ['source' => $this->getRegistryAlias()]); - return new $class([], ['source' => $this->getRegistryAlias()]); + return $entity; } /** @@ -2949,7 +2984,7 @@ public function newEmptyEntity(): EntityInterface * * @param array $data The data to build an entity with. * @param array $options A list of options for the object hydration. - * @return \Cake\Datasource\EntityInterface + * @return TEntity * @see \Cake\ORM\Marshaller::one() */ public function newEntity(array $data, array $options = []): EntityInterface @@ -2989,7 +3024,7 @@ public function newEntity(array $data, array $options = []): EntityInterface * * @param array $data The data to build an entity with. * @param array $options A list of options for the objects hydration. - * @return array<\Cake\Datasource\EntityInterface> An array of hydrated records. + * @return array An array of hydrated records. */ public function newEntities(array $data, array $options = []): array { @@ -3042,11 +3077,12 @@ public function newEntities(array $data, array $options = []): array * property will not be marked as dirty. This is an optimization to prevent unnecessary field * updates when persisting entities. * - * @param \Cake\Datasource\EntityInterface $entity the entity that will get the + * @template TPatchedEntity of \Cake\Datasource\EntityInterface + * @param TPatchedEntity $entity the entity that will get the * data merged in * @param array $data key value list of fields to be merged into the entity * @param array $options A list of options for the object hydration. - * @return \Cake\Datasource\EntityInterface + * @return TPatchedEntity * @see \Cake\ORM\Marshaller::merge() */ public function patchEntity(EntityInterface $entity, array $data, array $options = []): EntityInterface @@ -3081,11 +3117,12 @@ public function patchEntity(EntityInterface $entity, array $data, array $options * You can use the `Model.beforeMarshal` event to modify request data * before it is converted into entities. * - * @param iterable<\Cake\Datasource\EntityInterface> $entities the entities that will get the + * @template TPatchedEntity of \Cake\Datasource\EntityInterface + * @param iterable $entities the entities that will get the * data merged in * @param array $data list of arrays to be merged into the entities * @param array $options A list of options for the objects hydration. - * @return array<\Cake\Datasource\EntityInterface> + * @return array */ public function patchEntities(iterable $entities, array $data, array $options = []): array { @@ -3247,14 +3284,17 @@ public function buildRules(RulesChecker $rules): RulesChecker * * The properties for the associations to be loaded will be overwritten on each entity. * - * @param \Cake\Datasource\EntityInterface|array<\Cake\Datasource\EntityInterface> $entities a single entity or list of entities + * @param TEntity|array $entities a single entity or list of entities * @param array $contain A `contain()` compatible array. - * @see \Cake\ORM\Query::contain() - * @return \Cake\Datasource\EntityInterface|array<\Cake\Datasource\EntityInterface> + * @see \Cake\ORM\Query\SelectQuery::contain() + * @return TEntity|array */ public function loadInto(EntityInterface|array $entities, array $contain): EntityInterface|array { - return (new LazyEagerLoader())->loadInto($entities, $contain, $this); + /** @var TEntity|array $result */ + $result = (new LazyEagerLoader())->loadInto($entities, $contain, $this); + + return $result; } /** diff --git a/app/vendor/cakephp/cakephp/src/ORM/TableEventsTrait.php b/app/vendor/cakephp/cakephp/src/ORM/TableEventsTrait.php new file mode 100644 index 000000000..95a5b162e --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/ORM/TableEventsTrait.php @@ -0,0 +1,208 @@ + $event Model event. + * @param \ArrayObject $data Data to be saved. + * @param \ArrayObject $options Options. + * @return void + */ + public function beforeMarshal(EventInterface $event, ArrayObject $data, ArrayObject $options): void + { + } + + /** + * The Model.afterMarshal event is fired after request data is converted into entities. + * Event handlers will get the converted entities, original request data and the options provided + * to the patchEntity() or newEntity() call. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity The entity to be saved. + * @param \ArrayObject $data Data to be saved. + * @param \ArrayObject $options Options. + * @return void + */ + public function afterMarshal( + EventInterface $event, + EntityInterface $entity, + ArrayObject $data, + ArrayObject $options, + ): void { + } + + /** + * The Model.buildValidator event is fired when $name validator is created. + * Behaviors, can use this hook to add in validation methods. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Validation\Validator $validator Validator. + * @param string $name Name. + * @return void + */ + public function buildValidator(EventInterface $event, Validator $validator, string $name): void + { + } + + /** + * The Model.beforeFind event is fired before each find operation. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\ORM\Query\SelectQuery $query Query. + * @param \ArrayObject $options Options. + * @param bool $primary `true` if it is the root query, `false` if it is the associated query. + * @return void + */ + public function beforeFind(EventInterface $event, SelectQuery $query, ArrayObject $options, bool $primary): void + { + } + + /** + * The Model.beforeSave event is fired before each entity is saved. + * Stopping this event will abort the save operation. + * When the event is stopped the result of the event will be returned. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity The entity to be saved. + * @param \ArrayObject $options Options. + * @return void + */ + public function beforeSave(EventInterface $event, EntityInterface $entity, ArrayObject $options): void + { + } + + /** + * The Model.afterSave event is fired after an entity is saved. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity Saved entity. + * @param \ArrayObject $options Options. + * @return void + */ + public function afterSave(EventInterface $event, EntityInterface $entity, ArrayObject $options): void + { + } + + /** + * The Model.afterSaveCommit event is fired after the transaction in which the save operation is wrapped has been + * committed. It’s also triggered for non atomic saves where database operations are implicitly committed. The event + * is triggered only for the primary table on which save() is directly called. The event is not triggered if a + * transaction is started before calling save. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity Saved entity. + * @param \ArrayObject $options Options. + * @return void + */ + public function afterSaveCommit(EventInterface $event, EntityInterface $entity, ArrayObject $options): void + { + } + + /** + * The Model.beforeDelete event is fired before an entity is deleted. + * By stopping this event you will abort the delete operation. + * When the event is stopped the result of the event will be returned. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity Entity to be deleted. + * @param \ArrayObject $options Options. + * @return void + */ + public function beforeDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options): void + { + } + + /** + * The Model.afterDelete event is fired after an entity has been deleted. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity Deleted entity. + * @param \ArrayObject $options Options. + * @return void + */ + public function afterDelete(EventInterface $event, EntityInterface $entity, ArrayObject $options): void + { + } + + /** + * The Model.afterDeleteCommit event is fired after the transaction in which the delete operation is wrapped has + * been committed. It's also triggered for non atomic deletes where database operations are implicitly committed. + * The event is triggered only for the primary table on which delete() is directly called. The event is not + * triggered if a transaction is started before calling delete. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity Deleted entity. + * @param \ArrayObject $options Options. + * @return void + */ + public function afterDeleteCommit(EventInterface $event, EntityInterface $entity, ArrayObject $options): void + { + } + + /** + * The Model.beforeRules event is fired before an entity has had rules applied. + * By stopping this event, you can halt the rules checking and set the result of applying rules. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity The entity to be saved. + * @param \ArrayObject $options Options. + * @param string $operation Operation. + * @return void + */ + public function beforeRules( + EventInterface $event, + EntityInterface $entity, + ArrayObject $options, + string $operation, + ): void { + } + + /** + * The Model.afterRules event is fired after an entity has rules applied. + * By stopping this event, you can return the final value of the rules checking operation. + * + * @param \Cake\Event\EventInterface<\Cake\ORM\Table> $event Model event. + * @param \Cake\Datasource\EntityInterface $entity The entity to be saved. + * @param \ArrayObject $options Options. + * @param bool $result Result. + * @param string $operation Operation. + * @return void + */ + public function afterRules( + EventInterface $event, + EntityInterface $entity, + ArrayObject $options, + bool $result, + string $operation, + ): void { + } +} diff --git a/app/vendor/cakephp/cakephp/src/ORM/composer.json b/app/vendor/cakephp/cakephp/src/ORM/composer.json index c3f67a12f..7e7050187 100644 --- a/app/vendor/cakephp/cakephp/src/ORM/composer.json +++ b/app/vendor/cakephp/cakephp/src/ORM/composer.json @@ -23,18 +23,18 @@ "source": "https://github.com/cakephp/orm" }, "require": { - "php": ">=8.1", - "cakephp/collection": "5.2.*@dev", - "cakephp/core": "5.2.*@dev", - "cakephp/datasource": "5.2.*@dev", - "cakephp/database": "5.2.*@dev", - "cakephp/event": "5.2.*@dev", - "cakephp/utility": "5.2.*@dev", - "cakephp/validation": "5.2.*@dev" + "php": ">=8.2", + "cakephp/collection": "^5.3.0", + "cakephp/core": "^5.3.0", + "cakephp/datasource": "^5.3.0", + "cakephp/database": "^5.3.0", + "cakephp/event": "^5.3.0", + "cakephp/utility": "^5.3.0", + "cakephp/validation": "^5.3.0" }, "require-dev": { - "cakephp/cache": "5.2.*@dev", - "cakephp/i18n": "5.2.*@dev" + "cakephp/cache": "^5.3.0", + "cakephp/i18n": "^5.3.0" }, "autoload": { "psr-4": { @@ -48,10 +48,11 @@ "cakephp/cache": "If you decide to use Query caching.", "cakephp/i18n": "If you are using Translate/TimestampBehavior or Chronos types." }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Routing/Exception/DuplicateNamedRouteException.php b/app/vendor/cakephp/cakephp/src/Routing/Exception/DuplicateNamedRouteException.php index 6ef184978..9c20616bc 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/Exception/DuplicateNamedRouteException.php +++ b/app/vendor/cakephp/cakephp/src/Routing/Exception/DuplicateNamedRouteException.php @@ -18,7 +18,7 @@ use Throwable; /** - * Exception raised when a route names used twice. + * Exception raised when a route name is used twice. */ class DuplicateNamedRouteException extends CakeException { diff --git a/app/vendor/cakephp/cakephp/src/Routing/Middleware/AssetMiddleware.php b/app/vendor/cakephp/cakephp/src/Routing/Middleware/AssetMiddleware.php index 0bbce0e55..068c16552 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/Middleware/AssetMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Routing/Middleware/AssetMiddleware.php @@ -20,6 +20,7 @@ use Cake\Core\Plugin; use Cake\Http\MimeType; use Cake\Http\Response; +use Cake\I18n\DateTime; use Cake\Utility\Inflector; use Laminas\Diactoros\Stream; use Psr\Http\Message\ResponseInterface; @@ -162,13 +163,15 @@ protected function deliverAsset(ServerRequestInterface $request, SplFileInfo $fi if ($expire === false) { throw new CakeException(sprintf('Invalid cache time value `%s`', $this->cacheTime)); } - $maxAge = $expire - time(); + + $now = time(); + $maxAge = $expire - $now; return $response ->withHeader('Content-Type', $contentType) ->withHeader('Cache-Control', 'public,max-age=' . $maxAge) - ->withHeader('Date', gmdate(CAKE_DATE_RFC7231, time())) - ->withHeader('Last-Modified', gmdate(CAKE_DATE_RFC7231, $modified)) - ->withHeader('Expires', gmdate(CAKE_DATE_RFC7231, $expire)); + ->withHeader('Date', DateTime::parse($now)->toRfc7231String()) + ->withHeader('Last-Modified', DateTime::parse($modified)->toRfc7231String()) + ->withHeader('Expires', DateTime::parse($expire)->toRfc7231String()); } } diff --git a/app/vendor/cakephp/cakephp/src/Routing/Middleware/RoutingMiddleware.php b/app/vendor/cakephp/cakephp/src/Routing/Middleware/RoutingMiddleware.php index a5232e573..939ebc4ea 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/Middleware/RoutingMiddleware.php +++ b/app/vendor/cakephp/cakephp/src/Routing/Middleware/RoutingMiddleware.php @@ -40,6 +40,7 @@ class RoutingMiddleware implements MiddlewareInterface * Key used to store the route collection in the cache engine * * @var string + * @deprecated 5.3.0 This constant is no longer used. */ public const ROUTE_COLLECTION_CACHE_KEY = 'routeCollection'; diff --git a/app/vendor/cakephp/cakephp/src/Routing/Route/RedirectRoute.php b/app/vendor/cakephp/cakephp/src/Routing/Route/RedirectRoute.php index 4621c332f..9f51611b3 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/Route/RedirectRoute.php +++ b/app/vendor/cakephp/cakephp/src/Routing/Route/RedirectRoute.php @@ -16,9 +16,6 @@ */ namespace Cake\Routing\Route; -use Cake\Http\Exception\RedirectException; -use Cake\Routing\Router; - /** * Redirect route will perform an immediate redirect. Redirect routes * are useful when you want to have Routing layer redirects occur in your @@ -29,89 +26,5 @@ */ class RedirectRoute extends Route { - /** - * The location to redirect to. - * - * @var array - */ - public array $redirect; - - /** - * Constructor - * - * @param string $template Template string with parameter placeholders - * @param array $defaults Defaults for the route. Either a redirect=>value array or a CakePHP array URL. - * @param array $options Array of additional options for the Route - */ - public function __construct(string $template, array $defaults = [], array $options = []) - { - parent::__construct($template, $defaults, $options); - if (isset($defaults['redirect'])) { - $defaults = (array)$defaults['redirect']; - } - $this->redirect = $defaults; - } - - /** - * Parses a string URL into an array. Parsed URLs will result in an automatic - * redirection. - * - * @param string $url The URL to parse. - * @param string $method The HTTP method being used. - * @return array|null Null on failure. An exception is raised on a successful match. Array return type is unused. - * @throws \Cake\Http\Exception\RedirectException An exception is raised on successful match. - * This is used to halt route matching and signal to the middleware that a redirect should happen. - */ - public function parse(string $url, string $method = ''): ?array - { - $params = parent::parse($url, $method); - if (!$params) { - return null; - } - $redirect = $this->redirect; - if ($this->redirect && count($this->redirect) === 1 && !isset($this->redirect['controller'])) { - $redirect = $this->redirect[0]; - } - if (isset($this->options['persist']) && is_array($redirect)) { - $redirect += ['pass' => $params['pass'], 'url' => []]; - if (is_array($this->options['persist'])) { - foreach ($this->options['persist'] as $elem) { - if (isset($params[$elem])) { - $redirect[$elem] = $params[$elem]; - } - } - } - $redirect = Router::reverseToArray($redirect); - } - $status = 301; - if (isset($this->options['status']) && ($this->options['status'] >= 300 && $this->options['status'] < 400)) { - $status = $this->options['status']; - } - throw new RedirectException(Router::url($redirect, true), $status); - } - - /** - * There is no reverse routing redirection routes. - * - * @param array $url Array of parameters to convert to a string. - * @param array $context Array of request context parameters. - * @return string|null Always null, string return result unused. - */ - public function match(array $url, array $context = []): ?string - { - return null; - } - - /** - * Sets the HTTP status - * - * @param int $status The status code for this route - * @return $this - */ - public function setStatus(int $status) - { - $this->options['status'] = $status; - - return $this; - } + use RedirectTrait; } diff --git a/app/vendor/cakephp/cakephp/src/Routing/Route/RedirectTrait.php b/app/vendor/cakephp/cakephp/src/Routing/Route/RedirectTrait.php new file mode 100644 index 000000000..1d6368f7e --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/Routing/Route/RedirectTrait.php @@ -0,0 +1,121 @@ +value array or a CakePHP array URL. + * @param array $options Array of additional options for the Route + */ + public function __construct(string $template, array $defaults = [], array $options = []) + { + parent::__construct($template, $defaults, $options); + if (isset($defaults['redirect'])) { + $defaults = (array)$defaults['redirect']; + } + $this->redirect = $defaults; + } + + /** + * Parses a string URL into an array. Parsed URLs will result in an automatic + * redirection. + * + * @param string $url The URL to parse. + * @param string $method The HTTP method being used. + * @return array|null Null on failure. An exception is raised on a successful match. Array return type is unused. + * @throws \Cake\Http\Exception\RedirectException An exception is raised on successful match. + * This is used to halt route matching and signal to the middleware that a redirect should happen. + */ + public function parse(string $url, string $method = ''): ?array + { + $params = parent::parse($url, $method); + if (!$params) { + return null; + } + $redirect = $this->redirect; + if (count($redirect) === 1 && !isset($redirect['controller'])) { + $redirect = $redirect[0]; + } + if (isset($this->options['persist']) && is_array($redirect)) { + $redirect += ['pass' => $params['pass'], 'url' => []]; + if (is_array($this->options['persist'])) { + foreach ($this->options['persist'] as $elem) { + if (isset($params[$elem])) { + $redirect[$elem] = $params[$elem]; + } + } + } + $redirect = Router::reverseToArray($redirect); + } + $status = 301; + if (isset($this->options['status']) && ($this->options['status'] >= 300 && $this->options['status'] < 400)) { + $status = $this->options['status']; + } + throw new RedirectException(Router::url($redirect, true), $status); + } + + /** + * There is no reverse routing redirection routes. + * + * @param array $url Array of parameters to convert to a string. + * @param array $context Array of request context parameters. + * @return string|null Always null, string return result unused. + */ + public function match(array $url, array $context = []): ?string + { + return null; + } + + /** + * Sets the HTTP status + * + * @param int $status The status code for this route + * @return $this + */ + public function setStatus(int $status) + { + $this->options['status'] = $status; + + return $this; + } +} diff --git a/app/vendor/cakephp/cakephp/src/Routing/Route/Route.php b/app/vendor/cakephp/cakephp/src/Routing/Route/Route.php index 2f7606b1b..e513a788e 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/Route/Route.php +++ b/app/vendor/cakephp/cakephp/src/Routing/Route/Route.php @@ -16,10 +16,12 @@ */ namespace Cake\Routing\Route; +use BackedEnum; use Cake\Core\Exception\CakeException; use Cake\Http\Exception\BadRequestException; use InvalidArgumentException; use Psr\Http\Message\ServerRequestInterface; +use UnitEnum; /** * A single Route used by the Router to connect requests to @@ -701,8 +703,19 @@ public function match(array $url, array $context = []): ?string unset($url['_method'], $url['[method]'], $defaults['_method']); // Defaults with different values are a fail. - if (array_intersect_key($url, $defaults) != $defaults) { - return null; + // Check each default value against the URL, but skip null plugin/prefix + // values as they should be treated as "not set" for matching purposes + foreach ($defaults as $key => $val) { + // Skip null plugin/prefix values - they shouldn't affect matching + if (($key === 'plugin' || $key === 'prefix') && $val === null && !isset($url[$key])) { + continue; + } + if (isset($url[$key]) && $url[$key] != $val) { + return null; + } + if (!isset($url[$key]) && $val !== null) { + return null; + } } // If this route uses pass option, and the passed elements are @@ -817,6 +830,12 @@ protected function _writeUrl(array $params, array $pass = [], array $query = []) )); } $string = $params[$key]; + if ($string instanceof BackedEnum) { + $string = $string->value; + } elseif ($string instanceof UnitEnum) { + $string = $string->name; + } + $search[] = "{{$key}}"; $replace[] = $string; } diff --git a/app/vendor/cakephp/cakephp/src/Routing/RouteBuilder.php b/app/vendor/cakephp/cakephp/src/Routing/RouteBuilder.php index 817bd659e..022b14f04 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/RouteBuilder.php +++ b/app/vendor/cakephp/cakephp/src/Routing/RouteBuilder.php @@ -109,6 +109,13 @@ class RouteBuilder */ protected array $middleware = []; + /** + * Default route options to apply to all routes created in this builder. + * + * @var array + */ + protected array $defaultOptions = []; + /** * Constructor * @@ -206,6 +213,34 @@ public function addExtensions(array|string $extensions) return $this; } + /** + * Set default options for all routes created in this builder. + * + * These options will be merged with options passed to connect() calls. + * Options passed to connect() will take precedence. + * + * Useful for setting options like `_host`, `_https`, `_port` that should + * apply to all routes within a scope. + * + * Example: + * + * ``` + * $routes->scope('/{org}', function ($routes) { + * $routes->setOptions(['_host' => 'example.com']); + * // All routes here will have _host => 'example.com' + * }); + * ``` + * + * @param array $options Default route options like _host, _https, _port, etc. + * @return $this + */ + public function setOptions(array $options) + { + $this->defaultOptions = $options; + + return $this; + } + /** * Get the path this scope is for. * @@ -549,7 +584,7 @@ protected function _methodRoute(string $method, string $template, array|string $ '_ext' => $this->_extensions, '_middleware' => $this->middleware, 'routeClass' => $this->_routeClass, - ]; + ] + $this->defaultOptions; $target = $this->parseDefaults($target); $target['_method'] = $method; @@ -671,6 +706,8 @@ public function loadPlugin(string $name) public function connect(Route|string $route, array|string $defaults = [], array $options = []): Route { $defaults = $this->parseDefaults($defaults); + $options += $this->defaultOptions; + if (empty($options['_ext'])) { $options['_ext'] = $this->_extensions; } @@ -938,6 +975,8 @@ public function scope(string $path, Closure|array $params, ?Closure $callback = 'namePrefix' => $namePrefix, 'middleware' => $this->middleware, ]); + // Inherit default options from parent scope + $builder->defaultOptions = $this->defaultOptions; $callback($builder); return $this; @@ -987,11 +1026,10 @@ public function registerMiddleware(string $name, MiddlewareInterface|Closure|str * @param string ...$names The names of the middleware to apply to the current scope. * @return $this * @throws \InvalidArgumentException If it cannot apply one of the given middleware or middleware groups. - * @see \Cake\Routing\RouteCollection::addMiddlewareToScope() + * @see \Cake\Routing\RouteCollection::registerMiddleware() */ public function applyMiddleware(string ...$names) { - /** @var array $names */ foreach ($names as $name) { if (!$this->_collection->middlewareExists($name)) { $message = "Cannot apply `{$name}` middleware or middleware group. " . diff --git a/app/vendor/cakephp/cakephp/src/Routing/RouteCollection.php b/app/vendor/cakephp/cakephp/src/Routing/RouteCollection.php index 83bb49a0a..ecec092a0 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/RouteCollection.php +++ b/app/vendor/cakephp/cakephp/src/Routing/RouteCollection.php @@ -137,7 +137,7 @@ public function parseRequest(ServerRequestInterface $request): array { $uri = $request->getUri(); $urlPath = $uri->getPath(); - if (strpos($urlPath, '%') !== false) { + if (str_contains($urlPath, '%')) { // decode urlencoded segments, but don't decode %2f aka / $parts = explode('/', $urlPath); $parts = array_map( diff --git a/app/vendor/cakephp/cakephp/src/Routing/Router.php b/app/vendor/cakephp/cakephp/src/Routing/Router.php index 4e4b5385a..e13b79bc5 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/Router.php +++ b/app/vendor/cakephp/cakephp/src/Routing/Router.php @@ -186,7 +186,7 @@ public static function getNamedExpressions(): array } /** - * Get the routing parameters for the request is possible. + * Get the routing parameters for the request if possible. * * @param \Cake\Http\ServerRequest $request The request to parse request data from. * @return array Parsed elements from URL. @@ -342,7 +342,7 @@ protected static function _applyUrlFilters(array $url): array * ### Usage * * - `Router::url('/posts/edit/1');` Returns the string with the base dir prepended. - * This usage does not use reverser routing. + * This usage does not use reverse routing. * - `Router::url(['controller' => 'Posts', 'action' => 'edit']);` Returns a URL * generated through reverse routing. * - `Router::url(['_name' => 'custom-name', ...]);` Returns a URL generated @@ -351,21 +351,20 @@ protected static function _applyUrlFilters(array $url): array * There are a few 'special' parameters that can change the final URL string that is generated * * - `_base` - Set to false to remove the base path from the generated URL. If your application - * is not in the root directory, this can be used to generate URLs that are 'cake relative'. - * cake relative URLs are required when using requestAction. + * is not in the root directory, this can be used to generate URLs that are "cake relative". * - `_scheme` - Set to create links on different schemes like `webcal` or `ftp`. Defaults * to the current scheme. * - `_host` - Set the host to use for the link. Defaults to the current host. * - `_port` - Set the port if you need to create links on non-standard ports. * - `_full` - If true output of `Router::fullBaseUrl()` will be prepended to generated URLs. - * - `#` - Allows you to set URL hash fragments. * - `_https` - Set to true to convert the generated URL to https, or false to force http. * - `_name` - Name of route. If you have setup named routes you can use this key * to specify it. + * - `#` - Allows you to set URL hash fragments. * * @param \Psr\Http\Message\UriInterface|array|string|null $url An array specifying any of the following: * 'controller', 'action', 'plugin' additionally, you can provide routed - * elements or query string parameters. If string it can be name any valid url + * elements or query string parameters. If string it can be any valid url * string or it can be an UriInterface instance. * @param bool $full If true, the full base URL will be prepended to the result. * Default is false. @@ -513,7 +512,7 @@ public static function pathUrl(string $path, array $params = [], bool $full = fa * @see Router::url() * @param array|string|null $url An array specifying any of the following: * 'controller', 'action', 'plugin' additionally, you can provide routed - * elements or query string parameters. If string it can be name any valid url + * elements or query string parameters. If string it can be any valid url * string. * @param bool $full If true, the full base URL will be prepended to the result. * Default is false. diff --git a/app/vendor/cakephp/cakephp/src/Routing/functions.php b/app/vendor/cakephp/cakephp/src/Routing/functions.php index 65724f02e..1c340ccf6 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/functions.php +++ b/app/vendor/cakephp/cakephp/src/Routing/functions.php @@ -44,7 +44,7 @@ function urlArray(string $path, array $params = []): array * * @param \Psr\Http\Message\UriInterface|array|string|null $url An array specifying any of the following: * 'controller', 'action', 'plugin' additionally, you can provide routed - * elements or query string parameters. If string it can be name any valid url + * elements or query string parameters. If string it can be any valid url * string or it can be an UriInterface instance. * @param bool $full If true, the full base URL will be prepended to the result. * Default is false. diff --git a/app/vendor/cakephp/cakephp/src/Routing/functions_global.php b/app/vendor/cakephp/cakephp/src/Routing/functions_global.php index b893ebd82..ad009f95a 100644 --- a/app/vendor/cakephp/cakephp/src/Routing/functions_global.php +++ b/app/vendor/cakephp/cakephp/src/Routing/functions_global.php @@ -26,7 +26,7 @@ * * @param \Psr\Http\Message\UriInterface|array|string|null $url An array specifying any of the following: * 'controller', 'action', 'plugin' additionally, you can provide routed - * elements or query string parameters. If string it can be name any valid url + * elements or query string parameters. If string it can be any valid url * string or it can be an UriInterface instance. * @param bool $full If true, the full base URL will be prepended to the result. * Default is false. diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/ConnectionHelper.php b/app/vendor/cakephp/cakephp/src/TestSuite/ConnectionHelper.php index be96b8d16..0ec8d64a3 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/ConnectionHelper.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/ConnectionHelper.php @@ -23,8 +23,6 @@ /** * Helper for managing test connections - * - * @internal */ class ConnectionHelper { @@ -71,10 +69,10 @@ public static function enableQueryLogging(?array $connections = null): void $message = '--Starting test run ' . date('Y-m-d H:i:s'); if ( $connection instanceof Connection && - $connection->getDriver()->log($message) === false + $connection->getWriteDriver()->log($message) === false ) { - $connection->getDriver()->setLogger(new QueryLogger()); - $connection->getDriver()->log($message); + $connection->getWriteDriver()->setLogger(new QueryLogger()); + $connection->getWriteDriver()->log($message); } } } @@ -100,9 +98,9 @@ public static function dropTables(string $connectionName, ?array $tables = null) $tables = $tables !== null ? array_intersect($tables, $allTables) : $allTables; /** @var array<\Cake\Database\Schema\TableSchema> $schemas Specify type for psalm */ - $schemas = array_map(fn($table) => $collection->describe($table), $tables); + $schemas = array_map(fn(string $table) => $collection->describe($table), $tables); - $dialect = $connection->getDriver()->schemaDialect(); + $dialect = $connection->getWriteDriver()->schemaDialect(); foreach ($schemas as $schema) { foreach ($dialect->dropConstraintSql($schema) as $statement) { $connection->execute($statement); @@ -131,10 +129,10 @@ public static function truncateTables(string $connectionName, ?array $tables = n $allTables = $collection->listTablesWithoutViews(); $tables = $tables !== null ? array_intersect($tables, $allTables) : $allTables; /** @var array<\Cake\Database\Schema\TableSchema> $schemas Specify type for psalm */ - $schemas = array_map(fn($table) => $collection->describe($table), $tables); + $schemas = array_map(fn(string $table) => $collection->describe($table), $tables); self::runWithoutConstraints($connection, function (Connection $connection) use ($schemas): void { - $dialect = $connection->getDriver()->schemaDialect(); + $dialect = $connection->getWriteDriver()->schemaDialect(); foreach ($schemas as $schema) { foreach ($dialect->truncateTableSql($schema) as $statement) { $connection->execute($statement); @@ -152,7 +150,7 @@ public static function truncateTables(string $connectionName, ?array $tables = n */ public static function runWithoutConstraints(Connection $connection, Closure $callback): void { - if ($connection->getDriver()->supports(DriverFeatureEnum::DISABLE_CONSTRAINT_WITHOUT_TRANSACTION)) { + if ($connection->getWriteDriver()->supports(DriverFeatureEnum::DISABLE_CONSTRAINT_WITHOUT_TRANSACTION)) { $connection->disableConstraints(fn(Connection $connection) => $callback($connection)); } else { $connection->transactional(function (Connection $connection) use ($callback): void { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailConstraintBase.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailConstraintBase.php index 3021c0c44..72eca231c 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailConstraintBase.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailConstraintBase.php @@ -35,7 +35,6 @@ abstract class MailConstraintBase extends Constraint * Constructor * * @param int|null $at At - * @return void */ public function __construct(?int $at = null) { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailSentWith.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailSentWith.php index be3badc83..50b9ef081 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailSentWith.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Email/MailSentWith.php @@ -33,7 +33,6 @@ class MailSentWith extends MailConstraintBase * * @param int|null $at At * @param string|null $method Method - * @return void */ public function __construct(?int $at = null, ?string $method = null) { @@ -60,7 +59,7 @@ public function matches(mixed $other): bool } if ( !is_array($other) - && in_array($this->method, ['to', 'cc', 'bcc', 'from', 'replyTo', 'sender']) + && in_array($this->method, ['to', 'cc', 'bcc', 'from', 'replyTo', 'sender'], true) && array_key_exists($other, $value) ) { return true; diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/EventFiredWith.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/EventFiredWith.php index e0515b08f..47631e490 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/EventFiredWith.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/EventFiredWith.php @@ -66,21 +66,16 @@ public function __construct(EventManager $eventManager, string $dataKey, mixed $ */ public function matches(mixed $other): bool { - $firedEvents = []; + $eventGroup = []; $list = $this->_eventManager->getEventList(); if ($list !== null) { - $totalEvents = count($list); - for ($e = 0; $e < $totalEvents; $e++) { - $firedEvents[] = $list[$e]; - } + $eventGroup = (new Collection($list)) + ->groupBy(function (EventInterface $event): string { + return $event->getName(); + }) + ->toArray(); } - $eventGroup = (new Collection($firedEvents)) - ->groupBy(function (EventInterface $event): string { - return $event->getName(); - }) - ->toArray(); - if (!array_key_exists($other, $eventGroup)) { return false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyContains.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyContains.php index b9f7ede17..19126a1bb 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyContains.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyContains.php @@ -47,9 +47,8 @@ public function __construct(ResponseInterface $response, bool $ignoreCase = fals * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { $method = 'mb_strpos'; if ($this->ignoreCase) { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEmpty.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEmpty.php index 0ce51b2b9..d56cdcc0c 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEmpty.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEmpty.php @@ -27,9 +27,8 @@ class BodyEmpty extends ResponseBase * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return empty($this->_getBodyAsString()); } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEquals.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEquals.php index f030c9690..174fede32 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEquals.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyEquals.php @@ -27,9 +27,8 @@ class BodyEquals extends ResponseBase * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return $this->_getBodyAsString() === $other; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotContains.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotContains.php index 14e0c4668..692d32b9a 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotContains.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotContains.php @@ -27,9 +27,8 @@ class BodyNotContains extends BodyContains * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return parent::matches($other) === false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEmpty.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEmpty.php index 1d12afd6b..d51cf9f4a 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEmpty.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEmpty.php @@ -27,9 +27,8 @@ class BodyNotEmpty extends BodyEmpty * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return parent::matches($other) === false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEquals.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEquals.php index 4dd19e9c9..3ef953aa2 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEquals.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotEquals.php @@ -27,9 +27,8 @@ class BodyNotEquals extends BodyEquals * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return parent::matches($other) === false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotRegExp.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotRegExp.php index d270053be..249910031 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotRegExp.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyNotRegExp.php @@ -27,9 +27,8 @@ class BodyNotRegExp extends BodyRegExp * * @param mixed $other Expected pattern * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return parent::matches($other) === false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyRegExp.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyRegExp.php index 49992a275..5ea14831d 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyRegExp.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/BodyRegExp.php @@ -27,9 +27,8 @@ class BodyRegExp extends ResponseBase * * @param mixed $other Expected pattern * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return preg_match($other, $this->_getBodyAsString()) > 0; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/ContentType.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/ContentType.php index 320cd56b6..3d9e91214 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/ContentType.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/ContentType.php @@ -35,9 +35,8 @@ class ContentType extends ResponseBase * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { $mimeType = MimeType::getMimeType($other); if ($mimeType !== null) { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEncryptedEquals.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEncryptedEquals.php index 163b69c65..13e747035 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEncryptedEquals.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEncryptedEquals.php @@ -64,9 +64,8 @@ public function __construct(?Response $response, string $cookieName, string $mod * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { $cookie = $this->response->getCookie($this->cookieName); diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEquals.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEquals.php index b17f7ee93..67f5d7653 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEquals.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieEquals.php @@ -53,9 +53,8 @@ public function __construct(?Response $response, string $cookieName) * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { $cookie = $this->readCookie($this->cookieName); diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieNotSet.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieNotSet.php index 6bead8591..b30043772 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieNotSet.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieNotSet.php @@ -27,9 +27,8 @@ class CookieNotSet extends CookieSet * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return parent::matches($other) === false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieSet.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieSet.php index 202f66a3a..a48ebd5f4 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieSet.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/CookieSet.php @@ -34,9 +34,8 @@ class CookieSet extends ResponseBase * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { $cookie = $this->readCookie($other); diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSent.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSent.php index 076e96e68..9fa21d37c 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSent.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSent.php @@ -34,9 +34,8 @@ class FileSent extends ResponseBase * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return $this->response->getFile() !== null; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSentAs.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSentAs.php index 09acde831..1d9e5eec8 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSentAs.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/FileSentAs.php @@ -34,9 +34,8 @@ class FileSentAs extends ResponseBase * * @param mixed $other Expected type * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { $file = $this->response->getFile(); if (!$file) { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderContains.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderContains.php index 658f3a6a0..eee9edf4d 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderContains.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderContains.php @@ -27,9 +27,8 @@ class HeaderContains extends HeaderEquals * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return mb_strpos($this->response->getHeaderLine($this->headerName), $other) !== false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderEquals.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderEquals.php index 461f788b0..53410bc03 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderEquals.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderEquals.php @@ -47,9 +47,8 @@ public function __construct(ResponseInterface $response, string $headerName) * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return $this->response->getHeaderLine($this->headerName) === $other; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotContains.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotContains.php index 3929c7dfd..4b1ab9cc9 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotContains.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotContains.php @@ -27,9 +27,8 @@ class HeaderNotContains extends HeaderContains * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return parent::matches($other) === false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotSet.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotSet.php index f38b7e749..e11ee4b2a 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotSet.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderNotSet.php @@ -27,9 +27,8 @@ class HeaderNotSet extends HeaderSet * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return parent::matches($other) === false; } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderSet.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderSet.php index 073b6e145..2989038e1 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderSet.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/HeaderSet.php @@ -47,9 +47,8 @@ public function __construct(?ResponseInterface $response, string $headerName) * * @param mixed $other Expected content * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { return $this->response->hasHeader($this->headerName); } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/StatusCodeBase.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/StatusCodeBase.php index 2342368f3..bd50177bd 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/StatusCodeBase.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Response/StatusCodeBase.php @@ -32,9 +32,8 @@ abstract class StatusCodeBase extends ResponseBase * * @param array|int $other Array of min/max status codes, or a single code * @return bool - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint */ - public function matches($other): bool + public function matches(mixed $other): bool { if (!$other) { $other = $this->code; diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Session/FlashParamContains.php b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Session/FlashParamContains.php new file mode 100644 index 000000000..39f815a1f --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Constraint/Session/FlashParamContains.php @@ -0,0 +1,130 @@ +enableRetainFlashMessages()` has been enabled for the test.'; + throw new AssertionFailedError($message); + } + + $this->session = $session; + $this->key = $key; + $this->param = $param; + $this->at = $at; + $this->ignoreCase = $ignoreCase; + } + + /** + * Compare to flash message(s) using contains logic + * + * @param mixed $other Value to compare with + * @return bool + */ + public function matches(mixed $other): bool + { + // Server::run calls Session::close at the end of the request. + // Which means, that we cannot use Session object here to access the session data. + // Call to Session::read will start new session (and will erase the data). + $messages = (array)Hash::get($_SESSION, 'Flash.' . $this->key); + if ($this->at !== null) { + $messages = [Hash::get($_SESSION, 'Flash.' . $this->key . '.' . $this->at)]; + } + + $method = 'mb_strpos'; + if ($this->ignoreCase) { + $method = 'mb_stripos'; + } + + foreach ($messages as $message) { + if (!isset($message[$this->param])) { + continue; + } + if ($method($message[$this->param], $other) !== false) { + return true; + } + } + + return false; + } + + /** + * Assertion message string + * + * @return string + */ + public function toString(): string + { + if ($this->at !== null) { + return sprintf("contains in '%s' %s #%d", $this->key, $this->param, $this->at); + } + + return sprintf("contains in '%s' %s", $this->key, $this->param); + } +} diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/FixtureHelper.php b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/FixtureHelper.php index 58d4bb9f8..597f8f63f 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/FixtureHelper.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/FixtureHelper.php @@ -90,10 +90,7 @@ public function loadFixtures(array $fixtureNames): array throw new UnexpectedValueException(sprintf('Could not find fixture `%s`.', $fixtureName)); } - if (!isset($cachedFixtures[$className])) { - $cachedFixtures[$className] = new $className(); - } - + $cachedFixtures[$className] ??= new $className(); $fixtures[$className] = $cachedFixtures[$className]; } @@ -186,7 +183,7 @@ public function truncate(array $fixtures): void $this->runPerConnection(function (ConnectionInterface $connection, array $groupFixtures): void { if ($connection instanceof Connection) { $sortedFixtures = null; - if ($connection->getDriver()->supports(DriverFeatureEnum::TRUNCATE_WITH_CONSTRAINTS)) { + if ($connection->getWriteDriver()->supports(DriverFeatureEnum::TRUNCATE_WITH_CONSTRAINTS)) { $sortedFixtures = $this->sortByConstraint($connection, $groupFixtures); } @@ -283,7 +280,7 @@ protected function getForeignReferences(Connection $connection, FixtureInterface $references = []; foreach ($schema->constraints() as $constraintName) { - $constraint = $schema->getConstraint($constraintName); + $constraint = $schema->getConstraint((string)$constraintName); if ($constraint && $constraint['type'] === TableSchema::CONSTRAINT_FOREIGN) { $references[] = $constraint['references'][0]; diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/SchemaLoader.php b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/SchemaLoader.php index 17bae5580..09de58c64 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/SchemaLoader.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/SchemaLoader.php @@ -74,7 +74,7 @@ public function loadSqlFiles( // Use the underlying PDO connection so we can avoid prepared statements // which don't support multiple queries in postgres. - $driver = $connection->getDriver(); + $driver = $connection->getWriteDriver(); $driver->exec($sql); } diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TestFixture.php b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TestFixture.php index c74033b9f..4697d501b 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TestFixture.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TestFixture.php @@ -16,6 +16,7 @@ namespace Cake\TestSuite\Fixture; use Cake\Core\Exception\CakeException; +use Cake\Core\Plugin; use Cake\Database\Connection; use Cake\Database\Schema\SqlGeneratorInterface; use Cake\Database\Schema\TableSchema; @@ -43,12 +44,30 @@ class TestFixture implements FixtureInterface public string $connection = 'test'; /** - * Full Table Name + * The physical database table name to use. + * + * If set, tableAlias must initially be empty. + * $tableAlias will then be inflected as Inflector::camelize($table). * * @var string */ public string $table = ''; + /** + * The ORM table alias to use. + * + * If set, table must initially be empty. + * $table will be read from the ORM table loaded via the alias. + * + * If both table and tableAlias are empty, the alias will be inflected + * from the class name using tableize() then camelize() to respect + * custom Inflector rules. For plugin fixtures, the plugin name is + * automatically prepended (e.g., `MyPlugin.Articles`). + * + * @var string + */ + public string $tableAlias = ''; + /** * Fixture records to be inserted. * @@ -114,25 +133,43 @@ public function sourceName(): string */ public function init(): void { - if (!$this->table) { - $this->table = $this->_tableFromClass(); + assert(!$this->table || !$this->tableAlias, 'Cannot configure both database table and Cake table alias.'); + if ($this->table) { + $this->tableAlias = Inflector::camelize($this->table); + } elseif (!$this->tableAlias) { + $this->tableAlias = $this->_aliasFromClass(); } $this->_schemaFromReflection(); } /** - * Returns the table name using the fixture class + * Returns the ORM table alias using the fixture class. + * + * Uses tableize() then camelize() to respect custom Inflector rules + * like uninflected words. + * + * For plugin fixtures (namespace pattern `{Plugin}\Test\Fixture\`), + * the plugin name is automatically prepended to the alias. * * @return string */ - protected function _tableFromClass(): string + protected function _aliasFromClass(): string { [, $class] = namespaceSplit(static::class); preg_match('/^(.*)Fixture$/', $class, $matches); - $table = $matches[1] ?? $class; + $name = $matches[1] ?? $class; - return Inflector::tableize($table); + $alias = Inflector::camelize(Inflector::tableize($name)); + + // Detect plugin namespace pattern: {Plugin}\Test\Fixture\... + // and prepend plugin name to alias for proper table resolution + $plugin = strstr(static::class, '\\Test\\Fixture\\', before_needle: true); + if ($plugin && Plugin::isLoaded($plugin)) { + return $plugin . '.' . $alias; + } + + return $alias; } /** @@ -146,12 +183,15 @@ protected function _schemaFromReflection(): void $db = ConnectionManager::get($this->connection()); assert($db instanceof Connection); try { - $name = Inflector::camelize($this->table); - $ormTable = $this->fetchTable($name, ['connection' => $db]); + $ormTable = $this->fetchTable($this->tableAlias, ['connection' => $db]); // Remove the fetched table from the locator to avoid conflicts // with test cases that need to (re)configure the alias. - $this->getTableLocator()->remove($name); + $this->getTableLocator()->remove($this->tableAlias); + + if (!$this->table) { + $this->table = $ormTable->getTable(); + } $schema = $ormTable->getSchema(); assert($schema instanceof TableSchema); @@ -203,7 +243,10 @@ protected function _getRecords(): array foreach ($this->records as $index => $record) { $recordFields = array_keys($record); if ($this->strictFields) { - $invalidFields = array_values(array_filter($recordFields, fn($f) => !in_array($f, $columns, true))); + $invalidFields = array_values(array_filter( + $recordFields, + fn(int|string $f) => !in_array($f, $columns, true), + )); if ($invalidFields !== []) { throw new CakeException( "Record #{$index} in fixture has additional fields that do not exist in the schema. " . diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TransactionFixtureStrategy.php b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TransactionFixtureStrategy.php deleted file mode 100644 index 4a01e9f3a..000000000 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TransactionFixtureStrategy.php +++ /dev/null @@ -1,89 +0,0 @@ - - */ - protected array $fixtures = []; - - /** - * Initialize strategy. - */ - public function __construct() - { - $this->helper = new FixtureHelper(); - } - - /** - * @inheritDoc - */ - public function setupTest(array $fixtureNames): void - { - $this->fixtures = $this->helper->loadFixtures($fixtureNames); - - $this->helper->runPerConnection(function ($connection): void { - if ($connection instanceof Connection) { - assert( - $connection->inTransaction() === false, - 'Cannot start transaction strategy inside a transaction. This is most likely a bug.', - ); - $connection->enableSavePoints(); - if (!$connection->isSavePointsEnabled()) { - throw new DatabaseException( - "Could not enable save points for the `{$connection->configName()}` connection. " . - 'Your database needs to support savepoints in order to use ' . - 'TransactionFixtureStrategy.', - ); - } - - $connection->begin(); - $connection->createSavePoint('__fixtures__'); - } - }, $this->fixtures); - - $this->helper->insert($this->fixtures); - } - - /** - * @inheritDoc - */ - public function teardownTest(): void - { - $this->helper->runPerConnection(function (Connection $connection): void { - if ($connection->inTransaction()) { - $connection->rollback(true); - } - }, $this->fixtures); - } -} diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TruncateFixtureStrategy.php b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TruncateFixtureStrategy.php deleted file mode 100644 index 9573adf3e..000000000 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TruncateFixtureStrategy.php +++ /dev/null @@ -1,58 +0,0 @@ - - */ - protected array $fixtures = []; - - /** - * Initialize strategy. - */ - public function __construct() - { - $this->helper = new FixtureHelper(); - } - - /** - * @inheritDoc - */ - public function setupTest(array $fixtureNames): void - { - $this->fixtures = $this->helper->loadFixtures($fixtureNames); - $this->helper->insert($this->fixtures); - } - - /** - * @inheritDoc - */ - public function teardownTest(): void - { - $this->helper->truncate($this->fixtures); - } -} diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TruncateStrategy.php b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TruncateStrategy.php index a2f4438bd..0b8de8e3c 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TruncateStrategy.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Fixture/TruncateStrategy.php @@ -17,7 +17,7 @@ namespace Cake\TestSuite\Fixture; /** - * Fixture strategy that truncates all fixture ables at the end of test. + * Fixture strategy that truncates all fixture tables at the end of test. */ class TruncateStrategy implements FixtureStrategyInterface { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/IntegrationTestTrait.php b/app/vendor/cakephp/cakephp/src/TestSuite/IntegrationTestTrait.php index 0cf1328a8..47525d66a 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/IntegrationTestTrait.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/IntegrationTestTrait.php @@ -54,6 +54,7 @@ use Cake\TestSuite\Constraint\Response\StatusFailure; use Cake\TestSuite\Constraint\Response\StatusOk; use Cake\TestSuite\Constraint\Response\StatusSuccess; +use Cake\TestSuite\Constraint\Session\FlashParamContains; use Cake\TestSuite\Constraint\Session\FlashParamEquals; use Cake\TestSuite\Constraint\Session\SessionEquals; use Cake\TestSuite\Constraint\Session\SessionHasKey; @@ -78,6 +79,8 @@ * It favours full integration tests over mock objects as you can test * more of your code easily and avoid some of the maintenance pitfalls * that mock objects create. + * + * @require-extends \Cake\TestSuite\TestCase */ trait IntegrationTestTrait { @@ -731,7 +734,7 @@ protected function _addTokens(string $url, array $data, string $method): array if ($this->_securityToken === true) { $fields = array_diff_key($data, array_flip($this->_unlockedFields)); - $keys = array_map(function ($field) { + $keys = array_map(function (int|string $field) { return preg_replace('/(\.\d+)+$/', '', (string)$field); }, array_keys(Hash::flatten($fields))); @@ -742,7 +745,13 @@ protected function _addTokens(string $url, array $data, string $method): array $tokenData = $formProtector->buildTokenData($url, 'cli'); $data['_Token'] = $tokenData; - $data['_Token']['debug'] = 'FormProtector debug data would be added here'; + + /** @see \Cake\Form\FormProtector::extractToken() */ + if (Configure::read('debug')) { + $data['_Token']['debug'] = 'FormProtector debug data would be added here'; + } elseif (isset($data['_Token']['debug'])) { + unset($data['_Token']['debug']); + } } if ($this->_csrfToken === true) { @@ -761,7 +770,7 @@ protected function _addTokens(string $url, array $data, string $method): array // the inverse. $this->_session[$this->_csrfKeyName] = $token; $this->_cookie[$this->_csrfKeyName] = $token; - if (!isset($data['_csrfToken']) && !in_array($method, ['GET', 'OPTIONS'])) { + if (!isset($data['_csrfToken']) && !in_array($method, ['GET', 'OPTIONS'], true)) { $data['_csrfToken'] = $token; } } @@ -907,7 +916,11 @@ public function assertResponseCode(int $code, string $message = ''): void } /** - * Asserts that the Location header is correct. Comparison is made against a full URL. + * Asserts that the Location header is correct. + * + * This method normalizes both the expected URL and Location header value to absolute URLs + * for comparison. This accommodates differences between authentication plugins and core + * framework behavior, where some parts return relative URLs and others return absolute URLs. * * @param array|string|null $url The URL you expected the client to go to. This * can either be a string URL or an array compatible with Router::url(). Use null to @@ -925,14 +938,87 @@ public function assertRedirect(array|string|null $url = null, string $message = $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage); if ($url) { + // Normalize both URLs to absolute for comparison + $expectedUrl = Router::url($url, true); + $actualUrl = Router::url($this->_response->getHeaderLine('Location'), true); + + // Create a response with the normalized URL for proper error messages + $tempResponse = $this->_response->withHeader('Location', $actualUrl); + $this->assertThat( - Router::url($url, true), - new HeaderEquals($this->_response, 'Location'), + $expectedUrl, + new HeaderEquals($tempResponse, 'Location'), $verboseMessage, ); } } + /** + * Assert whether the response is redirecting back to the previous location. + * + * @param int|null $code Specific status code to validate against, defaults to success (2xx-3xx) range. + * @param string $message The failure message that will be appended to the generated message. + * @return void + */ + public function assertRedirectBack(?int $code = null, string $message = ''): void + { + if (!$this->_response) { + $this->fail('No response set, cannot assert header.'); + } + + $verboseMessage = $this->extractVerboseMessage($message); + $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage); + if ($code !== null) { + $this->assertThat($code, new StatusCode($this->_response), $message); + } else { + $this->assertThat(null, new StatusSuccess($this->_response), $verboseMessage); + } + + $url = $this->_request['url'] ?? null; + if (!$url) { + $this->fail('No `url` set in request, cannot assert header.'); + } + + $this->assertThat( + Router::url($url, true), + new HeaderEquals($this->_response, 'Location'), + $verboseMessage, + ); + } + + /** + * Assert whether the response is redirecting back to the referer. + * + * @param int|null $code Specific status code to validate against, defaults to success (2xx-3xx) range. + * @param string $message The failure message that will be appended to the generated message. + * @return void + */ + public function assertRedirectBackToReferer(?int $code = null, string $message = ''): void + { + if (!$this->_response) { + $this->fail('No response set, cannot assert header.'); + } + + $verboseMessage = $this->extractVerboseMessage($message); + $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage); + if ($code !== null) { + $this->assertThat($code, new StatusCode($this->_response), $message); + } else { + $this->assertThat(null, new StatusSuccess($this->_response), $verboseMessage); + } + + $referer = $this->_request['environment']['HTTP_REFERER'] ?? null; + if (!$referer) { + $this->fail('No `HTTP_REFERER` set in request environment, cannot assert header.'); + } + + $this->assertThat( + Router::url($referer, true), + new HeaderEquals($this->_response, 'Location'), + $verboseMessage, + ); + } + /** * Asserts that the Location header is correct. Comparison is made against exactly the URL provided. * @@ -952,7 +1038,18 @@ public function assertRedirectEquals(array|string|null $url = null, string $mess $this->assertThat(null, new HeaderSet($this->_response, 'Location'), $verboseMessage); if ($url) { - $this->assertThat(Router::url($url), new HeaderEquals($this->_response, 'Location'), $verboseMessage); + // Normalize both URLs to absolute for comparison + $expectedUrl = Router::url($url, true); + $actualUrl = Router::url($this->_response->getHeaderLine('Location'), true); + + // Create a response with the normalized URL for proper error messages + $tempResponse = $this->_response->withHeader('Location', $actualUrl); + + $this->assertThat( + $expectedUrl, + new HeaderEquals($tempResponse, 'Location'), + $verboseMessage, + ); } } @@ -1307,6 +1404,54 @@ public function assertFlashMessageAt(int $at, string $expected, string $key = 'f ); } + /** + * Asserts a flash message contains a substring + * + * @param string $expected Expected substring in message + * @param string $key Flash key + * @param string $message Assertion failure message + * @param bool $ignoreCase Whether to ignore case + * @return void + */ + public function assertFlashMessageContains( + string $expected, + string $key = 'flash', + string $message = '', + bool $ignoreCase = false, + ): void { + $verboseMessage = $this->extractVerboseMessage($message); + $this->assertThat( + $expected, + new FlashParamContains($this->_requestSession, $key, 'message', null, $ignoreCase), + $verboseMessage, + ); + } + + /** + * Asserts a flash message contains a substring at a certain index + * + * @param int $at Flash index + * @param string $expected Expected substring in message + * @param string $key Flash key + * @param string $message Assertion failure message + * @param bool $ignoreCase Whether to ignore case + * @return void + */ + public function assertFlashMessageContainsAt( + int $at, + string $expected, + string $key = 'flash', + string $message = '', + bool $ignoreCase = false, + ): void { + $verboseMessage = $this->extractVerboseMessage($message); + $this->assertThat( + $expected, + new FlashParamContains($this->_requestSession, $key, 'message', $at, $ignoreCase), + $verboseMessage, + ); + } + /** * Asserts a flash element was set * @@ -1486,13 +1631,13 @@ protected function extractExceptionMessage(Exception $exception): string { $exceptions = [$exception]; $previous = $exception->getPrevious(); - while ($previous != null) { + while ($previous !== null) { $exceptions[] = $previous; $previous = $previous->getPrevious(); } $message = PHP_EOL; foreach ($exceptions as $i => $error) { - if ($i == 0) { + if ($i === 0) { $message .= sprintf('Possibly related to `%s`: "%s"', $error::class, $error->getMessage()); $message .= PHP_EOL; } else { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/LogTestTrait.php b/app/vendor/cakephp/cakephp/src/TestSuite/LogTestTrait.php index e53390815..ad0a04ff8 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/LogTestTrait.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/LogTestTrait.php @@ -22,6 +22,8 @@ /** * Make assertions on logs + * + * @require-extends \Cake\TestSuite\TestCase */ trait LogTestTrait { @@ -141,7 +143,7 @@ protected function _expectLogMessage( continue; } $messages = $engineObj->read(); - $engineScopes = $engineObj->scopes(); + $engineScopes = (array)$engineObj->scopes(); // No overlapping scopes if ($scope !== null && !in_array($scope, $engineScopes, true)) { continue; diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/MiddlewareDispatcher.php b/app/vendor/cakephp/cakephp/src/TestSuite/MiddlewareDispatcher.php index 4ebf8aa47..4e6f18ab8 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/MiddlewareDispatcher.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/MiddlewareDispatcher.php @@ -24,6 +24,7 @@ use Cake\Routing\Router; use Cake\Routing\RoutingApplicationInterface; use Psr\Http\Message\ResponseInterface; +use function Cake\Core\deprecationWarning; /** * Dispatches a request capturing the response for integration @@ -59,6 +60,11 @@ public function __construct(HttpApplicationInterface $app) */ public function resolveUrl(array|string $url): string { + deprecationWarning( + '5.1.0', + 'MiddlewareDispatcher::resolveUrl() is deprecated. Use IntegrationTestTrait::resolveUrl() instead.', + ); + // If we need to resolve a Route URL but there are no routes, load routes. if (is_array($url) && Router::getRouteCollection()->routes() === []) { return $this->resolveRoute($url); @@ -76,6 +82,11 @@ public function resolveUrl(array|string $url): string */ protected function resolveRoute(array $url): string { + deprecationWarning( + '5.1.0', + 'MiddlewareDispatcher::resolveRoute() is deprecated. Use IntegrationTestTrait::resolveRoute() instead.', + ); + // Simulate application bootstrap and route loading. // We need both to ensure plugins are loaded. $this->app->bootstrap(); diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/StringCompareTrait.php b/app/vendor/cakephp/cakephp/src/TestSuite/StringCompareTrait.php index 1fcd1b2a9..68663e9d5 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/StringCompareTrait.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/StringCompareTrait.php @@ -23,6 +23,8 @@ * * Implementing objects are expected to modify the `$_compareBasePath` property * before use. + * + * @require-extends \Cake\TestSuite\TestCase */ trait StringCompareTrait { diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/Stub/TestExceptionRenderer.php b/app/vendor/cakephp/cakephp/src/TestSuite/Stub/TestExceptionRenderer.php index 034edf902..e26f91b18 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/Stub/TestExceptionRenderer.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/Stub/TestExceptionRenderer.php @@ -28,7 +28,7 @@ * caught by the ErrorHandlerMiddleware. This is useful while debugging or * writing integration test cases. * - * @see \Cake\TestSuite\IntegrationTestCase::disableErrorHandlerMiddleware() + * @see \Cake\TestSuite\IntegrationTestTrait::disableErrorHandlerMiddleware() * @internal */ class TestExceptionRenderer implements ExceptionRendererInterface @@ -37,7 +37,6 @@ class TestExceptionRenderer implements ExceptionRendererInterface * Simply rethrow the given exception * * @param \Throwable $exception Exception. - * @return void * @throws \Throwable $exception Rethrows the passed exception. */ public function __construct(Throwable $exception) diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/TestCase.php b/app/vendor/cakephp/cakephp/src/TestSuite/TestCase.php index 9cedf7d63..368db63f8 100644 --- a/app/vendor/cakephp/cakephp/src/TestSuite/TestCase.php +++ b/app/vendor/cakephp/cakephp/src/TestSuite/TestCase.php @@ -43,6 +43,7 @@ use PHPUnit\Framework\TestCase as BaseTestCase; use ReflectionClass; use ReflectionException; +use ReflectionMethod; use function Cake\Core\pluginSplit; /** @@ -190,7 +191,7 @@ function ( &$deprecation, $type, ): bool { - if ($code == $type) { + if ($code === $type) { $deprecation = true; return true; @@ -225,7 +226,7 @@ protected function assertPostConditions(): void parent::assertPostConditions(); if (class_exists(Mockery::class)) { - // @phpstan-ignore method.internal + // @phpstan-ignore method.internal, argument.type $this->addToAssertionCount(Mockery::getContainer()->mockery_getExpectationCount()); } } @@ -354,9 +355,9 @@ public function loadRoutes(?array $appArgs = null): void * elements in CakePHP or applications. * * @param array $plugins List of Plugins to load. - * @return \Cake\Http\BaseApplication + * @return \Cake\Http\BaseApplication<\Cake\Http\BaseApplication> */ - public function loadPlugins(array $plugins = []): BaseApplication + public function loadPlugins(array $plugins = []): BaseApplication // @phpstan-ignore missingType.generics { $this->appPluginsToLoad = $plugins; @@ -386,6 +387,76 @@ public function middleware(MiddlewareQueue $middlewareQueue): MiddlewareQueue return $app; } + /** + * Load all plugins from the application's plugins.php config file. + * + * This method allows tests to load all plugins that would normally be loaded + * in the application, ensuring consistent behavior between test and production + * environments. + * + * Use this method in your test's setUp() or in individual test methods when + * you need to test functionality that depends on plugins being loaded. + * + * Example: + * ``` + * public function setUp(): void + * { + * parent::setUp(); + * $this->loadAllPlugins(); + * } + * ``` + * + * Or load from a specific config directory: + * ``` + * $this->loadAllPlugins('/path/to/config/'); + * ``` + * + * @param string|null $configPath The path to the config directory. + * If not provided, uses Configure::read('Test.plugins') or defaults to CONFIG. + * @return $this For method chaining + * @since 5.3.0 + */ + public function loadAllPlugins(?string $configPath = null) + { + $plugins = []; + + if ($configPath !== null) { + // Load from specified path + $pluginsFile = rtrim($configPath, DIRECTORY_SEPARATOR) . DIRECTORY_SEPARATOR . 'plugins.php'; + if (file_exists($pluginsFile)) { + $plugins = require $pluginsFile; + } + } else { + // Try configured plugins first + $plugins = Configure::read('Test.plugins'); + + // Fall back to default CONFIG path + if ($plugins === null && defined('CONFIG')) { + $pluginsFile = CONFIG . 'plugins.php'; + if (file_exists($pluginsFile)) { + /** @phpstan-ignore-next-line */ + $plugins = require $pluginsFile; + } + } + } + + // Ensure we have an array + if (!is_array($plugins)) { + $plugins = []; + } + + // If using IntegrationTestTrait, set the plugins to be loaded + /** @phpstan-ignore-next-line */ + if (property_exists($this, 'appPluginsToLoad')) { + $this->appPluginsToLoad = $plugins; + } else { + // Otherwise, use the existing loadPlugins method + $this->loadPlugins($plugins); + } + + return $this; + } + /** * Remove plugins from the global plugin collection. * @@ -495,6 +566,7 @@ public function assertTextEquals(string $expected, string $result, string $messa * @param string $string The string to search in. * @param string $message The message to use for failure. * @return void + * @phpstan-param non-empty-string $prefix */ public function assertTextStartsWith(string $prefix, string $string, string $message = ''): void { @@ -512,6 +584,7 @@ public function assertTextStartsWith(string $prefix, string $string, string $mes * @param string $string The string to search. * @param string $message The message to use for failure. * @return void + * @phpstan-param non-empty-string $prefix */ public function assertTextStartsNotWith(string $prefix, string $string, string $message = ''): void { @@ -529,6 +602,7 @@ public function assertTextStartsNotWith(string $prefix, string $string, string $ * @param string $string The string to search. * @param string $message The message to use for failure. * @return void + * @phpstan-param non-empty-string $suffix */ public function assertTextEndsWith(string $suffix, string $string, string $message = ''): void { @@ -546,6 +620,7 @@ public function assertTextEndsWith(string $suffix, string $string, string $messa * @param string $string The string to search. * @param string $message The message to use for failure. * @return void + * @phpstan-param non-empty-string $suffix */ public function assertTextEndsNotWith(string $suffix, string $string, string $message = ''): void { @@ -907,7 +982,7 @@ protected static function assertWithinRange($expected, $result, $margin, $messag { $upper = $result + $margin; $lower = $result - $margin; - static::assertTrue(($expected <= $upper) && ($expected >= $lower), $message); + self::assertTrue(($expected <= $upper) && ($expected >= $lower), $message); } /** @@ -923,7 +998,7 @@ protected static function assertNotWithinRange($expected, $result, $margin, $mes { $upper = $result + $margin; $lower = $result - $margin; - static::assertTrue(($expected > $upper) || ($expected < $lower), $message); + self::assertTrue(($expected > $upper) || ($expected < $lower), $message); } /** @@ -938,7 +1013,7 @@ protected static function assertPathEquals($expected, $result, $message = '') { $expected = str_replace(DIRECTORY_SEPARATOR, '/', $expected); $result = str_replace(DIRECTORY_SEPARATOR, '/', $result); - static::assertEquals($expected, $result, $message); + self::assertEquals($expected, $result, $message); } /** @@ -980,7 +1055,7 @@ public function getMockForModel(string $alias, array $methods = [], array $optio $options += ['alias' => $baseClass, 'connection' => $connection]; $options += $locator->getConfig($alias); $reflection = new ReflectionClass($className); - $classMethods = array_map(function ($method) { + $classMethods = array_map(function (ReflectionMethod $method) { return $method->name; }, $reflection->getMethods()); diff --git a/app/vendor/cakephp/cakephp/src/TestSuite/functions.php b/app/vendor/cakephp/cakephp/src/TestSuite/functions.php new file mode 100644 index 000000000..a1383a470 --- /dev/null +++ b/app/vendor/cakephp/cakephp/src/TestSuite/functions.php @@ -0,0 +1,62 @@ +|array $data Array of data or object implementing * \ArrayAccess interface to operate on. * @param array|string|int|null $path The path being searched for. Either a dot - * separated string, or an array of path segments. - * @param mixed $default The return value when the path does not exist + * separated string, or an array of path segments. If null, returns $default. + * @param mixed $default The return value when the path does not exist or is null. * @throws \InvalidArgumentException - * @return mixed The value fetched from the array, or null. - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::get + * @return mixed The value fetched from the array, or $default if path doesn't exist, is null, + * or $data is empty. + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-get */ public static function get(ArrayAccess|array $data, array|string|int|null $path, mixed $default = null): mixed { @@ -110,12 +111,12 @@ public static function get(ArrayAccess|array $data, array|string|int|null $path, * - `{n}.User[username=/^paul/]` Get User elements with username matching `^paul`. * - `{n}.User[id=1].name` Get the Users name with id matching `1`. * - * @param \ArrayAccess|array $data The data to extract from. + * @param \ArrayAccess|array $data The data to extract from. * @param string $path The path to extract. - * @return \ArrayAccess|array An array of the extracted values. Returns an empty array + * @return \ArrayAccess|array An array of the extracted values. Returns an empty array * if there are no matches. - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::extract - * @phpstan-return ($path is non-empty-string ? array : \ArrayAccess|array) + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-extract + * @phpstan-return ($path is non-empty-string ? array : \ArrayAccess|array) */ public static function extract(ArrayAccess|array $data, string $path): ArrayAccess|array { @@ -220,7 +221,7 @@ protected static function _matchToken(mixed $key, string $token): bool /** * Checks whether $data matches the attribute patterns * - * @param \ArrayAccess|array $data Array of data to match. + * @param \ArrayAccess|array $data Array of data to match. * @param string $selector The patterns to match. * @return bool Fitness of expression. */ @@ -289,13 +290,13 @@ protected static function _matches(ArrayAccess|array $data, string $selector): b * Insert $values into an array with the given $path. You can use * `{n}` and `{s}` elements to insert $data multiple times. * - * @template T of \ArrayAccess|array + * @template T of \ArrayAccess|array * @param T $data The data to insert into. * @param string $path The path to insert at. * @param mixed $values The values to insert. - * @return \ArrayAccess|array The data with $values inserted. - * @phpstan-return (T is array ? array : \ArrayAccess) - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::insert + * @return \ArrayAccess|array The data with $values inserted. + * @phpstan-return (T is array ? array : \ArrayAccess) + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-insert */ public static function insert(ArrayAccess|array $data, string $path, mixed $values = null): ArrayAccess|array { @@ -344,10 +345,10 @@ public static function insert(ArrayAccess|array $data, string $path, mixed $valu * Perform a simple insert/remove operation. * * @param string $op The operation to do. - * @param \ArrayAccess|array $data The data to operate on. + * @param \ArrayAccess|array $data The data to operate on. * @param array $path The path to work on. * @param mixed $values The values to insert when doing inserts. - * @return \ArrayAccess|array + * @return \ArrayAccess|array */ protected static function _simpleOp( string $op, @@ -394,12 +395,12 @@ protected static function _simpleOp( * You can use `{n}` and `{s}` to remove multiple elements * from $data. * - * @template T of \ArrayAccess|array + * @template T of \ArrayAccess|array * @param T $data The data to operate on * @param string $path A path expression to use to remove. - * @return \ArrayAccess|array The modified array. - * @phpstan-return (T is array ? array : \ArrayAccess) - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::remove + * @return \ArrayAccess|array The modified array. + * @phpstan-return (T is array ? array : \ArrayAccess) + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-remove */ public static function remove(ArrayAccess|array $data, string $path): ArrayAccess|array { @@ -431,6 +432,7 @@ public static function remove(ArrayAccess|array $data, string $path): ArrayAcces foreach ($data as $k => $v) { $match = static::_matchToken($k, $token); if ($match && (is_array($v) || $v instanceof ArrayAccess)) { + /** @var \ArrayAccess|array $v */ if ($conditions) { if (static::_matches($v, $conditions)) { if ($nextPath !== '') { @@ -464,7 +466,7 @@ public static function remove(ArrayAccess|array $data, string $path): ArrayAcces * @param array|string|null $valuePath A dot-separated string. * @param string|null $groupPath A dot-separated string. * @return array Combined array - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::combine + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-combine * @throws \InvalidArgumentException When keys and values count is unequal. */ public static function combine( @@ -551,8 +553,9 @@ public static function combine( * @param array $data Source array from which to extract the data * @param array $paths An array containing one or more Hash::extract()-style key paths * @param string $format Format string into which values will be inserted, see sprintf() - * @return array|null An array of strings extracted from `$path` and formatted with `$format` - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::format + * @return array|null An array of strings extracted from `$path` and formatted with `$format`, + * or null if $paths is empty. + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-format * @see sprintf() * @see \Cake\Utility\Hash::extract() * @phpstan-return ($paths is non-empty-array ? array : null) @@ -592,9 +595,9 @@ public static function format(array $data, array $paths, string $format): ?array * Determines if one array contains the exact keys and values of another. * * @param array $data The data to search through. - * @param array $needle The values to file in $data + * @param array $needle The values to find in $data * @return bool true If $data contains $needle, false otherwise - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::contains + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-contains */ public static function contains(array $data, array $needle): bool { @@ -638,7 +641,7 @@ public static function contains(array $data, array $needle): bool * @param string $path The path to check for. * @return bool Existence of path. * @see \Cake\Utility\Hash::extract() - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::check + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-check */ public static function check(array $data, string $path): bool { @@ -657,7 +660,7 @@ public static function check(array $data, string $path): bool * @param callable|null $callback A function to filter the data with. Defaults to * all non-empty or zero values. * @return array Filtered array - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::filter + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-filter */ public static function filter(array $data, ?callable $callback = null): array { @@ -678,7 +681,7 @@ public static function filter(array $data, ?callable $callback = null): array */ protected static function _filter(mixed $var): bool { - return $var === 0 || $var === 0.0 || $var === '0' || !empty($var); + return in_array($var, [0, 0.0, '0'], true) || !empty($var); } /** @@ -688,7 +691,7 @@ protected static function _filter(mixed $var): bool * @param array $data Array to flatten * @param string $separator String used to separate array key elements in a path, defaults to '.' * @return array - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::flatten + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-flatten */ public static function flatten(array $data, string $separator = '.'): array { @@ -696,9 +699,8 @@ public static function flatten(array $data, string $separator = '.'): array $stack = []; $path = ''; - reset($data); while (!empty($data)) { - $key = key($data); + $key = array_key_first($data); $element = $data[$key]; unset($data[$key]); @@ -733,7 +735,7 @@ public static function flatten(array $data, string $separator = '.'): array * @param array $data Flattened array * @param string $separator The delimiter used * @return array - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::expand + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-expand */ public static function expand(array $data, string $separator = '.'): array { @@ -773,7 +775,7 @@ public static function expand(array $data, string $separator = '.'): array * @param array $data Array to be merged * @param mixed $merge Array to merge with. The argument and all trailing arguments will be array cast when merged * @return array Merged array - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::merge + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-merge */ public static function merge(array $data, mixed $merge): array { @@ -830,7 +832,7 @@ protected static function _merge(array $stack, array &$return): void * * @param array $data The array to check. * @return bool true if values are numeric, false otherwise - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::numeric + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-numeric */ public static function numeric(array $data): bool { @@ -850,7 +852,7 @@ public static function numeric(array $data): bool * * @param array $data Array to count dimensions on * @return int The number of dimensions in $data - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::dimensions + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-dimensions */ public static function dimensions(array $data): int { @@ -877,7 +879,7 @@ public static function dimensions(array $data): int * * @param array $data Array to count dimensions on * @return int The maximum number of dimensions in $data - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::maxDimensions + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-maxdimensions */ public static function maxDimensions(array $data): int { @@ -901,7 +903,7 @@ public static function maxDimensions(array $data): int * @param string $path The path to extract for mapping over. * @param callable $function The function to call on each extracted value. * @return array An array of the modified values. - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::map + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-map */ public static function map(array $data, string $path, callable $function): array { @@ -917,7 +919,7 @@ public static function map(array $data, string $path, callable $function): array * @param string $path The path to extract from $data. * @param callable $function The function to call on each extracted value. * @return mixed The reduced value. - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::reduce + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-reduce */ public static function reduce(array $data, string $path, callable $function): mixed { @@ -949,7 +951,7 @@ public static function reduce(array $data, string $path, callable $function): mi * @param string $path The path to extract from $data. * @param callable $function The function to call on each extracted value. * @return mixed The results of the applied method. - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::apply + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-apply */ public static function apply(array $data, string $path, callable $function): mixed { @@ -989,7 +991,7 @@ public static function apply(array $data, string $path, callable $function): mix * @param string|int $dir See directions above. Defaults to 'asc'. * @param array|string $type See direction types above. Defaults to 'regular'. * @return array Sorted array of data - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::sort + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-sort */ public static function sort( array $data, @@ -1111,7 +1113,7 @@ protected static function _squash(array $data, string|int|null $key = null): arr * @param array $compare Second value * @return array Returns the key => value pairs that are not common in $data and $compare * The expression for this function is ($data - $compare) + ($compare - ($data - $compare)) - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::diff + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-diff */ public static function diff(array $data, array $compare): array { @@ -1138,7 +1140,7 @@ public static function diff(array $data, array $compare): array * @param array $data The data to append onto. * @param array $compare The data to compare and append onto. * @return array The merged array. - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::mergeDiff + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-mergediff */ public static function mergeDiff(array $data, array $compare): array { @@ -1166,7 +1168,7 @@ public static function mergeDiff(array $data, array $compare): array * @param bool $assoc If true, $data will be converted to an associative array. * @param mixed $default The default value to use when a top level numeric key is converted to associative form. * @return array - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::normalize + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-normalize */ public static function normalize(array $data, bool $assoc = true, mixed $default = null): array { @@ -1214,7 +1216,7 @@ public static function normalize(array $data, bool $assoc = true, mixed $default * @return array of results, nested * @see \Cake\Utility\Hash::extract() * @throws \InvalidArgumentException When providing invalid data. - * @link https://book.cakephp.org/5/en/core-libraries/hash.html#Cake\Utility\Hash::nest + * @link https://book.cakephp.org/5/en/core-libraries/hash.html#hash-nest * @phpstan-param array{idPath?: string, parentPath?: string, children?: string, root?: string|null} $options */ public static function nest(array $data, array $options = []): array @@ -1272,7 +1274,7 @@ public static function nest(array $data, array $options = []): array foreach ($return as $i => $result) { $id = static::get($result, $idKeys); $parentId = static::get($result, $parentKeys); - if ($id !== $root && $parentId != $root) { + if ($id !== $root && $parentId !== $root) { unset($return[$i]); } } diff --git a/app/vendor/cakephp/cakephp/src/Utility/Inflector.php b/app/vendor/cakephp/cakephp/src/Utility/Inflector.php index 7a7c06057..f9cbbef4c 100644 --- a/app/vendor/cakephp/cakephp/src/Utility/Inflector.php +++ b/app/vendor/cakephp/cakephp/src/Utility/Inflector.php @@ -349,7 +349,7 @@ public static function singularize(string $word): string } if (preg_match(static::$_cache['uninflected'], $word, $regs)) { - static::$_cache['pluralize'][$word] = $word; + static::$_cache['singularize'][$word] = $word; return $word; } diff --git a/app/vendor/cakephp/cakephp/src/Utility/MergeVariablesTrait.php b/app/vendor/cakephp/cakephp/src/Utility/MergeVariablesTrait.php index 814154edc..3db0f304d 100644 --- a/app/vendor/cakephp/cakephp/src/Utility/MergeVariablesTrait.php +++ b/app/vendor/cakephp/cakephp/src/Utility/MergeVariablesTrait.php @@ -108,9 +108,7 @@ protected function _mergePropertyData(array $current, array $parent, bool $isAss } $parent = Hash::normalize($parent); foreach ($parent as $key => $value) { - if (!isset($current[$key])) { - $current[$key] = $value; - } + $current[$key] ??= $value; } return $current; diff --git a/app/vendor/cakephp/cakephp/src/Utility/Security.php b/app/vendor/cakephp/cakephp/src/Utility/Security.php index 1795ab46e..b00d3ecc8 100644 --- a/app/vendor/cakephp/cakephp/src/Utility/Security.php +++ b/app/vendor/cakephp/cakephp/src/Utility/Security.php @@ -159,8 +159,9 @@ public static function insecureRandomBytes(int $length): string * * You can use this method to forcibly decide between openssl/custom implementations. * - * @param \Cake\Utility\Crypto\OpenSsl|null $instance The crypto instance to use. - * @return \Cake\Utility\Crypto\OpenSsl Crypto instance. + * @param \Cake\Utility\Crypto\OpenSsl|null $instance The crypto instance to use. If provided, sets and returns this instance. + * If null, returns the currently configured engine or creates a new OpenSsl instance. + * @return \Cake\Utility\Crypto\OpenSsl Crypto instance. By default, returns a \Cake\Utility\Crypto\OpenSsl instance. * @throws \InvalidArgumentException When no compatible crypto extension is available. */ public static function engine(?object $instance = null): object diff --git a/app/vendor/cakephp/cakephp/src/Utility/Text.php b/app/vendor/cakephp/cakephp/src/Utility/Text.php index a37189112..ef2349b9e 100644 --- a/app/vendor/cakephp/cakephp/src/Utility/Text.php +++ b/app/vendor/cakephp/cakephp/src/Utility/Text.php @@ -16,7 +16,9 @@ */ namespace Cake\Utility; +use Cake\Core\Configure; use Cake\Core\Exception\CakeException; +use Closure; use InvalidArgumentException; use Transliterator; use function Cake\I18n\__d; @@ -66,12 +68,29 @@ class Text * It should also not be used to create identifiers that have security implications, such as * 'unguessable' URL identifiers. Instead, you should use {@link \Cake\Utility\Security::randomBytes()}` for that. * + * ### Custom UUID generation + * + * You can configure a custom UUID generator by setting a Closure via Configure: + * + * ``` + * Configure::write('Text.uuidGenerator', function () { + * // Return your custom UUID string + * return MyUuidLibrary::generate(); + * }); + * ``` + * * @see https://www.ietf.org/rfc/rfc4122.txt * @return string RFC 4122 UUID + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-uuid * @copyright Matt Farina MIT License https://github.com/lootils/uuid/blob/master/LICENSE */ public static function uuid(): string { + $generator = Configure::read('Text.uuidGenerator'); + if ($generator instanceof Closure) { + return $generator(); + } + return sprintf( '%04x%04x-%04x-%04x-%04x-%04x%04x%04x', // 32 bits for "time_low" @@ -101,6 +120,7 @@ public static function uuid(): string * @param string $leftBound The left boundary to ignore separators in. * @param string $rightBound The right boundary to ignore separators in. * @return array Array of tokens in $data. + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-tokenize */ public static function tokenize( string $data, @@ -197,6 +217,7 @@ public static function tokenize( * to be replaced with val * @param array $options An array of options, see description above * @return string + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-insert */ public static function insert(string $str, array $data, array $options = []): string { @@ -215,7 +236,7 @@ public static function insert(string $str, array $data, array $options = []): st $dataKeys = array_keys($data); $hashKeys = array_map( - fn($str) => hash('xxh128', $str), + fn(int|string $str) => hash('xxh128', (string)$str), $dataKeys, ); /** @var array $tempData */ @@ -250,6 +271,7 @@ public static function insert(string $str, array $data, array $options = []): st * @param array $options Options list. * @return string * @see \Cake\Utility\Text::insert() + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-cleaninsert */ public static function cleanInsert(string $str, array $options): string { @@ -320,6 +342,7 @@ public static function cleanInsert(string $str, array $options): string * @param string $text The text to format. * @param array|int $options Array of options to use, or an integer to wrap the text to. * @return string Formatted text. + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-wrap */ public static function wrap(string $text, array|int $options = []): string { @@ -361,6 +384,7 @@ public static function wrap(string $text, array|int $options = []): string * @param string $text The text to format. * @param array|int $options Array of options to use, or an integer to wrap the text to. * @return string Formatted text. + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-wrapblock */ public static function wrapBlock(string $text, array|int $options = []): string { @@ -540,6 +564,7 @@ public static function highlight(string $text, array|string $phrase, array $opti * @param int $length Length of returned string, including ellipsis. * @param array $options An array of options. * @return string Trimmed string. + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-tail */ public static function tail(string $text, int $length = 100, array $options = []): string { @@ -849,7 +874,7 @@ protected static function _removeLastWord(string $text): string * * @param string $text String to search the phrase in * @param string $phrase Phrase that will be searched for - * @param int $radius The amount of characters that will be returned on each side of the founded phrase + * @param int $radius The amount of characters that will be returned on each side of the found phrase * @param string $ellipsis Ending that will be appended * @return string Modified string * @link https://book.cakephp.org/5/en/core-libraries/text.html#extracting-an-excerpt @@ -997,13 +1022,15 @@ public static function ascii(array $array): string } /** - * Converts filesize from human readable string to bytes + * Converts filesize from human-readable string to bytes * - * @param string $size Size in human readable string like '5MB', '5M', '500B', '50kb' etc. - * @param mixed $default Value to be returned when invalid size was used, for example 'Unknown type' - * @return mixed Number of bytes as integer on success, `$default` on failure if not false - * @throws \InvalidArgumentException On invalid Unit type. - * @link https://book.cakephp.org/5/en/core-libraries/text.html#Cake\Utility\Text::parseFileSize + * @param string $size Size in human-readable string like '5MB', '5M', '500B', '50kb' etc. + * @param mixed $default Value to be returned when invalid size was used. + * If set to false (default), an exception will be thrown instead. + * @return mixed Number of bytes as integer on success, or $default value on failure + * (if $default is not false). + * @throws \InvalidArgumentException On invalid unit type when $default is false. + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-parsefilesize */ public static function parseFileSize(string $size, mixed $default = false): mixed { @@ -1095,6 +1122,7 @@ public static function setTransliteratorId(string $transliteratorId): void * `setTransliterator()` will be used. * @return string * @see https://secure.php.net/manual/en/transliterator.transliterate.php + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-transliterate */ public static function transliterate(string $string, Transliterator|string|null $transliterator = null): string { @@ -1128,8 +1156,9 @@ public static function transliterate(string $string, Transliterator|string|null * @param array|string $options If string it will be use as replacement character * or an array of options. * @return string - * @see setTransliterator() - * @see setTransliteratorId() + * @see Text::setTransliterator() + * @see Text::setTransliteratorId() + * @link https://book.cakephp.org/5/en/core-libraries/text.html#text-slug */ public static function slug(string $string, array|string $options = []): string { diff --git a/app/vendor/cakephp/cakephp/src/Utility/composer.json b/app/vendor/cakephp/cakephp/src/Utility/composer.json index 563b1c34d..cb4b0ec9a 100644 --- a/app/vendor/cakephp/cakephp/src/Utility/composer.json +++ b/app/vendor/cakephp/cakephp/src/Utility/composer.json @@ -25,8 +25,8 @@ "source": "https://github.com/cakephp/utility" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev" + "php": ">=8.2", + "cakephp/core": "^5.3.0" }, "autoload": { "psr-4": { @@ -40,10 +40,11 @@ "ext-intl": "To use Text::transliterate() or Text::slug()", "lib-ICU": "To use Text::transliterate() or Text::slug()" }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/Validation/Validation.php b/app/vendor/cakephp/cakephp/src/Validation/Validation.php index 9a5996f48..f1fb7d741 100644 --- a/app/vendor/cakephp/cakephp/src/Validation/Validation.php +++ b/app/vendor/cakephp/cakephp/src/Validation/Validation.php @@ -174,7 +174,7 @@ public static function alphaNumeric(mixed $check): bool } /** - * Checks that a doesn't contain any alpha numeric characters + * Checks that a value doesn't contain any alpha numeric characters * * This method's definition of letters and integers includes unicode characters. * Use `notAsciiAlphaNumeric()` if you want to exclude ascii only. @@ -203,7 +203,7 @@ public static function asciiAlphaNumeric(mixed $check): bool } /** - * Checks that a doesn't contain any non-ascii alpha numeric characters + * Checks that a value doesn't contain any non-ascii alpha numeric characters * * @param mixed $check Value to check * @return bool Success @@ -345,7 +345,7 @@ public static function comparison(mixed $check1, string $operator, mixed $check2 { if ( (!is_numeric($check1) || !is_numeric($check2)) && - !in_array($operator, static::COMPARE_STRING) + !in_array($operator, static::COMPARE_STRING, true) ) { return false; } @@ -593,7 +593,7 @@ public static function datetime(mixed $check, array|string $dateFormat = 'ymd', * * @param mixed $check Value to check * @return bool True if the value is valid, false otherwise - * @see Regex credits: https://www.myintervals.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/ + * @see https://www.myintervals.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/ for regex credits */ public static function iso8601(mixed $check): bool { @@ -651,9 +651,9 @@ public static function time(mixed $check): bool * @param string|int|null $format any format accepted by IntlDateFormatter * @return bool Success * @throws \InvalidArgumentException when unsupported $type given - * @see \Cake\I18n\Time::parseDate() + * @see \Cake\I18n\Date::parseDate() * @see \Cake\I18n\Time::parseTime() - * @see \Cake\I18n\Time::parseDateTime() + * @see \Cake\I18n\DateTime::parseDateTime() */ public static function localizedTime(mixed $check, string $type = 'datetime', string|int|null $format = null): bool { @@ -839,7 +839,7 @@ public static function enum(mixed $check, string $enumClassName): bool } /** - * Checks that the value is a valid backed enum instance or value. + * Checks that the value is backed enum instance or value of one of the provided enum cases. * * @param mixed $check Value to check * @param array<\BackedEnum> $cases Array of enum cases that are valid. @@ -862,7 +862,7 @@ public static function enumOnly(mixed $check, array $cases): bool } /** - * Checks that the value is a valid backed enum instance or value. + * Checks that the value is a valid backed enum instance or value except the cases provided. * * @param mixed $check Value to check * @param array<\BackedEnum> $cases Array of enum cases that are not valid. @@ -932,7 +932,7 @@ protected static function checkEnum(mixed $check, string $enumClassName, array $ $check = (int)$check; } - if (get_debug_type($check) !== (string)$backingType) { + if (get_debug_type($check) !== $backingType) { return false; } @@ -999,7 +999,7 @@ public static function equalTo(mixed $check, mixed $comparedTo): bool /** * Checks that value has a valid file extension. * - * Supports checking `\Psr\Http\Message\UploadedFileInterface` instances and + * Supports checking `\Psr\Http\Message\UploadedFileInterface` instances * and arrays with a `name` key. * * @param mixed $check Value to check @@ -1055,6 +1055,35 @@ public static function ip(mixed $check, string $type = 'both'): bool return (bool)filter_var($check, FILTER_VALIDATE_IP, ['flags' => $flags]); } + /** + * Validation of an IP address or range (subnet). + * + * @param mixed $check The string to test. + * @param string $type The IP Protocol version to validate against + * @return bool Success + */ + public static function ipOrRange(mixed $check, string $type = 'both'): bool + { + if (!is_string($check)) { + return false; + } + + if (!str_contains($check, '/')) { + return static::ip($check, $type); + } + + [$ip, $mask] = explode('/', $check, 2); + + if (in_array($type, ['both', 'ipv4', true]) && filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4)) { + return is_numeric($mask) && $mask >= 0 && $mask <= 32; + } + if (in_array($type, ['both', 'ipv6', true]) && filter_var($ip, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6)) { + return is_numeric($mask) && $mask >= 0 && $mask <= 128; + } + + return false; + } + /** * Checks whether the length of a string (in characters) is greater or equal to a minimal length. * @@ -1442,7 +1471,7 @@ protected static function getFilename(mixed $check): ?string * * @param mixed $check Value to check. * @param string $operator See `Validation::comparison()`. - * @param string|int $size Size in bytes or human readable string like '5MB'. + * @param string|int $size Size in bytes or human-readable string like '5MB'. * @return bool Success */ public static function fileSize(mixed $check, string $operator, string|int $size): bool @@ -1463,8 +1492,8 @@ public static function fileSize(mixed $check, string $operator, string|int $size /** * Checking for upload errors * - * Supports checking `\Psr\Http\Message\UploadedFileInterface` instances and - * and arrays with a `error` key. + * Supports checking `\Psr\Http\Message\UploadedFileInterface` instances + * and arrays with an `error` key. * * @param mixed $check Value to check. * @param bool $allowNoFile Set to true to allow UPLOAD_ERR_NO_FILE as a pass. @@ -1700,7 +1729,7 @@ public static function latitude(mixed $value, array $options = []): bool /** * Convenience method for longitude validation. * - * @param mixed $value Latitude as string + * @param mixed $value Longitude as string * @param array $options Options for the validation logic. * @return bool * @link https://en.wikipedia.org/wiki/Longitude diff --git a/app/vendor/cakephp/cakephp/src/Validation/Validator.php b/app/vendor/cakephp/cakephp/src/Validation/Validator.php index 00b08524a..81934e83c 100644 --- a/app/vendor/cakephp/cakephp/src/Validation/Validator.php +++ b/app/vendor/cakephp/cakephp/src/Validation/Validator.php @@ -218,20 +218,29 @@ public function setStopOnFailure(bool $stopOnFailure = true) /** * Validates and returns an array of failed fields and their error messages. * - * @param array $data The data to be checked for errors - * @param bool $newRecord whether the data to be validated is new or to be updated. - * @return array Array of failed fields + * @param array $data The data to be checked for errors. + * Keys are field names, values are the field values to validate. + * @param bool $newRecord Whether the data to be validated is new or to be updated. + * @param array $context Additional validation context. + * @return array> Array of validation errors. + * Outer keys are field names, inner keys are validation rule names, + * values are error messages. When using `addNested()` or `addNestedMany()`, + * values may be nested error arrays. Special rule names: '_required', '_empty'. */ - public function validate(array $data, bool $newRecord = true): array + public function validate(array $data, bool $newRecord = true, array $context = []): array { $errors = []; foreach ($this->_fields as $name => $field) { + if (!empty($context['fields']) && !in_array($name, $context['fields'], true)) { + continue; + } + $name = (string)$name; $keyPresent = array_key_exists($name, $data); $providers = $this->_providers; - $context = compact('data', 'newRecord', 'field', 'providers'); + $context = compact('data', 'newRecord', 'field', 'providers') + $context; if (!$keyPresent && !$this->_checkPresence($field, $context)) { $errors[$name]['_required'] = $this->getRequiredMessage($name); @@ -259,7 +268,7 @@ public function validate(array $data, bool $newRecord = true): array continue; } - $result = $this->_processRules($name, $field, $data, $newRecord); + $result = $this->_processRules($name, $field, $data, $newRecord, $context); if ($result) { $errors[$name] = $result; } @@ -279,7 +288,7 @@ public function validate(array $data, bool $newRecord = true): array */ public function field(string $name, ?ValidationSet $set = null): ValidationSet { - if (empty($this->_fields[$name])) { + if (!isset($this->_fields[$name])) { $set = $set ?: new ValidationSet(); $this->_fields[$name] = $set; } @@ -534,7 +543,7 @@ public function addNested( $provider = $this->getProvider($name); $validator->setProvider($name, $provider); } - $errors = $validator->validate($value, $context['newRecord']); + $errors = $validator->validate($value, $context['newRecord'], ['parentContext' => $context]); $message = $message ? [static::NESTED => $message] : []; @@ -587,7 +596,11 @@ public function addNestedMany( if (!is_array($row)) { return false; } - $check = $validator->validate($row, $context['newRecord']); + $check = $validator->validate( + $row, + $context['newRecord'], + ['parentContext' => $context, 'nestedManyIndex' => $i], + ); if ($check) { $errors[$i] = $check; } @@ -652,8 +665,8 @@ public function requirePresence(array|string $field, Closure|string|bool $mode = 'message' => $message, ]; - if (!is_array($field)) { - $field = $this->_convertValidatorToArray((string)$field, $defaults); + if (is_string($field)) { + $field = $this->_convertValidatorToArray($field, $defaults); } foreach ($field as $fieldName => $setting) { @@ -2082,7 +2095,7 @@ public function enum( } if ($message === null) { - $cases = array_map(fn($case) => $case->value, $enumClassName::cases()); + $cases = array_map(fn(BackedEnum $case) => $case->value, $enumClassName::cases()); $caseOptions = implode('`, `', $cases); if (!$this->_useI18n) { $message = sprintf('The provided value must be one of `%s`', $caseOptions); @@ -3168,11 +3181,18 @@ protected function isEmpty(mixed $data, int $flags): bool * @param \Cake\Validation\ValidationSet $rules the list of rules for a field * @param array $data the full data passed to the validator * @param bool $newRecord whether is it a new record or an existing one + * @param array $context Additional validation context. * @return array */ - protected function _processRules(string $field, ValidationSet $rules, array $data, bool $newRecord): array - { + protected function _processRules( + string $field, + ValidationSet $rules, + array $data, + bool $newRecord, + array $context = [], + ): array { $errors = []; + $context = compact('newRecord', 'data', 'field') + $context; if (!$this->_useI18n) { $message = 'The provided value is invalid'; @@ -3181,7 +3201,7 @@ protected function _processRules(string $field, ValidationSet $rules, array $dat } foreach ($rules as $name => $rule) { - $result = $rule->process($data[$field], $this->_providers, compact('newRecord', 'data', 'field')); + $result = $rule->process($data[$field], $this->_providers, $context); if ($result === true) { continue; } diff --git a/app/vendor/cakephp/cakephp/src/Validation/ValidatorAwareTrait.php b/app/vendor/cakephp/cakephp/src/Validation/ValidatorAwareTrait.php index 93e10c634..f4b1feca9 100644 --- a/app/vendor/cakephp/cakephp/src/Validation/ValidatorAwareTrait.php +++ b/app/vendor/cakephp/cakephp/src/Validation/ValidatorAwareTrait.php @@ -37,13 +37,15 @@ * * If the including class also implements events the `Model.buildValidator` event * will be triggered when validators are created. + * + * @require-implements \Cake\Validation\ValidatorAwareInterface */ trait ValidatorAwareTrait { /** * Validator class. * - * @var string + * @var class-string<\Cake\Validation\Validator> */ protected string $_validatorClass = Validator::class; @@ -113,7 +115,7 @@ protected function createValidator(string $name): Validator { $method = 'validation' . ucfirst($name); if (!$this->validationMethodExists($method)) { - $message = sprintf('The `%s::%s()` validation method does not exists.', static::class, $method); + $message = sprintf('The `%s::%s()` validation method does not exist.', static::class, $method); throw new InvalidArgumentException($message); } diff --git a/app/vendor/cakephp/cakephp/src/Validation/composer.json b/app/vendor/cakephp/cakephp/src/Validation/composer.json index c5d6c13e9..e888bac34 100644 --- a/app/vendor/cakephp/cakephp/src/Validation/composer.json +++ b/app/vendor/cakephp/cakephp/src/Validation/composer.json @@ -22,13 +22,13 @@ "source": "https://github.com/cakephp/validation" }, "require": { - "php": ">=8.1", - "cakephp/core": "5.2.*@dev", - "cakephp/utility": "5.2.*@dev", + "php": ">=8.2", + "cakephp/core": "^5.3.0", + "cakephp/utility": "^5.3.0", "psr/http-message": "^1.1 || ^2.0" }, "require-dev": { - "cakephp/i18n": "5.2.*@dev" + "cakephp/i18n": "^5.3.0" }, "autoload": { "psr-4": { @@ -38,10 +38,11 @@ "suggest": { "cakephp/i18n": "If you want to use Validation::localizedTime()" }, + "minimum-stability": "dev", "prefer-stable": true, "extra": { "branch-alias": { - "dev-5.x": "5.2.x-dev" + "dev-5.next": "5.4.x-dev" } } } diff --git a/app/vendor/cakephp/cakephp/src/View/Cell.php b/app/vendor/cakephp/cakephp/src/View/Cell.php index 9c94188db..767d8e1af 100644 --- a/app/vendor/cakephp/cakephp/src/View/Cell.php +++ b/app/vendor/cakephp/cakephp/src/View/Cell.php @@ -36,12 +36,13 @@ /** * Cell base. * - * @implements \Cake\Event\EventDispatcherInterface<\Cake\View\View> + * @template TSubject of \Cake\View\View + * @implements \Cake\Event\EventDispatcherInterface */ abstract class Cell implements EventDispatcherInterface, Stringable { /** - * @use \Cake\Event\EventDispatcherTrait<\Cake\View\View> + * @use \Cake\Event\EventDispatcherTrait */ use EventDispatcherTrait; use LocatorAwareTrait; @@ -58,7 +59,7 @@ abstract class Cell implements EventDispatcherInterface, Stringable * Instance of the View created during rendering. Won't be set until after * Cell::__toString()/render() is called. * - * @var \Cake\View\View + * @var TSubject */ protected View $View; @@ -92,6 +93,13 @@ abstract class Cell implements EventDispatcherInterface, Stringable */ protected array $args = []; + /** + * The plugin name this cell belongs to. + * + * @var string|null + */ + protected ?string $plugin = null; + /** * List of valid options (constructor's fourth arguments) * Override this property in subclasses to allow @@ -128,7 +136,7 @@ public function __construct( $this->request = $request; $this->response = $response; - $this->_validCellOptions = array_merge(['action', 'args'], $this->_validCellOptions); + $this->_validCellOptions = array_merge(['action', 'args', 'plugin'], $this->_validCellOptions); foreach ($this->_validCellOptions as $var) { if (isset($cellOptions[$var])) { $this->{$var} = $cellOptions[$var]; @@ -153,6 +161,23 @@ public function initialize(): void { } + /** + * Get the view builder being used. + * + * @return \Cake\View\ViewBuilder + */ + public function viewBuilder(): ViewBuilder + { + if ($this->_viewBuilder === null) { + $this->_viewBuilder = new ViewBuilder(); + if ($this->plugin !== null) { + $this->_viewBuilder->setPlugin($this->plugin); + } + } + + return $this->_viewBuilder; + } + /** * Render the cell. * diff --git a/app/vendor/cakephp/cakephp/src/View/CellTrait.php b/app/vendor/cakephp/cakephp/src/View/CellTrait.php index 630f525c5..2f9e62b50 100644 --- a/app/vendor/cakephp/cakephp/src/View/CellTrait.php +++ b/app/vendor/cakephp/cakephp/src/View/CellTrait.php @@ -53,7 +53,7 @@ trait CellTrait * @param array $data Additional arguments for cell method. e.g.: * `cell('TagCloud::smallList', ['a1' => 'v1', 'a2' => 'v2'])` maps to `View\Cell\TagCloud::smallList(v1, v2)` * @param array $options Options for Cell's constructor - * @return \Cake\View\Cell The cell instance + * @return \Cake\View\Cell<\Cake\View\View> The cell instance * @throws \Cake\View\Exception\MissingCellException If Cell class was not found. */ protected function cell(string $cell, array $data = [], array $options = []): Cell @@ -85,11 +85,15 @@ protected function cell(string $cell, array $data = [], array $options = []): Ce * @param string $action The action name. * @param string|null $plugin The plugin name. * @param array $options The constructor options for the cell. - * @return \Cake\View\Cell + * @return \Cake\View\Cell<\Cake\View\View> */ protected function _createCell(string $className, string $action, ?string $plugin, array $options): Cell { - /** @var \Cake\View\Cell $instance */ + if ($plugin) { + $options['plugin'] = $plugin; + } + + /** @var \Cake\View\Cell<\Cake\View\View> $instance */ $instance = new $className($this->request, $this->response, $this->getEventManager(), $options); $builder = $instance->viewBuilder(); diff --git a/app/vendor/cakephp/cakephp/src/View/Exception/MissingCellTemplateException.php b/app/vendor/cakephp/cakephp/src/View/Exception/MissingCellTemplateException.php index ece31e842..3bad9d946 100644 --- a/app/vendor/cakephp/cakephp/src/View/Exception/MissingCellTemplateException.php +++ b/app/vendor/cakephp/cakephp/src/View/Exception/MissingCellTemplateException.php @@ -55,8 +55,7 @@ public function __construct( /** * Get the passed in attributes * - * @return array - * @phpstan-return array{name: string, file: string, paths: array} + * @return array{name: string, file: string, paths: array} */ public function getAttributes(): array { diff --git a/app/vendor/cakephp/cakephp/src/View/Exception/MissingTemplateException.php b/app/vendor/cakephp/cakephp/src/View/Exception/MissingTemplateException.php index 7b7fd8dc2..59a58a888 100644 --- a/app/vendor/cakephp/cakephp/src/View/Exception/MissingTemplateException.php +++ b/app/vendor/cakephp/cakephp/src/View/Exception/MissingTemplateException.php @@ -86,8 +86,7 @@ public function formatMessage(): string /** * Get the passed in attributes * - * @return array - * @phpstan-return array{file: string, paths: array} + * @return array{file: string, paths: array} */ public function getAttributes(): array { diff --git a/app/vendor/cakephp/cakephp/src/View/Form/EntityContext.php b/app/vendor/cakephp/cakephp/src/View/Form/EntityContext.php index 2ce89ffdf..2ce73a4da 100644 --- a/app/vendor/cakephp/cakephp/src/View/Form/EntityContext.php +++ b/app/vendor/cakephp/cakephp/src/View/Form/EntityContext.php @@ -234,7 +234,7 @@ public function val(string $field, array $options = []): mixed 'schemaDefault' => true, ]; - if (empty($this->_context['entity'])) { + if (!$this->_context['entity']) { return $options['default']; } $parts = explode('.', $field); @@ -489,9 +489,16 @@ public function isRequired(string $field): ?bool $validator = $this->_getValidator($parts); $fieldName = array_pop($parts); + if (!$validator->hasField($fieldName)) { return null; } + // If allowEmpty was given a callable (e.g. allowEmptyString('field', function(...) {})), + // we cannot evaluate it here because we don't have the submitted form data yet. + // Return null so FormHelper skips adding required="required" to the input. + if (is_callable($validator->field($fieldName)->isEmptyAllowed())) { + return null; + } if ($this->type($field) !== 'boolean') { return !$validator->isEmptyAllowed($fieldName, $isNew); } @@ -575,7 +582,7 @@ public function fieldNames(): array */ protected function _getValidator(array $parts): Validator { - $keyParts = array_filter(array_slice($parts, 0, -1), function ($part) { + $keyParts = array_filter(array_slice($parts, 0, -1), function (string $part) { return !is_numeric($part); }); $key = implode('.', $keyParts); @@ -625,7 +632,7 @@ protected function _getTable(EntityInterface|array|string $parts, bool $fallback return $this->_tables[$this->_rootName]; } - $normalized = array_slice(array_filter($parts, function ($part) { + $normalized = array_slice(array_filter($parts, function (string $part) { return !is_numeric($part); }), 0, -1); @@ -645,10 +652,9 @@ protected function _getTable(EntityInterface|array|string $parts, bool $fallback $table = $assoc->junction(); $assoc = null; continue; - } else { - $associationCollection = $table->associations(); - $assoc = $associationCollection->getByProperty($part); } + $associationCollection = $table->associations(); + $assoc = $associationCollection->getByProperty($part); if ($assoc === null) { if ($fallback) { @@ -674,9 +680,8 @@ protected function _getTable(EntityInterface|array|string $parts, bool $fallback public function type(string $field): ?string { $parts = explode('.', $field); - $table = $this->_getTable($parts); - return $table?->getSchema()->baseColumnType(array_pop($parts)); + return $this->_getTable($parts)?->getSchema()->baseColumnType(array_pop($parts)); } /** diff --git a/app/vendor/cakephp/cakephp/src/View/Helper.php b/app/vendor/cakephp/cakephp/src/View/Helper.php index 764c89c49..d6c5db73a 100644 --- a/app/vendor/cakephp/cakephp/src/View/Helper.php +++ b/app/vendor/cakephp/cakephp/src/View/Helper.php @@ -39,6 +39,8 @@ * - `beforeRenderFile(EventInterface $event, $viewFile)` - Called before any view fragment is rendered. * - `afterRenderFile(EventInterface $event, $viewFile, $content)` - Called after any view fragment is rendered. * If a listener returns a non-null value, the output of the rendered file will be set to that. + * + * @template TView of \Cake\View\View */ class Helper implements EventListenerInterface { @@ -61,21 +63,21 @@ class Helper implements EventListenerInterface /** * Loaded helper instances. * - * @var array + * @var array> */ protected array $helperInstances = []; /** * The View instance this helper is attached to * - * @var \Cake\View\View + * @var TView */ protected View $_View; /** * Default Constructor * - * @param \Cake\View\View $view The View this helper is being attached to. + * @param TView $view The View this helper is being attached to. * @param array $config Configuration settings for the helper. */ public function __construct(View $view, array $config = []) @@ -94,7 +96,7 @@ public function __construct(View $view, array $config = []) * Lazy loads helpers. * * @param string $name Name of the property being accessed. - * @return \Cake\View\Helper|null Helper instance if helper with provided name exists + * @return \Cake\View\Helper<\Cake\View\View>|null Helper instance if helper with provided name exists */ public function __get(string $name): ?Helper { @@ -114,7 +116,7 @@ public function __get(string $name): ?Helper /** * Get the view instance this helper is bound to. * - * @return \Cake\View\View The bound view instance. + * @return TView The bound view instance. */ public function getView(): View { diff --git a/app/vendor/cakephp/cakephp/src/View/Helper/BreadcrumbsHelper.php b/app/vendor/cakephp/cakephp/src/View/Helper/BreadcrumbsHelper.php index 6d1e25ce7..87de279a2 100644 --- a/app/vendor/cakephp/cakephp/src/View/Helper/BreadcrumbsHelper.php +++ b/app/vendor/cakephp/cakephp/src/View/Helper/BreadcrumbsHelper.php @@ -19,11 +19,13 @@ use Cake\View\Helper; use Cake\View\StringTemplateTrait; use LogicException; +use function Cake\Core\deprecationWarning; /** * BreadcrumbsHelper to register and display a breadcrumb trail for your views * * @property \Cake\View\Helper\UrlHelper $Url + * @extends \Cake\View\Helper<\Cake\View\View> */ class BreadcrumbsHelper extends Helper { @@ -70,7 +72,7 @@ class BreadcrumbsHelper extends Helper * * @param array|string|null $url URL of the crumb. Either a string, an array of route params to pass to * Url::build() or null / empty if the crumb does not have a link. - * @param array $options Array of options. These options will be used as attributes HTML attribute the crumb will + * @param array $options Array of options. These options will be used as HTML attributes the crumb will * be rendered in (a
  • tag by default). It accepts two special keys: * * - *innerAttrs*: An array that allows you to define attributes for the inner element of the crumb (by default, to @@ -81,11 +83,13 @@ class BreadcrumbsHelper extends Helper public function add(array|string $title, array|string|null $url = null, array $options = []) { if (is_array($title)) { - foreach ($title as $crumb) { - $this->crumbs[] = $crumb + ['title' => '', 'url' => null, 'options' => []]; - } + deprecationWarning( + '5.3.0', + 'Passing an array as the first argument to BreadcrumbsHelper::add() is deprecated. ' . + 'Use addMany() instead.', + ); - return $this; + return $this->addMany($title, $options); } $this->crumbs[] = compact('title', 'url', 'options'); @@ -93,6 +97,30 @@ public function add(array|string $title, array|string|null $url = null, array $o return $this; } + /** + * Add multiple crumbs to the end of the trail. + * + * @param array}> $crumbs Array of crumbs to add. + * @param array $options Shared options for all crumbs. These options will be used as defaults + * for each crumb, with individual crumb options taking precedence. These options will be used as attributes + * HTML attribute the crumb will be rendered in (a
  • tag by default). It accepts two special keys: + * + * - *innerAttrs*: An array that allows you to define attributes for the inner element of the crumb (by default, to + * the link) + * - *templateVars*: Specific template vars in case you override the templates provided. + * @return $this + */ + public function addMany(array $crumbs, array $options = []) + { + foreach ($crumbs as $crumb) { + $crumb += ['title' => '', 'url' => null, 'options' => []]; + $crumb['options'] += $options; + $this->crumbs[] = $crumb; + } + + return $this; + } + /** * Prepend a crumb to the start of the queue. * @@ -106,7 +134,7 @@ public function add(array|string $title, array|string|null $url = null, array $o * * @param array|string|null $url URL of the crumb. Either a string, an array of route params to pass to * Url::build() or null / empty if the crumb does not have a link. - * @param array $options Array of options. These options will be used as attributes HTML attribute the crumb will + * @param array $options Array of options. These options will be used as HTML attributes the crumb will * be rendered in (a
  • tag by default). It accepts two special keys: * * - *innerAttrs*: An array that allows you to define attributes for the inner element of the crumb (by default, to @@ -117,14 +145,13 @@ public function add(array|string $title, array|string|null $url = null, array $o public function prepend(array|string $title, array|string|null $url = null, array $options = []) { if (is_array($title)) { - $crumbs = []; - foreach ($title as $crumb) { - $crumbs[] = $crumb + ['title' => '', 'url' => null, 'options' => []]; - } - - array_splice($this->crumbs, 0, 0, $crumbs); + deprecationWarning( + '5.3.0', + 'Passing an array as the first argument to BreadcrumbsHelper::prepend() is deprecated. ' . + 'Use prependMany() instead.', + ); - return $this; + return $this->prependMany($title, $options); } array_unshift($this->crumbs, compact('title', 'url', 'options')); @@ -132,6 +159,33 @@ public function prepend(array|string $title, array|string|null $url = null, arra return $this; } + /** + * Prepend multiple crumbs to the start of the queue. + * + * @param array}> $crumbs Array of crumbs to prepend. + * @param array $options Shared options for all crumbs. These options will be used as defaults + * for each crumb, with individual crumb options taking precedence. These options will be used as attributes + * HTML attribute the crumb will be rendered in (a
  • tag by default). It accepts two special keys: + * + * - *innerAttrs*: An array that allows you to define attributes for the inner element of the crumb (by default, to + * the link) + * - *templateVars*: Specific template vars in case you override the templates provided. + * @return $this + */ + public function prependMany(array $crumbs, array $options = []) + { + $prepend = []; + foreach ($crumbs as $crumb) { + $crumb += ['title' => '', 'url' => null, 'options' => []]; + $crumb['options'] += $options; + $prepend[] = $crumb; + } + + array_splice($this->crumbs, 0, 0, $prepend); + + return $this; + } + /** * Insert a crumb at a specific index. * @@ -145,7 +199,7 @@ public function prepend(array|string $title, array|string|null $url = null, arra * @param string $title Title of the crumb. * @param array|string|null $url URL of the crumb. Either a string, an array of route params to pass to * Url::build() or null / empty if the crumb does not have a link. - * @param array $options Array of options. These options will be used as attributes HTML attribute the crumb will + * @param array $options Array of options. These options will be used as HTML attributes the crumb will * be rendered in (a
  • tag by default). It accepts two special keys: * * - *innerAttrs*: An array that allows you to define attributes for the inner element of the crumb (by default, to @@ -175,7 +229,7 @@ public function insertAt(int $index, string $title, array|string|null $url = nul * @param string $title Title of the crumb. * @param array|string|null $url URL of the crumb. Either a string, an array of route params to pass to * Url::build() or null / empty if the crumb does not have a link. - * @param array $options Array of options. These options will be used as attributes HTML attribute the crumb will + * @param array $options Array of options. These options will be used as HTML attributes the crumb will * be rendered in (a
  • tag by default). It accepts two special keys: * * - *innerAttrs*: An array that allows you to define attributes for the inner element of the crumb (by default, to @@ -209,7 +263,7 @@ public function insertBefore( * @param string $title Title of the crumb. * @param array|string|null $url URL of the crumb. Either a string, an array of route params to pass to * Url::build() or null / empty if the crumb does not have a link. - * @param array $options Array of options. These options will be used as attributes HTML attribute the crumb will + * @param array $options Array of options. These options will be used as HTML attributes the crumb will * be rendered in (a
  • tag by default). It accepts two special keys: * * - *innerAttrs*: An array that allows you to define attributes for the inner element of the crumb (by default, to diff --git a/app/vendor/cakephp/cakephp/src/View/Helper/FlashHelper.php b/app/vendor/cakephp/cakephp/src/View/Helper/FlashHelper.php index 86e8a4886..6448b7234 100644 --- a/app/vendor/cakephp/cakephp/src/View/Helper/FlashHelper.php +++ b/app/vendor/cakephp/cakephp/src/View/Helper/FlashHelper.php @@ -23,6 +23,8 @@ * * After setting messages in your controllers with FlashComponent, you can use * this class to output your flash messages in your views. + * + * @extends \Cake\View\Helper<\Cake\View\View> */ class FlashHelper extends Helper { diff --git a/app/vendor/cakephp/cakephp/src/View/Helper/FormHelper.php b/app/vendor/cakephp/cakephp/src/View/Helper/FormHelper.php index 89044d05c..c9bc5c57f 100644 --- a/app/vendor/cakephp/cakephp/src/View/Helper/FormHelper.php +++ b/app/vendor/cakephp/cakephp/src/View/Helper/FormHelper.php @@ -56,6 +56,7 @@ * @property \Cake\View\Helper\HtmlHelper $Html * @property \Cake\View\Helper\UrlHelper $Url * @link https://book.cakephp.org/5/en/views/helpers/form.html + * @extends \Cake\View\Helper<\Cake\View\View> */ class FormHelper extends Helper { @@ -76,7 +77,7 @@ class FormHelper extends Helper */ protected array $_defaultConfig = [ 'idPrefix' => null, - // Deprecated option, use templates.errorClass intead. + // Deprecated option, use templates.errorClass instead. 'errorClass' => null, 'defaultPostLinkBlock' => null, 'typeMap' => [ @@ -105,9 +106,9 @@ class FormHelper extends Helper // Used for checkboxes in checkbox() and multiCheckbox(). 'checkbox' => '', // Input group wrapper for checkboxes created via control(). - 'checkboxFormGroup' => '{{label}}', + 'checkboxFormGroup' => '{{input}}{{label}}', // Wrapper container for checkboxes in a multicheckbox input - 'checkboxWrapper' => '
    {{label}}
    ', + 'checkboxWrapper' => '
    {{input}}{{label}}
    ', // Error message wrapper elements. 'error' => '
    {{content}}
    ', // Container for error items. @@ -156,7 +157,7 @@ class FormHelper extends Helper // Radio input element, 'radio' => '', // Wrapping container for radio input/label, - 'radioWrapper' => '{{label}}', + 'radioWrapper' => '{{input}}{{label}}', // Textarea input element, 'textarea' => '', // Container for submit buttons. @@ -179,6 +180,8 @@ class FormHelper extends Helper ], // set HTML5 validation message to custom required/empty messages 'autoSetCustomValidity' => true, + // Whether checkboxes and radios should be wrapped in a label element + 'nestedCheckboxAndRadio' => true, ]; /** @@ -382,7 +385,7 @@ public function contextFactory(?ContextFactory $instance = null, array $contexts * array of meta data. You can use `null` to make a context-less form. * @param array $options An array of html attributes and options. * @return string An formatted opening FORM tag. - * @link https://book.cakephp.org/5/en/views/helpers/form.html#Cake\View\Helper\FormHelper::create + * @link https://book.cakephp.org/5/en/views/helpers/form.html#starting-a-form */ public function create(mixed $context = null, array $options = []): string { @@ -1149,7 +1152,7 @@ public function control(string $fieldName, array $options = []): string $nestedInput = false; if ($options['type'] === 'checkbox') { - $nestedInput = true; + $nestedInput = $this->getConfig('nestedCheckboxAndRadio'); } $nestedInput = $options['nestedInput'] ?? $nestedInput; unset($options['nestedInput']); @@ -1256,7 +1259,7 @@ protected function _getInput(string $fieldName, array $options): array|string case 'radio': case 'multicheckbox': $opts = $options['options']; - if ($opts == null) { + if ($opts === null) { $opts = []; } unset($options['options']); @@ -1648,6 +1651,7 @@ public function radio(string $fieldName, iterable $options = [], array $attribut { $attributes['options'] = $options; $attributes['idPrefix'] = $this->_idPrefix; + $attributes['nestedInput'] ??= $this->getConfig('nestedCheckboxAndRadio'); $generatedHiddenId = false; if (!isset($attributes['id'])) { @@ -2181,6 +2185,7 @@ public function select(string $fieldName, iterable $options = [], array $attribu if ($attributes['multiple'] === 'checkbox') { unset($attributes['multiple'], $attributes['empty']); + $attributes['nestedInput'] = $this->getConfig('nestedCheckboxAndRadio'); return $this->multiCheckbox($fieldName, $options, $attributes); } @@ -2296,7 +2301,7 @@ public function multiCheckbox(string $fieldName, iterable $options, array $attri * @param string $fieldName The field name. * @param array $options Options & attributes for the select elements. * @return string Completed year select input - * @link https://book.cakephp.org/5/en/views/helpers/form.html#creating-year-inputs + * @link https://book.cakephp.org/5/en/views/helpers/form.html#creating-year-controls */ public function year(string $fieldName, array $options = []): string { @@ -2429,9 +2434,7 @@ protected function _initInputField(string $field, array $options = []): array { $options += ['fieldName' => $field]; - if (!isset($options['secure'])) { - $options['secure'] = $this->_View->getRequest()->getAttribute('formTokenData') !== null; - } + $options['secure'] ??= $this->_View->getRequest()->getAttribute('formTokenData') !== null; $context = $this->_getContext(); if (isset($options['id']) && $options['id'] === true) { @@ -2517,7 +2520,7 @@ protected function _isDisabled(array $options): bool if (is_array($first)) { $disabled = array_filter( $options['options'], - fn($i) => in_array($i['value'], $options['disabled'], true), + fn(array $i) => in_array($i['value'], $options['disabled'], true), ); return $disabled !== []; @@ -2681,8 +2684,8 @@ protected function validateValueSources(array $sources): void $diff = array_diff($sources, $this->supportedValueSources); if ($diff) { - array_walk($diff, fn(&$x) => $x = "`{$x}`"); - array_walk($this->supportedValueSources, fn(&$x) => $x = "`{$x}`"); + array_walk($diff, fn(string &$x) => $x = "`{$x}`"); + array_walk($this->supportedValueSources, fn(string &$x) => $x = "`{$x}`"); throw new InvalidArgumentException(sprintf( 'Invalid value source(s): %s. Valid values are: %s.', implode(', ', $diff), diff --git a/app/vendor/cakephp/cakephp/src/View/Helper/HtmlHelper.php b/app/vendor/cakephp/cakephp/src/View/Helper/HtmlHelper.php index 6ff41d662..aeed440de 100644 --- a/app/vendor/cakephp/cakephp/src/View/Helper/HtmlHelper.php +++ b/app/vendor/cakephp/cakephp/src/View/Helper/HtmlHelper.php @@ -29,6 +29,7 @@ * * @property \Cake\View\Helper\UrlHelper $Url * @link https://book.cakephp.org/5/en/views/helpers/html.html + * @extends \Cake\View\Helper<\Cake\View\View> */ class HtmlHelper extends Helper { @@ -76,9 +77,7 @@ class HtmlHelper extends Helper 'ol' => '{{content}}', 'li' => '{{content}}
    • ', 'javascriptblock' => '{{content}}', - 'javascriptstart' => '', - 'javascriptend' => '', 'confirmJs' => '{{confirm}}', ], ]; @@ -189,13 +188,6 @@ public function meta(array|string $type, array|string|null $content = null, arra } else { $options['link'] = $this->Url->assetUrl($options['link']); } - if (isset($options['rel']) && $options['rel'] === 'icon') { - $out = $this->formatTemplate('metalink', [ - 'url' => $options['link'], - 'attrs' => $this->templater()->formatAttributes($options, ['block', 'link']), - ]); - $options['rel'] = 'shortcut icon'; - } $out .= $this->formatTemplate('metalink', [ 'url' => $options['link'], 'attrs' => $this->templater()->formatAttributes($options, ['block', 'link']), @@ -232,7 +224,7 @@ public function charset(?string $charset = null): string } return $this->formatTemplate('charset', [ - 'charset' => !empty($charset) ? $charset : 'utf-8', + 'charset' => $charset ?: 'utf-8', ]); } @@ -325,7 +317,7 @@ public function link(array|string $title, array|string|null $url = null, array $ * @param array $options Array of options and HTML attributes. * @return string An `` element. * @see \Cake\Routing\Router::pathUrl() - * @link https://book.cakephp.org/5/en/views/helpers/html.html#creating-links + * @link https://book.cakephp.org/5/en/views/helpers/html.html#creating-links-from-route-paths */ public function linkFromPath(string $title, string $path, array $params = [], array $options = []): string { @@ -657,6 +649,10 @@ public function scriptStart(array $options = []): void public function scriptEnd(): ?string { $buffer = (string)ob_get_clean(); + preg_match('/^\s* - - - diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/Template/dashboard_branch.html.dist b/app/vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/Template/dashboard_branch.html.dist index eb003154a..a2a2b7bed 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/Template/dashboard_branch.html.dist +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/Template/dashboard_branch.html.dist @@ -5,7 +5,6 @@ Dashboard for {{full_path}} - @@ -24,109 +23,35 @@
    -
    -
    -

    Classes

    -
    -
    -
    -
    -

    Coverage Distribution

    -
    - -
    -
    +
    -

    Complexity

    -
    - +

    Classes

    +

    Bubble size = executable lines. Hover for details, click to navigate.

    +
    +{{class_bubble_chart}}
    -
    -
    -
    -

    Insufficient Coverage

    -
    - - - - - - - - -{{insufficient_coverage_classes}} - -
    ClassCoverage
    -
    -
    -
    -

    Project Risks

    +
    +

     

    +

    Sorted by descending CRAP (Change Risk Anti-Patterns) index.

    - - - - - - - - -{{project_risks_classes}} - -
    ClassCRAP
    +{{class_crap_table}}
    -
    -
    -

    Methods

    -
    -
    -
    -
    -

    Coverage Distribution

    -
    - -
    -
    +
    -

    Complexity

    -
    - +

    Methods

    +

    Bubble size = executable lines. Hover for details, click to navigate.

    +
    +{{method_bubble_chart}}
    -
    -
    -
    -

    Insufficient Coverage

    -
    - - - - - - - - -{{insufficient_coverage_methods}} - -
    MethodCoverage
    -
    -
    -
    -

    Project Risks

    +
    +

     

    +

    Sorted by descending CRAP (Change Risk Anti-Patterns) index.

    - - - - - - - - -{{project_risks_methods}} - -
    MethodCRAP
    +{{method_crap_table}}
    @@ -137,157 +62,5 @@

    - - - - diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/Template/js/billboard.pkgd.min.js b/app/vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/Template/js/billboard.pkgd.min.js deleted file mode 100644 index 52128a864..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Html/Renderer/Template/js/billboard.pkgd.min.js +++ /dev/null @@ -1,57 +0,0 @@ -/*! - * Copyright (c) 2017 ~ present NAVER Corp. - * billboard.js project is licensed under the MIT license - * - * billboard.js, JavaScript chart library - * https://naver.github.io/billboard.js/ - * - * @version 3.15.1 - * - * All-in-one packaged file for ease use of 'billboard.js' with dependant d3.js modules & polyfills. - * - @types/d3-selection ^3.0.11 - * - @types/d3-transition ^3.0.9 - * - d3-axis ^3.0.0 - * - d3-brush ^3.0.0 - * - d3-drag ^3.0.0 - * - d3-dsv ^3.0.1 - * - d3-ease ^3.0.1 - * - d3-hierarchy ^3.1.2 - * - d3-interpolate ^3.0.1 - * - d3-scale ^4.0.2 - * - d3-selection ^3.0.0 - * - d3-shape ^3.2.0 - * - d3-time-format ^4.1.0 - * - d3-transition ^3.0.1 - * - d3-zoom ^3.0.0 - */(function(Xa,zn){if(typeof exports=="object"&&typeof module=="object")module.exports=zn();else if(typeof define=="function"&&define.amd)define([],zn);else{var Ha=zn();for(var x in Ha)(typeof exports=="object"?exports:Xa)[x]=Ha[x]}})(this,function(){return function(){"use strict";var Cs=[function(x,b,r){r(1),r(97),r(98),r(99),r(100),r(101),r(102),r(103),r(104),r(105),r(106),r(107),r(108),r(109),r(110),r(111),r(124),r(126),r(136),r(137),r(139),r(143),r(146),r(148),r(150),r(151),r(152),r(153),r(155),r(156),r(158),r(159),r(161),r(165),r(166),r(167),r(168),r(173),r(174),r(176),r(177),r(178),r(180),r(184),r(185),r(186),r(187),r(188),r(193),r(195),r(196),r(198),r(201),r(202),r(203),r(204),r(205),r(207),r(218),r(220),r(221),r(223),r(224),r(227),r(230),r(236),r(237),r(238),r(239),r(240),r(241),r(245),r(246),r(248),r(249),r(250),r(252),r(253),r(254),r(255),r(256),r(261),r(262),r(263),r(264),r(266),r(267),r(268),r(270),r(271),r(272),r(273),r(93),r(274),r(275),r(283),r(285),r(287),r(288),r(289),r(290),r(291),r(293),r(294),r(295),r(296),r(297),r(298),r(300),r(301),r(302),r(303),r(304),r(305),r(306),r(307),r(311),r(312),r(314),r(316),r(317),r(318),r(319),r(320),r(322),r(324),r(325),r(326),r(327),r(329),r(330),r(332),r(333),r(334),r(335),r(337),r(338),r(339),r(340),r(341),r(342),r(343),r(344),r(345),r(347),r(348),r(349),r(350),r(351),r(352),r(353),r(354),r(355),r(356),r(357),r(359),r(360),r(361),r(362),r(386),r(387),r(388),r(389),r(390),r(391),r(392),r(393),r(394),r(395),r(397),r(398),r(399),r(400),r(401),r(402),r(403),r(404),r(405),r(406),r(413),r(415),r(416),r(418),r(419),r(420),r(421),r(422),r(424),r(434),r(436),r(438),r(440),r(442),r(444),r(446),r(447),r(449),r(452),r(453),r(454),r(455),r(456),r(460),r(461),r(463),r(464),r(465),r(466),r(468),r(469),r(470),r(471),r(472),r(473),r(474),r(476),r(479),r(482),r(485),r(486),r(487),r(488),r(489),r(490),r(491),r(492),r(493),r(494),r(495),r(496),r(497),r(505),r(506),r(507),r(508),r(509),r(510),r(511),r(512),r(513),r(514),r(515),r(516),r(517),r(519),r(520),r(521),r(522),r(523),r(524),r(525),r(526),r(527),r(528),r(529),r(530),r(531),r(532),r(533),r(534),r(535),r(536),r(537),r(538),r(539),r(540),r(541),r(542),r(543),r(544),r(545),r(546),r(549),r(551),r(553),r(554),r(557),r(558),r(560),r(561),r(562),r(566),r(567),r(568),r(569),r(572),r(577),r(578),r(579),r(580),r(581),r(582),r(583),r(80)},function(x,b,r){r(2),r(90),r(92),r(93),r(96)},function(x,b,r){var u=r(3),d=r(4),h=r(8),p=r(14),y=r(36),T=r(6),$=r(26),A=r(7),E=r(38),R=r(24),I=r(46),O=r(12),C=r(18),D=r(68),M=r(11),F=r(71),z=r(73),U=r(57),j=r(75),G=r(66),B=r(5),V=r(44),Y=r(72),Z=r(10),J=r(47),q=r(77),nt=r(34),rt=r(53),_=r(54),tt=r(40),et=r(33),lt=r(78),mt=r(79),gt=r(81),xt=r(82),yt=r(51),Ut=r(83).forEach,Dt=rt("hidden"),Xt="Symbol",Qt="prototype",kt=yt.set,me=yt.getterFor(Xt),ge=Object[Qt],ae=d.Symbol,Mt=ae&&ae[Qt],Ht=d.RangeError,re=d.TypeError,se=d.QObject,ee=B.f,fe=V.f,Pe=j.f,Me=Z.f,$e=p([].push),ce=nt("symbols"),Ae=nt("op-symbols"),Te=nt("wks"),de=!se||!se[Qt]||!se[Qt].findChild,bt=function(It,Pt,Ct){var Nt=ee(ge,Pt);Nt&&delete ge[Pt],fe(It,Pt,Ct),Nt&&It!==ge&&fe(ge,Pt,Nt)},Ft=T&&A(function(){return F(fe({},"a",{get:function(){return fe(this,"a",{value:7}).a}})).a!==7})?bt:fe,Tt=function(It,Pt){var Ct=ce[It]=F(Mt);return kt(Ct,{type:Xt,tag:It,description:Pt}),T||(Ct.description=Pt),Ct},qt=function(Pt,Ct,Nt){Pt===ge&&qt(Ae,Ct,Nt),I(Pt);var Et=C(Ct);return I(Nt),E(ce,Et)?(Nt.enumerable?(E(Pt,Dt)&&Pt[Dt][Et]&&(Pt[Dt][Et]=!1),Nt=F(Nt,{enumerable:M(0,!1)})):(E(Pt,Dt)||fe(Pt,Dt,M(1,F(null))),Pt[Dt][Et]=!0),Ft(Pt,Et,Nt)):fe(Pt,Et,Nt)},te=function(Pt,Ct){I(Pt);var Nt=O(Ct),Et=z(Nt).concat(ut(Nt));return Ut(Et,function(ie){(!T||h(Yt,Nt,ie))&&qt(Pt,ie,Nt[ie])}),Pt},Zt=function(Pt,Ct){return Ct===void 0?F(Pt):te(F(Pt),Ct)},Yt=function(Pt){var Ct=C(Pt),Nt=h(Me,this,Ct);return this===ge&&E(ce,Ct)&&!E(Ae,Ct)?!1:Nt||!E(this,Ct)||!E(ce,Ct)||E(this,Dt)&&this[Dt][Ct]?Nt:!0},Ye=function(Pt,Ct){var Nt=O(Pt),Et=C(Ct);if(!(Nt===ge&&E(ce,Et)&&!E(Ae,Et))){var ie=ee(Nt,Et);return ie&&E(ce,Et)&&!(E(Nt,Dt)&&Nt[Dt][Et])&&(ie.enumerable=!0),ie}},Ze=function(Pt){var Ct=Pe(O(Pt)),Nt=[];return Ut(Ct,function(Et){!E(ce,Et)&&!E(_,Et)&&$e(Nt,Et)}),Nt},ut=function(It){var Pt=It===ge,Ct=Pe(Pt?Ae:O(It)),Nt=[];return Ut(Ct,function(Et){E(ce,Et)&&(!Pt||E(ge,Et))&&$e(Nt,ce[Et])}),Nt};$||(ae=function(){if(R(Mt,this))throw new re("Symbol is not a constructor");var Pt=!arguments.length||arguments[0]===void 0?void 0:D(arguments[0]),Ct=tt(Pt),Nt=function(Et){var ie=this===void 0?d:this;ie===ge&&h(Nt,Ae,Et),E(ie,Dt)&&E(ie[Dt],Ct)&&(ie[Dt][Ct]=!1);var we=M(1,Et);try{Ft(ie,Ct,we)}catch(Rt){if(!(Rt instanceof Ht))throw Rt;bt(ie,Ct,we)}};return T&&de&&Ft(ge,Ct,{configurable:!0,set:Nt}),Tt(Ct,Pt)},Mt=ae[Qt],J(Mt,"toString",function(){return me(this).tag}),J(ae,"withoutSetter",function(It){return Tt(tt(It),It)}),Z.f=Yt,V.f=qt,Y.f=te,B.f=Ye,U.f=j.f=Ze,G.f=ut,lt.f=function(It){return Tt(et(It),It)},T&&(q(Mt,"description",{configurable:!0,get:function(){return me(this).description}}),y||J(ge,"propertyIsEnumerable",Yt,{unsafe:!0}))),u({global:!0,constructor:!0,wrap:!0,forced:!$,sham:!$},{Symbol:ae}),Ut(z(Te),function(It){mt(It)}),u({target:Xt,stat:!0,forced:!$},{useSetter:function(){de=!0},useSimple:function(){de=!1}}),u({target:"Object",stat:!0,forced:!$,sham:!T},{create:Zt,defineProperty:qt,defineProperties:te,getOwnPropertyDescriptor:Ye}),u({target:"Object",stat:!0,forced:!$},{getOwnPropertyNames:Ze}),gt(),xt(ae,Xt),_[Dt]=!0},function(x,b,r){var u=r(4),d=r(5).f,h=r(43),p=r(47),y=r(37),T=r(55),$=r(67);x.exports=function(A,E){var R=A.target,I=A.global,O=A.stat,C,D,M,F,z,U;if(I?D=u:O?D=u[R]||y(R,{}):D=u[R]&&u[R].prototype,D)for(M in E){if(z=E[M],A.dontCallGetSet?(U=d(D,M),F=U&&U.value):F=D[M],C=$(I?M:R+(O?".":"#")+M,A.forced),!C&&F!==void 0){if(typeof z==typeof F)continue;T(z,F)}(A.sham||F&&F.sham)&&h(z,"sham",!0),p(D,M,z,A)}}},function(x){var b=function(r){return r&&r.Math===Math&&r};x.exports=b(typeof globalThis=="object"&&globalThis)||b(typeof window=="object"&&window)||b(typeof self=="object"&&self)||b(typeof global=="object"&&global)||b(typeof this=="object"&&this)||function(){return this}()||Function("return this")()},function(x,b,r){var u=r(6),d=r(8),h=r(10),p=r(11),y=r(12),T=r(18),$=r(38),A=r(41),E=Object.getOwnPropertyDescriptor;b.f=u?E:function(I,O){if(I=y(I),O=T(O),A)try{return E(I,O)}catch(C){}if($(I,O))return p(!d(h.f,I,O),I[O])}},function(x,b,r){var u=r(7);x.exports=!u(function(){return Object.defineProperty({},1,{get:function(){return 7}})[1]!==7})},function(x){x.exports=function(b){try{return!!b()}catch(r){return!0}}},function(x,b,r){var u=r(9),d=Function.prototype.call;x.exports=u?d.bind(d):function(){return d.apply(d,arguments)}},function(x,b,r){var u=r(7);x.exports=!u(function(){var d=function(){}.bind();return typeof d!="function"||d.hasOwnProperty("prototype")})},function(x,b){var r={}.propertyIsEnumerable,u=Object.getOwnPropertyDescriptor,d=u&&!r.call({1:2},1);b.f=d?function(p){var y=u(this,p);return!!y&&y.enumerable}:r},function(x){x.exports=function(b,r){return{enumerable:!(b&1),configurable:!(b&2),writable:!(b&4),value:r}}},function(x,b,r){var u=r(13),d=r(16);x.exports=function(h){return u(d(h))}},function(x,b,r){var u=r(14),d=r(7),h=r(15),p=Object,y=u("".split);x.exports=d(function(){return!p("z").propertyIsEnumerable(0)})?function(T){return h(T)==="String"?y(T,""):p(T)}:p},function(x,b,r){var u=r(9),d=Function.prototype,h=d.call,p=u&&d.bind.bind(h,h);x.exports=u?p:function(y){return function(){return h.apply(y,arguments)}}},function(x,b,r){var u=r(14),d=u({}.toString),h=u("".slice);x.exports=function(p){return h(d(p),8,-1)}},function(x,b,r){var u=r(17),d=TypeError;x.exports=function(h){if(u(h))throw new d("Can't call method on "+h);return h}},function(x){x.exports=function(b){return b==null}},function(x,b,r){var u=r(19),d=r(22);x.exports=function(h){var p=u(h,"string");return d(p)?p:p+""}},function(x,b,r){var u=r(8),d=r(20),h=r(22),p=r(29),y=r(32),T=r(33),$=TypeError,A=T("toPrimitive");x.exports=function(E,R){if(!d(E)||h(E))return E;var I=p(E,A),O;if(I){if(R===void 0&&(R="default"),O=u(I,E,R),!d(O)||h(O))return O;throw new $("Can't convert object to primitive value")}return R===void 0&&(R="number"),y(E,R)}},function(x,b,r){var u=r(21);x.exports=function(d){return typeof d=="object"?d!==null:u(d)}},function(x){var b=typeof document=="object"&&document.all;x.exports=typeof b=="undefined"&&b!==void 0?function(r){return typeof r=="function"||r===b}:function(r){return typeof r=="function"}},function(x,b,r){var u=r(23),d=r(21),h=r(24),p=r(25),y=Object;x.exports=p?function(T){return typeof T=="symbol"}:function(T){var $=u("Symbol");return d($)&&h($.prototype,y(T))}},function(x,b,r){var u=r(4),d=r(21),h=function(p){return d(p)?p:void 0};x.exports=function(p,y){return arguments.length<2?h(u[p]):u[p]&&u[p][y]}},function(x,b,r){var u=r(14);x.exports=u({}.isPrototypeOf)},function(x,b,r){var u=r(26);x.exports=u&&!Symbol.sham&&typeof Symbol.iterator=="symbol"},function(x,b,r){var u=r(27),d=r(7),h=r(4),p=h.String;x.exports=!!Object.getOwnPropertySymbols&&!d(function(){var y=Symbol("symbol detection");return!p(y)||!(Object(y)instanceof Symbol)||!Symbol.sham&&u&&u<41})},function(x,b,r){var u=r(4),d=r(28),h=u.process,p=u.Deno,y=h&&h.versions||p&&p.version,T=y&&y.v8,$,A;T&&($=T.split("."),A=$[0]>0&&$[0]<4?1:+($[0]+$[1])),!A&&d&&($=d.match(/Edge\/(\d+)/),(!$||$[1]>=74)&&($=d.match(/Chrome\/(\d+)/),$&&(A=+$[1]))),x.exports=A},function(x,b,r){var u=r(4),d=u.navigator,h=d&&d.userAgent;x.exports=h?String(h):""},function(x,b,r){var u=r(30),d=r(17);x.exports=function(h,p){var y=h[p];return d(y)?void 0:u(y)}},function(x,b,r){var u=r(21),d=r(31),h=TypeError;x.exports=function(p){if(u(p))return p;throw new h(d(p)+" is not a function")}},function(x){var b=String;x.exports=function(r){try{return b(r)}catch(u){return"Object"}}},function(x,b,r){var u=r(8),d=r(21),h=r(20),p=TypeError;x.exports=function(y,T){var $,A;if(T==="string"&&d($=y.toString)&&!h(A=u($,y))||d($=y.valueOf)&&!h(A=u($,y))||T!=="string"&&d($=y.toString)&&!h(A=u($,y)))return A;throw new p("Can't convert object to primitive value")}},function(x,b,r){var u=r(4),d=r(34),h=r(38),p=r(40),y=r(26),T=r(25),$=u.Symbol,A=d("wks"),E=T?$.for||$:$&&$.withoutSetter||p;x.exports=function(R){return h(A,R)||(A[R]=y&&h($,R)?$[R]:E("Symbol."+R)),A[R]}},function(x,b,r){var u=r(35);x.exports=function(d,h){return u[d]||(u[d]=h||{})}},function(x,b,r){var u=r(36),d=r(4),h=r(37),p="__core-js_shared__",y=x.exports=d[p]||h(p,{});(y.versions||(y.versions=[])).push({version:"3.41.0",mode:u?"pure":"global",copyright:"\xA9 2014-2025 Denis Pushkarev (zloirock.ru)",license:"https://github.com/zloirock/core-js/blob/v3.41.0/LICENSE",source:"https://github.com/zloirock/core-js"})},function(x){x.exports=!1},function(x,b,r){var u=r(4),d=Object.defineProperty;x.exports=function(h,p){try{d(u,h,{value:p,configurable:!0,writable:!0})}catch(y){u[h]=p}return p}},function(x,b,r){var u=r(14),d=r(39),h=u({}.hasOwnProperty);x.exports=Object.hasOwn||function(y,T){return h(d(y),T)}},function(x,b,r){var u=r(16),d=Object;x.exports=function(h){return d(u(h))}},function(x,b,r){var u=r(14),d=0,h=Math.random(),p=u(1 .toString);x.exports=function(y){return"Symbol("+(y===void 0?"":y)+")_"+p(++d+h,36)}},function(x,b,r){var u=r(6),d=r(7),h=r(42);x.exports=!u&&!d(function(){return Object.defineProperty(h("div"),"a",{get:function(){return 7}}).a!==7})},function(x,b,r){var u=r(4),d=r(20),h=u.document,p=d(h)&&d(h.createElement);x.exports=function(y){return p?h.createElement(y):{}}},function(x,b,r){var u=r(6),d=r(44),h=r(11);x.exports=u?function(p,y,T){return d.f(p,y,h(1,T))}:function(p,y,T){return p[y]=T,p}},function(x,b,r){var u=r(6),d=r(41),h=r(45),p=r(46),y=r(18),T=TypeError,$=Object.defineProperty,A=Object.getOwnPropertyDescriptor,E="enumerable",R="configurable",I="writable";b.f=u?h?function(C,D,M){if(p(C),D=y(D),p(M),typeof C=="function"&&D==="prototype"&&"value"in M&&I in M&&!M[I]){var F=A(C,D);F&&F[I]&&(C[D]=M.value,M={configurable:R in M?M[R]:F[R],enumerable:E in M?M[E]:F[E],writable:!1})}return $(C,D,M)}:$:function(C,D,M){if(p(C),D=y(D),p(M),d)try{return $(C,D,M)}catch(F){}if("get"in M||"set"in M)throw new T("Accessors not supported");return"value"in M&&(C[D]=M.value),C}},function(x,b,r){var u=r(6),d=r(7);x.exports=u&&d(function(){return Object.defineProperty(function(){},"prototype",{value:42,writable:!1}).prototype!==42})},function(x,b,r){var u=r(20),d=String,h=TypeError;x.exports=function(p){if(u(p))return p;throw new h(d(p)+" is not an object")}},function(x,b,r){var u=r(21),d=r(44),h=r(48),p=r(37);x.exports=function(y,T,$,A){A||(A={});var E=A.enumerable,R=A.name!==void 0?A.name:T;if(u($)&&h($,R,A),A.global)E?y[T]=$:p(T,$);else{try{A.unsafe?y[T]&&(E=!0):delete y[T]}catch(I){}E?y[T]=$:d.f(y,T,{value:$,enumerable:!1,configurable:!A.nonConfigurable,writable:!A.nonWritable})}return y}},function(x,b,r){var u=r(14),d=r(7),h=r(21),p=r(38),y=r(6),T=r(49).CONFIGURABLE,$=r(50),A=r(51),E=A.enforce,R=A.get,I=String,O=Object.defineProperty,C=u("".slice),D=u("".replace),M=u([].join),F=y&&!d(function(){return O(function(){},"length",{value:8}).length!==8}),z=String(String).split("String"),U=x.exports=function(j,G,B){C(I(G),0,7)==="Symbol("&&(G="["+D(I(G),/^Symbol\(([^)]*)\).*$/,"$1")+"]"),B&&B.getter&&(G="get "+G),B&&B.setter&&(G="set "+G),(!p(j,"name")||T&&j.name!==G)&&(y?O(j,"name",{value:G,configurable:!0}):j.name=G),F&&B&&p(B,"arity")&&j.length!==B.arity&&O(j,"length",{value:B.arity});try{B&&p(B,"constructor")&&B.constructor?y&&O(j,"prototype",{writable:!1}):j.prototype&&(j.prototype=void 0)}catch(Y){}var V=E(j);return p(V,"source")||(V.source=M(z,typeof G=="string"?G:"")),j};Function.prototype.toString=U(function(){return h(this)&&R(this).source||$(this)},"toString")},function(x,b,r){var u=r(6),d=r(38),h=Function.prototype,p=u&&Object.getOwnPropertyDescriptor,y=d(h,"name"),T=y&&function(){}.name==="something",$=y&&(!u||u&&p(h,"name").configurable);x.exports={EXISTS:y,PROPER:T,CONFIGURABLE:$}},function(x,b,r){var u=r(14),d=r(21),h=r(35),p=u(Function.toString);d(h.inspectSource)||(h.inspectSource=function(y){return p(y)}),x.exports=h.inspectSource},function(x,b,r){var u=r(52),d=r(4),h=r(20),p=r(43),y=r(38),T=r(35),$=r(53),A=r(54),E="Object already initialized",R=d.TypeError,I=d.WeakMap,O,C,D,M=function(j){return D(j)?C(j):O(j,{})},F=function(j){return function(G){var B;if(!h(G)||(B=C(G)).type!==j)throw new R("Incompatible receiver, "+j+" required");return B}};if(u||T.state){var z=T.state||(T.state=new I);z.get=z.get,z.has=z.has,z.set=z.set,O=function(j,G){if(z.has(j))throw new R(E);return G.facade=j,z.set(j,G),G},C=function(j){return z.get(j)||{}},D=function(j){return z.has(j)}}else{var U=$("state");A[U]=!0,O=function(j,G){if(y(j,U))throw new R(E);return G.facade=j,p(j,U,G),G},C=function(j){return y(j,U)?j[U]:{}},D=function(j){return y(j,U)}}x.exports={set:O,get:C,has:D,enforce:M,getterFor:F}},function(x,b,r){var u=r(4),d=r(21),h=u.WeakMap;x.exports=d(h)&&/native code/.test(String(h))},function(x,b,r){var u=r(34),d=r(40),h=u("keys");x.exports=function(p){return h[p]||(h[p]=d(p))}},function(x){x.exports={}},function(x,b,r){var u=r(38),d=r(56),h=r(5),p=r(44);x.exports=function(y,T,$){for(var A=d(T),E=p.f,R=h.f,I=0;IR;)d(E,O=A[R++])&&(~p(I,O)||T(I,O));return I}},function(x,b,r){var u=r(12),d=r(60),h=r(63),p=function(y){return function(T,$,A){var E=u(T),R=h(E);if(R===0)return!y&&-1;var I=d(A,R),O;if(y&&$!==$){for(;R>I;)if(O=E[I++],O!==O)return!0}else for(;R>I;I++)if((y||I in E)&&E[I]===$)return y||I||0;return!y&&-1}};x.exports={includes:p(!0),indexOf:p(!1)}},function(x,b,r){var u=r(61),d=Math.max,h=Math.min;x.exports=function(p,y){var T=u(p);return T<0?d(T+y,0):h(T,y)}},function(x,b,r){var u=r(62);x.exports=function(d){var h=+d;return h!==h||h===0?0:u(h)}},function(x){var b=Math.ceil,r=Math.floor;x.exports=Math.trunc||function(d){var h=+d;return(h>0?r:b)(h)}},function(x,b,r){var u=r(64);x.exports=function(d){return u(d.length)}},function(x,b,r){var u=r(61),d=Math.min;x.exports=function(h){var p=u(h);return p>0?d(p,9007199254740991):0}},function(x){x.exports=["constructor","hasOwnProperty","isPrototypeOf","propertyIsEnumerable","toLocaleString","toString","valueOf"]},function(x,b){b.f=Object.getOwnPropertySymbols},function(x,b,r){var u=r(7),d=r(21),h=/#|\.prototype\./,p=function(E,R){var I=T[y(E)];return I===A?!0:I===$?!1:d(R)?u(R):!!R},y=p.normalize=function(E){return String(E).replace(h,".").toLowerCase()},T=p.data={},$=p.NATIVE="N",A=p.POLYFILL="P";x.exports=p},function(x,b,r){var u=r(69),d=String;x.exports=function(h){if(u(h)==="Symbol")throw new TypeError("Cannot convert a Symbol value to a string");return d(h)}},function(x,b,r){var u=r(70),d=r(21),h=r(15),p=r(33),y=p("toStringTag"),T=Object,$=h(function(){return arguments}())==="Arguments",A=function(E,R){try{return E[R]}catch(I){}};x.exports=u?h:function(E){var R,I,O;return E===void 0?"Undefined":E===null?"Null":typeof(I=A(R=T(E),y))=="string"?I:$?h(R):(O=h(R))==="Object"&&d(R.callee)?"Arguments":O}},function(x,b,r){var u=r(33),d=u("toStringTag"),h={};h[d]="z",x.exports=String(h)==="[object z]"},function(x,b,r){var u=r(46),d=r(72),h=r(65),p=r(54),y=r(74),T=r(42),$=r(53),A=">",E="<",R="prototype",I="script",O=$("IE_PROTO"),C=function(){},D=function(j){return E+I+A+j+E+"/"+I+A},M=function(j){j.write(D("")),j.close();var G=j.parentWindow.Object;return j=null,G},F=function(){var j=T("iframe"),G="java"+I+":",B;return j.style.display="none",y.appendChild(j),j.src=String(G),B=j.contentWindow.document,B.open(),B.write(D("document.F=Object")),B.close(),B.F},z,U=function(){try{z=new ActiveXObject("htmlfile")}catch(G){}U=typeof document!="undefined"?document.domain&&z?M(z):F():M(z);for(var j=h.length;j--;)delete U[R][h[j]];return U()};p[O]=!0,x.exports=Object.create||function(G,B){var V;return G!==null?(C[R]=u(G),V=new C,C[R]=null,V[O]=G):V=U(),B===void 0?V:d.f(V,B)}},function(x,b,r){var u=r(6),d=r(45),h=r(44),p=r(46),y=r(12),T=r(73);b.f=u&&!d?Object.defineProperties:function(A,E){p(A);for(var R=y(E),I=T(E),O=I.length,C=0,D;O>C;)h.f(A,D=I[C++],R[D]);return A}},function(x,b,r){var u=r(58),d=r(65);x.exports=Object.keys||function(p){return u(p,d)}},function(x,b,r){var u=r(23);x.exports=u("document","documentElement")},function(x,b,r){var u=r(15),d=r(12),h=r(57).f,p=r(76),y=typeof window=="object"&&window&&Object.getOwnPropertyNames?Object.getOwnPropertyNames(window):[],T=function($){try{return h($)}catch(A){return p(y)}};x.exports.f=function(A){return y&&u(A)==="Window"?T(A):h(d(A))}},function(x,b,r){var u=r(14);x.exports=u([].slice)},function(x,b,r){var u=r(48),d=r(44);x.exports=function(h,p,y){return y.get&&u(y.get,p,{getter:!0}),y.set&&u(y.set,p,{setter:!0}),d.f(h,p,y)}},function(x,b,r){var u=r(33);b.f=u},function(x,b,r){var u=r(80),d=r(38),h=r(78),p=r(44).f;x.exports=function(y){var T=u.Symbol||(u.Symbol={});d(T,y)||p(T,y,{value:h.f(y)})}},function(x,b,r){var u=r(4);x.exports=u},function(x,b,r){var u=r(8),d=r(23),h=r(33),p=r(47);x.exports=function(){var y=d("Symbol"),T=y&&y.prototype,$=T&&T.valueOf,A=h("toPrimitive");T&&!T[A]&&p(T,A,function(E){return u($,this)},{arity:1})}},function(x,b,r){var u=r(44).f,d=r(38),h=r(33),p=h("toStringTag");x.exports=function(y,T,$){y&&!$&&(y=y.prototype),y&&!d(y,p)&&u(y,p,{configurable:!0,value:T})}},function(x,b,r){var u=r(84),d=r(14),h=r(13),p=r(39),y=r(63),T=r(86),$=d([].push),A=function(E){var R=E===1,I=E===2,O=E===3,C=E===4,D=E===6,M=E===7,F=E===5||D;return function(z,U,j,G){for(var B=p(z),V=h(B),Y=y(V),Z=u(U,j),J=0,q=G||T,nt=R?q(z,Y):I||M?q(z,0):void 0,rt,_;Y>J;J++)if((F||J in V)&&(rt=V[J],_=Z(rt,J,B),E))if(R)nt[J]=_;else if(_)switch(E){case 3:return!0;case 5:return rt;case 6:return J;case 2:$(nt,rt)}else switch(E){case 4:return!1;case 7:$(nt,rt)}return D?-1:O||C?C:nt}};x.exports={forEach:A(0),map:A(1),filter:A(2),some:A(3),every:A(4),find:A(5),findIndex:A(6),filterReject:A(7)}},function(x,b,r){var u=r(85),d=r(30),h=r(9),p=u(u.bind);x.exports=function(y,T){return d(y),T===void 0?y:h?p(y,T):function(){return y.apply(T,arguments)}}},function(x,b,r){var u=r(15),d=r(14);x.exports=function(h){if(u(h)==="Function")return d(h)}},function(x,b,r){var u=r(87);x.exports=function(d,h){return new(u(d))(h===0?0:h)}},function(x,b,r){var u=r(88),d=r(89),h=r(20),p=r(33),y=p("species"),T=Array;x.exports=function($){var A;return u($)&&(A=$.constructor,d(A)&&(A===T||u(A.prototype))?A=void 0:h(A)&&(A=A[y],A===null&&(A=void 0))),A===void 0?T:A}},function(x,b,r){var u=r(15);x.exports=Array.isArray||function(h){return u(h)==="Array"}},function(x,b,r){var u=r(14),d=r(7),h=r(21),p=r(69),y=r(23),T=r(50),$=function(){},A=y("Reflect","construct"),E=/^\s*(?:class|function)\b/,R=u(E.exec),I=!E.test($),O=function(M){if(!h(M))return!1;try{return A($,[],M),!0}catch(F){return!1}},C=function(M){if(!h(M))return!1;switch(p(M)){case"AsyncFunction":case"GeneratorFunction":case"AsyncGeneratorFunction":return!1}try{return I||!!R(E,T(M))}catch(F){return!0}};C.sham=!0,x.exports=!A||d(function(){var D;return O(O.call)||!O(Object)||!O(function(){D=!0})||D})?C:O},function(x,b,r){var u=r(3),d=r(23),h=r(38),p=r(68),y=r(34),T=r(91),$=y("string-to-symbol-registry"),A=y("symbol-to-string-registry");u({target:"Symbol",stat:!0,forced:!T},{for:function(E){var R=p(E);if(h($,R))return $[R];var I=d("Symbol")(R);return $[R]=I,A[I]=R,I}})},function(x,b,r){var u=r(26);x.exports=u&&!!Symbol.for&&!!Symbol.keyFor},function(x,b,r){var u=r(3),d=r(38),h=r(22),p=r(31),y=r(34),T=r(91),$=y("symbol-to-string-registry");u({target:"Symbol",stat:!0,forced:!T},{keyFor:function(E){if(!h(E))throw new TypeError(p(E)+" is not a symbol");if(d($,E))return $[E]}})},function(x,b,r){var u=r(3),d=r(23),h=r(94),p=r(8),y=r(14),T=r(7),$=r(21),A=r(22),E=r(76),R=r(95),I=r(26),O=String,C=d("JSON","stringify"),D=y(/./.exec),M=y("".charAt),F=y("".charCodeAt),z=y("".replace),U=y(1 .toString),j=/[\uD800-\uDFFF]/g,G=/^[\uD800-\uDBFF]$/,B=/^[\uDC00-\uDFFF]$/,V=!I||T(function(){var q=d("Symbol")("stringify detection");return C([q])!=="[null]"||C({a:q})!=="{}"||C(Object(q))!=="{}"}),Y=T(function(){return C("\uDF06\uD834")!=='"\\udf06\\ud834"'||C("\uDEAD")!=='"\\udead"'}),Z=function(q,nt){var rt=E(arguments),_=R(nt);if(!(!$(_)&&(q===void 0||A(q))))return rt[1]=function(tt,et){if($(_)&&(et=p(_,this,O(tt),et)),!A(et))return et},h(C,null,rt)},J=function(q,nt,rt){var _=M(rt,nt-1),tt=M(rt,nt+1);return D(G,q)&&!D(B,tt)||D(B,q)&&!D(G,_)?"\\u"+U(F(q,0),16):q};C&&u({target:"JSON",stat:!0,arity:3,forced:V||Y},{stringify:function(nt,rt,_){var tt=E(arguments),et=h(V?Z:C,null,tt);return Y&&typeof et=="string"?z(et,j,J):et}})},function(x,b,r){var u=r(9),d=Function.prototype,h=d.apply,p=d.call;x.exports=typeof Reflect=="object"&&Reflect.apply||(u?p.bind(h):function(){return p.apply(h,arguments)})},function(x,b,r){var u=r(14),d=r(88),h=r(21),p=r(15),y=r(68),T=u([].push);x.exports=function($){if(h($))return $;if(d($)){for(var A=$.length,E=[],R=0;Rj&&R(_,arguments[j]),_});if(J.prototype=Y,B!=="Error"?y?y(J,Z):T(J,Z,{name:!0}):O&&U in V&&($(J,V,U),$(J,V,"prepareStackTrace")),T(J,V),!C)try{Y.name!==B&&h(Y,"name",B),Y.constructor=J}catch(q){}return J}}},function(x,b,r){var u=r(114),d=r(20),h=r(16),p=r(115);x.exports=Object.setPrototypeOf||("__proto__"in{}?function(){var y=!1,T={},$;try{$=u(Object.prototype,"__proto__","set"),$(T,[]),y=T instanceof Array}catch(A){}return function(E,R){return h(E),p(R),d(E)&&(y?$(E,R):E.__proto__=R),E}}():void 0)},function(x,b,r){var u=r(14),d=r(30);x.exports=function(h,p,y){try{return u(d(Object.getOwnPropertyDescriptor(h,p)[y]))}catch(T){}}},function(x,b,r){var u=r(116),d=String,h=TypeError;x.exports=function(p){if(u(p))return p;throw new h("Can't set "+d(p)+" as a prototype")}},function(x,b,r){var u=r(20);x.exports=function(d){return u(d)||d===null}},function(x,b,r){var u=r(44).f;x.exports=function(d,h,p){p in d||u(d,p,{configurable:!0,get:function(){return h[p]},set:function(y){h[p]=y}})}},function(x,b,r){var u=r(21),d=r(20),h=r(113);x.exports=function(p,y,T){var $,A;return h&&u($=y.constructor)&&$!==T&&d(A=$.prototype)&&A!==T.prototype&&h(p,A),p}},function(x,b,r){var u=r(68);x.exports=function(d,h){return d===void 0?arguments.length<2?"":h:u(d)}},function(x,b,r){var u=r(20),d=r(43);x.exports=function(h,p){u(p)&&"cause"in p&&d(h,"cause",p.cause)}},function(x,b,r){var u=r(43),d=r(122),h=r(123),p=Error.captureStackTrace;x.exports=function(y,T,$,A){h&&(p?p(y,T):u(y,"stack",d($,A)))}},function(x,b,r){var u=r(14),d=Error,h=u("".replace),p=function($){return String(new d($).stack)}("zxcasd"),y=/\n\s*at [^:]*:[^\n]*/,T=y.test(p);x.exports=function($,A){if(T&&typeof $=="string"&&!d.prepareStackTrace)for(;A--;)$=h($,y,"");return $}},function(x,b,r){var u=r(7),d=r(11);x.exports=!u(function(){var h=new Error("a");return"stack"in h?(Object.defineProperty(h,"stack",d(1,7)),h.stack!==7):!0})},function(x,b,r){var u=r(47),d=r(125),h=Error.prototype;h.toString!==d&&u(h,"toString",d)},function(x,b,r){var u=r(6),d=r(7),h=r(46),p=r(119),y=Error.prototype.toString,T=d(function(){if(u){var $=Object.create(Object.defineProperty({},"name",{get:function(){return this===$}}));if(y.call($)!=="true")return!0}return y.call({message:1,name:2})!=="2: 1"||y.call({})!=="Error"});x.exports=T?function(){var A=h(this),E=p(A.name,"Error"),R=p(A.message);return E?R?E+": "+R:E:R}:y},function(x,b,r){r(127)},function(x,b,r){var u=r(3),d=r(24),h=r(128),p=r(113),y=r(55),T=r(71),$=r(43),A=r(11),E=r(120),R=r(121),I=r(130),O=r(119),C=r(33),D=C("toStringTag"),M=Error,F=[].push,z=function(G,B){var V=d(U,this),Y;p?Y=p(new M,V?h(this):U):(Y=V?this:T(U),$(Y,D,"Error")),B!==void 0&&$(Y,"message",O(B)),R(Y,z,Y.stack,1),arguments.length>2&&E(Y,arguments[2]);var Z=[];return I(G,F,{that:Z}),$(Y,"errors",Z),Y};p?p(z,M):y(z,M,{name:!0});var U=z.prototype=T(M.prototype,{constructor:A(1,z),message:A(1,""),name:A(1,"AggregateError")});u({global:!0,constructor:!0,arity:2},{AggregateError:z})},function(x,b,r){var u=r(38),d=r(21),h=r(39),p=r(53),y=r(129),T=p("IE_PROTO"),$=Object,A=$.prototype;x.exports=y?$.getPrototypeOf:function(E){var R=h(E);if(u(R,T))return R[T];var I=R.constructor;return d(I)&&R instanceof I?I.prototype:R instanceof $?A:null}},function(x,b,r){var u=r(7);x.exports=!u(function(){function d(){}return d.prototype.constructor=null,Object.getPrototypeOf(new d)!==d.prototype})},function(x,b,r){var u=r(84),d=r(8),h=r(46),p=r(31),y=r(131),T=r(63),$=r(24),A=r(133),E=r(134),R=r(135),I=TypeError,O=function(D,M){this.stopped=D,this.result=M},C=O.prototype;x.exports=function(D,M,F){var z=F&&F.that,U=!!(F&&F.AS_ENTRIES),j=!!(F&&F.IS_RECORD),G=!!(F&&F.IS_ITERATOR),B=!!(F&&F.INTERRUPTED),V=u(M,z),Y,Z,J,q,nt,rt,_,tt=function(lt){return Y&&R(Y,"normal",lt),new O(!0,lt)},et=function(lt){return U?(h(lt),B?V(lt[0],lt[1],tt):V(lt[0],lt[1])):B?V(lt,tt):V(lt)};if(j)Y=D.iterator;else if(G)Y=D;else{if(Z=E(D),!Z)throw new I(p(D)+" is not iterable");if(y(Z)){for(J=0,q=T(D);q>J;J++)if(nt=et(D[J]),nt&&$(C,nt))return nt;return new O(!1)}Y=A(D,Z)}for(rt=j?D.next:Y.next;!(_=d(rt,Y)).done;){try{nt=et(_.value)}catch(lt){R(Y,"throw",lt)}if(typeof nt=="object"&&nt&&$(C,nt))return nt}return new O(!1)}},function(x,b,r){var u=r(33),d=r(132),h=u("iterator"),p=Array.prototype;x.exports=function(y){return y!==void 0&&(d.Array===y||p[h]===y)}},function(x){x.exports={}},function(x,b,r){var u=r(8),d=r(30),h=r(46),p=r(31),y=r(134),T=TypeError;x.exports=function($,A){var E=arguments.length<2?y($):A;if(d(E))return h(u(E,$));throw new T(p($)+" is not iterable")}},function(x,b,r){var u=r(69),d=r(29),h=r(17),p=r(132),y=r(33),T=y("iterator");x.exports=function($){if(!h($))return d($,T)||d($,"@@iterator")||p[u($)]}},function(x,b,r){var u=r(8),d=r(46),h=r(29);x.exports=function(p,y,T){var $,A;d(p);try{if($=h(p,"return"),!$){if(y==="throw")throw T;return T}$=u($,p)}catch(E){A=!0,$=E}if(y==="throw")throw T;if(A)throw $;return d($),T}},function(x,b,r){var u=r(3),d=r(23),h=r(94),p=r(7),y=r(112),T="AggregateError",$=d(T),A=!p(function(){return $([1]).errors[0]!==1})&&p(function(){return $([1],T,{cause:7}).cause!==7});u({global:!0,constructor:!0,arity:2,forced:A},{AggregateError:y(T,function(E){return function(I,O){return h(E,this,arguments)}},A,!0)})},function(x,b,r){var u=r(3),d=r(39),h=r(63),p=r(61),y=r(138);u({target:"Array",proto:!0},{at:function($){var A=d(this),E=h(A),R=p($),I=R>=0?R:E+R;return I<0||I>=E?void 0:A[I]}}),y("at")},function(x,b,r){var u=r(33),d=r(71),h=r(44).f,p=u("unscopables"),y=Array.prototype;y[p]===void 0&&h(y,p,{configurable:!0,value:d(null)}),x.exports=function(T){y[p][T]=!0}},function(x,b,r){var u=r(3),d=r(7),h=r(88),p=r(20),y=r(39),T=r(63),$=r(140),A=r(141),E=r(86),R=r(142),I=r(33),O=r(27),C=I("isConcatSpreadable"),D=O>=51||!d(function(){var z=[];return z[C]=!1,z.concat()[0]!==z}),M=function(z){if(!p(z))return!1;var U=z[C];return U!==void 0?!!U:h(z)},F=!D||!R("concat");u({target:"Array",proto:!0,arity:1,forced:F},{concat:function(U){var j=y(this),G=E(j,0),B=0,V,Y,Z,J,q;for(V=-1,Z=arguments.length;Vr)throw b("Maximum allowed index exceeded");return u}},function(x,b,r){var u=r(6),d=r(44),h=r(11);x.exports=function(p,y,T){u?d.f(p,y,h(0,T)):p[y]=T}},function(x,b,r){var u=r(7),d=r(33),h=r(27),p=d("species");x.exports=function(y){return h>=51||!u(function(){var T=[],$=T.constructor={};return $[p]=function(){return{foo:1}},T[y](Boolean).foo!==1})}},function(x,b,r){var u=r(3),d=r(144),h=r(138);u({target:"Array",proto:!0},{copyWithin:d}),h("copyWithin")},function(x,b,r){var u=r(39),d=r(60),h=r(63),p=r(145),y=Math.min;x.exports=[].copyWithin||function($,A){var E=u(this),R=h(E),I=d($,R),O=d(A,R),C=arguments.length>2?arguments[2]:void 0,D=y((C===void 0?R:d(C,R))-O,R-I),M=1;for(O0;)O in E?E[I]=E[O]:p(E,I),I+=M,O+=M;return E}},function(x,b,r){var u=r(31),d=TypeError;x.exports=function(h,p){if(!delete h[p])throw new d("Cannot delete property "+u(p)+" of "+u(h))}},function(x,b,r){var u=r(3),d=r(83).every,h=r(147),p=h("every");u({target:"Array",proto:!0,forced:!p},{every:function(T){return d(this,T,arguments.length>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(7);x.exports=function(d,h){var p=[][d];return!!p&&u(function(){p.call(null,h||function(){return 1},1)})}},function(x,b,r){var u=r(3),d=r(149),h=r(138);u({target:"Array",proto:!0},{fill:d}),h("fill")},function(x,b,r){var u=r(39),d=r(60),h=r(63);x.exports=function(y){for(var T=u(this),$=h(T),A=arguments.length,E=d(A>1?arguments[1]:void 0,$),R=A>2?arguments[2]:void 0,I=R===void 0?$:d(R,$);I>E;)T[E++]=y;return T}},function(x,b,r){var u=r(3),d=r(83).filter,h=r(142),p=h("filter");u({target:"Array",proto:!0,forced:!p},{filter:function(T){return d(this,T,arguments.length>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(3),d=r(83).find,h=r(138),p="find",y=!0;p in[]&&Array(1)[p](function(){y=!1}),u({target:"Array",proto:!0,forced:y},{find:function($){return d(this,$,arguments.length>1?arguments[1]:void 0)}}),h(p)},function(x,b,r){var u=r(3),d=r(83).findIndex,h=r(138),p="findIndex",y=!0;p in[]&&Array(1)[p](function(){y=!1}),u({target:"Array",proto:!0,forced:y},{findIndex:function($){return d(this,$,arguments.length>1?arguments[1]:void 0)}}),h(p)},function(x,b,r){var u=r(3),d=r(154).findLast,h=r(138);u({target:"Array",proto:!0},{findLast:function(y){return d(this,y,arguments.length>1?arguments[1]:void 0)}}),h("findLast")},function(x,b,r){var u=r(84),d=r(13),h=r(39),p=r(63),y=function(T){var $=T===1;return function(A,E,R){for(var I=h(A),O=d(I),C=p(O),D=u(E,R),M,F;C-- >0;)if(M=O[C],F=D(M,C,I),F)switch(T){case 0:return M;case 1:return C}return $?-1:void 0}};x.exports={findLast:y(0),findLastIndex:y(1)}},function(x,b,r){var u=r(3),d=r(154).findLastIndex,h=r(138);u({target:"Array",proto:!0},{findLastIndex:function(y){return d(this,y,arguments.length>1?arguments[1]:void 0)}}),h("findLastIndex")},function(x,b,r){var u=r(3),d=r(157),h=r(39),p=r(63),y=r(61),T=r(86);u({target:"Array",proto:!0},{flat:function(){var A=arguments.length?arguments[0]:void 0,E=h(this),R=p(E),I=T(E,0);return I.length=d(I,E,E,R,0,A===void 0?1:y(A)),I}})},function(x,b,r){var u=r(88),d=r(63),h=r(140),p=r(84),y=function(T,$,A,E,R,I,O,C){for(var D=R,M=0,F=O?p(O,C):!1,z,U;M0&&u(z)?(U=d(z),D=y(T,$,z,U,D,I-1)-1):(h(D+1),T[D]=z),D++),M++;return D};x.exports=y},function(x,b,r){var u=r(3),d=r(157),h=r(30),p=r(39),y=r(63),T=r(86);u({target:"Array",proto:!0},{flatMap:function(A){var E=p(this),R=y(E),I;return h(A),I=T(E,0),I.length=d(I,E,E,R,0,1,A,arguments.length>1?arguments[1]:void 0),I}})},function(x,b,r){var u=r(3),d=r(160);u({target:"Array",proto:!0,forced:[].forEach!==d},{forEach:d})},function(x,b,r){var u=r(83).forEach,d=r(147),h=d("forEach");x.exports=h?[].forEach:function(y){return u(this,y,arguments.length>1?arguments[1]:void 0)}},function(x,b,r){var u=r(3),d=r(162),h=r(164),p=!h(function(y){Array.from(y)});u({target:"Array",stat:!0,forced:p},{from:d})},function(x,b,r){var u=r(84),d=r(8),h=r(39),p=r(163),y=r(131),T=r(89),$=r(63),A=r(141),E=r(133),R=r(134),I=Array;x.exports=function(C){var D=h(C),M=T(this),F=arguments.length,z=F>1?arguments[1]:void 0,U=z!==void 0;U&&(z=u(z,F>2?arguments[2]:void 0));var j=R(D),G=0,B,V,Y,Z,J,q;if(j&&!(this===I&&y(j)))for(V=M?new this:[],Z=E(D,j),J=Z.next;!(Y=d(J,Z)).done;G++)q=U?p(Z,z,[Y.value,G],!0):Y.value,A(V,G,q);else for(B=$(D),V=M?new this(B):I(B);B>G;G++)q=U?z(D[G],G):D[G],A(V,G,q);return V.length=G,V}},function(x,b,r){var u=r(46),d=r(135);x.exports=function(h,p,y,T){try{return T?p(u(y)[0],y[1]):p(y)}catch($){d(h,"throw",$)}}},function(x,b,r){var u=r(33),d=u("iterator"),h=!1;try{var p=0,y={next:function(){return{done:!!p++}},return:function(){h=!0}};y[d]=function(){return this},Array.from(y,function(){throw 2})}catch(T){}x.exports=function(T,$){try{if(!$&&!h)return!1}catch(R){return!1}var A=!1;try{var E={};E[d]=function(){return{next:function(){return{done:A=!0}}}},T(E)}catch(R){}return A}},function(x,b,r){var u=r(3),d=r(59).includes,h=r(7),p=r(138),y=h(function(){return!Array(1).includes()});u({target:"Array",proto:!0,forced:y},{includes:function($){return d(this,$,arguments.length>1?arguments[1]:void 0)}}),p("includes")},function(x,b,r){var u=r(3),d=r(85),h=r(59).indexOf,p=r(147),y=d([].indexOf),T=!!y&&1/y([1],1,-0)<0,$=T||!p("indexOf");u({target:"Array",proto:!0,forced:$},{indexOf:function(E){var R=arguments.length>1?arguments[1]:void 0;return T?y(this,E,R)||0:h(this,E,R)}})},function(x,b,r){var u=r(3),d=r(88);u({target:"Array",stat:!0},{isArray:d})},function(x,b,r){var u=r(12),d=r(138),h=r(132),p=r(51),y=r(44).f,T=r(169),$=r(172),A=r(36),E=r(6),R="Array Iterator",I=p.set,O=p.getterFor(R);x.exports=T(Array,"Array",function(D,M){I(this,{type:R,target:u(D),index:0,kind:M})},function(){var D=O(this),M=D.target,F=D.index++;if(!M||F>=M.length)return D.target=null,$(void 0,!0);switch(D.kind){case"keys":return $(F,!1);case"values":return $(M[F],!1)}return $([F,M[F]],!1)},"values");var C=h.Arguments=h.Array;if(d("keys"),d("values"),d("entries"),!A&&E&&C.name!=="values")try{y(C,"name",{value:"values"})}catch(D){}},function(x,b,r){var u=r(3),d=r(8),h=r(36),p=r(49),y=r(21),T=r(170),$=r(128),A=r(113),E=r(82),R=r(43),I=r(47),O=r(33),C=r(132),D=r(171),M=p.PROPER,F=p.CONFIGURABLE,z=D.IteratorPrototype,U=D.BUGGY_SAFARI_ITERATORS,j=O("iterator"),G="keys",B="values",V="entries",Y=function(){return this};x.exports=function(Z,J,q,nt,rt,_,tt){T(q,J,nt);var et=function(kt){if(kt===rt&&yt)return yt;if(!U&&kt&&kt in gt)return gt[kt];switch(kt){case G:return function(){return new q(this,kt)};case B:return function(){return new q(this,kt)};case V:return function(){return new q(this,kt)}}return function(){return new q(this)}},lt=J+" Iterator",mt=!1,gt=Z.prototype,xt=gt[j]||gt["@@iterator"]||rt&>[rt],yt=!U&&xt||et(rt),Ut=J==="Array"&>.entries||xt,Dt,Xt,Qt;if(Ut&&(Dt=$(Ut.call(new Z)),Dt!==Object.prototype&&Dt.next&&(!h&&$(Dt)!==z&&(A?A(Dt,z):y(Dt[j])||I(Dt,j,Y)),E(Dt,lt,!0,!0),h&&(C[lt]=Y))),M&&rt===B&&xt&&xt.name!==B&&(!h&&F?R(gt,"name",B):(mt=!0,yt=function(){return d(xt,this)})),rt)if(Xt={values:et(B),keys:_?yt:et(G),entries:et(V)},tt)for(Qt in Xt)(U||mt||!(Qt in gt))&&I(gt,Qt,Xt[Qt]);else u({target:J,proto:!0,forced:U||mt},Xt);return(!h||tt)&>[j]!==yt&&I(gt,j,yt,{name:rt}),C[J]=yt,Xt}},function(x,b,r){var u=r(171).IteratorPrototype,d=r(71),h=r(11),p=r(82),y=r(132),T=function(){return this};x.exports=function($,A,E,R){var I=A+" Iterator";return $.prototype=d(u,{next:h(+!R,E)}),p($,I,!1,!0),y[I]=T,$}},function(x,b,r){var u=r(7),d=r(21),h=r(20),p=r(71),y=r(128),T=r(47),$=r(33),A=r(36),E=$("iterator"),R=!1,I,O,C;[].keys&&(C=[].keys(),"next"in C?(O=y(y(C)),O!==Object.prototype&&(I=O)):R=!0);var D=!h(I)||u(function(){var M={};return I[E].call(M)!==M});D?I={}:A&&(I=p(I)),d(I[E])||T(I,E,function(){return this}),x.exports={IteratorPrototype:I,BUGGY_SAFARI_ITERATORS:R}},function(x){x.exports=function(b,r){return{value:b,done:r}}},function(x,b,r){var u=r(3),d=r(14),h=r(13),p=r(12),y=r(147),T=d([].join),$=h!==Object,A=$||!y("join",",");u({target:"Array",proto:!0,forced:A},{join:function(R){return T(p(this),R===void 0?",":R)}})},function(x,b,r){var u=r(3),d=r(175);u({target:"Array",proto:!0,forced:d!==[].lastIndexOf},{lastIndexOf:d})},function(x,b,r){var u=r(94),d=r(12),h=r(61),p=r(63),y=r(147),T=Math.min,$=[].lastIndexOf,A=!!$&&1/[1].lastIndexOf(1,-0)<0,E=y("lastIndexOf"),R=A||!E;x.exports=R?function(O){if(A)return u($,this,arguments)||0;var C=d(this),D=p(C);if(D===0)return-1;var M=D-1;for(arguments.length>1&&(M=T(M,h(arguments[1]))),M<0&&(M=D+M);M>=0;M--)if(M in C&&C[M]===O)return M||0;return-1}:$},function(x,b,r){var u=r(3),d=r(83).map,h=r(142),p=h("map");u({target:"Array",proto:!0,forced:!p},{map:function(T){return d(this,T,arguments.length>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(3),d=r(7),h=r(89),p=r(141),y=Array,T=d(function(){function $(){}return!(y.of.call($)instanceof $)});u({target:"Array",stat:!0,forced:T},{of:function(){for(var A=0,E=arguments.length,R=new(h(this)?this:y)(E);E>A;)p(R,A,arguments[A++]);return R.length=E,R}})},function(x,b,r){var u=r(3),d=r(39),h=r(63),p=r(179),y=r(140),T=r(7),$=T(function(){return[].push.call({length:4294967296},1)!==4294967297}),A=function(){try{Object.defineProperty([],"length",{writable:!1}).push()}catch(R){return R instanceof TypeError}},E=$||!A();u({target:"Array",proto:!0,arity:1,forced:E},{push:function(I){var O=d(this),C=h(O),D=arguments.length;y(C+D);for(var M=0;M79&&p<83,$=T||!h("reduce");u({target:"Array",proto:!0,forced:$},{reduce:function(E){var R=arguments.length;return d(this,E,R,R>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(30),d=r(39),h=r(13),p=r(63),y=TypeError,T="Reduce of empty array with no initial value",$=function(A){return function(E,R,I,O){var C=d(E),D=h(C),M=p(C);if(u(R),M===0&&I<2)throw new y(T);var F=A?M-1:0,z=A?-1:1;if(I<2)for(;;){if(F in D){O=D[F],F+=z;break}if(F+=z,A?F<0:M<=F)throw new y(T)}for(;A?F>=0:M>F;F+=z)F in D&&(O=R(O,D[F],F,C));return O}};x.exports={left:$(!1),right:$(!0)}},function(x,b,r){var u=r(183);x.exports=u==="NODE"},function(x,b,r){var u=r(4),d=r(28),h=r(15),p=function(y){return d.slice(0,y.length)===y};x.exports=function(){return p("Bun/")?"BUN":p("Cloudflare-Workers")?"CLOUDFLARE":p("Deno/")?"DENO":p("Node.js/")?"NODE":u.Bun&&typeof Bun.version=="string"?"BUN":u.Deno&&typeof Deno.version=="object"?"DENO":h(u.process)==="process"?"NODE":u.window&&u.document?"BROWSER":"REST"}()},function(x,b,r){var u=r(3),d=r(181).right,h=r(147),p=r(27),y=r(182),T=!y&&p>79&&p<83,$=T||!h("reduceRight");u({target:"Array",proto:!0,forced:$},{reduceRight:function(E){return d(this,E,arguments.length,arguments.length>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(3),d=r(14),h=r(88),p=d([].reverse),y=[1,2];u({target:"Array",proto:!0,forced:String(y)===String(y.reverse())},{reverse:function(){return h(this)&&(this.length=this.length),p(this)}})},function(x,b,r){var u=r(3),d=r(88),h=r(89),p=r(20),y=r(60),T=r(63),$=r(12),A=r(141),E=r(33),R=r(142),I=r(76),O=R("slice"),C=E("species"),D=Array,M=Math.max;u({target:"Array",proto:!0,forced:!O},{slice:function(z,U){var j=$(this),G=T(j),B=y(z,G),V=y(U===void 0?G:U,G),Y,Z,J;if(d(j)&&(Y=j.constructor,h(Y)&&(Y===D||d(Y.prototype))?Y=void 0:p(Y)&&(Y=Y[C],Y===null&&(Y=void 0)),Y===D||Y===void 0))return I(j,B,V);for(Z=new(Y===void 0?D:Y)(M(V-B,0)),J=0;B1?arguments[1]:void 0)}})},function(x,b,r){var u=r(3),d=r(14),h=r(30),p=r(39),y=r(63),T=r(145),$=r(68),A=r(7),E=r(189),R=r(147),I=r(190),O=r(191),C=r(27),D=r(192),M=[],F=d(M.sort),z=d(M.push),U=A(function(){M.sort(void 0)}),j=A(function(){M.sort(null)}),G=R("sort"),B=!A(function(){if(C)return C<70;if(!(I&&I>3)){if(O)return!0;if(D)return D<603;var Z="",J,q,nt,rt;for(J=65;J<76;J++){switch(q=String.fromCharCode(J),J){case 66:case 69:case 70:case 72:nt=3;break;case 68:case 71:nt=4;break;default:nt=2}for(rt=0;rt<47;rt++)M.push({k:q+rt,v:nt})}for(M.sort(function(_,tt){return tt.v-_.v}),rt=0;rt$(q)?1:-1}};u({target:"Array",proto:!0,forced:V},{sort:function(J){J!==void 0&&h(J);var q=p(this);if(B)return J===void 0?F(q):F(q,J);var nt=[],rt=y(q),_,tt;for(tt=0;tt0;)p[E]=p[--E];E!==$++&&(p[E]=A)}else for(var R=d(T/2),I=h(u(p,0,R),y),O=h(u(p,R),y),C=I.length,D=O.length,M=0,F=0;Mj-Y+V;J--)R(U,J-1)}else if(V>Y)for(J=j-Y;J>G;J--)q=J+Y-1,nt=J+V-1,q in U?U[nt]=U[q]:R(U,nt);for(J=0;J2?p:u(h),$=new d(T);T>y;)$[y]=h[y++];return $}},function(x,b,r){var u=r(4);x.exports=function(d,h){var p=u[d],y=p&&p.prototype;return y&&y[h]}},function(x,b,r){var u=r(3),d=r(138),h=r(140),p=r(63),y=r(60),T=r(12),$=r(61),A=Array,E=Math.max,R=Math.min;u({target:"Array",proto:!0},{toSpliced:function(O,C){var D=T(this),M=p(D),F=y(O,M),z=arguments.length,U=0,j,G,B,V;for(z===0?j=G=0:z===1?(j=0,G=M-F):(j=z-2,G=R(E($(C),0),M-F)),B=h(M+j-G),V=A(B);U=A||R<0)throw new h("Incorrect index");for(var I=new y(A),O=0;O>8&255]},se=function(bt){return[bt&255,bt>>8&255,bt>>16&255,bt>>24&255]},ee=function(bt){return bt[3]<<24|bt[2]<<16|bt[1]<<8|bt[0]},fe=function(bt){return ae(D(bt),23,4)},Pe=function(bt){return ae(bt,52,8)},Me=function(bt,Ft,Tt){$(bt[rt],Ft,{configurable:!0,get:function(){return Tt(this)[Ft]}})},$e=function(bt,Ft,Tt,qt){var te=lt(bt),Zt=C(Tt),Yt=!!qt;if(Zt+Ft>te.byteLength)throw new kt(tt);var Ye=te.bytes,Ze=Zt+te.byteOffset,ut=j(Ye,Ze,Ze+Ft);return Yt?ut:ge(ut)},ce=function(bt,Ft,Tt,qt,te,Zt){var Yt=lt(bt),Ye=C(Tt),Ze=qt(+te),ut=!!Zt;if(Ye+Ft>Yt.byteLength)throw new kt(tt);for(var It=Yt.bytes,Pt=Ye+Yt.byteOffset,Ct=0;CtZt)throw new kt("Wrong offset");if(qt=qt===void 0?Zt-Yt:O(qt),Yt+qt>Zt)throw new kt(_);mt(this,{type:nt,buffer:Ft,byteLength:qt,byteOffset:Yt,bytes:te.bytes}),h||(this.buffer=Ft,this.byteLength=qt,this.byteOffset=Yt)},Dt=Ut[rt],h&&(Me(xt,"byteLength",et),Me(Ut,"buffer",lt),Me(Ut,"byteLength",lt),Me(Ut,"byteOffset",lt)),A(Dt,{getInt8:function(Ft){return $e(this,1,Ft)[0]<<24>>24},getUint8:function(Ft){return $e(this,1,Ft)[0]},getInt16:function(Ft){var Tt=$e(this,2,Ft,arguments.length>1?arguments[1]:!1);return(Tt[1]<<8|Tt[0])<<16>>16},getUint16:function(Ft){var Tt=$e(this,2,Ft,arguments.length>1?arguments[1]:!1);return Tt[1]<<8|Tt[0]},getInt32:function(Ft){return ee($e(this,4,Ft,arguments.length>1?arguments[1]:!1))},getUint32:function(Ft){return ee($e(this,4,Ft,arguments.length>1?arguments[1]:!1))>>>0},getFloat32:function(Ft){return Mt($e(this,4,Ft,arguments.length>1?arguments[1]:!1),23)},getFloat64:function(Ft){return Mt($e(this,8,Ft,arguments.length>1?arguments[1]:!1),52)},setInt8:function(Ft,Tt){ce(this,1,Ft,Ht,Tt)},setUint8:function(Ft,Tt){ce(this,1,Ft,Ht,Tt)},setInt16:function(Ft,Tt){ce(this,2,Ft,re,Tt,arguments.length>2?arguments[2]:!1)},setUint16:function(Ft,Tt){ce(this,2,Ft,re,Tt,arguments.length>2?arguments[2]:!1)},setInt32:function(Ft,Tt){ce(this,4,Ft,se,Tt,arguments.length>2?arguments[2]:!1)},setUint32:function(Ft,Tt){ce(this,4,Ft,se,Tt,arguments.length>2?arguments[2]:!1)},setFloat32:function(Ft,Tt){ce(this,4,Ft,fe,Tt,arguments.length>2?arguments[2]:!1)},setFloat64:function(Ft,Tt){ce(this,8,Ft,Pe,Tt,arguments.length>2?arguments[2]:!1)}});else{var Ae=Z&>.name!==q;!E(function(){gt(1)})||!E(function(){new gt(-1)})||E(function(){return new gt,new gt(1.5),new gt(NaN),gt.length!==1||Ae&&!J})?(xt=function(Ft){return R(this,yt),G(new gt(C(Ft)),this,xt)},xt[rt]=yt,yt.constructor=xt,B(xt,gt)):Ae&&J&&T(gt,"name",q),z&&F(Dt)!==Xt&&z(Dt,Xt);var Te=new Ut(new xt(2)),de=d(Dt.setInt8);Te.setInt8(0,2147483648),Te.setInt8(1,2147483649),(Te.getInt8(0)||!Te.getInt8(1))&&A(Dt,{setInt8:function(Ft,Tt){de(this,Ft,Tt<<24>>24)},setUint8:function(Ft,Tt){de(this,Ft,Tt<<24>>24)}},{unsafe:!0})}V(xt,q),V(Ut,nt),x.exports={ArrayBuffer:xt,DataView:Ut}},function(x){x.exports=typeof ArrayBuffer!="undefined"&&typeof DataView!="undefined"},function(x,b,r){var u=r(47);x.exports=function(d,h,p){for(var y in h)u(d,y,h[y],p);return d}},function(x,b,r){var u=r(24),d=TypeError;x.exports=function(h,p){if(u(p,h))return h;throw new d("Incorrect invocation")}},function(x,b,r){var u=r(61),d=r(64),h=RangeError;x.exports=function(p){if(p===void 0)return 0;var y=u(p),T=d(y);if(y!==T)throw new h("Wrong length or index");return T}},function(x,b,r){var u=r(214),d=11920928955078125e-23,h=34028234663852886e22,p=11754943508222875e-54;x.exports=Math.fround||function(T){return u(T,d,h,p)}},function(x,b,r){var u=r(215),d=r(216),h=Math.abs,p=2220446049250313e-31;x.exports=function(y,T,$,A){var E=+y,R=h(E),I=u(E);if(R$||C!==C?I*(1/0):I*C}},function(x){x.exports=Math.sign||function(r){var u=+r;return u===0||u!==u?u:u<0?-1:1}},function(x){var b=2220446049250313e-31,r=1/b;x.exports=function(u){return u+r-r}},function(x){var b=Array,r=Math.abs,u=Math.pow,d=Math.floor,h=Math.log,p=Math.LN2,y=function($,A,E){var R=b(E),I=E*8-A-1,O=(1<>1,D=A===23?u(2,-24)-u(2,-77):0,M=$<0||$===0&&1/$<0?1:0,F=0,z,U,j;for($=r($),$!==$||$===1/0?(U=$!==$?1:0,z=O):(z=d(h($)/p),j=u(2,-z),$*j<1&&(z--,j*=2),z+C>=1?$+=D/j:$+=D*u(2,1-C),$*j>=2&&(z++,j/=2),z+C>=O?(U=0,z=O):z+C>=1?(U=($*j-1)*u(2,A),z+=C):(U=$*u(2,C-1)*u(2,A),z=0));A>=8;)R[F++]=U&255,U/=256,A-=8;for(z=z<0;)R[F++]=z&255,z/=256,I-=8;return R[F-1]|=M*128,R},T=function($,A){var E=$.length,R=E*8-A-1,I=(1<>1,C=R-7,D=E-1,M=$[D--],F=M&127,z;for(M>>=7;C>0;)F=F*256+$[D--],C-=8;for(z=F&(1<<-C)-1,F>>=-C,C+=A;C>0;)z=z*256+$[D--],C-=8;if(F===0)F=1-O;else{if(F===I)return z?NaN:M?-1/0:1/0;z+=u(2,A),F-=O}return(M?-1:1)*z*u(2,F-A)};x.exports={pack:y,unpack:T}},function(x,b,r){var u=r(3),d=r(219),h=d.NATIVE_ARRAY_BUFFER_VIEWS;u({target:"ArrayBuffer",stat:!0,forced:!h},{isView:d.isView})},function(x,b,r){var u=r(209),d=r(6),h=r(4),p=r(21),y=r(20),T=r(38),$=r(69),A=r(31),E=r(43),R=r(47),I=r(77),O=r(24),C=r(128),D=r(113),M=r(33),F=r(40),z=r(51),U=z.enforce,j=z.get,G=h.Int8Array,B=G&&G.prototype,V=h.Uint8ClampedArray,Y=V&&V.prototype,Z=G&&C(G),J=B&&C(B),q=Object.prototype,nt=h.TypeError,rt=M("toStringTag"),_=F("TYPED_ARRAY_TAG"),tt="TypedArrayConstructor",et=u&&!!D&&$(h.opera)!=="Opera",lt=!1,mt,gt,xt,yt={Int8Array:1,Uint8Array:1,Uint8ClampedArray:1,Int16Array:2,Uint16Array:2,Int32Array:4,Uint32Array:4,Float32Array:4,Float64Array:8},Ut={BigInt64Array:8,BigUint64Array:8},Dt=function(Ht){if(!y(Ht))return!1;var re=$(Ht);return re==="DataView"||T(yt,re)||T(Ut,re)},Xt=function(Mt){var Ht=C(Mt);if(y(Ht)){var re=j(Ht);return re&&T(re,tt)?re[tt]:Xt(Ht)}},Qt=function(Mt){if(!y(Mt))return!1;var Ht=$(Mt);return T(yt,Ht)||T(Ut,Ht)},kt=function(Mt){if(Qt(Mt))return Mt;throw new nt("Target is not a typed array")},me=function(Mt){if(p(Mt)&&(!D||O(Z,Mt)))return Mt;throw new nt(A(Mt)+" is not a typed array constructor")},ge=function(Mt,Ht,re,se){if(d){if(re)for(var ee in yt){var fe=h[ee];if(fe&&T(fe.prototype,Mt))try{delete fe.prototype[Mt]}catch(Pe){try{fe.prototype[Mt]=Ht}catch(Me){}}}(!J[Mt]||re)&&R(J,Mt,re?Ht:et&&B[Mt]||Ht,se)}},ae=function(Mt,Ht,re){var se,ee;if(d){if(D){if(re){for(se in yt)if(ee=h[se],ee&&T(ee,Mt))try{delete ee[Mt]}catch(fe){}}if(!Z[Mt]||re)try{return R(Z,Mt,re?Ht:et&&Z[Mt]||Ht)}catch(fe){}else return}for(se in yt)ee=h[se],ee&&(!ee[Mt]||re)&&R(ee,Mt,Ht)}};for(mt in yt)gt=h[mt],xt=gt&>.prototype,xt?U(xt)[tt]=gt:et=!1;for(mt in Ut)gt=h[mt],xt=gt&>.prototype,xt&&(U(xt)[tt]=gt);if((!et||!p(Z)||Z===Function.prototype)&&(Z=function(){throw new nt("Incorrect invocation")},et))for(mt in yt)h[mt]&&D(h[mt],Z);if((!et||!J||J===q)&&(J=Z.prototype,et))for(mt in yt)h[mt]&&D(h[mt].prototype,J);if(et&&C(Y)!==J&&D(Y,J),d&&!T(J,rt)){lt=!0,I(J,rt,{configurable:!0,get:function(){return y(this)?this[_]:void 0}});for(mt in yt)h[mt]&&E(h[mt],_,mt)}x.exports={NATIVE_ARRAY_BUFFER_VIEWS:et,TYPED_ARRAY_TAG:lt&&_,aTypedArray:kt,aTypedArrayConstructor:me,exportTypedArrayMethod:ge,exportTypedArrayStaticMethod:ae,getTypedArrayConstructor:Xt,isView:Dt,isTypedArray:Qt,TypedArray:Z,TypedArrayPrototype:J}},function(x,b,r){var u=r(3),d=r(85),h=r(7),p=r(208),y=r(46),T=r(60),$=r(64),A=p.ArrayBuffer,E=p.DataView,R=E.prototype,I=d(A.prototype.slice),O=d(R.getUint8),C=d(R.setUint8),D=h(function(){return!new A(2).slice(1,void 0).byteLength});u({target:"ArrayBuffer",proto:!0,unsafe:!0,forced:D},{slice:function(F,z){if(I&&z===void 0)return I(y(this),F);for(var U=y(this).byteLength,j=T(F,U),G=T(z===void 0?U:z,U),B=new A($(G-j)),V=new E(this),Y=new E(B),Z=0;j>>15,O=R>>>10&p,C=R&y;return O===p?C===0?I===0?1/0:-1/0:NaN:O===0?C*(I===0?T:-T):h(2,O-15)*(I===0?1+C*$:-1-C*$)},E=d(DataView.prototype.getUint16);u({target:"DataView",proto:!0},{getFloat16:function(I){var O=E(this,I,arguments.length>1?arguments[1]:!1);return A(O)}})},function(x,b,r){var u=r(3),d=r(14),h=r(225),p=r(212),y=r(226),T=r(216),$=Math.pow,A=65520,E=61005353927612305e-21,R=16777216,I=1024,O=function(D){if(D!==D)return 32256;if(D===0)return(1/D===-1/0)<<15;var M=D<0;if(M&&(D=-D),D>=A)return M<<15|31744;if(D2?arguments[2]:!1)}})},function(x,b,r){var u=r(69),d=TypeError;x.exports=function(h){if(u(h)==="DataView")return h;throw new d("Argument is not a DataView")}},function(x){var b=Math.log,r=Math.LN2;x.exports=Math.log2||function(d){return b(d)/r}},function(x,b,r){var u=r(6),d=r(77),h=r(228),p=ArrayBuffer.prototype;u&&!("detached"in p)&&d(p,"detached",{configurable:!0,get:function(){return h(this)}})},function(x,b,r){var u=r(4),d=r(209),h=r(229),p=u.DataView;x.exports=function(y){if(!d||h(y)!==0)return!1;try{return new p(y),!1}catch(T){return!0}}},function(x,b,r){var u=r(4),d=r(114),h=r(15),p=u.ArrayBuffer,y=u.TypeError;x.exports=p&&d(p.prototype,"byteLength","get")||function(T){if(h(T)!=="ArrayBuffer")throw new y("ArrayBuffer expected");return T.byteLength}},function(x,b,r){var u=r(3),d=r(231);d&&u({target:"ArrayBuffer",proto:!0},{transfer:function(){return d(this,arguments.length?arguments[0]:void 0,!0)}})},function(x,b,r){var u=r(4),d=r(14),h=r(114),p=r(212),y=r(232),T=r(229),$=r(233),A=r(235),E=u.structuredClone,R=u.ArrayBuffer,I=u.DataView,O=Math.min,C=R.prototype,D=I.prototype,M=d(C.slice),F=h(C,"resizable","get"),z=h(C,"maxByteLength","get"),U=d(D.getInt8),j=d(D.setInt8);x.exports=(A||$)&&function(G,B,V){var Y=T(G),Z=B===void 0?Y:p(B),J=!F||!F(G),q;if(y(G),A&&(G=E(G,{transfer:[G]}),Y===Z&&(V||J)))return G;if(Y>=Z&&(!V||J))q=M(G,0,Z);else{var nt=V&&!J&&z?{maxByteLength:z(G)}:void 0;q=new R(Z,nt);for(var rt=new I(G),_=new I(q),tt=O(Z,Y),et=0;et92||p==="NODE"&&h>94||p==="BROWSER"&&h>97)return!1;var T=new ArrayBuffer(8),$=y(T,{transfer:[T]});return T.byteLength!==0||$.byteLength!==8})},function(x,b,r){var u=r(3),d=r(231);d&&u({target:"ArrayBuffer",proto:!0},{transferToFixedLength:function(){return d(this,arguments.length?arguments[0]:void 0,!1)}})},function(x,b,r){var u=r(3),d=r(14),h=r(7),p=h(function(){return new Date(16e11).getYear()!==120}),y=d(Date.prototype.getFullYear);u({target:"Date",proto:!0,forced:p},{getYear:function(){return y(this)-1900}})},function(x,b,r){var u=r(3),d=r(14),h=Date,p=d(h.prototype.getTime);u({target:"Date",stat:!0},{now:function(){return p(new h)}})},function(x,b,r){var u=r(3),d=r(14),h=r(61),p=Date.prototype,y=d(p.getTime),T=d(p.setFullYear);u({target:"Date",proto:!0},{setYear:function(A){y(this);var E=h(A),R=E>=0&&E<=99?E+1900:E;return T(this,R)}})},function(x,b,r){var u=r(3);u({target:"Date",proto:!0},{toGMTString:Date.prototype.toUTCString})},function(x,b,r){var u=r(3),d=r(242);u({target:"Date",proto:!0,forced:Date.prototype.toISOString!==d},{toISOString:d})},function(x,b,r){var u=r(14),d=r(7),h=r(243).start,p=RangeError,y=isFinite,T=Math.abs,$=Date.prototype,A=$.toISOString,E=u($.getTime),R=u($.getUTCDate),I=u($.getUTCFullYear),O=u($.getUTCHours),C=u($.getUTCMilliseconds),D=u($.getUTCMinutes),M=u($.getUTCMonth),F=u($.getUTCSeconds);x.exports=d(function(){return A.call(new Date(-50000000000001))!=="0385-07-25T07:06:39.999Z"})||!d(function(){A.call(new Date(NaN))})?function(){if(!y(E(this)))throw new p("Invalid time value");var U=this,j=I(U),G=C(U),B=j<0?"-":j>9999?"+":"";return B+h(T(j),B?6:4,0)+"-"+h(M(U)+1,2,0)+"-"+h(R(U),2,0)+"T"+h(O(U),2,0)+":"+h(D(U),2,0)+":"+h(F(U),2,0)+"."+h(G,3,0)+"Z"}:A},function(x,b,r){var u=r(14),d=r(64),h=r(68),p=r(244),y=r(16),T=u(p),$=u("".slice),A=Math.ceil,E=function(R){return function(I,O,C){var D=h(y(I)),M=d(O),F=D.length,z=C===void 0?" ":h(C),U,j;return M<=F||z===""?D:(U=M-F,j=T(z,A(U/z.length)),j.length>U&&(j=$(j,0,U)),R?D+j:j+D)}};x.exports={start:E(!1),end:E(!0)}},function(x,b,r){var u=r(61),d=r(68),h=r(16),p=RangeError;x.exports=function(T){var $=d(h(this)),A="",E=u(T);if(E<0||E===1/0)throw new p("Wrong number of repetitions");for(;E>0;(E>>>=1)&&($+=$))E&1&&(A+=$);return A}},function(x,b,r){var u=r(3),d=r(7),h=r(39),p=r(19),y=d(function(){return new Date(NaN).toJSON()!==null||Date.prototype.toJSON.call({toISOString:function(){return 1}})!==1});u({target:"Date",proto:!0,arity:1,forced:y},{toJSON:function($){var A=h(this),E=p(A,"number");return typeof E=="number"&&!isFinite(E)?null:A.toISOString()}})},function(x,b,r){var u=r(38),d=r(47),h=r(247),p=r(33),y=p("toPrimitive"),T=Date.prototype;u(T,y)||d(T,y,h)},function(x,b,r){var u=r(46),d=r(32),h=TypeError;x.exports=function(p){if(u(this),p==="string"||p==="default")p="string";else if(p!=="number")throw new h("Incorrect hint");return d(this,p)}},function(x,b,r){var u=r(14),d=r(47),h=Date.prototype,p="Invalid Date",y="toString",T=u(h[y]),$=u(h.getTime);String(new Date(NaN))!==p&&d(h,y,function(){var E=$(this);return E===E?T(this):p})},function(x,b,r){var u=r(3),d=r(14),h=r(68),p=d("".charAt),y=d("".charCodeAt),T=d(/./.exec),$=d(1 .toString),A=d("".toUpperCase),E=/[\w*+\-./@]/,R=function(I,O){for(var C=$(I,16);C.length1?arguments[1]:void 0),_;_=_?_.next:nt.first;)for(rt(_.value,_.key,this);_&&_.removed;)_=_.previous},has:function(q){return!!Z(this,q)}}),h(B,U?{get:function(q){var nt=Z(this,q);return nt&&nt.value},set:function(q,nt){return Y(this,q===0?0:q,nt)}}:{add:function(q){return Y(this,q=q===0?0:q,q)}}),I&&d(B,"size",{configurable:!0,get:function(){return V(this).size}}),G},setStrong:function(F,z,U){var j=z+" Iterator",G=M(z),B=M(j);A(F,z,function(V,Y){D(this,{type:j,target:V,state:G(V),kind:Y,last:null})},function(){for(var V=B(this),Y=V.kind,Z=V.last;Z&&Z.removed;)Z=Z.previous;return!V.target||!(V.last=Z=Z?Z.next:V.state.first)?(V.target=null,E(void 0,!0)):E(Y==="keys"?Z.key:Y==="values"?Z.value:[Z.key,Z.value],!1)},U?"entries":"values",!U,!0),R(z)}}},function(x,b,r){var u=r(3),d=r(14),h=r(30),p=r(16),y=r(130),T=r(284),$=r(36),A=r(7),E=T.Map,R=T.has,I=T.get,O=T.set,C=d([].push),D=$||A(function(){return E.groupBy("ab",function(M){return M}).get("a").length!==1});u({target:"Map",stat:!0,forced:$||D},{groupBy:function(F,z){p(F),h(z);var U=new E,j=0;return y(F,function(G){var B=z(G,j++);R(U,B)?C(I(U,B),G):O(U,B,[G])}),U}})},function(x,b,r){var u=r(14),d=Map.prototype;x.exports={Map,set:u(d.set),get:u(d.get),has:u(d.has),remove:u(d.delete),proto:d}},function(x,b,r){var u=r(3),d=r(286),h=Math.acosh,p=Math.log,y=Math.sqrt,T=Math.LN2,$=!h||Math.floor(h(Number.MAX_VALUE))!==710||h(1/0)!==1/0;u({target:"Math",stat:!0,forced:$},{acosh:function(E){var R=+E;return R<1?NaN:R>9490626562425156e-8?p(R)+T:d(R-1+y(R-1)*y(R+1))}})},function(x){var b=Math.log;x.exports=Math.log1p||function(u){var d=+u;return d>-1e-8&&d<1e-8?d-d*d/2:b(1+d)}},function(x,b,r){var u=r(3),d=Math.asinh,h=Math.log,p=Math.sqrt;function y($){var A=+$;return!isFinite(A)||A===0?A:A<0?-y(-A):h(A+p(A*A+1))}var T=!(d&&1/d(0)>0);u({target:"Math",stat:!0,forced:T},{asinh:y})},function(x,b,r){var u=r(3),d=Math.atanh,h=Math.log,p=!(d&&1/d(-0)<0);u({target:"Math",stat:!0,forced:p},{atanh:function(T){var $=+T;return $===0?$:h((1+$)/(1-$))/2}})},function(x,b,r){var u=r(3),d=r(215),h=Math.abs,p=Math.pow;u({target:"Math",stat:!0},{cbrt:function(T){var $=+T;return d($)*p(h($),.3333333333333333)}})},function(x,b,r){var u=r(3),d=Math.floor,h=Math.log,p=Math.LOG2E;u({target:"Math",stat:!0},{clz32:function(T){var $=T>>>0;return $?31-d(h($+.5)*p):32}})},function(x,b,r){var u=r(3),d=r(292),h=Math.cosh,p=Math.abs,y=Math.E,T=!h||h(710)===1/0;u({target:"Math",stat:!0,forced:T},{cosh:function(A){var E=d(p(A)-1)+1;return(E+1/(E*y*y))*(y/2)}})},function(x){var b=Math.expm1,r=Math.exp;x.exports=!b||b(10)>22025.465794806718||b(10)<22025.465794806718||b(-2e-17)!==-2e-17?function(d){var h=+d;return h===0?h:h>-1e-6&&h<1e-6?h+h*h/2:r(h)-1}:b},function(x,b,r){var u=r(3),d=r(292);u({target:"Math",stat:!0,forced:d!==Math.expm1},{expm1:d})},function(x,b,r){var u=r(3),d=r(213);u({target:"Math",stat:!0},{fround:d})},function(x,b,r){var u=r(3),d=r(214),h=.0009765625,p=65504,y=6103515625e-14;u({target:"Math",stat:!0},{f16round:function($){return d($,h,p,y)}})},function(x,b,r){var u=r(3),d=Math.hypot,h=Math.abs,p=Math.sqrt,y=!!d&&d(1/0,NaN)!==1/0;u({target:"Math",stat:!0,arity:2,forced:y},{hypot:function($,A){for(var E=0,R=0,I=arguments.length,O=0,C,D;R0?(D=C/O,E+=D*D):E+=C;return O===1/0?1/0:O*p(E)}})},function(x,b,r){var u=r(3),d=r(7),h=Math.imul,p=d(function(){return h(4294967295,5)!==-5||h.length!==2});u({target:"Math",stat:!0,forced:p},{imul:function(T,$){var A=65535,E=+T,R=+$,I=A&E,O=A&R;return 0|I*O+((A&E>>>16)*O+I*(A&R>>>16)<<16>>>0)}})},function(x,b,r){var u=r(3),d=r(299);u({target:"Math",stat:!0},{log10:d})},function(x){var b=Math.log,r=Math.LOG10E;x.exports=Math.log10||function(d){return b(d)*r}},function(x,b,r){var u=r(3),d=r(286);u({target:"Math",stat:!0},{log1p:d})},function(x,b,r){var u=r(3),d=r(226);u({target:"Math",stat:!0},{log2:d})},function(x,b,r){var u=r(3),d=r(215);u({target:"Math",stat:!0},{sign:d})},function(x,b,r){var u=r(3),d=r(7),h=r(292),p=Math.abs,y=Math.exp,T=Math.E,$=d(function(){return Math.sinh(-2e-17)!==-2e-17});u({target:"Math",stat:!0,forced:$},{sinh:function(E){var R=+E;return p(R)<1?(h(R)-h(-R))/2:(y(R-1)-y(-R-1))*(T/2)}})},function(x,b,r){var u=r(3),d=r(292),h=Math.exp;u({target:"Math",stat:!0},{tanh:function(y){var T=+y,$=d(T),A=d(-T);return $===1/0?1:A===1/0?-1:($-A)/(h(T)+h(-T))}})},function(x,b,r){var u=r(82);u(Math,"Math",!0)},function(x,b,r){var u=r(3),d=r(62);u({target:"Math",stat:!0},{trunc:d})},function(x,b,r){var u=r(3),d=r(36),h=r(6),p=r(4),y=r(80),T=r(14),$=r(67),A=r(38),E=r(118),R=r(24),I=r(22),O=r(19),C=r(7),D=r(57).f,M=r(5).f,F=r(44).f,z=r(308),U=r(309).trim,j="Number",G=p[j],B=y[j],V=G.prototype,Y=p.TypeError,Z=T("".slice),J=T("".charCodeAt),q=function(lt){var mt=O(lt,"number");return typeof mt=="bigint"?mt:nt(mt)},nt=function(lt){var mt=O(lt,"number"),gt,xt,yt,Ut,Dt,Xt,Qt,kt;if(I(mt))throw new Y("Cannot convert a Symbol value to a number");if(typeof mt=="string"&&mt.length>2){if(mt=U(mt),gt=J(mt,0),gt===43||gt===45){if(xt=J(mt,2),xt===88||xt===120)return NaN}else if(gt===48){switch(J(mt,1)){case 66:case 98:yt=2,Ut=49;break;case 79:case 111:yt=8,Ut=55;break;default:return+mt}for(Dt=Z(mt,2),Xt=Dt.length,Qt=0;QtUt)return NaN;return parseInt(Dt,yt)}}return+mt},rt=$(j,!G(" 0o1")||!G("0b1")||G("+0x1")),_=function(lt){return R(V,lt)&&C(function(){z(lt)})},tt=function(mt){var gt=arguments.length<1?0:G(q(mt));return _(this)?E(Object(gt),this,tt):gt};tt.prototype=V,rt&&!d&&(V.constructor=tt),u({global:!0,constructor:!0,wrap:!0,forced:rt},{Number:tt});var et=function(lt,mt){for(var gt=h?D(mt):"MAX_VALUE,MIN_VALUE,NaN,NEGATIVE_INFINITY,POSITIVE_INFINITY,EPSILON,MAX_SAFE_INTEGER,MIN_SAFE_INTEGER,isFinite,isInteger,isNaN,isSafeInteger,parseFloat,parseInt,fromString,range".split(","),xt=0,yt;gt.length>xt;xt++)A(mt,yt=gt[xt])&&!A(lt,yt)&&F(lt,yt,M(mt,yt))};d&&B&&et(y[j],B),(rt||d)&&et(y[j],G)},function(x,b,r){var u=r(14);x.exports=u(1 .valueOf)},function(x,b,r){var u=r(14),d=r(16),h=r(68),p=r(310),y=u("".replace),T=RegExp("^["+p+"]+"),$=RegExp("(^|[^"+p+"])["+p+"]+$"),A=function(E){return function(R){var I=h(d(R));return E&1&&(I=y(I,T,"")),E&2&&(I=y(I,$,"$1")),I}};x.exports={start:A(1),end:A(2),trim:A(3)}},function(x){x.exports=` -\v\f\r \xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200A\u202F\u205F\u3000\u2028\u2029\uFEFF`},function(x,b,r){var u=r(3);u({target:"Number",stat:!0,nonConfigurable:!0,nonWritable:!0},{EPSILON:Math.pow(2,-52)})},function(x,b,r){var u=r(3),d=r(313);u({target:"Number",stat:!0},{isFinite:d})},function(x,b,r){var u=r(4),d=u.isFinite;x.exports=Number.isFinite||function(p){return typeof p=="number"&&d(p)}},function(x,b,r){var u=r(3),d=r(315);u({target:"Number",stat:!0},{isInteger:d})},function(x,b,r){var u=r(20),d=Math.floor;x.exports=Number.isInteger||function(p){return!u(p)&&isFinite(p)&&d(p)===p}},function(x,b,r){var u=r(3);u({target:"Number",stat:!0},{isNaN:function(h){return h!==h}})},function(x,b,r){var u=r(3),d=r(315),h=Math.abs;u({target:"Number",stat:!0},{isSafeInteger:function(y){return d(y)&&h(y)<=9007199254740991}})},function(x,b,r){var u=r(3);u({target:"Number",stat:!0,nonConfigurable:!0,nonWritable:!0},{MAX_SAFE_INTEGER:9007199254740991})},function(x,b,r){var u=r(3);u({target:"Number",stat:!0,nonConfigurable:!0,nonWritable:!0},{MIN_SAFE_INTEGER:-9007199254740991})},function(x,b,r){var u=r(3),d=r(321);u({target:"Number",stat:!0,forced:Number.parseFloat!==d},{parseFloat:d})},function(x,b,r){var u=r(4),d=r(7),h=r(14),p=r(68),y=r(309).trim,T=r(310),$=h("".charAt),A=u.parseFloat,E=u.Symbol,R=E&&E.iterator,I=1/A(T+"-0")!==-1/0||R&&!d(function(){A(Object(R))});x.exports=I?function(C){var D=y(p(C)),M=A(D);return M===0&&$(D,0)==="-"?-0:M}:A},function(x,b,r){var u=r(3),d=r(323);u({target:"Number",stat:!0,forced:Number.parseInt!==d},{parseInt:d})},function(x,b,r){var u=r(4),d=r(7),h=r(14),p=r(68),y=r(309).trim,T=r(310),$=u.parseInt,A=u.Symbol,E=A&&A.iterator,R=/^[+-]?0x/i,I=h(R.exec),O=$(T+"08")!==8||$(T+"0x16")!==22||E&&!d(function(){$(Object(E))});x.exports=O?function(D,M){var F=y(p(D));return $(F,M>>>0||(I(R,F)?16:10))}:$},function(x,b,r){var u=r(3),d=r(14),h=r(61),p=r(308),y=r(244),T=r(299),$=r(7),A=RangeError,E=String,R=isFinite,I=Math.abs,O=Math.floor,C=Math.pow,D=Math.round,M=d(1 .toExponential),F=d(y),z=d("".slice),U=M(-69e-12,4)==="-6.9000e-11"&&M(1.255,2)==="1.25e+0"&&M(12345,3)==="1.235e+4"&&M(25,0)==="3e+1",j=function(){return $(function(){M(1,1/0)})&&$(function(){M(1,-1/0)})},G=function(){return!$(function(){M(1/0,1/0),M(NaN,1/0)})},B=!U||!j()||!G();u({target:"Number",proto:!0,forced:B},{toExponential:function(Y){var Z=p(this);if(Y===void 0)return M(Z);var J=h(Y);if(!R(Z))return String(Z);if(J<0||J>20)throw new A("Incorrect fraction digits");if(U)return M(Z,J);var q="",nt,rt,_,tt;if(Z<0&&(q="-",Z=-Z),Z===0)rt=0,nt=F("0",J+1);else{var et=T(Z);rt=O(et);var lt=C(10,rt-J),mt=D(Z/lt);2*Z>=(2*mt+1)*lt&&(mt+=1),mt>=C(10,J+1)&&(mt/=10,rt+=1),nt=E(mt)}return J!==0&&(nt=z(nt,0,1)+"."+z(nt,1)),rt===0?(_="+",tt="0"):(_=rt>0?"+":"-",tt=E(I(rt))),nt+="e"+_+tt,q+nt}})},function(x,b,r){var u=r(3),d=r(14),h=r(61),p=r(308),y=r(244),T=r(7),$=RangeError,A=String,E=Math.floor,R=d(y),I=d("".slice),O=d(1 .toFixed),C=function(j,G,B){return G===0?B:G%2===1?C(j,G-1,B*j):C(j*j,G/2,B)},D=function(j){for(var G=0,B=j;B>=4096;)G+=12,B/=4096;for(;B>=2;)G+=1,B/=2;return G},M=function(j,G,B){for(var V=-1,Y=B;++V<6;)Y+=G*j[V],j[V]=Y%1e7,Y=E(Y/1e7)},F=function(j,G){for(var B=6,V=0;--B>=0;)V+=j[B],j[B]=E(V/G),V=V%G*1e7},z=function(j){for(var G=6,B="";--G>=0;)if(B!==""||G===0||j[G]!==0){var V=A(j[G]);B=B===""?V:B+R("0",7-V.length)+V}return B},U=T(function(){return O(8e-5,3)!=="0.000"||O(.9,0)!=="1"||O(1.255,2)!=="1.25"||O(0xde0b6b3a7640080,0)!=="1000000000000000128"})||!T(function(){O({})});u({target:"Number",proto:!0,forced:U},{toFixed:function(G){var B=p(this),V=h(G),Y=[0,0,0,0,0,0],Z="",J="0",q,nt,rt,_;if(V<0||V>20)throw new $("Incorrect fraction digits");if(B!==B)return"NaN";if(B<=-1e21||B>=1e21)return A(B);if(B<0&&(Z="-",B=-B),B>1e-21)if(q=D(B*C(2,69,1))-69,nt=q<0?B*C(2,-q,1):B/C(2,q,1),nt*=4503599627370496,q=52-q,q>0){for(M(Y,0,nt),rt=V;rt>=7;)M(Y,1e7,0),rt-=7;for(M(Y,C(10,rt,1),0),rt=q-1;rt>=23;)F(Y,8388608),rt-=23;F(Y,1<0?(_=J.length,J=Z+(_<=V?"0."+R("0",V-_)+J:I(J,0,_-V)+"."+I(J,_-V))):J=Z+J,J}})},function(x,b,r){var u=r(3),d=r(14),h=r(7),p=r(308),y=d(1 .toPrecision),T=h(function(){return y(1,void 0)!=="1"})||!h(function(){y({})});u({target:"Number",proto:!0,forced:T},{toPrecision:function(A){return A===void 0?y(p(this)):y(p(this),A)}})},function(x,b,r){var u=r(3),d=r(328);u({target:"Object",stat:!0,arity:2,forced:Object.assign!==d},{assign:d})},function(x,b,r){var u=r(6),d=r(14),h=r(8),p=r(7),y=r(73),T=r(66),$=r(10),A=r(39),E=r(13),R=Object.assign,I=Object.defineProperty,O=d([].concat);x.exports=!R||p(function(){if(u&&R({b:1},R(I({},"a",{enumerable:!0,get:function(){I(this,"b",{value:3,enumerable:!1})}}),{b:2})).b!==1)return!0;var C={},D={},M=Symbol("assign detection"),F="abcdefghijklmnopqrst";return C[M]=7,F.split("").forEach(function(z){D[z]=z}),R({},C)[M]!==7||y(R({},D)).join("")!==F})?function(D,M){for(var F=A(D),z=arguments.length,U=1,j=T.f,G=$.f;z>U;)for(var B=E(arguments[U++]),V=j?O(y(B),j(B)):y(B),Y=V.length,Z=0,J;Y>Z;)J=V[Z++],(!u||h(G,B,J))&&(F[J]=B[J]);return F}:R},function(x,b,r){var u=r(3),d=r(6),h=r(71);u({target:"Object",stat:!0,sham:!d},{create:h})},function(x,b,r){var u=r(3),d=r(6),h=r(331),p=r(30),y=r(39),T=r(44);d&&u({target:"Object",proto:!0,forced:h},{__defineGetter__:function(A,E){T.f(y(this),A,{get:p(E),enumerable:!0,configurable:!0})}})},function(x,b,r){var u=r(36),d=r(4),h=r(7),p=r(192);x.exports=u||!h(function(){if(!(p&&p<535)){var y=Math.random();__defineSetter__.call(null,y,function(){}),delete d[y]}})},function(x,b,r){var u=r(3),d=r(6),h=r(72).f;u({target:"Object",stat:!0,forced:Object.defineProperties!==h,sham:!d},{defineProperties:h})},function(x,b,r){var u=r(3),d=r(6),h=r(44).f;u({target:"Object",stat:!0,forced:Object.defineProperty!==h,sham:!d},{defineProperty:h})},function(x,b,r){var u=r(3),d=r(6),h=r(331),p=r(30),y=r(39),T=r(44);d&&u({target:"Object",proto:!0,forced:h},{__defineSetter__:function(A,E){T.f(y(this),A,{set:p(E),enumerable:!0,configurable:!0})}})},function(x,b,r){var u=r(3),d=r(336).entries;u({target:"Object",stat:!0},{entries:function(p){return d(p)}})},function(x,b,r){var u=r(6),d=r(7),h=r(14),p=r(128),y=r(73),T=r(12),$=r(10).f,A=h($),E=h([].push),R=u&&d(function(){var O=Object.create(null);return O[2]=2,!A(O,2)}),I=function(O){return function(C){for(var D=T(C),M=y(D),F=R&&p(D)===null,z=M.length,U=0,j=[],G;z>U;)G=M[U++],(!u||(F?G in D:A(D,G)))&&E(j,O?[G,D[G]]:D[G]);return j}};x.exports={entries:I(!0),values:I(!1)}},function(x,b,r){var u=r(3),d=r(281),h=r(7),p=r(20),y=r(278).onFreeze,T=Object.freeze,$=h(function(){T(1)});u({target:"Object",stat:!0,forced:$,sham:!d},{freeze:function(E){return T&&p(E)?T(y(E)):E}})},function(x,b,r){var u=r(3),d=r(130),h=r(141);u({target:"Object",stat:!0},{fromEntries:function(y){var T={};return d(y,function($,A){h(T,$,A)},{AS_ENTRIES:!0}),T}})},function(x,b,r){var u=r(3),d=r(7),h=r(12),p=r(5).f,y=r(6),T=!y||d(function(){p(1)});u({target:"Object",stat:!0,forced:T,sham:!y},{getOwnPropertyDescriptor:function(A,E){return p(h(A),E)}})},function(x,b,r){var u=r(3),d=r(6),h=r(56),p=r(12),y=r(5),T=r(141);u({target:"Object",stat:!0,sham:!d},{getOwnPropertyDescriptors:function(A){for(var E=p(A),R=y.f,I=h(E),O={},C=0,D,M;I.length>C;)M=R(E,D=I[C++]),M!==void 0&&T(O,D,M);return O}})},function(x,b,r){var u=r(3),d=r(7),h=r(75).f,p=d(function(){return!Object.getOwnPropertyNames(1)});u({target:"Object",stat:!0,forced:p},{getOwnPropertyNames:h})},function(x,b,r){var u=r(3),d=r(7),h=r(39),p=r(128),y=r(129),T=d(function(){p(1)});u({target:"Object",stat:!0,forced:T,sham:!y},{getPrototypeOf:function(A){return p(h(A))}})},function(x,b,r){var u=r(3),d=r(23),h=r(14),p=r(30),y=r(16),T=r(18),$=r(130),A=r(7),E=Object.groupBy,R=d("Object","create"),I=h([].push),O=!E||A(function(){return E("ab",function(C){return C}).a.length!==1});u({target:"Object",stat:!0,forced:O},{groupBy:function(D,M){y(D),p(M);var F=R(null),z=0;return $(D,function(U){var j=T(M(U,z++));j in F?I(F[j],U):F[j]=[U]}),F}})},function(x,b,r){var u=r(3),d=r(38);u({target:"Object",stat:!0},{hasOwn:d})},function(x,b,r){var u=r(3),d=r(346);u({target:"Object",stat:!0},{is:d})},function(x){x.exports=Object.is||function(r,u){return r===u?r!==0||1/r===1/u:r!==r&&u!==u}},function(x,b,r){var u=r(3),d=r(279);u({target:"Object",stat:!0,forced:Object.isExtensible!==d},{isExtensible:d})},function(x,b,r){var u=r(3),d=r(7),h=r(20),p=r(15),y=r(280),T=Object.isFrozen,$=y||d(function(){T(1)});u({target:"Object",stat:!0,forced:$},{isFrozen:function(E){return!h(E)||y&&p(E)==="ArrayBuffer"?!0:T?T(E):!1}})},function(x,b,r){var u=r(3),d=r(7),h=r(20),p=r(15),y=r(280),T=Object.isSealed,$=y||d(function(){T(1)});u({target:"Object",stat:!0,forced:$},{isSealed:function(E){return!h(E)||y&&p(E)==="ArrayBuffer"?!0:T?T(E):!1}})},function(x,b,r){var u=r(3),d=r(39),h=r(73),p=r(7),y=p(function(){h(1)});u({target:"Object",stat:!0,forced:y},{keys:function($){return h(d($))}})},function(x,b,r){var u=r(3),d=r(6),h=r(331),p=r(39),y=r(18),T=r(128),$=r(5).f;d&&u({target:"Object",proto:!0,forced:h},{__lookupGetter__:function(E){var R=p(this),I=y(E),O;do if(O=$(R,I))return O.get;while(R=T(R))}})},function(x,b,r){var u=r(3),d=r(6),h=r(331),p=r(39),y=r(18),T=r(128),$=r(5).f;d&&u({target:"Object",proto:!0,forced:h},{__lookupSetter__:function(E){var R=p(this),I=y(E),O;do if(O=$(R,I))return O.set;while(R=T(R))}})},function(x,b,r){var u=r(3),d=r(20),h=r(278).onFreeze,p=r(281),y=r(7),T=Object.preventExtensions,$=y(function(){T(1)});u({target:"Object",stat:!0,forced:$,sham:!p},{preventExtensions:function(E){return T&&d(E)?T(h(E)):E}})},function(x,b,r){var u=r(6),d=r(77),h=r(20),p=r(116),y=r(39),T=r(16),$=Object.getPrototypeOf,A=Object.setPrototypeOf,E=Object.prototype,R="__proto__";if(u&&$&&A&&!(R in E))try{d(E,R,{configurable:!0,get:function(){return $(y(this))},set:function(O){var C=T(this);p(O)&&h(C)&&A(C,O)}})}catch(I){}},function(x,b,r){var u=r(3),d=r(20),h=r(278).onFreeze,p=r(281),y=r(7),T=Object.seal,$=y(function(){T(1)});u({target:"Object",stat:!0,forced:$,sham:!p},{seal:function(E){return T&&d(E)?T(h(E)):E}})},function(x,b,r){var u=r(3),d=r(113);u({target:"Object",stat:!0},{setPrototypeOf:d})},function(x,b,r){var u=r(70),d=r(47),h=r(358);u||d(Object.prototype,"toString",h,{unsafe:!0})},function(x,b,r){var u=r(70),d=r(69);x.exports=u?{}.toString:function(){return"[object "+d(this)+"]"}},function(x,b,r){var u=r(3),d=r(336).values;u({target:"Object",stat:!0},{values:function(p){return d(p)}})},function(x,b,r){var u=r(3),d=r(321);u({global:!0,forced:parseFloat!==d},{parseFloat:d})},function(x,b,r){var u=r(3),d=r(323);u({global:!0,forced:parseInt!==d},{parseInt:d})},function(x,b,r){r(363),r(379),r(381),r(382),r(383),r(384)},function(x,b,r){var u=r(3),d=r(36),h=r(182),p=r(4),y=r(8),T=r(47),$=r(113),A=r(82),E=r(194),R=r(30),I=r(21),O=r(20),C=r(211),D=r(364),M=r(366).set,F=r(369),z=r(374),U=r(375),j=r(371),G=r(51),B=r(376),V=r(377),Y=r(378),Z="Promise",J=V.CONSTRUCTOR,q=V.REJECTION_EVENT,nt=V.SUBCLASSING,rt=G.getterFor(Z),_=G.set,tt=B&&B.prototype,et=B,lt=tt,mt=p.TypeError,gt=p.document,xt=p.process,yt=Y.f,Ut=yt,Dt=!!(gt&>.createEvent&&p.dispatchEvent),Xt="unhandledrejection",Qt="rejectionhandled",kt=0,me=1,ge=2,ae=1,Mt=2,Ht,re,se,ee,fe=function(Tt){var qt;return O(Tt)&&I(qt=Tt.then)?qt:!1},Pe=function(Tt,qt){var te=qt.value,Zt=qt.state===me,Yt=Zt?Tt.ok:Tt.fail,Ye=Tt.resolve,Ze=Tt.reject,ut=Tt.domain,It,Pt,Ct;try{Yt?(Zt||(qt.rejection===Mt&&Te(qt),qt.rejection=ae),Yt===!0?It=te:(ut&&ut.enter(),It=Yt(te),ut&&(ut.exit(),Ct=!0)),It===Tt.promise?Ze(new mt("Promise-chain cycle")):(Pt=fe(It))?y(Pt,It,Ye,Ze):Ye(It)):Ze(te)}catch(Nt){ut&&!Ct&&ut.exit(),Ze(Nt)}},Me=function(Tt,qt){Tt.notified||(Tt.notified=!0,F(function(){for(var te=Tt.reactions,Zt;Zt=te.get();)Pe(Zt,Tt);Tt.notified=!1,qt&&!Tt.rejection&&ce(Tt)}))},$e=function(Tt,qt,te){var Zt,Yt;Dt?(Zt=gt.createEvent("Event"),Zt.promise=qt,Zt.reason=te,Zt.initEvent(Tt,!1,!0),p.dispatchEvent(Zt)):Zt={promise:qt,reason:te},!q&&(Yt=p["on"+Tt])?Yt(Zt):Tt===Xt&&z("Unhandled promise rejection",te)},ce=function(Tt){y(M,p,function(){var qt=Tt.facade,te=Tt.value,Zt=Ae(Tt),Yt;if(Zt&&(Yt=U(function(){h?xt.emit("unhandledRejection",te,qt):$e(Xt,qt,te)}),Tt.rejection=h||Ae(Tt)?Mt:ae,Yt.error))throw Yt.value})},Ae=function(Tt){return Tt.rejection!==ae&&!Tt.parent},Te=function(Tt){y(M,p,function(){var qt=Tt.facade;h?xt.emit("rejectionHandled",qt):$e(Qt,qt,Tt.value)})},de=function(Tt,qt,te){return function(Zt){Tt(qt,Zt,te)}},bt=function(Tt,qt,te){Tt.done||(Tt.done=!0,te&&(Tt=te),Tt.value=qt,Tt.state=ge,Me(Tt,!0))},Ft=function(Tt,qt,te){if(!Tt.done){Tt.done=!0,te&&(Tt=te);try{if(Tt.facade===qt)throw new mt("Promise can't be resolved itself");var Zt=fe(qt);Zt?F(function(){var Yt={done:!1};try{y(Zt,qt,de(Ft,Yt,Tt),de(bt,Yt,Tt))}catch(Ye){bt(Yt,Ye,Tt)}}):(Tt.value=qt,Tt.state=me,Me(Tt,!1))}catch(Yt){bt({done:!1},Yt,Tt)}}};if(J&&(et=function(qt){C(this,lt),R(qt),y(Ht,this);var te=rt(this);try{qt(de(Ft,te),de(bt,te))}catch(Zt){bt(te,Zt)}},lt=et.prototype,Ht=function(qt){_(this,{type:Z,done:!1,notified:!1,parent:!1,reactions:new j,rejection:!1,state:kt,value:null})},Ht.prototype=T(lt,"then",function(qt,te){var Zt=rt(this),Yt=yt(D(this,et));return Zt.parent=!0,Yt.ok=I(qt)?qt:!0,Yt.fail=I(te)&&te,Yt.domain=h?xt.domain:void 0,Zt.state===kt?Zt.reactions.add(Yt):F(function(){Pe(Yt,Zt)}),Yt.promise}),re=function(){var Tt=new Ht,qt=rt(Tt);this.promise=Tt,this.resolve=de(Ft,qt),this.reject=de(bt,qt)},Y.f=yt=function(Tt){return Tt===et||Tt===se?new re(Tt):Ut(Tt)},!d&&I(B)&&tt!==Object.prototype)){ee=tt.then,nt||T(tt,"then",function(qt,te){var Zt=this;return new et(function(Yt,Ye){y(ee,Zt,Yt,Ye)}).then(qt,te)},{unsafe:!0});try{delete tt.constructor}catch(Tt){}$&&$(tt,lt)}u({global:!0,constructor:!0,wrap:!0,forced:J},{Promise:et}),A(et,Z,!1,!0),E(Z)},function(x,b,r){var u=r(46),d=r(365),h=r(17),p=r(33),y=p("species");x.exports=function(T,$){var A=u(T).constructor,E;return A===void 0||h(E=u(A)[y])?$:d(E)}},function(x,b,r){var u=r(89),d=r(31),h=TypeError;x.exports=function(p){if(u(p))return p;throw new h(d(p)+" is not a constructor")}},function(x,b,r){var u=r(4),d=r(94),h=r(84),p=r(21),y=r(38),T=r(7),$=r(74),A=r(76),E=r(42),R=r(367),I=r(368),O=r(182),C=u.setImmediate,D=u.clearImmediate,M=u.process,F=u.Dispatch,z=u.Function,U=u.MessageChannel,j=u.String,G=0,B={},V="onreadystatechange",Y,Z,J,q;T(function(){Y=u.location});var nt=function(et){if(y(B,et)){var lt=B[et];delete B[et],lt()}},rt=function(et){return function(){nt(et)}},_=function(et){nt(et.data)},tt=function(et){u.postMessage(j(et),Y.protocol+"//"+Y.host)};(!C||!D)&&(C=function(lt){R(arguments.length,1);var mt=p(lt)?lt:z(lt),gt=A(arguments,1);return B[++G]=function(){d(mt,void 0,gt)},Z(G),G},D=function(lt){delete B[lt]},O?Z=function(et){M.nextTick(rt(et))}:F&&F.now?Z=function(et){F.now(rt(et))}:U&&!I?(J=new U,q=J.port2,J.port1.onmessage=_,Z=h(q.postMessage,q)):u.addEventListener&&p(u.postMessage)&&!u.importScripts&&Y&&Y.protocol!=="file:"&&!T(tt)?(Z=tt,u.addEventListener("message",_,!1)):V in E("script")?Z=function(et){$.appendChild(E("script"))[V]=function(){$.removeChild(this),nt(et)}}:Z=function(et){setTimeout(rt(et),0)}),x.exports={set:C,clear:D}},function(x){var b=TypeError;x.exports=function(r,u){if(r1?p(arguments,1):[],C=y.f(this),D=$(function(){return h(T(I),void 0,O)});return(D.error?C.reject:C.resolve)(D.value),C.promise}})},function(x,b,r){var u=r(3),d=r(378);u({target:"Promise",stat:!0},{withResolvers:function(){var p=d.f(this);return{promise:p.promise,resolve:p.resolve,reject:p.reject}}})},function(x,b,r){var u=r(3),d=r(94),h=r(30),p=r(46),y=r(7),T=!y(function(){Reflect.apply(function(){})});u({target:"Reflect",stat:!0,forced:T},{apply:function(A,E,R){return d(h(A),E,p(R))}})},function(x,b,r){var u=r(3),d=r(23),h=r(94),p=r(251),y=r(365),T=r(46),$=r(20),A=r(71),E=r(7),R=d("Reflect","construct"),I=Object.prototype,O=[].push,C=E(function(){function F(){}return!(R(function(){},[],F)instanceof F)}),D=!E(function(){R(function(){})}),M=C||D;u({target:"Reflect",stat:!0,forced:M,sham:M},{construct:function(z,U){y(z),T(U);var j=arguments.length<3?z:y(arguments[2]);if(D&&!C)return R(z,U,j);if(z===j){switch(U.length){case 0:return new z;case 1:return new z(U[0]);case 2:return new z(U[0],U[1]);case 3:return new z(U[0],U[1],U[2]);case 4:return new z(U[0],U[1],U[2],U[3])}var G=[null];return h(O,G,U),new(h(p,z,G))}var B=j.prototype,V=A($(B)?B:I),Y=h(z,V,U);return $(Y)?Y:V}})},function(x,b,r){var u=r(3),d=r(6),h=r(46),p=r(18),y=r(44),T=r(7),$=T(function(){Reflect.defineProperty(y.f({},1,{value:1}),1,{value:2})});u({target:"Reflect",stat:!0,forced:$,sham:!d},{defineProperty:function(E,R,I){h(E);var O=p(R);h(I);try{return y.f(E,O,I),!0}catch(C){return!1}}})},function(x,b,r){var u=r(3),d=r(46),h=r(5).f;u({target:"Reflect",stat:!0},{deleteProperty:function(y,T){var $=h(d(y),T);return $&&!$.configurable?!1:delete y[T]}})},function(x,b,r){var u=r(3),d=r(8),h=r(20),p=r(46),y=r(396),T=r(5),$=r(128);function A(E,R){var I=arguments.length<3?E:arguments[2],O,C;if(p(E)===I)return E[R];if(O=T.f(E,R),O)return y(O)?O.value:O.get===void 0?void 0:d(O.get,I);if(h(C=$(E)))return A(C,R,I)}u({target:"Reflect",stat:!0},{get:A})},function(x,b,r){var u=r(38);x.exports=function(d){return d!==void 0&&(u(d,"value")||u(d,"writable"))}},function(x,b,r){var u=r(3),d=r(6),h=r(46),p=r(5);u({target:"Reflect",stat:!0,sham:!d},{getOwnPropertyDescriptor:function(T,$){return p.f(h(T),$)}})},function(x,b,r){var u=r(3),d=r(46),h=r(128),p=r(129);u({target:"Reflect",stat:!0,sham:!p},{getPrototypeOf:function(T){return h(d(T))}})},function(x,b,r){var u=r(3);u({target:"Reflect",stat:!0},{has:function(h,p){return p in h}})},function(x,b,r){var u=r(3),d=r(46),h=r(279);u({target:"Reflect",stat:!0},{isExtensible:function(y){return d(y),h(y)}})},function(x,b,r){var u=r(3),d=r(56);u({target:"Reflect",stat:!0},{ownKeys:d})},function(x,b,r){var u=r(3),d=r(23),h=r(46),p=r(281);u({target:"Reflect",stat:!0,sham:!p},{preventExtensions:function(T){h(T);try{var $=d("Object","preventExtensions");return $&&$(T),!0}catch(A){return!1}}})},function(x,b,r){var u=r(3),d=r(8),h=r(46),p=r(20),y=r(396),T=r(7),$=r(44),A=r(5),E=r(128),R=r(11);function I(C,D,M){var F=arguments.length<4?C:arguments[3],z=A.f(h(C),D),U,j,G;if(!z){if(p(j=E(C)))return I(j,D,M,F);z=R(0)}if(y(z)){if(z.writable===!1||!p(F))return!1;if(U=A.f(F,D)){if(U.get||U.set||U.writable===!1)return!1;U.value=M,$.f(F,D,U)}else $.f(F,D,R(0,M))}else{if(G=z.set,G===void 0)return!1;d(G,F,M)}return!0}var O=T(function(){var C=function(){},D=$.f(new C,"a",{configurable:!0});return Reflect.set(C.prototype,"a",1,D)!==!1});u({target:"Reflect",stat:!0,forced:O},{set:I})},function(x,b,r){var u=r(3),d=r(46),h=r(115),p=r(113);p&&u({target:"Reflect",stat:!0},{setPrototypeOf:function(T,$){d(T),h($);try{return p(T,$),!0}catch(A){return!1}}})},function(x,b,r){var u=r(3),d=r(4),h=r(82);u({global:!0},{Reflect:{}}),h(d.Reflect,"Reflect",!0)},function(x,b,r){var u=r(6),d=r(4),h=r(14),p=r(67),y=r(118),T=r(43),$=r(71),A=r(57).f,E=r(24),R=r(407),I=r(68),O=r(408),C=r(410),D=r(117),M=r(47),F=r(7),z=r(38),U=r(51).enforce,j=r(194),G=r(33),B=r(411),V=r(412),Y=G("match"),Z=d.RegExp,J=Z.prototype,q=d.SyntaxError,nt=h(J.exec),rt=h("".charAt),_=h("".replace),tt=h("".indexOf),et=h("".slice),lt=/^\?<[^\s\d!#%&*+<=>@^][^\s!#%&*+<=>@^]*>/,mt=/a/g,gt=/a/g,xt=new Z(mt)!==mt,yt=C.MISSED_STICKY,Ut=C.UNSUPPORTED_Y,Dt=u&&(!xt||yt||B||V||F(function(){return gt[Y]=!1,Z(mt)!==mt||Z(gt)===gt||String(Z(mt,"i"))!=="/a/i"})),Xt=function(ae){for(var Mt=ae.length,Ht=0,re="",se=!1,ee;Ht<=Mt;Ht++){if(ee=rt(ae,Ht),ee==="\\"){re+=ee+rt(ae,++Ht);continue}!se&&ee==="."?re+="[\\s\\S]":(ee==="["?se=!0:ee==="]"&&(se=!1),re+=ee)}return re},Qt=function(ae){for(var Mt=ae.length,Ht=0,re="",se=[],ee=$(null),fe=!1,Pe=!1,Me=0,$e="",ce;Ht<=Mt;Ht++){if(ce=rt(ae,Ht),ce==="\\")ce+=rt(ae,++Ht);else if(ce==="]")fe=!1;else if(!fe)switch(!0){case ce==="[":fe=!0;break;case ce==="(":if(re+=ce,et(ae,Ht+1,Ht+3)==="?:")continue;nt(lt,et(ae,Ht+1))&&(Ht+=2,Pe=!0),Me++;continue;case(ce===">"&&Pe):if($e===""||z(ee,$e))throw new q("Invalid capture group name");ee[$e]=!0,se[se.length]=[$e,Me],Pe=!1,$e="";continue}Pe?$e+=ce:re+=ce}return[re,se]};if(p("RegExp",Dt)){for(var kt=function(Mt,Ht){var re=E(J,this),se=R(Mt),ee=Ht===void 0,fe=[],Pe=Mt,Me,$e,ce,Ae,Te,de;if(!re&&se&&ee&&Mt.constructor===kt)return Mt;if((se||E(J,Mt))&&(Mt=Mt.source,ee&&(Ht=O(Pe))),Mt=Mt===void 0?"":I(Mt),Ht=Ht===void 0?"":I(Ht),Pe=Mt,B&&"dotAll"in mt&&($e=!!Ht&&tt(Ht,"s")>-1,$e&&(Ht=_(Ht,/s/g,""))),Me=Ht,yt&&"sticky"in mt&&(ce=!!Ht&&tt(Ht,"y")>-1,ce&&Ut&&(Ht=_(Ht,/y/g,""))),V&&(Ae=Qt(Mt),Mt=Ae[0],fe=Ae[1]),Te=y(Z(Mt,Ht),re?this:J,kt),($e||ce||fe.length)&&(de=U(Te),$e&&(de.dotAll=!0,de.raw=kt(Xt(Mt),Me)),ce&&(de.sticky=!0),fe.length&&(de.groups=fe)),Mt!==Pe)try{T(Te,"source",Pe===""?"(?:)":Pe)}catch(bt){}return Te},me=A(Z),ge=0;me.length>ge;)D(kt,Z,me[ge++]);J.constructor=kt,kt.prototype=J,M(d,"RegExp",kt,{constructor:!0})}j("RegExp")},function(x,b,r){var u=r(20),d=r(15),h=r(33),p=h("match");x.exports=function(y){var T;return u(y)&&((T=y[p])!==void 0?!!T:d(y)==="RegExp")}},function(x,b,r){var u=r(8),d=r(38),h=r(24),p=r(409),y=RegExp.prototype;x.exports=function(T){var $=T.flags;return $===void 0&&!("flags"in y)&&!d(T,"flags")&&h(y,T)?u(p,T):$}},function(x,b,r){var u=r(46);x.exports=function(){var d=u(this),h="";return d.hasIndices&&(h+="d"),d.global&&(h+="g"),d.ignoreCase&&(h+="i"),d.multiline&&(h+="m"),d.dotAll&&(h+="s"),d.unicode&&(h+="u"),d.unicodeSets&&(h+="v"),d.sticky&&(h+="y"),h}},function(x,b,r){var u=r(7),d=r(4),h=d.RegExp,p=u(function(){var $=h("a","y");return $.lastIndex=2,$.exec("abcd")!==null}),y=p||u(function(){return!h("a","y").sticky}),T=p||u(function(){var $=h("^r","gy");return $.lastIndex=2,$.exec("str")!==null});x.exports={BROKEN_CARET:T,MISSED_STICKY:y,UNSUPPORTED_Y:p}},function(x,b,r){var u=r(7),d=r(4),h=d.RegExp;x.exports=u(function(){var p=h(".","s");return!(p.dotAll&&p.test(` -`)&&p.flags==="s")})},function(x,b,r){var u=r(7),d=r(4),h=d.RegExp;x.exports=u(function(){var p=h("(?    b)","g");return p.exec("b").groups.a!=="b"||"b".replace(p,"$c")!=="bc"})},function(x,b,r){var u=r(3),d=r(14),h=r(414),p=r(38),y=r(243).start,T=r(310),$=Array,A=RegExp.escape,E=d("".charAt),R=d("".charCodeAt),I=d(1.1.toString),O=d([].join),C=/^[0-9a-z]/i,D=/^[$()*+./?[\\\]^{|}]/,M=RegExp("^[!\"#%&',\\-:;<=>@`~"+T+"]"),F=d(C.exec),z={" ":"t","\n":"n","\v":"v","\f":"f","\r":"r"},U=function(G){var B=I(R(G,0),16);return B.length<3?"\\x"+y(B,2,"0"):"\\u"+y(B,4,"0")},j=!A||A("ab")!=="\\x61b";u({target:"RegExp",stat:!0,forced:j},{escape:function(B){h(B);for(var V=B.length,Y=$(V),Z=0;Z=56320||Z+1>=V||(R(B,Z+1)&64512)!==56320?Y[Z]=U(J):(Y[Z]=J,Y[++Z]=E(B,Z))}}return O(Y,"")}})},function(x){var b=TypeError;x.exports=function(r){if(typeof r=="string")return r;throw new b("Argument is not a string")}},function(x,b,r){var u=r(6),d=r(411),h=r(15),p=r(77),y=r(51).get,T=RegExp.prototype,$=TypeError;u&&d&&p(T,"dotAll",{configurable:!0,get:function(){if(this!==T){if(h(this)==="RegExp")return!!y(this).dotAll;throw new $("Incompatible receiver, RegExp required")}}})},function(x,b,r){var u=r(3),d=r(417);u({target:"RegExp",proto:!0,forced:/./.exec!==d},{exec:d})},function(x,b,r){var u=r(8),d=r(14),h=r(68),p=r(409),y=r(410),T=r(34),$=r(71),A=r(51).get,E=r(411),R=r(412),I=T("native-string-replace",String.prototype.replace),O=RegExp.prototype.exec,C=O,D=d("".charAt),M=d("".indexOf),F=d("".replace),z=d("".slice),U=function(){var V=/a/,Y=/b*/g;return u(O,V,"a"),u(O,Y,"a"),V.lastIndex!==0||Y.lastIndex!==0}(),j=y.BROKEN_CARET,G=/()??/.exec("")[1]!==void 0,B=U||G||j||E||R;B&&(C=function(Y){var Z=this,J=A(Z),q=h(Y),nt=J.raw,rt,_,tt,et,lt,mt,gt;if(nt)return nt.lastIndex=Z.lastIndex,rt=u(C,nt,q),Z.lastIndex=nt.lastIndex,rt;var xt=J.groups,yt=j&&Z.sticky,Ut=u(p,Z),Dt=Z.source,Xt=0,Qt=q;if(yt&&(Ut=F(Ut,"y",""),M(Ut,"g")===-1&&(Ut+="g"),Qt=z(q,Z.lastIndex),Z.lastIndex>0&&(!Z.multiline||Z.multiline&&D(q,Z.lastIndex-1)!==` -`)&&(Dt="(?: "+Dt+")",Qt=" "+Qt,Xt++),_=new RegExp("^(?:"+Dt+")",Ut)),G&&(_=new RegExp("^"+Dt+"$(?!\\s)",Ut)),U&&(tt=Z.lastIndex),et=u(O,yt?_:Z,Qt),yt?et?(et.input=z(et.input,Xt),et[0]=z(et[0],Xt),et.index=Z.lastIndex,Z.lastIndex+=et[0].length):Z.lastIndex=0:U&&et&&(Z.lastIndex=Z.global?et.index+et[0].length:tt),G&&et&&et.length>1&&u(I,et[0],_,function(){for(lt=1;ltC.size?T(C.getIterator(),function(M){E(O,M)&&A(D,M)}):y(O,function(M){C.includes(M)&&A(D,M)}),D}},function(x,b,r){var u=r(3),d=r(437),h=r(433),p=!h("isDisjointFrom",function(y){return!y});u({target:"Set",proto:!0,real:!0,forced:p},{isDisjointFrom:d})},function(x,b,r){var u=r(426),d=r(427).has,h=r(431),p=r(432),y=r(429),T=r(430),$=r(135);x.exports=function(E){var R=u(this),I=p(E);if(h(R)<=I.size)return y(R,function(C){if(I.includes(C))return!1},!0)!==!1;var O=I.getIterator();return T(O,function(C){if(d(R,C))return $(O,"normal",!1)})!==!1}},function(x,b,r){var u=r(3),d=r(439),h=r(433),p=!h("isSubsetOf",function(y){return y});u({target:"Set",proto:!0,real:!0,forced:p},{isSubsetOf:d})},function(x,b,r){var u=r(426),d=r(431),h=r(429),p=r(432);x.exports=function(T){var $=u(this),A=p(T);return d($)>A.size?!1:h($,function(E){if(!A.includes(E))return!1},!0)!==!1}},function(x,b,r){var u=r(3),d=r(441),h=r(433),p=!h("isSupersetOf",function(y){return!y});u({target:"Set",proto:!0,real:!0,forced:p},{isSupersetOf:d})},function(x,b,r){var u=r(426),d=r(427).has,h=r(431),p=r(432),y=r(430),T=r(135);x.exports=function(A){var E=u(this),R=p(A);if(h(E)=0?C:O+C;return D<0||D>=O?void 0:$(I,D)}})},function(x,b,r){var u=r(3),d=r(448).codeAt;u({target:"String",proto:!0},{codePointAt:function(p){return d(this,p)}})},function(x,b,r){var u=r(14),d=r(61),h=r(68),p=r(16),y=u("".charAt),T=u("".charCodeAt),$=u("".slice),A=function(E){return function(R,I){var O=h(p(R)),C=d(I),D=O.length,M,F;return C<0||C>=D?E?"":void 0:(M=T(O,C),M<55296||M>56319||C+1===D||(F=T(O,C+1))<56320||F>57343?E?y(O,C):M:E?$(O,C,C+2):(M-55296<<10)+(F-56320)+65536)}};x.exports={codeAt:A(!1),charAt:A(!0)}},function(x,b,r){var u=r(3),d=r(85),h=r(5).f,p=r(64),y=r(68),T=r(450),$=r(16),A=r(451),E=r(36),R=d("".slice),I=Math.min,O=A("endsWith"),C=!E&&!O&&!!function(){var D=h(String.prototype,"endsWith");return D&&!D.writable}();u({target:"String",proto:!0,forced:!C&&!O},{endsWith:function(M){var F=y($(this));T(M);var z=arguments.length>1?arguments[1]:void 0,U=F.length,j=z===void 0?U:I(p(z),U),G=y(M);return R(F,j-G.length,j)===G}})},function(x,b,r){var u=r(407),d=TypeError;x.exports=function(h){if(u(h))throw new d("The method doesn't accept regular expressions");return h}},function(x,b,r){var u=r(33),d=u("match");x.exports=function(h){var p=/./;try{"/./"[h](p)}catch(y){try{return p[d]=!1,"/./"[h](p)}catch(T){}}return!1}},function(x,b,r){var u=r(3),d=r(14),h=r(60),p=RangeError,y=String.fromCharCode,T=String.fromCodePoint,$=d([].join),A=!!T&&T.length!==1;u({target:"String",stat:!0,arity:1,forced:A},{fromCodePoint:function(R){for(var I=[],O=arguments.length,C=0,D;O>C;){if(D=+arguments[C++],h(D,1114111)!==D)throw new p(D+" is not a valid code point");I[C]=D<65536?y(D):y(((D-=65536)>>10)+55296,D%1024+56320)}return $(I,"")}})},function(x,b,r){var u=r(3),d=r(14),h=r(450),p=r(16),y=r(68),T=r(451),$=d("".indexOf);u({target:"String",proto:!0,forced:!T("includes")},{includes:function(E){return!!~$(y(p(this)),y(h(E)),arguments.length>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(3),d=r(14),h=r(16),p=r(68),y=d("".charCodeAt);u({target:"String",proto:!0},{isWellFormed:function(){for(var $=p(h(this)),A=$.length,E=0;E=56320||++E>=A||(y($,E)&64512)!==56320))return!1}return!0}})},function(x,b,r){var u=r(448).charAt,d=r(68),h=r(51),p=r(169),y=r(172),T="String Iterator",$=h.set,A=h.getterFor(T);p(String,"String",function(E){$(this,{type:T,string:d(E),index:0})},function(){var R=A(this),I=R.string,O=R.index,C;return O>=I.length?y(void 0,!0):(C=u(I,O),R.index+=C.length,y(C,!1))})},function(x,b,r){var u=r(8),d=r(457),h=r(46),p=r(17),y=r(64),T=r(68),$=r(16),A=r(29),E=r(458),R=r(459);d("match",function(I,O,C){return[function(M){var F=$(this),z=p(M)?void 0:A(M,I);return z?u(z,M,F):new RegExp(M)[I](T(F))},function(D){var M=h(this),F=T(D),z=C(O,M,F);if(z.done)return z.value;if(!M.global)return R(M,F);var U=M.unicode;M.lastIndex=0;for(var j=[],G=0,B;(B=R(M,F))!==null;){var V=T(B[0]);j[G]=V,V===""&&(M.lastIndex=E(F,y(M.lastIndex),U)),G++}return G===0?null:j}]})},function(x,b,r){r(416);var u=r(8),d=r(47),h=r(417),p=r(7),y=r(33),T=r(43),$=y("species"),A=RegExp.prototype;x.exports=function(E,R,I,O){var C=y(E),D=!p(function(){var U={};return U[C]=function(){return 7},""[E](U)!==7}),M=D&&!p(function(){var U=!1,j=/a/;return E==="split"&&(j={},j.constructor={},j.constructor[$]=function(){return j},j.flags="",j[C]=/./[C]),j.exec=function(){return U=!0,null},j[C](""),!U});if(!D||!M||I){var F=/./[C],z=R(C,""[E],function(U,j,G,B,V){var Y=j.exec;return Y===h||Y===A.exec?D&&!V?{done:!0,value:u(F,j,G,B)}:{done:!0,value:u(U,G,j,B)}:{done:!1}});d(String.prototype,E,z[0]),d(A,C,z[1])}O&&T(A[C],"sham",!0)}},function(x,b,r){var u=r(448).charAt;x.exports=function(d,h,p){return h+(p?u(d,h).length:1)}},function(x,b,r){var u=r(8),d=r(46),h=r(21),p=r(15),y=r(417),T=TypeError;x.exports=function($,A){var E=$.exec;if(h(E)){var R=u(E,$,A);return R!==null&&d(R),R}if(p($)==="RegExp")return u(y,$,A);throw new T("RegExp#exec called on incompatible receiver")}},function(x,b,r){var u=r(3),d=r(8),h=r(85),p=r(170),y=r(172),T=r(16),$=r(64),A=r(68),E=r(46),R=r(17),I=r(15),O=r(407),C=r(408),D=r(29),M=r(47),F=r(7),z=r(33),U=r(364),j=r(458),G=r(459),B=r(51),V=r(36),Y=z("matchAll"),Z="RegExp String",J=Z+" Iterator",q=B.set,nt=B.getterFor(J),rt=RegExp.prototype,_=TypeError,tt=h("".indexOf),et=h("".matchAll),lt=!!et&&!F(function(){et("a",/./)}),mt=p(function(yt,Ut,Dt,Xt){q(this,{type:J,regexp:yt,string:Ut,global:Dt,unicode:Xt,done:!1})},Z,function(){var yt=nt(this);if(yt.done)return y(void 0,!0);var Ut=yt.regexp,Dt=yt.string,Xt=G(Ut,Dt);return Xt===null?(yt.done=!0,y(void 0,!0)):yt.global?(A(Xt[0])===""&&(Ut.lastIndex=j(Dt,$(Ut.lastIndex),yt.unicode)),y(Xt,!1)):(yt.done=!0,y(Xt,!1))}),gt=function(xt){var yt=E(this),Ut=A(xt),Dt=U(yt,RegExp),Xt=A(C(yt)),Qt,kt,me;return Qt=new Dt(Dt===RegExp?yt.source:yt,Xt),kt=!!~tt(Xt,"g"),me=!!~tt(Xt,"u"),Qt.lastIndex=$(yt.lastIndex),new mt(Qt,Ut,kt,me)};u({target:"String",proto:!0,forced:lt},{matchAll:function(yt){var Ut=T(this),Dt,Xt,Qt,kt;if(R(yt)){if(lt)return et(Ut,yt)}else{if(O(yt)&&(Dt=A(T(C(yt))),!~tt(Dt,"g")))throw new _("`.matchAll` does not allow non-global regexes");if(lt)return et(Ut,yt);if(Qt=D(yt,Y),Qt===void 0&&V&&I(yt)==="RegExp"&&(Qt=gt),Qt)return d(Qt,yt,Ut)}return Xt=A(Ut),kt=new RegExp(yt,"g"),V?d(gt,kt,Xt):kt[Y](Xt)}}),V||Y in rt||M(rt,Y,gt)},function(x,b,r){var u=r(3),d=r(243).end,h=r(462);u({target:"String",proto:!0,forced:h},{padEnd:function(y){return d(this,y,arguments.length>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(28);x.exports=/Version\/10(?:\.\d+){1,2}(?: [\w./]+)?(?: Mobile\/\w+)? Safari\//.test(u)},function(x,b,r){var u=r(3),d=r(243).start,h=r(462);u({target:"String",proto:!0,forced:h},{padStart:function(y){return d(this,y,arguments.length>1?arguments[1]:void 0)}})},function(x,b,r){var u=r(3),d=r(14),h=r(12),p=r(39),y=r(68),T=r(63),$=d([].push),A=d([].join);u({target:"String",stat:!0},{raw:function(R){var I=h(p(R).raw),O=T(I);if(!O)return"";for(var C=arguments.length,D=[],M=0;;){if($(D,y(I[M++])),M===O)return A(D,"");M")!=="7"});p("replace",function(_,tt,et){var lt=nt?"$":"$0";return[function(gt,xt){var yt=O(this),Ut=A(gt)?void 0:D(gt,U);return Ut?d(Ut,gt,yt,xt):d(tt,I(yt),gt,xt)},function(mt,gt){var xt=T(this),yt=I(mt);if(typeof gt=="string"&&Y(gt,lt)===-1&&Y(gt,"$<")===-1){var Ut=et(tt,xt,yt,gt);if(Ut.done)return Ut.value}var Dt=$(gt);Dt||(gt=I(gt));var Xt=xt.global,Qt;Xt&&(Qt=xt.unicode,xt.lastIndex=0);for(var kt=[],me;me=F(xt,yt),!(me===null||(V(kt,me),!Xt));){var ge=I(me[0]);ge===""&&(xt.lastIndex=C(yt,R(xt.lastIndex),Qt))}for(var ae="",Mt=0,Ht=0;Ht=Mt&&(ae+=Z(yt,Mt,se)+fe,Mt=se+re.length)}return ae+Z(yt,Mt)}]},!rt||!q||nt)},function(x,b,r){var u=r(14),d=r(39),h=Math.floor,p=u("".charAt),y=u("".replace),T=u("".slice),$=/\$([$&'`]|\d{1,2}|<[^>]*>)/g,A=/\$([$&'`]|\d{1,2})/g;x.exports=function(E,R,I,O,C,D){var M=I+E.length,F=O.length,z=A;return C!==void 0&&(C=d(C),z=$),y(D,z,function(U,j){var G;switch(p(j,0)){case"$":return"$";case"&":return E;case"`":return T(R,0,I);case"'":return T(R,M);case"<":G=C[T(j,1,-1)];break;default:var B=+j;if(B===0)return U;if(B>F){var V=h(B/10);return V===0?U:V<=F?O[V-1]===void 0?p(j,1):O[V-1]+p(j,1):U}G=O[B-1]}return G===void 0?"":G})}},function(x,b,r){var u=r(3),d=r(8),h=r(14),p=r(16),y=r(21),T=r(17),$=r(407),A=r(68),E=r(29),R=r(408),I=r(467),O=r(33),C=r(36),D=O("replace"),M=TypeError,F=h("".indexOf),z=h("".replace),U=h("".slice),j=Math.max;u({target:"String",proto:!0},{replaceAll:function(B,V){var Y=p(this),Z,J,q,nt,rt,_,tt,et,lt,mt,gt=0,xt="";if(!T(B)){if(Z=$(B),Z&&(J=A(p(R(B))),!~F(J,"g")))throw new M("`.replaceAll` does not allow non-global regexes");if(q=E(B,D),q)return d(q,B,Y,V);if(C&&Z)return z(A(Y),B,V)}for(nt=A(Y),rt=A(B),_=y(V),_||(V=A(V)),tt=rt.length,et=j(1,tt),lt=F(nt,rt);lt!==-1;)mt=_?A(V(rt,lt,nt)):I(rt,nt,lt,[],void 0,V),xt+=U(nt,gt,lt)+mt,gt=lt+tt,lt=lt+et>nt.length?-1:F(nt,rt,lt+et);return gt1||"".split(/.?/).length;h("split",function(V,Y,Z){var J="0".split(void 0,0).length?function(q,nt){return q===void 0&&nt===0?[]:u(Y,this,q,nt)}:Y;return[function(nt,rt){var _=T(this),tt=y(nt)?void 0:I(nt,V);return tt?u(tt,nt,_,rt):u(J,R(_),nt,rt)},function(q,nt){var rt=p(this),_=R(q);if(!B){var tt=Z(J,rt,_,nt,J!==Y);if(tt.done)return tt.value}var et=$(rt,RegExp),lt=rt.unicode,mt=(rt.ignoreCase?"i":"")+(rt.multiline?"m":"")+(rt.unicode?"u":"")+(M?"g":"y"),gt=new et(M?"^(?:"+rt.source+")":rt,mt),xt=nt===void 0?F:nt>>>0;if(xt===0)return[];if(_.length===0)return O(gt,_)===null?[_]:[];for(var yt=0,Ut=0,Dt=[];Ut<_.length;){gt.lastIndex=M?0:Ut;var Xt=O(gt,M?j(_,Ut):_),Qt;if(Xt===null||(Qt=z(E(gt.lastIndex+(M?Ut:0)),_.length))===yt)Ut=A(_,Ut,lt);else{if(U(Dt,j(_,yt,Ut)),Dt.length===xt)return Dt;for(var kt=1;kt<=Xt.length-1;kt++)if(U(Dt,Xt[kt]),Dt.length===xt)return Dt;Ut=yt=Qt}}return U(Dt,j(_,yt)),Dt}]},B||!G,M)},function(x,b,r){var u=r(3),d=r(85),h=r(5).f,p=r(64),y=r(68),T=r(450),$=r(16),A=r(451),E=r(36),R=d("".slice),I=Math.min,O=A("startsWith"),C=!E&&!O&&!!function(){var D=h(String.prototype,"startsWith");return D&&!D.writable}();u({target:"String",proto:!0,forced:!C&&!O},{startsWith:function(M){var F=y($(this));T(M);var z=p(I(arguments.length>1?arguments[1]:void 0,F.length)),U=y(M);return R(F,z,z+U.length)===U}})},function(x,b,r){var u=r(3),d=r(14),h=r(16),p=r(61),y=r(68),T=d("".slice),$=Math.max,A=Math.min,E=!"".substr||"ab".substr(-1)!=="b";u({target:"String",proto:!0,forced:E},{substr:function(I,O){var C=y(h(this)),D=C.length,M=p(I),F,z;return M===1/0&&(M=0),M<0&&(M=$(D+M,0)),F=O===void 0?D:p(O),F<=0||F===1/0?"":(z=A(M+F,D),M>=z?"":T(C,M,z))}})},function(x,b,r){var u=r(3),d=r(8),h=r(14),p=r(16),y=r(68),T=r(7),$=Array,A=h("".charAt),E=h("".charCodeAt),R=h([].join),I="".toWellFormed,O="\uFFFD",C=I&&T(function(){return d(I,1)!=="1"});u({target:"String",proto:!0,forced:C},{toWellFormed:function(){var M=y(p(this));if(C)return d(I,M);for(var F=M.length,z=$(F),U=0;U=56320||U+1>=F||(E(M,U+1)&64512)!==56320?z[U]=O:(z[U]=A(M,U),z[++U]=A(M,U))}return R(z,"")}})},function(x,b,r){var u=r(3),d=r(309).trim,h=r(475);u({target:"String",proto:!0,forced:h("trim")},{trim:function(){return d(this)}})},function(x,b,r){var u=r(49).PROPER,d=r(7),h=r(310),p="\u200B\x85\u180E";x.exports=function(y){return d(function(){return!!h[y]()||p[y]()!==p||u&&h[y].name!==y})}},function(x,b,r){r(477);var u=r(3),d=r(478);u({target:"String",proto:!0,name:"trimEnd",forced:"".trimEnd!==d},{trimEnd:d})},function(x,b,r){var u=r(3),d=r(478);u({target:"String",proto:!0,name:"trimEnd",forced:"".trimRight!==d},{trimRight:d})},function(x,b,r){var u=r(309).end,d=r(475);x.exports=d("trimEnd")?function(){return u(this)}:"".trimEnd},function(x,b,r){r(480);var u=r(3),d=r(481);u({target:"String",proto:!0,name:"trimStart",forced:"".trimStart!==d},{trimStart:d})},function(x,b,r){var u=r(3),d=r(481);u({target:"String",proto:!0,name:"trimStart",forced:"".trimLeft!==d},{trimLeft:d})},function(x,b,r){var u=r(309).start,d=r(475);x.exports=d("trimStart")?function(){return u(this)}:"".trimStart},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("anchor")},{anchor:function(y){return d(this,"a","name",y)}})},function(x,b,r){var u=r(14),d=r(16),h=r(68),p=/"/g,y=u("".replace);x.exports=function(T,$,A,E){var R=h(d(T)),I="<"+$;return A!==""&&(I+=" "+A+'="'+y(h(E),p,""")+'"'),I+">"+R+""}},function(x,b,r){var u=r(7);x.exports=function(d){return u(function(){var h=""[d]('"');return h!==h.toLowerCase()||h.split('"').length>3})}},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("big")},{big:function(){return d(this,"big","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("blink")},{blink:function(){return d(this,"blink","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("bold")},{bold:function(){return d(this,"b","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("fixed")},{fixed:function(){return d(this,"tt","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("fontcolor")},{fontcolor:function(y){return d(this,"font","color",y)}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("fontsize")},{fontsize:function(y){return d(this,"font","size",y)}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("italics")},{italics:function(){return d(this,"i","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("link")},{link:function(y){return d(this,"a","href",y)}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("small")},{small:function(){return d(this,"small","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("strike")},{strike:function(){return d(this,"strike","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("sub")},{sub:function(){return d(this,"sub","","")}})},function(x,b,r){var u=r(3),d=r(483),h=r(484);u({target:"String",proto:!0,forced:h("sup")},{sup:function(){return d(this,"sup","","")}})},function(x,b,r){var u=r(498);u("Float32",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(3),d=r(4),h=r(8),p=r(6),y=r(499),T=r(219),$=r(208),A=r(211),E=r(11),R=r(43),I=r(315),O=r(64),C=r(212),D=r(500),M=r(501),F=r(18),z=r(38),U=r(69),j=r(20),G=r(22),B=r(71),V=r(24),Y=r(113),Z=r(57).f,J=r(502),q=r(83).forEach,nt=r(194),rt=r(77),_=r(44),tt=r(5),et=r(199),lt=r(51),mt=r(118),gt=lt.get,xt=lt.set,yt=lt.enforce,Ut=_.f,Dt=tt.f,Xt=d.RangeError,Qt=$.ArrayBuffer,kt=Qt.prototype,me=$.DataView,ge=T.NATIVE_ARRAY_BUFFER_VIEWS,ae=T.TYPED_ARRAY_TAG,Mt=T.TypedArray,Ht=T.TypedArrayPrototype,re=T.isTypedArray,se="BYTES_PER_ELEMENT",ee="Wrong length",fe=function(Ae,Te){rt(Ae,Te,{configurable:!0,get:function(){return gt(this)[Te]}})},Pe=function(Ae){var Te;return V(kt,Ae)||(Te=U(Ae))==="ArrayBuffer"||Te==="SharedArrayBuffer"},Me=function(Ae,Te){return re(Ae)&&!G(Te)&&Te in Ae&&I(+Te)&&Te>=0},$e=function(Te,de){return de=F(de),Me(Te,de)?E(2,Te[de]):Dt(Te,de)},ce=function(Te,de,bt){return de=F(de),Me(Te,de)&&j(bt)&&z(bt,"value")&&!z(bt,"get")&&!z(bt,"set")&&!bt.configurable&&(!z(bt,"writable")||bt.writable)&&(!z(bt,"enumerable")||bt.enumerable)?(Te[de]=bt.value,Te):Ut(Te,de,bt)};p?(ge||(tt.f=$e,_.f=ce,fe(Ht,"buffer"),fe(Ht,"byteOffset"),fe(Ht,"byteLength"),fe(Ht,"length")),u({target:"Object",stat:!0,forced:!ge},{getOwnPropertyDescriptor:$e,defineProperty:ce}),x.exports=function(Ae,Te,de){var bt=Ae.match(/\d+/)[0]/8,Ft=Ae+(de?"Clamped":"")+"Array",Tt="get"+Ae,qt="set"+Ae,te=d[Ft],Zt=te,Yt=Zt&&Zt.prototype,Ye={},Ze=function(Ct,Nt){var Et=gt(Ct);return Et.view[Tt](Nt*bt+Et.byteOffset,!0)},ut=function(Ct,Nt,Et){var ie=gt(Ct);ie.view[qt](Nt*bt+ie.byteOffset,de?M(Et):Et,!0)},It=function(Ct,Nt){Ut(Ct,Nt,{get:function(){return Ze(this,Nt)},set:function(Et){return ut(this,Nt,Et)},enumerable:!0})};ge?y&&(Zt=Te(function(Ct,Nt,Et,ie){return A(Ct,Yt),mt(function(){return j(Nt)?Pe(Nt)?ie!==void 0?new te(Nt,D(Et,bt),ie):Et!==void 0?new te(Nt,D(Et,bt)):new te(Nt):re(Nt)?et(Zt,Nt):h(J,Zt,Nt):new te(C(Nt))}(),Ct,Zt)}),Y&&Y(Zt,Mt),q(Z(te),function(Ct){Ct in Zt||R(Zt,Ct,te[Ct])}),Zt.prototype=Yt):(Zt=Te(function(Ct,Nt,Et,ie){A(Ct,Yt);var we=0,Rt=0,zt,jt,Wt;if(!j(Nt))Wt=C(Nt),jt=Wt*bt,zt=new Qt(jt);else if(Pe(Nt)){zt=Nt,Rt=D(Et,bt);var ue=Nt.byteLength;if(ie===void 0){if(ue%bt)throw new Xt(ee);if(jt=ue-Rt,jt<0)throw new Xt(ee)}else if(jt=O(ie)*bt,jt+Rt>ue)throw new Xt(ee);Wt=jt/bt}else return re(Nt)?et(Zt,Nt):h(J,Zt,Nt);for(xt(Ct,{buffer:zt,byteOffset:Rt,byteLength:jt,length:Wt,view:new me(zt)});we255?255:u&255}},function(x,b,r){var u=r(84),d=r(8),h=r(365),p=r(39),y=r(63),T=r(133),$=r(134),A=r(131),E=r(503),R=r(219).aTypedArrayConstructor,I=r(504);x.exports=function(C){var D=h(this),M=p(C),F=arguments.length,z=F>1?arguments[1]:void 0,U=z!==void 0,j=$(M),G,B,V,Y,Z,J,q,nt;if(j&&!A(j))for(q=T(M,j),nt=q.next,M=[];!(J=d(nt,q)).done;)M.push(J.value);for(U&&F>2&&(z=u(z,arguments[2])),B=y(M),V=new(R(D))(B),Y=E(V),G=0;B>G;G++)Z=U?z(M[G],G):M[G],V[G]=Y?I(Z):+Z;return V}},function(x,b,r){var u=r(69);x.exports=function(d){var h=u(d);return h==="BigInt64Array"||h==="BigUint64Array"}},function(x,b,r){var u=r(19),d=TypeError;x.exports=function(h){var p=u(h,"number");if(typeof p=="number")throw new d("Can't convert number to bigint");return BigInt(p)}},function(x,b,r){var u=r(498);u("Float64",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(498);u("Int8",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(498);u("Int16",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(498);u("Int32",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(498);u("Uint8",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(498);u("Uint8",function(d){return function(p,y,T){return d(this,p,y,T)}},!0)},function(x,b,r){var u=r(498);u("Uint16",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(498);u("Uint32",function(d){return function(p,y,T){return d(this,p,y,T)}})},function(x,b,r){var u=r(219),d=r(63),h=r(61),p=u.aTypedArray,y=u.exportTypedArrayMethod;y("at",function($){var A=p(this),E=d(A),R=h($),I=R>=0?R:E+R;return I<0||I>=E?void 0:A[I]})},function(x,b,r){var u=r(14),d=r(219),h=r(144),p=u(h),y=d.aTypedArray,T=d.exportTypedArrayMethod;T("copyWithin",function(A,E){return p(y(this),A,E,arguments.length>2?arguments[2]:void 0)})},function(x,b,r){var u=r(219),d=r(83).every,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("every",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=r(149),h=r(504),p=r(69),y=r(8),T=r(14),$=r(7),A=u.aTypedArray,E=u.exportTypedArrayMethod,R=T("".slice),I=$(function(){var O=0;return new Int8Array(2).fill({valueOf:function(){return O++}}),O!==1});E("fill",function(C){var D=arguments.length;A(this);var M=R(p(this),0,3)==="Big"?h(C):+C;return y(d,this,M,D>1?arguments[1]:void 0,D>2?arguments[2]:void 0)},I)},function(x,b,r){var u=r(219),d=r(83).filter,h=r(518),p=u.aTypedArray,y=u.exportTypedArrayMethod;y("filter",function($){var A=d(p(this),$,arguments.length>1?arguments[1]:void 0);return h(this,A)})},function(x,b,r){var u=r(199),d=r(219).getTypedArrayConstructor;x.exports=function(h,p){return u(d(h),p)}},function(x,b,r){var u=r(219),d=r(83).find,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("find",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=r(83).findIndex,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("findIndex",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=r(154).findLast,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("findLast",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=r(154).findLastIndex,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("findLastIndex",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=r(83).forEach,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("forEach",function(T){d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(499),d=r(219).exportTypedArrayStaticMethod,h=r(502);d("from",h,u)},function(x,b,r){var u=r(219),d=r(59).includes,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("includes",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=r(59).indexOf,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("indexOf",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(4),d=r(7),h=r(14),p=r(219),y=r(168),T=r(33),$=T("iterator"),A=u.Uint8Array,E=h(y.values),R=h(y.keys),I=h(y.entries),O=p.aTypedArray,C=p.exportTypedArrayMethod,D=A&&A.prototype,M=!d(function(){D[$].call([1])}),F=!!D&&D.values&&D[$]===D.values&&D.values.name==="values",z=function(){return E(O(this))};C("entries",function(){return I(O(this))},M),C("keys",function(){return R(O(this))},M),C("values",z,M||!F,{name:"values"}),C($,z,M||!F,{name:"values"})},function(x,b,r){var u=r(219),d=r(14),h=u.aTypedArray,p=u.exportTypedArrayMethod,y=d([].join);p("join",function($){return y(h(this),$)})},function(x,b,r){var u=r(219),d=r(94),h=r(175),p=u.aTypedArray,y=u.exportTypedArrayMethod;y("lastIndexOf",function($){var A=arguments.length;return d(h,p(this),A>1?[$,arguments[1]]:[$])})},function(x,b,r){var u=r(219),d=r(83).map,h=u.aTypedArray,p=u.getTypedArrayConstructor,y=u.exportTypedArrayMethod;y("map",function($){return d(h(this),$,arguments.length>1?arguments[1]:void 0,function(A,E){return new(p(A))(E)})})},function(x,b,r){var u=r(219),d=r(499),h=u.aTypedArrayConstructor,p=u.exportTypedArrayStaticMethod;p("of",function(){for(var T=0,$=arguments.length,A=new(h(this))($);$>T;)A[T]=arguments[T++];return A},d)},function(x,b,r){var u=r(219),d=r(181).left,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("reduce",function(T){var $=arguments.length;return d(h(this),T,$,$>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=r(181).right,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("reduceRight",function(T){var $=arguments.length;return d(h(this),T,$,$>1?arguments[1]:void 0)})},function(x,b,r){var u=r(219),d=u.aTypedArray,h=u.exportTypedArrayMethod,p=Math.floor;h("reverse",function(){for(var T=this,$=d(T).length,A=p($/2),E=0,R;E1?arguments[1]:void 0,1),j=T(z);if(D)return d(I,this,j,U);var G=this.length,B=p(j),V=0;if(B+U>G)throw new A("Wrong length");for(;VC;)M[C]=I[C++];return M},$)},function(x,b,r){var u=r(219),d=r(83).some,h=u.aTypedArray,p=u.exportTypedArrayMethod;p("some",function(T){return d(h(this),T,arguments.length>1?arguments[1]:void 0)})},function(x,b,r){var u=r(4),d=r(85),h=r(7),p=r(30),y=r(189),T=r(219),$=r(190),A=r(191),E=r(27),R=r(192),I=T.aTypedArray,O=T.exportTypedArrayMethod,C=u.Uint16Array,D=C&&d(C.prototype.sort),M=!!D&&!(h(function(){D(new C(2),null)})&&h(function(){D(new C(2),{})})),F=!!D&&!h(function(){if(E)return E<74;if($)return $<67;if(A)return!0;if(R)return R<602;var U=new C(516),j=Array(516),G,B;for(G=0;G<516;G++)B=G%4,U[G]=515-G,j[G]=G-2*B+3;for(D(U,function(V,Y){return(V/4|0)-(Y/4|0)}),G=0;G<516;G++)if(U[G]!==j[G])return!0}),z=function(U){return function(j,G){return U!==void 0?+U(j,G)||0:G!==G?-1:j!==j?1:j===0&&G===0?1/j>0&&1/G<0?1:-1:j>G}};O("sort",function(j){return j!==void 0&&p(j),F?D(this,j):y(I(this),z(j))},!F||M)},function(x,b,r){var u=r(219),d=r(64),h=r(60),p=u.aTypedArray,y=u.getTypedArrayConstructor,T=u.exportTypedArrayMethod;T("subarray",function(A,E){var R=p(this),I=R.length,O=h(A,I),C=y(R);return new C(R.buffer,R.byteOffset+O*R.BYTES_PER_ELEMENT,d((E===void 0?I:h(E,I))-O))})},function(x,b,r){var u=r(4),d=r(94),h=r(219),p=r(7),y=r(76),T=u.Int8Array,$=h.aTypedArray,A=h.exportTypedArrayMethod,E=[].toLocaleString,R=!!T&&p(function(){E.call(new T(1))}),I=p(function(){return[1,2].toLocaleString()!==new T([1,2]).toLocaleString()})||!p(function(){T.prototype.toLocaleString.call([1,2])});A("toLocaleString",function(){return d(E,R?y($(this)):$(this),y(arguments))},I)},function(x,b,r){var u=r(197),d=r(219),h=d.aTypedArray,p=d.exportTypedArrayMethod,y=d.getTypedArrayConstructor;p("toReversed",function(){return u(h(this),y(this))})},function(x,b,r){var u=r(219),d=r(14),h=r(30),p=r(199),y=u.aTypedArray,T=u.getTypedArrayConstructor,$=u.exportTypedArrayMethod,A=d(u.TypedArrayPrototype.sort);$("toSorted",function(R){R!==void 0&&h(R);var I=y(this),O=p(T(I),I);return A(O,R)})},function(x,b,r){var u=r(219).exportTypedArrayMethod,d=r(7),h=r(4),p=r(14),y=h.Uint8Array,T=y&&y.prototype||{},$=[].toString,A=p([].join);d(function(){$.call({})})&&($=function(){return A(this)});var E=T.toString!==$;u("toString",$,E)},function(x,b,r){var u=r(206),d=r(219),h=r(503),p=r(61),y=r(504),T=d.aTypedArray,$=d.getTypedArrayConstructor,A=d.exportTypedArrayMethod,E=!!function(){try{new Int8Array(1).with(2,{valueOf:function(){throw 8}})}catch(R){return R===8}}();A("with",function(R,I){var O=T(this),C=p(R),D=h(O)?y(I):+I;return u(O,$(O),C,D)},!E)},function(x,b,r){var u=r(3),d=r(14),h=r(68),p=String.fromCharCode,y=d("".charAt),T=d(/./.exec),$=d("".slice),A=/^[\da-f]{2}$/i,E=/^[\da-f]{4}$/i;u({global:!0},{unescape:function(I){for(var O=h(I),C="",D=O.length,M=0,F,z;M>(-2*_&6)));return nt}})},function(x){var b="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789",r=b+"+/",u=b+"-_",d=function(h){for(var p={},y=0;y<64;y++)p[h.charAt(y)]=y;return p};x.exports={i2c:r,c2i:d(r),i2cUrl:u,c2iUrl:d(u)}},function(x,b,r){var u=r(3),d=r(4),h=r(23),p=r(14),y=r(8),T=r(7),$=r(68),A=r(367),E=r(552).i2c,R=h("btoa"),I=p("".charAt),O=p("".charCodeAt),C=!!R&&!T(function(){return R("hi")!=="aGk="}),D=C&&!T(function(){R()}),M=C&&T(function(){return R(null)!=="bnVsbA=="}),F=C&&R.length!==1;u({global:!0,bind:!0,enumerable:!0,forced:!C||D||M||F},{btoa:function(U){if(A(arguments.length,1),C)return y(R,d,$(U));for(var j=$(U),G="",B=0,V=E,Y,Z;I(j,B)||(V="=",B%1);){if(Z=O(j,B+=.75),Z>255)throw new(h("DOMException"))("The string contains characters outside of the Latin1 range","InvalidCharacterError");Y=Y<<8|Z,G+=I(V,63&Y>>8-B%1*8)}return G}})},function(x,b,r){var u=r(4),d=r(555),h=r(556),p=r(160),y=r(43),T=function(A){if(A&&A.forEach!==p)try{y(A,"forEach",p)}catch(E){A.forEach=p}};for(var $ in d)d[$]&&T(u[$]&&u[$].prototype);T(h)},function(x){x.exports={CSSRuleList:0,CSSStyleDeclaration:0,CSSValueList:0,ClientRectList:0,DOMRectList:0,DOMStringList:0,DOMTokenList:1,DataTransferItemList:0,FileList:0,HTMLAllCollection:0,HTMLCollection:0,HTMLFormElement:0,HTMLSelectElement:0,MediaList:0,MimeTypeArray:0,NamedNodeMap:0,NodeList:1,PaintRequestList:0,Plugin:0,PluginArray:0,SVGLengthList:0,SVGNumberList:0,SVGPathSegList:0,SVGPointList:0,SVGStringList:0,SVGTransformList:0,SourceBufferList:0,StyleSheetList:0,TextTrackCueList:0,TextTrackList:0,TouchList:0}},function(x,b,r){var u=r(42),d=u("span").classList,h=d&&d.constructor&&d.constructor.prototype;x.exports=h===Object.prototype?void 0:h},function(x,b,r){var u=r(4),d=r(555),h=r(556),p=r(168),y=r(43),T=r(82),$=r(33),A=$("iterator"),E=p.values,R=function(O,C){if(O){if(O[A]!==E)try{y(O,A,E)}catch(M){O[A]=E}if(T(O,C,!0),d[C]){for(var D in p)if(O[D]!==p[D])try{y(O,D,p[D])}catch(M){O[D]=p[D]}}}};for(var I in d)R(u[I]&&u[I].prototype,I);R(h,"DOMTokenList")},function(x,b,r){var u=r(3),d=r(23),h=r(234),p=r(7),y=r(71),T=r(11),$=r(44).f,A=r(47),E=r(77),R=r(38),I=r(211),O=r(46),C=r(125),D=r(119),M=r(559),F=r(122),z=r(51),U=r(6),j=r(36),G="DOMException",B="DATA_CLONE_ERR",V=d("Error"),Y=d(G)||function(){try{var Mt=d("MessageChannel")||h("worker_threads").MessageChannel;new Mt().port1.postMessage(new WeakMap)}catch(Ht){if(Ht.name===B&&Ht.code===25)return Ht.constructor}}(),Z=Y&&Y.prototype,J=V.prototype,q=z.set,nt=z.getterFor(G),rt="stack"in new V(G),_=function(Mt){return R(M,Mt)&&M[Mt].m?M[Mt].c:0},tt=function(){I(this,et);var Ht=arguments.length,re=D(Ht<1?void 0:arguments[0]),se=D(Ht<2?void 0:arguments[1],"Error"),ee=_(se);if(q(this,{type:G,name:se,message:re,code:ee}),U||(this.name=se,this.message=re,this.code=ee),rt){var fe=new V(re);fe.name=G,$(this,"stack",T(1,F(fe.stack,1)))}},et=tt.prototype=y(J),lt=function(Mt){return{enumerable:!0,configurable:!0,get:Mt}},mt=function(Mt){return lt(function(){return nt(this)[Mt]})};U&&(E(et,"code",mt("code")),E(et,"message",mt("message")),E(et,"name",mt("name"))),$(et,"constructor",T(1,tt));var gt=p(function(){return!(new Y instanceof V)}),xt=gt||p(function(){return J.toString!==C||String(new Y(1,2))!=="2: 1"}),yt=gt||p(function(){return new Y(1,"DataCloneError").code!==25}),Ut=gt||Y[B]!==25||Z[B]!==25,Dt=j?xt||yt||Ut:gt;u({global:!0,constructor:!0,forced:Dt},{DOMException:Dt?tt:Y});var Xt=d(G),Qt=Xt.prototype;xt&&(j||Y===Xt)&&A(Qt,"toString",C),yt&&U&&Y===Xt&&E(Qt,"code",lt(function(){return _(O(this).name)}));for(var kt in M)if(R(M,kt)){var me=M[kt],ge=me.s,ae=T(6,me.c);R(Xt,ge)||$(Xt,ge,ae),R(Qt,ge)||$(Qt,ge,ae)}},function(x){x.exports={IndexSizeError:{s:"INDEX_SIZE_ERR",c:1,m:1},DOMStringSizeError:{s:"DOMSTRING_SIZE_ERR",c:2,m:0},HierarchyRequestError:{s:"HIERARCHY_REQUEST_ERR",c:3,m:1},WrongDocumentError:{s:"WRONG_DOCUMENT_ERR",c:4,m:1},InvalidCharacterError:{s:"INVALID_CHARACTER_ERR",c:5,m:1},NoDataAllowedError:{s:"NO_DATA_ALLOWED_ERR",c:6,m:0},NoModificationAllowedError:{s:"NO_MODIFICATION_ALLOWED_ERR",c:7,m:1},NotFoundError:{s:"NOT_FOUND_ERR",c:8,m:1},NotSupportedError:{s:"NOT_SUPPORTED_ERR",c:9,m:1},InUseAttributeError:{s:"INUSE_ATTRIBUTE_ERR",c:10,m:1},InvalidStateError:{s:"INVALID_STATE_ERR",c:11,m:1},SyntaxError:{s:"SYNTAX_ERR",c:12,m:1},InvalidModificationError:{s:"INVALID_MODIFICATION_ERR",c:13,m:1},NamespaceError:{s:"NAMESPACE_ERR",c:14,m:1},InvalidAccessError:{s:"INVALID_ACCESS_ERR",c:15,m:1},ValidationError:{s:"VALIDATION_ERR",c:16,m:0},TypeMismatchError:{s:"TYPE_MISMATCH_ERR",c:17,m:1},SecurityError:{s:"SECURITY_ERR",c:18,m:1},NetworkError:{s:"NETWORK_ERR",c:19,m:1},AbortError:{s:"ABORT_ERR",c:20,m:1},URLMismatchError:{s:"URL_MISMATCH_ERR",c:21,m:1},QuotaExceededError:{s:"QUOTA_EXCEEDED_ERR",c:22,m:1},TimeoutError:{s:"TIMEOUT_ERR",c:23,m:1},InvalidNodeTypeError:{s:"INVALID_NODE_TYPE_ERR",c:24,m:1},DataCloneError:{s:"DATA_CLONE_ERR",c:25,m:1}}},function(x,b,r){var u=r(3),d=r(4),h=r(23),p=r(11),y=r(44).f,T=r(38),$=r(211),A=r(118),E=r(119),R=r(559),I=r(122),O=r(6),C=r(36),D="DOMException",M=h("Error"),F=h(D),z=function(){$(this,U);var tt=arguments.length,et=E(tt<1?void 0:arguments[0]),lt=E(tt<2?void 0:arguments[1],"Error"),mt=new F(et,lt),gt=new M(et);return gt.name=D,y(mt,"stack",p(1,I(gt.stack,1))),A(mt,this,z),mt},U=z.prototype=F.prototype,j="stack"in new M(D),G="stack"in new F(1,2),B=F&&O&&Object.getOwnPropertyDescriptor(d,D),V=!!B&&!(B.writable&&B.configurable),Y=j&&!V&&!G;u({global:!0,constructor:!0,forced:C||Y},{DOMException:Y?z:F});var Z=h(D),J=Z.prototype;if(J.constructor!==Z){C||y(J,"constructor",p(1,Z));for(var q in R)if(T(R,q)){var nt=R[q],rt=nt.s;T(Z,rt)||y(Z,rt,p(6,nt.c))}}},function(x,b,r){var u=r(23),d=r(82),h="DOMException";d(u(h),h)},function(x,b,r){r(563),r(564)},function(x,b,r){var u=r(3),d=r(4),h=r(366).clear;u({global:!0,bind:!0,enumerable:!0,forced:d.clearImmediate!==h},{clearImmediate:h})},function(x,b,r){var u=r(3),d=r(4),h=r(366).set,p=r(565),y=d.setImmediate?p(h,!1):h;u({global:!0,bind:!0,enumerable:!0,forced:d.setImmediate!==y},{setImmediate:y})},function(x,b,r){var u=r(4),d=r(94),h=r(21),p=r(183),y=r(28),T=r(76),$=r(367),A=u.Function,E=/MSIE .\./.test(y)||p==="BUN"&&function(){var R=u.Bun.version.split(".");return R.length<3||R[0]==="0"&&(R[1]<3||R[1]==="3"&&R[2]==="0")}();x.exports=function(R,I){var O=I?2:1;return E?function(C,D){var M=$(arguments.length,1)>O,F=h(C)?C:A(C),z=M?T(arguments,O):[],U=M?function(){d(F,this,z)}:F;return I?R(U,D):R(U)}:R}},function(x,b,r){var u=r(3),d=r(4),h=r(369),p=r(30),y=r(367),T=r(7),$=r(6),A=T(function(){return $&&Object.getOwnPropertyDescriptor(d,"queueMicrotask").value.length!==1});u({global:!0,enumerable:!0,dontCallGetSet:!0,forced:A},{queueMicrotask:function(R){y(arguments.length,1),h(p(R))}})},function(x,b,r){var u=r(3),d=r(4),h=r(77),p=r(6),y=TypeError,T=Object.defineProperty,$=d.self!==d;try{if(p){var A=Object.getOwnPropertyDescriptor(d,"self");($||!A||!A.get||!A.enumerable)&&h(d,"self",{get:function(){return d},set:function(R){if(this!==d)throw new y("Illegal invocation");T(d,"self",{value:R,writable:!0,configurable:!0,enumerable:!0})},configurable:!0,enumerable:!0})}else u({global:!0,simple:!0,forced:$},{self:d})}catch(E){}},function(x,b,r){var u=r(36),d=r(3),h=r(4),p=r(23),y=r(14),T=r(7),$=r(40),A=r(21),E=r(89),R=r(17),I=r(20),O=r(22),C=r(130),D=r(46),M=r(69),F=r(38),z=r(141),U=r(43),j=r(63),G=r(367),B=r(408),V=r(284),Y=r(427),Z=r(429),J=r(233),q=r(123),nt=r(235),rt=h.Object,_=h.Array,tt=h.Date,et=h.Error,lt=h.TypeError,mt=h.PerformanceMark,gt=p("DOMException"),xt=V.Map,yt=V.has,Ut=V.get,Dt=V.set,Xt=Y.Set,Qt=Y.add,kt=Y.has,me=p("Object","keys"),ge=y([].push),ae=y((!0).valueOf),Mt=y(1 .valueOf),Ht=y("".valueOf),re=y(tt.prototype.getTime),se=$("structuredClone"),ee="DataCloneError",fe="Transferring",Pe=function(ut){return!T(function(){var It=new h.Set([7]),Pt=ut(It),Ct=ut(rt(7));return Pt===It||!Pt.has(7)||!I(Ct)||+Ct!=7})&&ut},Me=function(ut,It){return!T(function(){var Pt=new It,Ct=ut({a:Pt,b:Pt});return!(Ct&&Ct.a===Ct.b&&Ct.a instanceof It&&Ct.a.stack===Pt.stack)})},$e=function(ut){return!T(function(){var It=ut(new h.AggregateError([1],se,{cause:3}));return It.name!=="AggregateError"||It.errors[0]!==1||It.message!==se||It.cause!==3})},ce=h.structuredClone,Ae=u||!Me(ce,et)||!Me(ce,gt)||!$e(ce),Te=!ce&&Pe(function(ut){return new mt(se,{detail:ut}).detail}),de=Pe(ce)||Te,bt=function(ut){throw new gt("Uncloneable type: "+ut,ee)},Ft=function(ut,It){throw new gt((It||"Cloning")+" of "+ut+" cannot be properly polyfilled in this engine",ee)},Tt=function(ut,It){return de||Ft(It),de(ut)},qt=function(){var ut;try{ut=new h.DataTransfer}catch(It){try{ut=new h.ClipboardEvent("").clipboardData}catch(Pt){}}return ut&&ut.items&&ut.files?ut:null},te=function(ut,It,Pt){if(yt(It,ut))return Ut(It,ut);var Ct=Pt||M(ut),Nt,Et,ie,we,Rt,zt;if(Ct==="SharedArrayBuffer")de?Nt=de(ut):Nt=ut;else{var jt=h.DataView;!jt&&!A(ut.slice)&&Ft("ArrayBuffer");try{if(A(ut.slice)&&!ut.resizable)Nt=ut.slice(0);else for(Et=ut.byteLength,ie=("maxByteLength"in ut)?{maxByteLength:ut.maxByteLength}:void 0,Nt=new ArrayBuffer(Et,ie),we=new jt(ut),Rt=new jt(Nt),zt=0;zt1&&!R(arguments[1])?D(arguments[1]):void 0,Ct=Pt?Pt.transfer:void 0,Nt,Et;Ct!==void 0&&(Nt=new xt,Et=Ye(Ct,Nt));var ie=Yt(It,Nt);return Et&&Ze(Et),ie}})},function(x,b,r){r(570),r(571)},function(x,b,r){var u=r(3),d=r(4),h=r(565),p=h(d.setInterval,!0);u({global:!0,bind:!0,forced:d.setInterval!==p},{setInterval:p})},function(x,b,r){var u=r(3),d=r(4),h=r(565),p=h(d.setTimeout,!0);u({global:!0,bind:!0,forced:d.setTimeout!==p},{setTimeout:p})},function(x,b,r){r(573)},function(x,b,r){r(455);var u=r(3),d=r(6),h=r(574),p=r(4),y=r(84),T=r(14),$=r(47),A=r(77),E=r(211),R=r(38),I=r(328),O=r(162),C=r(76),D=r(448).codeAt,M=r(575),F=r(68),z=r(82),U=r(367),j=r(576),G=r(51),B=G.set,V=G.getterFor("URL"),Y=j.URLSearchParams,Z=j.getState,J=p.URL,q=p.TypeError,nt=p.parseInt,rt=Math.floor,_=Math.pow,tt=T("".charAt),et=T(/./.exec),lt=T([].join),mt=T(1 .toString),gt=T([].pop),xt=T([].push),yt=T("".replace),Ut=T([].shift),Dt=T("".split),Xt=T("".slice),Qt=T("".toLowerCase),kt=T([].unshift),me="Invalid authority",ge="Invalid scheme",ae="Invalid host",Mt="Invalid port",Ht=/[a-z]/i,re=/[\d+-.a-z]/i,se=/\d/,ee=/^0x/i,fe=/^[0-7]+$/,Pe=/^\d+$/,Me=/^[\da-f]+$/i,$e=/[\0\t\n\r #%/:<>?@[\\\]^|]/,ce=/[\0\t\n\r #/:<>?@[\\\]^|]/,Ae=/^[\u0000-\u0020]+/,Te=/(^|[^\u0000-\u0020])[\u0000-\u0020]+$/,de=/[\t\n\r]/g,bt,Ft=function(ft){var wt=Dt(ft,"."),pt,it,Ot,ye,_t,Ie,rn;if(wt.length&&wt[wt.length-1]===""&&wt.length--,pt=wt.length,pt>4)return ft;for(it=[],Ot=0;Ot1&&tt(ye,0)==="0"&&(_t=et(ee,ye)?16:8,ye=Xt(ye,_t===8?1:2)),ye==="")Ie=0;else{if(!et(_t===10?Pe:_t===8?fe:Me,ye))return ft;Ie=nt(ye,_t)}xt(it,Ie)}for(Ot=0;Ot=_(256,5-pt))return null}else if(Ie>255)return null;for(rn=gt(it),Ot=0;Ot6))return;for(Ie=0;an();){if(rn=null,Ie>0)if(an()==="."&&Ie<4)Ot++;else return;if(!et(se,an()))return;for(;et(se,an());){if(hn=nt(an(),10),rn===null)rn=hn;else{if(rn===0)return;rn=rn*10+hn}if(rn>255)return;Ot++}wt[pt]=wt[pt]*256+rn,Ie++,(Ie===2||Ie===4)&&pt++}if(Ie!==4)return;break}else if(an()===":"){if(Ot++,!an())return}else if(an())return;wt[pt++]=ye}if(it!==null)for(pn=pt-it,pt=7;pt!==0&&pn>0;)ot=wt[pt],wt[pt--]=wt[it+pn-1],wt[it+--pn]=ot;else if(pt!==8)return;return wt},qt=function(ft){for(var wt=null,pt=1,it=null,Ot=0,ye=0;ye<8;ye++)ft[ye]!==0?(Ot>pt&&(wt=it,pt=Ot),it=null,Ot=0):(it===null&&(it=ye),++Ot);return Ot>pt?it:wt},te=function(ft){var wt,pt,it,Ot;if(typeof ft=="number"){for(wt=[],pt=0;pt<4;pt++)kt(wt,ft%256),ft=rt(ft/256);return lt(wt,".")}if(typeof ft=="object"){for(wt="",it=qt(ft),pt=0;pt<8;pt++)Ot&&ft[pt]===0||(Ot&&(Ot=!1),it===pt?(wt+=pt?":":"::",Ot=!0):(wt+=mt(ft[pt],16),pt<7&&(wt+=":")));return"["+wt+"]"}return ft},Zt={},Yt=I({},Zt,{" ":1,'"':1,"<":1,">":1,"`":1}),Ye=I({},Yt,{"#":1,"?":1,"{":1,"}":1}),Ze=I({},Ye,{"/":1,":":1,";":1,"=":1,"@":1,"[":1,"\\":1,"]":1,"^":1,"|":1}),ut=function(ft,wt){var pt=D(ft,0);return pt>32&&pt<127&&!R(wt,ft)?ft:encodeURIComponent(ft)},It={ftp:21,file:null,http:80,https:443,ws:80,wss:443},Pt=function(ft,wt){var pt;return ft.length===2&&et(Ht,tt(ft,0))&&((pt=tt(ft,1))===":"||!wt&&pt==="|")},Ct=function(ft){var wt;return ft.length>1&&Pt(Xt(ft,0,2))&&(ft.length===2||(wt=tt(ft,2))==="/"||wt==="\\"||wt==="?"||wt==="#")},Nt=function(ft){return ft==="."||Qt(ft)==="%2e"},Et=function(ft){return ft=Qt(ft),ft===".."||ft==="%2e."||ft===".%2e"||ft==="%2e%2e"},ie={},we={},Rt={},zt={},jt={},Wt={},ue={},Ee={},Xe={},Je={},nn={},vn={},jn={},Hr={},Ya={},ga={},yr={},Vn={},Wa={},ir={},Wn={},va=function(ft,wt,pt){var it=F(ft),Ot,ye,_t;if(wt){if(ye=this.parse(it),ye)throw new q(ye);this.searchParams=null}else{if(pt!==void 0&&(Ot=new va(pt,!0)),ye=this.parse(it,null,Ot),ye)throw new q(ye);_t=Z(new Y),_t.bindURL(this),this.searchParams=_t}};va.prototype={type:"URL",parse:function(ft,wt,pt){var it=this,Ot=wt||ie,ye=0,_t="",Ie=!1,rn=!1,hn=!1,pn,ot,an,Fn;for(ft=F(ft),wt||(it.scheme="",it.username="",it.password="",it.host=null,it.port=null,it.path=[],it.query=null,it.fragment=null,it.cannotBeABaseURL=!1,ft=yt(ft,Ae,""),ft=yt(ft,Te,"$1")),ft=yt(ft,de,""),pn=O(ft);ye<=pn.length;){switch(ot=pn[ye],Ot){case ie:if(ot&&et(Ht,ot))_t+=Qt(ot),Ot=we;else{if(wt)return ge;Ot=Rt;continue}break;case we:if(ot&&(et(re,ot)||ot==="+"||ot==="-"||ot==="."))_t+=Qt(ot);else if(ot===":"){if(wt&&(it.isSpecial()!==R(It,_t)||_t==="file"&&(it.includesCredentials()||it.port!==null)||it.scheme==="file"&&!it.host))return;if(it.scheme=_t,wt){it.isSpecial()&&It[it.scheme]===it.port&&(it.port=null);return}_t="",it.scheme==="file"?Ot=Hr:it.isSpecial()&&pt&&pt.scheme===it.scheme?Ot=zt:it.isSpecial()?Ot=Ee:pn[ye+1]==="/"?(Ot=jt,ye++):(it.cannotBeABaseURL=!0,xt(it.path,""),Ot=Wa)}else{if(wt)return ge;_t="",Ot=Rt,ye=0;continue}break;case Rt:if(!pt||pt.cannotBeABaseURL&&ot!=="#")return ge;if(pt.cannotBeABaseURL&&ot==="#"){it.scheme=pt.scheme,it.path=C(pt.path),it.query=pt.query,it.fragment="",it.cannotBeABaseURL=!0,Ot=Wn;break}Ot=pt.scheme==="file"?Hr:Wt;continue;case zt:if(ot==="/"&&pn[ye+1]==="/")Ot=Xe,ye++;else{Ot=Wt;continue}break;case jt:if(ot==="/"){Ot=Je;break}else{Ot=Vn;continue}case Wt:if(it.scheme=pt.scheme,ot===bt)it.username=pt.username,it.password=pt.password,it.host=pt.host,it.port=pt.port,it.path=C(pt.path),it.query=pt.query;else if(ot==="/"||ot==="\\"&&it.isSpecial())Ot=ue;else if(ot==="?")it.username=pt.username,it.password=pt.password,it.host=pt.host,it.port=pt.port,it.path=C(pt.path),it.query="",Ot=ir;else if(ot==="#")it.username=pt.username,it.password=pt.password,it.host=pt.host,it.port=pt.port,it.path=C(pt.path),it.query=pt.query,it.fragment="",Ot=Wn;else{it.username=pt.username,it.password=pt.password,it.host=pt.host,it.port=pt.port,it.path=C(pt.path),it.path.length--,Ot=Vn;continue}break;case ue:if(it.isSpecial()&&(ot==="/"||ot==="\\"))Ot=Xe;else if(ot==="/")Ot=Je;else{it.username=pt.username,it.password=pt.password,it.host=pt.host,it.port=pt.port,Ot=Vn;continue}break;case Ee:if(Ot=Xe,ot!=="/"||tt(_t,ye+1)!=="/")continue;ye++;break;case Xe:if(ot!=="/"&&ot!=="\\"){Ot=Je;continue}break;case Je:if(ot==="@"){Ie&&(_t="%40"+_t),Ie=!0,an=O(_t);for(var en=0;en65535)return Mt;it.port=it.isSpecial()&&Bn===It[it.scheme]?null:Bn,_t=""}if(wt)return;Ot=yr;continue}else return Mt;break;case Hr:if(it.scheme="file",ot==="/"||ot==="\\")Ot=Ya;else if(pt&&pt.scheme==="file")switch(ot){case bt:it.host=pt.host,it.path=C(pt.path),it.query=pt.query;break;case"?":it.host=pt.host,it.path=C(pt.path),it.query="",Ot=ir;break;case"#":it.host=pt.host,it.path=C(pt.path),it.query=pt.query,it.fragment="",Ot=Wn;break;default:Ct(lt(C(pn,ye),""))||(it.host=pt.host,it.path=C(pt.path),it.shortenPath()),Ot=Vn;continue}else{Ot=Vn;continue}break;case Ya:if(ot==="/"||ot==="\\"){Ot=ga;break}pt&&pt.scheme==="file"&&!Ct(lt(C(pn,ye),""))&&(Pt(pt.path[0],!0)?xt(it.path,pt.path[0]):it.host=pt.host),Ot=Vn;continue;case ga:if(ot===bt||ot==="/"||ot==="\\"||ot==="?"||ot==="#"){if(!wt&&Pt(_t))Ot=Vn;else if(_t===""){if(it.host="",wt)return;Ot=yr}else{if(Fn=it.parseHost(_t),Fn)return Fn;if(it.host==="localhost"&&(it.host=""),wt)return;_t="",Ot=yr}continue}else _t+=ot;break;case yr:if(it.isSpecial()){if(Ot=Vn,ot!=="/"&&ot!=="\\")continue}else if(!wt&&ot==="?")it.query="",Ot=ir;else if(!wt&&ot==="#")it.fragment="",Ot=Wn;else if(ot!==bt&&(Ot=Vn,ot!=="/"))continue;break;case Vn:if(ot===bt||ot==="/"||ot==="\\"&&it.isSpecial()||!wt&&(ot==="?"||ot==="#")){if(Et(_t)?(it.shortenPath(),ot!=="/"&&!(ot==="\\"&&it.isSpecial())&&xt(it.path,"")):Nt(_t)?ot!=="/"&&!(ot==="\\"&&it.isSpecial())&&xt(it.path,""):(it.scheme==="file"&&!it.path.length&&Pt(_t)&&(it.host&&(it.host=""),_t=tt(_t,0)+":"),xt(it.path,_t)),_t="",it.scheme==="file"&&(ot===bt||ot==="?"||ot==="#"))for(;it.path.length>1&&it.path[0]==="";)Ut(it.path);ot==="?"?(it.query="",Ot=ir):ot==="#"&&(it.fragment="",Ot=Wn)}else _t+=ut(ot,Ye);break;case Wa:ot==="?"?(it.query="",Ot=ir):ot==="#"?(it.fragment="",Ot=Wn):ot!==bt&&(it.path[0]+=ut(ot,Zt));break;case ir:!wt&&ot==="#"?(it.fragment="",Ot=Wn):ot!==bt&&(ot==="'"&&it.isSpecial()?it.query+="%27":ot==="#"?it.query+="%23":it.query+=ut(ot,Zt));break;case Wn:ot!==bt&&(it.fragment+=ut(ot,Yt));break}ye++}},parseHost:function(ft){var wt,pt,it;if(tt(ft,0)==="["){if(tt(ft,ft.length-1)!=="]"||(wt=Tt(Xt(ft,1,-1)),!wt))return ae;this.host=wt}else if(this.isSpecial()){if(ft=M(ft),et($e,ft)||(wt=Ft(ft),wt===null))return ae;this.host=wt}else{if(et(ce,ft))return ae;for(wt="",pt=O(ft),it=0;it1?arguments[1]:void 0,Ot=B(pt,new va(wt,!1,it));d||(pt.href=Ot.serialize(),pt.origin=Ot.getOrigin(),pt.protocol=Ot.getProtocol(),pt.username=Ot.getUsername(),pt.password=Ot.getPassword(),pt.host=Ot.getHost(),pt.hostname=Ot.getHostname(),pt.port=Ot.getPort(),pt.pathname=Ot.getPathname(),pt.search=Ot.getSearch(),pt.searchParams=Ot.getSearchParams(),pt.hash=Ot.getHash())},xn=xr.prototype,Mn=function(ft,wt){return{get:function(){return V(this)[ft]()},set:wt&&function(pt){return V(this)[wt](pt)},configurable:!0,enumerable:!0}};if(d&&(A(xn,"href",Mn("serialize","setHref")),A(xn,"origin",Mn("getOrigin")),A(xn,"protocol",Mn("getProtocol","setProtocol")),A(xn,"username",Mn("getUsername","setUsername")),A(xn,"password",Mn("getPassword","setPassword")),A(xn,"host",Mn("getHost","setHost")),A(xn,"hostname",Mn("getHostname","setHostname")),A(xn,"port",Mn("getPort","setPort")),A(xn,"pathname",Mn("getPathname","setPathname")),A(xn,"search",Mn("getSearch","setSearch")),A(xn,"searchParams",Mn("getSearchParams")),A(xn,"hash",Mn("getHash","setHash"))),$(xn,"toJSON",function(){return V(this).serialize()},{enumerable:!0}),$(xn,"toString",function(){return V(this).serialize()},{enumerable:!0}),J){var Ka=J.createObjectURL,Za=J.revokeObjectURL;Ka&&$(xr,"createObjectURL",y(Ka,J)),Za&&$(xr,"revokeObjectURL",y(Za,J))}z(xr,"URL"),u({global:!0,constructor:!0,forced:!h,sham:!d},{URL:xr})},function(x,b,r){var u=r(7),d=r(33),h=r(6),p=r(36),y=d("iterator");x.exports=!u(function(){var T=new URL("b?a=1&b=2&c=3","https://a"),$=T.searchParams,A=new URLSearchParams("a=1&a=2&b=3"),E="";return T.pathname="c%20d",$.forEach(function(R,I){$.delete("b"),E+=I+R}),A.delete("a",2),A.delete("b",void 0),p&&(!T.toJSON||!A.has("a",1)||A.has("a",2)||!A.has("a",void 0)||A.has("b"))||!$.size&&(p||!h)||!$.sort||T.href!=="https://a/c%20d?a=1&c=3"||$.get("c")!=="3"||String(new URLSearchParams("?a=1"))!=="a=1"||!$[y]||new URL("https://a@b").username!=="a"||new URLSearchParams(new URLSearchParams("a=b")).get("a")!=="b"||new URL("https://\u0442\u0435\u0441\u0442").host!=="xn--e1aybc"||new URL("https://a#\u0431").hash!=="#%D0%B1"||E!=="a1c3"||new URL("https://x",void 0).host!=="x"})},function(x,b,r){var u=r(14),d=2147483647,h=36,p=1,y=26,T=38,$=700,A=72,E=128,R="-",I=/[^\0-\u007E]/,O=/[.\u3002\uFF0E\uFF61]/g,C="Overflow: input needs wider integers to process",D=h-p,M=RangeError,F=u(O.exec),z=Math.floor,U=String.fromCharCode,j=u("".charCodeAt),G=u([].join),B=u([].push),V=u("".replace),Y=u("".split),Z=u("".toLowerCase),J=function(_){for(var tt=[],et=0,lt=_.length;et=55296&&mt<=56319&&et>1,_+=z(_/tt);_>D*y>>1;)_=z(_/D),lt+=h;return z(lt+(D+1)*_/(_+T))},rt=function(_){var tt=[];_=J(_);var et=_.length,lt=E,mt=0,gt=A,xt,yt;for(xt=0;xt<_.length;xt++)yt=_[xt],yt<128&&B(tt,U(yt));var Ut=tt.length,Dt=Ut;for(Ut&&B(tt,R);Dt=lt&&ytz((d-mt)/Qt))throw new M(C);for(mt+=(Xt-lt)*Qt,lt=Xt,xt=0;xt<_.length;xt++){if(yt=_[xt],ytd)throw new M(C);if(yt===lt){for(var kt=mt,me=h;;){var ge=me<=gt?p:me>=gt+y?y:me-gt;if(kt0&&(Rt&jt)!==0;jt>>=1)zt++;return zt},qt=function(Rt){var zt=null;switch(Rt.length){case 1:zt=Rt[0];break;case 2:zt=(Rt[0]&31)<<6|Rt[1]&63;break;case 3:zt=(Rt[0]&15)<<12|(Rt[1]&63)<<6|Rt[2]&63;break;case 4:zt=(Rt[0]&7)<<18|(Rt[1]&63)<<12|(Rt[2]&63)<<6|Rt[3]&63;break}return zt>1114111?null:zt},te=function(Rt){Rt=fe(Rt,Te," ");for(var zt=Rt.length,jt="",Wt=0;Wtzt){jt+="%",Wt++;continue}var Ee=Ft(Rt,Wt+1);if(Ee!==Ee){jt+=ue,Wt++;continue}Wt+=2;var Xe=Tt(Ee);if(Xe===0)ue=ae(Ee);else{if(Xe===1||Xe>4){jt+=de,Wt++;continue}for(var Je=[Ee],nn=1;nnzt||re(Rt,Wt)!=="%"));){var vn=Ft(Rt,Wt+1);if(vn!==vn){Wt+=3;break}if(vn>191||vn<128)break;ee(Je,vn),Wt+=2,nn++}if(Je.length!==Xe){jt+=de;continue}var jn=qt(Je);jn===null?jt+=de:ue=Mt(jn)}}jt+=ue,Wt++}return jt},Zt=/[!'()~]|%20/g,Yt={"!":"%21","'":"%27","(":"%28",")":"%29","~":"%7E","%20":"+"},Ye=function(Rt){return Yt[Rt]},Ze=function(Rt){return fe(ge(Rt),Zt,Ye)},ut=C(function(zt,jt){gt(this,{type:mt,target:xt(zt).entries,index:0,kind:jt})},lt,function(){var zt=yt(this),jt=zt.target,Wt=zt.index++;if(!jt||Wt>=jt.length)return zt.target=null,nt(void 0,!0);var ue=jt[Wt];switch(zt.kind){case"keys":return nt(ue.key,!1);case"values":return nt(ue.value,!1)}return nt([ue.key,ue.value],!1)},!0),It=function(Rt){this.entries=[],this.url=null,Rt!==void 0&&(B(Rt)?this.parseObject(Rt):this.parseQuery(typeof Rt=="string"?re(Rt,0)==="?"?ce(Rt,1):Rt:V(Rt)))};It.prototype={type:lt,bindURL:function(Rt){this.url=Rt,this.update()},parseObject:function(Rt){var zt=this.entries,jt=q(Rt),Wt,ue,Ee,Xe,Je,nn,vn;if(jt)for(Wt=J(Rt,jt),ue=Wt.next;!(Ee=y(ue,Wt)).done;){if(Xe=J(G(Ee.value)),Je=Xe.next,(nn=y(Je,Xe)).done||(vn=y(Je,Xe)).done||!y(Je,Xe).done)throw new me("Expected sequence with length 2");ee(zt,{key:V(nn.value),value:V(vn.value)})}else for(var jn in Rt)z(Rt,jn)&&ee(zt,{key:jn,value:V(Rt[jn])})},parseQuery:function(Rt){if(Rt)for(var zt=this.entries,jt=$e(Rt,"&"),Wt=0,ue,Ee;Wt0?arguments[0]:void 0,jt=gt(this,new It(zt));$||(this.size=jt.entries.length)},Ct=Pt.prototype;if(I(Ct,{append:function(zt,jt){var Wt=xt(this);rt(arguments.length,2),ee(Wt.entries,{key:V(zt),value:V(jt)}),$||this.length++,Wt.updateURL()},delete:function(Rt){for(var zt=xt(this),jt=rt(arguments.length,1),Wt=zt.entries,ue=V(Rt),Ee=jt<2?void 0:arguments[1],Xe=Ee===void 0?Ee:V(Ee),Je=0;JeWt.key?1:-1}),zt.updateURL()},forEach:function(zt){for(var jt=xt(this).entries,Wt=U(zt,arguments.length>1?arguments[1]:void 0),ue=0,Ee;ue1?ie(arguments[1]):{})}}),F(Dt)){var we=function(zt){return M(this,Qt),new Dt(zt,arguments.length>1?ie(arguments[1]):{})};Qt.constructor=we,we.prototype=Qt,u({global:!0,constructor:!0,dontCallGetSet:!0,forced:!0},{Request:we})}}x.exports={URLSearchParams:Pt,getState:xt}},function(x,b,r){var u=r(3),d=r(23),h=r(7),p=r(367),y=r(68),T=r(574),$=d("URL"),A=T&&h(function(){$.canParse()}),E=h(function(){return $.canParse.length!==1});u({target:"URL",stat:!0,forced:!A||E},{canParse:function(I){var O=p(arguments.length,1),C=y(I),D=O<2||arguments[1]===void 0?void 0:y(arguments[1]);try{return!!new $(C,D)}catch(M){return!1}}})},function(x,b,r){var u=r(3),d=r(23),h=r(367),p=r(68),y=r(574),T=d("URL");u({target:"URL",stat:!0,forced:!y},{parse:function(A){var E=h(arguments.length,1),R=p(A),I=E<2||arguments[1]===void 0?void 0:p(arguments[1]);try{return new T(R,I)}catch(O){return null}}})},function(x,b,r){var u=r(3),d=r(8);u({target:"URL",proto:!0,enumerable:!0},{toJSON:function(){return d(URL.prototype.toString,this)}})},function(x,b,r){r(576)},function(x,b,r){var u=r(47),d=r(14),h=r(68),p=r(367),y=URLSearchParams,T=y.prototype,$=d(T.append),A=d(T.delete),E=d(T.forEach),R=d([].push),I=new y("a=1&a=2&b=3");I.delete("a",1),I.delete("b",void 0),I+""!="a=2"&&u(T,"delete",function(O){var C=arguments.length,D=C<2?void 0:arguments[1];if(C&&D===void 0)return A(this,O);var M=[];E(this,function(Y,Z){R(M,{key:Z,value:Y})}),p(C,1);for(var F=h(O),z=h(D),U=0,j=0,G=!1,B=M.length,V;U=W&&(W=X+1);!(k=L[W])&&++W=0;)(s=a[i])&&(o&&s.compareDocumentPosition(o)^4&&o.parentNode.insertBefore(s,o),o=s);return this}function xt(t){t||(t=yt);function e(v,m){return v&&m?t(v.__data__,m.__data__):!v-!m}for(var n=this._groups,a=n.length,i=new Array(a),o=0;oe?1:t>=e?0:NaN}function Ut(){var t=arguments[0];return arguments[0]=this,t.apply(null,arguments),this}function Dt(){return Array.from(this)}function Xt(){for(var t=this._groups,e=0,n=t.length;e=0&&(e=t.slice(0,n))!=="xmlns"&&(t=t.slice(n+1)),ae.hasOwnProperty(e)?{space:ae[e],local:t}:t}function Ht(t){return function(){this.removeAttribute(t)}}function re(t){return function(){this.removeAttributeNS(t.space,t.local)}}function se(t,e){return function(){this.setAttribute(t,e)}}function ee(t,e){return function(){this.setAttributeNS(t.space,t.local,e)}}function fe(t,e){return function(){var n=e.apply(this,arguments);n==null?this.removeAttribute(t):this.setAttribute(t,n)}}function Pe(t,e){return function(){var n=e.apply(this,arguments);n==null?this.removeAttributeNS(t.space,t.local):this.setAttributeNS(t.space,t.local,n)}}function Me(t,e){var n=Mt(t);if(arguments.length<2){var a=this.node();return n.local?a.getAttributeNS(n.space,n.local):a.getAttribute(n)}return this.each((e==null?n.local?re:Ht:typeof e=="function"?n.local?Pe:fe:n.local?ee:se)(n,e))}function $e(t){return t.ownerDocument&&t.ownerDocument.defaultView||t.document&&t||t.defaultView}function ce(t){return function(){this.style.removeProperty(t)}}function Ae(t,e,n){return function(){this.style.setProperty(t,e,n)}}function Te(t,e,n){return function(){var a=e.apply(this,arguments);a==null?this.style.removeProperty(t):this.style.setProperty(t,a,n)}}function de(t,e,n){return arguments.length>1?this.each((e==null?ce:typeof e=="function"?Te:Ae)(t,e,n==null?"":n)):bt(this.node(),t)}function bt(t,e){return t.style.getPropertyValue(e)||$e(t).getComputedStyle(t,null).getPropertyValue(e)}function Ft(t){return function(){delete this[t]}}function Tt(t,e){return function(){this[t]=e}}function qt(t,e){return function(){var n=e.apply(this,arguments);n==null?delete this[t]:this[t]=n}}function te(t,e){return arguments.length>1?this.each((e==null?Ft:typeof e=="function"?qt:Tt)(t,e)):this.node()[t]}function Zt(t){return t.trim().split(/^|\s+/)}function Yt(t){return t.classList||new Ye(t)}function Ye(t){this._node=t,this._names=Zt(t.getAttribute("class")||"")}Ye.prototype={add:function(t){var e=this._names.indexOf(t);e<0&&(this._names.push(t),this._node.setAttribute("class",this._names.join(" ")))},remove:function(t){var e=this._names.indexOf(t);e>=0&&(this._names.splice(e,1),this._node.setAttribute("class",this._names.join(" ")))},contains:function(t){return this._names.indexOf(t)>=0}};function Ze(t,e){for(var n=Yt(t),a=-1,i=e.length;++a=0&&(n=e.slice(a+1),e=e.slice(0,a)),{type:e,name:n}})}function Ka(t){return function(){var e=this.__on;if(e){for(var n=0,a=-1,i=e.length,o;n(t(o=new Date(+o)),o),i.ceil=o=>(t(o=new Date(o-1)),e(o,1),t(o),o),i.round=o=>{const s=i(o),l=i.ceil(o);return o-s(e(o=new Date(+o),s==null?1:Math.floor(s)),o),i.range=(o,s,l)=>{const c=[];if(o=i.ceil(o),l=l==null?1:Math.floor(l),!(o0))return c;let f;do c.push(f=new Date(+o)),e(o,l),t(o);while(fen(s=>{if(s>=s)for(;t(s),!o(s);)s.setTime(s-1)},(s,l)=>{if(s>=s)if(l<0)for(;++l<=0;)for(;e(s,-1),!o(s););else for(;--l>=0;)for(;e(s,1),!o(s););}),n&&(i.count=(o,s)=>(an.setTime(+o),Fn.setTime(+s),t(an),t(Fn),Math.floor(n(an,Fn))),i.every=o=>(o=Math.floor(o),!isFinite(o)||!(o>0)?null:o>1?i.filter(a?s=>a(s)%o===0:s=>i.count(0,s)%o===0):i)),i}const Gn=1e3,In=Gn*60,Bn=In*60,or=Bn*24,to=or*7,Ps=or*30,eo=or*365;function Rr(t){return en(e=>{e.setDate(e.getDate()-(e.getDay()+7-t)%7),e.setHours(0,0,0,0)},(e,n)=>{e.setDate(e.getDate()+n*7)},(e,n)=>(n-e-(n.getTimezoneOffset()-e.getTimezoneOffset())*In)/to)}const Ja=Rr(0),Qa=Rr(1),Rf=Rr(2),If=Rr(3),Yr=Rr(4),Of=Rr(5),Cf=Rr(6),I0=Ja.range,O0=Qa.range,C0=Rf.range,P0=If.range,w0=Yr.range,M0=Of.range,D0=Cf.range;function Ir(t){return en(e=>{e.setUTCDate(e.getUTCDate()-(e.getUTCDay()+7-t)%7),e.setUTCHours(0,0,0,0)},(e,n)=>{e.setUTCDate(e.getUTCDate()+n*7)},(e,n)=>(n-e)/to)}const ka=Ir(0),qa=Ir(1),Pf=Ir(2),wf=Ir(3),Wr=Ir(4),Mf=Ir(5),Df=Ir(6),L0=ka.range,N0=qa.range,F0=Pf.range,B0=wf.range,U0=Wr.range,z0=Mf.range,j0=Df.range,pa=en(t=>t.setHours(0,0,0,0),(t,e)=>t.setDate(t.getDate()+e),(t,e)=>(e-t-(e.getTimezoneOffset()-t.getTimezoneOffset())*In)/or,t=>t.getDate()-1),V0=pa.range,_a=en(t=>{t.setUTCHours(0,0,0,0)},(t,e)=>{t.setUTCDate(t.getUTCDate()+e)},(t,e)=>(e-t)/or,t=>t.getUTCDate()-1),G0=_a.range,ws=en(t=>{t.setUTCHours(0,0,0,0)},(t,e)=>{t.setUTCDate(t.getUTCDate()+e)},(t,e)=>(e-t)/or,t=>Math.floor(t/or)),X0=ws.range,sr=en(t=>{t.setMonth(0,1),t.setHours(0,0,0,0)},(t,e)=>{t.setFullYear(t.getFullYear()+e)},(t,e)=>e.getFullYear()-t.getFullYear(),t=>t.getFullYear());sr.every=t=>!isFinite(t=Math.floor(t))||!(t>0)?null:en(e=>{e.setFullYear(Math.floor(e.getFullYear()/t)*t),e.setMonth(0,1),e.setHours(0,0,0,0)},(e,n)=>{e.setFullYear(e.getFullYear()+n*t)});const H0=sr.range,lr=en(t=>{t.setUTCMonth(0,1),t.setUTCHours(0,0,0,0)},(t,e)=>{t.setUTCFullYear(t.getUTCFullYear()+e)},(t,e)=>e.getUTCFullYear()-t.getUTCFullYear(),t=>t.getUTCFullYear());lr.every=t=>!isFinite(t=Math.floor(t))||!(t>0)?null:en(e=>{e.setUTCFullYear(Math.floor(e.getUTCFullYear()/t)*t),e.setUTCMonth(0,1),e.setUTCHours(0,0,0,0)},(e,n)=>{e.setUTCFullYear(e.getUTCFullYear()+n*t)});const Y0=lr.range;function no(t){if(0<=t.y&&t.y<100){var e=new Date(-1,t.m,t.d,t.H,t.M,t.S,t.L);return e.setFullYear(t.y),e}return new Date(t.y,t.m,t.d,t.H,t.M,t.S,t.L)}function ro(t){if(0<=t.y&&t.y<100){var e=new Date(Date.UTC(-1,t.m,t.d,t.H,t.M,t.S,t.L));return e.setUTCFullYear(t.y),e}return new Date(Date.UTC(t.y,t.m,t.d,t.H,t.M,t.S,t.L))}function ma(t,e,n){return{y:t,m:e,d:n,H:0,M:0,S:0,L:0}}function Lf(t){var e=t.dateTime,n=t.date,a=t.time,i=t.periods,o=t.days,s=t.shortDays,l=t.months,c=t.shortMonths,f=ya(i),g=xa(i),v=ya(o),m=xa(o),S=ya(s),P=xa(s),N=ya(l),L=xa(l),w=ya(c),X=xa(c),W={a:At,A:Gt,b:Bt,B:Kt,c:null,d:Bs,e:Bs,f:rd,g:hd,G:vd,H:td,I:ed,j:nd,L:Us,m:ad,M:id,p:ne,q:le,Q:Hs,s:Ys,S:od,u:sd,U:ld,V:cd,w:ud,W:fd,x:null,X:null,y:dd,Y:gd,Z:pd,"%":Xs},H={a:be,A:Oe,b:Ce,B:He,c:null,d:js,e:js,f:Td,g:Pd,G:Md,H:md,I:yd,j:xd,L:Vs,m:$d,M:Sd,p:Fe,q:dn,Q:Hs,s:Ys,S:Ad,u:Ed,U:bd,V:Rd,w:Id,W:Od,x:null,X:null,y:Cd,Y:wd,Z:Dd,"%":Xs},k={a:dt,A:st,b:Vt,B:vt,c:Q,d:Ns,e:Ns,f:Qf,g:Ls,G:Ds,H:Fs,I:Fs,j:Wf,L:Jf,m:Yf,M:Kf,p:$t,q:Hf,Q:qf,s:_f,S:Zf,u:zf,U:jf,V:Vf,w:Uf,W:Gf,x:St,X:ct,y:Ls,Y:Ds,Z:Xf,"%":kf};W.x=K(n,W),W.X=K(a,W),W.c=K(e,W),H.x=K(n,H),H.X=K(a,H),H.c=K(e,H);function K(Jt,xe){return function(Re){var Lt=[],un=-1,Ge=0,Pn=Jt.length,wn,pe,fn;for(Re instanceof Date||(Re=new Date(+Re));++un53)return null;"w"in Lt||(Lt.w=1),"Z"in Lt?(Ge=ro(ma(Lt.y,0,1)),Pn=Ge.getUTCDay(),Ge=Pn>4||Pn===0?qa.ceil(Ge):qa(Ge),Ge=_a.offset(Ge,(Lt.V-1)*7),Lt.y=Ge.getUTCFullYear(),Lt.m=Ge.getUTCMonth(),Lt.d=Ge.getUTCDate()+(Lt.w+6)%7):(Ge=no(ma(Lt.y,0,1)),Pn=Ge.getDay(),Ge=Pn>4||Pn===0?Qa.ceil(Ge):Qa(Ge),Ge=pa.offset(Ge,(Lt.V-1)*7),Lt.y=Ge.getFullYear(),Lt.m=Ge.getMonth(),Lt.d=Ge.getDate()+(Lt.w+6)%7)}else("W"in Lt||"U"in Lt)&&("w"in Lt||(Lt.w="u"in Lt?Lt.u%7:"W"in Lt?1:0),Pn="Z"in Lt?ro(ma(Lt.y,0,1)).getUTCDay():no(ma(Lt.y,0,1)).getDay(),Lt.m=0,Lt.d="W"in Lt?(Lt.w+6)%7+Lt.W*7-(Pn+5)%7:Lt.w+Lt.U*7-(Pn+6)%7);return"Z"in Lt?(Lt.H+=Lt.Z/100|0,Lt.M+=Lt.Z%100,ro(Lt)):no(Lt)}}function ht(Jt,xe,Re,Lt){for(var un=0,Ge=xe.length,Pn=Re.length,wn,pe;un=Pn)return-1;if(wn=xe.charCodeAt(un++),wn===37){if(wn=xe.charAt(un++),pe=k[wn in Ms?xe.charAt(un++):wn],!pe||(Lt=pe(Jt,Re,Lt))<0)return-1}else if(wn!=Re.charCodeAt(Lt++))return-1}return Lt}function $t(Jt,xe,Re){var Lt=f.exec(xe.slice(Re));return Lt?(Jt.p=g.get(Lt[0].toLowerCase()),Re+Lt[0].length):-1}function dt(Jt,xe,Re){var Lt=S.exec(xe.slice(Re));return Lt?(Jt.w=P.get(Lt[0].toLowerCase()),Re+Lt[0].length):-1}function st(Jt,xe,Re){var Lt=v.exec(xe.slice(Re));return Lt?(Jt.w=m.get(Lt[0].toLowerCase()),Re+Lt[0].length):-1}function Vt(Jt,xe,Re){var Lt=w.exec(xe.slice(Re));return Lt?(Jt.m=X.get(Lt[0].toLowerCase()),Re+Lt[0].length):-1}function vt(Jt,xe,Re){var Lt=N.exec(xe.slice(Re));return Lt?(Jt.m=L.get(Lt[0].toLowerCase()),Re+Lt[0].length):-1}function Q(Jt,xe,Re){return ht(Jt,e,xe,Re)}function St(Jt,xe,Re){return ht(Jt,n,xe,Re)}function ct(Jt,xe,Re){return ht(Jt,a,xe,Re)}function At(Jt){return s[Jt.getDay()]}function Gt(Jt){return o[Jt.getDay()]}function Bt(Jt){return c[Jt.getMonth()]}function Kt(Jt){return l[Jt.getMonth()]}function ne(Jt){return i[+(Jt.getHours()>=12)]}function le(Jt){return 1+~~(Jt.getMonth()/3)}function be(Jt){return s[Jt.getUTCDay()]}function Oe(Jt){return o[Jt.getUTCDay()]}function Ce(Jt){return c[Jt.getUTCMonth()]}function He(Jt){return l[Jt.getUTCMonth()]}function Fe(Jt){return i[+(Jt.getUTCHours()>=12)]}function dn(Jt){return 1+~~(Jt.getUTCMonth()/3)}return{format:function(Jt){var xe=K(Jt+="",W);return xe.toString=function(){return Jt},xe},parse:function(Jt){var xe=at(Jt+="",!1);return xe.toString=function(){return Jt},xe},utcFormat:function(Jt){var xe=K(Jt+="",H);return xe.toString=function(){return Jt},xe},utcParse:function(Jt){var xe=at(Jt+="",!0);return xe.toString=function(){return Jt},xe}}}var Ms={"-":"",_:" ",0:"0"},mn=/^\s*\d+/,Nf=/^%/,Ff=/[\\^$*+?|[\]().{}]/g;function Ne(t,e,n){var a=t<0?"-":"",i=(a?-t:t)+"",o=i.length;return a+(o[e.toLowerCase(),n]))}function Uf(t,e,n){var a=mn.exec(e.slice(n,n+1));return a?(t.w=+a[0],n+a[0].length):-1}function zf(t,e,n){var a=mn.exec(e.slice(n,n+1));return a?(t.u=+a[0],n+a[0].length):-1}function jf(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.U=+a[0],n+a[0].length):-1}function Vf(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.V=+a[0],n+a[0].length):-1}function Gf(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.W=+a[0],n+a[0].length):-1}function Ds(t,e,n){var a=mn.exec(e.slice(n,n+4));return a?(t.y=+a[0],n+a[0].length):-1}function Ls(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.y=+a[0]+(+a[0]>68?1900:2e3),n+a[0].length):-1}function Xf(t,e,n){var a=/^(Z)|([+-]\d\d)(?::?(\d\d))?/.exec(e.slice(n,n+6));return a?(t.Z=a[1]?0:-(a[2]+(a[3]||"00")),n+a[0].length):-1}function Hf(t,e,n){var a=mn.exec(e.slice(n,n+1));return a?(t.q=a[0]*3-3,n+a[0].length):-1}function Yf(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.m=a[0]-1,n+a[0].length):-1}function Ns(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.d=+a[0],n+a[0].length):-1}function Wf(t,e,n){var a=mn.exec(e.slice(n,n+3));return a?(t.m=0,t.d=+a[0],n+a[0].length):-1}function Fs(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.H=+a[0],n+a[0].length):-1}function Kf(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.M=+a[0],n+a[0].length):-1}function Zf(t,e,n){var a=mn.exec(e.slice(n,n+2));return a?(t.S=+a[0],n+a[0].length):-1}function Jf(t,e,n){var a=mn.exec(e.slice(n,n+3));return a?(t.L=+a[0],n+a[0].length):-1}function Qf(t,e,n){var a=mn.exec(e.slice(n,n+6));return a?(t.L=Math.floor(a[0]/1e3),n+a[0].length):-1}function kf(t,e,n){var a=Nf.exec(e.slice(n,n+1));return a?n+a[0].length:-1}function qf(t,e,n){var a=mn.exec(e.slice(n));return a?(t.Q=+a[0],n+a[0].length):-1}function _f(t,e,n){var a=mn.exec(e.slice(n));return a?(t.s=+a[0],n+a[0].length):-1}function Bs(t,e){return Ne(t.getDate(),e,2)}function td(t,e){return Ne(t.getHours(),e,2)}function ed(t,e){return Ne(t.getHours()%12||12,e,2)}function nd(t,e){return Ne(1+pa.count(sr(t),t),e,3)}function Us(t,e){return Ne(t.getMilliseconds(),e,3)}function rd(t,e){return Us(t,e)+"000"}function ad(t,e){return Ne(t.getMonth()+1,e,2)}function id(t,e){return Ne(t.getMinutes(),e,2)}function od(t,e){return Ne(t.getSeconds(),e,2)}function sd(t){var e=t.getDay();return e===0?7:e}function ld(t,e){return Ne(Ja.count(sr(t)-1,t),e,2)}function zs(t){var e=t.getDay();return e>=4||e===0?Yr(t):Yr.ceil(t)}function cd(t,e){return t=zs(t),Ne(Yr.count(sr(t),t)+(sr(t).getDay()===4),e,2)}function ud(t){return t.getDay()}function fd(t,e){return Ne(Qa.count(sr(t)-1,t),e,2)}function dd(t,e){return Ne(t.getFullYear()%100,e,2)}function hd(t,e){return t=zs(t),Ne(t.getFullYear()%100,e,2)}function gd(t,e){return Ne(t.getFullYear()%1e4,e,4)}function vd(t,e){var n=t.getDay();return t=n>=4||n===0?Yr(t):Yr.ceil(t),Ne(t.getFullYear()%1e4,e,4)}function pd(t){var e=t.getTimezoneOffset();return(e>0?"-":(e*=-1,"+"))+Ne(e/60|0,"0",2)+Ne(e%60,"0",2)}function js(t,e){return Ne(t.getUTCDate(),e,2)}function md(t,e){return Ne(t.getUTCHours(),e,2)}function yd(t,e){return Ne(t.getUTCHours()%12||12,e,2)}function xd(t,e){return Ne(1+_a.count(lr(t),t),e,3)}function Vs(t,e){return Ne(t.getUTCMilliseconds(),e,3)}function Td(t,e){return Vs(t,e)+"000"}function $d(t,e){return Ne(t.getUTCMonth()+1,e,2)}function Sd(t,e){return Ne(t.getUTCMinutes(),e,2)}function Ad(t,e){return Ne(t.getUTCSeconds(),e,2)}function Ed(t){var e=t.getUTCDay();return e===0?7:e}function bd(t,e){return Ne(ka.count(lr(t)-1,t),e,2)}function Gs(t){var e=t.getUTCDay();return e>=4||e===0?Wr(t):Wr.ceil(t)}function Rd(t,e){return t=Gs(t),Ne(Wr.count(lr(t),t)+(lr(t).getUTCDay()===4),e,2)}function Id(t){return t.getUTCDay()}function Od(t,e){return Ne(qa.count(lr(t)-1,t),e,2)}function Cd(t,e){return Ne(t.getUTCFullYear()%100,e,2)}function Pd(t,e){return t=Gs(t),Ne(t.getUTCFullYear()%100,e,2)}function wd(t,e){return Ne(t.getUTCFullYear()%1e4,e,4)}function Md(t,e){var n=t.getUTCDay();return t=n>=4||n===0?Wr(t):Wr.ceil(t),Ne(t.getUTCFullYear()%1e4,e,4)}function Dd(){return"+0000"}function Xs(){return"%"}function Hs(t){return+t}function Ys(t){return Math.floor(+t/1e3)}var Kr,ao,Ws,io,Ks;Ld({dateTime:"%x, %X",date:"%-m/%-d/%Y",time:"%-I:%M:%S %p",periods:["AM","PM"],days:["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],shortDays:["Sun","Mon","Tue","Wed","Thu","Fri","Sat"],months:["January","February","March","April","May","June","July","August","September","October","November","December"],shortMonths:["Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"]});function Ld(t){return Kr=Lf(t),ao=Kr.format,Ws=Kr.parse,io=Kr.utcFormat,Ks=Kr.utcParse,Kr}var Nd=Object.defineProperty,Zs=Object.getOwnPropertySymbols,Fd=Object.prototype.hasOwnProperty,Bd=Object.prototype.propertyIsEnumerable,Js=(t,e,n)=>e in t?Nd(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,ke=(t,e)=>{for(var n in e||(e={}))Fd.call(e,n)&&Js(t,n,e[n]);if(Zs)for(var n of Zs(e))Bd.call(e,n)&&Js(t,n,e[n]);return t};const Se={button:"bb-button",chart:"bb-chart",empty:"bb-empty",main:"bb-main",target:"bb-target",EXPANDED:"_expanded_"},Ve={arc:"bb-arc",arcLabelLine:"bb-arc-label-line",arcRange:"bb-arc-range",arcs:"bb-arcs",chartArc:"bb-chart-arc",chartArcs:"bb-chart-arcs",chartArcsBackground:"bb-chart-arcs-background",chartArcsTitle:"bb-chart-arcs-title",needle:"bb-needle"},ti={area:"bb-area",areas:"bb-areas"},Tn={axis:"bb-axis",axisX:"bb-axis-x",axisXLabel:"bb-axis-x-label",axisY:"bb-axis-y",axisY2:"bb-axis-y2",axisY2Label:"bb-axis-y2-label",axisYLabel:"bb-axis-y-label",axisXTooltip:"bb-axis-x-tooltip",axisYTooltip:"bb-axis-y-tooltip",axisY2Tooltip:"bb-axis-y2-tooltip"},Kn={bar:"bb-bar",bars:"bb-bars",chartBar:"bb-chart-bar",chartBars:"bb-chart-bars"},cr={candlestick:"bb-candlestick",candlesticks:"bb-candlesticks",chartCandlestick:"bb-chart-candlestick",chartCandlesticks:"bb-chart-candlesticks",valueDown:"bb-value-down",valueUp:"bb-value-up"},$n={chartCircles:"bb-chart-circles",circle:"bb-circle",circles:"bb-circles"},oo={colorPattern:"bb-color-pattern",colorScale:"bb-colorscale"},Or={dragarea:"bb-dragarea",INCLUDED:"_included_"},Ta={funnel:"bb-funnel",chartFunnel:"bb-chart-funnel",chartFunnels:"bb-chart-funnels",funnelBackground:"bb-funnel-background"},Un={chartArcsGaugeMax:"bb-chart-arcs-gauge-max",chartArcsGaugeMin:"bb-chart-arcs-gauge-min",chartArcsGaugeUnit:"bb-chart-arcs-gauge-unit",chartArcsGaugeTitle:"bb-chart-arcs-gauge-title",gaugeValue:"bb-gauge-value"},We={legend:"bb-legend",legendBackground:"bb-legend-background",legendItem:"bb-legend-item",legendItemEvent:"bb-legend-item-event",legendItemHidden:"bb-legend-item-hidden",legendItemPoint:"bb-legend-item-point",legendItemTile:"bb-legend-item-tile"},ur={chartLine:"bb-chart-line",chartLines:"bb-chart-lines",line:"bb-line",lines:"bb-lines"},Zn={eventRect:"bb-event-rect",eventRects:"bb-event-rects",eventRectsMultiple:"bb-event-rects-multiple",eventRectsSingle:"bb-event-rects-single"},qe={focused:"bb-focused",defocused:"bb-defocused",legendItemFocused:"bb-legend-item-focused",xgridFocus:"bb-xgrid-focus",ygridFocus:"bb-ygrid-focus"},on={grid:"bb-grid",gridLines:"bb-grid-lines",xgrid:"bb-xgrid",xgridLine:"bb-xgrid-line",xgridLines:"bb-xgrid-lines",xgrids:"bb-xgrids",ygrid:"bb-ygrid",ygridLine:"bb-ygrid-line",ygridLines:"bb-ygrid-lines",ygrids:"bb-ygrids"},Tr={level:"bb-level",levels:"bb-levels"},Qs={chartRadar:"bb-chart-radar",chartRadars:"bb-chart-radars"},$a={region:"bb-region",regions:"bb-regions"},tn={selectedCircle:"bb-selected-circle",selectedCircles:"bb-selected-circles",SELECTED:"_selected_"},sn={shape:"bb-shape",shapes:"bb-shapes"},ks={brush:"bb-brush",subchart:"bb-subchart"},On={chartText:"bb-chart-text",chartTexts:"bb-chart-texts",text:"bb-text",texts:"bb-texts",title:"bb-title",TextOverlapping:"text-overlapping"},ei={tooltip:"bb-tooltip",tooltipContainer:"bb-tooltip-container",tooltipName:"bb-tooltip-name"},qs={treemap:"bb-treemap",chartTreemap:"bb-chart-treemap",chartTreemaps:"bb-chart-treemaps"},so={buttonZoomReset:"bb-zoom-reset",zoomBrush:"bb-zoom-brush"};var Ue=ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke(ke({},Se),Ve),ti),Tn),Kn),cr),$n),oo),Or),Un),We),ur),Zn),qe),Ta),on),Qs),$a),tn),sn),ks),On),ei),qs),so),Ud={boost_useCssRule:!1,boost_useWorker:!1},zd={color_pattern:[],color_tiles:void 0,color_threshold:{},color_onover:void 0},jd={legend_contents_bindto:void 0,legend_contents_template:"{=TITLE}",legend_equally:!1,legend_hide:!1,legend_inset_anchor:"top-left",legend_inset_x:10,legend_inset_y:0,legend_inset_step:void 0,legend_item_interaction:!0,legend_item_dblclick:!1,legend_item_onclick:void 0,legend_item_onover:void 0,legend_item_onout:void 0,legend_item_tile_width:10,legend_item_tile_height:10,legend_item_tile_r:5,legend_item_tile_type:"rectangle",legend_format:void 0,legend_padding:0,legend_position:"bottom",legend_show:!0,legend_tooltip:!1,legend_usePoint:!1},Vd={bindto:"#chart",background:{},clipPath:!0,svg_classname:void 0,size_width:void 0,size_height:void 0,padding:!0,padding_mode:void 0,padding_left:void 0,padding_right:void 0,padding_top:void 0,padding_bottom:void 0,resize_auto:!0,resize_timer:!0,onclick:void 0,onover:void 0,onout:void 0,onresize:void 0,onresized:void 0,onbeforeinit:void 0,oninit:void 0,onafterinit:void 0,onrendered:void 0,transition_duration:250,plugins:[],render:{},regions:[]},Gd={title_text:void 0,title_padding:{top:0,right:0,bottom:0,left:0},title_position:"center"},Xd={tooltip_show:!0,tooltip_doNotHide:!1,tooltip_grouped:!0,tooltip_format_title:void 0,tooltip_format_name:void 0,tooltip_format_value:void 0,tooltip_position:void 0,tooltip_contents:{},tooltip_init_show:!1,tooltip_init_x:0,tooltip_init_position:void 0,tooltip_linked:!1,tooltip_linked_name:"",tooltip_onshow:()=>{},tooltip_onhide:()=>{},tooltip_onshown:()=>{},tooltip_onhidden:()=>{},tooltip_order:null},Hd={data_x:void 0,data_idConverter:t=>t,data_names:{},data_classes:{},data_type:void 0,data_types:{},data_order:"desc",data_groups:[],data_groupsZeroAs:"positive",data_color:void 0,data_colors:{},data_labels:{},data_labels_backgroundColors:void 0,data_labels_colors:void 0,data_labels_position:{},data_hide:!1,data_filter:void 0,data_onclick:()=>{},data_onover:()=>{},data_onout:()=>{},data_onshown:void 0,data_onhidden:void 0,data_onmin:void 0,data_onmax:void 0,data_url:void 0,data_headers:void 0,data_json:void 0,data_rows:void 0,data_columns:void 0,data_mimeType:"csv",data_keys:void 0,data_empty_label_text:""},Yd={interaction_enabled:!0,interaction_brighten:!0,interaction_inputType_mouse:!0,interaction_inputType_touch:{},interaction_onout:!0},Wd={value:()=>{}};function _s(){for(var t=0,e=arguments.length,n={},a;t=0&&(a=n.slice(i+1),n=n.slice(0,i)),n&&!e.hasOwnProperty(n))throw new Error("unknown type: "+n);return{type:n,name:a}})}ni.prototype=_s.prototype={constructor:ni,on:function(t,e){var n=this._,a=Kd(t+"",n),i,o=-1,s=a.length;if(arguments.length<2){for(;++o0)for(var n=new Array(i),a=0,i,o;a>8&15|e>>4&240,e>>4&15|e&240,(e&15)<<4|e&15,1):n===8?ii(e>>24&255,e>>16&255,e>>8&255,(e&255)/255):n===4?ii(e>>12&15|e>>8&240,e>>8&15|e>>4&240,e>>4&15|e&240,((e&15)<<4|e&15)/255):null):(e=kd.exec(t))?new Dn(e[1],e[2],e[3],1):(e=qd.exec(t))?new Dn(e[1]*255/100,e[2]*255/100,e[3]*255/100,1):(e=_d.exec(t))?ii(e[1],e[2],e[3],e[4]):(e=th.exec(t))?ii(e[1]*255/100,e[2]*255/100,e[3]*255/100,e[4]):(e=eh.exec(t))?ll(e[1],e[2]/100,e[3]/100,1):(e=nh.exec(t))?ll(e[1],e[2]/100,e[3]/100,e[4]):nl.hasOwnProperty(t)?il(nl[t]):t==="transparent"?new Dn(NaN,NaN,NaN,0):null}function il(t){return new Dn(t>>16&255,t>>8&255,t&255,1)}function ii(t,e,n,a){return a<=0&&(t=e=n=NaN),new Dn(t,e,n,a)}function ih(t){return t instanceof Aa||(t=Cr(t)),t?(t=t.rgb(),new Dn(t.r,t.g,t.b,t.opacity)):new Dn}function oi(t,e,n,a){return arguments.length===1?ih(t):new Dn(t,e,n,a==null?1:a)}function Dn(t,e,n,a){this.r=+t,this.g=+e,this.b=+n,this.opacity=+a}fo(Dn,oi,el(Aa,{brighter(t){return t=t==null?ai:Math.pow(ai,t),new Dn(this.r*t,this.g*t,this.b*t,this.opacity)},darker(t){return t=t==null?Ea:Math.pow(Ea,t),new Dn(this.r*t,this.g*t,this.b*t,this.opacity)},rgb(){return this},clamp(){return new Dn(Pr(this.r),Pr(this.g),Pr(this.b),si(this.opacity))},displayable(){return-.5<=this.r&&this.r<255.5&&-.5<=this.g&&this.g<255.5&&-.5<=this.b&&this.b<255.5&&0<=this.opacity&&this.opacity<=1},hex:ol,formatHex:ol,formatHex8:oh,formatRgb:sl,toString:sl}));function ol(){return`#${wr(this.r)}${wr(this.g)}${wr(this.b)}`}function oh(){return`#${wr(this.r)}${wr(this.g)}${wr(this.b)}${wr((isNaN(this.opacity)?1:this.opacity)*255)}`}function sl(){const t=si(this.opacity);return`${t===1?"rgb(":"rgba("}${Pr(this.r)}, ${Pr(this.g)}, ${Pr(this.b)}${t===1?")":`, ${t})`}`}function si(t){return isNaN(t)?1:Math.max(0,Math.min(1,t))}function Pr(t){return Math.max(0,Math.min(255,Math.round(t)||0))}function wr(t){return t=Pr(t),(t<16?"0":"")+t.toString(16)}function ll(t,e,n,a){return a<=0?t=e=n=NaN:n<=0||n>=1?t=e=NaN:e<=0&&(t=NaN),new Jn(t,e,n,a)}function cl(t){if(t instanceof Jn)return new Jn(t.h,t.s,t.l,t.opacity);if(t instanceof Aa||(t=Cr(t)),!t)return new Jn;if(t instanceof Jn)return t;t=t.rgb();var e=t.r/255,n=t.g/255,a=t.b/255,i=Math.min(e,n,a),o=Math.max(e,n,a),s=NaN,l=o-i,c=(o+i)/2;return l?(e===o?s=(n-a)/l+(n0&&c<1?0:s,new Jn(s,l,c,t.opacity)}function sh(t,e,n,a){return arguments.length===1?cl(t):new Jn(t,e,n,a==null?1:a)}function Jn(t,e,n,a){this.h=+t,this.s=+e,this.l=+n,this.opacity=+a}fo(Jn,sh,el(Aa,{brighter(t){return t=t==null?ai:Math.pow(ai,t),new Jn(this.h,this.s,this.l*t,this.opacity)},darker(t){return t=t==null?Ea:Math.pow(Ea,t),new Jn(this.h,this.s,this.l*t,this.opacity)},rgb(){var t=this.h%360+(this.h<0)*360,e=isNaN(t)||isNaN(this.s)?0:this.s,n=this.l,a=n+(n<.5?n:1-n)*e,i=2*n-a;return new Dn(ho(t>=240?t-240:t+120,i,a),ho(t,i,a),ho(t<120?t+240:t-120,i,a),this.opacity)},clamp(){return new Jn(ul(this.h),li(this.s),li(this.l),si(this.opacity))},displayable(){return(0<=this.s&&this.s<=1||isNaN(this.s))&&0<=this.l&&this.l<=1&&0<=this.opacity&&this.opacity<=1},formatHsl(){const t=si(this.opacity);return`${t===1?"hsl(":"hsla("}${ul(this.h)}, ${li(this.s)*100}%, ${li(this.l)*100}%${t===1?")":`, ${t})`}`}}));function ul(t){return t=(t||0)%360,t<0?t+360:t}function li(t){return Math.max(0,Math.min(1,t||0))}function ho(t,e,n){return(t<60?e+(n-e)*t/60:t<180?n:t<240?e+(n-e)*(240-t)/60:e)*255}function fl(t,e,n,a,i){var o=t*t,s=o*t;return((1-3*t+3*o-s)*e+(4-6*o+3*s)*n+(1+3*t+3*o-3*s)*a+s*i)/6}function lh(t){var e=t.length-1;return function(n){var a=n<=0?n=0:n>=1?(n=1,e-1):Math.floor(n*e),i=t[a],o=t[a+1],s=a>0?t[a-1]:2*i-o,l=a()=>t;function dl(t,e){return function(n){return t+n*e}}function uh(t,e,n){return t=Math.pow(t,n),e=Math.pow(e,n)-t,n=1/n,function(a){return Math.pow(t+a*e,n)}}function W0(t,e){var n=e-t;return n?dl(t,n>180||n<-180?n-360*Math.round(n/360):n):ci(isNaN(t)?e:t)}function fh(t){return(t=+t)==1?hl:function(e,n){return n-e?uh(e,n,t):ci(isNaN(e)?n:e)}}function hl(t,e){var n=e-t;return n?dl(t,n):ci(isNaN(t)?e:t)}var ui=function t(e){var n=fh(e);function a(i,o){var s=n((i=oi(i)).r,(o=oi(o)).r),l=n(i.g,o.g),c=n(i.b,o.b),f=hl(i.opacity,o.opacity);return function(g){return i.r=s(g),i.g=l(g),i.b=c(g),i.opacity=f(g),i+""}}return a.gamma=t,a}(1);function gl(t){return function(e){var n=e.length,a=new Array(n),i=new Array(n),o=new Array(n),s,l;for(s=0;sn&&(o=e.slice(n,o),l[s]?l[s]+=o:l[++s]=o),(a=a[0])===(i=i[0])?l[s]?l[s]+=i:l[++s]=i:(l[++s]=null,c.push({i:s,x:Qn(a,i)})),n=vo.lastIndex;return n=0&&t._call.call(void 0,e),t=t._next;--kr}function Sl(){Mr=(di=Ca.now())+hi,kr=Ra=0;try{yh()}finally{kr=0,Th(),Mr=0}}function xh(){var t=Ca.now(),e=t-di;e>xl&&(hi-=e,di=t)}function Th(){for(var t,e=fi,n,a=1/0;e;)e._call?(a>e._time&&(a=e._time),t=e,e=e._next):(n=e._next,e._next=null,e=t?t._next=n:fi=n);Oa=t,mo(a)}function mo(t){if(!kr){Ra&&(Ra=clearTimeout(Ra));var e=t-Mr;e>24?(t<1/0&&(Ra=setTimeout(Sl,t-Ca.now()-hi)),Ia&&(Ia=clearInterval(Ia))):(Ia||(di=Ca.now(),Ia=setInterval(xh,xl)),kr=1,Tl(Sl))}}function Al(t,e,n){var a=new gi;return e=e==null?0:+e,a.restart(i=>{a.stop(),t(i+e)},e,n),a}var $h=ri("start","end","cancel","interrupt"),Sh=[],El=0,bl=1,yo=2,vi=3,Rl=4,xo=5,pi=6;function mi(t,e,n,a,i,o){var s=t.__transition;if(!s)t.__transition={};else if(n in s)return;Ah(t,n,{name:e,index:a,group:i,on:$h,tween:Sh,time:o.time,delay:o.delay,duration:o.duration,ease:o.ease,timer:null,state:El})}function To(t,e){var n=kn(t,e);if(n.state>El)throw new Error("too late; already scheduled");return n}function er(t,e){var n=kn(t,e);if(n.state>vi)throw new Error("too late; already running");return n}function kn(t,e){var n=t.__transition;if(!n||!(n=n[e]))throw new Error("transition not found");return n}function Ah(t,e,n){var a=t.__transition,i;a[e]=n,n.timer=$l(o,0,n.time);function o(f){n.state=bl,n.timer.restart(s,n.delay,n.time),n.delay<=f&&s(f-n.delay)}function s(f){var g,v,m,S;if(n.state!==bl)return c();for(g in a)if(S=a[g],S.name===n.name){if(S.state===vi)return Al(s);S.state===Rl?(S.state=pi,S.timer.stop(),S.on.call("interrupt",t,t.__data__,S.index,S.group),delete a[g]):+gyo&&a.state180?g+=360:g-f>180&&(f+=360),m.push({i:v.push(i(v)+"rotate(",null,a)-2,x:Qn(f,g)})):g&&v.push(i(v)+"rotate("+g+a)}function l(f,g,v,m){f!==g?m.push({i:v.push(i(v)+"skewX(",null,a)-2,x:Qn(f,g)}):g&&v.push(i(v)+"skewX("+g+a)}function c(f,g,v,m,S,P){if(f!==v||g!==m){var N=S.push(i(S)+"scale(",null,",",null,")");P.push({i:N-4,x:Qn(f,v)},{i:N-2,x:Qn(g,m)})}else(v!==1||m!==1)&&S.push(i(S)+"scale("+v+","+m+")")}return function(f,g){var v=[],m=[];return f=t(f),g=t(g),o(f.translateX,f.translateY,g.translateX,g.translateY,v,m),s(f.rotate,g.rotate,v,m),l(f.skewX,g.skewX,v,m),c(f.scaleX,f.scaleY,g.scaleX,g.scaleY,v,m),f=g=null,function(S){for(var P=-1,N=m.length,L;++P=0&&(e=e.slice(0,n)),!e||e==="start"})}function rg(t,e,n){var a,i,o=ng(e)?To:er;return function(){var s=o(this,t),l=s.on;l!==a&&(i=(a=l).copy()).on(e,n),s.on=i}}function ag(t,e){var n=this._id;return arguments.length<2?kn(this.node(),n).on.on(t):this.each(rg(n,t,e))}function ig(t){return function(){var e=this.parentNode;for(var n in this.__transition)if(+n!==t)return;e&&e.removeChild(this)}}function og(){return this.on("end.remove",ig(this._id))}function sg(t){var e=this._name,n=this._id;typeof t!="function"&&(t=p(t));for(var a=this._groups,i=a.length,o=new Array(i),s=0;s()=>t;function Mg(t,{sourceEvent:e,target:n,selection:a,mode:i,dispatch:o}){Object.defineProperties(this,{type:{value:t,enumerable:!0,configurable:!0},sourceEvent:{value:e,enumerable:!0,configurable:!0},target:{value:n,enumerable:!0,configurable:!0},selection:{value:a,enumerable:!0,configurable:!0},mode:{value:i,enumerable:!0,configurable:!0},_:{value:o}})}function Dg(t){t.stopImmediatePropagation()}function Eo(t){t.preventDefault(),t.stopImmediatePropagation()}var Ll={name:"drag"},bo={name:"space"},_r={name:"handle"},ta={name:"center"};const{abs:Nl,max:Sn,min:An}=Math;function Fl(t){return[+t[0],+t[1]]}function Ro(t){return[Fl(t[0]),Fl(t[1])]}var xi={name:"x",handles:["w","e"].map(Pa),input:function(t,e){return t==null?null:[[+t[0],e[0][1]],[+t[1],e[1][1]]]},output:function(t){return t&&[t[0][0],t[1][0]]}},Ti={name:"y",handles:["n","s"].map(Pa),input:function(t,e){return t==null?null:[[e[0][0],+t[0]],[e[1][0],+t[1]]]},output:function(t){return t&&[t[0][1],t[1][1]]}},Lg={name:"xy",handles:["n","w","e","s","nw","ne","sw","se"].map(Pa),input:function(t){return t==null?null:Ro(t)},output:function(t){return t}},hr={overlay:"crosshair",selection:"move",n:"ns-resize",e:"ew-resize",s:"ns-resize",w:"ew-resize",nw:"nwse-resize",ne:"nesw-resize",se:"nwse-resize",sw:"nesw-resize"},Bl={e:"w",w:"e",nw:"ne",ne:"nw",se:"sw",sw:"se"},Ul={n:"s",s:"n",nw:"sw",ne:"se",se:"ne",sw:"nw"},Ng={overlay:1,selection:1,n:null,e:1,s:null,w:-1,nw:-1,ne:1,se:1,sw:-1},Fg={overlay:1,selection:1,n:-1,e:null,s:1,w:null,nw:-1,ne:-1,se:1,sw:1};function Pa(t){return{type:t}}function Bg(t){return!t.ctrlKey&&!t.button}function Ug(){var t=this.ownerSVGElement||this;return t.hasAttribute("viewBox")?(t=t.viewBox.baseVal,[[t.x,t.y],[t.x+t.width,t.y+t.height]]):[[0,0],[t.width.baseVal.value,t.height.baseVal.value]]}function zg(){return navigator.maxTouchPoints||"ontouchstart"in this}function Io(t){for(;!t.__brush;)if(!(t=t.parentNode))return;return t.__brush}function jg(t){return t[0][0]===t[1][0]||t[0][1]===t[1][1]}function zl(t){var e=t.__brush;return e?e.dim.output(e.selection):null}function Vg(){return Oo(xi)}function Gg(){return Oo(Ti)}function q0(){return Oo(Lg)}function Oo(t){var e=Ug,n=Bg,a=zg,i=!0,o=ri("start","brush","end"),s=6,l;function c(L){var w=L.property("__brush",N).selectAll(".overlay").data([Pa("overlay")]);w.enter().append("rect").attr("class","overlay").attr("pointer-events","all").attr("cursor",hr.overlay).merge(w).each(function(){var W=Io(this).extent;ot(this).attr("x",W[0][0]).attr("y",W[0][1]).attr("width",W[1][0]-W[0][0]).attr("height",W[1][1]-W[0][1])}),L.selectAll(".selection").data([Pa("selection")]).enter().append("rect").attr("class","selection").attr("cursor",hr.selection).attr("fill","#777").attr("fill-opacity",.3).attr("stroke","#fff").attr("shape-rendering","crispEdges");var X=L.selectAll(".handle").data(t.handles,function(W){return W.type});X.exit().remove(),X.enter().append("rect").attr("class",function(W){return"handle handle--"+W.type}).attr("cursor",function(W){return hr[W.type]}),L.each(f).attr("fill","none").attr("pointer-events","all").on("mousedown.brush",m).filter(a).on("touchstart.brush",m).on("touchmove.brush",S).on("touchend.brush touchcancel.brush",P).style("touch-action","none").style("-webkit-tap-highlight-color","rgba(0,0,0,0)")}c.move=function(L,w,X){L.tween?L.on("start.brush",function(W){g(this,arguments).beforestart().start(W)}).on("interrupt.brush end.brush",function(W){g(this,arguments).end(W)}).tween("brush",function(){var W=this,H=W.__brush,k=g(W,arguments),K=H.selection,at=t.input(typeof w=="function"?w.apply(this,arguments):w,H.extent),ht=Qr(K,at);function $t(dt){H.selection=dt===1&&at===null?null:ht(dt),f.call(W),k.brush()}return K!==null&&at!==null?$t:$t(1)}):L.each(function(){var W=this,H=arguments,k=W.__brush,K=t.input(typeof w=="function"?w.apply(W,H):w,k.extent),at=g(W,H).beforestart();qr(W),k.selection=K===null?null:K,f.call(W),at.start(X).brush(X).end(X)})},c.clear=function(L,w){c.move(L,null,w)};function f(){var L=ot(this),w=Io(this).selection;w?(L.selectAll(".selection").style("display",null).attr("x",w[0][0]).attr("y",w[0][1]).attr("width",w[1][0]-w[0][0]).attr("height",w[1][1]-w[0][1]),L.selectAll(".handle").style("display",null).attr("x",function(X){return X.type[X.type.length-1]==="e"?w[1][0]-s/2:w[0][0]-s/2}).attr("y",function(X){return X.type[0]==="s"?w[1][1]-s/2:w[0][1]-s/2}).attr("width",function(X){return X.type==="n"||X.type==="s"?w[1][0]-w[0][0]+s:s}).attr("height",function(X){return X.type==="e"||X.type==="w"?w[1][1]-w[0][1]+s:s})):L.selectAll(".selection,.handle").style("display","none").attr("x",null).attr("y",null).attr("width",null).attr("height",null)}function g(L,w,X){var W=L.__brush.emitter;return W&&(!X||!W.clean)?W:new v(L,w,X)}function v(L,w,X){this.that=L,this.args=w,this.state=L.__brush,this.active=0,this.clean=X}v.prototype={beforestart:function(){return++this.active===1&&(this.state.emitter=this,this.starting=!0),this},start:function(L,w){return this.starting?(this.starting=!1,this.emit("start",L,w)):this.emit("brush",L),this},brush:function(L,w){return this.emit("brush",L,w),this},end:function(L,w){return--this.active===0&&(delete this.state.emitter,this.emit("end",L,w)),this},emit:function(L,w,X){var W=ot(this.that).datum();o.call(L,this.that,new Mg(L,{sourceEvent:w,target:c,selection:t.output(this.state.selection),mode:X,dispatch:o}),W)}};function m(L){if(l&&!L.touches||!n.apply(this,arguments))return;var w=this,X=L.target.__data__.type,W=(i&&L.metaKey?X="overlay":X)==="selection"?Ll:i&&L.altKey?ta:_r,H=t===Ti?null:Ng[X],k=t===xi?null:Fg[X],K=Io(w),at=K.extent,ht=K.selection,$t=at[0][0],dt,st,Vt=at[0][1],vt,Q,St=at[1][0],ct,At,Gt=at[1][1],Bt,Kt,ne=0,le=0,be,Oe=H&&k&&i&&L.shiftKey,Ce,He,Fe=Array.from(L.touches||[L],pe=>{const fn=pe.identifier;return pe=Xn(pe,w),pe.point0=pe.slice(),pe.identifier=fn,pe});qr(w);var dn=g(w,arguments,!0).beforestart();if(X==="overlay"){ht&&(be=!0);const pe=[Fe[0],Fe[1]||Fe[0]];K.selection=ht=[[dt=t===Ti?$t:An(pe[0][0],pe[1][0]),vt=t===xi?Vt:An(pe[0][1],pe[1][1])],[ct=t===Ti?St:Sn(pe[0][0],pe[1][0]),Bt=t===xi?Gt:Sn(pe[0][1],pe[1][1])]],Fe.length>1&&un(L)}else dt=ht[0][0],vt=ht[0][1],ct=ht[1][0],Bt=ht[1][1];st=dt,Q=vt,At=ct,Kt=Bt;var Jt=ot(w).attr("pointer-events","none"),xe=Jt.selectAll(".overlay").attr("cursor",hr[X]);if(L.touches)dn.moved=Lt,dn.ended=Ge;else{var Re=ot(L.view).on("mousemove.brush",Lt,!0).on("mouseup.brush",Ge,!0);i&&Re.on("keydown.brush",Pn,!0).on("keyup.brush",wn,!0),co(L.view)}f.call(w),dn.start(L,W.name);function Lt(pe){for(const fn of pe.changedTouches||[pe])for(const Ga of Fe)Ga.identifier===fn.identifier&&(Ga.cur=Xn(fn,w));if(Oe&&!Ce&&!He&&Fe.length===1){const fn=Fe[0];Nl(fn.cur[0]-fn[0])>Nl(fn.cur[1]-fn[1])?He=!0:Ce=!0}for(const fn of Fe)fn.cur&&(fn[0]=fn.cur[0],fn[1]=fn.cur[1]);be=!0,Eo(pe),un(pe)}function un(pe){const fn=Fe[0],Ga=fn.point0;var br;switch(ne=fn[0]-Ga[0],le=fn[1]-Ga[1],W){case bo:case Ll:{H&&(ne=Sn($t-dt,An(St-ct,ne)),st=dt+ne,At=ct+ne),k&&(le=Sn(Vt-vt,An(Gt-Bt,le)),Q=vt+le,Kt=Bt+le);break}case _r:{Fe[1]?(H&&(st=Sn($t,An(St,Fe[0][0])),At=Sn($t,An(St,Fe[1][0])),H=1),k&&(Q=Sn(Vt,An(Gt,Fe[0][1])),Kt=Sn(Vt,An(Gt,Fe[1][1])),k=1)):(H<0?(ne=Sn($t-dt,An(St-dt,ne)),st=dt+ne,At=ct):H>0&&(ne=Sn($t-ct,An(St-ct,ne)),st=dt,At=ct+ne),k<0?(le=Sn(Vt-vt,An(Gt-vt,le)),Q=vt+le,Kt=Bt):k>0&&(le=Sn(Vt-Bt,An(Gt-Bt,le)),Q=vt,Kt=Bt+le));break}case ta:{H&&(st=Sn($t,An(St,dt-ne*H)),At=Sn($t,An(St,ct+ne*H))),k&&(Q=Sn(Vt,An(Gt,vt-le*k)),Kt=Sn(Vt,An(Gt,Bt+le*k)));break}}At0&&(dt=st-ne),k<0?Bt=Kt-le:k>0&&(vt=Q-le),W=bo,xe.attr("cursor",hr.selection),un(pe));break}default:return}Eo(pe)}function wn(pe){switch(pe.keyCode){case 16:{Oe&&(Ce=He=Oe=!1,un(pe));break}case 18:{W===ta&&(H<0?ct=At:H>0&&(dt=st),k<0?Bt=Kt:k>0&&(vt=Q),W=_r,un(pe));break}case 32:{W===bo&&(pe.altKey?(H&&(ct=At-ne*H,dt=st+ne*H),k&&(Bt=Kt-le*k,vt=Q+le*k),W=ta):(H<0?ct=At:H>0&&(dt=st),k<0?Bt=Kt:k>0&&(vt=Q),W=_r),xe.attr("cursor",hr[X]),un(pe));break}default:return}Eo(pe)}}function S(L){g(this,arguments).moved(L)}function P(L){g(this,arguments).ended(L)}function N(){var L=this.__brush||{selection:null};return L.extent=Ro(e.apply(this,arguments)),L.dim=t,L}return c.extent=function(L){return arguments.length?(e=typeof L=="function"?L:Ao(Ro(L)),c):e},c.filter=function(L){return arguments.length?(n=typeof L=="function"?L:Ao(!!L),c):n},c.touchable=function(L){return arguments.length?(a=typeof L=="function"?L:Ao(!!L),c):a},c.handleSize=function(L){return arguments.length?(s=+L,c):s},c.keyModifiers=function(L){return arguments.length?(i=!!L,c):i},c.on=function(){var L=o.on.apply(o,arguments);return L===o?c:L},c}function Xg(){return typeof globalThis=="object"&&globalThis!==null&&globalThis.Object===Object&&globalThis||typeof global=="object"&&global!==null&&global.Object===Object&&global||typeof self=="object"&&self!==null&&self.Object===Object&&self||Function("return this")()}function Hg(t){const e=typeof(t==null?void 0:t.requestAnimationFrame)=="function"&&typeof(t==null?void 0:t.cancelAnimationFrame)=="function",n=typeof(t==null?void 0:t.requestIdleCallback)=="function"&&typeof(t==null?void 0:t.cancelIdleCallback)=="function",a=o=>setTimeout(o,1),i=o=>clearTimeout(o);return[e?t.requestAnimationFrame:a,e?t.cancelAnimationFrame:i,n?t.requestIdleCallback:a,n?t.cancelIdleCallback:i]}const Ke=Xg(),gn=Ke==null?void 0:Ke.document,[Yg,_0,jl,t1]=Hg(Ke);var Wg=Object.defineProperty,Vl=Object.getOwnPropertySymbols,Kg=Object.prototype.hasOwnProperty,Zg=Object.prototype.propertyIsEnumerable,Gl=(t,e,n)=>e in t?Wg(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,Xl=(t,e)=>{for(var n in e||(e={}))Kg.call(e,n)&&Gl(t,n,e[n]);if(Vl)for(var n of Vl(e))Zg.call(e,n)&&Gl(t,n,e[n]);return t};const De=t=>t||t===0,ve=t=>typeof t=="function",ze=t=>typeof t=="string",he=t=>typeof t=="number",ln=t=>typeof t=="undefined",Qe=t=>typeof t!="undefined",Co=t=>typeof t=="boolean",Jg=t=>Math.ceil(t/10)*10,$i=t=>Math.ceil(t)+.5,Dr=t=>t[1]-t[0],nr=t=>typeof t=="object",qn=t=>ln(t)||t===null||ze(t)&&t.length===0||nr(t)&&!(t instanceof Date)&&Object.keys(t).length===0||he(t)&&isNaN(t),cn=t=>!qn(t),je=t=>Array.isArray(t),Be=t=>t&&!(t!=null&&t.nodeType)&&nr(t)&&!je(t);function $r(t,e,n){return Qe(t[e])?t[e]:n}function Qg(t,e){let n=!1;return Object.keys(t).forEach(a=>t[a]===e&&(n=!0)),n}function _e(t,e,...n){const a=ve(t);return a&&t.call(e,...n),a}function Si(t,e){let n=0;const a=function(...i){!--n&&e.apply(this,...i)};"duration"in t?t.each(()=>++n).on("end",a):(++n,t.call(a))}function Po(t){return ze(t)?t.replace(/<(script|img)?/ig,"<").replace(/(script)?>/ig,">"):t}function wa(t,e,n=[-1,1],a=!1){if(!(!t||!ze(e)))if(e.indexOf(` -`)===-1)t.text(e);else{const i=[t.text(),e].map(o=>o.replace(/[\s\n]/g,""));if(i[0]!==i[1]){const o=e.split(` -`),s=a?o.length-1:1;t.html(""),o.forEach((l,c)=>{t.append("tspan").attr("x",0).attr("dy",`${c===0?n[0]*s:n[1]}em`).text(l)})}}}function Hl(t){const{x:e,y:n,width:a,height:i}=t.getBBox();return[{x:e,y:n+i},{x:e,y:n},{x:e+a,y:n},{x:e+a,y:n+i}]}function Yl(t){const{width:e,height:n}=t.getBoundingClientRect(),a=Hl(t),i=a[0].x,o=Math.min(a[0].y,a[1].y);return{x:i,y:o,width:e,height:n}}function Hn(t,e){var n;const a=t&&((n=t.touches||t.sourceEvent&&t.sourceEvent.touches)==null?void 0:n[0]);let i=[0,0];try{i=Xn(a||t,e)}catch(o){}return i.map(o=>isNaN(o)?0:o)}function Wl(t){const{event:e,$el:n}=t,a=n.subchart.main||n.main;let i;return e&&e.type==="brush"?i=e.selection:a&&(i=a.select(".bb-brush").node())&&(i=zl(i)),i}function Ma(t){return!("rect"in t)||"rect"in t&&t.hasAttribute("width")&&t.rect.width!==+t.getAttribute("width")?t.rect=t.getBoundingClientRect():t.rect}function gr(t=!0,e=0,n=1e4){const a=Ke.crypto||Ke.msCrypto,i=a?e+a.getRandomValues(new Uint32Array(1))[0]%(n-e+1):Math.floor(Math.random()*(n-e)+e);return t?String(i):i}function wo(t,e,n,a,i){if(n>a)return-1;const o=Math.floor((n+a)/2);let{x:s,w:l=0}=t[o];return i&&(s=t[o].y,l=t[o].h),e>=s&&e<=s+l?o:e{if(Be(n)&&n.constructor){const a=new n.constructor;for(const i in n)a[i]=e(n[i]);return a}return n};return t.map(n=>e(n)).reduce((n,a)=>Xl(Xl({},n),a))}function yn(t={},e){je(e)&&e.forEach(n=>yn(t,n));for(const n in e)/^\d+$/.test(n)||n in t||(t[n]=e[n]);return t}const Cn=t=>t.charAt(0).toUpperCase()+t.slice(1);function qg(t,e="-"){return t.split(e).map((n,a)=>a?n.charAt(0).toUpperCase()+n.slice(1).toLowerCase():n.toLowerCase()).join("")}const Lr=t=>[].slice.call(t);function _g(t,e,n){const{rootSelector:a="",sheet:i}=t,s=`${a} ${(l=>l.replace(/\s?(bb-)/g,".$1").replace(/\.+/g,"."))(e)} {${n.join(";")}}`;return i[i.insertRule?"insertRule":"addRule"](s,i.cssRules.length)}function tv(t){let e=[];return t.forEach(n=>{var a;try{n.cssRules&&n.cssRules.length&&(e=e.concat(Lr(n.cssRules)))}catch(i){(a=Ke.console)==null||a.warn(`Error while reading rules from ${n.href}: ${i.toString()}`)}}),e}function Zl(t){var e,n,a,i,o,s;return{x:((n=(e=Ke.pageXOffset)!=null?e:Ke.scrollX)!=null?n:0)+((a=t.scrollLeft)!=null?a:0),y:((o=(i=Ke.pageYOffset)!=null?i:Ke.scrollY)!=null?o:0)+((s=t.scrollTop)!=null?s:0)}}function Ai(t,e=0,n=0,a=!0){const i=new DOMPoint(e,n),o=t.getScreenCTM(),s=i.matrixTransform(a?o==null?void 0:o.inverse():o);if(a===!1){const l=t.getBoundingClientRect();s.x-=l.x,s.y-=l.y}return s}function Jl(t){const e=t?t.transform:null,n=e&&e.baseVal;return n&&n.numberOfItems?n.getItem(0).matrix:{a:0,b:0,c:0,d:0,e:0,f:0}}function Mo(t){const e=t[0]instanceof Date,n=(e?t.map(Number):t).filter((a,i,o)=>o.indexOf(a)===i);return e?n.map(a=>new Date(a)):n}function Do(t){return t&&t.length?t.reduce((e,n)=>e.concat(n)):[]}function ea(t,...e){if(!e.length||e.length===1&&!e[0])return t;const n=e.shift();return Be(t)&&Be(n)&&Object.keys(n).forEach(a=>{if(!/^(__proto__|constructor|prototype)$/i.test(a)){const i=n[a];Be(i)?(!t[a]&&(t[a]={}),t[a]=ea(t[a],i)):t[a]=je(i)?i.concat():i}}),ea(t,...e)}function na(t,e=!0){let n;return t[0]instanceof Date?n=e?(a,i)=>a-i:(a,i)=>i-a:e&&!t.every(isNaN)?n=(a,i)=>a-i:e||(n=(a,i)=>a>i&&-1||acn(a));return n.length?he(n[0])?n=Math[t](...n):n[0]instanceof Date&&(n=na(n,t==="min")[0]):n=void 0,n}const Ei=(t,e,n=1)=>{const a=[],i=Math.max(0,Math.ceil((e-t)/n))|0;for(let o=t;o{const t=()=>({bubbles:!1,cancelable:!1,screenX:0,screenY:0,clientX:0,clientY:0});try{return new MouseEvent("t"),(e,n,a=t())=>{e.dispatchEvent(new MouseEvent(n,a))}}catch(e){return(n,a,i=t())=>{const o=gn.createEvent("MouseEvent");o.initMouseEvent(a,i.bubbles,i.cancelable,Ke,0,i.screenX,i.screenY,i.clientX,i.clientY,!1,!1,!1,!1,0,null),n.dispatchEvent(o)}}})(),touch:(t,e,n)=>{const a=new Touch(ea({identifier:Date.now(),target:t,radiusX:2.5,radiusY:2.5,rotationAngle:10,force:.5},n));t.dispatchEvent(new TouchEvent(e,{cancelable:!0,bubbles:!0,shiftKey:!0,touches:[a],targetTouches:[],changedTouches:[a]}))}};function bi(t,e){let n=t;for(const a in e)n=n.replace(new RegExp(`{=${a}}`,"g"),e[a]);return n}function Yn(t){var e;let n;if(t instanceof Date)n=t;else if(ze(t)){const{config:a,format:i}=this;n=(e=i.dataTime(a.data_xFormat)(t))!=null?e:new Date(t)}else he(t)&&!isNaN(t)&&(n=new Date(+t));return(!n||isNaN(+n))&&console&&console.error&&console.error(`Failed to parse x '${t}' to Date object`),n}function Lo(t){const e=t.attr("viewBox");return e?/(\d+(\.\d+)?){3}/.test(e):!1}function nv(t,e,n=!1){const a=!!t.node;let i=!1;for(const[o,s]of Object.entries(e))if(i=a?t.style(o)===s:t.style[o]===s,n===!1&&i)break;return i}function Da(){var t,e;return((t=gn)==null?void 0:t.hidden)===!1||((e=gn)==null?void 0:e.visibilityState)==="visible"}function rv(t,e){const{DocumentTouch:n,matchMedia:a,navigator:i}=Ke,o=a==null?void 0:a("(pointer:coarse)").matches;let s=!1;if(e)if(i&&"maxTouchPoints"in i)s=i.maxTouchPoints>0;else if("ontouchmove"in Ke||n&&gn instanceof n)s=!0;else if(o)s=!0;else{const c=i.userAgent;s=/\b(BlackBerry|webOS|iPhone|IEMobile)\b/i.test(c)||/\b(Android|Windows Phone|iPad|iPod)\b/i.test(c)}return t&&!o&&(a==null?void 0:a("(pointer:fine)").matches)&&"mouse"||s&&"touch"||"mouse"}function Ql(t,e){e()===!1?Yg(()=>Ql(t,e)):t()}var av=Object.defineProperty,kl=Object.getOwnPropertySymbols,iv=Object.prototype.hasOwnProperty,ov=Object.prototype.propertyIsEnumerable,No=(t,e,n)=>e in t?av(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,ql=(t,e)=>{for(var n in e||(e={}))iv.call(e,n)&&No(t,n,e[n]);if(kl)for(var n of kl(e))ov.call(e,n)&&No(t,n,e[n]);return t},sv=(t,e,n)=>No(t,typeof e!="symbol"?e+"":e,n);const _l=class bf{static setOptions(e){this.data=e.reduce((n,a)=>ql(ql({},n),a),this.data)}constructor(){return kg(Vd,Ud,Hd,zd,Yd,jd,Gd,Xd,bf.data)}};sv(_l,"data",{});let Nr=_l;class lv{constructor(){return{chart:null,main:null,svg:null,axis:{x:null,y:null,y2:null,subX:null},axisTooltip:{x:null,y:null,y2:null},defs:null,tooltip:null,legend:null,title:null,subchart:{main:null,bar:null,line:null,area:null},arcs:null,bar:null,candlestick:null,line:null,area:null,circle:null,radar:null,text:null,grid:{main:null,x:null,y:null},gridLines:{main:null,x:null,y:null},region:{main:null,list:null},eventRect:null,zoomResetBtn:null}}}class cv{constructor(){return{width:0,width2:0,height:0,height2:0,margin:{top:0,bottom:0,left:0,right:0},margin2:{top:0,bottom:0,left:0,right:0},margin3:{top:0,bottom:0,left:0,right:0},arcWidth:0,arcHeight:0,xAxisHeight:0,hasAxis:!1,hasFunnel:!1,hasRadar:!1,hasTreemap:!1,cssRule:{},current:{domain:void 0,width:0,height:0,dataMax:0,maxTickSize:{x:{width:0,height:0,ticks:[],clipPath:0,domain:""},y:{width:0,height:0,domain:""},y2:{width:0,height:0,domain:""}},types:[],needle:void 0},isLegendRight:!1,isLegendInset:!1,isLegendTop:!1,isLegendLeft:!1,legendStep:0,legendItemWidth:0,legendItemHeight:0,legendHasRendered:!1,eventReceiver:{currentIdx:-1,rect:{},data:[],coords:[]},axis:{x:{padding:{left:0,right:0},tickCount:0}},rotatedPadding:{left:30,right:0,top:5},withoutFadeIn:{},inputType:"",datetimeId:"",clip:{id:"",idXAxis:"",idYAxis:"",idXAxisTickTexts:"",idGrid:"",idSubchart:"",path:"",pathXAxis:"",pathYAxis:"",pathXAxisTickTexts:"",pathGrid:""},event:null,dragStart:null,dragging:!1,flowing:!1,cancelClick:!1,mouseover:!1,rendered:!1,transiting:!1,redrawing:!1,resizing:!1,toggling:!1,zooming:!1,hasNegativeValue:!1,hasPositiveValue:!0,orgAreaOpacity:"0.2",orgConfig:{},hiddenTargetIds:[],hiddenLegendIds:[],focusedTargetIds:[],defocusedTargetIds:[],radius:0,innerRadius:0,outerRadius:void 0,innerRadiusRatio:0,gaugeArcWidth:0,radiusExpanded:0,xgridAttr:{x1:null,x2:null,y1:null,y2:null}}}}const tc={element:lv,state:cv};class uv{constructor(){Object.keys(tc).forEach(e=>{this[e]=new tc[e]})}getStore(e){return this[e]}}var fv=Object.defineProperty,dv=(t,e,n)=>e in t?fv(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,hv=(t,e,n)=>dv(t,typeof e!="symbol"?e+"":e,n);const Ln={bubbleBaseLength:"$baseLength",colorPattern:"__colorPattern__",dataMinMax:"$dataMinMax",dataTotalSum:"$dataTotalSum",dataTotalPerIndex:"$totalPerIndex",legendItemTextBox:"legendItemTextBox",radarPoints:"$radarPoints",radarTextWidth:"$radarTextWidth",setOverOut:"setOverOut",callOverOutForTouch:"callOverOutForTouch",textRect:"textRect"};class gv{constructor(){hv(this,"cache",{})}add(e,n,a=!1){return this.cache[e]=a?this.cloneTarget(n):n,this.cache[e]}remove(e){(ze(e)?[e]:e).forEach(n=>delete this.cache[n])}get(e,n=!1){if(n&&Array.isArray(e)){const a=[];for(let i=0,o;o=e[i];i++)o in this.cache&&a.push(this.cloneTarget(this.cache[o]));return a}else{const a=this.cache[e];return De(a)?a:null}}reset(e){const n=this;for(const a in n.cache)(e||/^\$/.test(a))&&(n.cache[a]=null)}cloneTarget(e){return{id:e.id,id_org:e.id_org,values:e.values.map(n=>({x:n.x,value:n.value,id:n.id}))}}}const oe={AREA:"area",AREA_LINE_RANGE:"area-line-range",AREA_SPLINE:"area-spline",AREA_SPLINE_RANGE:"area-spline-range",AREA_STEP:"area-step",AREA_STEP_RANGE:"area-step-range",BAR:"bar",BUBBLE:"bubble",CANDLESTICK:"candlestick",DONUT:"donut",FUNNEL:"funnel",GAUGE:"gauge",LINE:"line",PIE:"pie",POLAR:"polar",RADAR:"radar",SCATTER:"scatter",SPLINE:"spline",STEP:"step",TREEMAP:"treemap"},Fo={AREA:"initArea",AREA_LINE_RANGE:"initArea",AREA_SPLINE:"initArea",AREA_SPLINE_RANGE:"initArea",AREA_STEP:"initArea",AREA_STEP_RANGE:"initArea",BAR:"initBar",BUBBLE:"initCircle",CANDLESTICK:"initCandlestick",DONUT:"initArc",FUNNEL:"initFunnel",GAUGE:"initArc",LINE:"initLine",PIE:"initArc",POLAR:"initPolar",RADAR:"initCircle",SCATTER:"initCircle",SPLINE:"initLine",STEP:"initLine",TREEMAP:"initTreemap"},Sr={Area:[oe.AREA,oe.AREA_SPLINE,oe.AREA_SPLINE_RANGE,oe.AREA_LINE_RANGE,oe.AREA_STEP,oe.AREA_STEP_RANGE],AreaRange:[oe.AREA_SPLINE_RANGE,oe.AREA_LINE_RANGE,oe.AREA_STEP_RANGE],Arc:[oe.PIE,oe.DONUT,oe.GAUGE,oe.POLAR,oe.RADAR],Line:[oe.LINE,oe.SPLINE,oe.AREA,oe.AREA_SPLINE,oe.AREA_SPLINE_RANGE,oe.AREA_LINE_RANGE,oe.STEP,oe.AREA_STEP,oe.AREA_STEP_RANGE],Step:[oe.STEP,oe.AREA_STEP,oe.AREA_STEP_RANGE],Spline:[oe.SPLINE,oe.AREA_SPLINE,oe.AREA_SPLINE_RANGE]};function vv(t){const e=t,{config:n}=e;let a="";if(qn(n.data_type||n.data_types)&&!e[Fo.LINE])a="line";else for(const i in Fo){const o=oe[i];if(e.hasType(o)&&!e[Fo[i]]){a=o;break}}a&&pv(`Please, make sure if %c${qg(a)}`,"module has been imported and specified correctly.","https://github.com/naver/billboard.js/wiki/CHANGELOG-v2#modularization-by-its-functionality")}function pv(t,e,n){var a;const i="[billboard.js]";if((a=Ke.console)==null?void 0:a.error){const s=e?["background:red;color:white;display:block;font-size:15px",e]:[];console.error(`\u274C ${i} ${t}`,"background:red;color:white;display:block;font-size:15px",...s),n&&console.info("%c\u2139\uFE0F","font-size:15px",n)}throw Error(`${i} ${t.replace(/\%c([a-z-]+)/i,"'$1' ")} ${e!=null?e:""}`)}const{setTimeout:mv,clearTimeout:yv}=Ke;function xv(t){const e=[];let n;const a=function(){a.clear(),t===!1?jl(()=>{e.forEach(i=>i())},{timeout:200}):n=mv(()=>{e.forEach(i=>i())},he(t)?t:200)};return a.clear=()=>{n&&(yv(n),n=null)},a.add=i=>e.push(i),a.remove=i=>e.splice(e.indexOf(i),1),a}function ec(){let t=[];const e=function(n,a){function i(){var o;let s=0;for(let l=0,c;c=t[l];l++){if(c===!0||(o=c.empty)!=null&&o.call(c)){s++;continue}if(Da()===!1){s=t.length;break}try{c.transition()}catch(f){s++}}return s===t.length}Ql(()=>{a==null||a()},i)};return e.add=function(n){je(n)?t=t.concat(n):t.push(n)},e}const Bo={};function Tv(t,e){var n;const a=t.toString(),i=a.replace(/(function|[\s\W\n])/g,"").substring(0,15);return i in Bo||(Bo[i]=new Ke.Blob([`${(n=e==null?void 0:e.map(String).join(";"))!=null?n:""} - - self.onmessage=function({data}) { - const result = (${a}).apply(null, data); - self.postMessage(result); - };`],{type:"text/javascript"})),Ke.URL.createObjectURL(Bo[i])}function $v(t){const e=new Ke.Worker(t);return e.onerror=function(n){console.error?console.error(n):console.log(n)},e}function Uo(t=!0,e,n,a){let i=function(...o){const s=e(...o);n(s)};if(Ke.Worker&&t){const o=Tv(e,a),s=$v(o);i=function(...l){s.postMessage(l),s.onmessage=function(c){return Ke.URL.revokeObjectURL(o),n(c.data)}}}return i}var nc={},zo={},jo=34,La=10,Vo=13;function rc(t){return new Function("d","return {"+t.map(function(e,n){return JSON.stringify(e)+": d["+n+'] || ""'}).join(",")+"}")}function Sv(t,e){var n=rc(t);return function(a,i){return e(n(a),i,t)}}function ac(t){var e=Object.create(null),n=[];return t.forEach(function(a){for(var i in a)i in e||n.push(e[i]=i)}),n}function Nn(t,e){var n=t+"",a=n.length;return a9999?"+"+Nn(t,6):Nn(t,4)}function Ev(t){var e=t.getUTCHours(),n=t.getUTCMinutes(),a=t.getUTCSeconds(),i=t.getUTCMilliseconds();return isNaN(t)?"Invalid Date":Av(t.getUTCFullYear(),4)+"-"+Nn(t.getUTCMonth()+1,2)+"-"+Nn(t.getUTCDate(),2)+(i?"T"+Nn(e,2)+":"+Nn(n,2)+":"+Nn(a,2)+"."+Nn(i,3)+"Z":a?"T"+Nn(e,2)+":"+Nn(n,2)+":"+Nn(a,2)+"Z":n||e?"T"+Nn(e,2)+":"+Nn(n,2)+"Z":"")}function ic(t){var e=new RegExp('["'+t+` -\r]`),n=t.charCodeAt(0);function a(v,m){var S,P,N=i(v,function(L,w){if(S)return S(L,w-1);P=L,S=m?Sv(L,m):rc(L)});return N.columns=P||[],N}function i(v,m){var S=[],P=v.length,N=0,L=0,w,X=P<=0,W=!1;v.charCodeAt(P-1)===La&&--P,v.charCodeAt(P-1)===Vo&&--P;function H(){if(X)return zo;if(W)return W=!1,nc;var K,at=N,ht;if(v.charCodeAt(at)===jo){for(;N++=P?X=!0:(ht=v.charCodeAt(N++))===La?W=!0:ht===Vo&&(W=!0,v.charCodeAt(N)===La&&++N),v.slice(at+1,K-1).replace(/""/g,'"')}for(;N0){if(typeof e[s-1]=="undefined"&&(e[s-1]={}),typeof o=="undefined")throw new Error(`Source data is missing a component at (${a}, ${s})!`);e[s-1][i]=o}})}),e}function Xo(t){const e=t[0],n=[];return t.forEach(function(a,i){if(i>0){const o={};a.forEach(function(s,l){if(typeof s=="undefined")throw new Error(`Source data is missing a component at (${i}, ${l})!`);o[e[l]]=s}),n.push(o)}}),n}function oc(t,e){const n=[];let a,i;if(Array.isArray(t)){const o=function(s,l){if(s[l]!==void 0)return s[l];const f=l.replace(/\[(\w+)\]/g,".$1").replace(/^\./,"").split(".");let g=s;return f.some(function(v){return!(g=g&&v in g?g[v]:void 0)}),g};e.x?a=e.value.concat(e.x):a=e.value,n.push(a),t.forEach(function(s){const l=a.map(function(c){let f=o(s,c);return typeof f=="undefined"&&(f=null),f});n.push(l)}),i=Xo(n)}else Object.keys(t).forEach(function(o){var s;const l=t[o].concat();(s=l.unshift)==null||s.call(l,o),n.push(l)}),i=Go(n);return i}function Cv(t,e="csv",n,a,i){const o=new XMLHttpRequest,s={csv:Pv,tsv:wv,json:oc};o.open("GET",t),n&&Object.keys(n).forEach(function(l){o.setRequestHeader(l,n[l])}),o.onreadystatechange=function(){if(o.readyState===4)if(o.status===200){const l=o.responseText;l&&i.call(this,s[e](e==="json"?JSON.parse(l):l,a))}else throw new Error(`${t}: Something went wrong loading!`)},o.send()}function sc(t,e){const n=t.rows(e);let a;return n.length===1?(a=[{}],n[0].forEach(i=>{a[0][i]=null})):a=t.parse(e),a}function Pv(t){return sc({rows:Rv,parse:bv},t)}function wv(t){return sc({rows:Ov,parse:Iv},t)}function lc(t,e){const n=t||(e==null?void 0:e.data_keys);return n!=null&&n.x&&(e.data_x=n.x),n}var Mv={convertData(t,e){const{config:n}=this,a=n.boost_useWorker;let i=t;if(t.bindto&&(i={},["url","mimeType","headers","keys","json","keys","rows","columns"].forEach(o=>{const s=`data_${o}`;s in t&&(i[o]=t[s])})),i.url&&e)Cv(i.url,i.mimeType,i.headers,lc(i.keys,n),e);else if(i.json)Uo(a,oc,e,[Go,Xo])(i.json,lc(i.keys,n));else if(i.rows)Uo(a,Xo,e)(i.rows);else if(i.columns)Uo(a,Go,e)(i.columns);else if(t.bindto)throw Error("url or json or rows or columns is required.")},convertDataToTargets(t,e){const n=this,{axis:a,config:i,state:o}=n,s=i.data_type;let l=!1,c=!1,f=!1;a&&(l=a.isCategorized(),c=a.isTimeSeries(),f=a.isCustomX());const g=Object.keys(t[0]||{}),v=g.length?g.filter(n.isNotX,n):[],m=g.length?g.filter(n.isX,n):[];let S;v.forEach(N=>{const L=this.getXKey(N);f||c?m.indexOf(L)>=0?S=(e&&n.data.xs[N]||[]).concat(t.map(w=>w[L]).filter(De).map((w,X)=>n.generateTargetX(w,N,X))):i.data_x?S=this.getOtherTargetXs():cn(i.data_xs)&&(S=n.getXValuesOfXKey(L,n.data.targets)):S=t.map((w,X)=>X),S&&(this.data.xs[N]=S)}),v.forEach(N=>{if(!this.data.xs[N])throw new Error(`x is not defined for id = "${N}".`)});const P=v.map((N,L)=>{const w=i.data_idConverter.bind(n.api)(N),X=n.getXKey(N),W=f&&l,H=W&&t.map(at=>at.x).every(at=>i.axis_x_categories.indexOf(at)>-1),k=t.__append__,K=X===null&&k?n.api.data.values(N).length:0;return{id:w,id_org:N,values:t.map((at,ht)=>{const $t=at[X];let dt=at[N],st;return dt=dt!==null&&!isNaN(dt)&&!Be(dt)?+dt:je(dt)||Be(dt)?dt:null,(W||o.hasRadar)&&L===0&&!ln($t)?(!H&&L===0&&ht===0&&!k&&(i.axis_x_categories=[]),st=i.axis_x_categories.indexOf($t),st===-1&&(st=i.axis_x_categories.length,i.axis_x_categories.push($t))):st=n.generateTargetX($t,N,K+ht),(ln(dt)||n.data.xs[N].length<=ht)&&(st=void 0),{x:st,value:dt,id:w,index:-1}}).filter(at=>Qe(at.x))}});if(P.forEach(N=>{var L;i.data_xSort&&(N.values=N.values.sort((w,X)=>{const W=w.x||w.x===0?w.x:1/0,H=X.x||X.x===0?X.x:1/0;return W-H})),N.values.forEach((w,X)=>w.index=X),(L=n.data.xs[N.id])==null||L.sort((w,X)=>w-X)}),o.hasNegativeValue=n.hasNegativeValueInTargets(P),o.hasPositiveValue=n.hasPositiveValueInTargets(P),s&&n.isValidChartType(s)){const N=n.mapToIds(P).filter(L=>!(L in i.data_types)||!n.isValidChartType(i.data_types[L]));n.setTargetType(N,s)}return P.forEach(N=>n.cache.add(N.id_org,N,!0)),P}},Dv={isX(t){const e=this,{config:n}=e,a=n.data_x&&t===n.data_x,i=cn(n.data_xs)&&Qg(n.data_xs,t);return a||i},isNotX(t){return!this.isX(t)},isStackNormalized(){const{config:t}=this;return!!(t.data_stack_normalize&&t.data_groups.length)},isGrouped(t){const e=this.config.data_groups;return t?e.some(n=>n.indexOf(t)>=0&&n.length>1):e.length>0},getXKey(t){const e=this,{config:n}=e;return n.data_x?n.data_x:cn(n.data_xs)?n.data_xs[t]:null},getXValuesOfXKey(t,e){const n=this,a=e&&cn(e)?n.mapToIds(e):[];let i;return a.forEach(o=>{n.getXKey(o)===t&&(i=n.data.xs[o])}),i},getIndexByX(t,e){const n=this;return e?e.indexOf(ze(t)?t:+t):(n.filterByX(n.data.targets,t)[0]||{index:null}).index},getXValue(t,e){const n=this;return t in n.data.xs&&n.data.xs[t]&&De(n.data.xs[t][e])?n.data.xs[t][e]:e},getOtherTargetXs(){const t=this,e=Object.keys(t.data.xs);return e.length?t.data.xs[e[0]]:null},getOtherTargetX(t){const e=this.getOtherTargetXs();return e&&t{n.data_xs[a]=t[a]})},isMultipleX(){return!this.config.axis_x_forceAsSingle&&(cn(this.config.data_xs)||this.hasType("bubble")||this.hasType("scatter"))},addName(t){const e=this,{config:n}=e;let a;return t&&(a=n.data_names[t.id],t.name=a!==void 0?a:t.id),t},getAllValuesOnIndex(t,e=!1){const n=this;let a=n.filterTargetsToShow(n.data.targets).map(i=>n.addName(n.getValueOnIndex(i.values,t)));return e&&(a=a.filter(i=>i&&"value"in i&&De(i.value))),a},getValueOnIndex(t,e){const n=t.filter(a=>a.index===e);return n.length?n[0]:null},updateTargetX(t,e){const n=this;t.forEach(a=>{a.values.forEach((i,o)=>{i.x=n.generateTargetX(e[o],a.id,o)}),n.data.xs[a.id]=e})},updateTargetXs(t,e){const n=this;t.forEach(a=>{e[a.id]&&n.updateTargetX([a],e[a.id])})},generateTargetX(t,e,n){const a=this,{axis:i}=a;let o=i!=null&&i.isCategorized()?n:t||n;if(i!=null&&i.isTimeSeries()){const s=Yn.bind(a);o=s(t||a.getXValue(e,n))}else i!=null&&i.isCustomX()&&!(i!=null&&i.isCategorized())&&(o=De(t)?+t:a.getXValue(e,n));return o},updateXs(t){t.length&&(this.axis.xs=t.map(e=>e.x))},getPrevX(t){const e=this.axis.xs[t-1];return Qe(e)?e:null},getNextX(t){const e=this.axis.xs[t+1];return Qe(e)?e:null},getBaseValue(t){const e=this,{hasAxis:n}=e.state;let{value:a}=t;return a&&n&&(e.isAreaRangeType(t)?a=e.getRangedData(t,"mid"):e.isBubbleZType(t)&&(a=e.getBubbleZData(a,"y"))),a},getMinMaxValue(t){const e=this.getBaseValue.bind(this);let n,a;return(t||this.data.targets.map(i=>i.values)).forEach((i,o)=>{const s=i.map(e).filter(he);n=Math.min(o?n:1/0,...s),a=Math.max(o?a:-1/0,...s)}),{min:n,max:a}},getMinMaxData(){const t=this,e=Ln.dataMinMax;let n=t.cache.get(e);if(!n){const a=t.data.targets.map(l=>l.values),i=t.getMinMaxValue(a);let o=[],s=[];a.forEach(l=>{const c=t.getFilteredDataByValue(l,i.min),f=t.getFilteredDataByValue(l,i.max);c.length&&(o=o.concat(c)),f.length&&(s=s.concat(f))}),t.cache.add(e,n={min:o,max:s})}return n},getTotalPerIndex(){const t=this,e=Ln.dataTotalPerIndex;let n=t.cache.get(e);return(t.config.data_groups.length||t.isStackNormalized())&&!n&&(n=[],t.data.targets.forEach(a=>{a.values.forEach((i,o)=>{n[o]||(n[o]=0),n[o]+=he(i.value)?i.value:0})})),n},getTotalDataSum(t){const e=this,n=Ln.dataTotalSum;let a=e.cache.get(n);if(!he(a)){const i=Do(e.data.targets.map(o=>o.values)).map(o=>o.value);a=i.length?i.reduce((o,s)=>o+s):0,e.cache.add(n,a)}return t&&(a-=e.getHiddenTotalDataSum()),a},getHiddenTotalDataSum(){const t=this,{api:e,state:{hiddenTargetIds:n}}=t;let a=0;return n.length&&(a=e.data.values.bind(e)(n).reduce((i,o)=>i+o)),a},getFilteredDataByValue(t,e){return t.filter(n=>this.getBaseValue(n)===e)},getMaxDataCount(){return Math.max(...this.data.targets.map(t=>t.values.length),0)},getMaxDataCountTarget(){let t=this.filterTargetsToShow()||[];const e=t.length,n=this.config.axis_x_inverted;return e>1?(t=t.map(a=>a.values).reduce((a,i)=>a.concat(i)).map(a=>a.x),t=na(Mo(t)).map((a,i,o)=>({x:a,index:n?o.length-i-1:i}))):e&&(t=t[0].values.concat()),t},mapToIds(t){return t.map(e=>e.id)},mapToTargetIds(t){const e=this;return t?je(t)?t.concat():[t]:e.mapToIds(e.data.targets)},hasTarget(t,e){const n=this.mapToIds(t);for(let a=0,i;i=n[a];a++)if(i===e)return!0;return!1},isTargetToShow(t){return this.state.hiddenTargetIds.indexOf(t)<0},isLegendToShow(t){return this.state.hiddenLegendIds.indexOf(t)<0},filterTargetsToShow(t){const e=this;return(t||e.data.targets).filter(n=>e.isTargetToShow(n.id))},mapTargetsToUniqueXs(t){const e=this,{axis:n}=e;let a=[];return t!=null&&t.length&&(a=Mo(Do(t.map(i=>i.values.map(o=>+o.x)))),a=n!=null&&n.isTimeSeries()?a.map(i=>new Date(+i)):a.map(Number)),na(a)},addTargetIds(t,e){const{state:n}=this;(je(e)?e:[e]).forEach(i=>{n[t].indexOf(i)<0&&n[t].push(i)})},removeTargetIds(t,e){const{state:n}=this;(je(e)?e:[e]).forEach(i=>{const o=n[t].indexOf(i);o>=0&&n[t].splice(o,1)})},addHiddenTargetIds(t){this.addTargetIds("hiddenTargetIds",t)},removeHiddenTargetIds(t){this.removeTargetIds("hiddenTargetIds",t)},addHiddenLegendIds(t){this.addTargetIds("hiddenLegendIds",t)},removeHiddenLegendIds(t){this.removeTargetIds("hiddenLegendIds",t)},getValuesAsIdKeyed(t){const e=this,{hasAxis:n}=e.state,a={},i=e.isMultipleX(),o=i?e.mapTargetsToUniqueXs(t).map(s=>ze(s)?s:+s):null;return t.forEach(s=>{const l=[];s.values.filter(({value:c})=>De(c)||c===null).forEach(c=>{let{value:f}=c;f!==null&&e.isCandlestickType(c)&&(f=je(f)?f.slice(0,4):[f.open,f.high,f.low,f.close]),je(f)?l.push(...f):Be(f)&&"high"in f?l.push(...Object.values(f)):e.isBubbleZType(c)?l.push(n&&e.getBubbleZData(f,"y")):i?l[e.getIndexByX(c.x,o)]=f:l.push(f)}),a[s.id]=l}),a},checkValueInTargets(t,e){const n=Object.keys(t);let a;for(let i=0;i1},hasNegativeValueInTargets(t){return this.checkValueInTargets(t,e=>e<0)},hasPositiveValueInTargets(t){return this.checkValueInTargets(t,e=>e>0)},orderTargets(t){const e=this,n=[...t],a=e.getSortCompareFn();return a&&n.sort(a),n},getSortCompareFn(t=!1){const e=this,{config:n}=e,a=n.data_order,i=/asc/i.test(a),o=/desc/i.test(a);let s;if(i||o){const l=(f,g)=>f+Math.abs(g.value),c=f=>he(f)?f:"values"in f?f.values.reduce(l,0):f.value;s=(f,g)=>{const v=c(f),m=c(g);return t?i?v-m:m-v:i?m-v:v-m}}else ve(a)&&(s=a.bind(e.api));return s||null},filterByX(t,e){return Do(t.map(n=>n.values)).filter(n=>n.x-e===0)},filterRemoveNull(t){return t.filter(e=>De(this.getBaseValue(e)))},filterByXDomain(t,e){return t.map(n=>({id:n.id,id_org:n.id_org,values:n.values.filter(a=>e[0]<=a.x&&a.x<=e[1])}))},hasDataLabel(){const t=this.config.data_labels;return Co(t)&&t||nr(t)&&cn(t)},hasNullDataValue(t){return t.some(({value:e})=>e===null)},getDataIndexFromEvent(t){const e=this,{$el:n,config:a,state:{hasRadar:i,inputType:o,eventReceiver:{coords:s,rect:l}}}=e;let c;if(i){let f=t.target;/tspan/i.test(f.tagName)&&(f=f.parentNode);const g=ot(f).datum();c=g&&Object.keys(g).length===1?g.index:void 0}else{const f=a.axis_rotated,g=Zl(n.chart.node()),v=o==="touch"&&t.changedTouches?t.changedTouches[0]:t;let m=f?v.clientY+g.y:v.clientX+g.x;if(Lo(n.svg)){const S=[m,0];f&&S.reverse(),m=Ai(n.eventRect.node(),...S)[f?"y":"x"]}else m-=f?l.top:l.left;c=wo(s,m,0,s.length-1,f)}return c},getDataLabelLength(t,e,n){const a=this,i=[0,0],o=1.3;return a.$el.chart.select("svg").selectAll(".dummy").data([t,e]).enter().append("text").text(s=>a.dataLabelFormat(s.id)(s)).each(function(s,l){i[l]=this.getBoundingClientRect()[n]*o}).remove(),i},isNoneArc(t){return this.hasTarget(this.data.targets,t.id)},isArc(t){return"data"in t&&this.hasTarget(this.data.targets,t.data.id)},findSameXOfValues(t,e){const n=t[e].x,a=[];let i;for(i=e-1;i>=0&&n===t[i].x;i--)a.push(t[i]);for(i=e;in.findClosest(i.values,e));return n.findClosest(a,e)},findClosest(t,e){const n=this,{$el:{main:a}}=n,i=t.filter(l=>l&&De(l.value));let o,s;return i.filter(l=>n.isBarType(l.id)||n.isCandlestickType(l.id)).forEach(l=>{const c=n.isBarType(l.id)?`.${Kn.chartBar}.${Se.target}${n.getTargetSelectorSuffix(l.id)} .${Kn.bar}-${l.index}`:`.${cr.chartCandlestick}.${Se.target}${n.getTargetSelectorSuffix(l.id)} .${cr.candlestick}-${l.index} path`;!s&&n.isWithinBar(a.select(c).node())&&(s=l)}),i.filter(l=>!n.isBarType(l.id)&&!n.isCandlestickType(l.id)).forEach(l=>{const c=n.dist(l,e);o=n.getPointSensitivity(l),c{const{x:i,id:o}=a;n.push({x:i,id:o,value:a.value[0]}),n.push({x:i,id:o,value:a.value[2]})}),n},updateDataAttributes(t,e){const n=this,{config:a}=n,i=a[`data_${t}`];return ln(e)||(Object.keys(e).forEach(o=>{i[o]=e[o]}),n.redraw({withLegend:!0})),i},getRangedData(t,e="",n="areaRange"){const a=t==null?void 0:t.value;if(je(a)){if(n==="bar")return a.reduce((i,o)=>o-i);{const i={areaRange:["high","mid","low"],candlestick:["open","high","low","close","volume"]}[n].indexOf(e);return i>=0&&a?a[i]:void 0}}else if(a&&e)return a[e];return a},setRatioForGroupedData(t){const e=this,{config:n}=e;if(n.data_groups.length&&t.some(a=>e.isGrouped(a.id))){const a=i=>e.getRatio("index",i,!0);t.forEach(i=>{"values"in i?i.values.forEach(a):a(i)})}},getRatio(t,e,n=!1){const a=this,{config:i,state:o}=a,s=a.api;let l=0;if(e&&s.data.shown().length)if(l=e.ratio||e.value,t==="arc")if(a.pie.padAngle()())l=e.value/a.getTotalDataSum(!0);else{const c=i.gauge_fullCircle?a.getArcLength():a.getStartingAngle()*-2,f=a.hasType("gauge")?c:Math.PI*2;l=(e.endAngle-e.startAngle)/f}else if(t==="index"){const c=s.data.values.bind(s);let f=this.getTotalPerIndex();if(o.hiddenTargetIds.length){let v=c(o.hiddenTargetIds,!1);v.length&&(v=v.reduce((m,S)=>m.map((P,N)=>(he(P)?P:0)+S[N])),f=f.map((m,S)=>m-v[S]))}const g=f[e.index];e.ratio=he(e.value)&&f&&g?e.value/g:0,l=e.ratio}else if(t==="radar")l=parseFloat(String(Math.max(e.value,0)))/o.current.dataMax*i.radar_size_ratio;else if(t==="bar"){const f=a.getYScaleById.bind(a)(e.id).domain().reduce((g,v)=>v-g);l=f===0?0:Math.abs(a.getRangedData(e,null,t)/f)}else t==="treemap"&&(l/=a.getTotalDataSum(!0));return n&&l?l*100:l},updateDataIndexByX(t){const e=this,n=t.reduce((a,i,o)=>(a[Number(i.x)]=o,a),{});e.data.targets.forEach(a=>{a.values.forEach((i,o)=>{let s=n[Number(i.x)];s===void 0&&(s=o),i.index=s})})},isBubbleZType(t){return this.isBubbleType(t)&&(Be(t.value)&&("z"in t.value||"y"in t.value)||je(t.value)&&t.value.length>=2)},isBarRangeType(t){const e=this,{value:n}=t;return e.isBarType(t)&&je(n)&&n.length>=2&&n.every(a=>he(a))},getDataById(t){var e;const n=this.cache.get(t)||this.api.data(t);return(e=n==null?void 0:n[0])!=null?e:n}};function cc(t,e=!1){const n=this,{api:a}=n;e&&n.api.flush(!0),t==null||t.call(a)}var Lv={load(t,e){const n=this,{axis:a,data:i,org:o,scale:s}=n,{append:l}=e,c={domain:null,currentDomain:null,x:null};let f=t;f&&(e.filter&&(f=f.filter(e.filter)),(e.type||e.types)&&f.forEach(g=>{var v;const m=((v=e.types)==null?void 0:v[g.id])||e.type;n.setTargetType(g.id,m)}),i.targets.forEach(g=>{for(let v=0;v{const a=t.data||n;t.append&&(a.__append__=!0),a&&e.load(e.convertDataToTargets(a),t)}))},unload(t,e){var n;const a=this,{state:i,$el:o,$T:s}=a,l=!!((n=a.hasLegendDefsPoint)!=null&&n.call(a));let c=e,f=t;if(a.cache.reset(),c||(c=()=>{}),f=f.filter(v=>a.hasTarget(a.data.targets,v)),!f||f.length===0){c();return}const g=o.svg.selectAll(f.map(v=>a.selectorTarget(v)));s(g).style("opacity","0").remove().call(Si,c),f.forEach(v=>{var m;const S=a.getTargetSelectorSuffix(v);i.withoutFadeIn[v]=!1,o.legend&&o.legend.selectAll(`.${We.legendItem}${S}`).remove(),a.data.targets=a.data.targets.filter(P=>P.id!==v),l&&((m=o.defs)==null||m.select(`#${a.getDefsPointId(S)}`).remove())}),i.hasFunnel&&a.updateFunnel(a.data.targets),i.hasTreemap&&a.updateTargetsForTreemap(a.data.targets),a.updateTypesElements()}},Ri=t=>()=>t;function Ho(t,{sourceEvent:e,subject:n,target:a,identifier:i,active:o,x:s,y:l,dx:c,dy:f,dispatch:g}){Object.defineProperties(this,{type:{value:t,enumerable:!0,configurable:!0},sourceEvent:{value:e,enumerable:!0,configurable:!0},subject:{value:n,enumerable:!0,configurable:!0},target:{value:a,enumerable:!0,configurable:!0},identifier:{value:i,enumerable:!0,configurable:!0},active:{value:o,enumerable:!0,configurable:!0},x:{value:s,enumerable:!0,configurable:!0},y:{value:l,enumerable:!0,configurable:!0},dx:{value:c,enumerable:!0,configurable:!0},dy:{value:f,enumerable:!0,configurable:!0},_:{value:g}})}Ho.prototype.on=function(){var t=this._.on.apply(this._,arguments);return t===this._?this:t};function Nv(t){return!t.ctrlKey&&!t.button}function Fv(){return this.parentNode}function Bv(t,e){return e==null?{x:t.x,y:t.y}:e}function Uv(){return navigator.maxTouchPoints||"ontouchstart"in this}function uc(){var t=Nv,e=Fv,n=Bv,a=Uv,i={},o=ri("start","drag","end"),s=0,l,c,f,g,v=0;function m(H){H.on("mousedown.drag",S).filter(a).on("touchstart.drag",L).on("touchmove.drag",w,Jd).on("touchend.drag touchcancel.drag",X).style("touch-action","none").style("-webkit-tap-highlight-color","rgba(0,0,0,0)")}function S(H,k){if(!(g||!t.call(this,H,k))){var K=W(this,e.call(this,H,k),H,k,"mouse");K&&(ot(H.view).on("mousemove.drag",P,Sa).on("mouseup.drag",N,Sa),co(H.view),lo(H),f=!1,l=H.clientX,c=H.clientY,K("start",H))}}function P(H){if(Zr(H),!f){var k=H.clientX-l,K=H.clientY-c;f=k*k+K*K>v}i.mouse("drag",H)}function N(H){ot(H.view).on("mousemove.drag mouseup.drag",null),uo(H.view,f),Zr(H),i.mouse("end",H)}function L(H,k){if(t.call(this,H,k)){var K=H.changedTouches,at=e.call(this,H,k),ht=K.length,$t,dt;for($t=0;$ti.$el[o]).forEach(o=>{a&&i.$el[o].classed(Se.EXPANDED,!1),i.getShapeByIndex(o,e,n).classed(Se.EXPANDED,t)})},setOverOut(t,e){const n=this,{config:a,state:{hasFunnel:i,hasRadar:o,hasTreemap:s},$el:{main:l}}=n,c=Be(e);if(c||e!==-1){const f=a[t?"data_onover":"data_onout"].bind(n.api);if(a.color_onover&&n.setOverColor(t,e,c),c){const g=n.getTargetSelectorSuffix(e.id),v=i||s?`${Se.target+g} .${sn.shape}`:Ve.arc+g;f(e,l.select(`.${v}`).node())}else if(a.tooltip_grouped)t&&(o&&n.isPointFocusOnly()?n.showCircleFocus(n.getAllValuesOnIndex(e,!0)):n.setExpand(e,null,!0)),!n.isMultipleX()&&l.selectAll(`.${sn.shape}-${e}`).each(function(g){f(g,this)});else{const g=n.cache.get(Ln.setOverOut)||[],v=l.selectAll(`.${sn.shape}-${e}`).filter(function(S){return n.isWithinShape(this,S)}),m=v.filter(function(){return g.every(S=>S!==this)});if(!t||v.empty()||g.length===m.size()&&m.nodes().every((S,P)=>S!==g[P]))for(;g.length;){const S=g.pop();a.data_onout.bind(n.api)(ot(S).datum(),S)}m.each(function(){t&&(f(ot(this).datum(),this),g.push(this))}),n.cache.add(Ln.setOverOut,g)}}},callOverOutForTouch(t){const e=this,n=e.cache.get(Ln.callOverOutForTouch);(Be(t)&&n?t.id!==n.id:t!==n)&&((n||he(n))&&e.setOverOut(!1,n),(t||he(t))&&e.setOverOut(!0,t),e.cache.add(Ln.callOverOutForTouch,t))},getDraggableSelection(){const t=this,{config:e,state:n}=t;return e.interaction_enabled&&e.data_selection_draggable&&t.drag?uc().on("drag",function(a){n.event=a,t.drag(Hn(a,this))}).on("start",function(a){n.event=a,t.dragstart(Hn(a,this))}).on("end",a=>{n.event=a,t.dragend()}):()=>{}},dispatchEvent(t,e,n){var a,i,o;const s=this,{config:l,state:{eventReceiver:c,hasAxis:f,hasFunnel:g,hasRadar:v,hasTreemap:m},$el:{eventRect:S,funnel:P,radar:N,svg:L,treemap:w}}=s;let X=(o=(i=(g||m)&&c.rect||v&&N.axes.select(`.${Tn.axis}-${e} text`)||S||((a=s.getArcElementByIdOrIndex)==null?void 0:a.call(s,e)))==null?void 0:i.node)==null?void 0:o.call(i);if(X){const W=s.isMultipleX(),H=l.axis_rotated;let{width:k,left:K,top:at}=X.getBoundingClientRect();if(f&&!v&&!W){const st=c.coords[e];st?(k=st.w,K+=st.x,at+=st.y):(k=0,K=0,at=0)}let ht=K+(n?n[0]:0)+(W||H?0:k/2),$t=at+(n?n[1]:0)+(H?4:0);if(Lo(L)){const st=Ai(s.$el.eventRect.node(),ht,$t,!1);ht=st.x,$t=st.y}const dt={screenX:ht,screenY:$t,clientX:ht,clientY:$t,bubbles:v};(g||m)&&(X=(P!=null?P:w).node()),ev[/^(mouse|click)/.test(t)?"mouse":"touch"](X,t,dt)}},setDragStatus(t){this.state.dragging=t},unbindZoomEvent(){const t=this,{$el:{eventRect:e,zoomResetBtn:n}}=t;e==null||e.on(".zoom wheel.zoom .drag",null),n==null||n.on("click",null).style("display","none")},unbindAllEvents(){var t;const e=this,{$el:{arcs:n,eventRect:a,legend:i,region:o,svg:s,treemap:l},brush:c}=e,f=["wheel","click","mouseover","mousemove","mouseout","touchstart","touchmove","touchend","touchstart.eventRect","touchmove.eventRect","touchend.eventRect",".brush",".drag",".zoom","wheel.zoom","dblclick.zoom"].join(" ");[s,a,o==null?void 0:o.list,c==null?void 0:c.getSelection(),n==null?void 0:n.selectAll("path"),i==null?void 0:i.selectAll("g"),l].forEach(g=>g==null?void 0:g.on(f,null)),(t=e.unbindZoomEvent)==null||t.call(e)}},jv={categoryName(t){var e;const{axis_x_categories:n}=this.config;return(e=n==null?void 0:n[t])!=null?e:t}},Vv={generateClass(t,e){return` ${t} ${t+this.getTargetSelectorSuffix(e)}`},getClass(t,e){const n=/s$/.test(t),a=/^(area|arc|line|funnel|treemap)s?$/.test(t),i=n?"id":"index";return o=>{const s=o.data||o;return((e?this.generateClass(Ue[n?"shapes":"shape"],s[i]):"")+this.generateClass(Ue[t],s[a?"id":i])).trim()}},getChartClass(t){return e=>Ue[`chart${t}`]+this.classTarget((e.data?e.data:e).id)},generateExtraLineClass(){const e=this.config.line_classes||[],n=[];return function(a){var i;const o=a.id||((i=a.data)==null?void 0:i.id)||a;return n.indexOf(o)<0&&n.push(o),e[n.indexOf(o)%e.length]}},classRegion(t,e){return`${this.generateClass(Ue.region,e)} ${"class"in t?t.class:""}`},classTarget(t){const e=this.config.data_classes[t];let n="";return e&&(n=` ${Ue.target}-${e}`),this.generateClass(Ue.target,t)+n},classFocus(t){return this.classFocused(t)+this.classDefocused(t)},classFocused(t){return` ${this.state.focusedTargetIds.indexOf(t.id)>=0?Ue.focused:""}`},classDefocused(t){return` ${this.state.defocusedTargetIds.indexOf(t.id)>=0?Ue.defocused:""}`},getTargetSelectorSuffix(t){return(t||t===0?`-${t}`:"").replace(/[\x00-\x20\x7F-\xA0\s?!@#$%^&*()_=+,.<>'":;\[\]\/|~`{}\\]/g,"-")},selectorTarget(t,e="",n=""){const a=this.getTargetSelectorSuffix(t);return`${e}.${Ue.target+a} ${n}, ${e}.${Ue.circles+a} ${n}`},selectorTargets(t,e){const n=t||[];return n.length?n.map(a=>this.selectorTarget(a,e)):null},selectorLegend(t){return`.${Ue.legendItem+this.getTargetSelectorSuffix(t)}`},selectorLegends(t){return t!=null&&t.length?t.map(e=>this.selectorLegend(e)):null}};class fc extends Map{constructor(e,n=gc){if(super(),Object.defineProperties(this,{_intern:{value:new Map},_key:{value:n}}),e!=null)for(const[a,i]of e)this.set(a,i)}get(e){return super.get(Yo(this,e))}has(e){return super.has(Yo(this,e))}set(e,n){return super.set(dc(this,e),n)}delete(e){return super.delete(hc(this,e))}}class f1 extends Set{constructor(e,n=gc){if(super(),Object.defineProperties(this,{_intern:{value:new Map},_key:{value:n}}),e!=null)for(const a of e)this.add(a)}has(e){return super.has(Yo(this,e))}add(e){return super.add(dc(this,e))}delete(e){return super.delete(hc(this,e))}}function Yo({_intern:t,_key:e},n){const a=e(n);return t.has(a)?t.get(a):n}function dc({_intern:t,_key:e},n){const a=e(n);return t.has(a)?t.get(a):(t.set(a,n),n)}function hc({_intern:t,_key:e},n){const a=e(n);return t.has(a)&&(n=t.get(a),t.delete(a)),n}function gc(t){return t!==null&&typeof t=="object"?t.valueOf():t}function ra(t,e){switch(arguments.length){case 0:break;case 1:this.range(t);break;default:this.range(e).domain(t);break}return this}function d1(t,e){switch(arguments.length){case 0:break;case 1:{typeof t=="function"?this.interpolator(t):this.range(t);break}default:{this.domain(t),typeof e=="function"?this.interpolator(e):this.range(e);break}}return this}const vc=Symbol("implicit");function pc(){var t=new fc,e=[],n=[],a=vc;function i(o){let s=t.get(o);if(s===void 0){if(a!==vc)return a;t.set(o,s=e.push(o)-1)}return n[s%n.length]}return i.domain=function(o){if(!arguments.length)return e.slice();e=[],t=new fc;for(const s of o)t.has(s)||t.set(s,e.push(s)-1);return i},i.range=function(o){return arguments.length?(n=Array.from(o),i):n.slice()},i.unknown=function(o){return arguments.length?(a=o,i):a},i.copy=function(){return pc(e,n).unknown(a)},ra.apply(i,arguments),i}const Gv=(t,e,n)=>{const a=ot(t.cloneNode(!0));return a.attr("id",n).insert("rect",":first-child").attr("width",a.attr("width")).attr("height",a.attr("height")).style("fill",e),{id:n,node:a.node()}};function Xv(t){const e=Ln.colorPattern,{body:n}=gn;let a=n[e];if(!a){const i=";",o=t.classed(oo.colorPattern,!0).style("background-image");t.classed(oo.colorPattern,!1),o.indexOf(i)>-1&&(a=o.replace(/url[^#]*|["'()]|(\s|%20)/g,"").split(i).map(s=>s.trim().replace(/[\"'\s]/g,"")).filter(Boolean),n[e]=a)}return a}const Hv=["#1f77b4","#ff7f0e","#2ca02c","#d62728","#9467bd","#8c564b","#e377c2","#7f7f7f","#bcbd22","#17becf"];var Yv={generateColor(){const t=this,{$el:e,config:n}=t,a=n.data_colors,i=n.data_color,o=[];let s=cn(n.color_pattern)?n.color_pattern:pc(Xv(e.chart)||Hv).range();const l=s;if(ve(n.color_tiles)){const c=n.color_tiles.bind(t.api)(),f=s.map((g,v)=>{const m=g.replace(/[#\(\)\s,]/g,""),S=`${t.state.datetimeId}-pattern-${m}-${v}`;return Gv(c[v%c.length],g,S)});s=f.map(g=>`url(#${g.id})`),t.patterns=f}return function(c){var f;const g=c.id||((f=c.data)==null?void 0:f.id)||c,v=t.isTypeOf(g,["line","spline","step"])||!n.data_types[g];let m;return ve(a[g])?m=a[g].bind(t.api)(c):a[g]?m=a[g]:(o.indexOf(g)<0&&o.push(g),m=v?l[o.indexOf(g)%l.length]:s[o.indexOf(g)%s.length],a[g]=m),ve(i)?i.bind(t.api)(m,c):m}},generateLevelColor(){const t=this,{config:e}=t,n=e.color_pattern,a=e.color_threshold,i=a.unit==="value",o=a.max||100,s=a.values&&a.values.length?a.values:[];return cn(a)?function(l){const c=i?l:l*100/o;let f=n[n.length-1];for(let g=0,v=s.length;g{const l=`${i.datetimeId}-labels-bg${n.getTargetSelectorSuffix(s)}${ze(t)?n.getTargetSelectorSuffix(t):""}`;a.defs.append("filter").attr("x",e.x).attr("y",e.y).attr("width",e.width).attr("height",e.height).attr("id",l).html(` - `)})}},getGradienColortUrl(t){return`url(#${this.state.datetimeId}-gradient${this.getTargetSelectorSuffix(t)})`},updateLinearGradient(){const t=this,{config:e,data:{targets:n},state:{datetimeId:a},$el:{defs:i}}=t;n.forEach(o=>{const s=`${a}-gradient${t.getTargetSelectorSuffix(o.id)}`,l=t.hasPointType()&&e.point_radialGradient,c=t.isAreaType(o)&&"area"||t.isBarType(o)&&"bar";if((l||c)&&i.select(`#${s}`).empty()){const f=t.color(o),g={defs:null,stops:[]};if(l){const{cx:v=.3,cy:m=.3,r:S=.7,stops:P=[[.1,f,0],[.9,f,1]]}=l;g.stops=P,g.defs=i.append("radialGradient").attr("id",`${s}`).attr("cx",v).attr("cy",m).attr("r",S)}else{const v=e.axis_rotated,{x:m=v?[1,0]:[0,0],y:S=v?[0,0]:[0,1],stops:P=[[0,f,1],[1,f,0]]}=e[`${c}_linearGradient`];g.stops=P,g.defs=i.append("linearGradient").attr("id",`${s}`).attr("x1",m[0]).attr("x2",m[1]).attr("y1",S[0]).attr("y2",S[1])}g.stops.forEach(v=>{const[m,S,P]=v,N=ve(S)?S.bind(t.api)(o.id):S;g.defs&&g.defs.append("stop").attr("offset",m).attr("stop-color",N||f).attr("stop-opacity",P)})}})},setOverColor(t,e){const n=this,{config:a,$el:{main:i}}=n,o=a.color_onover;let s=t?o:n.color;Be(s)?s=({id:l})=>l in o?o[l]:n.color(l):ze(s)?s=()=>o:ve(o)&&(s=s.bind(n.api)),i.selectAll(Be(e)?`.${Ve.arc}${n.getTargetSelectorSuffix(e.id)}`:`.${sn.shape}-${e}`).style("fill",s)}},Wv={getYDomainMinMax(t,e){const n=this,{axis:a,config:i}=n,o=e==="min",s=i.data_groups,l=n.mapToIds(t),c=n.getValuesAsIdKeyed(t);if(s.length>0){const f=n[`has${o?"Negative":"Positive"}ValueInTargets`](t);s.forEach(g=>{const v=g.filter(m=>l.indexOf(m)>=0);if(v.length){const m=v[0],S=a.getId(m);f&&c[m]&&(c[m]=c[m].map(P=>(o?P<0:P>0)?P:0)),v.filter((P,N)=>N>0).forEach(P=>{if(c[P]){const N=a.getId(P);c[P].forEach((L,w)=>{const X=+L,W=o?X>0:X<0;N===S&&!(f&&W)&&(c[m][w]+=X)})}})}})}return _n(e,Object.keys(c).map(f=>_n(e,c[f])))},isHiddenTargetWithYDomain(t){const e=this;return e.state.hiddenTargetIds.some(n=>e.axis.getId(n)===t)},getYDomain(t,e,n){const a=this,{axis:i,config:o,scale:s}=a,l=`axis_${e}`;if(a.isStackNormalized())return[0,100];const c=(s==null?void 0:s[e])&&s[e].type==="log",f=t.filter(dt=>i.getId(dt.id)===e),g=n?a.filterByXDomain(f,n):f;if(g.length===0)return a.isHiddenTargetWithYDomain(e)?s[e].domain():e==="y2"?s.y.domain():a.getYDomain(t,"y2",n);const v=o[`${l}_min`],m=o[`${l}_max`],S=o[`${l}_center`],P=o[`${l}_inverted`],N=a.hasDataLabel()&&o.axis_rotated,L=a.hasDataLabel()&&!o.axis_rotated;let w=a.getYDomainMinMax(g,"min"),X=a.getYDomainMinMax(g,"max"),W=[oe.BAR,oe.BUBBLE,oe.SCATTER,...Sr.Line].some(dt=>{const st=dt.indexOf("area")>-1?"area":dt;return a.hasType(dt,g,!0)&&o[`${st}_zerobased`]});w=De(v)?v:De(m)?w<=m?w:m-10:w,X=De(m)?m:De(v)?v<=X?X:v+10:X,isNaN(w)&&(w=0),isNaN(X)&&(X=w),w===X&&(w<0?X=0:w=0);const H=w>=0&&X>=0,k=w<=0&&X<=0;(De(v)&&H||De(m)&&k)&&(W=!1),W&&(H&&(w=0),k&&(X=0));const K=Math.abs(X-w);let at={top:K*.1,bottom:K*.1};if(Qe(S)){const dt=Math.max(Math.abs(w),Math.abs(X));X=S+dt,w=S-dt}if(N){const dt=Dr(s.y.range()),st=a.getDataLabelLength(w,X,"width").map(Vt=>Vt/dt);["bottom","top"].forEach((Vt,vt)=>{at[Vt]+=K*(st[vt]/(1-st[0]-st[1]))})}else if(L){const dt=a.getDataLabelLength(w,X,"height");["bottom","top"].forEach((st,Vt)=>{at[st]+=a.convertPixelToScale("y",dt[Vt],K)})}at=a.getResettedPadding(at);const ht=o[`${l}_padding`];cn(ht)&&["bottom","top"].forEach(dt=>{at[dt]=i.getPadding(ht,dt,at[dt],K)}),W&&(H&&(at.bottom=w),k&&(at.top=-X));const $t=c?[w,X].map(dt=>dt<0?0:dt):[w-at.bottom,X+at.top];return P?$t.reverse():$t},getXDomainMinMax(t,e){var n;const a=this,i=a.config[`axis_x_${e}`],o=_n(e,t.map(l=>_n(e,l.values.map(c=>c.x))));let s=Be(i)?i.value:i;return s=Qe(s)&&((n=a.axis)!=null&&n.isTimeSeries())?Yn.bind(this)(s):s,Be(i)&&i.fit&&(e==="min"&&so)&&(s=void 0),Qe(s)?s:o},getXDomainPadding(t,e){const n=this,{axis:a,config:i}=n,o=i.axis_x_padding,s=a.isTimeSeries()&&e,l=Dr(t);let c;if(a.isCategorized()||s)c=0;else if(n.hasType("bar")){const v=n.getMaxDataCount();c=v>1?l/(v-1)/2:.5}else c=n.getResettedPadding(l*.01);let{left:f=c,right:g=c}=he(o)?{left:o,right:o}:o;if(o.unit==="px"){const v=Math.abs(l+l*.2);f=a.getPadding(o,"left",c,v),g=a.getPadding(o,"right",c,v)}else{const v=l+f+g;if(s&&v){const m=l/e/v;f=f/v/m,g=g/v/m}}return{left:f,right:g}},getXDomain(t){const e=this,{axis:n,config:a,scale:{x:i}}=e,o=a.axis_x_inverted,s=[e.getXDomainMinMax(t,"min"),e.getXDomainMinMax(t,"max")];let[l=0,c=0]=s;if(i.type!=="log"){const f=n.isCategorized(),g=n.isTimeSeries(),v=e.getXDomainPadding(s);let[m,S]=s;m-S===0&&!f&&(g?(m=new Date(m.getTime()*.5),S=new Date(S.getTime()*1.5)):(m=m===0?1:m*.5,S=S===0?-1:S*1.5)),(m||m===0)&&(l=g?new Date(m.getTime()-v.left):m-v.left),(S||S===0)&&(c=g?new Date(S.getTime()+v.right):S+v.right)}return o?[c,l]:[l,c]},updateXDomain(t,e,n,a,i){var o;const s=this,{config:l,org:c,scale:{x:f,subX:g}}=s,v=l.zoom_enabled;if(n&&(f.domain(i||na(s.getXDomain(t),!l.axis_x_inverted)),c.xDomain=f.domain(),g.domain(f.domain()),(o=s.brush)==null||o.scale(g)),e){const m=i||!s.brush||Kl(s)?c.xDomain:Wl(s).map(g.invert);f.domain(m)}return(n||e)&&v&&s.zoom.updateScaleExtent(),a&&f.domain(s.trimXDomain(f.orgDomain())),f.domain()},trimXDomain(t){const e=this,n=e.config.axis_x_inverted,a=e.getZoomDomain(),[i,o]=a;return(n?t[0]>=i:t[0]<=i)&&(t[1]=+t[1]+(i-t[0]),t[0]=i),(n?t[1]<=o:t[1]>=o)&&(t[0]=+t[0]-(t[1]-o),t[1]=o),t},getZoomDomain(t="zoom",e=!1){const n=this,{config:a,scale:i,org:o}=n;let[s,l]=e&&i[t]?i[t].domain():o.xDomain;return t==="zoom"&&(Qe(a.zoom_x_min)&&(s=_n("min",[s,a.zoom_x_min])),Qe(a.zoom_x_max)&&(l=_n("max",[l,a.zoom_x_max]))),[s,l]},getZoomDomainValue(t){const e=this,{config:n,axis:a}=e;if(a.isCategorized()&&Array.isArray(t)){const i=n.axis_x_inverted;return t.map((s,l)=>Number(s)+(l===0?+i:+!i))}return t},convertPixelToScale(t,e,n){const a=this,{config:i,state:o}=a,s=i.axis_rotated;let l;return t==="x"?l=s?"height":"width":l=s?"width":"height",n*(e/o[l])},withinRange(t,e=[0,0],n){const i=this.config.axis_x_inverted,[o,s]=n;if(Array.isArray(t)){const l=[...t];if(i&&l.reverse(),l[0](f===0?i?+c<=o:+c>=o:i?+c>=s:+c<=s)&&!t.every((g,v)=>g===e[v]))}return!1}};function mc(t,e,n){const{config:a}=t,i=`axis_${e}_tick_format`;return(a[i]?a[i]:t.defaultValueFormat).call(t.api,n)}var Kv={yFormat(t){return mc(this,"y",t)},y2Format(t){return mc(this,"y2",t)},getDefaultValueFormat(){const t=this,{defaultArcValueFormat:e,yFormat:n,y2Format:a}=t,i=t.hasArcType(null,["gauge","polar","radar"]);return function(o,s,l){return(i?e:t.axis&&t.axis.getId(l)==="y2"?a:n).call(t,o,s)}},defaultValueFormat(t){return je(t)?t.join("~"):De(t)?+t:""},defaultArcValueFormat(t,e){return`${(e*100).toFixed(1)}%`},defaultPolarValueFormat(t){return`${t}`},dataLabelFormat(t){const e=this,n=e.config.data_labels,a=o=>{const s="~";let l=o;return je(o)?l=o.join(s):Be(o)&&(l=Object.values(o).join(s)),l};let i=a;return ve(n.format)?i=n.format:nr(n.format)&&(n.format[t]?i=n.format[t]===!0?a:n.format[t]:i=()=>""),i.bind(e.api)}};function Ii(t){const e=this,n=e.getDataById(t);return e.levelColor?e.levelColor(n.values[0].value):e.color(n)}function Wo(t,e=!0){var n;const{config:a}=this;let i=(n=a.data_names[t])!=null?n:t;return e&&ve(a.legend_format)&&(i=a.legend_format(i,t!==i?t:void 0)),i}var Zv={initLegend(){const t=this,{config:e,$el:n}=t;t.legendItemTextBox={},t.state.legendHasRendered=!1,e.legend_show?(e.legend_contents_bindto||(n.legend=t.$el.svg.append("g").classed(We.legend,!0).attr("transform",t.getTranslate("legend"))),t.updateLegend()):t.state.hiddenLegendIds=t.mapToIds(t.data.targets)},updateLegend(t,e,n){var a;const i=this,{config:o,state:s,scale:l,$el:c}=i,f=e||{withTransform:!1,withTransitionForTransform:!1,withTransition:!1};f.withTransition=$r(f,"withTransition",!0),f.withTransitionForTransform=$r(f,"withTransitionForTransform",!0),o.legend_contents_bindto&&o.legend_contents_template?i.updateLegendTemplate():s.hasTreemap||i.updateLegendElement(t||i.mapToIds(i.data.targets),f,n),(a=c.legend)==null||a.selectAll(`.${We.legendItem}`).classed(We.legendItemHidden,function(g){const v=!i.isTargetToShow(g);return v&&(this.style.opacity=null),v}),i.updateScales(!1,!l.zoom),i.updateSvgSize(),i.transformAll(f.withTransitionForTransform,n),s.legendHasRendered=!0},updateLegendTemplate(){const t=this,{config:e,$el:n}=t,a=ot(e.legend_contents_bindto),i=e.legend_contents_template;if(!a.empty()){const o=t.mapToIds(t.data.targets),s=[];let l="";o.forEach(f=>{const g=ve(i)?i.bind(t.api)(f,t.color(f),t.api.data(f)[0].values):bi(i,{COLOR:t.color(f),TITLE:f});g&&(s.push(f),l+=g)});const c=a.html(l).selectAll(function(){return this.childNodes}).data(s);t.setLegendItem(c),n.legend=a}},updateSizeForLegend(t){const e=this,{config:n,state:{isLegendTop:a,isLegendLeft:i,isLegendRight:o,isLegendInset:s,current:l}}=e,{width:c,height:f}=t,g={top:a?e.getCurrentPaddingByDirection("top")+n.legend_inset_y+5.5:l.height-f-e.getCurrentPaddingByDirection("bottom")-n.legend_inset_y,left:i?e.getCurrentPaddingByDirection("left")+n.legend_inset_x+.5:l.width-c-e.getCurrentPaddingByDirection("right")-n.legend_inset_x+.5};e.state.margin3={top:o?0:s?g.top:l.height-f,right:NaN,bottom:0,left:o?l.width-c:s?g.left:0}},transformLegend(t){const e=this,{$el:{legend:n},$T:a}=e;a(n,t).attr("transform",e.getTranslate("legend"))},updateLegendStep(t){this.state.legendStep=t},updateLegendItemWidth(t){this.state.legendItemWidth=t},updateLegendItemHeight(t){this.state.legendItemHeight=t},updateLegendItemColor(t,e){const{legend:n}=this.$el;n&&n.select(`.${We.legendItem}-${t} line`).style("stroke",e)},getLegendWidth(){const t=this,{current:{width:e},isLegendRight:n,isLegendInset:a,legendItemWidth:i,legendStep:o}=t.state;return t.config.legend_show?n||a?i*(o+1):e:0},getLegendHeight(){var t;const e=this,{current:n,isLegendRight:a,legendItemHeight:i,legendStep:o}=e.state,s=((t=e.config.padding)==null?void 0:t.mode)==="fit";return e.config.legend_show?a?n.height:Math.max(s?10:20,i)*(o+1):0},opacityForUnfocusedLegend(t){return t.classed(We.legendItemHidden)?null:"0.3"},toggleFocusLegend(t,e){const n=this,{$el:{legend:a},$T:i}=n,o=n.mapToTargetIds(t);a&&i(a.selectAll(`.${We.legendItem}`).filter(s=>o.indexOf(s)>=0).classed(qe.legendItemFocused,e)).style("opacity",function(){return e?null:n.opacityForUnfocusedLegend.call(n,ot(this))})},revertLegend(){const t=this,{$el:{legend:e},$T:n}=t;e&&n(e.selectAll(`.${We.legendItem}`).classed(qe.legendItemFocused,!1)).style("opacity",null)},showLegend(t){const e=this,{config:n,$el:a,$T:i}=e;n.legend_show||(n.legend_show=!0,a.legend?a.legend.style("visibility",null):e.initLegend(),!e.state.legendHasRendered&&e.updateLegend()),e.removeHiddenLegendIds(t),i(a.legend.selectAll(e.selectorLegends(t)).style("visibility",null)).style("opacity",null)},hideLegend(t){const e=this,{config:n,$el:{legend:a}}=e;n.legend_show&&qn(t)&&(n.legend_show=!1,a.style("visibility","hidden")),e.addHiddenLegendIds(t),a.selectAll(e.selectorLegends(t)).style("opacity","0").style("visibility","hidden")},getLegendItemTextBox(t,e){const n=this,{cache:a,state:i}=n;let o;const s=Ln.legendItemTextBox;return t&&(o=!i.redrawing&&a.get(s)||{},o[t]||(o[t]=n.getTextRect(e,We.legendItem),a.add(s,o)),o=o[t]),o},setLegendItem(t){const e=this,{$el:n,api:a,config:i,state:o}=e,s=o.inputType==="touch",l=e.hasType("gauge"),c=i.boost_useCssRule,f=i.legend_item_interaction;t.attr("class",function(g){const v=ot(this);return(!v.empty()&&v.attr("class")||"")+e.generateClass(We.legendItem,g)}).style("visibility",g=>e.isLegendToShow(g)?null:"hidden"),i.interaction_enabled&&(c&&[[`.${We.legendItem}`,"cursor:pointer"],[`.${We.legendItem} text`,"pointer-events:none"],[`.${We.legendItemPoint} text`,"pointer-events:none"],[`.${We.legendItemTile}`,"pointer-events:none"],[`.${We.legendItemEvent}`,"fill-opacity:0"]].forEach(g=>{const[v,m]=g;e.setCssRule(!1,v,[m])(n.legend)}),t.on(f.dblclick?"dblclick":"click",f||ve(i.legend_item_onclick)?function(g,v){if(!_e(i.legend_item_onclick,a,v,!o.hiddenTargetIds.includes(v))){const{altKey:m,target:S,type:P}=g;P==="dblclick"||m?o.hiddenTargetIds.length&&S.parentNode.getAttribute("class").indexOf(We.legendItemHidden)===-1?a.show():(a.hide(),a.show(v)):(a.toggle(v),ot(this).classed(qe.legendItemFocused,!1))}s&&e.hideTooltip()}:null),!s&&t.on("mouseout",f||ve(i.legend_item_onout)?function(g,v){_e(i.legend_item_onout,a,v,!o.hiddenTargetIds.includes(v))||(ot(this).classed(qe.legendItemFocused,!1),l&&e.undoMarkOverlapped(e,`.${Un.gaugeValue}`),e.api.revert())}:null).on("mouseover",f||ve(i.legend_item_onover)?function(g,v){_e(i.legend_item_onover,a,v,!o.hiddenTargetIds.includes(v))||(ot(this).classed(qe.legendItemFocused,!0),l&&e.markOverlapped(v,e,`.${Un.gaugeValue}`),!o.transiting&&e.isTargetToShow(v)&&a.focus(v))}:null),!t.empty()&&t.on("click mouseout mouseover")&&t.style("cursor",e.getStylePropValue("pointer")))},updateLegendElement(t,e){const n=this,{config:a,state:i,$el:{legend:o},$T:s}=n,c=a.legend_item_tile_type!=="circle",f=a.legend_item_tile_r,g={width:c?a.legend_item_tile_width:f*2,height:c?a.legend_item_tile_height:f*2},v={padding:{top:4,right:10},max:{width:0,height:0},posMin:10,step:0,tileWidth:g.width+5,totalLength:0},m={offsets:{},widths:{},heights:{},margins:[0],steps:{}};let S,P,N;const L=t.filter(K=>!Qe(a.data_names[K])||a.data_names[K]!==null),w=e.withTransition,X=n.getUpdateLegendPositions(L,v,m);i.isLegendInset&&(v.step=a.legend_inset_step?a.legend_inset_step:L.length,n.updateLegendStep(v.step)),i.isLegendRight?(S=K=>v.max.width*m.steps[K],P=K=>m.margins[m.steps[K]]+m.offsets[K]):i.isLegendInset?(S=K=>v.max.width*m.steps[K]+10,P=K=>m.margins[m.steps[K]]+m.offsets[K]):(S=K=>m.margins[m.steps[K]]+m.offsets[K],P=K=>v.max.height*m.steps[K]);const W={xText:(K,at)=>S(K,at)+4+g.width,xRect:(K,at)=>S(K,at),x1Tile:(K,at)=>S(K,at)-2,x2Tile:(K,at)=>S(K,at)-2+g.width,yText:(K,at)=>P(K,at)+9,yRect:(K,at)=>P(K,at)-5,yTile:(K,at)=>P(K,at)+4};n.generateLegendItem(L,g,X,W),N=o.select(`.${We.legendBackground} rect`),i.isLegendInset&&v.max.width>0&&N.size()===0&&(N=o.insert("g",`.${We.legendItem}`).attr("class",We.legendBackground).append("rect")),a.legend_tooltip&&o.selectAll("title").data(L).text(K=>Wo.bind(n)(K,!1));const H=o.selectAll("text").data(L).text(K=>Wo.bind(n)(K)).each(function(K,at){X(this,K,at)});s(H,w).attr("x",W.xText).attr("y",W.yText);const k=o.selectAll(`rect.${We.legendItemEvent}`).data(L);s(k,w).attr("width",K=>m.widths[K]).attr("height",K=>m.heights[K]).attr("x",W.xRect).attr("y",W.yRect),n.updateLegendItemPos(L,w,W),N&&s(N,w).attr("height",n.getLegendHeight()-12).attr("width",v.max.width*(v.step+1)+10),n.updateLegendItemWidth(v.max.width),n.updateLegendItemHeight(v.max.height),n.updateLegendStep(v.step)},getUpdateLegendPositions(t,e,n){const a=this,{config:i,state:o}=a,s=o.isLegendRight||o.isLegendInset;return function(l,c,f){const g=f===0,v=f===t.length-1,m=a.getLegendItemTextBox(c,l),S=m.width+e.tileWidth+(v&&!s?0:e.padding.right)+i.legend_padding,P=m.height+e.padding.top,N=s?P:S,L=s?a.getLegendHeight():a.getLegendWidth();let w;const X=function(H,k){k||(w=(L-e.totalLength-N)/2,w=e.max.width)&&(e.max.width=S),(!e.max.height||P>=e.max.height)&&(e.max.height=P);const W=s?e.max.height:e.max.width;i.legend_equally?(Object.keys(n.widths).forEach(H=>n.widths[H]=e.max.width),Object.keys(n.heights).forEach(H=>n.heights[H]=e.max.height),w=(L-W*t.length)/2,wX(H))):X(c,!0)):X(c)}},generateLegendItem(t,e,n,a){const i=this,{config:o,state:s,$el:{legend:l}}=i,c=o.legend_usePoint,f=o.legend_item_tile_r,g=o.legend_item_tile_type,v=g!=="circle",m=s.isLegendRight||s.isLegendInset,S=-200,P=l.selectAll(`.${We.legendItem}`).data(t).enter().append("g");if(i.setLegendItem(P),o.legend_tooltip&&P.append("title").text(N=>N),P.append("text").text(N=>Wo.bind(i)(N)).each(function(N,L){n(this,N,L)}).style("pointer-events",i.getStylePropValue("none")).attr("x",m?a.xText:S).attr("y",m?S:a.yText),P.append("rect").attr("class",We.legendItemEvent).style("fill-opacity",i.getStylePropValue("0")).attr("x",m?a.xRect:S).attr("y",m?S:a.yRect),c){const N=[];P.append(L=>{const w=cn(o.point_pattern)?o.point_pattern:[o.point_type];N.indexOf(L)===-1&&N.push(L);let X=w[N.indexOf(L)%w.length];return X==="rectangle"&&(X="rect"),gn.createElementNS(ae.svg,"hasValidPointType"in i&&i.hasValidPointType(X)?X:"use")}).attr("class",We.legendItemPoint).style("fill",Ii.bind(i)).style("pointer-events",i.getStylePropValue("none")).attr("href",(L,w,X)=>{const H=X[w].nodeName.toLowerCase(),k=i.getTargetSelectorSuffix(L);return H==="use"?`#${s.datetimeId}-point${k}`:void 0})}else P.append(v?"line":g).attr("class",We.legendItemTile).style("stroke",Ii.bind(i)).style("pointer-events",i.getStylePropValue("none")).call(N=>{g==="circle"?N.attr("r",f).style("fill",Ii.bind(i)).attr("cx",m?a.x2Tile:S).attr("cy",m?S:a.yTile):v&&N.attr("stroke-width",e.height).attr("x1",m?a.x1Tile:S).attr("y1",m?S:a.yTile).attr("x2",m?a.x2Tile:S).attr("y2",m?S:a.yTile)})},updateLegendItemPos(t,e,n){const a=this,{config:i,$el:{legend:o},$T:s}=a,l=i.legend_usePoint,c=i.legend_item_tile_type,f=c!=="circle";if(l){const g=o.selectAll(`.${We.legendItemPoint}`).data(t);s(g,e).each(function(){const v=this.nodeName.toLowerCase(),m=i.point_r;let S="x",P="y",N=2,L=2.5,w=null,X=null,W=null;if(v==="circle"){const H=m*.2;S="cx",P="cy",w=m+H,N=m*2,L=-H}else if(v==="rect"){const H=m*2.5;X=H,W=H,L=3}ot(this).attr(S,H=>n.x1Tile(H)+N).attr(P,H=>n.yTile(H)-L).attr("r",w).attr("width",X).attr("height",W)})}else{const g=o.selectAll(`.${We.legendItemTile}`).data(t);s(g,e).style("stroke",Ii.bind(a)).call(v=>{c==="circle"?v.attr("cx",m=>{const S=n.x2Tile(m);return S-(S-n.x1Tile(m))/2}).attr("cy",n.yTile):f&&v.attr("x1",n.x1Tile).attr("y1",n.yTile).attr("x2",n.x2Tile).attr("y2",n.yTile)})}}},Jv={redraw(t={}){var e,n,a,i;const o=this,{config:s,state:l,$el:c}=o,{main:f,treemap:g}=c;l.redrawing=!0;const v=o.filterTargetsToShow(o.data.targets),{flow:m,initializing:S}=t,P=o.getWithOption(t),N=P.Transition?s.transition_duration:0,L=P.TransitionForExit?N:0,w=P.TransitionForAxis?N:0,X=(e=o.axis)==null?void 0:e.generateTransitions(w);o.updateSizes(S),P.Legend&&s.legend_show?(t.withTransition=!!N,!g&&o.updateLegend(o.mapToIds(o.data.targets),t,X)):P.Dimension&&o.updateDimension(!0),s.data_empty_label_text&&f.select(`text.${On.text}.${Se.empty}`).attr("x",l.width/2).attr("y",l.height/2).text(s.data_empty_label_text).style("display",v.length?"none":null),l.hasAxis?(o.axis.redrawAxis(v,P,X,m,S),o.hasGrid()&&o.updateGrid(),s.regions.length&&o.updateRegion(),["bar","candlestick","line","area"].forEach(W=>{const H=Cn(W);(/^(line|area)$/.test(W)&&o.hasTypeOf(H)||o.hasType(W))&&o[`update${H}`](P.TransitionForExit)}),c.text&&f.selectAll(`.${tn.selectedCircles}`).filter(o.isBarType.bind(o)).selectAll("circle").remove(),s.interaction_enabled&&!m&&P.EventRect&&(o.redrawEventRect(),(n=o.bindZoomEvent)==null||n.call(o))):(c.arcs&&o.redrawArc(N,L,P.Transform),c.radar&&o.redrawRadar(),c.polar&&o.redrawPolar(),c.funnel&&o.redrawFunnel(),g&&o.updateTreemap(L)),!l.resizing&&!g&&(o.hasPointType()||l.hasRadar)?o.updateCircle():(a=o.hasLegendDefsPoint)!=null&&a.call(o)&&o.data.targets.forEach(o.point("create",this)),o.hasDataLabel()&&!o.hasArcType(null,["radar"])&&o.updateText(),(i=o.redrawTitle)==null||i.call(o),S&&o.updateTypesElements(),o.generateRedrawList(v,m,N,P.Subchart),o.updateTooltipOnRedraw(),o.callPluginHook("$redraw",t,N)},generateRedrawList(t,e,n,a){const i=this,{config:o,state:s}=i,l=i.getDrawShape();s.hasAxis&&o.subchart_show&&i.redrawSubchart(a,n,l);const c=e&&i.generateFlow({targets:t,flow:e,duration:e.duration,shape:l,xv:i.xv.bind(i)}),f=(n||c)&&Da(),g=i.getRedrawList(l,e,c,f),v=()=>{c&&c(),s.redrawing=!1,_e(o.onrendered,i.api)};if(v)if(f&&g.length){const m=ec();Ml().duration(n).each(()=>{g.reduce((S,P)=>S.concat(P),[]).forEach(S=>m.add(S))}).call(m,v)}else s.transiting||v();i.mapToIds(i.data.targets).forEach(m=>{s.withoutFadeIn[m]=!0})},getRedrawList(t,e,n,a){const i=this,{config:o,state:{hasAxis:s,hasRadar:l,hasTreemap:c},$el:{grid:f}}=i,{cx:g,cy:v,xForText:m,yForText:S}=t.pos,P=[];return s&&((o.grid_x_lines.length||o.grid_y_lines.length)&&P.push(i.redrawGrid(a)),o.regions.length&&P.push(i.redrawRegion(a)),Object.keys(t.type).forEach(N=>{const L=Cn(N),w=t.type[N];(/^(area|line)$/.test(N)&&i.hasTypeOf(L)||i.hasType(N))&&P.push(i[`redraw${L}`](w,a))}),!e&&f.main&&P.push(i.updateGridFocus())),(!i.hasArcType()||l)&&cn(o.data_labels)&&o.data_labels!==!1&&P.push(i.redrawText(m,S,e,a)),(i.hasPointType()||l)&&!i.isPointFocusOnly()&&i.redrawCircle&&P.push(i.redrawCircle(g,v,a,n)),c&&P.push(i.redrawTreemap(a)),P},updateAndRedraw(t={}){const e=this,{config:n,state:a}=e;let i;t.withTransition=$r(t,"withTransition",!0),t.withTransform=$r(t,"withTransform",!1),t.withLegend=$r(t,"withLegend",!1),t.withUpdateXDomain=!0,t.withUpdateOrgXDomain=!0,t.withTransitionForExit=!1,t.withTransitionForTransform=$r(t,"withTransitionForTransform",t.withTransition),t.withLegend&&n.legend_show||(a.hasAxis&&(i=e.axis.generateTransitions(t.withTransitionForAxis?n.transition_duration:0)),e.updateScales(),e.updateSvgSize(),e.transformAll(t.withTransitionForTransform,i)),e.redraw(t,i)}};const Qv=Math.sqrt(50),kv=Math.sqrt(10),qv=Math.sqrt(2);function Oi(t,e,n){const a=(e-t)/Math.max(0,n),i=Math.floor(Math.log10(a)),o=a/Math.pow(10,i),s=o>=Qv?10:o>=kv?5:o>=qv?2:1;let l,c,f;return i<0?(f=Math.pow(10,-i)/s,l=Math.round(t*f),c=Math.round(e*f),l/fe&&--c,f=-f):(f=Math.pow(10,i)*s,l=Math.round(t/f),c=Math.round(e/f),l*fe&&--c),c0))return[];if(t===e)return[t];const a=e=i))return[];const l=o-i+1,c=new Array(l);if(a)if(s<0)for(let f=0;fe?1:t>=e?0:NaN}function _v(t,e){return t==null||e==null?NaN:et?1:e>=t?0:NaN}function Qo(t){let e,n,a;t.length!==2?(e=Ci,n=(l,c)=>Ci(t(l),c),a=(l,c)=>t(l)-c):(e=t===Ci||t===_v?t:tp,n=t,a=t);function i(l,c,f=0,g=l.length){if(f>>1;n(l[v],c)<0?f=v+1:g=v}while(f>>1;n(l[v],c)<=0?f=v+1:g=v}while(ff&&a(l[v-1],c)>-a(l[v],c)?v-1:v}return{left:i,center:s,right:o}}function tp(){return 0}function ep(t){return t===null?NaN:+t}function*h1(t,e){if(e===void 0)for(let n of t)n!=null&&(n=+n)>=n&&(yield n);else{let n=-1;for(let a of t)(a=e(a,++n,t))!=null&&(a=+a)>=a&&(yield a)}}const yc=Qo(Ci),np=yc.right,g1=yc.left,v1=Qo(ep).center;var rp=np;function ap(t,e){return t=+t,e=+e,function(n){return Math.round(t*(1-n)+e*n)}}function ip(t){return function(){return t}}function op(t){return+t}var xc=[0,1];function aa(t){return t}function ko(t,e){return(e-=t=+t)?function(n){return(n-t)/e}:ip(isNaN(e)?NaN:.5)}function sp(t,e){var n;return t>e&&(n=t,t=e,e=n),function(a){return Math.max(t,Math.min(e,a))}}function lp(t,e,n){var a=t[0],i=t[1],o=e[0],s=e[1];return i2?cp:lp,c=f=null,v}function v(m){return m==null||isNaN(m=+m)?o:(c||(c=l(t.map(a),e,n)))(a(s(m)))}return v.invert=function(m){return s(i((f||(f=l(e,t.map(a),Qn)))(m)))},v.domain=function(m){return arguments.length?(t=Array.from(m,op),g()):t.slice()},v.range=function(m){return arguments.length?(e=Array.from(m),g()):e.slice()},v.rangeRound=function(m){return e=Array.from(m),n=ap,g()},v.clamp=function(m){return arguments.length?(s=m?!0:aa,g()):s!==aa},v.interpolate=function(m){return arguments.length?(n=m,g()):n},v.unknown=function(m){return arguments.length?(o=m,v):o},function(m,S){return a=m,i=S,g()}}function Tc(){return qo()(aa,aa)}var up=/^(?:(.)?([<>=^]))?([+\-( ])?([$#])?(0)?(\d+)?(,)?(\.\d+)?(~)?([a-z%])?$/i;function Na(t){if(!(e=up.exec(t)))throw new Error("invalid format: "+t);var e;return new _o({fill:e[1],align:e[2],sign:e[3],symbol:e[4],zero:e[5],width:e[6],comma:e[7],precision:e[8]&&e[8].slice(1),trim:e[9],type:e[10]})}Na.prototype=_o.prototype;function _o(t){this.fill=t.fill===void 0?" ":t.fill+"",this.align=t.align===void 0?">":t.align+"",this.sign=t.sign===void 0?"-":t.sign+"",this.symbol=t.symbol===void 0?"":t.symbol+"",this.zero=!!t.zero,this.width=t.width===void 0?void 0:+t.width,this.comma=!!t.comma,this.precision=t.precision===void 0?void 0:+t.precision,this.trim=!!t.trim,this.type=t.type===void 0?"":t.type+""}_o.prototype.toString=function(){return this.fill+this.align+this.sign+this.symbol+(this.zero?"0":"")+(this.width===void 0?"":Math.max(1,this.width|0))+(this.comma?",":"")+(this.precision===void 0?"":"."+Math.max(0,this.precision|0))+(this.trim?"~":"")+this.type};function fp(t){return Math.abs(t=Math.round(t))>=1e21?t.toLocaleString("en").replace(/,/g,""):t.toString(10)}function wi(t,e){if((n=(t=e?t.toExponential(e-1):t.toExponential()).indexOf("e"))<0)return null;var n,a=t.slice(0,n);return[a.length>1?a[0]+a.slice(2):a,+t.slice(n+1)]}function ia(t){return t=wi(Math.abs(t)),t?t[1]:NaN}function dp(t,e){return Math.max(0,Math.max(-8,Math.min(8,Math.floor(ia(e)/3)))*3-ia(Math.abs(t)))}function hp(t,e){return function(n,a){for(var i=n.length,o=[],s=0,l=t[0],c=0;i>0&&l>0&&(c+l+1>a&&(l=Math.max(1,a-c)),o.push(n.substring(i-=l,i+l)),!((c+=l+1)>a));)l=t[s=(s+1)%t.length];return o.reverse().join(e)}}function gp(t){return function(e){return e.replace(/[0-9]/g,function(n){return t[+n]})}}function vp(t){t:for(var e=t.length,n=1,a=-1,i;n0&&(a=0);break}return a>0?t.slice(0,a)+t.slice(i+1):t}var $c;function pp(t,e){var n=wi(t,e);if(!n)return t+"";var a=n[0],i=n[1],o=i-($c=Math.max(-8,Math.min(8,Math.floor(i/3)))*3)+1,s=a.length;return o===s?a:o>s?a+new Array(o-s+1).join("0"):o>0?a.slice(0,o)+"."+a.slice(o):"0."+new Array(1-o).join("0")+wi(t,Math.max(0,e+o-1))[0]}function Sc(t,e){var n=wi(t,e);if(!n)return t+"";var a=n[0],i=n[1];return i<0?"0."+new Array(-i).join("0")+a:a.length>i+1?a.slice(0,i+1)+"."+a.slice(i+1):a+new Array(i-a.length+2).join("0")}var Ac={"%":(t,e)=>(t*100).toFixed(e),b:t=>Math.round(t).toString(2),c:t=>t+"",d:fp,e:(t,e)=>t.toExponential(e),f:(t,e)=>t.toFixed(e),g:(t,e)=>t.toPrecision(e),o:t=>Math.round(t).toString(8),p:(t,e)=>Sc(t*100,e),r:Sc,s:pp,X:t=>Math.round(t).toString(16).toUpperCase(),x:t=>Math.round(t).toString(16)};function Ec(t){return t}var bc=Array.prototype.map,Rc=["y","z","a","f","p","n","\xB5","m","","k","M","G","T","P","E","Z","Y"];function mp(t){var e=t.grouping===void 0||t.thousands===void 0?Ec:hp(bc.call(t.grouping,Number),t.thousands+""),n=t.currency===void 0?"":t.currency[0]+"",a=t.currency===void 0?"":t.currency[1]+"",i=t.decimal===void 0?".":t.decimal+"",o=t.numerals===void 0?Ec:gp(bc.call(t.numerals,String)),s=t.percent===void 0?"%":t.percent+"",l=t.minus===void 0?"\u2212":t.minus+"",c=t.nan===void 0?"NaN":t.nan+"";function f(v){v=Na(v);var m=v.fill,S=v.align,P=v.sign,N=v.symbol,L=v.zero,w=v.width,X=v.comma,W=v.precision,H=v.trim,k=v.type;k==="n"?(X=!0,k="g"):Ac[k]||(W===void 0&&(W=12),H=!0,k="g"),(L||m==="0"&&S==="=")&&(L=!0,m="0",S="=");var K=N==="$"?n:N==="#"&&/[boxX]/.test(k)?"0"+k.toLowerCase():"",at=N==="$"?a:/[%p]/.test(k)?s:"",ht=Ac[k],$t=/[defgprs%]/.test(k);W=W===void 0?6:/[gprs]/.test(k)?Math.max(1,Math.min(21,W)):Math.max(0,Math.min(20,W));function dt(st){var Vt=K,vt=at,Q,St,ct;if(k==="c")vt=ht(st)+vt,st="";else{st=+st;var At=st<0||1/st<0;if(st=isNaN(st)?c:ht(Math.abs(st),W),H&&(st=vp(st)),At&&+st==0&&P!=="+"&&(At=!1),Vt=(At?P==="("?P:l:P==="-"||P==="("?"":P)+Vt,vt=(k==="s"?Rc[8+$c/3]:"")+vt+(At&&P==="("?")":""),$t){for(Q=-1,St=st.length;++Qct||ct>57){vt=(ct===46?i+st.slice(Q+1):st.slice(Q))+vt,st=st.slice(0,Q);break}}}X&&!L&&(st=e(st,1/0));var Gt=Vt.length+st.length+vt.length,Bt=Gt>1)+Vt+st+vt+Bt.slice(Gt);break;default:st=Bt+Vt+st+vt;break}return o(st)}return dt.toString=function(){return v+""},dt}function g(v,m){var S=f((v=Na(v),v.type="f",v)),P=Math.max(-8,Math.min(8,Math.floor(ia(m)/3)))*3,N=Math.pow(10,-P),L=Rc[8+P/3];return function(w){return S(N*w)+L}}return{format:f,formatPrefix:g}}var Mi,ts,Ic;yp({thousands:",",grouping:[3],currency:["$",""]});function yp(t){return Mi=mp(t),ts=Mi.format,Ic=Mi.formatPrefix,Mi}function xp(t,e){return t=Math.abs(t),e=Math.abs(e)-t,Math.max(0,ia(e)-ia(t))+1}function Tp(t){return Math.max(0,-ia(Math.abs(t)))}function $p(t,e,n,a){var i=Jo(t,e,n),o;switch(a=Na(a==null?",f":a),a.type){case"s":{var s=Math.max(Math.abs(t),Math.abs(e));return a.precision==null&&!isNaN(o=dp(i,s))&&(a.precision=o),Ic(a,s)}case"":case"e":case"g":case"p":case"r":{a.precision==null&&!isNaN(o=xp(i,Math.max(Math.abs(t),Math.abs(e))))&&(a.precision=o-(a.type==="e"));break}case"f":case"%":{a.precision==null&&!isNaN(o=Tp(i))&&(a.precision=o-(a.type==="%")*2);break}}return ts(a)}function Oc(t){var e=t.domain;return t.ticks=function(n){var a=e();return Ko(a[0],a[a.length-1],n==null?10:n)},t.tickFormat=function(n,a){var i=e();return $p(i[0],i[i.length-1],n==null?10:n,a)},t.nice=function(n){n==null&&(n=10);var a=e(),i=0,o=a.length-1,s=a[i],l=a[o],c,f,g=10;for(l0;){if(f=Zo(s,l,n),f===c)return a[i]=s,a[o]=l,e(a);if(f>0)s=Math.floor(s/f)*f,l=Math.ceil(l/f)*f;else if(f<0)s=Math.ceil(s*f)/f,l=Math.floor(l*f)/f;else break;c=f}return t},t}function Di(){var t=Tc();return t.copy=function(){return Pi(t,Di())},ra.apply(t,arguments),Oc(t)}function Cc(t){return function(e){return Math.sign(e)*Math.log1p(Math.abs(e/t))}}function Pc(t){return function(e){return Math.sign(e)*Math.expm1(Math.abs(e))*t}}function Sp(t){var e=1,n=t(Cc(e),Pc(e));return n.constant=function(a){return arguments.length?t(Cc(e=+a),Pc(e)):e},Oc(n)}function wc(){var t=Sp(qo());return t.copy=function(){return Pi(t,wc()).constant(t.constant())},ra.apply(t,arguments)}function Mc(t,e){t=t.slice();var n=0,a=t.length-1,i=t[n],o=t[a],s;return oMath.pow(t,e)}function Ip(t){return t===Math.E?Math.log:t===10&&Math.log10||t===2&&Math.log2||(t=Math.log(t),e=>Math.log(e)/t)}function Nc(t){return(e,n)=>-t(-e,n)}function Op(t){const e=t(Dc,Lc),n=e.domain;let a=10,i,o;function s(){return i=Ip(a),o=Rp(a),n()[0]<0?(i=Nc(i),o=Nc(o),t(Ap,Ep)):t(Dc,Lc),e}return e.base=function(l){return arguments.length?(a=+l,s()):a},e.domain=function(l){return arguments.length?(n(l),s()):n()},e.ticks=l=>{const c=n();let f=c[0],g=c[c.length-1];const v=g0){for(;m<=S;++m)for(P=1;Pg)break;w.push(N)}}else for(;m<=S;++m)for(P=a-1;P>=1;--P)if(N=m>0?P/o(-m):P*o(m),!(Ng)break;w.push(N)}w.length*2{if(l==null&&(l=10),c==null&&(c=a===10?"s":","),typeof c!="function"&&(!(a%1)&&(c=Na(c)).precision==null&&(c.trim=!0),c=ts(c)),l===1/0)return c;const f=Math.max(1,a*l/e.ticks().length);return g=>{let v=g/o(Math.round(i(g)));return v*an(Mc(n(),{floor:l=>o(Math.floor(i(l))),ceil:l=>o(Math.ceil(i(l)))})),e}function Fc(){const t=Op(qo()).domain([1,10]);return t.copy=()=>Pi(t,Fc()).base(t.base()),ra.apply(t,arguments),t}const Li=en(()=>{},(t,e)=>{t.setTime(+t+e)},(t,e)=>e-t);Li.every=t=>(t=Math.floor(t),!isFinite(t)||!(t>0)?null:t>1?en(e=>{e.setTime(Math.floor(e/t)*t)},(e,n)=>{e.setTime(+e+n*t)},(e,n)=>(n-e)/t):Li);const p1=Li.range,Ur=en(t=>{t.setTime(t-t.getMilliseconds())},(t,e)=>{t.setTime(+t+e*Gn)},(t,e)=>(e-t)/Gn,t=>t.getUTCSeconds()),m1=Ur.range,es=en(t=>{t.setTime(t-t.getMilliseconds()-t.getSeconds()*Gn)},(t,e)=>{t.setTime(+t+e*In)},(t,e)=>(e-t)/In,t=>t.getMinutes()),y1=es.range,ns=en(t=>{t.setUTCSeconds(0,0)},(t,e)=>{t.setTime(+t+e*In)},(t,e)=>(e-t)/In,t=>t.getUTCMinutes()),x1=ns.range,rs=en(t=>{t.setTime(t-t.getMilliseconds()-t.getSeconds()*Gn-t.getMinutes()*In)},(t,e)=>{t.setTime(+t+e*Bn)},(t,e)=>(e-t)/Bn,t=>t.getHours()),T1=rs.range,as=en(t=>{t.setUTCMinutes(0,0,0)},(t,e)=>{t.setTime(+t+e*Bn)},(t,e)=>(e-t)/Bn,t=>t.getUTCHours()),$1=as.range,is=en(t=>{t.setDate(1),t.setHours(0,0,0,0)},(t,e)=>{t.setMonth(t.getMonth()+e)},(t,e)=>e.getMonth()-t.getMonth()+(e.getFullYear()-t.getFullYear())*12,t=>t.getMonth()),S1=is.range,os=en(t=>{t.setUTCDate(1),t.setUTCHours(0,0,0,0)},(t,e)=>{t.setUTCMonth(t.getUTCMonth()+e)},(t,e)=>e.getUTCMonth()-t.getUTCMonth()+(e.getUTCFullYear()-t.getUTCFullYear())*12,t=>t.getUTCMonth()),A1=os.range;function Bc(t,e,n,a,i,o){const s=[[Ur,1,Gn],[Ur,5,5*Gn],[Ur,15,15*Gn],[Ur,30,30*Gn],[o,1,In],[o,5,5*In],[o,15,15*In],[o,30,30*In],[i,1,Bn],[i,3,3*Bn],[i,6,6*Bn],[i,12,12*Bn],[a,1,or],[a,2,2*or],[n,1,to],[e,1,Ps],[e,3,3*Ps],[t,1,eo]];function l(f,g,v){const m=gL).right(s,m);if(S===s.length)return t.every(Jo(f/eo,g/eo,v));if(S===0)return Li.every(Math.max(Jo(f,g,v),1));const[P,N]=s[m/s[S-1][2]n.axis.x.tickOffset()),i=n.config.axis_x_inverted,o=function(s){return t(s)+a()};for(const s in t)o[s]=t[s];return o.orgDomain=()=>t.domain(),o.orgScale=()=>t,n.axis.isCategorized()&&(o.domain=function(s){let l=s;return arguments.length?(t.domain(l),o):(l=this.orgDomain(),i?[l[0]+1,l[1]]:[l[0],l[1]+1])}),o},updateScales(t,e=!0){var n,a;const i=this,{axis:o,config:s,format:l,org:c,scale:f,state:{current:g,width:v,height:m,width2:S,height2:P,hasAxis:N,hasTreemap:L}}=i;if(N){const w=s.axis_rotated,X=i.getResettedPadding(1),W={x:w?X:0,y:w?0:m,subX:w?1:0,subY:w?0:P},H={x:w?m:v,y:w?v:X,subX:w?m:v,subY:w?S:1},k=e&&((n=f.x)==null?void 0:n.orgDomain()),K=e&&c.xDomain;f.x=i.getXScale(W.x,H.x,k,()=>o.x.tickOffset()),f.subX=i.getXScale(W.x,H.x,K,at=>{var ht;return at%1?0:((ht=o.subX)!=null?ht:o.x).tickOffset()}),l.xAxisTick=o.getXAxisTickFormat(),l.subXAxisTick=o.getXAxisTickFormat(!0),o.setAxis("x",f.x,s.axis_x_tick_outer,t),s.subchart_show&&o.setAxis("subX",f.subX,s.axis_x_tick_outer,t),f.y=i.getYScale("y",W.y,H.y,f.y?f.y.domain():s.axis_y_default),f.subY=i.getYScale("y",W.subY,H.subY,f.subY?f.subY.domain():s.axis_y_default),o.setAxis("y",f.y,s.axis_y_tick_outer,t),s.axis_y2_show&&(f.y2=i.getYScale("y2",W.y,H.y,f.y2?f.y2.domain():s.axis_y2_default),f.subY2=i.getYScale("y2",W.subY,H.subY,f.subY2?f.subY2.domain():s.axis_y2_default),o.setAxis("y2",f.y2,s.axis_y2_tick_outer,t))}else if(L){const w=i.getCurrentPadding();f.x=Di().rangeRound([w.left,g.width-w.right]),f.y=Di().rangeRound([w.top,g.height-w.bottom])}else(a=i.updateArc)==null||a.call(i)},xx(t){const e=this,{config:n,scale:{x:a,zoom:i}}=e,o=n.zoom_enabled&&i?i:a;return t?o(De(t.x)?t.x:t):null},xv(t){const e=this,{axis:n,config:a,scale:{x:i,zoom:o}}=e,s=a.zoom_enabled&&o?o:i;let l=e.getBaseValue(t);return n.isTimeSeries()?l=Yn.call(e,l):n.isCategorized()&&ze(l)&&(l=a.axis_x_categories.indexOf(l)),s(l)},yv(t){const e=this,{scale:{y:n,y2:a}}=e;return(t.axis&&t.axis==="y2"?a:n)(e.getBaseValue(t))},subxx(t){return t?this.scale.subX(t.x):null}},Up={setContainerSize(){const t=this,{state:e}=t;e.current.width=t.getCurrentWidth(),e.current.height=t.getCurrentHeight()},getCurrentWidth(){const t=this;return t.config.size_width||t.getParentWidth()},getCurrentHeight(){const t=this,{config:e}=t,n=e.size_height||t.getParentHeight();return n>0?n:320/(t.hasType("gauge")&&!e.gauge_fullCircle?2:1)},getParentRectValue(t){const e=`offset${Cn(t)}`;let n=this.$el.chart.node(),a=0;for(;a<30&&n&&n.tagName!=="BODY";){try{a=n.getBoundingClientRect()[t]}catch(o){e in n&&(a=n[e])}n=n.parentNode}const i=gn.body[e];return a>i&&(a=i),a},getParentWidth(){return this.getParentRectValue("width")},getParentHeight(){const t=this.$el.chart.style("height");let e=0;return t&&(e=/px$/.test(t)?parseInt(t,10):this.getParentRectValue("height")),e},getSvgLeft(t){const e=this,{config:n,state:{hasAxis:a},$el:i}=e,o=n.axis_rotated,s=o||!o&&!n.axis_y_inner,l=o?Tn.axisX:Tn.axisY,c=i.main.select(`.${l}`).node(),f=a&&n[`axis_${o?"x":"y"}_label`];let g=0;if(a&&(ze(f)||ze(f.text)||/^inner-/.test(f==null?void 0:f.position))){const N=i.main.select(`.${l}-label`);N.empty()||(g=N.node().getBoundingClientRect().left)}const v=c&&s?c.getBoundingClientRect():{right:0},m=i.chart.node().getBoundingClientRect().left+g,S=e.hasArcType(),P=v.right-m-(S?0:e.getCurrentPaddingByDirection("left",t));return P>0?P:0},updateDimension(t){var e;const n=this,{config:a,state:{hasAxis:i},$el:o}=n;i&&!t&&n.axis.x&&a.axis_rotated&&((e=n.axis.subX)==null||e.create(o.axis.subX)),n.updateScales(t),n.updateSvgSize(),n.transformAll(!1)},updateSvgSize(){const t=this,{config:e,state:{clip:n,current:a,hasAxis:i,width:o,height:s},$el:{svg:l}}=t;if(e.resize_auto==="viewBox"?l.attr("viewBox",`0 0 ${a.width} ${a.height}`):l.attr("width",a.width).attr("height",a.height),i){const c=l.select(`.${ks.brush} .overlay`),f={width:0,height:0};c.size()&&(f.width=+c.attr("width"),f.height=+c.attr("height")),l.selectAll([`#${n.id}`,`#${n.idGrid}`]).select("rect").attr("width",o).attr("height",s),l.select(`#${n.idXAxis}`).select("rect").call(t.setXAxisClipPath.bind(t)),l.select(`#${n.idYAxis}`).select("rect").call(t.setYAxisClipPath.bind(t)),n.idSubchart&&l.select(`#${n.idSubchart}`).select("rect").attr("width",o).attr("height",f.height)}},getCurrentPaddingByDirection(t,e=!1,n=!1){var a;const i=this,{config:o,$el:s,state:{hasAxis:l}}=i,c=o.axis_rotated,f=((a=o.padding)==null?void 0:a.mode)==="fit",g=he(o[`padding_${t}`])?o[`padding_${t}`]:void 0,v=l?{top:c?"y2":null,bottom:c?"y":"x",left:c?"x":"y",right:c?null:"y2"}[t]:null,m=/^(left|right)$/.test(t),S=v&&o[`axis_${v}_inner`],P=v&&o[`axis_${v}_show`],N=v?o[`axis_${v}_axes`].length:0;let L=v?m?i.getAxisWidthByAxisId(v,e):i.getHorizontalAxisHeight(v):0;const w=20;let X=0;!f&&m&&(L=Jg(L));let W=l&&m&&(S||ln(g)&&!P)?0:f?(P?L:0)+(g!=null?g:0):ln(g)?L:g;return m&&l?(v&&(f||S)&&o[`axis_${v}_label`].text&&(W+=i.axis.getAxisLabelPosition(v).isOuter?w:0),t==="right"?(W+=c?!f&&ln(g)?10:2:!P||S?f?2:1:0,W+=n?i.axis.getXAxisTickTextY2Overflow(w):0):t==="left"&&c&&ln(g)&&(W=o.axis_x_show?f?L:Math.max(L,40):1)):t==="top"?(s.title&&s.title.node()&&(W+=i.getTitlePadding()),X=c&&!S?N:0):t==="bottom"&&l&&c&&!P&&(W+=1),W+L*N-X},getCurrentPadding(t=!1){const e=this,[n,a,i,o]=["top","bottom","left","right"].map(s=>e.getCurrentPaddingByDirection(s,null,t));return{top:n,bottom:a,left:i,right:o}},getResettedPadding(t){const e=this,{config:n}=e,a=he(t);let i=a?0:{};return n.padding===!1?!a&&Object.keys(t).forEach(o=>{i[o]=!qn(n.data_labels)&&n.data_labels!==!1&&o==="top"?t[o]:0}):i=t,i},updateSizes(t){var e,n,a,i,o;const s=this,{config:l,state:c,$el:{legend:f}}=s,g=l.axis_rotated,v=s.hasArcType()||c.hasFunnel||c.hasTreemap,m=((e=l.padding)==null?void 0:e.mode)==="fit";!t&&s.setContainerSize();const S={width:f?s.getLegendWidth():0,height:f?s.getLegendHeight():0};!v&&l.axis_x_show&&l.axis_x_tick_autorotate&&s.updateXAxisTickClip();const P={right:l.legend_show&&c.isLegendRight?s.getLegendWidth()+(m?0:20):0,bottom:!l.legend_show||c.isLegendRight||c.isLegendInset?0:S.height},N=g||v?0:s.getHorizontalAxisHeight("x"),L=l.subchart_axis_x_show&&l.subchart_axis_x_tick_text_show?N:30,w=l.subchart_show&&!v?l.subchart_size_height+L:0,X=s.hasType("gauge")&&l.arc_needle_show&&!l.gauge_fullCircle&&!l.gauge_label_show?10:0,W=s.getCurrentPadding(!0);if(c.margin=!v&&g?{top:W.top,right:v?0:W.right+P.right,bottom:P.bottom+W.bottom,left:w+(v?0:W.left)}:{top:(m?0:4)+W.top,right:v?0:W.right+P.right,bottom:X+w+P.bottom+W.bottom,left:v?0:W.left},c.margin=s.getResettedPadding(c.margin),c.margin2=g?{top:c.margin.top,right:NaN,bottom:20+P.bottom,left:s.state.rotatedPadding.left}:{top:c.current.height-w-P.bottom,right:NaN,bottom:L+P.bottom,left:c.margin.left},c.margin3={top:0,right:NaN,bottom:0,left:0},(n=s.updateSizeForLegend)==null||n.call(s,S),c.width=c.current.width-c.margin.left-c.margin.right,c.height=c.current.height-c.margin.top-c.margin.bottom,c.width<0&&(c.width=0),c.height<0&&(c.height=0),c.width2=g?c.margin.left-c.rotatedPadding.left-c.rotatedPadding.right:c.width,c.height2=g?c.height:c.current.height-c.margin2.top-c.margin2.bottom,c.width2<0&&(c.width2=0),c.height2<0&&(c.height2=0),s.hasArcType()){const H=s.hasType("gauge"),k=l.legend_show&&c.isLegendRight,K=(a=c.hasRadar&&s.cache.get(Ln.radarTextWidth))!=null?a:0;c.arcWidth=c.width-(k?S.width+10:0)-K,c.arcHeight=c.height-(k&&!H?0:10),(i=l.arc_rangeText_values)!=null&&i.length&&(H?(c.arcWidth-=25,c.arcHeight-=10,c.margin.left+=10):(c.arcHeight-=20,c.margin.top+=10)),H&&!l.gauge_fullCircle&&(c.arcHeight+=c.height-s.getPaddingBottomForGauge()),(o=s.updateRadius)==null||o.call(s)}c.isLegendRight&&v&&(c.margin3.left=c.arcWidth/2+c.radiusExpanded*1.1)}},zp={setCssRule(t,e,n,a){const i=this,{config:o,state:{cssRule:s,style:l}}=i;return o.boost_useCssRule?c=>{c.each(f=>{const g=a&&(a==null?void 0:a.call(i,f)),v=`${t?`.${sn.shapes+i.getTargetSelectorSuffix(f.id)}`:""}${e}`;e in s&&l.sheet.deleteRule(s[v]),i.state.cssRule[v]=_g(l,v,n.filter(Boolean).map(m=>ze(g)&&m.indexOf(":")===-1?`${m}: ${g}`:m||""))})}:()=>{}},getStylePropValue(t){const{config:{boost_useCssRule:e}}=this;return e?null:ve(t)?t.bind(this):t}};function Uc(t){return typeof t=="string"?new Ie([document.querySelectorAll(t)],[document.documentElement]):new Ie([T(t)],_t)}function jp(t){let e="middle";return t>0&&t<=170?e="end":t>190&&t<=360&&(e="start"),e}function Vp(t,e,n,a,i){var o;const s=this,{value:l}=t,c=s.isCandlestickType(t),f=he(l)&&l<0||c&&!((o=s.getCandlestickData(t))!=null&&o._isUp);let{x:g,y:v}=e;const m=4,S=m*2;return a?n==="start"?(g+=f?0:S,v+=m):n==="middle"?(g+=S,v-=S):n==="end"&&(f&&(g-=S),v+=m):(n==="start"?(g+=m,f&&(v+=S*2)):n==="middle"?v-=S:n==="end"&&(g-=m,f&&(v+=S*2)),i&&(v+=f?-17:c?13:7)),{x:g,y:v}}function zc(t,e){var n;const a=this.config.data_labels_position,{id:i,index:o,value:s}=t;return(n=ve(a)?a.bind(this.api)(e,s,i,o,this.$el.text):(i in a?a[i]:a)[e])!=null?n:0}var Gp={opacityForText(t){const e=this;return e.isBarType(t)&&!e.meetsLabelThreshold(Math.abs(e.getRatio("bar",t)),"bar")?"0":e.hasDataLabel?null:"0"},initText(){const{$el:t}=this;t.main.select(`.${Se.chart}`).append("g").attr("class",On.chartTexts).style("pointer-events",t.funnel||t.treemap?"none":null)},updateTargetsForText(t){const e=this,n=e.getChartClass("Text"),a=e.getClass("texts","id"),i=e.classFocus.bind(e);e.$el.main.select(`.${On.chartTexts}`).selectAll(`.${On.chartText}`).data(t).attr("class",l=>`${n(l)}${i(l)}`.trim()).enter().append("g").style("opacity","0").attr("class",n).call(e.setCssRule(!0,` .${On.text}`,["fill","pointer-events:none"],e.updateTextColor)).append("g").attr("class",a)},updateText(){const t=this,{$el:e,$T:n,config:a,axis:i}=t,o=t.getClass("text","index"),s=a.data_labels.centered,l=e.main.selectAll(`.${On.texts}`).selectAll(`.${On.text}`).data(t.labelishData.bind(t));n(l.exit()).style("fill-opacity","0").remove(),e.text=l.enter().append("text").merge(l).attr("class",o).attr("text-anchor",c=>{let g=a[`axis_${i==null?void 0:i.getId(c.id)}_inverted`]?c.value>0:c.value<0;if(t.isCandlestickType(c)){const v=t.getCandlestickData(c);g=!(v!=null&&v._isUp)}else if(t.isTreemapType(c))return s?"middle":"start";return a.axis_rotated?g?"end":"start":"middle"}).style("fill",t.getStylePropValue(t.updateTextColor)).style("fill-opacity","0").each(function(c,f,g){const v=ot(this);let{value:m}=c;if(t.isBubbleZType(c))m=t.getBubbleZData(m,"z");else if(t.isCandlestickType(c)){const S=t.getCandlestickData(c);S&&(m=S.close)}m=t.isTreemapType(c)?t.treemapDataLabelFormat(c)(v):t.dataLabelFormat(c.id)(m,c.id,c.index,g),he(m)?this.textContent=m:wa(v,m)})},updateTextColor(t){const e=this,{config:n}=e,a=n.data_labels_colors,i=e.isArcType(t)&&!e.isRadarType(t)||e.isFunnelType(t)||e.isTreemapType(t)?null:e.color(t);let o;if(ze(a))o=a;else if(Be(a)){const{id:s}=t.data||t;o=a[s]}else ve(a)&&(o=a.bind(e.api)(i,t));if(e.isCandlestickType(t)&&!ve(a)){const s=e.getCandlestickData(t);if(!(s!=null&&s._isUp)){const l=n.candlestick_color_down;o=Be(l)?l[t.id]:l}}return o||i},updateTextBGColor(t,e){const n=this,{$el:a}=n;let i="";if(ze(e)||Be(e)){const o=ze(e)?"":n.getTargetSelectorSuffix("id"in t?t.id:t.data.id),s=a.defs.select(["filter[id*='labels-bg","']"].join(o));s.size()&&(i=`url(#${s.attr("id")})`)}return i||null},redrawText(t,e,n,a){const i=this,{$T:o,axis:s,config:l,state:{hasTreemap:c}}=i,f=gr(!0),g=l.axis_rotated,v=l.data_labels.rotate,m=jp(v),S=v?`rotate(${v})`:"";return i.$el.text.style("fill",i.getStylePropValue(i.updateTextColor)).attr("filter",P=>i.updateTextBGColor.bind(i)(P,l.data_labels_backgroundColors)).style("fill-opacity",n?0:i.opacityForText.bind(i)).each(function(P,N){const L=o(c&&this.childElementCount?this.parentNode:this,!!(a&&this.getAttribute("x")),f),w=l[`axis_${s==null?void 0:s.getId(P.id)}_inverted`];let X={x:t.bind(this)(P,N),y:e.bind(this)(P,N)};v&&(X=Vp.bind(i)(P,X,m,g,w),L.attr("text-anchor",m)),this.childElementCount||v?L.attr("transform",`translate(${X.x} ${X.y}) ${S}`):L.attr("x",X.x).attr("y",X.y)}),!0},getTextRect(t,e){const n=this;let a=t.node?t.node():t;/text/i.test(a.tagName)||(a=a.querySelector("text"));const i=a.textContent,o=`${Ln.textRect}-${i.replace(/\W/g,"_")}`;let s=n.cache.get(o);return s||(n.$el.svg.append("text").style("visibility","hidden").style("font",ot(a).style("font")).classed(e,!0).text(i).call(l=>{s=Ma(l.node())}).remove(),n.cache.add(o,s)),s},generateXYForText(t,e){const n=this,{state:{hasRadar:a,hasFunnel:i,hasTreemap:o}}=n,s=Object.keys(t),l={},c=e?n.getXForText:n.getYForText;return i&&s.push("funnel"),a&&s.push("radar"),o&&s.push("treemap"),s.forEach(f=>{l[f]=n[`generateGet${Cn(f)}Points`](t[f],!1)}),function(f,g){const v=n.isAreaType(f)&&"area"||n.isBarType(f)&&"bar"||n.isCandlestickType(f)&&"candlestick"||n.isFunnelType(f)&&"funnel"||n.isRadarType(f)&&"radar"||n.isTreemapType(f)&&"treemap"||"line";return c.call(n,l[v](f,g),f,this)}},getCenteredTextPos(t,e,n,a){const i=this,{config:o}=i,s=o.axis_rotated,l=i.isBarType(t),c=i.isTreemapType(t);if(o.data_labels.centered&&(l||c)){const f=Ma(n);if(l){const g=i.getRangedData(t,null,"bar")>=0;if(s){const v=(g?e[1][1]-e[0][1]:e[0][1]-e[1][1])/2+f.width/2;return g?-v-3:v+2}else{const v=(g?e[0][1]-e[1][1]:e[1][1]-e[0][1])/2+f.height/2;return g?v:-v-2}}else if(c)return a==="x"?(e[1][0]-e[0][0])/2:(e[1][1]-e[0][1])/2+f.height/2}return 0},getXForText(t,e,n){var a;const i=this,{config:o}=i,s=o.axis_rotated,l=i.isFunnelType(e),c=i.isTreemapType(e);let f=t?t[0][0]:0;if(i.isCandlestickType(e))s?f=(a=i.getCandlestickData(e))!=null&&a._isUp?t[2][2]+4:t[2][1]-4:f+=(t[1][0]-f)/2;else if(l)f+=i.state.current.width/2;else if(c)f+=o.data_labels.centered?0:5;else if(s){const g=o[`axis_${i.axis.getId(e.id)}_inverted`],v=i.isBarType(e)?4:6,m=e.value;f=t[2][1],g?f-=v*(m>0?1:-1):f+=v*(m<0?-1:1)}else f=i.hasType("bar")?(t[2][0]+t[0][0])/2:f;return(s||c)&&(f+=i.getCenteredTextPos(e,t,n,"x")),f+zc.call(this,e,"x")},getYForText(t,e,n){const a=this,{axis:i,config:o,state:s}=a,l=o.axis_rotated,c=o[`axis_${i==null?void 0:i.getId(e.id)}_inverted`],f=a.isBarType(e),g=a.isFunnelType(e),v=a.isTreemapType(e),m=o.point_r,S=Ma(n);let{value:P}=e,N=3,L;if(a.isCandlestickType(e))P=a.getCandlestickData(e),l?(L=t[0][0],L+=(t[1][0]-L)/2+N):(L=P&&P._isUp?t[2][2]-N:t[2][1]+N*4,c&&(L+=15*(P._isUp?1:-1)));else if(g)L=t?t[0][1]+(t[1][1]-t[0][1])/2+S.height/2-3:0;else if(v)L=t[0][1]+(o.data_labels.centered?0:S.height+5);else if(l)L=(t[0][0]+t[2][0]+S.height*.6)/2;else if(L=t[2][1],he(m)&&m>5&&(a.isLineType(e)||a.isScatterType(e))&&(N+=o.point_r/2.3),P<0||P===0&&!s.hasPositiveValue&&s.hasNegativeValue)L+=c?f?-3:-5:S.height+(f?-N:N);else{let w=-N*2;f?w=-N:a.isBubbleType(e)&&(w=N),c&&(w=f?10:15),L+=w}return(!l||v)&&(L+=a.getCenteredTextPos(e,t,n,"y")),L+zc.call(this,e,"y")},markOverlapped(t,e,n){const a=e.$el.arcs.selectAll(n),i=a.filter(c=>c.data.id!==t),o=a.filter(c=>c.data.id===t),s=Jl(o.node()),l=(c,f)=>Math.sqrt(Math.pow(c,2)+Math.pow(f,2));o.node()&&i.each(function(){const c=Jl(this),f=ot(this),g=l(s.e,s.f)>l(c.e,c.f)?o:f,v=Math.ceil(Math.abs(s.e-c.e))=i}};function jc(t="left",e){const n=he(e);let a;return t.indexOf("center")>-1?a=n?e/2:"middle":t.indexOf("right")>-1?a=n?e:"end":a=n?0:"start",a}var Xp={initTitle(){const t=this,{config:e,$el:n}=t;if(e.title_text){n.title=n.svg.append("g");const a=n.title.append("text").style("text-anchor",jc(e.title_position)).attr("class",On.title);wa(a,e.title_text,[.3,1.5])}},redrawTitle(){const t=this,{config:e,state:{current:n},$el:{title:a}}=t;if(a){const i=jc(e.title_position,n.width),o=(e.title_padding.top||0)+t.getTextRect(t.$el.title,On.title).height;a.attr("transform",`translate(${i}, ${o})`)}},getTitlePadding(){const t=this,{$el:{title:e},config:n}=t;return(n.title_padding.top||0)+(e?t.getTextRect(e,On.title).height:0)+(n.title_padding.bottom||0)}},Hp={initTooltip(){const t=this,{config:e,$el:n}=t;n.tooltip=ot(e.tooltip_contents.bindto),n.tooltip.empty()&&(n.tooltip=n.chart.append("div").attr("class",ei.tooltipContainer).style("position","absolute").style("pointer-events","none").style("display","none")),t.bindTooltipResizePos()},initShowTooltip(){var t;const e=this,{config:n,$el:a,state:{hasAxis:i,hasRadar:o}}=e;if(n.tooltip_init_show){const s=!(i||o);(t=e.axis)!=null&&t.isTimeSeries()&&ze(n.tooltip_init_x)&&(n.tooltip_init_x=Yn.call(e,n.tooltip_init_x)),e.api.tooltip.show({data:{[s?"index":"x"]:n.tooltip_init_x}});const l=n.tooltip_init_position;if(!n.tooltip_contents.bindto&&!qn(l)){const{top:c=0,left:f=50}=l;a.tooltip.style("top",ze(c)?c:`${c}px`).style("left",ze(f)?f:`${f}px`).style("display",null)}}},getTooltipHTML(...t){const e=this,{api:n,config:a}=e;return ve(a.tooltip_contents)?a.tooltip_contents.bind(n)(...t):e.getTooltipContent(...t)},getTooltipContent(t,e,n,a){var i;const o=this,{api:s,config:l,state:c,$el:f}=o,[g,v,m]=["title","name","value"].map(vt=>{const Q=l[`tooltip_format_${vt}`];return ve(Q)?Q.bind(s):Q}),S=(...vt)=>Po((g||e)(...vt)),P=(...vt)=>Po((v||(Q=>Q))(...vt)),N=(...vt)=>{const Q=m||(c.hasTreemap||o.isStackNormalized()?(St,ct)=>`${(ct*100).toFixed(2)}%`:n);return Po(Q(...vt))},L=l.tooltip_order,w=vt=>o.axis&&o.isBubbleZType(vt)?o.getBubbleZData(vt.value,"z"):o.getBaseValue(vt),X=o.levelColor?vt=>o.levelColor(vt.value):vt=>a(vt),W=l.tooltip_contents,H=W.template,k=o.mapToTargetIds();if(L===null&&l.data_groups.length){const vt=o.orderTargets(o.data.targets).map(Q=>Q.id).reverse();t.sort((Q,St)=>{let ct=Q?Q.value:null,At=St?St.value:null;return ct>0&&At>0&&(ct=Q.id?vt.indexOf(Q.id):null,At=St.id?vt.indexOf(St.id):null),ct-At})}else if(/^(asc|desc)$/.test(L)){const vt=L==="asc";t.sort((Q,St)=>{const ct=Q?w(Q):null,At=St?w(St):null;return vt?ct-At:At-ct})}else ve(L)&&t.sort(L.bind(s));const K=o.getTooltipContentTemplate(H),at=t.length;let ht,$t,dt,st,Vt;for(Vt=0;Vt
    		${vt}
    `},getTooltipContentTemplate(t){return(t||` - {=TITLE} - {{ - - - }} -
    ${this.patterns?"{=COLOR}":''}{=NAME}{=VALUE}
    `).replace(/(\r?\n|\t)/g,"").split(/{{(.*)}}/)},setTooltipPosition(t,e){var n,a;const i=this,{config:o,scale:s,state:l,$el:{eventRect:c,tooltip:f,svg:g}}=i,{bindto:v}=o.tooltip_contents,m=o.axis_rotated,S=f==null?void 0:f.datum();if(!v&&S){const P=t!=null?t:JSON.parse(S.current),[N,L]=Hn(l.event,e!=null?e:c==null?void 0:c.node()),w={x:N,y:L};if(l.hasAxis&&s.x&&S&&"x"in S){const k=(K=0,at,ht="y")=>{var $t;const dt=s[at?($t=i.axis)==null?void 0:$t.getId(at):ht];return dt?dt(K)+(m?l.margin.left:l.margin.top):0};w.xAxis=s.x(S.x)+(o.tooltip_position?m?l.margin.top:l.margin.left:0),P.length===1?w.yAxis=k(P[0].value,P[0].id):w.yAxis=k}const{width:X=0,height:W=0}=S,H=(a=(n=o.tooltip_position)==null?void 0:n.bind(i.api)(P,X,W,c==null?void 0:c.node(),w))!=null?a:Lo(g)?i.getTooltipPositionViewBox.bind(i)(X,W,w):i.getTooltipPosition.bind(i)(X,W,w);["top","left"].forEach(k=>{const K=H[k];f.style(k,`${K}px`),k==="left"&&!S.xPosInPercent&&(S.xPosInPercent=K/l.current.width*100)})}},getTooltipPositionViewBox(t,e,n){var a,i;const o=this,{$el:{eventRect:s,svg:l},config:c,state:f}=o,g=c.axis_rotated,v=o.hasArcType()||f.hasFunnel||f.hasTreemap,m=(i=(a=v?l:s)==null?void 0:a.node())!=null?i:f.event.target;let{x:S,y:P}=n;f.hasAxis&&(S=g?S:n.xAxis,P=g?n.xAxis:P);const N=Ai(m,S,P,!1),L=m.getBoundingClientRect(),w=Ai(m,20,0,!1).x;let X=N.y,W=N.x+t/2+w;return v&&(f.hasFunnel||f.hasTreemap||f.hasRadar?(W-=t/2+w,X+=e):(X+=L.height/2,W+=L.width/2-(t-w))),W+t>L.width&&(W=L.width-t-w),X+e>L.height&&(X-=e*2),{top:X,left:W}},getTooltipPosition(t,e,n){var a,i,o;const s=this,{config:l,scale:c,state:f}=s,{width:g,height:v,current:m,hasFunnel:S,hasRadar:P,hasTreemap:N,isLegendRight:L,inputType:w}=f,X=s.hasType("gauge")&&!l.gauge_fullCircle,W=l.axis_rotated,H=s.hasArcType(),k=s.getSvgLeft(!0);let K=k+m.width-s.getCurrentPaddingByDirection("right");const at=20;let{x:ht,y:$t}=n;if(P)ht+=ht>=g/2?15:-(t+15),$t+=15;else if(H){if(w!=="touch"){let Vt=(i=(a=s.getTitlePadding)==null?void 0:a.call(s))!=null?i:0;Vt&&X&&((o=l.arc_rangeText_values)!=null&&o.length)&&(Vt+=10),ht+=(g-(L?s.getLegendWidth():0))/2,$t+=(X?v:v/2+e)+Vt}}else if(S||N)$t+=e;else{const st={top:s.getCurrentPaddingByDirection("top",!0),left:s.getCurrentPaddingByDirection("left",!0)};W?(ht+=k+st.left+at,$t=st.top+n.xAxis+at,K-=k):(ht=k+st.left+at+(c.zoom?ht:n.xAxis),$t+=st.top-5)}if(ht+t+15>K&&(ht-=t+(S||N||H?0:W?at*2:38)),$t+e>m.height){const st=N?e+10:30;$t-=X?e*1.5:e+st}const dt={top:$t,left:ht};return Object.keys(dt).forEach(st=>{dt[st]<0&&(dt[st]=0)}),dt},showTooltip(t,e){const n=this,{config:a,$el:{tooltip:i}}=n,o=t.filter(c=>c&&De(n.getBaseValue(c)));if(!i||o.length===0||!a.tooltip_show)return;let s=i.datum();const l=JSON.stringify(t);if(!s||s.current!==l){const{index:c,x:f}=t.concat().sort()[0];_e(a.tooltip_onshow,n.api,t),i.html(n.getTooltipHTML(t,n.axis?n.axis.getXAxisTickFormat():n.categoryName.bind(n),n.getDefaultValueFormat(),n.color)).style("display",null).style("visibility",null).datum(s={index:c,x:f,current:l,width:i.property("offsetWidth"),height:i.property("offsetHeight")}),_e(a.tooltip_onshown,n.api,t),n._handleLinkedCharts(!0,c)}n.setTooltipPosition(o,e)},bindTooltipResizePos(){const t=this,{resizeFunction:e,state:n,$el:{tooltip:a}}=t;e.add(()=>{if(a.style("display")==="block"){const{current:i}=n,{width:o,xPosInPercent:s}=a.datum();let l=i.width/100*s;const c=i.width-(l+o);c<0&&(l+=c),a.style("left",`${l}px`)}})},hideTooltip(t){var e;const n=this,{api:a,config:i,$el:{tooltip:o}}=n;if(o&&o.style("display")!=="none"&&(!i.tooltip_doNotHide||t)){const s=JSON.parse((e=o.datum().current)!=null?e:{});_e(i.tooltip_onhide,a,s),o.style("display","none").style("visibility","hidden").datum(null),_e(i.tooltip_onhidden,a,s)}},_handleLinkedCharts(t,e){const n=this,{charts:a,config:i,state:{event:o}}=n;if(o!=null&&o.isTrusted&&i.tooltip_linked&&a.length>1){const s=i.tooltip_linked_name;a.filter(l=>l!==n.api).forEach(l=>{const{config:c,$el:f}=l.internal,g=c.tooltip_linked,v=c.tooltip_linked_name,m=gn.body.contains(f.chart.node());if(g&&s===v&&m){const S=f.tooltip.data()[0],P=e!==(S==null?void 0:S.index);try{l.tooltip[t&&P?"show":"hide"]({index:e})}catch(N){}}})}},updateTooltipOnRedraw(t,e){var n;const a=this,{config:i,$el:{eventRect:o,svg:s,tooltip:l},state:{event:c,hasAxis:f,hasRadar:g,hasTreemap:v}}=a;if((l==null?void 0:l.style("display"))==="block"&&c){const m=t!=null?t:(n=g?s:o)==null?void 0:n.node();if(f||g)if(a.isMultipleX())a.selectRectForMultipleXs(m,!1);else{const S=e!=null?e:a.getDataIndexFromEvent(c);e===-1?a.api.tooltip.hide():(a.selectRectForSingle(m,S),a.setExpand(S,null,!0))}else{const{clientX:S,clientY:P}=c;setTimeout(()=>{let N=[S,P].every(Number.isFinite)&&gn.elementFromPoint(S,P);const L=N&&ot(N).datum();if(L){const w=a.hasArcType()?a.convertToArcData(a.updateAngle(L)):L==null?void 0:L.data;v&&(N=s.node()),w&&a.showTooltip([w],N)}else a.api.tooltip.hide()},i.transition_duration)}}}},Yp={getTranslate(t,e=0){var n;const a=this,{config:i,state:o}=a,s=i.axis_rotated;let l=0,c,f;if(e&&/^(x|y2?)$/.test(t)&&(l=a.getAxisSize(t)*e),t==="main")c=$i(o.margin.left),f=$i(o.margin.top);else if(t==="context")c=$i(o.margin2.left),f=$i(o.margin2.top);else if(t==="legend")c=o.margin3.left,f=o.margin3.top;else if(t==="x")c=s?-l:0,f=s?0:o.height+l;else if(t==="y")c=s?0:-l,f=s?o.height+l:0;else if(t==="y2")c=s?0:o.width+l,f=s?-l-1:0;else if(t==="subX")c=0,f=s?0:o.height2;else if(t==="arc")c=o.arcWidth/2,f=o.arcHeight/2,(n=i.arc_rangeText_values)!=null&&n.length&&(f+=5+(a.hasType("gauge")&&i.title_text?10:0));else if(t==="polar")c=o.arcWidth/2,f=o.arcHeight/2;else if(t==="radar"){const[g,v]=a.getRadarSize();c=o.width/2-g,f=o.height/2-v}return`translate(${c}, ${f})`},transformMain(t,e){const n=this,{$el:{main:a},$T:i}=n,o=e!=null&&e.axisX?e.axisX:i(a.select(`.${Tn.axisX}`),t),s=e!=null&&e.axisY?e.axisY:i(a.select(`.${Tn.axisY}`),t),l=e!=null&&e.axisY2?e.axisY2:i(a.select(`.${Tn.axisY2}`),t);i(a,t).attr("transform",n.getTranslate("main")),o.attr("transform",n.getTranslate("x")),s.attr("transform",n.getTranslate("y")),l.attr("transform",n.getTranslate("y2")),a.select(`.${Ve.chartArcs}`).attr("transform",n.getTranslate("arc"))},transformAll(t,e){const n=this,{config:a,state:{hasAxis:i,hasFunnel:o,hasTreemap:s},$el:l}=n;!o&&!s&&n.transformMain(t,e),i&&a.subchart_show&&n.transformContext(t,e),l.legend&&n.transformLegend(t)}},Wp={isValidChartType(t){return!!(t&&Object.values(oe).indexOf(t)>-1)},setTargetType(t,e){const n=this,{config:a,state:{withoutFadeIn:i}}=n;n.mapToTargetIds(t).forEach(o=>{i[o]=e===a.data_types[o],a.data_types[o]=e}),t||(a.data_type=e)},updateTypesElements(){const t=this,{state:{current:e}}=t;Object.keys(oe).forEach(n=>{const a=oe[n],i=t.hasType(a,null,!0),o=e.types.indexOf(a);o===-1&&i?e.types.push(a):o>-1&&!i&&e.types.splice(o,1)}),t.setChartElements()},hasType(t,e,n=!1){var a;const i=this,{config:o,state:{current:s}}=i,l=o.data_types,c=e||i.data.targets;let f=!1;return!n&&((a=s.types)==null?void 0:a.indexOf(t))>-1?f=!0:c!=null&&c.length?c.forEach(g=>{const v=l[g.id];(v===t||!v&&t==="line")&&(f=!0)}):Object.keys(l).length?Object.keys(l).forEach(g=>{l[g]===t&&(f=!0)}):f=o.data_type===t,f},hasTypeOf(t,e,n=[]){return t in Sr?!Sr[t].filter(a=>n.indexOf(a)===-1).every(a=>!this.hasType(a,e)):!1},isTypeOf(t,e){var n;const a=ze(t)?t:t.id,i=this.config&&(((n=this.config.data_types)==null?void 0:n[a])||this.config.data_type);return je(e)?e.indexOf(i)>=0:i===e},hasPointType(){const t=this;return t.hasTypeOf("Line")||t.hasType("bubble")||t.hasType("scatter")},hasArcType(t,e){return this.hasTypeOf("Arc",t,e)},hasMultiArcGauge(){return this.hasType("gauge")&&this.config.gauge_type==="multi"},isLineType(t){const e=ze(t)?t:t.id;return!this.config.data_types[e]||this.isTypeOf(e,Sr.Line)},isStepType(t){return this.isTypeOf(t,Sr.Step)},isSplineType(t){return this.isTypeOf(t,Sr.Spline)},isAreaType(t){return this.isTypeOf(t,Sr.Area)},isAreaRangeType(t){return this.isTypeOf(t,Sr.AreaRange)},isBarType(t){return this.isTypeOf(t,"bar")},isBubbleType(t){return this.isTypeOf(t,"bubble")},isCandlestickType(t){return this.isTypeOf(t,"candlestick")},isScatterType(t){return this.isTypeOf(t,"scatter")},isTreemapType(t){return this.isTypeOf(t,"treemap")},isPieType(t){return this.isTypeOf(t,"pie")},isFunnelType(t){return this.isTypeOf(t,"funnel")},isGaugeType(t){return this.isTypeOf(t,"gauge")},isDonutType(t){return this.isTypeOf(t,"donut")},isPolarType(t){return this.isTypeOf(t,"polar")},isRadarType(t){return this.isTypeOf(t,"radar")},isArcType(t){return this.isPieType(t)||this.isDonutType(t)||this.isGaugeType(t)||this.isPolarType(t)||this.isRadarType(t)},isCirclePoint(t){const{config:e}=this,n=e.point_pattern;let a=!1;return(t==null?void 0:t.tagName)==="circle"?a=!0:a=e.point_type==="circle"&&(!n||je(n)&&n.length===0),a},lineData(t){return this.isLineType(t)?[t]:[]},arcData(t){return this.isArcType(t.data)?[t]:[]},labelishData(t){return this.isBarType(t)||this.isLineType(t)||this.isScatterType(t)||this.isBubbleType(t)||this.isCandlestickType(t)||this.isFunnelType(t)||this.isRadarType(t)||this.isTreemapType(t)?t.values.filter(e=>he(e.value)||!!e.value):[]},barLineBubbleData(t){return this.isBarType(t)||this.isLineType(t)||this.isBubbleType(t)?t.values:[]},isInterpolationType(t){return["basis","basis-closed","basis-open","bundle","cardinal","cardinal-closed","cardinal-open","catmull-rom","catmull-rom-closed","catmull-rom-open","linear","linear-closed","monotone-x","monotone-y","natural"].indexOf(t)>=0}};function Ni(t,e,n){t._context.bezierCurveTo((2*t._x0+t._x1)/3,(2*t._y0+t._y1)/3,(t._x0+2*t._x1)/3,(t._y0+2*t._y1)/3,(t._x0+4*t._x1+e)/6,(t._y0+4*t._y1+n)/6)}function Fi(t){this._context=t}Fi.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x0=this._x1=this._y0=this._y1=NaN,this._point=0},lineEnd:function(){switch(this._point){case 3:Ni(this,this._x1,this._y1);case 2:this._context.lineTo(this._x1,this._y1);break}(this._line||this._line!==0&&this._point===1)&&this._context.closePath(),this._line=1-this._line},point:function(t,e){switch(t=+t,e=+e,this._point){case 0:this._point=1,this._line?this._context.lineTo(t,e):this._context.moveTo(t,e);break;case 1:this._point=2;break;case 2:this._point=3,this._context.lineTo((5*this._x0+this._x1)/6,(5*this._y0+this._y1)/6);default:Ni(this,t,e);break}this._x0=this._x1,this._x1=t,this._y0=this._y1,this._y1=e}};function Kp(t){return new Fi(t)}function Ar(){}function Vc(t){this._context=t}Vc.prototype={areaStart:Ar,areaEnd:Ar,lineStart:function(){this._x0=this._x1=this._x2=this._x3=this._x4=this._y0=this._y1=this._y2=this._y3=this._y4=NaN,this._point=0},lineEnd:function(){switch(this._point){case 1:{this._context.moveTo(this._x2,this._y2),this._context.closePath();break}case 2:{this._context.moveTo((this._x2+2*this._x3)/3,(this._y2+2*this._y3)/3),this._context.lineTo((this._x3+2*this._x2)/3,(this._y3+2*this._y2)/3),this._context.closePath();break}case 3:{this.point(this._x2,this._y2),this.point(this._x3,this._y3),this.point(this._x4,this._y4);break}}},point:function(t,e){switch(t=+t,e=+e,this._point){case 0:this._point=1,this._x2=t,this._y2=e;break;case 1:this._point=2,this._x3=t,this._y3=e;break;case 2:this._point=3,this._x4=t,this._y4=e,this._context.moveTo((this._x0+4*this._x1+t)/6,(this._y0+4*this._y1+e)/6);break;default:Ni(this,t,e);break}this._x0=this._x1,this._x1=t,this._y0=this._y1,this._y1=e}};function Zp(t){return new Vc(t)}function Gc(t){this._context=t}Gc.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x0=this._x1=this._y0=this._y1=NaN,this._point=0},lineEnd:function(){(this._line||this._line!==0&&this._point===3)&&this._context.closePath(),this._line=1-this._line},point:function(t,e){switch(t=+t,e=+e,this._point){case 0:this._point=1;break;case 1:this._point=2;break;case 2:this._point=3;var n=(this._x0+4*this._x1+t)/6,a=(this._y0+4*this._y1+e)/6;this._line?this._context.lineTo(n,a):this._context.moveTo(n,a);break;case 3:this._point=4;default:Ni(this,t,e);break}this._x0=this._x1,this._x1=t,this._y0=this._y1,this._y1=e}};function Jp(t){return new Gc(t)}function Xc(t,e){this._basis=new Fi(t),this._beta=e}Xc.prototype={lineStart:function(){this._x=[],this._y=[],this._basis.lineStart()},lineEnd:function(){var t=this._x,e=this._y,n=t.length-1;if(n>0)for(var a=t[0],i=e[0],o=t[n]-a,s=e[n]-i,l=-1,c;++l<=n;)c=l/n,this._basis.point(this._beta*t[l]+(1-this._beta)*(a+c*o),this._beta*e[l]+(1-this._beta)*(i+c*s));this._x=this._y=null,this._basis.lineEnd()},point:function(t,e){this._x.push(+t),this._y.push(+e)}};var Qp=function t(e){function n(a){return e===1?new Fi(a):new Xc(a,e)}return n.beta=function(a){return t(+a)},n}(.85);function Bi(t,e,n){t._context.bezierCurveTo(t._x1+t._k*(t._x2-t._x0),t._y1+t._k*(t._y2-t._y0),t._x2+t._k*(t._x1-e),t._y2+t._k*(t._y1-n),t._x2,t._y2)}function ls(t,e){this._context=t,this._k=(1-e)/6}ls.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x0=this._x1=this._x2=this._y0=this._y1=this._y2=NaN,this._point=0},lineEnd:function(){switch(this._point){case 2:this._context.lineTo(this._x2,this._y2);break;case 3:Bi(this,this._x1,this._y1);break}(this._line||this._line!==0&&this._point===1)&&this._context.closePath(),this._line=1-this._line},point:function(t,e){switch(t=+t,e=+e,this._point){case 0:this._point=1,this._line?this._context.lineTo(t,e):this._context.moveTo(t,e);break;case 1:this._point=2,this._x1=t,this._y1=e;break;case 2:this._point=3;default:Bi(this,t,e);break}this._x0=this._x1,this._x1=this._x2,this._x2=t,this._y0=this._y1,this._y1=this._y2,this._y2=e}};var kp=function t(e){function n(a){return new ls(a,e)}return n.tension=function(a){return t(+a)},n}(0);function cs(t,e){this._context=t,this._k=(1-e)/6}cs.prototype={areaStart:Ar,areaEnd:Ar,lineStart:function(){this._x0=this._x1=this._x2=this._x3=this._x4=this._x5=this._y0=this._y1=this._y2=this._y3=this._y4=this._y5=NaN,this._point=0},lineEnd:function(){switch(this._point){case 1:{this._context.moveTo(this._x3,this._y3),this._context.closePath();break}case 2:{this._context.lineTo(this._x3,this._y3),this._context.closePath();break}case 3:{this.point(this._x3,this._y3),this.point(this._x4,this._y4),this.point(this._x5,this._y5);break}}},point:function(t,e){switch(t=+t,e=+e,this._point){case 0:this._point=1,this._x3=t,this._y3=e;break;case 1:this._point=2,this._context.moveTo(this._x4=t,this._y4=e);break;case 2:this._point=3,this._x5=t,this._y5=e;break;default:Bi(this,t,e);break}this._x0=this._x1,this._x1=this._x2,this._x2=t,this._y0=this._y1,this._y1=this._y2,this._y2=e}};var qp=function t(e){function n(a){return new cs(a,e)}return n.tension=function(a){return t(+a)},n}(0);function us(t,e){this._context=t,this._k=(1-e)/6}us.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x0=this._x1=this._x2=this._y0=this._y1=this._y2=NaN,this._point=0},lineEnd:function(){(this._line||this._line!==0&&this._point===3)&&this._context.closePath(),this._line=1-this._line},point:function(t,e){switch(t=+t,e=+e,this._point){case 0:this._point=1;break;case 1:this._point=2;break;case 2:this._point=3,this._line?this._context.lineTo(this._x2,this._y2):this._context.moveTo(this._x2,this._y2);break;case 3:this._point=4;default:Bi(this,t,e);break}this._x0=this._x1,this._x1=this._x2,this._x2=t,this._y0=this._y1,this._y1=this._y2,this._y2=e}};var _p=function t(e){function n(a){return new us(a,e)}return n.tension=function(a){return t(+a)},n}(0);const Hc=Math.abs,En=Math.atan2,jr=Math.cos,tm=Math.max,fs=Math.min,rr=Math.sin,oa=Math.sqrt,bn=1e-12,Fa=Math.PI,Ui=Fa/2,zi=2*Fa;function em(t){return t>1?0:t<-1?Fa:Math.acos(t)}function Yc(t){return t>=1?Ui:t<=-1?-Ui:Math.asin(t)}function ds(t,e,n){var a=t._x1,i=t._y1,o=t._x2,s=t._y2;if(t._l01_a>bn){var l=2*t._l01_2a+3*t._l01_a*t._l12_a+t._l12_2a,c=3*t._l01_a*(t._l01_a+t._l12_a);a=(a*l-t._x0*t._l12_2a+t._x2*t._l01_2a)/c,i=(i*l-t._y0*t._l12_2a+t._y2*t._l01_2a)/c}if(t._l23_a>bn){var f=2*t._l23_2a+3*t._l23_a*t._l12_a+t._l12_2a,g=3*t._l23_a*(t._l23_a+t._l12_a);o=(o*f+t._x1*t._l23_2a-e*t._l12_2a)/g,s=(s*f+t._y1*t._l23_2a-n*t._l12_2a)/g}t._context.bezierCurveTo(a,i,o,s,t._x2,t._y2)}function Wc(t,e){this._context=t,this._alpha=e}Wc.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x0=this._x1=this._x2=this._y0=this._y1=this._y2=NaN,this._l01_a=this._l12_a=this._l23_a=this._l01_2a=this._l12_2a=this._l23_2a=this._point=0},lineEnd:function(){switch(this._point){case 2:this._context.lineTo(this._x2,this._y2);break;case 3:this.point(this._x2,this._y2);break}(this._line||this._line!==0&&this._point===1)&&this._context.closePath(),this._line=1-this._line},point:function(t,e){if(t=+t,e=+e,this._point){var n=this._x2-t,a=this._y2-e;this._l23_a=Math.sqrt(this._l23_2a=Math.pow(n*n+a*a,this._alpha))}switch(this._point){case 0:this._point=1,this._line?this._context.lineTo(t,e):this._context.moveTo(t,e);break;case 1:this._point=2;break;case 2:this._point=3;default:ds(this,t,e);break}this._l01_a=this._l12_a,this._l12_a=this._l23_a,this._l01_2a=this._l12_2a,this._l12_2a=this._l23_2a,this._x0=this._x1,this._x1=this._x2,this._x2=t,this._y0=this._y1,this._y1=this._y2,this._y2=e}};var nm=function t(e){function n(a){return e?new Wc(a,e):new ls(a,0)}return n.alpha=function(a){return t(+a)},n}(.5);function Kc(t,e){this._context=t,this._alpha=e}Kc.prototype={areaStart:Ar,areaEnd:Ar,lineStart:function(){this._x0=this._x1=this._x2=this._x3=this._x4=this._x5=this._y0=this._y1=this._y2=this._y3=this._y4=this._y5=NaN,this._l01_a=this._l12_a=this._l23_a=this._l01_2a=this._l12_2a=this._l23_2a=this._point=0},lineEnd:function(){switch(this._point){case 1:{this._context.moveTo(this._x3,this._y3),this._context.closePath();break}case 2:{this._context.lineTo(this._x3,this._y3),this._context.closePath();break}case 3:{this.point(this._x3,this._y3),this.point(this._x4,this._y4),this.point(this._x5,this._y5);break}}},point:function(t,e){if(t=+t,e=+e,this._point){var n=this._x2-t,a=this._y2-e;this._l23_a=Math.sqrt(this._l23_2a=Math.pow(n*n+a*a,this._alpha))}switch(this._point){case 0:this._point=1,this._x3=t,this._y3=e;break;case 1:this._point=2,this._context.moveTo(this._x4=t,this._y4=e);break;case 2:this._point=3,this._x5=t,this._y5=e;break;default:ds(this,t,e);break}this._l01_a=this._l12_a,this._l12_a=this._l23_a,this._l01_2a=this._l12_2a,this._l12_2a=this._l23_2a,this._x0=this._x1,this._x1=this._x2,this._x2=t,this._y0=this._y1,this._y1=this._y2,this._y2=e}};var rm=function t(e){function n(a){return e?new Kc(a,e):new cs(a,0)}return n.alpha=function(a){return t(+a)},n}(.5);function Zc(t,e){this._context=t,this._alpha=e}Zc.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x0=this._x1=this._x2=this._y0=this._y1=this._y2=NaN,this._l01_a=this._l12_a=this._l23_a=this._l01_2a=this._l12_2a=this._l23_2a=this._point=0},lineEnd:function(){(this._line||this._line!==0&&this._point===3)&&this._context.closePath(),this._line=1-this._line},point:function(t,e){if(t=+t,e=+e,this._point){var n=this._x2-t,a=this._y2-e;this._l23_a=Math.sqrt(this._l23_2a=Math.pow(n*n+a*a,this._alpha))}switch(this._point){case 0:this._point=1;break;case 1:this._point=2;break;case 2:this._point=3,this._line?this._context.lineTo(this._x2,this._y2):this._context.moveTo(this._x2,this._y2);break;case 3:this._point=4;default:ds(this,t,e);break}this._l01_a=this._l12_a,this._l12_a=this._l23_a,this._l01_2a=this._l12_2a,this._l12_2a=this._l23_2a,this._x0=this._x1,this._x1=this._x2,this._x2=t,this._y0=this._y1,this._y1=this._y2,this._y2=e}};var am=function t(e){function n(a){return e?new Zc(a,e):new us(a,0)}return n.alpha=function(a){return t(+a)},n}(.5);function Jc(t){return t<0?-1:1}function Qc(t,e,n){var a=t._x1-t._x0,i=e-t._x1,o=(t._y1-t._y0)/(a||i<0&&-0),s=(n-t._y1)/(i||a<0&&-0),l=(o*i+s*a)/(a+i);return(Jc(o)+Jc(s))*Math.min(Math.abs(o),Math.abs(s),.5*Math.abs(l))||0}function kc(t,e){var n=t._x1-t._x0;return n?(3*(t._y1-t._y0)/n-e)/2:e}function hs(t,e,n){var a=t._x0,i=t._y0,o=t._x1,s=t._y1,l=(o-a)/3;t._context.bezierCurveTo(a+l,i+l*e,o-l,s-l*n,o,s)}function ji(t){this._context=t}ji.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x0=this._x1=this._y0=this._y1=this._t0=NaN,this._point=0},lineEnd:function(){switch(this._point){case 2:this._context.lineTo(this._x1,this._y1);break;case 3:hs(this,this._t0,kc(this,this._t0));break}(this._line||this._line!==0&&this._point===1)&&this._context.closePath(),this._line=1-this._line},point:function(t,e){var n=NaN;if(t=+t,e=+e,!(t===this._x1&&e===this._y1)){switch(this._point){case 0:this._point=1,this._line?this._context.lineTo(t,e):this._context.moveTo(t,e);break;case 1:this._point=2;break;case 2:this._point=3,hs(this,kc(this,n=Qc(this,t,e)),n);break;default:hs(this,this._t0,n=Qc(this,t,e));break}this._x0=this._x1,this._x1=t,this._y0=this._y1,this._y1=e,this._t0=n}}};function qc(t){this._context=new _c(t)}(qc.prototype=Object.create(ji.prototype)).point=function(t,e){ji.prototype.point.call(this,e,t)};function _c(t){this._context=t}_c.prototype={moveTo:function(t,e){this._context.moveTo(e,t)},closePath:function(){this._context.closePath()},lineTo:function(t,e){this._context.lineTo(e,t)},bezierCurveTo:function(t,e,n,a,i,o){this._context.bezierCurveTo(e,t,a,n,o,i)}};function im(t){return new ji(t)}function om(t){return new qc(t)}function tu(t){this._context=t}tu.prototype={areaStart:function(){this._line=0},areaEnd:function(){this._line=NaN},lineStart:function(){this._x=[],this._y=[]},lineEnd:function(){var t=this._x,e=this._y,n=t.length;if(n)if(this._line?this._context.lineTo(t[0],e[0]):this._context.moveTo(t[0],e[0]),n===2)this._context.lineTo(t[1],e[1]);else for(var a=eu(t),i=eu(e),o=0,s=1;s=0;--e)i[e]=(s[e]-i[e+1])/o[e];for(o[n-1]=(t[n]+i[n-1])/2,e=0;e=0&&(this._t=1-this._t,this._line=1-this._line)},point:function(t,e){switch(t=+t,e=+e,this._point){case 0:this._point=1,this._line?this._context.lineTo(t,e):this._context.moveTo(t,e);break;case 1:this._point=2;default:{if(this._t<=0)this._context.lineTo(this._x,e),this._context.lineTo(t,e);else{var n=this._x*(1-this._t)+t*this._t;this._context.lineTo(n,this._y),this._context.lineTo(n,e)}break}}this._x=t,this._y=e}};function cm(t){return new Vi(t,.5)}function um(t){return new Vi(t,0)}function fm(t){return new Vi(t,1)}function dm(t){const e=this;let n;return e.isLineType(t)?n=e.generateGetLinePoints(e.getShapeIndices(e.isLineType)):e.isBarType(t)&&(n=e.generateGetBarPoints(e.getShapeIndices(e.isBarType))),n}var hm={getDrawShape(){const t=this,e=t.config.axis_rotated,{hasRadar:n,hasTreemap:a}=t.state,i={type:{},indices:{},pos:{}};if(!a&&["bar","candlestick","line","area"].forEach(o=>{const s=Cn(/^(bubble|scatter)$/.test(o)?"line":o);if(t.hasType(o)||t.hasTypeOf(s)||o==="line"&&(t.hasType("bubble")||t.hasType("scatter"))){const l=t.getShapeIndices(t[`is${s}Type`]),c=t[`generateDraw${s}`];i.indices[o]=l,i.type[o]=c?c.bind(t)(l,!1):void 0}}),!t.hasArcType()||n||a){let o,s;a||(o=n?t.radarCircleX:e?t.circleY:t.circleX,s=n?t.radarCircleY:e?t.circleX:t.circleY),i.pos={xForText:t.generateXYForText(i.indices,!0),yForText:t.generateXYForText(i.indices,!1),cx:(o||function(){}).bind(t),cy:(s||function(){}).bind(t)}}return i},getShapeIndices(t){const e=this,{config:n}=e,a=n.data_xs,i=cn(a),o={};let s=i?{}:0;return i&&Mo(Object.keys(a).map(l=>a[l])).forEach(l=>{s[l]=0,o[l]={}}),e.filterTargetsToShow(e.data.targets.filter(t,e)).forEach(l=>{var c;const f=l.id in a?a[l.id]:"",g=f?o[f]:o;for(let v=0,m;m=n.data_groups[v];v++)if(!(m.indexOf(l.id)<0))for(let S=0,P;P=m[S];S++){if(P in g){g[l.id]=g[P];break}l.id!==P&&f&&(g[P]=(c=g[l.id])!=null?c:s[f])}ln(g[l.id])&&(g[l.id]=f?s[f]++:s++,g.__max__=(f?s[f]:s)-1)}),o},getIndices(t,e,n){const a=this,{data_xs:i,bar_indices_removeNull:o}=a.config,{id:s,index:l}=e;if(a.isBarType(s)&&o){const c={};return a.getAllValuesOnIndex(l,!0).forEach((f,g)=>{c[f.id]=g,c.__max__=g}),c}return cn(i)?t[i[s]]:t},getIndicesMax(t){return cn(this.config.data_xs)?Object.keys(t).map(e=>t[e].__max__||0).reduce((e,n)=>e+n):t.__max__},getShapeX(t,e,n){const a=this,{config:i,scale:o}=a,s=n?o.subX:o.zoom||o.x,l=i.bar_overlap,c=i.bar_padding,f=(v,m)=>v+m,g=nr(t)&&(t._$total.length?t._$total.reduce(f)/2:0);return v=>{const m=a.getIndices(e,v,"getShapeX"),S=v.id in m?m[v.id]:0,P=(m.__max__||0)+1;let N=0;if(cn(v.x)){const L=s(v.x,!0);if(g){const w=t[v.id]||t._$width;N=l?L-w/2:L-w+t._$total.slice(0,S+1).reduce(f)-g}else N=L-(he(t)?t:t._$width)*(P/2-(l?1:S))}return t&&N&&P>1&&c&&(S&&(N+=c*S),P>2?N-=(P-1)*c/2:P===2&&(N-=c/2)),N}},getShapeY(t){const e=this,n=e.isStackNormalized();return a=>{let{value:i}=a;return he(a)?i=a:e.isAreaRangeType(a)?i=e.getBaseValue(a,"mid"):n?i=e.getRatio("index",a,!0):e.isBubbleZType(a)?i=e.getBubbleZData(a.value,"y"):e.isBarRangeType(a)&&(i=i[1]),e.getYScaleById(a.id,t)(i)}},getShapeYMin(t){const e=this,n=e.axis.getId(t),a=e.scale[n],[i]=a.domain(),o=e.config[`axis_${n}_inverted`];return!e.isGrouped(t)&&!o&&i>0?i:0},getShapeOffsetData(t){const e=this,n=e.orderTargets(e.filterTargetsToShow(e.data.targets.filter(t,e))),a=e.isStackNormalized(),i=n.map(s=>{let l=s.values;const c={};e.isStepType(s)&&(l=e.convertValuesToStep(l));const f=l.reduce((g,v)=>{const m=Number(v.x);return g[m]=v,c[m]=a?e.getRatio("index",v,!0):v.value,g},{});return{id:s.id,rowValues:l,rowValueMapByXValue:f,values:c}});return{indexMapByTargetId:n.reduce((s,{id:l},c)=>(s[l]=c,s),{}),shapeOffsetTargets:i}},getShapeOffset(t,e,n){const a=this,{shapeOffsetTargets:i,indexMapByTargetId:o}=a.getShapeOffsetData(t),s=a.config.data_groupsZeroAs;return(l,c)=>{const{id:f,value:g,x:v}=l,m=a.getIndices(e,l),S=a.getYScaleById(f,n);if(a.isBarRangeType(l))return S(g[0]);const P=Number(v),N=S(s==="zero"?0:a.getShapeYMin(f));let L=N;return i.filter(w=>w.id!==f&&m[w.id]===m[f]).forEach(w=>{const{id:X,rowValueMapByXValue:W,rowValues:H,values:k}=w;if(o[X]=0&&he(K)&&(g!==0||s==="positive"&&K>0||s==="negative"&&K<0)&&(L+=S(K)-N)}}),L}},circleY(t,e){const n=this,a=t.id;let i;return n.isGrouped(a)&&(i=dm.bind(n)(t)),i?i(t,e)[0][1]:n.getYScaleById(a)(n.getBaseValue(t))},getBarW(t,e,n){var a,i,o,s,l;const c=this,{config:f,org:g,scale:v,state:m}=c,S=c.getMaxDataCount(),P=t==="bar"&&((a=f.data_groups)==null?void 0:a.length),N=`${t}_width`,{k:L}=(o=(i=c.getZoomTransform)==null?void 0:i.call(c))!=null?o:{k:1},w=[(s=f.axis_x_min)!=null?s:g.xDomain[0],(l=f.axis_x_max)!=null?l:g.xDomain[1]].map(c.axis.isTimeSeries()?Yn.bind(c):Number);let X=e.tickInterval(S);if(v.zoom&&!c.axis.isCategorized()&&L>1){const k=w.every((K,at)=>K===g.xDomain[at]);X=g.xDomain.map((K,at)=>{const ht=k?K:K-Math.abs(w[at]);return v.zoom(ht)}).reduce((K,at)=>Math.abs(K)+at)/S}const W=k=>{const K=k?f[N][k]:f[N],at=k?K.ratio:f[`${N}_ratio`],ht=k?K.max:f[`${N}_max`],$t=he(K)?K:ve(K)?K.call(c,m.width,n,S):n?X*at/n:0;return ht&&$t>ht?ht:$t};let H=W();return!P&&nr(f[N])&&(H={_$width:H,_$total:[]},c.filterTargetsToShow(c.data.targets).forEach(k=>{f[N][k.id]&&(H[k.id]=W(k.id),H._$total.push(H[k.id]||H._$width))})),H},getShapeByIndex(t,e,n){const a=this,{$el:i}=a,o=De(e)?`-${e}`:"";let s=i[t];return s&&!s.empty()?s=s.filter(l=>n?l.id===n:!0).filter(l=>De(e)?l.index===e:!0):s=(n?i.main.selectAll(`.${Ue[`${t}s`]}${a.getTargetSelectorSuffix(n)}`):i.main).selectAll(`.${Ue[t]}${o}`),s},isWithinShape(t,e){var n;const a=this,i=ot(t);let o;return a.isTargetToShow(e.id)?(n=a.hasValidPointType)!=null&&n.call(a,t.nodeName)?o=a.isStepType(e)?a.isWithinStep(t,a.getYScaleById(e.id)(a.getBaseValue(e))):a.isWithinCircle(t,a.isBubbleType(e)?a.pointSelectR(e)*1.5:0):t.nodeName==="path"&&(o=i.classed(Ue.bar)?a.isWithinBar(t):!0):o=!1,o},getInterpolate(t){const n=this.getInterpolateType(t);return{basis:Kp,"basis-closed":Zp,"basis-open":Jp,bundle:Qp,cardinal:kp,"cardinal-closed":qp,"cardinal-open":_p,"catmull-rom":nm,"catmull-rom-closed":rm,"catmull-rom-open":am,"monotone-x":im,"monotone-y":om,natural:sm,"linear-closed":lm,linear:gs,step:cm,"step-after":fm,"step-before":um}[n]},getInterpolateType(t){const e=this,{config:n}=e,a=n.spline_interpolation_type,i=e.isInterpolationType(a)?a:"cardinal";return e.isSplineType(t)?i:e.isStepType(t)?n.line_step_type:"linear"},isWithinBar(t){const e=Hn(this.state.event,t),n=Hl(t),[a,i]=n,o=Math.min(a.x,i.x),s=Math.min(a.y,i.y),l=this.config.bar_sensitivity,{width:c,height:f}=t.getBBox(),g=o-l,v=o+c+l,m=s+f+l,S=s-l;return ge in t?gm(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,Rn=(t,e,n)=>vm(t,typeof e!="symbol"?e+"":e,n);class Vr{constructor(e){Rn(this,"api"),Rn(this,"config"),Rn(this,"cache"),Rn(this,"$el"),Rn(this,"state"),Rn(this,"charts"),Rn(this,"data",{xs:{},targets:[]}),Rn(this,"axis"),Rn(this,"scale",{x:null,y:null,y2:null,subX:null,subY:null,subY2:null,zoom:null}),Rn(this,"org",{xScale:null,xDomain:null}),Rn(this,"color"),Rn(this,"patterns"),Rn(this,"levelColor"),Rn(this,"point"),Rn(this,"brush"),Rn(this,"format",{extraLineClasses:null,xAxisTick:null,dataTime:null,defaultAxisTime:null,axisTime:null});const n=this;n.api=e,n.config=new Nr,n.cache=new gv;const a=new uv;n.$el=a.getStore("element"),n.state=a.getStore("state"),n.$T=n.$T.bind(n)}$T(e,n,a){const{config:i,state:o}=this,s=i.transition_duration,l=i.subchart_show;let c=e;return c&&("tagName"in c&&(c=ot(c)),c=(n!==!1&&s||n)&&(!o.zooming||o.dragging)&&!o.resizing&&o.rendered&&!l?c.transition(a).duration(s):c),c}beforeInit(){const e=this;e.callPluginHook("$beforeInit"),_e(e.config.onbeforeinit,e.api)}afterInit(){const e=this;e.callPluginHook("$afterInit"),_e(e.config.onafterinit,e.api)}init(){const e=this,{config:n,state:a,$el:i}=e,o=n.boost_useCssRule;if(vv(e),a.hasRadar=!a.hasAxis&&e.hasType("radar"),a.hasFunnel=!a.hasAxis&&e.hasType("funnel"),a.hasTreemap=!a.hasAxis&&e.hasType("treemap"),a.hasAxis=!e.hasArcType()&&!a.hasFunnel&&!a.hasTreemap,a.datetimeId=`bb-${+new Date*gr()}`,o){const l=gn.createElement("style");l.type="text/css",gn.head.appendChild(l),a.style={rootSelctor:`.${a.datetimeId}`,sheet:l.sheet},i.style=l}const s={element:n.bindto,classname:"bb"};Be(n.bindto)&&(s.element=n.bindto.element||"#chart",s.classname=n.bindto.classname||s.classname),i.chart=ve(s.element.node)?n.bindto.element:ot(s.element||[]),i.chart.empty()&&(i.chart=ot(gn.body.appendChild(gn.createElement("div")))),i.chart.html("").classed(s.classname,!0).classed(a.datetimeId,o).style("position","relative"),e.initParams(),e.initToRender()}initToRender(e){const n=this,{config:a,state:i,$el:{chart:o}}=n,s=()=>nv(o,{display:"none",visibility:"hidden"}),l=a.render.lazy===!1?!1:a.render.lazy||s(),c=Ke.MutationObserver;l&&c&&a.render.observe!==!1&&!e&&new c((f,g)=>{s()||(g.disconnect(),!i.rendered&&n.initToRender(!0))}).observe(o.node(),{attributes:!0,attributeFilter:["class","style"]}),(!l||e)&&n.convertData(a,f=>{n.initWithData(f),n.afterInit()})}initParams(){var e;const n=this,{config:a,format:i,state:o}=n,s=a.axis_rotated;if(n.color=n.generateColor(),n.levelColor=n.generateLevelColor(),a.padding===!1&&(a.axis_x_show=!1,a.axis_y_show=!1,a.axis_y2_show=!1,a.subchart_show=!1),(n.hasPointType()||(e=n.hasLegendDefsPoint)!=null&&e.call(n))&&(n.point=n.generatePoint()),o.hasAxis){n.initClip(),i.extraLineClasses=n.generateExtraLineClass(),i.dataTime=a.data_xLocaltime?Ws:Ks,i.axisTime=a.axis_x_localtime?ao:io;const l=n.config.zoom_enabled&&n.config.zoom_type==="drag";i.defaultAxisTime=c=>{const{x:f,zoom:g}=n.scale,v=l?g:g&&f.orgDomain().toString()!==g.domain().toString(),m=c.getMilliseconds()&&".%L"||c.getSeconds()&&".:%S"||c.getMinutes()&&"%I:%M"||c.getHours()&&"%I %p"||c.getDate()!==1&&"%b %d"||v&&c.getDate()===1&&"%b'%y"||c.getMonth()&&"%-m/%-d"||"%Y";return i.axisTime(m)(c)}}o.isLegendRight=a.legend_position==="right",o.isLegendInset=a.legend_position==="inset",o.isLegendTop=a.legend_inset_anchor==="top-left"||a.legend_inset_anchor==="top-right",o.isLegendLeft=a.legend_inset_anchor==="top-left"||a.legend_inset_anchor==="bottom-left",o.rotatedPadding.top=n.getResettedPadding(o.rotatedPadding.top),o.rotatedPadding.right=s&&!a.axis_x_show?0:30,o.inputType=rv(a.interaction_inputType_mouse,a.interaction_inputType_touch)}initWithData(e){var n,a,i;const o=this,{config:s,scale:l,state:c,$el:f,org:g}=o,{hasAxis:v,hasFunnel:m,hasTreemap:S}=c,P=s.interaction_enabled,N=o.hasType("polar"),L=s.data_labels_backgroundColors;if(v&&(o.axis=o.getAxisInstance(),s.zoom_enabled&&o.initZoom()),o.data.xs={},o.data.targets=o.convertDataToTargets(e),s.data_filter&&(o.data.targets=o.data.targets.filter(s.data_filter.bind(o.api))),s.data_hide&&o.addHiddenTargetIds(s.data_hide===!0?o.mapToIds(o.data.targets):s.data_hide),s.legend_hide&&o.addHiddenLegendIds(s.legend_hide===!0?o.mapToIds(o.data.targets):s.legend_hide),o.updateSizes(),o.updateScales(!0),v){const{x:W,y:H,y2:k,subX:K,subY:at,subY2:ht}=l;W&&(W.domain(na(o.getXDomain(o.data.targets),!s.axis_x_inverted)),K.domain(W.domain()),g.xDomain=W.domain()),H&&(H.domain(o.getYDomain(o.data.targets,"y")),at.domain(H.domain())),k&&(k.domain(o.getYDomain(o.data.targets,"y2")),ht&&ht.domain(k.domain()))}if(f.svg=f.chart.append("svg").style("overflow","hidden").style("display","block"),P&&c.inputType){const W=c.inputType==="touch",{onclick:H,onover:k,onout:K}=s;f.svg.on("click",(H==null?void 0:H.bind(o.api))||null).on(W?"touchstart":"mouseenter",(k==null?void 0:k.bind(o.api))||null).on(W?"touchend":"mouseleave",(K==null?void 0:K.bind(o.api))||null)}s.svg_classname&&f.svg.attr("class",s.svg_classname);const w=ve(s.color_tiles)&&o.patterns;(v||w||N||S||L||(n=o.hasLegendDefsPoint)!=null&&n.call(o))&&(f.defs=f.svg.append("defs"),v&&["id","idXAxis","idYAxis","idGrid"].forEach(W=>{o.appendClip(f.defs,c.clip[W])}),o.generateTextBGColorFilter(L),w&&o.patterns.forEach(W=>f.defs.append(()=>W.node))),o.updateSvgSize(),o.bindResize();const X=f.svg.append("g").classed(Se.main,!0).attr("transform",m||S?null:o.getTranslate("main"));if(f.main=X,s.subchart_show&&o.initSubchart(),s.tooltip_show&&o.initTooltip(),s.title_text&&o.initTitle(),!S&&s.legend_show&&o.initLegend(),s.data_empty_label_text&&X.append("text").attr("class",`${On.text} ${Se.empty}`).attr("text-anchor","middle").attr("dominant-baseline","middle"),v&&(s.regions.length&&o.initRegion(),!s.clipPath&&o.axis.init()),X.append("g").classed(Se.chart,!0).attr("clip-path",v?c.clip.path:null),o.callPluginHook("$init"),o.initChartElements(),v&&(P&&((a=o.initEventRect)==null||a.call(o)),o.initGrid(),s.clipPath&&((i=o.axis)==null||i.init())),o.updateTargets(o.data.targets),o.updateDimension(),_e(s.oninit,o.api),o.setBackground(),o.redraw({withTransition:!1,withTransform:!0,withUpdateXDomain:!0,withUpdateOrgXDomain:!0,withTransitionForAxis:!1,initializing:!0}),s.data_onmin||s.data_onmax){const W=o.getMinMaxData();_e(s.data_onmin,o.api,W.min),_e(s.data_onmax,o.api,W.max)}s.tooltip_show&&o.initShowTooltip(),c.rendered=!0}initChartElements(){const e=this,{hasAxis:n,hasRadar:a,hasTreemap:i}=e.state,o=[];if(n){const s=["bar","bubble","candlestick","line"];e.config.bar_front&&s.push(s.shift()),s.forEach(l=>{const c=Cn(l);(l==="line"&&e.hasTypeOf(c)||e.hasType(l))&&o.push(c)})}else if(i)o.push("Treemap");else if(e.hasType("funnel"))o.push("Funnel");else{const s=e.hasType("polar");a||o.push("Arc","Pie"),e.hasType("gauge")?o.push("Gauge"):a?o.push("Radar"):s&&o.push("Polar")}o.forEach(s=>{e[`init${s}`]()}),cn(e.config.data_labels)&&!e.hasArcType(null,["radar"])&&e.initText()}setChartElements(){const e=this,{$el:{chart:n,svg:a,defs:i,main:o,tooltip:s,legend:l,title:c,grid:f,needle:g,arcs:v,circle:m,bar:S,candlestick:P,line:N,area:L,text:w}}=e;e.api.$={chart:n,svg:a,defs:i,main:o,tooltip:s,legend:l,title:c,grid:f,arc:v,circles:m,bar:{bars:S},candlestick:P,line:{lines:N,areas:L},needle:g,text:{texts:w}}}setBackground(){const e=this,{config:{background:n},state:a,$el:{svg:i}}=e;if(cn(n)){const o=i.select("g").insert(n.imgUrl?"image":"rect",":first-child");n.imgUrl?o.attr("href",n.imgUrl):n.color&&o.style("fill",n.color).attr("clip-path",a.clip.path),o.attr("class",n.class||null).attr("width","100%").attr("height","100%")}}updateTargets(e){var n;const a=this,{hasAxis:i,hasFunnel:o,hasRadar:s,hasTreemap:l}=a.state,c=g=>a[`updateTargetsFor${g}`](e.filter(a[`is${g}Type`].bind(a)));if(a.updateTargetsForText(e),i)["bar","candlestick","line"].forEach(g=>{const v=Cn(g);(g==="line"&&a.hasTypeOf(v)||a.hasType(g))&&c(v)}),a.updateTargetsForSubchart&&a.updateTargetsForSubchart(e);else if(a.hasArcType(e)){let g="Arc";s?g="Radar":a.hasType("polar")&&(g="Polar"),c(g)}else o?c("Funnel"):l&&c("Treemap");const f=a.hasType("bubble")||a.hasType("scatter");f&&((n=a.updateTargetForCircle)==null||n.call(a)),a.filterTargetsToShowAtInit(f)}filterTargetsToShowAtInit(e=!1){const n=this,{$el:{svg:a},$T:i}=n;let o=`.${Se.target}`;e&&(o+=`, .${$n.chartCircles} > .${$n.circles}`),i(a.selectAll(o).filter(s=>n.isTargetToShow(s.id))).style("opacity",null)}getWithOption(e){const n={Dimension:!0,EventRect:!0,Legend:!1,Subchart:!0,Transform:!1,Transition:!0,TrimXDomain:!0,UpdateXAxis:"UpdateXDomain",UpdateXDomain:!1,UpdateOrgXDomain:!1,TransitionForExit:"Transition",TransitionForAxis:"Transition",Y:!0};return Object.keys(n).forEach(a=>{let i=n[a];ze(i)&&(i=n[i]),n[a]=$r(e,`with${a}`,i)}),n}initialOpacity(e){const n=this,{withoutFadeIn:a}=n.state;return n.getBaseValue(e)!==null&&a[e.id]?null:"0"}bindResize(){const e=this,{$el:n,config:a,state:i}=e,o=xv(a.resize_timer),s=[];s.push(()=>_e(a.onresize,e.api)),/^(true|parent)$/.test(a.resize_auto)&&s.push(()=>{i.resizing=!0,a.legend_show&&(e.updateSizes(),e.updateLegend()),e.api.flush(!1)}),s.push(()=>{_e(a.onresized,e.api),i.resizing=!1}),s.forEach(l=>o.add(l)),e.resizeFunction=o,a.resize_auto==="parent"?(e.resizeFunction.resizeObserver=new ResizeObserver(e.resizeFunction.bind(e))).observe(n.chart.node().parentNode):Ke.addEventListener("resize",e.resizeFunction)}callPluginHook(e,...n){this.config.plugins.forEach(a=>{e==="$beforeInit"&&(a.$$=this,this.api.plugins.push(a)),a[e](...n)})}}yn(Vr.prototype,[Mv,Dv,Lv,jv,Vv,Yv,Wv,zv,Kv,Zv,Jv,Bp,hm,Up,zp,Gp,Xp,Hp,Yp,Wp]);function pm(t){const e=this.config;let n,a,i;const o=()=>{const s=a.shift();if(s&&n&&nr(n)&&s in n)return n=n[s],o();if(!s)return n};Object.keys(e).forEach(s=>{n=t,a=s.split("_"),i=o(),Qe(i)&&(e[s]=i)}),this.api&&(this.state.orgConfig=t)}var mm={resize(t){const e=this.internal,{config:n,state:a}=e;a.rendered&&(n.size_width=t?t.width:null,n.size_height=t?t.height:null,a.resizing=!0,this.flush(!1),e.resizeFunction())},flush(t){var e,n;const a=this.internal,{state:i,$el:{zoomResetBtn:o}}=a;i.rendered?(i.resizing?(e=a.brush)==null||e.updateResize():(n=a.axis)==null||n.setOrient(),o==null||o.style("display","none"),a.scale.zoom=null,t?a.redraw({withTransform:!0,withUpdateXDomain:!0,withUpdateOrgXDomain:!0,withLegend:!0}):a.updateAndRedraw({withLegend:!0,withTransition:!1,withTransitionForTransform:!1}),!i.resizing&&a.brush&&(a.brush.getSelection().call(a.brush.move),a.unselectRect())):a.initToRender(!0)},destroy(){var t;const e=this.internal,{$el:{chart:n,style:a,svg:i}}=e;if(cn(e)){e.callPluginHook("$willDestroy"),e.charts.splice(e.charts.indexOf(this),1),e.unbindAllEvents(),i.select("*").interrupt(),e.resizeFunction.clear(),(t=e.resizeFunction.resizeObserver)==null||t.disconnect(),Ke.removeEventListener("resize",e.resizeFunction),n.classed("bb",!1).style("position",null).selectChildren().remove(),a&&a.parentNode.removeChild(a),Object.keys(this).forEach(o=>{o==="internal"&&Object.keys(e).forEach(s=>{e[s]=null}),this[o]=null,delete this[o]});for(const o in this)this[o]=()=>{}}return null},config(t,e,n){const a=this.internal,{config:i,state:o}=a,s=t==null?void 0:t.replace(/\./g,"_");let l;return t&&s in i?Qe(e)?(i[s]=e,l=e,n&&this.flush()):l=i[s]:(arguments.length===0||qn(t))&&(l=o.orgConfig),l}},ym={color(t){return this.internal.color(t)}};const au=function(t){const{targets:e}=this.internal.data;if(!ln(t)){const n=je(t)?t:[t];return e.filter(a=>n.some(i=>i===a.id))}return e};yn(au,{shown:function(t){return this.internal.filterTargetsToShow(this.data(t))},values:function(t,e=!0){let n=null;if(t){const a=this.data(t);je(a)&&(n=[],a.forEach(i=>{const o=i.values.map(s=>s.value);e?n=n.concat(o):n.push(o)}))}return n},names:function(t){return this.internal.updateDataAttributes("names",t)},colors:function(t){return this.internal.updateDataAttributes("colors",t)},axes:function(t){return this.internal.updateDataAttributes("axes",t)},min:function(){return this.internal.getMinMaxData().min},max:function(){return this.internal.getMinMaxData().max}});var xm={data:au};const Tm=t=>{var e,n;return(n=(e=Ke).btoa)==null?void 0:n.call(e,encodeURIComponent(t).replace(/%([0-9A-F]{2})/g,(a,i)=>String.fromCharCode(+`0x${i}`)))};function $m(t,e,n){const{width:a,height:i}=e||n,o=new XMLSerializer,s=t.cloneNode(!0),l=tv(Lr(gn.styleSheets)).filter(m=>m.cssText).map(m=>m.cssText);s.setAttribute("xmlns",ae.xhtml),s.style.margin="0",s.style.padding="0",e.preserveFontStyle&&s.querySelectorAll("text").forEach(m=>{m.innerHTML=""});const c=o.serializeToString(s),f=gn.createElement("style");f.appendChild(gn.createTextNode(l.join(` -`)));const g=o.serializeToString(f),v=` - - ${g} - ${c.replace(/(url\()[^#]+/g,"$1")} - `;return`data:image/svg+xml;base64,${Tm(v)}`}function Sm(t,e){const{top:n,left:a}=e,{x:i,y:o}=t.getBBox(),{a:s,b:l,c,d:f,e:g,f:v}=t.getScreenCTM(),{width:m,height:S}=t.getBoundingClientRect();return{x:s*i+c*o+g-a,y:l*i+f*o+v-n+(S-Math.round(S/4)),width:m,height:S}}function Am(t){const{left:e,top:n}=t.getBoundingClientRect(),a=o=>o.textContent||o.childElementCount,i=[];return Lr(t.querySelectorAll("text")).filter(a).forEach(o=>{const s=l=>{const{fill:c,fontFamily:f,fontSize:g,textAnchor:v,transform:m}=Ke.getComputedStyle(l),{x:S,y:P,width:N,height:L}=Sm(l,{left:e,top:n});return{[l.textContent]:{x:S,y:P,width:N,height:L,fill:c,fontFamily:f,fontSize:g,textAnchor:v,transform:m}}};if(o.childElementCount>1){const l=[];return Lr(o.querySelectorAll("tspan")).filter(a).forEach(c=>{i.push(s(c))}),l}else i.push(s(o))}),i}function Em(t,e){e.forEach(n=>{Object.keys(n).forEach(a=>{const{x:i,y:o,width:s,height:l,fill:c,fontFamily:f,fontSize:g,transform:v}=n[a];if(t.save(),t.font=`${g} ${f}`,t.fillStyle=c,v==="none")t.fillText(a,i,o);else{const m=v.replace(/(matrix|\(|\))/g,"").split(",");m.splice(4).every(S=>+S==0)?(m.push(i+s-s/4),m.push(o-l+l/3)):(m.push(i),m.push(o)),t.transform(...m),t.fillText(a,0,0)}t.restore()})})}var bm={export(t,e){const n=this.internal,{state:a,$el:{chart:i,svg:o}}=n,{width:s,height:l}=a.current,c=ea(Object.create(null),{width:s,height:l,preserveAspectRatio:!0,preserveFontStyle:!1,mimeType:"image/png"},t),f=$m(i.node(),c,{width:s,height:l}),g=c.preserveFontStyle?Am(o.node()):[];if(e&&ve(e)){const v=new Image;v.crossOrigin="Anonymous",v.onload=()=>{const m=gn.createElement("canvas"),S=m.getContext("2d");m.width=c.width||s,m.height=c.height||l,S.drawImage(v,0,0),g.length&&(Em(S,g),g.length=0),e.bind(this)(m.toDataURL(c.mimeType))},v.src=f}return f}},Rm={focus(t){const e=this.internal,{state:n}=e,a=e.mapToTargetIds(t),i=e.$el.svg.selectAll(e.selectorTargets(a.filter(e.isTargetToShow,e)));this.revert(),this.defocus(),i.classed(qe.focused,!0).classed(qe.defocused,!1),e.hasArcType()&&!n.hasRadar&&(e.expandArc(a),e.hasType("gauge")&&e.markOverlapped(t,e,`.${Un.gaugeValue}`)),e.toggleFocusLegend(a,!0),n.focusedTargetIds=a,n.defocusedTargetIds=n.defocusedTargetIds.filter(o=>a.indexOf(o)<0)},defocus(t){const e=this.internal,{state:n}=e,a=e.mapToTargetIds(t);e.$el.svg.selectAll(e.selectorTargets(a.filter(e.isTargetToShow,e))).classed(qe.focused,!1).classed(qe.defocused,!0),e.hasArcType(null,["polar"])&&(e.unexpandArc(a),e.hasType("gauge")&&e.undoMarkOverlapped(e,`.${Un.gaugeValue}`)),e.toggleFocusLegend(a,!1),n.focusedTargetIds=n.focusedTargetIds.filter(o=>a.indexOf(o)<0),n.defocusedTargetIds=a},revert(t){const e=this.internal,{config:n,state:a,$el:i}=e,o=e.mapToTargetIds(t);i.svg.selectAll(e.selectorTargets(o)).classed(qe.focused,!1).classed(qe.defocused,!1),e.hasArcType(null,["polar"])&&e.unexpandArc(o),n.legend_show&&(e.showLegend(o.filter(e.isLegendToShow.bind(e))),i.legend.selectAll(e.selectorLegends(o)).filter(function(){return ot(this).classed(qe.legendItemFocused)}).classed(qe.legendItemFocused,!1)),a.focusedTargetIds=[],a.defocusedTargetIds=[]}},Im={legend:{show:function(t){const e=this.internal;e.showLegend(e.mapToTargetIds(t)),e.updateAndRedraw({withLegend:!0})},hide:function(t){const e=this.internal;e.hideLegend(e.mapToTargetIds(t)),e.updateAndRedraw({withLegend:!0})}}},Om={load(t){const e=this.internal,{config:n}=e;t.xs&&e.addXs(t.xs),"names"in t&&this.data.names(t.names),"classes"in t&&Object.keys(t.classes).forEach(a=>{n.data_classes[a]=t.classes[a]}),"categories"in t&&e.axis.isCategorized()&&(n.axis_x_categories=t.categories),"axes"in t&&Object.keys(t.axes).forEach(a=>{n.data_axes[a]=t.axes[a]}),"colors"in t&&Object.keys(t.colors).forEach(a=>{n.data_colors[a]=t.colors[a]}),"unload"in t&&t.unload!==!1?e.unload(e.mapToTargetIds(t.unload===!0?null:t.unload),()=>{jl(()=>e.loadFromArgs(t))}):e.loadFromArgs(t)},unload(t){const e=this.internal;let n=t||{};qn(n)&&this.tooltip.hide(),je(n)?n={ids:n}:ze(n)&&(n={ids:[n]});const a=e.mapToTargetIds(n.ids);e.unload(a,()=>{e.redraw({withUpdateOrgXDomain:!0,withUpdateXDomain:!0,withLegend:!0}),e.cache.remove(a),cc.call(e,n.done,n.resizeAfter)})}};function iu(t,e,n){const a=this.internal,i=a.mapToTargetIds(e),o=a.state.hiddenTargetIds.map(c=>i.indexOf(c)>-1&&c).filter(Boolean);a.state.toggling=!0,a[`${t?"remove":"add"}HiddenTargetIds`](i);const s=a.$el.svg.selectAll(a.selectorTargets(i)),l=t?null:"0";t&&o.length&&(s.style("display",null),_e(a.config.data_onshown,this,o)),a.$T(s).style("opacity",l,"important").call(Si,()=>{var c;!t&&o.length===0&&(s.style("display","none"),_e((c=a.config)==null?void 0:c.data_onhidden,this,i)),s.style("opacity",l)}),n.withLegend&&a[`${t?"show":"hide"}Legend`](i),a.redraw({withUpdateOrgXDomain:!0,withUpdateXDomain:!0,withLegend:!0}),a.state.toggling=!1}var Cm={show(t,e={}){iu.call(this,!0,t,e)},hide(t,e={}){iu.call(this,!1,t,e)},toggle(t,e={}){const n=this.internal,a={show:[],hide:[]};n.mapToTargetIds(t).forEach(i=>a[n.isTargetToShow(i)?"hide":"show"].push(i)),a.show.length&&this.show(a.show,e),a.hide.length&&setTimeout(()=>this.hide(a.hide,e),0)}},Pm={tooltip:{show:function(t){var e,n,a;const i=this.internal,{$el:o,config:s,state:{eventReceiver:l,hasFunnel:c,hasTreemap:f,inputType:g}}=i;let v,m;if(t.mouse&&(m=t.mouse),t.data){const{data:S}=t,P=(e=i.getYScaleById(S.id))==null?void 0:e(S.value);if((c||f)&&S.id){const N=i.selectorTarget(S.id,void 0,`.${sn.shape}`);l.rect=o.main.select(N)}else i.isMultipleX()?m=[i.xx(S),P]:(s.tooltip_grouped||(m=[0,P]),v=(a=S.index)!=null?a:i.hasArcType()&&S.id?(n=i.getArcElementByIdOrIndex(S.id))==null?void 0:n.datum().index:i.getIndexByX(S.x))}else Qe(t.x)?v=i.getIndexByX(t.x):Qe(t.index)&&(v=t.index);(g==="mouse"?["mouseover","mousemove"]:["touchstart"]).forEach(S=>{i.dispatchEvent(S,v,m)})},hide:function(){var t,e,n;const a=this.internal,{state:{inputType:i},$el:{tooltip:o}}=a,s=o==null?void 0:o.datum();if(s){const{index:l}=JSON.parse(s.current)[0];(i==="mouse"?["mouseout"]:["touchend"]).forEach(c=>{a.dispatchEvent(c,l)})}i==="touch"&&a.callOverOutForTouch(),a.hideTooltip(!0),(t=a.hideGridFocus)==null||t.call(a),(e=a.unexpandCircles)==null||e.call(a),(n=a.expandBarTypeShapes)==null||n.call(a,!1)}}},wm=Object.defineProperty,Mm=(t,e,n)=>e in t?wm(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,ou=(t,e,n)=>Mm(t,typeof e!="symbol"?e+"":e,n);class Er{constructor(e){ou(this,"plugins",[]),ou(this,"internal");const n=new Vr(this);this.internal=n,function a(i,o,s){Object.keys(i).forEach(l=>{const c=ve(i[l]),f=o!==s,g=cn(i[l]),v=g&&Object.keys(i[l]).length>0;c&&(!f&&v||f)?o[l]=i[l].bind(s):g&&!c?o[l]={}:o[l]=i[l],v&&a(i[l],o[l],s)})}(Er.prototype,this,this),pm.call(n,e),n.beforeInit(),n.init()}}yn(Er.prototype,[mm,ym,xm,bm,Rm,Im,Om,Cm,Pm]);function su(t=!1,e,n,a){const i=this,{config:o,$el:{main:s}}=i,l=o.data_selection_grouped,c=o.data_selection_isselectable.bind(i.api);o.data_selection_enabled&&s.selectAll(`.${sn.shapes}`).selectAll(`.${sn.shape}`).each(function(f){const g=ot(this),{id:v,index:m}=f.data?f.data:f,S=i.getToggle(this,f).bind(i),P=l||!e||e.indexOf(v)>=0,N=!n||n.indexOf(m)>=0,L=g.classed(tn.SELECTED);g.classed(ur.line)||g.classed(ti.area)||(t?P&&N&&c(f)&&!L?S(!0,g.classed(tn.SELECTED,!0),f,m):Qe(a)&&a&&L&&S(!1,g.classed(tn.SELECTED,!1),f,m):P&&N&&c(f)&&L&&S(!1,g.classed(tn.SELECTED,!1),f,m))})}var Dm={selected(t){const e=this.internal,n=[];return e.$el.main.selectAll(`.${sn.shapes+e.getTargetSelectorSuffix(t)}`).selectAll(`.${sn.shape}`).filter(function(){return ot(this).classed(tn.SELECTED)}).each(a=>n.push(a)),n},select(t,e,n){const a=this.internal;su.bind(a)(!0,t,e,n)},unselect(t,e){const n=this.internal;su.bind(n)(!1,t,e)}};const lu=function(t){var e;const n=this.internal,{axis:a,brush:i,config:o,scale:{x:s,subX:l},state:c}=n;let f;return o.subchart_show&&(f=t,Array.isArray(f)?(a.isTimeSeries()&&(f=f.map(v=>Yn.bind(n)(v))),n.withinRange(f,n.getZoomDomain("subX",!0),n.getZoomDomain("subX"))&&(c.domain=f,i.move(i.getSelection(),f.map(l)))):f=(e=c.domain)!=null?e:s.orgDomain()),f};yn(lu,{show(){var t,e;const n=this.internal,{$el:{subchart:a},config:i}=n,o=i.subchart_show;if(!o){n.unbindZoomEvent(),i.subchart_show=!o,!a.main&&n.initSubchart();let s=a.main.selectAll(`.${Se.target}`);n.data.targets.length!==s.size()&&(n.updateSizes(),n.updateTargetsForSubchart(n.data.targets),s=(t=a.main)==null?void 0:t.selectAll(`.${Se.target}`)),s==null||s.style("opacity",null),(e=a.main)==null||e.style("display",null),this.resize()}},hide(){const t=this.internal,{$el:{subchart:{main:e}},config:n}=t;n.subchart_show&&(e==null?void 0:e.style("display"))!=="none"&&(n.subchart_show=!1,e.style("display","none"),this.resize())},toggle(){const t=this.internal,{config:e}=t;this.subchart[e.subchart_show?"hide":"show"]()},reset(){const t=this.internal,{brush:e}=t;e.clear(e.getSelection())}});var Lm={subchart:lu},Nm=1e-12;function cu(t){return((t=Math.exp(t))+1/t)/2}function Fm(t){return((t=Math.exp(t))-1/t)/2}function Bm(t){return((t=Math.exp(2*t))-1)/(t+1)}var Um=function t(e,n,a){function i(o,s){var l=o[0],c=o[1],f=o[2],g=s[0],v=s[1],m=s[2],S=g-l,P=v-c,N=S*S+P*P,L,w;if(N()=>t;function zm(t,{sourceEvent:e,target:n,transform:a,dispatch:i}){Object.defineProperties(this,{type:{value:t,enumerable:!0,configurable:!0},sourceEvent:{value:e,enumerable:!0,configurable:!0},target:{value:n,enumerable:!0,configurable:!0},transform:{value:a,enumerable:!0,configurable:!0},_:{value:i}})}function vr(t,e,n){this.k=t,this.x=e,this.y=n}vr.prototype={constructor:vr,scale:function(t){return t===1?this:new vr(this.k*t,this.x,this.y)},translate:function(t,e){return t===0&e===0?this:new vr(this.k,this.x+this.k*t,this.y+this.k*e)},apply:function(t){return[t[0]*this.k+this.x,t[1]*this.k+this.y]},applyX:function(t){return t*this.k+this.x},applyY:function(t){return t*this.k+this.y},invert:function(t){return[(t[0]-this.x)/this.k,(t[1]-this.y)/this.k]},invertX:function(t){return(t-this.x)/this.k},invertY:function(t){return(t-this.y)/this.k},rescaleX:function(t){return t.copy().domain(t.range().map(this.invertX,this).map(t.invert,t))},rescaleY:function(t){return t.copy().domain(t.range().map(this.invertY,this).map(t.invert,t))},toString:function(){return"translate("+this.x+","+this.y+") scale("+this.k+")"}};var ar=new vr(1,0,0);vs.prototype=vr.prototype;function vs(t){for(;!t.__zoom;)if(!(t=t.parentNode))return ar;return t.__zoom}function ps(t){t.stopImmediatePropagation()}function Ba(t){t.preventDefault(),t.stopImmediatePropagation()}function jm(t){return(!t.ctrlKey||t.type==="wheel")&&!t.button}function Vm(){var t=this;return t instanceof SVGElement?(t=t.ownerSVGElement||t,t.hasAttribute("viewBox")?(t=t.viewBox.baseVal,[[t.x,t.y],[t.x+t.width,t.y+t.height]]):[[0,0],[t.width.baseVal.value,t.height.baseVal.value]]):[[0,0],[t.clientWidth,t.clientHeight]]}function uu(){return this.__zoom||ar}function Gm(t){return-t.deltaY*(t.deltaMode===1?.05:t.deltaMode?1:.002)*(t.ctrlKey?10:1)}function Xm(){return navigator.maxTouchPoints||"ontouchstart"in this}function Hm(t,e,n){var a=t.invertX(e[0][0])-n[0][0],i=t.invertX(e[1][0])-n[1][0],o=t.invertY(e[0][1])-n[0][1],s=t.invertY(e[1][1])-n[1][1];return t.translate(i>a?(a+i)/2:Math.min(0,a)||Math.max(0,i),s>o?(o+s)/2:Math.min(0,o)||Math.max(0,s))}function Ym(){var t=jm,e=Vm,n=Hm,a=Gm,i=Xm,o=[0,1/0],s=[[-1/0,-1/0],[1/0,1/0]],l=250,c=Um,f=ri("start","zoom","end"),g,v,m,S=500,P=150,N=0,L=10;function w(Q){Q.property("__zoom",uu).on("wheel.zoom",ht,{passive:!1}).on("mousedown.zoom",$t).on("dblclick.zoom",dt).filter(i).on("touchstart.zoom",st).on("touchmove.zoom",Vt).on("touchend.zoom touchcancel.zoom",vt).style("-webkit-tap-highlight-color","rgba(0,0,0,0)")}w.transform=function(Q,St,ct,At){var Gt=Q.selection?Q.selection():Q;Gt.property("__zoom",uu),Q!==Gt?k(Q,St,ct,At):Gt.interrupt().each(function(){K(this,arguments).event(At).start().zoom(null,typeof St=="function"?St.apply(this,arguments):St).end()})},w.scaleBy=function(Q,St,ct,At){w.scaleTo(Q,function(){var Gt=this.__zoom.k,Bt=typeof St=="function"?St.apply(this,arguments):St;return Gt*Bt},ct,At)},w.scaleTo=function(Q,St,ct,At){w.transform(Q,function(){var Gt=e.apply(this,arguments),Bt=this.__zoom,Kt=ct==null?H(Gt):typeof ct=="function"?ct.apply(this,arguments):ct,ne=Bt.invert(Kt),le=typeof St=="function"?St.apply(this,arguments):St;return n(W(X(Bt,le),Kt,ne),Gt,s)},ct,At)},w.translateBy=function(Q,St,ct,At){w.transform(Q,function(){return n(this.__zoom.translate(typeof St=="function"?St.apply(this,arguments):St,typeof ct=="function"?ct.apply(this,arguments):ct),e.apply(this,arguments),s)},null,At)},w.translateTo=function(Q,St,ct,At,Gt){w.transform(Q,function(){var Bt=e.apply(this,arguments),Kt=this.__zoom,ne=At==null?H(Bt):typeof At=="function"?At.apply(this,arguments):At;return n(ar.translate(ne[0],ne[1]).scale(Kt.k).translate(typeof St=="function"?-St.apply(this,arguments):-St,typeof ct=="function"?-ct.apply(this,arguments):-ct),Bt,s)},At,Gt)};function X(Q,St){return St=Math.max(o[0],Math.min(o[1],St)),St===Q.k?Q:new vr(St,Q.x,Q.y)}function W(Q,St,ct){var At=St[0]-ct[0]*Q.k,Gt=St[1]-ct[1]*Q.k;return At===Q.x&&Gt===Q.y?Q:new vr(Q.k,At,Gt)}function H(Q){return[(+Q[0][0]+ +Q[1][0])/2,(+Q[0][1]+ +Q[1][1])/2]}function k(Q,St,ct,At){Q.on("start.zoom",function(){K(this,arguments).event(At).start()}).on("interrupt.zoom end.zoom",function(){K(this,arguments).event(At).end()}).tween("zoom",function(){var Gt=this,Bt=arguments,Kt=K(Gt,Bt).event(At),ne=e.apply(Gt,Bt),le=ct==null?H(ne):typeof ct=="function"?ct.apply(Gt,Bt):ct,be=Math.max(ne[1][0]-ne[0][0],ne[1][1]-ne[0][1]),Oe=Gt.__zoom,Ce=typeof St=="function"?St.apply(Gt,Bt):St,He=c(Oe.invert(le).concat(be/Oe.k),Ce.invert(le).concat(be/Ce.k));return function(Fe){if(Fe===1)Fe=Ce;else{var dn=He(Fe),Jt=be/dn[2];Fe=new vr(Jt,le[0]-dn[0]*Jt,le[1]-dn[1]*Jt)}Kt.zoom(null,Fe)}})}function K(Q,St,ct){return!ct&&Q.__zooming||new at(Q,St)}function at(Q,St){this.that=Q,this.args=St,this.active=0,this.sourceEvent=null,this.extent=e.apply(Q,St),this.taps=0}at.prototype={event:function(Q){return Q&&(this.sourceEvent=Q),this},start:function(){return++this.active===1&&(this.that.__zooming=this,this.emit("start")),this},zoom:function(Q,St){return this.mouse&&Q!=="mouse"&&(this.mouse[1]=St.invert(this.mouse[0])),this.touch0&&Q!=="touch"&&(this.touch0[1]=St.invert(this.touch0[0])),this.touch1&&Q!=="touch"&&(this.touch1[1]=St.invert(this.touch1[0])),this.that.__zoom=St,this.emit("zoom"),this},end:function(){return--this.active===0&&(delete this.that.__zooming,this.emit("end")),this},emit:function(Q){var St=ot(this.that).datum();f.call(Q,this.that,new zm(Q,{sourceEvent:this.sourceEvent,target:w,type:Q,transform:this.that.__zoom,dispatch:f}),St)}};function ht(Q,...St){if(!t.apply(this,arguments))return;var ct=K(this,St).event(Q),At=this.__zoom,Gt=Math.max(o[0],Math.min(o[1],At.k*Math.pow(2,a.apply(this,arguments)))),Bt=Xn(Q);if(ct.wheel)(ct.mouse[0][0]!==Bt[0]||ct.mouse[0][1]!==Bt[1])&&(ct.mouse[1]=At.invert(ct.mouse[0]=Bt)),clearTimeout(ct.wheel);else{if(At.k===Gt)return;ct.mouse=[Bt,At.invert(Bt)],qr(this),ct.start()}Ba(Q),ct.wheel=setTimeout(Kt,P),ct.zoom("mouse",n(W(X(At,Gt),ct.mouse[0],ct.mouse[1]),ct.extent,s));function Kt(){ct.wheel=null,ct.end()}}function $t(Q,...St){if(m||!t.apply(this,arguments))return;var ct=Q.currentTarget,At=K(this,St,!0).event(Q),Gt=ot(Q.view).on("mousemove.zoom",le,!0).on("mouseup.zoom",be,!0),Bt=Xn(Q,ct),Kt=Q.clientX,ne=Q.clientY;co(Q.view),ps(Q),At.mouse=[Bt,this.__zoom.invert(Bt)],qr(this),At.start();function le(Oe){if(Ba(Oe),!At.moved){var Ce=Oe.clientX-Kt,He=Oe.clientY-ne;At.moved=Ce*Ce+He*He>N}At.event(Oe).zoom("mouse",n(W(At.that.__zoom,At.mouse[0]=Xn(Oe,ct),At.mouse[1]),At.extent,s))}function be(Oe){Gt.on("mousemove.zoom mouseup.zoom",null),uo(Oe.view,At.moved),Ba(Oe),At.event(Oe).end()}}function dt(Q,...St){if(t.apply(this,arguments)){var ct=this.__zoom,At=Xn(Q.changedTouches?Q.changedTouches[0]:Q,this),Gt=ct.invert(At),Bt=ct.k*(Q.shiftKey?.5:2),Kt=n(W(X(ct,Bt),At,Gt),e.apply(this,St),s);Ba(Q),l>0?ot(this).transition().duration(l).call(k,Kt,At,Q):ot(this).call(w.transform,Kt,At,Q)}}function st(Q,...St){if(t.apply(this,arguments)){var ct=Q.touches,At=ct.length,Gt=K(this,St,Q.changedTouches.length===At).event(Q),Bt,Kt,ne,le;for(ps(Q),Kt=0;KtYn.bind(n)(v))),n.withinRange(f,n.getZoomDomain("zoom",!0),n.getZoomDomain("zoom"))){if(l.domain=f,f=n.getZoomDomainValue(f),n.api.tooltip.hide(),i.subchart_show){const v=s.zoom||s.x;n.brush.getSelection().call(n.brush.move,f.map(v))}else{const v=c?s.x.orgScale():o.xScale||s.x;n.updateCurrentZoomTransform(v,f)}n.setZoomResetButton()}}else f=n.zoom.getDomain();return(e=l.domain)!=null?e:f};yn(fu,{enable(t){const e=this.internal,{config:n}=e;/^(drag|wheel)$/.test(t)&&(n.zoom_type=t),n.zoom_enabled=!!t,e.zoom?t===!1&&e.bindZoomEvent(!1):(e.initZoom(),e.bindZoomEvent()),e.updateAndRedraw()},max(t){const e=this.internal,{config:n,org:{xDomain:a}}=e;return(t===0||t)&&(n.zoom_x_max=_n("max",[a[1],t])),n.zoom_x_max},min(t){const e=this.internal,{config:n,org:{xDomain:a}}=e;return(t===0||t)&&(n.zoom_x_min=_n("min",[a[0],t])),n.zoom_x_min},range(t){const e=this.zoom;if(Be(t)){const{min:n,max:a}=t;Qe(n)&&e.min(n),Qe(a)&&e.max(a)}return{min:e.min(),max:e.max()}}});var Wm={zoom:fu,unzoom(){const t=this.internal,{config:e,$el:{eventRect:n,zoomResetBtn:a},scale:{zoom:i},state:o}=t;i&&(e.subchart_show?t.brush.getSelection().call(t.brush.move,null):t.zoom.updateTransformScale(ar),t.updateZoom(!0),a==null||a.style("display","none"),vs(n.node())!==ar&&t.zoom.transform(n,ar),o.domain=void 0)}},Km={initBrush(){const t=this,{config:e,scale:n,$el:{subchart:a},state:i}=t,o=e.axis_rotated,s=e.subchart_size_height;let l,c,f;t.brush=(o?Gg():Vg()).handleSize(5),t.brush.on("start brush end",g=>{const{selection:v,sourceEvent:m,target:S,type:P}=g;P==="start"&&(t.state.inputType==="touch"&&t.hideTooltip(),c=m?v:null),/(start|brush)/.test(P)&&(P==="brush"&&m&&i.domain&&(c==null||c.forEach((N,L)=>{N!==v[L]&&(i.domain[L]=n.x.orgDomain()[L])})),t.redrawForBrush(P!=="start")),P==="end"&&(l=n.x.orgDomain()),S!=null&&S.handle&&(v===null?t.brush.handle.attr("display","none"):t.brush.handle.attr("display",null).attr("transform",(N,L)=>{const w=[v[L],s/2];return`translate(${o?w.reverse():w})`}))}),t.brush.updateResize=function(){f&&clearTimeout(f),f=setTimeout(()=>{const g=this.getSelection();l&&zl(g.node())&&this.move(g,l.map(n.subX.orgScale()))},0)},t.brush.update=function(){var g;return this.extent()()[1].filter(m=>isNaN(m)).length===0&&((g=a.main)==null||g.select(`.${Ue.brush}`).call(this)),this},t.brush.scale=function(g){const v=e.subchart_size_height;let m=t.axis.getExtent();!m&&g.range?m=[[0,0],[g.range()[1],v]]:je(m)&&(m=m.map((S,P)=>[S,P>0?v:P])),o&&m[1].reverse(),this.extent(m),this.update()},t.brush.getSelection=()=>a.main?a.main.select(`.${Ue.brush}`):ot([])},initSubchart(){const t=this,{config:e,state:{clip:n,hasAxis:a},$el:{defs:i,svg:o,subchart:s,axis:l}}=t;if(!a)return;const c=e.subchart_show?null:"hidden",f=`${n.id}-subchart`,g=t.getClipPath(f);n.idSubchart=f,t.appendClip(i,f),t.initBrush(),s.main=o.append("g").classed(Ue.subchart,!0).attr("transform",t.getTranslate("context"));const{main:v}=s;v.style("visibility",c),v.append("g").attr("clip-path",g).attr("class",Ue.chart),["bar","line","bubble","candlestick","scatter"].forEach(S=>{const P=Cn(/^(bubble|scatter)$/.test(S)?"circle":S);if(t.hasType(S)||t.hasTypeOf(P)){const N=v.select(`.${Ue.chart}`),L=Ue[`chart${P}s`];N.select(`.${L}`).empty()&&N.append("g").attr("class",L)}});const m=v.append("g").attr("clip-path",g).attr("class",Ue.brush).call(t.brush);e.subchart_showHandle&&t.addBrushHandle(m),l.subX=v.append("g").attr("class",Ue.axisX).attr("transform",t.getTranslate("subX")).attr("clip-path",e.axis_rotated?"":n.pathXAxis).style("visibility",e.subchart_axis_x_show?c:"hidden")},addBrushHandle(t){const e=this,{config:n}=e,a=n.axis_rotated,i=n.subchart_init_range,o="handle--custom",s=a?["M8.5 0 a6 6 0 0 0 -6 -6.5 H-2.5 a 6 6 0 0 0 -6 6.5 z m-5 -2 H-3.5 m7 -2 H-3.5z","M8.5 0 a6 -6 0 0 1 -6 6.5 H-2.5 a 6 -6 0 0 1 -6 -6.5z m-5 2 H-3.5 m7 2 H-3.5z"]:["M0 -8.5 A6 6 0 0 0 -6.5 -3.5 V2.5 A6 6 0 0 0 0 8.5 Z M-2 -3.5 V3.5 M-4 -3.5 V3.5z","M0 -8.5 A6 6 0 0 1 6.5 -3.5 V2.5 A6 6 0 0 1 0 8.5 Z M2 -3.5 V3.5 M4 -3.5 V3.5z"];e.brush.handle=t.selectAll(`.${o}`).data(a?[{type:"n"},{type:"s"}]:[{type:"w"},{type:"e"}]).enter().append("path").attr("class",o).attr("cursor",`${a?"ns":"ew"}-resize`).attr("d",l=>s[+/[se]/.test(l.type)]).attr("display",i?null:"none")},updateTargetsForSubchart(t){const e=this,{config:n,state:a,$el:{subchart:{main:i}}}=e;n.subchart_show&&(["bar","line","bubble","candlestick","scatter"].filter(o=>e.hasType(o)||e.hasTypeOf(Cn(o))).forEach(o=>{const s=/^(bubble|scatter)$/.test(o),l=Cn(s?"circle":o),c=e.getChartClass(l,!0),f=e.getClass(s?"circles":`${o}s`,!0),g=i.select(`.${Ue[`chart${`${l}s`}`]}`);if(s){const v=g.selectAll(`.${Ue.circles}`).data(t.filter(e[`is${Cn(o)}Type`].bind(e))).attr("class",f);v.exit().remove(),v.enter().append("g").attr("class",f)}else{const v=g.selectAll(`.${Ue[`chart${l}`]}`).attr("class",c).data(t.filter(e[`is${l}Type`].bind(e))),m=v.enter().append("g").style("opacity","0").attr("class",c).append("g").attr("class",f);v.exit().remove(),o==="line"&&e.hasTypeOf("Area")&&m.append("g").attr("class",e.getClass("areas",!0))}}),i.selectAll(`.${Ue.brush} rect`).attr(n.axis_rotated?"width":"height",n.axis_rotated?a.width2:a.height2))},redrawSubchart(t,e,n){var a;const i=this,{config:o,$el:{subchart:{main:s}},state:l}=i,c=!!e;if(s.style("visibility",o.subchart_show?null:"hidden"),o.subchart_show&&(((a=l.event)==null?void 0:a.type)==="zoom"&&i.brush.update(),t)){const f=o.subchart_init_range;if(!Kl(i)&&i.brush.update(),Object.keys(n.type).forEach(g=>{const v=Cn(g),m=i[`generateDraw${v}`](n.indices[g],!0);i[`update${v}`](c,!0),i[`redraw${v}`](m,c,!0)}),i.hasType("bubble")||i.hasType("scatter")){const{cx:g}=n.pos,v=i.updateCircleY(!0);i.updateCircle(!0),i.redrawCircle(g,v,c,void 0,!0)}!l.rendered&&f&&(l.domain=f,i.brush.move(i.brush.getSelection(),f.map(i.scale.x)))}},redrawForBrush(t=!0){var e;const n=this,{config:{subchart_onbrush:a,zoom_rescale:i},scale:o,state:s}=n;n.redraw({withTransition:!1,withY:i,withSubchart:!1,withUpdateXDomain:!0,withDimension:!1}),t&&s.rendered&&a.bind(n.api)((e=s.domain)!=null?e:o.x.orgDomain())},transformContext(t,e){const n=this,{$el:{subchart:a},$T:i}=n,o=e!=null&&e.axisSubX?e.axisSubX:i(a.main.select(`.${Ue.axisX}`),t);a.main.attr("transform",n.getTranslate("context")),o.attr("transform",n.getTranslate("subX"))}},Zm={initZoom(){const t=this;t.scale.zoom=null,t.generateZoom(),t.config.zoom_type==="drag"&&t.initZoomBehaviour()},bindZoomEvent(t=!0){const e=this,{config:n}=e;n.zoom_enabled&&t?!n.subchart_show&&e.bindZoomOnEventRect():t===!1&&(e.api.unzoom(),e.unbindZoomEvent())},generateZoom(){const t=this,{config:e,org:n,scale:a}=t,i=Ym().duration(0).on("start",t.onZoomStart.bind(t)).on("zoom",t.onZoom.bind(t)).on("end",t.onZoomEnd.bind(t));i.orgScaleExtent=()=>{const o=e.zoom_extent||[1,10];return[o[0],Math.max(t.getMaxDataCount()/o[1],o[1])]},i.updateScaleExtent=function(){const o=Dr(t.scale.x.orgDomain())/Dr(t.getZoomDomain()),s=this.orgScaleExtent();return this.scaleExtent([s[0]*o,s[1]*o]),this},i.updateTransformScale=(o,s)=>{var l;const c=e.axis_rotated;(l=n.xScale)==null||l.range(a.x.range());const f=o[c?"rescaleY":"rescaleX"](n.xScale||a.x);if(f.domain().some(m=>/(Invalid Date|NaN)/.test(m.toString())))return;const g=t.trimXDomain(f.domain()),v=e.zoom_rescale;if(f.domain(g,n.xDomain),s){const m=f(a.x.domain()[0]),S=c?o.x:m,P=c?m:o.y;t.$el.eventRect.property("__zoom",ar.translate(S,P).scale(o.k))}t.state.xTickOffset||(t.state.xTickOffset=t.axis.x.tickOffset()),a.zoom=t.getCustomizedXScale(f),t.axis.x.scale(a.zoom),v?(!n.xScale&&(n.xScale=a.x.copy()),a.x.domain(g)):n.xScale&&(a.x.domain(n.xScale.domain()),n.xScale=null)},i.getDomain=()=>{const o=a[a.zoom?"zoom":"subX"].domain();return t.axis.isCategorized()&&(o[1]-=2),o},t.zoom=i},onZoomStart(t){const e=this,{sourceEvent:n}=t;n&&(e.zoom.startEvent=n,e.state.zooming=!0,_e(e.config.zoom_onzoomstart,e.api,t))},onZoom(t){var e;const n=this,{config:a,scale:i,state:o,org:s}=n,{sourceEvent:l}=t,c=(t==null?void 0:t.transform)===ar;if(!a.zoom_enabled||n.filterTargetsToShow(n.data.targets).length===0||!i.zoom&&(l==null?void 0:l.type.indexOf("touch"))>-1&&(l==null?void 0:l.touches.length)===1)return;t.sourceEvent&&(o.zooming=!0,o.domain=void 0);const f=(l==null?void 0:l.type)==="mousemove",g=(l==null?void 0:l.wheelDelta)<0,{transform:v}=t;!f&&g&&i.x.domain().every((S,P)=>S!==s.xDomain[P])&&i.x.domain(s.xDomain),n.zoom.updateTransformScale(v,a.zoom_type==="wheel"&&l);const m=a.transition_duration>0&&!a.subchart_show&&(o.dragging||c||!t.sourceEvent);n.redraw({withTransition:m,withY:a.zoom_rescale,withSubchart:!1,withEventRect:!1,withDimension:!1}),n.state.cancelClick=f,!c&&_e(a.zoom_onzoom,n.api,(e=n.state.domain)!=null?e:n.zoom.getDomain())},onZoomEnd(t){var e,n;const a=this,{config:i,state:o}=a;let{startEvent:s}=a.zoom,l=t==null?void 0:t.sourceEvent;const c=(t==null?void 0:t.transform)===ar;(s==null?void 0:s.type.indexOf("touch"))>-1&&(s=s.changedTouches[0],l=(e=l==null?void 0:l.changedTouches)==null?void 0:e[0]),!(i.zoom_type==="drag"&&l&&s.clientX===l.clientX&&s.clientY===l.clientY)&&(o.zooming=!1,a.redrawEventRect(),a.updateZoom(),!c&&(l||o.dragging)&&_e(i.zoom_onzoomend,a.api,(n=a.state.domain)!=null?n:a.zoom.getDomain()))},updateZoom(t){const e=this,{subX:n,x:a,zoom:i}=e.scale;if(i){const o=i.domain(),s=n.domain(),l=.015,c=e.config.axis_x_inverted?(o[0]>=s[0]||o[0]+l>=s[0])&&(s[1]>=o[1]||s[1]>=o[1]+l):(o[0]<=s[0]||o[0]-l<=s[0])&&(s[1]<=o[1]||s[1]<=o[1]-l);(t||c)&&(e.axis.x.scale(n),a.domain(n.orgDomain()),e.scale.zoom=null)}},updateCurrentZoomTransform(t,e){const n=this,{$el:{eventRect:a},config:i}=n,o=i.axis_rotated,s=[-t(e[0]),0],l=ar.scale(t.range()[1]/(t(e[1])-t(e[0]))).translate(...o?s.reverse():s);a.call(n.zoom.transform,l)},bindZoomOnEventRect(){var t;const e=this,{config:n,$el:{eventRect:a,svg:i}}=e,o=n.zoom_type==="drag"?e.zoomBehaviour:e.zoom;Ke.GestureEvent&&/^((?!chrome|android|mobile).)*safari/i.test((t=Ke.navigator)==null?void 0:t.userAgent)&&i.on("wheel",()=>{}),a==null||a.call(o).on("dblclick.zoom",null)},initZoomBehaviour(){const t=this,{config:e,state:n}=t,a=e.axis_rotated;let i=0,o=0,s,l;const c={axis:a?"y":"x",attr:a?"height":"width",index:a?1:0};t.zoomBehaviour=uc().clickDistance(4).on("start",function(f){l=t.scale.zoom?null:t.axis.getExtent(),n.event=f,t.setDragStatus(!0),t.unselectRect(),s||(s=t.$el.main.append("rect").attr("clip-path",n.clip.path).attr("class",so.zoomBrush).attr("width",a?n.width:0).attr("height",a?0:n.height)),i=Hn(f,this)[c.index],l&&(il[1]&&(i=l[1])),o=i,s.attr(c.axis,i).attr(c.attr,0),t.onZoomStart(f)}).on("drag",function(f){o=Hn(f,this)[c.index],l&&(o>l[1]?o=l[1]:o{const g=t.scale.zoom||t.scale.x;n.event=f,s.attr(c.axis,0).attr(c.attr,0),i>o&&([i,o]=[o,i]),i<0&&(o+=Math.abs(i),i=0),i!==o&&t.api.zoom([i,o].map(v=>g.invert(v))),t.setDragStatus(!1)})},setZoomResetButton(){const t=this,{config:e,$el:n}=t,a=e.zoom_resetButton;a&&e.zoom_type==="drag"&&(n.zoomResetBtn?n.zoomResetBtn.style("display",null):n.zoomResetBtn=t.$el.chart.append("div").classed(Se.button,!0).append("span").on("click",function(){ve(a.onclick)&&a.onclick.bind(t.api)(this),t.api.unzoom()}).classed(so.buttonZoomReset,!0).text(a.text||"Reset Zoom"))},getZoomTransform(){const t=this,{$el:{eventRect:e}}=t;return e!=null&&e.node()?vs(e.node()):{k:1}}},Jm={drag(t){const e=this,{config:n,state:a,$el:{main:i}}=e,o=n.data_selection_grouped,s=n.interaction_enabled&&n.data_selection_isselectable;if(e.hasArcType()||!n.data_selection_enabled||n.zoom_enabled&&!e.zoom.altDomain||!n.data_selection_multiple)return;const[l,c]=a.dragStart||[0,0],[f,g]=t,v=Math.min(l,f),m=Math.max(l,f),S=o?a.margin.top:Math.min(c,g),P=o?a.height:Math.max(c,g);i.select(`.${Or.dragarea}`).attr("x",v).attr("y",S).attr("width",m-v).attr("height",P-S),i.selectAll(`.${sn.shapes}`).selectAll(`.${sn.shape}`).filter(N=>s==null?void 0:s.bind(e.api)(N)).each(function(N,L){const w=ot(this),X=w.classed(tn.SELECTED),W=w.classed(Or.INCLUDED);let H=!1,k;if(w.classed($n.circle)){const K=+w.attr("cx")*1,at=+w.attr("cy")*1;k=e.togglePoint,H=ve in t?Qm(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,ey=(t,e)=>{for(var n in e||(e={}))_m.call(e,n)&&hu(t,n,e[n]);if(du)for(var n of du(e))ty.call(e,n)&&hu(t,n,e[n]);return t},ny=(t,e)=>km(t,qm(e)),ry=ny(ey({},Jm),{selectPoint(t,e,n){const a=this,{config:i,$el:{main:o},$T:s}=a,l=i.axis_rotated,c=(l?a.circleY:a.circleX).bind(a),f=(l?a.circleX:a.circleY).bind(a),g=a.pointSelectR.bind(a);_e(i.data_onselected,a.api,e,t.node()),s(o.select(`.${tn.selectedCircles}${a.getTargetSelectorSuffix(e.id)}`).selectAll(`.${tn.selectedCircle}-${n}`).data([e]).enter().append("circle").attr("class",()=>a.generateClass(tn.selectedCircle,n)).attr("cx",c).attr("cy",f).attr("stroke",a.color).attr("r",v=>a.pointSelectR(v)*1.4)).attr("r",g)},unselectPoint(t,e,n){const a=this,{config:i,$el:{main:o},$T:s}=a;_e(i.data_onunselected,a.api,e,t==null?void 0:t.node()),s(o.select(`.${tn.selectedCircles}${a.getTargetSelectorSuffix(e.id)}`).selectAll(`.${tn.selectedCircle}-${n}`)).attr("r",0).remove()},togglePoint(t,e,n,a){this[`${t?"":"un"}selectPoint`](e,n,a)},selectPath(t,e){const n=this,{config:a}=n;_e(a.data_onselected,n.api,e,t.node()),a.interaction_brighten&&t.style("filter","brightness(1.25)")},unselectPath(t,e){const n=this,{config:a}=n;_e(a.data_onunselected,n.api,e,t.node()),a.interaction_brighten&&t.style("filter",null)},togglePath(t,e,n,a){this[`${t?"":"un"}selectPath`](e,n,a)},getToggle(t,e){const n=this;return t.nodeName==="path"?n.togglePath:n.isStepType(e)?()=>{}:n.togglePoint},toggleShape(t,e,n){var a;const i=this,{config:o,$el:{main:s}}=i;if(o.data_selection_enabled&&o.data_selection_isselectable.bind(i.api)(e)){const l=ot(t),c=l.classed(tn.SELECTED),f=i.getToggle(t,e).bind(i);let g;if(!o.data_selection_multiple){const v=(a=i.isPointFocusOnly)==null?void 0:a.call(i);let m=`.${v?tn.selectedCircles:sn.shapes}`;o.data_selection_grouped&&(m+=i.getTargetSelectorSuffix(e.id)),s.selectAll(m).selectAll(v?`.${tn.selectedCircle}`:`.${sn.shape}.${tn.SELECTED}`).classed(tn.SELECTED,!1).each(function(S){const P=ot(this);g=P,f(!1,P,S,S.index)})}(!g||g.node()!==l.node())&&(l.classed(tn.SELECTED,!c),f(!c,l,e,n))}}}),ay={data_selection_enabled:!1,data_selection_grouped:!1,data_selection_isselectable:()=>!0,data_selection_multiple:!0,data_selection_draggable:!1,data_onselected:()=>{},data_onunselected:()=>{}},iy={subchart_show:!1,subchart_showHandle:!1,subchart_size_height:60,subchart_axis_x_show:!0,subchart_axis_x_tick_show:!0,subchart_axis_x_tick_format:void 0,subchart_axis_x_tick_text_show:!0,subchart_init_range:void 0,subchart_onbrush:()=>{}},oy={zoom_enabled:!1,zoom_type:"wheel",zoom_extent:void 0,zoom_privileged:!1,zoom_rescale:!1,zoom_onzoom:void 0,zoom_onzoomstart:void 0,zoom_onzoomend:void 0,zoom_resetButton:!0,zoom_x_min:void 0,zoom_x_max:void 0};let gu=()=>(yn(Vr.prototype,ry),yn(Er.prototype,Dm),Nr.setOptions([ay]),(gu=()=>!0)()),vu=()=>(yn(Vr.prototype,Km),yn(Er.prototype,Lm),Nr.setOptions([iy]),(vu=()=>!0)()),pu=()=>(yn(Vr.prototype,Zm),yn(Er.prototype,Wm),Nr.setOptions([oy]),(pu=()=>!0)());function mu(t,e,n){const{config:a}=t,i=(o,s)=>{const l=he(s)?s:s===!1?void 0:null;l!==null&&(a[`axis_${o}_${e}`]=l)};Qe(n)&&(nr(n)?Object.keys(n).forEach(o=>{i(o,n[o])}):(he(n)||n===!1)&&["y","y2"].forEach(o=>{i(o,n)}),t.redraw({withUpdateOrgXDomain:!0,withUpdateXDomain:!0}))}function yu(t,e){const{config:n}=t;return{x:n[`axis_x_${e}`],y:n[`axis_y_${e}`],y2:n[`axis_y2_${e}`]}}var sy={axis:{labels:function(t){const e=this.internal;let n;return t&&(Object.keys(t).forEach(a=>{e.axis.setLabelText(a,t[a])}),e.axis.updateLabels()),["x","y","y2"].forEach(a=>{const i=e.axis.getLabelText(a);i&&(!n&&(n={}),n[a]=i)}),n},min:function(t){const e=this.internal;return De(t)||t===!1?mu(e,"min",t):yu(e,"min")},max:function(t){const e=this.internal;return De(t)||t===!1?mu(e,"max",t):yu(e,"max")},range:function(t){const{axis:e}=this;if(arguments.length){const{min:n,max:a}=t;Qe(a)&&e.max(a),Qe(n)&&e.min(n)}else return{max:e.max(),min:e.min()}}}},ly={category(t,e){const n=this.internal,{config:a}=n;return arguments.length>1&&(a.axis_x_categories[t]=e,n.redraw()),a.axis_x_categories[t]},categories(t){const e=this.internal,{config:n}=e;if(!t||!Array.isArray(t)){const a=n.axis_x_categories;return qn(a)?Object.values(e.data.xs)[0]:a}return n.axis_x_categories=t,e.redraw(),n.axis_x_categories}},cy={flow(t){const e=this.internal;let n;(t.json||t.rows||t.columns)&&e.convertData(t,i=>{n=i,a()});function a(){let i,o=0,s=0,l,c;if(e.state.redrawing||!n||!Da())return;const f=[],g=e.getMaxDataCount(),v=e.convertDataToTargets(n,!0),m=e.axis.isTimeSeries();e.data.targets.forEach(N=>{let L=!1;for(let w=0;w{for(let L=0;L{const L=[];for(let w=e.data.targets[0].values[0].index;w{w.index+=s,m||(w.x+=s)}),N.values=L.concat(N.values)}),e.data.targets=e.data.targets.concat(v);const S=e.data.targets[0],P=S.values[0];Qe(t.to)?(o=0,c=m?Yn.call(e,t.to):t.to,S.values.forEach(N=>{N.x1?S.values[S.values.length-1].x-P.x:P.x-e.getXDomain(e.data.targets)[0]:l=1,i=[P.x-l,P.x]),i&&e.updateXDomain(null,!0,!0,!1,i),e.updateTargets(e.data.targets),e.redraw({flow:{index:P.index,length:o,duration:De(t.duration)?t.duration:e.config.transition_duration,done:t.done,orgDataCount:g},withLegend:!0,withTransition:g>1,withTrimXDomain:!1,withUpdateXAxis:!0})}}};function ms(t,e){const n=this.internal,{config:a}=n,i=a.transition_duration&&Da(),o=`grid_${e}_lines`;return t&&(a[o]=t,n.updateGrid(),n.redrawGrid(i)),a[o]}function xu(t,e){const n=`grid_${e}_lines`;return ms.bind(this)(this.internal.config[n].concat(t||[]),e)}function Tu(t,e){this.internal.removeGridLines(t,e)}const $u=function(t){return ms.bind(this)(t,"x")};yn($u,{add(t){return xu.bind(this)(t,"x")},remove(t){return Tu.bind(this)(t,!0)}});const Su=function(t){return ms.bind(this)(t,"y")};yn(Su,{add(t){return xu.bind(this)(t,"y")},remove(t){return Tu.bind(this)(t,!1)}});var uy={xgrids:$u,ygrids:Su},fy={groups(t){const e=this.internal,{config:n}=e;return ln(t)||(n.data_groups=t,e.redraw()),n.data_groups}};function Au(t,e=!1){const n=this.internal,{config:a}=n,i=a.transition_duration&&Da();return t?(a.regions=e?a.regions.concat(t):t,n.updateRegion(),n.redrawRegion(i),e?a.regions:t):a.regions}const Eu=function(t){return Au.bind(this)(t)};yn(Eu,{add:function(t){return Au.bind(this)(t,!0)},remove:function(t){const e=this.internal,{config:n,$T:a}=e,i=t||{},o=$r(i,"classes",[$a.region]);let s=e.$el.main.select(`.${$a.regions}`).selectAll(o.map(l=>`.${l}`));return a(s).style("opacity","0").remove(),s=n.regions,Object.keys(i).length?(s=s.filter(l=>{let c=!1;return l.class?(l.class.split(" ").forEach(f=>{o.indexOf(f)>=0&&(c=!0)}),!c):!0}),n.regions=s):n.regions=[],s}});var dy={regions:Eu},hy={x(t){const e=this.internal,{axis:n,data:a}=e,i=n.isCustomX()&&n.isCategorized();return je(t)&&(i?this.categories(t):(e.updateTargetX(a.targets,t),e.redraw({withUpdateOrgXDomain:!0,withUpdateXDomain:!0}))),i?this.categories():a.xs},xs(t){const e=this.internal;return Be(t)&&(e.updateTargetXs(e.data.targets,t),e.redraw({withUpdateOrgXDomain:!0,withUpdateXDomain:!0})),e.data.xs}};function gy(t){return t}var Xi=1,Hi=2,ys=3,Ua=4,bu=1e-6;function vy(t){return"translate("+t+",0)"}function py(t){return"translate(0,"+t+")"}function my(t){return e=>+t(e)}function yy(t,e){return e=Math.max(0,t.bandwidth()-e*2)/2,t.round()&&(e=Math.round(e)),n=>+t(n)+e}function xy(){return!this.__axis}function Yi(t,e){var n=[],a=null,i=null,o=6,s=6,l=3,c=typeof window!="undefined"&&window.devicePixelRatio>1?0:.5,f=t===Xi||t===Ua?-1:1,g=t===Ua||t===Hi?"x":"y",v=t===Xi||t===ys?vy:py;function m(S){var P=a==null?e.ticks?e.ticks.apply(e,n):e.domain():a,N=i==null?e.tickFormat?e.tickFormat.apply(e,n):gy:i,L=Math.max(o,0)+l,w=e.range(),X=+w[0]+c,W=+w[w.length-1]+c,H=(e.bandwidth?yy:my)(e.copy(),c),k=S.selection?S.selection():S,K=k.selectAll(".domain").data([null]),at=k.selectAll(".tick").data(P,e).order(),ht=at.exit(),$t=at.enter().append("g").attr("class","tick"),dt=at.select("line"),st=at.select("text");K=K.merge(K.enter().insert("path",".tick").attr("class","domain").attr("stroke","currentColor")),at=at.merge($t),dt=dt.merge($t.append("line").attr("stroke","currentColor").attr(g+"2",f*o)),st=st.merge($t.append("text").attr("fill","currentColor").attr(g,f*L).attr("dy",t===Xi?"0em":t===ys?"0.71em":"0.32em")),S!==k&&(K=K.transition(S),at=at.transition(S),dt=dt.transition(S),st=st.transition(S),ht=ht.transition(S).attr("opacity",bu).attr("transform",function(Vt){return isFinite(Vt=H(Vt))?v(Vt+c):this.getAttribute("transform")}),$t.attr("opacity",bu).attr("transform",function(Vt){var vt=this.parentNode.__axis;return v((vt&&isFinite(vt=vt(Vt))?vt:H(Vt))+c)})),ht.remove(),K.attr("d",t===Ua||t===Hi?s?"M"+f*s+","+X+"H"+c+"V"+W+"H"+f*s:"M"+c+","+X+"V"+W:s?"M"+X+","+f*s+"V"+c+"H"+W+"V"+f*s:"M"+X+","+c+"H"+W),at.attr("opacity",1).attr("transform",function(Vt){return v(H(Vt)+c)}),dt.attr(g+"2",f*o),st.attr(g,f*L).text(N),k.filter(xy).attr("fill","none").attr("font-size",10).attr("font-family","sans-serif").attr("text-anchor",t===Hi?"start":t===Ua?"end":"middle"),k.each(function(){this.__axis=H})}return m.scale=function(S){return arguments.length?(e=S,m):e},m.ticks=function(){return n=Array.from(arguments),m},m.tickArguments=function(S){return arguments.length?(n=S==null?[]:Array.from(S),m):n.slice()},m.tickValues=function(S){return arguments.length?(a=S==null?null:Array.from(S),m):a&&a.slice()},m.tickFormat=function(S){return arguments.length?(i=S,m):i},m.tickSize=function(S){return arguments.length?(o=s=+S,m):o},m.tickSizeInner=function(S){return arguments.length?(o=+S,m):o},m.tickSizeOuter=function(S){return arguments.length?(s=+S,m):s},m.tickPadding=function(S){return arguments.length?(l=+S,m):l},m.offset=function(S){return arguments.length?(c=+S,m):c},m}function Ty(t){return Yi(Xi,t)}function $y(t){return Yi(Hi,t)}function Ru(t){return Yi(ys,t)}function Iu(t){return Yi(Ua,t)}var Sy=Object.defineProperty,Ay=(t,e,n)=>e in t?Sy(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,xs=(t,e,n)=>Ay(t,typeof e!="symbol"?e+"":e,n);class Ou{constructor(e){xs(this,"owner"),xs(this,"config"),xs(this,"scale");const n=zr(),{config:a,params:i}=e;this.owner=e,this.config=a,this.scale=n,(a.noTransition||!i.config.transition_duration)&&(a.withoutTransition=!0),a.range=this.scaleExtent((i.orgXScale||n).range())}static getSizeFor1Char(e,n=!0){const a={w:5.5,h:11.5};return!e.empty()&&e.text("0").call(i=>{try{const{width:o,height:s}=i.node().getBBox();o&&s&&(a.w=o,a.h=s)}finally{i.text("")}}),n&&(this.getSizeFor1Char=()=>a),a}getTickTransformSetter(e){const{config:n}=this,a=e==="x"?i=>`translate(${i+n.tickOffset},0)`:i=>`translate(0,${i})`;return(i,o)=>{i.attr("transform",s=>{const l=o(s);return De(s)?a(l):null})}}scaleExtent(e){const n=e[0],a=e[e.length-1];return n0?i:1,o]).range(e.range());s=c.ticks();for(let f=o.toFixed().length;s.length>15;f--)s=c.ticks(f);s.splice(0,1,i),s.splice(s.length-1,1,o)}else s=e.ticks(...this.config.tickArguments||[]);s=s.map(c=>ze(c)&&he(c)&&!isNaN(c)&&Math.round(c*10)/10||c)}return s}copyScale(){const e=this.scale.copy();return e.domain().length||e.domain(this.scale.domain()),e.type=this.scale.type,e}textFormatted(e){const n=this.config.tickFormat,a=/\d+\.\d+0{5,}\d$/.test(e)?+String(e).replace(/0+\d$/,""):e,i=n?n(a):a;return Qe(i)?i:""}transitionise(e){const{config:n}=this;let a=e;if(n.withoutTransition)a=e.interrupt();else if(n.transition||!this.owner.params.noTransition)try{a=e.transition(n.transition)}catch(i){}return a}}var Ey=Object.defineProperty,by=(t,e,n)=>e in t?Ey(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,za=(t,e,n)=>by(t,typeof e!="symbol"?e+"":e,n);class Ry{constructor(e={}){za(this,"helper"),za(this,"config"),za(this,"params"),za(this,"g"),za(this,"generatedTicks");const n={innerTickSize:6,outerTickSize:e.outerTick?6:0,orient:"bottom",range:[],tickArguments:null,tickCentered:null,tickCulling:!0,tickFormat:null,tickLength:9,tickOffset:0,tickPadding:3,tickValues:null,transition:null,noTransition:e.noTransition};n.tickLength=Math.max(n.innerTickSize,0)+n.tickPadding,this.config=n,this.params=e,this.helper=new Ou(this)}create(e){const n=this,{config:a,helper:i,params:o}=n,{scale:s}=i,{orient:l}=a,c=this.splitTickText.bind(n),f=/^(left|right)$/.test(l),g=/^(top|bottom)$/.test(l),v=i.getTickTransformSetter(g?"x":"y"),m=v===i.axisX?"y":"x",S=/^(top|left)$/.test(l)?-1:1,P=o.tickTextRotate;this.config.range=s.rangeExtent?s.rangeExtent():i.scaleExtent((o.orgXScale||s).range());const{innerTickSize:N,tickLength:L,range:w}=a,X=o.id,W=X&&/^(x|y|y2)$/.test(X)?o.config[`axis_${X}_tick_text_position`]:{x:0,y:0},H=X==="subX"?"subchart_axis_x":`axis_${X}`,k=o.config[`${H}_show`],K={tick:k?o.config[`${H}_tick_show`]:!1,text:k?o.config[`${H}_tick_text_show`]:!1},at=o.config.axis_evalTextSize;let ht;e.each(function(){const $t=ot(this);let dt=this.__chart__||s,st=i.copyScale();ht=$t,this.__chart__=st,a.tickOffset=o.isCategory?(st(1)-st(0))/2:0;const Vt=$t.selectAll(".domain").data([0]);if(Vt.enter().append("path").attr("class","domain").merge(Vt).attr("d",()=>{const vt=a.outerTickSize*S;return g?`M${w[0]},${vt}V0H${w[1]}V${vt}`:`M${vt},${w[0]}H0V${w[1]}H${vt}`}),K.tick||K.text){const vt=a.tickValues||i.generateTicks(st,f);n.generatedTicks=vt;let Q=$t.selectAll(".tick").data(vt,st);const St=Q.enter().insert("g",".domain").attr("class","tick"),ct=Q.exit().remove();Q=St.merge(Q),K.tick&&St.append("line"),K.text&&St.append("text");const At=Q.select("text"),Gt=ve(at)?at.bind(n.params.owner.api)(At.node()):Ou.getSizeFor1Char(At,at),Bt=[];let Kt=At.selectAll("tspan").data((be,Oe)=>{const Ce=o.tickMultiline?c(be,st,vt,f,Gt.w):je(i.textFormatted(be))?i.textFormatted(be).concat():[i.textFormatted(be)];return Bt[Oe]=Ce.length,Ce.map(He=>({index:Oe,splitted:He}))});Kt.exit().remove(),Kt=Kt.enter().append("tspan").merge(Kt).text(be=>be.splitted),Kt.attr("x",g?0:L*S).attr("dx",(()=>{let be=0;return/(top|bottom)/.test(l)&&P&&(be=8*Math.sin(Math.PI*(P/180))*(l==="top"?-1:1)),be+(W.x||0)})()).attr("dy",(be,Oe)=>{const Ce=".71em";let He=0;return l!=="top"&&(He=Gt.h,Oe===0&&(He=f?-((Bt[be.index]-1)*(Gt.h/2)-3):W.y===0?Ce:0)),he(He)&&W.y?He+W.y:He||Ce});const ne=Q.select("line"),le=Q.select("text");if(St.select("line").attr(`${m}2`,N*S),St.select("text").attr(m,L*S),n.setTickLineTextPosition(ne,le),o.tickTitle){const be=le.select("title");(be.empty()?le.append("title"):be).text(Oe=>o.tickTitle[Oe])}if(st.bandwidth){const be=st,Oe=be.bandwidth()/2;dt=Ce=>be(Ce)+Oe,st=dt}else dt.bandwidth?dt=st:v(ct,st);Q=o.owner.state.flowing?i.transitionise(Q):o.owner.$T(Q),v(St,dt),v(Q.style("opacity",null),st)}}),this.g=ht}getGeneratedTicks(e){var n;const a=((n=this.generatedTicks)==null?void 0:n.length)-1;let i=this.generatedTicks;if(a>e){const o=Math.round(a/e+.1);i=this.generatedTicks.map((s,l)=>l%o===0?s:null).filter(s=>s!==null).splice(0,e)}return i}getTickXY(){const{config:e}=this,n={x:0,y:0};return this.params.isCategory&&(n.x=e.tickCentered?0:e.tickOffset,n.y=e.tickCentered?e.tickOffset:0),n}getTickSize(e){const{scale:n}=this.helper,{config:a}=this,{innerTickSize:i,range:o}=a,s=n(e)+(a.tickCentered?0:a.tickOffset);return o[0]{const N=["start","end"];return o==="top"&&N.reverse(),P?N[P>0?0:1]:"middle"},g=P=>P?`rotate(${P})`:null,v=P=>{const N=P/(o==="bottom"?15:23);return P?11.5-2.5*N*(P>0?1:-1):s},{config:{axis_rotated:m,axis_x_tick_text_inner:S}}=this.params.owner;switch(o){case"bottom":e.attr("x1",a.x).attr("x2",a.x).attr("y2",this.getTickSize.bind(this)),n.attr("x",0).attr("y",v(c)).style("text-anchor",f(c)).style("text-anchor",(P,N,{length:L})=>!m&&N===0&&(S===!0||S.first)?"start":!m&&N===L-1&&(S===!0||S.last)?"end":f(c)).attr("transform",g(c));break;case"top":e.attr("x2",0).attr("y2",-i),n.attr("x",0).attr("y",-v(c)*2).style("text-anchor",f(c)).attr("transform",g(c));break;case"left":e.attr("x2",-i).attr("y1",a.y).attr("y2",a.y),n.attr("x",-s).attr("y",l).style("text-anchor","end");break;case"right":e.attr("x2",i).attr("y2",0),n.attr("x",s).attr("y",0).style("text-anchor","start")}}splitTickText(e,n,a,i,o){const{params:s}=this,l=this.helper.textFormatted(e),c=ze(l)&&l.indexOf(` -`)>-1?l.split(` -`):[];if(c.length)return c;if(je(l))return l;let f=s.tickWidth;(!f||f<=0)&&(f=i?95:s.isCategory?(s.isInverted?n(a[0])-n(a[1]):n(a[1])-n(a[0]))-12:110);function g(v,m){let S,P,N;for(let L=1;L{const S=v+1;return Se(this.helper.scale.domain());else{if(!arguments.length)return n.tickValues;n.tickValues=e}return this}setTransition(e){return this.config.transition=e,this}}var Iy=Object.defineProperty,Oy=(t,e,n)=>e in t?Iy(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,pr=(t,e,n)=>Oy(t,typeof e!="symbol"?e+"":e,n),Cy={getAxisInstance:function(){return this.axis||new Py(this)}};class Py{constructor(e){pr(this,"owner"),pr(this,"x"),pr(this,"subX"),pr(this,"y"),pr(this,"y2"),pr(this,"axesList",{}),pr(this,"tick",{x:null,y:null,y2:null}),pr(this,"xs",[]),pr(this,"orient",{x:"bottom",y:"left",y2:"right",subX:"bottom"}),this.owner=e,this.setOrient()}getAxisClassName(e){return`${Tn.axis} ${Tn[`axis${Cn(e)}`]}`}isHorizontal(e,n){const a=e.config.axis_rotated;return n?a:!a}isCategorized(){const{config:e,state:n}=this.owner;return e.axis_x_type.indexOf("category")>=0||n.hasRadar}isCustomX(){const{config:e}=this.owner;return!this.isTimeSeries()&&(e.data_x||cn(e.data_xs))}isTimeSeries(e="x"){return this.owner.config[`axis_${e}_type`]==="timeseries"}isLog(e="x"){return this.owner.config[`axis_${e}_type`]==="log"}isTimeSeriesY(){return this.isTimeSeries("y")}getAxisType(e="x"){let n="linear";return this.isTimeSeries(e)?n=this.owner.config.axis_x_localtime?"time":"utc":this.isLog(e)&&(n="log"),n}getExtent(){const e=this.owner,{config:n,scale:a}=e;let i=n.axis_x_extent;if(i){if(ve(i))i=i.bind(e.api)(e.getXDomain(e.data.targets),a.subX);else if(this.isTimeSeries()&&i.every(isNaN)){const o=Yn.bind(e);i=i.map(s=>a.subX(o(s)))}}return i}init(){const e=this.owner,{config:n,$el:{main:a,axis:i},state:{clip:o}}=e,s=["x","y"];n.axis_y2_show&&s.push("y2"),s.forEach(l=>{const c=this.getAxisClassName(l);i[l]=a.append("g").attr("class",c).attr("clip-path",()=>{let f=null;return l==="x"?f=o.pathXAxis:l==="y"&&(f=o.pathYAxis),f}).attr("transform",e.getTranslate(l)).style("visibility",n[`axis_${l}_show`]?null:"hidden"),this.generateAxes(l)})}setOrient(){const e=this.owner,{axis_rotated:n,axis_y_inner:a,axis_y2_inner:i}=e.config;this.orient={x:n?"left":"bottom",y:n?a?"top":"bottom":a?"right":"left",y2:n?i?"bottom":"top":i?"left":"right",subX:n?"left":"bottom"}}generateAxes(e){const n=this.owner,{config:a}=n,i=[],o=a[`axis_${e}_axes`],s=a.axis_rotated;let l;e==="x"?l=s?Iu:Ru:e==="y"?l=s?Ru:Iu:e==="y2"&&(l=s?Ty:$y),o.length&&o.forEach(c=>{const f=c.tick||{},g=n.scale[e].copy();c.domain&&g.domain(c.domain),i.push(l(g).ticks(f.count).tickFormat(ve(f.format)?f.format.bind(n.api):v=>v).tickValues(f.values).tickSizeOuter(f.outer===!1?0:6))}),this.axesList[e]=i}updateAxes(){const e=this.owner,{config:n,$el:{main:a},$T:i}=e;Object.keys(this.axesList).forEach(o=>{const s=n[`axis_${o}_axes`],l=e.scale[o].copy(),c=l.range();this.axesList[o].forEach((f,g)=>{const v=f.scale().range();c.every((P,N)=>P===v[N])||f.scale().range(c);const m=`${this.getAxisClassName(o)}-${g+1}`;let S=a.select(`.${m.replace(/\s/,".")}`);S.empty()?S=a.append("g").attr("class",m).style("visibility",n[`axis_${o}_show`]?null:"hidden").call(f):(s[g].domain&&l.domain(s[g].domain),i(S).call(f.scale(l))),S.attr("transform",e.getTranslate(o,g+1))})})}setAxis(e,n,a,i){const o=this.owner;e!=="subX"&&(this.tick[e]=this.getTickValues(e)),this[e]=this.getAxis(e,n,a,e==="x"&&(o.scale.zoom||o.config.subchart_show||o.state.resizing)?!0:i)}getAxis(e,n,a,i,o){const s=this.owner,{config:l}=s,c=/^(x|subX)$/.test(e),f=c?"x":e,g=c&&this.isCategorized(),v=this.orient[e],m=o?0:s.getAxisTickRotate(f);let S;if(c)S=e==="subX"?s.format.subXAxisTick:s.format.xAxisTick;else{const X=l[`axis_${e}_tick_format`];ve(X)&&(S=X.bind(s.api))}let P=this.tick[f];const N=ea({outerTick:a,noTransition:i,config:l,id:e,tickTextRotate:m,owner:s},c&&{isCategory:g,isInverted:l.axis_x_inverted,tickMultiline:l.axis_x_tick_multiline,tickWidth:l.axis_x_tick_width,tickTitle:g&&l.axis_x_tick_tooltip&&s.api.categories(),orgXScale:s.scale.x});c||(N.tickStepSize=l[`axis_${f}_tick_stepSize`]);const L=new Ry(N).scale(c&&s.scale.zoom||n).orient(v);if(c&&this.isTimeSeries()&&P&&!ve(P)){const X=Yn.bind(s);P=P.map(W=>X(W))}else!c&&this.isTimeSeriesY()&&(L.ticks(l.axis_y_tick_time_value),P=null);P&&L.tickValues(P),L.tickFormat(S||!c&&s.isStackNormalized()&&(X=>`${X}%`)),g&&(L.tickCentered(l.axis_x_tick_centered),qn(l.axis_x_tick_culling)&&(l.axis_x_tick_culling=!1));const w=l[`axis_${f}_tick_count`];return w&&L.ticks(w),L}updateXAxisTickValues(e,n){var a;const i=this.owner,{config:o}=i,s=o.axis_x_tick_fit;let l=o.axis_x_tick_count,c;return(s||l&&s)&&(c=i.mapTargetsToUniqueXs(e),this.isCategorized()&&l>c.length&&(l=c.length),c=this.generateTickValues(c,l,this.isTimeSeries())),n?n.tickValues(c):this.x&&(this.x.tickValues(c),(a=this.subX)==null||a.tickValues(c)),c}getId(e){const{config:n,scale:a}=this.owner;let i=n.data_axes[e];return(!i||!a[i])&&(i="y"),i}getXAxisTickFormat(e){const n=this.owner,{config:a,format:i}=n,o=e&&a.subchart_axis_x_tick_format||a.axis_x_tick_format,s=this.isTimeSeries(),l=this.isCategorized();let c;return o?ve(o)?c=o.bind(n.api):s&&(c=f=>f?i.axisTime(o)(f):""):c=s?i.defaultAxisTime:l?n.categoryName:f=>f<0?f.toFixed(0):f,ve(c)?f=>c.apply(n,l?[f,n.categoryName(f)]:[f]):c}getTickValues(e){const n=this.owner,a=n.config[`axis_${e}_tick_values`],i=n[`${e}Axis`];return(ve(a)?a.call(n.api):a)||(i?i.tickValues():void 0)}getLabelOptionByAxisId(e){return this.owner.config[`axis_${e}_label`]}getLabelText(e){const n=this.getLabelOptionByAxisId(e);return ze(n)?n:n?n.text:null}setLabelText(e,n){const a=this.owner,{config:i}=a,o=this.getLabelOptionByAxisId(e);ze(o)?i[`axis_${e}_label`]=n:o&&(o.text=n)}getLabelPosition(e,n){const a=this.owner.config.axis_rotated,i=this.getLabelOptionByAxisId(e),o=nr(i)&&i.position?i.position:n[+!a],s=l=>!!~o.indexOf(l);return{isInner:s("inner"),isOuter:s("outer"),isLeft:s("left"),isCenter:s("center"),isRight:s("right"),isTop:s("top"),isMiddle:s("middle"),isBottom:s("bottom")}}getAxisLabelPosition(e){return this.getLabelPosition(e,e==="x"?["inner-top","inner-right"]:["inner-right","inner-top"])}getLabelPositionById(e){return this.getAxisLabelPosition(e)}xForAxisLabel(e){const n=this.owner,{state:{width:a,height:i}}=n,o=this.getAxisLabelPosition(e);let s=o.isMiddle?-i/2:0;return this.isHorizontal(n,e!=="x")?s=o.isLeft?0:o.isCenter?a/2:a:o.isBottom&&(s=-i),s}textAnchorForAxisLabel(e){const n=this.owner,a=this.getAxisLabelPosition(e);let i=a.isMiddle?"middle":"end";return this.isHorizontal(n,e!=="x")?i=a.isLeft?"start":a.isCenter?"middle":"end":a.isBottom&&(i="start"),i}dxForAxisLabel(e){const n=this.owner,a=this.getAxisLabelPosition(e);let i=a.isBottom?"0.5em":"0";return this.isHorizontal(n,e!=="x")?i=a.isLeft?"0.5em":a.isRight?"-0.5em":"0":a.isTop&&(i="-0.5em"),i}dyForAxisLabel(e){const n=this.owner,{config:a}=n,i=a.axis_rotated,o=this.getAxisLabelPosition(e).isInner,s=a[`axis_${e}_tick_rotate`]?n.getHorizontalAxisHeight(e):0,{width:l}=this.getMaxTickSize(e);let c;if(e==="x"){const f=a.axis_x_height;i?c=o?"1.2em":-25-l:o?c="-0.5em":f?c=f-10:s?c=s-10:c="3em"}else c={y:["-0.5em",10,"3em","1.2em",10],y2:["1.2em",-20,"-2.2em","-0.5em",15]}[e],i?o?c=c[0]:s?c=s*(e==="y2"?-1:1)-c[1]:c=c[2]:c=o?c[3]:(c[4]+(a[`axis_${e}_inner`]?0:l+c[4]))*(e==="y"?-1:1);return c}getMaxTickSize(e,n){const a=this.owner,{config:i,state:{current:o},$el:{svg:s,chart:l}}=a,c=o.maxTickSize[e],f=`axis_${e}`,g={width:0,height:0};if(n||!i[`${f}_show`]||c.width>0&&a.filterTargetsToShow().length===0)return c;if(s){const v=/^y2?$/.test(e),m=a.filterTargetsToShow(a.data.targets),S=a.scale[e].copy().domain(a[`get${v?"Y":"X"}Domain`](m,e)),P=S.domain(),N=P[0]===P[1]&&P.every(K=>K>0),L=je(c.domain)&&c.domain[0]===c.domain[1]&&c.domain.every(K=>K>0);if(N||L)return c.size;c.domain=P,v||c.ticks.splice(0);const w=this.getAxis(e,S,!1,!1,!0),X=i[`${f}_tick_rotate`],W=i[`${f}_tick_count`];!i[`${f}_tick_values`]&&W&&w.tickValues(this.generateTickValues(P,W,v?this.isTimeSeriesY():this.isTimeSeries())),!v&&this.updateXAxisTickValues(m,w);const k=l.append("svg").style("visibility","hidden").style("position","fixed").style("top","0").style("left","0");w.create(k),k.selectAll("text").attr("transform",he(X)?`rotate(${X})`:null).each(function(K,at){const{width:ht,height:$t}=this.getBoundingClientRect();g.width=Math.max(g.width,ht),g.height=Math.max(g.height,$t),v||(c.ticks[at]=ht)}),k.remove()}return Object.keys(g).forEach(v=>{g[v]>0&&(c[v]=g[v])}),c}getXAxisTickTextY2Overflow(e){const n=this.owner,{axis:a,config:i,state:{current:o,isLegendRight:s,legendItemWidth:l}}=n,c=n.getAxisTickRotate("x"),f=c>0&&c<90;if((a.isCategorized()||a.isTimeSeries())&&i.axis_x_tick_fit&&(!i.axis_x_tick_culling||qn(i.axis_x_tick_culling))&&!i.axis_x_tick_multiline&&f){const g=i.axis_y2_show&&o.maxTickSize.y2.width||0,v=s&&l||0,m=o.width-n.getCurrentPaddingByDirection("left"),S=this.getXAxisTickMaxOverflow(c,m-e)-g-v,P=Math.max(0,S)+e;return Math.min(P,m/2)}return 0}getXAxisTickMaxOverflow(e,n){const a=this.owner,{axis:i,config:o,state:s}=a,l=i.isTimeSeries(),c=s.current.maxTickSize.x.ticks,f=c.length,{left:g,right:v}=s.axis.x.padding;let m=0;const S=f-(l&&o.axis_x_tick_fit?.5:0);for(let L=0;L{const c=this.getLabelText(l),f=`axis${Cn(l)}`,g=Tn[`${f}Label`];if(c){let v=i.select(`text.${g}`);v.empty()&&(v=i.select(`g.${Tn[f]}`).insert("text",":first-child").attr("class",g).attr("transform",["rotate(-90)",null][l==="x"?+!s:+s]).style("text-anchor",()=>this.textAnchorForAxisLabel(l))),o(v,e).attr("x",()=>this.xForAxisLabel(l)).attr("dx",()=>this.dxForAxisLabel(l)).attr("dy",()=>this.dyForAxisLabel(l)).text(c)}})}getPadding(e,n,a,i){const o=he(e)?e:e[n];return De(o)?this.owner.convertPixelToScale(/(bottom|top)/.test(n)?"y":"x",o,i):a}generateTickValues(e,n,a){let i=e;if(n){const o=ve(n)?n():n;if(o===1)i=[e[0]];else if(o===2)i=[e[0],e[e.length-1]];else if(o>2){const s=this.isCategorized(),l=o-2,c=e[0],f=e[e.length-1],g=(f-c)/(l+1);let v;i=[c];for(let m=0;mo-s)),i}generateTransitions(e){const n=this.owner,{$el:{axis:a},$T:i}=n,[o,s,l,c]=["x","y","y2","subX"].map(f=>i(a[f],e));return{axisX:o,axisY:s,axisY2:l,axisSubX:c}}redraw(e,n,a){const i=this.owner,{config:o,state:s,$el:l}=i,c=n?"0":null;["x","y","y2","subX"].forEach(f=>{const g=this[f],v=l.axis[f];g&&v&&(!a&&!o.transition_duration&&(g.config.withoutTransition=!0),v.style("opacity",c),g.create(e[`axis${Cn(f)}`]))}),this.updateAxes(),!s.rendered&&o.axis_tooltip&&this.setAxisTooltip()}redrawAxis(e,n,a,i,o){var s,l,c;const f=this.owner,{config:g,scale:v,$el:m}=f,S=!!v.zoom;let P;!S&&this.isCategorized()&&e.length===0&&v.x.domain([0,m.axis.x.selectAll(".tick").size()]),v.x&&e.length?(!S&&f.updateXDomain(e,n.UpdateXDomain,n.UpdateOrgXDomain,n.TrimXDomain),g.axis_x_tick_values||this.updateXAxisTickValues(e)):this.x&&(this.x.tickValues([]),(s=this.subX)==null||s.tickValues([])),g.zoom_rescale&&!i&&(P=v.x.orgDomain()),["y","y2"].forEach(N=>{const L=`axis_${N}_`,w=v[N];if(w){const X=g[`${L}tick_values`],W=g[`${L}tick_count`];if(w.domain(f.getYDomain(e,N,P)),!X&&W){const H=f.axis[N],k=w.domain();H.tickValues(this.generateTickValues(k,k.every(K=>K===0)?1:W,this.isTimeSeriesY()))}}}),this.redraw(a,f.hasArcType(),o),this.updateLabels(n.Transition),(n.UpdateXDomain||n.UpdateXAxis||n.Y)&&e.length&&this.setCulling(),n.Y&&((l=v.subY)==null||l.domain(f.getYDomain(e,"y")),(c=v.subY2)==null||c.domain(f.getYDomain(e,"y2")))}setCulling(){const e=this.owner,{config:n,state:{clip:a,current:i},$el:o}=e;["subX","x","y","y2"].forEach(s=>{const l=o.axis[s],f=`axis_${s==="subX"?"x":s}_tick_culling`,g=n[f];if(l&&g){const v=l.selectAll(".tick"),m=na(v.data()),S=m.length,P=n[`${f}_max`],N=n[`${f}_lines`];let L;if(S){for(let w=1;w{var f,g,v;if(ze(l)||l[c])if(s[c]=(f=o[c])==null?void 0:f.append("text").classed(Tn[`axis${c.toUpperCase()}Tooltip`],!0).attr("filter",n.updateTextBGColor({id:c},l)),a){const m=c==="x"?"x":"y",S=c==="y"?"1.15em":c==="x"?"-0.3em":"-0.4em";(g=s[c])==null||g.attr(m,S).attr(`d${c==="x"?"y":"x"}`,c==="x"?"0.4em":"-1.3em").style("text-anchor",c==="x"?"end":null)}else{const m=c==="x"?"y":"x",S=c==="x"?"1.15em":`${c==="y"?"-":""}0.4em`;(v=s[c])==null||v.attr(m,S).attr(`d${c==="x"?"x":"y"}`,c==="x"?"-1em":"0.3em").style("text-anchor",c==="y"?"end":null)}})}}var wy={initEventRect(){this.$el.main.select(`.${Se.chart}`).append("g").attr("class",Zn.eventRects).style("fill-opacity","0")},redrawEventRect(){var t;const e=this,{config:n,state:a,$el:i}=e,o=e.isMultipleX(),s=n.axis_x_inverted;if(i.eventRect)e.updateEventRect(i.eventRect,!0);else if(e.data.targets.length){const c=e.$el.main.select(`.${Zn.eventRects}`).style("cursor",n.zoom_enabled&&n.zoom_type!=="drag"?n.axis_rotated?"ns-resize":"ew-resize":null).classed(Zn.eventRectsMultiple,o).classed(Zn.eventRectsSingle,!o).selectAll(`.${Zn.eventRect}`).data([0]).enter().append("rect");e.updateEventRect(c),e.updateEventType(c),c.call(e.getDraggableSelection()),i.eventRect=c,e.state.inputType==="touch"&&!i.svg.on("touchstart.eventRect")&&!e.hasArcType()&&e.bindTouchOnEventRect(),a.rendered&&e.updateEventRect(i.eventRect,!0)}if(!o){const l=e.getMaxDataCountTarget();(!n.data_xSort||s)&&l.sort((c,f)=>s?f.x-c.x:c.x-f.x),e.updateDataIndexByX(l),e.updateXs(l),(t=e.updatePointClass)==null||t.call(e,!0),a.eventReceiver.data=l}e.updateEventRectData()},bindTouchOnEventRect(){const t=this,{config:e,state:n,$el:{eventRect:a,svg:i}}=t,o=m=>{if(t.isMultipleX())t.selectRectForMultipleXs(m);else{const S=t.getDataIndexFromEvent(n.event);t.callOverOutForTouch(S),S===-1?t.unselectRect():t.selectRectForSingle(m,S)}},s=()=>{t.unselectRect(),t.callOverOutForTouch()},l=e.interaction_inputType_touch.preventDefault,c=Co(l)&&l||!1,f=!isNaN(l)&&l||null;let g;const v=m=>{const S=m.type,N=m.changedTouches[0][`client${e.axis_rotated?"Y":"X"}`];S==="touchstart"?c?m.preventDefault():f!==null&&(g=N):S==="touchmove"&&(c||g===!0||f!==null&&Math.abs(g-N)>=f)&&(g=!0,m.preventDefault())};a.on("touchstart",m=>{n.event=m,t.updateEventRect()}).on("touchstart.eventRect touchmove.eventRect",m=>{if(n.event=m,!a.empty()&&a.classed(Zn.eventRect)){if(n.dragging||n.flowing||t.hasArcType()||m.touches.length>1)return;v(m),o(a.node())}else s()},!0).on("touchend.eventRect",m=>{n.event=m,!a.empty()&&a.classed(Zn.eventRect)&&(t.hasArcType()||!t.toggleShape||n.cancelClick)&&n.cancelClick&&(n.cancelClick=!1)},!0),i.on("touchstart",m=>{n.event=m;const{target:S}=m;S&&S!==a.node()&&s()})},updateEventRect(t,e=!1){const n=this,{state:a,$el:i}=n,{eventReceiver:o,width:s,height:l,rendered:c,resizing:f}=a,g=t||i.eventRect,v=()=>{if(o){const m=Zl(i.chart.node());o.rect=g.node().getBoundingClientRect().toJSON(),o.rect.top+=m.y,o.rect.left+=m.x}};(!c||f||e)&&(g.attr("x",0).attr("y",0).attr("width",s).attr("height",l),(!c||e)&&g.classed(Zn.eventRect,!0)),v()},updateEventType(t){const e=this,n=Co(t),a=n?e.$el.eventRect:t,i=n?t!==(a==null?void 0:a.datum().multipleX):!1;a&&(i&&(a==null||a.on("mouseover mousemove mouseout click",null)),e.isMultipleX()?e.generateEventRectsForMultipleXs(a):e.generateEventRectsForSingleX(a))},updateEventRectData(){const t=this,{config:e,scale:n,state:a}=t,i=n.zoom||n.x,o=e.axis_rotated,s=t.isMultipleX();let l,c,f,g;if(t.updateEventType(s),s)l=0,c=0,f=a.width,g=a.height;else{let S,P;if(t.axis.isCategorized())S=t.getEventRectWidth(),P=N=>i(N.x)-S/2;else{const N=({index:L})=>({prev:t.getPrevX(L),next:t.getNextX(L)});S=L=>{const w=N(L),X=i.domain();let W;return w.prev===null&&w.next===null?W=o?a.height:a.width:w.prev===null?W=(i(w.next)+i(L.x))/2:w.next===null?W=i(X[1])-(i(w.prev)+i(L.x))/2:(Object.keys(w).forEach((H,k)=>{var K;w[H]=(K=w[H])!=null?K:X[k]}),W=Math.max(0,(i(w.next)-i(w.prev))/2)),W},P=L=>{const w=N(L);let X;return w.prev===null&&w.next===null?X=0:w.prev===null?X=i(i.domain()[0]):X=(i(L.x)+i(w.prev))/2,X}}l=o?0:P,c=o?P:0,f=o?a.width:S,g=o?S:a.height}const{eventReceiver:v}=a,m=(S,P)=>ve(S)?S(P):S;v.coords.splice(v.data.length),v.data.forEach((S,P)=>{v.coords[P]={x:m(l,S),y:m(c,S),w:m(f,S),h:m(g,S)}})},selectRectForSingle(t,e){var n,a;const i=this,{config:o,$el:{main:s,circle:l}}=i,c=o.data_selection_enabled,f=o.data_selection_grouped,g=o.data_selection_isselectable,v=o.tooltip_grouped,m=i.getAllValuesOnIndex(e);if(v&&(i.showTooltip(m,t),(n=i.showGridFocus)==null||n.call(i,m),!c||f))return;!l&&s.selectAll(`.${Se.EXPANDED}:not(.${sn.shape}-${e})`).classed(Se.EXPANDED,!1);const S=s.selectAll(`.${sn.shape}-${e}`).classed(Se.EXPANDED,!0).style("cursor",g?"pointer":null).filter(function(P){return i.isWithinShape(this,P)});S.empty()&&!v&&o.interaction_onout&&((a=i.hideGridFocus)==null||a.call(i),i.hideTooltip(),!f&&i.setExpand(e)),S.call(P=>{var N,L;const w=P.data();c&&(f||g!=null&&g.bind(i.api)(w))&&(t.style.cursor="pointer"),v||(i.showTooltip(w,t),(N=i.showGridFocus)==null||N.call(i,w),(L=i.unexpandCircles)==null||L.call(i),P.each(X=>i.setExpand(e,X.id)))})},selectRectForMultipleXs(t,e=!0){const n=this,{config:a,state:i}=n,o=n.filterTargetsToShow(n.data.targets);if(i.dragging||n.hasArcType(o))return;const s=Hn(i.event,t),l=n.findClosestFromTargets(o,s);if(e&&i.mouseover&&(!l||l.id!==i.mouseover.id)&&(a.data_onout.call(n.api,i.mouseover),i.mouseover=void 0),!l){n.unselectRect();return}const f=(n.isBubbleType(l)||n.isScatterType(l)||!a.tooltip_grouped?[l]:n.filterByX(o,l.x)).map(v=>n.addName(v));n.showTooltip(f,t),n.setExpand(l.index,l.id,!0),n.showGridFocus(f);const g=n.dist(l,s);(n.isBarType(l.id)||g{const c=l?e.getDataIndexFromEvent(l):i.currentIdx;return c>-1?i.data[c]:null};o.on("mouseover",l=>{a.event=l,e.updateEventRect(),Object.values(e.$el.axisTooltip).forEach(c=>c==null?void 0:c.style("display",null))}).on("mousemove",function(l){const c=s(l);if(a.event=l,!c)return;let{index:f}=c;const g=n.line_step_type;if(n.line_step_tooltipMatch&&e.hasType("step")&&/^step\-(before|after)$/.test(g)){const m=e.scale.zoom||e.scale.x,S=e.axis.xs[f],P=m.invert(Hn(l,this)[0]);g==="step-after"&&PS&&(f+=1)}e.showAxisGridFocus();const v=n.tooltip_grouped&&f===i.currentIdx;if(a.dragging||a.flowing||e.hasArcType()||v){n.tooltip_show&&v&&e.setTooltipPosition();return}f!==i.currentIdx&&(e.setOverOut(!1,i.currentIdx),i.currentIdx=f),f===-1?e.unselectRect():e.selectRectForSingle(this,f),e.setOverOut(f!==-1,f)}).on("mouseout",l=>{a.event=l,!(!n||e.hasArcType()||i.currentIdx===-1||!n.interaction_onout)&&(e.hideAxisGridFocus(),e.unselectRect(),e.setOverOut(!1,i.currentIdx),i.currentIdx=-1)})}return o},clickHandlerForSingleX(t,e){const n=e,{config:a,state:i,$el:{main:o}}=n;if(!t||n.hasArcType()||i.cancelClick){i.cancelClick&&(i.cancelClick=!1);return}const{index:s}=t;o.selectAll(`.${sn.shape}-${s}`).each(function(l){var c;(a.data_selection_grouped||n.isWithinShape(this,l))&&((c=n.toggleShape)==null||c.call(n,this,l,s),a.data_onclick.bind(n.api)(l,this))})},generateEventRectsForMultipleXs(t){const e=this,{config:n,state:a}=e;t.on("click",function(i){a.event=i,e.clickHandlerForMultipleXS.bind(this)(e)}).datum({multipleX:!0}),a.inputType==="mouse"&&t.on("mouseover mousemove",function(i){a.event=i,e.selectRectForMultipleXs(this)}).on("mouseout",i=>{a.event=i,!(!e.config||e.hasArcType()||!n.interaction_onout)&&e.unselectRect()})},clickHandlerForMultipleXS(t){const e=t,{config:n,state:a}=e,i=e.filterTargetsToShow(e.data.targets);if(e.hasArcType(i))return;const o=Hn(a.event,this),s=e.findClosestFromTargets(i,o),l=e.getPointSensitivity(s);s&&(e.isBarType(s.id)||e.dist(s,o)+t;var Dy={generateFlow(t){const e=this,{data:n,state:a,$el:i}=e;return function(){const o=t.flow.length;a.flowing=!0,n.targets.forEach(l=>{l.values.splice(0,o)}),e.updateXGrid&&e.updateXGrid(!0);const s={};["axis.x","grid.x","gridLines.x","region.list","text","bar","line","area","circle"].forEach(l=>{const c=l.split(".");let f=i[c[0]];f&&c.length>1&&(f=f[c[1]]),f!=null&&f.size()&&(s[l]=f)}),e.hideGridFocus(),e.setFlowList(s,t)}},setFlowList(t,e){const n=this,{flow:a,targets:i}=e,{duration:o=e.duration,index:s,length:l,orgDataCount:c}=a,f=n.getFlowTransform(i,c,s,l),g=ec();let v;g.add(Object.keys(t).map(m=>(v=t[m].transition().ease(My).duration(o),m==="axis.x"?v=v.call(S=>{n.axis.x.setTransition(S).create(S)}):m==="region.list"?v=v.filter(n.isRegionOnX).attr("transform",f):v=v.attr("transform",f),v))),v.call(g,()=>{n.cleanUpFlow(t,e)})},cleanUpFlow(t,e){const n=this,{config:a,state:i,$el:{svg:o}}=n,s=a.axis_rotated,{flow:l,shape:c,xv:f}=e,{cx:g,cy:v,xForText:m,yForText:S}=c.pos,{done:P=()=>{},length:N}=l;N&&(["circle","text","shape","eventRect"].forEach(L=>{const w=[];for(let X=0;X{const w=t[L];if(L!=="axis.x"&&w.attr("transform",null),L==="grid.x")w.attr(i.xgridAttr);else if(L==="gridLines.x")w.attr("x1",s?0:f).attr("x2",s?i.width:f),w.select("text").attr("x",s?i.width:0).attr("y",f);else if(/^(area|bar|line)$/.test(L))w.attr("d",c.type[L]);else if(L==="text")w.attr("x",m).attr("y",S).style("fill-opacity",n.opacityForText.bind(n));else if(L==="circle")if(n.isCirclePoint())w.attr("cx",g).attr("cy",v);else{const X=H=>g(H)-a.point_r,W=H=>v(H)-a.point_r;w.attr("x",X).attr("y",W)}else L==="region.list"&&w.select("rect").filter(n.isRegionOnX).attr("x",n.regionX.bind(n)).attr("width",n.regionWidth.bind(n))}),a.interaction_enabled&&n.redrawEventRect(),P.call(n.api),i.flowing=!1},getFlowTransform(t,e,n,a){const i=this,{data:o,scale:{x:s}}=i,l=o.targets[0].values;let c=i.getValueOnIndex(l,n),f=i.getValueOnIndex(l,n+a),g;const v=s.domain(),m=i.updateXDomain(t,!0,!0);e?e===1||(c==null?void 0:c.x)===(f==null?void 0:f.x)?g=s(v[0])-s(m[0]):g=i.axis.isTimeSeries()?s(v[0])-s(m[0]):s((c==null?void 0:c.x)||0)-s(f.x):l.length!==1?g=s(v[0])-s(m[0]):i.axis.isTimeSeries()?(c=i.getValueOnIndex(l,0),f=i.getValueOnIndex(l,l.length-1),g=s(c.x)-s(f.x)):g=Dr(m)/2;const S=Dr(v)/Dr(m);return`translate(${g},0) scale(${S},1)`}},Ly={initClip(){const t=this,{clip:e,datetimeId:n}=t.state;e.id=`${n}-clip`,e.idXAxis=`${e.id}-xaxis`,e.idYAxis=`${e.id}-yaxis`,e.idGrid=`${e.id}-grid`,e.path=t.getClipPath(e.id),e.pathXAxis=t.getClipPath(e.idXAxis),e.pathYAxis=t.getClipPath(e.idYAxis),e.pathGrid=t.getClipPath(e.idGrid)},getClipPath(t){const e=this,{config:n}=e;return!n.clipPath&&/-clip$/.test(t)||!n.axis_x_clipPath&&/-clip-xaxis$/.test(t)||!n.axis_y_clipPath&&/-clip-yaxis$/.test(t)?null:`url(#${t})`},appendClip(t,e){e&&t.append("clipPath").attr("id",e).append("rect")},setXAxisClipPath(t){const e=this,{config:n,state:{margin:a,width:i,height:o}}=e,s=n.axis_rotated,l=Math.max(30,a.left)-(s?0:20),c=(s?a.top+o+10:a.bottom)+20,f=s?-(1+l):-(l-1),g=-15,v=s?a.left+20:i+10+l;t.attr("x",f).attr("y",g).attr("width",v).attr("height",c)},setYAxisClipPath(t){const e=this,{config:n,state:{margin:a,width:i,height:o}}=e,s=n.axis_rotated,l=Math.max(30,a.left)-(s?20:0),c=n.axis_y_inner,f=c&&!s?n.axis_y_label.text?-20:-1:s?-(1+l):-(l-1),g=-(s?20:a.top),v=(s?i+15+l:a.left+20)+(c?20:0),m=(s?a.bottom+10:a.top+o)+10;t.attr("x",f).attr("y",g).attr("width",v).attr("height",m)},updateXAxisTickClip(){const t=this,{config:e,state:{clip:n,xAxisHeight:a},$el:{defs:i}}=t,o=t.getHorizontalAxisHeight("x");if(i&&!n.idXAxisTickTexts){const s=`${n.id}-xaxisticktexts`;t.appendClip(i,s),n.pathXAxisTickTexts=t.getClipPath(n.idXAxisTickTexts),n.idXAxisTickTexts=s}!e.axis_x_tick_multiline&&t.getAxisTickRotate("x")&&o!==a&&(t.setXAxisTickClipWidth(),t.setXAxisTickTextClipPathWidth()),t.state.xAxisHeight=o},setXAxisTickClipWidth(){const t=this,{config:e,state:{current:{maxTickSize:n}}}=t,a=t.getAxisTickRotate("x");if(!e.axis_x_tick_multiline&&a){const i=Math.sin(Math.PI/180*Math.abs(a));n.x.clipPath=(t.getHorizontalAxisHeight("x")-20)/i}else n.x.clipPath=null},setXAxisTickTextClipPathWidth(){const t=this,{state:{clip:e,current:n},$el:{svg:a}}=t;a&&a.select(`#${e.idXAxisTickTexts} rect`).attr("width",n.maxTickSize.x.clipPath).attr("height",30)}};const Ny=t=>De(t.position)||"end",Fy=t=>t.position==="start"?4:t.position==="middle"?0:-4;function Cu(t,e,n){return a=>{let i=t?0:e;return a.position==="start"?i=t?-n:0:a.position==="middle"&&(i=(t?-n:e)/2),i}}function Pu(t,e){e==="grid"&&t.each(function(){const n=ot(this);["x1","x2","y1","y2"].forEach(a=>n.attr(a,+n.attr(a)))})}var By={hasGrid(){const{config:t}=this;return["x","y"].some(e=>t[`grid_${e}_show`]||t[`grid_${e}_lines`].length)},initGrid(){const t=this;t.hasGrid()&&t.initGridLines(),t.initFocusGrid()},initGridLines(){const t=this,{config:e,state:{clip:n},$el:a}=t;(e.grid_x_lines.length||e.grid_y_lines.length)&&(a.gridLines.main=a.main.insert("g",`.${Se.chart}${e.grid_lines_front?" + *":""}`).attr("clip-path",n.pathGrid).attr("class",`${on.grid} ${on.gridLines}`),a.gridLines.main.append("g").attr("class",on.xgridLines),a.gridLines.main.append("g").attr("class",on.ygridLines),a.gridLines.x=Uc([]))},updateXGrid(t){const e=this,{config:n,scale:a,state:i,$el:{main:o,grid:s}}=e,l=n.axis_rotated,c=e.generateGridData(n.grid_x_type,a.x),f=e.axis.isCategorized()?e.axis.x.tickOffset():0,g=v=>(a.zoom||a.x)(v)+f*(l?-1:1);i.xgridAttr=l?{x1:0,x2:i.width,y1:g,y2:g}:{x1:g,x2:g,y1:0,y2:i.height},s.x=o.select(`.${on.xgrids}`).selectAll(`.${on.xgrid}`).data(c),s.x.exit().remove(),s.x=s.x.enter().append("line").attr("class",on.xgrid).merge(s.x),t||s.x.each(function(){const v=ot(this);Object.keys(i.xgridAttr).forEach(m=>{v.attr(m,i.xgridAttr[m]).style("opacity",()=>v.attr(l?"y1":"x1")===(l?i.height:0)?"0":null)})})},updateYGrid(){const t=this,{axis:e,config:n,scale:a,state:i,$el:{grid:o,main:s}}=t,l=n.axis_rotated,c=g=>a.y(g),f=e.y.getGeneratedTicks(n.grid_y_ticks)||t.scale.y.ticks(n.grid_y_ticks);o.y=s.select(`.${on.ygrids}`).selectAll(`.${on.ygrid}`).data(f),o.y.exit().remove(),o.y=o.y.enter().append("line").attr("class",on.ygrid).merge(o.y),o.y.attr("x1",l?c:0).attr("x2",l?c:i.width).attr("y1",l?0:c).attr("y2",l?i.height:c),Pu(o.y,"grid")},updateGrid(){const t=this,{$el:{grid:e,gridLines:n}}=t;!n.main&&t.initGridLines(),e.main.style("visibility",t.hasArcType()?"hidden":null),t.hideGridFocus(),t.updateGridLines("x"),t.updateGridLines("y")},updateGridLines(t){const e=this,{config:n,$el:{gridLines:a,main:i},$T:o}=e,s=n.axis_rotated,l=t==="x";n[`grid_${t}_show`]&&e[`update${t.toUpperCase()}Grid`]();let c=i.select(`.${on[`${t}gridLines`]}`).selectAll(`.${on[`${t}gridLine`]}`).data(n[`grid_${t}_lines`]);o(c.exit()).style("opacity","0").remove();const f=c.enter().append("g");f.append("line").style("opacity","0"),c=f.merge(c),c.each(function(g){const v=ot(this);v.select("text").empty()&&g.text&&v.append("text").style("opacity","0")}),o(c.attr("class",g=>`${on[`${t}gridLine`]} ${g.class||""}`.trim()).select("text").attr("text-anchor",Ny).attr("transform",()=>l?s?null:"rotate(-90)":s?"rotate(-90)":null).attr("dx",Fy).attr("dy",-5)).text(function(g){var v;return(v=g.text)!=null?v:this.remove()}),a[t]=c},redrawGrid(t){const e=this,{config:{axis_rotated:n},state:{width:a,height:i},$el:{gridLines:o},$T:s}=e,l=e.xv.bind(e),c=e.yv.bind(e);let f=o.x.select("line"),g=o.x.select("text"),v=o.y.select("line"),m=o.y.select("text");return f=s(f,t).attr("x1",n?0:l).attr("x2",n?a:l).attr("y1",n?l:0).attr("y2",n?l:i),g=s(g,t).attr("x",Cu(!n,a,i)).attr("y",l),v=s(v,t).attr("x1",n?c:0).attr("x2",n?c:a).attr("y1",n?0:c).attr("y2",n?i:c),m=s(m,t).attr("x",Cu(n,a,i)).attr("y",c),[f.style("opacity",null),g.style("opacity",null),v.style("opacity",null),m.style("opacity",null)]},initFocusGrid(){const t=this,{config:e,state:{clip:n},$el:a}=t,i=e.grid_front,o=`.${i&&a.gridLines.main?on.gridLines:Se.chart}${i?" + *":""}`,s=a.main.insert("g",o).attr("clip-path",n.pathGrid).attr("class",on.grid);if(a.grid.main=s,e.grid_x_show&&s.append("g").attr("class",on.xgrids),e.grid_y_show&&s.append("g").attr("class",on.ygrids),e.axis_tooltip){const l=s.append("g").attr("class","bb-axis-tooltip");l.append("line").attr("class","bb-axis-tooltip-x"),l.append("line").attr("class","bb-axis-tooltip-y")}e.interaction_enabled&&e.grid_focus_show&&!e.axis_tooltip&&(s.append("g").attr("class",qe.xgridFocus).append("line").attr("class",qe.xgridFocus),e.grid_focus_y&&!e.tooltip_grouped&&s.append("g").attr("class",qe.ygridFocus).append("line").attr("class",qe.ygridFocus))},showAxisGridFocus(){var t,e;const n=this,{config:a,format:i,state:{event:o,width:s,height:l}}=n,c=a.axis_rotated,[f,g]=Hn(o,(t=n.$el.eventRect)==null?void 0:t.node()),v={x:f,y:g};for(const[m,S]of Object.entries(n.$el.axisTooltip)){const P=m==="x"&&!c||m!=="x"&&c?"x":"y",N=v[P];let L=(e=n.scale[m])==null?void 0:e.invert(N);L&&(L=m==="x"&&n.axis.isTimeSeries()?i.xAxisTick(L):L==null?void 0:L.toFixed(2),S==null||S.attr(P,N).text(L))}n.$el.main.selectAll("line.bb-axis-tooltip-x, line.bb-axis-tooltip-y").style("visibility",null).each(function(m,S){const P=ot(this);S===0?P.attr("x1",f).attr("x2",f).attr("y1",S?0:l).attr("y2",S?l:0):P.attr("x1",S?0:s).attr("x2",S?s:0).attr("y1",g).attr("y2",g)})},hideAxisGridFocus(){const t=this;t.$el.main.selectAll("line.bb-axis-tooltip-x, line.bb-axis-tooltip-y").style("visibility","hidden"),Object.values(t.$el.axisTooltip).forEach(e=>e==null?void 0:e.style("display","none"))},showGridFocus(t){var e;const n=this,{config:a,state:{width:i,height:o}}=n,s=a.axis_rotated,l=n.$el.main.selectAll(`line.${qe.xgridFocus}, line.${qe.ygridFocus}`),c=(t||[l.datum()]).filter(v=>v&&De(n.getBaseValue(v)));if(!a.tooltip_show||c.length===0||!a.axis_x_forceAsSingle&&n.hasType("bubble")||n.hasArcType())return;const f=a.grid_focus_edge&&!a.tooltip_grouped,g=n.xx.bind(n);l.style("visibility",null).data(c.concat(c)).each(function(v){const m=ot(this),S={x:g(v),y:n.getYScaleById(v.id)(v.value)};let P;if(m.classed(qe.xgridFocus))P=s?[null,S.x,f?S.y:i,S.x]:[S.x,f?S.y:null,S.x,o];else{const N=n.axis.getId(v.id)==="y2";P=s?[S.y,f&&!N?S.x:null,S.y,f&&N?S.x:o]:[f&&N?S.x:null,S.y,f&&!N?S.x:i,S.y]}["x1","y1","x2","y2"].forEach((N,L)=>m.attr(N,P[L]))}),Pu(l,"grid"),(e=n.showCircleFocus)==null||e.call(n,t)},hideGridFocus(){var t;const e=this,{state:{inputType:n,resizing:a},$el:{main:i}}=e;(n==="mouse"||!a)&&(i.selectAll(`line.${qe.xgridFocus}, line.${qe.ygridFocus}`).style("visibility","hidden"),(t=e.hideCircleFocus)==null||t.call(e))},updateGridFocus(){var t;const e=this,{state:{inputType:n,width:a,height:i,resizing:o},$el:{grid:s}}=e,l=s.main.select(`line.${qe.xgridFocus}`);if(n==="touch")l.empty()?o&&((t=e.showCircleFocus)==null||t.call(e)):e.showGridFocus();else{const c=e.config.axis_rotated;l.attr("x1",c?0:-10).attr("x2",c?a:-10).attr("y1",c?-10:0).attr("y2",c?-10:i)}return!0},generateGridData(t,e){const n=this,a=n.$el.main.select(`.${Tn.axisX}`).selectAll(".tick").size();let i=[];if(t==="year"){const o=n.getXDomain(),[s,l]=o.map(c=>c.getFullYear());for(let c=s;c<=l;c++)i.push(new Date(`${c}-01-01 00:00:00`))}else i=e.ticks(10),i.length>a&&(i=i.filter(o=>String(o).indexOf(".")<0));return i},getGridFilterToRemove(t){return t?e=>{let n=!1;return(je(t)?t.concat():[t]).forEach(a=>{("value"in a&&e.value===a.value||"class"in a&&e.class===a.class)&&(n=!0)}),n}:()=>!0},removeGridLines(t,e){const n=this,{config:a,$T:i}=n,o=n.getGridFilterToRemove(t),s=g=>!o(g),l=e?on.xgridLines:on.ygridLines,c=e?on.xgridLine:on.ygridLine;i(n.$el.main.select(`.${l}`).selectAll(`.${c}`).filter(o)).style("opacity","0").remove();const f=`grid_${e?"x":"y"}_lines`;a[f]=a[f].filter(s)}},Uy={initRegion(){const t=this,{$el:e}=t;e.region.main=e.main.insert("g",":first-child").attr("clip-path",t.state.clip.path).attr("class",$a.regions)},updateRegion(){const t=this,{config:e,$el:{region:n},$T:a}=t;n.main||t.initRegion(),n.main.style("visibility",t.hasArcType()?"hidden":null);const i=n.main.selectAll(`.${$a.region}`).data(e.regions);a(i.exit()).style("opacity","0").remove();const o=i.enter().append("g");o.append("rect").style("fill-opacity","0"),n.list=o.merge(i).attr("class",t.classRegion.bind(t)),n.list.each(function(s){var l;ot(this).select("text").empty()&&((l=s.label)!=null&&l.text)&&ot(this).append("text").style("opacity","0")})},redrawRegion(t){const e=this,{$el:{region:n},$T:a}=e,i=e.regionX.bind(e),o=e.regionY.bind(e),s=["width","height"];let l=n.list.select("rect"),c=n.list.selectAll("text");return l=a(l,t).attr("x",i).attr("y",o).attr("width",e.regionWidth.bind(e)).attr("height",e.regionHeight.bind(e)),c=a(c,t).text(f=>{var g;return(g=f.label)==null?void 0:g.text}).attr("transform",({label:f})=>f.rotated?" rotate(-90)":null).attr("transform",function(f){var g;const{x:v=0,y:m=0,center:S=!1,rotated:P=!1}=(g=f.label)!=null?g:{},N=this.previousElementSibling,L={x:0,y:0};return ze(S)&&["x","y"].forEach((w,X)=>{S.indexOf(w)>-1&&(L[w]=(+N.getAttribute(s[X])-Ma(this)[s[X]])/2)}),`translate(${i(f)+L.x+v}, ${o(f)+L.y+m})${P?" rotate(-90)":""}`}).attr("text-anchor",({label:f})=>f!=null&&f.rotated?"end":null).attr("dy","1em").style("fill",({label:f})=>{var g;return(g=f==null?void 0:f.color)!=null?g:null}),[l.style("fill-opacity",f=>De(f.opacity)?f.opacity:null).on("end",function(){ot(this.parentNode).selectAll("rect:not([x])").remove()}),c.style("opacity",null)]},regionX(t){return this.getRegionSize("x",t)},regionY(t){return this.getRegionSize("y",t)},regionWidth(t){return this.getRegionSize("width",t)},regionHeight(t){return this.getRegionSize("height",t)},getRegionSize(t,e){const n=this,{config:a,scale:i,state:o}=n,s=a.axis_rotated,l=/(x|y|y2)/.test(t),c=l?t==="x":t==="width",f=!l&&n[c?"regionX":"regionY"](e);let g=l?"start":"end",v=l?0:o[t],m;if(e.axis==="y"||e.axis==="y2"?(!l&&!c?g="start":l&&!c&&(g="end"),(c?s:!s)&&g in e&&(m=i[e.axis])):(c?!s:s)&&g in e&&(m=i.zoom||i.x),m){let S=0;v=e[g],n.axis.isTimeSeries(e.axis)?v=Yn.call(n,v):/(x|width)/.test(t)&&n.axis.isCategorized()&&isNaN(v)&&(v=a.axis_x_categories.indexOf(v),S=n.axis.x.tickOffset()*(g==="start"?-1:1)),v=m(v)+S}return l?v:v0&&(!i.axis_x_tick_autorotate||a.needToRotateXAxisTickTexts());return(i.axis_x_tick_multiline||L)&&N.height>S&&(P+=N.height-S),P+(a.axis.getLabelPositionById(t).isInner?0:10)+(t==="y2"&&!f?-10:0)},getEventRectWidth(){const t=this,{config:e,axis:n}=t,a=e.axis_x_inverted,i=n.x.tickInterval();return Math.max(0,a?Math.abs(i):i)},getAxisTickRotate(t){const e=this,{axis:n,config:a,state:i,$el:o}=e;let s=a[`axis_${t}_tick_rotate`];if(t==="x"){const l=n.isCategorized()||n.isTimeSeries();if(a.axis_x_tick_fit&&l){const c=a.axis_x_tick_count,f=i.current.maxTickSize.x.ticks.length;let g=0;if(c?g=c>f?f:c:f&&(g=f),g!==i.axis.x.tickCount){const{targets:v}=e.data;i.axis.x.padding=e.getXDomainPadding([e.getXDomainMinMax(v,"min"),e.getXDomainMinMax(v,"max")],g)}i.axis.x.tickCount=g}o.svg&&a.axis_x_tick_autorotate&&a.axis_x_tick_fit&&!a.axis_x_tick_multiline&&!a.axis_x_tick_culling&&l&&(s=e.needToRotateXAxisTickTexts()?a.axis_x_tick_rotate:0)}return s},needToRotateXAxisTickTexts(){const t=this,{state:{axis:e,current:n,isLegendRight:a,legendItemWidth:i}}=t,o=a&&i,s=n.width-o-t.getCurrentPaddingByDirection("left")-t.getCurrentPaddingByDirection("right"),l=e.x.tickCount+e.x.padding.left+e.x.padding.right,{width:c}=t.axis.getMaxTickSize("x"),f=l?s/l:0;return c>f}},jy={axis_x_clipPath:!0,axis_x_show:!0,axis_x_forceAsSingle:!1,axis_x_type:"indexed",axis_x_localtime:!0,axis_x_categories:[],axis_x_tick_centered:!1,axis_x_tick_format:void 0,axis_x_tick_culling:{},axis_x_tick_culling_max:10,axis_x_tick_culling_lines:!0,axis_x_tick_count:void 0,axis_x_tick_show:!0,axis_x_tick_text_show:!0,axis_x_tick_text_inner:!1,axis_x_tick_text_position:{x:0,y:0},axis_x_tick_fit:!0,axis_x_tick_values:null,axis_x_tick_autorotate:!1,axis_x_tick_rotate:0,axis_x_tick_outer:!0,axis_x_tick_multiline:!0,axis_x_tick_width:null,axis_x_tick_tooltip:!1,axis_x_max:void 0,axis_x_min:void 0,axis_x_inverted:!1,axis_x_padding:{},axis_x_height:void 0,axis_x_extent:void 0,axis_x_label:{},axis_x_axes:[]},Vy={axis_y_clipPath:!0,axis_y_show:!0,axis_y_type:"indexed",axis_y_max:void 0,axis_y_min:void 0,axis_y_inverted:!1,axis_y_center:void 0,axis_y_inner:!1,axis_y_label:{},axis_y_tick_format:void 0,axis_y_tick_culling:!1,axis_y_tick_culling_max:5,axis_y_tick_culling_lines:!0,axis_y_tick_outer:!0,axis_y_tick_values:null,axis_y_tick_rotate:0,axis_y_tick_count:void 0,axis_y_tick_show:!0,axis_y_tick_stepSize:null,axis_y_tick_text_show:!0,axis_y_tick_text_position:{x:0,y:0},axis_y_tick_time_value:void 0,axis_y_padding:{},axis_y_default:void 0,axis_y_axes:[]},Gy={axis_y2_show:!1,axis_y2_type:"indexed",axis_y2_max:void 0,axis_y2_min:void 0,axis_y2_inverted:!1,axis_y2_center:void 0,axis_y2_inner:!1,axis_y2_label:{},axis_y2_tick_format:void 0,axis_y2_tick_culling:!1,axis_y2_tick_culling_max:5,axis_y2_tick_culling_lines:!0,axis_y2_tick_outer:!0,axis_y2_tick_values:null,axis_y2_tick_rotate:0,axis_y2_tick_count:void 0,axis_y2_tick_show:!0,axis_y2_tick_stepSize:null,axis_y2_tick_text_show:!0,axis_y2_tick_text_position:{x:0,y:0},axis_y2_padding:{},axis_y2_default:void 0,axis_y2_axes:[]},Xy=Object.defineProperty,wu=Object.getOwnPropertySymbols,Hy=Object.prototype.hasOwnProperty,Yy=Object.prototype.propertyIsEnumerable,Mu=(t,e,n)=>e in t?Xy(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,Ts=(t,e)=>{for(var n in e||(e={}))Hy.call(e,n)&&Mu(t,n,e[n]);if(wu)for(var n of wu(e))Yy.call(e,n)&&Mu(t,n,e[n]);return t},Wy=Ts(Ts(Ts({axis_evalTextSize:!0,axis_rotated:!1,axis_tooltip:!1},jy),Vy),Gy),Ky={grid_x_show:!1,grid_x_type:"tick",grid_x_lines:[],grid_y_show:!1,grid_y_lines:[],grid_y_ticks:void 0,grid_focus_edge:!1,grid_focus_show:!0,grid_focus_y:!1,grid_front:!1,grid_lines_front:!0},Zy={data_xs:{},data_xFormat:"%Y-%m-%d",data_xLocaltime:!0,data_xSort:!0,data_axes:{},data_regions:{},data_stack_normalize:!1};const Jy=[sy,ly,cy,uy,fy,dy,hy],Du={axis:Cy,clip:Ly,eventrect:wy,flow:Dy,grid:By,region:Uy,sizeAxis:zy},Lu={optDataAxis:Zy,optAxis:Wy,optGrid:Ky};var I1=Array.prototype.slice;function $s(t){return typeof t=="object"&&"length"in t?t:Array.from(t)}function Le(t){return function(){return t}}function Qy(t,e){return et?1:e>=t?0:NaN}function ky(t){return t}function qy(){var t=ky,e=Qy,n=null,a=Le(0),i=Le(zi),o=Le(0);function s(l){var c,f=(l=$s(l)).length,g,v,m=0,S=new Array(f),P=new Array(f),N=+a.apply(this,arguments),L=Math.min(zi,Math.max(-zi,i.apply(this,arguments)-N)),w,X=Math.min(Math.abs(L)/f,o.apply(this,arguments)),W=X*(L<0?-1:1),H;for(c=0;c0&&(m+=H);for(e!=null?S.sort(function(k,K){return e(P[k],P[K])}):n!=null&&S.sort(function(k,K){return n(l[k],l[K])}),c=0,v=m?(L-f*W)/m:0;c0?H*v:0)+W,P[g]={data:l[g],index:c,value:H,startAngle:N,endAngle:w,padAngle:X};return P}return s.value=function(l){return arguments.length?(t=typeof l=="function"?l:Le(+l),s):t},s.sortValues=function(l){return arguments.length?(e=l,n=null,s):e},s.sort=function(l){return arguments.length?(n=l,e=null,s):n},s.startAngle=function(l){return arguments.length?(a=typeof l=="function"?l:Le(+l),s):a},s.endAngle=function(l){return arguments.length?(i=typeof l=="function"?l:Le(+l),s):i},s.padAngle=function(l){return arguments.length?(o=typeof l=="function"?l:Le(+l),s):o},s}var _y=Math.pow;const Ss=Math.PI,As=2*Ss,Gr=1e-6,tx=As-Gr;function Nu(t){this._+=t[0];for(let e=1,n=t.length;e=0))throw new Error(`invalid digits: ${t}`);if(e>15)return Nu;const n=_y(10,e);return function(a){this._+=a[0];for(let i=1,o=a.length;iGr)if(!(Math.abs(v*c-f*g)>Gr)||!o)this._append`L${this._x1=e},${this._y1=n}`;else{let S=a-s,P=i-l,N=c*c+f*f,L=S*S+P*P,w=Math.sqrt(N),X=Math.sqrt(m),W=o*Math.tan((Ss-Math.acos((N+m-L)/(2*w*X)))/2),H=W/X,k=W/w;Math.abs(H-1)>Gr&&this._append`L${e+H*g},${n+H*v}`,this._append`A${o},${o},0,0,${+(v*S>g*P)},${this._x1=e+k*c},${this._y1=n+k*f}`}}arc(e,n,a,i,o,s){if(e=+e,n=+n,a=+a,s=!!s,a<0)throw new Error(`negative radius: ${a}`);let l=a*Math.cos(i),c=a*Math.sin(i),f=e+l,g=n+c,v=1^s,m=s?i-o:o-i;this._x1===null?this._append`M${f},${g}`:(Math.abs(this._x1-f)>Gr||Math.abs(this._y1-g)>Gr)&&this._append`L${f},${g}`,a&&(m<0&&(m=m%As+As),m>tx?this._append`A${a},${a},0,1,${v},${e-l},${n-c}A${a},${a},0,1,${v},${this._x1=f},${this._y1=g}`:m>Gr&&this._append`A${a},${a},0,${+(m>=Ss)},${v},${this._x1=e+a*Math.cos(o)},${this._y1=n+a*Math.sin(o)}`)}rect(e,n,a,i){this._append`M${this._x0=this._x1=+e},${this._y0=this._y1=+n}h${a=+a}v${+i}h${-a}Z`}toString(){return this._}}function nx(){return new Wi}nx.prototype=Wi.prototype;function O1(t=3){return new Wi(+t)}function Es(t){let e=3;return t.digits=function(n){if(!arguments.length)return e;if(n==null)e=null;else{const a=Math.floor(n);if(!(a>=0))throw new RangeError(`invalid digits: ${n}`);e=a}return t},()=>new Wi(e)}function rx(t){return t.innerRadius}function ax(t){return t.outerRadius}function ix(t){return t.startAngle}function ox(t){return t.endAngle}function sx(t){return t&&t.padAngle}function lx(t,e,n,a,i,o,s,l){var c=n-t,f=a-e,g=s-i,v=l-o,m=v*c-g*f;if(!(m*mQ*Q+St*St&&(ht=dt,$t=st),{cx:ht,cy:$t,x01:-g,y01:-v,x11:ht*(i/k-1),y11:$t*(i/k-1)}}function Fu(){var t=rx,e=ax,n=Le(0),a=null,i=ix,o=ox,s=sx,l=null,c=Es(f);function f(){var g,v,m=+t.apply(this,arguments),S=+e.apply(this,arguments),P=i.apply(this,arguments)-Ui,N=o.apply(this,arguments)-Ui,L=Hc(N-P),w=N>P;if(l||(l=g=c()),Sbn))l.moveTo(0,0);else if(L>zi-bn)l.moveTo(S*jr(P),S*rr(P)),l.arc(0,0,S,P,N,!w),m>bn&&(l.moveTo(m*jr(N),m*rr(N)),l.arc(0,0,m,N,P,w));else{var X=P,W=N,H=P,k=N,K=L,at=L,ht=s.apply(this,arguments)/2,$t=ht>bn&&(a?+a.apply(this,arguments):oa(m*m+S*S)),dt=fs(Hc(S-m)/2,+n.apply(this,arguments)),st=dt,Vt=dt,vt,Q;if($t>bn){var St=Yc($t/m*rr(ht)),ct=Yc($t/S*rr(ht));(K-=St*2)>bn?(St*=w?1:-1,H+=St,k-=St):(K=0,H=k=(P+N)/2),(at-=ct*2)>bn?(ct*=w?1:-1,X+=ct,W-=ct):(at=0,X=W=(P+N)/2)}var At=S*jr(X),Gt=S*rr(X),Bt=m*jr(k),Kt=m*rr(k);if(dt>bn){var ne=S*jr(W),le=S*rr(W),be=m*jr(H),Oe=m*rr(H),Ce;if(Lbn?Vt>bn?(vt=Ki(be,Oe,At,Gt,S,Vt,w),Q=Ki(ne,le,Bt,Kt,S,Vt,w),l.moveTo(vt.cx+vt.x01,vt.cy+vt.y01),Vtbn)||!(K>bn)?l.lineTo(Bt,Kt):st>bn?(vt=Ki(Bt,Kt,ne,le,m,-st,w),Q=Ki(At,Gt,be,Oe,m,-st,w),l.lineTo(vt.cx+vt.x01,vt.cy+vt.y01),ste in t?cx(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,gx=(t,e)=>{for(var n in e||(e={}))dx.call(e,n)&&Uu(t,n,e[n]);if(Bu)for(var n of Bu(e))hx.call(e,n)&&Uu(t,n,e[n]);return t},vx=(t,e)=>ux(t,fx(e));function zu(t=0){const e=this,{config:n,state:a}=e,i=e.hasMultiArcGauge(),o=a.gaugeArcWidth/e.filterTargetsToShow(e.data.targets).length,s=t?Math.min(a.radiusExpanded*t-a.radius,o*.8-(1-t)*100):0;return{inner(l){const{innerRadius:c}=e.getRadius(l);return i?a.radius-o*(l.index+1):he(c)?c:0},outer(l){const{outerRadius:c}=e.getRadius(l);let f;if(i)f=a.radius-o*l.index+s;else if(e.hasType("polar")&&!t)f=e.getPolarOuterRadius(l,c);else if(f=c,t){let{radiusExpanded:g}=a;a.radius!==c&&(g-=Math.abs(a.radius-c)),f=g*t}return f},corner(l,c){const{arc_cornerRadius_ratio:f=0,arc_cornerRadius:g=0}=n,{data:{id:v},value:m}=l;let S=0;return f?S=f*c:S=he(g)?g:g.call(e.api,v,m,c),S}}}function bs(t){return function(e){const n=({startAngle:i=0,endAngle:o=0,padAngle:s=0})=>({startAngle:i,endAngle:o,padAngle:s}),a=Qr(n(this._current),n(e));return this._current=e,function(i){const o=a(i),{data:s,index:l,value:c}=e;return t(vx(gx({},o),{data:s,index:l,value:c}))}}}var px={initPie(){const t=this,{config:e}=t,n=e.data_type,a=e[`${n}_padding`],i=e[`${n}_startingAngle`]||0,o=(a?a*.01:e[`${n}_padAngle`])||0;t.pie=qy().startAngle(i).endAngle(i+2*Math.PI).padAngle(o).value(s=>{var l,c;return(c=(l=s.values)==null?void 0:l.reduce((f,g)=>f+g.value,0))!=null?c:s}).sort(t.getSortCompareFn.bind(t)(!0))},updateRadius(){const t=this,{config:e,state:n}=t,a=e.data_type,i=e[`${a}_padding`],o=e.gauge_width||e.donut_width,s=t.filterTargetsToShow(t.data.targets).length*e.gauge_arcs_minWidth;n.radiusExpanded=Math.min(n.arcWidth,n.arcHeight)/2*(t.hasMultiArcGauge()&&e.gauge_label_show?.85:1),n.radius=n.radiusExpanded*.95,n.innerRadiusRatio=o?(n.radius-o)/n.radius:.6,n.gaugeArcWidth=o||(s<=n.radius-n.innerRadius?n.radius-n.innerRadius:s<=n.radius?s:n.radius);const l=e.pie_innerRadius||(i?i*(n.innerRadiusRatio+.1):0);n.outerRadius=e.pie_outerRadius,n.innerRadius=t.hasType("donut")||t.hasType("gauge")?n.radius*n.innerRadiusRatio:l},getRadius(t){const e=this,n=t==null?void 0:t.data;let{innerRadius:a,outerRadius:i}=e.state;return!he(a)&&n&&(a=a[n.id]||0),Be(i)&&n&&n.id in i?i=i[n.id]:he(i)||(i=e.state.radius),{innerRadius:a,outerRadius:i}},updateArc(){const t=this;t.updateRadius(),t.svgArc=t.getSvgArc(),t.svgArcExpanded=t.getSvgArcExpanded()},getArcLength(){const t=this,{config:e}=t,n=e.gauge_arcLength*3.6;let a=2*(n/360);return n<-360?a=-2:n>360&&(a=2),a*Math.PI},getStartingAngle(){const t=this,{config:e}=t,n=e.data_type,a=t.hasType("gauge")?e.gauge_fullCircle:!1,i=-1*Math.PI/2,o=Math.PI/2;let s=e[`${n}_startingAngle`]||0;return!a&&s<=i?s=i:!a&&s>=o?s=o:(s>Math.PI||s<-1*Math.PI)&&(s=Math.PI),s},updateAngle(t,e=!1){var n;const a=this,{config:i,state:o}=a,s=e&&a.hasType("gauge");let{pie:l}=a,c=t,f=!1;if(!i)return null;const g=a.getStartingAngle(),v=i.gauge_fullCircle||e&&!s?a.getArcLength():g*-2;if(c.data&&a.isGaugeType(c.data)&&!a.hasMultiArcGauge()){const{gauge_min:m,gauge_max:S}=i,P=a.getTotalDataSum(o.rendered),N=v*((P-m)/(S-m));l=l.startAngle(g).endAngle(N+g)}if(e===!1&&l(a.filterTargetsToShow()).forEach((m,S)=>{var P;!f&&m.data.id===((P=c.data)==null?void 0:P.id)&&(f=!0,c=m,c.index=S)}),isNaN(c.startAngle)&&(c.startAngle=0),isNaN(c.endAngle)&&(c.endAngle=c.startAngle),e||c.data&&(i.gauge_enforceMinMax||a.hasMultiArcGauge())){const{gauge_min:m,gauge_max:S}=i,P=e&&!s?a.getTotalDataSum(o.rendered):S,N=v/(P-m),L=(n=c.value)!=null?n:0,w=L{const l=e.updateAngle(s),c=a(l);let f=0;return l&&(f=i(l,c)),l?o.cornerRadius(f)(l):"M 0 0"}},getArc(t,e,n){return n||this.isArcType(t.data)?this.svgArc(t,e):"M 0 0"},redrawArcRangeText(){const t=this,{config:e,$el:{arcs:n},state:a,$T:i}=t,o=e.arc_rangeText_format,s=t.hasType("gauge")&&e.arc_rangeText_fixed;let l=e.arc_rangeText_values;if(l!=null&&l.length){const c=e.arc_rangeText_unit==="%",f=t.getTotalDataSum(a.rendered);c&&(l=l.map(m=>f/100*m));const g=t.pie(l).map((m,S)=>(m.index=S,m));let v=n.selectAll(`.${Ve.arcRange}`).data(l);v.exit(),v=i(v.enter().append("text").attr("class",Ve.arcRange).style("text-anchor","middle").style("pointer-events","none").style("opacity","0").text(m=>{const S=c?m/f*100:m;return ve(o)?o(S):`${S}${c?"%":""}`}).merge(v)),(!a.rendered||a.rendered&&!s)&&f>0&&v.attr("transform",(m,S)=>t.transformForArcLabel(g[S],!0)),v.style("opacity",m=>!s&&(m>f||f===0)?"0":null)}},transformForArcLabel(t,e=!1){var n,a,i;const o=this,{config:s,state:{radiusExpanded:l}}=o,c=o.updateAngle(t,e);let f="";if(c){if(e||o.hasMultiArcGauge()){const g=Math.sin(c.endAngle-Math.PI/2),v=s.arc_rangeText_position;let m=Math.cos(c.endAngle-Math.PI/2)*(l+(e?5:25)),S=g*(l+15-Math.abs(g*10))+3;if(e&&v){const P=s.arc_rangeText_values,N=ve(v)?v(P[t.index]):v;m+=(n=N==null?void 0:N.x)!=null?n:0,S+=(a=N==null?void 0:N.y)!=null?a:0}f=`translate(${m},${S})`}else if(!o.hasType("gauge")||o.data.targets.length>1){let{outerRadius:g}=o.getRadius(t);o.hasType("polar")&&(g=o.getPolarOuterRadius(t,g));const v=this.svgArc.centroid(c),[m,S]=v.map(L=>isNaN(L)?0:L),P=Math.sqrt(m*m+S*S);let N=(i=["donut","gauge","pie","polar"].filter(o.hasType.bind(o)).map(L=>s[`${L}_label_ratio`]))==null?void 0:i[0];N?N=ve(N)?N.bind(o.api)(t,g,P):N:N=g&&(P?(36/g>.375?1.175-36/g:.8)*g/P:0),f=`translate(${m*N},${S*N})`}}return f},convertToArcData(t){return this.addName({id:"data"in t?t.data.id:t.id,value:t.value,ratio:this.getRatio("arc",t),index:t.index})},textForArcLabel(t){const e=this,n=e.hasType("gauge");e.shouldShowArcLabel()&&t.style("fill",e.updateTextColor.bind(e)).attr("filter",a=>e.updateTextBGColor.bind(e)(a,e.config.data_labels_backgroundColors)).each(function(a){var i;const o=ot(this),s=e.updateAngle(a),l=e.getRatio("arc",s);if(e.meetsLabelThreshold(l,(i=["donut","gauge","pie","polar"].filter(e.hasType.bind(e)))==null?void 0:i[0])){const{value:f}=s||a,g=(e.getArcLabelFormat()||e.defaultArcValueFormat)(f,l,a.data.id).toString();wa(o,g,[-1,1],n)}else o.text("")})},expandArc(t){const e=this,{state:{transiting:n},$el:a}=e;if(n){const o=setInterval(()=>{n||(clearInterval(o),a.legend.selectAll(`.${qe.legendItemFocused}`).size()>0&&e.expandArc(t))},10);return}const i=e.mapToTargetIds(t);a.svg.selectAll(e.selectorTargets(i,`.${Ve.chartArc}`)).each(function(o){if(!e.shouldExpand(o.data.id))return;const s=e.getExpandConfig(o.data.id,"duration"),l=e.getSvgArcExpanded(e.getExpandConfig(o.data.id,"rate"));ot(this).selectAll("path").transition().duration(s).attrTween("d",bs(e.svgArcExpanded.bind(e))).transition().duration(s*2).attrTween("d",bs(l.bind(e)))})},unexpandArc(t){const e=this,{state:{transiting:n},$el:{svg:a}}=e;if(n)return;const i=e.mapToTargetIds(t);a.selectAll(e.selectorTargets(i,`.${Ve.chartArc}`)).selectAll("path").transition().duration(o=>e.getExpandConfig(o.data.id,"duration")).attrTween("d",bs(e.svgArc.bind(e))),a.selectAll(`${Ve.arc}`).style("opacity",null)},getExpandConfig(t,e){const n=this,{config:a}=n,i={duration:50,rate:.98};let o;return n.isDonutType(t)?o="donut":n.isGaugeType(t)?o="gauge":n.isPieType(t)&&(o="pie"),o?a[`${o}_expand_${e}`]:i[e]},shouldExpand(t){const e=this,{config:n}=e;return e.isDonutType(t)&&n.donut_expand||e.isGaugeType(t)&&n.gauge_expand||e.isPieType(t)&&n.pie_expand},shouldShowArcLabel(){const t=this,{config:e}=t;return["donut","gauge","pie","polar"].some(n=>t.hasType(n)&&e[`${n}_label_show`])},getArcLabelFormat(){const t=this,{config:e}=t;let n=a=>a;return["donut","gauge","pie","polar"].filter(t.hasType.bind(t)).forEach(a=>{n=e[`${a}_label_format`]}),ve(n)?n.bind(t.api):n},updateTargetsForArc(t){const e=this,{$el:n}=e,a=e.hasType("gauge"),i=e.getChartClass("Arc"),o=e.getClass("arcs",!0),s=e.classFocus.bind(e),l=n.main.select(`.${Ve.chartArcs}`),c=l.selectAll(`.${Ve.chartArc}`).data(e.pie(t)).attr("class",g=>i(g)+s(g.data)),f=c.enter().append("g").attr("class",i).call(this.setCssRule(!1,`.${Ve.chartArcs} text`,["pointer-events:none","text-anchor:middle"]));f.append("g").attr("class",o).merge(c),f.append("text").attr("dy",a&&!e.hasMultiTargets()?"-.1em":".35em").style("opacity","0").style("text-anchor",e.getStylePropValue("middle")).style("pointer-events",e.getStylePropValue("none")),n.text=l.selectAll(`.${Se.target} text`)},initArc(){const t=this,{$el:e}=t;e.arcs=e.main.select(`.${Se.chart}`).append("g").attr("class",Ve.chartArcs).attr("transform",t.getTranslate("arc")),t.setArcTitle()},setArcTitle(t){const e=this,n=t||e.getArcTitle(),a=e.hasType("gauge");if(n){const i=a?Un.chartArcsGaugeTitle:Ve.chartArcsTitle;let o=e.$el.arcs.select(`.${i}`);o.empty()&&(o=e.$el.arcs.append("text").attr("class",i).style("text-anchor","middle")),a&&o.attr("dy","-0.3em"),wa(o,n,a?void 0:[-.6,1.35],!0)}},getArcTitle(){const t=this,e=t.hasType("donut")&&"donut"||t.hasType("gauge")&&"gauge";return e?t.config[`${e}_title`]:""},getArcTitleWithNeedleValue(){const t=this,{config:e,state:n}=t,a=t.getArcTitle();if(a&&t.config.arc_needle_show&&/{=[A-Z_]+}/.test(a)){let i=n.current.needle;return he(i)||(i=e.arc_needle_value),bi(a,{NEEDLE_VALUE:he(i)?i:0})}return!1},redrawArc(t,e,n){const a=this,{config:i,state:o,$el:{main:s}}=a,l=i.interaction_enabled,c=l&&i.data_selection_isselectable;let f=s.selectAll(`.${Ve.arcs}`).selectAll(`.${Ve.arc}`).data(a.arcData.bind(a));f.exit().transition().duration(e).style("opacity","0").remove(),f=f.enter().append("path").attr("class",a.getClass("arc",!0)).style("fill",g=>a.color(g.data)).style("cursor",g=>{var v;return(v=c==null?void 0:c.bind)!=null&&v.call(c,a.api)(g)?"pointer":null}).style("opacity","0").each(function(g){a.isGaugeType(g.data)&&(g.startAngle=i.gauge_startingAngle,g.endAngle=i.gauge_startingAngle),this._current=g}).merge(f),a.hasType("gauge")&&(a.updateGaugeMax(),a.hasMultiArcGauge()&&a.redrawArcGaugeLine()),f.attr("transform",g=>!a.isGaugeType(g.data)&&n?"scale(0)":"").style("opacity",function(g){return g===this._current?"0":null}).each(()=>{o.transiting=!0}).transition().duration(t).attrTween("d",function(g){const v=a.updateAngle(g);if(!v)return()=>"M 0 0";isNaN(this._current.startAngle)&&(this._current.startAngle=0),isNaN(this._current.endAngle)&&(this._current.endAngle=this._current.startAngle);const m=Qr(this._current,v);return this._current=m(0),function(S){const P=m(S);return P.data=g.data,a.getArc(P,!0)}}).attr("transform",n?"scale(1)":"").style("fill",g=>{let v;return a.levelColor?(v=a.levelColor(g.data.values[0].value),i.data_colors[g.data.id]=v):v=a.color(g.data),v}).style("opacity",null).call(Si,function(){if(a.levelColor){const g=ot(this),v=g.datum(this._current);a.updateLegendItemColor(v.data.id,g.style("fill"))}o.transiting=!1,_e(i.onrendered,a.api)}),l&&a.bindArcEvent(f),a.hasType("polar")&&a.redrawPolar(),a.hasType("gauge")&&a.redrawBackgroundArcs(),i.arc_needle_show&&a.redrawNeedle(),a.redrawArcText(t),a.redrawArcRangeText()},redrawNeedle(){const t=this,{$el:e,config:n,state:{hiddenTargetIds:a,radius:i}}=t,o=(i-1)/100*n.arc_needle_length,s=a.length!==t.data.targets.length;let l=t.$el.arcs.select(`.${Ve.needle}`);const c=n.arc_needle_path,f=n.arc_needle_bottom_width/2,g=n.arc_needle_top_width/2,v=n.arc_needle_top_rx,m=n.arc_needle_top_ry,S=n.arc_needle_bottom_len,P=n.arc_needle_bottom_rx,N=n.arc_needle_bottom_ry,L=t.getNeedleAngle(),w=()=>{const X=t.getArcTitleWithNeedleValue();X&&t.setArcTitle(X)};if(w(),l.empty()&&(l=e.arcs.append("path").classed(Ve.needle,!0),e.needle=l,e.needle.updateHelper=(X,W=!1)=>{e.needle.style("display")!=="none"&&t.$T(e.needle).style("transform",`rotate(${t.getNeedleAngle(X)}deg)`).call(Si,()=>{W&&(n.arc_needle_value=X),w()})}),s){const X=ve(c)?c.call(t,o):`M-${f} ${S} A${P} ${N} 0 0 0 ${f} ${S} L${g} -${o} A${v} ${m} 0 0 0 -${g} -${o} L-${f} ${S} Z`;t.$T(l).attr("d",X).style("fill",n.arc_needle_color).style("display",null).style("transform",`rotate(${L}deg)`)}else l.style("display","none")},getNeedleAngle(t){const e=this,{config:n,state:a}=e,i=e.getArcLength(),o=e.hasType("gauge"),s=e.getTotalDataSum(!0);let l=Qe(t)?t:n.arc_needle_value,c=n[`${n.data_type}_startingAngle`]||0,f=0;if(he(l)||(l=o&&e.data.targets.length===1?s:0),a.current.needle=l,o){c=e.getStartingAngle();const g=n.gauge_fullCircle?i:c*-2,{gauge_min:v,gauge_max:m}=n;f=g*((l-v)/(m-v))}else f=i*(l/s);return(c+f)*(180/Math.PI)},redrawBackgroundArcs(){const t=this,{config:e,state:n}=t,a=t.hasMultiArcGauge(),i=e.gauge_fullCircle,o=t.filterTargetsToShow(t.data.targets).length===0&&!!e.data_empty_label_text,s=t.getStartingAngle(),l=i?s+t.getArcLength():s*-1;let c=t.$el.arcs.select(`${a?"g":""}.${Ve.chartArcsBackground}`);if(a){let f=0;c=c.selectAll(`path.${Ve.chartArcsBackground}`).data(t.data.targets),c.enter().append("path").attr("class",(g,v)=>`${Ve.chartArcsBackground} ${Ve.chartArcsBackground}-${v}`).merge(c).style("fill",e.gauge_background||null).attr("d",({id:g})=>{if(o||n.hiddenTargetIds.indexOf(g)>=0)return"M 0 0";const v={data:[{value:e.gauge_max}],startAngle:s,endAngle:l,index:f++};return t.getArc(v,!0,!0)}),c.exit().remove()}else c.attr("d",o?"M 0 0":()=>{const f={data:[{value:e.gauge_max}],startAngle:s,endAngle:l};return t.getArc(f,!0,!0)})},bindArcEvent(t){const e=this,{config:n,state:a}=e,i=a.inputType==="touch",o=a.inputType==="mouse";function s(c,f,g){e.expandArc(g),e.api.focus(g),e.toggleFocusLegend(g,!0),e.showTooltip([f],c)}function l(c){const f=(c==null?void 0:c.id)||void 0;e.unexpandArc(f),e.api.revert(),e.revertLegend(),e.hideTooltip()}if(t.on("click",function(c,f,g){var v;const m=e.updateAngle(f);let S;m&&(S=e.convertToArcData(m),(v=e.toggleShape)==null||v.call(e,this,S,g),n.data_onclick.bind(e.api)(S,this))}),o&&t.on("mouseover",function(c,f){if(a.transiting)return;a.event=c;const g=e.updateAngle(f),v=g?e.convertToArcData(g):null,m=(v==null?void 0:v.id)||void 0;s(this,v,m),e.setOverOut(!0,v)}).on("mouseout",(c,f)=>{if(a.transiting||!n.interaction_onout)return;a.event=c;const g=e.updateAngle(f),v=g?e.convertToArcData(g):null;l(),e.setOverOut(!1,v)}).on("mousemove",function(c,f){const g=e.updateAngle(f),v=g?e.convertToArcData(g):null;a.event=c,e.showTooltip([v],this)}),i&&e.hasArcType()&&!e.radars){const c=f=>{var g,v;const{clientX:m,clientY:S}=(v=(g=f.changedTouches)==null?void 0:g[0])!=null?v:{clientX:0,clientY:0};return ot(gn.elementFromPoint(m,S))};e.$el.svg.on("touchstart touchmove",function(f){if(a.transiting)return;a.event=f;const v=c(f).datum(),m=v!=null&&v.data&&v.data.id?e.updateAngle(v):null,S=m?e.convertToArcData(m):null,P=(S==null?void 0:S.id)||void 0;e.callOverOutForTouch(S),ln(P)?l():s(this,S,P)})}},redrawArcText(t){const e=this,{config:n,state:a,$el:{main:i,arcs:o}}=e,s=e.hasType("gauge"),l=e.hasMultiArcGauge();let c;if(s&&e.data.targets.length===1&&n.gauge_title||(c=i.selectAll(`.${Ve.chartArc}`).select("text").style("opacity","0").attr("class",f=>e.isGaugeType(f.data)?Un.gaugeValue:null).call(e.textForArcLabel.bind(e)).attr("transform",f=>e.transformForArcLabel.bind(e)(f)).style("font-size",f=>e.isGaugeType(f.data)&&e.data.targets.length===1&&!l?`${Math.round(a.radius/5)}px`:null).transition().duration(t).style("opacity",f=>e.isTargetToShow(f.data.id)&&e.isArcType(f.data)?null:"0"),l&&c.attr("dy","-.1em")),i.select(`.${Ve.chartArcsTitle}`).style("opacity",e.hasType("donut")||s?null:"0"),s){const f=n.gauge_fullCircle;f&&(c==null||c.attr("dy",`${l?0:Math.round(a.radius/14)}`)),n.gauge_label_show&&(o.select(`.${Un.chartArcsGaugeUnit}`).attr("dy",`${f?1.5:.75}em`).text(n.gauge_units),o.select(`.${Un.chartArcsGaugeMin}`).attr("dx",`${-1*(a.innerRadius+(a.radius-a.innerRadius)/(f?1:2))}px`).attr("dy","1.2em").text(e.textForGaugeMinMax(n.gauge_min,!1)),!f&&o.select(`.${Un.chartArcsGaugeMax}`).attr("dx",`${a.innerRadius+(a.radius-a.innerRadius)/2}px`).attr("dy","1.2em").text(e.textForGaugeMinMax(n.gauge_max,!0)))}},getArcElementByIdOrIndex(t){const e=this,{$el:{arcs:n}}=e,a=he(t)?i=>i.index===t:i=>i.data.id===t;return n==null?void 0:n.selectAll(`.${Se.target} path`).filter(a)}};function ju(t){return t[0]}function Vu(t){return t[1]}function Gu(t,e){var n=Le(!0),a=null,i=gs,o=null,s=Es(l);t=typeof t=="function"?t:t===void 0?ju:Le(t),e=typeof e=="function"?e:e===void 0?Vu:Le(e);function l(c){var f,g=(c=$s(c)).length,v,m=!1,S;for(a==null&&(o=i(S=s())),f=0;f<=g;++f)!(f=S;--P)l.point(W[P],H[P]);l.lineEnd(),l.areaEnd()}w&&(W[m]=+t(L,m,v),H[m]=+e(L,m,v),l.point(a?+a(L,m,v):W[m],n?+n(L,m,v):H[m]))}if(X)return l=null,X+""||null}function g(){return Gu().defined(i).curve(s).context(o)}return f.x=function(v){return arguments.length?(t=typeof v=="function"?v:Le(+v),a=null,f):t},f.x0=function(v){return arguments.length?(t=typeof v=="function"?v:Le(+v),f):t},f.x1=function(v){return arguments.length?(a=v==null?null:typeof v=="function"?v:Le(+v),f):a},f.y=function(v){return arguments.length?(e=typeof v=="function"?v:Le(+v),n=null,f):e},f.y0=function(v){return arguments.length?(e=typeof v=="function"?v:Le(+v),f):e},f.y1=function(v){return arguments.length?(n=v==null?null:typeof v=="function"?v:Le(+v),f):n},f.lineX0=f.lineY0=function(){return g().x(t).y(e)},f.lineY1=function(){return g().x(t).y(n)},f.lineX1=function(){return g().x(a).y(e)},f.defined=function(v){return arguments.length?(i=typeof v=="function"?v:Le(!!v),f):i},f.curve=function(v){return arguments.length?(s=v,o!=null&&(l=s(o)),f):s},f.context=function(v){return arguments.length?(v==null?o=l=null:l=s(o=v),f):o},f}var sa={initArea(t){const e=this,{config:n}=e;t.insert("g",`.${n.area_front?$n.circles:ur.lines}`).attr("class",e.getClass("areas",!0))},updateAreaColor(t){const e=this;return e.config.area_linearGradient?e.getGradienColortUrl(t.id):e.color(t)},updateArea(t,e=!1){const n=this,{config:a,state:i,$el:o,$T:s}=n,l=e?o.subchart:o;a.area_linearGradient&&n.updateLinearGradient();const c=l.main.selectAll(`.${ti.areas}`).selectAll(`.${ti.area}`).data(n.lineData.bind(n));s(c.exit(),t).style("opacity","0").remove(),l.area=c.enter().append("path").attr("class",n.getClass("area",!0)).style("fill",n.updateAreaColor.bind(n)).style("opacity",function(){return i.orgAreaOpacity=ot(this).style("opacity"),"0"}).merge(c),c.style("opacity",i.orgAreaOpacity),n.setRatioForGroupedData(l.area.data())},redrawArea(t,e,n=!1){const a=this,{area:i}=n?this.$el.subchart:this.$el,{orgAreaOpacity:o}=a.state;return[a.$T(i,e,gr()).attr("d",t).style("fill",a.updateAreaColor.bind(a)).style("opacity",s=>String(a.isAreaRangeType(s)?o/1.75:o))]},generateDrawArea(t,e){const n=this,{config:a}=n,i=a.line_connectNull,o=a.axis_rotated,s=n.generateGetAreaPoints(t,e),l=n.getYScaleById.bind(n),c=v=>(e?n.subxx:n.xx).call(n,v),f=(v,m)=>n.isGrouped(v.id)?s(v,m)[0][1]:l(v.id,e)(n.isAreaRangeType(v)?n.getRangedData(v,"high"):n.getShapeYMin(v.id)),g=(v,m)=>n.isGrouped(v.id)?s(v,m)[1][1]:l(v.id,e)(n.isAreaRangeType(v)?n.getRangedData(v,"low"):v.value);return v=>{let m=i?n.filterRemoveNull(v.values):v.values,S=0,P=0,N;if(n.isAreaType(v)){let L=mx();L=o?L.y(c).x0(f).x1(g):L.x(c).y0(a.area_above?0:a.area_below?n.state.height:f).y1(g),i||(L=L.defined(w=>n.getBaseValue(w)!==null)),n.isStepType(v)&&(m=n.convertValuesToStep(m)),N=L.curve(n.getCurve(v))(m)}else m[0]&&(S=n.scale.x(m[0].x),P=n.getYScaleById(v.id)(m[0].value)),N=o?`M ${P} ${S}`:`M ${S} ${P}`;return N||"M 0 0"}},generateGetAreaPoints(t,e){const n=this,{config:a}=n,i=n.getShapeX(0,t,e),o=n.getShapeY(!!e),s=n.getShapeOffset(n.isAreaType,t,e),l=n.getYScaleById.bind(n);return function(c,f){const g=l.call(n,c.id,e)(n.getShapeYMin(c.id)),v=s(c,f)||g,m=i(c),S=c.value;let P=o(c);return a.axis_rotated&&(S>0&&Pg.values.some(v=>he(v.value)||e.isBarRangeType(v)))).attr("class",g=>i(g)+s(g)).enter().append("g").attr("class",i).style("opacity","0").style("pointer-events",e.getStylePropValue("none")).append("g").attr("class",o).style("cursor",g=>{var v;return(v=l==null?void 0:l.bind)!=null&&v.call(l,e.api)(g)?"pointer":null}).call(e.setCssRule(!0,` .${Kn.bar}`,["fill"],e.color))},updateBar(t,e=!1){const n=this,{config:a,$el:i,$T:o}=n,s=e?i.subchart:i,l=n.getClass("bar",!0),c=n.initialOpacity.bind(n);a.bar_linearGradient&&n.updateLinearGradient();const f=s.main.selectAll(`.${Kn.bars}`).selectAll(`.${Kn.bar}`).data(n.labelishData.bind(n));o(f.exit(),t).style("opacity","0").remove(),s.bar=f.enter().append("path").attr("class",l).style("fill",n.updateBarColor.bind(n)).merge(f).style("opacity",c),n.setRatioForGroupedData(s.bar.data())},updateBarColor(t){const e=this,n=e.getStylePropValue(e.color);return e.config.bar_linearGradient?e.getGradienColortUrl(t.id):n?n(t):null},redrawBar(t,e,n=!1){const a=this,{bar:i}=n?a.$el.subchart:a.$el;return[a.$T(i,e,gr()).attr("d",o=>(he(o.value)||a.isBarRangeType(o))&&t(o)).style("fill",a.updateBarColor.bind(a)).style("clip-path",o=>o.clipPath).style("opacity",null)]},generateDrawBar(t,e){const n=this,{config:a}=n,i=n.generateGetBarPoints(t,e),o=a.axis_rotated,s=a.bar_radius,l=a.bar_radius_ratio,c=he(s)&&s>0?()=>s:he(l)?f=>f*l:null;return(f,g)=>{const v=i(f,g),m=+o,S=+!m,P=f.value<0,N=a[`axis_${n.axis.getId(f.id)}_inverted`],L=!N&&P||N&&!P,w=["",""],X=n.isGrouped(f.id),W=c&&X?n.isStackingRadiusData(f):!1,H=[v[0][m],v[0][S]];let k=0;if(f.clipPath=null,c){const ht=o?S:m,$t=v[2][ht]-v[0][ht];k=!X||W?c($t):0;const dt=`a${k} ${k} ${L?"1 0 0":"0 0 1"} `;w[+!o]=`${dt}${k},${k}`,w[+o]=`${dt}${[-k,k][o?"sort":"reverse"]()}`,L&&w.reverse()}const K=o?v[1][m]+(L?k:-k):v[1][S]+(L?-k:k);if(k){let ht="";o?L&&H[0]K&&(ht=`0 0 0 ${H[0]-K}px`):L&&H[1]>K?ht=`${H[1]-K}px 0 0 0`:!L&&H[1]-1){const m=n.bar.filter(S=>S.id===s&&S.value===c);return!m.empty()&&/a\d+/i.test(m.attr("d"))}const f=a.data_groups.find(m=>m.indexOf(s)>-1),v=e.orderTargets(e.filterTargetsToShow(i.targets.filter(e.isBarType,e))).filter(m=>f.indexOf(m.id)>-1).map(m=>m.values.filter(S=>S.index===l&&(he(c)&&c>0?S.value>0:S.value<0))[0]).filter(Boolean).map(m=>m.id);return c!==0&&v.indexOf(s)===v.length-1},generateGetBarPoints(t,e){const n=this,{config:a}=n,i=e?n.axis.subX:n.axis.x,o=n.getIndicesMax(t)+1,s=n.getBarW("bar",i,o),l=n.getShapeX(s,t,!!e),c=n.getShapeY(!!e),f=n.getShapeOffset(n.isBarType,t,!!e),g=n.getYScaleById.bind(n);return(v,m)=>{const{id:S}=v,P=g.call(n,S,e)(n.getShapeYMin(S)),N=f(v,m)||P,L=he(s)?s:s[v.id]||s._$width,w=a[`axis_${n.axis.getId(S)}_inverted`],X=v.value,W=l(v);let H=c(v);a.axis_rotated&&!w&&(X>0&&He.isBubbleZType(s)?e.getBubbleZData(s.value,"y"):Be(s.value)?s.value.mid:s.value)),i=n*n*Math.PI,o=(e.isBubbleZType(t)?e.getBubbleZData(t.value,"z"):t.value)*(i/a);return Math.sqrt(o/Math.PI)},getBubbleZData(t,e){return Be(t)?t[e]:t[e==="y"?0:1]}},Tx=Object.defineProperty,Xu=Object.getOwnPropertySymbols,$x=Object.prototype.hasOwnProperty,Sx=Object.prototype.propertyIsEnumerable,Hu=(t,e,n)=>e in t?Tx(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,Ax=(t,e)=>{for(var n in e||(e={}))$x.call(e,n)&&Hu(t,n,e[n]);if(Xu)for(var n of Xu(e))Sx.call(e,n)&&Hu(t,n,e[n]);return t},Ex={initCandlestick(){const{$el:t}=this;t.candlestick=t.main.select(`.${Se.chart}`).append("g").attr("class",cr.chartCandlesticks)},updateTargetsForCandlestick(t){const e=this,{$el:n}=e,a=e.getChartClass("Candlestick");n.candlestick||e.initCandlestick(),e.$el.main.select(`.${cr.chartCandlesticks}`).selectAll(`.${cr.chartCandlestick}`).data(t).enter().append("g").attr("class",a).style("pointer-events","none")},updateCandlestick(t,e=!1){const n=this,{$el:a,$T:i}=n,o=e?a.subchart:a,s=n.getClass("candlestick",!0),l=n.initialOpacity.bind(n),c=o.main.selectAll(`.${cr.chartCandlestick}`).selectAll(`.${cr.candlestick}`).data(n.labelishData.bind(n));i(c.exit(),t).style("opacity","0").remove();const f=c.enter().filter(g=>g.value).append("g").attr("class",s);f.append("line"),f.append("path"),o.candlestick=c.merge(f).style("opacity",l)},generateDrawCandlestick(t,e){const n=this,{config:a}=n,i=n.generateGetCandlestickPoints(t,e),o=a.axis_rotated,s=a.candlestick_color_down;return(l,c,f)=>{const g=i(l,c),v=n.getCandlestickData(l),m=v==null?void 0:v._isUp,S=+o,P=+!S;f.classed&&f.classed(cr[m?"valueUp":"valueDown"],!0);const N=o?`H${g[1][1]} V${g[1][0]} H${g[0][1]}`:`V${g[1][1]} H${g[1][0]} V${g[0][1]}`;f.select("path").attr("d",`M${g[0][S]},${g[0][P]}${N}z`).style("fill",X=>(m?n.color(X):Be(s)?s[X.id]:s)||n.color(X));const L=f.select("line"),w=o?{x1:g[2][1],x2:g[2][2],y1:g[2][0],y2:g[2][0]}:{x1:g[2][0],x2:g[2][0],y1:g[2][1],y2:g[2][2]};for(const X in w)L.attr(X,w[X])}},generateGetCandlestickPoints(t,e=!1){const n=this,a=e?n.axis.subX:n.axis.x,i=n.getIndicesMax(t)+1,o=n.getBarW("candlestick",a,i),s=n.getShapeX(o,t,!!e),l=n.getShapeY(!!e),c=n.getShapeOffset(n.isBarType,t,!!e),f=n.getYScaleById.bind(n);return(g,v)=>{const m=f.call(n,g.id,e)(n.getShapeYMin(g.id)),S=c(g,v)||m,P=he(o)?o:o[g.id]||o._$width,N=n.getCandlestickData(g);let L;if(N&&he(N.open)&&he(N.close)){const w={start:s(g),end:0};w.end=w.start+P;const X={start:l(N.open),end:l(N.close)},W={x:w.start+P/2,high:l(N.high),low:l(N.low)};X.start-=m-S,L=[[w.start,X.start],[w.end,X.end],[W.x,W.low,W.high]]}else L=[[0,0],[0,0],[0,0,0]];return L}},redrawCandlestick(t,e,n=!1){const a=this,{$el:i,$T:o}=a,{candlestick:s}=n?i.subchart:i,l=gr(!0);return[s.each(function(c,f){const g=o(ot(this),e,l);t(c,f,g)}).style("opacity",null)]},getCandlestickData({value:t}){let e;if(je(t)){const[n,a,i,o,s=!1]=t;e={open:n,high:a,low:i,close:o},s!==!1&&(e.volume=s)}else Be(t)&&(e=Ax({},t));return e&&(e._isUp=e.close>=e.open),e||null}},bx=Object.defineProperty,Yu=Object.getOwnPropertySymbols,Rx=Object.prototype.hasOwnProperty,Ix=Object.prototype.propertyIsEnumerable,Wu=(t,e,n)=>e in t?bx(t,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):t[e]=n,Ox=(t,e)=>{for(var n in e||(e={}))Rx.call(e,n)&&Wu(t,n,e[n]);if(Yu)for(var n of Yu(e))Ix.call(e,n)&&Wu(t,n,e[n]);return t};function Zi(t=!1){const e=this,{config:n,state:{current:{width:a,height:i}}}=e,o=e.getCurrentPadding(),s=Ox({width:a-(o.left+o.right),height:i-(n.legend_show?e.getLegendHeight()+10:0)-(o.top+o.bottom)},o);if(t){const{width:l,height:c}=Ku.call(e,{width:s.width,height:s.height});s.width{let l=o;return Be(o)&&(l=t[s?"height":"width"]*o.ratio),l}),{width:a,height:i}}function Cx(t){const e=this,{top:n,left:a,width:i}=Zi.call(e,!0),o=[];return t.forEach((s,l)=>{const{ratio:c}=s,f=l>0?o[l-1][2][1]:n;o.push(s.coords=[[a,f],[a+i,f],[a+i,l>0?c+f:c+n],[a,l>0?c+f:c+n],[a,f]])}),o}function Zu(t=!1){const e=this,{width:n,height:a,top:i,left:o}=Zi.call(e,!0),s=Ku.call(e,{width:n,height:a}),l=(n-s.width)/2,c=(n+s.width)/2,f=a-s.height,g=[[0,0],[n,0],[c,f],[c,a],[l,a],[l,f],[0,0]];return t&&g.forEach(v=>{v[0]+=o,v[1]+=i}),`M${g.join("L")}z`}function Px(t){const e=this,{config:n}=e,a=t.map(i=>({id:i.id,value:i.values.reduce((o,s)=>o+s.value,0)}));return n.data_order&&a.sort(e.getSortCompareFn.bind(e)(!0)),Ju.call(e,a)}function Ju(t){const e=this,{height:n}=Zi.call(e),a=e.getTotalDataSum(!0);return t.forEach(i=>{i.ratio=i.value/a*n}),t}var wx={initFunnel(){const t=this,{$el:e}=t;e.funnel=e.main.select(`.${Se.chart}`).append("g").classed(Ta.chartFunnels,!0),e.funnel.background=e.funnel.append("path").classed(Ta.funnelBackground,!0),t.bindFunnelEvent()},bindFunnelEvent(){const t=this,{$el:{funnel:e},config:n,state:a}=t,i=o=>{var s;const l=o.isTrusted?o.target:(s=a.eventReceiver.rect)==null?void 0:s.node();let c;return/^path$/i.test(l.tagName)&&(a.event=o,c=ot(l).datum()),c};if(n.interaction_enabled){const o=a.inputType==="touch";e.on(o?"touchstart":"mouseover mousemove",s=>{const l=i(s);l&&(t.showTooltip([l],s.target),/^(touchstart|mouseover)$/.test(s.type)&&t.setOverOut(!0,l))}).on(o?"touchend":"mouseout",s=>{const l=i(s);n.interaction_onout&&(t.hideTooltip(),t.setOverOut(!1,l))})}},updateTargetsForFunnel(t){const e=this,{$el:{funnel:n}}=e,a=e.getChartClass("Funnel"),i=e.getClass("funnel",!0);n||e.initFunnel();const o=Px.call(e,t.filter(e.isFunnelType.bind(e))),s=n.selectAll(`.${Ta.chartFunnel}`).data(o);s.exit().remove();const l=s.enter().insert("g",`.${Ta.funnelBackground}`);l.append("path"),n.path=l.merge(s).attr("class",c=>a(c)).select("path").attr("class",i).style("opacity","0").style("fill",e.color)},updateFunnel(t){const e=this,{$el:{funnel:n}}=e,a=t.map(({id:i})=>i);n.path=n.path.filter(i=>a.indexOf(i.id)>=0)},generateGetFunnelPoints(){const t=this,{$el:{funnel:e}}=t,n=t.filterTargetsToShow(e.path),{top:a,left:i,right:o}=Zi.call(t),s=(i-o)/2,l={};let c=a!=null?a:0;return n.each((f,g)=>{var v;l[f.id]=[[s,c],[s,c+=((v=n==null?void 0:n[g])!=null?v:f).ratio]]}),f=>l[f.id]},redrawFunnel(){const t=this,{$T:e,$el:{funnel:n}}=t,a=t.filterTargetsToShow(n.path),i=Cx.call(t,Ju.call(t,a.data()));n.attr("clip-path",`path('${Zu.bind(t)()}')`),n.background.attr("d",Zu.call(t,!0)),e(a).attr("d",(o,s)=>`M${i[s].join("L")}z`).style("opacity","1"),n.selectAll("g").style("opacity",null)}},Mx={initGauge(){const t=this,{config:e,$el:{arcs:n}}=t,a=(i=null,o="")=>{n.append("text").attr("class",i).style("text-anchor","middle").style("pointer-events","none").text(o)};if(t.hasType("gauge")){const i=t.hasMultiArcGauge();n.append(i?"g":"path").attr("class",Ve.chartArcsBackground).style("fill",!i&&e.gauge_background||null),e.gauge_units&&a(Un.chartArcsGaugeUnit),e.gauge_label_show&&(a(Un.chartArcsGaugeMin),!e.gauge_fullCircle&&a(Un.chartArcsGaugeMax))}},updateGaugeMax(){const t=this,{config:e,state:n}=t,i=t.hasMultiArcGauge()?t.getMinMaxData().max[0].value:t.getTotalDataSum(n.rendered);!e.gauge_enforceMinMax&&i+e.gauge_min*(e.gauge_min>0?-1:1)>e.gauge_max&&(e.gauge_max=i-e.gauge_min)},redrawArcGaugeLine(){const t=this,{config:e,state:n,$el:a}=t,{hiddenTargetIds:i}=t.state,o=a.main.selectAll(`.${Ve.arcs}`).selectAll(`.${Ve.arcLabelLine}`).data(t.arcData.bind(t));o.enter().append("rect").attr("class",l=>`${Ve.arcLabelLine} ${Se.target} ${Se.target}-${l.data.id}`).merge(o).style("fill",l=>t.levelColor?t.levelColor(l.data.values[0].value):t.color(l.data)).style("display",e.gauge_label_show?null:"none").each(function(l){let c=0;const f=2;let g=0,v=0,m="";if(i.indexOf(l.data.id)<0){const S=t.updateAngle(l),P=n.gaugeArcWidth/t.filterTargetsToShow(t.data.targets).length*(S.index+1),N=S.endAngle-Math.PI/2,L=n.radius-P,w=N-(L===0?0:1/L);c=n.radiusExpanded-n.radius+P,g=Math.cos(w)*L,v=Math.sin(w)*L,m=`rotate(${N*180/Math.PI}, ${g}, ${v})`}ot(this).attr("x",g).attr("y",v).attr("width",c).attr("height",f).attr("transform",m).style("stroke-dasharray",`0, ${c+f}, 0`)})},textForGaugeMinMax(t,e){const n=this,{config:a}=n,i=a.gauge_label_extents;return ve(i)?i.bind(n.api)(t,e):t},getGaugeLabelHeight(){const{config:t}=this;return this.config.gauge_label_show&&!t.gauge_fullCircle?20:0},getPaddingBottomForGauge(){const t=this;return t.getGaugeLabelHeight()*(t.config.gauge_label_show?2:2.5)}};function Dx(t,e,n,a=!1){const i=t?[t,0]:n;for(let o=t||n.reduce((s,l)=>s+l);o<=e;)n.forEach(s=>{o+s<=e&&i.push(s),o+=s});return i.length%2!==0&&i.push(a?n[1]:0),{dash:i.join(" "),length:i.reduce((o,s)=>o+s,0)}}function Lx(t,e,n){const a=this,i=[],o="2 2";if(Qe(e)){const s=(l,c)=>ln(l)?c:n?Yn.call(a,l):l;for(let l=0,c;c=e[l];l++){const f=s(c.start,t[0].x),g=s(c.end,t[t.length-1].x),v=c.style||{dasharray:o};i[l]={start:f,end:g,style:v}}}return i}var Nx={initLine(){const{$el:t}=this;t.line=t.main.select(`.${Se.chart}`).append("g").attr("class",ur.chartLines).call(this.setCssRule(!1,`.${ur.chartLines}`,["pointer-events:none"]))},updateTargetsForLine(t){const e=this,{$el:{area:n,line:a,main:i}}=e,o=e.getChartClass("Line"),s=e.getClass("lines",!0),l=e.classFocus.bind(e);a||e.initLine();const c=t.filter(v=>!(e.isScatterType(v)||e.isBubbleType(v))),f=i.select(`.${ur.chartLines}`).selectAll(`.${ur.chartLine}`).data(c).attr("class",v=>o(v)+l(v)),g=f.enter().append("g").attr("class",o).style("opacity","0").style("pointer-events",e.getStylePropValue("none"));if(g.append("g").attr("class",s),e.hasTypeOf("Area")){const v=(!n&&g.empty()?f:g).filter(e.isAreaType.bind(e));e.initArea(v)}e.updateTargetForCircle(c,g)},updateLine(t,e=!1){const n=this,{format:{extraLineClasses:a},$el:i,$T:o}=n,s=e?i.subchart:i,l=s.main.selectAll(`.${ur.lines}`).selectAll(`.${ur.line}`).data(n.lineData.bind(n));o(l.exit(),t).style("opacity","0").remove(),s.line=l.enter().append("path").attr("class",c=>`${n.getClass("line",!0)(c)} ${a(c)||""}`).style("stroke",n.color).merge(l).style("opacity",n.initialOpacity.bind(n)).attr("transform",null)},redrawLine(t,e,n=!1){const a=this,{$el:i,$T:o}=a,{line:s}=n?i.subchart:i;return[o(s,e,gr()).attr("d",t).style("stroke",this.color).style("opacity",null)]},getCurve(t){const e=this;return e.config.axis_rotated&&e.isStepType(t)?a=>{const i=e.getInterpolate(t)(a);return i.orgPoint=i.point,i.pointRotated=function(o,s){this._point===1&&(this._point=2);const l=this._y*(1-this._t)+s*this._t;this._context.lineTo(this._x,l),this._context.lineTo(o,l),this._x=o,this._y=s},i.point=function(o,s){this._point===0?this.orgPoint(o,s):this.pointRotated(o,s)},i}:e.getInterpolate(t)},generateDrawLine(t,e){const n=this,{config:a,scale:i}=n,o=a.line_connectNull,s=a.axis_rotated,l=n.generateGetLinePoints(t,e),c=n.getYScaleById.bind(n),f=S=>(e?n.subxx:n.xx).call(n,S),g=(S,P)=>n.isGrouped(S.id)?l(S,P)[0][1]:c(S.id,e)(n.getBaseValue(S));let v=Gu();v=s?v.x(g).y(f):v.x(f).y(g),o||(v=v.defined(S=>n.getBaseValue(S)!==null));const m=e?i.subX:i.x;return S=>{const P=c(S.id,e);let N=o?n.filterRemoveNull(S.values):S.values,L=0,w=0,X;if(n.isLineType(S)){const W=a.data_regions[S.id];W?X=n.lineWithRegions(N,i.zoom||m,P,W):(n.isStepType(S)&&(N=n.convertValuesToStep(N)),X=v.curve(n.getCurve(S))(N))}else N[0]&&(L=m(N[0].x),w=P(N[0].value)),X=s?`M ${w} ${L}`:`M ${L} ${w}`;return X||"M 0 0"}},lineWithRegions(t,e,n,a){const i=this,{config:o}=i,s=o.axis_rotated,l=i.axis.isTimeSeries(),c="2 2",f=Lx.bind(i)(t,a,l),g=i.hasNullDataValue(t);let v,m,S,P;const N=s?dt=>n(dt.value):dt=>e(dt.x),L=s?dt=>e(dt.x):dt=>n(dt.value),w=dt=>`M${dt[0][0]},${dt[0][1]}L${dt[1][0]},${dt[1][1]}`,X=l?(dt,st,Vt,vt)=>{const Q=dt.x.getTime(),St=st.x-dt.x,ct=new Date(Q+St*Vt),At=new Date(Q+St*(Vt+vt)),Gt=s?[[n(m(Vt)),e(ct)],[n(m(Vt+S)),e(At)]]:[[e(ct),n(m(Vt))],[e(At),n(m(Vt+S))]];return w(Gt)}:(dt,st,Vt,vt)=>{const Q=e(st.x,!s),St=n(st.value,s),ct=Vt+vt,At=e(v(Vt),!s),Gt=n(m(Vt),s);let Bt=e(v(ct),!s),Kt=n(m(ct),s);Bt>Q&&(Bt=Q),dt.value>st.value&&(s?KtSt)&&(Kt=St);const ne=[[At,Gt],[Bt,Kt]];return s&&ne.forEach(le=>le.reverse()),w(ne)},W={x:i.axis.getAxisType("x"),y:i.axis.getAxisType("y")};let H="";const k=i.$el.line.filter(({id:dt})=>dt===t[0].id),K=k.clone().style("display","none"),at=(dt,st)=>dt.attr("d",st).node().getTotalLength(),ht={dash:[],lastLength:0};let $t=!1;for(let dt=0,st;st=t[dt];dt++){const Vt=t[dt-1],vt=Vt&&De(Vt.value);let Q=i.isWithinRegions(st.x,f);if(De(st.value)){if(ln(f)||!Q||!vt)H+=`${dt&&vt?"L":"M"}${N(st)},${L(st)}`;else if(vt)if(Q=((Q==null?void 0:Q.dasharray)||c).split(" ").map(Number),v=zr(W.x,Vt.x,st.x),m=zr(W.y,Vt.value,st.value),g){const St=e(st.x)-e(Vt.x),ct=n(st.value)-n(Vt.value),At=Math.sqrt(Math.pow(St,2)+Math.pow(ct,2));S=Q[0]/At,P=S*Q[1];for(let Gt=S;Gt<=1;Gt+=P)H+=X(Vt,st,Gt,S),Gt+P>=1&&(H+=X(Vt,st,1,0))}else{let St=[];if($t=st.x===t[t.length-1].x,l){const Bt=+Vt.x,Kt=new Date(Bt),ne=new Date(Bt+(+st.x-Bt));St=[[e(Kt),n(m(0))],[e(ne),n(m(1))]]}else St=[[e(v(0)),n(m(0))],[e(v(1)),n(m(1))]];s&&St.forEach(Bt=>Bt.reverse());const ct=at(K,H),At=at(K,H+=`L${St[1].join(",")}`),Gt=Dx(ct-ht.lastLength,At-ht.lastLength,Q,$t);ht.lastLength+=Gt.length,ht.dash.push(Gt.dash)}}}return ht.dash.length&&(!$t&&ht.dash.push(at(K,H)),K.remove(),k.attr("stroke-dasharray",ht.dash.join(" "))),H},isWithinRegions(t,e){for(let n=0,a;a=e[n];n++)if(a.startgr();var Ji={initialOpacityForCircle(t){const{config:e,state:{withoutFadeIn:n}}=this;let a=e.point_opacity;return ln(a)&&(a=this.getBaseValue(t)!==null&&n[t.id]?this.opacityForCircle(t):"0"),a},opacityForCircle(t){var e;const{config:n}=this;let a=n.point_opacity;return ln(a)&&(a=n.point_show&&!((e=this.isPointFocusOnly)!=null&&e.call(this))?null:"0",a=De(this.getBaseValue(t))?this.isBubbleType(t)||this.isScatterType(t)?"0.5":a:"0"),a},initCircle(){const t=this,{$el:{main:e}}=t;!t.point&&(t.point=t.generatePoint()),(t.hasType("bubble")||t.hasType("scatter"))&&e.select(`.${Se.chart} > .${$n.chartCircles}`).empty()&&e.select(`.${Se.chart}`).append("g").attr("class",$n.chartCircles)},updateTargetForCircle(t,e){const n=this,{config:a,data:i,$el:o}=n,s=a.interaction_enabled&&a.data_selection_enabled,l=s&&a.data_selection_isselectable,c=n.getClass("circles",!0);if(!a.point_show)return;n.initCircle();let f=t,g=e;if(!f){f=i.targets.filter(m=>this.isScatterType(m)||this.isBubbleType(m));const v=o.main.select(`.${$n.chartCircles}`).style("pointer-events","none").selectAll(`.${$n.circles}`).data(f);v.exit().remove(),g=v.enter()}s&&g.append("g").attr("class",v=>n.generateClass(tn.selectedCircles,v.id)),g.append("g").attr("class",c).call(v=>{n.setCssRule(!0,`.${$n.circles}`,["cursor:pointer"],l)(v),n.setCssRule(!0,` .${$n.circle}`,["fill","stroke"],n.color)(v)}).style("opacity",function(){return ot(this.parentNode).attr("class").indexOf($n.chartCircles)>-1?"0":null}),s&&f.forEach(v=>{o.main.selectAll(`.${tn.selectedCircles}${n.getTargetSelectorSuffix(v.id)}`).selectAll(`${tn.selectedCircle}`).each(m=>{m.value=v.values[m.index].value})})},updateCircle(t=!1){const e=this,{config:n,state:a,$el:i}=e,o=e.isPointFocusOnly(),s=t?i.subchart:i;if(n.point_show&&!a.toggling){n.point_radialGradient&&e.updateLinearGradient();const l=s.main.selectAll(`.${$n.circles}`).selectAll(`.${$n.circle}`).data(c=>e.isLineType(c)&&e.shouldDrawPointsForLine(c)||e.isBubbleType(c)||e.isRadarType(c)||e.isScatterType(c)?o?[c.values[0]]:c.values:[]);l.exit().remove(),l.enter().filter(Boolean).append(e.point("create",this,e.pointR.bind(e),e.updateCircleColor.bind(e))),s.circle=s.main.selectAll(`.${$n.circles} .${$n.circle}`).style("stroke",e.getStylePropValue(e.color)).style("opacity",e.initialOpacityForCircle.bind(e))}},updateCircleColor(t){const e=this,n=e.getStylePropValue(e.color);return e.config.point_radialGradient?e.getGradienColortUrl(t.id):n?n(t):null},redrawCircle(t,e,n,a,i=!1){const o=this,{state:{rendered:s},$el:l,$T:c}=o,f=i?l.subchart:l,g=f.main.selectAll(`.${tn.selectedCircle}`);if(!o.config.point_show)return[];const v=o.point("update",o,t,e,o.updateCircleColor.bind(o),n,a,g),m=o.isCirclePoint()?"c":"",S=gr(),P=o.opacityForCircle.bind(o),N=[];return f.circle.each(function(L){let w=v.bind(this)(L);w=c(w,n||!s,S).style("opacity",P),N.push(w)}),[N,c(g,n).attr(`${m}x`,t).attr(`${m}y`,e)]},showCircleFocus(t){const e=this,{state:{hasRadar:n,resizing:a,toggling:i,transiting:o},$el:s}=e;let{circle:l}=s;if(o===!1&&l&&e.isPointFocusOnly()){const c=(n?e.radarCircleX:e.circleX).bind(e),f=(n?e.radarCircleY:e.circleY).bind(e),g=i||ln(t),v=e.point("update",e,c,f,e.getStylePropValue(e.color),a?!1:g);t&&(l=l.filter(function(m){var S;const P=(S=t.filter)==null?void 0:S.call(t,N=>N.id===m.id);return P.length?ot(this).datum(P[0]):!1})),l.attr("class",this.updatePointClass.bind(this)).style("opacity",null).each(function(m){const{id:S,index:P,value:N}=m;let L="hidden";De(N)&&(v.bind(this)(m),e.expandCircles(P,S),L=""),this.style.visibility=L})}},hideCircleFocus(){const t=this,{$el:{circle:e}}=t;t.isPointFocusOnly()&&e&&(t.unexpandCircles(),e.style("visibility","hidden"))},circleX(t){return this.xx(t)},updateCircleY(t=!1){const e=this,n=e.generateGetLinePoints(e.getShapeIndices(e.isLineType),t);return(a,i)=>{const o=a.id;return e.isGrouped(o)?n(a,i)[0][1]:e.getYScaleById(o,t)(e.getBaseValue(a))}},expandCircles(t,e,n){const a=this,i=a.pointExpandedR.bind(a);n&&a.unexpandCircles();const o=a.getShapeByIndex("circle",t,e).classed(Se.EXPANDED,!0),s=i(o)/a.config.point_r,l=1-s;a.isCirclePoint()?o.attr("r",i):o.each(function(){const c=ot(this);if(this.tagName==="circle")c.attr("r",i);else{const{width:f,height:g}=this.getBBox(),v=l*(+c.attr("x")+f/2),m=l*(+c.attr("y")+g/2);c.attr("transform",`translate(${v} ${m}) scale(${s})`)}})},unexpandCircles(t){const e=this,n=e.pointR.bind(e),a=e.getShapeByIndex("circle",t).filter(function(){return ot(this).classed(Se.EXPANDED)}).classed(Se.EXPANDED,!1);if(a.attr("r",n),!e.isCirclePoint()){const i=n(a)/e.config.point_r;a.attr("transform",i!==1?`scale(${i})`:null)}},pointR(t){const e=this,{config:n}=e,a=n.point_r;let i=a;return e.isBubbleType(t)?i=e.getBubbleR(t):ve(a)&&(i=a.bind(e.api)(t)),t.r=i,i},pointExpandedR(t){const e=this,{config:n}=e,a=e.isBubbleType(t)?1.15:1.75;return n.point_focus_expand_enabled?n.point_focus_expand_r||e.pointR(t)*a:e.pointR(t)},pointSelectR(t){const e=this,n=e.config.point_select_r;return ve(n)?n(t):n||e.pointR(t)*4},isPointFocusOnly(){const t=this;return t.config.point_focus_only&&!t.hasType("bubble")&&!t.hasType("scatter")&&!t.hasArcType(null,["radar"])},isWithinCircle(t,e){const{state:n}=this,a=Hn(n.event,t),i=ot(t),o=this.isCirclePoint(t)?"c":"",s=this.getPointSensitivity(i==null?void 0:i.datum());let l=+i.attr(`${o}x`),c=+i.attr(`${o}y`);if(!(l||c)&&t.nodeType===1){const{x:f,y:g}=Ma(t);l=f,c=g}return Math.sqrt(Math.pow(l-a[0],2)+Math.pow(c-a[1],2))<(e||s)},getPointSensitivity(t){const e=this;let n=e.config.point_sensitivity;if(t)ve(n)?n=n.call(e.api,t):n==="radius"&&(n=t.r);else return n;return n},updatePointClass(t){const e=this,{circle:n}=e.$el;let a=!1;return(Be(t)||n)&&(a=t===!0?n.each(function(i){let o=e.getClass("circle",!0)(i);this.getAttribute("class").indexOf(Se.EXPANDED)>-1&&(o+=` ${Se.EXPANDED}`),this.setAttribute("class",o)}):e.getClass("circle",!0)(t)),a},generateGetLinePoints(t,e){const n=this,{config:a}=n,i=n.getShapeX(0,t,e),o=n.getShapeY(e),s=n.getShapeOffset(n.isLineType,t,e),l=n.getYScaleById.bind(n);return(c,f)=>{const g=l.call(n,c.id,e)(n.getShapeYMin(c.id)),v=s(c,f)||g,m=i(c);let S=o(c);a.axis_rotated&&(c.value>0&&SDe(S.value)?e(S)-c/2:0,v=S=>De(S.value)?n(S)-f/2:0;let m=t;return i&&(o&&m.attr("x",g),m=l.$T(m,i,la()),s&&l.$T(s,i,la())),m.attr("x",g).attr("y",v).style("fill",a)}},circle:{create(t,e,n){return t.append("circle").attr("class",this.updatePointClass.bind(this)).attr("r",e).style("fill",n).node()},update(t,e,n,a,i,o,s){const l=this;let c=t;return l.hasType("bubble")&&c.attr("r",l.pointR.bind(l)),i&&(o&&c.attr("cx",e),c.attr("cx")&&(c=l.$T(c,i,la())),s&&l.$T(c,i,la())),c.attr("cx",e).attr("cy",n).style("fill",a)}},rectangle:{create(t,e,n){const a=i=>e(i)*2;return t.append("rect").attr("class",this.updatePointClass.bind(this)).attr("width",a).attr("height",a).style("fill",n).node()},update(t,e,n,a,i,o,s){const l=this,c=l.config.point_r,f=m=>e(m)-c,g=m=>n(m)-c;let v=t;return i&&(o&&v.attr("x",f),v=l.$T(v,i,la()),s&&l.$T(s,i,la())),v.attr("x",f).attr("y",g).style("fill",a)}}};function Fx(t){return nr(t)&&ve(t.create)&&ve(t.update)}function Bx(t,e){var n;const a=this,i=(c,f)=>{const g=c.attributes;for(let v=0,m;m=g[v];v++)m=m.name,f.setAttribute(m,c.getAttribute(m))},s=new DOMParser().parseFromString(t,"image/svg+xml").documentElement,l=gn.createElementNS(ae.svg,s.nodeName.toLowerCase());if(l.id=e,l.style.fill="inherit",l.style.stroke="inherit",i(s,l),(n=s.childNodes)!=null&&n.length){const c=ot(l);"innerHTML"in l?c.html(s.innerHTML):Lr(s.childNodes).forEach(f=>{i(f,c.append(f.tagName).node())})}a.$el.defs.node().appendChild(l)}var ca={hasValidPointType(t){return/^(circle|rect(angle)?|polygon|ellipse|use)$/i.test(t||this.config.point_type)},hasLegendDefsPoint(){var t;const{config:e}=this;return e.legend_show&&((t=e.point_pattern)==null?void 0:t.length)&&e.legend_usePoint},getDefsPointId(t){const{state:{datetimeId:e}}=this;return`${e}-point${t}`},generatePoint(){const t=this,{$el:e,config:n}=t,a=[],i=cn(n.point_pattern)?n.point_pattern:[n.point_type];return function(o,s,...l){return function(c){var f,g,v,m;const S=t.getTargetSelectorSuffix(c.id||((f=c.data)==null?void 0:f.id)||c),P=ot(this);a.indexOf(S)<0&&a.push(S);let N=i[a.indexOf(S)%i.length];if(t.hasValidPointType(N))N=t[N];else if(!Fx(N||n.point_type)){const L=t.getDefsPointId(S);if(e.defs.select(`#${L}`).size()<1&&Bx.bind(t)(N,L),o==="create")return(g=t.custom)==null?void 0:g.create.bind(s)(P,L,...l);if(o==="update")return(v=t.custom)==null?void 0:v.update.bind(s)(P,...l)}return(m=N[o])==null?void 0:m.bind(s)(P,...l)}}}};function Qu(t){const e=t.config.polar_level_max;let n=t.getMinMaxData().max[0].value;return e&&e>n&&(n=e),n}var Ux={initPolar(){const t=this,{$el:{arcs:e},config:n}=t,a=n.polar_level_text_show,i=n.polar_level_text_backgroundColor;e.levels=e.append("g").attr("class",Tr.levels),a&&i&&t.generateTextBGColorFilter(i)},getPolarOuterRadius(t,e){var n;const a=Qu(this);return((n=t==null?void 0:t.data.values[0].value)!=null?n:0)/a*e},updateTargetsForPolar(t){this.updateTargetsForArc(t)},redrawPolar(){const t=this,{config:e}=t;e.polar_level_show&&t.updatePolarLevel()},updatePolarLevel(){const t=this,{config:e,state:n,$el:{arcs:{levels:a}}}=t,i=e.polar_level_depth,o=Qu(t),s=Ei(0,i),l=n.radius,c=s.map(m=>l*((m+1)/i)),f=(e.polar_level_text_format||function(){}).bind(t.api),g=a.selectAll(`.${Tr.level}`).data(s);g.exit().remove();const v=g.enter().append("g").attr("class",(m,S)=>`${Tr.level} ${Tr.level}-${S}`);if(v.append("circle"),v.merge(g).selectAll("circle").style("visibility",e.polar_level_show?null:"hidden").attr("cx",0).attr("cy",0).attr("r",m=>c[m]),e.polar_level_text_show){const m=e.polar_level_text_backgroundColor,S=`#${n.datetimeId}-labels-bg${t.getTargetSelectorSuffix(m)}`;v.append("text").style("text-anchor","middle"),v.merge(g).selectAll("text").attr("dy",P=>-c[P]+5).attr("filter",m?`url(${S})`:null).text(P=>f(o/s.length*(P+1)))}}};function zx(t,e,n,a,i,o){const s=t&&a>0?n-a:a,l=2*Math.PI;return i*(1-o*(e==="x"?Math.sin:Math.cos)(s*l/n))}const ua=Ln.radarPoints,ku=Ln.radarTextWidth;var jx={initRadar(){const t=this,{config:e,state:{current:n},$el:a}=t;t.hasType("radar")&&(a.radar=a.main.select(`.${Se.chart}`).append("g").attr("class",Qs.chartRadars),a.radar.levels=a.radar.append("g").attr("class",Tr.levels),a.radar.axes=a.radar.append("g").attr("class",Tn.axis),a.radar.shapes=a.radar.append("g").attr("class",sn.shapes),n.dataMax=e.radar_axis_max||t.getMinMaxData().max[0].value,e.radar_axis_text_show&&(e.interaction_enabled&&t.bindRadarEvent(),t.updateRadarLevel(),t.updateRadarAxes()))},getRadarSize(){const t=this,{config:e,state:{arcWidth:n,arcHeight:a}}=t,i=e.axis_x_categories.length<4?-20:10,o=(Math.min(n,a)-i)/2;return[o,o]},updateTargetsForRadar(t){const e=this,{config:n}=e;qn(n.axis_x_categories)&&(n.axis_x_categories=Ei(0,_n("max",t.map(a=>a.values.length)))),e.generateRadarPoints()},getRadarPosition(t,e,n,a){const i=this,{config:o}=i,[s,l]=i.getRadarSize(),c=o.axis_x_categories.length,f=o.radar_direction_clockwise,g=Lr(t).map(v=>zx(f,v,c,e,Qe(n)?n:t==="x"?s:l,he(a)?a:o.radar_size_ratio));return g.length===1?g[0]:g},generateRadarPoints(){const t=this,e=t.data.targets,[n,a]=t.getRadarSize(),i=t.cache.get(ua)||{},o=i._size;(!o||o.width!==n&&o.height!==a)&&(e.forEach(s=>{i[s.id]=s.values.map((l,c)=>t.getRadarPosition(["x","y"],c,void 0,t.getRatio("radar",l)))}),i._size={width:n,height:a},t.cache.add(ua,i))},redrawRadar(){const t=this,{radar:e,main:n}=t.$el,a=t.getTranslate("radar");a&&(e.attr("transform",a),n.select(`.${On.chartTexts}`).attr("transform",a),t.generateRadarPoints(),t.updateRadarLevel(),t.updateRadarAxes(),t.updateRadarShape())},generateGetRadarPoints(){const t=this.cache.get(ua);return(e,n)=>{const a=t[e.id][n];return[a,a,a,a]}},updateRadarLevel(){const t=this,{config:e,state:n,$el:{radar:a}}=t,[i,o]=t.getRadarSize(),s=e.radar_level_depth,l=e.axis_x_categories.length,c=e.radar_level_text_show,f=a.levels,g=Ei(0,s),v=e.radar_size_ratio*Math.min(i,o),m=g.map(w=>v*((w+1)/s)),S=(e.radar_level_text_format||function(){}).bind(t.api),P=g.map(w=>{const X=m[w];return Ei(0,l).map(H=>t.getRadarPosition(["x","y"],H,X,1).join(",")).join(" ")}),N=f.selectAll(`.${Tr.level}`).data(g);N.exit().remove();const L=N.enter().append("g").attr("class",(w,X)=>`${Tr.level} ${Tr.level}-${X}`);L.append("polygon").style("visibility",e.radar_level_show?null:"hidden"),c&&(f.select("text").empty()&&f.append("text").attr("dx","-.5em").attr("dy","-.7em").style("text-anchor","end").text(()=>S(0)),L.append("text").attr("dx","-.5em").style("text-anchor","end").text(w=>S(n.current.dataMax/g.length*(w+1)))),L.merge(N).attr("transform",w=>`translate(${i-m[w]}, ${o-m[w]})`).selectAll("polygon").attr("points",w=>P[w]),c&&f.selectAll("text").attr("x",w=>ln(w)?i:P[w].split(",")[0]).attr("y",w=>ln(w)?o:0)},updateRadarAxes(){const t=this,{config:e,$el:{radar:n}}=t,[a,i]=t.getRadarSize(),o=e.axis_x_categories;let s=n.axes.selectAll("g").data(o);s.exit().remove();const l=s.enter().append("g").attr("class",(c,f)=>`${Tn.axis}-${f}`);if(e.radar_axis_line_show&&l.append("line"),e.radar_axis_text_show&&l.append("text"),s=l.merge(s),e.radar_axis_line_show&&s.select("line").attr("x1",a).attr("y1",i).attr("x2",(c,f)=>t.getRadarPosition("x",f)).attr("y2",(c,f)=>t.getRadarPosition("y",f)),e.radar_axis_text_show){const{x:c=0,y:f=0}=e.radar_axis_text_position,g=t.cache.get(ku)||0;if(s.select("text").style("text-anchor","middle").attr("dy",".5em").call(v=>{v.each(function(m){wa(ot(this),String(m),[-.6,1.2])})}).datum((v,m)=>({index:m})).attr("transform",function(v){ln(this.width)&&(this.width=this.getBoundingClientRect().width/2);let m=t.getRadarPosition("x",v.index,void 0,1),S=Math.round(t.getRadarPosition("y",v.index,void 0,1));return m>a?m+=this.width+c:Math.round(m)i?(S/2===i&&this.firstChild.tagName==="tspan"&&this.firstChild.setAttribute("dy","0em"),S+=f):SYl(m.node()).width);v.every(m=>m>0)&&t.cache.add(ku,v[0]-v[1])}}},bindRadarEvent(){const t=this,{config:e,state:n,$el:{radar:a,svg:i}}=t,o=t.isPointFocusOnly(),{inputType:s,transiting:l}=n,c=s==="mouse",f=g=>{if(n.event=g,!e.interaction_onout)return;const v=t.getDataIndexFromEvent(g),m=ln(v);(c||m)&&(t.hideTooltip(),o?t.hideCircleFocus():t.unexpandCircles(),c?t.setOverOut(!1,v):m&&t.callOverOutForTouch())};a.axes.on(c?"mouseover ":"touchstart",g=>{if(l)return;n.event=g;const v=t.getDataIndexFromEvent(g);t.selectRectForSingle(i.node(),v),c?t.setOverOut(!0,v):t.callOverOutForTouch(v)}).on("mouseout",c?f:null),c||i.on("touchstart",f)},updateRadarShape(){const t=this,e=t.data.targets.filter(o=>t.isRadarType(o)),n=t.cache.get(ua),a=t.$el.radar.shapes.selectAll("polygon").data(e),i=a.enter().append("g").attr("class",t.getChartClass("Radar"));t.$T(a.exit()).remove(),i.append("polygon").merge(a).style("fill",t.color).style("stroke",t.color).attr("points",o=>n[o.id].join(" ")),t.updateTargetForCircle(e,i)},radarCircleX(t){return this.cache.get(ua)[t.id][t.index][0]},radarCircleY(t){return this.cache.get(ua)[t.id][t.index][1]}};function Vx(t){var e=0,n=t.children,a=n&&n.length;if(!a)e=1;else for(;--a>=0;)e+=n[a].value;t.value=e}function Gx(){return this.eachAfter(Vx)}function Xx(t,e){let n=-1;for(const a of this)t.call(e,a,++n,this);return this}function Hx(t,e){for(var n=this,a=[n],i,o,s=-1;n=a.pop();)if(t.call(e,n,++s,this),i=n.children)for(o=i.length-1;o>=0;--o)a.push(i[o]);return this}function Yx(t,e){for(var n=this,a=[n],i=[],o,s,l,c=-1;n=a.pop();)if(i.push(n),o=n.children)for(s=0,l=o.length;s=0;)n+=a[i].value;e.value=n})}function Zx(t){return this.eachBefore(function(e){e.children&&e.children.sort(t)})}function Jx(t){for(var e=this,n=Qx(e,t),a=[e];e!==n;)e=e.parent,a.push(e);for(var i=a.length;t!==n;)a.splice(i,0,t),t=t.parent;return a}function Qx(t,e){if(t===e)return t;var n=t.ancestors(),a=e.ancestors(),i=null;for(t=n.pop(),e=a.pop();t===e;)i=t,t=n.pop(),e=a.pop();return i}function kx(){for(var t=this,e=[t];t=t.parent;)e.push(t);return e}function qx(){return Array.from(this)}function _x(){var t=[];return this.eachBefore(function(e){e.children||t.push(e)}),t}function t0(){var t=this,e=[];return t.each(function(n){n!==t&&e.push({source:n.parent,target:n})}),e}function*e0(){var t=this,e,n=[t],a,i,o;do for(e=n.reverse(),n=[];t=e.pop();)if(yield t,a=t.children)for(i=0,o=a.length;i=0;--l)i.push(o=s[l]=new Qi(s[l])),o.parent=a,o.depth=a.depth+1;return n.eachBefore(o0)}function n0(){return Rs(this).eachBefore(i0)}function r0(t){return t.children}function a0(t){return Array.isArray(t)?t[1]:null}function i0(t){t.data.value!==void 0&&(t.value=t.data.value),t.data=t.data.data}function o0(t){var e=0;do t.height=e;while((t=t.parent)&&t.height<++e)}function Qi(t){this.data=t,this.depth=this.height=0,this.parent=null}Qi.prototype=Rs.prototype={constructor:Qi,count:Gx,each:Xx,eachAfter:Yx,eachBefore:Hx,find:Wx,sum:Kx,sort:Zx,path:Jx,ancestors:kx,descendants:qx,leaves:_x,links:t0,copy:n0,[Symbol.iterator]:e0};function s0(t){t.x0=Math.round(t.x0),t.y0=Math.round(t.y0),t.x1=Math.round(t.x1),t.y1=Math.round(t.y1)}function ki(t,e,n,a,i){for(var o=t.children,s,l=-1,c=o.length,f=t.value&&(a-e)/t.value;++lX&&(X=f),K=L*L*k,W=Math.max(X/K,K/w),W>H){L-=f;break}H=W}s.push(c={value:L,dice:S1?a:1)},n}(qu);function C1(t){return t==null?null:ef(t)}function ef(t){if(typeof t!="function")throw new Error;return t}function ja(){return 0}function Va(t){return function(){return t}}function l0(){var t=tf,e=!1,n=1,a=1,i=[0],o=ja,s=ja,l=ja,c=ja,f=ja;function g(m){return m.x0=m.y0=0,m.x1=n,m.y1=a,m.eachBefore(v),i=[0],e&&m.eachBefore(s0),m}function v(m){var S=i[m.depth],P=m.x0+S,N=m.y0+S,L=m.x1-S,w=m.y1-S;L=m-1){var X=o[v];X.x0=P,X.y0=N,X.x1=L,X.y1=w;return}for(var W=f[v],H=S/2+W,k=v+1,K=m-1;k>>1;f[at]w-N){var dt=S?(P*$t+L*ht)/S:L;g(v,k,ht,P,N,dt,w),g(k,m,$t,dt,N,L,w)}else{var st=S?(N*$t+w*ht)/S:w;g(v,k,ht,P,N,L,st),g(k,m,$t,P,st,L,w)}}}function c0(t,e,n,a,i){(t.depth&1?qi:ki)(t,e,n,a,i)}var u0=function t(e){function n(a,i,o,s,l){if((c=a._squarify)&&c.ratio===e)for(var c,f,g,v,m=-1,S,P=c.length,N=a.value;++m1?a:1)},n}(qu);function f0(t,e){const n=this,{scale:{x:a,y:i},state:{width:o}}=n;t.selectAll("g").attr("transform",s=>`translate(${s===e?"0,0":`${a(s.x0)},${i(s.y0)}`})`).select("rect").attr("width",s=>s===e?o:a(s.x1)-a(s.x0)).attr("height",s=>s===e?0:i(s.y1)-i(s.y0))}function d0(t){const e=this;return t.map(n=>{const{id:a,values:i}=n,{value:o}=i[0];return{name:a,id:a,value:o,ratio:e.getRatio("treemap",i[0])}})}function h0(t){const e=this,n=Rs(t).sum(i=>i.value),a=e.getSortCompareFn(!0);return[e.treemap(a?n.sort(a):n)]}var g0={initTreemap(){const t=this,{$el:e,state:{current:{width:n,height:a},clip:i,datetimeId:o}}=t;i.id=`${o}-clip`,t.treemap=l0().tile(t.getTreemapTile()),e.defs.append("clipPath").attr("id",i.id).append("rect").attr("width",n).attr("height",a),e.treemap=e.main.select(`.${Se.chart}`).attr("clip-path",`url(#${i.id})`).append("g").classed(qs.chartTreemaps,!0),t.bindTreemapEvent()},bindTreemapEvent(){const t=this,{$el:e,config:n,state:a}=t,i=o=>{var s;const l=o.isTrusted?o.target:(s=a.eventReceiver.rect)==null?void 0:s.node();let c;return/^rect$/i.test(l.tagName)&&(a.event=o,c=ot(l).datum()),c==null?void 0:c.data};if(n.interaction_enabled){const o=a.inputType==="touch";e.treemap.on(o?"touchstart":"mouseover mousemove",s=>{const l=i(s);l&&(t.showTooltip([l],s.currentTarget),/^(touchstart|mouseover)$/.test(s.type)&&t.setOverOut(!0,l))}).on(o?"touchend":"mouseout",s=>{const l=i(s);n.interaction_onout&&(t.hideTooltip(),t.setOverOut(!1,l))})}},getTreemapTile(){var t,e;const n=this,{config:a,state:{current:{width:i,height:o}}}=n,s=(e={binary:nf,dice:ki,slice:qi,sliceDice:c0,squarify:tf,resquarify:u0}[(t=a.treemap_tile)!=null?t:"binary"])!=null?e:nf;return(l,c,f,g,v)=>{s(l,0,0,i,o);for(const m of l.children)m.x0=c+m.x0/i*(g-c),m.x1=c+m.x1/i*(g-c),m.y0=f+m.y0/o*(v-f),m.y1=f+m.y1/o*(v-f)}},getTreemapData(t){const e=this;return{name:"root",children:d0.bind(e)(e.filterTargetsToShow(t.filter(e.isTreemapType,e)))}},updateTargetsForTreemap(t){const e=this,{$el:{treemap:n}}=e,a=h0.call(e,e.getTreemapData(t!=null?t:e.data.targets));n.data(a)},updateTreemap(t){const e=this,{$el:n,$T:a}=e,i=n.treemap.datum(),o=e.getChartClass("Treemap"),s=e.getClass("treemap",!0),l=n.treemap.selectAll("g").data(i.children);a(l.exit(),t).style("opacity","0").remove(),l.enter().append("g").append("rect"),n.treemap.selectAll("g").attr("class",o).select("rect").attr("class",s).attr("fill",c=>e.color(c.data.name))},generateGetTreemapPoints(){const t=this,{$el:e,scale:{x:n,y:a}}=t,i={};return e.treemap.selectAll("g").each(o=>{i[o.data.name]=[[n(o.x0),a(o.y0)],[n(o.x1),a(o.y1)]]}),o=>i[o.id]},redrawTreemap(t){const e=this,{$el:n,state:{current:{width:a,height:i}}}=e;return n.defs.select("rect").attr("width",a).attr("height",i),[e.$T(n.treemap,t,gr()).call(f0.bind(e),n.treemap.datum())]},treemapDataLabelFormat(t){const e=this,{config:n}=e,{id:a,value:i}=t,o=n.treemap_label_format,s=e.getRatio("treemap",t),l=(s*100).toFixed(2),c=n.treemap_label_show&&e.meetsLabelThreshold(s,"treemap")?null:"0";return function(f){return f.style("opacity",c),ve(o)?o.bind(e.api)(i,s,a):`${a} -${l}%`}}},Xr={point_show:!0,point_r:2.5,point_radialGradient:!1,point_sensitivity:10,point_focus_expand_enabled:!0,point_focus_expand_r:void 0,point_focus_only:!1,point_opacity:void 0,point_pattern:[],point_select_r:void 0,point_type:"circle"},fa={area_above:!1,area_below:!1,area_front:!0,area_linearGradient:!1,area_zerobased:!0},v0={bar_front:!1,bar_indices_removeNull:!1,bar_label_threshold:0,bar_linearGradient:!1,bar_overlap:!1,bar_padding:0,bar_radius:void 0,bar_radius_ratio:void 0,bar_sensitivity:2,bar_width:void 0,bar_width_ratio:.6,bar_width_max:void 0,bar_zerobased:!0},p0={bubble_maxR:35,bubble_zerobased:!1},m0={candlestick_width:void 0,candlestick_width_ratio:.6,candlestick_width_max:void 0,candlestick_color_down:"red"},y0={line_connectNull:!1,line_step_type:"step",line_step_tooltipMatch:!1,line_zerobased:!1,line_classes:void 0,line_point:!0},x0={scatter_zerobased:!1},Is={spline_interpolation_type:"cardinal"},_i={arc_cornerRadius:0,arc_cornerRadius_ratio:0,arc_needle_show:!1,arc_needle_color:void 0,arc_needle_value:void 0,arc_needle_path:void 0,arc_needle_length:100,arc_needle_top_rx:0,arc_needle_top_ry:0,arc_needle_top_width:0,arc_needle_bottom_rx:1,arc_needle_bottom_ry:1,arc_needle_bottom_width:15,arc_needle_bottom_len:0,arc_rangeText_values:void 0,arc_rangeText_unit:"absolute",arc_rangeText_fixed:!1,arc_rangeText_format:void 0,arc_rangeText_position:void 0},T0={donut_label_show:!0,donut_label_format:void 0,donut_label_threshold:.05,donut_label_ratio:void 0,donut_width:void 0,donut_title:"",donut_expand:{},donut_expand_rate:.98,donut_expand_duration:50,donut_padAngle:0,donut_startingAngle:0},$0={funnel_neck_width:0,funnel_neck_height:0},S0={gauge_background:"",gauge_fullCircle:!1,gauge_label_show:!0,gauge_label_extents:void 0,gauge_label_format:void 0,gauge_label_ratio:void 0,gauge_label_threshold:0,gauge_enforceMinMax:!1,gauge_min:0,gauge_max:100,gauge_type:"single",gauge_startingAngle:-1*Math.PI/2,gauge_arcLength:100,gauge_title:"",gauge_units:void 0,gauge_width:void 0,gauge_arcs_minWidth:5,gauge_expand:{},gauge_expand_rate:.98,gauge_expand_duration:50},A0={pie_label_show:!0,pie_label_format:void 0,pie_label_ratio:void 0,pie_label_threshold:.05,pie_expand:{},pie_expand_rate:.98,pie_expand_duration:50,pie_innerRadius:0,pie_outerRadius:void 0,pie_padAngle:0,pie_padding:0,pie_startingAngle:0},E0={polar_label_show:!0,polar_label_format:void 0,polar_label_threshold:.05,polar_label_ratio:void 0,polar_level_depth:3,polar_level_max:void 0,polar_level_show:!0,polar_level_text_backgroundColor:"#fff",polar_level_text_format:t=>t%1===0?t:t.toFixed(2),polar_level_text_show:!0,polar_padAngle:0,polar_padding:0,polar_startingAngle:0},b0={radar_axis_max:void 0,radar_axis_line_show:!0,radar_axis_text_show:!0,radar_axis_text_position:{},radar_level_depth:3,radar_level_show:!0,radar_level_text_format:t=>t%1===0?t:t.toFixed(2),radar_level_text_show:!0,radar_size_ratio:.87,radar_direction_clockwise:!1},R0={treemap_tile:"binary",treemap_label_format:void 0,treemap_label_threshold:.05,treemap_label_show:!0};function da(t,e){yn(Vr.prototype,Object.values(Du).concat(t)),yn(Er.prototype,Jy),Nr.setOptions(Object.values(Lu).concat(e||[]))}function mr(t,e){da([ca,Ji,Nx].concat(t||[])),Nr.setOptions([Xr,y0].concat(e||[]))}function ha(t,e){yn(Vr.prototype,[px,ca].concat(t||[])),Nr.setOptions([Xr].concat(e||[]))}let rf=()=>(mr(sa,[fa]),(rf=()=>oe.AREA)()),af=()=>(mr(sa,[fa]),(af=()=>oe.AREA_LINE_RANGE)()),of=()=>(mr(sa,[fa]),(of=()=>oe.AREA_STEP_RANGE)()),sf=()=>(mr(sa,[fa,Is]),(sf=()=>oe.AREA_SPLINE)()),lf=()=>(mr(sa,[fa,Is]),(lf=()=>oe.AREA_SPLINE_RANGE)()),cf=()=>(mr(sa,[fa]),(cf=()=>oe.AREA_STEP)()),uf=()=>(mr(),(uf=()=>oe.LINE)()),ff=()=>(mr(void 0,[Is]),(ff=()=>oe.SPLINE)()),df=()=>(mr(),(df=()=>oe.STEP)()),hf=()=>(ha(void 0,[_i,T0]),(hf=()=>oe.DONUT)()),gf=()=>(ha([Mx],[_i,S0]),(gf=()=>oe.GAUGE)()),vf=()=>(ha(void 0,[_i,A0]),(vf=()=>oe.PIE)()),pf=()=>(ha([Ux],[_i,E0]),(pf=()=>oe.POLAR)()),mf=()=>(ha([Du.eventrect,Ji,jx],[Xr,b0,{axis_x_categories:Lu.optAxis.axis_x_categories}]),(mf=()=>oe.RADAR)()),yf=()=>(da([yx,ca],[v0,Xr]),(yf=()=>oe.BAR)()),xf=()=>(da([ca,Ji,xx],[p0,Xr]),(xf=()=>oe.BUBBLE)()),Tf=()=>(da([Ex,ca],[m0,Xr]),(Tf=()=>oe.CANDLESTICK)()),$f=()=>(da([ca,Ji],[Xr,x0]),($f=()=>oe.SCATTER)()),Sf=()=>(ha([wx],[$0]),(Sf=()=>oe.FUNNEL)()),Af=()=>(da([g0],[R0]),(Af=()=>oe.TREEMAP)()),Os=Object.create(null);const Ef={version:"3.15.1",generate(t){const e=ea(Object.create(null),Os,t),n=new Er(e);return n.internal.charts=this.instance,this.instance.push(n),n},defaults(t){return Be(t)&&(Os=t),Os},instance:[],plugin:{}};Object.keys(d).forEach(t=>d[t]()),Object.keys(u).forEach(t=>u[t]())}],Xa={};function zn(x){var b=Xa[x];if(b!==void 0)return b.exports;var r=Xa[x]={exports:{}};return Cs[x].call(r.exports,r,r.exports,zn),r.exports}(function(){zn.d=function(x,b){for(var r in b)zn.o(b,r)&&!zn.o(x,r)&&Object.defineProperty(x,r,{enumerable:!0,get:b[r]})}})(),function(){zn.o=function(x,b){return Object.prototype.hasOwnProperty.call(x,b)}}(),function(){zn.r=function(x){typeof Symbol!="undefined"&&Symbol.toStringTag&&Object.defineProperty(x,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(x,"__esModule",{value:!0})}}(),zn(0);var Ha=zn(584);return Ha}()}); diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Html/SyntaxHighlighter.php b/app/vendor/phpunit/php-code-coverage/src/Report/Html/SyntaxHighlighter.php new file mode 100644 index 000000000..9c592049c --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Html/SyntaxHighlighter.php @@ -0,0 +1,299 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Report\Html; + +use const ENT_COMPAT; +use const ENT_HTML401; +use const ENT_SUBSTITUTE; +use const T_ABSTRACT; +use const T_ARRAY; +use const T_AS; +use const T_BREAK; +use const T_CALLABLE; +use const T_CASE; +use const T_CATCH; +use const T_CLASS; +use const T_CLONE; +use const T_COMMENT; +use const T_CONST; +use const T_CONTINUE; +use const T_DECLARE; +use const T_DEFAULT; +use const T_DO; +use const T_DOC_COMMENT; +use const T_ECHO; +use const T_ELSE; +use const T_ELSEIF; +use const T_EMPTY; +use const T_ENDDECLARE; +use const T_ENDFOR; +use const T_ENDFOREACH; +use const T_ENDIF; +use const T_ENDSWITCH; +use const T_ENDWHILE; +use const T_ENUM; +use const T_EVAL; +use const T_EXIT; +use const T_EXTENDS; +use const T_FINAL; +use const T_FINALLY; +use const T_FN; +use const T_FOR; +use const T_FOREACH; +use const T_FUNCTION; +use const T_GLOBAL; +use const T_GOTO; +use const T_HALT_COMPILER; +use const T_IF; +use const T_IMPLEMENTS; +use const T_INCLUDE; +use const T_INCLUDE_ONCE; +use const T_INLINE_HTML; +use const T_INSTANCEOF; +use const T_INSTEADOF; +use const T_INTERFACE; +use const T_ISSET; +use const T_LIST; +use const T_MATCH; +use const T_NAMESPACE; +use const T_NEW; +use const T_PRINT; +use const T_PRIVATE; +use const T_PRIVATE_SET; +use const T_PROTECTED; +use const T_PROTECTED_SET; +use const T_PUBLIC; +use const T_PUBLIC_SET; +use const T_READONLY; +use const T_REQUIRE; +use const T_REQUIRE_ONCE; +use const T_RETURN; +use const T_STATIC; +use const T_SWITCH; +use const T_THROW; +use const T_TRAIT; +use const T_TRY; +use const T_UNSET; +use const T_USE; +use const T_VAR; +use const T_WHILE; +use const T_YIELD; +use const T_YIELD_FROM; +use const TOKEN_PARSE; +use function count; +use function explode; +use function file_get_contents; +use function htmlspecialchars; +use function is_string; +use function sprintf; +use function str_ends_with; +use function str_replace; +use function token_get_all; +use function trim; + +/** + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final class SyntaxHighlighter +{ + /** + * @var array + */ + private const array KEYWORD_TOKENS = [ + T_ABSTRACT => true, + T_ARRAY => true, + T_AS => true, + T_BREAK => true, + T_CALLABLE => true, + T_CASE => true, + T_CATCH => true, + T_CLASS => true, + T_CLONE => true, + T_CONST => true, + T_CONTINUE => true, + T_DECLARE => true, + T_DEFAULT => true, + T_DO => true, + T_ECHO => true, + T_ELSE => true, + T_ELSEIF => true, + T_EMPTY => true, + T_ENDDECLARE => true, + T_ENDFOR => true, + T_ENDFOREACH => true, + T_ENDIF => true, + T_ENDSWITCH => true, + T_ENDWHILE => true, + T_ENUM => true, + T_EVAL => true, + T_EXIT => true, + T_EXTENDS => true, + T_FINAL => true, + T_FINALLY => true, + T_FN => true, + T_FOR => true, + T_FOREACH => true, + T_FUNCTION => true, + T_GLOBAL => true, + T_GOTO => true, + T_HALT_COMPILER => true, + T_IF => true, + T_IMPLEMENTS => true, + T_INCLUDE => true, + T_INCLUDE_ONCE => true, + T_INSTANCEOF => true, + T_INSTEADOF => true, + T_INTERFACE => true, + T_ISSET => true, + T_LIST => true, + T_MATCH => true, + T_NAMESPACE => true, + T_NEW => true, + T_PRINT => true, + T_PRIVATE => true, + T_PRIVATE_SET => true, + T_PROTECTED => true, + T_PROTECTED_SET => true, + T_PUBLIC => true, + T_PUBLIC_SET => true, + T_READONLY => true, + T_REQUIRE => true, + T_REQUIRE_ONCE => true, + T_RETURN => true, + T_STATIC => true, + T_SWITCH => true, + T_THROW => true, + T_TRAIT => true, + T_TRY => true, + T_UNSET => true, + T_USE => true, + T_VAR => true, + T_WHILE => true, + T_YIELD => true, + T_YIELD_FROM => true, + ]; + + private const int HTML_SPECIAL_CHARS_FLAGS = ENT_COMPAT | ENT_HTML401 | ENT_SUBSTITUTE; + + /** + * @var array> + */ + private static array $cache = []; + + /** + * @param non-empty-string $file + * + * @return list + */ + public function highlight(string $file): array + { + if (isset(self::$cache[$file])) { + return self::$cache[$file]; + } + + $buffer = file_get_contents($file); + $tokens = token_get_all($buffer, TOKEN_PARSE); + $result = ['']; + $i = 0; + $stringFlag = false; + $fileEndsWithNewLine = str_ends_with($buffer, "\n"); + + unset($buffer); + + foreach ($tokens as $j => $token) { + if (is_string($token)) { + if ($token === '"' && $tokens[$j - 1] !== '\\') { + $result[$i] .= sprintf( + '%s', + htmlspecialchars($token, self::HTML_SPECIAL_CHARS_FLAGS), + ); + + $stringFlag = !$stringFlag; + } else { + $result[$i] .= sprintf( + '%s', + htmlspecialchars($token, self::HTML_SPECIAL_CHARS_FLAGS), + ); + } + + continue; + } + + [$token, $value] = $token; + + $value = str_replace( + ["\t", ' '], + ['    ', ' '], + htmlspecialchars($value, self::HTML_SPECIAL_CHARS_FLAGS), + ); + + if ($value === "\n") { + $result[++$i] = ''; + } else { + $lines = explode("\n", $value); + + foreach ($lines as $jj => $line) { + $line = trim($line); + + if ($line !== '') { + if ($stringFlag) { + $colour = 'string'; + } else { + $colour = 'default'; + + if ($this->isInlineHtml($token)) { + $colour = 'html'; + } elseif ($this->isComment($token)) { + $colour = 'comment'; + } elseif ($this->isKeyword($token)) { + $colour = 'keyword'; + } + } + + $result[$i] .= sprintf( + '%s', + $colour, + $line, + ); + } + + if (isset($lines[$jj + 1])) { + $result[++$i] = ''; + } + } + } + } + + if ($fileEndsWithNewLine) { + unset($result[count($result) - 1]); + } + + self::$cache[$file] = $result; + + return $result; + } + + private function isComment(int $token): bool + { + return $token === T_COMMENT || $token === T_DOC_COMMENT; + } + + private function isInlineHtml(int $token): bool + { + return $token === T_INLINE_HTML; + } + + private function isKeyword(int $token): bool + { + return isset(self::KEYWORD_TOKENS[$token]); + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/OpenClover.php b/app/vendor/phpunit/php-code-coverage/src/Report/OpenClover.php index 042132b33..394c71ead 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/OpenClover.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/OpenClover.php @@ -12,29 +12,35 @@ use function assert; use function basename; use function count; -use function dirname; -use function file_put_contents; use function is_string; use function ksort; use function max; use function range; -use function str_contains; use function str_replace; use function time; use DOMDocument; use DOMElement; -use SebastianBergmann\CodeCoverage\CodeCoverage; +use SebastianBergmann\CodeCoverage\Node\Directory; use SebastianBergmann\CodeCoverage\Node\File; +use SebastianBergmann\CodeCoverage\Util\EnsuresUtf8; use SebastianBergmann\CodeCoverage\Util\Filesystem; +use SebastianBergmann\CodeCoverage\Util\Xml; use SebastianBergmann\CodeCoverage\Version; use SebastianBergmann\CodeCoverage\WriteOperationFailedException; +/** + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ final class OpenClover { + use EnsuresUtf8; + /** * @throws WriteOperationFailedException */ - public function process(CodeCoverage $coverage, ?string $target = null, ?string $name = null): string + public function process(Directory $report, ?string $target = null, ?string $name = null): string { $time = (string) time(); @@ -50,14 +56,13 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string $xmlProject->setAttribute('timestamp', $time); if (is_string($name)) { - $xmlProject->setAttribute('name', $name); + $xmlProject->setAttribute('name', $this->ensureUtf8($name)); } $xmlCoverage->appendChild($xmlProject); /** @var array $packages */ $packages = []; - $report = $coverage->getReport(); foreach ($report as $item) { if (!$item instanceof File) { @@ -65,8 +70,8 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string } $xmlFile = $xmlDocument->createElement('file'); - $xmlFile->setAttribute('name', basename($item->pathAsString())); - $xmlFile->setAttribute('path', $item->pathAsString()); + $xmlFile->setAttribute('name', $this->ensureUtf8(basename($item->pathAsString()))); + $xmlFile->setAttribute('path', $this->ensureUtf8($item->pathAsString())); $classes = $item->classesAndTraits(); $coverageData = $item->lineCoverageData(); @@ -80,53 +85,53 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string $classMethods = 0; // Assumption: one namespace per file - if ($class['namespace'] !== '') { - $namespace = $class['namespace']; + if ($class->namespace !== '') { + $namespace = $class->namespace; } - foreach ($class['methods'] as $methodName => $method) { + foreach ($class->methods as $methodName => $method) { /** @phpstan-ignore equal.notAllowed */ - if ($method['executableLines'] == 0) { + if ($method->executableLines == 0) { continue; } $classMethods++; - $classStatements += $method['executableLines']; - $coveredClassStatements += $method['executedLines']; + $classStatements += $method->executableLines; + $coveredClassStatements += $method->executedLines; /** @phpstan-ignore equal.notAllowed */ - if ($method['coverage'] == 100) { + if ($method->coverage == 100) { $coveredMethods++; } $methodCount = 0; - foreach (range($method['startLine'], $method['endLine']) as $line) { + foreach (range($method->startLine, $method->endLine) as $line) { if (isset($coverageData[$line])) { $methodCount = max($methodCount, count($coverageData[$line])); } } - $lines[$method['startLine']] = [ - 'ccn' => $method['ccn'], + $lines[$method->startLine] = [ + 'ccn' => $method->ccn, 'count' => $methodCount, 'type' => 'method', - 'signature' => $method['signature'], - 'visibility' => $method['visibility'], + 'signature' => $method->signature, + 'visibility' => $method->visibility, ]; } $xmlClass = $xmlDocument->createElement('class'); - $xmlClass->setAttribute('name', str_replace($class['namespace'] . '\\', '', $className)); + $xmlClass->setAttribute('name', $this->ensureUtf8(str_replace($class->namespace . '\\', '', $className))); $xmlFile->appendChild($xmlClass); $xmlMetrics = $xmlDocument->createElement('metrics'); - $xmlMetrics->setAttribute('complexity', (string) $class['ccn']); - $xmlMetrics->setAttribute('elements', (string) ($classMethods + $classStatements + $class['executableBranches'])); - $xmlMetrics->setAttribute('coveredelements', (string) ($coveredMethods + $coveredClassStatements + $class['executedBranches'])); - $xmlMetrics->setAttribute('conditionals', (string) $class['executableBranches']); - $xmlMetrics->setAttribute('coveredconditionals', (string) $class['executedBranches']); + $xmlMetrics->setAttribute('complexity', (string) $class->ccn); + $xmlMetrics->setAttribute('elements', (string) ($classMethods + $classStatements + $class->executableBranches)); + $xmlMetrics->setAttribute('coveredelements', (string) ($coveredMethods + $coveredClassStatements + $class->executedBranches)); + $xmlMetrics->setAttribute('conditionals', (string) $class->executableBranches); + $xmlMetrics->setAttribute('coveredconditionals', (string) $class->executedBranches); $xmlMetrics->setAttribute('statements', (string) $classStatements); $xmlMetrics->setAttribute('coveredstatements', (string) $coveredClassStatements); $xmlMetrics->setAttribute('methods', (string) $classMethods); @@ -159,7 +164,7 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string $xmlLine->setAttribute('count', (string) $data['count']); if (isset($data['signature'])) { - $xmlLine->setAttribute('signature', $data['signature']); + $xmlLine->setAttribute('signature', $this->ensureUtf8($data['signature'])); } if (isset($data['visibility'])) { @@ -188,7 +193,7 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string if (!isset($packages[$namespace])) { $packages[$namespace] = $xmlDocument->createElement('package'); - $packages[$namespace]->setAttribute('name', $namespace); + $packages[$namespace]->setAttribute('name', $this->ensureUtf8($namespace)); $xmlPackageMetrics = $xmlDocument->createElement('metrics'); $xmlPackageMetrics->setAttribute('complexity', '0'); @@ -240,16 +245,10 @@ public function process(CodeCoverage $coverage, ?string $target = null, ?string $xmlMetrics->setAttribute('coveredmethods', (string) $report->numberOfTestedMethods()); $xmlProject->insertBefore($xmlMetrics, $xmlProject->firstChild); - $buffer = $xmlDocument->saveXML(); + $buffer = Xml::asString($xmlDocument); if ($target !== null) { - if (!str_contains($target, '://')) { - Filesystem::createDirectory(dirname($target)); - } - - if (@file_put_contents($target, $buffer) === false) { - throw new WriteOperationFailedException($target); - } + Filesystem::write($target, $buffer); } return $buffer; diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/PHP.php b/app/vendor/phpunit/php-code-coverage/src/Report/PHP.php deleted file mode 100644 index 051f9154e..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/Report/PHP.php +++ /dev/null @@ -1,42 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Report; - -use const PHP_EOL; -use function dirname; -use function file_put_contents; -use function serialize; -use function str_contains; -use SebastianBergmann\CodeCoverage\CodeCoverage; -use SebastianBergmann\CodeCoverage\Util\Filesystem; -use SebastianBergmann\CodeCoverage\WriteOperationFailedException; - -final class PHP -{ - public function process(CodeCoverage $coverage, ?string $target = null): string - { - $coverage->clearCache(); - - $buffer = " + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Report; + +use function sprintf; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final readonly class Summary +{ + /** + * @var non-negative-int + */ + private int $numberOfExecutableLines; + + /** + * @var non-negative-int + */ + private int $numberOfExecutedLines; + + /** + * @var non-negative-int + */ + private int $numberOfExecutableBranches; + + /** + * @var non-negative-int + */ + private int $numberOfExecutedBranches; + + /** + * @var non-negative-int + */ + private int $numberOfExecutablePaths; + + /** + * @var non-negative-int + */ + private int $numberOfExecutedPaths; + + /** + * @var non-negative-int + */ + private int $numberOfFilesWithoutBranchCoverageData; + + /** + * @param non-negative-int $numberOfExecutableLines + * @param non-negative-int $numberOfExecutedLines + * @param non-negative-int $numberOfExecutableBranches + * @param non-negative-int $numberOfExecutedBranches + * @param non-negative-int $numberOfExecutablePaths + * @param non-negative-int $numberOfExecutedPaths + * @param non-negative-int $numberOfFilesWithoutBranchCoverageData + */ + public function __construct(int $numberOfExecutableLines, int $numberOfExecutedLines, int $numberOfExecutableBranches, int $numberOfExecutedBranches, int $numberOfExecutablePaths, int $numberOfExecutedPaths, int $numberOfFilesWithoutBranchCoverageData = 0) + { + $this->numberOfExecutableLines = $numberOfExecutableLines; + $this->numberOfExecutedLines = $numberOfExecutedLines; + $this->numberOfExecutableBranches = $numberOfExecutableBranches; + $this->numberOfExecutedBranches = $numberOfExecutedBranches; + $this->numberOfExecutablePaths = $numberOfExecutablePaths; + $this->numberOfExecutedPaths = $numberOfExecutedPaths; + $this->numberOfFilesWithoutBranchCoverageData = $numberOfFilesWithoutBranchCoverageData; + } + + /** + * @return non-negative-int + */ + public function numberOfExecutableLines(): int + { + return $this->numberOfExecutableLines; + } + + /** + * @return non-negative-int + */ + public function numberOfExecutedLines(): int + { + return $this->numberOfExecutedLines; + } + + public function lineCoverageAsPercentage(): float + { + return $this->percentage($this->numberOfExecutedLines, $this->numberOfExecutableLines); + } + + public function hasBranchAndPathCoverage(): bool + { + return $this->numberOfExecutableBranches > 0; + } + + /** + * @return non-negative-int + */ + public function numberOfExecutableBranches(): int + { + return $this->numberOfExecutableBranches; + } + + /** + * @return non-negative-int + */ + public function numberOfExecutedBranches(): int + { + return $this->numberOfExecutedBranches; + } + + public function branchCoverageAsPercentage(): float + { + return $this->percentage($this->numberOfExecutedBranches, $this->numberOfExecutableBranches); + } + + /** + * @return non-negative-int + */ + public function numberOfExecutablePaths(): int + { + return $this->numberOfExecutablePaths; + } + + /** + * @return non-negative-int + */ + public function numberOfExecutedPaths(): int + { + return $this->numberOfExecutedPaths; + } + + public function pathCoverageAsPercentage(): float + { + return $this->percentage($this->numberOfExecutedPaths, $this->numberOfExecutablePaths); + } + + /** + * @return non-negative-int + */ + public function numberOfFilesWithoutBranchCoverageData(): int + { + return $this->numberOfFilesWithoutBranchCoverageData; + } + + /** + * @return non-empty-string + */ + public function asString(): string + { + $buffer = sprintf( + 'Lines: %01.2F%% (%d/%d)', + $this->lineCoverageAsPercentage(), + $this->numberOfExecutedLines, + $this->numberOfExecutableLines, + ); + + if ($this->hasBranchAndPathCoverage()) { + $buffer .= sprintf( + ', Branches: %01.2F%% (%d/%d)', + $this->branchCoverageAsPercentage(), + $this->numberOfExecutedBranches, + $this->numberOfExecutableBranches, + ); + + $buffer .= sprintf( + ', Paths: %01.2F%% (%d/%d)', + $this->pathCoverageAsPercentage(), + $this->numberOfExecutedPaths, + $this->numberOfExecutablePaths, + ); + } + + return $buffer; + } + + /** + * @param non-negative-int $fraction + * @param non-negative-int $total + */ + private function percentage(int $fraction, int $total): float + { + if ($total > 0) { + return ($fraction / $total) * 100; + } + + return 100.0; + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Text.php b/app/vendor/phpunit/php-code-coverage/src/Report/Text.php index f18820b70..8497be931 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Text.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Text.php @@ -17,20 +17,25 @@ use function sprintf; use function str_pad; use function strlen; -use SebastianBergmann\CodeCoverage\CodeCoverage; +use SebastianBergmann\CodeCoverage\Node\Directory; use SebastianBergmann\CodeCoverage\Node\File; use SebastianBergmann\CodeCoverage\Util\Percentage; -final class Text +/** + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final readonly class Text { private const string COLOR_GREEN = "\x1b[30;42m"; private const string COLOR_YELLOW = "\x1b[30;43m"; private const string COLOR_RED = "\x1b[37;41m"; private const string COLOR_HEADER = "\x1b[1;37;40m"; private const string COLOR_RESET = "\x1b[0m"; - private readonly Thresholds $thresholds; - private readonly bool $showUncoveredFiles; - private readonly bool $showOnlySummary; + private Thresholds $thresholds; + private bool $showUncoveredFiles; + private bool $showOnlySummary; public function __construct(Thresholds $thresholds, bool $showUncoveredFiles = false, bool $showOnlySummary = false) { @@ -39,12 +44,11 @@ public function __construct(Thresholds $thresholds, bool $showUncoveredFiles = f $this->showOnlySummary = $showOnlySummary; } - public function process(CodeCoverage $coverage, bool $showColors = false): string + public function process(Directory $report, bool $showColors = false): string { - $hasBranchCoverage = $coverage->getData(true)->functionCoverage() !== []; + $hasBranchCoverage = $report->numberOfExecutableBranches() > 0; $output = PHP_EOL . PHP_EOL; - $report = $coverage->getReport(); $colors = [ 'header' => '', @@ -141,7 +145,7 @@ public function process(CodeCoverage $coverage, bool $showColors = false): strin $report->numberOfExecutableLines(), ); - $padding = max(array_map('strlen', [$classes, $methods, $lines])); + $padding = max(array_map(strlen(...), [$classes, $methods, $lines])); if ($this->showOnlySummary) { $title = 'Code Coverage Report Summary:'; @@ -164,6 +168,17 @@ public function process(CodeCoverage $coverage, bool $showColors = false): strin if ($hasBranchCoverage) { $output .= $this->format($colors['paths'], $padding, $paths); $output .= $this->format($colors['branches'], $padding, $branches); + + $numFilesWithoutBranchCoverageData = $report->numberOfFilesWithoutBranchCoverageData(); + + if ($numFilesWithoutBranchCoverageData > 0) { + $output .= sprintf( + ' * %d %s not loaded during test execution and no branch/path data is available for %s' . PHP_EOL, + $numFilesWithoutBranchCoverageData, + $numFilesWithoutBranchCoverageData === 1 ? 'file was' : 'files were', + $numFilesWithoutBranchCoverageData === 1 ? 'it' : 'them', + ); + } } $output .= $this->format($colors['lines'], $padding, $lines); @@ -190,28 +205,28 @@ public function process(CodeCoverage $coverage, bool $showColors = false): strin $coveredMethods = 0; $classMethods = 0; - foreach ($class['methods'] as $method) { + foreach ($class->methods as $method) { /** @phpstan-ignore equal.notAllowed */ - if ($method['executableLines'] == 0) { + if ($method->executableLines == 0) { continue; } $classMethods++; - $classExecutableLines += $method['executableLines']; - $classExecutedLines += $method['executedLines']; - $classExecutableBranches += $method['executableBranches']; - $classExecutedBranches += $method['executedBranches']; - $classExecutablePaths += $method['executablePaths']; - $classExecutedPaths += $method['executedPaths']; + $classExecutableLines += $method->executableLines; + $classExecutedLines += $method->executedLines; + $classExecutableBranches += $method->executableBranches; + $classExecutedBranches += $method->executedBranches; + $classExecutablePaths += $method->executablePaths; + $classExecutedPaths += $method->executedPaths; /** @phpstan-ignore equal.notAllowed */ - if ($method['coverage'] == 100) { + if ($method->coverage == 100) { $coveredMethods++; } } $classCoverage[$className] = [ - 'namespace' => $class['namespace'], + 'namespace' => $class->namespace, 'className' => $className, 'methodsCovered' => $coveredMethods, 'methodCount' => $classMethods, diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Thresholds.php b/app/vendor/phpunit/php-code-coverage/src/Report/Thresholds.php index d1a81a260..7d181ac4d 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Thresholds.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Thresholds.php @@ -13,6 +13,8 @@ /** * @immutable + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Thresholds { diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/BuildInformation.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/BuildInformation.php index dba230123..a0ec38b44 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/BuildInformation.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/BuildInformation.php @@ -9,74 +9,42 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use function assert; -use function phpversion; use DateTimeImmutable; -use DOMElement; use SebastianBergmann\Environment\Runtime; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class BuildInformation { - private DOMElement $contextNode; - - public function __construct(DOMElement $contextNode) - { - $this->contextNode = $contextNode; - } - - public function setRuntimeInformation(Runtime $runtime): void - { - $runtimeNode = $this->nodeByName('runtime'); - - $runtimeNode->setAttribute('name', $runtime->getName()); - $runtimeNode->setAttribute('version', $runtime->getVersion()); - $runtimeNode->setAttribute('url', $runtime->getVendorUrl()); - - $driverNode = $this->nodeByName('driver'); - - if ($runtime->hasXdebug()) { - $driverNode->setAttribute('name', 'xdebug'); - $driverNode->setAttribute('version', phpversion('xdebug')); - } - - if ($runtime->hasPCOV()) { - $driverNode->setAttribute('name', 'pcov'); - $driverNode->setAttribute('version', phpversion('pcov')); - } - } - - public function setBuildTime(DateTimeImmutable $date): void - { - $this->contextNode->setAttribute('time', $date->format('D M j G:i:s T Y')); - } - - public function setGeneratorVersions(string $phpUnitVersion, string $coverageVersion): void - { - $this->contextNode->setAttribute('phpunit', $phpUnitVersion); - $this->contextNode->setAttribute('coverage', $coverageVersion); - } - - private function nodeByName(string $name): DOMElement - { - $node = $this->contextNode->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', - $name, - )->item(0); - - if ($node === null) { - $node = $this->contextNode->appendChild( - $this->contextNode->ownerDocument->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - $name, - ), - ); - } - - assert($node instanceof DOMElement); - - return $node; + public function __construct( + XMLWriter $xmlWriter, + Runtime $runtime, + DateTimeImmutable $buildDate, + string $phpUnitVersion, + string $coverageVersion, + string $driverExtensionName, + string $driverExtensionVersion, + ) { + $xmlWriter->startElement('build'); + $xmlWriter->writeAttribute('time', $buildDate->format('D M j G:i:s T Y')); + $xmlWriter->writeAttribute('phpunit', $phpUnitVersion); + $xmlWriter->writeAttribute('coverage', $coverageVersion); + + $xmlWriter->startElement('runtime'); + $xmlWriter->writeAttribute('name', $runtime->getName()); + $xmlWriter->writeAttribute('version', $runtime->getVersion()); + $xmlWriter->writeAttribute('url', $runtime->getVendorUrl()); + $xmlWriter->endElement(); + + $xmlWriter->startElement('driver'); + $xmlWriter->writeAttribute('name', $driverExtensionName); + $xmlWriter->writeAttribute('version', $driverExtensionVersion); + $xmlWriter->endElement(); + + $xmlWriter->endElement(); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Coverage.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Coverage.php index afb70a069..3f9a6f742 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Coverage.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Coverage.php @@ -9,57 +9,40 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use DOMElement; -use SebastianBergmann\CodeCoverage\ReportAlreadyFinalizedException; use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ -final class Coverage +final readonly class Coverage { - private readonly XMLWriter $writer; - private readonly DOMElement $contextNode; - private bool $finalized = false; - - public function __construct(DOMElement $context, string $line) - { - $this->contextNode = $context; - - $this->writer = new XMLWriter; - $this->writer->openMemory(); - $this->writer->startElementNs(null, $context->nodeName, 'https://schema.phpunit.de/coverage/1.0'); - $this->writer->writeAttribute('nr', $line); + private XMLWriter $xmlWriter; + private string $line; + + public function __construct( + XMLWriter $xmlWriter, + string $line + ) { + $this->xmlWriter = $xmlWriter; + $this->line = $line; } /** - * @throws ReportAlreadyFinalizedException + * @param list $tests */ - public function addTest(string $test): void + public function finalize(array $tests): void { - if ($this->finalized) { - // @codeCoverageIgnoreStart - throw new ReportAlreadyFinalizedException; - // @codeCoverageIgnoreEnd + $writer = $this->xmlWriter; + $writer->startElement('line'); + $writer->writeAttribute('nr', $this->line); + + foreach ($tests as $test) { + $writer->startElement('covered'); + $writer->writeAttribute('by', $test); + $writer->endElement(); } - - $this->writer->startElement('covered'); - $this->writer->writeAttribute('by', $test); - $this->writer->endElement(); - } - - public function finalize(): void - { - $this->writer->endElement(); - - $fragment = $this->contextNode->ownerDocument->createDocumentFragment(); - $fragment->appendXML($this->writer->outputMemory()); - - $this->contextNode->parentNode->replaceChild( - $fragment, - $this->contextNode, - ); - - $this->finalized = true; + $writer->endElement(); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Directory.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Directory.php index b712953ab..8e3e349b3 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Directory.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Directory.php @@ -11,6 +11,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class Directory extends Node { diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Facade.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Facade.php index ee2e8aa01..a0a3d64a9 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Facade.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Facade.php @@ -10,56 +10,61 @@ namespace SebastianBergmann\CodeCoverage\Report\Xml; use const DIRECTORY_SEPARATOR; -use const PHP_EOL; use function count; use function dirname; use function file_get_contents; -use function file_put_contents; use function is_array; use function is_dir; use function is_file; use function is_writable; -use function libxml_clear_errors; -use function libxml_get_errors; -use function libxml_use_internal_errors; use function sprintf; use function strlen; use function substr; use DateTimeImmutable; -use DOMDocument; use SebastianBergmann\CodeCoverage\CodeCoverage; +use SebastianBergmann\CodeCoverage\Data\ProcessedClassType; +use SebastianBergmann\CodeCoverage\Data\ProcessedFunctionType; +use SebastianBergmann\CodeCoverage\Data\ProcessedTraitType; use SebastianBergmann\CodeCoverage\Node\AbstractNode; use SebastianBergmann\CodeCoverage\Node\Directory as DirectoryNode; -use SebastianBergmann\CodeCoverage\Node\File; use SebastianBergmann\CodeCoverage\Node\File as FileNode; use SebastianBergmann\CodeCoverage\PathExistsButIsNotDirectoryException; -use SebastianBergmann\CodeCoverage\Util\Filesystem as DirectoryUtil; +use SebastianBergmann\CodeCoverage\Util\EnsuresUtf8; +use SebastianBergmann\CodeCoverage\Util\Filesystem; use SebastianBergmann\CodeCoverage\Version; use SebastianBergmann\CodeCoverage\WriteOperationFailedException; use SebastianBergmann\CodeCoverage\XmlException; use SebastianBergmann\Environment\Runtime; +use XMLWriter; /** - * @phpstan-import-type ProcessedClassType from File - * @phpstan-import-type ProcessedTraitType from File - * @phpstan-import-type ProcessedFunctionType from File * @phpstan-import-type TestType from CodeCoverage + * + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class Facade { + use EnsuresUtf8; + + public const string XML_NAMESPACE = 'https://schema.phpunit.de/coverage/1.0'; private string $target; private Project $project; - private readonly string $phpUnitVersion; + private readonly bool $includeSource; - public function __construct(string $version) + public function __construct(bool $includeSource = true) { - $this->phpUnitVersion = $version; + $this->includeSource = $includeSource; } /** + * @param non-empty-string $target + * @param array $tests + * * @throws XmlException */ - public function process(CodeCoverage $coverage, string $target): void + public function process(string $target, DirectoryNode $report, array $tests, ?Runtime $runtime = null, ?DateTimeImmutable $buildDate = null, ?string $phpUnitVersion = null, ?string $coverageVersion = null, ?string $driverExtensionName = null, ?string $driverExtensionVersion = null): void { if (substr($target, -1, 1) !== DIRECTORY_SEPARATOR) { $target .= DIRECTORY_SEPARATOR; @@ -68,25 +73,62 @@ public function process(CodeCoverage $coverage, string $target): void $this->target = $target; $this->initTargetDirectory($target); - $report = $coverage->getReport(); + $writer = new XMLWriter; + $writer->openUri($this->targetFilePath('index')); + $writer->setIndent(true); + $writer->setIndentString(' '); + + $this->project = new Project($writer, $report->name()); - $this->project = new Project( - $coverage->getReport()->name(), + $this->setBuildInformation( + $runtime, + $buildDate, + $phpUnitVersion, + $coverageVersion, + $driverExtensionName, + $driverExtensionVersion, ); - $this->setBuildInformation(); - $this->processTests($coverage->getTests()); + $this->project->startProject(); + $this->processTests($tests); $this->processDirectory($report, $this->project); - - $this->saveDocument($this->project->asDom(), 'index'); + $this->project->finalize(); } - private function setBuildInformation(): void + private function setBuildInformation(?Runtime $runtime, ?DateTimeImmutable $buildDate, ?string $phpUnitVersion, ?string $coverageVersion, ?string $driverExtensionName, ?string $driverExtensionVersion): void { - $buildNode = $this->project->buildInformation(); - $buildNode->setRuntimeInformation(new Runtime); - $buildNode->setBuildTime(new DateTimeImmutable); - $buildNode->setGeneratorVersions($this->phpUnitVersion, Version::id()); + if ($runtime === null) { + return; + } + + if ($buildDate === null) { + return; + } + + if ($phpUnitVersion === null) { + return; + } + + if ($coverageVersion === null) { + return; + } + + if ($driverExtensionName === null) { + $driverExtensionName = 'unknown'; + } + + if ($driverExtensionVersion === null) { + $driverExtensionVersion = 'unknown'; + } + + $this->project->buildInformation( + $runtime, + $buildDate, + $phpUnitVersion, + Version::id(), + $driverExtensionName, + $driverExtensionVersion, + ); } /** @@ -107,7 +149,7 @@ private function initTargetDirectory(string $directory): void // @codeCoverageIgnoreEnd } - DirectoryUtil::createDirectory($directory); + Filesystem::createDirectory($directory); } /** @@ -121,7 +163,10 @@ private function processDirectory(DirectoryNode $directory, Node $context): void $directoryName = '/'; } - $directoryObject = $context->addDirectory($directoryName); + $writer = $this->project->getWriter(); + $writer->startElement('directory'); + $writer->writeAttribute('name', $this->ensureUtf8($directoryName)); + $directoryObject = $context->addDirectory(); $this->setTotals($directory, $directoryObject->totals()); @@ -132,6 +177,7 @@ private function processDirectory(DirectoryNode $directory, Node $context): void foreach ($directory->files() as $node) { $this->processFile($node, $directoryObject); } + $writer->endElement(); } /** @@ -139,19 +185,27 @@ private function processDirectory(DirectoryNode $directory, Node $context): void */ private function processFile(FileNode $file, Directory $context): void { - $fileObject = $context->addFile( - $file->name(), - $file->id() . '.xml', - ); + $context->getWriter()->startElement('file'); + $context->getWriter()->writeAttribute('name', $this->ensureUtf8($file->name())); + $context->getWriter()->writeAttribute('href', $file->id() . '.xml'); + $context->getWriter()->writeAttribute('hash', $file->sha1()); + + $fileObject = $context->addFile(); $this->setTotals($file, $fileObject->totals()); + $context->getWriter()->endElement(); + $path = substr( $file->pathAsString(), strlen($this->project->projectSourceDirectory()), ); - $fileReport = new Report($path); + $writer = new XMLWriter; + $writer->openUri($this->targetFilePath($file->id())); + $writer->setIndent(true); + $writer->setIndentString(' '); + $fileReport = new Report($writer, $path, $file->sha1()); $this->setTotals($file, $fileReport->totals()); @@ -163,71 +217,89 @@ private function processFile(FileNode $file, Directory $context): void $this->processFunction($function, $fileReport); } + $fileReport->getWriter()->startElement('coverage'); + foreach ($file->lineCoverageData() as $line => $tests) { if (!is_array($tests) || count($tests) === 0) { continue; } $coverage = $fileReport->lineCoverage((string) $line); - - foreach ($tests as $test) { - $coverage->addTest($test); - } - - $coverage->finalize(); + $coverage->finalize($tests); } + $fileReport->getWriter()->endElement(); - $fileReport->source()->setSourceCode( - file_get_contents($file->pathAsString()), - ); + if ($this->includeSource) { + $fileReport->source()->setSourceCode( + file_get_contents($file->pathAsString()), + ); + } - $this->saveDocument($fileReport->asDom(), $file->id()); + $fileReport->finalize(); } - /** - * @param ProcessedClassType|ProcessedTraitType $unit - */ - private function processUnit(array $unit, Report $report): void + private function processUnit(ProcessedClassType|ProcessedTraitType $unit, Report $report): void { - if (isset($unit['className'])) { - $unitObject = $report->classObject($unit['className']); + if ($unit instanceof ProcessedClassType) { + $report->getWriter()->startElement('class'); + + $unitObject = $report->classObject( + $unit->className, + $unit->namespace, + $unit->startLine, + $unit->executableLines, + $unit->executedLines, + (float) $unit->crap, + ); } else { - $unitObject = $report->traitObject($unit['traitName']); + $report->getWriter()->startElement('trait'); + + $unitObject = $report->traitObject( + $unit->traitName, + $unit->namespace, + $unit->startLine, + $unit->executableLines, + $unit->executedLines, + (float) $unit->crap, + ); } - $unitObject->setLines( - $unit['startLine'], - $unit['executableLines'], - $unit['executedLines'], - ); - - $unitObject->setCrap((float) $unit['crap']); - $unitObject->setNamespace($unit['namespace']); - - foreach ($unit['methods'] as $method) { - $methodObject = $unitObject->addMethod($method['methodName']); - $methodObject->setSignature($method['signature']); - $methodObject->setLines((string) $method['startLine'], (string) $method['endLine']); - $methodObject->setCrap($method['crap']); - $methodObject->setTotals( - (string) $method['executableLines'], - (string) $method['executedLines'], - (string) $method['coverage'], + foreach ($unit->methods as $method) { + $report->getWriter()->startElement('method'); + + $unitObject->addMethod( + $method->methodName, + $method->signature, + (string) $method->startLine, + (string) $method->endLine, + (string) $method->executableLines, + (string) $method->executedLines, + (string) $method->coverage, + $method->crap, ); + + $report->getWriter()->endElement(); } + + $report->getWriter()->endElement(); } - /** - * @param ProcessedFunctionType $function - */ - private function processFunction(array $function, Report $report): void + private function processFunction(ProcessedFunctionType $function, Report $report): void { - $functionObject = $report->functionObject($function['functionName']); + $report->getWriter()->startElement('function'); + + $report->functionObject( + $function->functionName, + $function->signature, + (string) $function->startLine, + null, + (string) $function->executableLines, + (string) $function->executedLines, + (string) $function->coverage, + $function->crap, + ); - $functionObject->setSignature($function['signature']); - $functionObject->setLines((string) $function['startLine']); - $functionObject->setCrap($function['crap']); - $functionObject->setTotals((string) $function['executableLines'], (string) $function['executedLines'], (string) $function['coverage']); + $report->getWriter()->endElement(); } /** @@ -235,15 +307,21 @@ private function processFunction(array $function, Report $report): void */ private function processTests(array $tests): void { + $this->project->getWriter()->startElement('tests'); + $testsObject = $this->project->tests(); foreach ($tests as $test => $result) { $testsObject->addTest($test, $result); } + + $this->project->getWriter()->endElement(); } private function setTotals(AbstractNode $node, Totals $totals): void { + $totals->getWriter()->startElement('totals'); + $loc = $node->linesOfCode(); $totals->setNumLines( @@ -254,6 +332,16 @@ private function setTotals(AbstractNode $node, Totals $totals): void $node->numberOfExecutedLines(), ); + $totals->setNumMethods( + $node->numberOfMethods(), + $node->numberOfTestedMethods(), + ); + + $totals->setNumFunctions( + $node->numberOfFunctions(), + $node->numberOfTestedFunctions(), + ); + $totals->setNumClasses( $node->numberOfClasses(), $node->numberOfTestedClasses(), @@ -264,15 +352,7 @@ private function setTotals(AbstractNode $node, Totals $totals): void $node->numberOfTestedTraits(), ); - $totals->setNumMethods( - $node->numberOfMethods(), - $node->numberOfTestedMethods(), - ); - - $totals->setNumFunctions( - $node->numberOfFunctions(), - $node->numberOfTestedFunctions(), - ); + $totals->getWriter()->endElement(); } private function targetDirectory(): string @@ -280,45 +360,12 @@ private function targetDirectory(): string return $this->target; } - /** - * @throws XmlException - */ - private function saveDocument(DOMDocument $document, string $name): void + private function targetFilePath(string $name): string { $filename = sprintf('%s/%s.xml', $this->targetDirectory(), $name); - $document->formatOutput = true; - $document->preserveWhiteSpace = false; $this->initTargetDirectory(dirname($filename)); - file_put_contents($filename, $this->documentAsString($document)); - } - - /** - * @throws XmlException - * - * @see https://bugs.php.net/bug.php?id=79191 - */ - private function documentAsString(DOMDocument $document): string - { - $xmlErrorHandling = libxml_use_internal_errors(true); - $xml = $document->saveXML(); - - if ($xml === false) { - // @codeCoverageIgnoreStart - $message = 'Unable to generate the XML'; - - foreach (libxml_get_errors() as $error) { - $message .= PHP_EOL . $error->message; - } - - throw new XmlException($message); - // @codeCoverageIgnoreEnd - } - - libxml_clear_errors(); - libxml_use_internal_errors($xmlErrorHandling); - - return $xml; + return $filename; } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/File.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/File.php index 4a3fea008..2e598cb0e 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/File.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/File.php @@ -9,77 +9,34 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use function assert; -use DOMDocument; -use DOMElement; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ class File { - private readonly DOMDocument $dom; - private readonly DOMElement $contextNode; + protected XMLWriter $xmlWriter; - public function __construct(DOMElement $context) + public function __construct(XMLWriter $xmlWriter) { - $this->dom = $context->ownerDocument; - $this->contextNode = $context; + $this->xmlWriter = $xmlWriter; } - public function totals(): Totals + public function getWriter(): XMLWriter { - $totalsContainer = $this->contextNode->firstChild; - - if ($totalsContainer === null) { - $totalsContainer = $this->contextNode->appendChild( - $this->dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'totals', - ), - ); - } - - assert($totalsContainer instanceof DOMElement); - - return new Totals($totalsContainer); + return $this->xmlWriter; } - public function lineCoverage(string $line): Coverage - { - $coverage = $this->contextNode->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', - 'coverage', - )->item(0); - - if ($coverage === null) { - $coverage = $this->contextNode->appendChild( - $this->dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'coverage', - ), - ); - } - - $lineNode = $coverage->appendChild( - $this->dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'line', - ), - ); - - assert($lineNode instanceof DOMElement); - - return new Coverage($lineNode, $line); - } - - protected function contextNode(): DOMElement + public function totals(): Totals { - return $this->contextNode; + return new Totals($this->xmlWriter); } - protected function dom(): DOMDocument + public function lineCoverage(string $line): Coverage { - return $this->dom; + return new Coverage($this->xmlWriter, $line); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Method.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Method.php index 1994d0f79..87f999fff 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Method.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Method.php @@ -9,50 +9,45 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use DOMElement; +use SebastianBergmann\CodeCoverage\Util\EnsuresUtf8; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Method { - private DOMElement $contextNode; - - public function __construct(DOMElement $context, string $name) - { - $this->contextNode = $context; - - $this->setName($name); - } - - public function setSignature(string $signature): void - { - $this->contextNode->setAttribute('signature', $signature); - } - - public function setLines(string $start, ?string $end = null): void - { - $this->contextNode->setAttribute('start', $start); + use EnsuresUtf8; + private XMLWriter $xmlWriter; + + public function __construct( + XMLWriter $xmlWriter, + string $name, + string $signature, + string $start, + ?string $end, + string $executable, + string $executed, + string $coverage, + string $crap + ) { + $this->xmlWriter = $xmlWriter; + + $this->xmlWriter->writeAttribute('name', $this->ensureUtf8($name)); + $this->xmlWriter->writeAttribute('signature', $this->ensureUtf8($signature)); + + $this->xmlWriter->writeAttribute('start', $start); if ($end !== null) { - $this->contextNode->setAttribute('end', $end); + $this->xmlWriter->writeAttribute('end', $end); } - } - public function setTotals(string $executable, string $executed, string $coverage): void - { - $this->contextNode->setAttribute('executable', $executable); - $this->contextNode->setAttribute('executed', $executed); - $this->contextNode->setAttribute('coverage', $coverage); - } - - public function setCrap(string $crap): void - { - $this->contextNode->setAttribute('crap', $crap); - } + $this->xmlWriter->writeAttribute('crap', $crap); - private function setName(string $name): void - { - $this->contextNode->setAttribute('name', $name); + $this->xmlWriter->writeAttribute('executable', $executable); + $this->xmlWriter->writeAttribute('executed', $executed); + $this->xmlWriter->writeAttribute('coverage', $coverage); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Node.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Node.php index e41197a08..d5a406486 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Node.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Node.php @@ -9,81 +9,39 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use function assert; -use DOMDocument; -use DOMElement; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ abstract class Node { - private DOMDocument $dom; - private DOMElement $contextNode; - - public function __construct(DOMElement $context) - { - $this->setContextNode($context); - } + protected readonly XMLWriter $xmlWriter; - public function dom(): DOMDocument + public function __construct(XMLWriter $xmlWriter) { - return $this->dom; + $this->xmlWriter = $xmlWriter; } public function totals(): Totals { - $totalsContainer = $this->contextNode()->firstChild; - - if ($totalsContainer === null) { - $totalsContainer = $this->contextNode()->appendChild( - $this->dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'totals', - ), - ); - } - - assert($totalsContainer instanceof DOMElement); - - return new Totals($totalsContainer); - } - - public function addDirectory(string $name): Directory - { - $dirNode = $this->dom()->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'directory', - ); - - $dirNode->setAttribute('name', $name); - $this->contextNode()->appendChild($dirNode); - - return new Directory($dirNode); + return new Totals($this->xmlWriter); } - public function addFile(string $name, string $href): File + public function addDirectory(): Directory { - $fileNode = $this->dom()->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'file', - ); - - $fileNode->setAttribute('name', $name); - $fileNode->setAttribute('href', $href); - $this->contextNode()->appendChild($fileNode); - - return new File($fileNode); + return new Directory($this->xmlWriter); } - protected function setContextNode(DOMElement $context): void + public function addFile(): File { - $this->dom = $context->ownerDocument; - $this->contextNode = $context; + return new File($this->xmlWriter); } - protected function contextNode(): DOMElement + public function getWriter(): XMLWriter { - return $this->contextNode; + return $this->xmlWriter; } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Project.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Project.php index 21b5a2ce1..db5533d9f 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Project.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Project.php @@ -9,91 +9,75 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use function assert; -use DOMDocument; -use DOMElement; +use DateTimeImmutable; +use SebastianBergmann\Environment\Runtime; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class Project extends Node { - /** - * @phpstan-ignore constructor.missingParentCall - */ - public function __construct(string $directory) + private readonly string $directory; + + public function __construct(XMLWriter $xmlWriter, string $directory) { - $this->init(); - $this->setProjectSourceDirectory($directory); + $this->directory = $directory; + + parent::__construct($xmlWriter); + + $this->xmlWriter->startDocument(); + + $this->xmlWriter->startElement('phpunit'); + $this->xmlWriter->writeAttribute('xmlns', Facade::XML_NAMESPACE); } public function projectSourceDirectory(): string { - return $this->contextNode()->getAttribute('source'); + return $this->directory; } - public function buildInformation(): BuildInformation - { - $buildNode = $this->dom()->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', - 'build', - )->item(0); - - if ($buildNode === null) { - $buildNode = $this->dom()->documentElement->appendChild( - $this->dom()->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'build', - ), - ); - } - - assert($buildNode instanceof DOMElement); - - return new BuildInformation($buildNode); + public function buildInformation( + Runtime $runtime, + DateTimeImmutable $buildDate, + string $phpUnitVersion, + string $coverageVersion, + string $driverExtensionName, + string $driverExtensionVersion, + ): void { + new BuildInformation( + $this->xmlWriter, + $runtime, + $buildDate, + $phpUnitVersion, + $coverageVersion, + $driverExtensionName, + $driverExtensionVersion, + ); } public function tests(): Tests { - $testsNode = $this->contextNode()->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', - 'tests', - )->item(0); - - if ($testsNode === null) { - $testsNode = $this->contextNode()->appendChild( - $this->dom()->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'tests', - ), - ); - } - - assert($testsNode instanceof DOMElement); - - return new Tests($testsNode); + return new Tests($this->xmlWriter); } - public function asDom(): DOMDocument + public function getWriter(): XMLWriter { - return $this->dom(); + return $this->xmlWriter; } - private function init(): void + public function startProject(): void { - $dom = new DOMDocument; - $dom->loadXML(''); - - $this->setContextNode( - $dom->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', - 'project', - )->item(0), - ); + $this->xmlWriter->startElement('project'); + $this->xmlWriter->writeAttribute('source', $this->directory); } - private function setProjectSourceDirectory(string $name): void + public function finalize(): void { - $this->contextNode()->setAttribute('source', $name); + $this->xmlWriter->endElement(); + $this->xmlWriter->endDocument(); + $this->xmlWriter->flush(); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Report.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Report.php index f39ab860c..366bd4cd8 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Report.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Report.php @@ -9,99 +9,104 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use function assert; use function basename; use function dirname; use DOMDocument; -use DOMElement; +use SebastianBergmann\CodeCoverage\Util\EnsuresUtf8; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class Report extends File { - public function __construct(string $name) + use EnsuresUtf8; + private readonly string $name; + private readonly string $sha1; + + public function __construct(XMLWriter $xmlWriter, string $name, string $sha1) { + /* $dom = new DOMDocument; $dom->loadXML(''); $contextNode = $dom->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', + Facade::XML_NAMESPACE, 'file', )->item(0); - - parent::__construct($contextNode); - - $this->setName($name); +*/ + parent::__construct($xmlWriter); + + $this->name = $name; + $this->sha1 = $sha1; + + $xmlWriter->startDocument(); + $xmlWriter->startElement('phpunit'); + $xmlWriter->writeAttribute('xmlns', Facade::XML_NAMESPACE); + $xmlWriter->startElement('file'); + $xmlWriter->writeAttribute('name', $this->ensureUtf8(basename($this->name))); + $xmlWriter->writeAttribute('path', $this->ensureUtf8(dirname($this->name))); + $xmlWriter->writeAttribute('hash', $this->sha1); } - public function asDom(): DOMDocument + public function finalize(): void { - return $this->dom(); + $this->xmlWriter->endElement(); + $this->xmlWriter->endElement(); + + $this->xmlWriter->endDocument(); + $this->xmlWriter->flush(); } - public function functionObject(string $name): Method - { - $node = $this->contextNode()->appendChild( - $this->dom()->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'function', - ), + public function functionObject( + string $name, + string $signature, + string $start, + ?string $end, + string $executable, + string $executed, + string $coverage, + string $crap + ): void { + new Method( + $this->xmlWriter, + $name, + $signature, + $start, + $end, + $executable, + $executed, + $coverage, + $crap, ); - - assert($node instanceof DOMElement); - - return new Method($node, $name); } - public function classObject(string $name): Unit - { - return $this->unitObject('class', $name); + public function classObject( + string $name, + string $namespace, + int $start, + int $executable, + int $executed, + float $crap + ): Unit { + return new Unit($this->xmlWriter, $name, $namespace, $start, $executable, $executed, $crap); } - public function traitObject(string $name): Unit - { - return $this->unitObject('trait', $name); + public function traitObject( + string $name, + string $namespace, + int $start, + int $executable, + int $executed, + float $crap + ): Unit { + return new Unit($this->xmlWriter, $name, $namespace, $start, $executable, $executed, $crap); } public function source(): Source { - $source = $this->contextNode()->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', - 'source', - )->item(0); - - if ($source === null) { - $source = $this->contextNode()->appendChild( - $this->dom()->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'source', - ), - ); - } - - assert($source instanceof DOMElement); - - return new Source($source); - } - - private function setName(string $name): void - { - $this->contextNode()->setAttribute('name', basename($name)); - $this->contextNode()->setAttribute('path', dirname($name)); - } - - private function unitObject(string $tagName, string $name): Unit - { - $node = $this->contextNode()->appendChild( - $this->dom()->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - $tagName, - ), - ); - - assert($node instanceof DOMElement); - - return new Unit($node, $name); + return new Source($this->xmlWriter); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Source.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Source.php index 448fe72d6..32a61922c 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Source.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Source.php @@ -9,33 +9,28 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use DOMElement; use TheSeer\Tokenizer\NamespaceUri; use TheSeer\Tokenizer\Tokenizer; use TheSeer\Tokenizer\XMLSerializer; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Source { - private DOMElement $context; + private XMLWriter $xmlWriter; - public function __construct(DOMElement $context) + public function __construct(XMLWriter $xmlWriter) { - $this->context = $context; + $this->xmlWriter = $xmlWriter; } public function setSourceCode(string $source): void { - $context = $this->context; - $tokens = (new Tokenizer)->parse($source); - $srcDom = (new XMLSerializer(new NamespaceUri($context->namespaceURI)))->toDom($tokens); - - $context->parentNode->replaceChild( - $context->ownerDocument->importNode($srcDom->documentElement, true), - $context, - ); + new XMLSerializer(new NamespaceUri(Facade::XML_NAMESPACE))->appendToWriter($this->xmlWriter, $tokens); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Tests.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Tests.php index c9e9c48ef..9bb3fe5ac 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Tests.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Tests.php @@ -9,22 +9,26 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use function assert; -use DOMElement; +use function sprintf; use SebastianBergmann\CodeCoverage\CodeCoverage; +use SebastianBergmann\CodeCoverage\Util\EnsuresUtf8; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + * * @phpstan-import-type TestType from CodeCoverage */ final readonly class Tests { - private DOMElement $contextNode; + use EnsuresUtf8; + private readonly XMLWriter $xmlWriter; - public function __construct(DOMElement $context) + public function __construct(XMLWriter $xmlWriter) { - $this->contextNode = $context; + $this->xmlWriter = $xmlWriter; } /** @@ -32,17 +36,13 @@ public function __construct(DOMElement $context) */ public function addTest(string $test, array $result): void { - $node = $this->contextNode->appendChild( - $this->contextNode->ownerDocument->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'test', - ), - ); + $this->xmlWriter->startElement('test'); - assert($node instanceof DOMElement); + $this->xmlWriter->writeAttribute('name', $this->ensureUtf8($test)); + $this->xmlWriter->writeAttribute('size', $result['size']); + $this->xmlWriter->writeAttribute('status', $result['status']); + $this->xmlWriter->writeAttribute('time', sprintf('%F', $result['time'])); - $node->setAttribute('name', $test); - $node->setAttribute('size', $result['size']); - $node->setAttribute('status', $result['status']); + $this->xmlWriter->endElement(); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Totals.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Totals.php index 8e285a78e..a54187d09 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Totals.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Totals.php @@ -10,106 +10,88 @@ namespace SebastianBergmann\CodeCoverage\Report\Xml; use function sprintf; -use DOMElement; use SebastianBergmann\CodeCoverage\Util\Percentage; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Totals { - private DOMElement $linesNode; - private DOMElement $methodsNode; - private DOMElement $functionsNode; - private DOMElement $classesNode; - private DOMElement $traitsNode; + private XMLWriter $xmlWriter; - public function __construct(DOMElement $container) + public function __construct(XMLWriter $xmlWriter) { - $dom = $container->ownerDocument; - - $this->linesNode = $dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'lines', - ); - - $this->methodsNode = $dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'methods', - ); - - $this->functionsNode = $dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'functions', - ); - - $this->classesNode = $dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'classes', - ); - - $this->traitsNode = $dom->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'traits', - ); - - $container->appendChild($this->linesNode); - $container->appendChild($this->methodsNode); - $container->appendChild($this->functionsNode); - $container->appendChild($this->classesNode); - $container->appendChild($this->traitsNode); + $this->xmlWriter = $xmlWriter; } public function setNumLines(int $loc, int $cloc, int $ncloc, int $executable, int $executed): void { - $this->linesNode->setAttribute('total', (string) $loc); - $this->linesNode->setAttribute('comments', (string) $cloc); - $this->linesNode->setAttribute('code', (string) $ncloc); - $this->linesNode->setAttribute('executable', (string) $executable); - $this->linesNode->setAttribute('executed', (string) $executed); - $this->linesNode->setAttribute( + $this->xmlWriter->startElement('lines'); + $this->xmlWriter->writeAttribute('total', (string) $loc); + $this->xmlWriter->writeAttribute('comments', (string) $cloc); + $this->xmlWriter->writeAttribute('code', (string) $ncloc); + $this->xmlWriter->writeAttribute('executable', (string) $executable); + $this->xmlWriter->writeAttribute('executed', (string) $executed); + $this->xmlWriter->writeAttribute( 'percent', $executable === 0 ? '0' : sprintf('%01.2F', Percentage::fromFractionAndTotal($executed, $executable)->asFloat()), ); + $this->xmlWriter->endElement(); } public function setNumClasses(int $count, int $tested): void { - $this->classesNode->setAttribute('count', (string) $count); - $this->classesNode->setAttribute('tested', (string) $tested); - $this->classesNode->setAttribute( + $this->xmlWriter->startElement('classes'); + $this->xmlWriter->writeAttribute('count', (string) $count); + $this->xmlWriter->writeAttribute('tested', (string) $tested); + $this->xmlWriter->writeAttribute( 'percent', $count === 0 ? '0' : sprintf('%01.2F', Percentage::fromFractionAndTotal($tested, $count)->asFloat()), ); + $this->xmlWriter->endElement(); } public function setNumTraits(int $count, int $tested): void { - $this->traitsNode->setAttribute('count', (string) $count); - $this->traitsNode->setAttribute('tested', (string) $tested); - $this->traitsNode->setAttribute( + $this->xmlWriter->startElement('traits'); + $this->xmlWriter->writeAttribute('count', (string) $count); + $this->xmlWriter->writeAttribute('tested', (string) $tested); + $this->xmlWriter->writeAttribute( 'percent', $count === 0 ? '0' : sprintf('%01.2F', Percentage::fromFractionAndTotal($tested, $count)->asFloat()), ); + $this->xmlWriter->endElement(); } public function setNumMethods(int $count, int $tested): void { - $this->methodsNode->setAttribute('count', (string) $count); - $this->methodsNode->setAttribute('tested', (string) $tested); - $this->methodsNode->setAttribute( + $this->xmlWriter->startElement('methods'); + $this->xmlWriter->writeAttribute('count', (string) $count); + $this->xmlWriter->writeAttribute('tested', (string) $tested); + $this->xmlWriter->writeAttribute( 'percent', $count === 0 ? '0' : sprintf('%01.2F', Percentage::fromFractionAndTotal($tested, $count)->asFloat()), ); + $this->xmlWriter->endElement(); } public function setNumFunctions(int $count, int $tested): void { - $this->functionsNode->setAttribute('count', (string) $count); - $this->functionsNode->setAttribute('tested', (string) $tested); - $this->functionsNode->setAttribute( + $this->xmlWriter->startElement('functions'); + $this->xmlWriter->writeAttribute('count', (string) $count); + $this->xmlWriter->writeAttribute('tested', (string) $tested); + $this->xmlWriter->writeAttribute( 'percent', $count === 0 ? '0' : sprintf('%01.2F', Percentage::fromFractionAndTotal($tested, $count)->asFloat()), ); + $this->xmlWriter->endElement(); + } + + public function getWriter(): XMLWriter + { + return $this->xmlWriter; } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Unit.php b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Unit.php index a00f85d39..794e88b27 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Unit.php +++ b/app/vendor/phpunit/php-code-coverage/src/Report/Xml/Unit.php @@ -9,72 +9,61 @@ */ namespace SebastianBergmann\CodeCoverage\Report\Xml; -use function assert; -use DOMElement; +use SebastianBergmann\CodeCoverage\Util\EnsuresUtf8; +use XMLWriter; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Unit { - private DOMElement $contextNode; - - public function __construct(DOMElement $context, string $name) - { - $this->contextNode = $context; + use EnsuresUtf8; + private XMLWriter $xmlWriter; - $this->setName($name); - } + public function __construct( + XMLWriter $xmlWriter, + string $name, + string $namespace, + int $start, + int $executable, + int $executed, + float $crap + ) { + $this->xmlWriter = $xmlWriter; - public function setLines(int $start, int $executable, int $executed): void - { - $this->contextNode->setAttribute('start', (string) $start); - $this->contextNode->setAttribute('executable', (string) $executable); - $this->contextNode->setAttribute('executed', (string) $executed); - } + $this->xmlWriter->writeAttribute('name', $this->ensureUtf8($name)); + $this->xmlWriter->writeAttribute('start', (string) $start); + $this->xmlWriter->writeAttribute('executable', (string) $executable); + $this->xmlWriter->writeAttribute('executed', (string) $executed); + $this->xmlWriter->writeAttribute('crap', (string) $crap); - public function setCrap(float $crap): void - { - $this->contextNode->setAttribute('crap', (string) $crap); + $this->xmlWriter->startElement('namespace'); + $this->xmlWriter->writeAttribute('name', $this->ensureUtf8($namespace)); + $this->xmlWriter->endElement(); } - public function setNamespace(string $namespace): void - { - $node = $this->contextNode->getElementsByTagNameNS( - 'https://schema.phpunit.de/coverage/1.0', - 'namespace', - )->item(0); - - if ($node === null) { - $node = $this->contextNode->appendChild( - $this->contextNode->ownerDocument->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'namespace', - ), - ); - } - - assert($node instanceof DOMElement); - - $node->setAttribute('name', $namespace); - } - - public function addMethod(string $name): Method - { - $node = $this->contextNode->appendChild( - $this->contextNode->ownerDocument->createElementNS( - 'https://schema.phpunit.de/coverage/1.0', - 'method', - ), + public function addMethod( + string $name, + string $signature, + string $start, + ?string $end, + string $executable, + string $executed, + string $coverage, + string $crap + ): void { + new Method( + $this->xmlWriter, + $name, + $signature, + $start, + $end, + $executable, + $executed, + $coverage, + $crap, ); - - assert($node instanceof DOMElement); - - return new Method($node, $name); - } - - private function setName(string $name): void - { - $this->contextNode->setAttribute('name', $name); } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Serialization/Merger.php b/app/vendor/phpunit/php-code-coverage/src/Serialization/Merger.php new file mode 100644 index 000000000..af16faa3e --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Serialization/Merger.php @@ -0,0 +1,123 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Serialization; + +use function array_key_exists; +use function array_merge; +use function array_slice; +use DateTimeImmutable; +use SebastianBergmann\CodeCoverage\Version; + +/** + * @phpstan-import-type SerializedCoverage from Serializer + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final readonly class Merger +{ + /** + * @param list $paths + * + * @throws DriverMismatchException + * @throws EmptyPathListException + * @throws GitInformationMismatchException + * @throws MixedGitInformationException + * @throws RuntimeMismatchException + * + * @return SerializedCoverage + */ + public function merge(array $paths, bool $requireMatchingGitInformation = true, bool $requireMatchingPhpVersion = true, bool $requireMatchingCodeCoverageDriver = true): array + { + if ($paths === []) { + throw new EmptyPathListException; + } + + $unserializer = new Unserializer; + + $first = $unserializer->unserialize($paths[0]); + $refRuntime = $first['buildInformation']['runtime']; + $refDriver = $first['buildInformation']['phpCodeCoverage']['driverInformation']; + $refHasGit = array_key_exists('git', $first['buildInformation']); + $refGit = $first['buildInformation']['git'] ?? null; + + $mergedCoverage = clone $first['codeCoverage']; + $mergedTestResults = [$first['testResults']]; + + foreach (array_slice($paths, 1) as $path) { + $item = $unserializer->unserialize($path); + $runtime = $item['buildInformation']['runtime']; + + if ($requireMatchingPhpVersion) { + if ($runtime['name'] !== $refRuntime['name'] || $runtime['version'] !== $refRuntime['version']) { + throw new RuntimeMismatchException; + } + } + + if ($requireMatchingCodeCoverageDriver) { + $driver = $item['buildInformation']['phpCodeCoverage']['driverInformation']; + + if ($driver['name'] !== $refDriver['name'] || $driver['version'] !== $refDriver['version']) { + throw new DriverMismatchException; + } + } + + if ($requireMatchingGitInformation) { + $hasGit = array_key_exists('git', $item['buildInformation']); + + if ($hasGit !== $refHasGit) { + throw new MixedGitInformationException; + } + + if ($hasGit) { + $git = $item['buildInformation']['git']; + + foreach (['originUrl', 'branch', 'commit', 'status'] as $field) { + if ($git[$field] !== $refGit[$field]) { + throw new GitInformationMismatchException($field, (string) $refGit[$field], (string) $git[$field]); + } + } + + if ($git['isClean'] !== $refGit['isClean']) { + throw new GitInformationMismatchException( + 'isClean', + $refGit['isClean'] ? 'true' : 'false', + $git['isClean'] ? 'true' : 'false', + ); + } + } + } + + $mergedCoverage->merge($item['codeCoverage']); + + $mergedTestResults[] = $item['testResults']; + } + + $buildInformation = [ + 'timestamp' => (new DateTimeImmutable)->format('D M j G:i:s T Y'), + 'runtime' => $refRuntime, + 'phpCodeCoverage' => [ + 'version' => Version::id(), + 'serializationFormat' => Serializer::SERIALIZATION_FORMAT, + 'driverInformation' => $refDriver, + ], + ]; + + if ($refHasGit) { + $buildInformation['git'] = $refGit; + } + + return [ + 'buildInformation' => $buildInformation, + 'basePath' => $first['basePath'], + 'codeCoverage' => $mergedCoverage, + 'testResults' => array_merge(...$mergedTestResults), + ]; + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Serialization/Serializer.php b/app/vendor/phpunit/php-code-coverage/src/Serialization/Serializer.php new file mode 100644 index 000000000..8b36a958f --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Serialization/Serializer.php @@ -0,0 +1,152 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Serialization; + +use const PHP_EOL; +use function preg_replace_callback; +use function serialize; +use function str_starts_with; +use DateTimeImmutable; +use SebastianBergmann\CodeCoverage\CodeCoverage; +use SebastianBergmann\CodeCoverage\Data\ProcessedCodeCoverageData; +use SebastianBergmann\CodeCoverage\Util\Filesystem; +use SebastianBergmann\CodeCoverage\Util\PathReducer; +use SebastianBergmann\CodeCoverage\Version; +use SebastianBergmann\Environment\Runtime; +use SebastianBergmann\GitState\Builder as GitStateBuilder; + +/** + * @phpstan-type SerializedCoverage array{ + * buildInformation: array{ + * timestamp: string, + * runtime: array{ + * name: string, + * version: string, + * vendorUrl: string, + * }, + * phpCodeCoverage: array{ + * version: string, + * serializationFormat: int, + * driverInformation: array{ + * name: non-empty-string, + * version: non-empty-string, + * }, + * }, + * git?: array{ + * originUrl: string, + * branch: string, + * commit: string, + * isClean: bool, + * status: string, + * }, + * }, + * basePath: string, + * codeCoverage: ProcessedCodeCoverageData, + * testResults: array, + * } + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final readonly class Serializer +{ + public const int SERIALIZATION_FORMAT = 1; + + /** + * @param non-empty-string $target + * + * @throws PharPrefixCouldNotBeStrippedException + */ + public function serialize(string $target, CodeCoverage $codeCoverage, bool $includeGitInformation = false): void + { + $runtime = new Runtime; + + $buildInformation = [ + 'timestamp' => (new DateTimeImmutable)->format('D M j G:i:s T Y'), + 'runtime' => [ + 'name' => $runtime->getName(), + 'version' => $runtime->getVersion(), + 'vendorUrl' => $runtime->getVendorUrl(), + ], + 'phpCodeCoverage' => [ + 'version' => Version::id(), + 'serializationFormat' => self::SERIALIZATION_FORMAT, + 'driverInformation' => $codeCoverage->driverInformation(), + ], + ]; + + if ($includeGitInformation) { + $gitInformation = (new GitStateBuilder)->build(); + + if ($gitInformation !== false) { + $buildInformation['git'] = [ + 'originUrl' => $gitInformation->originUrl(), + 'branch' => $gitInformation->branch(), + 'commit' => $gitInformation->commit(), + 'isClean' => $gitInformation->isClean(), + 'status' => $gitInformation->status(), + ]; + } + } + + $coverageData = clone $codeCoverage->getData(); + $basePath = (new PathReducer)->reduce($coverageData); + + $data = [ + 'buildInformation' => $buildInformation, + 'basePath' => $basePath, + 'codeCoverage' => $coverageData, + 'testResults' => $codeCoverage->getTests(), + ]; + + $serializedData = serialize($data); + + if (str_starts_with(self::class, 'PHPUnitPHAR\\')) { + // @codeCoverageIgnoreStart + $serializedData = $this->stripPharPrefix($serializedData); + // @codeCoverageIgnoreEnd + } + + Filesystem::write( + $target, + ' + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Serialization; + +use function array_key_exists; +use function fclose; +use function fgets; +use function fopen; +use function is_array; +use function is_bool; +use function is_int; +use function is_string; +use function preg_match; +use function restore_error_handler; +use function set_error_handler; +use function trim; +use SebastianBergmann\CodeCoverage\Data\ProcessedCodeCoverageData; + +/** + * @phpstan-import-type SerializedCoverage from Serializer + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final readonly class Unserializer +{ + /** + * @param non-empty-string $path + * + * @throws FileCouldNotBeReadException + * @throws InvalidCoverageDataException + * @throws VersionMismatchException + * + * @return SerializedCoverage + */ + public function unserialize(string $path): array + { + $file = @fopen($path, 'r'); + + if ($file === false) { + throw new FileCouldNotBeReadException('Cannot open file: ' . $path); + } + + $firstLine = fgets($file); + + fclose($file); + + if ($firstLine === false) { + throw new FileCouldNotBeReadException('Cannot read from file: ' . $path); + } + + if (preg_match('/^<\?php \/\/ phpunit\/php-code-coverage serialization format (\d+)$/', trim($firstLine), $matches) !== 1) { + throw new FileCouldNotBeReadException('File does not contain phpunit/php-code-coverage serialization format information: ' . $path); + } + + $storedFormat = (int) $matches[1]; + + if ($storedFormat !== Serializer::SERIALIZATION_FORMAT) { + throw new VersionMismatchException($storedFormat, Serializer::SERIALIZATION_FORMAT); + } + + set_error_handler( + static function (int $errno, string $errstr) use ($path): never + { + throw new InvalidCoverageDataException( + 'Failed to unserialize coverage data from ' . $path . ': ' . $errstr, + ); + }, + ); + + try { + $data = require $path; + } finally { + restore_error_handler(); + } + + $this->validate($data); + + return $data; + } + + /** + * @throws InvalidCoverageDataException + */ + private function validate(mixed $data): void + { + if (!is_array($data)) { + throw new InvalidCoverageDataException('Coverage data is not an array'); + } + + if (!array_key_exists('buildInformation', $data) || !is_array($data['buildInformation'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation\' key'); + } + + $buildInformation = $data['buildInformation']; + + if (!array_key_exists('timestamp', $buildInformation) || !is_string($buildInformation['timestamp'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.timestamp\' key'); + } + + if (!array_key_exists('runtime', $buildInformation) || !is_array($buildInformation['runtime'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.runtime\' key'); + } + + $runtime = $buildInformation['runtime']; + + foreach (['name', 'version', 'vendorUrl'] as $key) { + if (!array_key_exists($key, $runtime) || !is_string($runtime[$key])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.runtime.' . $key . '\' key'); + } + } + + if (!array_key_exists('phpCodeCoverage', $buildInformation) || !is_array($buildInformation['phpCodeCoverage'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage\' key'); + } + + $phpCodeCoverage = $buildInformation['phpCodeCoverage']; + + if (!array_key_exists('version', $phpCodeCoverage) || !is_string($phpCodeCoverage['version'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage.version\' key'); + } + + if (!array_key_exists('serializationFormat', $phpCodeCoverage) || !is_int($phpCodeCoverage['serializationFormat'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage.serializationFormat\' key'); + } + + if (!array_key_exists('driverInformation', $phpCodeCoverage) || !is_array($phpCodeCoverage['driverInformation'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage.driverInformation\' key'); + } + + $driverInformation = $phpCodeCoverage['driverInformation']; + + foreach (['name', 'version'] as $key) { + if (!array_key_exists($key, $driverInformation) || !is_string($driverInformation[$key]) || $driverInformation[$key] === '') { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.phpCodeCoverage.driverInformation.' . $key . '\' key'); + } + } + + if (array_key_exists('git', $buildInformation)) { + if (!is_array($buildInformation['git'])) { + throw new InvalidCoverageDataException('Coverage data has invalid \'buildInformation.git\' key'); + } + + $git = $buildInformation['git']; + + foreach (['originUrl', 'branch', 'commit', 'status'] as $key) { + if (!array_key_exists($key, $git) || !is_string($git[$key])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.git.' . $key . '\' key'); + } + } + + if (!array_key_exists('isClean', $git) || !is_bool($git['isClean'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'buildInformation.git.isClean\' key'); + } + } + + if (!array_key_exists('basePath', $data) || !is_string($data['basePath'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'basePath\' key'); + } + + if (!array_key_exists('codeCoverage', $data) || !$data['codeCoverage'] instanceof ProcessedCodeCoverageData) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'codeCoverage\' key'); + } + + if (!array_key_exists('testResults', $data) || !is_array($data['testResults'])) { + throw new InvalidCoverageDataException('Coverage data is missing valid \'testResults\' key'); + } + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CacheWarmer.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CacheWarmer.php index dcd0c61ec..23d42e4ec 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CacheWarmer.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CacheWarmer.php @@ -14,6 +14,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class CacheWarmer { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CachingSourceAnalyser.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CachingSourceAnalyser.php index 6a7b8001b..9d015b049 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CachingSourceAnalyser.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/CachingSourceAnalyser.php @@ -22,6 +22,8 @@ /** * @internal This interface is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class CachingSourceAnalyser implements SourceAnalyser { @@ -107,8 +109,14 @@ private function read(string $cacheFile): AnalysisResult|false return false; } + $data = file_get_contents($cacheFile); + + if ($data === false) { + return false; + } + return unserialize( - file_get_contents($cacheFile), + $data, [ 'allowed_classes' => [ AnalysisResult::class, diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/FileAnalyser.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/FileAnalyser.php index 3b1c5a42b..db69c987f 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/FileAnalyser.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/FileAnalyser.php @@ -13,6 +13,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class FileAnalyser { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/ParsingSourceAnalyser.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/ParsingSourceAnalyser.php index 7f46eeca6..73e60aeb8 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/ParsingSourceAnalyser.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/ParsingSourceAnalyser.php @@ -31,6 +31,8 @@ /** * @internal This interface is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class ParsingSourceAnalyser implements SourceAnalyser { @@ -41,10 +43,6 @@ public function analyse(string $sourceCodeFile, string $sourceCode, bool $useAnn { $linesOfCode = max(substr_count($sourceCode, "\n") + 1, substr_count($sourceCode, "\r") + 1); - if ($linesOfCode === 0 && $sourceCode !== '') { - $linesOfCode = 1; - } - assert($linesOfCode > 0); $parser = (new ParserFactory)->createForHostVersion(); @@ -107,6 +105,7 @@ public function analyse(string $sourceCodeFile, string $sourceCode, bool $useAnn $lineCountingVisitor->result()->nonCommentLinesOfCode(), ), $executableLinesFindingVisitor->executableLinesGroupedByBranch(), + $executableLinesFindingVisitor->branchOperatorLines(), $ignoredLines, ); } diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/SourceAnalyser.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/SourceAnalyser.php index bc18996ff..be9908e40 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/SourceAnalyser.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/SourceAnalyser.php @@ -11,6 +11,8 @@ /** * @internal This interface is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ interface SourceAnalyser { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/AnalysisResult.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/AnalysisResult.php index 88fff2c46..2aae4ec52 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/AnalysisResult.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/AnalysisResult.php @@ -13,6 +13,8 @@ * @phpstan-type LinesType array * * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class AnalysisResult { @@ -42,6 +44,11 @@ */ private array $executableLines; + /** + * @var array + */ + private array $branchOperatorLines; + /** * @var LinesType */ @@ -53,17 +60,19 @@ * @param array $traits * @param array $functions * @param LinesType $executableLines + * @param array $branchOperatorLines * @param LinesType $ignoredLines */ - public function __construct(array $interfaces, array $classes, array $traits, array $functions, LinesOfCode $linesOfCode, array $executableLines, array $ignoredLines) + public function __construct(array $interfaces, array $classes, array $traits, array $functions, LinesOfCode $linesOfCode, array $executableLines, array $branchOperatorLines, array $ignoredLines) { - $this->interfaces = $interfaces; - $this->classes = $classes; - $this->traits = $traits; - $this->functions = $functions; - $this->linesOfCode = $linesOfCode; - $this->executableLines = $executableLines; - $this->ignoredLines = $ignoredLines; + $this->interfaces = $interfaces; + $this->classes = $classes; + $this->traits = $traits; + $this->functions = $functions; + $this->linesOfCode = $linesOfCode; + $this->executableLines = $executableLines; + $this->branchOperatorLines = $branchOperatorLines; + $this->ignoredLines = $ignoredLines; } /** @@ -111,6 +120,14 @@ public function executableLines(): array return $this->executableLines; } + /** + * @return array + */ + public function branchOperatorLines(): array + { + return $this->branchOperatorLines; + } + /** * @return LinesType */ diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Class_.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Class_.php index ee87b246e..40a389106 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Class_.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Class_.php @@ -11,6 +11,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Class_ { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Function_.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Function_.php index 7069dec99..bb0d016c0 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Function_.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Function_.php @@ -11,6 +11,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Function_ { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Interface_.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Interface_.php index 0b2579280..7f1769dd8 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Interface_.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Interface_.php @@ -11,6 +11,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Interface_ { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/LinesOfCode.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/LinesOfCode.php index f8720e1a7..e534b49cf 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/LinesOfCode.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/LinesOfCode.php @@ -11,6 +11,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class LinesOfCode { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Method.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Method.php index 12e3438eb..9970bff1b 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Method.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Method.php @@ -11,6 +11,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Method { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Trait_.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Trait_.php index 7bf1084cd..7b68ac34e 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Trait_.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Trait_.php @@ -11,6 +11,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Trait_ { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Visibility.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Visibility.php index c92797751..45254257e 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Visibility.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Value/Visibility.php @@ -11,6 +11,8 @@ /** * @internal This enumeration is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ enum Visibility: string { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/AttributeParentConnectingVisitor.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/AttributeParentConnectingVisitor.php index 2e2141405..1b26aaf29 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/AttributeParentConnectingVisitor.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/AttributeParentConnectingVisitor.php @@ -22,6 +22,8 @@ * $node->getAttribute('parent'). * * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class AttributeParentConnectingVisitor implements NodeVisitor { diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/CodeUnitFindingVisitor.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/CodeUnitFindingVisitor.php index 558d3e053..bcc04890d 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/CodeUnitFindingVisitor.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/CodeUnitFindingVisitor.php @@ -32,6 +32,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class CodeUnitFindingVisitor extends NodeVisitorAbstract { @@ -105,7 +107,7 @@ public function leaveNode(Node $node): null return null; } - if (!$node instanceof Class_ && !$node instanceof Trait_) { + if (!$node instanceof Class_ && !$node instanceof Enum_ && !$node instanceof Trait_) { return null; } @@ -254,7 +256,7 @@ private function processInterface(Interface_ $node): void $name, $namespacedName, $this->namespace($namespacedName, $name), - $node->getStartLine(), + $this->startLine($node), $node->getEndLine(), $parentInterfaces, ); @@ -282,7 +284,7 @@ private function processClass(Class_|Enum_ $node): void $namespacedName, $this->namespace($namespacedName, $name), $this->file, - $node->getStartLine(), + $this->startLine($node), $node->getEndLine(), $parentClass, $interfaces, @@ -301,7 +303,7 @@ private function processTrait(Trait_ $node): void $namespacedName, $this->namespace($namespacedName, $name), $this->file, - $node->getStartLine(), + $this->startLine($node), $node->getEndLine(), [], $this->processMethods($node->getMethods()), @@ -320,7 +322,7 @@ private function processMethods(array $nodes): array foreach ($nodes as $node) { $methods[$node->name->toString()] = new Method( $node->name->toString(), - $node->getStartLine(), + $this->startLine($node), $node->getEndLine(), $this->signature($node), $this->visibility($node), @@ -344,13 +346,18 @@ private function processFunction(Function_ $node): void $name, $namespacedName, $this->namespace($namespacedName, $name), - $node->getStartLine(), + $this->startLine($node), $node->getEndLine(), $this->signature($node), $this->cyclomaticComplexity($node), ); } + private function startLine(Class_|ClassMethod|Enum_|Function_|Interface_|Trait_ $node): int + { + return $node->name->getStartLine(); + } + private function namespace(string $namespacedName, string $name): string { return trim(rtrim($namespacedName, $name), '\\'); @@ -396,11 +403,11 @@ private function typeAsString(Identifier|Name $node): string /** * @param list $traits */ - private function postProcessClassOrTrait(Class_|Trait_ $node, array $traits): void + private function postProcessClassOrTrait(Class_|Enum_|Trait_ $node, array $traits): void { $name = $node->namespacedName->toString(); - if ($node instanceof Class_) { + if ($node instanceof Class_ || $node instanceof Enum_) { assert(isset($this->classes[$name])); $this->classes[$name] = new \SebastianBergmann\CodeCoverage\StaticAnalysis\Class_( diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/ExecutableLinesFindingVisitor.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/ExecutableLinesFindingVisitor.php index 6a114e1b9..a9faa4fd4 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/ExecutableLinesFindingVisitor.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/ExecutableLinesFindingVisitor.php @@ -10,6 +10,7 @@ namespace SebastianBergmann\CodeCoverage\StaticAnalysis; use function array_diff_key; +use function array_intersect_key; use function assert; use function count; use function current; @@ -21,12 +22,15 @@ use function range; use function reset; use function sprintf; +use function strtolower; use PhpParser\Node; use PhpParser\NodeVisitorAbstract; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + * * @phpstan-import-type LinesType from AnalysisResult */ final class ExecutableLinesFindingVisitor extends NodeVisitorAbstract @@ -39,6 +43,11 @@ final class ExecutableLinesFindingVisitor extends NodeVisitorAbstract */ private array $executableLinesGroupedByBranch = []; + /** + * @var array + */ + private array $branchOperatorLines = []; + /** * @var array */ @@ -48,6 +57,7 @@ final class ExecutableLinesFindingVisitor extends NodeVisitorAbstract * @var array */ private array $commentsToCheckForUnset = []; + private int $spreadDepth = 0; public function __construct(string $source) { @@ -56,6 +66,10 @@ public function __construct(string $source) public function enterNode(Node $node): null { + if ($node instanceof Node\ArrayItem && $node->unpack) { + $this->spreadDepth++; + } + foreach ($node->getComments() as $comment) { $commentLine = $comment->getStartLine(); @@ -83,7 +97,9 @@ public function enterNode(Node $node): null return null; } - if ($node instanceof Node\Stmt\Interface_) { + if ($node instanceof Node\Stmt\Interface_ || + $node instanceof Node\Attribute + ) { foreach (range($node->getStartLine(), $node->getEndLine()) as $line) { $this->unsets[$line] = true; } @@ -125,6 +141,24 @@ public function enterNode(Node $node): null ); } + if ([] !== $node->arms) { + $firstArmLine = $node->arms[0]->getStartLine(); + $lastArmLine = $node->arms[count($node->arms) - 1]->getEndLine(); + + if ($node->getStartLine() < $firstArmLine && + $this->matchConditionHasNoOpcode($node->cond)) { + foreach (range($node->getStartLine(), $firstArmLine - 1) as $line) { + $this->unsets[$line] = true; + } + } + + if ($node->getEndLine() > $lastArmLine) { + foreach (range($lastArmLine + 1, $node->getEndLine()) as $line) { + $this->unsets[$line] = true; + } + } + } + return null; } @@ -134,12 +168,21 @@ public function enterNode(Node $node): null return null; } + if ($node instanceof Node\Stmt\Expression && + $this->isSideEffectFreeExpressionStatement($node)) { + return null; + } + if ($node instanceof Node\Stmt\Enum_ || $node instanceof Node\Stmt\Function_ || $node instanceof Node\Stmt\Class_ || $node instanceof Node\Stmt\ClassMethod || $node instanceof Node\Expr\Closure || $node instanceof Node\Stmt\Trait_) { + if ($node instanceof Node\Stmt\ClassMethod && $node->isAbstract()) { + return null; + } + if ($node instanceof Node\Stmt\Function_ || $node instanceof Node\Stmt\ClassMethod) { $unsets = []; @@ -163,7 +206,10 @@ public function enterNode(Node $node): null } foreach (range($stmt->getStartLine(), $stmt->getEndLine()) as $line) { - unset($this->executableLinesGroupedByBranch[$line]); + unset( + $this->executableLinesGroupedByBranch[$line], + $this->branchOperatorLines[$line], + ); if ( $isConcreteClassLike && @@ -217,6 +263,10 @@ public function enterNode(Node $node): null } if ($node instanceof Node\Expr\Ternary) { + if ($this->spreadDepth > 0) { + return null; + } + if (null !== $node->if && $node->getStartLine() !== $node->if->getEndLine()) { $this->setLineBranch($node->if->getStartLine(), $node->if->getEndLine(), ++$this->nextBranch); @@ -238,12 +288,7 @@ public function enterNode(Node $node): null } if ($node instanceof Node\Stmt\If_ || - $node instanceof Node\Stmt\ElseIf_ || - $node instanceof Node\Stmt\Case_) { - if (null === $node->cond) { - return null; - } - + $node instanceof Node\Stmt\ElseIf_) { $this->setLineBranch( $node->cond->getStartLine(), $node->cond->getStartLine(), @@ -253,6 +298,18 @@ public function enterNode(Node $node): null return null; } + if ($node instanceof Node\Stmt\Case_) { + if (null === $node->cond) { + return null; + } + + $line = $node->cond->getStartLine(); + + $this->executableLinesGroupedByBranch[$line] = ++$this->nextBranch; + + return null; + } + if ($node instanceof Node\Stmt\For_) { $startLine = null; $endLine = null; @@ -356,7 +413,20 @@ public function enterNode(Node $node): null return null; } - $this->setLineBranch($node->getStartLine(), $node->getEndLine(), ++$this->nextBranch); + $branch = ++$this->nextBranch; + + foreach (range($node->getStartLine(), $node->getEndLine()) as $line) { + $this->executableLinesGroupedByBranch[$line] = $branch; + } + + return null; + } + + public function leaveNode(Node $node): null + { + if ($node instanceof Node\ArrayItem && $node->unpack) { + $this->spreadDepth--; + } return null; } @@ -382,6 +452,11 @@ public function afterTraverse(array $nodes): null $this->unsets, ); + $this->branchOperatorLines = array_intersect_key( + $this->branchOperatorLines, + $this->executableLinesGroupedByBranch, + ); + return null; } @@ -393,10 +468,55 @@ public function executableLinesGroupedByBranch(): array return $this->executableLinesGroupedByBranch; } + /** + * @return array + */ + public function branchOperatorLines(): array + { + return $this->branchOperatorLines; + } + private function setLineBranch(int $start, int $end, int $branch): void { foreach (range($start, $end) as $line) { $this->executableLinesGroupedByBranch[$line] = $branch; + $this->branchOperatorLines[$line] = true; } } + + private function matchConditionHasNoOpcode(Node\Expr $cond): bool + { + if (!$cond instanceof Node\Expr\ConstFetch) { + return false; + } + + $name = strtolower($cond->name->toString()); + + return $name === 'true' || $name === 'false' || $name === 'null'; + } + + /** + * A statement consisting solely of a literal scalar (`'foo';`, `42;`) or + * one of the named constants `true`, `false`, `null` produces no opcodes: + * the Zend compiler discards it as dead code, so the driver cannot report + * it as executed and the analyser must not record it as executable. + */ + private function isSideEffectFreeExpressionStatement(Node\Stmt\Expression $node): bool + { + $expr = $node->expr; + + if ($expr instanceof Node\Scalar\String_ || + $expr instanceof Node\Scalar\Int_ || + $expr instanceof Node\Scalar\Float_) { + return true; + } + + if ($expr instanceof Node\Expr\ConstFetch) { + $name = strtolower($expr->name->toString()); + + return $name === 'true' || $name === 'false' || $name === 'null'; + } + + return false; + } } diff --git a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/IgnoredLinesFindingVisitor.php b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/IgnoredLinesFindingVisitor.php index fefe646c8..048add231 100644 --- a/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/IgnoredLinesFindingVisitor.php +++ b/app/vendor/phpunit/php-code-coverage/src/StaticAnalysis/Visitor/IgnoredLinesFindingVisitor.php @@ -23,6 +23,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class IgnoredLinesFindingVisitor extends NodeVisitorAbstract { @@ -55,9 +57,16 @@ public function enterNode(Node $node): null return null; } + if ($node instanceof Interface_) { + for ($line = $node->getStartLine(); $line <= $node->getEndLine(); $line++) { + $this->ignoredLines[] = $line; + } + + return null; + } + if ($node instanceof Class_ || $node instanceof Trait_ || - $node instanceof Interface_ || $node instanceof Attribute) { $this->ignoredLines[] = $node->getStartLine(); @@ -71,10 +80,6 @@ public function enterNode(Node $node): null return null; } - if ($node instanceof Interface_) { - return null; - } - if ($node instanceof Attribute && $node->name->toString() === 'PHPUnit\Framework\Attributes\CodeCoverageIgnore') { $attributeGroup = $node->getAttribute('parent'); diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/Class_.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/Class_.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/Class_.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/Class_.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/ClassesThatExtendClass.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/ClassesThatExtendClass.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/ClassesThatExtendClass.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/ClassesThatExtendClass.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/ClassesThatImplementInterface.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/ClassesThatImplementInterface.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/ClassesThatImplementInterface.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/ClassesThatImplementInterface.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/Function_.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/Function_.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/Function_.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/Function_.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/MapBuilder.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/MapBuilder.php similarity index 95% rename from app/vendor/phpunit/php-code-coverage/src/Target/MapBuilder.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/MapBuilder.php index 8e8d93fbb..fa3de853f 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Target/MapBuilder.php +++ b/app/vendor/phpunit/php-code-coverage/src/Test/Target/MapBuilder.php @@ -25,6 +25,7 @@ /** * @phpstan-import-type TargetMap from Mapper * @phpstan-import-type TargetMapPart from Mapper + * @phpstan-import-type ReverseLookup from Mapper * * @immutable * @@ -169,6 +170,10 @@ public function build(Filter $filter, FileAnalyser $analyser): array ]; } + /** + * @param array> $sourceData + * @param array>> $data + */ private function mergeLines(string $targetClass, array $sourceData, array &$data): void { /** @@ -195,6 +200,13 @@ private function mergeLines(string $targetClass, array $sourceData, array &$data } } + /** + * @param TargetMapPart $methods + * @param ReverseLookup $reverseLookup + * + * @param-out TargetMapPart $methods + * @param-out ReverseLookup $reverseLookup + */ private function processMethods(Class_|Trait_ $classOrTrait, string $file, array &$methods, array &$reverseLookup): void { foreach ($classOrTrait->methods() as $method) { diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/Mapper.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/Mapper.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/Mapper.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/Mapper.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/Method.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/Method.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/Method.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/Method.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/Namespace_.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/Namespace_.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/Namespace_.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/Namespace_.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/Target.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/Target.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/Target.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/Target.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/TargetCollection.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/TargetCollection.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/TargetCollection.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/TargetCollection.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/TargetCollectionIterator.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/TargetCollectionIterator.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/TargetCollectionIterator.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/TargetCollectionIterator.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/TargetCollectionValidator.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/TargetCollectionValidator.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/TargetCollectionValidator.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/TargetCollectionValidator.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/Trait_.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/Trait_.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/Trait_.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/Trait_.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/ValidationFailure.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/ValidationFailure.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/ValidationFailure.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/ValidationFailure.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/ValidationResult.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/ValidationResult.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/ValidationResult.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/ValidationResult.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Target/ValidationSuccess.php b/app/vendor/phpunit/php-code-coverage/src/Test/Target/ValidationSuccess.php similarity index 100% rename from app/vendor/phpunit/php-code-coverage/src/Target/ValidationSuccess.php rename to app/vendor/phpunit/php-code-coverage/src/Test/Target/ValidationSuccess.php diff --git a/app/vendor/phpunit/php-code-coverage/src/Test/TestSize.php b/app/vendor/phpunit/php-code-coverage/src/Test/TestSize.php new file mode 100644 index 000000000..cd101587f --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Test/TestSize.php @@ -0,0 +1,66 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Test; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +enum TestSize: string +{ + public function isKnown(): bool + { + return $this !== self::Unknown; + } + + public function isUnknown(): bool + { + return $this === self::Unknown; + } + + public function isSmall(): bool + { + return $this === self::Small; + } + + public function isMedium(): bool + { + return $this === self::Medium; + } + + public function isLarge(): bool + { + return $this === self::Large; + } + + public function isGreaterThan(self $other): bool + { + return $this->order() > $other->order(); + } + + public function asString(): string + { + return $this->value; + } + + private function order(): int + { + return match ($this) { + self::Unknown => -1, + self::Small => 0, + self::Medium => 1, + self::Large => 2, + }; + } + + case Unknown = 'unknown'; + case Small = 'small'; + case Medium = 'medium'; + case Large = 'large'; +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Test/TestStatus.php b/app/vendor/phpunit/php-code-coverage/src/Test/TestStatus.php new file mode 100644 index 000000000..4df73d2d4 --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Test/TestStatus.php @@ -0,0 +1,44 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Test; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +enum TestStatus: string +{ + public function isKnown(): bool + { + return $this !== self::Unknown; + } + + public function isUnknown(): bool + { + return $this === self::Unknown; + } + + public function isSuccess(): bool + { + return $this === self::Success; + } + + public function isFailure(): bool + { + return $this === self::Failure; + } + + public function asString(): string + { + return $this->value; + } + case Unknown = 'unknown'; + case Success = 'success'; + case Failure = 'failure'; +} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestSize/Known.php b/app/vendor/phpunit/php-code-coverage/src/TestSize/Known.php deleted file mode 100644 index 2bd72abe2..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestSize/Known.php +++ /dev/null @@ -1,23 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestSize; - -/** - * @immutable - */ -abstract class Known extends TestSize -{ - public function isKnown(): true - { - return true; - } - - abstract public function isGreaterThan(self $other): bool; -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestSize/Large.php b/app/vendor/phpunit/php-code-coverage/src/TestSize/Large.php deleted file mode 100644 index f6a1b9532..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestSize/Large.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestSize; - -/** - * @immutable - */ -final class Large extends Known -{ - public function isLarge(): true - { - return true; - } - - public function isGreaterThan(TestSize $other): bool - { - return !$other->isLarge(); - } - - public function asString(): string - { - return 'large'; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestSize/Medium.php b/app/vendor/phpunit/php-code-coverage/src/TestSize/Medium.php deleted file mode 100644 index f7fd7c86f..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestSize/Medium.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestSize; - -/** - * @immutable - */ -final class Medium extends Known -{ - public function isMedium(): true - { - return true; - } - - public function isGreaterThan(TestSize $other): bool - { - return $other->isSmall(); - } - - public function asString(): string - { - return 'medium'; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestSize/Small.php b/app/vendor/phpunit/php-code-coverage/src/TestSize/Small.php deleted file mode 100644 index 7c695ef46..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestSize/Small.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestSize; - -/** - * @immutable - */ -final class Small extends Known -{ - public function isSmall(): true - { - return true; - } - - public function isGreaterThan(TestSize $other): bool - { - return false; - } - - public function asString(): string - { - return 'small'; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestSize/TestSize.php b/app/vendor/phpunit/php-code-coverage/src/TestSize/TestSize.php deleted file mode 100644 index a2c92dcc3..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestSize/TestSize.php +++ /dev/null @@ -1,78 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestSize; - -/** - * @immutable - */ -abstract class TestSize -{ - public static function unknown(): Unknown - { - return new Unknown; - } - - public static function small(): Small - { - return new Small; - } - - public static function medium(): Medium - { - return new Medium; - } - - public static function large(): Large - { - return new Large; - } - - /** - * @phpstan-assert-if-true Known $this - */ - public function isKnown(): bool - { - return false; - } - - /** - * @phpstan-assert-if-true Unknown $this - */ - public function isUnknown(): bool - { - return false; - } - - /** - * @phpstan-assert-if-true Small $this - */ - public function isSmall(): bool - { - return false; - } - - /** - * @phpstan-assert-if-true Medium $this - */ - public function isMedium(): bool - { - return false; - } - - /** - * @phpstan-assert-if-true Large $this - */ - public function isLarge(): bool - { - return false; - } - - abstract public function asString(): string; -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestSize/Unknown.php b/app/vendor/phpunit/php-code-coverage/src/TestSize/Unknown.php deleted file mode 100644 index 92808f688..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestSize/Unknown.php +++ /dev/null @@ -1,26 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestSize; - -/** - * @immutable - */ -final class Unknown extends TestSize -{ - public function isUnknown(): true - { - return true; - } - - public function asString(): string - { - return 'unknown'; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Failure.php b/app/vendor/phpunit/php-code-coverage/src/TestStatus/Failure.php deleted file mode 100644 index a08ac3f6e..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Failure.php +++ /dev/null @@ -1,26 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestStatus; - -/** - * @immutable - */ -final class Failure extends Known -{ - public function isFailure(): true - { - return true; - } - - public function asString(): string - { - return 'failure'; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Known.php b/app/vendor/phpunit/php-code-coverage/src/TestStatus/Known.php deleted file mode 100644 index 358abe165..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Known.php +++ /dev/null @@ -1,21 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestStatus; - -/** - * @immutable - */ -abstract class Known extends TestStatus -{ - public function isKnown(): true - { - return true; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Success.php b/app/vendor/phpunit/php-code-coverage/src/TestStatus/Success.php deleted file mode 100644 index 55f84a6b2..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Success.php +++ /dev/null @@ -1,26 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestStatus; - -/** - * @immutable - */ -final class Success extends Known -{ - public function isSuccess(): true - { - return true; - } - - public function asString(): string - { - return 'success'; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestStatus/TestStatus.php b/app/vendor/phpunit/php-code-coverage/src/TestStatus/TestStatus.php deleted file mode 100644 index c8015992f..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestStatus/TestStatus.php +++ /dev/null @@ -1,65 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestStatus; - -/** - * @immutable - */ -abstract class TestStatus -{ - public static function unknown(): self - { - return new Unknown; - } - - public static function success(): self - { - return new Success; - } - - public static function failure(): self - { - return new Failure; - } - - /** - * @phpstan-assert-if-true Known $this - */ - public function isKnown(): bool - { - return false; - } - - /** - * @phpstan-assert-if-true Unknown $this - */ - public function isUnknown(): bool - { - return false; - } - - /** - * @phpstan-assert-if-true Success $this - */ - public function isSuccess(): bool - { - return false; - } - - /** - * @phpstan-assert-if-true Failure $this - */ - public function isFailure(): bool - { - return false; - } - - abstract public function asString(): string; -} diff --git a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Unknown.php b/app/vendor/phpunit/php-code-coverage/src/TestStatus/Unknown.php deleted file mode 100644 index ecde844dd..000000000 --- a/app/vendor/phpunit/php-code-coverage/src/TestStatus/Unknown.php +++ /dev/null @@ -1,26 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\CodeCoverage\Test\TestStatus; - -/** - * @immutable - */ -final class Unknown extends TestStatus -{ - public function isUnknown(): true - { - return true; - } - - public function asString(): string - { - return 'unknown'; - } -} diff --git a/app/vendor/phpunit/php-code-coverage/src/UnintentionallyCoveredCodeChecker.php b/app/vendor/phpunit/php-code-coverage/src/UnintentionallyCoveredCodeChecker.php new file mode 100644 index 000000000..4b6f87c93 --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/UnintentionallyCoveredCodeChecker.php @@ -0,0 +1,179 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage; + +use function array_flip; +use function array_keys; +use function array_merge; +use function array_unique; +use function count; +use function explode; +use function sort; +use ReflectionClass; +use SebastianBergmann\CodeCoverage\Data\RawCodeCoverageData; +use SebastianBergmann\CodeCoverage\Test\Target\Mapper; +use SebastianBergmann\CodeCoverage\Test\Target\Method; +use SebastianBergmann\CodeCoverage\Test\Target\TargetCollection; + +/** + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @phpstan-import-type TargetedLines from CodeCoverage + */ +final readonly class UnintentionallyCoveredCodeChecker +{ + /** + * @param TargetedLines $linesToBeCovered + * @param TargetedLines $linesToBeUsed + * @param list $parentClassesExcludedFromCheck + * + * @throws ReflectionException + * @throws UnintentionallyCoveredCodeException + */ + public function check(RawCodeCoverageData $data, array $linesToBeCovered, array $linesToBeUsed, Mapper $targetMapper, array $parentClassesExcludedFromCheck, TargetCollection $covers, TargetCollection $uses): true + { + $allowedLines = $this->allowedLines( + $linesToBeCovered, + $linesToBeUsed, + ); + + $unintentionallyCoveredUnits = []; + + foreach ($data->lineCoverage() as $file => $_data) { + foreach ($_data as $line => $flag) { + if ($flag === 1 && !isset($allowedLines[$file][$line])) { + $unintentionallyCoveredUnits[] = $targetMapper->lookup($file, $line); + } + } + } + + $unintentionallyCoveredUnits = $this->process( + $unintentionallyCoveredUnits, + $parentClassesExcludedFromCheck, + $this->hasMethodLevelTargets($covers, $uses), + ); + + if ($unintentionallyCoveredUnits !== []) { + throw new UnintentionallyCoveredCodeException( + $unintentionallyCoveredUnits, + ); + } + + return true; + } + + /** + * @param list $unintentionallyCoveredUnits + * @param list $parentClassesExcludedFromCheck + * + * @throws ReflectionException + * + * @return list + */ + public function process(array $unintentionallyCoveredUnits, array $parentClassesExcludedFromCheck, bool $methodLevelReporting = false): array + { + $unintentionallyCoveredUnits = array_unique($unintentionallyCoveredUnits); + $processed = []; + + foreach ($unintentionallyCoveredUnits as $unintentionallyCoveredUnit) { + $tmp = explode('::', $unintentionallyCoveredUnit); + + if (count($tmp) !== 2) { + $processed[] = $unintentionallyCoveredUnit; + + continue; + } + + try { + $class = new ReflectionClass($tmp[0]); + + foreach ($parentClassesExcludedFromCheck as $parentClass) { + if ($class->isSubclassOf($parentClass)) { + continue 2; + } + } + } catch (\ReflectionException $e) { + throw new ReflectionException( + $e->getMessage(), + $e->getCode(), + $e, + ); + } + + if ($methodLevelReporting) { + $processed[] = $unintentionallyCoveredUnit; + } else { + $processed[] = $tmp[0]; + } + } + + $processed = array_unique($processed); + + sort($processed); + + return $processed; + } + + /** + * @param TargetedLines $linesToBeCovered + * @param TargetedLines $linesToBeUsed + * + * @return TargetedLines + */ + public function allowedLines(array $linesToBeCovered, array $linesToBeUsed): array + { + $allowedLines = []; + + foreach (array_keys($linesToBeCovered) as $file) { + if (!isset($allowedLines[$file])) { + $allowedLines[$file] = []; + } + + $allowedLines[$file] = array_merge( + $allowedLines[$file], + $linesToBeCovered[$file], + ); + } + + foreach (array_keys($linesToBeUsed) as $file) { + if (!isset($allowedLines[$file])) { + $allowedLines[$file] = []; + } + + $allowedLines[$file] = array_merge( + $allowedLines[$file], + $linesToBeUsed[$file], + ); + } + + foreach (array_keys($allowedLines) as $file) { + $allowedLines[$file] = array_flip( + array_unique($allowedLines[$file]), + ); + } + + return $allowedLines; + } + + private function hasMethodLevelTargets(TargetCollection $covers, TargetCollection $uses): bool + { + foreach ([$covers, $uses] as $targets) { + foreach ($targets as $target) { + if ($target instanceof Method) { + return true; + } + } + } + + return false; + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Util/EnsuresUtf8.php b/app/vendor/phpunit/php-code-coverage/src/Util/EnsuresUtf8.php new file mode 100644 index 000000000..f90763c93 --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Util/EnsuresUtf8.php @@ -0,0 +1,36 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Util; + +use function assert; +use function mb_check_encoding; +use function mb_convert_encoding; +use function mb_detect_encoding; + +/** + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +trait EnsuresUtf8 +{ + private function ensureUtf8(string $value): string + { + if (mb_check_encoding($value, 'UTF-8')) { + return $value; + } + + $encoding = mb_detect_encoding($value, ['Windows-1252', 'ISO-8859-1'], true); + + assert($encoding !== false); + + return mb_convert_encoding($value, 'UTF-8', $encoding); + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Util/Filesystem.php b/app/vendor/phpunit/php-code-coverage/src/Util/Filesystem.php index 0e99b1593..df2113eab 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Util/Filesystem.php +++ b/app/vendor/phpunit/php-code-coverage/src/Util/Filesystem.php @@ -9,12 +9,18 @@ */ namespace SebastianBergmann\CodeCoverage\Util; +use function dirname; +use function file_put_contents; use function is_dir; use function mkdir; use function sprintf; +use function str_contains; +use SebastianBergmann\CodeCoverage\WriteOperationFailedException; /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final class Filesystem { @@ -34,4 +40,20 @@ public static function createDirectory(string $directory): void ); } } + + /** + * @param non-empty-string $target + * + * @throws WriteOperationFailedException + */ + public static function write(string $target, string $buffer): void + { + if (!str_contains($target, '://')) { + self::createDirectory(dirname($target)); + } + + if (@file_put_contents($target, $buffer) === false) { + throw new WriteOperationFailedException($target); + } + } } diff --git a/app/vendor/phpunit/php-code-coverage/src/Util/PathReducer.php b/app/vendor/phpunit/php-code-coverage/src/Util/PathReducer.php new file mode 100644 index 000000000..79a546103 --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Util/PathReducer.php @@ -0,0 +1,111 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Util; + +use const DIRECTORY_SEPARATOR; +use function array_shift; +use function basename; +use function count; +use function dirname; +use function explode; +use function implode; +use function str_replace; +use function str_starts_with; +use function substr; +use SebastianBergmann\CodeCoverage\Data\ProcessedCodeCoverageData; + +/** + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final class PathReducer +{ + /** + * Reduces the paths by cutting the longest common start path, renames the + * files in the coverage data accordingly, and returns the common path. + * + * Returns an empty string when there are no covered files. + */ + public function reduce(ProcessedCodeCoverageData $data): string + { + $coveredFiles = $data->coveredFiles(); + + if ($coveredFiles === []) { + return ''; + } + + if (count($coveredFiles) === 1) { + $file = $coveredFiles[0]; + $normalised = $file; + + if (str_starts_with($file, 'phar://')) { + $normalised = str_replace('/', DIRECTORY_SEPARATOR, substr($file, 7)); + } + + $data->renameFile($file, basename($normalised)); + + return dirname($normalised); + } + + $original = $coveredFiles; + $paths = $coveredFiles; + $max = count($paths); + + for ($i = 0; $i < $max; $i++) { + if (str_starts_with($paths[$i], 'phar://')) { + $paths[$i] = substr($paths[$i], 7); + $paths[$i] = str_replace('/', DIRECTORY_SEPARATOR, $paths[$i]); + } + + $paths[$i] = explode(DIRECTORY_SEPARATOR, $paths[$i]); + + if ($paths[$i][0] === '') { + $paths[$i][0] = DIRECTORY_SEPARATOR; + } + } + + $commonPath = ''; + $done = false; + + while (!$done) { + for ($i = 0; $i < $max - 1; $i++) { + if (!isset($paths[$i][0]) || !isset($paths[$i + 1][0]) || + $paths[$i][0] !== $paths[$i + 1][0]) { + $done = true; + + break; + } + } + + if (!$done) { + $commonPath .= $paths[0][0]; + + if ($paths[0][0] !== DIRECTORY_SEPARATOR) { + $commonPath .= DIRECTORY_SEPARATOR; + } + + for ($i = 0; $i < $max; $i++) { + array_shift($paths[$i]); + } + } + } + + for ($i = 0; $i < $max; $i++) { + $newPath = implode(DIRECTORY_SEPARATOR, $paths[$i]); + + if ($newPath !== $original[$i]) { + $data->renameFile($original[$i], $newPath); + } + } + + return substr($commonPath, 0, -1); + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Util/Percentage.php b/app/vendor/phpunit/php-code-coverage/src/Util/Percentage.php index 1de640f80..d4f556c45 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Util/Percentage.php +++ b/app/vendor/phpunit/php-code-coverage/src/Util/Percentage.php @@ -13,6 +13,8 @@ /** * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage */ final readonly class Percentage { diff --git a/app/vendor/phpunit/php-code-coverage/src/Util/Xml.php b/app/vendor/phpunit/php-code-coverage/src/Util/Xml.php new file mode 100644 index 000000000..8a21ece4a --- /dev/null +++ b/app/vendor/phpunit/php-code-coverage/src/Util/Xml.php @@ -0,0 +1,57 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\CodeCoverage\Util; + +use const PHP_EOL; +use function libxml_clear_errors; +use function libxml_get_errors; +use function libxml_use_internal_errors; +use DOMDocument; +use SebastianBergmann\CodeCoverage\XmlException; + +/** + * @internal This class is not covered by the backward compatibility promise for phpunit/php-code-coverage + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ +final readonly class Xml +{ + /** + * @throws XmlException + * + * @see https://bugs.php.net/bug.php?id=79191 + */ + public static function asString(DOMDocument $document): string + { + $xmlErrorHandling = libxml_use_internal_errors(true); + + $document->formatOutput = true; + $document->preserveWhiteSpace = false; + + $buffer = $document->saveXML(); + + if ($buffer === false) { + // @codeCoverageIgnoreStart + $message = 'Unable to generate the XML'; + + foreach (libxml_get_errors() as $error) { + $message .= PHP_EOL . $error->message; + } + + throw new XmlException($message); + // @codeCoverageIgnoreEnd + } + + libxml_clear_errors(); + libxml_use_internal_errors($xmlErrorHandling); + + return $buffer; + } +} diff --git a/app/vendor/phpunit/php-code-coverage/src/Version.php b/app/vendor/phpunit/php-code-coverage/src/Version.php index df26baa9e..03e33720d 100644 --- a/app/vendor/phpunit/php-code-coverage/src/Version.php +++ b/app/vendor/phpunit/php-code-coverage/src/Version.php @@ -12,6 +12,9 @@ use function dirname; use SebastianBergmann\Version as VersionId; +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for phpunit/php-code-coverage + */ final class Version { private static string $version = ''; @@ -19,7 +22,7 @@ final class Version public static function id(): string { if (self::$version === '') { - self::$version = (new VersionId('12.3.6', dirname(__DIR__)))->asString(); + self::$version = new VersionId('14.1.9', dirname(__DIR__))->asString(); } return self::$version; diff --git a/app/vendor/phpunit/php-file-iterator/ChangeLog.md b/app/vendor/phpunit/php-file-iterator/ChangeLog.md index a0fa134a5..59d53f4f1 100644 --- a/app/vendor/phpunit/php-file-iterator/ChangeLog.md +++ b/app/vendor/phpunit/php-file-iterator/ChangeLog.md @@ -2,12 +2,30 @@ All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/). +## [7.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + +## [6.0.1] - 2026-02-02 + +### Fixed + +* [#84](https://github.com/sebastianbergmann/php-file-iterator/issues/84): `Factory` drops directories during wildcard resolution + ## [6.0.0] - 2025-02-07 ### Removed * This component is no longer supported on PHP 8.2 +## [5.1.1] - 2026-02-02 + +### Fixed + +* [#84](https://github.com/sebastianbergmann/php-file-iterator/issues/84): `Factory` drops directories during wildcard resolution + ## [5.1.0] - 2024-08-27 ### Added @@ -174,7 +192,10 @@ No changes * [#23](https://github.com/sebastianbergmann/php-file-iterator/pull/23): Added support for wildcards (glob) in exclude +[7.0.0]: https://github.com/sebastianbergmann/php-file-iterator/compare/6.0...7.0.0 +[6.0.1]: https://github.com/sebastianbergmann/php-file-iterator/compare/6.0.0...6.0.1 [6.0.0]: https://github.com/sebastianbergmann/php-file-iterator/compare/5.1...6.0.0 +[5.1.1]: https://github.com/sebastianbergmann/php-file-iterator/compare/5.1.0...5.1.1 [5.1.0]: https://github.com/sebastianbergmann/php-file-iterator/compare/5.0.1...5.1.0 [5.0.1]: https://github.com/sebastianbergmann/php-file-iterator/compare/5.0.0...5.0.1 [5.0.0]: https://github.com/sebastianbergmann/php-file-iterator/compare/4.1...5.0.0 diff --git a/app/vendor/phpunit/php-file-iterator/LICENSE b/app/vendor/phpunit/php-file-iterator/LICENSE index 017eb48b1..0dffde94d 100644 --- a/app/vendor/phpunit/php-file-iterator/LICENSE +++ b/app/vendor/phpunit/php-file-iterator/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2009-2025, Sebastian Bergmann +Copyright (c) 2009-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/phpunit/php-file-iterator/composer.json b/app/vendor/phpunit/php-file-iterator/composer.json index 528f298ba..76fdb2d8c 100644 --- a/app/vendor/phpunit/php-file-iterator/composer.json +++ b/app/vendor/phpunit/php-file-iterator/composer.json @@ -21,17 +21,17 @@ }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "prefer-stable": true, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "autoload": { "classmap": [ @@ -40,7 +40,7 @@ }, "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } } } diff --git a/app/vendor/phpunit/php-file-iterator/src/ExcludeIterator.php b/app/vendor/phpunit/php-file-iterator/src/ExcludeIterator.php index 209ec00f5..b521f1921 100644 --- a/app/vendor/phpunit/php-file-iterator/src/ExcludeIterator.php +++ b/app/vendor/phpunit/php-file-iterator/src/ExcludeIterator.php @@ -9,6 +9,7 @@ */ namespace SebastianBergmann\FileIterator; +use function array_all; use function assert; use function str_starts_with; use RecursiveDirectoryIterator; @@ -47,13 +48,7 @@ public function accept(): bool return false; } - foreach ($this->exclude as $exclude) { - if (str_starts_with($path, $exclude)) { - return false; - } - } - - return true; + return array_all($this->exclude, static fn (string $exclude) => !str_starts_with($path, $exclude)); } public function hasChildren(): bool diff --git a/app/vendor/phpunit/php-file-iterator/src/Factory.php b/app/vendor/phpunit/php-file-iterator/src/Factory.php index da53df923..75015a84c 100644 --- a/app/vendor/phpunit/php-file-iterator/src/Factory.php +++ b/app/vendor/phpunit/php-file-iterator/src/Factory.php @@ -9,6 +9,7 @@ */ namespace SebastianBergmann\FileIterator; +use const DIRECTORY_SEPARATOR; use const GLOB_ONLYDIR; use function array_filter; use function array_map; @@ -20,6 +21,7 @@ use function is_string; use function realpath; use function sort; +use function str_ends_with; use function stripos; use function substr; use AppendIterator; @@ -98,11 +100,32 @@ private function resolveWildcards(array $paths): array $_paths = [[]]; foreach ($paths as $path) { - if ($locals = $this->globstar($path)) { - $_paths[] = array_map('\realpath', $locals); + $pathEndsWithDirectorySeparator = str_ends_with($path, '/') || str_ends_with($path, DIRECTORY_SEPARATOR); + $locals = $this->globstar($path); + + if ($locals !== []) { + $_paths[] = array_map( + static function (string $local) use ($pathEndsWithDirectorySeparator): string|false + { + $realPath = realpath($local); + + if ($realPath !== false && $pathEndsWithDirectorySeparator && is_dir($realPath)) { + return $realPath . DIRECTORY_SEPARATOR; + } + + return $realPath; + }, + $locals, + ); } else { // @codeCoverageIgnoreStart - $_paths[] = [realpath($path)]; + $realPath = realpath($path); + + if ($realPath !== false && $pathEndsWithDirectorySeparator && is_dir($realPath)) { + $_paths[] = [$realPath . DIRECTORY_SEPARATOR]; + } else { + $_paths[] = [$realPath]; + } // @codeCoverageIgnoreEnd } } diff --git a/app/vendor/phpunit/php-file-iterator/src/Iterator.php b/app/vendor/phpunit/php-file-iterator/src/Iterator.php index b29f235a3..9f06f474e 100644 --- a/app/vendor/phpunit/php-file-iterator/src/Iterator.php +++ b/app/vendor/phpunit/php-file-iterator/src/Iterator.php @@ -9,6 +9,7 @@ */ namespace SebastianBergmann\FileIterator; +use function array_any; use function preg_match; use function realpath; use function str_ends_with; @@ -72,7 +73,7 @@ public function accept(): bool private function acceptPath(string $path): bool { // Filter files in hidden directories by checking path that is relative to the base path. - if (preg_match('=/\.[^/]*/=', str_replace((string) $this->basePath, '', $path))) { + if (preg_match('=/\.[^/]*/=', str_replace((string) $this->basePath, '', $path)) === 1) { return false; } @@ -94,17 +95,11 @@ private function acceptSuffix(string $filename): bool */ private function acceptSubString(string $filename, array $subStrings, int $type): bool { - if (empty($subStrings)) { + if ($subStrings === []) { return true; } - foreach ($subStrings as $string) { - if (($type === self::PREFIX && str_starts_with($filename, $string)) || - ($type === self::SUFFIX && str_ends_with($filename, $string))) { - return true; - } - } - - return false; + return array_any($subStrings, static fn (string $string) => ($type === self::PREFIX && str_starts_with($filename, $string)) || + ($type === self::SUFFIX && str_ends_with($filename, $string))); } } diff --git a/app/vendor/phpunit/php-invoker/ChangeLog.md b/app/vendor/phpunit/php-invoker/ChangeLog.md index 9af1807a6..c7816ce0b 100644 --- a/app/vendor/phpunit/php-invoker/ChangeLog.md +++ b/app/vendor/phpunit/php-invoker/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. +## [7.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [6.0.0] - 2025-02-07 ### Removed @@ -65,6 +71,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * This component is no longer supported on PHP 7.1 and PHP 7.2 +[7.0.0]: https://github.com/sebastianbergmann/php-invoker/compare/6.0...7.0.0 [6.0.0]: https://github.com/sebastianbergmann/php-invoker/compare/5.0...6.0.0 [5.0.1]: https://github.com/sebastianbergmann/php-invoker/compare/5.0.1...5.0.1 [5.0.0]: https://github.com/sebastianbergmann/php-invoker/compare/4.0...5.0.0 diff --git a/app/vendor/phpunit/php-invoker/LICENSE b/app/vendor/phpunit/php-invoker/LICENSE index 9d94d32e4..968b2d0f4 100644 --- a/app/vendor/phpunit/php-invoker/LICENSE +++ b/app/vendor/phpunit/php-invoker/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2011-2025, Sebastian Bergmann +Copyright (c) 2011-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/phpunit/php-invoker/composer.json b/app/vendor/phpunit/php-invoker/composer.json index b5bd9b85f..5a0644102 100644 --- a/app/vendor/phpunit/php-invoker/composer.json +++ b/app/vendor/phpunit/php-invoker/composer.json @@ -21,17 +21,17 @@ "prefer-stable": true, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { "ext-pcntl": "*", - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "autoload": { "classmap": [ @@ -48,7 +48,7 @@ }, "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } } } diff --git a/app/vendor/phpunit/php-text-template/.psalm/baseline.xml b/app/vendor/phpunit/php-text-template/.psalm/baseline.xml deleted file mode 100644 index 1f9a5e312..000000000 --- a/app/vendor/phpunit/php-text-template/.psalm/baseline.xml +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/app/vendor/phpunit/php-text-template/.psalm/config.xml b/app/vendor/phpunit/php-text-template/.psalm/config.xml deleted file mode 100644 index 343cc8e3e..000000000 --- a/app/vendor/phpunit/php-text-template/.psalm/config.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/phpunit/php-text-template/ChangeLog.md b/app/vendor/phpunit/php-text-template/ChangeLog.md index ff91aa434..eb4f44ede 100644 --- a/app/vendor/phpunit/php-text-template/ChangeLog.md +++ b/app/vendor/phpunit/php-text-template/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. +## [6.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [5.0.0] - 2025-02-07 ### Removed @@ -67,6 +73,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Removed support for PHP 5.3, PHP 5.4, PHP 5.5, PHP 5.6, PHP 7.0, PHP 7.1, and PHP 7.2 +[6.0.0]: https://github.com/sebastianbergmann/php-text-template/compare/5.0...6.0.0 [5.0.0]: https://github.com/sebastianbergmann/php-text-template/compare/4.0...5.0.0 [4.0.1]: https://github.com/sebastianbergmann/php-text-template/compare/4.0.0...4.0.1 [4.0.0]: https://github.com/sebastianbergmann/php-text-template/compare/3.0...4.0.0 diff --git a/app/vendor/phpunit/php-text-template/LICENSE b/app/vendor/phpunit/php-text-template/LICENSE index 017eb48b1..0dffde94d 100644 --- a/app/vendor/phpunit/php-text-template/LICENSE +++ b/app/vendor/phpunit/php-text-template/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2009-2025, Sebastian Bergmann +Copyright (c) 2009-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/phpunit/php-text-template/composer.json b/app/vendor/phpunit/php-text-template/composer.json index f7a5ae77a..22ee300d4 100644 --- a/app/vendor/phpunit/php-text-template/composer.json +++ b/app/vendor/phpunit/php-text-template/composer.json @@ -20,17 +20,17 @@ }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "prefer-stable": true, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "autoload": { "classmap": [ @@ -39,7 +39,7 @@ }, "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "6.0-dev" } } } diff --git a/app/vendor/phpunit/php-text-template/src/Template.php b/app/vendor/phpunit/php-text-template/src/Template.php index c062a0cdf..25ed916ca 100644 --- a/app/vendor/phpunit/php-text-template/src/Template.php +++ b/app/vendor/phpunit/php-text-template/src/Template.php @@ -59,7 +59,7 @@ public function __construct(string $templateFile, string $openDelimiter = '{', s */ public function setVar(array $values, bool $merge = true): void { - if (!$merge || empty($this->values)) { + if (!$merge || $this->values === []) { $this->values = $values; return; @@ -84,7 +84,7 @@ public function render(): string */ public function renderTo(string $target): void { - if (!@file_put_contents($target, $this->render())) { + if (@file_put_contents($target, $this->render()) === false) { throw new RuntimeException( sprintf( 'Writing rendered result to "%s" failed', @@ -106,7 +106,7 @@ private function loadTemplateFile(string $file): string if (is_file($file)) { $template = file_get_contents($file); - if (is_string($template) && !empty($template)) { + if (is_string($template) && $template !== '') { return $template; } } @@ -116,7 +116,7 @@ private function loadTemplateFile(string $file): string if (is_file($distFile)) { $template = file_get_contents($distFile); - if (is_string($template) && !empty($template)) { + if (is_string($template) && $template !== '') { return $template; } } diff --git a/app/vendor/phpunit/php-timer/ChangeLog.md b/app/vendor/phpunit/php-timer/ChangeLog.md index e103064ef..5dafd0ade 100644 --- a/app/vendor/phpunit/php-timer/ChangeLog.md +++ b/app/vendor/phpunit/php-timer/ChangeLog.md @@ -2,11 +2,17 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. +## [9.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [8.0.0] - 2025-02-07 ### Removed -* This component is no longer supported on PHP 8.1 +* This component is no longer supported on PHP 8.2 ## [7.0.1] - 2024-07-03 @@ -145,6 +151,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * This component is no longer supported on PHP 5.3, PHP 5.4, PHP 5.5, PHP 5.6, and PHP 7.0 +[9.0.0]: https://github.com/sebastianbergmann/php-timer/compare/8.0...9.0.0 [8.0.0]: https://github.com/sebastianbergmann/php-timer/compare/7.0...8.0.0 [7.0.1]: https://github.com/sebastianbergmann/php-timer/compare/7.0.0...7.0.1 [7.0.0]: https://github.com/sebastianbergmann/php-timer/compare/6.0...7.0.0 diff --git a/app/vendor/phpunit/php-timer/LICENSE b/app/vendor/phpunit/php-timer/LICENSE index fd52ce618..c93851eef 100644 --- a/app/vendor/phpunit/php-timer/LICENSE +++ b/app/vendor/phpunit/php-timer/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2010-2025, Sebastian Bergmann +Copyright (c) 2010-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/phpunit/php-timer/composer.json b/app/vendor/phpunit/php-timer/composer.json index 89c398425..5eac8b21e 100644 --- a/app/vendor/phpunit/php-timer/composer.json +++ b/app/vendor/phpunit/php-timer/composer.json @@ -20,14 +20,14 @@ }, "prefer-stable": true, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true @@ -39,7 +39,7 @@ }, "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "9.0-dev" } } } diff --git a/app/vendor/phpunit/php-timer/src/Timer.php b/app/vendor/phpunit/php-timer/src/Timer.php index d59eef639..05dec9de3 100644 --- a/app/vendor/phpunit/php-timer/src/Timer.php +++ b/app/vendor/phpunit/php-timer/src/Timer.php @@ -29,7 +29,7 @@ public function start(): void */ public function stop(): Duration { - if (empty($this->startTimes)) { + if ($this->startTimes === []) { throw new NoActiveTimerException( 'Timer::start() has to be called before Timer::stop()', ); diff --git a/app/vendor/phpunit/phpunit/ChangeLog-12.3.md b/app/vendor/phpunit/phpunit/ChangeLog-12.3.md deleted file mode 100644 index b0e41f3ca..000000000 --- a/app/vendor/phpunit/phpunit/ChangeLog-12.3.md +++ /dev/null @@ -1,108 +0,0 @@ -# Changes in PHPUnit 12.3 - -All notable changes of the PHPUnit 12.3 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. - -## [12.3.8] - 2025-09-03 - -### Fixed - -* [#6340](https://github.com/sebastianbergmann/phpunit/issues/6340): Implicitly enabled display of deprecation details is not disabled when it should be - -## [12.3.7] - 2025-08-28 - -### Changed - -* `#[IgnorePhpunitDeprecations]` is now considered for test runner deprecations (where applicable) - -## [12.3.6] - 2025-08-20 - -### Changed - -* Do not configure `report_memleaks` setting (which will be deprecated in PHP 8.5) for PHPT processes - -## [12.3.5] - 2025-08-16 - -### Changed - -* [#6319](https://github.com/sebastianbergmann/phpunit/issues/6319): Detect premature end of PHPUnit's main PHP process -* [#6321](https://github.com/sebastianbergmann/phpunit/issues/6321): Allow `error_reporting=E_ALL` for `--check-php-configuration` - -### Fixed - -* [#5863](https://github.com/sebastianbergmann/phpunit/issues/5863): TestDox printer does not show previous exception -* [#6102](https://github.com/sebastianbergmann/phpunit/issues/6102): `expectUserDeprecationMessage*()` fails when test is run in separate process - -## [12.3.4] - 2025-08-12 - -### Changed - -* [#6308](https://github.com/sebastianbergmann/phpunit/pull/6308): Improve output of `--check-php-configuration` -* The version number for the test result cache file has been incremented to reflect that its structure for PHPUnit 12.3 is not compatible with its structure for PHPUnit 8.5 and PHPUnit 9.6 - -### Fixed - -* [#6197](https://github.com/sebastianbergmann/phpunit/issues/6197): `ini_set('error_log')` sets filepath outside `open_basedir` -* [#6279](https://github.com/sebastianbergmann/phpunit/issues/6279): Deprecation triggered in data provider method affects all test methods using that data provider method -* [#6281](https://github.com/sebastianbergmann/phpunit/issues/6281): Exceptions raised in after-test method are not reported for skipped tests - -## [12.3.3] - 2025-08-11 - -### Fixed - -* [#6304](https://github.com/sebastianbergmann/phpunit/issues/6304): PHPUnit 11.5.29 hangs when a test runner deprecation is triggered and process isolation is used (this reverts "`#[IgnorePhpunitDeprecations]` is now considered for test runner deprecations" from PHPUnit 12.3.1) - -## [12.3.2] - 2025-08-10 - -### Changed - -* [#6300](https://github.com/sebastianbergmann/phpunit/issues/6300): Emit warning when the name of a data provider method begins with `test` -* Do not use `SplObjectStorage` methods that will be deprecated in PHP 8.5 - -## [12.3.1] - 2025-08-09 - -### Added - -* [#6297](https://github.com/sebastianbergmann/phpunit/issues/6297): `--check-php-configuration` CLI option for checking whether PHP is configured for testing - -### Changed - -* `#[IgnorePhpunitDeprecations]` is now considered for test runner deprecations (where applicable) - -### Fixed - -* [#6160](https://github.com/sebastianbergmann/phpunit/issues/6160): Baseline file in a subdirectory contains absolute paths -* [#6294](https://github.com/sebastianbergmann/phpunit/issues/6294): Silent failure of PHP fatal errors -* Errors due to invalid data provided using `#[TestWith]` or `#[TestWithJson]` attributes are now properly reported -* The `DataProviderMethodFinished` event is now also emitted when the provided data set has an invalid key - -## [12.3.0] - 2025-08-01 - -### Added - -* [#3795](https://github.com/sebastianbergmann/phpunit/issues/3795): Bootstrap scripts specific to test suites -* [#6268](https://github.com/sebastianbergmann/phpunit/pull/6268): `#[IgnorePHPUnitWarnings]` attribute for ignoring PHPUnit warnings -* `#[TestDoxFormatter]` and `#[TestDoxFormatterExternal]` attributes for configuring a custom TestDox formatter for tests that use data from data providers -* `TestRunner\ChildProcessErrored` event -* `Configuration::includeTestSuites()` and `Configuration::excludeTestSuites()` - -### Changed - -* [#6237](https://github.com/sebastianbergmann/phpunit/issues/6237): Do not run tests when code coverage analysis is requested but code coverage data cannot be collected -* [#6272](https://github.com/sebastianbergmann/phpunit/issues/6272): Use `@` format (compatible with `--filter` CLI option) in defect messages -* [#6273](https://github.com/sebastianbergmann/phpunit/pull/6273): Warn when `#[DataProvider*]` attributes are mixed with `#[TestWith*]` attributes - -### Deprecated - -* [#6229](https://github.com/sebastianbergmann/phpunit/issues/6229): `Configuration::includeTestSuite()`, use `Configuration::includeTestSuites()` instead -* [#6229](https://github.com/sebastianbergmann/phpunit/issues/6229): `Configuration::excludeTestSuite()`, use `Configuration::excludeTestSuites()` instead -* [#6246](https://github.com/sebastianbergmann/phpunit/issues/6246): Using `#[CoversNothing]` on a test method - -[12.3.8]: https://github.com/sebastianbergmann/phpunit/compare/12.3.7...12.3.8 -[12.3.7]: https://github.com/sebastianbergmann/phpunit/compare/12.3.6...12.3.7 -[12.3.6]: https://github.com/sebastianbergmann/phpunit/compare/12.3.5...12.3.6 -[12.3.5]: https://github.com/sebastianbergmann/phpunit/compare/12.3.4...12.3.5 -[12.3.4]: https://github.com/sebastianbergmann/phpunit/compare/12.3.3...12.3.4 -[12.3.3]: https://github.com/sebastianbergmann/phpunit/compare/12.3.2...12.3.3 -[12.3.2]: https://github.com/sebastianbergmann/phpunit/compare/12.3.1...12.3.2 -[12.3.1]: https://github.com/sebastianbergmann/phpunit/compare/12.3.0...12.3.1 -[12.3.0]: https://github.com/sebastianbergmann/phpunit/compare/12.2.9...12.3.0 diff --git a/app/vendor/phpunit/phpunit/ChangeLog-13.1.md b/app/vendor/phpunit/phpunit/ChangeLog-13.1.md new file mode 100644 index 000000000..7954796b9 --- /dev/null +++ b/app/vendor/phpunit/phpunit/ChangeLog-13.1.md @@ -0,0 +1,145 @@ +# Changes in PHPUnit 13.1 + +All notable changes of the PHPUnit 13.1 release series are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. + +## [13.1.11] - 2026-05-21 + +### Fixed + +* PHP setting values containing `=` need to be quoted before forwarding via `-d` + +## [13.1.10] - 2026-05-15 + +### Changed + +* Pass configuration options introduced in sebastian/diff 8.3.0 + +## [13.1.9] - 2026-05-13 + +### Changed + +* A `Test` or `Tests` prefix is no longer stripped from class names when they are processed for TestDox output + +### Fixed + +* [#6605](https://github.com/sebastianbergmann/phpunit/issues/6605): Data set names and provider values containing Unicode bidirectional control characters distort terminal output +* [#6610](https://github.com/sebastianbergmann/phpunit/issues/6610): Per-testsuite bootstrap script not loaded in process isolation +* TestDox output collapsed separate test classes into a single group when their prettified class names matched + +## [13.1.8] - 2026-05-01 + +### Fixed + +* [#6595](https://github.com/sebastianbergmann/phpunit/issues/6595): Crash when before-class or after-class method fails with assertion failure +* [#6599](https://github.com/sebastianbergmann/phpunit/issues/6599): TeamCity logger does not wrap failures in before-test methods with `testStarted` and `testFinished` +* [#6601](https://github.com/sebastianbergmann/phpunit/issues/6601): Anonymous classes are not rejected with a clear error when creating a test double +* [#6603](https://github.com/sebastianbergmann/phpunit/issues/6603): `assertArrays*IgnoringOrder()` fails on mixed scalar types and on reordered nested associative arrays +* `MockBuilder::setMockClassName()` and `TestStubBuilder::setStubClassName()` now reject values that are not valid unqualified PHP class identifiers, throwing the new `InvalidClassNameException` +* The regular expression used by `Generator::ensureValidMethods()` to validate method names passed to `MockBuilder::onlyMethods()` and `addMethods()` was not anchored, so any string containing a valid identifier substring (including strings with parentheses, braces, comments, or newlines) was accepted + +## [13.1.7] - 2026-04-18 + +### Changed + +* Pass `LIBXML_NONET` when parsing/validating XML configuration files to make explicit that no network I/O is performed +* Verify the result file written by an isolated child process with a random nonce before deserializing it + +## [13.1.6] - 2026-04-17 + +### Fixed + +* [#6590](https://github.com/sebastianbergmann/phpunit/issues/6590): Silent failure when configuration file is invalid +* [#6592](https://github.com/sebastianbergmann/phpunit/pull/6592): INI metacharacters `;` and `"` are not preserved when forwarding settings to child processes + +## [13.1.5] - 2026-04-16 + +### Fixed + +* [#5860](https://github.com/sebastianbergmann/phpunit/issues/5860): PHP CLI `-d` settings are not forwarded to child processes for process isolation +* [#6451](https://github.com/sebastianbergmann/phpunit/issues/6451): Incomplete version in `RequiresPhp` (e.g. `<=8.5`) is compared against full PHP version, causing unexpected skips +* [#6589](https://github.com/sebastianbergmann/phpunit/issues/6589): `dataSetAsStringWithData()` raises "float is not representable as int" warning for large floats in data sets + +## [13.1.4] - 2026-04-15 + +### Fixed + +* [#5993](https://github.com/sebastianbergmann/phpunit/issues/5993): `DefaultJobRunner` deadlocks on child processes that write large amounts of stderr output +* [#6465](https://github.com/sebastianbergmann/phpunit/issues/6465): SAPI-populated `$_SERVER` entries leak from parent into child process +* [#6587](https://github.com/sebastianbergmann/phpunit/issues/6587): `failOnEmptyTestSuite="false"` in `phpunit.xml` is ignored when `--group`/`--filter`/`--testsuite` matches no tests +* [#6588](https://github.com/sebastianbergmann/phpunit/issues/6588): Order of issue baseline entries is not canonicalized + +## [13.1.3] - 2026-04-13 + +### Fixed + +* Regression in XML configuration migration introduced in PHPUnit 12.5.8 + +## [13.1.2] - 2026-04-13 + +### Fixed + +* [#4571](https://github.com/sebastianbergmann/phpunit/issues/4571): No warning when `--random-order-seed` is used when test execution order is not random +* [#4975](https://github.com/sebastianbergmann/phpunit/issues/4975): `--filter` does not work when filter string starts with `#` +* [#5354](https://github.com/sebastianbergmann/phpunit/issues/5354): JUnit XML logger does not handle `TestSuiteSkipped` event +* [#6276](https://github.com/sebastianbergmann/phpunit/issues/6276): Exit with non-zero exit code when explicit test selection (`--filter`, `--group`, `--testsuite`) yields no tests +* [#6583](https://github.com/sebastianbergmann/phpunit/issues/6583): Failing output expectation skips `tearDown()` and handler restoration, causing subsequent tests to be marked as risky + +## [13.1.1] - 2026-04-08 + +### Changed + +* [#3676](https://github.com/sebastianbergmann/phpunit/issues/3676): Include class/interface name in mock object expectation failure messages +* [#4793](https://github.com/sebastianbergmann/phpunit/issues/4793): Exit with non-zero exit code when `exit` was called from some test + +### Fixed + +* [#5881](https://github.com/sebastianbergmann/phpunit/issues/5881): `colors="true"` in XML configuration file does not unconditionally enable colored output +* [#6019](https://github.com/sebastianbergmann/phpunit/issues/6019): `--migrate-configuration` does not update schema location when XML content already validates against current schema +* [#6372](https://github.com/sebastianbergmann/phpunit/issues/6372): Assertion failure inside `willReturnCallback()` is silently swallowed when code under test catches exceptions +* [#6464](https://github.com/sebastianbergmann/phpunit/issues/6464): Process isolation template unconditionally calls `set_include_path()` +* [#6571](https://github.com/sebastianbergmann/phpunit/issues/6571): Static analysis errors for `TestDoubleBuilder` method chaining + +## [13.1.0] - 2026-04-03 + +### Added + +* [#6501](https://github.com/sebastianbergmann/phpunit/issues/6501): Include unexpected output in Open Test Reporting (OTR) XML logfile +* [#6517](https://github.com/sebastianbergmann/phpunit/issues/6517): `includeInCodeCoverage` attribute for `` and `` children of `` +* [#6523](https://github.com/sebastianbergmann/phpunit/issues/6523): Include `#[Group]` information in Open Test Reporting (OTR) XML logfile +* [#6524](https://github.com/sebastianbergmann/phpunit/pull/6524): Report issues in Open Test Reporting (OTR) XML logfile +* [#6526](https://github.com/sebastianbergmann/phpunit/pull/6526): Introduce `#[DataProviderClosure]` for static closures +* [#6530](https://github.com/sebastianbergmann/phpunit/issues/6530): Support for custom issue trigger resolvers that can be configured using `` in the XML configuration file +* [#6547](https://github.com/sebastianbergmann/phpunit/pull/6547): Support for `%r...%r` in `EXPECTF` section +* Support for configuring HTML code coverage report options (colors, thresholds, custom CSS) in XML configuration file without requiring an `outputDirectory` attribute, allowing the output directory to be specified later with the `--coverage-html` CLI option +* Support for configuring dark mode colors, progress bar colors, and breadcrumb colors for HTML code coverage reports in the XML configuration file + +### Changed + +* [#6557](https://github.com/sebastianbergmann/phpunit/pull/6557): Improve failure description for `StringMatchesFormatDescription` constraint which is used by `assertFileMatchesFormat()`, `assertFileMatchesFormatFile()`, `assertStringMatchesFormat()`, `assertStringMatchesFormatFile()`, and `EXPECTF` sections of PHPT test files +* The HTML code coverage report now uses a more colorblind-friendly blue/amber/orange palette by default +* Extracted `PHPUnit\Runner\Extension\Facade` from a concrete class to an interface and introduced an internal `ExtensionFacade` implementation, so that extensions only depend on the `Facade` interface while PHPUnit internally uses the `ExtensionFacade` class that also provides query methods + +### Deprecated + +* [#6515](https://github.com/sebastianbergmann/phpunit/issues/6515): Deprecate the `--log-events-verbose-text ` CLI option +* [#6537](https://github.com/sebastianbergmann/phpunit/issues/6537): Soft-deprecate `id()` and `after()` for mock object expectations + +### Fixed + +* [#6025](https://github.com/sebastianbergmann/phpunit/issues/6025): `FILE_EXTERNAL` breaks `__DIR__` +* [#6351](https://github.com/sebastianbergmann/phpunit/issues/6351): No warning when the same test runner extension is configured more than once +* [#6433](https://github.com/sebastianbergmann/phpunit/issues/6433): Logic in `TestSuiteLoader` is brittle and causes "Class FooTest not found" even for valid tests in valid filenames +* [#6463](https://github.com/sebastianbergmann/phpunit/issues/6463): Process Isolation fails on non-serializable globals and quietly ignore closures + +[13.1.11]: https://github.com/sebastianbergmann/phpunit/compare/13.1.10...13.1.11 +[13.1.10]: https://github.com/sebastianbergmann/phpunit/compare/13.1.9...13.1.10 +[13.1.9]: https://github.com/sebastianbergmann/phpunit/compare/13.1.8...13.1.9 +[13.1.8]: https://github.com/sebastianbergmann/phpunit/compare/13.1.7...13.1.8 +[13.1.7]: https://github.com/sebastianbergmann/phpunit/compare/13.1.6...13.1.7 +[13.1.6]: https://github.com/sebastianbergmann/phpunit/compare/13.1.5...13.1.6 +[13.1.5]: https://github.com/sebastianbergmann/phpunit/compare/13.1.4...13.1.5 +[13.1.4]: https://github.com/sebastianbergmann/phpunit/compare/13.1.3...13.1.4 +[13.1.3]: https://github.com/sebastianbergmann/phpunit/compare/13.1.2...13.1.3 +[13.1.2]: https://github.com/sebastianbergmann/phpunit/compare/13.1.1...13.1.2 +[13.1.1]: https://github.com/sebastianbergmann/phpunit/compare/13.1.0...13.1.1 +[13.1.0]: https://github.com/sebastianbergmann/phpunit/compare/13.0.6...13.1.0 diff --git a/app/vendor/phpunit/phpunit/DEPRECATIONS.md b/app/vendor/phpunit/phpunit/DEPRECATIONS.md index b3f3fb98c..1c89dcc88 100644 --- a/app/vendor/phpunit/phpunit/DEPRECATIONS.md +++ b/app/vendor/phpunit/phpunit/DEPRECATIONS.md @@ -4,24 +4,13 @@ This functionality is currently [soft-deprecated](https://phpunit.de/backward-compatibility.html#soft-deprecation): -### Extending PHPUnit - -| Issue | Description | Since | Replacement | -|-------------------------------------------------------------------|---------------------------------------------|--------|-------------------------------------------------| -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `AfterTestMethodCalled::testCaseClass()` | 12.1.0 | `AfterTestMethodCalled::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `AfterTestMethodErrored::testCaseClass()` | 12.1.0 | `AfterTestMethodErrored::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `AfterTestMethodFinished::testCaseClass()` | 12.1.0 | `AfterTestMethodFinished::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `BeforeTestMethodCalled::testCaseClass()` | 12.1.0 | `BeforeTestMethodCalled::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `BeforeTestMethodErrored::testCaseClass()` | 12.1.0 | `BeforeTestMethodErrored::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `BeforeTestMethodFinished::testCaseClass()` | 12.1.0 | `BeforeTestMethodFinished::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `PreConditionCalled::testCaseClass()` | 12.1.0 | `PreConditionCalled::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `PreConditionErrored::testCaseClass()` | 12.1.0 | `PreConditionErrored::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `PreConditionFinished::testCaseClass()` | 12.1.0 | `PreConditionFinished::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `PostConditionCalled::testCaseClass()` | 12.1.0 | `PostConditionCalled::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `PostConditionErrored::testCaseClass()` | 12.1.0 | `PostConditionErrored::test()->className()` | -| [#6140](https://github.com/sebastianbergmann/phpunit/issues/6140) | `PostConditionFinished::testCaseClass()` | 12.1.0 | `PostConditionFinished::test()->className()` | -| [#6229](https://github.com/sebastianbergmann/phpunit/issues/6229) | `Configuration::includeTestSuite()` | 12.3.0 | `Configuration::includeTestSuites()` | -| [#6229](https://github.com/sebastianbergmann/phpunit/issues/6229) | `Configuration::excludeTestSuite()` | 12.3.0 | `Configuration::excludeTestSuites()` | +### Writing Tests + +#### Assertions, Constraints, and Expectations + +| Issue | Description | Since | Replacement | +|-------------------------------------------------------------------|---------------------------------------------------|--------|-------------| +| [#6537](https://github.com/sebastianbergmann/phpunit/issues/6537) | `id()` and `after()` for mock object expectations | 13.1.0 | | ## Hard Deprecations @@ -31,16 +20,14 @@ This functionality is currently [hard-deprecated](https://phpunit.de/backward-co #### Assertions, Constraints, and Expectations -| Issue | Description | Since | Replacement | -|-------------------------------------------------------------------|-------------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [#6052](https://github.com/sebastianbergmann/phpunit/issues/6052) | `Assert::isType()` | 11.5.0 | Use `isArray()`, `isBool()`, `isCallable()`, `isFloat()`, `isInt()`, `isIterable()`, `isNull()`, `isNumeric()`, `isObject()`, `isResource()`, `isClosedResource()`, `isScalar()`, or `isString()` instead | -| [#6055](https://github.com/sebastianbergmann/phpunit/issues/6055) | `Assert::assertContainsOnly()` | 11.5.0 | Use `assertContainsOnlyArray()`, `assertContainsOnlyBool()`, `assertContainsOnlyCallable()`, `assertContainsOnlyFloat()`, `assertContainsOnlyInt()`, `assertContainsOnlyIterable()`, `assertContainsOnlyNumeric()`, `assertContainsOnlyObject()`, `assertContainsOnlyResource()`, `assertContainsOnlyClosedResource()`, `assertContainsOnlyScalar()`, or `assertContainsOnlyString()` instead | -| [#6055](https://github.com/sebastianbergmann/phpunit/issues/6055) | `Assert::assertNotContainsOnly()` | 11.5.0 | Use `assertContainsNotOnlyArray()`, `assertContainsNotOnlyBool()`, `assertContainsNotOnlyCallable()`, `assertContainsNotOnlyFloat()`, `assertContainsNotOnlyInt()`, `assertContainsNotOnlyIterable()`, `assertContainsNotOnlyNumeric()`, `assertContainsNotOnlyObject()`, `assertContainsNotOnlyResource()`, `assertContainsNotOnlyClosedResource()`, `assertContainsNotOnlyScalar()`, or `assertContainsNotOnlyString()` instead | -| [#6059](https://github.com/sebastianbergmann/phpunit/issues/6059) | `Assert::containsOnly()` | 11.5.0 | Use `containsOnlyArray()`, `containsOnlyBool()`, `containsOnlyCallable()`, `containsOnlyFloat()`, `containsOnlyInt()`, `containsOnlyIterable()`, `containsOnlyNumeric()`, `containsOnlyObject()`, `containsOnlyResource()`, `containsOnlyClosedResource()`, `containsOnlyScalar()`, or `containsOnlyString()` instead | -| [#6246](https://github.com/sebastianbergmann/phpunit/issues/6246) | Using `#[CoversNothing]` on a test method | 12.3.0 | | +| Issue | Description | Since | Replacement | +|-------------------------------------------------------------------|-----------------------------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------| +| [#6461](https://github.com/sebastianbergmann/phpunit/issues/6461) | `TestCase::any()` | 12.5.5 | Use a test stub instead or configure a real invocation count expectation | +| [#6505](https://github.com/sebastianbergmann/phpunit/issues/6505) | Calling `atLeast()` with an argument that is not positive | 13.0.2 | Use a positive argument instead | +| [#6507](https://github.com/sebastianbergmann/phpunit/issues/6507) | Support for using `with*()` without `expects()` | 13.0.2 | Either configure an expected invocation count using `expects()`or use a test stub without the `with*()` call instead | ### Running Tests -| Issue | Description | Since | Replacement | -|-------------------------------------------------------------------|------------------------------------------|--------|--------------------------------------------------------| -| [#6240](https://github.com/sebastianbergmann/phpunit/issues/6240) | `--dont-report-useless-tests` CLI option | 12.2.3 | Use `--do-not-report-useless-tests` CLI option instead | +| Issue | Description | Since | Replacement | +|-------------------------------------------------------------------|------------------------------------------------|--------|-----------------------------------------------------------------| +| [#6515](https://github.com/sebastianbergmann/phpunit/issues/6515) | `--log-events-verbose-text ` CLI option | 13.1.0 | Use `--log-events-verbose-text --with-telemetry` instead | diff --git a/app/vendor/phpunit/phpunit/LICENSE b/app/vendor/phpunit/phpunit/LICENSE index b687f39ac..83489d635 100644 --- a/app/vendor/phpunit/phpunit/LICENSE +++ b/app/vendor/phpunit/phpunit/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2001-2025, Sebastian Bergmann +Copyright (c) 2001-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/phpunit/phpunit/README.md b/app/vendor/phpunit/phpunit/README.md index afec18c22..994e5c2d0 100644 --- a/app/vendor/phpunit/phpunit/README.md +++ b/app/vendor/phpunit/phpunit/README.md @@ -48,6 +48,7 @@ Here is a list of all components that are primarily developed and maintained by * [sebastian/diff](https://github.com/sebastianbergmann/diff) * [sebastian/environment](https://github.com/sebastianbergmann/environment) * [sebastian/exporter](https://github.com/sebastianbergmann/exporter) +* [sebastian/git-state](https://github.com/sebastianbergmann/git-state) * [sebastian/global-state](https://github.com/sebastianbergmann/global-state) * [sebastian/lines-of-code](https://github.com/sebastianbergmann/lines-of-code) * [sebastian/object-enumerator](https://github.com/sebastianbergmann/object-enumerator) @@ -88,14 +89,15 @@ These businesses support Sebastian Bergmann's work on PHPUnit: Bubble Shooter in2it vof - Roave + Mailtrap Testmo GmbH + TestMu AI Tideways GmbH - TYPO3 GmbH + TYPO3 GmbH VEMA Versicherungsmakler Genossenschaft eG @@ -105,4 +107,4 @@ Would you like to see your logo here as well as on the [PHPUnit website](https:/ Contact Sebastian Bergmann at [sponsoring@phpunit.de](mailto:sponsoring@phpunit.de) to learn more about how you can support his work on PHPUnit. Whether you are a CEO, CFO, CTO, or a developer: your company surely depends on Open Source software. -[It is time to pay your share](https://opensourcepledge.com/) and support maintainers like [Sebastian Bergmann](https://sebastian-bergmann.de/open-source.html?ref=github). +[It is time to pay your share](https://opensourcepledge.com/) and support maintainers like [Sebastian Bergmann](https://phpunit.de/sponsoring.html). diff --git a/app/vendor/phpunit/phpunit/SECURITY.md b/app/vendor/phpunit/phpunit/SECURITY.md index 5f55c4194..44dd9d2a8 100644 --- a/app/vendor/phpunit/phpunit/SECURITY.md +++ b/app/vendor/phpunit/phpunit/SECURITY.md @@ -1,12 +1,36 @@ # Security Policy -If you believe you have found a security vulnerability in PHPUnit, please report it to us through coordinated disclosure. +## Supported versions + +Security issues are fixed for versions of PHPUnit that are in the Bugfix Support phase. +Versions in the Life Support phase only receive changes required for compatibility with new versions of PHP; they do not receive bug or security fixes. +Versions that have reached End-of-Life do not receive any changes. + +| Version | Phase | End of Bugfix Support | +|------------|----------------|-----------------------| +| PHPUnit 13 | Bugfix Support | February 4, 2028 | +| PHPUnit 12 | Bugfix Support | February 5, 2027 | +| PHPUnit 11 | Life Support | February 6, 2026 | +| PHPUnit 10 | Life Support | February 7, 2025 | +| PHPUnit 9 | Life Support | February 2, 2024 | +| PHPUnit 8 | Life Support | February 3, 2023 | + +PHPUnit 7 and earlier have reached End-of-Life. + +See [Supported Versions of PHPUnit](https://phpunit.de/supported-versions.html) for the authoritative list and for the definitions of the support phases. + +## Reporting a vulnerability + +If you believe you have found a security vulnerability in PHPUnit, please report it to me through coordinated disclosure. +Please report vulnerabilities in bundled libraries to their respective repositories. **Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** Instead, please email `sebastian@phpunit.de`. -Please include as much of the information listed below as you can to help us better understand and resolve the issue: +Use my [PGP key](https://sebastian-bergmann.de/gpg.asc) for encrypted email, for example when your report includes proof-of-concept exploits against third-party systems. + +Please include as much of the information listed below as you can to help me better understand and resolve the issue: * The type of issue * Full paths of source file(s) related to the manifestation of the issue @@ -16,18 +40,68 @@ Please include as much of the information listed below as you can to help us bet * Proof-of-concept or exploit code (if possible) * Impact of the issue, including how an attacker might exploit the issue -This information will help us triage your report more quickly. +This information will help me triage your report more quickly. -## Web Context +If you used an AI assistant (LLM, coding agent, or similar) to find, reproduce, or write up the issue, please say so and describe how it was used. +This does not disqualify a report, but it changes how I triage it. -PHPUnit is a framework for writing as well as a command-line tool for running tests. Writing and running tests is a development-time activity. There is no reason why PHPUnit should be installed on a webserver and/or in a production environment. +## How reports are handled -**If you upload PHPUnit to a webserver then your deployment process is broken. On a more general note, if your `vendor` directory is publicly accessible on your webserver then your deployment process is also broken.** +I do not operate a bug bounty program. +There is no monetary reward for reporting a vulnerability. -Please note that if you upload PHPUnit to a webserver "bad things" may happen. [You have been warned.](https://thephp.cc/articles/phpunit-a-security-risk?ref=phpunit) +I will acknowledge receipt of a vulnerability report within 7 days. -PHPUnit is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using PHPUnit in an HTTP or web context or with untrusted input data is performed. PHPUnit might also contain functionality that intentionally exposes internal application data for debugging purposes. +A confirmed security issue is handled like any other bug. +It is not prioritized ahead of other work. +It is fixed when I have the time to fix it. -If PHPUnit is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. +I will fix and release before a public advisory is published, but I will not agree to fixed-date embargoes, multi-vendor coordination, or NDAs. +I do not optimize for metrics such as the OpenSSF Scorecard. + +Once a vulnerability has been fixed and a release with the fix is available, I publish a public advisory on GitHub. +I give credit in the advisory when I know the reporter's GitHub user name. + +## Scope + +PHPUnit is a framework for writing as well as a command-line tool for running tests. +Writing and running tests is a development-time activity. +PHPUnit is developed with a focus on development environments and the command-line. + +### In scope + +I treat a bug as a security issue when a documented, intended use of PHPUnit, or a reasonable extrapolation of it, causes PHPUnit itself to compromise the confidentiality, integrity, or availability of the environment it runs in. Examples: -Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. +* PHPUnit's console output, logfiles, and reports in any format contain a vulnerability that allows an attacker to extract secrets from or otherwise compromise the environment in which the output is viewed or processed. +* A regular test run, against trusted test code, trusted production code, and a trusted configuration, causes PHPUnit to transmit data from the environment to a third party. +* A regular test run, against trusted test code, trusted production code, and a trusted configuration, causes PHPUnit to write secrets from the environment to its own output, log files, or reports. + +### Not in scope + +No specific testing or hardening with regard to using PHPUnit in an HTTP or web context, in a CI/CD context, or with untrusted input data is performed. +The following classes of issue are explicitly not in scope. + +#### CI/CD Pipelines + +Running tests in a CI/CD pipeline is a legitimate and common use of PHPUnit. +However, a CI/CD pipeline is not a sandbox, and PHPUnit is not designed to defend one. +Executing test code, production code, or a configuration for PHPUnit or PHP that has not been reviewed is equivalent to executing arbitrary code on the infrastructure that hosts the pipeline. +This class of risk is documented as [CICD-SEC-04: Poisoned Pipeline Execution](https://owasp.org/www-project-top-10-ci-cd-security-risks/CICD-SEC-04-Poisoned-Pipeline-Execution) in the OWASP Top 10 CI/CD Security Risks. + +**If your CI/CD pipeline automatically runs PHPUnit against a configuration for PHPUnit or PHP, test code, and/or production code from third parties without those changes having been reviewed first, then your development process is broken.** + +Running code from a pull request on your infrastructure is, by definition, remote code execution. + +Protecting the pipeline is the responsibility of the operator of the pipeline: +limit which events trigger workflows, require review before workflows run on contributions from outside collaborators, isolate jobs that run untrusted code, and do not expose secrets to such jobs. + +#### Webserver + +There is no reason why PHPUnit should be installed on a webserver and/or in a production environment. + +**If you upload PHPUnit to a webserver then your deployment process is broken.** + +On a more general note, if your `vendor` directory is publicly accessible on your webserver then your deployment process is also broken. + +PHPUnit might contain functionality that intentionally exposes internal application data for debugging purposes. +If PHPUnit is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. diff --git a/app/vendor/phpunit/phpunit/composer.json b/app/vendor/phpunit/phpunit/composer.json index 9fd62fda4..5451db8be 100644 --- a/app/vendor/phpunit/phpunit/composer.json +++ b/app/vendor/phpunit/phpunit/composer.json @@ -16,13 +16,19 @@ "role": "lead" } ], + "funding": [ + { + "type": "other", + "url": "https://phpunit.de/sponsoring.html" + } + ], "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", "security": "https://github.com/sebastianbergmann/phpunit/security/policy" }, "prefer-stable": true, "require": { - "php": ">=8.3", + "php": ">=8.4.1", "ext-dom": "*", "ext-json": "*", "ext-libxml": "*", @@ -32,25 +38,27 @@ "myclabs/deep-copy": "^1.13.4", "phar-io/manifest": "^2.0.4", "phar-io/version": "^3.2.1", - "phpunit/php-code-coverage": "^12.3.6", - "phpunit/php-file-iterator": "^6.0.0", - "phpunit/php-invoker": "^6.0.0", - "phpunit/php-text-template": "^5.0.0", - "phpunit/php-timer": "^8.0.0", - "sebastian/cli-parser": "^4.0.0", - "sebastian/comparator": "^7.1.3", - "sebastian/diff": "^7.0.0", - "sebastian/environment": "^8.0.3", - "sebastian/exporter": "^7.0.0", - "sebastian/global-state": "^8.0.2", - "sebastian/object-enumerator": "^7.0.0", - "sebastian/type": "^6.0.3", - "sebastian/version": "^6.0.0", + "phpunit/php-code-coverage": "^14.1.9", + "phpunit/php-file-iterator": "^7.0.0", + "phpunit/php-invoker": "^7.0.0", + "phpunit/php-text-template": "^6.0.0", + "phpunit/php-timer": "^9.0.0", + "sebastian/cli-parser": "^5.0.0", + "sebastian/comparator": "^8.2.1", + "sebastian/diff": "^8.3.0", + "sebastian/environment": "^9.3.1", + "sebastian/exporter": "^8.1.0", + "sebastian/git-state": "^1.0", + "sebastian/global-state": "^9.0.0", + "sebastian/object-enumerator": "^8.0.0", + "sebastian/recursion-context": "^8.0.0", + "sebastian/type": "^7.0.1", + "sebastian/version": "^7.0.0", "staabm/side-effects-detector": "^1.0.5" }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "classmap-authoritative": true, "optimize-autoloader": true, @@ -74,7 +82,7 @@ "files": [ "tests/_files/deprecation-trigger/trigger_deprecation.php", "tests/unit/Event/AbstractEventTestCase.php", - "tests/unit/TextUI/AbstractSouceFilterTestCase.php", + "tests/unit/TextUI/AbstractSourceFilterTestCase.php", "tests/unit/Framework/MockObject/TestDoubleTestCase.php", "tests/unit/Metadata/Parser/AttributeParserTestCase.php", "tests/unit/Framework/Assert/assertContainsOnlyArrayTest.php", @@ -104,6 +112,7 @@ "tests/unit/Framework/Assert/assertNullTest.php", "tests/unit/Framework/Assert/assertSameSizeTest.php", "tests/unit/Framework/Assert/assertSameTest.php", + "tests/unit/TextUI/Output/Default/ResultPrinterTest.php", "tests/_files/CoveredFunction.php", "tests/_files/Generator.php", "tests/_files/NamespaceCoveredFunction.php", @@ -112,7 +121,7 @@ }, "extra": { "branch-alias": { - "dev-main": "12.3-dev" + "dev-main": "13.1-dev" } } } diff --git a/app/vendor/phpunit/phpunit/composer.lock b/app/vendor/phpunit/phpunit/composer.lock index 5bd6c500e..8cb1315e9 100644 --- a/app/vendor/phpunit/phpunit/composer.lock +++ b/app/vendor/phpunit/phpunit/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "0ba899528f94659fb21790b35e318a31", + "content-hash": "af766786b7cd5c01f40a3eb97baadd0e", "packages": [ { "name": "myclabs/deep-copy", @@ -68,16 +68,16 @@ }, { "name": "nikic/php-parser", - "version": "v5.6.1", + "version": "v5.7.0", "source": { "type": "git", "url": "https://github.com/nikic/PHP-Parser.git", - "reference": "f103601b29efebd7ff4a1ca7b3eeea9e3336a2a2" + "reference": "dca41cd15c2ac9d055ad70dbfd011130757d1f82" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/f103601b29efebd7ff4a1ca7b3eeea9e3336a2a2", - "reference": "f103601b29efebd7ff4a1ca7b3eeea9e3336a2a2", + "url": "https://api.github.com/repos/nikic/PHP-Parser/zipball/dca41cd15c2ac9d055ad70dbfd011130757d1f82", + "reference": "dca41cd15c2ac9d055ad70dbfd011130757d1f82", "shasum": "" }, "require": { @@ -120,9 +120,9 @@ ], "support": { "issues": "https://github.com/nikic/PHP-Parser/issues", - "source": "https://github.com/nikic/PHP-Parser/tree/v5.6.1" + "source": "https://github.com/nikic/PHP-Parser/tree/v5.7.0" }, - "time": "2025-08-13T20:13:15+00:00" + "time": "2025-12-06T11:56:16+00:00" }, { "name": "phar-io/manifest", @@ -244,34 +244,35 @@ }, { "name": "phpunit/php-code-coverage", - "version": "12.3.6", + "version": "14.1.9", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "da2cdaff87220fa641e7652364281b736e4347e0" + "reference": "655533a65696bbc4231cd8027af150dadc40ec88" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/da2cdaff87220fa641e7652364281b736e4347e0", - "reference": "da2cdaff87220fa641e7652364281b736e4347e0", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/655533a65696bbc4231cd8027af150dadc40ec88", + "reference": "655533a65696bbc4231cd8027af150dadc40ec88", "shasum": "" }, "require": { "ext-dom": "*", "ext-libxml": "*", + "ext-mbstring": "*", "ext-xmlwriter": "*", - "nikic/php-parser": "^5.6.1", - "php": ">=8.3", - "phpunit/php-file-iterator": "^6.0", - "phpunit/php-text-template": "^5.0", - "sebastian/complexity": "^5.0", - "sebastian/environment": "^8.0.3", - "sebastian/lines-of-code": "^4.0", - "sebastian/version": "^6.0", - "theseer/tokenizer": "^1.2.3" + "nikic/php-parser": "^5.7.0", + "php": ">=8.4", + "phpunit/php-text-template": "^6.0", + "sebastian/complexity": "^6.0", + "sebastian/environment": "^9.2", + "sebastian/git-state": "^1.0", + "sebastian/lines-of-code": "^5.0", + "sebastian/version": "^7.0", + "theseer/tokenizer": "^2.0.1" }, "require-dev": { - "phpunit/phpunit": "^12.3.7" + "phpunit/phpunit": "^13.1" }, "suggest": { "ext-pcov": "PHP extension that provides line coverage", @@ -280,7 +281,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "12.3.x-dev" + "dev-main": "14.1.x-dev" } }, "autoload": { @@ -309,7 +310,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", "security": "https://github.com/sebastianbergmann/php-code-coverage/security/policy", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/12.3.6" + "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/14.1.9" }, "funding": [ { @@ -329,32 +330,32 @@ "type": "tidelift" } ], - "time": "2025-09-02T05:23:14+00:00" + "time": "2026-05-16T05:16:14+00:00" }, { "name": "phpunit/php-file-iterator", - "version": "6.0.0", + "version": "7.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-file-iterator.git", - "reference": "961bc913d42fe24a257bfff826a5068079ac7782" + "reference": "6e5aa1fb0a95b1703d83e721299ee18bb4e2de50" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/961bc913d42fe24a257bfff826a5068079ac7782", - "reference": "961bc913d42fe24a257bfff826a5068079ac7782", + "url": "https://api.github.com/repos/sebastianbergmann/php-file-iterator/zipball/6e5aa1fb0a95b1703d83e721299ee18bb4e2de50", + "reference": "6e5aa1fb0a95b1703d83e721299ee18bb4e2de50", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } }, "autoload": { @@ -382,36 +383,48 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-file-iterator/issues", "security": "https://github.com/sebastianbergmann/php-file-iterator/security/policy", - "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/6.0.0" + "source": "https://github.com/sebastianbergmann/php-file-iterator/tree/7.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-file-iterator", + "type": "tidelift" } ], - "time": "2025-02-07T04:58:37+00:00" + "time": "2026-02-06T04:33:26+00:00" }, { "name": "phpunit/php-invoker", - "version": "6.0.0", + "version": "7.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-invoker.git", - "reference": "12b54e689b07a25a9b41e57736dfab6ec9ae5406" + "reference": "42e5c5cae0c65df12d1b1a3ab52bf3f50f244d88" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-invoker/zipball/12b54e689b07a25a9b41e57736dfab6ec9ae5406", - "reference": "12b54e689b07a25a9b41e57736dfab6ec9ae5406", + "url": "https://api.github.com/repos/sebastianbergmann/php-invoker/zipball/42e5c5cae0c65df12d1b1a3ab52bf3f50f244d88", + "reference": "42e5c5cae0c65df12d1b1a3ab52bf3f50f244d88", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { "ext-pcntl": "*", - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "suggest": { "ext-pcntl": "*" @@ -419,7 +432,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } }, "autoload": { @@ -446,40 +459,52 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-invoker/issues", "security": "https://github.com/sebastianbergmann/php-invoker/security/policy", - "source": "https://github.com/sebastianbergmann/php-invoker/tree/6.0.0" + "source": "https://github.com/sebastianbergmann/php-invoker/tree/7.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-invoker", + "type": "tidelift" } ], - "time": "2025-02-07T04:58:58+00:00" + "time": "2026-02-06T04:34:47+00:00" }, { "name": "phpunit/php-text-template", - "version": "5.0.0", + "version": "6.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-text-template.git", - "reference": "e1367a453f0eda562eedb4f659e13aa900d66c53" + "reference": "a47af19f93f76aa3368303d752aa5272ca3299f4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/e1367a453f0eda562eedb4f659e13aa900d66c53", - "reference": "e1367a453f0eda562eedb4f659e13aa900d66c53", + "url": "https://api.github.com/repos/sebastianbergmann/php-text-template/zipball/a47af19f93f76aa3368303d752aa5272ca3299f4", + "reference": "a47af19f93f76aa3368303d752aa5272ca3299f4", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "6.0-dev" } }, "autoload": { @@ -506,40 +531,52 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-text-template/issues", "security": "https://github.com/sebastianbergmann/php-text-template/security/policy", - "source": "https://github.com/sebastianbergmann/php-text-template/tree/5.0.0" + "source": "https://github.com/sebastianbergmann/php-text-template/tree/6.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-text-template", + "type": "tidelift" } ], - "time": "2025-02-07T04:59:16+00:00" + "time": "2026-02-06T04:36:37+00:00" }, { "name": "phpunit/php-timer", - "version": "8.0.0", + "version": "9.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-timer.git", - "reference": "f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc" + "reference": "a0e12065831f6ab0d83120dc61513eb8d9a966f6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc", - "reference": "f258ce36aa457f3aa3339f9ed4c81fc66dc8c2cc", + "url": "https://api.github.com/repos/sebastianbergmann/php-timer/zipball/a0e12065831f6ab0d83120dc61513eb8d9a966f6", + "reference": "a0e12065831f6ab0d83120dc61513eb8d9a966f6", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "9.0-dev" } }, "autoload": { @@ -566,40 +603,52 @@ "support": { "issues": "https://github.com/sebastianbergmann/php-timer/issues", "security": "https://github.com/sebastianbergmann/php-timer/security/policy", - "source": "https://github.com/sebastianbergmann/php-timer/tree/8.0.0" + "source": "https://github.com/sebastianbergmann/php-timer/tree/9.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpunit/php-timer", + "type": "tidelift" } ], - "time": "2025-02-07T04:59:38+00:00" + "time": "2026-02-06T04:37:53+00:00" }, { "name": "sebastian/cli-parser", - "version": "4.0.0", + "version": "5.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/cli-parser.git", - "reference": "6d584c727d9114bcdc14c86711cd1cad51778e7c" + "reference": "48a4654fa5e48c1c81214e9930048a572d4b23ca" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/cli-parser/zipball/6d584c727d9114bcdc14c86711cd1cad51778e7c", - "reference": "6d584c727d9114bcdc14c86711cd1cad51778e7c", + "url": "https://api.github.com/repos/sebastianbergmann/cli-parser/zipball/48a4654fa5e48c1c81214e9930048a572d4b23ca", + "reference": "48a4654fa5e48c1c81214e9930048a572d4b23ca", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "4.0-dev" + "dev-main": "5.0-dev" } }, "autoload": { @@ -623,39 +672,51 @@ "support": { "issues": "https://github.com/sebastianbergmann/cli-parser/issues", "security": "https://github.com/sebastianbergmann/cli-parser/security/policy", - "source": "https://github.com/sebastianbergmann/cli-parser/tree/4.0.0" + "source": "https://github.com/sebastianbergmann/cli-parser/tree/5.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/cli-parser", + "type": "tidelift" } ], - "time": "2025-02-07T04:53:50+00:00" + "time": "2026-02-06T04:39:44+00:00" }, { "name": "sebastian/comparator", - "version": "7.1.3", + "version": "8.2.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/comparator.git", - "reference": "dc904b4bb3ab070865fa4068cd84f3da8b945148" + "reference": "ce999bf08b2c387a5423fe56961c32eed3f88089" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/dc904b4bb3ab070865fa4068cd84f3da8b945148", - "reference": "dc904b4bb3ab070865fa4068cd84f3da8b945148", + "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/ce999bf08b2c387a5423fe56961c32eed3f88089", + "reference": "ce999bf08b2c387a5423fe56961c32eed3f88089", "shasum": "" }, "require": { "ext-dom": "*", "ext-mbstring": "*", - "php": ">=8.3", - "sebastian/diff": "^7.0", - "sebastian/exporter": "^7.0" + "php": ">=8.4", + "sebastian/diff": "^8.3", + "sebastian/exporter": "^8.0.3" }, "require-dev": { - "phpunit/phpunit": "^12.2" + "phpunit/phpunit": "^13.1.10" }, "suggest": { "ext-bcmath": "For comparing BcMath\\Number objects" @@ -663,7 +724,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "7.1-dev" + "dev-main": "8.2-dev" } }, "autoload": { @@ -703,7 +764,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/comparator/issues", "security": "https://github.com/sebastianbergmann/comparator/security/policy", - "source": "https://github.com/sebastianbergmann/comparator/tree/7.1.3" + "source": "https://github.com/sebastianbergmann/comparator/tree/8.2.1" }, "funding": [ { @@ -723,33 +784,33 @@ "type": "tidelift" } ], - "time": "2025-08-20T11:27:00+00:00" + "time": "2026-05-21T04:46:40+00:00" }, { "name": "sebastian/complexity", - "version": "5.0.0", + "version": "6.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/complexity.git", - "reference": "bad4316aba5303d0221f43f8cee37eb58d384bbb" + "reference": "c5651c795c98093480df79350cb050813fc7a2f3" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/complexity/zipball/bad4316aba5303d0221f43f8cee37eb58d384bbb", - "reference": "bad4316aba5303d0221f43f8cee37eb58d384bbb", + "url": "https://api.github.com/repos/sebastianbergmann/complexity/zipball/c5651c795c98093480df79350cb050813fc7a2f3", + "reference": "c5651c795c98093480df79350cb050813fc7a2f3", "shasum": "" }, "require": { "nikic/php-parser": "^5.0", - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "6.0-dev" } }, "autoload": { @@ -773,41 +834,53 @@ "support": { "issues": "https://github.com/sebastianbergmann/complexity/issues", "security": "https://github.com/sebastianbergmann/complexity/security/policy", - "source": "https://github.com/sebastianbergmann/complexity/tree/5.0.0" + "source": "https://github.com/sebastianbergmann/complexity/tree/6.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/complexity", + "type": "tidelift" } ], - "time": "2025-02-07T04:55:25+00:00" + "time": "2026-02-06T04:41:32+00:00" }, { "name": "sebastian/diff", - "version": "7.0.0", + "version": "8.3.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/diff.git", - "reference": "7ab1ea946c012266ca32390913653d844ecd085f" + "reference": "b36d33b6e796513de7cb7df053afb3f55eefcd47" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/7ab1ea946c012266ca32390913653d844ecd085f", - "reference": "7ab1ea946c012266ca32390913653d844ecd085f", + "url": "https://api.github.com/repos/sebastianbergmann/diff/zipball/b36d33b6e796513de7cb7df053afb3f55eefcd47", + "reference": "b36d33b6e796513de7cb7df053afb3f55eefcd47", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0", + "phpunit/phpunit": "^13.0", "symfony/process": "^7.2" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.3-dev" } }, "autoload": { @@ -840,35 +913,47 @@ "support": { "issues": "https://github.com/sebastianbergmann/diff/issues", "security": "https://github.com/sebastianbergmann/diff/security/policy", - "source": "https://github.com/sebastianbergmann/diff/tree/7.0.0" + "source": "https://github.com/sebastianbergmann/diff/tree/8.3.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/diff", + "type": "tidelift" } ], - "time": "2025-02-07T04:55:46+00:00" + "time": "2026-05-15T04:58:09+00:00" }, { "name": "sebastian/environment", - "version": "8.0.3", + "version": "9.3.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/environment.git", - "reference": "24a711b5c916efc6d6e62aa65aa2ec98fef77f68" + "reference": "a15fa79a5f5cfd0e9f6817dbcdb0048e99efa146" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/24a711b5c916efc6d6e62aa65aa2ec98fef77f68", - "reference": "24a711b5c916efc6d6e62aa65aa2ec98fef77f68", + "url": "https://api.github.com/repos/sebastianbergmann/environment/zipball/a15fa79a5f5cfd0e9f6817dbcdb0048e99efa146", + "reference": "a15fa79a5f5cfd0e9f6817dbcdb0048e99efa146", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "suggest": { "ext-posix": "*" @@ -876,7 +961,7 @@ "type": "library", "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "9.3-dev" } }, "autoload": { @@ -904,7 +989,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/environment/issues", "security": "https://github.com/sebastianbergmann/environment/security/policy", - "source": "https://github.com/sebastianbergmann/environment/tree/8.0.3" + "source": "https://github.com/sebastianbergmann/environment/tree/9.3.1" }, "funding": [ { @@ -924,34 +1009,34 @@ "type": "tidelift" } ], - "time": "2025-08-12T14:11:56+00:00" + "time": "2026-05-21T08:47:00+00:00" }, { "name": "sebastian/exporter", - "version": "7.0.0", + "version": "8.1.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/exporter.git", - "reference": "76432aafc58d50691a00d86d0632f1217a47b688" + "reference": "c0d29a945f8cf82f300a05e69874508e307ca4c6" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/76432aafc58d50691a00d86d0632f1217a47b688", - "reference": "76432aafc58d50691a00d86d0632f1217a47b688", + "url": "https://api.github.com/repos/sebastianbergmann/exporter/zipball/c0d29a945f8cf82f300a05e69874508e307ca4c6", + "reference": "c0d29a945f8cf82f300a05e69874508e307ca4c6", "shasum": "" }, "require": { "ext-mbstring": "*", - "php": ">=8.3", - "sebastian/recursion-context": "^7.0" + "php": ">=8.4", + "sebastian/recursion-context": "^8.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.1-dev" } }, "autoload": { @@ -994,43 +1079,124 @@ "support": { "issues": "https://github.com/sebastianbergmann/exporter/issues", "security": "https://github.com/sebastianbergmann/exporter/security/policy", - "source": "https://github.com/sebastianbergmann/exporter/tree/7.0.0" + "source": "https://github.com/sebastianbergmann/exporter/tree/8.1.0" + }, + "funding": [ + { + "url": "https://github.com/sebastianbergmann", + "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/exporter", + "type": "tidelift" + } + ], + "time": "2026-05-21T11:50:56+00:00" + }, + { + "name": "sebastian/git-state", + "version": "1.0.0", + "source": { + "type": "git", + "url": "https://github.com/sebastianbergmann/git-state.git", + "reference": "792a952e0eba55b6960a48aeceb9f371aad1f76b" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/sebastianbergmann/git-state/zipball/792a952e0eba55b6960a48aeceb9f371aad1f76b", + "reference": "792a952e0eba55b6960a48aeceb9f371aad1f76b", + "shasum": "" + }, + "require": { + "php": ">=8.4" + }, + "require-dev": { + "phpunit/phpunit": "^13.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.0-dev" + } + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "description": "Library for describing the state of a Git checkout", + "homepage": "https://github.com/sebastianbergmann/git-state", + "support": { + "issues": "https://github.com/sebastianbergmann/git-state/issues", + "security": "https://github.com/sebastianbergmann/git-state/security/policy", + "source": "https://github.com/sebastianbergmann/git-state/tree/1.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/git-state", + "type": "tidelift" } ], - "time": "2025-02-07T04:56:42+00:00" + "time": "2026-03-21T12:54:28+00:00" }, { "name": "sebastian/global-state", - "version": "8.0.2", + "version": "9.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/global-state.git", - "reference": "ef1377171613d09edd25b7816f05be8313f9115d" + "reference": "e52e3dc22441e6218c710afe72c3042f8fc41ea7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/ef1377171613d09edd25b7816f05be8313f9115d", - "reference": "ef1377171613d09edd25b7816f05be8313f9115d", + "url": "https://api.github.com/repos/sebastianbergmann/global-state/zipball/e52e3dc22441e6218c710afe72c3042f8fc41ea7", + "reference": "e52e3dc22441e6218c710afe72c3042f8fc41ea7", "shasum": "" }, "require": { - "php": ">=8.3", - "sebastian/object-reflector": "^5.0", - "sebastian/recursion-context": "^7.0" + "php": ">=8.4", + "sebastian/object-reflector": "^6.0", + "sebastian/recursion-context": "^8.0" }, "require-dev": { "ext-dom": "*", - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "9.0-dev" } }, "autoload": { @@ -1056,7 +1222,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/global-state/issues", "security": "https://github.com/sebastianbergmann/global-state/security/policy", - "source": "https://github.com/sebastianbergmann/global-state/tree/8.0.2" + "source": "https://github.com/sebastianbergmann/global-state/tree/9.0.0" }, "funding": [ { @@ -1076,33 +1242,33 @@ "type": "tidelift" } ], - "time": "2025-08-29T11:29:25+00:00" + "time": "2026-02-06T04:45:13+00:00" }, { "name": "sebastian/lines-of-code", - "version": "4.0.0", + "version": "5.0.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/lines-of-code.git", - "reference": "97ffee3bcfb5805568d6af7f0f893678fc076d2f" + "reference": "d2cff273a90c79b0eb590baa682d4b5c318bdbb7" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/lines-of-code/zipball/97ffee3bcfb5805568d6af7f0f893678fc076d2f", - "reference": "97ffee3bcfb5805568d6af7f0f893678fc076d2f", + "url": "https://api.github.com/repos/sebastianbergmann/lines-of-code/zipball/d2cff273a90c79b0eb590baa682d4b5c318bdbb7", + "reference": "d2cff273a90c79b0eb590baa682d4b5c318bdbb7", "shasum": "" }, "require": { - "nikic/php-parser": "^5.0", - "php": ">=8.3" + "nikic/php-parser": "^5.7.0", + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "4.0-dev" + "dev-main": "5.0-dev" } }, "autoload": { @@ -1126,42 +1292,54 @@ "support": { "issues": "https://github.com/sebastianbergmann/lines-of-code/issues", "security": "https://github.com/sebastianbergmann/lines-of-code/security/policy", - "source": "https://github.com/sebastianbergmann/lines-of-code/tree/4.0.0" + "source": "https://github.com/sebastianbergmann/lines-of-code/tree/5.0.1" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/lines-of-code", + "type": "tidelift" } ], - "time": "2025-02-07T04:57:28+00:00" + "time": "2026-05-19T16:23:37+00:00" }, { "name": "sebastian/object-enumerator", - "version": "7.0.0", + "version": "8.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/object-enumerator.git", - "reference": "1effe8e9b8e068e9ae228e542d5d11b5d16db894" + "reference": "b39ab125fd9a7434b0ecbc4202eebce11a98cfc5" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/1effe8e9b8e068e9ae228e542d5d11b5d16db894", - "reference": "1effe8e9b8e068e9ae228e542d5d11b5d16db894", + "url": "https://api.github.com/repos/sebastianbergmann/object-enumerator/zipball/b39ab125fd9a7434b0ecbc4202eebce11a98cfc5", + "reference": "b39ab125fd9a7434b0ecbc4202eebce11a98cfc5", "shasum": "" }, "require": { - "php": ">=8.3", - "sebastian/object-reflector": "^5.0", - "sebastian/recursion-context": "^7.0" + "php": ">=8.4", + "sebastian/object-reflector": "^6.0", + "sebastian/recursion-context": "^8.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.0-dev" } }, "autoload": { @@ -1184,40 +1362,52 @@ "support": { "issues": "https://github.com/sebastianbergmann/object-enumerator/issues", "security": "https://github.com/sebastianbergmann/object-enumerator/security/policy", - "source": "https://github.com/sebastianbergmann/object-enumerator/tree/7.0.0" + "source": "https://github.com/sebastianbergmann/object-enumerator/tree/8.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/object-enumerator", + "type": "tidelift" } ], - "time": "2025-02-07T04:57:48+00:00" + "time": "2026-02-06T04:46:36+00:00" }, { "name": "sebastian/object-reflector", - "version": "5.0.0", + "version": "6.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/object-reflector.git", - "reference": "4bfa827c969c98be1e527abd576533293c634f6a" + "reference": "3ca042c2c60b0eab094f8a1b6a7093f4d4c72200" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/object-reflector/zipball/4bfa827c969c98be1e527abd576533293c634f6a", - "reference": "4bfa827c969c98be1e527abd576533293c634f6a", + "url": "https://api.github.com/repos/sebastianbergmann/object-reflector/zipball/3ca042c2c60b0eab094f8a1b6a7093f4d4c72200", + "reference": "3ca042c2c60b0eab094f8a1b6a7093f4d4c72200", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "6.0-dev" } }, "autoload": { @@ -1240,40 +1430,52 @@ "support": { "issues": "https://github.com/sebastianbergmann/object-reflector/issues", "security": "https://github.com/sebastianbergmann/object-reflector/security/policy", - "source": "https://github.com/sebastianbergmann/object-reflector/tree/5.0.0" + "source": "https://github.com/sebastianbergmann/object-reflector/tree/6.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/object-reflector", + "type": "tidelift" } ], - "time": "2025-02-07T04:58:17+00:00" + "time": "2026-02-06T04:47:13+00:00" }, { "name": "sebastian/recursion-context", - "version": "7.0.1", + "version": "8.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/recursion-context.git", - "reference": "0b01998a7d5b1f122911a66bebcb8d46f0c82d8c" + "reference": "74c5af21f6a5833e91767ca068c4d3dfec15317e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/0b01998a7d5b1f122911a66bebcb8d46f0c82d8c", - "reference": "0b01998a7d5b1f122911a66bebcb8d46f0c82d8c", + "url": "https://api.github.com/repos/sebastianbergmann/recursion-context/zipball/74c5af21f6a5833e91767ca068c4d3dfec15317e", + "reference": "74c5af21f6a5833e91767ca068c4d3dfec15317e", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.0-dev" } }, "autoload": { @@ -1304,7 +1506,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/recursion-context/issues", "security": "https://github.com/sebastianbergmann/recursion-context/security/policy", - "source": "https://github.com/sebastianbergmann/recursion-context/tree/7.0.1" + "source": "https://github.com/sebastianbergmann/recursion-context/tree/8.0.0" }, "funding": [ { @@ -1324,32 +1526,32 @@ "type": "tidelift" } ], - "time": "2025-08-13T04:44:59+00:00" + "time": "2026-02-06T04:51:28+00:00" }, { "name": "sebastian/type", - "version": "6.0.3", + "version": "7.0.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/type.git", - "reference": "e549163b9760b8f71f191651d22acf32d56d6d4d" + "reference": "fee0309275847fefd7636167085e379c1dbf6990" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/type/zipball/e549163b9760b8f71f191651d22acf32d56d6d4d", - "reference": "e549163b9760b8f71f191651d22acf32d56d6d4d", + "url": "https://api.github.com/repos/sebastianbergmann/type/zipball/fee0309275847fefd7636167085e379c1dbf6990", + "reference": "fee0309275847fefd7636167085e379c1dbf6990", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } }, "autoload": { @@ -1373,7 +1575,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/type/issues", "security": "https://github.com/sebastianbergmann/type/security/policy", - "source": "https://github.com/sebastianbergmann/type/tree/6.0.3" + "source": "https://github.com/sebastianbergmann/type/tree/7.0.1" }, "funding": [ { @@ -1393,29 +1595,29 @@ "type": "tidelift" } ], - "time": "2025-08-09T06:57:12+00:00" + "time": "2026-05-20T06:49:11+00:00" }, { "name": "sebastian/version", - "version": "6.0.0", + "version": "7.0.0", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/version.git", - "reference": "3e6ccf7657d4f0a59200564b08cead899313b53c" + "reference": "ad37a5552c8e2b88572249fdc19b6da7792e021b" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/3e6ccf7657d4f0a59200564b08cead899313b53c", - "reference": "3e6ccf7657d4f0a59200564b08cead899313b53c", + "url": "https://api.github.com/repos/sebastianbergmann/version/zipball/ad37a5552c8e2b88572249fdc19b6da7792e021b", + "reference": "ad37a5552c8e2b88572249fdc19b6da7792e021b", "shasum": "" }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "type": "library", "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } }, "autoload": { @@ -1439,15 +1641,27 @@ "support": { "issues": "https://github.com/sebastianbergmann/version/issues", "security": "https://github.com/sebastianbergmann/version/security/policy", - "source": "https://github.com/sebastianbergmann/version/tree/6.0.0" + "source": "https://github.com/sebastianbergmann/version/tree/7.0.0" }, "funding": [ { "url": "https://github.com/sebastianbergmann", "type": "github" + }, + { + "url": "https://liberapay.com/sebastianbergmann", + "type": "liberapay" + }, + { + "url": "https://thanks.dev/u/gh/sebastianbergmann", + "type": "thanks_dev" + }, + { + "url": "https://tidelift.com/funding/github/packagist/sebastian/version", + "type": "tidelift" } ], - "time": "2025-02-07T05:00:38+00:00" + "time": "2026-02-06T04:52:52+00:00" }, { "name": "staabm/side-effects-detector", @@ -1503,23 +1717,23 @@ }, { "name": "theseer/tokenizer", - "version": "1.2.3", + "version": "2.0.1", "source": { "type": "git", "url": "https://github.com/theseer/tokenizer.git", - "reference": "737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2" + "reference": "7989e43bf381af0eac72e4f0ca5bcbfa81658be4" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/theseer/tokenizer/zipball/737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2", - "reference": "737eda637ed5e28c3413cb1ebe8bb52cbf1ca7a2", + "url": "https://api.github.com/repos/theseer/tokenizer/zipball/7989e43bf381af0eac72e4f0ca5bcbfa81658be4", + "reference": "7989e43bf381af0eac72e4f0ca5bcbfa81658be4", "shasum": "" }, "require": { "ext-dom": "*", "ext-tokenizer": "*", "ext-xmlwriter": "*", - "php": "^7.2 || ^8.0" + "php": "^8.1" }, "type": "library", "autoload": { @@ -1541,7 +1755,7 @@ "description": "A small library for converting tokenized PHP source code into XML and potentially other formats", "support": { "issues": "https://github.com/theseer/tokenizer/issues", - "source": "https://github.com/theseer/tokenizer/tree/1.2.3" + "source": "https://github.com/theseer/tokenizer/tree/2.0.1" }, "funding": [ { @@ -1549,7 +1763,7 @@ "type": "github" } ], - "time": "2024-03-03T12:36:25+00:00" + "time": "2025-12-08T11:19:18+00:00" } ], "packages-dev": [], @@ -1559,7 +1773,7 @@ "prefer-stable": true, "prefer-lowest": false, "platform": { - "php": ">=8.3", + "php": ">=8.4.1", "ext-dom": "*", "ext-json": "*", "ext-libxml": "*", @@ -1569,7 +1783,7 @@ }, "platform-dev": {}, "platform-overrides": { - "php": "8.3.0" + "php": "8.4.1" }, - "plugin-api-version": "2.6.0" + "plugin-api-version": "2.9.0" } diff --git a/app/vendor/phpunit/phpunit/phpunit b/app/vendor/phpunit/phpunit/phpunit index 84afaf14c..7cace6af4 100755 --- a/app/vendor/phpunit/phpunit/phpunit +++ b/app/vendor/phpunit/phpunit/phpunit @@ -24,11 +24,11 @@ if (!version_compare(PHP_VERSION, PHP_VERSION, '=')) { die(1); } -if (version_compare('8.3.0', PHP_VERSION, '>')) { +if (version_compare('8.4.1', PHP_VERSION, '>')) { fwrite( STDERR, sprintf( - 'This version of PHPUnit requires PHP >= 8.3.' . PHP_EOL . + 'This version of PHPUnit requires PHP >= 8.4.1.' . PHP_EOL . 'You are using PHP %s (%s).' . PHP_EOL, PHP_VERSION, PHP_BINARY diff --git a/app/vendor/phpunit/phpunit/phpunit.xsd b/app/vendor/phpunit/phpunit/phpunit.xsd index 73e7c2144..7ebf0a86c 100644 --- a/app/vendor/phpunit/phpunit/phpunit.xsd +++ b/app/vendor/phpunit/phpunit/phpunit.xsd @@ -2,7 +2,7 @@ - This Schema file defines the rules by which the XML configuration file of PHPUnit 12.3 may be structured. + This Schema file defines the rules by which the XML configuration file of PHPUnit 13.1 may be structured. @@ -24,6 +24,7 @@ + @@ -35,6 +36,7 @@ + @@ -43,7 +45,7 @@ - + @@ -52,6 +54,14 @@ + + + + + + + + @@ -178,6 +188,7 @@ + @@ -295,7 +306,7 @@ - + @@ -322,14 +333,27 @@ - + - - - - - + + + + + + + + + + + + + + + + + + @@ -337,6 +361,10 @@ + + + + @@ -344,5 +372,14 @@ + + + + + + + + + diff --git a/app/vendor/phpunit/phpunit/schema/11.5.xsd b/app/vendor/phpunit/phpunit/schema/11.5.xsd index ec0227111..e452d8fe6 100644 --- a/app/vendor/phpunit/phpunit/schema/11.5.xsd +++ b/app/vendor/phpunit/phpunit/schema/11.5.xsd @@ -35,6 +35,7 @@ + diff --git a/app/vendor/phpunit/phpunit/schema/12.3.xsd b/app/vendor/phpunit/phpunit/schema/12.3.xsd new file mode 100644 index 000000000..73e7c2144 --- /dev/null +++ b/app/vendor/phpunit/phpunit/schema/12.3.xsd @@ -0,0 +1,348 @@ + + + + + This Schema file defines the rules by which the XML configuration file of PHPUnit 12.3 may be structured. + + + + + + Root Element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The main type specifying the document structure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/vendor/phpunit/phpunit/schema/12.4.xsd b/app/vendor/phpunit/phpunit/schema/12.4.xsd new file mode 100644 index 000000000..8a7ce6224 --- /dev/null +++ b/app/vendor/phpunit/phpunit/schema/12.4.xsd @@ -0,0 +1,348 @@ + + + + + This Schema file defines the rules by which the XML configuration file of PHPUnit 12.4 may be structured. + + + + + + Root Element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The main type specifying the document structure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/vendor/phpunit/phpunit/schema/12.5.xsd b/app/vendor/phpunit/phpunit/schema/12.5.xsd new file mode 100644 index 000000000..08d881e6a --- /dev/null +++ b/app/vendor/phpunit/phpunit/schema/12.5.xsd @@ -0,0 +1,353 @@ + + + + + This Schema file defines the rules by which the XML configuration file of PHPUnit 12.5 may be structured. + + + + + + Root Element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The main type specifying the document structure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/vendor/phpunit/phpunit/schema/13.0.xsd b/app/vendor/phpunit/phpunit/schema/13.0.xsd new file mode 100644 index 000000000..ad6ac34e3 --- /dev/null +++ b/app/vendor/phpunit/phpunit/schema/13.0.xsd @@ -0,0 +1,354 @@ + + + + + This Schema file defines the rules by which the XML configuration file of PHPUnit 13.0 may be structured. + + + + + + Root Element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The main type specifying the document structure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/vendor/phpunit/phpunit/schema/9.6.xsd b/app/vendor/phpunit/phpunit/schema/9.6.xsd new file mode 100644 index 000000000..619434ef8 --- /dev/null +++ b/app/vendor/phpunit/phpunit/schema/9.6.xsd @@ -0,0 +1,330 @@ + + + + + This Schema file defines the rules by which the XML configuration file of PHPUnit 9.6 may be structured. + + + + + + Root Element + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The main type specifying the document structure + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/vendor/phpunit/phpunit/src/Event/Emitter/DispatchingEmitter.php b/app/vendor/phpunit/phpunit/src/Event/Emitter/DispatchingEmitter.php index 606eac4dd..915222b72 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Emitter/DispatchingEmitter.php +++ b/app/vendor/phpunit/phpunit/src/Event/Emitter/DispatchingEmitter.php @@ -11,6 +11,7 @@ use function assert; use function memory_reset_peak_usage; +use function preg_match; use PHPUnit\Event\Code\ClassMethod; use PHPUnit\Event\Code\ComparisonFailure; use PHPUnit\Event\Code\IssueTrigger\IssueTrigger; @@ -596,6 +597,17 @@ public function testRegisteredComparator(string $className): void ); } + public function testUsedCustomMethodInvocation(TestMethod $test, ClassMethod $customTestMethodInvocation): void + { + $this->dispatcher->dispatch( + new Test\CustomTestMethodInvocationUsed( + $this->telemetryInfo(), + $test, + $customTestMethodInvocation, + ), + ); + } + /** * @param class-string $className * @@ -804,12 +816,8 @@ public function testTriggeredPhpunitDeprecation(?Code\Test $test, string $messag * @throws NoTestCaseObjectOnCallStackException * @throws UnknownEventTypeException */ - public function testTriggeredPhpunitNotice(?Code\Test $test, string $message): void + public function testTriggeredPhpunitNotice(Code\Test $test, string $message): void { - if ($test === null) { - $test = TestMethodBuilder::fromCallStack(); - } - $this->dispatcher->dispatch( new Test\PhpunitNoticeTriggered( $this->telemetryInfo(), @@ -1020,7 +1028,9 @@ public function testTriggeredPhpunitWarning(Code\Test $test, string $message): v if (isset($metadata[0])) { assert($metadata[0] instanceof IgnorePhpunitWarnings); - if ($metadata[0]->shouldIgnore($message)) { + $messagePattern = $metadata[0]->messagePattern(); + + if ($messagePattern === null || (bool) preg_match('{' . $messagePattern . '}', $message)) { $ignoredByTest = true; } } diff --git a/app/vendor/phpunit/phpunit/src/Event/Emitter/Emitter.php b/app/vendor/phpunit/phpunit/src/Event/Emitter/Emitter.php index eb9d75cca..c5689984a 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Emitter/Emitter.php +++ b/app/vendor/phpunit/phpunit/src/Event/Emitter/Emitter.php @@ -22,7 +22,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Emitter { @@ -124,6 +124,8 @@ public function testPrepared(Code\Test $test): void; */ public function testRegisteredComparator(string $className): void; + public function testUsedCustomMethodInvocation(TestMethod $test, ClassMethod $customTestMethodInvocation): void; + /** * @param class-string $className */ @@ -175,7 +177,7 @@ public function testTriggeredPhpunitDeprecation(?Code\Test $test, string $messag /** * @param non-empty-string $message */ - public function testTriggeredPhpunitNotice(?Code\Test $test, string $message): void; + public function testTriggeredPhpunitNotice(Code\Test $test, string $message): void; /** * @param non-empty-string $message diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Application/Finished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Application/Finished.php index 6e94da2a9..e1d3914ff 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Application/Finished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Application/Finished.php @@ -23,6 +23,9 @@ private Telemetry\Info $telemetryInfo; private int $shellExitCode; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, int $shellExitCode) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Application/Started.php b/app/vendor/phpunit/phpunit/src/Event/Events/Application/Started.php index a9aa959a7..1b0e141c8 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Application/Started.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Application/Started.php @@ -24,6 +24,9 @@ private Telemetry\Info $telemetryInfo; private Runtime $runtime; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Runtime $runtime) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/EventCollection.php b/app/vendor/phpunit/phpunit/src/Event/Events/EventCollection.php index 7c6912692..00c8c54bd 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/EventCollection.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/EventCollection.php @@ -14,7 +14,7 @@ use IteratorAggregate; /** - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/EventCollectionIterator.php b/app/vendor/phpunit/phpunit/src/Event/Events/EventCollectionIterator.php index d121dea6e..3e25257e6 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/EventCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/EventCollectionIterator.php @@ -9,11 +9,10 @@ */ namespace PHPUnit\Event; -use function count; use Iterator; /** - * @template-implements Iterator + * @template-implements Iterator * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ @@ -23,8 +22,15 @@ final class EventCollectionIterator implements Iterator * @var list */ private readonly array $events; + + /** + * @var non-negative-int + */ private int $position = 0; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(EventCollection $events) { $this->events = $events->asArray(); @@ -37,9 +43,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->events); + return isset($this->events[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/AdditionalInformationProvided.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/AdditionalInformationProvided.php index d8f819ee4..d00df3a86 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/AdditionalInformationProvided.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/AdditionalInformationProvided.php @@ -32,6 +32,8 @@ /** * @param non-empty-string $additionalInformation + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, TestMethod $test, string $additionalInformation) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/ComparatorRegistered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/ComparatorRegistered.php index 9db33d5ea..c7bc8ef59 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/ComparatorRegistered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/ComparatorRegistered.php @@ -30,6 +30,8 @@ /** * @param class-string $className + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $className) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/CustomTestMethodInvocationUsed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/CustomTestMethodInvocationUsed.php new file mode 100644 index 000000000..78f6e8ab5 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/CustomTestMethodInvocationUsed.php @@ -0,0 +1,64 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Event\Test; + +use function sprintf; +use PHPUnit\Event\Code; +use PHPUnit\Event\Event; +use PHPUnit\Event\Telemetry; + +/** + * @immutable + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +final readonly class CustomTestMethodInvocationUsed implements Event +{ + private Telemetry\Info $telemetryInfo; + private Code\TestMethod $test; + private Code\ClassMethod $customTestMethodInvocation; + + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ + public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $customTestMethodInvocation) + { + $this->telemetryInfo = $telemetryInfo; + $this->test = $test; + $this->customTestMethodInvocation = $customTestMethodInvocation; + } + + public function telemetryInfo(): Telemetry\Info + { + return $this->telemetryInfo; + } + + public function test(): Code\TestMethod + { + return $this->test; + } + + public function customTestMethodInvocation(): Code\ClassMethod + { + return $this->customTestMethodInvocation; + } + + /** + * @return non-empty-string + */ + public function asString(): string + { + return sprintf( + 'Custom Test Method Invocation Used (%s::%s)', + $this->customTestMethodInvocation->className(), + $this->customTestMethodInvocation->methodName(), + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/CustomTestMethodInvocationUsedSubscriber.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/CustomTestMethodInvocationUsedSubscriber.php new file mode 100644 index 000000000..17c3e8da9 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/CustomTestMethodInvocationUsedSubscriber.php @@ -0,0 +1,20 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Event\Test; + +use PHPUnit\Event\Subscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +interface CustomTestMethodInvocationUsedSubscriber extends Subscriber +{ + public function notify(CustomTestMethodInvocationUsed $event): void; +} diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodCalled.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodCalled.php index 2c875a8cf..d6e867ce7 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodCalled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodCalled.php @@ -32,6 +32,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod $calledMethod) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodErrored.php index ecdb7a15d..44c544974 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodErrored.php @@ -35,6 +35,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod $calledMethod, Throwable $throwable) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFailed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFailed.php index b22146ea4..8dd29f44e 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFailed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFailed.php @@ -35,6 +35,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod $calledMethod, Throwable $throwable) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFinished.php index d8a5a11f2..e93d70eed 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterLastTestMethodFinished.php @@ -37,6 +37,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod ...$calledMethods) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodCalled.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodCalled.php index 93c4e12cb..72808d347 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodCalled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodCalled.php @@ -25,6 +25,9 @@ private Code\TestMethod $test; private Code\ClassMethod $calledMethod; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod) { $this->telemetryInfo = $telemetryInfo; @@ -42,16 +45,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodErrored.php index fd277e2d0..66d3dbfa3 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodErrored.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; @@ -46,16 +49,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFailed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFailed.php index e405066f7..c1b6fa88a 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFailed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFailed.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFinished.php index f897198e0..dae241259 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/AfterTestMethodFinished.php @@ -30,6 +30,9 @@ */ private array $calledMethods; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod ...$calledMethods) { $this->telemetryInfo = $telemetryInfo; @@ -47,16 +50,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - /** * @return list */ diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodCalled.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodCalled.php index b08eb8b95..7fb12e1d0 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodCalled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodCalled.php @@ -32,6 +32,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod $calledMethod) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodErrored.php index a2e37b337..985395aec 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodErrored.php @@ -35,6 +35,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod $calledMethod, Throwable $throwable) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFailed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFailed.php index 33e669a4e..6487bb817 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFailed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFailed.php @@ -35,6 +35,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod $calledMethod, Throwable $throwable) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFinished.php index 87230a676..93d1229d8 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeFirstTestMethodFinished.php @@ -37,6 +37,8 @@ /** * @param class-string $testClassName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod ...$calledMethods) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodCalled.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodCalled.php index 2927a6851..aef15ea03 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodCalled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodCalled.php @@ -25,6 +25,9 @@ private Code\TestMethod $test; private Code\ClassMethod $calledMethod; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod) { $this->telemetryInfo = $telemetryInfo; @@ -42,16 +45,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodErrored.php index 7e18a0c65..f5d5cd0fd 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodErrored.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; @@ -46,16 +49,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFailed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFailed.php index 95b46e410..d2bc3ed06 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFailed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFailed.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFinished.php index 971ad06bb..5b302c629 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/BeforeTestMethodFinished.php @@ -30,6 +30,9 @@ */ private array $calledMethods; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod ...$calledMethods) { $this->telemetryInfo = $telemetryInfo; @@ -47,16 +50,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - /** * @return list */ diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionCalled.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionCalled.php index 2035f6432..c80c4e68a 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionCalled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionCalled.php @@ -25,6 +25,9 @@ private Code\TestMethod $test; private Code\ClassMethod $calledMethod; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod) { $this->telemetryInfo = $telemetryInfo; @@ -42,16 +45,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionErrored.php index 29cfe0d64..5197701ed 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionErrored.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; @@ -46,16 +49,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFailed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFailed.php index cb4868973..aa9a773fd 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFailed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFailed.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFinished.php index 0910a2a8b..7e10d96d9 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PostConditionFinished.php @@ -30,6 +30,9 @@ */ private array $calledMethods; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod ...$calledMethods) { $this->telemetryInfo = $telemetryInfo; @@ -47,16 +50,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - /** * @return list */ diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionCalled.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionCalled.php index 80a10ee15..14006b40d 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionCalled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionCalled.php @@ -25,6 +25,9 @@ private Code\TestMethod $test; private Code\ClassMethod $calledMethod; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod) { $this->telemetryInfo = $telemetryInfo; @@ -42,16 +45,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionErrored.php index f2773d981..ee9003e03 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionErrored.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; @@ -46,16 +49,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - public function calledMethod(): Code\ClassMethod { return $this->calledMethod; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFailed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFailed.php index bf94de211..0d513db70 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFailed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFailed.php @@ -28,6 +28,9 @@ private Code\ClassMethod $calledMethod; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod $calledMethod, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFinished.php index 8a708ee05..65129bed8 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/HookMethod/PreConditionFinished.php @@ -30,6 +30,9 @@ */ private array $calledMethods; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\TestMethod $test, Code\ClassMethod ...$calledMethods) { $this->telemetryInfo = $telemetryInfo; @@ -47,16 +50,6 @@ public function test(): Code\TestMethod return $this->test; } - /** - * @return class-string - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6140 - */ - public function testClassName(): string - { - return $this->test->className(); - } - /** * @return list */ diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ConsideredRisky.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ConsideredRisky.php index 306c04e7d..4d9b99a00 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ConsideredRisky.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ConsideredRisky.php @@ -32,6 +32,8 @@ /** * @param non-empty-string $message + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, string $message) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/DeprecationTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/DeprecationTriggered.php index 09ec56fc8..a74125033 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/DeprecationTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/DeprecationTriggered.php @@ -56,6 +56,8 @@ * @param non-empty-string $file * @param positive-int $line * @param non-empty-string $stackTrace + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger, string $stackTrace) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ErrorTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ErrorTriggered.php index 7faefc634..eb54be8a2 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ErrorTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/ErrorTriggered.php @@ -46,6 +46,8 @@ * @param non-empty-string $message * @param non-empty-string $file * @param positive-int $line + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/NoticeTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/NoticeTriggered.php index 237e1f18a..fb4fbdcfb 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/NoticeTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/NoticeTriggered.php @@ -47,6 +47,8 @@ * @param non-empty-string $message * @param non-empty-string $file * @param positive-int $line + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpDeprecationTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpDeprecationTriggered.php index 5b9878ad4..fe936d2da 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpDeprecationTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpDeprecationTriggered.php @@ -50,6 +50,8 @@ * @param non-empty-string $message * @param non-empty-string $file * @param positive-int $line + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpNoticeTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpNoticeTriggered.php index ad976cfcf..932dde679 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpNoticeTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpNoticeTriggered.php @@ -47,6 +47,8 @@ * @param non-empty-string $message * @param non-empty-string $file * @param positive-int $line + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpWarningTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpWarningTriggered.php index 3d65125f7..4d2ed4884 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpWarningTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpWarningTriggered.php @@ -47,6 +47,8 @@ * @param non-empty-string $message * @param non-empty-string $file * @param positive-int $line + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitDeprecationTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitDeprecationTriggered.php index 4e1603f35..ebe100bcb 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitDeprecationTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitDeprecationTriggered.php @@ -32,6 +32,8 @@ /** * @param non-empty-string $message + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitErrorTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitErrorTriggered.php index abd5e8a1f..e3fdab79f 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitErrorTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitErrorTriggered.php @@ -33,6 +33,8 @@ /** * @param non-empty-string $message + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitNoticeTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitNoticeTriggered.php index 33984ba42..16bae74bd 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitNoticeTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitNoticeTriggered.php @@ -33,6 +33,8 @@ /** * @param non-empty-string $message + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitWarningTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitWarningTriggered.php index 75ef4894d..0089ae53f 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitWarningTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/PhpunitWarningTriggered.php @@ -34,6 +34,8 @@ /** * @param non-empty-string $message + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, bool $ignoredByTest) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/WarningTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/WarningTriggered.php index 7b3e313bf..6de126dad 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/WarningTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Issue/WarningTriggered.php @@ -47,6 +47,8 @@ * @param non-empty-string $message * @param non-empty-string $file * @param positive-int $line + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodCalled.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodCalled.php index 5631e1cf2..6d647048a 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodCalled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodCalled.php @@ -25,6 +25,9 @@ private ClassMethod $testMethod; private ClassMethod $dataProviderMethod; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Info $telemetryInfo, ClassMethod $testMethod, ClassMethod $dataProviderMethod) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodFinished.php index ec2677994..4bed3a4f2 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/DataProviderMethodFinished.php @@ -30,6 +30,9 @@ */ private array $calledMethods; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, ClassMethod $testMethod, ClassMethod ...$calledMethods) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Finished.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Finished.php index 3cc9a52ff..b02559883 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Finished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Finished.php @@ -31,6 +31,8 @@ /** * @param non-negative-int $numberOfAssertionsPerformed + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, int $numberOfAssertionsPerformed) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationErrored.php index 866bf5f1c..c5955c45f 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationErrored.php @@ -27,6 +27,9 @@ private Code\Test $test; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationFailed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationFailed.php index 7a8b1d67f..84b14cc85 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationFailed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationFailed.php @@ -27,6 +27,9 @@ private Code\Test $test; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationStarted.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationStarted.php index 7c548b08b..533795bdb 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationStarted.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/PreparationStarted.php @@ -24,6 +24,9 @@ private Telemetry\Info $telemetryInfo; private Code\Test $test; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Prepared.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Prepared.php index d83f1d595..ec7edbe41 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Prepared.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Lifecycle/Prepared.php @@ -24,6 +24,9 @@ private Telemetry\Info $telemetryInfo; private Code\Test $test; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Errored.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Errored.php index ef0684989..6be67eb92 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Errored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Errored.php @@ -28,6 +28,9 @@ private Code\Test $test; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Failed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Failed.php index bcc5867f0..a32a99218 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Failed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Failed.php @@ -30,6 +30,9 @@ private Throwable $throwable; private ?ComparisonFailure $comparisonFailure; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, Throwable $throwable, ?ComparisonFailure $comparisonFailure) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/MarkedIncomplete.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/MarkedIncomplete.php index a69b48a42..787aa4726 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/MarkedIncomplete.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/MarkedIncomplete.php @@ -28,6 +28,9 @@ private Code\Test $test; private Throwable $throwable; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, Throwable $throwable) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Passed.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Passed.php index 38f2d9816..e1ab4e04f 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Passed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Passed.php @@ -24,6 +24,9 @@ private Telemetry\Info $telemetryInfo; private Code\Test $test; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Skipped.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Skipped.php index fe605fff4..b8d3ee521 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Skipped.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/Outcome/Skipped.php @@ -26,6 +26,9 @@ private Code\Test $test; private string $message; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Code\Test $test, string $message) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/PrintedUnexpectedOutput.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/PrintedUnexpectedOutput.php index 4a0ceab39..b7b2bb489 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/PrintedUnexpectedOutput.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/PrintedUnexpectedOutput.php @@ -30,6 +30,8 @@ /** * @param non-empty-string $output + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $output) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectCreated.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectCreated.php index 8e91237c4..2b37692e8 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectCreated.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectCreated.php @@ -29,6 +29,8 @@ /** * @param class-string $className + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $className) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectForIntersectionOfInterfacesCreated.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectForIntersectionOfInterfacesCreated.php index 3548189e8..530923139 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectForIntersectionOfInterfacesCreated.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/MockObjectForIntersectionOfInterfacesCreated.php @@ -30,6 +30,8 @@ /** * @param list $interfaces + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, array $interfaces) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/PartialMockObjectCreated.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/PartialMockObjectCreated.php index 625747816..f1ae6f228 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/PartialMockObjectCreated.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/PartialMockObjectCreated.php @@ -34,6 +34,8 @@ /** * @param class-string $className + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $className, string ...$methodNames) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubCreated.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubCreated.php index 667fbad4b..e2251a4e5 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubCreated.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubCreated.php @@ -29,6 +29,8 @@ /** * @param class-string $className + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $className) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubForIntersectionOfInterfacesCreated.php b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubForIntersectionOfInterfacesCreated.php index bba93d9e0..82c66cdad 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubForIntersectionOfInterfacesCreated.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/Test/TestDouble/TestStubForIntersectionOfInterfacesCreated.php @@ -30,6 +30,8 @@ /** * @param list $interfaces + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, array $interfaces) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/BootstrapFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/BootstrapFinished.php index 8e46a00a8..28b73eba5 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/BootstrapFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/BootstrapFinished.php @@ -29,6 +29,8 @@ /** * @param non-empty-string $filename + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $filename) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessErrored.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessErrored.php index 2cb96422b..839b54701 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessErrored.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessErrored.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessFinished.php index 705a0c634..0a82416d1 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessFinished.php @@ -23,6 +23,9 @@ private string $stdout; private string $stderr; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, string $stdout, string $stderr) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessStarted.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessStarted.php index 2c20471e2..65995c592 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessStarted.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ChildProcessStarted.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Configured.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Configured.php index e0d14360a..b8a028966 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Configured.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Configured.php @@ -21,6 +21,9 @@ private Telemetry\Info $telemetryInfo; private Configuration $configuration; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, Configuration $configuration) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/DeprecationTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/DeprecationTriggered.php index 5cfef8f78..668af5afe 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/DeprecationTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/DeprecationTriggered.php @@ -29,6 +29,8 @@ /** * @param non-empty-string $message + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $message) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/EventFacadeSealed.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/EventFacadeSealed.php index bd4f5f603..ba0e56321 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/EventFacadeSealed.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/EventFacadeSealed.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionAborted.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionAborted.php index 6107e099b..06d8a953e 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionAborted.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionAborted.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionFinished.php index 25789fe7c..e7eeff9b0 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionFinished.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionStarted.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionStarted.php index e38a2a4d9..5f6c5ecf0 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionStarted.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExecutionStarted.php @@ -24,6 +24,9 @@ private Telemetry\Info $telemetryInfo; private TestSuite $testSuite; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, TestSuite $testSuite) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionBootstrapped.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionBootstrapped.php index 4ae1a6d5b..0df45542c 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionBootstrapped.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionBootstrapped.php @@ -35,6 +35,8 @@ /** * @param class-string $className * @param array $parameters + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $className, array $parameters) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionLoadedFromPhar.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionLoadedFromPhar.php index 2ce358d5c..6ba0e9f2d 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionLoadedFromPhar.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/ExtensionLoadedFromPhar.php @@ -41,6 +41,8 @@ * @param non-empty-string $filename * @param non-empty-string $name * @param non-empty-string $version + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $filename, string $name, string $version) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Finished.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Finished.php index 2abc685bb..643ebe4e4 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Finished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Finished.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionDisabled.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionDisabled.php index 4324a5c15..aff843880 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionDisabled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionDisabled.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionEnabled.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionEnabled.php index 1c4e08887..a41171b88 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionEnabled.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionEnabled.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionTriggered.php index d6a1ce643..0d479dd74 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/GarbageCollectionTriggered.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/NoticeTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/NoticeTriggered.php index a5bfa04f3..1fd25ad46 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/NoticeTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/NoticeTriggered.php @@ -23,6 +23,9 @@ private Telemetry\Info $telemetryInfo; private string $message; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, string $message) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Started.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Started.php index a58401108..3d93f3003 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Started.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/Started.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageFinished.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageFinished.php index d484528ec..8acbab488 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageFinished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageFinished.php @@ -35,6 +35,8 @@ /** * @param non-negative-int $cacheHits * @param non-negative-int $cacheMisses + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, int $cacheHits, int $cacheMisses) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageStarted.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageStarted.php index d12109727..cfdf18c5e 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageStarted.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/StaticAnalysisForCodeCoverageStarted.php @@ -21,6 +21,9 @@ { private Telemetry\Info $telemetryInfo; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/WarningTriggered.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/WarningTriggered.php index e9df01be9..2b99c8790 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/WarningTriggered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestRunner/WarningTriggered.php @@ -29,6 +29,8 @@ /** * @param non-empty-string $message + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(Telemetry\Info $telemetryInfo, string $message) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Filtered.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Filtered.php index 96d626ce4..2576f111b 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Filtered.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Filtered.php @@ -23,6 +23,9 @@ private Telemetry\Info $telemetryInfo; private TestSuite $testSuite; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, TestSuite $testSuite) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Finished.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Finished.php index a24ca8692..378768de0 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Finished.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Finished.php @@ -23,6 +23,9 @@ private Telemetry\Info $telemetryInfo; private TestSuite $testSuite; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, TestSuite $testSuite) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Loaded.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Loaded.php index d278c0ddc..7f69d3378 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Loaded.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Loaded.php @@ -23,6 +23,9 @@ private Telemetry\Info $telemetryInfo; private TestSuite $testSuite; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, TestSuite $testSuite) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Skipped.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Skipped.php index efe9c1fff..614f4dd16 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Skipped.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Skipped.php @@ -24,6 +24,9 @@ private TestSuite $testSuite; private string $message; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, TestSuite $testSuite, string $message) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Sorted.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Sorted.php index a73461db8..a6830bb36 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Sorted.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Sorted.php @@ -24,6 +24,9 @@ private int $executionOrderDefects; private bool $resolveDependencies; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, int $executionOrder, int $executionOrderDefects, bool $resolveDependencies) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Started.php b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Started.php index 36fee1f00..c558d7679 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Started.php +++ b/app/vendor/phpunit/phpunit/src/Event/Events/TestSuite/Started.php @@ -23,6 +23,9 @@ private Telemetry\Info $telemetryInfo; private TestSuite $testSuite; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Telemetry\Info $telemetryInfo, TestSuite $testSuite) { $this->telemetryInfo = $telemetryInfo; diff --git a/app/vendor/phpunit/phpunit/src/Event/Facade.php b/app/vendor/phpunit/phpunit/src/Event/Facade.php index 6348fc434..946292cb2 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Facade.php +++ b/app/vendor/phpunit/phpunit/src/Event/Facade.php @@ -196,6 +196,7 @@ private function registerDefaultTypes(TypeMap $typeMap): void Test\BeforeTestMethodFinished::class, Test\AdditionalInformationProvided::class, Test\ComparatorRegistered::class, + Test\CustomTestMethodInvocationUsed::class, Test\ConsideredRisky::class, Test\DeprecationTriggered::class, Test\Errored::class, diff --git a/app/vendor/phpunit/phpunit/src/Event/TypeMap.php b/app/vendor/phpunit/phpunit/src/Event/TypeMap.php index e525e446d..08f42a420 100644 --- a/app/vendor/phpunit/phpunit/src/Event/TypeMap.php +++ b/app/vendor/phpunit/phpunit/src/Event/TypeMap.php @@ -9,6 +9,7 @@ */ namespace PHPUnit\Event; +use function array_any; use function array_key_exists; use function class_exists; use function class_implements; @@ -53,13 +54,10 @@ public function addMapping(string $subscriberInterface, string $eventClass): voi public function isKnownSubscriberType(Subscriber $subscriber): bool { - foreach (class_implements($subscriber) as $interface) { - if (array_key_exists($interface, $this->mapping)) { - return true; - } - } - - return false; + return array_any( + class_implements($subscriber), + fn (string $interface) => array_key_exists($interface, $this->mapping), + ); } public function isKnownEventType(Event $event): bool diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/ClassMethod.php b/app/vendor/phpunit/phpunit/src/Event/Value/ClassMethod.php index 2a94033a5..866061bac 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/ClassMethod.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/ClassMethod.php @@ -29,6 +29,8 @@ /** * @param class-string $className * @param non-empty-string $methodName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(string $className, string $methodName) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/ComparisonFailure.php b/app/vendor/phpunit/phpunit/src/Event/Value/ComparisonFailure.php index c31f93e65..607e10f44 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/ComparisonFailure.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/ComparisonFailure.php @@ -20,6 +20,9 @@ private string $actual; private string $diff; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(string $expected, string $actual, string $diff) { $this->expected = $expected; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/OperatingSystem.php b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/OperatingSystem.php index 508d809f1..e37107183 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/OperatingSystem.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/OperatingSystem.php @@ -22,6 +22,9 @@ private string $operatingSystem; private string $operatingSystemFamily; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct() { $this->operatingSystem = PHP_OS; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHP.php b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHP.php index 46004f98c..5a8639bfe 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHP.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHP.php @@ -40,6 +40,9 @@ */ private array $extensions; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct() { $this->version = PHP_VERSION; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHPUnit.php b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHPUnit.php index 7f85133d2..000bca30d 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHPUnit.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/PHPUnit.php @@ -21,6 +21,9 @@ private string $versionId; private string $releaseSeries; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct() { $this->versionId = Version::id(); diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/Runtime.php b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/Runtime.php index 552ec9887..c7a256300 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/Runtime.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Runtime/Runtime.php @@ -22,6 +22,9 @@ private PHP $php; private PHPUnit $phpunit; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct() { $this->operatingSystem = new OperatingSystem; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Duration.php b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Duration.php index 230150a15..17351394f 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Duration.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Duration.php @@ -80,9 +80,9 @@ public function asString(): string return sprintf( '%02d:%02d:%02d.%09d', - $hours, - $minutes, - $seconds, + (int) $hours, + (int) $minutes, + (int) $seconds, $this->nanoseconds(), ); } diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/GarbageCollectorStatus.php b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/GarbageCollectorStatus.php index f8bb77a74..6b3e354c3 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/GarbageCollectorStatus.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/GarbageCollectorStatus.php @@ -29,6 +29,9 @@ private bool $full; private int $bufferSize; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(int $runs, int $collected, int $threshold, int $roots, float $applicationTime, float $collectorTime, float $destructorTime, float $freeTime, bool $running, bool $protected, bool $full, int $bufferSize) { $this->runs = $runs; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Info.php b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Info.php index a0d0a99f1..62468e714 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Info.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Info.php @@ -24,6 +24,9 @@ private Duration $durationSincePrevious; private MemoryUsage $memorySincePrevious; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(Snapshot $current, Duration $durationSinceStart, MemoryUsage $memorySinceStart, Duration $durationSincePrevious, MemoryUsage $memorySincePrevious) { $this->current = $current; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Snapshot.php b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Snapshot.php index 0f00f5d80..c69f4d66a 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Snapshot.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/Snapshot.php @@ -21,6 +21,9 @@ private MemoryUsage $peakMemoryUsage; private GarbageCollectorStatus $garbageCollectorStatus; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(HRTime $time, MemoryUsage $memoryUsage, MemoryUsage $peakMemoryUsage, GarbageCollectorStatus $garbageCollectorStatus) { $this->time = $time; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/System.php b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/System.php index 0a178363e..6d94d3338 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/System.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/System.php @@ -20,6 +20,9 @@ private MemoryMeter $memoryMeter; private GarbageCollectorStatusProvider $garbageCollectorStatusProvider; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(StopWatch $stopWatch, MemoryMeter $memoryMeter, GarbageCollectorStatusProvider $garbageCollectorStatusProvider) { $this->stopWatch = $stopWatch; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/SystemStopWatchWithOffset.php b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/SystemStopWatchWithOffset.php index d27fd98c1..1a586079e 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/SystemStopWatchWithOffset.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Telemetry/SystemStopWatchWithOffset.php @@ -23,6 +23,9 @@ final class SystemStopWatchWithOffset implements StopWatch { private ?HRTime $offset; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(HRTime $offset) { $this->offset = $offset; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/Code.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/Code.php new file mode 100644 index 000000000..f7f10337d --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/Code.php @@ -0,0 +1,28 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Event\Code\IssueTrigger; + +enum Code: string +{ + public function isFirstPartyOrTest(): bool + { + return $this === self::FirstParty || $this === self::Test; + } + + public function isThirdPartyOrPhpunitOrPhp(): bool + { + return $this === self::ThirdParty || $this === self::PHPUnit || $this === self::PHP; + } + case FirstParty = 'first-party code'; + case ThirdParty = 'third-party code'; + case Test = 'test code'; + case PHP = 'PHP runtime'; + case PHPUnit = 'PHPUnit'; +} diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/DirectTrigger.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/DirectTrigger.php deleted file mode 100644 index bbb3c66a8..000000000 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/DirectTrigger.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Event\Code\IssueTrigger; - -/** - * @immutable - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - */ -final class DirectTrigger extends IssueTrigger -{ - /** - * Your own code triggers an issue in third-party code. - */ - public function isDirect(): true - { - return true; - } - - public function asString(): string - { - return 'issue triggered by first-party code calling into third-party code'; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/IndirectTrigger.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/IndirectTrigger.php deleted file mode 100644 index 81f76b45e..000000000 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/IndirectTrigger.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Event\Code\IssueTrigger; - -/** - * @immutable - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - */ -final class IndirectTrigger extends IssueTrigger -{ - /** - * Third-party code triggers an issue either in your own code or in third-party code. - */ - public function isIndirect(): true - { - return true; - } - - public function asString(): string - { - return 'issue triggered by third-party code'; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/IssueTrigger.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/IssueTrigger.php index 93e42c729..5314053c1 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/IssueTrigger.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/IssueTrigger.php @@ -9,89 +9,101 @@ */ namespace PHPUnit\Event\Code\IssueTrigger; +use function sprintf; + /** * @immutable * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ -abstract class IssueTrigger +final readonly class IssueTrigger { - public static function test(): TestTrigger - { - return new TestTrigger; - } + private ?Code $callee; + private ?Code $caller; - public static function self(): SelfTrigger + public static function from(?Code $callee, ?Code $caller): self { - return new SelfTrigger; + return new self($callee, $caller); } - public static function direct(): DirectTrigger + private function __construct(?Code $callee, ?Code $caller) { - return new DirectTrigger; + $this->callee = $callee; + $this->caller = $caller; } - public static function indirect(): IndirectTrigger + /** + * An issue is triggered in first-party code or in test code. + */ + public function isSelf(): bool { - return new IndirectTrigger; + return $this->callee !== null && $this->callee->isFirstPartyOrTest(); } - public static function unknown(): UnknownTrigger + /** + * First-party code triggers an issue in third-party code. + */ + public function isDirect(): bool { - return new UnknownTrigger; + return $this->caller !== null && $this->caller->isFirstPartyOrTest() && + $this->callee !== null && $this->callee->isThirdPartyOrPhpunitOrPhp(); } - final private function __construct() + /** + * Third-party code triggers an issue. + */ + public function isIndirect(): bool { + return $this->caller !== null && $this->caller->isThirdPartyOrPhpunitOrPhp() && + $this->callee !== null && $this->callee->isThirdPartyOrPhpunitOrPhp(); } - /** - * Your test code triggers an issue. - * - * @phpstan-assert-if-true TestTrigger $this - */ - public function isTest(): bool + public function isUnknown(): bool { - return false; + return !$this->isSelf() && !$this->isDirect() && !$this->isIndirect(); } /** - * Your own code triggers an issue in your own code. - * - * @phpstan-assert-if-true SelfTrigger $this + * @return non-empty-string */ - public function isSelf(): bool + public function callerAsString(): string { - return false; + return $this->codeAsString($this->caller); } /** - * Your own code triggers an issue in third-party code. - * - * @phpstan-assert-if-true DirectTrigger $this + * @return non-empty-string */ - public function isDirect(): bool + public function calleeAsString(): string { - return false; + return $this->codeAsString($this->callee); } /** - * Third-party code triggers an issue either in your own code or in third-party code. - * - * @phpstan-assert-if-true IndirectTrigger $this + * @return non-empty-string */ - public function isIndirect(): bool + public function asString(): string { - return false; + if ($this->callee === null || $this->caller === null) { + return 'unknown if issue was triggered in first-party code or third-party code'; + } + + return sprintf( + 'issue triggered by %s calling into %s', + $this->caller->value, + $this->callee->value, + ); } /** - * @phpstan-assert-if-true UnknownTrigger $this + * @return non-empty-string */ - public function isUnknown(): bool + private function codeAsString(?Code $code): string { - return false; - } + if ($code === null) { + return 'unknown'; + } - abstract public function asString(): string; + return $code->value; + } } diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/SelfTrigger.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/SelfTrigger.php deleted file mode 100644 index e569e72f5..000000000 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/SelfTrigger.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Event\Code\IssueTrigger; - -/** - * @immutable - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - */ -final class SelfTrigger extends IssueTrigger -{ - /** - * Your own code triggers an issue in your own code. - */ - public function isSelf(): true - { - return true; - } - - public function asString(): string - { - return 'issue triggered by first-party code calling into first-party code'; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/TestTrigger.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/TestTrigger.php deleted file mode 100644 index 4768baca6..000000000 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/TestTrigger.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Event\Code\IssueTrigger; - -/** - * @immutable - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - */ -final class TestTrigger extends IssueTrigger -{ - /** - * Your test code triggers an issue. - */ - public function isTest(): true - { - return true; - } - - public function asString(): string - { - return 'issue triggered by test code'; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/UnknownTrigger.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/UnknownTrigger.php deleted file mode 100644 index 61f811489..000000000 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Issue/UnknownTrigger.php +++ /dev/null @@ -1,28 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Event\Code\IssueTrigger; - -/** - * @immutable - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - */ -final class UnknownTrigger extends IssueTrigger -{ - public function isUnknown(): true - { - return true; - } - - public function asString(): string - { - return 'unknown if issue was triggered in first-party code or third-party code'; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Test.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Test.php index 43ed73eb7..943c056a1 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/Test.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/Test.php @@ -23,6 +23,8 @@ /** * @param non-empty-string $file + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(string $file) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollection.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollection.php index 1924b64b6..265c01b19 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollection.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollection.php @@ -14,7 +14,7 @@ use IteratorAggregate; /** - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate * * @immutable * diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollectionIterator.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollectionIterator.php index 7c96f3409..b45b16354 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestCollectionIterator.php @@ -9,11 +9,10 @@ */ namespace PHPUnit\Event\Code; -use function count; use Iterator; /** - * @template-implements Iterator + * @template-implements Iterator * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ @@ -23,8 +22,15 @@ final class TestCollectionIterator implements Iterator * @var list */ private readonly array $tests; + + /** + * @var non-negative-int + */ private int $position = 0; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(TestCollection $tests) { $this->tests = $tests->asArray(); @@ -37,9 +43,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->tests); + return isset($this->tests[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollection.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollection.php index 460f0c0c5..44aefae49 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollection.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollection.php @@ -14,7 +14,7 @@ use IteratorAggregate; /** - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollectionIterator.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollectionIterator.php index aebed66ca..228814312 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestData/TestDataCollectionIterator.php @@ -9,11 +9,10 @@ */ namespace PHPUnit\Event\TestData; -use function count; use Iterator; /** - * @template-implements Iterator + * @template-implements Iterator * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ @@ -23,8 +22,15 @@ final class TestDataCollectionIterator implements Iterator * @var list */ private readonly array $data; + + /** + * @var non-negative-int + */ private int $position = 0; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(TestDataCollection $data) { $this->data = $data->asArray(); @@ -37,9 +43,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->data); + return isset($this->data[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestDox.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestDox.php index 53604dbfc..aacf20dc7 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestDox.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestDox.php @@ -20,6 +20,9 @@ private string $prettifiedMethodName; private string $prettifiedAndColorizedMethodName; + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ public function __construct(string $prettifiedClassName, string $prettifiedMethodName, string $prettifiedAndColorizedMethodName) { $this->prettifiedClassName = $prettifiedClassName; diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestMethod.php b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestMethod.php index 4c9726454..3cc259083 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestMethod.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Test/TestMethod.php @@ -44,6 +44,8 @@ * @param non-empty-string $methodName * @param non-empty-string $file * @param non-negative-int $line + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(string $className, string $methodName, string $file, int $line, TestDox $testDox, MetadataCollection $metadata, TestDataCollection $testData) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuite.php b/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuite.php index 783de57bd..73672ae00 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuite.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuite.php @@ -27,6 +27,8 @@ /** * @param non-empty-string $name + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(string $name, int $size, TestCollection $tests) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestClass.php b/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestClass.php index 34ad9d5ea..77ba7ed74 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestClass.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestClass.php @@ -27,6 +27,8 @@ /** * @param class-string $name + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(string $name, int $size, TestCollection $tests, string $file, int $line) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestMethodWithDataProvider.php b/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestMethodWithDataProvider.php index 67a94391d..d1510f401 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestMethodWithDataProvider.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/TestSuite/TestSuiteForTestMethodWithDataProvider.php @@ -34,6 +34,8 @@ * @param non-empty-string $name * @param class-string $className * @param non-empty-string $methodName + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(string $name, int $size, TestCollection $tests, string $className, string $methodName, string $file, int $line) { diff --git a/app/vendor/phpunit/phpunit/src/Event/Value/Throwable.php b/app/vendor/phpunit/phpunit/src/Event/Value/Throwable.php index e48cf1a3a..e1c419156 100644 --- a/app/vendor/phpunit/phpunit/src/Event/Value/Throwable.php +++ b/app/vendor/phpunit/phpunit/src/Event/Value/Throwable.php @@ -30,6 +30,8 @@ /** * @param class-string $className + * + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ public function __construct(string $className, string $message, string $description, string $stackTrace, ?self $previous) { diff --git a/app/vendor/phpunit/phpunit/src/Framework/Assert.php b/app/vendor/phpunit/phpunit/src/Framework/Assert.php index 91f940af3..92b31a6bd 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Assert.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Assert.php @@ -16,12 +16,12 @@ use function file_get_contents; use function interface_exists; use function is_bool; -use function sprintf; use ArrayAccess; use Countable; use Generator; -use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Framework\Constraint\ArrayHasKey; +use PHPUnit\Framework\Constraint\ArraysAreEqual; +use PHPUnit\Framework\Constraint\ArraysAreIdentical; use PHPUnit\Framework\Constraint\Callback; use PHPUnit\Framework\Constraint\Constraint; use PHPUnit\Framework\Constraint\Count; @@ -209,6 +209,154 @@ final public static function assertIsList(mixed $array, string $message = ''): v ); } + /** + * Assert that two arrays are identical. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array matters, and keys as well as values are compared strictly. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + */ + final public static function assertArraysAreIdentical(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreIdentical($expected, true, true), + $message, + ); + } + + /** + * Assert that two arrays are identical while ignoring the order of their values. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array does not matter, and keys as well as values are compared strictly. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + */ + final public static function assertArraysAreIdenticalIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreIdentical($expected, true, false), + $message, + ); + } + + /** + * Assert that two arrays have identical values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array matters, and values are compared strictly. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + */ + final public static function assertArraysHaveIdenticalValues(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreIdentical($expected, false, true), + $message, + ); + } + + /** + * Assert that two arrays have identical values while ignoring the order of these values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array does not matter, and values are compared strictly. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + */ + final public static function assertArraysHaveIdenticalValuesIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreIdentical($expected, false, false), + $message, + ); + } + + /** + * Assert that two arrays are equal. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array matters, and keys as well as values are compared loosely. + * + * @param array $expected + * @param array $actual + */ + final public static function assertArraysAreEqual(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreEqual($expected, true, true), + $message, + ); + } + + /** + * Assert that two arrays are equal while ignoring the order of their values. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array does not matter, and keys as well as values are compared loosely. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + */ + final public static function assertArraysAreEqualIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreEqual($expected, true, false), + $message, + ); + } + + /** + * Assert that two arrays have equal values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array matters, and values are compared loosely. + * + * @param array $expected + * @param array $actual + */ + final public static function assertArraysHaveEqualValues(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreEqual($expected, false, true), + $message, + ); + } + + /** + * Assert that two arrays have equal values while ignoring the order of these values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array does not matter, and values are compared loosely. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + */ + final public static function assertArraysHaveEqualValuesIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + self::assertThat( + $actual, + new ArraysAreEqual($expected, false, false), + $message, + ); + } + /** * Asserts that a haystack contains a needle. * @@ -265,73 +413,6 @@ final public static function assertNotContainsEquals(mixed $needle, iterable $ha self::assertThat($haystack, $constraint, $message); } - /** - * Asserts that a haystack contains only values of a given type. - * - * @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource (closed)'|'resource'|'scalar'|'string' $type - * @param iterable $haystack - * - * @throws Exception - * @throws ExpectationFailedException - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6056 - */ - final public static function assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void - { - if ($isNativeType === null) { - $isNativeType = self::isNativeType($type); - } - - if ($isNativeType) { - $replacement = match ($type) { - 'array' => 'assertContainsOnlyArray', - 'bool' => 'assertContainsOnlyBool', - 'boolean' => 'assertContainsOnlyBool', - 'callable' => 'assertContainsOnlyCallable', - 'double' => 'assertContainsOnlyFloat', - 'float' => 'assertContainsOnlyFloat', - 'int' => 'assertContainsOnlyInt', - 'integer' => 'assertContainsOnlyInt', - 'iterable' => 'assertContainsOnlyIterable', - 'null' => 'assertContainsOnlyNull', - 'numeric' => 'assertContainsOnlyNumeric', - 'object' => 'assertContainsOnlyObject', - 'real' => 'assertContainsOnlyFloat', - 'resource' => 'assertContainsOnlyResource', - 'resource (closed)' => 'assertContainsOnlyClosedResource', - 'scalar' => 'assertContainsOnlyScalar', - 'string' => 'assertContainsOnlyString', - }; - - EventFacade::emitter()->testTriggeredPhpunitDeprecation( - null, - sprintf( - 'assertContainsOnly() is deprecated and will be removed in PHPUnit 13. ' . - 'Please use %s($haystack) instead of assertContainsOnly(\'%s\', $haystack).', - $replacement, - $type, - ), - ); - - $constraint = TraversableContainsOnly::forNativeType(self::mapNativeType($type)); - } else { - EventFacade::emitter()->testTriggeredPhpunitDeprecation( - null, - sprintf( - 'assertContainsOnly() is deprecated and will be removed in PHPUnit 13. ' . - 'Please use assertContainsOnlyInstancesOf(\'%s\', $haystack) instead of assertContainsOnly(\'%s\', $haystack).', - $type, - $type, - ), - ); - - /** @phpstan-ignore argument.type */ - $constraint = TraversableContainsOnly::forClassOrInterface($type); - } - - self::assertThat($haystack, $constraint, $message); - } - /** * Asserts that a haystack contains only values of type array. * @@ -614,77 +695,6 @@ final public static function assertContainsOnlyInstancesOf(string $className, it ); } - /** - * Asserts that a haystack does not contain only values of a given type. - * - * @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource (closed)'|'resource'|'scalar'|'string' $type - * @param iterable $haystack - * - * @throws Exception - * @throws ExpectationFailedException - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6056 - */ - final public static function assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void - { - if ($isNativeType === null) { - $isNativeType = self::isNativeType($type); - } - - if ($isNativeType) { - $replacement = match ($type) { - 'array' => 'assertContainsNotOnlyArray', - 'bool' => 'assertContainsNotOnlyBool', - 'boolean' => 'assertContainsNotOnlyBool', - 'callable' => 'assertContainsNotOnlyCallable', - 'double' => 'assertContainsNotOnlyFloat', - 'float' => 'assertContainsNotOnlyFloat', - 'int' => 'assertContainsNotOnlyInt', - 'integer' => 'assertContainsNotOnlyInt', - 'iterable' => 'assertContainsNotOnlyIterable', - 'null' => 'assertContainsNotOnlyNull', - 'numeric' => 'assertContainsNotOnlyNumeric', - 'object' => 'assertContainsNotOnlyObject', - 'real' => 'assertContainsNotOnlyFloat', - 'resource' => 'assertContainsNotOnlyResource', - 'resource (closed)' => 'assertContainsNotOnlyClosedResource', - 'scalar' => 'assertContainsNotOnlyScalar', - 'string' => 'assertContainsNotOnlyString', - }; - - EventFacade::emitter()->testTriggeredPhpunitDeprecation( - null, - sprintf( - 'assertNotContainsOnly() is deprecated and will be removed in PHPUnit 13. ' . - 'Please use %s($haystack) instead of assertNotContainsOnly(\'%s\', $haystack).', - $replacement, - $type, - ), - ); - - $constraint = TraversableContainsOnly::forNativeType(self::mapNativeType($type)); - } else { - EventFacade::emitter()->testTriggeredPhpunitDeprecation( - null, - sprintf( - 'assertNotContainsOnly() is deprecated and will be removed in PHPUnit 13. ' . - 'Please use assertContainsNotOnlyInstancesOf(\'%s\', $haystack) instead of assertNotContainsOnly(\'%s\', $haystack).', - $type, - $type, - ), - ); - - /** @phpstan-ignore argument.type */ - $constraint = TraversableContainsOnly::forClassOrInterface($type); - } - - self::assertThat( - $haystack, - new LogicalNot($constraint), - $message, - ); - } - /** * Asserts that a haystack does not contain only values of type array. * @@ -1012,6 +1022,8 @@ final public static function assertNotCount(int $expectedCount, Countable|iterab /** * Asserts that two variables are equal. * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertEquals(mixed $expected, mixed $actual, string $message = ''): void @@ -1024,6 +1036,8 @@ final public static function assertEquals(mixed $expected, mixed $actual, string /** * Asserts that two variables are equal (canonicalizing). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertEqualsCanonicalizing(mixed $expected, mixed $actual, string $message = ''): void @@ -1036,6 +1050,8 @@ final public static function assertEqualsCanonicalizing(mixed $expected, mixed $ /** * Asserts that two variables are equal (ignoring case). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertEqualsIgnoringCase(mixed $expected, mixed $actual, string $message = ''): void @@ -1048,6 +1064,8 @@ final public static function assertEqualsIgnoringCase(mixed $expected, mixed $ac /** * Asserts that two variables are equal (with delta). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message = ''): void @@ -1063,6 +1081,8 @@ final public static function assertEqualsWithDelta(mixed $expected, mixed $actua /** * Asserts that two variables are not equal. * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertNotEquals(mixed $expected, mixed $actual, string $message = ''): void @@ -1077,6 +1097,8 @@ final public static function assertNotEquals(mixed $expected, mixed $actual, str /** * Asserts that two variables are not equal (canonicalizing). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertNotEqualsCanonicalizing(mixed $expected, mixed $actual, string $message = ''): void @@ -1091,6 +1113,8 @@ final public static function assertNotEqualsCanonicalizing(mixed $expected, mixe /** * Asserts that two variables are not equal (ignoring case). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertNotEqualsIgnoringCase(mixed $expected, mixed $actual, string $message = ''): void @@ -1105,6 +1129,8 @@ final public static function assertNotEqualsIgnoringCase(mixed $expected, mixed /** * Asserts that two variables are not equal (with delta). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException */ final public static function assertNotEqualsWithDelta(mixed $expected, mixed $actual, float $delta, string $message = ''): void @@ -1724,6 +1750,8 @@ final public static function assertObjectNotHasProperty(string $propertyName, ob * Used on objects, it asserts that two variables reference * the same object. * + * Comparison is performed using the === operator. + * * @template ExpectedType * * @param ExpectedType $expected @@ -1746,6 +1774,8 @@ final public static function assertSame(mixed $expected, mixed $actual, string $ * Used on objects, it asserts that two variables do not reference * the same object. * + * Comparison is performed using the === operator. + * * @throws ExpectationFailedException */ final public static function assertNotSame(mixed $expected, mixed $actual, string $message = ''): void @@ -2813,18 +2843,6 @@ final public static function containsIdentical(mixed $value): TraversableContain return new TraversableContainsIdentical($value); } - /** - * @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource (closed)'|'resource'|'scalar'|'string' $type - * - * @throws Exception - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6060 - */ - final public static function containsOnly(string $type): TraversableContainsOnly - { - return TraversableContainsOnly::forNativeType(self::mapNativeType($type)); - } - final public static function containsOnlyArray(): TraversableContainsOnly { return TraversableContainsOnly::forNativeType(NativeType::Array); @@ -3041,50 +3059,6 @@ final public static function isString(): IsType return new IsType(NativeType::String); } - /** - * @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource (closed)'|'resource'|'scalar'|'string' $type - * - * @throws UnknownNativeTypeException - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6053 - */ - final public static function isType(string $type): IsType - { - $constraint = new IsType(self::mapNativeType($type)); - - $replacement = match ($type) { - 'array' => 'isArray', - 'bool' => 'isBool', - 'boolean' => 'isBool', - 'callable' => 'isCallable', - 'double' => 'isFloat', - 'float' => 'isFloat', - 'int' => 'isInt', - 'integer' => 'isInt', - 'iterable' => 'isIterable', - 'null' => 'isNull', - 'numeric' => 'isNumeric', - 'object' => 'isObject', - 'real' => 'isFloat', - 'resource' => 'isResource', - 'resource (closed)' => 'isClosedResource', - 'scalar' => 'isScalar', - 'string' => 'isString', - }; - - EventFacade::emitter()->testTriggeredPhpunitDeprecation( - null, - sprintf( - 'isType(\'%s\') is deprecated and will be removed in PHPUnit 13. ' . - 'Please use the %s() method instead.', - $type, - $replacement, - ), - ); - - return $constraint; - } - final public static function lessThan(mixed $value): LessThan { return new LessThan($value); @@ -3195,56 +3169,4 @@ final public static function resetCount(): void { self::$count = 0; } - - private static function isNativeType(string $type): bool - { - return $type === 'array' || - $type === 'bool' || - $type === 'boolean' || - $type === 'callable' || - $type === 'double' || - $type === 'float' || - $type === 'int' || - $type === 'integer' || - $type === 'iterable' || - $type === 'null' || - $type === 'numeric' || - $type === 'object' || - $type === 'real' || - $type === 'resource' || - $type === 'resource (closed)' || - $type === 'scalar' || - $type === 'string'; - } - - /** - * @throws UnknownNativeTypeException - */ - private static function mapNativeType(string $type): NativeType - { - if (!self::isNativeType($type)) { - throw new UnknownNativeTypeException($type); - } - - /** @phpstan-ignore match.unhandled */ - return match ($type) { - 'array' => NativeType::Array, - 'bool' => NativeType::Bool, - 'boolean' => NativeType::Bool, - 'callable' => NativeType::Callable, - 'double' => NativeType::Float, - 'float' => NativeType::Float, - 'int' => NativeType::Int, - 'integer' => NativeType::Int, - 'iterable' => NativeType::Iterable, - 'null' => NativeType::Null, - 'numeric' => NativeType::Numeric, - 'object' => NativeType::Object, - 'real' => NativeType::Float, - 'resource' => NativeType::Resource, - 'resource (closed)' => NativeType::ClosedResource, - 'scalar' => NativeType::Scalar, - 'string' => NativeType::String, - }; - } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php b/app/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php index 0645fd262..71489c7aa 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Assert/Functions.php @@ -9,10 +9,12 @@ */ namespace PHPUnit\Framework; +use const PHP_EOL; use function func_get_args; use function function_exists; use ArrayAccess; use Countable; +use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Framework\Constraint\ArrayHasKey; use PHPUnit\Framework\Constraint\Callback; use PHPUnit\Framework\Constraint\Constraint; @@ -201,6 +203,176 @@ function assertIsList(mixed $array, string $message = ''): void } } +if (!function_exists('PHPUnit\Framework\assertArraysAreIdentical')) { + /** + * Assert that two arrays are identical. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array matters, and keys as well as values are compared strictly. + * This is essentially an alias for assertSame(). + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysAreIdentical + */ + function assertArraysAreIdentical(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysAreIdentical(...func_get_args()); + } +} + +if (!function_exists('PHPUnit\Framework\assertArraysAreEqual')) { + /** + * Assert that two arrays are equal. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array matters, and keys as well as values are compared loosely. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysAreEqual + */ + function assertArraysAreEqual(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysAreEqual(...func_get_args()); + } +} + +if (!function_exists('PHPUnit\Framework\assertArraysAreIdenticalIgnoringOrder')) { + /** + * Assert that two arrays are identical while ignoring the order of their values. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array does not matter, and keys as well as values are compared strictly. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysAreIdenticalIgnoringOrder + */ + function assertArraysAreIdenticalIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysAreIdenticalIgnoringOrder(...func_get_args()); + } +} + +if (!function_exists('PHPUnit\Framework\assertArraysAreEqualIgnoringOrder')) { + /** + * Assert that two arrays are equal while ignoring the order of their values. + * + * The (key, value) relationship matters, the order of the (key, value) pairs in the array does not matter, and keys as well as values are compared loosely. + * This is essentially an alias for assertEquals(). + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysAreEqualIgnoringOrder + */ + function assertArraysAreEqualIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysAreEqualIgnoringOrder(...func_get_args()); + } +} + +if (!function_exists('PHPUnit\Framework\assertArraysHaveIdenticalValues')) { + /** + * Assert that two arrays have identical values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array matters, and values are compared strictly. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysHaveIdenticalValues + */ + function assertArraysHaveIdenticalValues(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysHaveIdenticalValues(...func_get_args()); + } +} + +if (!function_exists('PHPUnit\Framework\assertArraysHaveEqualValues')) { + /** + * Assert that two arrays have equal values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array matters, and values are compared loosely. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysHaveEqualValues + */ + function assertArraysHaveEqualValues(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysHaveEqualValues(...func_get_args()); + } +} + +if (!function_exists('PHPUnit\Framework\assertArraysHaveIdenticalValuesIgnoringOrder')) { + /** + * Assert that two arrays have identical values while ignoring the order of these values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array does not matter, and values are compared strictly. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysHaveIdenticalValuesIgnoringOrder + */ + function assertArraysHaveIdenticalValuesIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysHaveIdenticalValuesIgnoringOrder(...func_get_args()); + } +} + +if (!function_exists('PHPUnit\Framework\assertArraysHaveEqualValuesIgnoringOrder')) { + /** + * Assert that two arrays have equal values while ignoring the order of these values. + * + * The (key, value) relationship does not matter, the order of the (key, value) pairs in the array does not matter, and values are compared loosely. + * + * @param array $expected + * @param array $actual + * + * @throws ExpectationFailedException + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @see Assert::assertArraysHaveEqualValuesIgnoringOrder + */ + function assertArraysHaveEqualValuesIgnoringOrder(array $expected, array $actual, string $message = ''): void + { + Assert::assertArraysHaveEqualValuesIgnoringOrder(...func_get_args()); + } +} + if (!function_exists('PHPUnit\Framework\assertContains')) { /** * Asserts that a haystack contains a needle. @@ -271,28 +443,6 @@ function assertNotContainsEquals(mixed $needle, iterable $haystack, string $mess } } -if (!function_exists('PHPUnit\Framework\assertContainsOnly')) { - /** - * Asserts that a haystack contains only values of a given type. - * - * @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource (closed)'|'resource'|'scalar'|'string' $type - * @param iterable $haystack - * - * @throws Exception - * @throws ExpectationFailedException - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6056 - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @see Assert::assertContainsOnly - */ - function assertContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void - { - Assert::assertContainsOnly(...func_get_args()); - } -} - if (!function_exists('PHPUnit\Framework\assertContainsOnlyArray')) { /** * Asserts that a haystack contains only values of type array. @@ -577,28 +727,6 @@ function assertContainsOnlyInstancesOf(string $className, iterable $haystack, st } } -if (!function_exists('PHPUnit\Framework\assertNotContainsOnly')) { - /** - * Asserts that a haystack does not contain only values of a given type. - * - * @param 'array'|'bool'|'boolean'|'callable'|'double'|'float'|'int'|'integer'|'iterable'|'null'|'numeric'|'object'|'real'|'resource (closed)'|'resource'|'scalar'|'string' $type - * @param iterable $haystack - * - * @throws Exception - * @throws ExpectationFailedException - * - * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6056 - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @see Assert::assertNotContainsOnly - */ - function assertNotContainsOnly(string $type, iterable $haystack, ?bool $isNativeType = null, string $message = ''): void - { - Assert::assertNotContainsOnly(...func_get_args()); - } -} - if (!function_exists('PHPUnit\Framework\assertContainsNotOnlyArray')) { /** * Asserts that a haystack does not contain only values of type array. @@ -897,6 +1025,8 @@ function assertNotCount(int $expectedCount, Countable|iterable $haystack, string /** * Asserts that two variables are equal. * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -913,6 +1043,8 @@ function assertEquals(mixed $expected, mixed $actual, string $message = ''): voi /** * Asserts that two variables are equal (canonicalizing). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -929,6 +1061,8 @@ function assertEqualsCanonicalizing(mixed $expected, mixed $actual, string $mess /** * Asserts that two variables are equal (ignoring case). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -945,6 +1079,8 @@ function assertEqualsIgnoringCase(mixed $expected, mixed $actual, string $messag /** * Asserts that two variables are equal (with delta). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -961,6 +1097,8 @@ function assertEqualsWithDelta(mixed $expected, mixed $actual, float $delta, str /** * Asserts that two variables are not equal. * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -977,6 +1115,8 @@ function assertNotEquals(mixed $expected, mixed $actual, string $message = ''): /** * Asserts that two variables are not equal (canonicalizing). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -993,6 +1133,8 @@ function assertNotEqualsCanonicalizing(mixed $expected, mixed $actual, string $m /** * Asserts that two variables are not equal (ignoring case). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -1009,6 +1151,8 @@ function assertNotEqualsIgnoringCase(mixed $expected, mixed $actual, string $mes /** * Asserts that two variables are not equal (with delta). * + * Comparison is performed using the == operator (loose comparison) and may be performed by a type-specific comparator which may apply type coercion. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -1801,6 +1945,8 @@ function assertObjectNotHasProperty(string $propertyName, object $object, string * Used on objects, it asserts that two variables reference * the same object. * + * Comparison is performed using the === operator. + * * @template ExpectedType * * @param ExpectedType $expected @@ -1825,6 +1971,8 @@ function assertSame(mixed $expected, mixed $actual, string $message = ''): void * Used on objects, it asserts that two variables do not reference * the same object. * + * Comparison is performed using the === operator. + * * @throws ExpectationFailedException * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -2971,13 +3119,6 @@ function containsIdentical(mixed $value): TraversableContainsIdentical } } -if (!function_exists('PHPUnit\Framework\containsOnly')) { - function containsOnly(string $type): TraversableContainsOnly - { - return Assert::containsOnly(...func_get_args()); - } -} - if (!function_exists('PHPUnit\Framework\containsOnlyArray')) { function containsOnlyArray(): TraversableContainsOnly { @@ -3265,13 +3406,6 @@ function isString(): IsType } } -if (!function_exists('PHPUnit\Framework\isType')) { - function isType(string $type): IsType - { - return Assert::isType(...func_get_args()); - } -} - if (!function_exists('PHPUnit\Framework\lessThan')) { function lessThan(mixed $value): LessThan { @@ -3360,6 +3494,8 @@ function callback(callable $callback): Callback /** * Returns a matcher that matches when the method is executed * zero or more times. + * + * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6461 */ function any(): AnyInvokedCountMatcher { @@ -3384,6 +3520,14 @@ function never(): InvokedCountMatcher */ function atLeast(int $requiredInvocations): InvokedAtLeastCountMatcher { + if ($requiredInvocations < 1) { + EventFacade::emitter()->testTriggeredPhpunitDeprecation( + null, + 'Calling atLeast() with an argument that is not positive is deprecated.' . PHP_EOL . + 'This will become an error in PHPUnit 14.', + ); + } + return new InvokedAtLeastCountMatcher( $requiredInvocations, ); diff --git a/app/vendor/phpunit/phpunit/src/Framework/Attributes/AllowMockObjectsWithoutExpectations.php b/app/vendor/phpunit/phpunit/src/Framework/Attributes/AllowMockObjectsWithoutExpectations.php new file mode 100644 index 000000000..4b8e3849a --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/Attributes/AllowMockObjectsWithoutExpectations.php @@ -0,0 +1,22 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\Attributes; + +use Attribute; + +/** + * @immutable + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] +final readonly class AllowMockObjectsWithoutExpectations +{ +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProvider.php b/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProvider.php index 0e95c5020..fc4a822f6 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProvider.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProvider.php @@ -23,13 +23,15 @@ * @var non-empty-string */ private string $methodName; + private bool $validateArgumentCount; /** * @param non-empty-string $methodName */ - public function __construct(string $methodName) + public function __construct(string $methodName, bool $validateArgumentCount = true) { - $this->methodName = $methodName; + $this->methodName = $methodName; + $this->validateArgumentCount = $validateArgumentCount; } /** @@ -39,4 +41,9 @@ public function methodName(): string { return $this->methodName; } + + public function validateArgumentCount(): bool + { + return $this->validateArgumentCount; + } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProviderClosure.php b/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProviderClosure.php new file mode 100644 index 000000000..370887f79 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProviderClosure.php @@ -0,0 +1,41 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\Attributes; + +use Attribute; +use Closure; + +/** + * @immutable + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +#[Attribute(Attribute::TARGET_METHOD | Attribute::IS_REPEATABLE)] +final readonly class DataProviderClosure +{ + private Closure $closure; + private bool $validateArgumentCount; + + public function __construct(Closure $closure, bool $validateArgumentCount = true) + { + $this->closure = $closure; + $this->validateArgumentCount = $validateArgumentCount; + } + + public function closure(): Closure + { + return $this->closure; + } + + public function validateArgumentCount(): bool + { + return $this->validateArgumentCount; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProviderExternal.php b/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProviderExternal.php index 9d05cef27..e1f11ab13 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProviderExternal.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Attributes/DataProviderExternal.php @@ -28,15 +28,17 @@ * @var non-empty-string */ private string $methodName; + private bool $validateArgumentCount; /** * @param class-string $className * @param non-empty-string $methodName */ - public function __construct(string $className, string $methodName) + public function __construct(string $className, string $methodName, bool $validateArgumentCount = true) { - $this->className = $className; - $this->methodName = $methodName; + $this->className = $className; + $this->methodName = $methodName; + $this->validateArgumentCount = $validateArgumentCount; } /** @@ -54,4 +56,9 @@ public function methodName(): string { return $this->methodName; } + + public function validateArgumentCount(): bool + { + return $this->validateArgumentCount; + } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Attributes/IgnoreDeprecations.php b/app/vendor/phpunit/phpunit/src/Framework/Attributes/IgnoreDeprecations.php index 6cde66b09..d137edd78 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Attributes/IgnoreDeprecations.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Attributes/IgnoreDeprecations.php @@ -19,4 +19,22 @@ #[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)] final readonly class IgnoreDeprecations { + /** @var null|non-empty-string */ + private ?string $messagePattern; + + /** + * @param null|non-empty-string $messagePattern + */ + public function __construct(null|string $messagePattern = null) + { + $this->messagePattern = $messagePattern; + } + + /** + * @return null|non-empty-string + */ + public function messagePattern(): ?string + { + return $this->messagePattern; + } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Attributes/RunClassInSeparateProcess.php b/app/vendor/phpunit/phpunit/src/Framework/Attributes/RunClassInSeparateProcess.php deleted file mode 100644 index 749ea3d9b..000000000 --- a/app/vendor/phpunit/phpunit/src/Framework/Attributes/RunClassInSeparateProcess.php +++ /dev/null @@ -1,22 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Framework\Attributes; - -use Attribute; - -/** - * @immutable - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - */ -#[Attribute(Attribute::TARGET_CLASS)] -final readonly class RunClassInSeparateProcess -{ -} diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArrayComparison.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArrayComparison.php new file mode 100644 index 000000000..827c66cf0 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArrayComparison.php @@ -0,0 +1,211 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\Constraint; + +use function array_key_exists; +use function array_values; +use function count; +use function is_array; +use PHPUnit\Framework\ExpectationFailedException; +use PHPUnit\Util\Exporter; +use SebastianBergmann\Comparator\ComparisonFailure; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +abstract class ArrayComparison extends Constraint +{ + /** + * @var array + */ + protected readonly array $expected; + protected readonly bool $keysMatter; + protected readonly bool $orderMatters; + + /** + * @param array $expected + */ + public function __construct(array $expected, bool $keysMatter, bool $orderMatters) + { + $this->expected = $expected; + $this->keysMatter = $keysMatter; + $this->orderMatters = $orderMatters; + } + + /** + * Evaluates the constraint for parameter $other. + * + * If $returnResult is set to false (the default), an exception is thrown + * in case of a failure. null is returned otherwise. + * + * If $returnResult is true, the result of the evaluation is returned as + * a boolean value instead: true in case of success, false in case of a + * failure. + * + * @throws ExpectationFailedException + */ + public function evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool + { + if (!is_array($other)) { + return false; + } + + $success = $this->compare($this->expected, $other); + + if ($returnResult) { + return $success; + } + + if (!$success) { + $this->fail( + $other, + $description, + new ComparisonFailure( + $this->expected, + $other, + Exporter::export($this->expected), + Exporter::export($other), + ), + ); + } + + // @codeCoverageIgnoreStart + return null; + // @codeCoverageIgnoreEnd + } + + /** + * Returns a string representation of the constraint. + */ + public function toString(): string + { + if ($this->keysMatter && $this->orderMatters) { + return 'two arrays are ' . $this->comparisonType(); + } + + if (!$this->keysMatter && !$this->orderMatters) { + return 'two arrays are ' . $this->comparisonType() . ' while ignoring keys and order'; + } + + if (!$this->keysMatter) { + return 'two arrays are ' . $this->comparisonType() . ' while ignoring keys'; + } + + return 'two arrays are ' . $this->comparisonType() . ' while ignoring order'; + } + + /** + * Returns the description of the failure. + * + * The beginning of failure messages is "Failed asserting that" in most + * cases. This method should return the second part of that sentence. + */ + protected function failureDescription(mixed $other): string + { + return $this->toString(); + } + + /** + * @return 'equal'|'identical' + */ + abstract protected function comparisonType(): string; + + /** + * Compares two non-array values (or two arrays in modes where order at + * every level is significant) using the strictness defined by the + * concrete subclass. + */ + abstract protected function compareLeaf(mixed $expected, mixed $actual): bool; + + /** + * Compares two values, recursing into arrays as needed. + * + * Whenever both $expected and $actual are arrays, the same comparison + * mode (controlled by $keysMatter and $orderMatters) is applied at every + * level of nesting. For all other value combinations, the leaf comparison + * provided by the concrete subclass is used. + */ + private function compare(mixed $expected, mixed $actual): bool + { + if (!is_array($expected) || !is_array($actual)) { + return $this->compareLeaf($expected, $actual); + } + + if ($this->keysMatter && $this->orderMatters) { + return $this->compareLeaf($expected, $actual); + } + + if (!$this->keysMatter && $this->orderMatters) { + return $this->compareLeaf(array_values($expected), array_values($actual)); + } + + if ($this->keysMatter) { + return $this->compareKeyedIgnoringOrder($expected, $actual); + } + + return $this->compareIgnoringKeysAndOrder($expected, $actual); + } + + /** + * @param array $expected + * @param array $actual + */ + private function compareKeyedIgnoringOrder(array $expected, array $actual): bool + { + if (count($expected) !== count($actual)) { + return false; + } + + foreach ($expected as $key => $value) { + if (!array_key_exists($key, $actual)) { + return false; + } + + if (!$this->compare($value, $actual[$key])) { + return false; + } + } + + return true; + } + + /** + * @param array $expected + * @param array $actual + */ + private function compareIgnoringKeysAndOrder(array $expected, array $actual): bool + { + if (count($expected) !== count($actual)) { + return false; + } + + $remaining = array_values($actual); + + foreach ($expected as $expectedValue) { + $matchedIndex = null; + + foreach ($remaining as $index => $candidate) { + if ($this->compare($expectedValue, $candidate)) { + $matchedIndex = $index; + + break; + } + } + + if ($matchedIndex === null) { + return false; + } + + unset($remaining[$matchedIndex]); + } + + return true; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Traversable/ArrayHasKey.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArrayHasKey.php similarity index 100% rename from app/vendor/phpunit/phpunit/src/Framework/Constraint/Traversable/ArrayHasKey.php rename to app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArrayHasKey.php diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArraysAreEqual.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArraysAreEqual.php new file mode 100644 index 000000000..3b04eb3f1 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArraysAreEqual.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\Constraint; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +final class ArraysAreEqual extends ArrayComparison +{ + protected function compareLeaf(mixed $expected, mixed $actual): bool + { + /** @phpstan-ignore equal.notAllowed */ + return $expected == $actual; + } + + /** + * @return 'equal' + */ + protected function comparisonType(): string + { + return 'equal'; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArraysAreIdentical.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArraysAreIdentical.php new file mode 100644 index 000000000..49c58ab3f --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/ArraysAreIdentical.php @@ -0,0 +1,29 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\Constraint; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +final class ArraysAreIdentical extends ArrayComparison +{ + protected function compareLeaf(mixed $expected, mixed $actual): bool + { + return $expected === $actual; + } + + /** + * @return 'identical' + */ + protected function comparisonType(): string + { + return 'identical'; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Traversable/IsList.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/IsList.php similarity index 100% rename from app/vendor/phpunit/phpunit/src/Framework/Constraint/Traversable/IsList.php rename to app/vendor/phpunit/phpunit/src/Framework/Constraint/Array/IsList.php diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Callback.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Callback.php index 8646f5a16..2b09ff1e0 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Callback.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Callback.php @@ -42,7 +42,7 @@ public function toString(): string public function isVariadic(): bool { - return (new ReflectionFunction(Closure::fromCallable($this->callback)))->isVariadic(); + return new ReflectionFunction(Closure::fromCallable($this->callback))->isVariadic(); } /** diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php index 2ec012a0e..1c0af56e3 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Cardinality/Count.php @@ -19,6 +19,7 @@ use IteratorAggregate; use PHPUnit\Framework\Exception; use PHPUnit\Framework\GeneratorNotSupportedException; +use SebastianBergmann\RecursionContext\Context; use Traversable; /** @@ -66,7 +67,15 @@ protected function getCountOf(mixed $other): ?int } if ($other instanceof Traversable) { + $context = new Context; + while ($other instanceof IteratorAggregate) { + if ($context->contains($other) !== false) { + throw new Exception('IteratorAggregate::getIterator() returned an object that was already seen'); + } + + $context->add($other); + try { $other = $other->getIterator(); } catch (\Exception $e) { diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Constraint.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Constraint.php index 3a3483e3f..ec19fdaf2 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Constraint.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Constraint.php @@ -19,6 +19,7 @@ use function strtolower; use function substr; use Countable; +use PHPUnit\Framework\Assert; use PHPUnit\Framework\ExpectationFailedException; use PHPUnit\Framework\SelfDescribing; use PHPUnit\Util\Exporter; @@ -30,6 +31,20 @@ */ abstract class Constraint implements Countable, SelfDescribing { + /** + * @template A + * + * @param A $actual + * + * @return A + */ + final public function __invoke(mixed $actual): mixed + { + Assert::assertThat($actual, $this); + + return $actual; + } + /** * Evaluates the constraint for parameter $other. * @@ -272,10 +287,10 @@ protected function valueToTypeStringFragment(mixed $value): string } return match ($type) { - 'array', 'integer' => 'an ' . $type . ' ', + 'array', 'integer' => 'an ' . $type . ' ', 'boolean', 'closed resource', 'float', 'resource', 'string' => 'a ' . $type . ' ', - 'null' => 'null ', - default => 'a value of ' . $type . ' ', + 'null' => 'null ', + default => 'a value of ' . $type . ' ', }; } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/IsAnything.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/IsAnything.php index 85df5f92f..d65844fc5 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/IsAnything.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/IsAnything.php @@ -23,6 +23,8 @@ final class IsAnything extends Constraint * If $returnResult is true, the result of the evaluation is returned as * a boolean value instead: true in case of success, false in case of a * failure. + * + * @throws void */ public function evaluate(mixed $other, string $description = '', bool $returnResult = false): ?bool { diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectEquals.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectEquals.php index 2c78ea427..dafea6218 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectEquals.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectEquals.php @@ -11,6 +11,7 @@ use function assert; use function count; +use function is_bool; use function is_object; use PHPUnit\Framework\ActualValueIsNotAnObjectException; use PHPUnit\Framework\ComparisonMethodDoesNotAcceptParameterTypeException; @@ -136,7 +137,11 @@ protected function matches(mixed $other): bool } /** @phpstan-ignore method.dynamicName */ - return $other->{$this->method}($this->expected); + $result = $other->{$this->method}($this->expected); + + assert(is_bool($result)); + + return $result; } protected function failureDescription(mixed $other): string diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectHasProperty.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectHasProperty.php index 74c40c75b..39e4680d9 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectHasProperty.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Object/ObjectHasProperty.php @@ -49,7 +49,7 @@ protected function matches(mixed $other): bool return false; } - return (new ReflectionObject($other))->hasProperty($this->propertyName); + return new ReflectionObject($other)->hasProperty($this->propertyName); } /** diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/BinaryOperator.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/BinaryOperator.php index feb6d0408..083bb17b1 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/BinaryOperator.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/BinaryOperator.php @@ -25,7 +25,7 @@ abstract class BinaryOperator extends Operator protected function __construct(mixed ...$constraints) { $this->constraints = array_map( - fn (mixed $constraint): Constraint => $this->checkConstraint($constraint), + $this->checkConstraint(...), $constraints, ); } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalNot.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalNot.php index 224260909..4675d5909 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalNot.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalNot.php @@ -10,6 +10,7 @@ namespace PHPUnit\Framework\Constraint; use function array_map; +use function assert; use function count; use function preg_match; use function preg_quote; @@ -21,6 +22,11 @@ */ final class LogicalNot extends UnaryOperator { + /** + * @param non-empty-string $string + * + * @return non-empty-string + */ public static function negate(string $string): string { $positives = [ @@ -80,6 +86,9 @@ public static function negate(string $string): string ); } + assert($negatedString !== null); + assert($negatedString !== ''); + return $negatedString; } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalOr.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalOr.php index cbd87b9c2..370aa2cab 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalOr.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalOr.php @@ -9,6 +9,8 @@ */ namespace PHPUnit\Framework\Constraint; +use function array_any; + /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ @@ -43,12 +45,9 @@ public function precedence(): int */ public function matches(mixed $other): bool { - foreach ($this->constraints() as $constraint) { - if ($constraint->evaluate($other, '', true)) { - return true; - } - } - - return false; + return array_any( + $this->constraints(), + static fn (Constraint $constraint) => $constraint->evaluate($other, '', true), + ); } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalXor.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalXor.php index 3b40a1261..6a2aa126d 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalXor.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/Operator/LogicalXor.php @@ -11,6 +11,8 @@ use function array_reduce; use function array_shift; +use function assert; +use function is_bool; use PHPUnit\Framework\ExpectationFailedException; /** @@ -57,10 +59,14 @@ public function matches(mixed $other): bool return false; } - return array_reduce( + $result = array_reduce( $constraints, static fn (?bool $matches, Constraint $constraint): bool => $matches xor $constraint->evaluate($other, '', true), $initial->evaluate($other, '', true), ); + + assert(is_bool($result)); + + return $result; } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/RegularExpression.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/RegularExpression.php index 03b0e4ea1..c6e749a64 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/RegularExpression.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/RegularExpression.php @@ -9,8 +9,10 @@ */ namespace PHPUnit\Framework\Constraint; +use function preg_last_error_msg; use function preg_match; use function sprintf; +use PHPUnit\Framework\Exception as FrameworkException; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -38,9 +40,22 @@ public function toString(): string /** * Evaluates the constraint for parameter $other. Returns true if the * constraint is met, false otherwise. + * + * @throws FrameworkException */ protected function matches(mixed $other): bool { - return preg_match($this->pattern, $other) > 0; + $matches = @preg_match($this->pattern, $other); + + if ($matches === false) { + throw new FrameworkException( + sprintf( + 'Regular expression cannot be matched: %s', + preg_last_error_msg(), + ), + ); + } + + return $matches > 0; } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/StringMatchesFormatDescription.php b/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/StringMatchesFormatDescription.php index 4df81715f..3d6ef5df3 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/StringMatchesFormatDescription.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Constraint/String/StringMatchesFormatDescription.php @@ -11,12 +11,21 @@ use const DIRECTORY_SEPARATOR; use const PHP_EOL; +use function assert; +use function count; use function explode; use function implode; +use function preg_last_error_msg; use function preg_match; use function preg_quote; use function preg_replace; +use function sprintf; +use function str_replace; +use function strlen; +use function strpos; use function strtr; +use function substr; +use PHPUnit\Framework\Exception as FrameworkException; use SebastianBergmann\Diff\Differ; use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder; @@ -40,18 +49,29 @@ public function toString(): string /** * Evaluates the constraint for parameter $other. Returns true if the * constraint is met, false otherwise. + * + * @throws FrameworkException */ protected function matches(mixed $other): bool { $other = $this->convertNewlines($other); - $matches = preg_match( + $matches = @preg_match( $this->regularExpressionForFormatDescription( $this->convertNewlines($this->formatDescription), ), $other, ); + if ($matches === false) { + throw new FrameworkException( + sprintf( + 'Format description cannot be matched: %s', + preg_last_error_msg(), + ), + ); + } + return $matches > 0; } @@ -69,40 +89,113 @@ protected function failureDescription(mixed $other): string * This method removes the expected differences by figuring out if a difference * is allowed by the use of a placeholder. * - * The problem here are %A and %a multiline placeholders since we look at the - * expected and actual output line by line. If differences allowed by those placeholders - * stretch over multiple lines they will still end up in the final diff. - * And since they mess up the line sync between the expected and actual output - * all following allowed changes will not be detected/removed anymore. + * For %A and %a multiline placeholders that can match across multiple lines, + * we use anchor lookahead: find the next non-multiline expected line and search + * for it in the actual output to determine how many actual lines the placeholder + * consumed, keeping expected and actual in sync. */ protected function additionalFailureDescription(mixed $other): string { - $from = explode("\n", $this->formatDescription); - $to = explode("\n", $this->convertNewlines($other)); - - foreach ($from as $index => $line) { - // is the expected output line different from the actual output line - if (isset($to[$index]) && $line !== $to[$index]) { - $line = $this->regularExpressionForFormatDescription($line); - - // if the difference is allowed by a placeholder - // overwrite the expected line with the actual line to prevent it from showing up in the diff - if (preg_match($line, $to[$index]) > 0) { - $from[$index] = $to[$index]; + $expected = explode("\n", $this->formatDescription); + $expectedCount = count($expected); + $actual = explode("\n", $this->convertNewlines($other)); + $actualCount = count($actual); + $synced = []; + $expectedIndex = 0; + $actualIndex = 0; + + while ($expectedIndex < $expectedCount && $actualIndex < $actualCount) { + if ($expected[$expectedIndex] === $actual[$actualIndex]) { + $synced[] = $actual[$actualIndex]; + + $expectedIndex++; + $actualIndex++; + + continue; + } + + if ($this->isMultilineMatch($expected[$expectedIndex])) { + $anchorExpectedIndex = $this->findNextAnchor($expected, $expectedIndex + 1); + + if ($anchorExpectedIndex !== null) { + $anchorActualIndex = $this->findAnchorInActual($expected[$anchorExpectedIndex], $actual, $actualIndex); + + if ($anchorActualIndex !== null) { + for ($i = $actualIndex; $i < $anchorActualIndex; $i++) { + $synced[] = $actual[$i]; + } + + $synced[] = $actual[$anchorActualIndex]; + + $expectedIndex = $anchorExpectedIndex + 1; + $actualIndex = $anchorActualIndex + 1; + + continue; + } + } else { + // No anchor after multiline placeholder(s): consume all remaining actual lines + for ($i = $actualIndex; $i < $actualCount; $i++) { + $synced[] = $actual[$i]; + } + + $expectedIndex = $expectedCount; + $actualIndex = $actualCount; + + continue; } } + + // Single-line comparison + $regex = $this->regularExpressionForFormatDescription($expected[$expectedIndex]); + + if (@preg_match($regex, $actual[$actualIndex]) > 0) { + $synced[] = $actual[$actualIndex]; + } else { + $synced[] = $expected[$expectedIndex]; + } + + $expectedIndex++; + $actualIndex++; } - $from = implode("\n", $from); - $to = implode("\n", $to); + while ($expectedIndex < $expectedCount) { + $synced[] = $expected[$expectedIndex]; + $expectedIndex++; + } - return $this->differ()->diff($from, $to); + return $this->differ()->diff(implode("\n", $synced), implode("\n", $actual)); } private function regularExpressionForFormatDescription(string $string): string { + $quoted = ''; + $startOffset = 0; + $length = strlen($string); + + while ($startOffset < $length) { + $start = strpos($string, '%r', $startOffset); + + if ($start !== false) { + $end = strpos($string, '%r', $start + 2); + + if ($end === false) { + $end = $start = $length; + } + } else { + $start = $end = $length; + } + + $quoted .= preg_quote(substr($string, $startOffset, $start - $startOffset), '/'); + + if ($end > $start) { + $quoted .= '(' . substr($string, $start + 2, $end - $start - 2) . ')'; + } + + $startOffset = $end + 2; + } + $string = strtr( - preg_quote($string, '/'), + $quoted, [ '%%' => '%', '%e' => preg_quote(DIRECTORY_SEPARATOR, '/'), @@ -123,13 +216,52 @@ private function regularExpressionForFormatDescription(string $string): string return '/^' . $string . '$/s'; } + private function isMultilineMatch(string $line): bool + { + return preg_match('/%[aA]/', str_replace('%%', '', $line)) > 0; + } + + /** + * @param list $expected + */ + private function findNextAnchor(array $expected, int $startIdx): ?int + { + for ($i = $startIdx, $len = count($expected); $i < $len; $i++) { + if (!$this->isMultilineMatch($expected[$i])) { + return $i; + } + } + + return null; + } + + /** + * @param list $actual + */ + private function findAnchorInActual(string $anchorLine, array $actual, int $startIdx): ?int + { + $anchorRegex = $this->regularExpressionForFormatDescription($anchorLine); + + for ($i = $startIdx, $len = count($actual); $i < $len; $i++) { + if ($anchorLine === $actual[$i] || @preg_match($anchorRegex, $actual[$i]) > 0) { + return $i; + } + } + + return null; + } + private function convertNewlines(string $text): string { - return preg_replace('/\r\n/', "\n", $text); + $result = preg_replace('/\r\n/', "\n", $text); + + assert($result !== null); + + return $result; } private function differ(): Differ { - return new Differ(new UnifiedDiffOutputBuilder("--- Expected\n+++ Actual\n")); + return new Differ(new UnifiedDiffOutputBuilder("--- Expected\n+++ Actual\n", false, 3, false)); } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/Exception/Exception.php b/app/vendor/phpunit/phpunit/src/Framework/Exception/Exception.php index e35b0d505..aa8e85d11 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Exception/Exception.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Exception/Exception.php @@ -43,7 +43,7 @@ class Exception extends RuntimeException implements \PHPUnit\Exception { /** - * @var list + * @var list */ protected array $serializableTrace; @@ -70,15 +70,15 @@ public function __construct(string $message = '', int|string $code = 0, ?Throwab } } - public function __sleep(): array + public function __serialize(): array { - return array_keys(get_object_vars($this)); + return get_object_vars($this); } /** * Returns the serializable trace (without 'args'). * - * @return list + * @return list */ public function getSerializableTrace(): array { diff --git a/app/vendor/phpunit/phpunit/src/Framework/Exception/Incomplete/IncompleteTest.php b/app/vendor/phpunit/phpunit/src/Framework/Exception/Incomplete/IncompleteTest.php index 4492ef226..39637fc09 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Exception/Incomplete/IncompleteTest.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Exception/Incomplete/IncompleteTest.php @@ -14,7 +14,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface IncompleteTest extends Throwable { diff --git a/app/vendor/phpunit/phpunit/src/Framework/Exception/Skipped/SkippedTest.php b/app/vendor/phpunit/phpunit/src/Framework/Exception/Skipped/SkippedTest.php index ab2f67496..3678b6011 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Exception/Skipped/SkippedTest.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Exception/Skipped/SkippedTest.php @@ -14,7 +14,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface SkippedTest extends Throwable { diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/Exception.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/Exception.php index f7994f20f..0d73a5fe8 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/Exception.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/Exception.php @@ -9,13 +9,11 @@ */ namespace PHPUnit\Framework\MockObject; -use Throwable; - /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ -interface Exception extends Throwable +interface Exception extends \PHPUnit\Exception { } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/NoMoreParameterSetsConfiguredException.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/NoMoreParameterSetsConfiguredException.php new file mode 100644 index 000000000..c66395777 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/NoMoreParameterSetsConfiguredException.php @@ -0,0 +1,32 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject; + +use function sprintf; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class NoMoreParameterSetsConfiguredException extends \PHPUnit\Framework\Exception implements Exception +{ + public function __construct(Invocation $invocation, int $numberOfConfiguredParameterSets) + { + parent::__construct( + sprintf( + 'Not enough parameter sets configured, only %d parameter sets given for %s::%s()', + $numberOfConfiguredParameterSets, + $invocation->className(), + $invocation->methodName(), + ), + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/TestDoubleSealedException.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/TestDoubleSealedException.php new file mode 100644 index 000000000..a721d4c97 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Exception/TestDoubleSealedException.php @@ -0,0 +1,25 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class TestDoubleSealedException extends \PHPUnit\Framework\Exception implements Exception +{ + public function __construct() + { + parent::__construct( + 'This test double has been sealed and cannot be configured further', + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/DoubledMethod.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/DoubledMethod.php index 09006b257..bfef14b9c 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/DoubledMethod.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/DoubledMethod.php @@ -274,9 +274,11 @@ private static function methodParametersForDeclaration(ReflectionMethod $method) /* Note: PHP extensions may use empty names for reference arguments * or "..." for methods taking a variable number of arguments. */ + // @codeCoverageIgnoreStart if ($name === '$' || $name === '$...') { $name = '$arg' . $i; } + // @codeCoverageIgnoreEnd $default = ''; $reference = ''; @@ -321,9 +323,11 @@ private static function methodParametersForCall(ReflectionMethod $method): strin /* Note: PHP extensions may use empty names for reference arguments * or "..." for methods taking a variable number of arguments. */ + // @codeCoverageIgnoreStart if ($name === '$' || $name === '$...') { $name = '$arg' . $i; } + // @codeCoverageIgnoreEnd if ($parameter->isVariadic()) { continue; diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Exception/ClassIsAnonymousException.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Exception/ClassIsAnonymousException.php new file mode 100644 index 000000000..ace971427 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Exception/ClassIsAnonymousException.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject\Generator; + +use function sprintf; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class ClassIsAnonymousException extends \PHPUnit\Framework\Exception implements Exception +{ + public function __construct(string $className) + { + parent::__construct( + sprintf( + 'Class "%s" is an anonymous class and cannot be doubled', + $className, + ), + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Exception/InvalidClassNameException.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Exception/InvalidClassNameException.php new file mode 100644 index 000000000..80b79bfe2 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Exception/InvalidClassNameException.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject\Generator; + +use function sprintf; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class InvalidClassNameException extends \PHPUnit\Framework\Exception implements Exception +{ + public function __construct(string $className) + { + parent::__construct( + sprintf( + 'Cannot use "%s" as the name of a test double class because it is not a valid PHP class name', + $className, + ), + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Generator.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Generator.php index f52ba60ca..394fdf5c4 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Generator.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/Generator.php @@ -64,20 +64,9 @@ final class Generator use TemplateLoader; /** - * @var non-empty-array + * @var null|non-empty-array */ - private const array EXCLUDED_METHOD_NAMES = [ - '__CLASS__' => true, - '__DIR__' => true, - '__FILE__' => true, - '__FUNCTION__' => true, - '__LINE__' => true, - '__METHOD__' => true, - '__NAMESPACE__' => true, - '__TRAIT__' => true, - '__clone' => true, - '__halt_compiler' => true, - ]; + private static ?array $excludedMethodNames = null; /** * @var array @@ -91,9 +80,11 @@ final class Generator * @param ?list $methods * @param array $arguments * + * @throws ClassIsAnonymousException * @throws ClassIsEnumerationException * @throws ClassIsFinalException * @throws DuplicateMethodException + * @throws InvalidClassNameException * @throws InvalidMethodNameException * @throws NameAlreadyInUseException * @throws ReflectionException @@ -108,6 +99,7 @@ public function testDouble(string $type, bool $mockObject, ?array $methods = [], $this->ensureKnownType($type); $this->ensureValidMethods($methods); + $this->ensureValidNameForTestDoubleClass($mockClassName); $this->ensureNameForTestDoubleClassIsAvailable($mockClassName); $mock = $this->generate( @@ -120,9 +112,11 @@ public function testDouble(string $type, bool $mockObject, ?array $methods = [], $object = $this->instantiate( $mock, + $type, $callOriginalConstructor, $arguments, $returnValueGeneration, + $mockObject, ); assert($object instanceof $type); @@ -207,6 +201,7 @@ public function testDoubleForInterfaceIntersection(array $interfaces, bool $mock * @param class-string $type * @param ?list $methods * + * @throws ClassIsAnonymousException * @throws ClassIsEnumerationException * @throws ClassIsFinalException * @throws ReflectionException @@ -298,12 +293,12 @@ private function userDefinedInterfaceMethods(string $interfaceName): array * @throws ReflectionException * @throws RuntimeException */ - private function instantiate(DoubledClass $mockClass, bool $callOriginalConstructor = false, array $arguments = [], bool $returnValueGeneration = true): object + private function instantiate(DoubledClass $mockClass, string $type, bool $callOriginalConstructor, array $arguments, bool $returnValueGeneration, bool $isMockObject): object { $className = $mockClass->generate(); try { - $object = (new ReflectionClass($className))->newInstanceWithoutConstructor(); + $object = new ReflectionClass($className)->newInstanceWithoutConstructor(); // @codeCoverageIgnoreStart } catch (\ReflectionException $e) { throw new ReflectionException( @@ -321,7 +316,7 @@ private function instantiate(DoubledClass $mockClass, bool $callOriginalConstruc */ $reflector->getProperty('__phpunit_state')->setValue( $object, - new TestDoubleState($mockClass->configurableMethods(), $returnValueGeneration), + new TestDoubleState($mockClass->configurableMethods(), $type, $returnValueGeneration, $isMockObject), ); if ($callOriginalConstructor && $reflector->getConstructor() !== null) { @@ -345,6 +340,7 @@ private function instantiate(DoubledClass $mockClass, bool $callOriginalConstruc * @param class-string $type * @param ?list $explicitMethods * + * @throws ClassIsAnonymousException * @throws ClassIsEnumerationException * @throws ClassIsFinalException * @throws MethodNamedMethodException @@ -377,6 +373,10 @@ private function generateCodeForTestDoubleClass(string $type, bool $mockObject, $class = $this->reflectClass($_mockClassName['fullClassName']); + if ($class->isAnonymous()) { + throw new ClassIsAnonymousException($_mockClassName['fullClassName']); + } + if ($class->isEnum()) { throw new ClassIsEnumerationException($_mockClassName['fullClassName']); } @@ -651,7 +651,27 @@ private function canMethodBeDoubled(ReflectionMethod $method): bool private function isMethodNameExcluded(string $name): bool { - return isset(self::EXCLUDED_METHOD_NAMES[$name]); + if (self::$excludedMethodNames === null) { + self::$excludedMethodNames = [ + '__CLASS__' => true, + '__DIR__' => true, + '__FILE__' => true, + '__FUNCTION__' => true, + '__LINE__' => true, + '__METHOD__' => true, + '__NAMESPACE__' => true, + '__TRAIT__' => true, + '__clone' => true, + '__halt_compiler' => true, + ]; + + if (version_compare(PHP_VERSION, '8.5', '>=')) { + self::$excludedMethodNames['__sleep'] = true; + self::$excludedMethodNames['__wakeup'] = true; + } + } + + return isset(self::$excludedMethodNames[$name]); } /** @@ -677,7 +697,7 @@ private function ensureValidMethods(?array $methods): void } foreach ($methods as $method) { - if (!preg_match('~[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*~', (string) $method)) { + if (!preg_match('~\A[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\z~', (string) $method)) { throw new InvalidMethodNameException((string) $method); } } @@ -687,6 +707,20 @@ private function ensureValidMethods(?array $methods): void } } + /** + * @throws InvalidClassNameException + */ + private function ensureValidNameForTestDoubleClass(string $className): void + { + if ($className === '') { + return; + } + + if (!preg_match('~\A[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*\z~', $className)) { + throw new InvalidClassNameException($className); + } + } + /** * @throws NameAlreadyInUseException * @throws ReflectionException @@ -705,11 +739,15 @@ trait_exists($className, false)) { } /** - * @param class-string $className + * @template T of object + * + * @param class-string $className * * @throws ReflectionException * - * @phpstan-ignore missingType.generics, throws.unusedType + * @return ReflectionClass + * + * @phpstan-ignore throws.unusedType */ private function reflectClass(string $className): ReflectionClass { @@ -789,7 +827,7 @@ private function configurableMethods(DoubledMethodSet $methods, array $propertie } foreach ($propertiesWithHooks as $property) { - if ($property->hasGetHook()) { + if ($property->shouldGenerateGetHook()) { $configurable[] = new ConfigurableMethod( sprintf( '$%s::get', @@ -801,7 +839,7 @@ private function configurableMethods(DoubledMethodSet $methods, array $propertie ); } - if ($property->hasSetHook()) { + if ($property->shouldGenerateSetHook()) { $configurable[] = new ConfigurableMethod( sprintf( '$%s::set', @@ -818,22 +856,12 @@ private function configurableMethods(DoubledMethodSet $methods, array $propertie } /** - * @param ?ReflectionClass $class + * @param ReflectionClass $class * * @return list */ - private function properties(?ReflectionClass $class): array + private function properties(ReflectionClass $class): array { - if (version_compare('8.4.1', PHP_VERSION, '>')) { - // @codeCoverageIgnoreStart - return []; - // @codeCoverageIgnoreEnd - } - - if ($class === null) { - return []; - } - $mapper = new ReflectionMapper; $properties = []; @@ -850,8 +878,9 @@ private function properties(?ReflectionClass $class): array continue; } - $hasGetHook = false; - $hasSetHook = false; + $hasGetHook = false; + $hasSetHook = false; + $setHookMethodParameterType = null; if ($property->hasHook(PropertyHookType::Get) && !$property->getHook(PropertyHookType::Get)->isFinal()) { @@ -860,7 +889,8 @@ private function properties(?ReflectionClass $class): array if ($property->hasHook(PropertyHookType::Set) && !$property->getHook(PropertyHookType::Set)->isFinal()) { - $hasSetHook = true; + $hasSetHook = true; + $setHookMethodParameterType = $mapper->fromParameterTypes($property->getHook(PropertyHookType::Set))[0]->type(); } if (!$hasGetHook && !$hasSetHook) { @@ -872,6 +902,8 @@ private function properties(?ReflectionClass $class): array $mapper->fromPropertyType($property), $hasGetHook, $hasSetHook, + $property->isVirtual(), + $setHookMethodParameterType, ); } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedProperty.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedProperty.php index e43d589d7..3a4a3467b 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedProperty.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedProperty.php @@ -25,16 +25,20 @@ private Type $type; private bool $getHook; private bool $setHook; + private bool $virtual; + private ?Type $setterType; /** * @param non-empty-string $name */ - public function __construct(string $name, Type $type, bool $getHook, bool $setHook) + public function __construct(string $name, Type $type, bool $getHook, bool $setHook, bool $virtual, ?Type $setterType) { - $this->name = $name; - $this->type = $type; - $this->getHook = $getHook; - $this->setHook = $setHook; + $this->name = $name; + $this->type = $type; + $this->getHook = $getHook; + $this->setHook = $setHook; + $this->virtual = $virtual; + $this->setterType = $setterType; } public function name(): string @@ -56,4 +60,31 @@ public function hasSetHook(): bool { return $this->setHook; } + + public function shouldGenerateGetHook(): bool + { + return $this->getHook || !$this->virtual && $this->setHook; + } + + public function shouldGenerateSetHook(): bool + { + return $this->setHook || !$this->virtual && $this->getHook; + } + + public function hasSetterType(): bool + { + return $this->setterType !== null; + } + + /** + * @throws RuntimeException + */ + public function setterType(): Type + { + if ($this->setterType === null) { + throw new RuntimeException; + } + + return $this->setterType; + } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedPropertyGenerator.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedPropertyGenerator.php index 4fcff6c82..d96123c94 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedPropertyGenerator.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Generator/HookedPropertyGenerator.php @@ -36,7 +36,7 @@ public function generate(string $className, array $properties): string $property->name(), ); - if ($property->hasGetHook()) { + if ($property->shouldGenerateGetHook()) { $code .= sprintf( <<<'EOT' @@ -55,7 +55,7 @@ public function generate(string $className, array $properties): string ); } - if ($property->hasSetHook()) { + if ($property->shouldGenerateSetHook()) { $code .= sprintf( <<<'EOT' @@ -68,7 +68,7 @@ public function generate(string $className, array $properties): string } EOT, - $property->type()->asString(), + ($property->hasSetterType() ? $property->setterType() : $property->type())->asString(), $className, $property->name(), ); diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/MockBuilder.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/MockBuilder.php index 02620db59..5f9e59ce3 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/MockBuilder.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/MockBuilder.php @@ -9,72 +9,53 @@ */ namespace PHPUnit\Framework\MockObject; -use function array_merge; use function assert; use PHPUnit\Framework\InvalidArgumentException; +use PHPUnit\Framework\MockObject\Generator\ClassIsAnonymousException; use PHPUnit\Framework\MockObject\Generator\ClassIsEnumerationException; use PHPUnit\Framework\MockObject\Generator\ClassIsFinalException; use PHPUnit\Framework\MockObject\Generator\DuplicateMethodException; -use PHPUnit\Framework\MockObject\Generator\Generator; +use PHPUnit\Framework\MockObject\Generator\InvalidClassNameException; use PHPUnit\Framework\MockObject\Generator\InvalidMethodNameException; use PHPUnit\Framework\MockObject\Generator\NameAlreadyInUseException; use PHPUnit\Framework\MockObject\Generator\ReflectionException; use PHPUnit\Framework\MockObject\Generator\RuntimeException; use PHPUnit\Framework\MockObject\Generator\UnknownTypeException; use PHPUnit\Framework\TestCase; -use ReflectionClass; /** * @template MockedType * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ -final class MockBuilder +final class MockBuilder extends TestDoubleBuilder { private readonly TestCase $testCase; - /** - * @var class-string|trait-string - */ - private readonly string $type; - - /** - * @var list - */ - private array $methods = []; - private bool $emptyMethodsArray = false; - /** * @var ?class-string */ private ?string $mockClassName = null; - /** - * @var array - */ - private array $constructorArgs = []; - private bool $originalConstructor = true; - private bool $originalClone = true; - private bool $returnValueGeneration = true; - private readonly Generator $generator; - /** * @param class-string|trait-string $type */ public function __construct(TestCase $testCase, string $type) { - $this->testCase = $testCase; - $this->type = $type; - $this->generator = new Generator; + parent::__construct($type); + + $this->testCase = $testCase; } /** * Creates a mock object using a fluent interface. * + * @throws ClassIsAnonymousException * @throws ClassIsEnumerationException * @throws ClassIsFinalException * @throws DuplicateMethodException * @throws InvalidArgumentException + * @throws InvalidClassNameException * @throws InvalidMethodNameException * @throws NameAlreadyInUseException * @throws ReflectionException @@ -85,82 +66,16 @@ public function __construct(TestCase $testCase, string $type) */ public function getMock(): MockObject { - $object = $this->generator->testDouble( - $this->type, - true, - !$this->emptyMethodsArray ? $this->methods : null, - $this->constructorArgs, - $this->mockClassName ?? '', - $this->originalConstructor, - $this->originalClone, - $this->returnValueGeneration, - ); + $object = $this->getTestDouble($this->mockClassName, true); assert($object instanceof $this->type); assert($object instanceof MockObject); - $this->testCase->registerMockObject($object); + $this->testCase->registerMockObject($this->type, $object); return $object; } - /** - * Specifies the subset of methods to mock, requiring each to exist in the class. - * - * @param list $methods - * - * @throws CannotUseOnlyMethodsException - * @throws ReflectionException - * - * @return $this - */ - public function onlyMethods(array $methods): self - { - if ($methods === []) { - $this->emptyMethodsArray = true; - - return $this; - } - - try { - $reflector = new ReflectionClass($this->type); - - // @codeCoverageIgnoreStart - /** @phpstan-ignore catch.neverThrown */ - } catch (\ReflectionException $e) { - throw new ReflectionException( - $e->getMessage(), - $e->getCode(), - $e, - ); - // @codeCoverageIgnoreEnd - } - - foreach ($methods as $method) { - if (!$reflector->hasMethod($method)) { - throw new CannotUseOnlyMethodsException($this->type, $method); - } - } - - $this->methods = array_merge($this->methods, $methods); - - return $this; - } - - /** - * Specifies the arguments for the constructor. - * - * @param array $arguments - * - * @return $this - */ - public function setConstructorArgs(array $arguments): self - { - $this->constructorArgs = $arguments; - - return $this; - } - /** * Specifies the name for the mock class. * @@ -174,72 +89,4 @@ public function setMockClassName(string $name): self return $this; } - - /** - * Disables the invocation of the original constructor. - * - * @return $this - */ - public function disableOriginalConstructor(): self - { - $this->originalConstructor = false; - - return $this; - } - - /** - * Enables the invocation of the original constructor. - * - * @return $this - */ - public function enableOriginalConstructor(): self - { - $this->originalConstructor = true; - - return $this; - } - - /** - * Disables the invocation of the original clone constructor. - * - * @return $this - */ - public function disableOriginalClone(): self - { - $this->originalClone = false; - - return $this; - } - - /** - * Enables the invocation of the original clone constructor. - * - * @return $this - */ - public function enableOriginalClone(): self - { - $this->originalClone = true; - - return $this; - } - - /** - * @return $this - */ - public function enableAutoReturnValueGeneration(): self - { - $this->returnValueGeneration = true; - - return $this; - } - - /** - * @return $this - */ - public function disableAutoReturnValueGeneration(): self - { - $this->returnValueGeneration = false; - - return $this; - } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/AbstractInvocationImplementation.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/AbstractInvocationImplementation.php new file mode 100644 index 000000000..8836ad839 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/AbstractInvocationImplementation.php @@ -0,0 +1,289 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject; + +use function array_flip; +use function array_key_exists; +use function array_map; +use function array_merge; +use function array_pop; +use function assert; +use function count; +use function is_string; +use function range; +use function strtolower; +use PHPUnit\Framework\Constraint\Constraint; +use PHPUnit\Framework\InvalidArgumentException; +use PHPUnit\Framework\MockObject\Runtime\PropertyHook; +use PHPUnit\Framework\MockObject\Stub\ConsecutiveCalls; +use PHPUnit\Framework\MockObject\Stub\Exception; +use PHPUnit\Framework\MockObject\Stub\ReturnArgument; +use PHPUnit\Framework\MockObject\Stub\ReturnCallback; +use PHPUnit\Framework\MockObject\Stub\ReturnReference; +use PHPUnit\Framework\MockObject\Stub\ReturnSelf; +use PHPUnit\Framework\MockObject\Stub\ReturnStub; +use PHPUnit\Framework\MockObject\Stub\ReturnValueMap; +use PHPUnit\Framework\MockObject\Stub\Stub; +use Throwable; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +abstract class AbstractInvocationImplementation implements InvocationStubber +{ + protected readonly InvocationHandler $invocationHandler; + protected readonly Matcher $matcher; + + /** + * @var list + */ + protected readonly array $configurableMethods; + + /** + * @var ?array + */ + protected ?array $configurableMethodNames = null; + protected bool $createdWithoutExplicitExpects = false; + + final public function __construct(InvocationHandler $handler, Matcher $matcher, ConfigurableMethod ...$configurableMethods) + { + $this->invocationHandler = $handler; + $this->matcher = $matcher; + $this->configurableMethods = $configurableMethods; + } + + /** + * @param Constraint|non-empty-string|PropertyHook $constraint + * + * @throws InvalidArgumentException + * @throws MethodCannotBeConfiguredException + * @throws MethodNameAlreadyConfiguredException + * + * @return $this + */ + final public function method(Constraint|PropertyHook|string $constraint): InvocationStubber + { + if ($this->matcher->hasMethodNameRule()) { + throw new MethodNameAlreadyConfiguredException; + } + + if ($constraint instanceof PropertyHook) { + $constraint = $constraint->asString(); + } + + if (is_string($constraint)) { + $this->configurableMethodNames ??= array_flip( + array_map( + static fn (ConfigurableMethod $configurable) => strtolower($configurable->name()), + $this->configurableMethods, + ), + ); + + if (!array_key_exists(strtolower($constraint), $this->configurableMethodNames)) { + throw new MethodCannotBeConfiguredException($constraint); + } + } + + $this->matcher->setMethodNameRule(new Rule\MethodName($constraint)); + + return $this; + } + + /** + * @return $this + */ + final public function will(Stub $stub): InvocationStubber + { + $this->matcher->setStub($stub); + + return $this; + } + + /** + * @throws IncompatibleReturnValueException + */ + final public function willReturn(mixed $value, mixed ...$nextValues): InvocationStubber + { + if (count($nextValues) === 0) { + $this->ensureTypeOfReturnValues([$value]); + + $stub = $value instanceof Stub ? $value : new ReturnStub($value); + + return $this->will($stub); + } + + $values = array_merge([$value], $nextValues); + + $this->ensureTypeOfReturnValues($values); + + $stub = new ConsecutiveCalls($values); + + return $this->will($stub); + } + + final public function willReturnReference(mixed &$reference): InvocationStubber + { + $stub = new ReturnReference($reference); + + return $this->will($stub); + } + + final public function willReturnMap(array $valueMap): InvocationStubber + { + $method = $this->configuredMethod(); + + assert($method instanceof ConfigurableMethod); + + $numberOfParameters = $method->numberOfParameters(); + $defaultValues = $method->defaultParameterValues(); + $hasDefaultValues = $defaultValues !== []; + + $_valueMap = []; + + foreach ($valueMap as $mapping) { + $numberOfConfiguredParameters = count($mapping) - 1; + + if ($numberOfConfiguredParameters === $numberOfParameters || !$hasDefaultValues) { + $_valueMap[] = $mapping; + + continue; + } + + $_mapping = []; + $returnValue = array_pop($mapping); + + foreach (range(0, $numberOfParameters - 1) as $i) { + if (array_key_exists($i, $mapping)) { + $_mapping[] = $mapping[$i]; + + continue; + } + + if (array_key_exists($i, $defaultValues)) { + $_mapping[] = $defaultValues[$i]; + } + } + + $_mapping[] = $returnValue; + $_valueMap[] = $_mapping; + } + + $stub = new ReturnValueMap($_valueMap); + + return $this->will($stub); + } + + final public function willReturnArgument(int $argumentIndex): InvocationStubber + { + $stub = new ReturnArgument($argumentIndex); + + return $this->will($stub); + } + + final public function willReturnCallback(callable $callback): InvocationStubber + { + $stub = new ReturnCallback($callback); + + return $this->will($stub); + } + + final public function willReturnSelf(): InvocationStubber + { + $stub = new ReturnSelf; + + return $this->will($stub); + } + + final public function willReturnOnConsecutiveCalls(mixed ...$values): InvocationStubber + { + $stub = new ConsecutiveCalls($values); + + return $this->will($stub); + } + + final public function willThrowException(Throwable $exception): InvocationStubber + { + $stub = new Exception($exception); + + return $this->will($stub); + } + + /** + * @internal This method is not covered by the backward compatibility promise for PHPUnit + */ + final public function markAsCreatedWithoutExplicitExpects(): static + { + $this->createdWithoutExplicitExpects = true; + + return $this; + } + + final public function seal(): void + { + $this->invocationHandler->seal($this->invocationHandler->isMockObject()); + } + + /** + * @throws MethodNameNotConfiguredException + * @throws MethodParametersAlreadyConfiguredException + */ + final protected function ensureParametersCanBeConfigured(): void + { + if (!$this->matcher->hasMethodNameRule()) { + throw new MethodNameNotConfiguredException; + } + + if ($this->matcher->hasParametersRule()) { + throw new MethodParametersAlreadyConfiguredException; + } + } + + private function configuredMethod(): ?ConfigurableMethod + { + $configuredMethod = null; + + foreach ($this->configurableMethods as $configurableMethod) { + if ($this->matcher->methodNameRule()->matchesName($configurableMethod->name())) { + if ($configuredMethod !== null) { + return null; + } + + $configuredMethod = $configurableMethod; + } + } + + return $configuredMethod; + } + + /** + * @param array $values + * + * @throws IncompatibleReturnValueException + */ + private function ensureTypeOfReturnValues(array $values): void + { + $configuredMethod = $this->configuredMethod(); + + if ($configuredMethod === null) { + return; + } + + foreach ($values as $value) { + if (!$configuredMethod->mayReturn($value)) { + throw new IncompatibleReturnValueException( + $configuredMethod, + $value, + ); + } + } + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/Method.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/Method.php index c9b4e42e5..cae33df2f 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/Method.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/Method.php @@ -27,6 +27,7 @@ public function method(Constraint|PropertyHook|string $constraint): InvocationSt return $this ->__phpunit_getInvocationHandler() ->expects(new AnyInvokedCount) - ->method($constraint); + ->method($constraint) + ->markAsCreatedWithoutExplicitExpects(); } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/MockObjectApi.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/MockObjectApi.php index a73695676..4df9b7080 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/MockObjectApi.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/MockObjectApi.php @@ -18,13 +18,16 @@ */ trait MockObjectApi { - /** @noinspection MagicMethodsValidityInspection */ - public function __phpunit_hasMatchers(): bool + public function __phpunit_hasInvocationCountRule(): bool { - return $this->__phpunit_getInvocationHandler()->hasMatchers(); + return $this->__phpunit_getInvocationHandler()->hasInvocationCountRule(); + } + + public function __phpunit_hasParametersRule(): bool + { + return $this->__phpunit_getInvocationHandler()->hasParametersRule(); } - /** @noinspection MagicMethodsValidityInspection */ public function __phpunit_verify(bool $unsetInvocationMocker = true): void { $this->__phpunit_getInvocationHandler()->verify(); @@ -40,7 +43,7 @@ abstract public function __phpunit_getInvocationHandler(): InvocationHandler; abstract public function __phpunit_unsetInvocationMocker(): void; - public function expects(InvocationOrder $matcher): InvocationStubber + public function expects(InvocationOrder $matcher): InvocationMocker { return $this->__phpunit_getInvocationHandler()->expects($matcher); } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/StubApi.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/StubApi.php index faba8d40f..08f660095 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/StubApi.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/StubApi.php @@ -20,16 +20,14 @@ trait StubApi public function __phpunit_state(): TestDoubleState { - return $this->__phpunit_state; + return $this->__phpunit_state ?? new TestDoubleState([], static::class, true, false); } - /** @noinspection MagicMethodsValidityInspection */ public function __phpunit_getInvocationHandler(): InvocationHandler { return $this->__phpunit_state()->invocationHandler(); } - /** @noinspection MagicMethodsValidityInspection */ public function __phpunit_unsetInvocationMocker(): void { $this->__phpunit_state()->unsetInvocationHandler(); diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/TestDoubleState.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/TestDoubleState.php index 93b10c14d..075847469 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/TestDoubleState.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Api/TestDoubleState.php @@ -20,16 +20,25 @@ final class TestDoubleState * @var list */ private readonly array $configurableMethods; + + /** + * @var class-string + */ + private readonly string $className; private readonly bool $generateReturnValues; + private readonly bool $isMockObject; private ?InvocationHandler $invocationHandler = null; /** * @param list $configurableMethods + * @param class-string $className */ - public function __construct(array $configurableMethods, bool $generateReturnValues) + public function __construct(array $configurableMethods, string $className, bool $generateReturnValues, bool $isMockObject = false) { $this->configurableMethods = $configurableMethods; + $this->className = $className; $this->generateReturnValues = $generateReturnValues; + $this->isMockObject = $isMockObject; } public function invocationHandler(): InvocationHandler @@ -40,7 +49,9 @@ public function invocationHandler(): InvocationHandler $this->invocationHandler = new InvocationHandler( $this->configurableMethods, + $this->className, $this->generateReturnValues, + $this->isMockObject, ); return $this->invocationHandler; diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/InvocationMocker.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/InvocationMocker.php new file mode 100644 index 000000000..7ba2f9213 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/InvocationMocker.php @@ -0,0 +1,57 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject; + +interface InvocationMocker extends InvocationStubber +{ + /** + * @return $this + */ + public function with(mixed ...$arguments): self; + + /** + * @return $this + */ + public function withParameterSetsInOrder(mixed ...$arguments): self; + + /** + * @return $this + */ + public function withParameterSetsInAnyOrder(mixed ...$arguments): self; + + /** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @return $this + */ + public function withAnyParameters(): self; + + /** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @param non-empty-string $id + * + * @return $this + * + * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6537 + */ + public function id(string $id): self; + + /** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @param non-empty-string $id + * + * @return $this + * + * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6537 + */ + public function after(string $id): self; +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/InvocationStubber.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/InvocationStubber.php index 337c82fb3..02acb5b17 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/InvocationStubber.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/InvocationStubber.php @@ -25,36 +25,6 @@ interface InvocationStubber */ public function method(Constraint|PropertyHook|string $constraint): self; - /** - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @param non-empty-string $id - * - * @return $this - */ - public function id(string $id): self; - - /** - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @param non-empty-string $id - * - * @return $this - */ - public function after(string $id): self; - - /** - * @return $this - */ - public function with(mixed ...$arguments): self; - - /** - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @return $this - */ - public function withAnyParameters(): self; - /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * @@ -119,4 +89,6 @@ public function willReturnOnConsecutiveCalls(mixed ...$values): self; * @return $this */ public function willThrowException(Throwable $exception): self; + + public function seal(): void; } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObject.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObject.php index 0ddc46dc4..f0e4ef3ce 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObject.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObject.php @@ -16,5 +16,5 @@ */ interface MockObject extends Stub { - public function expects(InvocationOrder $invocationRule): InvocationStubber; + public function expects(InvocationOrder $invocationRule): InvocationMocker; } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObjectInternal.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObjectInternal.php index 167d2466d..50c0cd38e 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObjectInternal.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Interface/MockObjectInternal.php @@ -16,7 +16,9 @@ */ interface MockObjectInternal extends MockObject, StubInternal { - public function __phpunit_hasMatchers(): bool; + public function __phpunit_hasInvocationCountRule(): bool; + + public function __phpunit_hasParametersRule(): bool; public function __phpunit_verify(bool $unsetInvocationMocker = true): void; } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Invocation.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Invocation.php index d9e3c3f66..4e862e1df 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Invocation.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Invocation.php @@ -126,7 +126,7 @@ public function toString(): string implode( ', ', array_map( - [Exporter::class, 'shortenedExport'], + Exporter::shortenedExport(...), $this->parameters, ), ), diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationHandler.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationHandler.php index 50f8283ad..c7d022ff2 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationHandler.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationHandler.php @@ -9,9 +9,16 @@ */ namespace PHPUnit\Framework\MockObject; +use function array_any; +use function array_unique; +use function array_values; +use function in_array; use function strtolower; use Exception; +use PHPUnit\Framework\AssertionFailedError; use PHPUnit\Framework\MockObject\Rule\InvocationOrder; +use PHPUnit\Framework\MockObject\Rule\InvokedCount; +use PHPUnit\Framework\MockObject\Rule\MethodName; use Throwable; /** @@ -35,26 +42,47 @@ final class InvocationHandler * @var list */ private readonly array $configurableMethods; + + /** + * @var class-string + */ + private readonly string $className; private readonly bool $returnValueGeneration; + private readonly bool $isMockObject; + private bool $sealed = false; + private ?AssertionFailedError $assertionFailure = null; /** * @param list $configurableMethods + * @param class-string $className */ - public function __construct(array $configurableMethods, bool $returnValueGeneration) + public function __construct(array $configurableMethods, string $className, bool $returnValueGeneration, bool $isMockObject = false) { $this->configurableMethods = $configurableMethods; + $this->className = $className; $this->returnValueGeneration = $returnValueGeneration; + $this->isMockObject = $isMockObject; } - public function hasMatchers(): bool + public function isMockObject(): bool { - foreach ($this->matchers as $matcher) { - if ($matcher->hasMatchers()) { - return true; - } - } + return $this->isMockObject; + } - return false; + public function hasInvocationCountRule(): bool + { + return array_any( + $this->matchers, + static fn (Matcher $matcher) => $matcher->hasInvocationCountRule(), + ); + } + + public function hasParametersRule(): bool + { + return array_any( + $this->matchers, + static fn (Matcher $matcher) => $matcher->hasParametersRule(), + ); } /** @@ -84,11 +112,26 @@ public function registerMatcher(string $id, Matcher $matcher): void $this->matcherMap[$id] = $matcher; } - public function expects(InvocationOrder $rule): InvocationStubber + /** + * @throws TestDoubleSealedException + */ + public function expects(InvocationOrder $rule): InvocationMocker|InvocationStubber { - $matcher = new Matcher($rule); + if ($this->sealed) { + throw new TestDoubleSealedException; + } + + $matcher = new Matcher($rule, $this->className); $this->addMatcher($matcher); + if ($this->isMockObject) { + return new InvocationMockerImplementation( + $this, + $matcher, + ...$this->configurableMethods, + ); + } + return new InvocationStubberImplementation( $this, $matcher, @@ -118,6 +161,10 @@ public function invoke(Invocation $invocation): mixed } } catch (Exception $e) { $exception = $e; + + if ($this->assertionFailure === null && $e instanceof AssertionFailedError) { + $this->assertionFailure = $e; + } } } @@ -148,10 +195,70 @@ public function verify(): void foreach ($this->matchers as $matcher) { $matcher->verify(); } + + if ($this->assertionFailure !== null) { + throw $this->assertionFailure; + } + } + + public function seal(bool $isMockObject): void + { + if ($this->sealed) { + return; + } + + $this->sealed = true; + + if (!$isMockObject) { + return; + } + + $configuredMethods = $this->configuredMethodNames(); + + foreach ($this->configurableMethods as $method) { + if (!in_array($method->name(), $configuredMethods, true)) { + $matcher = new Matcher(new InvokedCount(0), $this->className); + + $matcher->setMethodNameRule(new MethodName($method->name())); + + $this->addMatcher($matcher); + } + } + } + + public function isSealed(): bool + { + return $this->sealed; } private function addMatcher(Matcher $matcher): void { $this->matchers[] = $matcher; } + + /** + * Returns the list of method names that have been configured with expectations. + * Only considers exact string matches for method names. + * Methods with any() expectation are considered configured. + * + * @return list + */ + private function configuredMethodNames(): array + { + $names = []; + + foreach ($this->matchers as $matcher) { + if (!$matcher->hasMethodNameRule()) { + continue; + } + + foreach ($this->configurableMethods as $method) { + if ($matcher->methodNameRule()->matchesName($method->name())) { + $names[] = $method->name(); + } + } + } + + return array_values(array_unique($names)); + } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationMockerImplementation.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationMockerImplementation.php new file mode 100644 index 000000000..94e11a261 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationMockerImplementation.php @@ -0,0 +1,116 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject; + +use PHPUnit\Event\Facade as EventFacade; +use PHPUnit\Framework\Exception; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class InvocationMockerImplementation extends AbstractInvocationImplementation implements InvocationMocker +{ + /** + * @throws Exception + * @throws MethodNameNotConfiguredException + * @throws MethodParametersAlreadyConfiguredException + * + * @return $this + */ + public function with(mixed ...$arguments): InvocationMocker + { + $this->ensureParametersCanBeConfigured(); + $this->emitDeprecationWhenCreatedWithoutExplicitExpects(); + + $this->matcher->setParametersRule(new Rule\Parameters($arguments)); + + return $this; + } + + public function withParameterSetsInOrder(mixed ...$arguments): InvocationMocker + { + $this->ensureParametersCanBeConfigured(); + $this->emitDeprecationWhenCreatedWithoutExplicitExpects(); + + $this->matcher->setParametersRule(new Rule\OrderedParameterSets($arguments)); + + return $this; + } + + public function withParameterSetsInAnyOrder(mixed ...$arguments): InvocationMocker + { + $this->ensureParametersCanBeConfigured(); + $this->emitDeprecationWhenCreatedWithoutExplicitExpects(); + + $this->matcher->setParametersRule(new Rule\UnorderedParameterSets($arguments)); + + return $this; + } + + /** + * @throws MethodNameNotConfiguredException + * @throws MethodParametersAlreadyConfiguredException + * + * @return $this + */ + public function withAnyParameters(): InvocationMocker + { + $this->ensureParametersCanBeConfigured(); + $this->emitDeprecationWhenCreatedWithoutExplicitExpects(); + + $this->matcher->setParametersRule(new Rule\AnyParameters); + + return $this; + } + + /** + * @param non-empty-string $id + * + * @throws MatcherAlreadyRegisteredException + * + * @return $this + * + * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6537 + */ + public function id(string $id): InvocationMocker + { + $this->invocationHandler->registerMatcher($id, $this->matcher); + + return $this; + } + + /** + * @param non-empty-string $id + * + * @return $this + * + * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6537 + */ + public function after(string $id): InvocationMocker + { + $this->matcher->setAfterMatchBuilderId($id); + + return $this; + } + + private function emitDeprecationWhenCreatedWithoutExplicitExpects(): void + { + if (!$this->createdWithoutExplicitExpects) { + return; + } + + EventFacade::emitter()->testTriggeredPhpunitDeprecation( + null, + 'Using with*() without expects() is deprecated and will no longer be possible in PHPUnit 14.', + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationStubberImplementation.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationStubberImplementation.php index 3aca45a29..31e9b8f68 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationStubberImplementation.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/InvocationStubberImplementation.php @@ -9,322 +9,11 @@ */ namespace PHPUnit\Framework\MockObject; -use function array_flip; -use function array_key_exists; -use function array_map; -use function array_merge; -use function array_pop; -use function assert; -use function count; -use function is_string; -use function range; -use function strtolower; -use PHPUnit\Framework\Constraint\Constraint; -use PHPUnit\Framework\InvalidArgumentException; -use PHPUnit\Framework\MockObject\Runtime\PropertyHook; -use PHPUnit\Framework\MockObject\Stub\ConsecutiveCalls; -use PHPUnit\Framework\MockObject\Stub\Exception; -use PHPUnit\Framework\MockObject\Stub\ReturnArgument; -use PHPUnit\Framework\MockObject\Stub\ReturnCallback; -use PHPUnit\Framework\MockObject\Stub\ReturnReference; -use PHPUnit\Framework\MockObject\Stub\ReturnSelf; -use PHPUnit\Framework\MockObject\Stub\ReturnStub; -use PHPUnit\Framework\MockObject\Stub\ReturnValueMap; -use PHPUnit\Framework\MockObject\Stub\Stub; -use Throwable; - /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * * @internal This class is not covered by the backward compatibility promise for PHPUnit */ -final class InvocationStubberImplementation implements InvocationStubber +final class InvocationStubberImplementation extends AbstractInvocationImplementation implements InvocationStubber { - private readonly InvocationHandler $invocationHandler; - private readonly Matcher $matcher; - - /** - * @var list - */ - private readonly array $configurableMethods; - - /** - * @var ?array - */ - private ?array $configurableMethodNames = null; - - public function __construct(InvocationHandler $handler, Matcher $matcher, ConfigurableMethod ...$configurableMethods) - { - $this->invocationHandler = $handler; - $this->matcher = $matcher; - $this->configurableMethods = $configurableMethods; - } - - /** - * @param Constraint|non-empty-string|PropertyHook $constraint - * - * @throws InvalidArgumentException - * @throws MethodCannotBeConfiguredException - * @throws MethodNameAlreadyConfiguredException - * - * @return $this - */ - public function method(Constraint|PropertyHook|string $constraint): InvocationStubber - { - if ($this->matcher->hasMethodNameRule()) { - throw new MethodNameAlreadyConfiguredException; - } - - if ($constraint instanceof PropertyHook) { - $constraint = $constraint->asString(); - } - - if (is_string($constraint)) { - $this->configurableMethodNames ??= array_flip( - array_map( - static fn (ConfigurableMethod $configurable) => strtolower($configurable->name()), - $this->configurableMethods, - ), - ); - - if (!array_key_exists(strtolower($constraint), $this->configurableMethodNames)) { - throw new MethodCannotBeConfiguredException($constraint); - } - } - - $this->matcher->setMethodNameRule(new Rule\MethodName($constraint)); - - return $this; - } - - /** - * @param non-empty-string $id - * - * @throws MatcherAlreadyRegisteredException - * - * @return $this - */ - public function id(string $id): InvocationStubber - { - $this->invocationHandler->registerMatcher($id, $this->matcher); - - return $this; - } - - /** - * @param non-empty-string $id - * - * @return $this - */ - public function after(string $id): InvocationStubber - { - $this->matcher->setAfterMatchBuilderId($id); - - return $this; - } - - /** - * @throws \PHPUnit\Framework\Exception - * @throws MethodNameNotConfiguredException - * @throws MethodParametersAlreadyConfiguredException - * - * @return $this - */ - public function with(mixed ...$arguments): InvocationStubber - { - $this->ensureParametersCanBeConfigured(); - - $this->matcher->setParametersRule(new Rule\Parameters($arguments)); - - return $this; - } - - /** - * @throws MethodNameNotConfiguredException - * @throws MethodParametersAlreadyConfiguredException - * - * @return $this - */ - public function withAnyParameters(): InvocationStubber - { - $this->ensureParametersCanBeConfigured(); - - $this->matcher->setParametersRule(new Rule\AnyParameters); - - return $this; - } - - /** - * @return $this - */ - public function will(Stub $stub): InvocationStubber - { - $this->matcher->setStub($stub); - - return $this; - } - - /** - * @throws IncompatibleReturnValueException - */ - public function willReturn(mixed $value, mixed ...$nextValues): InvocationStubber - { - if (count($nextValues) === 0) { - $this->ensureTypeOfReturnValues([$value]); - - $stub = $value instanceof Stub ? $value : new ReturnStub($value); - - return $this->will($stub); - } - - $values = array_merge([$value], $nextValues); - - $this->ensureTypeOfReturnValues($values); - - $stub = new ConsecutiveCalls($values); - - return $this->will($stub); - } - - public function willReturnReference(mixed &$reference): InvocationStubber - { - $stub = new ReturnReference($reference); - - return $this->will($stub); - } - - public function willReturnMap(array $valueMap): InvocationStubber - { - $method = $this->configuredMethod(); - - assert($method instanceof ConfigurableMethod); - - $numberOfParameters = $method->numberOfParameters(); - $defaultValues = $method->defaultParameterValues(); - $hasDefaultValues = $defaultValues !== []; - - $_valueMap = []; - - foreach ($valueMap as $mapping) { - $numberOfConfiguredParameters = count($mapping) - 1; - - if ($numberOfConfiguredParameters === $numberOfParameters || !$hasDefaultValues) { - $_valueMap[] = $mapping; - - continue; - } - - $_mapping = []; - $returnValue = array_pop($mapping); - - foreach (range(0, $numberOfParameters - 1) as $i) { - if (array_key_exists($i, $mapping)) { - $_mapping[] = $mapping[$i]; - - continue; - } - - if (array_key_exists($i, $defaultValues)) { - $_mapping[] = $defaultValues[$i]; - } - } - - $_mapping[] = $returnValue; - $_valueMap[] = $_mapping; - } - - $stub = new ReturnValueMap($_valueMap); - - return $this->will($stub); - } - - public function willReturnArgument(int $argumentIndex): InvocationStubber - { - $stub = new ReturnArgument($argumentIndex); - - return $this->will($stub); - } - - public function willReturnCallback(callable $callback): InvocationStubber - { - $stub = new ReturnCallback($callback); - - return $this->will($stub); - } - - public function willReturnSelf(): InvocationStubber - { - $stub = new ReturnSelf; - - return $this->will($stub); - } - - public function willReturnOnConsecutiveCalls(mixed ...$values): InvocationStubber - { - $stub = new ConsecutiveCalls($values); - - return $this->will($stub); - } - - public function willThrowException(Throwable $exception): InvocationStubber - { - $stub = new Exception($exception); - - return $this->will($stub); - } - - /** - * @throws MethodNameNotConfiguredException - * @throws MethodParametersAlreadyConfiguredException - */ - private function ensureParametersCanBeConfigured(): void - { - if (!$this->matcher->hasMethodNameRule()) { - throw new MethodNameNotConfiguredException; - } - - if ($this->matcher->hasParametersRule()) { - throw new MethodParametersAlreadyConfiguredException; - } - } - - private function configuredMethod(): ?ConfigurableMethod - { - $configuredMethod = null; - - foreach ($this->configurableMethods as $configurableMethod) { - if ($this->matcher->methodNameRule()->matchesName($configurableMethod->name())) { - if ($configuredMethod !== null) { - return null; - } - - $configuredMethod = $configurableMethod; - } - } - - return $configuredMethod; - } - - /** - * @param array $values - * - * @throws IncompatibleReturnValueException - */ - private function ensureTypeOfReturnValues(array $values): void - { - $configuredMethod = $this->configuredMethod(); - - if ($configuredMethod === null) { - return; - } - - foreach ($values as $value) { - if (!$configuredMethod->mayReturn($value)) { - throw new IncompatibleReturnValueException( - $configuredMethod, - $value, - ); - } - } - } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Matcher.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Matcher.php index f1587f3b3..692d2028c 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Matcher.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Matcher.php @@ -30,6 +30,11 @@ final class Matcher { private readonly InvocationOrder $invocationRule; + /** + * @var class-string + */ + private readonly string $className; + /** * @var ?non-empty-string */ @@ -38,23 +43,37 @@ final class Matcher private ?ParametersRule $parametersRule = null; private ?Stub $stub = null; - public function __construct(InvocationOrder $rule) + /** + * @param class-string $className + */ + public function __construct(InvocationOrder $rule, string $className) { $this->invocationRule = $rule; + $this->className = $className; } - public function hasMatchers(): bool + public function hasInvocationCountRule(): bool { return !$this->invocationRule instanceof AnyInvokedCount; } + /** + * @phpstan-assert-if-true !null $this->methodNameRule + */ public function hasMethodNameRule(): bool { return $this->methodNameRule !== null; } + /** + * @throws MethodNameNotConfiguredException + */ public function methodNameRule(): MethodName { + if (!$this->hasMethodNameRule()) { + throw new MethodNameNotConfiguredException; + } + return $this->methodNameRule; } @@ -63,6 +82,9 @@ public function setMethodNameRule(MethodName $rule): void $this->methodNameRule = $rule; } + /** + * @phpstan-assert-if-true !null $this->parametersRule + */ public function hasParametersRule(): bool { return $this->parametersRule !== null; @@ -116,9 +138,8 @@ public function invoked(Invocation $invocation): mixed } catch (ExpectationFailedException $e) { throw new ExpectationFailedException( sprintf( - "Expectation failed for %s when %s\n%s", - $this->methodNameRule->toString(), - $this->invocationRule->toString(), + "Expectation for %s failed.\n%s", + $this->methodNameRule->failureDescription($this->className), $e->getMessage(), ), $e->getComparisonFailure(), @@ -169,9 +190,8 @@ public function matches(Invocation $invocation): bool } catch (ExpectationFailedException $e) { throw new ExpectationFailedException( sprintf( - "Expectation failed for %s when %s\n%s", - $this->methodNameRule->toString(), - $this->invocationRule->toString(), + "Expectation for %s failed.\n%s", + $this->methodNameRule->failureDescription($this->className), $e->getMessage(), ), $e->getComparisonFailure(), @@ -193,27 +213,50 @@ public function verify(): void try { $this->invocationRule->verify(); + } catch (ExpectationFailedException) { + $actual = $this->invocationRule->numberOfInvocations(); - if ($this->parametersRule === null) { - $this->parametersRule = new AnyParameters; + if ($actual === 0) { + $invoked = 'never invoked'; + } elseif ($actual === 1) { + $invoked = 'invoked once'; + } else { + $invoked = sprintf( + 'invoked %d times', + $actual, + ); } - $invocationIsAny = $this->invocationRule instanceof AnyInvokedCount; - $invocationIsNever = $this->invocationRule instanceof InvokedCount && $this->invocationRule->isNever(); - $invocationIsAtMost = $this->invocationRule instanceof InvokedAtMostCount; - - if (!$invocationIsAny && !$invocationIsNever && !$invocationIsAtMost) { - $this->parametersRule->verify(); - } - } catch (ExpectationFailedException $e) { throw new ExpectationFailedException( sprintf( - "Expectation failed for %s when %s.\n%s", - $this->methodNameRule->toString(), + '%s was expected to be %s but was %s.', + $this->methodNameRule->failureDescription($this->className), $this->invocationRule->toString(), - ThrowableToStringMapper::map($e), + $invoked, ), ); } + + if ($this->parametersRule === null) { + $this->parametersRule = new AnyParameters; + } + + $invocationIsAny = $this->invocationRule instanceof AnyInvokedCount; + $invocationIsNever = $this->invocationRule instanceof InvokedCount && $this->invocationRule->isNever(); + $invocationIsAtMost = $this->invocationRule instanceof InvokedAtMostCount; + + if (!$invocationIsAny && !$invocationIsNever && !$invocationIsAtMost) { + try { + $this->parametersRule->verify(); + } catch (ExpectationFailedException $e) { + throw new ExpectationFailedException( + sprintf( + "Expectation for %s failed.\n%s", + $this->methodNameRule->failureDescription($this->className), + ThrowableToStringMapper::map($e), + ), + ); + } + } } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/MethodNameConstraint.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/MethodNameConstraint.php index bb6bf60bd..072ebf4b8 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/MethodNameConstraint.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/MethodNameConstraint.php @@ -27,6 +27,11 @@ public function __construct(string $methodName) $this->methodName = $methodName; } + public function methodName(): string + { + return $this->methodName; + } + public function toString(): string { return sprintf( diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/ReturnValueGenerator.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/ReturnValueGenerator.php index e429bc984..e5922f2ae 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/ReturnValueGenerator.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/ReturnValueGenerator.php @@ -9,6 +9,7 @@ */ namespace PHPUnit\Framework\MockObject; +use function array_all; use function array_map; use function explode; use function in_array; @@ -59,7 +60,7 @@ public function generate(string $className, string $methodName, StubInternal $te } if (!$intersection) { - $lowerTypes = array_map('strtolower', $types); + $lowerTypes = array_map(strtolower(...), $types); if (in_array('', $lowerTypes, true) || in_array('null', $lowerTypes, true) || @@ -163,13 +164,7 @@ public function generate(string $className, string $methodName, StubInternal $te */ private function onlyInterfaces(array $types): bool { - foreach ($types as $type) { - if (!interface_exists($type)) { - return false; - } - } - - return true; + return array_all($types, static fn (string $type) => interface_exists($type)); } /** @@ -181,13 +176,14 @@ private function onlyInterfaces(array $types): bool private function newInstanceOf(StubInternal $testStub, string $className, string $methodName): Stub { try { - $object = (new ReflectionClass($testStub::class))->newInstanceWithoutConstructor(); + $object = new ReflectionClass($testStub::class)->newInstanceWithoutConstructor(); $reflector = new ReflectionObject($object); $reflector->getProperty('__phpunit_state')->setValue( $object, new TestDoubleState( $testStub->__phpunit_state()->configurableMethods(), + $className, $testStub->__phpunit_state()->generateReturnValues(), ), ); diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/AnyParameters.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/AnyParameters.php index 01a54d1b4..0bca00995 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/AnyParameters.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/AnyParameters.php @@ -18,6 +18,9 @@ */ final class AnyParameters implements ParametersRule { + /** + * @throws void + */ public function apply(BaseInvocation $invocation): void { } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedAtMostCount.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedAtMostCount.php index 0cfda5e18..8e7351626 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedAtMostCount.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedAtMostCount.php @@ -29,10 +29,13 @@ public function __construct(int $allowedInvocations) public function toString(): string { + if ($this->allowedInvocations === 1) { + return 'invoked at most once'; + } + return sprintf( - 'invoked at most %d time%s', + 'invoked at most %d times', $this->allowedInvocations, - $this->allowedInvocations !== 1 ? 's' : '', ); } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedCount.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedCount.php index 3f0e505a0..6b7b4c24c 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedCount.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/InvokedCount.php @@ -34,10 +34,13 @@ public function isNever(): bool public function toString(): string { + if ($this->expectedCount === 1) { + return 'invoked once'; + } + return sprintf( - 'invoked %d time%s', + 'invoked %d times', $this->expectedCount, - $this->expectedCount !== 1 ? 's' : '', ); } @@ -80,14 +83,16 @@ protected function invokedDo(BaseInvocation $invocation): void $message = $invocation->toString() . ' '; $message .= match ($this->expectedCount) { - 0 => 'was not expected to be called.', - 1 => 'was not expected to be called more than once.', + 0 => 'was not expected to be called', + 1 => 'was not expected to be called more than once', default => sprintf( - 'was not expected to be called more than %d times.', + 'was not expected to be called more than %d times', $this->expectedCount, ), }; + $message .= sprintf(', actually called %d time%s.', $count, $count !== 1 ? 's' : ''); + throw new ExpectationFailedException($message); } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/MethodName.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/MethodName.php index 219a8087d..ac98f2b2e 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/MethodName.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/MethodName.php @@ -42,6 +42,18 @@ public function toString(): string return 'method name ' . $this->constraint->toString(); } + /** + * @param class-string $className + */ + public function failureDescription(string $className): string + { + if ($this->constraint instanceof MethodNameConstraint) { + return $className . '::' . $this->constraint->methodName() . '()'; + } + + return $this->toString(); + } + /** * @throws ExpectationFailedException */ diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/OrderedParameterSets.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/OrderedParameterSets.php new file mode 100644 index 000000000..95a46e72f --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/OrderedParameterSets.php @@ -0,0 +1,91 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject\Rule; + +use function array_shift; +use function count; +use function is_array; +use function sprintf; +use PHPUnit\Framework\ExpectationFailedException; +use PHPUnit\Framework\MockObject\Invocation as BaseInvocation; +use PHPUnit\Framework\MockObject\NoMoreParameterSetsConfiguredException; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class OrderedParameterSets implements ParametersRule +{ + /** + * @var list + */ + private array $stack = []; + + /** + * @var list + */ + private array $applied = []; + private int $numberOfConfiguredParameterSets; + + /** + * @param list $stack + */ + public function __construct(array $stack) + { + foreach ($stack as $parameters) { + $this->stack[] = new Parameters(is_array($parameters) ? $parameters : [$parameters]); + } + + $this->numberOfConfiguredParameterSets = count($stack); + } + + public function apply(BaseInvocation $invocation): void + { + if ($this->stack === []) { + throw new NoMoreParameterSetsConfiguredException( + $invocation, + $this->numberOfConfiguredParameterSets, + ); + } + + $parameters = array_shift($this->stack); + $this->applied[] = $parameters; + + $parameters->apply($invocation); + } + + /** + * Checks if the invocation $invocation matches the current rules. If it + * does the rule will get the invoked() method called which should check + * if an expectation is met. + * + * @throws ExpectationFailedException + */ + public function verify(): void + { + if (count($this->applied) !== $this->numberOfConfiguredParameterSets && + count($this->stack) > 0) { + throw new ExpectationFailedException( + sprintf( + 'Too many parameter sets given, %d out of %d expected parameter set%s %s been called.', + count($this->applied), + $this->numberOfConfiguredParameterSets, + $this->numberOfConfiguredParameterSets !== 1 ? 's' : '', + count($this->applied) !== 1 ? 'have' : 'has', + ), + ); + } + + foreach ($this->applied as $parameters) { + $parameters->verify(); + } + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/Parameters.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/Parameters.php index 17df3f0a7..0fd73ae34 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/Parameters.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/Parameters.php @@ -9,6 +9,7 @@ */ namespace PHPUnit\Framework\MockObject\Rule; +use function assert; use function count; use function sprintf; use Exception; @@ -19,6 +20,8 @@ use PHPUnit\Framework\ExpectationFailedException; use PHPUnit\Framework\MockObject\Invocation as BaseInvocation; use PHPUnit\Util\Test; +use ReflectionException; +use ReflectionMethod; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -33,6 +36,7 @@ final class Parameters implements ParametersRule private array $parameters = []; private ?BaseInvocation $invocation = null; private null|bool|ExpectationFailedException $parameterVerificationResult; + private bool $useAssertionCount = true; /** * @param array $parameters @@ -81,6 +85,11 @@ public function verify(): void $this->doVerify(); } + public function useAssertionCount(bool $useAssertionCount): void + { + $this->useAssertionCount = $useAssertionCount; + } + /** * @throws ExpectationFailedException */ @@ -113,6 +122,8 @@ private function doVerify(): bool ); } + $parameters = $this->parameters($this->invocation); + foreach ($this->parameters as $i => $parameter) { if ($parameter instanceof Callback && $parameter->isVariadic()) { $other = $this->invocation->parameters(); @@ -126,7 +137,7 @@ private function doVerify(): bool $other, sprintf( 'Parameter %s for invocation %s does not match expected value.', - $i, + $parameters[$i] ?? (string) $i, $this->invocation->toString(), ), ); @@ -149,6 +160,34 @@ private function guardAgainstDuplicateEvaluationOfParameterConstraints(): bool private function incrementAssertionCount(): void { + if ($this->useAssertionCount === false) { + return; + } + Test::currentTestCase()->addToAssertionCount(1); } + + /** + * @return array + */ + private function parameters(BaseInvocation $invocation): array + { + $parameters = []; + + try { + $reflector = new ReflectionMethod( + $invocation->className(), + $invocation->methodName(), + ); + + foreach ($reflector->getParameters() as $parameter) { + assert($parameter->getPosition() >= 0); + + $parameters[$parameter->getPosition()] = '$' . $parameter->getName(); + } + } catch (ReflectionException) { + } + + return $parameters; + } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/UnorderedParameterSets.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/UnorderedParameterSets.php new file mode 100644 index 000000000..751ab88b1 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Rule/UnorderedParameterSets.php @@ -0,0 +1,115 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject\Rule; + +use function array_search; +use function array_shift; +use function count; +use function implode; +use function is_array; +use function sprintf; +use PHPUnit\Framework\ExpectationFailedException; +use PHPUnit\Framework\MockObject\Invocation as BaseInvocation; +use PHPUnit\Framework\MockObject\NoMoreParameterSetsConfiguredException; + +final class UnorderedParameterSets implements ParametersRule +{ + /** + * @var list + */ + private array $stack = []; + + /** + * @var list + */ + private array $unapplied = []; + + /** + * @var list + */ + private array $applied = []; + private int $numberOfConfiguredParameterSets; + + /** + * @param list $stack + */ + public function __construct(array $stack) + { + foreach ($stack as $parameters) { + $this->stack[] = new Parameters(is_array($parameters) ? $parameters : [$parameters]); + } + + $this->unapplied = $this->stack; + $this->numberOfConfiguredParameterSets = count($stack); + } + + public function apply(BaseInvocation $invocation): void + { + if ($this->unapplied === []) { + throw new NoMoreParameterSetsConfiguredException( + $invocation, + $this->numberOfConfiguredParameterSets, + ); + } + + $checkedParameters = 0; + $unappliedParameters = count($this->unapplied); + + while ($checkedParameters < $unappliedParameters) { + $checkedParameters++; + $parameters = array_shift($this->unapplied); + + try { + $parameters->useAssertionCount(false); + $parameters->apply($invocation); + + $this->applied[] = $parameters; + + $parameters->useAssertionCount(true); + $parameters->apply($invocation); + + break; + } catch (ExpectationFailedException $e) { + $this->unapplied[] = $parameters; + } + } + } + + /** + * Checks if the invocation $invocation matches the current rules. If it + * does the rule will get the invoked() method called which should check + * if an expectation is met. + * + * @throws ExpectationFailedException + */ + public function verify(): void + { + if (count($this->applied) !== $this->numberOfConfiguredParameterSets && + count($this->unapplied) > 0) { + $unappliedIndexes = []; + + foreach ($this->unapplied as $parameters) { + $unappliedIndexes[] = array_search($parameters, $this->stack, true); + } + + throw new ExpectationFailedException( + sprintf( + '%d out of %d expected parameter set%s %s called, index%s [' . implode(', ', $unappliedIndexes) . '] %s not called.', + count($this->applied), + $this->numberOfConfiguredParameterSets, + $this->numberOfConfiguredParameterSets !== 1 ? 's' : '', + count($this->applied) !== 1 ? 'were' : 'was', + count($unappliedIndexes) !== 1 ? 'es' : '', + count($unappliedIndexes) !== 1 ? 'were' : 'was', + ), + ); + } + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Stub/Stub.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Stub/Stub.php index 46d9e53a9..dc613d4f3 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Stub/Stub.php +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/Runtime/Stub/Stub.php @@ -14,7 +14,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Stub { diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/TestDoubleBuilder.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/TestDoubleBuilder.php new file mode 100644 index 000000000..da196b65c --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/TestDoubleBuilder.php @@ -0,0 +1,186 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject; + +use function array_merge; +use PHPUnit\Framework\MockObject\Generator\Generator; +use PHPUnit\Framework\MockObject\Generator\ReflectionException; +use ReflectionClass; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +abstract class TestDoubleBuilder +{ + /** + * @var class-string|trait-string + */ + protected readonly string $type; + + /** + * @var list + */ + protected array $methods = []; + protected bool $emptyMethodsArray = false; + + /** + * @var array + */ + protected array $constructorArgs = []; + protected bool $originalConstructor = true; + protected bool $originalClone = true; + protected bool $returnValueGeneration = true; + + /** + * @param class-string|trait-string $type + */ + public function __construct(string $type) + { + $this->type = $type; + } + + /** + * Specifies the subset of methods to mock, requiring each to exist in the class. + * + * @param list $methods + * + * @throws CannotUseOnlyMethodsException + * @throws ReflectionException + * + * @return $this + */ + public function onlyMethods(array $methods): static + { + if ($methods === []) { + $this->emptyMethodsArray = true; + + return $this; + } + + try { + $reflector = new ReflectionClass($this->type); + + // @codeCoverageIgnoreStart + } catch (\ReflectionException $e) { + throw new ReflectionException( + $e->getMessage(), + $e->getCode(), + $e, + ); + // @codeCoverageIgnoreEnd + } + + foreach ($methods as $method) { + if (!$reflector->hasMethod($method)) { + throw new CannotUseOnlyMethodsException($this->type, $method); + } + } + + $this->methods = array_merge($this->methods, $methods); + + return $this; + } + + /** + * Specifies the arguments for the constructor. + * + * @param array $arguments + * + * @return $this + */ + public function setConstructorArgs(array $arguments): static + { + $this->constructorArgs = $arguments; + + return $this; + } + + /** + * Disables the invocation of the original constructor. + * + * @return $this + */ + public function disableOriginalConstructor(): static + { + $this->originalConstructor = false; + + return $this; + } + + /** + * Enables the invocation of the original constructor. + * + * @return $this + */ + public function enableOriginalConstructor(): static + { + $this->originalConstructor = true; + + return $this; + } + + /** + * Disables the invocation of the original clone constructor. + * + * @return $this + */ + public function disableOriginalClone(): static + { + $this->originalClone = false; + + return $this; + } + + /** + * Enables the invocation of the original clone constructor. + * + * @return $this + */ + public function enableOriginalClone(): static + { + $this->originalClone = true; + + return $this; + } + + /** + * @return $this + */ + public function enableAutoReturnValueGeneration(): static + { + $this->returnValueGeneration = true; + + return $this; + } + + /** + * @return $this + */ + public function disableAutoReturnValueGeneration(): static + { + $this->returnValueGeneration = false; + + return $this; + } + + protected function getTestDouble(?string $testDoubleClassName, bool $mockObject): MockObject|Stub + { + return (new Generator)->testDouble( + $this->type, + $mockObject, + !$this->emptyMethodsArray ? $this->methods : null, + $this->constructorArgs, + $testDoubleClassName ?? '', + $this->originalConstructor, + $this->originalClone, + $this->returnValueGeneration, + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/MockObject/TestStubBuilder.php b/app/vendor/phpunit/phpunit/src/Framework/MockObject/TestStubBuilder.php new file mode 100644 index 000000000..acfe85fca --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Framework/MockObject/TestStubBuilder.php @@ -0,0 +1,76 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Framework\MockObject; + +use function assert; +use PHPUnit\Framework\MockObject\Generator\ClassIsAnonymousException; +use PHPUnit\Framework\MockObject\Generator\ClassIsEnumerationException; +use PHPUnit\Framework\MockObject\Generator\ClassIsFinalException; +use PHPUnit\Framework\MockObject\Generator\DuplicateMethodException; +use PHPUnit\Framework\MockObject\Generator\InvalidClassNameException; +use PHPUnit\Framework\MockObject\Generator\InvalidMethodNameException; +use PHPUnit\Framework\MockObject\Generator\NameAlreadyInUseException; +use PHPUnit\Framework\MockObject\Generator\ReflectionException; +use PHPUnit\Framework\MockObject\Generator\RuntimeException; +use PHPUnit\Framework\MockObject\Generator\UnknownTypeException; + +/** + * @template StubbedType + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +final class TestStubBuilder extends TestDoubleBuilder +{ + /** + * @var ?class-string + */ + private ?string $stubClassName = null; + + /** + * Creates a test stub using a fluent interface. + * + * @throws ClassIsAnonymousException + * @throws ClassIsEnumerationException + * @throws ClassIsFinalException + * @throws DuplicateMethodException + * @throws InvalidClassNameException + * @throws InvalidMethodNameException + * @throws NameAlreadyInUseException + * @throws ReflectionException + * @throws RuntimeException + * @throws UnknownTypeException + * + * @return Stub&StubbedType + */ + public function getStub(): Stub + { + $object = $this->getTestDouble($this->stubClassName, false); + + assert($object instanceof $this->type); + assert($object instanceof Stub); + assert(!$object instanceof MockObject); + + return $object; + } + + /** + * Specifies the name for the mock class. + * + * @param class-string $name + * + * @return $this + */ + public function setStubClassName(string $name): self + { + $this->stubClassName = $name; + + return $this; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Framework/Reorderable.php b/app/vendor/phpunit/phpunit/src/Framework/Reorderable.php index 10f6e9431..06dc9cb13 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/Reorderable.php +++ b/app/vendor/phpunit/phpunit/src/Framework/Reorderable.php @@ -12,7 +12,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Reorderable { diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestBuilder.php b/app/vendor/phpunit/phpunit/src/Framework/TestBuilder.php index 8e484c6d1..3eb4b1a02 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestBuilder.php +++ b/app/vendor/phpunit/phpunit/src/Framework/TestBuilder.php @@ -62,7 +62,6 @@ public function build(ReflectionClass $theClass, string $methodName, array $grou $data, $this->shouldTestMethodBeRunInSeparateProcess($className, $methodName), $this->shouldGlobalStateBePreserved($className, $methodName), - $this->shouldAllTestMethodsOfTestClassBeRunInSingleSeparateProcess($className), $this->backupSettings($className, $methodName), $groups, ); @@ -74,7 +73,6 @@ public function build(ReflectionClass $theClass, string $methodName, array $grou $test, $this->shouldTestMethodBeRunInSeparateProcess($className, $methodName), $this->shouldGlobalStateBePreserved($className, $methodName), - $this->shouldAllTestMethodsOfTestClassBeRunInSingleSeparateProcess($className), $this->backupSettings($className, $methodName), ); @@ -85,10 +83,10 @@ public function build(ReflectionClass $theClass, string $methodName, array $grou * @param non-empty-string $methodName * @param class-string $className * @param array $data - * @param array{backupGlobals: ?bool, backupGlobalsExcludeList: list, backupStaticProperties: ?bool, backupStaticPropertiesExcludeList: array>} $backupSettings + * @param array{backupGlobals: ?true, backupGlobalsExcludeList: list, backupStaticProperties: ?true, backupStaticPropertiesExcludeList: array>} $backupSettings * @param list $groups */ - private function buildDataProviderTestSuite(string $methodName, string $className, array $data, bool $runTestInSeparateProcess, ?bool $preserveGlobalState, bool $runClassInSeparateProcess, array $backupSettings, array $groups): DataProviderTestSuite + private function buildDataProviderTestSuite(string $methodName, string $className, array $data, bool $runTestInSeparateProcess, ?bool $preserveGlobalState, array $backupSettings, array $groups): DataProviderTestSuite { $dataProviderTestSuite = DataProviderTestSuite::empty( $className . '::' . $methodName, @@ -108,7 +106,6 @@ private function buildDataProviderTestSuite(string $methodName, string $classNam $_test, $runTestInSeparateProcess, $preserveGlobalState, - $runClassInSeparateProcess, $backupSettings, ); @@ -119,18 +116,14 @@ private function buildDataProviderTestSuite(string $methodName, string $classNam } /** - * @param array{backupGlobals: ?bool, backupGlobalsExcludeList: list, backupStaticProperties: ?bool, backupStaticPropertiesExcludeList: array>} $backupSettings + * @param array{backupGlobals: ?true, backupGlobalsExcludeList: list, backupStaticProperties: ?true, backupStaticPropertiesExcludeList: array>} $backupSettings */ - private function configureTestCase(TestCase $test, bool $runTestInSeparateProcess, ?bool $preserveGlobalState, bool $runClassInSeparateProcess, array $backupSettings): void + private function configureTestCase(TestCase $test, bool $runTestInSeparateProcess, ?bool $preserveGlobalState, array $backupSettings): void { if ($runTestInSeparateProcess) { $test->setRunTestInSeparateProcess(true); } - if ($runClassInSeparateProcess) { - $test->setRunClassInSeparateProcess(true); - } - if ($preserveGlobalState !== null) { $test->setPreserveGlobalState($preserveGlobalState); } @@ -156,7 +149,7 @@ private function configureTestCase(TestCase $test, bool $runTestInSeparateProces * @param class-string $className * @param non-empty-string $methodName * - * @return array{backupGlobals: ?bool, backupGlobalsExcludeList: list, backupStaticProperties: ?bool, backupStaticPropertiesExcludeList: array>} + * @return array{backupGlobals: ?true, backupGlobalsExcludeList: list, backupStaticProperties: ?true, backupStaticPropertiesExcludeList: array>} */ private function backupSettings(string $className, string $methodName): array { @@ -276,14 +269,6 @@ private function shouldTestMethodBeRunInSeparateProcess(string $className, strin return false; } - /** - * @param class-string $className - */ - private function shouldAllTestMethodsOfTestClassBeRunInSingleSeparateProcess(string $className): bool - { - return MetadataRegistry::parser()->forClass($className)->isRunClassInSeparateProcess()->isNotEmpty(); - } - /** * @param class-string $className * @param non-empty-string $methodName diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestCase.php b/app/vendor/phpunit/phpunit/src/Framework/TestCase.php index 97282664e..0b8f0ec4c 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestCase.php +++ b/app/vendor/phpunit/phpunit/src/Framework/TestCase.php @@ -10,6 +10,7 @@ namespace PHPUnit\Framework; use const PHP_EOL; +use function array_any; use function array_keys; use function array_merge; use function array_reverse; @@ -50,6 +51,7 @@ use function set_exception_handler; use function sprintf; use function str_contains; +use function str_starts_with; use function stream_get_contents; use function stream_get_meta_data; use function tmpfile; @@ -75,6 +77,7 @@ use PHPUnit\Framework\MockObject\Rule\InvokedCount as InvokedCountMatcher; use PHPUnit\Framework\MockObject\Stub; use PHPUnit\Framework\MockObject\Stub\Exception as ExceptionStub; +use PHPUnit\Framework\MockObject\TestStubBuilder; use PHPUnit\Framework\TestSize\TestSize; use PHPUnit\Framework\TestStatus\TestStatus; use PHPUnit\Metadata\Api\Groups; @@ -89,9 +92,11 @@ use PHPUnit\TestRunner\TestResult\PassedTests; use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry; use PHPUnit\Util\Exporter; +use PHPUnit\Util\Sanitizer; use PHPUnit\Util\Test as TestUtil; use ReflectionClass; use ReflectionException; +use ReflectionMethod; use ReflectionObject; use SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException; use SebastianBergmann\Comparator\Comparator; @@ -133,7 +138,6 @@ abstract class TestCase extends Assert implements Reorderable, SelfDescribing, T * @var list */ private ?array $backupGlobalExceptionHandlers = null; - private ?bool $runClassInSeparateProcess = null; private ?bool $runTestInSeparateProcess = null; private bool $preserveGlobalState = false; private bool $inIsolation = false; @@ -179,13 +183,13 @@ abstract class TestCase extends Assert implements Reorderable, SelfDescribing, T private array $dependencyInput = []; /** - * @var list + * @var list */ private array $mockObjects = []; private TestStatus $status; /** - * @var 0|positive-int + * @var non-negative-int */ private int $numberOfAssertionsPerformed = 0; private mixed $testResult = null; @@ -310,7 +314,7 @@ public function toString(): string { $buffer = sprintf( '%s::%s', - (new ReflectionClass($this))->getName(), + new ReflectionClass($this)->getName(), $this->methodName, ); @@ -362,10 +366,10 @@ final public function run(): void return; } - IsolatedTestRunnerRegistry::run( + (new SeparateProcessTestRunner)->run( $this, - $this->runClassInSeparateProcess && !$this->runTestInSeparateProcess, $this->preserveGlobalState, + $this->requiresXdebug(), ); } @@ -596,7 +600,10 @@ final public function runBare(): void $this->stopOutputBuffering()) { $outputBufferingStopped = true; - $this->performAssertionsOnOutput(); + try { + $this->performAssertionsOnOutput(); + } catch (ExpectationFailedException $e) { + } } try { @@ -764,14 +771,6 @@ final public function setRunTestInSeparateProcess(bool $runTestInSeparateProcess } } - /** - * @internal This method is not covered by the backward compatibility promise for PHPUnit - */ - final public function setRunClassInSeparateProcess(bool $runClassInSeparateProcess): void - { - $this->runClassInSeparateProcess = $runClassInSeparateProcess; - } - /** * @internal This method is not covered by the backward compatibility promise for PHPUnit */ @@ -809,27 +808,38 @@ final public function setResult(mixed $result): void } /** + * @template RealInstanceType of object + * + * @param class-string $type + * * @internal This method is not covered by the backward compatibility promise for PHPUnit */ - final public function registerMockObject(MockObject $mockObject): void + final public function registerMockObject(string $type, MockObject $mockObject): void { assert($mockObject instanceof MockObjectInternal); - $this->mockObjects[] = $mockObject; + $this->mockObjects[] = [ + 'type' => $type, + 'mockObject' => $mockObject, + ]; } /** + * @param non-negative-int $count + * * @internal This method is not covered by the backward compatibility promise for PHPUnit */ final public function addToAssertionCount(int $count): void { + assert($count >= 0); + $this->numberOfAssertionsPerformed += $count; } /** - * @internal This method is not covered by the backward compatibility promise for PHPUnit + * @return non-negative-int * - * @return 0|positive-int + * @internal This method is not covered by the backward compatibility promise for PHPUnit */ final public function numberOfAssertionsPerformed(): int { @@ -859,10 +869,13 @@ final public function dataSetAsString(): string { if ($this->data !== []) { if (is_int($this->dataName)) { - return sprintf(' with data set %s', $this->dataSetAsFilterString()); + return sprintf(' with data set #%s', $this->dataName); } - return sprintf(' with data set "%s"', $this->dataSetAsFilterString()); + return sprintf( + ' with data set "%s"', + Sanitizer::sanitizeBidirectionalControlCharacters($this->dataName), + ); } return ''; @@ -968,9 +981,17 @@ final public function wasPrepared(): bool /** * Returns a matcher that matches when the method is executed * zero or more times. + * + * @deprecated https://github.com/sebastianbergmann/phpunit/issues/6461 */ final protected function any(): AnyInvokedCountMatcher { + Event\Facade::emitter()->testTriggeredPhpunitDeprecation( + $this->testValueObjectForEvents, + 'The any() invoked count expectation is deprecated and will be removed in PHPUnit 14. ' . + 'Use a test stub instead or configure a real invocation count expectation.', + ); + return new AnyInvokedCountMatcher; } @@ -988,6 +1009,14 @@ final protected function never(): InvokedCountMatcher */ final protected function atLeast(int $requiredInvocations): InvokedAtLeastCountMatcher { + if ($requiredInvocations < 1) { + Event\Facade::emitter()->testTriggeredPhpunitDeprecation( + $this->valueObjectForEvents(), + 'Calling atLeast() with an argument that is not positive is deprecated.' . PHP_EOL . + 'This will become an error in PHPUnit 14.', + ); + } + return new InvokedAtLeastCountMatcher( $requiredInvocations, ); @@ -1082,7 +1111,7 @@ final protected function expectExceptionMessageMatches(string $regularExpression * Information for expected exception class, expected exception message, and * expected exception code are retrieved from a given Exception object. */ - final protected function expectExceptionObject(\Exception $exception): void + final protected function expectExceptionObject(Throwable $exception): void { $this->expectException($exception::class); $this->expectExceptionMessage($exception->getMessage()); @@ -1167,7 +1196,7 @@ final protected function createMock(string $type): MockObject assert($mock instanceof $type); assert($mock instanceof MockObject); - $this->registerMockObject($mock); + $this->registerMockObject($type, $mock); Event\Facade::emitter()->testCreatedMockObject($type); @@ -1189,7 +1218,7 @@ final protected function createMockForIntersectionOfInterfaces(array $interfaces assert($mock instanceof MockObject); - $this->registerMockObject($mock); + $this->registerMockObject(implode('|', $interfaces), $mock); Event\Facade::emitter()->testCreatedMockObjectForIntersectionOfInterfaces($interfaces); @@ -1281,6 +1310,15 @@ protected function onNotSuccessfulTest(Throwable $t): never throw $t; } + /** + * @param array $testArguments + */ + protected function invokeTestMethod(string $methodName, array $testArguments): mixed + { + /** @phpstan-ignore method.dynamicName */ + return $this->{$methodName}(...$testArguments); + } + /** * Returns the data set as a string compatible with the --filter CLI option. * @@ -1293,7 +1331,10 @@ private function dataSetAsFilterString(): string return sprintf('#%d', $this->dataName); } - return sprintf('@%s', $this->dataName); + return sprintf( + '@%s', + Sanitizer::sanitizeBidirectionalControlCharacters($this->dataName), + ); } return ''; @@ -1312,8 +1353,7 @@ private function runTest(): mixed $this->startErrorLogCapture(); try { - /** @phpstan-ignore method.dynamicName */ - $testResult = $this->{$this->methodName}(...$testArguments); + $testResult = $this->invokeTestMethod($this->methodName, $testArguments); $this->verifyErrorLogExpectation(); } catch (Throwable $exception) { @@ -1330,6 +1370,7 @@ private function runTest(): mixed $this->stopErrorLogCapture(); } + $this->emitEventForCustomTestMethodInvocation(); $this->expectedExceptionWasNotRaised(); return $testResult; @@ -1338,7 +1379,11 @@ private function runTest(): mixed private function stripDateFromErrorLog(string $log): string { // https://github.com/php/php-src/blob/c696087e323263e941774ebbf902ac249774ec9f/main/main.c#L905 - return preg_replace('/\[\d+-\w+-\d+ \d+:\d+:\d+ [^\r\n[\]]+?\] /', '', $log); + $result = preg_replace('/\[\d+-\w+-\d+ \d+:\d+:\d+ [^\r\n[\]]+?\] /', '', $log); + + assert($result !== null); + + return $result; } /** @@ -1362,15 +1407,10 @@ private function verifyDeprecationExpectations(): void foreach ($this->expectedUserDeprecationMessageRegularExpression as $deprecationExpectation) { $this->numberOfAssertionsPerformed++; - $expectedDeprecationTriggered = false; - - foreach (DeprecationCollector::deprecations() as $deprecation) { - if (@preg_match($deprecationExpectation, $deprecation) > 0) { - $expectedDeprecationTriggered = true; - - break; - } - } + $expectedDeprecationTriggered = array_any( + DeprecationCollector::deprecations(), + static fn (string $deprecation) => @preg_match($deprecationExpectation, $deprecation) > 0, + ); if (!$expectedDeprecationTriggered) { throw new ExpectationFailedException( @@ -1388,11 +1428,45 @@ private function verifyDeprecationExpectations(): void */ private function verifyMockObjects(): void { + $allowsMockObjectsWithoutExpectations = $this->allowsMockObjectsWithoutExpectations(); + $isPhpunitTestSuite = str_starts_with($this::class, 'PHPUnit\\'); + $requireSealedMockObjects = ConfigurationRegistry::get()->requireSealedMockObjects(); + foreach ($this->mockObjects as $mockObject) { - if ($mockObject->__phpunit_hasMatchers()) { - $this->numberOfAssertionsPerformed++; + $mockedType = $mockObject['type']; + $mockObject = $mockObject['mockObject']; + + if ($requireSealedMockObjects && + !$mockObject->__phpunit_getInvocationHandler()->isSealed()) { + Event\Facade::emitter()->testConsideredRisky( + $this->valueObjectForEvents(), + sprintf( + 'Mock object for %s has not been sealed', + $mockedType, + ), + ); + } + + if (!$mockObject->__phpunit_hasInvocationCountRule()) { + if (!$mockObject->__phpunit_hasParametersRule() && + !$allowsMockObjectsWithoutExpectations && + !$isPhpunitTestSuite) { + Event\Facade::emitter()->testTriggeredPhpunitNotice( + $this->testValueObjectForEvents, + sprintf( + 'No expectations were configured for the mock object for %s. ' . + 'Consider refactoring your test code to use a test stub instead. ' . + 'The #[AllowMockObjectsWithoutExpectations] attribute can be used to opt out of this check.', + $mockedType, + ), + ); + } + + continue; } + $this->numberOfAssertionsPerformed++; + $mockObject->__phpunit_verify( $this->shouldInvocationMockerBeReset($mockObject), ); @@ -1768,6 +1842,13 @@ private function createGlobalStateSnapshot(bool $backupGlobals): Snapshot $excludeList->addClassNamePrefix('SebastianBergmann\Invoker'); $excludeList->addClassNamePrefix('SebastianBergmann\Template'); $excludeList->addClassNamePrefix('SebastianBergmann\Timer'); + + foreach (array_keys($GLOBALS) as $key) { + if (str_starts_with($key, '__phpunit_')) { + $excludeList->addGlobalVariable($key); + } + } + $excludeList->addStaticProperty(ComparatorFactory::class, 'instance'); foreach ($this->backupStaticPropertiesExcludeList as $class => $properties) { @@ -1777,18 +1858,32 @@ private function createGlobalStateSnapshot(bool $backupGlobals): Snapshot } } - return new Snapshot( - $excludeList, - $backupGlobals, - (bool) $this->backupStaticProperties, - false, - false, - false, - false, - false, - false, - false, - ); + try { + return new Snapshot( + $excludeList, + $backupGlobals, + (bool) $this->backupStaticProperties, + false, + false, + false, + false, + false, + false, + false, + ); + } catch (Throwable $t) { + Event\Facade::emitter()->testPreparationFailed( + $this->valueObjectForEvents(), + Event\Code\ThrowableBuilder::from($t), + ); + + Event\Facade::emitter()->testErrored( + $this->valueObjectForEvents(), + Event\Code\ThrowableBuilder::from($t), + ); + + throw $t; + } } private function compareGlobalStateSnapshots(Snapshot $before, Snapshot $after): void @@ -1824,20 +1919,22 @@ private function compareGlobalStateSnapshots(Snapshot $before, Snapshot $after): */ private function compareGlobalStateSnapshotPart(array $before, array $after, string $header): void { - if ($before !== $after) { - $differ = new Differ(new UnifiedDiffOutputBuilder($header)); + if ($before === $after) { + return; + } - Event\Facade::emitter()->testConsideredRisky( - $this->valueObjectForEvents(), - 'This test modified global state but was not expected to do so' . PHP_EOL . - trim( - $differ->diff( - Exporter::export($before), - Exporter::export($after), - ), + $differ = new Differ(new UnifiedDiffOutputBuilder($header, false, 3, false)); + + Event\Facade::emitter()->testConsideredRisky( + $this->valueObjectForEvents(), + 'This test modified global state but was not expected to do so' . PHP_EOL . + trim( + $differ->diff( + Exporter::export($before), + Exporter::export($after), ), - ); - } + ), + ); } private function handleEnvironmentVariables(): void @@ -1948,10 +2045,6 @@ private function shouldRunInSeparateProcess(): bool return true; } - if ($this->runClassInSeparateProcess) { - return true; - } - return ConfigurationRegistry::get()->processIsolation(); } @@ -2280,13 +2373,10 @@ private function expectedExceptionWasNotRaised(): void private function isRegisteredFailure(Throwable $t): bool { - foreach (array_keys($this->failureTypes) as $failureType) { - if ($t instanceof $failureType) { - return true; - } - } - - return false; + return array_any( + array_keys($this->failureTypes), + static fn (string $failureType) => $t instanceof $failureType, + ); } /** @@ -2302,6 +2392,11 @@ private function requirementsNotSatisfied(): bool return (new Requirements)->requirementsNotSatisfiedFor(static::class, $this->methodName) !== []; } + private function requiresXdebug(): bool + { + return (new Requirements)->requiresXdebug(static::class, $this->methodName); + } + /** * @see https://github.com/sebastianbergmann/phpunit/issues/6095 */ @@ -2408,6 +2503,42 @@ private function stopErrorLogCapture(): void $this->previousErrorLogTarget = false; } + private function allowsMockObjectsWithoutExpectations(): bool + { + return MetadataRegistry::parser()->forClassAndMethod(static::class, $this->methodName)->isAllowMockObjectsWithoutExpectations()->isNotEmpty(); + } + + private function emitEventForCustomTestMethodInvocation(): void + { + $reflector = new ReflectionMethod($this, 'invokeTestMethod'); + + if (self::class === $reflector->getDeclaringClass()->getName()) { + return; + } + + Event\Facade::emitter()->testUsedCustomMethodInvocation( + $this->valueObjectForEvents(), + new Event\Code\ClassMethod( + $reflector->getDeclaringClass()->getName(), + 'invokeTestMethod', + ), + ); + } + + /** + * Returns a builder object to create test stubs using a fluent interface. + * + * @template RealInstanceType of object + * + * @param class-string $className + * + * @return TestStubBuilder + */ + final protected static function getStubBuilder(string $className): TestStubBuilder + { + return new TestStubBuilder($className); + } + /** * Creates a test stub for the specified interface or class. * diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/ChildProcessResultProcessor.php b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/ChildProcessResultProcessor.php index af487c196..43b454409 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/ChildProcessResultProcessor.php +++ b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/ChildProcessResultProcessor.php @@ -10,6 +10,9 @@ namespace PHPUnit\Framework; use function assert; +use function hash_equals; +use function strlen; +use function substr; use function trim; use function unserialize; use PHPUnit\Event\Code\TestMethodBuilder; @@ -37,7 +40,10 @@ public function __construct(Facade $eventFacade, Emitter $emitter, PassedTests $ $this->codeCoverage = $codeCoverage; } - public function process(Test $test, string $serializedProcessResult, string $stderr): void + /** + * @param ?non-empty-string $processResultNonce + */ + public function process(Test $test, string $serializedProcessResult, string $stderr, ?string $processResultNonce = null): void { if ($stderr !== '') { $exception = new Exception(trim($stderr)); @@ -52,6 +58,35 @@ public function process(Test $test, string $serializedProcessResult, string $std return; } + if ($processResultNonce !== null && $serializedProcessResult !== '') { + $nonceLength = strlen($processResultNonce); + + if (strlen($serializedProcessResult) < $nonceLength || + !hash_equals($processResultNonce, substr($serializedProcessResult, 0, $nonceLength))) { + $this->emitter->childProcessErrored(); + + $exception = new AssertionFailedError( + 'Test was run in child process and the result file was tampered with or written by an unexpected process', + ); + + assert($test instanceof TestCase); + + $this->emitter->testErrored( + TestMethodBuilder::fromTestCase($test), + ThrowableBuilder::from($exception), + ); + + $this->emitter->testFinished( + TestMethodBuilder::fromTestCase($test), + 0, + ); + + return; + } + + $serializedProcessResult = substr($serializedProcessResult, $nonceLength); + } + $childResult = @unserialize($serializedProcessResult); if ($childResult === false) { diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/IsolatedTestRunner.php b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/IsolatedTestRunner.php deleted file mode 100644 index 0322a6046..000000000 --- a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/IsolatedTestRunner.php +++ /dev/null @@ -1,20 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Framework; - -/** - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @internal This interface is not covered by the backward compatibility promise for PHPUnit - */ -interface IsolatedTestRunner -{ - public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState): void; -} diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/IsolatedTestRunnerRegistry.php b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/IsolatedTestRunnerRegistry.php deleted file mode 100644 index 058246543..000000000 --- a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/IsolatedTestRunnerRegistry.php +++ /dev/null @@ -1,34 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Framework; - -/** - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @internal This class is not covered by the backward compatibility promise for PHPUnit - */ -final class IsolatedTestRunnerRegistry -{ - private static ?IsolatedTestRunner $runner = null; - - public static function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState): void - { - if (self::$runner === null) { - self::$runner = new SeparateProcessTestRunner; - } - - self::$runner->run($test, $runEntireClass, $preserveGlobalState); - } - - public static function set(IsolatedTestRunner $runner): void - { - self::$runner = $runner; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/SeparateProcessTestRunner.php b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/SeparateProcessTestRunner.php index 6a6e2adeb..06107b1c6 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/SeparateProcessTestRunner.php +++ b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/SeparateProcessTestRunner.php @@ -10,18 +10,22 @@ namespace PHPUnit\Framework; use function assert; +use function bin2hex; use function defined; use function get_include_path; use function hrtime; +use function random_bytes; use function serialize; +use function sprintf; use function sys_get_temp_dir; use function tempnam; use function unlink; -use function unserialize; use function var_export; +use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Event\NoPreviousThrowableException; use PHPUnit\Runner\CodeCoverage; use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry; +use PHPUnit\TextUI\Configuration\SourceMapper; use PHPUnit\Util\GlobalState; use PHPUnit\Util\PHP\Job; use PHPUnit\Util\PHP\JobRunnerRegistry; @@ -34,8 +38,10 @@ * * @internal This class is not covered by the backward compatibility promise for PHPUnit */ -final class SeparateProcessTestRunner implements IsolatedTestRunner +final class SeparateProcessTestRunner { + private static ?string $sourceMapFile = null; + /** * @throws \PHPUnit\Runner\Exception * @throws \PHPUnit\Util\Exception @@ -44,20 +50,10 @@ final class SeparateProcessTestRunner implements IsolatedTestRunner * @throws NoPreviousThrowableException * @throws ProcessIsolationException */ - public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalState): void + public function run(TestCase $test, bool $preserveGlobalState, bool $requiresXdebug): void { $class = new ReflectionClass($test); - if ($runEntireClass) { - $template = new Template( - __DIR__ . '/templates/class.tpl', - ); - } else { - $template = new Template( - __DIR__ . '/templates/method.tpl', - ); - } - $bootstrap = ''; $constants = ''; $globals = ''; @@ -69,10 +65,22 @@ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalSt } if ($preserveGlobalState) { - $constants = GlobalState::getConstantsAsString(); - $globals = GlobalState::getGlobalsAsString(); - $includedFiles = GlobalState::getIncludedFilesAsString(); - $iniSettings = GlobalState::getIniSettingsAsString(); + $constants = GlobalState::getConstantsAsString(); + $globalStateResult = GlobalState::exportGlobals(); + $globals = $globalStateResult->globalsString(); + $includedFiles = GlobalState::getIncludedFilesAsString(); + $iniSettings = GlobalState::getIniSettingsAsString(); + + foreach ($globalStateResult->skippedGlobals() as $skipped) { + EventFacade::emitter()->testTriggeredPhpunitWarning( + $test->valueObjectForEvents(), + sprintf( + 'Global variable %s was not preserved because it %s', + $skipped['name'], + $skipped['reason'], + ), + ); + } } $coverage = CodeCoverage::instance()->isActive() ? 'true' : 'false'; @@ -101,7 +109,9 @@ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalSt $includePath = "'." . $includePath . ".'"; $offset = hrtime(); $serializedConfiguration = $this->saveConfigurationForChildProcess(); - $processResultFile = tempnam(sys_get_temp_dir(), 'phpunit_'); + $processResultFile = $this->pathForCachedSourceMap(); + $processResultNonce = bin2hex(random_bytes(16)); + $sourceMapFile = $this->sourceMapFileForChildProcess(); $file = $class->getFileName(); @@ -113,6 +123,7 @@ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalSt 'phar' => $phar, 'filename' => $file, 'className' => $class->getName(), + 'methodName' => $test->name(), 'collectCodeCoverageInformation' => $coverage, 'data' => $data, 'dataName' => $dataName, @@ -127,11 +138,11 @@ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalSt 'offsetNanoseconds' => (string) $offset[1], 'serializedConfiguration' => $serializedConfiguration, 'processResultFile' => $processResultFile, + 'processResultNonce' => $processResultNonce, + 'sourceMapFile' => $sourceMapFile, ]; - if (!$runEntireClass) { - $var['methodName'] = $test->name(); - } + $template = new Template(__DIR__ . '/templates/method.tpl'); $template->setVar($var); @@ -139,26 +150,70 @@ public function run(TestCase $test, bool $runEntireClass, bool $preserveGlobalSt assert($code !== ''); - JobRunnerRegistry::runTestJob(new Job($code), $processResultFile, $test); + JobRunnerRegistry::runTestJob(new Job($code, requiresXdebug: $requiresXdebug), $processResultFile, $test, $processResultNonce); @unlink($serializedConfiguration); } + private function sourceMapFileForChildProcess(): string + { + if (self::$sourceMapFile !== null) { + return self::$sourceMapFile; + } + + if (!ConfigurationRegistry::get()->source()->notEmpty()) { + self::$sourceMapFile = ''; + + return self::$sourceMapFile; + } + + $path = $this->pathForCachedSourceMap(); + + if ($path === false) { + // @codeCoverageIgnoreStart + self::$sourceMapFile = ''; + + return self::$sourceMapFile; + // @codeCoverageIgnoreEnd + } + + if (!SourceMapper::saveTo($path, ConfigurationRegistry::get()->source())) { + // @codeCoverageIgnoreStart + self::$sourceMapFile = ''; + + return self::$sourceMapFile; + // @codeCoverageIgnoreEnd + } + + self::$sourceMapFile = $path; + + return self::$sourceMapFile; + } + /** * @throws ProcessIsolationException */ private function saveConfigurationForChildProcess(): string { - $path = tempnam(sys_get_temp_dir(), 'phpunit_'); + $path = $this->pathForCachedSourceMap(); if ($path === false) { + // @codeCoverageIgnoreStart throw new ProcessIsolationException; + // @codeCoverageIgnoreEnd } if (!ConfigurationRegistry::saveTo($path)) { + // @codeCoverageIgnoreStart throw new ProcessIsolationException; + // @codeCoverageIgnoreEnd } return $path; } + + private function pathForCachedSourceMap(): false|string + { + return tempnam(sys_get_temp_dir(), 'phpunit_'); + } } diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/TestRunner.php b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/TestRunner.php index e6cf03f6b..d5befbb42 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/TestRunner.php +++ b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/TestRunner.php @@ -310,7 +310,7 @@ private function runTestWithTimeout(TestCase $test): bool } try { - (new Invoker)->invoke([$test, 'runBare'], [], $_timeout); + (new Invoker)->invoke($test->runBare(...), [], $_timeout); } catch (TimeoutException) { Facade::emitter()->testConsideredRisky( $test->valueObjectForEvents(), diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/templates/class.tpl b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/templates/class.tpl deleted file mode 100644 index 5edd7ee29..000000000 --- a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/templates/class.tpl +++ /dev/null @@ -1,137 +0,0 @@ -initForIsolation( - PHPUnit\Event\Telemetry\HRTime::fromSecondsAndNanoseconds( - {offsetSeconds}, - {offsetNanoseconds} - ), - ); - - require_once '{filename}'; - - $configuration = ConfigurationRegistry::get(); - - if ({collectCodeCoverageInformation}) { - CodeCoverage::instance()->init($configuration, CodeCoverageFilterRegistry::instance(), true); - } - - $deprecationTriggers = [ - 'functions' => [], - 'methods' => [], - ]; - - foreach ($configuration->source()->deprecationTriggers()['functions'] as $function) { - $deprecationTriggers['functions'][] = $function; - } - - foreach ($configuration->source()->deprecationTriggers()['methods'] as $method) { - [$className, $methodName] = explode('::', $method); - - $deprecationTriggers['methods'][] = [ - 'className' => $className, - 'methodName' => $methodName, - ]; - } - - ErrorHandler::instance()->useDeprecationTriggers($deprecationTriggers); - - $test = new {className}('{name}'); - - $test->setData('{dataName}', unserialize('{data}')); - $test->setDependencyInput(unserialize('{dependencyInput}')); - $test->setInIsolation(true); - - ob_end_clean(); - - $test->run(); - - $output = ''; - - if (!$test->expectsOutput()) { - $output = $test->output(); - } - - ini_set('xdebug.scream', '0'); - - // Not every STDOUT target stream is rewindable - @rewind(STDOUT); - - if ($stdout = @stream_get_contents(STDOUT)) { - $output = $stdout . $output; - $streamMetaData = stream_get_meta_data(STDOUT); - - if (!empty($streamMetaData['stream_type']) && 'STDIO' === $streamMetaData['stream_type']) { - @ftruncate(STDOUT, 0); - @rewind(STDOUT); - } - } - - file_put_contents( - '{processResultFile}', - serialize( - (object)[ - 'testResult' => $test->result(), - 'codeCoverage' => {collectCodeCoverageInformation} ? CodeCoverage::instance()->codeCoverage() : null, - 'numAssertions' => $test->numberOfAssertionsPerformed(), - 'output' => $output, - 'events' => $dispatcher->flush(), - 'passedTests' => PassedTests::instance() - ] - ) - ); -} - -function __phpunit_error_handler($errno, $errstr, $errfile, $errline) -{ - return true; -} - -set_error_handler('__phpunit_error_handler'); - -{constants} -{included_files} -{globals} - -restore_error_handler(); - -ConfigurationRegistry::loadFrom('{serializedConfiguration}'); -(new PhpHandler)->handle(ConfigurationRegistry::get()->php()); - -if ('{bootstrap}' !== '') { - require_once '{bootstrap}'; -} - -__phpunit_run_isolated_test(); diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/templates/method.tpl b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/templates/method.tpl index 8d4f38439..e26821f7f 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestRunner/templates/method.tpl +++ b/app/vendor/phpunit/phpunit/src/Framework/TestRunner/templates/method.tpl @@ -1,10 +1,12 @@ useDeprecationTriggers($deprecationTriggers); + foreach (array_reverse($configuration->source()->issueTriggerResolvers()) as $className) { + ErrorHandler::instance()->addIssueTriggerResolver(new $className); + } + $test = new {className}('{methodName}'); $test->setData('{dataName}', unserialize('{data}')); @@ -87,9 +95,9 @@ function __phpunit_run_isolated_test() ini_set('xdebug.scream', '0'); // Not every STDOUT target stream is rewindable - @rewind(STDOUT); + $hasRewound = @rewind(STDOUT); - if ($stdout = @stream_get_contents(STDOUT)) { + if ($hasRewound && $stdout = @stream_get_contents(STDOUT)) { $output = $stdout . $output; $streamMetaData = stream_get_meta_data(STDOUT); @@ -101,7 +109,7 @@ function __phpunit_run_isolated_test() file_put_contents( '{processResultFile}', - serialize( + '{processResultNonce}' . serialize( (object)[ 'testResult' => $test->result(), 'codeCoverage' => {collectCodeCoverageInformation} ? CodeCoverage::instance()->codeCoverage() : null, @@ -128,10 +136,30 @@ set_error_handler('__phpunit_error_handler'); restore_error_handler(); ConfigurationRegistry::loadFrom('{serializedConfiguration}'); + +if ('{sourceMapFile}' !== '') { + SourceMapper::loadFrom('{sourceMapFile}', ConfigurationRegistry::get()->source()); +} + (new PhpHandler)->handle(ConfigurationRegistry::get()->php()); if ('{bootstrap}' !== '') { require_once '{bootstrap}'; } +$__phpunit_includeTestSuites = ConfigurationRegistry::get()->includeTestSuites(); +$__phpunit_excludeTestSuites = ConfigurationRegistry::get()->excludeTestSuites(); + +foreach (ConfigurationRegistry::get()->bootstrapForTestSuite() as $__phpunit_testSuiteName => $__phpunit_bootstrapForTestSuite) { + if ($__phpunit_includeTestSuites !== [] && !in_array($__phpunit_testSuiteName, $__phpunit_includeTestSuites, true)) { + continue; + } + + if ($__phpunit_excludeTestSuites !== [] && in_array($__phpunit_testSuiteName, $__phpunit_excludeTestSuites, true)) { + continue; + } + + require_once $__phpunit_bootstrapForTestSuite; +} + __phpunit_run_isolated_test(); diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestSuite.php b/app/vendor/phpunit/phpunit/src/Framework/TestSuite.php index acf9e2b76..11bc090f7 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestSuite.php +++ b/app/vendor/phpunit/phpunit/src/Framework/TestSuite.php @@ -10,6 +10,7 @@ namespace PHPUnit\Framework; use const PHP_EOL; +use function array_all; use function array_merge; use function array_pop; use function array_reverse; @@ -50,7 +51,7 @@ use Throwable; /** - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * @@ -410,7 +411,7 @@ public function markTestSuiteSkipped(string $message = ''): never } /** - * Returns an iterator for this test suite. + * @return Iterator */ public function getIterator(): Iterator { @@ -535,7 +536,7 @@ protected function addTestMethod(ReflectionClass $class, ReflectionMethod $metho new TestMethod( $className, $methodName, - $class->getFileName(), + $method->getFileName(), $method->getStartLine(), Event\Code\TestDoxBuilder::fromClassNameAndMethodName( $className, @@ -576,13 +577,7 @@ private function clearCaches(): void */ private function containsOnlyVirtualGroups(array $groups): bool { - foreach ($groups as $group) { - if (!str_starts_with($group, '__phpunit_')) { - return false; - } - } - - return true; + return array_all($groups, static fn (string $group) => str_starts_with($group, '__phpunit_')); } private function methodDoesNotExistOrIsDeclaredInTestCase(string $methodName): bool diff --git a/app/vendor/phpunit/phpunit/src/Framework/TestSuiteIterator.php b/app/vendor/phpunit/phpunit/src/Framework/TestSuiteIterator.php index 3cbf43116..e6292a0b8 100644 --- a/app/vendor/phpunit/phpunit/src/Framework/TestSuiteIterator.php +++ b/app/vendor/phpunit/phpunit/src/Framework/TestSuiteIterator.php @@ -10,11 +10,10 @@ namespace PHPUnit\Framework; use function assert; -use function count; use RecursiveIterator; /** - * @template-implements RecursiveIterator + * @template-implements RecursiveIterator * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * @@ -22,13 +21,16 @@ */ final class TestSuiteIterator implements RecursiveIterator { - private int $position = 0; - /** * @var list */ private readonly array $tests; + /** + * @var non-negative-int + */ + private int $position = 0; + public function __construct(TestSuite $testSuite) { $this->tests = $testSuite->tests(); @@ -41,9 +43,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->tests); + return isset($this->tests[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/Logging/JUnit/JunitXmlLogger.php b/app/vendor/phpunit/phpunit/src/Logging/JUnit/JunitXmlLogger.php index 14a71b769..3a5ecc248 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/JUnit/JunitXmlLogger.php +++ b/app/vendor/phpunit/phpunit/src/Logging/JUnit/JunitXmlLogger.php @@ -32,6 +32,7 @@ use PHPUnit\Event\Test\Prepared; use PHPUnit\Event\Test\PrintedUnexpectedOutput; use PHPUnit\Event\Test\Skipped; +use PHPUnit\Event\TestSuite\Skipped as TestSuiteSkipped; use PHPUnit\Event\TestSuite\Started; use PHPUnit\TextUI\Output\Printer; use PHPUnit\Util\Xml; @@ -133,6 +134,17 @@ public function testSuiteStarted(Started $event): void $this->testSuiteTimes[$this->testSuiteLevel] = 0.0; } + public function testSuiteSkipped(TestSuiteSkipped $event): void + { + assert(isset($this->testSuiteSkipped[$this->testSuiteLevel])); + assert(isset($this->testSuiteTests[$this->testSuiteLevel])); + + $this->testSuiteSkipped[$this->testSuiteLevel] += $event->testSuite()->count(); + $this->testSuiteTests[$this->testSuiteLevel] += $event->testSuite()->count(); + + $this->testSuiteFinished(); + } + public function testSuiteFinished(): void { $this->testSuites[$this->testSuiteLevel]->setAttribute( @@ -304,6 +316,7 @@ private function registerSubscribers(Facade $facade): void { $facade->registerSubscribers( new TestSuiteStartedSubscriber($this), + new TestSuiteSkippedSubscriber($this), new TestSuiteFinishedSubscriber($this), new TestPreparationStartedSubscriber($this), new TestPreparationErroredSubscriber($this), diff --git a/app/vendor/phpunit/phpunit/src/Logging/JUnit/Subscriber/TestSuiteSkippedSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/JUnit/Subscriber/TestSuiteSkippedSubscriber.php new file mode 100644 index 000000000..93c67dea0 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/JUnit/Subscriber/TestSuiteSkippedSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\JUnit; + +use PHPUnit\Event\TestSuite\Skipped; +use PHPUnit\Event\TestSuite\SkippedSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestSuiteSkippedSubscriber extends Subscriber implements SkippedSubscriber +{ + public function notify(Skipped $event): void + { + $this->logger()->testSuiteSkipped($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/InfrastructureInformationProvider.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/InfrastructureInformationProvider.php deleted file mode 100644 index e0e12cbb8..000000000 --- a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/InfrastructureInformationProvider.php +++ /dev/null @@ -1,188 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Logging\OpenTestReporting; - -use const DIRECTORY_SEPARATOR; -use const PHP_OS_FAMILY; -use function assert; -use function explode; -use function fclose; -use function function_exists; -use function getenv; -use function gethostname; -use function is_array; -use function is_resource; -use function php_uname; -use function posix_geteuid; -use function posix_getpwuid; -use function preg_split; -use function proc_close; -use function proc_open; -use function str_contains; -use function str_replace; -use function str_starts_with; -use function stream_get_contents; -use function trim; - -/** - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @internal This class is not covered by the backward compatibility promise for PHPUnit - */ -final readonly class InfrastructureInformationProvider -{ - /** - * @return non-empty-string - */ - public function operatingSystem(): string - { - return php_uname(); - } - - /** - * @return non-empty-string - */ - public function hostName(): string - { - $candidate = gethostname(); - - if ($candidate === false) { - return 'unknown'; - } - - $candidate = trim($candidate); - - if ($candidate === '') { - return 'unknown'; - } - - return $candidate; - } - - /** - * @return non-empty-string - */ - public function userName(): string - { - if (function_exists('posix_getpwuid') && function_exists('posix_geteuid')) { - $candidate = trim(posix_getpwuid(posix_geteuid())['name']); - } elseif (PHP_OS_FAMILY === 'Windows') { - $candidate = trim((string) getenv('USERNAME')); - } - - if (!isset($candidate) || $candidate === '') { - return 'unknown'; - } - - return $candidate; - } - - /** - * @return array{originUrl: non-empty-string, branch: non-empty-string, commit: non-empty-string, clean: bool, status: string}|false - */ - public function gitInformation(): array|false - { - $buffer = $this->executeGitCommand('remote show -n'); - - if ($buffer === false) { - return false; - } - - if (!str_contains($buffer, 'origin')) { - return false; - } - - $buffer = $this->executeGitCommand('remote show -n origin'); - - if ($buffer === false) { - return false; - } - - $lines = preg_split("/\r\n|\n|\r/", $buffer); - - if (!isset($lines[1]) || !str_starts_with($lines[1], ' Fetch URL: ')) { - return false; - } - - $originUrl = trim(str_replace(' Fetch URL: ', '', $lines[1])); - - if (str_contains($originUrl, '@')) { - $originUrl = explode('@', $originUrl)[1]; - } - - $branch = $this->executeGitCommand('symbolic-ref --short HEAD'); - - if ($branch === false) { - return false; - } - - $commit = $this->executeGitCommand('rev-parse HEAD'); - - if ($commit === false) { - return false; - } - - $status = $this->executeGitCommand('status --porcelain'); - - if ($status === false) { - return false; - } - - return [ - 'originUrl' => $originUrl, - 'branch' => $branch, - 'commit' => $commit, - 'clean' => $status === '', - 'status' => $status, - ]; - } - - /** - * @return false|non-empty-string - */ - private function executeGitCommand(string $command): false|string - { - $command = 'git ' . $command; - - if (DIRECTORY_SEPARATOR === '/') { - $command = 'LC_ALL=en_US.UTF-8 ' . $command; - } - - $process = @proc_open( - $command, - [ - 1 => ['pipe', 'w'], - 2 => ['pipe', 'w'], - ], - $pipes, - ); - - if (!is_resource($process)) { - return false; - } - - assert(is_array($pipes)); - assert(isset($pipes[1]) && is_resource($pipes[1])); - assert(isset($pipes[2]) && is_resource($pipes[2])); - - $result = trim((string) stream_get_contents($pipes[1])); - - fclose($pipes[1]); - fclose($pipes[2]); - - $returnCode = proc_close($process); - - if ($returnCode !== 0) { - return false; - } - - return $result; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/OtrXmlLogger.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/OtrXmlLogger.php index fe45f7409..e171d6341 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/OtrXmlLogger.php +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/OtrXmlLogger.php @@ -18,6 +18,7 @@ use function str_replace; use DateTimeImmutable; use DateTimeZone; +use PHPUnit\Event\Code\IssueTrigger\IssueTrigger; use PHPUnit\Event\Code\Test; use PHPUnit\Event\Code\TestMethod; use PHPUnit\Event\Code\Throwable; @@ -26,16 +27,33 @@ use PHPUnit\Event\Test\AfterLastTestMethodFailed; use PHPUnit\Event\Test\BeforeFirstTestMethodErrored; use PHPUnit\Event\Test\BeforeFirstTestMethodFailed; +use PHPUnit\Event\Test\ConsideredRisky; +use PHPUnit\Event\Test\DeprecationTriggered; use PHPUnit\Event\Test\Errored; +use PHPUnit\Event\Test\ErrorTriggered; use PHPUnit\Event\Test\Failed; use PHPUnit\Event\Test\MarkedIncomplete; +use PHPUnit\Event\Test\NoticeTriggered; +use PHPUnit\Event\Test\PhpDeprecationTriggered; +use PHPUnit\Event\Test\PhpNoticeTriggered; +use PHPUnit\Event\Test\PhpunitDeprecationTriggered; +use PHPUnit\Event\Test\PhpunitErrorTriggered; +use PHPUnit\Event\Test\PhpunitNoticeTriggered; +use PHPUnit\Event\Test\PhpunitWarningTriggered; +use PHPUnit\Event\Test\PhpWarningTriggered; use PHPUnit\Event\Test\PreparationErrored; use PHPUnit\Event\Test\PreparationFailed; use PHPUnit\Event\Test\Prepared as TestStarted; +use PHPUnit\Event\Test\PrintedUnexpectedOutput; use PHPUnit\Event\Test\Skipped; +use PHPUnit\Event\Test\WarningTriggered; use PHPUnit\Event\TestSuite\Skipped as TestSuiteSkipped; use PHPUnit\Event\TestSuite\Started as TestSuiteStarted; use PHPUnit\Event\TestSuite\TestSuiteForTestClass; +use PHPUnit\Metadata\Group; +use SebastianBergmann\Environment\Host; +use SebastianBergmann\GitState\Builder as GitStateBuilder; +use SebastianBergmann\GitState\State as GitState; use XMLWriter; /** @@ -65,10 +83,15 @@ final class OtrXmlLogger /** * @var ?positive-int */ - private ?int $testId = null; - private ?Throwable $parentErrored = null; - private ?Throwable $parentFailed = null; - private bool $alreadyFinished = false; + private ?int $testId = null; + private ?Throwable $parentErrored = null; + private ?Throwable $parentFailed = null; + private bool $testWasPrepared = false; + private bool $alreadyFinished = false; + private ?Status $pendingStatus = null; + private ?string $pendingReason = null; + private ?Throwable $pendingThrowable = null; + private ?bool $pendingAssertionError = null; private bool $includeGitInformation; /** @@ -95,12 +118,8 @@ public function __construct(Facade $facade, string $uri, bool $includeGitInforma public function testRunnerStarted(): void { - $infrastructure = new InfrastructureInformationProvider; - $gitInformation = false; - - if ($this->includeGitInformation) { - $gitInformation = $infrastructure->gitInformation(); - } + $host = new Host; + $gitInformation = $this->gitInformation(); $this->writer->startDocument(); @@ -112,28 +131,28 @@ public function testRunnerStarted(): void $this->writer->writeAttribute('xmlns:git', 'https://schemas.opentest4j.org/reporting/git/0.2.0'); } - $this->writer->writeAttribute('xmlns:php', 'https://schema.phpunit.de/otr/php/0.0.1'); - $this->writer->writeAttribute('xmlns:phpunit', 'https://schema.phpunit.de/otr/phpunit/0.0.1'); + $this->writer->writeAttribute('xmlns:php', 'https://schema.phpunit.de/otr/php/0.1.0'); + $this->writer->writeAttribute('xmlns:phpunit', 'https://schema.phpunit.de/otr/phpunit/0.1.0'); $this->writer->startElement('infrastructure'); - $this->writer->writeElement('hostName', $infrastructure->hostName()); - $this->writer->writeElement('userName', $infrastructure->userName()); - $this->writer->writeElement('operatingSystem', $infrastructure->operatingSystem()); + $this->writer->writeElement('hostName', $host->name()); + $this->writer->writeElement('userName', $host->user()); + $this->writer->writeElement('operatingSystem', $host->operatingSystem()); $this->writer->writeElement('php:phpVersion', PHP_VERSION); $this->writer->writeElement('php:threadModel', ZEND_THREAD_SAFE ? 'ZTS' : 'NTS'); if ($gitInformation !== false) { $this->writer->startElement('git:repository'); - $this->writer->writeAttribute('originUrl', $gitInformation['originUrl']); + $this->writer->writeAttribute('originUrl', $gitInformation->originUrl()); $this->writer->endElement(); - $this->writer->writeElement('git:branch', $gitInformation['branch']); - $this->writer->writeElement('git:commit', $gitInformation['commit']); + $this->writer->writeElement('git:branch', $gitInformation->branch()); + $this->writer->writeElement('git:commit', $gitInformation->commit()); $this->writer->startElement('git:status'); - $this->writer->writeAttribute('clean', $gitInformation['clean'] === true ? 'true' : 'false'); - $this->writer->writeCdata($gitInformation['status']); + $this->writer->writeAttribute('clean', $gitInformation->isClean() ? 'true' : 'false'); + $this->writer->writeCdata($gitInformation->status()); $this->writer->endElement(); } @@ -249,6 +268,149 @@ public function testPrepared(PreparationErrored|PreparationFailed|TestStarted $e $this->testId, $this->parentId, ); + + if ($event instanceof TestStarted) { + $this->testWasPrepared = true; + } + } + + public function testPrintedUnexpectedOutput(PrintedUnexpectedOutput $event): void + { + $this->writer->startElement('e:reported'); + $this->writer->writeAttribute('id', (string) $this->testId); + $this->writer->writeAttribute('time', $this->timestamp()); + + $this->writer->startElement('attachments'); + $this->writer->startElement('output'); + $this->writer->writeAttribute('source', 'stdout'); + $this->writer->writeAttribute('time', $this->timestamp()); + $this->writer->writeCdata($event->output()); + $this->writer->endElement(); + $this->writer->endElement(); + + $this->writer->endElement(); + + $this->writer->flush(); + } + + public function testDeprecationTriggered(DeprecationTriggered $event): void + { + $trigger = $event->trigger(); + + $this->writeIssue( + 'deprecation', + $event->message(), + $event->file(), + $event->line(), + $event->wasSuppressed(), + $event->ignoredByBaseline(), + $event->ignoredByTest(), + $this->triggerAsString($trigger), + $trigger->callerAsString(), + $trigger->calleeAsString(), + ); + } + + public function testPhpDeprecationTriggered(PhpDeprecationTriggered $event): void + { + $trigger = $event->trigger(); + + $this->writeIssue( + 'php-deprecation', + $event->message(), + $event->file(), + $event->line(), + $event->wasSuppressed(), + $event->ignoredByBaseline(), + $event->ignoredByTest(), + $this->triggerAsString($trigger), + $trigger->callerAsString(), + $trigger->calleeAsString(), + ); + } + + public function testPhpunitDeprecationTriggered(PhpunitDeprecationTriggered $event): void + { + $this->writeIssue('phpunit-deprecation', $event->message()); + } + + public function testErrorTriggered(ErrorTriggered $event): void + { + $this->writeIssue( + 'error', + $event->message(), + $event->file(), + $event->line(), + $event->wasSuppressed(), + ); + } + + public function testPhpunitErrorTriggered(PhpunitErrorTriggered $event): void + { + $this->writeIssue('phpunit-error', $event->message()); + } + + public function testNoticeTriggered(NoticeTriggered $event): void + { + $this->writeIssue( + 'notice', + $event->message(), + $event->file(), + $event->line(), + $event->wasSuppressed(), + $event->ignoredByBaseline(), + ); + } + + public function testPhpNoticeTriggered(PhpNoticeTriggered $event): void + { + $this->writeIssue( + 'php-notice', + $event->message(), + $event->file(), + $event->line(), + $event->wasSuppressed(), + $event->ignoredByBaseline(), + ); + } + + public function testPhpunitNoticeTriggered(PhpunitNoticeTriggered $event): void + { + $this->writeIssue('phpunit-notice', $event->message()); + } + + public function testWarningTriggered(WarningTriggered $event): void + { + $this->writeIssue( + 'warning', + $event->message(), + $event->file(), + $event->line(), + $event->wasSuppressed(), + $event->ignoredByBaseline(), + ); + } + + public function testPhpWarningTriggered(PhpWarningTriggered $event): void + { + $this->writeIssue( + 'php-warning', + $event->message(), + $event->file(), + $event->line(), + $event->wasSuppressed(), + $event->ignoredByBaseline(), + ); + } + + public function testPhpunitWarningTriggered(PhpunitWarningTriggered $event): void + { + $this->writeIssue('phpunit-warning', $event->message(), null, null, null, null, $event->ignoredByTest()); + } + + public function testConsideredRisky(ConsideredRisky $event): void + { + $this->writeIssue('risky', $event->message()); } public function testFinished(): void @@ -257,18 +419,52 @@ public function testFinished(): void $this->writer->startElement('e:finished'); $this->writer->writeAttribute('id', (string) $this->testId); $this->writer->writeAttribute('time', $this->timestamp()); + + $status = Status::Successful; + + if ($this->pendingStatus !== null) { + $status = $this->pendingStatus; + } + $this->writer->startElement('result'); - $this->writer->writeAttribute('status', Status::Successful->value); + $this->writer->writeAttribute('status', $status->value); + + if ($this->pendingReason !== null) { + $this->writer->writeElement('reason', $this->pendingReason); + } + + if ($this->pendingThrowable !== null) { + assert($this->pendingAssertionError !== null); + + $this->writeThrowable($this->pendingThrowable, $this->pendingAssertionError); + } + $this->writer->endElement(); $this->writer->endElement(); + + $this->writer->flush(); } - $this->alreadyFinished = false; - $this->testId = null; + $this->alreadyFinished = false; + $this->testWasPrepared = false; + $this->testId = null; + $this->pendingStatus = null; + $this->pendingReason = null; + $this->pendingThrowable = null; + $this->pendingAssertionError = null; } public function testFailed(Failed $event): void { + if ($this->testWasPrepared) { + $this->pendingStatus = Status::Failed; + $this->pendingReason = $event->throwable()->message(); + $this->pendingThrowable = $event->throwable(); + $this->pendingAssertionError = true; + + return; + } + $this->writer->startElement('e:finished'); $this->writer->writeAttribute('id', (string) $this->testId); $this->writer->writeAttribute('time', $this->timestamp()); @@ -288,6 +484,15 @@ public function testFailed(Failed $event): void public function testErrored(Errored $event): void { + if ($this->testWasPrepared) { + $this->pendingStatus = Status::Errored; + $this->pendingReason = $event->throwable()->message(); + $this->pendingThrowable = $event->throwable(); + $this->pendingAssertionError = false; + + return; + } + $this->writer->startElement('e:finished'); $this->writer->writeAttribute('id', (string) $this->testId); $this->writer->writeAttribute('time', $this->timestamp()); @@ -315,51 +520,111 @@ public function testSkipped(Skipped $event): void $this->testId, $this->parentId, ); - } - $this->writer->startElement('e:finished'); - $this->writer->writeAttribute('id', (string) $this->testId); - $this->writer->writeAttribute('time', $this->timestamp()); - $this->writer->startElement('result'); - $this->writer->writeAttribute('status', Status::Skipped->value); + $this->writer->startElement('e:finished'); + $this->writer->writeAttribute('id', (string) $this->testId); + $this->writer->writeAttribute('time', $this->timestamp()); + $this->writer->startElement('result'); + $this->writer->writeAttribute('status', Status::Skipped->value); - $this->writer->writeElement('reason', $event->message()); + $this->writer->writeElement('reason', $event->message()); - $this->writer->endElement(); - $this->writer->endElement(); + $this->writer->endElement(); + $this->writer->endElement(); - $this->writer->flush(); + $this->writer->flush(); - $this->alreadyFinished = true; + $this->testId = null; + + return; + } + + $this->pendingStatus = Status::Skipped; + $this->pendingReason = $event->message(); } public function markTestIncomplete(MarkedIncomplete $event): void { - $this->writer->startElement('e:finished'); + $this->pendingStatus = Status::Aborted; + $this->pendingReason = $event->throwable()->message(); + $this->pendingThrowable = $event->throwable(); + $this->pendingAssertionError = false; + } + + public function parentErrored(AfterLastTestMethodErrored|BeforeFirstTestMethodErrored $event): void + { + $this->parentErrored = $event->throwable(); + } + + public function parentFailed(AfterLastTestMethodFailed|BeforeFirstTestMethodFailed $event): void + { + $this->parentFailed = $event->throwable(); + } + + private function writeIssue(string $type, string $message, ?string $file = null, ?int $line = null, ?bool $suppressed = null, ?bool $ignoredByBaseline = null, ?bool $ignoredByTest = null, ?string $trigger = null, ?string $caller = null, ?string $callee = null): void + { + $this->writer->startElement('e:reported'); $this->writer->writeAttribute('id', (string) $this->testId); $this->writer->writeAttribute('time', $this->timestamp()); - $this->writer->startElement('result'); - $this->writer->writeAttribute('status', Status::Aborted->value); - $this->writer->writeElement('reason', $event->throwable()->message()); - $this->writeThrowable($event->throwable(), false); + $this->writer->startElement('attachments'); + $this->writer->startElement('phpunit:issue'); + $this->writer->writeAttribute('type', $type); + $this->writer->writeAttribute('message', $message); + + if ($file !== null) { + $this->writer->writeAttribute('file', $file); + } + + if ($line !== null) { + $this->writer->writeAttribute('line', (string) $line); + } + + if ($suppressed !== null) { + $this->writer->writeAttribute('suppressed', $suppressed ? 'true' : 'false'); + } + + if ($ignoredByBaseline !== null) { + $this->writer->writeAttribute('ignoredByBaseline', $ignoredByBaseline ? 'true' : 'false'); + } + + if ($ignoredByTest !== null) { + $this->writer->writeAttribute('ignoredByTest', $ignoredByTest ? 'true' : 'false'); + } + + if ($trigger !== null) { + $this->writer->writeAttribute('trigger', $trigger); + } + + if ($caller !== null) { + $this->writer->writeAttribute('caller', $caller); + } + + if ($callee !== null) { + $this->writer->writeAttribute('callee', $callee); + } $this->writer->endElement(); $this->writer->endElement(); - + $this->writer->endElement(); $this->writer->flush(); - - $this->alreadyFinished = true; } - public function parentErrored(AfterLastTestMethodErrored|BeforeFirstTestMethodErrored $event): void + private function triggerAsString(IssueTrigger $trigger): string { - $this->parentErrored = $event->throwable(); - } + if ($trigger->isSelf()) { + return 'self'; + } - public function parentFailed(AfterLastTestMethodFailed|BeforeFirstTestMethodFailed $event): void - { - $this->parentFailed = $event->throwable(); + if ($trigger->isDirect()) { + return 'direct'; + } + + if ($trigger->isIndirect()) { + return 'indirect'; + } + + return 'unknown'; } private function registerSubscribers(Facade $facade): void @@ -375,6 +640,19 @@ private function registerSubscribers(Facade $facade): void new TestPreparationErroredSubscriber($this), new TestPreparationFailedSubscriber($this), new TestPreparedSubscriber($this), + new TestPrintedUnexpectedOutputSubscriber($this), + new TestDeprecationTriggeredSubscriber($this), + new TestPhpDeprecationTriggeredSubscriber($this), + new TestPhpunitDeprecationTriggeredSubscriber($this), + new TestErrorTriggeredSubscriber($this), + new TestPhpunitErrorTriggeredSubscriber($this), + new TestNoticeTriggeredSubscriber($this), + new TestPhpNoticeTriggeredSubscriber($this), + new TestPhpunitNoticeTriggeredSubscriber($this), + new TestWarningTriggeredSubscriber($this), + new TestPhpWarningTriggeredSubscriber($this), + new TestPhpunitWarningTriggeredSubscriber($this), + new TestConsideredRiskySubscriber($this), new TestAbortedSubscriber($this), new TestErroredSubscriber($this), new TestFailedSubscriber($this), @@ -401,6 +679,30 @@ private function writeTestStarted(Test $test, int $id, ?int $parentId): void $this->writer->writeAttribute('name', $test->name()); $this->writer->writeAttribute('time', $this->timestamp()); + if ($test->isTestMethod()) { + assert($test instanceof TestMethod); + + $tags = []; + + foreach ($test->metadata()->isGroup() as $group) { + assert($group instanceof Group); + + $tags[] = $group->groupName(); + } + + if ($tags !== []) { + $this->writer->startElement('metadata'); + $this->writer->startElement('tags'); + + foreach ($tags as $tag) { + $this->writer->writeElement('tag', $tag); + } + + $this->writer->endElement(); + $this->writer->endElement(); + } + } + $this->writer->startElement('sources'); $this->writer->startElement('fileSource'); @@ -446,7 +748,7 @@ private function writeThrowable(Throwable $throwable, bool $assertionError): voi */ private function timestamp(): string { - return (new DateTimeImmutable('now', new DateTimeZone('UTC')))->format('Y-m-d\TH:i:s.u\Z'); + return new DateTimeImmutable('now', new DateTimeZone('UTC'))->format('Y-m-d\TH:i:s.u\Z'); } /** @@ -469,4 +771,13 @@ private function reduceTestSuiteLevel(): void $this->parentId = null; } + + private function gitInformation(): false|GitState + { + if (!$this->includeGitInformation) { + return false; + } + + return (new GitStateBuilder)->build(); + } } diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestConsideredRiskySubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestConsideredRiskySubscriber.php new file mode 100644 index 000000000..5aa241220 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestConsideredRiskySubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\ConsideredRisky; +use PHPUnit\Event\Test\ConsideredRiskySubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestConsideredRiskySubscriber extends Subscriber implements ConsideredRiskySubscriber +{ + public function notify(ConsideredRisky $event): void + { + $this->logger()->testConsideredRisky($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestDeprecationTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestDeprecationTriggeredSubscriber.php new file mode 100644 index 000000000..3ff118460 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestDeprecationTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\DeprecationTriggered; +use PHPUnit\Event\Test\DeprecationTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestDeprecationTriggeredSubscriber extends Subscriber implements DeprecationTriggeredSubscriber +{ + public function notify(DeprecationTriggered $event): void + { + $this->logger()->testDeprecationTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestErrorTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestErrorTriggeredSubscriber.php new file mode 100644 index 000000000..fdac835d2 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestErrorTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\ErrorTriggered; +use PHPUnit\Event\Test\ErrorTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestErrorTriggeredSubscriber extends Subscriber implements ErrorTriggeredSubscriber +{ + public function notify(ErrorTriggered $event): void + { + $this->logger()->testErrorTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestNoticeTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestNoticeTriggeredSubscriber.php new file mode 100644 index 000000000..b574b1a5a --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestNoticeTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\NoticeTriggered; +use PHPUnit\Event\Test\NoticeTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestNoticeTriggeredSubscriber extends Subscriber implements NoticeTriggeredSubscriber +{ + public function notify(NoticeTriggered $event): void + { + $this->logger()->testNoticeTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpDeprecationTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpDeprecationTriggeredSubscriber.php new file mode 100644 index 000000000..cefcdde65 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpDeprecationTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PhpDeprecationTriggered; +use PHPUnit\Event\Test\PhpDeprecationTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPhpDeprecationTriggeredSubscriber extends Subscriber implements PhpDeprecationTriggeredSubscriber +{ + public function notify(PhpDeprecationTriggered $event): void + { + $this->logger()->testPhpDeprecationTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpNoticeTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpNoticeTriggeredSubscriber.php new file mode 100644 index 000000000..40a9717e7 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpNoticeTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PhpNoticeTriggered; +use PHPUnit\Event\Test\PhpNoticeTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPhpNoticeTriggeredSubscriber extends Subscriber implements PhpNoticeTriggeredSubscriber +{ + public function notify(PhpNoticeTriggered $event): void + { + $this->logger()->testPhpNoticeTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpWarningTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpWarningTriggeredSubscriber.php new file mode 100644 index 000000000..6cf9e283a --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpWarningTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PhpWarningTriggered; +use PHPUnit\Event\Test\PhpWarningTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPhpWarningTriggeredSubscriber extends Subscriber implements PhpWarningTriggeredSubscriber +{ + public function notify(PhpWarningTriggered $event): void + { + $this->logger()->testPhpWarningTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitDeprecationTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitDeprecationTriggeredSubscriber.php new file mode 100644 index 000000000..3b37302ff --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitDeprecationTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PhpunitDeprecationTriggered; +use PHPUnit\Event\Test\PhpunitDeprecationTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPhpunitDeprecationTriggeredSubscriber extends Subscriber implements PhpunitDeprecationTriggeredSubscriber +{ + public function notify(PhpunitDeprecationTriggered $event): void + { + $this->logger()->testPhpunitDeprecationTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitErrorTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitErrorTriggeredSubscriber.php new file mode 100644 index 000000000..856338a3a --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitErrorTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PhpunitErrorTriggered; +use PHPUnit\Event\Test\PhpunitErrorTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPhpunitErrorTriggeredSubscriber extends Subscriber implements PhpunitErrorTriggeredSubscriber +{ + public function notify(PhpunitErrorTriggered $event): void + { + $this->logger()->testPhpunitErrorTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitNoticeTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitNoticeTriggeredSubscriber.php new file mode 100644 index 000000000..668b1576f --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitNoticeTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PhpunitNoticeTriggered; +use PHPUnit\Event\Test\PhpunitNoticeTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPhpunitNoticeTriggeredSubscriber extends Subscriber implements PhpunitNoticeTriggeredSubscriber +{ + public function notify(PhpunitNoticeTriggered $event): void + { + $this->logger()->testPhpunitNoticeTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitWarningTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitWarningTriggeredSubscriber.php new file mode 100644 index 000000000..5933f4786 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPhpunitWarningTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PhpunitWarningTriggered; +use PHPUnit\Event\Test\PhpunitWarningTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPhpunitWarningTriggeredSubscriber extends Subscriber implements PhpunitWarningTriggeredSubscriber +{ + public function notify(PhpunitWarningTriggered $event): void + { + $this->logger()->testPhpunitWarningTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPrintedUnexpectedOutputSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPrintedUnexpectedOutputSubscriber.php new file mode 100644 index 000000000..c6e689c24 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestPrintedUnexpectedOutputSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\PrintedUnexpectedOutput; +use PHPUnit\Event\Test\PrintedUnexpectedOutputSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPrintedUnexpectedOutputSubscriber extends Subscriber implements PrintedUnexpectedOutputSubscriber +{ + public function notify(PrintedUnexpectedOutput $event): void + { + $this->logger()->testPrintedUnexpectedOutput($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestWarningTriggeredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestWarningTriggeredSubscriber.php new file mode 100644 index 000000000..7273511e2 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/Subscriber/TestWarningTriggeredSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\OpenTestReporting; + +use PHPUnit\Event\Test\WarningTriggered; +use PHPUnit\Event\Test\WarningTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestWarningTriggeredSubscriber extends Subscriber implements WarningTriggeredSubscriber +{ + public function notify(WarningTriggered $event): void + { + $this->logger()->testWarningTriggered($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/otr.xsd b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/otr.xsd index 982dac4de..e74b41d2d 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/otr.xsd +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/otr.xsd @@ -2,6 +2,6 @@ - - + + diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/php.xsd b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/php.xsd index f880345d1..e033139ee 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/php.xsd +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/php.xsd @@ -1,5 +1,5 @@ diff --git a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/phpunit.xsd b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/phpunit.xsd index 0a0c00eda..73015bf2e 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/phpunit.xsd +++ b/app/vendor/phpunit/phpunit/src/Logging/OpenTestReporting/schema/phpunit.xsd @@ -1,6 +1,7 @@ @@ -16,7 +17,7 @@ - + @@ -25,10 +26,62 @@ - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationErroredSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationErroredSubscriber.php new file mode 100644 index 000000000..0dac588b0 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationErroredSubscriber.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\TeamCity; + +use PHPUnit\Event\InvalidArgumentException; +use PHPUnit\Event\Test\PreparationErrored; +use PHPUnit\Event\Test\PreparationErroredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPreparationErroredSubscriber extends Subscriber implements PreparationErroredSubscriber +{ + /** + * @throws InvalidArgumentException + */ + public function notify(PreparationErrored $event): void + { + $this->logger()->testPreparationErrored(); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationFailedSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationFailedSubscriber.php new file mode 100644 index 000000000..a42c67cc4 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationFailedSubscriber.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\TeamCity; + +use PHPUnit\Event\InvalidArgumentException; +use PHPUnit\Event\Test\PreparationFailed; +use PHPUnit\Event\Test\PreparationFailedSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPreparationFailedSubscriber extends Subscriber implements PreparationFailedSubscriber +{ + /** + * @throws InvalidArgumentException + */ + public function notify(PreparationFailed $event): void + { + $this->logger()->testPreparationFailed(); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationStartedSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationStartedSubscriber.php new file mode 100644 index 000000000..658545d60 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparationStartedSubscriber.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\TeamCity; + +use PHPUnit\Event\InvalidArgumentException; +use PHPUnit\Event\Test\PreparationStarted; +use PHPUnit\Event\Test\PreparationStartedSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestPreparationStartedSubscriber extends Subscriber implements PreparationStartedSubscriber +{ + /** + * @throws InvalidArgumentException + */ + public function notify(PreparationStarted $event): void + { + $this->logger()->testPreparationStarted($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparedSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparedSubscriber.php index 85476a059..ce42b320a 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparedSubscriber.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestPreparedSubscriber.php @@ -21,6 +21,6 @@ { public function notify(Prepared $event): void { - $this->logger()->testPrepared($event); + $this->logger()->testPrepared(); } } diff --git a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestSuiteBeforeFirstTestMethodFailedSubscriber.php b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestSuiteBeforeFirstTestMethodFailedSubscriber.php new file mode 100644 index 000000000..b0c3e2a27 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/Subscriber/TestSuiteBeforeFirstTestMethodFailedSubscriber.php @@ -0,0 +1,30 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Logging\TeamCity; + +use PHPUnit\Event\InvalidArgumentException; +use PHPUnit\Event\Test\BeforeFirstTestMethodFailed; +use PHPUnit\Event\Test\BeforeFirstTestMethodFailedSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestSuiteBeforeFirstTestMethodFailedSubscriber extends Subscriber implements BeforeFirstTestMethodFailedSubscriber +{ + /** + * @throws InvalidArgumentException + */ + public function notify(BeforeFirstTestMethodFailed $event): void + { + $this->logger()->beforeFirstTestMethodFailed($event); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/TeamCityLogger.php b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/TeamCityLogger.php index 9a56fc383..45e2434ef 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TeamCity/TeamCityLogger.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TeamCity/TeamCityLogger.php @@ -24,12 +24,13 @@ use PHPUnit\Event\InvalidArgumentException; use PHPUnit\Event\Telemetry\HRTime; use PHPUnit\Event\Test\BeforeFirstTestMethodErrored; +use PHPUnit\Event\Test\BeforeFirstTestMethodFailed; use PHPUnit\Event\Test\ConsideredRisky; use PHPUnit\Event\Test\Errored; use PHPUnit\Event\Test\Failed; use PHPUnit\Event\Test\Finished; use PHPUnit\Event\Test\MarkedIncomplete; -use PHPUnit\Event\Test\Prepared; +use PHPUnit\Event\Test\PreparationStarted; use PHPUnit\Event\Test\Skipped; use PHPUnit\Event\TestSuite\Finished as TestSuiteFinished; use PHPUnit\Event\TestSuite\Skipped as TestSuiteSkipped; @@ -50,6 +51,9 @@ final class TeamCityLogger private bool $isSummaryTestCountPrinted = false; private ?HRTime $time = null; private ?int $flowId = null; + private bool $testStartedEmitted = false; + private bool $prepared = false; + private bool $preparationFailed = false; public function __construct(Printer $printer, Facade $facade) { @@ -112,7 +116,7 @@ public function testSuiteFinished(TestSuiteFinished $event): void $this->writeMessage('testSuiteFinished', $parameters); } - public function testPrepared(Prepared $event): void + public function testPreparationStarted(PreparationStarted $event): void { $test = $event->test(); @@ -133,7 +137,25 @@ public function testPrepared(Prepared $event): void $this->writeMessage('testStarted', $parameters); - $this->time = $event->telemetryInfo()->time(); + $this->time = $event->telemetryInfo()->time(); + $this->testStartedEmitted = true; + $this->prepared = false; + $this->preparationFailed = false; + } + + public function testPreparationErrored(): void + { + $this->preparationFailed = true; + } + + public function testPreparationFailed(): void + { + $this->preparationFailed = true; + } + + public function testPrepared(): void + { + $this->prepared = true; } /** @@ -156,6 +178,8 @@ public function testMarkedIncomplete(MarkedIncomplete $event): void 'duration' => $this->duration($event), ], ); + + $this->writeTestFinishedIfPreparationDidNotComplete($event); } /** @@ -175,6 +199,8 @@ public function testSkipped(Skipped $event): void $parameters['duration'] = $this->duration($event); $this->writeMessage('testIgnored', $parameters); + + $this->writeTestFinishedIfPreparationDidNotComplete($event); } /** @@ -202,19 +228,23 @@ public function testSuiteSkipped(TestSuiteSkipped $event): void */ public function beforeFirstTestMethodErrored(BeforeFirstTestMethodErrored $event): void { - if ($this->time === null) { - $this->time = $event->telemetryInfo()->time(); - } - - $parameters = [ - 'name' => $event->testClassName(), - 'message' => $this->message($event->throwable()), - 'details' => $this->details($event->throwable()), - 'duration' => $this->duration($event), - ]; + $this->writeBeforeFirstTestMethodHookFailure( + $event, + $event->testClassName(), + $event->throwable(), + ); + } - $this->writeMessage('testFailed', $parameters); - $this->writeMessage('testSuiteFinished', $parameters); + /** + * @throws InvalidArgumentException + */ + public function beforeFirstTestMethodFailed(BeforeFirstTestMethodFailed $event): void + { + $this->writeBeforeFirstTestMethodHookFailure( + $event, + $event->testClassName(), + $event->throwable(), + ); } /** @@ -235,6 +265,8 @@ public function testErrored(Errored $event): void 'duration' => $this->duration($event), ], ); + + $this->writeTestFinishedIfPreparationDidNotComplete($event); } /** @@ -262,6 +294,8 @@ public function testFailed(Failed $event): void } $this->writeMessage('testFailed', $parameters); + + $this->writeTestFinishedIfPreparationDidNotComplete($event); } /** @@ -291,6 +325,10 @@ public function testConsideredRisky(ConsideredRisky $event): void */ public function testFinished(Finished $event): void { + if (!$this->testStartedEmitted) { + return; + } + $this->writeMessage( 'testFinished', [ @@ -299,7 +337,10 @@ public function testFinished(Finished $event): void ], ); - $this->time = null; + $this->time = null; + $this->testStartedEmitted = false; + $this->prepared = false; + $this->preparationFailed = false; } public function flush(): void @@ -312,6 +353,9 @@ private function registerSubscribers(Facade $facade): void $facade->registerSubscribers( new TestSuiteStartedSubscriber($this), new TestSuiteFinishedSubscriber($this), + new TestPreparationStartedSubscriber($this), + new TestPreparationErroredSubscriber($this), + new TestPreparationFailedSubscriber($this), new TestPreparedSubscriber($this), new TestFinishedSubscriber($this), new TestErroredSubscriber($this), @@ -322,7 +366,78 @@ private function registerSubscribers(Facade $facade): void new TestConsideredRiskySubscriber($this), new TestRunnerExecutionFinishedSubscriber($this), new TestSuiteBeforeFirstTestMethodErroredSubscriber($this), + new TestSuiteBeforeFirstTestMethodFailedSubscriber($this), + ); + } + + /** + * @throws InvalidArgumentException + */ + private function writeBeforeFirstTestMethodHookFailure(Event $event, string $name, Throwable $throwable): void + { + if ($this->time === null) { + $this->time = $event->telemetryInfo()->time(); + } + + $this->writeMessage( + 'testStarted', + [ + 'name' => $name, + ], + ); + + $parameters = [ + 'name' => $name, + 'message' => $this->message($throwable), + 'details' => $this->details($throwable), + 'duration' => $this->duration($event), + ]; + + $this->writeMessage('testFailed', $parameters); + + $this->writeMessage( + 'testFinished', + [ + 'name' => $name, + 'duration' => $this->duration($event), + ], ); + + $this->writeMessage( + 'testSuiteFinished', + [ + 'name' => $name, + ], + ); + + $this->time = null; + } + + /** + * @throws InvalidArgumentException + */ + private function writeTestFinishedIfPreparationDidNotComplete(Errored|Failed|MarkedIncomplete|Skipped $event): void + { + if (!$this->testStartedEmitted) { + return; + } + + if ($this->prepared && !$this->preparationFailed) { + return; + } + + $this->writeMessage( + 'testFinished', + [ + 'name' => $event->test()->name(), + 'duration' => $this->duration($event), + ], + ); + + $this->time = null; + $this->testStartedEmitted = false; + $this->prepared = false; + $this->preparationFailed = false; } private function setFlowId(): void diff --git a/app/vendor/phpunit/phpunit/src/Logging/TestDox/HtmlRenderer.php b/app/vendor/phpunit/phpunit/src/Logging/TestDox/HtmlRenderer.php index 3d74d5936..7f1fea6fb 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TestDox/HtmlRenderer.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TestDox/HtmlRenderer.php @@ -89,16 +89,16 @@ EOT; /** - * @param array $tests + * @param array $tests */ public function render(array $tests): string { $buffer = self::PAGE_HEADER; - foreach ($tests as $prettifiedClassName => $_tests) { + foreach ($tests as $_tests) { $buffer .= sprintf( self::CLASS_HEADER, - $prettifiedClassName, + $_tests->asArray()[0]->test()->testDox()->prettifiedClassName(), ); foreach ($this->reduce($_tests) as $prettifiedMethodName => $outcome) { diff --git a/app/vendor/phpunit/phpunit/src/Logging/TestDox/NamePrettifier.php b/app/vendor/phpunit/phpunit/src/Logging/TestDox/NamePrettifier.php index 99d266c6c..7ff031f91 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TestDox/NamePrettifier.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TestDox/NamePrettifier.php @@ -25,9 +25,11 @@ use function is_int; use function is_object; use function is_scalar; +use function is_string; use function method_exists; use function preg_quote; use function preg_replace; +use function preg_replace_callback_array; use function rtrim; use function sprintf; use function str_contains; @@ -36,9 +38,9 @@ use function str_starts_with; use function strlen; use function strtolower; -use function strtoupper; use function substr; use function trim; +use function ucfirst; use PHPUnit\Event\Code\TestMethodBuilder; use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Framework\TestCase; @@ -48,6 +50,7 @@ use PHPUnit\Util\Color; use PHPUnit\Util\Exporter; use PHPUnit\Util\Filter; +use PHPUnit\Util\Sanitizer; use ReflectionEnum; use ReflectionMethod; use ReflectionObject; @@ -99,12 +102,6 @@ public function prettifyTestClassName(string $className): string $className = substr($className, 0, strlen($className) - strlen('Test')); } - if (str_starts_with($className, 'Tests')) { - $className = substr($className, strlen('Tests')); - } elseif (str_starts_with($className, 'Test')) { - $className = substr($className, strlen('Test')); - } - if ($className === '') { $className = 'UnnamedTests'; } @@ -118,6 +115,8 @@ public function prettifyTestClassName(string $className): string $result = preg_replace('/(?<=[[:lower:]])(?=[[:upper:]])/u', ' ', $className); + assert($result !== null); + if ($fullyQualifiedName !== $className) { return $result . ' (' . $fullyQualifiedName . ')'; } @@ -150,7 +149,7 @@ public function prettifyTestMethodName(string $name): string return ''; } - $name[0] = strtoupper($name[0]); + $name = ucfirst($name); $noUnderscore = str_replace('_', ' ', $name); @@ -158,30 +157,13 @@ public function prettifyTestMethodName(string $name): string return trim($noUnderscore); } - $wasNumeric = false; - - $buffer = ''; - - $len = strlen($name); - - for ($i = 0; $i < $len; $i++) { - if ($i > 0 && $name[$i] >= 'A' && $name[$i] <= 'Z') { - $buffer .= ' ' . strtolower($name[$i]); - } else { - $isNumeric = $name[$i] >= '0' && $name[$i] <= '9'; - - if (!$wasNumeric && $isNumeric) { - $buffer .= ' '; - $wasNumeric = true; - } - - if ($wasNumeric && !$isNumeric) { - $wasNumeric = false; - } - - $buffer .= $name[$i]; - } - } + $buffer = preg_replace_callback_array( + [ + '/(?!^)([A-Z])/' => static fn (array $matches) => ' ' . strtolower($matches[1]), + '/(\d+)/' => static fn (array $matches) => ' ' . $matches[1], + ], + $name, + ); return trim($buffer); } @@ -242,7 +224,12 @@ public function prettifyDataSet(TestCase $test, bool $colorize): string return Color::dim(' with data set ') . Color::colorize('fg-cyan', (string) $test->dataName()); } - return Color::dim(' with ') . Color::colorize('fg-cyan', Color::visualizeWhitespace($test->dataName())); + return Color::dim(' with ') . Color::colorize( + 'fg-cyan', + Color::visualizeWhitespace( + Sanitizer::sanitizeBidirectionalControlCharacters($test->dataName()), + ), + ); } /** @@ -256,17 +243,29 @@ private function mapTestMethodParameterNamesToProvidedDataValues(TestCase $test, $reflector = new ReflectionMethod($test::class, $test->name()); $providedData = []; - $providedDataValues = array_values($test->providedData()); + $providedDataValues = $test->providedData(); $i = 0; - $providedData['$_dataName'] = $test->dataName(); + $dataName = $test->dataName(); + + if (is_int($dataName)) { + $providedData['$_dataName'] = $dataName; + } else { + $providedData['$_dataName'] = Sanitizer::sanitizeBidirectionalControlCharacters($dataName); + } foreach ($reflector->getParameters() as $parameter) { - if (!array_key_exists($i, $providedDataValues) && $parameter->isDefaultValueAvailable()) { - $providedDataValues[$i] = $parameter->getDefaultValue(); + if (array_key_exists($parameter->getName(), $providedDataValues)) { + $value = $providedDataValues[$parameter->getName()]; + } elseif (array_key_exists($i, $providedDataValues)) { + $value = $providedDataValues[$i]; + } elseif ($parameter->isDefaultValueAvailable()) { + $value = $parameter->getDefaultValue(); + } else { + $value = null; } - $value = $providedDataValues[$i++] ?? null; + $i++; if (is_object($value)) { $value = $this->objectToString($value); @@ -292,7 +291,11 @@ private function mapTestMethodParameterNamesToProvidedDataValues(TestCase $test, } } - $providedData['$' . $parameter->getName()] = str_replace('$', '\\$', $value); + $providedData['$' . $parameter->getName()] = str_replace( + '$', + '\\$', + Sanitizer::sanitizeBidirectionalControlCharacters($value), + ); } if ($colorize) { @@ -305,9 +308,6 @@ private function mapTestMethodParameterNamesToProvidedDataValues(TestCase $test, return $providedData; } - /** - * @return non-empty-string - */ private function objectToString(object $value): string { $reflector = new ReflectionObject($value); @@ -319,11 +319,11 @@ private function objectToString(object $value): string return (string) $value->value; } - return $value->name; + return (string) $value->name; } if ($reflector->hasMethod('__toString')) { - return $value->__toString(); + return (string) $value; } return $value::class; @@ -355,6 +355,8 @@ private function processTestDox(TestCase $test, TestDox $testDox, bool $colorize $placeholdersUsed = true; } + assert($result !== null); + return [$result, $placeholdersUsed]; } @@ -419,7 +421,11 @@ private function processTestDoxFormatter(TestCase $test, TestDoxFormatter $forma } try { - return [$reflector->invokeArgs(null, array_values($test->providedData())), true]; + $result = $reflector->invokeArgs(null, array_values($test->providedData())); + + assert(is_string($result)); + + return [$result, true]; } catch (Throwable $t) { EventFacade::emitter()->testTriggeredPhpunitError( TestMethodBuilder::fromTestCase($test, false), diff --git a/app/vendor/phpunit/phpunit/src/Logging/TestDox/PlainTextRenderer.php b/app/vendor/phpunit/phpunit/src/Logging/TestDox/PlainTextRenderer.php index db591ca9f..bf98896fe 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TestDox/PlainTextRenderer.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TestDox/PlainTextRenderer.php @@ -19,14 +19,14 @@ final readonly class PlainTextRenderer { /** - * @param array $tests + * @param array $tests */ public function render(array $tests): string { $buffer = ''; - foreach ($tests as $prettifiedClassName => $_tests) { - $buffer .= $prettifiedClassName . "\n"; + foreach ($tests as $_tests) { + $buffer .= $_tests->asArray()[0]->test()->testDox()->prettifiedClassName() . "\n"; foreach ($this->reduce($_tests) as $prettifiedMethodName => $outcome) { $buffer .= sprintf( diff --git a/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollection.php b/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollection.php index 5c4a4d644..f27171f66 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollection.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollection.php @@ -12,7 +12,7 @@ use IteratorAggregate; /** - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate * * @immutable * diff --git a/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollectionIterator.php b/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollectionIterator.php index cf8ae7ac8..d09e66663 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollectionIterator.php @@ -9,11 +9,10 @@ */ namespace PHPUnit\Logging\TestDox; -use function count; use Iterator; /** - * @template-implements Iterator + * @template-implements Iterator * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * @@ -25,6 +24,10 @@ final class TestResultCollectionIterator implements Iterator * @var list */ private readonly array $testResults; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(TestResultCollection $testResults) @@ -39,9 +42,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->testResults); + return isset($this->testResults[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollector.php b/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollector.php index bdf03480f..a05e40ab6 100644 --- a/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollector.php +++ b/app/vendor/phpunit/phpunit/src/Logging/TestDox/TestResult/TestResultCollector.php @@ -12,7 +12,7 @@ use function array_merge; use function assert; use function is_subclass_of; -use function ksort; +use function uasort; use function uksort; use function usort; use PHPUnit\Event\Code\TestMethod; @@ -51,7 +51,7 @@ final class TestResultCollector private readonly IssueFilter $issueFilter; /** - * @var array> + * @var array> */ private array $tests = []; private ?TestStatus $status = null; @@ -66,17 +66,17 @@ public function __construct(Facade $facade, IssueFilter $issueFilter) } /** - * @return array + * @return array */ public function testMethodsGroupedByClass(): array { $result = []; - foreach ($this->tests as $prettifiedClassName => $tests) { + foreach ($this->tests as $className => $tests) { $testsByDeclaringClass = []; foreach ($tests as $test) { - $declaringClassName = (new ReflectionMethod($test->test()->className(), $test->test()->methodName()))->getDeclaringClass()->getName(); + $declaringClassName = new ReflectionMethod($test->test()->className(), $test->test()->methodName())->getDeclaringClass()->getName(); if (!isset($testsByDeclaringClass[$declaringClassName])) { $testsByDeclaringClass[$declaringClassName] = []; @@ -121,10 +121,17 @@ static function (string $a, string $b): int $tests = array_merge($tests, $_tests); } - $result[$prettifiedClassName] = TestResultCollection::fromArray($tests); + $result[$className] = TestResultCollection::fromArray($tests); } - ksort($result); + uasort( + $result, + static function (TestResultCollection $a, TestResultCollection $b): int + { + return $a->asArray()[0]->test()->testDox()->prettifiedClassName() + <=> $b->asArray()[0]->test()->testDox()->prettifiedClassName(); + }, + ); return $result; } @@ -370,11 +377,11 @@ private function updateTestStatus(TestStatus $status): void private function process(TestMethod $test): void { - if (!isset($this->tests[$test->testDox()->prettifiedClassName()])) { - $this->tests[$test->testDox()->prettifiedClassName()] = []; + if (!isset($this->tests[$test->className()])) { + $this->tests[$test->className()] = []; } - $this->tests[$test->testDox()->prettifiedClassName()][] = new TestDoxTestMethod( + $this->tests[$test->className()][] = new TestDoxTestMethod( $test, $this->status, $this->throwable, diff --git a/app/vendor/phpunit/phpunit/src/Metadata/After.php b/app/vendor/phpunit/phpunit/src/Metadata/After.php index 144136390..db5fd5a35 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/After.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/After.php @@ -18,10 +18,7 @@ { private int $priority; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, int $priority) + protected function __construct(Level $level, int $priority) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/AfterClass.php b/app/vendor/phpunit/phpunit/src/Metadata/AfterClass.php index 7dcb96fd7..1c7c39c20 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/AfterClass.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/AfterClass.php @@ -18,10 +18,7 @@ { private int $priority; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, int $priority) + protected function __construct(Level $level, int $priority) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/AllowMockObjectsWithoutExpectations.php b/app/vendor/phpunit/phpunit/src/Metadata/AllowMockObjectsWithoutExpectations.php new file mode 100644 index 000000000..cb6bbea41 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Metadata/AllowMockObjectsWithoutExpectations.php @@ -0,0 +1,23 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Metadata; + +/** + * @immutable + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +final readonly class AllowMockObjectsWithoutExpectations extends Metadata +{ + public function isAllowMockObjectsWithoutExpectations(): true + { + return true; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Api/CodeCoverage.php b/app/vendor/phpunit/phpunit/src/Metadata/Api/CodeCoverage.php index f6d0a9cec..f276623b7 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Api/CodeCoverage.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Api/CodeCoverage.php @@ -10,7 +10,6 @@ namespace PHPUnit\Metadata\Api; use function assert; -use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Framework\TestCase; use PHPUnit\Metadata\CoversClass; use PHPUnit\Metadata\CoversClassesThatExtendClass; @@ -149,20 +148,9 @@ public function usesTargets(string $className, string $methodName): TargetCollec public function shouldCodeCoverageBeCollectedFor(TestCase $test): bool { - $className = $test::class; - $methodName = $test->name(); - $parser = Registry::parser(); + $parser = Registry::parser(); - if ($parser->forMethod($className, $methodName)->isCoversNothing()->isNotEmpty()) { - EventFacade::emitter()->testTriggeredPhpunitDeprecation( - $test->valueObjectForEvents(), - 'Using #[CoversNothing] on a test method is deprecated, support for this will be removed in PHPUnit 13', - ); - - return false; - } - - if ($parser->forClass($className)->isCoversNothing()->isNotEmpty()) { + if ($parser->forClass($test::class)->isCoversNothing()->isNotEmpty()) { return false; } diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Api/DataProvider.php b/app/vendor/phpunit/phpunit/src/Metadata/Api/DataProvider.php index 718f2bcb8..da3eeecb6 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Api/DataProvider.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Api/DataProvider.php @@ -15,12 +15,15 @@ use function get_debug_type; use function is_array; use function is_int; +use function is_iterable; use function is_string; use function sprintf; use PHPUnit\Event; use PHPUnit\Event\Code\TestMethod; use PHPUnit\Framework\InvalidDataProviderException; +use PHPUnit\Framework\TestCase; use PHPUnit\Metadata\DataProvider as DataProviderMetadata; +use PHPUnit\Metadata\DataProviderClosure as DataProviderClosureMetadata; use PHPUnit\Metadata\MetadataCollection; use PHPUnit\Metadata\Parser\Registry as MetadataRegistry; use PHPUnit\Metadata\TestWith; @@ -36,8 +39,8 @@ final readonly class DataProvider { /** - * @param class-string $className - * @param non-empty-string $methodName + * @param class-string $className + * @param non-empty-string $methodName * * @throws InvalidDataProviderException * @@ -45,124 +48,65 @@ */ public function providedData(string $className, string $methodName): ?array { - $metadataCollection = MetadataRegistry::parser()->forMethod($className, $methodName); - $dataProvider = $metadataCollection->isDataProvider(); - $testWith = $metadataCollection->isTestWith(); + $metadataCollection = MetadataRegistry::parser()->forMethod($className, $methodName); + $dataProvider = $metadataCollection->isDataProvider(); + $dataProviderClosure = $metadataCollection->isDataProviderClosure(); + $testWith = $metadataCollection->isTestWith(); - if ($dataProvider->isEmpty() && $testWith->isEmpty()) { + if ($dataProvider->isEmpty() && $dataProviderClosure->isEmpty() && $testWith->isEmpty()) { return null; } - if ($dataProvider->isNotEmpty()) { - if ($testWith->isNotEmpty()) { - $method = new ReflectionMethod($className, $methodName); - - Event\Facade::emitter()->testTriggeredPhpunitWarning( - new TestMethod( - $className, - $methodName, - $method->getFileName(), - $method->getStartLine(), - Event\Code\TestDoxBuilder::fromClassNameAndMethodName( - $className, - $methodName, - ), - MetadataCollection::fromArray([]), - Event\TestData\TestDataCollection::fromArray([]), - ), - 'Mixing #[DataProvider*] and #[TestWith*] attributes is not supported, only the data provided by #[DataProvider*] will be used', - ); - } - $data = $this->dataProvidedByMethods($className, $methodName, $dataProvider); - } else { - $data = $this->dataProvidedByMetadata($testWith); - } - - if ($data === []) { - throw new InvalidDataProviderException( - 'Empty data set provided by data provider', - ); - } - - $method = new ReflectionMethod($className, $methodName); - $testMethodNumberOfParameters = $method->getNumberOfParameters(); - $testMethodIsNonVariadic = !$method->isVariadic(); - - foreach ($data as $key => $providedData) { - $value = $providedData->value(); + $testMethod = new ReflectionMethod($className, $methodName); - if (!is_array($value)) { - throw new InvalidDataProviderException( - sprintf( - 'Data set %s provided by %s is invalid, expected array but got %s', - $this->formatKey($key), - $providedData->label(), - get_debug_type($value), - ), - ); + if ($dataProvider->isNotEmpty() || $dataProviderClosure->isNotEmpty()) { + if ($testWith->isNotEmpty()) { + $this->triggerWarningForMixingOfDataProviderAndTestWith($testMethod); } - if ($testMethodIsNonVariadic && $testMethodNumberOfParameters < count($value)) { - Event\Facade::emitter()->testTriggeredPhpunitWarning( - new TestMethod( - $className, - $methodName, - $method->getFileName(), - $method->getStartLine(), - Event\Code\TestDoxBuilder::fromClassNameAndMethodName( - $className, - $methodName, - ), - MetadataCollection::fromArray([]), - Event\TestData\TestDataCollection::fromArray([]), - ), - sprintf( - 'Data set %s provided by %s has more arguments (%d) than the test method accepts (%d)', - $this->formatKey($key), - $providedData->label(), - count($value), - $testMethodNumberOfParameters, - ), - ); - } + return $this->dataProvidedByMethods($className, $testMethod, $dataProvider, $dataProviderClosure); } - return $data; + return $this->dataProvidedByMetadata($testMethod, $testWith); } /** - * @param class-string $className - * @param non-empty-string $methodName + * @param class-string $testClassName * * @throws InvalidDataProviderException * * @return array */ - private function dataProvidedByMethods(string $className, string $methodName, MetadataCollection $dataProvider): array + private function dataProvidedByMethods(string $testClassName, ReflectionMethod $testMethod, MetadataCollection $dataProvider, MetadataCollection $dataProviderClosure): array { - $testMethod = new Event\Code\ClassMethod($className, $methodName); - $methodsCalled = []; + $testMethodValueObject = new Event\Code\ClassMethod( + $testClassName, + $testMethod->getName(), + ); - /** - * @var array $result - */ - $result = []; + $methodsCalled = []; + $result = []; + $testMethodNumberOfParameters = $testMethod->getNumberOfParameters(); + $testMethodIsNonVariadic = !$testMethod->isVariadic(); foreach ($dataProvider as $_dataProvider) { assert($_dataProvider instanceof DataProviderMetadata); - $providerLabel = $_dataProvider->className() . '::' . $_dataProvider->methodName(); - $dataProviderMethod = new Event\Code\ClassMethod($_dataProvider->className(), $_dataProvider->methodName()); + $providerLabel = $_dataProvider->className() . '::' . $_dataProvider->methodName(); + $dataProviderMethod = new Event\Code\ClassMethod($_dataProvider->className(), $_dataProvider->methodName()); + $validateArgumentCount = $testMethodIsNonVariadic && $_dataProvider->validateArgumentCount(); Event\Facade::emitter()->dataProviderMethodCalled( - $testMethod, + $testMethodValueObject, $dataProviderMethod, ); $methodsCalled[] = $dataProviderMethod; try { - $method = new ReflectionMethod($_dataProvider->className(), $_dataProvider->methodName()); + $method = new ReflectionMethod($_dataProvider->className(), $_dataProvider->methodName()); + $className = $_dataProvider->className(); + $methodName = $_dataProvider->methodName(); if (Test::isTestMethod($method)) { Event\Facade::emitter()->testRunnerTriggeredPhpunitWarning( @@ -170,8 +114,8 @@ private function dataProvidedByMethods(string $className, string $methodName, Me 'Method %s::%s() used by test method %s::%s() is also a test method', $_dataProvider->className(), $_dataProvider->methodName(), - $className, - $methodName, + $testMethod->getDeclaringClass()->getName(), + $testMethod->getName(), ), ); } @@ -180,8 +124,8 @@ private function dataProvidedByMethods(string $className, string $methodName, Me throw new InvalidDataProviderException( sprintf( 'Data Provider method %s::%s() is not public', - $_dataProvider->className(), - $_dataProvider->methodName(), + $className, + $methodName, ), ); } @@ -190,8 +134,8 @@ private function dataProvidedByMethods(string $className, string $methodName, Me throw new InvalidDataProviderException( sprintf( 'Data Provider method %s::%s() is not static', - $_dataProvider->className(), - $_dataProvider->methodName(), + $className, + $methodName, ), ); } @@ -200,36 +144,72 @@ private function dataProvidedByMethods(string $className, string $methodName, Me throw new InvalidDataProviderException( sprintf( 'Data Provider method %s::%s() expects an argument', - $_dataProvider->className(), - $_dataProvider->methodName(), + $className, + $methodName, ), ); } - $className = $_dataProvider->className(); - $methodName = $_dataProvider->methodName(); - /** @phpstan-ignore staticMethod.dynamicName */ $data = $className::$methodName(); + + if (!is_iterable($data)) { + throw new InvalidDataProviderException( + sprintf( + 'Data Provider method %s::%s() does not return an iterable', + $className, + $methodName, + ), + ); + } } catch (Throwable $e) { Event\Facade::emitter()->dataProviderMethodFinished( - $testMethod, + $testMethodValueObject, ...$methodsCalled, ); throw InvalidDataProviderException::forException($e, $providerLabel); } - foreach ($data as $key => $value) { - if (is_int($key)) { - $result[] = new ProvidedData($providerLabel, $value); - } elseif (is_string($key)) { - if (array_key_exists($key, $result)) { - Event\Facade::emitter()->dataProviderMethodFinished( + try { + foreach ($data as $key => $value) { + if (!is_int($key) && !is_string($key)) { + throw new InvalidDataProviderException( + sprintf( + 'The key must be an integer or a string, %s given', + get_debug_type($key), + ), + ); + } + + if (!is_array($value)) { + throw new InvalidDataProviderException( + sprintf( + 'Data set %s provided by %s is invalid, expected array but got %s', + $this->formatKey($key), + $providerLabel, + get_debug_type($value), + ), + ); + } + + if ($validateArgumentCount && $testMethodNumberOfParameters < count($value)) { + $this->triggerWarningForArgumentCount( $testMethod, - ...$methodsCalled, + $this->formatKey($key), + $providerLabel, + count($value), + $testMethodNumberOfParameters, ); + } + + if (is_int($key)) { + $result[] = new ProvidedData($providerLabel, $value); + + continue; + } + if (array_key_exists($key, $result)) { throw new InvalidDataProviderException( sprintf( 'The key "%s" has already been defined by provider %s', @@ -240,9 +220,49 @@ private function dataProvidedByMethods(string $className, string $methodName, Me } $result[$key] = new ProvidedData($providerLabel, $value); - } else { + } + } catch (Throwable $e) { + Event\Facade::emitter()->dataProviderMethodFinished( + $testMethodValueObject, + ...$methodsCalled, + ); + + throw new InvalidDataProviderException( + $e->getMessage(), + $e->getCode(), + $e, + ); + } + } + + foreach ($dataProviderClosure as $_dataProvider) { + assert($_dataProvider instanceof DataProviderClosureMetadata); + + $providerLabel = sprintf('callable provided to %s::%s()', $testClassName, $testMethod->getName()); + $validateArgumentCount = $testMethodIsNonVariadic && $_dataProvider->validateArgumentCount(); + + try { + $callable = $_dataProvider->closure(); + $data = $callable(); + + if (!is_iterable($data)) { + throw new InvalidDataProviderException( + 'Data Provider callable does not return an iterable', + ); + } + } catch (Throwable $e) { + Event\Facade::emitter()->dataProviderMethodFinished( + $testMethodValueObject, + ...$methodsCalled, + ); + + throw InvalidDataProviderException::forException($e, $providerLabel); + } + + foreach ($data as $key => $value) { + if (!is_int($key) && !is_string($key)) { Event\Facade::emitter()->dataProviderMethodFinished( - $testMethod, + $testMethodValueObject, ...$methodsCalled, ); @@ -253,21 +273,76 @@ private function dataProvidedByMethods(string $className, string $methodName, Me ), ); } + + if (!is_array($value)) { + Event\Facade::emitter()->dataProviderMethodFinished( + $testMethodValueObject, + ...$methodsCalled, + ); + + throw new InvalidDataProviderException( + sprintf( + 'Data set %s provided by %s is invalid, expected array but got %s', + $this->formatKey($key), + $providerLabel, + get_debug_type($value), + ), + ); + } + + if ($validateArgumentCount && $testMethodNumberOfParameters < count($value)) { + $this->triggerWarningForArgumentCount( + $testMethod, + $this->formatKey($key), + $providerLabel, + count($value), + $testMethodNumberOfParameters, + ); + } + + if (is_int($key)) { + $result[] = new ProvidedData($providerLabel, $value); + + continue; + } + + if (array_key_exists($key, $result)) { + Event\Facade::emitter()->dataProviderMethodFinished( + $testMethodValueObject, + ...$methodsCalled, + ); + + throw new InvalidDataProviderException( + sprintf( + 'The key "%s" has already been defined by provider %s', + $key, + $result[$key]->label(), + ), + ); + } + + $result[$key] = new ProvidedData($providerLabel, $value); } } Event\Facade::emitter()->dataProviderMethodFinished( - $testMethod, + $testMethodValueObject, ...$methodsCalled, ); + if ($result === []) { + throw new InvalidDataProviderException( + 'Empty data set provided by data provider', + ); + } + return $result; } /** * @return array */ - private function dataProvidedByMetadata(MetadataCollection $testWith): array + private function dataProvidedByMetadata(ReflectionMethod $testMethod, MetadataCollection $testWith): array { $result = []; @@ -295,6 +370,34 @@ private function dataProvidedByMetadata(MetadataCollection $testWith): array } } + $testMethodNumberOfParameters = $testMethod->getNumberOfParameters(); + $testMethodIsNonVariadic = !$testMethod->isVariadic(); + + foreach ($result as $key => $providedData) { + $value = $providedData->value(); + + if (!is_array($value)) { + throw new InvalidDataProviderException( + sprintf( + 'Data set %s provided by %s is invalid, expected array but got %s', + $this->formatKey($key), + $providedData->label(), + get_debug_type($value), + ), + ); + } + + if ($testMethodIsNonVariadic && $testMethodNumberOfParameters < count($value)) { + $this->triggerWarningForArgumentCount( + $testMethod, + $this->formatKey($key), + $providedData->label(), + count($value), + $testMethodNumberOfParameters, + ); + } + } + return $result; } @@ -307,4 +410,42 @@ private function formatKey(int|string $key): string { return is_int($key) ? '#' . $key : '"' . $key . '"'; } + + private function triggerWarningForMixingOfDataProviderAndTestWith(ReflectionMethod $method): void + { + Event\Facade::emitter()->testTriggeredPhpunitWarning( + $this->testValueObject($method), + 'Mixing #[DataProvider*] and #[TestWith*] attributes is not supported, only the data provided by #[DataProvider*] will be used', + ); + } + + private function triggerWarningForArgumentCount(ReflectionMethod $method, string $key, string $label, int $numberOfValues, int $testMethodNumberOfParameters): void + { + Event\Facade::emitter()->testTriggeredPhpunitWarning( + $this->testValueObject($method), + sprintf( + 'Data set %s provided by %s has more arguments (%d) than the test method accepts (%d)', + $key, + $label, + $numberOfValues, + $testMethodNumberOfParameters, + ), + ); + } + + private function testValueObject(ReflectionMethod $method): TestMethod + { + return new TestMethod( + $method->getDeclaringClass()->getName(), + $method->getName(), + $method->getFileName(), + $method->getStartLine(), + Event\Code\TestDoxBuilder::fromClassNameAndMethodName( + $method->getDeclaringClass()->getName(), + $method->getName(), + ), + MetadataCollection::fromArray([]), + Event\TestData\TestDataCollection::fromArray([]), + ); + } } diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Api/Requirements.php b/app/vendor/phpunit/phpunit/src/Metadata/Api/Requirements.php index 4a6abe76f..9be97c243 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Api/Requirements.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Api/Requirements.php @@ -24,6 +24,8 @@ use function phpversion; use function preg_match; use function sprintf; +use function substr_count; +use PHPUnit\Event\Facade; use PHPUnit\Metadata\Parser\Registry; use PHPUnit\Metadata\RequiresEnvironmentVariable; use PHPUnit\Metadata\RequiresFunction; @@ -35,6 +37,8 @@ use PHPUnit\Metadata\RequiresPhpunit; use PHPUnit\Metadata\RequiresPhpunitExtension; use PHPUnit\Metadata\RequiresSetting; +use PHPUnit\Metadata\Version\ComparisonRequirement; +use PHPUnit\Metadata\Version\Requirement; use PHPUnit\Runner\Version; use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry; @@ -59,10 +63,14 @@ public function requirementsNotSatisfiedFor(string $className, string $methodNam if ($metadata->isRequiresPhp()) { assert($metadata instanceof RequiresPhp); - if (!$metadata->versionRequirement()->isSatisfiedBy(PHP_VERSION)) { + $versionRequirement = $metadata->versionRequirement(); + + $this->warnAboutIncompleteVersion($metadata->versionRequirement(), $className, $methodName); + + if (!$versionRequirement->isSatisfiedBy(PHP_VERSION)) { $notSatisfied[] = sprintf( 'PHP %s is required.', - $metadata->versionRequirement()->asString(), + $versionRequirement->asString(), ); } } @@ -76,6 +84,10 @@ public function requirementsNotSatisfiedFor(string $className, string $methodNam $extensionVersion = ''; } + if ($metadata->hasVersionRequirement()) { + $this->warnAboutIncompleteVersion($metadata->versionRequirement(), $className, $methodName); + } + if (!extension_loaded($metadata->extension()) || ($metadata->hasVersionRequirement() && !$metadata->versionRequirement()->isSatisfiedBy($extensionVersion))) { @@ -90,10 +102,14 @@ public function requirementsNotSatisfiedFor(string $className, string $methodNam if ($metadata->isRequiresPhpunit()) { assert($metadata instanceof RequiresPhpunit); - if (!$metadata->versionRequirement()->isSatisfiedBy(Version::id())) { + $versionRequirement = $metadata->versionRequirement(); + + $this->warnAboutIncompleteVersion($metadata->versionRequirement(), $className, $methodName); + + if (!$versionRequirement->isSatisfiedBy(Version::id())) { $notSatisfied[] = sprintf( 'PHPUnit %s is required.', - $metadata->versionRequirement()->asString(), + $versionRequirement->asString(), ); } } @@ -197,4 +213,41 @@ public function requirementsNotSatisfiedFor(string $className, string $methodNam return $notSatisfied; } + + public function requiresXdebug(string $className, string $methodName): bool + { + foreach (Registry::parser()->forClassAndMethod($className, $methodName) as $metadata) { + if ($metadata->isRequiresPhpExtension()) { + if ($metadata->extension() === 'xdebug') { + return true; + } + } + } + + return false; + } + + /** + * @param class-string $className + * @param non-empty-string $methodName + */ + private function warnAboutIncompleteVersion(Requirement $versionRequirement, string $className, string $methodName): void + { + if (!$versionRequirement instanceof ComparisonRequirement) { + return; + } + + if (substr_count($versionRequirement->version(), '.') === 2) { + return; + } + + Facade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Incomplete version requirement "%s" used by %s::%s()', + $versionRequirement->version(), + $className, + $methodName, + ), + ); + } } diff --git a/app/vendor/phpunit/phpunit/src/Metadata/BackupGlobals.php b/app/vendor/phpunit/phpunit/src/Metadata/BackupGlobals.php index 5d9478443..6de6686b9 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/BackupGlobals.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/BackupGlobals.php @@ -18,10 +18,7 @@ { private bool $enabled; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, bool $enabled) + protected function __construct(Level $level, bool $enabled) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/BackupStaticProperties.php b/app/vendor/phpunit/phpunit/src/Metadata/BackupStaticProperties.php index a07698eeb..1c2f1a15e 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/BackupStaticProperties.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/BackupStaticProperties.php @@ -18,10 +18,7 @@ { private bool $enabled; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, bool $enabled) + protected function __construct(Level $level, bool $enabled) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Before.php b/app/vendor/phpunit/phpunit/src/Metadata/Before.php index 08372f76c..7e4479ba1 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Before.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Before.php @@ -18,10 +18,7 @@ { private int $priority; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, int $priority) + protected function __construct(Level $level, int $priority) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/BeforeClass.php b/app/vendor/phpunit/phpunit/src/Metadata/BeforeClass.php index c56463207..89d38b4f7 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/BeforeClass.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/BeforeClass.php @@ -18,10 +18,7 @@ { private int $priority; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, int $priority) + protected function __construct(Level $level, int $priority) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/CoversClass.php b/app/vendor/phpunit/phpunit/src/Metadata/CoversClass.php index e573952b6..7551f5341 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/CoversClass.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/CoversClass.php @@ -22,10 +22,9 @@ private string $className; /** - * @param int<0, 1> $level * @param class-string $className */ - protected function __construct(int $level, string $className) + protected function __construct(Level $level, string $className) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatExtendClass.php b/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatExtendClass.php index 7feb40d70..862917b03 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatExtendClass.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatExtendClass.php @@ -22,10 +22,9 @@ private string $className; /** - * @param int<0, 1> $level * @param class-string $className */ - protected function __construct(int $level, string $className) + protected function __construct(Level $level, string $className) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatImplementInterface.php b/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatImplementInterface.php index e980801ec..1aaa66195 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatImplementInterface.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/CoversClassesThatImplementInterface.php @@ -22,10 +22,9 @@ private string $interfaceName; /** - * @param int<0, 1> $level * @param class-string $interfaceName */ - protected function __construct(int $level, string $interfaceName) + protected function __construct(Level $level, string $interfaceName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/CoversFunction.php b/app/vendor/phpunit/phpunit/src/Metadata/CoversFunction.php index 4e953601f..8a614371c 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/CoversFunction.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/CoversFunction.php @@ -22,10 +22,9 @@ private string $functionName; /** - * @param int<0, 1> $level * @param non-empty-string $functionName */ - protected function __construct(int $level, string $functionName) + protected function __construct(Level $level, string $functionName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/CoversMethod.php b/app/vendor/phpunit/phpunit/src/Metadata/CoversMethod.php index 73092ff78..95d9aa801 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/CoversMethod.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/CoversMethod.php @@ -27,11 +27,10 @@ private string $methodName; /** - * @param int<0, 1> $level * @param class-string $className * @param non-empty-string $methodName */ - protected function __construct(int $level, string $className, string $methodName) + protected function __construct(Level $level, string $className, string $methodName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/CoversNamespace.php b/app/vendor/phpunit/phpunit/src/Metadata/CoversNamespace.php index ef7452a66..0bfd464db 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/CoversNamespace.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/CoversNamespace.php @@ -22,10 +22,9 @@ private string $namespace; /** - * @param int<0, 1> $level * @param non-empty-string $namespace */ - protected function __construct(int $level, string $namespace) + protected function __construct(Level $level, string $namespace) { parent::__construct($level); @@ -38,7 +37,7 @@ public function isCoversNamespace(): true } /** - * @return class-string + * @return non-empty-string */ public function namespace(): string { diff --git a/app/vendor/phpunit/phpunit/src/Metadata/CoversTrait.php b/app/vendor/phpunit/phpunit/src/Metadata/CoversTrait.php index 2cad9dfb4..f8daf56cd 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/CoversTrait.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/CoversTrait.php @@ -22,10 +22,9 @@ private string $traitName; /** - * @param 0|1 $level * @param trait-string $traitName */ - protected function __construct(int $level, string $traitName) + protected function __construct(Level $level, string $traitName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/DataProvider.php b/app/vendor/phpunit/phpunit/src/Metadata/DataProvider.php index 57b821e48..e3a31d78d 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/DataProvider.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/DataProvider.php @@ -25,18 +25,19 @@ * @var non-empty-string */ private string $methodName; + private bool $validateArgumentCount; /** - * @param int<0, 1> $level * @param class-string $className * @param non-empty-string $methodName */ - protected function __construct(int $level, string $className, string $methodName) + protected function __construct(Level $level, string $className, string $methodName, bool $validateArgumentCount) { parent::__construct($level); - $this->className = $className; - $this->methodName = $methodName; + $this->className = $className; + $this->methodName = $methodName; + $this->validateArgumentCount = $validateArgumentCount; } public function isDataProvider(): true @@ -59,4 +60,9 @@ public function methodName(): string { return $this->methodName; } + + public function validateArgumentCount(): bool + { + return $this->validateArgumentCount; + } } diff --git a/app/vendor/phpunit/phpunit/src/Metadata/DataProviderClosure.php b/app/vendor/phpunit/phpunit/src/Metadata/DataProviderClosure.php new file mode 100644 index 000000000..4b7a39a66 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Metadata/DataProviderClosure.php @@ -0,0 +1,46 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Metadata; + +use Closure; + +/** + * @immutable + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +final readonly class DataProviderClosure extends Metadata +{ + private Closure $closure; + private bool $validateArgumentCount; + + protected function __construct(Level $level, Closure $closure, bool $validateArgumentCount) + { + parent::__construct($level); + + $this->closure = $closure; + $this->validateArgumentCount = $validateArgumentCount; + } + + public function isDataProviderClosure(): true + { + return true; + } + + public function closure(): Closure + { + return $this->closure; + } + + public function validateArgumentCount(): bool + { + return $this->validateArgumentCount; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Metadata/DependsOnClass.php b/app/vendor/phpunit/phpunit/src/Metadata/DependsOnClass.php index fbc40fd14..0f2f15d8e 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/DependsOnClass.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/DependsOnClass.php @@ -24,10 +24,9 @@ private bool $shallowClone; /** - * @param int<0, 1> $level * @param class-string $className */ - protected function __construct(int $level, string $className, bool $deepClone, bool $shallowClone) + protected function __construct(Level $level, string $className, bool $deepClone, bool $shallowClone) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/DependsOnMethod.php b/app/vendor/phpunit/phpunit/src/Metadata/DependsOnMethod.php index 82056a996..020d33bd5 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/DependsOnMethod.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/DependsOnMethod.php @@ -29,11 +29,10 @@ private bool $shallowClone; /** - * @param int<0, 1> $level * @param class-string $className * @param non-empty-string $methodName */ - protected function __construct(int $level, string $className, string $methodName, bool $deepClone, bool $shallowClone) + protected function __construct(Level $level, string $className, string $methodName, bool $deepClone, bool $shallowClone) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/ExcludeGlobalVariableFromBackup.php b/app/vendor/phpunit/phpunit/src/Metadata/ExcludeGlobalVariableFromBackup.php index 4f646dbde..9bd188891 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/ExcludeGlobalVariableFromBackup.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/ExcludeGlobalVariableFromBackup.php @@ -22,10 +22,9 @@ private string $globalVariableName; /** - * @param int<0, 1> $level * @param non-empty-string $globalVariableName */ - protected function __construct(int $level, string $globalVariableName) + protected function __construct(Level $level, string $globalVariableName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/ExcludeStaticPropertyFromBackup.php b/app/vendor/phpunit/phpunit/src/Metadata/ExcludeStaticPropertyFromBackup.php index 21725e939..f1405c52b 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/ExcludeStaticPropertyFromBackup.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/ExcludeStaticPropertyFromBackup.php @@ -27,11 +27,10 @@ private string $propertyName; /** - * @param int<0, 1> $level * @param class-string $className * @param non-empty-string $propertyName */ - protected function __construct(int $level, string $className, string $propertyName) + protected function __construct(Level $level, string $className, string $propertyName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Group.php b/app/vendor/phpunit/phpunit/src/Metadata/Group.php index 2ee2784f2..d67e8ca6e 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Group.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Group.php @@ -22,10 +22,9 @@ private string $groupName; /** - * @param int<0, 1> $level * @param non-empty-string $groupName */ - protected function __construct(int $level, string $groupName) + protected function __construct(Level $level, string $groupName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/IgnoreDeprecations.php b/app/vendor/phpunit/phpunit/src/Metadata/IgnoreDeprecations.php index e1f85a8d8..8606485f3 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/IgnoreDeprecations.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/IgnoreDeprecations.php @@ -16,8 +16,29 @@ */ final readonly class IgnoreDeprecations extends Metadata { + /** @var null|non-empty-string */ + private ?string $messagePattern; + + /** + * @param null|non-empty-string $messagePattern + */ + protected function __construct(Level $level, null|string $messagePattern) + { + parent::__construct($level); + + $this->messagePattern = $messagePattern; + } + public function isIgnoreDeprecations(): true { return true; } + + /** + * @return null|non-empty-string + */ + public function messagePattern(): ?string + { + return $this->messagePattern; + } } diff --git a/app/vendor/phpunit/phpunit/src/Metadata/IgnorePhpunitWarnings.php b/app/vendor/phpunit/phpunit/src/Metadata/IgnorePhpunitWarnings.php index bf50c98e7..c6eee7264 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/IgnorePhpunitWarnings.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/IgnorePhpunitWarnings.php @@ -9,8 +9,6 @@ */ namespace PHPUnit\Metadata; -use function preg_match; - /** * @immutable * @@ -22,10 +20,9 @@ private ?string $messagePattern; /** - * @param int<0, 1> $level * @param null|non-empty-string $messagePattern */ - protected function __construct(int $level, null|string $messagePattern) + protected function __construct(Level $level, null|string $messagePattern) { parent::__construct($level); @@ -37,9 +34,11 @@ public function isIgnorePhpunitWarnings(): true return true; } - public function shouldIgnore(string $message): bool + /** + * @return null|non-empty-string + */ + public function messagePattern(): ?string { - return $this->messagePattern === null || - (bool) preg_match('{' . $this->messagePattern . '}', $message); + return $this->messagePattern; } } diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Level.php b/app/vendor/phpunit/phpunit/src/Metadata/Level.php new file mode 100644 index 000000000..29e879665 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Metadata/Level.php @@ -0,0 +1,19 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Metadata; + +/** + * @internal This enumeration is not covered by the backward compatibility promise for PHPUnit + */ +enum Level +{ + case CLASS_LEVEL; + case METHOD_LEVEL; +} diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Metadata.php b/app/vendor/phpunit/phpunit/src/Metadata/Metadata.php index 72851d865..6bf65eaab 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Metadata.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Metadata.php @@ -9,6 +9,7 @@ */ namespace PHPUnit\Metadata; +use Closure; use PHPUnit\Metadata\Version\Requirement; use PHPUnit\Runner\Extension\Extension; @@ -19,52 +20,56 @@ */ abstract readonly class Metadata { - private const int CLASS_LEVEL = 0; - private const int METHOD_LEVEL = 1; - - /** - * @var int<0, 1> - */ - private int $level; + private Level $level; public static function after(int $priority): After { - return new After(self::METHOD_LEVEL, $priority); + return new After(Level::METHOD_LEVEL, $priority); } public static function afterClass(int $priority): AfterClass { - return new AfterClass(self::METHOD_LEVEL, $priority); + return new AfterClass(Level::METHOD_LEVEL, $priority); + } + + public static function allowMockObjectsWithoutExpectationsOnClass(): AllowMockObjectsWithoutExpectations + { + return new AllowMockObjectsWithoutExpectations(Level::CLASS_LEVEL); + } + + public static function allowMockObjectsWithoutExpectationsOnMethod(): AllowMockObjectsWithoutExpectations + { + return new AllowMockObjectsWithoutExpectations(Level::METHOD_LEVEL); } public static function backupGlobalsOnClass(bool $enabled): BackupGlobals { - return new BackupGlobals(self::CLASS_LEVEL, $enabled); + return new BackupGlobals(Level::CLASS_LEVEL, $enabled); } public static function backupGlobalsOnMethod(bool $enabled): BackupGlobals { - return new BackupGlobals(self::METHOD_LEVEL, $enabled); + return new BackupGlobals(Level::METHOD_LEVEL, $enabled); } public static function backupStaticPropertiesOnClass(bool $enabled): BackupStaticProperties { - return new BackupStaticProperties(self::CLASS_LEVEL, $enabled); + return new BackupStaticProperties(Level::CLASS_LEVEL, $enabled); } public static function backupStaticPropertiesOnMethod(bool $enabled): BackupStaticProperties { - return new BackupStaticProperties(self::METHOD_LEVEL, $enabled); + return new BackupStaticProperties(Level::METHOD_LEVEL, $enabled); } public static function before(int $priority): Before { - return new Before(self::METHOD_LEVEL, $priority); + return new Before(Level::METHOD_LEVEL, $priority); } public static function beforeClass(int $priority): BeforeClass { - return new BeforeClass(self::METHOD_LEVEL, $priority); + return new BeforeClass(Level::METHOD_LEVEL, $priority); } /** @@ -72,7 +77,7 @@ public static function beforeClass(int $priority): BeforeClass */ public static function coversNamespace(string $namespace): CoversNamespace { - return new CoversNamespace(self::CLASS_LEVEL, $namespace); + return new CoversNamespace(Level::CLASS_LEVEL, $namespace); } /** @@ -80,7 +85,7 @@ public static function coversNamespace(string $namespace): CoversNamespace */ public static function coversClass(string $className): CoversClass { - return new CoversClass(self::CLASS_LEVEL, $className); + return new CoversClass(Level::CLASS_LEVEL, $className); } /** @@ -88,7 +93,7 @@ public static function coversClass(string $className): CoversClass */ public static function coversClassesThatExtendClass(string $className): CoversClassesThatExtendClass { - return new CoversClassesThatExtendClass(self::CLASS_LEVEL, $className); + return new CoversClassesThatExtendClass(Level::CLASS_LEVEL, $className); } /** @@ -96,7 +101,7 @@ public static function coversClassesThatExtendClass(string $className): CoversCl */ public static function coversClassesThatImplementInterface(string $interfaceName): CoversClassesThatImplementInterface { - return new CoversClassesThatImplementInterface(self::CLASS_LEVEL, $interfaceName); + return new CoversClassesThatImplementInterface(Level::CLASS_LEVEL, $interfaceName); } /** @@ -104,7 +109,7 @@ public static function coversClassesThatImplementInterface(string $interfaceName */ public static function coversTrait(string $traitName): CoversTrait { - return new CoversTrait(self::CLASS_LEVEL, $traitName); + return new CoversTrait(Level::CLASS_LEVEL, $traitName); } /** @@ -113,7 +118,7 @@ public static function coversTrait(string $traitName): CoversTrait */ public static function coversMethod(string $className, string $methodName): CoversMethod { - return new CoversMethod(self::CLASS_LEVEL, $className, $methodName); + return new CoversMethod(Level::CLASS_LEVEL, $className, $methodName); } /** @@ -121,26 +126,31 @@ public static function coversMethod(string $className, string $methodName): Cove */ public static function coversFunction(string $functionName): CoversFunction { - return new CoversFunction(self::CLASS_LEVEL, $functionName); + return new CoversFunction(Level::CLASS_LEVEL, $functionName); } public static function coversNothingOnClass(): CoversNothing { - return new CoversNothing(self::CLASS_LEVEL); + return new CoversNothing(Level::CLASS_LEVEL); } public static function coversNothingOnMethod(): CoversNothing { - return new CoversNothing(self::METHOD_LEVEL); + return new CoversNothing(Level::METHOD_LEVEL); } /** * @param class-string $className * @param non-empty-string $methodName */ - public static function dataProvider(string $className, string $methodName): DataProvider + public static function dataProvider(string $className, string $methodName, bool $validateArgumentCount): DataProvider { - return new DataProvider(self::METHOD_LEVEL, $className, $methodName); + return new DataProvider(Level::METHOD_LEVEL, $className, $methodName, $validateArgumentCount); + } + + public static function dataProviderClosure(Closure $callable, bool $validateArgumentCount): DataProviderClosure + { + return new DataProviderClosure(Level::METHOD_LEVEL, $callable, $validateArgumentCount); } /** @@ -148,7 +158,7 @@ public static function dataProvider(string $className, string $methodName): Data */ public static function dependsOnClass(string $className, bool $deepClone, bool $shallowClone): DependsOnClass { - return new DependsOnClass(self::METHOD_LEVEL, $className, $deepClone, $shallowClone); + return new DependsOnClass(Level::METHOD_LEVEL, $className, $deepClone, $shallowClone); } /** @@ -157,22 +167,22 @@ public static function dependsOnClass(string $className, bool $deepClone, bool $ */ public static function dependsOnMethod(string $className, string $methodName, bool $deepClone, bool $shallowClone): DependsOnMethod { - return new DependsOnMethod(self::METHOD_LEVEL, $className, $methodName, $deepClone, $shallowClone); + return new DependsOnMethod(Level::METHOD_LEVEL, $className, $methodName, $deepClone, $shallowClone); } public static function disableReturnValueGenerationForTestDoubles(): DisableReturnValueGenerationForTestDoubles { - return new DisableReturnValueGenerationForTestDoubles(self::CLASS_LEVEL); + return new DisableReturnValueGenerationForTestDoubles(Level::CLASS_LEVEL); } public static function doesNotPerformAssertionsOnClass(): DoesNotPerformAssertions { - return new DoesNotPerformAssertions(self::CLASS_LEVEL); + return new DoesNotPerformAssertions(Level::CLASS_LEVEL); } public static function doesNotPerformAssertionsOnMethod(): DoesNotPerformAssertions { - return new DoesNotPerformAssertions(self::METHOD_LEVEL); + return new DoesNotPerformAssertions(Level::METHOD_LEVEL); } /** @@ -180,7 +190,7 @@ public static function doesNotPerformAssertionsOnMethod(): DoesNotPerformAsserti */ public static function excludeGlobalVariableFromBackupOnClass(string $globalVariableName): ExcludeGlobalVariableFromBackup { - return new ExcludeGlobalVariableFromBackup(self::CLASS_LEVEL, $globalVariableName); + return new ExcludeGlobalVariableFromBackup(Level::CLASS_LEVEL, $globalVariableName); } /** @@ -188,7 +198,7 @@ public static function excludeGlobalVariableFromBackupOnClass(string $globalVari */ public static function excludeGlobalVariableFromBackupOnMethod(string $globalVariableName): ExcludeGlobalVariableFromBackup { - return new ExcludeGlobalVariableFromBackup(self::METHOD_LEVEL, $globalVariableName); + return new ExcludeGlobalVariableFromBackup(Level::METHOD_LEVEL, $globalVariableName); } /** @@ -197,7 +207,7 @@ public static function excludeGlobalVariableFromBackupOnMethod(string $globalVar */ public static function excludeStaticPropertyFromBackupOnClass(string $className, string $propertyName): ExcludeStaticPropertyFromBackup { - return new ExcludeStaticPropertyFromBackup(self::CLASS_LEVEL, $className, $propertyName); + return new ExcludeStaticPropertyFromBackup(Level::CLASS_LEVEL, $className, $propertyName); } /** @@ -206,7 +216,7 @@ public static function excludeStaticPropertyFromBackupOnClass(string $className, */ public static function excludeStaticPropertyFromBackupOnMethod(string $className, string $propertyName): ExcludeStaticPropertyFromBackup { - return new ExcludeStaticPropertyFromBackup(self::METHOD_LEVEL, $className, $propertyName); + return new ExcludeStaticPropertyFromBackup(Level::METHOD_LEVEL, $className, $propertyName); } /** @@ -214,7 +224,7 @@ public static function excludeStaticPropertyFromBackupOnMethod(string $className */ public static function groupOnClass(string $groupName): Group { - return new Group(self::CLASS_LEVEL, $groupName); + return new Group(Level::CLASS_LEVEL, $groupName); } /** @@ -222,17 +232,23 @@ public static function groupOnClass(string $groupName): Group */ public static function groupOnMethod(string $groupName): Group { - return new Group(self::METHOD_LEVEL, $groupName); + return new Group(Level::METHOD_LEVEL, $groupName); } - public static function ignoreDeprecationsOnClass(): IgnoreDeprecations + /** + * @param null|non-empty-string $messagePattern + */ + public static function ignoreDeprecationsOnClass(?string $messagePattern = null): IgnoreDeprecations { - return new IgnoreDeprecations(self::CLASS_LEVEL); + return new IgnoreDeprecations(Level::CLASS_LEVEL, $messagePattern); } - public static function ignoreDeprecationsOnMethod(): IgnoreDeprecations + /** + * @param null|non-empty-string $messagePattern + */ + public static function ignoreDeprecationsOnMethod(?string $messagePattern = null): IgnoreDeprecations { - return new IgnoreDeprecations(self::METHOD_LEVEL); + return new IgnoreDeprecations(Level::METHOD_LEVEL, $messagePattern); } /** @@ -240,7 +256,7 @@ public static function ignoreDeprecationsOnMethod(): IgnoreDeprecations */ public static function ignorePhpunitDeprecationsOnClass(): IgnorePhpunitDeprecations { - return new IgnorePhpunitDeprecations(self::CLASS_LEVEL); + return new IgnorePhpunitDeprecations(Level::CLASS_LEVEL); } /** @@ -248,27 +264,27 @@ public static function ignorePhpunitDeprecationsOnClass(): IgnorePhpunitDeprecat */ public static function ignorePhpunitDeprecationsOnMethod(): IgnorePhpunitDeprecations { - return new IgnorePhpunitDeprecations(self::METHOD_LEVEL); + return new IgnorePhpunitDeprecations(Level::METHOD_LEVEL); } public static function postCondition(int $priority): PostCondition { - return new PostCondition(self::METHOD_LEVEL, $priority); + return new PostCondition(Level::METHOD_LEVEL, $priority); } public static function preCondition(int $priority): PreCondition { - return new PreCondition(self::METHOD_LEVEL, $priority); + return new PreCondition(Level::METHOD_LEVEL, $priority); } public static function preserveGlobalStateOnClass(bool $enabled): PreserveGlobalState { - return new PreserveGlobalState(self::CLASS_LEVEL, $enabled); + return new PreserveGlobalState(Level::CLASS_LEVEL, $enabled); } public static function preserveGlobalStateOnMethod(bool $enabled): PreserveGlobalState { - return new PreserveGlobalState(self::METHOD_LEVEL, $enabled); + return new PreserveGlobalState(Level::METHOD_LEVEL, $enabled); } /** @@ -276,7 +292,7 @@ public static function preserveGlobalStateOnMethod(bool $enabled): PreserveGloba */ public static function requiresFunctionOnClass(string $functionName): RequiresFunction { - return new RequiresFunction(self::CLASS_LEVEL, $functionName); + return new RequiresFunction(Level::CLASS_LEVEL, $functionName); } /** @@ -284,7 +300,7 @@ public static function requiresFunctionOnClass(string $functionName): RequiresFu */ public static function requiresFunctionOnMethod(string $functionName): RequiresFunction { - return new RequiresFunction(self::METHOD_LEVEL, $functionName); + return new RequiresFunction(Level::METHOD_LEVEL, $functionName); } /** @@ -293,7 +309,7 @@ public static function requiresFunctionOnMethod(string $functionName): RequiresF */ public static function requiresMethodOnClass(string $className, string $methodName): RequiresMethod { - return new RequiresMethod(self::CLASS_LEVEL, $className, $methodName); + return new RequiresMethod(Level::CLASS_LEVEL, $className, $methodName); } /** @@ -302,7 +318,7 @@ public static function requiresMethodOnClass(string $className, string $methodNa */ public static function requiresMethodOnMethod(string $className, string $methodName): RequiresMethod { - return new RequiresMethod(self::METHOD_LEVEL, $className, $methodName); + return new RequiresMethod(Level::METHOD_LEVEL, $className, $methodName); } /** @@ -310,7 +326,7 @@ public static function requiresMethodOnMethod(string $className, string $methodN */ public static function requiresOperatingSystemOnClass(string $operatingSystem): RequiresOperatingSystem { - return new RequiresOperatingSystem(self::CLASS_LEVEL, $operatingSystem); + return new RequiresOperatingSystem(Level::CLASS_LEVEL, $operatingSystem); } /** @@ -318,7 +334,7 @@ public static function requiresOperatingSystemOnClass(string $operatingSystem): */ public static function requiresOperatingSystemOnMethod(string $operatingSystem): RequiresOperatingSystem { - return new RequiresOperatingSystem(self::METHOD_LEVEL, $operatingSystem); + return new RequiresOperatingSystem(Level::METHOD_LEVEL, $operatingSystem); } /** @@ -326,7 +342,7 @@ public static function requiresOperatingSystemOnMethod(string $operatingSystem): */ public static function requiresOperatingSystemFamilyOnClass(string $operatingSystemFamily): RequiresOperatingSystemFamily { - return new RequiresOperatingSystemFamily(self::CLASS_LEVEL, $operatingSystemFamily); + return new RequiresOperatingSystemFamily(Level::CLASS_LEVEL, $operatingSystemFamily); } /** @@ -334,17 +350,17 @@ public static function requiresOperatingSystemFamilyOnClass(string $operatingSys */ public static function requiresOperatingSystemFamilyOnMethod(string $operatingSystemFamily): RequiresOperatingSystemFamily { - return new RequiresOperatingSystemFamily(self::METHOD_LEVEL, $operatingSystemFamily); + return new RequiresOperatingSystemFamily(Level::METHOD_LEVEL, $operatingSystemFamily); } public static function requiresPhpOnClass(Requirement $versionRequirement): RequiresPhp { - return new RequiresPhp(self::CLASS_LEVEL, $versionRequirement); + return new RequiresPhp(Level::CLASS_LEVEL, $versionRequirement); } public static function requiresPhpOnMethod(Requirement $versionRequirement): RequiresPhp { - return new RequiresPhp(self::METHOD_LEVEL, $versionRequirement); + return new RequiresPhp(Level::METHOD_LEVEL, $versionRequirement); } /** @@ -352,7 +368,7 @@ public static function requiresPhpOnMethod(Requirement $versionRequirement): Req */ public static function requiresPhpExtensionOnClass(string $extension, ?Requirement $versionRequirement): RequiresPhpExtension { - return new RequiresPhpExtension(self::CLASS_LEVEL, $extension, $versionRequirement); + return new RequiresPhpExtension(Level::CLASS_LEVEL, $extension, $versionRequirement); } /** @@ -360,17 +376,17 @@ public static function requiresPhpExtensionOnClass(string $extension, ?Requireme */ public static function requiresPhpExtensionOnMethod(string $extension, ?Requirement $versionRequirement): RequiresPhpExtension { - return new RequiresPhpExtension(self::METHOD_LEVEL, $extension, $versionRequirement); + return new RequiresPhpExtension(Level::METHOD_LEVEL, $extension, $versionRequirement); } public static function requiresPhpunitOnClass(Requirement $versionRequirement): RequiresPhpunit { - return new RequiresPhpunit(self::CLASS_LEVEL, $versionRequirement); + return new RequiresPhpunit(Level::CLASS_LEVEL, $versionRequirement); } public static function requiresPhpunitOnMethod(Requirement $versionRequirement): RequiresPhpunit { - return new RequiresPhpunit(self::METHOD_LEVEL, $versionRequirement); + return new RequiresPhpunit(Level::METHOD_LEVEL, $versionRequirement); } /** @@ -378,7 +394,7 @@ public static function requiresPhpunitOnMethod(Requirement $versionRequirement): */ public static function requiresPhpunitExtensionOnClass(string $extensionClass): RequiresPhpunitExtension { - return new RequiresPhpunitExtension(self::CLASS_LEVEL, $extensionClass); + return new RequiresPhpunitExtension(Level::CLASS_LEVEL, $extensionClass); } /** @@ -386,27 +402,27 @@ public static function requiresPhpunitExtensionOnClass(string $extensionClass): */ public static function requiresPhpunitExtensionOnMethod(string $extensionClass): RequiresPhpunitExtension { - return new RequiresPhpunitExtension(self::METHOD_LEVEL, $extensionClass); + return new RequiresPhpunitExtension(Level::METHOD_LEVEL, $extensionClass); } public static function requiresEnvironmentVariableOnClass(string $environmentVariableName, null|string $value): RequiresEnvironmentVariable { - return new RequiresEnvironmentVariable(self::CLASS_LEVEL, $environmentVariableName, $value); + return new RequiresEnvironmentVariable(Level::CLASS_LEVEL, $environmentVariableName, $value); } public static function requiresEnvironmentVariableOnMethod(string $environmentVariableName, null|string $value): RequiresEnvironmentVariable { - return new RequiresEnvironmentVariable(self::METHOD_LEVEL, $environmentVariableName, $value); + return new RequiresEnvironmentVariable(Level::METHOD_LEVEL, $environmentVariableName, $value); } public static function withEnvironmentVariableOnClass(string $environmentVariableName, null|string $value): WithEnvironmentVariable { - return new WithEnvironmentVariable(self::CLASS_LEVEL, $environmentVariableName, $value); + return new WithEnvironmentVariable(Level::CLASS_LEVEL, $environmentVariableName, $value); } public static function withEnvironmentVariableOnMethod(string $environmentVariableName, null|string $value): WithEnvironmentVariable { - return new WithEnvironmentVariable(self::METHOD_LEVEL, $environmentVariableName, $value); + return new WithEnvironmentVariable(Level::METHOD_LEVEL, $environmentVariableName, $value); } /** @@ -415,7 +431,7 @@ public static function withEnvironmentVariableOnMethod(string $environmentVariab */ public static function requiresSettingOnClass(string $setting, string $value): RequiresSetting { - return new RequiresSetting(self::CLASS_LEVEL, $setting, $value); + return new RequiresSetting(Level::CLASS_LEVEL, $setting, $value); } /** @@ -424,27 +440,22 @@ public static function requiresSettingOnClass(string $setting, string $value): R */ public static function requiresSettingOnMethod(string $setting, string $value): RequiresSetting { - return new RequiresSetting(self::METHOD_LEVEL, $setting, $value); - } - - public static function runClassInSeparateProcess(): RunClassInSeparateProcess - { - return new RunClassInSeparateProcess(self::CLASS_LEVEL); + return new RequiresSetting(Level::METHOD_LEVEL, $setting, $value); } public static function runTestsInSeparateProcesses(): RunTestsInSeparateProcesses { - return new RunTestsInSeparateProcesses(self::CLASS_LEVEL); + return new RunTestsInSeparateProcesses(Level::CLASS_LEVEL); } public static function runInSeparateProcess(): RunInSeparateProcess { - return new RunInSeparateProcess(self::METHOD_LEVEL); + return new RunInSeparateProcess(Level::METHOD_LEVEL); } public static function test(): Test { - return new Test(self::METHOD_LEVEL); + return new Test(Level::METHOD_LEVEL); } /** @@ -452,7 +463,7 @@ public static function test(): Test */ public static function testDoxOnClass(string $text): TestDox { - return new TestDox(self::CLASS_LEVEL, $text); + return new TestDox(Level::CLASS_LEVEL, $text); } /** @@ -460,7 +471,7 @@ public static function testDoxOnClass(string $text): TestDox */ public static function testDoxOnMethod(string $text): TestDox { - return new TestDox(self::METHOD_LEVEL, $text); + return new TestDox(Level::METHOD_LEVEL, $text); } /** @@ -469,7 +480,7 @@ public static function testDoxOnMethod(string $text): TestDox */ public static function testDoxFormatter(string $className, string $methodName): TestDoxFormatter { - return new TestDoxFormatter(self::METHOD_LEVEL, $className, $methodName); + return new TestDoxFormatter(Level::METHOD_LEVEL, $className, $methodName); } /** @@ -477,7 +488,7 @@ public static function testDoxFormatter(string $className, string $methodName): */ public static function testWith(mixed $data, ?string $name = null): TestWith { - return new TestWith(self::METHOD_LEVEL, $data, $name); + return new TestWith(Level::METHOD_LEVEL, $data, $name); } /** @@ -485,7 +496,7 @@ public static function testWith(mixed $data, ?string $name = null): TestWith */ public static function usesNamespace(string $namespace): UsesNamespace { - return new UsesNamespace(self::CLASS_LEVEL, $namespace); + return new UsesNamespace(Level::CLASS_LEVEL, $namespace); } /** @@ -493,7 +504,7 @@ public static function usesNamespace(string $namespace): UsesNamespace */ public static function usesClass(string $className): UsesClass { - return new UsesClass(self::CLASS_LEVEL, $className); + return new UsesClass(Level::CLASS_LEVEL, $className); } /** @@ -501,7 +512,7 @@ public static function usesClass(string $className): UsesClass */ public static function usesClassesThatExtendClass(string $className): UsesClassesThatExtendClass { - return new UsesClassesThatExtendClass(self::CLASS_LEVEL, $className); + return new UsesClassesThatExtendClass(Level::CLASS_LEVEL, $className); } /** @@ -509,7 +520,7 @@ public static function usesClassesThatExtendClass(string $className): UsesClasse */ public static function usesClassesThatImplementInterface(string $interfaceName): UsesClassesThatImplementInterface { - return new UsesClassesThatImplementInterface(self::CLASS_LEVEL, $interfaceName); + return new UsesClassesThatImplementInterface(Level::CLASS_LEVEL, $interfaceName); } /** @@ -517,7 +528,7 @@ public static function usesClassesThatImplementInterface(string $interfaceName): */ public static function usesTrait(string $traitName): UsesTrait { - return new UsesTrait(self::CLASS_LEVEL, $traitName); + return new UsesTrait(Level::CLASS_LEVEL, $traitName); } /** @@ -525,7 +536,7 @@ public static function usesTrait(string $traitName): UsesTrait */ public static function usesFunction(string $functionName): UsesFunction { - return new UsesFunction(self::CLASS_LEVEL, $functionName); + return new UsesFunction(Level::CLASS_LEVEL, $functionName); } /** @@ -534,12 +545,12 @@ public static function usesFunction(string $functionName): UsesFunction */ public static function usesMethod(string $className, string $methodName): UsesMethod { - return new UsesMethod(self::CLASS_LEVEL, $className, $methodName); + return new UsesMethod(Level::CLASS_LEVEL, $className, $methodName); } public static function withoutErrorHandler(): WithoutErrorHandler { - return new WithoutErrorHandler(self::METHOD_LEVEL); + return new WithoutErrorHandler(Level::METHOD_LEVEL); } /** @@ -547,25 +558,22 @@ public static function withoutErrorHandler(): WithoutErrorHandler */ public static function ignorePhpunitWarnings(?string $messagePattern): IgnorePhpunitWarnings { - return new IgnorePhpunitWarnings(self::METHOD_LEVEL, $messagePattern); + return new IgnorePhpunitWarnings(Level::METHOD_LEVEL, $messagePattern); } - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level) + protected function __construct(Level $level) { $this->level = $level; } public function isClassLevel(): bool { - return $this->level === self::CLASS_LEVEL; + return $this->level === Level::CLASS_LEVEL; } public function isMethodLevel(): bool { - return $this->level === self::METHOD_LEVEL; + return $this->level === Level::METHOD_LEVEL; } /** @@ -584,6 +592,14 @@ public function isAfterClass(): bool return false; } + /** + * @phpstan-assert-if-true AllowMockObjectsWithoutExpectations $this + */ + public function isAllowMockObjectsWithoutExpectations(): bool + { + return false; + } + /** * @phpstan-assert-if-true BackupGlobals $this */ @@ -688,6 +704,14 @@ public function isDataProvider(): bool return false; } + /** + * @phpstan-assert-if-true DataProviderClosure $this + */ + public function isDataProviderClosure(): bool + { + return false; + } + /** * @phpstan-assert-if-true DependsOnClass $this */ @@ -762,14 +786,6 @@ public function isIgnorePhpunitDeprecations(): bool return false; } - /** - * @phpstan-assert-if-true RunClassInSeparateProcess $this - */ - public function isRunClassInSeparateProcess(): bool - { - return false; - } - /** * @phpstan-assert-if-true RunInSeparateProcess $this */ diff --git a/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollection.php b/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollection.php index 621e7b86d..975d5af6b 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollection.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollection.php @@ -16,7 +16,7 @@ use IteratorAggregate; /** - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate * * @immutable * @@ -128,6 +128,16 @@ public function isAfterClass(): self ); } + public function isAllowMockObjectsWithoutExpectations(): self + { + return new self( + ...array_filter( + $this->metadata, + static fn (Metadata $metadata): bool => $metadata->isAllowMockObjectsWithoutExpectations(), + ), + ); + } + public function isBackupGlobals(): self { return new self( @@ -278,6 +288,16 @@ public function isDataProvider(): self ); } + public function isDataProviderClosure(): self + { + return new self( + ...array_filter( + $this->metadata, + static fn (Metadata $metadata): bool => $metadata->isDataProviderClosure(), + ), + ); + } + public function isDepends(): self { return new self( @@ -371,16 +391,6 @@ public function isIgnorePhpunitWarnings(): self ); } - public function isRunClassInSeparateProcess(): self - { - return new self( - ...array_filter( - $this->metadata, - static fn (Metadata $metadata): bool => $metadata->isRunClassInSeparateProcess(), - ), - ); - } - public function isRunInSeparateProcess(): self { return new self( diff --git a/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollectionIterator.php b/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollectionIterator.php index bfe398999..c1b20e469 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/MetadataCollectionIterator.php @@ -9,11 +9,10 @@ */ namespace PHPUnit\Metadata; -use function count; use Iterator; /** - * @template-implements Iterator + * @template-implements Iterator * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ @@ -23,6 +22,10 @@ final class MetadataCollectionIterator implements Iterator * @var list */ private readonly array $metadata; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(MetadataCollection $metadata) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->metadata); + return isset($this->metadata[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Parser/AttributeParser.php b/app/vendor/phpunit/phpunit/src/Metadata/Parser/AttributeParser.php index d95cab77f..5603f9d54 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Parser/AttributeParser.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Parser/AttributeParser.php @@ -12,6 +12,7 @@ use const JSON_THROW_ON_ERROR; use function assert; use function class_exists; +use function is_numeric; use function json_decode; use function method_exists; use function sprintf; @@ -22,6 +23,7 @@ use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Framework\Attributes\After; use PHPUnit\Framework\Attributes\AfterClass; +use PHPUnit\Framework\Attributes\AllowMockObjectsWithoutExpectations; use PHPUnit\Framework\Attributes\BackupGlobals; use PHPUnit\Framework\Attributes\BackupStaticProperties; use PHPUnit\Framework\Attributes\Before; @@ -35,6 +37,7 @@ use PHPUnit\Framework\Attributes\CoversNothing; use PHPUnit\Framework\Attributes\CoversTrait; use PHPUnit\Framework\Attributes\DataProvider; +use PHPUnit\Framework\Attributes\DataProviderClosure; use PHPUnit\Framework\Attributes\DataProviderExternal; use PHPUnit\Framework\Attributes\Depends; use PHPUnit\Framework\Attributes\DependsExternal; @@ -68,7 +71,6 @@ use PHPUnit\Framework\Attributes\RequiresPhpunit; use PHPUnit\Framework\Attributes\RequiresPhpunitExtension; use PHPUnit\Framework\Attributes\RequiresSetting; -use PHPUnit\Framework\Attributes\RunClassInSeparateProcess; use PHPUnit\Framework\Attributes\RunInSeparateProcess; use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses; use PHPUnit\Framework\Attributes\Small; @@ -91,7 +93,7 @@ use PHPUnit\Metadata\InvalidAttributeException; use PHPUnit\Metadata\Metadata; use PHPUnit\Metadata\MetadataCollection; -use PHPUnit\Metadata\Version\ConstraintRequirement; +use PHPUnit\Metadata\Version\Requirement; use ReflectionClass; use ReflectionMethod; @@ -138,6 +140,13 @@ public function forClass(string $className): MetadataCollection } switch ($attribute->getName()) { + case AllowMockObjectsWithoutExpectations::class: + assert($attributeInstance instanceof AllowMockObjectsWithoutExpectations); + + $result[] = Metadata::allowMockObjectsWithoutExpectationsOnClass(); + + break; + case BackupGlobals::class: assert($attributeInstance instanceof BackupGlobals); @@ -296,7 +305,7 @@ public function forClass(string $className): MetadataCollection case IgnoreDeprecations::class: assert($attributeInstance instanceof IgnoreDeprecations); - $result[] = Metadata::ignoreDeprecationsOnClass(); + $result[] = Metadata::ignoreDeprecationsOnClass($attributeInstance->messagePattern()); break; @@ -348,12 +357,15 @@ public function forClass(string $className): MetadataCollection case RequiresPhp::class: assert($attributeInstance instanceof RequiresPhp); - $result[] = Metadata::requiresPhpOnClass( - ConstraintRequirement::from( - $attributeInstance->versionRequirement(), - ), + $requirement = $this->requirement( + $attributeInstance->versionRequirement(), + $className, ); + if ($requirement !== null) { + $result[] = Metadata::requiresPhpOnClass($requirement); + } + break; case RequiresPhpExtension::class: @@ -363,7 +375,10 @@ public function forClass(string $className): MetadataCollection $versionRequirement = $attributeInstance->versionRequirement(); if ($versionRequirement !== null) { - $versionConstraint = ConstraintRequirement::from($versionRequirement); + $versionConstraint = $this->requirement( + $versionRequirement, + $className, + ); } $result[] = Metadata::requiresPhpExtensionOnClass( @@ -376,12 +391,15 @@ public function forClass(string $className): MetadataCollection case RequiresPhpunit::class: assert($attributeInstance instanceof RequiresPhpunit); - $result[] = Metadata::requiresPhpunitOnClass( - ConstraintRequirement::from( - $attributeInstance->versionRequirement(), - ), + $requirement = $this->requirement( + $attributeInstance->versionRequirement(), + $className, ); + if ($requirement !== null) { + $result[] = Metadata::requiresPhpunitOnClass($requirement); + } + break; case RequiresPhpunitExtension::class: @@ -423,11 +441,6 @@ public function forClass(string $className): MetadataCollection break; - case RunClassInSeparateProcess::class: - $result[] = Metadata::runClassInSeparateProcess(); - - break; - case RunTestsInSeparateProcesses::class: $result[] = Metadata::runTestsInSeparateProcesses(); @@ -552,6 +565,13 @@ public function forMethod(string $className, string $methodName): MetadataCollec break; + case AllowMockObjectsWithoutExpectations::class: + assert($attributeInstance instanceof AllowMockObjectsWithoutExpectations); + + $result[] = Metadata::allowMockObjectsWithoutExpectationsOnMethod(); + + break; + case BackupGlobals::class: assert($attributeInstance instanceof BackupGlobals); @@ -588,14 +608,21 @@ public function forMethod(string $className, string $methodName): MetadataCollec case DataProvider::class: assert($attributeInstance instanceof DataProvider); - $result[] = Metadata::dataProvider($className, $attributeInstance->methodName()); + $result[] = Metadata::dataProvider($className, $attributeInstance->methodName(), $attributeInstance->validateArgumentCount()); break; case DataProviderExternal::class: assert($attributeInstance instanceof DataProviderExternal); - $result[] = Metadata::dataProvider($attributeInstance->className(), $attributeInstance->methodName()); + $result[] = Metadata::dataProvider($attributeInstance->className(), $attributeInstance->methodName(), $attributeInstance->validateArgumentCount()); + + break; + + case DataProviderClosure::class: + assert($attributeInstance instanceof DataProviderClosure); + + $result[] = Metadata::dataProviderClosure($attributeInstance->closure(), $attributeInstance->validateArgumentCount()); break; @@ -698,7 +725,7 @@ public function forMethod(string $className, string $methodName): MetadataCollec case IgnoreDeprecations::class: assert($attributeInstance instanceof IgnoreDeprecations); - $result[] = Metadata::ignoreDeprecationsOnMethod(); + $result[] = Metadata::ignoreDeprecationsOnMethod($attributeInstance->messagePattern()); break; @@ -764,12 +791,16 @@ public function forMethod(string $className, string $methodName): MetadataCollec case RequiresPhp::class: assert($attributeInstance instanceof RequiresPhp); - $result[] = Metadata::requiresPhpOnMethod( - ConstraintRequirement::from( - $attributeInstance->versionRequirement(), - ), + $requirement = $this->requirement( + $attributeInstance->versionRequirement(), + $className, + $methodName, ); + if ($requirement !== null) { + $result[] = Metadata::requiresPhpOnMethod($requirement); + } + break; case RequiresPhpExtension::class: @@ -779,7 +810,11 @@ public function forMethod(string $className, string $methodName): MetadataCollec $versionRequirement = $attributeInstance->versionRequirement(); if ($versionRequirement !== null) { - $versionConstraint = ConstraintRequirement::from($versionRequirement); + $versionConstraint = $this->requirement( + $versionRequirement, + $className, + $methodName, + ); } $result[] = Metadata::requiresPhpExtensionOnMethod( @@ -792,12 +827,16 @@ public function forMethod(string $className, string $methodName): MetadataCollec case RequiresPhpunit::class: assert($attributeInstance instanceof RequiresPhpunit); - $result[] = Metadata::requiresPhpunitOnMethod( - ConstraintRequirement::from( - $attributeInstance->versionRequirement(), - ), + $requirement = $this->requirement( + $attributeInstance->versionRequirement(), + $className, + $methodName, ); + if ($requirement !== null) { + $result[] = Metadata::requiresPhpunitOnMethod($requirement); + } + break; case RequiresPhpunitExtension::class: @@ -948,6 +987,28 @@ private function isSizeGroup(string $groupName, string $testClassName, ?string $ return true; } + /** + * @param non-empty-string $versionRequirement + * @param class-string $testClassName + * @param ?non-empty-string $testMethodName + */ + private function requirement(string $versionRequirement, string $testClassName, ?string $testMethodName = null): ?Requirement + { + if (is_numeric(trim($versionRequirement))) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Test %s has attribute with version constraint string argument without explicit version comparison operator ("%s"), version constraint is ignored', + $this->testAsString($testClassName, $testMethodName), + $versionRequirement, + ), + ); + + return null; + } + + return Requirement::from($versionRequirement); + } + /** * @param class-string $testClassName * @param ?non-empty-string $testMethodName diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Parser/Parser.php b/app/vendor/phpunit/phpunit/src/Metadata/Parser/Parser.php index edc2d87f4..3159653f5 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Parser/Parser.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Parser/Parser.php @@ -14,7 +14,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Parser { diff --git a/app/vendor/phpunit/phpunit/src/Metadata/PostCondition.php b/app/vendor/phpunit/phpunit/src/Metadata/PostCondition.php index d52ae0628..6f9a595c1 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/PostCondition.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/PostCondition.php @@ -18,10 +18,7 @@ { private int $priority; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, int $priority) + protected function __construct(Level $level, int $priority) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/PreCondition.php b/app/vendor/phpunit/phpunit/src/Metadata/PreCondition.php index 9243122bc..b990e5c3d 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/PreCondition.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/PreCondition.php @@ -18,10 +18,7 @@ { private int $priority; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, int $priority) + protected function __construct(Level $level, int $priority) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/PreserveGlobalState.php b/app/vendor/phpunit/phpunit/src/Metadata/PreserveGlobalState.php index f88811915..9ce0e8254 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/PreserveGlobalState.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/PreserveGlobalState.php @@ -18,10 +18,7 @@ { private bool $enabled; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, bool $enabled) + protected function __construct(Level $level, bool $enabled) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresEnvironmentVariable.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresEnvironmentVariable.php index 0888c296d..018ae8ecf 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresEnvironmentVariable.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresEnvironmentVariable.php @@ -19,7 +19,7 @@ private string $environmentVariableName; private null|string $value; - public function __construct(int $level, string $environmentVariableName, null|string $value) + protected function __construct(Level $level, string $environmentVariableName, null|string $value) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresFunction.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresFunction.php index f66c5180c..d98caeddd 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresFunction.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresFunction.php @@ -22,10 +22,9 @@ private string $functionName; /** - * @param int<0, 1> $level * @param non-empty-string $functionName */ - protected function __construct(int $level, string $functionName) + protected function __construct(Level $level, string $functionName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresMethod.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresMethod.php index 2ad7fbb9a..ed052d37a 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresMethod.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresMethod.php @@ -27,11 +27,10 @@ private string $methodName; /** - * @param int<0, 1> $level * @param class-string $className * @param non-empty-string $methodName */ - protected function __construct(int $level, string $className, string $methodName) + protected function __construct(Level $level, string $className, string $methodName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystem.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystem.php index 8719d2961..ca625eeb8 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystem.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystem.php @@ -22,10 +22,9 @@ private string $operatingSystem; /** - * @param int<0, 1> $level * @param non-empty-string $operatingSystem */ - public function __construct(int $level, string $operatingSystem) + protected function __construct(Level $level, string $operatingSystem) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystemFamily.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystemFamily.php index 4481dcf8c..86b03d37b 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystemFamily.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresOperatingSystemFamily.php @@ -22,10 +22,9 @@ private string $operatingSystemFamily; /** - * @param int<0, 1> $level * @param non-empty-string $operatingSystemFamily */ - protected function __construct(int $level, string $operatingSystemFamily) + protected function __construct(Level $level, string $operatingSystemFamily) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhp.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhp.php index c64a39628..a5805013b 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhp.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhp.php @@ -20,10 +20,7 @@ { private Requirement $versionRequirement; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, Requirement $versionRequirement) + protected function __construct(Level $level, Requirement $versionRequirement) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpExtension.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpExtension.php index 5c547ea9e..fd7d42435 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpExtension.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpExtension.php @@ -25,10 +25,9 @@ private ?Requirement $versionRequirement; /** - * @param int<0, 1> $level * @param non-empty-string $extension */ - protected function __construct(int $level, string $extension, ?Requirement $versionRequirement) + protected function __construct(Level $level, string $extension, ?Requirement $versionRequirement) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunit.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunit.php index dc8ae80e2..f0c08c57f 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunit.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunit.php @@ -20,10 +20,7 @@ { private Requirement $versionRequirement; - /** - * @param int<0, 1> $level - */ - protected function __construct(int $level, Requirement $versionRequirement) + protected function __construct(Level $level, Requirement $versionRequirement) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunitExtension.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunitExtension.php index 726c3b961..fe50c0275 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunitExtension.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresPhpunitExtension.php @@ -26,7 +26,7 @@ /** * @param class-string $extensionClass */ - public function __construct(int $level, string $extensionClass) + protected function __construct(Level $level, string $extensionClass) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RequiresSetting.php b/app/vendor/phpunit/phpunit/src/Metadata/RequiresSetting.php index 0d0b0230a..3eea7f6b1 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/RequiresSetting.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/RequiresSetting.php @@ -27,11 +27,10 @@ private string $value; /** - * @param int<0, 1> $level * @param non-empty-string $setting * @param non-empty-string $value */ - protected function __construct(int $level, string $setting, string $value) + protected function __construct(Level $level, string $setting, string $value) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/RunClassInSeparateProcess.php b/app/vendor/phpunit/phpunit/src/Metadata/RunClassInSeparateProcess.php deleted file mode 100644 index 6f7927cec..000000000 --- a/app/vendor/phpunit/phpunit/src/Metadata/RunClassInSeparateProcess.php +++ /dev/null @@ -1,23 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Metadata; - -/** - * @immutable - * - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - */ -final readonly class RunClassInSeparateProcess extends Metadata -{ - public function isRunClassInSeparateProcess(): true - { - return true; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Metadata/TestDox.php b/app/vendor/phpunit/phpunit/src/Metadata/TestDox.php index 6e2944e5f..e456ae6ad 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/TestDox.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/TestDox.php @@ -22,10 +22,9 @@ private string $text; /** - * @param int<0, 1> $level * @param non-empty-string $text */ - protected function __construct(int $level, string $text) + protected function __construct(Level $level, string $text) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/TestDoxFormatter.php b/app/vendor/phpunit/phpunit/src/Metadata/TestDoxFormatter.php index a7f055b87..3aa42293b 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/TestDoxFormatter.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/TestDoxFormatter.php @@ -27,11 +27,10 @@ private string $methodName; /** - * @param int<0, 1> $level * @param class-string $className * @param non-empty-string $methodName */ - protected function __construct(int $level, string $className, string $methodName) + protected function __construct(Level $level, string $className, string $methodName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/TestWith.php b/app/vendor/phpunit/phpunit/src/Metadata/TestWith.php index d704d863f..b347d340f 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/TestWith.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/TestWith.php @@ -24,10 +24,9 @@ private ?string $name; /** - * @param int<0, 1> $level * @param ?non-empty-string $name */ - protected function __construct(int $level, mixed $data, ?string $name = null) + protected function __construct(Level $level, mixed $data, ?string $name = null) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/UsesClass.php b/app/vendor/phpunit/phpunit/src/Metadata/UsesClass.php index edbd03ac5..2c17cf5ef 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/UsesClass.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/UsesClass.php @@ -22,10 +22,9 @@ private string $className; /** - * @param int<0, 1> $level * @param class-string $className */ - protected function __construct(int $level, string $className) + protected function __construct(Level $level, string $className) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatExtendClass.php b/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatExtendClass.php index baddfeb6b..71ddeda8d 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatExtendClass.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatExtendClass.php @@ -22,10 +22,9 @@ private string $className; /** - * @param int<0, 1> $level * @param class-string $className */ - protected function __construct(int $level, string $className) + protected function __construct(Level $level, string $className) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatImplementInterface.php b/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatImplementInterface.php index 5cdc6f629..1d38b89d6 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatImplementInterface.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/UsesClassesThatImplementInterface.php @@ -22,10 +22,9 @@ private string $interfaceName; /** - * @param int<0, 1> $level * @param class-string $interfaceName */ - protected function __construct(int $level, string $interfaceName) + protected function __construct(Level $level, string $interfaceName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/UsesFunction.php b/app/vendor/phpunit/phpunit/src/Metadata/UsesFunction.php index ec6cafee8..d5e47ca5d 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/UsesFunction.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/UsesFunction.php @@ -22,10 +22,9 @@ private string $functionName; /** - * @param int<0, 1> $level * @param non-empty-string $functionName */ - public function __construct(int $level, string $functionName) + protected function __construct(Level $level, string $functionName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/UsesMethod.php b/app/vendor/phpunit/phpunit/src/Metadata/UsesMethod.php index 6fc78f8f2..22edec882 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/UsesMethod.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/UsesMethod.php @@ -27,11 +27,10 @@ private string $methodName; /** - * @param int<0, 1> $level * @param class-string $className * @param non-empty-string $methodName */ - protected function __construct(int $level, string $className, string $methodName) + protected function __construct(Level $level, string $className, string $methodName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/UsesNamespace.php b/app/vendor/phpunit/phpunit/src/Metadata/UsesNamespace.php index f5e5d01ec..88c52e4c9 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/UsesNamespace.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/UsesNamespace.php @@ -22,10 +22,9 @@ private string $namespace; /** - * @param int<0, 1> $level * @param non-empty-string $namespace */ - protected function __construct(int $level, string $namespace) + protected function __construct(Level $level, string $namespace) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/UsesTrait.php b/app/vendor/phpunit/phpunit/src/Metadata/UsesTrait.php index 19490f26c..4d218068a 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/UsesTrait.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/UsesTrait.php @@ -22,10 +22,9 @@ private string $traitName; /** - * @param 0|1 $level * @param trait-string $traitName */ - protected function __construct(int $level, string $traitName) + protected function __construct(Level $level, string $traitName) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Metadata/Version/ComparisonRequirement.php b/app/vendor/phpunit/phpunit/src/Metadata/Version/ComparisonRequirement.php index b3b6a1fca..b87222fd0 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/Version/ComparisonRequirement.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/Version/ComparisonRequirement.php @@ -37,4 +37,9 @@ public function asString(): string { return $this->operator->asString() . ' ' . $this->version; } + + public function version(): string + { + return $this->version; + } } diff --git a/app/vendor/phpunit/phpunit/src/Metadata/WithEnvironmentVariable.php b/app/vendor/phpunit/phpunit/src/Metadata/WithEnvironmentVariable.php index cc4d0fe7d..4c415e920 100644 --- a/app/vendor/phpunit/phpunit/src/Metadata/WithEnvironmentVariable.php +++ b/app/vendor/phpunit/phpunit/src/Metadata/WithEnvironmentVariable.php @@ -25,7 +25,7 @@ /** * @param non-empty-string $environmentVariableName */ - public function __construct(int $level, string $environmentVariableName, null|string $value) + protected function __construct(Level $level, string $environmentVariableName, null|string $value) { parent::__construct($level); diff --git a/app/vendor/phpunit/phpunit/src/Runner/Baseline/Baseline.php b/app/vendor/phpunit/phpunit/src/Runner/Baseline/Baseline.php index cffc3791d..a2a33a5a2 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Baseline/Baseline.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Baseline/Baseline.php @@ -9,6 +9,10 @@ */ namespace PHPUnit\Runner\Baseline; +use function ksort; +use function strcmp; +use function usort; + /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * @@ -56,6 +60,21 @@ public function has(Issue $issue): bool */ public function groupedByFileAndLine(): array { - return $this->issues; + $issues = $this->issues; + + ksort($issues); + + foreach ($issues as &$lines) { + ksort($lines); + + foreach ($lines as &$issuesOnLine) { + usort( + $issuesOnLine, + static fn (Issue $a, Issue $b): int => strcmp($a->description(), $b->description()), + ); + } + } + + return $issues; } } diff --git a/app/vendor/phpunit/phpunit/src/Runner/CodeCoverage.php b/app/vendor/phpunit/phpunit/src/Runner/CodeCoverage.php index e84a5fc5f..05c2a2645 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/CodeCoverage.php +++ b/app/vendor/phpunit/phpunit/src/Runner/CodeCoverage.php @@ -10,9 +10,10 @@ namespace PHPUnit\Runner; use function assert; -use function file_put_contents; +use function implode; use function sprintf; use function sys_get_temp_dir; +use DateTimeImmutable; use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Framework\TestCase; use PHPUnit\TextUI\Configuration\CodeCoverageFilterRegistry; @@ -23,23 +24,19 @@ use SebastianBergmann\CodeCoverage\Driver\Selector; use SebastianBergmann\CodeCoverage\Exception as CodeCoverageException; use SebastianBergmann\CodeCoverage\Filter; -use SebastianBergmann\CodeCoverage\Report\Clover as CloverReport; -use SebastianBergmann\CodeCoverage\Report\Cobertura as CoberturaReport; -use SebastianBergmann\CodeCoverage\Report\Crap4j as Crap4jReport; +use SebastianBergmann\CodeCoverage\Report\Facade as ReportFacade; use SebastianBergmann\CodeCoverage\Report\Html\Colors; use SebastianBergmann\CodeCoverage\Report\Html\CustomCssFile; -use SebastianBergmann\CodeCoverage\Report\Html\Facade as HtmlReport; -use SebastianBergmann\CodeCoverage\Report\OpenClover as OpenCloverReport; -use SebastianBergmann\CodeCoverage\Report\PHP as PhpReport; -use SebastianBergmann\CodeCoverage\Report\Text as TextReport; use SebastianBergmann\CodeCoverage\Report\Thresholds; -use SebastianBergmann\CodeCoverage\Report\Xml\Facade as XmlReport; +use SebastianBergmann\CodeCoverage\Serialization\Serializer; use SebastianBergmann\CodeCoverage\StaticAnalysis\CacheWarmer; use SebastianBergmann\CodeCoverage\Test\Target\TargetCollection; use SebastianBergmann\CodeCoverage\Test\Target\ValidationFailure; -use SebastianBergmann\CodeCoverage\Test\TestSize\TestSize; -use SebastianBergmann\CodeCoverage\Test\TestStatus\TestStatus; +use SebastianBergmann\CodeCoverage\Test\TestSize; +use SebastianBergmann\CodeCoverage\Test\TestStatus; +use SebastianBergmann\CodeCoverage\Version as CodeCoverageVersion; use SebastianBergmann\Comparator\Comparator; +use SebastianBergmann\Environment\Runtime; use SebastianBergmann\Timer\NoActiveTimerException; use SebastianBergmann\Timer\Timer; @@ -124,19 +121,7 @@ public function init(Configuration $configuration, CodeCoverageFilterRegistry $c $this->codeCoverage()->excludeUncoveredFiles(); } - if ($codeCoverageFilterRegistry->get()->isEmpty()) { - if (!$codeCoverageFilterRegistry->configured()) { - EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( - 'No filter is configured, code coverage will not be processed', - ); - } else { - EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( - 'Incorrect filter configuration, code coverage will not be processed', - ); - } - - $this->deactivate(); - } + $this->warnIfFilterIsNotConfigured($codeCoverageFilterRegistry, $configuration); if (isset($coverageCacheDirectory) && $configuration->includeUncoveredFiles()) { EventFacade::emitter()->testRunnerStartedStaticAnalysisForCodeCoverage(); @@ -159,7 +144,7 @@ public function init(Configuration $configuration, CodeCoverageFilterRegistry $c } /** - * @phpstan-assert-if-true !null $this->instance + * @phpstan-assert-if-true !null $this->codeCoverage */ public function isActive(): bool { @@ -185,14 +170,14 @@ public function start(TestCase $test): void return; } - $size = TestSize::unknown(); + $size = TestSize::Unknown; if ($test->size()->isSmall()) { - $size = TestSize::small(); + $size = TestSize::Small; } elseif ($test->size()->isMedium()) { - $size = TestSize::medium(); + $size = TestSize::Medium; } elseif ($test->size()->isLarge()) { - $size = TestSize::large(); + $size = TestSize::Large; } $this->test = $test; @@ -203,6 +188,8 @@ public function start(TestCase $test): void ); $this->collecting = true; + + $this->timer()->start(); } public function stop(bool $append, null|false|TargetCollection $covers = null, ?TargetCollection $uses = null): void @@ -211,13 +198,15 @@ public function stop(bool $append, null|false|TargetCollection $covers = null, ? return; } - $status = TestStatus::unknown(); + $time = $this->timer()->stop()->asSeconds(); + $status = TestStatus::Unknown; + $this->collecting = false; if ($this->test !== null) { if ($this->test->status()->isSuccess()) { - $status = TestStatus::success(); + $status = TestStatus::Success; } else { - $status = TestStatus::failure(); + $status = TestStatus::Failure; } } @@ -251,10 +240,9 @@ public function stop(bool $append, null|false|TargetCollection $covers = null, ? } } - $this->codeCoverage->stop($append, $status, $covers, $uses); + $this->codeCoverage->stop($append, $status, $covers, $uses, $time); - $this->test = null; - $this->collecting = false; + $this->test = null; } public function deactivate(): void @@ -273,28 +261,24 @@ public function generateReports(Printer $printer, Configuration $configuration): if ($configuration->hasCoveragePhp()) { $this->codeCoverageGenerationStart($printer, 'PHP'); - try { - $writer = new PhpReport; - $writer->process($this->codeCoverage(), $configuration->coveragePhp()); + $serializer = new Serializer; - $this->codeCoverageGenerationSucceeded($printer); + $serializer->serialize($configuration->coveragePhp(), $this->codeCoverage(), $configuration->includeGitInformation()); - unset($writer); - } catch (CodeCoverageException $e) { - $this->codeCoverageGenerationFailed($printer, $e); - } + $this->codeCoverageGenerationSucceeded($printer); + + unset($serializer); } + $facade = ReportFacade::fromObject($this->codeCoverage()); + if ($configuration->hasCoverageClover()) { $this->codeCoverageGenerationStart($printer, 'Clover XML'); try { - $writer = new CloverReport; - $writer->process($this->codeCoverage(), $configuration->coverageClover(), 'Clover Coverage'); + $facade->renderClover($configuration->coverageClover(), 'Clover Coverage'); $this->codeCoverageGenerationSucceeded($printer); - - unset($writer); } catch (CodeCoverageException $e) { $this->codeCoverageGenerationFailed($printer, $e); } @@ -304,12 +288,9 @@ public function generateReports(Printer $printer, Configuration $configuration): $this->codeCoverageGenerationStart($printer, 'OpenClover XML'); try { - $writer = new OpenCloverReport; - $writer->process($this->codeCoverage(), $configuration->coverageOpenClover(), 'OpenClover Coverage'); + $facade->renderOpenClover($configuration->coverageOpenClover(), 'OpenClover Coverage'); $this->codeCoverageGenerationSucceeded($printer); - - unset($writer); } catch (CodeCoverageException $e) { $this->codeCoverageGenerationFailed($printer, $e); } @@ -319,12 +300,9 @@ public function generateReports(Printer $printer, Configuration $configuration): $this->codeCoverageGenerationStart($printer, 'Cobertura XML'); try { - $writer = new CoberturaReport; - $writer->process($this->codeCoverage(), $configuration->coverageCobertura()); + $facade->renderCobertura($configuration->coverageCobertura()); $this->codeCoverageGenerationSucceeded($printer); - - unset($writer); } catch (CodeCoverageException $e) { $this->codeCoverageGenerationFailed($printer, $e); } @@ -334,12 +312,9 @@ public function generateReports(Printer $printer, Configuration $configuration): $this->codeCoverageGenerationStart($printer, 'Crap4J XML'); try { - $writer = new Crap4jReport($configuration->coverageCrap4jThreshold()); - $writer->process($this->codeCoverage(), $configuration->coverageCrap4j()); + $facade->renderCrap4j($configuration->coverageCrap4j(), $configuration->coverageCrap4jThreshold()); $this->codeCoverageGenerationSucceeded($printer); - - unset($writer); } catch (CodeCoverageException $e) { $this->codeCoverageGenerationFailed($printer, $e); } @@ -355,17 +330,31 @@ public function generateReports(Printer $printer, Configuration $configuration): $customCssFile = CustomCssFile::from($configuration->coverageHtmlCustomCssFile()); } - $writer = new HtmlReport( + $facade->renderHtml( + $configuration->coverageHtml(), sprintf( ' and PHPUnit %s', Version::id(), ), Colors::from( $configuration->coverageHtmlColorSuccessLow(), + $configuration->coverageHtmlColorSuccessLowDark(), $configuration->coverageHtmlColorSuccessMedium(), + $configuration->coverageHtmlColorSuccessMediumDark(), $configuration->coverageHtmlColorSuccessHigh(), + $configuration->coverageHtmlColorSuccessHighDark(), + $configuration->coverageHtmlColorSuccessBar(), + $configuration->coverageHtmlColorSuccessBarDark(), $configuration->coverageHtmlColorWarning(), + $configuration->coverageHtmlColorWarningDark(), + $configuration->coverageHtmlColorWarningBar(), + $configuration->coverageHtmlColorWarningBarDark(), $configuration->coverageHtmlColorDanger(), + $configuration->coverageHtmlColorDangerDark(), + $configuration->coverageHtmlColorDangerBar(), + $configuration->coverageHtmlColorDangerBarDark(), + $configuration->coverageHtmlColorBreadcrumbs(), + $configuration->coverageHtmlColorBreadcrumbsDark(), ), Thresholds::from( $configuration->coverageHtmlLowUpperBound(), @@ -374,31 +363,33 @@ public function generateReports(Printer $printer, Configuration $configuration): $customCssFile, ); - $writer->process($this->codeCoverage(), $configuration->coverageHtml()); - $this->codeCoverageGenerationSucceeded($printer); - - unset($writer); } catch (CodeCoverageException $e) { $this->codeCoverageGenerationFailed($printer, $e); } } if ($configuration->hasCoverageText()) { - $processor = new TextReport( - Thresholds::default(), - $configuration->coverageTextShowUncoveredFiles(), - $configuration->coverageTextShowOnlySummary(), - ); - - $textReport = $processor->process($this->codeCoverage(), $configuration->colors()); - if ($configuration->coverageText() === 'php://stdout') { if (!$configuration->noOutput() && !$configuration->debug()) { - $printer->print($textReport); + $printer->print( + $facade->renderText( + null, + Thresholds::default(), + $configuration->coverageTextShowUncoveredFiles(), + $configuration->coverageTextShowOnlySummary(), + $configuration->colors(), + ), + ); } } else { - file_put_contents($configuration->coverageText(), $textReport); + $facade->renderText( + $configuration->coverageText(), + Thresholds::default(), + $configuration->coverageTextShowUncoveredFiles(), + $configuration->coverageTextShowOnlySummary(), + $configuration->colors(), + ); } } @@ -406,18 +397,62 @@ public function generateReports(Printer $printer, Configuration $configuration): $this->codeCoverageGenerationStart($printer, 'PHPUnit XML'); try { - $writer = new XmlReport(Version::id()); - $writer->process($this->codeCoverage(), $configuration->coverageXml()); + $driverInformation = $this->codeCoverage->driverInformation(); + + $facade->renderXml( + $configuration->coverageXml(), + $configuration->coverageXmlIncludeSource(), + new Runtime, + new DateTimeImmutable, + Version::id(), + CodeCoverageVersion::id(), + $driverInformation['name'], + $driverInformation['version'], + ); $this->codeCoverageGenerationSucceeded($printer); - - unset($writer); } catch (CodeCoverageException $e) { $this->codeCoverageGenerationFailed($printer, $e); } } } + public function warnIfFilterIsNotConfigured(CodeCoverageFilterRegistry $codeCoverageFilterRegistry, Configuration $configuration): void + { + if (!$codeCoverageFilterRegistry->get()->isEmpty()) { + return; + } + + if (!$codeCoverageFilterRegistry->configured()) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + 'No filter is configured, code coverage will not be processed', + ); + + $this->deactivate(); + + return; + } + + $paths = []; + + foreach ($configuration->source()->includeDirectories() as $directory) { + $paths[] = $directory->path(); + } + + foreach ($configuration->source()->includeFiles() as $file) { + $paths[] = $file->path(); + } + + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Configured source filter (include-path: %s) does not match any files, code coverage will not be processed', + implode(', ', $paths), + ), + ); + + $this->deactivate(); + } + private function activate(Filter $filter, bool $pathCoverage): void { try { diff --git a/app/vendor/phpunit/phpunit/src/Runner/ErrorHandler.php b/app/vendor/phpunit/phpunit/src/Runner/ErrorHandler.php index b1d0468bd..93589ad1e 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/ErrorHandler.php +++ b/app/vendor/phpunit/phpunit/src/Runner/ErrorHandler.php @@ -25,22 +25,30 @@ use const E_USER_WARNING; use const E_WARNING; use function array_keys; +use function array_unshift; use function array_values; +use function assert; +use function count; use function debug_backtrace; use function defined; use function error_reporting; +use function preg_match; use function restore_error_handler; use function set_error_handler; use function sprintf; use PHPUnit\Event; +use PHPUnit\Event\Code\IssueTrigger\Code; use PHPUnit\Event\Code\IssueTrigger\IssueTrigger; use PHPUnit\Event\Code\NoTestCaseObjectOnCallStackException; use PHPUnit\Event\Code\TestMethod; use PHPUnit\Framework\TestCase; +use PHPUnit\Metadata\IgnoreDeprecations; +use PHPUnit\Metadata\Parser\Registry as MetadataParserRegistry; use PHPUnit\Runner\Baseline\Baseline; use PHPUnit\Runner\Baseline\Issue; -use PHPUnit\TextUI\Configuration\Registry; -use PHPUnit\TextUI\Configuration\Source; +use PHPUnit\Runner\IssueTriggerResolver\DefaultResolver as DefaultIssueTriggerResolver; +use PHPUnit\Runner\IssueTriggerResolver\Resolver as IssueTriggerResolver; +use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry; use PHPUnit\TextUI\Configuration\SourceFilter; use PHPUnit\Util\ExcludeList; @@ -51,13 +59,14 @@ */ final class ErrorHandler { - private const int UNHANDLEABLE_LEVELS = E_ERROR | E_PARSE | E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_COMPILE_WARNING; - private const int INSUPPRESSIBLE_LEVELS = E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR | E_RECOVERABLE_ERROR; - private static ?self $instance = null; - private ?Baseline $baseline = null; + private const int UNHANDLEABLE_LEVELS = E_ERROR | E_PARSE | E_CORE_ERROR | E_CORE_WARNING | E_COMPILE_ERROR | E_COMPILE_WARNING; + private const int INSUPPRESSIBLE_LEVELS = E_ERROR | E_PARSE | E_CORE_ERROR | E_COMPILE_ERROR | E_USER_ERROR | E_RECOVERABLE_ERROR; + private static ?self $instance = null; + private ?Baseline $baseline = null; + private ExcludeList $excludeList; private bool $enabled = false; private ?int $originalErrorReportingLevel = null; - private readonly Source $source; + private readonly bool $identifyIssueTrigger; /** * @var list @@ -75,25 +84,46 @@ final class ErrorHandler */ private ?array $deprecationTriggers = null; + /** + * @var non-empty-list + */ + private array $issueTriggerResolvers; + public static function instance(): self { - return self::$instance ?? self::$instance = new self(Registry::get()->source()); + $source = ConfigurationRegistry::get()->source(); + + $identifyIssueTrigger = true; + + if (!$source->identifyIssueTrigger()) { + $identifyIssueTrigger = false; + } + + if (!$source->notEmpty()) { + $identifyIssueTrigger = false; + } + + return self::$instance ?? self::$instance = new self($identifyIssueTrigger); } - private function __construct(Source $source) + private function __construct(bool $identifyIssueTrigger) { - $this->source = $source; + $this->excludeList = new ExcludeList; + $this->identifyIssueTrigger = $identifyIssueTrigger; + $this->issueTriggerResolvers = [new DefaultIssueTriggerResolver]; } /** * @throws NoTestCaseObjectOnCallStackException */ - public function __invoke(int $errorNumber, string $errorString, string $errorFile, int $errorLine): bool + public function __invoke(int $errorNumber, string $errorString, string $errorFile, int $errorLine): false { $suppressed = (error_reporting() & ~self::INSUPPRESSIBLE_LEVELS) === 0; - if ($suppressed && (new ExcludeList)->isExcluded($errorFile)) { + if ($suppressed && $this->excludeList->isExcluded($errorFile)) { + // @codeCoverageIgnoreStart return false; + // @codeCoverageIgnoreEnd } /** @@ -102,7 +132,9 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil * @see https://github.com/sebastianbergmann/phpunit/issues/5956 */ if (defined('E_STRICT') && $errorNumber === 2048) { + // @codeCoverageIgnoreStart $errorNumber = E_NOTICE; + // @codeCoverageIgnoreEnd } $test = Event\Code\TestMethodBuilder::fromCallStack(); @@ -114,7 +146,7 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil } $ignoredByBaseline = $this->ignoredByBaseline($errorFile, $errorLine, $errorString); - $ignoredByTest = $test->metadata()->isIgnoreDeprecations()->isNotEmpty(); + $ignoredByTest = $this->deprecationIgnoredByTest($test, $errorString); switch ($errorNumber) { case E_NOTICE: @@ -174,7 +206,7 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil $suppressed, $ignoredByBaseline, $ignoredByTest, - $this->trigger($test, false), + $this->trigger($test, false, $errorString, $errorFile), ); break; @@ -188,7 +220,7 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil $suppressed, $ignoredByBaseline, $ignoredByTest, - $this->trigger($test, true), + $this->trigger($test, true, $errorString), $this->stackTrace(), ); @@ -212,7 +244,7 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil return false; } - public function deprecationHandler(int $errorNumber, string $errorString, string $errorFile, int $errorLine): bool + public function deprecationHandler(int $errorNumber, string $errorString, string $errorFile, int $errorLine): true { if ($this->testCaseContext !== null) { $this->testCaseContextDeprecations[$this->testCaseContext][] = [$errorNumber, $errorString, $errorFile, $errorLine]; @@ -225,7 +257,7 @@ public function deprecationHandler(int $errorNumber, string $errorString, string public function registerDeprecationHandler(): void { - set_error_handler([self::$instance, 'deprecationHandler'], E_USER_DEPRECATED); + set_error_handler([self::$instance, 'deprecationHandler'], E_USER_DEPRECATED | E_DEPRECATED); } public function restoreDeprecationHandler(): void @@ -235,9 +267,7 @@ public function restoreDeprecationHandler(): void public function enable(TestCase $test): void { - if ($this->enabled) { - return; - } + assert(!$this->enabled); $oldErrorHandler = set_error_handler($this); @@ -282,6 +312,11 @@ public function useDeprecationTriggers(array $deprecationTriggers): void $this->deprecationTriggers = $deprecationTriggers; } + public function addIssueTriggerResolver(IssueTriggerResolver $resolver): void + { + array_unshift($this->issueTriggerResolvers, $resolver); + } + public function enterTestCaseContext(string $className, string $methodName): void { $this->testCaseContext = $this->testCaseContext($className, $methodName); @@ -306,52 +341,88 @@ private function ignoredByBaseline(string $file, int $line, string $description) return $this->baseline->has(Issue::from($file, $line, null, $description)); } - private function trigger(TestMethod $test, bool $filterTrigger): IssueTrigger + /** + * @param null|non-empty-string $errorFile + */ + private function trigger(TestMethod $test, bool $isUserland, string $errorString, ?string $errorFile = null): IssueTrigger { - if (!$this->source->notEmpty()) { - return IssueTrigger::unknown(); + if (!$this->identifyIssueTrigger) { + return IssueTrigger::from(null, null); } - $trace = $this->filteredStackTrace($filterTrigger); + if (!$isUserland) { + assert($errorFile !== null); + + return IssueTrigger::from(Code::PHP, $this->categorizeFile($errorFile, $test)); + } - $triggeredInFirstPartyCode = false; - $triggerCalledFromFirstPartyCode = false; + $trace = $this->filteredStackTrace(); - if (isset($trace[0]['file'])) { - if ($trace[0]['file'] === $test->file()) { - return IssueTrigger::test(); + return $this->triggerForUserlandDeprecation($test, $errorString, $trace); + } + + /** + * @param list}> $trace + */ + private function triggerForUserlandDeprecation(TestMethod $test, string $message, array $trace): IssueTrigger + { + foreach ($this->issueTriggerResolvers as $resolver) { + $result = $resolver->resolve($trace, $message); + + if ($result === null) { + continue; } - if (SourceFilter::instance()->includes($trace[0]['file'])) { - $triggeredInFirstPartyCode = true; + $callee = null; + + if ($result->hasCallee()) { + $callee = $this->categorizeFile($result->callee(), $test); } + + $caller = null; + + if ($result->hasCaller()) { + $caller = $this->categorizeFile($result->caller(), $test); + } + + return IssueTrigger::from($callee, $caller); } - if (isset($trace[1]['file']) && - ($trace[1]['file'] === $test->file() || - SourceFilter::instance()->includes($trace[1]['file']))) { - $triggerCalledFromFirstPartyCode = true; + // @codeCoverageIgnoreStart + return IssueTrigger::from(null, null); + // @codeCoverageIgnoreEnd + } + + /** + * @param non-empty-string $file + */ + private function categorizeFile(string $file, TestMethod $test): Code + { + if ($file === $test->file()) { + return Code::Test; } - if ($triggerCalledFromFirstPartyCode) { - if ($triggeredInFirstPartyCode) { - return IssueTrigger::self(); - } + if (SourceFilter::instance()->includes($file)) { + return Code::FirstParty; + } - return IssueTrigger::direct(); + if ($this->excludeList->isExcluded($file)) { + return Code::PHPUnit; } - return IssueTrigger::indirect(); + return Code::ThirdParty; } /** - * @return list + * @return list, object?: object}> */ - private function filteredStackTrace(bool $filterDeprecationTriggers): array + private function filteredStackTrace(): array { - $trace = $this->errorStackTrace(); + $ignoreArguments = count($this->issueTriggerResolvers) === 1; + + $trace = $this->errorStackTrace($ignoreArguments); - if ($this->deprecationTriggers === null || !$filterDeprecationTriggers) { + if ($this->deprecationTriggers === null) { return array_values($trace); } @@ -405,11 +476,15 @@ private function guessDeprecationFrame(): ?array } /** - * @return list + * @return list, object?: object}> */ - private function errorStackTrace(): array + private function errorStackTrace(bool $ignoreArgs = true): array { - $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); + if ($ignoreArgs) { + $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); + } else { + $trace = debug_backtrace(); + } $i = 0; @@ -446,8 +521,7 @@ private function frameIsMethod(array $frame, array $method): bool */ private function stackTrace(): string { - $buffer = ''; - $excludeList = new ExcludeList(true); + $buffer = ''; foreach ($this->errorStackTrace() as $frame) { /** @@ -457,7 +531,7 @@ private function stackTrace(): string continue; } - if ($excludeList->isExcluded($frame['file'])) { + if ($this->excludeList->isExcluded($frame['file'])) { continue; } @@ -473,7 +547,7 @@ private function stackTrace(): string private function triggerGlobalDeprecations(TestCase $test): void { - foreach ($this->globalDeprecations ?? [] as $d) { + foreach ($this->globalDeprecations as $d) { $this->__invoke(...$d); } @@ -488,4 +562,22 @@ private function testCaseContext(string $className, string $methodName): string { return "{$className}::{$methodName}"; } + + private function deprecationIgnoredByTest(TestMethod $test, string $message): bool + { + $metadata = MetadataParserRegistry::parser()->forClassAndMethod($test->className(), $test->methodName())->isIgnoreDeprecations()->asArray(); + + foreach ($metadata as $metadatum) { + assert($metadatum instanceof IgnoreDeprecations); + + $ignoreDeprecationMessagePattern = $metadatum->messagePattern(); + + if ($ignoreDeprecationMessagePattern === null || + (bool) preg_match('{' . $ignoreDeprecationMessagePattern . '}', $message)) { + return true; + } + } + + return false; + } } diff --git a/app/vendor/phpunit/phpunit/src/Runner/Exception/CodeCoverageFileExistsException.php b/app/vendor/phpunit/phpunit/src/Runner/Exception/CodeCoverageFileExistsException.php new file mode 100644 index 000000000..3ffde5bfa --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Runner/Exception/CodeCoverageFileExistsException.php @@ -0,0 +1,21 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Runner; + +use RuntimeException; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class CodeCoverageFileExistsException extends RuntimeException implements Exception +{ +} diff --git a/app/vendor/phpunit/phpunit/src/Runner/Exception/Exception.php b/app/vendor/phpunit/phpunit/src/Runner/Exception/Exception.php index ea0cf4244..d2577c2db 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Exception/Exception.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Exception/Exception.php @@ -12,7 +12,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Exception extends \PHPUnit\Exception { diff --git a/app/vendor/phpunit/phpunit/src/Runner/Extension/ExtensionBootstrapper.php b/app/vendor/phpunit/phpunit/src/Runner/Extension/ExtensionBootstrapper.php index b9c6c9fa2..89966aec0 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Extension/ExtensionBootstrapper.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Extension/ExtensionBootstrapper.php @@ -66,7 +66,7 @@ public function bootstrap(string $className, array $parameters): void } try { - $instance = (new ReflectionClass($className))->newInstance(); + $instance = new ReflectionClass($className)->newInstance(); assert($instance instanceof Extension); diff --git a/app/vendor/phpunit/phpunit/src/Runner/Extension/ExtensionFacade.php b/app/vendor/phpunit/phpunit/src/Runner/Extension/ExtensionFacade.php new file mode 100644 index 000000000..15882845f --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Runner/Extension/ExtensionFacade.php @@ -0,0 +1,95 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Runner\Extension; + +use PHPUnit\Event\EventFacadeIsSealedException; +use PHPUnit\Event\Facade as EventFacade; +use PHPUnit\Event\Subscriber; +use PHPUnit\Event\Tracer\Tracer; +use PHPUnit\Event\UnknownSubscriberTypeException; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class ExtensionFacade implements Facade +{ + private bool $replacesOutput = false; + private bool $replacesProgressOutput = false; + private bool $replacesResultOutput = false; + private bool $requiresCodeCoverageCollection = false; + + /** + * @throws EventFacadeIsSealedException + * @throws UnknownSubscriberTypeException + */ + public function registerSubscribers(Subscriber ...$subscribers): void + { + EventFacade::instance()->registerSubscribers(...$subscribers); + } + + /** + * @throws EventFacadeIsSealedException + * @throws UnknownSubscriberTypeException + */ + public function registerSubscriber(Subscriber $subscriber): void + { + EventFacade::instance()->registerSubscriber($subscriber); + } + + /** + * @throws EventFacadeIsSealedException + */ + public function registerTracer(Tracer $tracer): void + { + EventFacade::instance()->registerTracer($tracer); + } + + public function replaceOutput(): void + { + $this->replacesOutput = true; + } + + public function replacesOutput(): bool + { + return $this->replacesOutput; + } + + public function replaceProgressOutput(): void + { + $this->replacesProgressOutput = true; + } + + public function replacesProgressOutput(): bool + { + return $this->replacesOutput || $this->replacesProgressOutput; + } + + public function replaceResultOutput(): void + { + $this->replacesResultOutput = true; + } + + public function replacesResultOutput(): bool + { + return $this->replacesOutput || $this->replacesResultOutput; + } + + public function requireCodeCoverageCollection(): void + { + $this->requiresCodeCoverageCollection = true; + } + + public function requiresCodeCoverageCollection(): bool + { + return $this->requiresCodeCoverageCollection; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Runner/Extension/Facade.php b/app/vendor/phpunit/phpunit/src/Runner/Extension/Facade.php index 910f4e5fe..e2462423c 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Extension/Facade.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Extension/Facade.php @@ -10,7 +10,6 @@ namespace PHPUnit\Runner\Extension; use PHPUnit\Event\EventFacadeIsSealedException; -use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Event\Subscriber; use PHPUnit\Event\Tracer\Tracer; use PHPUnit\Event\UnknownSubscriberTypeException; @@ -18,76 +17,30 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit */ -final class Facade +interface Facade { - private bool $replacesOutput = false; - private bool $replacesProgressOutput = false; - private bool $replacesResultOutput = false; - private bool $requiresCodeCoverageCollection = false; - /** * @throws EventFacadeIsSealedException * @throws UnknownSubscriberTypeException */ - public function registerSubscribers(Subscriber ...$subscribers): void - { - EventFacade::instance()->registerSubscribers(...$subscribers); - } + public function registerSubscribers(Subscriber ...$subscribers): void; /** * @throws EventFacadeIsSealedException * @throws UnknownSubscriberTypeException */ - public function registerSubscriber(Subscriber $subscriber): void - { - EventFacade::instance()->registerSubscriber($subscriber); - } + public function registerSubscriber(Subscriber $subscriber): void; /** * @throws EventFacadeIsSealedException */ - public function registerTracer(Tracer $tracer): void - { - EventFacade::instance()->registerTracer($tracer); - } - - public function replaceOutput(): void - { - $this->replacesOutput = true; - } - - public function replacesOutput(): bool - { - return $this->replacesOutput; - } - - public function replaceProgressOutput(): void - { - $this->replacesProgressOutput = true; - } - - public function replacesProgressOutput(): bool - { - return $this->replacesOutput || $this->replacesProgressOutput; - } + public function registerTracer(Tracer $tracer): void; - public function replaceResultOutput(): void - { - $this->replacesResultOutput = true; - } + public function replaceOutput(): void; - public function replacesResultOutput(): bool - { - return $this->replacesOutput || $this->replacesResultOutput; - } + public function replaceProgressOutput(): void; - public function requireCodeCoverageCollection(): void - { - $this->requiresCodeCoverageCollection = true; - } + public function replaceResultOutput(): void; - public function requiresCodeCoverageCollection(): bool - { - return $this->requiresCodeCoverageCollection; - } + public function requireCodeCoverageCollection(): void; } diff --git a/app/vendor/phpunit/phpunit/src/Runner/Filter/NameFilterIterator.php b/app/vendor/phpunit/phpunit/src/Runner/Filter/NameFilterIterator.php index f28bf0b43..070c553d9 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Filter/NameFilterIterator.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Filter/NameFilterIterator.php @@ -97,7 +97,7 @@ private function prepareFilter(string $filter): array $dataSetMinimum = (int) $matches[2]; $dataSetMaximum = (int) $matches[3]; - } else { + } elseif ($matches[1] !== '') { $filter = sprintf( '%s.*with data set #%s$', $matches[1], @@ -109,7 +109,7 @@ private function prepareFilter(string $filter): array // * testDetermineJsonError@JSON.* elseif (preg_match('/^(.*?)@(.+)$/', $filter, $matches)) { $filter = sprintf( - '%s.*with data set "@%s"$', + '%s.*with data set "%s"$', $matches[1], $matches[2], ); diff --git a/app/vendor/phpunit/phpunit/src/Runner/IssueFilter.php b/app/vendor/phpunit/phpunit/src/Runner/IssueFilter.php index 445c15b7f..329a79556 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/IssueFilter.php +++ b/app/vendor/phpunit/phpunit/src/Runner/IssueFilter.php @@ -44,8 +44,7 @@ public function shouldBeProcessed(DeprecationTriggered|ErrorTriggered|NoticeTrig return false; } - if ($this->source->ignoreSelfDeprecations() && - ($event->trigger()->isTest() || $event->trigger()->isSelf())) { + if ($this->source->ignoreSelfDeprecations() && $event->trigger()->isSelf()) { return false; } diff --git a/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/DefaultResolver.php b/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/DefaultResolver.php new file mode 100644 index 000000000..0fe6dbecb --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/DefaultResolver.php @@ -0,0 +1,29 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Runner\IssueTriggerResolver; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class DefaultResolver implements Resolver +{ + /** + * @param list}> $trace + */ + public function resolve(array $trace, string $message): Resolution + { + return new Resolution( + $trace[0]['file'] ?? null, + $trace[1]['file'] ?? null, + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/Resolution.php b/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/Resolution.php new file mode 100644 index 000000000..92695a0d5 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/Resolution.php @@ -0,0 +1,51 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Runner\IssueTriggerResolver; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +final readonly class Resolution +{ + private ?string $callee; + private ?string $caller; + + public function __construct(?string $callee, ?string $caller) + { + $this->callee = $callee; + $this->caller = $caller; + } + + /** + * @phpstan-assert-if-true !null $this->callee + */ + public function hasCallee(): bool + { + return $this->callee !== null; + } + + public function callee(): ?string + { + return $this->callee; + } + + /** + * @phpstan-assert-if-true !null $this->caller + */ + public function hasCaller(): bool + { + return $this->caller !== null; + } + + public function caller(): ?string + { + return $this->caller; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/Resolver.php b/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/Resolver.php new file mode 100644 index 000000000..8da16c06a --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Runner/IssueTriggerResolver/Resolver.php @@ -0,0 +1,23 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Runner\IssueTriggerResolver; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + */ +interface Resolver +{ + /** + * Return null to defer to the next resolver in the chain. + * + * @param list, object?: object}> $trace + */ + public function resolve(array $trace, string $message): ?Resolution; +} diff --git a/app/vendor/phpunit/phpunit/src/Runner/Phpt/Parser.php b/app/vendor/phpunit/phpunit/src/Runner/Phpt/Parser.php index 72582d733..e89250710 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Phpt/Parser.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Phpt/Parser.php @@ -19,6 +19,7 @@ use function is_readable; use function is_string; use function preg_match; +use function realpath; use function rtrim; use function str_contains; use function trim; @@ -184,11 +185,20 @@ private function parseExternal(string $phptFile, array &$sections): void ); } - $contents = file_get_contents($testDirectory . $externalFilename); + $externalPath = $testDirectory . $externalFilename; + $contents = file_get_contents($externalPath); assert($contents !== false && $contents !== ''); $sections[$section] = $contents; + + if ($section === 'FILE') { + $resolvedPath = realpath($externalPath); + + assert(is_string($resolvedPath) && $resolvedPath !== ''); + + $sections['FILE_EXTERNAL_PATH'] = $resolvedPath; + } } } } diff --git a/app/vendor/phpunit/phpunit/src/Runner/Phpt/Renderer.php b/app/vendor/phpunit/phpunit/src/Runner/Phpt/Renderer.php index 0fe1de925..b4257f502 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Phpt/Renderer.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Phpt/Renderer.php @@ -15,7 +15,6 @@ use function file_put_contents; use function str_replace; use function var_export; -use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry; use SebastianBergmann\Template\InvalidArgumentException; use SebastianBergmann\Template\Template; @@ -57,7 +56,7 @@ public function render(string $phptFile, string $code): string * * @throws InvalidArgumentException */ - public function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory, array $files): void + public function renderForCoverage(string &$job, bool $pathCoverage, ?string $codeCoverageCacheDirectory, string $bootstrap, array $files): void { $template = new Template( __DIR__ . '/templates/phpt.tpl', @@ -72,7 +71,9 @@ public function renderForCoverage(string &$job, bool $pathCoverage, ?string $cod $phar = '\'\''; if (defined('__PHPUNIT_PHAR__')) { + // @codeCoverageIgnoreStart $phar = var_export(__PHPUNIT_PHAR__, true); + // @codeCoverageIgnoreEnd } if ($codeCoverageCacheDirectory === null) { @@ -81,12 +82,6 @@ public function renderForCoverage(string &$job, bool $pathCoverage, ?string $cod $codeCoverageCacheDirectory = "'" . $codeCoverageCacheDirectory . "'"; } - $bootstrap = ''; - - if (ConfigurationRegistry::get()->hasBootstrap()) { - $bootstrap = ConfigurationRegistry::get()->bootstrap(); - } - $template->setVar( [ 'bootstrap' => $bootstrap, diff --git a/app/vendor/phpunit/phpunit/src/Runner/Phpt/TestCase.php b/app/vendor/phpunit/phpunit/src/Runner/Phpt/TestCase.php index ab75397b2..b15a46beb 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Phpt/TestCase.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Phpt/TestCase.php @@ -17,6 +17,7 @@ use function dirname; use function explode; use function extension_loaded; +use function file_exists; use function file_get_contents; use function is_array; use function is_file; @@ -49,19 +50,20 @@ use PHPUnit\Framework\SelfDescribing; use PHPUnit\Framework\Test; use PHPUnit\Runner\CodeCoverage; +use PHPUnit\Runner\CodeCoverageFileExistsException; use PHPUnit\Runner\Exception; +use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry; use PHPUnit\Util\PHP\Job; use PHPUnit\Util\PHP\JobRunnerRegistry; use SebastianBergmann\CodeCoverage\Data\RawCodeCoverageData; use SebastianBergmann\CodeCoverage\InvalidArgumentException; use SebastianBergmann\CodeCoverage\ReflectionException; -use SebastianBergmann\CodeCoverage\Test\TestSize\TestSize; -use SebastianBergmann\CodeCoverage\Test\TestStatus\TestStatus; +use SebastianBergmann\CodeCoverage\Test\TestSize; +use SebastianBergmann\CodeCoverage\Test\TestStatus; use SebastianBergmann\CodeCoverage\TestIdMissingException; use SebastianBergmann\CodeCoverage\UnintentionallyCoveredCodeException; use staabm\SideEffectsDetector\SideEffect; use staabm\SideEffectsDetector\SideEffectsDetector; -use Throwable; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -83,6 +85,8 @@ public function __construct(string $filename) { $this->filename = $filename; + + $this->ensureCoverageFileDoesNotExist(); } public function count(): int @@ -119,7 +123,7 @@ public function run(): void return; } - $code = (new Renderer)->render($this->filename, $sections['FILE']); + $code = (new Renderer)->render($sections['FILE_EXTERNAL_PATH'] ?? $this->filename, $sections['FILE']); $xfail = false; $environmentVariables = []; $phpSettings = $parser->parseIniSection($this->settings(CodeCoverage::instance()->isActive())); @@ -153,18 +157,27 @@ public function run(): void } if (CodeCoverage::instance()->isActive()) { + // @codeCoverageIgnoreStart $codeCoverageCacheDirectory = null; if (CodeCoverage::instance()->codeCoverage()->cachesStaticAnalysis()) { $codeCoverageCacheDirectory = CodeCoverage::instance()->codeCoverage()->cacheDirectory(); } + $bootstrap = ''; + + if (ConfigurationRegistry::get()->hasBootstrap()) { + $bootstrap = ConfigurationRegistry::get()->bootstrap(); + } + (new Renderer)->renderForCoverage( $code, CodeCoverage::instance()->codeCoverage()->collectsBranchAndPathCoverage(), $codeCoverageCacheDirectory, + $bootstrap, $this->coverageFiles(), ); + // @codeCoverageIgnoreEnd } $jobResult = JobRunnerRegistry::run( @@ -183,16 +196,18 @@ public function run(): void $output = $jobResult->stdout(); if (CodeCoverage::instance()->isActive()) { + // @codeCoverageIgnoreStart $coverage = $this->cleanupForCoverage(); - CodeCoverage::instance()->codeCoverage()->start($this->filename, TestSize::large()); + CodeCoverage::instance()->codeCoverage()->start($this->filename, TestSize::Large); CodeCoverage::instance()->codeCoverage()->append( $coverage, $this->filename, true, - TestStatus::unknown(), + TestStatus::Unknown, ); + // @codeCoverageIgnoreEnd } $passed = true; @@ -231,10 +246,6 @@ public function run(): void $emitter->testFailed($this->valueObjectForEvents(), ThrowableBuilder::from($failure), null); } - $passed = false; - } catch (Throwable $t) { - $emitter->testErrored($this->valueObjectForEvents(), ThrowableBuilder::from($t)); - $passed = false; } @@ -295,7 +306,6 @@ public function valueObjectForEvents(): Phpt /** * @param array $sections * - * @throws Exception * @throws ExpectationFailedException */ private function assertPhptExpectation(array $sections, string $output): void @@ -319,8 +329,6 @@ private function assertPhptExpectation(array $sections, string $output): void return; } } - - throw new InvalidPhptFileException; } /** @@ -450,6 +458,8 @@ private function runClean(array $sections, bool $collectCoverage): void } /** + * @codeCoverageIgnore + * * @phpstan-ignore return.internalClass */ private function cleanupForCoverage(): RawCodeCoverageData @@ -467,7 +477,15 @@ private function cleanupForCoverage(): RawCodeCoverageData } if ($buffer !== false) { - $coverage = @unserialize($buffer); + $coverage = @unserialize( + $buffer, + [ + 'allowed_classes' => [ + /** @phpstan-ignore classConstant.internalClass */ + RawCodeCoverageData::class, + ], + ], + ); if ($coverage === false) { /** @@ -667,6 +685,7 @@ private function settings(bool $collectCoverage): array 'report_zend_debug=0', ]; + // @codeCoverageIgnoreStart if (extension_loaded('pcov')) { if ($collectCoverage) { $settings[] = 'pcov.enabled=1'; @@ -680,6 +699,7 @@ private function settings(bool $collectCoverage): array $settings[] = 'xdebug.mode=coverage'; } } + // @codeCoverageIgnoreEnd return $settings; } @@ -706,4 +726,22 @@ private function triggerRunnerWarningOnPhpErrors(string $section, string $output ); } } + + /** + * @throws CodeCoverageFileExistsException + */ + private function ensureCoverageFileDoesNotExist(): void + { + $files = $this->coverageFiles(); + + if (file_exists($files['coverage'])) { + throw new CodeCoverageFileExistsException( + sprintf( + 'File %s exists, PHPT test %s will not be executed', + $files['coverage'], + $this->filename, + ), + ); + } + } } diff --git a/app/vendor/phpunit/phpunit/src/Runner/Phpt/templates/phpt.tpl b/app/vendor/phpunit/phpunit/src/Runner/Phpt/templates/phpt.tpl index c42518886..f9cc6d6ff 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Phpt/templates/phpt.tpl +++ b/app/vendor/phpunit/phpunit/src/Runner/Phpt/templates/phpt.tpl @@ -3,48 +3,48 @@ use SebastianBergmann\CodeCoverage\CodeCoverage; use SebastianBergmann\CodeCoverage\Driver\Selector; use SebastianBergmann\CodeCoverage\Filter; -$composerAutoload = {composerAutoload}; -$phar = {phar}; +$__phpunit_composerAutoload = {composerAutoload}; +$__phpunit_phar = {phar}; ob_start(); $GLOBALS['__PHPUNIT_ISOLATION_EXCLUDE_LIST'][] = '{job}'; -if ($composerAutoload) { - require_once $composerAutoload; +if ($__phpunit_composerAutoload) { + require_once $__phpunit_composerAutoload; - define('PHPUNIT_COMPOSER_INSTALL', $composerAutoload); -} else if ($phar) { - require $phar; + define('PHPUNIT_COMPOSER_INSTALL', $__phpunit_composerAutoload); +} else if ($__phpunit_phar) { + require $__phpunit_phar; } -$coverage = null; +$__phpunit_coverage = null; if ('{bootstrap}' !== '') { require_once '{bootstrap}'; } if (class_exists('SebastianBergmann\CodeCoverage\CodeCoverage')) { - $filter = new Filter; + $__phpunit_filter = new Filter; - $coverage = new CodeCoverage( - (new Selector)->{driverMethod}($filter), - $filter + $__phpunit_coverage = new CodeCoverage( + (new Selector)->{driverMethod}($__phpunit_filter), + $__phpunit_filter ); if ({codeCoverageCacheDirectory}) { - $coverage->cacheStaticAnalysis({codeCoverageCacheDirectory}); + $__phpunit_coverage->cacheStaticAnalysis({codeCoverageCacheDirectory}); } - $coverage->start(__FILE__); + $__phpunit_coverage->start(__FILE__); } register_shutdown_function( - function() use ($coverage) { + function() use ($__phpunit_coverage) { $output = null; - if ($coverage) { - $output = $coverage->stop(); + if ($__phpunit_coverage) { + $output = $__phpunit_coverage->stop(); } file_put_contents('{coverageFile}', serialize($output)); diff --git a/app/vendor/phpunit/phpunit/src/Runner/ResultCache/DefaultResultCache.php b/app/vendor/phpunit/phpunit/src/Runner/ResultCache/DefaultResultCache.php index 0d700a9a0..da57427f1 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/ResultCache/DefaultResultCache.php +++ b/app/vendor/phpunit/phpunit/src/Runner/ResultCache/DefaultResultCache.php @@ -47,13 +47,13 @@ final class DefaultResultCache implements ResultCache */ private array $times = []; - public function __construct(?string $filepath = null) + public function __construct(string $filepath) { - if ($filepath !== null && is_dir($filepath)) { + if (is_dir($filepath)) { $filepath .= DIRECTORY_SEPARATOR . self::DEFAULT_RESULT_CACHE_FILENAME; } - $this->cacheFilename = $filepath ?? $_ENV['PHPUNIT_RESULT_CACHE'] ?? self::DEFAULT_RESULT_CACHE_FILENAME; + $this->cacheFilename = $filepath; } public function setStatus(ResultCacheId $id, TestStatus $status): void diff --git a/app/vendor/phpunit/phpunit/src/Runner/ResultCache/ResultCache.php b/app/vendor/phpunit/phpunit/src/Runner/ResultCache/ResultCache.php index a3d62f50b..49b2df034 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/ResultCache/ResultCache.php +++ b/app/vendor/phpunit/phpunit/src/Runner/ResultCache/ResultCache.php @@ -14,7 +14,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface ResultCache { diff --git a/app/vendor/phpunit/phpunit/src/Runner/ShutdownHandler.php b/app/vendor/phpunit/phpunit/src/Runner/ShutdownHandler.php index 29d82d9df..5ee78d0c3 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/ShutdownHandler.php +++ b/app/vendor/phpunit/phpunit/src/Runner/ShutdownHandler.php @@ -9,7 +9,10 @@ */ namespace PHPUnit\Runner; +use const PHP_EOL; +use function getmypid; use function register_shutdown_function; +use function rtrim; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -40,11 +43,20 @@ private static function register(): void } self::$registered = true; + $pid = getmypid(); register_shutdown_function( - static function (): void + static function () use ($pid): void { - print self::$message; + $message = rtrim(self::$message); + + if ($message === '' || $pid !== getmypid()) { + return; + } + + print $message . PHP_EOL; + + exit(2); }, ); } diff --git a/app/vendor/phpunit/phpunit/src/Runner/TestResult/Collector.php b/app/vendor/phpunit/phpunit/src/Runner/TestResult/Collector.php index 5615a0dad..f6cbca9d2 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/TestResult/Collector.php +++ b/app/vendor/phpunit/phpunit/src/Runner/TestResult/Collector.php @@ -250,6 +250,8 @@ public function testSuiteSkipped(TestSuiteSkipped $event): void } $this->testSuiteSkippedEvents[] = $event; + + $this->numberOfTestsRun += $event->testSuite()->count(); } public function testSuiteStarted(TestSuiteStarted $event): void @@ -278,6 +280,10 @@ public function testSuiteFinished(TestSuiteFinished $event): void assert($test instanceof TestMethod); foreach ($this->testFailedEvents as $testFailedEvent) { + if ($testFailedEvent instanceof AfterLastTestMethodFailed || $testFailedEvent instanceof BeforeFirstTestMethodFailed) { + continue; + } + if ($testFailedEvent->test()->isTestMethod() && $testFailedEvent->test()->methodName() === $test->methodName()) { return; } diff --git a/app/vendor/phpunit/phpunit/src/Runner/TestResult/Facade.php b/app/vendor/phpunit/phpunit/src/Runner/TestResult/Facade.php index 4862d6860..c95ff53b0 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/TestResult/Facade.php +++ b/app/vendor/phpunit/phpunit/src/Runner/TestResult/Facade.php @@ -9,6 +9,7 @@ */ namespace PHPUnit\TestRunner\TestResult; +use function array_any; use function str_contains; use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Runner\DeprecationCollector\Facade as DeprecationCollectorFacade; @@ -101,12 +102,12 @@ private static function stopOnDeprecation(Configuration $configuration): bool return $deprecations !== []; } - foreach ($deprecations as $deprecation) { - if (str_contains($deprecation, $configuration->specificDeprecationToStopOn())) { - return true; - } - } - - return false; + return array_any( + $deprecations, + static fn (string $deprecation) => str_contains( + $deprecation, + $configuration->specificDeprecationToStopOn(), + ), + ); } } diff --git a/app/vendor/phpunit/phpunit/src/Runner/TestResult/PassedTests.php b/app/vendor/phpunit/phpunit/src/Runner/TestResult/PassedTests.php index 4fad1b5ec..2f611461d 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/TestResult/PassedTests.php +++ b/app/vendor/phpunit/phpunit/src/Runner/TestResult/PassedTests.php @@ -118,7 +118,7 @@ public function isGreaterThan(string $method, TestSize $other): bool public function hasReturnValue(string $method): bool { - $returnType = (new ReflectionMethod(...explode('::', $method)))->getReturnType(); + $returnType = new ReflectionMethod(...explode('::', $method))->getReturnType(); return !$returnType instanceof ReflectionNamedType || !in_array($returnType->getName(), ['never', 'void'], true); } diff --git a/app/vendor/phpunit/phpunit/src/Runner/TestResult/TestResult.php b/app/vendor/phpunit/phpunit/src/Runner/TestResult/TestResult.php index f491718f7..3601956db 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/TestResult/TestResult.php +++ b/app/vendor/phpunit/phpunit/src/Runner/TestResult/TestResult.php @@ -9,6 +9,8 @@ */ namespace PHPUnit\TestRunner\TestResult; +use function array_map; +use function array_sum; use function count; use PHPUnit\Event\Test\AfterLastTestMethodErrored; use PHPUnit\Event\Test\AfterLastTestMethodFailed; @@ -225,7 +227,7 @@ public function hasTestErroredEvents(): bool } /** - * @return list + * @return list */ public function testFailedEvents(): array { @@ -268,14 +270,19 @@ public function testSuiteSkippedEvents(): array return $this->testSuiteSkippedEvents; } - public function numberOfTestSuiteSkippedEvents(): int + public function numberOfTestSkippedByTestSuiteSkippedEvents(): int { - return count($this->testSuiteSkippedEvents); + return array_sum( + array_map( + static fn (TestSuiteSkipped $event): int => $event->testSuite()->count(), + $this->testSuiteSkippedEvents, + ), + ); } public function hasTestSuiteSkippedEvents(): bool { - return $this->numberOfTestSuiteSkippedEvents() > 0; + return $this->numberOfTestSkippedByTestSuiteSkippedEvents() > 0; } /** diff --git a/app/vendor/phpunit/phpunit/src/Runner/TestSuiteLoader.php b/app/vendor/phpunit/phpunit/src/Runner/TestSuiteLoader.php index 3d01964de..54a88f849 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/TestSuiteLoader.php +++ b/app/vendor/phpunit/phpunit/src/Runner/TestSuiteLoader.php @@ -133,10 +133,10 @@ private function loadSuiteClassFile(string $suiteClassFile): array self::$declaredClasses = get_declared_classes(); - if ($loadedClasses === []) { + if (!isset(self::$fileToClassesMap[$suiteClassFile])) { return self::$declaredClasses; } - return $loadedClasses; + return self::$fileToClassesMap[$suiteClassFile]; } } diff --git a/app/vendor/phpunit/phpunit/src/Runner/TestSuiteSorter.php b/app/vendor/phpunit/phpunit/src/Runner/TestSuiteSorter.php index b20ae2501..3a1e56403 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/TestSuiteSorter.php +++ b/app/vendor/phpunit/phpunit/src/Runner/TestSuiteSorter.php @@ -13,6 +13,7 @@ use function array_merge; use function array_reverse; use function array_splice; +use function assert; use function count; use function in_array; use function max; @@ -55,27 +56,15 @@ final class TestSuiteSorter * @var array Associative array of (string => DEFECT_SORT_WEIGHT) elements */ private array $defectSortOrder = []; - private readonly ResultCache $cache; - /** - * @var array A list of normalized names of tests before reordering - */ - private array $originalExecutionOrder = []; - - /** - * @var array A list of normalized names of tests affected by reordering - */ - private array $executionOrder = []; - - public function __construct(?ResultCache $cache = null) + public function __construct(private readonly ?ResultCache $cache = new NullResultCache) { - $this->cache = $cache ?? new NullResultCache; } /** * @throws Exception */ - public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDependencies, int $orderDefects, bool $isRootTestSuite = true): void + public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDependencies, int $orderDefects): void { $allowedOrders = [ self::ORDER_DEFAULT, @@ -86,7 +75,9 @@ public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDepend ]; if (!in_array($order, $allowedOrders, true)) { + // @codeCoverageIgnoreStart throw new InvalidOrderException; + // @codeCoverageIgnoreEnd } $allowedOrderDefects = [ @@ -95,16 +86,14 @@ public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDepend ]; if (!in_array($orderDefects, $allowedOrderDefects, true)) { + // @codeCoverageIgnoreStart throw new InvalidOrderException; - } - - if ($isRootTestSuite) { - $this->originalExecutionOrder = $this->calculateTestExecutionOrder($suite); + // @codeCoverageIgnoreEnd } if ($suite instanceof TestSuite) { foreach ($suite as $_suite) { - $this->reorderTestsInSuite($_suite, $order, $resolveDependencies, $orderDefects, false); + $this->reorderTestsInSuite($_suite, $order, $resolveDependencies, $orderDefects); } if ($orderDefects === self::ORDER_DEFECTS_FIRST) { @@ -113,26 +102,6 @@ public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDepend $this->sort($suite, $order, $resolveDependencies, $orderDefects); } - - if ($isRootTestSuite) { - $this->executionOrder = $this->calculateTestExecutionOrder($suite); - } - } - - /** - * @return array - */ - public function getOriginalExecutionOrder(): array - { - return $this->originalExecutionOrder; - } - - /** - * @return array - */ - public function getExecutionOrder(): array - { - return $this->executionOrder; } private function sort(TestSuite $suite, int $order, bool $resolveDependencies, int $orderDefects): void @@ -169,9 +138,7 @@ private function addSuiteToDefectSortOrder(TestSuite $suite): void $max = 0; foreach ($suite->tests() as $test) { - if (!$test instanceof Reorderable) { - continue; - } + assert($test instanceof Reorderable); $sortId = $test->sortId(); @@ -260,14 +227,13 @@ private function sortBySize(array $tests): array */ private function cmpDefectPriorityAndTime(Test $a, Test $b): int { - if (!($a instanceof Reorderable && $b instanceof Reorderable)) { - return 0; - } + assert($a instanceof Reorderable); + assert($b instanceof Reorderable); $priorityA = $this->defectSortOrder[$a->sortId()] ?? 0; $priorityB = $this->defectSortOrder[$b->sortId()] ?? 0; - if (($priorityB <=> $priorityA) > 0) { + if ($priorityA !== $priorityB) { // Sort defect weight descending return $priorityB <=> $priorityA; } @@ -340,24 +306,4 @@ private function resolveDependencies(array $tests): array return array_merge($newTestOrder, $tests); } - - /** - * @return array - */ - private function calculateTestExecutionOrder(Test $suite): array - { - $tests = []; - - if ($suite instanceof TestSuite) { - foreach ($suite->tests() as $test) { - if (!$test instanceof TestSuite && $test instanceof Reorderable) { - $tests[] = $test->sortId(); - } else { - $tests = array_merge($tests, $this->calculateTestExecutionOrder($test)); - } - } - } - - return $tests; - } } diff --git a/app/vendor/phpunit/phpunit/src/Runner/Version.php b/app/vendor/phpunit/phpunit/src/Runner/Version.php index 08d26c8d2..3ad5e5fe7 100644 --- a/app/vendor/phpunit/phpunit/src/Runner/Version.php +++ b/app/vendor/phpunit/phpunit/src/Runner/Version.php @@ -35,7 +35,7 @@ public static function id(): string } if (self::$version === '') { - self::$version = (new VersionId('12.3.8', dirname(__DIR__, 2)))->asString(); + self::$version = new VersionId('13.1.11', dirname(__DIR__, 2))->asString(); } return self::$version; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Application.php b/app/vendor/phpunit/phpunit/src/TextUI/Application.php index e430df7c7..4d6bce136 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Application.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Application.php @@ -11,12 +11,15 @@ use const PHP_EOL; use const PHP_VERSION; +use function array_reverse; use function assert; use function class_exists; +use function class_implements; use function defined; use function dirname; use function explode; use function function_exists; +use function in_array; use function is_file; use function method_exists; use function printf; @@ -49,9 +52,10 @@ use PHPUnit\Runner\DirectoryDoesNotExistException; use PHPUnit\Runner\ErrorHandler; use PHPUnit\Runner\Extension\ExtensionBootstrapper; -use PHPUnit\Runner\Extension\Facade as ExtensionFacade; +use PHPUnit\Runner\Extension\ExtensionFacade; use PHPUnit\Runner\Extension\PharLoader; use PHPUnit\Runner\GarbageCollection\GarbageCollectionHandler; +use PHPUnit\Runner\IssueTriggerResolver\Resolver; use PHPUnit\Runner\Phpt\TestCase as PhptTestCase; use PHPUnit\Runner\ResultCache\DefaultResultCache; use PHPUnit\Runner\ResultCache\NullResultCache; @@ -218,6 +222,7 @@ public function run(array $argv): int } $this->configureDeprecationTriggers($configuration); + $this->configureIssueTriggerResolvers($configuration); $timer = new Timer; $timer->start(); @@ -588,12 +593,16 @@ private function registerLogfileWriters(Configuration $configuration): void EventFacade::instance()->registerTracer( new EventLogger( $configuration->logEventsText(), - false, + $configuration->withTelemetry(), ), ); } if ($configuration->hasLogEventsVerboseText()) { + EventFacade::emitter()->testRunnerTriggeredPhpunitDeprecation( + 'The "--log-events-verbose-text " CLI option is deprecated and will be removed in PHPUnit 14. Use "--log-events-text --with-telemetry" instead.', + ); + if (is_file($configuration->logEventsVerboseText())) { unlink($configuration->logEventsVerboseText()); } @@ -784,14 +793,18 @@ private function configureDeprecationTriggers(Configuration $configuration): voi 'methods' => [], ]; + $ignoreUndefinedTriggers = $configuration->source()->deprecationTriggers()['ignoreUndefinedTriggers'] ?? false; + foreach ($configuration->source()->deprecationTriggers()['functions'] as $function) { if (!function_exists($function)) { - EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( - sprintf( - 'Function %s cannot be configured as a deprecation trigger because it is not declared', - $function, - ), - ); + if (!$ignoreUndefinedTriggers) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Function %s cannot be configured as a deprecation trigger because it is not declared', + $function, + ), + ); + } continue; } @@ -814,13 +827,15 @@ private function configureDeprecationTriggers(Configuration $configuration): voi [$className, $methodName] = explode('::', $method); if (!class_exists($className) || !method_exists($className, $methodName)) { - EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( - sprintf( - 'Method %s::%s cannot be configured as a deprecation trigger because it is not declared', - $className, - $methodName, - ), - ); + if (!$ignoreUndefinedTriggers) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Method %s::%s cannot be configured as a deprecation trigger because it is not declared', + $className, + $methodName, + ), + ); + } continue; } @@ -831,7 +846,41 @@ private function configureDeprecationTriggers(Configuration $configuration): voi ]; } - ErrorHandler::instance()->useDeprecationTriggers($deprecationTriggers); + if ($deprecationTriggers !== ['functions' => [], 'methods' => []]) { + ErrorHandler::instance()->useDeprecationTriggers($deprecationTriggers); + } + } + + private function configureIssueTriggerResolvers(Configuration $configuration): void + { + $classNames = $configuration->source()->issueTriggerResolvers(); + + foreach (array_reverse($classNames) as $className) { + if (!class_exists($className)) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Class %s cannot be used as an issue trigger resolver because it does not exist', + $className, + ), + ); + + continue; + } + + if (!in_array(Resolver::class, class_implements($className), true)) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Class %s cannot be used as an issue trigger resolver because it does not implement %s', + $className, + Resolver::class, + ), + ); + + continue; + } + + ErrorHandler::instance()->addIssueTriggerResolver(new $className); + } } private function preload(): void diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Command/Command.php b/app/vendor/phpunit/phpunit/src/TextUI/Command/Command.php index 4194551e4..faa9ebc0e 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Command/Command.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Command/Command.php @@ -12,7 +12,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Command { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/CheckPhpConfigurationCommand.php b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/CheckPhpConfigurationCommand.php index 7f684cc0e..66c2e41de 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/CheckPhpConfigurationCommand.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/CheckPhpConfigurationCommand.php @@ -11,6 +11,7 @@ use const E_ALL; use const PHP_EOL; +use function assert; use function extension_loaded; use function in_array; use function ini_get; @@ -100,7 +101,11 @@ private function ok(): string } // @codeCoverageIgnoreStart - return Color::colorizeTextBox('fg-green, bold', 'ok'); + $result = Color::colorizeTextBox('fg-green, bold', 'ok'); + + assert($result !== ''); + + return $result; // @codeCoverageIgnoreEnd } @@ -116,7 +121,11 @@ private function notOk(string $actualValue): string } // @codeCoverageIgnoreStart - return Color::colorizeTextBox('fg-red, bold', $message); + $result = Color::colorizeTextBox('fg-red, bold', $message); + + assert($result !== ''); + + return $result; // @codeCoverageIgnoreEnd } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestFilesCommand.php b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestFilesCommand.php index 6d7f875f4..dfe2da27c 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestFilesCommand.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestFilesCommand.php @@ -49,7 +49,7 @@ public function execute(): Result foreach ($this->tests as $test) { if ($test instanceof TestCase) { - $name = (new ReflectionClass($test))->getFileName(); + $name = new ReflectionClass($test)->getFileName(); assert($name !== false); diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestSuitesCommand.php b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestSuitesCommand.php index 7f5c3b51e..fcaf7765a 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestSuitesCommand.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestSuitesCommand.php @@ -69,10 +69,6 @@ private function warnAboutConflictingOptions(): string $configuration = Registry::get(); - if ($configuration->hasDefaultTestSuite()) { - $buffer .= 'The defaultTestSuite (XML) and --list-suites (CLI) options cannot be combined, only the default test suite is shown' . PHP_EOL; - } - if ($configuration->includeTestSuites() !== [] && !$configuration->hasDefaultTestSuite()) { $buffer .= 'The --testsuite and --list-suites options cannot be combined, --testsuite is ignored' . PHP_EOL; } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestsAsXmlCommand.php b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestsAsXmlCommand.php index b3d680143..a07c62cbb 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestsAsXmlCommand.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Command/Commands/ListTestsAsXmlCommand.php @@ -72,7 +72,7 @@ public function execute(): Result $writer->endElement(); } - $file = (new ReflectionClass($test))->getFileName(); + $file = new ReflectionClass($test)->getFileName(); assert($file !== false); diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Builder.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Builder.php index c3d0e2a4b..5822e377d 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Builder.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Builder.php @@ -35,6 +35,7 @@ final class Builder * @var non-empty-list */ private const array LONG_OPTIONS = [ + 'all', 'atleast-version=', 'bootstrap=', 'cache-result', @@ -57,6 +58,7 @@ final class Builder 'only-summary-for-coverage-text', 'show-uncovered-for-coverage-text', 'coverage-xml=', + 'exclude-source-from-xml-coverage', 'path-coverage', 'disallow-test-output', 'display-all-issues', @@ -106,7 +108,6 @@ final class Builder 'order-by=', 'process-isolation', 'do-not-report-useless-tests', - 'dont-report-useless-tests', 'random-order', 'random-order-seed=', 'reverse-order', @@ -154,6 +155,7 @@ final class Builder 'test-suffix=', 'testsuite=', 'exclude-testsuite=', + 'test-files-file=', 'log-events-text=', 'log-events-verbose-text=', 'version', @@ -190,6 +192,7 @@ public function fromParameters(array $parameters): Configuration ); } + $all = null; $atLeastVersion = null; $backupGlobals = null; $backupStaticProperties = null; @@ -214,6 +217,7 @@ public function fromParameters(array $parameters): Configuration $coverageTextShowUncoveredFiles = null; $coverageTextShowOnlySummary = null; $coverageXml = null; + $excludeSourceFromXmlCoverage = null; $pathCoverage = null; $defaultTimeLimit = null; $disableCodeCoverageIgnore = null; @@ -303,6 +307,7 @@ public function fromParameters(array $parameters): Configuration $testSuffixes = null; $testSuite = null; $excludeTestSuite = null; + $testFilesFile = null; $useDefaultConfiguration = true; $version = false; $logEventsText = null; @@ -318,6 +323,11 @@ public function fromParameters(array $parameters): Configuration $optionAllowedMultipleTimes = false; switch ($option[0]) { + case '--all': + $all = true; + + break; + case '--colors': $colors = \PHPUnit\TextUI\Configuration\Configuration::COLOR_AUTO; @@ -421,6 +431,11 @@ public function fromParameters(array $parameters): Configuration break; + case '--exclude-source-from-xml-coverage': + $excludeSourceFromXmlCoverage = true; + + break; + case '--path-coverage': $pathCoverage = true; @@ -471,6 +486,11 @@ public function fromParameters(array $parameters): Configuration break; + case '--test-files-file': + $testFilesFile = $option[1]; + + break; + case '--generate-baseline': $generateBaseline = $option[1]; @@ -1046,15 +1066,6 @@ public function fromParameters(array $parameters): Configuration break; - case '--dont-report-useless-tests': - EventFacade::emitter()->testRunnerTriggeredPhpunitDeprecation( - 'Option --dont-report-useless-tests is deprecated, use --do-not-report-useless-tests instead', - ); - - $reportUselessTests = false; - - break; - case '--strict-coverage': $strictCoverage = true; @@ -1240,8 +1251,16 @@ public function fromParameters(array $parameters): Configuration $extensions = null; } + if ($randomOrderSeed !== null && $executionOrder !== TestSuiteSorter::ORDER_RANDOMIZED) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + '--random-order-seed is only used when execution order is "random" (use --order-by random or --random-order)', + ); + } + return new Configuration( $options[1], + $testFilesFile, + $all, $atLeastVersion, $backupGlobals, $backupStaticProperties, @@ -1264,6 +1283,7 @@ public function fromParameters(array $parameters): Configuration $coverageTextShowUncoveredFiles, $coverageTextShowOnlySummary, $coverageXml, + $excludeSourceFromXmlCoverage, $pathCoverage, $warmCoverageCache, $defaultTimeLimit, diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Configuration.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Configuration.php index d2d0948f8..42409c02c 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Configuration.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Cli/Configuration.php @@ -22,6 +22,8 @@ * @var list */ private array $arguments; + private ?string $testFilesFile; + private ?bool $all; private ?string $atLeastVersion; private ?bool $backupGlobals; private ?bool $backupStaticProperties; @@ -49,6 +51,7 @@ private ?bool $coverageTextShowUncoveredFiles; private ?bool $coverageTextShowOnlySummary; private ?string $coverageXml; + private ?bool $excludeSourceFromXmlCoverage; private ?bool $pathCoverage; private bool $warmCoverageCache; private ?int $defaultTimeLimit; @@ -129,7 +132,7 @@ private ?array $iniSettings; private ?string $junitLogfile; private ?string $otrLogfile; - private ?bool $includeGitInformationInOtrLogfile; + private ?bool $includeGitInformation; private bool $listGroups; private bool $listSuites; private bool $listTestFiles; @@ -194,9 +197,11 @@ * @param ?non-empty-list $coverageFilter * @param ?non-empty-list $extensions */ - public function __construct(array $arguments, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, bool $checkPhpConfiguration, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $pathCoverage, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnPhpunitNotice, ?bool $failOnPhpunitWarning, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnPhpunitNotice, ?bool $doNotFailOnPhpunitWarning, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $excludeFilter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?string $otrLogfile, ?bool $includeGitInformation, bool $listGroups, bool $listSuites, bool $listTestFiles, bool $listTests, ?string $listTestsXml, ?bool $noCoverage, ?bool $noExtensions, ?bool $noOutput, ?bool $noProgress, ?bool $noResults, ?bool $noLogging, ?bool $processIsolation, ?int $randomOrderSeed, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?string $teamcityLogfile, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?array $testSuffixes, ?string $testSuite, ?string $excludeTestSuite, bool $useDefaultConfiguration, ?bool $displayDetailsOnAllIssues, ?bool $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnPhpunitDeprecations, ?bool $displayDetailsOnPhpunitNotices, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $testdoxPrinter, ?bool $testdoxPrinterSummary, bool $debug, bool $withTelemetry, ?array $extensions) + public function __construct(array $arguments, ?string $testFilesFile, ?bool $all, ?string $atLeastVersion, ?bool $backupGlobals, ?bool $backupStaticProperties, ?bool $beStrictAboutChangesToGlobalState, ?string $bootstrap, ?string $cacheDirectory, ?bool $cacheResult, bool $checkPhpConfiguration, bool $checkVersion, ?string $colors, null|int|string $columns, ?string $configurationFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4J, ?string $coverageHtml, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, ?bool $coverageTextShowUncoveredFiles, ?bool $coverageTextShowOnlySummary, ?string $coverageXml, ?bool $coverageXmlIncludeSource, ?bool $pathCoverage, bool $warmCoverageCache, ?int $defaultTimeLimit, ?bool $disableCodeCoverageIgnore, ?bool $disallowTestOutput, ?bool $enforceTimeLimit, ?array $excludeGroups, ?int $executionOrder, ?int $executionOrderDefects, ?bool $failOnAllIssues, ?bool $failOnDeprecation, ?bool $failOnPhpunitDeprecation, ?bool $failOnPhpunitNotice, ?bool $failOnPhpunitWarning, ?bool $failOnEmptyTestSuite, ?bool $failOnIncomplete, ?bool $failOnNotice, ?bool $failOnRisky, ?bool $failOnSkipped, ?bool $failOnWarning, ?bool $doNotFailOnDeprecation, ?bool $doNotFailOnPhpunitDeprecation, ?bool $doNotFailOnPhpunitNotice, ?bool $doNotFailOnPhpunitWarning, ?bool $doNotFailOnEmptyTestSuite, ?bool $doNotFailOnIncomplete, ?bool $doNotFailOnNotice, ?bool $doNotFailOnRisky, ?bool $doNotFailOnSkipped, ?bool $doNotFailOnWarning, ?bool $stopOnDefect, ?bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, ?bool $stopOnError, ?bool $stopOnFailure, ?bool $stopOnIncomplete, ?bool $stopOnNotice, ?bool $stopOnRisky, ?bool $stopOnSkipped, ?bool $stopOnWarning, ?string $filter, ?string $excludeFilter, ?string $generateBaseline, ?string $useBaseline, bool $ignoreBaseline, bool $generateConfiguration, bool $migrateConfiguration, ?array $groups, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, bool $help, ?string $includePath, ?array $iniSettings, ?string $junitLogfile, ?string $otrLogfile, ?bool $includeGitInformation, bool $listGroups, bool $listSuites, bool $listTestFiles, bool $listTests, ?string $listTestsXml, ?bool $noCoverage, ?bool $noExtensions, ?bool $noOutput, ?bool $noProgress, ?bool $noResults, ?bool $noLogging, ?bool $processIsolation, ?int $randomOrderSeed, ?bool $reportUselessTests, ?bool $resolveDependencies, ?bool $reverseList, ?bool $stderr, ?bool $strictCoverage, ?string $teamcityLogfile, ?string $testdoxHtmlFile, ?string $testdoxTextFile, ?array $testSuffixes, ?string $testSuite, ?string $excludeTestSuite, bool $useDefaultConfiguration, ?bool $displayDetailsOnAllIssues, ?bool $displayDetailsOnIncompleteTests, ?bool $displayDetailsOnSkippedTests, ?bool $displayDetailsOnTestsThatTriggerDeprecations, ?bool $displayDetailsOnPhpunitDeprecations, ?bool $displayDetailsOnPhpunitNotices, ?bool $displayDetailsOnTestsThatTriggerErrors, ?bool $displayDetailsOnTestsThatTriggerNotices, ?bool $displayDetailsOnTestsThatTriggerWarnings, bool $version, ?array $coverageFilter, ?string $logEventsText, ?string $logEventsVerboseText, ?bool $printerTeamCity, ?bool $testdoxPrinter, ?bool $testdoxPrinterSummary, bool $debug, bool $withTelemetry, ?array $extensions) { $this->arguments = $arguments; + $this->testFilesFile = $testFilesFile; + $this->all = $all; $this->atLeastVersion = $atLeastVersion; $this->backupGlobals = $backupGlobals; $this->backupStaticProperties = $backupStaticProperties; @@ -220,6 +225,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba $this->coverageTextShowUncoveredFiles = $coverageTextShowUncoveredFiles; $this->coverageTextShowOnlySummary = $coverageTextShowOnlySummary; $this->coverageXml = $coverageXml; + $this->excludeSourceFromXmlCoverage = $coverageXmlIncludeSource; $this->pathCoverage = $pathCoverage; $this->warmCoverageCache = $warmCoverageCache; $this->defaultTimeLimit = $defaultTimeLimit; @@ -276,7 +282,7 @@ public function __construct(array $arguments, ?string $atLeastVersion, ?bool $ba $this->iniSettings = $iniSettings; $this->junitLogfile = $junitLogfile; $this->otrLogfile = $otrLogfile; - $this->includeGitInformationInOtrLogfile = $includeGitInformation; + $this->includeGitInformation = $includeGitInformation; $this->listGroups = $listGroups; $this->listSuites = $listSuites; $this->listTestFiles = $listTestFiles; @@ -330,6 +336,46 @@ public function arguments(): array return $this->arguments; } + /** + * @phpstan-assert-if-true !null $this->testFilesFile + */ + public function hasTestFilesFile(): bool + { + return $this->testFilesFile !== null; + } + + /** + * @throws Exception + */ + public function testFilesFile(): string + { + if (!$this->hasTestFilesFile()) { + throw new Exception; + } + + return $this->testFilesFile; + } + + /** + * @phpstan-assert-if-true !null $this->all + */ + public function hasAll(): bool + { + return $this->all !== null; + } + + /** + * @throws Exception + */ + public function all(): bool + { + if (!$this->hasAll()) { + throw new Exception; + } + + return $this->all; + } + /** * @phpstan-assert-if-true !null $this->atLeastVersion */ @@ -762,6 +808,26 @@ public function coverageXml(): string return $this->coverageXml; } + /** + * @phpstan-assert-if-true !null $this->excludeSourceFromXmlCoverage + */ + public function hasExcludeSourceFromXmlCoverage(): bool + { + return $this->excludeSourceFromXmlCoverage !== null; + } + + /** + * @throws Exception + */ + public function excludeSourceFromXmlCoverage(): bool + { + if (!$this->hasExcludeSourceFromXmlCoverage()) { + throw new Exception; + } + + return $this->excludeSourceFromXmlCoverage; + } + /** * @phpstan-assert-if-true !null $this->pathCoverage */ @@ -1820,23 +1886,23 @@ public function otrLogfile(): string } /** - * @phpstan-assert-if-true !null $this->includeGitInformationInOtrLogfile + * @phpstan-assert-if-true !null $this->includeGitInformation */ - public function hasIncludeGitInformationInOtrLogfile(): bool + public function hasIncludeGitInformation(): bool { - return $this->includeGitInformationInOtrLogfile !== null; + return $this->includeGitInformation !== null; } /** * @throws Exception */ - public function includeGitInformationInOtrLogfile(): bool + public function includeGitInformation(): bool { - if (!$this->hasIncludeGitInformationInOtrLogfile()) { + if (!$this->hasIncludeGitInformation()) { throw new Exception; } - return $this->includeGitInformationInOtrLogfile; + return $this->includeGitInformation; } public function listGroups(): bool diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/CodeCoverageFilterRegistry.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/CodeCoverageFilterRegistry.php index 7051d2840..5a570b2f5 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/CodeCoverageFilterRegistry.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/CodeCoverageFilterRegistry.php @@ -62,7 +62,7 @@ public function init(Configuration $configuration, bool $force = false): void $this->filter = new Filter; if ($configuration->source()->notEmpty()) { - $this->filter->includeFiles(array_keys((new SourceMapper)->map($configuration->source()))); + $this->filter->includeFiles(array_keys((new SourceMapper)->mapForCodeCoverage($configuration->source()))); $this->configured = true; } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Configuration.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Configuration.php index a6dfe62aa..c77fa952b 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Configuration.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Configuration.php @@ -27,6 +27,7 @@ * @var list */ private array $cliArguments; + private ?string $testFilesFile; private ?string $configurationFile; private ?string $bootstrap; @@ -47,10 +48,23 @@ private int $coverageHtmlLowUpperBound; private int $coverageHtmlHighLowerBound; private string $coverageHtmlColorSuccessLow; + private string $coverageHtmlColorSuccessLowDark; private string $coverageHtmlColorSuccessMedium; + private string $coverageHtmlColorSuccessMediumDark; private string $coverageHtmlColorSuccessHigh; + private string $coverageHtmlColorSuccessHighDark; + private string $coverageHtmlColorSuccessBar; + private string $coverageHtmlColorSuccessBarDark; private string $coverageHtmlColorWarning; + private string $coverageHtmlColorWarningDark; + private string $coverageHtmlColorWarningBar; + private string $coverageHtmlColorWarningBarDark; private string $coverageHtmlColorDanger; + private string $coverageHtmlColorDangerDark; + private string $coverageHtmlColorDangerBar; + private string $coverageHtmlColorDangerBarDark; + private string $coverageHtmlColorBreadcrumbs; + private string $coverageHtmlColorBreadcrumbsDark; private ?string $coverageHtmlCustomCssFile; private ?string $coverageOpenClover; private ?string $coveragePhp; @@ -58,6 +72,7 @@ private bool $coverageTextShowUncoveredFiles; private bool $coverageTextShowOnlySummary; private ?string $coverageXml; + private bool $coverageXmlIncludeSource; private string $testResultCacheFile; private bool $ignoreDeprecatedCodeUnitsFromCodeCoverage; private bool $disableCodeCoverageIgnore; @@ -129,6 +144,7 @@ private bool $displayDetailsOnTestsThatTriggerWarnings; private bool $reverseDefectList; private bool $requireCoverageMetadata; + private bool $requireSealedMockObjects; private bool $noProgress; private bool $noResults; private bool $noOutput; @@ -138,6 +154,7 @@ private ?string $logfileTeamcity; private ?string $logfileJunit; private ?string $logfileOtr; + private bool $includeGitInformation; private bool $includeGitInformationInOtrLogfile; private ?string $logfileTestdoxHtml; private ?string $logfileTestdoxText; @@ -179,6 +196,7 @@ private string $includeTestSuite; private string $excludeTestSuite; private ?string $defaultTestSuite; + private bool $ignoreTestSelectionInXmlConfiguration; /** * @var non-empty-list @@ -214,9 +232,10 @@ * @param null|non-empty-string $generateBaseline * @param non-negative-int $shortenArraysForExportThreshold */ - public function __construct(array $cliArguments, ?string $configurationFile, ?string $bootstrap, array $bootstrapForTestSuite, bool $cacheResult, ?string $cacheDirectory, ?string $coverageCacheDirectory, Source $source, string $testResultCacheFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4j, int $coverageCrap4jThreshold, ?string $coverageHtml, int $coverageHtmlLowUpperBound, int $coverageHtmlHighLowerBound, string $coverageHtmlColorSuccessLow, string $coverageHtmlColorSuccessMedium, string $coverageHtmlColorSuccessHigh, string $coverageHtmlColorWarning, string $coverageHtmlColorDanger, ?string $coverageHtmlCustomCssFile, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, bool $coverageTextShowUncoveredFiles, bool $coverageTextShowOnlySummary, ?string $coverageXml, bool $pathCoverage, bool $ignoreDeprecatedCodeUnitsFromCodeCoverage, bool $disableCodeCoverageIgnore, bool $failOnAllIssues, bool $failOnDeprecation, bool $failOnPhpunitDeprecation, bool $failOnPhpunitNotice, bool $failOnPhpunitWarning, bool $failOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnNotice, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, bool $doNotFailOnDeprecation, bool $doNotFailOnPhpunitDeprecation, bool $doNotFailOnPhpunitNotice, bool $doNotFailOnPhpunitWarning, bool $doNotFailOnEmptyTestSuite, bool $doNotFailOnIncomplete, bool $doNotFailOnNotice, bool $doNotFailOnRisky, bool $doNotFailOnSkipped, bool $doNotFailOnWarning, bool $stopOnDefect, bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, bool $stopOnError, bool $stopOnFailure, bool $stopOnIncomplete, bool $stopOnNotice, bool $stopOnRisky, bool $stopOnSkipped, bool $stopOnWarning, bool $outputToStandardErrorStream, int $columns, bool $noExtensions, ?string $pharExtensionDirectory, array $extensionBootstrappers, bool $backupGlobals, bool $backupStaticProperties, bool $beStrictAboutChangesToGlobalState, bool $colors, bool $processIsolation, bool $enforceTimeLimit, int $defaultTimeLimit, int $timeoutForSmallTests, int $timeoutForMediumTests, int $timeoutForLargeTests, bool $reportUselessTests, bool $strictCoverage, bool $disallowTestOutput, bool $displayDetailsOnAllIssues, bool $displayDetailsOnIncompleteTests, bool $displayDetailsOnSkippedTests, bool $displayDetailsOnTestsThatTriggerDeprecations, bool $displayDetailsOnPhpunitDeprecations, bool $displayDetailsOnPhpunitNotices, bool $displayDetailsOnTestsThatTriggerErrors, bool $displayDetailsOnTestsThatTriggerNotices, bool $displayDetailsOnTestsThatTriggerWarnings, bool $reverseDefectList, bool $requireCoverageMetadata, bool $noProgress, bool $noResults, bool $noOutput, int $executionOrder, int $executionOrderDefects, bool $resolveDependencies, ?string $logfileTeamcity, ?string $logfileJunit, ?string $logfileOtr, bool $includeGitInformationInOtrLogfile, ?string $logfileTestdoxHtml, ?string $logfileTestdoxText, ?string $logEventsText, ?string $logEventsVerboseText, bool $teamCityOutput, bool $testDoxOutput, bool $testDoxOutputSummary, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, ?string $filter, ?string $excludeFilter, array $groups, array $excludeGroups, int $randomOrderSeed, bool $includeUncoveredFiles, TestSuiteCollection $testSuite, string $includeTestSuite, string $excludeTestSuite, ?string $defaultTestSuite, array $testSuffixes, Php $php, bool $controlGarbageCollector, int $numberOfTestsBeforeGarbageCollection, ?string $generateBaseline, bool $debug, bool $withTelemetry, int $shortenArraysForExportThreshold) + public function __construct(array $cliArguments, ?string $testFilesFile, ?string $configurationFile, ?string $bootstrap, array $bootstrapForTestSuite, bool $cacheResult, ?string $cacheDirectory, ?string $coverageCacheDirectory, Source $source, string $testResultCacheFile, ?string $coverageClover, ?string $coverageCobertura, ?string $coverageCrap4j, int $coverageCrap4jThreshold, ?string $coverageHtml, int $coverageHtmlLowUpperBound, int $coverageHtmlHighLowerBound, string $coverageHtmlColorSuccessLow, string $coverageHtmlColorSuccessLowDark, string $coverageHtmlColorSuccessMedium, string $coverageHtmlColorSuccessMediumDark, string $coverageHtmlColorSuccessHigh, string $coverageHtmlColorSuccessHighDark, string $coverageHtmlColorSuccessBar, string $coverageHtmlColorSuccessBarDark, string $coverageHtmlColorWarning, string $coverageHtmlColorWarningDark, string $coverageHtmlColorWarningBar, string $coverageHtmlColorWarningBarDark, string $coverageHtmlColorDanger, string $coverageHtmlColorDangerDark, string $coverageHtmlColorDangerBar, string $coverageHtmlColorDangerBarDark, string $coverageHtmlColorBreadcrumbs, string $coverageHtmlColorBreadcrumbsDark, ?string $coverageHtmlCustomCssFile, ?string $coverageOpenClover, ?string $coveragePhp, ?string $coverageText, bool $coverageTextShowUncoveredFiles, bool $coverageTextShowOnlySummary, ?string $coverageXml, bool $coverageXmlIncludeSource, bool $pathCoverage, bool $ignoreDeprecatedCodeUnitsFromCodeCoverage, bool $disableCodeCoverageIgnore, bool $failOnAllIssues, bool $failOnDeprecation, bool $failOnPhpunitDeprecation, bool $failOnPhpunitNotice, bool $failOnPhpunitWarning, bool $failOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnNotice, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, bool $doNotFailOnDeprecation, bool $doNotFailOnPhpunitDeprecation, bool $doNotFailOnPhpunitNotice, bool $doNotFailOnPhpunitWarning, bool $doNotFailOnEmptyTestSuite, bool $doNotFailOnIncomplete, bool $doNotFailOnNotice, bool $doNotFailOnRisky, bool $doNotFailOnSkipped, bool $doNotFailOnWarning, bool $stopOnDefect, bool $stopOnDeprecation, ?string $specificDeprecationToStopOn, bool $stopOnError, bool $stopOnFailure, bool $stopOnIncomplete, bool $stopOnNotice, bool $stopOnRisky, bool $stopOnSkipped, bool $stopOnWarning, bool $outputToStandardErrorStream, int $columns, bool $noExtensions, ?string $pharExtensionDirectory, array $extensionBootstrappers, bool $backupGlobals, bool $backupStaticProperties, bool $beStrictAboutChangesToGlobalState, bool $colors, bool $processIsolation, bool $enforceTimeLimit, int $defaultTimeLimit, int $timeoutForSmallTests, int $timeoutForMediumTests, int $timeoutForLargeTests, bool $reportUselessTests, bool $strictCoverage, bool $disallowTestOutput, bool $displayDetailsOnAllIssues, bool $displayDetailsOnIncompleteTests, bool $displayDetailsOnSkippedTests, bool $displayDetailsOnTestsThatTriggerDeprecations, bool $displayDetailsOnPhpunitDeprecations, bool $displayDetailsOnPhpunitNotices, bool $displayDetailsOnTestsThatTriggerErrors, bool $displayDetailsOnTestsThatTriggerNotices, bool $displayDetailsOnTestsThatTriggerWarnings, bool $reverseDefectList, bool $requireCoverageMetadata, bool $requireSealedMockObjects, bool $noProgress, bool $noResults, bool $noOutput, int $executionOrder, int $executionOrderDefects, bool $resolveDependencies, ?string $logfileTeamcity, ?string $logfileJunit, ?string $logfileOtr, bool $includeGitInformation, bool $includeGitInformationInOtrLogfile, ?string $logfileTestdoxHtml, ?string $logfileTestdoxText, ?string $logEventsText, ?string $logEventsVerboseText, bool $teamCityOutput, bool $testDoxOutput, bool $testDoxOutputSummary, ?array $testsCovering, ?array $testsUsing, ?array $testsRequiringPhpExtension, ?string $filter, ?string $excludeFilter, array $groups, array $excludeGroups, int $randomOrderSeed, bool $includeUncoveredFiles, TestSuiteCollection $testSuite, string $includeTestSuite, string $excludeTestSuite, ?string $defaultTestSuite, bool $ignoreTestSelectionInXmlConfiguration, array $testSuffixes, Php $php, bool $controlGarbageCollector, int $numberOfTestsBeforeGarbageCollection, ?string $generateBaseline, bool $debug, bool $withTelemetry, int $shortenArraysForExportThreshold) { $this->cliArguments = $cliArguments; + $this->testFilesFile = $testFilesFile; $this->configurationFile = $configurationFile; $this->bootstrap = $bootstrap; $this->bootstrapForTestSuite = $bootstrapForTestSuite; @@ -233,10 +252,23 @@ public function __construct(array $cliArguments, ?string $configurationFile, ?st $this->coverageHtmlLowUpperBound = $coverageHtmlLowUpperBound; $this->coverageHtmlHighLowerBound = $coverageHtmlHighLowerBound; $this->coverageHtmlColorSuccessLow = $coverageHtmlColorSuccessLow; + $this->coverageHtmlColorSuccessLowDark = $coverageHtmlColorSuccessLowDark; $this->coverageHtmlColorSuccessMedium = $coverageHtmlColorSuccessMedium; + $this->coverageHtmlColorSuccessMediumDark = $coverageHtmlColorSuccessMediumDark; $this->coverageHtmlColorSuccessHigh = $coverageHtmlColorSuccessHigh; + $this->coverageHtmlColorSuccessHighDark = $coverageHtmlColorSuccessHighDark; + $this->coverageHtmlColorSuccessBar = $coverageHtmlColorSuccessBar; + $this->coverageHtmlColorSuccessBarDark = $coverageHtmlColorSuccessBarDark; $this->coverageHtmlColorWarning = $coverageHtmlColorWarning; + $this->coverageHtmlColorWarningDark = $coverageHtmlColorWarningDark; + $this->coverageHtmlColorWarningBar = $coverageHtmlColorWarningBar; + $this->coverageHtmlColorWarningBarDark = $coverageHtmlColorWarningBarDark; $this->coverageHtmlColorDanger = $coverageHtmlColorDanger; + $this->coverageHtmlColorDangerDark = $coverageHtmlColorDangerDark; + $this->coverageHtmlColorDangerBar = $coverageHtmlColorDangerBar; + $this->coverageHtmlColorDangerBarDark = $coverageHtmlColorDangerBarDark; + $this->coverageHtmlColorBreadcrumbs = $coverageHtmlColorBreadcrumbs; + $this->coverageHtmlColorBreadcrumbsDark = $coverageHtmlColorBreadcrumbsDark; $this->coverageHtmlCustomCssFile = $coverageHtmlCustomCssFile; $this->coverageOpenClover = $coverageOpenClover; $this->coveragePhp = $coveragePhp; @@ -244,6 +276,7 @@ public function __construct(array $cliArguments, ?string $configurationFile, ?st $this->coverageTextShowUncoveredFiles = $coverageTextShowUncoveredFiles; $this->coverageTextShowOnlySummary = $coverageTextShowOnlySummary; $this->coverageXml = $coverageXml; + $this->coverageXmlIncludeSource = $coverageXmlIncludeSource; $this->pathCoverage = $pathCoverage; $this->ignoreDeprecatedCodeUnitsFromCodeCoverage = $ignoreDeprecatedCodeUnitsFromCodeCoverage; $this->disableCodeCoverageIgnore = $disableCodeCoverageIgnore; @@ -307,6 +340,7 @@ public function __construct(array $cliArguments, ?string $configurationFile, ?st $this->displayDetailsOnTestsThatTriggerWarnings = $displayDetailsOnTestsThatTriggerWarnings; $this->reverseDefectList = $reverseDefectList; $this->requireCoverageMetadata = $requireCoverageMetadata; + $this->requireSealedMockObjects = $requireSealedMockObjects; $this->noProgress = $noProgress; $this->noResults = $noResults; $this->noOutput = $noOutput; @@ -316,6 +350,7 @@ public function __construct(array $cliArguments, ?string $configurationFile, ?st $this->logfileTeamcity = $logfileTeamcity; $this->logfileJunit = $logfileJunit; $this->logfileOtr = $logfileOtr; + $this->includeGitInformation = $includeGitInformation; $this->includeGitInformationInOtrLogfile = $includeGitInformationInOtrLogfile; $this->logfileTestdoxHtml = $logfileTestdoxHtml; $this->logfileTestdoxText = $logfileTestdoxText; @@ -337,6 +372,7 @@ public function __construct(array $cliArguments, ?string $configurationFile, ?st $this->includeTestSuite = $includeTestSuite; $this->excludeTestSuite = $excludeTestSuite; $this->defaultTestSuite = $defaultTestSuite; + $this->ignoreTestSelectionInXmlConfiguration = $ignoreTestSelectionInXmlConfiguration; $this->testSuffixes = $testSuffixes; $this->php = $php; $this->controlGarbageCollector = $controlGarbageCollector; @@ -363,6 +399,26 @@ public function cliArguments(): array return $this->cliArguments; } + /** + * @phpstan-assert-if-true !null $this->testFilesFile + */ + public function hasTestFilesFile(): bool + { + return $this->testFilesFile !== null; + } + + /** + * @throws NoTestFilesFileException + */ + public function testFilesFile(): string + { + if (!$this->hasTestFilesFile()) { + throw new NoTestFilesFileException; + } + + return $this->testFilesFile; + } + /** * @phpstan-assert-if-true !null $this->configurationFile */ @@ -593,26 +649,91 @@ public function coverageHtmlColorSuccessLow(): string return $this->coverageHtmlColorSuccessLow; } + public function coverageHtmlColorSuccessLowDark(): string + { + return $this->coverageHtmlColorSuccessLowDark; + } + public function coverageHtmlColorSuccessMedium(): string { return $this->coverageHtmlColorSuccessMedium; } + public function coverageHtmlColorSuccessMediumDark(): string + { + return $this->coverageHtmlColorSuccessMediumDark; + } + public function coverageHtmlColorSuccessHigh(): string { return $this->coverageHtmlColorSuccessHigh; } + public function coverageHtmlColorSuccessHighDark(): string + { + return $this->coverageHtmlColorSuccessHighDark; + } + + public function coverageHtmlColorSuccessBar(): string + { + return $this->coverageHtmlColorSuccessBar; + } + + public function coverageHtmlColorSuccessBarDark(): string + { + return $this->coverageHtmlColorSuccessBarDark; + } + public function coverageHtmlColorWarning(): string { return $this->coverageHtmlColorWarning; } + public function coverageHtmlColorWarningDark(): string + { + return $this->coverageHtmlColorWarningDark; + } + + public function coverageHtmlColorWarningBar(): string + { + return $this->coverageHtmlColorWarningBar; + } + + public function coverageHtmlColorWarningBarDark(): string + { + return $this->coverageHtmlColorWarningBarDark; + } + public function coverageHtmlColorDanger(): string { return $this->coverageHtmlColorDanger; } + public function coverageHtmlColorDangerDark(): string + { + return $this->coverageHtmlColorDangerDark; + } + + public function coverageHtmlColorDangerBar(): string + { + return $this->coverageHtmlColorDangerBar; + } + + public function coverageHtmlColorDangerBarDark(): string + { + return $this->coverageHtmlColorDangerBarDark; + } + + public function coverageHtmlColorBreadcrumbs(): string + { + return $this->coverageHtmlColorBreadcrumbs; + } + + public function coverageHtmlColorBreadcrumbsDark(): string + { + return $this->coverageHtmlColorBreadcrumbsDark; + } + /** * @phpstan-assert-if-true !null $this->coverageHtmlCustomCssFile */ @@ -723,6 +844,11 @@ public function coverageXml(): string return $this->coverageXml; } + public function coverageXmlIncludeSource(): bool + { + return $this->coverageXmlIncludeSource; + } + public function failOnAllIssues(): bool { return $this->failOnAllIssues; @@ -1058,6 +1184,11 @@ public function requireCoverageMetadata(): bool return $this->requireCoverageMetadata; } + public function requireSealedMockObjects(): bool + { + return $this->requireSealedMockObjects; + } + public function noProgress(): bool { return $this->noProgress; @@ -1153,6 +1284,11 @@ public function includeGitInformationInOtrLogfile(): bool return $this->includeGitInformationInOtrLogfile; } + public function includeGitInformation(): bool + { + return $this->includeGitInformation; + } + /** * @phpstan-assert-if-true !null $this->logfileTestdoxHtml */ @@ -1413,14 +1549,6 @@ public function testSuite(): TestSuiteCollection return $this->testSuite; } - /** - * @deprecated Use includeTestSuites() instead - */ - public function includeTestSuite(): string - { - return $this->includeTestSuite; - } - /** * @return list */ @@ -1433,14 +1561,6 @@ public function includeTestSuites(): array return explode(',', $this->includeTestSuite); } - /** - * @deprecated Use excludeTestSuites() instead - */ - public function excludeTestSuite(): string - { - return $this->excludeTestSuite; - } - /** * @return list */ @@ -1473,6 +1593,11 @@ public function defaultTestSuite(): string return $this->defaultTestSuite; } + public function ignoreTestSelectionInXmlConfiguration(): bool + { + return $this->ignoreTestSelectionInXmlConfiguration; + } + /** * @return non-empty-list */ diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Exception/NoHtmlCoverageTargetException.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Exception/NoHtmlCoverageTargetException.php new file mode 100644 index 000000000..3a2b3dee5 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Exception/NoHtmlCoverageTargetException.php @@ -0,0 +1,21 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\TextUI\Configuration; + +use RuntimeException; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class NoHtmlCoverageTargetException extends RuntimeException implements Exception +{ +} diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Exception/NoTestFilesFileException.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Exception/NoTestFilesFileException.php new file mode 100644 index 000000000..86a862086 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Exception/NoTestFilesFileException.php @@ -0,0 +1,21 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\TextUI\Configuration; + +use RuntimeException; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final class NoTestFilesFileException extends RuntimeException implements Exception +{ +} diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Merger.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Merger.php index 578031402..5f7def9f9 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Merger.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Merger.php @@ -12,11 +12,14 @@ use const DIRECTORY_SEPARATOR; use const PATH_SEPARATOR; use function array_diff; +use function array_key_exists; +use function array_values; use function assert; use function dirname; use function explode; use function is_int; use function realpath; +use function sprintf; use function time; use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Runner\TestSuiteSorter; @@ -45,6 +48,12 @@ */ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlConfiguration): Configuration { + $testFilesFile = null; + + if ($cliConfiguration->hasTestFilesFile()) { + $testFilesFile = $cliConfiguration->testFilesFile(); + } + $configurationFile = null; if ($xmlConfiguration->wasLoadedFromFile()) { @@ -133,8 +142,10 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC if ($cliConfiguration->hasFailOnEmptyTestSuite()) { $failOnEmptyTestSuite = $cliConfiguration->failOnEmptyTestSuite(); - } else { + } elseif ($xmlConfiguration->phpunit()->hasFailOnEmptyTestSuite()) { $failOnEmptyTestSuite = $xmlConfiguration->phpunit()->failOnEmptyTestSuite(); + } else { + $failOnEmptyTestSuite = $this->hasExplicitTestSelection($cliConfiguration); } if ($cliConfiguration->hasFailOnIncomplete()) { @@ -329,7 +340,16 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC if ($cliConfiguration->hasExtensions()) { foreach ($cliConfiguration->extensions() as $extension) { - $extensionBootstrappers[] = [ + if (array_key_exists($extension, $extensionBootstrappers)) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Extension "%s" is configured more than once on the command line', + $extension, + ), + ); + } + + $extensionBootstrappers[$extension] = [ 'className' => $extension, 'parameters' => [], ]; @@ -337,7 +357,16 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC } foreach ($xmlConfiguration->extensions() as $extension) { - $extensionBootstrappers[] = [ + if (array_key_exists($extension->className(), $extensionBootstrappers)) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Extension "%s" is configured more than once', + $extension->className(), + ), + ); + } + + $extensionBootstrappers[$extension->className()] = [ 'className' => $extension->className(), 'parameters' => $extension->parameters(), ]; @@ -352,26 +381,40 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $defaultColors = Colors::default(); $defaultThresholds = Thresholds::default(); - $coverageClover = null; - $coverageCobertura = null; - $coverageCrap4j = null; - $coverageCrap4jThreshold = 30; - $coverageHtml = null; - $coverageHtmlLowUpperBound = $defaultThresholds->lowUpperBound(); - $coverageHtmlHighLowerBound = $defaultThresholds->highLowerBound(); - $coverageHtmlColorSuccessLow = $defaultColors->successLow(); - $coverageHtmlColorSuccessMedium = $defaultColors->successMedium(); - $coverageHtmlColorSuccessHigh = $defaultColors->successHigh(); - $coverageHtmlColorWarning = $defaultColors->warning(); - $coverageHtmlColorDanger = $defaultColors->danger(); - $coverageHtmlCustomCssFile = null; - $coverageOpenClover = null; - $coveragePhp = null; - $coverageText = null; - $coverageTextShowUncoveredFiles = false; - $coverageTextShowOnlySummary = false; - $coverageXml = null; - $coverageFromXmlConfiguration = true; + $coverageClover = null; + $coverageCobertura = null; + $coverageCrap4j = null; + $coverageCrap4jThreshold = 30; + $coverageHtml = null; + $coverageHtmlLowUpperBound = $defaultThresholds->lowUpperBound(); + $coverageHtmlHighLowerBound = $defaultThresholds->highLowerBound(); + $coverageHtmlColorSuccessLow = $defaultColors->successLow(); + $coverageHtmlColorSuccessLowDark = $defaultColors->successLowDark(); + $coverageHtmlColorSuccessMedium = $defaultColors->successMedium(); + $coverageHtmlColorSuccessMediumDark = $defaultColors->successMediumDark(); + $coverageHtmlColorSuccessHigh = $defaultColors->successHigh(); + $coverageHtmlColorSuccessHighDark = $defaultColors->successHighDark(); + $coverageHtmlColorSuccessBar = $defaultColors->successBar(); + $coverageHtmlColorSuccessBarDark = $defaultColors->successBarDark(); + $coverageHtmlColorWarning = $defaultColors->warning(); + $coverageHtmlColorWarningDark = $defaultColors->warningDark(); + $coverageHtmlColorWarningBar = $defaultColors->warningBar(); + $coverageHtmlColorWarningBarDark = $defaultColors->warningBarDark(); + $coverageHtmlColorDanger = $defaultColors->danger(); + $coverageHtmlColorDangerDark = $defaultColors->dangerDark(); + $coverageHtmlColorDangerBar = $defaultColors->dangerBar(); + $coverageHtmlColorDangerBarDark = $defaultColors->dangerBarDark(); + $coverageHtmlColorBreadcrumbs = $defaultColors->breadcrumbs(); + $coverageHtmlColorBreadcrumbsDark = $defaultColors->breadcrumbsDark(); + $coverageHtmlCustomCssFile = null; + $coverageOpenClover = null; + $coveragePhp = null; + $coverageText = null; + $coverageTextShowUncoveredFiles = false; + $coverageTextShowOnlySummary = false; + $coverageXml = null; + $coverageXmlIncludeSource = true; + $coverageFromXmlConfiguration = true; if ($cliConfiguration->hasNoCoverage() && $cliConfiguration->noCoverage()) { $coverageFromXmlConfiguration = false; @@ -408,11 +451,24 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $coverageHtmlHighLowerBound = $defaultThresholds->highLowerBound(); } - $coverageHtmlColorSuccessLow = $xmlConfiguration->codeCoverage()->html()->colorSuccessLow(); - $coverageHtmlColorSuccessMedium = $xmlConfiguration->codeCoverage()->html()->colorSuccessMedium(); - $coverageHtmlColorSuccessHigh = $xmlConfiguration->codeCoverage()->html()->colorSuccessHigh(); - $coverageHtmlColorWarning = $xmlConfiguration->codeCoverage()->html()->colorWarning(); - $coverageHtmlColorDanger = $xmlConfiguration->codeCoverage()->html()->colorDanger(); + $coverageHtmlColorSuccessLow = $xmlConfiguration->codeCoverage()->html()->colorSuccessLow(); + $coverageHtmlColorSuccessLowDark = $xmlConfiguration->codeCoverage()->html()->colorSuccessLowDark(); + $coverageHtmlColorSuccessMedium = $xmlConfiguration->codeCoverage()->html()->colorSuccessMedium(); + $coverageHtmlColorSuccessMediumDark = $xmlConfiguration->codeCoverage()->html()->colorSuccessMediumDark(); + $coverageHtmlColorSuccessHigh = $xmlConfiguration->codeCoverage()->html()->colorSuccessHigh(); + $coverageHtmlColorSuccessHighDark = $xmlConfiguration->codeCoverage()->html()->colorSuccessHighDark(); + $coverageHtmlColorSuccessBar = $xmlConfiguration->codeCoverage()->html()->colorSuccessBar(); + $coverageHtmlColorSuccessBarDark = $xmlConfiguration->codeCoverage()->html()->colorSuccessBarDark(); + $coverageHtmlColorWarning = $xmlConfiguration->codeCoverage()->html()->colorWarning(); + $coverageHtmlColorWarningDark = $xmlConfiguration->codeCoverage()->html()->colorWarningDark(); + $coverageHtmlColorWarningBar = $xmlConfiguration->codeCoverage()->html()->colorWarningBar(); + $coverageHtmlColorWarningBarDark = $xmlConfiguration->codeCoverage()->html()->colorWarningBarDark(); + $coverageHtmlColorDanger = $xmlConfiguration->codeCoverage()->html()->colorDanger(); + $coverageHtmlColorDangerDark = $xmlConfiguration->codeCoverage()->html()->colorDangerDark(); + $coverageHtmlColorDangerBar = $xmlConfiguration->codeCoverage()->html()->colorDangerBar(); + $coverageHtmlColorDangerBarDark = $xmlConfiguration->codeCoverage()->html()->colorDangerBarDark(); + $coverageHtmlColorBreadcrumbs = $xmlConfiguration->codeCoverage()->html()->colorBreadcrumbs(); + $coverageHtmlColorBreadcrumbsDark = $xmlConfiguration->codeCoverage()->html()->colorBreadcrumbsDark(); if ($xmlConfiguration->codeCoverage()->html()->hasCustomCssFile()) { $coverageHtmlCustomCssFile = $xmlConfiguration->codeCoverage()->html()->customCssFile(); @@ -421,7 +477,7 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC if ($cliConfiguration->hasCoverageHtml()) { $coverageHtml = $cliConfiguration->coverageHtml(); - } elseif ($coverageFromXmlConfiguration && $xmlConfiguration->codeCoverage()->hasHtml()) { + } elseif ($coverageFromXmlConfiguration && $xmlConfiguration->codeCoverage()->hasHtml() && $xmlConfiguration->codeCoverage()->html()->hasTarget()) { $coverageHtml = $xmlConfiguration->codeCoverage()->html()->target()->path(); } @@ -462,6 +518,12 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $coverageXml = $xmlConfiguration->codeCoverage()->xml()->target()->path(); } + if ($cliConfiguration->hasExcludeSourceFromXmlCoverage()) { + $coverageXmlIncludeSource = !$cliConfiguration->excludeSourceFromXmlCoverage(); + } elseif ($coverageFromXmlConfiguration && $xmlConfiguration->codeCoverage()->hasXml()) { + $coverageXmlIncludeSource = $xmlConfiguration->codeCoverage()->xml()->includeSource(); + } + if ($cliConfiguration->hasBackupGlobals()) { $backupGlobals = $cliConfiguration->backupGlobals(); } else { @@ -586,7 +648,8 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $reverseDefectList = $xmlConfiguration->phpunit()->reverseDefectList(); } - $requireCoverageMetadata = $xmlConfiguration->phpunit()->requireCoverageMetadata(); + $requireCoverageMetadata = $xmlConfiguration->phpunit()->requireCoverageMetadata(); + $requireSealedMockObjects = $xmlConfiguration->phpunit()->requireSealedMockObjects(); if ($cliConfiguration->hasExecutionOrder()) { $executionOrder = $cliConfiguration->executionOrder(); @@ -652,10 +715,12 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $logfileOtr = $xmlConfiguration->logging()->otr()->target()->path(); } + $includeGitInformation = false; $includeGitInformationInOtrLogfile = false; - if ($cliConfiguration->hasIncludeGitInformationInOtrLogfile()) { - $includeGitInformationInOtrLogfile = $cliConfiguration->includeGitInformationInOtrLogfile(); + if ($cliConfiguration->hasIncludeGitInformation()) { + $includeGitInformation = $cliConfiguration->includeGitInformation(); + $includeGitInformationInOtrLogfile = $cliConfiguration->includeGitInformation(); } elseif ($loggingFromXmlConfiguration && $xmlConfiguration->logging()->hasOtr()) { $includeGitInformationInOtrLogfile = $xmlConfiguration->logging()->otr()->includeGitInformation(); } @@ -750,15 +815,25 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $excludeFilter = $cliConfiguration->excludeFilter(); } + $ignoreTestSelectionInXmlConfiguration = false; + + if ($cliConfiguration->hasAll()) { + $ignoreTestSelectionInXmlConfiguration = true; + } + + $groups = []; + if ($cliConfiguration->hasGroups()) { $groups = $cliConfiguration->groups(); - } else { + } elseif (!$ignoreTestSelectionInXmlConfiguration) { $groups = $xmlConfiguration->groups()->include()->asArrayOfStrings(); } + $excludeGroups = []; + if ($cliConfiguration->hasExcludeGroups()) { $excludeGroups = $cliConfiguration->excludeGroups(); - } else { + } elseif (!$ignoreTestSelectionInXmlConfiguration) { $excludeGroups = $xmlConfiguration->groups()->exclude()->asArrayOfStrings(); } @@ -893,8 +968,17 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $displayDetailsOnSkippedTests = true; } + $issueTriggerIdentificationNeeded = $xmlConfiguration->source()->ignoreSelfDeprecations() || $xmlConfiguration->source()->ignoreDirectDeprecations() || $xmlConfiguration->source()->ignoreIndirectDeprecations(); + + if ($issueTriggerIdentificationNeeded && !$xmlConfiguration->source()->identifyIssueTrigger()) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + 'The identification of issue triggers is disabled. However, ignoring self-deprecations, direct deprecations, or indirect deprecations is requested.', + ); + } + return new Configuration( $cliConfiguration->arguments(), + $testFilesFile, $configurationFile, $bootstrap, $xmlConfiguration->phpunit()->bootstrapForTestSuite(), @@ -921,6 +1005,8 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $xmlConfiguration->source()->ignoreSelfDeprecations(), $xmlConfiguration->source()->ignoreDirectDeprecations(), $xmlConfiguration->source()->ignoreIndirectDeprecations(), + $xmlConfiguration->source()->identifyIssueTrigger(), + $xmlConfiguration->source()->issueTriggerResolvers(), ), $testResultCacheFile, $coverageClover, @@ -931,10 +1017,23 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $coverageHtmlLowUpperBound, $coverageHtmlHighLowerBound, $coverageHtmlColorSuccessLow, + $coverageHtmlColorSuccessLowDark, $coverageHtmlColorSuccessMedium, + $coverageHtmlColorSuccessMediumDark, $coverageHtmlColorSuccessHigh, + $coverageHtmlColorSuccessHighDark, + $coverageHtmlColorSuccessBar, + $coverageHtmlColorSuccessBarDark, $coverageHtmlColorWarning, + $coverageHtmlColorWarningDark, + $coverageHtmlColorWarningBar, + $coverageHtmlColorWarningBarDark, $coverageHtmlColorDanger, + $coverageHtmlColorDangerDark, + $coverageHtmlColorDangerBar, + $coverageHtmlColorDangerBarDark, + $coverageHtmlColorBreadcrumbs, + $coverageHtmlColorBreadcrumbsDark, $coverageHtmlCustomCssFile, $coverageOpenClover, $coveragePhp, @@ -942,6 +1041,7 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $coverageTextShowUncoveredFiles, $coverageTextShowOnlySummary, $coverageXml, + $coverageXmlIncludeSource, $pathCoverage, $xmlConfiguration->codeCoverage()->ignoreDeprecatedCodeUnits(), $disableCodeCoverageIgnore, @@ -980,7 +1080,7 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $columns, $noExtensions, $pharExtensionDirectory, - $extensionBootstrappers, + array_values($extensionBootstrappers), $backupGlobals, $backupStaticProperties, $beStrictAboutChangesToGlobalState, @@ -1005,6 +1105,7 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $displayDetailsOnTestsThatTriggerWarnings, $reverseDefectList, $requireCoverageMetadata, + $requireSealedMockObjects, $noProgress, $noResults, $noOutput, @@ -1014,6 +1115,7 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $logfileTeamcity, $logfileJunit, $logfileOtr, + $includeGitInformation, $includeGitInformationInOtrLogfile, $logfileTestdoxHtml, $logfileTestdoxText, @@ -1035,6 +1137,7 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $includeTestSuite, $excludeTestSuite, $xmlConfiguration->phpunit()->hasDefaultTestSuite() ? $xmlConfiguration->phpunit()->defaultTestSuite() : null, + $ignoreTestSelectionInXmlConfiguration, $testSuffixes, new Php( DirectoryCollection::fromArray($includePaths), @@ -1057,4 +1160,33 @@ public function merge(CliConfiguration $cliConfiguration, XmlConfiguration $xmlC $xmlConfiguration->phpunit()->shortenArraysForExportThreshold(), ); } + + private function hasExplicitTestSelection(CliConfiguration $cliConfiguration): bool + { + if ($cliConfiguration->hasFilter()) { + return true; + } + + if ($cliConfiguration->hasExcludeFilter()) { + return true; + } + + if ($cliConfiguration->hasGroups()) { + return true; + } + + if ($cliConfiguration->hasExcludeGroups()) { + return true; + } + + if ($cliConfiguration->hasTestSuite()) { + return true; + } + + if ($cliConfiguration->hasExcludedTestSuite()) { + return true; + } + + return false; + } } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/PhpHandler.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/PhpHandler.php index 3aa13160e..95adb5ae1 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/PhpHandler.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/PhpHandler.php @@ -18,6 +18,10 @@ use function ini_get; use function ini_set; use function putenv; +use function restore_error_handler; +use function set_error_handler; +use function sprintf; +use PHPUnit\Event\Facade as EventFacade; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -68,7 +72,31 @@ private function handleIniSettings(IniSettingCollection $iniSettings): void $value = (string) constant($value); } - ini_set($iniSetting->name(), $value); + $error = ''; + + set_error_handler( + static function (int $errno, string $errstr, string $errfile, int $errline) use (&$error): true + { + $error = $errstr; + + return true; + }, + ); + + $success = ini_set($iniSetting->name(), $value); + + restore_error_handler(); + + if ($success === false) { + EventFacade::emitter()->testRunnerTriggeredPhpunitWarning( + sprintf( + 'Failed to set "%s=%s": %s', + $iniSetting->name(), + $value, + $error, + ), + ); + } } } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Registry.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Registry.php index ad8075235..a1cacdfb6 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Registry.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Registry.php @@ -79,6 +79,8 @@ public static function loadFrom(string $path): void File::class, FilterDirectoryCollection::class, FilterDirectory::class, + FilterFileCollection::class, + FilterFile::class, TestDirectoryCollection::class, TestDirectory::class, TestFileCollection::class, diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceFilter.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceFilter.php index 845a9b376..c96747506 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceFilter.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceFilter.php @@ -44,6 +44,9 @@ public function __construct(array $map) $this->map = $map; } + /** + * @param non-empty-string $path + */ public function includes(string $path): bool { return isset($this->map[$path]); diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceMapper.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceMapper.php index c2c548382..ae3d17725 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceMapper.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/SourceMapper.php @@ -9,7 +9,15 @@ */ namespace PHPUnit\TextUI\Configuration; +use const DIRECTORY_SEPARATOR; +use function file_get_contents; +use function file_put_contents; +use function is_array; +use function preg_match; use function realpath; +use function serialize; +use function str_replace; +use function unserialize; use SebastianBergmann\FileIterator\Facade as FileIteratorFacade; use SplObjectStorage; @@ -25,6 +33,38 @@ final class SourceMapper */ private static ?SplObjectStorage $files = null; + public static function saveTo(string $path, Source $source): bool + { + $map = (new self)->map($source); + + return file_put_contents($path, serialize($map)) !== false; + } + + /** + * @codeCoverageIgnore + */ + public static function loadFrom(string $path, Source $source): void + { + $content = file_get_contents($path); + + if ($content === false) { + return; + } + + $map = unserialize($content, ['allowed_classes' => false]); + + if (!is_array($map)) { + return; + } + + if (self::$files === null) { + self::$files = new SplObjectStorage; + } + + /** @phpstan-ignore offsetAssign.valueType */ + self::$files[$source] = $map; + } + /** * @return array */ @@ -43,6 +83,8 @@ public function map(Source $source): array $directories = $this->aggregateDirectories($source->includeDirectories()); foreach ($directories as $path => [$prefixes, $suffixes]) { + $basePath = realpath($path); + foreach ((new FileIteratorFacade)->getFilesAsArray($path, $suffixes, $prefixes) as $file) { $file = realpath($file); @@ -50,6 +92,10 @@ public function map(Source $source): array continue; } + if ($this->isInHiddenDirectory($file, $basePath)) { + continue; + } + $files[$file] = true; } } @@ -101,6 +147,55 @@ public function map(Source $source): array return $files; } + /** + * @return array + */ + public function mapForCodeCoverage(Source $source): array + { + $files = $this->map($source); + + foreach ($source->includeDirectories() as $directory) { + if ($directory->includeInCodeCoverage()) { + continue; + } + + foreach ((new FileIteratorFacade)->getFilesAsArray($directory->path(), $directory->suffix(), $directory->prefix()) as $file) { + $file = realpath($file); + + if (!$file) { + continue; + } + + unset($files[$file]); + } + } + + foreach ($source->includeFiles() as $file) { + if ($file->includeInCodeCoverage()) { + continue; + } + + $path = realpath($file->path()); + + if (!$path) { + continue; + } + + unset($files[$path]); + } + + return $files; + } + + private function isInHiddenDirectory(string $path, false|string $basePath): bool + { + $relativePath = str_replace((string) $basePath, '', $path); + + $separator = DIRECTORY_SEPARATOR === '\\' ? '\\\\' : '/'; + + return preg_match('=' . $separator . '\.[^' . $separator . ']*' . $separator . '=', $relativePath) === 1; + } + /** * @return array,list}> */ diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/TestSuiteBuilder.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/TestSuiteBuilder.php index 0312aad76..96f98ef3f 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/TestSuiteBuilder.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/TestSuiteBuilder.php @@ -9,13 +9,17 @@ */ namespace PHPUnit\TextUI\Configuration; +use const DIRECTORY_SEPARATOR; use const PHP_EOL; use function assert; use function count; +use function dirname; +use function file; use function is_dir; use function is_file; use function realpath; use function str_ends_with; +use function trim; use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Exception; use PHPUnit\Framework\TestSuite; @@ -41,17 +45,42 @@ */ public function build(Configuration $configuration): TestSuite { - if ($configuration->hasCliArguments()) { + if ($configuration->hasCliArguments() || $configuration->hasTestFilesFile()) { $arguments = []; - foreach ($configuration->cliArguments() as $cliArgument) { - $argument = realpath($cliArgument); + if ($configuration->hasCliArguments()) { + foreach ($configuration->cliArguments() as $cliArgument) { + $argument = realpath($cliArgument); - if (!$argument) { - throw new TestFileNotFoundException($cliArgument); + if (!$argument) { + throw new TestFileNotFoundException($cliArgument); + } + + $arguments[] = $argument; } + } + + if ($configuration->hasTestFilesFile()) { + if (!is_file($configuration->testFilesFile())) { + throw new RuntimeException('Cannot read from ' . $configuration->testFilesFile()); + } + + $directory = dirname($configuration->testFilesFile()) . DIRECTORY_SEPARATOR; - $arguments[] = $argument; + foreach (file($configuration->testFilesFile()) as $file) { + $file = trim($file); + $argument = realpath($file); + + if (!$argument) { + $argument = realpath($directory . $file); + } + + if (!$argument) { + throw new TestFileNotFoundException($file); + } + + $arguments[] = $argument; + } } if (count($arguments) === 1) { @@ -75,8 +104,8 @@ public function build(Configuration $configuration): TestSuite $testSuite = (new TestSuiteMapper)->map( $xmlConfigurationFile, $configuration->testSuite(), - $configuration->includeTestSuites(), - $configuration->excludeTestSuites(), + $configuration->ignoreTestSelectionInXmlConfiguration() ? [] : $configuration->includeTestSuites(), + $configuration->ignoreTestSelectionInXmlConfiguration() ? [] : $configuration->excludeTestSuites(), ); } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollection.php index 3e34d7434..137dceb7a 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class ConstantCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollectionIterator.php index f385b7faf..3b06dc8b1 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ConstantCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class ConstantCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class ConstantCollectionIterator implements Iterator * @var list */ private readonly array $constants; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(ConstantCollection $constants) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->constants); + return isset($this->constants[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollection.php index dc1e840c9..d76deec51 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class DirectoryCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollectionIterator.php index 73d2cff63..4b4ebb451 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/DirectoryCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class DirectoryCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class DirectoryCollectionIterator implements Iterator * @var list */ private readonly array $directories; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(DirectoryCollection $directories) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->directories); + return isset($this->directories[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollection.php index 16ca1e070..99c3a3ed8 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollection.php @@ -12,7 +12,7 @@ use IteratorAggregate; /** - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate * * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollectionIterator.php index 0b5c20ba1..3d64c625f 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/ExtensionBootstrapCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class ExtensionBootstrapCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class ExtensionBootstrapCollectionIterator implements Iterator * @var list */ private readonly array $extensionBootstraps; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(ExtensionBootstrapCollection $extensionBootstraps) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->extensionBootstraps); + return isset($this->extensionBootstraps[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollection.php index 61522a5eb..b80897f04 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class FileCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollectionIterator.php index 91ec8e276..fb4910d6c 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FileCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class FileCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class FileCollectionIterator implements Iterator * @var list */ private readonly array $files; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(FileCollection $files) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->files); + return isset($this->files[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectory.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectory.php index 52dcd1b13..a693781b7 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectory.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectory.php @@ -22,15 +22,17 @@ private string $path; private string $prefix; private string $suffix; + private bool $includeInCodeCoverage; /** * @param non-empty-string $path */ - public function __construct(string $path, string $prefix, string $suffix) + public function __construct(string $path, string $prefix, string $suffix, bool $includeInCodeCoverage = true) { - $this->path = $path; - $this->prefix = $prefix; - $this->suffix = $suffix; + $this->path = $path; + $this->prefix = $prefix; + $this->suffix = $suffix; + $this->includeInCodeCoverage = $includeInCodeCoverage; } /** @@ -50,4 +52,9 @@ public function suffix(): string { return $this->suffix; } + + public function includeInCodeCoverage(): bool + { + return $this->includeInCodeCoverage; + } } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollection.php index 147f0618f..df534a3dc 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class FilterDirectoryCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollectionIterator.php index 737c752f4..f301d7e38 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterDirectoryCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class FilterDirectoryCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class FilterDirectoryCollectionIterator implements Iterator * @var list */ private readonly array $directories; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(FilterDirectoryCollection $directories) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->directories); + return isset($this->directories[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFile.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFile.php new file mode 100644 index 000000000..e1ab24152 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFile.php @@ -0,0 +1,46 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\TextUI\Configuration; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @immutable + */ +final readonly class FilterFile +{ + /** + * @var non-empty-string + */ + private string $path; + private bool $includeInCodeCoverage; + + /** + * @param non-empty-string $path + */ + public function __construct(string $path, bool $includeInCodeCoverage = true) + { + $this->path = $path; + $this->includeInCodeCoverage = $includeInCodeCoverage; + } + + /** + * @return non-empty-string + */ + public function path(): string + { + return $this->path; + } + + public function includeInCodeCoverage(): bool + { + return $this->includeInCodeCoverage; + } +} diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFileCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFileCollection.php new file mode 100644 index 000000000..01f4e8716 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFileCollection.php @@ -0,0 +1,65 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\TextUI\Configuration; + +use function count; +use Countable; +use IteratorAggregate; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @immutable + * + * @template-implements IteratorAggregate + */ +final readonly class FilterFileCollection implements Countable, IteratorAggregate +{ + /** + * @var list + */ + private array $files; + + /** + * @param list $files + */ + public static function fromArray(array $files): self + { + return new self(...$files); + } + + private function __construct(FilterFile ...$files) + { + $this->files = $files; + } + + /** + * @return list + */ + public function asArray(): array + { + return $this->files; + } + + public function count(): int + { + return count($this->files); + } + + public function notEmpty(): bool + { + return $this->files !== []; + } + + public function getIterator(): FilterFileCollectionIterator + { + return new FilterFileCollectionIterator($this); + } +} diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFileCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFileCollectionIterator.php new file mode 100644 index 000000000..f7da3362c --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/FilterFileCollectionIterator.php @@ -0,0 +1,63 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\TextUI\Configuration; + +use Iterator; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @template-implements Iterator + */ +final class FilterFileCollectionIterator implements Iterator +{ + /** + * @var list + */ + private readonly array $files; + + /** + * @var non-negative-int + */ + private int $position = 0; + + public function __construct(FilterFileCollection $files) + { + $this->files = $files->asArray(); + } + + public function rewind(): void + { + $this->position = 0; + } + + public function valid(): bool + { + return isset($this->files[$this->position]); + } + + /** + * @return non-negative-int + */ + public function key(): int + { + return $this->position; + } + + public function current(): FilterFile + { + return $this->files[$this->position]; + } + + public function next(): void + { + $this->position++; + } +} diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollection.php index 8232e1f34..57ff48121 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollection.php @@ -16,7 +16,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class GroupCollection implements IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollectionIterator.php index 774808757..04eac0350 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/GroupCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class GroupCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class GroupCollectionIterator implements Iterator * @var list */ private readonly array $groups; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(GroupCollection $groups) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->groups); + return isset($this->groups[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollection.php index abfd8fd24..3281e0eea 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class IniSettingCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollectionIterator.php index cb68c3dd1..1a4306b50 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/IniSettingCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class IniSettingCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class IniSettingCollectionIterator implements Iterator * @var list */ private readonly array $iniSettings; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(IniSettingCollection $iniSettings) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->iniSettings); + return isset($this->iniSettings[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/Source.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/Source.php index b6f61eb07..106490107 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/Source.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/Source.php @@ -22,9 +22,9 @@ private ?string $baseline; private bool $ignoreBaseline; private FilterDirectoryCollection $includeDirectories; - private FileCollection $includeFiles; + private FilterFileCollection $includeFiles; private FilterDirectoryCollection $excludeDirectories; - private FileCollection $excludeFiles; + private FilterFileCollection $excludeFiles; private bool $restrictNotices; private bool $restrictWarnings; private bool $ignoreSuppressionOfDeprecations; @@ -37,17 +37,24 @@ private bool $ignoreSelfDeprecations; private bool $ignoreDirectDeprecations; private bool $ignoreIndirectDeprecations; + private bool $identifyIssueTrigger; /** - * @var array{functions: list, methods: list} + * @var array{functions: list, methods: list, ignoreUndefinedTriggers: bool} */ private array $deprecationTriggers; /** - * @param non-empty-string $baseline - * @param array{functions: list, methods: list} $deprecationTriggers + * @var list */ - public function __construct(?string $baseline, bool $ignoreBaseline, FilterDirectoryCollection $includeDirectories, FileCollection $includeFiles, FilterDirectoryCollection $excludeDirectories, FileCollection $excludeFiles, bool $restrictNotices, bool $restrictWarnings, bool $ignoreSuppressionOfDeprecations, bool $ignoreSuppressionOfPhpDeprecations, bool $ignoreSuppressionOfErrors, bool $ignoreSuppressionOfNotices, bool $ignoreSuppressionOfPhpNotices, bool $ignoreSuppressionOfWarnings, bool $ignoreSuppressionOfPhpWarnings, array $deprecationTriggers, bool $ignoreSelfDeprecations, bool $ignoreDirectDeprecations, bool $ignoreIndirectDeprecations) + private array $issueTriggerResolvers; + + /** + * @param ?non-empty-string $baseline + * @param array{functions: list, methods: list, ignoreUndefinedTriggers: bool} $deprecationTriggers + * @param list $issueTriggerResolvers + */ + public function __construct(?string $baseline, bool $ignoreBaseline, FilterDirectoryCollection $includeDirectories, FilterFileCollection $includeFiles, FilterDirectoryCollection $excludeDirectories, FilterFileCollection $excludeFiles, bool $restrictNotices, bool $restrictWarnings, bool $ignoreSuppressionOfDeprecations, bool $ignoreSuppressionOfPhpDeprecations, bool $ignoreSuppressionOfErrors, bool $ignoreSuppressionOfNotices, bool $ignoreSuppressionOfPhpNotices, bool $ignoreSuppressionOfWarnings, bool $ignoreSuppressionOfPhpWarnings, array $deprecationTriggers, bool $ignoreSelfDeprecations, bool $ignoreDirectDeprecations, bool $ignoreIndirectDeprecations, bool $identifyIssueTrigger, array $issueTriggerResolvers = []) { $this->baseline = $baseline; $this->ignoreBaseline = $ignoreBaseline; @@ -68,6 +75,8 @@ public function __construct(?string $baseline, bool $ignoreBaseline, FilterDirec $this->ignoreSelfDeprecations = $ignoreSelfDeprecations; $this->ignoreDirectDeprecations = $ignoreDirectDeprecations; $this->ignoreIndirectDeprecations = $ignoreIndirectDeprecations; + $this->identifyIssueTrigger = $identifyIssueTrigger; + $this->issueTriggerResolvers = $issueTriggerResolvers; } /** @@ -105,7 +114,7 @@ public function includeDirectories(): FilterDirectoryCollection return $this->includeDirectories; } - public function includeFiles(): FileCollection + public function includeFiles(): FilterFileCollection { return $this->includeFiles; } @@ -115,7 +124,7 @@ public function excludeDirectories(): FilterDirectoryCollection return $this->excludeDirectories; } - public function excludeFiles(): FileCollection + public function excludeFiles(): FilterFileCollection { return $this->excludeFiles; } @@ -171,7 +180,7 @@ public function ignoreSuppressionOfPhpWarnings(): bool } /** - * @return array{functions: list, methods: list} + * @return array{functions: list, methods: list, ignoreUndefinedTriggers: bool} */ public function deprecationTriggers(): array { @@ -192,4 +201,17 @@ public function ignoreIndirectDeprecations(): bool { return $this->ignoreIndirectDeprecations; } + + public function identifyIssueTrigger(): bool + { + return $this->identifyIssueTrigger; + } + + /** + * @return list + */ + public function issueTriggerResolvers(): array + { + return $this->issueTriggerResolvers; + } } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollection.php index ba867273c..033e66091 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class TestDirectoryCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollectionIterator.php index fa57410a6..474adf340 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestDirectoryCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class TestDirectoryCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class TestDirectoryCollectionIterator implements Iterator * @var list */ private readonly array $directories; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(TestDirectoryCollection $directories) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->directories); + return isset($this->directories[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollection.php index 6d1ae2799..5a861475d 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class TestFileCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollectionIterator.php index ed328e9ec..7364852d7 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestFileCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class TestFileCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class TestFileCollectionIterator implements Iterator * @var list */ private readonly array $files; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(TestFileCollection $files) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->files); + return isset($this->files[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollection.php index 26c9a6457..5cbeda2f2 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class TestSuiteCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollectionIterator.php index d0b0768a4..d72944a1c 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/TestSuiteCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class TestSuiteCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class TestSuiteCollectionIterator implements Iterator * @var list */ private readonly array $testSuites; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(TestSuiteCollection $testSuites) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->testSuites); + return isset($this->testSuites[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollection.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollection.php index 77fb4cff9..e83a4e40e 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollection.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollection.php @@ -18,7 +18,7 @@ * * @immutable * - * @template-implements IteratorAggregate + * @template-implements IteratorAggregate */ final readonly class VariableCollection implements Countable, IteratorAggregate { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollectionIterator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollectionIterator.php index 2e32194c1..0eeb39f27 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollectionIterator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Value/VariableCollectionIterator.php @@ -9,13 +9,12 @@ */ namespace PHPUnit\TextUI\Configuration; -use function count; use Iterator; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @template-implements Iterator + * @template-implements Iterator */ final class VariableCollectionIterator implements Iterator { @@ -23,6 +22,10 @@ final class VariableCollectionIterator implements Iterator * @var list */ private readonly array $variables; + + /** + * @var non-negative-int + */ private int $position = 0; public function __construct(VariableCollection $variables) @@ -37,9 +40,12 @@ public function rewind(): void public function valid(): bool { - return $this->position < count($this->variables); + return isset($this->variables[$this->position]); } + /** + * @return non-negative-int + */ public function key(): int { return $this->position; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Html.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Html.php index dde8880f1..4bd7fa6e0 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Html.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Html.php @@ -11,6 +11,7 @@ use PHPUnit\TextUI\Configuration\Directory; use PHPUnit\TextUI\Configuration\NoCustomCssFileException; +use PHPUnit\TextUI\Configuration\NoHtmlCoverageTargetException; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -21,31 +22,72 @@ */ final readonly class Html { - private Directory $target; + private ?Directory $target; private int $lowUpperBound; private int $highLowerBound; private string $colorSuccessLow; + private string $colorSuccessLowDark; private string $colorSuccessMedium; + private string $colorSuccessMediumDark; private string $colorSuccessHigh; + private string $colorSuccessHighDark; + private string $colorSuccessBar; + private string $colorSuccessBarDark; private string $colorWarning; + private string $colorWarningDark; + private string $colorWarningBar; + private string $colorWarningBarDark; private string $colorDanger; + private string $colorDangerDark; + private string $colorDangerBar; + private string $colorDangerBarDark; + private string $colorBreadcrumbs; + private string $colorBreadcrumbsDark; private ?string $customCssFile; - public function __construct(Directory $target, int $lowUpperBound, int $highLowerBound, string $colorSuccessLow, string $colorSuccessMedium, string $colorSuccessHigh, string $colorWarning, string $colorDanger, ?string $customCssFile) + public function __construct(?Directory $target, int $lowUpperBound, int $highLowerBound, string $colorSuccessLow, string $colorSuccessLowDark, string $colorSuccessMedium, string $colorSuccessMediumDark, string $colorSuccessHigh, string $colorSuccessHighDark, string $colorSuccessBar, string $colorSuccessBarDark, string $colorWarning, string $colorWarningDark, string $colorWarningBar, string $colorWarningBarDark, string $colorDanger, string $colorDangerDark, string $colorDangerBar, string $colorDangerBarDark, string $colorBreadcrumbs, string $colorBreadcrumbsDark, ?string $customCssFile) { - $this->target = $target; - $this->lowUpperBound = $lowUpperBound; - $this->highLowerBound = $highLowerBound; - $this->colorSuccessLow = $colorSuccessLow; - $this->colorSuccessMedium = $colorSuccessMedium; - $this->colorSuccessHigh = $colorSuccessHigh; - $this->colorWarning = $colorWarning; - $this->colorDanger = $colorDanger; - $this->customCssFile = $customCssFile; + $this->target = $target; + $this->lowUpperBound = $lowUpperBound; + $this->highLowerBound = $highLowerBound; + $this->colorSuccessLow = $colorSuccessLow; + $this->colorSuccessLowDark = $colorSuccessLowDark; + $this->colorSuccessMedium = $colorSuccessMedium; + $this->colorSuccessMediumDark = $colorSuccessMediumDark; + $this->colorSuccessHigh = $colorSuccessHigh; + $this->colorSuccessHighDark = $colorSuccessHighDark; + $this->colorSuccessBar = $colorSuccessBar; + $this->colorSuccessBarDark = $colorSuccessBarDark; + $this->colorWarning = $colorWarning; + $this->colorWarningDark = $colorWarningDark; + $this->colorWarningBar = $colorWarningBar; + $this->colorWarningBarDark = $colorWarningBarDark; + $this->colorDanger = $colorDanger; + $this->colorDangerDark = $colorDangerDark; + $this->colorDangerBar = $colorDangerBar; + $this->colorDangerBarDark = $colorDangerBarDark; + $this->colorBreadcrumbs = $colorBreadcrumbs; + $this->colorBreadcrumbsDark = $colorBreadcrumbsDark; + $this->customCssFile = $customCssFile; } + /** + * @phpstan-assert-if-true !null $this->target + */ + public function hasTarget(): bool + { + return $this->target !== null; + } + + /** + * @throws NoHtmlCoverageTargetException + */ public function target(): Directory { + if (!$this->hasTarget()) { + throw new NoHtmlCoverageTargetException; + } + return $this->target; } @@ -64,26 +106,91 @@ public function colorSuccessLow(): string return $this->colorSuccessLow; } + public function colorSuccessLowDark(): string + { + return $this->colorSuccessLowDark; + } + public function colorSuccessMedium(): string { return $this->colorSuccessMedium; } + public function colorSuccessMediumDark(): string + { + return $this->colorSuccessMediumDark; + } + public function colorSuccessHigh(): string { return $this->colorSuccessHigh; } + public function colorSuccessHighDark(): string + { + return $this->colorSuccessHighDark; + } + + public function colorSuccessBar(): string + { + return $this->colorSuccessBar; + } + + public function colorSuccessBarDark(): string + { + return $this->colorSuccessBarDark; + } + public function colorWarning(): string { return $this->colorWarning; } + public function colorWarningDark(): string + { + return $this->colorWarningDark; + } + + public function colorWarningBar(): string + { + return $this->colorWarningBar; + } + + public function colorWarningBarDark(): string + { + return $this->colorWarningBarDark; + } + public function colorDanger(): string { return $this->colorDanger; } + public function colorDangerDark(): string + { + return $this->colorDangerDark; + } + + public function colorDangerBar(): string + { + return $this->colorDangerBar; + } + + public function colorDangerBarDark(): string + { + return $this->colorDangerBarDark; + } + + public function colorBreadcrumbs(): string + { + return $this->colorBreadcrumbs; + } + + public function colorBreadcrumbsDark(): string + { + return $this->colorBreadcrumbsDark; + } + /** * @phpstan-assert-if-true !null $this->customCssFile */ diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Xml.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Xml.php index 62f99a061..c67ef1eea 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Xml.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Xml.php @@ -21,14 +21,21 @@ final readonly class Xml { private Directory $target; + private bool $includeSource; - public function __construct(Directory $target) + public function __construct(Directory $target, bool $includeSource) { - $this->target = $target; + $this->target = $target; + $this->includeSource = $includeSource; } public function target(): Directory { return $this->target; } + + public function includeSource(): bool + { + return $this->includeSource; + } } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/DefaultConfiguration.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/DefaultConfiguration.php index de16474a8..c4ea4d331 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/DefaultConfiguration.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/DefaultConfiguration.php @@ -13,8 +13,8 @@ use PHPUnit\TextUI\Configuration\ConstantCollection; use PHPUnit\TextUI\Configuration\DirectoryCollection; use PHPUnit\TextUI\Configuration\ExtensionBootstrapCollection; -use PHPUnit\TextUI\Configuration\FileCollection; -use PHPUnit\TextUI\Configuration\FilterDirectoryCollection as CodeCoverageFilterDirectoryCollection; +use PHPUnit\TextUI\Configuration\FilterDirectoryCollection; +use PHPUnit\TextUI\Configuration\FilterFileCollection; use PHPUnit\TextUI\Configuration\GroupCollection; use PHPUnit\TextUI\Configuration\IniSettingCollection; use PHPUnit\TextUI\Configuration\Php; @@ -40,10 +40,10 @@ public static function create(): self new Source( null, false, - CodeCoverageFilterDirectoryCollection::fromArray([]), - FileCollection::fromArray([]), - CodeCoverageFilterDirectoryCollection::fromArray([]), - FileCollection::fromArray([]), + FilterDirectoryCollection::fromArray([]), + FilterFileCollection::fromArray([]), + FilterDirectoryCollection::fromArray([]), + FilterFileCollection::fromArray([]), false, false, false, @@ -54,12 +54,14 @@ public static function create(): self false, false, [ - 'functions' => [], - 'methods' => [], + 'functions' => [], + 'methods' => [], + 'ignoreUndefinedTriggers' => false, ], false, false, false, + true, ), new CodeCoverage( false, @@ -116,6 +118,7 @@ public static function create(): self false, false, false, + false, null, [], false, @@ -139,6 +142,7 @@ public static function create(): self false, false, false, + false, null, false, false, diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Loader.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Loader.php index 886959fd5..e3ddb9ada 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Loader.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Loader.php @@ -44,6 +44,8 @@ use PHPUnit\TextUI\Configuration\FileCollection; use PHPUnit\TextUI\Configuration\FilterDirectory; use PHPUnit\TextUI\Configuration\FilterDirectoryCollection; +use PHPUnit\TextUI\Configuration\FilterFile; +use PHPUnit\TextUI\Configuration\FilterFileCollection; use PHPUnit\TextUI\Configuration\Group; use PHPUnit\TextUI\Configuration\GroupCollection; use PHPUnit\TextUI\Configuration\IniSetting; @@ -120,6 +122,14 @@ public function load(string $filename): LoadedFromFileConfiguration $validationResult = (new Validator)->validate($document, $xsdFilename); + if ($validationResult->hasValidationErrors()) { + $this->ensureConfigurationValidatesAgainstAtLeastOneSchema( + $document, + $configurationFileRealpath, + $validationResult, + ); + } + try { return new LoadedFromFileConfiguration( $configurationFileRealpath, @@ -312,6 +322,7 @@ private function source(string $filename, DOMXPath $xpath): Source $ignoreSelfDeprecations = false; $ignoreDirectDeprecations = false; $ignoreIndirectDeprecations = false; + $identifyIssueTrigger = true; $element = $this->element($xpath, 'source'); @@ -334,11 +345,16 @@ private function source(string $filename, DOMXPath $xpath): Source $ignoreSelfDeprecations = $this->parseBooleanAttribute($element, 'ignoreSelfDeprecations', false); $ignoreDirectDeprecations = $this->parseBooleanAttribute($element, 'ignoreDirectDeprecations', false); $ignoreIndirectDeprecations = $this->parseBooleanAttribute($element, 'ignoreIndirectDeprecations', false); + $identifyIssueTrigger = $this->parseBooleanAttribute($element, 'identifyIssueTrigger', true); } + $deprecationTriggerElement = $this->element($xpath, 'source/deprecationTrigger'); + $deprecationTriggers = [ - 'functions' => [], - 'methods' => [], + 'functions' => [], + 'methods' => [], + 'ignoreUndefinedTriggers' => $deprecationTriggerElement !== null && + $this->parseBooleanAttribute($deprecationTriggerElement, 'ignoreUndefinedTriggers', false), ]; $functionNodes = $xpath->query('source/deprecationTrigger/function'); @@ -361,6 +377,17 @@ private function source(string $filename, DOMXPath $xpath): Source $deprecationTriggers['methods'][] = $methodNode->textContent; } + $issueTriggerResolvers = []; + $issueTriggerResolverNodes = $xpath->query('source/issueTriggerResolvers/issueTriggerResolver'); + + assert($issueTriggerResolverNodes instanceof DOMNodeList); + + foreach ($issueTriggerResolverNodes as $node) { + assert($node instanceof DOMElement); + + $issueTriggerResolvers[] = $node->getAttribute('className'); + } + return new Source( $baseline, false, @@ -381,6 +408,8 @@ private function source(string $filename, DOMXPath $xpath): Source $ignoreSelfDeprecations, $ignoreDirectDeprecations, $ignoreIndirectDeprecations, + $identifyIssueTrigger, + $issueTriggerResolvers, ); } @@ -468,21 +497,39 @@ private function codeCoverage(string $filename, DOMXPath $xpath): CodeCoverage if ($element !== null) { $defaultColors = Colors::default(); $defaultThresholds = Thresholds::default(); + $outputDirectory = $this->parseStringAttribute($element, 'outputDirectory'); - $html = new CodeCoverageHtml( - new Directory( + if ($outputDirectory !== null) { + $outputDirectory = new Directory( $this->toAbsolutePath( $filename, - (string) $this->parseStringAttribute($element, 'outputDirectory'), + $outputDirectory, ), - ), + ); + } + + $html = new CodeCoverageHtml( + $outputDirectory, $this->parseIntegerAttribute($element, 'lowUpperBound', $defaultThresholds->lowUpperBound()), $this->parseIntegerAttribute($element, 'highLowerBound', $defaultThresholds->highLowerBound()), $this->parseStringAttributeWithDefault($element, 'colorSuccessLow', $defaultColors->successLow()), + $this->parseStringAttributeWithDefault($element, 'colorSuccessLowDark', $defaultColors->successLowDark()), $this->parseStringAttributeWithDefault($element, 'colorSuccessMedium', $defaultColors->successMedium()), + $this->parseStringAttributeWithDefault($element, 'colorSuccessMediumDark', $defaultColors->successMediumDark()), $this->parseStringAttributeWithDefault($element, 'colorSuccessHigh', $defaultColors->successHigh()), + $this->parseStringAttributeWithDefault($element, 'colorSuccessHighDark', $defaultColors->successHighDark()), + $this->parseStringAttributeWithDefault($element, 'colorSuccessBar', $defaultColors->successBar()), + $this->parseStringAttributeWithDefault($element, 'colorSuccessBarDark', $defaultColors->successBarDark()), $this->parseStringAttributeWithDefault($element, 'colorWarning', $defaultColors->warning()), + $this->parseStringAttributeWithDefault($element, 'colorWarningDark', $defaultColors->warningDark()), + $this->parseStringAttributeWithDefault($element, 'colorWarningBar', $defaultColors->warningBar()), + $this->parseStringAttributeWithDefault($element, 'colorWarningBarDark', $defaultColors->warningBarDark()), $this->parseStringAttributeWithDefault($element, 'colorDanger', $defaultColors->danger()), + $this->parseStringAttributeWithDefault($element, 'colorDangerDark', $defaultColors->dangerDark()), + $this->parseStringAttributeWithDefault($element, 'colorDangerBar', $defaultColors->dangerBar()), + $this->parseStringAttributeWithDefault($element, 'colorDangerBarDark', $defaultColors->dangerBarDark()), + $this->parseStringAttributeWithDefault($element, 'colorBreadcrumbs', $defaultColors->breadcrumbs()), + $this->parseStringAttributeWithDefault($element, 'colorBreadcrumbsDark', $defaultColors->breadcrumbsDark()), $this->parseStringAttribute($element, 'customCssFile'), ); } @@ -542,6 +589,7 @@ private function codeCoverage(string $filename, DOMXPath $xpath): CodeCoverage (string) $this->parseStringAttribute($element, 'outputDirectory'), ), ), + $this->parseBooleanAttribute($element, 'includeSource', true), ); } @@ -608,13 +656,14 @@ private function readFilterDirectories(string $filename, DOMXPath $xpath, string $this->toAbsolutePath($filename, $directoryPath), $directoryNode->hasAttribute('prefix') ? $directoryNode->getAttribute('prefix') : '', $directoryNode->hasAttribute('suffix') ? $directoryNode->getAttribute('suffix') : '.php', + !$directoryNode->hasAttribute('includeInCodeCoverage') || $directoryNode->getAttribute('includeInCodeCoverage') !== 'false', ); } return FilterDirectoryCollection::fromArray($directories); } - private function readFilterFiles(string $filename, DOMXPath $xpath, string $query): FileCollection + private function readFilterFiles(string $filename, DOMXPath $xpath, string $query): FilterFileCollection { $files = []; @@ -623,16 +672,19 @@ private function readFilterFiles(string $filename, DOMXPath $xpath, string $quer assert($fileNodes instanceof DOMNodeList); foreach ($fileNodes as $fileNode) { - assert($fileNode instanceof DOMNode); + assert($fileNode instanceof DOMElement); $filePath = $fileNode->textContent; if ($filePath !== '') { - $files[] = new File($this->toAbsolutePath($filename, $filePath)); + $files[] = new FilterFile( + $this->toAbsolutePath($filename, $filePath), + !$fileNode->hasAttribute('includeInCodeCoverage') || $fileNode->getAttribute('includeInCodeCoverage') !== 'false', + ); } } - return FileCollection::fromArray($files); + return FilterFileCollection::fromArray($files); } private function groups(DOMXPath $xpath): Groups @@ -906,6 +958,12 @@ private function phpunit(string $filename, DOMDocument $document, DOMXPath $xpat $requireCoverageMetadata = $this->parseBooleanAttribute($document->documentElement, 'requireCoverageMetadata', false); } + $requireSealedMockObjects = false; + + if ($document->documentElement->hasAttribute('requireSealedMockObjects')) { + $requireSealedMockObjects = $this->parseBooleanAttribute($document->documentElement, 'requireSealedMockObjects', false); + } + $beStrictAboutCoverageMetadata = false; if ($document->documentElement->hasAttribute('beStrictAboutCoverageMetadata')) { @@ -935,6 +993,7 @@ private function phpunit(string $filename, DOMDocument $document, DOMXPath $xpat $this->parseBooleanAttribute($document->documentElement, 'displayDetailsOnTestsThatTriggerWarnings', false), $this->parseBooleanAttribute($document->documentElement, 'reverseDefectList', false), $requireCoverageMetadata, + $requireSealedMockObjects, $bootstrap, $this->bootstrapForTestSuite($filename, $xpath), $this->parseBooleanAttribute($document->documentElement, 'processIsolation', false), @@ -944,6 +1003,7 @@ private function phpunit(string $filename, DOMDocument $document, DOMXPath $xpat $this->parseBooleanAttribute($document->documentElement, 'failOnPhpunitNotice', false), $this->parseBooleanAttribute($document->documentElement, 'failOnPhpunitWarning', true), $this->parseBooleanAttribute($document->documentElement, 'failOnEmptyTestSuite', false), + $document->documentElement->hasAttribute('failOnEmptyTestSuite'), $this->parseBooleanAttribute($document->documentElement, 'failOnIncomplete', false), $this->parseBooleanAttribute($document->documentElement, 'failOnNotice', false), $this->parseBooleanAttribute($document->documentElement, 'failOnRisky', false), @@ -987,10 +1047,8 @@ private function parseColors(DOMDocument $document): string $colors = Configuration::COLOR_DEFAULT; if ($document->documentElement->hasAttribute('colors')) { - /* only allow boolean for compatibility with previous versions - 'always' only allowed from command line */ if ($this->booleanFromString($document->documentElement->getAttribute('colors'), false)) { - $colors = Configuration::COLOR_AUTO; + $colors = Configuration::COLOR_ALWAYS; } else { $colors = Configuration::COLOR_NEVER; } @@ -1222,4 +1280,37 @@ private function element(DOMXPath $xpath, string $element): ?DOMElement return null; } + + /** + * @throws Exception + */ + private function ensureConfigurationValidatesAgainstAtLeastOneSchema(DOMDocument $document, string $configurationFile, ValidationResult $validationResult): void + { + if ($document->documentElement->localName === 'phpunit') { + return; + } + + $schemaFinder = new SchemaFinder; + $validator = new Validator; + + foreach ($schemaFinder->available() as $version) { + try { + $xsdFilename = $schemaFinder->find($version); + } catch (CannotFindSchemaException) { + continue; + } + + if (!$validator->validate($document, $xsdFilename)->hasValidationErrors()) { + return; + } + } + + throw new Exception( + sprintf( + 'XML configuration file %s does not validate against any supported PHPUnit schema:' . PHP_EOL . '%s', + $configurationFile, + $validationResult->asString(), + ), + ); + } } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/MigrationBuilder.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/MigrationBuilder.php index 6235c55f3..13068d9e1 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/MigrationBuilder.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/MigrationBuilder.php @@ -43,7 +43,7 @@ ConvertLogTypes::class, ], - '9.5' => [ + '9.6' => [ RemoveListeners::class, RemoveTestSuiteLoaderAttributes::class, RemoveCacheResultFileAttribute::class, diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/Migration.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/Migration.php index 05359a2d0..6fd052418 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/Migration.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/Migration.php @@ -14,7 +14,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Migration { diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/RemoveLoggingElements.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/RemoveLoggingElements.php index ccccb8199..d40ab029c 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/RemoveLoggingElements.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/RemoveLoggingElements.php @@ -29,7 +29,7 @@ public function migrate(DOMDocument $document): void private function removeTestDoxElement(DOMDocument $document): void { - $nodes = (new DOMXPath($document))->query('logging/testdoxXml'); + $nodes = new DOMXPath($document)->query('logging/testdoxXml'); assert($nodes !== false); @@ -44,7 +44,7 @@ private function removeTestDoxElement(DOMDocument $document): void private function removeTextElement(DOMDocument $document): void { - $nodes = (new DOMXPath($document))->query('logging/text'); + $nodes = new DOMXPath($document)->query('logging/text'); assert($nodes !== false); diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/UpdateSchemaLocation.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/UpdateSchemaLocation.php index 35c8abe81..85b0b568e 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/UpdateSchemaLocation.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrations/UpdateSchemaLocation.php @@ -31,7 +31,7 @@ public function migrate(DOMDocument $document): void assert($root instanceof DOMElement); - $existingSchemaLocation = $root->getAttributeNodeNS(self::NAMESPACE_URI, self::LOCAL_NAME_SCHEMA_LOCATION)->value; + $existingSchemaLocation = $root->getAttributeNS(self::NAMESPACE_URI, self::LOCAL_NAME_SCHEMA_LOCATION); if (str_contains($existingSchemaLocation, '://') === false) { // If the current schema location is a relative path, don't update it return; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrator.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrator.php index 4649dec28..2fe14586d 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/Migration/Migrator.php @@ -10,6 +10,9 @@ namespace PHPUnit\TextUI\XmlConfiguration; use function assert; +use function str_contains; +use DOMDocument; +use DOMElement; use PHPUnit\Runner\Version; use PHPUnit\Util\Xml\Loader as XmlLoader; use PHPUnit\Util\Xml\XmlException; @@ -34,14 +37,18 @@ public function migrate(string $filename): string throw new Exception('The file does not validate against any known schema'); } - if ($origin->version() === Version::series()) { - throw new Exception('The file does not need to be migrated'); - } - $configurationDocument = (new XmlLoader)->loadFile($filename); - foreach ((new MigrationBuilder)->build($origin->version()) as $migration) { - $migration->migrate($configurationDocument); + if ($origin->version() === Version::series()) { + if (!$this->schemaLocationNeedsUpdate($configurationDocument)) { + throw new Exception('The file does not need to be migrated'); + } + + (new UpdateSchemaLocation)->migrate($configurationDocument); + } else { + foreach ((new MigrationBuilder)->build($origin->version()) as $migration) { + $migration->migrate($configurationDocument); + } } $configurationDocument->formatOutput = true; @@ -53,4 +60,22 @@ public function migrate(string $filename): string return $xml; } + + private function schemaLocationNeedsUpdate(DOMDocument $document): bool + { + $root = $document->documentElement; + + assert($root instanceof DOMElement); + + $schemaLocation = $root->getAttributeNS( + 'http://www.w3.org/2001/XMLSchema-instance', + 'noNamespaceSchemaLocation', + ); + + if (!str_contains($schemaLocation, '://')) { + return false; + } + + return $schemaLocation !== 'https://schema.phpunit.de/' . Version::series() . '/phpunit.xsd'; + } } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/PHPUnit.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/PHPUnit.php index 0b384e739..1e5243f26 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/PHPUnit.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/PHPUnit.php @@ -34,6 +34,7 @@ private bool $displayDetailsOnTestsThatTriggerWarnings; private bool $reverseDefectList; private bool $requireCoverageMetadata; + private bool $requireSealedMockObjects; private ?string $bootstrap; /** @@ -47,6 +48,7 @@ private bool $failOnPhpunitNotice; private bool $failOnPhpunitWarning; private bool $failOnEmptyTestSuite; + private bool $hasFailOnEmptyTestSuite; private bool $failOnIncomplete; private bool $failOnNotice; private bool $failOnRisky; @@ -96,7 +98,7 @@ * @param ?non-empty-string $extensionsDirectory * @param non-negative-int $shortenArraysForExportThreshold */ - public function __construct(?string $cacheDirectory, bool $cacheResult, int|string $columns, string $colors, bool $stderr, bool $displayDetailsOnAllIssues, bool $displayDetailsOnIncompleteTests, bool $displayDetailsOnSkippedTests, bool $displayDetailsOnTestsThatTriggerDeprecations, bool $displayDetailsOnPhpunitDeprecations, bool $displayDetailsOnPhpunitNotices, bool $displayDetailsOnTestsThatTriggerErrors, bool $displayDetailsOnTestsThatTriggerNotices, bool $displayDetailsOnTestsThatTriggerWarnings, bool $reverseDefectList, bool $requireCoverageMetadata, ?string $bootstrap, array $bootstrapForTestSuite, bool $processIsolation, bool $failOnAllIssues, bool $failOnDeprecation, bool $failOnPhpunitDeprecation, bool $failOnPhpunitNotice, bool $failOnPhpunitWarning, bool $failOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnNotice, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, bool $stopOnDefect, bool $stopOnDeprecation, bool $stopOnError, bool $stopOnFailure, bool $stopOnIncomplete, bool $stopOnNotice, bool $stopOnRisky, bool $stopOnSkipped, bool $stopOnWarning, ?string $extensionsDirectory, bool $beStrictAboutChangesToGlobalState, bool $beStrictAboutOutputDuringTests, bool $beStrictAboutTestsThatDoNotTestAnything, bool $beStrictAboutCoverageMetadata, bool $enforceTimeLimit, int $defaultTimeLimit, int $timeoutForSmallTests, int $timeoutForMediumTests, int $timeoutForLargeTests, ?string $defaultTestSuite, int $executionOrder, bool $resolveDependencies, bool $defectsFirst, bool $backupGlobals, bool $backupStaticProperties, bool $testdoxPrinter, bool $testdoxPrinterSummary, bool $controlGarbageCollector, int $numberOfTestsBeforeGarbageCollection, int $shortenArraysForExportThreshold) + public function __construct(?string $cacheDirectory, bool $cacheResult, int|string $columns, string $colors, bool $stderr, bool $displayDetailsOnAllIssues, bool $displayDetailsOnIncompleteTests, bool $displayDetailsOnSkippedTests, bool $displayDetailsOnTestsThatTriggerDeprecations, bool $displayDetailsOnPhpunitDeprecations, bool $displayDetailsOnPhpunitNotices, bool $displayDetailsOnTestsThatTriggerErrors, bool $displayDetailsOnTestsThatTriggerNotices, bool $displayDetailsOnTestsThatTriggerWarnings, bool $reverseDefectList, bool $requireCoverageMetadata, bool $requireSealedMockObjects, ?string $bootstrap, array $bootstrapForTestSuite, bool $processIsolation, bool $failOnAllIssues, bool $failOnDeprecation, bool $failOnPhpunitDeprecation, bool $failOnPhpunitNotice, bool $failOnPhpunitWarning, bool $failOnEmptyTestSuite, bool $hasFailOnEmptyTestSuite, bool $failOnIncomplete, bool $failOnNotice, bool $failOnRisky, bool $failOnSkipped, bool $failOnWarning, bool $stopOnDefect, bool $stopOnDeprecation, bool $stopOnError, bool $stopOnFailure, bool $stopOnIncomplete, bool $stopOnNotice, bool $stopOnRisky, bool $stopOnSkipped, bool $stopOnWarning, ?string $extensionsDirectory, bool $beStrictAboutChangesToGlobalState, bool $beStrictAboutOutputDuringTests, bool $beStrictAboutTestsThatDoNotTestAnything, bool $beStrictAboutCoverageMetadata, bool $enforceTimeLimit, int $defaultTimeLimit, int $timeoutForSmallTests, int $timeoutForMediumTests, int $timeoutForLargeTests, ?string $defaultTestSuite, int $executionOrder, bool $resolveDependencies, bool $defectsFirst, bool $backupGlobals, bool $backupStaticProperties, bool $testdoxPrinter, bool $testdoxPrinterSummary, bool $controlGarbageCollector, int $numberOfTestsBeforeGarbageCollection, int $shortenArraysForExportThreshold) { $this->cacheDirectory = $cacheDirectory; $this->cacheResult = $cacheResult; @@ -114,6 +116,7 @@ public function __construct(?string $cacheDirectory, bool $cacheResult, int|stri $this->displayDetailsOnTestsThatTriggerWarnings = $displayDetailsOnTestsThatTriggerWarnings; $this->reverseDefectList = $reverseDefectList; $this->requireCoverageMetadata = $requireCoverageMetadata; + $this->requireSealedMockObjects = $requireSealedMockObjects; $this->bootstrap = $bootstrap; $this->bootstrapForTestSuite = $bootstrapForTestSuite; $this->processIsolation = $processIsolation; @@ -123,6 +126,7 @@ public function __construct(?string $cacheDirectory, bool $cacheResult, int|stri $this->failOnPhpunitNotice = $failOnPhpunitNotice; $this->failOnPhpunitWarning = $failOnPhpunitWarning; $this->failOnEmptyTestSuite = $failOnEmptyTestSuite; + $this->hasFailOnEmptyTestSuite = $hasFailOnEmptyTestSuite; $this->failOnIncomplete = $failOnIncomplete; $this->failOnNotice = $failOnNotice; $this->failOnRisky = $failOnRisky; @@ -255,6 +259,11 @@ public function requireCoverageMetadata(): bool return $this->requireCoverageMetadata; } + public function requireSealedMockObjects(): bool + { + return $this->requireSealedMockObjects; + } + /** * @phpstan-assert-if-true !null $this->bootstrap */ @@ -318,6 +327,11 @@ public function failOnEmptyTestSuite(): bool return $this->failOnEmptyTestSuite; } + public function hasFailOnEmptyTestSuite(): bool + { + return $this->hasFailOnEmptyTestSuite; + } + public function failOnIncomplete(): bool { return $this->failOnIncomplete; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/SchemaDetector/SuccessfulSchemaDetectionResult.php b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/SchemaDetector/SuccessfulSchemaDetectionResult.php index 18658f87f..72a64c193 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/SchemaDetector/SuccessfulSchemaDetectionResult.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/SchemaDetector/SuccessfulSchemaDetectionResult.php @@ -37,6 +37,8 @@ public function detected(): bool } /** + * @throws void + * * @return non-empty-string */ public function version(): string diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Help.php b/app/vendor/phpunit/phpunit/src/TextUI/Help.php index 639a5be38..b41648958 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Help.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Help.php @@ -170,6 +170,7 @@ private function elements(): array ], 'Selection' => [ + ['arg' => '--all', 'desc' => 'Ignore test selection from XML configuration file'], ['arg' => '--list-suites', 'desc' => 'List available test suites'], ['arg' => '--testsuite ', 'desc' => 'Only run tests from the specified test suite(s)'], ['arg' => '--exclude-testsuite ', 'desc' => 'Exclude tests from the specified test suite(s)'], @@ -185,6 +186,7 @@ private function elements(): array ['arg' => '--filter ', 'desc' => 'Filter which tests to run'], ['arg' => '--exclude-filter ', 'desc' => 'Exclude tests for the specified filter pattern'], ['arg' => '--test-suffix ', 'desc' => 'Only search for test in files with specified suffix(es). Default: Test.php,.phpt'], + ['arg' => '--test-files-file ', 'desc' => 'Only run test files listed in file (one file by line)'], ], 'Execution' => [ @@ -242,11 +244,15 @@ private function elements(): array ['spacer' => ''], ['arg' => '--order-by ', 'desc' => 'Run tests in order: default|defects|depends|duration|no-depends|random|reverse|size'], + ['arg' => '--resolve-dependencies', 'desc' => 'Alias for "--order-by depends"'], + ['arg' => '--ignore-dependencies', 'desc' => 'Alias for "--order-by no-depends"'], + ['arg' => '--random-order', 'desc' => 'Alias for "--order-by random"'], ['arg' => '--random-order-seed ', 'desc' => 'Use the specified random seed when running tests in random order'], + ['arg' => '--reverse-order', 'desc' => 'Alias for "--order-by reverse"'], ], 'Reporting' => [ - ['arg' => '--colors ', 'desc' => 'Use colors in output ("never", "auto" or "always")'], + ['arg' => '--colors=', 'desc' => 'Use colors in output ("never", "auto" or "always")'], ['arg' => '--columns ', 'desc' => 'Number of columns to use for progress output'], ['arg' => '--columns max', 'desc' => 'Use maximum number of columns for progress output'], ['arg' => '--stderr', 'desc' => 'Write to STDERR instead of STDOUT'], @@ -281,12 +287,12 @@ private function elements(): array 'Logging' => [ ['arg' => '--log-junit ', 'desc' => 'Write test results in JUnit XML format to file'], ['arg' => '--log-otr ', 'desc' => 'Write test results in Open Test Reporting XML format to file'], - ['arg' => '--include-git-information', 'desc' => 'Include Git information in Open Test Reporting XML logfile'], ['arg' => '--log-teamcity ', 'desc' => 'Write test results in TeamCity format to file'], ['arg' => '--testdox-html ', 'desc' => 'Write test results in TestDox format (HTML) to file'], ['arg' => '--testdox-text ', 'desc' => 'Write test results in TestDox format (plain text) to file'], ['arg' => '--log-events-text ', 'desc' => 'Stream events as plain text to file'], ['arg' => '--log-events-verbose-text ', 'desc' => 'Stream events as plain text with extended information to file'], + ['arg' => '--include-git-information', 'desc' => 'Include Git information in supported formats'], ['arg' => '--no-logging', 'desc' => 'Ignore logging configured in the XML configuration file'], ], @@ -301,6 +307,7 @@ private function elements(): array ['arg' => '--only-summary-for-coverage-text', 'desc' => 'Option for code coverage report in text format: only show summary'], ['arg' => '--show-uncovered-for-coverage-text', 'desc' => 'Option for code coverage report in text format: show uncovered files'], ['arg' => '--coverage-xml ', 'desc' => 'Write code coverage report in XML format to directory'], + ['arg' => '--exclude-source-from-xml-coverage', 'desc' => 'Exclude element from code coverage report in XML format'], ['arg' => '--warm-coverage-cache', 'desc' => 'Warm static analysis cache'], ['arg' => '--coverage-filter ', 'desc' => 'Include in code coverage reporting'], ['arg' => '--path-coverage', 'desc' => 'Report path coverage in addition to line coverage'], diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/ProgressPrinter.php b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/ProgressPrinter.php index bcee39960..0153ef10f 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/ProgressPrinter.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/ProgressPrinter.php @@ -90,6 +90,13 @@ public function testSkipped(): void } } + public function testSuiteSkipped(int $countTests): void + { + for ($i = 0; $i < $countTests; $i++) { + $this->testSkipped(); + } + } + public function testMarkedIncomplete(): void { $this->updateTestStatus(TestStatus::incomplete()); @@ -137,8 +144,7 @@ public function testTriggeredDeprecation(DeprecationTriggered $event): void return; } - if ($this->source->ignoreSelfDeprecations() && - ($event->trigger()->isTest() || $event->trigger()->isSelf())) { + if ($this->source->ignoreSelfDeprecations() && $event->trigger()->isSelf()) { return; } @@ -163,8 +169,7 @@ public function testTriggeredPhpDeprecation(PhpDeprecationTriggered $event): voi return; } - if ($this->source->ignoreSelfDeprecations() && - ($event->trigger()->isTest() || $event->trigger()->isSelf())) { + if ($this->source->ignoreSelfDeprecations() && $event->trigger()->isSelf()) { return; } @@ -188,6 +193,11 @@ public function testTriggeredPhpunitDeprecation(): void $this->updateTestStatus(TestStatus::deprecation()); } + public function testTriggeredPhpunitNotice(): void + { + $this->updateTestStatus(TestStatus::notice()); + } + public function testConsideredRisky(): void { $this->updateTestStatus(TestStatus::risky()); @@ -311,11 +321,13 @@ private function registerSubscribers(Facade $facade): void new TestPreparedSubscriber($this), new TestRunnerExecutionStartedSubscriber($this), new TestSkippedSubscriber($this), + new TestSuiteSkippedSubscriber($this), new TestTriggeredDeprecationSubscriber($this), new TestTriggeredNoticeSubscriber($this), new TestTriggeredPhpDeprecationSubscriber($this), new TestTriggeredPhpNoticeSubscriber($this), new TestTriggeredPhpunitDeprecationSubscriber($this), + new TestTriggeredPhpunitNoticeSubscriber($this), new TestTriggeredPhpunitWarningSubscriber($this), new TestTriggeredPhpWarningSubscriber($this), new TestTriggeredWarningSubscriber($this), diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/Subscriber/TestSuiteSkippedSubscriber.php b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/Subscriber/TestSuiteSkippedSubscriber.php new file mode 100644 index 000000000..1054df188 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/Subscriber/TestSuiteSkippedSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\TextUI\Output\Default\ProgressPrinter; + +use PHPUnit\Event\TestSuite\Skipped; +use PHPUnit\Event\TestSuite\SkippedSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestSuiteSkippedSubscriber extends Subscriber implements SkippedSubscriber +{ + public function notify(Skipped $event): void + { + $this->printer()->testSuiteSkipped($event->testSuite()->count()); + } +} diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/Subscriber/TestTriggeredPhpunitNoticeSubscriber.php b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/Subscriber/TestTriggeredPhpunitNoticeSubscriber.php new file mode 100644 index 000000000..6b0e48cfd --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ProgressPrinter/Subscriber/TestTriggeredPhpunitNoticeSubscriber.php @@ -0,0 +1,26 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\TextUI\Output\Default\ProgressPrinter; + +use PHPUnit\Event\Test\PhpunitNoticeTriggered; +use PHPUnit\Event\Test\PhpunitNoticeTriggeredSubscriber; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class TestTriggeredPhpunitNoticeSubscriber extends Subscriber implements PhpunitNoticeTriggeredSubscriber +{ + public function notify(PhpunitNoticeTriggered $event): void + { + $this->printer()->testTriggeredPhpunitNotice(); + } +} diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ResultPrinter.php b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ResultPrinter.php index 555382db4..22fb63498 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ResultPrinter.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Output/Default/ResultPrinter.php @@ -27,7 +27,9 @@ use PHPUnit\Event\Code\Test; use PHPUnit\Event\Code\TestMethod; use PHPUnit\Event\Test\AfterLastTestMethodErrored; +use PHPUnit\Event\Test\AfterLastTestMethodFailed; use PHPUnit\Event\Test\BeforeFirstTestMethodErrored; +use PHPUnit\Event\Test\BeforeFirstTestMethodFailed; use PHPUnit\Event\Test\ConsideredRisky; use PHPUnit\Event\Test\DeprecationTriggered; use PHPUnit\Event\Test\ErrorTriggered; @@ -326,6 +328,12 @@ private function printTestsWithFailedAssertions(TestResult $result): void $elements = []; foreach ($result->testFailedEvents() as $event) { + if ($event instanceof AfterLastTestMethodFailed || $event instanceof BeforeFirstTestMethodFailed) { + $title = $event->testClassName(); + } else { + $title = $this->name($event->test()); + } + $body = $event->throwable()->asString(); if (str_starts_with($body, 'AssertionError: ')) { @@ -333,7 +341,7 @@ private function printTestsWithFailedAssertions(TestResult $result): void } $elements[] = [ - 'title' => $this->name($event->test()), + 'title' => $title, 'body' => $body, ]; } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Output/Facade.php b/app/vendor/phpunit/phpunit/src/TextUI/Output/Facade.php index 2a50017b0..c4b3de0f9 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Output/Facade.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Output/Facade.php @@ -67,6 +67,8 @@ public static function init(Configuration $configuration, bool $extensionReplace ); } + assert(self::$printer !== null); + return self::$printer; } @@ -106,7 +108,7 @@ public static function printResult(TestResult $result, ?array $testDoxResult, Du public static function printerFor(string $target): Printer { if ($target === 'php://stdout') { - if (!self::$printer instanceof NullPrinter) { + if (self::$printer !== null && !self::$printer instanceof NullPrinter) { return self::$printer; } diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Output/SummaryPrinter.php b/app/vendor/phpunit/phpunit/src/TextUI/Output/SummaryPrinter.php index 4f3e66183..918164bbb 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Output/SummaryPrinter.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Output/SummaryPrinter.php @@ -62,33 +62,33 @@ public function print(TestResult $result): void return; } - $color = 'fg-black, bg-yellow'; - if ($result->wasSuccessful()) { if ($result->hasIssues()) { + $color = 'fg-black, bg-yellow'; + $this->printWithColor( $color, 'OK, but there were issues!', ); } else { + $color = 'fg-black, bg-green'; + $this->printWithColor( $color, 'OK, but some tests were skipped!', ); } } else { - if ($result->hasTestErroredEvents() || $result->hasTestTriggeredPhpunitErrorEvents()) { - $color = 'fg-white, bg-red'; + $color = 'fg-white, bg-red'; + if ($result->hasTestErroredEvents() || $result->hasTestTriggeredPhpunitErrorEvents()) { $this->printWithColor( - $color, + 'fg-white, bg-red', 'ERRORS!', ); } else { - $color = 'fg-white, bg-red'; - $this->printWithColor( - $color, + 'fg-white, bg-red', 'FAILURES!', ); } @@ -104,7 +104,7 @@ public function print(TestResult $result): void $this->printCountString($result->numberOfPhpunitDeprecations(), 'PHPUnit Deprecations', $color); $this->printCountString($result->numberOfPhpunitNotices(), 'PHPUnit Notices', $color); $this->printCountString($result->numberOfNotices(), 'Notices', $color); - $this->printCountString($result->numberOfTestSuiteSkippedEvents() + $result->numberOfTestSkippedEvents(), 'Skipped', $color); + $this->printCountString($result->numberOfTestSkippedByTestSuiteSkippedEvents() + $result->numberOfTestSkippedEvents(), 'Skipped', $color); $this->printCountString($result->numberOfTestMarkedIncompleteEvents(), 'Incomplete', $color); $this->printCountString($result->numberOfTestsWithTestConsideredRiskyEvents(), 'Risky', $color); $this->printWithColor($color, '.'); diff --git a/app/vendor/phpunit/phpunit/src/TextUI/Output/TestDox/ResultPrinter.php b/app/vendor/phpunit/phpunit/src/TextUI/Output/TestDox/ResultPrinter.php index 27ae3cede..946454260 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/Output/TestDox/ResultPrinter.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/Output/TestDox/ResultPrinter.php @@ -50,7 +50,7 @@ public function __construct(Printer $printer, bool $colors, int $columns, bool $ } /** - * @param array $tests + * @param array $tests */ public function print(TestResult $result, array $tests): void { @@ -87,11 +87,11 @@ public function print(TestResult $result, array $tests): void } /** - * @param array $tests + * @param array $tests */ private function doPrint(array $tests, bool $onlySummary): void { - foreach ($tests as $prettifiedClassName => $_tests) { + foreach ($tests as $_tests) { $print = true; if ($onlySummary) { @@ -116,7 +116,7 @@ private function doPrint(array $tests, bool $onlySummary): void continue; } - $this->printPrettifiedClassName($prettifiedClassName); + $this->printPrettifiedClassName($_tests->asArray()[0]->test()->testDox()->prettifiedClassName()); foreach ($_tests as $test) { if ($onlySummary && $test->status()->isSuccess()) { @@ -286,7 +286,7 @@ private function colorizeMessageAndDiff(string $buffer, string $style): array $lines = []; if ($buffer !== '') { - $lines = array_map('\rtrim', explode(PHP_EOL, $buffer)); + $lines = array_map(rtrim(...), explode(PHP_EOL, $buffer)); } $message = []; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/ShellExitCodeCalculator.php b/app/vendor/phpunit/phpunit/src/TextUI/ShellExitCodeCalculator.php index c566a3832..cc95d33c1 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/ShellExitCodeCalculator.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/ShellExitCodeCalculator.php @@ -28,7 +28,7 @@ public function calculate(Configuration $configuration, TestResult $result): int $failOnDeprecation = false; $failOnPhpunitDeprecation = false; $failOnPhpunitNotice = false; - $failOnPhpunitWarning = true; + $failOnPhpunitWarning = false; $failOnEmptyTestSuite = false; $failOnIncomplete = false; $failOnNotice = false; diff --git a/app/vendor/phpunit/phpunit/src/TextUI/TestRunner.php b/app/vendor/phpunit/phpunit/src/TextUI/TestRunner.php index 2363ca290..6e6107b5f 100644 --- a/app/vendor/phpunit/phpunit/src/TextUI/TestRunner.php +++ b/app/vendor/phpunit/phpunit/src/TextUI/TestRunner.php @@ -41,7 +41,7 @@ public function run(Configuration $configuration, ResultCache $resultCache, Test $configuration->resolveDependencies()) { $resultCache->load(); - (new TestSuiteSorter($resultCache))->reorderTestsInSuite( + new TestSuiteSorter($resultCache)->reorderTestsInSuite( $suite, $configuration->executionOrder(), $configuration->resolveDependencies(), diff --git a/app/vendor/phpunit/phpunit/src/Util/Color.php b/app/vendor/phpunit/phpunit/src/Util/Color.php index c225e37b7..334267f10 100644 --- a/app/vendor/phpunit/phpunit/src/Util/Color.php +++ b/app/vendor/phpunit/phpunit/src/Util/Color.php @@ -11,8 +11,10 @@ use const DIRECTORY_SEPARATOR; use const PHP_EOL; +use function array_key_exists; use function array_map; use function array_walk; +use function assert; use function count; use function explode; use function implode; @@ -23,6 +25,7 @@ use function preg_split; use function sprintf; use function str_pad; +use function strlen; use function strtr; use function trim; @@ -80,17 +83,25 @@ final class Color 'bg-white' => '47', ]; + /** + * @param non-empty-string $color + */ public static function colorize(string $color, string $buffer): string { if (trim($buffer) === '') { return $buffer; } - $codes = array_map('\trim', explode(',', $color)); + if (array_key_exists($color, self::ANSI_CODES)) { + return self::optimizeColor(sprintf("\x1b[%sm%s\x1b[0m", self::ANSI_CODES[$color], $buffer)); + } + $styles = []; - foreach ($codes as $code) { - if (isset(self::ANSI_CODES[$code])) { + foreach (explode(',', $color) as $code) { + $code = trim($code); + + if (array_key_exists($code, self::ANSI_CODES)) { $styles[] = self::ANSI_CODES[$code]; } } @@ -99,13 +110,17 @@ public static function colorize(string $color, string $buffer): string return $buffer; } - return self::optimizeColor(sprintf("\x1b[%sm", implode(';', $styles)) . $buffer . "\x1b[0m"); + return self::optimizeColor(sprintf("\x1b[%sm%s\x1b[0m", implode(';', $styles), $buffer)); } + /** + * @param non-empty-string $color + * @param ?non-negative-int $columns + */ public static function colorizeTextBox(string $color, string $buffer, ?int $columns = null): string { $lines = preg_split('/\r\n|\r|\n/', $buffer); - $maxBoxWidth = max(array_map('\strlen', $lines)); + $maxBoxWidth = max(array_map(strlen(...), $lines)); if ($columns !== null) { $maxBoxWidth = min($maxBoxWidth, $columns); @@ -119,6 +134,10 @@ public static function colorizeTextBox(string $color, string $buffer, ?int $colu return implode(PHP_EOL, $lines); } + /** + * @param non-empty-string $path + * @param ?non-empty-string $previousPath + */ public static function colorizePath(string $path, ?string $previousPath = null, bool $colorizeFilename = false): string { if ($previousPath === null) { @@ -159,16 +178,20 @@ public static function visualizeWhitespace(string $buffer, bool $visualizeEOL = { $replaceMap = $visualizeEOL ? self::WHITESPACE_EOL_MAP : self::WHITESPACE_MAP; - return preg_replace_callback( + $result = preg_replace_callback( '/\s+/', static fn (array $matches) => self::dim(strtr($matches[0], $replaceMap)), $buffer, ); + + assert($result !== null); + + return $result; } private static function optimizeColor(string $buffer): string { - return preg_replace( + $result = preg_replace( [ "/\e\\[22m\e\\[2m/", "/\e\\[([^m]*)m\e\\[([1-9][0-9;]*)m/", @@ -181,5 +204,9 @@ private static function optimizeColor(string $buffer): string ], $buffer, ); + + assert($result !== null); + + return $result; } } diff --git a/app/vendor/phpunit/phpunit/src/Util/ExcludeList.php b/app/vendor/phpunit/phpunit/src/Util/ExcludeList.php index 7ec8d4273..1e3edd4e4 100644 --- a/app/vendor/phpunit/phpunit/src/Util/ExcludeList.php +++ b/app/vendor/phpunit/phpunit/src/Util/ExcludeList.php @@ -10,6 +10,7 @@ namespace PHPUnit\Util; use const PHP_OS_FAMILY; +use function array_any; use function assert; use function class_exists; use function defined; @@ -186,13 +187,10 @@ public function isExcluded(string $file): bool self::initialize(); - foreach (self::$directories as $directory) { - if (str_starts_with($file, $directory)) { - return true; - } - } - - return false; + return array_any( + self::$directories, + static fn (string $directory) => str_starts_with($file, $directory), + ); } private static function initialize(): void @@ -206,7 +204,7 @@ private static function initialize(): void continue; } - $directory = (new ReflectionClass($className))->getFileName(); + $directory = new ReflectionClass($className)->getFileName(); for ($i = 0; $i < $parent; $i++) { $directory = dirname($directory); diff --git a/app/vendor/phpunit/phpunit/src/Util/Exporter.php b/app/vendor/phpunit/phpunit/src/Util/Exporter.php index 182499e9d..ed8a7b1ca 100644 --- a/app/vendor/phpunit/phpunit/src/Util/Exporter.php +++ b/app/vendor/phpunit/phpunit/src/Util/Exporter.php @@ -21,7 +21,9 @@ final class Exporter public static function export(mixed $value): string { - return self::exporter()->export($value); + return Sanitizer::sanitizeBidirectionalControlCharacters( + self::exporter()->export($value), + ); } /** @@ -29,12 +31,16 @@ public static function export(mixed $value): string */ public static function shortenedRecursiveExport(array $data): string { - return self::exporter()->shortenedRecursiveExport($data); + return Sanitizer::sanitizeBidirectionalControlCharacters( + self::exporter()->shortenedRecursiveExport($data), + ); } public static function shortenedExport(mixed $value): string { - return self::exporter()->shortenedExport($value); + return Sanitizer::sanitizeBidirectionalControlCharacters( + self::exporter()->shortenedExport($value), + ); } private static function exporter(): OriginalExporter diff --git a/app/vendor/phpunit/phpunit/src/Util/Filter.php b/app/vendor/phpunit/phpunit/src/Util/Filter.php index 122e5c065..1abb00636 100644 --- a/app/vendor/phpunit/phpunit/src/Util/Filter.php +++ b/app/vendor/phpunit/phpunit/src/Util/Filter.php @@ -9,6 +9,7 @@ */ namespace PHPUnit\Util; +use function array_any; use function array_unshift; use function defined; use function in_array; @@ -124,12 +125,9 @@ private static function fileIsExcluded(string $file, ExcludeList $excludeList): */ private static function frameExists(array $trace, string $file, int $line): bool { - foreach ($trace as $frame) { - if (isset($frame['file'], $frame['line']) && $frame['file'] === $file && $frame['line'] === $line) { - return true; - } - } - - return false; + return array_any( + $trace, + static fn (array $frame) => isset($frame['file'], $frame['line']) && $frame['file'] === $file && $frame['line'] === $line, + ); } } diff --git a/app/vendor/phpunit/phpunit/src/Util/GlobalState.php b/app/vendor/phpunit/phpunit/src/Util/GlobalState.php index 717ad4dc4..ecf23b7a5 100644 --- a/app/vendor/phpunit/phpunit/src/Util/GlobalState.php +++ b/app/vendor/phpunit/phpunit/src/Util/GlobalState.php @@ -30,6 +30,7 @@ use function strtr; use function var_export; use Closure; +use Throwable; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit @@ -51,6 +52,24 @@ '_REQUEST', ]; + /** + * Keys in $_SERVER that are populated by the SAPI in the child process + * and must therefore not be preserved from the parent process. + * + * @var non-empty-list + */ + private const array SAPI_SERVER_KEYS = [ + 'PHP_SELF', + 'SCRIPT_NAME', + 'SCRIPT_FILENAME', + 'PATH_TRANSLATED', + 'DOCUMENT_ROOT', + 'REQUEST_TIME', + 'REQUEST_TIME_FLOAT', + 'argv', + 'argc', + ]; + /** * @var non-empty-array> */ @@ -122,6 +141,42 @@ 'mbstring.internal_encoding' => true, 'oci8.old_oci_close_semantics' => true, ], + + '8.4' => [ + 'auto_detect_line_endings' => true, + 'filter.default' => true, + 'iconv.input_encoding' => true, + 'iconv.output_encoding' => true, + 'iconv.internal_encoding' => true, + 'mbstring.http_input' => true, + 'mbstring.http_output' => true, + 'mbstring.internal_encoding' => true, + 'oci8.old_oci_close_semantics' => true, + ], + + '8.5' => [ + 'auto_detect_line_endings' => true, + 'filter.default' => true, + 'iconv.input_encoding' => true, + 'iconv.output_encoding' => true, + 'iconv.internal_encoding' => true, + 'mbstring.http_input' => true, + 'mbstring.http_output' => true, + 'mbstring.internal_encoding' => true, + 'oci8.old_oci_close_semantics' => true, + ], + + '8.6' => [ + 'auto_detect_line_endings' => true, + 'filter.default' => true, + 'iconv.input_encoding' => true, + 'iconv.output_encoding' => true, + 'iconv.internal_encoding' => true, + 'mbstring.http_input' => true, + 'mbstring.http_output' => true, + 'mbstring.internal_encoding' => true, + 'oci8.old_oci_close_semantics' => true, + ], ]; /** @@ -226,23 +281,36 @@ public static function getConstantsAsString(): string return $result; } - public static function getGlobalsAsString(): string + public static function exportGlobals(): GlobalStateResult { - $result = ''; + $result = ''; + $skippedGlobals = []; foreach (self::SUPER_GLOBAL_ARRAYS as $superGlobalArray) { if (isset($GLOBALS[$superGlobalArray]) && is_array($GLOBALS[$superGlobalArray])) { foreach ($GLOBALS[$superGlobalArray] as $key => $value) { + if ($superGlobalArray === '_SERVER' && in_array($key, self::SAPI_SERVER_KEYS, true)) { + continue; + } + + $name = sprintf('$GLOBALS[\'%s\'][\'%s\']', $superGlobalArray, $key); + if ($value instanceof Closure) { + $skippedGlobals[] = ['name' => $name, 'reason' => 'is a Closure']; + continue; } - $result .= sprintf( - '$GLOBALS[\'%s\'][\'%s\'] = %s;' . "\n", - $superGlobalArray, - $key, - self::exportVariable($GLOBALS[$superGlobalArray][$key]), - ); + try { + $result .= sprintf( + '$GLOBALS[\'%s\'][\'%s\'] = %s;' . "\n", + $superGlobalArray, + $key, + self::exportVariable($GLOBALS[$superGlobalArray][$key]), + ); + } catch (Throwable) { + $skippedGlobals[] = ['name' => $name, 'reason' => 'is not serializable']; + } } } } @@ -251,16 +319,30 @@ public static function getGlobalsAsString(): string $excludeList[] = 'GLOBALS'; foreach ($GLOBALS as $key => $value) { - if (!$value instanceof Closure && !in_array($key, $excludeList, true)) { + if (in_array($key, $excludeList, true)) { + continue; + } + + $name = sprintf('$GLOBALS[\'%s\']', $key); + + if ($value instanceof Closure) { + $skippedGlobals[] = ['name' => $name, 'reason' => 'is a Closure']; + + continue; + } + + try { $result .= sprintf( '$GLOBALS[\'%s\'] = %s;' . "\n", $key, self::exportVariable($value), ); + } catch (Throwable) { + $skippedGlobals[] = ['name' => $name, 'reason' => 'is not serializable']; } } - return $result; + return new GlobalStateResult($result, $skippedGlobals); } private static function exportVariable(mixed $variable): string diff --git a/app/vendor/phpunit/phpunit/src/Util/GlobalStateResult.php b/app/vendor/phpunit/phpunit/src/Util/GlobalStateResult.php new file mode 100644 index 000000000..290c7986d --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Util/GlobalStateResult.php @@ -0,0 +1,57 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Util; + +/** + * @immutable + * + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class GlobalStateResult +{ + /** + * @param list $skippedGlobals + */ + private string $globalsString; + + /** + * @var list + */ + private array $skippedGlobals; + + /** + * @param list $skippedGlobals + */ + public function __construct(string $globalsString, array $skippedGlobals) + { + $this->globalsString = $globalsString; + $this->skippedGlobals = $skippedGlobals; + } + + public function globalsString(): string + { + return $this->globalsString; + } + + /** + * @return list + */ + public function skippedGlobals(): array + { + return $this->skippedGlobals; + } + + public function hasSkippedGlobals(): bool + { + return $this->skippedGlobals !== []; + } +} diff --git a/app/vendor/phpunit/phpunit/src/Util/Http/Downloader.php b/app/vendor/phpunit/phpunit/src/Util/Http/Downloader.php index a9af2e38f..4e8252bc0 100644 --- a/app/vendor/phpunit/phpunit/src/Util/Http/Downloader.php +++ b/app/vendor/phpunit/phpunit/src/Util/Http/Downloader.php @@ -12,7 +12,7 @@ /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * - * @internal This class is not covered by the backward compatibility promise for PHPUnit + * @internal This interface is not covered by the backward compatibility promise for PHPUnit */ interface Downloader { diff --git a/app/vendor/phpunit/phpunit/src/Util/PHP/DefaultJobRunner.php b/app/vendor/phpunit/phpunit/src/Util/PHP/DefaultJobRunner.php deleted file mode 100644 index 073e4e4d4..000000000 --- a/app/vendor/phpunit/phpunit/src/Util/PHP/DefaultJobRunner.php +++ /dev/null @@ -1,246 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace PHPUnit\Util\PHP; - -use const PHP_BINARY; -use const PHP_SAPI; -use function array_keys; -use function array_merge; -use function array_values; -use function assert; -use function fclose; -use function file_put_contents; -use function function_exists; -use function fwrite; -use function ini_get_all; -use function is_array; -use function is_resource; -use function proc_close; -use function proc_open; -use function stream_get_contents; -use function sys_get_temp_dir; -use function tempnam; -use function trim; -use function unlink; -use function xdebug_is_debugger_active; -use PHPUnit\Event\Facade; -use PHPUnit\Runner\CodeCoverage; -use SebastianBergmann\Environment\Runtime; - -/** - * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit - * - * @internal This class is not covered by the backward compatibility promise for PHPUnit - */ -final readonly class DefaultJobRunner extends JobRunner -{ - /** - * @throws PhpProcessException - */ - public function run(Job $job): Result - { - $temporaryFile = null; - - if ($job->hasInput()) { - $temporaryFile = tempnam(sys_get_temp_dir(), 'phpunit_'); - - if ($temporaryFile === false || - file_put_contents($temporaryFile, $job->code()) === false) { - // @codeCoverageIgnoreStart - throw new PhpProcessException( - 'Unable to write temporary file', - ); - // @codeCoverageIgnoreEnd - } - - $job = new Job( - $job->input(), - $job->phpSettings(), - $job->environmentVariables(), - $job->arguments(), - null, - $job->redirectErrors(), - ); - } - - assert($temporaryFile !== ''); - - return $this->runProcess($job, $temporaryFile); - } - - /** - * @param ?non-empty-string $temporaryFile - * - * @throws PhpProcessException - */ - private function runProcess(Job $job, ?string $temporaryFile): Result - { - $environmentVariables = null; - - if ($job->hasEnvironmentVariables()) { - /** @phpstan-ignore nullCoalesce.variable */ - $environmentVariables = $_SERVER ?? []; - - unset($environmentVariables['argv'], $environmentVariables['argc']); - - $environmentVariables = array_merge($environmentVariables, $job->environmentVariables()); - - foreach ($environmentVariables as $key => $value) { - if (is_array($value)) { - unset($environmentVariables[$key]); - } - } - - unset($key, $value); - } - - $pipeSpec = [ - 0 => ['pipe', 'r'], - 1 => ['pipe', 'w'], - 2 => ['pipe', 'w'], - ]; - - if ($job->redirectErrors()) { - $pipeSpec[2] = ['redirect', 1]; - } - - $process = proc_open( - $this->buildCommand($job, $temporaryFile), - $pipeSpec, - $pipes, - null, - $environmentVariables, - ); - - if (!is_resource($process)) { - // @codeCoverageIgnoreStart - throw new PhpProcessException( - 'Unable to spawn worker process', - ); - // @codeCoverageIgnoreEnd - } - - Facade::emitter()->childProcessStarted(); - - fwrite($pipes[0], $job->code()); - fclose($pipes[0]); - - $stdout = ''; - $stderr = ''; - - if (isset($pipes[1])) { - $stdout = stream_get_contents($pipes[1]); - - fclose($pipes[1]); - } - - if (isset($pipes[2])) { - $stderr = stream_get_contents($pipes[2]); - - fclose($pipes[2]); - } - - proc_close($process); - - if ($temporaryFile !== null) { - unlink($temporaryFile); - } - - assert($stdout !== false); - assert($stderr !== false); - - return new Result($stdout, $stderr); - } - - /** - * @return non-empty-list - */ - private function buildCommand(Job $job, ?string $file): array - { - $runtime = new Runtime; - $command = [PHP_BINARY]; - $phpSettings = $job->phpSettings(); - - if ($runtime->hasPCOV()) { - $pcovSettings = ini_get_all('pcov'); - - assert($pcovSettings !== false); - - $phpSettings = array_merge( - $phpSettings, - $runtime->getCurrentSettings( - array_keys($pcovSettings), - ), - ); - } elseif ($runtime->hasXdebug()) { - assert(function_exists('xdebug_is_debugger_active')); - - $xdebugSettings = ini_get_all('xdebug'); - - assert($xdebugSettings !== false); - - $phpSettings = array_merge( - $phpSettings, - $runtime->getCurrentSettings( - array_keys($xdebugSettings), - ), - ); - - if (!CodeCoverage::instance()->isActive() && - xdebug_is_debugger_active() === false) { - $phpSettings['xdebug.mode'] = 'xdebug.mode=off'; - } - } - - $command = array_merge($command, $this->settingsToParameters(array_values($phpSettings))); - - if (PHP_SAPI === 'phpdbg') { - $command[] = '-qrr'; - - if ($file === null) { - $command[] = 's='; - } - } - - if ($file !== null) { - $command[] = '-f'; - $command[] = $file; - } - - if ($job->hasArguments()) { - if ($file === null) { - $command[] = '--'; - } - - foreach ($job->arguments() as $argument) { - $command[] = trim($argument); - } - } - - return $command; - } - - /** - * @param list $settings - * - * @return list - */ - private function settingsToParameters(array $settings): array - { - $buffer = []; - - foreach ($settings as $setting) { - $buffer[] = '-d'; - $buffer[] = $setting; - } - - return $buffer; - } -} diff --git a/app/vendor/phpunit/phpunit/src/Util/PHP/Job.php b/app/vendor/phpunit/phpunit/src/Util/PHP/Job.php index 5405590ac..172d3f593 100644 --- a/app/vendor/phpunit/phpunit/src/Util/PHP/Job.php +++ b/app/vendor/phpunit/phpunit/src/Util/PHP/Job.php @@ -43,6 +43,7 @@ */ private ?string $input; private bool $redirectErrors; + private bool $requiresXdebug; /** * @param non-empty-string $code @@ -51,7 +52,7 @@ * @param list $arguments * @param ?non-empty-string $input */ - public function __construct(string $code, array $phpSettings = [], array $environmentVariables = [], array $arguments = [], ?string $input = null, bool $redirectErrors = false) + public function __construct(string $code, array $phpSettings = [], array $environmentVariables = [], array $arguments = [], ?string $input = null, bool $redirectErrors = false, bool $requiresXdebug = false) { $this->code = $code; $this->phpSettings = $phpSettings; @@ -59,6 +60,7 @@ public function __construct(string $code, array $phpSettings = [], array $enviro $this->arguments = $arguments; $this->input = $input; $this->redirectErrors = $redirectErrors; + $this->requiresXdebug = $requiresXdebug; } /** @@ -135,4 +137,9 @@ public function redirectErrors(): bool { return $this->redirectErrors; } + + public function requiresXdebug(): bool + { + return $this->requiresXdebug; + } } diff --git a/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunner.php b/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunner.php index 6805a0c44..13a1c2430 100644 --- a/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunner.php +++ b/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunner.php @@ -9,20 +9,48 @@ */ namespace PHPUnit\Util\PHP; +use const PHP_BINARY; +use const PHP_SAPI; +use function array_keys; +use function array_merge; +use function array_values; use function assert; +use function count; +use function explode; +use function fclose; use function file_get_contents; +use function file_put_contents; +use function function_exists; +use function fwrite; +use function ini_get_all; +use function is_array; use function is_file; +use function is_resource; +use function proc_close; +use function proc_open; +use function sprintf; +use function str_contains; +use function str_replace; +use function str_starts_with; +use function stream_get_contents; +use function sys_get_temp_dir; +use function tempnam; +use function trim; use function unlink; +use function xdebug_is_debugger_active; +use PHPUnit\Event\Facade; use PHPUnit\Event\Facade as EventFacade; use PHPUnit\Framework\ChildProcessResultProcessor; use PHPUnit\Framework\Test; +use PHPUnit\Runner\CodeCoverage; +use SebastianBergmann\Environment\Runtime; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit * * @internal This class is not covered by the backward compatibility promise for PHPUnit */ -abstract readonly class JobRunner +final readonly class JobRunner { private ChildProcessResultProcessor $processor; @@ -32,9 +60,10 @@ public function __construct(ChildProcessResultProcessor $processor) } /** - * @param non-empty-string $processResultFile + * @param non-empty-string $processResultFile + * @param ?non-empty-string $processResultNonce */ - final public function runTestJob(Job $job, string $processResultFile, Test $test): void + public function runTestJob(Job $job, string $processResultFile, Test $test, ?string $processResultNonce = null): void { $result = $this->run($job); @@ -52,10 +81,308 @@ final public function runTestJob(Job $job, string $processResultFile, Test $test $test, $processResult, $result->stderr(), + $processResultNonce, ); EventFacade::emitter()->childProcessFinished($result->stdout(), $result->stderr()); } - abstract public function run(Job $job): Result; + /** + * @throws PhpProcessException + */ + public function run(Job $job): Result + { + $temporaryFile = null; + + if ($job->hasInput()) { + $temporaryFile = tempnam(sys_get_temp_dir(), 'phpunit_'); + + if ($temporaryFile === false || + file_put_contents($temporaryFile, $job->code()) === false) { + // @codeCoverageIgnoreStart + throw new PhpProcessException( + 'Unable to write temporary file', + ); + // @codeCoverageIgnoreEnd + } + + $job = new Job( + $job->input(), + $job->phpSettings(), + $job->environmentVariables(), + $job->arguments(), + null, + $job->redirectErrors(), + $job->requiresXdebug(), + ); + } + + assert($temporaryFile !== ''); + + return $this->runProcess($job, $temporaryFile); + } + + /** + * @param ?non-empty-string $temporaryFile + * + * @throws PhpProcessException + */ + private function runProcess(Job $job, ?string $temporaryFile): Result + { + $environmentVariables = null; + + if ($job->hasEnvironmentVariables()) { + /** @phpstan-ignore nullCoalesce.variable */ + $environmentVariables = $_SERVER ?? []; + + unset($environmentVariables['argv'], $environmentVariables['argc']); + + $environmentVariables = array_merge($environmentVariables, $job->environmentVariables()); + + foreach ($environmentVariables as $key => $value) { + if (is_array($value)) { + unset($environmentVariables[$key]); + } + } + + unset($key, $value); + } + + $pipeSpec = [ + 0 => ['pipe', 'r'], + 1 => ['pipe', 'w'], + 2 => ['pipe', 'w'], + ]; + + if ($job->redirectErrors()) { + $pipeSpec[2] = ['redirect', 1]; + } + + $process = proc_open( + $this->buildCommand($job, $temporaryFile), + $pipeSpec, + $pipes, + null, + $environmentVariables, + ); + + if (!is_resource($process)) { + // @codeCoverageIgnoreStart + throw new PhpProcessException( + 'Unable to spawn worker process', + ); + // @codeCoverageIgnoreEnd + } + + Facade::emitter()->childProcessStarted(); + + fwrite($pipes[0], $job->code()); + fclose($pipes[0]); + + $stdout = ''; + $stderr = ''; + + if (isset($pipes[1])) { + $stdout = stream_get_contents($pipes[1]); + + fclose($pipes[1]); + } + + if (isset($pipes[2])) { + $stderr = stream_get_contents($pipes[2]); + + fclose($pipes[2]); + } + + proc_close($process); + + if ($temporaryFile !== null) { + unlink($temporaryFile); + } + + assert($stdout !== false); + assert($stderr !== false); + + return new Result($stdout, $stderr); + } + + /** + * @return non-empty-list + */ + private function buildCommand(Job $job, ?string $file): array + { + $runtime = new Runtime; + $command = [PHP_BINARY]; + $phpSettings = $job->phpSettings(); + + $xdebugModeConfiguredExplicitly = false; + + foreach ($phpSettings as $phpSetting) { + if (str_starts_with($phpSetting, 'xdebug.mode')) { + $xdebugModeConfiguredExplicitly = true; + + break; + } + } + + if ($runtime->hasPCOV()) { + $pcovSettings = ini_get_all('pcov'); + + assert($pcovSettings !== false); + + $phpSettings = array_merge( + $phpSettings, + $runtime->getCurrentSettings( + array_keys($pcovSettings), + ), + ); + } elseif ($runtime->hasXdebug()) { + assert(function_exists('xdebug_is_debugger_active')); + + $xdebugSettings = ini_get_all('xdebug'); + + assert($xdebugSettings !== false); + + $phpSettings = array_merge( + $phpSettings, + $runtime->getCurrentSettings( + array_keys($xdebugSettings), + ), + ); + + if ( + !$xdebugModeConfiguredExplicitly && + !CodeCoverage::instance()->isActive() && + xdebug_is_debugger_active() === false && + !$job->requiresXdebug() + ) { + // disable xdebug to speedup test execution + $phpSettings['xdebug.mode'] = 'xdebug.mode=off'; + } + } + + $phpSettings = array_merge($phpSettings, $this->cliIniOverrides($phpSettings)); + + $command = array_merge($command, $this->settingsToParameters(array_values($phpSettings))); + + if (PHP_SAPI === 'phpdbg') { + $command[] = '-qrr'; + + if ($file === null) { + $command[] = 's='; + } + } + + if ($file !== null) { + $command[] = '-f'; + $command[] = $file; + } + + if ($job->hasArguments()) { + if ($file === null) { + $command[] = '--'; + } + + foreach ($job->arguments() as $argument) { + $command[] = trim($argument); + } + } + + return $command; + } + + /** + * Detects INI settings that cannot be set via ini_set() (PHP_INI_SYSTEM + * and PHP_INI_PERDIR) and whose current value differs from the value + * configured in INI files. + * + * These settings must be forwarded as -d flags to child processes + * because the @ini_set() calls in GlobalState::getIniSettingsAsString() + * cannot change them at runtime. + * + * @param array $alreadySet + * + * @return array + */ + private function cliIniOverrides(array $alreadySet): array + { + $overrides = (new Runtime)->getSettingsNotChangeableAtRuntime(); + + foreach ($overrides as $key => $value) { + foreach ($alreadySet as $existing) { + if (str_starts_with($existing, $key . '=')) { + unset($overrides[$key]); + + break; + } + } + } + + return $overrides; + } + + /** + * @param list $settings + * + * @throws PhpProcessException + * + * @return list + */ + private function settingsToParameters(array $settings): array + { + $buffer = []; + + foreach ($settings as $setting) { + $buffer[] = '-d'; + $buffer[] = $this->processSettingValue($setting); + } + + return $buffer; + } + + /** + * Rejects "name=value" INI settings whose value contains a line-break + * character. A newline cannot legitimately appear in a PHP INI value and + * would, if forwarded unchanged, be parsed by the child process as a + * directive separator — turning a single setting into an attacker- + * controlled sequence of directives. + * + * Otherwise quotes the value portion only when it contains characters + * PHP's INI parser would interpret as metacharacters (`;` starts a + * comment, `"` is a string delimiter, `=` is the assignment operator + * that would otherwise be parsed as starting a new directive and + * trigger `PHP: syntax error, unexpected '='`). + * + * Quoting is avoided for plain values so that boolean keywords such as + * `On` / `Off` keep their special INI semantics; wrapping them in quotes + * turns them into the literal strings `"On"` / `"Off"` and breaks + * settings like `output_buffering`. + * + * @throws PhpProcessException + */ + private function processSettingValue(string $setting): string + { + $parts = explode('=', $setting, 2); + + if (count($parts) !== 2) { + return $setting; + } + + [$name, $value] = $parts; + + if (str_contains($value, "\n") || str_contains($value, "\r")) { + throw new PhpProcessException( + sprintf( + 'PHP setting "%s" contains a line-break character, which is not permitted', + $name, + ), + ); + } + + if (!str_contains($value, ';') && !str_contains($value, '"') && !str_contains($value, '=')) { + return $setting; + } + + return $name . '="' . str_replace('"', '\\"', $value) . '"'; + } } diff --git a/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunnerRegistry.php b/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunnerRegistry.php index 94e22a4e4..7f05057c1 100644 --- a/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunnerRegistry.php +++ b/app/vendor/phpunit/phpunit/src/Util/PHP/JobRunnerRegistry.php @@ -30,11 +30,12 @@ public static function run(Job $job): Result } /** - * @param non-empty-string $processResultFile + * @param non-empty-string $processResultFile + * @param ?non-empty-string $processResultNonce */ - public static function runTestJob(Job $job, string $processResultFile, Test $test): void + public static function runTestJob(Job $job, string $processResultFile, Test $test, ?string $processResultNonce = null): void { - self::runner()->runTestJob($job, $processResultFile, $test); + self::runner()->runTestJob($job, $processResultFile, $test, $processResultNonce); } public static function set(JobRunner $runner): void @@ -45,7 +46,7 @@ public static function set(JobRunner $runner): void private static function runner(): JobRunner { if (self::$runner === null) { - self::$runner = new DefaultJobRunner( + self::$runner = new JobRunner( new ChildProcessResultProcessor( Facade::instance(), Facade::emitter(), diff --git a/app/vendor/phpunit/phpunit/src/Util/Sanitizer.php b/app/vendor/phpunit/phpunit/src/Util/Sanitizer.php new file mode 100644 index 000000000..3f0ee27b3 --- /dev/null +++ b/app/vendor/phpunit/phpunit/src/Util/Sanitizer.php @@ -0,0 +1,39 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace PHPUnit\Util; + +use function mb_ord; +use function preg_replace_callback; +use function sprintf; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit + * + * @internal This class is not covered by the backward compatibility promise for PHPUnit + */ +final readonly class Sanitizer +{ + /** + * Replaces Unicode bidirectional formatting characters with their visible \u{NNNN} escape sequence. + * + * Matches the UTF-8 byte sequences for U+202A-U+202E and U+2066-U+2069 directly so that + * the function is safe to call on strings that are not valid UTF-8. + * + * @see https://github.com/sebastianbergmann/phpunit/issues/6605 + */ + public static function sanitizeBidirectionalControlCharacters(string $value): string + { + return preg_replace_callback( + '/\xE2\x80[\xAA-\xAE]|\xE2\x81[\xA6-\xA9]/', + static fn (array $matches) => sprintf('\u{%04X}', mb_ord($matches[0], 'UTF-8')), + $value, + ); + } +} diff --git a/app/vendor/phpunit/phpunit/src/Util/Xml/Loader.php b/app/vendor/phpunit/phpunit/src/Util/Xml/Loader.php index 1289c253f..4424d0721 100644 --- a/app/vendor/phpunit/phpunit/src/Util/Xml/Loader.php +++ b/app/vendor/phpunit/phpunit/src/Util/Xml/Loader.php @@ -9,6 +9,7 @@ */ namespace PHPUnit\Util\Xml; +use const LIBXML_NONET; use function error_reporting; use function file_get_contents; use function libxml_get_errors; @@ -70,7 +71,7 @@ public function load(string $actual): DOMDocument $internal = libxml_use_internal_errors(true); $message = ''; $reporting = error_reporting(0); - $loaded = $document->loadXML($actual); + $loaded = $document->loadXML($actual, LIBXML_NONET); foreach (libxml_get_errors() as $error) { $message .= "\n" . $error->message; @@ -81,7 +82,9 @@ public function load(string $actual): DOMDocument if ($loaded === false) { if ($message === '') { + // @codeCoverageIgnoreStart $message = 'Could not load XML for unknown reason'; + // @codeCoverageIgnoreEnd } throw new XmlException($message); diff --git a/app/vendor/phpunit/phpunit/src/Util/Xml/Xml.php b/app/vendor/phpunit/phpunit/src/Util/Xml/Xml.php index 5e30bb43b..dce109813 100644 --- a/app/vendor/phpunit/phpunit/src/Util/Xml/Xml.php +++ b/app/vendor/phpunit/phpunit/src/Util/Xml/Xml.php @@ -10,6 +10,7 @@ namespace PHPUnit\Util; use const ENT_QUOTES; +use function assert; use function htmlspecialchars; use function mb_convert_encoding; use function ord; @@ -33,7 +34,7 @@ */ public static function prepareString(string $string): string { - return preg_replace( + $result = preg_replace( '/[\\x00-\\x08\\x0b\\x0c\\x0e-\\x1f\\x7f]/', '', htmlspecialchars( @@ -41,6 +42,10 @@ public static function prepareString(string $string): string ENT_QUOTES, ), ); + + assert($result !== null); + + return $result; } private static function convertToUtf8(string $string): string diff --git a/app/vendor/psr/event-dispatcher/.editorconfig b/app/vendor/psr/event-dispatcher/.editorconfig new file mode 100644 index 000000000..164f092d6 --- /dev/null +++ b/app/vendor/psr/event-dispatcher/.editorconfig @@ -0,0 +1,15 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at http://editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[Makefile] +indent_style = tab diff --git a/app/vendor/psr/event-dispatcher/.gitignore b/app/vendor/psr/event-dispatcher/.gitignore new file mode 100644 index 000000000..3a9875b46 --- /dev/null +++ b/app/vendor/psr/event-dispatcher/.gitignore @@ -0,0 +1,2 @@ +/vendor/ +composer.lock diff --git a/app/vendor/psr/event-dispatcher/LICENSE b/app/vendor/psr/event-dispatcher/LICENSE new file mode 100644 index 000000000..3f1559b2a --- /dev/null +++ b/app/vendor/psr/event-dispatcher/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2018 PHP-FIG + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/app/vendor/psr/event-dispatcher/README.md b/app/vendor/psr/event-dispatcher/README.md new file mode 100644 index 000000000..294214afb --- /dev/null +++ b/app/vendor/psr/event-dispatcher/README.md @@ -0,0 +1,6 @@ +PSR Event Dispatcher +==================== + +This repository holds the interfaces related to [PSR-14](http://www.php-fig.org/psr/psr-14/). + +Note that this is not an Event Dispatcher implementation of its own. It is merely interfaces that describe the components of an Event Dispatcher. See the specification for more details. diff --git a/app/vendor/psr/event-dispatcher/composer.json b/app/vendor/psr/event-dispatcher/composer.json new file mode 100644 index 000000000..667a71448 --- /dev/null +++ b/app/vendor/psr/event-dispatcher/composer.json @@ -0,0 +1,26 @@ +{ + "name": "psr/event-dispatcher", + "description": "Standard interfaces for event handling.", + "type": "library", + "keywords": ["psr", "psr-14", "events"], + "license": "MIT", + "authors": [ + { + "name": "PHP-FIG", + "homepage": "http://www.php-fig.org/" + } + ], + "require": { + "php": ">=7.2.0" + }, + "autoload": { + "psr-4": { + "Psr\\EventDispatcher\\": "src/" + } + }, + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + } +} diff --git a/app/vendor/psr/event-dispatcher/src/EventDispatcherInterface.php b/app/vendor/psr/event-dispatcher/src/EventDispatcherInterface.php new file mode 100644 index 000000000..4306fa915 --- /dev/null +++ b/app/vendor/psr/event-dispatcher/src/EventDispatcherInterface.php @@ -0,0 +1,21 @@ + Windows + * [📕 PHP manual](https://github.com/bobthecow/psysh/wiki/PHP-manual) + * [🤓 Windows](https://github.com/bobthecow/psysh/wiki/Windows) ### [🖥 Usage](https://github.com/bobthecow/psysh/wiki/Usage) * [✨ Magic variables](https://github.com/bobthecow/psysh/wiki/Magic-variables) diff --git a/app/vendor/psy/psysh/bin/psysh b/app/vendor/psy/psysh/bin/psysh index a20a3e115..34d99b071 100755 --- a/app/vendor/psy/psysh/bin/psysh +++ b/app/vendor/psy/psysh/bin/psysh @@ -4,7 +4,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -14,6 +14,9 @@ // We'll wrap this whole mess in a Closure so it doesn't leak any globals. call_user_func(function () { $cwd = null; + $cwdFromArg = false; + $forceTrust = false; + $forceUntrust = false; // Find the cwd arg (if present) $argv = isset($_SERVER['argv']) ? $_SERVER['argv'] : array(); @@ -24,22 +27,223 @@ call_user_func(function () { exit(1); } $cwd = $argv[$i + 1]; - break; + $cwdFromArg = true; + continue; } if (preg_match('/^--cwd=/', $arg)) { $cwd = substr($arg, 6); - break; + $cwdFromArg = true; + continue; + } + + if ($arg === '--trust-project') { + $forceTrust = true; + $forceUntrust = false; + } elseif ($arg === '--no-trust-project') { + $forceUntrust = true; + $forceTrust = false; + } + } + + if ($cwdFromArg) { + if (!@chdir($cwd)) { + fwrite(STDERR, 'Invalid --cwd directory: ' . $cwd . PHP_EOL); + exit(1); } } - // Or fall back to the actual cwd - if (!isset($cwd)) { + // Fall back to the actual cwd, or normalize the path after chdir + if (!isset($cwd) || $cwdFromArg) { $cwd = getcwd(); } $cwd = str_replace('\\', '/', $cwd); + if ($cwdFromArg) { + $filtered = array(); + $skipNext = false; + foreach ($argv as $arg) { + if ($skipNext) { + $skipNext = false; + continue; + } + if ($arg === '--cwd') { + $skipNext = true; + continue; + } + if (preg_match('/^--cwd=/', $arg)) { + continue; + } + $filtered[] = $arg; + } + $_SERVER['argv'] = $filtered; + $_SERVER['argc'] = count($filtered); + $argv = $filtered; + } + + if (isset($_SERVER['PSYSH_TRUST_PROJECT']) && $_SERVER['PSYSH_TRUST_PROJECT'] !== '') { + $mode = strtolower(trim($_SERVER['PSYSH_TRUST_PROJECT'])); + if (in_array($mode, array('true', '1'))) { + $forceTrust = true; + $forceUntrust = false; + } elseif (in_array($mode, array('false', '0'))) { + $forceUntrust = true; + $forceTrust = false; + } else { + fwrite(STDERR, 'Invalid PSYSH_TRUST_PROJECT value: ' . $_SERVER['PSYSH_TRUST_PROJECT'] . '. Expected: true, 1, false, or 0.' . PHP_EOL); + exit(1); + } + } + + // Pass trust decision via env var and strip CLI flags. This allows a local + // psysh version to read the trust state while avoiding errors on older + // versions that don't understand --trust-project flags. + if ($forceTrust) { + $_SERVER['PSYSH_TRUST_PROJECT'] = 'true'; + $_ENV['PSYSH_TRUST_PROJECT'] = 'true'; + putenv('PSYSH_TRUST_PROJECT=true'); + } elseif ($forceUntrust) { + $_SERVER['PSYSH_TRUST_PROJECT'] = 'false'; + $_ENV['PSYSH_TRUST_PROJECT'] = 'false'; + putenv('PSYSH_TRUST_PROJECT=false'); + } + + if ($forceTrust || $forceUntrust) { + $filtered = array(); + foreach ($argv as $arg) { + if ($arg === '--trust-project' || $arg === '--no-trust-project') { + continue; + } + $filtered[] = $arg; + } + $_SERVER['argv'] = $filtered; + $_SERVER['argc'] = count($filtered); + $argv = $filtered; + } + + $trustedRoots = array(); + if (!$forceTrust) { + // Find the current config directory (matching ConfigPaths logic) + $currentConfigDir = null; + $fallbackConfigDir = null; + + // Windows: %APPDATA%/PsySH takes priority + if ($currentConfigDir === null && defined('PHP_WINDOWS_VERSION_MAJOR')) { + if (isset($_SERVER['APPDATA']) && $_SERVER['APPDATA']) { + $dir = str_replace('\\', '/', $_SERVER['APPDATA']).'/PsySH'; + $fallbackConfigDir = $fallbackConfigDir !== null ? $fallbackConfigDir : $dir; + if (@is_dir($dir)) { + $currentConfigDir = $dir; + } + } + } + + // XDG_CONFIG_HOME/psysh + if ($currentConfigDir === null && isset($_SERVER['XDG_CONFIG_HOME']) && $_SERVER['XDG_CONFIG_HOME']) { + $dir = rtrim(str_replace('\\', '/', $_SERVER['XDG_CONFIG_HOME']), '/').'/psysh'; + $fallbackConfigDir = $fallbackConfigDir !== null ? $fallbackConfigDir : $dir; + if (@is_dir($dir)) { + $currentConfigDir = $dir; + } + } + + // HOME/.config/psysh (default XDG location) + if ($currentConfigDir === null && isset($_SERVER['HOME']) && $_SERVER['HOME']) { + $home = rtrim(str_replace('\\', '/', $_SERVER['HOME']), '/'); + + $dir = $home.'/.config/psysh'; + $fallbackConfigDir = $fallbackConfigDir !== null ? $fallbackConfigDir : $dir; + if (@is_dir($dir)) { + $currentConfigDir = $dir; + } + + // legacy + if ($currentConfigDir === null) { + $dir = $home.'/.psysh'; + if (@is_dir($dir)) { + $currentConfigDir = $dir; + } + } + } + + // Windows: HOMEDRIVE/HOMEPATH fallback + if ($currentConfigDir === null && defined('PHP_WINDOWS_VERSION_MAJOR')) { + if (isset($_SERVER['HOMEDRIVE']) && isset($_SERVER['HOMEPATH']) && $_SERVER['HOMEDRIVE'] && $_SERVER['HOMEPATH']) { + $dir = rtrim(str_replace('\\', '/', $_SERVER['HOMEDRIVE'].'/'.$_SERVER['HOMEPATH']), '/').'/.psysh'; + if (@is_dir($dir)) { + $currentConfigDir = $dir; + } + } + } + + // Fall back to the first candidate directory if none exist yet + if ($currentConfigDir === null) { + $currentConfigDir = $fallbackConfigDir; + } + + if ($currentConfigDir !== null) { + $trustFile = $currentConfigDir.'/trusted_projects.json'; + if (is_file($trustFile)) { + $contents = file_get_contents($trustFile); + if ($contents !== false && $contents !== '') { + $data = json_decode($contents, true); + if (is_array($data)) { + foreach ($data as $dir) { + if (!is_string($dir) || $dir === '') { + continue; + } + + $real = realpath($dir); + if ($real !== false) { + $dir = $real; + } + + $trustedRoots[] = str_replace('\\', '/', $dir); + } + } + } + } + } + } + + // Composer-generated bin proxies expose `_composer_autoload_path`, which points + // at the autoloader for the *current* project invoking `vendor/bin/psysh`. + // We use this to distinguish "already running via this project's local psysh" + // from "global psysh trying to hop into some other project's local psysh". + $proxyAutoloadPath = null; + if (isset($GLOBALS['_composer_autoload_path']) + && is_string($GLOBALS['_composer_autoload_path']) + && $GLOBALS['_composer_autoload_path'] !== '' + ) { + $proxyAutoloadPath = realpath($GLOBALS['_composer_autoload_path']); + if ($proxyAutoloadPath === false) { + $proxyAutoloadPath = str_replace('\\', '/', $GLOBALS['_composer_autoload_path']); + } else { + $proxyAutoloadPath = str_replace('\\', '/', $proxyAutoloadPath); + } + } + + $isCurrentProjectAutoload = function ($projectPath) use ($proxyAutoloadPath) { + if ($proxyAutoloadPath === null) { + return false; + } + + $projectAutoloadPath = realpath($projectPath.'/vendor/autoload.php'); + if ($projectAutoloadPath === false) { + return false; + } + + return str_replace('\\', '/', $projectAutoloadPath) === $proxyAutoloadPath; + }; + + $markUntrustedProject = function ($projectPath, $prettyPath) { + fwrite(STDERR, 'Skipping local PsySH at ' . $prettyPath . ' (project is untrusted). Re-run with --trust-project to allow.' . PHP_EOL); + $_SERVER['PSYSH_UNTRUSTED_PROJECT'] = $projectPath; + $_ENV['PSYSH_UNTRUSTED_PROJECT'] = $projectPath; + putenv('PSYSH_UNTRUSTED_PROJECT='.$projectPath); + }; + $chunks = explode('/', $cwd); while (!empty($chunks)) { $path = implode('/', $chunks); @@ -54,7 +258,18 @@ call_user_func(function () { if (isset($cfg['name']) && $cfg['name'] === 'psy/psysh') { // We're inside the psysh project. Let's use the local Composer autoload. if (is_file($path . '/vendor/autoload.php')) { - if (realpath($path) !== realpath(__DIR__ . '/..')) { + $realPath = realpath($path); + $realPath = $realPath ? str_replace('\\', '/', $realPath) : $path; + $pathReal = realpath($path); + $binReal = realpath(__DIR__ . '/..'); + $isCurrentPsysh = ($pathReal !== false && $pathReal === $binReal) || $isCurrentProjectAutoload($path); + + if (!$isCurrentPsysh && !$forceTrust && ($forceUntrust || !in_array($realPath, $trustedRoots, true))) { + $markUntrustedProject($realPath, $prettyPath); + return; + } + + if (!$isCurrentPsysh) { fwrite(STDERR, 'Using local PsySH version at ' . $prettyPath . PHP_EOL); } @@ -69,11 +284,23 @@ call_user_func(function () { // Or a composer.lock if (is_file($path . '/composer.lock')) { if ($cfg = json_decode(file_get_contents($path . '/composer.lock'), true)) { - foreach (array_merge($cfg['packages'], $cfg['packages-dev']) as $pkg) { + $packages = array_merge(isset($cfg['packages']) ? $cfg['packages'] : array(), isset($cfg['packages-dev']) ? $cfg['packages-dev'] : array()); + foreach ($packages as $pkg) { if (isset($pkg['name']) && $pkg['name'] === 'psy/psysh') { // We're inside a project which requires psysh. We'll use the local Composer autoload. if (is_file($path . '/vendor/autoload.php')) { - if (realpath($path . '/vendor') !== realpath(__DIR__ . '/../../..')) { + $realPath = realpath($path); + $realPath = $realPath ? str_replace('\\', '/', $realPath) : $path; + $vendorReal = realpath($path . '/vendor'); + $binVendorReal = realpath(__DIR__ . '/../../..'); + $isCurrentPsysh = ($vendorReal !== false && $vendorReal === $binVendorReal) || $isCurrentProjectAutoload($path); + + if (!$isCurrentPsysh && !$forceTrust && ($forceUntrust || !in_array($realPath, $trustedRoots, true))) { + $markUntrustedProject($realPath, $prettyPath); + return; + } + + if (!$isCurrentPsysh) { fwrite(STDERR, 'Using local PsySH version at ' . $prettyPath . PHP_EOL); } @@ -111,9 +338,9 @@ if (!class_exists('Psy\Shell')) { // // Keep this PHP 5.3 and 5.4 code around for a while in case someone is using a // globally installed psysh as a bin launcher for older local versions. -if (version_compare(PHP_VERSION, '5.3.6', '<')) { +if (PHP_VERSION_ID < 50306) { $trace = debug_backtrace(); -} elseif (version_compare(PHP_VERSION, '5.4.0', '<')) { +} elseif (PHP_VERSION_ID < 50400) { $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS); } else { $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2); diff --git a/app/vendor/psy/psysh/composer.json b/app/vendor/psy/psysh/composer.json index 7e3ca5e83..a0ba9bf1c 100644 --- a/app/vendor/psy/psysh/composer.json +++ b/app/vendor/psy/psysh/composer.json @@ -16,16 +16,17 @@ "ext-json": "*", "ext-tokenizer": "*", "nikic/php-parser": "^5.0 || ^4.0", - "symfony/console": "^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4", - "symfony/var-dumper": "^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4" + "symfony/console": "^8.0 || ^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4", + "symfony/var-dumper": "^8.0 || ^7.0 || ^6.0 || ^5.0 || ^4.0 || ^3.4" }, "require-dev": { - "bamarni/composer-bin-plugin": "^1.2" + "bamarni/composer-bin-plugin": "^1.2", + "composer/class-map-generator": "^1.6" }, "suggest": { "ext-pcntl": "Enabling the PCNTL extension makes PsySH a lot happier :)", "ext-posix": "If you have PCNTL, you'll want the POSIX extension as well.", - "ext-pdo-sqlite": "The doc command requires SQLite to work." + "composer/class-map-generator": "Improved tab completion performance with better class discovery." }, "autoload": { "files": ["src/functions.php"], diff --git a/app/vendor/psy/psysh/src/Clipboard/ClipboardMethod.php b/app/vendor/psy/psysh/src/Clipboard/ClipboardMethod.php new file mode 100644 index 000000000..b9843e3ee --- /dev/null +++ b/app/vendor/psy/psysh/src/Clipboard/ClipboardMethod.php @@ -0,0 +1,19 @@ +command = $command; + } + + public function copy(string $text, OutputInterface $output): bool + { + $process = \proc_open($this->command, [ + 0 => ['pipe', 'r'], + 1 => ['pipe', 'w'], + 2 => ['pipe', 'w'], + ], $pipes); + if ($process === false) { + return false; + } + + $success = $this->writeAll($pipes[0], $text); + \fclose($pipes[0]); + + // Drain stdout and stderr to prevent the child process from blocking. + \stream_get_contents($pipes[1]); + \fclose($pipes[1]); + \stream_get_contents($pipes[2]); + \fclose($pipes[2]); + + return $success && \proc_close($process) === 0; + } + + /** + * Write the full string to the pipe, returning false on failure. + * + * @param resource $pipe + */ + private function writeAll($pipe, string $text): bool + { + $remaining = $text; + + while ($remaining !== '') { + $written = \fwrite($pipe, $remaining); + if ($written === false || $written === 0) { + return false; + } + + $remaining = (string) \substr($remaining, $written); + } + + return true; + } +} diff --git a/app/vendor/psy/psysh/src/Clipboard/NullClipboardMethod.php b/app/vendor/psy/psysh/src/Clipboard/NullClipboardMethod.php new file mode 100644 index 000000000..2f85e08da --- /dev/null +++ b/app/vendor/psy/psysh/src/Clipboard/NullClipboardMethod.php @@ -0,0 +1,57 @@ +isSsh = $isSsh; + $this->reason = $reason; + } + + public function copy(string $text, OutputInterface $output): bool + { + if ($this->warned) { + return false; + } + $this->warned = true; + + if ($this->isSsh) { + $output->writeln('Clipboard copy is unavailable over SSH.'); + $output->writeln('Set useOsc52Clipboard: true to enable OSC 52.'); + $output->writeln('Only enable this on trusted systems.'); + + return false; + } + + if ($this->reason === self::REASON_NO_COMMAND_SUPPORT) { + $output->writeln('Clipboard commands are unavailable in this PHP environment.'); + $output->writeln('Configured clipboardCommand requires proc_open.'); + } elseif ($this->reason === self::REASON_NO_COMMAND) { + $output->writeln('No clipboard command was found.'); + $output->writeln('Set clipboardCommand to configure one.'); + } + + return false; + } +} diff --git a/app/vendor/psy/psysh/src/Clipboard/Osc52ClipboardMethod.php b/app/vendor/psy/psysh/src/Clipboard/Osc52ClipboardMethod.php new file mode 100644 index 000000000..859464683 --- /dev/null +++ b/app/vendor/psy/psysh/src/Clipboard/Osc52ClipboardMethod.php @@ -0,0 +1,31 @@ +write($osc52, false, OutputInterface::OUTPUT_RAW); + + return true; + } +} diff --git a/app/vendor/psy/psysh/src/CodeAnalysis/BufferAnalysis.php b/app/vendor/psy/psysh/src/CodeAnalysis/BufferAnalysis.php new file mode 100644 index 000000000..cd6e210fc --- /dev/null +++ b/app/vendor/psy/psysh/src/CodeAnalysis/BufferAnalysis.php @@ -0,0 +1,192 @@ + */ + private array $tokens; + + /** @var array */ + private array $tokenPositions; + + /** @var array|null */ + private ?array $ast; + private ?Error $lastError; + + /** + * @param array $tokens + * @param array $tokenPositions + * @param array|null $ast + */ + public function __construct(string $code, array $tokens, array $tokenPositions, ?array $ast, ?Error $lastError) + { + $this->code = $code; + $this->tokens = $tokens; + $this->tokenPositions = $tokenPositions; + $this->ast = $ast; + $this->lastError = $lastError; + } + + /** + * Get the token_get_all() tokens for the buffer. + * + * @return array + */ + public function getTokens(): array + { + return $this->tokens; + } + + /** + * Get start/end code-point positions for each token. + * + * @return array + */ + public function getTokenPositions(): array + { + return $this->tokenPositions; + } + + /** + * Get the parsed AST, or null if parsing failed. + * + * @return array|null + */ + public function getAst(): ?array + { + return $this->ast; + } + + /** + * Get the last parse error, if any. + */ + public function getLastError(): ?Error + { + return $this->lastError; + } + + /** + * Check whether the buffer has balanced (), [] and {} pairs. + */ + public function hasBalancedBrackets(): bool + { + $stack = []; + $pairs = ['(' => ')', '[' => ']', '{' => '}']; + + foreach ($this->tokens as $token) { + if (\is_array($token)) { + if (\in_array($token[0], [\T_CURLY_OPEN, \T_DOLLAR_OPEN_CURLY_BRACES], true)) { + $stack[] = '{'; + } + + continue; + } + + if (isset($pairs[$token])) { + $stack[] = $token; + } elseif (\in_array($token, $pairs, true)) { + if (empty($stack)) { + return false; + } + + $last = \array_pop($stack); + if ($pairs[$last] !== $token) { + return false; + } + } + } + + return empty($stack); + } + + /** + * Check whether the buffer ends with an operator that requires more input. + */ + public function hasTrailingOperator(): bool + { + return TokenHelper::hasTrailingOperator($this->tokens); + } + + /** + * Check whether the token stream ends inside a string or comment context. + */ + public function endsInOpenStringOrComment(): bool + { + if ($this->tokens === []) { + return false; + } + + $last = $this->tokens[\count($this->tokens) - 1]; + + return $last === '"' || $last === '`' || + (\is_array($last) && \in_array($last[0], [\T_ENCAPSED_AND_WHITESPACE, \T_START_HEREDOC, \T_COMMENT], true)); + } + + /** + * Check whether the buffer ends with a control structure header that still needs a body. + */ + public function hasControlStructureWithoutBody(): bool + { + $trimmed = \rtrim($this->code); + + if (\preg_match('/\b(if|while|for|foreach|elseif)\s*\(.*\)\s*$/', $trimmed)) { + $lastParen = \strrpos($trimmed, ')'); + if ($lastParen !== false) { + $afterParen = \trim(\substr($trimmed, $lastParen + 1)); + if ($afterParen === '') { + if ($this->lastError !== null && !$this->isEOFError($this->lastError)) { + return false; + } + + return true; + } + } + } + + $isElseAfterBrace = \preg_match('/\}\s*else\s*$/', $trimmed); + $isBareElse = \preg_match('/^\s*else\s*$/', $trimmed); + + if ($isElseAfterBrace || $isBareElse) { + if ($isBareElse && $this->lastError !== null && !$this->isEOFError($this->lastError)) { + return false; + } + + return true; + } + + return false; + } + + /** + * Check whether the last parse error is an unexpected-EOF error. + */ + public function hasEOFError(): bool + { + return $this->lastError !== null && $this->isEOFError($this->lastError); + } + + private function isEOFError(Error $error): bool + { + $msg = $error->getRawMessage(); + + return ($msg === 'Unexpected token EOF') || (\strpos($msg, 'Syntax error, unexpected EOF') !== false); + } +} diff --git a/app/vendor/psy/psysh/src/CodeAnalysis/BufferAnalyzer.php b/app/vendor/psy/psysh/src/CodeAnalysis/BufferAnalyzer.php new file mode 100644 index 000000000..a729fddd8 --- /dev/null +++ b/app/vendor/psy/psysh/src/CodeAnalysis/BufferAnalyzer.php @@ -0,0 +1,117 @@ + + */ + private array $cache = []; + + public function __construct(?Parser $parser = null) + { + $this->parser = $parser ?? (new ParserFactory())->createParser(); + } + + /** + * Analyze the given code, using cached data when possible. + */ + public function analyze(string $code): BufferAnalysis + { + foreach ($this->cache as $i => $entry) { + if ($entry['code'] === $code) { + if ($i > 0) { + \array_splice($this->cache, $i, 1); + \array_unshift($this->cache, $entry); + } + + return $entry['analysis']; + } + } + + $analysis = $this->buildAnalysis($code); + + \array_unshift($this->cache, ['code' => $code, 'analysis' => $analysis]); + if (\count($this->cache) > self::CACHE_SIZE) { + \array_pop($this->cache); + } + + return $analysis; + } + + /** + * Check whether appending a semicolon would make the code parseable. + */ + public function canBeFixedWithSemicolon(string $code): bool + { + try { + $this->parser->parse(' $token) { + $text = \is_array($token) ? $token[1] : $token; + $length = \mb_strlen($text); + $tokenPositions[$index] = ['start' => $position, 'end' => $position + $length]; + $position += $length; + } + + $ast = null; + $lastError = null; + try { + // Trailing newline improves heredoc EOF behavior to match runtime checks. + $ast = $this->parser->parse('createAnalysis($code, $tokens, $tokenPositions, $ast, $lastError); + } + + /** + * @param string $code + * @param array $tokens + * @param array $tokenPositions + * @param array|null $ast + */ + protected function createAnalysis(string $code, array $tokens, array $tokenPositions, ?array $ast, ?Error $lastError): BufferAnalysis + { + return new BufferAnalysis($code, $tokens, $tokenPositions, $ast, $lastError); + } +} diff --git a/app/vendor/psy/psysh/src/CodeCleaner.php b/app/vendor/psy/psysh/src/CodeCleaner.php index 9cde20fe0..de25fd098 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner.php +++ b/app/vendor/psy/psysh/src/CodeCleaner.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,7 +11,16 @@ namespace Psy; +use PhpParser\Error as PhpParserError; +use PhpParser\Node\Expr\ClassConstFetch; +use PhpParser\Node\Expr\FuncCall; +use PhpParser\Node\Name; +use PhpParser\Node\Name\FullyQualified; +use PhpParser\Node\Stmt\Expression; +use PhpParser\Node\Stmt\Namespace_; +use PhpParser\Node\Stmt\Use_; use PhpParser\NodeTraverser; +use PhpParser\NodeVisitor\NameResolver; use PhpParser\Parser; use PhpParser\PrettyPrinter\Standard as Printer; use Psy\CodeCleaner\AbstractClassPass; @@ -25,12 +34,14 @@ use Psy\CodeCleaner\FunctionContextPass; use Psy\CodeCleaner\FunctionReturnInWriteContextPass; use Psy\CodeCleaner\ImplicitReturnPass; +use Psy\CodeCleaner\ImplicitUsePass; use Psy\CodeCleaner\IssetPass; use Psy\CodeCleaner\LabelContextPass; use Psy\CodeCleaner\LeavePsyshAlonePass; use Psy\CodeCleaner\ListPass; use Psy\CodeCleaner\LoopContextPass; use Psy\CodeCleaner\MagicConstantsPass; +use Psy\CodeCleaner\NamespaceAwarePass; use Psy\CodeCleaner\NamespacePass; use Psy\CodeCleaner\PassableByReferencePass; use Psy\CodeCleaner\RequirePass; @@ -41,6 +52,7 @@ use Psy\CodeCleaner\ValidConstructorPass; use Psy\CodeCleaner\ValidFunctionNamePass; use Psy\Exception\ParseErrorException; +use Psy\Util\Str; /** * A service to clean up user input, detect parse errors before they happen, @@ -50,11 +62,15 @@ class CodeCleaner { private bool $yolo = false; private bool $strictTypes = false; + private $implicitUse = false; private Parser $parser; private Printer $printer; private NodeTraverser $traverser; private ?array $namespace = null; + private array $messages = []; + private array $aliasesByNamespace = []; + private array $aliasesByTypeByNamespace = []; /** * CodeCleaner constructor. @@ -64,18 +80,29 @@ class CodeCleaner * @param NodeTraverser|null $traverser A PhpParser NodeTraverser instance. One will be created if not explicitly supplied * @param bool $yolo run without input validation * @param bool $strictTypes enforce strict types by default + * @param false|array $implicitUse disable implicit use statements (false) or configure with namespace filters (array) */ - public function __construct(?Parser $parser = null, ?Printer $printer = null, ?NodeTraverser $traverser = null, bool $yolo = false, bool $strictTypes = false) + public function __construct(?Parser $parser = null, ?Printer $printer = null, ?NodeTraverser $traverser = null, bool $yolo = false, bool $strictTypes = false, $implicitUse = false) { $this->yolo = $yolo; $this->strictTypes = $strictTypes; + $this->implicitUse = \is_array($implicitUse) ? $implicitUse : false; $this->parser = $parser ?? (new ParserFactory())->createParser(); $this->printer = $printer ?: new Printer(); $this->traverser = $traverser ?: new NodeTraverser(); + // Try to add implicit `use` statements and an implicit namespace, based on the file in + // which the `debug` call was made. + $this->addImplicitDebugContext(); + foreach ($this->getDefaultPasses() as $pass) { $this->traverser->addVisitor($pass); + + // Set CodeCleaner instance on NamespaceAwarePass for state management + if ($pass instanceof NamespaceAwarePass) { + $pass->setCleaner($this); + } } } @@ -94,12 +121,11 @@ public function yolo(): bool */ private function getDefaultPasses(): array { - $useStatementPass = new UseStatementPass(); - $namespacePass = new NamespacePass($this); - - // Try to add implicit `use` statements and an implicit namespace, - // based on the file in which the `debug` call was made. - $this->addImplicitDebugContext([$useStatementPass, $namespacePass]); + // Add implicit use pass if enabled (must run before use statement pass) + $usePasses = [new UseStatementPass()]; + if ($this->implicitUse) { + \array_unshift($usePasses, new ImplicitUsePass($this->implicitUse, $this)); + } // A set of code cleaner passes that don't try to do any validation, and // only do minimal rewriting to make things work inside the REPL. @@ -107,11 +133,11 @@ private function getDefaultPasses(): array // When in --yolo mode, these are the only code cleaner passes used. $rewritePasses = [ new LeavePsyshAlonePass(), - $useStatementPass, // must run before the namespace pass new ExitPass(), new ImplicitReturnPass(), new MagicConstantsPass(), - $namespacePass, // must run after the implicit return pass + new NamespacePass(), // must run after the implicit return pass + ...$usePasses, // must run after the namespace pass has re-injected the current namespace new RequirePass(), new StrictTypesPass($this->strictTypes), ]; @@ -150,13 +176,10 @@ private function getDefaultPasses(): array /** * "Warm up" code cleaner passes when we're coming from a debug call. * - * This is useful, for example, for `UseStatementPass` and `NamespacePass` - * which keep track of state between calls, to maintain the current - * namespace and a map of use statements. - * - * @param array $passes + * This sets up the alias and namespace state that `UseStatementPass` and `NamespacePass` need + * to track between calls. */ - private function addImplicitDebugContext(array $passes) + private function addImplicitDebugContext() { $file = $this->getDebugFile(); if ($file === null) { @@ -174,12 +197,17 @@ private function addImplicitDebugContext(array $passes) return; } + $useStatementPass = new UseStatementPass(); + $useStatementPass->setCleaner($this); + + $namespacePass = new NamespacePass(); + $namespacePass->setCleaner($this); + // Set up a clean traverser for just these code cleaner passes // @todo Pass visitors directly to once we drop support for PHP-Parser 4.x $traverser = new NodeTraverser(); - foreach ($passes as $pass) { - $traverser->addVisitor($pass); - } + $traverser->addVisitor($useStatementPass); + $traverser->addVisitor($namespacePass); $traverser->traverse($stmts); } catch (\Throwable $e) { @@ -209,6 +237,8 @@ private static function getDebugFile() return $stackFrame['file']; } + + return null; } /** @@ -237,6 +267,9 @@ private static function isDebugCall(array $stackFrame): bool */ public function clean(array $codeLines, bool $requireSemicolons = false) { + // Clear messages from previous clean + $this->messages = []; + $stmts = $this->parse('namespace over to storing ?Name at some point! + * + * @param Name|array|null $namespace Namespace as Name node, array of parts, or null */ - public function setNamespace(?array $namespace = null) + public function setNamespace($namespace = null) { + if ($namespace instanceof Name) { + // Backwards compatibility shim for PHP-Parser 4.x + $namespace = \method_exists($namespace, 'getParts') ? $namespace->getParts() : $namespace->parts; + } + $this->namespace = $namespace; } @@ -275,6 +317,315 @@ public function getNamespace() return $this->namespace; } + /** + * Set use statement aliases for a specific namespace. + * + * @param Name|null $namespace Namespace name or Name node (null for global namespace) + * @param array $aliases Map of lowercase alias names to Name nodes + */ + public function setAliasesForNamespace(?Name $namespace, array $aliases) + { + $namespaceKey = \strtolower($namespace ? $namespace->toString() : ''); + $this->aliasesByNamespace[$namespaceKey] = $aliases; + $this->aliasesByTypeByNamespace[$namespaceKey][Use_::TYPE_NORMAL] = $aliases; + } + + /** + * Get use statement aliases for a specific namespace. + * + * (This currently accepts a string namespace name, because that's all we're storing in + * CodeCleaner as the current namespace; we should update that to be a Name node.) + * + * @param Name|string|null $namespace Namespace name or Name node (null for global namespace) + * + * @return array Map of lowercase alias names to Name nodes + */ + public function getAliasesForNamespace($namespace): array + { + $namespaceName = $namespace instanceof Name ? $namespace->toString() : $namespace; + $namespaceKey = \strtolower($namespaceName ?? ''); + + return $this->aliasesByTypeByNamespace[$namespaceKey][Use_::TYPE_NORMAL] ?? $this->aliasesByNamespace[$namespaceKey] ?? []; + } + + /** + * Set use statement aliases by import type for a specific namespace. + * + * @param Name|null $namespace Namespace name or Name node (null for global namespace) + * @param array $aliasesByType Map of Use_::TYPE_* constants to alias maps + */ + public function setAliasesByTypeForNamespace(?Name $namespace, array $aliasesByType): void + { + $namespaceKey = \strtolower($namespace ? $namespace->toString() : ''); + $this->aliasesByTypeByNamespace[$namespaceKey] = $aliasesByType; + $this->aliasesByNamespace[$namespaceKey] = $aliasesByType[Use_::TYPE_NORMAL] ?? []; + } + + /** + * Get use statement aliases by import type for a specific namespace. + * + * @param Name|string|null $namespace Namespace name or Name node (null for global namespace) + * + * @return array Map of Use_::TYPE_* constants to alias maps + */ + public function getAliasesByTypeForNamespace($namespace): array + { + $namespaceName = $namespace instanceof Name ? $namespace->toString() : $namespace; + $namespaceKey = \strtolower($namespaceName ?? ''); + + if (isset($this->aliasesByTypeByNamespace[$namespaceKey])) { + return $this->aliasesByTypeByNamespace[$namespaceKey]; + } + + if (!isset($this->aliasesByNamespace[$namespaceKey])) { + return []; + } + + return [Use_::TYPE_NORMAL => $this->aliasesByNamespace[$namespaceKey]]; + } + + /** + * Resolve a class name using current use statements and namespace. + * + * This is used by commands to resolve short names the same way code execution does. + * Uses PHP-Parser's NameResolver along with PsySH's custom passes. + * + * @param string $name Class name to resolve (e.g., "NoopChecker" or "Bar\Baz") + * + * @return string Resolved class name (may be FQN, or original name if no resolution found) + */ + public function resolveClassName(string $name): string + { + // Clear messages from previous resolution + $this->messages = []; + + // Only attempt resolution if it's a valid class name, and not already fully qualified + if (\substr($name, 0, 1) === '\\' || !Str::isValidClassName($name)) { + return $name; + } + + try { + // Parse as a class name constant + $stmts = $this->parser->parse('setCleaner($this); + + $useStatementPass = new UseStatementPass(); + $useStatementPass->setCleaner($this); + + // Create a fresh traverser with fresh passes + $traverser = new NodeTraverser(); + $traverser->addVisitor($namespacePass); + $traverser->addVisitor($useStatementPass); + + // Add PHP-Parser's NameResolver - preserveOriginalNames lets us detect when resolution occurred + $traverser->addVisitor(new NameResolver(null, [ + 'preserveOriginalNames' => true, + ])); + + // Traverse: NamespacePass wraps in namespace if needed, + // UseStatementPass re-injects use statements, + // PHP-Parser's NameResolver resolves to FullyQualified + $stmts = $traverser->traverse($stmts); + + // Find the Expression node - it might be after re-injected use statements + // or wrapped in a Namespace_ node + $targetStmt = null; + foreach ($stmts as $stmt) { + if ($stmt instanceof Namespace_) { + // Look inside the namespace for the Expression + foreach ($stmt->stmts ?? [] as $innerStmt) { + if ($innerStmt instanceof Expression) { + $targetStmt = $innerStmt; + break 2; + } + } + } elseif ($stmt instanceof Expression) { + $targetStmt = $stmt; + break; + } + } + + if ($targetStmt instanceof Expression) { + $expr = $targetStmt->expr; + if ($expr instanceof ClassConstFetch && $expr->class instanceof FullyQualified) { + $resolved = '\\'.$expr->class->toString(); + + // Check if actual resolution occurred by comparing original to resolved + // NameResolver preserves the original Name node in the 'originalName' attribute + $originalName = $expr->class->getAttribute('originalName'); + + if ($originalName instanceof Name) { + $originalStr = $originalName->toString(); + $resolvedStr = $expr->class->toString(); + + // If they differ, resolution occurred (use statement was applied) + if ($originalStr !== $resolvedStr) { + return $resolved; + } + } + + // No transformation occurred - return original name unchanged + return $name; + } + } + } catch (\Throwable $e) { + // Fall through to return original name + } + + return $name; + } + + /** + * Resolve a function name using current use statements and namespace. + * + * Returns the fully-qualified callable name, or null if the name would not + * resolve to a callable function in the current REPL scope. + */ + public function resolveFunctionName(string $name): ?string + { + if ($name === '') { + return null; + } + + if ($name[0] === '\\') { + $name = \substr($name, 1); + + return \function_exists($name) ? '\\'.$name : null; + } + + $parts = \explode('\\', $name); + $namespace = $this->getNamespace(); + $namespaceString = $namespace ? \implode('\\', $namespace) : null; + $functionAliases = $this->getAliasesByTypeForNamespace($namespaceString)[Use_::TYPE_FUNCTION] ?? []; + $firstPart = \strtolower($parts[0]); + + if (isset($functionAliases[$firstPart])) { + $aliasName = $functionAliases[$firstPart]; + // PHP-Parser 5.x uses getParts(), 4.x uses ->parts + $aliasParts = \method_exists($aliasName, 'getParts') ? $aliasName->getParts() : $aliasName->parts; + $resolved = \implode('\\', \array_merge($aliasParts, \array_slice($parts, 1))); + + return \function_exists($resolved) ? '\\'.$resolved : null; + } + + if ($namespace) { + $namespaced = \implode('\\', \array_merge($namespace, $parts)); + if (\function_exists($namespaced)) { + return '\\'.$namespaced; + } + } + + if (\count($parts) > 1) { + return null; + } + + return \function_exists($name) ? '\\'.$name : null; + } + + /** + * Resolve a direct function call from raw input in the current REPL scope. + * + * If $expectedName is provided, the input must be a direct call to that + * function name in order to be considered a collision. + */ + public function getCallableFunctionForInput(string $input, ?string $expectedName = null): ?string + { + try { + $stmts = $this->parse('getDirectFunctionCallFromStatements($stmts, $expectedName); + if ($call === null) { + return null; + } + + $function = $this->resolveFunctionName($call->name->toString()); + + if ($function !== null && $this->functionCallMatchesArity($function, $call)) { + return $function; + } + + return null; + } + + /** + * Return the first direct function call expression from a statement list. + * + * @param \PhpParser\Node[] $stmts + */ + private function getDirectFunctionCallFromStatements(array $stmts, ?string $expectedName = null): ?FuncCall + { + $stmt = $stmts[0] ?? null; + if (!$stmt instanceof Expression) { + return null; + } + + $expr = $stmt->expr; + if (!$expr instanceof FuncCall || !$expr->name instanceof Name) { + return null; + } + + if ($expectedName !== null && \strtolower($expr->name->toString()) !== \strtolower($expectedName)) { + return null; + } + + return $expr; + } + + /** + * Check whether a parsed function call could satisfy the target function's arity. + */ + private function functionCallMatchesArity(string $function, FuncCall $call): bool + { + try { + $reflection = new \ReflectionFunction(\ltrim($function, '\\')); + } catch (\ReflectionException $e) { + return false; + } + + // Unpacked args can satisfy any arity, so only validate fixed arg counts. + foreach ($call->args as $arg) { + if ($arg->unpack) { + return true; + } + } + + $argCount = \count($call->args); + $required = $reflection->getNumberOfRequiredParameters(); + $max = $reflection->isVariadic() ? \PHP_INT_MAX : $reflection->getNumberOfParameters(); + + return $argCount >= $required && $argCount <= $max; + } + + /** + * Log a message from a CodeCleaner pass. + * + * @param string $message Message text to display + */ + public function log(string $message): void + { + $this->messages[] = $message; + } + + /** + * Get all logged messages from the last clean operation. + * + * @return string[] Array of message strings + */ + public function getMessages(): array + { + return $this->messages; + } + /** * Lex and parse a block of code. * @@ -289,7 +640,7 @@ protected function parse(string $code, bool $requireSemicolons = false) { try { return $this->parser->parse($code); - } catch (\PhpParser\Error $e) { + } catch (PhpParserError $e) { if ($this->parseErrorIsUnclosedString($e, $code)) { return false; } @@ -313,13 +664,13 @@ protected function parse(string $code, bool $requireSemicolons = false) try { // Unexpected EOF, try again with an implicit semicolon return $this->parser->parse($code.';'); - } catch (\PhpParser\Error $e) { + } catch (PhpParserError $e) { return false; } } } - private function parseErrorIsEOF(\PhpParser\Error $e): bool + private function parseErrorIsEOF(PhpParserError $e): bool { $msg = $e->getRawMessage(); @@ -333,7 +684,7 @@ private function parseErrorIsEOF(\PhpParser\Error $e): bool * their own special beautiful snowflake syntax error just for * themselves. */ - private function parseErrorIsUnclosedString(\PhpParser\Error $e, string $code): bool + private function parseErrorIsUnclosedString(PhpParserError $e, string $code): bool { if ($e->getRawMessage() !== 'Syntax error, unexpected T_ENCAPSED_AND_WHITESPACE') { return false; @@ -348,12 +699,12 @@ private function parseErrorIsUnclosedString(\PhpParser\Error $e, string $code): return true; } - private function parseErrorIsUnterminatedComment(\PhpParser\Error $e, string $code): bool + private function parseErrorIsUnterminatedComment(PhpParserError $e, string $code): bool { return $e->getRawMessage() === 'Unterminated comment'; } - private function parseErrorIsTrailingComma(\PhpParser\Error $e, string $code): bool + private function parseErrorIsTrailingComma(PhpParserError $e, string $code): bool { return ($e->getRawMessage() === 'A trailing comma is not allowed here') && (\substr(\rtrim($code), -1) === ','); } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/AbstractClassPass.php b/app/vendor/psy/psysh/src/CodeCleaner/AbstractClassPass.php index eed1e8df3..5c4c9f640 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/AbstractClassPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/AbstractClassPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -47,6 +47,8 @@ public function enterNode(Node $node) } } } + + return null; } /** @@ -71,5 +73,7 @@ public function leaveNode(Node $node) throw new FatalErrorException($msg, 0, \E_ERROR, null, $node->getStartLine()); } } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/AssignThisVariablePass.php b/app/vendor/psy/psysh/src/CodeCleaner/AssignThisVariablePass.php index cdcb84ad5..1076d93b5 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/AssignThisVariablePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/AssignThisVariablePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -37,5 +37,7 @@ public function enterNode(Node $node) if ($node instanceof Assign && $node->var instanceof Variable && $node->var->name === 'this') { throw new FatalErrorException('Cannot re-assign $this', 0, \E_ERROR, null, $node->getStartLine()); } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/CallTimePassByReferencePass.php b/app/vendor/psy/psysh/src/CodeCleaner/CallTimePassByReferencePass.php index c3eaed141..3e967cf9e 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/CallTimePassByReferencePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/CallTimePassByReferencePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -41,7 +41,7 @@ class CallTimePassByReferencePass extends CodeCleanerPass public function enterNode(Node $node) { if (!$node instanceof FuncCall && !$node instanceof MethodCall && !$node instanceof StaticCall) { - return; + return null; } foreach ($node->args as $arg) { @@ -53,5 +53,7 @@ public function enterNode(Node $node) throw new FatalErrorException(self::EXCEPTION_MESSAGE, 0, \E_ERROR, null, $node->getStartLine()); } } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/CalledClassPass.php b/app/vendor/psy/psysh/src/CodeCleaner/CalledClassPass.php index 0ec0c0106..c0293684e 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/CalledClassPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/CalledClassPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -36,6 +36,8 @@ class CalledClassPass extends CodeCleanerPass public function beforeTraverse(array $nodes) { $this->inClass = false; + + return null; } /** @@ -55,12 +57,12 @@ public function enterNode(Node $node) // // @todo switch this to actually validate args when we get context-aware code cleaner passes. if (!empty($node->args) && !$this->isNull($node->args[0])) { - return; + return null; } // We'll ignore name expressions as well (things like `$foo()`) if (!($node->name instanceof Name)) { - return; + return null; } $name = \strtolower($node->name); @@ -69,6 +71,8 @@ public function enterNode(Node $node) throw new ErrorException($msg, 0, \E_USER_WARNING, null, $node->getStartLine()); } } + + return null; } /** @@ -81,6 +85,8 @@ public function leaveNode(Node $node) if ($node instanceof Class_) { $this->inClass = false; } + + return null; } private function isNull(Node $node): bool @@ -89,6 +95,10 @@ private function isNull(Node $node): bool return false; } + if (!\property_exists($node, 'value')) { + return false; + } + return $node->value instanceof ConstFetch && \strtolower($node->value->name) === 'null'; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/CodeCleanerPass.php b/app/vendor/psy/psysh/src/CodeCleaner/CodeCleanerPass.php index 244c9d4e8..af3182c34 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/CodeCleanerPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/CodeCleanerPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/CodeCleaner/EmptyArrayDimFetchPass.php b/app/vendor/psy/psysh/src/CodeCleaner/EmptyArrayDimFetchPass.php index 0429589b8..29a8e5032 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/EmptyArrayDimFetchPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/EmptyArrayDimFetchPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -33,6 +33,8 @@ class EmptyArrayDimFetchPass extends CodeCleanerPass public function beforeTraverse(array $nodes) { $this->theseOnesAreFine = []; + + return null; } /** @@ -62,5 +64,7 @@ public function enterNode(Node $node) throw new FatalErrorException(self::EXCEPTION_MESSAGE, $node->getStartLine()); } } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ExitPass.php b/app/vendor/psy/psysh/src/CodeCleaner/ExitPass.php index e58a8d68a..cd5b48be5 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/ExitPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/ExitPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -12,6 +12,7 @@ namespace Psy\CodeCleaner; use PhpParser\Node; +use PhpParser\Node\Arg; use PhpParser\Node\Expr\Exit_; use PhpParser\Node\Expr\StaticCall; use PhpParser\Node\Name\FullyQualified as FullyQualifiedName; @@ -29,7 +30,11 @@ class ExitPass extends CodeCleanerPass public function leaveNode(Node $node) { if ($node instanceof Exit_) { - return new StaticCall(new FullyQualifiedName(BreakException::class), 'exitShell'); + $args = $node->expr ? [new Arg($node->expr)] : []; + + return new StaticCall(new FullyQualifiedName(BreakException::class), 'exitShell', $args); } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/FinalClassPass.php b/app/vendor/psy/psysh/src/CodeCleaner/FinalClassPass.php index cef5e91ad..03129ecc2 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/FinalClassPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/FinalClassPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -30,6 +30,8 @@ class FinalClassPass extends CodeCleanerPass public function beforeTraverse(array $nodes) { $this->finalClasses = []; + + return null; } /** @@ -54,6 +56,8 @@ public function enterNode(Node $node) $this->finalClasses[\strtolower($node->name)] = true; } } + + return null; } /** diff --git a/app/vendor/psy/psysh/src/CodeCleaner/FunctionContextPass.php b/app/vendor/psy/psysh/src/CodeCleaner/FunctionContextPass.php index d57889111..d550dd60e 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/FunctionContextPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/FunctionContextPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -28,6 +28,8 @@ class FunctionContextPass extends CodeCleanerPass public function beforeTraverse(array $nodes) { $this->functionDepth = 0; + + return null; } /** @@ -38,12 +40,12 @@ public function enterNode(Node $node) if ($node instanceof FunctionLike) { $this->functionDepth++; - return; + return null; } // node is inside function context if ($this->functionDepth !== 0) { - return; + return null; } // It causes fatal error. @@ -51,6 +53,8 @@ public function enterNode(Node $node) $msg = 'The "yield" expression can only be used inside a function'; throw new FatalErrorException($msg, 0, \E_ERROR, null, $node->getStartLine()); } + + return null; } /** @@ -63,5 +67,7 @@ public function leaveNode(Node $node) if ($node instanceof FunctionLike) { $this->functionDepth--; } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/FunctionReturnInWriteContextPass.php b/app/vendor/psy/psysh/src/CodeCleaner/FunctionReturnInWriteContextPass.php index 2c50d5fc4..a65d3c75a 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/FunctionReturnInWriteContextPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/FunctionReturnInWriteContextPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -68,6 +68,8 @@ public function enterNode(Node $node) } elseif ($node instanceof Assign && $this->isCallNode($node->var)) { throw new FatalErrorException(self::EXCEPTION_MESSAGE, 0, \E_ERROR, null, $node->getStartLine()); } + + return null; } private function isCallNode(Node $node): bool diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ImplicitReturnPass.php b/app/vendor/psy/psysh/src/CodeCleaner/ImplicitReturnPass.php index 2e4ebf3d0..d1a20bb5b 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/ImplicitReturnPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/ImplicitReturnPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -14,6 +14,7 @@ use PhpParser\Node; use PhpParser\Node\Expr; use PhpParser\Node\Expr\Exit_; +use PhpParser\Node\Expr\Throw_; use PhpParser\Node\Stmt; use PhpParser\Node\Stmt\Break_; use PhpParser\Node\Stmt\Expression; @@ -74,14 +75,14 @@ private function addImplicitReturn(array $nodes): array $case->stmts[] = $caseLast; } } - } elseif ($last instanceof Expr && !($last instanceof Exit_)) { + } elseif ($last instanceof Expr && !($last instanceof Exit_) && !self::isThrowNode($last)) { // @codeCoverageIgnoreStart $nodes[\count($nodes) - 1] = new Return_($last, [ 'startLine' => $last->getStartLine(), 'endLine' => $last->getEndLine(), ]); // @codeCoverageIgnoreEnd - } elseif ($last instanceof Expression && !($last->expr instanceof Exit_)) { + } elseif ($last instanceof Expression && !($last->expr instanceof Exit_) && !self::isThrowNode($last->expr)) { $nodes[\count($nodes) - 1] = new Return_($last->expr, [ 'startLine' => $last->getStartLine(), 'endLine' => $last->getEndLine(), @@ -100,7 +101,7 @@ private function addImplicitReturn(array $nodes): array // We're not adding a fallback return after namespace statements, // because code outside namespace statements doesn't really work, and // there's already an implicit return in the namespace statement anyway. - if (self::isNonExpressionStmt($last)) { + if (self::isNonExpressionStmt($last) && !self::isThrowNode($last)) { $nodes[] = new Return_(NoReturnValue::create()); } @@ -122,4 +123,13 @@ private static function isNonExpressionStmt(Node $node): bool !$node instanceof Return_ && !$node instanceof Namespace_; } + + /** + * PHP-Parser 4.x modeled standalone `throw` as Stmt\Throw_, while newer + * versions expose it as Expr\Throw_ inside Stmt\Expression. + */ + private static function isThrowNode(Node $node): bool + { + return $node instanceof Throw_ || $node->getType() === 'Stmt_Throw'; + } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ImplicitUsePass.php b/app/vendor/psy/psysh/src/CodeCleaner/ImplicitUsePass.php new file mode 100644 index 000000000..1a85bd30c --- /dev/null +++ b/app/vendor/psy/psysh/src/CodeCleaner/ImplicitUsePass.php @@ -0,0 +1,394 @@ + ['App\Model'], `new User` would become `use App\Model\User; new User;` + * even though there's also an `App\View\User` class. + * + * Works great with autoload warming (--warm-autoload) to pre-load classes. + */ +class ImplicitUsePass extends CodeCleanerPass +{ + private ?array $shortNameMap = null; + private array $implicitUses = []; + private array $seenNames = []; + private array $existingAliases = []; + private array $includeNamespaces = []; + private array $excludeNamespaces = []; + private ?string $currentNamespace = null; + private ?CodeCleaner $cleaner = null; + private ?PrettyPrinter $printer = null; + + /** + * @param array $config Configuration array with 'includeNamespaces' and/or 'excludeNamespaces' + * @param CodeCleaner|null $cleaner CodeCleaner instance for logging + */ + public function __construct(array $config = [], ?CodeCleaner $cleaner = null) + { + $this->includeNamespaces = $this->normalizeNamespaces($config['includeNamespaces'] ?? []); + $this->excludeNamespaces = $this->normalizeNamespaces($config['excludeNamespaces'] ?? []); + $this->cleaner = $cleaner; + } + + /** + * {@inheritdoc} + */ + public function beforeTraverse(array $nodes) + { + if (empty($this->includeNamespaces) && empty($this->excludeNamespaces)) { + return null; + } + + $this->buildShortNameMap(); + + // Reset state for this traversal + $this->implicitUses = []; + $this->seenNames = []; + $this->existingAliases = []; + $this->currentNamespace = null; + + $modified = false; + + // Collect use statements and seen names for each namespace + foreach ($nodes as $node) { + if ($node instanceof Namespace_) { + $this->currentNamespace = $node->name ? $node->name->toString() : null; + + $perNamespaceAliases = []; + $perNamespaceUses = []; + $perNamespaceSeen = []; + + if ($node->stmts !== null) { + $this->collectAliasesInNodes($node->stmts, $perNamespaceAliases); + $this->collectNamesInNodes($node->stmts, $perNamespaceSeen, $perNamespaceAliases, $perNamespaceUses); + } + + if (!empty($perNamespaceUses)) { + $this->logAddedUses($perNamespaceUses); + $node->stmts = \array_merge($this->createUseStatements($perNamespaceUses), $node->stmts ?? []); + $modified = true; + } + } + } + + $hasNamespace = false; + foreach ($nodes as $node) { + if ($node instanceof Namespace_) { + $hasNamespace = true; + break; + } + } + + // Collect use statements and seen names for top-level namespace + if (!$hasNamespace) { + $this->currentNamespace = null; + $topLevelAliases = []; + $topLevelUses = []; + $topLevelSeen = []; + + $this->collectAliasesInNodes($nodes, $topLevelAliases); + $this->collectNamesInNodes($nodes, $topLevelSeen, $topLevelAliases, $topLevelUses); + + if (!empty($topLevelUses)) { + $this->logAddedUses($topLevelUses); + + return \array_merge($this->createUseStatements($topLevelUses), $nodes); + } + } + + return $modified ? $nodes : null; + } + + /** + * Collect aliases in a set of nodes. + * + * @param array $nodes Array of Node objects + * @param array $aliases Associative array mapping lowercase alias names to true + */ + private function collectAliasesInNodes(array $nodes, array &$aliases): void + { + foreach ($nodes as $node) { + if ($node instanceof Use_ || $node instanceof GroupUse) { + foreach ($node->uses as $useItem) { + $alias = $useItem->getAlias(); + if ($alias !== null) { + $aliasStr = $alias instanceof Name ? $alias->toString() : (string) $alias; + $aliases[\strtolower($aliasStr)] = true; + } else { + $aliases[\strtolower($this->getShortName($useItem->name))] = true; + } + } + } + } + } + + /** + * Collect unqualified names in nodes. + * + * @param array $nodes Array of Node objects to traverse + * @param array $seen Lowercase short names already processed + * @param array $aliases Lowercase alias names that exist in this namespace + * @param array $uses Map of short names to FQNs for implicit use statements + */ + private function collectNamesInNodes(array $nodes, array &$seen, array $aliases, array &$uses): void + { + foreach ($nodes as $node) { + if (!$node instanceof Node || $node instanceof Use_) { + continue; + } + + if ($node instanceof Name && !$node instanceof FullyQualifiedName) { + if (!$this->isQualified($node)) { + $shortName = $this->getShortName($node); + $shortNameLower = \strtolower($shortName); + + if (isset($seen[$shortNameLower])) { + continue; + } + + $seen[$shortNameLower] = true; + + if ($this->shouldAddImplicitUseInContext($shortName, $shortNameLower, $aliases)) { + // @phan-suppress-next-line PhanTypeArraySuspiciousNullable - shortNameMap is initialized in beforeTraverse + $uses[$shortName] = $this->shortNameMap[$shortNameLower]; + } + } + } + + foreach ($node->getSubNodeNames() as $subNodeName) { + $subNode = $node->$subNodeName; + if ($subNode instanceof Node) { + $subNode = [$subNode]; + } + + if (\is_array($subNode)) { + $this->collectNamesInNodes($subNode, $seen, $aliases, $uses); + } + } + } + } + + /** + * Create Use_ statement nodes from uses array. + * + * @param array $uses Associative array mapping short names to FQNs + * + * @return Use_[] + */ + private function createUseStatements(array $uses): array + { + \asort($uses); + + $useStatements = []; + foreach ($uses as $fqn) { + $useItem = \class_exists(UseItem::class) ? new UseItem(new Name($fqn)) : new UseUse(new Name($fqn)); + $useStatements[] = new Use_([$useItem]); + } + + return $useStatements; + } + + /** + * Check if we should add an implicit use statement for this name in current context. + * + * @param string $shortName Original case short name + * @param string $shortNameLower Lowercase short name for comparison + * @param array $aliases Lowercase alias names that exist in this namespace + */ + private function shouldAddImplicitUseInContext(string $shortName, string $shortNameLower, array $aliases): bool + { + // Rule 1: No existing unqualified name (class/interface/trait) with that short name + if (\class_exists($shortName, false) || \interface_exists($shortName, false) || \trait_exists($shortName, false)) { + return false; + } + + // Rule 2: No existing use statement or alias with that short name + if (isset($aliases[$shortNameLower])) { + return false; + } + + // Rule 3: Exactly one matching short class/interface/trait in configured namespaces + if (!isset($this->shortNameMap[$shortNameLower]) || $this->shortNameMap[$shortNameLower] === null) { + return false; + } + + // Rule 4: Don't add use statement if the class exists in the current namespace + if ($this->currentNamespace !== null) { + $expectedFqn = \trim($this->currentNamespace, '\\').'\\'.$shortName; + + if (\class_exists($expectedFqn, false) || \interface_exists($expectedFqn, false) || \trait_exists($expectedFqn, false)) { + return false; + } + } + + return true; + } + + /** + * Build a map of short class names to fully-qualified names. + * + * Uses get_declared_classes(), get_declared_interfaces(), and get_declared_traits() + * to find all currently loaded classes. Only includes classes matching the configured + * namespace filters. Detects ambiguous short names (multiple FQNs with same short name + * within the filtered namespaces) and marks them as null. + */ + private function buildShortNameMap(): void + { + $this->shortNameMap = []; + + $allClasses = [ + ...\get_declared_classes(), + ...\get_declared_interfaces(), + ...\get_declared_traits(), + ]; + + // First pass: collect all matching classes + $candidatesByShortName = []; + foreach ($allClasses as $fqn) { + if (!$this->shouldIncludeClass($fqn)) { + continue; + } + + $parts = \explode('\\', $fqn); + $shortName = \strtolower(\end($parts)); + + if (!isset($candidatesByShortName[$shortName])) { + $candidatesByShortName[$shortName] = []; + } + $candidatesByShortName[$shortName][] = $fqn; + } + + // Second pass: determine if each short name is unique or ambiguous + foreach ($candidatesByShortName as $shortName => $fqns) { + $uniqueFqns = \array_unique($fqns); + // Mark as null if ambiguous (multiple FQNs with same short name) + $this->shortNameMap[$shortName] = (\count($uniqueFqns) === 1) ? $uniqueFqns[0] : null; + } + } + + /** + * Check if a class should be aliased based on namespace filters. + * + * @param string $fqn Fully-qualified class name + */ + private function shouldIncludeClass(string $fqn): bool + { + if (\strpos($fqn, '\\') === false) { + return false; + } + + if (empty($this->includeNamespaces) && empty($this->excludeNamespaces)) { + return false; + } + + foreach ($this->excludeNamespaces as $namespace) { + if (\stripos($fqn, $namespace) === 0) { + return false; + } + } + + if (empty($this->includeNamespaces)) { + return true; + } + + foreach ($this->includeNamespaces as $namespace) { + if (\stripos($fqn, $namespace) === 0) { + return true; + } + } + + return false; + } + + /** + * Normalize namespace prefixes. + * + * Removes leading backslash and ensures trailing backslash. + * + * @param string[] $namespaces + * + * @return string[] + */ + private function normalizeNamespaces(array $namespaces): array + { + return \array_map(fn ($namespace) => \trim($namespace, '\\').'\\', $namespaces); + } + + /** + * Get short name from a Name node. + */ + private function getShortName(Name $name): string + { + $parts = $this->getParts($name); + + return \end($parts); + } + + /** + * Check if a name is qualified (contains namespace separator). + */ + private function isQualified(Name $name): bool + { + return \count($this->getParts($name)) > 1; + } + + /** + * Backwards compatibility shim for PHP-Parser 4.x. + * + * @return string[] + */ + private function getParts(Name $name): array + { + return \method_exists($name, 'getParts') ? $name->getParts() : $name->parts; + } + + /** + * Log added use statements to the CodeCleaner. + * + * @param array $uses Associative array mapping short names to FQNs + */ + private function logAddedUses(array $uses): void + { + if ($this->cleaner === null || empty($uses)) { + return; + } + + if ($this->printer === null) { + $this->printer = new PrettyPrinter(); + } + + $useStmts = $this->createUseStatements($uses); + $this->cleaner->log($this->printer->prettyPrint($useStmts)); + } +} diff --git a/app/vendor/psy/psysh/src/CodeCleaner/IssetPass.php b/app/vendor/psy/psysh/src/CodeCleaner/IssetPass.php index fa8f60cfe..cf95452d9 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/IssetPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/IssetPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -37,7 +37,7 @@ class IssetPass extends CodeCleanerPass public function enterNode(Node $node) { if (!$node instanceof Isset_) { - return; + return null; } foreach ($node->vars as $var) { @@ -45,5 +45,7 @@ public function enterNode(Node $node) throw new FatalErrorException(self::EXCEPTION_MSG, 0, \E_ERROR, null, $node->getStartLine()); } } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/LabelContextPass.php b/app/vendor/psy/psysh/src/CodeCleaner/LabelContextPass.php index fa130b15c..d913a56d9 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/LabelContextPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/LabelContextPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -45,6 +45,8 @@ public function beforeTraverse(array $nodes) $this->functionDepth = 0; $this->labelDeclarations = []; $this->labelGotos = []; + + return null; } /** @@ -55,12 +57,12 @@ public function enterNode(Node $node) if ($node instanceof FunctionLike) { $this->functionDepth++; - return; + return null; } // node is inside function context if ($this->functionDepth !== 0) { - return; + return null; } if ($node instanceof Goto_) { @@ -68,6 +70,8 @@ public function enterNode(Node $node) } elseif ($node instanceof Label) { $this->labelDeclarations[\strtolower($node->name)] = $node->getStartLine(); } + + return null; } /** @@ -80,6 +84,8 @@ public function leaveNode(Node $node) if ($node instanceof FunctionLike) { $this->functionDepth--; } + + return null; } /** @@ -93,5 +99,7 @@ public function afterTraverse(array $nodes) throw new FatalErrorException($msg, 0, \E_ERROR, null, $line); } } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/LeavePsyshAlonePass.php b/app/vendor/psy/psysh/src/CodeCleaner/LeavePsyshAlonePass.php index 67ba68b16..85ade7805 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/LeavePsyshAlonePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/LeavePsyshAlonePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -34,5 +34,7 @@ public function enterNode(Node $node) if ($node instanceof Variable && $node->name === '__psysh__') { throw new RuntimeException('Don\'t mess with $__psysh__; bad things will happen'); } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ListPass.php b/app/vendor/psy/psysh/src/CodeCleaner/ListPass.php index 696508559..12289de44 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/ListPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/ListPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -42,15 +42,15 @@ class ListPass extends CodeCleanerPass public function enterNode(Node $node) { if (!$node instanceof Assign) { - return; + return null; } if (!$node->var instanceof Array_ && !$node->var instanceof List_) { - return; + return null; } // Polyfill for PHP-Parser 2.x - $items = isset($node->var->items) ? $node->var->items : $node->var->vars; + $items = isset($node->var->items) ? $node->var->items : (\property_exists($node->var, 'vars') ? $node->var->vars : []); if ($items === [] || $items === [null]) { throw new ParseErrorException('Cannot use empty list', ['startLine' => $node->var->getStartLine(), 'endLine' => $node->var->getEndLine()]); @@ -73,6 +73,8 @@ public function enterNode(Node $node) if (!$itemFound) { throw new ParseErrorException('Cannot use empty list'); } + + return null; } /** diff --git a/app/vendor/psy/psysh/src/CodeCleaner/LoopContextPass.php b/app/vendor/psy/psysh/src/CodeCleaner/LoopContextPass.php index 29a0ecf19..da5aacefb 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/LoopContextPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/LoopContextPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -40,6 +40,8 @@ class LoopContextPass extends CodeCleanerPass public function beforeTraverse(array $nodes) { $this->loopDepth = 0; + + return null; } /** @@ -95,6 +97,8 @@ public function enterNode(Node $node) } break; } + + return null; } /** @@ -113,5 +117,7 @@ public function leaveNode(Node $node) $this->loopDepth--; break; } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/MagicConstantsPass.php b/app/vendor/psy/psysh/src/CodeCleaner/MagicConstantsPass.php index 3c468af09..dc61931d3 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/MagicConstantsPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/MagicConstantsPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -38,5 +38,7 @@ public function enterNode(Node $node) } elseif ($node instanceof File) { return new String_('', $node->getAttributes()); } + + return null; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/NamespaceAwarePass.php b/app/vendor/psy/psysh/src/CodeCleaner/NamespaceAwarePass.php index 41d1f1df9..9c8a3c19b 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/NamespaceAwarePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/NamespaceAwarePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -14,15 +14,31 @@ use PhpParser\Node; use PhpParser\Node\Name; use PhpParser\Node\Name\FullyQualified as FullyQualifiedName; +use PhpParser\Node\Stmt\GroupUse; use PhpParser\Node\Stmt\Namespace_; +use PhpParser\Node\Stmt\Use_; +use Psy\CodeCleaner; /** * Abstract namespace-aware code cleaner pass. + * + * Tracks both namespace and use statement aliases for proper name resolution. */ abstract class NamespaceAwarePass extends CodeCleanerPass { protected array $namespace = []; protected array $currentScope = []; + protected array $aliases = []; + protected array $aliasesByType = []; + protected ?CodeCleaner $cleaner = null; + + /** + * Set the CodeCleaner instance for state management. + */ + public function setCleaner(CodeCleaner $cleaner) + { + $this->cleaner = $cleaner; + } /** * @todo should this be final? Extending classes should be sure to either @@ -36,6 +52,9 @@ public function beforeTraverse(array $nodes) { $this->namespace = []; $this->currentScope = []; + $this->aliasesByType = []; + + return null; } /** @@ -50,20 +69,94 @@ public function enterNode(Node $node) { if ($node instanceof Namespace_) { $this->namespace = isset($node->name) ? $this->getParts($node->name) : []; + + // Only restore use statement aliases for PsySH re-injected namespaces. + // Explicit namespace declarations start with a clean slate. + if ($this->cleaner && $node->getAttribute('psyshReinjected')) { + $this->aliasesByType = $this->cleaner->getAliasesByTypeForNamespace($node->name); + $this->aliases = $this->aliasesByType[Use_::TYPE_NORMAL] ?? []; + } else { + $this->aliases = []; + $this->aliasesByType = []; + } + } + + // Track use statements for alias resolution + if ($node instanceof Use_) { + foreach ($node->uses as $useItem) { + $this->setAliasForType(\strtolower($useItem->getAlias()), $useItem->name, $this->getUseImportType($node, $useItem)); + } + } + + // Track group use statements + if ($node instanceof GroupUse) { + foreach ($node->uses as $useItem) { + $this->setAliasForType(\strtolower($useItem->getAlias()), Name::concat($node->prefix, $useItem->name), $this->getUseImportType($node, $useItem)); + } + } + + return null; + } + + /** + * Save alias state when leaving a namespace. + * + * Braced namespaces (like `namespace { ... }`) are self-contained and don't persist their use + * statements between executions. + * + * Only save aliases for open namespaces (like `namespace Foo;`), or implicit namespace wrappers + * re-injected by PsySH (psyshReinjected). + * + * {@inheritdoc} + */ + public function leaveNode(Node $node) + { + if ($node instanceof Namespace_) { + $this->syncCompatAliases(); + + // Open namespaces (like `namespace Foo;`) have kind == KIND_SEMICOLON. + if ($node->getAttribute('kind') === Namespace_::KIND_SEMICOLON || $node->getAttribute('psyshReinjected')) { + if ($this->cleaner) { + $this->cleaner->setAliasesByTypeForNamespace($node->name, $this->aliasesByType); + } + } + + $this->aliases = []; + $this->aliasesByType = []; } + + return null; } /** * Get a fully-qualified name (class, function, interface, etc). * + * Resolves use statement aliases before applying namespace. + * * @param mixed $name */ protected function getFullyQualifiedName($name): string { + $this->syncCompatAliases(); + if ($name instanceof FullyQualifiedName) { return \implode('\\', $this->getParts($name)); } + // Check if this name matches a use statement alias + if ($name instanceof Name) { + $nameParts = $this->getParts($name); + $firstPart = \strtolower($nameParts[0]); + + if (isset($this->aliases[$firstPart])) { + // Replace first part with the aliased namespace + $aliasedParts = $this->getParts($this->aliases[$firstPart]); + \array_shift($nameParts); // Remove first part + + return \implode('\\', \array_merge($aliasedParts, $nameParts)); + } + } + if ($name instanceof Name) { $name = $this->getParts($name); } elseif (!\is_array($name)) { @@ -82,4 +175,54 @@ protected function getParts(Name $name): array { return \method_exists($name, 'getParts') ? $name->getParts() : $name->parts; } + + protected function getAliasesForType(int $type): array + { + $this->syncCompatAliases(); + + return $this->aliasesByType[$type] ?? []; + } + + private function setAliasForType(string $alias, Name $name, int $type): void + { + $this->aliasesByType[$type][$alias] = $name; + if ($type === Use_::TYPE_NORMAL) { + $this->aliases[$alias] = $name; + } + } + + /** + * Sync $aliases into $aliasesByType[TYPE_NORMAL] for subclasses that read $aliases directly. + */ + private function syncCompatAliases(): void + { + if ($this->aliases === []) { + unset($this->aliasesByType[Use_::TYPE_NORMAL]); + + return; + } + + $this->aliasesByType[Use_::TYPE_NORMAL] = $this->aliases; + } + + /** + * Resolve the import type for a use item across PHP-Parser 4.x and 5.x. + * + * Individual use items may specify their own type (e.g. in group use + * statements), otherwise fall back to the parent statement type. + */ + protected function getUseImportType(Node $node, Node $useItem): int + { + $itemType = $useItem->type ?? null; + if (\is_int($itemType) && $itemType !== Use_::TYPE_UNKNOWN) { + return $itemType; + } + + $nodeType = $node->type ?? null; + if (\is_int($nodeType) && $nodeType !== Use_::TYPE_UNKNOWN) { + return $nodeType; + } + + return Use_::TYPE_NORMAL; + } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/NamespacePass.php b/app/vendor/psy/psysh/src/CodeCleaner/NamespacePass.php index 49d9bca2b..04097b1a2 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/NamespacePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/NamespacePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -27,17 +27,16 @@ * namespace is replaced by another namespace. To reset to the top level * namespace, enter `namespace {}`. This is a bit ugly, but it does the trick :) */ -class NamespacePass extends CodeCleanerPass +class NamespacePass extends NamespaceAwarePass { - private ?Name $namespace = null; - private CodeCleaner $cleaner; - /** - * @param CodeCleaner $cleaner + * @param ?CodeCleaner $cleaner deprecated parameter, use setCleaner() instead + * + * @phpstan-ignore-next-line method.unused */ - public function __construct(CodeCleaner $cleaner) + public function __construct(?CodeCleaner $cleaner = null) { - $this->cleaner = $cleaner; + // No-op, since cleaner is provided by NamespaceAwarePass } /** @@ -61,9 +60,7 @@ public function beforeTraverse(array $nodes) if ($last instanceof Namespace_) { $kind = $last->getAttribute('kind'); - // Treat all namespace statements pre-PHP-Parser v3.1.2 as "open", - // even though we really have no way of knowing. - if ($kind === null || $kind === Namespace_::KIND_SEMICOLON) { + if ($kind === Namespace_::KIND_SEMICOLON) { // Save the current namespace for open namespaces $this->setNamespace($last->name); } else { @@ -74,25 +71,46 @@ public function beforeTraverse(array $nodes) return $nodes; } - return $this->namespace ? [new Namespace_($this->namespace, $nodes)] : $nodes; + // Wrap in current namespace if one is set + $currentNamespace = $this->getCurrentNamespace(); + + if (!$currentNamespace) { + return $nodes; + } + + // Mark as re-injected so UseStatementPass knows it can re-inject use statements + return [new Namespace_($currentNamespace, $nodes, ['psyshReinjected' => true])]; + } + + /** + * Get the current namespace as a Name node. + * + * This is more complicated than it needs to be, because we're not storing namespace as a Name. + * + * @return Name|null + */ + private function getCurrentNamespace(): ?Name + { + $namespace = $this->cleaner->getNamespace(); + + return $namespace ? new Name($namespace) : null; } /** - * Remember the namespace and (re)set the namespace on the CodeCleaner as - * well. + * Update the namespace in CodeCleaner and clear aliases. * * @param Name|null $namespace */ private function setNamespace(?Name $namespace) { - $this->namespace = $namespace; - $this->cleaner->setNamespace($namespace === null ? null : $this->getParts($namespace)); + $this->cleaner->setNamespace($namespace); + + // Always clear aliases when changing namespace + $this->cleaner->setAliasesByTypeForNamespace($namespace, []); } /** - * Backwards compatibility shim for PHP-Parser 4.x. - * - * At some point we might want to make the namespace a plain string, to match how Name works? + * @deprecated unused and will be removed in a future version */ protected function getParts(Name $name): array { diff --git a/app/vendor/psy/psysh/src/CodeCleaner/NoReturnValue.php b/app/vendor/psy/psysh/src/CodeCleaner/NoReturnValue.php index 53f30a221..218282177 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/NoReturnValue.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/NoReturnValue.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/CodeCleaner/PassableByReferencePass.php b/app/vendor/psy/psysh/src/CodeCleaner/PassableByReferencePass.php index 5118c5bbd..dc0795323 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/PassableByReferencePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/PassableByReferencePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -44,7 +44,7 @@ public function enterNode(Node $node) if ($node instanceof FuncCall) { // if function name is an expression or a variable, give it a pass for now. if ($node->name instanceof Expr || $node->name instanceof Variable) { - return; + return null; } $name = (string) $node->name; @@ -57,7 +57,7 @@ public function enterNode(Node $node) $refl = new \ReflectionFunction($name); } catch (\ReflectionException $e) { // Well, we gave it a shot! - return; + return null; } $args = []; @@ -66,7 +66,9 @@ public function enterNode(Node $node) continue; } - $args[$arg->name !== null ? $arg->name->name : $position] = $arg; + // Named arguments were added in php-parser 4.1, so we need to check if the property exists + $key = (\property_exists($arg, 'name') && $arg->name !== null) ? $arg->name->name : $position; + $args[$key] = $arg; } foreach ($refl->getParameters() as $key => $param) { @@ -78,13 +80,19 @@ public function enterNode(Node $node) } } } + + return null; } private function isPassableByReference(Node $arg): bool { + if (!\property_exists($arg, 'value')) { + return false; + } + // Unpacked arrays can be passed by reference if ($arg->value instanceof Array_) { - return $arg->unpack; + return \property_exists($arg, 'unpack') && $arg->unpack; } // FuncCall, MethodCall and StaticCall are all PHP _warnings_ not fatal errors, so we'll let diff --git a/app/vendor/psy/psysh/src/CodeCleaner/RequirePass.php b/app/vendor/psy/psysh/src/CodeCleaner/RequirePass.php index 5c8cde49c..c98291506 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/RequirePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/RequirePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -16,7 +16,6 @@ use PhpParser\Node\Expr\Include_; use PhpParser\Node\Expr\StaticCall; use PhpParser\Node\Name\FullyQualified as FullyQualifiedName; -use PhpParser\Node\Scalar\Int_; use PhpParser\Node\Scalar\LNumber; use Psy\Exception\ErrorException; use Psy\Exception\FatalErrorException; @@ -36,7 +35,7 @@ class RequirePass extends CodeCleanerPass public function enterNode(Node $origNode) { if (!$this->isRequireNode($origNode)) { - return; + return null; } $node = clone $origNode; @@ -50,10 +49,10 @@ public function enterNode(Node $origNode) * * $foo = require \Psy\CodeCleaner\RequirePass::resolve($bar) */ - // @todo Remove LNumber once we drop support for PHP-Parser 4.x - $arg = \class_exists('PhpParser\Node\Scalar\Int_') ? - new Int_($origNode->getStartLine()) : - new LNumber($origNode->getStartLine()); + // PHP-Parser 4.x uses LNumber, 5.x has LNumber as an alias to Int_ + // Just use LNumber for compatibility with both versions + // @todo Switch to Int_ once we drop support for PHP-Parser 4.x + $arg = new LNumber($origNode->getStartLine()); $node->expr = new StaticCall( new FullyQualifiedName(self::class), diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ReturnTypePass.php b/app/vendor/psy/psysh/src/CodeCleaner/ReturnTypePass.php index 8ab898460..ae5adc072 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/ReturnTypePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/ReturnTypePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -44,15 +44,15 @@ class ReturnTypePass extends CodeCleanerPass public function enterNode(Node $node) { if ($this->isFunctionNode($node)) { - $this->returnTypeStack[] = $node->returnType; + $this->returnTypeStack[] = \property_exists($node, 'returnType') ? $node->returnType : null; - return; + return null; } if (!empty($this->returnTypeStack) && $node instanceof Return_) { $expectedType = \end($this->returnTypeStack); if ($expectedType === null) { - return; + return null; } $msg = null; @@ -77,6 +77,8 @@ public function enterNode(Node $node) throw new FatalErrorException($msg, 0, \E_ERROR, null, $node->getStartLine()); } } + + return null; } /** @@ -89,6 +91,8 @@ public function leaveNode(Node $node) if (!empty($this->returnTypeStack) && $this->isFunctionNode($node)) { \array_pop($this->returnTypeStack); } + + return null; } private function isFunctionNode(Node $node): bool diff --git a/app/vendor/psy/psysh/src/CodeCleaner/StrictTypesPass.php b/app/vendor/psy/psysh/src/CodeCleaner/StrictTypesPass.php index 8fd6ab711..ab13ea0f9 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/StrictTypesPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/StrictTypesPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/CodeCleaner/UseStatementPass.php b/app/vendor/psy/psysh/src/CodeCleaner/UseStatementPass.php index a2ddc9ef4..ce39220a9 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/UseStatementPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/UseStatementPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -12,14 +12,12 @@ namespace Psy\CodeCleaner; use PhpParser\Node; -use PhpParser\Node\Name; -use PhpParser\Node\Name\FullyQualified as FullyQualifiedName; -use PhpParser\Node\Stmt\GroupUse; +use PhpParser\Node\Identifier; use PhpParser\Node\Stmt\Namespace_; use PhpParser\Node\Stmt\Use_; use PhpParser\Node\Stmt\UseItem; use PhpParser\Node\Stmt\UseUse; -use PhpParser\NodeTraverser; +use Psy\Exception\FatalErrorException; /** * Provide implicit use statements for subsequent execution. @@ -30,113 +28,135 @@ * * ... which it then applies implicitly to all future evaluated code, until the * current namespace is replaced by another namespace. + * + * Extends NamespaceAwarePass to leverage shared alias tracking. */ -class UseStatementPass extends CodeCleanerPass +class UseStatementPass extends NamespaceAwarePass { - private array $aliases = []; - private array $lastAliases = []; - private ?Name $lastNamespace = null; - /** - * Re-load the last set of use statements on re-entering a namespace. - * - * This isn't how namespaces normally work, but because PsySH has to spin - * up a new namespace for every line of code, we do this to make things - * work like you'd expect. - * - * @param Node $node - * - * @return int|Node|null Replacement node (or special return value) + * {@inheritdoc} */ public function enterNode(Node $node) { - if ($node instanceof Namespace_) { - // If this is the same namespace as last namespace, let's do ourselves - // a favor and reload all the aliases... - if (\strtolower($node->name ?: '') === \strtolower($this->lastNamespace ?: '')) { - $this->aliases = $this->lastAliases; - } + // Check for use statement conflicts BEFORE parent adds it to aliases + // Skip re-injected use statements (marked with 'psyshReinjected' attribute) + if ($node instanceof Use_ && !$node->getAttribute('psyshReinjected')) { + $this->validateUseStatement($node); } + + return parent::enterNode($node); } /** - * If this statement is a namespace, forget all the aliases we had. - * - * If it's a use statement, remember the alias for later. Otherwise, apply - * remembered aliases to the code. + * Re-inject use statements from previous inputs. * - * @param Node $node + * Each REPL input is evaluated separately; re-injecting use statements matches PHP behavior for + * namespaces and use statements in a file. * - * @return int|Node|Node[]|null Replacement node (or special return value) + * @return Node[]|null Array of nodes */ - public function leaveNode(Node $node) + public function beforeTraverse(array $nodes) { - // Store a reference to every "use" statement, because we'll need them in a bit. - if ($node instanceof Use_) { - foreach ($node->uses as $useItem) { - $this->aliases[\strtolower($useItem->getAlias())] = $useItem->name; - } + parent::beforeTraverse($nodes); - // @todo Rename to Node_Visitor::REMOVE_NODE once we drop support for PHP-Parser 4.x - return NodeTraverser::REMOVE_NODE; + if (!$this->cleaner) { + return null; } - // Expand every "use" statement in the group into a full, standalone "use" and store 'em with the others. - if ($node instanceof GroupUse) { - foreach ($node->uses as $useItem) { - $this->aliases[\strtolower($useItem->getAlias())] = Name::concat($node->prefix, $useItem->name, [ - 'startLine' => $node->prefix->getAttribute('startLine'), - 'endLine' => $useItem->name->getAttribute('endLine'), - ]); + // Check for namespace declarations in the input + foreach ($nodes as $node) { + if ($node instanceof Namespace_) { + // Only re-inject use statements if this is a wrapper created by NamespacePass. + // This matches PHP behavior: explicit namespace declaration clears use statements. + if ($node->getAttribute('psyshReinjected')) { + $aliasesByType = $this->cleaner->getAliasesByTypeForNamespace($node->name); + if (!empty($aliasesByType)) { + $useStatements = $this->createUseStatements($aliasesByType); + $node->stmts = \array_merge($useStatements, $node->stmts ?? []); + } + } + + // Don't process other nodes or return modified nodes + return null; } + } - // @todo Rename to Node_Visitor::REMOVE_NODE once we drop support for PHP-Parser 4.x - return NodeTraverser::REMOVE_NODE; + // No namespace declaration in input, or re-applied by NamespacePass; re-inject use + // statements for the empty namespace. + $aliasesByType = $this->cleaner->getAliasesByTypeForNamespace(null); + if (!empty($aliasesByType)) { + $useStatements = $this->createUseStatements($aliasesByType); + $nodes = \array_merge($useStatements, $nodes); } - // Start fresh, since we're done with this namespace. - if ($node instanceof Namespace_) { - $this->lastNamespace = $node->name; - $this->lastAliases = $this->aliases; - $this->aliases = []; + return $nodes; + } - return; + /** + * If we have aliases but didn't leave a namespace (global namespace case), persist them to + * CodeCleaner for the next traversal. + * + * {@inheritdoc} + */ + public function afterTraverse(array $nodes) + { + if (!$this->cleaner) { + return null; } - // Do nothing with UseItem; this an entry in the list of uses in the use statement. - // @todo Remove UseUse once we drop support for PHP-Parser 4.x - if ($node instanceof UseUse || $node instanceof UseItem) { - return; + // Persist aliases if they're at the global level (not inside any namespace) + if (!empty($this->aliasesByType)) { + $this->cleaner->setAliasesByTypeForNamespace(null, $this->aliasesByType); } - // For everything else, we'll implicitly thunk all aliases into fully-qualified names. - foreach ($node as $name => $subNode) { - if ($subNode instanceof Name) { - if ($replacement = $this->findAlias($subNode)) { - $node->$name = $replacement; - } + return null; + } + + /** + * Validate that a use statement doesn't conflict with existing aliases. + * + * @throws FatalErrorException if the alias is already in use + * + * @param Use_ $stmt The use statement node + */ + private function validateUseStatement(Use_ $stmt): void + { + $seenAliases = []; + + foreach ($stmt->uses as $useItem) { + $alias = \strtolower($useItem->getAlias()); + $type = $this->getUseImportType($stmt, $useItem); + + if (isset($seenAliases[$type][$alias]) || isset($this->getAliasesForType($type)[$alias])) { + throw new FatalErrorException(\sprintf('Cannot use %s as %s because the name is already in use', $useItem->name->toString(), $useItem->getAlias()), 0, \E_ERROR, null, $stmt->getStartLine()); } - } - return $node; + $seenAliases[$type][$alias] = true; + } } /** - * Find class/namespace aliases. + * Create use statement nodes from stored aliases. * - * @param Name $name + * @param array $aliasesByType Map of Use_::TYPE_* constants to alias maps * - * @return FullyQualifiedName|null + * @return Use_[] Array of use statement nodes */ - private function findAlias(Name $name) + private function createUseStatements(array $aliasesByType): array { - $that = \strtolower($name); - foreach ($this->aliases as $alias => $prefix) { - if ($that === $alias) { - return new FullyQualifiedName($prefix->toString()); - } elseif (\substr($that, 0, \strlen($alias) + 1) === $alias.'\\') { - return new FullyQualifiedName($prefix->toString().\substr($name, \strlen($alias))); + $useStatements = []; + + foreach ([Use_::TYPE_NORMAL, Use_::TYPE_FUNCTION, Use_::TYPE_CONSTANT] as $type) { + foreach ($aliasesByType[$type] ?? [] as $alias => $name) { + // Create UseItem (PHP-Parser 5.x) or UseUse (PHP-Parser 4.x) + $useItem = \class_exists(UseItem::class) + ? new UseItem($name, new Identifier($alias)) + : new UseUse($name, $alias); + // Mark as re-injected so we don't validate it + $useStatements[] = new Use_([$useItem], $type, ['psyshReinjected' => true]); } } + + return $useStatements; } } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ValidClassNamePass.php b/app/vendor/psy/psysh/src/CodeCleaner/ValidClassNamePass.php index 331ca743a..c3a31f9aa 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/ValidClassNamePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/ValidClassNamePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -56,7 +56,7 @@ public function enterNode(Node $node) if (self::isConditional($node)) { $this->conditionalScopes++; - return; + return null; } if ($this->conditionalScopes === 0) { @@ -68,6 +68,8 @@ public function enterNode(Node $node) $this->validateTraitStatement($node); } } + + return null; } /** @@ -80,6 +82,8 @@ public function leaveNode(Node $node) if (self::isConditional($node)) { $this->conditionalScopes--; } + + return null; } private static function isConditional(Node $node): bool @@ -137,7 +141,7 @@ protected function validateTraitStatement(Trait_ $stmt) protected function ensureCanDefine(Stmt $stmt, string $scopeType = self::CLASS_TYPE) { // Anonymous classes don't have a name, and uniqueness shouldn't be enforced. - if ($stmt->name === null) { + if (!\property_exists($stmt, 'name') || $stmt->name === null) { return; } @@ -311,6 +315,8 @@ protected function findInScope(string $name) if (isset($this->currentScope[$name])) { return $this->currentScope[$name]; } + + return null; } /** diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ValidConstructorPass.php b/app/vendor/psy/psysh/src/CodeCleaner/ValidConstructorPass.php index 3d14d98d3..2668aa07e 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/ValidConstructorPass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/ValidConstructorPass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -41,6 +41,8 @@ class ValidConstructorPass extends CodeCleanerPass public function beforeTraverse(array $nodes) { $this->namespace = []; + + return null; } /** @@ -62,14 +64,14 @@ public function enterNode(Node $node) foreach ($node->stmts as $stmt) { if ($stmt instanceof ClassMethod) { // If we find a new-style constructor, no need to look for the old-style - if ('__construct' === \strtolower($stmt->name)) { + if (\property_exists($stmt, 'name') && \strtolower($stmt->name) === '__construct') { $this->validateConstructor($stmt, $node); - return; + return null; } // We found a possible old-style constructor (unless there is also a __construct method) - if (empty($this->namespace) && $node->name !== null && \strtolower($node->name) === \strtolower($stmt->name)) { + if (empty($this->namespace) && $node->name !== null && \property_exists($stmt, 'name') && \strtolower($node->name) === \strtolower($stmt->name)) { $constructor = $stmt; } } @@ -79,6 +81,8 @@ public function enterNode(Node $node) $this->validateConstructor($constructor, $node); } } + + return null; } /** @@ -90,11 +94,11 @@ public function enterNode(Node $node) */ private function validateConstructor(Node $constructor, Node $classNode) { - if ($constructor->isStatic()) { + if (\method_exists($constructor, 'isStatic') && $constructor->isStatic()) { $msg = \sprintf( 'Constructor %s::%s() cannot be static', \implode('\\', \array_merge($this->namespace, (array) $classNode->name->toString())), - $constructor->name + \property_exists($constructor, 'name') ? $constructor->name : '__construct' ); throw new FatalErrorException($msg, 0, \E_ERROR, null, $classNode->getStartLine()); } @@ -103,7 +107,7 @@ private function validateConstructor(Node $constructor, Node $classNode) $msg = \sprintf( 'Constructor %s::%s() cannot declare a return type', \implode('\\', \array_merge($this->namespace, (array) $classNode->name->toString())), - $constructor->name + \property_exists($constructor, 'name') ? $constructor->name : '__construct' ); throw new FatalErrorException($msg, 0, \E_ERROR, null, $classNode->getStartLine()); } diff --git a/app/vendor/psy/psysh/src/CodeCleaner/ValidFunctionNamePass.php b/app/vendor/psy/psysh/src/CodeCleaner/ValidFunctionNamePass.php index 789364f18..4a744365a 100644 --- a/app/vendor/psy/psysh/src/CodeCleaner/ValidFunctionNamePass.php +++ b/app/vendor/psy/psysh/src/CodeCleaner/ValidFunctionNamePass.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -59,6 +59,8 @@ public function enterNode(Node $node) $this->currentScope[\strtolower($name)] = true; } + + return null; } /** @@ -71,6 +73,8 @@ public function leaveNode(Node $node) if (self::isConditional($node)) { $this->conditionalScopes--; } + + return null; } private static function isConditional(Node $node) diff --git a/app/vendor/psy/psysh/src/CodeCleanerAware.php b/app/vendor/psy/psysh/src/CodeCleanerAware.php new file mode 100644 index 000000000..ea19ba311 --- /dev/null +++ b/app/vendor/psy/psysh/src/CodeCleanerAware.php @@ -0,0 +1,26 @@ +setName('buffer') @@ -52,18 +57,32 @@ protected function configure() protected function execute(InputInterface $input, OutputInterface $output): int { $shell = $this->getShell(); - - $buf = $shell->getCodeBuffer(); + $shellOutput = $this->shellOutput($output); + $readline = $this->getLegacyReadline(); + $legacyBuffer = $readline->getBuffer(); + $shellBuffer = $shell->getPendingCodeBuffer(); + $buf = $legacyBuffer !== [] ? $legacyBuffer : $shellBuffer; if ($input->getOption('clear')) { - $shell->resetCodeBuffer(); - $output->writeln($this->formatLines($buf, 'urgent'), ShellOutput::NUMBER_LINES); + $readline->clearBuffer(); + if ($shellBuffer !== []) { + $shell->clearPendingCodeBuffer(); + } + $shellOutput->writeln($this->formatLines($buf, 'urgent'), ShellOutputAdapter::NUMBER_LINES); } else { - $output->writeln($this->formatLines($buf), ShellOutput::NUMBER_LINES); + $shellOutput->writeln($this->formatLines($buf), ShellOutputAdapter::NUMBER_LINES); } return 0; } + /** + * Set the shell's readline implementation. + */ + public function setReadline(Readline $readline) + { + $this->readline = $readline; + } + /** * A helper method for wrapping buffer lines in `` and `` formatter strings. * @@ -76,8 +95,18 @@ protected function formatLines(array $lines, string $type = 'return'): array { $template = \sprintf('<%s>%%s', $type, $type); - return \array_map(function ($line) use ($template) { - return \sprintf($template, $line); - }, $lines); + return \array_map(fn ($line) => \sprintf($template, $line), $lines); + } + + /** + * Get the active multiline buffer from the legacy shim. + */ + private function getLegacyReadline(): LegacyReadline + { + if ($this->readline instanceof LegacyReadline) { + return $this->readline; + } + + throw new \LogicException('BufferCommand requires LegacyReadline.'); } } diff --git a/app/vendor/psy/psysh/src/Command/ClearCommand.php b/app/vendor/psy/psysh/src/Command/ClearCommand.php index 42a66b0f2..4d1502f6b 100644 --- a/app/vendor/psy/psysh/src/Command/ClearCommand.php +++ b/app/vendor/psy/psysh/src/Command/ClearCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -24,7 +24,7 @@ class ClearCommand extends Command /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('clear') diff --git a/app/vendor/psy/psysh/src/Command/CodeArgumentParser.php b/app/vendor/psy/psysh/src/Command/CodeArgumentParser.php index 6d32276f3..0170aaf7c 100644 --- a/app/vendor/psy/psysh/src/Command/CodeArgumentParser.php +++ b/app/vendor/psy/psysh/src/Command/CodeArgumentParser.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,6 +11,7 @@ namespace Psy\Command; +use PhpParser\Error as PhpParserError; use PhpParser\Parser; use Psy\Exception\ParseErrorException; use Psy\ParserFactory; @@ -42,7 +43,7 @@ public function parse(string $code): array try { return $this->parser->parse($code); - } catch (\PhpParser\Error $e) { + } catch (PhpParserError $e) { if (\strpos($e->getMessage(), 'unexpected EOF') === false) { throw ParseErrorException::fromParseError($e); } @@ -50,7 +51,7 @@ public function parse(string $code): array // If we got an unexpected EOF, let's try it again with a semicolon. try { return $this->parser->parse($code.';'); - } catch (\PhpParser\Error $_e) { + } catch (PhpParserError $_e) { // Throw the original error, not the semicolon one. throw ParseErrorException::fromParseError($e); } diff --git a/app/vendor/psy/psysh/src/Command/Command.php b/app/vendor/psy/psysh/src/Command/Command.php index 693c5fc36..ef0d409ae 100644 --- a/app/vendor/psy/psysh/src/Command/Command.php +++ b/app/vendor/psy/psysh/src/Command/Command.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,11 +11,17 @@ namespace Psy\Command; +use Psy\CodeCleanerAware; +use Psy\ContextAware; +use Psy\Output\ShellOutputAdapter; +use Psy\Readline\ReadlineAware; use Psy\Shell; +use Psy\VarDumper\PresenterAware; use Symfony\Component\Console\Application; use Symfony\Component\Console\Command\Command as BaseCommand; use Symfony\Component\Console\Helper\Table; use Symfony\Component\Console\Helper\TableStyle; +use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; /** @@ -52,6 +58,23 @@ protected function getShell(): Shell return $shell; } + /** + * {@inheritdoc} + */ + public function run(InputInterface $input, OutputInterface $output): int + { + if ( + $this instanceof ContextAware || + $this instanceof CodeCleanerAware || + $this instanceof PresenterAware || + $this instanceof ReadlineAware + ) { + $this->getShell()->boot($input, $output); + } + + return parent::run($input, $output); + } + /** * {@inheritdoc} */ @@ -83,6 +106,14 @@ public function asText(): string return \implode("\n", $messages); } + /** + * Render help text for the current input context. + */ + public function asTextForInput(InputInterface $input): string + { + return $this->asText(); + } + /** * {@inheritdoc} */ @@ -90,9 +121,10 @@ private function getArguments(): array { $hidden = $this->getHiddenArguments(); - return \array_filter($this->getNativeDefinition()->getArguments(), function ($argument) use ($hidden) { - return !\in_array($argument->getName(), $hidden); - }); + return \array_filter( + $this->getNativeDefinition()->getArguments(), + fn ($argument) => !\in_array($argument->getName(), $hidden) + ); } /** @@ -112,9 +144,10 @@ private function getOptions(): array { $hidden = $this->getHiddenOptions(); - return \array_filter($this->getNativeDefinition()->getOptions(), function ($option) use ($hidden) { - return !\in_array($option->getName(), $hidden); - }); + return \array_filter( + $this->getNativeDefinition()->getOptions(), + fn ($option) => !\in_array($option->getName(), $hidden) + ); } /** @@ -154,7 +187,9 @@ private function argumentsAsText(): string } $name = $argument->getName(); + // @phan-suppress-next-line PhanParamSuspiciousOrder - intentionally padding empty string to create spaces $pad = \str_pad('', $max - \strlen($name)); + // @phan-suppress-next-line PhanParamSuspiciousOrder - intentionally padding empty string to create spaces $description = \str_replace("\n", "\n".\str_pad('', $max + 2, ' '), $argument->getDescription()); $messages[] = \sprintf(' %s%s %s%s', $name, $pad, $description, $default); @@ -186,6 +221,7 @@ private function optionsAsText(): string } $multiple = $option->isArray() ? ' (multiple values allowed)' : ''; + // @phan-suppress-next-line PhanParamSuspiciousOrder - intentionally padding empty string to create spaces $description = \str_replace("\n", "\n".\str_pad('', $max + 2, ' '), $option->getDescription()); $optionMax = $max - \strlen($option->getName()) - 2; @@ -268,4 +304,12 @@ protected function getTable(OutputInterface $output) ->setRows([]) ->setStyle($style); } + + /** + * Get a ShellOutputAdapter for the given output. + */ + protected function shellOutput(OutputInterface $output): ShellOutputAdapter + { + return new ShellOutputAdapter($output); + } } diff --git a/app/vendor/psy/psysh/src/Command/Config/AbstractConfigCommand.php b/app/vendor/psy/psysh/src/Command/Config/AbstractConfigCommand.php new file mode 100644 index 000000000..42e91b4ee --- /dev/null +++ b/app/vendor/psy/psysh/src/Command/Config/AbstractConfigCommand.php @@ -0,0 +1,562 @@ +config = $config; + $this->options = null; + } + + /** + * @return array Associative array of option definitions keyed by lowercase name + */ + protected function getOptions(): array + { + if ($this->options !== null) { + return $this->options; + } + + $config = $this->getConfig(); + $booleanParser = function (string $name, string $acceptedValues): callable { + return function (string $value) use ($name, $acceptedValues): bool { + switch (\strtolower($value)) { + case '1': + case 'true': + case 'yes': + case 'on': + return true; + + case '0': + case 'false': + case 'no': + case 'off': + return false; + + default: + throw new \InvalidArgumentException(\sprintf('Invalid %s value: %s. Accepted values: %s', $name, $value, $acceptedValues)); + } + }; + }; + $semicolonsSuppressReturnParser = function (string $name, string $acceptedValues): callable { + return function (string $value) use ($name, $acceptedValues) { + switch (\strtolower($value)) { + case '1': + case 'true': + case 'yes': + case 'on': + return true; + + case '0': + case 'false': + case 'no': + case 'off': + return false; + + case Configuration::SEMICOLONS_SUPPRESS_RETURN_DOUBLE: + return Configuration::SEMICOLONS_SUPPRESS_RETURN_DOUBLE; + + default: + throw new \InvalidArgumentException(\sprintf('Invalid %s value: %s. Accepted values: %s', $name, $value, $acceptedValues)); + } + }; + }; + $enumParser = function (string $name, array $values, string $acceptedValues): callable { + return function (string $value) use ($name, $values, $acceptedValues): string { + if (!\in_array($value, $values, true)) { + throw new \InvalidArgumentException(\sprintf('Invalid %s value: %s. Accepted values: %s', $name, $value, $acceptedValues)); + } + + return $value; + }; + }; + $configEnumParser = function (string $name, array $values, string $acceptedValues): callable { + return function (string $value) use ($name, $values, $acceptedValues): string { + if (\in_array($value, $values, true)) { + return $value; + } + + try { + $resolved = $this->resolveConfigurationConstant($value); + } catch (\Throwable $e) { + throw new \InvalidArgumentException(\sprintf('Invalid %s value: %s. Accepted values: %s', $name, $value, $acceptedValues), 0, $e); + } + + if (!\is_string($resolved) || !\in_array($resolved, $values, true)) { + throw new \InvalidArgumentException(\sprintf('Invalid %s value: %s. Accepted values: %s', $name, $value, $acceptedValues)); + } + + return $resolved; + }; + }; + + $this->options = [ + 'verbosity' => [ + 'name' => 'verbosity', + 'acceptedValues' => [ + Configuration::VERBOSITY_QUIET, + Configuration::VERBOSITY_NORMAL, + Configuration::VERBOSITY_VERBOSE, + Configuration::VERBOSITY_VERY_VERBOSE, + Configuration::VERBOSITY_DEBUG, + ], + 'parser' => $configEnumParser('verbosity', [ + Configuration::VERBOSITY_QUIET, + Configuration::VERBOSITY_NORMAL, + Configuration::VERBOSITY_VERBOSE, + Configuration::VERBOSITY_VERY_VERBOSE, + Configuration::VERBOSITY_DEBUG, + ], 'quiet|normal|verbose|very_verbose|debug'), + 'getter' => function () use ($config): string { + return $config->verbosity(); + }, + 'setter' => function (string $value) use ($config): void { + $config->setVerbosity($value); + }, + 'refresh' => true, + ], + 'useunicode' => [ + 'name' => 'useUnicode', + 'acceptedValues' => ['on', 'off'], + 'parser' => $booleanParser('useUnicode', 'on|off'), + 'getter' => function () use ($config): bool { + return $config->useUnicode(); + }, + 'setter' => function (bool $value) use ($config): void { + $config->setUseUnicode($value); + }, + 'refresh' => false, + ], + 'errorlogginglevel' => [ + 'name' => 'errorLoggingLevel', + 'acceptedValues' => [''], + 'parser' => function (string $value): int { + if (\preg_match('/^\d+$/', $value)) { + return (int) $value; + } + + try { + $resolved = $this->getShell()->execute($value, true); + } catch (\Throwable $e) { + throw new \InvalidArgumentException(\sprintf('Invalid errorLoggingLevel value: %s. Accepted values: ', $value), 0, $e); + } + + if (!\is_int($resolved)) { + throw new \InvalidArgumentException(\sprintf('Invalid errorLoggingLevel value: %s. Accepted values: ', $value)); + } + + return $resolved; + }, + 'getter' => function () use ($config): string { + return $this->formatErrorLoggingLevel($config->errorLoggingLevel()); + }, + 'setter' => function (int $value) use ($config): void { + $config->setErrorLoggingLevel($value); + }, + 'refresh' => false, + ], + 'clipboardcommand' => [ + 'name' => 'clipboardCommand', + 'acceptedValues' => ['auto', ''], + 'parser' => function (string $value): ?string { + return \strtolower($value) === 'auto' ? null : $value; + }, + 'getter' => function () use ($config): string { + return $config->clipboardCommand() ?? 'auto'; + }, + 'setter' => function (?string $value) use ($config): void { + $config->setClipboardCommand($value); + }, + 'refresh' => false, + ], + 'useosc52clipboard' => [ + 'name' => 'useOsc52Clipboard', + 'acceptedValues' => ['on', 'off'], + 'parser' => $booleanParser('useOsc52Clipboard', 'on|off'), + 'getter' => function () use ($config): bool { + return $config->useOsc52Clipboard(); + }, + 'setter' => function (bool $value) use ($config): void { + $config->setUseOsc52Clipboard($value); + }, + 'refresh' => false, + ], + 'colormode' => [ + 'name' => 'colorMode', + 'acceptedValues' => [ + Configuration::COLOR_MODE_AUTO, + Configuration::COLOR_MODE_FORCED, + Configuration::COLOR_MODE_DISABLED, + ], + 'parser' => $configEnumParser('colorMode', [ + Configuration::COLOR_MODE_AUTO, + Configuration::COLOR_MODE_FORCED, + Configuration::COLOR_MODE_DISABLED, + ], 'auto|forced|disabled'), + 'getter' => function () use ($config): string { + return $config->colorMode(); + }, + 'setter' => function (string $value) use ($config): void { + $config->setColorMode($value); + }, + 'refresh' => true, + ], + 'theme' => [ + 'name' => 'theme', + 'acceptedValues' => Theme::BUILTIN_THEMES, + 'parser' => $enumParser('theme', Theme::BUILTIN_THEMES, \implode('|', Theme::BUILTIN_THEMES)), + 'getter' => function () use ($config): string { + return $config->theme()->getName() ?? 'custom'; + }, + 'setter' => function (string $value) use ($config): bool { + $before = $config->theme(); + $config->setTheme($value); + + return !$before->equals($config->theme()); + }, + 'refresh' => true, + ], + 'pager' => [ + 'name' => 'pager', + 'acceptedValues' => ['default', 'off', ''], + 'parser' => function (string $value) { + switch (\strtolower($value)) { + case 'default': + case 'on': + case 'yes': + case 'true': + case '1': + return null; + case 'off': + case 'no': + case 'false': + case '0': + return false; + default: + return $value; + } + }, + 'getter' => function () use ($config): string { + $pager = $config->getPager(); + + if ($pager === false) { + return 'off'; + } + + if ($pager === null) { + return 'default'; + } + + if (\is_string($pager)) { + return $pager; + } + + return \get_class($pager); + }, + 'setter' => function ($value) use ($config): void { + if ($value === null) { + $config->setDefaultPager(); + + return; + } + + $config->setPager($value); + }, + 'refresh' => true, + ], + 'requiresemicolons' => [ + 'name' => 'requireSemicolons', + 'acceptedValues' => ['on', 'off'], + 'parser' => $booleanParser('requireSemicolons', 'on|off'), + 'getter' => function () use ($config): bool { + return $config->requireSemicolons(); + }, + 'setter' => function (bool $value) use ($config): void { + $config->setRequireSemicolons($value); + }, + 'refresh' => true, + ], + 'semicolonssuppressreturn' => [ + 'name' => 'semicolonsSuppressReturn', + 'acceptedValues' => ['on', 'off', Configuration::SEMICOLONS_SUPPRESS_RETURN_DOUBLE], + 'parser' => $semicolonsSuppressReturnParser('semicolonsSuppressReturn', 'on|off|double'), + 'getter' => function () use ($config) { + return $config->semicolonsSuppressReturn(); + }, + 'setter' => function ($value) use ($config): void { + $config->setSemicolonsSuppressReturn($value); + }, + 'refresh' => false, + ], + 'usebracketedpaste' => [ + 'name' => 'useBracketedPaste', + 'acceptedValues' => ['on', 'off'], + 'parser' => $booleanParser('useBracketedPaste', 'on|off'), + 'getter' => function () use ($config): bool { + return $config->useBracketedPaste(); + }, + 'setter' => function (bool $value) use ($config): void { + $config->setUseBracketedPaste($value); + }, + 'refresh' => true, + ], + 'usesyntaxhighlighting' => [ + 'name' => 'useSyntaxHighlighting', + 'acceptedValues' => ['on', 'off'], + 'parser' => $booleanParser('useSyntaxHighlighting', 'on|off'), + 'getter' => function () use ($config): bool { + return $config->useSyntaxHighlighting(); + }, + 'setter' => function (bool $value) use ($config): void { + $config->setUseSyntaxHighlighting($value); + }, + 'refresh' => true, + ], + 'usesuggestions' => [ + 'name' => 'useSuggestions', + 'acceptedValues' => ['on', 'off'], + 'parser' => $booleanParser('useSuggestions', 'on|off'), + 'getter' => function () use ($config): bool { + return $config->useSuggestions(); + }, + 'setter' => function (bool $value) use ($config): void { + $config->setUseSuggestions($value); + }, + 'refresh' => true, + ], + ]; + + return $this->options; + } + + protected function getOption(string $key): ?array + { + return $this->getOptions()[\strtolower($key)] ?? null; + } + + /** + * @return string[] + */ + protected function getOptionNames(): array + { + return \array_map( + fn (array $option): string => $option['name'], + \array_values($this->getOptions()) + ); + } + + /** + * @param mixed $value + */ + protected function formatValue($value): string + { + if (\is_bool($value)) { + return $value ? 'true' : 'false'; + } + + if ($value === null) { + return 'null'; + } + + return (string) $value; + } + + protected function formatAcceptedValues(array $option): string + { + return OutputFormatter::escape(\implode('|', $option['acceptedValues'])); + } + + protected function formatErrorLoggingLevel(int $value): string + { + if ($value === 0) { + return '0'; + } + + foreach ($this->getErrorLoggingConstants() as $name => $constantValue) { + if ($value === $constantValue) { + return $name; + } + } + + $allMask = $this->getErrorLoggingAllMask(); + if (($value & $allMask) === $value) { + $included = $this->formatErrorLoggingFlags($value); + $missingValue = $allMask & ~$value; + $missing = $this->formatErrorLoggingFlags($missingValue); + + if ($included !== null && $missing !== null && $this->countErrorLoggingFlags($missingValue) < $this->countErrorLoggingFlags($value)) { + return 'E_ALL & ~'.$this->wrapErrorLoggingFlags($missing); + } + + if ($included !== null) { + return $included; + } + } + + return (string) $value; + } + + protected function formatOptionName(string $name): string + { + return \sprintf('%s', $name); + } + + /** + * @param string[] $names + */ + protected function formatOptionNames(array $names): string + { + return \implode(', ', \array_map(fn (string $name): string => $this->formatOptionName($name), $names)); + } + + protected function unsupportedMessage(string $key): string + { + return \sprintf('Configuration option `%s` is not runtime-configurable.', $key); + } + + protected function getConfig(): Configuration + { + if ($this->config === null) { + throw new \RuntimeException('Configuration not available.'); + } + + return $this->config; + } + + /** + * @return int[] Error logging constants keyed by name + */ + private function getErrorLoggingConstants(): array + { + $names = [ + 'E_ALL', + 'E_ERROR', + 'E_WARNING', + 'E_PARSE', + 'E_NOTICE', + 'E_CORE_ERROR', + 'E_CORE_WARNING', + 'E_COMPILE_ERROR', + 'E_COMPILE_WARNING', + 'E_USER_ERROR', + 'E_USER_WARNING', + 'E_USER_NOTICE', + 'E_STRICT', + 'E_RECOVERABLE_ERROR', + 'E_DEPRECATED', + 'E_USER_DEPRECATED', + ]; + + $constants = []; + + foreach ($names as $name) { + if (\defined($name)) { + /** @var int $value */ + $value = \constant($name); + $constants[$name] = $value; + } + } + + return $constants; + } + + /** + * @return int[] Error logging flag constants keyed by name, excluding E_ALL + */ + private function getErrorLoggingFlagConstants(): array + { + $constants = $this->getErrorLoggingConstants(); + unset($constants['E_ALL']); + + return $constants; + } + + private function getErrorLoggingAllMask(): int + { + return \PHP_VERSION_ID < 80400 ? (\E_ALL | \E_STRICT) : \E_ALL; + } + + private function formatErrorLoggingFlags(int $value): ?string + { + if ($value === 0) { + return null; + } + + $parts = []; + $covered = 0; + + foreach ($this->getErrorLoggingFlagConstants() as $name => $constantValue) { + if ($constantValue !== 0 && ($value & $constantValue) === $constantValue) { + $parts[] = $name; + $covered |= $constantValue; + } + } + + if ($parts === [] || $covered !== $value) { + return null; + } + + return \implode(' | ', $parts); + } + + private function countErrorLoggingFlags(int $value): int + { + $count = 0; + + foreach ($this->getErrorLoggingFlagConstants() as $constantValue) { + if ($constantValue !== 0 && ($value & $constantValue) === $constantValue) { + $count++; + } + } + + return $count; + } + + private function wrapErrorLoggingFlags(string $expression): string + { + return \strpos($expression, ' | ') === false ? $expression : '('.$expression.')'; + } + + private function resolveConfigurationConstant(string $value): string + { + if (!\preg_match('/^\\\\?(?:Psy\\\\)?Configuration::([A-Z_]+)$/', $value, $matches)) { + throw new \InvalidArgumentException('Unsupported configuration constant expression.'); + } + + $constant = 'Psy\\Configuration::'.$matches[1]; + + if (!\defined($constant)) { + throw new \InvalidArgumentException('Unknown configuration constant.'); + } + + $resolved = \constant($constant); + + if (!\is_string($resolved)) { + throw new \InvalidArgumentException('Configuration constant does not resolve to a string value.'); + } + + return $resolved; + } +} diff --git a/app/vendor/psy/psysh/src/Command/Config/ConfigGetCommand.php b/app/vendor/psy/psysh/src/Command/Config/ConfigGetCommand.php new file mode 100644 index 000000000..767213841 --- /dev/null +++ b/app/vendor/psy/psysh/src/Command/Config/ConfigGetCommand.php @@ -0,0 +1,69 @@ +setName('config-get') + ->setDefinition([ + new InputArgument('key', InputArgument::OPTIONAL, 'Runtime-configurable option to inspect.'), + ]) + ->setDescription('Print the current value for one runtime-configurable PsySH setting.'); + } + + public function asText(): string + { + return \implode("\n", [ + 'Usage:', + ' config get \\', + '', + 'Help:', + ' Print the current value for one runtime-configurable PsySH setting.', + '', + 'Examples:', + ' >>> config get verbosity', + ' >>> config get theme', + '', + 'Supported Options:', + ' '.$this->formatOptionNames($this->getOptionNames()), + ]); + } + + protected function execute(InputInterface $input, OutputInterface $output): int + { + $key = $input->getArgument('key'); + if ($key === null) { + throw new \InvalidArgumentException('Please specify a runtime-configurable option to inspect.'); + } + + $option = $this->getOption($key); + if ($option === null) { + $output->writeln(\sprintf('%s', $this->unsupportedMessage((string) $key))); + + return 1; + } + + $output->writeln($this->formatValue($option['getter']())); + + return 0; + } +} diff --git a/app/vendor/psy/psysh/src/Command/Config/ConfigListCommand.php b/app/vendor/psy/psysh/src/Command/Config/ConfigListCommand.php new file mode 100644 index 000000000..f7a2a5b43 --- /dev/null +++ b/app/vendor/psy/psysh/src/Command/Config/ConfigListCommand.php @@ -0,0 +1,55 @@ +setName('config-list') + ->setDescription('Show runtime-configurable PsySH settings and their current values.'); + } + + public function asText(): string + { + return \implode("\n", [ + 'Usage:', + ' config list', + '', + 'Help:', + ' Show runtime-configurable PsySH settings and their current values.', + ]); + } + + protected function execute(InputInterface $input, OutputInterface $output): int + { + $table = $this->getTable($output); + + foreach ($this->getOptions() as $option) { + $table->addRow([ + $this->formatOptionName($option['name']), + $this->formatValue($option['getter']()), + ]); + } + + $table->render(); + + return 0; + } +} diff --git a/app/vendor/psy/psysh/src/Command/Config/ConfigSetCommand.php b/app/vendor/psy/psysh/src/Command/Config/ConfigSetCommand.php new file mode 100644 index 000000000..ceb8a3063 --- /dev/null +++ b/app/vendor/psy/psysh/src/Command/Config/ConfigSetCommand.php @@ -0,0 +1,134 @@ +setName('config-set') + ->setDefinition([ + new InputArgument('key', InputArgument::OPTIONAL, 'Runtime-configurable option to update.'), + new CodeArgument('value', CodeArgument::OPTIONAL, 'New runtime value for the selected option.'), + ]) + ->setDescription('Update one runtime-configurable PsySH setting for the current session.'); + } + + public function asText(): string + { + return \implode("\n", [ + 'Usage:', + ' config set \\ \\', + '', + 'Help:', + ' Set a runtime-configurable PsySH setting for the current session.', + '', + 'Examples:', + ' >>> config set verbosity debug', + ' >>> config set pager off', + ' >>> config set \\ --help', + '', + 'Supported Options:', + $this->renderSettableKeys(), + ]); + } + + public function asTextForInput(InputInterface $input): string + { + $key = $input->getArgument('key'); + + if ($key === null) { + return $this->asText(); + } + + $option = $this->getOption((string) $key); + + if ($option === null) { + return $this->asText(); + } + + return \implode("\n", [ + 'Usage:', + \sprintf(' config set %s \\', $option['name']), + '', + 'Help:', + \sprintf(' Set %s for the current session.', $this->formatOptionName($option['name'])), + '', + 'Accepted Values:', + ' '.$this->formatAcceptedValues($option), + '', + 'Current Value:', + ' '.$this->formatValue($option['getter']()), + ]); + } + + protected function execute(InputInterface $input, OutputInterface $output): int + { + $key = $input->getArgument('key'); + if ($key === null) { + throw new \InvalidArgumentException('Please specify a runtime-configurable option to update.'); + } + + $option = $this->getOption($key); + if ($option === null) { + $output->writeln(\sprintf('%s', $this->unsupportedMessage((string) $key))); + + return 1; + } + + $rawValue = $input->getArgument('value'); + if ($rawValue === null) { + throw new \InvalidArgumentException(\sprintf('Please specify a value for `%s`. Accepted values: %s', $option['name'], $this->formatAcceptedValues($option))); + } + + try { + $value = $option['parser']((string) $rawValue); + $changed = $option['setter']($value); + } catch (\InvalidArgumentException $e) { + $output->writeln(\sprintf('%s', $e->getMessage())); + + return 1; + } + + if ($option['refresh'] && $changed !== false) { + $this->getShell()->applyRuntimeConfigChange($option['name']); + } + + $output->writeln(\sprintf( + '%s = %s', + $option['name'], + $this->formatValue($option['getter']()) + )); + + return 0; + } + + private function renderSettableKeys(): string + { + $lines = []; + + foreach ($this->getOptions() as $option) { + $lines[] = \sprintf(' %s (%s)', $this->formatOptionName($option['name']), $this->formatAcceptedValues($option)); + } + + return \implode("\n", $lines); + } +} diff --git a/app/vendor/psy/psysh/src/Command/ConfigCommand.php b/app/vendor/psy/psysh/src/Command/ConfigCommand.php new file mode 100644 index 000000000..2ef9c196d --- /dev/null +++ b/app/vendor/psy/psysh/src/Command/ConfigCommand.php @@ -0,0 +1,377 @@ +defaultHelp = \implode("\n", [ + 'Inspect or update runtime-configurable PsySH settings for the current session.', + '', + 'e.g.', + '>>> config list', + '>>> config get verbosity', + '>>> config set verbosity debug', + '>>> config set pager off', + '>>> config set clipboardCommand auto', + '', + 'Runtime-configurable keys include '.$this->formatOptionNames([ + 'verbosity', + 'useUnicode', + 'errorLoggingLevel', + 'clipboardCommand', + 'useOsc52Clipboard', + 'colorMode', + 'theme', + 'pager', + 'requireSemicolons', + 'semicolonsSuppressReturn', + 'useBracketedPaste', + 'useSyntaxHighlighting', + 'useSuggestions', + ]).'.', + ]); + + $this + ->setName('config') + ->setDefinition([ + new InputArgument('action', InputArgument::OPTIONAL, 'Action: list, get, or set.', 'list'), + new InputArgument('key', InputArgument::OPTIONAL, 'Runtime-configurable option to inspect or update.'), + new CodeArgument('value', CodeArgument::OPTIONAL, 'New value when using `set`.'), + ]) + ->setDescription('Inspect or update runtime-configurable PsySH settings for the current session.') + ->setHelp($this->defaultHelp); + } + + public function run(InputInterface $input, OutputInterface $output): int + { + if ($input->hasParameterOption(['--help', '-h'], true)) { + $output->writeln($this->asTextForInput($input)); + + return 0; + } + + return parent::run($input, $output); + } + + public function asTextForInput(InputInterface $input): string + { + $action = $this->getActionFromInput($input); + + if ($action === '') { + return $this->asText(); + } + + $command = $this->createChildCommand($action); + + if ($command === null) { + return $this->asText(); + } + + return $command->asTextForInput($this->createChildInput($command, $action, $this->rawArguments($input))); + } + + public function getArgumentCompletions(AnalysisResult $analysis): array + { + return $this->resolveArgumentCompletion($analysis)['completions']; + } + + public function supportsArgumentCompletion(AnalysisResult $analysis): bool + { + return $this->resolveArgumentCompletion($analysis)['supported']; + } + + protected function execute(InputInterface $input, OutputInterface $output): int + { + $action = \strtolower((string) $input->getArgument('action')); + $command = $this->createChildCommand($action); + + if ($command === null) { + throw new \InvalidArgumentException(\sprintf('Unknown config action: %s. Expected list, get, or set.', $action)); + } + + return $command->run($this->createChildInput($command, $action, [ + $action, + (string) $input->getArgument('key'), + (string) $input->getArgument('value'), + ]), $output); + } + + /** + * @param string[] $arguments + */ + private function createChildInput(Command $command, string $action, array $arguments): ArrayInput + { + $parameters = []; + + switch ($action) { + case 'get': + if (isset($arguments[1]) && $arguments[1] !== '') { + $parameters['key'] = $arguments[1]; + } + break; + + case 'set': + if (isset($arguments[1]) && $arguments[1] !== '') { + $parameters['key'] = $arguments[1]; + } + if (isset($arguments[2]) && $arguments[2] !== '') { + $parameters['value'] = $arguments[2]; + } + break; + } + + $input = new ArrayInput($parameters, $command->getDefinition()); + $input->setInteractive(false); + + return $input; + } + + private function createChildCommand(string $action): ?Command + { + switch ($action) { + case '': + case 'list': + $command = new ConfigListCommand(); + break; + + case 'get': + $command = new ConfigGetCommand(); + break; + + case 'set': + $command = new ConfigSetCommand(); + break; + + default: + return null; + } + + $command->setConfiguration($this->getConfig()); + $command->setApplication($this->getApplication()); + + return $command; + } + + private function getActionFromInput(InputInterface $input): string + { + $arguments = $this->rawArguments($input); + + return \strtolower($arguments[0] ?? ''); + } + + /** + * Extract positional arguments from the raw input string. + * + * Symfony's Input classes don't expose raw tokens after parsing, so we + * re-tokenize __toString() output to recover them for child command routing. + * + * @return string[] + */ + private function rawArguments(InputInterface $input): array + { + if (!$input instanceof ArrayInput && !$input instanceof StringInput) { + return []; + } + + return $this->tokenizeArguments($input->__toString()); + } + + /** + * @return array{0: string[], 1: bool} + */ + private function parseCompletionInput(string $input): array + { + $trimmed = \rtrim($input); + + return [$this->tokenizeArguments($trimmed), $trimmed !== $input]; + } + + /** + * Tokenize an input string into positional arguments, skipping options. + * + * @return string[] + */ + private function tokenizeArguments(string $input): array + { + if ($input === '') { + return []; + } + + \preg_match_all('/"[^"]*"|\'[^\']*\'|\S+/', $input, $matches); + + $arguments = []; + + foreach ($matches[0] as $token) { + if ($token === '--') { + break; + } + + if ($token !== '' && $token[0] === '-') { + continue; + } + + $arguments[] = $this->trimQuotes($token); + } + + $first = $arguments[0] ?? null; + if ($first === $this->getName() || \in_array($first, $this->getAliases(), true)) { + \array_shift($arguments); + } + + return $arguments; + } + + /** + * @param string[] $arguments + */ + private function isCompletingSetValue(array $arguments, bool $hasTrailingSpace): bool + { + $count = \count($arguments); + + if ($count < 2 || $count > 3) { + return false; + } + + return ($count === 2 && $hasTrailingSpace) || ($count === 3 && !$hasTrailingSpace); + } + + /** + * @return array{supported: bool, completions: string[]} + */ + private function resolveArgumentCompletion(AnalysisResult $analysis): array + { + if ($this->lastCompletionResult !== null && $this->lastCompletionInput === $analysis->input) { + return $this->lastCompletionResult; + } + + $this->lastCompletionInput = $analysis->input; + + return $this->lastCompletionResult = $this->doResolveArgumentCompletion($analysis->input); + } + + /** + * @return array{supported: bool, completions: string[]} + */ + private function doResolveArgumentCompletion(string $input): array + { + [$arguments, $hasTrailingSpace] = $this->parseCompletionInput($input); + $count = \count($arguments); + $action = \strtolower($arguments[0] ?? ''); + + if ($count === 0 || ($count === 1 && !$hasTrailingSpace)) { + return ['supported' => true, 'completions' => self::ACTIONS]; + } + + switch ($action) { + case 'list': + return ['supported' => true, 'completions' => []]; + + case 'get': + case 'set': + // Completing the key name (cursor on or just after argument position 2) + if ($count <= 2 && ($count === 1 || !$hasTrailingSpace)) { + return ['supported' => true, 'completions' => $this->getOptionNames()]; + } + + if ($action !== 'set') { + return ['supported' => true, 'completions' => []]; + } + + if (!$this->isCompletingSetValue($arguments, $hasTrailingSpace)) { + return ['supported' => true, 'completions' => []]; + } + + return $this->resolveSetValueCompletion($arguments, $hasTrailingSpace); + + default: + return ['supported' => true, 'completions' => self::ACTIONS]; + } + } + + /** + * @param string[] $arguments + * + * @return array{supported: bool, completions: string[]} + */ + private function resolveSetValueCompletion(array $arguments, bool $hasTrailingSpace): array + { + $key = $arguments[1]; + $option = $this->getOption($key); + if ($option === null) { + return ['supported' => false, 'completions' => []]; + } + + $acceptsFreeForm = false; + $completions = []; + foreach ($option['acceptedValues'] as $value) { + if ($value !== '' && $value[0] === '<') { + $acceptsFreeForm = true; + } else { + $completions[] = $value; + } + } + + if (!$acceptsFreeForm) { + return ['supported' => $completions !== [], 'completions' => $completions]; + } + + $valuePrefix = $hasTrailingSpace ? '' : ($arguments[2] ?? ''); + + if ($valuePrefix === '') { + return ['supported' => $completions !== [], 'completions' => $completions]; + } + + if (FuzzyMatcher::filter($valuePrefix, $completions) !== []) { + return ['supported' => true, 'completions' => $completions]; + } + + return ['supported' => false, 'completions' => []]; + } + + private function trimQuotes(string $token): string + { + $quote = $token[0] ?? ''; + + if (($quote === '"' || $quote === '\'') && \substr($token, -1) === $quote) { + return \substr($token, 1, -1); + } + + return $token; + } +} diff --git a/app/vendor/psy/psysh/src/Command/CopyCommand.php b/app/vendor/psy/psysh/src/Command/CopyCommand.php new file mode 100644 index 000000000..274d86fbc --- /dev/null +++ b/app/vendor/psy/psysh/src/Command/CopyCommand.php @@ -0,0 +1,125 @@ +config = $config; + } + + /** + * {@inheritdoc} + */ + protected function configure(): void + { + $this + ->setName('copy') + ->setDefinition([ + new CodeArgument('expression', CodeArgument::OPTIONAL, 'Expression to copy.'), + ]) + ->setDescription('Copy a value to the clipboard.') + ->setHelp( + <<<'HELP' + Copy a value to the clipboard. + + When given: + - an expression, copy the exported value of the expression to the clipboard. + - no arguments, copy the last evaluated result ($_) to the clipboard. + + e.g. + >>> copy new Foo() + >>> copy User::all()->toArray() + >>> copy + HELP + ); + } + + /** + * {@inheritdoc} + * + * @return int 0 if everything went fine, or an exit code + */ + protected function execute(InputInterface $input, OutputInterface $output): int + { + $expression = $input->getArgument('expression'); + $value = $expression === null ? $this->context->get('_') : $this->resolveCode($expression); + + if (\is_object($value)) { + $this->setCommandScopeVariables(new \ReflectionObject($value)); + } + + if (!$this->getClipboardMethod()->copy($this->exportValue($value, $output), $output)) { + $output->writeln('Unable to copy value to clipboard.'); + + return 1; + } + + $output->writeln('Copied to clipboard.'); + + return 0; + } + + private function getClipboardMethod(): ClipboardMethod + { + return $this->config ? $this->config->getClipboard() : new NullClipboardMethod(false); + } + + private function exportValue($value, OutputInterface $output): string + { + $export = ''; + $warnings = []; + \set_error_handler(static function (int $errno, string $errstr) use (&$warnings): bool { + $warnings[$errstr] = true; + + return true; + }); + + try { + $export = (string) \var_export($value, true); + } finally { + \restore_error_handler(); + } + + foreach (\array_keys($warnings) as $warning) { + if ($warning === 'var_export does not handle circular references') { + $output->writeln('Value contains circular references; copied export may be incomplete.'); + + break; + } + + $output->writeln(\sprintf('%s', $warning)); + + break; + } + + return $export; + } +} diff --git a/app/vendor/psy/psysh/src/Command/DocCommand.php b/app/vendor/psy/psysh/src/Command/DocCommand.php index 77343dd01..8e451ad28 100644 --- a/app/vendor/psy/psysh/src/Command/DocCommand.php +++ b/app/vendor/psy/psysh/src/Command/DocCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,12 +11,18 @@ namespace Psy\Command; +use Psy\Configuration; use Psy\Formatter\DocblockFormatter; +use Psy\Formatter\ManualFormatter; use Psy\Formatter\SignatureFormatter; use Psy\Input\CodeArgument; -use Psy\Output\ShellOutput; +use Psy\ManualUpdater\ManualUpdate; use Psy\Reflection\ReflectionConstant; use Psy\Reflection\ReflectionLanguageConstruct; +use Psy\Util\Tty; +use Symfony\Component\Console\Exception\RuntimeException; +use Symfony\Component\Console\Input\ArrayInput; +use Symfony\Component\Console\Input\InputDefinition; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; @@ -28,17 +34,30 @@ class DocCommand extends ReflectingCommand { const INHERIT_DOC_TAG = '{@inheritdoc}'; + private ?Configuration $config = null; + + /** + * Set the configuration instance. + * + * @param \Psy\Configuration $config + */ + public function setConfiguration(Configuration $config) + { + $this->config = $config; + } + /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('doc') ->setAliases(['rtfm', 'man']) ->setDefinition([ new InputOption('all', 'a', InputOption::VALUE_NONE, 'Show documentation for superclasses as well as the current class.'), - new CodeArgument('target', CodeArgument::REQUIRED, 'Function, class, instance, constant, method or property to document.'), + new InputOption('update-manual', null, InputOption::VALUE_OPTIONAL, 'Download and install the latest PHP manual (optional language code)', false), + new CodeArgument('target', CodeArgument::OPTIONAL, 'Function, class, instance, constant, method or property to document.'), ]) ->setDescription('Read the documentation for an object, class, constant, method or property.') ->setHelp( @@ -53,6 +72,8 @@ protected function configure() >>> doc Psy\Shell::debug >>> \$s = new Psy\Shell >>> doc \$s->run +>>> doc --update-manual +>>> doc --update-manual=fr HELP ); } @@ -64,20 +85,28 @@ protected function configure() */ protected function execute(InputInterface $input, OutputInterface $output): int { + $shellOutput = $this->shellOutput($output); + + if ($input->getOption('update-manual') !== false) { + return $this->handleUpdateManual($input, $output); + } + $value = $input->getArgument('target'); + if (!$value) { + throw new RuntimeException('Not enough arguments (missing: "target").'); + } + if (ReflectionLanguageConstruct::isLanguageConstruct($value)) { $reflector = new ReflectionLanguageConstruct($value); $doc = $this->getManualDocById($value); } else { - list($target, $reflector) = $this->getTargetAndReflector($value); + list($target, $reflector) = $this->getTargetAndReflector($value, $output); $doc = $this->getManualDoc($reflector) ?: DocblockFormatter::format($reflector); } - $db = $this->getShell()->getManualDb(); + $hasManual = $this->getShell()->getManual() !== null; - if ($output instanceof ShellOutput) { - $output->startPaging(); - } + $shellOutput->startPaging(); // Maybe include the declaring class if ($reflector instanceof \ReflectionMethod || $reflector instanceof \ReflectionProperty) { @@ -87,16 +116,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int $output->writeln(SignatureFormatter::format($reflector)); $output->writeln(''); - if (empty($doc) && !$db) { + if (empty($doc) && !$hasManual) { $output->writeln('PHP manual not found'); $output->writeln(' To document core PHP functionality, download the PHP reference manual:'); $output->writeln(' https://github.com/bobthecow/psysh/wiki/PHP-manual'); - } else { + } elseif ($doc !== null) { $output->writeln($doc); } // Implicit --all if the original docblock has an {@inheritdoc} tag. - if ($input->getOption('all') || \stripos($doc, self::INHERIT_DOC_TAG) !== false) { + if ($input->getOption('all') || ($doc && \stripos($doc, self::INHERIT_DOC_TAG) !== false)) { $parent = $reflector; foreach ($this->getParentReflectors($reflector) as $parent) { $output->writeln(''); @@ -117,9 +146,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int } } - if ($output instanceof ShellOutput) { - $output->stopPaging(); - } + $shellOutput->stopPaging(); // Set some magic local variables $this->setCommandScopeVariables($reflector); @@ -127,6 +154,51 @@ protected function execute(InputInterface $input, OutputInterface $output): int return 0; } + /** + * Handle the manual update operation. + * + * @param InputInterface $input + * @param OutputInterface $output + * + * @return int 0 if everything went fine, or an exit code + */ + private function handleUpdateManual(InputInterface $input, OutputInterface $output): int + { + if (!$this->config) { + $output->writeln('Configuration not available for manual updates.'); + + return 1; + } + + // Create a synthetic input with the update-manual option + $definition = new InputDefinition([ + new InputOption('update-manual', null, InputOption::VALUE_OPTIONAL, '', false), + ]); + + // Get the language value: if true (no value), use null to preserve current language + $lang = $input->getOption('update-manual'); + $updateValue = ($lang === true) ? null : $lang; + + $updateInput = new ArrayInput(['--update-manual' => $updateValue], $definition); + $updateInput->setInteractive($input->isInteractive()); + + try { + $manualUpdate = ManualUpdate::fromConfig($this->config, $updateInput, $output); + $result = $manualUpdate->run($updateInput, $output); + + if ($result === 0) { + $output->writeln(''); + $output->writeln('Restart PsySH to use the updated manual.'); + } + + return $result; + } catch (\RuntimeException $e) { + $output->writeln(\sprintf('%s', $e->getMessage())); + + return 1; + } + } + private function getManualDoc($reflector) { switch (\get_class($reflector)) { @@ -242,11 +314,23 @@ private function getParentReflectors($reflector): \Generator private function getManualDocById($id) { - if ($db = $this->getShell()->getManualDb()) { - $result = $db->query(\sprintf('SELECT doc FROM php_manual WHERE id = %s', $db->quote($id))); - if ($result !== false) { - return $result->fetchColumn(0); + if ($manual = $this->getShell()->getManual()) { + switch ($manual->getVersion()) { + case 2: + // v2 manual docs are pre-formatted and should be rendered as-is + return $manual->get($id); + + case 3: + if ($doc = $manual->get($id)) { + $width = Tty::getWidth(); + $formatter = new ManualFormatter($width, $manual); + + return $formatter->format($doc); + } + break; } } + + return null; } } diff --git a/app/vendor/psy/psysh/src/Command/DumpCommand.php b/app/vendor/psy/psysh/src/Command/DumpCommand.php index 145851d0f..8e3127d2b 100644 --- a/app/vendor/psy/psysh/src/Command/DumpCommand.php +++ b/app/vendor/psy/psysh/src/Command/DumpCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,9 +11,7 @@ namespace Psy\Command; -use Psy\Exception\RuntimeException; use Psy\Input\CodeArgument; -use Psy\Output\ShellOutput; use Psy\VarDumper\Presenter; use Psy\VarDumper\PresenterAware; use Symfony\Component\Console\Input\InputInterface; @@ -42,7 +40,7 @@ public function setPresenter(Presenter $presenter) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('dump') @@ -73,13 +71,9 @@ protected function configure() */ protected function execute(InputInterface $input, OutputInterface $output): int { - if (!$output instanceof ShellOutput) { - throw new RuntimeException('DumpCommand requires a ShellOutput'); - } - $depth = $input->getOption('depth'); $target = $this->resolveCode($input->getArgument('target')); - $output->page($this->presenter->present($target, $depth, $input->getOption('all') ? Presenter::VERBOSE : 0)); + $this->shellOutput($output)->page($this->presenter->present($target, $depth, ($input->getOption('all') ? Presenter::VERBOSE : 0) | Presenter::RAW), OutputInterface::OUTPUT_RAW); if (\is_object($target)) { $this->setCommandScopeVariables(new \ReflectionObject($target)); diff --git a/app/vendor/psy/psysh/src/Command/EditCommand.php b/app/vendor/psy/psysh/src/Command/EditCommand.php index 7fbb78c1b..36ee2cac5 100644 --- a/app/vendor/psy/psysh/src/Command/EditCommand.php +++ b/app/vendor/psy/psysh/src/Command/EditCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -14,6 +14,7 @@ use Psy\ConfigPaths; use Psy\Context; use Psy\ContextAware; +use Psy\Util\Tty; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; @@ -39,7 +40,7 @@ public function __construct($runtimeDir, $name = null) $this->runtimeDir = $runtimeDir; } - protected function configure() + protected function configure(): void { $this ->setName('edit') @@ -154,9 +155,41 @@ private function editFile(string $filePath, bool $shouldRemoveFile): string $escapedFilePath = \escapeshellarg($filePath); $editor = (isset($_SERVER['EDITOR']) && $_SERVER['EDITOR']) ? $_SERVER['EDITOR'] : 'nano'; + // Enable signal characters so Ctrl-C can interrupt the editor. + // PsySH's interactive readline disables isig at the prompt, but + // the editor needs it to handle signals properly. + $originalStty = null; + if (Tty::supportsStty()) { + $originalStty = \trim((string) @\shell_exec('stty -g 2>/dev/null')); + @\shell_exec('stty isig 2>/dev/null'); + } + $pipes = []; $proc = \proc_open("{$editor} {$escapedFilePath}", [\STDIN, \STDOUT, \STDERR], $pipes); - \proc_close($proc); + + // Ignore SIGINT in PsySH while the editor is running. The editor + // handles ctrl-c itself; we just need to not die when the signal + // is delivered to our process group. Set this after proc_open so + // the editor inherits default signal handling. + if (\function_exists('pcntl_signal')) { + \pcntl_signal(\SIGINT, \SIG_IGN); + } + + try { + \proc_close($proc); + } finally { + if (\function_exists('pcntl_signal')) { + \pcntl_signal(\SIGINT, \SIG_DFL); + } + + if ($originalStty === null) { + // nothing to restore + } elseif ($originalStty === '') { + @\shell_exec('stty -isig 2>/dev/null'); + } else { + @\shell_exec('stty '.\escapeshellarg($originalStty).' 2>/dev/null'); + } + } $editedContent = @\file_get_contents($filePath); diff --git a/app/vendor/psy/psysh/src/Command/ExitCommand.php b/app/vendor/psy/psysh/src/Command/ExitCommand.php index 6552e288a..da8160be1 100644 --- a/app/vendor/psy/psysh/src/Command/ExitCommand.php +++ b/app/vendor/psy/psysh/src/Command/ExitCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -25,7 +25,7 @@ class ExitCommand extends Command /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('exit') diff --git a/app/vendor/psy/psysh/src/Command/HelpCommand.php b/app/vendor/psy/psysh/src/Command/HelpCommand.php index c7296f49d..4404cdd6c 100644 --- a/app/vendor/psy/psysh/src/Command/HelpCommand.php +++ b/app/vendor/psy/psysh/src/Command/HelpCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,7 +11,10 @@ namespace Psy\Command; -use Psy\Output\ShellOutput; +use Psy\Formatter\ManualWrapper; +use Psy\Readline\Interactive\Layout\DisplayString; +use Psy\Util\Tty; +use Symfony\Component\Console\Exception\CommandNotFoundException; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; @@ -23,12 +26,17 @@ */ class HelpCommand extends Command { + private const TABLE_OVERHEAD_TWO_COLUMNS = 7; + private const TABLE_OVERHEAD_THREE_COLUMNS = 10; + private const MIN_DESCRIPTION_WIDTH_FOR_ALIAS_COLUMN = 40; + private ?Command $command = null; + private ?InputInterface $commandInput = null; /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('help') @@ -50,6 +58,14 @@ public function setCommand(Command $command) $this->command = $command; } + /** + * Helper for preserving the original input when rendering contextual help. + */ + public function setCommandInput(InputInterface $input): void + { + $this->commandInput = $input; + } + /** * {@inheritdoc} * @@ -57,48 +73,116 @@ public function setCommand(Command $command) */ protected function execute(InputInterface $input, OutputInterface $output): int { + $shellOutput = $this->shellOutput($output); + if ($this->command !== null) { // help for an individual command - $output->page($this->command->asText()); + $shellOutput->page($this->command->asTextForInput($this->commandInput ?? $input)); $this->command = null; + $this->commandInput = null; } elseif ($name = $input->getArgument('command_name')) { // help for an individual command - $output->page($this->getApplication()->get($name)->asText()); + try { + $cmd = $this->getApplication()->get($name); + } catch (CommandNotFoundException $e) { + $this->getShell()->writeException($e); + $output->writeln(''); + $output->writeln(\sprintf( + '', + $name + )); + $output->writeln(''); + + return 1; + } + + if (!$cmd instanceof Command) { + throw new \RuntimeException(\sprintf('Expected Psy\Command\Command instance, got %s', \get_class($cmd))); + } + + $shellOutput->page($cmd->asTextForInput($input)); } else { - // list available commands - $commands = $this->getApplication()->all(); + $this->commandInput = null; + $shellOutput->page(function (OutputInterface $pagedOutput): void { + $this->renderCommandList($pagedOutput); + }); + } - $table = $this->getTable($output); + return 0; + } - foreach ($commands as $name => $command) { - if ($name !== $command->getName()) { - continue; - } + /** + * Render the top-level command list with fixed command widths and a + * conditional alias column when the terminal is wide enough. + */ + private function renderCommandList(OutputInterface $output): void + { + $commands = []; + + foreach ($this->getApplication()->all() as $name => $command) { + if ($name !== $command->getName()) { + continue; + } + + $commands[] = [ + 'name' => $name, + 'description' => $command->getDescription(), + 'aliasText' => $command->getAliases() + ? \sprintf('Aliases: %s', \implode(', ', $command->getAliases())) + : '', + ]; + } + + $nameWidth = 0; + $aliasWidth = 0; + $descriptionWidth = 0; + $formatter = $output->getFormatter(); + foreach ($commands as $command) { + $nameWidth = \max($nameWidth, DisplayString::width($command['name'])); + $aliasWidth = \max($aliasWidth, DisplayString::widthWithoutFormatting($command['aliasText'], $formatter)); + $descriptionWidth = \max($descriptionWidth, DisplayString::width($command['description'])); + } + + $terminalWidth = Tty::getWidth(); + $wrapper = new ManualWrapper(); + $table = $this->getTable($output)->setColumnWidth(0, $nameWidth); + $descriptionWidthWithAliasColumn = $terminalWidth - $nameWidth - $aliasWidth - self::TABLE_OVERHEAD_THREE_COLUMNS; - if ($command->getAliases()) { - $aliases = \sprintf('Aliases: %s', \implode(', ', $command->getAliases())); - } else { - $aliases = ''; - } + if ($aliasWidth > 0 && $descriptionWidthWithAliasColumn >= self::MIN_DESCRIPTION_WIDTH_FOR_ALIAS_COLUMN) { + $descriptionColumnWidth = \min($descriptionWidth, $descriptionWidthWithAliasColumn); + $table + ->setColumnWidth(1, $descriptionColumnWidth) + ->setColumnWidth(2, $aliasWidth); + + foreach ($commands as $command) { $table->addRow([ - \sprintf('%s', $name), - $command->getDescription(), - $aliases, + \sprintf('%s', $command['name']), + $wrapper->wrap($command['description'], $descriptionColumnWidth), + $command['aliasText'], ]); } - if ($output instanceof ShellOutput) { - $output->startPaging(); - } - $table->render(); - if ($output instanceof ShellOutput) { - $output->stopPaging(); + return; + } + + $detailsWidth = \max(10, $terminalWidth - $nameWidth - self::TABLE_OVERHEAD_TWO_COLUMNS); + $table->setColumnWidth(1, $detailsWidth); + + foreach ($commands as $command) { + $details = $wrapper->wrap($command['description'], $detailsWidth); + if ($command['aliasText'] !== '') { + $details .= "\n".$wrapper->wrap($command['aliasText'], $detailsWidth); } + + $table->addRow([ + \sprintf('%s', $command['name']), + $details, + ]); } - return 0; + $table->render(); } } diff --git a/app/vendor/psy/psysh/src/Command/HistoryCommand.php b/app/vendor/psy/psysh/src/Command/HistoryCommand.php index b40595939..ee83ce5cc 100644 --- a/app/vendor/psy/psysh/src/Command/HistoryCommand.php +++ b/app/vendor/psy/psysh/src/Command/HistoryCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,9 +11,11 @@ namespace Psy\Command; +use Psy\ConfigPaths; use Psy\Input\FilterOptions; -use Psy\Output\ShellOutput; +use Psy\Output\ShellOutputAdapter; use Psy\Readline\Readline; +use Psy\Readline\ReadlineAware; use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; @@ -24,7 +26,7 @@ * * Shows, searches and replays readline history. Not too shabby. */ -class HistoryCommand extends Command +class HistoryCommand extends Command implements ReadlineAware { private FilterOptions $filter; private Readline $readline; @@ -52,7 +54,7 @@ public function setReadline(Readline $readline) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { list($grep, $insensitive, $invert) = FilterOptions::getOptions(); @@ -98,11 +100,14 @@ protected function execute(InputInterface $input, OutputInterface $output): int $this->validateOnlyOne($input, ['show', 'head', 'tail']); $this->validateOnlyOne($input, ['save', 'replay', 'clear']); - $history = $this->getHistorySlice( - $input->getOption('show'), - $input->getOption('head'), - $input->getOption('tail') - ); + // For --show, slice first (uses original line numbers), then filter + $show = $input->getOption('show'); + + // For --head/--tail, filter first, then slice (uses result count) + $head = $input->getOption('head'); + $tail = $input->getOption('tail'); + + $history = $this->getHistorySlice($show); $highlighted = false; $this->filter->bind($input); @@ -120,12 +125,18 @@ protected function execute(InputInterface $input, OutputInterface $output): int } } else { unset($history[$i]); + unset($highlighted[$i]); } } } + $history = $this->applyHeadOrTail($history, $head, $tail); + if ($highlighted) { + $highlighted = $this->applyHeadOrTail($highlighted, $head, $tail); + } + if ($save = $input->getOption('save')) { - $output->writeln(\sprintf('Saving history in %s...', $save)); + $output->writeln(\sprintf('Saving history in %s...', ConfigPaths::prettyPath($save))); \file_put_contents($save, \implode(\PHP_EOL, $history).\PHP_EOL); $output->writeln('History saved.'); } elseif ($input->getOption('replay')) { @@ -141,12 +152,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int $this->clearHistory(); $output->writeln('History cleared.'); } else { - $type = $input->getOption('no-numbers') ? 0 : ShellOutput::NUMBER_LINES; + $type = $input->getOption('no-numbers') ? 0 : ShellOutputAdapter::NUMBER_LINES; if (!$highlighted) { $type = $type | OutputInterface::OUTPUT_RAW; } - $output->page($highlighted ?: $history, $type); + $this->shellOutput($output)->page($highlighted ?: $history, $type); } return 0; @@ -177,31 +188,39 @@ private function extractRange(string $range): array } /** - * Retrieve a slice of the readline history. + * Retrieve a slice of the readline history by range. * - * @param string|null $show - * @param string|null $head - * @param string|null $tail + * @param string|null $show Range specification (e.g., "5..10") * * @return array A slice of history */ - private function getHistorySlice($show, $head, $tail): array + private function getHistorySlice(?string $show): array { $history = $this->readline->listHistory(); - // don't show the current `history` invocation \array_pop($history); - if ($show) { - list($start, $end) = $this->extractRange($show); - $length = $end - $start; - } elseif ($head) { + if ($show === null) { + return $history; + } + + list($start, $end) = $this->extractRange($show); + $length = $end - $start; + + return \array_slice($history, $start, $length, true); + } + + /** + * Apply --head or --tail to a history array. + */ + private function applyHeadOrTail(array $history, ?string $head, ?string $tail): array + { + if ($head) { if (!\preg_match('/^\d+$/', $head)) { throw new \InvalidArgumentException('Please specify an integer argument for --head'); } - $start = 0; - $length = (int) $head; + return \array_slice($history, 0, (int) $head, true); } elseif ($tail) { if (!\preg_match('/^\d+$/', $tail)) { throw new \InvalidArgumentException('Please specify an integer argument for --tail'); @@ -209,11 +228,11 @@ private function getHistorySlice($show, $head, $tail): array $start = \count($history) - (int) $tail; $length = (int) $tail + 1; - } else { - return $history; + + return \array_slice($history, $start, $length, true); } - return \array_slice($history, $start, $length, true); + return $history; } /** diff --git a/app/vendor/psy/psysh/src/Command/ListCommand.php b/app/vendor/psy/psysh/src/Command/ListCommand.php index 4f084f5b1..28c7bda43 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -22,7 +22,6 @@ use Psy\Exception\RuntimeException; use Psy\Input\CodeArgument; use Psy\Input\FilterOptions; -use Psy\Output\ShellOutput; use Psy\VarDumper\Presenter; use Psy\VarDumper\PresenterAware; use Symfony\Component\Console\Formatter\OutputFormatter; @@ -51,7 +50,7 @@ public function setPresenter(Presenter $presenter) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { list($grep, $insensitive, $invert) = FilterOptions::getOptions(); @@ -118,26 +117,26 @@ protected function execute(InputInterface $input, OutputInterface $output): int { $this->validateInput($input); $this->initEnumerators(); + $shellOutput = $this->shellOutput($output); $method = $input->getOption('long') ? 'writeLong' : 'write'; if ($target = $input->getArgument('target')) { - list($target, $reflector) = $this->getTargetAndReflector($target); + list($target, $reflector) = $this->getTargetAndReflector($target, $output); } else { $reflector = null; } - // @todo something cleaner than this :-/ - if ($output instanceof ShellOutput && $input->getOption('long')) { - $output->startPaging(); + if ($input->getOption('long')) { + $shellOutput->startPaging(); } foreach ($this->enumerators as $enumerator) { $this->$method($output, $enumerator->enumerate($input, $reflector, $target)); } - if ($output instanceof ShellOutput && $input->getOption('long')) { - $output->stopPaging(); + if ($input->getOption('long')) { + $shellOutput->stopPaging(); } // Set some magic local variables @@ -181,9 +180,18 @@ protected function write(OutputInterface $output, array $result) return; } + $formatter = $output->getFormatter(); + foreach ($result as $label => $items) { - $names = \array_map([$this, 'formatItemName'], $items); - $output->writeln(\sprintf('%s: %s', $label, \implode(', ', $names))); + // Pre-format each item individually to avoid O(n^2) performance + // in Symfony's OutputFormatter when processing large strings with many style tags. + $names = \array_map(fn ($item) => $formatter->format($this->formatItemName($item)), $items); + + // Pre-format the label and join with pre-formatted names + $line = $formatter->format(\sprintf('%s: ', $label)).\implode(', ', $names); + + // Write raw since we've already formatted everything + $output->writeln($line, OutputInterface::OUTPUT_RAW); } } @@ -202,9 +210,12 @@ protected function writeLong(OutputInterface $output, array $result) } $table = $this->getTable($output); + $first = true; foreach ($result as $label => $items) { - $output->writeln(''); + if (!$first) { + $output->writeln(''); + } $output->writeln(\sprintf('%s:', $label)); $table->setRows([]); @@ -213,6 +224,7 @@ protected function writeLong(OutputInterface $output, array $result) } $table->render(); + $first = false; } } diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/ClassConstantEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/ClassConstantEnumerator.php index 9bc56748f..acae296f2 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/ClassConstantEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/ClassConstantEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/ClassEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/ClassEnumerator.php index b0edf0353..08e9b9630 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/ClassEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/ClassEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -58,11 +58,11 @@ protected function listItems(InputInterface $input, ?\Reflector $reflector = nul * If $internal or $user is defined, results will be limited to internal or * user-defined classes as appropriate. * - * @param string $key - * @param array $classes - * @param bool $internal - * @param bool $user - * @param string $prefix + * @param string $key + * @param array $classes + * @param bool $internal + * @param bool $user + * @param string|null $prefix * * @return array */ @@ -95,9 +95,7 @@ protected function filterClasses(string $key, array $classes, bool $internal, bo } if (!$user && !$internal) { - $ret[$key] = \array_filter($classes, function ($class) use ($prefix) { - return $prefix === null || \strpos(\strtolower($class), $prefix) === 0; - }); + $ret[$key] = \array_filter($classes, fn ($class) => $prefix === null || \strpos(\strtolower($class), $prefix) === 0); } return $ret; diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/ConstantEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/ConstantEnumerator.php index c0f7c617d..2db9087b3 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/ConstantEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/ConstantEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -118,7 +118,7 @@ protected function listItems(InputInterface $input, ?\Reflector $reflector = nul * Optionally restrict constants to a given category, e.g. "date". If the * category is "internal", include all non-user-defined constants. * - * @param string $category + * @param string|null $category * * @return array */ @@ -132,8 +132,9 @@ protected function getConstants(?string $category = null): array if ($category === 'internal') { unset($consts['user']); + $values = \array_values($consts); - return \array_merge(...\array_values($consts)); + return $values ? \array_merge(...$values) : []; } foreach ($consts as $key => $value) { diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/Enumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/Enumerator.php index 4cc336c51..07a9a8921 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/Enumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/Enumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -15,6 +15,7 @@ use Psy\Input\FilterOptions; use Psy\Util\Mirror; use Psy\VarDumper\Presenter; +use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\Console\Input\InputInterface; /** @@ -30,6 +31,7 @@ abstract class Enumerator const IS_CONSTANT = 'const'; const IS_CLASS = 'class'; const IS_FUNCTION = 'function'; + const IS_VIRTUAL = 'virtual'; private FilterOptions $filter; private Presenter $presenter; @@ -91,6 +93,12 @@ protected function showItem($name) protected function presentRef($value) { + // Symfony VarDumper 5.4 trips over NAN/INF on PHP 8.5 in PHAR builds, + // so format non-finite floats directly instead of cloning them. + if (\is_float($value) && !\is_finite($value)) { + return OutputFormatter::escape(\sprintf('%s', \var_export($value, true))); + } + return $this->presenter->presentRef($value); } diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/FunctionEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/FunctionEnumerator.php index fe3891a59..640251415 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/FunctionEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/FunctionEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -81,8 +81,8 @@ protected function getFunctions(?string $type = null): array /** * Prepare formatted function array. * - * @param array $functions - * @param string $prefix + * @param array $functions + * @param string|null $prefix * * @return array */ diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/GlobalVariableEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/GlobalVariableEnumerator.php index 81be16e53..0348937ec 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/GlobalVariableEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/GlobalVariableEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/MethodEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/MethodEnumerator.php index e7b4503fd..ae4f4af7d 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/MethodEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/MethodEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,6 +11,8 @@ namespace Psy\Command\ListCommand; +use Psy\Reflection\ReflectionMagicMethod; +use Psy\Util\Docblock; use Symfony\Component\Console\Input\InputInterface; /** @@ -59,7 +61,7 @@ protected function listItems(InputInterface $input, ?\Reflector $reflector = nul * @param \ReflectionClass $reflector * @param bool $noInherit Exclude inherited methods * - * @return array + * @return \ReflectionMethod[] */ protected function getMethods(bool $showAll, \ReflectionClass $reflector, bool $noInherit = false): array { @@ -78,6 +80,18 @@ protected function getMethods(bool $showAll, \ReflectionClass $reflector, bool $ } } + // Add magic methods from docblock @method tags + foreach (Docblock::getMagicMethods($reflector) as $method) { + if ($noInherit && $method->getDeclaringClass()->getName() !== $className) { + continue; + } + + // Skip if a real method with this name already exists + if (!isset($methods[$method->getName()])) { + $methods[$method->getName()] = $method; + } + } + \ksort($methods, \SORT_NATURAL | \SORT_FLAG_CASE); return $methods; @@ -86,7 +100,7 @@ protected function getMethods(bool $showAll, \ReflectionClass $reflector, bool $ /** * Prepare formatted method array. * - * @param array $methods + * @param \ReflectionMethod[] $methods * * @return array */ @@ -127,10 +141,14 @@ protected function getKindLabel(\ReflectionClass $reflector): string /** * Get output style for the given method's visibility. * - * @param \ReflectionMethod $method + * @param \ReflectionMethod|ReflectionMagicMethod $method */ - private function getVisibilityStyle(\ReflectionMethod $method): string + private function getVisibilityStyle(\Reflector $method): string { + if ($method instanceof ReflectionMagicMethod) { + return self::IS_VIRTUAL; + } + if ($method->isPublic()) { return self::IS_PUBLIC; } elseif ($method->isProtected()) { diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/PropertyEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/PropertyEnumerator.php index fe4a4b81f..3a92abf6a 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/PropertyEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/PropertyEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,6 +11,8 @@ namespace Psy\Command\ListCommand; +use Psy\Reflection\ReflectionMagicProperty; +use Psy\Util\Docblock; use Symfony\Component\Console\Input\InputInterface; /** @@ -60,7 +62,7 @@ protected function listItems(InputInterface $input, ?\Reflector $reflector = nul * @param \ReflectionClass $reflector * @param bool $noInherit Exclude inherited properties * - * @return array + * @return \ReflectionProperty[] */ protected function getProperties(bool $showAll, \ReflectionClass $reflector, bool $noInherit = false): array { @@ -77,6 +79,18 @@ protected function getProperties(bool $showAll, \ReflectionClass $reflector, boo } } + // Add magic properties from docblock @property tags + foreach (Docblock::getMagicProperties($reflector) as $property) { + if ($noInherit && $property->getDeclaringClass()->getName() !== $className) { + continue; + } + + // Skip if a real property with this name already exists + if (!isset($properties[$property->getName()])) { + $properties[$property->getName()] = $property; + } + } + \ksort($properties, \SORT_NATURAL | \SORT_FLAG_CASE); return $properties; @@ -85,7 +99,7 @@ protected function getProperties(bool $showAll, \ReflectionClass $reflector, boo /** * Prepare formatted property array. * - * @param array $properties + * @param \ReflectionProperty[] $properties * * @return array */ @@ -125,10 +139,14 @@ protected function getKindLabel(\ReflectionClass $reflector): string /** * Get output style for the given property's visibility. * - * @param \ReflectionProperty $property + * @param \ReflectionProperty|ReflectionMagicProperty $property */ - private function getVisibilityStyle(\ReflectionProperty $property): string + private function getVisibilityStyle(\Reflector $property): string { + if ($property instanceof ReflectionMagicProperty) { + return self::IS_VIRTUAL; + } + if ($property->isPublic()) { return self::IS_PUBLIC; } elseif ($property->isProtected()) { @@ -141,11 +159,16 @@ private function getVisibilityStyle(\ReflectionProperty $property): string /** * Present the $target's current value for a reflection property. * - * @param \ReflectionProperty $property - * @param mixed $target + * @param \ReflectionProperty|ReflectionMagicProperty $property + * @param mixed $target */ - protected function presentValue(\ReflectionProperty $property, $target): string + protected function presentValue(\Reflector $property, $target): string { + // Magic properties use SignatureFormatter for display + if ($property instanceof ReflectionMagicProperty) { + return $this->presentSignature($property); + } + if (!$target) { return ''; } diff --git a/app/vendor/psy/psysh/src/Command/ListCommand/VariableEnumerator.php b/app/vendor/psy/psysh/src/Command/ListCommand/VariableEnumerator.php index 133a188d4..3a80d5f17 100644 --- a/app/vendor/psy/psysh/src/Command/ListCommand/VariableEnumerator.php +++ b/app/vendor/psy/psysh/src/Command/ListCommand/VariableEnumerator.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Command/ParseCommand.php b/app/vendor/psy/psysh/src/Command/ParseCommand.php index 550f42bfb..c37a65d96 100644 --- a/app/vendor/psy/psysh/src/Command/ParseCommand.php +++ b/app/vendor/psy/psysh/src/Command/ParseCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,6 +11,7 @@ namespace Psy\Command; +use PhpParser\Error as PhpParserError; use PhpParser\Node; use PhpParser\Parser; use Psy\Context; @@ -80,7 +81,7 @@ public function setPresenter(Presenter $presenter) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('parse') @@ -111,11 +112,31 @@ protected function execute(InputInterface $input, OutputInterface $output): int $code = $input->getArgument('code'); $depth = $input->getOption('depth'); - $nodes = $this->parser->parse($code); - $output->page($this->presenter->present($nodes, $depth)); + if (!\preg_match('/^\s*<\\?/', $code)) { + $code = 'parser->parse($code); + } catch (PhpParserError $e) { + if ($this->parseErrorIsEOF($e)) { + $nodes = $this->parser->parse($code.';'); + } else { + throw $e; + } + } + + $this->shellOutput($output)->page($this->presenter->present($nodes, $depth, Presenter::RAW), OutputInterface::OUTPUT_RAW); $this->context->setReturnValue($nodes); return 0; } + + private function parseErrorIsEOF(PhpParserError $e): bool + { + $msg = $e->getRawMessage(); + + return ($msg === 'Unexpected token EOF') || (\strpos($msg, 'Syntax error, unexpected EOF') !== false); + } } diff --git a/app/vendor/psy/psysh/src/Command/PsyVersionCommand.php b/app/vendor/psy/psysh/src/Command/PsyVersionCommand.php index 959a9a786..cbd9131d9 100644 --- a/app/vendor/psy/psysh/src/Command/PsyVersionCommand.php +++ b/app/vendor/psy/psysh/src/Command/PsyVersionCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -22,7 +22,7 @@ class PsyVersionCommand extends Command /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('version') diff --git a/app/vendor/psy/psysh/src/Command/ReflectingCommand.php b/app/vendor/psy/psysh/src/Command/ReflectingCommand.php index 6f055b7ac..2122ca29f 100644 --- a/app/vendor/psy/psysh/src/Command/ReflectingCommand.php +++ b/app/vendor/psy/psysh/src/Command/ReflectingCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -13,7 +13,9 @@ use PhpParser\NodeTraverser; use PhpParser\PrettyPrinter\Standard as Printer; +use Psy\CodeCleaner; use Psy\CodeCleaner\NoReturnValue; +use Psy\CodeCleanerAware; use Psy\Context; use Psy\ContextAware; use Psy\Exception\ErrorException; @@ -22,11 +24,15 @@ use Psy\Reflection\ReflectionConstant; use Psy\Sudo\SudoVisitor; use Psy\Util\Mirror; +use Psy\Util\Str; +use Symfony\Component\Console\Formatter\OutputFormatter; +use Symfony\Component\Console\Output\ConsoleOutput; +use Symfony\Component\Console\Output\OutputInterface; /** * An abstract command with helpers for inspecting the current context. */ -abstract class ReflectingCommand extends Command implements ContextAware +abstract class ReflectingCommand extends Command implements ContextAware, CodeCleanerAware { const CLASS_OR_FUNC = '/^[\\\\\w]+$/'; const CLASS_MEMBER = '/^([\\\\\w]+)::(\w+)$/'; @@ -34,6 +40,7 @@ abstract class ReflectingCommand extends Command implements ContextAware const INSTANCE_MEMBER = '/^(\$\w+)(::|->)(\w+)$/'; protected Context $context; + protected CodeCleaner $cleaner; private CodeArgumentParser $parser; private NodeTraverser $traverser; private Printer $printer; @@ -64,6 +71,14 @@ public function setContext(Context $context) $this->context = $context; } + /** + * CodeCleanerAware interface. + */ + public function setCodeCleaner(CodeCleaner $cleaner) + { + $this->cleaner = $cleaner; + } + /** * Get the target for a value. * @@ -131,12 +146,23 @@ protected function resolveName(string $name, bool $includeFunctions = false): st return $name; } - // Check $name against the current namespace and use statements. - if (self::couldBeClassName($name)) { + // Use CodeCleaner to resolve the name through use statements and namespace + if (Str::isValidClassName($name)) { + $resolved = $this->cleaner->resolveClassName($name); + + // If we got a different name back, use it + if ($resolved !== $name) { + return $resolved; + } + + // Fall back to the old resolveCode approach for edge cases try { - $name = $this->resolveCode($name.'::class'); + $resolved = $this->resolveCode($name.'::class'); + if ($resolved !== $name) { + return $resolved; + } } catch (RuntimeException $e) { - // /shrug + // Fall through to namespace check } } @@ -151,26 +177,23 @@ protected function resolveName(string $name, bool $includeFunctions = false): st return $name; } - /** - * Check whether a given name could be a class name. - */ - protected function couldBeClassName(string $name): bool - { - // Regex based on https://www.php.net/manual/en/language.oop5.basic.php#language.oop5.basic.class - return \preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*(\\\\[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*)*$/', $name) === 1; - } - /** * Get a Reflector and documentation for a function, class or instance, constant, method or property. * - * @param string $valueName Function, class, variable, constant, method or property name + * @param string $valueName Function, class, variable, constant, method or property name + * @param OutputInterface|null $output Optional output for displaying cleaner messages * * @return array (value, Reflector) */ - protected function getTargetAndReflector(string $valueName): array + protected function getTargetAndReflector(string $valueName, ?OutputInterface $output = null): array { list($value, $member, $kind) = $this->getTarget($valueName); + // Display any implicit use statements that were added during name resolution + if ($output !== null) { + $this->writeCleanerMessages($output); + } + return [$value, Mirror::get($value, $member, $kind)]; } @@ -323,4 +346,19 @@ protected function setCommandScopeVariables(\Reflector $reflector) $this->context->setCommandScopeVariables($vars); } + + /** + * Write log messages (e.g. implicit use statements) from CodeCleaner passes. + */ + protected function writeCleanerMessages(OutputInterface $output) + { + // Write to stderr if this is a ConsoleOutput + if ($output instanceof ConsoleOutput) { + $output = $output->getErrorOutput(); + } + + foreach ($this->cleaner->getMessages() as $message) { + $output->writeln(\sprintf('%s', OutputFormatter::escape($message))); + } + } } diff --git a/app/vendor/psy/psysh/src/Command/ShowCommand.php b/app/vendor/psy/psysh/src/Command/ShowCommand.php index 35703e666..331804f22 100644 --- a/app/vendor/psy/psysh/src/Command/ShowCommand.php +++ b/app/vendor/psy/psysh/src/Command/ShowCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -32,7 +32,7 @@ class ShowCommand extends ReflectingCommand /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('show') @@ -102,8 +102,10 @@ protected function execute(InputInterface $input, OutputInterface $output): int private function writeCodeContext(InputInterface $input, OutputInterface $output) { + $shellOutput = $this->shellOutput($output); + try { - list($target, $reflector) = $this->getTargetAndReflector($input->getArgument('target')); + list($target, $reflector) = $this->getTargetAndReflector($input->getArgument('target'), $output); } catch (UnexpectedTargetException $e) { // If we didn't get a target and Reflector, maybe we got a filename? $target = $e->getTarget(); @@ -116,7 +118,7 @@ private function writeCodeContext(InputInterface $input, OutputInterface $output ]); } - $output->page(CodeFormatter::formatCode($code)); + $shellOutput->page(CodeFormatter::formatCode($code)); return; } else { @@ -128,7 +130,7 @@ private function writeCodeContext(InputInterface $input, OutputInterface $output $this->setCommandScopeVariables($reflector); try { - $output->page(CodeFormatter::format($reflector)); + $shellOutput->page(CodeFormatter::format($reflector)); } catch (RuntimeException $e) { $output->writeln(SignatureFormatter::format($reflector)); throw $e; @@ -167,9 +169,12 @@ private function writeExceptionContext(InputInterface $input, OutputInterface $o $this->lastException = $exception; $this->lastExceptionIndex = $index; - $output->writeln($this->getShell()->formatException($exception)); - $output->writeln('--'); + $shell = $this->getShell(); + + $shell->writeExceptionHeader($output, $exception); + $shell->writeSeparator($output); $this->writeTraceLine($output, $trace, $index); + $shell->writeSpacer($output); $this->writeTraceCodeSnippet($output, $trace, $index); $this->setCommandScopeVariablesFromContext($trace[$index]); diff --git a/app/vendor/psy/psysh/src/Command/SudoCommand.php b/app/vendor/psy/psysh/src/Command/SudoCommand.php index b84fbdc55..0df545fd3 100644 --- a/app/vendor/psy/psysh/src/Command/SudoCommand.php +++ b/app/vendor/psy/psysh/src/Command/SudoCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -15,6 +15,7 @@ use PhpParser\PrettyPrinter\Standard as Printer; use Psy\Input\CodeArgument; use Psy\Readline\Readline; +use Psy\Readline\ReadlineAware; use Psy\Sudo\SudoVisitor; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; @@ -22,7 +23,7 @@ /** * Evaluate PHP code, bypassing visibility restrictions. */ -class SudoCommand extends Command +class SudoCommand extends Command implements ReadlineAware { private Readline $readline; private CodeArgumentParser $parser; @@ -58,7 +59,7 @@ public function setReadline(Readline $readline) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('sudo') diff --git a/app/vendor/psy/psysh/src/Command/ThrowUpCommand.php b/app/vendor/psy/psysh/src/Command/ThrowUpCommand.php index 0c0042541..80da9df1f 100644 --- a/app/vendor/psy/psysh/src/Command/ThrowUpCommand.php +++ b/app/vendor/psy/psysh/src/Command/ThrowUpCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -13,11 +13,9 @@ use PhpParser\Node\Arg; use PhpParser\Node\Expr\New_; -use PhpParser\Node\Expr\Throw_; use PhpParser\Node\Expr\Variable; use PhpParser\Node\Name\FullyQualified as FullyQualifiedName; use PhpParser\Node\Scalar\String_; -use PhpParser\Node\Stmt\Expression; use PhpParser\PrettyPrinter\Standard as Printer; use Psy\Exception\ThrowUpException; use Psy\Input\CodeArgument; @@ -46,7 +44,7 @@ public function __construct($name = null) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('throw-up') @@ -79,8 +77,8 @@ protected function configure() protected function execute(InputInterface $input, OutputInterface $output): int { $args = $this->prepareArgs($input->getArgument('exception')); - $throwStmt = new Expression(new Throw_(new New_(new FullyQualifiedName(ThrowUpException::class), $args))); - $throwCode = $this->printer->prettyPrint([$throwStmt]); + $exception = new New_(new FullyQualifiedName(ThrowUpException::class), $args); + $throwCode = 'throw '.$this->printer->prettyPrintExpr($exception).';'; $shell = $this->getShell(); $shell->addCode($throwCode, !$shell->hasCode()); @@ -95,7 +93,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int * * @throws \InvalidArgumentException if there is no exception to throw * - * @param string $code + * @param string|null $code * * @return Arg[] */ @@ -118,7 +116,7 @@ private function prepareArgs(?string $code = null): array // Allow throwing via a string, e.g. `throw-up "SUP"` if ($expr instanceof String_) { - return [new New_(new FullyQualifiedName(\Exception::class), $args)]; + return [new Arg(new New_(new FullyQualifiedName(\Exception::class), $args))]; } return $args; diff --git a/app/vendor/psy/psysh/src/Command/TimeitCommand.php b/app/vendor/psy/psysh/src/Command/TimeitCommand.php index 964697df7..0bc41af83 100644 --- a/app/vendor/psy/psysh/src/Command/TimeitCommand.php +++ b/app/vendor/psy/psysh/src/Command/TimeitCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -27,8 +27,9 @@ class TimeitCommand extends Command const RESULT_MSG = 'Command took %.6f seconds to complete.'; const AVG_RESULT_MSG = 'Command took %.6f seconds on average (%.6f median; %.6f total) to complete.'; - // All times stored as nanoseconds! - private static ?int $start = null; + // All times stored as nanoseconds (int on 64-bit, float on 32-bit overflow) + /** @var int|float|null */ + private static $start = null; private static array $times = []; private CodeArgumentParser $parser; @@ -54,7 +55,7 @@ public function __construct($name = null) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('timeit') @@ -91,7 +92,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int self::$times = []; do { - $_ = $shell->execute($instrumentedCode); + $_ = $shell->execute($instrumentedCode, true); $this->ensureEndMarked(); } while (\count(self::$times) < $num); @@ -101,11 +102,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int self::$times = []; if ($num === 1) { + // @phpstan-ignore-next-line offsetAccess.nonOffsetAccessible (guaranteed by loop: count($times) >= $num) $output->writeln(\sprintf(self::RESULT_MSG, $times[0] / 1e+9)); } else { $total = \array_sum($times); \rsort($times); - $median = $times[\round($num / 2)]; + // @phpstan-ignore-next-line offsetAccess.nonOffsetAccessible (guaranteed by loop: count($times) >= $num) + $median = $times[(int) \round($num / 2)]; $output->writeln(\sprintf(self::AVG_RESULT_MSG, ($total / $num) / 1e+9, $median / 1e+9, $total / 1e+9)); } diff --git a/app/vendor/psy/psysh/src/Command/TimeitCommand/TimeitVisitor.php b/app/vendor/psy/psysh/src/Command/TimeitCommand/TimeitVisitor.php index e2817affc..bb1ec6d5e 100644 --- a/app/vendor/psy/psysh/src/Command/TimeitCommand/TimeitVisitor.php +++ b/app/vendor/psy/psysh/src/Command/TimeitCommand/TimeitVisitor.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -41,6 +41,8 @@ class TimeitVisitor extends NodeVisitorAbstract public function beforeTraverse(array $nodes) { $this->functionDepth = 0; + + return null; } /** @@ -55,13 +57,15 @@ public function enterNode(Node $node) if ($node instanceof FunctionLike) { $this->functionDepth++; - return; + return null; } // replace any top-level `return` statements with a `markEnd` call if ($this->functionDepth === 0 && $node instanceof Return_) { return new Return_($this->getEndCall($node->expr), $node->getAttributes()); } + + return null; } /** @@ -74,6 +78,8 @@ public function leaveNode(Node $node) if ($node instanceof FunctionLike) { $this->functionDepth--; } + + return null; } /** diff --git a/app/vendor/psy/psysh/src/Command/TraceCommand.php b/app/vendor/psy/psysh/src/Command/TraceCommand.php index 04a2beb0c..a4fd2d8fa 100644 --- a/app/vendor/psy/psysh/src/Command/TraceCommand.php +++ b/app/vendor/psy/psysh/src/Command/TraceCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -13,7 +13,7 @@ use Psy\Formatter\TraceFormatter; use Psy\Input\FilterOptions; -use Psy\Output\ShellOutput; +use Psy\Output\ShellOutputAdapter; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\Console\Output\OutputInterface; @@ -38,7 +38,7 @@ public function __construct($name = null) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { list($grep, $insensitive, $invert) = FilterOptions::getOptions(); @@ -75,7 +75,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int { $this->filter->bind($input); $trace = $this->getBacktrace(new \Exception(), $input->getOption('num'), $input->getOption('include-psy')); - $output->page($trace, ShellOutput::NUMBER_LINES); + $this->shellOutput($output)->page($trace, ShellOutputAdapter::NUMBER_LINES); return 0; } @@ -87,7 +87,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int * Psy from the trace. * * @param \Throwable $e The exception or error with a backtrace - * @param int $count (default: PHP_INT_MAX) + * @param int|null $count (default: PHP_INT_MAX) * @param bool $includePsy (default: true) * * @return array Formatted stacktrace lines diff --git a/app/vendor/psy/psysh/src/Command/WhereamiCommand.php b/app/vendor/psy/psysh/src/Command/WhereamiCommand.php index 68f4c4e2a..95615e320 100644 --- a/app/vendor/psy/psysh/src/Command/WhereamiCommand.php +++ b/app/vendor/psy/psysh/src/Command/WhereamiCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,8 +11,8 @@ namespace Psy\Command; +use Psy\ConfigPaths; use Psy\Formatter\CodeFormatter; -use Psy\Output\ShellOutput; use Psy\Shell; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; @@ -35,7 +35,7 @@ public function __construct() /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { $this ->setName('whereami') @@ -111,6 +111,8 @@ protected function fileInfo(): array */ protected function execute(InputInterface $input, OutputInterface $output): int { + $shellOutput = $this->shellOutput($output); + $info = $this->fileInfo(); $num = $input->getOption('num'); $lineNum = $info['line']; @@ -123,34 +125,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int $endLine = null; } - if ($output instanceof ShellOutput) { - $output->startPaging(); - } + $shellOutput->startPaging(); - $output->writeln(\sprintf('From %s:%s:', $this->replaceCwd($info['file']), $lineNum)); + $output->writeln(\sprintf('From %s:%s:', ConfigPaths::prettyPath($info['file']), $lineNum)); $output->write(CodeFormatter::formatCode($code, $startLine, $endLine, $lineNum), false); - if ($output instanceof ShellOutput) { - $output->stopPaging(); - } + $shellOutput->stopPaging(); return 0; } - - /** - * Replace the given directory from the start of a filepath. - * - * @param string $file - */ - private function replaceCwd(string $file): string - { - $cwd = \getcwd(); - if ($cwd === false) { - return $file; - } - - $cwd = \rtrim($cwd, \DIRECTORY_SEPARATOR).\DIRECTORY_SEPARATOR; - - return \preg_replace('/^'.\preg_quote($cwd, '/').'/', '', $file); - } } diff --git a/app/vendor/psy/psysh/src/Command/WtfCommand.php b/app/vendor/psy/psysh/src/Command/WtfCommand.php index 1b4c7c27b..6b4d8d2ed 100644 --- a/app/vendor/psy/psysh/src/Command/WtfCommand.php +++ b/app/vendor/psy/psysh/src/Command/WtfCommand.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -14,7 +14,7 @@ use Psy\Context; use Psy\ContextAware; use Psy\Input\FilterOptions; -use Psy\Output\ShellOutput; +use Psy\Output\ShellOutputAdapter; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; @@ -40,7 +40,7 @@ public function setContext(Context $context) /** * {@inheritdoc} */ - protected function configure() + protected function configure(): void { list($grep, $insensitive, $invert) = FilterOptions::getOptions(); @@ -82,6 +82,7 @@ protected function configure() protected function execute(InputInterface $input, OutputInterface $output): int { $this->filter->bind($input); + $shellOutput = $this->shellOutput($output); $incredulity = \implode('', $input->getArgument('incredulity')); if (\strlen(\preg_replace('/[\\?!]/', '', $incredulity))) { @@ -90,11 +91,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int $exception = $this->context->getLastException(); $count = $input->getOption('all') ? \PHP_INT_MAX : \max(3, \pow(2, \strlen($incredulity) + 1)); + $shell = $this->getShell(); - if ($output instanceof ShellOutput) { - $output->startPaging(); - } - + $shellOutput->startPaging(); do { $traceCount = \count($exception->getTrace()); $showLines = $count; @@ -106,23 +105,25 @@ protected function execute(InputInterface $input, OutputInterface $output): int $trace = $this->getBacktrace($exception, $showLines); $moreLines = $traceCount - \count($trace); - $output->writeln($this->getShell()->formatException($exception)); - $output->writeln('--'); - $output->write($trace, true, ShellOutput::NUMBER_LINES); - $output->writeln(''); + $shell->writeExceptionHeader($output, $exception); + $shell->writeSeparator($output); + $shellOutput->write($trace, true, ShellOutputAdapter::NUMBER_LINES); if ($moreLines > 0) { + $shell->writeSpacer($output); $output->writeln(\sprintf( '', $moreLines )); - $output->writeln(''); } - } while ($exception = $exception->getPrevious()); - if ($output instanceof ShellOutput) { - $output->stopPaging(); - } + $previous = $exception->getPrevious(); + if ($previous !== null) { + $shell->writeSpacer($output); + } + } while ($exception = $previous); + + $shellOutput->stopPaging(); return 0; } diff --git a/app/vendor/psy/psysh/src/Command/YoloCommand.php b/app/vendor/psy/psysh/src/Command/YoloCommand.php new file mode 100644 index 000000000..cc8877fe9 --- /dev/null +++ b/app/vendor/psy/psysh/src/Command/YoloCommand.php @@ -0,0 +1,92 @@ +readline = $readline; + } + + /** + * {@inheritdoc} + */ + protected function configure(): void + { + $this + ->setName('yolo') + ->setDefinition([ + new CodeArgument('code', CodeArgument::REQUIRED, 'Code to execute, or !! to repeat last.'), + ]) + ->setDescription('Execute code while bypassing reloader safety checks.') + ->setHelp( + <<<'HELP' +Execute code with all reloader safety checks bypassed. + +When the reloader shows warnings about skipped conditionals or other +risky operations, use yolo to force reload and execute anyway: + +e.g. +>>> my_helper() +Warning: Skipped conditional: if (...) { function my_helper() ... } + +>>> yolo !! +=> "result" +HELP + ); + } + + /** + * {@inheritdoc} + */ + protected function execute(InputInterface $input, OutputInterface $output): int + { + $code = $input->getArgument('code'); + + // Handle !! for last command + if ($code === '!!') { + $history = $this->readline->listHistory(); + \array_pop($history); // Remove the current `yolo !!` invocation + $code = \end($history) ?: ''; + if (empty($code)) { + throw new \RuntimeException('No previous command to repeat'); + } + } + + $shell = $this->getShell(); + + $shell->setForceReload(true); + + try { + $shell->addCode($code); + + return 0; + } finally { + $shell->setForceReload(false); + } + } +} diff --git a/app/vendor/psy/psysh/src/CommandArgumentCompletionAware.php b/app/vendor/psy/psysh/src/CommandArgumentCompletionAware.php new file mode 100644 index 000000000..d2e4e390d --- /dev/null +++ b/app/vendor/psy/psysh/src/CommandArgumentCompletionAware.php @@ -0,0 +1,32 @@ + */ + private array $commandMap = []; + + /** + * Set the available commands. + * + * @param Command[] $commands + */ + public function setCommands(array $commands): void + { + $this->commandMap = []; + + foreach ($commands as $command) { + $this->commandMap[$command->getName()] = $command; + + foreach ($command->getAliases() as $alias) { + $this->commandMap[$alias] = $command; + } + } + } +} diff --git a/app/vendor/psy/psysh/src/Completion/AnalysisResult.php b/app/vendor/psy/psysh/src/Completion/AnalysisResult.php new file mode 100644 index 000000000..fc4c18d6c --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/AnalysisResult.php @@ -0,0 +1,85 @@ +kinds = $kinds; + $this->prefix = $prefix; + $this->leftSide = $leftSide; + $this->leftSideNode = $leftSideNode; + $this->leftSideTypes = (array) $leftSideTypes; + $this->leftSideValue = $leftSideValue; + $this->tokens = $tokens; + $this->input = $input; + $this->readlineInfo = $readlineInfo; + $this->parseSucceeded = $parseSucceeded; + } + + /** + * Return a copy with updated completion context for a later pipeline stage. + */ + public function withContext(int $kinds, string $prefix = '', ?string $leftSide = null, ?Node $leftSideNode = null): self + { + // Types and value are cleared because CompletionEngine re-resolves + // them after all refiners have run. + $copy = clone $this; + $copy->kinds = $kinds; + $copy->prefix = $prefix; + $copy->leftSide = $leftSide; + $copy->leftSideNode = $leftSideNode; + $copy->leftSideTypes = []; + $copy->leftSideValue = null; + + return $copy; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/CompletionEngine.php b/app/vendor/psy/psysh/src/Completion/CompletionEngine.php new file mode 100644 index 000000000..d1554ad91 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/CompletionEngine.php @@ -0,0 +1,218 @@ +context = $context; + $this->analyzer = new ContextAnalyzer($cleaner); + $this->typeResolver = new TypeResolver($context, $cleaner); + $this->symbolCatalog = $symbolCatalog ?? new SymbolCatalog(); + $this->addRefiner(new PartialInputRefiner()); + $this->addRefiner(new CommandSyntaxRefiner()); + } + + /** + * Register the standard PsySH completion source set. + * + * @param SourceInterface[] $additionalSources Pre-initialized sources to include + */ + public function registerDefaultSources(array $additionalSources = []): void + { + // Context-aware sources. + $this->addSource(new VariableSource($this->context)); + $this->addSource(new ObjectMethodSource()); + $this->addSource(new ObjectPropertySource()); + + // Static reflection sources. + $this->addSource(new MethodSource()); + $this->addSource(new PropertySource()); + $this->addSource(new StaticMethodSource()); + $this->addSource(new StaticPropertySource()); + $this->addSource(new ClassConstantSource()); + + // Docblock magic sources. + $this->addSource(new MagicMethodSource()); + $this->addSource(new MagicPropertySource()); + + // Symbol sources (shared symbol catalog snapshot cache). + $this->addSource(new CatalogSource(CompletionKind::CLASS_NAME, [$this->symbolCatalog, 'getClasses'], $this->symbolCatalog)); + $this->addSource(new CatalogSource(CompletionKind::INTERFACE_NAME, [$this->symbolCatalog, 'getInterfaces'], $this->symbolCatalog)); + $this->addSource(new CatalogSource(CompletionKind::TRAIT_NAME, [$this->symbolCatalog, 'getTraits'], $this->symbolCatalog)); + $this->addSource(new CatalogSource(CompletionKind::ATTRIBUTE_NAME, [$this->symbolCatalog, 'getAttributeClasses'], $this->symbolCatalog)); + $this->addSource(new CatalogSource(CompletionKind::FUNCTION_NAME, [$this->symbolCatalog, 'getFunctions'], $this->symbolCatalog)); + $this->addSource(new CatalogSource(CompletionKind::CONSTANT, [$this->symbolCatalog, 'getConstants'], $this->symbolCatalog)); + $this->addSource(new NamespaceSource($this->symbolCatalog)); + + // Additional pre-initialized sources. + foreach ($additionalSources as $source) { + $this->addSource($source); + } + + // Generic sources. + $this->addSource(new KeywordSource()); + } + + /** + * Add a completion source. + */ + public function addSource(SourceInterface $source): void + { + if (!\in_array($source, $this->sources, true)) { + $this->sources[] = $source; + } + } + + /** + * Add an analysis refiner. + * + * Refiners translate broad parser output into the narrower completion lanes + * that sources consume. + */ + public function addRefiner(AnalysisRefinerInterface $refiner): void + { + if (!\in_array($refiner, $this->refiners, true)) { + $this->refiners[] = $refiner; + } + } + + /** + * Get completions for a normalized request. + * + * @return string[] + */ + public function getCompletions(CompletionRequest $request): array + { + $start = \microtime(true); + DebugLog::log('Completion', 'START', [ + 'mode' => $request->getMode(), + 'input' => $request->getBuffer(), + 'cursor' => $request->getCursor(), + ]); + + $analysis = $this->analyzer->analyze( + $request->getBuffer(), + $request->getCursor(), + $request->getReadlineInfo() + ); + foreach ($this->refiners as $refiner) { + $analysis = $refiner->refine($analysis); + } + DebugLog::log('Completion', 'ANALYZED', [ + 'kinds' => $analysis->kinds, + 'prefix' => $analysis->prefix, + 'leftSide' => $analysis->leftSide ?? 'null', + ]); + + $leftSide = $analysis->leftSide; + if ($leftSide !== null) { + $leftSideNode = $analysis->leftSideNode; + $analysis->leftSideTypes = $leftSideNode instanceof AstNode + ? $this->typeResolver->resolveNodeTypes($leftSideNode, $leftSide) + : $this->typeResolver->resolveTypes($leftSide); + $analysis->leftSideValue = $this->typeResolver->resolveValue($leftSide); + DebugLog::log('Completion', 'RESOLVED_TYPES', [ + 'types' => empty($analysis->leftSideTypes) ? 'none' : \implode('|', $analysis->leftSideTypes), + 'has_value' => $analysis->leftSideValue !== null, + ]); + } + + $results = $this->collectFromSources($analysis); + $results = \array_values(\array_unique(\array_filter($results, fn ($match) => $match !== '' && $match !== null))); + + if ($analysis->prefix !== '' && !empty($results)) { + $before = \count($results); + $results = FuzzyMatcher::filter($analysis->prefix, $results); + DebugLog::log('Completion', 'FUZZY_FILTER', [ + 'before' => $before, + 'after' => \count($results), + ]); + } + + $latencyMs = (\microtime(true) - $start) * 1000; + DebugLog::log('Completion', 'METRICS', [ + 'latency_ms' => \round($latencyMs, 2), + 'results' => \count($results), + ]); + + return $results; + } + + /** + * Collect completions from all applicable sources. + * + * @return string[] + */ + private function collectFromSources(AnalysisResult $analysis): array + { + $completions = []; + + foreach ($this->sources as $source) { + if (!$source->appliesToKind($analysis->kinds)) { + continue; + } + + $sourceCompletions = $source->getCompletions($analysis); + if (!empty($sourceCompletions)) { + DebugLog::log('Completion', 'SOURCE_MATCHED', [ + 'source' => \get_class($source), + 'count' => \count($sourceCompletions), + ]); + + $completions = \array_merge($completions, $sourceCompletions); + } + } + + return $completions; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/CompletionKind.php b/app/vendor/psy/psysh/src/Completion/CompletionKind.php new file mode 100644 index 000000000..cd29b6a13 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/CompletionKind.php @@ -0,0 +1,75 @@ +method()| + public const OBJECT_PROPERTY = 1 << 3; // $foo->property| + + // Static members (class) + public const STATIC_METHOD = 1 << 4; // Foo::method()| + public const STATIC_PROPERTY = 1 << 5; // Foo::$property| + public const CLASS_CONSTANT = 1 << 6; // Foo::CONSTANT| + + // Type names + public const CLASS_NAME = 1 << 7; // new Foo|, extends Foo| + public const INTERFACE_NAME = 1 << 8; // implements Bar| + public const TRAIT_NAME = 1 << 9; // use SomeTrait| (inside class) + public const ATTRIBUTE_NAME = 1 << 10; // #[Deprecated|] (PHP 8+) + + // Global symbols + public const FUNCTION_NAME = 1 << 11; // foo|() + public const CONSTANT = 1 << 12; // CONST| + public const NAMESPACE = 1 << 13; // namespace Foo\|, use Foo\| + + // PsySH-specific + public const COMMAND = 1 << 14; // ls|, doc| + public const COMMAND_OPTION = 1 << 15; // ls --option|, ls -a| + + // PHP keywords + public const KEYWORD = 1 << 16; // echo|, isset| + + // Advanced (future) + public const NAMED_PARAMETER = 1 << 17; // foo(name: |) (PHP 8+) + public const ARRAY_KEY = 1 << 18; // $array['key'|] + public const COMMAND_ARGUMENT = 1 << 19; // config set verbosity| + + // Common combinations for ambiguous contexts + public const OBJECT_MEMBER = self::OBJECT_METHOD | self::OBJECT_PROPERTY; // $foo->| + public const STATIC_MEMBER = self::STATIC_METHOD | self::STATIC_PROPERTY | self::CLASS_CONSTANT; // Foo::| + public const TYPE_NAME = self::CLASS_NAME | self::INTERFACE_NAME; // Type hints, return types + public const CLASS_LIKE = self::CLASS_NAME | self::INTERFACE_NAME | self::TRAIT_NAME; // Any class-like structure + public const CALLABLE = self::FUNCTION_NAME | self::CLASS_NAME; + public const SYMBOL = self::FUNCTION_NAME | self::CLASS_LIKE | self::CONSTANT; + + // Contexts where the input might be a shell command rather than PHP code + public const COMMAND_ELIGIBLE = self::UNKNOWN | self::SYMBOL | self::KEYWORD; +} diff --git a/app/vendor/psy/psysh/src/Completion/CompletionRequest.php b/app/vendor/psy/psysh/src/Completion/CompletionRequest.php new file mode 100644 index 000000000..1eab99408 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/CompletionRequest.php @@ -0,0 +1,68 @@ +buffer = $buffer; + $this->cursor = $this->normalizeCursor($buffer, $cursor); + $this->mode = $mode; + $this->readlineInfo = $readlineInfo; + } + + public function getBuffer(): string + { + return $this->buffer; + } + + public function getCursor(): int + { + return $this->cursor; + } + + public function getMode(): string + { + return $this->mode; + } + + /** + * Get raw readline callback metadata associated with this request. + */ + public function getReadlineInfo(): array + { + return $this->readlineInfo; + } + + private function normalizeCursor(string $buffer, int $cursor): int + { + $length = \mb_strlen($buffer); + + return \max(0, \min($cursor, $length)); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/ContextAnalyzer.php b/app/vendor/psy/psysh/src/Completion/ContextAnalyzer.php new file mode 100644 index 000000000..0ddcf9f0a --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/ContextAnalyzer.php @@ -0,0 +1,221 @@ +parser = (new ParserFactory())->createParser(); + $this->printer = new Printer(); + $this->cleaner = $cleaner; + } + + /** + * Analyze input and return the coarse parser-derived context. + */ + public function analyze(string $input, int $cursor, array $readlineInfo = []): AnalysisResult + { + // Cursor is in code-point units, so use mb_substr + $inputToCursor = \mb_substr($input, 0, $cursor); + $cursorAtEnd = ($cursor >= \mb_strlen($input)); + $analysis = $this->tryParse($inputToCursor, $cursorAtEnd); + $parseSucceeded = $analysis !== null; + $analysis = $analysis ?? new AnalysisResult(CompletionKind::UNKNOWN, ''); + $analysis->parseSucceeded = $parseSucceeded; + + $analysis->input = $inputToCursor; + $analysis->tokens = @\token_get_all('readlineInfo = $readlineInfo; + + return $analysis; + } + + /** + * Try to parse input and analyze the resulting AST. + */ + private function tryParse(string $input, bool $cursorAtEnd): ?AnalysisResult + { + $code = 'parser->parse($code.';'); + } catch (PhpParserError $e) { + try { + $stmts = $this->parser->parse($code); + } catch (PhpParserError $e2) { + return null; + } + } + + if (empty($stmts)) { + return new AnalysisResult(CompletionKind::UNKNOWN, ''); + } + + $visitor = new DeepestNodeVisitor(); + $traverser = new NodeTraverser(); + $traverser->addVisitor($visitor); + $traverser->traverse($stmts); + + $node = $visitor->getDeepestNode(); + if ($node === null) { + return new AnalysisResult(CompletionKind::UNKNOWN, ''); + } + + // Trailing whitespace means the user has moved past this token + if ($cursorAtEnd && $input !== \rtrim($input)) { + return new AnalysisResult(CompletionKind::UNKNOWN, ''); + } + + return $this->analyzeNode($node); + } + + /** + * Analyze a specific AST node to determine completion context. + */ + private function analyzeNode(Node $node): AnalysisResult + { + // $foo->bar, $foo->bar(), $foo?->bar, $foo?->bar() + if ( + $node instanceof MethodCall + || $node instanceof PropertyFetch + || $node instanceof NullsafeMethodCall + || $node instanceof NullsafePropertyFetch + ) { + $leftSide = $this->extractExpression($node->var); + $prefix = $node->name instanceof Identifier ? $node->name->name : ''; + $result = new AnalysisResult(CompletionKind::OBJECT_MEMBER, $prefix, $leftSide); + $result->leftSideNode = $node->var; + + return $result; + } + + // Foo::bar(), Foo::BAR, Foo::$bar + if ( + $node instanceof StaticCall + || $node instanceof ClassConstFetch + || $node instanceof StaticPropertyFetch + ) { + $leftSide = $this->extractExpression($node->class); + $prefix = $node->name instanceof Identifier ? $node->name->name : ''; + $result = new AnalysisResult(CompletionKind::STATIC_MEMBER, $prefix, $leftSide); + $result->leftSideNode = $node->class; + + return $result; + } + + // new Foo + if ($node instanceof New_) { + $prefix = $node->class instanceof Name ? $node->class->toString() : ''; + + return new AnalysisResult(CompletionKind::CLASS_NAME, $prefix); + } + + // $foo + if ($node instanceof Variable) { + $prefix = \is_string($node->name) ? $node->name : ''; + + return new AnalysisResult(CompletionKind::VARIABLE, $prefix); + } + + // foo() + if ($node instanceof FuncCall && $node->name instanceof Name) { + return new AnalysisResult(CompletionKind::FUNCTION_NAME, $node->name->toString()); + } + + // FOO (could be a constant, function, or class reference) + if ($node instanceof ConstFetch && $node->name instanceof Name) { + return new AnalysisResult(CompletionKind::SYMBOL, $node->name->toString()); + } + + if ($node instanceof Identifier) { + return new AnalysisResult(CompletionKind::UNKNOWN, $node->name); + } + + // Bare name: foo or Foo\Bar + if ($node instanceof Name) { + return new AnalysisResult(CompletionKind::SYMBOL, $node->toString()); + } + + return new AnalysisResult(CompletionKind::UNKNOWN, ''); + } + + /** + * Extract a string representation of an expression. + * + * Uses the printer to convert the AST node back to code. + */ + private function extractExpression($expr): string + { + if ($expr instanceof Variable && \is_string($expr->name)) { + return '$'.$expr->name; + } + + if ($expr instanceof Name) { + return $this->resolveClassName($expr); + } + + if ($expr instanceof Node\Expr) { + return $this->printer->prettyPrintExpr($expr); + } + + return ''; + } + + /** + * Resolve a class name using CodeCleaner's namespace context. + * + * This ensures we use the same use statements and namespace as the code + * being executed. + */ + private function resolveClassName(Name $name): string + { + if ($this->cleaner === null) { + return $name->toString(); + } + + return $this->cleaner->resolveClassName($name->toString()); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/DeepestNodeVisitor.php b/app/vendor/psy/psysh/src/Completion/DeepestNodeVisitor.php new file mode 100644 index 000000000..0671eb90f --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/DeepestNodeVisitor.php @@ -0,0 +1,48 @@ +format;`, we want the + * PropertyFetch node, not the Variable node inside it. + */ +class DeepestNodeVisitor extends NodeVisitorAbstract +{ + private ?Node $targetNode = null; + + public function enterNode(Node $node) + { + // If this is an Expression statement, grab its expression + if ($node instanceof Expression) { + $this->targetNode = $node->expr; + + // Don't traverse into the expression - we have what we need + // @phan-suppress-next-line PhanDeprecatedClassConstant - keep compat with php-parser 4.x baseline + return NodeTraverser::DONT_TRAVERSE_CHILDREN; + } + + return null; + } + + public function getDeepestNode(): ?Node + { + return $this->targetNode; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/FuzzyMatcher.php b/app/vendor/psy/psysh/src/Completion/FuzzyMatcher.php new file mode 100644 index 000000000..33b1e1719 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/FuzzyMatcher.php @@ -0,0 +1,176 @@ + $candidate, 'score' => $score]; + } + } + + // Sort by score (lower is better), then alphabetically + \usort($matches, function ($a, $b) { + if ($a['score'] !== $b['score']) { + return $a['score'] <=> $b['score']; + } + + return \strcmp($a['candidate'], $b['candidate']); + }); + + return \array_column($matches, 'candidate'); + } + + /** + * Check if search matches candidate and return a quality score. + * + * Returns null if no match, or a numeric score where lower is better. + * Score factors: + * - Exact prefix match gets lowest score (best) + * - Earlier matches get better scores + * - Consecutive character matches get bonus + * - First character must match at start or after a word boundary + * + * @return int|null Match score (lower is better), or null if no match + */ + private static function match(string $search, string $candidate): ?int + { + $searchLen = \strlen($search); + $candidateLen = \strlen($candidate); + + if ($searchLen === 0) { + return 0; + } + + $searchLower = \strtolower($search); + $candidateLower = \strtolower($candidate); + + // Check for exact prefix match first (best score) + if (\strpos($candidateLower, $searchLower) === 0) { + return 0; + } + + // Check if it contains the search as a substring (very good score) + $substringPos = \strpos($candidateLower, $searchLower); + if ($substringPos !== false) { + // Only match if substring starts at a word boundary + if ($substringPos === 0 || self::isWordBoundary($candidate[$substringPos - 1])) { + return $substringPos + 1; + } + } + + // Fuzzy match: characters must appear in order + // First character MUST match at start or after a word boundary + $searchIdx = 0; + $candidateIdx = 0; + $lastMatchIdx = -1; + $firstMatchIdx = null; + $consecutiveMatches = 0; + $firstCharFound = false; + + while ($searchIdx < $searchLen && $candidateIdx < $candidateLen) { + if ($searchLower[$searchIdx] === $candidateLower[$candidateIdx]) { + // For the first character, ensure it's at a word boundary + if ($searchIdx === 0) { + if ($candidateIdx === 0 || self::isWordBoundary($candidate[$candidateIdx - 1])) { + $firstCharFound = true; + } else { + // First char not at word boundary, skip it + $candidateIdx++; + continue; + } + } + + if ($firstMatchIdx === null) { + $firstMatchIdx = $candidateIdx; + } + + // Track consecutive matches + if ($candidateIdx === $lastMatchIdx + 1) { + $consecutiveMatches++; + } + + $lastMatchIdx = $candidateIdx; + $searchIdx++; + } + $candidateIdx++; + } + + // Did we match all search characters, and did the first char match at a word boundary? + if ($searchIdx < $searchLen || !$firstCharFound) { + return null; + } + + // Score: position of first match + distance between matches - consecutive bonus + // Lower score is better + $score = 100 + $firstMatchIdx + ($lastMatchIdx - $firstMatchIdx) - ($consecutiveMatches * 10); + + return $score; + } + + /** + * Check if a character is a word boundary. + * + * Word boundaries include: underscore, space, dash, slash, backslash, and other non-alphanumeric chars. + */ + private static function isWordBoundary(string $char): bool + { + return !\ctype_alnum($char); + } + + /** + * Check if search string matches candidate (fuzzy). + * + * @return bool True if all characters in search appear in order in candidate + */ + public static function matches(string $search, string $candidate): bool + { + return self::match($search, $candidate) !== null; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Refiner/AnalysisRefinerInterface.php b/app/vendor/psy/psysh/src/Completion/Refiner/AnalysisRefinerInterface.php new file mode 100644 index 000000000..460339540 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Refiner/AnalysisRefinerInterface.php @@ -0,0 +1,28 @@ +setCommands($commands); + } + + /** + * {@inheritdoc} + */ + public function refine(AnalysisResult $analysis): AnalysisResult + { + if (!$this->supportsRefinement($analysis)) { + return $analysis; + } + + if (!\preg_match('/^\s*([^\s]+)(\s+.*)$/s', $analysis->input, $matches)) { + return $analysis; + } + + $commandName = $matches[1]; + $command = $this->commandMap[$commandName] ?? null; + + if (!$command instanceof CommandArgumentCompletionAware) { + return $analysis; + } + + if (!$command->supportsArgumentCompletion($analysis)) { + return $analysis; + } + + return $analysis->withContext(CompletionKind::COMMAND_ARGUMENT, $analysis->prefix, $commandName); + } + + private function supportsRefinement(AnalysisResult $analysis): bool + { + if (($analysis->kinds & CompletionKind::COMMAND_OPTION) !== 0) { + return false; + } + + return ($analysis->kinds & CompletionKind::COMMAND_ELIGIBLE) !== 0; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Refiner/CommandSyntaxRefiner.php b/app/vendor/psy/psysh/src/Completion/Refiner/CommandSyntaxRefiner.php new file mode 100644 index 000000000..9a74c0cb4 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Refiner/CommandSyntaxRefiner.php @@ -0,0 +1,53 @@ +kinds & CompletionKind::COMMAND_ELIGIBLE) === 0) { + return $analysis; + } + + $trimmed = \rtrim($analysis->input); + + if (\preg_match('/^([a-z][a-z0-9-]*)\s+.*?(-{1,2}[\w-]*)$/', $trimmed, $matches)) { + return $analysis->withContext(CompletionKind::COMMAND_OPTION, $matches[2], $matches[1]); + } + + if ($analysis->input !== $trimmed) { + return $analysis; + } + + if (!\preg_match('/^([a-z][a-z0-9-]*)$/', $trimmed, $matches)) { + return $analysis; + } + + return $analysis->withContext( + CompletionKind::COMMAND | CompletionKind::KEYWORD | CompletionKind::SYMBOL, + $matches[1] + ); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Refiner/PartialInputRefiner.php b/app/vendor/psy/psysh/src/Completion/Refiner/PartialInputRefiner.php new file mode 100644 index 000000000..35f44f5f5 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Refiner/PartialInputRefiner.php @@ -0,0 +1,355 @@ +parseSucceeded) { + $partial = $this->analyzePartialInput($analysis->input, $analysis->tokens); + + return $analysis->withContext($partial->kinds, $partial->prefix, $partial->leftSide, $partial->leftSideNode); + } + + if ($analysis->kinds !== CompletionKind::UNKNOWN) { + return $analysis; + } + + $partial = $this->analyzePartialInput($analysis->input, $analysis->tokens); + + return $this->shouldPreferPartialAnalysis($partial) + ? $analysis->withContext($partial->kinds, $partial->prefix, $partial->leftSide, $partial->leftSideNode) + : $analysis; + } + + private function analyzePartialInput(string $input, array $tokens = []): AnalysisResult + { + $trimmed = \rtrim($input); + $hasTrailingSpace = $input !== $trimmed; + + if (\preg_match('/\bnew\s+([\w\\\\]*)$/i', $input, $matches)) { + return new AnalysisResult(CompletionKind::CLASS_NAME, $matches[1]); + } + + if (\preg_match('/^.*[;\{\}]\s*(\w+)$/', $trimmed, $matches)) { + if (!\preg_match('/(?:->|\?->)\w*$/', $trimmed) && !\preg_match('/::\w*$/', $trimmed)) { + if ($hasTrailingSpace) { + return new AnalysisResult(CompletionKind::UNKNOWN, ''); + } + + return new AnalysisResult(CompletionKind::KEYWORD | CompletionKind::SYMBOL, $matches[1]); + } + } + + if (\preg_match('/(\$\w+)(?:->|\?->)([\w]*)$/', $trimmed, $matches)) { + return new AnalysisResult(CompletionKind::OBJECT_MEMBER, $matches[2], $matches[1]); + } + + if (\preg_match('/([\w\\\\]*\\\\)$/', $trimmed, $matches)) { + return new AnalysisResult(CompletionKind::SYMBOL | CompletionKind::NAMESPACE, $matches[1]); + } + + if (\preg_match('/([\w\\\\]+)::\$(\w*)$/', $trimmed, $matches)) { + return new AnalysisResult(CompletionKind::STATIC_MEMBER, $matches[2], $matches[1]); + } + + if (\preg_match('/([\w\\\\]+)::([\w]*)$/', $trimmed, $matches)) { + return new AnalysisResult(CompletionKind::STATIC_MEMBER, $matches[2], $matches[1]); + } + + $tokenizedObjectMember = $this->analyzeTokenizedObjectMemberAccess($input, $tokens); + if ($tokenizedObjectMember !== null) { + return $tokenizedObjectMember; + } + + if (\preg_match('/\$(\w*)$/', $trimmed, $matches)) { + return new AnalysisResult(CompletionKind::VARIABLE, $matches[1]); + } + + if (\preg_match('/([\w\\\\]+)$/', $trimmed, $matches)) { + if ($hasTrailingSpace) { + return new AnalysisResult(CompletionKind::UNKNOWN, ''); + } + + return new AnalysisResult(CompletionKind::SYMBOL, $matches[1]); + } + + return new AnalysisResult(CompletionKind::UNKNOWN, ''); + } + + private function shouldPreferPartialAnalysis(AnalysisResult $partialAnalysis): bool + { + return \in_array($partialAnalysis->kinds, [ + CompletionKind::VARIABLE, + CompletionKind::OBJECT_MEMBER, + CompletionKind::STATIC_MEMBER, + CompletionKind::CLASS_NAME, + CompletionKind::SYMBOL | CompletionKind::NAMESPACE, + ], true); + } + + private function analyzeTokenizedObjectMemberAccess(string $input, array $tokens): ?AnalysisResult + { + $entries = $this->flattenTokens($tokens); + if ($entries === []) { + return null; + } + + $lastIndex = $this->findPreviousSignificantTokenIndex($entries, \count($entries) - 1); + if ($lastIndex === null) { + return null; + } + + $prefix = ''; + $operatorIndex = $lastIndex; + + if ($this->isIdentifierToken($entries[$lastIndex])) { + $prefix = $entries[$lastIndex]['text']; + $operatorIndex = $this->findPreviousSignificantTokenIndex($entries, $lastIndex - 1); + if ($operatorIndex === null) { + return null; + } + } + + if (!$this->isObjectAccessOperatorToken($entries[$operatorIndex]['token'])) { + return null; + } + + $leftEndIndex = $this->findPreviousSignificantTokenIndex($entries, $operatorIndex - 1); + if ($leftEndIndex === null) { + return null; + } + + $leftStartIndex = $this->findExpressionStartIndex($entries, $leftEndIndex); + if ($leftStartIndex === null) { + return null; + } + + $leftSide = \mb_substr( + $input, + $entries[$leftStartIndex]['start'], + $entries[$leftEndIndex]['end'] - $entries[$leftStartIndex]['start'] + ); + $leftSide = $this->normalizeLeftExpression($leftSide); + + if ($leftSide === '') { + return null; + } + + return new AnalysisResult(CompletionKind::OBJECT_MEMBER, $prefix, $leftSide); + } + + private function flattenTokens(array $tokens): array + { + $entries = []; + $position = 0; + + foreach ($tokens as $token) { + $text = \is_array($token) ? $token[1] : $token; + + if (\is_array($token) && $token[0] === \T_OPEN_TAG) { + continue; + } + + $length = \mb_strlen($text); + $entries[] = [ + 'token' => $token, + 'text' => $text, + 'start' => $position, + 'end' => $position + $length, + ]; + $position += $length; + } + + return $entries; + } + + private function findPreviousSignificantTokenIndex(array $entries, int $start): ?int + { + for ($i = $start; $i >= 0; $i--) { + $token = $entries[$i]['token']; + + if (\is_array($token) && \in_array($token[0], [\T_WHITESPACE, \T_COMMENT, \T_DOC_COMMENT], true)) { + continue; + } + + return $i; + } + + return null; + } + + private function findExpressionStartIndex(array $entries, int $endIndex): ?int + { + $parenDepth = 0; + $bracketDepth = 0; + $braceDepth = 0; + + for ($i = $endIndex; $i >= 0; $i--) { + $token = $entries[$i]['token']; + $text = $entries[$i]['text']; + + if (!\is_array($token)) { + if ($text === ')') { + $parenDepth++; + continue; + } + + if ($text === '(') { + if ($parenDepth > 0) { + $parenDepth--; + continue; + } + } elseif ($text === ']') { + $bracketDepth++; + continue; + } elseif ($text === '[') { + if ($bracketDepth > 0) { + $bracketDepth--; + continue; + } + } elseif ($text === '}') { + $braceDepth++; + continue; + } elseif ($text === '{') { + if ($braceDepth > 0) { + $braceDepth--; + continue; + } + } + + if ($parenDepth === 0 && $bracketDepth === 0 && $braceDepth === 0 && $this->isExpressionBoundaryToken($token)) { + return $this->findNextNonWhitespaceTokenIndex($entries, $i + 1); + } + + continue; + } + + if ($parenDepth === 0 && $bracketDepth === 0 && $braceDepth === 0 && $this->isExpressionBoundaryToken($token)) { + return $this->findNextNonWhitespaceTokenIndex($entries, $i + 1); + } + } + + return $this->findNextNonWhitespaceTokenIndex($entries, 0); + } + + private function findNextNonWhitespaceTokenIndex(array $entries, int $start): ?int + { + for ($i = $start; $i < \count($entries); $i++) { + $token = $entries[$i]['token']; + + if (\is_array($token) && \in_array($token[0], [\T_WHITESPACE, \T_COMMENT, \T_DOC_COMMENT], true)) { + continue; + } + + return $i; + } + + return null; + } + + private function isExpressionBoundaryToken($token): bool + { + if (!\is_array($token)) { + return \in_array($token, [';', '{', '}', ',', '=', '+', '-', '*', '/', '%', '.', '?', ':', '!', '&', '|', '^', '<', '>'], true); + } + + return \in_array($token[0], [ + \T_DOUBLE_ARROW, + \T_BOOLEAN_AND, + \T_BOOLEAN_OR, + \T_LOGICAL_AND, + \T_LOGICAL_OR, + \T_LOGICAL_XOR, + \T_COALESCE, + \T_RETURN, + \T_ECHO, + \T_PRINT, + \T_THROW, + ], true); + } + + private function normalizeLeftExpression(string $expression): string + { + $expression = \trim($expression); + + while ($this->isWrappedInParentheses($expression)) { + $expression = \trim(\substr($expression, 1, -1)); + } + + return $expression; + } + + private function isWrappedInParentheses(string $expression): bool + { + if (\strlen($expression) < 2 || $expression[0] !== '(' || \substr($expression, -1) !== ')') { + return false; + } + + $depth = 0; + $length = \strlen($expression); + + for ($i = 0; $i < $length; $i++) { + if ($expression[$i] === '(') { + $depth++; + } elseif ($expression[$i] === ')') { + $depth--; + } + + if ($depth === 0 && $i < $length - 1) { + return false; + } + } + + return $depth === 0; + } + + private function isIdentifierToken(array $entry): bool + { + if (!\is_array($entry['token'])) { + return false; + } + + return \in_array($entry['token'][0], [ + \T_STRING, + \defined('T_NAME_QUALIFIED') ? \T_NAME_QUALIFIED : \T_STRING, + \defined('T_NAME_FULLY_QUALIFIED') ? \T_NAME_FULLY_QUALIFIED : \T_STRING, + \defined('T_NAME_RELATIVE') ? \T_NAME_RELATIVE : \T_STRING, + ], true); + } + + private function isObjectAccessOperatorToken($token): bool + { + if (!\is_array($token)) { + return false; + } + + if ($token[0] === \T_OBJECT_OPERATOR) { + return true; + } + + return \defined('T_NULLSAFE_OBJECT_OPERATOR') && $token[0] === \T_NULLSAFE_OBJECT_OPERATOR; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/CatalogSource.php b/app/vendor/psy/psysh/src/Completion/Source/CatalogSource.php new file mode 100644 index 000000000..c9d86d992 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/CatalogSource.php @@ -0,0 +1,78 @@ +kind = $kind; + $this->catalogMethod = \Closure::fromCallable($catalogMethod); + $this->catalog = $catalog ?? new SymbolCatalog(); + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & $this->kind) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + $prefix = $analysis->prefix; + $all = ($this->catalogMethod)($this->catalog); + + // If we have a prefix, try prefix matching first + if ($prefix !== '') { + $lowerPrefix = \strtolower($prefix); + $matches = []; + + foreach ($all as $name) { + if (\strpos(\strtolower($name), $lowerPrefix) === 0) { + $matches[] = $name; + } + } + + // If we found enough prefix matches, return those (sorted) + if (\count($matches) >= 10) { + \sort($matches); + + return $matches; + } + } + + return $all; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/ClassConstantSource.php b/app/vendor/psy/psysh/src/Completion/Source/ClassConstantSource.php new file mode 100644 index 000000000..500e5bd32 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/ClassConstantSource.php @@ -0,0 +1,59 @@ +leftSideTypes)) { + return []; + } + + $constants = []; + foreach ($analysis->leftSideTypes as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + foreach ($reflection->getReflectionConstants() as $constant) { + if ($constant->isPublic()) { + $constants[] = $constant->getName(); + } + } + } + + return \array_values(\array_unique($constants)); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/CommandArgumentSource.php b/app/vendor/psy/psysh/src/Completion/Source/CommandArgumentSource.php new file mode 100644 index 000000000..28f5cc48a --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/CommandArgumentSource.php @@ -0,0 +1,62 @@ +setCommands($commands); + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::COMMAND_ARGUMENT) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + $commandName = \is_string($analysis->leftSide) ? $analysis->leftSide : null; + $command = $commandName !== null ? ($this->commandMap[$commandName] ?? null) : null; + + if (!$command instanceof CommandArgumentCompletionAware) { + return []; + } + + // CommandContextRefiner already verified supportsArgumentCompletion() + // before setting COMMAND_ARGUMENT kind. + return $command->getArgumentCompletions($analysis); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/CommandOptionSource.php b/app/vendor/psy/psysh/src/Completion/Source/CommandOptionSource.php new file mode 100644 index 000000000..d830a4cb1 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/CommandOptionSource.php @@ -0,0 +1,123 @@ +setCommands($commands); + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::COMMAND_OPTION) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + $commandName = $analysis->leftSide; + if (!\is_string($commandName) || !isset($this->commandMap[$commandName])) { + return []; + } + + $command = $this->commandMap[$commandName]; + $input = $this->createInput($analysis); + $matches = []; + + foreach ($command->getDefinition()->getOptions() as $option) { + $longName = '--'.$option->getName(); + $shortName = $option->getShortcut() !== null ? '-'.$option->getShortcut() : null; + + if (!$option->isArray() && $this->isOptionUsed($input, $analysis, $longName, $shortName)) { + continue; + } + + $matches[] = $longName; + + if ($shortName !== null) { + $matches[] = $shortName; + } + } + + \sort($matches); + + return $matches; + } + + /** + * Create a StringInput for token scanning, or null if input is empty/unparseable. + */ + private function createInput(AnalysisResult $analysis): ?StringInput + { + if ($analysis->input === '') { + return null; + } + + try { + return new StringInput($analysis->input); + } catch (\Exception $e) { + return null; + } + } + + /** + * Check whether an option has already been used in the input. + */ + private function isOptionUsed(?StringInput $input, AnalysisResult $analysis, string $longName, ?string $shortName): bool + { + if ($input === null) { + return false; + } + + $names = [$longName]; + if ($shortName !== null) { + $names[] = $shortName; + } + + if ($input->hasParameterOption($names, true)) { + return true; + } + + // hasParameterOption handles --long, --long=val, and -o as the + // first short option in a group, but not combined short options + // like -l in -al. Fall back to a simple string match for that. + if ($shortName !== null && \preg_match('/(^|\s)-\w*'.\preg_quote($shortName[1], '/').'/', $analysis->input)) { + return true; + } + + return false; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/CommandSource.php b/app/vendor/psy/psysh/src/Completion/Source/CommandSource.php new file mode 100644 index 000000000..2c5f404c4 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/CommandSource.php @@ -0,0 +1,71 @@ +setCommands($commands); + } + + /** + * Set commands for completion. + * + * @param Command[] $commands + */ + public function setCommands(array $commands): void + { + $names = []; + foreach ($commands as $command) { + $names[] = $command->getName(); + foreach ($command->getAliases() as $alias) { + $names[] = $alias; + } + } + + \sort($names); + $this->commandNames = $names; + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::COMMAND) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + return $this->commandNames; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/HistorySource.php b/app/vendor/psy/psysh/src/Completion/Source/HistorySource.php new file mode 100644 index 000000000..29a14dd0b --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/HistorySource.php @@ -0,0 +1,54 @@ +history = $history; + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::COMMAND) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + if ($analysis->prefix === '') { + return []; + } + + // Newest first, deduplicated + $commands = $this->history->search('', false); + + return \array_values(\array_unique($commands)); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/KeywordSource.php b/app/vendor/psy/psysh/src/Completion/Source/KeywordSource.php new file mode 100644 index 000000000..0cae94390 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/KeywordSource.php @@ -0,0 +1,69 @@ += 80000) { + $this->keywords[] = 'match'; + \sort($this->keywords); + } + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::KEYWORD) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + return $this->keywords; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/MagicMethodSource.php b/app/vendor/psy/psysh/src/Completion/Source/MagicMethodSource.php new file mode 100644 index 000000000..8ecdafe92 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/MagicMethodSource.php @@ -0,0 +1,70 @@ +leftSideTypes; + + if (empty($types) && $analysis->leftSideValue !== null && \is_object($analysis->leftSideValue)) { + $types = [\get_class($analysis->leftSideValue)]; + } + + if (empty($types)) { + return []; + } + + $staticOnly = ($analysis->kinds & CompletionKind::STATIC_METHOD) !== 0 + && ($analysis->kinds & CompletionKind::OBJECT_METHOD) === 0; + + $methods = []; + foreach ($types as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + foreach (Docblock::getMagicMethods($reflection) as $method) { + if ($staticOnly && !$method->isStatic()) { + continue; + } + + $methods[] = $method->getName(); + } + } + + return \array_values(\array_unique($methods)); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/MagicPropertySource.php b/app/vendor/psy/psysh/src/Completion/Source/MagicPropertySource.php new file mode 100644 index 000000000..454bbde6c --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/MagicPropertySource.php @@ -0,0 +1,63 @@ +leftSideTypes; + + if (empty($types) && $analysis->leftSideValue !== null && \is_object($analysis->leftSideValue)) { + $types = [\get_class($analysis->leftSideValue)]; + } + + if (empty($types)) { + return []; + } + + $properties = []; + foreach ($types as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + foreach (Docblock::getMagicProperties($reflection) as $property) { + $properties[] = $property->getName(); + } + } + + return \array_values(\array_unique($properties)); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/MatcherAdapterSource.php b/app/vendor/psy/psysh/src/Completion/Source/MatcherAdapterSource.php new file mode 100644 index 000000000..acbb8b726 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/MatcherAdapterSource.php @@ -0,0 +1,179 @@ +matchers = \array_filter( + $matchers, + fn ($matcher) => !\in_array(\get_class($matcher), self::SUPERSEDED_MATCHERS, true) + ); + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + // Legacy matchers don't understand command argument contexts. + return ($kinds & ~CompletionKind::COMMAND_ARGUMENT) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + $tokens = $this->convertToTokens($analysis); + $info = $this->buildReadlineInfo($analysis); + + $matches = []; + foreach ($this->matchers as $matcher) { + if ($matcher->hasMatched($tokens)) { + $matches = \array_merge($matches, $matcher->getMatches($tokens, $info)); + } + } + + return $matches; + } + + /** + * Convert AnalysisResult to token array for legacy matchers. + * + * Legacy matchers expect tokens from token_get_all(). We reconstruct + * a reasonable approximation from the analysis result. + * + * @return array Token array compatible with legacy matchers + */ + private function convertToTokens(AnalysisResult $analysis): array + { + if (!empty($analysis->tokens)) { + return $this->filterTokens($analysis->tokens); + } + + // Reconstruct a token array from the analysis result + $tokens = []; + + if ($analysis->leftSide !== null) { + $leftTokens = \token_get_all('leftSide); + $tokens = \array_merge($tokens, \array_slice($leftTokens, 1)); + } + + if (($analysis->kinds & CompletionKind::OBJECT_MEMBER) !== 0) { + $tokens[] = [\T_OBJECT_OPERATOR, '->', 0]; + } elseif (($analysis->kinds & CompletionKind::STATIC_MEMBER) !== 0) { + $tokens[] = [\T_DOUBLE_COLON, '::', 0]; + } + + if ($analysis->prefix !== '') { + $tokens[] = [\T_STRING, $analysis->prefix, 0]; + } + + return $this->filterTokens($tokens); + } + + /** + * Filter tokens to remove whitespace (legacy matcher expectation). + * + * @return array Filtered token array + */ + private function filterTokens(array $tokens): array + { + $filtered = \array_filter($tokens, fn ($token) => !AbstractMatcher::tokenIs($token, AbstractMatcher::T_WHITESPACE)); + + return \array_values($filtered); + } + + /** + * Build readline_info array for legacy matchers. + * + * @return array readline_info-like array + */ + private function buildReadlineInfo(AnalysisResult $analysis): array + { + if ($analysis->readlineInfo !== []) { + return $analysis->readlineInfo; + } + + $lineBuffer = ''; + if ($analysis->leftSide !== null) { + $lineBuffer .= $analysis->leftSide; + + if (($analysis->kinds & CompletionKind::OBJECT_MEMBER) !== 0) { + $lineBuffer .= '->'; + } elseif (($analysis->kinds & CompletionKind::STATIC_MEMBER) !== 0) { + $lineBuffer .= '::'; + } + } + $lineBuffer .= $analysis->prefix; + + return [ + 'line_buffer' => $lineBuffer, + 'point' => \strlen($lineBuffer), + 'end' => \strlen($lineBuffer), + ]; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/MethodSource.php b/app/vendor/psy/psysh/src/Completion/Source/MethodSource.php new file mode 100644 index 000000000..5e9b276cf --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/MethodSource.php @@ -0,0 +1,63 @@ +` operator. + */ +class MethodSource implements SourceInterface +{ + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::OBJECT_METHOD) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + if (empty($analysis->leftSideTypes)) { + return []; + } + + $allCompletions = []; + + foreach ($analysis->leftSideTypes as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + $methods = $reflection->getMethods(\ReflectionMethod::IS_PUBLIC); + + foreach ($methods as $method) { + $allCompletions[] = $method->getName(); + } + } + + // Return all methods (fuzzy matching in CompletionEngine will filter) + $allCompletions = \array_unique($allCompletions); + \sort($allCompletions); + + return $allCompletions; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/NamespaceSource.php b/app/vendor/psy/psysh/src/Completion/Source/NamespaceSource.php new file mode 100644 index 000000000..0cfcb4eab --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/NamespaceSource.php @@ -0,0 +1,63 @@ +catalog = $catalog ?? new SymbolCatalog(); + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::NAMESPACE) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + $prefix = $analysis->prefix; + + $namespaces = $this->catalog->getNamespaces(); + + // Filter by prefix (case-insensitive) + $matches = []; + $lowerPrefix = \strtolower($prefix); + + foreach ($namespaces as $namespace) { + if ($lowerPrefix === '' || \strpos(\strtolower($namespace), $lowerPrefix) === 0) { + $matches[] = $namespace; + } + } + + \sort($matches); + + return $matches; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/ObjectMethodSource.php b/app/vendor/psy/psysh/src/Completion/Source/ObjectMethodSource.php new file mode 100644 index 000000000..805820c31 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/ObjectMethodSource.php @@ -0,0 +1,83 @@ +prefix, '__') === 0; + + // Prefer runtime value if available + if ($analysis->leftSideValue !== null && \is_object($analysis->leftSideValue)) { + return $this->filterMethods(\get_class_methods($analysis->leftSideValue), $includeMagic); + } + + if (empty($analysis->leftSideTypes)) { + return []; + } + + $methods = []; + foreach ($analysis->leftSideTypes as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + foreach ($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) { + $methods[] = $method->getName(); + } + } + + return $this->filterMethods(\array_unique($methods), $includeMagic); + } + + /** + * Filter method names, hiding magic methods unless explicitly requested. + * + * @param string[] $methods + * + * @return string[] + */ + private function filterMethods(array $methods, bool $includeMagic): array + { + if (!$includeMagic) { + $methods = \array_filter($methods, fn ($method) => \strpos($method, '__') !== 0); + } + + return \array_values($methods); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/ObjectPropertySource.php b/app/vendor/psy/psysh/src/Completion/Source/ObjectPropertySource.php new file mode 100644 index 000000000..849cd4af0 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/ObjectPropertySource.php @@ -0,0 +1,62 @@ +leftSideValue !== null && \is_object($analysis->leftSideValue)) { + return \array_keys(\get_object_vars($analysis->leftSideValue)); + } + + if (empty($analysis->leftSideTypes)) { + return []; + } + + $properties = []; + foreach ($analysis->leftSideTypes as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + foreach ($reflection->getProperties(\ReflectionProperty::IS_PUBLIC) as $property) { + $properties[] = $property->getName(); + } + } + + return \array_values(\array_unique($properties)); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/PropertySource.php b/app/vendor/psy/psysh/src/Completion/Source/PropertySource.php new file mode 100644 index 000000000..169333964 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/PropertySource.php @@ -0,0 +1,63 @@ +` operator. + */ +class PropertySource implements SourceInterface +{ + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::OBJECT_PROPERTY) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + if (empty($analysis->leftSideTypes)) { + return []; + } + + $allCompletions = []; + + foreach ($analysis->leftSideTypes as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + $properties = $reflection->getProperties(\ReflectionProperty::IS_PUBLIC); + + foreach ($properties as $property) { + $allCompletions[] = $property->getName(); + } + } + + // Return all properties (fuzzy matching in CompletionEngine will filter) + $allCompletions = \array_unique($allCompletions); + \sort($allCompletions); + + return $allCompletions; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/SourceInterface.php b/app/vendor/psy/psysh/src/Completion/Source/SourceInterface.php new file mode 100644 index 000000000..bf9013006 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/SourceInterface.php @@ -0,0 +1,58 @@ +prefix for optimization but are not required + * to filter by it. CompletionEngine applies fuzzy matching to all results. + * + * @return string[] Array of completion strings + */ + public function getCompletions(AnalysisResult $analysis): array; +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/StaticMethodSource.php b/app/vendor/psy/psysh/src/Completion/Source/StaticMethodSource.php new file mode 100644 index 000000000..11453d7ae --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/StaticMethodSource.php @@ -0,0 +1,69 @@ +leftSideTypes)) { + return []; + } + + $includeMagic = \strpos($analysis->prefix, '__') === 0; + + $methods = []; + foreach ($analysis->leftSideTypes as $type) { + try { + $reflection = new \ReflectionClass($type); + } catch (\ReflectionException $e) { + continue; + } + + foreach ($reflection->getMethods(\ReflectionMethod::IS_PUBLIC) as $method) { + if ($method->isStatic()) { + $methods[] = $method->getName(); + } + } + } + + $methods = \array_unique($methods); + + if (!$includeMagic) { + $methods = \array_filter($methods, fn ($method) => \strpos($method, '__') !== 0); + } + + return \array_values($methods); + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/StaticPropertySource.php b/app/vendor/psy/psysh/src/Completion/Source/StaticPropertySource.php new file mode 100644 index 000000000..170616861 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/StaticPropertySource.php @@ -0,0 +1,68 @@ +leftSideTypes)) { + return []; + } + + $allProperties = []; + foreach ($analysis->leftSideTypes as $type) { + $properties = $this->getStaticPropertiesFromClass($type); + $allProperties = \array_merge($allProperties, $properties); + } + + return \array_values(\array_unique($allProperties)); + } + + /** + * Get static properties from a class using reflection. + * + * @return string[] + */ + private function getStaticPropertiesFromClass(string $className): array + { + try { + $reflection = new \ReflectionClass($className); + $properties = $reflection->getProperties(\ReflectionProperty::IS_PUBLIC); + $staticProperties = \array_filter($properties, fn ($p) => $p->isStatic()); + + return \array_values(\array_map(fn ($p) => $p->getName(), $staticProperties)); + } catch (\ReflectionException $e) { + return []; + } + } +} diff --git a/app/vendor/psy/psysh/src/Completion/Source/VariableSource.php b/app/vendor/psy/psysh/src/Completion/Source/VariableSource.php new file mode 100644 index 000000000..94002617b --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/Source/VariableSource.php @@ -0,0 +1,51 @@ +context = $context; + } + + /** + * {@inheritdoc} + */ + public function appliesToKind(int $kinds): bool + { + return ($kinds & CompletionKind::VARIABLE) !== 0; + } + + /** + * {@inheritdoc} + */ + public function getCompletions(AnalysisResult $analysis): array + { + // Always return all variables (typically small set, fuzzy matching will handle filtering) + $variables = \array_keys($this->context->getAll()); + \sort($variables); + + return $variables; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/SymbolCatalog.php b/app/vendor/psy/psysh/src/Completion/SymbolCatalog.php new file mode 100644 index 000000000..157c12460 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/SymbolCatalog.php @@ -0,0 +1,215 @@ +refreshIfNeeded(); + + return $this->version; + } + + /** + * @return string[] + */ + public function getClasses(): array + { + $this->refreshIfNeeded(); + + return $this->snapshot['classes']; + } + + /** + * @return string[] + */ + public function getInterfaces(): array + { + $this->refreshIfNeeded(); + + return $this->snapshot['interfaces']; + } + + /** + * @return string[] + */ + public function getTraits(): array + { + $this->refreshIfNeeded(); + + return $this->snapshot['traits']; + } + + /** + * @return string[] + */ + public function getFunctions(): array + { + $this->refreshIfNeeded(); + + return $this->snapshot['functions']; + } + + /** + * @return string[] + */ + public function getConstants(): array + { + $this->refreshIfNeeded(); + + return $this->snapshot['constants']; + } + + /** + * @return string[] + */ + public function getNamespaces(): array + { + $this->refreshIfNeeded(); + + return $this->snapshot['namespaces']; + } + + /** + * @return string[] + */ + public function getAttributeClasses(): array + { + $this->refreshIfNeeded(); + + return $this->snapshot['attributes']; + } + + private function refreshIfNeeded(): void + { + $classes = \get_declared_classes(); + $interfaces = \get_declared_interfaces(); + $traits = \get_declared_traits(); + $functions = \get_defined_functions(); + $constants = \array_keys(\get_defined_constants()); + + $version = \implode(':', [ + \count($classes), + \count($interfaces), + \count($traits), + \count($functions['user']), + \count($functions['internal']), + \count($constants), + ]); + + if ($this->version === $version && !empty($this->snapshot)) { + return; + } + + $allFunctions = \array_merge($functions['user'], $functions['internal']); + \sort($classes); + \sort($interfaces); + \sort($traits); + \sort($allFunctions); + \sort($constants); + + $namespaces = $this->extractNamespaces($classes, $interfaces, $traits); + \sort($namespaces); + + $attributes = $this->extractAttributes($classes); + \sort($attributes); + + $this->snapshot = [ + 'classes' => $classes, + 'interfaces' => $interfaces, + 'traits' => $traits, + 'functions' => $allFunctions, + 'constants' => $constants, + 'namespaces' => $namespaces, + 'attributes' => $attributes, + ]; + $this->version = $version; + } + + /** + * @param string[] $classes + * @param string[] $interfaces + * @param string[] $traits + * + * @return string[] + */ + private function extractNamespaces(array $classes, array $interfaces, array $traits): array + { + $classLikes = \array_merge($classes, $interfaces, $traits); + $namespaces = []; + + foreach ($classLikes as $className) { + $parts = \explode('\\', $className); + if (\count($parts) < 2) { + continue; + } + + \array_pop($parts); + + $namespace = ''; + foreach ($parts as $part) { + if ($namespace !== '') { + $namespace .= '\\'; + } + $namespace .= $part; + $namespaces[$namespace] = true; + } + } + + return \array_keys($namespaces); + } + + /** + * @param string[] $classes + * + * @return string[] + */ + private function extractAttributes(array $classes): array + { + if (\PHP_VERSION_ID < 80000 || !\class_exists('Attribute', false)) { + return []; + } + + $attributes = []; + foreach ($classes as $className) { + try { + $reflection = new \ReflectionClass($className); + if (!\method_exists($reflection, 'getAttributes')) { + continue; + } + + // @phan-suppress-next-line PhanUndeclaredMethod - available on PHP 8+, guarded by method_exists + $classAttributes = $reflection->getAttributes('Attribute'); + if (!empty($classAttributes)) { + $attributes[] = $className; + } + } catch (\ReflectionException $e) { + // Skip classes that cannot be reflected. + } + } + + return $attributes; + } +} diff --git a/app/vendor/psy/psysh/src/Completion/TypeResolver.php b/app/vendor/psy/psysh/src/Completion/TypeResolver.php new file mode 100644 index 000000000..ddc3d9470 --- /dev/null +++ b/app/vendor/psy/psysh/src/Completion/TypeResolver.php @@ -0,0 +1,946 @@ +context = $context; + $this->cleaner = $cleaner; + $this->parser = (new ParserFactory())->createParser(); + } + + /** + * Resolve all possible types of an expression (supports union types). + * + * For expressions that resolve to a union type (e.g., Address|City), + * returns all non-scalar types in the union. + * + * @return string[] Array of fully-qualified class names + */ + public function resolveTypes(string $expression): array + { + $expression = \trim($expression); + + if ($expression === '') { + return []; + } + + $parsedTypes = $this->resolveTypesFromParsedExpression($expression); + if (!empty($parsedTypes)) { + return $parsedTypes; + } + + $cleanedExpression = $this->cleanIncompleteExpression($expression); + if ($cleanedExpression === '') { + return []; + } + + if ($cleanedExpression !== $expression) { + $cleanedTypes = $this->resolveTypesFromParsedExpression($cleanedExpression); + if (!empty($cleanedTypes)) { + return $cleanedTypes; + } + } + + if ($cleanedExpression[0] === '$') { + $type = $this->resolveVariableType($cleanedExpression); + + if ($type !== null && !$this->isScalarOrNull($type)) { + return [$type]; + } + + return []; + } + + // Special keywords must come before isClassName check + if (\in_array(\strtolower($cleanedExpression), ['self', 'static', 'parent'])) { + $type = $this->resolveSpecialKeyword($cleanedExpression); + + return $type !== null ? [$type] : []; + } + + if ($this->isClassName($cleanedExpression)) { + return [$this->resolveClassName($cleanedExpression)]; + } + + return []; + } + + /** + * Resolve all possible types from an AST node. + * + * Falls back to string parsing for tokenizer-only contexts where we don't + * have a parseable node. + * + * @param Node $node Parsed expression node + * @param string|null $fallbackExpression Fallback expression for non-parse cases + * + * @return string[] Array of fully-qualified class names + */ + public function resolveNodeTypes(Node $node, ?string $fallbackExpression = null): array + { + $types = $this->resolveExpressionTypes($node); + if (!empty($types)) { + return $types; + } + + if ($fallbackExpression !== null && $fallbackExpression !== '') { + return $this->resolveTypes($fallbackExpression); + } + + return []; + } + + /** + * Resolve the actual runtime value of an expression. + * + * Currently only resolves simple variables ($foo). Method chains and + * complex expressions are not evaluated to avoid side effects. + * + * @return mixed The actual value, or null if it can't be resolved + */ + public function resolveValue(string $expression) + { + $expression = \trim($expression); + + if ($expression === '' || \strpos($expression, '$') !== 0) { + return null; + } + + $varName = \ltrim($expression, '$'); + + try { + return $this->context->get($varName); + } catch (\InvalidArgumentException $e) { + return null; + } + } + + /** + * Clean up incomplete/malformed expressions to extract the completable part. + * + * Handles cases like: + * - $user| -> $user + * - $user . " -> $user + * - [$user -> $user + * - if (true) { $user -> $user + * - $x + $user -> $user + * + * Uses tokenization to find the last complete variable or chain expression. + * + * @return string Cleaned expression (may be empty if nothing extractable) + */ + private function cleanIncompleteExpression(string $expression): string + { + if (\strpos($expression, '$') === false) { + return $expression; + } + + // For method chains, check if they parse cleanly first. If so, return + // as-is and let resolution handle incomplete identifiers via union types. + if (\strpos($expression, '->') !== false) { + try { + $this->parser->parse(' chains + for ($j = $i + 1; $j < \count($tokens); $j++) { + $nextToken = $tokens[$j]; + + if (\is_array($nextToken) && $nextToken[0] === \T_WHITESPACE) { + continue; + } + + if (!$this->isObjectAccessOperatorToken($nextToken)) { + break; + } + + // Found ->, look for identifier + for ($k = $j + 1; $k < \count($tokens); $k++) { + $afterArrow = $tokens[$k]; + + if (\is_array($afterArrow) && $afterArrow[0] === \T_WHITESPACE) { + continue; + } + + if (!(\is_array($afterArrow) && $afterArrow[0] === \T_STRING)) { + break; + } + + $chainEnd = $k; + + // Check for parenthesized call + for ($m = $k + 1; $m < \count($tokens); $m++) { + $parenToken = $tokens[$m]; + + if (\is_array($parenToken) && $parenToken[0] === \T_WHITESPACE) { + continue; + } + + if ($parenToken === '(') { + $depth = 1; + $foundClose = false; + for ($n = $m + 1; $n < \count($tokens); $n++) { + if ($tokens[$n] === '(') { + $depth++; + } elseif ($tokens[$n] === ')') { + $depth--; + if ($depth === 0) { + $chainEnd = $n; + $foundClose = true; + break; + } + } + } + + if (!$foundClose) { + $hasIncompleteCall = true; + } + } + + break; + } + + $i = $chainEnd; + break; + } + } + + $variables[] = [ + 'start' => $varStart, + 'end' => $chainEnd, + 'hasIncompleteCall' => $hasIncompleteCall, + ]; + } + + if (empty($variables)) { + return ''; + } + + $lastVar = \end($variables); + $extractedTokens = \array_slice($tokens, $lastVar['start'], $lastVar['end'] - $lastVar['start'] + 1); + + $parts = []; + $strippedIncompleteCall = $lastVar['hasIncompleteCall']; + + foreach ($extractedTokens as $token) { + if (\is_array($token)) { + $parts[] = $token[1]; + continue; + } + + // Stop at incomplete opening paren (no matching close) + if ($token === '(') { + $hasClose = false; + foreach ($extractedTokens as $t) { + if ($t === ')') { + $hasClose = true; + break; + } + } + if (!$hasClose) { + $strippedIncompleteCall = true; + break; + } + } + + $parts[] = $token; + } + + $result = \trim(\implode('', $parts)); + + // Complete stripped incomplete calls so they parse as method calls + if ($strippedIncompleteCall && $result !== '' && \substr($result, -2) !== '()') { + $result .= '()'; + } + + if ($result !== '' && $this->isFollowedByNonCompletableOperator($expression, $result)) { + return ''; + } + + return $result; + } + + /** + * Parse an expression and resolve types directly from its AST. + * + * Returns null if the expression cannot be parsed. + * + * @return string[]|null + */ + private function resolveTypesFromParsedExpression(string $expression): ?array + { + try { + $stmts = $this->parser->parse('resolveExpressionTypes($stmts[0]->expr); + } + + /** + * Check whether a token is -> or ?->. + * + * @param mixed $token Token from token_get_all + */ + private function isObjectAccessOperatorToken($token): bool + { + if (!\is_array($token)) { + return false; + } + + if ($token[0] === \T_OBJECT_OPERATOR) { + return true; + } + + if (\defined('T_NULLSAFE_OBJECT_OPERATOR')) { + /** @var int $nullsafeToken */ + $nullsafeToken = \constant('T_NULLSAFE_OBJECT_OPERATOR'); + + return $token[0] === $nullsafeToken; + } + + return false; + } + + /** + * Check if an identifier looks like an incomplete identifier (for tab completion). + * + * Short identifiers or common prefixes are likely incomplete during tab completion. + * + * @param string $identifier The identifier to check + * + * @return bool True if likely incomplete + */ + private function looksLikeIncompleteIdentifier(string $identifier): bool + { + // Very short identifiers (1-5 chars) are often incomplete + if (\strlen($identifier) <= 5) { + return true; + } + + // Common method prefixes that might be incomplete (6-7 chars) + // e.g., "getCit" (6 chars) vs "nonExistent" (11 chars) + $incompletePrefixes = ['get', 'set', 'is', 'has', 'can', 'find']; + + foreach ($incompletePrefixes as $prefix) { + if (\stripos($identifier, $prefix) === 0 && \strlen($identifier) <= 7) { + return true; + } + } + + return false; + } + + /** + * Check if an extracted expression is followed by operators that mean + * we shouldn't provide type completion. + * + * E.g., "$user . \""; user is concatenating, not completing + * + * @param string $original Original full expression + * @param string $extracted Extracted variable/chain + * + * @return bool True if followed by non-completable operator + */ + private function isFollowedByNonCompletableOperator(string $original, string $extracted): bool + { + $pos = \strpos($original, $extracted); + if ($pos === false) { + return false; + } + + $afterExtracted = \ltrim(\substr($original, $pos + \strlen($extracted))); + + if ($afterExtracted === '' || \strpos($afterExtracted, '->') === 0) { + return false; + } + + $nonCompletableOps = ['|', '.', '+', '-', '*', '/', '%', '&', '^', '~', '<', '>', '=', '!', '?', ':']; + + return \in_array($afterExtracted[0], $nonCompletableOps, true); + } + + /** + * Resolve all possible types of an AST expression node (supports union types). + * + * This is the core method that walks the AST tree and resolves types. + * + * @return string[] Array of fully-qualified class names + */ + private function resolveExpressionTypes($expr): array + { + if ( + $expr instanceof MethodCall + || $expr instanceof PropertyFetch + || $expr instanceof NullsafeMethodCall + || $expr instanceof NullsafePropertyFetch + ) { + return $this->resolveObjectMemberTypes($expr); + } + + if ($expr instanceof StaticCall) { + $classTypes = $this->resolveExpressionTypes($expr->class); + $methodName = $expr->name instanceof Identifier ? $expr->name->name : null; + + if (empty($classTypes) || $methodName === null) { + return []; + } + + return $this->resolveTypesAcrossClasses($classTypes, fn ($class) => $this->resolveMethodReturnTypes($class, $methodName)); + } + + if ($expr instanceof StaticPropertyFetch) { + $classTypes = $this->resolveExpressionTypes($expr->class); + $propertyName = $expr->name instanceof Identifier ? $expr->name->name : null; + + if ($propertyName === null && $expr->name instanceof Variable && \is_string($expr->name->name)) { + $propertyName = $expr->name->name; + } + + if (empty($classTypes) || $propertyName === null) { + return []; + } + + return $this->resolveTypesAcrossClasses($classTypes, fn ($class) => $this->resolvePropertyTypes($class, $propertyName)); + } + + if ($expr instanceof Variable && \is_string($expr->name)) { + $type = $this->resolveVariableType('$'.$expr->name); + + if ($type === null || $this->isScalarOrNull($type)) { + return []; + } + + return [$type]; + } + + if ($expr instanceof Name) { + $className = $expr->toString(); + + if (\in_array(\strtolower($className), ['self', 'static', 'parent'])) { + $type = $this->resolveSpecialKeyword($className); + + return $type !== null ? [$type] : []; + } + + return [$this->resolveClassName($className)]; + } + + if ($expr instanceof Node\Expr\Ternary) { + // Short ternary ($x ?: $y) uses the condition as the "if" branch + $ifTypes = $expr->if !== null + ? $this->resolveExpressionTypes($expr->if) + : $this->resolveExpressionTypes($expr->cond); + + $elseTypes = $expr->else !== null + ? $this->resolveExpressionTypes($expr->else) + : []; + + return \array_values(\array_unique(\array_merge($ifTypes, $elseTypes))); + } + + return []; + } + + /** + * Resolve types for an object member access (method call or property fetch). + * + * Handles the common pattern of resolving the object's types, looking up the + * member, and falling back to parent types for incomplete identifiers during + * tab completion. + * + * @param MethodCall|PropertyFetch|NullsafeMethodCall|NullsafePropertyFetch $expr + * + * @return string[] Array of fully-qualified class names + */ + private function resolveObjectMemberTypes($expr): array + { + $objectTypes = $this->resolveExpressionTypes($expr->var); + if (empty($objectTypes)) { + return []; + } + + $memberName = $expr->name instanceof Identifier ? $expr->name->name : null; + if ($memberName === null) { + return []; + } + + $isMethod = $expr instanceof MethodCall || $expr instanceof NullsafeMethodCall; + $reflectionCheck = $isMethod ? 'hasMethod' : 'hasProperty'; + + $memberExists = false; + foreach ($objectTypes as $objectType) { + try { + $reflection = new \ReflectionClass($objectType); + if ($reflection->$reflectionCheck($memberName)) { + $memberExists = true; + break; + } + } catch (\ReflectionException $e) { + // Class doesn't exist + } + } + + $resolver = $isMethod + ? fn ($class) => $this->resolveMethodReturnTypes($class, $memberName) + : fn ($class) => $this->resolvePropertyTypes($class, $memberName); + + $resolvedTypes = $this->resolveTypesAcrossClasses($objectTypes, $resolver); + + // For tab completion: if member doesn't exist and looks incomplete, + // return the parent object types so completion can suggest matching members + if (empty($resolvedTypes) && !$memberExists && $this->looksLikeIncompleteIdentifier($memberName)) { + return $objectTypes; + } + + return $resolvedTypes; + } + + /** + * Resolve types by applying a resolver callback across multiple class names. + * + * @param string[] $classTypes Array of class names to resolve across + * @param callable $resolver Callback that takes a class name and returns string[] + * + * @return string[] Array of unique fully-qualified class names + */ + private function resolveTypesAcrossClasses(array $classTypes, callable $resolver): array + { + $types = []; + foreach ($classTypes as $classType) { + $types = \array_merge($types, $resolver($classType)); + } + + return \array_values(\array_unique($types)); + } + + /** + * Resolve all possible return types of a method (supports union types). + * + * @param string $className Fully-qualified class name + * @param string $methodName Method name + * + * @return string[] Array of fully-qualified class names + */ + private function resolveMethodReturnTypes(string $className, string $methodName): array + { + try { + $reflection = new \ReflectionClass($className); + } catch (\ReflectionException $e) { + return []; + } + + if (!$reflection->hasMethod($methodName)) { + return []; + } + + try { + $method = $reflection->getMethod($methodName); + } catch (\ReflectionException $e) { + return []; + } + + if ($method->hasReturnType()) { + $returnType = $method->getReturnType(); + if (!$returnType instanceof \ReflectionType) { + return []; + } + + return $this->extractClassNamesFromType($returnType, $reflection); + } + + return $this->resolveReturnTypesFromDocblock($method, $reflection); + } + + /** + * Resolve all possible types of a property (supports union types). + * + * @param string $className Fully-qualified class name + * @param string $propertyName Property name + * + * @return string[] Array of fully-qualified class names + */ + private function resolvePropertyTypes(string $className, string $propertyName): array + { + try { + $reflection = new \ReflectionClass($className); + } catch (\ReflectionException $e) { + return []; + } + + if (!$reflection->hasProperty($propertyName)) { + return []; + } + + try { + $property = $reflection->getProperty($propertyName); + } catch (\ReflectionException $e) { + return []; + } + + if ($property->hasType()) { + $type = $property->getType(); + if (!$type instanceof \ReflectionType) { + return []; + } + + return $this->extractClassNamesFromType($type, $reflection); + } + + return $this->resolvePropertyTypesFromDocblock($property, $reflection); + } + + /** + * Extract all class names from a ReflectionType (handles all composite types). + * + * Recursively processes: + * - Named types: Returns class name if not builtin + * - Union types (A|B): Returns all class names from union members + * - Intersection types (A&B): Returns all class names (completion shows both) + * - DNF types ((A&B)|C): Returns all class names from nested types + * + * For completion purposes, we're liberal: any mentioned class is a valid + * completion candidate, even if the actual runtime type is more restrictive. + * + * @param \ReflectionType $type The reflection type to extract from + * @param \ReflectionClass $classContext Class context for resolving relative names + * + * @return string[] Array of fully-qualified class names + */ + private function extractClassNamesFromType(\ReflectionType $type, \ReflectionClass $classContext): array + { + if ($type instanceof \ReflectionNamedType) { + if ($type->isBuiltin()) { + return []; + } + + return [$this->resolveTypeName($type->getName(), $classContext)]; + } + + $compositeTypes = $this->getCompositeTypes($type); + if (!empty($compositeTypes)) { + $types = []; + foreach ($compositeTypes as $compositeType) { + $types = \array_merge($types, $this->extractClassNamesFromType($compositeType, $classContext)); + } + + return \array_values(\array_unique($types)); + } + + return []; + } + + /** + * Safely fetch child types for composite reflection types (union/intersection/DNF). + * + * @return \ReflectionType[] + */ + private function getCompositeTypes(\ReflectionType $type): array + { + if (!\method_exists($type, 'getTypes')) { + return []; + } + + // @phan-suppress-next-line PhanUndeclaredMethod, available for composite types, guarded by method_exists + $types = $type->getTypes(); + + if (!\is_array($types)) { + return []; + } + + return \array_values(\array_filter($types, fn ($candidate) => $candidate instanceof \ReflectionType)); + } + + /** + * Resolve a type name in the context of a class (handle relative names). + * + * @param string $typeName Type name (might be relative: "Foo" or absolute: "\Foo\Bar") + * @param \ReflectionClass $classContext The class context for resolving relative names + * + * @return string Fully-qualified class name + */ + private function resolveTypeName(string $typeName, \ReflectionClass $classContext): string + { + if (\in_array(\strtolower($typeName), ['self', 'static'])) { + return $classContext->getName(); + } + + if (\strtolower($typeName) === 'parent') { + $parent = $classContext->getParentClass(); + + return $parent ? $parent->getName() : $typeName; + } + + if ($typeName[0] === '\\') { + return \ltrim($typeName, '\\'); + } + + // PHP ReflectionType returns FQN without leading backslash + if (\class_exists($typeName) || \interface_exists($typeName) || \trait_exists($typeName)) { + return $typeName; + } + + $namespace = $classContext->getNamespaceName(); + if ($namespace) { + $fqn = $namespace.'\\'.$typeName; + if (\class_exists($fqn) || \interface_exists($fqn) || \trait_exists($fqn)) { + return $fqn; + } + } + + return $typeName; + } + + /** + * Resolve return types from @return docblock (supports union types). + * + * @return string[] Array of fully-qualified class names + */ + private function resolveReturnTypesFromDocblock(\ReflectionMethod $method, \ReflectionClass $classContext): array + { + $docblock = new Docblock($method); + + if (empty($docblock->tags['return'])) { + return []; + } + + $returnTag = $docblock->tags['return'][0]; + if (!isset($returnTag['type'])) { + return []; + } + + return $this->parseDocblockTypes($returnTag['type'], $classContext); + } + + /** + * Resolve property types from @var docblock (supports union types). + * + * @return string[] Array of fully-qualified class names + */ + private function resolvePropertyTypesFromDocblock(\ReflectionProperty $property, \ReflectionClass $classContext): array + { + $docblock = new Docblock($property); + + if (empty($docblock->tags['var'])) { + return []; + } + + $varTag = $docblock->tags['var'][0]; + if (!isset($varTag['type'])) { + return []; + } + + return $this->parseDocblockTypes($varTag['type'], $classContext); + } + + /** + * Parse a docblock type string and resolve to fully-qualified class names (supports unions). + * + * Handles: + * - Simple types: "Foo", "\\Foo\\Bar" + * - Nullable types: "?Foo" + * - Union types: "Foo|Bar|null" (returns ALL non-scalar types) + * - Array types: "Foo[]" (returns empty since we can't determine array element type) + * - Generic types: "array" or "Collection" (extracts Foo) + * + * @param string $typeString The type from docblock + * @param \ReflectionClass $classContext Context for resolving relative names + * + * @return string[] Array of fully-qualified class names + */ + private function parseDocblockTypes(string $typeString, \ReflectionClass $classContext): array + { + $typeString = \trim($typeString); + if ($typeString === '') { + return []; + } + + if ($typeString[0] === '?') { + $typeString = \substr($typeString, 1); + } + + if (\strpos($typeString, '|') !== false) { + $result = []; + foreach (\explode('|', $typeString) as $type) { + $type = \trim($type); + if (!$this->isScalarOrNull($type)) { + $result = \array_merge($result, $this->parseDocblockTypes($type, $classContext)); + } + } + + return \array_values(\array_unique($result)); + } + + if (\substr($typeString, -2) === '[]') { + return []; + } + + if (\preg_match('/^[\w\\\\]+<(.+)>$/', $typeString, $matches)) { + return $this->parseDocblockTypes($matches[1], $classContext); + } + + if ($this->isScalarOrNull($typeString)) { + return []; + } + + return [$this->resolveTypeName($typeString, $classContext)]; + } + + /** + * Check if a type string represents a scalar or null. + * + * @return bool + */ + private function isScalarOrNull(string $type): bool + { + return \in_array(\strtolower($type), self::SCALAR_TYPES, true); + } + + /** + * Resolve type of a variable. + */ + private function resolveVariableType(string $variable): ?string + { + $varName = \ltrim($variable, '$'); + + try { + $value = $this->context->get($varName); + + return \is_object($value) ? \get_class($value) : \gettype($value); + } catch (\InvalidArgumentException $e) { + return null; + } + } + + /** + * Resolve a class name (handle namespaces and use statements). + */ + private function resolveClassName(string $name): string + { + if (\strpos($name, '\\') === 0) { + return $name; + } + + if ($this->cleaner !== null) { + $resolved = $this->cleaner->resolveClassName($name); + if ($resolved !== $name) { + return $resolved; + } + } + + return $name; + } + + /** + * Resolve special keywords (self, static, parent). + */ + private function resolveSpecialKeyword(string $keyword): ?string + { + $keyword = \strtolower($keyword); + + $boundClass = $this->context->getBoundClass(); + if ($boundClass === null) { + $boundObject = $this->context->getBoundObject(); + $boundClass = $boundObject !== null ? \get_class($boundObject) : null; + } + + if ($boundClass === null) { + return null; + } + + if ($keyword === 'self' || $keyword === 'static') { + return $boundClass; + } + + if ($keyword === 'parent') { + $parent = (new \ReflectionClass($boundClass))->getParentClass(); + + return $parent ? $parent->getName() : null; + } + + return null; + } + + /** + * Check if a string looks like a class name. + */ + private function isClassName(string $name): bool + { + return \preg_match('/^[\\\\a-zA-Z_][\\\\a-zA-Z0-9_]*$/', $name) === 1; + } +} diff --git a/app/vendor/psy/psysh/src/ConfigPaths.php b/app/vendor/psy/psysh/src/ConfigPaths.php index 2d2ffa2c3..e299e6d79 100644 --- a/app/vendor/psy/psysh/src/ConfigPaths.php +++ b/app/vendor/psy/psysh/src/ConfigPaths.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -28,8 +28,8 @@ class ConfigPaths * * @see self::overrideDirs * - * @param string[] $overrides Directory overrides - * @param EnvInterface $env + * @param string[] $overrides Directory overrides + * @param EnvInterface|null $env */ public function __construct(array $overrides = [], ?EnvInterface $env = null) { @@ -184,6 +184,95 @@ public function dataDirs(): array return $this->allDirNames(\array_merge([$homeDataDir], $dataDirs)); } + /** + * Get the current home data directory. + * + * Returns the highest precedence home data directory which actually + * exists and is writable. If none of them exists, returns the highest + * precedence home data directory. + */ + public function currentDataDir(): ?string + { + if ($this->dataDir !== null) { + return $this->dataDir; + } + + $dataDirs = $this->dataDirs(); + + // Find first writable directory + foreach ($dataDirs as $dir) { + if (@\is_dir($dir) && @\is_writable($dir)) { + return $dir; + } + } + + // Return first (user) directory even if it doesn't exist yet + return $dataDirs[0] ?? null; + } + + /** + * Get the local config root directory (cwd only, no ancestor walking). + * + * Used for local `.psysh.php` config file detection. Returns the current + * working directory, or null if getcwd() fails. + */ + public function localConfigRoot(): ?string + { + $cwd = \getcwd(); + if ($cwd === false) { + return null; + } + + return \strtr($cwd, '\\', '/'); + } + + /** + * Find a project root for trust decisions. + * + * Walks up ancestors to find the nearest composer.json or composer.lock. + * If none found, falls back to the nearest .psysh.php, then to the current + * working directory. + * + * Used for trust decisions on Composer autoload and project-level features. + */ + public function projectRoot(?string $cwd = null): ?string + { + $cwd = $cwd ?? \getcwd(); + if ($cwd === false) { + return null; + } + + $dir = \strtr($cwd, '\\', '/'); + $root = null; + $localConfigRoot = null; + + $current = $dir; + $parent = \dirname($current); + + while ($current !== $parent) { + if ($root === null && (@\is_file($current.'/composer.json') || @\is_file($current.'/composer.lock'))) { + $root = $current; + } + + if ($localConfigRoot === null && @\is_file($current.'/.psysh.php')) { + $localConfigRoot = $current; + } + + $current = $parent; + $parent = \dirname($current); + } + + if ($root !== null) { + return $root; + } + + if ($localConfigRoot !== null) { + return $localConfigRoot; + } + + return $dir; + } + /** * Find real data files in config directories. * @@ -263,9 +352,7 @@ public function which($command): ?string private function allDirNames(array $baseDirs): array { $baseDirs = \array_filter($baseDirs); - $dirs = \array_map(function ($dir) { - return \strtr($dir, '\\', '/').'/psysh'; - }, $baseDirs); + $dirs = \array_map(fn ($dir) => \strtr($dir, '\\', '/').'/psysh', $baseDirs); // Add ~/.psysh if ($home = $this->getEnv('HOME')) { @@ -311,6 +398,44 @@ private function allRealFiles(array $dirNames, array $fileNames): array return $files; } + /** + * Make a path prettier by replacing cwd with . or home directory with ~. + * + * @param string|mixed $path Path to prettify + * @param string|null $relativeTo Directory to make path relative to (defaults to cwd) + * @param string|null $homeDir Home directory to replace with ~ (defaults to actual home) + * + * @return string|mixed Pretty path, or original value if not a string + */ + public static function prettyPath($path, ?string $relativeTo = null, ?string $homeDir = null) + { + if (!\is_string($path)) { + return $path; + } + + $path = \strtr($path, '\\', '/'); + + // Try replacing relativeTo directory first (more specific) + $relativeTo = $relativeTo ?: \getcwd(); + if ($relativeTo !== false) { + $relativeTo = \rtrim(\strtr($relativeTo, '\\', '/'), '/').'/'; + if (\strpos($path, $relativeTo) === 0) { + return './'.\substr($path, \strlen($relativeTo)); + } + } + + // Fall back to replacing home directory + $homeDir = $homeDir ?: (new self())->homeDir(); + if ($homeDir && $homeDir !== '/') { + $homeDir = \rtrim(\strtr($homeDir, '\\', '/'), '/').'/'; + if (\strpos($path, $homeDir) === 0) { + return '~/'.\substr($path, \strlen($homeDir)); + } + } + + return $path; + } + /** * Ensure that $dir exists and is writable. * diff --git a/app/vendor/psy/psysh/src/Configuration.php b/app/vendor/psy/psysh/src/Configuration.php index e2fa79fca..fe384f349 100644 --- a/app/vendor/psy/psysh/src/Configuration.php +++ b/app/vendor/psy/psysh/src/Configuration.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,13 +11,27 @@ namespace Psy; +use Psy\Clipboard\ClipboardMethod; +use Psy\Clipboard\CommandClipboardMethod; +use Psy\Clipboard\NullClipboardMethod; +use Psy\Clipboard\Osc52ClipboardMethod; use Psy\Exception\DeprecatedException; +use Psy\Exception\InvalidManualException; use Psy\Exception\RuntimeException; +use Psy\ExecutionLoop\ExecutionLoggingListener; +use Psy\ExecutionLoop\InputLoggingListener; use Psy\ExecutionLoop\ProcessForker; +use Psy\Formatter\SignatureFormatter; +use Psy\Logger\CallbackLogger; +use Psy\Manual\ManualInterface; +use Psy\Manual\V2Manual; +use Psy\Manual\V3Manual; use Psy\Output\OutputPager; use Psy\Output\ShellOutput; use Psy\Output\Theme; +use Psy\Readline\Interactive\Input\History as InteractiveHistory; use Psy\TabCompletion\AutoCompleter; +use Psy\Util\Tty; use Psy\VarDumper\Presenter; use Psy\VersionUpdater\Checker; use Psy\VersionUpdater\GitHubChecker; @@ -26,6 +40,7 @@ use Symfony\Component\Console\Formatter\OutputFormatterStyle; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\ConsoleOutput; use Symfony\Component\Console\Output\OutputInterface; /** @@ -41,12 +56,26 @@ class Configuration const INTERACTIVE_MODE_FORCED = 'forced'; const INTERACTIVE_MODE_DISABLED = 'disabled'; + const PROJECT_TRUST_PROMPT = 'prompt'; + const PROJECT_TRUST_ALWAYS = 'always'; + const PROJECT_TRUST_NEVER = 'never'; + const VERBOSITY_QUIET = 'quiet'; const VERBOSITY_NORMAL = 'normal'; const VERBOSITY_VERBOSE = 'verbose'; const VERBOSITY_VERY_VERBOSE = 'very_verbose'; const VERBOSITY_DEBUG = 'debug'; + const SEMICOLONS_SUPPRESS_RETURN_DOUBLE = 'double'; + + private const KNOWN_CLIPBOARD_COMMANDS = [ + 'wl-copy', + 'xsel --clipboard --input', + 'xclip -selection clipboard', + 'pbcopy', + 'clip.exe', + ]; + private const AVAILABLE_OPTIONS = [ 'codeCleaner', 'colorMode', @@ -54,28 +83,41 @@ class Configuration 'dataDir', 'defaultIncludes', 'eraseDuplicates', + 'exceptionDetails', 'errorLoggingLevel', + 'useExperimentalReadline', + 'useSyntaxHighlighting', + 'useSuggestions', 'forceArrayIndexes', 'formatterStyles', 'historyFile', 'historySize', + 'implicitUse', 'interactiveMode', + 'logging', 'manualDbFile', + 'useDeprecatedMultilineStrings', + 'trustProject', 'pager', 'prompt', 'rawOutput', 'requireSemicolons', 'runtimeDir', + 'semicolonsSuppressReturn', 'startupMessage', 'strictTypes', 'theme', 'updateCheck', + 'updateManualCheck', + 'clipboardCommand', 'useBracketedPaste', + 'useOsc52Clipboard', 'usePcntl', 'useReadline', 'useTabCompletion', 'useUnicode', 'verbosity', + 'warmAutoload', 'warnOnMultipleConfigs', 'yolo', ]; @@ -89,33 +131,50 @@ class Configuration private $historyFile; private int $historySize = 0; private ?bool $eraseDuplicates = null; + private bool $useExperimentalReadline = false; + private bool $useSyntaxHighlighting = true; + private bool $useSuggestions = false; private ?string $manualDbFile = null; private bool $hasReadline; private ?bool $useReadline = null; private bool $useBracketedPaste = false; private bool $hasPcntl; private ?bool $usePcntl = null; - private array $newCommands = []; + private array $commands = []; + private array $matchers = []; + /** @var Completion\Source\SourceInterface[] */ + private array $completionSources = []; private ?bool $pipedInput = null; private ?bool $pipedOutput = null; private bool $rawOutput = false; private bool $requireSemicolons = false; + /** @var bool|string */ + private $semicolonsSuppressReturn = false; private bool $strictTypes = false; + private ?string $clipboardCommand = null; private ?bool $useUnicode = null; private ?bool $useTabCompletion = null; - private array $newMatchers = []; + private bool $useOsc52Clipboard = false; + private ?array $autoloadWarmers = null; + private $implicitUse = false; + private ?ShellLogger $logger = null; + private ?\Closure $exceptionDetails = null; private int $errorLoggingLevel = \E_ALL; private bool $warnOnMultipleConfigs = false; private string $colorMode = self::COLOR_MODE_AUTO; private string $interactiveMode = self::INTERACTIVE_MODE_AUTO; + private ProjectTrust $projectTrust; private ?string $updateCheck = null; + private ?string $updateManualCheck = null; private ?string $startupMessage = null; private bool $forceArrayIndexes = false; + private bool $useDeprecatedMultilineStrings = false; /** @deprecated */ private array $formatterStyles = []; private string $verbosity = self::VERBOSITY_NORMAL; private bool $yolo = false; private ?Theme $theme = null; + private bool $localConfigLoaded = false; // services private ?Readline\Readline $readline = null; @@ -125,9 +184,12 @@ class Configuration /** @var string|OutputPager|false|null */ private $pager = null; private ?\PDO $manualDb = null; + private ?ManualInterface $manual = null; private ?Presenter $presenter = null; + private array $casters = []; private ?AutoCompleter $autoCompleter = null; private ?Checker $checker = null; + private ?ClipboardMethod $clipboard = null; /** @deprecated */ private ?string $prompt = null; private ConfigPaths $configPaths; @@ -142,6 +204,7 @@ class Configuration public function __construct(array $config = []) { $this->configPaths = new ConfigPaths(); + $this->projectTrust = new ProjectTrust($this->configPaths); // explicit configFile option if (isset($config['configFile'])) { @@ -152,6 +215,21 @@ public function __construct(array $config = []) $this->configFile = $configFile; } + $trustOverride = null; + if (isset($config['trustProject'])) { + $this->setTrustProject($config['trustProject']); + $trustOverride = $this->projectTrust->getMode(); + } elseif (isset($_SERVER['PSYSH_TRUST_PROJECT']) && $_SERVER['PSYSH_TRUST_PROJECT'] !== '') { + $this->projectTrust->setModeFromEnv($_SERVER['PSYSH_TRUST_PROJECT']); + $trustOverride = $this->projectTrust->getMode(); + } elseif (\PHP_SAPI === 'cli-server') { + $trust = \getenv('PSYSH_TRUST_PROJECT'); + if ($trust !== false && $trust !== '') { + $this->projectTrust->setModeFromEnv($trust); + $trustOverride = $this->projectTrust->getMode(); + } + } + // legacy baseDir option if (isset($config['baseDir'])) { $msg = "The 'baseDir' configuration option is deprecated; ". @@ -159,10 +237,20 @@ public function __construct(array $config = []) throw new DeprecatedException($msg); } - unset($config['configFile'], $config['baseDir']); + unset( + $config['configFile'], + $config['baseDir'], + $config['trustProject'] + ); // go go gadget, config! $this->loadConfig($config); + + // Ensure that explicit project trust settings are applied + if ($trustOverride !== null && $this->projectTrust->getMode() !== $trustOverride) { + $this->projectTrust->setMode($trustOverride); + } + $this->init(); } @@ -184,7 +272,12 @@ public function __construct(array $config = []) */ public static function fromInput(InputInterface $input): self { - $config = new self(['configFile' => self::getConfigFileFromInput($input)]); + $configOptions = [ + 'configFile' => self::getConfigFileFromInput($input), + 'trustProject' => self::getProjectTrustFromInput($input), + ]; + + $config = new self($configOptions); // Handle --color and --no-color (and --ansi and --no-ansi aliases) if (self::getOptionFromInput($input, ['color', 'ansi'])) { @@ -210,6 +303,18 @@ public static function fromInput(InputInterface $input): self $config->setTheme('compact'); } + // Handle --pager and --no-pager + if (self::hasPagerOption($input)) { + $pager = self::getPagerFromInput($input); + if ($pager === null) { + $config->setDefaultPager(); + } else { + $config->setPager($pager); + } + } elseif (self::getOptionFromInput($input, ['no-pager'])) { + $config->setPager(false); + } + // Handle --raw-output // @todo support raw output with interactive input? if (!$config->getInputInteractive()) { @@ -218,11 +323,21 @@ public static function fromInput(InputInterface $input): self } } + // Handle --warm-autoload + if (self::getOptionFromInput($input, ['warm-autoload'])) { + $config->setWarmAutoload(true); + } + // Handle --yolo if (self::getOptionFromInput($input, ['yolo'])) { $config->setYolo(true); } + // Handle --experimental-readline + if (self::getOptionFromInput($input, ['experimental-readline'])) { + $config->setUseExperimentalReadline(true); + } + return $config; } @@ -241,6 +356,70 @@ private static function getConfigFileFromInput(InputInterface $input) return $input->getParameterOption('--config', null, true) ?: $input->getParameterOption('-c', null, true); } + /** + * Get the desired project trust from the given input. + * + * @return bool|null project trust, or null if none is specified + */ + private static function getProjectTrustFromInput(InputInterface $input): ?bool + { + if (self::getOptionFromInput($input, ['no-trust-project'])) { + return false; + } elseif (self::getOptionFromInput($input, ['trust-project'])) { + return true; + } + + return null; + } + + /** + * Get the desired pager from the given input. + * + * @return string|null pager command, or null to use default pager resolution + */ + private static function getPagerFromInput(InputInterface $input): ?string + { + // Best case, input is properly bound and validated. + if ($input->hasOption('pager')) { + $pager = $input->getOption('pager'); + if (\is_string($pager)) { + return $pager === '' ? null : $pager; + } + + if ($pager === true) { + return null; + } + } + + if ($input->hasParameterOption('--pager', true)) { + $pager = $input->getParameterOption('--pager', null, true); + + if (\is_string($pager) && isset($pager[0]) && $pager[0] === '-') { + return null; + } + + return ($pager === null || $pager === '') ? null : $pager; + } + + return null; + } + + private static function hasPagerOption(InputInterface $input): bool + { + if ($input->hasOption('pager')) { + $pager = $input->getOption('pager'); + if (\is_string($pager) || $pager === true) { + return true; + } + } + + if ($input->hasParameterOption('--pager', true)) { + return true; + } + + return false; + } + /** * Get a boolean option from the given input. * @@ -316,7 +495,7 @@ private static function getVerbosityFromInput(InputInterface $input) case 'vvvvvvv': return self::VERBOSITY_DEBUG; default: // implicitly normal, config file default wins - return; + return null; } } @@ -341,6 +520,8 @@ private static function getVerbosityFromInput(InputInterface $input) if ($input->hasParameterOption('-v', true) || $input->hasParameterOption('--verbose=1', true) || $input->hasParameterOption('--verbose', true)) { return self::VERBOSITY_VERBOSE; } + + return null; } /** @@ -355,6 +536,8 @@ public static function getInputOptions(): array return [ new InputOption('config', 'c', InputOption::VALUE_REQUIRED, 'Use an alternate PsySH config file location.'), new InputOption('cwd', null, InputOption::VALUE_REQUIRED, 'Use an alternate working directory.'), + new InputOption('trust-project', null, InputOption::VALUE_NONE, 'Trust the current project for this run.'), + new InputOption('no-trust-project', null, InputOption::VALUE_NONE, 'Run in Restricted Mode for this project.'), new InputOption('color', null, InputOption::VALUE_NONE, 'Force colors in output.'), new InputOption('no-color', null, InputOption::VALUE_NONE, 'Disable colors in output.'), @@ -370,11 +553,16 @@ public static function getInputOptions(): array // --interaction and --no-interaction aliases for compatibility with Symfony, Composer, etc new InputOption('interaction', null, InputOption::VALUE_NONE, 'Force PsySH to run in interactive mode.'), new InputOption('no-interaction', null, InputOption::VALUE_NONE, 'Run PsySH without interactive input. Requires input from stdin.'), + new InputOption('pager', null, InputOption::VALUE_OPTIONAL, 'Use an alternate output pager command. Without a value, use the default pager selection.', false), + new InputOption('no-pager', null, InputOption::VALUE_NONE, 'Disable paging output for this run.'), new InputOption('raw-output', 'r', InputOption::VALUE_NONE, 'Print var_export-style return values (for non-interactive input)'), new InputOption('self-update', 'u', InputOption::VALUE_NONE, 'Update to the latest version'), + new InputOption('experimental-readline', null, InputOption::VALUE_NONE, 'Use experimental interactive readline implementation.'), new InputOption('yolo', null, InputOption::VALUE_NONE, 'Run PsySH with minimal input validation. You probably don\'t want this.'), + new InputOption('warm-autoload', null, InputOption::VALUE_NONE, 'Enable autoload warming for better tab completion.'), + new InputOption('info', null, InputOption::VALUE_NONE, 'Display PsySH environment and configuration info.'), ]; } @@ -386,7 +574,8 @@ public static function getInputOptions(): array * If a config file is available, it will be loaded and merged with the current config. * * If no custom config file was specified and a local project config file - * is available, it will be loaded and merged with the current config. + * is available, it may be loaded and merged with the current config + * depending on project trust settings. */ public function init() { @@ -398,9 +587,7 @@ public function init() $this->loadConfigFile($configFile); } - if (!$this->configFile && $localConfig = $this->getLocalConfigFile()) { - $this->loadConfigFile($localConfig); - } + $this->loadLocalConfigIfTrusted(); $this->configPaths->overrideDirs([ 'configDir' => $this->configDir, @@ -433,12 +620,15 @@ public function getConfigFile() if (!empty($files)) { if ($this->warnOnMultipleConfigs && \count($files) > 1) { - $msg = \sprintf('Multiple configuration files found: %s. Using %s', \implode(', ', $files), $files[0]); + $prettyFiles = \array_map([ConfigPaths::class, 'prettyPath'], $files); + $msg = \sprintf('Multiple configuration files found: %s. Using %s', \implode(', ', $prettyFiles), $prettyFiles[0]); \trigger_error($msg, \E_USER_NOTICE); } return $files[0]; } + + return null; } /** @@ -456,6 +646,232 @@ public function getLocalConfigFile() if (@\is_file($localConfig)) { return $localConfig; } + + return null; + } + + /** + * Configure the project trust mode. + * + * Accepts boolean values or one of: 'prompt', 'always', 'never'. + * + * @param bool|string|null $mode + */ + public function setTrustProject($mode): void + { + if ($mode === null) { + $this->projectTrust->setMode(self::PROJECT_TRUST_PROMPT); + + return; + } + + if (\is_bool($mode)) { + $this->projectTrust->setMode($mode ? self::PROJECT_TRUST_ALWAYS : self::PROJECT_TRUST_NEVER); + + return; + } + + if (!\is_string($mode)) { + throw new \InvalidArgumentException('Invalid trustProject value. Expected: prompt, always, or never'); + } + + switch (\strtolower(\trim($mode))) { + case 'prompt': + $this->projectTrust->setMode(self::PROJECT_TRUST_PROMPT); + break; + case 'always': + $this->projectTrust->setMode(self::PROJECT_TRUST_ALWAYS); + break; + case 'never': + $this->projectTrust->setMode(self::PROJECT_TRUST_NEVER); + break; + default: + throw new \InvalidArgumentException('Invalid trustProject value. Expected: prompt, always, or never'); + } + } + + /** + * Get the current project trust mode. + */ + public function getProjectTrustMode(): string + { + return $this->projectTrust->getMode(); + } + + /** + * @deprecated explicit autoload warming always respects project trust restrictions + */ + public function setForceWarmAutoload(bool $force = true): void + { + } + + /** + * Load local config with an interactive trust prompt when appropriate. + * + * When stdin is not interactive, loads local config without prompting and + * writes a warning to stderr. + */ + public function loadLocalConfigWithPrompt(InputInterface $input, OutputInterface $output): void + { + if ($this->localConfigLoaded) { + return; + } + + $localConfigRoot = $this->projectTrust->getLocalConfigRoot(); + $composerRoot = $this->projectTrust->getProjectRoot(); + $checkLocalPsyshBinary = $this->projectTrust->shouldPromptForLocalPsyshBinary(); + + // Collect features by root that need trust + $featuresByRoot = []; + + // Check for local config (cwd only) + if ($localConfigRoot !== null && $this->hasLocalConfig($localConfigRoot)) { + $trustStatus = $this->projectTrust->getProjectTrustStatus($localConfigRoot); + if ($trustStatus === null) { + $featuresByRoot[$localConfigRoot][] = 'Local config (.psysh.php)'; + } + } + + // Check for local PsySH binary (at Composer root, where vendor/bin lives) + if ($checkLocalPsyshBinary && $composerRoot !== null && $this->projectTrust->getLocalPsyshProjectRoot($composerRoot) !== null) { + $trustStatus = $this->projectTrust->getProjectTrustStatus($composerRoot); + if ($trustStatus === null) { + $featuresByRoot[$composerRoot][] = 'local PsySH binary'; + } + } + + // Check for autoload warming (Composer root, may differ from cwd) + if ($composerRoot !== null && $this->shouldReportAutoloadWarming($composerRoot)) { + $trustStatus = $this->projectTrust->getProjectTrustStatus($composerRoot); + if ($trustStatus === null) { + $featuresByRoot[$composerRoot][] = 'Project autoload (vendor/autoload.php)'; + } + } + + // If nothing needs trust, we're done + if (empty($featuresByRoot)) { + // Load local config if it's already trusted + if ($localConfigRoot !== null && $this->projectTrust->getProjectTrustStatus($localConfigRoot) === true) { + $this->loadLocalConfigIfPresent($localConfigRoot); + } + + return; + } + + // Handle force untrust + if ($this->projectTrust->getForceUntrust() || $this->projectTrust->getMode() === self::PROJECT_TRUST_NEVER) { + return; + } + + // Non-interactive: warn and skip untrusted features (do not auto-trust) + if (!$this->getInputInteractive() || !$input->isInteractive()) { + $errorOutput = $output; + if ($errorOutput instanceof ConsoleOutput) { + $errorOutput = $errorOutput->getErrorOutput(); + } + + foreach ($featuresByRoot as $root => $features) { + $prettyDir = ConfigPaths::prettyPath($root); + $errorOutput->writeln( + "Restricted Mode: skipping untrusted project features from {$prettyDir} (non-interactive mode). Use --trust-project to allow." + ); + } + + if ($localConfigRoot !== null && $this->projectTrust->getProjectTrustStatus($localConfigRoot) === true) { + $this->loadLocalConfigIfPresent($localConfigRoot); + } + + return; + } + + // Interactive: prompt per-root + foreach ($featuresByRoot as $root => $features) { + if ($this->projectTrust->promptForTrust($input, $output, $root, $features)) { + // Check for local PsySH binary that needs re-run message + if ($checkLocalPsyshBinary && ($localPsyshRoot = $this->projectTrust->getLocalPsyshProjectRoot($root))) { + $prettyLocal = ConfigPaths::prettyPath($localPsyshRoot); + $output->writeln(''); + $output->writeln("Local PsySH version detected at {$prettyLocal}."); + $output->writeln('Re-run PsySH to use the trusted local version, or pass --trust-project to use it immediately.'); + $output->writeln(''); + } + } + } + + // Load local config if now trusted + if ($localConfigRoot !== null && $this->projectTrust->getProjectTrustStatus($localConfigRoot) === true) { + $this->loadLocalConfigIfPresent($localConfigRoot); + } + } + + /** + * Check if a local config file exists at the given root. + */ + private function hasLocalConfig(string $root): bool + { + if (isset($this->configFile)) { + return false; + } + + return @\is_file($root.'/.psysh.php'); + } + + private function loadLocalConfigIfTrusted(): void + { + if ($this->localConfigLoaded || isset($this->configFile)) { + return; + } + + $localConfigRoot = $this->projectTrust->getLocalConfigRoot(); + if ($localConfigRoot === null) { + return; + } + + if ($this->projectTrust->getProjectTrustStatus($localConfigRoot) === true) { + $this->loadLocalConfigIfPresent($localConfigRoot); + } + } + + private function loadLocalConfigIfPresent(string $projectRoot): void + { + if ($this->localConfigLoaded || isset($this->configFile)) { + return; + } + + $localConfig = $projectRoot.'/.psysh.php'; + if (@\is_file($localConfig)) { + $this->loadConfigFile($localConfig); + $this->localConfigLoaded = true; + $this->configPaths->overrideDirs([ + 'configDir' => $this->configDir, + 'dataDir' => $this->dataDir, + 'runtimeDir' => $this->runtimeDir, + ]); + } + } + + private function shouldReportAutoloadWarming(string $projectRoot): bool + { + if (!$this->hasComposerAutoloadWarmerConfigured()) { + return false; + } + + return $this->projectTrust->hasComposerAutoloadFiles($projectRoot); + } + + private function hasComposerAutoloadWarmerConfigured(): bool + { + if ($this->autoloadWarmers === null) { + $this->autoloadWarmers = $this->parseWarmAutoloadConfig(false); + } + + foreach ($this->autoloadWarmers as $warmer) { + if ($warmer instanceof TabCompletion\AutoloadWarmer\ComposerAutoloadWarmer) { + return true; + } + } + + return false; } /** @@ -480,7 +896,7 @@ public function loadConfig(array $options) $this->setUseTabCompletion($options['tabCompletion']); } - foreach (['commands', 'matchers', 'casters'] as $option) { + foreach (['commands', 'matchers', 'completionSources', 'casters'] as $option) { if (isset($options[$option])) { $method = 'add'.\ucfirst($option); $this->$method($options[$option]); @@ -510,7 +926,7 @@ public function loadConfig(array $options) public function loadConfigFile(string $file) { if (!\is_file($file)) { - throw new \InvalidArgumentException(\sprintf('Invalid configuration file specified, %s does not exist', $file)); + throw new \InvalidArgumentException(\sprintf('Invalid configuration file specified, %s does not exist', ConfigPaths::prettyPath($file))); } $__psysh_config_file__ = $file; @@ -655,8 +1071,9 @@ public function setHistoryFile(string $file) /** * Get the readline history file path. * - * Defaults to `/history` inside the shell's base config dir unless - * explicitly overridden. + * Defaults to `/psysh_history` (standard readline) or + * `/psysh_history.jsonl` (interactive readline) in the shell's config dir + * unless explicitly overridden. */ public function getHistoryFile(): ?string { @@ -664,28 +1081,75 @@ public function getHistoryFile(): ?string return $this->historyFile; } + $configDir = $this->configPaths->currentConfigDir(); + if ($configDir === null) { + return null; + } + + if ($this->usesInteractiveHistoryFormat()) { + $jsonlHistoryFile = $configDir.'/psysh_history.jsonl'; + $this->bootstrapInteractiveHistoryFile($jsonlHistoryFile); + $this->setHistoryFile($jsonlHistoryFile); + + return $this->historyFile; + } + $files = $this->configPaths->configFiles(['psysh_history', 'history']); if (!empty($files)) { if ($this->warnOnMultipleConfigs && \count($files) > 1) { - $msg = \sprintf('Multiple history files found: %s. Using %s', \implode(', ', $files), $files[0]); + $prettyFiles = \array_map([ConfigPaths::class, 'prettyPath'], $files); + $msg = \sprintf('Multiple history files found: %s. Using %s', \implode(', ', $prettyFiles), $prettyFiles[0]); \trigger_error($msg, \E_USER_NOTICE); } $this->setHistoryFile($files[0]); } else { - // fallback: create our own history file - $configDir = $this->configPaths->currentConfigDir(); - if ($configDir === null) { - return null; - } - $this->setHistoryFile($configDir.'/psysh_history'); } return $this->historyFile; } + /** + * Determine whether history should use the interactive JSONL format. + */ + private function usesInteractiveHistoryFormat(): bool + { + if (isset($this->readline) && $this->readline instanceof Readline\InteractiveReadlineInterface) { + return true; + } + + return $this->getReadlineClass() === Readline\InteractiveReadline::class; + } + + /** + * Bootstrap interactive JSONL history from legacy history file if needed. + * + * This is intentionally one-way: once JSONL exists, legacy and JSONL + * history files diverge. + */ + private function bootstrapInteractiveHistoryFile(string $jsonlHistoryFile): void + { + if (@\is_file($jsonlHistoryFile)) { + return; + } + + $legacyFiles = $this->configPaths->configFiles(['psysh_history', 'history']); + if (empty($legacyFiles)) { + return; + } + + $legacyHistoryFile = $legacyFiles[0]; + if (!@\is_readable($legacyHistoryFile)) { + return; + } + + $history = new InteractiveHistory($this->getHistorySize(), $this->getEraseDuplicates() ?? false); + $history->importFromFile($legacyHistoryFile); + $history->saveToFile($jsonlHistoryFile); + } + /** * Set the readline max history size. * @@ -816,6 +1280,7 @@ public function getReadline(): Readline\Readline { if (!isset($this->readline)) { $className = $this->getReadlineClass(); + $this->readline = new $className( $this->getHistoryFile(), $this->getHistorySize(), @@ -833,6 +1298,11 @@ public function getReadline(): Readline\Readline */ private function getReadlineClass(): string { + // Experimental interactive readline (opt-in via config or --experimental-readline) + if ($this->useExperimentalReadline() && Readline\InteractiveReadline::isSupported()) { + return Readline\InteractiveReadline::class; + } + if ($this->useReadline()) { if (Readline\GNUReadline::isSupported()) { return Readline\GNUReadline::class; @@ -885,6 +1355,111 @@ public function useBracketedPaste(): bool // return $readlineClass::supportsBracketedPaste() && $this->useBracketedPaste !== false; } + /** + * Set a custom clipboard command. + * + * @param string|null $clipboardCommand + */ + public function setClipboardCommand(?string $clipboardCommand) + { + $this->clipboardCommand = $clipboardCommand !== null && \trim($clipboardCommand) !== '' + ? $clipboardCommand + : null; + $this->clipboard = null; + } + + /** + * Get the configured clipboard command, if any. + */ + public function clipboardCommand(): ?string + { + return $this->clipboardCommand; + } + + /** + * Set the ClipboardMethod service. + */ + public function setClipboard(ClipboardMethod $clipboard) + { + $this->clipboard = $clipboard; + } + + /** + * Get the ClipboardMethod service. + */ + public function getClipboard(): ClipboardMethod + { + if (isset($this->clipboard)) { + return $this->clipboard; + } + + if ($this->clipboardCommand !== null && \function_exists('proc_open')) { + return $this->clipboard = new CommandClipboardMethod($this->clipboardCommand); + } + + $isSsh = $this->isSshSession(); + if ($isSsh) { + return $this->clipboard = $this->useOsc52Clipboard() + ? new Osc52ClipboardMethod() + : new NullClipboardMethod(true); + } + + if (\function_exists('proc_open')) { + foreach (self::KNOWN_CLIPBOARD_COMMANDS as $command) { + if ($this->clipboardCommandExists($command)) { + return $this->clipboard = new CommandClipboardMethod($command); + } + } + } + + if ($this->useOsc52Clipboard()) { + return $this->clipboard = new Osc52ClipboardMethod(); + } + + return $this->clipboard = new NullClipboardMethod( + false, + $this->clipboardCommand !== null + ? NullClipboardMethod::REASON_NO_COMMAND_SUPPORT + : NullClipboardMethod::REASON_NO_COMMAND + ); + } + + /** + * Enable or disable OSC 52 clipboard support. + * + * @param bool $useOsc52Clipboard + */ + public function setUseOsc52Clipboard(bool $useOsc52Clipboard) + { + $this->useOsc52Clipboard = (bool) $useOsc52Clipboard; + $this->clipboard = null; + } + + /** + * Check whether to use OSC 52 clipboard support. + */ + public function useOsc52Clipboard(): bool + { + return $this->useOsc52Clipboard; + } + + private function isSshSession(): bool + { + return \getenv('SSH_TTY') !== false + || \getenv('SSH_CLIENT') !== false + || \getenv('SSH_CONNECTION') !== false; + } + + /** + * @phpstan-param non-empty-string $command + */ + private function clipboardCommandExists(string $command): bool + { + $bin = \explode(' ', $command, 2)[0]; + + return $this->configPaths->which($bin) !== null; + } + /** * Check whether this PHP instance has Pcntl available. * @@ -976,7 +1551,48 @@ public function requireSemicolons(): bool } /** - * Enable or disable strict types enforcement. + * Enable or disable semicolons suppressing return value display. + * + * @see self::semicolonsSuppressReturn() + */ + public function setSemicolonsSuppressReturn($semicolonsSuppressReturn) + { + if (\is_bool($semicolonsSuppressReturn)) { + $this->semicolonsSuppressReturn = $semicolonsSuppressReturn; + + return; + } + + if ($semicolonsSuppressReturn === self::SEMICOLONS_SUPPRESS_RETURN_DOUBLE) { + $this->semicolonsSuppressReturn = self::SEMICOLONS_SUPPRESS_RETURN_DOUBLE; + + return; + } + + $given = \is_scalar($semicolonsSuppressReturn) + ? (string) $semicolonsSuppressReturn + : \gettype($semicolonsSuppressReturn); + + throw new \InvalidArgumentException(\sprintf('Invalid semicolonsSuppressReturn value: %s. Accepted values: true, false, \'%s\'', $given, self::SEMICOLONS_SUPPRESS_RETURN_DOUBLE)); + } + + /** + * Check whether semicolons suppress return value display. + * + * When enabled, an unnecessary trailing semicolon suppresses the return + * value display (like Pry and MATLAB). The return value is still captured + * in $_. In `double` mode, a double semicolon (`;;`) is always required + * to suppress, regardless of the `requireSemicolons` setting. + * + * @return bool|string + */ + public function semicolonsSuppressReturn() + { + return $this->semicolonsSuppressReturn; + } + + /** + * Enable or disable strict types enforcement. */ public function setStrictTypes($strictTypes) { @@ -1071,7 +1687,7 @@ public function setCodeCleaner(CodeCleaner $cleaner) public function getCodeCleaner(): CodeCleaner { if (!isset($this->cleaner)) { - $this->cleaner = new CodeCleaner(null, null, null, $this->yolo(), $this->strictTypes()); + $this->cleaner = new CodeCleaner(null, null, null, $this->yolo(), $this->strictTypes(), $this->implicitUse); } return $this->cleaner; @@ -1095,6 +1711,54 @@ public function yolo(): bool return $this->yolo; } + /** + * Enable experimental interactive readline implementation. + */ + public function setUseExperimentalReadline(bool $enabled): void + { + $this->useExperimentalReadline = $enabled; + } + + /** + * Check whether to use experimental interactive readline. + */ + public function useExperimentalReadline(): bool + { + return $this->useExperimentalReadline; + } + + /** + * Enable or disable syntax highlighting in interactive readline. + */ + public function setUseSyntaxHighlighting(bool $enabled): void + { + $this->useSyntaxHighlighting = $enabled; + } + + /** + * Check whether syntax highlighting is enabled in interactive readline. + */ + public function useSyntaxHighlighting(): bool + { + return $this->useSyntaxHighlighting; + } + + /** + * Enable inline suggestions in interactive readline. + */ + public function setUseSuggestions(bool $enabled): void + { + $this->useSuggestions = $enabled; + } + + /** + * Check whether inline suggestions are enabled. + */ + public function useSuggestions(): bool + { + return $this->useSuggestions; + } + /** * Enable or disable tab completion. * @@ -1127,6 +1791,10 @@ public function setTabCompletion(bool $useTabCompletion) */ public function useTabCompletion(): bool { + if (isset($this->readline) && $this->readline instanceof Readline\InteractiveReadlineInterface) { + return $this->useTabCompletion ?? true; + } + return isset($this->useTabCompletion) ? ($this->hasReadline && $this->useTabCompletion) : $this->hasReadline; } @@ -1155,6 +1823,7 @@ public function setOutput(ShellOutput $output) } $this->applyFormatterStyles(); + $this->invalidatePresenter(); } /** @@ -1181,7 +1850,7 @@ public function getOutput(): ShellOutput // output stream to figure out if it's piped or not, so create it // first, then update after we have a stream. $decorated = $this->getOutputDecorated(); - if ($decorated !== null) { + if ($decorated !== null && $this->output !== null) { $this->output->setDecorated($decorated); } } @@ -1248,6 +1917,14 @@ public function setPager($pager) $this->pager = $pager; } + /** + * Use the default pager resolution for this configuration. + */ + public function setDefaultPager(): void + { + $this->pager = null; + } + /** * Get an OutputPager instance or a command for an external Proc pager. * @@ -1331,22 +2008,372 @@ public function getTabCompletionMatchers(): array */ public function addMatchers(array $matchers) { - $this->newMatchers = \array_merge($this->newMatchers, $matchers); + $this->matchers = \array_merge($this->matchers, $matchers); + if (isset($this->shell)) { + $this->syncShellExtensions(); + } + } + + /** + * Add completion sources. + * + * @internal experimental; API may change before Interactive Readline is stable + * + * @param Completion\Source\SourceInterface[] $sources + */ + public function addCompletionSources(array $sources) + { + $this->completionSources = \array_merge($this->completionSources, $sources); if (isset($this->shell)) { - $this->doAddMatchers(); + $this->syncShellExtensions(); + } + } + + /** + * Configure autoload warming. + * + * @param bool|array $config False to disable, true for defaults, or array for custom config + */ + public function setWarmAutoload($config): void + { + if (!\is_bool($config) && !\is_array($config)) { + throw new \InvalidArgumentException('warmAutoload must be a boolean or configuration array'); + } + + // Parse and store warmers immediately + $this->autoloadWarmers = $this->parseWarmAutoloadConfig($config); + } + + /** + * Get configured autoload warmers. + * + * If no warmers are explicitly configured, returns a default ComposerAutoloadWarmer + * with smart settings that work for most projects. + * + * To disable autoload warming, set 'warmAutoload' to false. + * + * @return TabCompletion\AutoloadWarmer\AutoloadWarmerInterface[] + */ + public function getAutoloadWarmers(): array + { + if ($this->autoloadWarmers === null) { + $this->autoloadWarmers = $this->parseWarmAutoloadConfig(false); + } + + if ($this->projectTrust->getForceTrust() || $this->projectTrust->getMode() === self::PROJECT_TRUST_ALWAYS) { + return $this->autoloadWarmers; + } + + $projectRoot = $this->projectTrust->getProjectRoot(); + if ($projectRoot !== null && ($this->projectTrust->getForceUntrust() || !$this->projectTrust->isProjectTrusted($projectRoot))) { + $filtered = \array_values(\array_filter( + $this->autoloadWarmers, + fn ($warmer) => !$warmer instanceof TabCompletion\AutoloadWarmer\ComposerAutoloadWarmer + )); + + if (\count($filtered) !== \count($this->autoloadWarmers)) { + $this->projectTrust->warnUntrustedAutoloadWarming($projectRoot, $this->getOutput()); + } + + return $filtered; + } + + return $this->autoloadWarmers; + } + + /** + * Parse warmAutoload configuration into autoload warmers. + * + * Accepts three types of configuration: + * - true: Enable with default ComposerAutoloadWarmer + * - false: Disable warming entirely (default) + * - array: Custom configuration for ComposerAutoloadWarmer and/or custom warmers + * + * When a config array is provided: + * - Empty array [] disables warming + * - 'warmers' key provides custom warmer instances + * - Other keys configure a ComposerAutoloadWarmer (implicitly enables) + * - Both can be combined: custom warmers + configured ComposerAutoloadWarmer + * + * @param bool|array $config Configuration value + * + * @return TabCompletion\AutoloadWarmer\AutoloadWarmerInterface[] + */ + private function parseWarmAutoloadConfig($config): array + { + // false = disable entirely + if ($config === false) { + return []; + } + + // true = use default ComposerAutoloadWarmer + if ($config === true) { + return [new TabCompletion\AutoloadWarmer\ComposerAutoloadWarmer()]; + } + + // array = custom configuration + if (!\is_array($config)) { + throw new \InvalidArgumentException('warmAutoload must be a boolean or configuration array'); + } + + $warmers = []; + + // Extract explicit warmers if provided + if (isset($config['warmers'])) { + $explicitWarmers = $config['warmers']; + if (!\is_array($explicitWarmers)) { + throw new \InvalidArgumentException('warmAutoload[\'warmers\'] must be an array'); + } + + foreach ($explicitWarmers as $warmer) { + if (!$warmer instanceof TabCompletion\AutoloadWarmer\AutoloadWarmerInterface) { + throw new \InvalidArgumentException('Autoload warmers must implement AutoloadWarmerInterface'); + } + $warmers[] = $warmer; + } + + unset($config['warmers']); + } + + // If there are remaining config options, create a ComposerAutoloadWarmer with them + if (!empty($config)) { + $warmers[] = new TabCompletion\AutoloadWarmer\ComposerAutoloadWarmer($config); + } + + return $warmers; + } + + /** + * Set implicit use statement configuration. + * + * Automatically adds use statements for unqualified class references when + * a single, non-ambiguous match is found among currently defined classes, + * interfaces, and traits within the configured namespaces. + * + * Works great with autoload warming (--warm-autoload) to pre-load classes + * for better resolution. Also works with dynamically defined classes. + * + * Examples: + * + * // Disable implicit use (default) + * $config->setImplicitUse(false); + * + * // Enable for specific namespaces + * $config->setImplicitUse([ + * 'includeNamespaces' => ['App\\', 'Domain\\'], + * ]); + * + * // Enable with exclusions + * $config->setImplicitUse([ + * 'includeNamespaces' => ['App\\'], + * 'excludeNamespaces' => ['App\\Legacy\\'], + * ]); + * + * Note: At least one of includeNamespaces or excludeNamespaces must be provided. + * If neither is provided, implicit use effectively does nothing. + * + * @param false|array $config False to disable, or array with includeNamespaces/excludeNamespaces + */ + public function setImplicitUse($config): void + { + if ($config === false) { + $this->implicitUse = false; + + return; + } + + if (!\is_array($config)) { + throw new \InvalidArgumentException('implicitUse must be false or a configuration array with includeNamespaces and/or excludeNamespaces'); + } + + $this->implicitUse = $config; + } + + /** + * Get implicit use configuration. + * + * @return bool|array Implicit use configuration + */ + public function getImplicitUse() + { + return $this->implicitUse; + } + + /** + * Configure logging. + * + * Logs PsySH input, commands, and executed code to the provided logger. + * Accepts a PSR-3 logger, a simple callback, or an array for more control + * over log levels. + * + * Examples: + * + * // Simple callback logging + * $config->setLogging(function ($kind, $data) { + * $line = sprintf("[%s] %s\n", $kind, $data); + * file_put_contents('/tmp/psysh.log', $line, FILE_APPEND); + * }); + * + * // PSR-3 logger with defaults (input=info, command=info, execute=debug) + * $config->setLogging($psrLogger); + * + * // Set single level for all event types + * $config->setLogging([ + * 'logger' => $psrLogger, + * 'level' => 'debug', + * ]); + * + * // Granular control over each event type + * $config->setLogging([ + * 'logger' => $psrLogger, + * 'level' => [ + * 'input' => 'info', + * 'command' => false, // disable logging + * 'execute' => 'debug', + * ], + * ]); + * + * @param \Psr\Log\LoggerInterface|callable|array $logging + */ + public function setLogging($logging): void + { + $this->logger = $this->parseLoggingConfig($logging); + } + + /** + * Get a ShellLogger instance if logging is configured. + * + * @return ShellLogger|null + */ + public function getLogger(): ?ShellLogger + { + return $this->logger; + } + + /** + * Configure a callback that returns additional structured exception details. + * + * The callback receives the thrown exception and may return any dumpable + * value; returning null suppresses additional output. + */ + public function setExceptionDetails(callable $exceptionDetails): void + { + $this->exceptionDetails = \Closure::fromCallable($exceptionDetails); + } + + /** + * Get the configured exception details callback, if any. + */ + public function getExceptionDetails(): ?\Closure + { + return $this->exceptionDetails; + } + + /** + * Get an InputLoggingListener if input logging is enabled. + * + * @return InputLoggingListener|null + */ + public function getInputLogger(): ?InputLoggingListener + { + $logger = $this->getLogger(); + if ($logger === null || $logger->isInputDisabled()) { + return null; + } + + return new InputLoggingListener($logger); + } + + /** + * Get an ExecutionLoggingListener if execution logging is enabled. + * + * @return ExecutionLoggingListener|null + */ + public function getExecutionLogger(): ?ExecutionLoggingListener + { + $logger = $this->getLogger(); + if ($logger === null || $logger->isExecuteDisabled()) { + return null; + } + + return new ExecutionLoggingListener($logger); + } + + /** + * Parse logging configuration. + * + * @param \Psr\Log\LoggerInterface|Logger\CallbackLogger|callable|array $config + * + * @return ShellLogger + */ + private function parseLoggingConfig($config): ShellLogger + { + if (!\is_array($config)) { + $config = ['logger' => $config]; + } + + if (!isset($config['logger'])) { + throw new \InvalidArgumentException('Logging config array must include a "logger" key'); + } + + $logger = $config['logger']; + + if (\is_callable($logger)) { + $logger = new CallbackLogger($logger); + } + + if (!$this->isLogger($logger)) { + throw new \InvalidArgumentException('Logging "logger" must be a logger instance or callable'); + } + + $defaults = [ + 'input' => 'info', + 'command' => 'info', + 'execute' => 'debug', + ]; + + if (isset($config['level'])) { + $level = $config['level']; + + // String: apply same level to all types + if (\is_string($level)) { + $levels = [ + 'input' => $level, + 'command' => $level, + 'execute' => $level, + ]; + } elseif (\is_array($level)) { + // Array: granular per-type levels + $levels = [ + 'input' => $level['input'] ?? $defaults['input'], + 'command' => $level['command'] ?? $defaults['command'], + 'execute' => $level['execute'] ?? $defaults['execute'], + ]; + } else { + throw new \InvalidArgumentException('Logging "level" must be a string or array'); + } + } else { + $levels = $defaults; } + + return new ShellLogger($logger, $levels); } /** - * Internal method for adding tab completion matchers. This will set any new - * matchers once a Shell is available. + * Check if a value is a valid logger instance. + * + * @param mixed $logger + * + * @return bool */ - private function doAddMatchers() + private function isLogger($logger): bool { - if (!empty($this->newMatchers)) { - $this->shell->addMatchers($this->newMatchers); - $this->newMatchers = []; + if ($logger instanceof CallbackLogger) { + return true; } + + // Safe check for LoggerInterface without requiring psr/log as a dependency + return \interface_exists('Psr\Log\LoggerInterface') && $logger instanceof \Psr\Log\LoggerInterface; } /** @@ -1373,22 +2400,22 @@ public function addTabCompletionMatchers(array $matchers) */ public function addCommands(array $commands) { - $this->newCommands = \array_merge($this->newCommands, $commands); + $this->commands = \array_merge($this->commands, $commands); if (isset($this->shell)) { - $this->doAddCommands(); + $this->syncShellExtensions(); } } /** - * Internal method for adding commands. This will set any new commands once - * a Shell is available. + * Sync configuration-driven extensions into the active shell. + * + * The shell handles deduplication, so we can safely forward everything. */ - private function doAddCommands() + private function syncShellExtensions(): void { - if (!empty($this->newCommands)) { - $this->shell->addCommands($this->newCommands); - $this->newCommands = []; - } + $this->shell->addCommands($this->commands); + $this->shell->addMatchers($this->matchers); + $this->shell->addCompletionSources($this->completionSources); } /** @@ -1399,8 +2426,10 @@ private function doAddCommands() public function setShell(Shell $shell) { $this->shell = $shell; - $this->doAddCommands(); - $this->doAddMatchers(); + $this->syncShellExtensions(); + + // Configure SignatureFormatter for hyperlinks + SignatureFormatter::setManual($this->getManual()); } /** @@ -1414,12 +2443,24 @@ public function setShell(Shell $shell) public function setManualDbFile(string $filename) { $this->manualDbFile = (string) $filename; + + // Reconfigure SignatureFormatter with new manual database + try { + SignatureFormatter::setManual($this->getManual()); + } catch (InvalidManualException $e) { + // Show user-friendly error for invalid explicitly configured manual + throw new \InvalidArgumentException($e->getMessage(), 0, $e); + } } /** * Get the current PHP manual database file. * - * @return string|null Default: '~/.local/share/psysh/php_manual.sqlite' + * Searches for manual files in order of preference: + * 1. php_manual.php (v3 format) + * 2. php_manual.sqlite (v2 format, legacy) + * + * @return string|null Default: '~/.local/share/psysh/php_manual.*' */ public function getManualDbFile() { @@ -1427,34 +2468,46 @@ public function getManualDbFile() return $this->manualDbFile; } - $files = $this->configPaths->dataFiles(['php_manual.sqlite']); + // Prefer v3 format over v2 + $files = $this->configPaths->dataFiles(['php_manual.php', 'php_manual.sqlite']); if (!empty($files)) { if ($this->warnOnMultipleConfigs && \count($files) > 1) { - $msg = \sprintf('Multiple manual database files found: %s. Using %s', \implode(', ', $files), $files[0]); + $prettyFiles = \array_map([ConfigPaths::class, 'prettyPath'], $files); + $msg = \sprintf('Multiple manual database files found: %s. Using %s', \implode(', ', $prettyFiles), $prettyFiles[0]); \trigger_error($msg, \E_USER_NOTICE); } return $this->manualDbFile = $files[0]; } + + return null; } /** * Get a PHP manual database connection. * + * @deprecated Use getManual() instead for unified access to all manual formats + * * @return \PDO|null */ public function getManualDb() { if (!isset($this->manualDb)) { $dbFile = $this->getManualDbFile(); - if ($dbFile !== null && \is_file($dbFile)) { + if ($dbFile !== null && \is_file($dbFile) && \substr($dbFile, -7) === '.sqlite') { try { $this->manualDb = new \PDO('sqlite:'.$dbFile); + + // Validate the database has the required structure + $result = $this->manualDb->query("SELECT name FROM sqlite_master WHERE type='table' AND name='php_manual'"); + if ($result === false || $result->fetchColumn() === false) { + throw new InvalidManualException('Manual database is missing required tables', $dbFile); + } } catch (\PDOException $e) { if ($e->getMessage() === 'could not find driver') { throw new RuntimeException('SQLite PDO driver not found', 0, $e); } else { - throw $e; + throw new InvalidManualException('Invalid SQLite manual database: '.$e->getMessage(), $dbFile, 0, $e); } } } @@ -1463,6 +2516,123 @@ public function getManualDb() return $this->manualDb; } + /** + * Get a PHP manual instance. + * + * Automatically detects the manual format and returns the appropriate manual type. + * Supports v2 (SQLite) and v3 (PHP) formats. + * + * @return ManualInterface|null + */ + public function getManual() + { + if (!isset($this->manual)) { + $this->manual = $this->loadManual(); + } + + return $this->manual; + } + + /** + * Load manual from filesystem or bundled Phar, preferring newest English version. + * + * Priority: + * 1. Explicit config: if user configured a specific file, use it + * 2. Local non-English: user downloaded a specific language + * 3. Newest English: compare local vs bundled + * + * @return ManualInterface|null + */ + private function loadManual() + { + // Priority 1: If user explicitly configured a manual file, use it + if (isset($this->manualDbFile)) { + $manual = $this->loadManualFromFile($this->manualDbFile); + if ($manual !== null) { + return $manual; + } + } + + // Check filesystem locations (auto-discovered) + $localFile = $this->getManualDbFile(); + $localManual = null; + $localMeta = null; + + if ($localFile !== null && \is_file($localFile)) { + try { + $localManual = $this->loadManualFromFile($localFile); + if ($localManual !== null) { + $localMeta = $localManual->getMeta(); + } + } catch (InvalidManualException $e) { + // Auto-discovered file is invalid - fall back to bundled + } + } + + // Check bundled manual in Phar + $bundledManual = null; + $bundledMeta = null; + + if (\Phar::running(false)) { + $bundledFile = 'phar://'.\Phar::running(false).'/php_manual.php'; + if (\is_file($bundledFile)) { + $bundledManual = $this->loadManualFromFile($bundledFile); + if ($bundledManual !== null) { + $bundledMeta = $bundledManual->getMeta(); + } + } + } + + // Priority 2: If local exists and is not English, use local (user wants that language) + // Priority 3: Otherwise, use newest English (compare local vs bundled) + + if ($localManual !== null) { + $localLang = $localMeta['lang'] ?? 'en'; + + // Non-English local manual takes priority + if ($localLang !== 'en') { + return $localManual; + } + + // Both are English, pick newest + $localTimestamp = $localMeta['built_at'] ?? 0; + $bundledTimestamp = $bundledMeta['built_at'] ?? 0; + + if ($localTimestamp >= $bundledTimestamp) { + return $localManual; + } else { + return $bundledManual; + } + } + + // No local manual, use bundled if available + return $bundledManual; + } + + /** + * Load a manual from a file path. + * + * @param string $file + * + * @return ManualInterface|null + * + * @throws InvalidManualException if manual file is invalid + */ + private function loadManualFromFile(string $file) + { + // Detect format by extension + if (\substr($file, -4) === '.php') { + return new V3Manual($file); + } elseif (\substr($file, -7) === '.sqlite') { + // Legacy v2 format + if ($db = $this->getManualDb()) { + return new V2Manual($db); + } + } + + return null; + } + /** * Add an array of casters definitions. * @@ -1470,7 +2640,11 @@ public function getManualDb() */ public function addCasters(array $casters) { - $this->getPresenter()->addCasters($casters); + $this->casters = \array_merge($this->casters, $casters); + + if (isset($this->presenter)) { + $this->presenter->addCasters($casters); + } } /** @@ -1479,7 +2653,10 @@ public function addCasters(array $casters) public function getPresenter(): Presenter { if (!isset($this->presenter)) { - $this->presenter = new Presenter($this->getOutput()->getFormatter(), $this->forceArrayIndexes()); + $this->presenter = new Presenter($this->getOutput()->getFormatter(), $this->forceArrayIndexes(), $this->useDeprecatedMultilineStrings()); + if ($this->casters !== []) { + $this->presenter->addCasters($this->casters); + } } return $this->presenter; @@ -1666,6 +2843,134 @@ public function getUpdateCheckCacheFile() return ConfigPaths::touchFileWithMkdir($configDir.'/update_check.json'); } + /** + * Get the current manual update check interval. + * + * One of 'always', 'daily', 'weekly', 'monthly' or 'never'. If none is + * explicitly set, default to 'weekly'. + */ + public function getUpdateManualCheck(): string + { + return isset($this->updateManualCheck) ? $this->updateManualCheck : ManualUpdater\Checker::WEEKLY; + } + + /** + * Set the manual update check interval. + * + * @throws \InvalidArgumentException if the update check interval is unknown + * + * @param string $interval + */ + public function setUpdateManualCheck(string $interval) + { + $validIntervals = [ + ManualUpdater\Checker::ALWAYS, + ManualUpdater\Checker::DAILY, + ManualUpdater\Checker::WEEKLY, + ManualUpdater\Checker::MONTHLY, + ManualUpdater\Checker::NEVER, + ]; + + if (!\in_array($interval, $validIntervals)) { + throw new \InvalidArgumentException('Invalid manual update check interval: '.$interval); + } + + $this->updateManualCheck = $interval; + } + + /** + * Get a manual update checker. + * + * If none has been explicitly defined, this will create a new instance. + * + * @param string|null $lang Override language (otherwise uses current manual's language or 'en') + * @param bool $always Force immediate check, ignoring interval setting + * + * @return ManualUpdater\Checker|null + */ + public function getManualChecker(?string $lang = null, bool $always = false): ?ManualUpdater\Checker + { + // Get current manual info + $manualFile = $this->getManualDbFile(); + $currentMeta = null; + if ($manualFile && \file_exists($manualFile)) { + $manual = $this->getManual(); + if ($manual) { + $currentMeta = $manual->getMeta(); + } + } + + $currentVersion = $currentMeta['version'] ?? null; + $currentLang = $currentMeta['lang'] ?? null; + + // Determine language (priority: explicit param, current manual, default to English) + if ($lang === null) { + $lang = $currentLang ?? 'en'; + } + + // Determine format from current manual file extension, default to v3 + $format = 'php'; + if ($manualFile && \substr($manualFile, -7) === '.sqlite') { + $format = 'sqlite'; + } + + $interval = $always ? ManualUpdater\Checker::ALWAYS : $this->getUpdateManualCheck(); + switch ($interval) { + case ManualUpdater\Checker::ALWAYS: + return new ManualUpdater\GitHubChecker($lang, $format, $currentVersion, $currentLang); + + case ManualUpdater\Checker::DAILY: + case ManualUpdater\Checker::WEEKLY: + case ManualUpdater\Checker::MONTHLY: + $checkFile = $this->getManualUpdateCheckCacheFile(); + if ($checkFile === false) { + return null; // No writable cache file + } + + $baseChecker = new ManualUpdater\GitHubChecker($lang, $format, $currentVersion, $currentLang); + + return new ManualUpdater\IntervalChecker($baseChecker, $checkFile, $interval); + + case ManualUpdater\Checker::NEVER: + default: + return null; + } + } + + /** + * Get a cache file path for the manual update checker. + * + * @return string|false Return false if config file/directory is not writable + */ + public function getManualUpdateCheckCacheFile() + { + $configDir = $this->configPaths->currentConfigDir(); + if ($configDir === null) { + return false; + } + + return ConfigPaths::touchFileWithMkdir($configDir.'/manual_update_check.json'); + } + + /** + * Get the manual installation directory path. + * + * @return string|false Return false if data directory is not writable + */ + public function getManualInstallDir() + { + $dataDir = $this->configPaths->currentDataDir(); + if ($dataDir === null) { + return false; + } + + if (!ConfigPaths::ensureDir($dataDir)) { + return false; + } + + return $dataDir; + } + /** * Set the startup message. * @@ -1730,6 +3035,28 @@ public function forceArrayIndexes(): bool public function setForceArrayIndexes(bool $forceArrayIndexes) { $this->forceArrayIndexes = $forceArrayIndexes; + $this->invalidatePresenter(); + } + + /** + * @deprecated temporary compatibility flag for triple-quoted multiline strings. + * + * This will be removed in the next stable release. + */ + public function useDeprecatedMultilineStrings(): bool + { + return $this->useDeprecatedMultilineStrings; + } + + /** + * @deprecated temporary compatibility flag for triple-quoted multiline strings + * + * This will be removed in the next stable release + */ + public function setUseDeprecatedMultilineStrings(bool $useDeprecatedMultilineStrings): void + { + $this->useDeprecatedMultilineStrings = $useDeprecatedMultilineStrings; + $this->invalidatePresenter(); } /** @@ -1743,14 +3070,18 @@ public function setTheme($theme) $theme = new Theme($theme); } - $this->theme = $theme; - if (isset($this->prompt)) { - $this->theme->setPrompt($this->prompt); + $theme->setPrompt($this->prompt); + } + + if (isset($this->theme) && $this->theme->equals($theme)) { + return; } + $this->theme = $theme; + if (isset($this->output)) { - $this->output->setTheme($theme); + $this->output->setTheme($this->theme); $this->applyFormatterStyles(); } } @@ -1772,6 +3103,11 @@ public function theme(): Theme return $this->theme; } + private function invalidatePresenter(): void + { + $this->presenter = null; + } + /** * Set the shell output formatter styles. * @@ -1919,13 +3255,6 @@ public function outputIsPiped(): bool */ private static function looksLikeAPipe($stream): bool { - if (\function_exists('posix_isatty')) { - return !\posix_isatty($stream); - } - - $stat = \fstat($stream); - $mode = $stat['mode'] & 0170000; - - return $mode === 0010000 || $mode === 0040000 || $mode === 0100000 || $mode === 0120000; + return !Tty::isatty($stream); } } diff --git a/app/vendor/psy/psysh/src/Context.php b/app/vendor/psy/psysh/src/Context.php index 1062448e7..201aecaf3 100644 --- a/app/vendor/psy/psysh/src/Context.php +++ b/app/vendor/psy/psysh/src/Context.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/ContextAware.php b/app/vendor/psy/psysh/src/ContextAware.php index 83979ae85..94923427f 100644 --- a/app/vendor/psy/psysh/src/ContextAware.php +++ b/app/vendor/psy/psysh/src/ContextAware.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -21,8 +21,6 @@ interface ContextAware { /** * Set the Context reference. - * - * @param Context $context */ public function setContext(Context $context); } diff --git a/app/vendor/psy/psysh/src/EnvInterface.php b/app/vendor/psy/psysh/src/EnvInterface.php index 31a738fc4..c41dc3adb 100644 --- a/app/vendor/psy/psysh/src/EnvInterface.php +++ b/app/vendor/psy/psysh/src/EnvInterface.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Exception/BreakException.php b/app/vendor/psy/psysh/src/Exception/BreakException.php index 1b84a83a9..e83cca7ea 100644 --- a/app/vendor/psy/psysh/src/Exception/BreakException.php +++ b/app/vendor/psy/psysh/src/Exception/BreakException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -40,10 +40,12 @@ public function getRawMessage(): string * * Since `throw` can not be inserted into arbitrary expressions, it wraps with function call. * + * @param int|string|null $status Exit status code or message + * * @throws BreakException */ - public static function exitShell() + public static function exitShell($status = 0) { - throw new self('Goodbye'); + throw new self(\is_string($status) ? $status : 'Goodbye', \is_int($status) ? $status : 0); } } diff --git a/app/vendor/psy/psysh/src/Exception/DeprecatedException.php b/app/vendor/psy/psysh/src/Exception/DeprecatedException.php index f326b53bd..856756cf3 100644 --- a/app/vendor/psy/psysh/src/Exception/DeprecatedException.php +++ b/app/vendor/psy/psysh/src/Exception/DeprecatedException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Exception/ErrorException.php b/app/vendor/psy/psysh/src/Exception/ErrorException.php index f32da850d..094313e23 100644 --- a/app/vendor/psy/psysh/src/Exception/ErrorException.php +++ b/app/vendor/psy/psysh/src/Exception/ErrorException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -67,8 +67,8 @@ public function __construct($message = '', $code = 0, $severity = 1, $filename = break; } - $message = \sprintf('PHP %s: %s%s on line %d', $type, $message, $filename ? ' in '.$filename : '', $lineno); - parent::__construct($message, $code, $severity, $filename, $lineno, $previous); + $message = \sprintf('PHP %s: %s%s on line %d', $type, $message, $filename ? ' in '.$filename : '', $lineno ?? 0); + parent::__construct($message, $code, $severity, $filename ?? '', $lineno ?? 0, $previous); } /** diff --git a/app/vendor/psy/psysh/src/Exception/Exception.php b/app/vendor/psy/psysh/src/Exception/Exception.php index db7906211..0fe52f4af 100644 --- a/app/vendor/psy/psysh/src/Exception/Exception.php +++ b/app/vendor/psy/psysh/src/Exception/Exception.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Exception/FatalErrorException.php b/app/vendor/psy/psysh/src/Exception/FatalErrorException.php index b8af5bbe3..a78e52784 100644 --- a/app/vendor/psy/psysh/src/Exception/FatalErrorException.php +++ b/app/vendor/psy/psysh/src/Exception/FatalErrorException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -36,8 +36,8 @@ public function __construct($message = '', $code = 0, $severity = 1, $filename = } $this->rawMessage = $message; - $message = \sprintf('PHP Fatal error: %s in %s on line %d', $message, $filename ?: "eval()'d code", $lineno); - parent::__construct($message, $code, $severity, $filename, $lineno, $previous); + $message = \sprintf('PHP Fatal error: %s in %s on line %d', $message, $filename ?: "eval()'d code", $lineno ?? 0); + parent::__construct($message, $code, $severity, $filename ?? '', $lineno ?? 0, $previous); } /** diff --git a/app/vendor/psy/psysh/src/Exception/InterruptException.php b/app/vendor/psy/psysh/src/Exception/InterruptException.php new file mode 100644 index 000000000..aecd00c27 --- /dev/null +++ b/app/vendor/psy/psysh/src/Exception/InterruptException.php @@ -0,0 +1,29 @@ +getMessage(); + } +} diff --git a/app/vendor/psy/psysh/src/Exception/InvalidManualException.php b/app/vendor/psy/psysh/src/Exception/InvalidManualException.php new file mode 100644 index 000000000..d2aa62ff8 --- /dev/null +++ b/app/vendor/psy/psysh/src/Exception/InvalidManualException.php @@ -0,0 +1,40 @@ +manualFile = $manualFile; + parent::__construct($message, $code, $previous); + } + + /** + * Get the path to the invalid manual file. + */ + public function getManualFile(): string + { + return $this->manualFile; + } +} diff --git a/app/vendor/psy/psysh/src/Exception/ParseErrorException.php b/app/vendor/psy/psysh/src/Exception/ParseErrorException.php index ee2e2d427..b63a6f084 100644 --- a/app/vendor/psy/psysh/src/Exception/ParseErrorException.php +++ b/app/vendor/psy/psysh/src/Exception/ParseErrorException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Exception/RuntimeException.php b/app/vendor/psy/psysh/src/Exception/RuntimeException.php index b8ea38790..c29ae04af 100644 --- a/app/vendor/psy/psysh/src/Exception/RuntimeException.php +++ b/app/vendor/psy/psysh/src/Exception/RuntimeException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Exception/ThrowUpException.php b/app/vendor/psy/psysh/src/Exception/ThrowUpException.php index b2b758e65..1df8dea10 100644 --- a/app/vendor/psy/psysh/src/Exception/ThrowUpException.php +++ b/app/vendor/psy/psysh/src/Exception/ThrowUpException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Exception/UnexpectedTargetException.php b/app/vendor/psy/psysh/src/Exception/UnexpectedTargetException.php index b5c0d15c8..e9b6a890a 100644 --- a/app/vendor/psy/psysh/src/Exception/UnexpectedTargetException.php +++ b/app/vendor/psy/psysh/src/Exception/UnexpectedTargetException.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/ExecutionClosure.php b/app/vendor/psy/psysh/src/ExecutionClosure.php index 5ae354acd..912d1b751 100644 --- a/app/vendor/psy/psysh/src/ExecutionClosure.php +++ b/app/vendor/psy/psysh/src/ExecutionClosure.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -28,6 +28,7 @@ public function __construct(Shell $__psysh__) $this->setClosure($__psysh__, function () use ($__psysh__) { try { // Restore execution scope variables + // @phan-suppress-next-line PhanTypeNonVarPassByRef assigning to a temp variable pollutes scope \extract($__psysh__->getScopeVariables(false)); // Buffer stdout; we'll need it later diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/AbstractListener.php b/app/vendor/psy/psysh/src/ExecutionLoop/AbstractListener.php index 8230c5508..72471bb56 100644 --- a/app/vendor/psy/psysh/src/ExecutionLoop/AbstractListener.php +++ b/app/vendor/psy/psysh/src/ExecutionLoop/AbstractListener.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -37,6 +37,7 @@ public function beforeLoop(Shell $shell) */ public function onInput(Shell $shell, string $input) { + return null; } /** @@ -44,6 +45,7 @@ public function onInput(Shell $shell, string $input) */ public function onExecute(Shell $shell, string $code) { + return null; } /** @@ -56,7 +58,7 @@ public function afterLoop(Shell $shell) /** * {@inheritdoc} */ - public function afterRun(Shell $shell) + public function afterRun(Shell $shell, int $exitCode = 0) { } } diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/ExecutionLoggingListener.php b/app/vendor/psy/psysh/src/ExecutionLoop/ExecutionLoggingListener.php new file mode 100644 index 000000000..9afa79ef2 --- /dev/null +++ b/app/vendor/psy/psysh/src/ExecutionLoop/ExecutionLoggingListener.php @@ -0,0 +1,51 @@ +logger = $logger; + } + + /** + * {@inheritdoc} + */ + public static function isSupported(): bool + { + return true; + } + + /** + * {@inheritdoc} + */ + public function onExecute(Shell $shell, string $code) + { + $this->logger->logExecute($code); + + return null; + } +} diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/InputLoggingListener.php b/app/vendor/psy/psysh/src/ExecutionLoop/InputLoggingListener.php new file mode 100644 index 000000000..083c6e038 --- /dev/null +++ b/app/vendor/psy/psysh/src/ExecutionLoop/InputLoggingListener.php @@ -0,0 +1,51 @@ +logger = $logger; + } + + /** + * {@inheritdoc} + */ + public static function isSupported(): bool + { + return true; + } + + /** + * {@inheritdoc} + */ + public function onInput(Shell $shell, string $input) + { + $this->logger->logInput($input); + + return null; + } +} diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/Listener.php b/app/vendor/psy/psysh/src/ExecutionLoop/Listener.php index 9f207f5b7..23418557c 100644 --- a/app/vendor/psy/psysh/src/ExecutionLoop/Listener.php +++ b/app/vendor/psy/psysh/src/ExecutionLoop/Listener.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -76,6 +76,7 @@ public function afterLoop(Shell $shell); * Called once after the REPL session ends. * * @param Shell $shell + * @param int $exitCode Exit code from the execution loop */ - public function afterRun(Shell $shell); + public function afterRun(Shell $shell, int $exitCode = 0); } diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/ProcessForker.php b/app/vendor/psy/psysh/src/ExecutionLoop/ProcessForker.php index 308b71d77..02eba7de1 100644 --- a/app/vendor/psy/psysh/src/ExecutionLoop/ProcessForker.php +++ b/app/vendor/psy/psysh/src/ExecutionLoop/ProcessForker.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -13,7 +13,9 @@ use Psy\Context; use Psy\Exception\BreakException; +use Psy\Exception\InterruptException; use Psy\Shell; +use Psy\Util\DependencyChecker; /** * An execution loop listener that forks the process before executing code. @@ -26,8 +28,11 @@ class ProcessForker extends AbstractListener private ?int $savegame = null; /** @var resource */ private $up; + private bool $sigintHandlerInstalled = false; + private bool $restoreStty = false; + private ?string $originalStty = null; - private const PCNTL_FUNCTIONS = [ + public const PCNTL_FUNCTIONS = [ 'pcntl_fork', 'pcntl_signal_dispatch', 'pcntl_signal', @@ -35,7 +40,7 @@ class ProcessForker extends AbstractListener 'pcntl_wexitstatus', ]; - private const POSIX_FUNCTIONS = [ + public const POSIX_FUNCTIONS = [ 'posix_getpid', 'posix_kill', ]; @@ -45,56 +50,48 @@ class ProcessForker extends AbstractListener */ public static function isSupported(): bool { - return self::isPcntlSupported() && !self::disabledPcntlFunctions() && self::isPosixSupported() && !self::disabledPosixFunctions(); + return DependencyChecker::functionsAvailable(self::PCNTL_FUNCTIONS) + && DependencyChecker::functionsAvailable(self::POSIX_FUNCTIONS); } /** * Verify that all required pcntl functions are, in fact, available. + * + * @deprecated */ public static function isPcntlSupported(): bool { - foreach (self::PCNTL_FUNCTIONS as $func) { - if (!\function_exists($func)) { - return false; - } - } - - return true; + return DependencyChecker::functionsAvailable(self::PCNTL_FUNCTIONS); } /** * Check whether required pcntl functions are disabled. + * + * @deprecated */ public static function disabledPcntlFunctions() { - return self::checkDisabledFunctions(self::PCNTL_FUNCTIONS); + return DependencyChecker::functionsDisabled(self::PCNTL_FUNCTIONS); } /** * Verify that all required posix functions are, in fact, available. + * + * @deprecated */ public static function isPosixSupported(): bool { - foreach (self::POSIX_FUNCTIONS as $func) { - if (!\function_exists($func)) { - return false; - } - } - - return true; + return DependencyChecker::functionsAvailable(self::POSIX_FUNCTIONS); } /** * Check whether required posix functions are disabled. + * + * @deprecated */ public static function disabledPosixFunctions() { - return self::checkDisabledFunctions(self::POSIX_FUNCTIONS); - } - - private static function checkDisabledFunctions(array $functions): array - { - return \array_values(\array_intersect($functions, \array_map('strtolower', \array_map('trim', \explode(',', \ini_get('disable_functions')))))); + return DependencyChecker::functionsDisabled(self::POSIX_FUNCTIONS); } /** @@ -107,8 +104,16 @@ private static function checkDisabledFunctions(array $functions): array */ public function beforeRun(Shell $shell) { + // Temporarily disable socket timeout for IPC sockets, to avoid losing our child process + // communication after 60 seconds. + $originalTimeout = @\ini_set('default_socket_timeout', '-1'); + list($up, $down) = \stream_socket_pair(\STREAM_PF_UNIX, \STREAM_SOCK_STREAM, \STREAM_IPPROTO_IP); + if ($originalTimeout !== false) { + @\ini_set('default_socket_timeout', $originalTimeout); + } + if (!$up) { throw new \RuntimeException('Unable to create socket pair'); } @@ -117,17 +122,54 @@ public function beforeRun(Shell $shell) if ($pid < 0) { throw new \RuntimeException('Unable to start execution loop'); } elseif ($pid > 0) { - // This is the main thread. We'll just wait for a while. + // This is the main (parent) process. Install SIGINT handler and wait for child. // We won't be needing this one. \fclose($up); + // Install SIGINT handler in parent to interrupt child + \pcntl_async_signals(true); + $interrupted = false; + $sigintHandlerInstalled = \pcntl_signal(\SIGINT, function () use (&$interrupted, $pid) { + $interrupted = true; + // Send SIGINT to child so it can handle interruption gracefully + \posix_kill($pid, \SIGINT); + }); + // Wait for a return value from the loop process. $read = [$down]; $write = null; $except = null; do { + if ($interrupted) { + // Wait for child to exit (it should handle SIGINT gracefully) + \pcntl_waitpid($pid, $status); + + // Try to read any final output from child before it exited + $content = @\stream_get_contents($down); + \fclose($down); + + if ($sigintHandlerInstalled) { + \pcntl_signal(\SIGINT, \SIG_DFL); + } + + $this->clearStdinBuffer(); + + // Restore scope variables and exit code if child sent any + // If child didn't send data, use the actual process exit status + $exitCode = \pcntl_wexitstatus($status); + if ($content) { + $data = @\unserialize($content); + if (\is_array($data) && isset($data['exitCode'], $data['scopeVars'])) { + $exitCode = $data['exitCode']; + $shell->setScopeVariables($data['scopeVars']); + } + } + + throw new BreakException('Exiting main thread', $exitCode); + } + $n = @\stream_select($read, $write, $except, null); if ($n === 0) { @@ -136,23 +178,39 @@ public function beforeRun(Shell $shell) if ($n === false) { $err = \error_get_last(); - if (!isset($err['message']) || \stripos($err['message'], 'interrupted system call') === false) { - $msg = $err['message'] ? - \sprintf('Error waiting for execution loop: %s', $err['message']) : - 'Error waiting for execution loop'; - throw new \RuntimeException($msg); + $errMessage = \is_array($err) ? ($err['message'] ?? null) : null; + + // If there's no error message, or it's an interrupted system call, just retry + if ($errMessage === null || \stripos($errMessage, 'interrupted system call') !== false) { + continue; } + + throw new \RuntimeException(\sprintf('Error waiting for execution loop: %s', $errMessage)); } } while ($n < 1); $content = \stream_get_contents($down); \fclose($down); + // Wait for child to exit and get its exit status + \pcntl_waitpid($pid, $status); + + // Restore default SIGINT handler + if ($sigintHandlerInstalled) { + \pcntl_signal(\SIGINT, \SIG_DFL); + } + + // If child didn't send data, use the actual process exit status + $exitCode = \pcntl_wexitstatus($status); if ($content) { - $shell->setScopeVariables(@\unserialize($content)); + $data = @\unserialize($content); + if (\is_array($data) && isset($data['exitCode'], $data['scopeVars'])) { + $exitCode = $data['exitCode']; + $shell->setScopeVariables($data['scopeVars']); + } } - throw new BreakException('Exiting main thread'); + throw new BreakException('Exiting main thread', $exitCode); } // This is the child process. It's going to do all the work. @@ -168,6 +226,35 @@ public function beforeRun(Shell $shell) // Save this; we'll need to close it in `afterRun` $this->up = $up; + + // Save original stty state so we can restore on exit + if (@\posix_isatty(\STDIN)) { + $this->originalStty = @\shell_exec('stty -g 2>/dev/null'); + } + } + + /** + * Install SIGINT handler before executing user code. + */ + public function onExecute(Shell $shell, string $code) + { + // Only handle SIGINT in the child process + if (isset($this->up)) { + // Ensure signal processing is enabled so Ctrl-C can interrupt execution + if (@\posix_isatty(\STDIN)) { + @\shell_exec('stty isig 2>/dev/null'); + $this->restoreStty = true; + } + + \pcntl_async_signals(true); + + // Install SIGINT handler that throws exception during execution + \pcntl_signal(\SIGINT, function () { + throw new InterruptException('Ctrl+C'); + }); + } + + return null; } /** @@ -183,10 +270,25 @@ public function beforeLoop(Shell $shell) /** * Clean up old savegames at the end of each loop iteration. * - * @param Shell $shell + * Restores terminal state and clears stdin if execution was interrupted. */ public function afterLoop(Shell $shell) { + // Only handle cleanup in child process + if (isset($this->up)) { + // Restore default SIGINT handler after execution + if (!$this->sigintHandlerInstalled) { + \pcntl_signal(\SIGINT, \SIG_DFL); + } + + // Restore terminal to raw mode after execution + // This prevents Ctrl-C at the prompt from generating SIGINT + if ($this->restoreStty) { + @\shell_exec('stty -isig 2>/dev/null'); + $this->restoreStty = false; + } + } + // if there's an old savegame hanging around, let's kill it. if (isset($this->savegame)) { \posix_kill($this->savegame, \SIGKILL); @@ -198,14 +300,26 @@ public function afterLoop(Shell $shell) * After the REPL session ends, send the scope variables back up to the main * thread (if this is a child thread). * - * @param Shell $shell + * {@inheritdoc} */ - public function afterRun(Shell $shell) + public function afterRun(Shell $shell, int $exitCode = 0) { - // We're a child thread. Send the scope variables back up to the main thread. + // We're a child thread. Send the scope variables and exit code back up to the main thread. if (isset($this->up)) { - \fwrite($this->up, $this->serializeReturn($shell->getScopeVariables(false))); - \fclose($this->up); + $data = $this->serializeReturn($exitCode, $shell->getScopeVariables(false)); + + // Suppress errors in case the pipe is broken (e.g., if parent was interrupted) + @\fwrite($this->up, $data); + @\fclose($this->up); + + // Restore original terminal state before exiting. + // + // We set `stty isig` during execution, so Ctrl-C can interrupt, and + // `stty -isig` after, so readline can handle it at the prompt. + // Let's put things back the way we found them. + if ($this->originalStty !== null) { + @\shell_exec('stty '.\escapeshellarg(\trim($this->originalStty)).' 2>/dev/null'); + } \posix_kill(\posix_getpid(), \SIGKILL); } @@ -236,25 +350,51 @@ private function createSavegame() } // worker didn't exit cleanly, we'll need to have another go + // @phan-suppress-next-line PhanPossiblyInfiniteRecursionSameParams - recursion exits via posix_kill above $this->createSavegame(); } } /** - * Serialize all serializable return values. + * Clear stdin buffer after interruption, in case SIGINT left the stream in a bad state. + */ + private function clearStdinBuffer(): void + { + if (!\defined('STDIN') || !\is_resource(\STDIN)) { + return; + } + + // Check if the stream is still usable + $meta = @\stream_get_meta_data(\STDIN); + if (!$meta || ($meta['eof'] ?? false)) { + return; + } + + // Drain any buffered input, suppressing I/O errors + @\stream_set_blocking(\STDIN, false); + while (@\fgetc(\STDIN) !== false) { + } + @\stream_set_blocking(\STDIN, true); + } + + /** + * Serialize exit code and scope variables for transmission to parent process. * * A naïve serialization will run into issues if there is a Closure or * SimpleXMLElement (among other things) in scope when exiting the execution * loop. We'll just ignore these unserializable classes, and serialize what * we can. * - * @param array $return + * @param int $exitCode Exit code from the child process + * @param array $scopeVars Scope variables to serialize + * + * @return string Serialized data array containing exitCode and scopeVars */ - private function serializeReturn(array $return): string + private function serializeReturn(int $exitCode, array $scopeVars): string { $serializable = []; - foreach ($return as $key => $value) { + foreach ($scopeVars as $key => $value) { // No need to return magic variables if (Context::isSpecialVariableName($key)) { continue; @@ -265,7 +405,7 @@ private function serializeReturn(array $return): string continue; } - if (\version_compare(\PHP_VERSION, '8.1', '>=') && $value instanceof \UnitEnum) { + if (\PHP_VERSION_ID >= 80100 && $value instanceof \UnitEnum) { // Enums defined in the REPL session can't be unserialized. $ref = new \ReflectionObject($value); if (\strpos($ref->getFileName(), ": eval()'d code") !== false) { @@ -281,6 +421,9 @@ private function serializeReturn(array $return): string } } - return @\serialize($serializable); + return @\serialize([ + 'exitCode' => $exitCode, + 'scopeVars' => $serializable, + ]); } } diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/RunkitReloader.php b/app/vendor/psy/psysh/src/ExecutionLoop/RunkitReloader.php index 4ba996a54..e7af30c55 100644 --- a/app/vendor/psy/psysh/src/ExecutionLoop/RunkitReloader.php +++ b/app/vendor/psy/psysh/src/ExecutionLoop/RunkitReloader.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -12,18 +12,23 @@ namespace Psy\ExecutionLoop; use PhpParser\Parser; +use Psy\ConfigPaths; use Psy\Exception\ParseErrorException; +use Psy\OutputAware; use Psy\ParserFactory; use Psy\Shell; +use Psy\Util\Docblock; +use Symfony\Component\Console\Output\OutputInterface; /** * A runkit-based code reloader, which is pretty much magic. * * @todo Remove RunkitReloader once we drop support for PHP 7.x :( */ -class RunkitReloader extends AbstractListener +class RunkitReloader extends AbstractListener implements OutputAware { private Parser $parser; + private ?OutputInterface $output = null; private array $timestamps = []; /** @@ -43,21 +48,26 @@ public function __construct() $this->parser = (new ParserFactory())->createParser(); } + /** + * {@inheritdoc} + */ + public function setOutput(OutputInterface $output): void + { + $this->output = $output; + } + /** * Reload code on input. - * - * @param Shell $shell - * @param string $input */ public function onInput(Shell $shell, string $input) { $this->reload($shell); + + return null; } /** * Look through included files and update anything with a new timestamp. - * - * @param Shell $shell */ private function reload(Shell $shell) { @@ -86,18 +96,21 @@ private function reload(Shell $shell) $this->timestamps[$file] = $timestamp; } - // switch (count($modified)) { - // case 0: - // return; + if (\count($modified) === 0) { + return; + } - // case 1: - // printf("Reloading modified file: \"%s\"\n", str_replace(getcwd(), '.', $file)); - // break; + // Clear magic method/property cache since docblocks may have changed + Docblock::clearMagicCache(); - // default: - // printf("Reloading %d modified files\n", count($modified)); - // break; - // } + // Notify user about reload attempts + if ($this->output) { + if (\count($modified) === 1) { + $this->output->writeln(\sprintf('Reloading %s', ConfigPaths::prettyPath($modified[0]))); + } else { + $this->output->writeln(\sprintf('Reloading %d files', \count($modified))); + } + } foreach ($modified as $file) { $flags = ( @@ -120,11 +133,7 @@ private function reload(Shell $shell) } /** - * Should this file be re-imported? - * - * Use PHP-Parser to ensure that the file is valid PHP. - * - * @param string $file + * Check if file has valid PHP syntax. */ private function lintFile(string $file): bool { diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/SignalHandler.php b/app/vendor/psy/psysh/src/ExecutionLoop/SignalHandler.php new file mode 100644 index 000000000..ba7f4129b --- /dev/null +++ b/app/vendor/psy/psysh/src/ExecutionLoop/SignalHandler.php @@ -0,0 +1,126 @@ +originalStty = @\shell_exec('stty -g 2>/dev/null'); + } + } + + /** + * Install SIGINT handler before executing user code. + */ + public function onExecute(Shell $shell, string $code) + { + $this->wasInterrupted = false; + + // Ensure signal processing is enabled so Ctrl-C can interrupt execution + if (@\posix_isatty(\STDIN)) { + @\shell_exec('stty isig 2>/dev/null'); + $this->restoreStty = true; + } + + \pcntl_async_signals(true); + + // Install SIGINT handler that throws exception during execution + $interrupted = &$this->wasInterrupted; + $this->sigintHandlerInstalled = \pcntl_signal(\SIGINT, function () use (&$interrupted) { + $interrupted = true; + throw new InterruptException('Ctrl+C'); + }); + + return null; + } + + /** + * Called at the end of each loop. + * + * Restores terminal state and clears stdin if execution was interrupted. + */ + public function afterLoop(Shell $shell) + { + // Restore default SIGINT handler after execution + if ($this->sigintHandlerInstalled) { + \pcntl_signal(\SIGINT, \SIG_DFL); + $this->sigintHandlerInstalled = false; + } + + // Restore terminal to raw mode after execution + // This prevents Ctrl-C at the prompt from generating SIGINT + if ($this->restoreStty) { + @\shell_exec('stty -isig 2>/dev/null'); + $this->restoreStty = false; + } + + // Clear any pending input from the interrupted stdin stream + // The SIGINT may have left the stream in a bad state + if ($this->wasInterrupted && \defined('STDIN') && \is_resource(\STDIN)) { + // Check if the stream is still usable + $meta = @\stream_get_meta_data(\STDIN); + if ($meta && !($meta['eof'] ?? false)) { + // Drain any buffered input, suppressing I/O errors + @\stream_set_blocking(\STDIN, false); + while (@\fgetc(\STDIN) !== false) { + } + @\stream_set_blocking(\STDIN, true); + } + $this->wasInterrupted = false; + } + } + + /** + * Restore original terminal state when the REPL exits. + */ + public function afterRun(Shell $shell, int $exitCode = 0) + { + if ($this->originalStty !== null) { + @\shell_exec('stty '.\escapeshellarg(\trim($this->originalStty)).' 2>/dev/null'); + } + } +} diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/UopzReloader.php b/app/vendor/psy/psysh/src/ExecutionLoop/UopzReloader.php new file mode 100644 index 000000000..15660fabc --- /dev/null +++ b/app/vendor/psy/psysh/src/ExecutionLoop/UopzReloader.php @@ -0,0 +1,305 @@ + File path => last processed timestamp */ + private array $timestamps = []; + + /** + * File paths with skipped elements, awaiting force-reload via yolo. + * + * @var array File path => last processed timestamp + */ + private array $skippedFiles = []; + + /** @var bool Whether to bypass safety warnings (set by yolo command) */ + private bool $forceReload = false; + + /** + * Only enabled if uopz extension is installed with required functions. + * + * Requires uopz 5.0+ which provides uopz_set_return() and uopz_redefine(). + */ + public static function isSupported(): bool + { + return \extension_loaded('uopz') && DependencyChecker::functionsAvailable([ + 'uopz_set_return', + 'uopz_redefine', + 'uopz_unset_return', + 'uopz_undefine', + ]); + } + + /** + * Construct a Uopz Reloader. + */ + public function __construct() + { + $this->parser = (new ParserFactory())->createParser(); + $this->printer = new PrettyPrinter\Standard(); + } + + /** + * {@inheritdoc} + */ + public function setOutput(OutputInterface $output): void + { + $this->output = $output; + } + + /** + * Enable or disable force-reload mode. + * + * When enabled, safety checks are bypassed and any pending skipped files + * are immediately re-processed. + */ + public function setForceReload(bool $force) + { + $this->forceReload = $force; + + // Re-process any skipped files now that force-reload is enabled + if ($force && !empty($this->skippedFiles) && $this->shell !== null) { + $this->reloadSkippedFiles(); + } + } + + /** + * Re-process files that were previously skipped. + */ + private function reloadSkippedFiles(): void + { + $files = $this->skippedFiles; + $this->skippedFiles = []; + + if (\count($files) === 1) { + $this->writeInfo(\sprintf('YOLO: Force-reloading %s', ConfigPaths::prettyPath(\array_key_first($files)))); + } else { + $this->writeInfo(\sprintf('YOLO: Force-reloading %d files', \count($files))); + } + + foreach ($files as $file => $timestamp) { + $this->reloadFile($file); + $this->timestamps[$file] = $timestamp; + } + } + + /** + * Reload code on input. + */ + public function onInput(Shell $shell, string $input) + { + $this->shell = $shell; + $this->reload(); + + return null; + } + + /** + * Look through included files and update anything with a new timestamp. + */ + private function reload(): void + { + \clearstatcache(); + $modified = []; + + foreach (\get_included_files() as $file) { + // Skip files that no longer exist + if (!\file_exists($file)) { + continue; + } + + $timestamp = \filemtime($file); + + if (!isset($this->timestamps[$file])) { + $this->timestamps[$file] = $timestamp; + continue; + } + + if ($this->timestamps[$file] === $timestamp) { + continue; + } + + if (!$this->lintFile($file)) { + $this->writeError(\sprintf('Modified file "%s" has syntax errors and cannot be reloaded', ConfigPaths::prettyPath($file))); + continue; + } + + $modified[$file] = $timestamp; + } + + if (\count($modified) === 0) { + return; + } + + // Clear magic method/property cache since docblocks may have changed + Docblock::clearMagicCache(); + + // Notify user about reload attempts + if ($this->forceReload) { + if (\count($modified) === 1) { + $this->writeInfo(\sprintf('YOLO: Force-reloading %s', ConfigPaths::prettyPath(\array_key_first($modified)))); + } else { + $this->writeInfo(\sprintf('YOLO: Force-reloading %d files', \count($modified))); + } + } else { + if (\count($modified) === 1) { + $this->writeInfo(\sprintf('Reloading %s', ConfigPaths::prettyPath(\array_key_first($modified)))); + } else { + $this->writeInfo(\sprintf('Reloading %d files', \count($modified))); + } + } + + foreach ($modified as $file => $timestamp) { + $hadSkips = $this->reloadFile($file); + $this->timestamps[$file] = $timestamp; + if ($hadSkips) { + // Track for later force-reload via yolo + $this->skippedFiles[$file] = $timestamp; + } else { + unset($this->skippedFiles[$file]); + } + } + } + + /** + * Reload a single file by parsing it and applying uopz overrides. + * + * @return bool True if any elements were skipped (need yolo to force) + */ + private function reloadFile(string $file): bool + { + try { + $code = \file_get_contents($file); + $ast = $this->parser->parse($code); + + if ($ast === null) { + return false; + } + + $traverser = new NodeTraverser(); + $reloader = new UopzReloaderVisitor($this->printer, $this->forceReload); + $traverser->addVisitor($reloader); + $traverser->traverse($ast); + + // Check if there were any warnings about limitations + if ($reloader->hasWarnings()) { + foreach ($reloader->getWarnings() as $warning) { + $this->writeWarning($warning); + } + } + + return $reloader->hasSkips(); + } catch (\Throwable $e) { + $this->writeError(\sprintf('Failed to reload %s: %s', ConfigPaths::prettyPath($file), $e->getMessage())); + + return false; + } + } + + /** + * Write an info message. + */ + private function writeInfo(string $message): void + { + if ($this->output) { + $this->output->writeln(\sprintf('%s', $message)); + } + } + + /** + * Write a warning message. + */ + private function writeWarning(string $message): void + { + if ($this->output) { + $this->output->writeln(\sprintf('Warning: %s', $message)); + } + } + + /** + * Write an error message using shell exception handling. + */ + private function writeError(string $message): void + { + if ($this->shell) { + try { + $this->shell->writeException(new ParseErrorException($message)); + + return; + } catch (\Throwable $e) { + // Shell not fully initialized, fall back to output + } + } + + if ($this->output) { + $this->output->writeln(\sprintf('Error: %s', $message)); + } + } + + /** + * Check if file has valid PHP syntax. + */ + private function lintFile(string $file): bool + { + try { + $this->parser->parse(\file_get_contents($file)); + } catch (\Throwable $e) { + return false; + } + + return true; + } +} diff --git a/app/vendor/psy/psysh/src/ExecutionLoop/UopzReloaderVisitor.php b/app/vendor/psy/psysh/src/ExecutionLoop/UopzReloaderVisitor.php new file mode 100644 index 000000000..89d215e51 --- /dev/null +++ b/app/vendor/psy/psysh/src/ExecutionLoop/UopzReloaderVisitor.php @@ -0,0 +1,646 @@ +printer = $printer; + $this->forceReload = $forceReload; + } + + /** + * Check if any warnings were generated during reloading. + */ + public function hasWarnings(): bool + { + return \count($this->warnings) > 0; + } + + /** + * Get all warnings generated during reloading. + * + * @return string[] + */ + public function getWarnings(): array + { + return $this->warnings; + } + + /** + * Check if any elements were skipped during reloading. + */ + public function hasSkips(): bool + { + return $this->hasSkips; + } + + /** + * Add a warning message. + */ + private function addWarning(string $message): void + { + $this->warnings[] = $message; + } + + /** + * {@inheritdoc} + */ + public function enterNode(Node $node) + { + // Track namespace + if ($node instanceof Stmt\Namespace_) { + $this->namespace = $node->name ? $node->name->toString() : ''; + } + + // Track current class and check for limitations + if ($node instanceof Stmt\Class_ || $node instanceof Stmt\Interface_ || $node instanceof Stmt\Trait_) { + $name = $node->name ? $node->name->toString() : null; + $this->currentClass = $name ? $this->getFullyQualifiedName($name) : null; + + if ($this->currentClass) { + $this->checkClassLimitations($this->currentClass, $node); + } + } + + // Track when we enter conditional/control structures at global scope + if ($this->currentClass === null && $this->currentFunction === null && $this->isControlStructure($node)) { + $this->conditionalDepth++; + } + + // Detect side effects at global/namespace scope (but not if we're already tracking it as conditional) + if ($this->currentClass === null && $this->currentFunction === null && $this->conditionalDepth === 0) { + $this->checkForSideEffects($node); + } + + // Reload class methods + if ($node instanceof Stmt\ClassMethod && $this->currentClass) { + $this->reloadMethod($this->currentClass, $node); + } + + // Reload functions (skip if inside conditional, unless force mode) + if ($node instanceof Stmt\Function_) { + // Track that we're entering a function + $this->currentFunction = $node->name->toString(); + + if ($this->conditionalDepth > 0 && $this->currentClass === null) { + $funcName = $node->name->toString(); + $snippet = \sprintf('if (...) { function %s() ... }', $funcName); + + if ($this->forceReload) { + $this->addWarning(\sprintf('YOLO: Force-reloaded %s', $snippet)); + $this->reloadFunction($node); + } else { + $this->addWarning(\sprintf('Skipped conditional: %s (use `yolo` to force)', $snippet)); + $this->hasSkips = true; + } + } else { + $this->reloadFunction($node); + } + } + + // Reload constants + if ($node instanceof Stmt\ClassConst && $this->currentClass) { + $this->reloadClassConstants($this->currentClass, $node); + } + + if ($node instanceof Stmt\Const_) { + if ($this->conditionalDepth > 0 && $this->currentClass === null) { + $constNode = $node->consts[0] ?? null; + $constName = $constNode ? $constNode->name->toString() : 'CONST'; + $snippet = \sprintf('if (...) { const %s = ...; }', $constName); + + if ($this->forceReload) { + $this->addWarning(\sprintf('YOLO: Force-reloaded %s', $snippet)); + $this->reloadGlobalConstants($node); + } else { + $this->addWarning(\sprintf('Skipped conditional: %s (use `yolo` to force)', $snippet)); + $this->hasSkips = true; + } + } else { + $this->reloadGlobalConstants($node); + } + } + + return null; + } + + /** + * {@inheritdoc} + */ + public function leaveNode(Node $node) + { + // Clear current class when leaving class/interface/trait + if ($node instanceof Stmt\Class_ || $node instanceof Stmt\Interface_ || $node instanceof Stmt\Trait_) { + $this->currentClass = null; + } + + // Clear current function when leaving function + if ($node instanceof Stmt\Function_) { + $this->currentFunction = null; + } + + // Track when we leave conditional/control structures at global scope + if ($this->currentClass === null && $this->currentFunction === null && $this->isControlStructure($node)) { + $this->conditionalDepth--; + } + + return null; + } + + /** + * Reload a class method using uopz_set_return. + */ + private function reloadMethod(string $className, Stmt\ClassMethod $method): void + { + $methodName = $method->name->toString(); + + // Skip abstract methods + if ($method->isAbstract()) { + return; + } + + // Check for static variables in method body + if ($this->hasStaticVariables($method->stmts)) { + $snippet = \sprintf('%s::%s() { static $var = ...; }', $className, $methodName); + $this->addWarning(\sprintf('Static vars will reset: %s', $snippet)); + } + + $closure = $this->createClosure($method->params, $method->stmts, $method->returnType); + if ($closure !== null) { + try { + \uopz_set_return($className, $methodName, $closure, true); + } catch (\Throwable $e) { + $this->addWarning(\sprintf('Failed to reload %s::%s(): %s', $className, $methodName, $e->getMessage())); + } + } + } + + /** + * Reload a function using uopz_set_return. + */ + private function reloadFunction(Stmt\Function_ $function): void + { + $functionName = $this->getFullyQualifiedName($function->name->toString()); + + // New function; just define it via eval + if (!\function_exists($functionName)) { + try { + $code = ''; + if ($this->namespace !== '') { + $code .= 'namespace '.$this->namespace.'; '; + } + $code .= $this->printer->prettyPrint([$function]); + eval($code); + } catch (\Throwable $e) { + $this->addWarning(\sprintf('Failed to add %s(): %s', $functionName, $e->getMessage())); + } + + return; + } + + // Existing function; check for static variables (state will reset on reload) + if ($this->hasStaticVariables($function->stmts)) { + $snippet = \sprintf('%s() { static $var = ...; }', $functionName); + $this->addWarning(\sprintf('Static vars will reset: %s', $snippet)); + } + + // Use uopz to override existing function + $closure = $this->createClosure($function->params, $function->stmts, $function->returnType); + if ($closure !== null) { + try { + \uopz_set_return($functionName, $closure, true); + } catch (\Throwable $e) { + $this->addWarning(\sprintf('Failed to reload %s(): %s', $functionName, $e->getMessage())); + } + } + } + + /** + * Create a closure from parameters and statements. + * + * @param Node\Param[] $params + * @param Stmt[]|null $stmts + * @param Node|null $returnType + * + * @return \Closure|null + */ + private function createClosure(array $params, ?array $stmts, ?Node $returnType = null): ?\Closure + { + $paramStrs = []; + foreach ($params as $param) { + $paramStr = ''; + + if ($param->type) { + $paramStr .= $this->printer->prettyPrint([$param->type]).' '; + } + + if ($param->variadic) { + $paramStr .= '...'; + } + + if ($param->byRef) { + $paramStr .= '&'; + } + + $paramStr .= '$'.$param->var->name; + + if ($param->default) { + $paramStr .= ' = '.$this->printer->prettyPrintExpr($param->default); + } + + $paramStrs[] = $paramStr; + } + + $paramList = \implode(', ', $paramStrs); + + $returnTypeStr = ''; + if ($returnType !== null) { + $returnTypeStr = ': '.$this->printer->prettyPrint([$returnType]); + } + + $body = ''; + if ($stmts) { + $bodyStmts = []; + foreach ($stmts as $stmt) { + $bodyStmts[] = $this->printer->prettyPrint([$stmt]); + } + $body = \implode("\n", $bodyStmts); + } + + $closureCode = \sprintf("return function(%s)%s {\n%s\n};", $paramList, $returnTypeStr, $body); + + try { + return eval($closureCode); + } catch (\Throwable $e) { + return null; + } + } + + /** + * Reload class constants using uopz_redefine. + */ + private function reloadClassConstants(string $className, Stmt\ClassConst $const): void + { + foreach ($const->consts as $constNode) { + $constName = $constNode->name->toString(); + $value = $this->evaluateConstValue($constNode->value); + + try { + \uopz_redefine($className, $constName, $value); + } catch (\Throwable $e) { + $this->addWarning(\sprintf('Failed to reload %s::%s: %s', $className, $constName, $e->getMessage())); + } + } + } + + /** + * Reload global constants using uopz_redefine. + */ + private function reloadGlobalConstants(Stmt\Const_ $const): void + { + foreach ($const->consts as $constNode) { + $constName = $this->getFullyQualifiedName($constNode->name->toString()); + $value = $this->evaluateConstValue($constNode->value); + + try { + \uopz_redefine($constName, $value); + } catch (\Throwable $e) { + $this->addWarning(\sprintf('Failed to reload %s: %s', $constName, $e->getMessage())); + } + } + } + + /** + * Evaluate a constant value from AST node. + * + * @return mixed + */ + private function evaluateConstValue(Expr $expr) + { + // For simple scalar values, we can evaluate directly + try { + $code = 'printer->prettyPrintExpr($expr).';'; + + return eval(\substr($code, 6)); + } catch (\Throwable $e) { + return null; + } + } + + /** + * Get a fully-qualified name (class, function, constant, etc). + */ + private function getFullyQualifiedName(string $name): string + { + if ($this->namespace && \strpos($name, '\\') !== 0) { + return $this->namespace.'\\'.$name; + } + + return $name; + } + + /** + * Check if a node is a control structure. + */ + private function isControlStructure(Node $node): bool + { + return $node instanceof Stmt\If_ || + $node instanceof Stmt\Switch_ || + $node instanceof Stmt\For_ || + $node instanceof Stmt\Foreach_ || + $node instanceof Stmt\While_ || + $node instanceof Stmt\Do_ || + $node instanceof Stmt\TryCatch; + } + + /** + * Check if statements contain static variable declarations. + * + * @param Stmt[]|null $stmts + */ + private function hasStaticVariables(?array $stmts): bool + { + if ($stmts === null) { + return false; + } + + foreach ($stmts as $stmt) { + // Direct static declaration + if ($stmt instanceof Stmt\Static_) { + return true; + } + + // Recursively check nested structures (if/for/while/etc) + if ($stmt instanceof Stmt\If_) { + if ($this->hasStaticVariables($stmt->stmts)) { + return true; + } + foreach ($stmt->elseifs as $elseif) { + if ($this->hasStaticVariables($elseif->stmts)) { + return true; + } + } + if ($stmt->else && $this->hasStaticVariables($stmt->else->stmts)) { + return true; + } + } + + if ($stmt instanceof Stmt\For_ || + $stmt instanceof Stmt\Foreach_ || + $stmt instanceof Stmt\While_ || + $stmt instanceof Stmt\Do_) { + if ($this->hasStaticVariables($stmt->stmts)) { + return true; + } + } + + if ($stmt instanceof Stmt\Switch_) { + foreach ($stmt->cases as $case) { + if ($this->hasStaticVariables($case->stmts)) { + return true; + } + } + } + + if ($stmt instanceof Stmt\TryCatch) { + if ($this->hasStaticVariables($stmt->stmts)) { + return true; + } + foreach ($stmt->catches as $catch) { + if ($this->hasStaticVariables($catch->stmts)) { + return true; + } + } + if ($stmt->finally && $this->hasStaticVariables($stmt->finally->stmts)) { + return true; + } + } + } + + return false; + } + + /** + * Check for side effects that won't be re-executed on reload. + * + * Detects top-level code that has side effects (function calls, variable + * assignments, etc.) which will not be re-run when the file is reloaded. + */ + private function checkForSideEffects(Node $node): void + { + // Skip declarations (these are handled by uopz) + if ($node instanceof Stmt\Class_ || + $node instanceof Stmt\Interface_ || + $node instanceof Stmt\Trait_ || + $node instanceof Stmt\Function_ || + $node instanceof Stmt\Const_ || + $node instanceof Stmt\Namespace_ || + $node instanceof Stmt\Use_) { + return; + } + + // Only check statements, not expressions (to avoid duplicate warnings) + // Expression statements contain the actual expression + if ($node instanceof Stmt\Expression) { + $expr = $node->expr; + $snippet = $this->printer->prettyPrintExpr($expr); + + // Truncate long snippets + if (\strlen($snippet) > 50) { + $snippet = \substr($snippet, 0, 47).'...'; + } + + $this->addWarning(\sprintf('Not re-run: %s', $snippet)); + + return; + } + + // Echo/print statements + if ($node instanceof Stmt\Echo_) { + $firstExpr = $node->exprs[0] ?? null; + $snippet = $firstExpr !== null + ? 'echo '.$this->printer->prettyPrintExpr($firstExpr) + : 'echo ...'; + if (\strlen($snippet) > 50) { + $snippet = \substr($snippet, 0, 47).'...'; + } + $this->addWarning(\sprintf('Not re-run: %s', $snippet)); + + return; + } + + // Global variable declarations + if ($node instanceof Stmt\Global_) { + $varNames = []; + foreach ($node->vars as $var) { + if ($var instanceof Expr\Variable) { + $varNames[] = '$'.$var->name; + } + } + $snippet = 'global '.\implode(', ', $varNames); + $this->addWarning(\sprintf('Not re-run: %s', $snippet)); + + return; + } + + // Static variable declarations (inside functions are OK, but top-level would be unusual) + if ($node instanceof Stmt\Static_) { + $varNames = []; + foreach ($node->vars as $var) { + $varNames[] = '$'.$var->var->name; + } + $snippet = 'static '.\implode(', ', $varNames); + $this->addWarning(\sprintf('Not re-run: %s', $snippet)); + + return; + } + + // If/switch/for/while/etc control structures at top level + if ($this->isControlStructure($node)) { + $type = 'if'; + if ($node instanceof Stmt\Switch_) { + $type = 'switch'; + } elseif ($node instanceof Stmt\For_) { + $type = 'for'; + } elseif ($node instanceof Stmt\Foreach_) { + $type = 'foreach'; + } elseif ($node instanceof Stmt\While_) { + $type = 'while'; + } elseif ($node instanceof Stmt\Do_) { + $type = 'do-while'; + } elseif ($node instanceof Stmt\TryCatch) { + $type = 'try-catch'; + } + + $this->addWarning(\sprintf('Not re-run: %s (...) { ... }', $type)); + + return; + } + } + + /** + * Check for known limitations when reloading a class. + */ + private function checkClassLimitations(string $className, Node $node): void + { + // Check if class already exists + if (!\class_exists($className, false) && !\interface_exists($className, false) && !\trait_exists($className, false)) { + // New class/interface/trait - uopz cannot add these + $type = $node instanceof Stmt\Interface_ ? 'interface' : ($node instanceof Stmt\Trait_ ? 'trait' : 'class'); + $this->addWarning(\sprintf('Cannot add %s %s', $type, $className)); + + return; + } + + // For existing classes, check for structural changes + if (!($node instanceof Stmt\Class_)) { + return; + } + + // Check for new properties (cannot be added) + foreach ($node->stmts as $stmt) { + if ($stmt instanceof Stmt\Property) { + foreach ($stmt->props as $prop) { + $propName = $prop->name->toString(); + if (!\property_exists($className, $propName)) { + $visibility = $stmt->isPublic() ? 'public' : ($stmt->isProtected() ? 'protected' : 'private'); + $static = $stmt->isStatic() ? 'static ' : ''; + $this->addWarning(\sprintf('Cannot add %s$%s', $static.$visibility.' ', $propName)); + } + } + } + + // Check for new methods (will try to add but may fail silently) + if ($stmt instanceof Stmt\ClassMethod) { + $methodName = $stmt->name->toString(); + if (!\method_exists($className, $methodName)) { + $this->addWarning(\sprintf('Cannot add %s::%s()', $className, $methodName)); + } + } + } + + // Check for inheritance changes + if ($node->extends) { + $newParent = $node->extends->toString(); + $reflection = new ReflectionClass($className); + $currentParent = $reflection->getParentClass(); + + if ($currentParent && $currentParent->getName() !== $this->getFullyQualifiedName($newParent)) { + $this->addWarning(\sprintf('Cannot change parent of %s', $className)); + } + } + + // Check for interface changes + if ($node->implements) { + $newInterfaces = \array_map(function ($interface) { + return $this->getFullyQualifiedName($interface->toString()); + }, $node->implements); + + $reflection = new ReflectionClass($className); + $currentInterfaces = $reflection->getInterfaceNames(); + + $added = \array_diff($newInterfaces, $currentInterfaces); + $removed = \array_diff($currentInterfaces, $newInterfaces); + + if (\count($added) > 0 || \count($removed) > 0) { + $this->addWarning(\sprintf('Cannot change interfaces of %s', $className)); + } + } + } +} diff --git a/app/vendor/psy/psysh/src/ExecutionLoopClosure.php b/app/vendor/psy/psysh/src/ExecutionLoopClosure.php index 28c6561a4..524c7f3ad 100644 --- a/app/vendor/psy/psysh/src/ExecutionLoopClosure.php +++ b/app/vendor/psy/psysh/src/ExecutionLoopClosure.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -12,6 +12,7 @@ namespace Psy; use Psy\Exception\BreakException; +use Psy\Exception\InterruptException; use Psy\Exception\ThrowUpException; /** @@ -28,6 +29,7 @@ public function __construct(Shell $__psysh__) { $this->setClosure($__psysh__, function () use ($__psysh__) { // Restore execution scope variables + // @phan-suppress-next-line PhanTypeNonVarPassByRef assigning to a temp variable pollutes scope \extract($__psysh__->getScopeVariables(false)); while (true) { @@ -39,6 +41,7 @@ public function __construct(Shell $__psysh__) try { // Pull in any new execution scope variables if ($__psysh__->getLastExecSuccess()) { + // @phan-suppress-next-line PhanTypeNonVarPassByRef assigning to a temp variable pollutes scope \extract($__psysh__->getScopeVariablesDiff(\get_defined_vars())); } @@ -70,18 +73,24 @@ public function __construct(Shell $__psysh__) $__psysh__->writeReturnValue($_); } catch (BreakException $_e) { + // exit() or ctrl-d exits the REPL $__psysh__->writeException($_e); - return; + return $_e->getCode(); } catch (ThrowUpException $_e) { + // `throw-up` command throws the exception out of the REPL $__psysh__->writeException($_e); throw $_e; + } catch (InterruptException $_e) { + // ctrl-c stops execution, but continues the REPL + $__psysh__->writeException($_e); } catch (\Throwable $_e) { + // Everything else gets printed to the shell output $__psysh__->writeException($_e); + } finally { + $__psysh__->afterLoop(); } - - $__psysh__->afterLoop(); } }); } diff --git a/app/vendor/psy/psysh/src/Formatter/CodeFormatter.php b/app/vendor/psy/psysh/src/Formatter/CodeFormatter.php index 98db81e3a..584b3a95d 100644 --- a/app/vendor/psy/psysh/src/Formatter/CodeFormatter.php +++ b/app/vendor/psy/psysh/src/Formatter/CodeFormatter.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -13,6 +13,7 @@ use Psy\Exception\RuntimeException; use Symfony\Component\Console\Formatter\OutputFormatter; +use Symfony\Component\Console\Formatter\OutputFormatterInterface; /** * A pretty-printer for code. @@ -28,14 +29,19 @@ class CodeFormatter implements ReflectorFormatter const HIGHLIGHT_PUBLIC = 'public'; const HIGHLIGHT_PROTECTED = 'protected'; const HIGHLIGHT_PRIVATE = 'private'; + const HIGHLIGHT_CLASS = 'class'; + const HIGHLIGHT_BOOL = 'bool'; const HIGHLIGHT_CONST = 'const'; const HIGHLIGHT_NUMBER = 'number'; const HIGHLIGHT_STRING = 'string'; + const HIGHLIGHT_ARRAY_KEY = 'array_key'; const HIGHLIGHT_COMMENT = 'code_comment'; const HIGHLIGHT_INLINE_HTML = 'inline_html'; - private const TOKEN_MAP = [ + private const CLASS_REFERENCE_KEYWORDS = [\T_NEW, \T_INSTANCEOF, \T_CATCH]; + + private const BASE_TOKEN_MAP = [ // Not highlighted \T_OPEN_TAG => self::HIGHLIGHT_DEFAULT, \T_OPEN_TAG_WITH_ECHO => self::HIGHLIGHT_DEFAULT, @@ -73,6 +79,71 @@ class CodeFormatter implements ReflectorFormatter \T_INLINE_HTML => self::HIGHLIGHT_INLINE_HTML, ]; + private const KEYWORD_TOKENS = [ + \T_ABSTRACT, + \T_ARRAY, + \T_AS, + \T_BREAK, + \T_CALLABLE, + \T_CASE, + \T_CATCH, + \T_CLONE, + \T_CONTINUE, + \T_DECLARE, + \T_DEFAULT, + \T_DO, + \T_ECHO, + \T_ELSE, + \T_ELSEIF, + \T_EMPTY, + \T_ENDDECLARE, + \T_ENDFOR, + \T_ENDFOREACH, + \T_ENDIF, + \T_ENDSWITCH, + \T_ENDWHILE, + \T_EVAL, + \T_EXIT, + \T_EXTENDS, + \T_FINAL, + \T_FINALLY, + \T_FN, + \T_FOR, + \T_FOREACH, + \T_FUNCTION, + \T_GLOBAL, + \T_GOTO, + \T_IF, + \T_IMPLEMENTS, + \T_INCLUDE, + \T_INCLUDE_ONCE, + \T_INSTANCEOF, + \T_INSTEADOF, + \T_INTERFACE, + \T_ISSET, + \T_LIST, + \T_LOGICAL_AND, + \T_LOGICAL_OR, + \T_LOGICAL_XOR, + \T_NAMESPACE, + \T_NEW, + \T_PRINT, + \T_REQUIRE, + \T_REQUIRE_ONCE, + \T_RETURN, + \T_STATIC, + \T_SWITCH, + \T_THROW, + \T_TRAIT, + \T_TRY, + \T_UNSET, + \T_USE, + \T_VAR, + \T_WHILE, + \T_YIELD, + \T_YIELD_FROM, + ]; + /** * Format the code represented by $reflector for shell output. * @@ -83,7 +154,9 @@ class CodeFormatter implements ReflectorFormatter public static function format(\Reflector $reflector): string { if (self::isReflectable($reflector)) { + // @phan-suppress-next-line PhanUndeclaredMethod - getFileName/getEndLine exist on ReflectionClass/ReflectionFunctionAbstract if ($code = @\file_get_contents($reflector->getFileName())) { + // @phan-suppress-next-line PhanUndeclaredMethod - getEndLine exists on ReflectionClass/ReflectionFunctionAbstract return self::formatCode($code, self::getStartLine($reflector), $reflector->getEndLine()); } } @@ -113,6 +186,52 @@ public static function formatCode(string $code, int $startLine = 1, ?int $endLin return \implode('', \iterator_to_array($lines)); } + /** + * Format a PHP snippet into ANSI-safe lines for inline shell rendering. + * + * Styles are applied line-by-line so multiline tokens do not leak styling + * across prompt boundaries. + * + * @return string[] + */ + public static function formatInputLines(string $code, ?OutputFormatterInterface $formatter = null): array + { + $lines = ['']; + $lineIndex = 0; + $first = true; + + foreach (self::tokenizeSpans(' $token) { + if (isset($arrayKeyIndexes[$index])) { + $nextType = self::HIGHLIGHT_ARRAY_KEY; + } elseif (isset($keywordNameIndexes[$index])) { + $nextType = self::HIGHLIGHT_KEYWORD; + } elseif (isset($classNameIndexes[$index])) { + $nextType = self::HIGHLIGHT_CLASS; + } else { + $nextType = self::nextHighlightType($token); + } $spanType = $spanType ?: $nextType; if ($spanType !== $nextType) { @@ -169,30 +299,408 @@ private static function tokenizeSpans(string $code): \Generator } /** - * Given a token and the current highlight span type, compute the next type. + * Given a token, compute the highlight type from the token map. * - * @param array|string $token \token_get_all token - * @param string|null $currentType + * @param array|string $token \token_get_all token * * @return string|null */ - private static function nextHighlightType($token, $currentType) + private static function nextHighlightType($token) { if ($token === '"') { return self::HIGHLIGHT_STRING; } if (\is_array($token)) { - if ($token[0] === \T_WHITESPACE) { - return $currentType; + if (($literalHighlight = self::literalHighlightType($token)) !== null) { + return $literalHighlight; + } + + $tokenMap = self::getTokenMap(); + if (\array_key_exists($token[0], $tokenMap)) { + return $tokenMap[$token[0]]; + } + } + + return self::HIGHLIGHT_DEFAULT; + } + + /** + * Build the token-to-style map once so unsupported token constants on older + * PHP versions can be ignored safely. + * + * @return string[] + */ + private static function getTokenMap(): array + { + static $tokenMap = null; + + if ($tokenMap !== null) { + return $tokenMap; + } + + $tokenMap = self::BASE_TOKEN_MAP; + + foreach (self::KEYWORD_TOKENS as $tokenType) { + $tokenMap[$tokenType] = self::HIGHLIGHT_KEYWORD; + } + + if (\defined('T_MATCH')) { + $tokenMap[\constant('T_MATCH')] = self::HIGHLIGHT_KEYWORD; + } + + return $tokenMap; + } + + /** + * Mark string literal tokens that are serving as array keys. + * + * This stays token-based instead of requiring a valid AST so it can work + * during interactive editing on incomplete input. + * + * @param array $tokens + * + * @return array + */ + private static function findArrayKeyTokenIndexes(array $tokens): array + { + $arrayKeyIndexes = []; + $stack = []; + $pendingArrayParen = false; + + foreach ($tokens as $index => $token) { + if (\is_array($token)) { + if ($token[0] === \T_ARRAY) { + $pendingArrayParen = true; + } + + if ($token[0] === \T_CONSTANT_ENCAPSED_STRING && self::isArrayContext($stack) && self::nextSignificantTokenIsDoubleArrow($tokens, $index)) { + $arrayKeyIndexes[$index] = true; + } + + if (!self::isIgnorableToken($token) && $token[0] !== \T_ARRAY) { + $pendingArrayParen = false; + } + + continue; + } + + if ($token === '(') { + $stack[] = [ + 'closing' => ')', + 'arrayLike' => $pendingArrayParen, + ]; + $pendingArrayParen = false; + continue; + } + + if ($token === '[') { + $stack[] = [ + 'closing' => ']', + 'arrayLike' => true, + ]; + $pendingArrayParen = false; + continue; + } + + if (($token === ')' || $token === ']') && !empty($stack)) { + $top = \array_pop($stack); + if (($top['closing'] ?? null) !== $token) { + $stack = []; + } + } + + if ($token !== ',' && $token !== '=>' && $token !== '=') { + $pendingArrayParen = false; + } + } + + return $arrayKeyIndexes; + } + + /** + * @param array $stack + */ + private static function isArrayContext(array $stack): bool + { + if ($stack === []) { + return false; + } + + $top = $stack[\count($stack) - 1]; + + return !empty($top['arrayLike']); + } + + /** + * @param array $tokens + */ + private static function nextSignificantTokenIsDoubleArrow(array $tokens, int $index): bool + { + $count = \count($tokens); + + for ($i = $index + 1; $i < $count; $i++) { + $token = $tokens[$i]; + + if (self::isIgnorableToken($token)) { + continue; + } + + return \is_array($token) && $token[0] === \T_DOUBLE_ARROW; + } + + return false; + } + + /** + * Mark tokens that are very likely to be class names from immediate syntax context. + * + * This is intentionally heuristic and conservative: declaration names, + * extends/implements lists, obvious runtime class references (`new`, + * `instanceof`, `catch`), and static references like `Foo::class`. + * + * On PHP 8+, qualified names arrive as T_NAME_* tokens and can be marked as + * a single unit. On PHP 7.4, qualified names are split across T_STRING and + * T_NS_SEPARATOR tokens, so we stitch them together only in these narrow, + * class-specific contexts. + * + * @param array $tokens + * + * @return array{0: array, 1: array} + */ + private static function findClassNameTokenIndexes(array $tokens): array + { + $classIndexes = []; + $keywordIndexes = []; + $context = null; + + foreach ($tokens as $index => $token) { + if (self::isIgnorableToken($token)) { + continue; + } + + if ($context !== null) { + if (self::literalHighlightType($token) !== null) { + continue; + } + + if (self::isClassNameToken($token)) { + if (self::isPseudoClassToken($token)) { + $keywordIndexes[$index] = true; + } else { + $classIndexes[$index] = true; + } + continue; + } + + if (self::isNamespaceSeparatorToken($token)) { + $classIndexes[$index] = true; + continue; + } + + if ($context === 'list' && ($token === ',' || $token === '&')) { + continue; + } + + if ($context === 'union' && ($token === '|' || $token === '&')) { + continue; + } + + if ($context === 'union' && $token === '?') { + continue; + } + + $context = null; + } + + if (!\is_array($token)) { + continue; + } + + $tokenType = $token[0]; + + if (self::isClassDeclarationKeyword($tokenType) && !self::previousSignificantTokenIs($tokens, $index, \T_DOUBLE_COLON)) { + $context = 'single'; + continue; + } + + if ($tokenType === \T_EXTENDS || $tokenType === \T_IMPLEMENTS) { + $context = 'list'; + continue; } - if (\array_key_exists($token[0], self::TOKEN_MAP)) { - return self::TOKEN_MAP[$token[0]]; + if (\in_array($tokenType, self::CLASS_REFERENCE_KEYWORDS, true)) { + $context = 'union'; + continue; + } + + if ($tokenType === \T_DOUBLE_COLON) { + self::markPreviousNameToken($tokens, $classIndexes, $keywordIndexes, $index - 1); + } + } + + return [$classIndexes, $keywordIndexes]; + } + + /** + * @param array|string $token + */ + private static function isIgnorableToken($token): bool + { + return \is_array($token) && ($token[0] === \T_WHITESPACE || $token[0] === \T_COMMENT || $token[0] === \T_DOC_COMMENT); + } + + /** + * @param array|string $token + */ + private static function isClassNameToken($token): bool + { + if (!\is_array($token)) { + return false; + } + + if ($token[0] === \T_STRING) { + return true; + } + + return \in_array($token[0], self::qualifiedNameTokenTypes(), true); + } + + /** + * @param array|string $token + */ + private static function isNamespaceSeparatorToken($token): bool + { + return \is_array($token) && $token[0] === \T_NS_SEPARATOR; + } + + /** + * @return int[] + */ + private static function qualifiedNameTokenTypes(): array + { + static $types = null; + + if ($types !== null) { + return $types; + } + + $types = []; + + foreach (['T_NAME_QUALIFIED', 'T_NAME_FULLY_QUALIFIED', 'T_NAME_RELATIVE'] as $tokenName) { + if (\defined($tokenName)) { + $types[] = \constant($tokenName); } } - return self::HIGHLIGHT_KEYWORD; + return $types; + } + + private static function isClassDeclarationKeyword(int $tokenType): bool + { + if (\in_array($tokenType, [\T_CLASS, \T_INTERFACE, \T_TRAIT], true)) { + return true; + } + + return \defined('T_ENUM') && $tokenType === \constant('T_ENUM'); + } + + /** + * @param array $tokens + */ + private static function previousSignificantTokenIs(array $tokens, int $index, int $tokenType): bool + { + for ($i = $index - 1; $i >= 0; $i--) { + $token = $tokens[$i]; + + if (self::isIgnorableToken($token)) { + continue; + } + + return \is_array($token) && $token[0] === $tokenType; + } + + return false; + } + + /** + * @param array $tokens + * @param array $classIndexes + * @param array $keywordIndexes + */ + private static function markPreviousNameToken(array $tokens, array &$classIndexes, array &$keywordIndexes, int $index): void + { + $chainIndexes = []; + + for ($i = $index; $i >= 0; $i--) { + $token = $tokens[$i]; + + if (self::isIgnorableToken($token)) { + if ($chainIndexes === []) { + continue; + } + + break; + } + + if (self::isNamespaceSeparatorToken($token) || self::isClassNameToken($token)) { + $chainIndexes[] = $i; + continue; + } + + break; + } + + if ($chainIndexes === []) { + return; + } + + $firstIndex = $chainIndexes[0]; + if (self::literalHighlightType($tokens[$firstIndex]) !== null) { + return; + } + + if (self::isPseudoClassToken($tokens[$firstIndex])) { + $keywordIndexes[$firstIndex] = true; + + return; + } + + foreach ($chainIndexes as $chainIndex) { + $classIndexes[$chainIndex] = true; + } + } + + /** + * @param array|string $token + */ + private static function isPseudoClassToken($token): bool + { + return \is_array($token) + && $token[0] === \T_STRING + && \in_array(\strtolower($token[1]), ['self', 'parent', 'static'], true); + } + + /** + * @param array|string $token + */ + private static function literalHighlightType($token): ?string + { + if (!\is_array($token) || $token[0] !== \T_STRING) { + return null; + } + + $value = \strtolower($token[1]); + + if ($value === 'true' || $value === 'false') { + return self::HIGHLIGHT_BOOL; + } + + if ($value === 'null') { + return self::HIGHLIGHT_CONST; + } + + return null; } /** @@ -299,7 +807,7 @@ private static function numberLines(\Generator $lines, ?int $markLine = null): \ $mark = ($markLine === $lineNum) ? self::LINE_MARKER : self::NO_LINE_MARKER; } - yield \sprintf("%s: %s", $mark, $lineNum, $line); + yield \sprintf("%s%{$pad}s: %s", $mark, $lineNum, $line); } } @@ -314,4 +822,13 @@ private static function isReflectable(\Reflector $reflector): bool { return ($reflector instanceof \ReflectionClass || $reflector instanceof \ReflectionFunctionAbstract) && \is_file($reflector->getFileName()); } + + private static function formatInputSpan(string $spanType, string $spanText, ?OutputFormatterInterface $formatter): string + { + if ($spanType === self::HIGHLIGHT_DEFAULT || $formatter === null || !$formatter->isDecorated() || !$formatter->hasStyle($spanType)) { + return $spanText; + } + + return $formatter->getStyle($spanType)->apply($spanText); + } } diff --git a/app/vendor/psy/psysh/src/Formatter/DocblockFormatter.php b/app/vendor/psy/psysh/src/Formatter/DocblockFormatter.php index 9a526d1a9..8eaf52de8 100644 --- a/app/vendor/psy/psysh/src/Formatter/DocblockFormatter.php +++ b/app/vendor/psy/psysh/src/Formatter/DocblockFormatter.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -87,13 +87,7 @@ private static function formatVector(array $vector, array $lines): string $template = \implode(' ', $template); return \implode("\n", \array_map(function ($line) use ($template) { - $escaped = \array_map(function ($l) { - if ($l === null) { - return ''; - } - - return OutputFormatter::escape($l); - }, $line); + $escaped = \array_map(fn ($l) => ($l === null) ? '' : OutputFormatter::escape($l), $line); return \rtrim(\vsprintf($template, $escaped)); }, $lines)); diff --git a/app/vendor/psy/psysh/src/Formatter/LinkFormatter.php b/app/vendor/psy/psysh/src/Formatter/LinkFormatter.php new file mode 100644 index 000000000..815ca8245 --- /dev/null +++ b/app/vendor/psy/psysh/src/Formatter/LinkFormatter.php @@ -0,0 +1,106 @@ + */ + private static $styles = []; + + /** + * Set styles for formatting hyperlinks. + * + * @param array $styles Map of style name to inline style string + */ + public static function setStyles(array $styles): void + { + self::$styles = $styles; + } + + /** + * Check if the current Symfony Console version supports hyperlinks. + */ + public static function supportsLinks(): bool + { + static $supports = null; + + if ($supports === null) { + $supports = \method_exists(OutputFormatterStyle::class, 'setHref'); + } + + return $supports; + } + + /** + * Wrap text in a style tag, optionally including an href. + * + * @param string $style The style name (e.g., 'class', 'function', 'info') + * @param string $text The text to wrap + * @param string|null $href Optional hyperlink + * + * @return string Formatted text with style and optional href + */ + public static function styleWithHref(string $style, string $text, ?string $href = null): string + { + $escapedText = OutputFormatter::escape($text); + + if ($href !== null && self::supportsLinks()) { + $href = self::encodeHrefForOsc8($href); + $inline = self::$styles[$style] ?? ''; + $combinedStyle = $inline !== '' ? \sprintf('%s;href=%s', $inline, $href) : \sprintf('href=%s', $href); + + return \sprintf('<%s>%s', $combinedStyle, $escapedText); + } + + return \sprintf('<%s>%s', $style, $escapedText, $style); + } + + /** + * Get the php.net manual URL for a given item. + * + * @param string $item Function or class name + * + * @return string URL to php.net manual + */ + public static function getPhpNetUrl(string $item): string + { + // Normalize the item name for URL (lowercase, replace :: with . and _ with -) + $normalized = \str_replace('::', '.', $item); + $normalized = \str_replace('_', '-', $normalized); + $normalized = \strtolower($normalized); + + return 'https://php.net/'.$normalized; + } + + /** + * Encode a string for use in OSC 8 hyperlink URIs. + * + * Per OSC 8 spec, URIs must only contain bytes in the 32-126 range. + * + * @param string $str String to encode + * + * @return string URI-encoded string safe for OSC 8 + */ + public static function encodeHrefForOsc8(string $str): string + { + // Encode any character outside printable ASCII range (32-126) + return \preg_replace_callback('/[^\x20-\x7E]/', function ($matches) { + return \rawurlencode($matches[0]); + }, $str); + } +} diff --git a/app/vendor/psy/psysh/src/Formatter/ManualFormatter.php b/app/vendor/psy/psysh/src/Formatter/ManualFormatter.php new file mode 100644 index 000000000..45bbb3fd3 --- /dev/null +++ b/app/vendor/psy/psysh/src/Formatter/ManualFormatter.php @@ -0,0 +1,454 @@ +wrapper = new ManualWrapper(); + // Cap width at MAX_WIDTH for readability on ultra-wide terminals + $this->width = \min($width, self::MAX_WIDTH); + $this->manual = $manual; + } + + /** + * Format structured manual data for display. + * + * @param array $data Structured manual data + */ + public function format(array $data): string + { + $output = []; + + // Format based on type + switch ($data['type'] ?? '') { + case 'function': + $output[] = $this->formatFunction($data); + break; + case 'class': + $output[] = $this->formatClass($data); + break; + case 'constant': + $output[] = $this->formatConstant($data); + break; + default: + // Generic fallback + if (!empty($data['description'])) { + $output[] = $this->formatDescription($data['description']); + } + } + + return \implode("\n\n", \array_filter($output))."\n"; + } + + /** + * Format a function entry. + * + * @param array $data Function data + */ + private function formatFunction(array $data): string + { + $output = []; + + if (!empty($data['description'])) { + $output[] = $this->formatDescription($data['description']); + } + + if (!empty($data['params'])) { + $output[] = $this->formatParameters($data['params']); + } + + if (!empty($data['return'])) { + $output[] = $this->formatReturn($data['return']); + } + + if (!empty($data['seeAlso'])) { + $output[] = $this->formatSeeAlso($data['seeAlso']); + } + + return \implode("\n\n", \array_filter($output)); + } + + /** + * Format a class entry. + * + * @param array $data Class data + */ + private function formatClass(array $data): string + { + $output = []; + + // Description + if (!empty($data['description'])) { + $output[] = $this->formatDescription($data['description']); + } + + // See also + if (!empty($data['seeAlso'])) { + $output[] = $this->formatSeeAlso($data['seeAlso']); + } + + return \implode("\n\n", \array_filter($output)); + } + + /** + * Format a constant entry. + * + * @param array $data Constant data + */ + private function formatConstant(array $data): string + { + $output = []; + + if (isset($data['value'])) { + $output[] = 'Value: '.$this->thunkTags($data['value']); + } + + if (!empty($data['description'])) { + $output[] = $this->formatDescription($data['description']); + } + + if (!empty($data['seeAlso'])) { + $output[] = $this->formatSeeAlso($data['seeAlso']); + } + + return \implode("\n\n", \array_filter($output)); + } + + /** + * Format a description section. + * + * @param string $description Description text with semantic tags + * + * @return string Formatted description + */ + private function formatDescription(string $description): string + { + $output = ['Description:']; + + $text = $this->thunkTags($description); + $wrapped = $this->wrapper->wrap($text, $this->width - 2); + + $output = \array_merge($output, $this->indentWrappedLines($wrapped, ' ')); + + return \implode("\n", $output); + } + + /** + * Format parameters section. + * + * @param array $params Parameter list + */ + private function formatParameters(array $params): string + { + // Decide layout based on terminal width + // Use table layout for wide terminals (80+), stacked for narrow + if ($this->width >= 80) { + return $this->formatParametersTable($params); + } else { + return $this->formatParametersStacked($params); + } + } + + /** + * Format parameters as a table (for wide terminals). + * + * @param array $params Parameter list + */ + private function formatParametersTable(array $params): string + { + $output = ['Param:']; + + // Calculate column widths (matching old format) + $typeWidth = \max(\array_map(function ($param) { + return \mb_strlen($param['type'] ?? 'mixed'); + }, $params)); + + $nameWidth = \max(\array_map(function ($param) { + return \mb_strlen($param['name']); + }, $params)); + + // Build columns with padding OUTSIDE style tags + $indent = \str_repeat(' ', $typeWidth + $nameWidth + 6); + $wrapWidth = $this->width - \mb_strlen($indent); + + foreach ($params as $param) { + $type = $param['type'] ?? 'mixed'; + $name = $param['name']; + $desc = $this->thunkTags($param['description'] ?? ''); + + // Wrap in style tags first, THEN pad to avoid long color blocks + $typeFormatted = ''.$type.''.\str_repeat(' ', $typeWidth - \mb_strlen($type)); + $nameFormatted = ''.$name.''.\str_repeat(' ', $nameWidth - \mb_strlen($name)); + + // Wrap description with proper indentation + if (!empty($desc)) { + $wrapped = $this->wrapper->wrap($desc, $wrapWidth); + $firstLine = ' '.$typeFormatted.' '.$nameFormatted.' '; + $output = \array_merge($output, $this->indentWrappedLines($wrapped, $indent, $firstLine)); + } else { + $output[] = ' '.$typeFormatted.' '.$nameFormatted; + } + } + + return \implode("\n", $output); + } + + /** + * Format parameters stacked (for narrow terminals). + * + * @param array $params Parameter list + */ + private function formatParametersStacked(array $params): string + { + $output = ['Param:']; + + // Calculate type width for alignment + $typeWidth = \max(\array_map(function ($param) { + return \mb_strlen($param['type'] ?? 'mixed'); + }, $params)); + + foreach ($params as $param) { + $type = \str_pad($param['type'] ?? 'mixed', $typeWidth); + $name = $param['name']; + + $output[] = \sprintf(' %s %s', $type, $name); + + if (!empty($param['description'])) { + $desc = $this->thunkTags($param['description']); + $indent = \str_repeat(' ', $typeWidth + 4); + $wrapped = $this->wrapper->wrap($desc, $this->width - \mb_strlen($indent)); + $output = \array_merge($output, $this->indentWrappedLines($wrapped, $indent)); + } + } + + return \implode("\n", $output); + } + + /** + * Format return value section. + * + * @param array $return Return value data + */ + private function formatReturn(array $return): string + { + $output = ['Return:']; + + $type = $return['type'] ?? 'unknown'; + $desc = $return['description'] ?? ''; + + $indent = \str_repeat(' ', \mb_strlen($type) + 4); + $wrapWidth = $this->width - \mb_strlen($indent); + + if (!empty($desc)) { + $desc = $this->thunkTags($desc); + $wrapped = $this->wrapper->wrap($desc, $wrapWidth); + $firstLine = \sprintf(' %s ', $type); + $output = \array_merge($output, $this->indentWrappedLines($wrapped, $indent, $firstLine)); + } else { + $output[] = \sprintf(' %s', $type); + } + + return \implode("\n", $output); + } + + /** + * Format see also section. + * + * @param array $seeAlso List of related functions/classes + */ + private function formatSeeAlso(array $seeAlso): string + { + if (empty($seeAlso)) { + return ''; + } + + $output = ['See Also:']; + + // Format items with hyperlinks if manual is available + $items = \array_map(function ($item) { + return $this->formatSeeAlsoItem($item); + }, $seeAlso); + + // Don't wrap - console tags need to stay intact + // Just join with commas and indent + $output[] = ' '.\implode(', ', $items); + + return \implode("\n", $output); + } + + /** + * Format a single see also item with hyperlink if available. + * + * @param string $item Function or class name (may contain XML tags) + */ + private function formatSeeAlsoItem(string $item): string + { + // Strip XML tags to get the actual function/class name + $cleanItem = \strip_tags($item); + + // Check if this item exists in the manual + $href = null; + if ($this->manual !== null && $this->manual->get($cleanItem) !== null) { + $href = LinkFormatter::getPhpNetUrl($cleanItem); + } + + // Add parentheses to functions (like php.net and old manual format) + // Items with tags are functions, otherwise classes/constants + $displayText = $cleanItem; + if (\strpos($item, '') !== false) { + $displayText .= '()'; + } + + if ($href !== null) { + return LinkFormatter::styleWithHref('info', $displayText, $href); + } + + // No hyperlink; apply semantic tag formatting, then add parens if function + $formatted = $this->thunkTags($item); + if (\strpos($item, '') !== false && \strpos($formatted, '()') === false) { + $formatted .= '()'; + } + + return $formatted; + } + + /** + * Indent wrapped text lines. + * + * Takes wrapped text and adds indentation to each line. + * The first line can have a different prefix than subsequent lines. + * + * @param string $wrapped Wrapped text (may contain newlines) + * @param string $indent Indentation for continuation lines + * @param string|null $firstIndent Optional different indentation for first line (defaults to $indent) + * + * @return array Lines with indentation applied + */ + private function indentWrappedLines(string $wrapped, string $indent, ?string $firstIndent = null): array + { + $firstIndent = $firstIndent ?? $indent; + $lines = \explode("\n", $wrapped); + $output = []; + + foreach ($lines as $i => $line) { + $output[] = ($i === 0 ? $firstIndent : $indent).$line; + } + + return $output; + } + + /** + * Convert semantic XML tags to Symfony Console format tags. + * + * @param string $text Text with semantic tags + * + * @return string Text with console format tags + */ + private function thunkTags(string $text): string + { + // First, escape any < and > that aren't part of our semantic tags + // Protect our semantic tags by replacing them with placeholders + $tagMap = []; + $tagIndex = 0; + + // Protect semantic tags + $semanticTags = ['parameter', 'function', 'constant', 'classname', 'type', 'literal', 'class']; + foreach ($semanticTags as $tag) { + $text = \preg_replace_callback( + "/<{$tag}>|<\/{$tag}>/", + function ($matches) use (&$tagMap, &$tagIndex) { + $placeholder = "\x00TAG{$tagIndex}\x00"; + $tagMap[$placeholder] = $matches[0]; + $tagIndex++; + + return $placeholder; + }, + $text + ); + } + + // Now escape any remaining < and > (these are content, not tags) + $text = \str_replace(['<', '>'], ['\\<', '\\>'], $text); + + // Restore protected tags + $text = \str_replace(\array_keys($tagMap), \array_values($tagMap), $text); + + // Handle parameters: add $ prefix and make bold + $text = \preg_replace_callback( + '/([^<]+)<\/parameter>/', + function ($matches) { + $name = $matches[1]; + // Add $ if not already present + if ($name[0] !== '$') { + $name = '$'.$name; + } + + return ''.$name.''; + }, + $text + ); + + // Handle functions: add () suffix and make bold + $text = \preg_replace_callback( + '/([^<]+)<\/function>/', + function ($matches) { + $name = $matches[1]; + // Add () if not already present + if (\substr($name, -2) !== '()') { + $name .= '()'; + } + + return ''.$name.''; + }, + $text + ); + + // Map other semantic tags to corresponding formats + $replacements = [ + '' => '', + '' => '', + '' => '', + '' => '', + '' => '', + '' => '', + '' => '', + '' => '', + '' => '', + '' => '', + ]; + + $text = \str_replace(\array_keys($replacements), \array_values($replacements), $text); + + return $text; + } +} diff --git a/app/vendor/psy/psysh/src/Formatter/ManualWrapper.php b/app/vendor/psy/psysh/src/Formatter/ManualWrapper.php new file mode 100644 index 000000000..df68a3cc1 --- /dev/null +++ b/app/vendor/psy/psysh/src/Formatter/ManualWrapper.php @@ -0,0 +1,216 @@ +]}»'"„›〃〉》」』】〕〗〙〞〟︶︸︺︼︾﹀﹂﹑﹚﹜＇）］｝｠､ + '\\)>\\]\\}\x{00BB}\x{2019}\x{201D}\x{201E}\x{203A}\x{3003}\x{3009}\x{300B}\x{300D}\x{300F}\x{3011}\x{3015}' + .'\x{3017}\x{3019}\x{301E}\x{301F}\x{FE36}\x{FE38}\x{FE3A}\x{FE3C}\x{FE3E}\x{FE40}\x{FE42}\x{FE51}\x{FE5A}' + .'\x{FE5C}\x{FF07}\x{FF09}\x{FF3D}\x{FF5D}\x{FF60}\x{FF64}', + + // misc symbols: + // %¢¨°·ˇˉ‖†‡•‥℃∶、〆︱︲︳﹓％｜ + '%\x{00A2}\x{00A8}\x{00B0}\x{00B7}\x{02C7}\x{02C9}\x{2016}\x{2020}\x{2021}\x{2022}\x{2025}\x{2103}\x{2236}' + .'\x{3001}\x{3006}\x{FE31}\x{FE32}\x{FE33}\x{FE53}\x{FF05}\x{FF5C}', + + // misc japanese: + // ヽヾーァィゥェォッャュョヮヵヶぁぃぅぇぉっゃゅょゎゕゖㇰㇱㇲㇳㇴㇵㇶㇷㇸㇹㇺㇻㇼㇽㇾㇿ々〻 + '\x{30FD}\x{30FE}\x{30FC}\x{30A1}\x{30A3}\x{30A5}\x{30A7}\x{30A9}\x{30C3}\x{30E3}\x{30E5}\x{30E7}\x{30EE}' + .'\x{30F5}\x{30F6}\x{3041}\x{3043}\x{3045}\x{3047}\x{3049}\x{3063}\x{3083}\x{3085}\x{3087}\x{308E}\x{3095}' + .'\x{3096}\x{31F0}\x{31F1}\x{31F2}\x{31F3}\x{31F4}\x{31F5}\x{31F6}\x{31F7}\x{31F8}\x{31F9}\x{31FA}\x{31FB}' + .'\x{31FC}\x{31FD}\x{31FE}\x{31FF}\x{3005}\x{303B}', + ]; + + // CJK characters not allowed at the end of lines + private static $notEnd = [ + // misc symbols, currency, etc: + // #$*\£¥々〇＄￡￥￦ + '#\\$\\*\\\x{00A3}\x{00A5}\x{3005}\x{3007}\x{FF04}\x{FFE1}\x{FFE5}\x{FFE6}', + + // opening brackets: + // ([{'"‟‵〈《「『【〔〖〝︴︵︷︹︻︽︿﹁﹃﹏﹙﹛（［｀｛ + '\\(\\[\\{\x{2018}\x{201C}\x{201F}\x{2035}\x{3008}\x{300A}\x{300C}\x{300E}\x{3010}\x{3014}\x{3016}\x{301D}' + .'\x{FE34}\x{FE35}\x{FE37}\x{FE39}\x{FE3B}\x{FE3D}\x{FE3F}\x{FE41}\x{FE43}\x{FE4F}\x{FE59}\x{FE5B}\x{FF08}' + .'\x{FF3B}\x{FF40}\x{FF5B}', + ]; + + // CJK characters not allowed at the start _or_ end of lines + private static $notSplit = [ + // misc japanese: + // —…‥〳〴〵 + '\x{2014}\x{2026}\x{2025}\x{3033}\x{3034}\x{3035}', + ]; + + /** + * A tag-aware, CJK friendly version of wordwrap(). + * + * @param string $text The input string + * @param int $width The number of characters at which the string will be wrapped + * @param string $break The line break character + * @param bool $cut Wrap at or before the specified width (unused) + * + * @return string The wrapped text + */ + public function wrap(string $text, int $width = 100, string $break = "\n", bool $cut = false): string + { + $lines = []; + + foreach (\explode($break, $text) as $line) { + if (self::len($line) <= $width) { + $lines[] = $line; + continue; + } + + $buf = ''; + foreach ($this->words($line) as $word) { + if (self::len($buf.$word) <= $width) { + $buf .= $word; + continue; + } + + $lines[] = \rtrim($buf); + $buf = $word; + } + + if (self::len($buf) > 0) { + $lines[] = $buf; + } + } + + return \implode($break, $lines); + } + + /** + * Calculate the apparent length of a unicode string. + * + * Full-width CJK characters count as 2 characters wide. + * Tags are ignored for width calculation. + * + * @param string $text The text to measure + * + * @return int The apparent width + */ + public static function len(string $text): int + { + // Match all full-width characters and replace them with 'xx', so that we can compute the _apparent_ length + // of the rendered string. + $isFullWidth = \sprintf('/[%s]/u', \implode('', self::$fullWidthRanges)); + + return \mb_strlen(\rtrim(\preg_replace($isFullWidth, 'xx', \strip_tags($text)))); + } + + /** + * A word generator. + * + * Returns actual (space delimited) words. It also returns CJK characters as "words", as long as they can be split + * between lines. + * + * @param string $line The line to split into words + * + * @return \Generator + */ + private function words(string $line): \Generator + { + $isCJK = \sprintf('/[%s]/u', \implode('', self::$fullWidthRanges)); + $notStart = \sprintf('/[%s%s]/u', \implode('', self::$notStart), \implode('', self::$notSplit)); + $notEnd = \sprintf('/[%s%s]/u', \implode('', self::$notEnd), \implode('', self::$notSplit)); + + $line = \rtrim($line); + $i = 0; + $len = \mb_strlen($line); + $inTag = false; + + do { + $char = \mb_substr($line, $i, 1); + switch ($char) { + case '<': + $inTag = true; + break; + + case '>': + $inTag = false; + break; + + case ' ': + if (!$inTag) { + yield \rtrim(\mb_substr($line, 0, $i)).' '; + $line = \mb_substr($line, $i + 1); + $len = \mb_strlen($line); + $i = -1; + } + break; + + default: + // if this is a CJK character... + if (!$inTag && \preg_match($isCJK, $char)) { + // … and it can end a line + if (!\preg_match($notEnd, $char)) { + // … and the next one can start a line + $next = \mb_substr($line, $i + 1, 1); + if (!\preg_match($notStart, $next)) { + // we'll pretend it's a word :) + yield \rtrim(\mb_substr($line, 0, $i + 1)); + $line = \mb_substr($line, $i + 1); + $len = \mb_strlen($line); + $i = -1; + } + } + } + break; + } + + $i++; + } while ($i < $len); + + yield \rtrim($line); + } +} diff --git a/app/vendor/psy/psysh/src/Formatter/ReflectorFormatter.php b/app/vendor/psy/psysh/src/Formatter/ReflectorFormatter.php index 02f426cdd..0751458fc 100644 --- a/app/vendor/psy/psysh/src/Formatter/ReflectorFormatter.php +++ b/app/vendor/psy/psysh/src/Formatter/ReflectorFormatter.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Formatter/SignatureFormatter.php b/app/vendor/psy/psysh/src/Formatter/SignatureFormatter.php index de29f2c27..5a442c122 100644 --- a/app/vendor/psy/psysh/src/Formatter/SignatureFormatter.php +++ b/app/vendor/psy/psysh/src/Formatter/SignatureFormatter.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,8 +11,11 @@ namespace Psy\Formatter; +use Psy\Manual\ManualInterface; use Psy\Reflection\ReflectionConstant; use Psy\Reflection\ReflectionLanguageConstruct; +use Psy\Reflection\ReflectionMagicMethod; +use Psy\Reflection\ReflectionMagicProperty; use Psy\Util\Json; use Symfony\Component\Console\Formatter\OutputFormatter; @@ -21,10 +24,46 @@ */ class SignatureFormatter implements ReflectorFormatter { + private static ?ManualInterface $manual = null; + + /** + * Set the manual interface for generating hyperlinks. + */ + public static function setManual(?ManualInterface $manual): void + { + self::$manual = $manual; + } + + /** + * Set styles for formatting hyperlinks. + * + * @deprecated Use LinkFormatter::setStyles() instead + * + * @param array $styles Map of style name to inline style string + */ + public static function setStyles(array $styles): void + { + // Delegate to LinkFormatter which now handles this + LinkFormatter::setStyles($styles); + } + + /** + * Set the manual database for generating hyperlinks. + * + * @deprecated Manual database is now set via Configuration::setManual() + * + * @param \PDO|null $db + */ + public static function setManualDb(?\PDO $db): void + { + // The functionality is now handled through setManual() + } + /** * Format a signature for the given reflector. * * Defers to subclasses to do the actual formatting. + * Automatically generates hyperlinks if manual database is set. * * @param \Reflector $reflector * @@ -44,9 +83,15 @@ public static function format(\Reflector $reflector): string case $reflector instanceof \ReflectionClassConstant: return self::formatClassConstant($reflector); + case $reflector instanceof ReflectionMagicMethod: + return self::formatMagicMethod($reflector); + case $reflector instanceof \ReflectionMethod: return self::formatMethod($reflector); + case $reflector instanceof ReflectionMagicProperty: + return self::formatMagicProperty($reflector); + case $reflector instanceof \ReflectionProperty: return self::formatProperty($reflector); @@ -67,7 +112,7 @@ public static function format(\Reflector $reflector): string */ public static function formatName(\Reflector $reflector): string { - return $reflector->getName(); + return self::normalizeName($reflector->getName()); } /** @@ -79,9 +124,12 @@ public static function formatName(\Reflector $reflector): string */ private static function formatModifiers(\Reflector $reflector): string { - return \implode(' ', \array_map(function ($modifier) { - return \sprintf('%s', $modifier); - }, \Reflection::getModifierNames($reflector->getModifiers()))); + $modifiers = \array_map( + fn ($modifier) => \sprintf('%s', $modifier), + \Reflection::getModifierNames($reflector->getModifiers()) + ); + + return \implode(' ', $modifiers); } /** @@ -105,11 +153,12 @@ private static function formatClass(\ReflectionClass $reflector): string $chunks[] = $reflector->isInterface() ? 'interface' : 'class'; } - $chunks[] = \sprintf('%s', self::formatName($reflector)); + $chunks[] = LinkFormatter::styleWithHref('class', self::formatName($reflector), self::getManualHref($reflector)); if ($parent = $reflector->getParentClass()) { $chunks[] = 'extends'; - $chunks[] = \sprintf('%s', $parent->getName()); + $parentHref = self::getManualHref($parent); + $chunks[] = LinkFormatter::styleWithHref('class', self::normalizeName($parent->getName()), $parentHref); } $interfaces = $reflector->getInterfaceNames(); @@ -118,7 +167,13 @@ private static function formatClass(\ReflectionClass $reflector): string $chunks[] = $reflector->isInterface() ? 'extends' : 'implements'; $chunks[] = \implode(', ', \array_map(function ($name) { - return \sprintf('%s', $name); + try { + $interfaceHref = self::getManualHref(new \ReflectionClass($name)); + } catch (\ReflectionException $e) { + $interfaceHref = null; + } + + return LinkFormatter::styleWithHref('class', self::normalizeName($name), $interfaceHref); }, $interfaces)); } @@ -138,8 +193,8 @@ private static function formatClassConstant($reflector): string $style = self::getTypeStyle($value); return \sprintf( - 'const %s = <%s>%s', - self::formatName($reflector), + 'const %s = <%s>%s', + LinkFormatter::styleWithHref('const', self::formatName($reflector), self::getManualHref($reflector)), $style, OutputFormatter::escape(Json::encode($value)), $style @@ -211,9 +266,9 @@ private static function formatProperty(\ReflectionProperty $reflector): string private static function formatFunction(\ReflectionFunctionAbstract $reflector): string { return \sprintf( - 'function %s%s(%s)%s', + 'function %s%s(%s)%s', $reflector->returnsReference() ? '&' : '', - self::formatName($reflector), + LinkFormatter::styleWithHref('function', self::formatName($reflector), self::getManualHref($reflector)), \implode(', ', self::formatFunctionParams($reflector)), self::formatFunctionReturnType($reflector) ); @@ -251,6 +306,68 @@ private static function formatMethod(\ReflectionMethod $reflector): string ); } + /** + * Format a magic method signature. + * + * @param ReflectionMagicMethod $reflector + * + * @return string Formatted signature + */ + private static function formatMagicMethod(ReflectionMagicMethod $reflector): string + { + $parts = []; + + $parts[] = self::formatModifiers($reflector); + $parts[] = 'function'; + + $ref = $reflector->returnsReference() ? '&' : ''; + + $signature = \sprintf( + '%s%s(%s)', + $ref, + $reflector->getName(), + OutputFormatter::escape($reflector->getParameterString()) + ); + + $returnType = $reflector->getDocblockReturnType(); + if ($returnType !== null) { + $signature .= \sprintf(': %s', OutputFormatter::escape($returnType)); + } + + $parts[] = $signature; + + return \implode(' ', \array_filter($parts)); + } + + /** + * Format a magic property signature. + * + * @param ReflectionMagicProperty $reflector + * + * @return string Formatted signature + */ + private static function formatMagicProperty(ReflectionMagicProperty $reflector): string + { + $parts = []; + + $parts[] = self::formatModifiers($reflector); + + $type = $reflector->getDocblockType(); + if ($type !== null) { + $parts[] = \sprintf('%s', OutputFormatter::escape($type)); + } + + $parts[] = \sprintf('$%s', $reflector->getName()); + + if ($reflector->isReadOnly()) { + $parts[] = ''; + } elseif ($reflector->isWriteOnly()) { + $parts[] = ''; + } + + return \implode(' ', \array_filter($parts)); + } + /** * Print the function params. * @@ -272,7 +389,7 @@ private static function formatFunctionParams(\ReflectionFunctionAbstract $reflec if ($param->isArray()) { $hint = 'array'; } elseif ($class = $param->getClass()) { - $hint = \sprintf('%s', $class->getName()); + $hint = LinkFormatter::styleWithHref('class', self::normalizeName($class->getName()), self::getManualHref($class)); } } } catch (\Throwable $e) { @@ -321,7 +438,7 @@ private static function formatFunctionParams(\ReflectionFunctionAbstract $reflec /** * Print function param or return type(s). * - * @param \ReflectionType $type + * @param \ReflectionType|null $type */ private static function formatReflectionType(?\ReflectionType $type, bool $indicateNullable): string { @@ -350,9 +467,124 @@ private static function formatReflectionType(?\ReflectionType $type, bool $indic */ private static function formatReflectionNamedType(\ReflectionNamedType $type, bool $indicateNullable): string { - $typeStyle = $type->isBuiltin() ? 'keyword' : 'class'; $nullable = $indicateNullable && $type->allowsNull() ? '?' : ''; + $typeName = self::normalizeName($type->getName()); + + if ($type->isBuiltin()) { + return \sprintf('%s%s', $nullable, OutputFormatter::escape($typeName)); + } + + // Non-builtin type is a class - try to get href for it + $href = null; + try { + $classReflector = new \ReflectionClass($typeName); + $href = self::getManualHref($classReflector); + } catch (\ReflectionException $e) { + // Class doesn't exist or can't be reflected, no href + } + + return $nullable.LinkFormatter::styleWithHref('class', $typeName, $href); + } + + /** + * Wrap text in a style tag, optionally including an href. + * + * @deprecated use LinkFormatter::styleWithHref directly + * + * @param string $style The style name (e.g., 'class', 'function') + * @param string $text The text to wrap + * @param string|null $href Optional hyperlink URL + * + * @return string Formatted text with style and optional href + */ + private static function styleWithHref(string $style, string $text, ?string $href = null): string + { + return LinkFormatter::styleWithHref($style, $text, $href); + } + + /** + * Get a hyperlink URL for a reflector if it's in the PHP manual. + * + * @param \Reflector $reflector + * + * @return string|null URL to php.net or null if not in manual + */ + private static function getManualHref(\Reflector $reflector): ?string + { + // If it's not in the manual, assume it's not on php.net + if (!self::getManualDoc($reflector)) { + return null; + } + + switch (\get_class($reflector)) { + case \ReflectionClass::class: + case \ReflectionObject::class: + case \ReflectionFunction::class: + $query = self::normalizeName($reflector->name); + break; + + case \ReflectionMethod::class: + $query = self::normalizeName($reflector->class).'.'.self::normalizeName($reflector->name); + break; - return \sprintf('<%s>%s%s', $typeStyle, $nullable, OutputFormatter::escape($type->getName()), $typeStyle); + case \ReflectionProperty::class: + case \ReflectionClassConstant::class: + // No simple redirect URLs for properties/constants, link to class instead + $query = self::normalizeName($reflector->class); + break; + + default: + return null; + } + + return \sprintf('https://php.net/%s', $query); + } + + /** + * Get manual documentation for a reflector. + * + * @param \Reflector $reflector + * + * @return string|array|false Documentation string or structured data, or false if not found + */ + private static function getManualDoc(\Reflector $reflector) + { + if (!self::$manual) { + return false; + } + + switch (\get_class($reflector)) { + case \ReflectionClass::class: + case \ReflectionObject::class: + case \ReflectionFunction::class: + $id = self::normalizeName($reflector->name); + break; + + case \ReflectionMethod::class: + case \ReflectionClassConstant::class: + $id = self::normalizeName($reflector->class).'::'.self::normalizeName($reflector->name); + break; + + case \ReflectionProperty::class: + $id = self::normalizeName($reflector->class).'::$'.self::normalizeName($reflector->name); + break; + + case ReflectionConstant::class: + $id = self::normalizeName($reflector->name); + break; + + default: + return false; + } + + return self::$manual->get($id) ?? false; + } + + /** + * Strip scoped PHAR namespace prefixes from a name. + */ + private static function normalizeName(string $name): string + { + return (string) \preg_replace('/^_Psy[a-f0-9]+\\\\/i', '', $name); } } diff --git a/app/vendor/psy/psysh/src/Formatter/TraceFormatter.php b/app/vendor/psy/psysh/src/Formatter/TraceFormatter.php index a30b4b8c3..8c2af6f41 100644 --- a/app/vendor/psy/psysh/src/Formatter/TraceFormatter.php +++ b/app/vendor/psy/psysh/src/Formatter/TraceFormatter.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -22,10 +22,10 @@ class TraceFormatter /** * Format the trace of the given exception. * - * @param \Throwable $throwable The error or exception with a backtrace - * @param FilterOptions $filter (default: null) - * @param int $count (default: PHP_INT_MAX) - * @param bool $includePsy (default: true) + * @param \Throwable $throwable The error or exception with a backtrace + * @param FilterOptions|null $filter (default: null) + * @param int|null $count (default: PHP_INT_MAX) + * @param bool $includePsy (default: true) * * @return string[] Formatted stacktrace lines */ diff --git a/app/vendor/psy/psysh/src/Input/CodeArgument.php b/app/vendor/psy/psysh/src/Input/CodeArgument.php index 2654c9437..abb716cca 100644 --- a/app/vendor/psy/psysh/src/Input/CodeArgument.php +++ b/app/vendor/psy/psysh/src/Input/CodeArgument.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -32,10 +32,10 @@ class CodeArgument extends InputArgument /** * Constructor. * - * @param string $name The argument name - * @param int $mode The argument mode: self::REQUIRED or self::OPTIONAL - * @param string $description A description text - * @param mixed $default The default value (for self::OPTIONAL mode only) + * @param string $name The argument name + * @param int|null $mode The argument mode: self::REQUIRED or self::OPTIONAL + * @param string $description A description text + * @param mixed $default The default value (for self::OPTIONAL mode only) * * @throws \InvalidArgumentException When argument mode is not valid */ diff --git a/app/vendor/psy/psysh/src/Input/FilterOptions.php b/app/vendor/psy/psysh/src/Input/FilterOptions.php index db79c3455..f0082f9cd 100644 --- a/app/vendor/psy/psysh/src/Input/FilterOptions.php +++ b/app/vendor/psy/psysh/src/Input/FilterOptions.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -82,12 +82,16 @@ public function hasFilter(): bool /** * Check whether a string matches the current filter options. * - * @param string $string - * @param array $matches + * @param string $string + * @param array|null $matches */ public function match(string $string, ?array &$matches = null): bool { - return $this->filter === false || (\preg_match($this->pattern, $string, $matches) xor $this->invert); + if ($this->filter === false || $this->pattern === null) { + return true; + } + + return \preg_match($this->pattern, $string, $matches) xor $this->invert; } /** @@ -129,6 +133,7 @@ private function validateRegex(string $pattern) { \set_error_handler([ErrorException::class, 'throwException']); try { + // @phan-suppress-next-line PhanParamSuspiciousOrder - intentionally testing regex against empty string \preg_match($pattern, ''); } catch (ErrorException $e) { throw new RuntimeException(\str_replace('preg_match(): ', 'Invalid regular expression: ', $e->getRawMessage())); diff --git a/app/vendor/psy/psysh/src/Input/ShellInput.php b/app/vendor/psy/psysh/src/Input/ShellInput.php index 17a39fc6f..18c2dc63c 100644 --- a/app/vendor/psy/psysh/src/Input/ShellInput.php +++ b/app/vendor/psy/psysh/src/Input/ShellInput.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Input/SilentInput.php b/app/vendor/psy/psysh/src/Input/SilentInput.php index 1bf5df534..5d44be3ec 100644 --- a/app/vendor/psy/psysh/src/Input/SilentInput.php +++ b/app/vendor/psy/psysh/src/Input/SilentInput.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Logger/CallbackLogger.php b/app/vendor/psy/psysh/src/Logger/CallbackLogger.php new file mode 100644 index 000000000..552ca9da2 --- /dev/null +++ b/app/vendor/psy/psysh/src/Logger/CallbackLogger.php @@ -0,0 +1,61 @@ +callback = \Closure::fromCallable($callback); + } + + /** + * Log a message. + * + * @param string $level Log level + * @param string $message Log message + * @param array $context Context data + */ + public function log(string $level, string $message, array $context = []): void + { + // Determine the kind from the message + switch ($message) { + case 'PsySH input': + $kind = 'input'; + break; + case 'PsySH command': + $kind = 'command'; + break; + case 'PsySH execute': + $kind = 'execute'; + break; + default: + $kind = 'unknown'; + break; + } + + // Extract the data from context + $data = $context[$kind] ?? $context['code'] ?? ''; + + \call_user_func($this->callback, $kind, $data); + } +} diff --git a/app/vendor/psy/psysh/src/Manual/ManualInterface.php b/app/vendor/psy/psysh/src/Manual/ManualInterface.php new file mode 100644 index 000000000..a728e625f --- /dev/null +++ b/app/vendor/psy/psysh/src/Manual/ManualInterface.php @@ -0,0 +1,44 @@ +db = $db; + } + + /** + * {@inheritdoc} + */ + public function get(string $id) + { + $result = $this->db->query(\sprintf('SELECT doc FROM php_manual WHERE id = %s', $this->db->quote($id))); + if ($result !== false) { + return $result->fetchColumn(0) ?: null; + } + + return null; + } + + /** + * {@inheritdoc} + */ + public function getVersion(): int + { + return 2; + } + + /** + * Get manual metadata (version, language, build date, etc). + * + * Reads metadata from the meta table in the SQLite database. + * + * @return array + */ + public function getMeta(): array + { + $meta = ['format' => 'sqlite']; + + $result = $this->db->query('SELECT id, value FROM meta'); + if ($result !== false) { + while ($row = $result->fetch(\PDO::FETCH_ASSOC)) { + $key = $row['id']; + $value = $row['value']; + + // Convert numeric strings to integers + if (\in_array($key, ['git_timestamp', 'built_at'], true)) { + $value = (int) $value; + } + + $meta[$key] = $value; + } + } + + return $meta; + } +} diff --git a/app/vendor/psy/psysh/src/Manual/V3Manual.php b/app/vendor/psy/psysh/src/Manual/V3Manual.php new file mode 100644 index 000000000..b6fffddbb --- /dev/null +++ b/app/vendor/psy/psysh/src/Manual/V3Manual.php @@ -0,0 +1,106 @@ + */ + private static $cache = []; + + /** + * Constructor. + * + * @param string $filePath Path to the PHP manual file + * + * @throws InvalidManualException if file doesn't return a valid manual data object + */ + public function __construct(string $filePath) + { + // Avoid redefining __COMPILER_HALT_OFFSET__ + // TODO: Remove cache after dropping support for PHP 8.2. + if (isset(self::$cache[$filePath])) { + $data = self::$cache[$filePath]; + } else { + // Suppress output from invalid/corrupted manual files + \ob_start(); + try { + /** @var mixed $data */ + $data = require $filePath; + } finally { + \ob_end_clean(); + } + // @phan-suppress-next-line PhanPossiblyUndeclaredVariable $data is always set above + self::$cache[$filePath] = $data; + } + + // Validate that the file returned an object with the expected interface + // @phan-suppress-next-line PhanPossiblyUndeclaredVariable $data is always set above + if (!\is_object($data)) { + throw new InvalidManualException(\sprintf('Manual file "%s" must return an object, got %s', $filePath, \gettype($data)), $filePath); + } + + $requiredMethods = ['get', 'getMeta']; + foreach ($requiredMethods as $method) { + // @phan-suppress-next-line PhanPossiblyUndeclaredVariable $data is always set above + if (!\method_exists($data, $method)) { + throw new InvalidManualException(\sprintf('Manual data object must have a %s() method', $method), $filePath); + } + } + + // Verify the manual format version is v3.x + $meta = $data->getMeta(); + if (!isset($meta['version']) || !\preg_match('/^3\./', (string) $meta['version'])) { + $version = $meta['version'] ?? 'unknown'; + throw new InvalidManualException(\sprintf('Manual file "%s" must be v3.x format, got version %s', $filePath, $version), $filePath); + } + + $this->data = $data; + } + + /** + * {@inheritdoc} + */ + public function get(string $id) + { + return $this->data->get($id); + } + + /** + * {@inheritdoc} + */ + public function getVersion(): int + { + return 3; + } + + /** + * Get manual metadata (version, language, build date, etc). + * + * @return array + */ + public function getMeta(): array + { + return $this->data->getMeta(); + } +} diff --git a/app/vendor/psy/psysh/src/ManualUpdater/Checker.php b/app/vendor/psy/psysh/src/ManualUpdater/Checker.php new file mode 100644 index 000000000..dff30d91c --- /dev/null +++ b/app/vendor/psy/psysh/src/ManualUpdater/Checker.php @@ -0,0 +1,36 @@ +lang = $lang; + $this->format = $format; + $this->currentVersion = $currentVersion; + $this->currentLang = $currentLang; + } + + public function isLatest(): bool + { + if ($this->currentVersion === null) { + return false; + } + + // If language has changed, need to update regardless of version + if ($this->currentLang !== null && $this->currentLang !== $this->lang) { + return false; + } + + return \version_compare($this->currentVersion, $this->getLatest(), '>='); + } + + public function getLatest(): string + { + if (!isset($this->latestVersion)) { + $this->fetchLatestRelease(); + } + + return $this->latestVersion; + } + + public function getDownloadUrl(): string + { + if (!isset($this->downloadUrl)) { + $this->fetchLatestRelease(); + } + + return $this->downloadUrl; + } + + private function fetchLatestRelease() + { + $context = \stream_context_create([ + 'http' => [ + 'user_agent' => 'PsySH/'.Shell::VERSION, + 'timeout' => 3.0, + ], + ]); + + \set_error_handler(function () { + // Ignore errors - we'll handle failures below + }); + + $result = @\file_get_contents(self::RELEASES_URL, false, $context); + + \restore_error_handler(); + + if (!$result) { + throw new \RuntimeException('Unable to fetch manual releases from GitHub'); + } + + $releases = \json_decode($result, true); + if (!$releases || !\is_array($releases)) { + throw new \RuntimeException('Invalid response from GitHub releases API'); + } + + // Find the first release with a manifest + foreach ($releases as $release) { + $manifest = $this->fetchManifest($release); + if ($manifest === null) { + continue; + } + + // Find our language/format in the manifest + foreach ($manifest['manuals'] as $manual) { + if ($manual['lang'] === $this->lang && $manual['format'] === $this->format) { + $this->latestVersion = $manual['version']; + + // Build download URL + $filename = \sprintf('psysh-manual-v%s-%s.tar.gz', $manual['version'], $this->lang); + $this->downloadUrl = $release['assets_url'] ?? null; + + // Find the actual asset URL + foreach ($release['assets'] as $asset) { + if ($asset['name'] === $filename) { + $this->downloadUrl = $asset['browser_download_url']; + break; + } + } + + return; + } + } + } + + throw new \RuntimeException(\sprintf('No manual found for language "%s" in format "%s"', $this->lang, $this->format)); + } + + /** + * Fetch and parse manifest.json from a release. + * + * @return array|null + */ + private function fetchManifest(array $release): ?array + { + // Find manifest.json in assets + foreach ($release['assets'] as $asset) { + if ($asset['name'] === 'manifest.json') { + $context = \stream_context_create([ + 'http' => [ + 'user_agent' => 'PsySH/'.Shell::VERSION, + 'timeout' => 3.0, + ], + ]); + + \set_error_handler(function () { + // Ignore errors + }); + + $manifestContent = @\file_get_contents($asset['browser_download_url'], false, $context); + + \restore_error_handler(); + + if ($manifestContent) { + return \json_decode($manifestContent, true); + } + } + } + + return null; + } +} diff --git a/app/vendor/psy/psysh/src/ManualUpdater/Installer.php b/app/vendor/psy/psysh/src/ManualUpdater/Installer.php new file mode 100644 index 000000000..84517d049 --- /dev/null +++ b/app/vendor/psy/psysh/src/ManualUpdater/Installer.php @@ -0,0 +1,106 @@ +dataDir = $dataDir; + $this->format = $format; + } + + /** + * Check if the data directory is writable. + */ + public function isDataDirWritable(): bool + { + return \is_dir($this->dataDir) && \is_writable($this->dataDir); + } + + /** + * Extract and install the manual from a downloaded tarball. + * + * @param string $tarballPath Path to the downloaded .tar.gz file + * + * @return bool True on success + */ + public function install(string $tarballPath): bool + { + if (!\file_exists($tarballPath)) { + return false; + } + + // Create temp directory for extraction + $tempDir = \sys_get_temp_dir().'/psysh-manual-'.\uniqid(); + if (!\mkdir($tempDir)) { + return false; + } + + try { + // Extract tarball + $phar = new \PharData($tarballPath); + $phar->extractTo($tempDir); + + // Determine the manual filename + $manualFilename = $this->format === 'php' ? 'php_manual.php' : 'php_manual.sqlite'; + $extractedFile = $tempDir.'/'.$manualFilename; + + if (!\file_exists($extractedFile)) { + return false; + } + + // Move to data directory (overwrites existing) + $success = \rename($extractedFile, $this->getInstallPath()); + + return $success; + } finally { + // Clean up temp directory + $this->removeDirectory($tempDir); + } + } + + /** + * Get the path where the manual will be installed. + */ + public function getInstallPath(): string + { + $manualFilename = $this->format === 'php' ? 'php_manual.php' : 'php_manual.sqlite'; + + return $this->dataDir.'/'.$manualFilename; + } + + /** + * Recursively remove a directory. + */ + private function removeDirectory(string $dir) + { + if (!\is_dir($dir)) { + return; + } + + $files = \array_diff(\scandir($dir), ['.', '..']); + foreach ($files as $file) { + $path = $dir.'/'.$file; + \is_dir($path) ? $this->removeDirectory($path) : \unlink($path); + } + + \rmdir($dir); + } +} diff --git a/app/vendor/psy/psysh/src/ManualUpdater/IntervalChecker.php b/app/vendor/psy/psysh/src/ManualUpdater/IntervalChecker.php new file mode 100644 index 000000000..44eb5db59 --- /dev/null +++ b/app/vendor/psy/psysh/src/ManualUpdater/IntervalChecker.php @@ -0,0 +1,137 @@ +checker = $checker; + $this->cacheFile = $cacheFile; + $this->interval = $interval; + } + + public function isLatest(): bool + { + $this->loadCache(); + + // If we have a recent check, use the cached result + if ($this->isCacheValid()) { + return $this->cached['is_latest'] ?? true; + } + + // Otherwise check now and cache the result + $isLatest = $this->checker->isLatest(); + $this->updateCache($isLatest); + + return $isLatest; + } + + public function getLatest(): string + { + $this->loadCache(); + + // If we have a recent check, use the cached version + if ($this->isCacheValid() && isset($this->cached['latest_version'])) { + return $this->cached['latest_version']; + } + + // Otherwise fetch now and cache the result + $latest = $this->checker->getLatest(); + $this->updateCache(null, $latest); + + return $latest; + } + + public function getDownloadUrl(): string + { + // Always delegate to the underlying checker + // (URL might change between checks) + return $this->checker->getDownloadUrl(); + } + + private function loadCache() + { + if ($this->cached !== null) { + return; + } + + $content = @\file_get_contents($this->cacheFile); + if ($content) { + $this->cached = \json_decode($content, true) ?: []; + } else { + $this->cached = []; + } + } + + private function isCacheValid(): bool + { + if (!isset($this->cached['last_check'])) { + return false; + } + + try { + $now = new \DateTime(); + $lastCheck = new \DateTime($this->cached['last_check']); + + return $lastCheck >= $now->sub($this->getDateInterval()); + } catch (\Exception $e) { + return false; + } + } + + /** + * @throws \RuntimeException if interval is not supported + */ + private function getDateInterval(): \DateInterval + { + switch ($this->interval) { + case Checker::DAILY: + return new \DateInterval('P1D'); + case Checker::WEEKLY: + return new \DateInterval('P1W'); + case Checker::MONTHLY: + return new \DateInterval('P1M'); + } + + throw new \RuntimeException('Invalid interval configured'); + } + + private function updateCache(?bool $isLatest = null, ?string $latestVersion = null) + { + $this->loadCache(); + + // Update cache data + $this->cached['last_check'] = \date(\DATE_ATOM); + + if ($isLatest !== null) { + $this->cached['is_latest'] = $isLatest; + } + + if ($latestVersion !== null) { + $this->cached['latest_version'] = $latestVersion; + } + + // Write to file + @\file_put_contents($this->cacheFile, \json_encode($this->cached)); + } +} diff --git a/app/vendor/psy/psysh/src/ManualUpdater/ManualUpdate.php b/app/vendor/psy/psysh/src/ManualUpdater/ManualUpdate.php new file mode 100644 index 000000000..7905c73c9 --- /dev/null +++ b/app/vendor/psy/psysh/src/ManualUpdater/ManualUpdate.php @@ -0,0 +1,341 @@ +updates = $updates; + } + + /** + * Create a ManualUpdate instance from Configuration and command-line input. + * + * @param Configuration $config Configuration instance + * @param InputInterface $input Input interface + * @param OutputInterface $output Output interface + * + * @return self + */ + public static function fromConfig(Configuration $config, InputInterface $input, OutputInterface $output): self + { + $lang = $input->getOption('update-manual') ?: null; + + // Clear the manual update cache when explicitly running --update-manual + $cacheFile = $config->getManualUpdateCheckCacheFile(); + if ($cacheFile && \file_exists($cacheFile)) { + @\unlink($cacheFile); + } + + // Get current manual language before potentially deleting files + $currentLang = null; + $removedInvalidSqlite = false; + $manualFile = $config->getManualDbFile(); + if ($manualFile && \file_exists($manualFile)) { + try { + $manual = $config->getManual(); + if ($manual) { + $currentMeta = $manual->getMeta(); + $currentLang = $currentMeta['lang'] ?? null; + } + } catch (InvalidManualException $e) { + $removedInvalidSqlite = \substr($e->getManualFile(), -7) === '.sqlite'; + self::handleInvalidManual($e, $input, $output); + } + } + + $dataDir = $config->getManualInstallDir(); + if ($dataDir === false) { + throw new \RuntimeException('Unable to find a writable data directory for manual installation'); + } + + $phpManualPath = $dataDir.'/php_manual.php'; + $sqliteManualPath = $dataDir.'/php_manual.sqlite'; + + $formats = self::getFormatsToUpdate( + $input, + $output, + \file_exists($phpManualPath), + \file_exists($sqliteManualPath), + $removedInvalidSqlite, + $sqliteManualPath + ); + + // Build update configurations for selected formats + $checkerLang = $lang ?: $currentLang ?: 'en'; + $updates = []; + + foreach ($formats as $format) { + $path = $format === 'php' ? $phpManualPath : $sqliteManualPath; + $meta = self::getManualMeta($path); + + $updates[] = [ + 'checker' => new GitHubChecker($checkerLang, $format, $meta['version'] ?? null, $meta['lang'] ?? null), + 'installer' => new Installer($dataDir, $format), + ]; + } + + return new self(...$updates); + } + + /** + * Allow the downloader to be injected for testing. + * + * @return void + */ + public function setDownloader(Downloader $downloader) + { + $this->downloader = $downloader; + } + + /** + * Get the currently set Downloader or create one based on the capabilities of the php environment. + * + * @throws ErrorException if a downloader cannot be created for the php environment + */ + private function getDownloader(): Downloader + { + if (!isset($this->downloader)) { + return Downloader\Factory::getDownloader(); + } + + return $this->downloader; + } + + /** + * Update the manual installation. + */ + public function run(InputInterface $input, OutputInterface $output): int + { + foreach ($this->updates as $update) { + if (!$update['installer']->isDataDirWritable()) { + $output->writeln('Data directory is not writable.'); + + return self::FAILURE; + } + } + + $downloader = $this->getDownloader(); + $downloader->setTempDir(\sys_get_temp_dir()); + $installed = []; + + // Download and install each format + foreach ($this->updates as $update) { + $checker = $update['checker']; + $installer = $update['installer']; + + if ($checker->isLatest()) { + continue; + } + + $latestVersion = $checker->getLatest(); + $downloadUrl = $checker->getDownloadUrl(); + + $output->write("Downloading manual v{$latestVersion}..."); + + try { + $downloaded = $downloader->download($downloadUrl); + } catch (ErrorException $e) { + $output->write(' Failed.'); + $output->writeln(\sprintf('%s', $e->getMessage())); + $downloader->cleanup(); + + return self::FAILURE; + } + + if (!$downloaded) { + $output->writeln(' Download failed.'); + $downloader->cleanup(); + + return self::FAILURE; + } + + $output->write(' OK'.\PHP_EOL); + + $downloadedFile = $downloader->getFilename(); + + if (!$installer->install($downloadedFile)) { + $downloader->cleanup(); + $output->writeln('Failed to install manual.'); + + return self::FAILURE; + } + + $installed[] = [$installer->getInstallPath(), $latestVersion]; + + $downloader->cleanup(); + } + + if (empty($installed)) { + $output->writeln('Manual is up-to-date.'); + } else { + foreach ($installed as [$installPath, $version]) { + $prettyPath = ConfigPaths::prettyPath($installPath); + $output->writeln("Installed manual v{$version} to {$prettyPath}"); + } + } + + return self::SUCCESS; + } + + /** + * Handle an invalid manual file by prompting the user to remove it. + * + * @param InvalidManualException $e The exception containing invalid manual details + * @param InputInterface $input Input interface + * @param OutputInterface $output Output interface + * + * @throws \RuntimeException if user declines to remove the file or removal fails + */ + private static function handleInvalidManual(InvalidManualException $e, InputInterface $input, OutputInterface $output): void + { + $prettyPath = ConfigPaths::prettyPath($e->getManualFile()); + $output->writeln(\sprintf('Invalid manual file detected: %s', $prettyPath)); + $output->writeln(''); + + $helper = new QuestionHelper(); + $question = new ConfirmationQuestion('Remove this file and continue? [Y/n] ', true); + + if (!$helper->ask($input, $output, $question)) { + throw new \RuntimeException('Manual update cancelled.'); + } + + if (!\unlink($e->getManualFile())) { + throw new \RuntimeException(\sprintf('Failed to remove file: %s', $prettyPath)); + } + + $output->writeln('Invalid manual file removed.'); + $output->writeln(''); + } + + /** + * Prompt user to download PHP format manual when they have/had legacy SQLite. + * + * @param InputInterface $input Input interface + * @param OutputInterface $output Output interface + * @param string $manualFile Path to current/former SQLite manual file + * @param bool $wasRemoved Whether the file was already removed + * + * @return bool True if user wants to download PHP format + */ + private static function promptMigrateToV3(InputInterface $input, OutputInterface $output, string $manualFile, bool $wasRemoved): bool + { + $prettyPath = ConfigPaths::prettyPath($manualFile); + $verb = $wasRemoved ? 'had' : 'have'; + $output->writeln(\sprintf('You %s a legacy SQLite manual: %s', $verb, $prettyPath)); + $output->writeln(''); + + $helper = new QuestionHelper(); + $question = new ConfirmationQuestion('Download the current manual format? [Y/n] ', true); + + return $helper->ask($input, $output, $question); + } + + /** + * Determine which manual formats should be updated. + * + * @param InputInterface $input Input interface + * @param OutputInterface $output Output interface + * @param bool $hasPhpManual Whether PHP manual exists + * @param bool $hasSqliteManual Whether SQLite manual exists + * @param bool $removedInvalidSqlite Whether we just removed an invalid SQLite manual + * @param string $sqliteManualPath Path to SQLite manual file + * + * @return string[] Array of format names to update ('php', 'sqlite') + */ + private static function getFormatsToUpdate( + InputInterface $input, + OutputInterface $output, + bool $hasPhpManual, + bool $hasSqliteManual, + bool $removedInvalidSqlite, + string $sqliteManualPath + ): array { + // Only SQLite exists (or just removed invalid SQLite): offer to add PHP format + if (!$hasPhpManual && ($hasSqliteManual || $removedInvalidSqlite)) { + if (self::promptMigrateToV3($input, $output, $sqliteManualPath, $removedInvalidSqlite)) { + return ['php', 'sqlite']; + } + + return ['sqlite']; + } + + // PHP exists, or neither exist: default to PHP, and include SQLite if it exists + $formats = ['php']; + if ($hasSqliteManual) { + $formats[] = 'sqlite'; + } + + return $formats; + } + + /** + * Get manual metadata from a file. + * + * @param string $path Path to manual file + * + * @return array|null Metadata array with 'version' and 'lang' keys, or null if unavailable + */ + private static function getManualMeta(string $path): ?array + { + if (!\file_exists($path)) { + return null; + } + + try { + if (\substr($path, -4) === '.php') { + $manual = new V3Manual($path); + + return $manual->getMeta(); + } + + if (\substr($path, -7) === '.sqlite') { + $pdo = new \PDO('sqlite:'.$path); + $manual = new V2Manual($pdo); + + return $manual->getMeta(); + } + } catch (\Exception $e) { + // Ignore errors reading manual metadata + } + + return null; + } +} diff --git a/app/vendor/psy/psysh/src/Output/OutputPager.php b/app/vendor/psy/psysh/src/Output/OutputPager.php index 0652b70bf..bf43f5429 100644 --- a/app/vendor/psy/psysh/src/Output/OutputPager.php +++ b/app/vendor/psy/psysh/src/Output/OutputPager.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -19,6 +19,15 @@ */ interface OutputPager extends OutputInterface { + // TODO: Add doWrite to the OutputPager interface. + // /** + // * Writes a message to the output. + // * + // * @param string $message A message to write to the output + // * @param bool $newline Whether to add a newline or not + // */ + // public function doWrite($message, $newline): void; + /** * Close the current pager process. */ diff --git a/app/vendor/psy/psysh/src/Output/PassthruPager.php b/app/vendor/psy/psysh/src/Output/PassthruPager.php index 6ad17b5b9..538ffaf11 100644 --- a/app/vendor/psy/psysh/src/Output/PassthruPager.php +++ b/app/vendor/psy/psysh/src/Output/PassthruPager.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -29,6 +29,17 @@ public function __construct(StreamOutput $output) parent::__construct($output->getStream()); } + /** + * Writes a message to the output. + * + * @param string $message A message to write to the output + * @param bool $newline Whether to add a newline or not + */ + public function doWrite($message, $newline): void + { + parent::doWrite($message, $newline); + } + /** * Close the current pager process. */ diff --git a/app/vendor/psy/psysh/src/Output/ProcOutputPager.php b/app/vendor/psy/psysh/src/Output/ProcOutputPager.php index 8a0e5ab22..b103b5a5a 100644 --- a/app/vendor/psy/psysh/src/Output/ProcOutputPager.php +++ b/app/vendor/psy/psysh/src/Output/ProcOutputPager.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -30,6 +30,7 @@ class ProcOutputPager extends StreamOutput implements OutputPager /** @var resource */ private $stream; private string $cmd; + private bool $closedEarly = false; /** * Constructor. @@ -53,14 +54,21 @@ public function __construct(StreamOutput $output, string $cmd = 'less -R -F -X') */ public function doWrite($message, $newline): void { + // If the pager was closed early (user quit), don't reopen it. + if ($this->closedEarly) { + return; + } + $pipe = $this->getPipe(); if (false === @\fwrite($pipe, $message.($newline ? \PHP_EOL : ''))) { // @codeCoverageIgnoreStart // When the message is sufficiently long, writing to the pipe fails // if the pager process is closed before the entire message is read. // - // This is a normal condition, so we just close the pipe and return. + // This is a normal condition, so we close the pipe and ignore any + // further writes until the next paging session. $this->close(); + $this->closedEarly = true; return; // @codeCoverageIgnoreEnd @@ -74,11 +82,11 @@ public function doWrite($message, $newline): void */ public function close() { - if (isset($this->pipe)) { + if (\is_resource($this->pipe)) { \fclose($this->pipe); } - if (isset($this->proc)) { + if (\is_resource($this->proc)) { $exit = \proc_close($this->proc); if ($exit !== 0) { throw new \RuntimeException('Error closing output stream'); @@ -87,6 +95,7 @@ public function close() $this->pipe = null; $this->proc = null; + $this->closedEarly = false; } /** diff --git a/app/vendor/psy/psysh/src/Output/ShellOutput.php b/app/vendor/psy/psysh/src/Output/ShellOutput.php index 6dd91a47a..3f762150d 100644 --- a/app/vendor/psy/psysh/src/Output/ShellOutput.php +++ b/app/vendor/psy/psysh/src/Output/ShellOutput.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,6 +11,7 @@ namespace Psy\Output; +use Psy\Formatter\LinkFormatter; use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\Console\Formatter\OutputFormatterInterface; use Symfony\Component\Console\Output\ConsoleOutput; @@ -25,6 +26,7 @@ class ShellOutput extends ConsoleOutput private int $paging = 0; private OutputPager $pager; private Theme $theme; + private bool $visibleOutputWritten = false; /** * Construct a ShellOutput instance. @@ -41,15 +43,7 @@ public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = nu $this->theme = $theme ?? new Theme('modern'); $this->initFormatters(); - if ($pager === null) { - $this->pager = new PassthruPager($this); - } elseif (\is_string($pager)) { - $this->pager = new ProcOutputPager($this, $pager); - } elseif ($pager instanceof OutputPager) { - $this->pager = $pager; - } else { - throw new \InvalidArgumentException('Unexpected pager parameter: '.$pager); - } + $this->pager = $this->createPager($pager); } /** @@ -68,7 +62,9 @@ public function __construct($verbosity = self::VERBOSITY_NORMAL, $decorated = nu public function page($messages, int $type = 0) { if (\is_string($messages)) { - $messages = (array) $messages; + // Split on newlines to avoid O(n^2) performance in Symfony's OutputFormatter + // when processing large strings with many style tags. + $messages = \explode("\n", $messages); } if (!\is_array($messages) && !\is_callable($messages)) { @@ -86,6 +82,15 @@ public function page($messages, int $type = 0) $this->stopPaging(); } + /** + * Set a listener invoked whenever visible output is written. + * + * @deprecated No longer used. ShellOutput tracks visible writes internally. + */ + public function setWriteListener(?callable $listener): void + { + } + /** * Start sending output to the output pager. */ @@ -125,14 +130,33 @@ public function write($messages, $newline = false, $type = 0): void if ($type & self::NUMBER_LINES) { $pad = \strlen((string) \count($messages)); - $template = $this->isDecorated() ? ": %s" : "%{$pad}s: %s"; + $template = $this->isDecorated() && $this->getFormatter()->hasStyle('whisper') + ? "%{$pad}s: %s" + : "%{$pad}s: %s"; if ($type & self::OUTPUT_RAW) { $messages = \array_map([OutputFormatter::class, 'escape'], $messages); } + $indent = \str_repeat(' ', $pad + 2); // Indent continuation lines to align with text + foreach ($messages as $i => $line) { - $messages[$i] = \sprintf($template, $i, $line); + // Check if line contains newlines (multi-line entry) + if (\strpos($line, "\n") !== false) { + // Split into lines and indent continuation lines + $lines = \explode("\n", $line); + $firstLine = \array_shift($lines); + $indentedLines = \array_map(function ($l) use ($indent) { + return $indent.$l; + }, $lines); + + $messages[$i] = \sprintf($template, $i, $firstLine); + if (!empty($indentedLines)) { + $messages[$i] .= "\n".\implode("\n", $indentedLines); + } + } else { + $messages[$i] = \sprintf($template, $i, $line); + } } // clean this up for super. @@ -152,14 +176,27 @@ public function write($messages, $newline = false, $type = 0): void */ public function doWrite($message, $newline): void { + $this->visibleOutputWritten = true; + // @todo Update OutputPager interface to require doWrite - if ($this->paging > 0 && $this->pager instanceof ProcOutputPager) { + if ($this->paging > 0 && ($this->pager instanceof ProcOutputPager || $this->pager instanceof PassthruPager)) { $this->pager->doWrite($message, $newline); } else { parent::doWrite($message, $newline); } } + /** + * Reset visible output tracking and return whether output was written. + */ + public function consumeVisibleOutputWritten(): bool + { + $written = $this->visibleOutputWritten; + $this->visibleOutputWritten = false; + + return $written; + } + /** * Set the output Theme. */ @@ -169,6 +206,18 @@ public function setTheme(Theme $theme) $this->initFormatters(); } + /** + * Replace the output pager used for future paging operations. + * + * @param string|OutputPager|null $pager + */ + public function setPager($pager): void + { + $this->closePager(); + $this->paging = 0; + $this->pager = $this->createPager($pager); + } + /** * Flush and close the output pager. */ @@ -179,6 +228,26 @@ private function closePager() } } + /** + * @param string|OutputPager|null $pager + */ + private function createPager($pager): OutputPager + { + if ($pager === null) { + return new PassthruPager($this); + } + + if (\is_string($pager)) { + return new ProcOutputPager($this, $pager); + } + + if ($pager instanceof OutputPager) { + return $pager; + } + + throw new \InvalidArgumentException('Unexpected pager parameter: '.$pager); + } + /** * Initialize output formatter styles. */ @@ -187,6 +256,9 @@ private function initFormatters() $useGrayFallback = !$this->grayExists(); $this->theme->applyStyles($this->getFormatter(), $useGrayFallback); $this->theme->applyErrorStyles($this->getErrorOutput()->getFormatter(), $useGrayFallback); + + // Set inline styles for hyperlinks + LinkFormatter::setStyles($this->theme->getInlineStyles($useGrayFallback)); } /** @@ -195,7 +267,7 @@ private function initFormatters() private function grayExists(): bool { try { - $this->write(''); + $this->getFormatter()->format(''); } catch (\InvalidArgumentException $e) { return false; } diff --git a/app/vendor/psy/psysh/src/Output/ShellOutputAdapter.php b/app/vendor/psy/psysh/src/Output/ShellOutputAdapter.php new file mode 100644 index 000000000..bfdb08f68 --- /dev/null +++ b/app/vendor/psy/psysh/src/Output/ShellOutputAdapter.php @@ -0,0 +1,249 @@ +output = $output; + } + + /** + * Page multiple lines of output. + * + * @param string|array|\Closure $messages + */ + public function page($messages, int $type = 0): void + { + if ($this->output instanceof ShellOutput) { + $this->output->page($messages, $type); + + return; + } + + if (\is_string($messages)) { + // Split on newlines to avoid O(n^2) performance in Symfony's OutputFormatter + // when processing large strings with many style tags. + $messages = \explode("\n", $messages); + } + + if (!\is_array($messages) && !\is_callable($messages)) { + throw new \InvalidArgumentException('Paged output requires a string, array or callback'); + } + + $this->startPaging(); + + if (\is_callable($messages)) { + $messages($this); + } else { + $this->write($messages, true, $type); + } + + $this->stopPaging(); + } + + /** + * Start sending output to the output pager. + */ + public function startPaging(): void + { + if ($this->output instanceof ShellOutput) { + $this->output->startPaging(); + } + } + + /** + * Stop paging output and flush the output pager. + */ + public function stopPaging(): void + { + if ($this->output instanceof ShellOutput) { + $this->output->stopPaging(); + } + } + + /** + * Writes a message to the output. + * + * @param string|array $messages + */ + public function write($messages, $newline = false, $type = 0): void + { + if ($this->output instanceof ShellOutput) { + $this->output->write($messages, $newline, $type); + + return; + } + + $messages = (array) $messages; + + if ($type & self::NUMBER_LINES) { + $messages = $this->numberLines($messages, $type); + + // clean this up for the wrapped output. + $type = $type & ~self::NUMBER_LINES & ~OutputInterface::OUTPUT_RAW; + } + + $this->output->write($messages, $newline, $type); + } + + /** + * Writes a message to the output and adds a newline at the end. + * + * @param string|array $messages + */ + public function writeln($messages, $type = 0): void + { + $this->write($messages, true, $type); + } + + /** + * {@inheritdoc} + */ + public function setVerbosity($level): void + { + $this->output->setVerbosity($level); + } + + /** + * {@inheritdoc} + */ + public function getVerbosity(): int + { + return $this->output->getVerbosity(); + } + + /** + * {@inheritdoc} + */ + public function isQuiet(): bool + { + return $this->output->isQuiet(); + } + + /** + * {@inheritdoc} + */ + public function isVerbose(): bool + { + return $this->output->isVerbose(); + } + + /** + * {@inheritdoc} + */ + public function isVeryVerbose(): bool + { + return $this->output->isVeryVerbose(); + } + + /** + * @todo Remove method_exists guard when dropping support for Symfony < 7.2. + * + * @suppress PhanUndeclaredMethod + */ + public function isSilent(): bool + { + if (\method_exists($this->output, 'isSilent')) { + return $this->output->isSilent(); + } + + return false; + } + + /** + * {@inheritdoc} + */ + public function isDebug(): bool + { + return $this->output->isDebug(); + } + + /** + * {@inheritdoc} + */ + public function setDecorated($decorated): void + { + $this->output->setDecorated($decorated); + } + + /** + * {@inheritdoc} + */ + public function isDecorated(): bool + { + return $this->output->isDecorated(); + } + + /** + * {@inheritdoc} + */ + public function setFormatter(OutputFormatterInterface $formatter): void + { + $this->output->setFormatter($formatter); + } + + /** + * {@inheritdoc} + */ + public function getFormatter(): OutputFormatterInterface + { + return $this->output->getFormatter(); + } + + /** + * Add line numbers to a message array. + * + * @param string[] $messages + * + * @return string[] + */ + private function numberLines(array $messages, int $type): array + { + $pad = \strlen((string) \count($messages)); + $template = $this->output->isDecorated() && $this->output->getFormatter()->hasStyle('whisper') + ? "%{$pad}s: %s" + : "%{$pad}s: %s"; + + if ($type & OutputInterface::OUTPUT_RAW) { + $messages = \array_map([OutputFormatter::class, 'escape'], $messages); + } + + foreach ($messages as $i => $line) { + $messages[$i] = \sprintf($template, $i, $line); + } + + return $messages; + } +} diff --git a/app/vendor/psy/psysh/src/Output/Theme.php b/app/vendor/psy/psysh/src/Output/Theme.php index 3c84041e0..28eb5f5e6 100644 --- a/app/vendor/psy/psysh/src/Output/Theme.php +++ b/app/vendor/psy/psysh/src/Output/Theme.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -19,6 +19,8 @@ */ class Theme { + public const BUILTIN_THEMES = ['modern', 'compact', 'classic']; + const MODERN_THEME = []; // Defaults :) const COMPACT_THEME = [ @@ -34,19 +36,29 @@ class Theme 'returnValue' => '=> ', ]; + private const BUILTIN_THEME_CONFIGS = [ + 'modern' => self::MODERN_THEME, + 'compact' => self::COMPACT_THEME, + 'classic' => self::CLASSIC_THEME, + ]; + + // Custom themes fall back to DEFAULT_STYLES for any undefined style. const DEFAULT_STYLES = [ - 'info' => ['white', 'blue', ['bold']], + 'info' => ['green', null, ['bold']], 'warning' => ['black', 'yellow'], 'error' => ['white', 'red', ['bold']], 'whisper' => ['gray'], - 'aside' => ['blue'], - 'strong' => [null, null, ['bold']], - 'return' => ['cyan'], - 'urgent' => ['red'], - 'hidden' => ['black'], + 'aside' => ['blue'], + 'strong' => [null, null, ['bold']], + 'return' => ['cyan'], + 'urgent' => ['red'], + 'hidden' => ['black'], + 'command' => ['cyan', null, ['bold']], + 'command_option' => ['yellow'], + 'command_argument' => ['green'], - // Visibility + // Keywords 'public' => [null, null, ['bold']], 'protected' => ['yellow'], 'private' => ['red'], @@ -54,13 +66,15 @@ class Theme 'const' => ['cyan'], 'class' => ['blue', null, ['underscore']], 'function' => [null], + 'virtual' => ['magenta'], 'default' => [null], // Types 'number' => ['magenta'], 'integer' => ['magenta'], - 'float' => ['yellow'], + 'float' => ['magenta'], 'string' => ['green'], + 'array_key' => ['blue'], 'bool' => ['cyan'], 'keyword' => ['yellow'], 'comment' => ['blue'], @@ -70,6 +84,11 @@ class Theme // Code-specific formatting 'inline_html' => ['cyan'], + + // Interactive readline + 'input_frame' => ['bright-white', 'gray'], + 'input_frame_error' => ['bright-white', 'red'], + 'input_highlight' => [null, null, ['reverse']], ]; const ERROR_STYLES = ['info', 'warning', 'error', 'whisper', 'class']; @@ -91,23 +110,11 @@ class Theme public function __construct($config = 'modern') { if (\is_string($config)) { - switch ($config) { - case 'modern': - $config = static::MODERN_THEME; - break; - - case 'compact': - $config = static::COMPACT_THEME; - break; - - case 'classic': - $config = static::CLASSIC_THEME; - break; - - default: - \trigger_error(\sprintf('Unknown theme: %s', $config), \E_USER_NOTICE); - $config = static::MODERN_THEME; - break; + if (isset(self::BUILTIN_THEME_CONFIGS[$config])) { + $config = self::BUILTIN_THEME_CONFIGS[$config]; + } else { + \trigger_error(\sprintf('Unknown theme: %s', $config), \E_USER_NOTICE); + $config = static::MODERN_THEME; } } @@ -253,6 +260,34 @@ public function setStyles(array $styles) } } + /** + * Get the built-in theme name, or null for custom themes. + */ + public function getName(): ?string + { + foreach (self::BUILTIN_THEMES as $name) { + if ($this->equals(new self($name))) { + return $name; + } + } + + return null; + } + + /** + * Compare two themes by effective config. + */ + public function equals(self $theme): bool + { + return $this->compact === $theme->compact + && $this->prompt === $theme->prompt + && $this->bufferPrompt === $theme->bufferPrompt + && $this->replayPrompt === $theme->replayPrompt + && $this->returnValue === $theme->returnValue + && $this->grayFallback === $theme->grayFallback + && $this->styles === $theme->styles; + } + /** * Apply the current output formatter styles. */ @@ -273,10 +308,71 @@ public function applyErrorStyles(OutputFormatterInterface $errorFormatter, bool } } + /** + * Get a style definition as an array. + * + * @return array [foreground, background, options] + */ private function getStyle(string $name, bool $useGrayFallback): array { - return \array_map(function ($style) use ($useGrayFallback) { - return ($useGrayFallback && $style === 'gray') ? $this->grayFallback : $style; - }, $this->styles[$name]); + if (!$useGrayFallback) { + return $this->styles[$name]; + } + + // The default input_frame styles use extended colors (bright-white, + // gray) unavailable on older Symfony Console. Drop them rather than + // falling back to unreadable backgrounds. + if (($name === 'input_frame' || $name === 'input_frame_error') && $this->styles[$name] === static::DEFAULT_STYLES[$name]) { + return [null, null]; + } + + return \array_map(fn ($style) => ($style === 'gray') ? $this->grayFallback : $style, $this->styles[$name]); + } + + /** + * Get a style as inline style string for use with hrefs. + * + * Converts style array [fg, bg, options] to inline format: "fg=color;bg=color;options=opt1,opt2" + * + * @return string Inline style string (e.g., "fg=blue;options=underscore") + */ + private function getStyleAsInline(string $name, bool $useGrayFallback = false): string + { + $style = $this->getStyle($name, $useGrayFallback) ?? static::DEFAULT_STYLES[$name] ?? [null, null, []]; + $fg = $style[0] ?? null; + $bg = $style[1] ?? null; + $options = $style[2] ?? []; + + $parts = []; + + if ($fg !== null) { + $parts[] = \sprintf('fg=%s', $fg); + } + + if ($bg !== null) { + $parts[] = \sprintf('bg=%s', $bg); + } + + if (!empty($options)) { + $parts[] = \sprintf('options=%s', \implode(',', $options)); + } + + return \implode(';', $parts); + } + + /** + * Get all styles as inline style strings, for use with hrefs or other manual formatting. + * + * @return array Map of style name to inline style string + */ + public function getInlineStyles(bool $useGrayFallback = false): array + { + $inlineStyles = []; + + foreach (\array_keys(static::DEFAULT_STYLES) as $name) { + $inlineStyles[$name] = $this->getStyleAsInline($name, $useGrayFallback); + } + + return $inlineStyles; } } diff --git a/app/vendor/psy/psysh/src/OutputAware.php b/app/vendor/psy/psysh/src/OutputAware.php new file mode 100644 index 000000000..7d9bcb1c4 --- /dev/null +++ b/app/vendor/psy/psysh/src/OutputAware.php @@ -0,0 +1,28 @@ +create(OriginalParserFactory::PREFER_PHP7); + return $factory->create(PhpParserFactory::ONLY_PHP7); } return $factory->createForHostVersion(); diff --git a/app/vendor/psy/psysh/src/ProjectTrust.php b/app/vendor/psy/psysh/src/ProjectTrust.php new file mode 100644 index 000000000..f0f2eeab0 --- /dev/null +++ b/app/vendor/psy/psysh/src/ProjectTrust.php @@ -0,0 +1,474 @@ +configPaths = $configPaths; + } + + /** + * Get the current trust mode. + */ + public function getMode(): string + { + return $this->mode; + } + + /** + * Set the trust mode. + * + * Accepts one of: 'prompt', 'always', 'never'. + */ + public function setMode(string $mode): void + { + $this->mode = $mode; + } + + /** + * Set trust mode from environment variable. + * + * Accepts: true, 1, false, 0 + * + * @throws \InvalidArgumentException for invalid values + */ + public function setModeFromEnv(string $value): void + { + switch (\strtolower(\trim($value))) { + case 'true': + case '1': + $this->mode = Configuration::PROJECT_TRUST_ALWAYS; + break; + case 'false': + case '0': + $this->mode = Configuration::PROJECT_TRUST_NEVER; + break; + default: + throw new \InvalidArgumentException('Invalid PSYSH_TRUST_PROJECT value. Expected: true, 1, false, or 0'); + } + } + + /** + * Set force trust for this run. + */ + public function setForceTrust(bool $force = true): void + { + $this->forceTrust = $force; + if ($force) { + $this->forceUntrust = false; + } + } + + /** + * Get force trust status. + */ + public function getForceTrust(): bool + { + return $this->forceTrust; + } + + /** + * Set force untrust for this run. + */ + public function setForceUntrust(bool $force = true): void + { + $this->forceUntrust = $force; + if ($force) { + $this->forceTrust = false; + } + } + + /** + * Get force untrust status. + */ + public function getForceUntrust(): bool + { + return $this->forceUntrust; + } + + /** + * Check project trust status. + * + * @return bool|null true if trusted, false if untrusted, null if should prompt + */ + public function getProjectTrustStatus(string $projectRoot): ?bool + { + if ($this->forceUntrust || $this->mode === Configuration::PROJECT_TRUST_NEVER) { + return false; + } + + if ($this->forceTrust || $this->mode === Configuration::PROJECT_TRUST_ALWAYS || $this->isProjectTrusted($projectRoot)) { + return true; + } + + return null; + } + + /** + * Check if a project root is trusted (via stored trust or session trust). + */ + public function isProjectTrusted(string $root): bool + { + if ($this->forceUntrust) { + return false; + } + + if ($this->forceTrust) { + return true; + } + + if ($this->mode === Configuration::PROJECT_TRUST_ALWAYS) { + return true; + } + + if ($this->mode === Configuration::PROJECT_TRUST_NEVER) { + return false; + } + + $root = $this->normalizeProjectRoot($root); + $trustedRoots = $this->getTrustedProjectRoots(); + + if (\in_array($root, $trustedRoots, true)) { + return true; + } + + return \in_array($root, $this->sessionTrustedRoots, true); + } + + /** + * Trust a project root, persisting if possible. + * + * Falls back to session-only trust with a warning if persistence fails. + */ + public function trustProjectRoot(string $root, ?OutputInterface $output = null): bool + { + $root = $this->normalizeProjectRoot($root); + $trustedRoots = $this->getTrustedProjectRoots(); + if (!\in_array($root, $trustedRoots, true)) { + $trustedRoots[] = $root; + } + + if (!$this->saveTrustedProjectRoots($trustedRoots)) { + if ($output !== null) { + $this->warnTrustPersistenceFailed($root, $output); + } + $this->sessionTrustedRoots[] = $root; + + return true; + } + + return true; + } + + /** + * Display a trust persistence failure warning. + */ + public function warnTrustPersistenceFailed(string $root, OutputInterface $output): void + { + if ($output instanceof ConsoleOutput) { + $output = $output->getErrorOutput(); + } + + $prettyDir = ConfigPaths::prettyPath($root); + $output->writeln( + "Warning: Unable to save trust settings. Trusting {$prettyDir} for this session only." + ); + } + + /** + * Display a warning about untrusted autoload warming. + */ + public function warnUntrustedAutoloadWarming(string $projectRoot, OutputInterface $output): void + { + if ($this->warnedUntrustedAutoload) { + return; + } + + $this->warnedUntrustedAutoload = true; + if ($output instanceof ConsoleOutput) { + $output = $output->getErrorOutput(); + } + + $prettyDir = ConfigPaths::prettyPath($projectRoot); + $output->writeln( + "Skipping project autoload (vendor/autoload.php) in untrusted project {$prettyDir}. Use --trust-project to allow." + ); + } + + /** + * Display the interactive trust prompt and trust the project on approval. + * + * @param string[] $features Features that need trust + * + * @return bool true if user approved + */ + public function promptForTrust(InputInterface $input, OutputInterface $output, string $root, array $features): bool + { + $helper = new QuestionHelper(); + $prettyDir = ConfigPaths::prettyPath($root); + + $output->writeln(''); + $output->writeln("Unrecognized project {$prettyDir}"); + $output->writeln(''); + $output->writeln('Untrusted projects run in Restricted Mode to protect your system.'); + $output->writeln(''); + $output->writeln('Trusting this project would enable:'); + foreach ($features as $feature) { + $output->writeln(" - {$feature}"); + } + $output->writeln(''); + + $question = new ConfirmationQuestion('Trust and continue? (y/N) ', false); + if ($helper->ask($input, $output, $question)) { + $this->trustProjectRoot($root, $output); + + return true; + } + + return false; + } + + /** + * Normalize a project root path. + */ + public function normalizeProjectRoot(string $root): string + { + $realRoot = \realpath($root); + if ($realRoot !== false) { + $root = $realRoot; + } + + return \str_replace('\\', '/', $root); + } + + /** + * Get the project root for trust decisions (walks up to find composer.json). + */ + public function getProjectRoot(): ?string + { + $root = $this->configPaths->projectRoot(); + if ($root === null) { + return null; + } + + return $this->normalizeProjectRoot($root); + } + + /** + * Get the local config root (cwd only, no ancestor walking). + */ + public function getLocalConfigRoot(): ?string + { + $root = $this->configPaths->localConfigRoot(); + if ($root === null) { + return null; + } + + return $this->normalizeProjectRoot($root); + } + + /** + * Check if a project has Composer autoload files. + * + * Walks up the directory tree from the project root looking for + * vendor/autoload.php or vendor/composer/autoload_psr4.php. + */ + public function hasComposerAutoloadFiles(string $projectRoot): bool + { + $dir = $projectRoot; + $parent = \dirname($dir); + + while ($dir !== $parent) { + if (@\is_file($dir.'/vendor/autoload.php') || @\is_file($dir.'/vendor/composer/autoload_psr4.php')) { + return true; + } + + $dir = $parent; + $parent = \dirname($dir); + } + + return false; + } + + /** + * Check if the project has a local PsySH installation. + * + * Looks for psy/psysh in composer.json name or composer.lock packages, + * and falls back to the PSYSH_UNTRUSTED_PROJECT env var. + */ + public function getLocalPsyshProjectRoot(string $projectRoot): ?string + { + $composerJson = $projectRoot.'/composer.json'; + if (@\is_file($composerJson)) { + $cfg = \json_decode(@\file_get_contents($composerJson), true); + if (\is_array($cfg) && isset($cfg['name']) && $cfg['name'] === 'psy/psysh') { + if (@\is_file($projectRoot.'/vendor/autoload.php')) { + return $this->normalizeProjectRoot($projectRoot); + } + } + } + + $composerLock = $projectRoot.'/composer.lock'; + if (@\is_file($composerLock)) { + $cfg = \json_decode(@\file_get_contents($composerLock), true); + if (\is_array($cfg)) { + $packages = \array_merge($cfg['packages'] ?? [], $cfg['packages-dev'] ?? []); + foreach ($packages as $pkg) { + if (isset($pkg['name']) && $pkg['name'] === 'psy/psysh') { + if (@\is_file($projectRoot.'/vendor/autoload.php')) { + return $this->normalizeProjectRoot($projectRoot); + } + + return null; + } + } + } + } + + if (($untrustedProjectRoot = $this->getUntrustedProjectRootHint()) !== null) { + return $this->normalizeProjectRoot($untrustedProjectRoot); + } + + return null; + } + + /** + * Only prompt about local PsySH binaries when a launcher detected one. + */ + public function shouldPromptForLocalPsyshBinary(): bool + { + return $this->getUntrustedProjectRootHint() !== null; + } + + /** + * Get untrusted project root hint from environment, if present. + */ + private function getUntrustedProjectRootHint(): ?string + { + if (isset($_SERVER['PSYSH_UNTRUSTED_PROJECT']) + && \is_string($_SERVER['PSYSH_UNTRUSTED_PROJECT']) + && $_SERVER['PSYSH_UNTRUSTED_PROJECT'] !== '' + ) { + return $_SERVER['PSYSH_UNTRUSTED_PROJECT']; + } + + $env = \getenv('PSYSH_UNTRUSTED_PROJECT'); + + if (\is_string($env) && $env !== '') { + return $env; + } + + return null; + } + + /** + * Get trusted project roots from the trust file. + * + * @return string[] + */ + public function getTrustedProjectRoots(): array + { + $trustFile = $this->getProjectTrustFilePath(); + if ($trustFile === null || !@\is_file($trustFile)) { + return []; + } + + $contents = @\file_get_contents($trustFile); + if ($contents === false || $contents === '') { + return []; + } + + $data = \json_decode($contents, true); + if (!\is_array($data)) { + return []; + } + + $roots = []; + foreach ($data as $dir) { + if (\is_string($dir) && $dir !== '') { + $roots[] = $dir; + } + } + + return \array_values(\array_unique($roots)); + } + + /** + * Save trusted project roots to the trust file. + * + * @param string[] $roots + */ + public function saveTrustedProjectRoots(array $roots): bool + { + $trustFile = $this->getProjectTrustFileForWrite(); + if ($trustFile === false) { + return false; + } + + $roots = \array_values(\array_unique(\array_filter($roots, 'is_string'))); + $json = \json_encode($roots, \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES); + if ($json === false) { + return false; + } + + return \file_put_contents($trustFile, $json.\PHP_EOL) !== false; + } + + /** + * Get the path to the trusted projects file. + */ + public function getProjectTrustFilePath(): ?string + { + $configDir = $this->configPaths->currentConfigDir(); + if ($configDir === null) { + return null; + } + + return $configDir.'/trusted_projects.json'; + } + + /** + * Get a writable path to the trusted projects file, creating dirs if needed. + * + * @return string|false + */ + private function getProjectTrustFileForWrite() + { + $trustFile = $this->getProjectTrustFilePath(); + if ($trustFile === null) { + return false; + } + + return ConfigPaths::touchFileWithMkdir($trustFile); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/GNUReadline.php b/app/vendor/psy/psysh/src/Readline/GNUReadline.php index 52aa9e822..ecf482bd1 100644 --- a/app/vendor/psy/psysh/src/Readline/GNUReadline.php +++ b/app/vendor/psy/psysh/src/Readline/GNUReadline.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/AcceptSuggestionAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/AcceptSuggestionAction.php new file mode 100644 index 000000000..3c1a73ada --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/AcceptSuggestionAction.php @@ -0,0 +1,48 @@ +getCurrentSuggestion(); + if ($suggestion === null) { + return false; + } + + $text = $suggestion->applyToBuffer($buffer->getText()); + $buffer->setText($text); + $buffer->setCursor($suggestion->getReplaceStart() + \mb_strlen($suggestion->getAcceptText())); + $readline->clearSuggestion(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'accept-suggestion'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/AcceptSuggestionWordAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/AcceptSuggestionWordAction.php new file mode 100644 index 000000000..75a981ac0 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/AcceptSuggestionWordAction.php @@ -0,0 +1,59 @@ +getCurrentSuggestion(); + if ($suggestion === null) { + return false; + } + + // Word-accept currently supports append-only suggestions. + if (!$suggestion->isAppendOnly($buffer->getCursor())) { + return false; + } + + $text = $suggestion->getAcceptText(); + $wordEnd = (new WordNavigationPolicy())->findNextWord($text, 0); + $firstWord = \mb_substr($text, 0, $wordEnd); + if ($firstWord === '') { + return false; + } + + $buffer->insert($firstWord); + $readline->clearSuggestion(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'accept-suggestion-word'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ActionInterface.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ActionInterface.php new file mode 100644 index 000000000..f8592d42e --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ActionInterface.php @@ -0,0 +1,38 @@ +isMultilineMode()) { + $buffer->clear(); + + return true; + } + + if ($buffer->isEmpty()) { + $now = \time(); + $timeSinceLastCtrlC = $now - self::$lastEmptyCtrlCTime; + + // If Ctrl-C pressed twice within timeout, show exit hint + if (self::$lastEmptyCtrlCTime > 0 && $timeSinceLastCtrlC <= self::HINT_TIMEOUT) { + $terminal->write("\r"); + $terminal->clearToEndOfLine(); + $terminal->writeFormatted('(Press Ctrl-D to exit, or type \'exit\')'); + $terminal->write("\n"); + + self::$lastEmptyCtrlCTime = 0; // Reset to avoid showing hint repeatedly + } else { + $terminal->bell(); + self::$lastEmptyCtrlCTime = $now; + } + + return true; + } + + $buffer->clear(); + self::$lastEmptyCtrlCTime = 0; + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'clear-buffer'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ClearScreenAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ClearScreenAction.php new file mode 100644 index 000000000..779483b74 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ClearScreenAction.php @@ -0,0 +1,44 @@ +clearPreviousLines(); + + // Move cursor to top-left and clear entire screen + $terminal->write("\033[H\033[2J"); + $terminal->invalidateFrame(true); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'clear-screen'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DedentLeadingIndentationAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DedentLeadingIndentationAction.php new file mode 100644 index 000000000..a338f51ea --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DedentLeadingIndentationAction.php @@ -0,0 +1,74 @@ +isMultilineMode()) { + return false; + } + + $line = $buffer->getCurrentLineText(); + $indentLength = \strspn($line, " \t"); + if ($indentLength === 0) { + return false; + } + + $cursorInLine = $buffer->getCursorPositionInLine(); + if ($cursorInLine > $indentLength) { + return false; + } + + // Cursor is at line start: forward-delete leading indentation. + if ($cursorInLine === 0) { + if ($line[0] === "\t") { + return $buffer->deleteForward(1); + } + + $leadingSpaces = \strspn($line, ' '); + + return $buffer->deleteForward($buffer->spacesToPreviousTabStop($leadingSpaces)); + } + + // Cursor is within leading whitespace: backward-delete to previous tab stop. + if ($line[$cursorInLine - 1] === "\t") { + return $buffer->deleteBackward(1); + } + + $beforeCursor = \substr($line, 0, $cursorInLine); + $trailingSpaces = \strlen($beforeCursor) - \strlen(\rtrim($beforeCursor, ' ')); + + return $buffer->deleteBackward($buffer->spacesToPreviousTabStop($trailingSpaces)); + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'dedent-leading-indentation'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteBackwardCharAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteBackwardCharAction.php new file mode 100644 index 000000000..d454c16fd --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteBackwardCharAction.php @@ -0,0 +1,40 @@ +deleteBackward(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'delete-backward-char'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteBracketPairAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteBracketPairAction.php new file mode 100644 index 000000000..d9a06153d --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteBracketPairAction.php @@ -0,0 +1,46 @@ +deleteBackward(1); + $buffer->deleteForward(1); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'delete-bracket-pair'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteForwardAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteForwardAction.php new file mode 100644 index 000000000..76547f0c3 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/DeleteForwardAction.php @@ -0,0 +1,40 @@ +deleteForward(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'delete-forward'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ExitIfEmptyAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ExitIfEmptyAction.php new file mode 100644 index 000000000..fb917adea --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ExitIfEmptyAction.php @@ -0,0 +1,45 @@ +isEmpty()) { + return false; + } + + $readline->escapeCurrentFrameForAbort($buffer); + + throw new BreakException('Ctrl+D'); + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'exit-if-empty'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ExpandHistoryOnTabAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ExpandHistoryOnTabAction.php new file mode 100644 index 000000000..033a7e0b0 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ExpandHistoryOnTabAction.php @@ -0,0 +1,57 @@ +historyExpansion = $historyExpansion; + } + + /** + * Replace the HistoryExpansionAction (e.g. after Shell is set). + */ + public function setHistoryExpansion(HistoryExpansionAction $historyExpansion): void + { + $this->historyExpansion = $historyExpansion; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($this->historyExpansion->detectExpansion($buffer->getText(), $buffer->getCursor()) === null) { + return false; + } + + return $this->historyExpansion->execute($buffer, $terminal, $readline); + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'expand-history-on-tab'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/FallbackAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/FallbackAction.php new file mode 100644 index 000000000..cda3cd11a --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/FallbackAction.php @@ -0,0 +1,68 @@ +actions = \array_values($actions); + $this->defaultToContinue = $defaultToContinue; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + foreach ($this->actions as $action) { + if ($action->execute($buffer, $terminal, $readline)) { + return true; + } + } + + return $this->defaultToContinue; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'fallback('.\implode(',', \array_map(fn (ActionInterface $action) => $action->getName(), $this->actions)).')'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/HistoryExpansionAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/HistoryExpansionAction.php new file mode 100644 index 000000000..b96e17eba --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/HistoryExpansionAction.php @@ -0,0 +1,366 @@ +history = $history; + $this->shell = $shell; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + $text = $buffer->getText(); + $cursor = $buffer->getCursor(); + + $expansion = $this->detectExpansion($text, $cursor); + + if ($expansion === null) { + return true; + } + + $replacement = $this->getExpansion($expansion['pattern']); + + if ($replacement === null) { + $terminal->bell(); + + return true; + } + + $before = \mb_substr($text, 0, $expansion['start']); + $after = \mb_substr($text, $expansion['end']); + $newText = $before.$replacement.$after; + + $buffer->setText($newText); + $buffer->setCursor($expansion['start'] + \mb_strlen($replacement)); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'history-expansion'; + } + + /** + * Detect expansion pattern at or before cursor. + * + * @return array|null Array with 'pattern', 'start', 'end' or null + */ + public function detectExpansion(string $text, int $cursor): ?array + { + $patterns = ['!!', '!*', '!^', '!$']; + + foreach ($patterns as $pattern) { + $len = \mb_strlen($pattern); + $start = $cursor - $len; + + if ($start < 0) { + continue; + } + + $candidate = \mb_substr($text, $start, $len); + + if ($candidate === $pattern) { + // Ensure pattern is at a word boundary + if ($start > 0) { + $prevChar = \mb_substr($text, $start - 1, 1); + if (\preg_match('/[\w$]/u', $prevChar)) { + continue; + } + } + + return [ + 'pattern' => $pattern, + 'start' => $start, + 'end' => $cursor, + ]; + } + } + + return null; + } + + /** + * Get expansion for a pattern. + * + * @return string|null Expansion text or null if not available + */ + private function getExpansion(string $pattern): ?string + { + $entries = $this->history->getAll(); + if (empty($entries)) { + return null; + } + + $lastCommand = $entries[\count($entries) - 1]['command']; + + switch ($pattern) { + case '!!': + return $lastCommand; + + case '!$': + return $this->getLastArgument($lastCommand); + + case '!^': + return $this->getFirstArgument($lastCommand); + + case '!*': + return $this->getAllArguments($lastCommand); + + default: + return null; + } + } + + /** + * Get the first argument (index 0 is the command itself). + */ + private function getFirstArgument(string $command): ?string + { + return $this->parseArguments($command)[1] ?? null; + } + + /** + * Get the last argument. + */ + private function getLastArgument(string $command): ?string + { + $args = $this->parseArguments($command); + + if (empty($args)) { + return null; + } + + return \end($args); + } + + /** + * Get all arguments (excluding the command) joined with spaces. + */ + private function getAllArguments(string $command): ?string + { + $args = \array_slice($this->parseArguments($command), 1); + + return empty($args) ? null : \implode(' ', $args); + } + + /** + * Parse a command string into arguments. + * + * Handles both PsySH commands (like `ls $var`, `show Class::method`) and + * PHP code (like `echo $foo, $bar`). + * + * @return string[] Array of arguments + */ + private function parseArguments(string $command): array + { + $command = \trim($command); + + if ($command === '') { + return []; + } + + $psyshArgs = $this->parsePsyshCommand($command); + if ($psyshArgs !== null) { + return $psyshArgs; + } + + return $this->parsePhpCode($command); + } + + /** + * Parse PsySH command to extract code arguments. + * + * Returns null if the command is not a PsySH command with a CodeArgument. + * + * Examples: + * - `ls $var` → ['ls', '$var'] + * - `ls -al $foo->bar()` → ['ls', '$foo->bar()'] + * - `show --all SomeClass` → ['show', 'SomeClass'] + * + * @return string[]|null Array with command and code argument, or null if not a PsySH command + */ + private function parsePsyshCommand(string $command): ?array + { + if ($this->shell === null) { + return null; + } + + if (!\preg_match('/^([^\s]+)/', $command, $match)) { + return null; + } + + $commandName = $match[1]; + + try { + $cmd = $this->shell->get($commandName); + } catch (\Throwable $e) { + return null; + } + + $definition = $cmd->getDefinition(); + + // Only handle commands that accept a CodeArgument + $hasCodeArg = false; + foreach ($definition->getArguments() as $arg) { + if ($arg instanceof CodeArgument) { + $hasCodeArg = true; + break; + } + } + + if (!$hasCodeArg) { + return null; + } + + $remainder = \ltrim(\substr($command, \strlen($commandName))); + + if ($remainder === '') { + return [$commandName]; + } + + try { + $input = new ShellInput($remainder); + $input->bind($definition); + + foreach ($definition->getArguments() as $arg) { + if ($arg instanceof CodeArgument) { + $codeArg = $input->getArgument($arg->getName()); + if ($codeArg !== null && $codeArg !== '') { + return [$commandName, $codeArg]; + } + break; + } + } + + return [$commandName]; + } catch (\Throwable $e) { + return $this->parseArgumentsFallback($command); + } + } + + /** + * Parse PHP code to extract function/method call arguments. + * + * Uses PHP Parser to extract arguments from the AST. + * + * @return string[] Array of arguments + */ + private function parsePhpCode(string $code): array + { + try { + $parser = (new ParserFactory())->createParser(); + $printer = new Printer(); + $phpCode = 'parse($phpCode.';'); + if ($stmts === null) { + $stmts = @$parser->parse($phpCode); + } + + if ($stmts === null || empty($stmts)) { + return $this->parseArgumentsFallback($code); + } + + $visitor = new ArgumentExtractorVisitor($printer); + $traverser = new NodeTraverser(); + $traverser->addVisitor($visitor); + $traverser->traverse($stmts); + + $result = $visitor->getArguments(); + + // Fall back for things like "ls -al" that parse as PHP but aren't function calls + if (empty($result)) { + return $this->parseArgumentsFallback($code); + } + + return $result; + } catch (\Throwable $e) { + return $this->parseArgumentsFallback($code); + } + } + + /** + * Fallback argument parser that splits on whitespace while preserving quotes. + * + * @return string[] Array of arguments + */ + private function parseArgumentsFallback(string $command): array + { + $args = []; + $current = ''; + $inQuote = null; + $len = \strlen($command); + + for ($i = 0; $i < $len; $i++) { + $char = $command[$i]; + + if ($inQuote !== null) { + $current .= $char; + if ($char === $inQuote && ($i === 0 || $command[$i - 1] !== '\\')) { + $inQuote = null; + } + } elseif ($char === '"' || $char === "'") { + $inQuote = $char; + $current .= $char; + } elseif (\ctype_space($char)) { + if ($current !== '') { + $args[] = $current; + $current = ''; + } + } else { + $current .= $char; + } + } + + if ($current !== '') { + $args[] = $current; + } + + return $args; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertCloseBracketAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertCloseBracketAction.php new file mode 100644 index 000000000..bd551bb52 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertCloseBracketAction.php @@ -0,0 +1,86 @@ +bracket = $bracket; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if (BracketPair::shouldSkipOver($this->bracket, $buffer)) { + if ($this->shouldDedent($buffer)) { + $this->dedentAndSkip($buffer); + } else { + $buffer->moveCursorRight(1); + } + } else { + $buffer->autoDedentIfClosingBracket($this->bracket, $buffer->getBeforeCursor()); + $buffer->insert($this->bracket); + } + + return true; + } + + /** + * Check if we should dedent when typing a closing bracket. + * + * Dedent when: + * - Cursor is before the closing bracket + * - Current line only has whitespace before the cursor + * - We're in multi-line mode + */ + private function shouldDedent(Buffer $buffer): bool + { + $currentLine = $buffer->getCurrentLineText(); + $cursorInLine = $buffer->getCursorPositionInLine(); + + $textBeforeCursor = \mb_substr($currentLine, 0, $cursorInLine); + + return \trim($textBeforeCursor) === '' && \strpos($buffer->getText(), "\n") !== false; + } + + /** + * Dedent by removing indentation before the closing bracket. + * + * Keeps the closing bracket on its own line but removes the indentation. + */ + private function dedentAndSkip(Buffer $buffer): void + { + $buffer->deleteBackward($buffer->getCursorPositionInLine()); + $buffer->moveCursorRight(1); + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'insert-close-bracket'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertIndentOnTabAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertIndentOnTabAction.php new file mode 100644 index 000000000..9abb42d94 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertIndentOnTabAction.php @@ -0,0 +1,53 @@ +isMultilineMode()) { + return false; + } + + $line = $buffer->getCurrentLineText(); + $cursorInLine = $buffer->getCursorPositionInLine(); + $beforeCursor = \substr($line, 0, $cursorInLine); + + if (\trim($beforeCursor) !== '') { + return false; + } + + $spaces = $buffer->spacesToNextTabStop($cursorInLine); + $buffer->insert(\str_repeat(' ', $spaces)); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'insert-indent-on-tab'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakAction.php new file mode 100644 index 000000000..0dbe54d3e --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakAction.php @@ -0,0 +1,61 @@ +calculateIndentBeforeCursor(); + $expandBracket = $this->isCursorBeforeClosingBracket($buffer); + + $buffer->insert("\n".$indent); + + // Push the closing bracket to its own line, dedented one level. + if ($expandBracket) { + $cursorPos = $buffer->getCursor(); + $buffer->insert("\n".$buffer->dedent($indent)); + $buffer->setCursor($cursorPos); + } + + return true; + } + + /** + * Check whether the cursor is immediately before a closing bracket. + */ + private function isCursorBeforeClosingBracket(Buffer $buffer): bool + { + $afterCursor = $buffer->getAfterCursor(); + + return $afterCursor !== '' && \in_array($afterCursor[0], BracketPair::CLOSING_BRACKETS); + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'insert-line-break'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakOnIncompleteStatementAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakOnIncompleteStatementAction.php new file mode 100644 index 000000000..f0e953da1 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakOnIncompleteStatementAction.php @@ -0,0 +1,62 @@ +lineBreakAction = new InsertLineBreakAction(); + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($readline->isMultilineMode()) { + if ($buffer->isCompleteStatement()) { + return false; + } + + return $this->lineBreakAction->execute($buffer, $terminal, $readline); + } + + if ($buffer->isEmpty() || $buffer->isCompleteStatement()) { + return false; + } + + $line = $buffer->getText(); + if ($readline->isCommand($line) && !$readline->isInOpenStringOrComment($line)) { + return false; + } + + return $this->lineBreakAction->execute($buffer, $terminal, $readline); + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'insert-line-break-on-incomplete-statement'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakOnUnclosedBracketsAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakOnUnclosedBracketsAction.php new file mode 100644 index 000000000..35f279ff6 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertLineBreakOnUnclosedBracketsAction.php @@ -0,0 +1,57 @@ +smartBrackets = $smartBrackets; + $this->lineBreakAction = new InsertLineBreakAction(); + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if (!$this->smartBrackets || !$buffer->hasUnclosedBracketsBeforeCursor()) { + return false; + } + + // If the full buffer is semantically complete, let it submit + // even if the cursor is between brackets. + if ($buffer->isCompleteStatement()) { + return false; + } + + return $this->lineBreakAction->execute($buffer, $terminal, $readline); + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'insert-line-break-on-unclosed-brackets'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertOpenBracketAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertOpenBracketAction.php new file mode 100644 index 000000000..2da3d1b12 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertOpenBracketAction.php @@ -0,0 +1,99 @@ +bracket = $bracket; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($this->shouldDedentForControlStructureBrace($buffer)) { + $this->dedentForControlStructureBrace($buffer); + } + + if (BracketPair::shouldAutoClose($this->bracket, $buffer)) { + $closingBracket = BracketPair::getClosingBracket($this->bracket); + $buffer->insert($this->bracket.$closingBracket); + $buffer->moveCursorLeft(1); + } else { + $buffer->insert($this->bracket); + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'insert-open-bracket'; + } + + /** + * Detect Allman-style opening braces after a control structure line. + */ + private function shouldDedentForControlStructureBrace(Buffer $buffer): bool + { + if ($this->bracket !== '{') { + return false; + } + + $currentLine = $buffer->getCurrentLineText(); + $cursorInLine = $buffer->getCursorPositionInLine(); + $textBeforeCursor = \mb_substr($currentLine, 0, $cursorInLine); + + if (\trim($currentLine) !== '' || \trim($textBeforeCursor) !== '' || $cursorInLine !== \mb_strlen($currentLine)) { + return false; + } + + $linesBeforeCursor = \explode("\n", $buffer->getBeforeCursor()); + \array_pop($linesBeforeCursor); + $previousLine = \end($linesBeforeCursor); + + if ($previousLine === false) { + return false; + } + + return (bool) \preg_match('/^\s*(?:(?:if|for|foreach|while|switch|elseif)\s*\([^)]*\)|else|do)\s*$/', $previousLine); + } + + /** + * Align the opening brace with the preceding control structure line. + */ + private function dedentForControlStructureBrace(Buffer $buffer): void + { + $cursorInLine = $buffer->getCursorPositionInLine(); + $indent = \mb_substr($buffer->getCurrentLineText(), 0, $cursorInLine); + $dedentedIndent = $buffer->dedent($indent); + + $buffer->deleteBackward($cursorInLine); + $buffer->insert($dedentedIndent); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertQuoteAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertQuoteAction.php new file mode 100644 index 000000000..1d4cd2b36 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/InsertQuoteAction.php @@ -0,0 +1,59 @@ +quote = $quote; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if (BracketPair::shouldSkipOver($this->quote, $buffer)) { + $buffer->moveCursorRight(1); + + return true; + } + + if (BracketPair::shouldAutoClose($this->quote, $buffer)) { + $buffer->insert($this->quote.$this->quote); + $buffer->moveCursorLeft(1); + } else { + $buffer->insert($this->quote); + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'insert-quote'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillLineAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillLineAction.php new file mode 100644 index 000000000..e0b11e8e3 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillLineAction.php @@ -0,0 +1,40 @@ +deleteToEnd(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'kill-line'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillTokenAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillTokenAction.php new file mode 100644 index 000000000..4d7d1371b --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillTokenAction.php @@ -0,0 +1,44 @@ +deletePreviousToken(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'kill-token'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillWholeLineAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillWholeLineAction.php new file mode 100644 index 000000000..f865b0fc1 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillWholeLineAction.php @@ -0,0 +1,40 @@ +deleteToStart(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'kill-whole-line'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillWordAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillWordAction.php new file mode 100644 index 000000000..421c5cf27 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/KillWordAction.php @@ -0,0 +1,40 @@ +deletePreviousWord(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'kill-word'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveLeftAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveLeftAction.php new file mode 100644 index 000000000..ac4a938ee --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveLeftAction.php @@ -0,0 +1,40 @@ +moveCursorLeft(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-left'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveRightAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveRightAction.php new file mode 100644 index 000000000..1ef45d3e2 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveRightAction.php @@ -0,0 +1,40 @@ +moveCursorRight(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-right'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveToEndAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveToEndAction.php new file mode 100644 index 000000000..1b35e74e2 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveToEndAction.php @@ -0,0 +1,40 @@ +moveCursorToEndOfCurrentLine(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-to-end'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveToStartAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveToStartAction.php new file mode 100644 index 000000000..8941fd7ef --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveToStartAction.php @@ -0,0 +1,51 @@ +getCurrentLineText(); + $cursorInLine = $buffer->getCursorPositionInLine(); + $lineStart = $buffer->getCursor() - $cursorInLine; + + // For whitespace-only lines, treat the whole line as having no indent + $firstNonWhitespace = \strspn($line, " \t"); + if ($firstNonWhitespace === \strlen($line)) { + $firstNonWhitespace = 0; + } + + $targetColumn = $cursorInLine === $firstNonWhitespace ? 0 : $firstNonWhitespace; + $buffer->setCursor($lineStart + $targetColumn); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-to-start'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveTokenLeftAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveTokenLeftAction.php new file mode 100644 index 000000000..d27322c38 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveTokenLeftAction.php @@ -0,0 +1,45 @@ +findPreviousToken(); + $buffer->setCursor($tokenStart); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-token-left'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveTokenRightAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveTokenRightAction.php new file mode 100644 index 000000000..c6c96bdd0 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveTokenRightAction.php @@ -0,0 +1,45 @@ +findNextToken(); + $buffer->setCursor($tokenStart); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-token-right'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveWordLeftAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveWordLeftAction.php new file mode 100644 index 000000000..01a63f671 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveWordLeftAction.php @@ -0,0 +1,41 @@ +findPreviousWord(); + $buffer->setCursor($wordStart); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-word-left'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveWordRightAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveWordRightAction.php new file mode 100644 index 000000000..855d149b6 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/MoveWordRightAction.php @@ -0,0 +1,41 @@ +findNextWord(); + $buffer->setCursor($wordEnd); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'move-word-right'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/NextHistoryAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/NextHistoryAction.php new file mode 100644 index 000000000..caec143c3 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/NextHistoryAction.php @@ -0,0 +1,77 @@ +history = $history; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($buffer->moveToNextVisualRow( + $terminal->getWidth(), + $readline->getPromptWidthForCurrentLine($buffer) + )) { + return true; + } + + if ($readline->isMultilineMode() && !$buffer->isOnLastLine()) { + $buffer->moveToNextLine(); + + return true; + } + + if (!$this->history->isInHistory()) { + $terminal->bell(); + + return true; + } + + $entry = $this->history->getNext(); + + if ($entry !== null) { + $buffer->setText($entry); + } else { + $terminal->bell(); + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'next-history'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/PreviousHistoryAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/PreviousHistoryAction.php new file mode 100644 index 000000000..e441ebe21 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/PreviousHistoryAction.php @@ -0,0 +1,86 @@ +history = $history; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($buffer->moveToPreviousVisualRow( + $terminal->getWidth(), + $readline->getPromptWidthForCurrentLine($buffer) + )) { + return true; + } + + if ($readline->isMultilineMode() && !$buffer->isOnFirstLine()) { + $buffer->moveToPreviousLine(); + + return true; + } + + $enteringHistory = !$this->history->isInHistory(); + $text = $buffer->getText(); + + // Set the search term when first entering history navigation + if ($enteringHistory) { + $this->history->setSearchTerm($text !== '' ? $text : null); + } + + $entry = $this->history->getPrevious(); + + if ($entry === null) { + $terminal->bell(); + + return true; + } + + // Save current input before navigating away so we can restore it + if ($enteringHistory && $text !== '') { + $this->history->saveTemporaryEntry($text); + } + + $buffer->setText($entry); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'previous-history'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/RejectSyntaxErrorAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/RejectSyntaxErrorAction.php new file mode 100644 index 000000000..7ba50479c --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/RejectSyntaxErrorAction.php @@ -0,0 +1,84 @@ +hasUnrecoverableSyntaxError()) { + return false; + } + + $line = $buffer->getText(); + if ($readline->isCommand($line) && !$readline->isInOpenStringOrComment($line)) { + return false; + } + + // Don't reject when there are truly unclosed brackets before + // cursor (more opens than closes). In that case, the user is + // still typing inside a bracket pair and the unclosed-brackets + // action should handle continuation instead. + if ($this->hasOpenBracketsBeforeCursor($buffer)) { + return false; + } + + $readline->setInputFrameError(true); + $terminal->bell(); + + return true; + } + + /** + * Check if text before cursor has more opening brackets than closing. + */ + private function hasOpenBracketsBeforeCursor(Buffer $buffer): bool + { + $text = $buffer->getBeforeCursor(); + if (\trim($text) === '') { + return false; + } + + $tokens = @\token_get_all(' 1, ')' => -1, '[' => 1, ']' => -1, '{' => 1, '}' => -1]; + + foreach ($tokens as $token) { + if (\is_string($token) && isset($pairs[$token])) { + $depth += $pairs[$token]; + } + } + + return $depth > 0; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'reject-syntax-error'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ReverseSearchAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ReverseSearchAction.php new file mode 100644 index 000000000..c462ec894 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/ReverseSearchAction.php @@ -0,0 +1,54 @@ +search = $search; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($this->search->isActive()) { + $this->search->findNext(); + } else { + $readline->clearSuggestion(); + $this->search->saveBuffer($buffer); + $this->search->enter($buffer->getCurrentLineText()); + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'reverse-search-history'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/SelfInsertAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/SelfInsertAction.php new file mode 100644 index 000000000..faf726f6b --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/SelfInsertAction.php @@ -0,0 +1,50 @@ +char = $char; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + $context = $buffer->getText(); + $buffer->autoDedentIfClosingBracket($this->char, $context); + + $buffer->insert($this->char); + + return true; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'self-insert'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/SubmitLineAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/SubmitLineAction.php new file mode 100644 index 000000000..fd795f612 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/SubmitLineAction.php @@ -0,0 +1,49 @@ +getText(); + + // Move from current input line to below any outer frame rows. + $lineCount = \substr_count($line, "\n") + 1; + $remainingInputLines = $lineCount - $buffer->getCurrentLineNumber(); + $outerRows = $readline->getInputFrameOuterRowCount(); + $escapeRows = $remainingInputLines + $outerRows; + $terminal->write(\str_repeat("\n", $escapeRows)); + + $readline->setLastSubmitEscapeRows($escapeRows); + + return false; + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'submit-line'; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Actions/TabAction.php b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/TabAction.php new file mode 100644 index 000000000..9f41e818f --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Actions/TabAction.php @@ -0,0 +1,546 @@ +completer = $completer; + $this->smartBrackets = $smartBrackets; + } + + /** + * Set the CompletionEngine instance. + */ + public function setCompleter(CompletionEngine $completer): void + { + $this->completer = $completer; + } + + /** + * Force-enable or disable interactive menu mode (for tests). + * + * @internal + */ + public function setInteractiveSelectionEnabled(?bool $enabled): void + { + $this->interactiveSelectionEnabled = $enabled; + } + + /** + * {@inheritdoc} + */ + public function execute(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($this->completer === null) { + $terminal->bell(); + + return true; + } + + $text = $buffer->getText(); + $cursor = $buffer->getCursor(); + + $matches = $this->completer->getCompletions( + new CompletionRequest($text, $cursor, CompletionRequest::MODE_TAB) + ); + + if (empty($matches)) { + return true; + } + + if (\count($matches) === 1) { + $this->insertMatch($buffer, $matches[0]); + + return true; + } + + $commonPrefix = $this->getCommonPrefix($matches); + $currentWord = CurrentWord::extract($text, $cursor); + + if (!empty($commonPrefix) && $commonPrefix !== $currentWord) { + $this->insertMatch($buffer, $commonPrefix); + $currentWord = $commonPrefix; + } + + $this->currentMatches = \array_values($matches); + $this->filterText = $currentWord; + $this->filteredMatches = $this->currentMatches; + $this->selectedIndex = 0; + $this->scrollOffset = 0; + $this->expanded = false; + $this->inInteractiveMode = true; + + $readline->enterMenuMode(); + try { + $this->updateOverlay($buffer, $terminal, $readline); + + return $this->handleInteractiveSelection($buffer, $terminal, $readline); + } finally { + $readline->exitMenuMode(); + } + } + + /** + * {@inheritdoc} + */ + public function getName(): string + { + return 'tab-completion'; + } + + /** + * Insert a match at the cursor position. + */ + private function insertMatch(Buffer $buffer, string $match): void + { + $text = $buffer->getText(); + $cursor = $buffer->getCursor(); + $textLen = \mb_strlen($text); + + $start = $cursor; + $hasVarPrefix = false; + while ($start > 0) { + $char = \mb_substr($text, $start - 1, 1); + if (\ctype_space($char)) { + break; + } + if ($char === '>' && $start >= 2 && \mb_substr($text, $start - 2, 1) === '-') { + break; + } + if ($char === ':' && $start >= 2 && \mb_substr($text, $start - 2, 1) === ':') { + break; + } + if ($char === '$') { + $hasVarPrefix = true; + $start--; + break; + } + $start--; + } + + $end = $cursor; + while ($end < $textLen) { + $char = \mb_substr($text, $end, 1); + if (\ctype_space($char) || (!\ctype_alnum($char) && $char !== '_')) { + break; + } + $end++; + } + + if ($hasVarPrefix && $match[0] !== '$') { + $match = '$'.$match; + } + + $addParens = $this->smartBrackets && $this->shouldAddParentheses($match); + + $before = \mb_substr($text, 0, $start); + $after = \mb_substr($text, $end); + + if ($addParens) { + $buffer->setText($before.$match.'()'.$after); + // Place cursor after parens for zero-arg functions, inside for others + $offset = $this->functionHasParameters($match) ? 1 : 2; + $buffer->setCursor($start + \mb_strlen($match) + $offset); + } else { + $buffer->setText($before.$match.$after); + $buffer->setCursor($start + \mb_strlen($match)); + } + } + + /** + * Determine if parentheses should be added for this completion. + */ + private function shouldAddParentheses(string $match): bool + { + if (\substr($match, 0, 1) === '$') { + return false; + } + + if (\strtoupper($match) === $match && \ctype_upper($match[0])) { + return false; + } + + return \function_exists($match); + } + + /** + * Check whether a function accepts any parameters (required or optional). + */ + private function functionHasParameters(string $name): bool + { + try { + return (new \ReflectionFunction($name))->getNumberOfParameters() > 0; + } catch (\ReflectionException $e) { + // If we can't reflect it, assume it has parameters + return true; + } + } + + /** + * Handle interactive selection with arrow keys and filtering. + */ + private function handleInteractiveSelection(Buffer $buffer, Terminal $terminal, Readline $readline): bool + { + if ($this->interactiveSelectionEnabled !== null) { + $isTTY = $this->interactiveSelectionEnabled; + } else { + $isTTY = @\stream_isatty(\STDIN); + } + + if (!$isTTY) { + $this->inInteractiveMode = false; + + return true; + } + + while ($this->inInteractiveMode) { + $key = $readline->readNextKey(); + $keyStr = (string) $key; + $keyValue = $key->getValue(); + + if ($keyStr === 'escape:[A' || $keyValue === "\x10") { // Up or Ctrl-P + $this->moveSelection(-1, $readline); + $this->updateOverlay($buffer, $terminal, $readline); + } elseif ($keyStr === 'escape:[B' || $keyValue === "\x0e") { // Down or Ctrl-N + $this->moveSelection(1, $readline); + $this->updateOverlay($buffer, $terminal, $readline); + } elseif ($keyStr === 'escape:[C' || $keyValue === "\x06") { // Right or Ctrl-F + $this->moveSelectionHorizontal(1, $readline); + $this->updateOverlay($buffer, $terminal, $readline); + } elseif ($keyStr === 'escape:[D' || $keyValue === "\x02") { // Left or Ctrl-B + $this->moveSelectionHorizontal(-1, $readline); + $this->updateOverlay($buffer, $terminal, $readline); + } elseif ($keyValue === "\t") { + // Tab cycles to the next match + $this->moveSelection(1, $readline); + $this->updateOverlay($buffer, $terminal, $readline); + } elseif ($keyValue === "\r" || $keyValue === "\n") { + $this->inInteractiveMode = false; + if (!empty($this->filteredMatches)) { + $selected = $this->filteredMatches[$this->selectedIndex]; + $this->insertMatch($buffer, $selected); + } + $readline->clearOverlay($buffer); + break; + } elseif ($keyValue === "\e" || $keyValue === "\x03") { // Escape or Ctrl-C + $this->inInteractiveMode = false; + $readline->clearOverlay($buffer); + break; + } elseif ($keyValue === "\x7f" || $keyValue === "\x08") { // Backspace + if ($buffer->getCursor() > 0) { + $buffer->deleteBackward(); + + $this->filterText = CurrentWord::extract($buffer->getText(), $buffer->getCursor()); + + if ($this->filterText === '') { + $this->inInteractiveMode = false; + $readline->clearOverlay($buffer); + break; + } + + $this->updateFilter($terminal); + $this->updateOverlay($buffer, $terminal, $readline); + } + } elseif ($key->isChar() && \strlen($keyValue) === 1 && $keyValue >= ' ' && $keyValue <= '~') { + $buffer->insert($keyValue); + + if ($keyValue === ' ') { + $this->inInteractiveMode = false; + $readline->clearOverlay($buffer); + break; + } + + $this->filterText = CurrentWord::extract($buffer->getText(), $buffer->getCursor()); + $this->updateFilter($terminal); + $this->updateOverlay($buffer, $terminal, $readline); + } else { + $this->inInteractiveMode = false; + $readline->clearOverlay($buffer); + $readline->replayKey($key); + break; + } + } + + return true; + } + + /** + * Generate overlay lines from matches and render the frame. + */ + private function updateOverlay(Buffer $buffer, Terminal $terminal, Readline $readline): void + { + // Terminal width may change while the menu is open. + $this->updateLayout($terminal); + + $maxRows = $this->getMaxRows($readline); + if ($maxRows === null) { + $this->scrollOffset = 0; + } else { + $maxOffset = \max(0, $this->totalRows - $maxRows); + $this->scrollOffset = \max(0, \min($this->scrollOffset, $maxOffset)); + } + + $renderer = new CompletionRenderer($terminal); + $lines = $renderer->render($this->filteredMatches, $this->selectedIndex, $maxRows, $this->scrollOffset, !$this->expanded); + + // Prepend a blank separator line above the menu + $readline->renderOverlay($buffer, \array_merge([''], $lines)); + } + + /** + * Update filtered matches based on current filter text. + */ + private function updateFilter(?Terminal $terminal = null): void + { + $previousSelection = $this->filteredMatches[$this->selectedIndex] ?? null; + + if ($this->filterText === '') { + $this->filteredMatches = $this->currentMatches; + } else { + $this->filteredMatches = FuzzyMatcher::filter($this->filterText, $this->currentMatches); + } + + // Keep the same item selected if it survived filtering, otherwise + // reset to the top where the best matches are. + $newIndex = \array_search($previousSelection, $this->filteredMatches, true); + $this->selectedIndex = $newIndex !== false ? $newIndex : 0; + + // Reset viewport when filter changes + $this->scrollOffset = 0; + $this->expanded = false; + + if ($terminal !== null) { + $this->updateLayout($terminal); + } + } + + /** + * Recalculate total row count for the current matches. + */ + private function updateLayout(Terminal $terminal): void + { + if (empty($this->filteredMatches)) { + $this->totalRows = 0; + $this->totalColumns = 0; + + return; + } + + $renderer = new CompletionRenderer($terminal); + $layout = $renderer->calculateLayout($this->filteredMatches); + $this->totalRows = $layout['rows']; + $this->totalColumns = $layout['columns']; + } + + /** + * Get the maximum visible rows for the current viewport state. + * + * Returns null if all rows fit without truncation. + */ + private function getMaxRows(Readline $readline): ?int + { + $available = $readline->getOverlayAvailableRows(!$this->expanded); + + // Account for the blank separator line above the menu + $menuBudget = \max(1, $available - 1); + + if ($this->totalRows <= $menuBudget) { + // No truncation needed if everything fits (including the +1 off-by-one: + // don't show a status line when the last row would fit in its place) + return null; + } + + // When truncated, reserve one row for the status line + return \max(1, $menuBudget - 1); + } + + /** + * Move selection up or down, adjusting viewport as needed. + */ + private function moveSelection(int $delta, Readline $readline): void + { + $count = \count($this->filteredMatches); + if ($count === 0) { + return; + } + + $newIndex = $this->selectedIndex + $delta; + + // Wrap around + if ($newIndex < 0) { + $newIndex = $count - 1; + } elseif ($newIndex >= $count) { + $newIndex = 0; + } + + $this->selectedIndex = $newIndex; + $this->adjustViewport($readline); + } + + /** + * Adjust scroll offset so the selected item is visible. + */ + private function adjustViewport(Readline $readline): void + { + $maxRows = $this->getMaxRows($readline); + + // Everything fits, no scrolling needed + if ($maxRows === null) { + $this->scrollOffset = 0; + + return; + } + + $selectedRow = $this->selectedIndex % $this->totalRows; + + // Selection is above the visible window + if ($selectedRow < $this->scrollOffset) { + $this->scrollOffset = $selectedRow; + + return; + } + + // Selection is below the visible window + if ($selectedRow >= $this->scrollOffset + $maxRows) { + if (!$this->expanded) { + $this->expanded = true; + $maxRows = $this->getMaxRows($readline); + + // After expanding, everything might fit + if ($maxRows === null) { + $this->scrollOffset = 0; + + return; + } + } + + // Scroll to keep selection visible at the bottom + if ($selectedRow >= $this->scrollOffset + $maxRows) { + $this->scrollOffset = $selectedRow - $maxRows + 1; + } + } + + // Clamp scroll offset + $this->scrollOffset = \max(0, \min($this->scrollOffset, $this->totalRows - $maxRows)); + } + + /** + * Move selection left or right (horizontal between columns). + */ + private function moveSelectionHorizontal(int $delta, Readline $readline): void + { + $count = \count($this->filteredMatches); + if ($count === 0) { + return; + } + + $rows = $this->totalRows; + $columns = $this->totalColumns; + + $currentRow = $this->selectedIndex % $rows; + $currentCol = \intdiv($this->selectedIndex, $rows); + + $newCol = $currentCol + $delta; + + // Wrap to next/previous row at column boundaries + if ($newCol >= $columns || ($currentRow + ($newCol * $rows)) >= $count) { + $newCol = 0; + $currentRow++; + if ($currentRow >= $rows) { + $currentRow = 0; + } + } elseif ($newCol < 0) { + $newCol = $columns - 1; + $currentRow--; + if ($currentRow < 0) { + $currentRow = $rows - 1; + } + } + + $newIndex = $currentRow + ($newCol * $rows); + + // If we landed past the end (sparse last row), fall back to last column on this row + if ($newIndex >= $count) { + while ($newCol > 0 && $newIndex >= $count) { + $newCol--; + $newIndex = $currentRow + ($newCol * $rows); + } + } + + $this->selectedIndex = $newIndex; + $this->adjustViewport($readline); + } + + /** + * Get the common prefix of all matches. + * + * @todo Should this be grapheme cluster aware? + * + * @param string[] $matches + */ + private function getCommonPrefix(array $matches): string + { + if (empty($matches)) { + return ''; + } + + $first = \array_shift($matches); + $prefix = ''; + + for ($i = 0; $i < \strlen($first); $i++) { + $char = $first[$i]; + foreach ($matches as $match) { + if (!isset($match[$i]) || $match[$i] !== $char) { + return $prefix; + } + } + $prefix .= $char; + } + + return $prefix; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/ArgumentExtractorVisitor.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/ArgumentExtractorVisitor.php new file mode 100644 index 000000000..fc7127cdf --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/ArgumentExtractorVisitor.php @@ -0,0 +1,134 @@ +printer = $printer; + } + + public function enterNode(Node $node) + { + if ($this->foundCall) { + return null; + } + + $callable = $this->resolveCallable($node); + if ($callable !== null) { + $this->foundCall = true; + $this->arguments[] = $callable; + + if ($node instanceof Node\Expr\FuncCall || $node instanceof Node\Expr\MethodCall || $node instanceof Node\Expr\StaticCall || $node instanceof Node\Expr\New_) { + $this->extractArgs($node); + } + } + + return null; + } + + /** + * Resolve the callable name for a function/method call or new expression. + */ + private function resolveCallable(Node $node): ?string + { + if ($node instanceof Node\Expr\FuncCall) { + if ($node->name instanceof Node\Name) { + return $node->name->toString(); + } + + return $this->printer->prettyPrintExpr($node->name); + } + + if ($node instanceof Node\Expr\MethodCall) { + return $this->printer->prettyPrintExpr($node->var).'->'.$this->resolveMethodName($node->name); + } + + if ($node instanceof Node\Expr\StaticCall) { + return $this->resolveClassName($node->class).'::'.$this->resolveMethodName($node->name); + } + + if ($node instanceof Node\Expr\New_) { + return 'new '.$this->resolveClassName($node->class); + } + + return null; + } + + /** + * Resolve a class name from a Name node or expression. + * + * @param Node\Name|Node\Expr $class + */ + private function resolveClassName(Node $class): string + { + if ($class instanceof Node\Name) { + return $class->toString(); + } + + return $this->printer->prettyPrintExpr($class); + } + + /** + * Resolve a method name from an Identifier node or expression. + * + * @param Node\Identifier|Node\Expr $name + */ + private function resolveMethodName(Node $name): string + { + if ($name instanceof Node\Identifier) { + return $name->name; + } + + return $this->printer->prettyPrintExpr($name); + } + + /** + * @param Node\Expr\FuncCall|Node\Expr\MethodCall|Node\Expr\StaticCall|Node\Expr\New_ $node + */ + private function extractArgs($node): void + { + if (!\is_array($node->args)) { + return; + } + + foreach ($node->args as $arg) { + if ($arg instanceof Node\Arg) { + $this->arguments[] = $this->printer->prettyPrintExpr($arg->value); + } + } + } + + /** + * @return string[] + */ + public function getArguments(): array + { + return $this->arguments; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/BracketPair.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/BracketPair.php new file mode 100644 index 000000000..2b22c1e52 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/BracketPair.php @@ -0,0 +1,221 @@ + ')', + '[' => ']', + '{' => '}', + '"' => '"', + "'" => "'", + ]; + + private const CLOSING_TO_OPENING = [ + ')' => '(', + ']' => '[', + '}' => '{', + ]; + + /** + * Should we auto-close this opening bracket? + */ + public static function shouldAutoClose(string $char, Buffer $buffer): bool + { + if (!isset(self::PAIRS[$char])) { + return false; + } + + if (self::isQuote($char) && self::isInsideString($buffer)) { + return false; + } + + // Don't auto-close if next char is alphanumeric, e.g. typing "ar(ray" + $nextChar = $buffer->getCharAfterCursor(); + if ($nextChar !== null && self::startsWithAlnum($nextChar)) { + return false; + } + + return true; + } + + /** + * Should we skip over the closing bracket instead of inserting? + */ + public static function shouldSkipOver(string $char, Buffer $buffer): bool + { + $nextChar = $buffer->getCharAfterCursor(); + + return $nextChar === $char; + } + + /** + * Should backspace delete the matching closing bracket? + */ + public static function shouldDeletePair(Buffer $buffer): bool + { + $before = $buffer->getCharBeforeCursor(); + $after = $buffer->getCharAfterCursor(); + + if ($before === null || $after === null) { + return false; + } + + return isset(self::PAIRS[$before]) && self::PAIRS[$before] === $after; + } + + /** + * Get the closing bracket for this opening bracket. + */ + public static function getClosingBracket(string $openingBracket): ?string + { + return self::PAIRS[$openingBracket] ?? null; + } + + /** + * Check if a closing bracket matches the most recent unclosed opening bracket. + * + * Tokenizes the code to respect strings and comments when tracking brackets. + */ + public static function doesClosingBracketMatch(string $closingChar, string $code): bool + { + if (!isset(self::CLOSING_TO_OPENING[$closingChar])) { + return false; + } + + $expectedOpening = self::CLOSING_TO_OPENING[$closingChar]; + + $tokens = \token_get_all('getCharBeforeCursor(); + $after = $buffer->getCharAfterCursor(); + + if ($before === null || $after === null) { + return false; + } + + // Only non-quote bracket pairs, not quotes like "" or '' + return \in_array($before, self::OPENING_BRACKETS) + && self::PAIRS[$before] === $after; + } + + /** + * Check whether a character is a quote. + */ + private static function isQuote(string $char): bool + { + return $char === '"' || $char === "'"; + } + + /** + * Check whether the grapheme cluster starts with an alphanumeric code point. + */ + private static function startsWithAlnum(string $char): bool + { + $firstCodePoint = \mb_substr($char, 0, 1); + + return $firstCodePoint !== '' && \ctype_alnum($firstCodePoint); + } + + /** + * Simple heuristic to detect if cursor is inside a string. + * + * Counts quotes before cursor - if odd, we're inside a string. + * Not perfect but works for most cases. + */ + private static function isInsideString(Buffer $buffer): bool + { + $beforeCursor = $buffer->getBeforeCursor(); + + $doubleQuotes = self::countUnescapedQuotes($beforeCursor, '"'); + $singleQuotes = self::countUnescapedQuotes($beforeCursor, "'"); + + return ($doubleQuotes % 2 === 1) || ($singleQuotes % 2 === 1); + } + + /** + * Count unescaped quotes in the string. + */ + private static function countUnescapedQuotes(string $text, string $quote): int + { + $count = 0; + $escaped = false; + + for ($i = 0; $i < \strlen($text); $i++) { + $char = $text[$i]; + + if ($escaped) { + $escaped = false; + continue; + } + + if ($char === '\\') { + $escaped = true; + continue; + } + + if ($char === $quote) { + $count++; + } + } + + return $count; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CommandHighlighter.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CommandHighlighter.php new file mode 100644 index 000000000..cf4fedd0b --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CommandHighlighter.php @@ -0,0 +1,382 @@ + */ + private array $commandMap = []; + + /** @var array> */ + private array $shortcutMapCache = []; + + /** + * {@inheritdoc} + */ + public function setCommands(array $commands): void + { + $this->commandMap = []; + + foreach ($commands as $command) { + $this->commandMap[$command->getName()] = $command; + + foreach ($command->getAliases() as $alias) { + $this->commandMap[$alias] = $command; + } + } + + $this->shortcutMapCache = []; + } + + /** + * Check whether the given name is a known command. + */ + public function hasCommand(string $name): bool + { + return isset($this->commandMap[$name]); + } + + /** + * Highlight a complete command string. + */ + public function highlight(string $text, OutputFormatterInterface $formatter): string + { + return \implode("\n", $this->highlightLines($text, $formatter)); + } + + /** + * Highlight a command string into ANSI-safe lines. + * + * @return string[] + */ + public function highlightLines(string $text, OutputFormatterInterface $formatter): array + { + if ($text === '') { + return ['']; + } + + if (!\preg_match('/^(\s*)(\S+)(.*)$/s', $text, $matches)) { + return [$text]; + } + + $lines = [$matches[1].$this->applyStyle($matches[2], self::STYLE_COMMAND, $formatter)]; + $command = $this->resolveCommand($matches[2]); + + if ($command === null) { + $this->appendText($lines, $matches[3]); + + return $lines; + } + + $definition = $command->getDefinition(); + $shortcuts = $this->getCachedShortcutMap($matches[2], $definition); + $arguments = \array_values($definition->getArguments()); + $argumentIndex = 0; + $expectingOptionValue = null; + $endOfOptions = false; + + foreach ($this->tokenize($matches[3]) as $segment) { + if ($segment['type'] === 'whitespace') { + $this->appendText($lines, $segment['text']); + continue; + } + + $token = $segment['text']; + + if ($expectingOptionValue instanceof InputOption) { + $this->appendText($lines, $this->highlightValue($token, $formatter)); + $expectingOptionValue = null; + continue; + } + + if (!$endOfOptions && $token === '--') { + $this->appendText($lines, $this->applyStyle($token, self::STYLE_OPTION, $formatter)); + $endOfOptions = true; + continue; + } + + if (!$endOfOptions) { + $longOption = $this->matchLongOption($token, $definition, $formatter); + if ($longOption !== null) { + $this->appendText($lines, $longOption['text']); + $expectingOptionValue = $longOption['nextExpectsValue']; + continue; + } + + $shortOption = $this->matchShortOption($token, $shortcuts, $formatter); + if ($shortOption !== null) { + $this->appendText($lines, $shortOption['text']); + $expectingOptionValue = $shortOption['nextExpectsValue']; + continue; + } + } + + $argument = $arguments[$argumentIndex] ?? null; + + if ($argument instanceof CodeArgument) { + $this->appendLines($lines, CodeFormatter::formatInputLines((string) \substr($matches[3], $segment['offset']), $formatter)); + + return $lines; + } + + $this->appendText($lines, $this->highlightValue($token, $formatter)); + + if ($argument instanceof InputArgument && !$argument->isArray()) { + $argumentIndex++; + } + } + + return $lines; + } + + private function resolveCommand(string $name): ?Command + { + return $this->commandMap[$name] ?? null; + } + + /** + * @return array + */ + private function getCachedShortcutMap(string $commandName, InputDefinition $definition): array + { + if (isset($this->shortcutMapCache[$commandName])) { + return $this->shortcutMapCache[$commandName]; + } + + $shortcuts = []; + + foreach ($definition->getOptions() as $option) { + if (!$option->getShortcut()) { + continue; + } + + foreach (\explode('|', $option->getShortcut()) as $shortcut) { + $shortcuts[$shortcut] = $option; + } + } + + return $this->shortcutMapCache[$commandName] = $shortcuts; + } + + /** + * @return array{text: string, nextExpectsValue: InputOption|null}|null + */ + private function matchLongOption(string $token, InputDefinition $definition, OutputFormatterInterface $formatter): ?array + { + if (!\preg_match('/^(--[A-Za-z0-9][A-Za-z0-9-]*)(?:=(.*))?$/s', $token, $matches)) { + return null; + } + + $name = \substr($matches[1], 2); + if (!$definition->hasOption($name)) { + return [ + 'text' => $this->applyStyle($token, self::STYLE_OPTION, $formatter), + 'nextExpectsValue' => null, + ]; + } + + $option = $definition->getOption($name); + $text = $this->applyStyle($matches[1], self::STYLE_OPTION, $formatter); + + if (\array_key_exists(2, $matches) && $matches[2] !== '') { + return [ + 'text' => $text.'='.$this->highlightValue($matches[2], $formatter), + 'nextExpectsValue' => null, + ]; + } + + return [ + 'text' => $text, + 'nextExpectsValue' => $option->isValueRequired() ? $option : null, + ]; + } + + /** + * @param array $shortcuts + * + * @return array{text: string, nextExpectsValue: InputOption|null}|null + */ + private function matchShortOption(string $token, array $shortcuts, OutputFormatterInterface $formatter): ?array + { + if (!\preg_match('/^-[^-].*$/', $token)) { + return null; + } + + $cluster = \substr($token, 1); + $consumed = ''; + + for ($i = 0, $length = \strlen($cluster); $i < $length; $i++) { + $shortcut = $cluster[$i]; + if (!isset($shortcuts[$shortcut])) { + return [ + 'text' => $this->applyStyle($token, self::STYLE_OPTION, $formatter), + 'nextExpectsValue' => null, + ]; + } + + $consumed .= $shortcut; + $option = $shortcuts[$shortcut]; + if (!$option->acceptValue()) { + continue; + } + + $optionText = '-'.$consumed; + $valueText = \substr($cluster, $i + 1); + + if ($valueText !== '') { + return [ + 'text' => $this->applyStyle($optionText, self::STYLE_OPTION, $formatter).$this->highlightValue($valueText, $formatter), + 'nextExpectsValue' => null, + ]; + } + + return [ + 'text' => $this->applyStyle($optionText, self::STYLE_OPTION, $formatter), + 'nextExpectsValue' => $option->isValueRequired() ? $option : null, + ]; + } + + return [ + 'text' => $this->applyStyle($token, self::STYLE_OPTION, $formatter), + 'nextExpectsValue' => null, + ]; + } + + private function highlightValue(string $token, OutputFormatterInterface $formatter): string + { + if (\preg_match('/^[+-]?\d+(?:\.\d+)?$/', $token)) { + return $this->applyStyle($token, CodeFormatter::HIGHLIGHT_NUMBER, $formatter); + } + + return $this->applyStyle($token, self::STYLE_ARGUMENT, $formatter); + } + + private function applyStyle(string $text, string $style, OutputFormatterInterface $formatter): string + { + if (!$formatter->isDecorated() || !$formatter->hasStyle($style)) { + return $text; + } + + return $formatter->getStyle($style)->apply($text); + } + + /** + * @return array + */ + private function tokenize(string $text): array + { + $tokens = []; + $length = \strlen($text); + $offset = 0; + + while ($offset < $length) { + $char = $text[$offset]; + + if (\ctype_space($char)) { + $start = $offset; + while ($offset < $length && \ctype_space($text[$offset])) { + $offset++; + } + + $tokens[] = [ + 'type' => 'whitespace', + 'text' => \substr($text, $start, $offset - $start), + 'offset' => $start, + ]; + + continue; + } + + $start = $offset; + $quote = null; + + while ($offset < $length) { + $char = $text[$offset]; + + if ($quote !== null) { + $offset++; + if ($char === $quote && ($offset < 2 || $text[$offset - 2] !== '\\')) { + $quote = null; + } + continue; + } + + if ($char === '"' || $char === "'") { + $quote = $char; + $offset++; + continue; + } + + if (\ctype_space($char)) { + break; + } + + $offset++; + } + + $tokens[] = [ + 'type' => 'token', + 'text' => \substr($text, $start, $offset - $start), + 'offset' => $start, + ]; + } + + return $tokens; + } + + /** + * @param string[] $lines + */ + private function appendText(array &$lines, string $text): void + { + $parts = \preg_split('/\r\n?|\n/', $text); + if ($parts === false || $parts === []) { + return; + } + + $lines[\count($lines) - 1] .= \array_shift($parts); + + foreach ($parts as $part) { + $lines[] = $part; + } + } + + /** + * @param string[] $lines + * @param string[] $extraLines + */ + private function appendLines(array &$lines, array $extraLines): void + { + if ($extraLines === []) { + return; + } + + $lines[\count($lines) - 1] .= \array_shift($extraLines); + \array_push($lines, ...$extraLines); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CompletionRenderer.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CompletionRenderer.php new file mode 100644 index 000000000..fee147b55 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CompletionRenderer.php @@ -0,0 +1,218 @@ +terminal = $terminal; + } + + /** + * Render completion items in a compact columnar menu. + * + * @param string[] $items Completion matches + * @param int $selectedIndex Index of selected item (-1 for none) + * @param int|null $maxRows Maximum visible rows (null for unlimited) + * @param int $scrollOffset First visible row index + * + * @return string[] The rendered lines + */ + public function render( + array $items, + int $selectedIndex = -1, + ?int $maxRows = null, + int $scrollOffset = 0, + bool $compact = true + ): array { + if (empty($items)) { + return [$this->terminal->format( + ' (no matches)', + )]; + } + + $items = \array_map([History::class, 'collapseToSingleLine'], \array_values($items)); + $layout = $this->doCalculateLayout($items); + $totalRows = $layout['rows']; + $columns = $layout['columns']; + $columnWidths = $layout['columnWidths']; + $count = \count($items); + + // Determine visible row range + $needsTruncation = $maxRows !== null && $totalRows > $maxRows + 1; + $startRow = $needsTruncation ? $scrollOffset : 0; + $endRow = $needsTruncation + ? \min($totalRows, $startRow + $maxRows) + : $totalRows; + + $lines = []; + $hasSelection = $selectedIndex >= 0; + + $formatter = $this->terminal->getFormatter(); + $highlightStyle = $formatter->isDecorated() && $formatter->hasStyle('input_highlight') ? $formatter->getStyle('input_highlight') : null; + + for ($row = $startRow; $row < $endRow; $row++) { + $line = ' '; + for ($col = 0; $col < $columns; $col++) { + $index = $row + $col * $totalRows; + if ($index < $count) { + $colWidth = $columnWidths[$col]; + $item = DisplayString::truncate($items[$index], $colWidth, true); + $itemWidth = DisplayString::width($item); + $padding = \max(0, $colWidth - $itemWidth); + + if ($hasSelection && $index === $selectedIndex) { + $highlighted = $item.\str_repeat(' ', $padding); + $line .= $highlightStyle ? $highlightStyle->apply($highlighted) : $highlighted; + } else { + $line .= $item.\str_repeat(' ', $padding); + } + + if ($col < $columns - 1) { + $line .= ' '; + } + } + } + $lines[] = $line; + } + + if ($needsTruncation) { + $lines[] = $this->renderStatusLine( + $startRow, + $endRow, + $totalRows, + $compact, + ); + } + + return $lines; + } + + /** + * Calculate the column layout for a set of items. + * + * @param string[] $items Completion matches + * + * @return array{rows: int, columns: int, columnWidths: int[]} + */ + public function calculateLayout(array $items): array + { + return $this->doCalculateLayout(\array_map([History::class, 'collapseToSingleLine'], $items)); + } + + /** + * @param string[] $items Display-ready (single-line) items + * + * @return array{rows: int, columns: int, columnWidths: int[]} + */ + private function doCalculateLayout(array $items): array + { + $widths = \array_map([DisplayString::class, 'width'], $items); + $count = \count($items); + $maxWidth = $this->terminal->getWidth(); + + // Start with a naive guess based on the widest item + $columns = \max(1, \intdiv($maxWidth, \max($widths) + 2)); + $columnWidths = $this->calculateColumnWidths($widths, $count, $columns); + $maxColumns = \min($count, $columns + 5); + + // Check up to five more columns, to see if there's a more optimal + // layout after wrapping. + for ($try = $columns + 1; $try <= $maxColumns; $try++) { + $candidate = $this->calculateColumnWidths($widths, $count, $try); + if (\array_sum($candidate) + ($try - 1) * 2 + 3 <= $maxWidth) { + $columns = $try; + $columnWidths = $candidate; + } + } + + // Cap single-column width so wide items don't soft-wrap. + // Multi-column layouts are already validated by the loop above. + if ($columns === 1) { + $columnWidths[0] = \min($columnWidths[0], $maxWidth - 3); + } + + return [ + 'rows' => $this->calculateRowCount($count, $columns), + 'columns' => $columns, + 'columnWidths' => $columnWidths, + ]; + } + + /** + * Render the status line for truncated menus. + */ + private function renderStatusLine( + int $startRow, + int $endRow, + int $totalRows, + bool $compact + ): string { + if ($compact && $startRow === 0) { + $remaining = $totalRows - $endRow; + $text = \sprintf('…and %d more rows', $remaining); + } else { + $text = \sprintf( + 'rows %d to %d of %d', + $startRow + 1, + $endRow, + $totalRows, + ); + } + + return $this->terminal->format(' '.$text.''); + } + + /** + * Calculate per-column widths for a given column count. + * + * @param int[] $widths Pre-computed item widths + * @param int $count Total item count + * @param int $columns Number of columns + * + * @return int[] Width of each column + */ + private function calculateColumnWidths( + array $widths, + int $count, + int $columns + ): array { + $rows = $this->calculateRowCount($count, $columns); + $columnWidths = \array_fill(0, $columns, 0); + for ($i = 0; $i < $count; $i++) { + $col = \intdiv($i, $rows); + $columnWidths[$col] = \max($columnWidths[$col], $widths[$i]); + } + + return $columnWidths; + } + + /** + * Calculate the number of rows needed for a column-first layout. + */ + private function calculateRowCount(int $itemCount, int $columns): int + { + return \intdiv($itemCount + $columns - 1, $columns); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CurrentWord.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CurrentWord.php new file mode 100644 index 000000000..5685a9c75 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/CurrentWord.php @@ -0,0 +1,52 @@ +', and '::'. + */ + public static function extract(string $line, int $position): string + { + $length = \mb_strlen($line); + $position = \max(0, \min($position, $length)); + + if ($position === 0 || $line === '') { + return ''; + } + + $start = $position; + while ($start > 0) { + $char = \mb_substr($line, $start - 1, 1); + if ($char === '' || \ctype_space($char) || $char === '$') { + break; + } + + if ($start >= 2) { + $prev = \mb_substr($line, $start - 2, 1); + if (($prev === '-' && $char === '>') || ($prev === ':' && $char === ':')) { + break; + } + } + + $start--; + } + + return \mb_substr($line, $start, $position - $start); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/DebugLog.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/DebugLog.php new file mode 100644 index 000000000..fcaac05ed --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/DebugLog.php @@ -0,0 +1,158 @@ + $value) { + if (\is_string($value)) { + $parts[] = "{$key}=\"".self::escapeValue($value).'"'; + } elseif (\is_bool($value)) { + $parts[] = "{$key}=".($value ? 'true' : 'false'); + } elseif ($value === null) { + $parts[] = "{$key}=null"; + } else { + $parts[] = "{$key}={$value}"; + } + } + $contextStr = ' ('.\implode(', ', $parts).')'; + } else { + $contextStr = ' ('.self::escapeValue((string) $context).')'; + } + } + + self::writeLine("{$category}: {$message}{$contextStr}"); + } + + /** + * Log a separator for readability. + */ + public static function separator(string $label = ''): void + { + if (!self::$enabled) { + return; + } + + $sep = \str_repeat('-', 60); + self::writeLine($label ? "{$sep} {$label} {$sep}" : $sep); + } + + /** + * Write a timestamped line to the log file. + */ + private static function writeLine(string $content): void + { + if (self::$handle !== null && \is_resource(self::$handle)) { + $timestamp = \date('H:i:s'); + \fwrite(self::$handle, "[{$timestamp}] {$content}\n"); + \fflush(self::$handle); + } + } + + /** + * Escape non-printable bytes for safe debug output. + */ + private static function escapeValue(string $value): string + { + $escaped = \addcslashes($value, "\0..\37\177..\377\\\""); + + if (\strlen($escaped) > 200) { + return \substr($escaped, 0, 200).'...'; + } + + return $escaped; + } + + /** + * Get the log file path. + */ + public static function getLogPath(): string + { + return self::$logPath; + } + + /** + * Check if debug logging is enabled. + */ + public static function isEnabled(): bool + { + return self::$enabled; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/HistorySearchRenderer.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/HistorySearchRenderer.php new file mode 100644 index 000000000..e37c239e8 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/HistorySearchRenderer.php @@ -0,0 +1,127 @@ +terminal = $terminal; + $this->prefix = $prefix; + } + + /** + * Set the search query for highlighting matches. + */ + public function setQuery(string $query): void + { + $this->query = $query; + } + + /** + * Render history search items in a single-column list. + * + * @param string[] $items History matches (newest first) + * @param int $selectedIndex Index of selected item (-1 for none) + * @param int|null $maxRows Maximum visible rows (null for unlimited) + * @param int $scrollOffset First visible row index + * @param int $totalCount Total match count for status line + * + * @return string[] The rendered lines + */ + public function render( + array $items, + int $selectedIndex = 0, + ?int $maxRows = null, + int $scrollOffset = 0, + int $totalCount = 0 + ): array { + if (empty($items)) { + return [$this->terminal->format(' (no matches)')]; + } + + $items = \array_map([History::class, 'collapseToSingleLine'], \array_values($items)); + $prefixWidth = DisplayString::width($this->prefix); + $indent = \str_repeat(' ', $prefixWidth); + $maxWidth = \max(1, $this->terminal->getWidth() - $prefixWidth); + $totalRows = \count($items); + + $needsTruncation = $maxRows !== null && $totalRows > $maxRows + 1; + $startRow = $needsTruncation ? $scrollOffset : 0; + $endRow = $needsTruncation + ? \min($totalRows, $startRow + $maxRows) + : $totalRows; + + $lines = []; + + for ($row = $startRow; $row < $endRow; $row++) { + $item = DisplayString::truncate($items[$row], $maxWidth, true); + + if ($row === $selectedIndex) { + $escaped = OutputFormatter::escape($item); + $itemWidth = DisplayString::width($item); + $padding = \max(0, $maxWidth - $itemWidth); + $lines[] = $this->terminal->format( + ''.$this->prefix.$escaped.\str_repeat(' ', $padding).'', + ); + } else { + $lines[] = $indent.$this->highlightQuery($item); + } + } + + if ($needsTruncation) { + $text = \sprintf('Items %d to %d of %d', $startRow + 1, $endRow, $totalCount > 0 ? $totalCount : $totalRows); + $lines[] = $this->terminal->format($indent.''.$text.''); + } + + return $lines; + } + + /** + * Highlight the first occurrence of the search query in an item. + */ + private function highlightQuery(string $item): string + { + if ($this->query === '') { + return $item; + } + + $caseSensitive = History::isSearchCaseSensitive($this->query); + $pos = $caseSensitive + ? \mb_strpos($item, $this->query) + : \mb_stripos($item, $this->query); + + if ($pos === false) { + return $item; + } + + $before = \mb_substr($item, 0, $pos); + $match = \mb_substr($item, $pos, \mb_strlen($this->query)); + $after = \mb_substr($item, $pos + \mb_strlen($this->query)); + + return $before.$this->terminal->format(''.OutputFormatter::escape($match).'').$after; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Helper/TokenHelper.php b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/TokenHelper.php new file mode 100644 index 000000000..b05a1066d --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Helper/TokenHelper.php @@ -0,0 +1,63 @@ +', ',']; + + /** + * Check whether the last non-whitespace token is a trailing operator. + * + * Used to determine whether a statement continues onto the next line. + * + * @param array $tokens token_get_all tokens + */ + public static function hasTrailingOperator(array $tokens): bool + { + if (empty($tokens)) { + return false; + } + + $lastToken = null; + for ($i = \count($tokens) - 1; $i >= 0; $i--) { + $token = $tokens[$i]; + if (\is_array($token) && $token[0] === \T_WHITESPACE) { + continue; + } + + $lastToken = $token; + break; + } + + if ($lastToken === null) { + return false; + } + + if (\is_array($lastToken)) { + return \in_array($lastToken[0], self::TRAILING_TOKEN_OPS, true); + } + + return \in_array($lastToken, self::TRAILING_CHAR_OPS, true); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/HistorySearch.php b/app/vendor/psy/psysh/src/Readline/Interactive/HistorySearch.php new file mode 100644 index 000000000..6f7d8388e --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/HistorySearch.php @@ -0,0 +1,433 @@ +terminal = $terminal; + $this->history = $history; + $this->frameRenderer = $frameRenderer; + $this->overlayViewport = $overlayViewport; + $this->theme = $theme; + } + + /** + * Set the theme. + */ + public function setTheme(Theme $theme): void + { + $this->theme = $theme; + $this->renderer = null; + } + + /** + * Check if search mode is active. + */ + public function isActive(): bool + { + return $this->active; + } + + /** + * Enter search mode with an optional initial query. + */ + public function enter(string $query = ''): void + { + $this->active = true; + $this->updateQuery($query); + } + + /** + * Exit search mode and clear state. + */ + public function exit(): void + { + $this->active = false; + $this->resetState(); + $this->savedBufferText = null; + $this->savedCursorPosition = 0; + $this->frameRenderer->setOverlayLines([]); + } + + /** + * Save the current buffer before starting search. + */ + public function saveBuffer(Buffer $buffer): void + { + $this->savedBufferText = $buffer->getText(); + $this->savedCursorPosition = $buffer->getCursor(); + } + + /** + * Handle input while in search mode. + * + * @return bool|null True to stay in search, false if exited (key consumed), null if exited (replay key) + */ + public function handleInput(Key $key, Buffer $buffer) + { + $value = $key->getValue(); + $keyStr = (string) $key; + + if ($value === "\x07" || $value === "\x1b") { // Ctrl-G or Escape + $this->cancelSearch($buffer); + + return false; + } elseif ($value === "\r" || $value === "\n") { + $this->acceptMatch($buffer); + + return false; + } elseif ($keyStr === 'escape:[C' || $value === "\x06") { // Right or Ctrl-F: accept, cursor at end + $this->acceptMatch($buffer); + + return false; + } elseif ($keyStr === 'escape:[D' || $value === "\x02") { // Left or Ctrl-B: accept, cursor at start + $this->acceptMatch($buffer); + $buffer->setCursor(0); + + return false; + } elseif ($keyStr === 'escape:[A' || $value === "\x10" || $value === "\x13") { // Up, Ctrl-P, or Ctrl-S + $this->moveSelection(-1); + + return true; + } elseif ($keyStr === 'escape:[B' || $value === "\x0e" || $value === "\x12") { // Down, Ctrl-N, or Ctrl-R + $this->moveSelection(1); + + return true; + } elseif ($value === "\x17") { // Ctrl-W: delete last word + $this->removeWord(); + + return true; + } elseif ($value === "\x08" || $value === "\x7f") { // Backspace + $this->removeChar(); + + return true; + } elseif ($key->isChar() && !$key->isControl()) { + $this->addChar($value); + + return true; + } else { + $this->acceptMatch($buffer); + + return null; + } + } + + /** + * Render the search UI with overlay. + */ + public function display(): void + { + $preview = $this->getSelectedMatch() ?? ''; + $searchPrompt = $this->terminal->format('search:').' '.$this->searchQuery; + + $this->updateOverlay(); + $this->frameRenderer->renderSearchFrame($preview, $searchPrompt); + } + + /** + * Get the search query. + */ + public function getQuery(): string + { + return $this->searchQuery; + } + + /** + * Get the number of search matches. + */ + public function getMatchCount(): int + { + return \count($this->searchMatches); + } + + /** + * Get the search selection index. + */ + public function getSelectedIndex(): int + { + return $this->currentMatchIndex; + } + + /** + * Get the current search match. + * + * @return string|null The current match, or null if no match + */ + public function getSelectedMatch(): ?string + { + if (empty($this->searchMatches) || $this->currentMatchIndex < 0) { + return null; + } + + return $this->searchMatches[$this->currentMatchIndex] ?? null; + } + + /** + * Find next match in search results (older entries). + */ + public function findNext(): void + { + $this->moveSelection(1); + } + + /** + * Find previous match in search results (newer entries). + */ + public function findPrevious(): void + { + $this->moveSelection(-1); + } + + /** + * Update search query and find matches. + */ + public function updateQuery(string $query): void + { + $this->searchQuery = $query; + + $this->searchMatches = $this->history->search($query); + $this->currentMatchIndex = empty($this->searchMatches) ? -1 : 0; + $this->searchScrollOffset = 0; + $this->searchExpanded = false; + } + + /** + * Add a character to the search query. + */ + private function addChar(string $char): void + { + $this->updateQuery($this->searchQuery.$char); + } + + /** + * Remove last character from search query. + */ + private function removeChar(): void + { + if ($this->searchQuery !== '') { + $this->updateQuery(\mb_substr($this->searchQuery, 0, -1)); + } + } + + /** + * Remove last word from search query. + */ + private function removeWord(): void + { + if ($this->searchQuery === '') { + return; + } + + $policy = new WordNavigationPolicy(); + $boundary = $policy->findPreviousWord($this->searchQuery, \mb_strlen($this->searchQuery)); + $this->updateQuery(\mb_substr($this->searchQuery, 0, $boundary)); + } + + /** + * Reset search query and match state. + */ + private function resetState(): void + { + $this->searchQuery = ''; + $this->searchMatches = []; + $this->currentMatchIndex = -1; + $this->searchScrollOffset = 0; + $this->searchExpanded = false; + } + + /** + * Move search selection up or down, adjusting viewport as needed. + */ + private function moveSelection(int $delta): void + { + $count = \count($this->searchMatches); + if ($count === 0) { + $this->terminal->bell(); + + return; + } + + $newIndex = $this->currentMatchIndex + $delta; + + if ($newIndex < 0) { + $newIndex = $count - 1; + $this->terminal->bell(); + } elseif ($newIndex >= $count) { + $newIndex = 0; + $this->terminal->bell(); + } + + $this->currentMatchIndex = $newIndex; + $this->adjustViewport(); + } + + /** + * Accept current search match and exit search mode. + */ + private function acceptMatch(Buffer $buffer): void + { + $match = $this->getSelectedMatch(); + if ($match !== null) { + $buffer->clear(); + $buffer->insert($match); + } + + $this->exit(); + } + + /** + * Cancel search and restore original buffer. + */ + private function cancelSearch(Buffer $buffer): void + { + if ($this->savedBufferText !== null) { + $buffer->clear(); + $buffer->insert($this->savedBufferText); + $buffer->setCursor($this->savedCursorPosition); + } + + $this->exit(); + } + + /** + * Build and set overlay lines for the current search results. + */ + private function updateOverlay(): void + { + if (empty($this->searchMatches)) { + if ($this->searchQuery !== '') { + $noMatch = $this->terminal->format(' (no matches)'); + $this->frameRenderer->setOverlayLines([$noMatch]); + } else { + $this->frameRenderer->setOverlayLines([]); + } + + return; + } + + if ($this->renderer === null) { + $this->renderer = new HistorySearchRenderer($this->terminal, $this->theme->replayPrompt()); + } + $this->renderer->setQuery($this->searchQuery); + $maxRows = $this->getMaxRows(); + $lines = $this->renderer->render( + $this->searchMatches, + $this->currentMatchIndex, + $maxRows, + $this->searchScrollOffset, + \count($this->searchMatches), + ); + + $this->frameRenderer->setOverlayLines($lines); + } + + /** + * Get the maximum visible rows for search results. + * + * Returns null if all rows fit without truncation. + */ + private function getMaxRows(): ?int + { + $available = $this->overlayViewport->getAvailableRows(!$this->searchExpanded); + + // OverlayViewport already accounts for input frame + search prompt rows. + $menuBudget = \max(1, $available); + $totalRows = \count($this->searchMatches); + + if ($totalRows <= $menuBudget) { + return null; + } + + // Reserve one row for the status line + return \max(1, $menuBudget - 1); + } + + /** + * Adjust search scroll offset so the selected item is visible. + */ + private function adjustViewport(): void + { + $maxRows = $this->getMaxRows(); + + if ($maxRows === null) { + $this->searchScrollOffset = 0; + + return; + } + + $selected = $this->currentMatchIndex; + + // Scrolled past the top: snap to selection + if ($selected < $this->searchScrollOffset) { + $this->searchScrollOffset = $selected; + } + + // Scrolled past the bottom: try expanding the viewport first + if ($selected >= $this->searchScrollOffset + $maxRows && !$this->searchExpanded) { + $this->searchExpanded = true; + $maxRows = $this->getMaxRows(); + + if ($maxRows === null) { + $this->searchScrollOffset = 0; + + return; + } + } + + // Still past the bottom after expanding: scroll down + if ($selected >= $this->searchScrollOffset + $maxRows) { + $this->searchScrollOffset = $selected - $maxRows + 1; + } + + $count = \count($this->searchMatches); + $this->searchScrollOffset = \max(0, \min($this->searchScrollOffset, $count - $maxRows)); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/Buffer.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/Buffer.php new file mode 100644 index 000000000..a604ef976 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/Buffer.php @@ -0,0 +1,883 @@ +|null */ + private ?array $graphemeBoundaryMap = null; + + public function __construct(bool $requireSemicolons = false) + { + $this->requireSemicolons = $requireSemicolons; + $this->bufferAnalyzer = new BufferAnalyzer(); + $this->statementCompletenessPolicy = new StatementCompletenessPolicy( + $this->bufferAnalyzer, + $this->requireSemicolons + ); + $this->indentationPolicy = new IndentationPolicy(); + $this->tokenNavigationPolicy = new TokenNavigationPolicy(); + $this->wordNavigationPolicy = new WordNavigationPolicy(); + $this->visualNavigationPolicy = new VisualNavigationPolicy(); + } + + /** + * Get the buffer text. + */ + public function getText(): string + { + return $this->text; + } + + /** + * Set the buffer text and move cursor to end. + */ + public function setText(string $text): void + { + $this->text = $text; + $this->cursor = \mb_strlen($text); + $this->invalidateCaches(); + } + + /** + * Clear the buffer. + */ + public function clear(): void + { + $this->text = ''; + $this->cursor = 0; + $this->invalidateCaches(); + } + + /** + * Get the cursor position. + */ + public function getCursor(): int + { + return $this->cursor; + } + + /** + * Set the cursor position. + */ + public function setCursor(int $position): void + { + $this->cursor = \max(0, \min($position, \mb_strlen($this->text))); + } + + /** + * Get the length of the text in characters. + */ + public function getLength(): int + { + return \mb_strlen($this->text); + } + + /** + * Insert text at the cursor position. + */ + public function insert(string $text): void + { + $before = \mb_substr($this->text, 0, $this->cursor); + $after = \mb_substr($this->text, $this->cursor); + $this->text = $before.$text.$after; + $this->cursor += \mb_strlen($text); + $this->invalidateCaches(); + } + + /** + * Auto-dedent if typing a closing bracket at start of line. + * + * If the line currently starts with auto-inserted whitespace and + * we're about to insert a closing bracket, remove one indent level. + * + * @param string $char The character being typed + * @param string $context Optional accumulated code context for bracket matching + */ + public function autoDedentIfClosingBracket(string $char, string $context = ''): void + { + $spacesToRemove = $this->indentationPolicy->calculateClosingBracketDedent( + $char, $this->text, $this->cursor, $context + ); + + if ($spacesToRemove > 0) { + $lines = \explode("\n", $this->text); + $currentLineNum = $this->getCurrentLineNumber(); + $lines[$currentLineNum] = \substr($lines[$currentLineNum], $spacesToRemove); + $this->text = \implode("\n", $lines); + $this->cursor -= $spacesToRemove; + $this->invalidateCaches(); + } + } + + /** + * Delete grapheme clusters backward from cursor. + * + * @return bool True if characters were deleted + */ + public function deleteBackward(int $count = 1): bool + { + if ($this->cursor === 0 || $count <= 0) { + return false; + } + + $span = $this->graphemeClusterSpanReverse($count); + + $before = \mb_substr($this->text, 0, $this->cursor - $span); + $after = \mb_substr($this->text, $this->cursor); + + $this->text = $before.$after; + $this->cursor -= $span; + $this->invalidateCaches(); + + return true; + } + + /** + * Delete grapheme clusters forward from cursor. + * + * @return bool True if characters were deleted + */ + public function deleteForward(int $count = 1): bool + { + if ($this->cursor >= \mb_strlen($this->text) || $count <= 0) { + return false; + } + + $span = $this->graphemeClusterSpanForward($count); + + $before = \mb_substr($this->text, 0, $this->cursor); + $after = \mb_substr($this->text, $this->cursor + $span); + + $this->text = $before.$after; + $this->invalidateCaches(); + + return true; + } + + /** + * Delete from cursor to end of line. + * + * @return string The deleted text + */ + public function deleteToEnd(): string + { + $nextNewline = \mb_strpos($this->text, "\n", $this->cursor); + $end = $nextNewline === false ? \mb_strlen($this->text) : $nextNewline; + + $killed = \mb_substr($this->text, $this->cursor, $end - $this->cursor); + $this->text = \mb_substr($this->text, 0, $this->cursor).\mb_substr($this->text, $end); + $this->invalidateCaches(); + + return $killed; + } + + /** + * Delete from start of line to cursor. + * + * @return string The deleted text + */ + public function deleteToStart(): string + { + $beforeCursor = \mb_substr($this->text, 0, $this->cursor); + $lastNewline = \mb_strrpos($beforeCursor, "\n"); + $start = $lastNewline === false ? 0 : $lastNewline + 1; + + $killed = \mb_substr($this->text, $start, $this->cursor - $start); + $this->text = \mb_substr($this->text, 0, $start).\mb_substr($this->text, $this->cursor); + $this->cursor = $start; + $this->invalidateCaches(); + + return $killed; + } + + /** + * Move cursor left by specified number of grapheme clusters. + * + * @return int Number of code points actually moved + */ + public function moveCursorLeft(int $count = 1): int + { + $oldCursor = $this->cursor; + $span = $this->graphemeClusterSpanReverse($count); + $this->cursor = \max(0, $this->cursor - $span); + + return $oldCursor - $this->cursor; + } + + /** + * Move cursor right by specified number of grapheme clusters. + * + * @return int Number of code points actually moved + */ + public function moveCursorRight(int $count = 1): int + { + $oldCursor = $this->cursor; + $span = $this->graphemeClusterSpanForward($count); + $this->cursor = \min(\mb_strlen($this->text), $this->cursor + $span); + + return $this->cursor - $oldCursor; + } + + /** + * Get the grapheme cluster before the cursor. + * + * @return string|null The grapheme cluster, or null if at start + */ + public function getCharBeforeCursor(): ?string + { + if ($this->cursor === 0) { + return null; + } + + $span = $this->graphemeClusterSpanReverse(1); + + return \mb_substr($this->text, $this->cursor - $span, $span); + } + + /** + * Get the grapheme cluster after the cursor. + * + * @return string|null The grapheme cluster, or null if at end + */ + public function getCharAfterCursor(): ?string + { + if ($this->cursor >= \mb_strlen($this->text)) { + return null; + } + + $span = $this->graphemeClusterSpanForward(1); + + return \mb_substr($this->text, $this->cursor, $span); + } + + /** + * Move cursor to start of line. + */ + public function moveCursorToStart(): void + { + $this->cursor = 0; + } + + /** + * Move cursor to end of line. + */ + public function moveCursorToEnd(): void + { + $this->cursor = \mb_strlen($this->text); + } + + /** + * Move cursor to start of current line (for multi-line buffers). + */ + public function moveCursorToStartOfCurrentLine(): void + { + $beforeCursor = \mb_substr($this->text, 0, $this->cursor); + $lastNewline = \mb_strrpos($beforeCursor, "\n"); + $this->cursor = $lastNewline === false ? 0 : $lastNewline + 1; + } + + /** + * Move cursor to end of current line (for multi-line buffers). + */ + public function moveCursorToEndOfCurrentLine(): void + { + $nextNewline = \mb_strpos($this->text, "\n", $this->cursor); + $this->cursor = $nextNewline === false ? \mb_strlen($this->text) : $nextNewline; + } + + /** + * Get the current line number (0-indexed) based on cursor position. + */ + public function getCurrentLineNumber(): int + { + return \substr_count(\mb_substr($this->text, 0, $this->cursor), "\n"); + } + + /** + * Get the text of the current line (where cursor is). + */ + public function getCurrentLineText(): string + { + $lines = \explode("\n", $this->text); + $lineNumber = $this->getCurrentLineNumber(); + + return $lines[$lineNumber] ?? ''; + } + + /** + * Get the cursor position within the current line (0-indexed). + */ + public function getCursorPositionInLine(): int + { + $lineNumber = $this->getCurrentLineNumber(); + + $lines = \explode("\n", $this->text); + $charsBeforeLine = 0; + for ($i = 0; $i < $lineNumber; $i++) { + $charsBeforeLine += \mb_strlen($lines[$i]) + 1; + } + + return $this->cursor - $charsBeforeLine; + } + + /** + * Get the total number of lines in the buffer. + */ + public function getLineCount(): int + { + return \substr_count($this->text, "\n") + 1; + } + + /** + * Check if the cursor is on the first line. + */ + public function isOnFirstLine(): bool + { + return $this->getCurrentLineNumber() === 0; + } + + /** + * Check if the cursor is on the last line. + */ + public function isOnLastLine(): bool + { + return $this->getCurrentLineNumber() === $this->getLineCount() - 1; + } + + /** + * Move cursor to the previous line, maintaining column position if possible. + * + * @return bool True if moved, false if already on first line + */ + public function moveToPreviousLine(): bool + { + if ($this->isOnFirstLine()) { + return false; + } + + $beforeCursor = \mb_substr($this->text, 0, $this->cursor); + $lastNewline = \mb_strrpos($beforeCursor, "\n"); + + if ($lastNewline === false) { + return false; + } + + $currentColumn = $this->cursor - $lastNewline - 1; + + $beforeCurrentLine = \mb_substr($this->text, 0, $lastNewline); + $prevLineStart = \mb_strrpos($beforeCurrentLine, "\n"); + $prevLineStart = $prevLineStart === false ? 0 : $prevLineStart + 1; + + $prevLineLength = $lastNewline - $prevLineStart; + + $this->cursor = $prevLineStart + \min($currentColumn, $prevLineLength); + + return true; + } + + /** + * Move cursor to the previous soft-wrapped visual row on the current line. + * + * @param int $terminalWidth Number of terminal columns + * @param int $promptWidth Display width of the active prompt + * + * @return bool True if moved, false if already on first visual row + */ + public function moveToPreviousVisualRow(int $terminalWidth, int $promptWidth): bool + { + return $this->moveVisualRows(-1, $terminalWidth, $promptWidth); + } + + /** + * Move cursor to the next soft-wrapped visual row on the current line. + * + * @param int $terminalWidth Number of terminal columns + * @param int $promptWidth Display width of the active prompt + * + * @return bool True if moved, false if already on last visual row + */ + public function moveToNextVisualRow(int $terminalWidth, int $promptWidth): bool + { + return $this->moveVisualRows(1, $terminalWidth, $promptWidth); + } + + /** + * Move cursor by soft-wrapped visual rows. + */ + private function moveVisualRows(int $deltaRows, int $terminalWidth, int $promptWidth): bool + { + $target = $this->visualNavigationPolicy->moveByRows( + $this->text, + $this->cursor, + $deltaRows, + $terminalWidth, + $promptWidth + ); + + if ($target === null) { + return false; + } + + $this->cursor = $target; + + return true; + } + + /** + * Move cursor to the next line, maintaining column position if possible. + * + * @return bool True if moved, false if already on last line + */ + public function moveToNextLine(): bool + { + if ($this->isOnLastLine()) { + return false; + } + + $beforeCursor = \mb_substr($this->text, 0, $this->cursor); + $lastNewline = \mb_strrpos($beforeCursor, "\n"); + $currentLineStart = $lastNewline === false ? 0 : $lastNewline + 1; + + $currentColumn = $this->cursor - $currentLineStart; + + $nextNewline = \mb_strpos($this->text, "\n", $this->cursor); + + if ($nextNewline === false) { + return false; + } + + $nextLineStart = $nextNewline + 1; + + $lineAfterNext = \mb_strpos($this->text, "\n", $nextLineStart); + $nextLineEnd = $lineAfterNext === false ? \mb_strlen($this->text) : $lineAfterNext; + + $nextLineLength = $nextLineEnd - $nextLineStart; + + $this->cursor = $nextLineStart + \min($currentColumn, $nextLineLength); + + return true; + } + + /** + * Get text before cursor. + */ + public function getBeforeCursor(): string + { + return \mb_substr($this->text, 0, $this->cursor); + } + + /** + * Get text after cursor. + */ + public function getAfterCursor(): string + { + return \mb_substr($this->text, $this->cursor); + } + + /** + * Find the position of the start of the previous word. + */ + public function findPreviousWord(): int + { + return $this->wordNavigationPolicy->findPreviousWord($this->text, $this->cursor); + } + + /** + * Find the position of the start of the next word. + */ + public function findNextWord(): int + { + return $this->wordNavigationPolicy->findNextWord($this->text, $this->cursor); + } + + /** + * Delete previous word (from cursor backwards). + * + * @return string The deleted text + */ + public function deletePreviousWord(): string + { + return $this->deleteBackwardTo(fn () => $this->findPreviousWord()); + } + + /** + * Delete next word (from cursor forwards). + * + * @return string The deleted text + */ + public function deleteNextWord(): string + { + return $this->deleteForwardTo($this->findNextWord()); + } + + /** + * Check if the buffer is empty. + */ + public function isEmpty(): bool + { + return $this->text === ''; + } + + /** + * Get the code-point span of N grapheme clusters forward from cursor. + * + * Uses PCRE \X to match extended grapheme clusters (Unicode TR#29). + */ + private function graphemeClusterSpanForward(int $count): int + { + if ($count <= 0) { + return 0; + } + + if ($this->initializeGraphemeCache() && $this->graphemeBoundaries !== null && isset($this->graphemeBoundaryMap[$this->cursor])) { + $startIndex = $this->graphemeBoundaryMap[$this->cursor]; + $targetIndex = \min($startIndex + $count, \count($this->graphemeBoundaries) - 1); + + return $this->graphemeBoundaries[$targetIndex] - $this->cursor; + } + + return $this->graphemeClusterSpan(\mb_substr($this->text, $this->cursor), $count, false); + } + + /** + * Get the code-point span of N grapheme clusters backward from cursor. + */ + private function graphemeClusterSpanReverse(int $count): int + { + if ($count <= 0) { + return 0; + } + + if ($this->initializeGraphemeCache() && $this->graphemeBoundaries !== null && isset($this->graphemeBoundaryMap[$this->cursor])) { + $startIndex = $this->graphemeBoundaryMap[$this->cursor]; + $targetIndex = \max(0, $startIndex - $count); + + return $this->cursor - $this->graphemeBoundaries[$targetIndex]; + } + + return $this->graphemeClusterSpan(\mb_substr($this->text, 0, $this->cursor), $count, true); + } + + /** + * Build grapheme boundaries for current text. + */ + private function initializeGraphemeCache(): bool + { + if ($this->graphemeCacheInitialized) { + return $this->graphemeBoundaries !== null; + } + + $this->graphemeCacheInitialized = true; + + if ($this->text === '') { + $this->graphemeBoundaries = [0]; + $this->graphemeBoundaryMap = [0 => 0]; + + return true; + } + + if (\preg_match_all('/\X/u', $this->text, $matches) === false || empty($matches[0])) { + $this->graphemeBoundaries = null; + $this->graphemeBoundaryMap = null; + + return false; + } + + $boundaries = [0]; + $boundaryMap = [0 => 0]; + $offset = 0; + $index = 0; + + foreach ($matches[0] as $cluster) { + $offset += \mb_strlen($cluster); + $boundaries[] = $offset; + $boundaryMap[$offset] = ++$index; + } + + $this->graphemeBoundaries = $boundaries; + $this->graphemeBoundaryMap = $boundaryMap; + + return true; + } + + /** + * Get the code-point span of N grapheme clusters from one end of a string. + * + * @param string $text The text to measure + * @param int $count Number of grapheme clusters + * @param bool $fromEnd Take clusters from the end rather than the start + */ + private function graphemeClusterSpan(string $text, int $count, bool $fromEnd): int + { + if ($count <= 0 || $text === '') { + return 0; + } + + // Fall back to code-point count if regex fails (e.g. invalid UTF-8) + if (\preg_match_all('/\X/u', $text, $matches) === false || empty($matches[0])) { + return \min($count, \mb_strlen($text)); + } + + $offset = $fromEnd ? -$count : 0; + $clusters = \array_slice($matches[0], $offset, $count); + + return \array_sum(\array_map('mb_strlen', $clusters)); + } + + /** + * Delete backward from cursor to a target position, including bracket pairs when applicable. + * + * @param callable $findTarget Returns the target position when called with current cursor state + * + * @return string The deleted text + */ + private function deleteBackwardTo(callable $findTarget): string + { + if (BracketPair::isInsideEmptyBrackets($this)) { + // Include the bracket pair in the deletion + $savedCursor = $this->cursor; + $this->cursor--; + $targetStart = $findTarget(); + $this->cursor = $savedCursor; + + $killed = \mb_substr($this->text, $targetStart, $this->cursor - $targetStart + 1); + $before = \mb_substr($this->text, 0, $targetStart); + $after = \mb_substr($this->text, $this->cursor + 1); + + $this->text = $before.$after; + $this->cursor = $targetStart; + $this->invalidateCaches(); + + return $killed; + } + + $targetStart = $findTarget(); + $killed = \mb_substr($this->text, $targetStart, $this->cursor - $targetStart); + + $before = \mb_substr($this->text, 0, $targetStart); + $after = \mb_substr($this->text, $this->cursor); + + $this->text = $before.$after; + $this->cursor = $targetStart; + $this->invalidateCaches(); + + return $killed; + } + + /** + * Delete forward from cursor to a target position. + * + * @return string The deleted text + */ + private function deleteForwardTo(int $targetEnd): string + { + $killed = \mb_substr($this->text, $this->cursor, $targetEnd - $this->cursor); + + $before = \mb_substr($this->text, 0, $this->cursor); + $after = \mb_substr($this->text, $targetEnd); + + $this->text = $before.$after; + $this->invalidateCaches(); + + return $killed; + } + + private function invalidateCaches(): void + { + $this->graphemeCacheInitialized = false; + $this->graphemeBoundaries = null; + $this->graphemeBoundaryMap = null; + } + + private function getBufferAnalysis(): BufferAnalysis + { + return $this->bufferAnalyzer->analyze($this->getText()); + } + + /** + * @return array Raw token_get_all() tokens + */ + private function getParsedTokens(): array + { + return $this->getBufferAnalysis()->getTokens(); + } + + /** + * @return array + */ + private function getParsedTokenPositions(): array + { + return $this->getBufferAnalysis()->getTokenPositions(); + } + + /** + * Check if the buffer contains a complete PHP statement. + */ + public function isCompleteStatement(): bool + { + return $this->statementCompletenessPolicy->isCompleteStatement($this->text); + } + + /** + * Check if the buffer has an unrecoverable syntax error. + */ + public function hasUnrecoverableSyntaxError(): bool + { + return $this->statementCompletenessPolicy->hasUnrecoverableSyntaxError($this->text); + } + + /** + * Check whether text before the cursor has unclosed brackets. + */ + public function hasUnclosedBracketsBeforeCursor(): bool + { + $textBeforeCursor = $this->getBeforeCursor(); + if (\trim($textBeforeCursor) === '') { + return false; + } + + return !$this->statementCompletenessPolicy->hasBalancedBrackets($textBeforeCursor); + } + + /** + * Calculate the appropriate indentation for the next line. + * + * Analyzes the current line to determine how much whitespace should + * be automatically inserted when continuing to a new line. + * + * @return string The whitespace to insert (spaces or tabs) + */ + public function calculateNextLineIndent(): string + { + return $this->indentationPolicy->calculateNextLineIndent( + $this->text, + $this->getParsedTokens() + ); + } + + /** + * Calculate indentation using only text before the cursor. + */ + public function calculateIndentBeforeCursor(): string + { + $textBeforeCursor = $this->getBeforeCursor(); + $tokens = $this->bufferAnalyzer->analyze($textBeforeCursor)->getTokens(); + + return $this->indentationPolicy->calculateNextLineIndent($textBeforeCursor, $tokens); + } + + /** + * Remove one level of indentation from an indent string. + */ + public function dedent(string $indent): string + { + return $this->indentationPolicy->dedent($indent); + } + + /** + * Get the number of spaces needed to reach the next tab stop. + */ + public function spacesToNextTabStop(int $column): int + { + return $this->indentationPolicy->spacesToNextTabStop($column); + } + + /** + * Get the number of spaces to remove to reach the previous tab stop. + */ + public function spacesToPreviousTabStop(int $spaces): int + { + return $this->indentationPolicy->spacesToPreviousTabStop($spaces); + } + + /** + * Find the start position of the previous token. + * + * Navigates to the start of the token before the cursor position. + * If cursor is inside a token (not at start), goes to start of that token. + * If cursor is at the start of a token, goes to previous token. + * + * @return int Position of previous token start, or 0 if at beginning + */ + public function findPreviousToken(): int + { + return $this->tokenNavigationPolicy->findPreviousToken( + $this->getParsedTokens(), + $this->getParsedTokenPositions(), + $this->cursor + ); + } + + /** + * Find the start position of the next token. + * + * Navigates to the start of the token after the cursor position. + * If cursor is inside a token, goes to next token after that. + * If cursor is between tokens, goes to next token. + * + * @return int Position of next token start, or end of line if at end + */ + public function findNextToken(): int + { + return $this->tokenNavigationPolicy->findNextToken( + $this->getParsedTokens(), + $this->getParsedTokenPositions(), + $this->cursor, + $this->getLength() + ); + } + + /** + * Delete from cursor backwards to start of previous token. + * + * @return string The deleted text + */ + public function deletePreviousToken(): string + { + return $this->deleteBackwardTo(fn () => $this->findPreviousToken()); + } + + /** + * Delete from cursor forwards to start of next token. + * + * @return string The deleted text + */ + public function deleteNextToken(): string + { + return $this->deleteForwardTo($this->findNextToken()); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/History.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/History.php new file mode 100644 index 000000000..aa30880b5 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/History.php @@ -0,0 +1,575 @@ + 'psysh-history', + 'format' => 'jsonl', + 'version' => 1, + ]; + + /** @var array[] History entries (index 0 = oldest, last index = most recent) */ + private array $entries = []; + + /** @var int Current position in history (-1 = not in history, index entries in when navigating) */ + private int $position = -1; + + /** Temporary entry saved when entering history, restored on forward exit */ + private ?string $temporaryEntry = null; + + /** Search term for filtered history navigation (null = no filtering) */ + private ?string $searchTerm = null; + + /** Last command returned during navigation, for skipping consecutive dupes */ + private ?string $lastNavigatedCommand = null; + + private int $maxSize; + private bool $eraseDups; + private int $revision = 0; + + public function __construct(int $maxSize = 10000, bool $eraseDups = false) + { + $this->maxSize = $maxSize; + $this->eraseDups = $eraseDups; + } + + /** + * Add an entry to history. + * + * Skips empty lines and duplicates of the most recent entry. + * If eraseDups is enabled, removes any previous occurrence of the same command. + */ + public function add(string $line): void + { + if (\trim($line) === '') { + return; + } + + $lastIndex = \count($this->entries) - 1; + if ($lastIndex >= 0 && $this->entries[$lastIndex]['command'] === $line) { + return; + } + + if ($this->eraseDups) { + $this->entries = \array_values(\array_filter($this->entries, fn ($entry) => $entry['command'] !== $line)); + } + + $this->entries[] = [ + 'command' => $line, + 'timestamp' => \time(), + 'lines' => \substr_count($line, "\n") + 1, + ]; + + if ($this->maxSize > 0 && \count($this->entries) > $this->maxSize) { + $this->entries = \array_slice($this->entries, -$this->maxSize); + } + + $this->revision++; + } + + /** + * Get the previous history entry. + * + * Moves backward in history (toward older entries). + * When a search term is set, skips entries that don't match. + * + * @return string|null The previous entry, or null if at the beginning + */ + public function getPrevious(): ?string + { + if (empty($this->entries)) { + return null; + } + + $start = $this->position === -1 ? \count($this->entries) - 1 : $this->position - 1; + + for ($i = $start; $i >= 0; $i--) { + $command = $this->entries[$i]['command']; + if ($this->matchesSearchTerm($command) && $command !== $this->lastNavigatedCommand) { + $this->position = $i; + $this->lastNavigatedCommand = $command; + + return $command; + } + } + + return null; + } + + /** + * Get the next history entry. + * + * Moves forward in history (toward newer entries). + * When a search term is set, skips entries that don't match. + * Restores the temporary entry when moving past the most recent match. + * + * @return string|null The next entry, or the saved input when exiting history + */ + public function getNext(): ?string + { + if ($this->position === -1) { + return null; + } + + $lastIndex = \count($this->entries) - 1; + + for ($i = $this->position + 1; $i <= $lastIndex; $i++) { + $command = $this->entries[$i]['command']; + if ($this->matchesSearchTerm($command) && $command !== $this->lastNavigatedCommand) { + $this->position = $i; + $this->lastNavigatedCommand = $command; + + return $command; + } + } + + // No more matches forward — exit history, restore original input + $this->position = -1; + $this->lastNavigatedCommand = null; + $temp = $this->temporaryEntry; + $this->temporaryEntry = null; + + return $temp ?? ''; + } + + /** + * Reset history navigation. + * + * Call this when a line is accepted to prepare for next input. + */ + public function reset(): void + { + $this->position = -1; + $this->temporaryEntry = null; + $this->searchTerm = null; + $this->lastNavigatedCommand = null; + } + + /** + * Save the current input as temporary entry for restoring when exiting history forward. + */ + public function saveTemporaryEntry(string $entry): void + { + $this->temporaryEntry = $entry; + } + + /** + * Set the search term for filtered history navigation. + * + * When set, getPrevious() and getNext() will only return entries + * containing the search term as a substring. + * + * Uses smart case: case-insensitive unless the term contains uppercase. + */ + public function setSearchTerm(?string $term): void + { + $this->searchTerm = ($term !== null && $term !== '') ? $term : null; + } + + /** + * Get the current search term for filtered navigation. + */ + public function getSearchTerm(): ?string + { + return $this->searchTerm; + } + + /** + * Check if currently navigating history. + */ + public function isInHistory(): bool + { + return $this->position !== -1; + } + + /** + * Get the current position in history. + */ + public function getPosition(): int + { + return $this->position; + } + + /** + * Get all history entries. + * + * @return array[] History entries (index 0 = oldest, last index = most recent) + */ + public function getAll(): array + { + return $this->entries; + } + + /** + * Search history for entries matching a query. + * + * @param string $query The search query (smart-case: case-sensitive if query contains uppercase) + * @param bool $reverse If true, return oldest matches first; if false, newest first + * + * @return string[] Matching command strings + */ + public function search(string $query, bool $reverse = false): array + { + if ($query === '') { + $commands = $this->deduplicateCommands(\array_column($this->entries, 'command')); + + return $reverse ? $commands : \array_reverse($commands); + } + + $caseSensitive = self::isSearchCaseSensitive($query); + $matches = []; + foreach ($this->entries as $entry) { + $found = $caseSensitive + ? \strpos($entry['command'], $query) !== false + : \stripos($entry['command'], $query) !== false; + if ($found) { + $matches[] = $entry['command']; + } + } + + $matches = $this->deduplicateCommands($matches); + + return $reverse ? $matches : \array_reverse($matches); + } + + /** + * Deduplicate commands, keeping only the last (most recent) occurrence. + * + * @param string[] $commands + * + * @return string[] + */ + private function deduplicateCommands(array $commands): array + { + $seen = []; + $result = []; + foreach (\array_reverse($commands) as $command) { + if (!isset($seen[$command])) { + $seen[$command] = true; + $result[] = $command; + } + } + + return \array_reverse($result); + } + + /** + * Get the number of entries in history. + */ + public function getCount(): int + { + return \count($this->entries); + } + + /** + * Get the current history revision. + * + * Increments on every mutation (add, clear, load, import). + */ + public function getRevision(): int + { + return $this->revision; + } + + /** + * Clear all history. + */ + public function clear(): void + { + $this->entries = []; + $this->position = -1; + $this->temporaryEntry = null; + $this->searchTerm = null; + $this->lastNavigatedCommand = null; + $this->revision++; + } + + /** + * Load history from file. + * + * Loads JSONL (interactive history format) entries. + * Optionally accepts a JSON signature line at the top of the file. + * Non-JSON lines are ignored. + */ + public function loadFromFile(string $path): void + { + $lines = $this->readLinesFromFile($path); + if ($lines === null) { + return; + } + + $hasJsonSignature = false; + $entries = []; + foreach ($lines as $i => $line) { + if ($i === 0 && self::isJsonHistorySignatureLine($line)) { + $hasJsonSignature = true; + + continue; + } + + $entry = $this->parseJsonLine($line); + if ($entry !== null) { + $entries[] = $entry; + } + } + + // If the file has content but no valid JSONL entries, leave history unchanged. + if (!empty($lines) && empty($entries) && !$hasJsonSignature) { + return; + } + + $this->setEntries($entries); + } + + /** + * Import history from a legacy plain-text file. + * + * Legacy format stores one command per line. + */ + public function importFromFile(string $path): void + { + $lines = $this->readLinesFromFile($path); + if ($lines === null) { + return; + } + + // libedit legacy files may start with a version signature line. + if (!empty($lines) && $lines[0] === '_HiStOrY_V2_') { + \array_shift($lines); + } + + $entries = []; + foreach ($lines as $line) { + $entry = $this->parseLegacyLine($line); + if ($entry !== null) { + $entries[] = $entry; + } + } + + $this->setEntries($entries); + } + + /** + * Save history to file. + * + * Saves in JSONL format with metadata. + */ + public function saveToFile(string $path): void + { + $dir = \dirname($path); + if (!\is_dir($dir)) { + @\mkdir($dir, 0700, true); + } + + $jsonFlags = \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE; + $lines = \array_map(fn ($entry) => \json_encode($entry, $jsonFlags), $this->entries); + \array_unshift($lines, \json_encode(self::HISTORY_SIGNATURE, $jsonFlags)); + + $content = \implode("\n", $lines)."\n"; + + @\file_put_contents($path, $content); + } + + /** + * Check whether a line is valid JSON history (entry or signature). + */ + public static function isJsonHistoryLine(string $line): bool + { + $data = @\json_decode(\trim($line), true); + if (!\is_array($data)) { + return false; + } + + if (isset($data['command']) && \is_string($data['command'])) { + return true; + } + + return self::isJsonHistorySignatureData($data); + } + + /** + * Get display command for history navigation. + * + * For multi-line commands, returns a single-line representation. + * Used by the `hist` command for display purposes. + * + * @param array $entry History entry + */ + public function getDisplayCommand(array $entry): string + { + $command = $entry['command']; + $lines = $entry['lines'] ?? 1; + + if ($lines === 1) { + return $command; + } + + return self::collapseToSingleLine($command); + } + + /** + * Collapse multi-line text to a single line. + */ + public static function collapseToSingleLine(string $text): string + { + $lines = \explode("\n", $text); + $lines = \array_map('trim', $lines); + $lines = \array_filter($lines, fn ($line) => $line !== ''); + + return \implode(' ', $lines); + } + + /** + * Parse a JSONL line into a history entry. + * + * @return array|null + */ + private function parseJsonLine(string $line): ?array + { + $data = @\json_decode(\trim($line), true); + + if (!\is_array($data) || !isset($data['command']) || !\is_string($data['command'])) { + return null; + } + + return [ + 'command' => $data['command'], + 'timestamp' => $data['timestamp'] ?? \time(), + 'lines' => $data['lines'] ?? (\substr_count($data['command'], "\n") + 1), + ]; + } + + /** + * Parse a legacy plain-text history line into an entry. + */ + private function parseLegacyLine(string $line): ?array + { + // GNU/libedit history comments and timestamps use NUL-prefixed lines. + if ($line === '' || $line[0] === "\0") { + return null; + } + + // Ignore comment/timestamp suffix after NUL. + if (($pos = \strpos($line, "\0")) !== false) { + $line = \substr($line, 0, $pos); + } + + $command = Str::unvis(\rtrim($line, "\r")); + if ($command === '') { + return null; + } + + return [ + 'command' => $command, + 'timestamp' => \time(), + 'lines' => \substr_count($command, "\n") + 1, + ]; + } + + /** + * Check whether a line is a JSON history signature. + */ + private static function isJsonHistorySignatureLine(string $line): bool + { + $data = @\json_decode(\trim($line), true); + + return \is_array($data) && self::isJsonHistorySignatureData($data); + } + + /** + * Check whether decoded JSON matches the history signature schema. + * + * @param array $data + */ + private static function isJsonHistorySignatureData(array $data): bool + { + return ($data['type'] ?? null) === self::HISTORY_SIGNATURE['type'] + && ($data['format'] ?? null) === self::HISTORY_SIGNATURE['format'] + && \is_int($data['version'] ?? null) + && $data['version'] === self::HISTORY_SIGNATURE['version']; + } + + /** + * Read and normalize non-empty lines from a file. + * + * @return string[]|null + */ + private function readLinesFromFile(string $path): ?array + { + if (!\file_exists($path) || !\is_readable($path)) { + return null; + } + + $content = @\file_get_contents($path); + if ($content === false) { + return null; + } + + $lines = \explode("\n", $content); + + return \array_values(\array_filter($lines, fn ($line) => \trim($line) !== '')); + } + + /** + * Check whether a search term is case-sensitive (contains uppercase). + */ + public static function isSearchCaseSensitive(string $term): bool + { + return $term !== \mb_strtolower($term); + } + + /** + * Check whether a command matches the current search term. + * + * Smart case: case-insensitive unless the search term contains uppercase. + */ + private function matchesSearchTerm(string $command): bool + { + if ($this->searchTerm === null) { + return true; + } + + if (self::isSearchCaseSensitive($this->searchTerm)) { + return \strpos($command, $this->searchTerm) !== false; + } + + return \stripos($command, $this->searchTerm) !== false; + } + + /** + * Replace history entries, enforcing the configured max size. + * + * @param array $entries + */ + private function setEntries(array $entries): void + { + if ($this->maxSize > 0 && \count($entries) > $this->maxSize) { + $entries = \array_slice($entries, -$this->maxSize); + } + + $this->entries = \array_values($entries); + $this->position = -1; + $this->temporaryEntry = null; + $this->searchTerm = null; + $this->lastNavigatedCommand = null; + $this->revision++; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/IndentationPolicy.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/IndentationPolicy.php new file mode 100644 index 000000000..d5e1e0d79 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/IndentationPolicy.php @@ -0,0 +1,247 @@ +isEndOfLineInStringOrComment($bufferText, $tokens)) { + return ''; + } + + $currentIndent = $this->getLineIndentation($lastLine); + $lastChar = \substr(\rtrim($trimmedLastLine), -1); + + if (\in_array($lastChar, BracketPair::OPENING_BRACKETS)) { + return $this->indent($currentIndent); + } + + if ($this->endsWithControlStructure($trimmedLastLine)) { + return $this->indent($currentIndent); + } + + return $currentIndent; + } + + /** + * Add one level of indentation. + */ + public function indent(string $currentIndent): string + { + return $currentIndent.\str_repeat(' ', self::INDENT_WIDTH); + } + + /** + * Remove one level of indentation. + */ + public function dedent(string $indent): string + { + if ($indent === '') { + return ''; + } + + // Calculate the visual column width, accounting for tabs. + $column = 0; + $length = \strlen($indent); + + for ($i = 0; $i < $length; $i++) { + $column += $indent[$i] === "\t" ? $this->spacesToNextTabStop($column) : 1; + } + + $target = $column - $this->spacesToPreviousTabStop($column); + + // Find the byte position where truncating leaves us at the target column. + $column = 0; + for ($i = 0; $i < $length; $i++) { + $column += $indent[$i] === "\t" ? $this->spacesToNextTabStop($column) : 1; + if ($column > $target) { + return \substr($indent, 0, $i); + } + } + + return $indent; + } + + /** + * Calculate how many spaces to remove when typing a closing bracket. + * + * Returns the number of leading spaces to strip from the current line + * when a closing bracket is typed at the end of a whitespace-only line. + * + * @param string $char The character being typed + * @param string $text The full buffer text + * @param int $cursor The current cursor position + * @param string $context Accumulated code context for bracket matching + */ + public function calculateClosingBracketDedent(string $char, string $text, int $cursor, string $context = ''): int + { + if (!\in_array($char, BracketPair::CLOSING_BRACKETS)) { + return 0; + } + + $lines = \explode("\n", $text); + $currentLineNum = \substr_count(\mb_substr($text, 0, $cursor), "\n"); + $currentLine = $lines[$currentLineNum]; + + $charsBeforeLine = 0; + for ($i = 0; $i < $currentLineNum; $i++) { + $charsBeforeLine += \mb_strlen($lines[$i]) + 1; + } + $cursorInLine = $cursor - $charsBeforeLine; + + if (\trim($currentLine) !== '') { + return 0; + } + + if ($cursorInLine !== \mb_strlen($currentLine)) { + return 0; + } + + $leadingSpaces = \mb_strlen($currentLine) - \mb_strlen(\ltrim($currentLine)); + if ($leadingSpaces === 0) { + return 0; + } + + if ($context !== '' && !BracketPair::doesClosingBracketMatch($char, $context)) { + return 0; + } + + return $this->spacesToPreviousTabStop($leadingSpaces); + } + + /** + * @param array $tokens + */ + private function isEndOfLineInStringOrComment(string $bufferText, array $tokens): bool + { + if (empty($tokens)) { + return false; + } + + $lastToken = null; + for ($i = \count($tokens) - 1; $i >= 0; $i--) { + $token = $tokens[$i]; + if (\is_array($token) && $token[0] === \T_WHITESPACE) { + continue; + } + + $lastToken = $token; + break; + } + + if ($lastToken === null) { + return false; + } + + if (\is_array($lastToken)) { + $tokenType = $lastToken[0]; + if ($tokenType === \T_CONSTANT_ENCAPSED_STRING || + $tokenType === \T_ENCAPSED_AND_WHITESPACE || + $tokenType === \T_START_HEREDOC || + $tokenType === \T_END_HEREDOC) { + return true; + } + + if ($tokenType === \T_COMMENT) { + $text = \ltrim($lastToken[1]); + + // Only suppress indentation for block comments, not single-line + return \strpos($text, '/*') === 0; + } + + if ($tokenType === \T_DOC_COMMENT) { + return true; + } + + if (\defined('T_BACKTICK') && $tokenType === T_BACKTICK) { + return true; + } + } + + $trimmed = \rtrim($bufferText); + $lastChar = \substr($trimmed, -1); + if ($lastChar === '"' || $lastChar === "'" || $lastChar === '`') { + $doubleQuoteCount = \substr_count($bufferText, '"'); + $singleQuoteCount = \substr_count($bufferText, "'"); + $backtickCount = \substr_count($bufferText, '`'); + + if ($lastChar === '"' && $doubleQuoteCount % 2 === 1) { + return true; + } + if ($lastChar === "'" && $singleQuoteCount % 2 === 1) { + return true; + } + if ($lastChar === '`' && $backtickCount % 2 === 1) { + return true; + } + } + + return false; + } + + /** + * Get the number of spaces needed to reach the next tab stop. + */ + public function spacesToNextTabStop(int $column): int + { + return self::INDENT_WIDTH - ($column % self::INDENT_WIDTH); + } + + /** + * Get the number of spaces to remove to reach the previous tab stop. + */ + public function spacesToPreviousTabStop(int $spaces): int + { + $remainder = $spaces % self::INDENT_WIDTH; + + return $remainder === 0 ? self::INDENT_WIDTH : $remainder; + } + + /** + * Extract leading whitespace from a line. + */ + private function getLineIndentation(string $line): string + { + if (\preg_match('/^(\s+)/', $line, $matches)) { + return $matches[1]; + } + + return ''; + } + + /** + * Check whether a line ends with a control structure (if, for, while, etc.). + */ + private function endsWithControlStructure(string $line): bool + { + return (bool) \preg_match('/\b(if|for|foreach|while|switch|else|elseif|do)\s*\([^)]*\)\s*$/', $line); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/InputQueue.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/InputQueue.php new file mode 100644 index 000000000..06a6b8e72 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/InputQueue.php @@ -0,0 +1,50 @@ +terminal = $terminal; + } + + /** + * Read the next key event, replaying buffered events first. + */ + public function read(): Key + { + if (!empty($this->bufferedEvents)) { + return \array_shift($this->bufferedEvents); + } + + return Key::normalized($this->terminal->readKey()); + } + + /** + * Push an event back so it is replayed on the next read. + */ + public function replay(Key $key): void + { + \array_unshift($this->bufferedEvents, Key::normalized($key)); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/Key.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/Key.php new file mode 100644 index 000000000..284870305 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/Key.php @@ -0,0 +1,130 @@ +value = $value; + $this->type = $type; + } + + /** + * Get the raw key value. + */ + public function getValue(): string + { + return $this->value; + } + + /** + * Get the key type. + */ + public function getType(): string + { + return $this->type; + } + + /** + * Check if this is a regular character key. + */ + public function isChar(): bool + { + return $this->type === self::TYPE_CHAR; + } + + /** + * Check if this is a control character. + */ + public function isControl(): bool + { + return $this->type === self::TYPE_CONTROL; + } + + /** + * Check if this is an escape sequence. + */ + public function isEscape(): bool + { + return $this->type === self::TYPE_ESCAPE; + } + + /** + * Check if this is an EOF signal. + */ + public function isEof(): bool + { + return $this->type === self::TYPE_EOF; + } + + /** + * Check if this is pasted content. + */ + public function isPaste(): bool + { + return $this->type === self::TYPE_PASTE; + } + + /** + * Create a normalized copy of a key. + */ + public static function normalized(self $key): self + { + $value = $key->value; + $type = $key->type; + + // Normalize CR to LF for deterministic line-accept handling. + if ($type === self::TYPE_CHAR && $value === "\r") { + $value = "\n"; + } + + // Normalize CSI-u key event type suffixes (e.g. \033[13;2:1u -> \033[13;2u). + if ($type === self::TYPE_ESCAPE && \preg_match('/^(\033\[\d+(?:;\d+)*):\d+u$/', $value, $matches)) { + $value = $matches[1].'u'; + } + + return new self($value, $type); + } + + public function __toString(): string + { + if ($this->type === self::TYPE_CONTROL) { + $ord = \ord($this->value); + if ($ord < 32) { + $char = \chr($ord + 96); + + return 'control:'.$char; + } elseif ($ord === 127) { + return 'control:?'; + } + } elseif ($this->type === self::TYPE_ESCAPE) { + return 'escape:'.\substr($this->value, 1); + } elseif ($this->type === self::TYPE_CHAR) { + return 'char:'.$this->value; + } + + return $this->type.':'.$this->value; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/KeyBindings.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/KeyBindings.php new file mode 100644 index 000000000..3edeae3b9 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/KeyBindings.php @@ -0,0 +1,185 @@ +bindings[$keyPattern] = empty($fallbackActions) ? $action : new FallbackAction([$action, ...$fallbackActions]); + } + + /** + * Get the action bound to a key. + */ + public function get(Key $key): ?ActionInterface + { + return $this->bindings[(string) $key] ?? null; + } + + /** + * Get all bindings. + * + * @return ActionInterface[] Keyed by key pattern + */ + public function getAll(): array + { + return $this->bindings; + } + + /** + * Create default Emacs-style keybindings. + * + * @param bool $smartBrackets Enable smart bracket pairing + */ + public static function createDefault(History $history, HistorySearch $search, bool $smartBrackets = false): self + { + $bindings = new self(); + + // Enter/Return + $acceptLine = new FallbackAction([ + new RejectSyntaxErrorAction(), + new InsertLineBreakOnUnclosedBracketsAction($smartBrackets), + new InsertLineBreakOnIncompleteStatementAction(), + new SubmitLineAction(), + ], false); + $bindings->bind('char:'."\n", $acceptLine); + $bindings->bind('char:'."\r", $acceptLine); + // Shift+Enter variants (CSI-u / modifyOtherKeys) + $bindings->bind('escape:[13;2u', new InsertLineBreakAction()); + $bindings->bind('escape:[13;2~', new InsertLineBreakAction()); + $bindings->bind('escape:[27;2;13~', new InsertLineBreakAction()); + // Shift+Enter remapped by some terminal setups (Esc+Enter) + $bindings->bind('escape:'."\r", new InsertLineBreakAction()); + $bindings->bind('escape:'."\n", new InsertLineBreakAction()); + + // Backspace + $backspace = $smartBrackets + ? new FallbackAction([new DedentLeadingIndentationAction(), new DeleteBracketPairAction(), new DeleteBackwardCharAction()]) + : new FallbackAction([new DedentLeadingIndentationAction(), new DeleteBackwardCharAction()]); + $bindings->bind('control:h', $backspace); + $bindings->bind('control:?', $backspace); + + // Delete + $bindings->bind('escape:[3~', new DeleteForwardAction()); + + // Arrow keys + $bindings->bind('escape:[D', new MoveLeftAction()); + $bindings->bind('escape:[C', new AcceptSuggestionAction(), new MoveRightAction()); + $bindings->bind('escape:[A', new PreviousHistoryAction($history)); + $bindings->bind('escape:[B', new NextHistoryAction($history)); + + // Emacs cursor movement + $bindings->bind('control:b', new MoveLeftAction()); + $bindings->bind('control:f', new AcceptSuggestionAction(), new MoveRightAction()); + $bindings->bind('control:a', new MoveToStartAction()); + $bindings->bind('control:e', new MoveToEndAction()); + + // Word movement - Alt+Arrow + $bindings->bind('escape:[1;3D', new MoveWordLeftAction()); + $bindings->bind('escape:[1;3C', new AcceptSuggestionWordAction(), new MoveWordRightAction()); + + // Word movement - Ctrl+Arrow + $bindings->bind('escape:[1;5D', new MoveWordLeftAction()); + $bindings->bind('escape:[1;5C', new MoveWordRightAction()); + + // Word movement - Emacs style + $bindings->bind('escape:b', new MoveWordLeftAction()); + $bindings->bind('escape:f', new AcceptSuggestionWordAction(), new MoveWordRightAction()); + + // Home/End keys + $bindings->bind('escape:[H', new MoveToStartAction()); + $bindings->bind('escape:[F', new MoveToEndAction()); + $bindings->bind('escape:[1~', new MoveToStartAction()); + $bindings->bind('escape:[4~', new MoveToEndAction()); + + // Kill operations + $bindings->bind('control:k', new KillLineAction()); + $bindings->bind('control:u', new KillWholeLineAction()); + $bindings->bind('control:w', new KillWordAction()); + + // Buffer control + $bindings->bind('control:c', new ClearBufferAction()); + $bindings->bind('control:d', new ExitIfEmptyAction(), new DeleteForwardAction()); + + // History search + $bindings->bind('control:r', new ReverseSearchAction($search)); + + // Clear screen + $bindings->bind('control:l', new ClearScreenAction()); + + // Smart bracket pairing + if ($smartBrackets) { + // Opening brackets + $bindings->bind('char:(', new InsertOpenBracketAction('(')); + $bindings->bind('char:[', new InsertOpenBracketAction('[')); + $bindings->bind('char:{', new InsertOpenBracketAction('{')); + + // Closing brackets + $bindings->bind('char:)', new InsertCloseBracketAction(')')); + $bindings->bind('char:]', new InsertCloseBracketAction(']')); + $bindings->bind('char:}', new InsertCloseBracketAction('}')); + + // Quotes + $bindings->bind('char:"', new InsertQuoteAction('"')); + $bindings->bind("char:'", new InsertQuoteAction("'")); + } + + return $bindings; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/StatementCompletenessPolicy.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/StatementCompletenessPolicy.php new file mode 100644 index 000000000..523a6f9c6 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/StatementCompletenessPolicy.php @@ -0,0 +1,125 @@ +bufferAnalyzer = $bufferAnalyzer; + $this->requireSemicolons = $requireSemicolons; + } + + public function isCompleteStatement(string $line): bool + { + if ($line === '') { + return true; + } + + $analysis = $this->bufferAnalyzer->analyze($line); + $lastError = $analysis->getLastError(); + + // Control structures like `if (...)` are incomplete in REPL context. + if ($analysis->hasControlStructureWithoutBody()) { + return false; + } + + if ($lastError === null) { + if (!$analysis->hasBalancedBrackets()) { + return false; + } + + if ($analysis->hasTrailingOperator()) { + return false; + } + + return true; + } + + if (!$this->requireSemicolons && $analysis->hasEOFError()) { + if ($this->bufferAnalyzer->canBeFixedWithSemicolon($line)) { + return true; + } + } + + if ($this->isUnterminatedComment($lastError) || $this->isUnclosedString($lastError)) { + return false; + } + + if (!$analysis->hasEOFError()) { + // Real syntax errors should execute immediately so the user sees them. + return true; + } + + return false; + } + + /** + * Check whether the buffer has a non-EOF parse error that isn't recoverable + * by adding more input (e.g. extra closing brackets, invalid syntax). + */ + public function hasUnrecoverableSyntaxError(string $line): bool + { + if ($line === '') { + return false; + } + + $analysis = $this->bufferAnalyzer->analyze($line); + $lastError = $analysis->getLastError(); + + if ($lastError === null) { + return false; + } + + if ($analysis->hasEOFError()) { + return false; + } + + if ($this->isUnterminatedComment($lastError) || $this->isUnclosedString($lastError)) { + return false; + } + + // Control structures without body aren't syntax errors, they're incomplete. + if ($analysis->hasControlStructureWithoutBody()) { + return false; + } + + return true; + } + + public function hasBalancedBrackets(string $line): bool + { + return $this->bufferAnalyzer->analyze($line)->hasBalancedBrackets(); + } + + private function isUnterminatedComment(Error $error): bool + { + return $error->getRawMessage() === 'Unterminated comment'; + } + + private function isUnclosedString(Error $error): bool + { + $msg = $error->getRawMessage(); + + return $msg === 'Syntax error, unexpected T_ENCAPSED_AND_WHITESPACE' || + \strpos($msg, 'Unterminated string') !== false; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/StdinReader.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/StdinReader.php new file mode 100644 index 000000000..20bf17cdd --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/StdinReader.php @@ -0,0 +1,292 @@ +stream = $stream; + } + + /** + * Check if there's pending input (useful for paste detection). + */ + public function hasPendingInput(): bool + { + // Memory streams don't support stream_select. + $meta = \stream_get_meta_data($this->stream); + if (isset($meta['stream_type']) && $meta['stream_type'] === 'MEMORY') { + return false; + } + + \stream_set_blocking($this->stream, false); + + $read = [$this->stream]; + $write = null; + $except = null; + + $ready = @\stream_select($read, $write, $except, 0, 0); + + \stream_set_blocking($this->stream, true); + + return $ready > 0; + } + + /** + * Read all available input (used for handling pastes). + * + * @return string The pasted content + */ + public function readPastedContent(): string + { + // Memory streams don't support stream_select. + $meta = \stream_get_meta_data($this->stream); + if (isset($meta['stream_type']) && $meta['stream_type'] === 'MEMORY') { + $content = ''; + while (($char = \fgetc($this->stream)) !== false) { + $content .= $char; + } + + return $content; + } + + \stream_set_blocking($this->stream, false); + + $content = ''; + $timeout = 50000; + $start = \microtime(true); + + while ((\microtime(true) - $start) < ($timeout / 1000000)) { + $char = \fgetc($this->stream); + + if ($char === false) { + $read = [$this->stream]; + $write = null; + $except = null; + if (@\stream_select($read, $write, $except, 0, 1000) > 0) { + continue; + } + break; + } + + $content .= $char; + } + + \stream_set_blocking($this->stream, true); + + return $content; + } + + /** + * Read a single key press from the input stream. + */ + public function readKey(): Key + { + $char = \fgetc($this->stream); + + if ($char === false) { + return new Key('', Key::TYPE_EOF); + } + + // Escape sequences must be handled before paste detection. + if ($char === "\033") { + $escapeKey = $this->readEscapeSequence($char); + + if ($escapeKey->getValue() === "\033[200~") { + return $this->readBracketedPaste(); + } + + return $escapeKey; + } + + if ($this->hasPendingInput()) { + $pastedContent = $char.$this->readPastedContent(); + + // No ungetc support in PHP, so return any buffered content as a paste. + if (\strlen($pastedContent) > 1) { + return new Key($pastedContent, Key::TYPE_PASTE); + } + } + + // CR/LF are handled as regular chars, not control characters. + $ord = \ord($char); + if ($ord < 32 && $char !== "\n" && $char !== "\r") { + return new Key($char, Key::TYPE_CONTROL); + } + + if ($ord === 127) { + return new Key($char, Key::TYPE_CONTROL); + } + + return new Key($char, Key::TYPE_CHAR); + } + + /** + * Read an escape sequence from the input stream. + */ + protected function readEscapeSequence(string $prefix): Key + { + \stream_set_blocking($this->stream, false); + + $sequence = $prefix; + $timeout = 100000; + $start = \microtime(true); + + while ((\microtime(true) - $start) < ($timeout / 1000000)) { + $char = \fgetc($this->stream); + + if ($char === false) { + \usleep(1000); // 1ms + continue; + } + + $sequence .= $char; + + if ($this->isCompleteEscapeSequence($sequence)) { + break; + } + + if (\strlen($sequence) > 32) { + break; + } + } + + \stream_set_blocking($this->stream, true); + + return new Key($sequence, Key::TYPE_ESCAPE); + } + + /** + * Check if an escape sequence is complete. + */ + protected function isCompleteEscapeSequence(string $sequence): bool + { + // Esc+Enter remaps (common in terminal keybind customization). + if ($sequence === "\033\r" || $sequence === "\033\n") { + return true; + } + + // Arrow keys: \033[A-D, Home/End: \033[H, \033[F + if (\preg_match('/^\033\[[A-DHF]$/', $sequence)) { + return true; + } + + // Function keys, Delete, bracketed paste: \033[NNN~ or \033[27;2;13~ + if (\preg_match('/^\033\[\d+(?:[;:]\d+)*~$/', $sequence)) { + return true; + } + + // Modified keys: \033[1;3C (Alt+Right), \033[1;5D (Ctrl+Left), etc. + if (\preg_match('/^\033\[\d+(?:[;:]\d+)*[A-Za-z]$/', $sequence)) { + return true; + } + + // CSI-u protocol: \033[13;2u (Shift+Enter), \033[97;5u (Ctrl+A), etc. + if (\preg_match('/^\033\[\d+(?:[;:]\d+)*u$/', $sequence)) { + return true; + } + + // SS3 keys: \033OM (keypad Enter), \033OA, etc. + if (\preg_match('/^\033O[A-Z]$/', $sequence)) { + return true; + } + + // Alt+char: \033b, \033f, etc. + if (\preg_match('/^\033[a-z]$/i', $sequence)) { + return true; + } + + return false; + } + + /** + * Read bracketed paste content. + * + * Called after detecting \033[200~ sequence. + * Reads until \033[201~ is encountered. + */ + protected function readBracketedPaste(): Key + { + $content = ''; + $escapeBuffer = ''; + + while (true) { + $char = \fgetc($this->stream); + + if ($char === false) { + break; + } + + if ($char === "\033") { + $escapeBuffer = $char; + + \stream_set_blocking($this->stream, false); + $timeout = 10000; + $start = \microtime(true); + + while ((\microtime(true) - $start) < ($timeout / 1000000)) { + $nextChar = \fgetc($this->stream); + + if ($nextChar === false) { + \usleep(500); + continue; + } + + $escapeBuffer .= $nextChar; + + if ($escapeBuffer === "\033[201~") { + \stream_set_blocking($this->stream, true); + + return new Key($content, Key::TYPE_PASTE); + } + + if ($this->isCompleteEscapeSequence($escapeBuffer)) { + break; + } + + if (\strlen($escapeBuffer) > 32) { + break; + } + } + + \stream_set_blocking($this->stream, true); + + $content .= $escapeBuffer; + $escapeBuffer = ''; + } else { + $content .= $char; + } + } + + return new Key($content, Key::TYPE_PASTE); + } + + /** + * Get the underlying stream resource. + * + * @return resource + */ + public function getStream() + { + return $this->stream; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/TokenNavigationPolicy.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/TokenNavigationPolicy.php new file mode 100644 index 000000000..5975d4529 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/TokenNavigationPolicy.php @@ -0,0 +1,99 @@ + $token) { + $tokenStart = $tokenPositions[$index]['start']; + $tokenEnd = $tokenPositions[$index]['end']; + + if ($tokenStart < self::PHP_PREFIX_LENGTH) { + continue; + } + + if (\is_array($token) && $token[0] === \T_WHITESPACE) { + continue; + } + + // Cursor is inside this token — jump to its start + if ($tokenStart < $cursorPos && $cursorPos <= $tokenEnd) { + return $tokenStart - self::PHP_PREFIX_LENGTH; + } + + // Cursor is before this token — jump to previous non-whitespace token + if ($tokenStart >= $cursorPos) { + return \max(0, $lastNonWhitespaceStart - self::PHP_PREFIX_LENGTH); + } + + $lastNonWhitespaceStart = $tokenStart; + } + + return \max(0, $lastNonWhitespaceStart - self::PHP_PREFIX_LENGTH); + } + + /** + * @param array $tokens + * @param array $tokenPositions + */ + public function findNextToken(array $tokens, array $tokenPositions, int $cursor, int $lineLength): int + { + if (empty($tokens) || empty($tokenPositions)) { + return $lineLength; + } + + $cursorPos = $cursor + self::PHP_PREFIX_LENGTH; + $skipCurrentToken = false; + + foreach ($tokens as $index => $token) { + $tokenStart = $tokenPositions[$index]['start']; + $tokenEnd = $tokenPositions[$index]['end']; + + if ($tokenStart < self::PHP_PREFIX_LENGTH) { + continue; + } + + if (\is_array($token) && $token[0] === \T_WHITESPACE) { + continue; + } + + if ($tokenStart <= $cursorPos && $cursorPos < $tokenEnd) { + $skipCurrentToken = true; + continue; + } + + if ($tokenStart > $cursorPos || ($skipCurrentToken && $tokenStart >= $cursorPos)) { + return $tokenStart - self::PHP_PREFIX_LENGTH; + } + } + + return $lineLength; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/VisualNavigationPolicy.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/VisualNavigationPolicy.php new file mode 100644 index 000000000..5e8393ef2 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/VisualNavigationPolicy.php @@ -0,0 +1,78 @@ +getLineBounds($text, $cursor); + $lineText = \mb_substr($text, $lineStart, $lineEnd - $lineStart); + + $cursorInLine = \max(0, \min(\mb_strlen($lineText), $cursor - $lineStart)); + $textBeforeCursor = \mb_substr($lineText, 0, $cursorInLine); + + $currentAbsoluteColumn = $promptWidth + DisplayString::width($textBeforeCursor) + 1; + $lineEndAbsoluteColumn = $promptWidth + DisplayString::width($lineText) + 1; + + $currentRow = $calculator->rowOffsetForAbsoluteColumn($currentAbsoluteColumn); + $targetRow = $currentRow + $deltaRows; + $maxRow = $calculator->rowOffsetForAbsoluteColumn($lineEndAbsoluteColumn); + + if ($targetRow < 0 || $targetRow > $maxRow) { + return null; + } + + $targetAbsoluteColumn = $currentAbsoluteColumn + ($deltaRows * $calculator->getTerminalWidth()); + $targetAbsoluteColumn = \max($promptWidth + 1, \min($lineEndAbsoluteColumn, $targetAbsoluteColumn)); + $targetTextWidth = \max(0, $targetAbsoluteColumn - $promptWidth - 1); + + $targetOffset = DisplayString::offsetForWidth($lineText, $targetTextWidth); + + return $lineStart + $targetOffset; + } + + /** + * Get current logical line bounds as [start, end) offsets. + * + * @return array{int, int} + */ + private function getLineBounds(string $text, int $cursor): array + { + $beforeCursor = \mb_substr($text, 0, $cursor); + $lineStartPos = \mb_strrpos($beforeCursor, "\n"); + $lineStart = $lineStartPos === false ? 0 : $lineStartPos + 1; + + $lineEndPos = \mb_strpos($text, "\n", $lineStart); + $lineEnd = $lineEndPos === false ? \mb_strlen($text) : $lineEndPos; + + return [$lineStart, $lineEnd]; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Input/WordNavigationPolicy.php b/app/vendor/psy/psysh/src/Readline/Interactive/Input/WordNavigationPolicy.php new file mode 100644 index 000000000..b8f995774 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Input/WordNavigationPolicy.php @@ -0,0 +1,46 @@ +terminal = $terminal; + } + + /** + * Start interactive terminal lifecycle. + * + * @throws \RuntimeException if raw mode cannot be enabled + */ + public function start(): void + { + if ($this->active) { + return; + } + + $this->registerShutdownHandler(); + if (!$this->terminal->enableRawMode()) { + throw new \RuntimeException('Unable to enable raw mode for interactive readline.'); + } + + if ($this->bracketedPasteEnabled) { + $this->terminal->enableBracketedPaste(); + } + + $this->active = true; + } + + /** + * Stop interactive terminal lifecycle. + */ + public function stop(): void + { + if (!$this->active) { + return; + } + + if ($this->terminal->isBracketedPasteEnabled()) { + $this->terminal->disableBracketedPaste(); + } + + $this->terminal->disableRawMode(); + $this->active = false; + } + + /** + * Enable or disable bracketed paste mode for the active session. + */ + public function setUseBracketedPaste(bool $enabled): void + { + $this->bracketedPasteEnabled = $enabled; + + if (!$this->active) { + return; + } + + if ($enabled) { + $this->terminal->enableBracketedPaste(); + } else { + $this->terminal->disableBracketedPaste(); + } + } + + /** + * Determine whether the session is active. + */ + public function isActive(): bool + { + return $this->active; + } + + /** + * Register a shutdown function to ensure the terminal is restored on exit. + */ + private function registerShutdownHandler(): void + { + if ($this->shutdownRegistered) { + return; + } + + \register_shutdown_function([$this, 'stop']); + $this->shutdownRegistered = true; + } + + /** + * Stop the session on destruction. + */ + public function __destruct() + { + $this->stop(); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Layout/DisplayString.php b/app/vendor/psy/psysh/src/Readline/Interactive/Layout/DisplayString.php new file mode 100644 index 000000000..9596c681c --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Layout/DisplayString.php @@ -0,0 +1,149 @@ +..." and should be measured by their rendered width. + */ + public static function widthWithoutFormatting(string $text, OutputFormatterInterface $formatter): int + { + return self::width(Helper::removeDecoration($formatter, $text)); + } + + /** + * Measure width from already-rendered terminal output. + * + * This strips ANSI/control sequences only; it does not parse formatter + * markup like "...". + */ + public static function widthWithoutAnsi(string $text): int + { + return self::width(self::stripAnsi($text)); + } + + /** + * Resolve the code-point offset for a target display width. + * + * The returned offset is always on a grapheme boundary. + */ + public static function offsetForWidth(string $text, int $targetWidth): int + { + if ($targetWidth <= 0 || $text === '') { + return 0; + } + + $offset = 0; + $width = 0; + foreach (self::graphemes($text) as $grapheme) { + $graphemeWidth = self::width($grapheme); + if ($width + $graphemeWidth > $targetWidth) { + break; + } + + $width += $graphemeWidth; + $offset += \mb_strlen($grapheme); + } + + return $offset; + } + + /** + * Truncate text to a maximum display width with optional ellipsis. + */ + public static function truncate(string $text, int $maxWidth, bool $withEllipsis = false): string + { + if ($maxWidth <= 0 || $text === '') { + return ''; + } + + if (self::width($text) <= $maxWidth) { + return $text; + } + + if (!$withEllipsis || $maxWidth <= 3) { + return Helper::substr($text, 0, $maxWidth); + } + + $targetWidth = $maxWidth - 3; + $offset = self::offsetForWidth($text, $targetWidth); + + return \mb_substr($text, 0, $offset).'...'; + } + + /** + * Iterate grapheme clusters in a string. + * + * @return string[] + */ + private static function graphemes(string $text): array + { + if (\preg_match_all('/\X/u', $text, $matches) > 0) { + return $matches[0]; + } + + // Fallback to individual code points when grapheme matching fails. + $length = \mb_strlen($text); + $chars = []; + for ($i = 0; $i < $length; $i++) { + $chars[] = \mb_substr($text, $i, 1); + } + + return $chars; + } + + /** + * Remove terminal ANSI/control sequences from rendered text. + */ + private static function stripAnsi(string $text): string + { + return \preg_replace([self::ANSI_CSI_RX, self::ANSI_OSC_RX], '', $text) ?? $text; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Layout/SoftWrapCalculator.php b/app/vendor/psy/psysh/src/Readline/Interactive/Layout/SoftWrapCalculator.php new file mode 100644 index 000000000..8ba11e391 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Layout/SoftWrapCalculator.php @@ -0,0 +1,62 @@ +terminalWidth = \max(1, $terminalWidth); + } + + public function getTerminalWidth(): int + { + return $this->terminalWidth; + } + + /** + * Normalize an absolute terminal column (1-indexed) into visible column. + */ + public function normalizeColumn(int $absoluteColumn): int + { + $offset = \max(0, $absoluteColumn - 1); + + return ($offset % $this->terminalWidth) + 1; + } + + /** + * Get wrapped row offset for an absolute terminal column (1-indexed). + */ + public function rowOffsetForAbsoluteColumn(int $absoluteColumn): int + { + return \intdiv(\max(0, $absoluteColumn - 1), $this->terminalWidth); + } + + /** + * Count wrapped rows occupied by text with this display width. + * + * Zero-width text still occupies one row. + */ + public function rowCountForDisplayWidth(int $displayWidth): int + { + if ($displayWidth <= 0) { + return 1; + } + + return \intdiv($displayWidth - 1, $this->terminalWidth) + 1; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Readline.php b/app/vendor/psy/psysh/src/Readline/Interactive/Readline.php new file mode 100644 index 000000000..816761990 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Readline.php @@ -0,0 +1,601 @@ +terminal = $terminal; + $this->inputQueue = new InputQueue($this->terminal); + $this->history = $history ?? new History(); + $this->theme = new Theme(); + + $this->suggestionEngine = new SuggestionEngine($this->history); + $this->overlayViewport = new OverlayViewport($this->terminal); + $this->frameRenderer = new FrameRenderer($this->terminal, $this->overlayViewport, $this->theme); + $this->search = new HistorySearch($this->terminal, $this->history, $this->frameRenderer, $this->overlayViewport, $this->theme); + + $this->bindings = $bindings ?? KeyBindings::createDefault($this->history, $this->search, $this->smartBrackets); + } + + /** + * Set the theme for prompt strings and compact mode. + */ + public function setTheme(Theme $theme): void + { + $this->theme = $theme; + $this->frameRenderer->setTheme($theme); + $this->search->setTheme($theme); + } + + /** + * Check whether compact input frame rendering is enabled. + */ + public function isInputFrameCompact(): bool + { + return $this->frameRenderer->isCompactInputFrame(); + } + + /** + * Get number of outer rows surrounding input content. + */ + public function getInputFrameOuterRowCount(): int + { + return $this->frameRenderer->getInputFrameOuterRowCount(); + } + + /** + * Get active prompt display width for the cursor's current line. + */ + public function getPromptWidthForCurrentLine(Buffer $buffer): int + { + return $this->frameRenderer->getPromptWidthForCurrentLine($buffer); + } + + /** + * Set the Shell reference. + */ + public function setShell(Shell $shell): void + { + $this->shell = $shell; + + if ($this->expandHistoryAction !== null) { + $this->expandHistoryAction->setHistoryExpansion(new HistoryExpansionAction($this->history, $this->shell)); + } + } + + /** + * Get the command highlighter for CommandAware registration. + */ + public function getCommandHighlighter(): Helper\CommandHighlighter + { + return $this->frameRenderer->getCommandHighlighter(); + } + + /** + * Set whether to require semicolons on all statements. + * + * By default, PsySH automatically inserts semicolons. When set to true, + * semicolons are strictly required. + */ + public function setRequireSemicolons(bool $require): void + { + $this->requireSemicolons = $require; + } + + /** + * Set the CompletionEngine for context-aware tab completion. + */ + public function setCompletionEngine(CompletionEngine $completionEngine): void + { + if ($this->tabAction === null) { + $this->tabAction = new TabAction($completionEngine, $this->smartBrackets); + $this->expandHistoryAction = new ExpandHistoryOnTabAction(new HistoryExpansionAction($this->history, $this->shell)); + $this->bindings->bind( + 'control:i', + new InsertIndentOnTabAction(), + $this->expandHistoryAction, + $this->tabAction + ); + } else { + $this->tabAction->setCompleter($completionEngine); + } + } + + /** + * Check if the current input is a PsySH command. + */ + public function isCommand(string $input): bool + { + if ($this->shell === null) { + return false; + } + + if (\preg_match('/([^\s]+?)(?:\s|$)/A', \ltrim($input), $match)) { + return $this->shell->has($match[1]); + } + + return false; + } + + /** + * Check if the input should be highlighted as a command (not in an open string or comment). + */ + private function isCommandInput(string $text): bool + { + return $this->isCommand($text) && !$this->isInOpenStringOrComment($text); + } + + /** + * Check if currently in multi-line mode. + */ + public function isMultilineMode(): bool + { + return $this->multilineMode; + } + + /** + * Check if input is in an open string or comment. + */ + public function isInOpenStringOrComment(string $input): bool + { + $tokens = @\token_get_all('multilineMode = true; + } + + /** + * Exit multi-line mode. + */ + public function exitMultilineMode(): void + { + $this->multilineMode = false; + } + + /** + * Cancel multi-line mode without executing. + */ + public function cancelMultilineMode(): void + { + if (!$this->multilineMode) { + return; + } + + $this->multilineMode = false; + } + + /** + * Sync multiline mode with buffer content and invalidate the frame on transition. + */ + private function syncMultilineMode(string $text): void + { + $isMultiline = \strpos($text, "\n") !== false; + + if ($this->multilineMode === $isMultiline) { + return; + } + + if ($isMultiline) { + $this->enterMultilineMode(); + } else { + $this->exitMultilineMode(); + } + + $this->terminal->invalidateFrame(); + } + + /** + * Read a line of input. + * + * @return string|false The input line, or false on EOF + */ + public function readline() + { + $this->mode = self::MODE_NORMAL; + $this->search->exit(); + $this->clearSuggestion(); + + if ($this->continueFrame && $this->lastSubmittedText !== null) { + // Rewind the cursor past the escape newlines written by SubmitLineAction. + // Wrap in a frame render so the movement doesn't mark the terminal dirty + // (we're restoring the cursor to its known position, not making out-of-band changes). + $this->terminal->beginFrameRender(); + if ($this->lastSubmitEscapeRows > 0) { + $this->terminal->moveCursorUp($this->lastSubmitEscapeRows); + } + $this->terminal->endFrameRender(); + + $this->frameRenderer->addHistoryLines($this->lastSubmittedText, $this->isCommandInput($this->lastSubmittedText)); + + $this->continueFrame = false; + } else { + $this->frameRenderer->reset(); + } + + $this->multilineMode = false; + + $buffer = new Buffer($this->requireSemicolons); + $this->display($buffer); + + try { + while (true) { + $key = $this->inputQueue->read(); + + if ($key->isEof()) { + $this->escapeCurrentFrameForAbort($buffer); + + return false; + } + + // Any keystroke clears error mode + $this->setInputFrameError(false); + + if ($key->isPaste()) { + $this->handlePastedContent($key->getValue(), $buffer); + $this->syncMultilineMode($buffer->getText()); + $this->display($buffer); + continue; + } + + if ($this->search->isActive()) { + $result = $this->search->handleInput($key, $buffer); + if ($result === true) { + $this->search->display(); + } else { + if ($result === null) { + $this->replayKey($key); + } + $this->syncMultilineMode($buffer->getText()); + $this->display($buffer); + } + continue; + } + + $action = $this->bindings->get($key); + + if ($action === null && $key->isChar()) { + $action = new SelfInsertAction($key->getValue()); + } + + if ($action !== null) { + $textBefore = $buffer->getText(); + $continue = $action->execute($buffer, $this->terminal, $this); + + if ($continue) { + // Any buffer mutation outside of history navigation exits history mode. + if ($this->history->isInHistory() + && $buffer->getText() !== $textBefore + && !$action instanceof PreviousHistoryAction + && !$action instanceof NextHistoryAction + ) { + $this->history->reset(); + } + + if ($this->search->isActive()) { + $this->search->display(); + } else { + $this->syncMultilineMode($buffer->getText()); + $this->updateSuggestion($buffer); + $this->display($buffer); + } + } else { + $line = $buffer->getText(); + $this->clearSuggestion(); + + if (!$this->isCommand($line) || $this->isInOpenStringOrComment($line)) { + $this->exitMultilineMode(); + } + + $this->history->reset(); + $this->lastSubmittedText = $line; + + return $line; + } + } else { + $this->terminal->bell(); + } + } + } catch (BreakException $e) { + // Shell.php will write the newline + return false; + } + } + + /** + * Handle pasted content (potentially multi-line). + */ + private function handlePastedContent(string $content, Buffer $buffer): void + { + $content = \strtr(\str_replace("\r\n", "\n", $content), "\r", "\n"); + + $buffer->insert($content); + } + + /** + * Display the prompt and buffer. + */ + private function display(Buffer $buffer): void + { + $searchTerm = $this->history->isInHistory() ? $this->history->getSearchTerm() : null; + $text = $buffer->getText(); + $this->frameRenderer->render($buffer, $this->currentSuggestion, $searchTerm, $this->isCommandInput($text)); + } + + /** + * Clear the overlay and re-render. + */ + public function clearOverlay(Buffer $buffer): void + { + $this->frameRenderer->clearOverlay($buffer); + } + + /** + * Render overlay lines and redraw the frame. + * + * @param string[] $lines + */ + public function renderOverlay(Buffer $buffer, array $lines): void + { + $this->frameRenderer->setOverlayLines($lines); + $this->display($buffer); + } + + /** + * Read the next key event from the queue. + */ + public function readNextKey(): Key + { + return $this->inputQueue->read(); + } + + /** + * Replay a key event so the main loop can consume it. + */ + public function replayKey(Key $key): void + { + $this->inputQueue->replay($key); + } + + /** + * Internal accessor for interactive readline internals and tests. + * + * @internal + */ + public function getTabAction(): ?TabAction + { + return $this->tabAction; + } + + /** + * Get available overlay rows for completion/search UI. + */ + public function getOverlayAvailableRows(bool $collapsed): int + { + return $this->overlayViewport->getAvailableRows($collapsed); + } + + /** + * Set the input frame error state (red-tinted background for syntax errors). + */ + public function setInputFrameError(bool $error): void + { + $this->frameRenderer->setErrorMode($error); + } + + /** + * Clear previously submitted lines from the current input frame. + */ + public function clearPreviousLines(): void + { + $this->frameRenderer->clearHistoryLines(); + } + + /** + * Set whether the next readline() call should continue the current frame. + */ + public function setContinueFrame(bool $continue): void + { + $this->continueFrame = $continue; + } + + /** + * Store the number of newlines written by SubmitLineAction to escape the frame. + */ + public function setLastSubmitEscapeRows(int $rows): void + { + $this->lastSubmitEscapeRows = $rows; + } + + /** + * Escape below the current frame before aborting back to Shell.php. + * + * Shell.php writes the final newline after readline returns false or a + * BreakException bubbles up, so only escape the remaining frame rows here. + */ + public function escapeCurrentFrameForAbort(Buffer $buffer): void + { + $lineCount = \substr_count($buffer->getText(), "\n") + 1; + $remainingInputLines = $lineCount - $buffer->getCurrentLineNumber(); + $escapeRows = \max(0, $remainingInputLines + $this->getInputFrameOuterRowCount() - 1); + + if ($escapeRows > 0) { + $this->terminal->write(\str_repeat("\n", $escapeRows)); + } + } + + /** + * Get the history. + */ + public function getHistory(): History + { + return $this->history; + } + + /** + * Enable or disable inline suggestions. + */ + public function setUseSuggestions(bool $enabled): void + { + $this->useSuggestions = $enabled; + } + + /** + * Enable or disable syntax highlighting. + */ + public function setUseSyntaxHighlighting(bool $enabled): void + { + $this->frameRenderer->setUseSyntaxHighlighting($enabled); + } + + /** + * Get the suggestion engine. + */ + public function getSuggestionEngine(): SuggestionEngine + { + return $this->suggestionEngine; + } + + /** + * Get the current suggestion. + */ + public function getCurrentSuggestion(): ?SuggestionResult + { + return $this->currentSuggestion; + } + + /** + * Clear the current suggestion. + */ + public function clearSuggestion(): void + { + $this->currentSuggestion = null; + $this->suggestionEngine->clearCache(); + } + + /** + * Update suggestion based on current buffer state. + */ + private function updateSuggestion(Buffer $buffer): void + { + if (!$this->useSuggestions) { + return; + } + + if ($this->mode !== self::MODE_NORMAL || $this->search->isActive() || $this->multilineMode) { + $this->clearSuggestion(); + + return; + } + + $this->currentSuggestion = $this->suggestionEngine->getSuggestion( + $buffer->getText(), + $buffer->getCursor() + ); + } + + /** + * Get the history search state machine. + */ + public function getSearch(): HistorySearch + { + return $this->search; + } + + /** + * Enter completion menu mode. + */ + public function enterMenuMode(): void + { + $this->mode = self::MODE_MENU; + } + + /** + * Exit completion menu mode. + */ + public function exitMenuMode(): void + { + if ($this->mode === self::MODE_MENU) { + $this->mode = self::MODE_NORMAL; + } + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Renderer/FrameRenderer.php b/app/vendor/psy/psysh/src/Readline/Interactive/Renderer/FrameRenderer.php new file mode 100644 index 000000000..dee662a1a --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Renderer/FrameRenderer.php @@ -0,0 +1,646 @@ + Cached row counts keyed by line content. */ + private array $lineRowCache = []; + + /** @var array Cached prompt widths keyed by "line:decorated". */ + private array $promptWidthCache = []; + + public function __construct(Terminal $terminal, OverlayViewport $viewport, ?Theme $theme = null) + { + $this->terminal = $terminal; + $this->viewport = $viewport; + $this->theme = $theme ?? new Theme(); + $this->commandHighlighter = new CommandHighlighter(); + } + + /** + * Get the command highlighter for CommandAware registration. + */ + public function getCommandHighlighter(): CommandHighlighter + { + return $this->commandHighlighter; + } + + /** + * Set the theme for prompt strings and compact mode. + */ + public function setTheme(Theme $theme): void + { + $this->theme = $theme; + $this->promptWidthCache = []; + } + + /** + * Enable or disable syntax highlighting for input rendering. + */ + public function setUseSyntaxHighlighting(bool $enabled): void + { + $this->useSyntaxHighlighting = $enabled; + } + + /** + * Check whether compact input frame rendering is enabled. + */ + public function isCompactInputFrame(): bool + { + return $this->theme->compact(); + } + + /** + * Set the error mode for the input frame. + */ + public function setErrorMode(bool $error): void + { + $this->errorMode = $error; + } + + /** + * Get number of outer rows surrounding input content. + */ + public function getInputFrameOuterRowCount(): int + { + return $this->theme->compact() ? 0 : self::INPUT_FRAME_PADDING_ROWS; + } + + /** + * Get active prompt display width for the cursor's current line. + */ + public function getPromptWidthForCurrentLine(Buffer $buffer): int + { + $lineNumber = 0; + if (\strpos($buffer->getText(), "\n") !== false) { + $lineNumber = $buffer->getCurrentLineNumber(); + } + + return $this->getPromptWidthForLine($lineNumber, $this->terminal->getFormatter()); + } + + /** + * Get the prompt string for a given line number. + */ + private function getPromptForLine(int $lineNumber): string + { + return $lineNumber === 0 ? $this->theme->prompt() : $this->theme->bufferPrompt(); + } + + /** + * Get the display width of the prompt for a given line number. + */ + private function getPromptWidthForLine(int $lineNumber, ?OutputFormatterInterface $formatter = null): int + { + $key = ($lineNumber === 0 ? '0' : '1').($formatter !== null ? ':f' : ':p'); + if (isset($this->promptWidthCache[$key])) { + return $this->promptWidthCache[$key]; + } + + $prompt = $this->getPromptForLine($lineNumber); + $width = ($formatter === null) + ? DisplayString::width($prompt) + : DisplayString::widthWithoutFormatting($prompt, $formatter); + + $this->promptWidthCache[$key] = $width; + + return $width; + } + + /** + * Add a previously submitted input to the in-frame history. + */ + public function addHistoryLines(string $text, bool $isCommand = false): void + { + $newLines = $this->formatHighlightedLinesWithPrompts($this->formatInputLines($text, null, $isCommand)); + \array_push($this->historyLines, ...$newLines); + + foreach ($newLines as $line) { + $this->historyRowCount += $this->lineRowCount($line); + } + } + + /** + * Clear previously submitted lines rendered above the current input. + */ + public function clearHistoryLines(): void + { + $this->historyLines = []; + $this->historyRowCount = 0; + } + + /** + * Set overlay lines to display below the input. + * + * @param string[] $lines + */ + public function setOverlayLines(array $lines): void + { + $this->overlayLines = $lines; + } + + /** + * Clear the overlay and re-render. + */ + public function clearOverlay(Buffer $buffer): void + { + $this->overlayLines = []; + $this->render($buffer, null); + } + + /** + * Render the full frame (input + overlay) to the terminal. + */ + public function render(Buffer $buffer, ?SuggestionResult $suggestion, ?string $historySearchTerm = null, bool $isCommand = false): void + { + $isMultiline = \strpos($buffer->getText(), "\n") !== false; + $inputLines = $this->buildInputLines($buffer, $isMultiline, $suggestion, $historySearchTerm, $isCommand); + + $this->viewport->setInputRowCount($this->getFrameRowCount($inputLines)); + + $frame = \array_merge($inputLines, $this->overlayLines); + + [$cursorRow, $cursorColumn] = $this->getCursorPosition($buffer, $isMultiline); + + $this->syncFrame($frame, $cursorRow, $cursorColumn); + $this->terminal->flush(); + } + + /** + * Render the search UI: preview in the input frame, search field + results below. + * + * @param string $previewText Text to show in the input frame as a preview + * @param string $searchPrompt The search field line (cursor goes here) + */ + public function renderSearchFrame(string $previewText, string $searchPrompt): void + { + // Show a concise, truncated preview on the prompt line. + $promptLine = $this->getPromptForLine(0); + if ($previewText !== '') { + $collapsed = History::collapseToSingleLine($previewText); + $promptWidth = $this->getPromptWidthForLine(0, $this->terminal->getFormatter()); + $maxWidth = $this->getTerminalWidth() - $promptWidth; + $truncated = DisplayString::truncate($collapsed, $maxWidth, true); + $promptLine .= OutputFormatter::escape($truncated); + } + + $inputLines = $this->wrapInInputFrame([$promptLine]); + + $inputRowCount = $this->getFrameRowCount($inputLines); + $searchPromptRows = $this->lineRowCount($searchPrompt); + $this->viewport->setInputRowCount($inputRowCount + $searchPromptRows); + + // Frame = input frame + search field + overlay results + $frame = \array_merge($inputLines, [$searchPrompt], $this->overlayLines); + + // Position cursor at end of search prompt, below the input frame + $calculator = $this->getSoftWrapCalculator(); + $absoluteColumn = DisplayString::widthWithoutAnsi($searchPrompt) + 1; + $searchLineRow = $this->getRowOffsetBeforeLine($frame, \count($inputLines)); + $cursorRow = $searchLineRow + $calculator->rowOffsetForAbsoluteColumn($absoluteColumn); + $cursorColumn = $calculator->normalizeColumn($absoluteColumn); + + $this->syncFrame($frame, $cursorRow, $cursorColumn); + $this->terminal->flush(); + } + + /** + * Reset renderer state (call when starting a new readline session). + */ + public function reset(): void + { + $this->previousFrame = []; + $this->cursorFrameRow = 0; + $this->overlayLines = []; + $this->historyLines = []; + $this->historyRowCount = 0; + $this->errorMode = false; + $this->lastTerminalWidth = null; + $this->lastTerminalHeight = null; + $this->lineRowCache = []; + } + + /** + * Build the input section of the frame. + * + * @return string[] + */ + private function buildInputLines(Buffer $buffer, bool $isMultiline, ?SuggestionResult $suggestion, ?string $historySearchTerm = null, bool $isCommand = false): array + { + $text = $buffer->getText(); + $contentLines = []; + if ($isMultiline) { + $contentLines = $this->formatHighlightedLinesWithPrompts($this->formatInputLines($text, $historySearchTerm, $isCommand)); + } else { + $line = $this->getPromptForLine(0).\implode("\n", $this->formatInputLines($text, $historySearchTerm, $isCommand)); + + if ($suggestion !== null) { + $line = $this->appendSuggestionGhostText($line, $buffer, $text, $suggestion); + } + + $contentLines[] = $line; + } + + return $this->wrapInInputFrame($contentLines); + } + + /** + * Wrap content lines in the input frame (background, padding). + * + * @param string[] $contentLines + * + * @return string[] + */ + private function wrapInInputFrame(array $contentLines): array + { + if ($this->theme->compact()) { + return \array_merge($this->historyLines, $contentLines); + } + + $styleName = $this->errorMode ? 'input_frame_error' : 'input_frame'; + $formatter = $this->terminal->getFormatter(); + $inputFrameStyle = ($formatter->isDecorated() && $formatter->hasStyle($styleName)) + ? $formatter->getStyle($styleName) + : null; + + $framedLines = ['']; + foreach (['', ...$this->historyLines, ...$contentLines, ''] as $line) { + $lineWithClear = $line.self::CLEAR_TO_END_OF_LINE; + $framedLines[] = $inputFrameStyle ? $inputFrameStyle->apply($lineWithClear) : $lineWithClear; + } + $framedLines[] = ''; + + return $framedLines; + } + + /** + * Format raw input text into prompt-prefixed lines. + * + * @return string[] + */ + private function formatHighlightedLinesWithPrompts(array $lines): array + { + $result = []; + foreach ($lines as $i => $line) { + $result[] = $this->getPromptForLine($i).$line; + } + + return $result; + } + + /** + * Highlight all occurrences of a search term in text. + * + * Uses smart case (case-insensitive unless the term contains uppercase). + */ + private function highlightSearchTerm(string $text, string $term): string + { + $formatter = $this->terminal->getFormatter(); + if (!$formatter->isDecorated() || !$formatter->hasStyle('input_highlight')) { + return $text; + } + + $style = $formatter->getStyle('input_highlight'); + $pattern = '/'.\preg_quote($term, '/').'/u'.(History::isSearchCaseSensitive($term) ? '' : 'i'); + $highlighted = \preg_replace_callback($pattern, fn (array $match) => $style->apply($match[0]), $text); + + return $highlighted ?? $text; + } + + /** + * Append single-line suggestion ghost text when there is room. + */ + private function appendSuggestionGhostText(string $line, Buffer $buffer, string $text, SuggestionResult $suggestion): string + { + // Completion overlays own the viewport; don't mix ghost text with menus. + if (!empty($this->overlayLines)) { + return $line; + } + + $absoluteCursorColumn = $this->getPromptWidthForLine(0, $this->terminal->getFormatter()) + + DisplayString::width(\mb_substr($text, 0, $buffer->getCursor())) + 1; + $cursorColumn = $this->getSoftWrapCalculator()->normalizeColumn($absoluteCursorColumn); + $maxWidth = $this->getTerminalWidth() - $cursorColumn + 1; + if ($maxWidth <= 0) { + return $line; + } + + $suggestionText = DisplayString::truncate($suggestion->getDisplayText(), $maxWidth, true); + if ($suggestionText === '') { + return $line; + } + + return $line.$this->terminal->format(''.OutputFormatter::escape($suggestionText).''); + } + + /** + * Get the wrapped frame row and terminal column where the cursor should be. + * + * @return array{int, int} + */ + private function getCursorPosition(Buffer $buffer, bool $isMultiline): array + { + $text = $buffer->getText(); + $historyRowOffset = $this->historyRowCount; + + if ($isMultiline) { + $lines = \explode("\n", $text); + $lineNum = $buffer->getCurrentLineNumber(); + $promptWidth = $this->getPromptWidthForLine($lineNum, $this->terminal->getFormatter()); + + $charsBeforeLine = 0; + $rowsBeforeLine = 0; + for ($i = 0; $i < $lineNum; $i++) { + $charsBeforeLine += \mb_strlen($lines[$i]) + 1; + $rowsBeforeLine += $this->lineRowCount($this->getPromptForLine($i).($lines[$i] ?? '')); + } + + $lineText = $lines[$lineNum] ?? ''; + $cursorInLine = \max(0, \min(\mb_strlen($lineText), $buffer->getCursor() - $charsBeforeLine)); + $textBeforeCursor = \mb_substr($lineText, 0, $cursorInLine); + + $absoluteColumn = $promptWidth + DisplayString::width($textBeforeCursor) + 1; + $calculator = $this->getSoftWrapCalculator(); + + return [ + $this->getInputFrameOuterRowCount() + $historyRowOffset + $rowsBeforeLine + $calculator->rowOffsetForAbsoluteColumn($absoluteColumn), + $calculator->normalizeColumn($absoluteColumn), + ]; + } + + $textBeforeCursor = \mb_substr($text, 0, $buffer->getCursor()); + $absoluteColumn = $this->getPromptWidthForLine(0, $this->terminal->getFormatter()) + + DisplayString::width($textBeforeCursor) + 1; + $calculator = $this->getSoftWrapCalculator(); + + return [ + $this->getInputFrameOuterRowCount() + $historyRowOffset + $calculator->rowOffsetForAbsoluteColumn($absoluteColumn), + $calculator->normalizeColumn($absoluteColumn), + ]; + } + + /** + * Sync a new frame to the terminal. + * + * @param string[] $newFrame + */ + private function syncFrame(array $newFrame, int $cursorRow, int $cursorColumn): void + { + $terminalWidth = $this->getTerminalWidth(); + $terminalHeight = \max(1, $this->terminal->getHeight()); + $sizeChanged = $this->lastTerminalWidth !== null && ( + $terminalWidth !== $this->lastTerminalWidth || $terminalHeight !== $this->lastTerminalHeight + ); + $dirty = $this->terminal->isDirty(); + + $oldFrame = ($sizeChanged || $dirty) ? [] : $this->previousFrame; + $firstChangedLine = $this->findFirstChangedLine($oldFrame, $newFrame); + + // Wrapped row tracking is invalid after row-affecting out-of-band writes/resizes, + // or if we can no longer trust the previous frame contents. + if ($sizeChanged || $this->terminal->isCursorRowUnknown()) { + $this->cursorFrameRow = 0; + } + + $this->terminal->beginFrameRender(); + + try { + $currentRow = $this->cursorFrameRow; + + if ($firstChangedLine !== null) { + $oldStartRow = $this->getRowOffsetBeforeLine($oldFrame, $firstChangedLine); + $newStartRow = $this->getRowOffsetBeforeLine($newFrame, $firstChangedLine); + + $currentRow = $this->moveCursorToRow($currentRow, $oldStartRow); + + $this->terminal->write("\r"); + $this->terminal->clearToEndOfScreen(); + + $suffix = \array_slice($newFrame, $firstChangedLine); + foreach ($suffix as $i => $line) { + if ($i > 0) { + $this->terminal->write("\n"); + } + $this->terminal->write($line); + } + + $currentRow = empty($suffix) + ? $newStartRow + : $newStartRow + $this->getFrameRowCount($suffix) - 1; + } + + $currentRow = $this->moveCursorToRow($currentRow, $cursorRow); + + $this->terminal->moveCursorToColumn($cursorColumn); + + $this->previousFrame = $newFrame; + $this->cursorFrameRow = $cursorRow; + $this->lastTerminalWidth = $terminalWidth; + $this->lastTerminalHeight = $terminalHeight; + } finally { + $this->terminal->endFrameRender(); + } + } + + /** + * Count how many terminal rows a frame occupies after soft wrapping. + * + * @param string[] $frame + */ + private function getFrameRowCount(array $frame): int + { + $rows = 0; + foreach ($frame as $line) { + $rows += $this->lineRowCount($line); + } + + return \max(1, $rows); + } + + /** + * Count wrapped terminal rows for a single logical line. + */ + private function lineRowCount(string $line): int + { + if (isset($this->lineRowCache[$line])) { + return $this->lineRowCache[$line]; + } + + $width = DisplayString::widthWithoutAnsi($line); + $rows = $this->getSoftWrapCalculator()->rowCountForDisplayWidth($width); + $this->lineRowCache[$line] = $rows; + + return $rows; + } + + /** + * Format input into ANSI-safe lines for prompt rendering. + * + * @return string[] + */ + private function formatInputLines(string $text, ?string $historySearchTerm = null, bool $isCommand = false): array + { + if ($text === '') { + return ['']; + } + + if ($historySearchTerm !== null) { + return \explode("\n", $this->highlightSearchTerm($text, $historySearchTerm)); + } + + if (!$this->useSyntaxHighlighting) { + return \explode("\n", $text); + } + + if ($isCommand) { + return $this->commandHighlighter->highlightLines($text, $this->terminal->getFormatter()); + } + + return CodeFormatter::formatInputLines($text, $this->terminal->getFormatter()); + } + + private function getTerminalWidth(): int + { + return \max(1, $this->terminal->getWidth()); + } + + /** + * Recalculate the cached history row count after line row cache invalidation. + */ + private function recalculateHistoryRowCount(): void + { + $this->historyRowCount = 0; + foreach ($this->historyLines as $line) { + $this->historyRowCount += $this->lineRowCount($line); + } + } + + private function getSoftWrapCalculator(): SoftWrapCalculator + { + $width = $this->getTerminalWidth(); + if ($this->softWrapCalculator === null || $this->softWrapCachedWidth !== $width) { + $this->softWrapCalculator = new SoftWrapCalculator($width); + $this->softWrapCachedWidth = $width; + $this->lineRowCache = []; + $this->recalculateHistoryRowCount(); + } + + return $this->softWrapCalculator; + } + + /** + * Find the first logical line that differs between two frames. + * + * @param string[] $oldFrame + * @param string[] $newFrame + */ + private function findFirstChangedLine(array $oldFrame, array $newFrame): ?int + { + $oldCount = \count($oldFrame); + $newCount = \count($newFrame); + $sharedCount = \min($oldCount, $newCount); + + for ($i = 0; $i < $sharedCount; $i++) { + if ($oldFrame[$i] !== $newFrame[$i]) { + return $i; + } + } + + if ($oldCount !== $newCount) { + return $sharedCount; + } + + return null; + } + + /** + * Get total wrapped rows occupied by lines before the given logical line index. + * + * @param string[] $frame + */ + private function getRowOffsetBeforeLine(array $frame, int $lineIndex): int + { + $rows = 0; + $lineIndex = \max(0, \min($lineIndex, \count($frame))); + + for ($i = 0; $i < $lineIndex; $i++) { + $rows += $this->lineRowCount($frame[$i]); + } + + return $rows; + } + + /** + * Move cursor vertically between wrapped frame rows. + */ + private function moveCursorToRow(int $currentRow, int $targetRow): int + { + if ($targetRow < $currentRow) { + $this->terminal->moveCursorUp($currentRow - $targetRow); + } elseif ($targetRow > $currentRow) { + $this->terminal->moveCursorDown($targetRow - $currentRow); + } + + return $targetRow; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Renderer/OverlayViewport.php b/app/vendor/psy/psysh/src/Readline/Interactive/Renderer/OverlayViewport.php new file mode 100644 index 000000000..3318f4fba --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Renderer/OverlayViewport.php @@ -0,0 +1,67 @@ +terminal = $terminal; + } + + /** + * Update how many terminal rows the input currently occupies. + * + * Called by FrameRenderer after each render. + */ + public function setInputRowCount(int $rows): void + { + $this->inputRowCount = \max(1, $rows); + } + + /** + * Get the maximum number of rows available for overlay content. + * + * Subtracts the input height from the terminal height, reserving + * one row for breathing room. In compact mode, also caps at half + * the terminal height. + * + * @param bool $compact If true, use at most half the terminal height + */ + public function getAvailableRows(bool $compact = false): int + { + $terminalHeight = $this->terminal->getHeight(); + + // Reserve 1 row for status line / breathing room + $available = $terminalHeight - $this->inputRowCount - 1; + + if ($compact) { + $halfTerminal = (int) \floor($terminalHeight / 2); + $available = \min($available, $halfTerminal); + } + + return \max(1, $available); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/FrecencyIndex.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/FrecencyIndex.php new file mode 100644 index 000000000..960044a25 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/FrecencyIndex.php @@ -0,0 +1,179 @@ +buildIndex($history); + } + + /** + * Get frecency score for a word. + * + * Returns 0.0 for unknown words. + */ + public function getScore(string $word): float + { + return $this->scores[\strtolower($word)] ?? 0.0; + } + + /** + * Get all scored words. + * + * @return float[] Keyed by word + */ + public function getAllScores(): array + { + return $this->scores; + } + + /** + * Check if a word exists in the index. + */ + public function hasWord(string $word): bool + { + return isset($this->scores[\strtolower($word)]); + } + + /** + * Build the frecency index from history entries. + */ + private function buildIndex(History $history): void + { + $now = \time(); + $windowStart = $now - (self::RECENCY_WINDOW * 86400); // Days to seconds + + $historyCount = $history->getCount(); + DebugLog::log('FrecencyIndex', 'BUILD_START', [ + 'history_count' => $historyCount, + 'window_days' => self::RECENCY_WINDOW, + ]); + + $wordData = []; + $processedEntries = 0; + + foreach ($history->getAll() as $entry) { + $timestamp = $entry['timestamp'] ?? $now; + + if ($timestamp < $windowStart) { + continue; + } + + $processedEntries++; + + $words = $this->extractWords($entry['command']); + + $age = ($now - $timestamp) / 86400; + + $recencyWeight = \pow(self::RECENCY_DECAY, $age); + + if ($processedEntries <= 3) { + DebugLog::log('FrecencyIndex', 'ENTRY', [ + 'num' => $processedEntries, + 'age' => \sprintf('%.1f', $age).'d', + 'weight' => \sprintf('%.3f', $recencyWeight), + 'words' => \implode(', ', $words), + ]); + } + + foreach ($words as $word) { + if (!isset($wordData[$word])) { + $wordData[$word] = [ + 'count' => 0, + 'totalWeight' => 0.0, + ]; + } + + $wordData[$word]['count']++; + $wordData[$word]['totalWeight'] += $recencyWeight; + } + } + + DebugLog::log('FrecencyIndex', 'PROCESSED', [ + 'entries' => $processedEntries, + 'words' => \count($wordData), + ]); + + foreach ($wordData as $word => $data) { + $avgRecency = $data['totalWeight'] / $data['count']; + $frequency = $data['count']; + $score = $frequency * $avgRecency; + $this->scores[$word] = \min(100.0, $score * 10); + } + + \arsort($this->scores); + + $top = \array_slice($this->scores, 0, 10, true); + foreach ($top as $word => $score) { + $count = $wordData[$word]['count']; + $avgRec = $wordData[$word]['totalWeight'] / $count; + DebugLog::log('FrecencyIndex', 'TOP_WORD', [ + 'word' => $word, + 'score' => \sprintf('%.1f', $score), + 'freq' => $count, + 'avg_recency' => \sprintf('%.3f', $avgRec), + ]); + } + } + + /** + * Extract meaningful words from a command. + * + * @return string[] Normalized word list + */ + private function extractWords(string $command): array + { + return \array_values(\array_filter( + WordExtractor::extractNormalizedIdentifiers($command), + fn (string $word): bool => !\ctype_digit($word) && !\in_array($word, self::STOPWORDS, true) + )); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/CallSignatureSource.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/CallSignatureSource.php new file mode 100644 index 000000000..bc0f4c2ff --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/CallSignatureSource.php @@ -0,0 +1,155 @@ + Cached formatted signatures keyed by function name. */ + private array $signatureCache = []; + + /** + * {@inheritdoc} + */ + public function getSuggestion(string $buffer, int $cursorPosition): ?SuggestionResult + { + if (\preg_match('/(?:->|::)\s*[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*\(\s*$/u', $buffer)) { + return null; + } + + if (!\preg_match('/([a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*)\(\s*$/u', $buffer, $matches)) { + return null; + } + + $functionName = $matches[1]; + + $signature = $this->getFunctionSignature($functionName); + + if ($signature === null) { + return null; + } + + return SuggestionResult::forAppend( + $signature, + SuggestionResult::SOURCE_CALL_SIGNATURE, + $cursorPosition, + $signature.')' + ); + } + + /** + * {@inheritdoc} + */ + public function getPriority(): int + { + return 150; // Highest priority - very specific context + } + + /** + * Get function signature for display. + * + * Returns parameter list like: $array1, $array2, ...$arrays + */ + private function getFunctionSignature(string $functionName): ?string + { + if (\array_key_exists($functionName, $this->signatureCache)) { + return $this->signatureCache[$functionName]; + } + + $signature = null; + try { + if (\function_exists($functionName)) { + $reflection = new \ReflectionFunction($functionName); + $signature = $this->formatParameters($reflection->getParameters()); + } + } catch (\ReflectionException $e) { + // Leave as null. + } + + $this->signatureCache[$functionName] = $signature; + + return $signature; + } + + /** + * Format reflection parameters into readable signature. + * + * @param \ReflectionParameter[] $parameters + */ + private function formatParameters(array $parameters): string + { + if (empty($parameters)) { + return ''; + } + + $parts = []; + + foreach ($parameters as $param) { + $paramStr = ''; + + if ($param->isVariadic()) { + $paramStr .= '...'; + } + + $paramStr .= '$'.$param->getName(); + + if ($param->isOptional() && !$param->isVariadic()) { + $paramStr .= ' = '.$this->formatDefaultValue($param); + } + + $parts[] = $paramStr; + } + + return \implode(', ', $parts); + } + + /** + * Format a parameter's default value for display in the signature. + */ + private function formatDefaultValue(\ReflectionParameter $parameter): string + { + try { + $default = $parameter->getDefaultValue(); + } catch (\ReflectionException $e) { + return '...'; + } + + if ($default === null) { + return 'null'; + } + + if (\is_bool($default)) { + return $default ? 'true' : 'false'; + } + + if (\is_string($default)) { + if (\strlen($default) > 20) { + return '"'.\substr($default, 0, 17).'..."'; + } + + return '"'.$default.'"'; + } + + if (\is_array($default)) { + return '[]'; + } + + return \var_export($default, true); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/ContextAwareSource.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/ContextAwareSource.php new file mode 100644 index 000000000..32c700410 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/ContextAwareSource.php @@ -0,0 +1,71 @@ +completer = $completer; + } + + /** + * {@inheritdoc} + */ + public function getSuggestion(string $buffer, int $cursorPosition): ?SuggestionResult + { + $completions = $this->completer->getCompletions( + new CompletionRequest($buffer, $cursorPosition, CompletionRequest::MODE_SUGGESTION) + ); + + if (empty($completions)) { + return null; + } + + $completion = $completions[0]; + $currentWord = CurrentWord::extract($buffer, $cursorPosition); + + if ($currentWord !== '' && \stripos($completion, $currentWord) === 0) { + $suffix = \substr($completion, \strlen($currentWord)); + } else { + $suffix = $completion; + } + + return SuggestionResult::forAppend( + $suffix, + SuggestionResult::SOURCE_CONTEXT_AWARE, + $cursorPosition + ); + } + + /** + * {@inheritdoc} + */ + public function getPriority(): int + { + // High priority, but lower than history (which should be 100) + // We want context-aware to kick in when history doesn't match + return 90; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/HistorySource.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/HistorySource.php new file mode 100644 index 000000000..bc8f09fae --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/HistorySource.php @@ -0,0 +1,69 @@ +history = $history; + } + + /** + * {@inheritdoc} + */ + public function getSuggestion(string $buffer, int $cursorPosition): ?SuggestionResult + { + // Search history most-recent first. + $entries = $this->history->getAll(); + for ($i = \count($entries) - 1; $i >= 0; $i--) { + $entry = $entries[$i]; + $line = $entry['command']; + + if (\strpos($line, $buffer) === 0 && $line !== $buffer) { + $acceptText = \substr($line, \strlen($buffer)); + $displayText = $acceptText; + if ($entry['lines'] > 1) { + $displayText = History::collapseToSingleLine($acceptText); + } + + return SuggestionResult::forAppend( + $displayText, + SuggestionResult::SOURCE_HISTORY, + $cursorPosition, + $acceptText + ); + } + } + + return null; + } + + /** + * {@inheritdoc} + */ + public function getPriority(): int + { + return 100; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/SourceInterface.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/SourceInterface.php new file mode 100644 index 000000000..227a767df --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/Source/SourceInterface.php @@ -0,0 +1,35 @@ +history = $history; + + $this->sources = [ + new CallSignatureSource(), + new HistorySource($history), + ]; + + $this->sortSources(); + + $this->filter = new SuggestionFilter(); + + DebugLog::log('SuggestionEngine', 'INIT', ['sources' => \count($this->sources)]); + } + + /** + * Get suggestion for current buffer state. + * + * Only suggests when cursor is at end of buffer. + * + * @param string $buffer Current input buffer + * @param int $cursorPosition Current cursor position + * + * @return SuggestionResult|null + */ + public function getSuggestion(string $buffer, int $cursorPosition): ?SuggestionResult + { + // @todo should this be multi-line aware? + if ($cursorPosition !== \mb_strlen($buffer)) { + DebugLog::log('Suggestion', 'SKIP', ['reason' => 'cursor_not_at_end', 'pos' => $cursorPosition, 'len' => \mb_strlen($buffer)]); + + return null; + } + + if (\trim($buffer) === '') { + DebugLog::log('Suggestion', 'SKIP', ['reason' => 'empty_buffer']); + + return null; + } + + $historyRevision = $this->history->getRevision(); + + if ($historyRevision !== $this->lastHistoryRevision) { + $this->frecencyInitialized = false; + } + + if ($buffer === $this->lastBuffer && + $cursorPosition === $this->lastCursorPosition && + $historyRevision === $this->lastHistoryRevision && + $this->lastSuggestion !== null) { + DebugLog::log('Suggestion', 'CACHE_HIT', ['text' => $this->lastSuggestion->getDisplayText(), 'source' => $this->lastSuggestion->getSource()]); + + return $this->lastSuggestion; + } + + $candidates = []; + foreach ($this->sources as $source) { + $suggestion = $source->getSuggestion($buffer, $cursorPosition); + if ($suggestion !== null && $this->filter->isValid($buffer, $suggestion->getDisplayText())) { + $candidates[] = $suggestion; + DebugLog::log('Suggestion', 'CANDIDATE', ['source' => $suggestion->getSource(), 'text' => $suggestion->getDisplayText()]); + } + } + + $best = null; + if (!empty($candidates)) { + $this->ensureFrecencyIndex(); + DebugLog::log('SuggestionEngine', 'SCORING', ['candidates' => \count($candidates)]); + $best = $this->selectBestCandidate($buffer, $candidates); + DebugLog::log('Suggestion', 'SHOW', ['text' => $best->getDisplayText(), 'source' => $best->getSource(), 'buffer' => $buffer]); + } else { + DebugLog::log('Suggestion', 'NONE', ['buffer' => $buffer]); + } + + $this->lastBuffer = $buffer; + $this->lastCursorPosition = $cursorPosition; + $this->lastHistoryRevision = $historyRevision; + $this->lastSuggestion = $best; + + return $best; + } + + /** + * Clear cached suggestion. + */ + public function clearCache(): void + { + if ($this->lastSuggestion !== null) { + DebugLog::log('Suggestion', 'CACHE_CLEAR', ['had_suggestion' => true]); + } + + $this->lastSuggestion = null; + $this->lastBuffer = ''; + $this->lastCursorPosition = -1; + $this->lastHistoryRevision = -1; + } + + /** + * Add a suggestion source. + */ + public function addSource(SourceInterface $source): void + { + $this->sources[] = $source; + $this->sortSources(); + $this->clearCache(); + } + + /** + * Sort sources by priority, highest first. + */ + private function sortSources(): void + { + \usort($this->sources, fn (SourceInterface $a, SourceInterface $b) => $b->getPriority() <=> $a->getPriority()); + } + + /** + * Build and attach the frecency index on first scoring operation. + */ + private function ensureFrecencyIndex(): void + { + if ($this->frecencyInitialized) { + return; + } + + $startedAt = \microtime(true); + $frecencyIndex = new FrecencyIndex($this->history); + $this->filter->setFrecencyIndex($frecencyIndex); + $this->frecencyInitialized = true; + + DebugLog::log('SuggestionEngine', 'FRECENCY_READY', [ + 'words' => \count($frecencyIndex->getAllScores()), + 'ms' => \sprintf('%.1f', (\microtime(true) - $startedAt) * 1000), + ]); + } + + /** + * Score candidates once and return the best one. + * + * Keeps source-order as a deterministic tie-breaker. + * + * @param SuggestionResult[] $candidates + */ + private function selectBestCandidate(string $buffer, array $candidates): SuggestionResult + { + $scored = []; + foreach ($candidates as $index => $candidate) { + $scored[] = [ + 'suggestion' => $candidate, + 'score' => $this->filter->score($buffer, $candidate), + 'index' => $index, + ]; + } + + \usort($scored, static function (array $a, array $b): int { + if ($a['score'] !== $b['score']) { + return $b['score'] <=> $a['score']; + } + + return $a['index'] <=> $b['index']; + }); + + return $scored[0]['suggestion']; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/SuggestionFilter.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/SuggestionFilter.php new file mode 100644 index 000000000..f0a156762 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/SuggestionFilter.php @@ -0,0 +1,147 @@ +frecencyIndex = $index; + } + + /** + * Check if suggestion is valid for the given buffer context. + * + * @param string $buffer Current input buffer + * @param string $suggestion Proposed suggestion text + * + * @return bool + */ + public function isValid(string $buffer, string $suggestion): bool + { + if (\trim($suggestion) === '') { + return false; + } + + if ($this->isAfterObjectOperator($buffer)) { + return !$this->looksLikeFunction($buffer.$suggestion); + } + + return true; + } + + /** + * Score a suggestion for ranking purposes. + * + * Higher score = better suggestion. + */ + public function score(string $buffer, SuggestionResult $suggestion): int + { + $score = 50; + $appliedText = $suggestion->applyToBuffer($buffer); + + if ($this->frecencyIndex !== null) { + $score += $this->calculateFrecencyBoost($appliedText); + } + + $length = \mb_strlen($suggestion->getDisplayText()); + if ($length < 10) { + $score += 5; + } elseif ($length > 50) { + $score -= 5; + } + + switch ($suggestion->getSource()) { + case SuggestionResult::SOURCE_CALL_SIGNATURE: + $score += 15; + break; + case SuggestionResult::SOURCE_HISTORY: + $score += 10; + break; + } + + if ($buffer !== '' && \strpos($appliedText, $buffer) === 0) { + $score += 10; + } + + if (\strpos($suggestion->getDisplayText(), "\n") === false) { + $score += 5; + } + + $finalScore = (int) \max(0, \min(100, $score)); + + if (DebugLog::isEnabled()) { + DebugLog::log('SuggestionFilter', 'SCORE', [ + 'score' => $finalScore, + 'source' => $suggestion->getSource(), + 'text' => $appliedText, + ]); + } + + return $finalScore; + } + + /** + * Calculate frecency boost for a suggestion. + * + * Extracts important words and sums their frecency scores. + * + * @param string $text full text produced by applying the suggestion + * + * @return float Boost from 0-30 + */ + private function calculateFrecencyBoost(string $text): float + { + $words = WordExtractor::extractNormalizedIdentifiers($text); + + if (empty($words)) { + return 0.0; + } + + $totalScore = 0.0; + foreach ($words as $word) { + $totalScore += $this->frecencyIndex->getScore($word); + } + + $avgScore = $totalScore / \count($words); + + return \min(30.0, $avgScore / 3.0); + } + + /** + * Check if buffer ends with object operator (->). + */ + private function isAfterObjectOperator(string $buffer): bool + { + return (bool) \preg_match('/->\s*[a-zA-Z_]*$/', $buffer); + } + + /** + * Check if text looks like a function (ends with parentheses). + */ + private function looksLikeFunction(string $text): bool + { + return (bool) \preg_match('/\([^)]*\)\s*$/', $text); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/SuggestionResult.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/SuggestionResult.php new file mode 100644 index 000000000..25c023c27 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/SuggestionResult.php @@ -0,0 +1,127 @@ +displayText = $displayText; + $this->source = $source; + $this->acceptText = $acceptText; + $this->replaceStart = $replaceStart; + $this->replaceEnd = $replaceEnd; + } + + /** + * Build a suggestion that appends text at the current cursor. + * + * @param string $displayText Text shown in ghost-text preview + * @param string $source Source type + * @param int $cursorPosition Current cursor position + * @param string|null $acceptText Optional accept text (defaults to display text) + */ + public static function forAppend( + string $displayText, + string $source, + int $cursorPosition, + ?string $acceptText = null + ): self { + $insertText = $acceptText ?? $displayText; + + return new self($displayText, $source, $insertText, $cursorPosition, $cursorPosition); + } + + /** + * Get the suggestion text shown in the ghost-text preview. + */ + public function getDisplayText(): string + { + return $this->displayText; + } + + /** + * Get the source that provided this suggestion. + */ + public function getSource(): string + { + return $this->source; + } + + /** + * Get the text inserted when accepting this suggestion. + */ + public function getAcceptText(): string + { + return $this->acceptText; + } + + /** + * Replacement range start (inclusive). + */ + public function getReplaceStart(): int + { + return $this->replaceStart; + } + + /** + * Replacement range end (exclusive). + */ + public function getReplaceEnd(): int + { + return $this->replaceEnd; + } + + /** + * Whether this suggestion appends at the given cursor without replacing. + */ + public function isAppendOnly(int $cursor): bool + { + return $this->replaceStart === $cursor && $this->replaceEnd === $cursor; + } + + /** + * Apply the suggestion edit to a buffer string. + */ + public function applyToBuffer(string $buffer): string + { + $length = \mb_strlen($buffer); + $start = \max(0, \min($this->replaceStart, $length)); + $end = \max($start, \min($this->replaceEnd, $length)); + + return \mb_substr($buffer, 0, $start).$this->acceptText.\mb_substr($buffer, $end); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/WordExtractor.php b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/WordExtractor.php new file mode 100644 index 000000000..97e2da8c8 --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/Suggestion/WordExtractor.php @@ -0,0 +1,46 @@ +input = $input; + $this->output = $output; + $this->symfonyTerminal = new SymfonyTerminal(); + $this->cursor = new Cursor($output); + } + + /** + * Check whether any out-of-band write has occurred since the last frame. + */ + public function isDirty(): bool + { + return $this->dirty; + } + + /** + * Check whether cursor row tracking has been invalidated. + */ + public function isCursorRowUnknown(): bool + { + return $this->cursorRowUnknown; + } + + /** + * Begin a frame render, clearing dirty flags. + * + * Writes during a frame render don't set the dirty flags. + */ + public function beginFrameRender(): void + { + $this->frameRenderDepth++; + $this->dirty = false; + $this->cursorRowUnknown = false; + } + + /** + * End a frame render. + */ + public function endFrameRender(): void + { + $this->frameRenderDepth = \max(0, $this->frameRenderDepth - 1); + } + + /** + * Write text to the terminal and flush. + * + * Writes directly to the stream, bypassing the output formatter. + * + * By default, out-of-band writes (outside a frame render) mark the + * frame dirty and check for newlines that would move the cursor row. + * Pass $visible = false for writes that don't affect screen content + * or cursor position (e.g. BEL, mode-change escape sequences). + */ + public function write(string $text, bool $visible = true): void + { + if ($visible) { + $movesRow = \strpbrk($text, "\n\v\f") !== false; + $this->noteOutOfBandWrite($movesRow); + } + + $this->output->write($text, false, OutputInterface::OUTPUT_RAW); + } + + /** + * Flush the output stream. + */ + public function flush(): void + { + \fflush($this->output->getStream()); + } + + /** + * Invalidate frame renderer caches before the next render pass. + * + * Useful when a mode switch should repaint the full input frame. + */ + public function invalidateFrame(bool $cursorRowUnknown = false): void + { + $this->dirty = true; + if ($cursorRowUnknown) { + $this->cursorRowUnknown = true; + } + } + + /** + * Get the output formatter. + * + * Provides access to the formatter for cases where direct formatting control is needed. + */ + public function getFormatter(): OutputFormatterInterface + { + return $this->output->getFormatter(); + } + + /** + * Format text using the output formatter. + * + * Applies theme styles like , , etc. + * + * @return string Formatted text with ANSI codes + */ + public function format(string $text): string + { + return $this->getFormatter()->format($text); + } + + /** + * Write formatted text to the terminal. + * + * Text is processed through the output formatter, applying theme styles + * like , , etc. + */ + public function writeFormatted(string $text): void + { + $this->write($this->format($text)); + } + + /** + * Move cursor to a specific column (1-indexed, terminal convention). + */ + public function moveCursorToColumn(int $column): void + { + $this->noteOutOfBandWrite(); + $this->cursor->moveToColumn($column); + } + + /** + * Move cursor up. + */ + public function moveCursorUp(int $count = 1): void + { + if ($count > 0) { + $this->noteOutOfBandWrite(true); + $this->cursor->moveUp($count); + } + } + + /** + * Move cursor down by specified number of lines. + */ + public function moveCursorDown(int $count = 1): void + { + if ($count > 0) { + $this->noteOutOfBandWrite(true); + $this->cursor->moveDown($count); + } + } + + /** + * Clear entire current line. + */ + public function clearLine(): void + { + $this->noteOutOfBandWrite(); + $this->cursor->clearLine(); + } + + /** + * Clear from cursor to end of line. + */ + public function clearToEndOfLine(): void + { + $this->noteOutOfBandWrite(); + $this->cursor->clearLineAfter(); + } + + /** + * Clear from cursor to end of screen. + */ + public function clearToEndOfScreen(): void + { + $this->noteOutOfBandWrite(); + $this->cursor->clearOutput(); + } + + /** + * Save cursor position. + */ + public function saveCursor(): void + { + $this->cursor->savePosition(); + } + + /** + * Restore cursor position. + */ + public function restoreCursor(): void + { + $this->noteOutOfBandWrite(true); + $this->cursor->restorePosition(); + } + + /** + * Read a single key press from input. + */ + public function readKey(): Key + { + return $this->input->readKey(); + } + + /** + * Get terminal width in columns. + */ + public function getWidth(): int + { + return $this->symfonyTerminal->getWidth(); + } + + /** + * Get terminal height in rows. + */ + public function getHeight(): int + { + return $this->symfonyTerminal->getHeight(); + } + + /** + * Ring the terminal bell. + */ + public function bell(): void + { + $this->write("\x07", false); // BEL character + } + + /** + * Enable raw mode for terminal input. + * + * Disables canonical mode, echo, and signal processing so we can + * read characters one at a time and handle control characters. + */ + public function enableRawMode(): bool + { + // Only works on Unix-like systems with stty + if (\DIRECTORY_SEPARATOR === '\\') { + return false; + } + + $stty = \shell_exec('stty -g'); + if ($stty === null || $stty === false) { + return false; + } + + $this->originalSttyMode = \trim($stty); + + // Set raw mode: -icanon (disable canonical mode), -echo (disable echo) + // -isig (disable signal chars like Ctrl-C), -ixon (disable Ctrl-S/Q) + \shell_exec('stty -icanon -echo -isig -ixon'); + + return true; + } + + /** + * Disable raw mode and restore original terminal settings. + */ + public function disableRawMode(): void + { + if ($this->originalSttyMode !== null) { + \shell_exec('stty '.\escapeshellarg($this->originalSttyMode)); + $this->originalSttyMode = null; + } + } + + /** + * Enable bracketed paste mode. + * + * When enabled, pasted text is wrapped with special escape sequences + * (\033[200~ / \033[201~) to distinguish it from typed content. + */ + public function enableBracketedPaste(): void + { + if (!$this->bracketedPasteEnabled) { + $this->write("\033[?2004h", false); + $this->bracketedPasteEnabled = true; + } + } + + /** + * Disable bracketed paste mode. + */ + public function disableBracketedPaste(): void + { + if ($this->bracketedPasteEnabled) { + $this->write("\033[?2004l", false); + $this->bracketedPasteEnabled = false; + } + } + + /** + * Check if bracketed paste mode is enabled. + */ + public function isBracketedPasteEnabled(): bool + { + return $this->bracketedPasteEnabled; + } + + /** + * Flag the terminal as dirty when writing outside a frame render. + */ + private function noteOutOfBandWrite(bool $movesRow = false): void + { + if ($this->frameRenderDepth === 0) { + $this->dirty = true; + if ($movesRow) { + $this->cursorRowUnknown = true; + } + } + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Interactive/TerminalOutput.php b/app/vendor/psy/psysh/src/Readline/Interactive/TerminalOutput.php new file mode 100644 index 000000000..88c79ae1d --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/Interactive/TerminalOutput.php @@ -0,0 +1,70 @@ +source = $source; + + parent::__construct( + $source->getStream(), + $source->getVerbosity(), + $source->isDecorated(), + $source->getFormatter() + ); + } + + /** + * {@inheritdoc} + * + * @param string|iterable $messages + */ + public function write($messages, $newline = false, $type = 0): void + { + $this->syncState(); + + parent::write($messages, $newline, $type); + } + + /** + * {@inheritdoc} + */ + public function getFormatter(): OutputFormatterInterface + { + $this->syncState(); + + return parent::getFormatter(); + } + + /** + * Keep formatter and display flags aligned with the shell output. + */ + private function syncState(): void + { + parent::setFormatter($this->source->getFormatter()); + parent::setDecorated($this->source->isDecorated()); + parent::setVerbosity($this->source->getVerbosity()); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/InteractiveReadline.php b/app/vendor/psy/psysh/src/Readline/InteractiveReadline.php new file mode 100644 index 000000000..c291ca4aa --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/InteractiveReadline.php @@ -0,0 +1,457 @@ +historyFile = ($historyFile !== null) ? $historyFile : false; + $this->historySize = $historySize; + $this->eraseDups = $eraseDups; + } + + /** + * {@inheritdoc} + */ + public function setOutput(OutputInterface $output, ?Terminal $terminal = null): void + { + if (!($output instanceof StreamOutput)) { + throw new \InvalidArgumentException('InteractiveReadline requires a StreamOutput instance.'); + } + + DebugLog::enable($output->getVerbosity()); + + $this->terminal = $terminal ?? new Terminal(new StdinReader(\STDIN), new TerminalOutput($output)); + $this->session = new InteractiveSession($this->terminal); + $this->history = new InteractiveHistory($this->historySize, $this->eraseDups); + $this->resolveHistoryFiles(); + $this->loadHistory(); + $this->readline = new InternalReadline($this->terminal, null, $this->history); + + $this->applyDynamicInputFrameColor($output); + + $this->booted = true; + + if (DebugLog::isEnabled()) { + $this->showDebugInfo(); + } + } + + /** + * Ensure setOutput has been called before using readline internals. + * + * @throws \RuntimeException if readline has not been booted via setOutput + */ + private function assertBooted(): void + { + if (!$this->booted) { + throw new \RuntimeException('InteractiveReadline has not been booted. Call setOutput() first.'); + } + } + + /** + * Show debug logging information (whisper message). + */ + private function showDebugInfo(): void + { + $logPath = DebugLog::getLogPath(); + DebugLog::separator('INTERACTIVE READLINE SESSION START'); + DebugLog::log('System', 'INITIALIZED', ['log_path' => $logPath]); + + // Output whisper message to stderr so it doesn't interfere with shell output + $message = \sprintf( + "\033[90mDebug logging enabled: tail -f %s\033[0m\n", + $logPath + ); + \fwrite(\STDERR, $message); + } + + /** + * {@inheritdoc} + */ + public function addHistory(string $line): bool + { + $this->assertBooted(); + $this->history->add($line); + $this->writeHistory(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function clearHistory(): bool + { + $this->assertBooted(); + $this->history->clear(); + $this->writeHistory(); + + return true; + } + + /** + * {@inheritdoc} + */ + public function listHistory(): array + { + $this->assertBooted(); + $entries = $this->history->getAll(); + + // Extract just the command strings + return \array_map(fn ($entry) => $entry['command'], $entries); + } + + /** + * {@inheritdoc} + */ + public function readHistory(): bool + { + $this->assertBooted(); + $this->resolveHistoryFiles(); + if (!$this->hasReadableHistory()) { + return false; + } + + $this->loadHistory(); + + return true; + } + + /** + * {@inheritdoc} + * + * Note: $prompt is unused here, as multi-line buffer rendering is managed internally + */ + public function readline(?string $prompt = null) + { + $this->assertBooted(); + try { + $this->session->start(); + } catch (\RuntimeException $e) { + throw new ThrowUpException($e); + } + + return $this->readline->readline(); + } + + /** + * {@inheritdoc} + */ + public function setTheme(Theme $theme): void + { + $this->assertBooted(); + $this->readline->setTheme($theme); + } + + /** + * {@inheritdoc} + */ + public function redisplay() + { + // Interactive readline doesn't expose redisplay (it's handled by the readline itself) + } + + /** + * {@inheritdoc} + */ + public function writeHistory(): bool + { + $this->assertBooted(); + $this->resolveHistoryFiles(); + if ($this->historyFile !== false) { + $this->history->saveToFile($this->historyFile); + } + + return true; + } + + /** + * {@inheritdoc} + */ + public function setShell(Shell $shell): void + { + $this->assertBooted(); + $this->readline->setShell($shell); + } + + public function setCommands(array $commands): void + { + $this->assertBooted(); + $this->readline->getCommandHighlighter()->setCommands($commands); + } + + /** + * {@inheritdoc} + */ + public function setRequireSemicolons(bool $require): void + { + $this->assertBooted(); + $this->readline->setRequireSemicolons($require); + } + + /** + * {@inheritdoc} + */ + public function setCompletionEngine(CompletionEngine $completionEngine): void + { + $this->assertBooted(); + $this->readline->setCompletionEngine($completionEngine); + + $suggestionSource = new ContextAwareSource($completionEngine); + $this->readline->getSuggestionEngine()->addSource($suggestionSource); + } + + /** + * {@inheritdoc} + */ + public function setOutputWritten(bool $written): void + { + $this->readline->setContinueFrame(!$written); + } + + /** + * {@inheritdoc} + */ + public function setUseSuggestions(bool $enabled): void + { + $this->assertBooted(); + $this->readline->setUseSuggestions($enabled); + } + + /** + * {@inheritdoc} + */ + public function setUseSyntaxHighlighting(bool $enabled): void + { + $this->assertBooted(); + $this->readline->setUseSyntaxHighlighting($enabled); + } + + /** + * {@inheritdoc} + */ + public function setUseBracketedPaste(bool $enabled): void + { + $this->assertBooted(); + $this->session->setUseBracketedPaste($enabled); + } + + /** + * {@inheritdoc} + */ + public function getHistory(): InteractiveHistory + { + $this->assertBooted(); + + return $this->history; + } + + /** + * Query the terminal's background color and override the input_frame style. + * + * When detection succeeds, the background is a subtle tint over the + * terminal's actual background, which looks better than the static fallback + * across both dark and light themes. + */ + private function applyDynamicInputFrameColor(StreamOutput $output): void + { + $formatter = $output->getFormatter(); + if (!$formatter->isDecorated()) { + return; + } + + $this->setDynamicStyle($formatter, 'input_frame', TerminalColor::computeInputFrameBackground()); + $this->setDynamicStyle($formatter, 'input_frame_error', TerminalColor::computeInputFrameErrorBackground()); + } + + /** + * Set a dynamic formatter style from a computed hex color. + * + * Hex colors require Symfony Console 5.2+; falls back gracefully. + */ + private function setDynamicStyle($formatter, string $styleName, ?string $bgHex): void + { + if ($bgHex === null) { + return; + } + + try { + $formatter->setStyle($styleName, new OutputFormatterStyle(null, $bgHex)); + } catch (\InvalidArgumentException $e) { + // Keep the existing static style + } + } + + /** + * Resolve history read/write files. + * + * Legacy plain-text history files are import-only: when one is configured, + * new history is written to a sibling JSONL file. + */ + private function resolveHistoryFiles(): void + { + if ($this->historyFilesResolved || $this->historyFile === false) { + return; + } + + $this->historyFilesResolved = true; + if (!$this->isLegacyHistoryFile($this->historyFile)) { + return; + } + + $legacyHistoryFile = $this->historyFile; + $jsonlHistoryFile = $legacyHistoryFile.'.jsonl'; + + if (\file_exists($jsonlHistoryFile)) { + $this->historyFile = $jsonlHistoryFile; + + return; + } + + $this->historyImportFile = $legacyHistoryFile; + $this->historyFile = $jsonlHistoryFile; + } + + /** + * Load history from the configured JSONL file, or import from legacy file. + */ + private function loadHistory(): void + { + if ($this->historyFile !== false && \file_exists($this->historyFile)) { + $this->history->loadFromFile($this->historyFile); + + return; + } + + if ($this->historyImportFile !== false && \file_exists($this->historyImportFile)) { + $this->history->importFromFile($this->historyImportFile); + } + } + + /** + * Check whether either the primary history file or import source exists. + */ + private function hasReadableHistory(): bool + { + if ($this->historyFile !== false && \file_exists($this->historyFile)) { + return true; + } + + return $this->historyImportFile !== false && \file_exists($this->historyImportFile); + } + + /** + * Check whether a history file is in legacy plain-text readline format. + * + * Peeks at the first non-empty line: if it's a valid JSON history line + * (signature or entry), the file is not legacy; otherwise it is. + */ + private function isLegacyHistoryFile(string $path): bool + { + if (!\file_exists($path) || !\is_readable($path)) { + return false; + } + + $handle = @\fopen($path, 'r'); + if ($handle === false) { + return false; + } + + while (($line = \fgets($handle)) !== false) { + if (\trim($line) === '') { + continue; + } + + @\fclose($handle); + + return !InteractiveHistory::isJsonHistoryLine($line); + } + + @\fclose($handle); + + return false; + } +} diff --git a/app/vendor/psy/psysh/src/Readline/InteractiveReadlineInterface.php b/app/vendor/psy/psysh/src/Readline/InteractiveReadlineInterface.php new file mode 100644 index 000000000..76ec1e33e --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/InteractiveReadlineInterface.php @@ -0,0 +1,71 @@ +readline = $readline; + $this->bufferAnalyzer = new BufferAnalyzer(); + $this->statementCompletenessPolicy = new StatementCompletenessPolicy($this->bufferAnalyzer); + } + + public static function isSupported(): bool + { + return true; + } + + public static function supportsBracketedPaste(): bool + { + return false; + } + + public function addHistory(string $line): bool + { + return $this->readline->addHistory($line); + } + + public function clearHistory(): bool + { + return $this->readline->clearHistory(); + } + + public function listHistory(): array + { + return $this->readline->listHistory(); + } + + public function readHistory(): bool + { + return $this->readline->readHistory(); + } + + public function readline(?string $prompt = null) + { + $lines = $this->buffer; + if ($lines !== []) { + $text = \implode("\n", $lines); + if ($this->statementCompletenessPolicy->isCompleteStatement($text)) { + $this->clearBuffer(); + + return $text; + } + } + + while (true) { + $linePrompt = ($lines === []) ? $prompt : ($this->bufferPrompt ?? $prompt); + $line = $this->readline->readline($linePrompt); + if ($line === false) { + if ($lines === []) { + return false; + } + + // Mirror the legacy shell behavior for Ctrl+D mid-buffer: + // clear the partial statement and return to a fresh prompt. + $this->clearBuffer(); + if ($this->output !== null) { + $this->output->writeln(''); + } + + return ''; + } + + if ($lines !== [] && $this->isCommand($line) && !$this->inputInOpenStringOrComment($line)) { + return $line; + } + + [$line, $keepBufferOpen] = $this->normalizeLine($line); + $lines[] = $line; + $this->buffer = $lines; + $text = \implode("\n", $lines); + + if (!$keepBufferOpen && $this->statementCompletenessPolicy->isCompleteStatement($text)) { + $this->clearBuffer(); + + return $text; + } + } + } + + public function redisplay() + { + $this->readline->redisplay(); + } + + public function writeHistory(): bool + { + return $this->readline->writeHistory(); + } + + public function setRequireSemicolons(bool $require): void + { + $this->requireSemicolons = $require; + $this->statementCompletenessPolicy = new StatementCompletenessPolicy( + $this->bufferAnalyzer, + $this->requireSemicolons + ); + } + + public function setBufferPrompt(?string $prompt): void + { + $this->bufferPrompt = $prompt; + } + + /** + * Set the shell output for buffer-clearing notifications. + */ + public function setOutput(OutputInterface $output): void + { + $this->output = $output; + } + + /** + * Set the shell instance for command detection while buffering input. + */ + public function setShell(Shell $shell): void + { + $this->shell = $shell; + } + + /** + * Get the buffered physical lines for the current incomplete statement. + * + * @return string[] + */ + public function getBuffer(): array + { + return $this->buffer; + } + + /** + * Check whether there is buffered multiline input. + */ + public function hasBuffer(): bool + { + return $this->buffer !== []; + } + + /** + * Append generated code to the active multiline buffer. + */ + public function append(string $code): void + { + foreach (\explode("\n", $code) as $line) { + $this->buffer[] = $line; + } + } + + /** + * Clear the current incomplete statement buffer. + */ + public function clearBuffer(): void + { + $this->buffer = []; + } + + /** + * Strip the legacy trailing backslash continuation marker. + */ + private function normalizeLine(string $line): array + { + $trimmed = \rtrim($line); + + if (\substr($trimmed, -1) === '\\') { + return [\substr($trimmed, 0, -1), true]; + } + + return [$line, false]; + } + + /** + * Check if the current physical line is a PsySH command. + */ + private function isCommand(string $input): bool + { + if ($this->shell === null) { + return false; + } + + return $this->shell->hasCommand($input); + } + + /** + * Check whether the current buffer plus input is in an open string or comment. + */ + private function inputInOpenStringOrComment(string $input): bool + { + if ($this->buffer === []) { + return false; + } + + $code = $this->buffer; + $code[] = $input; + + return $this->bufferAnalyzer->analyze(\implode("\n", $code))->endsInOpenStringOrComment(); + } +} diff --git a/app/vendor/psy/psysh/src/Readline/Libedit.php b/app/vendor/psy/psysh/src/Readline/Libedit.php index 3ae8d6e29..123145e6d 100644 --- a/app/vendor/psy/psysh/src/Readline/Libedit.php +++ b/app/vendor/psy/psysh/src/Readline/Libedit.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,6 +11,7 @@ namespace Psy\Readline; +use Psy\ConfigPaths; use Psy\Util\Str; /** @@ -86,7 +87,7 @@ public function writeHistory(): bool if ($res === false && !$this->hasWarnedOwnership) { if (\is_file($this->historyFile) && \is_writable($this->historyFile)) { $this->hasWarnedOwnership = true; - $msg = \sprintf('Error writing history file, check file ownership: %s', $this->historyFile); + $msg = \sprintf('Error writing history file, check file ownership: %s', ConfigPaths::prettyPath($this->historyFile)); \trigger_error($msg, \E_USER_NOTICE); } } @@ -108,7 +109,7 @@ protected function parseHistoryLine(string $line) { // empty line, comment or timestamp if (!$line || $line[0] === "\0") { - return; + return null; } // if "\0" is found in an entry, then // everything from it until the end of line is a comment. diff --git a/app/vendor/psy/psysh/src/Readline/Readline.php b/app/vendor/psy/psysh/src/Readline/Readline.php index 429b2b1ff..75fe24b3a 100644 --- a/app/vendor/psy/psysh/src/Readline/Readline.php +++ b/app/vendor/psy/psysh/src/Readline/Readline.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Readline/ReadlineAware.php b/app/vendor/psy/psysh/src/Readline/ReadlineAware.php new file mode 100644 index 000000000..755ae714f --- /dev/null +++ b/app/vendor/psy/psysh/src/Readline/ReadlineAware.php @@ -0,0 +1,26 @@ +declaringClass = $declaringClass; + $this->name = $name; + $this->class = $declaringClass->getName(); + $this->isStatic = $isStatic; + $this->returnType = $returnType; + $this->parameters = $parameters; + $this->description = $description; + $this->returnsReference = $returnsReference; + } + + /** + * Get the method name. + */ + public function getName(): string + { + return $this->name; + } + + /** + * Get the class that declares this method. + */ + public function getDeclaringClass(): \ReflectionClass + { + return $this->declaringClass; + } + + /** + * Check if this is a static method. + */ + public function isStatic(): bool + { + return $this->isStatic; + } + + /** + * Magic methods are always public. + */ + public function isPublic(): bool + { + return true; + } + + /** + * Magic methods are never protected. + */ + public function isProtected(): bool + { + return false; + } + + /** + * Magic methods are never private. + */ + public function isPrivate(): bool + { + return false; + } + + /** + * Magic methods are never abstract. + */ + public function isAbstract(): bool + { + return false; + } + + /** + * Magic methods are never final. + */ + public function isFinal(): bool + { + return false; + } + + /** + * Check if this method returns by reference. + */ + public function returnsReference(): bool + { + return $this->returnsReference; + } + + /** + * Get the method modifiers. + */ + public function getModifiers(): int + { + $modifiers = \ReflectionMethod::IS_PUBLIC; + + if ($this->isStatic) { + $modifiers |= \ReflectionMethod::IS_STATIC; + } + + return $modifiers; + } + + /** + * Get parameters - returns empty array since we only have a string representation. + * + * @return \ReflectionParameter[] + */ + public function getParameters(): array + { + return []; + } + + /** + * Get the raw parameter string from the docblock. + */ + public function getParameterString(): string + { + return $this->parameters; + } + + /** + * Get the return type from the docblock. + */ + public function getDocblockReturnType(): ?string + { + return $this->returnType; + } + + /** + * Get the description from the docblock. + */ + public function getDescription(): ?string + { + return $this->description; + } + + /** + * Magic methods don't have a native return type. + */ + public function hasReturnType(): bool + { + return false; + } + + /** + * Magic methods don't have a native return type. + */ + public function getReturnType(): ?\ReflectionType + { + return null; + } + + /** + * Get the docblock for this magic method. + * + * Returns the description if available. + * + * @return string|false + */ + public function getDocComment() + { + if ($this->description === null) { + return false; + } + + return \sprintf("/**\n * %s\n */", $this->description); + } + + /** + * Export is not supported. + * + * @throws \RuntimeException + */ + public static function export($class, $name, $return = false): ?string + { + throw new \RuntimeException('Export is not supported for magic methods'); + } + + /** + * String representation. + */ + public function __toString(): string + { + $static = $this->isStatic ? 'static ' : ''; + $return = $this->returnType ? $this->returnType.' ' : ''; + $ref = $this->returnsReference ? '&' : ''; + + return \sprintf( + 'Method [ public %s%smethod %s%s ] { %s%s(%s) }', + $static, + $return, + $ref, + $this->name, + $ref, + $this->name, + $this->parameters + ); + } +} diff --git a/app/vendor/psy/psysh/src/Reflection/ReflectionMagicProperty.php b/app/vendor/psy/psysh/src/Reflection/ReflectionMagicProperty.php new file mode 100644 index 000000000..8bd8cb503 --- /dev/null +++ b/app/vendor/psy/psysh/src/Reflection/ReflectionMagicProperty.php @@ -0,0 +1,219 @@ +declaringClass = $declaringClass; + $this->name = $name; + $this->class = $declaringClass->getName(); + $this->type = $type; + $this->readOnly = $readOnly; + $this->writeOnly = $writeOnly; + $this->description = $description; + } + + /** + * Get the property name. + */ + public function getName(): string + { + return $this->name; + } + + /** + * Get the class that declares this property. + */ + public function getDeclaringClass(): \ReflectionClass + { + return $this->declaringClass; + } + + /** + * Magic properties are always public. + */ + public function isPublic(): bool + { + return true; + } + + /** + * Magic properties are never protected. + */ + public function isProtected(): bool + { + return false; + } + + /** + * Magic properties are never private. + */ + public function isPrivate(): bool + { + return false; + } + + /** + * Magic properties are never static. + */ + public function isStatic(): bool + { + return false; + } + + /** + * Check if this is a read-only property (@property). + */ + public function isReadOnly(): bool + { + return $this->readOnly; + } + + /** + * Check if this is a write-only property (@property). + */ + public function isWriteOnly(): bool + { + return $this->writeOnly; + } + + /** + * Magic properties don't have default values. + */ + public function isDefault(): bool + { + return false; + } + + /** + * Get the property modifiers. + */ + public function getModifiers(): int + { + return \ReflectionProperty::IS_PUBLIC; + } + + /** + * Get the docblock type for this property. + */ + public function getDocblockType(): ?string + { + return $this->type; + } + + /** + * Get the description from the docblock. + */ + public function getDescription(): ?string + { + return $this->description; + } + + /** + * Magic properties don't have a native type. + */ + public function hasType(): bool + { + return false; + } + + /** + * Magic properties don't have a native type. + */ + public function getType(): ?\ReflectionType + { + return null; + } + + /** + * Get the docblock for this magic property. + * + * Returns the description if available. + * + * @return string|false + */ + public function getDocComment() + { + if ($this->description === null) { + return false; + } + + return \sprintf("/**\n * %s\n */", $this->description); + } + + /** + * Export is not supported. + * + * @throws \RuntimeException + */ + public static function export($class, $name, $return = false): ?string + { + throw new \RuntimeException('Export is not supported for magic properties'); + } + + /** + * String representation. + */ + public function __toString(): string + { + $type = $this->type ? $this->type.' ' : ''; + $suffix = ''; + + if ($this->readOnly) { + $suffix = ' (read-only)'; + } elseif ($this->writeOnly) { + $suffix = ' (write-only)'; + } + + return \sprintf( + 'Property [ public %s$%s ]%s', + $type, + $this->name, + $suffix + ); + } +} diff --git a/app/vendor/psy/psysh/src/Reflection/ReflectionNamespace.php b/app/vendor/psy/psysh/src/Reflection/ReflectionNamespace.php index ba2e6a19b..9659b9611 100644 --- a/app/vendor/psy/psysh/src/Reflection/ReflectionNamespace.php +++ b/app/vendor/psy/psysh/src/Reflection/ReflectionNamespace.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Shell.php b/app/vendor/psy/psysh/src/Shell.php index edb516340..7c25f03fe 100644 --- a/app/vendor/psy/psysh/src/Shell.php +++ b/app/vendor/psy/psysh/src/Shell.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -12,21 +12,37 @@ namespace Psy; use Psy\CodeCleaner\NoReturnValue; +use Psy\Completion\CompletionEngine; +use Psy\Completion\Refiner\CommandContextRefiner; +use Psy\Completion\Source\CommandArgumentSource; +use Psy\Completion\Source\CommandOptionSource; +use Psy\Completion\Source\CommandSource; +use Psy\Completion\Source\HistorySource; +use Psy\Completion\Source\MatcherAdapterSource; use Psy\Exception\BreakException; use Psy\Exception\ErrorException; use Psy\Exception\Exception as PsyException; +use Psy\Exception\InterruptException; use Psy\Exception\RuntimeException; use Psy\Exception\ThrowUpException; use Psy\ExecutionLoop\ProcessForker; use Psy\ExecutionLoop\RunkitReloader; +use Psy\ExecutionLoop\SignalHandler; +use Psy\ExecutionLoop\UopzReloader; use Psy\Formatter\TraceFormatter; use Psy\Input\ShellInput; use Psy\Input\SilentInput; use Psy\Output\ShellOutput; +use Psy\Readline\InteractiveReadlineInterface; +use Psy\Readline\LegacyReadline; use Psy\Readline\Readline; +use Psy\Readline\ReadlineAware; +use Psy\Readline\ShellReadlineInterface; +use Psy\Shell\PendingInputState; use Psy\TabCompletion\AutoCompleter; use Psy\TabCompletion\Matcher; -use Psy\TabCompletion\Matcher\CommandsMatcher; +use Psy\Util\Tty; +use Psy\VarDumper\Presenter; use Psy\VarDumper\PresenterAware; use Symfony\Component\Console\Application; use Symfony\Component\Console\Command\Command as BaseCommand; @@ -40,6 +56,7 @@ use Symfony\Component\Console\Input\StringInput; use Symfony\Component\Console\Output\ConsoleOutput; use Symfony\Component\Console\Output\OutputInterface; +use Symfony\Component\Console\Output\StreamOutput; /** * The Psy Shell application. @@ -53,30 +70,37 @@ */ class Shell extends Application { - const VERSION = 'v0.12.10'; + const VERSION = 'v0.12.23'; private Configuration $config; - private CodeCleaner $cleaner; + private ?CodeCleaner $cleaner = null; private OutputInterface $output; private ?int $originalVerbosity = null; - private Readline $readline; + private ?ShellReadlineInterface $readline = null; private array $inputBuffer; - /** @var string|false|null */ - private $code = null; - private array $codeBuffer = []; - private bool $codeBufferOpen = false; - private array $codeStack; + private PendingInputState $pendingInput; private string $stdoutBuffer; private Context $context; private array $includes; private bool $outputWantsNewline = false; private array $loopListeners; + private bool $booted = false; + private bool $autoloadWarmed = false; private ?AutoCompleter $autoCompleter = null; + private ?CompletionEngine $completionEngine = null; + /** @var Completion\Source\SourceInterface[] */ + private array $pendingCompletionSources = []; private array $matchers = []; - private ?CommandsMatcher $commandsMatcher = null; + /** @var CommandAware[] */ + private array $commandCompletion = []; private bool $lastExecSuccess = true; + private bool $suppressReturnValue = false; private bool $nonInteractive = false; private ?int $errorReporting = null; + private bool $interactiveSignalCharsEnabled = false; + private bool $outputWritten = false; + private bool $legacyNeedsPromptSpacer = false; + private bool $writingLegacySpacer = false; /** * Create a new Psy Shell. @@ -86,12 +110,10 @@ class Shell extends Application public function __construct(?Configuration $config = null) { $this->config = $config ?: new Configuration(); - $this->cleaner = $this->config->getCodeCleaner(); $this->context = new Context(); $this->includes = []; - $this->readline = $this->config->getReadline(); $this->inputBuffer = []; - $this->codeStack = []; + $this->pendingInput = new PendingInputState(); $this->stdoutBuffer = ''; $this->loopListeners = $this->getDefaultLoopListeners(); @@ -103,6 +125,168 @@ public function __construct(?Configuration $config = null) \Psy\info($this->config); } + /** + * Warm the autoloader by loading classes at startup. + * + * This improves tab completion by making classes available via get_declared_classes() + * rather than maintaining a separate list of available classes. + */ + private function warmAutoloader(): void + { + if ($this->autoloadWarmed) { + return; + } + $this->autoloadWarmed = true; + + $warmers = $this->config->getAutoloadWarmers(); + if (empty($warmers)) { + return; + } + + $output = $this->config->getOutput(); + if ($output instanceof ConsoleOutput) { + $output = $output->getErrorOutput(); + } + + $start = \microtime(true); + $loadedCount = 0; + + foreach ($warmers as $warmer) { + try { + $loadedCount += $warmer->warm(); + } catch (\Throwable $e) { + $output->writeln($this->formatException($e), OutputInterface::VERBOSITY_DEBUG); + } + } + + $message = \sprintf( + 'Autoload warming: loaded %d classes in %.1fms', + $loadedCount, + (\microtime(true) - $start) * 1000 + ); + + $output->writeln($message, OutputInterface::VERBOSITY_DEBUG); + + if (!\class_exists('Composer\\ClassMapGenerator\\ClassMapGenerator', false)) { + $output->writeln('Autoload warming works best with composer/class-map-generator installed'); + } + } + + /** + * Boot the shell, initializing the CodeCleaner and Readline. + * + * This is called lazily when commands or methods require these dependencies. + * If input/output are provided, they'll be used for trust prompts. Otherwise, + * falls back to config defaults. + */ + public function boot(?InputInterface $input = null, ?OutputInterface $output = null): void + { + if ($this->booted) { + return; + } + + $this->loadLocalConfig($input, $output); + + $this->cleaner = $this->config->getCodeCleaner(); + $this->readline = $this->configureReadline($this->config->getReadline()); + $this->booted = true; + + if ($this->readline instanceof LegacyReadline) { + $this->add(new Command\BufferCommand()); + } + + $this->refreshCommandDependencies(); + } + + /** + * Load local config with trust prompt if needed. + */ + private function loadLocalConfig(?InputInterface $input, ?OutputInterface $output): void + { + if ($output === null) { + $output = $this->config->getOutput(); + } + + if ($input === null) { + $input = new ArrayInput([]); + // Programmatic callers (e.g. Shell::execute) don't provide a real + // interactive input stream, so trust prompts must not block. + $input->setInteractive(false); + } + + $this->config->loadLocalConfigWithPrompt($input, $output); + } + + /** + * Configure a readline instance before assigning it to the shell. + * + * This sets up shell awareness, interactive readline dependencies, + * output/theme integration, and options. + * + * @return ShellReadlineInterface The configured readline instance + */ + private function configureReadline(Readline $readline): ShellReadlineInterface + { + if (!($readline instanceof ShellReadlineInterface)) { + $readline = new LegacyReadline($readline); + } + + if ($readline instanceof InteractiveReadlineInterface) { + // setOutput boots the interactive readline, so it must come first + $readline->setOutput($this->output ?? $this->config->getOutput()); + $readline->setTheme($this->config->theme()); + $readline->setRequireSemicolons($this->config->requireSemicolons()); + $readline->setUseBracketedPaste($this->config->useBracketedPaste()); + $readline->setUseSyntaxHighlighting($this->config->useSyntaxHighlighting()); + $readline->setUseSuggestions($this->config->useSuggestions()); + } else { + $readline->setRequireSemicolons($this->config->requireSemicolons()); + } + + if ($readline instanceof LegacyReadline) { + $readline->setBufferPrompt($this->config->theme()->bufferPrompt()); + $readline->setOutput($this->output ?? $this->config->getOutput()); + } + + $readline->setShell($this); + + return $readline; + } + + /** + * Refresh dependencies on all registered commands. + */ + private function refreshCommandDependencies(): void + { + foreach ($this->all() as $command) { + $this->configureCommand($command); + } + } + + /** + * Configure a command with context and dependencies. + */ + private function configureCommand(BaseCommand $command): void + { + if ($command instanceof ContextAware) { + $command->setContext($this->context); + } + + if ($this->booted) { + if ($command instanceof CodeCleanerAware && $this->cleaner !== null) { + $command->setCodeCleaner($this->cleaner); + } + + if ($command instanceof PresenterAware) { + $command->setPresenter($this->config->getPresenter()); + } + + if ($command instanceof ReadlineAware && $this->readline !== null) { + $command->setReadline($this->readline); + } + } + } + /** * Check whether the first thing in a backtrace is an include call. * @@ -154,7 +338,7 @@ public static function debug(array $vars = [], $bindTo = null): array /** * Adds a command object. * - * {@inheritdoc} + * @deprecated since Symfony Console 7.4, use addCommand() instead * * @param BaseCommand $command A Symfony Console Command object * @@ -162,17 +346,32 @@ public static function debug(array $vars = [], $bindTo = null): array */ public function add(BaseCommand $command): BaseCommand { - if ($ret = parent::add($command)) { - if ($ret instanceof ContextAware) { - $ret->setContext($this->context); - } + return $this->addCommand($command); + } - if ($ret instanceof PresenterAware) { - $ret->setPresenter($this->config->getPresenter()); - } + /** + * Adds a command object. + * + * @param BaseCommand|callable $command A Symfony Console Command object or callable + * + * @return BaseCommand|null The registered command, or null + */ + public function addCommand($command): ?BaseCommand + { + // For Symfony Console < 7.4, use parent::add() + if (\method_exists(Application::class, 'addCommand')) { + /** @phan-suppress-next-line PhanUndeclaredStaticMethod (Symfony Console 7.4+) */ + $ret = parent::addCommand($command); + } else { + $ret = parent::add($command); + } + + if ($ret) { + $this->configureCommand($ret); - if (isset($this->commandsMatcher)) { - $this->commandsMatcher->setCommands($this->all()); + $allCommands = $this->all(); + foreach ($this->commandCompletion as $instance) { + $instance->setCommands($allCommands); } } @@ -200,23 +399,31 @@ protected function getDefaultInputDefinition(): InputDefinition protected function getDefaultCommands(): array { $sudo = new Command\SudoCommand(); - $sudo->setReadline($this->readline); $hist = new Command\HistoryCommand(); - $hist->setReadline($this->readline); - return [ + $doc = new Command\DocCommand(); + $doc->setConfiguration($this->config); + + $copy = new Command\CopyCommand(); + $copy->setConfiguration($this->config); + + $config = new Command\ConfigCommand(); + $config->setConfiguration($this->config); + + $commands = [ new Command\HelpCommand(), new Command\ListCommand(), new Command\DumpCommand(), - new Command\DocCommand(), + $config, + $copy, + $doc, new Command\ShowCommand(), new Command\WtfCommand(), new Command\WhereamiCommand(), new Command\ThrowUpCommand(), new Command\TimeitCommand(), new Command\TraceCommand(), - new Command\BufferCommand(), new Command\ClearCommand(), new Command\EditCommand($this->config->getRuntimeDir(false)), // new Command\PsyVersionCommand(), @@ -224,32 +431,24 @@ protected function getDefaultCommands(): array $hist, new Command\ExitCommand(), ]; + + // Only add yolo command if UopzReloader is supported + if (UopzReloader::isSupported()) { + $yolo = new Command\YoloCommand(); + $commands[] = $yolo; + } + + return $commands; } /** + * @deprecated No longer used internally; matchers are registered via the completion engine + * * @return Matcher\AbstractMatcher[] */ protected function getDefaultMatchers(): array { - // Store the Commands Matcher for later. If more commands are added, - // we'll update the Commands Matcher too. - $this->commandsMatcher = new CommandsMatcher($this->all()); - - return [ - $this->commandsMatcher, - new Matcher\KeywordsMatcher(), - new Matcher\VariablesMatcher(), - new Matcher\ConstantsMatcher(), - new Matcher\FunctionsMatcher(), - new Matcher\ClassNamesMatcher(), - new Matcher\ClassMethodsMatcher(), - new Matcher\ClassAttributesMatcher(), - new Matcher\ObjectMethodsMatcher(), - new Matcher\ObjectAttributesMatcher(), - new Matcher\ClassMethodDefaultParametersMatcher(), - new Matcher\ObjectMethodDefaultParametersMatcher(), - new Matcher\FunctionDefaultParametersMatcher(), - ]; + return []; } /** @@ -261,17 +460,102 @@ protected function getDefaultLoopListeners(): array { $listeners = []; + if ($inputLogger = $this->config->getInputLogger()) { + $listeners[] = $inputLogger; + } + if (ProcessForker::isSupported() && $this->config->usePcntl()) { $listeners[] = new ProcessForker(); + } elseif (SignalHandler::isSupported()) { + // Only use SignalHandler when process forking is disabled + // ProcessForker handles SIGINT in the parent process, which is cleaner + $listeners[] = new SignalHandler(); } if (RunkitReloader::isSupported()) { $listeners[] = new RunkitReloader(); + } elseif (UopzReloader::isSupported()) { + $listeners[] = new UopzReloader(); + } + + if ($executionLogger = $this->config->getExecutionLogger()) { + $listeners[] = $executionLogger; } return $listeners; } + /** + * Enable or disable force-reload mode for code reloaders. + * + * Used by the `yolo` command to bypass safety warnings when reloading code. + */ + public function setForceReload(bool $force): void + { + foreach ($this->loopListeners as $listener) { + if (\method_exists($listener, 'setForceReload')) { + $listener->setForceReload($force); + } + } + } + + /** + * Apply live service updates after a runtime configuration change. + */ + public function applyRuntimeConfigChange(string $key): void + { + if (isset($this->output)) { + switch ($key) { + case 'colorMode': + $decorated = $this->config->getOutputDecorated(); + $this->output->setDecorated($decorated !== null ? $decorated : !$this->config->outputIsPiped()); + break; + + case 'verbosity': + $this->originalVerbosity = $this->config->getOutputVerbosity(); + $this->output->setVerbosity($this->originalVerbosity); + break; + + case 'theme': + if ($this->output instanceof ShellOutput) { + $this->output->setTheme($this->config->theme()); + } + break; + + case 'pager': + if ($this->output instanceof ShellOutput) { + $pager = $this->config->getPager(); + $this->output->setPager($pager === false ? null : $pager); + } + break; + } + } + + if (isset($this->readline) && $this->readline instanceof InteractiveReadlineInterface) { + switch ($key) { + case 'theme': + $this->readline->setTheme($this->config->theme()); + break; + + case 'requireSemicolons': + $this->readline->setRequireSemicolons($this->config->requireSemicolons()); + break; + + case 'useBracketedPaste': + $this->readline->setUseBracketedPaste($this->config->useBracketedPaste()); + break; + + case 'useSyntaxHighlighting': + $this->readline->setUseSyntaxHighlighting($this->config->useSyntaxHighlighting()); + break; + + case 'useSuggestions': + $this->readline->setUseSuggestions($this->config->useSuggestions()); + break; + } + } + } + /** * Add tab completion matchers. * @@ -279,10 +563,15 @@ protected function getDefaultLoopListeners(): array */ public function addMatchers(array $matchers) { + $matchers = $this->deduplicateObjects($matchers, $this->matchers); + if ($matchers === []) { + return; + } + $this->matchers = \array_merge($this->matchers, $matchers); - if (isset($this->autoCompleter)) { - $this->addMatchersToAutoCompleter($matchers); + if (isset($this->completionEngine)) { + $this->addLegacyMatchersToCompletionEngine($matchers); } } @@ -298,6 +587,32 @@ public function addTabCompletionMatchers(array $matchers) $this->addMatchers($matchers); } + /** + * Add completion sources to the completion engine. + * + * @internal experimental; API may change before Interactive Readline is stable + * + * @param Completion\Source\SourceInterface[] $sources + */ + public function addCompletionSources(array $sources) + { + $existing = isset($this->completionEngine) ? [] : $this->pendingCompletionSources; + $sources = $this->deduplicateObjects($sources, $existing); + if ($sources === []) { + return; + } + + if (!isset($this->completionEngine)) { + $this->pendingCompletionSources = \array_merge($this->pendingCompletionSources, $sources); + + return; + } + + foreach ($sources as $source) { + $this->completionEngine->addSource($source); + } + } + /** * Set the Shell output. * @@ -321,6 +636,7 @@ public function run(?InputInterface $input = null, ?OutputInterface $output = nu { // We'll just ignore the input passed in, and set up our own! $input = new ArrayInput([]); + $input->setInteractive($this->config->getInputInteractive()); if ($output === null) { $output = $this->config->getOutput(); @@ -331,6 +647,9 @@ public function run(?InputInterface $input = null, ?OutputInterface $output = nu try { return parent::run($input, $output); + } catch (BreakException $e) { + // BreakException from ProcessForker or exit() - return its exit code + return $e->getCode(); } catch (\Throwable $e) { $this->writeException($e); } @@ -351,9 +670,11 @@ public function run(?InputInterface $input = null, ?OutputInterface $output = nu public function doRun(InputInterface $input, OutputInterface $output): int { $this->setOutput($output); - $this->resetCodeBuffer(); + $this->boot($input, $output); + $this->clearPendingCode(); + $this->warmAutoloader(); - if ($input->isInteractive()) { + if ($this->config->getInputInteractive()) { // @todo should it be possible to have raw output in an interactive run? return $this->doInteractiveRun(); } else { @@ -373,26 +694,37 @@ public function doRun(InputInterface $input, OutputInterface $output): int */ private function doInteractiveRun(): int { - $this->initializeTabCompletion(); + if ($this->config->useTabCompletion()) { + $this->initializeCompletionEngine(); + $this->initializeTabCompletion(); + } + + if ($this->readline instanceof CommandAware) { + $this->readline->setCommands($this->all()); + $this->commandCompletion[] = $this->readline; + } + $this->readline->readHistory(); $this->output->writeln($this->getHeader()); $this->writeVersionInfo(); + $this->writeManualUpdateInfo(); $this->writeStartupMessage(); try { $this->beforeRun(); $this->loadIncludes(); $loop = new ExecutionLoopClosure($this); - $loop->execute(); - $this->afterRun(); + $exitCode = $loop->execute(); + $this->afterRun($exitCode ?? 0); + + return $exitCode ?? 0; } catch (ThrowUpException $e) { throw $e->getPrevious(); } catch (BreakException $e) { // The ProcessForker throws a BreakException to finish the main thread. + return $e->getCode(); } - - return 0; } /** @@ -413,6 +745,7 @@ private function doNonInteractiveRun(bool $rawOutput): int if (!$rawOutput && !$this->config->outputIsPiped()) { $this->output->writeln($this->getHeader()); $this->writeVersionInfo(); + $this->writeManualUpdateInfo(); $this->writeStartupMessage(); } @@ -426,12 +759,20 @@ private function doNonInteractiveRun(bool $rawOutput): int $this->getInput(false); } - if ($this->hasCode()) { - $ret = $this->execute($this->flushCode()); - $this->writeReturnValue($ret, $rawOutput); + try { + if ($this->hasCode()) { + $ret = $this->execute($this->flushCode()); + $this->writeReturnValue($ret, $rawOutput); + } + } catch (BreakException $e) { + // User called exit() in non-interactive mode + $this->afterRun($e->getCode()); + $this->nonInteractive = false; + + return $e->getCode(); } - $this->afterRun(); + $this->afterRun(0); $this->nonInteractive = false; return 0; @@ -492,11 +833,13 @@ private function loadIncludes() */ public function getInput(bool $interactive = true) { - $this->codeBufferOpen = false; + $this->boot(); - do { + while (true) { // reset output verbosity (in case it was altered by a subcommand) $this->output->setVerbosity($this->originalVerbosity); + $this->outputWritten = false; + $this->resetShellOutputWritten(); $input = $this->readline(); @@ -514,52 +857,44 @@ public function getInput(bool $interactive = true) $this->output->writeln(''); - if ($this->hasCode()) { - $this->resetCodeBuffer(); - } else { - throw new BreakException('Ctrl+D'); - } + throw new BreakException('Ctrl+D'); } // handle empty input - if (\trim($input) === '' && !$this->codeBufferOpen) { + if (\trim($input) === '') { + $this->notifyOutputWritten(); continue; } + if (!$this->hasCode()) { + $this->writeLegacyInputSpacer(); + } + $input = $this->onInput($input); - // If the input isn't in an open string or comment, check for commands to run. if ($this->hasCommand($input) && !$this->inputInOpenStringOrComment($input)) { $this->addHistory($input); + $outputPositions = $this->captureOutputStreamPositions(); + $this->writePhpCommandCollisionHint($input); $this->runCommand($input); + if (!$this->outputWritten && $this->outputWasWrittenSince($outputPositions)) { + $this->outputWritten = true; + $this->markLegacyOutputWritten(); + } + $this->notifyOutputWritten(); + + if ($interactive && $this->hasValidCode()) { + return; + } continue; } $this->addCode($input); - } while (!$interactive || !$this->hasValidCode()); - } - - /** - * Check whether the code buffer (plus current input) is in an open string or comment. - * - * @param string $input current line of input - * - * @return bool true if the input is in an open string or comment - */ - private function inputInOpenStringOrComment(string $input): bool - { - if (!$this->hasCode()) { - return false; + if ($interactive) { + return; + } } - - $code = $this->codeBuffer; - $code[] = $input; - $tokens = @\token_get_all('loopListeners as $listener) { + if ($listener instanceof OutputAware) { + $listener->setOutput($this->output); + } + } + foreach ($this->loopListeners as $listener) { $listener->beforeRun($this); } @@ -577,6 +918,9 @@ protected function beforeRun() */ public function beforeLoop() { + $this->outputWritten = false; + $this->resetShellOutputWritten(); + foreach ($this->loopListeners as $listener) { $listener->beforeLoop($this); } @@ -606,6 +950,7 @@ public function onInput(string $input): string public function onExecute(string $code): string { $this->errorReporting = \error_reporting(); + $this->enableInteractiveSignalCharsIfNeeded(); foreach ($this->loopListeners as $listener) { if (($return = $listener->onExecute($this, $code)) !== null) { @@ -628,19 +973,174 @@ public function onExecute(string $code): string */ public function afterLoop() { - foreach ($this->loopListeners as $listener) { + $this->disableInteractiveSignalCharsIfNeeded(); + + foreach (\array_reverse($this->loopListeners) as $listener) { $listener->afterLoop($this); } + + $this->notifyOutputWritten(); + } + + /** + * Report to the interactive readline whether visible output was written. + */ + private function notifyOutputWritten(): void + { + if ($this->output instanceof ShellOutput && $this->output->consumeVisibleOutputWritten()) { + $this->outputWritten = true; + $this->markLegacyOutputWritten(); + } + + if ($this->readline instanceof InteractiveReadlineInterface) { + $this->readline->setOutputWritten($this->outputWritten); + } + } + + /** + * Reset ShellOutput's visible-output tracker. + */ + private function resetShellOutputWritten(): void + { + if ($this->output instanceof ShellOutput) { + $this->output->consumeVisibleOutputWritten(); + } + } + + /** + * Capture write positions for output streams not covered by ShellOutput tracking. + * + * @return array|null + */ + private function captureOutputStreamPositions(): ?array + { + $outputs = [$this->output]; + + if ($this->output instanceof ConsoleOutput) { + $outputs[] = $this->output->getErrorOutput(); + } + + $positions = []; + + foreach ($outputs as $output) { + if (!$output instanceof StreamOutput) { + continue; + } + + $stream = $output->getStream(); + if (!\is_resource($stream) || \get_resource_type($stream) !== 'stream') { + continue; + } + + $position = @\ftell($stream); + if (!\is_int($position)) { + continue; + } + + $positions[(int) $stream] = $position; + } + + return $positions !== [] ? $positions : null; + } + + /** + * Determine whether a command wrote output based on fallback stream movement. + * + * This covers outputs that don't report writes explicitly, such as plain + * StreamOutput instances and stderr writes routed around ShellOutput. + * If stream positions are unavailable, assume output may have been written + * to avoid false "no output" frame continuation. + * + * @param array|null $before + */ + private function outputWasWrittenSince(?array $before): bool + { + if ($before === null) { + return true; + } + + $after = $this->captureOutputStreamPositions(); + if ($after === null) { + return true; + } + + foreach ($before as $streamId => $position) { + if (($after[$streamId] ?? $position) > $position) { + return true; + } + } + + foreach ($after as $streamId => $position) { + if (!isset($before[$streamId]) && $position > 0) { + return true; + } + } + + return false; } /** * Run execution loop listers after the shell session. + * + * @param int $exitCode Exit code from the execution loop */ - protected function afterRun() + protected function afterRun(int $exitCode = 0) + { + $this->disableInteractiveSignalCharsIfNeeded(); + + foreach (\array_reverse($this->loopListeners) as $listener) { + $listener->afterRun($this, $exitCode); + } + } + + /** + * Enable terminal signal chars during code execution when no SIGINT listener is active. + * + * Interactive readline raw mode disables terminal-generated SIGINT by default. + * When ProcessForker/SignalHandler are unavailable, we temporarily re-enable + * signal chars so Ctrl-C can still interrupt long-running code. + */ + private function enableInteractiveSignalCharsIfNeeded(): void + { + if ( + $this->interactiveSignalCharsEnabled + || $this->nonInteractive + || !($this->readline instanceof InteractiveReadlineInterface) + || $this->hasSigintExecutionListener() + || !Tty::supportsStty() + ) { + return; + } + + @\shell_exec('stty isig 2>/dev/null'); + $this->interactiveSignalCharsEnabled = true; + } + + /** + * Restore prompt-time terminal signal behavior after execution. + */ + private function disableInteractiveSignalCharsIfNeeded(): void + { + if (!$this->interactiveSignalCharsEnabled) { + return; + } + + @\shell_exec('stty -isig 2>/dev/null'); + $this->interactiveSignalCharsEnabled = false; + } + + /** + * Check whether any loop listener handles SIGINT during execution. + */ + private function hasSigintExecutionListener(): bool { foreach ($this->loopListeners as $listener) { - $listener->afterRun($this); + if ($listener instanceof ProcessForker || $listener instanceof SignalHandler) { + return true; + } } + + return false; } /** @@ -816,7 +1316,7 @@ public function getIncludes(): array */ public function hasCode(): bool { - return !empty($this->codeBuffer); + return $this->pendingInput->hasCode(); } /** @@ -828,38 +1328,128 @@ public function hasCode(): bool */ protected function hasValidCode(): bool { - return !$this->codeBufferOpen && $this->code !== false; + return $this->pendingInput->hasValidCode(); + } + + /** + * Add code to the code buffer. + * + * @param string $code + * @param bool $silent + */ + public function addCode(string $code, bool $silent = false) + { + $this->appendCode($code, $silent); + } + + /** + * Add code to the pending buffer or active legacy continuation buffer. + * + * @param string $code + * @param bool $silent + * @param bool $allowLegacyBufferAppend + */ + private function appendCode(string $code, bool $silent = false, bool $allowLegacyBufferAppend = true): void + { + $this->boot(); + + if ($allowLegacyBufferAppend && $this->readline instanceof LegacyReadline && $this->readline->hasBuffer()) { + $this->readline->append($code); + + return; + } + + try { + $this->pendingInput->appendLine($code, $silent); + $cleanedCode = $this->cleaner->clean($this->pendingInput->getPendingCodeBuffer(), $this->config->requireSemicolons()); + $this->pendingInput->setPendingCode($cleanedCode); + + if (!$silent && $cleanedCode !== false) { + $this->suppressReturnValue = $this->shouldSuppressReturnValue(); + $this->writeCleanerMessages(); + } + } catch (\Throwable $e) { + // Add failed pending code blocks to the readline history. + $this->addPendingCodeBufferToHistory(); + + throw $e; + } + } + + /** + * Check whether the current code buffer ends with an unnecessary semicolon. + * + * @see Configuration::semicolonsSuppressReturn() + */ + private function shouldSuppressReturnValue(): bool + { + if ($this->config->semicolonsSuppressReturn() === false) { + return false; + } + + $tokens = @\token_get_all('pendingInput->getPendingCodeBuffer())); + [$lastToken, $index] = $this->lastNonCommentToken($tokens); + + if ($lastToken !== ';') { + return false; + } + + $requireDouble = $this->config->semicolonsSuppressReturn() === Configuration::SEMICOLONS_SUPPRESS_RETURN_DOUBLE + || $this->config->requireSemicolons(); + + if (!$requireDouble) { + // When semicolons are optional, a single ; is unnecessary + return true; + } + + // Require a double semicolon (`;;`) to suppress + return $index !== null && $this->lastNonCommentToken($tokens, $index - 1)[0] === ';'; + } + + /** + * Get the last non-comment token from a tokenized PHP snippet. + * + * @param array $tokens Token array from token_get_all() + * + * @return array Token and index pair: [token, index] or [null, null] + */ + private function lastNonCommentToken(array $tokens, ?int $offset = null): array + { + $offset ??= \count($tokens) - 1; + + for ($i = $offset; $i >= 0; $i--) { + $token = $tokens[$i]; + + if (\is_array($token) && \in_array($token[0], [\T_WHITESPACE, \T_COMMENT, \T_DOC_COMMENT, \T_OPEN_TAG], true)) { + continue; + } + + return [$token, $i]; + } + + return [null, null]; } /** - * Add code to the code buffer. - * - * @param string $code - * @param bool $silent + * Check whether the pending code buffer plus current input is in an open string or comment. */ - public function addCode(string $code, bool $silent = false) + private function inputInOpenStringOrComment(string $input): bool { - try { - // Code lines ending in \ keep the buffer open - if (\substr(\rtrim($code), -1) === '\\') { - $this->codeBufferOpen = true; - $code = \substr(\rtrim($code), 0, -1); - } else { - $this->codeBufferOpen = false; - } + if (!$this->hasCode()) { + return false; + } - $this->codeBuffer[] = $silent ? new SilentInput($code) : $code; - $this->code = $this->cleaner->clean($this->codeBuffer, $this->config->requireSemicolons()); - } catch (\Throwable $e) { - // Add failed code blocks to the readline history. - $this->addCodeBufferToHistory(); + $code = $this->pendingInput->getPendingCodeBuffer(); + $code[] = $input; + $tokens = @\token_get_all('hasCode()) { - $this->codeStack[] = [$this->codeBuffer, $this->codeBufferOpen, $this->code]; + $this->pendingInput->pushCurrentCode(); } - $this->resetCodeBuffer(); + $this->clearPendingCode(); try { - $this->addCode($code, $silent); + $this->appendCode($code, $silent, false); } catch (\Throwable $e) { $this->popCodeStack(); @@ -895,13 +1485,25 @@ private function setCode(string $code, bool $silent = false) /** * Get the current code buffer. * - * This is useful for commands which manipulate the buffer. + * This is useful for callers which still inspect the shell's pending code. * * @return string[] + * + * @deprecated pending input inspection is being removed from Shell internals */ public function getCodeBuffer(): array { - return $this->codeBuffer; + return $this->getPendingCodeBuffer(); + } + + /** + * Get the current executable pending code buffer. + * + * @return string[] + */ + public function getPendingCodeBuffer(): array + { + return $this->pendingInput->getPendingCodeBuffer(); } /** @@ -921,6 +1523,10 @@ protected function runCommand(string $input) throw new \InvalidArgumentException('Command not found: '.$input); } + if ($logger = $this->config->getLogger()) { + $logger->logCommand($input); + } + $input = new ShellInput(\str_replace('\\', '\\\\', \rtrim($input, " \t\n\r\0\x0B;"))); if (!$input->hasParameterOption(['--help', '-h'])) { @@ -933,10 +1539,7 @@ protected function runCommand(string $input) $this->writeException($e); - $this->output->writeln('--'); - if (!$this->config->theme()->compact()) { - $this->output->writeln(''); - } + $this->writeSeparator($this->output); } } @@ -945,6 +1548,7 @@ protected function runCommand(string $input) throw new RuntimeException('Invalid help command instance'); } $helpCommand->setCommand($command); + $helpCommand->setCommandInput($input); return $helpCommand->run(new StringInput(''), $this->output); } @@ -978,15 +1582,43 @@ private static function needsInputHelp(\Exception $e): bool } /** - * Reset the current code buffer. + * Whisper messages from CodeCleaner passes. + */ + private function writeCleanerMessages(): void + { + if (!isset($this->output)) { + return; + } + + $output = $this->output; + if ($output instanceof ConsoleOutput) { + $output = $output->getErrorOutput(); + } + + foreach ($this->cleaner->getMessages() as $message) { + $output->writeln(\sprintf('%s', OutputFormatter::escape($message))); + } + } + + /** + * Reset the current pending code buffer. * * This should be run after evaluating user input, catching exceptions, or * on demand by commands such as BufferCommand. + * + * @deprecated pending input reset is being removed from Shell internals */ public function resetCodeBuffer() { - $this->codeBuffer = []; - $this->code = false; + $this->clearPendingCode(); + } + + /** + * Clear the current executable pending code buffer. + */ + public function clearPendingCodeBuffer(): void + { + $this->clearPendingCode(); } /** @@ -1005,7 +1637,7 @@ public function addInput($input, bool $silent = false) } /** - * Flush the current (valid) code buffer. + * Flush the current executable pending code buffer. * * If the code buffer is valid, resets the code buffer and returns the * current code. @@ -1015,30 +1647,22 @@ public function addInput($input, bool $silent = false) public function flushCode() { if ($this->hasValidCode()) { - $this->addCodeBufferToHistory(); - $code = $this->code; + $this->addPendingCodeBufferToHistory(); + $code = $this->pendingInput->getPendingCode(); $this->popCodeStack(); return $code; } + + return null; } /** - * Reset the code buffer and restore any code pushed during `execute` calls. + * Reset pending code and restore any code pushed during `execute` calls. */ private function popCodeStack() { - $this->resetCodeBuffer(); - - if (empty($this->codeStack)) { - return; - } - - list($codeBuffer, $codeBufferOpen, $code) = \array_pop($this->codeStack); - - $this->codeBuffer = $codeBuffer; - $this->codeBufferOpen = $codeBufferOpen; - $this->code = $code; + $this->pendingInput->restorePreviousCode(); } /** @@ -1068,15 +1692,21 @@ private function addHistory($line) /** * Filter silent input from code buffer, write the rest to readline history. */ - private function addCodeBufferToHistory() + private function addPendingCodeBufferToHistory() { - $codeBuffer = \array_filter($this->codeBuffer, function ($line) { - return !$line instanceof SilentInput; - }); + $codeBuffer = \array_filter($this->pendingInput->getPendingCodeBuffer(), fn ($line) => !$line instanceof SilentInput); $this->addHistory(\implode("\n", $codeBuffer)); } + /** + * Clear the shell's pending execution state. + */ + private function clearPendingCode(): void + { + $this->pendingInput->clear(); + } + /** * Get the current evaluation scope namespace. * @@ -1086,9 +1716,13 @@ private function addCodeBufferToHistory() */ public function getNamespace() { + $this->boot(); + if ($namespace = $this->cleaner->getNamespace()) { return \implode('\\', $namespace); } + + return null; } /** @@ -1098,8 +1732,10 @@ public function getNamespace() * * @param string $out * @param int $phase Output buffering phase + * + * @return string Empty string */ - public function writeStdout(string $out, int $phase = \PHP_OUTPUT_HANDLER_END) + public function writeStdout(string $out, int $phase = \PHP_OUTPUT_HANDLER_END): string { if ($phase & \PHP_OUTPUT_HANDLER_START) { if ($this->output instanceof ShellOutput) { @@ -1111,9 +1747,11 @@ public function writeStdout(string $out, int $phase = \PHP_OUTPUT_HANDLER_END) // Incremental flush if ($out !== '' && !$isCleaning) { + $this->markLegacyOutputWritten(); $this->output->write($out, false, OutputInterface::OUTPUT_RAW); $this->outputWantsNewline = (\substr($out, -1) !== "\n"); $this->stdoutBuffer .= $out; + $this->outputWritten = true; } // Output buffering is done! @@ -1138,6 +1776,8 @@ public function writeStdout(string $out, int $phase = \PHP_OUTPUT_HANDLER_END) $this->output->stopPaging(); } } + + return ''; } /** @@ -1156,26 +1796,41 @@ public function writeReturnValue($ret, bool $rawOutput = false) $this->lastExecSuccess = true; if ($ret instanceof NoReturnValue) { + $this->suppressReturnValue = false; + return; } $this->context->setReturnValue($ret); + // Don't display the return value, but $_ is still captured above. + if ($this->suppressReturnValue) { + $this->suppressReturnValue = false; + + return; + } + if ($rawOutput) { $formatted = \var_export($ret, true); } else { $prompt = $this->config->theme()->returnValue(); $indent = \str_repeat(' ', \strlen($prompt)); $formatted = $this->presentValue($ret); - $formattedRetValue = \sprintf('%s', $prompt); + $formatter = $this->output->getFormatter(); + $formattedPrompt = ($formatter->hasStyle('whisper') && $formatter->isDecorated()) + ? $formatter->getStyle('whisper')->apply($prompt) + : $prompt; - $formatted = $formattedRetValue.\str_replace(\PHP_EOL, \PHP_EOL.$indent, $formatted); + $formatted = $formattedPrompt.\str_replace(\PHP_EOL, \PHP_EOL.$indent, $formatted); } + $this->outputWritten = true; + $this->markLegacyOutputWritten(); + if ($this->output instanceof ShellOutput) { - $this->output->page($formatted.\PHP_EOL); + $this->output->page($formatted, OutputInterface::OUTPUT_RAW); } else { - $this->output->writeln($formatted); + $this->output->writeln($formatted, OutputInterface::OUTPUT_RAW); } } @@ -1193,7 +1848,7 @@ public function writeException(\Throwable $e) { // No need to write the break exception during a non-interactive run. if ($e instanceof BreakException && $this->nonInteractive) { - $this->resetCodeBuffer(); + $this->clearPendingCode(); return; } @@ -1202,34 +1857,31 @@ public function writeException(\Throwable $e) if (!$e instanceof BreakException) { $this->lastExecSuccess = false; $this->context->setLastException($e); + $this->outputWritten = true; } + $this->markLegacyOutputWritten(); + $output = $this->output; if ($output instanceof ConsoleOutput) { $output = $output->getErrorOutput(); } - if (!$this->config->theme()->compact()) { - $output->writeln(''); - } - - $output->writeln($this->formatException($e)); - - if (!$this->config->theme()->compact()) { - $output->writeln(''); + $this->writeExceptionHeader($output, $e); + if ($e instanceof BreakException) { + $this->writeSpacer($output); } // Include an exception trace (as long as this isn't a BreakException). if (!$e instanceof BreakException && $output->getVerbosity() >= OutputInterface::VERBOSITY_VERBOSE) { $trace = TraceFormatter::formatTrace($e); if (\count($trace) !== 0) { - $output->writeln('--'); + $this->writeSeparator($output); $output->write($trace, true); - $output->writeln(''); } } - $this->resetCodeBuffer(); + $this->clearPendingCode(); } /** @@ -1242,6 +1894,26 @@ public function getLastExecSuccess(): bool return $this->lastExecSuccess; } + /** + * Check whether the shell is using a compact theme. + */ + public function isCompactTheme(): bool + { + return $this->config->theme()->compact(); + } + + /** + * Write a formatted exception header with optional details and compact-aware spacing. + */ + public function writeExceptionHeader(OutputInterface $output, \Throwable $e): void + { + $output->writeln($this->formatException($e)); + + if ($details = $this->formatExceptionDetails($e)) { + $output->writeln($details, OutputInterface::OUTPUT_RAW); + } + } + /** * Helper for formatting an exception or error for writeException(). * @@ -1254,7 +1926,9 @@ public function formatException(\Throwable $e): string $indent = $this->config->theme()->compact() ? '' : ' '; if ($e instanceof BreakException) { - return \sprintf('%s INFO %s.', $indent, \rtrim($e->getRawMessage(), '.')); + return \sprintf('%s INFO %s.', $indent, \rtrim($e->getRawMessage(), '.')); + } elseif ($e instanceof InterruptException) { + return \sprintf('%s INTERRUPT %s.', $indent, $e->getRawMessage()); } elseif ($e instanceof PsyException) { $message = $e->getLine() > 1 ? \sprintf('%s in %s on line %d', $e->getRawMessage(), $e->getFile(), $e->getLine()) @@ -1267,7 +1941,10 @@ public function formatException(\Throwable $e): string } $message = \preg_replace( - "#(\\w:)?([\\\\/]\\w+)*[\\\\/]src[\\\\/]Execution(?:Loop)?Closure.php\(\d+\) : eval\(\)'d code#", + [ + "#(?:[A-Za-z]:)?[\\\\/][^\\r\\n]*?[\\\\/]src[\\\\/]Execution(?:Loop)?Closure\\.php\\(\\d+\\) : eval\\(\\)'d code#", + "#\\bsrc[\\\\/]Execution(?:Loop)?Closure\\.php\\(\\d+\\) : eval\\(\\)'d code#", + ], "eval()'d code", $message ); @@ -1288,6 +1965,115 @@ public function formatException(\Throwable $e): string return \sprintf('%s<%s> %s %s', $indent, $severity, $messageLabel, $severity, OutputFormatter::escape($message)); } + /** + * Format exception details (if provided) for display. + */ + protected function formatExceptionDetails(\Throwable $e): ?string + { + $formatter = $this->config->getExceptionDetails(); + if ($formatter === null) { + return null; + } + + try { + $details = $formatter($e); + } catch (\Throwable $_e) { + return null; + } + + if ($details === null) { + return null; + } + + $rendered = $this->presentValue($details); + $compact = $this->config->theme()->compact(); + $indent = $compact ? ' ' : ' '; + $prefix = $compact ? '' : \PHP_EOL; + + return $prefix.\implode(\PHP_EOL, \array_map(static function ($line) use ($indent) { + return $indent.$line; + }, \explode(\PHP_EOL, $rendered))); + } + + /** + * Write a single blank spacer line in non-compact mode. + */ + public function writeSpacer(OutputInterface $output): void + { + if (!$this->isCompactTheme()) { + $output->writeln(''); + } + } + + /** + * Write a separator line with compact-aware spacing. + */ + public function writeSeparator(OutputInterface $output): void + { + $this->writeSpacer($output); + $output->writeln('--'); + $this->writeSpacer($output); + } + + /** + * Check whether the shell is using legacy readline with non-compact spacing. + */ + private function usesLegacySpacerLayout(): bool + { + return $this->readline instanceof LegacyReadline && !$this->isCompactTheme(); + } + + /** + * Write a single blank spacer line for legacy readline. + */ + private function writeLegacySpacer(): void + { + if (!$this->usesLegacySpacerLayout() || $this->writingLegacySpacer) { + return; + } + + $this->writingLegacySpacer = true; + + try { + $this->output->writeln(''); + } finally { + $this->resetShellOutputWritten(); + $this->writingLegacySpacer = false; + } + } + + /** + * Write the spacer separating the previous output block from the next prompt. + */ + private function writeLegacyPromptSpacer(): void + { + if (!$this->legacyNeedsPromptSpacer) { + return; + } + + $this->writeLegacySpacer(); + $this->legacyNeedsPromptSpacer = false; + } + + /** + * Write the spacer separating submitted input from subsequent output. + */ + private function writeLegacyInputSpacer(): void + { + $this->writeLegacySpacer(); + $this->legacyNeedsPromptSpacer = false; + } + + /** + * Mark that visible output was written and the next prompt needs spacing. + */ + private function markLegacyOutputWritten(): void + { + if ($this->usesLegacySpacerLayout()) { + $this->legacyNeedsPromptSpacer = true; + } + } + /** * Helper for getting an output style for the given ErrorException's level. * @@ -1349,8 +2135,10 @@ protected function getMessageLabel(\Throwable $e): string return 'User Deprecated'; case \E_DEPRECATED: return 'Deprecated'; - case \E_STRICT: - return 'Strict'; + default: + if ((\PHP_VERSION_ID < 80400) && $severity === \E_STRICT) { + return 'Strict'; + } } } } @@ -1387,7 +2175,14 @@ protected function getMessageLabel(\Throwable $e): string */ public function execute(string $code, bool $throwExceptions = false) { + $this->boot(); + $this->setCode($code, true); + + if ($logger = $this->config->getLogger()) { + $logger->logExecute($code); + } + $closure = new ExecutionClosure($this); if ($throwExceptions) { @@ -1396,6 +2191,9 @@ public function execute(string $code, bool $throwExceptions = false) try { return $closure->execute(); + } catch (BreakException $_e) { + // Re-throw BreakException so it can propagate exit codes + throw $_e; } catch (\Throwable $_e) { $this->writeException($_e); } @@ -1457,7 +2255,7 @@ public function handleError($errno, $errstr, $errfile, $errline) */ protected function presentValue($val): string { - return $this->config->getPresenter()->present($val); + return $this->config->getPresenter()->present($val, null, Presenter::RAW); } /** @@ -1473,6 +2271,8 @@ protected function getCommand(string $input) if ($name = $input->getFirstArgument()) { return $this->get($name); } + + return null; } /** @@ -1482,13 +2282,53 @@ protected function getCommand(string $input) * * @return bool True if the shell has a command for the given input */ - protected function hasCommand(string $input): bool + public function hasCommand(string $input): bool + { + $name = $this->extractCommandName($input); + + return $name !== null && $this->has($name); + } + + /** + * Extract the command name (first word) from input. + */ + private function extractCommandName(string $input): ?string { if (\preg_match('/([^\s]+?)(?:\s|$)/A', \ltrim($input), $match)) { - return $this->has($match[1]); + return $match[1]; } - return false; + return null; + } + + /** + * Write a hint if the input collides with a callable PHP function. + */ + private function writePhpCommandCollisionHint(string $input): void + { + $function = $this->getPhpCommandCollisionFunction($input); + if ($function === null) { + return; + } + + $label = OutputFormatter::escape($function.'()'); + $this->output->writeln(\sprintf( + 'Input also matches PHP function %s; prefix with ";" to execute PHP instead.', + $label + )); + } + + /** + * Return the callable PHP function name when a command input also resolves as a direct PHP call. + */ + private function getPhpCommandCollisionFunction(string $input): ?string + { + $commandName = $this->extractCommandName($input); + if ($commandName === null || $this->cleaner === null) { + return null; + } + + return $this->cleaner->getCallableFunctionForInput($input, $commandName); } /** @@ -1502,13 +2342,7 @@ protected function getPrompt() return null; } - $theme = $this->config->theme(); - - if ($this->hasCode()) { - return $theme->bufferPrompt(); - } - - return $theme->prompt(); + return $this->config->theme()->prompt(); } /** @@ -1537,7 +2371,11 @@ protected function readline(bool $interactive = true) return $line; } - $bracketedPaste = $interactive && $this->config->useBracketedPaste(); + $this->writeLegacyPromptSpacer(); + + // Interactive readline manages bracketed paste internally + $usesInteractiveReadline = $this->readline instanceof InteractiveReadlineInterface; + $bracketedPaste = $interactive && $this->config->useBracketedPaste() && !$usesInteractiveReadline; if ($bracketedPaste) { \printf("\e[?2004h"); // Enable bracketed paste @@ -1587,6 +2425,8 @@ public static function getVersionHeader(bool $useUnicode = false): string /** * Get a PHP manual database instance. * + * @deprecated Use getManual() instead for unified access to all manual formats + * * @return \PDO|null */ public function getManualDb() @@ -1594,6 +2434,16 @@ public function getManualDb() return $this->config->getManualDb(); } + /** + * Get a PHP manual loader. + * + * @return Manual\ManualInterface|null + */ + public function getManual() + { + return $this->config->getManual(); + } + /** * Initialize tab completion matchers. * @@ -1602,33 +2452,118 @@ public function getManualDb() */ protected function initializeTabCompletion() { - if (!$this->config->useTabCompletion()) { + if (!$this->config->useTabCompletion() || $this->readline instanceof InteractiveReadlineInterface) { return; } $this->autoCompleter = $this->config->getAutoCompleter(); + if ($this->completionEngine === null) { + throw new \LogicException('Completion engine must be initialized before tab completion.'); + } - // auto completer needs shell to be linked to configuration because of - // the context aware matchers - $this->addMatchersToAutoCompleter($this->getDefaultMatchers()); - $this->addMatchersToAutoCompleter($this->matchers); - + $this->autoCompleter->setCompletionEngine($this->completionEngine); $this->autoCompleter->activate(); } /** - * Add matchers to the auto completer, setting context if needed. + * Initialize context-aware completion for the active readline frontend. + */ + private function initializeCompletionEngine(): void + { + $completion = new CompletionEngine($this->context, $this->cleaner); + $this->completionEngine = $completion; + + $allCommands = $this->all(); + $commandContextRefiner = new CommandContextRefiner($allCommands); + $commandSource = new CommandSource($allCommands); + $commandOptionSource = new CommandOptionSource($allCommands); + $commandArgumentSource = new CommandArgumentSource($allCommands); + $completion->addRefiner($commandContextRefiner); + $this->commandCompletion[] = $commandContextRefiner; + $this->commandCompletion[] = $commandSource; + $this->commandCompletion[] = $commandOptionSource; + $this->commandCompletion[] = $commandArgumentSource; + + $sources = [ + $commandSource, + $commandOptionSource, + $commandArgumentSource, + ]; + + if ($this->readline instanceof InteractiveReadlineInterface) { + $sources[] = new HistorySource($this->readline->getHistory()); + } + + $completion->registerDefaultSources($sources); + + foreach ($this->pendingCompletionSources as $source) { + $completion->addSource($source); + } + $this->pendingCompletionSources = []; + + $this->addLegacyMatchersToCompletionEngine($this->getDefaultCompletionCompatibilityMatchers()); + + if (!empty($this->matchers)) { + $this->addLegacyMatchersToCompletionEngine($this->matchers); + } + + if ($this->readline instanceof InteractiveReadlineInterface) { + $this->readline->setCompletionEngine($completion); + } + } + + /** + * Filter out objects already present in an existing array. + */ + protected function deduplicateObjects(array $new, array $existing): array + { + $seen = []; + foreach ($existing as $item) { + if (\is_object($item)) { + $seen[\spl_object_id($item)] = true; + } + } + + return \array_values(\array_filter( + $new, + fn ($item) => !\is_object($item) || !isset($seen[\spl_object_id($item)]) + )); + } + + /** + * Add legacy matchers to completion engine via adapter. * - * @param array $matchers + * @param array $matchers Legacy matchers to adapt */ - private function addMatchersToAutoCompleter(array $matchers) + private function addLegacyMatchersToCompletionEngine(array $matchers): void { + if ($this->completionEngine === null) { + throw new \LogicException('Completion engine is not set'); + } + + // Set context on context-aware matchers foreach ($matchers as $matcher) { if ($matcher instanceof ContextAware) { $matcher->setContext($this->context); } - $this->autoCompleter->addMatcher($matcher); } + + // MatcherAdapterSource filters out matchers superseded by new-style sources + $this->completionEngine->addSource(new MatcherAdapterSource($matchers)); + } + + /** + * Matcher-only built-ins that do not yet have source-based equivalents. + * + * @return Matcher\AbstractMatcher[] + */ + protected function getDefaultCompletionCompatibilityMatchers(): array + { + return [ + new Matcher\ClassMethodDefaultParametersMatcher(), + new Matcher\ObjectMethodDefaultParametersMatcher(), + new Matcher\FunctionDefaultParametersMatcher(), + ]; } /** @@ -1652,6 +2587,25 @@ protected function writeVersionInfo() } } + /** + * Check for manual updates and write notification if available. + */ + protected function writeManualUpdateInfo() + { + if (\PHP_SAPI !== 'cli') { + return; + } + + try { + $checker = $this->config->getManualChecker(); + if ($checker && !$checker->isLatest()) { + $this->output->writeln(\sprintf('New PHP manual is available (latest: %s). Update with `doc --update-manual`', $checker->getLatest())); + } + } catch (\Exception $e) { + // Silently ignore manual update check failures + } + } + /** * Write a startup message if set. */ diff --git a/app/vendor/psy/psysh/src/Shell/PendingInputState.php b/app/vendor/psy/psysh/src/Shell/PendingInputState.php new file mode 100644 index 000000000..44e1fd6ca --- /dev/null +++ b/app/vendor/psy/psysh/src/Shell/PendingInputState.php @@ -0,0 +1,95 @@ +pendingCodeBuffer !== []; + } + + public function hasValidCode(): bool + { + return $this->hasCode() && !$this->pendingCodeBufferOpen && $this->pendingCode !== false; + } + + public function pushCurrentCode(): void + { + $this->pendingCodeStack[] = [$this->pendingCodeBuffer, $this->pendingCodeBufferOpen, $this->pendingCode]; + } + + public function restorePreviousCode(): void + { + $this->clear(); + + if ($this->pendingCodeStack === []) { + return; + } + + [$this->pendingCodeBuffer, $this->pendingCodeBufferOpen, $this->pendingCode] = \array_pop($this->pendingCodeStack); + } + + public function clear(): void + { + $this->pendingCodeBuffer = []; + $this->pendingCodeBufferOpen = false; + $this->pendingCode = false; + } + + public function appendLine(string $code, bool $silent): string + { + $trimmed = \rtrim($code); + if (\substr($trimmed, -1) === '\\') { + $this->pendingCodeBufferOpen = true; + $code = \substr($trimmed, 0, -1); + } else { + $this->pendingCodeBufferOpen = false; + } + + $this->pendingCodeBuffer[] = $silent ? new SilentInput($code) : $code; + + return $code; + } + + /** + * @return string|false + */ + public function getPendingCode() + { + return $this->pendingCode; + } + + /** + * @param string|false $pendingCode + */ + public function setPendingCode($pendingCode): void + { + $this->pendingCode = $pendingCode; + } + + public function getPendingCodeBuffer(): array + { + return $this->pendingCodeBuffer; + } +} diff --git a/app/vendor/psy/psysh/src/ShellAware.php b/app/vendor/psy/psysh/src/ShellAware.php new file mode 100644 index 000000000..b6635109b --- /dev/null +++ b/app/vendor/psy/psysh/src/ShellAware.php @@ -0,0 +1,26 @@ +logger = $logger; + $this->levels = $levels; + } + + /** + * Log user input. + * + * @param string $input User code input + */ + public function logInput(string $input): void + { + if (!$this->isInputDisabled()) { + $this->logger->log($this->levels['input'], 'PsySH input', [ + 'input' => $input, + ]); + } + } + + /** + * Log a PsySH command. + * + * @param string $command Command string (e.g., "ls", "doc array_map") + */ + public function logCommand(string $command): void + { + if (!$this->isCommandDisabled()) { + $this->logger->log($this->levels['command'], 'PsySH command', [ + 'command' => $command, + ]); + } + } + + /** + * Log code about to be executed. + * + * @param string $code Cleaned PHP code + */ + public function logExecute(string $code): void + { + if (!$this->isExecuteDisabled()) { + $this->logger->log($this->levels['execute'], 'PsySH execute', [ + 'code' => $code, + ]); + } + } + + /** + * Check if input logging is disabled. + */ + public function isInputDisabled(): bool + { + return $this->levels['input'] === false; + } + + /** + * Check if command logging is disabled. + */ + public function isCommandDisabled(): bool + { + return $this->levels['command'] === false; + } + + /** + * Check if execute logging is disabled. + */ + public function isExecuteDisabled(): bool + { + return $this->levels['execute'] === false; + } +} diff --git a/app/vendor/psy/psysh/src/Sudo.php b/app/vendor/psy/psysh/src/Sudo.php index 329f3f56e..f805276be 100644 --- a/app/vendor/psy/psysh/src/Sudo.php +++ b/app/vendor/psy/psysh/src/Sudo.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -54,7 +54,7 @@ public static function assignProperty($object, string $property, $value) * * @param object $object * @param string $method method name - * @param mixed $args... + * @param mixed ...$args * * @return mixed */ @@ -115,7 +115,7 @@ public static function assignStaticProperty($class, string $property, $value) * * @param string|object $class class name or instance * @param string $method method name - * @param mixed $args... + * @param mixed ...$args * * @return mixed */ @@ -162,7 +162,7 @@ public static function fetchClassConst($class, string $const) * Construct an instance of a class, bypassing private constructors. * * @param string $class class name - * @param mixed $args... + * @param mixed ...$args */ public static function newInstance(string $class, ...$args) { diff --git a/app/vendor/psy/psysh/src/Sudo/SudoVisitor.php b/app/vendor/psy/psysh/src/Sudo/SudoVisitor.php index 151dc527c..c6c1aadf9 100644 --- a/app/vendor/psy/psysh/src/Sudo/SudoVisitor.php +++ b/app/vendor/psy/psysh/src/Sudo/SudoVisitor.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -123,12 +123,12 @@ public function enterNode(Node $node) // not using prepareCall because the $node->args we started with are already Arg instances return new StaticCall(new FullyQualifiedName(Sudo::class), self::NEW_INSTANCE, $args); } + + return null; } private function prepareCall(string $method, array $args): StaticCall { - return new StaticCall(new FullyQualifiedName(Sudo::class), $method, \array_map(function ($arg) { - return new Arg($arg); - }, $args)); + return new StaticCall(new FullyQualifiedName(Sudo::class), $method, \array_map(fn ($arg) => new Arg($arg), $args)); } } diff --git a/app/vendor/psy/psysh/src/SuperglobalsEnv.php b/app/vendor/psy/psysh/src/SuperglobalsEnv.php index d3369c6ab..7d864af03 100644 --- a/app/vendor/psy/psysh/src/SuperglobalsEnv.php +++ b/app/vendor/psy/psysh/src/SuperglobalsEnv.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/SystemEnv.php b/app/vendor/psy/psysh/src/SystemEnv.php index fe2a8edcf..3240802ed 100644 --- a/app/vendor/psy/psysh/src/SystemEnv.php +++ b/app/vendor/psy/psysh/src/SystemEnv.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/AutoCompleter.php b/app/vendor/psy/psysh/src/TabCompletion/AutoCompleter.php index 1be9caa99..040b98731 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/AutoCompleter.php +++ b/app/vendor/psy/psysh/src/TabCompletion/AutoCompleter.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,6 +11,9 @@ namespace Psy\TabCompletion; +use Psy\Completion\CompletionEngine; +use Psy\Completion\CompletionRequest; +use Psy\Completion\Source\MatcherAdapterSource; use Psy\TabCompletion\Matcher\AbstractMatcher; /** @@ -21,7 +24,8 @@ class AutoCompleter { /** @var Matcher\AbstractMatcher[] */ - protected $matchers; + protected $matchers = []; + private ?CompletionEngine $completionEngine = null; /** * Register a tab completion Matcher. @@ -31,6 +35,22 @@ class AutoCompleter public function addMatcher(AbstractMatcher $matcher) { $this->matchers[] = $matcher; + + if ($this->completionEngine !== null) { + $this->completionEngine->addSource(new MatcherAdapterSource([$matcher])); + } + } + + /** + * Use the canonical completion engine for readline callbacks. + */ + public function setCompletionEngine(CompletionEngine $completionEngine): void + { + $this->completionEngine = $completionEngine; + + if ($this->matchers !== []) { + $this->completionEngine->addSource(new MatcherAdapterSource($this->matchers)); + } } /** @@ -52,33 +72,15 @@ public function activate() */ public function processCallback(string $input, int $index, array $info = []): array { - // Some (Windows?) systems provide incomplete `readline_info`, so let's - // try to work around it. - $line = $info['line_buffer']; - if (isset($info['end'])) { - $line = \substr($line, 0, $info['end']); - } - if ($line === '' && $input !== '') { - $line = $input; - } - - $tokens = \token_get_all('normalizeLineBuffer($input, $info); - // remove whitespaces - $tokens = \array_filter($tokens, function ($token) { - return !AbstractMatcher::tokenIs($token, AbstractMatcher::T_WHITESPACE); - }); - // reset index from 0 to remove missing index number - $tokens = \array_values($tokens); - - $matches = []; - foreach ($this->matchers as $matcher) { - if ($matcher->hasMatched($tokens)) { - $matches = \array_merge($matcher->getMatches($tokens, $info), $matches); - } + if ($this->completionEngine === null) { + throw new \LogicException('AutoCompleter requires a CompletionEngine.'); } - $matches = \array_unique($matches); + $matches = $this->completionEngine->getCompletions( + new CompletionRequest($line, \mb_strlen($line), CompletionRequest::MODE_TAB, $info) + ); return !empty($matches) ? $matches : ['']; } @@ -98,6 +100,19 @@ public function callback(string $input, int $index): array return $this->processCallback($input, $index, \readline_info()); } + private function normalizeLineBuffer(string $input, array $info): string + { + $line = $info['line_buffer'] ?? ''; + if (isset($info['end'])) { + $line = \substr($line, 0, $info['end']); + } + if ($line === '' && $input !== '') { + $line = $input; + } + + return $line; + } + /** * Remove readline callback handler on destruct. */ diff --git a/app/vendor/psy/psysh/src/TabCompletion/AutoloadWarmer/AutoloadWarmerInterface.php b/app/vendor/psy/psysh/src/TabCompletion/AutoloadWarmer/AutoloadWarmerInterface.php new file mode 100644 index 000000000..8fc31c798 --- /dev/null +++ b/app/vendor/psy/psysh/src/TabCompletion/AutoloadWarmer/AutoloadWarmerInterface.php @@ -0,0 +1,32 @@ +setWarmAutoload(true); + * + * // Disable autoload warming (default) + * $config->setWarmAutoload(false); + * + * // Configure ComposerAutoloadWarmer options + * $config->setWarmAutoload([ + * 'includeVendor' => true, // Include all vendor packages + * 'includeTests' => false, // Exclude test namespaces + * 'includeNamespaces' => ['App\\', 'Lib\\'], // Only these namespaces + * 'excludeNamespaces' => ['App\\Legacy\\'], // Exclude specific namespaces + * ]); + * + * // Include specific vendor packages only + * $config->setWarmAutoload([ + * 'includeVendorNamespaces' => ['Symfony\\', 'Doctrine\\'], + * ]); + * + * // Include all vendor except specific packages + * $config->setWarmAutoload([ + * 'includeVendor' => true, + * 'excludeVendorNamespaces' => ['Symfony\\Debug\\'], + * ]); + * + * // Use custom warmers only + * $config->setWarmAutoload([ + * 'warmers' => [$myCustomWarmer], + * ]); + * + * // Combine custom warmers with configured ComposerAutoloadWarmer + * $config->setWarmAutoload([ + * 'warmers' => [$myCustomWarmer], + * 'includeVendorNamespaces' => ['Symfony\\'], + * ]); + */ +class ComposerAutoloadWarmer implements AutoloadWarmerInterface +{ + private bool $includeVendor; + private bool $includeTests; + private array $includeNamespaces; + private array $excludeNamespaces; + private array $includeVendorNamespaces; + private array $excludeVendorNamespaces; + private ?string $vendorDir = null; + private ?string $pharPrefix = null; + + private const KNOWN_BAD_NAMESPACES = [ + 'Psy\\Readline\\Hoa\\', + // Autoloading Composer classes breaks Composer autoloading :grimacing: + 'Composer\\', + // DI is an optional Symfony Console dependency; prevent explosion + 'Symfony\\Component\\Console\\DependencyInjection\\', + ]; + + /** + * PsySH's php-scoper prefix pattern for PHAR builds. + * + * Vendor dependencies in the PHAR are prefixed with "_Psy\" to avoid + * conflicts with user dependencies. The hash is randomly generated per build. + */ + private const PHAR_SCOPED_PREFIX_PATTERN = '/^_Psy[a-f0-9]+\\\\/'; + + /** + * @param array $config Configuration options + * @param string|null $vendorDir Optional vendor directory path (auto-detected if not provided) + */ + public function __construct(array $config = [], ?string $vendorDir = null) + { + $hasVendorFilters = isset($config['includeVendorNamespaces']) || isset($config['excludeVendorNamespaces']); + + // Validate conflicting config + if ($hasVendorFilters && isset($config['includeVendor']) && $config['includeVendor'] === false) { + throw new \InvalidArgumentException('Cannot use includeVendorNamespaces or excludeVendorNamespaces when includeVendor is false'); + } + + // Vendor namespace filters imply includeVendor: true + $this->includeVendor = $config['includeVendor'] ?? $hasVendorFilters; + $this->includeTests = $config['includeTests'] ?? false; + $this->includeNamespaces = $this->normalizeNamespaces($config['includeNamespaces'] ?? []); + $this->excludeNamespaces = $this->normalizeNamespaces($config['excludeNamespaces'] ?? []); + $this->includeVendorNamespaces = $this->normalizeNamespaces($config['includeVendorNamespaces'] ?? []); + $this->excludeVendorNamespaces = $this->normalizeNamespaces($config['excludeVendorNamespaces'] ?? []); + + // Cache PHAR prefix to avoid repeated Phar::running() calls + if (Shell::isPhar()) { + $runningPhar = \Phar::running(false); + $this->pharPrefix = 'phar://'.$runningPhar.'/'; + } + + $vendorDir = $vendorDir ?? $this->findVendorDir(); + if ($vendorDir !== null) { + $resolvedVendorDir = \realpath($vendorDir); + if ($resolvedVendorDir !== false) { + $this->vendorDir = \str_replace('\\', '/', $resolvedVendorDir); + } + } + } + + /** + * {@inheritdoc} + */ + public function warm(): int + { + // Get count of already-loaded classes before we start + $beforeCount = \count(\get_declared_classes()) + + \count(\get_declared_interfaces()) + + \count(\get_declared_traits()); + + $classes = $this->getClassNames(); + foreach ($classes as $class) { + try { + // Skip if already loaded (check without autoloading first) + if ( + \class_exists($class, false) || + \interface_exists($class, false) || + \trait_exists($class, false) + ) { + continue; + } + + // Try to load the class/interface/trait + // The autoload parameter (true) will trigger autoloading + \class_exists($class, true) || + \interface_exists($class, true) || + \trait_exists($class, true); + } catch (\Throwable $e) { + // Ignore classes that fail to load + // This is expected for classes with missing dependencies, etc. + } + } + + // Return the number of newly loaded classes + $afterCount = \count(\get_declared_classes()) + + \count(\get_declared_interfaces()) + + \count(\get_declared_traits()); + + return $afterCount - $beforeCount; + } + + /** + * Discover classes from available sources. + * + * Uses two complementary strategies: + * 1. ClassLoader's classmap (from optimized autoload or registered classes) + * 2. ClassMapGenerator to scan PSR-4 directories (if available, safe, no side effects) + * + * Both strategies are attempted and results are combined, since ClassLoader + * may have an optimized classmap while ClassMapGenerator can discover new + * classes added during development. + * + * @internal This method is exported for testability and is not part of the public API + * + * @return string[] Fully-qualified class names + */ + public function getClassNames(): array + { + $autoloadMap = $this->getAutoloadClassMap(); + $generatedMap = $this->generateClassMap(); + + return $this->classesFromClassMap(\array_merge($autoloadMap, $generatedMap)); + } + + /** + * Get class map from the registered Composer ClassLoader, if available. + * + * This map is populated by running `composer dump-autoload` + * + * @return array Map of class name => file path + */ + private function getAutoloadClassMap(): array + { + // If we found a project vendor dir, try to register their autoloader (if it hasn't been already) + // Skip if vendor dir is inside a PHAR (don't re-require the PHAR's autoloader) + if ($this->vendorDir !== null && \substr($this->vendorDir, 0, 7) !== 'phar://') { + $projectAutoload = $this->vendorDir.'/autoload.php'; + if (\file_exists($projectAutoload)) { + try { + require_once $projectAutoload; + } catch (\Throwable $e) { + // Ignore autoloader errors + } + } + } + + foreach (\spl_autoload_functions() as $autoloader) { + if (!\is_array($autoloader)) { + continue; + } + + $loader = $autoloader[0] ?? null; + if (!\is_object($loader) || \get_class($loader) !== 'Composer\Autoload\ClassLoader') { + continue; + } + + // Check if this loader contains scoped classes (indicates it's from the PHAR) + if (\method_exists($loader, 'getClassMap')) { + $classMap = $loader->getClassMap(); + foreach (\array_keys($classMap) as $class) { + if (\preg_match(self::PHAR_SCOPED_PREFIX_PATTERN, $class)) { + continue 2; // Skip to next autoloader + } + } + } + + // If we have an explicit vendor dir, check if this loader serves that directory + if ($this->vendorDir !== null) { + $hasTargetPaths = false; + + if (\method_exists($loader, 'getPrefixesPsr4')) { + $prefixes = $loader->getPrefixesPsr4(); + foreach ($prefixes as $namespace => $paths) { + foreach ($paths as $path) { + if (\strpos($path, $this->vendorDir.'/') === 0) { + $hasTargetPaths = true; + break 2; + } + } + } + } + + if (!$hasTargetPaths) { + continue; + } + } + + if (\method_exists($loader, 'getClassMap')) { + return $loader->getClassMap(); + } + + return []; + } + + return []; + } + + /** + * Scan autoload directories using a Composer ClassMapGenerator, if available. + * + * @return array Map of class name => file path + */ + private function generateClassMap(): array + { + if ($this->vendorDir === null || !\class_exists('Composer\\ClassMapGenerator\\ClassMapGenerator', true)) { + return []; + } + + // Get PSR-4 mappings from Composer + $psr4File = $this->vendorDir.'/composer/autoload_psr4.php'; + if (!\file_exists($psr4File)) { + return []; + } + + try { + $psr4Map = require $psr4File; + if (!\is_array($psr4Map)) { + return []; + } + + $generator = new \Composer\ClassMapGenerator\ClassMapGenerator(); + + foreach ($psr4Map as $prefix => $paths) { + foreach ($paths as $path) { + if (!\is_dir($path) || $this->shouldSkipPath($path)) { + continue; + } + + try { + $generator->scanPaths($path); + } catch (\Throwable $e) { + // Ignore errors (permissions, malformed files, etc.) + } + } + } + + return $generator->getClassMap()->getMap(); + } catch (\Throwable $e) { + return []; + } + } + + /** + * Find the vendor directory by checking registered autoloaders, falling + * back to filesystem search. + * + * @return string|null + */ + private function findVendorDir(): ?string + { + // When running the PsySH PHAR, skip autoloader detection. It will just return the internal + // vendor directory. + if ($this->pharPrefix !== null) { + // Try to find from autoloader + foreach (\spl_autoload_functions() as $autoloader) { + if (!\is_array($autoloader)) { + continue; + } + + $loader = $autoloader[0] ?? null; + if (!\is_object($loader)) { + continue; + } + + try { + $reflection = new \ReflectionClass($loader); + $loaderPath = $reflection->getFileName(); + $normalizedPath = \str_replace('\\', '/', $loaderPath); + + // Skip any other PHAR-based autoloaders + if (\strpos($normalizedPath, 'phar://') === 0) { + continue; + } + + // ClassLoader is typically at vendor/composer/ClassLoader.php + if (\strpos($normalizedPath, '/vendor/composer/') !== false) { + return \dirname($loaderPath, 2); + } + } catch (\Throwable $e) { + // Ignore and try next autoloader + } + } + } + + // Walk up the directory tree from cwd looking for vendor directory + $dir = \getcwd(); + $root = \dirname($dir); + + while ($dir !== $root) { + $vendorDir = $dir.'/vendor'; + if (\is_dir($vendorDir) && \file_exists($vendorDir.'/composer/autoload_psr4.php')) { + return $vendorDir; + } + + $root = $dir; + $dir = \dirname($dir); + } + + return null; + } + + /** + * Normalize namespace prefixes. + * + * Removes leading backslash and ensures trailing backslash. + * + * @param string[] $namespaces + * + * @return string[] + */ + private function normalizeNamespaces(array $namespaces): array + { + return \array_map(fn ($namespace) => \trim($namespace, '\\').'\\', $namespaces); + } + + /** + * Check if a path should be skipped based on configuration. + * + * @param string $path File or directory path + * + * @return bool True if the path should be skipped + */ + private function shouldSkipPath(string $path): bool + { + $normalizedPath = \str_replace('\\', '/', $path); + + // Skip paths from PsySH's own PHAR; these are PsySH's bundled dependencies, not user dependencies + if ($this->isPathFromPhar($normalizedPath)) { + return true; + } + + // Check if path is under vendor directory + if (!$this->includeVendor && $this->vendorDir !== null) { + // Resolve relative paths like "vendor/composer/../../src/Cache.php" before comparing + $resolvedPath = \realpath($path); + if ($resolvedPath === false) { + // File doesn't exist, permissions, etc. /shrug + return true; + } + + $resolvedPath = \str_replace('\\', '/', $resolvedPath); + if (\strpos($resolvedPath, $this->vendorDir.'/') === 0) { + return true; + } + } + + // Check test paths + if (!$this->includeTests) { + $patterns = ['/test/', '/tests/', '/spec/', '/specs/']; + foreach ($patterns as $pattern) { + if (\stripos($normalizedPath, $pattern) !== false) { + return true; + } + } + } + + return false; + } + + /** + * Get classes from class map, filtered based on configured namespace rules and excluded paths. + * + * @param array $classMap Map of class name => file path + * + * @return string[] + */ + private function classesFromClassMap(array $classMap): array + { + // First filter the map by path + $classMap = \array_filter($classMap, function ($path) { + return !$this->shouldSkipPath($path); + }); + + $classes = \array_keys($classMap); + + // Then filter by namespace + return \array_values( + \array_filter($classes, function ($class) use ($classMap) { + // Exclude PsySH's scoped PHAR dependencies (e.g., _Psy3684f4474398\Symfony\...) + if (\preg_match(self::PHAR_SCOPED_PREFIX_PATTERN, $class)) { + return false; + } + + // Hardcode excluding known-bad classes + foreach (self::KNOWN_BAD_NAMESPACES as $namespace) { + if (\stripos($class, $namespace) === 0) { + return false; + } + } + + $isVendorClass = $this->isVendorClass($class, $classMap); + + // Apply vendor-specific exclude filters + if ($isVendorClass && !empty($this->excludeVendorNamespaces)) { + foreach ($this->excludeVendorNamespaces as $namespace) { + if (\stripos($class, $namespace) === 0) { + return false; + } + } + } + + // Apply general exclude filters + foreach ($this->excludeNamespaces as $namespace) { + if (\stripos($class, $namespace) === 0) { + return false; + } + } + + // Apply vendor-specific include filters + if ($isVendorClass && !empty($this->includeVendorNamespaces)) { + foreach ($this->includeVendorNamespaces as $namespace) { + if (\stripos($class, $namespace) === 0) { + return true; + } + } + + return false; // Vendor class doesn't match vendor filters + } + + // Apply general include filters + if (!empty($this->includeNamespaces)) { + foreach ($this->includeNamespaces as $namespace) { + if (\stripos($class, $namespace) === 0) { + return true; + } + } + + return false; + } + + // No include filters provided, and didn't match exclude filters + return true; + }), + ); + } + + /** + * Check if a class is from the vendor directory. + * + * @param string $class Class name + * @param array $classMap Map of class name => file path + * + * @return bool + */ + private function isVendorClass(string $class, array $classMap): bool + { + if ($this->vendorDir === null || !isset($classMap[$class])) { + return false; + } + + $path = $classMap[$class]; + + // Resolve relative paths like "vendor/composer/../../src/Cache.php" before comparing + // This ensures consistency with shouldSkipPath() logic + $resolvedPath = \realpath($path); + if ($resolvedPath === false) { + // If realpath fails, fall back to raw path comparison + // This matches the behavior in shouldSkipPath() + $normalizedPath = \str_replace('\\', '/', $path); + + return \strpos($normalizedPath, $this->vendorDir.'/') === 0; + } + + $normalizedPath = \str_replace('\\', '/', $resolvedPath); + + return \strpos($normalizedPath, $this->vendorDir.'/') === 0; + } + + /** + * Check if a path is from PsySH's own PHAR. + * + * @param string $path File path to check + * + * @return bool True if the path is from PsySH's PHAR + */ + private function isPathFromPhar(string $path): bool + { + if ($this->pharPrefix === null || \strpos($path, 'phar://') !== 0) { + return false; + } + + return \strpos($path, $this->pharPrefix) === 0; + } +} diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractContextAwareMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractContextAwareMatcher.php index bc39e6047..fca52642c 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractContextAwareMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractContextAwareMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractDefaultParametersMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractDefaultParametersMatcher.php index 0887333a3..08c3453d0 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractDefaultParametersMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractDefaultParametersMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractMatcher.php index 209cae2f6..064b43fb8 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/AbstractMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -48,7 +48,7 @@ abstract class AbstractMatcher * * @param array $tokens Tokenized readline input * - * @return false + * @return bool */ public function hasMatched(array $tokens): bool { @@ -157,6 +157,7 @@ public static function isOperator($token): bool return false; } + // @phan-suppress-next-line PhanParamSuspiciousOrder - intentionally searching for token in constant string return \strpos(self::MISC_OPERATORS, $token) !== false; } diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassAttributesMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassAttributesMatcher.php index 0503d71db..9de5fd563 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassAttributesMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassAttributesMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodDefaultParametersMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodDefaultParametersMatcher.php index 118740ef2..05c05ca67 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodDefaultParametersMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodDefaultParametersMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodsMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodsMatcher.php index a526e1ec3..f334ad1ee 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodsMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassMethodsMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -48,9 +48,7 @@ public function getMatches(array $tokens, array $info = []): array $methods = $reflection->getMethods(\ReflectionMethod::IS_STATIC); } - $methods = \array_map(function (\ReflectionMethod $method) { - return $method->getName(); - }, $methods); + $methods = \array_map(fn (\ReflectionMethod $method) => $method->getName(), $methods); return \array_map( function ($name) use ($class) { @@ -59,9 +57,7 @@ function ($name) use ($class) { return $className.'::'.$name; }, - \array_filter($methods, function ($method) use ($input) { - return AbstractMatcher::startsWith($input, $method); - }) + \array_filter($methods, fn ($method) => AbstractMatcher::startsWith($input, $method)) ); } diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassNamesMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassNamesMatcher.php index 32a34640e..b192546e9 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassNamesMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ClassNamesMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -14,7 +14,7 @@ /** * A class name tab completion Matcher. * - * This matcher provides completion for all declared classes. + * This matcher provides completion for all declared classes, interfaces, and traits. * * @author Marc Garcia */ @@ -41,7 +41,7 @@ function ($className) use ($class) { return \implode('\\', \array_slice($pieces, $nsPos, \count($pieces))); }, \array_filter( - \array_merge(\get_declared_classes(), \get_declared_interfaces()), + \array_merge(\get_declared_classes(), \get_declared_interfaces(), \get_declared_traits()), function ($className) use ($quotedClass) { return AbstractMatcher::startsWith($quotedClass, $className); } diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/CommandsMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/CommandsMatcher.php index 952329a5b..56c98f4fc 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/CommandsMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/CommandsMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -12,6 +12,7 @@ namespace Psy\TabCompletion\Matcher; use Psy\Command\Command; +use Psy\CommandAware; /** * A Psy Command tab completion Matcher. @@ -21,7 +22,7 @@ * * @author Marc Garcia */ -class CommandsMatcher extends AbstractMatcher +class CommandsMatcher extends AbstractMatcher implements CommandAware { /** @var string[] */ protected $commands = []; @@ -37,7 +38,7 @@ public function __construct(array $commands) } /** - * Set Commands for completion. + * Set commands for completion. * * @param Command[] $commands */ @@ -45,8 +46,10 @@ public function setCommands(array $commands) { $names = []; foreach ($commands as $command) { - $names = \array_merge([$command->getName()], $names); - $names = \array_merge($command->getAliases(), $names); + $names[] = $command->getName(); + foreach ($command->getAliases() as $alias) { + $names[] = $alias; + } } $this->commands = $names; } @@ -84,9 +87,7 @@ public function getMatches(array $tokens, array $info = []): array { $input = $this->getInput($tokens); - return \array_filter($this->commands, function ($command) use ($input) { - return AbstractMatcher::startsWith($input, $command); - }); + return \array_filter($this->commands, fn ($command) => AbstractMatcher::startsWith($input, $command)); } /** diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ConstantsMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ConstantsMatcher.php index cad81a53e..b177aa413 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ConstantsMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ConstantsMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -27,9 +27,7 @@ public function getMatches(array $tokens, array $info = []): array { $const = $this->getInput($tokens); - return \array_filter(\array_keys(\get_defined_constants()), function ($constant) use ($const) { - return AbstractMatcher::startsWith($const, $constant); - }); + return \array_filter(\array_keys(\get_defined_constants()), fn ($constant) => AbstractMatcher::startsWith($const, $constant)); } /** diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionDefaultParametersMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionDefaultParametersMatcher.php index 2bbf12627..a273942a0 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionDefaultParametersMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionDefaultParametersMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionsMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionsMatcher.php index 2642a09e8..b3fafa704 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionsMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/FunctionsMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -30,9 +30,7 @@ public function getMatches(array $tokens, array $info = []): array $functions = \get_defined_functions(); $allFunctions = \array_merge($functions['user'], $functions['internal']); - return \array_filter($allFunctions, function ($function) use ($func) { - return AbstractMatcher::startsWith($func, $function); - }); + return \array_filter($allFunctions, fn ($function) => AbstractMatcher::startsWith($func, $function)); } /** diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/KeywordsMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/KeywordsMatcher.php index 9f2bdef7d..9043d1a89 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/KeywordsMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/KeywordsMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -56,9 +56,7 @@ public function getMatches(array $tokens, array $info = []): array { $input = $this->getInput($tokens); - return \array_filter($this->keywords, function ($keyword) use ($input) { - return AbstractMatcher::startsWith($input, $keyword); - }); + return \array_filter($this->keywords, fn ($keyword) => AbstractMatcher::startsWith($input, $keyword)); } /** diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/MagicMethodsMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MagicMethodsMatcher.php new file mode 100644 index 000000000..c52a54b27 --- /dev/null +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MagicMethodsMatcher.php @@ -0,0 +1,147 @@ +getInput($tokens); + + $firstToken = \array_pop($tokens); + if (self::tokenIs($firstToken, self::T_STRING)) { + // Pop the operator (-> or ::) which is now at the end + $operatorToken = \array_pop($tokens); + } else { + // First token IS the operator + $operatorToken = $firstToken; + } + + // Determine if this is instance (->) or static (::) context + $isStatic = self::tokenIs($operatorToken, self::T_DOUBLE_COLON); + + if ($isStatic) { + return $this->getStaticMatches($tokens, $input); + } + + return $this->getInstanceMatches($tokens, $input); + } + + /** + * Get magic method matches for instance context ($obj->). + * + * @return string[] + */ + private function getInstanceMatches(array $tokens, string $input): array + { + $objectToken = \array_pop($tokens); + if (!\is_array($objectToken)) { + return []; + } + $objectName = \str_replace('$', '', $objectToken[1]); + + try { + $object = $this->getVariable($objectName); + } catch (InvalidArgumentException $e) { + return []; + } + + if (!\is_object($object)) { + return []; + } + + try { + $reflection = new \ReflectionClass($object); + } catch (\ReflectionException $e) { + return []; + } + + $magicMethods = Docblock::getMagicMethods($reflection); + + $matches = []; + foreach ($magicMethods as $method) { + if (self::startsWith($input, $method->getName())) { + $matches[] = $method->getName(); + } + } + + return $matches; + } + + /** + * Get magic method matches for static context (Class::). + * + * @return string[] + */ + private function getStaticMatches(array $tokens, string $input): array + { + $class = $this->getNamespaceAndClass($tokens); + + try { + $reflection = new \ReflectionClass($class); + } catch (\ReflectionException $e) { + return []; + } + + $magicMethods = Docblock::getMagicMethods($reflection); + + // For static context, only return static magic methods + // unless this is a command like `doc` or `ls` that wants all methods + $needAll = self::needCompleteClass($tokens[1] ?? null); + + $matches = []; + foreach ($magicMethods as $method) { + if ($needAll || $method->isStatic()) { + if (self::startsWith($input, $method->getName())) { + $chunks = \explode('\\', $class); + $className = \array_pop($chunks); + $matches[] = $className.'::'.$method->getName(); + } + } + } + + return $matches; + } + + /** + * {@inheritdoc} + */ + public function hasMatched(array $tokens): bool + { + $token = \array_pop($tokens); + $prevToken = \array_pop($tokens); + + switch (true) { + // Instance: $obj-> or $obj->meth + case self::tokenIs($token, self::T_OBJECT_OPERATOR): + case self::tokenIs($prevToken, self::T_OBJECT_OPERATOR): + // Static: Class:: or Class::meth + case self::tokenIs($token, self::T_DOUBLE_COLON): + case self::tokenIs($prevToken, self::T_DOUBLE_COLON) && self::tokenIs($token, self::T_STRING): + return true; + } + + return false; + } +} diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/MagicPropertiesMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MagicPropertiesMatcher.php new file mode 100644 index 000000000..819cf49b7 --- /dev/null +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MagicPropertiesMatcher.php @@ -0,0 +1,144 @@ +getInput($tokens); + + $firstToken = \array_pop($tokens); + if (self::tokenIs($firstToken, self::T_STRING)) { + // Pop the operator (-> or ::) which is now at the end + $operatorToken = \array_pop($tokens); + } else { + // First token IS the operator + $operatorToken = $firstToken; + } + + // Determine if this is instance (->) or static (::) context + $isStatic = self::tokenIs($operatorToken, self::T_DOUBLE_COLON); + + if ($isStatic) { + return $this->getStaticMatches($tokens, $input); + } + + return $this->getInstanceMatches($tokens, $input); + } + + /** + * Get magic property matches for instance context ($obj->). + * + * @return string[] + */ + private function getInstanceMatches(array $tokens, string $input): array + { + $objectToken = \array_pop($tokens); + if (!\is_array($objectToken)) { + return []; + } + $objectName = \str_replace('$', '', $objectToken[1]); + + try { + $object = $this->getVariable($objectName); + } catch (InvalidArgumentException $e) { + return []; + } + + if (!\is_object($object)) { + return []; + } + + try { + $reflection = new \ReflectionClass($object); + } catch (\ReflectionException $e) { + return []; + } + + $magicProperties = Docblock::getMagicProperties($reflection); + + $matches = []; + foreach ($magicProperties as $property) { + if (self::startsWith($input, $property->getName())) { + $matches[] = $property->getName(); + } + } + + return $matches; + } + + /** + * Get magic property matches for static context (Class::). + * + * Static magic properties are less common but we support them for completeness. + * + * @return string[] + */ + private function getStaticMatches(array $tokens, string $input): array + { + $class = $this->getNamespaceAndClass($tokens); + + try { + $reflection = new \ReflectionClass($class); + } catch (\ReflectionException $e) { + return []; + } + + $magicProperties = Docblock::getMagicProperties($reflection); + + $matches = []; + foreach ($magicProperties as $property) { + if (self::startsWith($input, $property->getName())) { + $chunks = \explode('\\', $class); + $className = \array_pop($chunks); + $matches[] = $className.'::$'.$property->getName(); + } + } + + return $matches; + } + + /** + * {@inheritdoc} + */ + public function hasMatched(array $tokens): bool + { + $token = \array_pop($tokens); + $prevToken = \array_pop($tokens); + + switch (true) { + // Instance: $obj-> or $obj->prop + case self::tokenIs($token, self::T_OBJECT_OPERATOR): + case self::tokenIs($prevToken, self::T_OBJECT_OPERATOR): + // Static: Class:: or Class::$prop + case self::tokenIs($token, self::T_DOUBLE_COLON): + case self::tokenIs($prevToken, self::T_DOUBLE_COLON) && self::tokenIs($token, self::T_STRING): + return true; + } + + return false; + } +} diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoClientMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoClientMatcher.php index 3c70ee095..30edc82d2 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoClientMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoClientMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -43,12 +43,8 @@ public function getMatches(array $tokens, array $info = []): array $list = $object->listDBs(); return \array_filter( - \array_map(function ($info) { - return $info['name']; - }, $list['databases']), - function ($var) use ($input) { - return AbstractMatcher::startsWith($input, $var); - } + \array_map(fn ($info) => $info['name'], $list['databases']), + fn ($var) => AbstractMatcher::startsWith($input, $var) ); } diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoDatabaseMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoDatabaseMatcher.php index 7cea95f49..699977218 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoDatabaseMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/MongoDatabaseMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectAttributesMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectAttributesMatcher.php index e0e96679e..d5b3db2d4 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectAttributesMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectAttributesMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodDefaultParametersMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodDefaultParametersMatcher.php index 73221fd37..66f3c456b 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodDefaultParametersMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodDefaultParametersMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodsMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodsMatcher.php index 4f10b0796..251052748 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodsMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/ObjectMethodsMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/TabCompletion/Matcher/VariablesMatcher.php b/app/vendor/psy/psysh/src/TabCompletion/Matcher/VariablesMatcher.php index 6a5167f7c..d6b9e5aa3 100644 --- a/app/vendor/psy/psysh/src/TabCompletion/Matcher/VariablesMatcher.php +++ b/app/vendor/psy/psysh/src/TabCompletion/Matcher/VariablesMatcher.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -27,9 +27,34 @@ public function getMatches(array $tokens, array $info = []): array { $var = \str_replace('$', '', $this->getInput($tokens)); - return \array_filter(\array_keys($this->getVariables()), function ($variable) use ($var) { - return AbstractMatcher::startsWith($var, $variable); - }); + return \array_filter( + \array_keys($this->getVariables()), + fn ($variable) => AbstractMatcher::startsWith($var, $variable) + ); + } + + /** + * Get current readline input word (variable name). + * + * Overrides parent to handle T_VARIABLE tokens. + * + * @param array $tokens Tokenized readline input (see token_get_all) + */ + protected function getInput(array $tokens): string + { + $var = ''; + $firstToken = \array_pop($tokens); + + // Handle T_VARIABLE tokens (e.g., $varName) + if (\is_array($firstToken) && self::tokenIs($firstToken, self::T_VARIABLE)) { + // Token value includes the $, so strip it + $var = \ltrim((string) $firstToken[1], '$'); + } elseif (\is_array($firstToken) && self::tokenIs($firstToken, self::T_STRING)) { + // Fallback to parent behavior for T_STRING tokens + $var = (string) $firstToken[1]; + } + + return $var; } /** diff --git a/app/vendor/psy/psysh/src/Util/DependencyChecker.php b/app/vendor/psy/psysh/src/Util/DependencyChecker.php new file mode 100644 index 000000000..8eaaedce0 --- /dev/null +++ b/app/vendor/psy/psysh/src/Util/DependencyChecker.php @@ -0,0 +1,49 @@ + ['type', 'desc'], ]; + /** @var array Cache for getMagicMethods() */ + private static array $methodCache = []; + + /** @var array Cache for getMagicProperties() */ + private static array $propertyCache = []; + protected $reflector; /** @@ -104,9 +113,7 @@ protected function setComment(string $comment) protected static function prefixLength(array $lines): int { // find only lines with interesting things - $lines = \array_filter($lines, function ($line) { - return \substr($line, \strspn($line, "* \t\n\r\0\x0B")); - }); + $lines = \array_filter($lines, fn ($line) => \substr($line, \strspn($line, "* \t\n\r\0\x0B"))); // if we sort the lines, we only have to compare two items \sort($lines); @@ -119,10 +126,10 @@ protected static function prefixLength(array $lines): int return \strspn($first, "* \t\n\r\0\x0B"); } - // find the longest common substring + // find the longest common substring, but stop before @ (tag marker) $count = \min(\strlen($first), \strlen($last)); for ($i = 0; $i < $count; $i++) { - if ($first[$i] !== $last[$i]) { + if ($first[$i] !== $last[$i] || $first[$i] === '@') { return $i; } } @@ -145,9 +152,7 @@ protected function parseComment(string $comment) // Trim asterisks and whitespace from the beginning and whitespace from the end of lines $prefixLength = self::prefixLength($comment); - $comment = \array_map(function ($line) use ($prefixLength) { - return \rtrim(\substr($line, $prefixLength)); - }, $comment); + $comment = \array_map(fn ($line) => \rtrim(\substr($line, $prefixLength)), $comment); // Group the lines together by @tags $blocks = []; @@ -179,7 +184,7 @@ protected function parseComment(string $comment) // The tagged block is a vector $count = \count(self::$vectors[$tag]); if ($body) { - $parts = \preg_split('/\s+/', $body, $count); + $parts = self::splitOnWhitespace($body, $count); } else { $parts = []; } @@ -241,5 +246,475 @@ public static function strTag(string $str) if (\preg_match('/^@[a-z0-9_]+/', $str, $matches)) { return $matches[0]; } + + return null; + } + + /** + * Split a string on whitespace, respecting balanced brackets. + * + * Like preg_split('/\s+/', $str, $limit) but treats `<...>` and `(...)` as atomic, + * so `array $foo` splits into ['array', '$foo'] + * and `find(int $id)` stays as one token instead of being split. + * + * Uses a stack to ensure proper nesting (e.g. `<(>)` won't break). + * + * @param string $str The string to split + * @param int $limit Maximum number of parts (0 = unlimited) + * + * @return string[] + */ + private static function splitOnWhitespace(string $str, int $limit = 0): array + { + static $brackets = ['<' => '>', '(' => ')']; + + $parts = []; + $current = ''; + $stack = []; + $len = \strlen($str); + $i = 0; + + while ($i < $len) { + $char = $str[$i]; + + if (isset($brackets[$char])) { + // Opening bracket; push onto stack + $stack[] = $char; + $current .= $char; + } elseif (!empty($stack) && $brackets[\end($stack)] === $char) { + // Closing bracket matching the current opener; pop stack + \array_pop($stack); + $current .= $char; + } elseif (empty($stack) && \ctype_space($char)) { + // At top level, whitespace is a delimiter + if ($current !== '') { + $parts[] = $current; + $current = ''; + + // If we've hit the limit, grab the rest as the final part + if ($limit > 0 && \count($parts) === $limit - 1) { + $rest = \ltrim(\substr($str, $i)); + if ($rest !== '') { + $parts[] = $rest; + } + + return $parts; + } + } + // Skip consecutive whitespace + while ($i + 1 < $len && \ctype_space($str[$i + 1])) { + $i++; + } + } else { + $current .= $char; + } + + $i++; + } + + if ($current !== '') { + $parts[] = $current; + } + + return $parts; + } + + /** + * Get magic methods declared in this docblock via @method tags. + * + * Only works when the docblock was created from a ReflectionClass. + * + * @return ReflectionMagicMethod[] + */ + public function getMethods(): array + { + if (empty($this->comment) || !$this->reflector instanceof \ReflectionClass) { + return []; + } + + return self::parseMethodTags($this->comment, $this->reflector); + } + + /** + * Get magic properties declared in this docblock via @property tags. + * + * Includes property, property-read, and property-write tags. + * Only works when the docblock was created from a ReflectionClass. + * + * @return ReflectionMagicProperty[] + */ + public function getProperties(): array + { + if (empty($this->comment) || !$this->reflector instanceof \ReflectionClass) { + return []; + } + + return self::parsePropertyTags($this->comment, $this->reflector); + } + + /** + * Get all magic methods from a class and its parents, interfaces, and traits. + * + * Results are cached for performance. + * + * @return ReflectionMagicMethod[] + */ + public static function getMagicMethods(\ReflectionClass $class): array + { + $cacheKey = $class->getName(); + + if (isset(self::$methodCache[$cacheKey])) { + return self::$methodCache[$cacheKey]; + } + + $methods = []; + + // Walk parent classes first (so child methods take precedence) + $parent = $class->getParentClass(); + if ($parent !== false) { + foreach (self::getMagicMethods($parent) as $method) { + $methods[$method->getName()] = $method; + } + } + + // Walk interfaces + foreach ($class->getInterfaces() as $interface) { + foreach (self::getMagicMethods($interface) as $method) { + if (!isset($methods[$method->getName()])) { + $methods[$method->getName()] = $method; + } + } + } + + // Walk traits + foreach ($class->getTraits() as $trait) { + foreach (self::getMagicMethods($trait) as $method) { + if (!isset($methods[$method->getName()])) { + $methods[$method->getName()] = $method; + } + } + } + + // Parse this class's docblock (takes precedence over inherited) + $docComment = $class->getDocComment(); + if ($docComment !== false) { + foreach (self::parseMethodTags($docComment, $class) as $method) { + $methods[$method->getName()] = $method; + } + } + + self::$methodCache[$cacheKey] = \array_values($methods); + + return self::$methodCache[$cacheKey]; + } + + /** + * Get all magic properties from a class and its parents, interfaces, and traits. + * + * Results are cached for performance. + * + * @return ReflectionMagicProperty[] + */ + public static function getMagicProperties(\ReflectionClass $class): array + { + $cacheKey = $class->getName(); + + if (isset(self::$propertyCache[$cacheKey])) { + return self::$propertyCache[$cacheKey]; + } + + $properties = []; + + // Walk parent classes first (so child properties take precedence) + $parent = $class->getParentClass(); + if ($parent !== false) { + foreach (self::getMagicProperties($parent) as $property) { + $properties[$property->getName()] = $property; + } + } + + // Walk interfaces + foreach ($class->getInterfaces() as $interface) { + foreach (self::getMagicProperties($interface) as $property) { + if (!isset($properties[$property->getName()])) { + $properties[$property->getName()] = $property; + } + } + } + + // Walk traits + foreach ($class->getTraits() as $trait) { + foreach (self::getMagicProperties($trait) as $property) { + if (!isset($properties[$property->getName()])) { + $properties[$property->getName()] = $property; + } + } + } + + // Parse this class's docblock (takes precedence over inherited) + $docComment = $class->getDocComment(); + if ($docComment !== false) { + foreach (self::parsePropertyTags($docComment, $class) as $property) { + $properties[$property->getName()] = $property; + } + } + + self::$propertyCache[$cacheKey] = \array_values($properties); + + return self::$propertyCache[$cacheKey]; + } + + /** + * Clear the magic method and property caches. + * + * Useful for testing or when classes are redefined. + */ + public static function clearMagicCache(): void + { + self::$methodCache = []; + self::$propertyCache = []; + } + + /** + * Parse a single @method tag body. + * + * Handles: [static] [returnType] [&]methodName([params]) [description] + * + * @return array|null Parsed method data or null if invalid + */ + private static function parseMethodTag(string $body): ?array + { + $body = \trim($body); + if ($body === '') { + return null; + } + + $isStatic = false; + $returnType = null; + $returnsReference = false; + $name = null; + $parameters = ''; + $description = null; + + // Check for 'static' keyword at the start + if (\strpos($body, 'static ') === 0) { + $isStatic = true; + $body = \ltrim(\substr($body, 7)); + } + + // Split into tokens respecting generics + $tokens = self::splitOnWhitespace($body); + if (empty($tokens)) { + return null; + } + + // Find the method name (contains parentheses or is the last non-description token) + $methodIndex = null; + foreach ($tokens as $i => $token) { + if (\preg_match('/^&?[\w_]+\s*\(/', $token)) { + $methodIndex = $i; + break; + } + } + + // If no parentheses found, check for bare method name pattern + if ($methodIndex === null) { + foreach ($tokens as $i => $token) { + if (\preg_match('/^&?[\w_]+$/', $token) && $i > 0) { + // Could be a method name if previous tokens look like types + $methodIndex = $i; + break; + } + } + } + + // If still no method found, first token might be the method name + if ($methodIndex === null) { + if (\preg_match('/^&?[\w_]+/', $tokens[0])) { + $methodIndex = 0; + } else { + return null; + } + } + + // Everything before methodIndex is the return type + if ($methodIndex > 0) { + $returnType = \implode(' ', \array_slice($tokens, 0, $methodIndex)); + } + + // Parse the method token + $methodToken = $tokens[$methodIndex]; + + // Check for returns-by-reference + if (\strpos($methodToken, '&') === 0) { + $returnsReference = true; + $methodToken = \substr($methodToken, 1); + } + + // Extract method name and parameters + if (\preg_match('/^([\w_]+)\s*(?:\(([^\)]*)\))?/', $methodToken, $matches)) { + $name = $matches[1]; + $parameters = $matches[2] ?? ''; + } else { + return null; + } + + // Everything after the method token is the description + if ($methodIndex < \count($tokens) - 1) { + $descParts = \array_slice($tokens, $methodIndex + 1); + $description = \implode(' ', $descParts); + } + + return [ + 'name' => $name, + 'static' => $isStatic, + 'returnType' => $returnType, + 'returnsReference' => $returnsReference, + 'parameters' => $parameters, + 'description' => $description !== '' ? $description : null, + ]; + } + + /** + * Parse a single @property tag body. + * + * Handles: [type] $name [description] + * + * @param string $tagName One of 'property', 'property-read', 'property-write' + * + * @return array|null Parsed property data or null if invalid + */ + private static function parsePropertyTag(string $body, string $tagName): ?array + { + $body = \trim($body); + if ($body === '') { + return null; + } + + $type = null; + $name = null; + $description = null; + + // Split into tokens respecting generics + $tokens = self::splitOnWhitespace($body); + if (empty($tokens)) { + return null; + } + + // Find the property name (starts with $ or is a bare word after a type) + $nameIndex = null; + foreach ($tokens as $i => $token) { + if (\strpos($token, '$') === 0) { + $nameIndex = $i; + break; + } + } + + // If no $ found, check if second token looks like a name (first would be type) + if ($nameIndex === null && \count($tokens) >= 2) { + if (\preg_match('/^[\w_]+$/', $tokens[1])) { + $nameIndex = 1; + } + } + + // If still no name found, first token is the name (no type) + if ($nameIndex === null) { + $nameIndex = 0; + } + + // Everything before nameIndex is the type + if ($nameIndex > 0) { + $type = \implode(' ', \array_slice($tokens, 0, $nameIndex)); + } + + // Extract property name (strip $ if present) + $name = \ltrim($tokens[$nameIndex], '$'); + + // Everything after the name is the description + if ($nameIndex < \count($tokens) - 1) { + $descParts = \array_slice($tokens, $nameIndex + 1); + $description = \implode(' ', $descParts); + } + + return [ + 'name' => $name, + 'type' => $type, + 'readOnly' => $tagName === 'property-read', + 'writeOnly' => $tagName === 'property-write', + 'description' => $description !== '' ? $description : null, + ]; + } + + /** + * Parse all @method tags from a raw docblock comment. + * + * @return ReflectionMagicMethod[] + */ + private static function parseMethodTags(string $docComment, \ReflectionClass $class): array + { + $methods = []; + + if (\strpos($docComment, '@method') === false) { + return $methods; + } + + // Match @method tags (handles multi-line by stopping at next @ or end) + if (\preg_match_all('/@method\s+(.+?)(?=\n\s*\*\s*@|\n\s*\*\/|\z)/s', $docComment, $matches)) { + foreach ($matches[1] as $body) { + // Clean up the body (remove leading asterisks and normalize whitespace) + $body = \preg_replace('/\n\s*\*\s*/', ' ', $body); + $body = \trim($body); + + $parsed = self::parseMethodTag($body); + if ($parsed !== null) { + $methods[] = new ReflectionMagicMethod( + $class, + $parsed['name'], + $parsed['static'], + $parsed['returnType'], + $parsed['parameters'], + $parsed['description'], + $parsed['returnsReference'] + ); + } + } + } + + return $methods; + } + + /** + * Parse all @property tags from a raw docblock comment. + * + * @return ReflectionMagicProperty[] + */ + private static function parsePropertyTags(string $docComment, \ReflectionClass $class): array + { + $properties = []; + + // Match @property, @property-read, @property-write tags + $pattern = '/@(property(?:-read|-write)?)\s+(.+?)(?=\n\s*\*\s*@|\n\s*\*\/|\z)/s'; + + if (\preg_match_all($pattern, $docComment, $matches, \PREG_SET_ORDER)) { + foreach ($matches as $match) { + $tagName = $match[1]; + $body = \preg_replace('/\n\s*\*\s*/', ' ', $match[2]); + $body = \trim($body); + + $parsed = self::parsePropertyTag($body, $tagName); + if ($parsed !== null) { + $properties[] = new ReflectionMagicProperty( + $class, + $parsed['name'], + $parsed['type'], + $parsed['readOnly'], + $parsed['writeOnly'], + $parsed['description'] + ); + } + } + } + + return $properties; } } diff --git a/app/vendor/psy/psysh/src/Util/Json.php b/app/vendor/psy/psysh/src/Util/Json.php index a7eebca95..aa6ca2fd0 100644 --- a/app/vendor/psy/psysh/src/Util/Json.php +++ b/app/vendor/psy/psysh/src/Util/Json.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/Util/Mirror.php b/app/vendor/psy/psysh/src/Util/Mirror.php index 9dd0c1b06..1b58b40e2 100644 --- a/app/vendor/psy/psysh/src/Util/Mirror.php +++ b/app/vendor/psy/psysh/src/Util/Mirror.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -36,9 +36,9 @@ class Mirror * @throws \Psy\Exception\RuntimeException when a $member specified but not present on $value * @throws \InvalidArgumentException if $value is something other than an object or class/function name * - * @param mixed $value Class or function name, or variable instance - * @param string $member Optional: property, constant or method name (default: null) - * @param int $filter (default: CONSTANT | METHOD | PROPERTY | STATIC_PROPERTY) + * @param mixed $value Class or function name, or variable instance + * @param string|null $member Optional: property, constant or method name (default: null) + * @param int $filter (default: CONSTANT | METHOD | PROPERTY | STATIC_PROPERTY) * * @return \Reflector */ diff --git a/app/vendor/psy/psysh/src/Util/Str.php b/app/vendor/psy/psysh/src/Util/Str.php index dd126d1b4..95863defa 100644 --- a/app/vendor/psy/psysh/src/Util/Str.php +++ b/app/vendor/psy/psysh/src/Util/Str.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -108,4 +108,20 @@ protected static function unvisReplace(array $match): string return \chr($cp); } } + + /** + * Check whether a given string is a valid PHP class name. + * + * Validates that the name follows PHP identifier rules, with optional + * namespace separators. + * + * @param string $name The name to check + * + * @return bool True if the name is syntactically valid + */ + public static function isValidClassName(string $name): bool + { + // Regex based on https://www.php.net/manual/en/language.oop5.basic.php#language.oop5.basic.class + return \preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*(\\\\[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*)*$/', $name) === 1; + } } diff --git a/app/vendor/psy/psysh/src/Util/TerminalColor.php b/app/vendor/psy/psysh/src/Util/TerminalColor.php new file mode 100644 index 000000000..c9a05afa3 --- /dev/null +++ b/app/vendor/psy/psysh/src/Util/TerminalColor.php @@ -0,0 +1,356 @@ + self::isLight($bg) ? 'light' : 'dark', + 'bg' => self::toHex($bg), + 'blended' => $hex, + ]); + + return $hex; + } + + /** + * Query the terminal's foreground and background colors. + * + * Results are cached for the lifetime of the process. + * + * @return array{bg: int[]|null, fg: int[]|null} + */ + public static function queryTerminalColors(): array + { + if (self::$cachedColors !== null) { + return self::$cachedColors; + } + + self::$cachedColors = ['bg' => null, 'fg' => null]; + + $tty = self::openTty(); + if ($tty === null) { + DebugLog::log('TerminalColor', 'SKIP', ['reason' => 'no_tty']); + + return self::$cachedColors; + } + + $startTime = \microtime(true); + + try { + $sttyState = self::saveStty(); + if ($sttyState === null) { + DebugLog::log('TerminalColor', 'SKIP', ['reason' => 'stty_failed']); + + return self::$cachedColors; + } + + try { + // Put terminal in raw mode for direct I/O + @\shell_exec('stty -echo -icanon min 0 time 0 < /dev/tty 2>/dev/null'); + + // Query background and foreground together + \fwrite($tty, "\033]".self::OSC_BACKGROUND.";?\033\\\033]".self::OSC_FOREGROUND.";?\033\\"); + \fflush($tty); + + $response = self::readResponse($tty); + + $elapsed = (\microtime(true) - $startTime) * 1000; + + if ($response !== '') { + self::$cachedColors['bg'] = self::parseOscResponse($response, self::OSC_BACKGROUND); + self::$cachedColors['fg'] = self::parseOscResponse($response, self::OSC_FOREGROUND); + + DebugLog::log('TerminalColor', 'OSC_QUERY', [ + 'elapsed_ms' => \round($elapsed, 1), + 'bg' => self::$cachedColors['bg'] !== null ? self::toHex(self::$cachedColors['bg']) : 'null', + 'fg' => self::$cachedColors['fg'] !== null ? self::toHex(self::$cachedColors['fg']) : 'null', + 'response' => $response, + ]); + } else { + DebugLog::log('TerminalColor', 'OSC_QUERY', [ + 'elapsed_ms' => \round($elapsed, 1), + 'result' => 'no_response', + ]); + } + } finally { + self::restoreStty($sttyState); + } + } finally { + @\fclose($tty); + } + + return self::$cachedColors; + } + + /** + * Determine whether an RGB color is light (high luminance). + * + * @param int[] $rgb [r, g, b] values 0-255 + */ + public static function isLight(array $rgb): bool + { + return self::luminance($rgb) > 128; + } + + /** + * Compute perceived luminance for an RGB color. + * + * Uses the ITU-R BT.601 luma formula. + * + * @param int[] $rgb [r, g, b] values 0-255 + */ + public static function luminance(array $rgb): float + { + return 0.299 * $rgb[0] + 0.587 * $rgb[1] + 0.114 * $rgb[2]; + } + + /** + * Alpha-composite an overlay color onto a base color. + * + * @param int[] $overlay [r, g, b] values 0-255 + * @param int[] $base [r, g, b] values 0-255 + * + * @return int[] [r, g, b] blended result + */ + public static function blend(array $overlay, array $base, float $alpha): array + { + return [ + (int) \round($overlay[0] * $alpha + $base[0] * (1 - $alpha)), + (int) \round($overlay[1] * $alpha + $base[1] * (1 - $alpha)), + (int) \round($overlay[2] * $alpha + $base[2] * (1 - $alpha)), + ]; + } + + /** + * Convert an RGB array to a hex color string. + * + * @param int[] $rgb [r, g, b] values 0-255 + */ + public static function toHex(array $rgb): string + { + return \sprintf('#%02x%02x%02x', $rgb[0], $rgb[1], $rgb[2]); + } + + /** + * Parse an OSC color response for a given parameter number. + * + * Handles the `rgb:R/G/B`, `rgb:RR/GG/BB`, `rgb:RRR/GGG/BBB`, and + * `rgb:RRRR/GGGG/BBBB` formats returned by xterm-compatible terminals. + * + * @return int[]|null [r, g, b] values 0-255, or null on parse failure + */ + public static function parseOscResponse(string $response, string $param): ?array + { + // Match OSC response: ESC ] ; rgb:R.../G.../B... (terminated by BEL or ST) + $pattern = '/\033\]'.$param.';rgb:([0-9a-fA-F]{1,4})\/([0-9a-fA-F]{1,4})\/([0-9a-fA-F]{1,4})/'; + + if (!\preg_match($pattern, $response, $matches)) { + return null; + } + + // Components are 1-4 hex digits; normalize each channel to 0-255. + return [ + self::scaleColorComponent($matches[1]), + self::scaleColorComponent($matches[2]), + self::scaleColorComponent($matches[3]), + ]; + } + + /** + * Scale a hex color component string to an 8-bit value (0-255). + * + * Components are normalized by bit depth: + * - 1 hex digit (4-bit) 0x0-0xf -> 0-255 + * - 2 hex digits (8-bit) 0x00-0xff -> 0-255 + * - 3 hex digits (12-bit) 0x000-0xfff -> 0-255 + * - 4 hex digits (16-bit) 0x0000-0xffff -> 0-255 + */ + private static function scaleColorComponent(string $hex): int + { + $digits = \strlen($hex); + $value = \hexdec($hex); + + // 8-bit values are already in the target range. + if ($digits === 2) { + return (int) $value; + } + + $maxValue = (16 ** $digits) - 1; + + return (int) \round(($value * 255) / $maxValue); + } + + /** + * Open /dev/tty for terminal I/O. + * + * @return resource|null + */ + private static function openTty() + { + $tty = @\fopen('/dev/tty', 'r+'); + if ($tty === false) { + return null; + } + + \stream_set_blocking($tty, false); + + return $tty; + } + + /** + * Save the current stty state. + */ + private static function saveStty(): ?string + { + $state = @\shell_exec('stty -g < /dev/tty 2>/dev/null'); + if (!\is_string($state) || \trim($state) === '') { + return null; + } + + return \trim($state); + } + + /** + * Restore a previously saved stty state. + */ + private static function restoreStty(string $state): void + { + @\shell_exec(\sprintf('stty %s < /dev/tty 2>/dev/null', \escapeshellarg($state))); + } + + /** + * Read the terminal's response with a short timeout. + * + * @param resource $tty + */ + private static function readResponse($tty): string + { + $response = ''; + $deadline = \microtime(true) + self::QUERY_TIMEOUT_USEC / 1000000; + + while (\microtime(true) < $deadline) { + $read = [$tty]; + $write = null; + $except = null; + $remainingUsec = (int) (($deadline - \microtime(true)) * 1000000); + if ($remainingUsec <= 0) { + break; + } + + $ready = @\stream_select($read, $write, $except, 0, $remainingUsec); + if ($ready === false || $ready === 0) { + // No data yet; if we already have some response, we're probably done + if ($response !== '') { + break; + } + continue; + } + + $chunk = @\fread($tty, 256); + if ($chunk === false || $chunk === '') { + break; + } + + $response .= $chunk; + + // Stop if we've received both responses (two terminators, ST or BEL) + $terminators = \substr_count($response, "\033\\") + \substr_count($response, "\x07"); + if ($terminators >= 2) { + break; + } + } + + return $response; + } + + /** + * Reset the cached terminal colors. + * + * Primarily for testing. + */ + public static function resetCache(): void + { + self::$cachedColors = null; + } +} diff --git a/app/vendor/psy/psysh/src/Util/Tty.php b/app/vendor/psy/psysh/src/Util/Tty.php new file mode 100644 index 000000000..fb946ff21 --- /dev/null +++ b/app/vendor/psy/psysh/src/Util/Tty.php @@ -0,0 +1,102 @@ +/dev/null'); + + return self::$sttySupported = \is_string($stty) && \trim($stty) !== ''; + } + + /** + * Check whether a stream is a TTY. + * + * Falls back gracefully when stream_isatty and posix_isatty are + * unavailable, using fstat to check for a character device. + * + * Returns false when detection is uncertain. + * + * @param resource|int $stream + */ + public static function isatty($stream): bool + { + if (\function_exists('stream_isatty')) { + return @\stream_isatty($stream); + } + + if (\function_exists('posix_isatty')) { + return @\posix_isatty($stream); + } + + // Fallback: check fstat mode for character device (TTY = 0020000) + $stat = @\fstat($stream); + if (!\is_array($stat) || !isset($stat['mode'])) { + return false; + } + + return ($stat['mode'] & 0170000) === 0020000; + } + + /** + * Get the current terminal width in columns. + */ + public static function getWidth(int $default = self::DEFAULT_WIDTH): int + { + if (self::supportsStty() && \defined('STDOUT') && self::isatty(\STDOUT)) { + // Output format: "rows cols" + $size = @\shell_exec('stty size /dev/null'); + if ($size && \preg_match('/^\d+ (\d+)$/', \trim($size), $matches)) { + return (int) $matches[1]; + } + + $width = @\shell_exec('tput cols /dev/null'); + if ($width && \is_numeric(\trim($width))) { + return (int) \trim($width); + } + } + + // Check COLUMNS environment variable (may be stale after resize) + $width = \getenv('COLUMNS'); + if ($width && \is_numeric(\trim($width))) { + return (int) \trim($width); + } + + return $default; + } +} diff --git a/app/vendor/psy/psysh/src/VarDumper/Cloner.php b/app/vendor/psy/psysh/src/VarDumper/Cloner.php index a2fc6ad98..bf69b57bd 100644 --- a/app/vendor/psy/psysh/src/VarDumper/Cloner.php +++ b/app/vendor/psy/psysh/src/VarDumper/Cloner.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VarDumper/Dumper.php b/app/vendor/psy/psysh/src/VarDumper/Dumper.php index 54b5ac2d0..a38c35917 100644 --- a/app/vendor/psy/psysh/src/VarDumper/Dumper.php +++ b/app/vendor/psy/psysh/src/VarDumper/Dumper.php @@ -3,7 +3,22 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +/** + * @phan-file-suppress PhanRedefineClass + * @phan-file-suppress PhanRedefinedUsedTrait + * @phan-file-suppress PhanUndeclaredMethod + */ + +/* + * This file is part of Psy Shell. + * + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,98 +26,211 @@ namespace Psy\VarDumper; -use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\VarDumper\Cloner\Cursor; use Symfony\Component\VarDumper\Dumper\CliDumper; -/** - * A PsySH-specialized CliDumper. - */ -class Dumper extends CliDumper -{ - private OutputFormatter $formatter; - private bool $forceArrayIndexes; - - private const ONLY_CONTROL_CHARS = '/^[\x00-\x1F\x7F]+$/'; - private const CONTROL_CHARS = '/([\x00-\x1F\x7F]+)/'; - private const CONTROL_CHARS_MAP = [ - "\0" => '\0', - "\t" => '\t', - "\n" => '\n', - "\v" => '\v', - "\f" => '\f', - "\r" => '\r', - "\033" => '\e', - ]; +require_once __DIR__.'/DumperBase.php'; - public function __construct(OutputFormatter $formatter, $forceArrayIndexes = false) +$method = new \ReflectionMethod(CliDumper::class, 'enterHash'); +$typed = $method->getParameters()[1]->hasType(); +$returnTyped = $method->hasReturnType(); +if ($typed) { + if ($returnTyped) { + trait DumperEnterHashShim + { + public function enterHash(Cursor $cursor, int $type, $class, bool $hasChild): void + { + $this->doEnterHash($cursor, $type, $class, $hasChild); + } + } + } else { + trait DumperEnterHashShim + { + public function enterHash(Cursor $cursor, int $type, $class, bool $hasChild) + { + $this->doEnterHash($cursor, $type, $class, $hasChild); + } + } + } +} elseif ($returnTyped) { + trait DumperEnterHashShim { - $this->formatter = $formatter; - $this->forceArrayIndexes = $forceArrayIndexes; - parent::__construct(); - $this->setColors(false); + public function enterHash(Cursor $cursor, $type, $class, $hasChild): void + { + $this->doEnterHash($cursor, $type, $class, $hasChild); + } } - - /** - * {@inheritdoc} - */ - public function enterHash(Cursor $cursor, $type, $class, $hasChild): void +} else { + trait DumperEnterHashShim { - if (Cursor::HASH_INDEXED === $type || Cursor::HASH_ASSOC === $type) { - $class = 0; + public function enterHash(Cursor $cursor, $type, $class, $hasChild) + { + $this->doEnterHash($cursor, $type, $class, $hasChild); } - parent::enterHash($cursor, $type, $class, $hasChild); } +} - /** - * {@inheritdoc} - */ - protected function dumpKey(Cursor $cursor): void +$method = new \ReflectionMethod(CliDumper::class, 'dumpString'); +$typed = $method->getParameters()[1]->hasType(); +$returnTyped = $method->hasReturnType(); +if ($typed) { + if ($returnTyped) { + trait DumperDumpStringShim + { + public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut): void + { + $this->doDumpString($cursor, $str, $bin, $cut); + } + } + } else { + trait DumperDumpStringShim + { + public function dumpString(Cursor $cursor, string $str, bool $bin, int $cut) + { + $this->doDumpString($cursor, $str, $bin, $cut); + } + } + } +} elseif ($returnTyped) { + trait DumperDumpStringShim { - if ($this->forceArrayIndexes || Cursor::HASH_INDEXED !== $cursor->hashType) { - parent::dumpKey($cursor); + public function dumpString(Cursor $cursor, $str, $bin, $cut): void + { + $this->doDumpString($cursor, $str, $bin, $cut); } } - - protected function style($style, $value, $attr = []): string +} else { + trait DumperDumpStringShim { - if ('ref' === $style) { - $value = \strtr($value, '@', '#'); + public function dumpString(Cursor $cursor, $str, $bin, $cut) + { + $this->doDumpString($cursor, $str, $bin, $cut); } + } +} - $styled = ''; - $cchr = $this->styles['cchr']; - - $chunks = \preg_split(self::CONTROL_CHARS, $value, -1, \PREG_SPLIT_NO_EMPTY | \PREG_SPLIT_DELIM_CAPTURE); - foreach ($chunks as $chunk) { - if (\preg_match(self::ONLY_CONTROL_CHARS, $chunk)) { - $chars = ''; - $i = 0; - do { - $chars .= isset(self::CONTROL_CHARS_MAP[$chunk[$i]]) ? self::CONTROL_CHARS_MAP[$chunk[$i]] : \sprintf('\x%02X', \ord($chunk[$i])); - } while (isset($chunk[++$i])); - - $chars = $this->formatter->escape($chars); - $styled .= "<{$cchr}>{$chars}"; - } else { - $styled .= $this->formatter->escape($chunk); +$method = new \ReflectionMethod(CliDumper::class, 'style'); +$typed = $method->getParameters()[0]->hasType(); +$returnTyped = $method->hasReturnType(); +if ($typed) { + if ($returnTyped) { + trait DumperStyleShim + { + protected function style(string $style, string $value, array $attr = []): string + { + return $this->doStyle($style, $value, $attr); } } + } else { + trait DumperStyleShim + { + protected function style(string $style, string $value, array $attr = []) + { + return $this->doStyle($style, $value, $attr); + } + } + } +} elseif ($returnTyped) { + trait DumperStyleShim + { + protected function style($style, $value, $attr = []): string + { + return $this->doStyle($style, $value, $attr); + } + } +} else { + trait DumperStyleShim + { + protected function style($style, $value, $attr = []) + { + return $this->doStyle($style, $value, $attr); + } + } +} - $style = $this->styles[$style]; - - return "<{$style}>{$styled}"; +$method = new \ReflectionMethod(CliDumper::class, 'dumpLine'); +$typed = $method->getParameters()[0]->hasType(); +$returnTyped = $method->hasReturnType(); +if ($typed) { + if ($returnTyped) { + trait DumperDumpLineShim + { + protected function dumpLine(int $depth, bool $endOfValue = false): void + { + $this->doDumpLine($depth, $endOfValue); + } + } + } else { + trait DumperDumpLineShim + { + protected function dumpLine(int $depth, bool $endOfValue = false) + { + $this->doDumpLine($depth, $endOfValue); + } + } } +} elseif ($returnTyped) { + trait DumperDumpLineShim + { + protected function dumpLine($depth, $endOfValue = false): void + { + $this->doDumpLine($depth, $endOfValue); + } + } +} else { + trait DumperDumpLineShim + { + protected function dumpLine($depth, $endOfValue = false) + { + $this->doDumpLine($depth, $endOfValue); + } + } +} - /** - * {@inheritdoc} - */ - protected function dumpLine($depth, $endOfValue = false): void +$method = new \ReflectionMethod(CliDumper::class, 'dumpKey'); +$typed = $method->getParameters()[0]->hasType(); +$returnTyped = $method->hasReturnType(); +if ($typed) { + if ($returnTyped) { + trait DumperDumpKeyShim + { + protected function dumpKey(Cursor $cursor): void + { + $this->doDumpKey($cursor); + } + } + } else { + trait DumperDumpKeyShim + { + protected function dumpKey(Cursor $cursor) + { + $this->doDumpKey($cursor); + } + } + } +} elseif ($returnTyped) { + trait DumperDumpKeyShim + { + protected function dumpKey($cursor): void + { + $this->doDumpKey($cursor); + } + } +} else { + trait DumperDumpKeyShim { - if ($endOfValue && 0 < $depth) { - $this->line .= ','; + protected function dumpKey($cursor) + { + $this->doDumpKey($cursor); } - $this->line = $this->formatter->format($this->line); - parent::dumpLine($depth, $endOfValue); } } + +class Dumper extends DumperBase +{ + use DumperDumpKeyShim; + use DumperDumpLineShim; + use DumperDumpStringShim; + use DumperEnterHashShim; + use DumperStyleShim; +} diff --git a/app/vendor/psy/psysh/src/VarDumper/DumperBase.php b/app/vendor/psy/psysh/src/VarDumper/DumperBase.php new file mode 100644 index 000000000..2d892915e --- /dev/null +++ b/app/vendor/psy/psysh/src/VarDumper/DumperBase.php @@ -0,0 +1,362 @@ + '\0', + "\t" => '\t', + "\n" => '\n', + "\v" => '\v', + "\f" => '\f', + "\r" => '\r', + "\033" => '\e', + ]; + private const STRING_DELIMITERS = [ + '\\' => '\\\\', + '"' => '\\"', + '$' => '\\$', + ]; + private const STRING_ESCAPE_CHARS = '/([\x00-\x1F\x7F\\\\"$])/'; + private const HEREDOC_DELIMITERS = [ + '\\' => '\\\\', + '$' => '\\$', + ]; + private const HEREDOC_ESCAPE_CHARS = '/([\x00-\x1F\x7F\\\\$])/'; + + public function __construct(OutputFormatter $formatter, $forceArrayIndexes = false, bool $useDeprecatedMultilineStrings = false) + { + $this->formatter = $formatter; + $this->forceArrayIndexes = $forceArrayIndexes; + $this->useDeprecatedMultilineStrings = $useDeprecatedMultilineStrings; + parent::__construct(); + $this->setColors(false); + } + + protected function doEnterHash(Cursor $cursor, $type, $class, $hasChild): void + { + if (Cursor::HASH_INDEXED === $type || Cursor::HASH_ASSOC === $type) { + $class = 0; + } + parent::enterHash($cursor, $type, $class, $hasChild); + } + + protected function doDumpKey(Cursor $cursor): void + { + if (!$this->forceArrayIndexes && Cursor::HASH_INDEXED === $cursor->hashType) { + return; + } + + if (null === $key = $cursor->hashKey) { + return; + } + + if ($cursor->hashKeyIsBinary) { + $key = $this->utf8Encode($key); + } + + $attr = ['binary' => $cursor->hashKeyIsBinary]; + $bin = $cursor->hashKeyIsBinary ? 'b' : ''; + $style = 'key'; + + switch ($cursor->hashType) { + default: + case Cursor::HASH_INDEXED: + if (self::DUMP_LIGHT_ARRAY & $this->flags) { + break; + } + + $style = 'index'; + // no break + case Cursor::HASH_ASSOC: + if (\is_int($key)) { + $this->line .= $this->style($style, (string) $key).' => '; + } else { + $this->line .= $bin.$this->style($style, '"'); + $this->appendEscapedString((string) $key, $style); + $this->line .= $this->style($style, '"').' => '; + } + + break; + + case Cursor::HASH_RESOURCE: + case Cursor::HASH_OBJECT: + parent::dumpKey($cursor); + } + + if ($cursor->hardRefTo) { + $this->line .= $this->style('ref', '&'.($cursor->hardRefCount ? $cursor->hardRefTo : ''), ['count' => $cursor->hardRefCount]).' '; + } + } + + protected function doDumpString(Cursor $cursor, $str, $bin, $cut): void + { + $this->doDumpKey($cursor); + $this->collapseNextHash = $this->expandNextHash = false; + $attr = $cursor->attr; + + if ($bin) { + $str = (string) $this->utf8Encode($str); + } + + if ('' === $str) { + $this->line .= $this->style('str', '""'); + if ($cut) { + $this->line .= '…'.$cut; + } + $this->endValue($cursor); + + return; + } + + $attr += [ + 'length' => 0 <= $cut ? \mb_strlen($str, 'UTF-8') + $cut : 0, + 'binary' => $bin, + ]; + + $parts = $bin && false !== \strpos($str, "\0") ? [$str] : \explode("\n", $str); + if (isset($parts[1]) && !isset($parts[2]) && !isset($parts[1][0])) { + unset($parts[1]); + $parts[0] .= "\n"; + } + $last = \count($parts) - 1; + $index = $lineCut = 0; + $useHeredocMultilineStrings = $last && $this->useHeredocMultilineStrings(); + $heredocLabel = $useHeredocMultilineStrings ? $this->getHeredocLabel($parts) : null; + + if (self::DUMP_STRING_LENGTH & $this->flags) { + $this->line .= '('.$attr['length'].') '; + } + if ($bin) { + $this->line .= 'b'; + } + + if ($last) { + if ($useHeredocMultilineStrings) { + $this->line .= '<<<'.$this->style('str', (string) $heredocLabel); + } else { + $this->line .= $this->style('str', '"""'); + } + $this->dumpLine($cursor->depth); + } else { + $this->line .= $this->style('str', '"'); + } + + foreach ($parts as $part) { + $endsWithNewline = $index < $last; + $displayPart = $part; + $measurePart = $displayPart; + if ($useHeredocMultilineStrings && $endsWithNewline) { + $measurePart .= "\n"; + } elseif ($last && $endsWithNewline) { + $displayPart .= "\n"; + $measurePart = $displayPart; + } + if (0 < $this->maxStringWidth && $this->maxStringWidth < $len = \mb_strlen($measurePart, 'UTF-8')) { + $displayPart = (string) \mb_substr($displayPart, 0, $this->maxStringWidth, 'UTF-8'); + $lineCut = $len - $this->maxStringWidth; + } + if ($last && $cursor->depth > 0) { + $this->line .= $this->indentPad; + } + if ($displayPart !== '') { + if ($useHeredocMultilineStrings) { + $this->appendEscaped($displayPart, 'str', self::HEREDOC_ESCAPE_CHARS, self::HEREDOC_DELIMITERS); + } else { + $this->appendEscapedString($displayPart, 'str'); + } + } + if ($index++ === $last) { + if ($last) { + if ($displayPart !== '') { + $this->dumpLine($cursor->depth); + if ($cursor->depth > 0) { + $this->line .= $this->indentPad; + } + } + $this->line .= $useHeredocMultilineStrings ? $this->style('str', (string) $heredocLabel) : $this->style('str', '"""'); + } else { + $this->line .= $this->style('str', '"'); + } + if ($cut < 0) { + $this->line .= '…'; + $lineCut = 0; + } elseif ($cut) { + $lineCut += $cut; + } + } + if ($lineCut) { + $this->line .= '…'.$lineCut; + $lineCut = 0; + } + + if ($index > $last) { + $this->endValue($cursor); + } else { + $this->dumpLine($cursor->depth); + } + } + } + + protected function doStyle($style, $value, $attr = []) + { + if ($attr['if_links'] ?? false) { + return ''; + } + + if ('ref' === $style) { + $value = \strtr($value, '@', '#'); + } + + $styled = ''; + $baseStyle = $this->styles[$style] ?? null; + $controlStyle = $this->styles['cchr'] ?? null; + + $chunks = \preg_split(self::CONTROL_CHARS, $value, -1, \PREG_SPLIT_NO_EMPTY | \PREG_SPLIT_DELIM_CAPTURE); + foreach ($chunks as $chunk) { + if (\preg_match(self::ONLY_CONTROL_CHARS, $chunk)) { + $chars = ''; + $i = 0; + do { + $chars .= isset(self::CONTROL_CHARS_MAP[$chunk[$i]]) ? self::CONTROL_CHARS_MAP[$chunk[$i]] : \sprintf('\x%02X', \ord($chunk[$i])); + } while (isset($chunk[++$i])); + + $styled .= $this->applyStyle($controlStyle, $chars); + } else { + $styled .= $this->applyStyle($baseStyle, $chunk); + } + } + + return $styled; + } + + protected function doDumpLine($depth, $endOfValue = false): void + { + if ($endOfValue && 0 < $depth) { + $this->line .= ','; + } + + parent::dumpLine($depth, $endOfValue); + } + + private function applyStyle(?string $style, string $value): string + { + if ($style === null || !$this->formatter->hasStyle($style)) { + return $value; + } + + if (!$this->formatter->isDecorated()) { + return $value; + } + + return $this->formatter->getStyle($style)->apply($value); + } + + private function appendEscapedString(string $value, string $style): void + { + $this->appendEscaped($value, $style, self::STRING_ESCAPE_CHARS, self::STRING_DELIMITERS); + } + + private function appendEscaped(string $value, string $style, string $escapePattern, array $delimiters): void + { + $baseStyle = $this->styles[$style] ?? null; + $controlStyle = $this->styles['cchr'] ?? null; + + $chunks = \preg_split($escapePattern, $value, -1, \PREG_SPLIT_NO_EMPTY | \PREG_SPLIT_DELIM_CAPTURE); + foreach ($chunks as $chunk) { + $escaped = $this->escapeChar($chunk, $delimiters); + if ($escaped !== null) { + $this->line .= $this->applyStyle($controlStyle, $escaped); + } else { + $this->line .= $this->applyStyle($baseStyle, $chunk); + } + } + } + + private function escapeChar(string $char, array $delimiters): ?string + { + if (isset($delimiters[$char])) { + return $delimiters[$char]; + } + + if (isset(self::CONTROL_CHARS_MAP[$char])) { + return self::CONTROL_CHARS_MAP[$char]; + } + + if (\preg_match(self::ONLY_CONTROL_CHARS, $char)) { + return \sprintf('\x%02X', \ord($char)); + } + + return null; + } + + /** + * Pick a heredoc label that won't be mistaken for a closing marker. + * + * @param string[] $parts + */ + private function getHeredocLabel(array $parts): string + { + $label = self::HEREDOC_LABEL; + $suffix = 1; + + while ($this->partsContainHeredocLabel($parts, $label)) { + ++$suffix; + $label = self::HEREDOC_LABEL.'_'.$suffix; + } + + return $label; + } + + /** + * @param string[] $parts + */ + private function partsContainHeredocLabel(array $parts, string $label): bool + { + foreach ($parts as $part) { + if (\preg_match('/^\s*'.\preg_quote($label, '/').'(?:$|[;,])/', $this->escapeHeredocString($part))) { + return true; + } + } + + return false; + } + + private function escapeHeredocString(string $value): string + { + $escaped = ''; + $chunks = \preg_split(self::HEREDOC_ESCAPE_CHARS, $value, -1, \PREG_SPLIT_NO_EMPTY | \PREG_SPLIT_DELIM_CAPTURE); + + foreach ($chunks as $chunk) { + $escaped .= $this->escapeChar($chunk, self::HEREDOC_DELIMITERS) ?? $chunk; + } + + return $escaped; + } + + private function useHeredocMultilineStrings(): bool + { + return !$this->useDeprecatedMultilineStrings; + } +} diff --git a/app/vendor/psy/psysh/src/VarDumper/Presenter.php b/app/vendor/psy/psysh/src/VarDumper/Presenter.php index b76aed335..cbe2c30d0 100644 --- a/app/vendor/psy/psysh/src/VarDumper/Presenter.php +++ b/app/vendor/psy/psysh/src/VarDumper/Presenter.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -21,6 +21,7 @@ class Presenter { const VERBOSE = 1; + const RAW = 2; private Cloner $cloner; private Dumper $dumper; @@ -46,17 +47,17 @@ class Presenter 'protected' => 'protected', 'private' => 'private', 'meta' => 'comment', - 'key' => 'comment', + 'key' => 'array_key', 'index' => 'number', ]; - public function __construct(OutputFormatter $formatter, $forceArrayIndexes = false) + public function __construct(OutputFormatter $formatter, $forceArrayIndexes = false, bool $useDeprecatedMultilineStrings = false) { // Work around https://github.com/symfony/symfony/issues/23572 $oldLocale = \setlocale(\LC_NUMERIC, 0); \setlocale(\LC_NUMERIC, 'C'); - $this->dumper = new Dumper($formatter, $forceArrayIndexes); + $this->dumper = new Dumper($formatter, $forceArrayIndexes, $useDeprecatedMultilineStrings); $this->dumper->setStyles(self::STYLES); // Now put the locale back @@ -93,19 +94,21 @@ public function addCasters(array $casters) * * @param mixed $value */ - public function presentRef($value): string + public function presentRef($value, int $options = 0): string { - return $this->present($value, 0); + return $this->present($value, 0, $options); } /** * Present a full representation of the value. * * If $depth is 0, the value will be presented as a ref instead. + * Use Presenter::RAW when the caller owns the final output write; the + * default escaped mode is for formatter-managed embedding contexts. * - * @param mixed $value - * @param int $depth (default: null) - * @param int $options One of Presenter constants + * @param mixed $value + * @param int|null $depth (default: null) + * @param int $options One of Presenter constants */ public function present($value, ?int $depth = null, int $options = 0): string { @@ -132,6 +135,13 @@ public function present($value, ?int $depth = null, int $options = 0): string // Now put the locale back \setlocale(\LC_NUMERIC, $oldLocale); + return ($options & self::RAW) ? $output : $this->escapeOutput($output); + } + + private function escapeOutput(string $output): string + { + $output = \preg_replace('/\\\\(?=[<>])/', '\\\\\\\\', $output); + return OutputFormatter::escape($output); } } diff --git a/app/vendor/psy/psysh/src/VarDumper/PresenterAware.php b/app/vendor/psy/psysh/src/VarDumper/PresenterAware.php index 47590fb3a..3b4c2b0e2 100644 --- a/app/vendor/psy/psysh/src/VarDumper/PresenterAware.php +++ b/app/vendor/psy/psysh/src/VarDumper/PresenterAware.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -19,8 +19,6 @@ interface PresenterAware { /** * Set a reference to the Presenter. - * - * @param Presenter $presenter */ public function setPresenter(Presenter $presenter); } diff --git a/app/vendor/psy/psysh/src/VersionUpdater/Checker.php b/app/vendor/psy/psysh/src/VersionUpdater/Checker.php index 4de48013f..ee5fed6f5 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/Checker.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/Checker.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/Downloader.php b/app/vendor/psy/psysh/src/VersionUpdater/Downloader.php index 233db318b..2f41ecb0f 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/Downloader.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/Downloader.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/Downloader/CurlDownloader.php b/app/vendor/psy/psysh/src/VersionUpdater/Downloader/CurlDownloader.php index 5b40917b2..2d0903215 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/Downloader/CurlDownloader.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/Downloader/CurlDownloader.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -58,7 +58,9 @@ public function download(string $url): bool \curl_setopt($curl, \CURLOPT_URL, $url); $result = \curl_exec($curl); $error = \curl_error($curl); - \curl_close($curl); + if (\PHP_VERSION_ID < 80000) { + \curl_close($curl); + } \fclose($outputHandle); diff --git a/app/vendor/psy/psysh/src/VersionUpdater/Downloader/Factory.php b/app/vendor/psy/psysh/src/VersionUpdater/Downloader/Factory.php index e1cfd8465..06c6607f3 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/Downloader/Factory.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/Downloader/Factory.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/Downloader/FileDownloader.php b/app/vendor/psy/psysh/src/VersionUpdater/Downloader/FileDownloader.php index 2af6f6964..af3d76264 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/Downloader/FileDownloader.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/Downloader/FileDownloader.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/GitHubChecker.php b/app/vendor/psy/psysh/src/VersionUpdater/GitHubChecker.php index 62209d2e7..2f8b80c46 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/GitHubChecker.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/GitHubChecker.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/Installer.php b/app/vendor/psy/psysh/src/VersionUpdater/Installer.php index c346799aa..5143e1a4e 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/Installer.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/Installer.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/IntervalChecker.php b/app/vendor/psy/psysh/src/VersionUpdater/IntervalChecker.php index 4833fbddf..ec3d9a2a0 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/IntervalChecker.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/IntervalChecker.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/NoopChecker.php b/app/vendor/psy/psysh/src/VersionUpdater/NoopChecker.php index 2c8240e65..a064ecc76 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/NoopChecker.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/NoopChecker.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/VersionUpdater/SelfUpdate.php b/app/vendor/psy/psysh/src/VersionUpdater/SelfUpdate.php index b970d18ac..56dadf97b 100644 --- a/app/vendor/psy/psysh/src/VersionUpdater/SelfUpdate.php +++ b/app/vendor/psy/psysh/src/VersionUpdater/SelfUpdate.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. diff --git a/app/vendor/psy/psysh/src/functions.php b/app/vendor/psy/psysh/src/functions.php index 7b58344eb..56b13d30e 100644 --- a/app/vendor/psy/psysh/src/functions.php +++ b/app/vendor/psy/psysh/src/functions.php @@ -3,7 +3,7 @@ /* * This file is part of Psy Shell. * - * (c) 2012-2023 Justin Hileman + * (c) 2012-2026 Justin Hileman * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. @@ -11,14 +11,20 @@ namespace Psy; +use Psy\Exception\BreakException; +use Psy\Exception\InvalidManualException; use Psy\ExecutionLoop\ProcessForker; +use Psy\ManualUpdater\ManualUpdate; +use Psy\Util\DependencyChecker; use Psy\VersionUpdater\GitHubChecker; use Psy\VersionUpdater\Installer; use Psy\VersionUpdater\SelfUpdate; +use Symfony\Component\Console\Formatter\OutputFormatter; use Symfony\Component\Console\Input\ArgvInput; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputDefinition; use Symfony\Component\Console\Input\InputOption; +use Symfony\Component\Console\Output\OutputInterface; if (!\function_exists('Psy\\sh')) { /** @@ -28,7 +34,7 @@ */ function sh(): string { - if (\version_compare(\PHP_VERSION, '8.0', '<')) { + if (\PHP_VERSION_ID < 80000) { return '\extract(\Psy\debug(\get_defined_vars(), isset($this) ? $this : @\get_called_class()));'; } @@ -134,23 +140,7 @@ function info(?Configuration $config = null) if ($config !== null) { $lastConfig = $config; - return; - } - - $prettyPath = function ($path) { - return $path; - }; - - $homeDir = (new ConfigPaths())->homeDir(); - if ($homeDir && $homeDir = \rtrim($homeDir, '/')) { - $homePattern = '#^'.\preg_quote($homeDir, '#').'/#'; - $prettyPath = function ($path) use ($homePattern) { - if (\is_string($path)) { - return \preg_replace($homePattern, '~/', $path); - } else { - return $path; - } - }; + return null; } $config = $lastConfig ?: new Configuration(); @@ -171,9 +161,9 @@ function info(?Configuration $config = null) 'strict types' => $config->strictTypes(), 'error logging level' => $config->errorLoggingLevel(), 'config file' => [ - 'default config file' => $prettyPath($config->getConfigFile()), - 'local config file' => $prettyPath($config->getLocalConfigFile()), - 'PSYSH_CONFIG env' => $prettyPath($configEnv), + 'default config file' => ConfigPaths::prettyPath($config->getConfigFile()), + 'local config file' => ConfigPaths::prettyPath($config->getLocalConfigFile()), + 'PSYSH_CONFIG env' => ConfigPaths::prettyPath($configEnv), ], // 'config dir' => $config->getConfigDir(), // 'data dir' => $config->getDataDir(), @@ -194,23 +184,28 @@ function info(?Configuration $config = null) 'update available' => $updateAvailable, 'latest release version' => $latest, 'update check interval' => $config->getUpdateCheck(), - 'update cache file' => $prettyPath($config->getUpdateCheckCacheFile()), + 'update cache file' => ConfigPaths::prettyPath($config->getUpdateCheckCacheFile()), ]; $input = [ 'interactive mode' => $config->interactiveMode(), 'input interactive' => $config->getInputInteractive(), + 'bracketed paste' => $config->useBracketedPaste(), 'yolo' => $config->yolo(), ]; - if ($config->hasReadline()) { - $info = \readline_info(); + $readlineService = $config->getReadline(); + $interactiveReadline = $readlineService instanceof Readline\InteractiveReadlineInterface; - $readline = [ - 'readline available' => true, - 'readline enabled' => $config->useReadline(), - 'readline service' => \get_class($config->getReadline()), - ]; + $readline = [ + 'readline available' => $config->hasReadline(), + 'readline enabled' => $config->useReadline(), + 'readline service' => \get_class($readlineService), + ]; + + // Only show system readline library info when actually using it + if ($config->hasReadline() && !$interactiveReadline) { + $info = \readline_info(); if (isset($info['library_version'])) { $readline['readline library'] = $info['library_version']; @@ -219,10 +214,17 @@ function info(?Configuration $config = null) if (isset($info['readline_name']) && $info['readline_name'] !== '') { $readline['readline name'] = $info['readline_name']; } - } else { - $readline = [ - 'readline available' => false, - ]; + } + + $readline['interactive readline requested'] = $config->useExperimentalReadline(); + + if ($interactiveReadline) { + $readline['syntax highlighting'] = $config->useSyntaxHighlighting(); + } + + // Show supported diagnostic when requested but not active + if (!$interactiveReadline) { + $readline['interactive readline supported'] = Readline\InteractiveReadline::isSupported(); } $output = [ @@ -233,8 +235,8 @@ function info(?Configuration $config = null) ]; $theme = $config->theme(); - // @todo show styles (but only if they're different than default?) - $output['theme'] = [ + $output['theme'] = $theme->getName() ?? [ + // @todo show styles (but only if they're different than default?) 'compact' => $theme->compact(), 'prompt' => $theme->prompt(), 'bufferPrompt' => $theme->bufferPrompt(), @@ -243,64 +245,135 @@ function info(?Configuration $config = null) ]; $pcntl = [ - 'pcntl available' => ProcessForker::isPcntlSupported(), - 'posix available' => ProcessForker::isPosixSupported(), + 'pcntl available' => DependencyChecker::functionsAvailable(ProcessForker::PCNTL_FUNCTIONS), + 'posix available' => DependencyChecker::functionsAvailable(ProcessForker::POSIX_FUNCTIONS), ]; - if ($disabledPcntl = ProcessForker::disabledPcntlFunctions()) { + if ($disabledPcntl = DependencyChecker::functionsDisabled(ProcessForker::PCNTL_FUNCTIONS)) { $pcntl['disabled pcntl functions'] = $disabledPcntl; } - if ($disabledPosix = ProcessForker::disabledPosixFunctions()) { + if ($disabledPosix = DependencyChecker::functionsDisabled(ProcessForker::POSIX_FUNCTIONS)) { $pcntl['disabled posix functions'] = $disabledPosix; } $pcntl['use pcntl'] = $config->usePcntl(); $history = [ - 'history file' => $prettyPath($config->getHistoryFile()), + 'history file' => ConfigPaths::prettyPath($config->getHistoryFile()), + 'history format' => $interactiveReadline ? 'jsonl' : 'plain text', 'history size' => $config->getHistorySize(), 'erase duplicates' => $config->getEraseDuplicates(), ]; - $docs = [ - 'manual db file' => $prettyPath($config->getManualDbFile()), - 'sqlite available' => true, - ]; + $manualDbFile = $config->getManualDbFile(); + $manual = null; + $manualError = null; try { - if ($db = $config->getManualDb()) { - if ($q = $db->query('SELECT * FROM meta;')) { - $q->setFetchMode(\PDO::FETCH_KEY_PAIR); - $meta = $q->fetchAll(); - - foreach ($meta as $key => $val) { - switch ($key) { - case 'built_at': - $d = new \DateTime('@'.$val); - $val = $d->format(\DateTime::RFC2822); - break; - } - $key = 'db '.\str_replace('_', ' ', $key); - $docs[$key] = $val; - } - } else { - $docs['db schema'] = '0.1.0'; + $manual = $config->getManual(); + } catch (InvalidManualException $e) { + $manualError = $e->getMessage(); + } + + // If we have a manual but no db file path, it's bundled in the PHAR + if ($manual && !$manualDbFile && \Phar::running(false)) { + $docs = [ + 'manual db file' => '', + ]; + } else { + $docs = [ + 'manual db file' => ConfigPaths::prettyPath($manualDbFile), + ]; + } + + if ($manualError) { + $docs['manual error'] = $manualError; + } elseif ($manual) { + $meta = $manual->getMeta(); + + foreach ($meta as $key => $val) { + switch ($key) { + case 'built_at': + $d = new \DateTime('@'.$val); + $val = $d->format(\DateTime::RFC2822); + break; } + $key = 'manual '.\str_replace('_', ' ', $key); + $docs[$key] = $val; } - } catch (Exception\RuntimeException $e) { - if ($e->getMessage() === 'SQLite PDO driver not found') { - $docs['sqlite available'] = false; - } else { - throw $e; - } + } + + $completionIntegration = 'disabled'; + if ($config->useTabCompletion()) { + $completionIntegration = $interactiveReadline ? 'interactive readline' : 'legacy readline shim'; } $autocomplete = [ - 'tab completion enabled' => $config->useTabCompletion(), - 'bracketed paste' => $config->useBracketedPaste(), + 'tab completion enabled' => $config->useTabCompletion(), + 'completion integration' => $completionIntegration, + 'inline suggestions' => $interactiveReadline && $config->useSuggestions(), ]; + $warmers = $config->getAutoloadWarmers(); + $autoload = [ + 'autoload warming enabled' => !empty($warmers), + 'warmers configured' => \count($warmers), + ]; + + if (!empty($warmers)) { + $autoload['warmer types'] = \array_map('get_class', $warmers); + + // Add extended info for ComposerAutoloadWarmer + foreach ($warmers as $warmer) { + if ($warmer instanceof TabCompletion\AutoloadWarmer\ComposerAutoloadWarmer) { + try { + $autoload['composer warmer config'] = [ + 'include vendor' => Sudo::fetchProperty($warmer, 'includeVendor'), + 'include tests' => Sudo::fetchProperty($warmer, 'includeTests'), + 'vendor dir' => Sudo::fetchProperty($warmer, 'vendorDir'), + 'phar prefix' => Sudo::fetchProperty($warmer, 'pharPrefix'), + ]; + + $includeNamespaces = Sudo::fetchProperty($warmer, 'includeNamespaces'); + $excludeNamespaces = Sudo::fetchProperty($warmer, 'excludeNamespaces'); + $includeVendorNamespaces = Sudo::fetchProperty($warmer, 'includeVendorNamespaces'); + $excludeVendorNamespaces = Sudo::fetchProperty($warmer, 'excludeVendorNamespaces'); + + if (!empty($includeNamespaces)) { + $autoload['composer warmer config']['include namespaces'] = $includeNamespaces; + } + if (!empty($excludeNamespaces)) { + $autoload['composer warmer config']['exclude namespaces'] = $excludeNamespaces; + } + if (!empty($includeVendorNamespaces)) { + $autoload['composer warmer config']['include vendor namespaces'] = $includeVendorNamespaces; + } + if (!empty($excludeVendorNamespaces)) { + $autoload['composer warmer config']['exclude vendor namespaces'] = $excludeVendorNamespaces; + } + } catch (\ReflectionException $e) { + // shrug + } + break; // Only show info for the first ComposerAutoloadWarmer + } + } + } + + $implicitUse = []; + $implicitUseConfig = $config->getImplicitUse(); + if (\is_array($implicitUseConfig)) { + if (!empty($implicitUseConfig['includeNamespaces'])) { + $implicitUse['include namespaces'] = $implicitUseConfig['includeNamespaces']; + } + if (!empty($implicitUseConfig['excludeNamespaces'])) { + $implicitUse['exclude namespaces'] = $implicitUseConfig['excludeNamespaces']; + } + } + if (empty($implicitUse)) { + $implicitUse = false; + } + // Shenanigans, but totally justified. try { if ($shell = Sudo::fetchProperty($config, 'shell')) { @@ -321,7 +394,26 @@ function info(?Configuration $config = null) $core['commands'] = \array_map('get_class', $shell->all()); try { - $autocomplete['custom matchers'] = \array_map('get_class', Sudo::fetchProperty($shell, 'matchers')); + $autocomplete['custom legacy matchers'] = \array_map('get_class', Sudo::fetchProperty($shell, 'matchers')); + } catch (\ReflectionException $e) { + // shrug + } + + try { + $completionEngine = Sudo::fetchProperty($shell, 'completionEngine'); + if ($completionEngine !== null) { + $autocomplete['completion sources'] = \array_map('get_class', Sudo::fetchProperty($completionEngine, 'sources')); + $autocomplete['completion refiners'] = \array_map('get_class', Sudo::fetchProperty($completionEngine, 'refiners')); + } + } catch (\ReflectionException $e) { + // shrug + } + + try { + $pendingCompletionSources = Sudo::fetchProperty($shell, 'pendingCompletionSources'); + if (!empty($pendingCompletionSources)) { + $autocomplete['pending completion sources'] = \array_map('get_class', $pendingCompletionSources); + } } catch (\ReflectionException $e) { // shrug } @@ -332,7 +424,24 @@ function info(?Configuration $config = null) // @todo Show Presenter / custom casters. - return \array_merge($shellInfo, $core, \compact('updates', 'pcntl', 'input', 'readline', 'output', 'history', 'docs', 'autocomplete')); + return \array_merge( + $shellInfo, + $core, + \compact( + 'updates', + 'pcntl', + 'input', + 'readline', + 'output', + 'history', + 'docs', + 'autocomplete', + 'autoload' + ), + [ + 'implicit use' => $implicitUse, + ], + ); } } @@ -345,6 +454,11 @@ function info(?Configuration $config = null) function bin(): \Closure { return function () { + // Ensure exit() works when uopz extension is loaded with uopz.exit=0 + if (\function_exists('uopz_allow_exit')) { + \uopz_allow_exit(true); + } + if (!isset($_SERVER['PSYSH_IGNORE_ENV']) || !$_SERVER['PSYSH_IGNORE_ENV']) { if (\defined('HHVM_VERSION_ID')) { \fwrite(\STDERR, 'PsySH v0.11 and higher does not support HHVM. Install an older version, or set the environment variable PSYSH_IGNORE_ENV=1 to override this restriction and proceed anyway.'.\PHP_EOL); @@ -381,6 +495,8 @@ function bin(): \Closure new InputOption('help', 'h', InputOption::VALUE_NONE), new InputOption('version', 'V', InputOption::VALUE_NONE), new InputOption('self-update', 'u', InputOption::VALUE_NONE), + new InputOption('update-manual', null, InputOption::VALUE_OPTIONAL, '', false), + new InputOption('info', null, InputOption::VALUE_NONE), new InputArgument('include', InputArgument::IS_ARRAY), ]))); @@ -388,6 +504,22 @@ function bin(): \Closure $usageException = $e; } + if ($usageException === null) { + $cwd = null; + if ($input->hasOption('cwd')) { + $cwd = $input->getOption('cwd'); + } + if ($cwd === null || $cwd === '') { + $cwd = $input->getParameterOption('--cwd', null, true); + } + if ($cwd !== null && $cwd !== '') { + if (!@\chdir($cwd)) { + \fwrite(\STDERR, 'Invalid --cwd directory: '.$cwd.\PHP_EOL); + exit(1); + } + } + } + try { $config = Configuration::fromInput($input); } catch (\InvalidArgumentException $e) { @@ -396,6 +528,17 @@ function bin(): \Closure // Handle --help if (!isset($config) || $usageException !== null || $input->getOption('help')) { + // Determine if we should use colors + $useColors = true; + if ($input->hasParameterOption(['--no-color'])) { + $useColors = false; + } elseif (!$input->hasParameterOption(['--color']) && !\stream_isatty(\STDOUT)) { + $useColors = false; + } + + // Create output formatter for proper tag rendering + $formatter = new OutputFormatter($useColors); + if ($usageException !== null) { echo $usageException->getMessage().\PHP_EOL.\PHP_EOL; } @@ -404,37 +547,61 @@ function bin(): \Closure $argv = isset($_SERVER['argv']) ? $_SERVER['argv'] : []; $name = $argv ? \basename(\reset($argv)) : 'psysh'; - echo <<-u, --self-update Install a newer version if available" : ''; -Options: - -h, --help Display this help message. - -c, --config FILE Use an alternate PsySH config file location. - --cwd PATH Use an alternate working directory. - -V, --version Display the PsySH version. + $helpText = <<Description: + A runtime developer console, interactive debugger and REPL for PHP + +Usage: + $name [options] [--] [...] + +Arguments: + files PHP file(s) to load before starting the shell + +Options: + -h, --help Display this help message + --info Display PsySH environment and configuration info + -V, --version Display the PsySH version{$selfUpdateOption} + --update-manual[=LANG] Download and install the latest PHP manual (optional language code) + + --experimental-readline Use experimental interactive readline implementation + --warm-autoload Enable autoload warming for better tab completion + --yolo Run PsySH without input validation (you don't want this) + + -c, --config=FILE Use an alternate PsySH config file location + --cwd=PATH Use an alternate working directory + --trust-project Trust the current project for this run + --no-trust-project Run in Restricted Mode for this project + --color|--no-color Force (or disable with --no-color) colors in output + -i, --interactive Force PsySH to run in interactive mode + -n, --no-interactive Run PsySH without interactive input (requires input from stdin) + --pager[=PAGER] Use an alternate output pager command (without a value, use the default pager) + --no-pager Disable paging output for this run + -r, --raw-output Print var_export-style return values (for non-interactive input) + --compact Run PsySH with compact output + -q, --quiet Shhhhhh + -v|vv|vvv, --verbose Increase the verbosity of messages + +Help: + PsySH is an interactive runtime developer console for PHP. Use it as a REPL + for quick experiments, or drop into your code with eval(\Psy\sh()); or + \Psy\debug(); to inspect application state and debug interactively. + + For more information, see https://psysh.org + + Examples: + + $name # Start interactive shell + $name -c ~/.config/psysh.php # Use custom config + $name --warm-autoload # Enable autoload warming + $name index.php # Load file before starting EOL; - } - echo <<format($helpText); exit($usageException === null ? 0 : 1); } @@ -445,6 +612,23 @@ function bin(): \Closure exit(0); } + // Handle --info + if ($input->getOption('info')) { + // Store config for info() function + info($config); + $infoData = info(); + + // Format and display the info + $output = $config->getOutput(); + if ($config->rawOutput()) { + $output->writeln(\var_export($infoData, true)); + } else { + $presenter = $config->getPresenter(); + $output->writeln($presenter->present($infoData, null, VarDumper\Presenter::RAW), OutputInterface::OUTPUT_RAW); + } + exit(0); + } + // Handle --self-update if ($input->getOption('self-update')) { if (!$shellIsPhar) { @@ -456,6 +640,18 @@ function bin(): \Closure exit($result); } + // Handle --update-manual + if ($input->getOption('update-manual') !== false) { + try { + $manualUpdate = ManualUpdate::fromConfig($config, $input, $config->getOutput()); + $result = $manualUpdate->run($input, $config->getOutput()); + exit($result); + } catch (\RuntimeException $e) { + \fwrite(\STDERR, $e->getMessage().\PHP_EOL); + exit(1); + } + } + $shell = new Shell($config); // Pass additional arguments to Shell as 'includes' @@ -463,15 +659,17 @@ function bin(): \Closure try { // And go! - $shell->run(); + $exitCode = $shell->run(); + if ($exitCode !== 0) { + exit($exitCode); + } + } catch (BreakException $e) { + // BreakException can escape if thrown before the execution loop starts + // (though it shouldn't in normal operation) + exit($e->getCode()); } catch (\Throwable $e) { \fwrite(\STDERR, $e->getMessage().\PHP_EOL); - - // @todo this triggers the "exited unexpectedly" logic in the - // ForkingLoop, so we can't exit(1) after starting the shell... - // fix this :) - - // exit(1); + exit(1); } }; } diff --git a/app/vendor/robmorgan/phinx/.stickler.yml b/app/vendor/robmorgan/phinx/.stickler.yml deleted file mode 100644 index cf599f130..000000000 --- a/app/vendor/robmorgan/phinx/.stickler.yml +++ /dev/null @@ -1,12 +0,0 @@ -linters: - phpcs: - standard: CakePHP3 - fixer: true - -files: - ignore: - - 'vendor/*' - -fixers: - enable: true - workflow: commit diff --git a/app/vendor/robmorgan/phinx/LICENSE b/app/vendor/robmorgan/phinx/LICENSE deleted file mode 100644 index 54619b91f..000000000 --- a/app/vendor/robmorgan/phinx/LICENSE +++ /dev/null @@ -1,23 +0,0 @@ -(The MIT license) - -Copyright (c) 2012-2017 Rob Morgan -Copyright (c) 2017-present, Cake Software Foundation, Inc. (https://cakefoundation.org) - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/app/vendor/robmorgan/phinx/README.md b/app/vendor/robmorgan/phinx/README.md deleted file mode 100644 index e9bcc2ecf..000000000 --- a/app/vendor/robmorgan/phinx/README.md +++ /dev/null @@ -1,143 +0,0 @@ -# [Phinx](https://phinx.org): Simple PHP Database Migrations - -[![CI](https://github.com/cakephp/phinx/actions/workflows/ci.yml/badge.svg?branch=0.x&event=push)](https://github.com/cakephp/phinx/actions/workflows/ci.yml) -[![Code Coverage](https://codecov.io/gh/cakephp/phinx/branch/master/graph/badge.svg)](https://codecov.io/gh/cakephp/phinx) -![Packagist Version](https://img.shields.io/packagist/v/robmorgan/phinx) -[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%208.1-8892BF.svg)](https://php.net/) -![Packagist Downloads](https://img.shields.io/packagist/dt/robmorgan/phinx) - -## Intro - -Phinx makes it ridiculously easy to manage the database migrations for your PHP app. In less than 5 minutes, you can install Phinx and create your first database migration. Phinx is just about migrations without all the bloat of a database ORM system or framework. - -**Check out [book.cakephp.org/phinx](https://book.cakephp.org/phinx) for the comprehensive documentation.** - -![phinxterm](https://cloud.githubusercontent.com/assets/178939/3887559/e6b5e524-21f2-11e4-8256-0ba6040725fc.gif) - -### Features - -* Write database migrations using database agnostic PHP code. -* Migrate up and down. -* Migrate on deployment. -* Seed data after database creation. -* Get going in less than 5 minutes. -* Stop worrying about the state of your database. -* Take advantage of SCM features such as branching. -* Integrate with any app. - -### Supported Adapters - -Phinx natively supports the following database adapters: - -* MySQL -* PostgreSQL -* SQLite -* Microsoft SQL Server - -## Install & Run - -See [version and branch overview](https://github.com/cakephp/phinx/wiki#version-and-branch-overview) for branch and PHP compatibility. - -### Composer - -The fastest way to install Phinx is to add it to your project using Composer (https://getcomposer.org/). - -1. Install Composer: - - ``` - curl -sS https://getcomposer.org/installer | php - ``` - -1. Require Phinx as a dependency using Composer: - - ``` - php composer.phar require robmorgan/phinx - ``` - -1. Install Phinx: - - ``` - php composer.phar install - ``` - -1. Execute Phinx: - - ``` - php vendor/bin/phinx - ``` - -### As a Phar - -You can also use the Box application to build Phinx as a Phar archive (https://box-project.github.io/box2/). - -1. Clone Phinx from GitHub - - ``` - git clone https://github.com/cakephp/phinx.git - cd phinx - ``` - -1. Install Composer - - ``` - curl -s https://getcomposer.org/installer | php - ``` - -1. Install the Phinx dependencies - - ``` - php composer.phar install - ``` - -1. Install Box: - - ``` - curl -LSs https://box-project.github.io/box2/installer.php | php - ``` - -1. Create a Phar archive - - ``` - php box.phar build - ``` - -## Documentation - -Check out https://book.cakephp.org/phinx for the comprehensive documentation. - -Other translations include: - - * [Chinese](https://tsy12321.gitbooks.io/phinx-doc/) (Maintained by [@tsy12321](https://github.com/tsy12321/phinx-doc)) - -## Contributing - -Please read the [CONTRIBUTING](CONTRIBUTING.md) document. - -## News & Updates - -Follow [@CakePHP](https://twitter.com/cakephp) on Twitter to stay up to date. - -## Limitations - -### PostgreSQL - -- Not able to set a unique constraint on a table (). - - -## Misc - -### Version History - -Please read the [release notes](https://github.com/cakephp/phinx/releases). - -### License - -(The MIT license) - -Copyright (c) 2017 Rob Morgan - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/app/vendor/robmorgan/phinx/app/phinx.php b/app/vendor/robmorgan/phinx/app/phinx.php deleted file mode 100644 index b03ef7eda..000000000 --- a/app/vendor/robmorgan/phinx/app/phinx.php +++ /dev/null @@ -1,36 +0,0 @@ - 'getStatus', - 'migrate' => 'getMigrate', - 'rollback' => 'getRollback', -]; - -// Extract the requested command from the URL, default to "status". -$command = trim(parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH), '/'); -if (!$command) { - $command = 'status'; -} - -// Verify that the command exists, or list available commands. -if (!isset($routes[$command])) { - $commands = implode(', ', array_keys($routes)); - header('Content-Type: text/plain', true, 404); - die("Command not found! Valid commands are: {$commands}."); -} - -// Get the environment and target version parameters. -$env = $_GET['e'] ?? null; -$target = $_GET['t'] ?? null; - -// Check if debugging is enabled. -$debug = !empty($_GET['debug']) && filter_var($_GET['debug'], FILTER_VALIDATE_BOOLEAN); - -// Execute the command and determine if it was successful. -$output = call_user_func([$wrap, $routes[$command]], $env, $target); -$error = $wrap->getExitCode() > 0; - -// Finally, display the output of the command. -header('Content-Type: text/plain', true, $error ? 500 : 200); -if ($debug) { - // Show what command was executed based on request parameters. - $args = implode(', ', [var_export($env, true), var_export($target, true)]); - echo "DEBUG: $command($args)" . PHP_EOL . PHP_EOL; -} -echo $output; diff --git a/app/vendor/robmorgan/phinx/bin/phinx b/app/vendor/robmorgan/phinx/bin/phinx deleted file mode 100755 index ac371753b..000000000 --- a/app/vendor/robmorgan/phinx/bin/phinx +++ /dev/null @@ -1,28 +0,0 @@ -#!/usr/bin/env php -run(); diff --git a/app/vendor/robmorgan/phinx/bin/phinx.bat b/app/vendor/robmorgan/phinx/bin/phinx.bat deleted file mode 100644 index e7d7e7d0f..000000000 --- a/app/vendor/robmorgan/phinx/bin/phinx.bat +++ /dev/null @@ -1,41 +0,0 @@ -@echo off - -rem This script will do the following: -rem - check for PHP_COMMAND env, if found, use it. -rem - if not found detect php, if found use it, otherwise err and terminate - -if "%OS%"=="Windows_NT" @setlocal - -rem %~dp0 is expanded pathname of the current script under NT -set DEFAULT_PHINX_HOME=%~dp0.. - -goto init -goto cleanup - -:init - -if "%PHINX_HOME%" == "" set PHINX_HOME=%DEFAULT_PHINX_HOME% -set DEFAULT_PHINX_HOME= - -if "%PHP_COMMAND%" == "" goto no_phpcommand - -goto run -goto cleanup - -:run -"%PHP_COMMAND%" -d html_errors=off -qC "%PHINX_HOME%\bin\phinx" %* -goto cleanup - -:no_phpcommand -rem PHP_COMMAND environment variable not found, assuming php.exe is on path. -set PHP_COMMAND=php.exe -goto init - -:err_home -echo ERROR: Environment var PHINX_HOME not set. Please point this -echo variable to your local phinx installation! -goto cleanup - -:cleanup -if "%OS%"=="Windows_NT" @endlocal -rem pause \ No newline at end of file diff --git a/app/vendor/robmorgan/phinx/composer.json b/app/vendor/robmorgan/phinx/composer.json deleted file mode 100644 index 4fa95419e..000000000 --- a/app/vendor/robmorgan/phinx/composer.json +++ /dev/null @@ -1,92 +0,0 @@ -{ - "name": "robmorgan/phinx", - "type": "library", - "description": "Phinx makes it ridiculously easy to manage the database migrations for your PHP app.", - "keywords": [ - "phinx", - "migrations", - "database", - "db", - "database migrations" - ], - "homepage": "https://phinx.org", - "license": "MIT", - "authors": [ - { - "name": "Rob Morgan", - "email": "robbym@gmail.com", - "homepage": "https://robmorgan.id.au", - "role": "Lead Developer" - }, - { - "name": "Woody Gilk", - "email": "woody.gilk@gmail.com", - "homepage": "https://shadowhand.me", - "role": "Developer" - }, - { - "name": "Richard Quadling", - "email": "rquadling@gmail.com", - "role": "Developer" - }, - { - "name": "CakePHP Community", - "role": "Developer", - "homepage": "https://github.com/cakephp/phinx/graphs/contributors" - } - ], - "require": { - "php-64bit": ">=8.1", - "composer-runtime-api": "^2.0", - "cakephp/database": "^5.0.2", - "psr/container": "^1.1|^2.0", - "symfony/config": "^4.0|^5.0|^6.0|^7.0", - "symfony/console": "^6.0|^7.0" - }, - "require-dev": { - "ext-json": "*", - "ext-pdo": "*", - "cakephp/cakephp-codesniffer": "^5.0", - "cakephp/i18n": "^5.0", - "phpunit/phpunit": "^9.5.19", - "symfony/yaml": "^4.0|^5.0|^6.0|^7.0" - }, - "autoload": { - "psr-4": { - "Phinx\\": "src/Phinx/" - } - }, - "autoload-dev": { - "psr-4": { - "Test\\Phinx\\": "tests/Phinx/" - } - }, - "suggest": { - "ext-json": "Install if using JSON configuration format", - "ext-pdo": "PDO extension is needed", - "symfony/yaml": "Install if using YAML configuration format" - }, - "scripts": { - "check": [ - "@test", - "@cs-check" - ], - "cs-check": "phpcs", - "cs-fix": "phpcbf", - "stan": "phpstan analyse", - "stan-setup": "cp composer.json composer.backup && composer require --dev phpstan/phpstan:~1.9.0 && mv composer.backup composer.json", - "lowest": "validate-prefer-lowest", - "lowest-setup": "composer update --prefer-lowest --prefer-stable --prefer-dist --no-interaction && cp composer.json composer.backup && composer require --dev dereuromark/composer-prefer-lowest && mv composer.backup composer.json", - "test": "phpunit --colors=always" - }, - "bin": [ - "bin/phinx" - ], - "minimum-stability": "dev", - "prefer-stable": true, - "config": { - "allow-plugins": { - "dealerdirect/phpcodesniffer-composer-installer": true - } - } -} diff --git a/app/vendor/robmorgan/phinx/data/phinx.json.dist b/app/vendor/robmorgan/phinx/data/phinx.json.dist deleted file mode 100644 index 1deeaf1c1..000000000 --- a/app/vendor/robmorgan/phinx/data/phinx.json.dist +++ /dev/null @@ -1,38 +0,0 @@ -{ - "paths": { - "migrations": "%%PHINX_CONFIG_DIR%%/db/migrations", - "seeds": "%%PHINX_CONFIG_DIR%%/db/seeds" - }, - "environments": { - "default_migration_table": "phinxlog", - "default_environment": "development", - "production": { - "adapter": "mysql", - "host": "localhost", - "name": "production_db", - "user": "root", - "pass": "", - "port": 3306, - "charset": "utf8" - }, - "development": { - "adapter": "mysql", - "host": "localhost", - "name": "development_db", - "user": "root", - "pass": "", - "port": 3306, - "charset": "utf8" - }, - "testing": { - "adapter": "mysql", - "host": "localhost", - "name": "testing_db", - "user": "root", - "pass": "", - "port": 3306, - "charset": "utf8" - } - }, - "version_order": "creation" -} diff --git a/app/vendor/robmorgan/phinx/data/phinx.php.dist b/app/vendor/robmorgan/phinx/data/phinx.php.dist deleted file mode 100644 index 7ff2b08a9..000000000 --- a/app/vendor/robmorgan/phinx/data/phinx.php.dist +++ /dev/null @@ -1,41 +0,0 @@ - [ - 'migrations' => '%%PHINX_CONFIG_DIR%%/db/migrations', - 'seeds' => '%%PHINX_CONFIG_DIR%%/db/seeds' - ], - 'environments' => [ - 'default_migration_table' => 'phinxlog', - 'default_environment' => 'development', - 'production' => [ - 'adapter' => 'mysql', - 'host' => 'localhost', - 'name' => 'production_db', - 'user' => 'root', - 'pass' => '', - 'port' => '3306', - 'charset' => 'utf8', - ], - 'development' => [ - 'adapter' => 'mysql', - 'host' => 'localhost', - 'name' => 'development_db', - 'user' => 'root', - 'pass' => '', - 'port' => '3306', - 'charset' => 'utf8', - ], - 'testing' => [ - 'adapter' => 'mysql', - 'host' => 'localhost', - 'name' => 'testing_db', - 'user' => 'root', - 'pass' => '', - 'port' => '3306', - 'charset' => 'utf8', - ] - ], - 'version_order' => 'creation' -]; diff --git a/app/vendor/robmorgan/phinx/data/phinx.yml.dist b/app/vendor/robmorgan/phinx/data/phinx.yml.dist deleted file mode 100644 index 857e535aa..000000000 --- a/app/vendor/robmorgan/phinx/data/phinx.yml.dist +++ /dev/null @@ -1,35 +0,0 @@ -paths: - migrations: '%%PHINX_CONFIG_DIR%%/db/migrations' - seeds: '%%PHINX_CONFIG_DIR%%/db/seeds' - -environments: - default_migration_table: phinxlog - default_environment: development - production: - adapter: mysql - host: localhost - name: production_db - user: root - pass: '' - port: 3306 - charset: utf8 - - development: - adapter: mysql - host: localhost - name: development_db - user: root - pass: '' - port: 3306 - charset: utf8 - - testing: - adapter: mysql - host: localhost - name: testing_db - user: root - pass: '' - port: 3306 - charset: utf8 - -version_order: creation diff --git a/app/vendor/robmorgan/phinx/docs/config/__init__.py b/app/vendor/robmorgan/phinx/docs/config/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/app/vendor/robmorgan/phinx/docs/config/all.py b/app/vendor/robmorgan/phinx/docs/config/all.py deleted file mode 100644 index 9fd53bce4..000000000 --- a/app/vendor/robmorgan/phinx/docs/config/all.py +++ /dev/null @@ -1,43 +0,0 @@ -# -*- coding: utf-8 -*- -# -# Phinx documentation build configuration file, created by -# sphinx-quickstart on Thu Jun 14 17:39:42 2012. -# - -# Import the base theme configuration -from cakephpsphinx.config.all import * - -# The full version, including alpha/beta/rc tags. -release = '0.16.x' - -# The search index version. -search_version = 'phinx-0' - -# The marketing display name for the book. -version_name = '' - -# Project name shown in the black header bar -project = 'Phinx' - -# Other versions that display in the version picker menu. -version_list = [ - {'name': '0.16', 'number': '/phinx/0', 'title': '0.16', 'current': True}, -] - -# Languages available. -languages = ['en'] - -# The GitHub branch name for this version of the docs -# for edit links to point at. -branch = '0.x' - -# Current version being built -version = '0.16' - -show_root_link = True - -repository = 'cakephp/phinx' - -source_path = 'docs/' - -hide_page_contents = ('search', '404', 'contents') diff --git a/app/vendor/robmorgan/phinx/docs/en/commands.rst b/app/vendor/robmorgan/phinx/docs/en/commands.rst deleted file mode 100644 index 7cedbf703..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/commands.rst +++ /dev/null @@ -1,416 +0,0 @@ -.. index:: - single: Commands - -Commands -======== - -Phinx is run using a number of commands. - -The Breakpoint Command ----------------------- - -The Breakpoint command is used to set breakpoints, allowing you to limit -rollbacks. You can toggle the breakpoint of the most recent migration by -not supplying any parameters. - -.. code-block:: bash - - $ phinx breakpoint -e development - -To toggle a breakpoint on a specific version then use the ``--target`` -parameter or ``-t`` for short. - -.. code-block:: bash - - $ phinx breakpoint -e development -t 20120103083322 - -You can remove all the breakpoints by using the ``--remove-all`` parameter -or ``-r`` for short. - -.. code-block:: bash - - $ phinx breakpoint -e development -r - -You can set or unset (rather than just toggle) the breakpoint on the most -recent migration (or on a specific migration when combined with the -``--target`` or ``-t`` parameter) by using ``-set`` or ``--unset``. - -Breakpoints are visible when you run the ``status`` command. - -The Create Command ------------------- - -The Create command is used to create a new migration file. It requires one -argument: the name of the migration. The migration name should be specified in -CamelCase format. - -.. code-block:: bash - - $ phinx create MyNewMigration - -Open the new migration file in your text editor to add your database -transformations. Phinx creates migration files using the path specified in your -phinx configuration file. Please see the :doc:`Configuration ` chapter -for more information. - -You are able to override the template file used by Phinx by supplying an -alternative template filename. - -.. code-block:: bash - - $ phinx create MyNewMigration --template="" - -You can also supply a template generating class. This class must implement the -interface ``Phinx\Migration\CreationInterface``. - -.. code-block:: bash - - $ phinx create MyNewMigration --class="" - -In addition to providing the template for the migration, the class can also define -a callback that will be called once the migration file has been generated from the -template. - -You cannot use ``--template`` and ``--class`` together. - -The Init Command ----------------- - -The Init command (short for initialize) is used to prepare your project for -Phinx. This command generates the phinx configuration file in the root of your -project directory. By default, this file will be named ``phinx.php``. - -.. code-block:: bash - - $ phinx init - -Optionally you can specify a custom location for Phinx's config file: - -.. code-block:: bash - - $ phinx init ./custom/location/ - -You can also specify a custom file name: - -.. code-block:: bash - - $ phinx init custom-config.yml - -As well as a different format from php, yml, and json. For example, to create yml file: - -.. code-block:: bash - - $ phinx init --format yml - -Open this file in your text editor to setup your project configuration. Please -see the :doc:`Configuration ` chapter for more information. - -The Migrate Command -------------------- - -The Migrate command runs all of the available migrations, optionally up to a -specific version. - -.. code-block:: bash - - $ phinx migrate -e development - -To migrate to a specific version then use the ``--target`` parameter or ``-t`` -for short. - -.. code-block:: bash - - $ phinx migrate -e development -t 20110103081132 - -Use ``--dry-run`` to print the queries to standard output without executing them - -.. code-block:: bash - - $ phinx migrate --dry-run - -The Rollback Command --------------------- - -The Rollback command is used to undo previous migrations executed by Phinx. It -is the opposite of the Migrate command. - -You can rollback to the previous migration by using the ``rollback`` command -with no arguments. - -.. code-block:: bash - - $ phinx rollback -e development - -To rollback all migrations to a specific version then use the ``--target`` -parameter or ``-t`` for short. - -.. code-block:: bash - - $ phinx rollback -e development -t 20120103083322 - -Specifying 0 as the target version will revert all migrations. - -.. code-block:: bash - - $ phinx rollback -e development -t 0 - -To rollback all migrations to a specific date then use the ``--date`` -parameter or ``-d`` for short. - -.. code-block:: bash - - $ phinx rollback -e development -d 2012 - $ phinx rollback -e development -d 201201 - $ phinx rollback -e development -d 20120103 - $ phinx rollback -e development -d 2012010312 - $ phinx rollback -e development -d 201201031205 - $ phinx rollback -e development -d 20120103120530 - -If a breakpoint is set, blocking further rollbacks, you can override the -breakpoint using the ``--force`` parameter or ``-f`` for short. - -.. code-block:: bash - - $ phinx rollback -e development -t 0 -f - -Use ``--dry-run`` to print the queries to standard output without executing them - -.. code-block:: bash - - $ phinx rollback --dry-run - -.. note:: - - When rolling back, Phinx orders the executed migrations using - the order specified in the ``version_order`` option of your - phinx configuration file. - Please see the :doc:`Configuration ` chapter for more information. - -The Status Command ------------------- - -The Status command prints a list of all migrations, along with their current -status. You can use this command to determine which migrations have been run. - -.. code-block:: bash - - $ phinx status -e development - -This command exits with code 0 if the database is up-to-date (ie. all migrations are up) or one of the following codes otherwise: - -* 2: There is at least one missing migration. -* 3: There is at least one down migration. - -An exit code of 1 means an application error has occurred. - -The Seed Create Command ------------------------ - -The Seed Create command can be used to create new database seed classes. It -requires one argument, the name of the class. The class name should be specified -in CamelCase format. - -.. code-block:: bash - - $ phinx seed:create MyNewSeeder - -Open the new seed file in your text editor to add your database seed commands. -Phinx creates seed files using the path specified in your configuration file. -Please see the :doc:`Configuration ` chapter for more information. - -You are able to override the template file used by Phinx by supplying an -alternative template filename. - -.. code-block:: bash - - $ phinx seed:create MyNewSeeder --template="" - -The Seed Run Command --------------------- - -The Seed Run command runs all of the available seed classes or optionally just -one. - -.. code-block:: bash - - $ phinx seed:run -e development - -To run only one seed class use the ``--seed`` parameter or ``-s`` for short. - -.. code-block:: bash - - $ phinx seed:run -e development -s MyNewSeeder - -Configuration File Parameter ----------------------------- - -When running Phinx from the command line, you may specify a configuration file -using the ``--configuration`` or ``-c`` parameter. In addition to YAML, the -configuration file may be the computed output of a PHP file as a PHP array: - -.. code-block:: php - - [ - "migrations" => "application/migrations" - ], - "environments" => [ - "default_migration_table" => "phinxlog", - "default_environment" => "dev", - "dev" => [ - "adapter" => "mysql", - "host" => $_ENV['DB_HOST'], - "name" => $_ENV['DB_NAME'], - "user" => $_ENV['DB_USER'], - "pass" => $_ENV['DB_PASS'], - "port" => $_ENV['DB_PORT'] - ] - ] - ]; - -Phinx auto-detects which language parser to use for files with ``*.yaml``, ``*.yml``, ``*.json``, and ``*.php`` extensions. -The appropriate parser may also be specified via the ``--parser`` and ``-p`` parameters. Anything other than ``"json"`` or -``"php"`` is treated as YAML. - -When using a PHP array, you can provide a ``connection`` key with an existing PDO instance. It is also important to pass -the database name too, as Phinx requires this for certain methods such as ``hasTable()``: - -.. code-block:: php - - [ - "migrations" => "application/migrations" - ), - "environments" => [ - "default_migration_table" => "phinxlog", - "default_environment" => "dev", - "dev" => [ - "name" => "dev_db", - "connection" => $pdo_instance - ] - ] - ]; - -Running Phinx in a Web App --------------------------- - -Phinx can also be run inside of a web application by using the ``Phinx\Wrapper\TextWrapper`` -class. An example of this is provided in ``app/web.php``, which can be run as a -standalone server: - -.. code-block:: bash - - $ php -S localhost:8000 vendor/robmorgan/phinx/app/web.php - -This will create local web server at ``__ which will show current -migration status by default. To run migrations up, use ``__ -and to rollback use ``__. - -**The included web app is only an example and should not be used in production!** - -.. note:: - - To modify configuration variables at runtime and override ``%%PHINX_DBNAME%%`` - or other another dynamic option, set ``$_SERVER['PHINX_DBNAME']`` before - running commands. Available options are documented in the Configuration page. - -Wrapping Phinx in another Symfony Console Application ------------------------------------------------------ - -Phinx can be wrapped and run as part of a separate Symfony console application. This -may be desirable to present a unified interface to the user for all aspects of your -application, or because you wish to run multiple Phinx commands. While you could -run the commands through ``exec`` or use the above ``Phinx\Wrapper\TextWrapper``, -though this makes it hard to deal with the return code and output in a similar fashion -as your application. - -Luckily, Symfony makes doing this sort of "meta" command straight-forward: - -.. code-block:: php - - use Symfony\Component\Console\Input\ArrayInput; - use Symfony\Component\Console\Input\InputInterface; - use Symfony\Component\Console\Output\OutputInterface; - use Phinx\Console\PhinxApplication; - - // ... - - protected function execute(InputInterface $input, OutputInterface $output) - { - - $phinx = new PhinxApplication(); - $command = $phinx->find('migrate'); - - $arguments = [ - 'command' => 'migrate', - '--environment' => 'production', - '--configuration' => '/path/to/phinx/config/file' - ]; - - $input = new ArrayInput($arguments); - $returnCode = $command->run(new ArrayInput($arguments), $output); - // ... - } - -Here, you are instantianting the ``PhinxApplication``, telling it to find the ``migrate`` -command, defining the arguments to pass to it (which match the commandline arguments and flags), -and then finally running the command, passing it the same ``OutputInterface`` that your -application uses. - -See this `Symfony page `_ for more information. - -Using Phinx with PHPUnit --------------------------- - -Phinx can be used within your unit tests to prepare or seed the database. You can use it programatically : - -.. code-block:: php - - public function setUp () - { - $app = new PhinxApplication(); - $app->setAutoExit(false); - $app->run(new StringInput('migrate'), new NullOutput()); - } - -If you use a memory database, you'll need to give Phinx a specific PDO instance. You can interact with Phinx directly -using the Manager class : - -.. code-block:: php - - use PDO; - use Phinx\Config\Config; - use Phinx\Migration\Manager; - use PHPUnit\Framework\TestCase; - use Symfony\Component\Console\Input\StringInput; - use Symfony\Component\Console\Output\NullOutput; - - class DatabaseTestCase extends TestCase { - - public function setUp () - { - $pdo = new PDO('sqlite::memory:', null, null, [ - PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION - ]); - $configPath = __DIR__ . '/../phinx.php'; - $configArray = require $configPath; - $configArray['environments']['test'] = [ - 'adapter' => 'sqlite', - 'connection' => $pdo, - 'name' => ':memory:', - ]; - $config = new Config( - $configArray, - $configPath - ); - $manager = new Manager($config, new StringInput(' '), new NullOutput()); - $manager->migrate('test'); - $manager->seed('test'); - $this->pdo = $pdo; - // You can change default fetch mode after the seeding - $this->pdo->setAttribute(PDO::ATTR_DEFAULT_FETCH_MODE, PDO::FETCH_OBJ); - } - - } diff --git a/app/vendor/robmorgan/phinx/docs/en/conf.py b/app/vendor/robmorgan/phinx/docs/en/conf.py deleted file mode 100644 index f638bda22..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/conf.py +++ /dev/null @@ -1,9 +0,0 @@ -import sys, os - -# Append the top level directory of the docs, so we can import from the config dir. -sys.path.insert(0, os.path.abspath('..')) - -# Pull in all the configuration options defined in the global config file.. -from config.all import * - -language = 'en' diff --git a/app/vendor/robmorgan/phinx/docs/en/configuration.rst b/app/vendor/robmorgan/phinx/docs/en/configuration.rst deleted file mode 100644 index d577c092e..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/configuration.rst +++ /dev/null @@ -1,579 +0,0 @@ -.. index:: - single: Configuration - -Configuration -============= - -When you initialize your project using the :doc:`Init Command`, Phinx -creates a default file in the root of your project directory. By default, this -file uses the YAML data serialization format, but you can use the ``--format`` -command line option to specify either ``yaml``, ``yml``, ``json``, or ``php``. - -If a ``--configuration`` command line option is given, Phinx will load the -specified file. Otherwise, it will attempt to find ``phinx.php``, ``phinx.json``, -``phinx.yml``, or ``phinx.yaml`` and load the first file found. See the -:doc:`Commands ` chapter for more information. - -.. warning:: - - Remember to store the configuration file outside of a publicly accessible - directory on your webserver. This file contains your database credentials - and may be accidentally served as plain text. - -Note that while JSON and YAML files are *parsed*, the PHP file is *included*. -This means that: - -* It must `return` an array of configuration items. -* The variable scope is local, i.e. you would need to explicitly declare - any global variables your initialization file reads or modifies. -* Its standard output is suppressed. -* Unlike with JSON and YAML, it is possible to omit environment connection details - and instead specify ``connection`` which must contain an initialized PDO instance. - This is useful when you want your migrations to interact with your application - and/or share the same connection. However remember to also pass the database name - as Phinx cannot infer this from the PDO connection. - -.. code-block:: php - - $app = require 'app/phinx.php'; - $pdo = $app->getDatabase()->getPdo(); - - return [ - 'environments' => [ - 'default_environment' => 'development', - 'development' => [ - 'name' => 'devdb', - 'connection' => $pdo - ] - ] - ]; - -Migration Paths ---------------- - -The first option specifies the path to your migration directory. Phinx uses -``%%PHINX_CONFIG_DIR%%/db/migrations`` by default. - -.. note:: - - ``%%PHINX_CONFIG_DIR%%`` is a special token and is automatically replaced - with the root directory where your phinx configuration file is stored. - -In order to overwrite the default ``%%PHINX_CONFIG_DIR%%/db/migrations``, you -need to add the following to the configuration. - -.. code-block:: yaml - - paths: - migrations: /your/full/path - -You can also provide multiple migration paths by using an array in your configuration: - -.. code-block:: yaml - - paths: - migrations: - - application/module1/migrations - - application/module2/migrations - -Class namespaces may be specified by adding a key to each migration path: - -.. code-block:: yaml - - paths: - migrations: - App\Module1\Migrations: application/module1/migrations - App\Module2\Migrations: application/module2/migrations - - - -You can also use the ``%%PHINX_CONFIG_DIR%%`` token in your path. - -.. code-block:: yaml - - paths: - migrations: '%%PHINX_CONFIG_DIR%%/your/relative/path' - -Migrations are captured with ``glob``, so you can define a pattern for multiple -directories. - -.. code-block:: yaml - - paths: - migrations: '%%PHINX_CONFIG_DIR%%/module/*/{data,scripts}/migrations' - -Custom Migration Base ---------------------- - -By default all migrations will extend from Phinx's `AbstractMigration` class. -This can be set to a custom class that extends from `AbstractMigration` by -setting ``migration_base_class`` in your config: - -.. code-block:: yaml - - migration_base_class: MyMagicalMigration - -Seed Paths ----------- - -The second option specifies the path to your seed directory. Phinx uses -``%%PHINX_CONFIG_DIR%%/db/seeds`` by default. - -.. note:: - - ``%%PHINX_CONFIG_DIR%%`` is a special token and is automatically replaced - with the root directory where your configuration file is stored. - -In order to overwrite the default ``%%PHINX_CONFIG_DIR%%/db/seeds``, you -need to add the following to the yaml configuration. - -.. code-block:: yaml - - paths: - seeds: /your/full/path - -You can also provide multiple seed paths by using an array in your configuration: - -.. code-block:: yaml - - paths: - seeds: - - /your/full/path1 - - /your/full/path2 - - -You can also use the ``%%PHINX_CONFIG_DIR%%`` token in your path. - -.. code-block:: yaml - - paths: - seeds: '%%PHINX_CONFIG_DIR%%/your/relative/path' - -Class namespaces may be specified by adding a key to each seed path: - -.. code-block:: yaml - - paths: - seeds: - App\Module1\Seeds: application/module1/seeds - App\Module2\Seeds: application/module2/seeds - - -Custom Seeder Base ---------------------- - -By default all seeders will extend from Phinx's `AbstractSeed` class. -This can be set to a custom class that extends from `AbstractSeed` by -setting ``seed_base_class`` in your config: - -.. code-block:: yaml - - seed_base_class: MyMagicalSeeder - -Custom Migration Template -------------------------- - -Custom template for Migrations could be used either by defining template file path -in configuration file: - -.. code-block:: yaml - - templates: - file: src/templates/customMigrationTemplate.php - - -Custom Seeder Template ----------------------- - -Custom Seeder template could be used either by defining template file path -in configuration file: - -.. code-block:: yaml - - templates: - seedFile: src/templates/customSeederTemplate.php - - -Environments ------------- - -One of the key features of Phinx is support for multiple database environments. -You can use Phinx to create migrations on your development environment, then -run the same migrations on your production environment. Environments are -specified under the ``environments`` nested collection. For example: - -.. code-block:: yaml - - environments: - default_migration_table: phinxlog - default_environment: development - production: - adapter: mysql - host: localhost - name: production_db - user: root - pass: '' - port: 3306 - charset: utf8mb4 - collation: utf8mb4_unicode_ci - -would define a new environment called ``production``. - -In a situation when multiple developers work on the same project and each has -a different environment (e.g. a convention such as ``--``), or when you need to have separate -environments for separate purposes (branches, testing, etc) use environment -variable `PHINX_ENVIRONMENT` to override the default environment in the yaml -file: - -.. code-block:: bash - - export PHINX_ENVIRONMENT=dev-`whoami`-`hostname` - -Migration Table ---------------- - -To keep track of the migration statuses for an environment, phinx creates -a table to store this information. You can customize where this table -is created by configuring ``default_migration_table`` to be used as default -for all environments: - -.. code-block:: yaml - - environment: - default_migration_table: phinxlog - -If this field is omitted, then it will default to ``phinxlog``. For -databases that support it, e.g. Postgres, the schema name can be prefixed -with a period separator (``.``). For example, ``phinx.log`` will create -the table ``log`` in the ``phinx`` schema instead of ``phinxlog`` in the -``public`` (default) schema. - -You may also specify the ``migration_table`` on a per environment basis. -Any environment that does not have a ``migration_table`` specified will -fallback to using the ``default_migration_table`` that is defined at the -top level. An example of how you might use this is as follows: - -.. code-block:: yaml - - environment: - default_migration_table: phinxlog - development: - migration_table: phinxlog_dev - # rest of the development settings - production: - # rest of the production settings - -In the above example, ``development`` will look to the ``phinxlog_dev`` -table for migration statues while ``production`` will use ``phinxlog``. - -Table Prefix and Suffix ------------------------ - -You can define a table prefix and table suffix: - -.. code-block:: yaml - - environments: - development: - .... - table_prefix: dev_ - table_suffix: _v1 - testing: - .... - table_prefix: test_ - table_suffix: _v2 - - -Socket Connections ------------------- - -When using the MySQL adapter, it is also possible to use sockets instead of -network connections. The socket path is configured with ``unix_socket``: - -.. code-block:: yaml - - environments: - default_migration_table: phinxlog - default_environment: development - production: - adapter: mysql - name: production_db - user: root - pass: '' - unix_socket: /var/run/mysql/mysql.sock - charset: utf8 - -External Variables ------------------- - -Phinx will automatically grab any environment variable prefixed with ``PHINX_`` -and make it available as a token in the config file. The token will have -exactly the same name as the variable but you must access it by wrapping two -``%%`` symbols on either side. e.g: ``'%%PHINX_DBUSER%%'``. This is especially -useful if you wish to store your secret database credentials directly on the -server and not in a version control system. This feature can be easily -demonstrated by the following example: - -.. code-block:: yaml - - environments: - default_migration_table: phinxlog - default_environment: development - production: - adapter: mysql - host: '%%PHINX_DBHOST%%' - name: '%%PHINX_DBNAME%%' - user: '%%PHINX_DBUSER%%' - pass: '%%PHINX_DBPASS%%' - port: 3306 - charset: utf8 - -Data Source Names ------------------ - -Phinx supports the use of data source names (DSN) to specify the connection -options, which can be useful if you use a single environment variable to hold -the database credentials. PDO has a different DSN formats depending on the -underlying driver, so Phinx uses a database-agnostic DSN format used by other -projects (Doctrine, Rails, AMQP, PaaS, etc). - -.. code-block:: text - - ://[[:]@][:]/[?] - -* A DSN requires at least ``adapter``, ``host`` and ``name``. -* You cannot specify a password without a username. -* ``port`` must be a positive integer. -* ``additionalOptions`` takes the form of a query string, and will be passed to - the adapter in the options array. - -.. code-block:: yaml - - environments: - default_migration_table: phinxlog - default_environment: development - production: - # Example data source name - dsn: mysql://root@localhost:3306/mydb?charset=utf8 - -Once a DSN is parsed, it's values are merged with the already existing -connection options. Values in specified in a DSN will never override any value -specified directly as connection options. - -.. code-block:: yaml - - environments: - default_migration_table: phinxlog - default_environment: development - development: - dsn: '%%DATABASE_URL%%' - production: - dsn: '%%DATABASE_URL%%' - name: production_database - -If the supplied DSN is invalid, then it is completely ignored. - -Supported Adapters ------------------- - -Phinx currently supports the following database adapters natively: - -* `MySQL `_: specify the ``mysql`` adapter. -* `PostgreSQL `_: specify the ``pgsql`` adapter. -* `SQLite `_: specify the ``sqlite`` adapter. -* `SQL Server `_: specify the ``sqlsrv`` adapter. - -The following settings are available for the adapters: - -adapter - The name of the adapter to use, e.g. ``pgsql``. -host - The database server's hostname (or IP address). -port - The database server's TCP port number. -user - The username for the database. -pass - The password for the database. -name - The name of the database for this environment. For SQLite, it's recommended to use an absolute path, - without the file extension. -suffix - The suffix to use for the SQLite database file. Defaults to ``.sqlite3``. -schema - For PostgreSQL, allows specifying the schema to use for the database. Defaults to ``public``. - -For each adapter, you may configure the behavior of the underlying PDO object by setting in your -config object the lowercase version of the constant name. This works for both PDO options -(e.g. ``\PDO::ATTR_CASE`` would be ``attr_case``) and adapter specific options (e.g. for MySQL -you may set ``\PDO::MYSQL_ATTR_IGNORE_SPACE`` as ``mysql_attr_ignore_space``). Please consult -the `PDO documentation `_ for the allowed attributes -and their values. - -For example, to set the above example options: - -.. code-block:: php - - $config = [ - "environments" => [ - "development" => [ - "adapter" => "mysql", - # other adapter settings - "attr_case" => \PDO::ATTR_CASE, - "mysql_attr_ignore_space" => 1, - ], - ], - ]; - -By default, the only attribute that Phinx sets is ``\PDO::ATTR_ERRMODE`` to ``PDO::ERRMODE_EXCEPTION``. It is -not recommended to override this. - -MySQL -````````````````` - -The MySQL adapter has an unfortunate limitation in that certain actions cause an -`implicit commit `_ regardless of transaction -state. Notably this list includes ``CREATE TABLE``, ``ALTER TABLE``, and ``DROP TABLE``, which are the most -common operations that Phinx will run. This means that unlike other adapters which will attempt to gracefully -rollback a transaction on a failed migration, if a migration fails for MySQL, it may leave your DB in a partially -migrated state. - -SQLite -````````````````` - -Declaring an SQLite database uses a simplified structure: - -.. code-block:: yaml - - environments: - development: - adapter: sqlite - name: ./data/derby - suffix: ".db" # Defaults to ".sqlite3" - testing: - adapter: sqlite - memory: true # Setting memory to *any* value overrides name - -Starting with PHP 8.1 the SQlite adapter supports ``cache`` and ``mode`` -query parameters by using the `URI scheme `_ as long as ``open_basedir`` is unset. - -.. code-block:: yaml - - environments: - testing: - adapter: sqlite - name: my_app - mode: memory # Determines if the new database is opened read-only, read-write, read-write and created if it does not exist, or that the database is a pure in-memory database that never interacts with disk, respectively. - cache: shared # Determines if the new database is opened using shared cache mode or with a private cache. - -SQL Server -````````````````` - -When using the ``sqlsrv`` adapter and connecting to a named instance you should -omit the ``port`` setting as SQL Server will negotiate the port automatically. -Additionally, omit the ``charset: utf8`` or change to ``charset: 65001`` which -corresponds to UTF8 for SQL Server. - -Custom Adapters -````````````````` - -You can provide a custom adapter by registering an implementation of the `Phinx\\Db\\Adapter\\AdapterInterface` -with `AdapterFactory`: - -.. code-block:: php - - $name = 'fizz'; - $class = 'Acme\Adapter\FizzAdapter'; - - AdapterFactory::instance()->registerAdapter($name, $class); - -Adapters can be registered any time before `$app->run()` is called, which normally -called by `bin/phinx`. - -Templates ---------- - -You may override how phinx generates the template used with in a handful of ways: - -* file - path to an alternative file to use. -* class - class to use for the template, must implement the ``Phinx\Migration\CreationInterface`` interface. -* style - style to use for template, either ``change`` or ``up_down``, defaults to ``change`` if not set. - -You should only use one of these options. These can be overridden by passing command line options to the -:doc:`Create Command `. - -The aliased classes will still be required to implement the ``Phinx\Migration\CreationInterface`` interface. - -.. code-block:: yaml - - aliases: - permission: \Namespace\Migrations\PermissionMigrationTemplateGenerator - view: \Namespace\Migrations\ViewMigrationTemplateGenerator - -Version Order -------------- - -When rolling back or printing the status of migrations, Phinx orders the executed migrations according to the -``version_order`` option, which can have the following values: - -* ``creation`` (the default): migrations are ordered by their creation time, which is also part of their filename. -* ``execution``: migrations are ordered by their execution time, also known as start time. - -Bootstrap Path ---------------- - -You can provide a path to a `bootstrap` php file that will be included before any phinx commands are run. Note that -setting External Variables to modify the config will not work because the config has already been parsed by this point. - -.. code-block:: yaml - - paths: - bootstrap: 'phinx-bootstrap.php' - -Within the bootstrap script, the following variables will be available: - -.. code-block:: php - - /** - * @var string $filename The file name as provided by the configuration - * @var string $filePath The absolute, real path to the file - * @var \Symfony\Component\Console\Input\InputInterface $input The executing command's input object - * @var \Symfony\Component\Console\Output\OutputInterface $output The executing command's output object - * @var \Phinx\Console\Command\AbstractCommand $context the executing command object - */ - -Feature Flags -------------- - -For some breaking changes, Phinx offers a way to opt-out of new behavior. The following flags are available: - -* ``unsigned_primary_keys``: Should Phinx create primary keys as unsigned integers? (default: ``true``) -* ``column_null_default``: Should Phinx create columns as null by default? (default: ``true``) - -Since MySQL ``TIMESTAMP`` fields do not support dates past 2038-01-19, you have the option to use ``DATETIME`` field -types for fields created by the ``addTimestamps()`` function: - -* ``add_timestamps_use_datetime``: Should Phinx create created_at and updated_at fields as datetime? (default: ``false``) - -.. code-block:: yaml - - feature_flags: - unsigned_primary_keys: false - -These values can also be set by modifying class fields on the ```Phinx\Config\FeatureFlags``` class, converting -the flag name to ``camelCase``, for example: - -.. code-block:: php - - Phinx\Config\FeatureFlags::$unsignedPrimaryKeys = false; diff --git a/app/vendor/robmorgan/phinx/docs/en/contents.rst b/app/vendor/robmorgan/phinx/docs/en/contents.rst deleted file mode 100644 index 900f6ed2e..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/contents.rst +++ /dev/null @@ -1,14 +0,0 @@ -Contents -######## - -.. toctree:: - :caption: Phinx - - intro - goals - install - migrations - seeding - commands - configuration - copyright diff --git a/app/vendor/robmorgan/phinx/docs/en/copyright.rst b/app/vendor/robmorgan/phinx/docs/en/copyright.rst deleted file mode 100644 index 71a6dfc11..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/copyright.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. index:: - single: Copyright - -Copyright -========= - -License - -(The MIT license) - -Copyright (c) 2012 Rob Morgan - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies -of the Software, and to permit persons to whom the Software is furnished to do -so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. \ No newline at end of file diff --git a/app/vendor/robmorgan/phinx/docs/en/goals.rst b/app/vendor/robmorgan/phinx/docs/en/goals.rst deleted file mode 100644 index aaea2453c..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/goals.rst +++ /dev/null @@ -1,13 +0,0 @@ -.. index:: - single: Goals - -Goals -===== - -Phinx was developed with the following goals in mind: - -* Be portable amongst the most popular database vendors. -* Be PHP framework independent. -* Have a simple install process. -* Have an easy to use command-line operation. -* Integrate with various other PHP tools (Phing, PHPUnit) and web frameworks. diff --git a/app/vendor/robmorgan/phinx/docs/en/index.rst b/app/vendor/robmorgan/phinx/docs/en/index.rst deleted file mode 100644 index c17323068..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/index.rst +++ /dev/null @@ -1,33 +0,0 @@ -:orphan: - -Phinx Documentation -=================== - -Phinx makes it ridiculously easy to manage the database migrations for your PHP -app. In less than 5 minutes, you can install Phinx using Composer and create -your first database migration. Phinx is just about migrations without all the -bloat of a database ORM system or application framework. - -Phinx requires a 64-bit version of PHP to function. - -Contents -======== - -.. toctree:: - :maxdepth: 2 - - intro - goals - install - migrations - seeding - commands - configuration - copyright - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/app/vendor/robmorgan/phinx/docs/en/install.rst b/app/vendor/robmorgan/phinx/docs/en/install.rst deleted file mode 100644 index 10078c7a1..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/install.rst +++ /dev/null @@ -1,28 +0,0 @@ -.. index:: - single: Installation - -Installation -============ - -Phinx should be installed using Composer, which is a tool for dependency -management in PHP. Please visit the `Composer `_ -website for more information. - -.. note:: - - Phinx requires at least PHP 8.1 (or later). - -To install Phinx, simply require it using Composer: - -.. code-block:: bash - - php composer.phar require robmorgan/phinx - -Create folders in your project following the structure ``db/migrations`` with adequate permissions. -It is where your migration files will live and should be writable. - -Phinx can now be executed from within your project: - -.. code-block:: bash - - vendor/bin/phinx init diff --git a/app/vendor/robmorgan/phinx/docs/en/intro.rst b/app/vendor/robmorgan/phinx/docs/en/intro.rst deleted file mode 100644 index 50c44443f..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/intro.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. index:: - single: Introduction - -Introduction -============ - -Good developers always version their code using a SCM system, so why don't they -do the same for their database schema? - -Phinx allows developers to alter and manipulate databases in a clear and -concise way. It avoids the use of writing SQL by hand and instead offers a -powerful API for creating migrations using PHP code. Developers can then -version these migrations using their preferred SCM system. This makes Phinx -migrations portable between different database systems. Phinx keeps track of -which migrations have been run, so you can worry less about the state of your -database and instead focus on building better software. \ No newline at end of file diff --git a/app/vendor/robmorgan/phinx/docs/en/migrations.rst b/app/vendor/robmorgan/phinx/docs/en/migrations.rst deleted file mode 100644 index 4c34b768f..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/migrations.rst +++ /dev/null @@ -1,1988 +0,0 @@ -.. index:: - single: Writing Migrations - -Writing Migrations -================== - -Phinx relies on migrations in order to transform your database. Each migration -is represented by a PHP class in a unique file. It is preferred that you write -your migrations using the Phinx PHP API, but raw SQL is also supported. - -Creating a New Migration ------------------------- -Generating a skeleton migration file -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Let's start by creating a new Phinx migration. Run Phinx using the ``create`` -command: - -.. code-block:: bash - - $ vendor/bin/phinx create MyNewMigration - -This will create a new migration in the format -``YYYYMMDDHHMMSS_my_new_migration.php``, where the first 14 characters are -replaced with the current timestamp down to the second. - -If you have specified multiple migration paths, you will be asked to select -which path to create the new migration in. - -Phinx automatically creates a skeleton migration file with a single method: - -.. code-block:: php - - table('user_logins'); - $table->addColumn('user_id', 'integer') - ->addColumn('created', 'datetime') - ->create(); - } - } - -When executing this migration, Phinx will create the ``user_logins`` table on -the way up and automatically figure out how to drop the table on the way down. -Please be aware that when a ``change`` method exists, Phinx will automatically -ignore the ``up`` and ``down`` methods. If you need to use these methods it is -recommended to create a separate migration file. - -.. note:: - - When creating or updating tables inside a ``change()`` method you must use - the Table ``create()`` and ``update()`` methods. Phinx cannot automatically - determine whether a ``save()`` call is creating a new table or modifying an - existing one. - -The following actions are reversible when done through the Table API in Phinx, -and will be automatically reversed: - -- Creating a table -- Renaming a table -- Adding a column -- Renaming a column -- Adding an index -- Adding a foreign key - -If a command cannot be reversed then Phinx will throw an -``IrreversibleMigrationException`` when it's migrating down. If you wish to -use a command that cannot be reversed in the change function, you can use an -if statement with ``$this->isMigratingUp()`` to only run things in the -up or down direction. For example: - -.. code-block:: php - - table('user_logins'); - $table->addColumn('user_id', 'integer') - ->addColumn('created', 'datetime') - ->create(); - if ($this->isMigratingUp()) { - $table->insert([['user_id' => 1, 'created' => '2020-01-19 03:14:07']]) - ->save(); - } - } - } - -The Up Method -~~~~~~~~~~~~~ - -The up method is automatically run by Phinx when you are migrating up and it -detects the given migration hasn't been executed previously. You should use the -up method to transform the database with your intended changes. - -The Down Method -~~~~~~~~~~~~~~~ - -The down method is automatically run by Phinx when you are migrating down and -it detects the given migration has been executed in the past. You should use -the down method to reverse/undo the transformations described in the up method. - -The Init Method -~~~~~~~~~~~~~~~ - -The ``init()`` method is run by Phinx before the migration methods if it exists. -This can be used for setting common class properties that are then used within -the migration methods. - -The Should Execute Method -~~~~~~~~~~~~~~~~~~~~~~~~~ - -The ``shouldExecute()`` method is run by Phinx before executing the migration. -This can be used to prevent the migration from being executed at this time. It always -returns true by default. You can override it in your custom ``AbstractMigration`` -implementation. - -Executing Queries ------------------ - -Queries can be executed with the ``execute()`` and ``query()`` methods. The -``execute()`` method returns the number of affected rows whereas the -``query()`` method returns the result as a -`PDOStatement `_. Both methods -accept an optional second parameter ``$params`` which is an array of elements, -and if used will cause the underlying connection to use a prepared statement. - -.. code-block:: php - - execute('DELETE FROM users'); // returns the number of affected rows - - // query() - $stmt = $this->query('SELECT * FROM users'); // returns PDOStatement - $rows = $stmt->fetchAll(); // returns the result as an array - - // using prepared queries - $count = $this->execute('DELETE FROM users WHERE id = ?', [5]); - $stmt = $this->query('SELECT * FROM users WHERE id > ?', [5]); // returns PDOStatement - $rows = $stmt->fetchAll(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -.. note:: - - These commands run using the PHP Data Objects (PDO) extension which - defines a lightweight, consistent interface for accessing databases - in PHP. Always make sure your queries abide with PDOs before using - the ``execute()`` command. This is especially important when using - DELIMITERs during insertion of stored procedures or triggers which - don't support DELIMITERs. - -.. note:: - - If you wish to execute multiple queries at once, you may not also use the prepared - variant of these functions. When using prepared queries, PDO can only execute - them one at a time. - -.. warning:: - - When using ``execute()`` or ``query()`` with a batch of queries, PDO doesn't - throw an exception if there is an issue with one or more of the queries - in the batch. - - As such, the entire batch is assumed to have passed without issue. - - If Phinx was to iterate any potential result sets, looking to see if one - had an error, then Phinx would be denying access to all the results as there - is no facility in PDO to get a previous result set - `nextRowset() `_ - - but no ``previousSet()``). - - So, as a consequence, due to the design decision in PDO to not throw - an exception for batched queries, Phinx is unable to provide the fullest - support for error handling when batches of queries are supplied. - - Fortunately though, all the features of PDO are available, so multiple batches - can be controlled within the migration by calling upon - `nextRowset() `_ - and examining `errorInfo `_. - -Fetching Rows -------------- - -There are two methods available to fetch rows. The ``fetchRow()`` method will -fetch a single row, whilst the ``fetchAll()`` method will return multiple rows. -Both methods accept raw SQL as their only parameter. - -.. code-block:: php - - fetchRow('SELECT * FROM users'); - - // fetch an array of messages - $rows = $this->fetchAll('SELECT * FROM messages'); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -Inserting Data --------------- - -Phinx makes it easy to insert data into your tables. Whilst this feature is -intended for the :doc:`seed feature `, you are also free to use the -insert methods in your migrations. - -.. code-block:: php - - table('status'); - - // inserting only one row - $singleRow = [ - 'id' => 1, - 'name' => 'In Progress' - ]; - - $table->insert($singleRow)->saveData(); - - // inserting multiple rows - $rows = [ - [ - 'id' => 2, - 'name' => 'Stopped' - ], - [ - 'id' => 3, - 'name' => 'Queued' - ] - ]; - - $table->insert($rows)->saveData(); - } - - /** - * Migrate Down. - */ - public function down() - { - $this->execute('DELETE FROM status'); - } - } - -.. note:: - - You cannot use the insert methods inside a `change()` method. Please use the - `up()` and `down()` methods. - -Working With Tables -------------------- - -The Table Object -~~~~~~~~~~~~~~~~ - -The Table object is one of the most useful APIs provided by Phinx. It allows -you to easily manipulate database tables using PHP code. You can retrieve an -instance of the Table object by calling the ``table()`` method from within -your database migration. - -.. code-block:: php - - table('tableName'); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -You can then manipulate this table using the methods provided by the Table -object. - -Saving Changes -~~~~~~~~~~~~~~ - -When working with the Table object, Phinx stores certain operations in a -pending changes cache. Once you have made the changes you want to the table, -you must save them. To perform this operation, Phinx provides three methods, -``create()``, ``update()``, and ``save()``. ``create()`` will first create -the table and then run the pending changes. ``update()`` will just run the -pending changes, and should be used when the table already exists. ``save()`` -is a helper function that checks first if the table exists and if it does not -will run ``create()``, else it will run ``update()``. - -As stated above, when using the ``change()`` migration method, you should always -use ``create()`` or ``update()``, and never ``save()`` as otherwise migrating -and rolling back may result in different states, due to ``save()`` calling -``create()`` when running migrate and then ``update()`` on rollback. When -using the ``up()``/``down()`` methods, it is safe to use either ``save()`` or -the more explicit methods. - -When in doubt with working with tables, it is always recommended to call -the appropriate function and commit any pending changes to the database. - -Creating a Table -~~~~~~~~~~~~~~~~ - -Creating a table is really easy using the Table object. Let's create a table to -store a collection of users. - -.. code-block:: php - - table('users'); - $users->addColumn('username', 'string', ['limit' => 20]) - ->addColumn('password', 'string', ['limit' => 40]) - ->addColumn('password_salt', 'string', ['limit' => 40]) - ->addColumn('email', 'string', ['limit' => 100]) - ->addColumn('first_name', 'string', ['limit' => 30]) - ->addColumn('last_name', 'string', ['limit' => 30]) - ->addColumn('created', 'datetime') - ->addColumn('updated', 'datetime', ['null' => true]) - ->addIndex(['username', 'email'], ['unique' => true]) - ->create(); - } - } - -Columns are added using the ``addColumn()`` method. We create a unique index -for both the username and email columns using the ``addIndex()`` method. -Finally calling ``create()`` commits the changes to the database. - -.. note:: - - Phinx automatically creates an auto-incrementing primary key column called ``id`` for every - table. - -The ``id`` option sets the name of the automatically created identity field, while the ``primary_key`` -option selects the field or fields used for primary key. ``id`` will always override the ``primary_key`` -option unless it's set to false. If you don't need a primary key set ``id`` to false without -specifying a ``primary_key``, and no primary key will be created. - -To specify an alternate primary key, you can specify the ``primary_key`` option -when accessing the Table object. Let's disable the automatic ``id`` column and -create a primary key using two columns instead: - -.. code-block:: php - - table('followers', ['id' => false, 'primary_key' => ['user_id', 'follower_id']]); - $table->addColumn('user_id', 'integer') - ->addColumn('follower_id', 'integer') - ->addColumn('created', 'datetime') - ->create(); - } - } - -Setting a single ``primary_key`` doesn't enable the ``AUTO_INCREMENT`` option. -To simply change the name of the primary key, we need to override the default ``id`` field name: - -.. code-block:: php - - table('followers', ['id' => 'user_id']); - $table->addColumn('follower_id', 'integer') - ->addColumn('created', 'timestamp', ['default' => 'CURRENT_TIMESTAMP']) - ->create(); - } - } - -In addition, the MySQL adapter supports following options: - -========== =========== -Option Description -========== =========== -comment set a text comment on the table -row_format set the table row format -engine define table engine *(defaults to ``InnoDB``)* -collation define table collation *(defaults to ``utf8mb4_unicode_ci``)* -signed whether the primary key is ``signed`` *(defaults to ``false``)* -limit set the maximum length for the primary key -========== =========== - -By default, the primary key is ``unsigned``. -To simply set it to be signed just pass ``signed`` option with a ``true`` value: - -.. code-block:: php - - table('followers', ['signed' => false]); - $table->addColumn('follower_id', 'integer') - ->addColumn('created', 'timestamp', ['default' => 'CURRENT_TIMESTAMP']) - ->create(); - } - } - - -The PostgreSQL adapter supports the following options: - -========= =========== -Option Description -========= =========== -comment set a text comment on the table -========= =========== - -To view available column types and options, see `Valid Column Types`_ for details. - -Determining Whether a Table Exists -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can determine whether or not a table exists by using the ``hasTable()`` -method. - -.. code-block:: php - - hasTable('users'); - if ($exists) { - // do something - } - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -Dropping a Table -~~~~~~~~~~~~~~~~ - -Tables can be dropped quite easily using the ``drop()`` method. It is a -good idea to recreate the table again in the ``down()`` method. - -Note that like other methods in the ``Table`` class, ``drop`` also needs ``save()`` -to be called at the end in order to be executed. This allows phinx to intelligently -plan migrations when more than one table is involved. - -.. code-block:: php - - table('users')->drop()->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - $users = $this->table('users'); - $users->addColumn('username', 'string', ['limit' => 20]) - ->addColumn('password', 'string', ['limit' => 40]) - ->addColumn('password_salt', 'string', ['limit' => 40]) - ->addColumn('email', 'string', ['limit' => 100]) - ->addColumn('first_name', 'string', ['limit' => 30]) - ->addColumn('last_name', 'string', ['limit' => 30]) - ->addColumn('created', 'datetime') - ->addColumn('updated', 'datetime', ['null' => true]) - ->addIndex(['username', 'email'], ['unique' => true]) - ->save(); - } - } - -Renaming a Table -~~~~~~~~~~~~~~~~ - -To rename a table access an instance of the Table object then call the -``rename()`` method. - -.. code-block:: php - - table('users'); - $table - ->rename('legacy_users') - ->update(); - } - - /** - * Migrate Down. - */ - public function down() - { - $table = $this->table('legacy_users'); - $table - ->rename('users') - ->update(); - } - } - -Changing the Primary Key -~~~~~~~~~~~~~~~~~~~~~~~~ - -To change the primary key on an existing table, use the ``changePrimaryKey()`` method. -Pass in a column name or array of columns names to include in the primary key, or ``null`` to drop the primary key. -Note that the mentioned columns must be added to the table, they will not be added implicitly. - -.. code-block:: php - - table('users'); - $users - ->addColumn('username', 'string', ['limit' => 20, 'null' => false]) - ->addColumn('password', 'string', ['limit' => 40]) - ->save(); - - $users - ->addColumn('new_id', 'integer', ['null' => false]) - ->changePrimaryKey(['new_id', 'username']) - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -Changing the Table Comment -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To change the comment on an existing table, use the ``changeComment()`` method. -Pass in a string to set as the new table comment, or ``null`` to drop the existing comment. - -.. code-block:: php - - table('users'); - $users - ->addColumn('username', 'string', ['limit' => 20]) - ->addColumn('password', 'string', ['limit' => 40]) - ->save(); - - $users - ->changeComment('This is the table with users auth information, password should be encrypted') - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -Working With Columns --------------------- - -.. _valid-column-types: - -Valid Column Types -~~~~~~~~~~~~~~~~~~ - -Column types are specified as strings and can be one of: - -- binary -- boolean -- char -- date -- datetime -- decimal -- float -- double -- smallinteger -- integer -- biginteger -- string -- text -- time -- timestamp -- uuid - -In addition, the MySQL adapter supports ``enum``, ``set``, ``blob``, ``tinyblob``, ``mediumblob``, ``longblob``, ``bit`` and ``json`` column types -(``json`` in MySQL 5.7 and above). When providing a limit value and using ``binary``, ``varbinary`` or ``blob`` and its subtypes, the retained column -type will be based on required length (see `Limit Option and MySQL`_ for details); - -In addition, the Postgres adapter supports ``interval``, ``json``, ``jsonb``, ``uuid``, ``cidr``, ``inet`` and ``macaddr`` column types -(PostgreSQL 9.3 and above). - -Valid Column Options -~~~~~~~~~~~~~~~~~~~~ - -The following are valid column options: - -For any column type: - -======= =========== -Option Description -======= =========== -limit set maximum length for strings, also hints column types in adapters (see note below) -length alias for ``limit`` -default set default value or action -null allow ``NULL`` values, defaults to ``true`` (setting ``identity`` will override default to ``false``) -after specify the column that a new column should be placed after, or use ``\Phinx\Db\Adapter\MysqlAdapter::FIRST`` to place the column at the start of the table *(only applies to MySQL)* -comment set a text comment on the column -======= =========== - -For ``decimal`` columns: - -========= =========== -Option Description -========= =========== -precision combine with ``scale`` set to set decimal accuracy -scale combine with ``precision`` to set decimal accuracy -signed enable or disable the ``unsigned`` option *(only applies to MySQL)* -========= =========== - -For ``enum`` and ``set`` columns: - -========= =========== -Option Description -========= =========== -values Can be a comma separated list or an array of values -========= =========== - -For ``smallinteger``, ``integer`` and ``biginteger`` columns: - -======== =========== -Option Description -======== =========== -identity enable or disable automatic incrementing (if enabled, will set ``null: false`` if ``null`` option is not set) -signed enable or disable the ``unsigned`` option *(only applies to MySQL)* -======== =========== - -For Postgres, when using ``identity``, it will utilize the ``serial`` type appropriate for the integer size, so that -``smallinteger`` will give you ``smallserial``, ``integer`` gives ``serial``, and ``biginteger`` gives ``bigserial``. - -For ``timestamp`` columns: - -======== =========== -Option Description -======== =========== -default set default value (use with ``CURRENT_TIMESTAMP``) -update set an action to be triggered when the row is updated (use with ``CURRENT_TIMESTAMP``) *(only applies to MySQL)* -timezone enable or disable the ``with time zone`` option for ``time`` and ``timestamp`` columns *(only applies to Postgres)* -======== =========== - -You can add ``created_at`` and ``updated_at`` timestamps to a table using the ``addTimestamps()`` method. This method accepts -three arguments, where the first two allow setting alternative names for the columns while the third argument allows you to -enable the ``timezone`` option for the columns. The defaults for these arguments are ``created_at``, ``updated_at``, and ``false`` -respectively. For the first and second argument, if you provide ``null``, then the default name will be used, and if you provide -``false``, then that column will not be created. Please note that attempting to set both to ``false`` will throw a -``\RuntimeException``. Additionally, you can use the ``addTimestampsWithTimezone()`` method, which is an alias to -``addTimestamps()`` that will always set the third argument to ``true`` (see examples below). The ``created_at`` column will -have a default set to ``CURRENT_TIMESTAMP``. For MySQL only, ``update_at`` column will have update set to -``CURRENT_TIMESTAMP``. - -.. code-block:: php - - table('users')->addTimestamps()->create(); - // Use defaults (with timezones) - $table = $this->table('users')->addTimestampsWithTimezone()->create(); - - // Override the 'created_at' column name with 'recorded_at'. - $table = $this->table('books')->addTimestamps('recorded_at')->create(); - - // Override the 'updated_at' column name with 'amended_at', preserving timezones. - // The two lines below do the same, the second one is simply cleaner. - $table = $this->table('books')->addTimestamps(null, 'amended_at', true)->create(); - $table = $this->table('users')->addTimestampsWithTimezone(null, 'amended_at')->create(); - - // Only add the created_at column to the table - $table = $this->table('books')->addTimestamps(null, false); - // Only add the updated_at column to the table - $table = $this->table('users')->addTimestamps(false); - // Note, setting both false will throw a \RuntimeError - } - } - -For ``boolean`` columns: - -======== =========== -Option Description -======== =========== -signed enable or disable the ``unsigned`` option *(only applies to MySQL)* -======== =========== - -For ``string`` and ``text`` columns: - -========= =========== -Option Description -========= =========== -collation set collation that differs from table defaults *(only applies to MySQL)* -encoding set character set that differs from table defaults *(only applies to MySQL)* -========= =========== - -For foreign key definitions: - -========== =========== -Option Description -========== =========== -update set an action to be triggered when the row is updated -delete set an action to be triggered when the row is deleted -constraint set a name to be used by foreign key constraint -deferrable set the foreign key constraint to be deferrable *(only applies to PostgreSQL)* -========== =========== - -You can pass one or more of these options to any column with the optional -third argument array. - -Limit Option and MySQL -~~~~~~~~~~~~~~~~~~~~~~ - -When using the MySQL adapter, there are a couple things to consider when working with limits: - -- When using a ``string`` primary key or index on MySQL 5.7 or below, or the MyISAM storage engine, and the default charset of ``utf8mb4_unicode_ci``, you must specify a limit less than or equal to 191, or use a different charset. -- Additional hinting of database column type can be made for ``integer``, ``text``, ``blob``, ``tinyblob``, ``mediumblob``, ``longblob`` columns. Using ``limit`` with one the following options will modify the column type accordingly: - -============ ============== -Limit Column Type -============ ============== -BLOB_TINY TINYBLOB -BLOB_REGULAR BLOB -BLOB_MEDIUM MEDIUMBLOB -BLOB_LONG LONGBLOB -TEXT_TINY TINYTEXT -TEXT_REGULAR TEXT -TEXT_MEDIUM MEDIUMTEXT -TEXT_LONG LONGTEXT -INT_TINY TINYINT -INT_SMALL SMALLINT -INT_MEDIUM MEDIUMINT -INT_REGULAR INT -INT_BIG BIGINT -============ ============== - -For ``binary`` or ``varbinary`` types, if limit is set greater than allowed 255 bytes, the type will be changed to the best matching blob type given the length. - -.. code-block:: php - - table('cart_items'); - $table->addColumn('user_id', 'integer') - ->addColumn('product_id', 'integer', ['limit' => MysqlAdapter::INT_BIG]) - ->addColumn('subtype_id', 'integer', ['limit' => MysqlAdapter::INT_SMALL]) - ->addColumn('quantity', 'integer', ['limit' => MysqlAdapter::INT_TINY]) - ->create(); - -Custom Column Types & Default Values -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Some DBMS systems provide additional column types and default values that are specific to them. -If you don't want to keep your migrations DBMS-agnostic you can use those custom types in your migrations -through the ``\Phinx\Util\Literal::from`` method, which takes a string as its only argument, and returns an -instance of ``\Phinx\Util\Literal``. When Phinx encounters this value as a column's type it knows not to -run any validation on it and to use it exactly as supplied without escaping. This also works for ``default`` -values. - -You can see an example below showing how to add a ``citext`` column as well as a column whose default value -is a function, in PostgreSQL. This method of preventing the built-in escaping is supported in all adapters. - -.. code-block:: php - - table('users') - ->addColumn('username', Literal::from('citext')) - ->addColumn('uniqid', 'uuid', [ - 'default' => Literal::from('uuid_generate_v4()') - ]) - ->addColumn('creation', 'timestamp', [ - 'timezone' => true, - 'default' => Literal::from('now()') - ]) - ->create(); - } - } - -User Defined Types (Custom Data Domain) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Building upon the base types and column options you can define your custom -user defined types. Custom user defined types are configured in the -``data_domain`` root config option. - -.. code-block:: yaml - - data_domain: - phone_number: - type: string - length: 20 - address_line: - type: string - length: 150 - -Each user defined type can hold any valid type and column option, they are just -used as "macros" and replaced at the time of migration. - -.. code-block:: php - - table('user_data'); - $table->addColumn('user_phone_number', 'phone_number') - ->addColumn('user_address_line_1', 'address_line') - ->addColumn('user_address_line_2', 'address_line', ['null' => true]) - ->create(); - -Specifying a data domain at the beginning of your project is crucial to have a -homogeneous data model. It avoids mistakes like having many ``contact_name`` -columns with different lengths, mismatched integer types (long vs. bigint, etc). - -.. note:: - - For ``integer``, ``text`` and ``blob`` columns you can use the special - constants from MySQL and Postgress adapter classes. - - You can even customize some internal types to add your own default options, - but some column options can't be overriden in the data model (some options - are fixed like ``limit`` for the ``uuid`` special data type). - -.. code-block:: yaml - - # Some examples of custom data types - data_domain: - file: - type: blob - limit: BLOB_LONG # For MySQL DB. Uses MysqlAdapter::BLOB_LONG - boolean: - type: boolean # Customization of the boolean to be unsigned - signed: false - image_type: - type: enum # Enums can use YAML lists or a comma separated string - values: - - gif - - jpg - - png - -Get a column list -~~~~~~~~~~~~~~~~~ - -To retrieve all table columns, simply create a `table` object and call `getColumns()` -method. This method will return an array of Column classes with basic info. Example below: - -.. code-block:: php - - table('users')->getColumns(); - ... - } - - /** - * Migrate Down. - */ - public function down() - { - ... - } - } - -Get a column by name -~~~~~~~~~~~~~~~~~~~~ - -To retrieve one table column, simply create a `table` object and call the `getColumn()` -method. This method will return a Column class with basic info or NULL when the column doesn't exist. Example below: - -.. code-block:: php - - table('users')->getColumn('email'); - ... - } - - /** - * Migrate Down. - */ - public function down() - { - ... - } - } - -Checking whether a column exists -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can check if a table already has a certain column by using the -``hasColumn()`` method. - -.. code-block:: php - - table('user'); - $column = $table->hasColumn('username'); - - if ($column) { - // do something - } - - } - } - -Renaming a Column -~~~~~~~~~~~~~~~~~ - -To rename a column, access an instance of the Table object then call the -``renameColumn()`` method. - -.. code-block:: php - - table('users'); - $table->renameColumn('bio', 'biography') - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - $table = $this->table('users'); - $table->renameColumn('biography', 'bio') - ->save(); - } - } - -Adding a Column After Another Column -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -When adding a column with the MySQL adapter, you can dictate its position using the ``after`` option, -where its value is the name of the column to position it after. - -.. code-block:: php - - table('users'); - $table->addColumn('city', 'string', ['after' => 'email']) - ->update(); - } - } - -This would create the new column ``city`` and position it after the ``email`` column. The -``\Phinx\Db\Adapter\MysqlAdapter::FIRST`` constant can be used to specify that the new column should be -created as the first column in that table. - -Dropping a Column -~~~~~~~~~~~~~~~~~ - -To drop a column, use the ``removeColumn()`` method. - -.. code-block:: php - - table('users'); - $table->removeColumn('short_name') - ->save(); - } - } - - -Specifying a Column Limit -~~~~~~~~~~~~~~~~~~~~~~~~~ - -You can limit the maximum length of a column by using the ``limit`` option. - -.. code-block:: php - - table('tags'); - $table->addColumn('short_name', 'string', ['limit' => 30]) - ->update(); - } - } - -Changing Column Attributes -~~~~~~~~~~~~~~~~~~~~~~~~~~ - -To change column type or options on an existing column, use the ``changeColumn()`` method. -See :ref:`valid-column-types` and `Valid Column Options`_ for allowed values. - -.. code-block:: php - - table('users'); - $users->changeColumn('email', 'string', ['limit' => 255]) - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -Working With Indexes --------------------- - -To add an index to a table you can simply call the ``addIndex()`` method on the -table object. - -.. code-block:: php - - table('users'); - $table->addColumn('city', 'string') - ->addIndex(['city']) - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -By default Phinx instructs the database adapter to create a normal index. We -can pass an additional parameter ``unique`` to the ``addIndex()`` method to -specify a unique index. We can also explicitly specify a name for the index -using the ``name`` parameter, the index columns sort order can also be specified using -the ``order`` parameter. The order parameter takes an array of column names and sort order key/value pairs. - -.. code-block:: php - - table('users'); - $table->addColumn('email', 'string') - ->addColumn('username','string') - ->addIndex(['email', 'username'], [ - 'unique' => true, - 'name' => 'idx_users_email', - 'order' => ['email' => 'DESC', 'username' => 'ASC']] - ) - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -The MySQL adapter also supports ``fulltext`` indexes. If you are using a version before 5.6 you must -ensure the table uses the ``MyISAM`` engine. - -.. code-block:: php - - table('users', ['engine' => 'MyISAM']); - $table->addColumn('email', 'string') - ->addIndex('email', ['type' => 'fulltext']) - ->create(); - } - } - -In addition, MySQL adapter also supports setting the index length defined by limit option. -When you are using a multi-column index, you are able to define each column index length. -The single column index can define its index length with or without defining column name in limit option. - -.. code-block:: php - - table('users'); - $table->addColumn('email', 'string') - ->addColumn('username','string') - ->addColumn('user_guid', 'string', ['limit' => 36]) - ->addIndex(['email','username'], ['limit' => ['email' => 5, 'username' => 2]]) - ->addIndex('user_guid', ['limit' => 6]) - ->create(); - } - } - -The SQL Server and PostgreSQL adapters also supports ``include`` (non-key) columns on indexes. - -.. code-block:: php - - table('users'); - $table->addColumn('email', 'string') - ->addColumn('firstname','string') - ->addColumn('lastname','string') - ->addIndex(['email'], ['include' => ['firstname', 'lastname']]) - ->create(); - } - } - -In addition PostgreSQL adapters also supports Generalized Inverted Index ``gin`` indexes. - -.. code-block:: php - - table('users'); - $table->addColumn('address', 'string') - ->addIndex('address', ['type' => 'gin']) - ->create(); - } - } - -Removing indexes is as easy as calling the ``removeIndex()`` method. You must -call this method for each index. - -.. code-block:: php - - table('users'); - $table->removeIndex(['email']) - ->save(); - - // alternatively, you can delete an index by its name, ie: - $table->removeIndexByName('idx_users_email') - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - - -Working With Foreign Keys -------------------------- - -Phinx has support for creating foreign key constraints on your database tables. -Let's add a foreign key to an example table: - -.. code-block:: php - - table('tags'); - $table->addColumn('tag_name', 'string') - ->save(); - - $refTable = $this->table('tag_relationships'); - $refTable->addColumn('tag_id', 'integer', ['null' => true]) - ->addForeignKey('tag_id', 'tags', 'id', ['delete'=> 'SET_NULL', 'update'=> 'NO_ACTION']) - ->save(); - - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -"On delete" and "On update" actions are defined with a 'delete' and 'update' options array. Possibles values are 'SET_NULL', 'NO_ACTION', 'CASCADE' and 'RESTRICT'. If 'SET_NULL' is used then the column must be created as nullable with the option ``['null' => true]``. -Constraint name can be changed with the 'constraint' option. - -It is also possible to pass ``addForeignKey()`` an array of columns. -This allows us to establish a foreign key relationship to a table which uses a combined key. - -.. code-block:: php - - table('follower_events'); - $table->addColumn('user_id', 'integer') - ->addColumn('follower_id', 'integer') - ->addColumn('event_id', 'integer') - ->addForeignKey(['user_id', 'follower_id'], - 'followers', - ['user_id', 'follower_id'], - ['delete'=> 'NO_ACTION', 'update'=> 'NO_ACTION', 'constraint' => 'user_follower_id']) - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -We can add named foreign keys using the ``constraint`` parameter. This feature is supported as of Phinx version 0.6.5 - -.. code-block:: php - - table('your_table'); - $table->addForeignKey('foreign_id', 'reference_table', ['id'], - ['constraint' => 'your_foreign_key_name']); - ->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -For PostgreSQL, you can set if the foreign key is deferrable. The available options are ``DEFERRED`` (corresponds to -``DEFERRABLE INITIALLY DEFERRED``), ``IMMEDIATE`` (corresponds to ``DEFERRABLE INITIALLY IMMEDIATE``), and ``NOT_DEFERRED`` -(corresponds to ``NOT DEFERRABLE``). - -.. code-block:: php - - table('phones'); - $table->addColumn('name', 'string') - ->addColumn('manufacturer_name', 'string') - ->addForeignKey('manufacturer_name', - 'manufacturers ', - 'name', - ['deferrable' => 'DEFERRED']) - ->save(); - } - } - -We can also easily check if a foreign key exists: - -.. code-block:: php - - table('tag_relationships'); - $exists = $table->hasForeignKey('tag_id'); - if ($exists) { - // do something - } - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - -Finally, to delete a foreign key, use the ``dropForeignKey`` method. - -Note that like other methods in the ``Table`` class, ``dropForeignKey`` also needs ``save()`` -to be called at the end in order to be executed. This allows phinx to intelligently -plan migrations when more than one table is involved. - -.. code-block:: php - - table('tag_relationships'); - $table->dropForeignKey('tag_id')->save(); - } - - /** - * Migrate Down. - */ - public function down() - { - - } - } - - - -Using the Query Builder ------------------------ - -It is not uncommon to pair database structure changes with data changes. For example, you may want to -migrate the data in a couple columns from the users to a newly created table. For this type of scenarios, -Phinx provides access to a Query builder object, that you may use to execute complex ``SELECT``, ``UPDATE``, -``INSERT`` or ``DELETE`` statements. - -The Query builder is provided by the `cakephp/database `_ project, and should -be easy to work with as it resembles very closely plain SQL. Accesing the query builder is done by calling the -``getQueryBuilder(string $type)`` function. The ``string $type`` options are `'select'`, `'insert'`, `'update'` and `'delete'`: - - -.. code-block:: php - - getQueryBuilder('select'); - $statement = $builder->select('*')->from('users')->execute(); - var_dump($statement->fetchAll()); - } - } - -Alternatively, the following methods are available to enhance code organization and improve clarity: - -* ``getSelectBuilder()``: Returns a SelectQuery object for building SELECT statements. -* ``getInsertBuilder()``: Returns an InsertQuery object for building INSERT statements. -* ``getUpdateBuilder()``: Returns an UpdateQuery object for building UPDATE statements. -* ``getDeleteBuilder()``: Returns a DeleteQuery object for building DELETE statements. - - -.. code-block:: php - - getSelectBuilder(); - $statement = $builder->select('*')->from('users')->execute(); - var_dump($statement->fetchAll()); - } - } - - -Selecting Fields -~~~~~~~~~~~~~~~~ - -Adding fields to the SELECT clause: - - -.. code-block:: php - - select(['id', 'title', 'body']); - - // Results in SELECT id AS pk, title AS aliased_title, body ... - $builder->select(['pk' => 'id', 'aliased_title' => 'title', 'body']); - - // Use a closure - $builder->select(function ($builder) { - return ['id', 'title', 'body']; - }); - - -Where Conditions -~~~~~~~~~~~~~~~~ - -Generating conditions: - -.. code-block:: php - - // WHERE id = 1 - $builder->where(['id' => 1]); - - // WHERE id > 1 - $builder->where(['id >' => 1]); - - -As you can see you can use any operator by placing it with a space after the field name. Adding multiple conditions is easy as well: - - -.. code-block:: php - - where(['id >' => 1])->andWhere(['title' => 'My Title']); - - // Equivalent to - $builder->where(['id >' => 1, 'title' => 'My title']); - - // WHERE id > 1 OR title = 'My title' - $builder->where(['OR' => ['id >' => 1, 'title' => 'My title']]); - - -For even more complex conditions you can use closures and expression objects: - -.. code-block:: php - - select('*') - ->from('articles') - ->where(function ($exp) { - return $exp - ->eq('author_id', 2) - ->eq('published', true) - ->notEq('spam', true) - ->gt('view_count', 10); - }); - - -Which results in: - -.. code-block:: sql - - SELECT * FROM articles - WHERE - author_id = 2 - AND published = 1 - AND spam != 1 - AND view_count > 10 - - -Combining expressions is also possible: - - -.. code-block:: php - - select('*') - ->from('articles') - ->where(function ($exp) { - $orConditions = $exp->or_(['author_id' => 2]) - ->eq('author_id', 5); - return $exp - ->not($orConditions) - ->lte('view_count', 10); - }); - -It generates: - -.. code-block:: sql - - SELECT * - FROM articles - WHERE - NOT (author_id = 2 OR author_id = 5) - AND view_count <= 10 - - -When using the expression objects you can use the following methods to create conditions: - -* ``eq()`` Creates an equality condition. -* ``notEq()`` Create an inequality condition -* ``like()`` Create a condition using the ``LIKE`` operator. -* ``notLike()`` Create a negated ``LIKE`` condition. -* ``in()`` Create a condition using ``IN``. -* ``notIn()`` Create a negated condition using ``IN``. -* ``gt()`` Create a ``>`` condition. -* ``gte()`` Create a ``>=`` condition. -* ``lt()`` Create a ``<`` condition. -* ``lte()`` Create a ``<=`` condition. -* ``isNull()`` Create an ``IS NULL`` condition. -* ``isNotNull()`` Create a negated ``IS NULL`` condition. - - -Aggregates and SQL Functions -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - - -.. code-block:: php - - select(['count' => $builder->func()->count('*')]); - -A number of commonly used functions can be created with the func() method: - -* ``sum()`` Calculate a sum. The arguments will be treated as literal values. -* ``avg()`` Calculate an average. The arguments will be treated as literal values. -* ``min()`` Calculate the min of a column. The arguments will be treated as literal values. -* ``max()`` Calculate the max of a column. The arguments will be treated as literal values. -* ``count()`` Calculate the count. The arguments will be treated as literal values. -* ``concat()`` Concatenate two values together. The arguments are treated as bound parameters unless marked as literal. -* ``coalesce()`` Coalesce values. The arguments are treated as bound parameters unless marked as literal. -* ``dateDiff()`` Get the difference between two dates/times. The arguments are treated as bound parameters unless marked as literal. -* ``now()`` Take either 'time' or 'date' as an argument allowing you to get either the current time, or current date. - -When providing arguments for SQL functions, there are two kinds of parameters you can use, -literal arguments and bound parameters. Literal parameters allow you to reference columns or -other SQL literals. Bound parameters can be used to safely add user data to SQL functions. For example: - - -.. code-block:: php - - func()->concat([ - 'title' => 'literal', - ' NEW' - ]); - $query->select(['title' => $concat]); - - -Getting Results out of a Query -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Once you’ve made your query, you’ll want to retrieve rows from it. There are a few ways of doing this: - - -.. code-block:: php - - execute()->fetchAll('assoc'); - - -Creating an Insert Query -~~~~~~~~~~~~~~~~~~~~~~~~ - -Creating insert queries is also possible: - - -.. code-block:: php - - getQueryBuilder('insert'); - $builder - ->insert(['first_name', 'last_name']) - ->into('users') - ->values(['first_name' => 'Steve', 'last_name' => 'Jobs']) - ->values(['first_name' => 'Jon', 'last_name' => 'Snow']) - ->execute(); - - -For increased performance, you can use another builder object as the values for an insert query: - -.. code-block:: php - - getQueryBuilder('select'); - $namesQuery - ->select(['fname', 'lname']) - ->from('users') - ->where(['is_active' => true]); - - $builder = $this->getQueryBuilder('insert'); - $st = $builder - ->insert(['first_name', 'last_name']) - ->into('names') - ->values($namesQuery) - ->execute(); - - var_dump($st->lastInsertId('names', 'id')); - - -The above code will generate: - -.. code-block:: sql - - INSERT INTO names (first_name, last_name) - (SELECT fname, lname FROM USERS where is_active = 1) - - -Creating an update Query -~~~~~~~~~~~~~~~~~~~~~~~~ - -Creating update queries is similar to both inserting and selecting: - -.. code-block:: php - - getQueryBuilder('update'); - $builder - ->update('users') - ->set('fname', 'Snow') - ->where(['fname' => 'Jon']) - ->execute(); - - -Creating a Delete Query -~~~~~~~~~~~~~~~~~~~~~~~ - -Finally, delete queries: - -.. code-block:: php - - getQueryBuilder('delete'); - $builder - ->delete('users') - ->where(['accepted_gdpr' => false]) - ->execute(); diff --git a/app/vendor/robmorgan/phinx/docs/en/namespaces.rst b/app/vendor/robmorgan/phinx/docs/en/namespaces.rst deleted file mode 100644 index df00b096b..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/namespaces.rst +++ /dev/null @@ -1,154 +0,0 @@ -:orphan: - -.. index:: - single: Supporting namespaces - -PSR-4 compliance -================== - -Phinx allows the use of namespaces in Migrations and Seeders. -Migrations require a timestamp in the filename, and therefore won't be fully PSR-4 compliant. Seeders do not need a timestamp and will be fully PSR-4 compliant. - -Using namespaces ------------------------- -1) locate your Phinx config file, the config file may be in one of following three formats: PHP, YAML or JSON. -2) Locate the "paths" key inside the config file, it should look something like one of the below examples. - - (NB. the "migrations" and "seeds" keys may be both an array or a string, so don't be alarmed if yours looks different) - -PHP: - -.. code-block:: php - - 'paths' => [ - 'migrations' => 'database/migrations', - 'seeds' => 'database/seeds', - ], - - -YAML: - -.. code-block:: yaml - - paths: - migrations: ./database/migrations - seeds: ./database/seeds - -JSON: - -.. code-block:: json - - { - "paths": { - "migrations": "database/migrations", - "seeds": "database/seeds" - } - } - -3) Enabling namespaces is a fairly simple task, we're going to turn the "migrations" and "seeds" keys into arrays. - - Any value without a key is a global-non-namespaced path - - Any keyed value will use the key as namespace - -.. code-block:: php - - 'paths' => [ - 'migrations' => [ - '/path/to/migration/without/namespace', // Non-namespaced migrations - 'Foo' => '/path/to/migration/Foo', // Migrations in the Foo namespace - ], - 'seeds' => [ - '/path/to/seeds/without/namespace', // Non-namespaced seeders - 'Baz' => '/path/to/seeds/Baz', // Seeders in the Baz namespace - ] - ], - -PHP is a bit special in this case, as it allows keyless and keyed values in the same array. To make this configuration work in YAML and JSON, we have to key the non-namespaced path with "0". - -.. code-block:: json - - { - "paths": { - "migrations": { - "0": "./db/migrations", - "Foo\\Bar": "./src/FooBar/db/migrations" - } - } - } - -.. code-block:: yaml - - paths: - migrations: - 0: ./db/migrations - Foo\\Bar: ./src/FooBar/db/migrations - -Path resolving -^^^^^^^^^^^^^^ - -Let's take a closer look on how the paths are resolved, let's start with the non-namespaced path. - -"./" refers to the project-root, therefore "./db/migrations" would resolve to /db/migrations. -This is the directory where Phinx will look for migrations when migrating. -NB. these migrations must not have a namespace. - -.. image:: https://i.imgur.com/l84308Q.jpg - -This image shows the path for "./db/migrations" where "Phinx" is the project root. - -And the namespaced path would be resolved as shown below. - -"./src/FooBar/db/migrations" would resolve to /src/FooBar/db/migrations, which is where Phinx will look for migrations in the Foo\\Bar namespace. - -.. image:: https://i.imgur.com/2mg0V8V.jpg - -The file path would look like this, if the project-root was "Phinx" - -File examples -^^^^^^^^^^^^^ - -The non-namespaced file in /db/migrations may look like the following example. - -.. code-block:: php - - table('users'); - $table->addColumn('name', 'string')->create(); - } - } - -Whereas the namespaced file will be found in /src/FoorBar/db/migrations and can look like this: -(Notice the namespace is the same as defined in the paths config). - -.. code-block:: php - - table('users'); - $table->addColumn('name', 'string')->create(); - } - } - - -4) That's it, you're ready to go, to create a migration simply run: *$ phinx create CreateUsersTable [--path ./src/FoorBar/db/migrations]* - - - If multiple paths are configured, but none provided with the --path flag, you will be prompted for which path to use. - - -Did you run into an issue? --------------------------- - -- Due to the way the migrations are created, it is impossible to generate a migration in the *global* namespace with a class-name that is the same as a migration in a user-defined namespace. diff --git a/app/vendor/robmorgan/phinx/docs/en/seeding.rst b/app/vendor/robmorgan/phinx/docs/en/seeding.rst deleted file mode 100644 index 47e465b36..000000000 --- a/app/vendor/robmorgan/phinx/docs/en/seeding.rst +++ /dev/null @@ -1,234 +0,0 @@ -.. index:: - single: Database Seeding - -Database Seeding -================ - -In version 0.5.0 Phinx introduced support for seeding your database with test -data. Seed classes are a great way to easily fill your database with data after -it's created. By default they are stored in the `seeds` directory; however, this -path can be changed in your configuration file. - -.. note:: - - Database seeding is entirely optional, and Phinx does not create a `seeds` - directory by default. - -Creating a New Seed Class -------------------------- - -Phinx includes a command to easily generate a new seed class: - -.. code-block:: bash - - $ php vendor/bin/phinx seed:create UserSeeder - -If you have specified multiple seed paths, you will be asked to select which -path to create the new seed class in. - -It is based on a skeleton template: - -.. code-block:: php - - 'foo', - 'created' => date('Y-m-d H:i:s'), - ],[ - 'body' => 'bar', - 'created' => date('Y-m-d H:i:s'), - ] - ]; - - $posts = $this->table('posts'); - $posts->insert($data) - ->saveData(); - } - } - -.. note:: - - You must call the `saveData()` method to commit your data to the table. Phinx - will buffer data until you do so. - -Truncating Tables ------------------ - -In addition to inserting data Phinx makes it trivial to empty your tables using the -SQL `TRUNCATE` command: - -.. code-block:: php - - 'foo', - 'created' => date('Y-m-d H:i:s'), - ], - [ - 'body' => 'bar', - 'created' => date('Y-m-d H:i:s'), - ] - ]; - - $posts = $this->table('posts'); - $posts->insert($data) - ->saveData(); - - // empty the table - $posts->truncate(); - } - } - -.. note:: - - SQLite doesn't natively support the `TRUNCATE` command so behind the scenes - `DELETE FROM` is used. It is recommended to call the `VACUUM` command - after truncating a table. Phinx does not do this automatically. - -Executing Seed Classes ----------------------- - -This is the easy part. To seed your database, simply use the `seed:run` command: - -.. code-block:: bash - - $ php vendor/bin/phinx seed:run - -By default, Phinx will execute all available seed classes. If you would like to -run a specific class, simply pass in the name of it using the `-s` parameter: - -.. code-block:: bash - - $ php vendor/bin/phinx seed:run -s UserSeeder - -You can also run multiple seeders: - -.. code-block:: bash - - $ php vendor/bin/phinx seed:run -s UserSeeder -s PermissionSeeder -s LogSeeder - -You can also use the `-v` parameter for more output verbosity: - -.. code-block:: bash - - $ php vendor/bin/phinx seed:run -v - -The Phinx seed functionality provides a simple mechanism to easily and repeatably -insert test data into your database. diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Config/Config.php b/app/vendor/robmorgan/phinx/src/Phinx/Config/Config.php deleted file mode 100644 index 2b143c669..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Config/Config.php +++ /dev/null @@ -1,551 +0,0 @@ -configFilePath = $configFilePath; - $this->values = $this->replaceTokens($configArray); - - if (isset($this->values['feature_flags'])) { - FeatureFlags::setFlagsFromConfig($this->values['feature_flags']); - } - } - - /** - * Create a new instance of the config class using a Yaml file path. - * - * @param string $configFilePath Path to the Yaml File - * @throws \RuntimeException - * @return \Phinx\Config\ConfigInterface - */ - public static function fromYaml(string $configFilePath): ConfigInterface - { - if (!class_exists('Symfony\\Component\\Yaml\\Yaml', true)) { - // @codeCoverageIgnoreStart - throw new RuntimeException('Missing yaml parser, symfony/yaml package is not installed.'); - // @codeCoverageIgnoreEnd - } - - $configFile = file_get_contents($configFilePath); - $configArray = Yaml::parse($configFile); - - if (!is_array($configArray)) { - throw new RuntimeException(sprintf( - 'File \'%s\' must be valid YAML', - $configFilePath, - )); - } - - return new static($configArray, $configFilePath); - } - - /** - * Create a new instance of the config class using a JSON file path. - * - * @param string $configFilePath Path to the JSON File - * @throws \RuntimeException - * @return \Phinx\Config\ConfigInterface - */ - public static function fromJson(string $configFilePath): ConfigInterface - { - if (!function_exists('json_decode')) { - // @codeCoverageIgnoreStart - throw new RuntimeException('Need to install JSON PHP extension to use JSON config'); - // @codeCoverageIgnoreEnd - } - - $configArray = json_decode(file_get_contents($configFilePath), true); - if (!is_array($configArray)) { - throw new RuntimeException(sprintf( - 'File \'%s\' must be valid JSON', - $configFilePath, - )); - } - - return new static($configArray, $configFilePath); - } - - /** - * Create a new instance of the config class using a PHP file path. - * - * @param string $configFilePath Path to the PHP File - * @throws \RuntimeException - * @return \Phinx\Config\ConfigInterface - */ - public static function fromPhp(string $configFilePath): ConfigInterface - { - ob_start(); - /** @noinspection PhpIncludeInspection */ - $configArray = include $configFilePath; - - // Hide console output - ob_end_clean(); - - if (!is_array($configArray)) { - throw new RuntimeException(sprintf( - 'PHP file \'%s\' must return an array', - $configFilePath, - )); - } - - return new static($configArray, $configFilePath); - } - - /** - * @inheritDoc - */ - public function getEnvironments(): ?array - { - if (isset($this->values['environments'])) { - $environments = []; - foreach ($this->values['environments'] as $key => $value) { - if (is_array($value)) { - $environments[$key] = $value; - } - } - - return $environments; - } - - return null; - } - - /** - * @inheritDoc - */ - public function getEnvironment(string $name): ?array - { - $environments = $this->getEnvironments(); - - if (isset($environments[$name])) { - if ( - isset($this->values['environments']['default_migration_table']) - && !isset($environments[$name]['migration_table']) - ) { - $environments[$name]['migration_table'] = - $this->values['environments']['default_migration_table']; - } - - if ( - isset($environments[$name]['adapter']) - && $environments[$name]['adapter'] === 'sqlite' - && SQLiteAdapter::isMemory($environments[$name]) - ) { - $environments[$name]['name'] = SQLiteAdapter::MEMORY; - } - - return $this->parseAgnosticDsn($environments[$name]); - } - - return null; - } - - /** - * @inheritDoc - */ - public function hasEnvironment(string $name): bool - { - return $this->getEnvironment($name) !== null; - } - - /** - * @inheritDoc - */ - public function getDefaultEnvironment(): string - { - // The $PHINX_ENVIRONMENT variable overrides all other default settings - $env = getenv('PHINX_ENVIRONMENT'); - if (!empty($env)) { - if ($this->hasEnvironment($env)) { - return $env; - } - - throw new RuntimeException(sprintf( - 'The environment configuration (read from $PHINX_ENVIRONMENT) for \'%s\' is missing', - $env, - )); - } - - // deprecated: to be removed 0.13 - if (isset($this->values['environments']['default_database'])) { - trigger_error('default_database in the config has been deprecated since 0.12, use default_environment instead.', E_USER_DEPRECATED); - $this->values['environments']['default_environment'] = $this->values['environments']['default_database']; - } - - // if the user has configured a default environment then use it, - // providing it actually exists! - if (isset($this->values['environments']['default_environment'])) { - if ($this->hasEnvironment($this->values['environments']['default_environment'])) { - return $this->values['environments']['default_environment']; - } - - throw new RuntimeException(sprintf( - 'The environment configuration for \'%s\' is missing', - $this->values['environments']['default_environment'], - )); - } - - // else default to the first available one - if (is_array($this->getEnvironments()) && count($this->getEnvironments()) > 0) { - $names = array_keys($this->getEnvironments()); - - return $names[0]; - } - - throw new RuntimeException('Could not find a default environment'); - } - - /** - * @inheritDoc - */ - public function getAlias($alias): ?string - { - return !empty($this->values['aliases'][$alias]) ? $this->values['aliases'][$alias] : null; - } - - /** - * @inheritDoc - */ - public function getAliases(): array - { - return !empty($this->values['aliases']) ? $this->values['aliases'] : []; - } - - /** - * @inheritDoc - */ - public function getConfigFilePath(): ?string - { - return $this->configFilePath; - } - - /** - * @inheritDoc - * @throws \UnexpectedValueException - */ - public function getMigrationPaths(): array - { - if (!isset($this->values['paths']['migrations'])) { - throw new UnexpectedValueException('Migrations path missing from config file'); - } - - if (is_string($this->values['paths']['migrations'])) { - $this->values['paths']['migrations'] = [$this->values['paths']['migrations']]; - } - - return $this->values['paths']['migrations']; - } - - /** - * @inheritDoc - * @throws \UnexpectedValueException - */ - public function getSeedPaths(): array - { - if (!isset($this->values['paths']['seeds'])) { - throw new UnexpectedValueException('Seeds path missing from config file'); - } - - if (is_string($this->values['paths']['seeds'])) { - $this->values['paths']['seeds'] = [$this->values['paths']['seeds']]; - } - - return $this->values['paths']['seeds']; - } - - /** - * @inheritdoc - */ - public function getMigrationBaseClassName(bool $dropNamespace = true): string - { - $className = !isset($this->values['migration_base_class']) ? 'Phinx\Migration\AbstractMigration' : $this->values['migration_base_class']; - - return $dropNamespace ? (substr(strrchr($className, '\\'), 1) ?: $className) : $className; - } - - /** - * @inheritdoc - */ - public function getSeedBaseClassName(bool $dropNamespace = true): string - { - $className = !isset($this->values['seed_base_class']) ? 'Phinx\Seed\AbstractSeed' : $this->values['seed_base_class']; - - return $dropNamespace ? substr(strrchr($className, '\\'), 1) : $className; - } - - /** - * @inheritdoc - */ - public function getTemplateFile(): string|false - { - if (!isset($this->values['templates']['file'])) { - return false; - } - - return $this->values['templates']['file']; - } - - /** - * @inheritdoc - */ - public function getTemplateClass(): string|false - { - if (!isset($this->values['templates']['class'])) { - return false; - } - - return $this->values['templates']['class']; - } - - /** - * @inheritdoc - */ - public function getTemplateStyle(): string - { - if (!isset($this->values['templates']['style'])) { - return self::TEMPLATE_STYLE_CHANGE; - } - - return $this->values['templates']['style'] === self::TEMPLATE_STYLE_UP_DOWN ? self::TEMPLATE_STYLE_UP_DOWN : self::TEMPLATE_STYLE_CHANGE; - } - - /** - * @inheritdoc - */ - public function getDataDomain(): array - { - if (!isset($this->values['data_domain'])) { - return []; - } - - return $this->values['data_domain']; - } - - /** - * @inheritDoc - */ - public function getContainer(): ?ContainerInterface - { - if (!isset($this->values['container'])) { - return null; - } - - return $this->values['container']; - } - - /** - * @inheritdoc - */ - public function getVersionOrder(): string - { - if (!isset($this->values['version_order'])) { - return self::VERSION_ORDER_CREATION_TIME; - } - - return $this->values['version_order']; - } - - /** - * @inheritdoc - */ - public function isVersionOrderCreationTime(): bool - { - $versionOrder = $this->getVersionOrder(); - - return $versionOrder == self::VERSION_ORDER_CREATION_TIME; - } - - /** - * @inheritdoc - */ - public function getBootstrapFile(): string|false - { - if (!isset($this->values['paths']['bootstrap'])) { - return false; - } - - return $this->values['paths']['bootstrap']; - } - - /** - * Replace tokens in the specified array. - * - * @param array $arr Array to replace - * @return array - */ - protected function replaceTokens(array $arr): array - { - // Get environment variables - // Depending on configuration of server / OS and variables_order directive, - // environment variables either end up in $_SERVER (most likely) or $_ENV, - // so we search through both - $tokens = []; - foreach (array_merge($_ENV, $_SERVER) as $varname => $varvalue) { - if (strpos($varname, 'PHINX_') === 0) { - $tokens['%%' . $varname . '%%'] = $varvalue; - } - } - - // Phinx defined tokens (override env tokens) - $tokens['%%PHINX_CONFIG_PATH%%'] = $this->getConfigFilePath(); - $tokens['%%PHINX_CONFIG_DIR%%'] = $this->getConfigFilePath() !== null ? dirname($this->getConfigFilePath()) : ''; - - // Recurse the array and replace tokens - return $this->recurseArrayForTokens($arr, $tokens); - } - - /** - * Recurse an array for the specified tokens and replace them. - * - * @param array $arr Array to recurse - * @param string[] $tokens Array of tokens to search for - * @return array - */ - protected function recurseArrayForTokens(array $arr, array $tokens): array - { - $out = []; - foreach ($arr as $name => $value) { - if (is_array($value)) { - $out[$name] = $this->recurseArrayForTokens($value, $tokens); - continue; - } - if (is_string($value)) { - foreach ($tokens as $token => $tval) { - $value = str_replace($token, $tval ?? '', $value); - } - $out[$name] = $value; - continue; - } - $out[$name] = $value; - } - - return $out; - } - - /** - * Parse a database-agnostic DSN into individual options. - * - * @param array $options Options - * @return array - */ - protected function parseAgnosticDsn(array $options): array - { - $parsed = Util::parseDsn($options['dsn'] ?? ''); - if ($parsed) { - unset($options['dsn']); - } - - $options += $parsed; - - return $options; - } - - /** - * {@inheritDoc} - * - * @param mixed $id ID - * @param mixed $value Value - * @return void - */ - public function offsetSet($id, $value): void - { - $this->values[$id] = $value; - } - - /** - * {@inheritDoc} - * - * @param mixed $id ID - * @throws \InvalidArgumentException - * @return mixed - */ - #[ReturnTypeWillChange] - public function offsetGet($id) - { - if (!array_key_exists($id, $this->values)) { - throw new InvalidArgumentException(sprintf('Identifier "%s" is not defined.', $id)); - } - - return $this->values[$id] instanceof Closure ? $this->values[$id]($this) : $this->values[$id]; - } - - /** - * {@inheritDoc} - * - * @param mixed $id ID - * @return bool - */ - public function offsetExists($id): bool - { - return isset($this->values[$id]); - } - - /** - * {@inheritDoc} - * - * @param mixed $id ID - * @return void - */ - public function offsetUnset($id): void - { - unset($this->values[$id]); - } - - /** - * @inheritdoc - */ - public function getSeedTemplateFile(): ?string - { - return $this->values['templates']['seedFile'] ?? null; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Config/ConfigInterface.php b/app/vendor/robmorgan/phinx/src/Phinx/Config/ConfigInterface.php deleted file mode 100644 index 81382a2b9..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Config/ConfigInterface.php +++ /dev/null @@ -1,168 +0,0 @@ -null if no environments exist. - * - * @return array|null - */ - public function getEnvironments(): ?array; - - /** - * Returns the configuration for a given environment. - * - * This method returns null if the specified environment - * doesn't exist. - * - * @param string $name Environment Name - * @return array|null - */ - public function getEnvironment(string $name): ?array; - - /** - * Does the specified environment exist in the configuration file? - * - * @param string $name Environment Name - * @return bool - */ - public function hasEnvironment(string $name): bool; - - /** - * Gets the default environment name. - * - * @throws \RuntimeException - * @return string - */ - public function getDefaultEnvironment(): string; - - /** - * Get the aliased value from a supplied alias. - * - * @param string $alias Alias - * @return string|null - */ - public function getAlias(string $alias): ?string; - - /** - * Get all the aliased values. - * - * @return string[] - */ - public function getAliases(): array; - - /** - * Gets the config file path. - * - * @return string|null - */ - public function getConfigFilePath(): ?string; - - /** - * Gets the paths to search for migration files. - * - * @return string[] - */ - public function getMigrationPaths(): array; - - /** - * Gets the paths to search for seed files. - * - * @return string[] - */ - public function getSeedPaths(): array; - - /** - * Get the template file name. - * - * @return string|false - */ - public function getTemplateFile(): string|false; - - /** - * Get the template class name. - * - * @return string|false - */ - public function getTemplateClass(): string|false; - - /** - * Get the template style to use, either change or up_down. - * - * @return string - */ - public function getTemplateStyle(): string; - - /** - * Get the user-provided container for instantiating seeds - * - * @return \Psr\Container\ContainerInterface|null - */ - public function getContainer(): ?ContainerInterface; - - /** - * Get the data domain array. - * - * @return array - */ - public function getDataDomain(): array; - - /** - * Get the version order. - * - * @return string - */ - public function getVersionOrder(): string; - - /** - * Is version order creation time? - * - * @return bool - */ - public function isVersionOrderCreationTime(): bool; - - /** - * Get the bootstrap file path - * - * @return string|false - */ - public function getBootstrapFile(): string|false; - - /** - * Gets the base class name for migrations. - * - * @param bool $dropNamespace Return the base migration class name without the namespace. - * @return string - */ - public function getMigrationBaseClassName(bool $dropNamespace = true): string; - - /** - * Gets the base class name for seeders. - * - * @param bool $dropNamespace Return the base seeder class name without the namespace. - * @return string - */ - public function getSeedBaseClassName(bool $dropNamespace = true): string; - - /** - * Get the seeder template file name or null if not set. - * - * @return string|null - */ - public function getSeedTemplateFile(): ?string; -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Config/FeatureFlags.php b/app/vendor/robmorgan/phinx/src/Phinx/Config/FeatureFlags.php deleted file mode 100644 index 67da55d29..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Config/FeatureFlags.php +++ /dev/null @@ -1,48 +0,0 @@ -getMigrationPaths(); - - return $this->searchNamespace($path, $paths); - } - - /** - * Get Seed Namespace associated with path. - * - * @param string $path Path - * @return string|null - */ - public function getSeedNamespaceByPath(string $path): ?string - { - $paths = $this->getSeedPaths(); - - return $this->searchNamespace($path, $paths); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/AbstractCommand.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/AbstractCommand.php deleted file mode 100644 index 88cafc424..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/AbstractCommand.php +++ /dev/null @@ -1,507 +0,0 @@ -addOption('--configuration', '-c', InputOption::VALUE_REQUIRED, 'The configuration file to load'); - $this->addOption('--parser', '-p', InputOption::VALUE_REQUIRED, 'Parser used to read the config file. Defaults to YAML'); - $this->addOption('--no-info', null, InputOption::VALUE_NONE, 'Hides all debug information'); - } - - /** - * Bootstrap Phinx. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return void - */ - public function bootstrap(InputInterface $input, OutputInterface $output): void - { - if ($input->hasParameterOption('--no-info')) { - $this->verbosityLevel = OutputInterface::VERBOSITY_VERBOSE; - } - - if (!$this->hasConfig()) { - $this->loadConfig($input, $output); - } - - $this->loadManager($input, $output); - - $bootstrap = $this->getConfig()->getBootstrapFile(); - if ($bootstrap) { - $output->writeln('using bootstrap ' . Util::relativePath($bootstrap) . ' ', $this->verbosityLevel); - Util::loadPhpFile($bootstrap, $input, $output, $this); - } - - // report the paths - $paths = $this->getConfig()->getMigrationPaths(); - - $output->writeln('using migration paths ', $this->verbosityLevel); - - foreach (Util::globAll($paths) as $path) { - $output->writeln(' - ' . realpath($path) . '', $this->verbosityLevel); - } - - try { - $paths = $this->getConfig()->getSeedPaths(); - - $output->writeln('using seed paths ', $this->verbosityLevel); - - foreach (Util::globAll($paths) as $path) { - $output->writeln(' - ' . realpath($path) . '', $this->verbosityLevel); - } - } catch (UnexpectedValueException $e) { - // do nothing as seeds are optional - } - } - - /** - * Sets the config. - * - * @param \Phinx\Config\ConfigInterface $config Config - * @return $this - */ - public function setConfig(ConfigInterface $config) - { - $this->config = $config; - - return $this; - } - - /** - * @return bool - */ - public function hasConfig(): bool - { - return $this->config !== null; - } - - /** - * Gets the config. - * - * @return \Phinx\Config\ConfigInterface - */ - public function getConfig(): ConfigInterface - { - if ($this->config === null) { - throw new RuntimeException('No config set yet'); - } - - return $this->config; - } - - /** - * Sets the database adapter. - * - * @param \Phinx\Db\Adapter\AdapterInterface $adapter Adapter - * @return $this - */ - public function setAdapter(AdapterInterface $adapter) - { - $this->adapter = $adapter; - - return $this; - } - - /** - * Gets the database adapter. - * - * @return \Phinx\Db\Adapter\AdapterInterface - */ - public function getAdapter(): AdapterInterface - { - return $this->adapter; - } - - /** - * Sets the migration manager. - * - * @param \Phinx\Migration\Manager $manager Manager - * @return $this - */ - public function setManager(Manager $manager) - { - $this->manager = $manager; - - return $this; - } - - /** - * Gets the migration manager. - * - * @return \Phinx\Migration\Manager|null - */ - public function getManager(): ?Manager - { - return $this->manager ?? null; - } - - /** - * Returns config file path - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @return string - */ - protected function locateConfigFile(InputInterface $input): string - { - $configFile = $input->hasOption('configuration') ? $input->getOption('configuration') : null; - - $useDefault = false; - - if ($configFile === null || $configFile === false) { - $useDefault = true; - } - - $cwd = getcwd(); - - // locate the phinx config file - // In future walk the tree in reverse (max 10 levels) - $locator = new FileLocator([ - $cwd . DIRECTORY_SEPARATOR, - ]); - - if (!$useDefault) { - // Locate() throws an exception if the file does not exist - return $locator->locate($configFile, $cwd, true); - } - - $possibleConfigFiles = ['phinx.php', 'phinx.json', 'phinx.yaml', 'phinx.yml']; - foreach ($possibleConfigFiles as $configFile) { - try { - return $locator->locate($configFile, $cwd, true); - } catch (InvalidArgumentException $exception) { - $lastException = $exception; - } - } - throw $lastException; - } - - /** - * Parse the config file and load it into the config object - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @throws \InvalidArgumentException - * @return void - */ - protected function loadConfig(InputInterface $input, OutputInterface $output): void - { - $configFilePath = $this->locateConfigFile($input); - $output->writeln('using config file ' . Util::relativePath($configFilePath), $this->verbosityLevel); - - /** @var string|null $parser */ - $parser = $input->getOption('parser'); - - // If no parser is specified try to determine the correct one from the file extension. Defaults to YAML - if ($parser === null) { - $extension = pathinfo($configFilePath, PATHINFO_EXTENSION); - - switch (strtolower($extension)) { - case self::FORMAT_JSON: - $parser = self::FORMAT_JSON; - break; - case self::FORMAT_YML_ALIAS: - case self::FORMAT_YML: - $parser = self::FORMAT_YML; - break; - case self::FORMAT_PHP: - default: - $parser = self::FORMAT_DEFAULT; - break; - } - } - - switch (strtolower($parser)) { - case self::FORMAT_JSON: - $config = Config::fromJson($configFilePath); - break; - case self::FORMAT_PHP: - $config = Config::fromPhp($configFilePath); - break; - case self::FORMAT_YML_ALIAS: - case self::FORMAT_YML: - $config = Config::fromYaml($configFilePath); - break; - default: - throw new InvalidArgumentException(sprintf('\'%s\' is not a valid parser.', $parser)); - } - - $output->writeln('using config parser ' . $parser, $this->verbosityLevel); - - $this->setConfig($config); - } - - /** - * Load the migrations manager and inject the config - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return void - */ - protected function loadManager(InputInterface $input, OutputInterface $output): void - { - if (!isset($this->manager)) { - $manager = new Manager($this->getConfig(), $input, $output); - $manager->setVerbosityLevel($this->verbosityLevel); - $container = $this->getConfig()->getContainer(); - if ($container !== null) { - $manager->setContainer($container); - } - $this->setManager($manager); - } else { - $manager = $this->getManager(); - $manager->setInput($input); - $manager->setOutput($output); - } - } - - /** - * Verify that the migration directory exists and is writable. - * - * @param string $path Path - * @throws \InvalidArgumentException - * @return void - */ - protected function verifyMigrationDirectory(string $path): void - { - if (!is_dir($path)) { - throw new InvalidArgumentException(sprintf( - 'Migration directory "%s" does not exist', - $path, - )); - } - - if (!is_writable($path)) { - throw new InvalidArgumentException(sprintf( - 'Migration directory "%s" is not writable', - $path, - )); - } - } - - /** - * Verify that the seed directory exists and is writable. - * - * @param string $path Path - * @throws \InvalidArgumentException - * @return void - */ - protected function verifySeedDirectory(string $path): void - { - if (!is_dir($path)) { - throw new InvalidArgumentException(sprintf( - 'Seed directory "%s" does not exist', - $path, - )); - } - - if (!is_writable($path)) { - throw new InvalidArgumentException(sprintf( - 'Seed directory "%s" is not writable', - $path, - )); - } - } - - /** - * Returns the migration template filename. - * - * @return string - */ - protected function getMigrationTemplateFilename(string $style): string - { - return $style === Config::TEMPLATE_STYLE_CHANGE ? __DIR__ . self::DEFAULT_CHANGE_MIGRATION_TEMPLATE : __DIR__ . self::DEFAULT_UP_DOWN_MIGRATION_TEMPLATE; - } - - /** - * Returns the seed template filename. - * - * @return string - */ - protected function getSeedTemplateFilename(): string - { - return __DIR__ . self::DEFAULT_SEED_TEMPLATE; - } - - /** - * Write out environment information to the OutputInterface - */ - protected function writeEnvironmentOutput(?string &$environment, OutputInterface $output): bool - { - if ($environment === null) { - $environment = $this->getConfig()->getDefaultEnvironment(); - $output->writeln('warning no environment specified, defaulting to: ' . $environment, $this->verbosityLevel); - } else { - $output->writeln('using environment ' . $environment, $this->verbosityLevel); - } - - if (!$this->getConfig()->hasEnvironment($environment)) { - self::getErrorOutput($output)->writeln(sprintf('The environment "%s" does not exist', $environment)); - - return false; - } - - return true; - } - - /** - * Write out options information to the OutputInterface - */ - protected function writeInformationOutput(?string &$environment, OutputInterface $output): bool - { - $success = $this->writeEnvironmentOutput($environment, $output); - if (!$success) { - return false; - } - - $envOptions = $this->getConfig()->getEnvironment($environment); - if (isset($envOptions['adapter'])) { - $output->writeln('using adapter ' . $envOptions['adapter'], $this->verbosityLevel); - } - - if (isset($envOptions['wrapper'])) { - $output->writeln('using wrapper ' . $envOptions['wrapper'], $this->verbosityLevel); - } - - if (isset($envOptions['name'])) { - $name = $envOptions['name']; - // We do error handling for missing adapter or connection is invalid later on running a command - $adapter = $envOptions['adapter'] ?? null; - if (isset($envOptions['connection']) && $envOptions['connection'] instanceof PDO) { - $adapter = $envOptions['connection']->getAttribute(PDO::ATTR_DRIVER_NAME); - } - if ($adapter === 'sqlite') { - $name .= SQLiteAdapter::getSuffix($envOptions); - } - $output->writeln('using database ' . $name, $this->verbosityLevel); - } else { - self::getErrorOutput($output)->writeln('Could not determine database name! Please specify a database name in your config file.'); - - return false; - } - - if (isset($envOptions['table_prefix'])) { - $output->writeln('using table prefix ' . $envOptions['table_prefix'], $this->verbosityLevel); - } - if (isset($envOptions['table_suffix'])) { - $output->writeln('using table suffix ' . $envOptions['table_suffix'], $this->verbosityLevel); - } - - return true; - } - - /** - * Returns the error output to use - * - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return \Symfony\Component\Console\Output\OutputInterface - */ - protected static function getErrorOutput(OutputInterface $output): OutputInterface - { - return $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Breakpoint.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Breakpoint.php deleted file mode 100644 index caf0f7656..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Breakpoint.php +++ /dev/null @@ -1,103 +0,0 @@ -addOption('--environment', '-e', InputOption::VALUE_REQUIRED, 'The target environment.'); - - $this->setDescription('Manage breakpoints') - ->addOption('--target', '-t', InputOption::VALUE_REQUIRED, 'The version number to target for the breakpoint') - ->addOption('--set', '-s', InputOption::VALUE_NONE, 'Set the breakpoint') - ->addOption('--unset', '-u', InputOption::VALUE_NONE, 'Unset the breakpoint') - ->addOption('--remove-all', '-r', InputOption::VALUE_NONE, 'Remove all breakpoints') - ->setHelp( - <<breakpoint command allows you to toggle, set, or unset a breakpoint against a specific target to inhibit rollbacks beyond a certain target. -If no target is supplied then the most recent migration will be used. -You cannot specify un-migrated targets - -phinx breakpoint -e development -phinx breakpoint -e development -t 20110103081132 -phinx breakpoint -e development -r -EOT, - ); - } - - /** - * Toggle the breakpoint. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @throws \InvalidArgumentException - * @return int integer 0 on success, or an error code. - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - /** @var string|null $environment */ - $environment = $input->getOption('environment'); - $version = (int)$input->getOption('target') ?: null; - $removeAll = $input->getOption('remove-all'); - $set = $input->getOption('set'); - $unset = $input->getOption('unset'); - - $success = $this->writeEnvironmentOutput($environment, $output); - if (!$success) { - return self::CODE_ERROR; - } - - if ($version && $removeAll) { - throw new InvalidArgumentException('Cannot toggle a breakpoint and remove all breakpoints at the same time.'); - } - - if (($set && $unset) || ($set && $removeAll) || ($unset && $removeAll)) { - throw new InvalidArgumentException('Cannot use more than one of --set, --unset, or --remove-all at the same time.'); - } - - if ($removeAll) { - // Remove all breakpoints. - $this->getManager()->removeBreakpoints($environment); - } elseif ($set) { - // Set the breakpoint. - $this->getManager()->setBreakpoint($environment, $version); - } elseif ($unset) { - // Unset the breakpoint. - $this->getManager()->unsetBreakpoint($environment, $version); - } else { - // Toggle the breakpoint. - $this->getManager()->toggleBreakpoint($environment, $version); - } - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Create.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Create.php deleted file mode 100644 index c28253115..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Create.php +++ /dev/null @@ -1,348 +0,0 @@ -setDescription('Create a new migration') - ->addArgument('name', InputArgument::OPTIONAL, 'Class name of the migration (in CamelCase)') - ->setHelp(sprintf( - '%sCreates a new database migration%s', - PHP_EOL, - PHP_EOL, - )); - - // An alternative template. - $this->addOption('template', 't', InputOption::VALUE_REQUIRED, 'Use an alternative template'); - - // A classname to be used to gain access to the template content as well as the ability to - // have a callback once the migration file has been created. - $this->addOption('class', 'l', InputOption::VALUE_REQUIRED, 'Use a class implementing "' . self::CREATION_INTERFACE . '" to generate the template'); - - // Allow the migration path to be chosen non-interactively. - $this->addOption('path', null, InputOption::VALUE_REQUIRED, 'Specify the path in which to create this migration'); - - $this->addOption('style', null, InputOption::VALUE_REQUIRED, 'Specify the style of migration to create'); - } - - /** - * Get the confirmation question asking if the user wants to create the - * migrations directory. - * - * @return \Symfony\Component\Console\Question\ConfirmationQuestion - */ - protected function getCreateMigrationDirectoryQuestion(): ConfirmationQuestion - { - return new ConfirmationQuestion('Create migrations directory? [y]/n ', true); - } - - /** - * Get the question that allows the user to select which migration path to use. - * - * @param string[] $paths Paths - * @return \Symfony\Component\Console\Question\ChoiceQuestion - */ - protected function getSelectMigrationPathQuestion(array $paths): ChoiceQuestion - { - return new ChoiceQuestion('Which migrations path would you like to use?', $paths, 0); - } - - /** - * Returns the migration path to create the migration in. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @throws \Exception - * @return string - */ - protected function getMigrationPath(InputInterface $input, OutputInterface $output): string - { - // First, try the non-interactive option: - $path = $input->getOption('path'); - - if (!empty($path)) { - return $path; - } - - $paths = $this->getConfig()->getMigrationPaths(); - - // No paths? That's a problem. - if (empty($paths)) { - throw new Exception('No migration paths set in your Phinx configuration file.'); - } - - $paths = Util::globAll($paths); - - if (empty($paths)) { - throw new Exception( - 'You probably used curly braces to define migration path in your Phinx configuration file, ' . - 'but no directories have been matched using this pattern. ' . - 'You need to create a migration directory manually.', - ); - } - - // Only one path set, so select that: - if (count($paths) === 1) { - return array_shift($paths); - } - - /** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */ - $helper = $this->getHelper('question'); - $question = $this->getSelectMigrationPathQuestion($paths); - - return $helper->ask($input, $output, $question); - } - - /** - * Create the new migration. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @throws \RuntimeException - * @throws \InvalidArgumentException - * @return int 0 on success - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - // get the migration path from the config - $path = $this->getMigrationPath($input, $output); - - if (!file_exists($path)) { - /** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */ - $helper = $this->getHelper('question'); - $question = $this->getCreateMigrationDirectoryQuestion(); - - if ($helper->ask($input, $output, $question)) { - mkdir($path, 0755, true); - } - } - - $this->verifyMigrationDirectory($path); - - $config = $this->getConfig(); - $namespace = $config instanceof NamespaceAwareInterface ? $config->getMigrationNamespaceByPath($path) : null; - - $path = realpath($path); - $className = $input->getArgument('name'); - if ($className !== null && in_array(strtolower($className), $this->keywords)) { - throw new InvalidArgumentException(sprintf( - 'The migration class name "%s" is a reserved PHP keyword. Please choose a different class name.', - $className, - )); - } - - $offset = 0; - do { - $timestamp = Util::getCurrentTimestamp($offset++); - } while (!Util::isUniqueTimestamp($path, $timestamp)); - - if ($className === null) { - $className = 'V' . $timestamp; - $fileName = ''; - } else { - if (!Util::isValidPhinxClassName($className)) { - throw new InvalidArgumentException(sprintf( - 'The migration class name "%s" is invalid. Please use CamelCase format.', - $className, - )); - } - - $fileName = Util::toSnakeCase($className); - } - $fileName = $timestamp . $fileName . '.php'; - - if (!Util::isUniqueMigrationClassName($className, $path)) { - throw new InvalidArgumentException(sprintf( - 'The migration class name "%s%s" already exists', - $namespace ? $namespace . '\\' : '', - $className, - )); - } - - $filePath = $path . DIRECTORY_SEPARATOR . $fileName; - - if (is_file($filePath)) { - throw new InvalidArgumentException(sprintf( - 'The file "%s" already exists', - $filePath, - )); - } - - // Get the alternative template and static class options from the config, but only allow one of them. - $defaultAltTemplate = $this->getConfig()->getTemplateFile(); - $defaultCreationClassName = $this->getConfig()->getTemplateClass(); - $defaultStyle = $this->getConfig()->getTemplateStyle(); - if ($defaultAltTemplate && $defaultCreationClassName) { - throw new InvalidArgumentException('Cannot define template:class and template:file at the same time'); - } - - // Get the alternative template and static class options from the command line, but only allow one of them. - /** @var string|null $altTemplate */ - $altTemplate = $input->getOption('template'); - /** @var string|null $creationClassName */ - $creationClassName = $input->getOption('class'); - $style = $input->getOption('style'); - - if ($altTemplate && $creationClassName) { - throw new InvalidArgumentException('Cannot use --template and --class at the same time'); - } - - if ($style && !in_array($style, [Config::TEMPLATE_STYLE_CHANGE, Config::TEMPLATE_STYLE_UP_DOWN])) { - throw new InvalidArgumentException('--style should be one of ' . Config::TEMPLATE_STYLE_CHANGE . ' or ' . Config::TEMPLATE_STYLE_UP_DOWN); - } - - // If no commandline options then use the defaults. - if (!$altTemplate && !$creationClassName) { - $altTemplate = $defaultAltTemplate; - $creationClassName = $defaultCreationClassName; - } - - // Verify the alternative template file's existence. - if ($altTemplate && !is_file($altTemplate)) { - throw new InvalidArgumentException(sprintf( - 'The alternative template file "%s" does not exist', - $altTemplate, - )); - } - - // Verify that the template creation class (or the aliased class) exists and that it implements the required interface. - $aliasedClassName = null; - if ($creationClassName) { - // Supplied class does not exist, is it aliased? - if (!class_exists($creationClassName)) { - $aliasedClassName = $this->getConfig()->getAlias($creationClassName); - if ($aliasedClassName && !class_exists($aliasedClassName)) { - throw new InvalidArgumentException(sprintf( - 'The class "%s" via the alias "%s" does not exist', - $aliasedClassName, - $creationClassName, - )); - } elseif (!$aliasedClassName) { - throw new InvalidArgumentException(sprintf( - 'The class "%s" does not exist', - $creationClassName, - )); - } - } - - // Does the class implement the required interface? - if (!$aliasedClassName && !is_subclass_of($creationClassName, self::CREATION_INTERFACE)) { - throw new InvalidArgumentException(sprintf( - 'The class "%s" does not implement the required interface "%s"', - $creationClassName, - self::CREATION_INTERFACE, - )); - } elseif ($aliasedClassName && !is_subclass_of($aliasedClassName, self::CREATION_INTERFACE)) { - throw new InvalidArgumentException(sprintf( - 'The class "%s" via the alias "%s" does not implement the required interface "%s"', - $aliasedClassName, - $creationClassName, - self::CREATION_INTERFACE, - )); - } - } - - // Use the aliased class. - $creationClassName = $aliasedClassName ?: $creationClassName; - - // Determine the appropriate mechanism to get the template - if ($creationClassName) { - // Get the template from the creation class - $creationClass = new $creationClassName($input, $output); - $contents = $creationClass->getMigrationTemplate(); - } else { - // Load the alternative template if it is defined. - $contents = file_get_contents($altTemplate ?: $this->getMigrationTemplateFilename($style ?: $defaultStyle)); - } - - // inject the class names appropriate to this migration - $classes = [ - '$namespaceDefinition' => $namespace !== null ? (PHP_EOL . 'namespace ' . $namespace . ';' . PHP_EOL) : '', - '$namespace' => $namespace, - '$useClassName' => $this->getConfig()->getMigrationBaseClassName(false), - '$className' => $className, - '$version' => Util::getVersionFromFileName($fileName), - '$baseClassName' => $this->getConfig()->getMigrationBaseClassName(true), - ]; - $contents = strtr($contents, $classes); - - if (file_put_contents($filePath, $contents) === false) { - throw new RuntimeException(sprintf( - 'The file "%s" could not be written to', - $path, - )); - } - - // Do we need to do the post creation call to the creation class? - if (isset($creationClass)) { - /** @var \Phinx\Migration\CreationInterface $creationClass */ - $creationClass->postMigrationCreation($filePath, $className, $this->getConfig()->getMigrationBaseClassName()); - } - - $output->writeln('using migration base class ' . $classes['$useClassName'], $this->verbosityLevel); - - if (!empty($altTemplate)) { - $output->writeln('using alternative template ' . $altTemplate, $this->verbosityLevel); - } elseif (!empty($creationClassName)) { - $output->writeln('using template creation class ' . $creationClassName, $this->verbosityLevel); - } else { - $output->writeln('using default template', $this->verbosityLevel); - } - - $output->writeln('created ' . Util::relativePath($filePath), $this->verbosityLevel); - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Init.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Init.php deleted file mode 100644 index 3b634f72d..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Init.php +++ /dev/null @@ -1,173 +0,0 @@ -setDescription('Initialize the application for Phinx') - ->addOption( - '--format', - '-f', - InputArgument::OPTIONAL, - 'What format should we use to initialize?', - AbstractCommand::FORMAT_DEFAULT, - ) - ->addArgument('path', InputArgument::OPTIONAL, 'Which path should we initialize for Phinx?') - ->setHelp(sprintf( - '%sInitializes the application for Phinx%s', - PHP_EOL, - PHP_EOL, - )); - } - - /** - * Initializes the application. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Interface implemented by all input classes. - * @param \Symfony\Component\Console\Output\OutputInterface $output Interface implemented by all output classes. - * @return int 0 on success - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $format = strtolower($input->getOption('format')); - $path = $this->resolvePath($input, $format); - $this->writeConfig($path, $format); - - $output->writeln("created {$path}"); - - return AbstractCommand::CODE_SUCCESS; - } - - /** - * Return valid $path for Phinx's config file. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Interface implemented by all input classes. - * @param string $format Format to resolve for - * @throws \InvalidArgumentException - * @return string - */ - protected function resolvePath(InputInterface $input, string $format): string - { - // get the migration path from the config - $path = (string)$input->getArgument('path'); - - if (!in_array($format, static::$supportedFormats, true)) { - throw new InvalidArgumentException(sprintf( - 'Invalid format "%s". Format must be either ' . implode(', ', static::$supportedFormats) . '.', - $format, - )); - } - - // Fallback - if (!$path) { - $path = getcwd() . DIRECTORY_SEPARATOR . self::FILE_NAME . '.' . $format; - } - - // Adding file name if necessary - if (is_dir($path)) { - $path .= DIRECTORY_SEPARATOR . self::FILE_NAME . '.' . $format; - } - - // Check if path is available - $dirname = dirname($path); - if (is_dir($dirname) && !is_file($path)) { - return $path; - } - - // Path is valid, but file already exists - if (is_file($path)) { - throw new InvalidArgumentException(sprintf( - 'Config file "%s" already exists.', - $path, - )); - } - - // Dir is invalid - throw new InvalidArgumentException(sprintf( - 'Invalid path "%s" for config file.', - $path, - )); - } - - /** - * Writes Phinx's config in provided $path - * - * @param string $path Config file's path. - * @param string $format Format to use for config file - * @throws \InvalidArgumentException - * @throws \RuntimeException - * @return void - */ - protected function writeConfig(string $path, string $format = AbstractCommand::FORMAT_DEFAULT): void - { - // Check if dir is writable - $dirname = dirname($path); - if (!is_writable($dirname)) { - throw new InvalidArgumentException(sprintf( - 'The directory "%s" is not writable', - $dirname, - )); - } - - if ($format === AbstractCommand::FORMAT_YML_ALIAS) { - $format = AbstractCommand::FORMAT_YML; - } - - // load the config template - if (is_dir(__DIR__ . '/../../../../data')) { - $contents = file_get_contents(__DIR__ . '/../../../../data/' . self::FILE_NAME . '.' . $format . '.dist'); - } else { - throw new RuntimeException(sprintf( - 'Could not find template for format "%s".', - $format, - )); - } - - if (file_put_contents($path, $contents) === false) { - throw new RuntimeException(sprintf( - 'The file "%s" could not be written to', - $path, - )); - } - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/ListAliases.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/ListAliases.php deleted file mode 100644 index f7b757db9..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/ListAliases.php +++ /dev/null @@ -1,82 +0,0 @@ -setDescription('List template class aliases') - ->setHelp('The list:aliases command lists the migration template generation class aliases'); - } - - /** - * List migration template creation aliases. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return int 0 on success - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - $aliases = $this->config->getAliases(); - - if ($aliases) { - $maxAliasLength = max(array_map('strlen', array_keys($aliases))); - $maxClassLength = max(array_map('strlen', $aliases)); - $output->writeln( - array_merge( - [ - '', - sprintf('%s %s', str_pad('Alias', $maxAliasLength), str_pad('Class', $maxClassLength)), - sprintf('%s %s', str_repeat('=', $maxAliasLength), str_repeat('=', $maxClassLength)), - ], - array_map( - function ($alias, $class) use ($maxAliasLength, $maxClassLength) { - return sprintf('%s %s', str_pad($alias, $maxAliasLength), str_pad($class, $maxClassLength)); - }, - array_keys($aliases), - $aliases, - ), - ), - $this->verbosityLevel, - ); - } else { - $output->writeln( - 'warning no aliases defined in ' . Util::relativePath( - $this->config->getConfigFilePath(), - ), - $this->verbosityLevel, - ); - } - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Migrate.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Migrate.php deleted file mode 100644 index a8c9c501d..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Migrate.php +++ /dev/null @@ -1,110 +0,0 @@ -addOption('--environment', '-e', InputOption::VALUE_REQUIRED, 'The target environment'); - - $this->setDescription('Migrate the database') - ->addOption('--target', '-t', InputOption::VALUE_REQUIRED, 'The version number to migrate to') - ->addOption('--date', '-d', InputOption::VALUE_REQUIRED, 'The date to migrate to') - ->addOption('--count', '-k', InputOption::VALUE_REQUIRED, 'The number of migrations to run') - ->addOption('--dry-run', '-x', InputOption::VALUE_NONE, 'Dump query to standard output instead of executing it') - ->addOption('--fake', null, InputOption::VALUE_NONE, "Mark any migrations selected as run, but don't actually execute them") - ->setHelp( - <<migrate command runs all available migrations, optionally up to a specific version, date, or count. - -phinx migrate -e development -phinx migrate -e development -t 20110103081132 -phinx migrate -e development -d 20110103 -phinx migrate -e development -k 5 -phinx migrate -e development -v - -EOT, - ); - } - - /** - * Migrate the database. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return int integer 0 on success, or an error code. - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - $version = $input->getOption('target') !== null ? (int)$input->getOption('target') : null; - /** @var string|null $environment */ - $environment = $input->getOption('environment'); - $date = $input->getOption('date'); - $count = $input->getOption('count') !== null ? (int)$input->getOption('count') : null; - $fake = (bool)$input->getOption('fake'); - - $success = $this->writeInformationOutput($environment, $output); - if (!$success) { - return self::CODE_ERROR; - } - - $versionOrder = $this->getConfig()->getVersionOrder(); - $output->writeln('ordering by ' . $versionOrder . ' time', $this->verbosityLevel); - - if ($fake) { - $output->writeln('warning performing fake migrations', $this->verbosityLevel); - } - - try { - // run the migrations - $start = microtime(true); - if ($count !== null) { - $this->getManager()->migrateToCount($environment, $count, $fake); - } elseif ($date !== null) { - $this->getManager()->migrateToDateTime($environment, new DateTime($date), $fake); - } else { - $this->getManager()->migrate($environment, $version, $fake); - } - $end = microtime(true); - } catch (Throwable $e) { - self::getErrorOutput($output)->writeln('' . $e->__toString() . ''); - - return self::CODE_ERROR; - } - - $output->writeln('', $this->verbosityLevel); - $output->writeln('All Done. Took ' . sprintf('%.4fs', $end - $start) . '', $this->verbosityLevel); - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Rollback.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Rollback.php deleted file mode 100644 index ff78f04a9..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Rollback.php +++ /dev/null @@ -1,150 +0,0 @@ -addOption('--environment', '-e', InputOption::VALUE_REQUIRED, 'The target environment'); - - $this->setDescription('Rollback the last or to a specific migration') - ->addOption('--target', '-t', InputOption::VALUE_REQUIRED, 'The version number to rollback to') - ->addOption('--date', '-d', InputOption::VALUE_REQUIRED, 'The date to rollback to') - ->addOption('--force', '-f', InputOption::VALUE_NONE, 'Force rollback to ignore breakpoints') - ->addOption('--dry-run', '-x', InputOption::VALUE_NONE, 'Dump query to standard output instead of executing it') - ->addOption('--fake', null, InputOption::VALUE_NONE, "Mark any rollbacks selected as run, but don't actually execute them") - ->setHelp( - <<rollback command reverts the last migration, or optionally up to a specific version - -phinx rollback -e development -phinx rollback -e development -t 20111018185412 -phinx rollback -e development -d 20111018 -phinx rollback -e development -v -phinx rollback -e development -t 20111018185412 -f - -If you have a breakpoint set, then you can rollback to target 0 and the rollbacks will stop at the breakpoint. -phinx rollback -e development -t 0 - -The version_order configuration option is used to determine the order of the migrations when rolling back. -This can be used to allow the rolling back of the last executed migration instead of the last created one, or combined -with the -d|--date option to rollback to a certain date using the migration start times to order them. - -EOT, - ); - } - - /** - * Rollback the migration. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return int integer 0 on success, or an error code. - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - $environment = $input->getOption('environment'); - $version = $input->getOption('target'); - $date = $input->getOption('date'); - $force = (bool)$input->getOption('force'); - $fake = (bool)$input->getOption('fake'); - - $success = $this->writeInformationOutput($environment, $output); - if (!$success) { - return self::CODE_ERROR; - } - - $versionOrder = $this->getConfig()->getVersionOrder(); - $output->writeln('ordering by ' . $versionOrder . ' time', $this->verbosityLevel); - - if ($fake) { - $output->writeln('warning performing fake rollbacks', $this->verbosityLevel); - } - - // rollback the specified environment - if ($date === null) { - $targetMustMatchVersion = true; - $target = $version; - } else { - $targetMustMatchVersion = false; - $target = $this->getTargetFromDate($date); - } - - $start = microtime(true); - $this->getManager()->rollback($environment, $target, $force, $targetMustMatchVersion, $fake); - $end = microtime(true); - - $output->writeln('', $this->verbosityLevel); - $output->writeln('All Done. Took ' . sprintf('%.4fs', $end - $start) . '', $this->verbosityLevel); - - return self::CODE_SUCCESS; - } - - /** - * Get Target from Date - * - * @param string $date The date to convert to a target. - * @throws \InvalidArgumentException - * @return string The target - */ - public function getTargetFromDate(string $date): string - { - if (!preg_match('/^\d{4,14}$/', $date)) { - throw new InvalidArgumentException('Invalid date. Format is YYYY[MM[DD[HH[II[SS]]]]].'); - } - - // what we need to append to the date according to the possible date string lengths - $dateStrlenToAppend = [ - 14 => '', - 12 => '00', - 10 => '0000', - 8 => '000000', - 6 => '01000000', - 4 => '0101000000', - ]; - - if (!isset($dateStrlenToAppend[strlen($date)])) { - throw new InvalidArgumentException('Invalid date. Format is YYYY[MM[DD[HH[II[SS]]]]].'); - } - - $target = $date . $dateStrlenToAppend[strlen($date)]; - - $dateTime = DateTime::createFromFormat('YmdHis', $target); - - if ($dateTime === false) { - throw new InvalidArgumentException('Invalid date. Format is YYYY[MM[DD[HH[II[SS]]]]].'); - } - - return $dateTime->format('YmdHis'); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/SeedCreate.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/SeedCreate.php deleted file mode 100644 index 3b0fe3bbe..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/SeedCreate.php +++ /dev/null @@ -1,221 +0,0 @@ -setDescription('Create a new database seeder') - ->addArgument('name', InputArgument::REQUIRED, 'What is the name of the seeder?') - ->addOption('path', null, InputOption::VALUE_REQUIRED, 'Specify the path in which to create this seeder') - ->setHelp(sprintf( - '%sCreates a new database seeder%s', - PHP_EOL, - PHP_EOL, - )); - - // An alternative template. - $this->addOption('template', 't', InputOption::VALUE_REQUIRED, 'Use an alternative template'); - } - - /** - * Get the confirmation question asking if the user wants to create the - * seeds directory. - * - * @return \Symfony\Component\Console\Question\ConfirmationQuestion - */ - protected function getCreateSeedDirectoryQuestion(): ConfirmationQuestion - { - return new ConfirmationQuestion('Create seeds directory? [y]/n ', true); - } - - /** - * Get the question that allows the user to select which seed path to use. - * - * @param string[] $paths Paths - * @return \Symfony\Component\Console\Question\ChoiceQuestion - */ - protected function getSelectSeedPathQuestion(array $paths): ChoiceQuestion - { - return new ChoiceQuestion('Which seeds path would you like to use?', $paths, 0); - } - - /** - * Returns the seed path to create the seeder in. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @throws \Exception - * @return string - */ - protected function getSeedPath(InputInterface $input, OutputInterface $output): string - { - // First, try the non-interactive option: - $path = $input->getOption('path'); - - if (!empty($path)) { - return $path; - } - - $paths = $this->getConfig()->getSeedPaths(); - - // No paths? That's a problem. - if (empty($paths)) { - throw new Exception('No seed paths set in your Phinx configuration file.'); - } - - $paths = Util::globAll($paths); - - if (empty($paths)) { - throw new Exception( - 'You probably used curly braces to define seed path in your Phinx configuration file, ' . - 'but no directories have been matched using this pattern. ' . - 'You need to create a seed directory manually.', - ); - } - - // Only one path set, so select that: - if (count($paths) === 1) { - return array_shift($paths); - } - - /** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */ - $helper = $this->getHelper('question'); - $question = $this->getSelectSeedPathQuestion($paths); - - return $helper->ask($input, $output, $question); - } - - /** - * Create the new seeder. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @throws \RuntimeException - * @throws \InvalidArgumentException - * @return int 0 on success - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - // get the seed path from the config - $path = $this->getSeedPath($input, $output); - - if (!file_exists($path)) { - /** @var \Symfony\Component\Console\Helper\QuestionHelper $helper */ - $helper = $this->getHelper('question'); - $question = $this->getCreateSeedDirectoryQuestion(); - - if ($helper->ask($input, $output, $question)) { - mkdir($path, 0755, true); - } - } - - $this->verifySeedDirectory($path); - - $path = realpath($path); - /** @var string|null $className */ - $className = $input->getArgument('name'); - - if (!Util::isValidPhinxClassName($className)) { - throw new InvalidArgumentException(sprintf( - 'The seed class name "%s" is invalid. Please use CamelCase format', - $className, - )); - } - - // Compute the file path - $filePath = $path . DIRECTORY_SEPARATOR . $className . '.php'; - - if (is_file($filePath)) { - throw new InvalidArgumentException(sprintf( - 'The file "%s" already exists', - basename($filePath), - )); - } - - // Get the alternative template option from the command line. - $altTemplate = $input->getOption('template'); - - // Verify the alternative template file's existence. - if ($altTemplate && !is_file($altTemplate)) { - throw new InvalidArgumentException(sprintf( - 'The template file "%s" does not exist', - $altTemplate, - )); - } - - // Command-line option must have higher priority than value from Config - $config = $this->getConfig(); - if (is_null($altTemplate)) { - $altTemplate = $config->getSeedTemplateFile(); - if (!is_null($altTemplate) && !is_file($altTemplate)) { - throw new InvalidArgumentException(sprintf( - 'The template file `%s` from config does not exist', - $altTemplate, - )); - } - } - - // Determine the appropriate mechanism to get the template - // Load the alternative template if it is defined. - $contents = file_get_contents($altTemplate ?: $this->getSeedTemplateFilename()); - - $namespace = $config instanceof NamespaceAwareInterface ? $config->getSeedNamespaceByPath($path) : null; - $classes = [ - '$namespaceDefinition' => $namespace !== null ? (PHP_EOL . 'namespace ' . $namespace . ';' . PHP_EOL) : '', - '$namespace' => $namespace, - '$useClassName' => $config->getSeedBaseClassName(false), - '$className' => $className, - '$baseClassName' => $config->getSeedBaseClassName(true), - ]; - $contents = strtr($contents, $classes); - - if (file_put_contents($filePath, $contents) === false) { - throw new RuntimeException(sprintf( - 'The file "%s" could not be written to', - $path, - )); - } - - $output->writeln('using seed base class ' . $classes['$useClassName'], $this->verbosityLevel); - $output->writeln('created ' . Util::relativePath($filePath), $this->verbosityLevel); - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/SeedRun.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/SeedRun.php deleted file mode 100644 index 343221152..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/SeedRun.php +++ /dev/null @@ -1,92 +0,0 @@ -addOption('--environment', '-e', InputOption::VALUE_REQUIRED, 'The target environment'); - - $this->setDescription('Run database seeders') - ->addOption('--seed', '-s', InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY, 'What is the name of the seeder?') - ->addOption('--dry-run', '-x', InputOption::VALUE_NONE, 'Dump query to standard output instead of executing it') - ->setHelp( - <<seed:run command runs all available or individual seeders - -phinx seed:run -e development -phinx seed:run -e development -s UserSeeder -phinx seed:run -e development -s UserSeeder -s PermissionSeeder -s LogSeeder -phinx seed:run -e development -v - -EOT, - ); - } - - /** - * Run database seeders. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return int integer 0 on success, or an error code. - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - /** @var array|null $seedSet */ - $seedSet = $input->getOption('seed'); - /** @var string|null $environment */ - $environment = $input->getOption('environment'); - - $success = $this->writeInformationOutput($environment, $output); - if (!$success) { - return self::CODE_ERROR; - } - - $start = microtime(true); - - if (empty($seedSet)) { - // run all the seed(ers) - $this->getManager()->seed($environment); - } else { - // run seed(ers) specified in a comma-separated list of classes - foreach ($seedSet as $seed) { - $this->getManager()->seed($environment, trim($seed)); - } - } - - $end = microtime(true); - - $output->writeln('', $this->verbosityLevel); - $output->writeln('All Done. Took ' . sprintf('%.4fs', $end - $start) . '', $this->verbosityLevel); - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Status.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Status.php deleted file mode 100644 index ca09eb457..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Status.php +++ /dev/null @@ -1,88 +0,0 @@ -addOption('--environment', '-e', InputOption::VALUE_REQUIRED, 'The target environment.'); - - $this->setDescription('Show migration status') - ->addOption('--format', '-f', InputOption::VALUE_REQUIRED, 'The output format: text or json. Defaults to text.') - ->setHelp( - <<status command prints a list of all migrations, along with their current status - -phinx status -e development -phinx status -e development -f json - -The version_order configuration option is used to determine the order of the status migrations. -EOT, - ); - } - - /** - * Show the migration status. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return int 0 if all migrations are up, or an error code - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - $this->bootstrap($input, $output); - - /** @var string|null $environment */ - $environment = $input->getOption('environment'); - /** @var string|null $environment */ - $format = $input->getOption('format'); - - $success = $this->writeEnvironmentOutput($environment, $output); - if (!$success) { - return self::CODE_ERROR; - } - - if ($format !== null) { - $output->writeln('using format ' . $format, $this->verbosityLevel); - } - - $output->writeln('ordering by ' . $this->getConfig()->getVersionOrder() . ' time', $this->verbosityLevel); - - // print the status - $result = $this->getManager()->printStatus($environment, $format); - - if ($result['hasMissingMigration']) { - return self::CODE_STATUS_MISSING; - } elseif ($result['hasDownMigration']) { - return self::CODE_STATUS_DOWN; - } - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Test.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Test.php deleted file mode 100644 index 7391add3e..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/Command/Test.php +++ /dev/null @@ -1,102 +0,0 @@ -addOption('--environment', '-e', InputOption::VALUE_REQUIRED, 'The target environment'); - - $this->setDescription('Verify the configuration file') - ->setHelp( - <<test command is used to verify the phinx configuration file and optionally an environment - -phinx test -phinx test -e development - -If the environment option is set, it will test that phinx can connect to the DB associated with that environment -EOT, - ); - } - - /** - * Verify configuration file - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @throws \InvalidArgumentException - * @return int 0 on success - */ - protected function execute(InputInterface $input, OutputInterface $output): int - { - if (!$this->hasConfig()) { - $this->loadConfig($input, $output); - } - - $this->loadManager($input, $output); - - // Verify the migrations path(s) - array_map( - [$this, 'verifyMigrationDirectory'], - Util::globAll($this->getConfig()->getMigrationPaths()), - ); - - // Verify the seed path(s) - array_map( - [$this, 'verifySeedDirectory'], - Util::globAll($this->getConfig()->getSeedPaths()), - ); - - $envName = $input->getOption('environment'); - if ($envName) { - if (!$this->getConfig()->hasEnvironment($envName)) { - throw new InvalidArgumentException(sprintf( - 'The environment "%s" does not exist', - $envName, - )); - } - - $output->writeln(sprintf('validating environment %s', $envName), $this->verbosityLevel); - $environment = new Environment( - $envName, - $this->getConfig()->getEnvironment($envName), - ); - // validate environment connection - $environment->getAdapter()->connect(); - } - - $output->writeln('success!', $this->verbosityLevel); - - return self::CODE_SUCCESS; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Console/PhinxApplication.php b/app/vendor/robmorgan/phinx/src/Phinx/Console/PhinxApplication.php deleted file mode 100644 index ca71911bb..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Console/PhinxApplication.php +++ /dev/null @@ -1,103 +0,0 @@ -getVersion()); - - $this->addCommands([ - new Init(), - new Create(), - new Migrate(), - new Rollback(), - new Status(), - new Breakpoint(), - new Test(), - new SeedCreate(), - new SeedRun(), - new ListAliases(), - ]); - } - - /** - * Runs the current application. - * - * @param \Symfony\Component\Console\Input\InputInterface $input An Input instance - * @param \Symfony\Component\Console\Output\OutputInterface $output An Output instance - * @return int 0 if everything went fine, or an error code - */ - public function doRun(InputInterface $input, OutputInterface $output): int - { - // always show the version information except when the user invokes the help - // command as that already does it - if ($input->hasParameterOption('--no-info') === false) { - if (($input->hasParameterOption(['--help', '-h']) !== false) || ($input->getFirstArgument() !== null && $input->getFirstArgument() !== 'list')) { - $output->writeln($this->getLongVersion()); - $output->writeln(''); - } - } - - return parent::doRun($input, $output); - } - - /** - * Get the current application version. - * - * @return string The application version if it could be found, otherwise 'UNKNOWN' - */ - public function getVersion(): string - { - if (isset($this->version)) { - return $this->version; - } - - // humbug/box will replace this with actual version when building - // so use that if available - $gitTag = '@git_tag@'; - if (!str_starts_with($gitTag, '@')) { - return $this->version = $gitTag; - } - - // Otherwise fallback to the version as reported by composer - if (class_exists(InstalledVersions::class)) { - return $this->version = InstalledVersions::getPrettyVersion('robmorgan/phinx') ?? 'UNKNOWN'; - } - - return $this->version = 'UNKNOWN'; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/Action.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/Action.php deleted file mode 100644 index f8263c48d..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/Action.php +++ /dev/null @@ -1,39 +0,0 @@ -table = $table; - } - - /** - * The table this action will be applied to - * - * @return \Phinx\Db\Table\Table - */ - public function getTable(): Table - { - return $this->table; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddColumn.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddColumn.php deleted file mode 100644 index a4c09152f..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddColumn.php +++ /dev/null @@ -1,64 +0,0 @@ -column = $column; - } - - /** - * Returns a new AddColumn object after assembling the given commands - * - * @param \Phinx\Db\Table\Table $table The table to add the column to - * @param string $columnName The column name - * @param string|\Phinx\Util\Literal $type The column type - * @param array $options The column options - * @return static - */ - public static function build(Table $table, string $columnName, string|Literal $type, array $options = []): static - { - $column = new Column(); - $column->setName($columnName); - $column->setType($type); - $column->setOptions($options); // map options to column methods - - return new static($table, $column); - } - - /** - * Returns the column to be added - * - * @return \Phinx\Db\Table\Column - */ - public function getColumn(): Column - { - return $this->column; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddForeignKey.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddForeignKey.php deleted file mode 100644 index 1468539cd..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddForeignKey.php +++ /dev/null @@ -1,79 +0,0 @@ -foreignKey = $fk; - } - - /** - * Creates a new AddForeignKey object after building the foreign key with - * the passed attributes - * - * @param \Phinx\Db\Table\Table $table The table object to add the foreign key to - * @param string|string[] $columns The columns for the foreign key - * @param \Phinx\Db\Table\Table|string $referencedTable The table the foreign key references - * @param string|string[] $referencedColumns The columns in the referenced table - * @param array $options Extra options for the foreign key - * @param string|null $name The name of the foreign key - * @return static - */ - public static function build(Table $table, string|array $columns, Table|string $referencedTable, string|array $referencedColumns = ['id'], array $options = [], ?string $name = null): static - { - if (is_string($referencedColumns)) { - $referencedColumns = [$referencedColumns]; // str to array - } - - if (is_string($referencedTable)) { - $referencedTable = new Table($referencedTable); - } - - $fk = new ForeignKey(); - $fk->setReferencedTable($referencedTable) - ->setColumns($columns) - ->setReferencedColumns($referencedColumns) - ->setOptions($options); - - if ($name !== null) { - $fk->setConstraint($name); - } - - return new static($table, $fk); - } - - /** - * Returns the foreign key to be added - * - * @return \Phinx\Db\Table\ForeignKey - */ - public function getForeignKey(): ForeignKey - { - return $this->foreignKey; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddIndex.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddIndex.php deleted file mode 100644 index bf563edbc..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/AddIndex.php +++ /dev/null @@ -1,68 +0,0 @@ -index = $index; - } - - /** - * Creates a new AddIndex object after building the index object with the - * provided arguments - * - * @param \Phinx\Db\Table\Table $table The table to add the index to - * @param string|string[]|\Phinx\Db\Table\Index $columns The columns to index - * @param array $options Additional options for the index creation - * @return static - */ - public static function build(Table $table, string|array|Index $columns, array $options = []): static - { - // create a new index object if strings or an array of strings were supplied - $index = $columns; - - if (!$columns instanceof Index) { - $index = new Index(); - - $index->setColumns($columns); - $index->setOptions($options); - } - - return new static($table, $index); - } - - /** - * Returns the index to be added - * - * @return \Phinx\Db\Table\Index - */ - public function getIndex(): Index - { - return $this->index; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangeColumn.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangeColumn.php deleted file mode 100644 index f55afa8a9..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangeColumn.php +++ /dev/null @@ -1,89 +0,0 @@ -columnName = $columnName; - $this->column = $column; - - // if the name was omitted use the existing column name - if ($column->getName() === null || strlen($column->getName()) === 0) { - $column->setName($columnName); - } - } - - /** - * Creates a new ChangeColumn object after building the column definition - * out of the provided arguments - * - * @param \Phinx\Db\Table\Table $table The table to alter - * @param string $columnName The name of the column to change - * @param string|\Phinx\Util\Literal $type The type of the column - * @param array $options Additional options for the column - * @return static - */ - public static function build(Table $table, string $columnName, string|Literal $type, array $options = []): static - { - $column = new Column(); - $column->setName($columnName); - $column->setType($type); - $column->setOptions($options); // map options to column methods - - return new static($table, $columnName, $column); - } - - /** - * Returns the name of the column to change - * - * @return string - */ - public function getColumnName(): string - { - return $this->columnName; - } - - /** - * Returns the column definition - * - * @return \Phinx\Db\Table\Column - */ - public function getColumn(): Column - { - return $this->column; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangeComment.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangeComment.php deleted file mode 100644 index 7718519b7..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangeComment.php +++ /dev/null @@ -1,43 +0,0 @@ -newComment = $newComment; - } - - /** - * Return the new comment for the table - * - * @return string|null - */ - public function getNewComment(): ?string - { - return $this->newComment; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangePrimaryKey.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangePrimaryKey.php deleted file mode 100644 index a97349161..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/ChangePrimaryKey.php +++ /dev/null @@ -1,43 +0,0 @@ -newColumns = $newColumns; - } - - /** - * Return the new columns for the primary key - * - * @return string|string[]|null - */ - public function getNewColumns(): string|array|null - { - return $this->newColumns; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/CreateTable.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/CreateTable.php deleted file mode 100644 index a9a593bbd..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/CreateTable.php +++ /dev/null @@ -1,13 +0,0 @@ -foreignKey = $foreignKey; - } - - /** - * Creates a new DropForeignKey object after building the ForeignKey - * definition out of the passed arguments. - * - * @param \Phinx\Db\Table\Table $table The table to delete the foreign key from - * @param string|string[] $columns The columns participating in the foreign key - * @param string|null $constraint The constraint name - * @return static - */ - public static function build(Table $table, string|array $columns, ?string $constraint = null): static - { - if (is_string($columns)) { - $columns = [$columns]; - } - - $foreignKey = new ForeignKey(); - $foreignKey->setColumns($columns); - - if ($constraint) { - $foreignKey->setConstraint($constraint); - } - - return new static($table, $foreignKey); - } - - /** - * Returns the foreign key to remove - * - * @return \Phinx\Db\Table\ForeignKey - */ - public function getForeignKey(): ForeignKey - { - return $this->foreignKey; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/DropIndex.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/DropIndex.php deleted file mode 100644 index d5b973918..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/DropIndex.php +++ /dev/null @@ -1,76 +0,0 @@ -index = $index; - } - - /** - * Creates a new DropIndex object after assembling the passed - * arguments. - * - * @param \Phinx\Db\Table\Table $table The table where the index is - * @param string[] $columns the indexed columns - * @return static - */ - public static function build(Table $table, array $columns = []): static - { - $index = new Index(); - $index->setColumns($columns); - - return new static($table, $index); - } - - /** - * Creates a new DropIndex when the name of the index to drop - * is known. - * - * @param \Phinx\Db\Table\Table $table The table where the index is - * @param string $name The name of the index - * @return static - */ - public static function buildFromName(Table $table, string $name): static - { - $index = new Index(); - $index->setName($name); - - return new static($table, $index); - } - - /** - * Returns the index to be dropped - * - * @return \Phinx\Db\Table\Index - */ - public function getIndex(): Index - { - return $this->index; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/DropTable.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/DropTable.php deleted file mode 100644 index 318664971..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/DropTable.php +++ /dev/null @@ -1,13 +0,0 @@ -column = $column; - } - - /** - * Creates a new RemoveColumn object after assembling the - * passed arguments. - * - * @param \Phinx\Db\Table\Table $table The table where the column is - * @param string $columnName The name of the column to drop - * @return static - */ - public static function build(Table $table, string $columnName): static - { - $column = new Column(); - $column->setName($columnName); - - return new static($table, $column); - } - - /** - * Returns the column to be dropped - * - * @return \Phinx\Db\Table\Column - */ - public function getColumn(): Column - { - return $this->column; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/RenameColumn.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/RenameColumn.php deleted file mode 100644 index 3bf4ed52f..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/RenameColumn.php +++ /dev/null @@ -1,80 +0,0 @@ -newName = $newName; - $this->column = $column; - } - - /** - * Creates a new RenameColumn object after building the passed - * arguments - * - * @param \Phinx\Db\Table\Table $table The table where the column is - * @param string $columnName The name of the column to be changed - * @param string $newName The new name for the column - * @return static - */ - public static function build(Table $table, string $columnName, string $newName): static - { - $column = new Column(); - $column->setName($columnName); - - return new static($table, $column, $newName); - } - - /** - * Returns the column to be changed - * - * @return \Phinx\Db\Table\Column - */ - public function getColumn(): Column - { - return $this->column; - } - - /** - * Returns the new name for the column - * - * @return string - */ - public function getNewName(): string - { - return $this->newName; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/RenameTable.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/RenameTable.php deleted file mode 100644 index 25c4718e3..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Action/RenameTable.php +++ /dev/null @@ -1,43 +0,0 @@ -newName = $newName; - } - - /** - * Return the new name for the table - * - * @return string - */ - public function getNewName(): string - { - return $this->newName; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AbstractAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AbstractAdapter.php deleted file mode 100644 index abc223ddb..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AbstractAdapter.php +++ /dev/null @@ -1,413 +0,0 @@ - - */ - protected array $options = []; - - /** - * @var \Symfony\Component\Console\Input\InputInterface|null - */ - protected ?InputInterface $input = null; - - /** - * @var \Symfony\Component\Console\Output\OutputInterface - */ - protected OutputInterface $output; - - /** - * @var string[] - */ - protected array $createdTables = []; - - /** - * @var string - */ - protected string $schemaTableName = 'phinxlog'; - - /** - * @var array - */ - protected array $dataDomain = []; - - /** - * Class Constructor. - * - * @param array $options Options - * @param \Symfony\Component\Console\Input\InputInterface|null $input Input Interface - * @param \Symfony\Component\Console\Output\OutputInterface|null $output Output Interface - */ - public function __construct(array $options, ?InputInterface $input = null, ?OutputInterface $output = null) - { - $this->setOptions($options); - if ($input !== null) { - $this->setInput($input); - } - if ($output !== null) { - $this->setOutput($output); - } - } - - /** - * @inheritDoc - */ - public function setOptions(array $options): AdapterInterface - { - $this->options = $options; - - if (isset($options['default_migration_table'])) { - trigger_error('The default_migration_table setting for adapter has been deprecated since 0.13.0. Use `migration_table` instead.', E_USER_DEPRECATED); - if (!isset($options['migration_table'])) { - $options['migration_table'] = $options['default_migration_table']; - } - } - - if (isset($options['migration_table'])) { - $this->setSchemaTableName($options['migration_table']); - } - - if (isset($options['data_domain'])) { - $this->setDataDomain($options['data_domain']); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function getOptions(): array - { - return $this->options; - } - - /** - * @inheritDoc - */ - public function hasOption(string $name): bool - { - return isset($this->options[$name]); - } - - /** - * @inheritDoc - */ - public function getOption(string $name): mixed - { - if (!$this->hasOption($name)) { - return null; - } - - return $this->options[$name]; - } - - /** - * @inheritDoc - */ - public function setInput(InputInterface $input): AdapterInterface - { - $this->input = $input; - - return $this; - } - - /** - * @inheritDoc - */ - public function getInput(): ?InputInterface - { - return $this->input; - } - - /** - * @inheritDoc - */ - public function setOutput(OutputInterface $output): AdapterInterface - { - $this->output = $output; - - return $this; - } - - /** - * @inheritDoc - */ - public function getOutput(): OutputInterface - { - if (!isset($this->output)) { - $output = new NullOutput(); - $this->setOutput($output); - } - - return $this->output; - } - - /** - * @inheritDoc - * @return array - */ - public function getVersions(): array - { - $rows = $this->getVersionLog(); - - return array_keys($rows); - } - - /** - * Gets the schema table name. - * - * @return string - */ - public function getSchemaTableName(): string - { - return $this->schemaTableName; - } - - /** - * Sets the schema table name. - * - * @param string $schemaTableName Schema Table Name - * @return $this - */ - public function setSchemaTableName(string $schemaTableName) - { - $this->schemaTableName = $schemaTableName; - - return $this; - } - - /** - * Gets the data domain. - * - * @return array - */ - public function getDataDomain(): array - { - return $this->dataDomain; - } - - /** - * Sets the data domain. - * - * @param array $dataDomain Array for the data domain - * @return $this - */ - public function setDataDomain(array $dataDomain) - { - $this->dataDomain = []; - - // Iterate over data domain field definitions and perform initial and - // simple normalization. We make sure the definition as a base 'type' - // and it is compatible with the base Phinx types. - foreach ($dataDomain as $type => $options) { - if (!isset($options['type'])) { - throw new InvalidArgumentException(sprintf( - 'You must specify a type for data domain type "%s".', - $type, - )); - } - - // Replace type if it's the name of a Phinx constant - if (defined('static::' . $options['type'])) { - $options['type'] = constant('static::' . $options['type']); - } - - if (!in_array($options['type'], $this->getColumnTypes(), true)) { - throw new InvalidArgumentException(sprintf( - 'An invalid column type "%s" was specified for data domain type "%s".', - $options['type'], - $type, - )); - } - - $internal_type = $options['type']; - unset($options['type']); - - // Do a simple replacement for the 'length' / 'limit' option and - // detect hinting values for 'limit'. - if (isset($options['length'])) { - $options['limit'] = $options['length']; - unset($options['length']); - } - - if (isset($options['limit']) && !is_numeric($options['limit'])) { - if (!defined('static::' . $options['limit'])) { - throw new InvalidArgumentException(sprintf( - 'An invalid limit value "%s" was specified for data domain type "%s".', - $options['limit'], - $type, - )); - } - - $options['limit'] = constant('static::' . $options['limit']); - } - - // Save the data domain types in a more suitable format - $this->dataDomain[$type] = [ - 'type' => $internal_type, - 'options' => $options, - ]; - } - - return $this; - } - - /** - * @inheritdoc - */ - public function getColumnForType(string $columnName, string $type, array $options): Column - { - $column = new Column(); - $column->setName($columnName); - - if (array_key_exists($type, $this->getDataDomain())) { - $column->setType($this->dataDomain[$type]['type']); - $column->setOptions($this->dataDomain[$type]['options']); - } else { - $column->setType($type); - } - - $column->setOptions($options); - - return $column; - } - - /** - * @inheritDoc - * @throws \InvalidArgumentException - * @return void - */ - public function createSchemaTable(): void - { - try { - $options = [ - 'id' => false, - 'primary_key' => 'version', - ]; - - $table = new Table($this->getSchemaTableName(), $options, $this); - $table->addColumn('version', 'biginteger', ['null' => false]) - ->addColumn('migration_name', 'string', ['limit' => 100, 'default' => null, 'null' => true]) - ->addColumn('start_time', 'timestamp', ['default' => null, 'null' => true]) - ->addColumn('end_time', 'timestamp', ['default' => null, 'null' => true]) - ->addColumn('breakpoint', 'boolean', ['default' => false, 'null' => false]) - ->save(); - } catch (Exception $exception) { - throw new InvalidArgumentException( - 'There was a problem creating the schema table: ' . $exception->getMessage(), - (int)$exception->getCode(), - $exception, - ); - } - } - - /** - * @inheritDoc - */ - public function getAdapterType(): string - { - return $this->getOption('adapter'); - } - - /** - * @inheritDoc - */ - public function isValidColumnType(Column $column): bool - { - return $column->getType() instanceof Literal || in_array($column->getType(), $this->getColumnTypes(), true); - } - - /** - * Determines if instead of executing queries a dump to standard output is needed - * - * @return bool - */ - public function isDryRunEnabled(): bool - { - /** @var \Symfony\Component\Console\Input\InputInterface|null $input */ - $input = $this->getInput(); - - return $input && $input->hasOption('dry-run') ? (bool)$input->getOption('dry-run') : false; - } - - /** - * Adds user-created tables (e.g. not phinxlog) to a cached list - * - * @param string $tableName The name of the table - * @return void - */ - protected function addCreatedTable(string $tableName): void - { - $tableName = $this->quoteTableName($tableName); - if (substr_compare($tableName, 'phinxlog', -strlen('phinxlog')) !== 0) { - $this->createdTables[] = $tableName; - } - } - - /** - * Updates the name of the cached table - * - * @param string $tableName Original name of the table - * @param string $newTableName New name of the table - * @return void - */ - protected function updateCreatedTableName(string $tableName, string $newTableName): void - { - $tableName = $this->quoteTableName($tableName); - $newTableName = $this->quoteTableName($newTableName); - $key = array_search($tableName, $this->createdTables, true); - if ($key !== false) { - $this->createdTables[$key] = $newTableName; - } - } - - /** - * Removes table from the cached created list - * - * @param string $tableName The name of the table - * @return void - */ - protected function removeCreatedTable(string $tableName): void - { - $tableName = $this->quoteTableName($tableName); - $key = array_search($tableName, $this->createdTables, true); - if ($key !== false) { - unset($this->createdTables[$key]); - } - } - - /** - * Check if the table is in the cached list of created tables - * - * @param string $tableName The name of the table - * @return bool - */ - protected function hasCreatedTable(string $tableName): bool - { - $tableName = $this->quoteTableName($tableName); - - return in_array($tableName, $this->createdTables, true); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterFactory.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterFactory.php deleted file mode 100644 index 7413c4c13..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterFactory.php +++ /dev/null @@ -1,171 +0,0 @@ - - * @phpstan-var array> - */ - protected array $adapters = [ - 'mysql' => 'Phinx\Db\Adapter\MysqlAdapter', - 'pgsql' => 'Phinx\Db\Adapter\PostgresAdapter', - 'sqlite' => 'Phinx\Db\Adapter\SQLiteAdapter', - 'sqlsrv' => 'Phinx\Db\Adapter\SqlServerAdapter', - ]; - - /** - * Class map of adapters wrappers, indexed by name. - * - * @var array - */ - protected array $wrappers = [ - 'prefix' => 'Phinx\Db\Adapter\TablePrefixAdapter', - 'proxy' => 'Phinx\Db\Adapter\ProxyAdapter', - 'timed' => 'Phinx\Db\Adapter\TimedOutputAdapter', - ]; - - /** - * Register an adapter class with a given name. - * - * @param string $name Name - * @param object|string $class Class - * @throws \RuntimeException - * @return $this - */ - public function registerAdapter(string $name, object|string $class) - { - if (!is_subclass_of($class, 'Phinx\Db\Adapter\AdapterInterface')) { - throw new RuntimeException(sprintf( - 'Adapter class "%s" must implement Phinx\\Db\\Adapter\\AdapterInterface', - is_string($class) ? $class : get_class($class), - )); - } - $this->adapters[$name] = $class; - - return $this; - } - - /** - * Get an adapter class by name. - * - * @param string $name Name - * @throws \RuntimeException - * @return object|string - * @phpstan-return object|class-string<\Phinx\Db\Adapter\AdapterInterface> - */ - protected function getClass(string $name): object|string - { - if (empty($this->adapters[$name])) { - throw new RuntimeException(sprintf( - 'Adapter "%s" has not been registered', - $name, - )); - } - - return $this->adapters[$name]; - } - - /** - * Get an adapter instance by name. - * - * @param string $name Name - * @param array $options Options - * @return \Phinx\Db\Adapter\AdapterInterface - */ - public function getAdapter(string $name, array $options): AdapterInterface - { - $class = $this->getClass($name); - - return new $class($options); - } - - /** - * Add or replace a wrapper with a fully qualified class name. - * - * @param string $name Name - * @param object|string $class Class - * @throws \RuntimeException - * @return $this - */ - public function registerWrapper(string $name, object|string $class) - { - if (!is_subclass_of($class, 'Phinx\Db\Adapter\WrapperInterface')) { - throw new RuntimeException(sprintf( - 'Wrapper class "%s" must be implement Phinx\\Db\\Adapter\\WrapperInterface', - is_string($class) ? $class : get_class($class), - )); - } - $this->wrappers[$name] = $class; - - return $this; - } - - /** - * Get a wrapper class by name. - * - * @param string $name Name - * @throws \RuntimeException - * @return \Phinx\Db\Adapter\WrapperInterface|string - */ - protected function getWrapperClass(string $name): WrapperInterface|string - { - if (empty($this->wrappers[$name])) { - throw new RuntimeException(sprintf( - 'Wrapper "%s" has not been registered', - $name, - )); - } - - return $this->wrappers[$name]; - } - - /** - * Get a wrapper instance by name. - * - * @param string $name Name - * @param \Phinx\Db\Adapter\AdapterInterface $adapter Adapter - * @return \Phinx\Db\Adapter\AdapterWrapper - */ - public function getWrapper(string $name, AdapterInterface $adapter): AdapterWrapper - { - $class = $this->getWrapperClass($name); - - return new $class($adapter); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterInterface.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterInterface.php deleted file mode 100644 index ecce738af..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterInterface.php +++ /dev/null @@ -1,538 +0,0 @@ - - */ - public function getVersions(): array; - - /** - * Get all migration log entries, indexed by version creation time and sorted ascendingly by the configuration's - * version order option - * - * @return array - */ - public function getVersionLog(): array; - - /** - * Set adapter configuration options. - * - * @param array $options Options - * @return $this - */ - public function setOptions(array $options); - - /** - * Get all adapter options. - * - * @return array - */ - public function getOptions(): array; - - /** - * Check if an option has been set. - * - * @param string $name Name - * @return bool - */ - public function hasOption(string $name): bool; - - /** - * Get a single adapter option, or null if the option does not exist. - * - * @param string $name Name - * @return mixed - */ - public function getOption(string $name): mixed; - - /** - * Sets the console input. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @return $this - */ - public function setInput(InputInterface $input); - - /** - * Gets the console input. - * - * @return \Symfony\Component\Console\Input\InputInterface|null - */ - public function getInput(): ?InputInterface; - - /** - * Sets the console output. - * - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return $this - */ - public function setOutput(OutputInterface $output); - - /** - * Gets the console output. - * - * @return \Symfony\Component\Console\Output\OutputInterface - */ - public function getOutput(): OutputInterface; - - /** - * Returns a new Phinx\Db\Table\Column using the existent data domain. - * - * @param string $columnName The desired column name - * @param string $type The type for the column. Can be a data domain type. - * @param array $options Options array - * @return \Phinx\Db\Table\Column - */ - public function getColumnForType(string $columnName, string $type, array $options): Column; - - /** - * Records a migration being run. - * - * @param \Phinx\Migration\MigrationInterface $migration Migration - * @param string $direction Direction - * @param string $startTime Start Time - * @param string $endTime End Time - * @return $this - */ - public function migrated(MigrationInterface $migration, string $direction, string $startTime, string $endTime); - - /** - * Toggle a migration breakpoint. - * - * @param \Phinx\Migration\MigrationInterface $migration Migration - * @return $this - */ - public function toggleBreakpoint(MigrationInterface $migration); - - /** - * Reset all migration breakpoints. - * - * @return int The number of breakpoints reset - */ - public function resetAllBreakpoints(): int; - - /** - * Set a migration breakpoint. - * - * @param \Phinx\Migration\MigrationInterface $migration The migration target for the breakpoint set - * @return $this - */ - public function setBreakpoint(MigrationInterface $migration); - - /** - * Unset a migration breakpoint. - * - * @param \Phinx\Migration\MigrationInterface $migration The migration target for the breakpoint unset - * @return $this - */ - public function unsetBreakpoint(MigrationInterface $migration); - - /** - * Creates the schema table. - * - * @return void - */ - public function createSchemaTable(): void; - - /** - * Returns the adapter type. - * - * @return string - */ - public function getAdapterType(): string; - - /** - * Initializes the database connection. - * - * @throws \RuntimeException When the requested database driver is not installed. - * @return void - */ - public function connect(): void; - - /** - * Closes the database connection. - * - * @return void - */ - public function disconnect(): void; - - /** - * Does the adapter support transactions? - * - * @return bool - */ - public function hasTransactions(): bool; - - /** - * Begin a transaction. - * - * @return void - */ - public function beginTransaction(): void; - - /** - * Commit a transaction. - * - * @return void - */ - public function commitTransaction(): void; - - /** - * Rollback a transaction. - * - * @return void - */ - public function rollbackTransaction(): void; - - /** - * Executes a SQL statement and returns the number of affected rows. - * - * @param string $sql SQL - * @param array $params parameters to use for prepared query - * @return int - */ - public function execute(string $sql, array $params = []): int; - - /** - * Executes a list of migration actions for the given table - * - * @param \Phinx\Db\Table\Table $table The table to execute the actions for - * @param \Phinx\Db\Action\Action[] $actions The table to execute the actions for - * @return void - */ - public function executeActions(Table $table, array $actions): void; - - /** - * Returns a new Query object - * - * @return \Cake\Database\Query - */ - public function getQueryBuilder(string $type): Query; - - /** - * Return a new SelectQuery object - * - * @return \Cake\Database\Query\SelectQuery - */ - public function getSelectBuilder(): SelectQuery; - - /** - * Return a new InsertQuery object - * - * @return \Cake\Database\Query\InsertQuery - */ - public function getInsertBuilder(): InsertQuery; - - /** - * Return a new UpdateQuery object - * - * @return \Cake\Database\Query\UpdateQuery - */ - public function getUpdateBuilder(): UpdateQuery; - - /** - * Return a new DeleteQuery object - * - * @return \Cake\Database\Query\DeleteQuery - */ - public function getDeleteBuilder(): DeleteQuery; - - /** - * Executes a SQL statement. - * - * The return type depends on the underlying adapter being used. - * - * @param string $sql SQL - * @param array $params parameters to use for prepared query - * @return mixed - */ - public function query(string $sql, array $params = []): mixed; - - /** - * Executes a query and returns only one row as an array. - * - * @param string $sql SQL - * @return array|false - */ - public function fetchRow(string $sql): array|false; - - /** - * Executes a query and returns an array of rows. - * - * @param string $sql SQL - * @return array - */ - public function fetchAll(string $sql): array; - - /** - * Inserts data into a table. - * - * @param \Phinx\Db\Table\Table $table Table where to insert data - * @param array $row Row - * @return void - */ - public function insert(Table $table, array $row): void; - - /** - * Inserts data into a table in a bulk. - * - * @param \Phinx\Db\Table\Table $table Table where to insert data - * @param array $rows Rows - * @return void - */ - public function bulkinsert(Table $table, array $rows): void; - - /** - * Quotes a table name for use in a query. - * - * @param string $tableName Table name - * @return string - */ - public function quoteTableName(string $tableName): string; - - /** - * Quotes a column name for use in a query. - * - * @param string $columnName Table name - * @return string - */ - public function quoteColumnName(string $columnName): string; - - /** - * Checks to see if a table exists. - * - * @param string $tableName Table name - * @return bool - */ - public function hasTable(string $tableName): bool; - - /** - * Creates the specified database table. - * - * @param \Phinx\Db\Table\Table $table Table - * @param \Phinx\Db\Table\Column[] $columns List of columns in the table - * @param \Phinx\Db\Table\Index[] $indexes List of indexes for the table - * @return void - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void; - - /** - * Truncates the specified table - * - * @param string $tableName Table name - * @return void - */ - public function truncateTable(string $tableName): void; - - /** - * Returns table columns - * - * @param string $tableName Table name - * @return \Phinx\Db\Table\Column[] - */ - public function getColumns(string $tableName): array; - - /** - * Checks to see if a column exists. - * - * @param string $tableName Table name - * @param string $columnName Column name - * @return bool - */ - public function hasColumn(string $tableName, string $columnName): bool; - - /** - * Checks to see if an index exists. - * - * @param string $tableName Table name - * @param string|string[] $columns Column(s) - * @return bool - */ - public function hasIndex(string $tableName, string|array $columns): bool; - - /** - * Checks to see if an index specified by name exists. - * - * @param string $tableName Table name - * @param string $indexName Index name - * @return bool - */ - public function hasIndexByName(string $tableName, string $indexName): bool; - - /** - * Checks to see if the specified primary key exists. - * - * @param string $tableName Table name - * @param string|string[] $columns Column(s) - * @param string|null $constraint Constraint name - * @return bool - */ - public function hasPrimaryKey(string $tableName, string|array $columns, ?string $constraint = null): bool; - - /** - * Checks to see if a foreign key exists. - * - * @param string $tableName Table name - * @param string|string[] $columns Column(s) - * @param string|null $constraint Constraint name - * @return bool - */ - public function hasForeignKey(string $tableName, string|array $columns, ?string $constraint = null): bool; - - /** - * Returns an array of the supported Phinx column types. - * - * @return string[] - */ - public function getColumnTypes(): array; - - /** - * Checks that the given column is of a supported type. - * - * @param \Phinx\Db\Table\Column $column Column - * @return bool - */ - public function isValidColumnType(Column $column): bool; - - /** - * Converts the Phinx logical type to the adapter's SQL type. - * - * @param \Phinx\Util\Literal|string $type Type - * @param int|null $limit Limit - * @return array - */ - public function getSqlType(Literal|string $type, ?int $limit = null): array; - - /** - * Creates a new database. - * - * @param string $name Database Name - * @param array $options Options - * @return void - */ - public function createDatabase(string $name, array $options = []): void; - - /** - * Checks to see if a database exists. - * - * @param string $name Database Name - * @return bool - */ - public function hasDatabase(string $name): bool; - - /** - * Drops the specified database. - * - * @param string $name Database Name - * @return void - */ - public function dropDatabase(string $name): void; - - /** - * Creates the specified schema or throws an exception - * if there is no support for it. - * - * @param string $schemaName Schema Name - * @return void - */ - public function createSchema(string $schemaName = 'public'): void; - - /** - * Drops the specified schema table or throws an exception - * if there is no support for it. - * - * @param string $schemaName Schema name - * @return void - */ - public function dropSchema(string $schemaName): void; - - /** - * Cast a value to a boolean appropriate for the adapter. - * - * @param mixed $value The value to be cast - * @return mixed - */ - public function castToBool(mixed $value): mixed; -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterWrapper.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterWrapper.php deleted file mode 100644 index 09ee619dc..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/AdapterWrapper.php +++ /dev/null @@ -1,524 +0,0 @@ -setAdapter($adapter); - } - - /** - * @inheritDoc - */ - public function setAdapter(AdapterInterface $adapter): AdapterInterface - { - $this->adapter = $adapter; - - return $this; - } - - /** - * @inheritDoc - */ - public function getAdapter(): AdapterInterface - { - return $this->adapter; - } - - /** - * @inheritDoc - */ - public function setOptions(array $options): AdapterInterface - { - $this->adapter->setOptions($options); - - return $this; - } - - /** - * @inheritDoc - */ - public function getOptions(): array - { - return $this->adapter->getOptions(); - } - - /** - * @inheritDoc - */ - public function hasOption(string $name): bool - { - return $this->adapter->hasOption($name); - } - - /** - * @inheritDoc - */ - public function getOption(string $name): mixed - { - return $this->adapter->getOption($name); - } - - /** - * @inheritDoc - */ - public function setInput(InputInterface $input): AdapterInterface - { - $this->adapter->setInput($input); - - return $this; - } - - /** - * @inheritDoc - */ - public function getInput(): InputInterface - { - return $this->adapter->getInput(); - } - - /** - * @inheritDoc - */ - public function setOutput(OutputInterface $output): AdapterInterface - { - $this->adapter->setOutput($output); - - return $this; - } - - /** - * @inheritDoc - */ - public function getOutput(): OutputInterface - { - return $this->adapter->getOutput(); - } - - /** - * @inheritDoc - */ - public function getColumnForType(string $columnName, string $type, array $options): Column - { - return $this->adapter->getColumnForType($columnName, $type, $options); - } - - /** - * @inheritDoc - */ - public function connect(): void - { - $this->getAdapter()->connect(); - } - - /** - * @inheritDoc - */ - public function disconnect(): void - { - $this->getAdapter()->disconnect(); - } - - /** - * @inheritDoc - */ - public function execute(string $sql, array $params = []): int - { - return $this->getAdapter()->execute($sql, $params); - } - - /** - * @inheritDoc - */ - public function query(string $sql, array $params = []): mixed - { - return $this->getAdapter()->query($sql, $params); - } - - /** - * @inheritDoc - */ - public function insert(Table $table, array $row): void - { - $this->getAdapter()->insert($table, $row); - } - - /** - * @inheritDoc - */ - public function bulkinsert(Table $table, array $rows): void - { - $this->getAdapter()->bulkinsert($table, $rows); - } - - /** - * @inheritDoc - */ - public function fetchRow(string $sql): array|false - { - return $this->getAdapter()->fetchRow($sql); - } - - /** - * @inheritDoc - */ - public function fetchAll(string $sql): array - { - return $this->getAdapter()->fetchAll($sql); - } - - /** - * @inheritDoc - */ - public function getVersions(): array - { - return $this->getAdapter()->getVersions(); - } - - /** - * @inheritDoc - */ - public function getVersionLog(): array - { - return $this->getAdapter()->getVersionLog(); - } - - /** - * @inheritDoc - */ - public function migrated(MigrationInterface $migration, string $direction, string $startTime, string $endTime): AdapterInterface - { - $this->getAdapter()->migrated($migration, $direction, $startTime, $endTime); - - return $this; - } - - /** - * @inheritDoc - */ - public function toggleBreakpoint(MigrationInterface $migration): AdapterInterface - { - $this->getAdapter()->toggleBreakpoint($migration); - - return $this; - } - - /** - * @inheritDoc - */ - public function resetAllBreakpoints(): int - { - return $this->getAdapter()->resetAllBreakpoints(); - } - - /** - * @inheritDoc - */ - public function setBreakpoint(MigrationInterface $migration): AdapterInterface - { - $this->getAdapter()->setBreakpoint($migration); - - return $this; - } - - /** - * @inheritDoc - */ - public function unsetBreakpoint(MigrationInterface $migration): AdapterInterface - { - $this->getAdapter()->unsetBreakpoint($migration); - - return $this; - } - - /** - * @inheritDoc - */ - public function createSchemaTable(): void - { - $this->getAdapter()->createSchemaTable(); - } - - /** - * @inheritDoc - */ - public function getColumnTypes(): array - { - return $this->getAdapter()->getColumnTypes(); - } - - /** - * @inheritDoc - */ - public function isValidColumnType(Column $column): bool - { - return $this->getAdapter()->isValidColumnType($column); - } - - /** - * @inheritDoc - */ - public function hasTransactions(): bool - { - return $this->getAdapter()->hasTransactions(); - } - - /** - * @inheritDoc - */ - public function beginTransaction(): void - { - $this->getAdapter()->beginTransaction(); - } - - /** - * @inheritDoc - */ - public function commitTransaction(): void - { - $this->getAdapter()->commitTransaction(); - } - - /** - * @inheritDoc - */ - public function rollbackTransaction(): void - { - $this->getAdapter()->rollbackTransaction(); - } - - /** - * @inheritDoc - */ - public function quoteTableName(string $tableName): string - { - return $this->getAdapter()->quoteTableName($tableName); - } - - /** - * @inheritDoc - */ - public function quoteColumnName(string $columnName): string - { - return $this->getAdapter()->quoteColumnName($columnName); - } - - /** - * @inheritDoc - */ - public function hasTable(string $tableName): bool - { - return $this->getAdapter()->hasTable($tableName); - } - - /** - * @inheritDoc - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void - { - $this->getAdapter()->createTable($table, $columns, $indexes); - } - - /** - * @inheritDoc - */ - public function getColumns(string $tableName): array - { - return $this->getAdapter()->getColumns($tableName); - } - - /** - * @inheritDoc - */ - public function hasColumn(string $tableName, string $columnName): bool - { - return $this->getAdapter()->hasColumn($tableName, $columnName); - } - - /** - * @inheritDoc - */ - public function hasIndex(string $tableName, string|array $columns): bool - { - return $this->getAdapter()->hasIndex($tableName, $columns); - } - - /** - * @inheritDoc - */ - public function hasIndexByName(string $tableName, string $indexName): bool - { - return $this->getAdapter()->hasIndexByName($tableName, $indexName); - } - - /** - * @inheritDoc - */ - public function hasPrimaryKey(string $tableName, $columns, ?string $constraint = null): bool - { - return $this->getAdapter()->hasPrimaryKey($tableName, $columns, $constraint); - } - - /** - * @inheritDoc - */ - public function hasForeignKey(string $tableName, $columns, ?string $constraint = null): bool - { - return $this->getAdapter()->hasForeignKey($tableName, $columns, $constraint); - } - - /** - * @inheritDoc - */ - public function getSqlType(Literal|string $type, ?int $limit = null): array - { - return $this->getAdapter()->getSqlType($type, $limit); - } - - /** - * @inheritDoc - */ - public function createDatabase(string $name, array $options = []): void - { - $this->getAdapter()->createDatabase($name, $options); - } - - /** - * @inheritDoc - */ - public function hasDatabase(string $name): bool - { - return $this->getAdapter()->hasDatabase($name); - } - - /** - * @inheritDoc - */ - public function dropDatabase(string $name): void - { - $this->getAdapter()->dropDatabase($name); - } - - /** - * @inheritDoc - */ - public function createSchema(string $schemaName = 'public'): void - { - $this->getAdapter()->createSchema($schemaName); - } - - /** - * @inheritDoc - */ - public function dropSchema(string $schemaName): void - { - $this->getAdapter()->dropSchema($schemaName); - } - - /** - * @inheritDoc - */ - public function truncateTable(string $tableName): void - { - $this->getAdapter()->truncateTable($tableName); - } - - /** - * @inheritDoc - */ - public function castToBool($value): mixed - { - return $this->getAdapter()->castToBool($value); - } - - /** - * @return \PDO - */ - public function getConnection(): PDO - { - return $this->getAdapter()->getConnection(); - } - - /** - * @inheritDoc - */ - public function executeActions(Table $table, array $actions): void - { - $this->getAdapter()->executeActions($table, $actions); - } - - /** - * @inheritDoc - */ - public function getQueryBuilder(string $type): Query - { - return $this->getAdapter()->getQueryBuilder($type); - } - - /** - * @inheritDoc - */ - public function getSelectBuilder(): SelectQuery - { - return $this->getAdapter()->getSelectBuilder(); - } - - /** - * @inheritDoc - */ - public function getInsertBuilder(): InsertQuery - { - return $this->getAdapter()->getInsertBuilder(); - } - - /** - * @inheritDoc - */ - public function getUpdateBuilder(): UpdateQuery - { - return $this->getAdapter()->getUpdateBuilder(); - } - - /** - * @inheritDoc - */ - public function getDeleteBuilder(): DeleteQuery - { - return $this->getAdapter()->getDeleteBuilder(); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/DirectActionInterface.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/DirectActionInterface.php deleted file mode 100644 index 81985c1a5..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/DirectActionInterface.php +++ /dev/null @@ -1,140 +0,0 @@ - true, - self::PHINX_TYPE_TINY_INTEGER => true, - self::PHINX_TYPE_SMALL_INTEGER => true, - self::PHINX_TYPE_MEDIUM_INTEGER => true, - self::PHINX_TYPE_BIG_INTEGER => true, - self::PHINX_TYPE_FLOAT => true, - self::PHINX_TYPE_DECIMAL => true, - self::PHINX_TYPE_DOUBLE => true, - self::PHINX_TYPE_BOOLEAN => true, - ]; - - // These constants roughly correspond to the maximum allowed value for each field, - // except for the `_LONG` and `_BIG` variants, which are maxed at 32-bit - // PHP_INT_MAX value. The `INT_REGULAR` field is just arbitrarily half of INT_BIG - // as its actual value is its regular value is larger than PHP_INT_MAX. We do this - // to keep consistent the type hints for getSqlType and Column::$limit being integers. - public const TEXT_TINY = 255; - public const TEXT_SMALL = 255; /* deprecated, alias of TEXT_TINY */ - public const TEXT_REGULAR = 65535; - public const TEXT_MEDIUM = 16777215; - public const TEXT_LONG = 2147483647; - - // According to https://dev.mysql.com/doc/refman/5.0/en/blob.html BLOB sizes are the same as TEXT - public const BLOB_TINY = 255; - public const BLOB_SMALL = 255; /* deprecated, alias of BLOB_TINY */ - public const BLOB_REGULAR = 65535; - public const BLOB_MEDIUM = 16777215; - public const BLOB_LONG = 2147483647; - - public const INT_TINY = 255; - public const INT_SMALL = 65535; - public const INT_MEDIUM = 16777215; - public const INT_REGULAR = 1073741823; - public const INT_BIG = 2147483647; - - public const INT_DISPLAY_TINY = 4; - public const INT_DISPLAY_SMALL = 6; - public const INT_DISPLAY_MEDIUM = 8; - public const INT_DISPLAY_REGULAR = 11; - public const INT_DISPLAY_BIG = 20; - - public const BIT = 64; - - public const TYPE_YEAR = 'year'; - - public const FIRST = 'FIRST'; - - /** - * {@inheritDoc} - * - * @throws \RuntimeException - * @throws \InvalidArgumentException - * @return void - */ - public function connect(): void - { - if ($this->connection === null) { - if (!class_exists('PDO') || !in_array('mysql', PDO::getAvailableDrivers(), true)) { - // @codeCoverageIgnoreStart - throw new RuntimeException('You need to enable the PDO_Mysql extension for Phinx to run properly.'); - // @codeCoverageIgnoreEnd - } - - $options = $this->getOptions(); - - $dsn = 'mysql:'; - - if (!empty($options['unix_socket'])) { - // use socket connection - $dsn .= 'unix_socket=' . $options['unix_socket']; - } else { - // use network connection - $dsn .= 'host=' . $options['host']; - if (!empty($options['port'])) { - $dsn .= ';port=' . $options['port']; - } - } - - $dsn .= ';dbname=' . $options['name']; - - // charset support - if (!empty($options['charset'])) { - $dsn .= ';charset=' . $options['charset']; - } - - $driverOptions = []; - - // use custom data fetch mode - if (!empty($options['fetch_mode'])) { - $driverOptions[PDO::ATTR_DEFAULT_FETCH_MODE] = constant('\PDO::FETCH_' . strtoupper($options['fetch_mode'])); - } - - // pass \PDO::ATTR_PERSISTENT to driver options instead of useless setting it after instantiation - if (isset($options['attr_persistent'])) { - $driverOptions[PDO::ATTR_PERSISTENT] = $options['attr_persistent']; - } - - // support arbitrary \PDO::MYSQL_ATTR_* driver options and pass them to PDO - // https://php.net/manual/en/ref.pdo-mysql.php#pdo-mysql.constants - foreach ($options as $key => $option) { - if (strpos($key, 'mysql_attr_') === 0) { - $pdoConstant = '\PDO::' . strtoupper($key); - if (!defined($pdoConstant)) { - throw new UnexpectedValueException('Invalid PDO attribute: ' . $key . ' (' . $pdoConstant . ')'); - } - $driverOptions[constant($pdoConstant)] = $option; - } - } - - $db = $this->createPdoConnection($dsn, $options['user'] ?? null, $options['pass'] ?? null, $driverOptions); - - $this->setConnection($db); - } - } - - /** - * @inheritDoc - */ - public function disconnect(): void - { - $this->connection = null; - } - - /** - * @inheritDoc - */ - public function hasTransactions(): bool - { - return true; - } - - /** - * @inheritDoc - */ - public function beginTransaction(): void - { - $this->execute('START TRANSACTION'); - } - - /** - * @inheritDoc - */ - public function commitTransaction(): void - { - $this->execute('COMMIT'); - } - - /** - * @inheritDoc - */ - public function rollbackTransaction(): void - { - $this->execute('ROLLBACK'); - } - - /** - * @inheritDoc - */ - public function quoteTableName(string $tableName): string - { - return str_replace('.', '`.`', $this->quoteColumnName($tableName)); - } - - /** - * @inheritDoc - */ - public function quoteColumnName(string $columnName): string - { - return '`' . str_replace('`', '``', $columnName) . '`'; - } - - /** - * @inheritDoc - */ - public function hasTable(string $tableName): bool - { - if ($this->hasCreatedTable($tableName)) { - return true; - } - - if (strpos($tableName, '.') !== false) { - [$schema, $table] = explode('.', $tableName); - $exists = $this->hasTableWithSchema($schema, $table); - // Only break here on success, because it is possible for table names to contain a dot. - if ($exists) { - return true; - } - } - - $options = $this->getOptions(); - - return $this->hasTableWithSchema($options['name'], $tableName); - } - - /** - * @param string $schema The table schema - * @param string $tableName The table name - * @return bool - */ - protected function hasTableWithSchema(string $schema, string $tableName): bool - { - $result = $this->fetchRow(sprintf( - "SELECT TABLE_NAME - FROM INFORMATION_SCHEMA.TABLES - WHERE TABLE_SCHEMA = '%s' AND TABLE_NAME = '%s'", - $schema, - $tableName, - )); - - return !empty($result); - } - - /** - * @inheritDoc - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void - { - // This method is based on the MySQL docs here: https://dev.mysql.com/doc/refman/5.1/en/create-index.html - $defaultOptions = [ - 'engine' => 'InnoDB', - 'collation' => 'utf8mb4_unicode_ci', - ]; - - $options = array_merge( - $defaultOptions, - array_intersect_key($this->getOptions(), $defaultOptions), - $table->getOptions(), - ); - - // Add the default primary key - if (!isset($options['id']) || (isset($options['id']) && $options['id'] === true)) { - $options['id'] = 'id'; - } - - if (isset($options['id']) && is_string($options['id'])) { - // Handle id => "field_name" to support AUTO_INCREMENT - $column = new Column(); - $column->setName($options['id']) - ->setType('integer') - ->setOptions([ - 'signed' => $options['signed'] ?? !FeatureFlags::$unsignedPrimaryKeys, - 'identity' => true, - ]); - - if (isset($options['limit'])) { - $column->setLimit($options['limit']); - } - - array_unshift($columns, $column); - if (isset($options['primary_key']) && (array)$options['id'] !== (array)$options['primary_key']) { - throw new InvalidArgumentException('You cannot enable an auto incrementing ID field and a primary key'); - } - $options['primary_key'] = $options['id']; - } - - // open: process table options like collation etc - - // process table engine (default to InnoDB) - $optionsStr = 'ENGINE = InnoDB'; - if (isset($options['engine'])) { - $optionsStr = sprintf('ENGINE = %s', $options['engine']); - } - - // process table collation - if (isset($options['collation'])) { - $charset = explode('_', $options['collation']); - $optionsStr .= sprintf(' CHARACTER SET %s', $charset[0]); - $optionsStr .= sprintf(' COLLATE %s', $options['collation']); - } - - // set the table comment - if (isset($options['comment'])) { - $optionsStr .= sprintf(' COMMENT=%s ', $this->getConnection()->quote($options['comment'])); - } - - // set the table row format - if (isset($options['row_format'])) { - $optionsStr .= sprintf(' ROW_FORMAT=%s ', $options['row_format']); - } - - $sql = 'CREATE TABLE '; - $sql .= $this->quoteTableName($table->getName()) . ' ('; - foreach ($columns as $column) { - $sql .= $this->quoteColumnName($column->getName()) . ' ' . $this->getColumnSqlDefinition($column) . ', '; - } - - // set the primary key(s) - if (isset($options['primary_key'])) { - $sql = rtrim($sql); - $sql .= ' PRIMARY KEY ('; - if (is_string($options['primary_key'])) { // handle primary_key => 'id' - $sql .= $this->quoteColumnName($options['primary_key']); - } elseif (is_array($options['primary_key'])) { // handle primary_key => array('tag_id', 'resource_id') - $sql .= implode(',', array_map([$this, 'quoteColumnName'], (array)$options['primary_key'])); - } - $sql .= ')'; - } else { - $sql = substr(rtrim($sql), 0, -1); // no primary keys - } - - // set the indexes - foreach ($indexes as $index) { - $sql .= ', ' . $this->getIndexSqlDefinition($index); - } - - $sql .= ') ' . $optionsStr; - $sql = rtrim($sql); - - // execute the sql - $this->execute($sql); - - $this->addCreatedTable($table->getName()); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getChangePrimaryKeyInstructions(Table $table, $newColumns): AlterInstructions - { - $instructions = new AlterInstructions(); - - // Drop the existing primary key - $primaryKey = $this->getPrimaryKey($table->getName()); - if (!empty($primaryKey['columns'])) { - $instructions->addAlter('DROP PRIMARY KEY'); - } - - // Add the primary key(s) - if (!empty($newColumns)) { - $sql = 'ADD PRIMARY KEY ('; - if (is_string($newColumns)) { // handle primary_key => 'id' - $sql .= $this->quoteColumnName($newColumns); - } elseif (is_array($newColumns)) { // handle primary_key => array('tag_id', 'resource_id') - $sql .= implode(',', array_map([$this, 'quoteColumnName'], $newColumns)); - } else { - throw new InvalidArgumentException(sprintf( - 'Invalid value for primary key: %s', - json_encode($newColumns), - )); - } - $sql .= ')'; - $instructions->addAlter($sql); - } - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getChangeCommentInstructions(Table $table, ?string $newComment): AlterInstructions - { - $instructions = new AlterInstructions(); - - // passing 'null' is to remove table comment - $newComment = $newComment ?? ''; - $sql = sprintf(' COMMENT=%s ', $this->getConnection()->quote($newComment)); - $instructions->addAlter($sql); - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getRenameTableInstructions(string $tableName, string $newTableName): AlterInstructions - { - $this->updateCreatedTableName($tableName, $newTableName); - $sql = sprintf( - 'RENAME TABLE %s TO %s', - $this->quoteTableName($tableName), - $this->quoteTableName($newTableName), - ); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - protected function getDropTableInstructions(string $tableName): AlterInstructions - { - $this->removeCreatedTable($tableName); - $sql = sprintf('DROP TABLE %s', $this->quoteTableName($tableName)); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - public function truncateTable(string $tableName): void - { - $sql = sprintf( - 'TRUNCATE TABLE %s', - $this->quoteTableName($tableName), - ); - - $this->execute($sql); - } - - /** - * @inheritDoc - */ - public function getColumns(string $tableName): array - { - $columns = []; - $rows = $this->fetchAll(sprintf('SHOW FULL COLUMNS FROM %s', $this->quoteTableName($tableName))); - foreach ($rows as $columnInfo) { - $phinxType = $this->getPhinxType($columnInfo['Type']); - - $column = new Column(); - $column->setName($columnInfo['Field']) - ->setNull($columnInfo['Null'] !== 'NO') - ->setType($phinxType['name']) - ->setSigned(strpos($columnInfo['Type'], 'unsigned') === false) - ->setLimit($phinxType['limit']) - ->setScale($phinxType['scale']) - ->setComment($columnInfo['Comment']); - - if ($columnInfo['Extra'] === 'auto_increment') { - $column->setIdentity(true); - } - - if ($columnInfo['Extra'] === 'on update CURRENT_TIMESTAMP') { - $column->setUpdate('CURRENT_TIMESTAMP'); - } - - if (isset($phinxType['values'])) { - $column->setValues($phinxType['values']); - } - - $default = $columnInfo['Default']; - if ( - is_string($default) && - in_array( - $column->getType(), - array_merge( - static::PHINX_TYPES_GEOSPATIAL, - [static::PHINX_TYPE_BLOB, static::PHINX_TYPE_JSON, static::PHINX_TYPE_TEXT], - ), - ) - ) { - // The default that comes back from MySQL for these types prefixes the collation type and - // surrounds the value with escaped single quotes, for example "_utf8mbf4\'abc\'", and so - // this converts that then down to the default value of "abc" to correspond to what the user - // would have specified in a migration. - $default = preg_replace("/^_(?:[a-zA-Z0-9]+?)\\\'(.*)\\\'$/", '\1', $default); - } - $column->setDefault($default); - - $columns[] = $column; - } - - return $columns; - } - - /** - * @inheritDoc - */ - public function hasColumn(string $tableName, string $columnName): bool - { - $rows = $this->fetchAll(sprintf('SHOW COLUMNS FROM %s', $this->quoteTableName($tableName))); - foreach ($rows as $column) { - if (strcasecmp($column['Field'], $columnName) === 0) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - protected function getAddColumnInstructions(Table $table, Column $column): AlterInstructions - { - $alter = sprintf( - 'ADD %s %s', - $this->quoteColumnName($column->getName()), - $this->getColumnSqlDefinition($column), - ); - - $alter .= $this->afterClause($column); - - return new AlterInstructions([$alter]); - } - - /** - * Exposes the MySQL syntax to arrange a column `FIRST`. - * - * @param \Phinx\Db\Table\Column $column The column being altered. - * @return string The appropriate SQL fragment. - */ - protected function afterClause(Column $column): string - { - $after = $column->getAfter(); - if (empty($after)) { - return ''; - } - - if ($after === self::FIRST) { - return ' FIRST'; - } - - return ' AFTER ' . $this->quoteColumnName($after); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getRenameColumnInstructions(string $tableName, string $columnName, string $newColumnName): AlterInstructions - { - $rows = $this->fetchAll(sprintf('SHOW FULL COLUMNS FROM %s', $this->quoteTableName($tableName))); - - foreach ($rows as $row) { - if (strcasecmp($row['Field'], $columnName) === 0) { - $null = $row['Null'] === 'NO' ? 'NOT NULL' : 'NULL'; - $comment = isset($row['Comment']) ? ' COMMENT ' . '\'' . addslashes($row['Comment']) . '\'' : ''; - - // create the extra string by also filtering out the DEFAULT_GENERATED option (MySQL 8 fix) - $extras = array_filter(explode(' ', strtoupper($row['Extra'])), function ($value) { - if ($value == 'DEFAULT_GENERATED') { - return false; - } - - return true; - }); - $extra = ' ' . implode(' ', $extras); - - if (($row['Default'] !== null)) { - $extra .= $this->getDefaultValueDefinition($row['Default']); - } - $definition = $row['Type'] . ' ' . $null . $extra . $comment; - - $alter = sprintf( - 'CHANGE COLUMN %s %s %s', - $this->quoteColumnName($columnName), - $this->quoteColumnName($newColumnName), - $definition, - ); - - return new AlterInstructions([$alter]); - } - } - - throw new InvalidArgumentException(sprintf( - "The specified column doesn't exist: " . - $columnName, - )); - } - - /** - * @inheritDoc - */ - protected function getChangeColumnInstructions(string $tableName, string $columnName, Column $newColumn): AlterInstructions - { - $alter = sprintf( - 'CHANGE %s %s %s%s', - $this->quoteColumnName($columnName), - $this->quoteColumnName($newColumn->getName()), - $this->getColumnSqlDefinition($newColumn), - $this->afterClause($newColumn), - ); - - return new AlterInstructions([$alter]); - } - - /** - * @inheritDoc - */ - protected function getDropColumnInstructions(string $tableName, string $columnName): AlterInstructions - { - $alter = sprintf('DROP COLUMN %s', $this->quoteColumnName($columnName)); - - return new AlterInstructions([$alter]); - } - - /** - * Get an array of indexes from a particular table. - * - * @param string $tableName Table name - * @return array - */ - protected function getIndexes(string $tableName): array - { - $indexes = []; - $rows = $this->fetchAll(sprintf('SHOW INDEXES FROM %s', $this->quoteTableName($tableName))); - foreach ($rows as $row) { - if (!isset($indexes[$row['Key_name']])) { - $indexes[$row['Key_name']] = ['columns' => []]; - } - $indexes[$row['Key_name']]['columns'][] = strtolower($row['Column_name']); - } - - return $indexes; - } - - /** - * @inheritDoc - */ - public function hasIndex(string $tableName, string|array $columns): bool - { - if (is_string($columns)) { - $columns = [$columns]; // str to array - } - - $columns = array_map('strtolower', $columns); - $indexes = $this->getIndexes($tableName); - - foreach ($indexes as $index) { - if ($columns == $index['columns']) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - public function hasIndexByName(string $tableName, string $indexName): bool - { - $indexes = $this->getIndexes($tableName); - - foreach ($indexes as $name => $index) { - if ($name === $indexName) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - protected function getAddIndexInstructions(Table $table, Index $index): AlterInstructions - { - $instructions = new AlterInstructions(); - - if ($index->getType() === Index::FULLTEXT) { - // Must be executed separately - // SQLSTATE[HY000]: General error: 1795 InnoDB presently supports one FULLTEXT index creation at a time - $alter = sprintf( - 'ALTER TABLE %s ADD %s', - $this->quoteTableName($table->getName()), - $this->getIndexSqlDefinition($index), - ); - - $instructions->addPostStep($alter); - } else { - $alter = sprintf( - 'ADD %s', - $this->getIndexSqlDefinition($index), - ); - - $instructions->addAlter($alter); - } - - return $instructions; - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getDropIndexByColumnsInstructions(string $tableName, $columns): AlterInstructions - { - if (is_string($columns)) { - $columns = [$columns]; // str to array - } - - $indexes = $this->getIndexes($tableName); - $columns = array_map('strtolower', $columns); - - foreach ($indexes as $indexName => $index) { - if ($columns == $index['columns']) { - return new AlterInstructions([sprintf( - 'DROP INDEX %s', - $this->quoteColumnName($indexName), - )]); - } - } - - throw new InvalidArgumentException(sprintf( - "The specified index on columns '%s' does not exist", - implode(',', $columns), - )); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getDropIndexByNameInstructions(string $tableName, $indexName): AlterInstructions - { - $indexes = $this->getIndexes($tableName); - - foreach ($indexes as $name => $index) { - if ($name === $indexName) { - return new AlterInstructions([sprintf( - 'DROP INDEX %s', - $this->quoteColumnName($indexName), - )]); - } - } - - throw new InvalidArgumentException(sprintf( - "The specified index name '%s' does not exist", - $indexName, - )); - } - - /** - * @inheritDoc - */ - public function hasPrimaryKey(string $tableName, $columns, ?string $constraint = null): bool - { - $primaryKey = $this->getPrimaryKey($tableName); - - if (empty($primaryKey['constraint'])) { - return false; - } - - if ($constraint) { - return $primaryKey['constraint'] === $constraint; - } - - // Normalize the columns for comparison - $primaryKeyColumns = array_map('mb_strtolower', $primaryKey['columns']); - $columns = array_map('mb_strtolower', (array)$columns); - - return $primaryKeyColumns === $columns; - } - - /** - * Get the primary key from a particular table. - * - * @param string $tableName Table name - * @return array - */ - public function getPrimaryKey(string $tableName): array - { - $options = $this->getOptions(); - $rows = $this->fetchAll(sprintf( - "SELECT - k.CONSTRAINT_NAME, - k.COLUMN_NAME - FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS t - JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE k - USING(CONSTRAINT_NAME,TABLE_SCHEMA,TABLE_NAME) - WHERE t.CONSTRAINT_TYPE='PRIMARY KEY' - AND t.TABLE_SCHEMA='%s' - AND t.TABLE_NAME='%s'", - $options['name'], - $tableName, - )); - - $primaryKey = [ - 'columns' => [], - ]; - foreach ($rows as $row) { - $primaryKey['constraint'] = $row['CONSTRAINT_NAME']; - $primaryKey['columns'][] = $row['COLUMN_NAME']; - } - - return $primaryKey; - } - - /** - * @inheritDoc - */ - public function hasForeignKey(string $tableName, $columns, ?string $constraint = null): bool - { - $foreignKeys = $this->getForeignKeys($tableName); - if ($constraint) { - if (isset($foreignKeys[$constraint])) { - return !empty($foreignKeys[$constraint]); - } - - return false; - } - - $columns = array_map('mb_strtolower', (array)$columns); - - foreach ($foreignKeys as $key) { - if (array_map('mb_strtolower', $key['columns']) === $columns) { - return true; - } - } - - return false; - } - - /** - * Get an array of foreign keys from a particular table. - * - * @param string $tableName Table name - * @return array - */ - protected function getForeignKeys(string $tableName): array - { - if (strpos($tableName, '.') !== false) { - [$schema, $tableName] = explode('.', $tableName); - } - - $foreignKeys = []; - $rows = $this->fetchAll(sprintf( - "SELECT - CONSTRAINT_NAME, - CONCAT(TABLE_SCHEMA, '.', TABLE_NAME) AS TABLE_NAME, - COLUMN_NAME, - CONCAT(REFERENCED_TABLE_SCHEMA, '.', REFERENCED_TABLE_NAME) AS REFERENCED_TABLE_NAME, - REFERENCED_COLUMN_NAME - FROM information_schema.KEY_COLUMN_USAGE - WHERE REFERENCED_TABLE_NAME IS NOT NULL - AND TABLE_SCHEMA = %s - AND TABLE_NAME = '%s' - ORDER BY POSITION_IN_UNIQUE_CONSTRAINT", - empty($schema) ? 'DATABASE()' : "'$schema'", - $tableName, - )); - foreach ($rows as $row) { - $foreignKeys[$row['CONSTRAINT_NAME']]['table'] = $row['TABLE_NAME']; - $foreignKeys[$row['CONSTRAINT_NAME']]['columns'][] = $row['COLUMN_NAME']; - $foreignKeys[$row['CONSTRAINT_NAME']]['referenced_table'] = $row['REFERENCED_TABLE_NAME']; - $foreignKeys[$row['CONSTRAINT_NAME']]['referenced_columns'][] = $row['REFERENCED_COLUMN_NAME']; - } - - return $foreignKeys; - } - - /** - * @inheritDoc - */ - protected function getAddForeignKeyInstructions(Table $table, ForeignKey $foreignKey): AlterInstructions - { - $alter = sprintf( - 'ADD %s', - $this->getForeignKeySqlDefinition($foreignKey), - ); - - return new AlterInstructions([$alter]); - } - - /** - * @inheritDoc - */ - protected function getDropForeignKeyInstructions(string $tableName, string $constraint): AlterInstructions - { - $alter = sprintf( - 'DROP FOREIGN KEY %s', - $constraint, - ); - - return new AlterInstructions([$alter]); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getDropForeignKeyByColumnsInstructions(string $tableName, array $columns): AlterInstructions - { - $instructions = new AlterInstructions(); - - $columns = array_map('mb_strtolower', $columns); - - $matches = []; - $foreignKeys = $this->getForeignKeys($tableName); - foreach ($foreignKeys as $name => $key) { - if (array_map('mb_strtolower', $key['columns']) === $columns) { - $matches[] = $name; - } - } - - if (empty($matches)) { - throw new InvalidArgumentException(sprintf( - 'No foreign key on column(s) `%s` exists', - implode(', ', $columns), - )); - } - - foreach ($matches as $name) { - $instructions->merge( - $this->getDropForeignKeyInstructions($tableName, $name), - ); - } - - return $instructions; - } - - /** - * {@inheritDoc} - * - * @throws \Phinx\Db\Adapter\UnsupportedColumnTypeException - */ - public function getSqlType(Literal|string $type, ?int $limit = null): array - { - $type = (string)$type; - switch ($type) { - case static::PHINX_TYPE_FLOAT: - case static::PHINX_TYPE_DOUBLE: - case static::PHINX_TYPE_DECIMAL: - case static::PHINX_TYPE_DATE: - case static::PHINX_TYPE_ENUM: - case static::PHINX_TYPE_SET: - case static::PHINX_TYPE_JSON: - // Geospatial database types - case static::PHINX_TYPE_GEOMETRY: - case static::PHINX_TYPE_POINT: - case static::PHINX_TYPE_LINESTRING: - case static::PHINX_TYPE_POLYGON: - return ['name' => $type]; - case static::PHINX_TYPE_DATETIME: - case static::PHINX_TYPE_TIMESTAMP: - case static::PHINX_TYPE_TIME: - return ['name' => $type, 'limit' => $limit]; - case static::PHINX_TYPE_STRING: - return ['name' => 'varchar', 'limit' => $limit ?: 255]; - case static::PHINX_TYPE_CHAR: - return ['name' => 'char', 'limit' => $limit ?: 255]; - case static::PHINX_TYPE_TEXT: - if ($limit) { - $sizes = [ - // Order matters! Size must always be tested from longest to shortest! - 'longtext' => static::TEXT_LONG, - 'mediumtext' => static::TEXT_MEDIUM, - 'text' => static::TEXT_REGULAR, - 'tinytext' => static::TEXT_SMALL, - ]; - foreach ($sizes as $name => $length) { - if ($limit >= $length) { - return ['name' => $name]; - } - } - } - - return ['name' => 'text']; - case static::PHINX_TYPE_BINARY: - if ($limit === null) { - $limit = 255; - } - - if ($limit > 255) { - return $this->getSqlType(static::PHINX_TYPE_BLOB, $limit); - } - - return ['name' => 'binary', 'limit' => $limit]; - case static::PHINX_TYPE_BINARYUUID: - return ['name' => 'binary', 'limit' => 16]; - case static::PHINX_TYPE_VARBINARY: - if ($limit === null) { - $limit = 255; - } - - if ($limit > 255) { - return $this->getSqlType(static::PHINX_TYPE_BLOB, $limit); - } - - return ['name' => 'varbinary', 'limit' => $limit]; - case static::PHINX_TYPE_BLOB: - if ($limit !== null) { - // Rework this part as the choosen types were always UNDER the required length - $sizes = [ - 'tinyblob' => static::BLOB_SMALL, - 'blob' => static::BLOB_REGULAR, - 'mediumblob' => static::BLOB_MEDIUM, - ]; - - foreach ($sizes as $name => $length) { - if ($limit <= $length) { - return ['name' => $name]; - } - } - - // For more length requirement, the longblob is used - return ['name' => 'longblob']; - } - - // If not limit is provided, fallback on blob - return ['name' => 'blob']; - case static::PHINX_TYPE_TINYBLOB: - // Automatically reprocess blob type to ensure that correct blob subtype is selected given provided limit - return $this->getSqlType(static::PHINX_TYPE_BLOB, $limit ?: static::BLOB_TINY); - case static::PHINX_TYPE_MEDIUMBLOB: - // Automatically reprocess blob type to ensure that correct blob subtype is selected given provided limit - return $this->getSqlType(static::PHINX_TYPE_BLOB, $limit ?: static::BLOB_MEDIUM); - case static::PHINX_TYPE_LONGBLOB: - // Automatically reprocess blob type to ensure that correct blob subtype is selected given provided limit - return $this->getSqlType(static::PHINX_TYPE_BLOB, $limit ?: static::BLOB_LONG); - case static::PHINX_TYPE_BIT: - return ['name' => 'bit', 'limit' => $limit ?: 64]; - case static::PHINX_TYPE_BIG_INTEGER: - if ($limit === static::INT_BIG) { - $limit = static::INT_DISPLAY_BIG; - } - - return ['name' => 'bigint', 'limit' => $limit ?: 20]; - case static::PHINX_TYPE_MEDIUM_INTEGER: - if ($limit === static::INT_MEDIUM) { - $limit = static::INT_DISPLAY_MEDIUM; - } - - return ['name' => 'mediumint', 'limit' => $limit ?: 8]; - case static::PHINX_TYPE_SMALL_INTEGER: - if ($limit === static::INT_SMALL) { - $limit = static::INT_DISPLAY_SMALL; - } - - return ['name' => 'smallint', 'limit' => $limit ?: 6]; - case static::PHINX_TYPE_TINY_INTEGER: - if ($limit === static::INT_TINY) { - $limit = static::INT_DISPLAY_TINY; - } - - return ['name' => 'tinyint', 'limit' => $limit ?: 4]; - case static::PHINX_TYPE_INTEGER: - if ($limit && $limit >= static::INT_TINY) { - $sizes = [ - // Order matters! Size must always be tested from longest to shortest! - 'bigint' => static::INT_BIG, - 'int' => static::INT_REGULAR, - 'mediumint' => static::INT_MEDIUM, - 'smallint' => static::INT_SMALL, - 'tinyint' => static::INT_TINY, - ]; - $limits = [ - 'tinyint' => static::INT_DISPLAY_TINY, - 'smallint' => static::INT_DISPLAY_SMALL, - 'mediumint' => static::INT_DISPLAY_MEDIUM, - 'int' => static::INT_DISPLAY_REGULAR, - 'bigint' => static::INT_DISPLAY_BIG, - ]; - foreach ($sizes as $name => $length) { - if ($limit >= $length) { - $def = ['name' => $name]; - if (isset($limits[$name])) { - $def['limit'] = $limits[$name]; - } - - return $def; - } - } - } elseif (!$limit) { - $limit = static::INT_DISPLAY_REGULAR; - } - - return ['name' => 'int', 'limit' => $limit]; - case static::PHINX_TYPE_BOOLEAN: - return ['name' => 'tinyint', 'limit' => 1]; - case static::PHINX_TYPE_UUID: - return ['name' => 'char', 'limit' => 36]; - case static::PHINX_TYPE_YEAR: - if (!$limit || in_array($limit, [2, 4])) { - $limit = 4; - } - - return ['name' => 'year', 'limit' => $limit]; - default: - throw new UnsupportedColumnTypeException('Column type "' . $type . '" is not supported by MySQL.'); - } - } - - /** - * Returns Phinx type by SQL type - * - * @internal param string $sqlType SQL type - * @param string $sqlTypeDef SQL Type definition - * @throws \Phinx\Db\Adapter\UnsupportedColumnTypeException - * @return array Phinx type - */ - public function getPhinxType(string $sqlTypeDef): array - { - $matches = []; - if (!preg_match('/^([\w]+)(\(([\d]+)*(,([\d]+))*\))*(.+)*$/', $sqlTypeDef, $matches)) { - throw new UnsupportedColumnTypeException('Column type "' . $sqlTypeDef . '" is not supported by MySQL.'); - } - - $limit = null; - $scale = null; - $type = $matches[1]; - if (count($matches) > 2) { - $limit = $matches[3] ? (int)$matches[3] : null; - } - if (count($matches) > 4) { - $scale = (int)$matches[5]; - } - if ($type === 'tinyint' && $limit === 1) { - $type = static::PHINX_TYPE_BOOLEAN; - $limit = null; - } - switch ($type) { - case 'varchar': - $type = static::PHINX_TYPE_STRING; - if ($limit === 255) { - $limit = null; - } - break; - case 'char': - $type = static::PHINX_TYPE_CHAR; - if ($limit === 255) { - $limit = null; - } - if ($limit === 36) { - $type = static::PHINX_TYPE_UUID; - } - break; - case 'tinyint': - $type = static::PHINX_TYPE_TINY_INTEGER; - break; - case 'smallint': - $type = static::PHINX_TYPE_SMALL_INTEGER; - break; - case 'mediumint': - $type = static::PHINX_TYPE_MEDIUM_INTEGER; - break; - case 'int': - $type = static::PHINX_TYPE_INTEGER; - break; - case 'bigint': - $type = static::PHINX_TYPE_BIG_INTEGER; - break; - case 'bit': - $type = static::PHINX_TYPE_BIT; - if ($limit === 64) { - $limit = null; - } - break; - case 'blob': - $type = static::PHINX_TYPE_BLOB; - $limit = static::BLOB_REGULAR; - break; - case 'tinyblob': - $type = static::PHINX_TYPE_TINYBLOB; - $limit = static::BLOB_TINY; - break; - case 'mediumblob': - $type = static::PHINX_TYPE_MEDIUMBLOB; - $limit = static::BLOB_MEDIUM; - break; - case 'longblob': - $type = static::PHINX_TYPE_LONGBLOB; - $limit = static::BLOB_LONG; - break; - case 'tinytext': - $type = static::PHINX_TYPE_TEXT; - $limit = static::TEXT_TINY; - break; - case 'mediumtext': - $type = static::PHINX_TYPE_TEXT; - $limit = static::TEXT_MEDIUM; - break; - case 'longtext': - $type = static::PHINX_TYPE_TEXT; - $limit = static::TEXT_LONG; - break; - case 'binary': - if ($limit === null) { - $limit = 255; - } - - if ($limit > 255) { - $type = static::PHINX_TYPE_BLOB; - break; - } - - if ($limit === 16) { - $type = static::PHINX_TYPE_BINARYUUID; - } - break; - } - - try { - // Call this to check if parsed type is supported. - $this->getSqlType($type, $limit); - } catch (UnsupportedColumnTypeException $e) { - $type = Literal::from($type); - } - - $phinxType = [ - 'name' => $type, - 'limit' => $limit, - 'scale' => $scale, - ]; - - if ($type === static::PHINX_TYPE_ENUM || $type === static::PHINX_TYPE_SET) { - $values = trim($matches[6], '()'); - $phinxType['values'] = []; - $opened = false; - $escaped = false; - $wasEscaped = false; - $value = ''; - $valuesLength = strlen($values); - for ($i = 0; $i < $valuesLength; $i++) { - $char = $values[$i]; - if ($char === "'" && !$opened) { - $opened = true; - } elseif ( - !$escaped - && ($i + 1) < $valuesLength - && ( - $char === "'" && $values[$i + 1] === "'" - || $char === '\\' && $values[$i + 1] === '\\' - ) - ) { - $escaped = true; - } elseif ($char === "'" && $opened && !$escaped) { - $phinxType['values'][] = $value; - $value = ''; - $opened = false; - } elseif (($char === "'" || $char === '\\') && $opened && $escaped) { - $value .= $char; - $escaped = false; - $wasEscaped = true; - } elseif ($opened) { - if ($values[$i - 1] === '\\' && !$wasEscaped) { - if ($char === 'n') { - $char = "\n"; - } elseif ($char === 'r') { - $char = "\r"; - } elseif ($char === 't') { - $char = "\t"; - } - if ($values[$i] !== $char) { - $value = substr($value, 0, strlen($value) - 1); - } - } - $value .= $char; - $wasEscaped = false; - } - } - } - - return $phinxType; - } - - /** - * @inheritDoc - */ - public function createDatabase(string $name, array $options = []): void - { - $charset = $options['charset'] ?? 'utf8'; - - if (isset($options['collation'])) { - $this->execute(sprintf( - 'CREATE DATABASE %s DEFAULT CHARACTER SET `%s` COLLATE `%s`', - $this->quoteColumnName($name), - $charset, - $options['collation'], - )); - } else { - $this->execute(sprintf('CREATE DATABASE %s DEFAULT CHARACTER SET `%s`', $this->quoteColumnName($name), $charset)); - } - } - - /** - * @inheritDoc - */ - public function hasDatabase(string $name): bool - { - $rows = $this->fetchAll( - sprintf( - 'SELECT SCHEMA_NAME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = \'%s\'', - $name, - ), - ); - - foreach ($rows as $row) { - if (!empty($row)) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - public function dropDatabase(string $name): void - { - $this->execute(sprintf('DROP DATABASE IF EXISTS %s', $this->quoteColumnName($name))); - $this->createdTables = []; - } - - /** - * Gets the MySQL Column Definition for a Column object. - * - * @param \Phinx\Db\Table\Column $column Column - * @return string - */ - protected function getColumnSqlDefinition(Column $column): string - { - if ($column->getType() instanceof Literal) { - $def = (string)$column->getType(); - } else { - $sqlType = $this->getSqlType($column->getType(), $column->getLimit()); - $def = strtoupper($sqlType['name']); - } - if ($column->getPrecision() && $column->getScale()) { - $def .= '(' . $column->getPrecision() . ',' . $column->getScale() . ')'; - } elseif (isset($sqlType['limit'])) { - $def .= '(' . $sqlType['limit'] . ')'; - } - - $values = $column->getValues(); - if ($values && is_array($values)) { - $def .= '(' . implode(', ', array_map(function ($value) { - // we special case NULL as it's not actually allowed an enum value, - // and we want MySQL to issue an error on the create statement, but - // quote coerces it to an empty string, which will not error - return $value === null ? 'NULL' : $this->getConnection()->quote($value); - }, $values)) . ')'; - } - - $def .= $column->getEncoding() ? ' CHARACTER SET ' . $column->getEncoding() : ''; - $def .= $column->getCollation() ? ' COLLATE ' . $column->getCollation() : ''; - $def .= !$column->isSigned() && isset($this->signedColumnTypes[$column->getType()]) ? ' unsigned' : ''; - $def .= $column->isNull() ? ' NULL' : ' NOT NULL'; - - if ( - version_compare($this->getAttribute(PDO::ATTR_SERVER_VERSION), '8', '>=') - && in_array($column->getType(), static::PHINX_TYPES_GEOSPATIAL) - && !is_null($column->getSrid()) - ) { - $def .= " SRID {$column->getSrid()}"; - } - - $def .= $column->isIdentity() ? ' AUTO_INCREMENT' : ''; - - $default = $column->getDefault(); - // MySQL 8 supports setting default for the following tested types, but only if they are "cast as expressions" - if ( - version_compare($this->getAttribute(PDO::ATTR_SERVER_VERSION), '8', '>=') && - is_string($default) && - in_array( - $column->getType(), - array_merge( - static::PHINX_TYPES_GEOSPATIAL, - [static::PHINX_TYPE_BLOB, static::PHINX_TYPE_JSON, static::PHINX_TYPE_TEXT], - ), - ) - ) { - $default = Literal::from('(' . $this->getConnection()->quote($column->getDefault()) . ')'); - } - $def .= $this->getDefaultValueDefinition($default, $column->getType()); - - if ($column->getComment()) { - $def .= ' COMMENT ' . $this->getConnection()->quote($column->getComment()); - } - - if ($column->getUpdate()) { - $def .= ' ON UPDATE ' . $column->getUpdate(); - } - - return $def; - } - - /** - * Gets the MySQL Index Definition for an Index object. - * - * @param \Phinx\Db\Table\Index $index Index - * @return string - */ - protected function getIndexSqlDefinition(Index $index): string - { - $def = ''; - $limit = ''; - - if ($index->getType() === Index::UNIQUE) { - $def .= ' UNIQUE'; - } - - if ($index->getType() === Index::FULLTEXT) { - $def .= ' FULLTEXT'; - } - - $def .= ' KEY'; - - if (is_string($index->getName())) { - $def .= ' `' . $index->getName() . '`'; - } - - $columnNames = $index->getColumns(); - $order = $index->getOrder() ?? []; - $columnNames = array_map(function ($columnName) use ($order) { - $ret = '`' . $columnName . '`'; - if (isset($order[$columnName])) { - $ret .= ' ' . $order[$columnName]; - } - - return $ret; - }, $columnNames); - - if (!is_array($index->getLimit())) { - if ($index->getLimit()) { - $limit = '(' . $index->getLimit() . ')'; - } - $def .= ' (' . implode(',', $columnNames) . $limit . ')'; - } else { - $columns = $index->getColumns(); - $limits = $index->getLimit(); - $def .= ' ('; - foreach ($columns as $column) { - $limit = !isset($limits[$column]) || $limits[$column] <= 0 ? '' : '(' . $limits[$column] . ')'; - $columnSort = isset($order[$column]) ?? ''; - $def .= '`' . $column . '`' . $limit . ' ' . $columnSort . ', '; - } - $def = rtrim($def, ', '); - $def .= ' )'; - } - - return $def; - } - - /** - * Gets the MySQL Foreign Key Definition for an ForeignKey object. - * - * @param \Phinx\Db\Table\ForeignKey $foreignKey Foreign key - * @return string - */ - protected function getForeignKeySqlDefinition(ForeignKey $foreignKey): string - { - $def = ''; - if ($foreignKey->getConstraint()) { - $def .= ' CONSTRAINT ' . $this->quoteColumnName($foreignKey->getConstraint()); - } - $columnNames = []; - foreach ($foreignKey->getColumns() as $column) { - $columnNames[] = $this->quoteColumnName($column); - } - $def .= ' FOREIGN KEY (' . implode(',', $columnNames) . ')'; - $refColumnNames = []; - foreach ($foreignKey->getReferencedColumns() as $column) { - $refColumnNames[] = $this->quoteColumnName($column); - } - $def .= ' REFERENCES ' . $this->quoteTableName($foreignKey->getReferencedTable()->getName()) . ' (' . implode(',', $refColumnNames) . ')'; - if ($foreignKey->getOnDelete()) { - $def .= ' ON DELETE ' . $foreignKey->getOnDelete(); - } - if ($foreignKey->getOnUpdate()) { - $def .= ' ON UPDATE ' . $foreignKey->getOnUpdate(); - } - - return $def; - } - - /** - * Describes a database table. This is a MySQL adapter specific method. - * - * @param string $tableName Table name - * @return array - */ - public function describeTable(string $tableName): array - { - $options = $this->getOptions(); - - // mysql specific - $sql = sprintf( - "SELECT * - FROM information_schema.tables - WHERE table_schema = '%s' - AND table_name = '%s'", - $options['name'], - $tableName, - ); - - $table = $this->fetchRow($sql); - - return $table !== false ? $table : []; - } - - /** - * Returns MySQL column types (inherited and MySQL specified). - * - * @return string[] - */ - public function getColumnTypes(): array - { - return array_merge(parent::getColumnTypes(), static::$specificColumnTypes); - } - - /** - * @inheritDoc - */ - public function getDecoratedConnection(): Connection - { - if (isset($this->decoratedConnection)) { - return $this->decoratedConnection; - } - - $options = $this->getOptions(); - $options = [ - 'username' => $options['user'] ?? null, - 'password' => $options['pass'] ?? null, - 'database' => $options['name'], - 'quoteIdentifiers' => true, - ] + $options; - - return $this->decoratedConnection = $this->buildConnection(MysqlDriver::class, $options); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/PdoAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/PdoAdapter.php deleted file mode 100644 index 46e6b0870..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/PdoAdapter.php +++ /dev/null @@ -1,1129 +0,0 @@ -isDryRunEnabled() && - $this->getOutput()->getVerbosity() < OutputInterface::VERBOSITY_VERY_VERBOSE - ) { - return; - } - - $this->getOutput()->writeln($message); - } - - /** - * Create PDO connection - * - * @param string $dsn Connection string - * @param string|null $username Database username - * @param string|null $password Database password - * @param array $options Connection options - * @return \PDO - */ - protected function createPdoConnection( - string $dsn, - ?string $username = null, - #[SensitiveParameter] - ?string $password = null, - array $options = [], - ): PDO { - $adapterOptions = $this->getOptions() + [ - 'attr_errmode' => PDO::ERRMODE_EXCEPTION, - ]; - - try { - $db = new PDO($dsn, $username, $password, $options); - - foreach ($adapterOptions as $key => $option) { - if (strpos($key, 'attr_') === 0) { - $pdoConstant = '\PDO::' . strtoupper($key); - if (!defined($pdoConstant)) { - throw new UnexpectedValueException('Invalid PDO attribute: ' . $key . ' (' . $pdoConstant . ')'); - } - $db->setAttribute(constant($pdoConstant), $option); - } - } - } catch (PDOException $e) { - throw new InvalidArgumentException(sprintf( - 'There was a problem connecting to the database: %s', - $e->getMessage(), - ), 0, $e); - } - - return $db; - } - - /** - * @inheritDoc - */ - public function setOptions(array $options): AdapterInterface - { - parent::setOptions($options); - - if (isset($options['connection'])) { - $this->setConnection($options['connection']); - } - - return $this; - } - - /** - * Sets the database connection. - * - * @param \PDO $connection Connection - * @return \Phinx\Db\Adapter\AdapterInterface - */ - public function setConnection(PDO $connection): AdapterInterface - { - $this->connection = $connection; - - // Create the schema table if it doesn't already exist - if (!$this->hasTable($this->getSchemaTableName())) { - $this->createSchemaTable(); - } else { - $table = new DbTable($this->getSchemaTableName(), [], $this); - if (!$table->hasColumn('migration_name')) { - $table - ->addColumn( - 'migration_name', - 'string', - ['limit' => 100, 'after' => 'version', 'default' => null, 'null' => true], - ) - ->save(); - } - if (!$table->hasColumn('breakpoint')) { - $table - ->addColumn('breakpoint', 'boolean', ['default' => false, 'null' => false]) - ->save(); - } - } - - return $this; - } - - /** - * Gets the database connection - * - * @return \PDO - */ - public function getConnection(): PDO - { - if ($this->connection === null) { - $this->connect(); - } - - return $this->connection; - } - - /** - * @inheritDoc - */ - abstract public function connect(): void; - - /** - * @inheritDoc - */ - abstract public function disconnect(): void; - - /** - * @inheritDoc - */ - public function execute(string $sql, array $params = []): int - { - $sql = rtrim($sql, "; \t\n\r\0\x0B"); - $this->verboseLog($sql . ';'); - - if ($this->isDryRunEnabled()) { - return 0; - } - - if (empty($params)) { - return $this->getConnection()->exec($sql); - } - - $stmt = $this->getConnection()->prepare($sql); - $result = $stmt->execute($params); - - return $result ? $stmt->rowCount() : $result; - } - - /** - * Returns the Cake\Database connection object using the same underlying - * PDO object as this connection. - * - * @return \Cake\Database\Connection - */ - abstract public function getDecoratedConnection(): Connection; - - /** - * Build connection instance. - * - * @param class-string<\Cake\Database\Driver> $driverClass Driver class name. - * @param array $options Options. - * @return \Cake\Database\Connection - */ - protected function buildConnection(string $driverClass, array $options): Connection - { - $driver = new $driverClass($options); - $prop = new ReflectionProperty($driver, 'pdo'); - $prop->setValue($driver, $this->connection); - - return new Connection(['driver' => $driver] + $options); - } - - /** - * @inheritDoc - */ - public function getQueryBuilder(string $type): Query - { - return match ($type) { - Query::TYPE_SELECT => $this->getDecoratedConnection()->selectQuery(), - Query::TYPE_INSERT => $this->getDecoratedConnection()->insertQuery(), - Query::TYPE_UPDATE => $this->getDecoratedConnection()->updateQuery(), - Query::TYPE_DELETE => $this->getDecoratedConnection()->deleteQuery(), - default => throw new InvalidArgumentException( - 'Query type must be one of: `select`, `insert`, `update`, `delete`.', - ) - }; - } - - /** - * @inheritDoc - */ - public function getSelectBuilder(): SelectQuery - { - return $this->getDecoratedConnection()->selectQuery(); - } - - /** - * @inheritDoc - */ - public function getInsertBuilder(): InsertQuery - { - return $this->getDecoratedConnection()->insertQuery(); - } - - /** - * @inheritDoc - */ - public function getUpdateBuilder(): UpdateQuery - { - return $this->getDecoratedConnection()->updateQuery(); - } - - /** - * @inheritDoc - */ - public function getDeleteBuilder(): DeleteQuery - { - return $this->getDecoratedConnection()->deleteQuery(); - } - - /** - * Executes a query and returns PDOStatement. - * - * @param string $sql SQL - * @return mixed - */ - public function query(string $sql, array $params = []): mixed - { - if (empty($params)) { - return $this->getConnection()->query($sql); - } - $stmt = $this->getConnection()->prepare($sql); - $result = $stmt->execute($params); - - return $result ? $stmt : false; - } - - /** - * @inheritDoc - */ - public function fetchRow(string $sql): array|false - { - return $this->query($sql)->fetch(); - } - - /** - * @inheritDoc - */ - public function fetchAll(string $sql): array - { - return $this->query($sql)->fetchAll(); - } - - /** - * Get the parameters array for prepared insert statement - * - * @param array $params Parameters array to be filled - * @param array $row Row to be inserted into DB - */ - protected function getInsertParameters(array &$params, array $row): void - { - foreach ($row as $value) { - if ($value instanceof Literal) { - continue; - } elseif ($value instanceof DateTime) { - $params[] = $value->toDateTimeString(); - } elseif ($value instanceof Date) { - $params[] = $value->toDateString(); - } elseif (is_bool($value)) { - $params[] = $this->castToBool($value); - } else { - $params[] = $value; - } - } - } - - /** - * @inheritDoc - */ - public function insert(Table $table, array $row): void - { - $sql = sprintf( - 'INSERT INTO %s ', - $this->quoteTableName($table->getName()), - ); - $columns = array_keys($row); - $sql .= '(' . implode(', ', array_map([$this, 'quoteColumnName'], $columns)) . ') ' . $this->getInsertOverride() . 'VALUES '; - - foreach ($row as $column => $value) { - if (is_bool($value)) { - $row[$column] = $this->castToBool($value); - } - } - - if ($this->isDryRunEnabled()) { - $sql .= '(' . implode(', ', array_map([$this, 'quoteValue'], $row)) . ');'; - $this->output->writeln($sql); - } else { - $sql .= '('; - $values = []; - foreach ($row as $value) { - $values[] = $value instanceof Literal ? (string)$value : '?'; - } - $params = []; - $this->getInsertParameters($params, $row); - $sql .= implode(', ', $values) . ')'; - $stmt = $this->getConnection()->prepare($sql); - $stmt->execute($params); - } - } - - /** - * Quotes a database value. - * - * @param mixed $value The value to quote - * @return mixed - */ - protected function quoteValue(mixed $value): mixed - { - if (is_numeric($value)) { - return $value; - } - - if (is_bool($value)) { - return $this->castToBool($value); - } - - if ($value === null) { - return 'null'; - } - - if ($value instanceof Literal) { - return (string)$value; - } - - if ($value instanceof DateTime) { - $value = $value->toDateTimeString(); - } elseif ($value instanceof Date) { - $value = $value->toDateString(); - } - - return $this->getConnection()->quote($value); - } - - /** - * Quotes a database string. - * - * @param string $value The string to quote - * @return string - */ - protected function quoteString(string $value): string - { - return $this->getConnection()->quote($value); - } - - /** - * @inheritDoc - */ - public function bulkinsert(Table $table, array $rows): void - { - $sql = sprintf( - 'INSERT INTO %s ', - $this->quoteTableName($table->getName()), - ); - $current = current($rows); - $keys = array_keys($current); - $sql .= '(' . implode(', ', array_map([$this, 'quoteColumnName'], $keys)) . ') ' . $this->getInsertOverride() . 'VALUES '; - - if ($this->isDryRunEnabled()) { - $values = array_map(function ($row) { - return '(' . implode(', ', array_map([$this, 'quoteValue'], $row)) . ')'; - }, $rows); - $sql .= implode(', ', $values) . ';'; - $this->output->writeln($sql); - } else { - $queries = []; - foreach ($rows as $row) { - $values = []; - foreach ($row as $value) { - $values[] = $value instanceof Literal ? (string)$value : '?'; - } - $queries[] = '(' . implode(', ', $values) . ')'; - } - $sql .= implode(',', $queries); - $stmt = $this->getConnection()->prepare($sql); - - $params = []; - foreach ($rows as $row) { - $this->getInsertParameters($params, $row); - } - - $stmt->execute($params); - } - } - - /** - * Returns override clause for insert operations, to be befort `VALUES` keyword. - * - * @return string - */ - protected function getInsertOverride(): string - { - return ''; - } - - /** - * @inheritDoc - */ - public function getVersions(): array - { - $rows = $this->getVersionLog(); - - return array_keys($rows); - } - - /** - * {@inheritDoc} - * - * @throws \RuntimeException - */ - public function getVersionLog(): array - { - $result = []; - - switch ($this->options['version_order']) { - case Config::VERSION_ORDER_CREATION_TIME: - $orderBy = 'version ASC'; - break; - case Config::VERSION_ORDER_EXECUTION_TIME: - $orderBy = 'start_time ASC, version ASC'; - break; - default: - throw new RuntimeException('Invalid version_order configuration option'); - } - - // This will throw an exception if doing a --dry-run without any migrations as phinxlog - // does not exist, so in that case, we can just expect to trivially return empty set - try { - $rows = $this->fetchAll(sprintf('SELECT * FROM %s ORDER BY %s', $this->quoteTableName($this->getSchemaTableName()), $orderBy)); - } catch (PDOException $e) { - if (!$this->isDryRunEnabled()) { - throw $e; - } - $rows = []; - } - - foreach ($rows as $version) { - $result[(int)$version['version']] = $version; - } - - return $result; - } - - /** - * @inheritDoc - */ - public function migrated(MigrationInterface $migration, string $direction, string $startTime, string $endTime): AdapterInterface - { - if (strcasecmp($direction, MigrationInterface::UP) === 0) { - // up - $sql = sprintf( - "INSERT INTO %s (%s, %s, %s, %s, %s) VALUES ('%s', '%s', '%s', '%s', %s);", - $this->quoteTableName($this->getSchemaTableName()), - $this->quoteColumnName('version'), - $this->quoteColumnName('migration_name'), - $this->quoteColumnName('start_time'), - $this->quoteColumnName('end_time'), - $this->quoteColumnName('breakpoint'), - $migration->getVersion(), - substr($migration->getName(), 0, 100), - $startTime, - $endTime, - $this->castToBool(false), - ); - - $this->execute($sql); - } else { - // down - $sql = sprintf( - "DELETE FROM %s WHERE %s = '%s'", - $this->quoteTableName($this->getSchemaTableName()), - $this->quoteColumnName('version'), - $migration->getVersion(), - ); - - $this->execute($sql); - } - - return $this; - } - - /** - * @inheritDoc - */ - public function toggleBreakpoint(MigrationInterface $migration): AdapterInterface - { - $this->query( - sprintf( - 'UPDATE %1$s SET %2$s = CASE %2$s WHEN %3$s THEN %4$s ELSE %3$s END, %7$s = %7$s WHERE %5$s = \'%6$s\';', - $this->quoteTableName($this->getSchemaTableName()), - $this->quoteColumnName('breakpoint'), - $this->castToBool(true), - $this->castToBool(false), - $this->quoteColumnName('version'), - $migration->getVersion(), - $this->quoteColumnName('start_time'), - ), - ); - - return $this; - } - - /** - * @inheritDoc - */ - public function resetAllBreakpoints(): int - { - return $this->execute( - sprintf( - 'UPDATE %1$s SET %2$s = %3$s, %4$s = %4$s WHERE %2$s <> %3$s;', - $this->quoteTableName($this->getSchemaTableName()), - $this->quoteColumnName('breakpoint'), - $this->castToBool(false), - $this->quoteColumnName('start_time'), - ), - ); - } - - /** - * @inheritDoc - */ - public function setBreakpoint(MigrationInterface $migration): AdapterInterface - { - $this->markBreakpoint($migration, true); - - return $this; - } - - /** - * @inheritDoc - */ - public function unsetBreakpoint(MigrationInterface $migration): AdapterInterface - { - $this->markBreakpoint($migration, false); - - return $this; - } - - /** - * Mark a migration breakpoint. - * - * @param \Phinx\Migration\MigrationInterface $migration The migration target for the breakpoint - * @param bool $state The required state of the breakpoint - * @return \Phinx\Db\Adapter\AdapterInterface - */ - protected function markBreakpoint(MigrationInterface $migration, bool $state): AdapterInterface - { - $this->query( - sprintf( - 'UPDATE %1$s SET %2$s = %3$s, %4$s = %4$s WHERE %5$s = \'%6$s\';', - $this->quoteTableName($this->getSchemaTableName()), - $this->quoteColumnName('breakpoint'), - $this->castToBool($state), - $this->quoteColumnName('start_time'), - $this->quoteColumnName('version'), - $migration->getVersion(), - ), - ); - - return $this; - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function createSchema(string $schemaName = 'public'): void - { - throw new BadMethodCallException('Creating a schema is not supported'); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropSchema(string $name): void - { - throw new BadMethodCallException('Dropping a schema is not supported'); - } - - /** - * @inheritDoc - */ - public function getColumnTypes(): array - { - return [ - 'string', - 'char', - 'text', - 'tinyinteger', - 'smallinteger', - 'integer', - 'biginteger', - 'bit', - 'float', - 'decimal', - 'double', - 'datetime', - 'timestamp', - 'time', - 'date', - 'blob', - 'binary', - 'varbinary', - 'boolean', - 'uuid', - // Geospatial data types - 'geometry', - 'point', - 'linestring', - 'polygon', - ]; - } - - /** - * @inheritDoc - */ - public function castToBool($value): mixed - { - return (bool)$value ? 1 : 0; - } - - /** - * Retrieve a database connection attribute - * - * @see https://php.net/manual/en/pdo.getattribute.php - * @param int $attribute One of the PDO::ATTR_* constants - * @return mixed - */ - public function getAttribute(int $attribute): mixed - { - return $this->connection->getAttribute($attribute); - } - - /** - * Get the definition for a `DEFAULT` statement. - * - * @param mixed $default Default value - * @param string|\Phinx\Util\Literal|null $columnType Column type - * @return string - */ - protected function getDefaultValueDefinition(mixed $default, string|Literal|null $columnType = null): string - { - if ($default instanceof Literal) { - $default = (string)$default; - } elseif (is_string($default) && stripos($default, 'CURRENT_TIMESTAMP') !== 0) { - // Ensure a defaults of CURRENT_TIMESTAMP(3) is not quoted. - $default = $this->getConnection()->quote($default); - } elseif (is_bool($default)) { - $default = $this->castToBool($default); - } elseif ($default !== null && (string)$columnType === static::PHINX_TYPE_BOOLEAN) { - $default = $this->castToBool((bool)$default); - } - - return isset($default) ? " DEFAULT $default" : ''; - } - - /** - * Executes all the ALTER TABLE instructions passed for the given table - * - * @param string $tableName The table name to use in the ALTER statement - * @param \Phinx\Db\Util\AlterInstructions $instructions The object containing the alter sequence - * @return void - */ - protected function executeAlterSteps(string $tableName, AlterInstructions $instructions): void - { - $alter = sprintf('ALTER TABLE %s %%s', $this->quoteTableName($tableName)); - $instructions->execute($alter, [$this, 'execute']); - } - - /** - * @inheritDoc - */ - public function addColumn(Table $table, Column $column): void - { - $instructions = $this->getAddColumnInstructions($table, $column); - $this->executeAlterSteps($table->getName(), $instructions); - } - - /** - * Returns the instructions to add the specified column to a database table. - * - * @param \Phinx\Db\Table\Table $table Table - * @param \Phinx\Db\Table\Column $column Column - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getAddColumnInstructions(Table $table, Column $column): AlterInstructions; - - /** - * @inheritdoc - */ - public function renameColumn(string $tableName, string $columnName, string $newColumnName): void - { - $instructions = $this->getRenameColumnInstructions($tableName, $columnName, $newColumnName); - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to rename the specified column. - * - * @param string $tableName Table name - * @param string $columnName Column Name - * @param string $newColumnName New Column Name - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getRenameColumnInstructions(string $tableName, string $columnName, string $newColumnName): AlterInstructions; - - /** - * @inheritdoc - */ - public function changeColumn(string $tableName, string $columnName, Column $newColumn): void - { - $instructions = $this->getChangeColumnInstructions($tableName, $columnName, $newColumn); - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to change a table column type. - * - * @param string $tableName Table name - * @param string $columnName Column Name - * @param \Phinx\Db\Table\Column $newColumn New Column - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getChangeColumnInstructions(string $tableName, string $columnName, Column $newColumn): AlterInstructions; - - /** - * @inheritdoc - */ - public function dropColumn(string $tableName, string $columnName): void - { - $instructions = $this->getDropColumnInstructions($tableName, $columnName); - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to drop the specified column. - * - * @param string $tableName Table name - * @param string $columnName Column Name - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getDropColumnInstructions(string $tableName, string $columnName): AlterInstructions; - - /** - * @inheritdoc - */ - public function addIndex(Table $table, Index $index): void - { - $instructions = $this->getAddIndexInstructions($table, $index); - $this->executeAlterSteps($table->getName(), $instructions); - } - - /** - * Returns the instructions to add the specified index to a database table. - * - * @param \Phinx\Db\Table\Table $table Table - * @param \Phinx\Db\Table\Index $index Index - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getAddIndexInstructions(Table $table, Index $index): AlterInstructions; - - /** - * @inheritdoc - */ - public function dropIndex(string $tableName, $columns): void - { - $instructions = $this->getDropIndexByColumnsInstructions($tableName, $columns); - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to drop the specified index from a database table. - * - * @param string $tableName The name of of the table where the index is - * @param string|string[] $columns Column(s) - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getDropIndexByColumnsInstructions(string $tableName, string|array $columns): AlterInstructions; - - /** - * @inheritdoc - */ - public function dropIndexByName(string $tableName, string $indexName): void - { - $instructions = $this->getDropIndexByNameInstructions($tableName, $indexName); - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to drop the index specified by name from a database table. - * - * @param string $tableName The table name whe the index is - * @param string $indexName The name of the index - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getDropIndexByNameInstructions(string $tableName, string $indexName): AlterInstructions; - - /** - * @inheritdoc - */ - public function addForeignKey(Table $table, ForeignKey $foreignKey): void - { - $instructions = $this->getAddForeignKeyInstructions($table, $foreignKey); - $this->executeAlterSteps($table->getName(), $instructions); - } - - /** - * Returns the instructions to adds the specified foreign key to a database table. - * - * @param \Phinx\Db\Table\Table $table The table to add the constraint to - * @param \Phinx\Db\Table\ForeignKey $foreignKey The foreign key to add - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getAddForeignKeyInstructions(Table $table, ForeignKey $foreignKey): AlterInstructions; - - /** - * @inheritDoc - */ - public function dropForeignKey(string $tableName, array $columns, ?string $constraint = null): void - { - if ($constraint) { - $instructions = $this->getDropForeignKeyInstructions($tableName, $constraint); - } else { - $instructions = $this->getDropForeignKeyByColumnsInstructions($tableName, $columns); - } - - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to drop the specified foreign key from a database table. - * - * @param string $tableName The table where the foreign key constraint is - * @param string $constraint Constraint name - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getDropForeignKeyInstructions(string $tableName, string $constraint): AlterInstructions; - - /** - * Returns the instructions to drop the specified foreign key from a database table. - * - * @param string $tableName The table where the foreign key constraint is - * @param string[] $columns The list of column names - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getDropForeignKeyByColumnsInstructions(string $tableName, array $columns): AlterInstructions; - - /** - * @inheritdoc - */ - public function dropTable(string $tableName): void - { - $instructions = $this->getDropTableInstructions($tableName); - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to drop the specified database table. - * - * @param string $tableName Table name - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getDropTableInstructions(string $tableName): AlterInstructions; - - /** - * @inheritdoc - */ - public function renameTable(string $tableName, string $newTableName): void - { - $instructions = $this->getRenameTableInstructions($tableName, $newTableName); - $this->executeAlterSteps($tableName, $instructions); - } - - /** - * Returns the instructions to rename the specified database table. - * - * @param string $tableName Table name - * @param string $newTableName New Name - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getRenameTableInstructions(string $tableName, string $newTableName): AlterInstructions; - - /** - * @inheritdoc - */ - public function changePrimaryKey(Table $table, $newColumns): void - { - $instructions = $this->getChangePrimaryKeyInstructions($table, $newColumns); - $this->executeAlterSteps($table->getName(), $instructions); - } - - /** - * Returns the instructions to change the primary key for the specified database table. - * - * @param \Phinx\Db\Table\Table $table Table - * @param string|string[]|null $newColumns Column name(s) to belong to the primary key, or null to drop the key - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getChangePrimaryKeyInstructions(Table $table, string|array|null $newColumns): AlterInstructions; - - /** - * @inheritdoc - */ - public function changeComment(Table $table, $newComment): void - { - $instructions = $this->getChangeCommentInstructions($table, $newComment); - $this->executeAlterSteps($table->getName(), $instructions); - } - - /** - * Returns the instruction to change the comment for the specified database table. - * - * @param \Phinx\Db\Table\Table $table Table - * @param string|null $newComment New comment string, or null to drop the comment - * @return \Phinx\Db\Util\AlterInstructions - */ - abstract protected function getChangeCommentInstructions(Table $table, ?string $newComment): AlterInstructions; - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - * @return void - */ - public function executeActions(Table $table, array $actions): void - { - $instructions = new AlterInstructions(); - - foreach ($actions as $action) { - switch (true) { - case $action instanceof AddColumn: - /** @var \Phinx\Db\Action\AddColumn $action */ - $instructions->merge($this->getAddColumnInstructions($table, $action->getColumn())); - break; - - case $action instanceof AddIndex: - /** @var \Phinx\Db\Action\AddIndex $action */ - $instructions->merge($this->getAddIndexInstructions($table, $action->getIndex())); - break; - - case $action instanceof AddForeignKey: - /** @var \Phinx\Db\Action\AddForeignKey $action */ - $instructions->merge($this->getAddForeignKeyInstructions($table, $action->getForeignKey())); - break; - - case $action instanceof ChangeColumn: - /** @var \Phinx\Db\Action\ChangeColumn $action */ - $instructions->merge($this->getChangeColumnInstructions( - $table->getName(), - $action->getColumnName(), - $action->getColumn(), - )); - break; - - case $action instanceof DropForeignKey && !$action->getForeignKey()->getConstraint(): - /** @var \Phinx\Db\Action\DropForeignKey $action */ - $instructions->merge($this->getDropForeignKeyByColumnsInstructions( - $table->getName(), - $action->getForeignKey()->getColumns(), - )); - break; - - case $action instanceof DropForeignKey && $action->getForeignKey()->getConstraint(): - /** @var \Phinx\Db\Action\DropForeignKey $action */ - $instructions->merge($this->getDropForeignKeyInstructions( - $table->getName(), - $action->getForeignKey()->getConstraint(), - )); - break; - - case $action instanceof DropIndex && $action->getIndex()->getName() !== null: - /** @var \Phinx\Db\Action\DropIndex $action */ - $instructions->merge($this->getDropIndexByNameInstructions( - $table->getName(), - $action->getIndex()->getName(), - )); - break; - - case $action instanceof DropIndex && $action->getIndex()->getName() == null: - /** @var \Phinx\Db\Action\DropIndex $action */ - $instructions->merge($this->getDropIndexByColumnsInstructions( - $table->getName(), - $action->getIndex()->getColumns(), - )); - break; - - case $action instanceof DropTable: - /** @var \Phinx\Db\Action\DropTable $action */ - $instructions->merge($this->getDropTableInstructions( - $table->getName(), - )); - break; - - case $action instanceof RemoveColumn: - /** @var \Phinx\Db\Action\RemoveColumn $action */ - $instructions->merge($this->getDropColumnInstructions( - $table->getName(), - $action->getColumn()->getName(), - )); - break; - - case $action instanceof RenameColumn: - /** @var \Phinx\Db\Action\RenameColumn $action */ - $instructions->merge($this->getRenameColumnInstructions( - $table->getName(), - $action->getColumn()->getName(), - $action->getNewName(), - )); - break; - - case $action instanceof RenameTable: - /** @var \Phinx\Db\Action\RenameTable $action */ - $instructions->merge($this->getRenameTableInstructions( - $table->getName(), - $action->getNewName(), - )); - break; - - case $action instanceof ChangePrimaryKey: - /** @var \Phinx\Db\Action\ChangePrimaryKey $action */ - $instructions->merge($this->getChangePrimaryKeyInstructions( - $table, - $action->getNewColumns(), - )); - break; - - case $action instanceof ChangeComment: - /** @var \Phinx\Db\Action\ChangeComment $action */ - $instructions->merge($this->getChangeCommentInstructions( - $table, - $action->getNewComment(), - )); - break; - - default: - throw new InvalidArgumentException( - sprintf("Don't know how to execute action: '%s'", get_class($action)), - ); - } - } - - $this->executeAlterSteps($table->getName(), $instructions); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/PostgresAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/PostgresAdapter.php deleted file mode 100644 index 865d36ba0..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/PostgresAdapter.php +++ /dev/null @@ -1,1617 +0,0 @@ -= 10.0) - * - * @var bool - */ - protected bool $useIdentity; - - /** - * @var string - */ - protected string $schema = 'public'; - - /** - * {@inheritDoc} - */ - public function setOptions(array $options): AdapterInterface - { - if (!empty($options['schema'])) { - $this->schema = $options['schema']; - } - - parent::setOptions($options); - - return $this; - } - - /** - * {@inheritDoc} - */ - public function setConnection(PDO $connection): AdapterInterface - { - // always set here since connect() isn't always called - $this->useIdentity = (float)$connection->getAttribute(PDO::ATTR_SERVER_VERSION) >= 10; - - return parent::setConnection($connection); - } - - /** - * {@inheritDoc} - * - * @throws \RuntimeException - * @throws \InvalidArgumentException - * @return void - */ - public function connect(): void - { - if ($this->connection === null) { - if (!class_exists('PDO') || !in_array('pgsql', PDO::getAvailableDrivers(), true)) { - // @codeCoverageIgnoreStart - throw new RuntimeException('You need to enable the PDO_Pgsql extension for Phinx to run properly.'); - // @codeCoverageIgnoreEnd - } - - $options = $this->getOptions(); - $dsn = 'pgsql:dbname=' . $options['name']; - - if (isset($options['host'])) { - $dsn .= ';host=' . $options['host']; - } - - // if custom port is specified use it - if (isset($options['port'])) { - $dsn .= ';port=' . $options['port']; - } - - $driverOptions = []; - - // use custom data fetch mode - if (!empty($options['fetch_mode'])) { - $driverOptions[PDO::ATTR_DEFAULT_FETCH_MODE] = - constant('\PDO::FETCH_' . strtoupper($options['fetch_mode'])); - } - - // pass \PDO::ATTR_PERSISTENT to driver options instead of useless setting it after instantiation - if (isset($options['attr_persistent'])) { - $driverOptions[PDO::ATTR_PERSISTENT] = $options['attr_persistent']; - } - - $db = $this->createPdoConnection($dsn, $options['user'] ?? null, $options['pass'] ?? null, $driverOptions); - - try { - if (isset($options['schema'])) { - $db->exec('SET search_path TO ' . $this->quoteSchemaName($options['schema'])); - } - } catch (PDOException $exception) { - throw new InvalidArgumentException( - sprintf('Schema does not exists: %s', $options['schema']), - 0, - $exception, - ); - } - - $this->setConnection($db); - } - } - - /** - * @inheritDoc - */ - public function disconnect(): void - { - $this->connection = null; - } - - /** - * @inheritDoc - */ - public function hasTransactions(): bool - { - return true; - } - - /** - * @inheritDoc - */ - public function beginTransaction(): void - { - $this->execute('BEGIN'); - } - - /** - * @inheritDoc - */ - public function commitTransaction(): void - { - $this->execute('COMMIT'); - } - - /** - * @inheritDoc - */ - public function rollbackTransaction(): void - { - $this->execute('ROLLBACK'); - } - - /** - * Quotes a schema name for use in a query. - * - * @param string $schemaName Schema Name - * @return string - */ - public function quoteSchemaName(string $schemaName): string - { - return $this->quoteColumnName($schemaName); - } - - /** - * @inheritDoc - */ - public function quoteTableName(string $tableName): string - { - $parts = $this->getSchemaName($tableName); - - return $this->quoteSchemaName($parts['schema']) . '.' . $this->quoteColumnName($parts['table']); - } - - /** - * @inheritDoc - */ - public function quoteColumnName(string $columnName): string - { - return '"' . $columnName . '"'; - } - - /** - * @inheritDoc - */ - public function hasTable(string $tableName): bool - { - if ($this->hasCreatedTable($tableName)) { - return true; - } - - $parts = $this->getSchemaName($tableName); - $result = $this->getConnection()->query( - sprintf( - 'SELECT * - FROM information_schema.tables - WHERE table_schema = %s - AND table_name = %s', - $this->getConnection()->quote($parts['schema']), - $this->getConnection()->quote($parts['table']), - ), - ); - - return $result->rowCount() === 1; - } - - /** - * @inheritDoc - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void - { - $queries = []; - - $options = $table->getOptions(); - $parts = $this->getSchemaName($table->getName()); - - // Add the default primary key - if (!isset($options['id']) || (isset($options['id']) && $options['id'] === true)) { - $options['id'] = 'id'; - } - - if (isset($options['id']) && is_string($options['id'])) { - // Handle id => "field_name" to support AUTO_INCREMENT - $column = new Column(); - $column->setName($options['id']) - ->setType('integer') - ->setOptions(['identity' => true]); - - array_unshift($columns, $column); - if (isset($options['primary_key']) && (array)$options['id'] !== (array)$options['primary_key']) { - throw new InvalidArgumentException('You cannot enable an auto incrementing ID field and a primary key'); - } - $options['primary_key'] = $options['id']; - } - - // TODO - process table options like collation etc - $sql = 'CREATE TABLE '; - $sql .= $this->quoteTableName($table->getName()) . ' ('; - - $this->columnsWithComments = []; - foreach ($columns as $column) { - $sql .= $this->quoteColumnName($column->getName()) . ' ' . $this->getColumnSqlDefinition($column); - if ($this->useIdentity && $column->getIdentity() && $column->getGenerated() !== null) { - $sql .= sprintf(' GENERATED %s AS IDENTITY', $column->getGenerated()); - } - $sql .= ', '; - - // set column comments, if needed - if ($column->getComment()) { - $this->columnsWithComments[] = $column; - } - } - - // set the primary key(s) - if (isset($options['primary_key'])) { - $sql = rtrim($sql); - $sql .= sprintf(' CONSTRAINT %s PRIMARY KEY (', $this->quoteColumnName($parts['table'] . '_pkey')); - if (is_string($options['primary_key'])) { // handle primary_key => 'id' - $sql .= $this->quoteColumnName($options['primary_key']); - } elseif (is_array($options['primary_key'])) { // handle primary_key => array('tag_id', 'resource_id') - $sql .= implode(',', array_map([$this, 'quoteColumnName'], $options['primary_key'])); - } - $sql .= ')'; - } else { - $sql = rtrim($sql, ', '); // no primary keys - } - - $sql .= ')'; - $queries[] = $sql; - - // process column comments - if (!empty($this->columnsWithComments)) { - foreach ($this->columnsWithComments as $column) { - $queries[] = $this->getColumnCommentSqlDefinition($column, $table->getName()); - } - } - - // set the indexes - if (!empty($indexes)) { - foreach ($indexes as $index) { - $queries[] = $this->getIndexSqlDefinition($index, $table->getName()); - } - } - - // process table comments - if (isset($options['comment'])) { - $queries[] = sprintf( - 'COMMENT ON TABLE %s IS %s', - $this->quoteTableName($table->getName()), - $this->getConnection()->quote($options['comment']), - ); - } - - foreach ($queries as $query) { - $this->execute($query); - } - - $this->addCreatedTable($table->getName()); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getChangePrimaryKeyInstructions(Table $table, $newColumns): AlterInstructions - { - $parts = $this->getSchemaName($table->getName()); - - $instructions = new AlterInstructions(); - - // Drop the existing primary key - $primaryKey = $this->getPrimaryKey($table->getName()); - if (!empty($primaryKey['constraint'])) { - $sql = sprintf( - 'DROP CONSTRAINT %s', - $this->quoteColumnName($primaryKey['constraint']), - ); - $instructions->addAlter($sql); - } - - // Add the new primary key - if (!empty($newColumns)) { - $sql = sprintf( - 'ADD CONSTRAINT %s PRIMARY KEY (', - $this->quoteColumnName($parts['table'] . '_pkey'), - ); - if (is_string($newColumns)) { // handle primary_key => 'id' - $sql .= $this->quoteColumnName($newColumns); - } elseif (is_array($newColumns)) { // handle primary_key => array('tag_id', 'resource_id') - $sql .= implode(',', array_map([$this, 'quoteColumnName'], $newColumns)); - } else { - throw new InvalidArgumentException(sprintf( - 'Invalid value for primary key: %s', - json_encode($newColumns), - )); - } - $sql .= ')'; - $instructions->addAlter($sql); - } - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getChangeCommentInstructions(Table $table, ?string $newComment): AlterInstructions - { - $instructions = new AlterInstructions(); - - // passing 'null' is to remove table comment - $newComment = $newComment !== null - ? $this->getConnection()->quote($newComment) - : 'NULL'; - $sql = sprintf( - 'COMMENT ON TABLE %s IS %s', - $this->quoteTableName($table->getName()), - $newComment, - ); - $instructions->addPostStep($sql); - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getRenameTableInstructions(string $tableName, string $newTableName): AlterInstructions - { - $this->updateCreatedTableName($tableName, $newTableName); - $sql = sprintf( - 'ALTER TABLE %s RENAME TO %s', - $this->quoteTableName($tableName), - $this->quoteColumnName($newTableName), - ); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - protected function getDropTableInstructions(string $tableName): AlterInstructions - { - $this->removeCreatedTable($tableName); - $sql = sprintf('DROP TABLE %s', $this->quoteTableName($tableName)); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - public function truncateTable(string $tableName): void - { - $sql = sprintf( - 'TRUNCATE TABLE %s RESTART IDENTITY', - $this->quoteTableName($tableName), - ); - - $this->execute($sql); - } - - /** - * @inheritDoc - */ - public function getColumns(string $tableName): array - { - $parts = $this->getSchemaName($tableName); - $columns = []; - $sql = sprintf( - 'SELECT column_name, data_type, udt_name, is_identity, is_nullable, - column_default, character_maximum_length, numeric_precision, numeric_scale, - datetime_precision - %s - FROM information_schema.columns - WHERE table_schema = %s AND table_name = %s - ORDER BY ordinal_position', - $this->useIdentity ? ', identity_generation' : '', - $this->getConnection()->quote($parts['schema']), - $this->getConnection()->quote($parts['table']), - ); - $columnsInfo = $this->fetchAll($sql); - foreach ($columnsInfo as $columnInfo) { - $isUserDefined = strtoupper(trim($columnInfo['data_type'])) === 'USER-DEFINED'; - - if ($isUserDefined) { - $columnType = Literal::from($columnInfo['udt_name']); - } else { - $columnType = $this->getPhinxType($columnInfo['data_type']); - } - - // If the default value begins with a ' or looks like a function mark it as literal - if (isset($columnInfo['column_default'][0]) && $columnInfo['column_default'][0] === "'") { - if (preg_match('/^\'(.*)\'::[^:]+$/', $columnInfo['column_default'], $match)) { - // '' and \' are replaced with a single ' - $columnDefault = preg_replace('/[\'\\\\]\'/', "'", $match[1]); - } else { - $columnDefault = Literal::from($columnInfo['column_default']); - } - } elseif ( - $columnInfo['column_default'] !== null && - preg_match('/^\D[a-z_\d]*\(.*\)$/', $columnInfo['column_default']) - ) { - $columnDefault = Literal::from($columnInfo['column_default']); - } else { - $columnDefault = $columnInfo['column_default']; - } - - $column = new Column(); - - $column->setName($columnInfo['column_name']) - ->setType($columnType) - ->setNull($columnInfo['is_nullable'] === 'YES') - ->setDefault($columnDefault) - ->setIdentity($columnInfo['is_identity'] === 'YES') - ->setScale($columnInfo['numeric_scale']); - - if ($this->useIdentity) { - $column->setGenerated($columnInfo['identity_generation']); - } - - if (preg_match('/\bwith time zone$/', $columnInfo['data_type'])) { - $column->setTimezone(true); - } - - if (isset($columnInfo['character_maximum_length'])) { - $column->setLimit($columnInfo['character_maximum_length']); - } - - if (in_array($columnType, [static::PHINX_TYPE_TIME, static::PHINX_TYPE_DATETIME], true)) { - $column->setPrecision($columnInfo['datetime_precision']); - } elseif ($columnType === self::PHINX_TYPE_DECIMAL) { - $column->setPrecision($columnInfo['numeric_precision']); - } - $columns[] = $column; - } - - return $columns; - } - - /** - * @inheritDoc - */ - public function hasColumn(string $tableName, string $columnName): bool - { - $parts = $this->getSchemaName($tableName); - $sql = sprintf( - 'SELECT count(*) - FROM information_schema.columns - WHERE table_schema = %s AND table_name = %s AND column_name = %s', - $this->getConnection()->quote($parts['schema']), - $this->getConnection()->quote($parts['table']), - $this->getConnection()->quote($columnName), - ); - - $result = $this->fetchRow($sql); - - return $result['count'] > 0; - } - - /** - * @inheritDoc - */ - protected function getAddColumnInstructions(Table $table, Column $column): AlterInstructions - { - $instructions = new AlterInstructions(); - $instructions->addAlter(sprintf( - 'ADD %s %s %s', - $this->quoteColumnName($column->getName()), - $this->getColumnSqlDefinition($column), - $column->isIdentity() && $column->getGenerated() !== null && $this->useIdentity ? - sprintf('GENERATED %s AS IDENTITY', $column->getGenerated()) : '', - )); - - if ($column->getComment()) { - $instructions->addPostStep($this->getColumnCommentSqlDefinition($column, $table->getName())); - } - - return $instructions; - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getRenameColumnInstructions( - string $tableName, - string $columnName, - string $newColumnName, - ): AlterInstructions { - $parts = $this->getSchemaName($tableName); - $sql = sprintf( - 'SELECT CASE WHEN COUNT(*) > 0 THEN 1 ELSE 0 END AS column_exists - FROM information_schema.columns - WHERE table_schema = %s AND table_name = %s AND column_name = %s', - $this->getConnection()->quote($parts['schema']), - $this->getConnection()->quote($parts['table']), - $this->getConnection()->quote($columnName), - ); - - $result = $this->fetchRow($sql); - if (!(bool)$result['column_exists']) { - throw new InvalidArgumentException("The specified column does not exist: $columnName"); - } - - $instructions = new AlterInstructions(); - $instructions->addPostStep( - sprintf( - 'ALTER TABLE %s RENAME COLUMN %s TO %s', - $this->quoteTableName($tableName), - $this->quoteColumnName($columnName), - $this->quoteColumnName($newColumnName), - ), - ); - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getChangeColumnInstructions( - string $tableName, - string $columnName, - Column $newColumn, - ): AlterInstructions { - $quotedColumnName = $this->quoteColumnName($columnName); - $instructions = new AlterInstructions(); - if ($newColumn->getType() === 'boolean') { - $sql = sprintf('ALTER COLUMN %s DROP DEFAULT', $quotedColumnName); - $instructions->addAlter($sql); - } - $sql = sprintf( - 'ALTER COLUMN %s TYPE %s', - $quotedColumnName, - $this->getColumnSqlDefinition($newColumn), - ); - if (in_array($newColumn->getType(), ['smallinteger', 'integer', 'biginteger'], true)) { - $sql .= sprintf( - ' USING (%s::bigint)', - $quotedColumnName, - ); - } - if ($newColumn->getType() === 'uuid') { - $sql .= sprintf( - ' USING (%s::uuid)', - $quotedColumnName, - ); - } - //NULL and DEFAULT cannot be set while changing column type - $sql = preg_replace('/ NOT NULL/', '', $sql); - $sql = preg_replace('/ NULL/', '', $sql); - //If it is set, DEFAULT is the last definition - $sql = preg_replace('/DEFAULT .*/', '', $sql); - if ($newColumn->getType() === 'boolean') { - $sql .= sprintf( - ' USING (CASE WHEN %s IS NULL THEN NULL WHEN %s::int=0 THEN FALSE ELSE TRUE END)', - $quotedColumnName, - $quotedColumnName, - ); - } - $instructions->addAlter($sql); - - $column = $this->getColumn($tableName, $columnName); - - if ($this->useIdentity) { - // process identity - $sql = sprintf( - 'ALTER COLUMN %s', - $quotedColumnName, - ); - if ($newColumn->isIdentity() && $newColumn->getGenerated() !== null) { - if ($column->isIdentity()) { - $sql .= sprintf(' SET GENERATED %s', $newColumn->getGenerated()); - } else { - $sql .= sprintf(' ADD GENERATED %s AS IDENTITY', $newColumn->getGenerated()); - } - } else { - $sql .= ' DROP IDENTITY IF EXISTS'; - } - $instructions->addAlter($sql); - } - - // process null - $sql = sprintf( - 'ALTER COLUMN %s', - $quotedColumnName, - ); - - if (!$newColumn->getIdentity() && !$column->getIdentity() && $newColumn->isNull()) { - $sql .= ' DROP NOT NULL'; - } else { - $sql .= ' SET NOT NULL'; - } - - $instructions->addAlter($sql); - - if ($newColumn->getDefault() !== null) { - $instructions->addAlter(sprintf( - 'ALTER COLUMN %s SET %s', - $quotedColumnName, - $this->getDefaultValueDefinition($newColumn->getDefault(), $newColumn->getType()), - )); - } elseif (!$newColumn->getIdentity()) { - //drop default - $instructions->addAlter(sprintf( - 'ALTER COLUMN %s DROP DEFAULT', - $quotedColumnName, - )); - } - - // rename column - if ($columnName !== $newColumn->getName()) { - $instructions->addPostStep(sprintf( - 'ALTER TABLE %s RENAME COLUMN %s TO %s', - $this->quoteTableName($tableName), - $quotedColumnName, - $this->quoteColumnName($newColumn->getName()), - )); - } - - // change column comment if needed - if ($newColumn->getComment()) { - $instructions->addPostStep($this->getColumnCommentSqlDefinition($newColumn, $tableName)); - } - - return $instructions; - } - - /** - * @param string $tableName Table name - * @param string $columnName Column name - * @return ?\Phinx\Db\Table\Column - */ - protected function getColumn(string $tableName, string $columnName): ?Column - { - $columns = $this->getColumns($tableName); - foreach ($columns as $column) { - if ($column->getName() === $columnName) { - return $column; - } - } - - return null; - } - - /** - * @inheritDoc - */ - protected function getDropColumnInstructions(string $tableName, string $columnName): AlterInstructions - { - $alter = sprintf( - 'DROP COLUMN %s', - $this->quoteColumnName($columnName), - ); - - return new AlterInstructions([$alter]); - } - - /** - * Get an array of indexes from a particular table. - * - * @param string $tableName Table name - * @return array - */ - protected function getIndexes(string $tableName): array - { - $parts = $this->getSchemaName($tableName); - - $indexes = []; - $sql = sprintf( - "SELECT - i.relname AS index_name, - a.attname AS column_name - FROM - pg_class t, - pg_class i, - pg_index ix, - pg_attribute a, - pg_namespace nsp - WHERE - t.oid = ix.indrelid - AND i.oid = ix.indexrelid - AND a.attrelid = t.oid - AND a.attnum = ANY(ix.indkey) - AND t.relnamespace = nsp.oid - AND nsp.nspname = %s - AND t.relkind = 'r' - AND t.relname = %s - ORDER BY - t.relname, - i.relname", - $this->getConnection()->quote($parts['schema']), - $this->getConnection()->quote($parts['table']), - ); - $rows = $this->fetchAll($sql); - foreach ($rows as $row) { - if (!isset($indexes[$row['index_name']])) { - $indexes[$row['index_name']] = ['columns' => []]; - } - $indexes[$row['index_name']]['columns'][] = $row['column_name']; - } - - return $indexes; - } - - /** - * @inheritDoc - */ - public function hasIndex(string $tableName, string|array $columns): bool - { - if (is_string($columns)) { - $columns = [$columns]; - } - $indexes = $this->getIndexes($tableName); - foreach ($indexes as $index) { - if (array_diff($index['columns'], $columns) === array_diff($columns, $index['columns'])) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - public function hasIndexByName(string $tableName, string $indexName): bool - { - $indexes = $this->getIndexes($tableName); - foreach ($indexes as $name => $index) { - if ($name === $indexName) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - protected function getAddIndexInstructions(Table $table, Index $index): AlterInstructions - { - $instructions = new AlterInstructions(); - $instructions->addPostStep($this->getIndexSqlDefinition($index, $table->getName())); - - return $instructions; - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getDropIndexByColumnsInstructions(string $tableName, $columns): AlterInstructions - { - $parts = $this->getSchemaName($tableName); - - if (is_string($columns)) { - $columns = [$columns]; // str to array - } - - $indexes = $this->getIndexes($tableName); - foreach ($indexes as $indexName => $index) { - $a = array_diff($columns, $index['columns']); - if (empty($a)) { - return new AlterInstructions([], [sprintf( - 'DROP INDEX IF EXISTS %s', - '"' . ($parts['schema'] . '".' . $this->quoteColumnName($indexName)), - )]); - } - } - - throw new InvalidArgumentException(sprintf( - "The specified index on columns '%s' does not exist", - implode(',', $columns), - )); - } - - /** - * @inheritDoc - */ - protected function getDropIndexByNameInstructions(string $tableName, string $indexName): AlterInstructions - { - $parts = $this->getSchemaName($tableName); - - $sql = sprintf( - 'DROP INDEX IF EXISTS %s', - '"' . ($parts['schema'] . '".' . $this->quoteColumnName($indexName)), - ); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - public function hasPrimaryKey(string $tableName, $columns, ?string $constraint = null): bool - { - $primaryKey = $this->getPrimaryKey($tableName); - - if (empty($primaryKey)) { - return false; - } - - if ($constraint) { - return $primaryKey['constraint'] === $constraint; - } - - return $primaryKey['columns'] === (array)$columns; - } - - /** - * Get the primary key from a particular table. - * - * @param string $tableName Table name - * @return array - */ - public function getPrimaryKey(string $tableName): array - { - $parts = $this->getSchemaName($tableName); - $rows = $this->fetchAll(sprintf( - "SELECT - tc.constraint_name, - kcu.column_name - FROM information_schema.table_constraints AS tc - JOIN information_schema.key_column_usage AS kcu - ON tc.constraint_name = kcu.constraint_name - WHERE constraint_type = 'PRIMARY KEY' - AND tc.table_schema = %s - AND tc.table_name = %s - ORDER BY kcu.position_in_unique_constraint", - $this->getConnection()->quote($parts['schema']), - $this->getConnection()->quote($parts['table']), - )); - - $primaryKey = [ - 'columns' => [], - ]; - foreach ($rows as $row) { - $primaryKey['constraint'] = $row['constraint_name']; - $primaryKey['columns'][] = $row['column_name']; - } - - return $primaryKey; - } - - /** - * @inheritDoc - */ - public function hasForeignKey(string $tableName, $columns, ?string $constraint = null): bool - { - $foreignKeys = $this->getForeignKeys($tableName); - if ($constraint) { - if (isset($foreignKeys[$constraint])) { - return !empty($foreignKeys[$constraint]); - } - - return false; - } - - if (is_string($columns)) { - $columns = [$columns]; - } - - foreach ($foreignKeys as $key) { - if ($key['columns'] === $columns) { - return true; - } - } - - return false; - } - - /** - * Get an array of foreign keys from a particular table. - * - * @param string $tableName Table name - * @return array - */ - protected function getForeignKeys(string $tableName): array - { - $parts = $this->getSchemaName($tableName); - $foreignKeys = []; - $rows = $this->fetchAll(sprintf( - "SELECT - tc.constraint_name, - tc.table_name, kcu.column_name, - ccu.table_name AS referenced_table_name, - ccu.column_name AS referenced_column_name - FROM - information_schema.table_constraints AS tc - JOIN information_schema.key_column_usage AS kcu ON tc.constraint_name = kcu.constraint_name - JOIN information_schema.constraint_column_usage AS ccu ON ccu.constraint_name = tc.constraint_name - WHERE constraint_type = 'FOREIGN KEY' AND tc.table_schema = %s AND tc.table_name = %s - ORDER BY kcu.ordinal_position", - $this->getConnection()->quote($parts['schema']), - $this->getConnection()->quote($parts['table']), - )); - foreach ($rows as $row) { - $foreignKeys[$row['constraint_name']]['table'] = $row['table_name']; - $foreignKeys[$row['constraint_name']]['columns'][] = $row['column_name']; - $foreignKeys[$row['constraint_name']]['referenced_table'] = $row['referenced_table_name']; - $foreignKeys[$row['constraint_name']]['referenced_columns'][] = $row['referenced_column_name']; - } - foreach ($foreignKeys as $name => $key) { - $foreignKeys[$name]['columns'] = array_values(array_unique($key['columns'])); - $foreignKeys[$name]['referenced_columns'] = array_values(array_unique($key['referenced_columns'])); - } - - return $foreignKeys; - } - - /** - * @inheritDoc - */ - protected function getAddForeignKeyInstructions(Table $table, ForeignKey $foreignKey): AlterInstructions - { - $alter = sprintf( - 'ADD %s', - $this->getForeignKeySqlDefinition($foreignKey, $table->getName()), - ); - - return new AlterInstructions([$alter]); - } - - /** - * @inheritDoc - */ - protected function getDropForeignKeyInstructions($tableName, $constraint): AlterInstructions - { - $alter = sprintf( - 'DROP CONSTRAINT %s', - $this->quoteColumnName($constraint), - ); - - return new AlterInstructions([$alter]); - } - - /** - * @inheritDoc - */ - protected function getDropForeignKeyByColumnsInstructions(string $tableName, array $columns): AlterInstructions - { - $instructions = new AlterInstructions(); - - $matches = []; - $foreignKeys = $this->getForeignKeys($tableName); - foreach ($foreignKeys as $name => $key) { - if ($key['columns'] === $columns) { - $matches[] = $name; - } - } - - if (empty($matches)) { - throw new InvalidArgumentException(sprintf( - 'No foreign key on column(s) `%s` exists', - implode(', ', $columns), - )); - } - - foreach ($matches as $name) { - $instructions->merge( - $this->getDropForeignKeyInstructions($tableName, $name), - ); - } - - return $instructions; - } - - /** - * {@inheritDoc} - * - * @throws \Phinx\Db\Adapter\UnsupportedColumnTypeException - */ - public function getSqlType(Literal|string $type, ?int $limit = null): array - { - $type = (string)$type; - switch ($type) { - case static::PHINX_TYPE_TEXT: - case static::PHINX_TYPE_TIME: - case static::PHINX_TYPE_DATE: - case static::PHINX_TYPE_BOOLEAN: - case static::PHINX_TYPE_JSON: - case static::PHINX_TYPE_JSONB: - case static::PHINX_TYPE_UUID: - case static::PHINX_TYPE_CIDR: - case static::PHINX_TYPE_INET: - case static::PHINX_TYPE_MACADDR: - case static::PHINX_TYPE_TIMESTAMP: - case static::PHINX_TYPE_INTEGER: - return ['name' => $type]; - case static::PHINX_TYPE_TINY_INTEGER: - return ['name' => 'smallint']; - case static::PHINX_TYPE_SMALL_INTEGER: - return ['name' => 'smallint']; - case static::PHINX_TYPE_DECIMAL: - return ['name' => $type, 'precision' => 18, 'scale' => 0]; - case static::PHINX_TYPE_DOUBLE: - return ['name' => 'double precision']; - case static::PHINX_TYPE_STRING: - return ['name' => 'character varying', 'limit' => 255]; - case static::PHINX_TYPE_CHAR: - return ['name' => 'character', 'limit' => 255]; - case static::PHINX_TYPE_BIG_INTEGER: - return ['name' => 'bigint']; - case static::PHINX_TYPE_FLOAT: - return ['name' => 'real']; - case static::PHINX_TYPE_DATETIME: - return ['name' => 'timestamp']; - case static::PHINX_TYPE_BINARYUUID: - return ['name' => 'uuid']; - case static::PHINX_TYPE_BLOB: - case static::PHINX_TYPE_BINARY: - return ['name' => 'bytea']; - case static::PHINX_TYPE_INTERVAL: - return ['name' => 'interval']; - // Geospatial database types - // Spatial storage in Postgres is done via the PostGIS extension, - // which enables the use of the "geography" type in combination - // with SRID 4326. - case static::PHINX_TYPE_GEOMETRY: - return ['name' => 'geography', 'type' => 'geometry', 'srid' => 4326]; - case static::PHINX_TYPE_POINT: - return ['name' => 'geography', 'type' => 'point', 'srid' => 4326]; - case static::PHINX_TYPE_LINESTRING: - return ['name' => 'geography', 'type' => 'linestring', 'srid' => 4326]; - case static::PHINX_TYPE_POLYGON: - return ['name' => 'geography', 'type' => 'polygon', 'srid' => 4326]; - default: - if ($this->isArrayType($type)) { - return ['name' => $type]; - } - // Return array type - throw new UnsupportedColumnTypeException('Column type `' . $type . '` is not supported by Postgresql.'); - } - } - - /** - * Returns Phinx type by SQL type - * - * @param string $sqlType SQL type - * @throws \Phinx\Db\Adapter\UnsupportedColumnTypeException - * @return string Phinx type - */ - public function getPhinxType(string $sqlType): string - { - switch ($sqlType) { - case 'character varying': - case 'varchar': - return static::PHINX_TYPE_STRING; - case 'character': - case 'char': - return static::PHINX_TYPE_CHAR; - case 'text': - return static::PHINX_TYPE_TEXT; - case 'json': - return static::PHINX_TYPE_JSON; - case 'jsonb': - return static::PHINX_TYPE_JSONB; - case 'smallint': - return static::PHINX_TYPE_SMALL_INTEGER; - case 'int': - case 'int4': - case 'integer': - return static::PHINX_TYPE_INTEGER; - case 'decimal': - case 'numeric': - return static::PHINX_TYPE_DECIMAL; - case 'bigint': - case 'int8': - return static::PHINX_TYPE_BIG_INTEGER; - case 'real': - case 'float4': - return static::PHINX_TYPE_FLOAT; - case 'double precision': - return static::PHINX_TYPE_DOUBLE; - case 'bytea': - return static::PHINX_TYPE_BINARY; - case 'interval': - return static::PHINX_TYPE_INTERVAL; - case 'time': - case 'timetz': - case 'time with time zone': - case 'time without time zone': - return static::PHINX_TYPE_TIME; - case 'date': - return static::PHINX_TYPE_DATE; - case 'timestamp': - case 'timestamptz': - case 'timestamp with time zone': - case 'timestamp without time zone': - return static::PHINX_TYPE_DATETIME; - case 'bool': - case 'boolean': - return static::PHINX_TYPE_BOOLEAN; - case 'uuid': - return static::PHINX_TYPE_UUID; - case 'cidr': - return static::PHINX_TYPE_CIDR; - case 'inet': - return static::PHINX_TYPE_INET; - case 'macaddr': - return static::PHINX_TYPE_MACADDR; - default: - throw new UnsupportedColumnTypeException( - 'Column type `' . $sqlType . '` is not supported by Postgresql.', - ); - } - } - - /** - * @inheritDoc - */ - public function createDatabase(string $name, array $options = []): void - { - $charset = $options['charset'] ?? 'utf8'; - $this->execute(sprintf("CREATE DATABASE %s WITH ENCODING = '%s'", $this->quoteColumnName($name), $charset)); - } - - /** - * @inheritDoc - */ - public function hasDatabase(string $name): bool - { - $sql = sprintf("SELECT count(*) FROM pg_database WHERE datname = '%s'", $name); - $result = $this->fetchRow($sql); - - return $result['count'] > 0; - } - - /** - * @inheritDoc - */ - public function dropDatabase($name): void - { - $this->disconnect(); - $this->execute(sprintf('DROP DATABASE IF EXISTS %s', $this->quoteColumnName($name))); - $this->createdTables = []; - $this->connect(); - } - - /** - * Gets the PostgreSQL Column Definition for a Column object. - * - * @param \Phinx\Db\Table\Column $column Column - * @return string - */ - protected function getColumnSqlDefinition(Column $column): string - { - $buffer = []; - - if ($column->isIdentity() && (!$this->useIdentity || $column->getGenerated() === null)) { - if ($column->getType() === 'smallinteger') { - $buffer[] = 'SMALLSERIAL'; - } elseif ($column->getType() === 'biginteger') { - $buffer[] = 'BIGSERIAL'; - } else { - $buffer[] = 'SERIAL'; - } - } elseif ($column->getType() instanceof Literal) { - $buffer[] = (string)$column->getType(); - } else { - $sqlType = $this->getSqlType($column->getType(), $column->getLimit()); - $buffer[] = strtoupper($sqlType['name']); - - // integers cant have limits in postgres - if ($sqlType['name'] === static::PHINX_TYPE_DECIMAL && ($column->getPrecision() || $column->getScale())) { - $buffer[] = sprintf( - '(%s, %s)', - $column->getPrecision() ?: $sqlType['precision'], - $column->getScale() ?: $sqlType['scale'], - ); - } elseif ($sqlType['name'] === self::PHINX_TYPE_GEOMETRY) { - // geography type must be written with geometry type and srid, like this: geography(POLYGON,4326) - $buffer[] = sprintf( - '(%s,%s)', - strtoupper($sqlType['type']), - $column->getSrid() ?: $sqlType['srid'], - ); - } elseif (in_array($sqlType['name'], [self::PHINX_TYPE_TIME, self::PHINX_TYPE_TIMESTAMP], true)) { - if (is_numeric($column->getPrecision())) { - $buffer[] = sprintf('(%s)', $column->getPrecision()); - } - - if ($column->isTimezone()) { - $buffer[] = strtoupper('with time zone'); - } - } elseif ( - !in_array($column->getType(), [ - self::PHINX_TYPE_TINY_INTEGER, - self::PHINX_TYPE_SMALL_INTEGER, - self::PHINX_TYPE_INTEGER, - self::PHINX_TYPE_BIG_INTEGER, - self::PHINX_TYPE_BOOLEAN, - self::PHINX_TYPE_TEXT, - self::PHINX_TYPE_BINARY, - ], true) - ) { - if ($column->getLimit() || isset($sqlType['limit'])) { - $buffer[] = sprintf('(%s)', $column->getLimit() ?: $sqlType['limit']); - } - } - } - - $buffer[] = $column->isNull() ? 'NULL' : 'NOT NULL'; - - if ($column->getDefault() !== null) { - $buffer[] = $this->getDefaultValueDefinition($column->getDefault(), $column->getType()); - } - - return implode(' ', $buffer); - } - - /** - * Gets the PostgreSQL Column Comment Definition for a column object. - * - * @param \Phinx\Db\Table\Column $column Column - * @param string $tableName Table name - * @return string - */ - protected function getColumnCommentSqlDefinition(Column $column, string $tableName): string - { - // passing 'null' is to remove column comment - $comment = strcasecmp($column->getComment(), 'NULL') !== 0 - ? $this->getConnection()->quote($column->getComment()) - : 'NULL'; - - return sprintf( - 'COMMENT ON COLUMN %s.%s IS %s;', - $this->quoteTableName($tableName), - $this->quoteColumnName($column->getName()), - $comment, - ); - } - - /** - * Gets the PostgreSQL Index Definition for an Index object. - * - * @param \Phinx\Db\Table\Index $index Index - * @param string $tableName Table name - * @return string - */ - protected function getIndexSqlDefinition(Index $index, string $tableName): string - { - $parts = $this->getSchemaName($tableName); - $columnNames = $index->getColumns(); - - if (is_string($index->getName())) { - $indexName = $index->getName(); - } else { - $indexName = sprintf('%s_%s', $parts['table'], implode('_', $columnNames)); - } - - $order = $index->getOrder() ?? []; - $columnNames = array_map(function ($columnName) use ($order) { - $ret = '"' . $columnName . '"'; - if (isset($order[$columnName])) { - $ret .= ' ' . $order[$columnName]; - } - - return $ret; - }, $columnNames); - - $includedColumns = $index->getInclude() ? sprintf('INCLUDE ("%s")', implode('","', $index->getInclude())) : ''; - - $createIndexSentence = 'CREATE %s INDEX %s ON %s '; - if ($index->getType() === self::GIN_INDEX_TYPE) { - $createIndexSentence .= ' USING ' . $index->getType() . '(%s) %s;'; - } else { - $createIndexSentence .= '(%s) %s;'; - } - - return sprintf( - $createIndexSentence, - ($index->getType() === Index::UNIQUE ? 'UNIQUE' : ''), - $this->quoteColumnName($indexName), - $this->quoteTableName($tableName), - implode(',', $columnNames), - $includedColumns, - ); - } - - /** - * Gets the MySQL Foreign Key Definition for an ForeignKey object. - * - * @param \Phinx\Db\Table\ForeignKey $foreignKey Foreign key - * @param string $tableName Table name - * @return string - */ - protected function getForeignKeySqlDefinition(ForeignKey $foreignKey, string $tableName): string - { - $parts = $this->getSchemaName($tableName); - - $constraintName = $foreignKey->getConstraint() ?: ( - $parts['table'] . '_' . implode('_', $foreignKey->getColumns()) . '_fkey' - ); - $def = ' CONSTRAINT ' . $this->quoteColumnName($constraintName) . - ' FOREIGN KEY ("' . implode('", "', $foreignKey->getColumns()) . '")' . - " REFERENCES {$this->quoteTableName($foreignKey->getReferencedTable()->getName())} (\"" . - implode('", "', $foreignKey->getReferencedColumns()) . '")'; - if ($foreignKey->getOnDelete()) { - $def .= " ON DELETE {$foreignKey->getOnDelete()}"; - } - if ($foreignKey->getOnUpdate()) { - $def .= " ON UPDATE {$foreignKey->getOnUpdate()}"; - } - - if ($foreignKey->getDeferrableMode()) { - $def .= " {$foreignKey->getDeferrableMode()}"; - } - - return $def; - } - - /** - * @inheritDoc - */ - public function createSchemaTable(): void - { - // Create the public/custom schema if it doesn't already exist - if ($this->hasSchema($this->schema) === false) { - $this->createSchema($this->schema); - } - - $this->setSearchPath(); - - parent::createSchemaTable(); - } - - /** - * @inheritDoc - */ - public function getVersions(): array - { - $this->setSearchPath(); - - return parent::getVersions(); - } - - /** - * @inheritDoc - */ - public function getVersionLog(): array - { - $this->setSearchPath(); - - return parent::getVersionLog(); - } - - /** - * Creates the specified schema. - * - * @param string $schemaName Schema Name - * @return void - */ - public function createSchema(string $schemaName = 'public'): void - { - // from postgres 9.3 we can use "CREATE SCHEMA IF NOT EXISTS schema_name" - $sql = sprintf('CREATE SCHEMA IF NOT EXISTS %s', $this->quoteSchemaName($schemaName)); - $this->execute($sql); - } - - /** - * Checks to see if a schema exists. - * - * @param string $schemaName Schema Name - * @return bool - */ - public function hasSchema(string $schemaName): bool - { - $sql = sprintf( - 'SELECT count(*) - FROM pg_namespace - WHERE nspname = %s', - $this->getConnection()->quote($schemaName), - ); - $result = $this->fetchRow($sql); - - return $result['count'] > 0; - } - - /** - * Drops the specified schema table. - * - * @param string $schemaName Schema name - * @return void - */ - public function dropSchema(string $schemaName): void - { - $sql = sprintf('DROP SCHEMA IF EXISTS %s CASCADE', $this->quoteSchemaName($schemaName)); - $this->execute($sql); - - foreach ($this->createdTables as $idx => $createdTable) { - if ($this->getSchemaName($createdTable)['schema'] === $this->quoteSchemaName($schemaName)) { - unset($this->createdTables[$idx]); - } - } - } - - /** - * Drops all schemas. - * - * @return void - */ - public function dropAllSchemas(): void - { - foreach ($this->getAllSchemas() as $schema) { - $this->dropSchema($schema); - } - } - - /** - * Returns schemas. - * - * @return array - */ - public function getAllSchemas(): array - { - $sql = "SELECT schema_name - FROM information_schema.schemata - WHERE schema_name <> 'information_schema' AND schema_name !~ '^pg_'"; - $items = $this->fetchAll($sql); - $schemaNames = []; - foreach ($items as $item) { - $schemaNames[] = $item['schema_name']; - } - - return $schemaNames; - } - - /** - * @inheritDoc - */ - public function getColumnTypes(): array - { - return array_merge(parent::getColumnTypes(), static::$specificColumnTypes); - } - - /** - * @inheritDoc - */ - public function isValidColumnType(Column $column): bool - { - // If not a standard column type, maybe it is array type? - return parent::isValidColumnType($column) || $this->isArrayType($column->getType()); - } - - /** - * Check if the given column is an array of a valid type. - * - * @param string|\Phinx\Util\Literal $columnType Column type - * @return bool - */ - protected function isArrayType(string|Literal $columnType): bool - { - if (!preg_match('/^([a-z]+)(?:\[\]){1,}$/', $columnType, $matches)) { - return false; - } - - $baseType = $matches[1]; - - return in_array($baseType, $this->getColumnTypes(), true); - } - - /** - * @param string $tableName Table name - * @return array - */ - protected function getSchemaName(string $tableName): array - { - $schema = $this->schema; - $table = $tableName; - if (strpos($tableName, '.') !== false) { - [$schema, $table] = explode('.', $tableName); - } - - return [ - 'schema' => $schema, - 'table' => $table, - ]; - } - - /** - * @inheritDoc - */ - public function castToBool($value): mixed - { - return (bool)$value ? 'TRUE' : 'FALSE'; - } - - /** - * @inheritDoc - */ - public function getDecoratedConnection(): Connection - { - if (isset($this->decoratedConnection)) { - return $this->decoratedConnection; - } - - $options = $this->getOptions(); - $options = [ - 'username' => $options['user'] ?? null, - 'password' => $options['pass'] ?? null, - 'database' => $options['name'], - 'schema' => $this->schema, - 'quoteIdentifiers' => true, - ] + $options; - - return $this->decoratedConnection = $this->buildConnection(PostgresDriver::class, $options); - } - - /** - * Sets search path of schemas to look through for a table - * - * @return void - */ - public function setSearchPath(): void - { - $this->execute( - sprintf( - 'SET search_path TO %s,"$user",public', - $this->quoteSchemaName($this->schema), - ), - ); - } - - /** - * @inheritDoc - */ - protected function getInsertOverride(): string - { - return $this->useIdentity ? self::OVERRIDE_SYSTEM_VALUE . ' ' : ''; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/ProxyAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/ProxyAdapter.php deleted file mode 100644 index 04c3492b4..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/ProxyAdapter.php +++ /dev/null @@ -1,128 +0,0 @@ -commands[] = new CreateTable($table); - } - - /** - * @inheritDoc - */ - public function executeActions(Table $table, array $actions): void - { - $this->commands = array_merge($this->commands, $actions); - } - - /** - * Gets an array of the recorded commands in reverse. - * - * @throws \Phinx\Migration\IrreversibleMigrationException if a command cannot be reversed. - * @return \Phinx\Db\Plan\Intent - */ - public function getInvertedCommands(): Intent - { - $inverted = new Intent(); - - foreach (array_reverse($this->commands) as $command) { - switch (true) { - case $command instanceof CreateTable: - /** @var \Phinx\Db\Action\CreateTable $command */ - $inverted->addAction(new DropTable($command->getTable())); - break; - - case $command instanceof RenameTable: - /** @var \Phinx\Db\Action\RenameTable $command */ - $inverted->addAction(new RenameTable(new Table($command->getNewName()), $command->getTable()->getName())); - break; - - case $command instanceof AddColumn: - /** @var \Phinx\Db\Action\AddColumn $command */ - $inverted->addAction(new RemoveColumn($command->getTable(), $command->getColumn())); - break; - - case $command instanceof RenameColumn: - /** @var \Phinx\Db\Action\RenameColumn $command */ - $column = clone $command->getColumn(); - $name = $column->getName(); - $column->setName($command->getNewName()); - $inverted->addAction(new RenameColumn($command->getTable(), $column, $name)); - break; - - case $command instanceof AddIndex: - /** @var \Phinx\Db\Action\AddIndex $command */ - $inverted->addAction(new DropIndex($command->getTable(), $command->getIndex())); - break; - - case $command instanceof AddForeignKey: - /** @var \Phinx\Db\Action\AddForeignKey $command */ - $inverted->addAction(new DropForeignKey($command->getTable(), $command->getForeignKey())); - break; - - default: - throw new IrreversibleMigrationException(sprintf( - 'Cannot reverse a "%s" command', - get_class($command), - )); - } - } - - return $inverted; - } - - /** - * Execute the recorded commands in reverse. - * - * @return void - */ - public function executeInvertedCommands(): void - { - $plan = new Plan($this->getInvertedCommands()); - $plan->executeInverse($this->getAdapter()); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/SQLiteAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/SQLiteAdapter.php deleted file mode 100644 index 1c7c76561..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/SQLiteAdapter.php +++ /dev/null @@ -1,2016 +0,0 @@ - 'biginteger', - self::PHINX_TYPE_BINARY => 'binary_blob', - self::PHINX_TYPE_BINARYUUID => 'uuid_blob', - self::PHINX_TYPE_BLOB => 'blob', - self::PHINX_TYPE_BOOLEAN => 'boolean_integer', - self::PHINX_TYPE_CHAR => 'char', - self::PHINX_TYPE_DATE => 'date_text', - self::PHINX_TYPE_DATETIME => 'datetime_text', - self::PHINX_TYPE_DECIMAL => 'decimal', - self::PHINX_TYPE_DOUBLE => 'double', - self::PHINX_TYPE_FLOAT => 'float', - self::PHINX_TYPE_INTEGER => 'integer', - self::PHINX_TYPE_JSON => 'json_text', - self::PHINX_TYPE_JSONB => 'jsonb_text', - self::PHINX_TYPE_SMALL_INTEGER => 'smallinteger', - self::PHINX_TYPE_STRING => 'varchar', - self::PHINX_TYPE_TEXT => 'text', - self::PHINX_TYPE_TIME => 'time_text', - self::PHINX_TYPE_TIMESTAMP => 'timestamp_text', - self::PHINX_TYPE_TINY_INTEGER => 'tinyinteger', - self::PHINX_TYPE_UUID => 'uuid_text', - self::PHINX_TYPE_VARBINARY => 'varbinary_blob', - ]; - - /** - * List of aliases of supported column types - * - * @var string[] - */ - protected static array $supportedColumnTypeAliases = [ - 'varchar' => self::PHINX_TYPE_STRING, - 'tinyint' => self::PHINX_TYPE_TINY_INTEGER, - 'tinyinteger' => self::PHINX_TYPE_TINY_INTEGER, - 'smallint' => self::PHINX_TYPE_SMALL_INTEGER, - 'int' => self::PHINX_TYPE_INTEGER, - 'mediumint' => self::PHINX_TYPE_INTEGER, - 'mediuminteger' => self::PHINX_TYPE_INTEGER, - 'bigint' => self::PHINX_TYPE_BIG_INTEGER, - 'tinytext' => self::PHINX_TYPE_TEXT, - 'mediumtext' => self::PHINX_TYPE_TEXT, - 'longtext' => self::PHINX_TYPE_TEXT, - 'tinyblob' => self::PHINX_TYPE_BLOB, - 'mediumblob' => self::PHINX_TYPE_BLOB, - 'longblob' => self::PHINX_TYPE_BLOB, - 'real' => self::PHINX_TYPE_FLOAT, - ]; - - /** - * List of known but unsupported Phinx column types - * - * @var string[] - */ - protected static array $unsupportedColumnTypes = [ - self::PHINX_TYPE_BIT, - self::PHINX_TYPE_CIDR, - self::PHINX_TYPE_ENUM, - self::PHINX_TYPE_FILESTREAM, - self::PHINX_TYPE_GEOMETRY, - self::PHINX_TYPE_INET, - self::PHINX_TYPE_INTERVAL, - self::PHINX_TYPE_LINESTRING, - self::PHINX_TYPE_MACADDR, - self::PHINX_TYPE_POINT, - self::PHINX_TYPE_POLYGON, - self::PHINX_TYPE_SET, - ]; - - /** - * @var string[] - */ - protected array $definitionsWithLimits = [ - 'CHAR', - 'CHARACTER', - 'VARCHAR', - 'VARYING CHARACTER', - 'NCHAR', - 'NATIVE CHARACTER', - 'NVARCHAR', - ]; - - /** - * @var string - */ - protected string $suffix = self::DEFAULT_SUFFIX; - - /** - * Indicates whether the database library version is at least the specified version - * - * @param string $ver The version to check against e.g. '3.28.0' - * @return bool - */ - public function databaseVersionAtLeast(string $ver): bool - { - $actual = $this->query('SELECT sqlite_version()')->fetchColumn(); - - return version_compare($actual, $ver, '>='); - } - - /** - * Check if the given options represent a memory database - * - * @param array $options Options to check - * @return bool - */ - public static function isMemory(array $options): bool - { - return !empty($options['memory']) || ($options['name'] ?? '') === static::MEMORY; - } - - /** - * {@inheritDoc} - * - * @throws \RuntimeException - * @throws \InvalidArgumentException - * @return void - */ - public function connect(): void - { - if ($this->connection === null) { - if (!class_exists('PDO') || !in_array('sqlite', PDO::getAvailableDrivers(), true)) { - // @codeCoverageIgnoreStart - throw new RuntimeException('You need to enable the PDO_SQLITE extension for Phinx to run properly.'); - // @codeCoverageIgnoreEnd - } - - $options = $this->getOptions(); - - if (PHP_VERSION_ID < 80100 && (!empty($options['mode']) || !empty($options['cache']))) { - throw new RuntimeException('SQLite URI support requires PHP 8.1.'); - } elseif ((!empty($options['mode']) || !empty($options['cache'])) && !empty($options['memory'])) { - throw new RuntimeException('Memory must not be set when cache or mode are.'); - } elseif (PHP_VERSION_ID >= 80100 && (!empty($options['mode']) || !empty($options['cache']))) { - $params = []; - if (!empty($options['cache'])) { - $params[] = 'cache=' . $options['cache']; - } - if (!empty($options['mode'])) { - $params[] = 'mode=' . $options['mode']; - } - $dsn = 'sqlite:file:' . ($options['name'] ?? '') . '?' . implode('&', $params); - } else { - // use a memory database if the option was specified - if (SQLiteAdapter::isMemory($options)) { - $dsn = 'sqlite:' . static::MEMORY; - } else { - $dsn = 'sqlite:' . $options['name'] . $this->suffix; - } - } - - $driverOptions = []; - - // use custom data fetch mode - if (!empty($options['fetch_mode'])) { - $driverOptions[PDO::ATTR_DEFAULT_FETCH_MODE] = constant('\PDO::FETCH_' . strtoupper($options['fetch_mode'])); - } - - // pass \PDO::ATTR_PERSISTENT to driver options instead of useless setting it after instantiation - if (isset($options['attr_persistent'])) { - $driverOptions[PDO::ATTR_PERSISTENT] = $options['attr_persistent']; - } - - $db = $this->createPdoConnection($dsn, null, null, $driverOptions); - - $this->setConnection($db); - } - } - - /** - * Get the suffix to use for the SQLite database file. - * - * @param array $options Environment options - * @return string - */ - public static function getSuffix(array $options): string - { - if (SQLiteAdapter::isMemory($options)) { - return ''; - } - - $suffix = self::DEFAULT_SUFFIX; - if (isset($options['suffix'])) { - $suffix = $options['suffix']; - } - //don't "fix" the file extension if it is blank, some people - //might want a SQLITE db file with absolutely no extension. - if ($suffix !== '' && strpos($suffix, '.') !== 0) { - $suffix = '.' . $suffix; - } - - return $suffix; - } - - /** - * @inheritDoc - */ - public function setOptions(array $options): AdapterInterface - { - parent::setOptions($options); - $this->suffix = self::getSuffix($options); - - return $this; - } - - /** - * @inheritDoc - */ - public function disconnect(): void - { - $this->connection = null; - } - - /** - * @inheritDoc - */ - public function hasTransactions(): bool - { - return true; - } - - /** - * @inheritDoc - */ - public function beginTransaction(): void - { - $this->getConnection()->beginTransaction(); - } - - /** - * @inheritDoc - */ - public function commitTransaction(): void - { - $this->getConnection()->commit(); - } - - /** - * @inheritDoc - */ - public function rollbackTransaction(): void - { - $this->getConnection()->rollBack(); - } - - /** - * @inheritDoc - */ - public function quoteTableName($tableName): string - { - return str_replace('.', '`.`', $this->quoteColumnName($tableName)); - } - - /** - * @inheritDoc - */ - public function quoteColumnName($columnName): string - { - return '`' . str_replace('`', '``', $columnName) . '`'; - } - - /** - * Generates a regular expression to match identifiers that may or - * may not be quoted with any of the supported quotes. - * - * @param string $identifier The identifier to match. - * @param bool $spacedNoQuotes Whether the non-quoted identifier requires to be surrounded by whitespace. - * @return string - */ - protected function possiblyQuotedIdentifierRegex(string $identifier, bool $spacedNoQuotes = true): string - { - $identifiers = []; - $identifier = preg_quote($identifier, '/'); - - $hasTick = str_contains($identifier, '`'); - $hasDoubleQuote = str_contains($identifier, '"'); - $hasSingleQuote = str_contains($identifier, "'"); - - $identifiers[] = '\[' . $identifier . '\]'; - $identifiers[] = '`' . ($hasTick ? str_replace('`', '``', $identifier) : $identifier) . '`'; - $identifiers[] = '"' . ($hasDoubleQuote ? str_replace('"', '""', $identifier) : $identifier) . '"'; - $identifiers[] = "'" . ($hasSingleQuote ? str_replace("'", "''", $identifier) : $identifier) . "'"; - - if (!$hasTick && !$hasDoubleQuote && !$hasSingleQuote) { - if ($spacedNoQuotes) { - $identifiers[] = "\s+$identifier\s+"; - } else { - $identifiers[] = $identifier; - } - } - - return '(' . implode('|', $identifiers) . ')'; - } - - /** - * @param string $tableName Table name - * @param bool $quoted Whether to return the schema name and table name escaped and quoted. If quoted, the schema (if any) will also be appended with a dot - * @return array - */ - protected function getSchemaName(string $tableName, bool $quoted = false): array - { - if (preg_match("/.\.([^\.]+)$/", $tableName, $match)) { - $table = $match[1]; - $schema = substr($tableName, 0, strlen($tableName) - strlen($match[0]) + 1); - $result = ['schema' => $schema, 'table' => $table]; - } else { - $result = ['schema' => '', 'table' => $tableName]; - } - - if ($quoted) { - $result['schema'] = $result['schema'] !== '' ? $this->quoteColumnName($result['schema']) . '.' : ''; - $result['table'] = $this->quoteColumnName($result['table']); - } - - return $result; - } - - /** - * Retrieves information about a given table from one of the SQLite pragmas - * - * @param string $tableName The table to query - * @param string $pragma The pragma to query - * @return array - */ - protected function getTableInfo(string $tableName, string $pragma = 'table_info'): array - { - $info = $this->getSchemaName($tableName, true); - - return $this->fetchAll(sprintf('PRAGMA %s%s(%s)', $info['schema'], $pragma, $info['table'])); - } - - /** - * Searches through all available schemata to find a table and returns an array - * containing the bare schema name and whether the table exists at all. - * If no schema was specified and the table does not exist the "main" schema is returned - * - * @param string $tableName The name of the table to find - * @return array - */ - protected function resolveTable(string $tableName): array - { - $info = $this->getSchemaName($tableName); - if ($info['schema'] === '') { - // if no schema is specified we search all schemata - $rows = $this->fetchAll('PRAGMA database_list;'); - // the temp schema is always first to be searched - $schemata = ['temp']; - foreach ($rows as $row) { - if (strtolower($row['name']) !== 'temp') { - $schemata[] = $row['name']; - } - } - $defaultSchema = 'main'; - } else { - // otherwise we search just the specified schema - $schemata = (array)$info['schema']; - $defaultSchema = $info['schema']; - } - - $table = strtolower($info['table']); - foreach ($schemata as $schema) { - if (strtolower($schema) === 'temp') { - $master = 'sqlite_temp_master'; - } else { - $master = sprintf('%s.%s', $this->quoteColumnName($schema), 'sqlite_master'); - } - try { - $rows = $this->fetchAll(sprintf("SELECT name FROM %s WHERE type='table' AND lower(name) = %s", $master, $this->quoteString($table))); - } catch (PDOException $e) { - // an exception can occur if the schema part of the table refers to a database which is not attached - break; - } - - // this somewhat pedantic check with strtolower is performed because the SQL lower function may be redefined, - // and can act on all Unicode characters if the ICU extension is loaded, while SQL identifiers are only case-insensitive for ASCII - foreach ($rows as $row) { - if (strtolower($row['name']) === $table) { - return ['schema' => $schema, 'table' => $row['name'], 'exists' => true]; - } - } - } - - return ['schema' => $defaultSchema, 'table' => $info['table'], 'exists' => false]; - } - - /** - * @inheritDoc - */ - public function hasTable(string $tableName): bool - { - return $this->hasCreatedTable($tableName) || $this->resolveTable($tableName)['exists']; - } - - /** - * @inheritDoc - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void - { - // Add the default primary key - $options = $table->getOptions(); - if (!isset($options['id']) || (isset($options['id']) && $options['id'] === true)) { - $options['id'] = 'id'; - } - - if (isset($options['id']) && is_string($options['id'])) { - // Handle id => "field_name" to support AUTO_INCREMENT - $column = new Column(); - $column->setName($options['id']) - ->setType('integer') - ->setOptions(['identity' => true]); - - array_unshift($columns, $column); - } - - $sql = 'CREATE TABLE '; - $sql .= $this->quoteTableName($table->getName()) . ' ('; - if (isset($options['primary_key'])) { - $options['primary_key'] = (array)$options['primary_key']; - } - foreach ($columns as $column) { - $sql .= $this->quoteColumnName($column->getName()) . ' ' . $this->getColumnSqlDefinition($column) . ', '; - - if (isset($options['primary_key']) && $column->getIdentity()) { - //remove column from the primary key array as it is already defined as an autoincrement - //primary id - $identityColumnIndex = array_search($column->getName(), $options['primary_key'], true); - if ($identityColumnIndex !== false) { - unset($options['primary_key'][$identityColumnIndex]); - - if (empty($options['primary_key'])) { - //The last primary key has been removed - unset($options['primary_key']); - } - } - } - } - - // set the primary key(s) - if (isset($options['primary_key'])) { - $sql = rtrim($sql); - $sql .= ' PRIMARY KEY ('; - if (is_array($options['primary_key'])) { // handle primary_key => array('tag_id', 'resource_id') - $sql .= implode(',', array_map([$this, 'quoteColumnName'], $options['primary_key'])); - } - $sql .= ')'; - } else { - $sql = substr(rtrim($sql), 0, -1); // no primary keys - } - - $sql = rtrim($sql) . ');'; - // execute the sql - $this->execute($sql); - - foreach ($indexes as $index) { - $this->addIndex($table, $index); - } - - $this->addCreatedTable($table->getName()); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getChangePrimaryKeyInstructions(Table $table, $newColumns): AlterInstructions - { - $instructions = new AlterInstructions(); - - // Drop the existing primary key - $primaryKey = $this->getPrimaryKey($table->getName()); - if (!empty($primaryKey)) { - $instructions->merge( - // FIXME: array access is a hack to make this incomplete implementation work with a correct getPrimaryKey implementation - $this->getDropPrimaryKeyInstructions($table, $primaryKey[0]), - ); - } - - // Add the primary key(s) - if (!empty($newColumns)) { - if (!is_string($newColumns)) { - throw new InvalidArgumentException(sprintf( - 'Invalid value for primary key: %s', - json_encode($newColumns), - )); - } - - $instructions->merge( - $this->getAddPrimaryKeyInstructions($table, $newColumns), - ); - } - - return $instructions; - } - - /** - * {@inheritDoc} - * - * SQLiteAdapter does not implement this functionality, and so will always throw an exception if used. - * - * @throws \BadMethodCallException - */ - protected function getChangeCommentInstructions(Table $table, $newComment): AlterInstructions - { - throw new BadMethodCallException('SQLite does not have table comments'); - } - - /** - * @inheritDoc - */ - protected function getRenameTableInstructions(string $tableName, string $newTableName): AlterInstructions - { - $this->updateCreatedTableName($tableName, $newTableName); - $sql = sprintf( - 'ALTER TABLE %s RENAME TO %s', - $this->quoteTableName($tableName), - $this->quoteTableName($newTableName), - ); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - protected function getDropTableInstructions(string $tableName): AlterInstructions - { - $this->removeCreatedTable($tableName); - $sql = sprintf('DROP TABLE %s', $this->quoteTableName($tableName)); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - public function truncateTable(string $tableName): void - { - $info = $this->resolveTable($tableName); - // first try deleting the rows - $this->execute(sprintf( - 'DELETE FROM %s.%s', - $this->quoteColumnName($info['schema']), - $this->quoteColumnName($info['table']), - )); - - // assuming no error occurred, reset the autoincrement (if any) - if ($this->hasTable($info['schema'] . '.sqlite_sequence')) { - $this->execute(sprintf( - 'DELETE FROM %s.%s where name = %s', - $this->quoteColumnName($info['schema']), - 'sqlite_sequence', - $this->quoteString($info['table']), - )); - } - } - - /** - * Parses a default-value expression to yield either a Literal representing - * a string value, a string representing an expression, or some other scalar - * - * @param mixed $default The default-value expression to interpret - * @param string $columnType The Phinx type of the column - * @return mixed - */ - protected function parseDefaultValue(mixed $default, string $columnType): mixed - { - if ($default === null) { - return null; - } - - // split the input into tokens - $trimChars = " \t\n\r\0\x0B"; - $pattern = <<getTableInfo($tableName) as $col) { - $type = strtolower($col['type']); - if ($col['pk'] > 1) { - // the table has a composite primary key - return null; - } elseif ($col['pk'] == 0) { - // the column is not a primary key column and is thus not relevant - continue; - } elseif ($type !== 'integer') { - // if the primary key's type is not exactly INTEGER, it cannot be a row ID alias - return null; - } else { - // the column is a candidate for a row ID alias - $result = $col['name']; - } - } - // if there is no suitable PK column, stop now - if ($result === null) { - return null; - } - // make sure the table does not have a PK-origin autoindex - // such an autoindex would indicate either that the primary key was specified as descending, or that this is a WITHOUT ROWID table - foreach ($this->getTableInfo($tableName, 'index_list') as $idx) { - if ($idx['origin'] === 'pk') { - return null; - } - } - - return $result; - } - - /** - * @inheritDoc - */ - public function getColumns(string $tableName): array - { - $columns = []; - - $rows = $this->getTableInfo($tableName); - $identity = $this->resolveIdentity($tableName); - - foreach ($rows as $columnInfo) { - $column = new Column(); - $type = $this->getPhinxType($columnInfo['type']); - // $type['name'] is string|Literal, convert it to be a string - $default = $this->parseDefaultValue($columnInfo['dflt_value'], (string)$type['name']); - - $column->setName($columnInfo['name']) - // SQLite on PHP 8.1 returns int for notnull, older versions return a string - ->setNull((int)$columnInfo['notnull'] !== 1) - ->setDefault($default) - ->setType($type['name']) - ->setLimit($type['limit']) - ->setScale($type['scale']) - ->setIdentity($columnInfo['name'] === $identity); - - $columns[] = $column; - } - - return $columns; - } - - /** - * @inheritDoc - */ - public function hasColumn(string $tableName, string $columnName): bool - { - $rows = $this->getTableInfo($tableName); - foreach ($rows as $column) { - if (strcasecmp($column['name'], $columnName) === 0) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - protected function getAddColumnInstructions(Table $table, Column $column): AlterInstructions - { - $tableName = $table->getName(); - - $instructions = $this->beginAlterByCopyTable($tableName); - - $instructions->addPostStep(function ($state) use ($tableName, $column) { - // we use the final column to anchor our regex to insert the new column, - // as the alternative is unwinding all possible table constraints which - // gets messy quickly with CHECK constraints. - $columns = $this->getColumns($tableName); - if (!$columns) { - return $state; - } - $finalColumnName = end($columns)->getName(); - $sql = preg_replace( - sprintf( - "/(%s(?:\/\*.*?\*\/|\([^)]+\)|'[^']*?'|[^,])+)([,)])/", - $this->quoteColumnName($finalColumnName), - ), - sprintf( - '$1, %s %s$2', - $this->quoteColumnName($column->getName()), - $this->getColumnSqlDefinition($column), - ), - $state['createSQL'], - 1, - ); - $this->execute($sql); - - return $state; - }); - - $instructions->addPostStep(function ($state) use ($tableName) { - $newState = $this->calculateNewTableColumns($tableName, false, false); - - return $newState + $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName); - } - - /** - * Returns the original CREATE statement for the give table - * - * @param string $tableName The table name to get the create statement for - * @return string - */ - protected function getDeclaringSql(string $tableName): string - { - $rows = $this->fetchAll("SELECT * FROM sqlite_master WHERE `type` = 'table'"); - - $sql = ''; - foreach ($rows as $table) { - if ($table['tbl_name'] === $tableName) { - $sql = $table['sql']; - } - } - - $columnsInfo = $this->getTableInfo($tableName); - - foreach ($columnsInfo as $column) { - $columnName = preg_quote($column['name'], '#'); - $columnNamePattern = "\"$columnName\"|`$columnName`|\\[$columnName\\]|$columnName"; - $columnNamePattern = "#([\(,]+\\s*)($columnNamePattern)(\\s)#iU"; - - $sql = preg_replace($columnNamePattern, "$1`{$column['name']}`$3", $sql); - } - - $tableNamePattern = "\"$tableName\"|`$tableName`|\\[$tableName\\]|$tableName"; - $tableNamePattern = "#^(CREATE TABLE)\s*($tableNamePattern)\s*(\()#Ui"; - - $sql = preg_replace($tableNamePattern, "$1 `$tableName` $3", $sql, 1); - - return $sql; - } - - /** - * Returns the original CREATE statement for the give index - * - * @param string $tableName The table name to get the create statement for - * @param string $indexName The table index - * @return string - */ - protected function getDeclaringIndexSql(string $tableName, string $indexName): string - { - $rows = $this->fetchAll("SELECT * FROM sqlite_master WHERE `type` = 'index'"); - - $sql = ''; - foreach ($rows as $table) { - if ($table['tbl_name'] === $tableName && $table['name'] === $indexName) { - $sql = $table['sql'] . '; '; - } - } - - return $sql; - } - - /** - * Obtains index and trigger information for a table. - * - * They will be stored in the state as arrays under the `indices` and `triggers` - * keys accordingly. - * - * Index columns defined as expressions, as for example in `ON (ABS(id), other)`, - * will appear as `null`, so for the given example the columns for the index would - * look like `[null, 'other']`. - * - * @param \Phinx\Db\Util\AlterInstructions $instructions The instructions to modify - * @param string $tableName The name of table being processed - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function bufferIndicesAndTriggers(AlterInstructions $instructions, string $tableName): AlterInstructions - { - $instructions->addPostStep(function (array $state) use ($tableName): array { - $state['indices'] = []; - $state['triggers'] = []; - - $rows = $this->fetchAll( - sprintf( - " - SELECT * - FROM sqlite_master - WHERE - (`type` = 'index' OR `type` = 'trigger') - AND tbl_name = %s - AND sql IS NOT NULL - ", - $this->quoteValue($tableName), - ), - ); - - $schema = $this->getSchemaName($tableName, true)['schema']; - - foreach ($rows as $row) { - switch ($row['type']) { - case 'index': - $info = $this->fetchAll( - sprintf('PRAGMA %sindex_info(%s)', $schema, $this->quoteValue($row['name'])), - ); - - $columns = array_map( - function ($column) { - if ($column === null) { - return null; - } - - return strtolower($column); - }, - array_column($info, 'name'), - ); - $hasExpressions = in_array(null, $columns, true); - - $index = [ - 'columns' => $columns, - 'hasExpressions' => $hasExpressions, - ]; - - $state['indices'][] = $index + $row; - break; - - case 'trigger': - $state['triggers'][] = $row; - break; - } - } - - return $state; - }); - - return $instructions; - } - - /** - * Filters out indices that reference a removed column. - * - * @param \Phinx\Db\Util\AlterInstructions $instructions The instructions to modify - * @param string $columnName The name of the removed column - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function filterIndicesForRemovedColumn( - AlterInstructions $instructions, - string $columnName, - ): AlterInstructions { - $instructions->addPostStep(function (array $state) use ($columnName): array { - foreach ($state['indices'] as $key => $index) { - if ( - !$index['hasExpressions'] && - in_array(strtolower($columnName), $index['columns'], true) - ) { - unset($state['indices'][$key]); - } - } - - return $state; - }); - - return $instructions; - } - - /** - * Updates indices that reference a renamed column. - * - * @param \Phinx\Db\Util\AlterInstructions $instructions The instructions to modify - * @param string $oldColumnName The old column name - * @param string $newColumnName The new column name - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function updateIndicesForRenamedColumn( - AlterInstructions $instructions, - string $oldColumnName, - string $newColumnName, - ): AlterInstructions { - $instructions->addPostStep(function (array $state) use ($oldColumnName, $newColumnName): array { - foreach ($state['indices'] as $key => $index) { - if ( - !$index['hasExpressions'] && - in_array(strtolower($oldColumnName), $index['columns'], true) - ) { - $pattern = ' - / - (INDEX.+?ON\s.+?) - (\(\s*|,\s*) # opening parenthesis or comma - (?:`|"|\[)? # optional opening quote - (%s) # column name - (?:`|"|\])? # optional closing quote - (\s+COLLATE\s+.+?)? # optional collation - (\s+(?:ASC|DESC))? # optional order - (\s*,|\s*\)) # comma or closing parenthesis - /isx'; - - $newColumnName = $this->quoteColumnName($newColumnName); - - $state['indices'][$key]['sql'] = preg_replace( - sprintf($pattern, preg_quote($oldColumnName, '/')), - "\\1\\2$newColumnName\\4\\5\\6", - $index['sql'], - ); - } - } - - return $state; - }); - - return $instructions; - } - - /** - * Recreates indices and triggers. - * - * @param \Phinx\Db\Util\AlterInstructions $instructions The instructions to process - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function recreateIndicesAndTriggers(AlterInstructions $instructions): AlterInstructions - { - $instructions->addPostStep(function (array $state): array { - foreach ($state['indices'] as $index) { - $this->execute($index['sql']); - } - - foreach ($state['triggers'] as $trigger) { - $this->execute($trigger['sql']); - } - - return $state; - }); - - return $instructions; - } - - /** - * Returns instructions for validating the foreign key constraints of - * the given table, and of those tables whose constraints are - * targeting it. - * - * @param \Phinx\Db\Util\AlterInstructions $instructions The instructions to process - * @param string $tableName The name of the table for which to check constraints. - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function validateForeignKeys(AlterInstructions $instructions, string $tableName): AlterInstructions - { - $instructions->addPostStep(function ($state) use ($tableName) { - $tablesToCheck = [ - $tableName, - ]; - - $otherTables = $this - ->query( - "SELECT name FROM sqlite_master WHERE type = 'table' AND name != ?", - [$tableName], - ) - ->fetchAll(); - - foreach ($otherTables as $otherTable) { - $foreignKeyList = $this->getTableInfo($otherTable['name'], 'foreign_key_list'); - foreach ($foreignKeyList as $foreignKey) { - if (strcasecmp($foreignKey['table'], $tableName) === 0) { - $tablesToCheck[] = $otherTable['name']; - break; - } - } - } - - $tablesToCheck = array_unique(array_map('strtolower', $tablesToCheck)); - - foreach ($tablesToCheck as $tableToCheck) { - $schema = $this->getSchemaName($tableToCheck, true)['schema']; - - $stmt = $this->query( - sprintf('PRAGMA %sforeign_key_check(%s)', $schema, $this->quoteTableName($tableToCheck)), - ); - $row = $stmt->fetch(); - $stmt->closeCursor(); - - if (is_array($row)) { - throw new RuntimeException(sprintf( - 'Integrity constraint violation: FOREIGN KEY constraint on `%s` failed.', - $tableToCheck, - )); - } - } - - return $state; - }); - - return $instructions; - } - - /** - * Copies all the data from a tmp table to another table - * - * @param string $tableName The table name to copy the data to - * @param string $tmpTableName The tmp table name where the data is stored - * @param string[] $writeColumns The list of columns in the target table - * @param string[] $selectColumns The list of columns in the tmp table - * @return void - */ - protected function copyDataToNewTable(string $tableName, string $tmpTableName, array $writeColumns, array $selectColumns): void - { - $sql = sprintf( - 'INSERT INTO %s(%s) SELECT %s FROM %s', - $this->quoteTableName($tableName), - implode(', ', $writeColumns), - implode(', ', $selectColumns), - $this->quoteTableName($tmpTableName), - ); - $this->execute($sql); - } - - /** - * Modifies the passed instructions to copy all data from the table into - * the provided tmp table and then drops the table and rename tmp table. - * - * @param \Phinx\Db\Util\AlterInstructions $instructions The instructions to modify - * @param string $tableName The table name to copy the data to - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function copyAndDropTmpTable(AlterInstructions $instructions, string $tableName): AlterInstructions - { - $instructions->addPostStep(function ($state) use ($tableName) { - $this->copyDataToNewTable( - $state['tmpTableName'], - $tableName, - $state['writeColumns'], - $state['selectColumns'], - ); - - $this->execute(sprintf('DROP TABLE %s', $this->quoteTableName($tableName))); - $this->execute(sprintf( - 'ALTER TABLE %s RENAME TO %s', - $this->quoteTableName($state['tmpTableName']), - $this->quoteTableName($tableName), - )); - - return $state; - }); - - return $instructions; - } - - /** - * Returns the columns and type to use when copying a table to another in the process - * of altering a table - * - * @param string $tableName The table to modify - * @param string|false $columnName The column name that is about to change - * @param string|false $newColumnName Optionally the new name for the column - * @throws \InvalidArgumentException - * @return array - */ - protected function calculateNewTableColumns(string $tableName, string|false $columnName, string|false $newColumnName): array - { - $columns = $this->fetchAll(sprintf('pragma table_info(%s)', $this->quoteTableName($tableName))); - $selectColumns = []; - $writeColumns = []; - $columnType = null; - $found = false; - - foreach ($columns as $column) { - $selectName = $column['name']; - $writeName = $selectName; - - if ($selectName === $columnName) { - $writeName = $newColumnName; - $found = true; - $columnType = $column['type']; - $selectName = $newColumnName === false ? $newColumnName : $selectName; - } - - $selectColumns[] = $selectName; - $writeColumns[] = $writeName; - } - - $selectColumns = array_filter($selectColumns, 'strlen'); - $writeColumns = array_filter($writeColumns, 'strlen'); - $selectColumns = array_map([$this, 'quoteColumnName'], $selectColumns); - $writeColumns = array_map([$this, 'quoteColumnName'], $writeColumns); - - if ($columnName && !$found) { - throw new InvalidArgumentException(sprintf( - 'The specified column doesn\'t exist: ' . $columnName, - )); - } - - return compact('writeColumns', 'selectColumns', 'columnType'); - } - - /** - * Returns the initial instructions to alter a table using the - * create-copy-drop strategy - * - * @param string $tableName The table to modify - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function beginAlterByCopyTable(string $tableName): AlterInstructions - { - $instructions = new AlterInstructions(); - $instructions->addPostStep(function ($state) use ($tableName) { - $tmpTableName = "tmp_{$tableName}"; - $createSQL = $this->getDeclaringSql($tableName); - - // Table name in SQLite can be hilarious inside declaring SQL: - // - tableName - // - `tableName` - // - "tableName" - // - [this is a valid table name too!] - // - etc. - // Just remove all characters before first "(" and build them again - $createSQL = preg_replace( - "/^CREATE TABLE .* \(/Ui", - '', - $createSQL, - ); - - $createSQL = "CREATE TABLE {$this->quoteTableName($tmpTableName)} ({$createSQL}"; - - return compact('createSQL', 'tmpTableName') + $state; - }); - - return $instructions; - } - - /** - * Returns the final instructions to alter a table using the - * create-copy-drop strategy. - * - * @param \Phinx\Db\Util\AlterInstructions $instructions The instructions to modify - * @param string $tableName The name of table being processed - * @param ?string $renamedOrRemovedColumnName The name of the renamed or removed column when part of a column - * rename/drop operation. - * @param ?string $newColumnName The new column name when part of a column rename operation. - * @param bool $validateForeignKeys Whether to validate foreign keys after the copy and drop operations. Note that - * enabling this option only has an effect when the `foreign_keys` PRAGMA is set to `ON`! - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function endAlterByCopyTable( - AlterInstructions $instructions, - string $tableName, - ?string $renamedOrRemovedColumnName = null, - ?string $newColumnName = null, - bool $validateForeignKeys = true, - ): AlterInstructions { - $instructions = $this->bufferIndicesAndTriggers($instructions, $tableName); - - if ($renamedOrRemovedColumnName !== null) { - if ($newColumnName !== null) { - $this->updateIndicesForRenamedColumn($instructions, $renamedOrRemovedColumnName, $newColumnName); - } else { - $this->filterIndicesForRemovedColumn($instructions, $renamedOrRemovedColumnName); - } - } - - $foreignKeysEnabled = (bool)$this->fetchRow('PRAGMA foreign_keys')['foreign_keys']; - - if ($foreignKeysEnabled) { - $instructions->addPostStep('PRAGMA foreign_keys = OFF'); - } - - $instructions = $this->copyAndDropTmpTable($instructions, $tableName); - $instructions = $this->recreateIndicesAndTriggers($instructions); - - if ($foreignKeysEnabled) { - $instructions->addPostStep('PRAGMA foreign_keys = ON'); - } - - if ( - $foreignKeysEnabled && - $validateForeignKeys - ) { - $instructions = $this->validateForeignKeys($instructions, $tableName); - } - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getRenameColumnInstructions(string $tableName, string $columnName, string $newColumnName): AlterInstructions - { - $instructions = $this->beginAlterByCopyTable($tableName); - - $instructions->addPostStep(function ($state) use ($columnName, $newColumnName) { - $sql = str_replace( - $this->quoteColumnName($columnName), - $this->quoteColumnName($newColumnName), - $state['createSQL'], - ); - $this->execute($sql); - - return $state; - }); - - $instructions->addPostStep(function ($state) use ($columnName, $newColumnName, $tableName) { - $newState = $this->calculateNewTableColumns($tableName, $columnName, $newColumnName); - - return $newState + $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName, $columnName, $newColumnName); - } - - /** - * @inheritDoc - */ - protected function getChangeColumnInstructions(string $tableName, string $columnName, Column $newColumn): AlterInstructions - { - $instructions = $this->beginAlterByCopyTable($tableName); - - $newColumnName = $newColumn->getName(); - $instructions->addPostStep(function ($state) use ($columnName, $newColumn) { - $sql = preg_replace( - sprintf("/%s(?:\/\*.*?\*\/|\([^)]+\)|'[^']*?'|[^,])+([,)])/", $this->quoteColumnName($columnName)), - sprintf('%s %s$1', $this->quoteColumnName($newColumn->getName()), $this->getColumnSqlDefinition($newColumn)), - $state['createSQL'], - 1, - ); - $this->execute($sql); - - return $state; - }); - - $instructions->addPostStep(function ($state) use ($columnName, $newColumnName, $tableName) { - $newState = $this->calculateNewTableColumns($tableName, $columnName, $newColumnName); - - return $newState + $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName); - } - - /** - * @inheritDoc - */ - protected function getDropColumnInstructions(string $tableName, string $columnName): AlterInstructions - { - $instructions = $this->beginAlterByCopyTable($tableName); - - $instructions->addPostStep(function ($state) use ($tableName, $columnName) { - $newState = $this->calculateNewTableColumns($tableName, $columnName, false); - - return $newState + $state; - }); - - $instructions->addPostStep(function ($state) use ($columnName) { - $sql = preg_replace( - sprintf("/%s\s%s.*(,\s(?!')|\)$)/U", preg_quote($this->quoteColumnName($columnName)), preg_quote($state['columnType'])), - '', - $state['createSQL'], - ); - - if (substr($sql, -2) === ', ') { - $sql = substr($sql, 0, -2) . ')'; - } - - $this->execute($sql); - - return $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName, $columnName); - } - - /** - * Get an array of indexes from a particular table. - * - * @param string $tableName Table name - * @return array - */ - protected function getIndexes(string $tableName): array - { - $indexes = []; - $schema = $this->getSchemaName($tableName, true)['schema']; - $indexList = $this->getTableInfo($tableName, 'index_list'); - - foreach ($indexList as $index) { - $indexData = $this->fetchAll(sprintf('pragma %sindex_info(%s)', $schema, $this->quoteColumnName($index['name']))); - $cols = []; - foreach ($indexData as $indexItem) { - $cols[] = $indexItem['name']; - } - $indexes[$index['name']] = $cols; - } - - return $indexes; - } - - /** - * Finds the names of a table's indexes matching the supplied columns - * - * @param string $tableName The table to which the index belongs - * @param string|string[] $columns The columns of the index - * @return array - */ - protected function resolveIndex(string $tableName, string|array $columns): array - { - $columns = array_map('strtolower', (array)$columns); - $indexes = $this->getIndexes($tableName); - $matches = []; - - foreach ($indexes as $name => $index) { - $indexCols = array_map('strtolower', $index); - if ($columns == $indexCols) { - $matches[] = $name; - } - } - - return $matches; - } - - /** - * @inheritDoc - */ - public function hasIndex(string $tableName, string|array $columns): bool - { - return (bool)$this->resolveIndex($tableName, $columns); - } - - /** - * @inheritDoc - */ - public function hasIndexByName(string $tableName, string $indexName): bool - { - $indexName = strtolower($indexName); - $indexes = $this->getIndexes($tableName); - - foreach (array_keys($indexes) as $index) { - if ($indexName === strtolower($index)) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - protected function getAddIndexInstructions(Table $table, Index $index): AlterInstructions - { - $indexColumnArray = []; - foreach ($index->getColumns() as $column) { - $indexColumnArray[] = sprintf('`%s` ASC', $column); - } - $indexColumns = implode(',', $indexColumnArray); - $sql = sprintf( - 'CREATE %s ON %s (%s)', - $this->getIndexSqlDefinition($table, $index), - $this->quoteTableName($table->getName()), - $indexColumns, - ); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - protected function getDropIndexByColumnsInstructions(string $tableName, $columns): AlterInstructions - { - $instructions = new AlterInstructions(); - $indexNames = $this->resolveIndex($tableName, $columns); - $schema = $this->getSchemaName($tableName, true)['schema']; - foreach ($indexNames as $indexName) { - if (strpos($indexName, 'sqlite_autoindex_') !== 0) { - $instructions->addPostStep(sprintf( - 'DROP INDEX %s%s', - $schema, - $this->quoteColumnName($indexName), - )); - } - } - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getDropIndexByNameInstructions(string $tableName, string $indexName): AlterInstructions - { - $instructions = new AlterInstructions(); - $indexName = strtolower($indexName); - $indexes = $this->getIndexes($tableName); - - $found = false; - foreach (array_keys($indexes) as $index) { - if ($indexName === strtolower($index)) { - $found = true; - break; - } - } - - if ($found) { - $schema = $this->getSchemaName($tableName, true)['schema']; - $instructions->addPostStep(sprintf( - 'DROP INDEX %s%s', - $schema, - $this->quoteColumnName($indexName), - )); - } - - return $instructions; - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - public function hasPrimaryKey(string $tableName, $columns, ?string $constraint = null): bool - { - if ($constraint !== null) { - throw new InvalidArgumentException('SQLite does not support named constraints.'); - } - - $columns = array_map('strtolower', (array)$columns); - $primaryKey = array_map('strtolower', $this->getPrimaryKey($tableName)); - - if (array_diff($primaryKey, $columns) || array_diff($columns, $primaryKey)) { - return false; - } - - return true; - } - - /** - * Get the primary key from a particular table. - * - * @param string $tableName Table name - * @return string[] - */ - protected function getPrimaryKey(string $tableName): array - { - $primaryKey = []; - - $rows = $this->getTableInfo($tableName); - - foreach ($rows as $row) { - if ($row['pk'] > 0) { - $primaryKey[$row['pk'] - 1] = $row['name']; - } - } - - return $primaryKey; - } - - /** - * @inheritDoc - */ - public function hasForeignKey(string $tableName, $columns, ?string $constraint = null): bool - { - if ($constraint !== null) { - return preg_match( - "/,?\s*CONSTRAINT\s*" . $this->possiblyQuotedIdentifierRegex($constraint) . '\s*FOREIGN\s+KEY/is', - $this->getDeclaringSql($tableName), - ) === 1; - } - - $columns = array_map('mb_strtolower', (array)$columns); - - foreach ($this->getForeignKeys($tableName) as $key) { - if (array_map('mb_strtolower', $key) === $columns) { - return true; - } - } - - return false; - } - - /** - * Get an array of foreign keys from a particular table. - * - * @param string $tableName Table name - * @return array - */ - protected function getForeignKeys(string $tableName): array - { - $foreignKeys = []; - - $rows = $this->getTableInfo($tableName, 'foreign_key_list'); - - foreach ($rows as $row) { - if (!isset($foreignKeys[$row['id']])) { - $foreignKeys[$row['id']] = []; - } - $foreignKeys[$row['id']][$row['seq']] = $row['from']; - } - - return $foreignKeys; - } - - /** - * @param \Phinx\Db\Table\Table $table The Table - * @param string $column Column Name - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function getAddPrimaryKeyInstructions(Table $table, string $column): AlterInstructions - { - $instructions = $this->beginAlterByCopyTable($table->getName()); - - $tableName = $table->getName(); - $instructions->addPostStep(function ($state) use ($column) { - $matchPattern = "/(`$column`)\s+(\w+(\(\d+\))?)\s+((NOT )?NULL)/"; - - $sql = $state['createSQL']; - - if (preg_match($matchPattern, $state['createSQL'], $matches)) { - if (isset($matches[2])) { - if ($matches[2] === 'INTEGER') { - $replace = '$1 INTEGER NOT NULL PRIMARY KEY AUTOINCREMENT'; - } else { - $replace = '$1 $2 NOT NULL PRIMARY KEY'; - } - - $sql = preg_replace($matchPattern, $replace, $state['createSQL'], 1); - } - } - - $this->execute($sql); - - return $state; - }); - - $instructions->addPostStep(function ($state) { - $columns = $this->fetchAll(sprintf('pragma table_info(%s)', $this->quoteTableName($state['tmpTableName']))); - $names = array_map([$this, 'quoteColumnName'], array_column($columns, 'name')); - $selectColumns = $writeColumns = $names; - - return compact('selectColumns', 'writeColumns') + $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName); - } - - /** - * @param \Phinx\Db\Table\Table $table Table - * @param string $column Column Name - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function getDropPrimaryKeyInstructions(Table $table, string $column): AlterInstructions - { - $tableName = $table->getName(); - $instructions = $this->beginAlterByCopyTable($tableName); - - $instructions->addPostStep(function ($state) { - $search = "/(,?\s*PRIMARY KEY\s*\([^\)]*\)|\s+PRIMARY KEY(\s+AUTOINCREMENT)?)/"; - $sql = preg_replace($search, '', $state['createSQL'], 1); - - if ($sql) { - $this->execute($sql); - } - - return $state; - }); - - $instructions->addPostStep(function ($state) use ($column) { - $newState = $this->calculateNewTableColumns($state['tmpTableName'], $column, $column); - - return $newState + $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName, null, null, false); - } - - /** - * @inheritDoc - */ - protected function getAddForeignKeyInstructions(Table $table, ForeignKey $foreignKey): AlterInstructions - { - $instructions = $this->beginAlterByCopyTable($table->getName()); - - $tableName = $table->getName(); - $instructions->addPostStep(function ($state) use ($foreignKey, $tableName) { - $this->execute('pragma foreign_keys = ON'); - $sql = substr($state['createSQL'], 0, -1) . ',' . $this->getForeignKeySqlDefinition($foreignKey) . '); '; - - //Delete indexes from original table and recreate them in temporary table - $schema = $this->getSchemaName($tableName, true)['schema']; - $tmpTableName = $state['tmpTableName']; - $indexes = $this->getIndexes($tableName); - foreach (array_keys($indexes) as $indexName) { - if (strpos($indexName, 'sqlite_autoindex_') !== 0) { - $sql .= sprintf( - 'DROP INDEX %s%s; ', - $schema, - $this->quoteColumnName($indexName), - ); - $createIndexSQL = $this->getDeclaringIndexSQL($tableName, $indexName); - $sql .= preg_replace( - "/\b{$tableName}\b/", - $tmpTableName, - $createIndexSQL, - ); - } - } - - $this->execute($sql); - - return $state; - }); - - $instructions->addPostStep(function ($state) { - $columns = $this->fetchAll(sprintf('pragma table_info(%s)', $this->quoteTableName($state['tmpTableName']))); - $names = array_map([$this, 'quoteColumnName'], array_column($columns, 'name')); - $selectColumns = $writeColumns = $names; - - return compact('selectColumns', 'writeColumns') + $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName); - } - - /** - * {@inheritDoc} - * - * SQLiteAdapter does not implement this functionality, and so will always throw an exception if used. - * - * @throws \BadMethodCallException - */ - protected function getDropForeignKeyInstructions(string $tableName, string $constraint): AlterInstructions - { - throw new BadMethodCallException('SQLite does not have named foreign keys'); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getDropForeignKeyByColumnsInstructions(string $tableName, array $columns): AlterInstructions - { - if (!$this->hasForeignKey($tableName, $columns)) { - throw new InvalidArgumentException(sprintf( - 'No foreign key on column(s) `%s` exists', - implode(', ', $columns), - )); - } - - $instructions = $this->beginAlterByCopyTable($tableName); - - $instructions->addPostStep(function ($state) use ($columns) { - $search = sprintf( - "/,[^,]+?\(\s*%s\s*\)\s*REFERENCES[^,]*\([^\)]*\)[^,)]*/is", - implode( - '\s*,\s*', - array_map( - fn($column) => $this->possiblyQuotedIdentifierRegex($column, false), - $columns, - ), - ), - ); - $sql = preg_replace($search, '', $state['createSQL']); - - if ($sql) { - $this->execute($sql); - } - - return $state; - }); - - $instructions->addPostStep(function ($state) { - $newState = $this->calculateNewTableColumns($state['tmpTableName'], false, false); - - return $newState + $state; - }); - - return $this->endAlterByCopyTable($instructions, $tableName); - } - - /** - * {@inheritDoc} - * - * @throws \Phinx\Db\Adapter\UnsupportedColumnTypeException - */ - public function getSqlType(Literal|string $type, ?int $limit = null): array - { - if ($type instanceof Literal) { - $name = $type; - } else { - $typeLC = strtolower($type); - - if (isset(static::$supportedColumnTypes[$typeLC])) { - $name = static::$supportedColumnTypes[$typeLC]; - } elseif (in_array($typeLC, static::$unsupportedColumnTypes, true)) { - throw new UnsupportedColumnTypeException('Column type "' . $type . '" is not supported by SQLite.'); - } else { - throw new UnsupportedColumnTypeException('Column type "' . $type . '" is not known by SQLite.'); - } - } - - return ['name' => $name, 'limit' => $limit]; - } - - /** - * Returns Phinx type by SQL type - * - * @param string|null $sqlTypeDef SQL Type definition - * @return array - */ - public function getPhinxType(?string $sqlTypeDef): array - { - $limit = null; - $scale = null; - if ($sqlTypeDef === null) { - // in SQLite columns can legitimately have null as a type, which is distinct from the empty string - $name = null; - } elseif (!preg_match('/^([a-z]+)(_(?:integer|float|text|blob))?(?:\((\d+)(?:,[ ]*(\d+))?\))?$/i', $sqlTypeDef, $match)) { - // doesn't match the pattern of a type we'd know about - $name = Literal::from($sqlTypeDef); - } else { - // possibly a known type - $type = $match[1]; - $typeLC = strtolower($type); - $affinity = $match[2] ?? ''; - $limit = isset($match[3]) && strlen($match[3]) ? (int)$match[3] : null; - $scale = isset($match[4]) && strlen($match[4]) ? (int)$match[4] : null; - if (in_array($typeLC, ['tinyint', 'tinyinteger'], true) && $limit === 1) { - // the type is a MySQL-style boolean - $name = static::PHINX_TYPE_BOOLEAN; - $limit = null; - } elseif (isset(static::$supportedColumnTypes[$typeLC])) { - // the type is an explicitly supported type - $name = $typeLC; - } elseif (isset(static::$supportedColumnTypeAliases[$typeLC])) { - // the type is an alias for a supported type - $name = static::$supportedColumnTypeAliases[$typeLC]; - } elseif (in_array($typeLC, static::$unsupportedColumnTypes, true)) { - // unsupported but known types are passed through lowercased, and without appended affinity - $name = Literal::from($typeLC); - } else { - // unknown types are passed through as-is - $name = Literal::from($type . $affinity); - } - } - - return [ - 'name' => $name, - 'limit' => $limit, - 'scale' => $scale, - ]; - } - - /** - * @inheritDoc - */ - public function createDatabase(string $name, array $options = []): void - { - touch($name . $this->suffix); - } - - /** - * @inheritDoc - */ - public function hasDatabase(string $name): bool - { - return is_file($name . $this->suffix); - } - - /** - * @inheritDoc - */ - public function dropDatabase(string $name): void - { - $this->createdTables = []; - if ($this->getOption('memory')) { - $this->disconnect(); - $this->connect(); - } - if (file_exists($name . $this->suffix)) { - unlink($name . $this->suffix); - } - } - - /** - * Gets the SQLite Column Definition for a Column object. - * - * @param \Phinx\Db\Table\Column $column Column - * @return string - */ - protected function getColumnSqlDefinition(Column $column): string - { - $isLiteralType = $column->getType() instanceof Literal; - if ($isLiteralType) { - $def = (string)$column->getType(); - } else { - $sqlType = $this->getSqlType($column->getType()); - $def = strtoupper($sqlType['name']); - - $limitable = in_array(strtoupper($sqlType['name']), $this->definitionsWithLimits, true); - if (($column->getLimit() || isset($sqlType['limit'])) && $limitable) { - $def .= '(' . ($column->getLimit() ?: $sqlType['limit']) . ')'; - } - } - if ($column->getPrecision() && $column->getScale()) { - $def .= '(' . $column->getPrecision() . ',' . $column->getScale() . ')'; - } - - $default = $column->getDefault(); - - $def .= $column->isNull() ? ' NULL' : ' NOT NULL'; - $def .= $this->getDefaultValueDefinition($default, $column->getType()); - $def .= $column->isIdentity() ? ' PRIMARY KEY AUTOINCREMENT' : ''; - - $def .= $this->getCommentDefinition($column); - - return $def; - } - - /** - * Gets the comment Definition for a Column object. - * - * @param \Phinx\Db\Table\Column $column Column - * @return string - */ - protected function getCommentDefinition(Column $column): string - { - if ($column->getComment()) { - return ' /* ' . $column->getComment() . ' */ '; - } - - return ''; - } - - /** - * Gets the SQLite Index Definition for an Index object. - * - * @param \Phinx\Db\Table\Table $table Table - * @param \Phinx\Db\Table\Index $index Index - * @return string - */ - protected function getIndexSqlDefinition(Table $table, Index $index): string - { - if ($index->getType() === Index::UNIQUE) { - $def = 'UNIQUE INDEX'; - } else { - $def = 'INDEX'; - } - if (is_string($index->getName())) { - $indexName = $index->getName(); - } else { - $indexName = $table->getName() . '_'; - foreach ($index->getColumns() as $column) { - $indexName .= $column . '_'; - } - $indexName .= 'index'; - } - $def .= ' `' . $indexName . '`'; - - return $def; - } - - /** - * @inheritDoc - */ - public function getColumnTypes(): array - { - return array_keys(static::$supportedColumnTypes); - } - - /** - * Gets the SQLite Foreign Key Definition for an ForeignKey object. - * - * @param \Phinx\Db\Table\ForeignKey $foreignKey Foreign key - * @return string - */ - protected function getForeignKeySqlDefinition(ForeignKey $foreignKey): string - { - $def = ''; - if ($foreignKey->getConstraint()) { - $def .= ' CONSTRAINT ' . $this->quoteColumnName($foreignKey->getConstraint()); - } - $columnNames = []; - foreach ($foreignKey->getColumns() as $column) { - $columnNames[] = $this->quoteColumnName($column); - } - $def .= ' FOREIGN KEY (' . implode(',', $columnNames) . ')'; - $refColumnNames = []; - foreach ($foreignKey->getReferencedColumns() as $column) { - $refColumnNames[] = $this->quoteColumnName($column); - } - $def .= ' REFERENCES ' . $this->quoteTableName($foreignKey->getReferencedTable()->getName()) . ' (' . implode(',', $refColumnNames) . ')'; - if ($foreignKey->getOnDelete()) { - $def .= ' ON DELETE ' . $foreignKey->getOnDelete(); - } - if ($foreignKey->getOnUpdate()) { - $def .= ' ON UPDATE ' . $foreignKey->getOnUpdate(); - } - - return $def; - } - - /** - * @inheritDoc - */ - public function getDecoratedConnection(): Connection - { - if (isset($this->decoratedConnection)) { - return $this->decoratedConnection; - } - - $options = $this->getOptions(); - $options['quoteIdentifiers'] = true; - - if (!empty($options['name'])) { - $options['database'] = $options['name']; - - if (file_exists($options['name'] . $this->suffix)) { - $options['database'] = $options['name'] . $this->suffix; - } - } - - return $this->decoratedConnection = $this->buildConnection(SqliteDriver::class, $options); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/SqlServerAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/SqlServerAdapter.php deleted file mode 100644 index 37b4bfd5e..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/SqlServerAdapter.php +++ /dev/null @@ -1,1378 +0,0 @@ - true, - self::PHINX_TYPE_BIG_INTEGER => true, - self::PHINX_TYPE_FLOAT => true, - self::PHINX_TYPE_DECIMAL => true, - ]; - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - * @return void - */ - public function connect(): void - { - if ($this->connection === null) { - if (!class_exists('PDO') || !in_array('sqlsrv', PDO::getAvailableDrivers(), true)) { - // try our connection via freetds (Mac/Linux) - $this->connectDblib(); - - return; - } - - $options = $this->getOptions(); - - $dsn = 'sqlsrv:server=' . $options['host']; - // if port is specified use it, otherwise use the SqlServer default - if (!empty($options['port'])) { - $dsn .= ',' . $options['port']; - } - $dsn .= ';database=' . $options['name'] . ';MultipleActiveResultSets=false'; - - // option to add additional connection options - // https://docs.microsoft.com/en-us/sql/connect/php/connection-options?view=sql-server-ver15 - if (isset($options['dsn_options'])) { - foreach ($options['dsn_options'] as $key => $option) { - $dsn .= ';' . $key . '=' . $option; - } - } - - $driverOptions = []; - - // charset support - if (isset($options['charset'])) { - $driverOptions[PDO::SQLSRV_ATTR_ENCODING] = $options['charset']; - } - - // use custom data fetch mode - if (!empty($options['fetch_mode'])) { - $driverOptions[PDO::ATTR_DEFAULT_FETCH_MODE] = constant('\PDO::FETCH_' . strtoupper($options['fetch_mode'])); - } - - // Note, the PDO::ATTR_PERSISTENT attribute is not supported for sqlsrv and will throw an error when used - // See https://github.com/Microsoft/msphpsql/issues/65 - - // support arbitrary \PDO::SQLSRV_ATTR_* driver options and pass them to PDO - // https://php.net/manual/en/ref.pdo-sqlsrv.php#pdo-sqlsrv.constants - foreach ($options as $key => $option) { - if (strpos($key, 'sqlsrv_attr_') === 0) { - $pdoConstant = '\PDO::' . strtoupper($key); - if (!defined($pdoConstant)) { - throw new UnexpectedValueException('Invalid PDO attribute: ' . $key . ' (' . $pdoConstant . ')'); - } - $driverOptions[constant($pdoConstant)] = $option; - } - } - - $db = $this->createPdoConnection($dsn, $options['user'] ?? null, $options['pass'] ?? null, $driverOptions); - - $this->setConnection($db); - } - } - - /** - * Connect to MSSQL using dblib/freetds. - * - * The "sqlsrv" driver is not available on Unix machines. - * - * @throws \InvalidArgumentException - * @throws \RuntimeException - * @return void - */ - protected function connectDblib(): void - { - if (!class_exists('PDO') || !in_array('dblib', PDO::getAvailableDrivers(), true)) { - // @codeCoverageIgnoreStart - throw new RuntimeException('You need to enable the PDO_Dblib extension for Phinx to run properly.'); - // @codeCoverageIgnoreEnd - } - - $options = $this->getOptions(); - - // if port is specified use it, otherwise use the SqlServer default - if (empty($options['port'])) { - $dsn = 'dblib:host=' . $options['host'] . ';dbname=' . $options['name']; - } else { - $dsn = 'dblib:host=' . $options['host'] . ':' . $options['port'] . ';dbname=' . $options['name']; - } - - $driverOptions = [PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION]; - - try { - $db = new PDO($dsn, $options['user'], $options['pass'], $driverOptions); - } catch (PDOException $exception) { - throw new InvalidArgumentException(sprintf( - 'There was a problem connecting to the database: %s', - $exception->getMessage(), - ), 0, $exception); - } - - $this->setConnection($db); - } - - /** - * @inheritDoc - */ - public function disconnect(): void - { - $this->connection = null; - } - - /** - * @inheritDoc - */ - public function hasTransactions(): bool - { - return true; - } - - /** - * @inheritDoc - */ - public function beginTransaction(): void - { - $this->execute('BEGIN TRANSACTION'); - } - - /** - * @inheritDoc - */ - public function commitTransaction(): void - { - $this->execute('COMMIT TRANSACTION'); - } - - /** - * @inheritDoc - */ - public function rollbackTransaction(): void - { - $this->execute('ROLLBACK TRANSACTION'); - } - - /** - * @inheritDoc - */ - public function quoteTableName(string $tableName): string - { - return str_replace('.', '].[', $this->quoteColumnName($tableName)); - } - - /** - * @inheritDoc - */ - public function quoteColumnName(string $columnName): string - { - return '[' . str_replace(']', ']]', $columnName) . ']'; - } - - /** - * @inheritDoc - */ - public function hasTable(string $tableName): bool - { - if ($this->hasCreatedTable($tableName)) { - return true; - } - - /** @var array $result */ - $result = $this->fetchRow(sprintf("SELECT count(*) as [count] FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = '%s';", $tableName)); - - return $result['count'] > 0; - } - - /** - * @inheritDoc - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void - { - $options = $table->getOptions(); - - // Add the default primary key - if (!isset($options['id']) || (isset($options['id']) && $options['id'] === true)) { - $options['id'] = 'id'; - } - - if (isset($options['id']) && is_string($options['id'])) { - // Handle id => "field_name" to support AUTO_INCREMENT - $column = new Column(); - $column->setName($options['id']) - ->setType('integer') - ->setOptions(['identity' => true]); - - array_unshift($columns, $column); - if (isset($options['primary_key']) && (array)$options['id'] !== (array)$options['primary_key']) { - throw new InvalidArgumentException('You cannot enable an auto incrementing ID field and a primary key'); - } - $options['primary_key'] = $options['id']; - } - - $sql = 'CREATE TABLE '; - $sql .= $this->quoteTableName($table->getName()) . ' ('; - $sqlBuffer = []; - $columnsWithComments = []; - foreach ($columns as $column) { - $sqlBuffer[] = $this->quoteColumnName($column->getName()) . ' ' . $this->getColumnSqlDefinition($column); - - // set column comments, if needed - if ($column->getComment()) { - $columnsWithComments[] = $column; - } - } - - // set the primary key(s) - if (isset($options['primary_key'])) { - $pkSql = sprintf('CONSTRAINT PK_%s PRIMARY KEY (', str_replace('.', '_', $table->getName())); - if (is_string($options['primary_key'])) { // handle primary_key => 'id' - $pkSql .= $this->quoteColumnName($options['primary_key']); - } elseif (is_array($options['primary_key'])) { // handle primary_key => array('tag_id', 'resource_id') - $pkSql .= implode(',', array_map([$this, 'quoteColumnName'], $options['primary_key'])); - } - $pkSql .= ')'; - $sqlBuffer[] = $pkSql; - } - - $sql .= implode(', ', $sqlBuffer); - $sql .= ');'; - - // process column comments - foreach ($columnsWithComments as $column) { - $sql .= $this->getColumnCommentSqlDefinition($column, $table->getName()); - } - - // set the indexes - foreach ($indexes as $index) { - $sql .= $this->getIndexSqlDefinition($index, $table->getName()); - } - - // execute the sql - $this->execute($sql); - - $this->addCreatedTable($table->getName()); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getChangePrimaryKeyInstructions(Table $table, $newColumns): AlterInstructions - { - $instructions = new AlterInstructions(); - - // Drop the existing primary key - $primaryKey = $this->getPrimaryKey($table->getName()); - if (!empty($primaryKey['constraint'])) { - $sql = sprintf( - 'DROP CONSTRAINT %s', - $this->quoteColumnName($primaryKey['constraint']), - ); - $instructions->addAlter($sql); - } - - // Add the primary key(s) - if (!empty($newColumns)) { - $sql = sprintf( - 'ALTER TABLE %s ADD CONSTRAINT %s PRIMARY KEY (', - $this->quoteTableName($table->getName()), - $this->quoteColumnName('PK_' . $table->getName()), - ); - if (is_string($newColumns)) { // handle primary_key => 'id' - $sql .= $this->quoteColumnName($newColumns); - } elseif (is_array($newColumns)) { // handle primary_key => array('tag_id', 'resource_id') - $sql .= implode(',', array_map([$this, 'quoteColumnName'], $newColumns)); - } else { - throw new InvalidArgumentException(sprintf( - 'Invalid value for primary key: %s', - json_encode($newColumns), - )); - } - $sql .= ')'; - $instructions->addPostStep($sql); - } - - return $instructions; - } - - /** - * @inheritDoc - * - * SqlServer does not implement this functionality, and so will always throw an exception if used. - * @throws \BadMethodCallException - */ - protected function getChangeCommentInstructions(Table $table, ?string $newComment): AlterInstructions - { - throw new BadMethodCallException('SqlServer does not have table comments'); - } - - /** - * Gets the SqlServer Column Comment Defininition for a column object. - * - * @param \Phinx\Db\Table\Column $column Column - * @param string $tableName Table name - * @return string - */ - protected function getColumnCommentSqlDefinition(Column $column, string $tableName): string - { - // passing 'null' is to remove column comment - $currentComment = $this->getColumnComment($tableName, $column->getName()); - - $comment = strcasecmp($column->getComment(), 'NULL') !== 0 ? $this->getConnection()->quote($column->getComment()) : '\'\''; - $command = $currentComment === null ? 'sp_addextendedproperty' : 'sp_updateextendedproperty'; - - return sprintf( - "EXECUTE %s N'MS_Description', N%s, N'SCHEMA', N'%s', N'TABLE', N'%s', N'COLUMN', N'%s';", - $command, - $comment, - $this->schema, - $tableName, - $column->getName(), - ); - } - - /** - * @inheritDoc - */ - protected function getRenameTableInstructions(string $tableName, string $newTableName): AlterInstructions - { - $this->updateCreatedTableName($tableName, $newTableName); - $sql = sprintf( - "EXEC sp_rename '%s', '%s'", - $tableName, - $newTableName, - ); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - protected function getDropTableInstructions(string $tableName): AlterInstructions - { - $this->removeCreatedTable($tableName); - $sql = sprintf('DROP TABLE %s', $this->quoteTableName($tableName)); - - return new AlterInstructions([], [$sql]); - } - - /** - * @inheritDoc - */ - public function truncateTable(string $tableName): void - { - $sql = sprintf( - 'TRUNCATE TABLE %s', - $this->quoteTableName($tableName), - ); - - $this->execute($sql); - } - - /** - * @param string $tableName Table name - * @param string $columnName Column name - * @return string|null - */ - public function getColumnComment(string $tableName, string $columnName): ?string - { - $sql = sprintf("SELECT cast(extended_properties.[value] as nvarchar(4000)) comment - FROM sys.schemas - INNER JOIN sys.tables - ON schemas.schema_id = tables.schema_id - INNER JOIN sys.columns - ON tables.object_id = columns.object_id - INNER JOIN sys.extended_properties - ON tables.object_id = extended_properties.major_id - AND columns.column_id = extended_properties.minor_id - AND extended_properties.name = 'MS_Description' - WHERE schemas.[name] = '%s' AND tables.[name] = '%s' AND columns.[name] = '%s'", $this->schema, $tableName, $columnName); - $row = $this->fetchRow($sql); - - if ($row) { - return trim($row['comment']); - } - - return null; - } - - /** - * @inheritDoc - */ - public function getColumns(string $tableName): array - { - $columns = []; - $sql = sprintf( - "SELECT DISTINCT TABLE_SCHEMA AS [schema], TABLE_NAME as [table_name], COLUMN_NAME AS [name], DATA_TYPE AS [type], - IS_NULLABLE AS [null], COLUMN_DEFAULT AS [default], - CHARACTER_MAXIMUM_LENGTH AS [char_length], - NUMERIC_PRECISION AS [precision], - NUMERIC_SCALE AS [scale], ORDINAL_POSITION AS [ordinal_position], - COLUMNPROPERTY(object_id(TABLE_NAME), COLUMN_NAME, 'IsIdentity') as [identity] - FROM INFORMATION_SCHEMA.COLUMNS - WHERE TABLE_NAME = '%s' - ORDER BY ordinal_position", - $tableName, - ); - $rows = $this->fetchAll($sql); - foreach ($rows as $columnInfo) { - try { - $type = $this->getPhinxType($columnInfo['type']); - } catch (UnsupportedColumnTypeException $e) { - $type = Literal::from($columnInfo['type']); - } - - $column = new Column(); - $column->setName($columnInfo['name']) - ->setType($type) - ->setNull($columnInfo['null'] !== 'NO') - ->setDefault($this->parseDefault($columnInfo['default'])) - ->setIdentity($columnInfo['identity'] === '1') - ->setComment($this->getColumnComment($columnInfo['table_name'], $columnInfo['name'])); - - if (!empty($columnInfo['char_length'])) { - $column->setLimit((int)$columnInfo['char_length']); - } - - $columns[$columnInfo['name']] = $column; - } - - return $columns; - } - - /** - * @param string|null $default Default - * @return int|string|null - */ - protected function parseDefault(?string $default): int|string|null - { - // if a column is non-nullable and has no default, the value of column_default is null, - // otherwise it should be a string value that we parse below, including "(NULL)" which - // also stands for a null default - if ($default === null) { - return null; - } - - $result = preg_replace(["/\('(.*)'\)/", "/\(\((.*)\)\)/", "/\((.*)\)/"], '$1', $default); - - if (strtoupper($result) === 'NULL') { - $result = null; - } elseif (is_numeric($result)) { - $result = (int)$result; - } - - return $result; - } - - /** - * @inheritDoc - */ - public function hasColumn(string $tableName, string $columnName): bool - { - $sql = sprintf( - "SELECT count(*) as [count] - FROM INFORMATION_SCHEMA.COLUMNS - WHERE TABLE_NAME = '%s' AND COLUMN_NAME = '%s'", - $tableName, - $columnName, - ); - /** @var array $result */ - $result = $this->fetchRow($sql); - - return $result['count'] > 0; - } - - /** - * @inheritDoc - */ - protected function getAddColumnInstructions(Table $table, Column $column): AlterInstructions - { - $alter = sprintf( - 'ALTER TABLE %s ADD %s %s', - $table->getName(), - $this->quoteColumnName($column->getName()), - $this->getColumnSqlDefinition($column), - ); - - return new AlterInstructions([], [$alter]); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getRenameColumnInstructions(string $tableName, string $columnName, string $newColumnName): AlterInstructions - { - if (!$this->hasColumn($tableName, $columnName)) { - throw new InvalidArgumentException("The specified column does not exist: $columnName"); - } - - $instructions = new AlterInstructions(); - - $oldConstraintName = "DF_{$tableName}_{$columnName}"; - $newConstraintName = "DF_{$tableName}_{$newColumnName}"; - $sql = <<addPostStep(sprintf( - $sql, - $oldConstraintName, - $newConstraintName, - )); - - $instructions->addPostStep(sprintf( - "EXECUTE sp_rename N'%s.%s', N'%s', 'COLUMN' ", - $tableName, - $columnName, - $newColumnName, - )); - - return $instructions; - } - - /** - * Returns the instructions to change a column default value - * - * @param string $tableName The table where the column is - * @param \Phinx\Db\Table\Column $newColumn The column to alter - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function getChangeDefault(string $tableName, Column $newColumn): AlterInstructions - { - $constraintName = "DF_{$tableName}_{$newColumn->getName()}"; - $default = $newColumn->getDefault(); - $instructions = new AlterInstructions(); - - if ($default === null) { - $default = 'DEFAULT NULL'; - } else { - $default = ltrim($this->getDefaultValueDefinition($default)); - } - - if (empty($default)) { - return $instructions; - } - - $instructions->addPostStep(sprintf( - 'ALTER TABLE %s ADD CONSTRAINT %s %s FOR %s', - $this->quoteTableName($tableName), - $constraintName, - $default, - $this->quoteColumnName($newColumn->getName()), - )); - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getChangeColumnInstructions(string $tableName, string $columnName, Column $newColumn): AlterInstructions - { - $columns = $this->getColumns($tableName); - $changeDefault = - $newColumn->getDefault() !== $columns[$columnName]->getDefault() || - $newColumn->getType() !== $columns[$columnName]->getType(); - - $instructions = new AlterInstructions(); - - if ($columnName !== $newColumn->getName()) { - $instructions->merge( - $this->getRenameColumnInstructions($tableName, $columnName, $newColumn->getName()), - ); - } - - if ($changeDefault) { - $instructions->merge($this->getDropDefaultConstraint($tableName, $newColumn->getName())); - } - - $instructions->addPostStep(sprintf( - 'ALTER TABLE %s ALTER COLUMN %s %s', - $this->quoteTableName($tableName), - $this->quoteColumnName($newColumn->getName()), - $this->getColumnSqlDefinition($newColumn, false), - )); - // change column comment if needed - if ($newColumn->getComment()) { - $instructions->addPostStep($this->getColumnCommentSqlDefinition($newColumn, $tableName)); - } - - if ($changeDefault) { - $instructions->merge($this->getChangeDefault($tableName, $newColumn)); - } - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getDropColumnInstructions(string $tableName, string $columnName): AlterInstructions - { - $instructions = $this->getDropDefaultConstraint($tableName, $columnName); - - $instructions->addPostStep(sprintf( - 'ALTER TABLE %s DROP COLUMN %s', - $this->quoteTableName($tableName), - $this->quoteColumnName($columnName), - )); - - return $instructions; - } - - /** - * @param string $tableName Table name - * @param string|null $columnName Column name - * @return \Phinx\Db\Util\AlterInstructions - */ - protected function getDropDefaultConstraint(string $tableName, ?string $columnName): AlterInstructions - { - $defaultConstraint = $this->getDefaultConstraint($tableName, $columnName); - - if (!$defaultConstraint) { - return new AlterInstructions(); - } - - return $this->getDropForeignKeyInstructions($tableName, $defaultConstraint); - } - - /** - * @param string $tableName Table name - * @param string $columnName Column name - * @return string|false - */ - protected function getDefaultConstraint(string $tableName, string $columnName): string|false - { - $sql = "SELECT - default_constraints.name -FROM - sys.all_columns - - INNER JOIN - sys.tables - ON all_columns.object_id = tables.object_id - - INNER JOIN - sys.schemas - ON tables.schema_id = schemas.schema_id - - INNER JOIN - sys.default_constraints - ON all_columns.default_object_id = default_constraints.object_id - -WHERE - schemas.name = 'dbo' - AND tables.name = '{$tableName}' - AND all_columns.name = '{$columnName}'"; - - $rows = $this->fetchAll($sql); - - return empty($rows) ? false : $rows[0]['name']; - } - - /** - * @param string $tableId Table ID - * @param string $indexId Index ID - * @return array - */ - protected function getIndexColums(string $tableId, string $indexId): array - { - $sql = "SELECT AC.[name] AS [column_name] -FROM sys.[index_columns] IC - INNER JOIN sys.[all_columns] AC ON IC.[column_id] = AC.[column_id] -WHERE AC.[object_id] = {$tableId} AND IC.[index_id] = {$indexId} AND IC.[object_id] = {$tableId} -ORDER BY IC.[key_ordinal];"; - - $rows = $this->fetchAll($sql); - $columns = []; - foreach ($rows as $row) { - $columns[] = strtolower($row['column_name']); - } - - return $columns; - } - - /** - * Get an array of indexes from a particular table. - * - * @param string $tableName Table name - * @return array - */ - public function getIndexes(string $tableName): array - { - $indexes = []; - $sql = "SELECT I.[name] AS [index_name], I.[index_id] as [index_id], T.[object_id] as [table_id] -FROM sys.[tables] AS T - INNER JOIN sys.[indexes] I ON T.[object_id] = I.[object_id] -WHERE T.[is_ms_shipped] = 0 AND I.[type_desc] <> 'HEAP' AND T.[name] = '{$tableName}' -ORDER BY T.[name], I.[index_id];"; - - $rows = $this->fetchAll($sql); - foreach ($rows as $row) { - $columns = $this->getIndexColums($row['table_id'], $row['index_id']); - $indexes[$row['index_name']] = ['columns' => $columns]; - } - - return $indexes; - } - - /** - * @inheritDoc - */ - public function hasIndex(string $tableName, string|array $columns): bool - { - if (is_string($columns)) { - $columns = [$columns]; // str to array - } - - $columns = array_map('strtolower', $columns); - $indexes = $this->getIndexes($tableName); - - foreach ($indexes as $index) { - $a = array_diff($columns, $index['columns']); - - if (empty($a)) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - public function hasIndexByName(string $tableName, string $indexName): bool - { - $indexes = $this->getIndexes($tableName); - - foreach ($indexes as $name => $index) { - if ($name === $indexName) { - return true; - } - } - - return false; - } - - /** - * @inheritDoc - */ - protected function getAddIndexInstructions(Table $table, Index $index): AlterInstructions - { - $sql = $this->getIndexSqlDefinition($index, $table->getName()); - - return new AlterInstructions([], [$sql]); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getDropIndexByColumnsInstructions(string $tableName, $columns): AlterInstructions - { - if (is_string($columns)) { - $columns = [$columns]; // str to array - } - - $indexes = $this->getIndexes($tableName); - $columns = array_map('strtolower', $columns); - $instructions = new AlterInstructions(); - - foreach ($indexes as $indexName => $index) { - $a = array_diff($columns, $index['columns']); - if (empty($a)) { - $instructions->addPostStep(sprintf( - 'DROP INDEX %s ON %s', - $this->quoteColumnName($indexName), - $this->quoteTableName($tableName), - )); - - return $instructions; - } - } - - throw new InvalidArgumentException(sprintf( - "The specified index on columns '%s' does not exist", - implode(',', $columns), - )); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - */ - protected function getDropIndexByNameInstructions(string $tableName, string $indexName): AlterInstructions - { - $indexes = $this->getIndexes($tableName); - $instructions = new AlterInstructions(); - - foreach ($indexes as $name => $index) { - if ($name === $indexName) { - $instructions->addPostStep(sprintf( - 'DROP INDEX %s ON %s', - $this->quoteColumnName($indexName), - $this->quoteTableName($tableName), - )); - - return $instructions; - } - } - - throw new InvalidArgumentException(sprintf( - "The specified index name '%s' does not exist", - $indexName, - )); - } - - /** - * @inheritDoc - */ - public function hasPrimaryKey(string $tableName, $columns, ?string $constraint = null): bool - { - $primaryKey = $this->getPrimaryKey($tableName); - - if (empty($primaryKey)) { - return false; - } - - if ($constraint) { - return $primaryKey['constraint'] === $constraint; - } - - return $primaryKey['columns'] === (array)$columns; - } - - /** - * Get the primary key from a particular table. - * - * @param string $tableName Table name - * @return array - */ - public function getPrimaryKey(string $tableName): array - { - $rows = $this->fetchAll(sprintf( - "SELECT - tc.CONSTRAINT_NAME, - kcu.COLUMN_NAME - FROM INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS tc - JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu - ON tc.CONSTRAINT_NAME = kcu.CONSTRAINT_NAME - WHERE CONSTRAINT_TYPE = 'PRIMARY KEY' - AND tc.TABLE_NAME = '%s' - ORDER BY kcu.ORDINAL_POSITION", - $tableName, - )); - - $primaryKey = [ - 'columns' => [], - ]; - foreach ($rows as $row) { - $primaryKey['constraint'] = $row['CONSTRAINT_NAME']; - $primaryKey['columns'][] = $row['COLUMN_NAME']; - } - - return $primaryKey; - } - - /** - * @inheritDoc - */ - public function hasForeignKey(string $tableName, $columns, ?string $constraint = null): bool - { - $foreignKeys = $this->getForeignKeys($tableName); - if ($constraint) { - if (isset($foreignKeys[$constraint])) { - return !empty($foreignKeys[$constraint]); - } - - return false; - } - - if (is_string($columns)) { - $columns = [$columns]; - } - - foreach ($foreignKeys as $key) { - if ($key['columns'] === $columns) { - return true; - } - } - - return false; - } - - /** - * Get an array of foreign keys from a particular table. - * - * @param string $tableName Table name - * @return array - */ - protected function getForeignKeys(string $tableName): array - { - $foreignKeys = []; - $rows = $this->fetchAll(sprintf( - "SELECT - tc.CONSTRAINT_NAME, - tc.TABLE_NAME, kcu.COLUMN_NAME, - ccu.TABLE_NAME AS REFERENCED_TABLE_NAME, - ccu.COLUMN_NAME AS REFERENCED_COLUMN_NAME - FROM - INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS tc - JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu ON tc.CONSTRAINT_NAME = kcu.CONSTRAINT_NAME - JOIN INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE AS ccu ON ccu.CONSTRAINT_NAME = tc.CONSTRAINT_NAME - WHERE CONSTRAINT_TYPE = 'FOREIGN KEY' AND tc.TABLE_NAME = '%s' - ORDER BY kcu.ORDINAL_POSITION", - $tableName, - )); - foreach ($rows as $row) { - $foreignKeys[$row['CONSTRAINT_NAME']]['table'] = $row['TABLE_NAME']; - $foreignKeys[$row['CONSTRAINT_NAME']]['columns'][] = $row['COLUMN_NAME']; - $foreignKeys[$row['CONSTRAINT_NAME']]['referenced_table'] = $row['REFERENCED_TABLE_NAME']; - $foreignKeys[$row['CONSTRAINT_NAME']]['referenced_columns'][] = $row['REFERENCED_COLUMN_NAME']; - } - foreach ($foreignKeys as $name => $key) { - $foreignKeys[$name]['columns'] = array_values(array_unique($key['columns'])); - $foreignKeys[$name]['referenced_columns'] = array_values(array_unique($key['referenced_columns'])); - } - - return $foreignKeys; - } - - /** - * @inheritDoc - */ - protected function getAddForeignKeyInstructions(Table $table, ForeignKey $foreignKey): AlterInstructions - { - $instructions = new AlterInstructions(); - $instructions->addPostStep(sprintf( - 'ALTER TABLE %s ADD %s', - $this->quoteTableName($table->getName()), - $this->getForeignKeySqlDefinition($foreignKey, $table->getName()), - )); - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getDropForeignKeyInstructions(string $tableName, string $constraint): AlterInstructions - { - $instructions = new AlterInstructions(); - $instructions->addPostStep(sprintf( - 'ALTER TABLE %s DROP CONSTRAINT %s', - $this->quoteTableName($tableName), - $this->quoteColumnName($constraint), - )); - - return $instructions; - } - - /** - * @inheritDoc - */ - protected function getDropForeignKeyByColumnsInstructions(string $tableName, array $columns): AlterInstructions - { - $instructions = new AlterInstructions(); - - $matches = []; - $foreignKeys = $this->getForeignKeys($tableName); - foreach ($foreignKeys as $name => $key) { - if ($key['columns'] === $columns) { - $matches[] = $name; - } - } - - if (empty($matches)) { - throw new InvalidArgumentException(sprintf( - 'No foreign key on column(s) `%s` exists', - implode(', ', $columns), - )); - } - - foreach ($matches as $name) { - $instructions->merge( - $this->getDropForeignKeyInstructions($tableName, $name), - ); - } - - return $instructions; - } - - /** - * {@inheritDoc} - * - * @throws \Phinx\Db\Adapter\UnsupportedColumnTypeException - */ - public function getSqlType(Literal|string $type, ?int $limit = null): array - { - $type = (string)$type; - switch ($type) { - case static::PHINX_TYPE_FLOAT: - case static::PHINX_TYPE_DECIMAL: - case static::PHINX_TYPE_DATETIME: - case static::PHINX_TYPE_TIME: - case static::PHINX_TYPE_DATE: - return ['name' => $type]; - case static::PHINX_TYPE_STRING: - return ['name' => 'nvarchar', 'limit' => 255]; - case static::PHINX_TYPE_CHAR: - return ['name' => 'nchar', 'limit' => 255]; - case static::PHINX_TYPE_TEXT: - return ['name' => 'ntext']; - case static::PHINX_TYPE_INTEGER: - return ['name' => 'int']; - case static::PHINX_TYPE_TINY_INTEGER: - return ['name' => 'tinyint']; - case static::PHINX_TYPE_SMALL_INTEGER: - return ['name' => 'smallint']; - case static::PHINX_TYPE_BIG_INTEGER: - return ['name' => 'bigint']; - case static::PHINX_TYPE_TIMESTAMP: - return ['name' => 'datetime']; - case static::PHINX_TYPE_BLOB: - case static::PHINX_TYPE_BINARY: - return ['name' => 'varbinary']; - case static::PHINX_TYPE_BOOLEAN: - return ['name' => 'bit']; - case static::PHINX_TYPE_BINARYUUID: - case static::PHINX_TYPE_UUID: - return ['name' => 'uniqueidentifier']; - case static::PHINX_TYPE_FILESTREAM: - return ['name' => 'varbinary', 'limit' => 'max']; - // Geospatial database types - case static::PHINX_TYPE_GEOGRAPHY: - case static::PHINX_TYPE_POINT: - case static::PHINX_TYPE_LINESTRING: - case static::PHINX_TYPE_POLYGON: - // SQL Server stores all spatial data using a single data type. - // Specific types (point, polygon, etc) are set at insert time. - return ['name' => 'geography']; - // Geometry specific type - case static::PHINX_TYPE_GEOMETRY: - return ['name' => 'geometry']; - default: - throw new UnsupportedColumnTypeException('Column type "' . $type . '" is not supported by SqlServer.'); - } - } - - /** - * Returns Phinx type by SQL type - * - * @internal param string $sqlType SQL type - * @param string $sqlType SQL Type definition - * @throws \Phinx\Db\Adapter\UnsupportedColumnTypeException - * @return string Phinx type - */ - public function getPhinxType(string $sqlType): string - { - switch ($sqlType) { - case 'nvarchar': - case 'varchar': - return static::PHINX_TYPE_STRING; - case 'char': - case 'nchar': - return static::PHINX_TYPE_CHAR; - case 'text': - case 'ntext': - return static::PHINX_TYPE_TEXT; - case 'int': - case 'integer': - return static::PHINX_TYPE_INTEGER; - case 'decimal': - case 'numeric': - case 'money': - return static::PHINX_TYPE_DECIMAL; - case 'tinyint': - return static::PHINX_TYPE_TINY_INTEGER; - case 'smallint': - return static::PHINX_TYPE_SMALL_INTEGER; - case 'bigint': - return static::PHINX_TYPE_BIG_INTEGER; - case 'real': - case 'float': - return static::PHINX_TYPE_FLOAT; - case 'binary': - case 'image': - case 'varbinary': - return static::PHINX_TYPE_BINARY; - case 'time': - return static::PHINX_TYPE_TIME; - case 'date': - return static::PHINX_TYPE_DATE; - case 'datetime': - case 'timestamp': - return static::PHINX_TYPE_DATETIME; - case 'bit': - return static::PHINX_TYPE_BOOLEAN; - case 'uniqueidentifier': - return static::PHINX_TYPE_UUID; - case 'filestream': - return static::PHINX_TYPE_FILESTREAM; - default: - throw new UnsupportedColumnTypeException('Column type "' . $sqlType . '" is not supported by SqlServer.'); - } - } - - /** - * @inheritDoc - */ - public function createDatabase(string $name, array $options = []): void - { - $databaseName = $this->quoteColumnName($name); - if (isset($options['collation'])) { - $this->execute(sprintf('CREATE DATABASE %s COLLATE %s', $databaseName, $options['collation'])); - } else { - $this->execute(sprintf('CREATE DATABASE %s', $databaseName)); - } - $this->execute(sprintf('USE %s', $databaseName)); - } - - /** - * @inheritDoc - */ - public function hasDatabase(string $name): bool - { - /** @var array $result */ - $result = $this->fetchRow( - sprintf( - "SELECT count(*) as [count] FROM master.dbo.sysdatabases WHERE [name] = '%s'", - $name, - ), - ); - - return $result['count'] > 0; - } - - /** - * @inheritDoc - */ - public function dropDatabase(string $name): void - { - $sql = sprintf( - 'USE master; - IF EXISTS(select * from sys.databases where name=N\'' . $name . '\') - ALTER DATABASE %1$s SET SINGLE_USER WITH ROLLBACK IMMEDIATE; - DROP DATABASE %1$s;', - $this->quoteColumnName($name), - ); - $this->execute($sql); - $this->createdTables = []; - } - - /** - * Gets the SqlServer Column Definition for a Column object. - * - * @param \Phinx\Db\Table\Column $column Column - * @param bool $create Create column flag - * @return string - */ - protected function getColumnSqlDefinition(Column $column, bool $create = true): string - { - $buffer = []; - if ($column->getType() instanceof Literal) { - $buffer[] = (string)$column->getType(); - } else { - $sqlType = $this->getSqlType($column->getType()); - $buffer[] = strtoupper($sqlType['name']); - // integers cant have limits in SQlServer - $noLimits = [ - 'bigint', - 'int', - 'tinyint', - 'smallint', - ]; - if ($sqlType['name'] === static::PHINX_TYPE_DECIMAL && $column->getPrecision() && $column->getScale()) { - $buffer[] = sprintf( - '(%s, %s)', - $column->getPrecision() ?: $sqlType['precision'], - $column->getScale() ?: $sqlType['scale'], - ); - } elseif (!in_array($sqlType['name'], $noLimits) && ($column->getLimit() || isset($sqlType['limit']))) { - $buffer[] = sprintf('(%s)', $column->getLimit() ?: $sqlType['limit']); - } - } - - $properties = $column->getProperties(); - $buffer[] = $column->getType() === 'filestream' ? 'FILESTREAM' : ''; - $buffer[] = isset($properties['rowguidcol']) ? 'ROWGUIDCOL' : ''; - - $buffer[] = $column->isNull() ? 'NULL' : 'NOT NULL'; - - if ($create === true) { - if ($column->getDefault() === null && $column->isNull()) { - $buffer[] = ' DEFAULT NULL'; - } else { - $buffer[] = $this->getDefaultValueDefinition($column->getDefault()); - } - } - - if ($column->isIdentity()) { - $seed = $column->getSeed() ?: 1; - $increment = $column->getIncrement() ?: 1; - $buffer[] = sprintf('IDENTITY(%d,%d)', $seed, $increment); - } - - return implode(' ', $buffer); - } - - /** - * Gets the SqlServer Index Definition for an Index object. - * - * @param \Phinx\Db\Table\Index $index Index - * @param string $tableName Table name - * @return string - */ - protected function getIndexSqlDefinition(Index $index, string $tableName): string - { - $columnNames = $index->getColumns(); - if (is_string($index->getName())) { - $indexName = $index->getName(); - } else { - $indexName = sprintf('%s_%s', $tableName, implode('_', $columnNames)); - } - $order = $index->getOrder() ?? []; - $columnNames = array_map(function ($columnName) use ($order) { - $ret = '[' . $columnName . ']'; - if (isset($order[$columnName])) { - $ret .= ' ' . $order[$columnName]; - } - - return $ret; - }, $columnNames); - - $includedColumns = $index->getInclude() ? sprintf('INCLUDE ([%s])', implode('],[', $index->getInclude())) : ''; - - return sprintf( - 'CREATE %s INDEX %s ON %s (%s) %s;', - ($index->getType() === Index::UNIQUE ? 'UNIQUE' : ''), - $indexName, - $this->quoteTableName($tableName), - implode(',', $columnNames), - $includedColumns, - ); - } - - /** - * Gets the SqlServer Foreign Key Definition for an ForeignKey object. - * - * @param \Phinx\Db\Table\ForeignKey $foreignKey Foreign key - * @param string $tableName Table name - * @return string - */ - protected function getForeignKeySqlDefinition(ForeignKey $foreignKey, string $tableName): string - { - $constraintName = $foreignKey->getConstraint() ?: $tableName . '_' . implode('_', $foreignKey->getColumns()); - $def = ' CONSTRAINT ' . $this->quoteColumnName($constraintName); - $def .= ' FOREIGN KEY ("' . implode('", "', $foreignKey->getColumns()) . '")'; - $def .= " REFERENCES {$this->quoteTableName($foreignKey->getReferencedTable()->getName())} (\"" . implode('", "', $foreignKey->getReferencedColumns()) . '")'; - if ($foreignKey->getOnDelete()) { - $def .= " ON DELETE {$foreignKey->getOnDelete()}"; - } - if ($foreignKey->getOnUpdate()) { - $def .= " ON UPDATE {$foreignKey->getOnUpdate()}"; - } - - return $def; - } - - /** - * @inheritDoc - */ - public function getColumnTypes(): array - { - return array_merge(parent::getColumnTypes(), static::$specificColumnTypes); - } - - /** - * Records a migration being run. - * - * @param \Phinx\Migration\MigrationInterface $migration Migration - * @param string $direction Direction - * @param string $startTime Start Time - * @param string $endTime End Time - * @return \Phinx\Db\Adapter\AdapterInterface - */ - public function migrated(MigrationInterface $migration, string $direction, string $startTime, string $endTime): AdapterInterface - { - $startTime = str_replace(' ', 'T', $startTime); - $endTime = str_replace(' ', 'T', $endTime); - - return parent::migrated($migration, $direction, $startTime, $endTime); - } - - /** - * @inheritDoc - */ - public function getDecoratedConnection(): Connection - { - if (isset($this->decoratedConnection)) { - return $this->decoratedConnection; - } - - $options = $this->getOptions(); - $options = [ - 'username' => $options['user'] ?? null, - 'password' => $options['pass'] ?? null, - 'database' => $options['name'], - 'quoteIdentifiers' => true, - ] + $options; - - return $this->decoratedConnection = $this->buildConnection(SqlServerDriver::class, $options); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/TablePrefixAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/TablePrefixAdapter.php deleted file mode 100644 index afa896003..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/TablePrefixAdapter.php +++ /dev/null @@ -1,493 +0,0 @@ -getAdapterTableName($tableName); - - return parent::hasTable($adapterTableName); - } - - /** - * @inheritDoc - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void - { - $adapterTable = new Table( - $this->getAdapterTableName($table->getName()), - $table->getOptions(), - ); - parent::createTable($adapterTable, $columns, $indexes); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function changePrimaryKey(Table $table, $newColumns): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - - $adapterTable = new Table( - $this->getAdapterTableName($table->getName()), - $table->getOptions(), - ); - $adapter->changePrimaryKey($adapterTable, $newColumns); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function changeComment(Table $table, ?string $newComment): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - - $adapterTable = new Table( - $this->getAdapterTableName($table->getName()), - $table->getOptions(), - ); - $adapter->changeComment($adapterTable, $newComment); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function renameTable(string $tableName, string $newTableName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - - $adapterTableName = $this->getAdapterTableName($tableName); - $adapterNewTableName = $this->getAdapterTableName($newTableName); - $adapter->renameTable($adapterTableName, $adapterNewTableName); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropTable(string $tableName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($tableName); - $adapter->dropTable($adapterTableName); - } - - /** - * @inheritDoc - */ - public function truncateTable(string $tableName): void - { - $adapterTableName = $this->getAdapterTableName($tableName); - parent::truncateTable($adapterTableName); - } - - /** - * @inheritDoc - */ - public function getColumns(string $tableName): array - { - $adapterTableName = $this->getAdapterTableName($tableName); - - return parent::getColumns($adapterTableName); - } - - /** - * @inheritDoc - */ - public function hasColumn(string $tableName, string $columnName): bool - { - $adapterTableName = $this->getAdapterTableName($tableName); - - return parent::hasColumn($adapterTableName, $columnName); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function addColumn(Table $table, Column $column): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($table->getName()); - $adapterTable = new Table($adapterTableName, $table->getOptions()); - $adapter->addColumn($adapterTable, $column); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function renameColumn(string $tableName, string $columnName, string $newColumnName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($tableName); - $adapter->renameColumn($adapterTableName, $columnName, $newColumnName); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function changeColumn(string $tableName, string $columnName, Column $newColumn): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($tableName); - $adapter->changeColumn($adapterTableName, $columnName, $newColumn); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropColumn(string $tableName, string $columnName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($tableName); - $adapter->dropColumn($adapterTableName, $columnName); - } - - /** - * @inheritDoc - */ - public function hasIndex(string $tableName, string|array $columns): bool - { - $adapterTableName = $this->getAdapterTableName($tableName); - - return parent::hasIndex($adapterTableName, $columns); - } - - /** - * @inheritDoc - */ - public function hasIndexByName(string $tableName, string $indexName): bool - { - $adapterTableName = $this->getAdapterTableName($tableName); - - return parent::hasIndexByName($adapterTableName, $indexName); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function addIndex(Table $table, Index $index): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTable = new Table($table->getName(), $table->getOptions()); - $adapter->addIndex($adapterTable, $index); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropIndex(string $tableName, $columns): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($tableName); - $adapter->dropIndex($adapterTableName, $columns); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropIndexByName(string $tableName, string $indexName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($tableName); - $adapter->dropIndexByName($adapterTableName, $indexName); - } - - /** - * @inheritDoc - */ - public function hasPrimaryKey(string $tableName, $columns, ?string $constraint = null): bool - { - $adapterTableName = $this->getAdapterTableName($tableName); - - return parent::hasPrimaryKey($adapterTableName, $columns, $constraint); - } - - /** - * @inheritDoc - */ - public function hasForeignKey(string $tableName, $columns, ?string $constraint = null): bool - { - $adapterTableName = $this->getAdapterTableName($tableName); - - return parent::hasForeignKey($adapterTableName, $columns, $constraint); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function addForeignKey(Table $table, ForeignKey $foreignKey): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($table->getName()); - $adapterTable = new Table($adapterTableName, $table->getOptions()); - $adapter->addForeignKey($adapterTable, $foreignKey); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropForeignKey(string $tableName, array $columns, ?string $constraint = null): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The underlying adapter does not implement DirectActionInterface'); - } - $adapterTableName = $this->getAdapterTableName($tableName); - $adapter->dropForeignKey($adapterTableName, $columns, $constraint); - } - - /** - * @inheritDoc - */ - public function insert(Table $table, array $row): void - { - $adapterTableName = $this->getAdapterTableName($table->getName()); - $adapterTable = new Table($adapterTableName, $table->getOptions()); - parent::insert($adapterTable, $row); - } - - /** - * @inheritDoc - */ - public function bulkinsert(Table $table, array $rows): void - { - $adapterTableName = $this->getAdapterTableName($table->getName()); - $adapterTable = new Table($adapterTableName, $table->getOptions()); - parent::bulkinsert($adapterTable, $rows); - } - - /** - * Gets the table prefix. - * - * @return string - */ - public function getPrefix(): string - { - return (string)$this->getOption('table_prefix'); - } - - /** - * Gets the table suffix. - * - * @return string - */ - public function getSuffix(): string - { - return (string)$this->getOption('table_suffix'); - } - - /** - * Applies the prefix and suffix to the table name. - * - * @param string $tableName Table name - * @return string - */ - public function getAdapterTableName(string $tableName): string - { - return $this->getPrefix() . $tableName . $this->getSuffix(); - } - - /** - * {@inheritDoc} - * - * @throws \InvalidArgumentException - * @return void - */ - public function executeActions(Table $table, array $actions): void - { - $adapterTableName = $this->getAdapterTableName($table->getName()); - $adapterTable = new Table($adapterTableName, $table->getOptions()); - - foreach ($actions as $k => $action) { - switch (true) { - case $action instanceof AddColumn: - /** @var \Phinx\Db\Action\AddColumn $action */ - $actions[$k] = new AddColumn($adapterTable, $action->getColumn()); - break; - - case $action instanceof AddIndex: - /** @var \Phinx\Db\Action\AddIndex $action */ - $actions[$k] = new AddIndex($adapterTable, $action->getIndex()); - break; - - case $action instanceof AddForeignKey: - /** @var \Phinx\Db\Action\AddForeignKey $action */ - $foreignKey = clone $action->getForeignKey(); - $refTable = $foreignKey->getReferencedTable(); - $refTableName = $this->getAdapterTableName($refTable->getName()); - $foreignKey->setReferencedTable(new Table($refTableName, $refTable->getOptions())); - $actions[$k] = new AddForeignKey($adapterTable, $foreignKey); - break; - - case $action instanceof ChangeColumn: - /** @var \Phinx\Db\Action\ChangeColumn $action */ - $actions[$k] = new ChangeColumn($adapterTable, $action->getColumnName(), $action->getColumn()); - break; - - case $action instanceof DropForeignKey: - /** @var \Phinx\Db\Action\DropForeignKey $action */ - $actions[$k] = new DropForeignKey($adapterTable, $action->getForeignKey()); - break; - - case $action instanceof DropIndex: - /** @var \Phinx\Db\Action\DropIndex $action */ - $actions[$k] = new DropIndex($adapterTable, $action->getIndex()); - break; - - case $action instanceof DropTable: - /** @var \Phinx\Db\Action\DropTable $action */ - $actions[$k] = new DropTable($adapterTable); - break; - - case $action instanceof RemoveColumn: - /** @var \Phinx\Db\Action\RemoveColumn $action */ - $actions[$k] = new RemoveColumn($adapterTable, $action->getColumn()); - break; - - case $action instanceof RenameColumn: - /** @var \Phinx\Db\Action\RenameColumn $action */ - $actions[$k] = new RenameColumn($adapterTable, $action->getColumn(), $action->getNewName()); - break; - - case $action instanceof RenameTable: - /** @var \Phinx\Db\Action\RenameTable $action */ - $actions[$k] = new RenameTable($adapterTable, $this->getAdapterTableName($action->getNewName())); - break; - - case $action instanceof ChangePrimaryKey: - /** @var \Phinx\Db\Action\ChangePrimaryKey $action */ - $actions[$k] = new ChangePrimaryKey($adapterTable, $action->getNewColumns()); - break; - - case $action instanceof ChangeComment: - /** @var \Phinx\Db\Action\ChangeComment $action */ - $actions[$k] = new ChangeComment($adapterTable, $action->getNewComment()); - break; - - default: - throw new InvalidArgumentException( - sprintf("Forgot to implement table prefixing for action: '%s'", get_class($action)), - ); - } - } - - parent::executeActions($adapterTable, $actions); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/TimedOutputAdapter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/TimedOutputAdapter.php deleted file mode 100644 index cac673759..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/TimedOutputAdapter.php +++ /dev/null @@ -1,424 +0,0 @@ -getAdapter()->getAdapterType(); - } - - /** - * Start timing a command. - * - * @return callable A function that is to be called when the command finishes - */ - public function startCommandTimer(): callable - { - $started = microtime(true); - - return function () use ($started): void { - $end = microtime(true); - if (OutputInterface::VERBOSITY_VERBOSE <= $this->getOutput()->getVerbosity()) { - $this->getOutput()->writeln(' -> ' . sprintf('%.4fs', $end - $started)); - } - }; - } - - /** - * Write a Phinx command to the output. - * - * @param string $command Command Name - * @param array $args Command Args - * @return void - */ - public function writeCommand(string $command, array $args = []): void - { - if (OutputInterface::VERBOSITY_VERBOSE > $this->getOutput()->getVerbosity()) { - return; - } - - if (count($args)) { - $outArr = []; - foreach ($args as $arg) { - if (is_array($arg)) { - $arg = array_map( - function ($value) { - return '\'' . $value . '\''; - }, - $arg, - ); - $outArr[] = '[' . implode(', ', $arg) . ']'; - continue; - } - - $outArr[] = '\'' . $arg . '\''; - } - $this->getOutput()->writeln(' -- ' . $command . '(' . implode(', ', $outArr) . ')'); - - return; - } - - $this->getOutput()->writeln(' -- ' . $command); - } - - /** - * @inheritDoc - */ - public function insert(Table $table, array $row): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('insert', [$table->getName()]); - parent::insert($table, $row); - $end(); - } - - /** - * @inheritDoc - */ - public function bulkinsert(Table $table, array $rows): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('bulkinsert', [$table->getName()]); - parent::bulkinsert($table, $rows); - $end(); - } - - /** - * @inheritDoc - */ - public function createTable(Table $table, array $columns = [], array $indexes = []): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('createTable', [$table->getName()]); - parent::createTable($table, $columns, $indexes); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function changePrimaryKey(Table $table, $newColumns): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('changePrimaryKey', [$table->getName()]); - $adapter->changePrimaryKey($table, $newColumns); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function changeComment(Table $table, ?string $newComment): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('changeComment', [$table->getName()]); - $adapter->changeComment($table, $newComment); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function renameTable(string $tableName, string $newTableName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('renameTable', [$tableName, $newTableName]); - $adapter->renameTable($tableName, $newTableName); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropTable(string $tableName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('dropTable', [$tableName]); - $adapter->dropTable($tableName); - $end(); - } - - /** - * @inheritDoc - */ - public function truncateTable(string $tableName): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('truncateTable', [$tableName]); - parent::truncateTable($tableName); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function addColumn(Table $table, Column $column): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand( - 'addColumn', - [ - $table->getName(), - $column->getName(), - $column->getType(), - ], - ); - $adapter->addColumn($table, $column); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function renameColumn(string $tableName, string $columnName, string $newColumnName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('renameColumn', [$tableName, $columnName, $newColumnName]); - $adapter->renameColumn($tableName, $columnName, $newColumnName); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function changeColumn(string $tableName, string $columnName, Column $newColumn): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('changeColumn', [$tableName, $columnName, $newColumn->getType()]); - $adapter->changeColumn($tableName, $columnName, $newColumn); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropColumn(string $tableName, string $columnName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('dropColumn', [$tableName, $columnName]); - $adapter->dropColumn($tableName, $columnName); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function addIndex(Table $table, Index $index): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('addIndex', [$table->getName(), $index->getColumns()]); - $adapter->addIndex($table, $index); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropIndex(string $tableName, $columns): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('dropIndex', [$tableName, $columns]); - $adapter->dropIndex($tableName, $columns); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropIndexByName(string $tableName, string $indexName): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('dropIndexByName', [$tableName, $indexName]); - $adapter->dropIndexByName($tableName, $indexName); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function addForeignKey(Table $table, ForeignKey $foreignKey): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('addForeignKey', [$table->getName(), $foreignKey->getColumns()]); - $adapter->addForeignKey($table, $foreignKey); - $end(); - } - - /** - * {@inheritDoc} - * - * @throws \BadMethodCallException - * @return void - */ - public function dropForeignKey(string $tableName, array $columns, ?string $constraint = null): void - { - $adapter = $this->getAdapter(); - if (!$adapter instanceof DirectActionInterface) { - throw new BadMethodCallException('The adapter needs to implement DirectActionInterface'); - } - $end = $this->startCommandTimer(); - $this->writeCommand('dropForeignKey', [$tableName, $columns]); - $adapter->dropForeignKey($tableName, $columns, $constraint); - $end(); - } - - /** - * @inheritDoc - */ - public function createDatabase(string $name, array $options = []): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('createDatabase', [$name]); - parent::createDatabase($name, $options); - $end(); - } - - /** - * @inheritDoc - */ - public function dropDatabase(string $name): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('dropDatabase', [$name]); - parent::dropDatabase($name); - $end(); - } - - /** - * @inheritDoc - */ - public function createSchema(string $name = 'public'): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('createSchema', [$name]); - parent::createSchema($name); - $end(); - } - - /** - * @inheritDoc - */ - public function dropSchema(string $name): void - { - $end = $this->startCommandTimer(); - $this->writeCommand('dropSchema', [$name]); - parent::dropSchema($name); - $end(); - } - - /** - * @inheritDoc - */ - public function executeActions(Table $table, array $actions): void - { - $end = $this->startCommandTimer(); - $this->writeCommand(sprintf('Altering table %s', $table->getName())); - parent::executeActions($table, $actions); - $end(); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/UnsupportedColumnTypeException.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/UnsupportedColumnTypeException.php deleted file mode 100644 index f784bf860..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Adapter/UnsupportedColumnTypeException.php +++ /dev/null @@ -1,18 +0,0 @@ -table = $table; - } - - /** - * Adds another action to the collection - * - * @param \Phinx\Db\Action\Action $action The action to add - * @return void - */ - public function addAction(Action $action): void - { - $this->actions[] = $action; - } - - /** - * Returns the table associated to this collection - * - * @return \Phinx\Db\Table\Table - */ - public function getTable(): Table - { - return $this->table; - } - - /** - * Returns an array with all collected actions - * - * @return \Phinx\Db\Action\Action[] - */ - public function getActions(): array - { - return $this->actions; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Intent.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Intent.php deleted file mode 100644 index fecf38ba3..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Intent.php +++ /dev/null @@ -1,56 +0,0 @@ -actions[] = $action; - } - - /** - * Returns the full list of actions - * - * @return \Phinx\Db\Action\Action[] - */ - public function getActions(): array - { - return $this->actions; - } - - /** - * Merges another Intent object with this one - * - * @param \Phinx\Db\Plan\Intent $another The other intent to merge in - * @return void - */ - public function merge(Intent $another): void - { - $this->actions = array_merge($this->actions, $another->getActions()); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/NewTable.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/NewTable.php deleted file mode 100644 index 25574e19f..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/NewTable.php +++ /dev/null @@ -1,102 +0,0 @@ -table = $table; - } - - /** - * Adds a column to the collection - * - * @param \Phinx\Db\Table\Column $column The column description - * @return void - */ - public function addColumn(Column $column): void - { - $this->columns[] = $column; - } - - /** - * Adds an index to the collection - * - * @param \Phinx\Db\Table\Index $index The index description - * @return void - */ - public function addIndex(Index $index): void - { - $this->indexes[] = $index; - } - - /** - * Returns the table object associated to this collection - * - * @return \Phinx\Db\Table\Table - */ - public function getTable(): Table - { - return $this->table; - } - - /** - * Returns the columns collection - * - * @return \Phinx\Db\Table\Column[] - */ - public function getColumns(): array - { - return $this->columns; - } - - /** - * Returns the indexes collection - * - * @return \Phinx\Db\Table\Index[] - */ - public function getIndexes(): array - { - return $this->indexes; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Plan.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Plan.php deleted file mode 100644 index d95221428..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Plan.php +++ /dev/null @@ -1,493 +0,0 @@ -createPlan($intent->getActions()); - } - - /** - * Parses the given Intent and creates the separate steps to execute - * - * @param \Phinx\Db\Action\Action[] $actions The actions to use for the plan - * @return void - */ - protected function createPlan(array $actions): void - { - $this->gatherCreates($actions); - $this->gatherUpdates($actions); - $this->gatherTableMoves($actions); - $this->gatherIndexes($actions); - $this->gatherConstraints($actions); - $this->resolveConflicts(); - } - - /** - * Returns a nested list of all the steps to execute - * - * @return \Phinx\Db\Plan\AlterTable[][] - */ - protected function updatesSequence(): array - { - return [ - $this->tableUpdates, - $this->constraints, - $this->indexes, - $this->columnRemoves, - $this->tableMoves, - ]; - } - - /** - * Returns a nested list of all the steps to execute in inverse order - * - * @return \Phinx\Db\Plan\AlterTable[][] - */ - protected function inverseUpdatesSequence(): array - { - return [ - $this->constraints, - $this->tableMoves, - $this->indexes, - $this->columnRemoves, - $this->tableUpdates, - ]; - } - - /** - * Executes this plan using the given AdapterInterface - * - * @param \Phinx\Db\Adapter\AdapterInterface $executor The executor object for the plan - * @return void - */ - public function execute(AdapterInterface $executor): void - { - foreach ($this->tableCreates as $newTable) { - $executor->createTable($newTable->getTable(), $newTable->getColumns(), $newTable->getIndexes()); - } - - foreach ($this->updatesSequence() as $updates) { - foreach ($updates as $update) { - $executor->executeActions($update->getTable(), $update->getActions()); - } - } - } - - /** - * Executes the inverse plan (rollback the actions) with the given AdapterInterface:w - * - * @param \Phinx\Db\Adapter\AdapterInterface $executor The executor object for the plan - * @return void - */ - public function executeInverse(AdapterInterface $executor): void - { - foreach ($this->inverseUpdatesSequence() as $updates) { - foreach ($updates as $update) { - $executor->executeActions($update->getTable(), $update->getActions()); - } - } - - foreach ($this->tableCreates as $newTable) { - $executor->createTable($newTable->getTable(), $newTable->getColumns(), $newTable->getIndexes()); - } - } - - /** - * Deletes certain actions from the plan if they are found to be conflicting or redundant. - * - * @return void - */ - protected function resolveConflicts(): void - { - foreach ($this->tableMoves as $alterTable) { - foreach ($alterTable->getActions() as $action) { - if ($action instanceof DropTable) { - $this->tableUpdates = $this->forgetTable($action->getTable(), $this->tableUpdates); - $this->constraints = $this->forgetTable($action->getTable(), $this->constraints); - $this->indexes = $this->forgetTable($action->getTable(), $this->indexes); - $this->columnRemoves = $this->forgetTable($action->getTable(), $this->columnRemoves); - } - } - } - - // Renaming a column and then changing the renamed column is something people do, - // but it is a conflicting action. Luckily solving the conflict can be done by moving - // the ChangeColumn action to another AlterTable. - $splitter = new ActionSplitter( - RenameColumn::class, - ChangeColumn::class, - function (RenameColumn $a, ChangeColumn $b) { - return $a->getNewName() === $b->getColumnName(); - }, - ); - $tableUpdates = []; - foreach ($this->tableUpdates as $update) { - $tableUpdates = array_merge($tableUpdates, $splitter($update)); - } - $this->tableUpdates = $tableUpdates; - - // Dropping indexes used by foreign keys is a conflict, but one we can resolve - // if the foreign key is also scheduled to be dropped. If we can find such a a case, - // we force the execution of the index drop after the foreign key is dropped. - // Changing constraint properties sometimes require dropping it and then - // creating it again with the new stuff. Unfortunately, we have already bundled - // everything together in as few AlterTable statements as we could, so we need to - // resolve this conflict manually. - $splitter = new ActionSplitter( - DropForeignKey::class, - AddForeignKey::class, - function (DropForeignKey $a, AddForeignKey $b) { - return $a->getForeignKey()->getColumns() === $b->getForeignKey()->getColumns(); - }, - ); - $constraints = []; - foreach ($this->constraints as $constraint) { - $constraints = array_merge( - $constraints, - $splitter($this->remapContraintAndIndexConflicts($constraint)), - ); - } - $this->constraints = $constraints; - } - - /** - * Deletes all actions related to the given table and keeps the - * rest - * - * @param \Phinx\Db\Table\Table $table The table to find in the list of actions - * @param \Phinx\Db\Plan\AlterTable[] $actions The actions to transform - * @return \Phinx\Db\Plan\AlterTable[] The list of actions without actions for the given table - */ - protected function forgetTable(Table $table, array $actions): array - { - $result = []; - foreach ($actions as $action) { - if ($action->getTable()->getName() === $table->getName()) { - continue; - } - $result[] = $action; - } - - return $result; - } - - /** - * Finds all DropForeignKey actions in an AlterTable and moves - * all conflicting DropIndex action in `$this->indexes` into the - * given AlterTable. - * - * @param \Phinx\Db\Plan\AlterTable $alter The collection of actions to inspect - * @return \Phinx\Db\Plan\AlterTable The updated AlterTable object. This function - * has the side effect of changing the `$this->indexes` property. - */ - protected function remapContraintAndIndexConflicts(AlterTable $alter): AlterTable - { - $newAlter = new AlterTable($alter->getTable()); - - foreach ($alter->getActions() as $action) { - $newAlter->addAction($action); - if ($action instanceof DropForeignKey) { - [$this->indexes, $dropIndexActions] = $this->forgetDropIndex( - $action->getTable(), - $action->getForeignKey()->getColumns(), - $this->indexes, - ); - foreach ($dropIndexActions as $dropIndexAction) { - $newAlter->addAction($dropIndexAction); - } - } - } - - return $newAlter; - } - - /** - * Deletes any DropIndex actions for the given table and exact columns - * - * @param \Phinx\Db\Table\Table $table The table to find in the list of actions - * @param string[] $columns The column names to match - * @param \Phinx\Db\Plan\AlterTable[] $actions The actions to transform - * @return array A tuple containing the list of actions without actions for dropping the index - * and a list of drop index actions that were removed. - */ - protected function forgetDropIndex(Table $table, array $columns, array $actions): array - { - $dropIndexActions = new ArrayObject(); - $indexes = array_map(function ($alter) use ($table, $columns, $dropIndexActions) { - if ($alter->getTable()->getName() !== $table->getName()) { - return $alter; - } - - $newAlter = new AlterTable($table); - foreach ($alter->getActions() as $action) { - if ($action instanceof DropIndex && $action->getIndex()->getColumns() === $columns) { - $dropIndexActions->append($action); - } else { - $newAlter->addAction($action); - } - } - - return $newAlter; - }, $actions); - - return [$indexes, $dropIndexActions->getArrayCopy()]; - } - - /** - * Deletes any RemoveColumn actions for the given table and exact columns - * - * @param \Phinx\Db\Table\Table $table The table to find in the list of actions - * @param string[] $columns The column names to match - * @param \Phinx\Db\Plan\AlterTable[] $actions The actions to transform - * @return array A tuple containing the list of actions without actions for removing the column - * and a list of remove column actions that were removed. - */ - protected function forgetRemoveColumn(Table $table, array $columns, array $actions): array - { - $removeColumnActions = new ArrayObject(); - $indexes = array_map(function ($alter) use ($table, $columns, $removeColumnActions) { - if ($alter->getTable()->getName() !== $table->getName()) { - return $alter; - } - - $newAlter = new AlterTable($table); - foreach ($alter->getActions() as $action) { - if ($action instanceof RemoveColumn && in_array($action->getColumn()->getName(), $columns, true)) { - $removeColumnActions->append($action); - } else { - $newAlter->addAction($action); - } - } - - return $newAlter; - }, $actions); - - return [$indexes, $removeColumnActions->getArrayCopy()]; - } - - /** - * Collects all table creation actions from the given intent - * - * @param \Phinx\Db\Action\Action[] $actions The actions to parse - * @return void - */ - protected function gatherCreates(array $actions): void - { - foreach ($actions as $action) { - if ($action instanceof CreateTable) { - $this->tableCreates[$action->getTable()->getName()] = new NewTable($action->getTable()); - } - } - - foreach ($actions as $action) { - if ( - ($action instanceof AddColumn || $action instanceof AddIndex) - && isset($this->tableCreates[$action->getTable()->getName()]) - ) { - $table = $action->getTable(); - - if ($action instanceof AddColumn) { - $this->tableCreates[$table->getName()]->addColumn($action->getColumn()); - } - - if ($action instanceof AddIndex) { - $this->tableCreates[$table->getName()]->addIndex($action->getIndex()); - } - } - } - } - - /** - * Collects all alter table actions from the given intent - * - * @param \Phinx\Db\Action\Action[] $actions The actions to parse - * @return void - */ - protected function gatherUpdates(array $actions): void - { - foreach ($actions as $action) { - if ( - !($action instanceof AddColumn) - && !($action instanceof ChangeColumn) - && !($action instanceof RemoveColumn) - && !($action instanceof RenameColumn) - ) { - continue; - } elseif (isset($this->tableCreates[$action->getTable()->getName()])) { - continue; - } - $table = $action->getTable(); - $name = $table->getName(); - - if ($action instanceof RemoveColumn) { - if (!isset($this->columnRemoves[$name])) { - $this->columnRemoves[$name] = new AlterTable($table); - } - $this->columnRemoves[$name]->addAction($action); - } else { - if (!isset($this->tableUpdates[$name])) { - $this->tableUpdates[$name] = new AlterTable($table); - } - $this->tableUpdates[$name]->addAction($action); - } - } - } - - /** - * Collects all alter table drop and renames from the given intent - * - * @param \Phinx\Db\Action\Action[] $actions The actions to parse - * @return void - */ - protected function gatherTableMoves(array $actions): void - { - foreach ($actions as $action) { - if ( - !($action instanceof DropTable) - && !($action instanceof RenameTable) - && !($action instanceof ChangePrimaryKey) - && !($action instanceof ChangeComment) - ) { - continue; - } - $table = $action->getTable(); - $name = $table->getName(); - - if (!isset($this->tableMoves[$name])) { - $this->tableMoves[$name] = new AlterTable($table); - } - - $this->tableMoves[$name]->addAction($action); - } - } - - /** - * Collects all index creation and drops from the given intent - * - * @param \Phinx\Db\Action\Action[] $actions The actions to parse - * @return void - */ - protected function gatherIndexes(array $actions): void - { - foreach ($actions as $action) { - if (!($action instanceof AddIndex) && !($action instanceof DropIndex)) { - continue; - } elseif (isset($this->tableCreates[$action->getTable()->getName()])) { - continue; - } - - $table = $action->getTable(); - $name = $table->getName(); - - if (!isset($this->indexes[$name])) { - $this->indexes[$name] = new AlterTable($table); - } - - $this->indexes[$name]->addAction($action); - } - } - - /** - * Collects all foreign key creation and drops from the given intent - * - * @param \Phinx\Db\Action\Action[] $actions The actions to parse - * @return void - */ - protected function gatherConstraints(array $actions): void - { - foreach ($actions as $action) { - if (!($action instanceof AddForeignKey || $action instanceof DropForeignKey)) { - continue; - } - $table = $action->getTable(); - $name = $table->getName(); - - if (!isset($this->constraints[$name])) { - $this->constraints[$name] = new AlterTable($table); - } - - $this->constraints[$name]->addAction($action); - } - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Solver/ActionSplitter.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Solver/ActionSplitter.php deleted file mode 100644 index c4ea33d11..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Plan/Solver/ActionSplitter.php +++ /dev/null @@ -1,104 +0,0 @@ -conflictClass = $conflictClass; - $this->conflictClassDual = $conflictClassDual; - $this->conflictFilter = $conflictFilter; - } - - /** - * Returs a sequence of AlterTable instructions that are non conflicting - * based on the constructor parameters. - * - * @param \Phinx\Db\Plan\AlterTable $alter The collection of actions to inspect - * @return \Phinx\Db\Plan\AlterTable[] A list of AlterTable that can be executed without - * this type of conflict - */ - public function __invoke(AlterTable $alter): array - { - $conflictActions = array_filter($alter->getActions(), function ($action) { - return $action instanceof $this->conflictClass; - }); - - $originalAlter = new AlterTable($alter->getTable()); - $newAlter = new AlterTable($alter->getTable()); - - foreach ($alter->getActions() as $action) { - if (!$action instanceof $this->conflictClassDual) { - $originalAlter->addAction($action); - continue; - } - - $found = false; - $matches = $this->conflictFilter; - foreach ($conflictActions as $ca) { - if ($matches($ca, $action)) { - $found = true; - break; - } - } - - if ($found) { - $newAlter->addAction($action); - } else { - $originalAlter->addAction($action); - } - } - - return [$originalAlter, $newAlter]; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Table.php deleted file mode 100644 index d0e483390..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table.php +++ /dev/null @@ -1,727 +0,0 @@ - $options Options - * @param \Phinx\Db\Adapter\AdapterInterface|null $adapter Database Adapter - */ - public function __construct(string $name, array $options = [], ?AdapterInterface $adapter = null) - { - $this->table = new TableValue($name, $options); - $this->actions = new Intent(); - - if ($adapter !== null) { - $this->setAdapter($adapter); - } - } - - /** - * Gets the table name. - * - * @return string - */ - public function getName(): string - { - return $this->table->getName(); - } - - /** - * Gets the table options. - * - * @return array - */ - public function getOptions(): array - { - return $this->table->getOptions(); - } - - /** - * Gets the table name and options as an object - * - * @return \Phinx\Db\Table\Table - */ - public function getTable(): TableValue - { - return $this->table; - } - - /** - * Sets the database adapter. - * - * @param \Phinx\Db\Adapter\AdapterInterface $adapter Database Adapter - * @return $this - */ - public function setAdapter(AdapterInterface $adapter) - { - $this->adapter = $adapter; - - return $this; - } - - /** - * Gets the database adapter. - * - * @throws \RuntimeException - * @return \Phinx\Db\Adapter\AdapterInterface - */ - public function getAdapter(): AdapterInterface - { - if (!$this->adapter) { - throw new RuntimeException('There is no database adapter set yet, cannot proceed'); - } - - return $this->adapter; - } - - /** - * Does the table have pending actions? - * - * @return bool - */ - public function hasPendingActions(): bool - { - return count($this->actions->getActions()) > 0 || count($this->data) > 0; - } - - /** - * Does the table exist? - * - * @return bool - */ - public function exists(): bool - { - return $this->getAdapter()->hasTable($this->getName()); - } - - /** - * Drops the database table. - * - * @return $this - */ - public function drop() - { - $this->actions->addAction(new DropTable($this->table)); - - return $this; - } - - /** - * Renames the database table. - * - * @param string $newTableName New Table Name - * @return $this - */ - public function rename(string $newTableName) - { - $this->actions->addAction(new RenameTable($this->table, $newTableName)); - - return $this; - } - - /** - * Changes the primary key of the database table. - * - * @param string|string[]|null $columns Column name(s) to belong to the primary key, or null to drop the key - * @return $this - */ - public function changePrimaryKey(string|array|null $columns) - { - $this->actions->addAction(new ChangePrimaryKey($this->table, $columns)); - - return $this; - } - - /** - * Checks to see if a primary key exists. - * - * @param string|string[] $columns Column(s) - * @param string|null $constraint Constraint names - * @return bool - */ - public function hasPrimaryKey(string|array $columns, ?string $constraint = null): bool - { - return $this->getAdapter()->hasPrimaryKey($this->getName(), $columns, $constraint); - } - - /** - * Changes the comment of the database table. - * - * @param string|null $comment New comment string, or null to drop the comment - * @return $this - */ - public function changeComment(?string $comment) - { - $this->actions->addAction(new ChangeComment($this->table, $comment)); - - return $this; - } - - /** - * Gets an array of the table columns. - * - * @return \Phinx\Db\Table\Column[] - */ - public function getColumns(): array - { - return $this->getAdapter()->getColumns($this->getName()); - } - - /** - * Gets a table column if it exists. - * - * @param string $name Column name - * @return \Phinx\Db\Table\Column|null - */ - public function getColumn(string $name): ?Column - { - $columns = array_filter( - $this->getColumns(), - function ($column) use ($name) { - return $column->getName() === $name; - }, - ); - - return array_pop($columns); - } - - /** - * Sets an array of data to be inserted. - * - * @param array $data Data - * @return $this - */ - public function setData(array $data) - { - $this->data = $data; - - return $this; - } - - /** - * Gets the data waiting to be inserted. - * - * @return array - */ - public function getData(): array - { - return $this->data; - } - - /** - * Resets all of the pending data to be inserted - * - * @return void - */ - public function resetData(): void - { - $this->setData([]); - } - - /** - * Resets all of the pending table changes. - * - * @return void - */ - public function reset(): void - { - $this->actions = new Intent(); - $this->resetData(); - } - - /** - * Add a table column. - * - * Type can be: string, text, integer, float, decimal, datetime, timestamp, - * time, date, binary, boolean. - * - * Valid options can be: limit, default, null, precision or scale. - * - * @param string|\Phinx\Db\Table\Column $columnName Column Name - * @param string|\Phinx\Util\Literal|null $type Column Type - * @param array $options Column Options - * @throws \InvalidArgumentException - * @return $this - */ - public function addColumn(string|Column $columnName, string|Literal|null $type = null, array $options = []) - { - assert($columnName instanceof Column || $type !== null); - if ($columnName instanceof Column) { - $action = new AddColumn($this->table, $columnName); - } elseif ($type instanceof Literal) { - $action = AddColumn::build($this->table, $columnName, $type, $options); - } else { - $action = new AddColumn($this->table, $this->getAdapter()->getColumnForType($columnName, $type, $options)); - } - - // Delegate to Adapters to check column type - if (!$this->getAdapter()->isValidColumnType($action->getColumn())) { - throw new InvalidArgumentException(sprintf( - 'An invalid column type "%s" was specified for column "%s".', - $action->getColumn()->getType(), - $action->getColumn()->getName(), - )); - } - - $this->actions->addAction($action); - - return $this; - } - - /** - * Remove a table column. - * - * @param string $columnName Column Name - * @return $this - */ - public function removeColumn(string $columnName) - { - $action = RemoveColumn::build($this->table, $columnName); - $this->actions->addAction($action); - - return $this; - } - - /** - * Rename a table column. - * - * @param string $oldName Old Column Name - * @param string $newName New Column Name - * @return $this - */ - public function renameColumn(string $oldName, string $newName) - { - $action = RenameColumn::build($this->table, $oldName, $newName); - $this->actions->addAction($action); - - return $this; - } - - /** - * Change a table column type. - * - * @param string $columnName Column Name - * @param string|\Phinx\Db\Table\Column|\Phinx\Util\Literal $newColumnType New Column Type - * @param array $options Options - * @return $this - */ - public function changeColumn(string $columnName, string|Column|Literal $newColumnType, array $options = []) - { - if ($newColumnType instanceof Column) { - $action = new ChangeColumn($this->table, $columnName, $newColumnType); - } else { - $action = ChangeColumn::build($this->table, $columnName, $newColumnType, $options); - } - $this->actions->addAction($action); - - return $this; - } - - /** - * Checks to see if a column exists. - * - * @param string $columnName Column Name - * @return bool - */ - public function hasColumn(string $columnName): bool - { - return $this->getAdapter()->hasColumn($this->getName(), $columnName); - } - - /** - * Add an index to a database table. - * - * In $options you can specify unique = true/false, and name (index name). - * - * @param string|array|\Phinx\Db\Table\Index $columns Table Column(s) - * @param array $options Index Options - * @return $this - */ - public function addIndex(string|array|Index $columns, array $options = []) - { - $action = AddIndex::build($this->table, $columns, $options); - $this->actions->addAction($action); - - return $this; - } - - /** - * Removes the given index from a table. - * - * @param string|string[] $columns Columns - * @return $this - */ - public function removeIndex(string|array $columns) - { - $action = DropIndex::build($this->table, is_string($columns) ? [$columns] : $columns); - $this->actions->addAction($action); - - return $this; - } - - /** - * Removes the given index identified by its name from a table. - * - * @param string $name Index name - * @return $this - */ - public function removeIndexByName(string $name) - { - $action = DropIndex::buildFromName($this->table, $name); - $this->actions->addAction($action); - - return $this; - } - - /** - * Checks to see if an index exists. - * - * @param string|string[] $columns Columns - * @return bool - */ - public function hasIndex(string|array $columns): bool - { - return $this->getAdapter()->hasIndex($this->getName(), $columns); - } - - /** - * Checks to see if an index specified by name exists. - * - * @param string $indexName Index name - * @return bool - */ - public function hasIndexByName(string $indexName): bool - { - return $this->getAdapter()->hasIndexByName($this->getName(), $indexName); - } - - /** - * Add a foreign key to a database table. - * - * In $options you can specify on_delete|on_delete = cascade|no_action .., - * on_update, constraint = constraint name. - * - * @param string|string[] $columns Columns - * @param string|\Phinx\Db\Table\Table $referencedTable Referenced Table - * @param string|string[] $referencedColumns Referenced Columns - * @param array $options Options - * @return $this - */ - public function addForeignKey(string|array $columns, string|TableValue $referencedTable, string|array $referencedColumns = ['id'], array $options = []) - { - $action = AddForeignKey::build($this->table, $columns, $referencedTable, $referencedColumns, $options); - $this->actions->addAction($action); - - return $this; - } - - /** - * Add a foreign key to a database table with a given name. - * - * In $options you can specify on_delete|on_delete = cascade|no_action .., - * on_update, constraint = constraint name. - * - * @param string $name The constraint name - * @param string|string[] $columns Columns - * @param string|\Phinx\Db\Table\Table $referencedTable Referenced Table - * @param string|string[] $referencedColumns Referenced Columns - * @param array $options Options - * @return $this - */ - public function addForeignKeyWithName(string $name, string|array $columns, string|TableValue $referencedTable, string|array $referencedColumns = ['id'], array $options = []) - { - $action = AddForeignKey::build( - $this->table, - $columns, - $referencedTable, - $referencedColumns, - $options, - $name, - ); - $this->actions->addAction($action); - - return $this; - } - - /** - * Removes the given foreign key from the table. - * - * @param string|string[] $columns Column(s) - * @param string|null $constraint Constraint names - * @return $this - */ - public function dropForeignKey(string|array $columns, ?string $constraint = null) - { - $action = DropForeignKey::build($this->table, $columns, $constraint); - $this->actions->addAction($action); - - return $this; - } - - /** - * Checks to see if a foreign key exists. - * - * @param string|string[] $columns Column(s) - * @param string|null $constraint Constraint names - * @return bool - */ - public function hasForeignKey(string|array $columns, ?string $constraint = null): bool - { - return $this->getAdapter()->hasForeignKey($this->getName(), $columns, $constraint); - } - - /** - * Add timestamp columns created_at and updated_at to the table. - * - * @param string|false|null $createdAt Alternate name for the created_at column - * @param string|false|null $updatedAt Alternate name for the updated_at column - * @param bool $withTimezone Whether to set the timezone option on the added columns - * @return $this - */ - public function addTimestamps(string|false|null $createdAt = 'created_at', string|false|null $updatedAt = 'updated_at', bool $withTimezone = false) - { - $createdAt = $createdAt ?? 'created_at'; - $updatedAt = $updatedAt ?? 'updated_at'; - - if (!$createdAt && !$updatedAt) { - throw new RuntimeException('Cannot set both created_at and updated_at columns to false'); - } - - $columnType = FeatureFlags::$addTimestampsUseDateTime ? 'datetime' : 'timestamp'; - - if ($createdAt) { - $this->addColumn($createdAt, $columnType, [ - 'null' => false, - 'default' => 'CURRENT_TIMESTAMP', - 'update' => '', - 'timezone' => $withTimezone, - ]); - } - if ($updatedAt) { - $this->addColumn($updatedAt, $columnType, [ - 'null' => true, - 'default' => null, - 'update' => 'CURRENT_TIMESTAMP', - 'timezone' => $withTimezone, - ]); - } - - return $this; - } - - /** - * Alias that always sets $withTimezone to true - * - * @see addTimestamps - * @param string|false|null $createdAt Alternate name for the created_at column - * @param string|false|null $updatedAt Alternate name for the updated_at column - * @return $this - */ - public function addTimestampsWithTimezone(string|false|null $createdAt = null, string|false|null $updatedAt = null) - { - $this->addTimestamps($createdAt, $updatedAt, true); - - return $this; - } - - /** - * Insert data into the table. - * - * @param array $data array of data in the form: - * array( - * array("col1" => "value1", "col2" => "anotherValue1"), - * array("col2" => "value2", "col2" => "anotherValue2"), - * ) - * or array("col1" => "value1", "col2" => "anotherValue1") - * @return $this - */ - public function insert(array $data) - { - // handle array of array situations - $keys = array_keys($data); - $firstKey = array_shift($keys); - if ($firstKey !== null && is_array($data[$firstKey])) { - foreach ($data as $row) { - $this->data[] = $row; - } - - return $this; - } - - if (count($data) > 0) { - $this->data[] = $data; - } - - return $this; - } - - /** - * Creates a table from the object instance. - * - * @return void - */ - public function create(): void - { - $this->executeActions(false); - $this->saveData(); - $this->reset(); // reset pending changes - } - - /** - * Updates a table from the object instance. - * - * @return void - */ - public function update(): void - { - $this->executeActions(true); - $this->saveData(); - $this->reset(); // reset pending changes - } - - /** - * Commit the pending data waiting for insertion. - * - * @return void - */ - public function saveData(): void - { - $rows = $this->getData(); - if (empty($rows)) { - return; - } - - $bulk = true; - $row = current($rows); - $c = array_keys($row); - foreach ($this->getData() as $row) { - $k = array_keys($row); - if ($k != $c) { - $bulk = false; - break; - } - } - - if ($bulk) { - $this->getAdapter()->bulkinsert($this->table, $this->getData()); - } else { - foreach ($this->getData() as $row) { - $this->getAdapter()->insert($this->table, $row); - } - } - - $this->resetData(); - } - - /** - * Immediately truncates the table. This operation cannot be undone - * - * @return void - */ - public function truncate(): void - { - $this->getAdapter()->truncateTable($this->getName()); - } - - /** - * Commits the table changes. - * - * If the table doesn't exist it is created otherwise it is updated. - * - * @return void - */ - public function save(): void - { - if ($this->exists()) { - $this->update(); // update the table - } else { - $this->create(); // create the table - } - } - - /** - * Executes all the pending actions for this table - * - * @param bool $exists Whether or not the table existed prior to executing this method - * @return void - */ - protected function executeActions(bool $exists): void - { - // Renaming a table is tricky, specially when running a reversible migration - // down. We will just assume the table already exists if the user commands a - // table rename. - if (!$exists) { - foreach ($this->actions->getActions() as $action) { - if ($action instanceof RenameTable) { - $exists = true; - break; - } - } - } - - // If the table does not exist, the last command in the chain needs to be - // a CreateTable action. - if (!$exists) { - $this->actions->addAction(new CreateTable($this->table)); - } - - $plan = new Plan($this->actions); - $plan->execute($this->getAdapter()); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Column.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Column.php deleted file mode 100644 index f677c7760..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Column.php +++ /dev/null @@ -1,807 +0,0 @@ -null = FeatureFlags::$columnNullDefault; - } - - /** - * Sets the column name. - * - * @param string $name Name - * @return $this - */ - public function setName(string $name) - { - $this->name = $name; - - return $this; - } - - /** - * Gets the column name. - * - * @return string|null - */ - public function getName(): ?string - { - return $this->name; - } - - /** - * Sets the column type. - * - * @param string|\Phinx\Util\Literal $type Column type - * @return $this - */ - public function setType(string|Literal $type) - { - $this->type = $type; - - return $this; - } - - /** - * Gets the column type. - * - * @return string|\Phinx\Util\Literal - */ - public function getType(): string|Literal - { - if (!isset($this->type)) { - throw new RuntimeException('Cannot access `type` it has not been set'); - } - - return $this->type; - } - - /** - * Sets the column limit. - * - * @param int|null $limit Limit - * @return $this - */ - public function setLimit(?int $limit) - { - $this->limit = $limit; - - return $this; - } - - /** - * Gets the column limit. - * - * @return int|null - */ - public function getLimit(): ?int - { - return $this->limit; - } - - /** - * Sets whether the column allows nulls. - * - * @param bool $null Null - * @return $this - */ - public function setNull(bool $null) - { - $this->null = (bool)$null; - - return $this; - } - - /** - * Gets whether the column allows nulls. - * - * @return bool - */ - public function getNull(): bool - { - return $this->null; - } - - /** - * Does the column allow nulls? - * - * @return bool - */ - public function isNull(): bool - { - return $this->getNull(); - } - - /** - * Sets the default column value. - * - * @param mixed $default Default - * @return $this - */ - public function setDefault(mixed $default) - { - $this->default = $default; - - return $this; - } - - /** - * Gets the default column value. - * - * @return mixed - */ - public function getDefault(): mixed - { - return $this->default; - } - - /** - * Sets generated option for identity columns. Ignored otherwise. - * - * @param string|null $generated Generated option - * @return $this - */ - public function setGenerated(?string $generated) - { - $this->generated = $generated; - - return $this; - } - - /** - * Gets generated option for identity columns. Null otherwise - * - * @return string|null - */ - public function getGenerated(): ?string - { - return $this->generated; - } - - /** - * Sets whether or not the column is an identity column. - * - * @param bool $identity Identity - * @return $this - */ - public function setIdentity(bool $identity) - { - $this->identity = $identity; - - return $this; - } - - /** - * Gets whether or not the column is an identity column. - * - * @return bool - */ - public function getIdentity(): bool - { - return $this->identity; - } - - /** - * Is the column an identity column? - * - * @return bool - */ - public function isIdentity(): bool - { - return $this->getIdentity(); - } - - /** - * Sets the name of the column to add this column after. - * - * @param string $after After - * @return $this - */ - public function setAfter(string $after) - { - $this->after = $after; - - return $this; - } - - /** - * Returns the name of the column to add this column after. - * - * @return string|null - */ - public function getAfter(): ?string - { - return $this->after; - } - - /** - * Sets the 'ON UPDATE' mysql column function. - * - * @param string $update On Update function - * @return $this - */ - public function setUpdate(string $update) - { - $this->update = $update; - - return $this; - } - - /** - * Returns the value of the ON UPDATE column function. - * - * @return string|null - */ - public function getUpdate(): ?string - { - return $this->update; - } - - /** - * Sets the number precision for decimal or float column. - * - * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale, - * and the column could store value from -999.99 to 999.99. - * - * @param int|null $precision Number precision - * @return $this - */ - public function setPrecision(?int $precision) - { - $this->setLimit($precision); - - return $this; - } - - /** - * Gets the number precision for decimal or float column. - * - * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale, - * and the column could store value from -999.99 to 999.99. - * - * @return int|null - */ - public function getPrecision(): ?int - { - return $this->limit; - } - - /** - * Sets the column identity increment. - * - * @param int $increment Number increment - * @return $this - */ - public function setIncrement(int $increment) - { - $this->increment = $increment; - - return $this; - } - - /** - * Gets the column identity increment. - * - * @return int|null - */ - public function getIncrement(): ?int - { - return $this->increment; - } - - /** - * Sets the column identity seed. - * - * @param int $seed Number seed - * @return $this - */ - public function setSeed(int $seed) - { - $this->seed = $seed; - - return $this; - } - - /** - * Gets the column identity seed. - * - * @return int - */ - public function getSeed(): ?int - { - return $this->seed; - } - - /** - * Sets the number scale for decimal or float column. - * - * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale, - * and the column could store value from -999.99 to 999.99. - * - * @param int|null $scale Number scale - * @return $this - */ - public function setScale(?int $scale) - { - $this->scale = $scale; - - return $this; - } - - /** - * Gets the number scale for decimal or float column. - * - * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale, - * and the column could store value from -999.99 to 999.99. - * - * @return int - */ - public function getScale(): ?int - { - return $this->scale; - } - - /** - * Sets the number precision and scale for decimal or float column. - * - * For example `DECIMAL(5,2)`, 5 is the precision and 2 is the scale, - * and the column could store value from -999.99 to 999.99. - * - * @param int $precision Number precision - * @param int $scale Number scale - * @return $this - */ - public function setPrecisionAndScale(int $precision, int $scale) - { - $this->setLimit($precision); - $this->scale = $scale; - - return $this; - } - - /** - * Sets the column comment. - * - * @param string|null $comment Comment - * @return $this - */ - public function setComment(?string $comment) - { - $this->comment = $comment; - - return $this; - } - - /** - * Gets the column comment. - * - * @return string - */ - public function getComment(): ?string - { - return $this->comment; - } - - /** - * Sets whether field should be signed. - * - * @param bool $signed Signed - * @return $this - */ - public function setSigned(bool $signed) - { - $this->signed = (bool)$signed; - - return $this; - } - - /** - * Gets whether field should be signed. - * - * @return bool - */ - public function getSigned(): bool - { - return $this->signed; - } - - /** - * Should the column be signed? - * - * @return bool - */ - public function isSigned(): bool - { - return $this->getSigned(); - } - - /** - * Sets whether the field should have a timezone identifier. - * Used for date/time columns only! - * - * @param bool $timezone Timezone - * @return $this - */ - public function setTimezone(bool $timezone) - { - $this->timezone = (bool)$timezone; - - return $this; - } - - /** - * Gets whether field has a timezone identifier. - * - * @return bool - */ - public function getTimezone(): bool - { - return $this->timezone; - } - - /** - * Should the column have a timezone? - * - * @return bool - */ - public function isTimezone(): bool - { - return $this->getTimezone(); - } - - /** - * Sets field properties. - * - * @param array $properties Properties - * @return $this - */ - public function setProperties(array $properties) - { - $this->properties = $properties; - - return $this; - } - - /** - * Gets field properties - * - * @return array - */ - public function getProperties(): array - { - return $this->properties; - } - - /** - * Sets field values. - * - * @param string[]|string $values Value(s) - * @return $this - */ - public function setValues(array|string $values) - { - if (!is_array($values)) { - $values = preg_split('/,\s*/', $values) ?: []; - } - $this->values = $values; - - return $this; - } - - /** - * Gets field values - * - * @return array|null - */ - public function getValues(): ?array - { - return $this->values; - } - - /** - * Sets the column collation. - * - * @param string $collation Collation - * @return $this - */ - public function setCollation(string $collation) - { - $this->collation = $collation; - - return $this; - } - - /** - * Gets the column collation. - * - * @return string|null - */ - public function getCollation(): ?string - { - return $this->collation; - } - - /** - * Sets the column character set. - * - * @param string $encoding Encoding - * @return $this - */ - public function setEncoding(string $encoding) - { - $this->encoding = $encoding; - - return $this; - } - - /** - * Gets the column character set. - * - * @return string|null - */ - public function getEncoding(): ?string - { - return $this->encoding; - } - - /** - * Sets the column SRID. - * - * @param int $srid SRID - * @return $this - */ - public function setSrid(int $srid) - { - $this->srid = $srid; - - return $this; - } - - /** - * Gets the column SRID. - * - * @return int|null - */ - public function getSrid(): ?int - { - return $this->srid; - } - - /** - * Gets all allowed options. Each option must have a corresponding `setFoo` method. - * - * @return array - */ - protected function getValidOptions(): array - { - return [ - 'limit', - 'default', - 'null', - 'identity', - 'scale', - 'after', - 'update', - 'comment', - 'signed', - 'timezone', - 'properties', - 'values', - 'collation', - 'encoding', - 'srid', - 'seed', - 'increment', - 'generated', - ]; - } - - /** - * Gets all aliased options. Each alias must reference a valid option. - * - * @return array - */ - protected function getAliasedOptions(): array - { - return [ - 'length' => 'limit', - 'precision' => 'limit', - ]; - } - - /** - * Utility method that maps an array of column options to this objects methods. - * - * @param array $options Options - * @throws \RuntimeException - * @return $this - */ - public function setOptions(array $options) - { - $validOptions = $this->getValidOptions(); - $aliasOptions = $this->getAliasedOptions(); - - if (isset($options['identity']) && $options['identity'] && !isset($options['null'])) { - $options['null'] = false; - } - - foreach ($options as $option => $value) { - if (isset($aliasOptions[$option])) { - // proxy alias -> option - $option = $aliasOptions[$option]; - } - - if (!in_array($option, $validOptions, true)) { - throw new RuntimeException(sprintf('"%s" is not a valid column option.', $option)); - } - - $method = 'set' . ucfirst($option); - $this->$method($value); - } - - return $this; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/ForeignKey.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/ForeignKey.php deleted file mode 100644 index 7c5d2671e..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/ForeignKey.php +++ /dev/null @@ -1,294 +0,0 @@ - - */ - protected static array $validOptions = ['delete', 'update', 'constraint', 'deferrable']; - - /** - * @var string[] - */ - protected array $columns = []; - - /** - * @var \Phinx\Db\Table\Table - */ - protected Table $referencedTable; - - /** - * @var string[] - */ - protected array $referencedColumns = []; - - /** - * @var string|null - */ - protected ?string $onDelete = null; - - /** - * @var string|null - */ - protected ?string $onUpdate = null; - - /** - * @var string|null - */ - protected ?string $constraint = null; - protected ?string $deferrableMode = null; - - /** - * Sets the foreign key columns. - * - * @param string[]|string $columns Columns - * @return $this - */ - public function setColumns(array|string $columns) - { - $this->columns = is_string($columns) ? [$columns] : $columns; - - return $this; - } - - /** - * Gets the foreign key columns. - * - * @return string[] - */ - public function getColumns(): array - { - return $this->columns; - } - - /** - * Sets the foreign key referenced table. - * - * @param \Phinx\Db\Table\Table $table The table this KEY is pointing to - * @return $this - */ - public function setReferencedTable(Table $table) - { - $this->referencedTable = $table; - - return $this; - } - - /** - * Gets the foreign key referenced table. - * - * @return \Phinx\Db\Table\Table - */ - public function getReferencedTable(): Table - { - if (!isset($this->referencedTable)) { - throw new RuntimeException('Cannot access `referencedTable` it has not been set'); - } - - return $this->referencedTable; - } - - /** - * Sets the foreign key referenced columns. - * - * @param string[] $referencedColumns Referenced columns - * @return $this - */ - public function setReferencedColumns(array $referencedColumns) - { - $this->referencedColumns = $referencedColumns; - - return $this; - } - - /** - * Gets the foreign key referenced columns. - * - * @return string[] - */ - public function getReferencedColumns(): array - { - return $this->referencedColumns; - } - - /** - * Sets ON DELETE action for the foreign key. - * - * @param string $onDelete On Delete - * @return $this - */ - public function setOnDelete(string $onDelete) - { - $this->onDelete = $this->normalizeAction($onDelete); - - return $this; - } - - /** - * Gets ON DELETE action for the foreign key. - * - * @return string|null - */ - public function getOnDelete(): ?string - { - return $this->onDelete; - } - - /** - * Gets ON UPDATE action for the foreign key. - * - * @return string|null - */ - public function getOnUpdate(): ?string - { - return $this->onUpdate; - } - - /** - * Sets ON UPDATE action for the foreign key. - * - * @param string $onUpdate On Update - * @return $this - */ - public function setOnUpdate(string $onUpdate) - { - $this->onUpdate = $this->normalizeAction($onUpdate); - - return $this; - } - - /** - * Sets constraint for the foreign key. - * - * @param string $constraint Constraint - * @return $this - */ - public function setConstraint(string $constraint) - { - $this->constraint = $constraint; - - return $this; - } - - /** - * Gets constraint name for the foreign key. - * - * @return string|null - */ - public function getConstraint(): ?string - { - return $this->constraint; - } - - /** - * Sets deferrable mode for the foreign key. - * - * @param string $deferrableMode Constraint - * @return $this - */ - public function setDeferrableMode(string $deferrableMode) - { - $this->deferrableMode = $this->normalizeDeferrable($deferrableMode); - - return $this; - } - - /** - * Gets deferrable mode for the foreign key. - */ - public function getDeferrableMode(): ?string - { - return $this->deferrableMode; - } - - /** - * Utility method that maps an array of index options to this objects methods. - * - * @param array $options Options - * @throws \RuntimeException - * @return $this - */ - public function setOptions(array $options) - { - foreach ($options as $option => $value) { - if (!in_array($option, static::$validOptions, true)) { - throw new RuntimeException(sprintf('"%s" is not a valid foreign key option.', $option)); - } - - // handle $options['delete'] as $options['update'] - if ($option === 'delete') { - $this->setOnDelete($value); - } elseif ($option === 'update') { - $this->setOnUpdate($value); - } elseif ($option === 'deferrable') { - $this->setDeferrableMode($value); - } else { - $method = 'set' . ucfirst($option); - $this->$method($value); - } - } - - return $this; - } - - /** - * From passed value checks if it's correct and fixes if needed - * - * @param string $action Action - * @throws \InvalidArgumentException - * @return string - */ - protected function normalizeAction(string $action): string - { - $constantName = 'static::' . str_replace(' ', '_', strtoupper(trim($action))); - if (!defined($constantName)) { - throw new InvalidArgumentException('Unknown action passed: ' . $action); - } - - return constant($constantName); - } - - /** - * From passed value checks if it's correct and fixes if needed - * - * @param string $deferrable Deferrable - * @throws \InvalidArgumentException - * @return string - */ - protected function normalizeDeferrable(string $deferrable): string - { - $mapping = [ - 'DEFERRED' => ForeignKey::DEFERRED, - 'IMMEDIATE' => ForeignKey::IMMEDIATE, - 'NOT DEFERRED' => ForeignKey::NOT_DEFERRED, - ForeignKey::DEFERRED => ForeignKey::DEFERRED, - ForeignKey::IMMEDIATE => ForeignKey::IMMEDIATE, - ForeignKey::NOT_DEFERRED => ForeignKey::NOT_DEFERRED, - ]; - $normalized = strtoupper(str_replace('_', ' ', $deferrable)); - if (array_key_exists($normalized, $mapping)) { - return $mapping[$normalized]; - } - - throw new InvalidArgumentException('Unknown deferrable passed: ' . $deferrable); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Index.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Index.php deleted file mode 100644 index cea7b9520..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Index.php +++ /dev/null @@ -1,228 +0,0 @@ -columns = is_string($columns) ? [$columns] : $columns; - - return $this; - } - - /** - * Gets the index columns. - * - * @return string[]|null - */ - public function getColumns(): ?array - { - return $this->columns; - } - - /** - * Sets the index type. - * - * @param string $type Type - * @return $this - */ - public function setType(string $type) - { - $this->type = $type; - - return $this; - } - - /** - * Gets the index type. - * - * @return string - */ - public function getType(): string - { - return $this->type; - } - - /** - * Sets the index name. - * - * @param string $name Name - * @return $this - */ - public function setName(string $name) - { - $this->name = $name; - - return $this; - } - - /** - * Gets the index name. - * - * @return string|null - */ - public function getName(): ?string - { - return $this->name; - } - - /** - * Sets the index limit. - * - * @param int|array $limit limit value or array of limit value - * @return $this - */ - public function setLimit(int|array $limit) - { - $this->limit = $limit; - - return $this; - } - - /** - * Gets the index limit. - * - * @return int|array|null - */ - public function getLimit(): int|array|null - { - return $this->limit; - } - - /** - * Sets the index columns sort order. - * - * @param string[] $order column name sort order key value pair - * @return $this - */ - public function setOrder(array $order) - { - $this->order = $order; - - return $this; - } - - /** - * Gets the index columns sort order. - * - * @return string[]|null - */ - public function getOrder(): ?array - { - return $this->order; - } - - /** - * Sets the index included columns. - * - * @param string[] $includedColumns Columns - * @return $this - */ - public function setInclude(array $includedColumns) - { - $this->includedColumns = $includedColumns; - - return $this; - } - - /** - * Gets the index included columns. - * - * @return string[]|null - */ - public function getInclude(): ?array - { - return $this->includedColumns; - } - - /** - * Utility method that maps an array of index options to this objects methods. - * - * @param array $options Options - * @throws \RuntimeException - * @return $this - */ - public function setOptions(array $options) - { - // Valid Options - $validOptions = ['type', 'unique', 'name', 'limit', 'order', 'include']; - foreach ($options as $option => $value) { - if (!in_array($option, $validOptions, true)) { - throw new RuntimeException(sprintf('"%s" is not a valid index option.', $option)); - } - - // handle $options['unique'] - if (strcasecmp($option, self::UNIQUE) === 0) { - if ((bool)$value) { - $this->setType(self::UNIQUE); - } - continue; - } - - $method = 'set' . ucfirst($option); - $this->$method($value); - } - - return $this; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Table.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Table.php deleted file mode 100644 index 30c47e277..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Table/Table.php +++ /dev/null @@ -1,85 +0,0 @@ - - */ - protected array $options; - - /** - * @param string $name The table name - * @param array $options The creation options for this table - * @throws \InvalidArgumentException - */ - public function __construct(string $name, array $options = []) - { - if (empty($name)) { - throw new InvalidArgumentException('Cannot use an empty table name'); - } - - $this->name = $name; - $this->options = $options; - } - - /** - * Sets the table name. - * - * @param string $name The name of the table - * @return $this - */ - public function setName(string $name) - { - $this->name = $name; - - return $this; - } - - /** - * Gets the table name. - * - * @return string - */ - public function getName(): string - { - return $this->name; - } - - /** - * Gets the table options - * - * @return array - */ - public function getOptions(): array - { - return $this->options; - } - - /** - * Sets the table options - * - * @param array $options The options for the table creation - * @return $this - */ - public function setOptions(array $options) - { - $this->options = $options; - - return $this; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Db/Util/AlterInstructions.php b/app/vendor/robmorgan/phinx/src/Phinx/Db/Util/AlterInstructions.php deleted file mode 100644 index bbde1b947..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Db/Util/AlterInstructions.php +++ /dev/null @@ -1,123 +0,0 @@ -alterParts = $alterParts; - $this->postSteps = $postSteps; - } - - /** - * Adds another part to the single ALTER instruction - * - * @param string $part The SQL snipped to add as part of the ALTER instruction - * @return void - */ - public function addAlter(string $part): void - { - $this->alterParts[] = $part; - } - - /** - * Adds a SQL command to be executed after the ALTER instruction. - * This method allows a callable, with will get an empty array as state - * for the first time and will pass the return value of the callable to - * the next callable, if present. - * - * This allows to keep a single state across callbacks. - * - * @param string|callable $sql The SQL to run after, or a callable to execute - * @return void - */ - public function addPostStep(string|callable $sql): void - { - $this->postSteps[] = $sql; - } - - /** - * Returns the alter SQL snippets - * - * @return string[] - */ - public function getAlterParts(): array - { - return $this->alterParts; - } - - /** - * Returns the SQL commands to run after the ALTER instruction - * - * @return (string|callable)[] - */ - public function getPostSteps(): array - { - return $this->postSteps; - } - - /** - * Merges another AlterInstructions object to this one - * - * @param \Phinx\Db\Util\AlterInstructions $other The other collection of instructions to merge in - * @return void - */ - public function merge(AlterInstructions $other): void - { - $this->alterParts = array_merge($this->alterParts, $other->getAlterParts()); - $this->postSteps = array_merge($this->postSteps, $other->getPostSteps()); - } - - /** - * Executes the ALTER instruction and all of the post steps. - * - * @param string $alterTemplate The template for the alter instruction - * @param callable $executor The function to be used to execute all instructions - * @return void - */ - public function execute(string $alterTemplate, callable $executor): void - { - if ($this->alterParts) { - $alter = sprintf($alterTemplate, implode(', ', $this->alterParts)); - $executor($alter); - } - - $state = []; - - foreach ($this->postSteps as $instruction) { - if (is_callable($instruction)) { - $state = $instruction($state); - continue; - } - - $executor($instruction); - } - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Migration/AbstractMigration.php b/app/vendor/robmorgan/phinx/src/Phinx/Migration/AbstractMigration.php deleted file mode 100644 index 738303163..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Migration/AbstractMigration.php +++ /dev/null @@ -1,396 +0,0 @@ - - */ - protected array $tables = []; - - /** - * @param string $environment Environment Detected - * @param int $version Migration Version - * @param \Symfony\Component\Console\Input\InputInterface|null $input Input - * @param \Symfony\Component\Console\Output\OutputInterface|null $output Output - */ - final public function __construct(string $environment, int $version, ?InputInterface $input = null, ?OutputInterface $output = null) - { - $this->validateVersion($version); - - $this->environment = $environment; - $this->version = $version; - - if ($input !== null) { - $this->setInput($input); - } - - if ($output !== null) { - $this->setOutput($output); - } - } - - /** - * @inheritDoc - */ - public function setAdapter(AdapterInterface $adapter): MigrationInterface - { - $this->adapter = $adapter; - - return $this; - } - - /** - * @inheritDoc - */ - public function getAdapter(): AdapterInterface - { - if (!isset($this->adapter)) { - throw new RuntimeException('Cannot access `adapter` it has not been set'); - } - - return $this->adapter; - } - - /** - * @inheritDoc - */ - public function setInput(InputInterface $input): MigrationInterface - { - $this->input = $input; - - return $this; - } - - /** - * @inheritDoc - */ - public function getInput(): ?InputInterface - { - return $this->input; - } - - /** - * @inheritDoc - */ - public function setOutput(OutputInterface $output): MigrationInterface - { - $this->output = $output; - - return $this; - } - - /** - * @inheritDoc - */ - public function getOutput(): ?OutputInterface - { - return $this->output; - } - - /** - * @inheritDoc - */ - public function getName(): string - { - return static::class; - } - - /** - * @inheritDoc - */ - public function getEnvironment(): string - { - return $this->environment; - } - - /** - * @inheritDoc - */ - public function setVersion($version): MigrationInterface - { - $this->version = $version; - - return $this; - } - - /** - * @inheritDoc - */ - public function getVersion(): int - { - return $this->version; - } - - /** - * @inheritDoc - */ - public function setMigratingUp(bool $isMigratingUp): MigrationInterface - { - $this->isMigratingUp = $isMigratingUp; - - return $this; - } - - /** - * @inheritDoc - */ - public function isMigratingUp(): bool - { - return $this->isMigratingUp; - } - - /** - * @inheritDoc - */ - public function execute(string $sql, array $params = []): int - { - return $this->getAdapter()->execute($sql, $params); - } - - /** - * @inheritDoc - */ - public function query(string $sql, array $params = []): mixed - { - return $this->getAdapter()->query($sql, $params); - } - - /** - * @inheritDoc - */ - public function getQueryBuilder(string $type): Query - { - return $this->getAdapter()->getQueryBuilder($type); - } - - /** - * @inheritDoc - */ - public function getSelectBuilder(): SelectQuery - { - return $this->getAdapter()->getSelectBuilder(); - } - - /** - * @inheritDoc - */ - public function getInsertBuilder(): InsertQuery - { - return $this->getAdapter()->getInsertBuilder(); - } - - /** - * @inheritDoc - */ - public function getUpdateBuilder(): UpdateQuery - { - return $this->getAdapter()->getUpdateBuilder(); - } - - /** - * @inheritDoc - */ - public function getDeleteBuilder(): DeleteQuery - { - return $this->getAdapter()->getDeleteBuilder(); - } - - /** - * @inheritDoc - */ - public function fetchRow(string $sql): array|false - { - return $this->getAdapter()->fetchRow($sql); - } - - /** - * @inheritDoc - */ - public function fetchAll(string $sql): array - { - return $this->getAdapter()->fetchAll($sql); - } - - /** - * @inheritDoc - */ - public function createDatabase(string $name, array $options): void - { - $this->getAdapter()->createDatabase($name, $options); - } - - /** - * @inheritDoc - */ - public function dropDatabase(string $name): void - { - $this->getAdapter()->dropDatabase($name); - } - - /** - * @inheritDoc - */ - public function createSchema(string $name): void - { - $this->getAdapter()->createSchema($name); - } - - /** - * @inheritDoc - */ - public function dropSchema(string $name): void - { - $this->getAdapter()->dropSchema($name); - } - - /** - * @inheritDoc - */ - public function hasTable(string $tableName): bool - { - return $this->getAdapter()->hasTable($tableName); - } - - /** - * @inheritDoc - */ - public function table(string $tableName, array $options = []): Table - { - $table = new Table($tableName, $options, $this->getAdapter()); - $this->tables[] = $table; - - return $table; - } - - /** - * Perform checks on the migration, print a warning - * if there are potential problems. - * - * Right now, the only check is if there is both a `change()` and - * an `up()` or a `down()` method. - * - * @return void - */ - public function preFlightCheck(): void - { - if (method_exists($this, MigrationInterface::CHANGE)) { - if ( - method_exists($this, MigrationInterface::UP) || - method_exists($this, MigrationInterface::DOWN) - ) { - $this->output->writeln(sprintf( - 'warning Migration contains both change() and up()/down() methods. Ignoring up() and down().', - )); - } - } - } - - /** - * Perform checks on the migration after completion - * - * Right now, the only check is whether all changes were committed - * - * @throws \RuntimeException - * @return void - */ - public function postFlightCheck(): void - { - foreach ($this->tables as $table) { - if ($table->hasPendingActions()) { - throw new RuntimeException(sprintf('Migration %s_%s has pending actions after execution!', $this->getVersion(), $this->getName())); - } - } - } - - /** - * Checks to see if the migration should be executed. - * - * Returns true by default. - * - * You can use this to prevent a migration from executing. - * - * @return bool - */ - public function shouldExecute(): bool - { - return true; - } - - /** - * Makes sure the version int is within range for valid datetime. - * This is required to have a meaningful order in the overview. - * - * @param int $version Version - * @return void - */ - protected function validateVersion(int $version): void - { - $length = strlen((string)$version); - if ($length === 14) { - return; - } - - throw new RuntimeException('Invalid version `' . $version . '`, should be in format `YYYYMMDDHHMMSS` (length of 14).'); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Migration/AbstractTemplateCreation.php b/app/vendor/robmorgan/phinx/src/Phinx/Migration/AbstractTemplateCreation.php deleted file mode 100644 index 9eea24268..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Migration/AbstractTemplateCreation.php +++ /dev/null @@ -1,75 +0,0 @@ -setInput($input); - } - if ($output !== null) { - $this->setOutput($output); - } - } - - /** - * @inheritDoc - */ - public function getInput(): InputInterface - { - return $this->input; - } - - /** - * @inheritDoc - */ - public function setInput(InputInterface $input): CreationInterface - { - $this->input = $input; - - return $this; - } - - /** - * @inheritDoc - */ - public function getOutput(): OutputInterface - { - return $this->output; - } - - /** - * @inheritDoc - */ - public function setOutput(OutputInterface $output): CreationInterface - { - $this->output = $output; - - return $this; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Migration/CreationInterface.php b/app/vendor/robmorgan/phinx/src/Phinx/Migration/CreationInterface.php deleted file mode 100644 index 2d0e05bd3..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Migration/CreationInterface.php +++ /dev/null @@ -1,68 +0,0 @@ -setConfig($config); - $this->setInput($input); - $this->setOutput($output); - } - - /** - * Prints the specified environment's migration status. - * - * @param string $environment environment to print status of - * @param string|null $format format to print status in (either text, json, or null) - * @throws \RuntimeException - * @return array array indicating if there are any missing or down migrations - */ - public function printStatus(string $environment, ?string $format = null): array - { - $output = $this->getOutput(); - $hasDownMigration = false; - $hasMissingMigration = false; - $migrations = $this->getMigrations($environment); - $migrationCount = 0; - $missingCount = 0; - $pendingMigrationCount = 0; - $finalMigrations = []; - $verbosity = $output->getVerbosity(); - if ($format === 'json') { - $output->setVerbosity(OutputInterface::VERBOSITY_QUIET); - } - if (count($migrations)) { - // rewrite using Symfony Table Helper as we already have this library - // included and it will fix formatting issues (e.g drawing the lines) - $output->writeln('', $this->verbosityLevel); - - switch ($this->getConfig()->getVersionOrder()) { - case Config::VERSION_ORDER_CREATION_TIME: - $migrationIdAndStartedHeader = '[Migration ID] Started '; - break; - case Config::VERSION_ORDER_EXECUTION_TIME: - $migrationIdAndStartedHeader = 'Migration ID [Started ]'; - break; - default: - throw new RuntimeException('Invalid version_order configuration option'); - } - - $output->writeln(" Status $migrationIdAndStartedHeader Finished Migration Name ", $this->verbosityLevel); - $output->writeln('----------------------------------------------------------------------------------', $this->verbosityLevel); - - $env = $this->getEnvironment($environment); - $versions = $env->getVersionLog(); - - $maxNameLength = $versions ? max(array_map(function ($version) { - return strlen($version['migration_name'] ?? ''); - }, $versions)) : 0; - - $missingVersions = array_diff_key($versions, $migrations); - $missingCount = count($missingVersions); - - $hasMissingMigration = !empty($missingVersions); - - // get the migrations sorted in the same way as the versions - /** @var \Phinx\Migration\AbstractMigration[] $sortedMigrations */ - $sortedMigrations = []; - - foreach ($versions as $versionCreationTime => $version) { - if (isset($migrations[$versionCreationTime])) { - array_push($sortedMigrations, $migrations[$versionCreationTime]); - unset($migrations[$versionCreationTime]); - } - } - - if (empty($sortedMigrations) && !empty($missingVersions)) { - // this means we have no up migrations, so we write all the missing versions already so they show up - // before any possible down migration - foreach ($missingVersions as $missingVersionCreationTime => $missingVersion) { - $this->printMissingVersion($missingVersion, $maxNameLength); - - unset($missingVersions[$missingVersionCreationTime]); - } - } - - // any migration left in the migrations (ie. not unset when sorting the migrations by the version order) is - // a migration that is down, so we add them to the end of the sorted migrations list - if (!empty($migrations)) { - $sortedMigrations = array_merge($sortedMigrations, $migrations); - } - - $migrationCount = count($sortedMigrations); - foreach ($sortedMigrations as $migration) { - $version = array_key_exists($migration->getVersion(), $versions) ? $versions[$migration->getVersion()] : false; - if ($version) { - // check if there are missing versions before this version - foreach ($missingVersions as $missingVersionCreationTime => $missingVersion) { - if ($this->getConfig()->isVersionOrderCreationTime()) { - if ($missingVersion['version'] > $version['version']) { - break; - } - } else { - if ($missingVersion['start_time'] > $version['start_time']) { - break; - } elseif ( - $missingVersion['start_time'] == $version['start_time'] && - $missingVersion['version'] > $version['version'] - ) { - break; - } - } - - $this->printMissingVersion($missingVersion, $maxNameLength); - - unset($missingVersions[$missingVersionCreationTime]); - } - - $status = ' up '; - } else { - $pendingMigrationCount++; - $hasDownMigration = true; - $status = ' down '; - } - $maxNameLength = max($maxNameLength, strlen($migration->getName())); - - $output->writeln( - sprintf( - '%s %14.0f %19s %19s %s', - $status, - $migration->getVersion(), - ($version ? $version['start_time'] : ''), - ($version ? $version['end_time'] : ''), - $migration->getName(), - ), - $this->verbosityLevel, - ); - - if ($version && $version['breakpoint']) { - $output->writeln(' BREAKPOINT SET', $this->verbosityLevel); - } - - $finalMigrations[] = ['migration_status' => trim(strip_tags($status)), 'migration_id' => sprintf('%14.0f', $migration->getVersion()), 'migration_name' => $migration->getName()]; - unset($versions[$migration->getVersion()]); - } - - // and finally add any possibly-remaining missing migrations - foreach ($missingVersions as $missingVersionCreationTime => $missingVersion) { - $this->printMissingVersion($missingVersion, $maxNameLength); - - unset($missingVersions[$missingVersionCreationTime]); - } - } else { - // there are no migrations - $output->writeln('', $this->verbosityLevel); - $output->writeln('There are no available migrations. Try creating one using the create command.', $this->verbosityLevel); - } - - // write an empty line - $output->writeln('', $this->verbosityLevel); - - if ($format !== null) { - switch ($format) { - case AbstractCommand::FORMAT_JSON: - $output->setVerbosity($verbosity); - $output->writeln(json_encode( - [ - 'pending_count' => $pendingMigrationCount, - 'missing_count' => $missingCount, - 'total_count' => $migrationCount + $missingCount, - 'migrations' => $finalMigrations, - ], - )); - break; - default: - $output->writeln('Unsupported format: ' . $format . ''); - } - } - - return [ - 'hasMissingMigration' => $hasMissingMigration, - 'hasDownMigration' => $hasDownMigration, - ]; - } - - /** - * Print Missing Version - * - * @param array $version The missing version to print (in the format returned by Environment.getVersionLog). - * @param int $maxNameLength The maximum migration name length. - * @return void - */ - protected function printMissingVersion(array $version, int $maxNameLength): void - { - $this->getOutput()->writeln(sprintf( - ' up %14.0f %19s %19s %s ** MISSING MIGRATION FILE **', - $version['version'], - $version['start_time'], - $version['end_time'], - str_pad($version['migration_name'] ?? '', $maxNameLength, ' '), - )); - - if ($version && $version['breakpoint']) { - $this->getOutput()->writeln(' BREAKPOINT SET'); - } - } - - /** - * Migrate to the version of the database on a given date. - * - * @param string $environment Environment - * @param \DateTime $dateTime Date to migrate to - * @param bool $fake flag that if true, we just record running the migration, but not actually do the - * migration - * @return void - */ - public function migrateToDateTime(string $environment, DateTime $dateTime, bool $fake = false): void - { - $versions = array_keys($this->getMigrations($environment)); - $dateString = $dateTime->format('YmdHis'); - - $outstandingMigrations = array_filter($versions, function ($version) use ($dateString) { - return $version <= $dateString; - }); - - if (count($outstandingMigrations) > 0) { - $migration = max($outstandingMigrations); - $this->getOutput()->writeln('Migrating to version ' . $migration, $this->verbosityLevel); - $this->migrate($environment, $migration, $fake); - } - } - - /** - * Migrate an environment to a specific number of migrations. - * - * @param string $environment Environment - * @param int $count Number of migrations to apply - * @param bool $fake flag that if true, we just record running the migration, but not actually do the migration - * @return void - */ - public function migrateToCount(string $environment, int $count, bool $fake = false): void - { - $versions = array_keys($this->getMigrations($environment)); - $env = $this->getEnvironment($environment); - $current = $env->getCurrentVersion(); - - if ($current === 0) { - $version = $versions[$count - 1]; - } else { - $currentIdx = array_search($current, $versions, true); - $version = $versions[min($currentIdx + $count, count($versions) - 1)]; - } - - $this->migrate($environment, $version, $fake); - } - - /** - * Migrate an environment to the specified version. - * - * @param string $environment Environment - * @param int|null $version version to migrate to - * @param bool $fake flag that if true, we just record running the migration, but not actually do the migration - * @return void - */ - public function migrate(string $environment, ?int $version = null, bool $fake = false): void - { - $migrations = $this->getMigrations($environment); - $env = $this->getEnvironment($environment); - $versions = $env->getVersions(); - $current = $env->getCurrentVersion(); - - if (empty($versions) && empty($migrations)) { - return; - } - - if ($version === null) { - $version = max(array_merge($versions, array_keys($migrations))); - } else { - if ($version != 0 && !isset($migrations[$version])) { - $this->output->writeln(sprintf( - 'warning %s is not a valid version', - $version, - )); - - return; - } - } - - // are we migrating up or down? - $direction = $version > $current ? MigrationInterface::UP : MigrationInterface::DOWN; - - if ($direction === MigrationInterface::DOWN) { - // run downs first - krsort($migrations); - foreach ($migrations as $migration) { - if ($migration->getVersion() <= $version) { - break; - } - - if (in_array($migration->getVersion(), $versions)) { - $this->executeMigration($environment, $migration, MigrationInterface::DOWN, $fake); - } - } - } - - ksort($migrations); - foreach ($migrations as $migration) { - if ($migration->getVersion() > $version) { - break; - } - - if (!in_array($migration->getVersion(), $versions)) { - $this->executeMigration($environment, $migration, MigrationInterface::UP, $fake); - } - } - } - - /** - * Execute a migration against the specified environment. - * - * @param string $name Environment Name - * @param \Phinx\Migration\MigrationInterface $migration Migration - * @param string $direction Direction - * @param bool $fake flag that if true, we just record running the migration, but not actually do the migration - * @return void - */ - public function executeMigration(string $name, MigrationInterface $migration, string $direction = MigrationInterface::UP, bool $fake = false): void - { - $this->getOutput()->writeln('', $this->verbosityLevel); - - // Skip the migration if it should not be executed - if (!$migration->shouldExecute()) { - $this->printMigrationStatus($migration, 'skipped'); - - return; - } - - $this->printMigrationStatus($migration, ($direction === MigrationInterface::UP ? 'migrating' : 'reverting')); - - // Execute the migration and log the time elapsed. - $start = microtime(true); - $this->getEnvironment($name)->executeMigration($migration, $direction, $fake); - $end = microtime(true); - - $this->printMigrationStatus( - $migration, - ($direction === MigrationInterface::UP ? 'migrated' : 'reverted'), - sprintf('%.4fs', $end - $start), - ); - } - - /** - * Execute a seeder against the specified environment. - * - * @param string $name Environment Name - * @param \Phinx\Seed\SeedInterface $seed Seed - * @return void - */ - public function executeSeed(string $name, SeedInterface $seed): void - { - $this->getOutput()->writeln('', $this->verbosityLevel); - - // Skip the seed if it should not be executed - if (!$seed->shouldExecute()) { - $this->printSeedStatus($seed, 'skipped'); - - return; - } - - $this->printSeedStatus($seed, 'seeding'); - - // Execute the seeder and log the time elapsed. - $start = microtime(true); - $this->getEnvironment($name)->executeSeed($seed); - $end = microtime(true); - - $this->printSeedStatus( - $seed, - 'seeded', - sprintf('%.4fs', $end - $start), - ); - } - - /** - * Print Migration Status - * - * @param \Phinx\Migration\MigrationInterface $migration Migration - * @param string $status Status of the migration - * @param string|null $duration Duration the migration took the be executed - * @return void - */ - protected function printMigrationStatus(MigrationInterface $migration, string $status, ?string $duration = null): void - { - $this->printStatusOutput( - $migration->getVersion() . ' ' . $migration->getName(), - $status, - $duration, - ); - } - - /** - * Print Seed Status - * - * @param \Phinx\Seed\SeedInterface $seed Seed - * @param string $status Status of the seed - * @param string|null $duration Duration the seed took the be executed - * @return void - */ - protected function printSeedStatus(SeedInterface $seed, string $status, ?string $duration = null): void - { - $this->printStatusOutput( - $seed->getName(), - $status, - $duration, - ); - } - - /** - * Print Status in Output - * - * @param string $name Name of the migration or seed - * @param string $status Status of the migration or seed - * @param string|null $duration Duration the migration or seed took the be executed - * @return void - */ - protected function printStatusOutput(string $name, string $status, ?string $duration = null): void - { - $this->getOutput()->writeln( - ' ==' . - ' ' . $name . ':' . - ' ' . $status . ' ' . $duration . '', - $this->verbosityLevel, - ); - } - - /** - * Rollback an environment to the specified version. - * - * @param string $environment Environment - * @param int|string|null $target Target - * @param bool $force Force - * @param bool $targetMustMatchVersion Target must match version - * @param bool $fake Flag that if true, we just record running the migration, but not actually do the migration - * @return void - */ - public function rollback(string $environment, int|string|null $target = null, bool $force = false, bool $targetMustMatchVersion = true, bool $fake = false): void - { - // note that the migrations are indexed by name (aka creation time) in ascending order - $migrations = $this->getMigrations($environment); - - // note that the version log are also indexed by name with the proper ascending order according to the version order - $executedVersions = $this->getEnvironment($environment)->getVersionLog(); - - // get a list of migrations sorted in the opposite way of the executed versions - $sortedMigrations = []; - - foreach ($executedVersions as $versionCreationTime => &$executedVersion) { - // if we have a date (ie. the target must not match a version) and we are sorting by execution time, we - // convert the version start time so we can compare directly with the target date - if (!$this->getConfig()->isVersionOrderCreationTime() && !$targetMustMatchVersion) { - /** @var \DateTime $dateTime */ - $dateTime = DateTime::createFromFormat('Y-m-d H:i:s', $executedVersion['start_time']); - $executedVersion['start_time'] = $dateTime->format('YmdHis'); - } - - if (isset($migrations[$versionCreationTime])) { - array_unshift($sortedMigrations, $migrations[$versionCreationTime]); - } else { - // this means the version is missing so we unset it so that we don't consider it when rolling back - // migrations (or choosing the last up version as target) - unset($executedVersions[$versionCreationTime]); - } - } - - if ($target === 'all' || $target === '0') { - $target = 0; - } elseif (!is_numeric($target) && $target !== null) { // try to find a target version based on name - // search through the migrations using the name - $migrationNames = array_map(function ($item) { - return $item['migration_name']; - }, $executedVersions); - $found = array_search($target, $migrationNames, true); - - // check on was found - if ($found !== false) { - $target = (string)$found; - } else { - $this->getOutput()->writeln("No migration found with name ($target)"); - - return; - } - } - - // Check we have at least 1 migration to revert - $executedVersionCreationTimes = array_keys($executedVersions); - if (empty($executedVersionCreationTimes) || $target == end($executedVersionCreationTimes)) { - $this->getOutput()->writeln('No migrations to rollback'); - - return; - } - - // If no target was supplied, revert the last migration - if ($target === null) { - // Get the migration before the last run migration - $prev = count($executedVersionCreationTimes) - 2; - $target = $prev >= 0 ? $executedVersionCreationTimes[$prev] : 0; - } - - // If the target must match a version, check the target version exists - if ($targetMustMatchVersion && $target !== 0 && !isset($migrations[$target])) { - $this->getOutput()->writeln("Target version ($target) not found"); - - return; - } - - // Rollback all versions until we find the wanted rollback target - $rollbacked = false; - - foreach ($sortedMigrations as $migration) { - if ($targetMustMatchVersion && $migration->getVersion() == $target) { - break; - } - - if (in_array($migration->getVersion(), $executedVersionCreationTimes)) { - $executedVersion = $executedVersions[$migration->getVersion()]; - - if (!$targetMustMatchVersion) { - if ( - ($this->getConfig()->isVersionOrderCreationTime() && $executedVersion['version'] <= $target) || - (!$this->getConfig()->isVersionOrderCreationTime() && $executedVersion['start_time'] <= $target) - ) { - break; - } - } - - if ($executedVersion['breakpoint'] != 0 && !$force) { - $this->getOutput()->writeln('Breakpoint reached. Further rollbacks inhibited.'); - break; - } - $this->executeMigration($environment, $migration, MigrationInterface::DOWN, $fake); - $rollbacked = true; - } - } - - if (!$rollbacked) { - $this->getOutput()->writeln('No migrations to rollback'); - } - } - - /** - * Run database seeders against an environment. - * - * @param string $environment Environment - * @param string|null $seed Seeder - * @throws \InvalidArgumentException - * @return void - */ - public function seed(string $environment, ?string $seed = null): void - { - $seeds = $this->getSeeds($environment); - - if ($seed === null) { - // run all seeders - foreach ($seeds as $seeder) { - if (array_key_exists($seeder->getName(), $seeds)) { - $this->executeSeed($environment, $seeder); - } - } - } else { - // run only one seeder - if (array_key_exists($seed, $seeds)) { - $this->executeSeed($environment, $seeds[$seed]); - } else { - throw new InvalidArgumentException(sprintf('The seed class "%s" does not exist', $seed)); - } - } - } - - /** - * Sets the environments. - * - * @param \Phinx\Migration\Manager\Environment[] $environments Environments - * @return $this - */ - public function setEnvironments(array $environments = []) - { - $this->environments = $environments; - - return $this; - } - - /** - * Gets the manager class for the given environment. - * - * @param string $name Environment Name - * @throws \InvalidArgumentException - * @return \Phinx\Migration\Manager\Environment - */ - public function getEnvironment(string $name): Environment - { - if (isset($this->environments[$name])) { - return $this->environments[$name]; - } - - // check the environment exists - if (!$this->getConfig()->hasEnvironment($name)) { - throw new InvalidArgumentException(sprintf( - 'The environment "%s" does not exist', - $name, - )); - } - - // create an environment instance and cache it - $envOptions = $this->getConfig()->getEnvironment($name); - $envOptions['version_order'] = $this->getConfig()->getVersionOrder(); - $envOptions['data_domain'] = $this->getConfig()->getDataDomain(); - - $environment = new Environment($name, $envOptions); - $this->environments[$name] = $environment; - $environment->setInput($this->getInput()); - $environment->setOutput($this->getOutput()); - - return $environment; - } - - /** - * Sets the user defined PSR-11 container - * - * @param \Psr\Container\ContainerInterface $container Container - * @return $this - */ - public function setContainer(ContainerInterface $container) - { - $this->container = $container; - - return $this; - } - - /** - * Sets the console input. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @return $this - */ - public function setInput(InputInterface $input) - { - $this->input = $input; - - return $this; - } - - /** - * Gets the console input. - * - * @return \Symfony\Component\Console\Input\InputInterface - */ - public function getInput(): InputInterface - { - return $this->input; - } - - /** - * Sets the console output. - * - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return $this - */ - public function setOutput(OutputInterface $output) - { - $this->output = $output; - - return $this; - } - - /** - * Gets the console output. - * - * @return \Symfony\Component\Console\Output\OutputInterface - */ - public function getOutput(): OutputInterface - { - return $this->output; - } - - /** - * Sets the database migrations. - * - * @param \Phinx\Migration\AbstractMigration[] $migrations Migrations - * @return $this - */ - public function setMigrations(array $migrations) - { - $this->migrations = $migrations; - - return $this; - } - - /** - * Gets an array of the database migrations, indexed by migration name (aka creation time) and sorted in ascending - * order - * - * @param string $environment Environment - * @throws \InvalidArgumentException - * @return \Phinx\Migration\MigrationInterface[] - */ - public function getMigrations(string $environment): array - { - if ($this->migrations === null) { - $phpFiles = $this->getMigrationFiles(); - - if ($this->getOutput()->getVerbosity() >= OutputInterface::VERBOSITY_DEBUG) { - $this->getOutput()->writeln('Migration file'); - $this->getOutput()->writeln( - array_map( - function ($phpFile) { - return " {$phpFile}"; - }, - $phpFiles, - ), - ); - } - - // filter the files to only get the ones that match our naming scheme - $fileNames = []; - /** @var \Phinx\Migration\AbstractMigration[] $versions */ - $versions = []; - - foreach ($phpFiles as $filePath) { - if (Util::isValidMigrationFileName(basename($filePath))) { - if ($this->getOutput()->getVerbosity() >= OutputInterface::VERBOSITY_DEBUG) { - $this->getOutput()->writeln("Valid migration file {$filePath}."); - } - - $version = Util::getVersionFromFileName(basename($filePath)); - - if (isset($versions[$version])) { - throw new InvalidArgumentException(sprintf('Duplicate migration - "%s" has the same version as "%s"', $filePath, $versions[$version]->getVersion())); - } - - $config = $this->getConfig(); - $namespace = $config instanceof NamespaceAwareInterface ? $config->getMigrationNamespaceByPath(dirname($filePath)) : null; - - // convert the filename to a class name - $class = ($namespace === null ? '' : $namespace . '\\') . Util::mapFileNameToClassName(basename($filePath)); - - if (isset($fileNames[$class])) { - throw new InvalidArgumentException(sprintf( - 'Migration "%s" has the same name as "%s"', - basename($filePath), - $fileNames[$class], - )); - } - - $fileNames[$class] = basename($filePath); - - if ($this->getOutput()->getVerbosity() >= OutputInterface::VERBOSITY_DEBUG) { - $this->getOutput()->writeln("Loading class $class from $filePath."); - } - - // load the migration file - $orig_display_errors_setting = ini_get('display_errors'); - ini_set('display_errors', 'On'); - /** @noinspection PhpIncludeInspection */ - require_once $filePath; - ini_set('display_errors', $orig_display_errors_setting); - if (!class_exists($class)) { - throw new InvalidArgumentException(sprintf( - 'Could not find class "%s" in file "%s"', - $class, - $filePath, - )); - } - - if ($this->getOutput()->getVerbosity() >= OutputInterface::VERBOSITY_DEBUG) { - $this->getOutput()->writeln("Running $class."); - } - - // instantiate it - $migration = new $class($environment, $version, $this->getInput(), $this->getOutput()); - - if (!($migration instanceof AbstractMigration)) { - throw new InvalidArgumentException(sprintf( - 'The class "%s" in file "%s" must extend \Phinx\Migration\AbstractMigration', - $class, - $filePath, - )); - } - - $versions[$version] = $migration; - } else { - if ($this->getOutput()->getVerbosity() >= OutputInterface::VERBOSITY_DEBUG) { - $this->getOutput()->writeln("Invalid migration file {$filePath}."); - } - } - } - - ksort($versions); - $this->setMigrations($versions); - } - - return $this->migrations; - } - - /** - * Returns a list of migration files found in the provided migration paths. - * - * @return string[] - */ - protected function getMigrationFiles(): array - { - return Util::getFiles($this->getConfig()->getMigrationPaths()); - } - - /** - * Sets the database seeders. - * - * @param \Phinx\Seed\SeedInterface[] $seeds Seeders - * @return $this - */ - public function setSeeds(array $seeds) - { - $this->seeds = $seeds; - - return $this; - } - - /** - * Get seed dependencies instances from seed dependency array - * - * @param \Phinx\Seed\SeedInterface $seed Seed - * @return \Phinx\Seed\SeedInterface[] - */ - protected function getSeedDependenciesInstances(SeedInterface $seed): array - { - $dependenciesInstances = []; - $dependencies = $seed->getDependencies(); - if (!empty($dependencies)) { - foreach ($dependencies as $dependency) { - foreach ($this->seeds as $seed) { - if (get_class($seed) === $dependency) { - $dependenciesInstances[get_class($seed)] = $seed; - } - } - } - } - - return $dependenciesInstances; - } - - /** - * Order seeds by dependencies - * - * @param \Phinx\Seed\SeedInterface[] $seeds Seeds - * @return \Phinx\Seed\SeedInterface[] - */ - protected function orderSeedsByDependencies(array $seeds): array - { - $orderedSeeds = []; - foreach ($seeds as $seed) { - $orderedSeeds[get_class($seed)] = $seed; - $dependencies = $this->getSeedDependenciesInstances($seed); - if (!empty($dependencies)) { - $orderedSeeds = array_merge($this->orderSeedsByDependencies($dependencies), $orderedSeeds); - } - } - - return $orderedSeeds; - } - - /** - * Gets an array of database seeders. - * - * @param string $environment Environment - * @throws \InvalidArgumentException - * @return \Phinx\Seed\SeedInterface[] - */ - public function getSeeds(string $environment): array - { - if ($this->seeds === null) { - $phpFiles = $this->getSeedFiles(); - - // filter the files to only get the ones that match our naming scheme - $fileNames = []; - /** @var \Phinx\Seed\SeedInterface[] $seeds */ - $seeds = []; - - foreach ($phpFiles as $filePath) { - if (Util::isValidSeedFileName(basename($filePath))) { - $config = $this->getConfig(); - $namespace = $config instanceof NamespaceAwareInterface ? $config->getSeedNamespaceByPath(dirname($filePath)) : null; - - // convert the filename to a class name - $class = ($namespace === null ? '' : $namespace . '\\') . pathinfo($filePath, PATHINFO_FILENAME); - $fileNames[$class] = basename($filePath); - - // load the seed file - /** @noinspection PhpIncludeInspection */ - require_once $filePath; - if (!class_exists($class)) { - throw new InvalidArgumentException(sprintf( - 'Could not find class "%s" in file "%s"', - $class, - $filePath, - )); - } - - // instantiate it - /** @var \Phinx\Seed\AbstractSeed $seed */ - if (isset($this->container)) { - $seed = $this->container->get($class); - } else { - $seed = new $class(); - } - $seed->setEnvironment($environment); - $input = $this->getInput(); - if ($input !== null) { - $seed->setInput($input); - } - $output = $this->getOutput(); - if ($output !== null) { - $seed->setOutput($output); - } - - if (!($seed instanceof AbstractSeed)) { - throw new InvalidArgumentException(sprintf( - 'The class "%s" in file "%s" must extend \Phinx\Seed\AbstractSeed', - $class, - $filePath, - )); - } - - $seeds[$class] = $seed; - } - } - - ksort($seeds); - $this->setSeeds($seeds); - } - - $this->seeds = $this->orderSeedsByDependencies($this->seeds); - - return $this->seeds; - } - - /** - * Returns a list of seed files found in the provided seed paths. - * - * @return string[] - */ - protected function getSeedFiles(): array - { - return Util::getFiles($this->getConfig()->getSeedPaths()); - } - - /** - * Sets the config. - * - * @param \Phinx\Config\ConfigInterface $config Configuration Object - * @return $this - */ - public function setConfig(ConfigInterface $config) - { - $this->config = $config; - - return $this; - } - - /** - * Gets the config. - * - * @return \Phinx\Config\ConfigInterface - */ - public function getConfig(): ConfigInterface - { - return $this->config; - } - - /** - * Toggles the breakpoint for a specific version. - * - * @param string $environment Environment name - * @param int|null $version Version - * @return void - */ - public function toggleBreakpoint(string $environment, ?int $version): void - { - $this->markBreakpoint($environment, $version, self::BREAKPOINT_TOGGLE); - } - - /** - * Updates the breakpoint for a specific version. - * - * @param string $environment The required environment - * @param int|null $version The version of the target migration - * @param int $mark The state of the breakpoint as defined by self::BREAKPOINT_xxxx constants. - * @return void - */ - protected function markBreakpoint(string $environment, ?int $version, int $mark): void - { - $migrations = $this->getMigrations($environment); - $env = $this->getEnvironment($environment); - $versions = $env->getVersionLog(); - - if (empty($versions) || empty($migrations)) { - return; - } - - if ($version === null) { - $lastVersion = end($versions); - $version = $lastVersion['version']; - } - - if ($version != 0 && (!isset($versions[$version]) || !isset($migrations[$version]))) { - $this->output->writeln(sprintf( - 'warning %s is not a valid version', - $version, - )); - - return; - } - - switch ($mark) { - case self::BREAKPOINT_TOGGLE: - $env->getAdapter()->toggleBreakpoint($migrations[$version]); - break; - case self::BREAKPOINT_SET: - if ($versions[$version]['breakpoint'] == 0) { - $env->getAdapter()->setBreakpoint($migrations[$version]); - } - break; - case self::BREAKPOINT_UNSET: - if ($versions[$version]['breakpoint'] == 1) { - $env->getAdapter()->unsetBreakpoint($migrations[$version]); - } - break; - } - - $versions = $env->getVersionLog(); - - $this->getOutput()->writeln( - ' Breakpoint ' . ($versions[$version]['breakpoint'] ? 'set' : 'cleared') . - ' for ' . $version . '' . - ' ' . $migrations[$version]->getName() . '', - ); - } - - /** - * Remove all breakpoints - * - * @param string $environment The required environment - * @return void - */ - public function removeBreakpoints(string $environment): void - { - $this->getOutput()->writeln(sprintf( - ' %d breakpoints cleared.', - $this->getEnvironment($environment)->getAdapter()->resetAllBreakpoints(), - )); - } - - /** - * Set the breakpoint for a specific version. - * - * @param string $environment The required environment - * @param int|null $version The version of the target migration - * @return void - */ - public function setBreakpoint(string $environment, ?int $version): void - { - $this->markBreakpoint($environment, $version, self::BREAKPOINT_SET); - } - - /** - * Unset the breakpoint for a specific version. - * - * @param string $environment The required environment - * @param int|null $version The version of the target migration - * @return void - */ - public function unsetBreakpoint(string $environment, ?int $version): void - { - $this->markBreakpoint($environment, $version, self::BREAKPOINT_UNSET); - } - - /** - * @param int $verbosityLevel Verbosity level for info messages - * @return $this - */ - public function setVerbosityLevel(int $verbosityLevel) - { - $this->verbosityLevel = $verbosityLevel; - - return $this; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Migration/Manager/Environment.php b/app/vendor/robmorgan/phinx/src/Phinx/Migration/Manager/Environment.php deleted file mode 100644 index 756206586..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Migration/Manager/Environment.php +++ /dev/null @@ -1,399 +0,0 @@ - - */ - protected array $options; - - /** - * @var \Symfony\Component\Console\Input\InputInterface|null - */ - protected ?InputInterface $input = null; - - /** - * @var \Symfony\Component\Console\Output\OutputInterface|null - */ - protected ?OutputInterface $output = null; - - /** - * @var int - */ - protected int $currentVersion; - - /** - * @var string - */ - protected string $schemaTableName = 'phinxlog'; - - /** - * @var \Phinx\Db\Adapter\AdapterInterface - */ - protected AdapterInterface $adapter; - - /** - * @param string $name Environment Name - * @param array $options Options - */ - public function __construct(string $name, array $options) - { - $this->name = $name; - $this->options = $options; - } - - /** - * Executes the specified migration on this environment. - * - * @param \Phinx\Migration\MigrationInterface $migration Migration - * @param string $direction Direction - * @param bool $fake flag that if true, we just record running the migration, but not actually do the migration - * @return void - */ - public function executeMigration(MigrationInterface $migration, string $direction = MigrationInterface::UP, bool $fake = false): void - { - $direction = $direction === MigrationInterface::UP ? MigrationInterface::UP : MigrationInterface::DOWN; - $migration->setMigratingUp($direction === MigrationInterface::UP); - - $startTime = time(); - $migration->setAdapter($this->getAdapter()); - - $migration->preFlightCheck(); - - if (method_exists($migration, MigrationInterface::INIT)) { - $migration->{MigrationInterface::INIT}(); - } - - // begin the transaction if the adapter supports it - if ($this->getAdapter()->hasTransactions()) { - $this->getAdapter()->beginTransaction(); - } - - if (!$fake) { - // Run the migration - if (method_exists($migration, MigrationInterface::CHANGE)) { - if ($direction === MigrationInterface::DOWN) { - // Create an instance of the ProxyAdapter so we can record all - // of the migration commands for reverse playback - - /** @var \Phinx\Db\Adapter\ProxyAdapter $proxyAdapter */ - $proxyAdapter = AdapterFactory::instance() - ->getWrapper('proxy', $this->getAdapter()); - $migration->setAdapter($proxyAdapter); - $migration->{MigrationInterface::CHANGE}(); - $proxyAdapter->executeInvertedCommands(); - $migration->setAdapter($this->getAdapter()); - } else { - $migration->{MigrationInterface::CHANGE}(); - } - } else { - $migration->{$direction}(); - } - } - - // Record it in the database - $this->getAdapter()->migrated($migration, $direction, date('Y-m-d H:i:s', $startTime), date('Y-m-d H:i:s', time())); - - $migration->postFlightCheck(); - - // commit the transaction if the adapter supports it - if ($this->getAdapter()->hasTransactions()) { - $this->getAdapter()->commitTransaction(); - } - } - - /** - * Executes the specified seeder on this environment. - * - * @param \Phinx\Seed\SeedInterface $seed Seed - * @return void - */ - public function executeSeed(SeedInterface $seed): void - { - $seed->setAdapter($this->getAdapter()); - if (method_exists($seed, SeedInterface::INIT)) { - $seed->{SeedInterface::INIT}(); - } - - // begin the transaction if the adapter supports it - if ($this->getAdapter()->hasTransactions()) { - $this->getAdapter()->beginTransaction(); - } - - // Run the seeder - if (method_exists($seed, SeedInterface::RUN)) { - $seed->{SeedInterface::RUN}(); - } - - // commit the transaction if the adapter supports it - if ($this->getAdapter()->hasTransactions()) { - $this->getAdapter()->commitTransaction(); - } - } - - /** - * Sets the environment's name. - * - * @param string $name Environment Name - * @return $this - */ - public function setName(string $name) - { - $this->name = $name; - - return $this; - } - - /** - * Gets the environment name. - * - * @return string - */ - public function getName(): string - { - return $this->name; - } - - /** - * Sets the environment's options. - * - * @param array $options Environment Options - * @return $this - */ - public function setOptions(array $options) - { - $this->options = $options; - - return $this; - } - - /** - * Gets the environment's options. - * - * @return array - */ - public function getOptions(): array - { - return $this->options; - } - - /** - * Sets the console input. - * - * @param \Symfony\Component\Console\Input\InputInterface $input Input - * @return $this - */ - public function setInput(InputInterface $input) - { - $this->input = $input; - - return $this; - } - - /** - * Gets the console input. - * - * @return \Symfony\Component\Console\Input\InputInterface|null - */ - public function getInput(): ?InputInterface - { - return $this->input; - } - - /** - * Sets the console output. - * - * @param \Symfony\Component\Console\Output\OutputInterface $output Output - * @return $this - */ - public function setOutput(OutputInterface $output) - { - $this->output = $output; - - return $this; - } - - /** - * Gets the console output. - * - * @return \Symfony\Component\Console\Output\OutputInterface|null - */ - public function getOutput(): ?OutputInterface - { - return $this->output; - } - - /** - * Gets all migrated version numbers. - * - * @return array - */ - public function getVersions(): array - { - return $this->getAdapter()->getVersions(); - } - - /** - * Get all migration log entries, indexed by version creation time and sorted in ascending order by the configuration's - * version_order option - * - * @return array - */ - public function getVersionLog(): array - { - return $this->getAdapter()->getVersionLog(); - } - - /** - * Sets the current version of the environment. - * - * @param int $version Environment Version - * @return $this - */ - public function setCurrentVersion(int $version) - { - $this->currentVersion = $version; - - return $this; - } - - /** - * Gets the current version of the environment. - * - * @return int - */ - public function getCurrentVersion(): int - { - // We don't cache this code as the current version is pretty volatile. - // that means they're no point in a setter then? - // maybe we should cache and call a reset() method every time a migration is run - $versions = $this->getVersions(); - $version = 0; - - if (!empty($versions)) { - $version = end($versions); - } - - $this->setCurrentVersion($version); - - return $this->currentVersion; - } - - /** - * Sets the database adapter. - * - * @param \Phinx\Db\Adapter\AdapterInterface $adapter Database Adapter - * @return $this - */ - public function setAdapter(AdapterInterface $adapter) - { - $this->adapter = $adapter; - - return $this; - } - - /** - * Gets the database adapter. - * - * @throws \RuntimeException - * @return \Phinx\Db\Adapter\AdapterInterface - */ - public function getAdapter(): AdapterInterface - { - if (isset($this->adapter)) { - return $this->adapter; - } - - $options = $this->getOptions(); - if (isset($options['connection'])) { - if (!($options['connection'] instanceof PDO)) { - throw new RuntimeException('The specified connection is not a PDO instance'); - } - - $options['connection']->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); - $options['adapter'] = $options['connection']->getAttribute(PDO::ATTR_DRIVER_NAME); - } - if (!isset($options['adapter'])) { - throw new RuntimeException('No adapter was specified for environment: ' . $this->getName()); - } - - $factory = AdapterFactory::instance(); - $adapter = $factory - ->getAdapter($options['adapter'], $options); - - // Automatically time the executed commands - $adapter = $factory->getWrapper('timed', $adapter); - - if (isset($options['wrapper'])) { - $adapter = $factory - ->getWrapper($options['wrapper'], $adapter); - } - - /** @var \Symfony\Component\Console\Input\InputInterface|null $input */ - $input = $this->getInput(); - if ($input) { - $adapter->setInput($this->getInput()); - } - - /** @var \Symfony\Component\Console\Output\OutputInterface|null $output */ - $output = $this->getOutput(); - if ($output) { - $adapter->setOutput($this->getOutput()); - } - - // Use the TablePrefixAdapter if table prefix/suffixes are in use - if ($adapter->hasOption('table_prefix') || $adapter->hasOption('table_suffix')) { - $adapter = AdapterFactory::instance() - ->getWrapper('prefix', $adapter); - } - - $this->setAdapter($adapter); - - return $adapter; - } - - /** - * Sets the schema table name. - * - * @param string $schemaTableName Schema Table Name - * @return $this - */ - public function setSchemaTableName(string $schemaTableName) - { - $this->schemaTableName = $schemaTableName; - - return $this; - } - - /** - * Gets the schema table name. - * - * @return string - */ - public function getSchemaTableName(): string - { - return $this->schemaTableName; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Migration/Migration.change.template.php.dist b/app/vendor/robmorgan/phinx/src/Phinx/Migration/Migration.change.template.php.dist deleted file mode 100644 index 40b609baf..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Migration/Migration.change.template.php.dist +++ /dev/null @@ -1,24 +0,0 @@ - $options Options - * @return void - */ - public function createDatabase(string $name, array $options): void; - - /** - * Drop a database. - * - * @param string $name Database Name - * @return void - */ - public function dropDatabase(string $name): void; - - /** - * Creates schema. - * - * This will thrown an error for adapters that do not support schemas. - * - * @param string $name Schema name - * @return void - * @throws \BadMethodCallException - */ - public function createSchema(string $name): void; - - /** - * Drops schema. - * - * This will thrown an error for adapters that do not support schemas. - * - * @param string $name Schema name - * @return void - * @throws \BadMethodCallException - */ - public function dropSchema(string $name): void; - - /** - * Checks to see if a table exists. - * - * @param string $tableName Table name - * @return bool - */ - public function hasTable(string $tableName): bool; - - /** - * Returns an instance of the \Table class. - * - * You can use this class to create and manipulate tables. - * - * @param string $tableName Table name - * @param array $options Options - * @return \Phinx\Db\Table - */ - public function table(string $tableName, array $options): Table; - - /** - * Perform checks on the migration, printing a warning - * if there are potential problems. - * - * @return void - */ - public function preFlightCheck(): void; - - /** - * Perform checks on the migration after completion - * - * Right now, the only check is whether all changes were committed - * - * @return void - */ - public function postFlightCheck(): void; - - /** - * Checks to see if the migration should be executed. - * - * Returns true by default. - * - * You can use this to prevent a migration from executing. - * - * @return bool - */ - public function shouldExecute(): bool; -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Seed/AbstractSeed.php b/app/vendor/robmorgan/phinx/src/Phinx/Seed/AbstractSeed.php deleted file mode 100644 index d9cdc9df3..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Seed/AbstractSeed.php +++ /dev/null @@ -1,226 +0,0 @@ -environment = $environment; - - return $this; - } - - /** - * @inheritDoc - */ - public function getEnvironment(): string - { - return $this->environment; - } - - /** - * @inheritDoc - */ - public function setAdapter(AdapterInterface $adapter): SeedInterface - { - $this->adapter = $adapter; - - return $this; - } - - /** - * @inheritDoc - */ - public function getAdapter(): AdapterInterface - { - if (!isset($this->adapter)) { - throw new RuntimeException('Cannot access `adapter` it has not been set'); - } - - return $this->adapter; - } - - /** - * @inheritDoc - */ - public function setInput(InputInterface $input) - { - $this->input = $input; - - return $this; - } - - /** - * @inheritDoc - */ - public function getInput(): InputInterface - { - return $this->input; - } - - /** - * @inheritDoc - */ - public function setOutput(OutputInterface $output): SeedInterface - { - $this->output = $output; - - return $this; - } - - /** - * @inheritDoc - */ - public function getOutput(): OutputInterface - { - return $this->output; - } - - /** - * @inheritDoc - */ - public function getName(): string - { - return static::class; - } - - /** - * @inheritDoc - */ - public function execute(string $sql, array $params = []): int - { - return $this->getAdapter()->execute($sql, $params); - } - - /** - * @inheritDoc - */ - public function query(string $sql, array $params = []): mixed - { - return $this->getAdapter()->query($sql, $params); - } - - /** - * @inheritDoc - */ - public function fetchRow(string $sql): array|false - { - return $this->getAdapter()->fetchRow($sql); - } - - /** - * @inheritDoc - */ - public function fetchAll(string $sql): array - { - return $this->getAdapter()->fetchAll($sql); - } - - /** - * @inheritDoc - */ - public function insert(string $table, array $data): void - { - // convert to table object - if (is_string($table)) { - $table = new Table($table, [], $this->getAdapter()); - } - $table->insert($data)->save(); - } - - /** - * @inheritDoc - */ - public function hasTable(string $tableName): bool - { - return $this->getAdapter()->hasTable($tableName); - } - - /** - * @inheritDoc - */ - public function table(string $tableName, array $options = []): Table - { - return new Table($tableName, $options, $this->getAdapter()); - } - - /** - * Checks to see if the seed should be executed. - * - * Returns true by default. - * - * You can use this to prevent a seed from executing. - * - * @return bool - */ - public function shouldExecute(): bool - { - return true; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Seed/Seed.template.php.dist b/app/vendor/robmorgan/phinx/src/Phinx/Seed/Seed.template.php.dist deleted file mode 100644 index ebb0affc4..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Seed/Seed.template.php.dist +++ /dev/null @@ -1,21 +0,0 @@ -\Table class. - * - * You can use this class to create and manipulate tables. - * - * @param string $tableName Table name - * @param array $options Options - * @return \Phinx\Db\Table - */ - public function table(string $tableName, array $options): Table; - - /** - * Checks to see if the seed should be executed. - * - * Returns true by default. - * - * You can use this to prevent a seed from executing. - * - * @return bool - */ - public function shouldExecute(): bool; -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Util/Expression.php b/app/vendor/robmorgan/phinx/src/Phinx/Util/Expression.php deleted file mode 100644 index 0de52fc2f..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Util/Expression.php +++ /dev/null @@ -1,42 +0,0 @@ -value = $value; - } - - /** - * @return string Returns the expression - */ - public function __toString(): string - { - return $this->value; - } - - /** - * @param string $value The expression - * @return self - */ - public static function from(string $value): Expression - { - return new self($value); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Util/Literal.php b/app/vendor/robmorgan/phinx/src/Phinx/Util/Literal.php deleted file mode 100644 index a3ea362eb..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Util/Literal.php +++ /dev/null @@ -1,42 +0,0 @@ -value = $value; - } - - /** - * @return string Returns the literal's value - */ - public function __toString(): string - { - return $this->value; - } - - /** - * @param string $value The literal's value - * @return self - */ - public static function from(string $value): Literal - { - return new self($value); - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Util/Util.php b/app/vendor/robmorgan/phinx/src/Phinx/Util/Util.php deleted file mode 100644 index 785b1f4a9..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Util/Util.php +++ /dev/null @@ -1,394 +0,0 @@ -modify('+' . $offset . ' seconds'); - } - - return $dt->format(static::DATE_FORMAT); - } - - /** - * Checks that the given timestamp is a unique prefix for any files in the given path. - * - * @param string $path Path to check - * @param string $timestamp Timestamp to check - * @return bool - */ - public static function isUniqueTimestamp(string $path, string $timestamp): bool - { - return !count(static::glob($path . DIRECTORY_SEPARATOR . $timestamp . '*.php')); - } - - /** - * Gets an array of all the existing migration class names. - * - * @param string $path Path - * @return string[] - */ - public static function getExistingMigrationClassNames(string $path): array - { - $classNames = []; - - if (!is_dir($path)) { - return $classNames; - } - - // filter the files to only get the ones that match our naming scheme - $phpFiles = static::getFiles($path); - - foreach ($phpFiles as $filePath) { - $fileName = basename($filePath); - if (preg_match(static::MIGRATION_FILE_NAME_PATTERN, $fileName)) { - $classNames[] = static::mapFileNameToClassName($fileName); - } - } - - return $classNames; - } - - /** - * Get the version from the beginning of a file name. - * - * @param string $fileName File Name - * @return int - */ - public static function getVersionFromFileName(string $fileName): int - { - $matches = []; - preg_match('/^[0-9]+/', basename($fileName), $matches); - $value = (int)($matches[0] ?? null); - if (!$value) { - throw new RuntimeException(sprintf('Cannot get a valid version from filename `%s`', $fileName)); - } - - return $value; - } - - /** - * Given a string, convert it to snake_case. - * - * @param string $string String to convert - * @return string - */ - public static function toSnakeCase(string $string): string - { - $snake = function ($matches) { - return '_' . strtolower($matches[0]); - }; - - return preg_replace_callback('/\d+|[A-Z]/', $snake, $string); - } - - /** - * Turn migration names like 'CreateUserTable' into file names like - * '12345678901234_create_user_table.php' or 'LimitResourceNamesTo30Chars' into - * '12345678901234_limit_resource_names_to_30_chars.php'. - * - * @deprecated Will be removed in 0.17.0 - * @param string $className Class Name - * @return string - */ - public static function mapClassNameToFileName(string $className): string - { - trigger_error('Util::mapClassNameToFileName is deprecated since 0.16.6, and will be removed in a future release.', E_USER_DEPRECATED); - $snake = function ($matches) { - return '_' . strtolower($matches[0]); - }; - $fileName = preg_replace_callback('/\d+|[A-Z]/', $snake, $className); - $fileName = static::getCurrentTimestamp() . "$fileName.php"; - - return $fileName; - } - - /** - * Turn file names like '12345678901234_create_user_table.php' into class - * names like 'CreateUserTable'. - * - * @param string $fileName File Name - * @return string - */ - public static function mapFileNameToClassName(string $fileName): string - { - $matches = []; - if (preg_match(static::MIGRATION_FILE_NAME_PATTERN, $fileName, $matches)) { - $fileName = $matches[1]; - } elseif (preg_match(static::MIGRATION_FILE_NAME_NO_NAME_PATTERN, $fileName)) { - return 'V' . substr($fileName, 0, strlen($fileName) - 4); - } - - $className = str_replace('_', '', ucwords($fileName, '_')); - - return $className; - } - - /** - * Check if a migration class name is unique regardless of the - * timestamp. - * - * This method takes a class name and a path to a migrations directory. - * - * Migration class names must be in PascalCase format but consecutive - * capitals are allowed. - * e.g: AddIndexToPostsTable or CustomHTMLTitle. - * - * @param string $className Class Name - * @param string $path Path - * @return bool - */ - public static function isUniqueMigrationClassName(string $className, string $path): bool - { - $existingClassNames = static::getExistingMigrationClassNames($path); - - return !in_array($className, $existingClassNames, true); - } - - /** - * Check if a migration/seed class name is valid. - * - * Migration & Seed class names must be in CamelCase format. - * e.g: CreateUserTable, AddIndexToPostsTable or UserSeeder. - * - * Single words are not allowed on their own. - * - * @param string $className Class Name - * @return bool - */ - public static function isValidPhinxClassName(string $className): bool - { - return (bool)preg_match(static::CLASS_NAME_PATTERN, $className); - } - - /** - * Check if a migration file name is valid. - * - * @param string $fileName File Name - * @return bool - */ - public static function isValidMigrationFileName(string $fileName): bool - { - return (bool)preg_match(static::MIGRATION_FILE_NAME_PATTERN, $fileName) - || (bool)preg_match(static::MIGRATION_FILE_NAME_NO_NAME_PATTERN, $fileName); - } - - /** - * Check if a seed file name is valid. - * - * @param string $fileName File Name - * @return bool - */ - public static function isValidSeedFileName(string $fileName): bool - { - return (bool)preg_match(static::SEED_FILE_NAME_PATTERN, $fileName); - } - - /** - * Expands a set of paths with curly braces (if supported by the OS). - * - * @param string[] $paths Paths - * @return string[] - */ - public static function globAll(array $paths): array - { - $result = []; - - foreach ($paths as $path) { - $result = array_merge($result, static::glob($path)); - } - - return $result; - } - - /** - * Expands a path with curly braces (if supported by the OS). - * - * @param string $path Path - * @return string[] - */ - public static function glob(string $path): array - { - return glob($path, defined('GLOB_BRACE') ? GLOB_BRACE : 0); - } - - /** - * Takes the path to a php file and attempts to include it if readable - * - * @param string $filename Filename - * @param \Symfony\Component\Console\Input\InputInterface|null $input Input - * @param \Symfony\Component\Console\Output\OutputInterface|null $output Output - * @param \Phinx\Console\Command\AbstractCommand|mixed|null $context Context - * @throws \Exception - * @return string - */ - public static function loadPhpFile(string $filename, ?InputInterface $input = null, ?OutputInterface $output = null, mixed $context = null): string - { - $filePath = realpath($filename); - if (!file_exists($filePath)) { - throw new Exception(sprintf("File does not exist: %s \n", $filename)); - } - - /** - * I lifed this from phpunits FileLoader class - * - * @see https://github.com/sebastianbergmann/phpunit/pull/2751 - */ - $isReadable = @fopen($filePath, 'r') !== false; - - if (!$isReadable) { - throw new Exception(sprintf("Cannot open file %s \n", $filename)); - } - - // prevent this to be propagated to the included file - unset($isReadable); - - include_once $filePath; - - return $filePath; - } - - /** - * Given an array of paths, return all unique PHP files that are in them - * - * @param string|string[] $paths Path or array of paths to get .php files. - * @return string[] - */ - public static function getFiles(string|array $paths): array - { - $files = static::globAll(array_map(function ($path) { - return $path . DIRECTORY_SEPARATOR . '*.php'; - }, (array)$paths)); - // glob() can return the same file multiple times - // This will cause the migration to fail with a - // false assumption of duplicate migrations - // https://php.net/manual/en/function.glob.php#110340 - $files = array_unique($files); - - return $files; - } - - /** - * Attempt to remove the current working directory from a path for output. - * - * @param string $path Path to remove cwd prefix from - * @return string - */ - public static function relativePath(string $path): string - { - $realpath = realpath($path); - if ($realpath !== false) { - $path = $realpath; - } - - $cwd = getcwd(); - if ($cwd !== false) { - $cwd .= DIRECTORY_SEPARATOR; - $cwdLen = strlen($cwd); - - if (substr($path, 0, $cwdLen) === $cwd) { - $path = substr($path, $cwdLen); - } - } - - return $path; - } - - /** - * Parses DSN string into db config array. - * - * @param string $dsn DSN string - * @return array - */ - public static function parseDsn(string $dsn): array - { - $pattern = <<<'REGEXP' -{ - ^ - (?: - (?P[\w\\\\]+):// - ) - (?: - (?P.*?) - (?: - :(?P.*?) - )? - @ - )? - (?: - (?P[^?#/:@]+) - (?: - :(?P\d+) - )? - )? - (?: - /(?P[^?#]*) - )? - (?: - \?(?P[^#]*) - )? - $ -}x -REGEXP; - - if (!preg_match($pattern, $dsn, $parsed)) { - return []; - } - - // filter out everything except the matched groups - $config = array_intersect_key($parsed, array_flip(['adapter', 'user', 'pass', 'host', 'port', 'name'])); - $config = array_filter($config); - - parse_str($parsed['query'] ?? '', $query); - $config = array_merge($query, $config); - - return $config; - } -} diff --git a/app/vendor/robmorgan/phinx/src/Phinx/Wrapper/TextWrapper.php b/app/vendor/robmorgan/phinx/src/Phinx/Wrapper/TextWrapper.php deleted file mode 100644 index 1e23ea9b9..000000000 --- a/app/vendor/robmorgan/phinx/src/Phinx/Wrapper/TextWrapper.php +++ /dev/null @@ -1,248 +0,0 @@ - - */ - protected array $options; - - /** - * @var int - */ - protected int $exitCode; - - /** - * @param \Phinx\Console\PhinxApplication $app Application - * @param array $options Options - */ - public function __construct(PhinxApplication $app, array $options = []) - { - $this->app = $app; - $this->options = $options; - } - - /** - * Get the application instance. - * - * @return \Phinx\Console\PhinxApplication - */ - public function getApp(): PhinxApplication - { - return $this->app; - } - - /** - * Returns the exit code from the last run command. - * - * @return int - */ - public function getExitCode(): int - { - return $this->exitCode; - } - - /** - * Returns the output from running the "status" command. - * - * @param string|null $env environment name (optional) - * @return string - */ - public function getStatus(?string $env = null): string - { - $command = ['status']; - if ($this->hasEnvValue($env)) { - $command['-e'] = $env ?: $this->getOption('environment'); - } - if ($this->hasOption('configuration')) { - $command['-c'] = $this->getOption('configuration'); - } - if ($this->hasOption('parser')) { - $command['-p'] = $this->getOption('parser'); - } - if ($this->hasOption('format')) { - $command['-f'] = $this->getOption('format'); - } - - return $this->executeRun($command); - } - - /** - * @param string|null $env environment name - * @return bool - */ - private function hasEnvValue(?string $env): bool - { - return $env || $this->hasOption('environment'); - } - - /** - * Returns the output from running the "migrate" command. - * - * @param string|null $env environment name (optional) - * @param string|null $target target version (optional) - * @return string - */ - public function getMigrate(?string $env = null, ?string $target = null): string - { - $command = ['migrate']; - if ($this->hasEnvValue($env)) { - $command += ['-e' => $env ?: $this->getOption('environment')]; - } - if ($this->hasOption('configuration')) { - $command += ['-c' => $this->getOption('configuration')]; - } - if ($this->hasOption('parser')) { - $command += ['-p' => $this->getOption('parser')]; - } - if ($target) { - $command += ['-t' => $target]; - } - - return $this->executeRun($command); - } - - /** - * Returns the output from running the "seed:run" command. - * - * @param string|null $env Environment name - * @param string|null $target Target version - * @param string[]|string|null $seed Array of seed names or seed name - * @return string - */ - public function getSeed(?string $env = null, ?string $target = null, array|string|null $seed = null): string - { - $command = ['seed:run']; - if ($this->hasEnvValue($env)) { - $command += ['-e' => $env ?: $this->getOption('environment')]; - } - if ($this->hasOption('configuration')) { - $command += ['-c' => $this->getOption('configuration')]; - } - if ($this->hasOption('parser')) { - $command += ['-p' => $this->getOption('parser')]; - } - if ($target) { - $command += ['-t' => $target]; - } - if ($seed) { - $seed = (array)$seed; - $command += ['-s' => $seed]; - } - - return $this->executeRun($command); - } - - /** - * Returns the output from running the "rollback" command. - * - * @param string|null $env Environment name (optional) - * @param mixed $target Target version, or 0 (zero) fully revert (optional) - * @return string - */ - public function getRollback(?string $env = null, mixed $target = null): string - { - $command = ['rollback']; - if ($this->hasEnvValue($env)) { - $command += ['-e' => $env ?: $this->getOption('environment')]; - } - if ($this->hasOption('configuration')) { - $command += ['-c' => $this->getOption('configuration')]; - } - if ($this->hasOption('parser')) { - $command += ['-p' => $this->getOption('parser')]; - } - if (isset($target)) { - // Need to use isset() with rollback, because -t0 is a valid option! - // See https://book.cakephp.org/phinx/0/en/commands.html#the-rollback-command - $command += ['-t' => $target]; - } - - return $this->executeRun($command); - } - - /** - * Check option from options array - * - * @param string $key Key - * @return bool - */ - protected function hasOption(string $key): bool - { - return isset($this->options[$key]); - } - - /** - * Get option from options array - * - * @param string $key Key - * @return string|null - */ - protected function getOption(string $key): ?string - { - if (!isset($this->options[$key])) { - return null; - } - - return $this->options[$key]; - } - - /** - * Set option in options array - * - * @param string $key Key - * @param string $value Value - * @return $this - */ - public function setOption(string $key, string $value) - { - $this->options[$key] = $value; - - return $this; - } - - /** - * Execute a command, capturing output and storing the exit code. - * - * @param array $command Command - * @return string - */ - protected function executeRun(array $command): string - { - // Output will be written to a temporary stream, so that it can be - // collected after running the command. - $stream = fopen('php://temp', 'w+'); - - // Execute the command, capturing the output in the temporary stream - // and storing the exit code for debugging purposes. - $this->exitCode = $this->app->doRun(new ArrayInput($command), new StreamOutput($stream)); - - // Get the output of the command and close the stream, which will - // destroy the temporary file. - $result = stream_get_contents($stream, -1, 0); - fclose($stream); - - return $result; - } -} diff --git a/app/vendor/robmorgan/phinx/src/composer_autoloader.php b/app/vendor/robmorgan/phinx/src/composer_autoloader.php deleted file mode 100644 index 51cac42c9..000000000 --- a/app/vendor/robmorgan/phinx/src/composer_autoloader.php +++ /dev/null @@ -1,24 +0,0 @@ -=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true @@ -36,7 +36,7 @@ }, "extra": { "branch-alias": { - "dev-main": "4.0-dev" + "dev-main": "5.0-dev" } } } diff --git a/app/vendor/sebastian/cli-parser/src/Parser.php b/app/vendor/sebastian/cli-parser/src/Parser.php index e1f02291d..c49f7d47f 100644 --- a/app/vendor/sebastian/cli-parser/src/Parser.php +++ b/app/vendor/sebastian/cli-parser/src/Parser.php @@ -20,17 +20,20 @@ use function is_array; use function is_int; use function key; +use function levenshtein; use function next; use function preg_replace; use function reset; +use function rtrim; use function sort; use function str_ends_with; use function str_starts_with; use function strlen; use function strstr; use function substr; +use function usort; -final class Parser +final readonly class Parser { /** * @param list $argv @@ -45,7 +48,7 @@ final class Parser */ public function parse(array $argv, string $shortOptions, ?array $longOptions = null): array { - if (empty($argv)) { + if ($argv === []) { return [[], []]; } @@ -62,7 +65,7 @@ public function parse(array $argv, string $shortOptions, ?array $longOptions = n reset($argv); - $argv = array_map('trim', $argv); + $argv = array_map(trim(...), $argv); while (false !== $arg = current($argv)) { $i = key($argv); @@ -124,7 +127,7 @@ private function parseShortOption(string $argument, string $shortOptions, array $optionArgument = null; if ($argument[$i] === ':' || ($spec = strstr($shortOptions, $option)) === false) { - throw new UnknownOptionException('-' . $option); + throw new UnknownOptionException('-' . $option, []); } if (strlen($spec) > 1 && $spec[1] === ':') { @@ -164,15 +167,21 @@ private function parseLongOption(string $argument, array $longOptions, array &$o $count = count($longOptions); $list = explode('=', $argument); $option = $list[0]; + $optionLength = strlen($option); + $similarOptions = []; $optionArgument = null; if (count($list) > 1) { + /** @phpstan-ignore offsetAccess.notFound */ $optionArgument = $list[1]; } - $optionLength = strlen($option); - foreach ($longOptions as $i => $longOption) { + $similarOptions[] = [ + levenshtein($longOption, $option), + '--' . rtrim($longOption, '='), + ]; + $opt_start = substr($longOption, 0, $optionLength); if ($opt_start !== $option) { @@ -181,12 +190,24 @@ private function parseLongOption(string $argument, array $longOptions, array &$o $opt_rest = substr($longOption, $optionLength); - if ($opt_rest !== '' && $i + 1 < $count && $option[0] !== '=' && str_starts_with($longOptions[$i + 1], $option)) { - throw new AmbiguousOptionException('--' . $option); + if ($opt_rest !== '' && + $i + 1 < $count && + $option[0] !== '=' && + /** @phpstan-ignore offsetAccess.notFound */ + str_starts_with($longOptions[$i + 1], $option)) { + $candidates = []; + + foreach ($longOptions as $aLongOption) { + if (str_starts_with($aLongOption, $option)) { + $candidates[] = '--' . rtrim($aLongOption, '='); + } + } + + throw new AmbiguousOptionException('--' . $option, $candidates); } if (str_ends_with($longOption, '=')) { - if (!str_ends_with($longOption, '==') && !strlen((string) $optionArgument)) { + if (!str_ends_with($longOption, '==') && (string) $optionArgument === '') { if (false === $optionArgument = current($argv)) { throw new RequiredOptionArgumentMissingException('--' . $option); } @@ -203,6 +224,27 @@ private function parseLongOption(string $argument, array $longOptions, array &$o return; } - throw new UnknownOptionException('--' . $option); + throw new UnknownOptionException('--' . $option, $this->formatSimilarOptions($similarOptions)); + } + + /** + * @param list $similarOptions + * + * @return array + */ + private function formatSimilarOptions(array $similarOptions): array + { + usort( + $similarOptions, + static fn (array $a, array $b): int => $a[0] <=> $b[0], + ); + + $similarFormatted = []; + + foreach (array_slice($similarOptions, 0, 5) as [$distance, $label]) { + $similarFormatted[] = $label; + } + + return $similarFormatted; } } diff --git a/app/vendor/sebastian/cli-parser/src/exceptions/AmbiguousOptionException.php b/app/vendor/sebastian/cli-parser/src/exceptions/AmbiguousOptionException.php index 99eb625a7..ab2ff4f22 100644 --- a/app/vendor/sebastian/cli-parser/src/exceptions/AmbiguousOptionException.php +++ b/app/vendor/sebastian/cli-parser/src/exceptions/AmbiguousOptionException.php @@ -9,17 +9,22 @@ */ namespace SebastianBergmann\CliParser; +use function implode; use function sprintf; use RuntimeException; final class AmbiguousOptionException extends RuntimeException implements Exception { - public function __construct(string $option) + /** + * @param array $candiates + */ + public function __construct(string $option, array $candiates) { parent::__construct( sprintf( - 'Option "%s" is ambiguous', + 'Option "%s" is ambiguous. Similar options are: %s', $option, + implode(', ', $candiates), ), ); } diff --git a/app/vendor/sebastian/cli-parser/src/exceptions/UnknownOptionException.php b/app/vendor/sebastian/cli-parser/src/exceptions/UnknownOptionException.php index 560c7ad22..3ddeddd1c 100644 --- a/app/vendor/sebastian/cli-parser/src/exceptions/UnknownOptionException.php +++ b/app/vendor/sebastian/cli-parser/src/exceptions/UnknownOptionException.php @@ -9,18 +9,30 @@ */ namespace SebastianBergmann\CliParser; +use function implode; use function sprintf; use RuntimeException; final class UnknownOptionException extends RuntimeException implements Exception { - public function __construct(string $option) + /** + * @param array $similarOptions + */ + public function __construct(string $option, array $similarOptions) { - parent::__construct( - sprintf( - 'Unknown option "%s"', - $option, - ), + $message = sprintf( + 'Unknown option "%s"', + $option, ); + + if ($similarOptions !== []) { + $message = sprintf( + 'Unknown option "%s". Most similar options are %s', + $option, + implode(', ', $similarOptions), + ); + } + + parent::__construct($message); } } diff --git a/app/vendor/sebastian/comparator/ChangeLog.md b/app/vendor/sebastian/comparator/ChangeLog.md index 2e26529af..f07dfe4c0 100644 --- a/app/vendor/sebastian/comparator/ChangeLog.md +++ b/app/vendor/sebastian/comparator/ChangeLog.md @@ -2,6 +2,106 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. +## [8.2.1] - 2026-05-21 + +### Changed + +* [#136](https://github.com/sebastianbergmann/comparator/pull/136): Cleaner diff output for canonicalized list comparisons +* [#160](https://github.com/sebastianbergmann/comparator/pull/160): Use by-value comparison for closures + +### Fixed + +* [#136](https://github.com/sebastianbergmann/comparator/pull/136): Canonicalized array comparison destroys string keys + +## [8.2.0] - 2026-05-20 + +### Added + +* [#126](https://github.com/sebastianbergmann/comparator/issues/126): `DateIntervalComparator` for comparing `DateInterval` objects with a delta tolerance + +### Fixed + +* [#70](https://github.com/sebastianbergmann/comparator/issues/70): Non-ASCII text in XML diffs is rendered as numeric character references, making diffs unreadable +* [#87](https://github.com/sebastianbergmann/comparator/issues/87): `DOMNodeComparator` crashes or returns false positives when `DOMNode::C14N()` fails +* [#107](https://github.com/sebastianbergmann/comparator/issues/107): `DOMNodeComparator` reports XML documents as equal when they differ only in comments +* [#115](https://github.com/sebastianbergmann/comparator/issues/115): `DateTimeComparator` does not track processed pairs, producing misleading diffs in nested structures +* [#158](https://github.com/sebastianbergmann/comparator/issues/158): `ComparisonFailure` cannot be serialized when stack trace contains non-serializable objects + +## [8.1.4] - 2026-05-15 + +### Changed + +* [#138](https://github.com/sebastianbergmann/comparator/issues/138): Use `StrictUnifiedDiffOutputBuilder` instead of `UnifiedDiffOutputBuilder` + +## [8.1.3] - 2026-05-15 + +### Changed + +* Pass configuration options introduced in sebastian/diff 8.3.0 + +## [8.1.2] - 2026-04-14 + +### Fixed + +* [#141](https://github.com/sebastianbergmann/comparator/issues/141): `ArrayComparator` sorts objects by `spl_object_id()`, breaking canonicalized equality for arrays of equal objects + +## [8.1.1] - 2026-04-08 + +### Fixed + +* [#140](https://github.com/sebastianbergmann/comparator/issues/140): `sort()` in `ArrayComparator` produces non-deterministic results for arrays with mixed types + +## [8.1.0] - 2026-04-06 + +### Added + +* [#137](https://github.com/sebastianbergmann/comparator/issues/137): Make diff context lines configurable + +## [8.0.0] - 2026-02-06 + +### Removed + +* Removed support for PHP 8.3 + +## [7.1.8] - 2026-05-21 + +### Changed + +* [#136](https://github.com/sebastianbergmann/comparator/pull/136): Cleaner diff output for canonicalized list comparisons +* [#160](https://github.com/sebastianbergmann/comparator/pull/160): Use by-value comparison for closures + +### Fixed + +* [#136](https://github.com/sebastianbergmann/comparator/pull/136): Canonicalized array comparison destroys string keys + +## [7.1.7] - 2026-05-20 + +### Fixed + +* [#70](https://github.com/sebastianbergmann/comparator/issues/70): Non-ASCII text in XML diffs is rendered as numeric character references, making diffs unreadable +* [#87](https://github.com/sebastianbergmann/comparator/issues/87): `DOMNodeComparator` crashes or returns false positives when `DOMNode::C14N()` fails +* [#107](https://github.com/sebastianbergmann/comparator/issues/107): `DOMNodeComparator` reports XML documents as equal when they differ only in comments +* [#115](https://github.com/sebastianbergmann/comparator/issues/115): `DateTimeComparator` does not track processed pairs, producing misleading diffs in nested structures +* [#158](https://github.com/sebastianbergmann/comparator/issues/158): `ComparisonFailure` cannot be serialized when stack trace contains non-serializable objects + +## [7.1.6] - 2026-04-14 + +### Fixed + +* [#141](https://github.com/sebastianbergmann/comparator/issues/141): `ArrayComparator` sorts objects by `spl_object_id()`, breaking canonicalized equality for arrays of equal objects + +## [7.1.5] - 2026-04-08 + +### Fixed + +* [#140](https://github.com/sebastianbergmann/comparator/issues/140): `sort()` in `ArrayComparator` produces non-deterministic results for arrays with mixed types + +## [7.1.4] - 2026-01-24 + +### Changed + +* [#134](https://github.com/sebastianbergmann/comparator/issues/134): Suppress warning introduced in PHP 8.5 + ## [7.1.3] - 2025-08-20 ### Changed @@ -38,6 +138,12 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Removed support for PHP 8.2 +## [6.3.3] - 2026-01-24 + +### Changed + +* [#134](https://github.com/sebastianbergmann/comparator/issues/134): Suppress warning introduced in PHP 8.5 + ## [6.3.2] - 2025-08-10 ### Changed @@ -98,6 +204,18 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Removed support for PHP 8.1 +## [5.0.5] - 2026-01-24 + +### Changed + +* [#134](https://github.com/sebastianbergmann/comparator/issues/134): Suppress warning introduced in PHP 8.5 + +## [5.0.4] - 2025-09-07 + +### Changed + +* Do not use `SplObjectStorage` methods that will be deprecated in PHP 8.5 + ## [5.0.3] - 2024-10-18 ### Fixed @@ -132,6 +250,18 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Removed `Comparator::$exporter` * Removed support for PHP 7.3, PHP 7.4, and PHP 8.0 +## [4.0.10] - 2026-01-24 + +### Changed + +* [#134](https://github.com/sebastianbergmann/comparator/issues/134): Suppress warning introduced in PHP 8.5 + +## [4.0.9] - 2025-08-10 + +### Changed + +* Do not use `SplObjectStorage` methods that will be deprecated in PHP 8.5 + ## [4.0.8] - 2022-09-14 ### Fixed @@ -186,6 +316,18 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Removed support for PHP 7.1 and PHP 7.2 +## [3.0.7] - 2026-01-24 + +### Changed + +* [#134](https://github.com/sebastianbergmann/comparator/issues/134): Suppress warning introduced in PHP 8.5 + +## [3.0.6] - 2025-08-10 + +### Changed + +* Do not use `SplObjectStorage` methods that will be deprecated in PHP 8.5 + ## [3.0.5] - 2022-09-14 ### Fixed @@ -252,12 +394,26 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Added `SebastianBergmann\Comparator\Factory::reset()` to unregister all non-default comparators * Added support for `phpunit/phpunit-mock-objects` version `^5.0` +[8.2.1]: https://github.com/sebastianbergmann/comparator/compare/8.2.0...8.2.1 +[8.2.0]: https://github.com/sebastianbergmann/comparator/compare/8.1.4...8.2.0 +[8.1.4]: https://github.com/sebastianbergmann/comparator/compare/8.1.3...8.1.4 +[8.1.3]: https://github.com/sebastianbergmann/comparator/compare/8.1.2...8.1.3 +[8.1.2]: https://github.com/sebastianbergmann/comparator/compare/8.1.1...8.1.2 +[8.1.1]: https://github.com/sebastianbergmann/comparator/compare/8.1.0...8.1.1 +[8.1.0]: https://github.com/sebastianbergmann/comparator/compare/8.0.0...8.1.0 +[8.0.0]: https://github.com/sebastianbergmann/comparator/compare/7.1...8.0.0 +[7.1.8]: https://github.com/sebastianbergmann/comparator/compare/7.1.7...7.1.8 +[7.1.7]: https://github.com/sebastianbergmann/comparator/compare/7.1.6...7.1.7 +[7.1.6]: https://github.com/sebastianbergmann/comparator/compare/7.1.5...7.1.6 +[7.1.5]: https://github.com/sebastianbergmann/comparator/compare/7.1.4...7.1.5 +[7.1.4]: https://github.com/sebastianbergmann/comparator/compare/7.1.3...7.1.4 [7.1.3]: https://github.com/sebastianbergmann/comparator/compare/7.1.2...7.1.3 [7.1.2]: https://github.com/sebastianbergmann/comparator/compare/7.1.1...7.1.2 [7.1.1]: https://github.com/sebastianbergmann/comparator/compare/7.1.0...7.1.1 [7.1.0]: https://github.com/sebastianbergmann/comparator/compare/7.0.1...7.1.0 [7.0.1]: https://github.com/sebastianbergmann/comparator/compare/7.0.0...7.0.1 [7.0.0]: https://github.com/sebastianbergmann/comparator/compare/6.3...7.0.0 +[6.3.3]: https://github.com/sebastianbergmann/comparator/compare/6.3.2...6.3.3 [6.3.2]: https://github.com/sebastianbergmann/comparator/compare/6.3.1...6.3.2 [6.3.1]: https://github.com/sebastianbergmann/comparator/compare/6.3.0...6.3.1 [6.3.0]: https://github.com/sebastianbergmann/comparator/compare/6.2.1...6.3.0 @@ -268,6 +424,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt [6.0.2]: https://github.com/sebastianbergmann/comparator/compare/6.0.1...6.0.2 [6.0.1]: https://github.com/sebastianbergmann/comparator/compare/6.0.0...6.0.1 [6.0.0]: https://github.com/sebastianbergmann/comparator/compare/5.0...6.0.0 +[5.0.4]: https://github.com/sebastianbergmann/comparator/compare/5.0.3...5.0.4 [5.0.3]: https://github.com/sebastianbergmann/comparator/compare/5.0.2...5.0.3 [5.0.2]: https://github.com/sebastianbergmann/comparator/compare/5.0.1...5.0.2 [5.0.1]: https://github.com/sebastianbergmann/comparator/compare/5.0.0...5.0.1 diff --git a/app/vendor/sebastian/comparator/LICENSE b/app/vendor/sebastian/comparator/LICENSE index c5268a916..0fad16fc6 100644 --- a/app/vendor/sebastian/comparator/LICENSE +++ b/app/vendor/sebastian/comparator/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2002-2025, Sebastian Bergmann +Copyright (c) 2002-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/comparator/SECURITY.md b/app/vendor/sebastian/comparator/SECURITY.md index d88ff0019..af0c5a4fd 100644 --- a/app/vendor/sebastian/comparator/SECURITY.md +++ b/app/vendor/sebastian/comparator/SECURITY.md @@ -1,30 +1,10 @@ # Security Policy -If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure. +The library that is developed in this repository is a first-party dependency of [PHPUnit](https://github.com/sebastianbergmann/phpunit). +[PHPUnit's Security Policy](https://github.com/sebastianbergmann/phpunit/security/policy) applies to this library as well. -**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** - -Instead, please email `sebastian@phpunit.de`. - -Please include as much of the information listed below as you can to help us better understand and resolve the issue: - -* The type of issue -* Full paths of source file(s) related to the manifestation of the issue -* The location of the affected source code (tag/branch/commit or direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the issue - -This information will help us triage your report more quickly. +If you believe you have found a security vulnerability in this library, please report it to me through coordinated disclosure. -## Web Context - -The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit. - -The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes. - -If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. - -Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. +Use my [PGP key](https://sebastian-bergmann.de/gpg.asc) for encrypted email, for example when your report includes proof-of-concept exploits against third-party systems. +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** diff --git a/app/vendor/sebastian/comparator/composer.json b/app/vendor/sebastian/comparator/composer.json index c673f9bc5..3922635b7 100644 --- a/app/vendor/sebastian/comparator/composer.json +++ b/app/vendor/sebastian/comparator/composer.json @@ -28,9 +28,9 @@ }, "prefer-stable": true, "require": { - "php": ">=8.3", - "sebastian/diff": "^7.0", - "sebastian/exporter": "^7.0", + "php": ">=8.4", + "sebastian/diff": "^8.3", + "sebastian/exporter": "^8.0.3", "ext-dom": "*", "ext-mbstring": "*" }, @@ -38,11 +38,11 @@ "ext-bcmath": "For comparing BcMath\\Number objects" }, "require-dev": { - "phpunit/phpunit": "^12.2" + "phpunit/phpunit": "^13.1.10" }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true @@ -59,7 +59,7 @@ }, "extra": { "branch-alias": { - "dev-main": "7.1-dev" + "dev-main": "8.2-dev" } } } diff --git a/app/vendor/sebastian/comparator/src/ArrayComparator.php b/app/vendor/sebastian/comparator/src/ArrayComparator.php index f1e079097..26a1f54e0 100644 --- a/app/vendor/sebastian/comparator/src/ArrayComparator.php +++ b/app/vendor/sebastian/comparator/src/ArrayComparator.php @@ -9,13 +9,21 @@ */ namespace SebastianBergmann\Comparator; +use function array_is_list; use function array_key_exists; use function assert; use function is_array; -use function sort; +use function is_bool; +use function is_float; +use function is_int; +use function is_object; +use function is_string; +use function ksort; +use function serialize; use function sprintf; use function str_replace; use function trim; +use function usort; use SebastianBergmann\Exporter\Exporter; /** @@ -44,9 +52,18 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, assert(is_array($expected)); assert(is_array($actual)); + $isList = false; + if ($canonicalize) { - sort($expected); - sort($actual); + $isList = array_is_list($expected) && array_is_list($actual); + + if ($isList) { + usort($expected, $this->compare(...)); + usort($actual, $this->compare(...)); + } else { + ksort($expected); + ksort($actual); + } } $remaining = $actual; @@ -59,11 +76,18 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, unset($remaining[$key]); if (!array_key_exists($key, $actual)) { - $expectedAsString .= sprintf( - " %s => %s\n", - $exporter->export($key), - $exporter->shortenedExport($value), - ); + if ($canonicalize && $isList) { + $expectedAsString .= sprintf( + " %s\n", + $exporter->shortenedExport($value), + ); + } else { + $expectedAsString .= sprintf( + " %s => %s\n", + $exporter->export($key), + $exporter->shortenedExport($value), + ); + } $equal = false; @@ -76,40 +100,71 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, /** @phpstan-ignore arguments.count */ $comparator->assertEquals($value, $actual[$key], $delta, $canonicalize, $ignoreCase, $processed); - $expectedAsString .= sprintf( - " %s => %s\n", - $exporter->export($key), - $exporter->shortenedExport($value), - ); + if ($canonicalize && $isList) { + $expectedAsString .= sprintf( + " %s\n", + $exporter->shortenedExport($value), + ); + + $actualAsString .= sprintf( + " %s\n", + $exporter->shortenedExport($actual[$key]), + ); + } else { + $expectedAsString .= sprintf( + " %s => %s\n", + $exporter->export($key), + $exporter->shortenedExport($value), + ); + + $actualAsString .= sprintf( + " %s => %s\n", + $exporter->export($key), + $exporter->shortenedExport($actual[$key]), + ); + } + } catch (ComparisonFailure $e) { + if ($canonicalize && $isList) { + $expectedAsString .= sprintf( + " %s\n", + $e->getExpectedAsString() !== '' ? $this->indent($e->getExpectedAsString()) : $exporter->shortenedExport($e->getExpected()), + ); + + $actualAsString .= sprintf( + " %s\n", + $e->getActualAsString() !== '' ? $this->indent($e->getActualAsString()) : $exporter->shortenedExport($e->getActual()), + ); + } else { + $expectedAsString .= sprintf( + " %s => %s\n", + $exporter->export($key), + $e->getExpectedAsString() !== '' ? $this->indent($e->getExpectedAsString()) : $exporter->shortenedExport($e->getExpected()), + ); + + $actualAsString .= sprintf( + " %s => %s\n", + $exporter->export($key), + $e->getActualAsString() !== '' ? $this->indent($e->getActualAsString()) : $exporter->shortenedExport($e->getActual()), + ); + } + + $equal = false; + } + } + foreach ($remaining as $key => $value) { + if ($canonicalize && $isList) { $actualAsString .= sprintf( - " %s => %s\n", - $exporter->export($key), - $exporter->shortenedExport($actual[$key]), - ); - } catch (ComparisonFailure $e) { - $expectedAsString .= sprintf( - " %s => %s\n", - $exporter->export($key), - $e->getExpectedAsString() !== '' ? $this->indent($e->getExpectedAsString()) : $exporter->shortenedExport($e->getExpected()), + " %s\n", + $exporter->shortenedExport($value), ); - + } else { $actualAsString .= sprintf( " %s => %s\n", $exporter->export($key), - $e->getActualAsString() !== '' ? $this->indent($e->getActualAsString()) : $exporter->shortenedExport($e->getActual()), + $exporter->shortenedExport($value), ); - - $equal = false; } - } - - foreach ($remaining as $key => $value) { - $actualAsString .= sprintf( - " %s => %s\n", - $exporter->export($key), - $exporter->shortenedExport($value), - ); $equal = false; } @@ -124,6 +179,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $expectedAsString, $actualAsString, 'Failed asserting that two arrays are equal.', + $this->contextLines(), ); } } @@ -132,4 +188,65 @@ private function indent(string $lines): string { return trim(str_replace("\n", "\n ", $lines)); } + + private function compare(mixed $a, mixed $b): int + { + $typeOrderA = $this->typeOrder($a); + $typeOrderB = $this->typeOrder($b); + + if ($typeOrderA !== $typeOrderB) { + return $typeOrderA <=> $typeOrderB; + } + + if (is_object($a) && is_object($b)) { + $classComparison = $a::class <=> $b::class; + + if ($classComparison !== 0) { + return $classComparison; + } + + try { + $this->factory()->getComparatorFor($a, $b)->assertEquals($a, $b); + + return 0; + } catch (ComparisonFailure) { + return serialize($a) <=> serialize($b); + } + } + + if (is_array($a) && is_array($b)) { + return serialize($a) <=> serialize($b); + } + + return $a <=> $b; + } + + private function typeOrder(mixed $value): int + { + if ($value === null) { + return 0; + } + + if (is_bool($value)) { + return 1; + } + + if (is_int($value) || is_float($value)) { + return 2; + } + + if (is_string($value)) { + return 3; + } + + if (is_array($value)) { + return 4; + } + + if (is_object($value)) { + return 5; + } + + return 6; + } } diff --git a/app/vendor/sebastian/comparator/src/ClosureComparator.php b/app/vendor/sebastian/comparator/src/ClosureComparator.php index f02bb1de6..dca472b9d 100644 --- a/app/vendor/sebastian/comparator/src/ClosureComparator.php +++ b/app/vendor/sebastian/comparator/src/ClosureComparator.php @@ -32,14 +32,29 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, assert($expected instanceof Closure); assert($actual instanceof Closure); - /** @phpstan-ignore equal.notAllowed */ - if ($expected == $actual) { + if ($expected === $actual) { return; } $expectedReflector = new ReflectionFunction($expected); $actualReflector = new ReflectionFunction($actual); + if ($this->declarationIsEqual($expectedReflector, $actualReflector) && + $this->bindingIsEqual($expectedReflector, $actualReflector) && + $this->capturedStateIsEqual($expectedReflector, $actualReflector)) { + return; + } + + $expectedFilename = $expectedReflector->getFileName(); + $expectedStartLine = $expectedReflector->getStartLine(); + $actualFilename = $actualReflector->getFileName(); + $actualStartLine = $actualReflector->getStartLine(); + + assert($expectedFilename !== false); + assert($expectedStartLine !== false); + assert($actualFilename !== false); + assert($actualStartLine !== false); + throw new ComparisonFailure( $expected, $actual, @@ -47,11 +62,51 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, 'Closure Object #' . spl_object_id($actual) . ' ()', sprintf( 'Failed asserting that closure declared at %s:%d is equal to closure declared at %s:%d.', - $expectedReflector->getFileName(), - $expectedReflector->getStartLine(), - $actualReflector->getFileName(), - $actualReflector->getStartLine(), + $expectedFilename, + $expectedStartLine, + $actualFilename, + $actualStartLine, ), + $this->contextLines(), ); } + + private function declarationIsEqual(ReflectionFunction $expected, ReflectionFunction $actual): bool + { + return $expected->getName() === $actual->getName() && + $expected->getFileName() === $actual->getFileName() && + $expected->getStartLine() === $actual->getStartLine() && + $expected->getEndLine() === $actual->getEndLine(); + } + + private function bindingIsEqual(ReflectionFunction $expected, ReflectionFunction $actual): bool + { + if ($expected->getClosureScopeClass()?->getName() !== $actual->getClosureScopeClass()?->getName()) { + return false; + } + + return $this->recursivelyEqual( + $expected->getClosureThis(), + $actual->getClosureThis(), + ); + } + + private function capturedStateIsEqual(ReflectionFunction $expected, ReflectionFunction $actual): bool + { + return $this->recursivelyEqual( + $expected->getClosureUsedVariables(), + $actual->getClosureUsedVariables(), + ); + } + + private function recursivelyEqual(mixed $expected, mixed $actual): bool + { + try { + $this->factory()->getComparatorFor($expected, $actual)->assertEquals($expected, $actual); + } catch (ComparisonFailure) { + return false; + } + + return true; + } } diff --git a/app/vendor/sebastian/comparator/src/Comparator.php b/app/vendor/sebastian/comparator/src/Comparator.php index 5caa817fb..0308a66e2 100644 --- a/app/vendor/sebastian/comparator/src/Comparator.php +++ b/app/vendor/sebastian/comparator/src/Comparator.php @@ -32,4 +32,16 @@ protected function factory(): Factory { return $this->factory; } + + /** + * @return positive-int + */ + final protected function contextLines(): int + { + if (!isset($this->factory)) { + return 3; + } + + return $this->factory->contextLines(); + } } diff --git a/app/vendor/sebastian/comparator/src/ComparisonFailure.php b/app/vendor/sebastian/comparator/src/ComparisonFailure.php index b8435ebc9..d97d2d7f1 100644 --- a/app/vendor/sebastian/comparator/src/ComparisonFailure.php +++ b/app/vendor/sebastian/comparator/src/ComparisonFailure.php @@ -11,7 +11,7 @@ use RuntimeException; use SebastianBergmann\Diff\Differ; -use SebastianBergmann\Diff\Output\UnifiedDiffOutputBuilder; +use SebastianBergmann\Diff\Output\StrictUnifiedDiffOutputBuilder; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for sebastian/comparator @@ -23,7 +23,13 @@ final class ComparisonFailure extends RuntimeException private string $expectedAsString; private string $actualAsString; - public function __construct(mixed $expected, mixed $actual, string $expectedAsString, string $actualAsString, string $message = '') + /** @var positive-int */ + private int $contextLines; + + /** + * @param positive-int $contextLines + */ + public function __construct(mixed $expected, mixed $actual, string $expectedAsString, string $actualAsString, string $message = '', int $contextLines = 3) { parent::__construct($message); @@ -31,6 +37,35 @@ public function __construct(mixed $expected, mixed $actual, string $expectedAsSt $this->actual = $actual; $this->expectedAsString = $expectedAsString; $this->actualAsString = $actualAsString; + $this->contextLines = $contextLines; + } + + /** + * @return array{expected: mixed, actual: mixed, expectedAsString: string, actualAsString: string, message: string, contextLines: positive-int} + */ + public function __serialize(): array + { + return [ + 'expected' => $this->expected, + 'actual' => $this->actual, + 'expectedAsString' => $this->expectedAsString, + 'actualAsString' => $this->actualAsString, + 'message' => $this->message, + 'contextLines' => $this->contextLines, + ]; + } + + /** + * @param array{expected: mixed, actual: mixed, expectedAsString: string, actualAsString: string, message: string, contextLines: positive-int} $data + */ + public function __unserialize(array $data): void + { + $this->expected = $data['expected']; + $this->actual = $data['actual']; + $this->expectedAsString = $data['expectedAsString']; + $this->actualAsString = $data['actualAsString']; + $this->message = $data['message']; + $this->contextLines = $data['contextLines']; } public function getActual(): mixed @@ -59,7 +94,17 @@ public function getDiff(): string return ''; } - $differ = new Differ(new UnifiedDiffOutputBuilder("\n--- Expected\n+++ Actual\n")); + $differ = new Differ( + new StrictUnifiedDiffOutputBuilder( + [ + 'header' => "\n--- Expected\n+++ Actual\n", + 'addLineNumbers' => false, + 'contextLines' => $this->contextLines, + 'emitDiffLineEndWarning' => true, + 'emitNoLineEndEofWarning' => false, + ], + ), + ); return $differ->diff($this->expectedAsString, $this->actualAsString); } diff --git a/app/vendor/sebastian/comparator/src/DOMNodeComparator.php b/app/vendor/sebastian/comparator/src/DOMNodeComparator.php index 2964e94db..6bdf0f1a4 100644 --- a/app/vendor/sebastian/comparator/src/DOMNodeComparator.php +++ b/app/vendor/sebastian/comparator/src/DOMNodeComparator.php @@ -50,6 +50,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $expectedAsString, $actualAsString, sprintf("Failed asserting that two DOM %s are equal.\n", $type), + $this->contextLines(), ); } } @@ -62,25 +63,30 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, */ private function nodeToText(DOMNode $node, bool $ignoreCase): string { - $document = new DOMDocument; + $c14n = @$node->C14N(false, true); - try { - $c14n = $node->C14N(); + if ($c14n === false || $c14n === '') { + $text = $this->serialize($node); + } else { + $document = new DOMDocument; - assert($c14n !== false && $c14n !== ''); + try { + @$document->loadXML($c14n); + // @codeCoverageIgnoreStart + } catch (ValueError) { + // @codeCoverageIgnoreEnd + } - @$document->loadXML($c14n); - // @codeCoverageIgnoreStart - } catch (ValueError) { - // @codeCoverageIgnoreEnd - } + $document->encoding = 'UTF-8'; + $document->formatOutput = true; + $document->normalizeDocument(); - $document->formatOutput = true; - $document->normalizeDocument(); + $saved = $document->saveXML(); - $text = $document->saveXML(); + assert($saved !== false); - assert($text !== false); + $text = $saved; + } if ($ignoreCase) { return mb_strtolower($text, 'UTF-8'); @@ -88,4 +94,25 @@ private function nodeToText(DOMNode $node, bool $ignoreCase): string return $text; } + + /** + * Serializes a node without canonicalization. + * Used as a fallback when DOMNode::C14N() fails. + */ + private function serialize(DOMNode $node): string + { + if ($node instanceof DOMDocument) { + $document = $node; + $target = null; + } else { + $document = $node->ownerDocument; + $target = $node; + } + + assert($document !== null); + + $text = $document->saveXML($target); + + return $text !== false ? $text : ''; + } } diff --git a/app/vendor/sebastian/comparator/src/DateIntervalComparator.php b/app/vendor/sebastian/comparator/src/DateIntervalComparator.php new file mode 100644 index 000000000..2cad8905b --- /dev/null +++ b/app/vendor/sebastian/comparator/src/DateIntervalComparator.php @@ -0,0 +1,77 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\Comparator; + +use function abs; +use function assert; +use function in_array; +use DateInterval; +use DateTimeImmutable; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for sebastian/comparator + * + * @internal This class is not covered by the backward compatibility promise for sebastian/comparator + */ +final class DateIntervalComparator extends ObjectComparator +{ + public function accepts(mixed $expected, mixed $actual): bool + { + return $expected instanceof DateInterval && $actual instanceof DateInterval; + } + + /** + * @param array $processed + * + * @throws ComparisonFailure + */ + public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, bool $canonicalize = false, bool $ignoreCase = false, array &$processed = []): void + { + assert($expected instanceof DateInterval); + assert($actual instanceof DateInterval); + + if (in_array([$actual, $expected], $processed, true) || + in_array([$expected, $actual], $processed, true)) { + return; + } + + $processed[] = [$actual, $expected]; + + if (abs($this->toSeconds($expected) - $this->toSeconds($actual)) > abs($delta)) { + throw new ComparisonFailure( + $expected, + $actual, + $this->format($expected), + $this->format($actual), + 'Failed asserting that two DateInterval objects are equal.', + $this->contextLines(), + ); + } + } + + /** + * Converts a DateInterval to a duration in seconds by applying it to the + * Unix epoch. Month and year components are therefore evaluated against a + * fixed anchor (a month is not always 30 days, a year not always 365), so + * two intervals whose calendar components differ may still be considered + * equal within a delta when the resulting durations match. + */ + private function toSeconds(DateInterval $interval): float + { + $applied = new DateTimeImmutable('@0')->add($interval); + + return (float) $applied->format('U') + ((float) $applied->format('u')) / 1_000_000; + } + + private function format(DateInterval $interval): string + { + return $interval->format('%RP%yY%mM%dDT%hH%iM%sS.%fF'); + } +} diff --git a/app/vendor/sebastian/comparator/src/DateTimeComparator.php b/app/vendor/sebastian/comparator/src/DateTimeComparator.php index 3b4da4c4d..8447e5496 100644 --- a/app/vendor/sebastian/comparator/src/DateTimeComparator.php +++ b/app/vendor/sebastian/comparator/src/DateTimeComparator.php @@ -12,6 +12,7 @@ use function abs; use function assert; use function floor; +use function in_array; use function sprintf; use DateInterval; use DateTime; @@ -41,7 +42,16 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, assert($expected instanceof DateTime || $expected instanceof DateTimeImmutable); assert($actual instanceof DateTime || $actual instanceof DateTimeImmutable); + if (in_array([$actual, $expected], $processed, true) || + in_array([$expected, $actual], $processed, true)) { + return; + } + + $processed[] = [$actual, $expected]; + $absDelta = abs($delta); + + /** @phpstan-ignore argument.type */ $delta = new DateInterval(sprintf('PT%dS', $absDelta)); $delta->f = $absDelta - floor($absDelta); @@ -63,6 +73,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $expected->format('Y-m-d\TH:i:s.uO'), $actual->format('Y-m-d\TH:i:s.uO'), 'Failed asserting that two DateTime objects are equal.', + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/EnumerationComparator.php b/app/vendor/sebastian/comparator/src/EnumerationComparator.php index 7341edf6c..47492cf24 100644 --- a/app/vendor/sebastian/comparator/src/EnumerationComparator.php +++ b/app/vendor/sebastian/comparator/src/EnumerationComparator.php @@ -50,6 +50,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $actual->name, $expected->name, ), + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/Factory.php b/app/vendor/sebastian/comparator/src/Factory.php index 7f330d627..cd83ac75a 100644 --- a/app/vendor/sebastian/comparator/src/Factory.php +++ b/app/vendor/sebastian/comparator/src/Factory.php @@ -31,6 +31,9 @@ final class Factory */ private array $defaultComparators = []; + /** @var positive-int */ + private int $contextLines = 3; + public static function getInstance(): self { if (self::$instance === null) { @@ -45,6 +48,22 @@ public function __construct() $this->registerDefaultComparators(); } + /** + * @return positive-int + */ + public function contextLines(): int + { + return $this->contextLines; + } + + /** + * @param positive-int $contextLines + */ + public function setContextLines(int $contextLines): void + { + $this->contextLines = $contextLines; + } + public function getComparatorFor(mixed $expected, mixed $actual): Comparator { foreach ($this->customComparators as $comparator) { @@ -103,6 +122,7 @@ private function registerDefaultComparators(): void $this->registerDefaultComparator(new ClosureComparator); $this->registerDefaultComparator(new MockObjectComparator); $this->registerDefaultComparator(new DateTimeComparator); + $this->registerDefaultComparator(new DateIntervalComparator); $this->registerDefaultComparator(new DOMNodeComparator); $this->registerDefaultComparator(new SplObjectStorageComparator); $this->registerDefaultComparator(new ExceptionComparator); diff --git a/app/vendor/sebastian/comparator/src/NumberComparator.php b/app/vendor/sebastian/comparator/src/NumberComparator.php index 8c606a757..91cf84c2c 100644 --- a/app/vendor/sebastian/comparator/src/NumberComparator.php +++ b/app/vendor/sebastian/comparator/src/NumberComparator.php @@ -39,17 +39,18 @@ public function accepts(mixed $expected, mixed $actual): bool public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, bool $canonicalize = false, bool $ignoreCase = false, array &$processed = []): void { if (!$expected instanceof Number) { - assert(is_string($expected) || is_int($expected)); + assert(is_int($expected) || is_string($expected) && is_numeric($expected)); $expected = new Number($expected); } if (!$actual instanceof Number) { - assert(is_string($actual) || is_int($actual)); + assert(is_int($actual) || is_string($actual) && is_numeric($actual)); $actual = new Number($actual); } + /** @phpstan-ignore argument.type */ $deltaNumber = new Number(number_format($delta, max($expected->scale, $actual->scale))); if ($actual < $expected - $deltaNumber || $actual > $expected + $deltaNumber) { @@ -59,6 +60,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, (string) $expected, (string) $actual, 'Failed asserting that two Number objects are equal.', + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/NumericComparator.php b/app/vendor/sebastian/comparator/src/NumericComparator.php index 77a04a3f7..216cff097 100644 --- a/app/vendor/sebastian/comparator/src/NumericComparator.php +++ b/app/vendor/sebastian/comparator/src/NumericComparator.php @@ -66,6 +66,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $exporter->export($actual), $exporter->export($expected), ), + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/ObjectComparator.php b/app/vendor/sebastian/comparator/src/ObjectComparator.php index da9a76cac..add76c3f6 100644 --- a/app/vendor/sebastian/comparator/src/ObjectComparator.php +++ b/app/vendor/sebastian/comparator/src/ObjectComparator.php @@ -51,6 +51,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $exporter->export($actual), $expected::class, ), + $this->contextLines(), ); } @@ -83,6 +84,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, substr_replace($e->getExpectedAsString(), $expected::class . ' Object', 0, 5), substr_replace($e->getActualAsString(), $actual::class . ' Object', 0, 5), 'Failed asserting that two objects are equal.', + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/ResourceComparator.php b/app/vendor/sebastian/comparator/src/ResourceComparator.php index 8691e7e19..f6d7edf9d 100644 --- a/app/vendor/sebastian/comparator/src/ResourceComparator.php +++ b/app/vendor/sebastian/comparator/src/ResourceComparator.php @@ -42,6 +42,8 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $actual, $exporter->export($expected), $exporter->export($actual), + '', + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/ScalarComparator.php b/app/vendor/sebastian/comparator/src/ScalarComparator.php index f28d10220..32a0c1114 100644 --- a/app/vendor/sebastian/comparator/src/ScalarComparator.php +++ b/app/vendor/sebastian/comparator/src/ScalarComparator.php @@ -53,10 +53,10 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, // otherwise 0 == 'Foobar' if ((is_string($expected) && !is_bool($actual)) || (is_string($actual) && !is_bool($expected))) { /** @phpstan-ignore cast.string */ - $expectedToCompare = (string) $expectedToCompare; + $expectedToCompare = @(string) $expectedToCompare; /** @phpstan-ignore cast.string */ - $actualToCompare = (string) $actualToCompare; + $actualToCompare = @(string) $actualToCompare; if ($ignoreCase) { $expectedToCompare = mb_strtolower($expectedToCompare, 'UTF-8'); @@ -74,6 +74,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $exporter->export($cutExpected), $exporter->export($cutActual), 'Failed asserting that two strings are equal.', + $this->contextLines(), ); } @@ -90,6 +91,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $exporter->export($actual), $exporter->export($expected), ), + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/SplObjectStorageComparator.php b/app/vendor/sebastian/comparator/src/SplObjectStorageComparator.php index a32b588be..825695b0a 100644 --- a/app/vendor/sebastian/comparator/src/SplObjectStorageComparator.php +++ b/app/vendor/sebastian/comparator/src/SplObjectStorageComparator.php @@ -43,6 +43,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $exporter->export($expected), $exporter->export($actual), 'Failed asserting that two objects are equal.', + $this->contextLines(), ); } } @@ -55,6 +56,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, $exporter->export($expected), $exporter->export($actual), 'Failed asserting that two objects are equal.', + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/comparator/src/TypeComparator.php b/app/vendor/sebastian/comparator/src/TypeComparator.php index c54468b8e..8dab5fbdf 100644 --- a/app/vendor/sebastian/comparator/src/TypeComparator.php +++ b/app/vendor/sebastian/comparator/src/TypeComparator.php @@ -42,6 +42,7 @@ public function assertEquals(mixed $expected, mixed $actual, float $delta = 0.0, (new Exporter)->shortenedExport($actual), gettype($expected), ), + $this->contextLines(), ); } } diff --git a/app/vendor/sebastian/complexity/ChangeLog.md b/app/vendor/sebastian/complexity/ChangeLog.md index 6d06b2cb3..d94db9236 100644 --- a/app/vendor/sebastian/complexity/ChangeLog.md +++ b/app/vendor/sebastian/complexity/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. +## [6.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [5.0.0] - 2025-02-07 ### Removed @@ -78,6 +84,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Initial release +[6.0.0]: https://github.com/sebastianbergmann/complexity/compare/5.0...6.0.0 [5.0.0]: https://github.com/sebastianbergmann/complexity/compare/4.0...5.0.0 [4.0.1]: https://github.com/sebastianbergmann/complexity/compare/4.0.0...4.0.1 [4.0.0]: https://github.com/sebastianbergmann/complexity/compare/3.2...4.0.0 diff --git a/app/vendor/sebastian/complexity/LICENSE b/app/vendor/sebastian/complexity/LICENSE index 0d534da34..a48fe5da4 100644 --- a/app/vendor/sebastian/complexity/LICENSE +++ b/app/vendor/sebastian/complexity/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2020-2025, Sebastian Bergmann +Copyright (c) 2020-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/complexity/composer.json b/app/vendor/sebastian/complexity/composer.json index 994a5a3de..dfda08ff8 100644 --- a/app/vendor/sebastian/complexity/composer.json +++ b/app/vendor/sebastian/complexity/composer.json @@ -17,15 +17,15 @@ }, "prefer-stable": true, "require": { - "php": ">=8.3", + "php": ">=8.4", "nikic/php-parser": "^5.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true @@ -37,7 +37,7 @@ }, "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "6.0-dev" } } } diff --git a/app/vendor/sebastian/complexity/src/Complexity/ComplexityCollection.php b/app/vendor/sebastian/complexity/src/Complexity/ComplexityCollection.php index 90fc4d085..e328d1882 100644 --- a/app/vendor/sebastian/complexity/src/Complexity/ComplexityCollection.php +++ b/app/vendor/sebastian/complexity/src/Complexity/ComplexityCollection.php @@ -66,7 +66,7 @@ public function count(): int public function isEmpty(): bool { - return empty($this->items); + return $this->items === []; } /** diff --git a/app/vendor/sebastian/diff/ChangeLog.md b/app/vendor/sebastian/diff/ChangeLog.md index 4d3379ba3..b218cd904 100644 --- a/app/vendor/sebastian/diff/ChangeLog.md +++ b/app/vendor/sebastian/diff/ChangeLog.md @@ -2,12 +2,52 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. -## [7.0.0] - 2025-02-07 +## [8.3.0] - 2026-05-15 + +### Added + +* [#136](https://github.com/sebastianbergmann/diff/issues/136): `UnifiedDiffOutputBuilder` now accepts a fourth `$emitNoLineEndEofWarning` constructor parameter (default `true`) to suppress the `\ No newline at end of file` marker for use cases such as PHPUnit comparison failures that are not related to files +* [#136](https://github.com/sebastianbergmann/diff/issues/136): `StrictUnifiedDiffOutputBuilder` now accepts the options `addLineNumbers`, `emitDiffLineEndWarning`, `emitNoLineEndEofWarning`, and `header` + +### Changed + +* [#136](https://github.com/sebastianbergmann/diff/issues/136): `UnifiedDiffOutputBuilder` now returns an empty string when no difference is detected (previously: returned the header) +* [#136](https://github.com/sebastianbergmann/diff/issues/136): `UnifiedDiffOutputBuilder::writeHunk()` now writes the actual `\ No newline at end of file` marker text (previously: wrote only a line break) and silently skips diff entries with unknown types + +### Deprecated + +* The `SebastianBergmann\Diff\LongestCommonSubsequenceCalculator` interface, its two implementations `SebastianBergmann\Diff\TimeEfficientLongestCommonSubsequenceCalculator` and `SebastianBergmann\Diff\MemoryEfficientLongestCommonSubsequenceCalculator`, and the `$lcs` parameter of `SebastianBergmann\Diff\Differ::diff()` and `SebastianBergmann\Diff\Differ::diffToArray()` are now deprecated; do not pass the `$lcs` parameter any more in preparation for the removal of these symbols and this parameter, respectively + +## [8.2.1] - 2026-05-14 + +### Changed + +* [#136](https://github.com/sebastianbergmann/diff/issues/136): Reverted changes introduced in version 8.2.0 + +## [8.2.0] - 2026-05-14 + +### Changed + +* [#136](https://github.com/sebastianbergmann/diff/issues/136): Align `UnifiedDiffOutputBuilder` behavior with `StrictUnifiedDiffOutputBuilder` + +## [8.1.0] - 2026-04-05 + +### Added + +* [#135](https://github.com/sebastianbergmann/diff/issues/135): Add `$contextLines` constructor parameter on `UnifiedDiffOutputBuilder` + +## [8.0.0] - 2026-02-06 ### Removed * This component is no longer supported on PHP 8.3 +## [7.0.0] - 2025-02-07 + +### Removed + +* This component is no longer supported on PHP 8.2 + ## [6.0.2] - 2024-07-03 ### Changed @@ -157,7 +197,12 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * This component is no longer supported on PHP 5.6 -[7.0.0]: https://github.com/sebastianbergmann/diff/compare/6.0...7.0.0 +[8.3.0]: https://github.com/sebastianbergmann/diff/compare/8.2.1...8.3.0 +[8.2.1]: https://github.com/sebastianbergmann/diff/compare/8.2.0...8.2.1 +[8.2.0]: https://github.com/sebastianbergmann/diff/compare/8.1.0...8.2.0 +[8.1.0]: https://github.com/sebastianbergmann/diff/compare/8.0.0...8.1.0 +[8.0.0]: https://github.com/sebastianbergmann/diff/compare/7.0...8.0.0 +[7.0.0]: https://github.com/sebastianbergmann/diff/compare/6.0.2...7.0.0 [6.0.2]: https://github.com/sebastianbergmann/diff/compare/6.0.1...6.0.2 [6.0.1]: https://github.com/sebastianbergmann/diff/compare/6.0.0...6.0.1 [6.0.0]: https://github.com/sebastianbergmann/diff/compare/5.1...6.0.0 diff --git a/app/vendor/sebastian/diff/LICENSE b/app/vendor/sebastian/diff/LICENSE index c5268a916..0fad16fc6 100644 --- a/app/vendor/sebastian/diff/LICENSE +++ b/app/vendor/sebastian/diff/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2002-2025, Sebastian Bergmann +Copyright (c) 2002-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/diff/SECURITY.md b/app/vendor/sebastian/diff/SECURITY.md index d88ff0019..af0c5a4fd 100644 --- a/app/vendor/sebastian/diff/SECURITY.md +++ b/app/vendor/sebastian/diff/SECURITY.md @@ -1,30 +1,10 @@ # Security Policy -If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure. +The library that is developed in this repository is a first-party dependency of [PHPUnit](https://github.com/sebastianbergmann/phpunit). +[PHPUnit's Security Policy](https://github.com/sebastianbergmann/phpunit/security/policy) applies to this library as well. -**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** - -Instead, please email `sebastian@phpunit.de`. - -Please include as much of the information listed below as you can to help us better understand and resolve the issue: - -* The type of issue -* Full paths of source file(s) related to the manifestation of the issue -* The location of the affected source code (tag/branch/commit or direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the issue - -This information will help us triage your report more quickly. +If you believe you have found a security vulnerability in this library, please report it to me through coordinated disclosure. -## Web Context - -The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit. - -The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes. - -If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. - -Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. +Use my [PGP key](https://sebastian-bergmann.de/gpg.asc) for encrypted email, for example when your report includes proof-of-concept exploits against third-party systems. +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** diff --git a/app/vendor/sebastian/diff/composer.json b/app/vendor/sebastian/diff/composer.json index 124d8ed6f..744502da4 100644 --- a/app/vendor/sebastian/diff/composer.json +++ b/app/vendor/sebastian/diff/composer.json @@ -21,16 +21,16 @@ "prefer-stable": true, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0", + "phpunit/phpunit": "^13.0", "symfony/process": "^7.2" }, "autoload": { @@ -45,7 +45,7 @@ }, "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.3-dev" } } } diff --git a/app/vendor/sebastian/diff/src/Differ.php b/app/vendor/sebastian/diff/src/Differ.php index 44a4b4455..f9d25a003 100644 --- a/app/vendor/sebastian/diff/src/Differ.php +++ b/app/vendor/sebastian/diff/src/Differ.php @@ -12,6 +12,7 @@ use const PHP_INT_SIZE; use const PREG_SPLIT_DELIM_CAPTURE; use const PREG_SPLIT_NO_EMPTY; +use function array_any; use function array_shift; use function array_unshift; use function array_values; @@ -167,22 +168,14 @@ private function detectUnmatchedLineEndings(array $diff): bool } // two-way compare - foreach ($newLineBreaks as $break => $set) { - if (!isset($oldLineBreaks[$break])) { - return true; - } - } - - foreach ($oldLineBreaks as $break => $set) { - if (!isset($newLineBreaks[$break])) { - return true; - } + if (array_any($newLineBreaks, static fn (bool $set, string $break) => !isset($oldLineBreaks[$break]))) { + return true; } - return false; + return array_any($oldLineBreaks, static fn (bool $set, string $break) => !isset($newLineBreaks[$break])); } - private function getLinebreak($line): string + private function getLinebreak(int|string $line): string { if (!is_string($line)) { return ''; diff --git a/app/vendor/sebastian/diff/src/Exception/ConfigurationException.php b/app/vendor/sebastian/diff/src/Exception/ConfigurationException.php index 4bd25d896..33891c1cd 100644 --- a/app/vendor/sebastian/diff/src/Exception/ConfigurationException.php +++ b/app/vendor/sebastian/diff/src/Exception/ConfigurationException.php @@ -12,11 +12,11 @@ use function gettype; use function is_object; use function sprintf; -use Exception; +use InvalidArgumentException; -final class ConfigurationException extends InvalidArgumentException +final class ConfigurationException extends InvalidArgumentException implements Exception { - public function __construct(string $option, string $expected, mixed $value, int $code = 0, ?Exception $previous = null) + public function __construct(string $option, string $expected, mixed $value, int $code = 0, ?\Exception $previous = null) { parent::__construct( sprintf( diff --git a/app/vendor/sebastian/diff/src/Exception/InvalidArgumentException.php b/app/vendor/sebastian/diff/src/Exception/InvalidArgumentException.php deleted file mode 100644 index 846ac3fbd..000000000 --- a/app/vendor/sebastian/diff/src/Exception/InvalidArgumentException.php +++ /dev/null @@ -1,14 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ -namespace SebastianBergmann\Diff; - -class InvalidArgumentException extends \InvalidArgumentException implements Exception -{ -} diff --git a/app/vendor/sebastian/diff/src/LongestCommonSubsequenceCalculator.php b/app/vendor/sebastian/diff/src/LongestCommonSubsequenceCalculator.php index dea8fe1cb..ef005d260 100644 --- a/app/vendor/sebastian/diff/src/LongestCommonSubsequenceCalculator.php +++ b/app/vendor/sebastian/diff/src/LongestCommonSubsequenceCalculator.php @@ -9,6 +9,9 @@ */ namespace SebastianBergmann\Diff; +/** + * @deprecated https://github.com/sebastianbergmann/diff/pull/138 + */ interface LongestCommonSubsequenceCalculator { /** diff --git a/app/vendor/sebastian/diff/src/MemoryEfficientLongestCommonSubsequenceCalculator.php b/app/vendor/sebastian/diff/src/MemoryEfficientLongestCommonSubsequenceCalculator.php index c9489230c..a70d4ab0c 100644 --- a/app/vendor/sebastian/diff/src/MemoryEfficientLongestCommonSubsequenceCalculator.php +++ b/app/vendor/sebastian/diff/src/MemoryEfficientLongestCommonSubsequenceCalculator.php @@ -16,6 +16,9 @@ use function count; use function in_array; +/** + * @deprecated https://github.com/sebastianbergmann/diff/pull/138 + */ final class MemoryEfficientLongestCommonSubsequenceCalculator implements LongestCommonSubsequenceCalculator { /** diff --git a/app/vendor/sebastian/diff/src/Output/StrictUnifiedDiffOutputBuilder.php b/app/vendor/sebastian/diff/src/Output/StrictUnifiedDiffOutputBuilder.php index 5c496186c..cf7047d85 100644 --- a/app/vendor/sebastian/diff/src/Output/StrictUnifiedDiffOutputBuilder.php +++ b/app/vendor/sebastian/diff/src/Output/StrictUnifiedDiffOutputBuilder.php @@ -23,6 +23,7 @@ use function max; use function min; use function sprintf; +use function str_ends_with; use function stream_get_contents; use function substr; use SebastianBergmann\Diff\ConfigurationException; @@ -36,14 +37,19 @@ final class StrictUnifiedDiffOutputBuilder implements DiffOutputBuilderInterface { private static array $default = [ - 'collapseRanges' => true, // ranges of length one are rendered with the trailing `,1` - 'commonLineThreshold' => 6, // number of same lines before ending a new hunk and creating a new one (if needed) - 'contextLines' => 3, // like `diff: -u, -U NUM, --unified[=NUM]`, for patch/git apply compatibility best to keep at least @ 3 - 'fromFile' => null, - 'fromFileDate' => null, - 'toFile' => null, - 'toFileDate' => null, + 'addLineNumbers' => true, // when false, hunk header is rendered as `@@ @@` (no line numbers); when true, as `@@ -from,range +to,range @@` + 'collapseRanges' => true, // ranges of length one are rendered with the trailing `,1` + 'commonLineThreshold' => 6, // number of same lines before ending a new hunk and creating a new one (if needed) + 'contextLines' => 3, // like `diff: -u, -U NUM, --unified[=NUM]`, for patch/git apply compatibility best to keep at least @ 3 + 'emitDiffLineEndWarning' => false, // when true, the `#Warning: Strings contain different line endings!` line inserted by `Differ` is rendered (it is not part of strict unified diff format) + 'emitNoLineEndEofWarning' => true, // when false, the `\ No newline at end of file` marker is suppressed (useful for comparisons not related to files) + 'fromFile' => null, + 'fromFileDate' => null, + 'header' => null, // when provided, used verbatim as the header; otherwise built from `fromFile`/`fromFileDate`/`toFile`/`toFileDate` + 'toFile' => null, + 'toFileDate' => null, ]; + private bool $addLineNumbers; private bool $changed; private bool $collapseRanges; @@ -51,6 +57,8 @@ final class StrictUnifiedDiffOutputBuilder implements DiffOutputBuilderInterface * @var positive-int */ private int $commonLineThreshold; + private bool $emitDiffLineEndWarning; + private bool $emitNoLineEndEofWarning; private string $header; /** @@ -62,6 +70,10 @@ public function __construct(array $options = []) { $options = array_merge(self::$default, $options); + if (!is_bool($options['addLineNumbers'])) { + throw new ConfigurationException('addLineNumbers', 'a bool', $options['addLineNumbers']); + } + if (!is_bool($options['collapseRanges'])) { throw new ConfigurationException('collapseRanges', 'a bool', $options['collapseRanges']); } @@ -74,22 +86,39 @@ public function __construct(array $options = []) throw new ConfigurationException('commonLineThreshold', 'an int > 0', $options['commonLineThreshold']); } - $this->assertString($options, 'fromFile'); - $this->assertString($options, 'toFile'); - $this->assertStringOrNull($options, 'fromFileDate'); - $this->assertStringOrNull($options, 'toFileDate'); - - $this->header = sprintf( - "--- %s%s\n+++ %s%s\n", - $options['fromFile'], - null === $options['fromFileDate'] ? '' : "\t" . $options['fromFileDate'], - $options['toFile'], - null === $options['toFileDate'] ? '' : "\t" . $options['toFileDate'], - ); + if (!is_bool($options['emitDiffLineEndWarning'])) { + throw new ConfigurationException('emitDiffLineEndWarning', 'a bool', $options['emitDiffLineEndWarning']); + } + + if (!is_bool($options['emitNoLineEndEofWarning'])) { + throw new ConfigurationException('emitNoLineEndEofWarning', 'a bool', $options['emitNoLineEndEofWarning']); + } - $this->collapseRanges = $options['collapseRanges']; - $this->commonLineThreshold = $options['commonLineThreshold']; - $this->contextLines = $options['contextLines']; + if (null !== $options['header']) { + $this->assertString($options, 'header'); + + $this->header = $options['header']; + } else { + $this->assertString($options, 'fromFile'); + $this->assertString($options, 'toFile'); + $this->assertStringOrNull($options, 'fromFileDate'); + $this->assertStringOrNull($options, 'toFileDate'); + + $this->header = sprintf( + "--- %s%s\n+++ %s%s\n", + $options['fromFile'], + null === $options['fromFileDate'] ? '' : "\t" . $options['fromFileDate'], + $options['toFile'], + null === $options['toFileDate'] ? '' : "\t" . $options['toFileDate'], + ); + } + + $this->addLineNumbers = $options['addLineNumbers']; + $this->collapseRanges = $options['collapseRanges']; + $this->commonLineThreshold = $options['commonLineThreshold']; + $this->contextLines = $options['contextLines']; + $this->emitDiffLineEndWarning = $options['emitDiffLineEndWarning']; + $this->emitNoLineEndEofWarning = $options['emitNoLineEndEofWarning']; } public function getDiff(array $diff): string @@ -104,7 +133,13 @@ public function getDiff(array $diff): string assert(is_resource($buffer)); - fwrite($buffer, $this->header); + if ('' !== $this->header) { + fwrite($buffer, $this->header); + + if (!str_ends_with($this->header, "\n")) { + fwrite($buffer, "\n"); + } + } $this->writeDiffHunks($buffer, $diff); @@ -127,8 +162,10 @@ public function getDiff(array $diff): string : $diff; } - private function writeDiffHunks($output, array $diff): void + private function writeDiffHunks(mixed $output, array $diff): void { + assert(is_resource($output)); + // detect "No newline at end of file" and insert into `$diff` if needed $upperLimit = count($diff); @@ -153,7 +190,7 @@ private function writeDiffHunks($output, array $diff): void array_splice($diff, $i + 1, 0, [["\n\\ No newline at end of file\n", Differ::NO_LINE_END_EOF_WARNING]]); } - if (!count($toFind)) { + if ($toFind === []) { break; } } @@ -166,9 +203,7 @@ private function writeDiffHunks($output, array $diff): void $hunkCapture = false; $sameCount = $toRange = $fromRange = 0; $toStart = $fromStart = 1; - $i = 0; - /** @var int $i */ foreach ($diff as $i => $entry) { if (0 === $entry[1]) { // same if (false === $hunkCapture) { @@ -258,6 +293,8 @@ private function writeDiffHunks($output, array $diff): void $fromRange -= $sameCount; $toRange -= $sameCount; + assert(isset($i) && is_int($i)); + $this->writeHunk( $diff, $hunkCapture - $contextStartOffset, @@ -278,21 +315,27 @@ private function writeHunk( int $fromRange, int $toStart, int $toRange, - $output + mixed $output ): void { - fwrite($output, '@@ -' . $fromStart); + assert(is_resource($output)); - if (!$this->collapseRanges || 1 !== $fromRange) { - fwrite($output, ',' . $fromRange); - } + if ($this->addLineNumbers) { + fwrite($output, '@@ -' . $fromStart); - fwrite($output, ' +' . $toStart); + if (!$this->collapseRanges || 1 !== $fromRange) { + fwrite($output, ',' . $fromRange); + } - if (!$this->collapseRanges || 1 !== $toRange) { - fwrite($output, ',' . $toRange); - } + fwrite($output, ' +' . $toStart); - fwrite($output, " @@\n"); + if (!$this->collapseRanges || 1 !== $toRange) { + fwrite($output, ',' . $toRange); + } + + fwrite($output, " @@\n"); + } else { + fwrite($output, "@@ @@\n"); + } for ($i = $diffStartIndex; $i < $diffEndIndex; $i++) { if ($diff[$i][1] === Differ::ADDED) { @@ -304,14 +347,11 @@ private function writeHunk( } elseif ($diff[$i][1] === Differ::OLD) { fwrite($output, ' ' . $diff[$i][0]); } elseif ($diff[$i][1] === Differ::NO_LINE_END_EOF_WARNING) { - $this->changed = true; - fwrite($output, $diff[$i][0]); + fwrite($output, $this->emitNoLineEndEofWarning ? $diff[$i][0] : "\n"); + } elseif ($this->emitDiffLineEndWarning && $diff[$i][1] === Differ::DIFF_LINE_END_WARNING) { + fwrite($output, ' ' . $diff[$i][0]); } - // } elseif ($diff[$i][1] === Differ::DIFF_LINE_END_WARNING) { // custom comment inserted by PHPUnit/diff package - // skip - // } else { - // unknown/invalid - // } + // else: unknown/invalid type or skipped warning - silently skip } } diff --git a/app/vendor/sebastian/diff/src/Output/UnifiedDiffOutputBuilder.php b/app/vendor/sebastian/diff/src/Output/UnifiedDiffOutputBuilder.php index d07ace6f0..be6a60498 100644 --- a/app/vendor/sebastian/diff/src/Output/UnifiedDiffOutputBuilder.php +++ b/app/vendor/sebastian/diff/src/Output/UnifiedDiffOutputBuilder.php @@ -15,6 +15,7 @@ use function fclose; use function fopen; use function fwrite; +use function is_int; use function is_resource; use function max; use function min; @@ -28,24 +29,38 @@ */ final class UnifiedDiffOutputBuilder extends AbstractChunkOutputBuilder { + /** @phpstan-ignore property.tooWideBool */ private bool $collapseRanges = true; private int $commonLineThreshold = 6; /** * @var positive-int */ - private int $contextLines = 3; + private int $contextLines; private string $header; private bool $addLineNumbers; + private bool $emitNoLineEndEofWarning; + private bool $changed; - public function __construct(string $header = "--- Original\n+++ New\n", bool $addLineNumbers = false) + /** + * @param positive-int $contextLines + */ + public function __construct(string $header = "--- Original\n+++ New\n", bool $addLineNumbers = false, int $contextLines = 3, bool $emitNoLineEndEofWarning = true) { - $this->header = $header; - $this->addLineNumbers = $addLineNumbers; + $this->header = $header; + $this->addLineNumbers = $addLineNumbers; + $this->contextLines = $contextLines; + $this->emitNoLineEndEofWarning = $emitNoLineEndEofWarning; } public function getDiff(array $diff): string { + if (0 === count($diff)) { + return ''; + } + + $this->changed = false; + $buffer = fopen('php://memory', 'r+b'); assert(is_resource($buffer)); @@ -58,8 +73,12 @@ public function getDiff(array $diff): string } } - if (0 !== count($diff)) { - $this->writeDiffHunks($buffer, $diff); + $this->writeDiffHunks($buffer, $diff); + + if (!$this->changed) { + fclose($buffer); + + return ''; } $diff = stream_get_contents($buffer, -1, 0); @@ -75,8 +94,10 @@ public function getDiff(array $diff): string : $diff; } - private function writeDiffHunks($output, array $diff): void + private function writeDiffHunks(mixed $output, array $diff): void { + assert(is_resource($output)); + // detect "No newline at end of file" and insert into `$diff` if needed $upperLimit = count($diff); @@ -101,7 +122,7 @@ private function writeDiffHunks($output, array $diff): void array_splice($diff, $i + 1, 0, [["\n\\ No newline at end of file\n", Differ::NO_LINE_END_EOF_WARNING]]); } - if (!count($toFind)) { + if ($toFind === []) { break; } } @@ -114,9 +135,7 @@ private function writeDiffHunks($output, array $diff): void $hunkCapture = false; $sameCount = $toRange = $fromRange = 0; $toStart = $fromStart = 1; - $i = 0; - /** @var int $i */ foreach ($diff as $i => $entry) { if (0 === $entry[1]) { // same if (false === $hunkCapture) { @@ -173,6 +192,8 @@ private function writeDiffHunks($output, array $diff): void continue; } + $this->changed = true; + if (false === $hunkCapture) { $hunkCapture = $i; } @@ -204,6 +225,8 @@ private function writeDiffHunks($output, array $diff): void $fromRange -= $sameCount; $toRange -= $sameCount; + assert(isset($i) && is_int($i)); + $this->writeHunk( $diff, $hunkCapture - $contextStartOffset, @@ -224,8 +247,10 @@ private function writeHunk( int $fromRange, int $toStart, int $toRange, - $output + mixed $output ): void { + assert(is_resource($output)); + if ($this->addLineNumbers) { fwrite($output, '@@ -' . $fromStart); @@ -252,10 +277,11 @@ private function writeHunk( } elseif ($diff[$i][1] === Differ::OLD) { fwrite($output, ' ' . $diff[$i][0]); } elseif ($diff[$i][1] === Differ::NO_LINE_END_EOF_WARNING) { - fwrite($output, "\n"); // $diff[$i][0] - } else { /* Not changed (old) Differ::OLD or Warning Differ::DIFF_LINE_END_WARNING */ + fwrite($output, $this->emitNoLineEndEofWarning ? $diff[$i][0] : "\n"); + } elseif ($diff[$i][1] === Differ::DIFF_LINE_END_WARNING) { fwrite($output, ' ' . $diff[$i][0]); } + // else: unknown/invalid type - silently skip } } } diff --git a/app/vendor/sebastian/diff/src/Parser.php b/app/vendor/sebastian/diff/src/Parser.php index e63e690c1..41eeaeca4 100644 --- a/app/vendor/sebastian/diff/src/Parser.php +++ b/app/vendor/sebastian/diff/src/Parser.php @@ -11,7 +11,6 @@ use const PREG_UNMATCHED_AS_NULL; use function array_pop; -use function assert; use function count; use function max; use function preg_match; @@ -23,13 +22,15 @@ final class Parser { /** - * @return Diff[] + * @return list */ public function parse(string $string): array { $lines = preg_split('(\r\n|\r|\n)', $string); - if (!empty($lines) && $lines[count($lines) - 1] === '') { + if ($lines !== false && + $lines !== [] && + $lines[count($lines) - 1] === '') { array_pop($lines); } @@ -48,9 +49,6 @@ public function parse(string $string): array $collected = []; } - assert(!empty($fromMatch['file'])); - assert(!empty($toMatch['file'])); - $diff = new Diff($fromMatch['file'], $toMatch['file']); $i++; @@ -63,7 +61,7 @@ public function parse(string $string): array } } - if ($diff !== null && count($collected)) { + if ($diff !== null && $collected !== []) { $this->parseFileDiff($diff, $collected); $diffs[] = $diff; diff --git a/app/vendor/sebastian/diff/src/TimeEfficientLongestCommonSubsequenceCalculator.php b/app/vendor/sebastian/diff/src/TimeEfficientLongestCommonSubsequenceCalculator.php index 98e856d53..64e9930da 100644 --- a/app/vendor/sebastian/diff/src/TimeEfficientLongestCommonSubsequenceCalculator.php +++ b/app/vendor/sebastian/diff/src/TimeEfficientLongestCommonSubsequenceCalculator.php @@ -13,6 +13,9 @@ use function count; use SplFixedArray; +/** + * @deprecated https://github.com/sebastianbergmann/diff/pull/138 + */ final class TimeEfficientLongestCommonSubsequenceCalculator implements LongestCommonSubsequenceCalculator { /** diff --git a/app/vendor/sebastian/environment/ChangeLog.md b/app/vendor/sebastian/environment/ChangeLog.md index 1eee0cb4e..dd19b0bf8 100644 --- a/app/vendor/sebastian/environment/ChangeLog.md +++ b/app/vendor/sebastian/environment/ChangeLog.md @@ -2,6 +2,60 @@ All notable changes in `sebastianbergmann/environment` are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. +## [9.3.1] - 2026-05-21 + +### Fixed + +* [#64](https://github.com/sebastianbergmann/environment/issues/64): `Runtime::getCurrentSettings()` does not quote values, breaking `php -d` round-trip + +## [9.3.0] - 2026-04-15 + +### Added + +* `Runtime::getSettingsNotChangeableAtRuntime()` + +## [9.2.0] - 2026-04-05 + +### Added + +* [`#80`](https://github.com/sebastianbergmann/environment/issues/80): Support for `FORCE_COLOR` environment variable + +## [9.1.0] - 2026-03-22 + +### Added + +* `Host` class + +## [9.0.1] - 2026-03-15 + +### Fixed + +* [#79](https://github.com/sebastianbergmann/environment/issues/79): Warnings in non-TTY environments + +## [9.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + +## [8.1.1] - 2026-05-21 + +### Fixed + +* [#64](https://github.com/sebastianbergmann/environment/issues/64): `Runtime::getCurrentSettings()` does not quote values, breaking `php -d` round-trip + +## [8.1.0] - 2026-04-15 + +### Added + +* `Runtime::getSettingsNotChangeableAtRuntime()` + +## [8.0.4] - 2026-03-15 + +### Fixed + +* [#79](https://github.com/sebastianbergmann/environment/issues/79): Warnings in non-TTY environments + ## [8.0.3] - 2025-08-12 ### Changed @@ -239,6 +293,17 @@ All notable changes in `sebastianbergmann/environment` are documented in this fi * This component is no longer supported on PHP 5.6 +[9.3.1]: https://github.com/sebastianbergmann/environment/compare/9.3.0...9.3.1 +[9.3.0]: https://github.com/sebastianbergmann/environment/compare/9.2.0...9.3.0 +[9.2.0]: https://github.com/sebastianbergmann/environment/compare/9.1.0...9.2.0 +[9.1.0]: https://github.com/sebastianbergmann/environment/compare/9.0.1...9.1.0 +[9.0.1]: https://github.com/sebastianbergmann/environment/compare/9.0.0...9.0.1 +[9.0.0]: https://github.com/sebastianbergmann/environment/compare/8.1...9.0.0 +[8.1.1]: https://github.com/sebastianbergmann/environment/compare/8.1.0...8.1 +[8.1.1]: https://github.com/sebastianbergmann/environment/compare/8.1.0...8.1.1 +[8.1.0]: https://github.com/sebastianbergmann/environment/compare/8.0.4...8.1.0 +[8.0.4]: https://github.com/sebastianbergmann/environment/compare/8.0.3...8.0.4 +[8.0.4]: https://github.com/sebastianbergmann/environment/compare/8.0.3...8.0 [8.0.3]: https://github.com/sebastianbergmann/environment/compare/8.0.2...8.0.3 [8.0.2]: https://github.com/sebastianbergmann/environment/compare/8.0.1...8.0.2 [8.0.1]: https://github.com/sebastianbergmann/environment/compare/8.0.0...8.0.1 diff --git a/app/vendor/sebastian/environment/LICENSE b/app/vendor/sebastian/environment/LICENSE index 845fd0b12..2e8cfac08 100644 --- a/app/vendor/sebastian/environment/LICENSE +++ b/app/vendor/sebastian/environment/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2014-2025, Sebastian Bergmann +Copyright (c) 2014-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/environment/SECURITY.md b/app/vendor/sebastian/environment/SECURITY.md index d88ff0019..af0c5a4fd 100644 --- a/app/vendor/sebastian/environment/SECURITY.md +++ b/app/vendor/sebastian/environment/SECURITY.md @@ -1,30 +1,10 @@ # Security Policy -If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure. +The library that is developed in this repository is a first-party dependency of [PHPUnit](https://github.com/sebastianbergmann/phpunit). +[PHPUnit's Security Policy](https://github.com/sebastianbergmann/phpunit/security/policy) applies to this library as well. -**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** - -Instead, please email `sebastian@phpunit.de`. - -Please include as much of the information listed below as you can to help us better understand and resolve the issue: - -* The type of issue -* Full paths of source file(s) related to the manifestation of the issue -* The location of the affected source code (tag/branch/commit or direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the issue - -This information will help us triage your report more quickly. +If you believe you have found a security vulnerability in this library, please report it to me through coordinated disclosure. -## Web Context - -The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit. - -The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes. - -If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. - -Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. +Use my [PGP key](https://sebastian-bergmann.de/gpg.asc) for encrypted email, for example when your report includes proof-of-concept exploits against third-party systems. +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** diff --git a/app/vendor/sebastian/environment/composer.json b/app/vendor/sebastian/environment/composer.json index f7534d7b5..d611ebf38 100644 --- a/app/vendor/sebastian/environment/composer.json +++ b/app/vendor/sebastian/environment/composer.json @@ -16,17 +16,17 @@ }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "prefer-stable": true, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "suggest": { "ext-posix": "*" @@ -38,7 +38,7 @@ }, "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "9.3-dev" } } } diff --git a/app/vendor/sebastian/environment/src/Console.php b/app/vendor/sebastian/environment/src/Console.php index 525c19391..2ae533f38 100644 --- a/app/vendor/sebastian/environment/src/Console.php +++ b/app/vendor/sebastian/environment/src/Console.php @@ -19,7 +19,6 @@ use function function_exists; use function getenv; use function in_array; -use function is_array; use function is_int; use function is_resource; use function is_string; @@ -63,10 +62,16 @@ public function hasColorSupport(): bool return false; } + // Follow https://no-color.org/ if (isset($_SERVER['NO_COLOR']) || false !== getenv('NO_COLOR')) { return false; } + // Follow https://force-color.org/ + if (isset($_SERVER['FORCE_COLOR']) || false !== getenv('FORCE_COLOR')) { + return true; + } + if (!@stream_isatty(STDOUT) && !in_array(strtoupper((string) getenv('MSYSTEM')), ['MINGW32', 'MINGW64'], true)) { return false; @@ -128,7 +133,7 @@ public function isInteractive(mixed $fileDescriptor = self::STDOUT): bool } if (function_exists('fstat')) { - $stat = @fstat(STDOUT); + $stat = @fstat($fileDescriptor); return $stat !== false && 0o020000 === ($stat['mode'] & 0o170000); } @@ -150,7 +155,7 @@ private function isWindows(): bool private function getNumberOfColumnsInteractive(): int { if (function_exists('shell_exec')) { - $stty = shell_exec('stty size'); + $stty = shell_exec('stty size 2>/dev/null'); if ($stty === false || $stty === null) { $stty = ''; @@ -162,7 +167,7 @@ private function getNumberOfColumnsInteractive(): int } } - $stty = shell_exec('stty'); + $stty = shell_exec('stty 2>/dev/null'); if ($stty === false || $stty === null) { $stty = ''; @@ -202,7 +207,6 @@ private function getNumberOfColumnsWindows(): int ['suppress_errors' => true], ); - assert(is_array($pipes)); assert(isset($pipes[1]) && is_resource($pipes[1])); assert(isset($pipes[2]) && is_resource($pipes[2])); diff --git a/app/vendor/sebastian/environment/src/Host.php b/app/vendor/sebastian/environment/src/Host.php new file mode 100644 index 000000000..abefca11b --- /dev/null +++ b/app/vendor/sebastian/environment/src/Host.php @@ -0,0 +1,77 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\Environment; + +use const PHP_OS_FAMILY; +use function assert; +use function function_exists; +use function getenv; +use function gethostname; +use function php_uname; +use function posix_geteuid; +use function posix_getpwuid; +use function trim; + +final readonly class Host +{ + /** + * @return non-empty-string + */ + public function name(): string + { + $candidate = gethostname(); + + if ($candidate === false) { + return 'unknown'; + } + + $candidate = trim($candidate); + + if ($candidate === '') { + return 'unknown'; + } + + return $candidate; + } + + /** + * @return non-empty-string + */ + public function user(): string + { + if (function_exists('posix_getpwuid') && function_exists('posix_geteuid')) { + $info = posix_getpwuid(posix_geteuid()); + + if ($info !== false) { + $candidate = trim($info['name']); + } + } elseif (PHP_OS_FAMILY === 'Windows') { + $candidate = trim((string) getenv('USERNAME')); + } + + if (!isset($candidate) || $candidate === '') { + return 'unknown'; + } + + return $candidate; + } + + /** + * @return non-empty-string + */ + public function operatingSystem(): string + { + $result = php_uname(); + + assert($result !== ''); + + return $result; + } +} diff --git a/app/vendor/sebastian/environment/src/Runtime.php b/app/vendor/sebastian/environment/src/Runtime.php index e272f01a8..f9cd1ca6d 100644 --- a/app/vendor/sebastian/environment/src/Runtime.php +++ b/app/vendor/sebastian/environment/src/Runtime.php @@ -9,6 +9,7 @@ */ namespace SebastianBergmann\Environment; +use const INI_SCANNER_NORMAL; use const PHP_BINARY; use const PHP_SAPI; use const PHP_VERSION; @@ -20,18 +21,30 @@ use function extension_loaded; use function in_array; use function ini_get; +use function ini_get_all; use function is_array; +use function is_int; +use function is_string; +use function json_decode; use function parse_ini_file; use function php_ini_loaded_file; use function php_ini_scanned_files; use function phpversion; +use function proc_close; +use function proc_open; use function sprintf; +use function stream_get_contents; use function strrpos; use function version_compare; use function xdebug_info; final class Runtime { + /** + * @var ?array + */ + private static ?array $compiledDefaults = null; + /** * Returns true when Xdebug or PCOV is available or * the runtime used is PHPDBG. @@ -141,18 +154,26 @@ public function getNameWithVersion(): string public function getNameWithVersionAndCodeCoverageDriver(): string { if ($this->hasPCOV()) { + $version = phpversion('pcov'); + + assert($version !== false); + return sprintf( '%s with PCOV %s', $this->getNameWithVersion(), - phpversion('pcov'), + $version, ); } if ($this->hasXdebug()) { + $version = phpversion('xdebug'); + + assert($version !== false); + return sprintf( '%s with Xdebug %s', $this->getNameWithVersion(), - phpversion('xdebug'), + $version, ); } @@ -223,13 +244,14 @@ public function hasPCOV(): bool /** * Parses the loaded php.ini file (if any) as well as all - * additional php.ini files from the additional ini dir for - * a list of all configuration settings loaded from files - * at startup. Then checks for each php.ini setting passed - * via the `$values` parameter whether this setting has - * been changed at runtime. Returns an array of strings - * where each string has the format `key=value` denoting - * the name of a changed php.ini setting with its new value. + * additional php.ini files from the additional ini dir into a + * single merged map of settings, and also obtains the compiled-in + * defaults by spawning a `php -n` child once per process. + * Then checks for each setting passed via the `$values` parameter + * whether the runtime value (`ini_get()`) differs from what the + * ini files specified or, when a setting is not configured in any + * ini file, from the compiled-in default. Returns an array of + * `key=value` strings for the changed settings. * * @param list $values * @@ -237,7 +259,95 @@ public function hasPCOV(): bool */ public function getCurrentSettings(array $values): array { - $diff = []; + $iniFileValues = $this->parseLoadedIniFiles(); + $compiledDefaults = self::compiledDefaults(); + $diff = []; + + foreach ($values as $value) { + $set = ini_get($value); + + if ($set === false) { + continue; + } + + if (isset($iniFileValues[$value]) && $iniFileValues[$value] === $set) { + continue; + } + + if (!isset($iniFileValues[$value]) && ($compiledDefaults[$value] ?? null) === $set) { + continue; + } + + $diff[$value] = sprintf('%s=%s', $value, $set); + } + + return $diff; + } + + /** + * Returns INI settings that cannot be changed via ini_set() + * (PHP_INI_SYSTEM and PHP_INI_PERDIR) and whose current value + * differs from the value configured in INI files. + * + * These settings can only have been changed via CLI -d flags + * and must be forwarded as -d flags to child processes because + * ini_set() cannot change them at runtime. + * + * @return array + */ + public function getSettingsNotChangeableAtRuntime(): array + { + $allSettings = ini_get_all(null, true); + + assert($allSettings !== false); + + $nonRuntimeSettable = []; + + foreach ($allSettings as $key => $info) { + assert(is_array($info)); + assert(isset($info['access'])); + assert(is_int($info['access'])); + + /** + * Only consider settings that cannot be changed via ini_set(). + * + * PHP_INI_USER = 1 + * PHP_INI_PERDIR = 2 + * PHP_INI_SYSTEM = 4 + * PHP_INI_ALL = 7 + */ + if (($info['access'] & 1) !== 0) { + continue; + } + + $nonRuntimeSettable[] = $key; + } + + return $this->getCurrentSettings($nonRuntimeSettable); + } + + public function isOpcacheActive(): bool + { + if (!extension_loaded('Zend OPcache')) { + return false; + } + + if ((PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') && ini_get('opcache.enable_cli') === '1') { + return true; + } + + if (PHP_SAPI !== 'cli' && PHP_SAPI !== 'phpdbg' && ini_get('opcache.enable') === '1') { + return true; + } + + return false; + } + + /** + * @return array + */ + private function parseLoadedIniFiles(): array + { $files = []; $file = php_ini_loaded_file(); @@ -258,39 +368,84 @@ public function getCurrentSettings(array $values): array ); } - foreach ($files as $ini) { - $config = parse_ini_file($ini, true); + $merged = []; - foreach ($values as $value) { - $set = ini_get($value); + foreach ($files as $ini) { + $parsed = parse_ini_file($ini, false, INI_SCANNER_NORMAL); - if ($set === false || $set === '') { - continue; - } + if ($parsed === false) { + continue; + } - if ((!isset($config[$value]) || ($set !== $config[$value]))) { - $diff[$value] = sprintf('%s=%s', $value, $set); + foreach ($parsed as $key => $val) { + if (is_string($val)) { + $merged[$key] = $val; } } } - return $diff; + return $merged; } - public function isOpcacheActive(): bool + /** + * Returns the compiled-in default values of every ini setting by + * spawning a `php -n` child process once and caching the result + * for the lifetime of the PHP process. When the child cannot be + * launched or its output is unusable, an empty array is returned + * and cached so the failure is not retried. + * + * @return array + */ + private static function compiledDefaults(): array { - if (!extension_loaded('Zend OPcache')) { - return false; + if (self::$compiledDefaults !== null) { + return self::$compiledDefaults; } - if ((PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') && ini_get('opcache.enable_cli') === '1') { - return true; + self::$compiledDefaults = []; + + $process = proc_open( + [PHP_BINARY, '-n', '-r', 'echo json_encode(ini_get_all(null, true));'], + [1 => ['pipe', 'w']], + $pipes, + ); + + if ($process === false) { + return self::$compiledDefaults; } - if (PHP_SAPI !== 'cli' && PHP_SAPI !== 'phpdbg' && ini_get('opcache.enable') === '1') { - return true; + assert(isset($pipes[1])); + + $stdout = stream_get_contents($pipes[1]); + + proc_close($process); + + if (!is_string($stdout) || $stdout === '') { + return self::$compiledDefaults; } - return false; + $parsed = json_decode($stdout, true); + + if (!is_array($parsed)) { + return self::$compiledDefaults; + } + + foreach ($parsed as $key => $info) { + if (!is_string($key)) { + continue; + } + + if (!is_array($info)) { + continue; + } + + if (!isset($info['global_value']) || !is_string($info['global_value'])) { + continue; + } + + self::$compiledDefaults[$key] = $info['global_value']; + } + + return self::$compiledDefaults; } } diff --git a/app/vendor/sebastian/exporter/ChangeLog.md b/app/vendor/sebastian/exporter/ChangeLog.md index f437a2ebe..46c5667fb 100644 --- a/app/vendor/sebastian/exporter/ChangeLog.md +++ b/app/vendor/sebastian/exporter/ChangeLog.md @@ -2,211 +2,66 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. -## [7.0.0] - 2025-02-07 - -### Removed - -* This component is no longer supported on PHP 8.2 - -## [6.3.0] - 2024-12-05 - -### Added - -* Optional constructor argument to control maximum string length - -### Deprecated - -* Optional argument for `shortenedRecursiveExport()` and `shortenedExport()` to control maximum string length - -## [6.2.0] - 2024-12-05 - -### Added - -* [#67](https://github.com/sebastianbergmann/exporter/issues/67): Optional argument for `shortenedRecursiveExport()` and `shortenedExport()` to control maximum string length - -### Changed - -* [#69](https://github.com/sebastianbergmann/exporter/pull/69): Do not initialize lazy objects during export - -## [6.1.3] - 2024-07-03 - -### Changed - -* [#66](https://github.com/sebastianbergmann/exporter/pull/66): Avoid using the Reflection API for some classes -* This project now uses PHPStan instead of Psalm for static analysis - -## [6.1.2] - 2024-06-18 - -### Changed - -* [#64](https://github.com/sebastianbergmann/exporter/pull/64): Improve performance of `Exporter::exportString()` -* [#65](https://github.com/sebastianbergmann/exporter/pull/65): Prevent unnecessary calls to `str_repeat()` - -### Fixed - -* [#62](https://github.com/sebastianbergmann/exporter/issues/62): Do not limit export of arrays by default (to restore BC with versions prior to 6.1.0) - -## [6.1.1] - 2024-06-18 - -### Fixed - -* [#61](https://github.com/sebastianbergmann/exporter/issues/61): `count(): Recursion detected` warning triggered - -## [6.1.0] - 2024-06-18 - -### Added - -* [#59](https://github.com/sebastianbergmann/exporter/pull/59): Option to limit export of (large) arrays (to speed up PHPUnit) +## [8.1.0] - 2026-05-21 ### Changed -* [#60](https://github.com/sebastianbergmann/exporter/pull/60): Take shortcut when exporting a string +* [#57](https://github.com/sebastianbergmann/exporter/issues/57): Preserve `SplObjectStorage` iterator position instead of resetting to first element +* [#91](https://github.com/sebastianbergmann/exporter/pull/91): Make binary string output readable for mostly-printable values -## [6.0.3] - 2024-06-17 +## [8.0.3] - 2026-05-20 ### Fixed -* Fixed code coverage metadata - -## [6.0.2] - 2024-06-17 [YANKED] +* [#90](https://github.com/sebastianbergmann/exporter/issues/90): `Exporter::toArray()` silently drops a private property that is redeclared in a derived class -### Changed +## [8.0.2] - 2026-04-15 -* [#58](https://github.com/sebastianbergmann/exporter/pull/58): Remove unnecessary `sprintf()` in hot path +* [#74](https://github.com/sebastianbergmann/exporter/pull/74): Int cast warning when exporting large floats -## [6.0.1] - 2024-03-02 +## [8.0.1] - 2026-04-10 ### Changed -* Do not use implicitly nullable parameters +* Explicitly handle `NAN`, `INF`, and `-INF` in `exportFloat()` -## [6.0.0] - 2024-02-02 +## [8.0.0] - 2026-02-06 ### Removed -* This component is no longer supported on PHP 8.1 - -## [5.1.2] - 2024-03-02 - -### Changed - -* Do not use implicitly nullable parameters - -## [5.1.1] - 2023-09-24 - -### Changed - -* [#52](https://github.com/sebastianbergmann/exporter/pull/52): Optimize export of large arrays and object graphs +* This component is no longer supported on PHP 8.3 -## [5.1.0] - 2023-09-18 - -### Changed - -* [#51](https://github.com/sebastianbergmann/exporter/pull/51): Export arrays using short array syntax - -## [5.0.1] - 2023-09-08 - -### Fixed - -* [#49](https://github.com/sebastianbergmann/exporter/issues/49): `Exporter::toArray()` changes `SplObjectStorage` index - -## [5.0.0] - 2023-02-03 - -### Changed - -* [#42](https://github.com/sebastianbergmann/exporter/pull/42): Improve export of enumerations - -### Removed - -* This component is no longer supported on PHP 7.3, PHP 7.4 and PHP 8.0 - -## [4.0.5] - 2022-09-14 +## [7.0.3] - 2026-05-20 ### Fixed -* [#47](https://github.com/sebastianbergmann/exporter/pull/47): Fix `float` export precision +* [#90](https://github.com/sebastianbergmann/exporter/issues/90): `Exporter::toArray()` silently drops a private property that is redeclared in a derived class -## [4.0.4] - 2021-11-11 +## [7.0.2] - 2025-09-24 ### Changed -* [#37](https://github.com/sebastianbergmann/exporter/pull/37): Improve export of closed resources - -## [4.0.3] - 2020-09-28 - -### Changed - -* Changed PHP version constraint in `composer.json` from `^7.3 || ^8.0` to `>=7.3` - -## [4.0.2] - 2020-06-26 - -### Added - -* This component is now supported on PHP 8 +* Suppress `unexpected NAN value was coerced to string` warning triggered on PHP 8.5 -## [4.0.1] - 2020-06-15 +## [7.0.1] - 2025-09-22 ### Changed -* Tests etc. are now ignored for archive exports +* Suppress `not representable as an int, cast occurred` warning triggered on PHP 8.5 -## [4.0.0] - 2020-02-07 - -### Removed - -* This component is no longer supported on PHP 7.0, PHP 7.1, and PHP 7.2 - -## [3.1.5] - 2022-09-14 - -### Fixed - -* [#47](https://github.com/sebastianbergmann/exporter/pull/47): Fix `float` export precision - -## [3.1.4] - 2021-11-11 - -### Changed - -* [#38](https://github.com/sebastianbergmann/exporter/pull/38): Improve export of closed resources - -## [3.1.3] - 2020-11-30 - -### Changed - -* Changed PHP version constraint in `composer.json` from `^7.0` to `>=7.0` - -## [3.1.2] - 2019-09-14 - -### Fixed - -* [#29](https://github.com/sebastianbergmann/exporter/pull/29): Second parameter for `str_repeat()` must be an integer +## [7.0.0] - 2025-02-07 ### Removed -* Remove HHVM-specific code that is no longer needed +* This component is no longer supported on PHP 8.2 +[8.1.0]: https://github.com/sebastianbergmann/exporter/compare/8.0.3...8.1.0 +[8.0.3]: https://github.com/sebastianbergmann/exporter/compare/8.0.2...8.0.3 +[8.0.2]: https://github.com/sebastianbergmann/exporter/compare/8.0.1...8.0.2 +[8.0.1]: https://github.com/sebastianbergmann/exporter/compare/8.0.0...8.0.1 +[8.0.0]: https://github.com/sebastianbergmann/exporter/compare/7.0...8.0.0 +[7.0.3]: https://github.com/sebastianbergmann/exporter/compare/7.0.2...7.0 +[7.0.3]: https://github.com/sebastianbergmann/exporter/compare/7.0.2...7.0.3 +[7.0.2]: https://github.com/sebastianbergmann/exporter/compare/7.0.1...7.0.2 +[7.0.1]: https://github.com/sebastianbergmann/exporter/compare/7.0.0...7.0.1 [7.0.0]: https://github.com/sebastianbergmann/exporter/compare/6.3...7.0.0 -[6.3.0]: https://github.com/sebastianbergmann/exporter/compare/6.2.0...6.3.0 -[6.2.0]: https://github.com/sebastianbergmann/exporter/compare/6.1.3...6.2.0 -[6.1.3]: https://github.com/sebastianbergmann/exporter/compare/6.1.2...6.1.3 -[6.1.2]: https://github.com/sebastianbergmann/exporter/compare/6.1.1...6.1.2 -[6.1.1]: https://github.com/sebastianbergmann/exporter/compare/6.1.0...6.1.1 -[6.1.0]: https://github.com/sebastianbergmann/exporter/compare/6.0.3...6.1.0 -[6.0.3]: https://github.com/sebastianbergmann/exporter/compare/fe0dca49a60d34440e2f086951952dd13aa9a5d2...6.0.3 -[6.0.2]: https://github.com/sebastianbergmann/exporter/compare/6.0.1...fe0dca49a60d34440e2f086951952dd13aa9a5d2 -[6.0.1]: https://github.com/sebastianbergmann/exporter/compare/6.0.0...6.0.1 -[6.0.0]: https://github.com/sebastianbergmann/exporter/compare/5.1...6.0.0 -[5.1.2]: https://github.com/sebastianbergmann/exporter/compare/5.1.1...5.1.2 -[5.1.1]: https://github.com/sebastianbergmann/exporter/compare/5.1.0...5.1.1 -[5.1.0]: https://github.com/sebastianbergmann/exporter/compare/5.0.1...5.1.0 -[5.0.1]: https://github.com/sebastianbergmann/exporter/compare/5.0.0...5.0.1 -[5.0.0]: https://github.com/sebastianbergmann/exporter/compare/4.0.5...5.0.0 -[4.0.5]: https://github.com/sebastianbergmann/exporter/compare/4.0.4...4.0.5 -[4.0.4]: https://github.com/sebastianbergmann/exporter/compare/4.0.3...4.0.4 -[4.0.3]: https://github.com/sebastianbergmann/exporter/compare/4.0.2...4.0.3 -[4.0.2]: https://github.com/sebastianbergmann/exporter/compare/4.0.1...4.0.2 -[4.0.1]: https://github.com/sebastianbergmann/exporter/compare/4.0.0...4.0.1 -[4.0.0]: https://github.com/sebastianbergmann/exporter/compare/3.1.2...4.0.0 -[3.1.5]: https://github.com/sebastianbergmann/exporter/compare/3.1.4...3.1.5 -[3.1.4]: https://github.com/sebastianbergmann/exporter/compare/3.1.3...3.1.4 -[3.1.3]: https://github.com/sebastianbergmann/exporter/compare/3.1.2...3.1.3 -[3.1.2]: https://github.com/sebastianbergmann/exporter/compare/3.1.1...3.1.2 diff --git a/app/vendor/sebastian/exporter/LICENSE b/app/vendor/sebastian/exporter/LICENSE index c5268a916..0fad16fc6 100644 --- a/app/vendor/sebastian/exporter/LICENSE +++ b/app/vendor/sebastian/exporter/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2002-2025, Sebastian Bergmann +Copyright (c) 2002-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/exporter/SECURITY.md b/app/vendor/sebastian/exporter/SECURITY.md index d88ff0019..af0c5a4fd 100644 --- a/app/vendor/sebastian/exporter/SECURITY.md +++ b/app/vendor/sebastian/exporter/SECURITY.md @@ -1,30 +1,10 @@ # Security Policy -If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure. +The library that is developed in this repository is a first-party dependency of [PHPUnit](https://github.com/sebastianbergmann/phpunit). +[PHPUnit's Security Policy](https://github.com/sebastianbergmann/phpunit/security/policy) applies to this library as well. -**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** - -Instead, please email `sebastian@phpunit.de`. - -Please include as much of the information listed below as you can to help us better understand and resolve the issue: - -* The type of issue -* Full paths of source file(s) related to the manifestation of the issue -* The location of the affected source code (tag/branch/commit or direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the issue - -This information will help us triage your report more quickly. +If you believe you have found a security vulnerability in this library, please report it to me through coordinated disclosure. -## Web Context - -The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit. - -The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes. - -If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. - -Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. +Use my [PGP key](https://sebastian-bergmann.de/gpg.asc) for encrypted email, for example when your report includes proof-of-concept exploits against third-party systems. +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** diff --git a/app/vendor/sebastian/exporter/composer.json b/app/vendor/sebastian/exporter/composer.json index 1430aa199..8d0ff6864 100644 --- a/app/vendor/sebastian/exporter/composer.json +++ b/app/vendor/sebastian/exporter/composer.json @@ -32,19 +32,19 @@ }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "prefer-stable": true, "require": { - "php": ">=8.3", + "php": ">=8.4", "ext-mbstring": "*", - "sebastian/recursion-context": "^7.0" + "sebastian/recursion-context": "^8.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "autoload": { "classmap": [ @@ -58,7 +58,7 @@ }, "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.1-dev" } } } diff --git a/app/vendor/sebastian/exporter/src/Exporter.php b/app/vendor/sebastian/exporter/src/Exporter.php index 599a331f0..d7893ba8c 100644 --- a/app/vendor/sebastian/exporter/src/Exporter.php +++ b/app/vendor/sebastian/exporter/src/Exporter.php @@ -21,16 +21,24 @@ use function is_array; use function is_bool; use function is_float; +use function is_infinite; +use function is_nan; use function is_object; use function is_resource; use function is_string; use function mb_strlen; use function mb_substr; +use function ord; use function preg_match; +use function preg_match_all; +use function preg_replace_callback; use function spl_object_id; use function sprintf; +use function str_contains; use function str_repeat; use function str_replace; +use function strlen; +use function strpbrk; use function strtr; use function var_export; use BackedEnum; @@ -92,7 +100,7 @@ public function shortenedRecursiveExport(array &$data, int $maxLengthForStrings $maxLengthForStrings = $this->maxLengthForStrings; } - if (!$processed) { + if ($processed === null) { $processed = new RecursionContext; } @@ -183,29 +191,43 @@ public function toArray(mixed $value): array return (array) $value; } - $array = []; + $properties = (array) $value; + $shadowed = $this->shadowedPropertyNames($properties); + $array = []; + + foreach ($properties as $key => $val) { + $key = (string) $key; - foreach ((array) $value as $key => $val) { // Exception traces commonly reference hundreds to thousands of // objects currently loaded in memory. Including them in the result // has a severe negative performance impact. - if ("\0Error\0trace" === $key || "\0Exception\0trace" === $key) { + if ($key === "\0Error\0trace" || $key === "\0Exception\0trace") { continue; } - // properties are transformed to keys in the following way: - // private $propertyName => "\0ClassName\0propertyName" - // protected $propertyName => "\0*\0propertyName" - // public $propertyName => "propertyName" - if (preg_match('/\0.+\0(.+)/', (string) $key, $matches)) { - $key = $matches[1]; - } - // See https://github.com/php/php-src/commit/5721132 if ($key === "\0gcdata") { continue; } + // Properties are transformed to keys in the following way: + // private $propertyName => "\0DeclaringClassName\0propertyName" + // protected $propertyName => "\0*\0propertyName" + // public $propertyName => "propertyName" + // + // A private property that is redeclared in a derived class and the + // private property of the same name that it shadows both exist, + // independently of each other. To keep one from overwriting the + // other, the name of a shadowed private property is prefixed with + // the name of the class that declares it. + if (preg_match('/^\0([^\0]+)\0([^\0]+)$/', $key, $matches) === 1) { + if ($matches[1] !== '*' && isset($shadowed[$matches[2]])) { + $key = $matches[1] . '::' . $matches[2]; + } else { + $key = $matches[2]; + } + } + $array[$key] = $val; } @@ -213,6 +235,12 @@ public function toArray(mixed $value): array // above (fast) mechanism nor with reflection in Zend. // Format the output similarly to print_r() in this case if ($value instanceof SplObjectStorage) { + $key = null; + + if ($value->valid()) { + $key = $value->key(); + } + foreach ($value as $_value) { $array['Object #' . spl_object_id($_value)] = [ 'obj' => $_value, @@ -220,7 +248,9 @@ public function toArray(mixed $value): array ]; } - $value->rewind(); + if ($key !== null) { + $value->seek($key); + } } return $array; @@ -236,10 +266,47 @@ public function countProperties(object $value): int if (!$value instanceof stdClass) { // using ReflectionClass prevents initialization of potential lazy objects - return count((new ReflectionClass($value))->getProperties()); + return count(new ReflectionClass($value)->getProperties()); + } + + return count(new ReflectionObject($value)->getProperties()); + } + + /** + * Returns, as keys of the returned array, the names of properties that + * are declared more than once in the inheritance chain of an object. + * + * This can only happen when a derived class redeclares a private property + * that one of its parent classes also declares. + * + * @param array $properties + * + * @return array + */ + private function shadowedPropertyNames(array $properties): array + { + $seen = []; + $shadowed = []; + + foreach ($properties as $key => $unused) { + $key = (string) $key; + + if ($key === "\0Error\0trace" || $key === "\0Exception\0trace" || $key === "\0gcdata") { + continue; + } + + if (preg_match('/^\0[^\0]+\0([^\0]+)$/', $key, $matches) === 1) { + $key = $matches[1]; + } + + if (isset($seen[$key])) { + $shadowed[$key] = true; + } + + $seen[$key] = true; } - return count((new ReflectionObject($value))->getProperties()); + return $shadowed; } /** @@ -262,7 +329,7 @@ private function shortenedCountedRecursiveExport(array &$data, RecursionContext } if (is_array($value)) { - assert(is_array($data[$key]) || is_object($data[$key])); + assert(isset($data[$key]) && (is_array($data[$key]) || is_object($data[$key]))); if ($processed->contains($data[$key]) !== false) { $result[] = '*RECURSION*'; @@ -302,6 +369,7 @@ private function recursiveExport(mixed &$value, int $indentation = 0, ?Recursion if (is_resource($value)) { return sprintf( 'resource(%d) of type (%s)', + /** @phpstan-ignore cast.useless */ (int) $value, get_resource_type($value), ); @@ -330,7 +398,7 @@ private function recursiveExport(mixed &$value, int $indentation = 0, ?Recursion return $this->exportString($value); } - if (!$processed) { + if ($processed === null) { $processed = new RecursionContext; } @@ -347,6 +415,14 @@ private function recursiveExport(mixed &$value, int $indentation = 0, ?Recursion private function exportFloat(float $value): string { + if (is_nan($value)) { + return 'NAN'; + } + + if (is_infinite($value)) { + return $value > 0 ? 'INF' : '-INF'; + } + $precisionBackup = ini_get('precision'); ini_set('precision', '-1'); @@ -355,7 +431,8 @@ private function exportFloat(float $value): string ini_set('precision', $precisionBackup); - if ((string) (int) $value === $valueAsString) { + // Add '.0' only if decimals and scientific notation are absent. + if (strpbrk($valueAsString, '.E') === false) { return $valueAsString . '.0'; } @@ -365,21 +442,44 @@ private function exportFloat(float $value): string private function exportString(string $value): string { // Match for most non-printable chars somewhat taking multibyte chars into account - if (preg_match('/[^\x09-\x0d\x1b\x20-\xff]/', $value)) { + $unprintableCount = preg_match_all('/[^\x09-\x0d\x1b\x20-\xff]/', $value); + + if ($unprintableCount === false || $unprintableCount === 0) { + return "'" . + strtr( + $value, + [ + "\r\n" => '\r\n' . "\n", + "\n\r" => '\n\r' . "\n", + "\r" => '\r' . "\n", + "\n" => '\n' . "\n", + ], + ) . + "'"; + } + + // A NUL byte or a high ratio of unprintable bytes signals truly + // binary data; keep the compact hex dump in those cases. + if (str_contains($value, "\x00") || ($unprintableCount / strlen($value)) > 0.3) { return 'Binary String: 0x' . bin2hex($value); } - return "'" . - strtr( + // Mostly printable: keep printable bytes visible and escape only + // the offending ones inline using PHP-style \xNN escapes. + return 'Binary String: "' . + preg_replace_callback( + '/[\x00-\x1f\x7f"\\\\]/', + static fn (array $m): string => match ($m[0]) { + "\t" => '\t', + "\n" => '\n', + "\r" => '\r', + '"' => '\"', + '\\' => '\\\\', + default => sprintf('\x%02x', ord($m[0])), + }, $value, - [ - "\r\n" => '\r\n' . "\n", - "\n\r" => '\n\r' . "\n", - "\r" => '\r' . "\n", - "\n" => '\n' . "\n", - ], ) . - "'"; + '"'; } /** @@ -404,6 +504,7 @@ private function exportArray(array &$value, RecursionContext $processed, int $in . ' ' . $this->recursiveExport($k, $indentation) . ' => ' . + /** @phpstan-ignore offsetAccess.invalidOffset */ $this->recursiveExport($value[$k], $indentation + 1, $processed) . ",\n"; } diff --git a/app/vendor/sebastian/git-state/ChangeLog.md b/app/vendor/sebastian/git-state/ChangeLog.md new file mode 100644 index 000000000..0f095cfde --- /dev/null +++ b/app/vendor/sebastian/git-state/ChangeLog.md @@ -0,0 +1,9 @@ +# ChangeLog + +All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. + +## [1.0.0] - 2026-03-21 + +* Initial release + +[1.0.0]: https://github.com/sebastianbergmann/git-state/compare/5a81afaa38ac1c23aa0012177a7f6b4504a2bf67...1.0.0 diff --git a/app/vendor/sebastian/git-state/LICENSE b/app/vendor/sebastian/git-state/LICENSE new file mode 100644 index 000000000..ea2fbdfff --- /dev/null +++ b/app/vendor/sebastian/git-state/LICENSE @@ -0,0 +1,29 @@ +BSD 3-Clause License + +Copyright (c) 2026, Sebastian Bergmann +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/app/vendor/sebastian/git-state/README.md b/app/vendor/sebastian/git-state/README.md new file mode 100644 index 000000000..4e2734a7c --- /dev/null +++ b/app/vendor/sebastian/git-state/README.md @@ -0,0 +1,54 @@ +[![Latest Stable Version](https://poser.pugx.org/sebastian/git-state/v)](https://packagist.org/packages/sebastian/git-state) +[![CI Status](https://github.com/sebastianbergmann/git-state/workflows/CI/badge.svg)](https://github.com/sebastianbergmann/git-state/actions) +[![codecov](https://codecov.io/gh/sebastianbergmann/git-state/branch/main/graph/badge.svg)](https://codecov.io/gh/sebastianbergmann/git-state) + +# sebastian/git-state + +Library for describing the state of a Git checkout. + +## Installation + +You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/): + +``` +composer require sebastian/git-state +``` + +If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency: + +``` +composer require --dev sebastian/git-state +``` + +## Usage + +#### `test.php` +```php +use SebastianBergmann\GitState\Builder; + +$builder = new Builder; +$state = $builder->build(); + +if ($state === false) { + // Not a Git repository or no origin remote configured + exit(1); +} + +print $state->originUrl() . PHP_EOL; +print $state->branch() . PHP_EOL; +print $state->commit() . PHP_EOL; + +if ($state->isClean()) { + print 'Working directory is clean' . PHP_EOL; +} else { + print $state->status() . PHP_EOL; +} +``` + +``` +github.com:sebastianbergmann/git-state.git +main +ab00820c3757dbd30a8caa185aa4515b98713238 +M README.md +?? test.php +``` diff --git a/app/vendor/sebastian/git-state/SECURITY.md b/app/vendor/sebastian/git-state/SECURITY.md new file mode 100644 index 000000000..d88ff0019 --- /dev/null +++ b/app/vendor/sebastian/git-state/SECURITY.md @@ -0,0 +1,30 @@ +# Security Policy + +If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure. + +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** + +Instead, please email `sebastian@phpunit.de`. + +Please include as much of the information listed below as you can to help us better understand and resolve the issue: + +* The type of issue +* Full paths of source file(s) related to the manifestation of the issue +* The location of the affected source code (tag/branch/commit or direct URL) +* Any special configuration required to reproduce the issue +* Step-by-step instructions to reproduce the issue +* Proof-of-concept or exploit code (if possible) +* Impact of the issue, including how an attacker might exploit the issue + +This information will help us triage your report more quickly. + +## Web Context + +The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit. + +The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes. + +If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. + +Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. + diff --git a/app/vendor/sebastian/git-state/composer.json b/app/vendor/sebastian/git-state/composer.json new file mode 100644 index 000000000..605724878 --- /dev/null +++ b/app/vendor/sebastian/git-state/composer.json @@ -0,0 +1,42 @@ +{ + "name": "sebastian/git-state", + "description": "Library for describing the state of a Git checkout", + "type": "library", + "homepage": "https://github.com/sebastianbergmann/git-state", + "license": "BSD-3-Clause", + "authors": [ + { + "name": "Sebastian Bergmann", + "email": "sebastian@phpunit.de", + "role": "lead" + } + ], + "support": { + "issues": "https://github.com/sebastianbergmann/git-state/issues", + "security": "https://github.com/sebastianbergmann/git-state/security/policy" + }, + "prefer-stable": true, + "require": { + "php": ">=8.4" + }, + "require-dev": { + "phpunit/phpunit": "^13.0" + }, + "config": { + "platform": { + "php": "8.4.1" + }, + "optimize-autoloader": true, + "sort-packages": true + }, + "autoload": { + "classmap": [ + "src/" + ] + }, + "extra": { + "branch-alias": { + "dev-main": "1.0-dev" + } + } +} diff --git a/app/vendor/sebastian/git-state/src/Builder.php b/app/vendor/sebastian/git-state/src/Builder.php new file mode 100644 index 000000000..12f49e403 --- /dev/null +++ b/app/vendor/sebastian/git-state/src/Builder.php @@ -0,0 +1,98 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\GitState; + +use function assert; +use function explode; +use function preg_split; +use function str_contains; +use function str_replace; +use function str_starts_with; +use function trim; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for sebastian/git-state + */ +final readonly class Builder +{ + private GitCommandRunner $runner; + + public function __construct(?GitCommandRunner $runner = null) + { + if ($runner === null) { + $runner = new GitCommandRunner( + new ShellCommandRunnerImplementation, + ); + } + + $this->runner = $runner; + } + + public function build(): false|State + { + $buffer = $this->runner->run('remote show -n'); + + if ($buffer === false) { + return false; + } + + if (!str_contains($buffer, 'origin')) { + return false; + } + + $buffer = $this->runner->run('remote show -n origin'); + + if ($buffer === false) { + return false; + } + + $lines = preg_split("/\r\n|\n|\r/", $buffer); + + if (!isset($lines[1]) || !str_starts_with($lines[1], ' Fetch URL: ')) { + return false; + } + + $originUrl = trim(str_replace(' Fetch URL: ', '', $lines[1])); + + if (str_contains($originUrl, '@')) { + $tmp = explode('@', $originUrl); + + assert(isset($tmp[1])); + + $originUrl = $tmp[1]; + } + + assert($originUrl !== ''); + + $branch = $this->runner->run('rev-parse --abbrev-ref HEAD'); + + if ($branch === false) { + return false; + } + + assert($branch !== ''); + + $commit = $this->runner->run('rev-parse HEAD'); + + if ($commit === false) { + return false; + } + + assert($commit !== ''); + + $status = $this->runner->run('status --porcelain'); + + if ($status === false) { + return false; + } + + return new State($originUrl, $branch, $commit, $status === '', $status); + } +} diff --git a/app/vendor/sebastian/git-state/src/GitCommandRunner.php b/app/vendor/sebastian/git-state/src/GitCommandRunner.php new file mode 100644 index 000000000..2c318d5d0 --- /dev/null +++ b/app/vendor/sebastian/git-state/src/GitCommandRunner.php @@ -0,0 +1,47 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\GitState; + +use const DIRECTORY_SEPARATOR; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for sebastian/git-state + * + * @internal This class is not covered by the backward compatibility promise for sebastian/git-state + */ +final readonly class GitCommandRunner +{ + private ShellCommandRunner $runner; + + public function __construct(?ShellCommandRunner $runner = null) + { + if ($runner === null) { + // @codeCoverageIgnoreStart + $runner = new ShellCommandRunnerImplementation; + // @codeCoverageIgnoreEnd + } + + $this->runner = $runner; + } + + /** + * @param non-empty-string $command + */ + public function run(string $command): false|string + { + $command = 'git ' . $command; + + if (DIRECTORY_SEPARATOR === '/') { + $command = 'LC_ALL=en_US.UTF-8 ' . $command; + } + + return $this->runner->run($command); + } +} diff --git a/app/vendor/sebastian/git-state/src/ShellCommandRunner.php b/app/vendor/sebastian/git-state/src/ShellCommandRunner.php new file mode 100644 index 000000000..5a7f123cb --- /dev/null +++ b/app/vendor/sebastian/git-state/src/ShellCommandRunner.php @@ -0,0 +1,23 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\GitState; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for sebastian/git-state + * + * @internal This class is not covered by the backward compatibility promise for sebastian/git-state + */ +interface ShellCommandRunner +{ + /** + * @param non-empty-string $command + */ + public function run(string $command): false|string; +} diff --git a/app/vendor/sebastian/git-state/src/ShellCommandRunnerImplementation.php b/app/vendor/sebastian/git-state/src/ShellCommandRunnerImplementation.php new file mode 100644 index 000000000..eaaff84a9 --- /dev/null +++ b/app/vendor/sebastian/git-state/src/ShellCommandRunnerImplementation.php @@ -0,0 +1,63 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\GitState; + +use function assert; +use function fclose; +use function is_resource; +use function proc_close; +use function proc_open; +use function stream_get_contents; +use function trim; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for sebastian/git-state + * + * @internal This class is not covered by the backward compatibility promise for sebastian/git-state + */ +final readonly class ShellCommandRunnerImplementation implements ShellCommandRunner +{ + /** + * @param non-empty-string $command + */ + public function run(string $command): false|string + { + $process = @proc_open( + $command, + [ + 1 => ['pipe', 'w'], + 2 => ['pipe', 'w'], + ], + $pipes, + ); + + if (!is_resource($process)) { + // @codeCoverageIgnoreStart + return false; + // @codeCoverageIgnoreEnd + } + + assert(isset($pipes[1]) && is_resource($pipes[1])); + assert(isset($pipes[2]) && is_resource($pipes[2])); + + $result = trim((string) stream_get_contents($pipes[1])); + + fclose($pipes[1]); + fclose($pipes[2]); + + $returnCode = proc_close($process); + + if ($returnCode !== 0) { + return false; + } + + return $result; + } +} diff --git a/app/vendor/sebastian/git-state/src/State.php b/app/vendor/sebastian/git-state/src/State.php new file mode 100644 index 000000000..1b6423e1a --- /dev/null +++ b/app/vendor/sebastian/git-state/src/State.php @@ -0,0 +1,81 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ +namespace SebastianBergmann\GitState; + +/** + * @no-named-arguments Parameter names are not covered by the backward compatibility promise for sebastian/git-state + */ +final readonly class State +{ + /** + * @var non-empty-string + */ + private string $originUrl; + + /** + * @var non-empty-string + */ + private string $branch; + + /** + * @var non-empty-string + */ + private string $commit; + private bool $clean; + private string $status; + + /** + * @param non-empty-string $originUrl + * @param non-empty-string $branch + * @param non-empty-string $commit + */ + public function __construct(string $originUrl, string $branch, string $commit, bool $clean, string $status) + { + $this->originUrl = $originUrl; + $this->branch = $branch; + $this->commit = $commit; + $this->clean = $clean; + $this->status = $status; + } + + /** + * @return non-empty-string + */ + public function originUrl(): string + { + return $this->originUrl; + } + + /** + * @return non-empty-string + */ + public function branch(): string + { + return $this->branch; + } + + /** + * @return non-empty-string + */ + public function commit(): string + { + return $this->commit; + } + + public function isClean(): bool + { + return $this->clean; + } + + public function status(): string + { + return $this->status; + } +} diff --git a/app/vendor/sebastian/global-state/ChangeLog.md b/app/vendor/sebastian/global-state/ChangeLog.md index 67830261b..aea37f8bb 100644 --- a/app/vendor/sebastian/global-state/ChangeLog.md +++ b/app/vendor/sebastian/global-state/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes in `sebastian/global-state` are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. +## [9.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [8.0.2] - 2025-08-29 ### Changed @@ -128,6 +134,7 @@ All notable changes in `sebastian/global-state` are documented in this file usin * This component is no longer supported on PHP 7.0 and PHP 7.1 +[9.0.0]: https://github.com/sebastianbergmann/global-state/compare/8.0...9.0.0 [8.0.2]: https://github.com/sebastianbergmann/global-state/compare/8.0.1...8.0.2 [8.0.1]: https://github.com/sebastianbergmann/global-state/compare/8.0.0...8.0.1 [8.0.0]: https://github.com/sebastianbergmann/global-state/compare/7.0...8.0.0 diff --git a/app/vendor/sebastian/global-state/LICENSE b/app/vendor/sebastian/global-state/LICENSE index b687f39ac..83489d635 100644 --- a/app/vendor/sebastian/global-state/LICENSE +++ b/app/vendor/sebastian/global-state/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2001-2025, Sebastian Bergmann +Copyright (c) 2001-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/global-state/composer.json b/app/vendor/sebastian/global-state/composer.json index ecd4b53ea..c7583014e 100644 --- a/app/vendor/sebastian/global-state/composer.json +++ b/app/vendor/sebastian/global-state/composer.json @@ -17,19 +17,19 @@ "prefer-stable": true, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "require": { - "php": ">=8.3", - "sebastian/object-reflector": "^5.0", - "sebastian/recursion-context": "^7.0" + "php": ">=8.4", + "sebastian/object-reflector": "^6.0", + "sebastian/recursion-context": "^8.0" }, "require-dev": { "ext-dom": "*", - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "autoload": { "classmap": [ @@ -46,7 +46,7 @@ }, "extra": { "branch-alias": { - "dev-main": "8.0-dev" + "dev-main": "9.0-dev" } } } diff --git a/app/vendor/sebastian/global-state/src/Restorer.php b/app/vendor/sebastian/global-state/src/Restorer.php index 36fcd21ae..f98ef097b 100644 --- a/app/vendor/sebastian/global-state/src/Restorer.php +++ b/app/vendor/sebastian/global-state/src/Restorer.php @@ -14,8 +14,10 @@ use function array_keys; use function array_merge; use function assert; +use function class_exists; use function in_array; use function is_array; +use function property_exists; use ReflectionClass; use ReflectionProperty; @@ -53,6 +55,9 @@ public function restoreStaticProperties(Snapshot $snapshot): void foreach ($snapshot->staticProperties() as $className => $staticProperties) { foreach ($staticProperties as $name => $value) { + assert(class_exists($className)); + assert(property_exists($className, $name)); + $reflector = new ReflectionProperty($className, $name); $reflector->setValue(null, $value); } diff --git a/app/vendor/sebastian/lines-of-code/ChangeLog.md b/app/vendor/sebastian/lines-of-code/ChangeLog.md index 4e724be6f..407b72423 100644 --- a/app/vendor/sebastian/lines-of-code/ChangeLog.md +++ b/app/vendor/sebastian/lines-of-code/ChangeLog.md @@ -2,6 +2,24 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. +## [5.0.1] - 2026-05-19 + +### Fixed + +* [#6](https://github.com/sebastianbergmann/lines-of-code/issues/6): Lines with multiple comments are double-counted, yielding negative `$nonCommentLinesOfCode` + +## [5.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + +## [4.0.1] - 2026-05-19 + +### Fixed + +* [#6](https://github.com/sebastianbergmann/lines-of-code/issues/6): Lines with multiple comments are double-counted, yielding negative `$nonCommentLinesOfCode` + ## [4.0.0] - 2025-02-07 ### Removed @@ -65,6 +83,9 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Initial release +[5.0.1]: https://github.com/sebastianbergmann/lines-of-code/compare/5.0.0...5.0.1 +[5.0.0]: https://github.com/sebastianbergmann/lines-of-code/compare/4.0...5.0.0 +[4.0.1]: https://github.com/sebastianbergmann/lines-of-code/compare/4.0.0...4.0.1 [4.0.0]: https://github.com/sebastianbergmann/lines-of-code/compare/3.0...4.0.0 [3.0.1]: https://github.com/sebastianbergmann/lines-of-code/compare/3.0.0...3.0.1 [3.0.0]: https://github.com/sebastianbergmann/lines-of-code/compare/2.0...3.0.0 diff --git a/app/vendor/sebastian/lines-of-code/LICENSE b/app/vendor/sebastian/lines-of-code/LICENSE index 0d534da34..a48fe5da4 100644 --- a/app/vendor/sebastian/lines-of-code/LICENSE +++ b/app/vendor/sebastian/lines-of-code/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2020-2025, Sebastian Bergmann +Copyright (c) 2020-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/lines-of-code/SECURITY.md b/app/vendor/sebastian/lines-of-code/SECURITY.md index d88ff0019..af0c5a4fd 100644 --- a/app/vendor/sebastian/lines-of-code/SECURITY.md +++ b/app/vendor/sebastian/lines-of-code/SECURITY.md @@ -1,30 +1,10 @@ # Security Policy -If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure. +The library that is developed in this repository is a first-party dependency of [PHPUnit](https://github.com/sebastianbergmann/phpunit). +[PHPUnit's Security Policy](https://github.com/sebastianbergmann/phpunit/security/policy) applies to this library as well. -**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** - -Instead, please email `sebastian@phpunit.de`. - -Please include as much of the information listed below as you can to help us better understand and resolve the issue: - -* The type of issue -* Full paths of source file(s) related to the manifestation of the issue -* The location of the affected source code (tag/branch/commit or direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the issue - -This information will help us triage your report more quickly. +If you believe you have found a security vulnerability in this library, please report it to me through coordinated disclosure. -## Web Context - -The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit. - -The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes. - -If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. - -Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. +Use my [PGP key](https://sebastian-bergmann.de/gpg.asc) for encrypted email, for example when your report includes proof-of-concept exploits against third-party systems. +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** diff --git a/app/vendor/sebastian/lines-of-code/composer.json b/app/vendor/sebastian/lines-of-code/composer.json index 7c428050f..82e403cec 100644 --- a/app/vendor/sebastian/lines-of-code/composer.json +++ b/app/vendor/sebastian/lines-of-code/composer.json @@ -17,15 +17,15 @@ }, "prefer-stable": true, "require": { - "php": ">=8.3", - "nikic/php-parser": "^5.0" + "php": ">=8.4", + "nikic/php-parser": "^5.7.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "config": { "platform": { - "php": "8.3" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true @@ -37,7 +37,7 @@ }, "extra": { "branch-alias": { - "dev-main": "4.0-dev" + "dev-main": "5.0-dev" } } } diff --git a/app/vendor/sebastian/lines-of-code/src/Counter.php b/app/vendor/sebastian/lines-of-code/src/Counter.php index ed2d3ab0e..273ec565c 100644 --- a/app/vendor/sebastian/lines-of-code/src/Counter.php +++ b/app/vendor/sebastian/lines-of-code/src/Counter.php @@ -38,7 +38,7 @@ public function countInSourceString(string $source): LinesOfCode { $linesOfCode = substr_count($source, "\n"); - if ($linesOfCode === 0 && !empty($source)) { + if ($linesOfCode === 0 && $source !== '') { $linesOfCode = 1; } diff --git a/app/vendor/sebastian/lines-of-code/src/LineCountingVisitor.php b/app/vendor/sebastian/lines-of-code/src/LineCountingVisitor.php index a461a98a9..66d17cf5a 100644 --- a/app/vendor/sebastian/lines-of-code/src/LineCountingVisitor.php +++ b/app/vendor/sebastian/lines-of-code/src/LineCountingVisitor.php @@ -58,16 +58,18 @@ public function enterNode(Node $node): null public function result(): LinesOfCode { - $commentLinesOfCode = 0; + $commentLines = []; foreach ($this->comments() as $comment) { - $commentLinesOfCode += ($comment->getEndLine() - $comment->getStartLine() + 1); + for ($line = $comment->getStartLine(); $line <= $comment->getEndLine(); $line++) { + $commentLines[$line] = true; + } } + $commentLinesOfCode = count($commentLines); $nonCommentLinesOfCode = $this->linesOfCode - $commentLinesOfCode; $logicalLinesOfCode = count(array_unique($this->linesWithStatements)); - assert($commentLinesOfCode >= 0); assert($nonCommentLinesOfCode >= 0); return new LinesOfCode( diff --git a/app/vendor/sebastian/object-enumerator/ChangeLog.md b/app/vendor/sebastian/object-enumerator/ChangeLog.md index 611c42d90..c90c02d1a 100644 --- a/app/vendor/sebastian/object-enumerator/ChangeLog.md +++ b/app/vendor/sebastian/object-enumerator/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes to `sebastianbergmann/object-enumerator` are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. +## [8.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [7.0.0] - 2025-02-07 ### Removed @@ -98,6 +104,7 @@ All notable changes to `sebastianbergmann/object-enumerator` are documented in t * Initial release +[8.0.0]: https://github.com/sebastianbergmann/object-enumerator/compare/7.0...8.0.0 [7.0.0]: https://github.com/sebastianbergmann/object-enumerator/compare/6.0...7.0.0 [6.0.1]: https://github.com/sebastianbergmann/object-enumerator/compare/6.0.0...6.0.1 [6.0.0]: https://github.com/sebastianbergmann/object-enumerator/compare/5.0...6.0.0 diff --git a/app/vendor/sebastian/object-enumerator/LICENSE b/app/vendor/sebastian/object-enumerator/LICENSE index ec89362e1..459cfed03 100644 --- a/app/vendor/sebastian/object-enumerator/LICENSE +++ b/app/vendor/sebastian/object-enumerator/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2016-2025, Sebastian Bergmann +Copyright (c) 2016-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/object-enumerator/composer.json b/app/vendor/sebastian/object-enumerator/composer.json index 442e002e0..305939e13 100644 --- a/app/vendor/sebastian/object-enumerator/composer.json +++ b/app/vendor/sebastian/object-enumerator/composer.json @@ -16,18 +16,18 @@ "prefer-stable": true, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "require": { - "php": ">=8.3", - "sebastian/object-reflector": "^5.0", - "sebastian/recursion-context": "^7.0" + "php": ">=8.4", + "sebastian/object-reflector": "^6.0", + "sebastian/recursion-context": "^8.0" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "autoload": { "classmap": [ @@ -41,7 +41,7 @@ }, "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.0-dev" } } } diff --git a/app/vendor/sebastian/object-enumerator/src/Enumerator.php b/app/vendor/sebastian/object-enumerator/src/Enumerator.php index d67d86347..2e4ae2043 100644 --- a/app/vendor/sebastian/object-enumerator/src/Enumerator.php +++ b/app/vendor/sebastian/object-enumerator/src/Enumerator.php @@ -26,7 +26,7 @@ public function enumerate(array|object $variable, Context $processed = new Conte { $objects = []; - if ($processed->contains($variable)) { + if ($processed->contains($variable) !== false) { return $objects; } diff --git a/app/vendor/sebastian/object-reflector/ChangeLog.md b/app/vendor/sebastian/object-reflector/ChangeLog.md index ddc1ed642..24d25d582 100644 --- a/app/vendor/sebastian/object-reflector/ChangeLog.md +++ b/app/vendor/sebastian/object-reflector/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes to `sebastianbergmann/object-reflector` are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. +## [6.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [5.0.0] - 2025-02-07 ### Removed @@ -74,6 +80,7 @@ All notable changes to `sebastianbergmann/object-reflector` are documented in th * Initial release +[6.0.0]: https://github.com/sebastianbergmann/object-reflector/compare/5.0...6.0.0 [5.0.0]: https://github.com/sebastianbergmann/object-reflector/compare/4.0...5.0.0 [4.0.1]: https://github.com/sebastianbergmann/object-reflector/compare/4.0.0...4.0.1 [4.0.0]: https://github.com/sebastianbergmann/object-reflector/compare/3.0...4.0.0 diff --git a/app/vendor/sebastian/object-reflector/LICENSE b/app/vendor/sebastian/object-reflector/LICENSE index e148db3fc..bf7f11ba6 100644 --- a/app/vendor/sebastian/object-reflector/LICENSE +++ b/app/vendor/sebastian/object-reflector/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2017-2025, Sebastian Bergmann +Copyright (c) 2017-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/object-reflector/composer.json b/app/vendor/sebastian/object-reflector/composer.json index d9286e951..26796d0d5 100644 --- a/app/vendor/sebastian/object-reflector/composer.json +++ b/app/vendor/sebastian/object-reflector/composer.json @@ -16,16 +16,16 @@ "prefer-stable": true, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "autoload": { "classmap": [ @@ -39,7 +39,7 @@ }, "extra": { "branch-alias": { - "dev-main": "5.0-dev" + "dev-main": "6.0-dev" } } } diff --git a/app/vendor/sebastian/recursion-context/ChangeLog.md b/app/vendor/sebastian/recursion-context/ChangeLog.md index 854244fa4..2fe93948d 100644 --- a/app/vendor/sebastian/recursion-context/ChangeLog.md +++ b/app/vendor/sebastian/recursion-context/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. +## [8.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [7.0.1] - 2025-08-13 ### Changed @@ -81,6 +87,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Tests etc. are now ignored for archive exports +[8.0.0]: https://github.com/sebastianbergmann/recursion-context/compare/7.0...8.0.0 [7.0.1]: https://github.com/sebastianbergmann/recursion-context/compare/7.0.0...7.0.1 [7.0.0]: https://github.com/sebastianbergmann/recursion-context/compare/6.0...7.0.0 [6.0.3]: https://github.com/sebastianbergmann/recursion-context/compare/6.0.2...6.0.3 diff --git a/app/vendor/sebastian/recursion-context/LICENSE b/app/vendor/sebastian/recursion-context/LICENSE index c5268a916..0fad16fc6 100644 --- a/app/vendor/sebastian/recursion-context/LICENSE +++ b/app/vendor/sebastian/recursion-context/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2002-2025, Sebastian Bergmann +Copyright (c) 2002-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/recursion-context/composer.json b/app/vendor/sebastian/recursion-context/composer.json index f37a207b3..982937484 100644 --- a/app/vendor/sebastian/recursion-context/composer.json +++ b/app/vendor/sebastian/recursion-context/composer.json @@ -24,16 +24,16 @@ "prefer-stable": true, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.0" }, "autoload": { "classmap": [ @@ -42,7 +42,7 @@ }, "extra": { "branch-alias": { - "dev-main": "7.0-dev" + "dev-main": "8.0-dev" } } } diff --git a/app/vendor/sebastian/type/ChangeLog.md b/app/vendor/sebastian/type/ChangeLog.md index e4a200d55..7179ddbd8 100644 --- a/app/vendor/sebastian/type/ChangeLog.md +++ b/app/vendor/sebastian/type/ChangeLog.md @@ -2,6 +2,24 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](http://keepachangelog.com/) principles. +## [7.0.1] - 2026-05-20 + +### Fixed + +* [#18](https://github.com/sebastianbergmann/type/issues/18): Class aliases are not resolved when checking type assignability + +## [7.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + +## [6.0.4] - 2026-05-20 + +### Fixed + +* [#18](https://github.com/sebastianbergmann/type/issues/18): Class aliases are not resolved when checking type assignability + ## [6.0.3] - 2025-08-09 ### Fixed @@ -213,6 +231,9 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * Initial release based on [code contributed by Michel Hartmann to PHPUnit](https://github.com/sebastianbergmann/phpunit/pull/3673) +[7.0.1]: https://github.com/sebastianbergmann/type/compare/7.0.0...7.0.1 +[7.0.0]: https://github.com/sebastianbergmann/type/compare/6.0...7.0.0 +[6.0.4]: https://github.com/sebastianbergmann/type/compare/6.0.3...6.0.4 [6.0.3]: https://github.com/sebastianbergmann/type/compare/6.0.2...6.0.3 [6.0.2]: https://github.com/sebastianbergmann/type/compare/6.0.1...6.0.2 [6.0.1]: https://github.com/sebastianbergmann/type/compare/6.0.0...6.0.1 diff --git a/app/vendor/sebastian/type/LICENSE b/app/vendor/sebastian/type/LICENSE index 84a832212..cd8235457 100644 --- a/app/vendor/sebastian/type/LICENSE +++ b/app/vendor/sebastian/type/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2019-2025, Sebastian Bergmann +Copyright (c) 2019-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/type/SECURITY.md b/app/vendor/sebastian/type/SECURITY.md index d88ff0019..af0c5a4fd 100644 --- a/app/vendor/sebastian/type/SECURITY.md +++ b/app/vendor/sebastian/type/SECURITY.md @@ -1,30 +1,10 @@ # Security Policy -If you believe you have found a security vulnerability in the library that is developed in this repository, please report it to us through coordinated disclosure. +The library that is developed in this repository is a first-party dependency of [PHPUnit](https://github.com/sebastianbergmann/phpunit). +[PHPUnit's Security Policy](https://github.com/sebastianbergmann/phpunit/security/policy) applies to this library as well. -**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** - -Instead, please email `sebastian@phpunit.de`. - -Please include as much of the information listed below as you can to help us better understand and resolve the issue: - -* The type of issue -* Full paths of source file(s) related to the manifestation of the issue -* The location of the affected source code (tag/branch/commit or direct URL) -* Any special configuration required to reproduce the issue -* Step-by-step instructions to reproduce the issue -* Proof-of-concept or exploit code (if possible) -* Impact of the issue, including how an attacker might exploit the issue - -This information will help us triage your report more quickly. +If you believe you have found a security vulnerability in this library, please report it to me through coordinated disclosure. -## Web Context - -The library that is developed in this repository was either extracted from [PHPUnit](https://github.com/sebastianbergmann/phpunit) or developed specifically as a dependency for PHPUnit. - -The library is developed with a focus on development environments and the command-line. No specific testing or hardening with regard to using the library in an HTTP or web context or with untrusted input data is performed. The library might also contain functionality that intentionally exposes internal application data for debugging purposes. - -If the library is used in a web application, the application developer is responsible for filtering inputs or escaping outputs as necessary and for verifying that the used functionality is safe for use within the intended context. - -Vulnerabilities specific to the use outside a development context will be fixed as applicable, provided that the fix does not have an averse effect on the primary use case for development purposes. +Use my [PGP key](https://sebastian-bergmann.de/gpg.asc) for encrypted email, for example when your report includes proof-of-concept exploits against third-party systems. +**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.** diff --git a/app/vendor/sebastian/type/composer.json b/app/vendor/sebastian/type/composer.json index e5b966df5..36381cfa0 100644 --- a/app/vendor/sebastian/type/composer.json +++ b/app/vendor/sebastian/type/composer.json @@ -17,14 +17,14 @@ }, "prefer-stable": true, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "require-dev": { - "phpunit/phpunit": "^12.0" + "phpunit/phpunit": "^13.1.10" }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true @@ -40,12 +40,13 @@ ], "files": [ "tests/_fixture/callback_function.php", + "tests/_fixture/class_alias.php", "tests/_fixture/functions_that_declare_return_types.php" ] }, "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } } } diff --git a/app/vendor/sebastian/type/src/type/CallableType.php b/app/vendor/sebastian/type/src/type/CallableType.php index dbe355488..389dd378c 100644 --- a/app/vendor/sebastian/type/src/type/CallableType.php +++ b/app/vendor/sebastian/type/src/type/CallableType.php @@ -100,7 +100,7 @@ private function hasInvokeMethod(ObjectType $type): bool assert(class_exists($className)); - return (new ReflectionClass($className))->hasMethod('__invoke'); + return new ReflectionClass($className)->hasMethod('__invoke'); } private function isFunction(SimpleType $type): bool @@ -132,7 +132,7 @@ private function isObjectCallback(SimpleType $type): bool [$object, $methodName] = $type->value(); - return (new ReflectionObject($object))->hasMethod($methodName); + return new ReflectionObject($object)->hasMethod($methodName); } private function isClassCallback(SimpleType $type): bool diff --git a/app/vendor/sebastian/type/src/type/IterableType.php b/app/vendor/sebastian/type/src/type/IterableType.php index 608ddc581..98f444f3f 100644 --- a/app/vendor/sebastian/type/src/type/IterableType.php +++ b/app/vendor/sebastian/type/src/type/IterableType.php @@ -48,7 +48,7 @@ public function isAssignable(Type $other): bool assert(class_exists($className)); - return (new ReflectionClass($className))->isIterable(); + return new ReflectionClass($className)->isIterable(); } return false; diff --git a/app/vendor/sebastian/type/src/type/ObjectType.php b/app/vendor/sebastian/type/src/type/ObjectType.php index 4ff4592ea..cd2149fc7 100644 --- a/app/vendor/sebastian/type/src/type/ObjectType.php +++ b/app/vendor/sebastian/type/src/type/ObjectType.php @@ -9,8 +9,11 @@ */ namespace SebastianBergmann\Type; +use function class_exists; +use function interface_exists; use function is_subclass_of; use function strcasecmp; +use ReflectionClass; /** * @no-named-arguments Parameter names are not covered by the backward compatibility promise for this library @@ -33,11 +36,14 @@ public function isAssignable(Type $other): bool } if ($other instanceof self) { - if (0 === strcasecmp($this->className->qualifiedName(), $other->className->qualifiedName())) { + $thisName = $this->canonicalClassName($this->className->qualifiedName()); + $otherName = $this->canonicalClassName($other->className->qualifiedName()); + + if (strcasecmp($thisName, $otherName) === 0) { return true; } - if (is_subclass_of($other->className->qualifiedName(), $this->className->qualifiedName(), true)) { + if (is_subclass_of($otherName, $thisName, true)) { return true; } } @@ -67,4 +73,18 @@ public function isObject(): bool { return true; } + + /** + * @param non-empty-string $name + * + * @return non-empty-string + */ + private function canonicalClassName(string $name): string + { + if (class_exists($name) || interface_exists($name)) { + return (new ReflectionClass($name))->getName(); + } + + return $name; + } } diff --git a/app/vendor/sebastian/type/src/type/SimpleType.php b/app/vendor/sebastian/type/src/type/SimpleType.php index b242b5cbe..1e6e1c03f 100644 --- a/app/vendor/sebastian/type/src/type/SimpleType.php +++ b/app/vendor/sebastian/type/src/type/SimpleType.php @@ -87,11 +87,11 @@ private function normalize(string $name): string $name = strtolower($name); return match ($name) { - 'boolean' => 'bool', + 'boolean' => 'bool', 'real', 'double' => 'float', - 'integer' => 'int', - '[]' => 'array', - default => $name, + 'integer' => 'int', + '[]' => 'array', + default => $name, }; } } diff --git a/app/vendor/sebastian/type/src/type/Type.php b/app/vendor/sebastian/type/src/type/Type.php index 0dee63f53..82ebb37a6 100644 --- a/app/vendor/sebastian/type/src/type/Type.php +++ b/app/vendor/sebastian/type/src/type/Type.php @@ -51,17 +51,17 @@ public static function fromValue(mixed $value, bool $allowsNull): self public static function fromName(string $typeName, bool $allowsNull): self { return match (strtolower($typeName)) { - 'callable' => new CallableType($allowsNull), - 'true' => new TrueType, - 'false' => new FalseType, - 'iterable' => new IterableType($allowsNull), - 'never' => new NeverType, - 'null' => new NullType, - 'object' => new GenericObjectType($allowsNull), - 'unknown type' => new UnknownType, - 'void' => new VoidType, + 'callable' => new CallableType($allowsNull), + 'true' => new TrueType, + 'false' => new FalseType, + 'iterable' => new IterableType($allowsNull), + 'never' => new NeverType, + 'null' => new NullType, + 'object' => new GenericObjectType($allowsNull), + 'unknown type' => new UnknownType, + 'void' => new VoidType, 'array', 'bool', 'boolean', 'double', 'float', 'int', 'integer', 'real', 'resource', 'resource (closed)', 'string' => new SimpleType($typeName, $allowsNull), - 'mixed' => new MixedType, + 'mixed' => new MixedType, /** @phpstan-ignore argument.type */ default => new ObjectType(TypeName::fromQualifiedName($typeName), $allowsNull), }; diff --git a/app/vendor/sebastian/type/src/type/UnionType.php b/app/vendor/sebastian/type/src/type/UnionType.php index 82eec56e5..2291236fe 100644 --- a/app/vendor/sebastian/type/src/type/UnionType.php +++ b/app/vendor/sebastian/type/src/type/UnionType.php @@ -9,6 +9,7 @@ */ namespace SebastianBergmann\Type; +use function array_any; use function assert; use function count; use function implode; @@ -39,13 +40,7 @@ public function __construct(Type ...$types) public function isAssignable(Type $other): bool { - foreach ($this->types as $type) { - if ($type->isAssignable($other)) { - return true; - } - } - - return false; + return array_any($this->types, static fn (Type $type) => $type->isAssignable($other)); } /** @@ -80,13 +75,7 @@ public function name(): string public function allowsNull(): bool { - foreach ($this->types as $type) { - if ($type instanceof NullType) { - return true; - } - } - - return false; + return array_any($this->types, static fn (Type $type) => $type instanceof NullType); } public function isUnion(): bool @@ -96,13 +85,7 @@ public function isUnion(): bool public function containsIntersectionTypes(): bool { - foreach ($this->types as $type) { - if ($type->isIntersection()) { - return true; - } - } - - return false; + return array_any($this->types, static fn (Type $type) => $type->isIntersection()); } /** diff --git a/app/vendor/sebastian/version/ChangeLog.md b/app/vendor/sebastian/version/ChangeLog.md index 53706bf0f..d761d34d2 100644 --- a/app/vendor/sebastian/version/ChangeLog.md +++ b/app/vendor/sebastian/version/ChangeLog.md @@ -2,6 +2,12 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](https://keepachangelog.com/) principles. +## [7.0.0] - 2026-02-06 + +### Removed + +* This component is no longer supported on PHP 8.3 + ## [6.0.0] - 2025-02-07 ### Removed @@ -60,6 +66,7 @@ All notable changes are documented in this file using the [Keep a CHANGELOG](htt * This component is no longer supported on PHP 7.1 and PHP 7.2 +[7.0.0]: https://github.com/sebastianbergmann/version/compare/6.0...7.0.0 [6.0.0]: https://github.com/sebastianbergmann/version/compare/5.0...6.0.0 [5.0.2]: https://github.com/sebastianbergmann/version/compare/5.0.1...5.0.2 [5.0.1]: https://github.com/sebastianbergmann/version/compare/5.0.0...5.0.1 diff --git a/app/vendor/sebastian/version/LICENSE b/app/vendor/sebastian/version/LICENSE index 42f4747e3..aac148b93 100644 --- a/app/vendor/sebastian/version/LICENSE +++ b/app/vendor/sebastian/version/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2013-2025, Sebastian Bergmann +Copyright (c) 2013-2026, Sebastian Bergmann All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/app/vendor/sebastian/version/composer.json b/app/vendor/sebastian/version/composer.json index 9ba2b85af..680f6eac9 100644 --- a/app/vendor/sebastian/version/composer.json +++ b/app/vendor/sebastian/version/composer.json @@ -16,14 +16,14 @@ }, "config": { "platform": { - "php": "8.3.0" + "php": "8.4.1" }, "optimize-autoloader": true, "sort-packages": true }, "prefer-stable": true, "require": { - "php": ">=8.3" + "php": ">=8.4" }, "autoload": { "classmap": [ @@ -32,7 +32,7 @@ }, "extra": { "branch-alias": { - "dev-main": "6.0-dev" + "dev-main": "7.0-dev" } } } diff --git a/app/vendor/sebastian/version/src/Version.php b/app/vendor/sebastian/version/src/Version.php index 0fd9def7f..19a374f9d 100644 --- a/app/vendor/sebastian/version/src/Version.php +++ b/app/vendor/sebastian/version/src/Version.php @@ -14,7 +14,6 @@ use function end; use function explode; use function fclose; -use function is_array; use function is_dir; use function is_resource; use function proc_close; @@ -63,7 +62,7 @@ private function generate(string $release, string $path): string $git = $this->getGitInformation($path); - if (!$git) { + if ($git === false) { return $version; } @@ -78,6 +77,8 @@ private function generate(string $release, string $path): string /** * @param non-empty-string $path + * + * @return false|non-empty-string */ private function getGitInformation(string $path): false|string { @@ -99,7 +100,6 @@ private function getGitInformation(string $path): false|string return false; } - assert(is_array($pipes)); assert(isset($pipes[1]) && is_resource($pipes[1])); assert(isset($pipes[2]) && is_resource($pipes[2])); @@ -114,6 +114,8 @@ private function getGitInformation(string $path): false|string return false; } + assert($result !== ''); + return $result; } } diff --git a/app/vendor/slevomat/coding-standard/README.md b/app/vendor/slevomat/coding-standard/README.md index 38369031d..e65a3dafc 100644 --- a/app/vendor/slevomat/coding-standard/README.md +++ b/app/vendor/slevomat/coding-standard/README.md @@ -43,6 +43,7 @@ Slevomat Coding Standard for [PHP_CodeSniffer](https://github.com/PHPCSStandards - [SlevomatCodingStandard.Attributes.RequireAttributeAfterDocComment](doc/attributes.md#slevomatcodingstandardattributesrequireattributeafterdoccomment-) 🔧 - [SlevomatCodingStandard.Classes.BackedEnumTypeSpacing](doc/classes.md#slevomatcodingstandardclassesbackedenumtypespacing-) 🔧 - [SlevomatCodingStandard.Classes.ClassConstantVisibility](doc/classes.md#slevomatcodingstandardclassesclassconstantvisibility-) 🔧 + - [SlevomatCodingStandard.Classes.ClassKeywordOrder](doc/classes.md#slevomatcodingstandardclassesclasskeywordorder-) 🔧 - [SlevomatCodingStandard.Classes.ClassLength](doc/classes.md#slevomatcodingstandardclassesclasslength) - [SlevomatCodingStandard.Classes.ClassMemberSpacing](doc/classes.md#slevomatcodingstandardclassesclassmemberspacing-) 🔧 - [SlevomatCodingStandard.Classes.ClassStructure](doc/classes.md#slevomatcodingstandardclassesclassstructure-) 🔧 @@ -71,6 +72,7 @@ Slevomat Coding Standard for [PHP_CodeSniffer](https://github.com/PHPCSStandards - [SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming](doc/classes.md#slevomatcodingstandardclassessuperfluousinterfacenaming) - [SlevomatCodingStandard.Classes.SuperfluousTraitNaming](doc/classes.md#slevomatcodingstandardclassessuperfluoustraitnaming) - [SlevomatCodingStandard.Classes.TraitUseDeclaration](doc/classes.md#slevomatcodingstandardclassestraitusedeclaration-) 🔧 + - [SlevomatCodingStandard.Classes.TraitUseOrder](doc/classes.md#slevomatcodingstandardclassestraituseorder-) 🔧 - [SlevomatCodingStandard.Classes.TraitUseSpacing](doc/classes.md#slevomatcodingstandardclassestraitusespacing-) 🔧 - [SlevomatCodingStandard.Classes.UselessLateStaticBinding](doc/classes.md#slevomatcodingstandardclassesuselesslatestaticbinding-) 🔧 - [SlevomatCodingStandard.Commenting.AnnotationName](doc/commenting.md#slevomatcodingstandardcommentingannotationname-) @@ -82,8 +84,10 @@ Slevomat Coding Standard for [PHP_CodeSniffer](https://github.com/PHPCSStandards - [SlevomatCodingStandard.Commenting.ForbiddenAnnotations](doc/commenting.md#slevomatcodingstandardcommentingforbiddenannotations-) 🔧 - [SlevomatCodingStandard.Commenting.ForbiddenComments](doc/commenting.md#slevomatcodingstandardcommentingforbiddencomments-) 🔧 - [SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration](doc/commenting.md#slevomatcodingstandardcommentinginlinedoccommentdeclaration-) 🔧 + - [SlevomatCodingStandard.Commenting.RequireOneDocComment](doc/commenting.md#slevomatcodingstandardcommentingrequireonedoccomment-) 🔧 - [SlevomatCodingStandard.Commenting.RequireOneLineDocComment](doc/commenting.md#slevomatcodingstandardcommentingrequireonelinedoccomment-) 🔧 - [SlevomatCodingStandard.Commenting.RequireOneLinePropertyDocComment](doc/commenting.md#slevomatcodingstandardcommentingrequireonelinepropertydoccomment-) 🔧 + - [SlevomatCodingStandard.Commenting.ThrowsAnnotationsOrder](doc/commenting.md#slevomatcodingstandardcommentingthrowsannotationsorder-) 🔧 - [SlevomatCodingStandard.Commenting.UselessFunctionDocComment](doc/commenting.md#slevomatcodingstandardcommentinguselessfunctiondoccomment-) 🔧 - [SlevomatCodingStandard.Commenting.UselessInheritDocComment](doc/commenting.md#slevomatcodingstandardcommentinguselessinheritdoccomment-) 🔧 - [SlevomatCodingStandard.Complexity.Cognitive](doc/complexity.md#slevomatcodingstandardcomplexitycognitive) @@ -112,6 +116,7 @@ Slevomat Coding Standard for [PHP_CodeSniffer](https://github.com/PHPCSStandards - [SlevomatCodingStandard.ControlStructures.UselessIfConditionWithReturn](doc/control-structures.md#slevomatcodingstandardcontrolstructuresuselessifconditionwithreturn-) 🔧 - [SlevomatCodingStandard.ControlStructures.UselessTernaryOperator](doc/control-structures.md#slevomatcodingstandardcontrolstructuresuselessternaryoperator-) 🔧 - [SlevomatCodingStandard.Exceptions.DeadCatch](doc/exceptions.md#slevomatcodingstandardexceptionsdeadcatch) + - [SlevomatCodingStandard.Exceptions.CatchExceptionsOrder](doc/exceptions.md#slevomatcodingstandardexceptionscatchexceptionsorder-) 🔧 - [SlevomatCodingStandard.Exceptions.DisallowNonCapturingCatch](doc/exceptions.md#slevomatcodingstandardexceptionsdisallownoncapturingcatch) - [SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly](doc/exceptions.md#slevomatcodingstandardexceptionsreferencethrowableonly-) 🔧🚧 - [SlevomatCodingStandard.Exceptions.RequireNonCapturingCatch](doc/exceptions.md#slevomatcodingstandardexceptionsrequirenoncapturingcatch-) 🔧 diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationHelper.php index ebce8e72b..afc7d5603 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationHelper.php @@ -286,7 +286,7 @@ public static function isAnnotationUseless( ['true', 'false', 'null'], true, )) { - return $enableStandaloneNullTrueFalseTypeHints; + return $typeHint->getTypeHint() === strtolower($annotationType->name) ? $enableStandaloneNullTrueFalseTypeHints : false; } if (TypeHintHelper::isSimpleUnofficialTypeHints( diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationTypeHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationTypeHelper.php index 972b47337..c8eeb3c40 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationTypeHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/AnnotationTypeHelper.php @@ -227,6 +227,10 @@ public static function containsItemsSpecificationForTraversable( ); } + if ($typeNode instanceof ThisTypeNode) { + return $inTraversable; + } + if ($typeNode instanceof ConstTypeNode) { return $inTraversable; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/CommentHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/CommentHelper.php index 09b6e676c..f7705aa87 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/CommentHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/CommentHelper.php @@ -46,7 +46,7 @@ public static function getCommentEndPointer(File $phpcsFile, int $commentStartPo continue; } - if (in_array($tokens[$i]['code'], Tokens::$phpcsCommentTokens, true)) { + if (in_array($tokens[$i]['code'], Tokens::PHPCS_ANNOTATION_TOKENS, true)) { $commentEndPointer = $i; continue; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ConditionHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ConditionHelper.php index cdab8e916..3af37bd63 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ConditionHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ConditionHelper.php @@ -32,9 +32,6 @@ use const T_LOGICAL_OR; use const T_LOGICAL_XOR; use const T_OPEN_PARENTHESIS; -use const T_PARENT; -use const T_SELF; -use const T_STATIC; use const T_STRING; use const T_VARIABLE; @@ -67,8 +64,8 @@ public static function conditionReturnsBoolean( $phpcsFile, array_merge( [T_OPEN_PARENTHESIS, T_LESS_THAN, T_GREATER_THAN], - Tokens::$booleanOperators, - Tokens::$equalityTokens, + Tokens::BOOLEAN_OPERATORS, + Tokens::EQUALITY_TOKENS, ), $actualPointer, $conditionBoundaryEndPointer + 1, @@ -154,7 +151,7 @@ private static function getNegativeConditionPart( $pointerAfterConditionStart = TokenHelper::findNextEffective($phpcsFile, $conditionBoundaryStartPointer); $booleanPointers = TokenHelper::findNextAll( $phpcsFile, - Tokens::$booleanOperators, + Tokens::BOOLEAN_OPERATORS, $conditionBoundaryStartPointer, $conditionBoundaryEndPointer + 1, ); @@ -211,7 +208,7 @@ private static function getNegativeConditionPart( } } - if (in_array($tokens[$pointerAfterConditionStart]['code'], [T_VARIABLE, T_SELF, T_STATIC, T_PARENT], true)) { + if (in_array($tokens[$pointerAfterConditionStart]['code'], [T_VARIABLE, ...TokenHelper::CLASS_KEYWORD_CODES], true)) { $identificatorEndPointer = IdentificatorHelper::findEndPointer($phpcsFile, $pointerAfterConditionStart); $pointerAfterIdentificatorEnd = TokenHelper::findNextEffective($phpcsFile, $identificatorEndPointer + 1); if ( @@ -295,7 +292,7 @@ private static function getNegativeLogicalCondition( do { $actualPointer = TokenHelper::findNext( $phpcsFile, - array_merge([T_OPEN_PARENTHESIS, T_CLOSE_PARENTHESIS], Tokens::$booleanOperators), + array_merge([T_OPEN_PARENTHESIS, T_CLOSE_PARENTHESIS], Tokens::BOOLEAN_OPERATORS), $actualPointer, $conditionBoundaryEndPointer + 1, ); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/DocCommentHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/DocCommentHelper.php index d1e6cd8b2..dbdaa290d 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/DocCommentHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/DocCommentHelper.php @@ -14,9 +14,7 @@ use function stripos; use function strtolower; use function trim; -use const T_ABSTRACT; use const T_ATTRIBUTE; -use const T_CLASS; use const T_CLOSE_CURLY_BRACKET; use const T_CONST; use const T_DOC_COMMENT_CLOSE_TAG; @@ -25,21 +23,10 @@ use const T_DOC_COMMENT_STRING; use const T_DOC_COMMENT_TAG; use const T_DOC_COMMENT_WHITESPACE; -use const T_ENUM; -use const T_FINAL; use const T_FUNCTION; -use const T_INTERFACE; use const T_OPEN_CURLY_BRACKET; -use const T_PRIVATE; -use const T_PROTECTED; -use const T_PUBLIC; -use const T_READONLY; use const T_SEMICOLON; -use const T_STATIC; -use const T_TRAIT; -use const T_VAR; use const T_VARIABLE; -use const T_WHITESPACE; /** * @internal @@ -183,38 +170,36 @@ public static function findDocCommentOwnerPointer(File $phpcsFile, int $docComme { $tokens = $phpcsFile->getTokens(); - $docCommentCloserPointer = $tokens[$docCommentOpenPointer]['comment_closer']; - if (self::isInline($phpcsFile, $docCommentOpenPointer)) { return null; } $docCommentOwnerPointer = null; - for ($i = $docCommentCloserPointer + 1; $i < count($tokens); $i++) { - if ($tokens[$i]['code'] === T_ATTRIBUTE) { - $i = $tokens[$i]['attribute_closer']; - continue; + $i = $docCommentOpenPointer; + do { + $pointer = TokenHelper::findNext( + $phpcsFile, + [T_ATTRIBUTE, T_DOC_COMMENT_OPEN_TAG, T_FUNCTION, T_VARIABLE, T_CONST, ...TokenHelper::CLASS_TYPE_TOKEN_CODES], + $i + 1, + ); + if ($pointer === null) { + break; } - if (in_array( - $tokens[$i]['code'], - [T_PUBLIC, T_PROTECTED, T_PRIVATE, T_VAR, T_READONLY, T_FINAL, T_STATIC, T_ABSTRACT, T_WHITESPACE], - true, - )) { - continue; + if ($tokens[$pointer]['code'] === T_DOC_COMMENT_OPEN_TAG) { + return null; } - if (in_array( - $tokens[$i]['code'], - [T_FUNCTION, T_VARIABLE, T_CONST, ...TokenHelper::CLASS_TYPE_TOKEN_CODES], - true, - )) { - $docCommentOwnerPointer = $i; + if ($tokens[$pointer]['code'] === T_ATTRIBUTE) { + $i = $tokens[$pointer]['attribute_closer']; + continue; } + $docCommentOwnerPointer = $pointer; break; - } + + } while (true); return $docCommentOwnerPointer; } @@ -229,7 +214,7 @@ public static function isInline(File $phpcsFile, int $docCommentOpenPointer): bo $nextPointer !== null && in_array( $tokens[$nextPointer]['code'], - [T_PUBLIC, T_PROTECTED, T_PRIVATE, T_READONLY, T_FINAL, T_STATIC, T_ABSTRACT, T_CONST, T_CLASS, T_INTERFACE, T_TRAIT, T_ENUM, T_ATTRIBUTE], + [...TokenHelper::MODIFIERS_TOKEN_CODES, ...TokenHelper::CLASS_TYPE_TOKEN_CODES, T_ATTRIBUTE], true, ) ) { diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/FunctionHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/FunctionHelper.php index 3e5c7fbe8..372d4d0da 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/FunctionHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/FunctionHelper.php @@ -156,7 +156,7 @@ public static function isMethod(File $phpcsFile, int $functionPointer): bool return false; } $lastFunctionPointerCondition = array_pop($functionPointerConditions); - return in_array($lastFunctionPointerCondition, Tokens::$ooScopeTokens, true); + return in_array($lastFunctionPointerCondition, Tokens::OO_SCOPE_TOKENS, true); } public static function findClassPointer(File $phpcsFile, int $functionPointer): ?int @@ -168,7 +168,7 @@ public static function findClassPointer(File $phpcsFile, int $functionPointer): } foreach (array_reverse($tokens[$functionPointer]['conditions'], true) as $conditionPointer => $conditionTokenCode) { - if (!in_array($conditionTokenCode, Tokens::$ooScopeTokens, true)) { + if (!in_array($conditionTokenCode, Tokens::OO_SCOPE_TOKENS, true)) { continue; } @@ -287,12 +287,9 @@ public static function findReturnTypeHint(File $phpcsFile, int $functionPointer) $nextPointer = TokenHelper::findNextEffective($phpcsFile, $tokens[$functionPointer]['parenthesis_closer'] + 1); - if ($tokens[$nextPointer]['code'] === T_USE) { - $useParenthesisOpener = TokenHelper::findNextEffective($phpcsFile, $nextPointer + 1); - $colonPointer = TokenHelper::findNextEffective($phpcsFile, $tokens[$useParenthesisOpener]['parenthesis_closer'] + 1); - } else { - $colonPointer = $nextPointer; - } + $colonPointer = $tokens[$nextPointer]['code'] === T_USE + ? TokenHelper::findNextEffective($phpcsFile, $tokens[$nextPointer]['parenthesis_closer'] + 1) + : $nextPointer; if ($tokens[$colonPointer]['code'] !== T_COLON) { return null; @@ -494,7 +491,7 @@ public static function getLineCount(File $file, int $tokenPosition, int $flags = for ($position = $tokenOpenerPosition; $position <= $tokenCloserPosition - 1; $position++) { $token = $tokens[$position]; if ($includeComments === false) { - if (in_array($token['code'], Tokens::$commentTokens, true)) { + if (in_array($token['code'], Tokens::COMMENT_TOKENS, true)) { if ( $previousIncludedPosition !== null && substr_count($token['content'], $file->eolChar) > 0 && diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/IdentificatorHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/IdentificatorHelper.php index 613c8b176..b2225d422 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/IdentificatorHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/IdentificatorHelper.php @@ -14,9 +14,6 @@ use const T_OBJECT_OPERATOR; use const T_OPEN_CURLY_BRACKET; use const T_OPEN_SQUARE_BRACKET; -use const T_PARENT; -use const T_SELF; -use const T_STATIC; use const T_VARIABLE; /** @@ -83,7 +80,7 @@ public static function findEndPointer(File $phpcsFile, int $startPointer): ?int $nextPointer = TokenHelper::findNextEffective($phpcsFile, $startPointer + 1); if ( - in_array($tokens[$startPointer]['code'], [T_SELF, T_STATIC, T_PARENT, ...TokenHelper::NAME_TOKEN_CODES], true) + in_array($tokens[$startPointer]['code'], [...TokenHelper::CLASS_KEYWORD_CODES, ...TokenHelper::NAME_TOKEN_CODES], true) && $tokens[$nextPointer]['code'] === T_DOUBLE_COLON ) { return self::getEndPointerAfterOperator($phpcsFile, $nextPointer); @@ -117,7 +114,7 @@ private static function getStartPointerBeforeOperator(File $phpcsFile, int $oper if ( $tokens[$operatorPointer]['code'] === T_DOUBLE_COLON - && in_array($tokens[$previousPointer]['code'], [T_SELF, T_STATIC, T_PARENT, ...TokenHelper::NAME_TOKEN_CODES], true) + && in_array($tokens[$previousPointer]['code'], [...TokenHelper::CLASS_KEYWORD_CODES, ...TokenHelper::NAME_TOKEN_CODES], true) ) { return $previousPointer; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/NamespaceHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/NamespaceHelper.php index 5bb24ca5f..a5a646842 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/NamespaceHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/NamespaceHelper.php @@ -11,9 +11,11 @@ use function defined; use function explode; use function implode; -use function in_array; use function ltrim; +use function min; use function sprintf; +use function strcasecmp; +use function strcmp; use function strpos; use const T_NAME_FULLY_QUALIFIED; use const T_NAMESPACE; @@ -61,7 +63,7 @@ public static function isFullyQualifiedName(string $typeName): bool public static function isFullyQualifiedPointer(File $phpcsFile, int $pointer): bool { - return in_array($phpcsFile->getTokens()[$pointer]['code'], [T_NS_SEPARATOR, T_NAME_FULLY_QUALIFIED], true); + return $phpcsFile->getTokens()[$pointer]['code'] === T_NAME_FULLY_QUALIFIED; } public static function getFullyQualifiedTypeName(string $typeName): string @@ -198,4 +200,31 @@ public static function resolveName(File $phpcsFile, string $nameAsReferencedInFi return $name; } + public static function compareStatements(string $fqnA, string $fqnB, bool $caseSensitive): int + { + $aNameParts = explode(self::NAMESPACE_SEPARATOR, ltrim($fqnA, self::NAMESPACE_SEPARATOR)); + $bNameParts = explode(self::NAMESPACE_SEPARATOR, ltrim($fqnB, self::NAMESPACE_SEPARATOR)); + + $minPartsCount = min(count($aNameParts), count($bNameParts)); + for ($i = 0; $i < $minPartsCount; $i++) { + $comparison = self::compare($aNameParts[$i], $bNameParts[$i], $caseSensitive); + if ($comparison === 0) { + continue; + } + + return $comparison; + } + + return count($aNameParts) <=> count($bNameParts); + } + + private static function compare(string $a, string $b, bool $caseSensitive): int + { + if ($caseSensitive) { + return strcmp($a, $b); + } + + return strcasecmp($a, $b); + } + } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/PropertyHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/PropertyHelper.php index bc53d9db6..d4a369409 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/PropertyHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/PropertyHelper.php @@ -52,7 +52,7 @@ public static function isProperty(File $phpcsFile, int $variablePointer, bool $p if (in_array( $tokens[$previousPointer]['code'], - [...array_values(Tokens::$scopeModifiers), T_READONLY], + [...array_values(Tokens::SCOPE_MODIFIERS), T_READONLY], true, )) { $constructorPointer = TokenHelper::findPrevious($phpcsFile, T_FUNCTION, $previousPointer - 1); @@ -105,7 +105,7 @@ public static function isProperty(File $phpcsFile, int $variablePointer, bool $p $conditionCode = array_values($tokens[$variablePointer]['conditions'])[count($tokens[$variablePointer]['conditions']) - 1]; - return in_array($conditionCode, Tokens::$ooScopeTokens, true); + return in_array($conditionCode, Tokens::OO_SCOPE_TOKENS, true); } public static function getStartPointer(File $phpcsFile, int $propertyPointer): int diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ReferencedNameHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ReferencedNameHelper.php index c90d2b202..edf403b21 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ReferencedNameHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/ReferencedNameHelper.php @@ -3,7 +3,6 @@ namespace SlevomatCodingStandard\Helpers; use PHP_CodeSniffer\Files\File; -use PHP_CodeSniffer\Util\Tokens; use function array_key_exists; use function array_reverse; use function array_values; @@ -35,9 +34,6 @@ use const T_HEREDOC; use const T_IMPLEMENTS; use const T_INSTANCEOF; -use const T_NAME_FULLY_QUALIFIED; -use const T_NAME_QUALIFIED; -use const T_NAME_RELATIVE; use const T_NAMESPACE; use const T_NEW; use const T_NS_SEPARATOR; @@ -48,7 +44,6 @@ use const T_OPEN_SHORT_ARRAY; use const T_OPEN_TAG; use const T_PARAM_NAME; -use const T_STRING; use const T_TRAIT; use const T_TYPE_INTERSECTION; use const T_TYPE_UNION; @@ -82,44 +77,6 @@ public static function getAllReferencedNamesInAttributes(File $phpcsFile, int $o return SniffLocalCache::getAndSetIfNotCached($phpcsFile, 'referencesFromAttributes', $lazyValue); } - public static function getReferenceName(File $phpcsFile, int $nameStartPointer, int $nameEndPointer): string - { - $tokens = $phpcsFile->getTokens(); - - $referencedName = ''; - for ($i = $nameStartPointer; $i <= $nameEndPointer; $i++) { - if (in_array($tokens[$i]['code'], Tokens::$emptyTokens, true)) { - continue; - } - - $referencedName .= $tokens[$i]['content']; - } - - return $referencedName; - } - - public static function getReferencedNameEndPointer(File $phpcsFile, int $startPointer): int - { - $tokens = $phpcsFile->getTokens(); - - $nameTokenCodesWithWhitespace = [...TokenHelper::NAME_TOKEN_CODES, ...TokenHelper::INEFFECTIVE_TOKEN_CODES]; - - $lastNamePointer = $startPointer; - for ($i = $startPointer + 1; $i < count($tokens); $i++) { - if (!in_array($tokens[$i]['code'], $nameTokenCodesWithWhitespace, true)) { - break; - } - - if (!in_array($tokens[$i]['code'], TokenHelper::NAME_TOKEN_CODES, true)) { - continue; - } - - $lastNamePointer = $i; - } - - return $lastNamePointer; - } - /** * @return list */ @@ -134,15 +91,15 @@ private static function createAllReferencedNames(File $phpcsFile, int $openTagPo $tokens = $phpcsFile->getTokens(); while (true) { - $nameStartPointer = TokenHelper::findNext($phpcsFile, $nameTokenCodes, $beginSearchAtPointer); - if ($nameStartPointer === null) { + $namePointer = TokenHelper::findNext($phpcsFile, $nameTokenCodes, $beginSearchAtPointer); + if ($namePointer === null) { break; } // Find referenced names inside double quotes string - if (self::isNeedParsedContent($tokens[$nameStartPointer]['code'])) { - $content = $tokens[$nameStartPointer]['content']; - $currentPointer = $nameStartPointer + 1; + if (self::isNeedParsedContent($tokens[$namePointer]['code'])) { + $content = $tokens[$namePointer]['content']; + $currentPointer = $namePointer + 1; while (self::isNeedParsedContent($tokens[$currentPointer]['code'])) { $content .= $tokens[$currentPointer]['content']; $currentPointer++; @@ -150,7 +107,7 @@ private static function createAllReferencedNames(File $phpcsFile, int $openTagPo $names = self::getReferencedNamesFromString($content); foreach ($names as $name) { - $referencedNames[] = new ReferencedName($name, $nameStartPointer, $nameStartPointer, ReferencedName::TYPE_CLASS); + $referencedNames[] = new ReferencedName($name, $namePointer, $namePointer, ReferencedName::TYPE_CLASS); } $beginSearchAtPointer = $currentPointer; @@ -158,33 +115,31 @@ private static function createAllReferencedNames(File $phpcsFile, int $openTagPo } // Attributes are parsed in specific method - $attributeStartPointerBefore = TokenHelper::findPrevious($phpcsFile, T_ATTRIBUTE, $nameStartPointer - 1, $beginSearchAtPointer); + $attributeStartPointerBefore = TokenHelper::findPrevious($phpcsFile, T_ATTRIBUTE, $namePointer - 1, $beginSearchAtPointer); if ($attributeStartPointerBefore !== null) { - if ($tokens[$attributeStartPointerBefore]['attribute_closer'] > $nameStartPointer) { + if ($tokens[$attributeStartPointerBefore]['attribute_closer'] > $namePointer) { $beginSearchAtPointer = $tokens[$attributeStartPointerBefore]['attribute_closer'] + 1; continue; } } - if (!self::isReferencedName($phpcsFile, $nameStartPointer)) { + if (!self::isReferencedName($phpcsFile, $namePointer)) { /** @var int $beginSearchAtPointer */ $beginSearchAtPointer = TokenHelper::findNextExcluding( $phpcsFile, [...TokenHelper::INEFFECTIVE_TOKEN_CODES, ...$nameTokenCodes], - $nameStartPointer + 1, + $namePointer + 1, ); continue; } - $nameEndPointer = self::getReferencedNameEndPointer($phpcsFile, $nameStartPointer); - $referencedNames[] = new ReferencedName( - self::getReferenceName($phpcsFile, $nameStartPointer, $nameEndPointer), - $nameStartPointer, - $nameEndPointer, - self::getReferenceType($phpcsFile, $nameStartPointer, $nameEndPointer), + $tokens[$namePointer]['content'], + $namePointer, + $namePointer, + self::getReferenceType($phpcsFile, $namePointer, $namePointer), ); - $beginSearchAtPointer = $nameEndPointer + 1; + $beginSearchAtPointer = $namePointer + 1; } return $referencedNames; } @@ -385,8 +340,7 @@ private static function isReferencedName(File $phpcsFile, int $startPointer): bo return false; } - $endPointer = self::getReferencedNameEndPointer($phpcsFile, $startPointer); - $referencedName = self::getReferenceName($phpcsFile, $startPointer, $endPointer); + $referencedName = $tokens[$startPointer]['content']; if (TypeHintHelper::isSimpleTypeHint($referencedName) || $referencedName === 'object') { return $tokens[$nextPointer]['code'] === T_OPEN_PARENTHESIS; @@ -432,8 +386,6 @@ private static function createAllReferencedNamesInAttributes(File $phpcsFile, in continue; } - $referencedNameEndPointer = self::getReferencedNameEndPointer($phpcsFile, $pointer); - $pointerBefore = TokenHelper::findPreviousEffective($phpcsFile, $pointer - 1); if (in_array($tokens[$pointerBefore]['code'], [T_OPEN_TAG, T_ATTRIBUTE], true)) { @@ -441,13 +393,13 @@ private static function createAllReferencedNamesInAttributes(File $phpcsFile, in } elseif ($tokens[$pointerBefore]['code'] === T_COMMA && $level === 0) { $referenceType = ReferencedName::TYPE_CLASS; } elseif (self::isReferencedName($phpcsFile, $pointer)) { - $referenceType = self::getReferenceType($phpcsFile, $pointer, $referencedNameEndPointer); + $referenceType = self::getReferenceType($phpcsFile, $pointer, $pointer); } else { $searchPointer = $pointer + 1; continue; } - $referencedName = self::getReferenceName($phpcsFile, $pointer, $referencedNameEndPointer); + $referencedName = $tokens[$pointer]['content']; $referencedNames[] = new ReferencedName( $referencedName, @@ -456,7 +408,7 @@ private static function createAllReferencedNamesInAttributes(File $phpcsFile, in $referenceType, ); - $searchPointer = $referencedNameEndPointer + 1; + $searchPointer = $pointer + 1; } while (true); } @@ -485,7 +437,11 @@ private static function getReferencedNamesFromString(string $content): array $referencedName = ''; $tmpPosition = $position - 1; while (true) { - if (!is_array($subTokens[$tmpPosition]) || !in_array($subTokens[$tmpPosition][0], [T_NS_SEPARATOR, T_STRING], true)) { + if (!isset($subTokens[$tmpPosition]) || !is_array($subTokens[$tmpPosition])) { + break; + } + // We need to check namespace separator because of support for PHP 7.4 + if (!in_array($subTokens[$tmpPosition][0], [T_NS_SEPARATOR, ...TokenHelper::NAME_TOKEN_CODES], true)) { break; } @@ -493,23 +449,22 @@ private static function getReferencedNamesFromString(string $content): array $tmpPosition--; } - $referencedNames[] = $referencedName; + if ($referencedName !== '') { + $referencedNames[] = $referencedName; + } } elseif (is_array($token) && $token[0] === T_NEW) { $referencedName = ''; $tmpPosition = $position + 1; while (true) { - if (!is_array($subTokens[$tmpPosition])) { + if (!isset($subTokens[$tmpPosition]) || !is_array($subTokens[$tmpPosition])) { break; } if ($subTokens[$tmpPosition][0] === T_WHITESPACE) { $tmpPosition++; continue; } - if (!in_array( - $subTokens[$tmpPosition][0], - [T_STRING, T_NS_SEPARATOR, T_NAME_QUALIFIED, T_NAME_FULLY_QUALIFIED, T_NAME_RELATIVE], - true, - )) { + // We need to check namespace separator because of support for PHP 7.4 + if (!in_array($subTokens[$tmpPosition][0], [T_NS_SEPARATOR, ...TokenHelper::NAME_TOKEN_CODES], true)) { break; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/SniffSettingsHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/SniffSettingsHelper.php index eb15511fb..652caa874 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/SniffSettingsHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/SniffSettingsHelper.php @@ -79,8 +79,15 @@ public static function isEnabledByPhpVersion(?bool $value, int $phpVersionLimit) return $value; } - $phpVersion = Config::getConfigData('php_version') !== null ? (int) Config::getConfigData('php_version') : PHP_VERSION_ID; + $phpVersion = self::getPhpVersion() ?? PHP_VERSION_ID; return $phpVersion >= $phpVersionLimit; } + public static function getPhpVersion(): ?int + { + $phpVersion = Config::getConfigData('php_version'); + + return $phpVersion !== null ? (int) $phpVersion : null; + } + } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TernaryOperatorHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TernaryOperatorHelper.php index a404995cc..1bf57397b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TernaryOperatorHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TernaryOperatorHelper.php @@ -31,6 +31,13 @@ class TernaryOperatorHelper { + public static function is(File $phpcsFile, int $pointer): bool + { + $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $pointer - 1); + + return $phpcsFile->getTokens()[$previousPointer]['code'] !== T_OPEN_PARENTHESIS; + } + public static function isConditionOfTernaryOperator(File $phpcsFile, int $pointer): bool { $inlineThenPointer = TokenHelper::findNext($phpcsFile, T_INLINE_THEN, $pointer + 1); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TokenHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TokenHelper.php index 4df7abd6b..4fa0ae09c 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TokenHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/TokenHelper.php @@ -31,7 +31,6 @@ use const T_NAME_FULLY_QUALIFIED; use const T_NAME_QUALIFIED; use const T_NAME_RELATIVE; -use const T_NS_SEPARATOR; use const T_NULL; use const T_OPEN_SHORT_ARRAY; use const T_PARENT; @@ -67,16 +66,17 @@ class TokenHelper { - public const ONLY_NAME_TOKEN_CODES = [ + public const NAME_TOKEN_CODES = [ T_STRING, T_NAME_FULLY_QUALIFIED, T_NAME_QUALIFIED, T_NAME_RELATIVE, ]; - public const NAME_TOKEN_CODES = [ - ...self::ONLY_NAME_TOKEN_CODES, - T_NS_SEPARATOR, + public const CLASS_KEYWORD_CODES = [ + T_PARENT, + T_SELF, + T_STATIC, ]; public const ONLY_TYPE_HINT_TOKEN_CODES = [ @@ -462,9 +462,6 @@ public static function findFirstNonWhitespaceOnPreviousLine(File $phpcsFile, int $phpcsFile->eolChar, $newLinePointerOnPreviousLine - 1, ); - if ($newLinePointerBeforePreviousLine === null) { - return null; - } $nextPointer = self::findNextExcluding($phpcsFile, [T_WHITESPACE, T_DOC_COMMENT_WHITESPACE], $newLinePointerBeforePreviousLine + 1); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/UseStatementHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/UseStatementHelper.php index d99ed5ea7..aadfeef02 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/UseStatementHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/UseStatementHelper.php @@ -83,10 +83,9 @@ public static function isImportUse(File $phpcsFile, int $usePointer): bool public static function isTraitUse(File $phpcsFile, int $usePointer): bool { $tokens = $phpcsFile->getTokens(); - $nextPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1); // Anonymous function use - if ($tokens[$nextPointer]['code'] === T_OPEN_PARENTHESIS) { + if (array_key_exists('parenthesis_opener', $tokens[$usePointer])) { return false; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/YodaHelper.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/YodaHelper.php index b576b60bc..2dffa34c3 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/YodaHelper.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/YodaHelper.php @@ -45,7 +45,6 @@ use const T_LOGICAL_XOR; use const T_MATCH_ARROW; use const T_MINUS; -use const T_NS_SEPARATOR; use const T_NULL; use const T_OBJECT_CAST; use const T_OPEN_PARENTHESIS; @@ -185,7 +184,7 @@ public static function getDynamismForTokens(array $tokens, array $sideTokens): ? { $sideTokens = array_values(array_filter($sideTokens, static fn (array $token): bool => !in_array( $token['code'], - [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT, T_NS_SEPARATOR, T_PLUS, T_MINUS, T_INT_CAST, T_DOUBLE_CAST, T_STRING_CAST, T_ARRAY_CAST, T_OBJECT_CAST, T_BOOL_CAST, T_UNSET_CAST], + [T_WHITESPACE, T_COMMENT, T_DOC_COMMENT, T_PLUS, T_MINUS, T_INT_CAST, T_DOUBLE_CAST, T_STRING_CAST, T_ARRAY_CAST, T_OBJECT_CAST, T_BOOL_CAST, T_UNSET_CAST], true, ))); @@ -311,7 +310,7 @@ private static function getTokenDynamism(): array T_STRING => self::DYNAMISM_FUNCTION_CALL, ]; - $tokenDynamism += array_fill_keys(array_keys(Tokens::$castTokens), 3); + $tokenDynamism += array_fill_keys(array_keys(Tokens::CAST_TOKENS), 3); } return $tokenDynamism; @@ -344,8 +343,8 @@ private static function getStopTokenCodes(): array T_FN_ARROW => true, ]; - $stopTokenCodes += array_fill_keys(array_keys(Tokens::$assignmentTokens), true); - $stopTokenCodes += array_fill_keys(array_keys(Tokens::$commentTokens), true); + $stopTokenCodes += array_fill_keys(array_keys(Tokens::ASSIGNMENT_TOKENS), true); + $stopTokenCodes += array_fill_keys(array_keys(Tokens::COMMENT_TOKENS), true); } return $stopTokenCodes; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/AlphabeticallySortedByKeysSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/AlphabeticallySortedByKeysSniff.php index dd60e04d9..8d429b0c5 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/AlphabeticallySortedByKeysSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/AlphabeticallySortedByKeysSniff.php @@ -27,11 +27,7 @@ public function register(): array return TokenHelper::ARRAY_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPointer - */ - public function process(File $phpcsFile, $stackPointer): void + public function process(File $phpcsFile, int $stackPointer): void { if (ArrayHelper::isMultiLine($phpcsFile, $stackPointer) === false) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/ArrayAccessSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/ArrayAccessSniff.php index 2a250146c..973a230ef 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/ArrayAccessSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/ArrayAccessSniff.php @@ -24,11 +24,7 @@ public function register(): array return [T_OPEN_SQUARE_BRACKET]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPointer - */ - public function process(File $phpcsFile, $stackPointer): void + public function process(File $phpcsFile, int $stackPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowImplicitArrayCreationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowImplicitArrayCreationSniff.php index 1cba40a29..02bbd68a2 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowImplicitArrayCreationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowImplicitArrayCreationSniff.php @@ -43,11 +43,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $bracketOpenerPointer - */ - public function process(File $phpcsFile, $bracketOpenerPointer): void + public function process(File $phpcsFile, int $bracketOpenerPointer): void { $tokens = $phpcsFile->getTokens(); @@ -151,14 +147,12 @@ private function isInheritedVariable(File $phpcsFile, int $closurePointer, int $ return false; } - $parenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1); - $inheritedVariablePointer = TokenHelper::findNextContent( $phpcsFile, T_VARIABLE, $variableName, - $parenthesisOpenerPointer + 1, - $tokens[$parenthesisOpenerPointer]['parenthesis_closer'], + $tokens[$usePointer]['parenthesis_opener'] + 1, + $tokens[$usePointer]['parenthesis_closer'], ); return $inheritedVariablePointer !== null; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowPartiallyKeyedSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowPartiallyKeyedSniff.php index e6bfc28a5..c26426be9 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowPartiallyKeyedSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/DisallowPartiallyKeyedSniff.php @@ -20,11 +20,7 @@ public function register(): array return TokenHelper::ARRAY_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPointer - */ - public function process(File $phpcsFile, $stackPointer): void + public function process(File $phpcsFile, int $stackPointer): void { $keyValues = ArrayHelper::parse($phpcsFile, $stackPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/MultiLineArrayEndBracketPlacementSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/MultiLineArrayEndBracketPlacementSniff.php index 870df29ee..bb8b5b71b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/MultiLineArrayEndBracketPlacementSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/MultiLineArrayEndBracketPlacementSniff.php @@ -22,11 +22,7 @@ public function register(): array return TokenHelper::ARRAY_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPointer - */ - public function process(File $phpcsFile, $stackPointer): void + public function process(File $phpcsFile, int $stackPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/SingleLineArrayWhitespaceSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/SingleLineArrayWhitespaceSniff.php index a4e460368..1cf92d5f0 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/SingleLineArrayWhitespaceSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/SingleLineArrayWhitespaceSniff.php @@ -36,11 +36,7 @@ public function register(): array return TokenHelper::ARRAY_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPointer - */ - public function process(File $phpcsFile, $stackPointer): int + public function process(File $phpcsFile, int $stackPointer): int { $this->spacesAroundBrackets = SniffSettingsHelper::normalizeInteger($this->spacesAroundBrackets); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/TrailingArrayCommaSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/TrailingArrayCommaSniff.php index f2de5517e..27d596a9f 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/TrailingArrayCommaSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Arrays/TrailingArrayCommaSniff.php @@ -28,11 +28,7 @@ public function register(): array return TokenHelper::ARRAY_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPointer - */ - public function process(File $phpcsFile, $stackPointer): void + public function process(File $phpcsFile, int $stackPointer): void { $this->enableAfterHeredoc = SniffSettingsHelper::isEnabledByPhpVersion($this->enableAfterHeredoc, 70300); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributeAndTargetSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributeAndTargetSpacingSniff.php index 57796b577..abf020367 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributeAndTargetSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributeAndTargetSpacingSniff.php @@ -31,11 +31,7 @@ public function register(): array return [T_ATTRIBUTE]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $attributeOpenerPointer - */ - public function process(File $phpcsFile, $attributeOpenerPointer): void + public function process(File $phpcsFile, int $attributeOpenerPointer): void { $this->linesCount = SniffSettingsHelper::normalizeInteger($this->linesCount); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributesOrderSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributesOrderSniff.php index 35f5a50f0..dbda974db 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributesOrderSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/AttributesOrderSniff.php @@ -40,11 +40,7 @@ public function register(): array return [T_ATTRIBUTE]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $attributeOpenerPointer - */ - public function process(File $phpcsFile, $attributeOpenerPointer): void + public function process(File $phpcsFile, int $attributeOpenerPointer): void { if (!AttributeHelper::isValidAttribute($phpcsFile, $attributeOpenerPointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowAttributesJoiningSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowAttributesJoiningSniff.php index 68a688368..1bcac2151 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowAttributesJoiningSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowAttributesJoiningSniff.php @@ -23,11 +23,7 @@ public function register(): array return [T_ATTRIBUTE]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $attributeOpenerPointer - */ - public function process(File $phpcsFile, $attributeOpenerPointer): void + public function process(File $phpcsFile, int $attributeOpenerPointer): void { if (!AttributeHelper::isValidAttribute($phpcsFile, $attributeOpenerPointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowMultipleAttributesPerLineSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowMultipleAttributesPerLineSniff.php index df7b5abf4..dd7b65c43 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowMultipleAttributesPerLineSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/DisallowMultipleAttributesPerLineSniff.php @@ -23,11 +23,7 @@ public function register(): array return [T_ATTRIBUTE]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $attributeOpenerPointer - */ - public function process(File $phpcsFile, $attributeOpenerPointer): void + public function process(File $phpcsFile, int $attributeOpenerPointer): void { if (!AttributeHelper::isValidAttribute($phpcsFile, $attributeOpenerPointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/RequireAttributeAfterDocCommentSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/RequireAttributeAfterDocCommentSniff.php index 9eeada477..324df988d 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/RequireAttributeAfterDocCommentSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Attributes/RequireAttributeAfterDocCommentSniff.php @@ -25,11 +25,7 @@ public function register(): array return [T_ATTRIBUTE]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $attributeOpenerPointer - */ - public function process(File $phpcsFile, $attributeOpenerPointer): void + public function process(File $phpcsFile, int $attributeOpenerPointer): void { if (!AttributeHelper::isValidAttribute($phpcsFile, $attributeOpenerPointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/AbstractPropertyConstantAndEnumCaseSpacing.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/AbstractPropertyConstantAndEnumCaseSpacing.php index 9d163d91e..dc79e421f 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/AbstractPropertyConstantAndEnumCaseSpacing.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/AbstractPropertyConstantAndEnumCaseSpacing.php @@ -45,11 +45,7 @@ abstract protected function isNextMemberValid(File $phpcsFile, int $pointer): bo abstract protected function addError(File $phpcsFile, int $pointer, int $min, int $max, int $found): bool; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): int + public function process(File $phpcsFile, int $pointer): int { $this->minLinesCountBeforeWithComment = SniffSettingsHelper::normalizeInteger($this->minLinesCountBeforeWithComment); $this->maxLinesCountBeforeWithComment = SniffSettingsHelper::normalizeInteger($this->maxLinesCountBeforeWithComment); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/BackedEnumTypeSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/BackedEnumTypeSpacingSniff.php index abad0b944..4d58d67d0 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/BackedEnumTypeSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/BackedEnumTypeSpacingSniff.php @@ -32,11 +32,7 @@ public function register(): array return [T_ENUM]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $enumPointer - */ - public function process(File $phpcsFile, $enumPointer): void + public function process(File $phpcsFile, int $enumPointer): void { $this->spacesCountBeforeColon = SniffSettingsHelper::normalizeInteger($this->spacesCountBeforeColon); $this->spacesCountBeforeType = SniffSettingsHelper::normalizeInteger($this->spacesCountBeforeType); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassConstantVisibilitySniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassConstantVisibilitySniff.php index f717c5a8e..7bfc2d65f 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassConstantVisibilitySniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassConstantVisibilitySniff.php @@ -36,11 +36,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $constantPointer - */ - public function process(File $phpcsFile, $constantPointer): void + public function process(File $phpcsFile, int $constantPointer): void { $tokens = $phpcsFile->getTokens(); @@ -50,7 +46,7 @@ public function process(File $phpcsFile, $constantPointer): void /** @var int $classPointer */ $classPointer = array_keys($tokens[$constantPointer]['conditions'])[count($tokens[$constantPointer]['conditions']) - 1]; - if (!in_array($tokens[$classPointer]['code'], Tokens::$ooScopeTokens, true)) { + if (!in_array($tokens[$classPointer]['code'], Tokens::OO_SCOPE_TOKENS, true)) { return; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassKeywordOrderSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassKeywordOrderSniff.php new file mode 100644 index 000000000..544ffc1a5 --- /dev/null +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassKeywordOrderSniff.php @@ -0,0 +1,112 @@ + + */ + public function register(): array + { + return [ + T_CLASS, + ]; + } + + public function process(File $phpcsFile, int $stackPtr): void + { + $tokens = $phpcsFile->getTokens(); + + $modifierTokens = [ + T_ABSTRACT => 'abstract', + T_FINAL => 'final', + T_READONLY => 'readonly', + ]; + + $foundModifiers = []; + $currentIndex = TokenHelper::findPreviousEffective($phpcsFile, $stackPtr - 1); + + while ($currentIndex !== null && isset($modifierTokens[$tokens[$currentIndex]['code']])) { + $foundModifiers[$currentIndex] = $tokens[$currentIndex]['code']; + $currentIndex = TokenHelper::findPreviousEffective($phpcsFile, $currentIndex - 1); + } + + if (count($foundModifiers) === 0) { + return; + } + + ksort($foundModifiers); + + $actualOrderCodes = array_values($foundModifiers); + $actualOrderText = array_map(static fn ($code) => $modifierTokens[$code], $actualOrderCodes); + + $sortedModifiers = $foundModifiers; + uasort($sortedModifiers, static function ($a, $b) { + $priority = [ + T_ABSTRACT => 0, + T_FINAL => 0, + T_READONLY => 1, + ]; + return $priority[$a] <=> $priority[$b]; + }); + + $expectedOrderCodes = array_values($sortedModifiers); + $expectedOrderText = array_map(static fn ($code) => $modifierTokens[$code], $expectedOrderCodes); + + if ($actualOrderCodes === $expectedOrderCodes) { + return; + } + + $error = 'Class keywords are not in the correct order. Found: "%s class"; Expected: "%s class"'; + $data = [ + implode(' ', $actualOrderText), + implode(' ', $expectedOrderText), + ]; + + $fix = $phpcsFile->addFixableError($error, $stackPtr, self::CODE_WRONG_CLASS_KEYWORD_ORDER, $data); + + if ($fix !== true) { + return; + } + + $phpcsFile->fixer->beginChangeset(); + + foreach (array_keys($foundModifiers) as $ptr) { + $phpcsFile->fixer->replaceToken($ptr, ''); + + if ($tokens[$ptr + 1]['code'] === T_WHITESPACE) { + $phpcsFile->fixer->replaceToken($ptr + 1, ''); + } + } + + $firstModifierPtr = array_key_first($foundModifiers); + + $newContent = implode(' ', $expectedOrderText) . ' '; + + $phpcsFile->fixer->addContentBefore($firstModifierPtr, $newContent); + + $phpcsFile->fixer->endChangeset(); + } + +} diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassLengthSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassLengthSniff.php index c5aa1287c..5166a3d8b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassLengthSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassLengthSniff.php @@ -29,14 +29,10 @@ class ClassLengthSniff implements Sniff */ public function register(): array { - return array_values(Tokens::$ooScopeTokens); + return array_values(Tokens::OO_SCOPE_TOKENS); } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->maxLinesLength = SniffSettingsHelper::normalizeInteger($this->maxLinesLength); $flags = array_keys(array_filter([ diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassMemberSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassMemberSpacingSniff.php index c295be62d..7537ec5ba 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassMemberSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassMemberSpacingSniff.php @@ -44,11 +44,7 @@ public function register(): array return TokenHelper::CLASS_TYPE_WITH_ANONYMOUS_CLASS_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $classPointer - */ - public function process(File $phpcsFile, $classPointer): void + public function process(File $phpcsFile, int $classPointer): void { $this->linesCountBetweenMembers = SniffSettingsHelper::normalizeInteger($this->linesCountBetweenMembers); @@ -214,7 +210,7 @@ private function getMemberStartPointer(File $phpcsFile, int $memberPointer, int continue; } - if (in_array($tokens[$pointerBefore]['code'], Tokens::$commentTokens, true)) { + if (in_array($tokens[$pointerBefore]['code'], Tokens::COMMENT_TOKENS, true)) { $pointerBeforeComment = TokenHelper::findPreviousEffective($phpcsFile, $pointerBefore - 1); if ($tokens[$pointerBeforeComment]['line'] !== $tokens[$pointerBefore]['line']) { $memberFirstCodePointer = array_key_exists('comment_opener', $tokens[$pointerBefore]) diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassStructureSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassStructureSniff.php index d58803e61..cfa2e2512 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassStructureSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ClassStructureSniff.php @@ -208,14 +208,10 @@ class ClassStructureSniff implements Sniff */ public function register(): array { - return array_values(Tokens::$ooScopeTokens); + return array_values(Tokens::OO_SCOPE_TOKENS); } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): int + public function process(File $phpcsFile, int $pointer): int { $tokens = $phpcsFile->getTokens(); $rootScopeToken = $tokens[$pointer]; @@ -431,6 +427,12 @@ private function resolveMethodGroup(File $phpcsFile, int $pointer, string $metho if ($method === $methodNamePrefix || !StringHelper::startsWith($method, $methodNamePrefix)) { continue; } + } elseif (StringHelper::startsWith($requiredName, '*')) { + $methodNameSuffix = substr($requiredName, 1); + + if ($method === $methodNameSuffix || !StringHelper::endsWith($method, $methodNameSuffix)) { + continue; + } } elseif ($method !== $requiredName) { continue; } @@ -516,7 +518,7 @@ private function getVisibilityForToken(File $phpcsFile, int $pointer) $previousPointer = $pointer - 1; $endTokenCodes = [T_OPEN_CURLY_BRACKET, T_CLOSE_CURLY_BRACKET, T_SEMICOLON]; - $tokenCodesToSearch = [...array_values(Tokens::$scopeModifiers), ...$endTokenCodes]; + $tokenCodesToSearch = [...array_values(Tokens::SCOPE_MODIFIERS), ...$endTokenCodes]; do { $previousPointer = TokenHelper::findPrevious($phpcsFile, $tokenCodesToSearch, $previousPointer - 1); @@ -584,7 +586,7 @@ private function isStaticConstructor(File $phpcsFile, int $pointer): bool private function getParentClassName(File $phpcsFile, int $pointer): string { - $classPointer = TokenHelper::findPrevious($phpcsFile, Tokens::$ooScopeTokens, $pointer - 1); + $classPointer = TokenHelper::findPrevious($phpcsFile, Tokens::OO_SCOPE_TOKENS, $pointer - 1); assert($classPointer !== null); return ClassHelper::getName($phpcsFile, $classPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ConstantSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ConstantSpacingSniff.php index 0df8094c8..ba9cf2fa8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ConstantSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ConstantSpacingSniff.php @@ -28,11 +28,7 @@ public function register(): array return [T_CONST]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $constantPointer - */ - public function process(File $phpcsFile, $constantPointer): int + public function process(File $phpcsFile, int $constantPointer): int { $tokens = $phpcsFile->getTokens(); @@ -42,7 +38,7 @@ public function process(File $phpcsFile, $constantPointer): int /** @var int $classPointer */ $classPointer = array_keys($tokens[$constantPointer]['conditions'])[count($tokens[$constantPointer]['conditions']) - 1]; - if (!in_array($tokens[$classPointer]['code'], Tokens::$ooScopeTokens, true)) { + if (!in_array($tokens[$classPointer]['code'], Tokens::OO_SCOPE_TOKENS, true)) { return $constantPointer; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowConstructorPropertyPromotionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowConstructorPropertyPromotionSniff.php index 5009f2ce3..2e6293f39 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowConstructorPropertyPromotionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowConstructorPropertyPromotionSniff.php @@ -26,11 +26,7 @@ public function register(): array return [T_FUNCTION]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $tokens = $phpcsFile->getTokens(); @@ -42,7 +38,7 @@ public function process(File $phpcsFile, $functionPointer): void $modifierPointers = TokenHelper::findNextAll( $phpcsFile, - [...array_values(Tokens::$scopeModifiers), T_READONLY], + [...array_values(Tokens::SCOPE_MODIFIERS), T_READONLY], $tokens[$functionPointer]['parenthesis_opener'] + 1, $tokens[$functionPointer]['parenthesis_closer'], ); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowLateStaticBindingForConstantsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowLateStaticBindingForConstantsSniff.php index 6d24e3681..abcaf5081 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowLateStaticBindingForConstantsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowLateStaticBindingForConstantsSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $staticPointer - */ - public function process(File $phpcsFile, $staticPointer): void + public function process(File $phpcsFile, int $staticPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiConstantDefinitionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiConstantDefinitionSniff.php index 549f26448..a50ea1861 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiConstantDefinitionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiConstantDefinitionSniff.php @@ -31,11 +31,7 @@ public function register(): array return [T_CONST]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $constantPointer - */ - public function process(File $phpcsFile, $constantPointer): void + public function process(File $phpcsFile, int $constantPointer): void { $tokens = $phpcsFile->getTokens(); @@ -72,7 +68,7 @@ public function process(File $phpcsFile, $constantPointer): void } $possibleVisibilityPointer = TokenHelper::findPreviousEffective($phpcsFile, $constantPointer - 1); - $visibilityPointer = in_array($tokens[$possibleVisibilityPointer]['code'], Tokens::$scopeModifiers, true) + $visibilityPointer = in_array($tokens[$possibleVisibilityPointer]['code'], Tokens::SCOPE_MODIFIERS, true) ? $possibleVisibilityPointer : null; $visibility = $visibilityPointer !== null ? $tokens[$possibleVisibilityPointer]['content'] : null; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiPropertyDefinitionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiPropertyDefinitionSniff.php index 1d22e672d..6d3a968e9 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiPropertyDefinitionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowMultiPropertyDefinitionSniff.php @@ -19,6 +19,7 @@ use const T_COMMA; use const T_CONST; use const T_FUNCTION; +use const T_OPEN_CURLY_BRACKET; use const T_OPEN_SHORT_ARRAY; use const T_SEMICOLON; use const T_VARIABLE; @@ -36,11 +37,7 @@ public function register(): array return TokenHelper::PROPERTY_MODIFIERS_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $modifierPointer - */ - public function process(File $phpcsFile, $modifierPointer): void + public function process(File $phpcsFile, int $modifierPointer): void { $tokens = $phpcsFile->getTokens(); @@ -55,7 +52,7 @@ public function process(File $phpcsFile, $modifierPointer): void return; } - // Ignore other class members with same mofidiers + // Ignore other class members with same modifiers $propertyPointer = TokenHelper::findNext($phpcsFile, [T_VARIABLE, T_CONST, T_FUNCTION, T_CLASS], $modifierPointer + 1); if ( $propertyPointer === null @@ -65,6 +62,11 @@ public function process(File $phpcsFile, $modifierPointer): void return; } + $endPointer = TokenHelper::findNext($phpcsFile, [T_SEMICOLON, T_OPEN_CURLY_BRACKET], $propertyPointer + 1); + if ($tokens[$endPointer]['code'] === T_OPEN_CURLY_BRACKET) { + return; + } + $semicolonPointer = TokenHelper::findNext($phpcsFile, T_SEMICOLON, $propertyPointer + 1); $commaPointers = []; $nextPointer = $propertyPointer; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowStringExpressionPropertyFetchSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowStringExpressionPropertyFetchSniff.php index 1a1a6d497..aba5412ec 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowStringExpressionPropertyFetchSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/DisallowStringExpressionPropertyFetchSniff.php @@ -25,11 +25,7 @@ public function register(): array return [T_OBJECT_OPERATOR]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $objectOperatorPointer - */ - public function process(File $phpcsFile, $objectOperatorPointer): void + public function process(File $phpcsFile, int $objectOperatorPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/EmptyLinesAroundClassBracesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/EmptyLinesAroundClassBracesSniff.php index f0ffec97a..08d9872ea 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/EmptyLinesAroundClassBracesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/EmptyLinesAroundClassBracesSniff.php @@ -35,14 +35,10 @@ class EmptyLinesAroundClassBracesSniff implements Sniff */ public function register(): array { - return array_values(Tokens::$ooScopeTokens); + return array_values(Tokens::OO_SCOPE_TOKENS); } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPointer - */ - public function process(File $phpcsFile, $stackPointer): void + public function process(File $phpcsFile, int $stackPointer): void { $this->linesCountAfterOpeningBrace = SniffSettingsHelper::normalizeInteger($this->linesCountAfterOpeningBrace); $this->linesCountBeforeClosingBrace = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeClosingBrace); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ForbiddenPublicPropertySniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ForbiddenPublicPropertySniff.php index 0082eefaa..62bb07855 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ForbiddenPublicPropertySniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ForbiddenPublicPropertySniff.php @@ -4,6 +4,7 @@ use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Sniffs\Sniff; +use SlevomatCodingStandard\Helpers\AttributeHelper; use SlevomatCodingStandard\Helpers\ClassHelper; use SlevomatCodingStandard\Helpers\PropertyHelper; use SlevomatCodingStandard\Helpers\StringHelper; @@ -40,11 +41,7 @@ public function register(): array return TokenHelper::PROPERTY_MODIFIERS_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $tokens = $phpcsFile->getTokens(); @@ -59,7 +56,7 @@ public function process(File $phpcsFile, $pointer): void return; } - // Ignore other class members with same mofidiers + // Ignore other class members with same modifiers $propertyPointer = TokenHelper::findNext($phpcsFile, [T_VARIABLE, T_CONST, T_FUNCTION, T_CLASS], $pointer + 1); if ( $propertyPointer === null @@ -69,6 +66,10 @@ public function process(File $phpcsFile, $pointer): void return; } + if (AttributeHelper::hasAttribute($phpcsFile, $propertyPointer, '\Override')) { + return; + } + // Skip sniff classes, they have public properties for configuration (unfortunately) if ($this->isSniffClass($phpcsFile, $propertyPointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/MethodSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/MethodSpacingSniff.php index e21068788..7734af753 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/MethodSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/MethodSpacingSniff.php @@ -36,11 +36,7 @@ public function register(): array return [T_FUNCTION]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $methodPointer - */ - public function process(File $phpcsFile, $methodPointer): void + public function process(File $phpcsFile, int $methodPointer): void { $this->minLinesCount = SniffSettingsHelper::normalizeInteger($this->minLinesCount); $this->maxLinesCount = SniffSettingsHelper::normalizeInteger($this->maxLinesCount); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ModernClassNameReferenceSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ModernClassNameReferenceSniff.php index 27f4a3747..e6e3f36b4 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ModernClassNameReferenceSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ModernClassNameReferenceSniff.php @@ -16,7 +16,6 @@ use const T_CLASS_C; use const T_DOUBLE_COLON; use const T_FUNCTION; -use const T_NS_SEPARATOR; use const T_OBJECT_OPERATOR; use const T_OPEN_PARENTHESIS; use const T_VARIABLE; @@ -36,15 +35,11 @@ public function register(): array { return [ T_CLASS_C, - ...TokenHelper::ONLY_NAME_TOKEN_CODES, + ...TokenHelper::NAME_TOKEN_CODES, ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->enableOnObjects = SniffSettingsHelper::isEnabledByPhpVersion($this->enableOnObjects, 80000); @@ -164,9 +159,6 @@ private function checkFunctionCall(File $phpcsFile, int $functionPointer): void } $phpcsFile->fixer->beginChangeset(); - if ($tokens[$functionPointer - 1]['code'] === T_NS_SEPARATOR) { - FixerHelper::replace($phpcsFile, $functionPointer - 1, ''); - } FixerHelper::change($phpcsFile, $functionPointer, $tokens[$openParenthesisPointer]['parenthesis_closer'], $fixedContent); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ParentCallSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ParentCallSpacingSniff.php index 95922d208..0cd1fb84d 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ParentCallSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/ParentCallSpacingSniff.php @@ -33,11 +33,7 @@ class ParentCallSpacingSniff extends AbstractControlStructureSpacing public int $linesCountAfterLast = 0; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $parentPointer - */ - public function process(File $phpcsFile, $parentPointer): void + public function process(File $phpcsFile, int $parentPointer): void { $this->linesCountBefore = SniffSettingsHelper::normalizeInteger($this->linesCountBefore); $this->linesCountBeforeFirst = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirst); @@ -51,14 +47,14 @@ public function process(File $phpcsFile, $parentPointer): void } $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $parentPointer - 1); - if (in_array($tokens[$previousPointer]['code'], array_merge(Tokens::$castTokens, [T_ASPERAND]), true)) { + if (in_array($tokens[$previousPointer]['code'], array_merge(Tokens::CAST_TOKENS, [T_ASPERAND]), true)) { $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1); } $tokensToIgnore = array_merge( - Tokens::$assignmentTokens, - Tokens::$equalityTokens, - Tokens::$booleanOperators, + Tokens::ASSIGNMENT_TOKENS, + Tokens::EQUALITY_TOKENS, + Tokens::BOOLEAN_OPERATORS, [T_RETURN, T_YIELD, T_YIELD_FROM, T_COLON, T_STRING_CONCAT, T_INLINE_THEN, T_INLINE_ELSE, T_COALESCE, T_MATCH_ARROW], ); if (in_array($tokens[$previousPointer]['code'], $tokensToIgnore, true)) { diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertyDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertyDeclarationSniff.php index 8d45b2684..832c9ad17 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertyDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertyDeclarationSniff.php @@ -82,11 +82,7 @@ public function register(): array return TokenHelper::PROPERTY_MODIFIERS_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $modifierPointer - */ - public function process(File $phpcsFile, $modifierPointer): void + public function process(File $phpcsFile, int $modifierPointer): void { $tokens = $phpcsFile->getTokens(); @@ -118,7 +114,7 @@ public function process(File $phpcsFile, $modifierPointer): void } } - // Ignore other class members with same mofidiers + // Ignore other class members with same modifiers $propertyPointer = TokenHelper::findNext($phpcsFile, [T_CLASS, T_FUNCTION, T_CONST, T_VARIABLE], $modifierPointer + 1); if ($propertyPointer === null || $tokens[$propertyPointer]['code'] !== T_VARIABLE) { diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertySpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertySpacingSniff.php index 040c45b97..7e4267616 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertySpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/PropertySpacingSniff.php @@ -26,11 +26,7 @@ public function register(): array return TokenHelper::PROPERTY_MODIFIERS_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): int + public function process(File $phpcsFile, int $pointer): int { $tokens = $phpcsFile->getTokens(); @@ -45,7 +41,7 @@ public function process(File $phpcsFile, $pointer): int return $nextPointer; } - // Ignore other class members with same mofidiers + // Ignore other class members with same modifiers $propertyPointer = TokenHelper::findNext($phpcsFile, [T_VARIABLE, T_FUNCTION, T_CONST, T_CLASS], $pointer + 1); if ( $propertyPointer === null diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php index 1442e7be3..b0d163f13 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireAbstractOrFinalSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $classPointer - */ - public function process(File $phpcsFile, $classPointer): void + public function process(File $phpcsFile, int $classPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireConstructorPropertyPromotionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireConstructorPropertyPromotionSniff.php index 436cdb345..d5716f174 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireConstructorPropertyPromotionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireConstructorPropertyPromotionSniff.php @@ -58,11 +58,7 @@ public function register(): array return [T_FUNCTION]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); @@ -383,7 +379,7 @@ private function isParameterModifiedBeforeAssignment( } $nextPointer = TokenHelper::findNextEffective($phpcsFile, $i + 1); - if (in_array($tokens[$nextPointer]['code'], Tokens::$assignmentTokens, true)) { + if (in_array($tokens[$nextPointer]['code'], Tokens::ASSIGNMENT_TOKENS, true)) { return true; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireMultiLineMethodSignatureSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireMultiLineMethodSignatureSniff.php index d152fa293..396843258 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireMultiLineMethodSignatureSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireMultiLineMethodSignatureSniff.php @@ -28,6 +28,8 @@ class RequireMultiLineMethodSignatureSniff extends AbstractMethodSignature public bool $withPromotedProperties = false; + public bool $withParametersWithAttributes = false; + /** @var list */ public array $includedMethodPatterns = []; @@ -40,11 +42,7 @@ class RequireMultiLineMethodSignatureSniff extends AbstractMethodSignature /** @var list|null */ public ?array $excludedMethodNormalizedPatterns = null; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $methodPointer - */ - public function process(File $phpcsFile, $methodPointer): void + public function process(File $phpcsFile, int $methodPointer): void { $this->minLineLength = SniffSettingsHelper::normalizeNullableInteger($this->minLineLength); $this->minParametersCount = SniffSettingsHelper::normalizeNullableInteger($this->minParametersCount); @@ -93,18 +91,21 @@ public function process(File $phpcsFile, $methodPointer): void return; } - $splitPromotedProperties = false; - if ($this->withPromotedProperties) { - foreach ($parameters as $parameter) { - if (isset($parameter['property_visibility'])) { - $splitPromotedProperties = true; - break; - } + $forceSplit = $this->minLineLength === 0; + foreach ($parameters as $parameter) { + if ($this->withPromotedProperties && isset($parameter['property_visibility'])) { + $forceSplit = true; + break; + } + + if ($this->withParametersWithAttributes && isset($parameter['has_attributes']) && $parameter['has_attributes']) { + $forceSplit = true; + break; } } - if (!$splitPromotedProperties) { - if ($this->minLineLength !== null && $this->minLineLength !== 0 && strlen($signature) < $this->minLineLength) { + if (!$forceSplit) { + if ($this->minLineLength !== null && strlen($signature) < $this->minLineLength) { return; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSelfReferenceSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSelfReferenceSniff.php index 70a1628d8..20c2d449a 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSelfReferenceSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSelfReferenceSniff.php @@ -31,11 +31,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSingleLineMethodSignatureSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSingleLineMethodSignatureSniff.php index 84f32306c..c1b2eced9 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSingleLineMethodSignatureSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/RequireSingleLineMethodSignatureSniff.php @@ -31,11 +31,7 @@ class RequireSingleLineMethodSignatureSniff extends AbstractMethodSignature /** @var list|null */ public ?array $excludedMethodNormalizedPatterns = null; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $methodPointer - */ - public function process(File $phpcsFile, $methodPointer): void + public function process(File $phpcsFile, int $methodPointer): void { $this->maxLineLength = SniffSettingsHelper::normalizeInteger($this->maxLineLength); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousAbstractClassNamingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousAbstractClassNamingSniff.php index 5c5800fb3..3d109ca76 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousAbstractClassNamingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousAbstractClassNamingSniff.php @@ -28,11 +28,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $classPointer - */ - public function process(File $phpcsFile, $classPointer): void + public function process(File $phpcsFile, int $classPointer): void { $className = ClassHelper::getName($phpcsFile, $classPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousErrorNamingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousErrorNamingSniff.php index 108c97eae..e68d17d33 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousErrorNamingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousErrorNamingSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $classPointer - */ - public function process(File $phpcsFile, $classPointer): void + public function process(File $phpcsFile, int $classPointer): void { $className = ClassHelper::getName($phpcsFile, $classPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousExceptionNamingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousExceptionNamingSniff.php index 5c1d58618..5d3a6aadb 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousExceptionNamingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousExceptionNamingSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $classPointer - */ - public function process(File $phpcsFile, $classPointer): void + public function process(File $phpcsFile, int $classPointer): void { $className = ClassHelper::getName($phpcsFile, $classPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousInterfaceNamingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousInterfaceNamingSniff.php index 448d83f5b..72298abdd 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousInterfaceNamingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousInterfaceNamingSniff.php @@ -26,11 +26,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $interfacePointer - */ - public function process(File $phpcsFile, $interfacePointer): void + public function process(File $phpcsFile, int $interfacePointer): void { $interfaceName = ClassHelper::getName($phpcsFile, $interfacePointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousTraitNamingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousTraitNamingSniff.php index 22e7ea61b..bda6aa6db 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousTraitNamingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/SuperfluousTraitNamingSniff.php @@ -25,11 +25,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $traitPointer - */ - public function process(File $phpcsFile, $traitPointer): void + public function process(File $phpcsFile, int $traitPointer): void { $traitName = ClassHelper::getName($phpcsFile, $traitPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseDeclarationSniff.php index 49cd8bea5..be3f07ab5 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseDeclarationSniff.php @@ -35,11 +35,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $classPointer - */ - public function process(File $phpcsFile, $classPointer): void + public function process(File $phpcsFile, int $classPointer): void { $usePointers = ClassHelper::getTraitUsePointers($phpcsFile, $classPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseOrderSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseOrderSniff.php new file mode 100644 index 000000000..bd21eed12 --- /dev/null +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseOrderSniff.php @@ -0,0 +1,198 @@ + + */ + public function register(): array + { + return [ + T_CLASS, + T_ANON_CLASS, + T_TRAIT, + T_ENUM, + ]; + } + + public function process(File $phpcsFile, int $classPointer): void + { + $usePointers = ClassHelper::getTraitUsePointers($phpcsFile, $classPointer); + + if (count($usePointers) === 0) { + return; + } + + $tokens = $phpcsFile->getTokens(); + + foreach ($usePointers as $usePointer) { + $this->processCommaSeparatedUse($phpcsFile, $classPointer, $usePointer); + } + + if (count($usePointers) <= 1) { + return; + } + + $uses = []; + + foreach ($usePointers as $usePointer) { + /** @var int $nameStartPointer */ + $nameStartPointer = TokenHelper::findNext($phpcsFile, TokenHelper::NAME_TOKEN_CODES, $usePointer + 1); + + $name = $tokens[$nameStartPointer]['content']; + + /** @var int $endPointer */ + $endPointer = TokenHelper::findNextLocal($phpcsFile, [T_SEMICOLON, T_OPEN_CURLY_BRACKET], $usePointer + 1); + + if ($tokens[$endPointer]['code'] === T_OPEN_CURLY_BRACKET) { + $endPointer = $tokens[$endPointer]['bracket_closer']; + } + + $contentStartPointer = $usePointer; + $previousNonWhitespace = TokenHelper::findPreviousNonWhitespace($phpcsFile, $usePointer - 1); + + if ($previousNonWhitespace !== null && $tokens[$previousNonWhitespace]['code'] === T_DOC_COMMENT_CLOSE_TAG) { + $contentStartPointer = $tokens[$previousNonWhitespace]['comment_opener']; + } elseif ($previousNonWhitespace !== null && $tokens[$previousNonWhitespace]['code'] === T_COMMENT) { + $contentStartPointer = $previousNonWhitespace; + + while (true) { + $prev = TokenHelper::findPreviousNonWhitespace($phpcsFile, $contentStartPointer - 1); + + if ($prev === null || $tokens[$prev]['code'] !== T_COMMENT) { + break; + } + + $contentStartPointer = $prev; + } + } + + $uses[] = [ + 'name' => $name, + 'contentStartPointer' => $contentStartPointer, + 'contentEndPointer' => $endPointer, + ]; + } + + $sortedUses = $uses; + + usort($sortedUses, fn (array $a, array $b): int => $this->compare($a['name'], $b['name'])); + + $isSorted = true; + + for ($i = 0; $i < count($uses); $i++) { + if ($uses[$i]['name'] !== $sortedUses[$i]['name']) { + $isSorted = false; + break; + } + } + + if ($isSorted) { + return; + } + + $fix = $phpcsFile->addFixableError('Incorrect order of trait use statements.', $classPointer, self::CODE_INCORRECT_ORDER); + + if (!$fix) { + return; + } + + $sortedContents = []; + + foreach ($sortedUses as $use) { + $sortedContents[] = TokenHelper::getContent($phpcsFile, $use['contentStartPointer'], $use['contentEndPointer']); + } + + $phpcsFile->fixer->beginChangeset(); + + foreach ($uses as $i => $use) { + FixerHelper::change($phpcsFile, $use['contentStartPointer'], $use['contentEndPointer'], $sortedContents[$i]); + } + + $phpcsFile->fixer->endChangeset(); + } + + private function compare(string $a, string $b): int + { + return NamespaceHelper::compareStatements($a, $b, $this->caseSensitive); + } + + private function processCommaSeparatedUse(File $phpcsFile, int $classPointer, int $usePointer): void + { + $tokens = $phpcsFile->getTokens(); + + /** @var int $endPointer */ + $endPointer = TokenHelper::findNextLocal($phpcsFile, [T_SEMICOLON, T_OPEN_CURLY_BRACKET], $usePointer + 1); + + $namePointers = []; + $pointer = $usePointer + 1; + + while ($pointer < $endPointer) { + $namePointer = TokenHelper::findNext($phpcsFile, TokenHelper::NAME_TOKEN_CODES, $pointer, $endPointer); + + if ($namePointer === null) { + break; + } + + $namePointers[] = $namePointer; + $pointer = $namePointer + 1; + } + + if (count($namePointers) <= 1) { + return; + } + + $names = []; + + foreach ($namePointers as $namePointer) { + $names[] = $tokens[$namePointer]['content']; + } + + $sortedNames = $names; + + usort($sortedNames, fn (string $a, string $b): int => $this->compare($a, $b)); + + if ($names === $sortedNames) { + return; + } + + $fix = $phpcsFile->addFixableError('Incorrect order of trait use statements.', $classPointer, self::CODE_INCORRECT_ORDER); + + if (!$fix) { + return; + } + + $phpcsFile->fixer->beginChangeset(); + + foreach ($namePointers as $i => $namePointer) { + $phpcsFile->fixer->replaceToken($namePointer, $sortedNames[$i]); + } + + $phpcsFile->fixer->endChangeset(); + } + +} diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseSpacingSniff.php index 651dcf8a6..aaa0b415a 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/TraitUseSpacingSniff.php @@ -52,11 +52,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $classPointer - */ - public function process(File $phpcsFile, $classPointer): void + public function process(File $phpcsFile, int $classPointer): void { $this->linesCountBeforeFirstUse = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirstUse); $this->linesCountBeforeFirstUseWhenFirstInClass = SniffSettingsHelper::normalizeNullableInteger( @@ -86,9 +82,9 @@ private function checkLinesBeforeFirstUse(File $phpcsFile, int $firstUsePointer) /** @var int $pointerBeforeFirstUse */ $pointerBeforeFirstUse = TokenHelper::findPreviousNonWhitespace($phpcsFile, $firstUsePointer - 1); - if (in_array($tokens[$pointerBeforeFirstUse]['code'], Tokens::$commentTokens, true)) { + if (in_array($tokens[$pointerBeforeFirstUse]['code'], Tokens::COMMENT_TOKENS, true)) { $pointerBeforeFirstUse = TokenHelper::findPreviousEffective($phpcsFile, $pointerBeforeFirstUse - 1); - $useStartPointer = TokenHelper::findNext($phpcsFile, Tokens::$commentTokens, $pointerBeforeFirstUse + 1); + $useStartPointer = TokenHelper::findNext($phpcsFile, Tokens::COMMENT_TOKENS, $pointerBeforeFirstUse + 1); } $isAtTheStartOfClass = $tokens[$pointerBeforeFirstUse]['code'] === T_OPEN_CURLY_BRACKET; @@ -239,10 +235,10 @@ private function checkLinesBetweenUses(File $phpcsFile, array $usePointers): voi $useStartPointer = $usePointer; $pointerBeforeUse = TokenHelper::findPreviousNonWhitespace($phpcsFile, $usePointer - 1); - if (in_array($tokens[$pointerBeforeUse]['code'], Tokens::$commentTokens, true)) { + if (in_array($tokens[$pointerBeforeUse]['code'], Tokens::COMMENT_TOKENS, true)) { $useStartPointer = TokenHelper::findNext( $phpcsFile, - Tokens::$commentTokens, + Tokens::COMMENT_TOKENS, TokenHelper::findPreviousEffective($phpcsFile, $pointerBeforeUse - 1) + 1, ); } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/UselessLateStaticBindingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/UselessLateStaticBindingSniff.php index 01306dcd3..0ea6fd0cf 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/UselessLateStaticBindingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Classes/UselessLateStaticBindingSniff.php @@ -28,11 +28,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $staticPointer - */ - public function process(File $phpcsFile, $staticPointer): void + public function process(File $phpcsFile, int $staticPointer): void { $tokens = $phpcsFile->getTokens(); @@ -43,7 +39,7 @@ public function process(File $phpcsFile, $staticPointer): void $classPointer = null; foreach (array_reverse($tokens[$staticPointer]['conditions'], true) as $conditionPointer => $conditionTokenCode) { - if (!in_array($conditionTokenCode, Tokens::$ooScopeTokens, true)) { + if (!in_array($conditionTokenCode, Tokens::OO_SCOPE_TOKENS, true)) { continue; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AbstractRequireOneLineDocComment.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AbstractRequireOneLineDocComment.php index 00cde5625..f79e8c42f 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AbstractRequireOneLineDocComment.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AbstractRequireOneLineDocComment.php @@ -29,11 +29,7 @@ public function register(): array return [T_DOC_COMMENT_OPEN_TAG]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentStartPointer - */ - public function process(File $phpcsFile, $docCommentStartPointer): void + public function process(File $phpcsFile, int $docCommentStartPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AnnotationNameSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AnnotationNameSniff.php index 12d75a31f..1f701a46b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AnnotationNameSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/AnnotationNameSniff.php @@ -161,11 +161,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer); $correctAnnotationNames = $this->getNormalizedAnnotationNames(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DeprecatedAnnotationDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DeprecatedAnnotationDeclarationSniff.php index c821eb52d..541c11b46 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DeprecatedAnnotationDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DeprecatedAnnotationDeclarationSniff.php @@ -21,11 +21,7 @@ public function register(): array return [T_DOC_COMMENT_OPEN_TAG]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentStartPointer - */ - public function process(File $phpcsFile, $docCommentStartPointer): void + public function process(File $phpcsFile, int $docCommentStartPointer): void { /** @var list> $annotations */ $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentStartPointer, '@deprecated'); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowCommentAfterCodeSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowCommentAfterCodeSniff.php index bc110ab9f..ed8fc55f3 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowCommentAfterCodeSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowCommentAfterCodeSniff.php @@ -34,11 +34,7 @@ public function register(): array return [...TokenHelper::INLINE_COMMENT_TOKEN_CODES, T_DOC_COMMENT_OPEN_TAG]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $commentPointer - */ - public function process(File $phpcsFile, $commentPointer): void + public function process(File $phpcsFile, int $commentPointer): void { $tokens = $phpcsFile->getTokens(); @@ -110,10 +106,10 @@ public function process(File $phpcsFile, $commentPointer): void ); } elseif ($tokens[$firstNonWhitespacePointerOnLine]['code'] === T_CLOSE_CURLY_BRACKET) { FixerHelper::add($phpcsFile, $firstNonWhiteSpacePointerBeforeComment, $phpcsFile->eolChar . $indentation . $commentContent); - } elseif (isset(Tokens::$stringTokens[$tokens[$firstPointerOnLine]['code']])) { + } elseif (isset(Tokens::STRING_TOKENS[$tokens[$firstPointerOnLine]['code']])) { $prevNonStringToken = TokenHelper::findPreviousExcluding( $phpcsFile, - [T_WHITESPACE] + Tokens::$stringTokens, + [T_WHITESPACE] + Tokens::STRING_TOKENS, $firstPointerOnLine - 1, ); $firstTokenOnNonStringTokenLine = TokenHelper::findFirstTokenOnLine($phpcsFile, $prevNonStringToken); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowOneLinePropertyDocCommentSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowOneLinePropertyDocCommentSniff.php index d7018dfea..48df5d05b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowOneLinePropertyDocCommentSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DisallowOneLinePropertyDocCommentSniff.php @@ -26,11 +26,7 @@ public function register(): array return [T_VARIABLE]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $propertyPointer - */ - public function process(File $phpcsFile, $propertyPointer): void + public function process(File $phpcsFile, int $propertyPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DocCommentSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DocCommentSpacingSniff.php index 2e790041f..1b58ad282 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DocCommentSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/DocCommentSpacingSniff.php @@ -74,11 +74,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenerPointer - */ - public function process(File $phpcsFile, $docCommentOpenerPointer): void + public function process(File $phpcsFile, int $docCommentOpenerPointer): void { $this->linesCountBeforeFirstContent = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirstContent); $this->linesCountBetweenDescriptionAndAnnotations = SniffSettingsHelper::normalizeInteger( diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/EmptyCommentSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/EmptyCommentSniff.php index 4617a6ced..08ddd14f8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/EmptyCommentSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/EmptyCommentSniff.php @@ -32,11 +32,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $commentStartPointer - */ - public function process(File $phpcsFile, $commentStartPointer): void + public function process(File $phpcsFile, int $commentStartPointer): void { $commentEndPointer = CommentHelper::getCommentEndPointer($phpcsFile, $commentStartPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenAnnotationsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenAnnotationsSniff.php index 8e3328d7e..c2d4fdfb7 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenAnnotationsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenAnnotationsSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenCommentsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenCommentsSniff.php index bb5d3c628..cebe36555 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenCommentsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ForbiddenCommentsSniff.php @@ -32,11 +32,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/InlineDocCommentDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/InlineDocCommentDeclarationSniff.php index d9ed4648e..351d1dd01 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/InlineDocCommentDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/InlineDocCommentDeclarationSniff.php @@ -61,11 +61,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $commentOpenPointer - */ - public function process(File $phpcsFile, $commentOpenPointer): void + public function process(File $phpcsFile, int $commentOpenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneDocCommentSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneDocCommentSniff.php new file mode 100644 index 000000000..d14012712 --- /dev/null +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneDocCommentSniff.php @@ -0,0 +1,94 @@ + + */ + public function register(): array + { + return [T_DOC_COMMENT_OPEN_TAG]; + } + + public function process(File $phpcsFile, int $stackPointer): void + { + $tokens = $phpcsFile->getTokens(); + + $firstOpener = $stackPointer; + $firstCloser = $tokens[$firstOpener]['comment_closer']; + + /** @var int $next */ + $next = $phpcsFile->findNext([T_WHITESPACE], $firstCloser + 1, null, true); + + if ($tokens[$next]['code'] === T_COMMENT) { + return; + } + + if ($tokens[$next]['code'] !== T_DOC_COMMENT_OPEN_TAG) { + return; + } + + $secondOpener = $next; + $secondCloser = $tokens[$secondOpener]['comment_closer']; + + if ($this->isSingleLineVarDoc($phpcsFile, $firstOpener, $firstCloser) + && $this->isSingleLineVarDoc($phpcsFile, $secondOpener, $secondCloser)) { + return; + } + + $error = 'Only one PHPDoc comment is allowed for a documentable entity; found two adjacent doc comments.'; + $phpcsFile->addError($error, $firstOpener, self::CODE_MULTIPLE_DOC_COMMENTS); + } + + private function isSingleLineVarDoc(File $phpcsFile, int $opener, int $closer): bool + { + $length = $closer - $opener + 1; + $text = $phpcsFile->getTokensAsString($opener, $length); + + if ((strpos($text, "\n") !== false) || (strpos($text, "\r") !== false)) { + return false; + } + + $inner = $this->getDocInner($text); + + return preg_match('/^@var\b/i', $inner) === 1 && preg_match('/\$\w+\s*$/', $inner) === 1; + } + + private function getDocInner(string $doc): string + { + $doc = preg_replace('#\A\s*/\*\*\s*#s', '', $doc); + $doc = preg_replace('#\s*\*/\s*\z#s', '', $doc); + + /** @var list $lines */ + $lines = preg_split("/\r\n|\n|\r/", $doc); + + $clean = []; + + foreach ($lines as $line) { + $line = preg_replace('#^\s*\*\s?#', '', $line); + $clean[] = $line; + } + + $inner = implode("\n", $clean); + + return trim($inner, "\n\r "); + } + +} diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneLinePropertyDocCommentSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneLinePropertyDocCommentSniff.php index 2749bd466..32fd545ae 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneLinePropertyDocCommentSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/RequireOneLinePropertyDocCommentSniff.php @@ -14,11 +14,7 @@ class RequireOneLinePropertyDocCommentSniff extends AbstractRequireOneLineDocCom public const CODE_MULTI_LINE_PROPERTY_COMMENT = 'MultiLinePropertyComment'; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentStartPointer - */ - public function process(File $phpcsFile, $docCommentStartPointer): void + public function process(File $phpcsFile, int $docCommentStartPointer): void { $propertyPointer = TokenHelper::findNext($phpcsFile, T_VARIABLE, $docCommentStartPointer + 1); if ($propertyPointer === null) { diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ThrowsAnnotationsOrderSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ThrowsAnnotationsOrderSniff.php new file mode 100644 index 000000000..f63bb232d --- /dev/null +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/ThrowsAnnotationsOrderSniff.php @@ -0,0 +1,131 @@ + + */ + public function register(): array + { + return [T_FUNCTION, T_CLOSURE]; + } + + public function process(File $phpcsFile, int $functionPointer): void + { + $annotations = AnnotationHelper::getAnnotations($phpcsFile, $functionPointer, '@throws'); + + if (count($annotations) <= 1) { + return; + } + + $actualOrder = []; + foreach ($annotations as $key => $annotation) { + $actualOrder[$key] = $this->getExceptionName($annotation); + } + + $expectedOrder = $actualOrder; + uasort($expectedOrder, fn (string $a, string $b): int => NamespaceHelper::compareStatements($a, $b, $this->caseSensitive)); + + if ($expectedOrder === $actualOrder) { + return; + } + + $firstAnnotation = $annotations[0]; + + $fix = $phpcsFile->addFixableError( + 'Incorrect order of @throws annotations.', + $firstAnnotation->getStartPointer(), + self::CODE_INCORRECT_ORDER, + ); + + if (!$fix) { + return; + } + + $annotationsContent = []; + foreach ($annotations as $key => $annotation) { + $annotationsContent[$key] = trim(TokenHelper::getContent( + $phpcsFile, + $annotation->getStartPointer(), + $annotation->getEndPointer(), + )); + } + + $lastAnnotation = $annotations[count($annotations) - 1]; + $indentation = IndentationHelper::getIndentation($phpcsFile, $firstAnnotation->getStartPointer()); + + // Build the replacement content + $fixedContent = ''; + $isFirst = true; + foreach (array_keys($expectedOrder) as $key) { + if ($isFirst) { + $isFirst = false; + } else { + $fixedContent .= sprintf('%s%s', $phpcsFile->eolChar, $indentation); + } + + $fixedContent .= $annotationsContent[$key]; + } + + $phpcsFile->fixer->beginChangeset(); + + FixerHelper::change( + $phpcsFile, + $firstAnnotation->getStartPointer(), + $lastAnnotation->getEndPointer(), + $fixedContent, + ); + + $phpcsFile->fixer->endChangeset(); + } + + /** + * @param Annotation $annotation + */ + private function getExceptionName(Annotation $annotation): string + { + if ($annotation->isInvalid()) { + return ''; + } + + $type = $annotation->getValue()->type; + + if ($type instanceof IdentifierTypeNode) { + return $type->name; + } + + if ($type instanceof UnionTypeNode && count($type->types) > 0 && $type->types[0] instanceof IdentifierTypeNode) { + return $type->types[0]->name; + } + + return AnnotationTypeHelper::print($type); + } + +} diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessFunctionDocCommentSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessFunctionDocCommentSniff.php index 5fe0d32e2..8a44d7213 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessFunctionDocCommentSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessFunctionDocCommentSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { if (!DocCommentHelper::hasDocComment($phpcsFile, $functionPointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessInheritDocCommentSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessInheritDocCommentSniff.php index e36d8bcb1..a07f5f3e1 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessInheritDocCommentSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Commenting/UselessInheritDocCommentSniff.php @@ -30,11 +30,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Complexity/CognitiveSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Complexity/CognitiveSniff.php index 5532fa9f3..9fe3a8d17 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Complexity/CognitiveSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Complexity/CognitiveSniff.php @@ -133,11 +133,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stackPtr - */ - public function process(File $phpcsFile, $stackPtr): void + public function process(File $phpcsFile, int $stackPtr): void { $this->phpcsFile = $phpcsFile; @@ -157,7 +153,9 @@ public function process(File $phpcsFile, $stackPtr): void return; } - $name = $phpcsFile->getDeclarationName($stackPtr); + $name = $phpcsFile->getTokens()[$stackPtr]['code'] === T_FUNCTION + ? FunctionHelper::getName($phpcsFile, $stackPtr) + : 'anonymous function'; $errorParameters = [ 'Cognitive complexity for "%s" is %d but has to be less than or equal to %d.', @@ -192,7 +190,7 @@ public function computeForFunctionFromTokensAndPosition(int $position): int /* Keep track of parser's level stack - We push to this stak whenever we encounter a Tokens::$scopeOpeners + We push to this stak whenever we encounter a Tokens::SCOPE_OPENERS token */ $levelStack = []; /* @@ -206,7 +204,7 @@ public function computeForFunctionFromTokensAndPosition(int $position): int $currentToken = $tokens[$i]; $isNestingToken = false; - if (in_array($currentToken['code'], Tokens::$scopeOpeners, true)) { + if (in_array($currentToken['code'], Tokens::SCOPE_OPENERS, true)) { $isNestingToken = true; if ($levelIncreased === false && count($levelStack) > 0) { // parser's level never increased @@ -310,7 +308,7 @@ private function isIncrementingToken(array $token, array $tokens, int $position) // B1. goto LABEL, break LABEL, continue LABEL if (isset(self::BREAKING_TOKENS[$code])) { - $nextToken = $this->phpcsFile->findNext(Tokens::$emptyTokens, $position + 1, null, true); + $nextToken = $this->phpcsFile->findNext(Tokens::EMPTY_TOKENS, $position + 1, null, true); if ($nextToken === false || $tokens[$nextToken]['code'] !== T_SEMICOLON) { return true; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AbstractControlStructureSpacing.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AbstractControlStructureSpacing.php index bb78ca8ae..86d249f5b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AbstractControlStructureSpacing.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AbstractControlStructureSpacing.php @@ -109,11 +109,7 @@ public function register(): array return $this->getTokensToCheck(); } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $controlStructurePointer - */ - public function process(File $phpcsFile, $controlStructurePointer): void + public function process(File $phpcsFile, int $controlStructurePointer): void { $this->checkLinesBefore($phpcsFile, $controlStructurePointer); @@ -143,7 +139,7 @@ protected function checkLinesBefore(File $phpcsFile, int $controlStructurePointe $pointerToCheckFirst = $pointerBefore; - if (in_array($tokens[$nonWhitespacePointerBefore]['code'], Tokens::$commentTokens, true)) { + if (in_array($tokens[$nonWhitespacePointerBefore]['code'], Tokens::COMMENT_TOKENS, true)) { $effectivePointerBefore = TokenHelper::findPreviousEffective($phpcsFile, $pointerBefore - 1); if ($tokens[$effectivePointerBefore]['line'] === $tokens[$nonWhitespacePointerBefore]['line']) { @@ -261,7 +257,7 @@ protected function checkLinesAfter(File $phpcsFile, int $controlStructurePointer return; } - $hasCommentAfter = in_array($tokens[$notWhitespacePointerAfter]['code'], Tokens::$commentTokens, true); + $hasCommentAfter = in_array($tokens[$notWhitespacePointerAfter]['code'], Tokens::COMMENT_TOKENS, true); $isCommentAfterOnSameLine = false; $pointerAfter = $notWhitespacePointerAfter; @@ -466,7 +462,7 @@ private function findControlStructureEnd(File $phpcsFile, int $controlStructureP if (TokenHelper::findPrevious($phpcsFile, T_SWITCH, $pointer - 1) === $switchPointer) { $pointerBeforeCaseOrDefault = TokenHelper::findPreviousNonWhitespace($phpcsFile, $pointer - 1); if ( - in_array($tokens[$pointerBeforeCaseOrDefault]['code'], Tokens::$commentTokens, true) + in_array($tokens[$pointerBeforeCaseOrDefault]['code'], Tokens::COMMENT_TOKENS, true) && $tokens[$pointerBeforeCaseOrDefault]['line'] + 1 === $tokens[$pointer]['line'] ) { $pointerBeforeCaseOrDefault = TokenHelper::findPreviousExcluding( diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AssignmentInConditionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AssignmentInConditionSniff.php index 8042fb98a..debaf1c96 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AssignmentInConditionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/AssignmentInConditionSniff.php @@ -33,11 +33,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $conditionStartPointer - */ - public function process(File $phpcsFile, $conditionStartPointer): void + public function process(File $phpcsFile, int $conditionStartPointer): void { $tokens = $phpcsFile->getTokens(); $token = $tokens[$conditionStartPointer]; @@ -88,12 +84,7 @@ private function processCondition(File $phpcsFile, int $parenthesisOpener, int $ continue; } - $functionCall = TokenHelper::findPrevious( - $phpcsFile, - TokenHelper::ONLY_NAME_TOKEN_CODES, - $insideParenthesis, - $parenthesisOpener, - ); + $functionCall = TokenHelper::findPrevious($phpcsFile, TokenHelper::NAME_TOKEN_CODES, $insideParenthesis, $parenthesisOpener); if ($functionCall !== null) { continue; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/BlockControlStructureSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/BlockControlStructureSpacingSniff.php index 3247e2247..35858aaa0 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/BlockControlStructureSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/BlockControlStructureSpacingSniff.php @@ -24,11 +24,7 @@ class BlockControlStructureSpacingSniff extends AbstractControlStructureSpacing /** @var list */ public array $controlStructures = []; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $controlStructurePointer - */ - public function process(File $phpcsFile, $controlStructurePointer): void + public function process(File $phpcsFile, int $controlStructurePointer): void { $this->linesCountBefore = SniffSettingsHelper::normalizeInteger($this->linesCountBefore); $this->linesCountBeforeFirst = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirst); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowContinueWithoutIntegerOperandInSwitchSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowContinueWithoutIntegerOperandInSwitchSniff.php index f3f94e918..f60c118d8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowContinueWithoutIntegerOperandInSwitchSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowContinueWithoutIntegerOperandInSwitchSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $continuePointer - */ - public function process(File $phpcsFile, $continuePointer): void + public function process(File $phpcsFile, int $continuePointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowEmptySniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowEmptySniff.php index e7cf97378..15c9140c3 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowEmptySniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowEmptySniff.php @@ -21,11 +21,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $emptyPointer - */ - public function process(File $phpcsFile, $emptyPointer): void + public function process(File $phpcsFile, int $emptyPointer): void { $phpcsFile->addError('Use of empty() is disallowed.', $emptyPointer, self::CODE_DISALLOWED_EMPTY); } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowNullSafeObjectOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowNullSafeObjectOperatorSniff.php index 6a26e4f30..8e7a7d995 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowNullSafeObjectOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowNullSafeObjectOperatorSniff.php @@ -21,11 +21,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $operatorPointer - */ - public function process(File $phpcsFile, $operatorPointer): void + public function process(File $phpcsFile, int $operatorPointer): void { $phpcsFile->addError('Operator ?-> is disallowed.', $operatorPointer, self::CODE_DISALLOWED_NULL_SAFE_OBJECT_OPERATOR); } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowShortTernaryOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowShortTernaryOperatorSniff.php index dc9fed5f1..0b138814c 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowShortTernaryOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowShortTernaryOperatorSniff.php @@ -28,11 +28,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $inlineThenPointer - */ - public function process(File $phpcsFile, $inlineThenPointer): void + public function process(File $phpcsFile, int $inlineThenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowTrailingMultiLineTernaryOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowTrailingMultiLineTernaryOperatorSniff.php index 1a2657330..c7626b8ee 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowTrailingMultiLineTernaryOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowTrailingMultiLineTernaryOperatorSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $inlineThenPointer - */ - public function process(File $phpcsFile, $inlineThenPointer): void + public function process(File $phpcsFile, int $inlineThenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowYodaComparisonSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowYodaComparisonSniff.php index 8cdc703e9..26f300f40 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowYodaComparisonSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/DisallowYodaComparisonSniff.php @@ -39,11 +39,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $comparisonTokenPointer - */ - public function process(File $phpcsFile, $comparisonTokenPointer): void + public function process(File $phpcsFile, int $comparisonTokenPointer): void { $tokens = $phpcsFile->getTokens(); $leftSideTokens = YodaHelper::getLeftSideTokens($tokens, $comparisonTokenPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/EarlyExitSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/EarlyExitSniff.php index 38c93bcb1..00e70c8b8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/EarlyExitSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/EarlyExitSniff.php @@ -56,11 +56,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/JumpStatementsSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/JumpStatementsSpacingSniff.php index b56db0244..30c503ece 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/JumpStatementsSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/JumpStatementsSpacingSniff.php @@ -44,11 +44,7 @@ class JumpStatementsSpacingSniff extends AbstractControlStructureSpacing /** @var list */ public array $jumpStatements = []; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $jumpStatementPointer - */ - public function process(File $phpcsFile, $jumpStatementPointer): void + public function process(File $phpcsFile, int $jumpStatementPointer): void { $this->linesCountBefore = SniffSettingsHelper::normalizeInteger($this->linesCountBefore); $this->linesCountBeforeFirst = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirst); @@ -188,7 +184,7 @@ private function isOneOfYieldSpecialCases(File $phpcsFile, int $jumpStatementPoi $pointerBefore = TokenHelper::findPreviousEffective($phpcsFile, $jumpStatementPointer - 1); // check if yield is used in assignment - if (in_array($tokens[$pointerBefore]['code'], Tokens::$assignmentTokens, true)) { + if (in_array($tokens[$pointerBefore]['code'], Tokens::ASSIGNMENT_TOKENS, true)) { return true; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/LanguageConstructWithParenthesesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/LanguageConstructWithParenthesesSniff.php index e26ebf874..99a22d7f4 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/LanguageConstructWithParenthesesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/LanguageConstructWithParenthesesSniff.php @@ -54,11 +54,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $languageConstructPointer - */ - public function process(File $phpcsFile, $languageConstructPointer): void + public function process(File $phpcsFile, int $languageConstructPointer): void { $tokens = $phpcsFile->getTokens(); /** @var int $openParenthesisPointer */ diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithParenthesesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithParenthesesSniff.php index 04549c213..c2745722e 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithParenthesesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithParenthesesSniff.php @@ -37,11 +37,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $newPointer - */ - public function process(File $phpcsFile, $newPointer): void + public function process(File $phpcsFile, int $newPointer): void { $tokens = $phpcsFile->getTokens(); /** @var int $nextPointer */ diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithoutParenthesesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithoutParenthesesSniff.php index 378ff3ccc..136417c95 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithoutParenthesesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/NewWithoutParenthesesSniff.php @@ -6,6 +6,7 @@ use PHP_CodeSniffer\Sniffs\Sniff; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\TokenHelper; +use function in_array; use const T_ANON_CLASS; use const T_CLOSE_PARENTHESIS; use const T_CLOSE_SHORT_ARRAY; @@ -13,10 +14,14 @@ use const T_COALESCE; use const T_COMMA; use const T_DOUBLE_ARROW; +use const T_DOUBLE_COLON; use const T_INLINE_ELSE; use const T_INLINE_THEN; use const T_NEW; +use const T_NULLSAFE_OBJECT_OPERATOR; +use const T_OBJECT_OPERATOR; use const T_OPEN_PARENTHESIS; +use const T_OPEN_SQUARE_BRACKET; use const T_SEMICOLON; class NewWithoutParenthesesSniff implements Sniff @@ -34,11 +39,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $newPointer - */ - public function process(File $phpcsFile, $newPointer): void + public function process(File $phpcsFile, int $newPointer): void { $tokens = $phpcsFile->getTokens(); /** @var int $nextPointer */ @@ -87,6 +88,21 @@ public function process(File $phpcsFile, $newPointer): void return; } + $pointerAfterParenthesisCloser = TokenHelper::findNextEffective( + $phpcsFile, + $tokens[$parenthesisOpenerPointer]['parenthesis_closer'] + 1, + ); + if ( + $pointerAfterParenthesisCloser !== null + && in_array( + $tokens[$pointerAfterParenthesisCloser]['code'], + [T_OBJECT_OPERATOR, T_NULLSAFE_OBJECT_OPERATOR, T_DOUBLE_COLON, T_OPEN_SQUARE_BRACKET, T_OPEN_PARENTHESIS], + true, + ) + ) { + return; + } + $fix = $phpcsFile->addFixableError('Useless parentheses in "new".', $newPointer, self::CODE_USELESS_PARENTHESES); if (!$fix) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineConditionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineConditionSniff.php index 0b798ffbe..b71402bbc 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineConditionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineConditionSniff.php @@ -26,11 +26,7 @@ class RequireMultiLineConditionSniff extends AbstractLineCondition public bool $alwaysSplitAllConditionParts = false; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $controlStructurePointer - */ - public function process(File $phpcsFile, $controlStructurePointer): void + public function process(File $phpcsFile, int $controlStructurePointer): void { $this->minLineLength = SniffSettingsHelper::normalizeInteger($this->minLineLength); @@ -45,7 +41,7 @@ public function process(File $phpcsFile, $controlStructurePointer): void $booleanOperatorPointers = TokenHelper::findNextAll( $phpcsFile, - Tokens::$booleanOperators, + Tokens::BOOLEAN_OPERATORS, $parenthesisOpenerPointer + 1, $parenthesisCloserPointer, ); @@ -109,7 +105,7 @@ public function process(File $phpcsFile, $controlStructurePointer): void if ($tokens[$i]['code'] === T_OPEN_PARENTHESIS) { $containsBooleanOperator = TokenHelper::findNext( $phpcsFile, - Tokens::$booleanOperators, + Tokens::BOOLEAN_OPERATORS, $i + 1, $tokens[$i]['parenthesis_closer'], ) !== null; @@ -146,7 +142,7 @@ public function process(File $phpcsFile, $controlStructurePointer): void continue; } - if (!in_array($tokens[$i]['code'], Tokens::$booleanOperators, true)) { + if (!in_array($tokens[$i]['code'], Tokens::BOOLEAN_OPERATORS, true)) { continue; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineTernaryOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineTernaryOperatorSniff.php index d465836d8..82ee233d6 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineTernaryOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireMultiLineTernaryOperatorSniff.php @@ -38,12 +38,12 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $inlineThenPointer - */ - public function process(File $phpcsFile, $inlineThenPointer): void + public function process(File $phpcsFile, int $inlineThenPointer): void { + if (!TernaryOperatorHelper::is($phpcsFile, $inlineThenPointer)) { + return; + } + $this->lineLengthLimit = SniffSettingsHelper::normalizeInteger($this->lineLengthLimit); $this->minExpressionsLength = SniffSettingsHelper::normalizeNullableInteger($this->minExpressionsLength); @@ -129,14 +129,6 @@ private function getEndOfLineBefore(File $phpcsFile, int $pointer): int break; } - if ( - $tokens[$possibleEndOfLinePointer]['code'] === T_OPEN_TAG - || $tokens[$possibleEndOfLinePointer]['code'] === T_OPEN_TAG_WITH_ECHO - ) { - $endOfLineBefore = $possibleEndOfLinePointer; - break; - } - if ( in_array($tokens[$possibleEndOfLinePointer]['code'], TokenHelper::INLINE_COMMENT_TOKEN_CODES, true) && substr($tokens[$possibleEndOfLinePointer]['content'], -1) === $phpcsFile->eolChar diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniff.php index 6d966fe51..0c30784e4 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceEqualOperatorSniff.php @@ -44,11 +44,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $equalPointer - */ - public function process(File $phpcsFile, $equalPointer): void + public function process(File $phpcsFile, int $equalPointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 70400); @@ -94,7 +90,7 @@ private function checkCoalesce(File $phpcsFile, int $equalPointer): void } $semicolonPointer = TokenHelper::findNext($phpcsFile, T_SEMICOLON, $equalPointer + 1); - if (TokenHelper::findNext($phpcsFile, Tokens::$operators, $nullCoalescePointer + 1, $semicolonPointer) !== null) { + if (TokenHelper::findNext($phpcsFile, Tokens::OPERATORS, $nullCoalescePointer + 1, $semicolonPointer) !== null) { return; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceOperatorSniff.php index dff8ad2d7..32020d714 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullCoalesceOperatorSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $tokens = $phpcsFile->getTokens(); @@ -62,12 +58,12 @@ public function checkIsset(File $phpcsFile, int $issetPointer): void return; } - if (in_array($tokens[$previousPointer]['code'], Tokens::$booleanOperators, true)) { + if (in_array($tokens[$previousPointer]['code'], Tokens::BOOLEAN_OPERATORS, true)) { return; } - $openParenthesisPointer = TokenHelper::findNextEffective($phpcsFile, $issetPointer + 1); - $closeParenthesisPointer = $tokens[$openParenthesisPointer]['parenthesis_closer']; + $openParenthesisPointer = $tokens[$issetPointer]['parenthesis_opener']; + $closeParenthesisPointer = $tokens[$issetPointer]['parenthesis_closer']; /** @var int $inlineThenPointer */ $inlineThenPointer = TokenHelper::findNextEffective($phpcsFile, $closeParenthesisPointer + 1); @@ -99,7 +95,7 @@ public function checkIsset(File $phpcsFile, int $issetPointer): void } $startPointer = $issetPointer; - if (in_array($tokens[$previousPointer]['code'], Tokens::$castTokens, true)) { + if (in_array($tokens[$previousPointer]['code'], Tokens::CAST_TOKENS, true)) { $startPointer = $previousPointer; } @@ -145,7 +141,7 @@ public function checkIdenticalOperator(File $phpcsFile, int $identicalOperator): ($isYodaCondition ? $pointerBeforeIdenticalOperator : $variableStartPointer) - 1, ); - if (in_array($tokens[$pointerBeforeCondition]['code'], Tokens::$booleanOperators, true)) { + if (in_array($tokens[$pointerBeforeCondition]['code'], Tokens::BOOLEAN_OPERATORS, true)) { return; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullSafeObjectOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullSafeObjectOperatorSniff.php index bebfa7755..4a318451f 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullSafeObjectOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireNullSafeObjectOperatorSniff.php @@ -54,11 +54,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $identicalPointer - */ - public function process(File $phpcsFile, $identicalPointer): int + public function process(File $phpcsFile, int $identicalPointer): int { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); @@ -119,7 +115,7 @@ private function checkTernaryOperator( $searchStartPointer = $ternaryOperatorStartPointer; do { - $booleanOperatorPointer = TokenHelper::findNext($phpcsFile, Tokens::$booleanOperators, $searchStartPointer, $inlineThenPointer); + $booleanOperatorPointer = TokenHelper::findNext($phpcsFile, Tokens::BOOLEAN_OPERATORS, $searchStartPointer, $inlineThenPointer); if ($booleanOperatorPointer === null) { break; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireShortTernaryOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireShortTernaryOperatorSniff.php index be9658d48..aceebcb0e 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireShortTernaryOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireShortTernaryOperatorSniff.php @@ -29,11 +29,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $inlineThenPointer - */ - public function process(File $phpcsFile, $inlineThenPointer): void + public function process(File $phpcsFile, int $inlineThenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireSingleLineConditionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireSingleLineConditionSniff.php index a92708fe2..3c04613d8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireSingleLineConditionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireSingleLineConditionSniff.php @@ -19,11 +19,7 @@ class RequireSingleLineConditionSniff extends AbstractLineCondition public bool $alwaysForSimpleConditions = true; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $controlStructurePointer - */ - public function process(File $phpcsFile, $controlStructurePointer): void + public function process(File $phpcsFile, int $controlStructurePointer): void { $this->maxLineLength = SniffSettingsHelper::normalizeInteger($this->maxLineLength); @@ -56,7 +52,7 @@ public function process(File $phpcsFile, $controlStructurePointer): void $lineLength = strlen($lineStart . $condition . $lineEnd); $isSimpleCondition = TokenHelper::findNext( $phpcsFile, - Tokens::$booleanOperators, + Tokens::BOOLEAN_OPERATORS, $parenthesisOpenerPointer + 1, $parenthesisCloserPointer, ) === null; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireTernaryOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireTernaryOperatorSniff.php index ac72140ef..4359e37d0 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireTernaryOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireTernaryOperatorSniff.php @@ -39,11 +39,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $ifPointer - */ - public function process(File $phpcsFile, $ifPointer): void + public function process(File $phpcsFile, int $ifPointer): void { $tokens = $phpcsFile->getTokens(); @@ -245,7 +241,7 @@ private function containsComment(File $phpcsFile, int $scopeOwnerPointer): bool $tokens = $phpcsFile->getTokens(); return TokenHelper::findNext( $phpcsFile, - Tokens::$commentTokens, + Tokens::COMMENT_TOKENS, $tokens[$scopeOwnerPointer]['scope_opener'] + 1, $tokens[$scopeOwnerPointer]['scope_closer'], ) !== null; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireYodaComparisonSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireYodaComparisonSniff.php index b610df63e..3d35d455a 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireYodaComparisonSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/RequireYodaComparisonSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $comparisonTokenPointer - */ - public function process(File $phpcsFile, $comparisonTokenPointer): void + public function process(File $phpcsFile, int $comparisonTokenPointer): void { $tokens = $phpcsFile->getTokens(); $leftSideTokens = YodaHelper::getLeftSideTokens($tokens, $comparisonTokenPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessIfConditionWithReturnSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessIfConditionWithReturnSniff.php index 38bc8f250..fd7dfc051 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessIfConditionWithReturnSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessIfConditionWithReturnSniff.php @@ -36,11 +36,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $ifPointer - */ - public function process(File $phpcsFile, $ifPointer): void + public function process(File $phpcsFile, int $ifPointer): void { $tokens = $phpcsFile->getTokens(); @@ -143,7 +139,7 @@ private function isFixable(File $phpcsFile, int $ifPointer, int $endPointer): bo { $tokens = $phpcsFile->getTokens(); - if (TokenHelper::findNext($phpcsFile, Tokens::$commentTokens, $ifPointer + 1, $endPointer) !== null) { + if (TokenHelper::findNext($phpcsFile, Tokens::COMMENT_TOKENS, $ifPointer + 1, $endPointer) !== null) { return false; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessTernaryOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessTernaryOperatorSniff.php index 004faa2ff..c83b3c34c 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessTernaryOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/ControlStructures/UselessTernaryOperatorSniff.php @@ -31,11 +31,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $inlineThenPointer - */ - public function process(File $phpcsFile, $inlineThenPointer): void + public function process(File $phpcsFile, int $inlineThenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/CatchExceptionsOrderSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/CatchExceptionsOrderSniff.php new file mode 100644 index 000000000..a2954f2d1 --- /dev/null +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/CatchExceptionsOrderSniff.php @@ -0,0 +1,111 @@ + + */ + public function register(): array + { + return [ + T_CATCH, + ]; + } + + public function process(File $phpcsFile, int $catchPointer): void + { + $tokens = $phpcsFile->getTokens(); + $catchToken = $tokens[$catchPointer]; + + /** @var int $parenthesisOpenerPointer */ + $parenthesisOpenerPointer = $catchToken['parenthesis_opener']; + /** @var int $parenthesisCloserPointer */ + $parenthesisCloserPointer = $catchToken['parenthesis_closer']; + + /** @var list $exceptions */ + $exceptions = []; + $nameEndPointer = $parenthesisOpenerPointer; + + do { + $nameStartPointer = TokenHelper::findNext( + $phpcsFile, + [T_BITWISE_OR, ...TokenHelper::NAME_TOKEN_CODES], + $nameEndPointer + 1, + $parenthesisCloserPointer, + ); + + if ($nameStartPointer === null) { + break; + } + + if ($tokens[$nameStartPointer]['code'] === T_BITWISE_OR) { + /** @var int $nameStartPointer */ + $nameStartPointer = TokenHelper::findNextEffective($phpcsFile, $nameStartPointer + 1, $parenthesisCloserPointer); + } + + $pointerAfterNameEndPointer = TokenHelper::findNextExcluding($phpcsFile, TokenHelper::NAME_TOKEN_CODES, $nameStartPointer + 1); + $nameEndPointer = $pointerAfterNameEndPointer === null ? $nameStartPointer : $pointerAfterNameEndPointer - 1; + + $exceptions[] = [ + 'name' => TokenHelper::getContent($phpcsFile, $nameStartPointer, $nameEndPointer), + 'startPointer' => $nameStartPointer, + 'endPointer' => $nameEndPointer, + ]; + } while (true); + + if (count($exceptions) <= 1) { + return; + } + + $sortedNames = []; + foreach ($exceptions as $exception) { + $sortedNames[] = $exception['name']; + } + usort($sortedNames, fn (string $a, string $b): int => NamespaceHelper::compareStatements($a, $b, $this->caseSensitive)); + + $originalNames = []; + foreach ($exceptions as $exception) { + $originalNames[] = $exception['name']; + } + + if ($sortedNames === $originalNames) { + return; + } + + $fix = $phpcsFile->addFixableError( + 'Caught exception types are not in alphabetical order.', + $catchPointer, + self::CODE_INCORRECT_ORDER, + ); + + if (!$fix) { + return; + } + + $phpcsFile->fixer->beginChangeset(); + + foreach ($exceptions as $i => $exception) { + FixerHelper::change($phpcsFile, $exception['startPointer'], $exception['endPointer'], $sortedNames[$i]); + } + + $phpcsFile->fixer->endChangeset(); + } + +} diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DeadCatchSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DeadCatchSniff.php index 8a3c29208..29924a538 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DeadCatchSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DeadCatchSniff.php @@ -24,11 +24,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $catchPointer - */ - public function process(File $phpcsFile, $catchPointer): void + public function process(File $phpcsFile, int $catchPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DisallowNonCapturingCatchSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DisallowNonCapturingCatchSniff.php index a519bf112..da2653ae9 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DisallowNonCapturingCatchSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/DisallowNonCapturingCatchSniff.php @@ -23,11 +23,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $catchPointer - */ - public function process(File $phpcsFile, $catchPointer): void + public function process(File $phpcsFile, int $catchPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/ReferenceThrowableOnlySniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/ReferenceThrowableOnlySniff.php index 987e3e4a6..713bba126 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/ReferenceThrowableOnlySniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/ReferenceThrowableOnlySniff.php @@ -41,11 +41,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/RequireNonCapturingCatchSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/RequireNonCapturingCatchSniff.php index 37344d883..eff49dd01 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/RequireNonCapturingCatchSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Exceptions/RequireNonCapturingCatchSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $catchPointer - */ - public function process(File $phpcsFile, $catchPointer): void + public function process(File $phpcsFile, int $catchPointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/FileLengthSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/FileLengthSniff.php index 111adb325..f3498c9ab 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/FileLengthSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/FileLengthSniff.php @@ -31,11 +31,7 @@ public function register(): array return [T_OPEN_TAG]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->maxLinesLength = SniffSettingsHelper::normalizeInteger($this->maxLinesLength); $flags = array_keys(array_filter([ diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/LineLengthSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/LineLengthSniff.php index 877df07fa..a175acd68 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/LineLengthSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/LineLengthSniff.php @@ -44,11 +44,9 @@ public function register(): array } /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint * @phpcsSuppress SlevomatCodingStandard.Functions.UnusedParameter.UnusedParameter - * @param int $pointer */ - public function process(File $phpcsFile, $pointer): int + public function process(File $phpcsFile, int $pointer): int { $tokens = $phpcsFile->getTokens(); for ($i = 0; $i < $phpcsFile->numTokens; $i++) { diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/TypeNameMatchesFileNameSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/TypeNameMatchesFileNameSniff.php index 14f6ccae5..f36f3a202 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/TypeNameMatchesFileNameSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Files/TypeNameMatchesFileNameSniff.php @@ -61,11 +61,7 @@ public function register(): array return TokenHelper::CLASS_TYPE_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $typePointer - */ - public function process(File $phpcsFile, $typePointer): void + public function process(File $phpcsFile, int $typePointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/AbstractLineCall.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/AbstractLineCall.php index 4d81e92a0..28e5a9212 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/AbstractLineCall.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/AbstractLineCall.php @@ -11,9 +11,6 @@ use const T_COMMA; use const T_FUNCTION; use const T_OPEN_PARENTHESIS; -use const T_PARENT; -use const T_SELF; -use const T_STATIC; use const T_WHITESPACE; abstract class AbstractLineCall implements Sniff @@ -24,7 +21,7 @@ abstract class AbstractLineCall implements Sniff */ public function register(): array { - return [...TokenHelper::ONLY_NAME_TOKEN_CODES, T_SELF, T_STATIC, T_PARENT]; + return [...TokenHelper::NAME_TOKEN_CODES, ...TokenHelper::CLASS_KEYWORD_CODES]; } protected function isCall(File $phpcsFile, int $stringPointer): bool diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/ArrowFunctionDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/ArrowFunctionDeclarationSniff.php index c9fd1ea18..35a29b03c 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/ArrowFunctionDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/ArrowFunctionDeclarationSniff.php @@ -40,11 +40,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $arrowFunctionPointer - */ - public function process(File $phpcsFile, $arrowFunctionPointer): void + public function process(File $phpcsFile, int $arrowFunctionPointer): void { $this->spacesCountAfterKeyword = SniffSettingsHelper::normalizeInteger($this->spacesCountAfterKeyword); $this->spacesCountBeforeArrow = SniffSettingsHelper::normalizeInteger($this->spacesCountBeforeArrow); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowArrowFunctionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowArrowFunctionSniff.php index 31520d076..37f3a787b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowArrowFunctionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowArrowFunctionSniff.php @@ -21,11 +21,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $arrowFunctionPointer - */ - public function process(File $phpcsFile, $arrowFunctionPointer): void + public function process(File $phpcsFile, int $arrowFunctionPointer): void { $phpcsFile->addError('Use of arrow function is disallowed.', $arrowFunctionPointer, self::CODE_DISALLOWED_ARROW_FUNCTION); } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowEmptyFunctionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowEmptyFunctionSniff.php index 4fb600c4c..9c36a1129 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowEmptyFunctionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowEmptyFunctionSniff.php @@ -29,11 +29,7 @@ public function register(): array return [T_FUNCTION]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $tokens = $phpcsFile->getTokens(); @@ -54,7 +50,7 @@ public function process(File $phpcsFile, $functionPointer): void $propertyPromotion = TokenHelper::findNext( $phpcsFile, - Tokens::$scopeModifiers, + Tokens::SCOPE_MODIFIERS, $tokens[$functionPointer]['parenthesis_opener'] + 1, $tokens[$functionPointer]['parenthesis_closer'], ); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowNamedArgumentsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowNamedArgumentsSniff.php index 4d9c4a531..f58c54721 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowNamedArgumentsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowNamedArgumentsSniff.php @@ -22,11 +22,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $argumentNamePointer - */ - public function process(File $phpcsFile, $argumentNamePointer): void + public function process(File $phpcsFile, int $argumentNamePointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInCallSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInCallSniff.php index eaf3e5f7d..b2bf6f855 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInCallSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInCallSniff.php @@ -11,9 +11,6 @@ use const T_COMMA; use const T_ISSET; use const T_OPEN_PARENTHESIS; -use const T_PARENT; -use const T_SELF; -use const T_STATIC; use const T_STRING; use const T_UNSET; use const T_VARIABLE; @@ -35,18 +32,14 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $parenthesisOpenerPointer - */ - public function process(File $phpcsFile, $parenthesisOpenerPointer): void + public function process(File $phpcsFile, int $parenthesisOpenerPointer): void { $tokens = $phpcsFile->getTokens(); $pointerBeforeParenthesisOpener = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisOpenerPointer - 1); if (!in_array( $tokens[$pointerBeforeParenthesisOpener]['code'], - [...TokenHelper::ONLY_NAME_TOKEN_CODES, T_STRING, T_VARIABLE, T_ISSET, T_UNSET, T_CLOSE_PARENTHESIS, T_SELF, T_STATIC, T_PARENT], + [...TokenHelper::NAME_TOKEN_CODES, T_STRING, T_VARIABLE, T_ISSET, T_UNSET, T_CLOSE_PARENTHESIS, ...TokenHelper::CLASS_KEYWORD_CODES], true, )) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniff.php index 8f7f06f42..a2dccf58d 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInClosureUseSniff.php @@ -28,11 +28,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $tokens = $phpcsFile->getTokens(); @@ -44,13 +40,13 @@ public function process(File $phpcsFile, $functionPointer): void return; } - $useParenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1); - $useParenthesisCloserPointer = $tokens[$useParenthesisOpenerPointer]['parenthesis_closer']; + $useParenthesisOpenerPointer = $tokens[$usePointer]['parenthesis_opener']; + $useParenthesisCloserPointer = $tokens[$usePointer]['parenthesis_closer']; $pointerBeforeUseParenthesisCloser = TokenHelper::findPreviousExcluding( $phpcsFile, T_WHITESPACE, - $tokens[$useParenthesisOpenerPointer]['parenthesis_closer'] - 1, + $tokens[$usePointer]['parenthesis_closer'] - 1, $useParenthesisOpenerPointer, ); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInDeclarationSniff.php index 615b6e9de..1c60fe4d8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/DisallowTrailingCommaInDeclarationSniff.php @@ -24,11 +24,7 @@ public function register(): array return TokenHelper::FUNCTION_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/FunctionLengthSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/FunctionLengthSniff.php index e74675333..d1c915007 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/FunctionLengthSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/FunctionLengthSniff.php @@ -31,11 +31,7 @@ public function register(): array return [T_FUNCTION]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $file, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $this->maxLinesLength = SniffSettingsHelper::normalizeInteger($this->maxLinesLength); @@ -45,7 +41,7 @@ public function process(File $file, $functionPointer): void ])); $flags = array_reduce($flags, static fn ($carry, $flag): int => $carry | $flag, 0); - $length = FunctionHelper::getFunctionLengthInLines($file, $functionPointer, $flags); + $length = FunctionHelper::getFunctionLengthInLines($phpcsFile, $functionPointer, $flags); if ($length <= $this->maxLinesLength) { return; @@ -57,7 +53,7 @@ public function process(File $file, $functionPointer): void $this->maxLinesLength, ); - $file->addError($errorMessage, $functionPointer, self::CODE_FUNCTION_LENGTH); + $phpcsFile->addError($errorMessage, $functionPointer, self::CODE_FUNCTION_LENGTH); } } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/NamedArgumentSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/NamedArgumentSpacingSniff.php index e72a2af2a..ad50bb79b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/NamedArgumentSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/NamedArgumentSpacingSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireArrowFunctionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireArrowFunctionSniff.php index 5fa4dc4a5..2af2cdb2b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireArrowFunctionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireArrowFunctionSniff.php @@ -10,7 +10,6 @@ use SlevomatCodingStandard\Helpers\TokenHelper; use function count; use const T_BITWISE_AND; -use const T_CLOSE_PARENTHESIS; use const T_CLOSURE; use const T_FN; use const T_RETURN; @@ -37,11 +36,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $closurePointer - */ - public function process(File $phpcsFile, $closurePointer): void + public function process(File $phpcsFile, int $closurePointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 70400); @@ -57,16 +52,13 @@ public function process(File $phpcsFile, $closurePointer): void } $usePointer = TokenHelper::findNextEffective($phpcsFile, $tokens[$closurePointer]['parenthesis_closer'] + 1); - if ($tokens[$usePointer]['code'] === T_USE) { - $useOpenParenthesisPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1); - if (TokenHelper::findNext( - $phpcsFile, - T_BITWISE_AND, - $useOpenParenthesisPointer + 1, - $tokens[$useOpenParenthesisPointer]['parenthesis_closer'], - ) !== null) { - return; - } + if ($tokens[$usePointer]['code'] === T_USE && TokenHelper::findNext( + $phpcsFile, + T_BITWISE_AND, + $tokens[$usePointer]['parenthesis_opener'] + 1, + $tokens[$usePointer]['parenthesis_closer'], + ) !== null) { + return; } if (!$this->allowNested) { @@ -102,11 +94,10 @@ public function process(File $phpcsFile, $closurePointer): void $nonWhitespacePointerAfterUseParenthesisCloser = null; if ($usePointer !== null) { - $useParenthesiCloserPointer = TokenHelper::findNext($phpcsFile, T_CLOSE_PARENTHESIS, $usePointer + 1); $nonWhitespacePointerAfterUseParenthesisCloser = TokenHelper::findNextExcluding( $phpcsFile, T_WHITESPACE, - $useParenthesiCloserPointer + 1, + $tokens[$usePointer]['parenthesis_closer'] + 1, ); } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php index c33c85fee..6b8804e10 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php @@ -2,15 +2,18 @@ namespace SlevomatCodingStandard\Sniffs\Functions; +use Exception; use PHP_CodeSniffer\Files\File; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\IndentationHelper; use SlevomatCodingStandard\Helpers\SniffSettingsHelper; use SlevomatCodingStandard\Helpers\TokenHelper; +use UnexpectedValueException; use function array_unique; use function count; use function in_array; use function ltrim; +use function preg_match; use function sprintf; use function strlen; use function trim; @@ -27,16 +30,31 @@ class RequireMultiLineCallSniff extends AbstractLineCall { public const CODE_REQUIRED_MULTI_LINE_CALL = 'RequiredMultiLineCall'; + private const DEFAULT_MIN_LINE_LENGTH = 121; - public int $minLineLength = 121; + public ?int $minLineLength = null; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stringPointer - */ - public function process(File $phpcsFile, $stringPointer): void + public ?int $minParametersCount = null; + + /** @var list */ + public array $excludedCallPatterns = []; + + /** @var list|null */ + public ?array $excludedCallNormalizedPatterns = null; + + public function process(File $phpcsFile, int $stringPointer): void { - $this->minLineLength = SniffSettingsHelper::normalizeInteger($this->minLineLength); + $this->minLineLength = SniffSettingsHelper::normalizeNullableInteger($this->minLineLength); + $this->minParametersCount = SniffSettingsHelper::normalizeNullableInteger($this->minParametersCount); + + if ($this->minLineLength !== null && $this->minParametersCount !== null) { + throw new UnexpectedValueException('Either minLineLength or minParametersCount can be set.'); + } + + // Backward compatibility if no configuration provided + if ($this->minLineLength === null && $this->minParametersCount === null) { + $this->minLineLength = self::DEFAULT_MIN_LINE_LENGTH; + } if (!$this->isCall($phpcsFile, $stringPointer)) { return; @@ -129,6 +147,13 @@ public function process(File $phpcsFile, $stringPointer): void $name = ltrim($tokens[$stringPointer]['content'], '\\'); + if ( + count($this->excludedCallPatterns) !== 0 + && $this->isCallNameInPatterns($name, $this->getExcludedCallNormalizedPatterns()) + ) { + return; + } + if (in_array($tokens[$previousPointer]['code'], [T_OBJECT_OPERATOR, T_DOUBLE_COLON], true)) { $error = sprintf('Call of method %s() should be split to more lines.', $name); } elseif ($tokens[$previousPointer]['code'] === T_NEW) { @@ -170,12 +195,7 @@ private function shouldBeSkipped(File $phpcsFile, int $stringPointer, int $paren $searchStartPointer = TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $stringPointer); while (true) { - $stringPointerBefore = TokenHelper::findNext( - $phpcsFile, - TokenHelper::ONLY_NAME_TOKEN_CODES, - $searchStartPointer, - $stringPointer, - ); + $stringPointerBefore = TokenHelper::findNext($phpcsFile, TokenHelper::NAME_TOKEN_CODES, $searchStartPointer, $stringPointer); if ($stringPointerBefore === null) { break; @@ -197,7 +217,7 @@ private function shouldBeSkipped(File $phpcsFile, int $stringPointer, int $paren while (true) { $stringPointerAfter = TokenHelper::findNext( $phpcsFile, - TokenHelper::ONLY_NAME_TOKEN_CODES, + TokenHelper::NAME_TOKEN_CODES, $searchStartPointer, $lastPointerOnLine + 1, ); @@ -237,7 +257,11 @@ private function shouldReportError( return true; } - if ($lineLength < $this->minLineLength) { + if ($this->minLineLength !== null && $lineLength < $this->minLineLength) { + return false; + } + + if ($this->minParametersCount !== null && $parametersCount < $this->minParametersCount) { return false; } @@ -248,4 +272,31 @@ private function shouldReportError( return strlen(trim($lineStart) . trim($lineEnd)) > $indentationLength; } + /** + * @param list $normalizedPatterns + */ + private function isCallNameInPatterns(string $callName, array $normalizedPatterns): bool + { + foreach ($normalizedPatterns as $pattern) { + if (!SniffSettingsHelper::isValidRegularExpression($pattern)) { + throw new Exception(sprintf('%s is not valid PCRE pattern.', $pattern)); + } + + if (preg_match($pattern, $callName) !== 0) { + return true; + } + } + + return false; + } + + /** + * @return list + */ + private function getExcludedCallNormalizedPatterns(): array + { + $this->excludedCallNormalizedPatterns ??= SniffSettingsHelper::normalizeArray($this->excludedCallPatterns); + return $this->excludedCallNormalizedPatterns; + } + } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireSingleLineCallSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireSingleLineCallSniff.php index 2c21ca9b3..e872de2b8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireSingleLineCallSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireSingleLineCallSniff.php @@ -36,11 +36,7 @@ class RequireSingleLineCallSniff extends AbstractLineCall public bool $ignoreWithComplexParameter = true; - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stringPointer - */ - public function process(File $phpcsFile, $stringPointer): void + public function process(File $phpcsFile, int $stringPointer): void { $this->maxLineLength = SniffSettingsHelper::normalizeInteger($this->maxLineLength); @@ -63,7 +59,7 @@ public function process(File $phpcsFile, $stringPointer): void if (TokenHelper::findNext( $phpcsFile, - array_merge(TokenHelper::INLINE_COMMENT_TOKEN_CODES, Tokens::$heredocTokens), + array_merge(TokenHelper::INLINE_COMMENT_TOKEN_CODES, Tokens::HEREDOC_TOKENS), $parenthesisOpenerPointer + 1, $parenthesisCloserPointer, ) !== null) { @@ -97,7 +93,7 @@ public function process(File $phpcsFile, $stringPointer): void while (true) { $innerStringPointer = TokenHelper::findNext( $phpcsFile, - TokenHelper::ONLY_NAME_TOKEN_CODES, + TokenHelper::NAME_TOKEN_CODES, $callSearchStartPointer, $parenthesisCloserPointer, ); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInCallSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInCallSniff.php index 9420a0ce1..31cc0bb4c 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInCallSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInCallSniff.php @@ -12,9 +12,6 @@ use const T_COMMA; use const T_ISSET; use const T_OPEN_PARENTHESIS; -use const T_PARENT; -use const T_SELF; -use const T_STATIC; use const T_STRING; use const T_UNSET; use const T_VARIABLE; @@ -36,11 +33,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $parenthesisOpenerPointer - */ - public function process(File $phpcsFile, $parenthesisOpenerPointer): void + public function process(File $phpcsFile, int $parenthesisOpenerPointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 70300); @@ -54,7 +47,7 @@ public function process(File $phpcsFile, $parenthesisOpenerPointer): void if (!in_array( $tokens[$pointerBeforeParenthesisOpener]['code'], - [...TokenHelper::ONLY_NAME_TOKEN_CODES, T_STRING, T_VARIABLE, T_ISSET, T_UNSET, T_CLOSE_PARENTHESIS, T_SELF, T_STATIC, T_PARENT], + [...TokenHelper::NAME_TOKEN_CODES, T_STRING, T_VARIABLE, T_ISSET, T_UNSET, T_CLOSE_PARENTHESIS, ...TokenHelper::CLASS_KEYWORD_CODES], true, )) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInClosureUseSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInClosureUseSniff.php index 5ac5eb57f..025b24eaa 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInClosureUseSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInClosureUseSniff.php @@ -27,11 +27,7 @@ public function register(): array return [T_CLOSURE]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); @@ -49,8 +45,8 @@ public function process(File $phpcsFile, $functionPointer): void return; } - $useParenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1); - $useParenthesisCloserPointer = $tokens[$useParenthesisOpenerPointer]['parenthesis_closer']; + $useParenthesisOpenerPointer = $tokens[$usePointer]['parenthesis_opener']; + $useParenthesisCloserPointer = $tokens[$usePointer]['parenthesis_closer']; if ($tokens[$useParenthesisOpenerPointer]['line'] === $tokens[$useParenthesisCloserPointer]['line']) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInDeclarationSniff.php index ce1a47fe7..2dbaac92b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireTrailingCommaInDeclarationSniff.php @@ -24,11 +24,7 @@ public function register(): array return TokenHelper::FUNCTION_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StaticClosureSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StaticClosureSniff.php index 35ffd7e11..6d886c973 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StaticClosureSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StaticClosureSniff.php @@ -32,11 +32,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $closurePointer - */ - public function process(File $phpcsFile, $closurePointer): void + public function process(File $phpcsFile, int $closurePointer): void { $tokens = $phpcsFile->getTokens(); @@ -63,7 +59,7 @@ public function process(File $phpcsFile, $closurePointer): void T_VARIABLE, '$this', $closureScopeOpenerPointer + 1, - $closureScopeCloserPointer, + $closureScopeCloserPointer + 1, ); if ($thisPointer !== null) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StrictCallSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StrictCallSniff.php index 6e4aaceb3..95e9f3913 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StrictCallSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/StrictCallSniff.php @@ -37,14 +37,10 @@ class StrictCallSniff implements Sniff */ public function register(): array { - return TokenHelper::ONLY_NAME_TOKEN_CODES; + return TokenHelper::NAME_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stringPointer - */ - public function process(File $phpcsFile, $stringPointer): void + public function process(File $phpcsFile, int $stringPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedInheritedVariablePassedToClosureSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedInheritedVariablePassedToClosureSniff.php index a6f76c0f9..02640fdb1 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedInheritedVariablePassedToClosureSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedInheritedVariablePassedToClosureSniff.php @@ -7,6 +7,7 @@ use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\TokenHelper; use SlevomatCodingStandard\Helpers\VariableHelper; +use function array_key_exists; use function in_array; use function sprintf; use const T_BITWISE_AND; @@ -32,31 +33,20 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $usePointer - */ - public function process(File $phpcsFile, $usePointer): void + public function process(File $phpcsFile, int $usePointer): void { $tokens = $phpcsFile->getTokens(); - /** @var int $parenthesisOpenerPointer */ - $parenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1); - if ($tokens[$parenthesisOpenerPointer]['code'] !== T_OPEN_PARENTHESIS) { + if (!array_key_exists('parenthesis_opener', $tokens[$usePointer])) { return; } /** @var int $closurePointer */ $closurePointer = TokenHelper::findPrevious($phpcsFile, T_CLOSURE, $usePointer - 1); - $currentPointer = $parenthesisOpenerPointer + 1; + $currentPointer = $tokens[$usePointer]['parenthesis_opener'] + 1; do { - $variablePointer = TokenHelper::findNext( - $phpcsFile, - T_VARIABLE, - $currentPointer, - $tokens[$parenthesisOpenerPointer]['parenthesis_closer'], - ); + $variablePointer = TokenHelper::findNext($phpcsFile, T_VARIABLE, $currentPointer, $tokens[$usePointer]['parenthesis_closer']); if ($variablePointer === null) { break; } @@ -64,8 +54,8 @@ public function process(File $phpcsFile, $usePointer): void $this->checkVariableUsage( $phpcsFile, $usePointer, - $parenthesisOpenerPointer, - $tokens[$parenthesisOpenerPointer]['parenthesis_closer'], + $tokens[$usePointer]['parenthesis_opener'], + $tokens[$usePointer]['parenthesis_closer'], $variablePointer, $closurePointer, ); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedParameterSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedParameterSniff.php index c0a9e3e16..90a0c1c3a 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedParameterSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UnusedParameterSniff.php @@ -38,11 +38,7 @@ public function register(): array return TokenHelper::FUNCTION_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { if (FunctionHelper::isAbstract($phpcsFile, $functionPointer)) { return; @@ -67,12 +63,12 @@ public function process(File $phpcsFile, $functionPointer): void $previousPointer = TokenHelper::findPrevious( $phpcsFile, - array_merge([T_COMMA], Tokens::$scopeModifiers), + array_merge([T_COMMA], Tokens::SCOPE_MODIFIERS), $parameterPointer - 1, $tokens[$functionPointer]['parenthesis_opener'], ); - if ($previousPointer !== null && in_array($tokens[$previousPointer]['code'], Tokens::$scopeModifiers, true)) { + if ($previousPointer !== null && in_array($tokens[$previousPointer]['code'], Tokens::SCOPE_MODIFIERS, true)) { $currentPointer = $parameterPointer + 1; continue; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UselessParameterDefaultValueSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UselessParameterDefaultValueSniff.php index e747c53ad..255d2144b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UselessParameterDefaultValueSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/UselessParameterDefaultValueSniff.php @@ -25,11 +25,7 @@ public function register(): array return TokenHelper::FUNCTION_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $parameters = $phpcsFile->getMethodParameters($functionPointer); $parametersCount = count($parameters); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AbstractFullyQualifiedGlobalReference.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AbstractFullyQualifiedGlobalReference.php index 7f9d26631..1ddffd14e 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AbstractFullyQualifiedGlobalReference.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AbstractFullyQualifiedGlobalReference.php @@ -56,11 +56,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AlphabeticallySortedUsesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AlphabeticallySortedUsesSniff.php index 13466cb3d..d3301f9c0 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AlphabeticallySortedUsesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/AlphabeticallySortedUsesSniff.php @@ -14,16 +14,11 @@ use SlevomatCodingStandard\Helpers\UseStatementHelper; use function array_key_exists; use function array_map; -use function count; use function end; -use function explode; use function implode; use function in_array; -use function min; use function reset; use function sprintf; -use function strcasecmp; -use function strcmp; use function uasort; use const T_COMMA; use const T_OPEN_TAG; @@ -49,11 +44,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; @@ -134,7 +125,7 @@ private function fixAlphabeticalOrder(File $phpcsFile, array $useStatements): vo foreach ($useStatements as $useStatement) { $pointerBeforeUseStatement = TokenHelper::findPreviousNonWhitespace($phpcsFile, $useStatement->getPointer() - 1); - if (!in_array($tokens[$pointerBeforeUseStatement]['code'], Tokens::$commentTokens, true)) { + if (!in_array($tokens[$pointerBeforeUseStatement]['code'], Tokens::COMMENT_TOKENS, true)) { continue; } @@ -209,29 +200,7 @@ private function compareUseStatements(UseStatement $a, UseStatement $b): int return $order[$a->getType()] <=> $order[$b->getType()]; } - $aNameParts = explode(NamespaceHelper::NAMESPACE_SEPARATOR, $a->getFullyQualifiedTypeName()); - $bNameParts = explode(NamespaceHelper::NAMESPACE_SEPARATOR, $b->getFullyQualifiedTypeName()); - - $minPartsCount = min(count($aNameParts), count($bNameParts)); - for ($i = 0; $i < $minPartsCount; $i++) { - $comparison = $this->compare($aNameParts[$i], $bNameParts[$i]); - if ($comparison === 0) { - continue; - } - - return $comparison; - } - - return count($aNameParts) <=> count($bNameParts); - } - - private function compare(string $a, string $b): int - { - if ($this->caseSensitive) { - return strcmp($a, $b); - } - - return strcasecmp($a, $b); + return NamespaceHelper::compareStatements($a->getFullyQualifiedTypeName(), $b->getFullyQualifiedTypeName(), $this->caseSensitive); } } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/DisallowGroupUseSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/DisallowGroupUseSniff.php index a2a7e1e87..aa6b44560 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/DisallowGroupUseSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/DisallowGroupUseSniff.php @@ -21,11 +21,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $usePointer - */ - public function process(File $phpcsFile, $usePointer): void + public function process(File $phpcsFile, int $usePointer): void { $phpcsFile->addError( 'Group use declaration is disallowed, use single use for every import.', diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedClassNameInAnnotationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedClassNameInAnnotationSniff.php index d120815c9..8565d88f2 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedClassNameInAnnotationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedClassNameInAnnotationSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer); $this->ignoredAnnotationNames = SniffSettingsHelper::normalizeArray($this->ignoredAnnotationNames); @@ -52,6 +48,10 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void $annotationName = $annotation->getName(); + if (in_array($annotationName, $this->ignoredAnnotationNames, true)) { + continue; + } + foreach ($identifierTypeNodes as $typeHintNode) { $typeHint = $typeHintNode->name; @@ -65,10 +65,6 @@ public function process(File $phpcsFile, $docCommentOpenPointer): void continue; } - if (in_array($annotationName, $this->ignoredAnnotationNames, true)) { - continue; - } - $fullyQualifiedTypeHint = TypeHintHelper::getFullyQualifiedTypeHint($phpcsFile, $docCommentOpenPointer, $typeHint); if ($fullyQualifiedTypeHint === $typeHint) { continue; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedExceptionsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedExceptionsSniff.php index b8d197a9e..a2e4a3a27 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedExceptionsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/FullyQualifiedExceptionsSniff.php @@ -45,11 +45,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/MultipleUsesPerLineSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/MultipleUsesPerLineSniff.php index 38ed1031d..7ba5e2524 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/MultipleUsesPerLineSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/MultipleUsesPerLineSniff.php @@ -25,11 +25,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $usePointer - */ - public function process(File $phpcsFile, $usePointer): void + public function process(File $phpcsFile, int $usePointer): void { if (!UseStatementHelper::isImportUse($phpcsFile, $usePointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceDeclarationSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceDeclarationSniff.php index b94286198..8e20aa705 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceDeclarationSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceDeclarationSniff.php @@ -10,7 +10,6 @@ use function sprintf; use function strlen; use const T_NAMESPACE; -use const T_NS_SEPARATOR; use const T_SEMICOLON; use const T_WHITESPACE; @@ -31,19 +30,8 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $namespacePointer - */ - public function process(File $phpcsFile, $namespacePointer): void + public function process(File $phpcsFile, int $namespacePointer): void { - $tokens = $phpcsFile->getTokens(); - - $pointerAfterNamespace = TokenHelper::findNextEffective($phpcsFile, $namespacePointer + 1); - if ($tokens[$pointerAfterNamespace]['code'] === T_NS_SEPARATOR) { - return; - } - $this->checkWhitespaceAfterNamespace($phpcsFile, $namespacePointer); $this->checkDisallowedContentBetweenNamespaceNameAndSemicolon($phpcsFile, $namespacePointer); $this->checkDisallowedBracketedSyntax($phpcsFile, $namespacePointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceSpacingSniff.php index e43a8e59c..2fcb9acfa 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/NamespaceSpacingSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $namespacePointer - */ - public function process(File $phpcsFile, $namespacePointer): void + public function process(File $phpcsFile, int $namespacePointer): void { $this->linesCountBeforeNamespace = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeNamespace); $this->linesCountAfterNamespace = SniffSettingsHelper::normalizeInteger($this->linesCountAfterNamespace); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/ReferenceUsedNamesOnlySniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/ReferenceUsedNamesOnlySniff.php index 7467fd8fc..a7a0f6ee6 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/ReferenceUsedNamesOnlySniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/ReferenceUsedNamesOnlySniff.php @@ -121,11 +121,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; @@ -218,58 +214,71 @@ public function process(File $phpcsFile, $openTagPointer): void } if ($isFullyQualified) { - if ($reference->isClass && $this->allowFullyQualifiedNameForCollidingClasses) { - $lowerCasedUnqualifiedClassName = strtolower($unqualifiedName); + $hasExistingUseForCanonicalName = false; + foreach ($useStatements as $useStatement) { if ( - array_key_exists($lowerCasedUnqualifiedClassName, $definedClassesIndex) - && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( - $definedClassesIndex[$lowerCasedUnqualifiedClassName], - ) + $useStatement->getType() === $reference->type + && $useStatement->getFullyQualifiedTypeName() === $canonicalName ) { - continue; + $hasExistingUseForCanonicalName = true; + break; } + } - if ( - array_key_exists($lowerCasedUnqualifiedClassName, $classReferencesIndex) - && $name !== $classReferencesIndex[$lowerCasedUnqualifiedClassName] - ) { - continue; - } + if (!$hasExistingUseForCanonicalName) { + if ($reference->isClass && $this->allowFullyQualifiedNameForCollidingClasses) { + $lowerCasedUnqualifiedClassName = strtolower($unqualifiedName); + if ( + array_key_exists($lowerCasedUnqualifiedClassName, $definedClassesIndex) + && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( + $definedClassesIndex[$lowerCasedUnqualifiedClassName], + ) + ) { + continue; + } - if ( - array_key_exists($collidingUseStatementUniqueId, $useStatements) - && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( - $useStatements[$collidingUseStatementUniqueId]->getFullyQualifiedTypeName(), - ) - ) { - continue; - } - } elseif ($reference->isFunction && $this->allowFullyQualifiedNameForCollidingFunctions) { - $lowerCasedUnqualifiedFunctionName = strtolower($unqualifiedName); - if (array_key_exists($lowerCasedUnqualifiedFunctionName, $definedFunctionsIndex)) { - continue; - } + if ( + array_key_exists($lowerCasedUnqualifiedClassName, $classReferencesIndex) + && $name !== $classReferencesIndex[$lowerCasedUnqualifiedClassName] + ) { + continue; + } - if ( - array_key_exists($collidingUseStatementUniqueId, $useStatements) - && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( - $useStatements[$collidingUseStatementUniqueId]->getFullyQualifiedTypeName(), - ) - ) { - continue; - } - } elseif ($reference->isConstant && $this->allowFullyQualifiedNameForCollidingConstants) { - if (array_key_exists($unqualifiedName, $definedConstantsIndex)) { - continue; - } + if ( + array_key_exists($collidingUseStatementUniqueId, $useStatements) + && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( + $useStatements[$collidingUseStatementUniqueId]->getFullyQualifiedTypeName(), + ) + ) { + continue; + } + } elseif ($reference->isFunction && $this->allowFullyQualifiedNameForCollidingFunctions) { + $lowerCasedUnqualifiedFunctionName = strtolower($unqualifiedName); + if (array_key_exists($lowerCasedUnqualifiedFunctionName, $definedFunctionsIndex)) { + continue; + } - if ( - array_key_exists($collidingUseStatementUniqueId, $useStatements) - && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( - $useStatements[$collidingUseStatementUniqueId]->getFullyQualifiedTypeName(), - ) - ) { - continue; + if ( + array_key_exists($collidingUseStatementUniqueId, $useStatements) + && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( + $useStatements[$collidingUseStatementUniqueId]->getFullyQualifiedTypeName(), + ) + ) { + continue; + } + } elseif ($reference->isConstant && $this->allowFullyQualifiedNameForCollidingConstants) { + if (array_key_exists($unqualifiedName, $definedConstantsIndex)) { + continue; + } + + if ( + array_key_exists($collidingUseStatementUniqueId, $useStatements) + && $canonicalName !== NamespaceHelper::normalizeToCanonicalName( + $useStatements[$collidingUseStatementUniqueId]->getFullyQualifiedTypeName(), + ) + ) { + continue; + } } } } @@ -416,38 +425,44 @@ static function (bool $carry, string $use) use ($canonicalName): bool { true, ); - if ( - ( - $reference->isClass - && array_key_exists($canonicalNameToReference, $definedClassesIndex) - && $canonicalName !== NamespaceHelper::normalizeToCanonicalName($definedClassesIndex[$canonicalNameToReference]) - ) - || ( - $reference->isClass - && array_key_exists($canonicalNameToReference, $classReferencesIndex) - && $canonicalName !== NamespaceHelper::normalizeToCanonicalName($classReferencesIndex[$canonicalNameToReference]) - ) - || ($reference->isFunction && array_key_exists($canonicalNameToReference, $definedFunctionsIndex)) - || ($reference->isConstant && array_key_exists($canonicalNameToReference, $definedConstantsIndex)) - ) { - $canBeFixed = false; - } - + $hasExistingUseForCanonicalName = false; + $hasCollision = false; foreach ($useStatements as $useStatement) { if ($useStatement->getType() !== $reference->type) { continue; } if ($useStatement->getFullyQualifiedTypeName() === $canonicalName) { - continue; + $hasExistingUseForCanonicalName = true; + break; } - if ($useStatement->getCanonicalNameAsReferencedInFile() !== $canonicalNameToReference) { - continue; + if ($useStatement->getCanonicalNameAsReferencedInFile() === $canonicalNameToReference) { + $hasCollision = true; } + } - $canBeFixed = false; - break; + if (!$hasExistingUseForCanonicalName) { + if ( + ( + $reference->isClass + && array_key_exists($canonicalNameToReference, $definedClassesIndex) + && $canonicalName !== NamespaceHelper::normalizeToCanonicalName($definedClassesIndex[$canonicalNameToReference]) + ) + || ( + $reference->isClass + && array_key_exists($canonicalNameToReference, $classReferencesIndex) + && $canonicalName !== NamespaceHelper::normalizeToCanonicalName($classReferencesIndex[$canonicalNameToReference]) + ) + || ($reference->isFunction && array_key_exists($canonicalNameToReference, $definedFunctionsIndex)) + || ($reference->isConstant && array_key_exists($canonicalNameToReference, $definedConstantsIndex)) + ) { + $canBeFixed = false; + } + + if ($hasCollision) { + $canBeFixed = false; + } } $label = sprintf( @@ -625,7 +640,7 @@ private function getUseStatementPlacePointer(File $phpcsFile, int $openTagPointe } $nonWhitespacePointerAfterOpenTag = TokenHelper::findNextNonWhitespace($phpcsFile, $openTagPointer + 1); - if (in_array($tokens[$nonWhitespacePointerAfterOpenTag]['code'], Tokens::$commentTokens, true)) { + if (in_array($tokens[$nonWhitespacePointerAfterOpenTag]['code'], Tokens::COMMENT_TOKENS, true)) { $commentEndPointer = CommentHelper::getCommentEndPointer($phpcsFile, $nonWhitespacePointerAfterOpenTag); if (StringHelper::endsWith($tokens[$commentEndPointer]['content'], $phpcsFile->eolChar)) { diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/RequireOneNamespaceInFileSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/RequireOneNamespaceInFileSniff.php index 8b9730242..8188b8737 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/RequireOneNamespaceInFileSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/RequireOneNamespaceInFileSniff.php @@ -6,7 +6,6 @@ use PHP_CodeSniffer\Sniffs\Sniff; use SlevomatCodingStandard\Helpers\TokenHelper; use const T_NAMESPACE; -use const T_NS_SEPARATOR; class RequireOneNamespaceInFileSniff implements Sniff { @@ -23,35 +22,13 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $namespacePointer - */ - public function process(File $phpcsFile, $namespacePointer): void + public function process(File $phpcsFile, int $namespacePointer): void { - $tokens = $phpcsFile->getTokens(); - - $pointerAfterNamespace = TokenHelper::findNextEffective($phpcsFile, $namespacePointer + 1); - if ($tokens[$pointerAfterNamespace]['code'] === T_NS_SEPARATOR) { + $previousNamespacePointer = TokenHelper::findPrevious($phpcsFile, T_NAMESPACE, $namespacePointer - 1); + if ($previousNamespacePointer === null) { return; } - $previousNamespacePointer = $namespacePointer; - do { - $previousNamespacePointer = TokenHelper::findPrevious($phpcsFile, T_NAMESPACE, $previousNamespacePointer - 1); - if ($previousNamespacePointer === null) { - return; - } - - $pointerAfterPreviousNamespace = TokenHelper::findNextEffective($phpcsFile, $previousNamespacePointer + 1); - if ($tokens[$pointerAfterPreviousNamespace]['code'] === T_NS_SEPARATOR) { - continue; - } - - break; - - } while (true); - $phpcsFile->addError('Only one namespace in a file is allowed.', $namespacePointer, self::CODE_MORE_NAMESPACES_IN_FILE); } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UnusedUsesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UnusedUsesSniff.php index 5671ccdf5..079bfa470 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UnusedUsesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UnusedUsesSniff.php @@ -64,11 +64,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseDoesNotStartWithBackslashSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseDoesNotStartWithBackslashSniff.php index 2022ec446..7570fa00e 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseDoesNotStartWithBackslashSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseDoesNotStartWithBackslashSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $usePointer - */ - public function process(File $phpcsFile, $usePointer): void + public function process(File $phpcsFile, int $usePointer): void { if (!UseStatementHelper::isImportUse($phpcsFile, $usePointer)) { return; @@ -43,7 +39,7 @@ public function process(File $phpcsFile, $usePointer): void $nextTokenPointer = TokenHelper::findNextEffective($phpcsFile, $usePointer + 1); if ( - in_array($tokens[$nextTokenPointer]['code'], TokenHelper::ONLY_NAME_TOKEN_CODES, true) + in_array($tokens[$nextTokenPointer]['code'], TokenHelper::NAME_TOKEN_CODES, true) && ( $tokens[$nextTokenPointer]['content'] === 'function' || $tokens[$nextTokenPointer]['content'] === 'const' diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseFromSameNamespaceSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseFromSameNamespaceSniff.php index 461e9f346..4681a014d 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseFromSameNamespaceSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseFromSameNamespaceSniff.php @@ -31,11 +31,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $usePointer - */ - public function process(File $phpcsFile, $usePointer): void + public function process(File $phpcsFile, int $usePointer): void { if (!UseStatementHelper::isImportUse($phpcsFile, $usePointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseOnlyWhitelistedNamespacesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseOnlyWhitelistedNamespacesSniff.php index 25423fb85..6396c80f8 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseOnlyWhitelistedNamespacesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseOnlyWhitelistedNamespacesSniff.php @@ -33,11 +33,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $usePointer - */ - public function process(File $phpcsFile, $usePointer): void + public function process(File $phpcsFile, int $usePointer): void { if (!UseStatementHelper::isImportUse($phpcsFile, $usePointer)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseSpacingSniff.php index 96069952e..3f7802428 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UseSpacingSniff.php @@ -44,11 +44,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { $this->linesCountBeforeFirstUse = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeFirstUse); $this->linesCountBetweenUseTypes = SniffSettingsHelper::normalizeInteger($this->linesCountBetweenUseTypes); @@ -83,7 +79,7 @@ private function checkLinesBeforeFirstUse(File $phpcsFile, UseStatement $firstUs $useStartPointer = $firstUse->getPointer(); if ( - in_array($tokens[$pointerBeforeFirstUse]['code'], Tokens::$commentTokens, true) + in_array($tokens[$pointerBeforeFirstUse]['code'], Tokens::COMMENT_TOKENS, true) && $tokens[$pointerBeforeFirstUse]['line'] + 1 === $tokens[$useStartPointer]['line'] ) { $useStartPointer = array_key_exists('comment_opener', $tokens[$pointerBeforeFirstUse]) @@ -141,7 +137,7 @@ private function checkLinesAfterLastUse(File $phpcsFile, UseStatement $lastUse): } if ( - in_array($tokens[$pointerAfterWhitespaceEnd]['code'], Tokens::$commentTokens, true) + in_array($tokens[$pointerAfterWhitespaceEnd]['code'], Tokens::COMMENT_TOKENS, true) && $tokens[$pointerAfterWhitespaceEnd]['code'] !== T_DOC_COMMENT_OPEN_TAG && ( $tokens[$useEndPointer]['line'] === $tokens[$pointerAfterWhitespaceEnd]['line'] @@ -219,7 +215,7 @@ private function checkLinesBetweenSameTypesOfUse(File $phpcsFile, array $useStat $useStartPointer = $use->getPointer(); if ( - in_array($tokens[$pointerBeforeUse]['code'], Tokens::$commentTokens, true) + in_array($tokens[$pointerBeforeUse]['code'], Tokens::COMMENT_TOKENS, true) && TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $pointerBeforeUse) === $pointerBeforeUse && $tokens[$pointerBeforeUse]['line'] + 1 === $tokens[$useStartPointer]['line'] ) { @@ -289,7 +285,7 @@ private function checkLinesBetweenDifferentTypesOfUse(File $phpcsFile, array $us $useStartPointer = $use->getPointer(); if ( - in_array($tokens[$pointerBeforeUse]['code'], Tokens::$commentTokens, true) + in_array($tokens[$pointerBeforeUse]['code'], Tokens::COMMENT_TOKENS, true) && TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $pointerBeforeUse) === $pointerBeforeUse && $tokens[$pointerBeforeUse]['line'] + 1 === $tokens[$useStartPointer]['line'] ) { diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UselessAliasSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UselessAliasSniff.php index b6866bd0e..5972bc81b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UselessAliasSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Namespaces/UselessAliasSniff.php @@ -29,11 +29,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { if (TokenHelper::findPrevious($phpcsFile, T_OPEN_TAG, $openTagPointer - 1) !== null) { return; @@ -67,7 +63,7 @@ public function process(File $phpcsFile, $openTagPointer): void } $asPointer = TokenHelper::findNext($phpcsFile, T_AS, $useStatement->getPointer() + 1); - $nameEndPointer = TokenHelper::findPrevious($phpcsFile, TokenHelper::ONLY_NAME_TOKEN_CODES, $asPointer - 1); + $nameEndPointer = TokenHelper::findPrevious($phpcsFile, TokenHelper::NAME_TOKEN_CODES, $asPointer - 1); $useSemicolonPointer = TokenHelper::findNext($phpcsFile, T_SEMICOLON, $asPointer + 1); $phpcsFile->fixer->beginChangeset(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/DisallowNumericLiteralSeparatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/DisallowNumericLiteralSeparatorSniff.php index 385eca554..6f9d6c9fa 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/DisallowNumericLiteralSeparatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/DisallowNumericLiteralSeparatorSniff.php @@ -26,11 +26,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $numberPointer - */ - public function process(File $phpcsFile, $numberPointer): void + public function process(File $phpcsFile, int $numberPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/RequireNumericLiteralSeparatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/RequireNumericLiteralSeparatorSniff.php index 310908d96..1da206efc 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/RequireNumericLiteralSeparatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Numbers/RequireNumericLiteralSeparatorSniff.php @@ -34,11 +34,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $numberPointer - */ - public function process(File $phpcsFile, $numberPointer): void + public function process(File $phpcsFile, int $numberPointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 70400); $this->minDigitsBeforeDecimalPoint = SniffSettingsHelper::normalizeInteger($this->minDigitsBeforeDecimalPoint); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowEqualOperatorsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowEqualOperatorsSniff.php index 4604c3b0a..e2305de58 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowEqualOperatorsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowEqualOperatorsSniff.php @@ -26,11 +26,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $operatorPointer - */ - public function process(File $phpcsFile, $operatorPointer): void + public function process(File $phpcsFile, int $operatorPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowIncrementAndDecrementOperatorsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowIncrementAndDecrementOperatorsSniff.php index 3d9d53966..ea2bf7ec1 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowIncrementAndDecrementOperatorsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/DisallowIncrementAndDecrementOperatorsSniff.php @@ -28,11 +28,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $operatorPointer - */ - public function process(File $phpcsFile, $operatorPointer): void + public function process(File $phpcsFile, int $operatorPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/NegationOperatorSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/NegationOperatorSpacingSniff.php index 00ca0e879..660540885 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/NegationOperatorSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/NegationOperatorSpacingSniff.php @@ -46,11 +46,7 @@ public function register(): array return [T_MINUS]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->spacesCount = SniffSettingsHelper::normalizeInteger($this->spacesCount); @@ -59,7 +55,7 @@ public function process(File $phpcsFile, $pointer): void $previousEffective = TokenHelper::findPreviousEffective($phpcsFile, $pointer - 1); $possibleOperandTypes = [ - ...TokenHelper::ONLY_NAME_TOKEN_CODES, + ...TokenHelper::NAME_TOKEN_CODES, T_CONSTANT_ENCAPSED_STRING, T_CLASS_C, T_CLOSE_PARENTHESIS, diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireCombinedAssignmentOperatorSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireCombinedAssignmentOperatorSniff.php index 475864dbf..10af77974 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireCombinedAssignmentOperatorSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireCombinedAssignmentOperatorSniff.php @@ -48,11 +48,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $equalPointer - */ - public function process(File $phpcsFile, $equalPointer): void + public function process(File $phpcsFile, int $equalPointer): void { $tokens = $phpcsFile->getTokens(); @@ -117,7 +113,7 @@ public function process(File $phpcsFile, $equalPointer): void } $semicolonPointer = TokenHelper::findNext($phpcsFile, T_SEMICOLON, $equalPointer + 1); - if (TokenHelper::findNext($phpcsFile, Tokens::$operators, $operatorPointer + 1, $semicolonPointer) !== null) { + if (TokenHelper::findNext($phpcsFile, Tokens::OPERATORS, $operatorPointer + 1, $semicolonPointer) !== null) { return; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireOnlyStandaloneIncrementAndDecrementOperatorsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireOnlyStandaloneIncrementAndDecrementOperatorsSniff.php index fb3958c34..f18ac2342 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireOnlyStandaloneIncrementAndDecrementOperatorsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/RequireOnlyStandaloneIncrementAndDecrementOperatorsSniff.php @@ -38,11 +38,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $operatorPointer - */ - public function process(File $phpcsFile, $operatorPointer): void + public function process(File $phpcsFile, int $operatorPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/SpreadOperatorSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/SpreadOperatorSpacingSniff.php index e149e4232..fdae14aa5 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/SpreadOperatorSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Operators/SpreadOperatorSpacingSniff.php @@ -29,11 +29,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $spreadOperatorPointer - */ - public function process(File $phpcsFile, $spreadOperatorPointer): void + public function process(File $phpcsFile, int $spreadOperatorPointer): void { $this->spacesCountAfterOperator = SniffSettingsHelper::normalizeInteger($this->spacesCountAfterOperator); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowDirectMagicInvokeCallSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowDirectMagicInvokeCallSniff.php index 28100a5b0..a973c8a86 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowDirectMagicInvokeCallSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowDirectMagicInvokeCallSniff.php @@ -26,11 +26,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stringPointer - */ - public function process(File $phpcsFile, $stringPointer): void + public function process(File $phpcsFile, int $stringPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowReferenceSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowReferenceSniff.php index 2f4eaef95..e05e58bbe 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowReferenceSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/DisallowReferenceSniff.php @@ -35,11 +35,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $referencePointer - */ - public function process(File $phpcsFile, $referencePointer): void + public function process(File $phpcsFile, int $referencePointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ForbiddenClassesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ForbiddenClassesSniff.php index 50f345d03..0ff9756cf 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ForbiddenClassesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ForbiddenClassesSniff.php @@ -6,7 +6,6 @@ use PHP_CodeSniffer\Sniffs\Sniff; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\NamespaceHelper; -use SlevomatCodingStandard\Helpers\ReferencedNameHelper; use SlevomatCodingStandard\Helpers\TokenHelper; use SlevomatCodingStandard\Helpers\UseStatementHelper; use function array_key_exists; @@ -14,12 +13,9 @@ use function count; use function in_array; use function is_array; -use function min; use function sprintf; use function strlen; use function strtolower; -use const PHP_INT_MAX; -use const T_COMMA; use const T_DOUBLE_COLON; use const T_EXTENDS; use const T_IMPLEMENTS; @@ -82,11 +78,7 @@ public function register(): array return $searchTokens; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $tokenPointer - */ - public function process(File $phpcsFile, $tokenPointer): void + public function process(File $phpcsFile, int $tokenPointer): void { $tokens = $phpcsFile->getTokens(); $token = $tokens[$tokenPointer]; @@ -137,7 +129,7 @@ public function process(File $phpcsFile, $tokenPointer): void } /** - * @param list $references + * @param list $references * @param array $forbiddenNames */ private function checkReferences( @@ -168,7 +160,7 @@ private function checkReferences( if ($alternative === null) { $phpcsFile->addError( sprintf('Usage of %s %s is forbidden.', $reference['fullyQualifiedName'], $nameType), - $reference['startPointer'], + $reference['pointer'], $code, ); } elseif (!$isFixable) { @@ -179,7 +171,7 @@ private function checkReferences( $nameType, $alternative, ), - $reference['startPointer'], + $reference['pointer'], $code, ); } else { @@ -190,7 +182,7 @@ private function checkReferences( $nameType, $alternative, ), - $reference['startPointer'], + $reference['pointer'], $code, ); if (!$fix) { @@ -199,7 +191,7 @@ private function checkReferences( $phpcsFile->fixer->beginChangeset(); - FixerHelper::change($phpcsFile, $reference['startPointer'], $reference['endPointer'], $alternative); + FixerHelper::change($phpcsFile, $reference['pointer'], $reference['pointer'], $alternative); $phpcsFile->fixer->endChangeset(); } @@ -215,18 +207,33 @@ private function isTraitsConflictResolutionToken(array $token): bool } /** - * @return list + * @return list */ private function getAllReferences(File $phpcsFile, int $startPointer, int $endPointer): array { + $tokens = $phpcsFile->getTokens(); + // Always ignore first token $startPointer++; $references = []; while ($startPointer < $endPointer) { - $nextComma = TokenHelper::findNext($phpcsFile, [T_COMMA], $startPointer + 1); - $nextSeparator = min($endPointer, $nextComma ?? PHP_INT_MAX); - $reference = ReferencedNameHelper::getReferenceName($phpcsFile, $startPointer, $nextSeparator - 1); + $referencePointer = TokenHelper::findNext( + $phpcsFile, + [...TokenHelper::CLASS_KEYWORD_CODES, ...TokenHelper::NAME_TOKEN_CODES], + $startPointer, + ); + + if ($referencePointer === null) { + break; + } + + if (in_array($tokens[$referencePointer]['code'], TokenHelper::CLASS_KEYWORD_CODES, true)) { + $startPointer = $referencePointer + 1; + continue; + } + + $reference = $tokens[$referencePointer]['content']; if ( strlen($reference) !== 0 @@ -234,12 +241,11 @@ private function getAllReferences(File $phpcsFile, int $startPointer, int $endPo ) { $references[] = [ 'fullyQualifiedName' => NamespaceHelper::resolveClassName($phpcsFile, $reference, $startPointer), - 'startPointer' => TokenHelper::findNextEffective($phpcsFile, $startPointer, $endPointer), - 'endPointer' => TokenHelper::findPreviousEffective($phpcsFile, $nextSeparator - 1, $startPointer), + 'pointer' => $referencePointer, ]; } - $startPointer = $nextSeparator + 1; + $startPointer = $referencePointer + 1; } return $references; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/OptimizedFunctionsWithoutUnpackingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/OptimizedFunctionsWithoutUnpackingSniff.php index 367b34912..1aaffec5b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/OptimizedFunctionsWithoutUnpackingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/OptimizedFunctionsWithoutUnpackingSniff.php @@ -29,14 +29,10 @@ class OptimizedFunctionsWithoutUnpackingSniff implements Sniff */ public function register(): array { - return TokenHelper::ONLY_NAME_TOKEN_CODES; + return TokenHelper::NAME_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $previousTokenPointer = TokenHelper::findPreviousEffective($phpcsFile, $pointer - 1); $openBracketPointer = TokenHelper::findNextEffective($phpcsFile, $pointer + 1); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ReferenceSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ReferenceSpacingSniff.php index 739bf38dc..5d88a4d83 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ReferenceSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ReferenceSpacingSniff.php @@ -39,11 +39,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $referencePointer - */ - public function process(File $phpcsFile, $referencePointer): void + public function process(File $phpcsFile, int $referencePointer): void { $this->spacesCountAfterReference = SniffSettingsHelper::normalizeInteger($this->spacesCountAfterReference); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireExplicitAssertionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireExplicitAssertionSniff.php index 847704a12..4cd606daa 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireExplicitAssertionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireExplicitAssertionSniff.php @@ -61,11 +61,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireNowdocSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireNowdocSniff.php index a4e82dea1..26563e585 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireNowdocSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/RequireNowdocSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $heredocStartPointer - */ - public function process(File $phpcsFile, $heredocStartPointer): void + public function process(File $phpcsFile, int $heredocStartPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ShortListSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ShortListSniff.php index 6a9362a32..b312ddf64 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ShortListSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/ShortListSniff.php @@ -22,11 +22,7 @@ public function register(): array return [T_LIST]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $fix = $phpcsFile->addFixableError('list(...) is forbidden, use [...] instead.', $pointer, self::CODE_LONG_LIST_USED); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/TypeCastSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/TypeCastSniff.php index cc39647c6..829a597c2 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/TypeCastSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/TypeCastSniff.php @@ -47,11 +47,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $tokens = $phpcsFile->getTokens(); $cast = $tokens[$pointer]['content']; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessParenthesesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessParenthesesSniff.php index 903c3bfb8..0e21a2f2e 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessParenthesesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessParenthesesSniff.php @@ -7,6 +7,7 @@ use PHP_CodeSniffer\Util\Tokens; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\IdentificatorHelper; +use SlevomatCodingStandard\Helpers\SniffSettingsHelper; use SlevomatCodingStandard\Helpers\TokenHelper; use function array_key_exists; use function array_map; @@ -54,7 +55,9 @@ use const T_MODULUS; use const T_MULTIPLY; use const T_NEW; +use const T_NULLSAFE_OBJECT_OPERATOR; use const T_OBJECT_CAST; +use const T_OBJECT_OPERATOR; use const T_OPEN_PARENTHESIS; use const T_PARENT; use const T_PLUS; @@ -103,6 +106,8 @@ class UselessParenthesesSniff implements Sniff public bool $ignoreComplexTernaryConditions = false; + public bool $enableCheckAroundNew = false; + /** * @return array */ @@ -113,12 +118,15 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $parenthesisOpenerPointer - */ - public function process(File $phpcsFile, $parenthesisOpenerPointer): void + public function process(File $phpcsFile, int $parenthesisOpenerPointer): void { + // @codeCoverageIgnoreStart + $phpVersion = SniffSettingsHelper::getPhpVersion(); + if ($phpVersion !== null && $phpVersion < 80400) { + $this->enableCheckAroundNew = false; + } + // @codeCoverageIgnoreEnd + $tokens = $phpcsFile->getTokens(); if (array_key_exists('parenthesis_owner', $tokens[$parenthesisOpenerPointer])) { @@ -233,18 +241,18 @@ private function checkParenthesesAroundConditionInTernaryOperator(File $phpcsFil return; } - if (in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::$comparisonTokens, true)) { + if (in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::COMPARISON_TOKENS, true)) { return; } - if (in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::$booleanOperators, true)) { + if (in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::BOOLEAN_OPERATORS, true)) { return; } if ($this->ignoreComplexTernaryConditions) { if (TokenHelper::findNext( $phpcsFile, - Tokens::$booleanOperators, + Tokens::BOOLEAN_OPERATORS, $parenthesisOpenerPointer + 1, $parenthesisCloserPointer, ) !== null) { @@ -349,7 +357,7 @@ private function checkParenthesesAroundVariableOrFunctionCall(File $phpcsFile, i } $pointerBeforeParenthesisOpener = TokenHelper::findPreviousEffective($phpcsFile, $parenthesisOpenerPointer - 1); - if (in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::$booleanOperators, true)) { + if (in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::BOOLEAN_OPERATORS, true)) { return; } @@ -483,8 +491,8 @@ private function checkParenthesesAroundOperators(File $phpcsFile, int $parenthes } if ( - in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::$booleanOperators, true) - || in_array($tokens[$pointerAfterParenthesisCloser]['code'], Tokens::$booleanOperators, true) + in_array($tokens[$pointerBeforeParenthesisOpener]['code'], Tokens::BOOLEAN_OPERATORS, true) + || in_array($tokens[$pointerAfterParenthesisCloser]['code'], Tokens::BOOLEAN_OPERATORS, true) || $tokens[$pointerBeforeParenthesisOpener]['code'] === T_BOOLEAN_NOT ) { return; @@ -503,7 +511,7 @@ private function checkParenthesesAroundOperators(File $phpcsFile, int $parenthes T_OPEN_PARENTHESIS, ...$complicatedOperators, ], - Tokens::$comparisonTokens, + Tokens::COMPARISON_TOKENS, ), $actualStartPointer, $tokens[$parenthesisOpenerPointer]['parenthesis_closer'], @@ -517,7 +525,7 @@ private function checkParenthesesAroundOperators(File $phpcsFile, int $parenthes return; } - if (in_array($tokens[$pointer]['code'], Tokens::$comparisonTokens, true)) { + if (in_array($tokens[$pointer]['code'], Tokens::COMPARISON_TOKENS, true)) { return; } @@ -615,7 +623,19 @@ private function checkParenthesesAroundNew(File $phpcsFile, int $parenthesisOpen $tokens[$parenthesisOpenerPointer]['parenthesis_closer'] + 1, ); if (!in_array($tokens[$pointerAfterParenthesisCloser]['code'], [T_COMMA, T_SEMICOLON, T_CLOSE_SHORT_ARRAY], true)) { - return; + if (!in_array($tokens[$pointerAfterParenthesisCloser]['code'], [T_OBJECT_OPERATOR, T_NULLSAFE_OBJECT_OPERATOR], true)) { + return; + } + if (!$this->enableCheckAroundNew) { + return; + } + $pointerBeforeParenthesisCloser = TokenHelper::findPreviousEffective( + $phpcsFile, + $tokens[$parenthesisOpenerPointer]['parenthesis_closer'] - 1, + ); + if ($tokens[$pointerBeforeParenthesisCloser]['type'] !== 'T_CLOSE_PARENTHESIS') { + return; + } } $fix = $phpcsFile->addFixableError('Useless parentheses.', $parenthesisOpenerPointer, self::CODE_USELESS_PARENTHESES); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessSemicolonSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessSemicolonSniff.php index 09bba5155..1504ed68e 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessSemicolonSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/PHP/UselessSemicolonSniff.php @@ -36,11 +36,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $semicolonPointer - */ - public function process(File $phpcsFile, $semicolonPointer): void + public function process(File $phpcsFile, int $semicolonPointer): void { $this->checkMultipleSemicolons($phpcsFile, $semicolonPointer); $this->checkSemicolonAtTheBeginningOfScope($phpcsFile, $semicolonPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Strings/DisallowVariableParsingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Strings/DisallowVariableParsingSniff.php index ad44796eb..f3363d257 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Strings/DisallowVariableParsingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Strings/DisallowVariableParsingSniff.php @@ -41,11 +41,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $stringPointer - */ - public function process(File $phpcsFile, $stringPointer): void + public function process(File $phpcsFile, int $stringPointer): void { if (!$this->disallowDollarCurlySyntax && !$this->disallowCurlyDollarSyntax && !$this->disallowSimpleSyntax) { throw new UnexpectedValueException('No option is set.'); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ClassConstantTypeHintSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ClassConstantTypeHintSniff.php index 3b78ab0fb..b791b7da9 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ClassConstantTypeHintSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ClassConstantTypeHintSniff.php @@ -4,12 +4,15 @@ use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Sniffs\Sniff; +use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode; +use SlevomatCodingStandard\Helpers\Annotation; use SlevomatCodingStandard\Helpers\AnnotationHelper; use SlevomatCodingStandard\Helpers\ClassHelper; use SlevomatCodingStandard\Helpers\DocCommentHelper; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\SniffSettingsHelper; use SlevomatCodingStandard\Helpers\TokenHelper; +use SlevomatCodingStandard\Helpers\TypeHint; use function array_key_exists; use function count; use function sprintf; @@ -69,11 +72,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $constantPointer - */ - public function process(File $phpcsFile, $constantPointer): void + public function process(File $phpcsFile, int $constantPointer): void { if (ClassHelper::getClassPointer($phpcsFile, $constantPointer) === null) { // Constant in namespace @@ -164,6 +163,25 @@ private function checkDocComment(File $phpcsFile, int $constantPointer): void $namePointer = $this->getConstantNamePointer($phpcsFile, $constantPointer); $constantName = $tokens[$namePointer]['content']; + $typeHintPointer = TokenHelper::findPreviousEffective($phpcsFile, $namePointer - 1); + $hasTypeHint = $typeHintPointer !== $constantPointer; + + /** @var Annotation $annotation */ + $annotation = $annotations[0]; + + if ( + $hasTypeHint + && !AnnotationHelper::isAnnotationUseless( + $phpcsFile, + $constantPointer, + new TypeHint($tokens[$typeHintPointer]['content'], false, $typeHintPointer, $typeHintPointer), + $annotation, + [], + ) + ) { + return; + } + $uselessDocComment = !DocCommentHelper::hasDocCommentDescription($phpcsFile, $constantPointer) && count($annotations) === 1; if ($uselessDocComment) { $fix = $phpcsFile->addFixableError( @@ -176,8 +194,6 @@ private function checkDocComment(File $phpcsFile, int $constantPointer): void $fixerStart = TokenHelper::findLastTokenOnPreviousLine($phpcsFile, $docCommentOpenPointer); $fixerEnd = $tokens[$docCommentOpenPointer]['comment_closer']; } else { - $annotation = $annotations[0]; - $fix = $phpcsFile->addFixableError( sprintf('Useless @var annotation for constant %s.', $constantName), $annotation->getStartPointer(), diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DNFTypeHintFormatSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DNFTypeHintFormatSniff.php index 78341ea0c..9939026cd 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DNFTypeHintFormatSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DNFTypeHintFormatSniff.php @@ -4,19 +4,42 @@ use PHP_CodeSniffer\Files\File; use PHP_CodeSniffer\Sniffs\Sniff; +use PHPStan\PhpDocParser\Ast\Attribute; +use PHPStan\PhpDocParser\Ast\PhpDoc\ParamTagValueNode; +use PHPStan\PhpDocParser\Ast\PhpDoc\PropertyTagValueNode; +use PHPStan\PhpDocParser\Ast\PhpDoc\ReturnTagValueNode; +use PHPStan\PhpDocParser\Ast\PhpDoc\VarTagValueNode; +use PHPStan\PhpDocParser\Ast\Type\IdentifierTypeNode; +use PHPStan\PhpDocParser\Ast\Type\IntersectionTypeNode; +use PHPStan\PhpDocParser\Ast\Type\NullableTypeNode; +use PHPStan\PhpDocParser\Ast\Type\TypeNode; +use PHPStan\PhpDocParser\Ast\Type\UnionTypeNode; +use SlevomatCodingStandard\Helpers\Annotation; +use SlevomatCodingStandard\Helpers\AnnotationHelper; +use SlevomatCodingStandard\Helpers\AnnotationTypeHelper; +use SlevomatCodingStandard\Helpers\DocCommentHelper; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\FunctionHelper; +use SlevomatCodingStandard\Helpers\ParsedDocComment; +use SlevomatCodingStandard\Helpers\PhpDocParserHelper; use SlevomatCodingStandard\Helpers\PropertyHelper; use SlevomatCodingStandard\Helpers\SniffSettingsHelper; use SlevomatCodingStandard\Helpers\TokenHelper; use SlevomatCodingStandard\Helpers\TypeHint; +use function array_unshift; +use function count; use function in_array; +use function preg_match; +use function preg_quote; use function preg_replace; use function sprintf; +use function str_replace; use function strpos; use function strtolower; use function substr; use function substr_count; +use function trim; +use const T_DOC_COMMENT_OPEN_TAG; use const T_TYPE_CLOSE_PARENTHESIS; use const T_TYPE_INTERSECTION; use const T_TYPE_OPEN_PARENTHESIS; @@ -44,6 +67,8 @@ class DNFTypeHintFormatSniff implements Sniff public ?bool $enable = null; + public bool $enableForDocComments = false; + public ?string $withSpacesAroundOperators = null; public ?string $withSpacesInsideParentheses = null; @@ -60,14 +85,11 @@ public function register(): array return [ T_VARIABLE, ...TokenHelper::FUNCTION_TOKEN_CODES, + T_DOC_COMMENT_OPEN_TAG, ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); @@ -77,6 +99,15 @@ public function process(File $phpcsFile, $pointer): void $tokens = $phpcsFile->getTokens(); + if ($tokens[$pointer]['code'] === T_DOC_COMMENT_OPEN_TAG) { + if (!$this->enableForDocComments) { + return; + } + + $this->processDocComment($phpcsFile, $pointer); + return; + } + if ($tokens[$pointer]['code'] === T_VARIABLE) { if (!PropertyHelper::isProperty($phpcsFile, $pointer)) { return; @@ -102,6 +133,363 @@ public function process(File $phpcsFile, $pointer): void } } + private function processDocComment(File $phpcsFile, int $docCommentOpenPointer): void + { + $parsedDocComment = DocCommentHelper::parseDocComment($phpcsFile, $docCommentOpenPointer); + if ($parsedDocComment === null) { + return; + } + + $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer); + + foreach ($annotations as $annotation) { + if ($annotation->isInvalid()) { + continue; + } + + if ($this->withSpacesAroundOperators !== null) { + foreach (AnnotationHelper::getAnnotationNodesByType($annotation->getNode(), UnionTypeNode::class) as $unionTypeNode) { + $this->checkDocCommentOperatorSpacing($phpcsFile, $annotation, $unionTypeNode, $parsedDocComment, '|'); + } + + foreach (AnnotationHelper::getAnnotationNodesByType( + $annotation->getNode(), + IntersectionTypeNode::class, + ) as $intersectionTypeNode) { + $this->checkDocCommentOperatorSpacing($phpcsFile, $annotation, $intersectionTypeNode, $parsedDocComment, '&'); + } + } + + if ($this->withSpacesInsideParentheses !== null) { + foreach (AnnotationHelper::getAnnotationNodesByType($annotation->getNode(), UnionTypeNode::class) as $unionTypeNode) { + foreach ($unionTypeNode->types as $typeNode) { + if (!$typeNode instanceof IntersectionTypeNode) { + continue; + } + + $this->checkDocCommentParenthesesSpacing($phpcsFile, $annotation, $typeNode, $parsedDocComment); + } + } + } + + if ($this->nullPosition !== null) { + foreach (AnnotationHelper::getAnnotationNodesByType($annotation->getNode(), UnionTypeNode::class) as $unionTypeNode) { + $this->checkDocCommentNullPosition($phpcsFile, $annotation, $unionTypeNode, $parsedDocComment); + } + } + + if ($this->shortNullable === null) { + continue; + } + + if ($this->shortNullable === self::NO) { + foreach (AnnotationHelper::getAnnotationNodesByType( + $annotation->getNode(), + NullableTypeNode::class, + ) as $nullableTypeNode) { + $this->checkDocCommentNullableExpansion($phpcsFile, $annotation, $nullableTypeNode, $parsedDocComment); + } + } elseif ($this->shortNullable === self::YES) { + $this->checkDocCommentNullableContraction($phpcsFile, $annotation, $parsedDocComment); + } + } + } + + /** + * @param UnionTypeNode|IntersectionTypeNode $typeNode + */ + private function checkDocCommentOperatorSpacing( + File $phpcsFile, + Annotation $annotation, + TypeNode $typeNode, + ParsedDocComment $parsedDocComment, + string $operator + ): void + { + $rawTypeText = trim($parsedDocComment->getTokens()->getContentBetween( + $typeNode->getAttribute(Attribute::START_INDEX), + $typeNode->getAttribute(Attribute::END_INDEX) + 1, + )); + + $escapedOperator = preg_quote($operator, '~'); + + if ($this->withSpacesAroundOperators === self::NO) { + if (preg_match('~\s' . $escapedOperator . '|' . $escapedOperator . '\s~', $rawTypeText) === 0) { + return; + } + + $fix = $phpcsFile->addFixableError( + sprintf('Spaces around "|" or "&" in type hint "%s" are disallowed.', $rawTypeText), + $annotation->getStartPointer(), + self::CODE_DISALLOWED_WHITESPACE_AROUND_OPERATOR, + ); + + if ($fix) { + $fixedTypeText = (string) preg_replace('~\s*' . $escapedOperator . '\s*~', $operator, $rawTypeText); + $this->fixDocCommentTypeText($phpcsFile, $parsedDocComment, $rawTypeText, $fixedTypeText); + } + } elseif ($this->withSpacesAroundOperators === self::YES) { + if (preg_match('~(?addFixableError( + sprintf('One space required around each "|" or "&" in type hint "%s".', $rawTypeText), + $annotation->getStartPointer(), + self::CODE_REQUIRED_WHITESPACE_AROUND_OPERATOR, + ); + + if ($fix) { + $fixedTypeText = (string) preg_replace('~\s*' . $escapedOperator . '\s*~', ' ' . $operator . ' ', $rawTypeText); + $this->fixDocCommentTypeText($phpcsFile, $parsedDocComment, $rawTypeText, $fixedTypeText); + } + } + } + + private function checkDocCommentParenthesesSpacing( + File $phpcsFile, + Annotation $annotation, + IntersectionTypeNode $intersectionTypeNode, + ParsedDocComment $parsedDocComment + ): void + { + $rawTypeText = trim($parsedDocComment->getTokens()->getContentBetween( + $intersectionTypeNode->getAttribute(Attribute::START_INDEX), + $intersectionTypeNode->getAttribute(Attribute::END_INDEX) + 1, + )); + + if ($this->withSpacesInsideParentheses === self::NO) { + if (preg_match('~^\(\s|\s\)$~', $rawTypeText) === 0) { + return; + } + + $fix = $phpcsFile->addFixableError( + sprintf('Spaces inside parentheses in type hint "%s" are disallowed.', $rawTypeText), + $annotation->getStartPointer(), + self::CODE_DISALLOWED_WHITESPACE_INSIDE_PARENTHESES, + ); + + if ($fix) { + $fixedTypeText = (string) preg_replace(['~\(\s+~', '~\s+\)~'], ['(', ')'], $rawTypeText); + $this->fixDocCommentTypeText($phpcsFile, $parsedDocComment, $rawTypeText, $fixedTypeText); + } + } elseif ($this->withSpacesInsideParentheses === self::YES) { + if (preg_match('~^\([^ ]|[^ ]\)$~', $rawTypeText) === 0) { + return; + } + + $fix = $phpcsFile->addFixableError( + sprintf('One space required around expression inside parentheses in type hint "%s".', $rawTypeText), + $annotation->getStartPointer(), + self::CODE_REQUIRED_WHITESPACE_INSIDE_PARENTHESES, + ); + + if ($fix) { + $fixedTypeText = (string) preg_replace(['~^\(\s*~', '~\s*\)$~'], ['( ', ' )'], $rawTypeText); + $this->fixDocCommentTypeText($phpcsFile, $parsedDocComment, $rawTypeText, $fixedTypeText); + } + } + } + + private function checkDocCommentNullPosition( + File $phpcsFile, + Annotation $annotation, + UnionTypeNode $unionTypeNode, + ParsedDocComment $parsedDocComment + ): void + { + $nullTypeNode = null; + $nullPosition = 0; + $position = 0; + + foreach ($unionTypeNode->types as $typeNode) { + if ($typeNode instanceof IdentifierTypeNode && strtolower($typeNode->name) === 'null') { + $nullTypeNode = $typeNode; + $nullPosition = $position; + break; + } + + $position++; + } + + if ($nullTypeNode === null) { + return; + } + + if ($this->nullPosition === self::LAST && $nullPosition === count($unionTypeNode->types) - 1) { + return; + } + + if ($this->nullPosition === self::FIRST && $nullPosition === 0) { + return; + } + + $errorCode = $this->nullPosition === self::LAST + ? self::CODE_NULL_TYPE_HINT_NOT_ON_LAST_POSITION + : self::CODE_NULL_TYPE_HINT_NOT_ON_FIRST_POSITION; + + $fix = $phpcsFile->addFixableError( + sprintf( + 'Null type hint should be on %s position in "%s".', + $this->nullPosition, + AnnotationTypeHelper::print($unionTypeNode), + ), + $annotation->getStartPointer(), + $errorCode, + ); + + if (!$fix) { + return; + } + + $fixedTypeNodes = []; + foreach ($unionTypeNode->types as $typeNode) { + if ($typeNode === $nullTypeNode) { + continue; + } + + $fixedTypeNodes[] = $typeNode; + } + + if ($this->nullPosition === self::FIRST) { + array_unshift($fixedTypeNodes, $nullTypeNode); + } else { + $fixedTypeNodes[] = $nullTypeNode; + } + + $fixedUnionTypeNode = PhpDocParserHelper::cloneNode($unionTypeNode); + $fixedUnionTypeNode->types = $fixedTypeNodes; + + $phpcsFile->fixer->beginChangeset(); + + $fixedDocComment = AnnotationHelper::fixAnnotation($parsedDocComment, $annotation, $unionTypeNode, $fixedUnionTypeNode); + + FixerHelper::change( + $phpcsFile, + $parsedDocComment->getOpenPointer(), + $parsedDocComment->getClosePointer(), + $fixedDocComment, + ); + + $phpcsFile->fixer->endChangeset(); + } + + private function checkDocCommentNullableExpansion( + File $phpcsFile, + Annotation $annotation, + NullableTypeNode $nullableTypeNode, + ParsedDocComment $parsedDocComment + ): void + { + $rawTypeText = trim($parsedDocComment->getTokens()->getContentBetween( + $nullableTypeNode->getAttribute(Attribute::START_INDEX), + $nullableTypeNode->getAttribute(Attribute::END_INDEX) + 1, + )); + + $fix = $phpcsFile->addFixableError( + sprintf('Usage of short nullable type hint in "%s" is disallowed.', $rawTypeText), + $annotation->getStartPointer(), + self::CODE_DISALLOWED_SHORT_NULLABLE, + ); + + if (!$fix) { + return; + } + + $innerTypeText = AnnotationTypeHelper::print($nullableTypeNode->type); + $separator = $this->withSpacesAroundOperators === self::YES ? ' | ' : '|'; + $fixedTypeText = $this->nullPosition === self::FIRST + ? 'null' . $separator . $innerTypeText + : $innerTypeText . $separator . 'null'; + + $this->fixDocCommentTypeText($phpcsFile, $parsedDocComment, $rawTypeText, $fixedTypeText); + } + + private function checkDocCommentNullableContraction(File $phpcsFile, Annotation $annotation, ParsedDocComment $parsedDocComment): void + { + $directType = $this->getAnnotationDirectType($annotation); + + if (!$directType instanceof UnionTypeNode || count($directType->types) !== 2) { + return; + } + + $nullTypeNode = null; + $otherTypeNode = null; + + foreach ($directType->types as $typeNode) { + if ($typeNode instanceof IdentifierTypeNode && strtolower($typeNode->name) === 'null') { + $nullTypeNode = $typeNode; + } else { + $otherTypeNode = $typeNode; + } + } + + if ($nullTypeNode === null || $otherTypeNode === null || $otherTypeNode instanceof IntersectionTypeNode) { + return; + } + + $rawTypeText = trim($parsedDocComment->getTokens()->getContentBetween( + $directType->getAttribute(Attribute::START_INDEX), + $directType->getAttribute(Attribute::END_INDEX) + 1, + )); + + $fix = $phpcsFile->addFixableError( + sprintf('Short nullable type hint in "%s" is required.', $rawTypeText), + $annotation->getStartPointer(), + self::CODE_REQUIRED_SHORT_NULLABLE, + ); + + if (!$fix) { + return; + } + + $fixedTypeText = '?' . AnnotationTypeHelper::print($otherTypeNode); + $this->fixDocCommentTypeText($phpcsFile, $parsedDocComment, $rawTypeText, $fixedTypeText); + } + + private function fixDocCommentTypeText( + File $phpcsFile, + ParsedDocComment $parsedDocComment, + string $originalText, + string $fixedText + ): void + { + $rawDocblockContent = TokenHelper::getContent( + $phpcsFile, + $parsedDocComment->getOpenPointer(), + $parsedDocComment->getClosePointer(), + ); + + $fixedDocblockContent = str_replace($originalText, $fixedText, $rawDocblockContent); + + $phpcsFile->fixer->beginChangeset(); + + FixerHelper::change( + $phpcsFile, + $parsedDocComment->getOpenPointer(), + $parsedDocComment->getClosePointer(), + $fixedDocblockContent, + ); + + $phpcsFile->fixer->endChangeset(); + } + + private function getAnnotationDirectType(Annotation $annotation): ?TypeNode + { + $value = $annotation->getValue(); + + if ( + $value instanceof ParamTagValueNode + || $value instanceof ReturnTagValueNode + || $value instanceof VarTagValueNode + || $value instanceof PropertyTagValueNode + ) { + return $value->type; + } + + return null; + } + private function checkTypeHint(File $phpcsFile, TypeHint $typeHint): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DeclareStrictTypesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DeclareStrictTypesSniff.php index bc2a64341..a61febf4f 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DeclareStrictTypesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DeclareStrictTypesSniff.php @@ -48,11 +48,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $openTagPointer - */ - public function process(File $phpcsFile, $openTagPointer): void + public function process(File $phpcsFile, int $openTagPointer): void { $this->linesCountBeforeDeclare = SniffSettingsHelper::normalizeInteger($this->linesCountBeforeDeclare); $this->linesCountAfterDeclare = SniffSettingsHelper::normalizeInteger($this->linesCountAfterDeclare); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowArrayTypeHintSyntaxSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowArrayTypeHintSyntaxSniff.php index 316c11cf9..37c67368b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowArrayTypeHintSyntaxSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowArrayTypeHintSyntaxSniff.php @@ -54,11 +54,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowMixedTypeHintSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowMixedTypeHintSniff.php index a3058bdf0..b4737e719 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowMixedTypeHintSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/DisallowMixedTypeHintSniff.php @@ -30,11 +30,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { if (SuppressHelper::isSniffSuppressed( $phpcsFile, diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/LongTypeHintsSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/LongTypeHintsSniff.php index 11403e3aa..b6908c2a4 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/LongTypeHintsSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/LongTypeHintsSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullTypeHintOnLastPositionSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullTypeHintOnLastPositionSniff.php index c9286c516..f3abbdf01 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullTypeHintOnLastPositionSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullTypeHintOnLastPositionSniff.php @@ -16,6 +16,9 @@ use function strtolower; use const T_DOC_COMMENT_OPEN_TAG; +/** + * @deprecated Use DNFTypeHintFormatSniff with nullPosition set to 'last' and enableForDocComments set to true, which enforces the same rule for both PHP code and docblocks. + */ class NullTypeHintOnLastPositionSniff implements Sniff { @@ -31,11 +34,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $docCommentOpenPointer - */ - public function process(File $phpcsFile, $docCommentOpenPointer): void + public function process(File $phpcsFile, int $docCommentOpenPointer): void { $annotations = AnnotationHelper::getAnnotations($phpcsFile, $docCommentOpenPointer); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullableTypeForNullDefaultValueSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullableTypeForNullDefaultValueSniff.php index 5c7967b00..f5a2de5a3 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullableTypeForNullDefaultValueSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/NullableTypeForNullDefaultValueSniff.php @@ -35,11 +35,7 @@ public function register(): array return TokenHelper::FUNCTION_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { if (SuppressHelper::isSniffSuppressed($phpcsFile, $functionPointer, self::NAME)) { return; diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSniff.php index 4e363381b..80f768226 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSniff.php @@ -96,11 +96,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $this->enableObjectTypeHint = SniffSettingsHelper::isEnabledByPhpVersion($this->enableObjectTypeHint, 70200); $this->enableMixedTypeHint = SniffSettingsHelper::isEnabledByPhpVersion($this->enableMixedTypeHint, 80000); @@ -115,10 +111,6 @@ public function process(File $phpcsFile, $functionPointer): void return; } - if (DocCommentHelper::hasInheritdocAnnotation($phpcsFile, $functionPointer)) { - return; - } - $parametersTypeHints = FunctionHelper::getParametersTypeHints($phpcsFile, $functionPointer); $parametersAnnotations = FunctionHelper::getValidParametersAnnotations($phpcsFile, $functionPointer); $prefixedParametersAnnotations = FunctionHelper::getValidPrefixedParametersAnnotations($phpcsFile, $functionPointer); @@ -147,6 +139,9 @@ private function checkTypeHints( array $prefixedParametersAnnotations ): void { + $isInherited = AttributeHelper::hasAttribute($phpcsFile, $functionPointer, '\Override') + || DocCommentHelper::hasInheritdocAnnotation($phpcsFile, $functionPointer); + $suppressNameAnyTypeHint = self::getSniffName(self::CODE_MISSING_ANY_TYPE_HINT); $isSuppressedAnyTypeHint = SuppressHelper::isSniffSuppressed($phpcsFile, $functionPointer, $suppressNameAnyTypeHint); @@ -180,7 +175,7 @@ private function checkTypeHints( $visibilityPointer = TokenHelper::findNextEffective($phpcsFile, $pointerBeforeParameter + 1); - $isPropertyPromotion = in_array($tokens[$visibilityPointer]['code'], Tokens::$scopeModifiers, true); + $isPropertyPromotion = in_array($tokens[$visibilityPointer]['code'], Tokens::SCOPE_MODIFIERS, true); } if ( @@ -196,6 +191,10 @@ private function checkTypeHints( continue; } + if ($isInherited) { + continue; + } + $phpcsFile->addError( sprintf( '%s %s() does not have parameter type hint nor @param annotation for its parameter %s.', @@ -210,10 +209,6 @@ private function checkTypeHints( continue; } - if (AttributeHelper::hasAttribute($phpcsFile, $functionPointer, '\Override')) { - continue; - } - $parameterTypeNode = $parametersAnnotations[$parameterName]->getValue()->type; if ( @@ -367,6 +362,10 @@ private function checkTypeHints( continue; } + if ($isInherited) { + continue; + } + $fix = $phpcsFile->addFixableError( sprintf( '%s %s() does not have native type hint for its parameter %s but it should be possible to add it based on @param annotation "%s".', @@ -460,6 +459,9 @@ private function checkTraversableTypeHintSpecification( array $prefixedParametersAnnotations ): void { + $isInherited = AttributeHelper::hasAttribute($phpcsFile, $functionPointer, '\Override') + || DocCommentHelper::hasInheritdocAnnotation($phpcsFile, $functionPointer); + $suppressName = self::getSniffName(self::CODE_MISSING_TRAVERSABLE_TYPE_HINT_SPECIFICATION); $isSniffSuppressed = SuppressHelper::isSniffSuppressed($phpcsFile, $functionPointer, $suppressName); $suppressUseless = true; @@ -494,7 +496,7 @@ private function checkTraversableTypeHintSpecification( if ($hasTraversableTypeHint && !array_key_exists($parameterName, $parametersAnnotations)) { $suppressUseless = false; - if (!$isSniffSuppressed) { + if (!$isSniffSuppressed && !$isInherited) { $phpcsFile->addError( sprintf( '%s %s() does not have @param annotation for its traversable parameter %s.', @@ -542,7 +544,7 @@ private function checkTraversableTypeHintSpecification( $suppressUseless = false; - if ($isSniffSuppressed) { + if ($isSniffSuppressed || $isInherited) { continue; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSpacingSniff.php index 2eb6688aa..6d762c300 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ParameterTypeHintSpacingSniff.php @@ -34,11 +34,7 @@ public function register(): array return TokenHelper::FUNCTION_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/PropertyTypeHintSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/PropertyTypeHintSniff.php index 9373cf731..4d736412f 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/PropertyTypeHintSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/PropertyTypeHintSniff.php @@ -19,6 +19,7 @@ use SlevomatCodingStandard\Helpers\Annotation; use SlevomatCodingStandard\Helpers\AnnotationHelper; use SlevomatCodingStandard\Helpers\AnnotationTypeHelper; +use SlevomatCodingStandard\Helpers\AttributeHelper; use SlevomatCodingStandard\Helpers\DocCommentHelper; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\NamespaceHelper; @@ -100,11 +101,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->enableNativeTypeHint = SniffSettingsHelper::isEnabledByPhpVersion($this->enableNativeTypeHint, 70400); $this->enableMixedTypeHint = $this->enableNativeTypeHint @@ -187,6 +184,8 @@ private function checkTypeHint( array $prefixedPropertyAnnotations ): void { + $isInherited = AttributeHelper::hasAttribute($phpcsFile, $propertyPointer, '\Override'); + $suppressNameAnyTypeHint = $this->getSniffName(self::CODE_MISSING_ANY_TYPE_HINT); $isSuppressedAnyTypeHint = SuppressHelper::isSniffSuppressed($phpcsFile, $propertyPointer, $suppressNameAnyTypeHint); @@ -205,7 +204,10 @@ private function checkTypeHint( return; } - if (!$isSuppressedAnyTypeHint) { + if ( + !$isSuppressedAnyTypeHint + && !$isInherited + ) { $phpcsFile->addError( sprintf( $this->enableNativeTypeHint @@ -361,7 +363,7 @@ private function checkTypeHint( $nullableTypeHint = true; } - if ($isSuppressedNativeTypeHint) { + if ($isSuppressedNativeTypeHint || $isInherited) { return; } @@ -425,6 +427,8 @@ private function checkTraversableTypeHintSpecification( array $prefixedPropertyAnnotations ): void { + $isInherited = AttributeHelper::hasAttribute($phpcsFile, $propertyPointer, '\Override'); + $suppressName = $this->getSniffName(self::CODE_MISSING_TRAVERSABLE_TYPE_HINT_SPECIFICATION); $isSuppressed = SuppressHelper::isSniffSuppressed($phpcsFile, $propertyPointer, $suppressName); @@ -438,7 +442,10 @@ private function checkTraversableTypeHintSpecification( return; } - if (!$isSuppressed) { + if ( + !$isSuppressed + && !$isInherited + ) { $phpcsFile->addError( sprintf( '@var annotation of property %s does not specify type hint for its items.', diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSniff.php index 1a9d74120..a33b70620 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSniff.php @@ -19,6 +19,7 @@ use SlevomatCodingStandard\Helpers\Annotation; use SlevomatCodingStandard\Helpers\AnnotationHelper; use SlevomatCodingStandard\Helpers\AnnotationTypeHelper; +use SlevomatCodingStandard\Helpers\AttributeHelper; use SlevomatCodingStandard\Helpers\DocCommentHelper; use SlevomatCodingStandard\Helpers\FixerHelper; use SlevomatCodingStandard\Helpers\FunctionHelper; @@ -92,11 +93,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->enableObjectTypeHint = SniffSettingsHelper::isEnabledByPhpVersion($this->enableObjectTypeHint, 70200); $this->enableStaticTypeHint = SniffSettingsHelper::isEnabledByPhpVersion($this->enableStaticTypeHint, 80000); @@ -113,10 +110,6 @@ public function process(File $phpcsFile, $pointer): void return; } - if (DocCommentHelper::hasInheritdocAnnotation($phpcsFile, $pointer)) { - return; - } - $token = $phpcsFile->getTokens()[$pointer]; if ($token['code'] === T_FUNCTION) { @@ -149,6 +142,12 @@ private function checkFunctionTypeHint( array $prefixedReturnAnnotations ): void { + $isInherited = AttributeHelper::hasAttribute( + $phpcsFile, + $functionPointer, + '\Override', + ) || DocCommentHelper::hasInheritdocAnnotation($phpcsFile, $functionPointer); + $suppressNameAnyTypeHint = $this->getSniffName(self::CODE_MISSING_ANY_TYPE_HINT); $isSuppressedAnyTypeHint = SuppressHelper::isSniffSuppressed($phpcsFile, $functionPointer, $suppressNameAnyTypeHint); @@ -183,6 +182,31 @@ private function checkFunctionTypeHint( } } + if ( + $this->enableStandaloneNullTrueFalseTypeHints + && $returnTypeHint->getTypeHint() === 'bool' + && $returnTypeNode instanceof IdentifierTypeNode + && in_array(strtolower($returnTypeNode->name), ['true', 'false'], true) + ) { + $fix = $phpcsFile->addFixableError( + sprintf( + '%s %s() has return type hint "bool" but it should be possible to use "%s" based on @return annotation "%s".', + FunctionHelper::getTypeLabel($phpcsFile, $functionPointer), + FunctionHelper::getFullyQualifiedName($phpcsFile, $functionPointer), + strtolower($returnTypeNode->name), + AnnotationTypeHelper::print($returnTypeNode), + ), + $functionPointer, + self::CODE_LESS_SPECIFIC_NATIVE_TYPE_HINT, + ); + + if ($fix) { + $phpcsFile->fixer->beginChangeset(); + FixerHelper::replace($phpcsFile, $returnTypeHint->getStartPointer(), strtolower($returnTypeNode->name)); + $phpcsFile->fixer->endChangeset(); + } + } + return; } @@ -211,7 +235,7 @@ private function checkFunctionTypeHint( return; } - if (!$isSuppressedAnyTypeHint) { + if (!$isSuppressedAnyTypeHint && !$isInherited) { $phpcsFile->addError( sprintf( '%s %s() does not have return type hint nor @return annotation for its return value.', @@ -233,7 +257,7 @@ private function checkFunctionTypeHint( || $isAnnotationReturnTypeVoidOrNever ) ) { - if (!$isSuppressedNativeTypeHint) { + if (!$isSuppressedNativeTypeHint && !$isInherited) { $message = !$hasReturnAnnotation ? sprintf( '%s %s() does not have void return type hint.', @@ -267,7 +291,7 @@ private function checkFunctionTypeHint( return; } - if (!$isSuppressedNativeTypeHint && $returnsValue && $isAnnotationReturnTypeVoidOrNever) { + if (!$isSuppressedNativeTypeHint && !$isInherited && $returnsValue && $isAnnotationReturnTypeVoidOrNever) { $message = sprintf( '%s %s() does not have native return type hint for its return value but it should be possible to add it based on @return annotation "%s".', FunctionHelper::getTypeLabel($phpcsFile, $functionPointer), @@ -418,7 +442,7 @@ private function checkFunctionTypeHint( $nullableReturnTypeHint = true; } - if ($isSuppressedNativeTypeHint) { + if ($isSuppressedNativeTypeHint || $isInherited) { return; } @@ -471,6 +495,12 @@ private function checkFunctionTraversableTypeHintSpecification( array $prefixedReturnAnnotations ): void { + $isInherited = AttributeHelper::hasAttribute( + $phpcsFile, + $functionPointer, + '\Override', + ) || DocCommentHelper::hasInheritdocAnnotation($phpcsFile, $functionPointer); + $suppressName = $this->getSniffName(self::CODE_MISSING_TRAVERSABLE_TYPE_HINT_SPECIFICATION); $isSuppressed = SuppressHelper::isSniffSuppressed($phpcsFile, $functionPointer, $suppressName); @@ -484,7 +514,7 @@ private function checkFunctionTraversableTypeHintSpecification( return; } - if (!$isSuppressed) { + if (!$isSuppressed && !$isInherited) { $phpcsFile->addError( sprintf( '%s %s() does not have @return annotation for its traversable return value.', @@ -525,7 +555,7 @@ private function checkFunctionTraversableTypeHintSpecification( return; } - if ($isSuppressed) { + if ($isSuppressed || $isInherited) { return; } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSpacingSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSpacingSniff.php index ceb0d89f6..1264ade20 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSpacingSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/ReturnTypeHintSpacingSniff.php @@ -41,11 +41,7 @@ public function register(): array return TokenHelper::FUNCTION_TOKEN_CODES; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $functionPointer - */ - public function process(File $phpcsFile, $functionPointer): void + public function process(File $phpcsFile, int $functionPointer): void { $this->spacesCountBeforeColon = SniffSettingsHelper::normalizeInteger($this->spacesCountBeforeColon); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UnionTypeHintFormatSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UnionTypeHintFormatSniff.php index 952d5302c..7183b185c 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UnionTypeHintFormatSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UnionTypeHintFormatSniff.php @@ -84,11 +84,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $this->enable = SniffSettingsHelper::isEnabledByPhpVersion($this->enable, 80000); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UselessConstantTypeHintSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UselessConstantTypeHintSniff.php index c85754165..42bb8e92c 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UselessConstantTypeHintSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/TypeHints/UselessConstantTypeHintSniff.php @@ -28,11 +28,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $constantPointer - */ - public function process(File $phpcsFile, $constantPointer): void + public function process(File $phpcsFile, int $constantPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowSuperGlobalVariableSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowSuperGlobalVariableSniff.php index 0410f7792..73f9574dc 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowSuperGlobalVariableSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowSuperGlobalVariableSniff.php @@ -34,11 +34,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowVariableVariableSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowVariableVariableSniff.php index ecd92b524..76eac18d6 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowVariableVariableSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DisallowVariableVariableSniff.php @@ -23,11 +23,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { $phpcsFile->addError('Use of variable variable is disallowed.', $pointer, self::CODE_DISALLOWED_VARIABLE_VARIABLE); } diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DuplicateAssignmentToVariableSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DuplicateAssignmentToVariableSniff.php index 36701025d..635e05e56 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DuplicateAssignmentToVariableSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/DuplicateAssignmentToVariableSniff.php @@ -27,11 +27,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $assignmentPointer - */ - public function process(File $phpcsFile, $assignmentPointer): void + public function process(File $phpcsFile, int $assignmentPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UnusedVariableSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UnusedVariableSniff.php index ef5fd00fd..da755be2d 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UnusedVariableSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UnusedVariableSniff.php @@ -85,11 +85,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $pointer - */ - public function process(File $phpcsFile, $pointer): void + public function process(File $phpcsFile, int $pointer): void { if (!$this->isAssignment($phpcsFile, $pointer)) { return; @@ -121,7 +117,7 @@ public function process(File $phpcsFile, $pointer): void return; } - if (in_array($tokens[$previousPointer]['code'], Tokens::$castTokens, true)) { + if (in_array($tokens[$previousPointer]['code'], Tokens::CAST_TOKENS, true)) { $previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $previousPointer - 1); } @@ -663,10 +659,10 @@ private function isPartOfStatementAndWithIncrementOrDecrementOperator(File $phpc $tokens[$previousPointer]['code'], array_merge( [T_STRING_CONCAT, T_ECHO, T_RETURN, T_EXIT, T_PRINT, T_COMMA, T_EMPTY, T_EVAL, T_YIELD], - Tokens::$operators, - Tokens::$assignmentTokens, - Tokens::$booleanOperators, - Tokens::$castTokens, + Tokens::OPERATORS, + Tokens::ASSIGNMENT_TOKENS, + Tokens::BOOLEAN_OPERATORS, + Tokens::CAST_TOKENS, ), true, ); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php index 79d27d810..503a6ea3a 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Variables/UselessVariableSniff.php @@ -61,11 +61,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $returnPointer - */ - public function process(File $phpcsFile, $returnPointer): void + public function process(File $phpcsFile, int $returnPointer): void { $tokens = $phpcsFile->getTokens(); diff --git a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Whitespaces/DuplicateSpacesSniff.php b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Whitespaces/DuplicateSpacesSniff.php index 20635817a..a0cfc893b 100644 --- a/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Whitespaces/DuplicateSpacesSniff.php +++ b/app/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Whitespaces/DuplicateSpacesSniff.php @@ -13,12 +13,14 @@ use function preg_replace; use function sprintf; use const PREG_OFFSET_CAPTURE; +use const T_BITWISE_AND; use const T_DOC_COMMENT_CLOSE_TAG; use const T_DOC_COMMENT_OPEN_TAG; use const T_DOC_COMMENT_STAR; use const T_DOC_COMMENT_STRING; use const T_DOC_COMMENT_TAG; use const T_DOC_COMMENT_WHITESPACE; +use const T_ELLIPSIS; use const T_MATCH_ARROW; use const T_VARIABLE; use const T_WHITESPACE; @@ -50,11 +52,7 @@ public function register(): array ]; } - /** - * @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint - * @param int $whitespacePointer - */ - public function process(File $phpcsFile, $whitespacePointer): void + public function process(File $phpcsFile, int $whitespacePointer): void { $tokens = $phpcsFile->getTokens(); @@ -73,7 +71,7 @@ public function process(File $phpcsFile, $whitespacePointer): void $pointerAfter = TokenHelper::findNextNonWhitespace($phpcsFile, $whitespacePointer + 1); if ( $pointerAfter !== null - && in_array($tokens[$pointerAfter]['code'], Tokens::$assignmentTokens, true) + && in_array($tokens[$pointerAfter]['code'], Tokens::ASSIGNMENT_TOKENS, true) ) { return; } @@ -81,12 +79,18 @@ public function process(File $phpcsFile, $whitespacePointer): void if ($this->ignoreSpacesInParameters) { $pointerAfter = TokenHelper::findNextNonWhitespace($phpcsFile, $whitespacePointer + 1); - if ( - $pointerAfter !== null - && $tokens[$pointerAfter]['code'] === T_VARIABLE - && ParameterHelper::isParameter($phpcsFile, $pointerAfter) - ) { - return; + if ($pointerAfter !== null) { + if (in_array($tokens[$pointerAfter]['code'], [T_BITWISE_AND, T_ELLIPSIS], true)) { + $pointerAfter = TokenHelper::findNextNonWhitespace($phpcsFile, $pointerAfter + 1); + } + + if ( + $pointerAfter !== null + && $tokens[$pointerAfter]['code'] === T_VARIABLE + && ParameterHelper::isParameter($phpcsFile, $pointerAfter) + ) { + return; + } } } diff --git a/app/vendor/slevomat/coding-standard/composer.json b/app/vendor/slevomat/coding-standard/composer.json index dabcf745d..c9a727cd2 100644 --- a/app/vendor/slevomat/coding-standard/composer.json +++ b/app/vendor/slevomat/coding-standard/composer.json @@ -4,7 +4,6 @@ "license": "MIT", "type": "phpcodesniffer-standard", "keywords": [ "phpcs", "dev" ], - "minimum-stability": "dev", "prefer-stable": true, "config": { "bin-dir": "bin", @@ -14,18 +13,18 @@ }, "require": { "php": "^7.4 || ^8.0", - "dealerdirect/phpcodesniffer-composer-installer": "^0.6.2 || ^0.7 || ^1.1.2", - "phpstan/phpdoc-parser": "^2.3.0", - "squizlabs/php_codesniffer": "^3.13.4" + "dealerdirect/phpcodesniffer-composer-installer": "^0.7 || ^1.2.1", + "phpstan/phpdoc-parser": "^2.3.2", + "squizlabs/php_codesniffer": "^4.0.1" }, "require-dev": { - "phing/phing": "3.0.1|3.1.0", + "phing/phing": "3.0.1|3.1.2", "php-parallel-lint/php-parallel-lint": "1.4.0", - "phpstan/phpstan": "2.1.22", - "phpstan/phpstan-deprecation-rules": "2.0.3", - "phpstan/phpstan-phpunit": "2.0.7", - "phpstan/phpstan-strict-rules": "2.0.6", - "phpunit/phpunit": "9.6.8|10.5.48|11.4.4|11.5.36|12.3.8" + "phpstan/phpstan": "2.1.54", + "phpstan/phpstan-deprecation-rules": "2.0.4", + "phpstan/phpstan-phpunit": "2.0.16", + "phpstan/phpstan-strict-rules": "2.0.11", + "phpunit/phpunit": "9.6.34|10.5.63|11.4.4|11.5.55|12.5.24" }, "autoload": { "psr-4": { diff --git a/app/vendor/slevomat/coding-standard/doc/classes.md b/app/vendor/slevomat/coding-standard/doc/classes.md index 5f64a4ff1..e1229d50d 100644 --- a/app/vendor/slevomat/coding-standard/doc/classes.md +++ b/app/vendor/slevomat/coding-standard/doc/classes.md @@ -22,6 +22,12 @@ const FOO = 1; // visibility missing! public const BAR = 2; // correct ``` +#### SlevomatCodingStandard.Classes.ClassKeywordOrder 🔧 + +Enforces the correct order of class modifiers (e.g., `final`, `abstract`, `readonly`). + +Required order is (final | abstract) readonly class. That is, use either `final` or `abstract` (never both), then `readonly` if present, then `class`. + #### SlevomatCodingStandard.Classes.ClassLength Disallows long classes. This sniff provides the following settings: @@ -46,6 +52,7 @@ Sniff provides the following settings: * `groups`: order of groups. Use multiple groups in one `` to not differentiate among them. You can use specific groups or shortcuts. * `methodGroups`: custom method groups. Define a custom group for special methods based on their name, annotation, or attribute. + * You can use a `*` as prefix or suffix to filter methods name as seen in the example below. **List of supported groups**: uses, @@ -68,6 +75,7 @@ constants, properties, static properties, methods, all public methods, all prote + @@ -96,6 +104,9 @@ constants, properties, static properties, methods, all public methods, all prote + + + @@ -246,7 +257,8 @@ Sniff provides the following settings: * `excludedMethodPatterns`: allows to configure which methods are excluded from sniff detection. This is an array of regular expressions (PCRE) with delimiters. You should not use this with `includedMethodPatterns`, as it will not work properly. -* `withPromotedProperties`: always require multiline signatures for methods with promoted properties. +* `withPromotedProperties` (default: `false`): always require multiline signatures for methods with promoted properties. +* `withParametersWithAttributes` (default: `false`): always require multiline signatures for methods with parameters with attributes. #### SlevomatCodingStandard.Classes.RequireSelfReference 🔧 @@ -288,6 +300,14 @@ Reports use of superfluous suffix "Trait" for traits. Prohibits multiple traits separated by commas in one `use` statement. +#### SlevomatCodingStandard.Classes.TraitUseOrder 🔧 + +Enforces alphabetical order of trait `use` statements, both when traits are on separate lines and when they are comma-separated in a single `use` statement. + +Sniff provides the following settings: + +* `caseSensitive` (default: `false`): compare trait names case-sensitively. + #### SlevomatCodingStandard.Classes.TraitUseSpacing 🔧 Enforces configurable number of lines before first `use`, after last `use` and between two `use` statements. diff --git a/app/vendor/slevomat/coding-standard/doc/commenting.md b/app/vendor/slevomat/coding-standard/doc/commenting.md index 0c4862765..a0d3a47fd 100644 --- a/app/vendor/slevomat/coding-standard/doc/commenting.md +++ b/app/vendor/slevomat/coding-standard/doc/commenting.md @@ -90,6 +90,10 @@ Sniff provides the following settings: * `allowDocCommentAboveReturn`: Allows documentation comments without variable name above `return` statement. * `allowAboveNonAssignment`: Allows documentation comments above non-assignment if the line contains the right variable name. +#### SlevomatCodingStandard.Commenting.RequireOneDocComment + +Ensures that there is only one PHPDoc comment block for each entity (class, method, property, constant, etc.). This sniff prevents multiple documentation comments from being associated with a single code element, which can lead to confusion and inconsistency. + #### SlevomatCodingStandard.Commenting.RequireOneLinePropertyDocComment 🔧 Requires property comments with single-line content to be written as one-liners. @@ -102,6 +106,14 @@ Sniff requires comments with single-line content to be written as one-liners. Sniff requires comments with single-line content to be written as multi-liners. +#### SlevomatCodingStandard.Commenting.ThrowsAnnotationsOrder 🔧 + +Checks that `@throws` annotations are sorted alphabetically by exception class name. + +Sniff provides the following settings: + +* `caseSensitive`: compare class names case-sensitively. Default is `false`. + #### SlevomatCodingStandard.Commenting.UselessFunctionDocComment 🔧 * Checks for useless doc comments. If the native method declaration contains everything and the phpDoc does not add anything useful, it's reported as useless and can optionally be automatically removed with `phpcbf`. @@ -111,8 +123,6 @@ Sniff provides the following settings: * `traversableTypeHints`: enforces which typehints must have specified contained type. E.g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`. -This sniff can cause an error if you're overriding or implementing a parent method which does not have typehints. In such cases add `@phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint` annotation to the method to have this sniff skip it. - #### SlevomatCodingStandard.Commenting.UselessInheritDocComment 🔧 Reports documentation comments containing only `{@inheritDoc}` annotation because inheritance is automatic, and it's not needed to use a special annotation for it. diff --git a/app/vendor/slevomat/coding-standard/doc/exceptions.md b/app/vendor/slevomat/coding-standard/doc/exceptions.md index bc675f25e..81fee427d 100644 --- a/app/vendor/slevomat/coding-standard/doc/exceptions.md +++ b/app/vendor/slevomat/coding-standard/doc/exceptions.md @@ -1,5 +1,13 @@ ## Exceptions +#### SlevomatCodingStandard.Exceptions.CatchExceptionsOrder 🔧 + +Enforces alphabetical order of caught exception types within a `catch` block. + +Sniff provides the following settings: + +* `caseSensitive` (default: `false`): compare exception names case-sensitively. + #### SlevomatCodingStandard.Exceptions.DeadCatch This sniff finds unreachable catch blocks: diff --git a/app/vendor/slevomat/coding-standard/doc/functions.md b/app/vendor/slevomat/coding-standard/doc/functions.md index 8741d9870..6c56da9c6 100644 --- a/app/vendor/slevomat/coding-standard/doc/functions.md +++ b/app/vendor/slevomat/coding-standard/doc/functions.md @@ -43,6 +43,8 @@ Enforces function call to be split to more lines so each parameter is on its own Sniff provides the following settings: * `minLineLength`: specifies min line length to enforce call to be split. Use 0 value to enforce for all calls, regardless of length. +* `minParametersCount`: specifies min parameters count to enforce call to be split. +* `excludedCallPatterns`: allows to configure which calls are excluded from sniff detection. This is an array of regular expressions (PCRE) with delimiters. #### SlevomatCodingStandard.Functions.RequireSingleLineCall 🔧 diff --git a/app/vendor/slevomat/coding-standard/doc/numbers.md b/app/vendor/slevomat/coding-standard/doc/numbers.md index 8df99a236..a9ca53bc2 100644 --- a/app/vendor/slevomat/coding-standard/doc/numbers.md +++ b/app/vendor/slevomat/coding-standard/doc/numbers.md @@ -11,6 +11,6 @@ Requires use of numeric literal separators. This sniff provides the following setting: * `enable`: either to enable or not this sniff. By default, it is enabled for PHP versions 7.4 or higher. -* `minDigitsBeforeDecimalPoint`: the minimum digits before decimal point to require separator. -* `minDigitsAfterDecimalPoint`: the minimum digits after decimal point to require separator. -* `ignoreOctalNumbers`: to ignore octal numbers. +* `minDigitsBeforeDecimalPoint` (default: `4`): the minimum digits before decimal point to require separator. +* `minDigitsAfterDecimalPoint` (default: `4`): the minimum digits after decimal point to require separator. +* `ignoreOctalNumbers` (default: `true`): to ignore octal numbers. diff --git a/app/vendor/slevomat/coding-standard/doc/php.md b/app/vendor/slevomat/coding-standard/doc/php.md index 43604714e..959a6982d 100644 --- a/app/vendor/slevomat/coding-standard/doc/php.md +++ b/app/vendor/slevomat/coding-standard/doc/php.md @@ -74,6 +74,8 @@ Looks for useless parentheses. Sniff provides the following settings: * `ignoreComplexTernaryConditions` (default: `false`): ignores complex ternary conditions - condition must contain `&&`, `||` etc. or end of line. +* `enableCheckAroundNew` (default: `false`): enables check of useless parentheses around `(new class())->call()`. + #### SlevomatCodingStandard.PHP.UselessSemicolon 🔧 diff --git a/app/vendor/slevomat/coding-standard/doc/type-hints.md b/app/vendor/slevomat/coding-standard/doc/type-hints.md index 5b482015c..b7a790e91 100644 --- a/app/vendor/slevomat/coding-standard/doc/type-hints.md +++ b/app/vendor/slevomat/coding-standard/doc/type-hints.md @@ -35,11 +35,12 @@ Disallows usage of "mixed" type hint in phpDocs. #### SlevomatCodingStandard.TypeHints.DNFTypeHintFormat 🔧 -Checks format of DNF type hints. +Checks format of DNF type hints. The same checks can also be applied to type hints inside `@param`, `@return`, `@var`, `@property` and `@property-read` annotations by enabling `enableForDocComments`. Sniff provides the following settings: * `enable`: either to enable or not this sniff. By default, it is enabled for PHP versions 8.0 or higher. +* `enableForDocComments`: `true` also applies the configured checks to type hints in doc-comment annotations. Disabled by default. * `withSpacesAroundOperators`: `yes` requires spaces around `|` and `&`, `no` requires no space around `|`and `&`. None is set by default so both are enabled. * `withSpacesInsideParentheses`: `yes` requires spaces inside parentheses, `no` requires no spaces inside parentheses. None is set by default so both are enabled. * `shortNullable`: `yes` requires usage of `?` for nullable type hint, `no` disallows it. None is set by default so both are enabled. @@ -51,6 +52,8 @@ Enforces using shorthand scalar typehint variants in phpDocs: `int` instead of ` #### SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition 🔧 +> **Deprecated.** Use [`SlevomatCodingStandard.TypeHints.DNFTypeHintFormat`](#slevomatcodingstandardtypehintsdnftypehintformat-) with `nullPosition` set to `last` and `enableForDocComments` set to `true`, which enforces the same rule for both PHP code and annotations. + Enforces `null` type hint on last position in annotations. #### SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue 🔧🚧 @@ -81,7 +84,7 @@ Sniff provides the following settings: * `enableStandaloneNullTrueFalseTypeHints`: enforces to transform `@param true`, `@param false` or `@param null` into native typehints. It's on by default if you're on PHP 8.2+ * `traversableTypeHints`: enforces which typehints must have specified contained type. E.g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`. -This sniff can cause an error if you're overriding or implementing a parent method which does not have typehints. In such cases add `@phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint` annotation to the method to have this sniff skip it. +This sniff can cause an error if you're overriding or implementing a parent method which does not have typehints. In such cases add `#[Override]` attribute or `@phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint` annotation to the method to have this sniff skip it. #### SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing 🔧 @@ -103,7 +106,7 @@ Sniff provides the following settings: * `enableStandaloneNullTrueFalseTypeHints`: enforces to transform `@var true`, `@var false` or `@var null` into native typehints. It's on by default if you're on PHP 8.2+. It can be enabled only when `enableNativeTypeHint` is enabled too. * `traversableTypeHints`: enforces which typehints must have specified contained type. E.g. if you set this to `\Doctrine\Common\Collections\Collection`, then `\Doctrine\Common\Collections\Collection` must always be supplied with the contained type: `\Doctrine\Common\Collections\Collection|Foo[]`. -This sniff can cause an error if you're overriding parent property which does not have typehints. In such cases add `@phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint` annotation to the property to have this sniff skip it. +This sniff can cause an error if you're overriding parent property which does not have typehints. In such cases add `#[Override]` attribute if you are using PHP 8.5+ or add `@phpcsSuppress SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint` annotation to the property to have this sniff skip it. #### SlevomatCodingStandard.TypeHints.ReturnTypeHint 🔧🚧 diff --git a/app/vendor/squizlabs/php_codesniffer/CHANGELOG-3.x.md b/app/vendor/squizlabs/php_codesniffer/CHANGELOG-3.x.md new file mode 100644 index 000000000..2511beb65 --- /dev/null +++ b/app/vendor/squizlabs/php_codesniffer/CHANGELOG-3.x.md @@ -0,0 +1,3974 @@ +# Changelog + +The file documents changes to the PHP_CodeSniffer project for the 3.x series of releases. + +## [3.13.5] - 2025-11-04 + +### Added +- Runtime support for PHP 8.5. All known PHP 8.5 deprecation notices have been fixed. + - Syntax support for new PHP 8.5 features will follow in a future release. + - If you find any PHP 8.5 deprecation notices which were missed, please report them. + +### Changed +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#1216]: Tokenizer/PHP: added more defensive coding to prevent PHP 8.5 "Using null as an array offset" deprecation notices. + - Thanks to [Andrew Lyons][@andrewnicols] for the patch. +- Fixed bug [#1279]: Tokenizer/PHP: on PHP < 8.0, an unclosed attribute (parse error) could end up removing some tokens from the token stream. + - This could lead to false positives and false negative from sniffs, but could also lead to incorrect fixes being made mangling the file under scan. + - Thanks to [Juliette Reinders Folmer](https://github.com/jrfnl) for the patch. + +### Other +- Please be aware that the `master` branch has been renamed to `3.x` and the default branch has changed to the `4.x` branch. + - If you contribute to PHP_CodeSniffer, you will need to update your local git clone. + - If you develop against PHP_CodeSniffer and run your tests against dev branches of PHPCS, you will need to update your workflows. + +[#1216]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1216 +[#1279]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1279 + + +## [3.13.4] - 2025-09-05 + +### Fixed +- Fixed bug [#1213]: ability to run tests for external standards using the PHPCS native test framework was broken. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#1215]: PHP 8.5 "Using null as an array offset" deprecation notices. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +[#1213]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1213 +[#1215]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1215 + + +## [3.13.3] - 2025-09-04 + +### Added +- Tokenizer support for PHP 8.4 dereferencing of new expressions without wrapping parentheses. [#1160] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Tokenizer support for PHP 8.4 `abstract` properties. [#1183] + - The `File::getMemberProperties()` method now also supports `abstract` properties through a new `is_abstract` array index in the return value. [#1184] + - Additionally, the following sniffs have been updated to support `abstract` properties: + - Generic.PHP.LowerCaseConstant [#1185] + - Generic.PHP.UpperCaseConstant [#1185] + - PSR2.Classes.PropertyDeclaration [#1188] + - Squiz.Commenting.VariableComment [#1186] + - Squiz.WhiteSpace.MemberVarSpacing [#1187] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches +- Tokenizer support for the PHP 8.4 "exit as a function call" change. [#1201] + - When `exit`/`die` is used as a fully qualified "function call", it will now be tokenized as `T_NS_SEPARATOR` + `T_EXIT`. + - Additionally, the following sniff has been updated to handle fully qualified exit/die correctly: + - Squiz.PHP.NonExecutableCode + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches + +### Changed +- Tokenizer/PHP: fully qualified `true`/`false`/`null` will now be tokenized as `T_NS_SEPARATOR` + `T_TRUE`/`T_FALSE`/`T_NULL`. [#1201] + - Previously, these were tokenized as `T_NS_SEPARATOR` + `T_STRING`. + - Additionally, the following sniffs have been updated to handle fully qualified true/false/null correctly: + - Generic.CodeAnalysis.UnconditionalIfStatement + - Generic.ControlStructures.DisallowYodaConditions + - PEAR.Functions.ValidDefaultValue + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. +- Generic.PHP.Syntax: the sniff is now able to scan input provided via STDIN on non-Windows OSes. [#915] + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- PSR2.ControlStructures.SwitchDeclaration: the `WrongOpener*` error code is now auto-fixable if the identified "wrong opener" is a semi-colon. [#1161] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The PSR2.Classes.PropertyDeclaration will now check that the abstract modifier keyword is placed before a visibility keyword. [#1188] + - Errors will be reported via a new `AbstractAfterVisibility` error code. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Bernhard Zwein][@benno5020], [Rick Kerkhof][@NanoSector], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#1112] : `--parallel` option fails if PHP_CodeSniffer is invoked via bash and the invokation creates a non-PHPCS-managed process. + - Thanks to [Rick Kerkhof][@NanoSector] for the patch. +- Fixed bug [#1113] : fatal error when the specified "files to scan" would result in the same file being added multiple times to the queue. + - This error only occured when `--parallel` scanning was enabled. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#1154] : PEAR.WhiteSpace.ObjectOperatorIndent: false positive when checking multiple chained method calls in a multidimensional array. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#1193] : edge case inconsistency in how empty string array keys for sniff properties are handled. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#1197] : Squiz.Commenting.FunctionComment: return types containing a class name with underscores would be truncated leading to incorrect results. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +### Other +- The [Wiki documentation] is now publicly editable. :tada: + - Update proposals can be submittted by opening a pull request in the [PHPCSStandards/PHP_CodeSniffer-documentation][docs-repo] repository. + Contributions welcome ! + - Thanks to [Anna Filina][@afilina], [Dan Wallis][@fredden] and [Juliette Reinders Folmer][@jrfnl] for their work on getting this set up. +- The [Phar website] has had a facelift. [#107] + - Thanks to [Bernhard Zwein][@benno5020] for making this happen! + +[Wiki documentation]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki +[docs-repo]: https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation +[Phar website]: https://phars.phpcodesniffer.com/ + +[#107]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/107 +[#915]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/915 +[#1112]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1112 +[#1113]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1113 +[#1154]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1154 +[#1160]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1160 +[#1161]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1161 +[#1183]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1183 +[#1184]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1184 +[#1185]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1185 +[#1186]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1186 +[#1187]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1187 +[#1188]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1188 +[#1193]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1193 +[#1197]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1197 +[#1201]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1201 + + +## [3.13.2] - 2025-06-18 + +### Changed +- The documentation for the following sniffs has been improved: + - Squiz.Classes.SelfMemberReference + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#1135] : Squiz.Functions.FunctionDeclarationArgumentSpacing: typo in new error code `SpacingAfterSetVis\[i\]bility`. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +[#1135]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1135 + + +## [3.13.1] - 2025-06-13 + +### Added +- Added support for PHP 8.4 properties with asymmetric visibility to File::getMemberProperties() through a new `set_scope` array index in the return value. [#1116] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. +- Added support for PHP 8.4 (constructor promoted) properties with asymmetric visibility to File::getMethodParameters() through new `set_visibility` and `set_visibility_token` array indexes in the return value. [#1116] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. +- Added support for PHP 8.4 asymmetric visibility modifiers to the following sniffs: + - Generic.PHP.LowerCaseKeyword [#1117] + - PEAR.NamingConventions.ValidVariableName [#1118] + - PSR2.Classes.PropertyDeclaration [#1119] + - Squiz.Commenting.BlockComment [#1120] + - Squiz.Commenting.DocCommentAlignment [#1120] + - Squiz.Commenting.VariableComment [#1120] + - Squiz.Functions.FunctionDeclarationArgumentSpacing [#1121] + - Squiz.Scope.MemberVarScope [#1122] + - Squiz.WhiteSpace.MemberVarSpacing [#1123] + - Squiz.WhiteSpace.ScopeKeywordSpacing [#1124] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. + +### Changed +- The PSR2.Classes.PropertyDeclaration will now check that a set-visibility modifier keyword is placed after a potential general visibility keyword. [#1119] + - Errors will be reported via a new `AvizKeywordOrder` error code. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The Squiz.Functions.FunctionDeclarationArgumentSpacing will now check spacing after a set-visibility modifier keyword. [#1121] + - Errors will be reported via a new `SpacingAfterSetVisibility` error code. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The Squiz.Scope.MemberVarScope will now flag missing "read" visibility, when "write" visibility is set, under a separate error code `AsymReadMissing`. [#1122] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The documentation for the following sniffs has been improved: + - PEAR.Classes.ClassDeclaration + - Squiz.WhiteSpace.FunctionOpeningBraceSpace + - Thanks to [Brian Dunne][@braindawg] and [Rodrigo Primo][@rodrigoprimo] for the patches. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Dan Wallis][@fredden], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Other +- The latest PHP_CodeSniffer XSD file is now available via the following permalink: . [#1094] + Older XSD files can be referenced via permalinks based on their minor: `https://schema.phpcodesniffer.com/#.#/phpcs.xsd`. +- The GPG signature for the PHAR files has been rotated. The new fingerprint is: D91D86963AF3A29B6520462297B02DD8E5071466. + +[#1094]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1094 +[#1116]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1116 +[#1117]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1117 +[#1118]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1118 +[#1119]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1119 +[#1120]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1120 +[#1121]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1121 +[#1122]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1122 +[#1123]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1123 +[#1124]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1124 + + +## [3.13.0] - 2025-05-11 + +### Added +- Added support for PHP 8.4 asymmetric visibility modifiers to the tokenizer. [#871] + - Thanks to [Daniel Scherzer][@DanielEScherzer] for the patch. +- Added support for PHP 8.4 `final` properties to the following sniffs: + - PSR2.Classes.PropertyDeclaration [#950] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. + +### Changed +- Generic.WhiteSpace.LanguageConstructSpacing: will now also check the spacing after the `goto` language construct keyword. [#917] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The PSR2.Classes.PropertyDeclaration will now check that the `final` modifier keyword is placed before a visibility keyword. [#950] + - Errors will be reported via a new `FinalAfterVisibility` error code. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Improved Help information about the `--reports` CLI flag. [#1078] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The documentation for the following sniffs has been improved: + - PSR1.Files.SideEffects + - PSR2.ControlStructures.SwitchDeclaration + - PSR2.Namespaces.NamespaceDeclaration + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patches. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Deprecated + +- Nearly everything which was soft deprecated before is now hard deprecated and will show deprecation notices: + - This applies to: + - All sniffs which will be removed in 4.0. [#888] + - The deprecated Generator methods. [#889] + - The old array property setting format (via comma separated strings). [#890] + - Sniffs not implementing the `PHP_CodeSniffer\Sniffs\Sniff` interface. [#891] + - Sniffs not following the naming conventions. [#892] + - Standards called Internal. [#893] + - Sniffs which don't listen for PHP, like JS/CSS specific sniffs. [#894] + - The deprecation notices can be silenced by using the `-q` (=quiet) CLI flag. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. + +### Fixed +- Fixed bug [#1040] : Generic.Strings.UnnecessaryHeredoc - false positive for heredocs containing escape sequences. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#1040] : Generic.Strings.UnnecessaryHeredoc - fixer would not clean up escape sequences which aren't necessary in nowdocs. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#1048] : A file under scan would sometimes be updated with partial fixes, even though the file "failed to fix". + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +### Other +**Calling all testers!** + +The first beta release for PHP_CodeSniffer 4.0 has been tagged. Please help by testing the beta release and reporting any issues you run into. +Upgrade guides for both [ruleset maintainers/end-users][wiki-upgrade-guide-users-40], as well as for [sniff developers and integrators][wiki-upgrade-guide-devs-40], have been published to the Wiki to help smooth the transition. + +[wiki-upgrade-guide-users-40]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-User-Upgrade-Guide +[wiki-upgrade-guide-devs-40]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-Developer-Upgrade-Guide + +[#871]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/871 +[#888]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/888 +[#889]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/889 +[#890]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/890 +[#891]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/891 +[#892]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/892 +[#893]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/893 +[#894]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/894 +[#917]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/917 +[#950]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/950 +[#1040]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1040 +[#1048]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1048 +[#1078]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1078 + +## [3.12.2] - 2025-04-13 + +### Added +- Added support for PHP 8.4 `final` properties to the following sniffs: + - Generic.PHP.LowerCaseConstant [#948] + - Generic.PHP.UpperCaseConstant [#948] + - Squiz.Commenting.DocCommentAlignment [#951] + - Squiz.Commenting.VariableComment [#949] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. + +### Changed +- Tokenizer/PHP: a PHP open tag at the very end of a file will now always be tokenized as T_OPEN_TAG, independently of the PHP version. [#937] + - Previously, a PHP open tag at the end of a file was not tokenized as an open tag on PHP < 7.4 and the tokenization would depend on the `short_open_tag` setting. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- PEAR.Commenting.FunctionComment: improved message for "blank lines between docblock and declaration" check. [#830] +- The documentation for the following sniffs has been improved: + - Generic.Functions.OpeningFunctionBraceBsdAllman + - Generic.Functions.OpeningFunctionBraceKernighanRitchie + - Generic.WhiteSpace.LanguageConstructSpacing + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patches. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#830] : PEAR.Commenting.FunctionComment will no longer remove blank lines within attributes. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#929] : Generic.PHP.ForbiddenFunctions: prevent false positives/negatives for code interlaced with comments. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#934] : Generic.PHP.LowerCaseConstant and Generic.PHP.UpperCaseConstant will now correctly ignore DNF types for properties. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#936] : Squiz.Commenting.FunctionCommentThrowTag: sniff would bow out when function has attributes attached, leading to false negatives. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#940] : Squiz.Commenting.VariableComment: false positive for missing docblock for properties using DNF types. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#944] : Squiz.Commenting.FunctionComment did not support DNF/intersection types in `@param` tags. + - Thanks to [Jeffrey Angenent][@devfrey] for the patch. +- Fixed bug [#945] : Squiz.WhiteSpace.FunctionSpacing would get confused when there are two docblocks above a function declaration. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#947] : Squiz.Commenting.FunctionCommentThrowTag: prevent false positives/negatives for code interlaced with comments. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#951] : Squiz.Commenting.DocCommentAlignment did not examine docblocks for `final` classes. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#955] : Potential race condition, leading to a fatal error, when both the `Diff` + the `Code` reports are requested and caching is on. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#956] : Generic.WhiteSpace.ScopeIndent: undefined array index notice when running in debug mode. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +[#830]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/830 +[#929]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/929 +[#934]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/934 +[#936]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/936 +[#937]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/937 +[#940]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/940 +[#944]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/944 +[#945]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/945 +[#947]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/947 +[#948]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/948 +[#949]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/949 +[#951]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/951 +[#955]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/955 +[#956]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/956 + +## [3.12.1] - 2025-04-04 + +### Added +- Documentation for the following sniffs: + - Squiz.Commenting.BlockComment + - Thanks to [Colin Stewart][@costdev] for the patch. + +### Changed +- Generic.WhiteSpace.HereNowdocIdentifierSpacing: improved error message text. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Deprecated +- The `Generic.Functions.CallTimePassByReference` sniff. See [#921]. + - This sniff will be removed in version 4.0.0. + +### Fixed +- Fixed bug [#906] : Fixer: prevent `InvalidArgumentException`s when displaying verbose information. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#907] : Tokenizer/PHP: tokenization of tokens related to union, intersection and DNF types in combination with PHP 8.4 final properties. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#908] : Tokenizer/PHP: tokenization of `?` in nullable types for readonly properties. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#916] : Tokenizer/PHP: `goto` was not recognized as a terminating statement for a case/default in a switch control structure. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +### Other +- PHP_CodeSniffer 4.0 is coming soon! Interested in a sneak peek ? Join the live stream at any time on April 14, 15, 17 or 18. + Read the open invitation ([#924]) for all the details. + +[#906]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/906 +[#907]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/907 +[#908]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/908 +[#916]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/916 +[#921]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/921 +[#924]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/924 + +## [3.12.0] - 2025-03-18 + +### Added +- Added support for PHP 8.4 `final` properties to File::getMemberProperties() through a new `is_final` array index in the return value. [#834] + - Thanks to [Daniel Scherzer][@DanielEScherzer] for the patch. +- Generators/HTML: each section title now has a unique anchor link, which can be copied when hovering over a title. [#859] + - This should make sharing a link to a specific section of the documentation more straight-forward. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Documentation for the following sniffs: + - Squiz.Classes.ClassFileName + - Squiz.Classes.ValidClassName + - Thanks to [Brian Dunne][@braindawg] for the patches. + +### Changed +- PHPCBF: the messaging when no fixable errors are found will now distinguish between "No violations" (at all) versus "No fixable errors". [#806] + - Thanks to [Peter Wilson][@peterwilsoncc] for the patch. +- The `-h` (Help) option now contains a more extensive list of "config" options which can be set. [#809] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Improved error message when invalid sniff codes are supplied to `--sniffs` or `--exclude` command line arguments. [#344] + - Thanks to [Dan Wallis][@fredden] for the patch. +- Improved error message when an invalid generator name is supplied to the `--generator` command line argument. [#709], [#771] + - The generator name will now also always be handled case-insensitively, independently of the OS used. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- The user will be shown an informative error message for sniffs missing one of the required methods. [#873] + - Previously this would result in a fatal error. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Ruleset processing will now be allowed to run to its conclusion - barring critical errors - before displaying all ruleset errors in one go. [#857] + - Previously an error in a ruleset would cause PHPCS to exit immediately and show only one error at a time. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators: XML documentation files which don't contain any actual documentation will now silently be ignored. [#755] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators: when the `title` attribute is missing, the documentation generation will now fall back to the sniff name as the title. [#820] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators: cleaner output based on the elements of the documentation which are available. [#819], [#821] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators/HTML: improved display of code tables by using semantic HTML. [#854] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Squiz.Classes.ClassFileName: recommend changing the file name instead of changing the class name. [#845] + - This prevents unactionable recommendations due to the file name not translating to a valid PHP symbol name. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Squiz.Functions.FunctionDeclarationArgumentSpacing: incorrect spacing after a comma followed by a promoted property has an improved error message and will now be flagged with the `SpacingBeforePropertyModifier` or `NoSpaceBeforePropertyModifier` error codes. [#792] + - This was previously already flagged, but using either the `SpacingBeforeHint` or `NoSpaceBeforeHint` error code, which was misleading. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Squiz.Functions.FunctionDeclarationArgumentSpacing: the sniff will now also check the spacing after property modifiers for promoted properties in constructor methods. [#792] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Squiz.WhiteSpace.ScopeKeywordSpacing: the sniff will now also check the spacing after the `final` and `abstract` modifier keywords. [#604] + - Thanks to [Klaus Purer][@klausi] for the patch. +- The following sniff(s) have received efficiency improvements: + - Squiz.WhiteSpace.ScopeKeywordSpacing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. +- Incorrectly set inline properties (in test case files) will be silently ignored again. [#884] + - This removes the `Internal.PropertyDoesNotExist` error code. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The AbstractMethodUnitTest class will now flag duplicate test case markers in a test case file. [#773] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Asis Pattisahusiwa][@asispts], [Dan Wallis][@fredden], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Deprecated +All deprecation are slated for removal in PHP_CodeSniffer 4.0. + +- Support for sniffs not implementing the PHPCS `Sniff` interface. See [#694]. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Support for including sniffs which don't comply with the PHPCS naming conventions (by referencing the sniff file directly). See [#689]. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Support for external standards named "Internal". See [#799]. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The following Generator methods are now (soft) deprecated. See [#755]: + - `PHP_CodeSniffer\Generators\Text::printTitle()` in favour of `PHP_CodeSniffer\Generators\Text::getFormattedTitle()` + - `PHP_CodeSniffer\Generators\Text::printTextBlock()` in favour of `PHP_CodeSniffer\Generators\Text::getFormattedTextBlock()` + - `PHP_CodeSniffer\Generators\Text::printCodeComparisonBlock()` in favour of `PHP_CodeSniffer\Generators\Text::getFormattedCodeComparisonBlock()` + - `PHP_CodeSniffer\Generators\Markdown::printHeader()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedHeader()` + - `PHP_CodeSniffer\Generators\Markdown::printFooter()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedFooter()` + - `PHP_CodeSniffer\Generators\Markdown::printTextBlock()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedTextBlock()` + - `PHP_CodeSniffer\Generators\Markdown::printCodeComparisonBlock()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedCodeComparisonBlock()` + - `PHP_CodeSniffer\Generators\HTML::printHeader()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedHeader()` + - `PHP_CodeSniffer\Generators\HTML::printToc()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedToc()` + - `PHP_CodeSniffer\Generators\HTML::printFooter()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedFooter()` + - `PHP_CodeSniffer\Generators\HTML::printTextBlock()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedTextBlock()` + - `PHP_CodeSniffer\Generators\HTML::printCodeComparisonBlock()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedCodeComparisonBlock()` + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +### Fixed +- Fixed bug [#794] : Generators: prevent fatal error when the XML documentation does not comply with the expected format. + - It is recommended to validate XML documentation files against the XSD file: + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#814] : Generic.NamingConventions.ConstructorName: prevent potential fatal errors during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#816] : File::getDeclarationName(): prevent incorrect result for unfinished closures during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#817] : Squiz.Classes.ValidClassName: ignore comments when determining the name to be validated. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#825] : Squiz.Classes.ClassDeclaration: false positives when the next thing after a class was a function with an attribute attached. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#826] : Squiz.WhiteSpace.FunctionSpacing: prevent incorrect some results when attributes are attached to a function. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#827] : PEAR.Functions.FunctionDeclaration: fixer conflict over an unfinished closure during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#828] : Squiz.WhiteSpace.MemberVarSpacing: allow for `readonly` properties. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#832] : Squiz.WhiteSpace.MemberVarSpacing: prevent potential fixer conflict during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#833] : Squiz.PHP.EmbeddedPhp: fixer conflict when a PHP open tag for a multi-line snippet is found on the same line as a single-line embedded PHP snippet. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#833] : Squiz.PHP.EmbeddedPhp: incorrect indent calculation in certain specific situations. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#835] : Generic.PHP.DisallowShortOpenTag: don't act on parse errors. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#838] : Squiz.PHP.EmbeddedPhp: no new line before close tag was incorrectly enforced when a preceding OO construct or function had a trailing comment after the close curly. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#840] : Squiz.WhiteSpace.MemberVarSpacing: more accurate reporting on blank lines in the property "pre-amble" (i.e. docblock, attributes). + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#845] : Squiz.Classes.ClassFileName: don't throw an incorrect error for an unfinished OO declaration during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#865] : Setting an array property to an empty array from an XML ruleset now works correctly. + - Previously, the property value would be set to `[0 => '']`. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#866] : Squiz.WhiteSpace.FunctionOpeningBraceSpace: XML docs were not accessible due to an issue with the file name. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +### Other +- A new [wiki page][wiki-about-standards] is available to clarify the difference between a project ruleset and an external standard. + - This wiki page also contains detailed information about the naming conventions external standards must comply with. +- A new [XMLLint validate][xmllint-validate] action runner is available which can be used in CI to validate rulesets for PHP_CodeSniffer against the XSD. + +[wiki-about-standards]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/About-Standards-for-PHP_CodeSniffer +[xmllint-validate]: https://github.com/marketplace/actions/xmllint-validate + +[#344]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/344 +[#604]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/604 +[#689]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/689 +[#694]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/694 +[#709]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/709 +[#755]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/755 +[#771]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/771 +[#773]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/773 +[#792]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/792 +[#794]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/794 +[#799]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/799 +[#806]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/806 +[#809]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/809 +[#814]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/814 +[#816]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/816 +[#817]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/817 +[#819]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/819 +[#820]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/820 +[#821]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/821 +[#825]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/825 +[#826]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/826 +[#827]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/827 +[#828]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/828 +[#832]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/832 +[#833]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/833 +[#834]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/834 +[#835]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/835 +[#838]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/838 +[#840]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/840 +[#845]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/845 +[#854]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/854 +[#857]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/857 +[#859]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/859 +[#865]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/865 +[#866]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/866 +[#873]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/873 +[#884]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/884 + +## [3.11.3] - 2025-01-23 + +### Changed +- Generic.ControlStructures.InlineControlStructure no longer unnecessarily listens for T_SWITCH tokens. [#595] + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Squiz.Functions.FunctionDeclarationArgumentSpacing: improvements to error message for `SpaceBeforeComma` error. [#783] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The following sniff(s) have received efficiency improvements: + - Squiz.Functions.FunctionDeclarationArgumentSpacing + - Thanks to [Dan Wallis][@fredden] and [Juliette Reinders Folmer][@jrfnl] for the patches. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Michał Bundyra][@michalbundyra], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#620] : Squiz.Functions.FunctionDeclarationArgumentSpacing: newlines after type will now be handled by the fixer. This also prevents a potential fixer conflict. + - Thanks to [Dan Wallis][@fredden] for the patch. +- Fixed bug [#782] : Tokenizer/PHP: prevent an "Undefined array key" notice during live coding for unfinished arrow functions. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: new line after reference token was not flagged nor fixed. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: new line after variadic token was not flagged nor fixed. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: new line before/after the equal sign for default values was not flagged nor fixed when `equalsSpacing` was set to `0`. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: fixer conflict when a new line is found before/after the equal sign for default values and `equalsSpacing` was set to `1`. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: fixer for spacing before/after equal sign could inadvertently remove comment. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: fixer will now handle comments between the end of a parameter and a comma more cleanly. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#784] : Squiz.WhiteSpace.FunctionSpacing: prevent fixer conflict when a multi-line docblock would start on the same line as the function close curly being examined. + - Thanks to [Klaus Purer][@klausi] for the patch + +[#595]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/595 +[#620]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/620 +[#782]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/782 +[#783]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/783 +[#784]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/784 + +## [3.11.2] - 2024-12-11 + +### Changed +- Generators/HTML + Markdown: the output will now be empty (no page header/footer) when there are no docs to display. [#687] + - This is in line with the Text Generator which already didn't produce output if there are no docs. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators/HTML: only display a Table of Contents when there is more than one sniff with documentation. [#697] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators/HTML: improved handling of line breaks in `` blocks. [#723] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators/Markdown: improved compatibility with the variety of available markdown parsers. [#722] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generators/Markdown: improved handling of line breaks in `` blocks. [#737] + - This prevents additional paragraphs from being displayed as code blocks. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Generic.NamingConventions.UpperCaseConstantName: the exact token containing the non-uppercase constant name will now be identified with more accuracy. [#665] + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Generic.Functions.OpeningFunctionBraceKernighanRitchie: minor improvement to the error message wording. [#736] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#527] : Squiz.Arrays.ArrayDeclaration: short lists within a foreach condition should be ignored. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positives and false negatives when code uses unconventional spacing and comments when calling `define()`. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive when a constant named `DEFINE` is encountered. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive for attribute class called `define`. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive when handling the instantiation of a class named `define`. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#688] : Generators/Markdown could leave error_reporting in an incorrect state. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#698] : Generators/Markdown : link in the documentation footer would not parse as a link. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#738] : Generators/Text: stray blank lines after code sample titles. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#739] : Generators/HTML + Markdown: multi-space whitespace within a code sample title was folded into a single space. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +[#527]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/527 +[#665]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/665 +[#687]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/687 +[#688]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/688 +[#697]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/697 +[#698]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/698 +[#722]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/722 +[#723]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/723 +[#736]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/736 +[#737]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/737 +[#738]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/738 +[#739]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/739 + +## [3.11.1] - 2024-11-16 + +### Changed +- Output from the `--generator=...` feature will respect the OS-expected EOL char in more places. [#671] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Bartosz Dziewoński][@MatmaRex] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#674] : Generic.WhiteSpace.HereNowdocIdentifierSpacing broken XML documentation + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Fixed bug [#675] : InvalidArgumentException when a ruleset includes a sniff by file name and the included sniff does not comply with the PHPCS naming conventions. + - Notwithstanding this fix, it is strongly recommended to ensure custom sniff classes comply with the PHPCS naming conventions. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +[#671]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/671 +[#674]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/674 +[#675]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/675 + +## [3.11.0] - 2024-11-12 + +### Added +- Runtime support for PHP 8.4. All known PHP 8.4 deprecation notices have been fixed. + - Syntax support for new PHP 8.4 features will follow in a future release. + - If you find any PHP 8.4 deprecation notices which were missed, please report them. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. +- Tokenizer support for PHP 8.3 "yield from" expressions with a comment between the keywords. [#529], [#647] + - Sniffs explicitly handling T_YIELD_FROM tokens may need updating. The PR description contains example code for use by sniff developers. + - Additionally, the following sniff has been updated to support "yield from" expressions with comments: + - Generic.WhiteSpace.LanguageConstructSpacing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- New `Generic.WhiteSpace.HereNowdocIdentifierSpacing` sniff. [#586], [#637] + - Forbid whitespace between the `<<<` and the identifier string in heredoc/nowdoc start tokens. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- New `Generic.Strings.UnnecessaryHeredoc` sniff. [#633] + - Warns about heredocs without interpolation or expressions in the body text and can auto-fix these to nowdocs. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Documentation for the following sniffs: + - Generic.Arrays.ArrayIndent + - Squiz.PHP.Heredoc + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for the patches. + +### Changed +- The Common::getSniffCode() method will now throw an InvalidArgumentException exception if an invalid `$sniffClass` is passed. [#524], [#625] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Documentation generated using the `--generator=...` feature will now always be presented in natural order based on the sniff name(s). [#668] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Minor improvements to the display of runtime information. [#658] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Squiz.Commenting.PostStatementComment: trailing annotations in PHP files will now be reported under a separate, non-auto-fixable error code `AnnotationFound`. [#560], [#627] + - This prevents (tooling related) annotations from taking on a different meaning when moved by the fixer. + - The separate error code also allows for selectively excluding it to prevent the sniff from triggering on trailing annotations, while still forbidding other trailing comments. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Squiz.ControlStructures.ForEachLoopDeclaration: the `SpacingAfterOpen` error code has been replaced by the `SpaceAfterOpen` error code. The latter is a pre-existing code. The former appears to have been a typo. [#582] + - Thanks to [Dan Wallis][@fredden] for the patch. +- The following sniff(s) have received efficiency improvements: + - Generic.Classes.DuplicateClassName + - Generic.NamingConventions.ConstructorName + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for the patches. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#3808][sq-3808] : Generic.WhiteSpace.ScopeIndent would throw false positive for tab indented multi-token yield from expression. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#630] : The tokenizer could inadvertently transform "normal" parentheses to DNF parentheses, when a function call was preceded by a switch-case / alternative syntax control structure colon. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#645] : On PHP 5.4, if yield was used as the declaration name for a function declared to return by reference, the function name would incorrectly be tokenized as T_YIELD instead of T_STRING. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#647] : Tokenizer not applying tab replacement in single token "yield from" keywords. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#647] : Generic.WhiteSpace.DisallowSpaceIndent did not flag space indentation in multi-line yield from. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#647] : Generic.WhiteSpace.DisallowTabIndent did not flag tabs inside yield from. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#652] : Generic.NamingConventions.ConstructorName: false positives for PHP-4 style calls to PHP-4 style parent constructor when a method with the same name as the parent class was called on another class. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#652] : Generic.NamingConventions.ConstructorName: false negatives for PHP-4 style calls to parent constructor for function calls with whitespace and comments in unconventional places. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#653] : Generic.Classes.DuplicateClassName : the sniff did not skip namespace keywords used as operators, which could lead to false positives. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#653] : Generic.Classes.DuplicateClassName : sniff going into an infinite loop during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#653] : Generic.Classes.DuplicateClassName : false positives/negatives when a namespace declaration contained whitespace or comments in unconventional places. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#653] : Generic.Classes.DuplicateClassName : namespace for a file going in/out of PHP was not remembered/applied correctly. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-3808]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3808 +[#524]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/524 +[#529]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/529 +[#560]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/560 +[#582]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/582 +[#586]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/586 +[#625]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/625 +[#627]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/627 +[#630]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/630 +[#633]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/633 +[#637]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/637 +[#645]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/645 +[#647]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/647 +[#652]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/652 +[#653]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/653 +[#658]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/658 +[#668]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/668 + +## [3.10.3] - 2024-09-18 + +### Changed +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#553] : Squiz.Classes.SelfMemberReference: false negative(s) when namespace operator was encountered between the namespace declaration and the OO declaration. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#579] : AbstractPatternSniff: potential PHP notice during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#580] : Squiz.Formatting.OperatorBracket: potential PHP notice during live coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#581] : PSR12.ControlStructures.ControlStructureSpacing: prevent fixer conflict by correctly handling multiple empty newlines before the first condition in a multi-line control structure. + - Thanks to [Dan Wallis][@fredden] for the patch. +- Fixed bug [#585] : Tokenizer not applying tab replacement in heredoc/nowdoc openers. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#588] : Squiz.PHP.EmbeddedPhp false positive when checking spaces after a PHP short open tag. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#597] : Generic.PHP.LowerCaseKeyword did not flag nor fix non-lowercase anonymous class keywords. + - Thanks to [Marek Štípek][@maryo] for the patch. +- Fixed bug [#598] : Squiz.PHP.DisallowMultipleAssignments: false positive on assignments to variable property on object stored in array. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#608] : Squiz.Functions.MultiLineFunctionDeclaration did not take (parameter) attributes into account when checking for one parameter per line. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Other +- The provenance of PHAR files associated with a release can now be verified via [GitHub Artifact Attestations][ghattest] using the [GitHub CLI tool][ghcli] with the following command: `gh attestation verify [phpcs|phpcbf].phar -o PHPCSStandards`. [#574] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. + +[#553]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/553 +[#574]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/574 +[#579]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/579 +[#580]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/580 +[#581]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/581 +[#585]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/585 +[#588]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/588 +[#597]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/597 +[#598]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/598 +[#608]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/608 + +[ghcli]: https://cli.github.com/ +[ghattest]: https://docs.github.com/en/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations + +## [3.10.2] - 2024-07-22 + +### Changed +- The following sniff(s) have received efficiency improvements: + - Generic.Functions.FunctionCallArgumentSpacing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The array format of the information passed to the `Reports::generateFileReport()` method is now documented in the Reports interface. [#523] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Bill Ruddock][@biinari], [Dan Wallis][@fredden], [Klaus Purer][@klausi], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#513] : Generic.Functions.FunctionCallArgumentSpacing did not ignore the body of a match expressions passed as a function argument, which could lead to false positives. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#533] : Generic.WhiteSpace.DisallowTabIndent: tab indentation for heredoc/nowdoc closers will no longer be auto-fixed to prevent parse errors. The issue will still be reported. + - The error code for heredoc/nowdoc indentation using tabs has been made more specific - `TabsUsedHeredocCloser` - to allow for selectively excluding the indentation check for heredoc/nowdoc closers. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#534] : Generic.WhiteSpace.DisallowSpaceIndent did not report on space indentation for PHP 7.3 flexible heredoc/nowdoc closers. + - Closers using space indentation will be reported with a dedicated error code: `SpacesUsedHeredocCloser`. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#537] : Squiz.PHP.DisallowMultipleAssignments false positive for list assignments at the start of a new PHP block after an embedded PHP statement. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#551] : Squiz.PHP.DisallowMultipleAssignments prevent false positive for function parameters during live coding. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#554] : Generic.CodeAnalysis.UselessOverridingMethod edge case false negative when the call to the parent method would end on a PHP close tag. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#555] : Squiz.Classes.SelfMemberReference edge case false negative when the namespace declaration would end on a PHP close tag. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[#513]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/513 +[#523]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/523 +[#533]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/533 +[#534]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/534 +[#537]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/537 +[#551]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/551 +[#554]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/554 +[#555]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/555 + +## [3.10.1] - 2024-05-22 + +### Added +- Documentation for the following sniffs: + - Generic.Commenting.DocComment + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. + +### Changed +- The following have received efficiency improvements: + - Type handling in the PHP Tokenizer + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#110], [#437], [#475] : `File::findStartOfStatement()`: the start of statement/expression determination for tokens in parentheses/short array brackets/others scopes, nested within match expressions, was incorrect in most cases. + The trickle down effect of the bug fixes made to the `File::findStartOfStatement()` method, is that the Generic.WhiteSpace.ScopeIndent and the PEAR.WhiteSpace.ScopeIndent sniffs should now be able to correctly determine and fix the indent for match expressions containing nested expressions. + These fixes also fix an issue with the `Squiz.Arrays.ArrayDeclaration` sniff and possibly other, unreported bugs. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#504] : The tokenizer could inadvertently mistake the last parameter in a function call using named arguments for a DNF type. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#508] : Tokenizer/PHP: extra hardening against handling parse errors in the type handling layer. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[#110]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/110 +[#437]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/437 +[#475]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/475 +[#504]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/504 +[#508]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/508 + +## [3.10.0] - 2024-05-20 + +### Added +- Tokenizer support for PHP 8.2 Disjunctive Normal Form (DNF) types. [#3731][sq-3731], [#387], [#461] + - Includes new `T_TYPE_OPEN_PARENTHESIS` and `T_TYPE_CLOSE_PARENTHESIS` tokens to represent the parentheses in DNF types. + - These new tokens, like other parentheses, will have the `parenthesis_opener` and `parenthesis_closer` token array indexes set and the tokens between them will have the `nested_parenthesis` index. + - The `File::getMethodProperties()`, `File::getMethodParameters()` and `File::getMemberProperties()` methods now all support DNF types. [#471], [#472], [#473] + - Additionally, the following sniff has been updated to support DNF types: + - Generic.PHP.LowerCaseType [#478] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. +- Documentation for the following sniffs: + - Squiz.WhiteSpace.FunctionClosingBraceSpace + - Thanks to [Przemek Hernik][@przemekhernik] for the patch. + +### Changed +- The help screens have received a face-lift for improved usability and readability. [#447] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch and thanks to [Colin Stewart][@costdev], [Gary Jones][@GaryJones] and [@mbomb007] for reviewing. +- The Squiz.Commenting.ClosingDeclarationComment sniff will now also examine and flag closing comments for traits. [#442] + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- The following sniff(s) have efficiency improvements: + - Generic.Arrays.ArrayIndent + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- The autoloader will now always return a boolean value indicating whether it has loaded a class or not. [#479] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Dan Wallis][@fredden], [Danny van der Sluijs][@DannyvdSluijs], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#466] : Generic.Functions.CallTimePassByReference was not flagging call-time pass-by-reference in class instantiations using the self/parent/static keywords. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#494] : edge case bug in tokenization of an empty block comment. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#494] : edge case bug in tokenization of an empty single-line DocBlock. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#499] : Generic.ControlStructures.InlineControlStructure now handles statements with a comment between `else` and `if` correctly. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. + +[sq-3731]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3731 +[#387]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/387 +[#442]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/442 +[#447]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/447 +[#461]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/461 +[#466]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/466 +[#471]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/471 +[#472]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/472 +[#473]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/473 +[#478]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/478 +[#479]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/479 +[#494]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/494 +[#499]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/499 + +## [3.9.2] - 2024-04-24 + +### Changed +- The Generic.ControlStructures.DisallowYodaConditions sniff no longer listens for the null coalesce operator. [#458] + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Dan Wallis][@fredden], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#381] : Squiz.Commenting.ClosingDeclarationComment could throw the wrong error when the close brace being examined is at the very end of a file. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#385] : Generic.CodeAnalysis.JumbledIncrementer improved handling of parse errors/live coding. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#394] : Generic.Functions.CallTimePassByReference was not flagging call-time pass-by-reference in anonymous class instantiations + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#420] : PEAR.Functions.FunctionDeclaration could run into a blocking PHP notice while fixing code containing a parse error. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#421] : File::getMethodProperties() small performance improvement & more defensive coding. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#423] : PEAR.WhiteSpace.ScopeClosingBrace would have a fixer conflict with itself when a close tag was preceded by non-empty inline HTML. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#424] : PSR2.Classes.ClassDeclaration using namespace relative interface names in the extends/implements part of a class declaration would lead to a fixer conflict. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#427] : Squiz.Operators.OperatorSpacing would have a fixer conflict with itself when an operator was preceeded by a new line and the previous line ended in a comment. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#430] : Squiz.ControlStructures.ForLoopDeclaration: fixed potential undefined array index notice + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#431] : PSR2.Classes.ClassDeclaration will no longer try to auto-fix multi-line interface implements statements if these are interlaced with comments on their own line. This prevents a potential fixer conflict. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#453] : Arrow function tokenization was broken when the return type was a stand-alone `true` or `false`; or contained `true` or `false` as part of a union type. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Other +- [ESLint 9.0] has been released and changes the supported configuration file format. + The (deprecated) `Generic.Debug.ESLint` sniff only supports the "old" configuration file formats and when using the sniff to run ESLint, the `ESLINT_USE_FLAT_CONFIG=false` environment variable will need to be set when using ESLint >= 9.0. + For more information, see [#436]. + + +[ESLint 9.0]: https://eslint.org/blog/2024/04/eslint-v9.0.0-released/#flat-config-is-now-the-default-and-has-some-changes + +[#381]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/381 +[#385]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/385 +[#394]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/394 +[#420]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/420 +[#421]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/421 +[#423]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/423 +[#424]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/424 +[#427]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/427 +[#430]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/430 +[#431]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/431 +[#436]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/436 +[#453]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/453 +[#458]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/458 + +## [3.9.1] - 2024-03-31 + +### Added +- Documentation for the following sniffs: + - Generic.PHP.RequireStrictTypes + - Squiz.WhiteSpace.MemberVarSpacing + - Squiz.WhiteSpace.ScopeClosingBrace + - Squiz.WhiteSpace.SuperfluousWhitespace + - Thanks to [Jay McPartland][@jaymcp] and [Rodrigo Primo][@rodrigoprimo] for the patches. + +### Changed +- The following sniffs have received performance related improvements: + - Generic.CodeAnalysis.UselessOverridingMethod + - Generic.Files.ByteOrderMark + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patches. +- Performance improvement for the "Diff" report. Should be most notable for Windows users. [#355] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- The test suite has received some performance improvements. Should be most notable contributors using Windows. [#351] + - External standards with sniff tests using the PHP_CodeSniffer native test framework will also benefit from these changes. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. +- Various housekeeping, including improvements to the tests and documentation. + - Thanks to [Jay McPartland][@jaymcp], [João Pedro Oliveira][@jpoliveira08], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. + +### Fixed +- Fixed bug [#289] : Squiz.WhiteSpace.OperatorSpacing and PSR12.Operators.OperatorSpacing : improved fixer conflict protection by more strenuously avoiding handling operators in declare statements. + - Thanks to [Dan Wallis][@fredden] for the patch. +- Fixed bug [#366] : Generic.CodeAnalysis.UselessOverridingMethod : prevent false negative when the declared method name and the called method name do not use the same case. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. +- Fixed bug [#368] : Squiz.Arrays.ArrayDeclaration fixer did not handle static closures correctly when moving array items to their own line. + - Thanks to [Michał Bundyra][@michalbundyra] for the patch. +- Fixed bug [#404] : Test framework : fixed PHP 8.4 deprecation notice. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[#289]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/289 +[#351]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/351 +[#355]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/355 +[#366]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/366 +[#368]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/368 +[#404]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/404 + +## [3.9.0] - 2024-02-16 + +### Added +- Tokenizer support for PHP 8.3 typed class constants. [#321] + - Additionally, the following sniffs have been updated to support typed class constants: + - Generic.NamingConventions.UpperCaseConstantName [#332] + - Generic.PHP.LowerCaseConstant [#330] + - Generic.PHP.LowerCaseType [#331] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches +- Tokenizer support for PHP 8.3 readonly anonymous classes. [#309] + - Additionally, the following sniffs have been updated to support readonly anonymous classes: + - PSR12.Classes.ClassInstantiation [#324] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches +- New `PHP_CodeSniffer\Sniffs\DeprecatedSniff` interface to allow for marking a sniff as deprecated. [#281] + - If a ruleset uses deprecated sniffs, deprecation notices will be shown to the end-user before the scan starts. + When running in `-q` (quiet) mode, the deprecation notices will be hidden. + - Deprecated sniffs will still run and using them will have no impact on the exit code for a scan. + - In ruleset "explain"-mode (`-e`) an asterix `*` will show next to deprecated sniffs. + - Sniff maintainers are advised to read through the PR description for full details on how to use this feature for their own (deprecated) sniffs. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- New `Generic.CodeAnalysis.RequireExplicitBooleanOperatorPrecedence` sniff. [#197] + - Forbid mixing different binary boolean operators within a single expression without making precedence clear using parentheses + - Thanks to [Tim Düsterhus][@TimWolla] for the contribution +- Squiz.PHP.EmbeddedPhp : the sniff will now also examine the formatting of embedded PHP statements using short open echo tags. [#27] + - Includes a new `ShortOpenEchoNoSemicolon` errorcode to allow for selectively ignoring missing semicolons in single line embedded PHP snippets within short open echo tags. + - The other error codes are the same and do not distinguish between what type of open tag was used. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Documentation for the following sniffs: + - Generic.WhiteSpace.IncrementDecrementSpacing + - PSR12.ControlStructures.ControlStructureSpacing + - PSR12.Files.ImportStatement + - PSR12.Functions.ReturnTypeDeclaration + - PSR12.Properties.ConstantVisibility + - Thanks to [Denis Žoljom][@dingo-d] and [Rodrigo Primo][@rodrigoprimo] for the patches + +### Changed +- The Performance report can now also be used for a `phpcbf` run. [#308] + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Sniff tests which extend the PHPCS native `AbstractSniffUnitTest` class will now show a (non-build-breaking) warning when test case files contain fixable errors/warnings, but there is no corresponding `.fixed` file available in the test suite to verify the fixes against. [#336] + - The warning is only displayed on PHPUnit 7.3.0 and higher. + - The warning will be elevated to a test failure in PHPCS 4.0. + - Thanks to [Dan Wallis][@fredden] for the patch +- The following sniffs have received performance related improvements: + - Squiz.PHP.EmbeddedPhp + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Various housekeeping, including improvements to the tests and documentation + - Thanks to [Dan Wallis][@fredden], [Joachim Noreiko][@joachim-n], [Remi Collet][@remicollet], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions + +### Deprecated +- Support for scanning JavaScript and CSS files. See [#2448][sq-2448]. + - This also means that all sniffs which are only aimed at JavaScript or CSS files are now deprecated. + - The Javascript and CSS Tokenizers, all Javascript and CSS specific sniffs, and support for JS and CSS in select sniffs which support multiple file types, will be removed in version 4.0.0. +- The abstract `PHP_CodeSniffer\Filters\ExactMatch::getBlacklist()` and `PHP_CodeSniffer\Filters\ExactMatch::getWhitelist()` methods are deprecated and will be removed in the 4.0 release. See [#198]. + - In version 4.0, these methods will be replaced with abstract `ExactMatch::getDisallowedFiles()` and `ExactMatch::getAllowedFiles()` methods + - To make Filters extending `ExactMatch` cross-version compatible with both PHP_CodeSniffer 3.9.0+ as well as 4.0+, implement the new `getDisallowedFiles()` and `getAllowedFiles()` methods. + - When both the `getDisallowedFiles()` and `getAllowedFiles()` methods as well as the `getBlacklist()` and `getWhitelist()` are available, the new methods will take precedence over the old methods. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The MySource standard and all sniffs in it. See [#2471][sq-2471]. + - The MySource standard and all sniffs in it will be removed in version 4.0.0. +- The `Zend.Debug.CodeAnalyzer` sniff. See [#277]. + - This sniff will be removed in version 4.0.0. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed bug [#127] : Squiz.Commenting.FunctionComment : The `MissingParamType` error code will now be used instead of `MissingParamName` when a parameter name is provided, but not its type. Additionally, invalid type hint suggestions will no longer be provided in these cases. + - Thanks to [Dan Wallis][@fredden] for the patch +- Fixed bug [#196] : Squiz.PHP.EmbeddedPhp : fixer will no longer leave behind trailing whitespace when moving code to another line. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#196] : Squiz.PHP.EmbeddedPhp : will now determine the needed indent with higher precision in multiple situations. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#196] : Squiz.PHP.EmbeddedPhp : fixer will no longer insert a stray new line when the closer of a multi-line embedded PHP block and the opener of the next multi-line embedded PHP block would be on the same line. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#235] : Generic.CodeAnalysis.ForLoopWithTestFunctionCall : prevent a potential PHP 8.3 deprecation notice during live coding + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch +- Fixed bug [#288] : Generic.WhiteSpace.IncrementDecrementSpacing : error message for post-in/decrement will now correctly inform about new lines found before the operator. + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch +- Fixed bug [#296] : Generic.WhiteSpace.ArbitraryParenthesesSpacing : false positive for non-arbitrary parentheses when these follow the scope closer of a `switch` `case`. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#307] : PSR2.Classes.ClassDeclaration : space between a modifier keyword and the `class` keyword was not checked when the space included a new line or comment. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#325] : Squiz.Operators.IncrementDecrementUsage : the sniff was underreporting when there was (no) whitespace and/or comments in unexpected places. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#335] : PSR12.Files.DeclareStatement : bow out in a certain parse error situation to prevent incorrect auto-fixes from being made. + - Thanks to [Dan Wallis][@fredden] for the patch +- Fixed bug [#340] : Squiz.Commenting.ClosingDeclarationComment : no longer adds a stray newline when adding a missing comment. + - Thanks to [Dan Wallis][@fredden] for the patch + +### Other +- A "Community cc list" has been introduced to ping maintainers of external standards and integrators for input regarding change proposals for PHP_CodeSniffer which may impact them. [#227] + - For anyone who missed the discussion about this and is interested to be on this list, please feel invited to submit a PR to add yourself. + The list is located in the `.github` folder. + +[sq-2448]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2448 +[sq-2471]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2471 +[#27]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/27 +[#127]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/127 +[#196]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/196 +[#197]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/197 +[#198]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/198 +[#227]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/227 +[#235]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/235 +[#277]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/277 +[#281]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/281 +[#288]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/288 +[#296]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/296 +[#307]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/307 +[#308]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/308 +[#309]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/309 +[#321]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/321 +[#324]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/324 +[#325]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/325 +[#330]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/330 +[#331]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/331 +[#332]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/332 +[#335]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/335 +[#336]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/336 +[#340]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/340 + +## [3.8.1] - 2024-01-11 + +### Added +- Documentation has been added for the following sniffs: + - Generic.CodeAnalysis.EmptyPHPStatement + - Generic.Formatting.SpaceBeforeCast + - Generic.PHP.Syntax + - Generic.WhiteSpace.LanguageConstructSpacing + - PSR12.Classes.ClosingBrace + - PSR12.Classes.OpeningBraceSpace + - PSR12.ControlStructures.BooleanOperatorPlacement + - PSR12.Files.OpenTag + - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Denis Žoljom][@dingo-d] for the patches + +### Changed +- GitHub releases will now always only contain unversioned release assets (PHARS + asc files) (same as it previously was in the squizlabs repo). See [#205] for context. + - Thanks to [Shivam Mathur][@shivammathur] for opening a discussion about this +- Various housekeeping, includes improvements to the tests and documentation + - Thanks to [Dan Wallis][@fredden], [Lucas Hoffmann][@lucc], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions + +### Fixed +- Fixed bug [#124] : Report Full : avoid unnecessarily wrapping lines when `-s` is used + - Thanks to [Brad Jorsch][@anomiex] for the patch +- Fixed bug [#124] : Report Full : fix incorrect bolding of pipes when `-s` is used and messages wraps + - Thanks to [Brad Jorsch][@anomiex] for the patch +- Fixed bug [#150] : Squiz.WhiteSpace.KeywordSpacing : prevent a PHP notice when run during live coding + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#154] : Report Full : delimiter line calculation could go wonky on wide screens when a report contains multi-line messages + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#178] : Squiz.Commenting.VariableComment : docblocks were incorrectly being flagged as missing when a property declaration used PHP native union/intersection type declarations + - Thanks to [Ferdinand Kuhl][@fcool] for the patch +- Fixed bug [#211] : Squiz.Commenting.VariableComment : docblocks were incorrectly being flagged as missing when a property declaration used PHP 8.2+ stand-alone `true`/`false`/`null` type declarations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#211] : Squiz.Commenting.VariableComment : docblocks were incorrectly being flagged as missing when a property declaration used PHP native `parent`, `self` or a namespace relative class name type declaration + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#226] : Generic.CodeAnalysis.ForLoopShouldBeWhileLoop : prevent a potential PHP 8.3 deprecation notice during live coding + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch + +[#124]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/124 +[#150]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/150 +[#154]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/154 +[#178]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/178 +[#205]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/205 +[#211]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/211 +[#226]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/226 + +## [3.8.0] - 2023-12-08 + +[Squizlabs/PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) is dead. Long live [PHPCSStandards/PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer)! + +### Breaking Changes +- The `squizlabs/PHP_CodeSniffer` repository has been abandoned. The `PHPCSStandards/PHP_CodeSniffer` repository will serve as the continuation of the project. For more information about this change, please read the [announcement](https://github.com/squizlabs/PHP_CodeSniffer/issues/3932). + - Installation of PHP_CodeSniffer via PEAR is no longer supported. + - Users will need to switch to another installation method. + - Note: this does not affect the PEAR sniffs. + - For Composer users, nothing changes. + - **_In contrast to earlier information, the `squizlabs/php_codesniffer` package now points to the new repository and everything will continue to work as before._** + - PHIVE users may need to clear the PHIVE URL cache. + - PHIVE users who don't use the package alias, but refer to the package URL, will need to update the URL from `https://squizlabs.github.io/PHP_CodeSniffer/phars/` to `https://phars.phpcodesniffer.com/phars/`. + - Users who download the PHAR files using curl or wget, will need to update the download URL from `https://squizlabs.github.io/PHP_CodeSniffer/[phpcs|phpcbf].phar` or `https://github.com/squizlabs/PHP_CodeSniffer/releases/latest/download/[phpcs|phpcbf].phar` to `https://phars.phpcodesniffer.com/[phpcs|phpcbf].phar`. + - For users who install PHP_CodeSniffer via the [Setup-PHP](https://github.com/shivammathur/setup-php/) action runner for GitHub Actions, nothing changes. + - Users using a git clone will need to update the clone address from `git@github.com:squizlabs/PHP_CodeSniffer.git` to `git@github.com:PHPCSStandards/PHP_CodeSniffer.git`. + - Contributors will need to fork the new repo and add both the new fork as well as the new repo as remotes to their local git copy of PHP_CodeSniffer. + - Users who have (valid) open issues or pull requests in the `squizlabs/PHP_CodeSniffer` repository are invited to resubmit these to the `PHPCSStandards/PHP_CodeSniffer` repository. + +### Added +- Runtime support for PHP 8.3. All known PHP 8.3 deprecation notices have been fixed + - Syntax support for new PHP 8.3 features will follow in a future release + - If you find any PHP 8.3 deprecation notices which were missed, please report them + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches +- Added support for PHP 8.2 readonly classes to File::getClassProperties() through a new is_readonly array index in the return value + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for PHP 8.2 readonly classes to a number of sniffs + - Generic.CodeAnalysis.UnnecessaryFinalModifier + - PEAR.Commenting.ClassComment + - PEAR.Commenting.FileComment + - PSR1.Files.SideEffects + - PSR2.Classes.ClassDeclaration + - PSR12.Files.FileHeader + - Squiz.Classes.ClassDeclaration + - Squiz.Classes.LowercaseClassKeywords + - Squiz.Commenting.ClassComment + - Squiz.Commenting.DocCommentAlignment + - Squiz.Commenting.FileComment + - Squiz.Commenting.InlineComment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for PHP 8.2 `true` as a stand-alone type declaration + - The `File::getMethodProperties()`, `File::getMethodParameters()` and `File::getMemberProperties()` methods now all support the `true` type + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for PHP 8.2 `true` as a stand-alone type to a number of sniffs + - Generic.PHP.LowerCaseType + - PSr12.Functions.NullableTypeDeclaration + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added a Performance report to allow for finding "slow" sniffs + - To run this report, run PHPCS with --report=Performance. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.PHP.RequireStrictTypes : new warning for when there is a declare statement, but the strict_types directive is set to 0 + - The warning can be turned off by excluding the `Generic.PHP.RequireStrictTypes.Disabled` error code + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.FunctionComment : new `ParamNameUnexpectedAmpersandPrefix` error for parameters annotated as passed by reference while the parameter is not passed by reference + - Thanks to [Dan Wallis][@fredden] for the patch +- Documentation has been added for the following sniffs: + - PSR2.Files.ClosingTag + - PSR2.Methods.FunctionCallSignature + - PSR2.Methods.FunctionClosingBrace + - Thanks to [Atsushi Okui][@blue32a] for the patch +- Support for PHPUnit 8 and 9 to the test suite + - Test suites for external standards which run via the PHPCS native test suite can now run on PHPUnit 4-9 (was 4-7) + - If any of these tests use the PHPUnit `setUp()`/`tearDown()` methods or overload the `setUp()` in the `AbstractSniffUnitTest` test case, they will need to be adjusted. See the [PR details for further information](https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/59/commits/bc302dd977877a22c5e60d42a2f6b7d9e9192dab) + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Changed +- Changes have been made to the way PHPCS handles invalid sniff properties being set in a custom ruleset + - Fixes PHP 8.2 deprecation notices for properties set in a (custom) ruleset for complete standards/complete sniff categories + - Invalid sniff properties set for individual sniffs will now result in an error and halt the execution of PHPCS + - A descriptive error message is provided to allow users to fix their ruleset + - Sniff properties set for complete standards/complete sniff categories will now only be set on sniffs which explicitly support the property + - The property will be silently ignored for those sniffs which do not support the property + - Invalid sniff properties set for sniffs via inline annotations will result in an informative `Internal.PropertyDoesNotExist` errror on line 1 of the scanned file, but will not halt the execution of PHPCS + - For sniff developers, it is strongly recommended for sniffs to explicitly declare any user-adjustable public properties + - If dynamic properties need to be supported for a sniff, either declare the magic __set()/__get()/__isset()/__unset() methods on the sniff or let the sniff extend stdClass + - Note: The `#[\AllowDynamicProperties]` attribute will have no effect for properties which are being set in rulesets + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The third parameter for the Ruleset::setSniffProperty() method has been changed to expect an array + - Sniff developers/integrators of PHPCS may need to make some small adjustments to allow for this change + - Existing code will continue to work but will throw a deprecation error + - The backwards compatiblity layer will be removed in PHPCS 4.0 + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- When using `auto` report width (the default) a value of 80 columns will be used if the width cannot be determined + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Sniff error messages are now more informative to help bugs get reported to the correct project + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.CodeAnalysis.UnusedFunctionParameter will now ignore magic methods for which the signature is defined by PHP + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Functions.OpeningFunctionBraceBsdAllman will now check the brace indent before the opening brace for empty functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Functions.OpeningFunctionBraceKernighanRitchie will now check the spacing before the opening brace for empty functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.WhiteSpace.IncrementDecrementSpacing now detects more spacing issues + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PSR2.Classes.PropertyDeclaration now enforces that the readonly modifier comes after the visibility modifier + - PSR2 and PSR12 do not have documented rules for this as they pre-date the readonly modifier + - PSR-PER has been used to confirm the order of this keyword so it can be applied to PSR2 and PSR12 correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PEAR.Commenting.FunctionComment + Squiz.Commenting.FunctionComment: the SpacingAfter error can now be auto-fixed + - Thanks to [Dan Wallis][@fredden] for the patch +- Squiz.PHP.InnerFunctions sniff no longer reports on OO methods for OO structures declared within a function or closure + - Thanks to [@Daimona] for the patch +- Squiz.PHP.NonExecutableCode will now also flag redundant return statements just before a closure close brace + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Runtime performance improvement for PHPCS CLI users. The improvement should be most noticeable for users on Windows. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The following sniffs have received performance related improvements: + - Generic.PHP.LowerCaseConstant + - Generic.PHP.LowerCaseType + - PSR12.Files.OpenTag + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches +- The -e (explain) command will now list sniffs in natural order + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Tests using the PHPCS native test framework with multiple test case files will now run the test case files in numeric order. + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The following sniffs have received minor message readability improvements: + - Generic.Arrays.ArrayIndent + - Generic.Formatting.SpaceAfterCast + - Generic.Formatting.SpaceAfterNot + - Generic.WhiteSpace.SpreadOperatorSpacingAfter + - Squiz.Arrays.ArrayDeclaration + - Squiz.Commenting.DocCommentAlignment + - Squiz.ControlStructures.ControlSignature + - Thanks to [Danny van der Sluijs][@DannyvdSluijs] and [Juliette Reinders Folmer][@jrfnl] for the patches +- Improved README syntax highlighting + - Thanks to [Benjamin Loison][@Benjamin-Loison] for the patch +- Various documentation improvements + - Thanks to [Andrew Dawes][@AndrewDawes], [Danny van der Sluijs][@DannyvdSluijs] and [Juliette Reinders Folmer][@jrfnl] for the patches + +### Removed +- Removed support for installation via PEAR + - Use composer or the PHAR files instead + +### Fixed +- Fixed bug [#2857][sq-2857] : Squiz/NonExecutableCode: prevent false positives when exit is used in a ternary expression or as default with null coalesce + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3386][sq-3386] : PSR1/SideEffects : improved recognition of disable/enable annotations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3557][sq-3557] : Squiz.Arrays.ArrayDeclaration will now ignore PHP 7.4 array unpacking when determining whether an array is associative + - Thanks to [Volker Dusch][@edorian] for the patch +- Fixed bug [#3592][sq-3592] : Squiz/NonExecutableCode: prevent false positives when a PHP 8.0+ inline throw expression is encountered + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3715][sq-3715] : Generic/UnusedFunctionParameter: fixed incorrect errorcode for closures/arrow functions nested within extended classes/classes which implement + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3717][sq-3717] : Squiz.Commenting.FunctionComment: fixed false positive for `InvalidNoReturn` when type is never + - Thanks to [Choraimy Kroonstuiver][@axlon] for the patch +- Fixed bug [#3720][sq-3720] : Generic/RequireStrictTypes : will now bow out silently in case of parse errors/live coding instead of throwing false positives/false negatives + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3720][sq-3720] : Generic/RequireStrictTypes : did not handle multi-directive declare statements + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3722][sq-3722] : Potential "Uninitialized string offset 1" in octal notation backfill + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3736][sq-3736] : PEAR/FunctionDeclaration: prevent fixer removing the close brace (and creating a parse error) when there is no space between the open brace and close brace of a function + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3739][sq-3739] : PEAR/FunctionDeclaration: prevent fixer conflict, and potentially creating a parse error, for unconventionally formatted return types + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3770][sq-3770] : Squiz/NonExecutableCode: prevent false positives for switching between PHP and HTML + - Thanks to [Dan Wallis][@fredden] for the patch +- Fixed bug [#3773][sq-3773] : Tokenizer/PHP: tokenization of the readonly keyword when used in combination with PHP 8.2 disjunctive normal types + - Thanks to [Dan Wallis][@fredden] and [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3776][sq-3776] : Generic/JSHint: error when JSHint is not available + - Thanks to [Dan Wallis][@fredden] for the patch +- Fixed bug [#3777][sq-3777] : Squiz/NonExecutableCode: slew of bug fixes, mostly related to modern PHP + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3778][sq-3778] : Squiz/LowercasePHPFunctions: bug fix for class names in attributes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3779][sq-3779] : Generic/ForbiddenFunctions: bug fix for class names in attributes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3785][sq-3785] : Squiz.Commenting.FunctionComment: potential "Uninitialized string offset 0" when a type contains a duplicate pipe symbol + - Thanks to [Dan Wallis][@fredden] for the patch +- Fixed bug [#3787][sq-3787] : `PEAR/Squiz/[MultiLine]FunctionDeclaration`: allow for PHP 8.1 new in initializers + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3789][sq-3789] : Incorrect tokenization for ternary operator with `match` inside of it + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3790][sq-3790] : PSR12/AnonClassDeclaration: prevent fixer creating parse error when there was no space before the open brace + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3797][sq-3797] : Tokenizer/PHP: more context sensitive keyword fixes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3801][sq-3801] : File::getMethodParameters(): allow for readonly promoted properties without visibility + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3805][sq-3805] : Generic/FunctionCallArgumentSpacing: prevent fixer conflict over PHP 7.3+ trailing comma's in function calls + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3806][sq-3806] : Squiz.PHP.InnerFunctions sniff now correctly reports inner functions declared within a closure + - Thanks to [@Daimona] for the patch +- Fixed bug [#3809][sq-3809] : GitBlame report was broken when passing a basepath + - Thanks to [Chris][@datengraben] for the patch +- Fixed bug [#3813][sq-3813] : Squiz.Commenting.FunctionComment: false positive for parameter name mismatch on parameters annotated as passed by reference + - Thanks to [Dan Wallis][@fredden] for the patch +- Fixed bug [#3833][sq-3833] : Generic.PHP.LowerCaseType: fixed potential undefined array index notice + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3846][sq-3846] : PSR2.Classes.ClassDeclaration.CloseBraceAfterBody : fixer will no longer remove indentation on the close brace line + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3854][sq-3854] : Fatal error when using Gitblame report in combination with `--basepath` and running from project subdirectory + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3856][sq-3856] : PSR12.Traits.UseDeclaration was using the wrong error code - SpacingAfterAs - for spacing issues after the `use` keyword + - These will now be reported using the SpacingAfterUse error code + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3856][sq-3856] : PSR12.Traits.UseDeclaration did not check spacing after `use` keyword for multi-line trait use statements + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3867][sq-3867] : Tokenizer/PHP: union type and intersection type operators were not correctly tokenized for static properties without explicit visibility + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3877][sq-3877] : Filter names can be case-sensitive. The -h help text will now display the correct case for the available filters + - Thanks to [@simonsan] for the patch +- Fixed bug [#3893][sq-3893] : Generic/DocComment : the SpacingAfterTagGroup fixer could accidentally remove ignore annotations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3898][sq-3898] : Squiz/NonExecutableCode : the sniff could get confused over comments in unexpected places + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3904][sq-3904] : Squiz/FunctionSpacing : prevent potential fixer conflict + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3906][sq-3906] : Tokenizer/CSS: bug fix related to the unsupported slash comment syntax + - Thanks to [Dan Wallis][@fredden] for the patch +- Fixed bug [#3913][sq-3913] : Config did not always correctly store unknown "long" arguments in the `$unknown` property + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +Thanks go to [Dan Wallis][@fredden] and [Danny van der Sluijs][@DannyvdSluijs] for reviewing quite a few of the PRs for this release. +Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo change over. + +[sq-2857]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2857 +[sq-3386]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3386 +[sq-3557]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3557 +[sq-3592]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3592 +[sq-3715]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3715 +[sq-3717]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3717 +[sq-3720]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3720 +[sq-3722]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3722 +[sq-3736]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3736 +[sq-3739]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3739 +[sq-3770]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3770 +[sq-3773]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3773 +[sq-3776]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3776 +[sq-3777]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3777 +[sq-3778]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3778 +[sq-3779]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3779 +[sq-3785]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3785 +[sq-3787]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3787 +[sq-3789]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3789 +[sq-3790]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3790 +[sq-3797]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3797 +[sq-3801]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3801 +[sq-3805]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3805 +[sq-3806]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3806 +[sq-3809]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3809 +[sq-3813]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3813 +[sq-3833]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3833 +[sq-3846]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3846 +[sq-3854]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3854 +[sq-3856]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3856 +[sq-3867]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3867 +[sq-3877]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3877 +[sq-3893]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3893 +[sq-3898]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3898 +[sq-3904]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3904 +[sq-3906]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3906 +[sq-3913]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3913 + +## [3.7.2] - 2023-02-23 + +### Changed +- Newer versions of Composer will now suggest installing PHPCS using require-dev instead of require + - Thanks to [Gary Jones][@GaryJones] for the patch +- A custom Out Of Memory error will now be shown if PHPCS or PHPCBF run out of memory during a run + - Error message provides actionable information about how to fix the problem and ensures the error is not silent + - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Alain Schlesser][@schlessera] for the patch +- Generic.PHP.LowerCaseType sniff now correctly examines types inside arrow functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Formatting.OperatorBracket no longer reports false positives in match() structures + +### Fixed +- Fixed bug [#3616][sq-3616] : Squiz.PHP.DisallowComparisonAssignment false positive for PHP 8 match expression + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3618][sq-3618] : Generic.WhiteSpace.ArbitraryParenthesesSpacing false positive for return new parent() + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3632][sq-3632] : Short list not tokenized correctly in control structures without braces + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3639][sq-3639] : Tokenizer not applying tab replacement to heredoc/nowdoc closers + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3640][sq-3640] : Generic.WhiteSpace.DisallowTabIndent not reporting errors for PHP 7.3 flexible heredoc/nowdoc syntax + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3645][sq-3645] : PHPCS can show 0 exit code when running in parallel even if child process has fatal error + - Thanks to [Alex Panshin][@enl] for the patch +- Fixed bug [#3653][sq-3653] : False positives for match() in OperatorSpacingSniff + - Thanks to [Jaroslav Hanslík][@kukulich] for the patch +- Fixed bug [#3666][sq-3666] : PEAR.Functions.FunctionCallSignature incorrect indent fix when checking mixed HTML/PHP files +- Fixed bug [#3668][sq-3668] : PSR12.Classes.ClassInstantiation.MissingParentheses false positive when instantiating parent classes + - Similar issues also fixed in Generic.Functions.FunctionCallArgumentSpacing and Squiz.Formatting.OperatorBracket + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3672][sq-3672] : Incorrect ScopeIndent.IncorrectExact report for match inside array literal +- Fixed bug [#3694][sq-3694] : Generic.WhiteSpace.SpreadOperatorSpacingAfter does not ignore spread operator in PHP 8.1 first class callables + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-3616]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3616 +[sq-3618]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3618 +[sq-3632]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3632 +[sq-3639]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3639 +[sq-3640]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3640 +[sq-3645]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3645 +[sq-3653]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3653 +[sq-3666]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3666 +[sq-3668]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3668 +[sq-3672]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3672 +[sq-3694]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3694 + +## [3.7.1] - 2022-06-18 + +### Fixed +- Fixed bug [#3609][sq-3609] : Methods/constants with name empty/isset/unset are always reported as error + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-3609]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3609 + +## [3.7.0] - 2022-06-13 + +### Added +- Added support for PHP 8.1 explicit octal notation + - This new syntax has been backfilled for PHP versions less than 8.1 + - Thanks to [Mark Baker][@MarkBaker] for the patch + - Thanks to [Juliette Reinders Folmer][@jrfnl] for additional fixes +- Added support for PHP 8.1 enums + - This new syntax has been backfilled for PHP versions less than 8.1 + - Includes a new T_ENUM_CASE token to represent the case statements inside an enum + - Thanks to [Jaroslav Hanslík][@kukulich] for the patch + - Thanks to [Juliette Reinders Folmer][@jrfnl] for additional core and sniff support +- Added support for the PHP 8.1 readonly token + - Tokenizing of the readonly keyword has been backfilled for PHP versions less than 8.1 + - Thanks to [Jaroslav Hanslík][@kukulich] for the patch +- Added support for PHP 8.1 intersection types + - Includes a new T_TYPE_INTERSECTION token to represent the ampersand character inside intersection types + - Thanks to [Jaroslav Hanslík][@kukulich] for the patch + +### Changed +- File::getMethodParameters now supports the new PHP 8.1 readonly token + - When constructor property promotion is used, a new property_readonly array index is included in the return value + - This is a boolean value indicating if the property is readonly + - If the readonly token is detected, a new readonly_token array index is included in the return value + - This contains the token index of the readonly keyword + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Support for new PHP 8.1 readonly keyword has been added to the following sniffs: + - Generic.PHP.LowerCaseKeyword + - PSR2.Classes.PropertyDeclaration + - Squiz.Commenting.BlockComment + - Squiz.Commenting.DocCommentAlignment + - Squiz.Commenting.VariableComment + - Squiz.WhiteSpace.ScopeKeywordSpacing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches +- The parallel feature is now more efficient and runs faster in some situations due to improved process management + - Thanks to [Sergei Morozov][@morozov] for the patch +- The list of installed coding standards now has consistent ordering across all platforms + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.PHP.UpperCaseConstant and Generic.PHP.LowerCaseConstant now ignore type declarations + - These sniffs now only report errors for true/false/null when used as values + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.PHP.LowerCaseType now supports the PHP 8.1 never type + - Thanks to [Jaroslav Hanslík][@kukulich] for the patch + +### Fixed +- Fixed bug [#3502][sq-3502] : A match statement within an array produces Squiz.Arrays.ArrayDeclaration.NoKeySpecified +- Fixed bug [#3503][sq-3503] : Squiz.Commenting.FunctionComment.ThrowsNoFullStop false positive when one line @throw +- Fixed bug [#3505][sq-3505] : The nullsafe operator is not counted in Generic.Metrics.CyclomaticComplexity + - Thanks to [Mark Baker][@MarkBaker] for the patch +- Fixed bug [#3526][sq-3526] : PSR12.Properties.ConstantVisibility false positive when using public final const syntax + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3530][sq-3530] : Line indented incorrectly false positive when using match-expression inside switch case +- Fixed bug [#3534][sq-3534] : Name of typed enum tokenized as T_GOTO_LABEL + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3546][sq-3546] : Tokenizer/PHP: bug fix - parent/static keywords in class instantiations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3550][sq-3550] : False positive from PSR2.ControlStructures.SwitchDeclaration.TerminatingComment when using trailing comment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3575][sq-3575] : Squiz.Scope.MethodScope misses visibility keyword on previous line + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3604][sq-3604] : Tokenizer/PHP: bug fix for double quoted strings using ${ + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-3502]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3502 +[sq-3503]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3503 +[sq-3505]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3505 +[sq-3526]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3526 +[sq-3530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3530 +[sq-3534]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3534 +[sq-3546]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3546 +[sq-3550]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3550 +[sq-3575]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3575 +[sq-3604]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3604 + +## [3.6.2] - 2021-12-13 + +### Changed +- Processing large code bases that use tab indenting inside comments and strings will now be faster + - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch + +### Fixed +- Fixed bug [#3388][sq-3388] : phpcs does not work when run from WSL drives + - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Graham Wharton][@gwharton] for the patch +- Fixed bug [#3422][sq-3422] : Squiz.WhiteSpace.ScopeClosingBrace fixer removes HTML content when fixing closing brace alignment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3437][sq-3437] : PSR12 does not forbid blank lines at the start of the class body + - Added new PSR12.Classes.OpeningBraceSpace sniff to enforce this +- Fixed bug [#3440][sq-3440] : Squiz.WhiteSpace.MemberVarSpacing false positives when attributes used without docblock + - Thanks to [Vadim Borodavko][@javer] for the patch +- Fixed bug [#3448][sq-3448] : PHP 8.1 deprecation notice while generating running time value + - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Andy Postnikov][@andypost] for the patch +- Fixed bug [#3456][sq-3456] : PSR12.Classes.ClassInstantiation.MissingParentheses false positive using attributes on anonymous class + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3460][sq-3460] : Generic.Formatting.MultipleStatementAlignment false positive on closure with parameters + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3468][sq-3468] : do/while loops are double-counted in Generic.Metrics.CyclomaticComplexity + - Thanks to [Mark Baker][@MarkBaker] for the patch +- Fixed bug [#3469][sq-3469] : Ternary Operator and Null Coalescing Operator are not counted in Generic.Metrics.CyclomaticComplexity + - Thanks to [Mark Baker][@MarkBaker] for the patch +- Fixed bug [#3472][sq-3472] : PHP 8 match() expression is not counted in Generic.Metrics.CyclomaticComplexity + - Thanks to [Mark Baker][@MarkBaker] for the patch + +[sq-3388]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3388 +[sq-3422]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3422 +[sq-3437]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3437 +[sq-3440]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3440 +[sq-3448]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3448 +[sq-3456]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3456 +[sq-3460]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3460 +[sq-3468]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3468 +[sq-3469]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3469 +[sq-3472]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3472 + +## [3.6.1] - 2021-10-11 + +### Changed +- PHPCS annotations can now be specified using hash-style comments + - Previously, only slash-style and block-style comments could be used to do things like disable errors + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The new PHP 8.1 tokenization for ampersands has been reverted to use the existing PHP_CodeSniffer method + - The PHP 8.1 tokens T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG and T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG are unused + - Ampersands continue to be tokenized as T_BITWISE_AND for all PHP versions + - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Anna Filina][@afilina] for the patch +- File::getMethodParameters() no longer incorrectly returns argument attributes in the type hint array index + - A new has_attributes array index is available and set to TRUE if the argument has attributes defined + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed an issue where some sniffs would not run on PHP files that only used the short echo tag + - The following sniffs were affected: + - Generic.Files.ExecutableFile + - Generic.Files.LowercasedFilename + - Generic.Files.LineEndings + - Generic.Files.EndFileNewline + - Generic.Files.EndFileNoNewline + - Generic.PHP.ClosingPHPTag + - Generic.PHP.Syntax + - Generic.VersionControl.GitMergeConflict + - Generic.WhiteSpace.DisallowSpaceIndent + - Generic.WhiteSpace.DisallowTabIndent + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.BlockComment now correctly applies rules for block comments after a short echo tag + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Generic.NamingConventions.ConstructorName no longer throws deprecation notices on PHP 8.1 + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed false positives when using attributes in the following sniffs: + - PEAR.Commenting.FunctionComment + - Squiz.Commenting.InlineComment + - Squiz.Commenting.BlockComment + - Squiz.Commenting.VariableComment + - Squiz.WhiteSpace.MemberVarSpacing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3294][sq-3294] : Bug in attribute tokenization when content contains PHP end token or attribute closer on new line + - Thanks to [Alessandro Chitolina][@alekitto] for the patch + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the tests +- Fixed bug [#3296][sq-3296] : PSR2.ControlStructures.SwitchDeclaration takes phpcs:ignore as content of case body +- Fixed bug [#3297][sq-3297] : PSR2.ControlStructures.SwitchDeclaration.TerminatingComment does not handle try/finally blocks + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3302][sq-3302] : PHP 8.0 | Tokenizer/PHP: bugfix for union types using namespace operator + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3303][sq-3303] : findStartOfStatement() doesn't work with T_OPEN_TAG_WITH_ECHO +- Fixed bug [#3316][sq-3316] : Arrow function not tokenized correctly when using null in union type +- Fixed bug [#3317][sq-3317] : Problem with how phpcs handles ignored files when running in parallel + - Thanks to [Emil Andersson][@emil-nasso] for the patch +- Fixed bug [#3324][sq-3324] : PHPCS hangs processing some nested arrow functions inside a function call +- Fixed bug [#3326][sq-3326] : Generic.Formatting.MultipleStatementAlignment error with const DEFAULT + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3333][sq-3333] : Squiz.Objects.ObjectInstantiation: null coalesce operators are not recognized as assignment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3340][sq-3340] : Ensure interface and trait names are always tokenized as T_STRING + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3342][sq-3342] : PSR12/Squiz/PEAR standards all error on promoted properties with docblocks + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3345][sq-3345] : IF statement with no braces and double catch turned into syntax error by auto-fixer + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3352][sq-3352] : PSR2.ControlStructures.SwitchDeclaration can remove comments on the same line as the case statement while fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3357][sq-3357] : Generic.Functions.OpeningFunctionBraceBsdAllman removes return type when additional lines are present + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3362][sq-3362] : Generic.WhiteSpace.ScopeIndent false positive for arrow functions inside arrays +- Fixed bug [#3384][sq-3384] : Squiz.Commenting.FileComment.SpacingAfterComment false positive on empty file +- Fixed bug [#3394][sq-3394] : Fix PHP 8.1 auto_detect_line_endings deprecation notice +- Fixed bug [#3400][sq-3400] : PHP 8.1: prevent deprecation notices about missing return types + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3424][sq-3424] : PHPCS fails when using PHP 8 Constructor property promotion with attributes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3425][sq-3425] : PHP 8.1 | Runner::processChildProcs(): fix passing null to non-nullable bug + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3445][sq-3445] : Nullable parameter after attribute incorrectly tokenized as ternary operator + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-3294]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3294 +[sq-3296]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3296 +[sq-3297]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3297 +[sq-3302]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3302 +[sq-3303]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3303 +[sq-3316]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3316 +[sq-3317]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3317 +[sq-3324]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3324 +[sq-3326]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3326 +[sq-3333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3333 +[sq-3340]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3340 +[sq-3342]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3342 +[sq-3345]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3345 +[sq-3352]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3352 +[sq-3357]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3357 +[sq-3362]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3362 +[sq-3384]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3384 +[sq-3394]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3394 +[sq-3400]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3400 +[sq-3424]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3424 +[sq-3425]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3425 +[sq-3445]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3445 + +## [3.6.0] - 2021-04-09 + +### Added +- Added support for PHP 8.0 union types + - A new T_TYPE_UNION token is available to represent the pipe character + - File::getMethodParameters(), getMethodProperties(), and getMemberProperties() will now return union types + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for PHP 8.0 named function call arguments + - A new T_PARAM_NAME token is available to represent the label with the name of the function argument in it + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for PHP 8.0 attributes + - The PHP-supplied T_ATTRIBUTE token marks the start of an attribute + - A new T_ATTRIBUTE_END token is available to mark the end of an attribute + - New attribute_owner and attribute_closer indexes are available in the tokens array for all tokens inside an attribute + - Tokenizing of attributes has been backfilled for older PHP versions + - The following sniffs have been updated to support attributes: + - PEAR.Commenting.ClassComment + - PEAR.Commenting.FileComment + - PSR1.Files.SideEffects + - PSR12.Files.FileHeader + - Squiz.Commenting.ClassComment + - Squiz.Commenting.FileComment + - Squiz.WhiteSpace.FunctionSpacing + - Thanks to [Vadim Borodavko][@javer] for the patch + - Thanks to [Alessandro Chitolina][@alekitto] for the patch +- Added support for PHP 8.0 dereferencing of text strings with interpolated variables + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for PHP 8.0 match expressions + - Match expressions are now tokenized with parenthesis and scope openers and closers + - Sniffs can listen for the T_MATCH token to process match expressions + - Note that the case and default statements inside match expressions do not have scopes set + - A new T_MATCH_ARROW token is available to represent the arrows in match expressions + - A new T_MATCH_DEFAULT token is available to represent the default keyword in match expressions + - All tokenizing of match expressions has been backfilled for older PHP versions + - The following sniffs have been updated to support match expressions: + - Generic.CodeAnalysis.AssignmentInCondition + - Generic.CodeAnalysis.EmptyPHPStatement + - Thanks to [Vadim Borodavko][@javer] for the patch + - Generic.CodeAnalysis.EmptyStatement + - Generic.PHP.LowerCaseKeyword + - PEAR.ControlStructures.ControlSignature + - PSR12.ControlStructures.BooleanOperatorPlacement + - Squiz.Commenting.LongConditionClosingComment + - Squiz.Commenting.PostStatementComment + - Squiz.ControlStructures.LowercaseDeclaration + - Squiz.ControlStructures.ControlSignature + - Squiz.Formatting.OperatorBracket + - Squiz.PHP.DisallowMultipleAssignments + - Squiz.Objects.ObjectInstantiation + - Squiz.WhiteSpace.ControlStructureSpacing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added Generic.NamingConventions.AbstractClassNamePrefix to enforce that class names are prefixed with "Abstract" + - Thanks to [Anna Borzenko][@annechko] for the contribution +- Added Generic.NamingConventions.InterfaceNameSuffix to enforce that interface names are suffixed with "Interface" + - Thanks to [Anna Borzenko][@annechko] for the contribution +- Added Generic.NamingConventions.TraitNameSuffix to enforce that trait names are suffixed with "Trait" + - Thanks to [Anna Borzenko][@annechko] for the contribution + +### Changed +- The value of the T_FN_ARROW token has changed from "T_FN_ARROW" to "PHPCS_T_FN_ARROW" to avoid package conflicts + - This will have no impact on custom sniffs unless they are specifically looking at the value of the T_FN_ARROW constant + - If sniffs are just using constant to find arrow functions, they will continue to work without modification + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- File::findStartOfStatement() now works correctly when passed the last token in a statement +- File::getMethodParameters() now supports PHP 8.0 constructor property promotion + - Returned method params now include a "property_visibility" and "visibility_token" index if property promotion is detected + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- File::getMethodProperties() now includes a "return_type_end_token" index in the return value + - This indicates the last token in the return type, which is helpful when checking union types + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Include patterns are now ignored when processing STDIN + - Previously, checks using include patterns were excluded when processing STDIN when no file path was provided via --stdin-path + - Now, all include and exclude rules are ignored when no file path is provided, allowing all checks to run + - If you want include and exclude rules enforced when checking STDIN, use --stdin-path to set the file path + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Spaces are now correctly escaped in the paths to external on Windows + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.CodeAnalysis.UnusedFunctionParameter can now be configured to ignore variable usage for specific type hints + - This allows you to suppress warnings for some variables that are not required, but leave warnings for others + - Set the ignoreTypeHints array property to a list of type hints to ignore + - Thanks to [Petr Bugyík][@o5] for the patch +- Generic.Formatting.MultipleStatementAlignment can now align statements at the start of the assignment token + - Previously, the sniff enforced that the values were aligned, even if this meant the assignment tokens were not + - Now, the sniff can enforce that the assignment tokens are aligned, even if this means the values are not + - Set the "alignAtEnd" sniff property to "false" to align the assignment tokens + - The default remains at "true", so the assigned values are aligned + - Thanks to [John P. Bloch][@johnpbloch] for the patch +- Generic.PHP.LowerCaseType now supports checking of typed properties + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.PHP.LowerCaseType now supports checking of union types + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PEAR.Commenting.FunctionComment and Squiz.Commenting.FunctionComment sniffs can now ignore private and protected methods + - Set the "minimumVisibility" sniff property to "protected" to ignore private methods + - Set the "minimumVisibility" sniff property to "public" to ignore both private and protected methods + - The default remains at "private", so all methods are checked + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- PEAR.Commenting.FunctionComment and Squiz.Commenting.FunctionComment sniffs can now ignore return tags in any method + - Previously, only `__construct()` and `__destruct()` were ignored + - Set the list of method names to ignore in the "specialMethods" sniff property + - The default remains at "__construct" and "__destruct" only + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- PSR2.ControlStructures.SwitchDeclaration now supports nested switch statements where every branch terminates + - Previously, if a CASE only contained a SWITCH and no direct terminating statement, a fall-through error was displayed + - Now, the error is suppressed if every branch of the SWITCH has a terminating statement + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- The PSR2.Methods.FunctionCallSignature.SpaceBeforeCloseBracket error message is now reported on the closing parenthesis token + - Previously, the error was being reported on the function keyword, leading to confusing line numbers in the error report +- Squiz.Commenting.FunctionComment is now able to ignore function comments that are only inheritdoc statements + - Set the skipIfInheritdoc sniff property to "true" to skip checking function comments if the content is only {@inhertidoc} + - The default remains at "false", so these comments will continue to report errors + - Thanks to [Jess Myrbo][@xjm] for the patch +- Squiz.Commenting.FunctionComment now supports the PHP 8 mixed type + - Thanks to [Vadim Borodavko][@javer] for the patch +- Squiz.PHP.NonExecutableCode now has improved handling of syntax errors + - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch +- Squiz.WhiteSpace.ScopeKeywordSpacing now checks spacing when using PHP 8.0 constructor property promotion + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed an issue that could occur when checking files on network drives, such as with WSL2 on Windows 10 + - This works around a long-standing PHP bug with is_readable() + - Thanks to [Michael S][@codebymikey] for the patch +- Fixed a number of false positives in the Squiz.PHP.DisallowMultipleAssignments sniff + - Sniff no longer errors for default value assignments in arrow functions + - Sniff no longer errors for assignments on first line of closure + - Sniff no longer errors for assignments after a goto label + - Thanks to [Jaroslav Hanslík][@kukulich] for the patch +- Fixed bug [#2913][sq-2913] : Generic.WhiteSpace.ScopeIndent false positive when opening and closing tag on same line inside conditional +- Fixed bug [#2992][sq-2992] : Enabling caching using a ruleset produces invalid cache files when using --sniffs and --exclude CLI args +- Fixed bug [#3003][sq-3003] : Squiz.Formatting.OperatorBracket autofix incorrect when assignment used with null coalescing operator +- Fixed bug [#3145][sq-3145] : Autoloading of sniff fails when multiple classes declared in same file +- Fixed bug [#3157][sq-3157] : PSR2.ControlStructures.SwitchDeclaration.BreakIndent false positive when case keyword is not indented +- Fixed bug [#3163][sq-3163] : Undefined index error with pre-commit hook using husky on PHP 7.4 + - Thanks to [Ismo Vuorinen][@ivuorinen] for the patch +- Fixed bug [#3165][sq-3165] : Squiz.PHP.DisallowComparisonAssignment false positive when comparison inside closure +- Fixed bug [#3167][sq-3167] : Generic.WhiteSpace.ScopeIndent false positive when using PHP 8.0 constructor property promotion +- Fixed bug [#3170][sq-3170] : Squiz.WhiteSpace.OperatorSpacing false positive when using negation with string concat + - This also fixes the same issue in the PSR12.Operators.OperatorSpacing sniff +- Fixed bug [#3177][sq-3177] : Incorrect tokenization of GOTO statements in mixed PHP/HTML files + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3184][sq-3184] : PSR2.Namespace.NamespaceDeclaration false positive on namespace operator + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3188][sq-3188] : Squiz.WhiteSpace.ScopeKeywordSpacing false positive for static return type + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3192][sq-3192] : findStartOfStatement doesn't work correctly inside switch + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- Fixed bug [#3195][sq-3195] : Generic.WhiteSpace.ScopeIndent confusing message when combination of tabs and spaces found +- Fixed bug [#3197][sq-3197] : Squiz.NamingConventions.ValidVariableName does not use correct error code for all member vars +- Fixed bug [#3219][sq-3219] : Generic.Formatting.MultipleStatementAlignment false positive for empty anonymous classes and closures +- Fixed bug [#3258][sq-3258] : Squiz.Formatting.OperatorBracket duplicate error messages for unary minus + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3273][sq-3273] : Squiz.Functions.FunctionDeclarationArgumentSpacing reports line break as 0 spaces between parenthesis +- Fixed bug [#3277][sq-3277] : Nullable static return typehint causes whitespace error +- Fixed bug [#3284][sq-3284] : Unused parameter false positive when using array index in arrow function + +[sq-2913]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2913 +[sq-2992]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2992 +[sq-3003]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3003 +[sq-3145]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3145 +[sq-3157]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3157 +[sq-3163]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3163 +[sq-3165]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3165 +[sq-3167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3167 +[sq-3170]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3170 +[sq-3177]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3177 +[sq-3184]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3184 +[sq-3188]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3188 +[sq-3192]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3192 +[sq-3195]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3195 +[sq-3197]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3197 +[sq-3219]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3219 +[sq-3258]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3258 +[sq-3273]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3273 +[sq-3277]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3277 +[sq-3284]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3284 + +## [3.5.8] - 2020-10-23 + +### Removed +- Reverted a change to the way include/exclude patterns are processed for STDIN content + - This change is not backwards compatible and will be re-introduced in version 3.6.0 + +## [3.5.7] - 2020-10-23 + +### Added +- The PHP 8.0 T_NULLSAFE_OBJECT_OPERATOR token has been made available for older versions + - Existing sniffs that check for T_OBJECT_OPERATOR have been modified to apply the same rules for the nullsafe object operator + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The new method of PHP 8.0 tokenizing for namespaced names has been reverted to the pre 8.0 method + - This maintains backwards compatible for existing sniffs on PHP 8.0 + - This change will be removed in PHPCS 4.0 as the PHP 8.0 tokenizing method will be backported for pre 8.0 versions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for changes to the way PHP 8.0 tokenizes hash comments + - The existing PHP 5-7 behaviour has been replicated for version 8, so no sniff changes are required + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Running the unit tests now includes warnings in the found and fixable error code counts + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PSR12.Functions.NullableTypeDeclaration now supports the PHP8 static return type + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Changed +- The autoloader has been changed to fix sniff class name detection issues that may occur when running on PHP 7.4+ + - Thanks to [Eloy Lafuente][@stronk7] for the patch +- PSR12.ControlStructures.BooleanOperatorPlacement.FoundMixed error message is now more accurate when using the allowOnly setting + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch + +### Fixed +- Fixed Squiz.Formatting.OperatorBracket false positive when exiting with a negative number +- Fixed Squiz.PHP.DisallowComparisonAssignment false positive for methods called on an object +- Fixed bug [#2882][sq-2882] : Generic.Arrays.ArrayIndent can request close brace indent to be less than the statement indent level +- Fixed bug [#2883][sq-2883] : Generic.WhiteSpace.ScopeIndent.Incorrect issue after NOWDOC +- Fixed bug [#2975][sq-2975] : Undefined offset in PSR12.Functions.ReturnTypeDeclaration when checking function return type inside ternary +- Fixed bug [#2988][sq-2988] : Undefined offset in Squiz.Strings.ConcatenationSpacing during live coding + - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch +- Fixed bug [#2989][sq-2989] : Incorrect auto-fixing in Generic.ControlStructures.InlineControlStructure during live coding + - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch +- Fixed bug [#3007][sq-3007] : Directory exclude pattern improperly excludes directories with names that start the same + - Thanks to [Steve Talbot][@SteveTalbot] for the patch +- Fixed bug [#3043][sq-3043] : Squiz.WhiteSpace.OperatorSpacing false positive for negation in arrow function + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3049][sq-3049] : Incorrect error with arrow function and parameter passed as reference + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3053][sq-3053] : PSR2 incorrect fix when multiple use statements on same line do not have whitespace between them +- Fixed bug [#3058][sq-3058] : Progress gets unaligned when 100% happens at the end of the available dots +- Fixed bug [#3059][sq-3059] : Squiz.Arrays.ArrayDeclaration false positive when using type casting + - Thanks to [Sergei Morozov][@morozov] for the patch +- Fixed bug [#3060][sq-3060] : Squiz.Arrays.ArrayDeclaration false positive for static functions + - Thanks to [Sergei Morozov][@morozov] for the patch +- Fixed bug [#3065][sq-3065] : Should not fix Squiz.Arrays.ArrayDeclaration.SpaceBeforeComma if comment between element and comma + - Thanks to [Sergei Morozov][@morozov] for the patch +- Fixed bug [#3066][sq-3066] : No support for namespace operator used in type declarations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3075][sq-3075] : PSR12.ControlStructures.BooleanOperatorPlacement false positive when operator is the only content on line +- Fixed bug [#3099][sq-3099] : Squiz.WhiteSpace.OperatorSpacing false positive when exiting with negative number + - Thanks to [Sergei Morozov][@morozov] for the patch +- Fixed bug [#3102][sq-3102] : PSR12.Squiz.OperatorSpacing false positive for default values of arrow functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#3124][sq-3124] : PSR-12 not reporting error for empty lines with only whitespace +- Fixed bug [#3135][sq-3135] : Ignore annotations are broken on PHP 8.0 + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-2882]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2882 +[sq-2883]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2883 +[sq-2975]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2975 +[sq-2988]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2988 +[sq-2989]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2989 +[sq-3007]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3007 +[sq-3043]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3043 +[sq-3049]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3049 +[sq-3053]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3053 +[sq-3058]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3058 +[sq-3059]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3059 +[sq-3060]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3060 +[sq-3065]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3065 +[sq-3066]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3066 +[sq-3075]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3075 +[sq-3099]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3099 +[sq-3102]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3102 +[sq-3124]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3124 +[sq-3135]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3135 + +## [3.5.6] - 2020-08-10 + +### Added +- Added support for PHP 8.0 magic constant dereferencing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added support for changes to the way PHP 8.0 tokenizes comments + - The existing PHP 5-7 behaviour has been replicated for version 8, so no sniff changes are required + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- `File::getMethodProperties()` now detects the PHP 8.0 static return type + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The PHP 8.0 static return type is now supported for arrow functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Changed +- The cache is no longer used if the list of loaded PHP extensions changes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- `Generic.NamingConventions.CamelCapsFunctionName` no longer reports `__serialize` and `__unserialize` as invalid names + - Thanks to [Filip Š][@filips123] for the patch +- `PEAR.NamingConventions.ValidFunctionName` no longer reports `__serialize` and `__unserialize` as invalid names + - Thanks to [Filip Š][@filips123] for the patch +- `Squiz.Scope.StaticThisUsage` now detects usage of `$this` inside closures and arrow functions + - Thanks to [Michał Bundyra][@michalbundyra] for the patch + +### Fixed +- Fixed bug [#2877][sq-2877] : PEAR.Functions.FunctionCallSignature false positive for array of functions + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- Fixed bug [#2888][sq-2888] : PSR12.Files.FileHeader blank line error with multiple namespaces in one file +- Fixed bug [#2926][sq-2926] : phpcs hangs when using arrow functions that return heredoc +- Fixed bug [#2943][sq-2943] : Redundant semicolon added to a file when fixing PSR2.Files.ClosingTag.NotAllowed +- Fixed bug [#2967][sq-2967] : Markdown generator does not output headings correctly + - Thanks to [Petr Bugyík][@o5] for the patch +- Fixed bug [#2977][sq-2977] : File::isReference() does not detect return by reference for closures + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2994][sq-2994] : Generic.Formatting.DisallowMultipleStatements false positive for FOR loop with no body +- Fixed bug [#3033][sq-3033] : Error generated during tokenizing of goto statements on PHP 8 + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-2877]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2877 +[sq-2888]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2888 +[sq-2926]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2926 +[sq-2943]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2943 +[sq-2967]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2967 +[sq-2977]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2977 +[sq-2994]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2994 +[sq-3033]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3033 + +## [3.5.5] - 2020-04-17 + +### Changed +- The T_FN backfill now works more reliably so T_FN tokens only ever represent real arrow functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed an issue where including sniffs using paths containing multiple dots would silently fail +- Generic.CodeAnalysis.EmptyPHPStatement now detects empty statements at the start of control structures + +### Fixed +- Error wording in PEAR.Functions.FunctionCallSignature now always uses "parenthesis" instead of sometimes using "bracket" + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- Fixed bug [#2787][sq-2787] : Squiz.PHP.DisallowMultipleAssignments not ignoring typed property declarations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2810][sq-2810] : PHPCBF fails to fix file with empty statement at start on control structure +- Fixed bug [#2812][sq-2812] : Squiz.Arrays.ArrayDeclaration not detecting some arrays with multiple arguments on the same line + - Thanks to [Jakub Chábek][@grongor] for the patch +- Fixed bug [#2826][sq-2826] : Generic.WhiteSpace.ArbitraryParenthesesSpacing doesn't detect issues for statements directly after a control structure + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- Fixed bug [#2848][sq-2848] : PSR12.Files.FileHeader false positive for file with mixed PHP and HTML and no file header +- Fixed bug [#2849][sq-2849] : Generic.WhiteSpace.ScopeIndent false positive with arrow function inside array +- Fixed bug [#2850][sq-2850] : Generic.PHP.LowerCaseKeyword complains __HALT_COMPILER is uppercase +- Fixed bug [#2853][sq-2853] : Undefined variable error when using Info report + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2865][sq-2865] : Double arrow tokenized as T_STRING when placed after function named "fn" +- Fixed bug [#2867][sq-2867] : Incorrect scope matching when arrow function used inside IF condition +- Fixed bug [#2868][sq-2868] : phpcs:ignore annotation doesn't work inside a docblock +- Fixed bug [#2878][sq-2878] : PSR12.Files.FileHeader conflicts with Generic.Files.LineEndings +- Fixed bug [#2895][sq-2895] : PSR2.Methods.FunctionCallSignature.MultipleArguments false positive with arrow function argument + +[sq-2787]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2787 +[sq-2810]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2810 +[sq-2812]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2812 +[sq-2826]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2826 +[sq-2848]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2848 +[sq-2849]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2849 +[sq-2850]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2850 +[sq-2853]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2853 +[sq-2865]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2865 +[sq-2867]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2867 +[sq-2868]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2868 +[sq-2878]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2878 +[sq-2895]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2895 + +## [3.5.4] - 2020-01-31 + +### Changed +- The PHP 7.4 numeric separator backfill now works correctly for more float formats + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The PHP 7.4 numeric separator backfill is no longer run on PHP version 7.4.0 or greater +- File::getCondition() now accepts a 3rd argument that allows for the closest matching token to be returned + - By default, it continues to return the first matched token found from the top of the file +- Fixed detection of array return types for arrow functions +- Added Generic.PHP.DisallowRequestSuperglobal to ban the use of the $_REQUEST superglobal + - Thanks to [Jeantwan Teuma][@Morerice] for the contribution +- Generic.ControlStructures.InlineControlStructure no longer shows errors for WHILE and FOR statements without a body + - Previously it required these to have curly braces, but there were no statements to enclose in them + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PSR12.ControlStructures.BooleanOperatorPlacement can now be configured to enforce a specific operator position + - By default, the sniff ensures that operators are all at the beginning or end of lines, but not a mix of both + - Set the allowOnly property to "first" to enforce all boolean operators to be at the start of a line + - Set the allowOnly property to "last" to enforce all boolean operators to be at the end of a line + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- PSR12.Files.ImportStatement now auto-fixes import statements by removing the leading slash + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Squiz.ControlStructures.ForLoopDeclaration now has a setting to ignore newline characters + - Default remains FALSE, so newlines are not allowed within FOR definitions + - Override the "ignoreNewlines" setting in a ruleset.xml file to change +- Squiz.PHP.InnerFunctions now handles multiple nested anon classes correctly + +### Fixed +- Fixed bug [#2497][sq-2497] : Sniff properties not set when referencing a sniff using relative paths or non-native slashes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2657][sq-2657] : Squiz.WhiteSpace.FunctionSpacing can remove spaces between comment and first/last method during auto-fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2688][sq-2688] : Case statements not tokenized correctly when switch is contained within ternary +- Fixed bug [#2698][sq-2698] : PHPCS throws errors determining auto report width when shell_exec is disabled + - Thanks to [Matthew Peveler][@MasterOdin] for the patch +- Fixed bug [#2730][sq-2730] : PSR12.ControlStructures.ControlStructureSpacing does not ignore comments between conditions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2732][sq-2732] : PSR12.Files.FileHeader misidentifies file header in mixed content file +- Fixed bug [#2745][sq-2745] : AbstractArraySniff wrong indices when mixed coalesce and ternary values + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#2748][sq-2748] : Wrong end of statement for fn closures + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#2751][sq-2751] : Autoload relative paths first to avoid confusion with files from the global include path + - Thanks to [Klaus Purer][@klausi] for the patch +- Fixed bug [#2763][sq-2763] : PSR12 standard reports errors for multi-line FOR definitions +- Fixed bug [#2768][sq-2768] : Generic.Files.LineLength false positive for non-breakable strings at exactly the soft limit + - Thanks to [Alex Miles][@ghostal] for the patch +- Fixed bug [#2773][sq-2773] : PSR2.Methods.FunctionCallSignature false positive when arrow function has array return type +- Fixed bug [#2790][sq-2790] : PSR12.Traits.UseDeclaration ignores block comments + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- Fixed bug [#2791][sq-2791] : PSR12.Functions.NullableTypeDeclaration false positive when ternary operator used with instanceof + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2802][sq-2802] : Can't specify a report file path using the tilde shortcut +- Fixed bug [#2804][sq-2804] : PHP4-style typed properties not tokenized correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2805][sq-2805] : Undefined Offset notice during live coding of arrow functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2843][sq-2843] : Tokenizer does not support alternative syntax for declare statements + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-2497]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2497 +[sq-2657]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2657 +[sq-2688]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2688 +[sq-2698]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2698 +[sq-2730]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2730 +[sq-2732]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2732 +[sq-2745]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2745 +[sq-2748]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2748 +[sq-2751]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2751 +[sq-2763]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2763 +[sq-2768]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2768 +[sq-2773]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2773 +[sq-2790]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2790 +[sq-2791]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2791 +[sq-2802]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2802 +[sq-2804]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2804 +[sq-2805]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2805 +[sq-2843]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2843 + +## [3.5.3] - 2019-12-04 + +### Changed +- The PHP 7.4 T_FN token has been made available for older versions + - T_FN represents the fn string used for arrow functions + - The double arrow becomes the scope opener, and uses a new T_FN_ARROW token type + - The token after the statement (normally a semicolon) becomes the scope closer + - The token is also associated with the opening and closing parenthesis of the statement + - Any functions named "fn" will have a T_FN token for the function name, but have no scope information + - Thanks to [Michał Bundyra][@michalbundyra] for the help with this change +- PHP 7.4 numeric separators are now tokenized in the same way when using older PHP versions + - Previously, a number like 1_000 would tokenize as T_LNUMBER (1), T_STRING (_000) + - Now, the number tokenizes as T_LNUMBER (1_000) + - Sniff developers should consider how numbers with underscores impact their custom sniffs +- The PHPCS file cache now takes file permissions into account + - The cache is now invalidated for a file when its permissions are changed +- File::getMethodParameters() now supports arrow functions +- File::getMethodProperties() now supports arrow functions +- Added Fixer::changeCodeBlockIndent() to change the indent of a code block while auto-fixing + - Can be used to either increase or decrease the indent + - Useful when moving the start position of something like a closure, where you want the content to also move +- Added Generic.Files.ExecutableFile sniff + - Ensures that files are not executable + - Thanks to [Matthew Peveler][@MasterOdin] for the contribution +- Generic.CodeAnalysis.EmptyPhpStatement now reports unnecessary semicolons after control structure closing braces + - Thanks to [Vincent Langlet][@VincentLanglet] for the patch +- Generic.PHP.LowerCaseKeyword now enforces that the "fn" keyword is lowercase + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Generic.WhiteSpace.ScopeIndent now supports static arrow functions +- PEAR.Functions.FunctionCallSignature now adjusts the indent of function argument contents during auto-fixing + - Previously, only the first line of an argument was changed, leading to inconsistent indents + - This change also applies to PSR2.Methods.FunctionCallSignature +- PSR2.ControlStructures.ControlStructureSpacing now checks whitespace before the closing parenthesis of multi-line control structures + - Previously, it incorrectly applied the whitespace check for single-line definitions only +- PSR12.Functions.ReturnTypeDeclaration now checks the return type of arrow functions + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- PSR12.Traits.UseDeclaration now ensures all trait import statements are grouped together + - Previously, the trait import section of the class ended when the first non-import statement was found + - Checking now continues throughout the class to ensure all statements are grouped together + - This also ensures that empty lines are not requested after an import statement that isn't the last one +- Squiz.Functions.LowercaseFunctionKeywords now enforces that the "fn" keyword is lowercase + - Thanks to [Michał Bundyra][@michalbundyra] for the patch + +### Fixed +- Fixed bug [#2586][sq-2586] : Generic.WhiteSpace.ScopeIndent false positives when indenting open tags at a non tab-stop +- Fixed bug [#2638][sq-2638] : Squiz.CSS.DuplicateClassDefinitionSniff sees comments as part of the class name + - Thanks to [Raphael Horber][@rhorber] for the patch +- Fixed bug [#2640][sq-2640] : Squiz.WhiteSpace.OperatorSpacing false positives for some negation operators + - Thanks to [Jakub Chábek][@grongor] and [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2674][sq-2674] : Squiz.Functions.FunctionDeclarationArgumentSpacing prints wrong argument name in error message +- Fixed bug [#2676][sq-2676] : PSR12.Files.FileHeader locks up when file ends with multiple inline comments +- Fixed bug [#2678][sq-2678] : PSR12.Classes.AnonClassDeclaration incorrectly enforcing that closing brace be on a line by itself +- Fixed bug [#2685][sq-2685] : File::getMethodParameters() setting typeHintEndToken for vars with no type hint + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2694][sq-2694] : AbstractArraySniff produces invalid indices when using ternary operator + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#2702][sq-2702] : Generic.WhiteSpace.ScopeIndent false positive when using ternary operator with short arrays + +[sq-2586]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2586 +[sq-2638]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2638 +[sq-2640]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2640 +[sq-2674]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2674 +[sq-2676]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2676 +[sq-2678]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2678 +[sq-2685]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2685 +[sq-2694]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2694 +[sq-2702]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2702 + +## [3.5.2] - 2019-10-28 + +### Changed +- Generic.ControlStructures.DisallowYodaConditions now returns less false positives + - False positives were being returned for array comparisons, or when performing some function calls +- Squiz.WhiteSpace.SemicolonSpacing.Incorrect error message now escapes newlines and tabs + - Provides a clearer error message as whitespace is now visible + - Also allows for better output for report types such as CSV and XML +- The error message for PSR12.Files.FileHeader.SpacingAfterBlock has been made clearer + - It now uses the wording from the published PSR-12 standard to indicate that blocks must be separated by a blank line + - Thanks to [Craig Duncan][@duncan3dc] for the patch + +### Fixed +- Fixed bug [#2654][sq-2654] : Incorrect indentation for arguments of multiline function calls +- Fixed bug [#2656][sq-2656] : Squiz.WhiteSpace.MemberVarSpacing removes comments before first member var during auto fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2663][sq-2663] : Generic.NamingConventions.ConstructorName complains about old constructor in interfaces +- Fixed bug [#2664][sq-2664] : PSR12.Files.OpenTag incorrectly identifies PHP file with only an opening tag +- Fixed bug [#2665][sq-2665] : PSR12.Files.ImportStatement should not apply to traits +- Fixed bug [#2673][sq-2673] : PSR12.Traits.UseDeclaration does not allow comments or blank lines between use statements + +[sq-2654]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2654 +[sq-2656]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2656 +[sq-2663]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2663 +[sq-2664]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2664 +[sq-2665]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2665 +[sq-2673]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2673 + +## [3.5.1] - 2019-10-17 + +### Changed +- Very very verbose diff report output has slightly changed to improve readability + - Output is printed when running PHPCS with the --report=diff and -vvv command line arguments + - Fully qualified class names have been replaced with sniff codes + - Tokens being changed now display the line number they are on +- PSR2, PSR12, and PEAR standards now correctly check for blank lines at the start of function calls + - This check has been missing from these standards, but has now been implemented + - When using the PEAR standard, the error code is PEAR.Functions.FunctionCallSignature.FirstArgumentPosition + - When using PSR2 or PSR12, the error code is PSR2.Methods.FunctionCallSignature.FirstArgumentPosition +- PSR12.ControlStructures.BooleanOperatorPlacement no longer complains when multiple expressions appear on the same line + - Previously, boolean operators were enforced to appear at the start or end of lines only + - Boolean operators can now appear in the middle of the line +- PSR12.Files.FileHeader no longer ignores comments preceding a use, namespace, or declare statement +- PSR12.Files.FileHeader now allows a hashbang line at the top of the file + +### Fixed +- Fixed bug [#2506][sq-2506] : PSR2 standard can't auto fix multi-line function call inside a string concat statement +- Fixed bug [#2530][sq-2530] : PEAR.Commenting.FunctionComment does not support intersection types in comments +- Fixed bug [#2615][sq-2615] : Constant visibility false positive on non-class constants +- Fixed bug [#2616][sq-2616] : PSR12.Files.FileHeader false positive when file only contains docblock +- Fixed bug [#2619][sq-2619] : PSR12.Files.FileHeader locks up when inline comment is the last content in a file +- Fixed bug [#2621][sq-2621] : PSR12.Classes.AnonClassDeclaration.CloseBraceSameLine false positive for anon class passed as function argument + - Thanks to [Martins Sipenko][@martinssipenko] for the patch +- Fixed bug [#2623][sq-2623] : PSR12.ControlStructures.ControlStructureSpacing not ignoring indentation inside multi-line string arguments +- Fixed bug [#2624][sq-2624] : PSR12.Traits.UseDeclaration doesnt apply the correct indent during auto fixing +- Fixed bug [#2626][sq-2626] : PSR12.Files.FileHeader detects @var annotations as file docblocks +- Fixed bug [#2628][sq-2628] : PSR12.Traits.UseDeclaration does not allow comments above a USE declaration +- Fixed bug [#2632][sq-2632] : Incorrect indentation of lines starting with "static" inside closures +- Fixed bug [#2641][sq-2641] : PSR12.Functions.NullableTypeDeclaration false positive when using new static() + +[sq-2506]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2506 +[sq-2530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2530 +[sq-2615]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2615 +[sq-2616]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2616 +[sq-2619]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2619 +[sq-2621]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2621 +[sq-2623]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2623 +[sq-2624]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2624 +[sq-2626]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2626 +[sq-2628]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2628 +[sq-2632]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2632 +[sq-2641]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2641 + +## [3.5.0] - 2019-09-27 + +### Changed +- The included PSR12 standard is now complete and ready to use + - Check your code using PSR-12 by running PHPCS with --standard=PSR12 +- Added support for PHP 7.4 typed properties + - The nullable operator is now tokenized as T_NULLABLE inside property types, as it is elsewhere + - To get the type of a member var, use the File::getMemberProperties() method, which now contains a "type" array index + - This contains the type of the member var, or a blank string if not specified + - If the type is nullable, the return type will contain the leading ? + - If a type is specified, the position of the first token in the type will be set in a "type_token" array index + - If a type is specified, the position of the last token in the type will be set in a "type_end_token" array index + - If the type is nullable, a "nullable_type" array index will also be set to TRUE + - If the type contains namespace information, it will be cleaned of whitespace and comments in the return value +- The PSR1 standard now correctly bans alternate PHP tags + - Previously, it only banned short open tags and not the pre-7.0 alternate tags +- Added support for only checking files that have been locally staged in a git repo + - Use --filter=gitstaged to check these files + - You still need to give PHPCS a list of files or directories in which to apply the filter + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- JSON reports now end with a newline character +- The phpcs.xsd schema now validates phpcs-only and phpcbf-only attributes correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The tokenizer now correctly identifies inline control structures in more cases +- All helper methods inside the File class now throw RuntimeException instead of TokenizerException + - Some tokenizer methods were also throwing RuntimeException but now correctly throw TokenizerException + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The File::getMethodParameters() method now returns more information, and supports closure USE groups + - If a type hint is specified, the position of the last token in the hint will be set in a "type_hint_end_token" array index + - If a default is specified, the position of the first token in the default value will be set in a "default_token" array index + - If a default is specified, the position of the equals sign will be set in a "default_equal_token" array index + - If the param is not the last, the position of the comma will be set in a "comma_token" array index + - If the param is passed by reference, the position of the reference operator will be set in a "reference_token" array index + - If the param is variable length, the position of the variadic operator will be set in a "variadic_token" array index +- The T_LIST token and it's opening and closing parentheses now contain references to each other in the tokens array + - Uses the same parenthesis_opener/closer/owner indexes as other tokens + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The T_ANON_CLASS token and it's opening and closing parentheses now contain references to each other in the tokens array + - Uses the same parenthesis_opener/closer/owner indexes as other tokens + - Only applicable if the anon class is passing arguments to the constructor + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The PHP 7.4 T_BAD_CHARACTER token has been made available for older versions + - Allows you to safely look for this token, but it will not appear unless checking with PHP 7.4+ +- Metrics are now available for Squiz.WhiteSpace.FunctionSpacing + - Use the "info" report to see blank lines before/after functions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Metrics are now available for Squiz.WhiteSpace.MemberVarSpacing + - Use the "info" report to see blank lines before member vars + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added Generic.ControlStructures.DisallowYodaConditions sniff + - Ban the use of Yoda conditions + - Thanks to [Mponos George][@gmponos] for the contribution +- Added Generic.PHP.RequireStrictTypes sniff + - Enforce the use of a strict types declaration in PHP files +- Added Generic.WhiteSpace.SpreadOperatorSpacingAfter sniff + - Checks whitespace between the spread operator and the variable/function call it applies to + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added PSR12.Classes.AnonClassDeclaration sniff + - Enforces the formatting of anonymous classes +- Added PSR12.Classes.ClosingBrace sniff + - Enforces that closing braces of classes/interfaces/traits/functions are not followed by a comment or statement +- Added PSR12.ControlStructures.BooleanOperatorPlacement sniff + - Enforces that boolean operators between conditions are consistently at the start or end of the line +- Added PSR12.ControlStructures.ControlStructureSpacing sniff + - Enforces that spacing and indents are correct inside control structure parenthesis +- Added PSR12.Files.DeclareStatement sniff + - Enforces the formatting of declare statements within a file +- Added PSR12.Files.FileHeader sniff + - Enforces the order and formatting of file header blocks +- Added PSR12.Files.ImportStatement sniff + - Enforces the formatting of import statements within a file +- Added PSR12.Files.OpenTag sniff + - Enforces that the open tag is on a line by itself when used at the start of a PHP-only file +- Added PSR12.Functions.ReturnTypeDeclaration sniff + - Enforces the formatting of return type declarations in functions and closures +- Added PSR12.Properties.ConstantVisibility sniff + - Enforces that constants must have their visibility defined + - Uses a warning instead of an error due to this conditionally requiring the project to support PHP 7.1+ +- Added PSR12.Traits.UseDeclaration sniff + - Enforces the formatting of trait import statements within a class +- Generic.Files.LineLength ignoreComments property now ignores comments at the end of a line + - Previously, this property was incorrectly causing the sniff to ignore any line that ended with a comment + - Now, the trailing comment is not included in the line length, but the rest of the line is still checked +- Generic.Files.LineLength now only ignores unwrappable comments when the comment is on a line by itself + - Previously, a short unwrappable comment at the end of the line would have the sniff ignore the entire line +- Generic.Functions.FunctionCallArgumentSpacing no longer checks spacing around assignment operators inside function calls + - Use the Squiz.WhiteSpace.OperatorSpacing sniff to enforce spacing around assignment operators + - Note that this sniff checks spacing around all assignment operators, not just inside function calls + - The Generic.Functions.FunctionCallArgumentSpacing.NoSpaceBeforeEquals error has been removed + - Use Squiz.WhiteSpace.OperatorSpacing.NoSpaceBefore instead + - The Generic.Functions.FunctionCallArgumentSpacing.NoSpaceAfterEquals error has been removed + - Use Squiz.WhiteSpace.OperatorSpacing.NoSpaceAfter instead + - This also changes the PEAR/PSR2/PSR12 standards so they no longer check assignment operators inside function calls + - They were previously checking these operators when they should not have + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.WhiteSpace.ScopeIndent no longer performs exact indents checking for chained method calls + - Other sniffs can be used to enforce chained method call indent rules + - Thanks to [Pieter Frenssen][@pfrenssen] for the patch +- PEAR.WhiteSpace.ObjectOperatorIndent now supports multi-level chained statements + - When enabled, chained calls must be indented 1 level more or less than the previous line + - Set the new "multilevel" setting to TRUE in a ruleset.xml file to enable this behaviour + - Thanks to [Marcos Passos][@marcospassos] for the patch +- PSR2.ControlStructures.ControlStructureSpacing now allows whitespace after the opening parenthesis if followed by a comment + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- PSR2.Classes.PropertyDeclaration now enforces a single space after a property type keyword + - The PSR2 standard itself excludes this new check as it is not defined in the written standard + - Using the PSR12 standard will enforce this check +- Squiz.Commenting.BlockComment no longer requires blank line before comment if it's the first content after the PHP open tag + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Functions.FunctionDeclarationArgumentSpacing now has more accurate error messages + - This includes renaming the SpaceAfterDefault error code to SpaceAfterEquals, which reflects the real error +- Squiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a reference operator + - If you don't want this new behaviour, exclude the SpacingAfterReference error message in a ruleset.xml file +- Squiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a variadic operator + - If you don't want this new behaviour, exclude the SpacingAfterVariadic error message in a ruleset.xml file +- Squiz.Functions.MultiLineFunctionDeclaration now has improved fixing for the FirstParamSpacing and UseFirstParamSpacing errors +- Squiz.Operators.IncrementDecrementUsage now suggests pre-increment of variables instead of post-increment + - This change does not enforce pre-increment over post-increment; only the suggestion has changed + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.PHP.DisallowMultipleAssignments now has a second error code for when assignments are found inside control structure conditions + - The new error code is Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure + - All other multiple assignment cases use the existing error code Squiz.PHP.DisallowMultipleAssignments.Found + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.FunctionSpacing now applies beforeFirst and afterLast spacing rules to nested functions + - Previously, these rules only applied to the first and last function in a class, interface, or trait + - These rules now apply to functions nested in any statement block, including other functions and conditions +- Squiz.WhiteSpace.OperatorSpacing now has improved handling of parse errors + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.OperatorSpacing now checks spacing around the instanceof operator + - Thanks to [Jakub Chábek][@grongor] for the patch +- Squiz.WhiteSpace.OperatorSpacing can now enforce a single space before assignment operators + - Previously, the sniff this spacing as multiple assignment operators are sometimes aligned + - Now, you can set the ignoreSpacingBeforeAssignments sniff property to FALSE to enable checking + - Default remains TRUE, so spacing before assignments is not checked by default + - Thanks to [Jakub Chábek][@grongor] for the patch + +### Fixed +- Fixed bug [#2391][sq-2391] : Sniff-specific ignore rules inside rulesets are filtering out too many files + - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Willington Vega][@wvega] for the patch +- Fixed bug [#2478][sq-2478] : FunctionCommentThrowTag.WrongNumber when exception is thrown once but built conditionally +- Fixed bug [#2479][sq-2479] : Generic.WhiteSpace.ScopeIndent error when using array destructing with exact indent checking +- Fixed bug [#2498][sq-2498] : Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed autofix breaks heredoc +- Fixed bug [#2502][sq-2502] : Generic.WhiteSpace.ScopeIndent false positives with nested switch indentation and case fall-through +- Fixed bug [#2504][sq-2504] : Generic.WhiteSpace.ScopeIndent false positives with nested arrays and nowdoc string +- Fixed bug [#2511][sq-2511] : PSR2 standard not checking if closing paren of single-line function declaration is on new line +- Fixed bug [#2512][sq-2512] : Squiz.PHP.NonExecutableCode does not support alternate SWITCH control structure + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2522][sq-2522] : Text generator throws error when code sample line is too long + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2526][sq-2526] : XML report format has bad syntax on Windows + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2529][sq-2529] : Generic.Formatting.MultipleStatementAlignment wrong error for assign in string concat +- Fixed bug [#2534][sq-2534] : Unresolvable installed_paths can lead to open_basedir errors + - Thanks to [Oliver Nowak][@ndm2] for the patch +- Fixed bug [#2541][sq-2541] : Text doc generator does not allow for multi-line rule explanations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2549][sq-2549] : Searching for a phpcs.xml file can throw warnings due to open_basedir restrictions + - Thanks to [Matthew Peveler][@MasterOdin] for the patch +- Fixed bug [#2558][sq-2558] : PHP 7.4 throwing offset syntax with curly braces is deprecated message + - Thanks to [Matthew Peveler][@MasterOdin] for the patch +- Fixed bug [#2561][sq-2561] : PHP 7.4 compatibility fix / implode argument order + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2562][sq-2562] : Inline WHILE triggers SpaceBeforeSemicolon incorrectly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2565][sq-2565] : Generic.ControlStructures.InlineControlStructure confused by mixed short/long tags + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2566][sq-2566] : Author tag email validation doesn't support all TLDs + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2575][sq-2575] : Custom error messages don't have data replaced when cache is enabled +- Fixed bug [#2601][sq-2601] : Squiz.WhiteSpace.FunctionSpacing incorrect fix when spacing is 0 +- Fixed bug [#2608][sq-2608] : PSR2 throws errors for use statements when multiple namespaces are defined in a file + +[sq-2391]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2391 +[sq-2478]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2478 +[sq-2479]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2479 +[sq-2498]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2498 +[sq-2502]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2502 +[sq-2504]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2504 +[sq-2511]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2511 +[sq-2512]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2512 +[sq-2522]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2522 +[sq-2526]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2526 +[sq-2529]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2529 +[sq-2534]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2534 +[sq-2541]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2541 +[sq-2549]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2549 +[sq-2558]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2558 +[sq-2561]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2561 +[sq-2562]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2562 +[sq-2565]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2565 +[sq-2566]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2566 +[sq-2575]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2575 +[sq-2601]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2601 +[sq-2608]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2608 + +## [3.4.2] - 2019-04-11 + +### Changed +- Squiz.Arrays.ArrayDeclaration now has improved handling of syntax errors + +### Fixed +- Fixed an issue where the PCRE JIT on PHP 7.3 caused PHPCS to die when using the parallel option + - PHPCS now disables the PCRE JIT before running +- Fixed bug [#2368][sq-2368] : MySource.PHP.AjaxNullComparison throws error when first function has no doc comment +- Fixed bug [#2414][sq-2414] : Indention false positive in switch/case/if combination +- Fixed bug [#2423][sq-2423] : Squiz.Formatting.OperatorBracket.MissingBrackets error with static +- Fixed bug [#2450][sq-2450] : Indentation false positive when closure containing nested IF conditions used as function argument +- Fixed bug [#2452][sq-2452] : LowercasePHPFunctions sniff failing on "new \File()" +- Fixed bug [#2453][sq-2453] : Squiz.CSS.SemicolonSpacingSniff false positive when style name proceeded by an asterisk + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2464][sq-2464] : Fixer conflict between Generic.WhiteSpace.ScopeIndent and Squiz.WhiteSpace.ScopeClosingBrace when class indented 1 space +- Fixed bug [#2465][sq-2465] : Excluding a sniff by path is not working +- Fixed bug [#2467][sq-2467] : PHP open/close tags inside CSS files are replaced with internal PHPCS token strings when auto fixing + +[sq-2368]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2368 +[sq-2414]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2414 +[sq-2423]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2423 +[sq-2450]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2450 +[sq-2452]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2452 +[sq-2453]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2453 +[sq-2464]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2464 +[sq-2465]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2465 +[sq-2467]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2467 + +## [3.4.1] - 2019-03-19 + +### Changed +- The PEAR installable version of PHPCS was missing some files, which have been re-included in this release + - The code report was not previously available for PEAR installs + - The Generic.Formatting.SpaceBeforeCast sniff was not previously available for PEAR installs + - The Generic.WhiteSpace.LanguageConstructSpacing sniff was not previously available for PEAR installs + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PHPCS will now refuse to run if any of the required PHP extensions are not loaded + - Previously, PHPCS only relied on requirements being checked by PEAR and Composer + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Ruleset XML parsing errors are now displayed in a readable format so they are easier to correct + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The PSR2 standard no longer throws duplicate errors for spacing around FOR loop parentheses + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- T_PHPCS_SET tokens now contain sniffCode, sniffProperty, and sniffPropertyValue indexes + - Sniffs can use this information instead of having to parse the token content manually +- Added more guard code for syntax errors to various CSS sniffs + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Commenting.DocComment error messages now contain the name of the comment tag that caused the error + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.ControlStructures.InlineControlStructure now handles syntax errors correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Debug.JSHint now longer requires rhino and can be run directly from the npm install + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Files.LineEndings no longer adds superfluous new line at the end of JS and CSS files + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Formatting.DisallowMultipleStatements no longer tries to fix lines containing phpcs:ignore statements + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Functions.FunctionCallArgumentSpacing now has improved performance and anonymous class support + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.WhiteSpace.ScopeIndent now respects changes to the "exact" property using phpcs:set mid-way through a file + - This allows you to change the "exact" rule for only some parts of a file +- Generic.WhiteSpace.ScopeIndent now disables exact indent checking inside all arrays + - Previously, this was only done when using long array syntax, but it now works for short array syntax as well +- PEAR.Classes.ClassDeclaration now has improved handling of PHPCS annotations and tab indents +- PSR12.Classes.ClassInstantiation has changed its error code from MissingParenthesis to MissingParentheses +- PSR12.Keywords.ShortFormTypeKeywords now ignores all spacing inside type casts during both checking and fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Classes.LowercaseClassKeywords now examines the class keyword for anonymous classes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.ControlStructures.ControlSignature now has improved handling of parse errors + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.PostStatementComment fixer no longer adds a blank line at the start of a JS file that begins with a comment + - Fixes a conflict between this sniff and the Squiz.WhiteSpace.SuperfluousWhitespace sniff + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.PostStatementComment now ignores comments inside control structure conditions, such as FOR loops + - Fixes a conflict between this sniff and the Squiz.ControlStructures.ForLoopDeclaration sniff + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.FunctionCommentThrowTag now has improved support for unknown exception types and namespaces + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.ControlStructures.ForLoopDeclaration has improved whitespace, closure, and empty expression support + - The SpacingAfterSecondNoThird error code has been removed as part of these fixes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.CSS.ClassDefinitionOpeningBraceSpace now handles comments and indentation correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.CSS.ClassDefinitionClosingBrace now handles comments, indentation, and multiple statements on the same line correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.CSS.Opacity now handles comments correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.CSS.SemicolonSpacing now handles comments and syntax errors correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.PHP.LowercasePHPFunctions now handles use statements, namespaces, and comments correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.FunctionSpacing now fixes function spacing correctly when a function is the first content in a file + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.SuperfluousWhitespace no longer throws errors for spacing between functions and properties in anon classes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Zend.Files.ClosingTag no longer adds a semicolon during fixing of a file that only contains a comment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Zend.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed bug [#2298][sq-2298] : PSR2.Classes.ClassDeclaration allows extended class on new line + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#2337][sq-2337] : Generic.WhiteSpace.ScopeIndent incorrect error when multi-line function call starts on same line as open tag +- Fixed bug [#2348][sq-2348] : Cache not invalidated when changing a ruleset included by another +- Fixed bug [#2376][sq-2376] : Using __halt_compiler() breaks Generic.PHP.ForbiddenFunctions unless it's last in the function list + - Thanks to [Sijun Zhu][@Billz95] for the patch +- Fixed bug [#2393][sq-2393] : The gitmodified filter will infinitely loop when encountering deleted file paths + - Thanks to [Lucas Manzke][@lmanzke] for the patch +- Fixed bug [#2396][sq-2396] : Generic.WhiteSpace.ScopeIndent incorrect error when multi-line IF condition mixed with HTML +- Fixed bug [#2431][sq-2431] : Use function/const not tokenized as T_STRING when preceded by comment + +[sq-2298]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2298 +[sq-2337]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2337 +[sq-2348]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2348 +[sq-2376]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2376 +[sq-2393]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2393 +[sq-2396]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2396 +[sq-2431]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2431 + +## [3.4.0] - 2018-12-20 + +### Deprecated +- The Generic.Formatting.NoSpaceAfterCast sniff has been deprecated and will be removed in version 4 + - The functionality of this sniff is now available in the Generic.Formatting.SpaceAfterCast sniff + - Include the Generic.Formatting.SpaceAfterCast sniff and set the "spacing" property to "0" + - As soon as possible, replace all instances of the old sniff code with the new sniff code and property setting + - The existing sniff will continue to work until version 4 has been released + +### Changed +- Rule include patterns in a ruleset.xml file are now evaluated as OR instead of AND + - Previously, a file had to match every include pattern and no exclude patterns to be included + - Now, a file must match at least one include pattern and no exclude patterns to be included + - This is a bug fix as include patterns are already documented to work this way +- New token T_BITWISE_NOT added for the bitwise not operator + - This token was previously tokenized as T_NONE + - Any sniffs specifically looking for T_NONE tokens with a tilde as the contents must now also look for T_BITWISE_NOT + - Sniffs can continue looking for T_NONE as well as T_BITWISE_NOT to support older PHP_CodeSniffer versions +- All types of binary casting are now tokenized as T_BINARY_CAST + - Previously, the 'b' in 'b"some string with $var"' would be a T_BINARY_CAST, but only when the string contained a var + - This change ensures the 'b' is always tokenized as T_BINARY_CAST + - This change also converts '(binary)' from T_STRING_CAST to T_BINARY_CAST + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the help with this patch +- Array properties set inside a ruleset.xml file can now extend a previous value instead of always overwriting it + - e.g., if you include a ruleset that defines forbidden functions, can you now add to that list instead of having to redefine it + - To use this feature, add extend="true" to the property tag + - e.g., property name="forbiddenFunctionNames" type="array" extend="true" + - Thanks to [Michael Moravec][@Majkl578] for the patch +- If $XDG_CACHE_HOME is set and points to a valid directory, it will be used for caching instead of the system temp directory +- PHPCBF now disables parallel running if you are passing content on STDIN + - Stops an error from being shown after the fixed output is printed +- The progress report now shows files with tokenizer errors as skipped (S) instead of a warning (W) + - The tokenizer error is still displayed in reports as normal + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The Squiz standard now ensures there is no space between an increment/decrement operator and its variable +- The File::getMethodProperties() method now includes a has_body array index in the return value + - FALSE if the method has no body (as with abstract and interface methods) or TRUE otherwise + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- The File::getTokensAsString() method now throws an exception if the $start param is invalid + - If the $length param is invalid, an empty string will be returned + - Stops an infinite loop when the function is passed invalid data + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added new Generic.CodeAnalysis.EmptyPHPStatement sniff + - Warns when it finds empty PHP open/close tag combinations or superfluous semicolons + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added new Generic.Formatting.SpaceBeforeCast sniff + - Ensures there is exactly 1 space before a type cast, unless the cast statement is indented or multi-line + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added new Generic.VersionControl.GitMergeConflict sniff + - Detects merge conflict artifacts left in files + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added Generic.WhiteSpace.IncrementDecrementSpacing sniff + - Ensures there is no space between the operator and the variable it applies to + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added PSR12.Functions.NullableTypeDeclaration sniff + - Ensures there is no space after the question mark in a nullable type declaration + - Thanks to [Timo Schinkel][@timoschinkel] for the contribution +- A number of sniffs have improved support for methods in anonymous classes + - These sniffs would often throw the same error twice for functions in nested classes + - Error messages have also been changed to be less confusing + - The full list of affected sniffs is: + - Generic.NamingConventions.CamelCapsFunctionName + - PEAR.NamingConventions.ValidFunctionName + - PSR1.Methods.CamelCapsMethodName + - PSR2.Methods.MethodDeclaration + - Squiz.Scope.MethodScope + - Squiz.Scope.StaticThisUsage + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.CodeAnalysis.UnusedFunctionParameter now only skips functions with empty bodies when the class implements an interface + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.CodeAnalysis.UnusedFunctionParameter now has additional error codes to indicate where unused params were found + - The new error code prefixes are: + - FoundInExtendedClass: when the class extends another + - FoundInImplementedInterface: when the class implements an interface + - Found: used in all other cases, including closures + - The new error code suffixes are: + - BeforeLastUsed: the unused param was positioned before the last used param in the function signature + - AfterLastUsed: the unused param was positioned after the last used param in the function signature + - This makes the new error code list for this sniff: + - Found + - FoundBeforeLastUsed + - FoundAfterLastUsed + - FoundInExtendedClass + - FoundInExtendedClassBeforeLastUsed + - FoundInExtendedClassAfterLastUsed + - FoundInImplementedInterface + - FoundInImplementedInterfaceBeforeLastUsed + - FoundInImplementedInterfaceAfterLastUsed + - These errors code make it easier for specific cases to be ignored or promoted using a ruleset.xml file + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Generic.Classes.DuplicateClassName now inspects traits for duplicate names as well as classes and interfaces + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- Generic.Files.InlineHTML now ignores a BOM at the start of the file + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- Generic.PHP.CharacterBeforePHPOpeningTag now ignores a BOM at the start of the file + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- Generic.Formatting.SpaceAfterCast now has a setting to specify how many spaces are required after a type cast + - Default remains 1 + - Override the "spacing" setting in a ruleset.xml file to change + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Formatting.SpaceAfterCast now has a setting to ignore newline characters after a type cast + - Default remains FALSE, so newlines are not allowed + - Override the "ignoreNewlines" setting in a ruleset.xml file to change + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Formatting.SpaceAfterNot now has a setting to specify how many spaces are required after a NOT operator + - Default remains 1 + - Override the "spacing" setting in a ruleset.xml file to change + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Formatting.SpaceAfterNot now has a setting to ignore newline characters after the NOT operator + - Default remains FALSE, so newlines are not allowed + - Override the "ignoreNewlines" setting in a ruleset.xml file to change + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PEAR.Functions.FunctionDeclaration now checks spacing before the opening parenthesis of functions with no body + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- PEAR.Functions.FunctionDeclaration now enforces no space before the semicolon in functions with no body + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- PSR2.Classes.PropertyDeclaration now checks the order of property modifier keywords + - This is a rule that is documented in PSR-2 but was not enforced by the included PSR2 standard until now + - This sniff is also able to fix the order of the modifier keywords if they are incorrect + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PSR2.Methods.MethodDeclaration now checks method declarations inside traits + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- Squiz.Commenting.InlineComment now has better detection of comment block boundaries +- Squiz.Classes.ClassFileName now checks that a trait name matches the filename + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- Squiz.Classes.SelfMemberReference now supports scoped declarations and anonymous classes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Classes.SelfMemberReference now fixes multiple errors at once, increasing fixer performance + - Thanks to [Gabriel Ostrolucký][@ostrolucky] for the patch +- Squiz.Functions.LowercaseFunctionKeywords now checks abstract and final prefixes, and auto-fixes errors + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Objects.ObjectMemberComma.Missing has been renamed to Squiz.Objects.ObjectMemberComma.Found + - The error is thrown when the comma is found but not required, so the error code was incorrect + - If you are referencing the old error code in a ruleset XML file, please use the new code instead + - If you wish to maintain backwards compatibility, you can provide rules for both the old and new codes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.ObjectOperatorSpacing is now more tolerant of parse errors +- Squiz.WhiteSpace.ObjectOperatorSpacing now fixes errors more efficiently + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed bug [#2109][sq-2109] : Generic.Functions.CallTimePassByReference false positive for bitwise and used in function argument +- Fixed bug [#2165][sq-2165] : Conflict between Squiz.Arrays.ArrayDeclaration and ScopeIndent sniffs when heredoc used in array +- Fixed bug [#2167][sq-2167] : Generic.WhiteSpace.ScopeIndent shows invalid error when scope opener indented inside inline HTML +- Fixed bug [#2178][sq-2178] : Generic.NamingConventions.ConstructorName matches methods in anon classes with same name as containing class + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2190][sq-2190] : PEAR.Functions.FunctionCallSignature incorrect error when encountering trailing PHPCS annotation + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2194][sq-2194] : Generic.Whitespace.LanguageConstructSpacing should not be checking namespace operators + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2202][sq-2202] : Squiz.WhiteSpace.OperatorSpacing throws error for negative index when using curly braces for string access + - Same issue fixed in Squiz.Formatting.OperatorBracket + - Thanks to [Andreas Buchenrieder][@anbuc] for the patch +- Fixed bug [#2210][sq-2210] : Generic.NamingConventions.CamelCapsFunctionName not ignoring SoapClient __getCookies() method + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2211][sq-2211] : PSR2.Methods.MethodDeclaration gets confused over comments between modifier keywords + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2212][sq-2212] : FUNCTION and CONST in use groups being tokenized as T_FUNCTION and T_CONST + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- Fixed bug [#2214][sq-2214] : File::getMemberProperties() is recognizing method params as properties + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2236][sq-2236] : Memory info measurement unit is Mb but probably should be MB +- Fixed bug [#2246][sq-2246] : CSS tokenizer does not tokenize class names correctly when they contain the string NEW + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2278][sq-2278] : Squiz.Operators.ComparisonOperatorUsage false positive when inline IF contained in parentheses + - Thanks to [Arnout Boks][@aboks] for the patch +- Fixed bug [#2284][sq-2284] : Squiz.Functions.FunctionDeclarationArgumentSpacing removing type hint during fixing + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#2297][sq-2297] : Anonymous class not tokenized correctly when used as argument to another anon class + - Thanks to [Michał Bundyra][@michalbundyra] for the patch + +[sq-2109]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2109 +[sq-2165]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2165 +[sq-2167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2167 +[sq-2178]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2178 +[sq-2190]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2190 +[sq-2194]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2194 +[sq-2202]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2202 +[sq-2210]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2210 +[sq-2211]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2211 +[sq-2212]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2212 +[sq-2214]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2214 +[sq-2236]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2236 +[sq-2246]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2246 +[sq-2278]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2278 +[sq-2284]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2284 +[sq-2297]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2297 + +## [3.3.2] - 2018-09-24 + +### Changed +- Fixed a problem where the report cache was not being cleared when the sniffs inside a standard were updated +- The info report (--report=info) now has improved formatting for metrics that span multiple lines + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The unit test runner now skips .bak files when looking for test cases + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The Squiz standard now ensures underscores are not used to indicate visibility of private members vars and methods + - Previously, this standard enforced the use of underscores +- Generic.PHP.NoSilencedErrors error messages now contain a code snippet to show the context of the error + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Arrays.ArrayDeclaration no longer reports errors for a comma on a line new after a here/nowdoc + - Also stops a parse error being generated when auto-fixing + - The SpaceBeforeComma error message has been changed to only have one data value instead of two +- Squiz.Commenting.FunctionComment no longer errors when trying to fix indents of multi-line param comments +- Squiz.Formatting.OperatorBracket now correctly fixes statements that contain strings +- Squiz.PHP.CommentedOutCode now ignores more @-style annotations and includes better comment block detection + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed a problem where referencing a relative file path in a ruleset XML file could add unnecessary sniff exclusions + - This didn't actually exclude anything, but caused verbose output to list strange exclusion rules +- Fixed bug [#2110][sq-2110] : Squiz.WhiteSpace.FunctionSpacing is removing indents from the start of functions when fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2115][sq-2115] : Squiz.Commenting.VariableComment not checking var types when the @var line contains a comment +- Fixed bug [#2120][sq-2120] : Tokenizer fails to match T_INLINE_ELSE when used after function call containing closure +- Fixed bug [#2121][sq-2121] : Squiz.PHP.DisallowMultipleAssignments false positive in while loop conditions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2127][sq-2127] : File::findExtendedClassName() doesn't support nested classes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2138][sq-2138] : Tokenizer detects wrong token for PHP ::class feature with spaces +- Fixed bug [#2143][sq-2143] : PSR2.Namespaces.UseDeclaration does not properly fix "use function" and "use const" statements + - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch +- Fixed bug [#2144][sq-2144] : Squiz.Arrays.ArrayDeclaration does incorrect align calculation in array with cyrillic keys +- Fixed bug [#2146][sq-2146] : Zend.Files.ClosingTag removes closing tag from end of file without inserting a semicolon +- Fixed bug [#2151][sq-2151] : XML schema not updated with the new array property syntax + +[sq-2110]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2110 +[sq-2115]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2115 +[sq-2120]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2120 +[sq-2121]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2121 +[sq-2127]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2127 +[sq-2138]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2138 +[sq-2143]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2143 +[sq-2144]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2144 +[sq-2146]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2146 +[sq-2151]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2151 + +## [3.3.1] - 2018-07-27 + +### Removed +- Support for HHVM has been dropped due to recent unfixed bugs and HHVM refocus on Hack only + - Thanks to [Walt Sorensen][@photodude] and [Juliette Reinders Folmer][@jrfnl] for helping to remove all HHVM exceptions from the core + +### Changed +- The full report (the default report) now has improved word wrapping for multi-line messages and sniff codes + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The summary report now sorts files based on their directory location instead of just a basic string sort + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The source report now orders error codes by name when they have the same number of errors + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The junit report no longer generates validation errors with the Jenkins xUnit plugin + - Thanks to [Nikolay Geo][@nicholascus] for the patch +- Generic.Commenting.DocComment no longer generates the SpacingBeforeTags error if tags are the first content in the docblock + - The sniff will still generate a MissingShort error if there is no short comment + - This allows the MissingShort error to be suppressed in a ruleset to make short descriptions optional +- Generic.Functions.FunctionCallArgumentSpacing now properly fixes multi-line function calls with leading commas + - Previously, newlines between function arguments would be removed + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.PHP.Syntax will now use PHP_BINARY instead of trying to discover the executable path + - This ensures that the sniff will always syntax check files using the PHP version that PHPCS is running under + - Setting the `php_path` config var will still override this value as normal + - Thanks to [Willem Stuursma-Ruwen][@willemstuursma] for the patch +- PSR2.Namespaces.UseDeclaration now supports commas at the end of group use declarations + - Also improves checking and fixing for use statements containing parse errors + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Arrays.ArrayDeclaration no longer removes the array opening brace while fixing + - This could occur when the opening brace was on a new line and the first array key directly followed + - This change also stops the KeyNotAligned error message being incorrectly reported in these cases +- Squiz.Arrays.ArrayDeclaration no longer tries to change multi-line arrays to single line when they contain comments + - Fixes a conflict between this sniff and some indentation sniffs +- Squiz.Classes.ClassDeclaration no longer enforces spacing rules when a class is followed by a function + - Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff +- The Squiz.Classes.ValidClassName.NotCamelCaps message now references PascalCase instead of CamelCase + - The "CamelCase class name" metric produced by the sniff has been changed to "PascalCase class name" + - This reflects the fact that the class name check is actually a Pascal Case check and not really Camel Case + - Thanks to [Tom H Anderson][@TomHAnderson] for the patch +- Squiz.Commenting.InlineComment no longer enforces spacing rules when an inline comment is followed by a docblock + - Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff +- Squiz.WhiteSpace.OperatorSpacing no longer tries to fix operator spacing if the next content is a comment on a new line + - Fixes a conflict between this sniff and the Squiz.Commenting.PostStatementComment sniff + - Also stops PHPCS annotations from being moved to a different line, potentially changing their meaning + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.FunctionSpacing no longer checks spacing of functions at the top of an embedded PHP block + - Fixes a conflict between this sniff and the Squiz.PHP.EmbeddedPHP sniff + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.MemberVarSpacing no longer checks spacing before member vars that come directly after methods + - Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff +- Squiz.WhiteSpace.SuperfluousWhitespace now recognizes unicode whitespace at the start and end of a file + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed bug [#2029][sq-2029] : Squiz.Scope.MemberVarScope throws fatal error when a property is found in an interface + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2047][sq-2047] : PSR12.Classes.ClassInstantiation false positive when instantiating class from array index +- Fixed bug [#2048][sq-2048] : GenericFormatting.MultipleStatementAlignment false positive when assigning values inside an array +- Fixed bug [#2053][sq-2053] : PSR12.Classes.ClassInstantiation incorrectly fix when using member vars and some variable formats +- Fixed bug [#2065][sq-2065] : Generic.ControlStructures.InlineControlStructure fixing fails when inline control structure contains closure +- Fixed bug [#2072][sq-2072] : Squiz.Arrays.ArrayDeclaration throws NoComma error when array value is a shorthand IF statement +- Fixed bug [#2082][sq-2082] : File with "defined() or define()" syntax triggers PSR1.Files.SideEffects.FoundWithSymbols +- Fixed bug [#2095][sq-2095] : PSR2.Namespaces.NamespaceDeclaration does not handle namespaces defined over multiple lines + +[sq-2029]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2029 +[sq-2047]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2047 +[sq-2048]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2048 +[sq-2053]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2053 +[sq-2065]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2065 +[sq-2072]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2072 +[sq-2082]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2082 +[sq-2095]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2095 + +## [3.3.0] - 2018-06-07 + +### Deprecated +- The Squiz.WhiteSpace.LanguageConstructSpacing sniff has been deprecated and will be removed in version 4 + - The sniff has been moved to the Generic standard, with a new code of Generic.WhiteSpace.LanguageConstructSpacing + - As soon as possible, replace all instances of the old sniff code with the new sniff code in your ruleset.xml files + - The existing Squiz sniff will continue to work until version 4 has been released + - The new Generic sniff now also checks many more language constructs to enforce additional spacing rules + - Thanks to [Mponos George][@gmponos] for the contribution +- The current method for setting array properties in ruleset files has been deprecated and will be removed in version 4 + - Currently, setting an array value uses the string syntax "print=>echo,create_function=>null" + - Now, individual array elements are specified using a new "element" tag with "key" and "value" attributes + - For example, element key="print" value="echo" + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- The T_ARRAY_HINT token has been deprecated and will be removed in version 4 + - The token was used to ensure array type hints were not tokenized as T_ARRAY, but no other type hints were given a special token + - Array type hints now use the standard T_STRING token instead + - Sniffs referencing this token type will continue to run without error until version 4, but will not find any T_ARRAY_HINT tokens +- The T_RETURN_TYPE token has been deprecated and will be removed in version 4 + - The token was used to ensure array/self/parent/callable return types were tokenized consistently + - For namespaced return types, only the last part of the string (the class name) was tokenized as T_RETURN_TYPE + - This was not consistent and so return types are now left using their original token types so they are not skipped by sniffs + - The exception are array return types, which are tokenized as T_STRING instead of T_ARRAY, as they are for type hints + - Sniffs referencing this token type will continue to run without error until version 4, but will not find any T_RETUTN_TYPE tokens + - To get the return type of a function, use the File::getMethodProperties() method, which now contains a "return_type" array index + - This contains the return type of the function or closer, or a blank string if not specified + - If the return type is nullable, the return type will contain the leading ? + - A nullable_return_type array index in the return value will also be set to true + - If the return type contains namespace information, it will be cleaned of whitespace and comments + - To access the original return value string, use the main tokens array + +### Added +- This release contains an incomplete version of the PSR-12 coding standard + - Errors found using this standard should be valid, but it will miss a lot of violations until it is complete + - If you'd like to test and help, you can use the standard by running PHPCS with --standard=PSR12 + +### Changed +- Config values set using --runtime-set now override any config values set in rulesets or the CodeSniffer.conf file +- You can now apply include-pattern rules to individual message codes in a ruleset like you can with exclude-pattern rules + - Previously, include-pattern rules only applied to entire sniffs + - If a message code has both include and exclude patterns, the exclude patterns will be ignored +- Using PHPCS annotations to selectively re-enable sniffs is now more flexible + - Previously, you could only re-enable a sniff/category/standard using the exact same code that was disabled + - Now, you can disable a standard and only re-enable a specific category or sniff + - Or, you can disable a specific sniff and have it re-enable when you re-enable the category or standard +- The value of array sniff properties can now be set using phpcs:set annotations + - e.g., phpcs:set Standard.Category.SniffName property[] key=>value,key2=>value2 + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- PHPCS annotations now remain as T_PHPCS_* tokens instead of reverting to comment tokens when --ignore-annotations is used + - This stops sniffs (especially commenting sniffs) from generating a large number of false errors when ignoring + - Any custom sniffs that are using the T_PHPCS_* tokens to detect annotations may need to be changed to ignore them + - Check $phpcsFile->config->annotations to see if annotations are enabled and ignore when false +- You can now use fully or partially qualified class names for custom reports instead of absolute file paths + - To support this, you must specify an autoload file in your ruleset.xml file and use it to register an autoloader + - Your autoloader will need to load your custom report class when requested + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The JSON report format now does escaping in error source codes as well as error messages + - Thanks to [Martin Vasel][@marvasDE] for the patch +- Invalid installed_paths values are now ignored instead of causing a fatal error +- Improved testability of custom rulesets by allowing the installed standards to be overridden + - Thanks to [Timo Schinkel][@timoschinkel] for the patch +- The key used for caching PHPCS runs now includes all set config values + - This fixes a problem where changing config values (e.g., via --runtime-set) used an incorrect cache file +- The "Function opening brace placement" metric has been separated into function and closure metrics in the info report + - Closures are no longer included in the "Function opening brace placement" metric + - A new "Closure opening brace placement" metric now shows information for closures +- Multi-line T_YIELD_FROM statements are now replicated properly for older PHP versions +- The PSR2 standard no longer produces 2 error messages when the AS keyword in a foreach loop is not lowercase +- Specifying a path to a non-existent dir when using the `--report-[reportType]=/path/to/report` CLI option no longer throws an exception + - This now prints a readable error message, as it does when using `--report-file` +- The File::getMethodParamaters() method now includes a type_hint_token array index in the return value + - Provides the position in the token stack of the first token in the type hint +- The File::getMethodProperties() method now includes a return_type_token array index in the return value + - Provides the position in the token stack of the first token in the return type +- The File::getTokensAsString() method can now optionally return original (non tab-replaced) content + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Removed Squiz.PHP.DisallowObEndFlush from the Squiz standard + - If you use this sniff and want to continue banning ob_end_flush(), use Generic.PHP.ForbiddenFunctions instead + - You will need to set the forbiddenFunctions property in your ruleset.xml file +- Removed Squiz.PHP.ForbiddenFunctions from the Squiz standard + - Replaced by using the forbiddenFunctions property of Generic.PHP.ForbiddenFunctions in the Squiz ruleset.xml + - Functionality of the Squiz standard remains the same, but the error codes are now different + - Previously, Squiz.PHP.ForbiddenFunctions.Found and Squiz.PHP.ForbiddenFunctions.FoundWithAlternative + - Now, Generic.PHP.ForbiddenFunctions.Found and Generic.PHP.ForbiddenFunctions.FoundWithAlternative +- Added new Generic.PHP.LowerCaseType sniff + - Ensures PHP types used for type hints, return types, and type casting are lowercase + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added new Generic.WhiteSpace.ArbitraryParenthesesSpacing sniff + - Generates an error for whitespace inside parenthesis that don't belong to a function call/declaration or control structure + - Generates a warning for any empty parenthesis found + - Allows the required spacing to be set using the spacing sniff property (default is 0) + - Allows newlines to be used by setting the ignoreNewlines sniff property (default is false) + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added new PSR12.Classes.ClassInstantiation sniff + - Ensures parenthesis are used when instantiating a new class +- Added new PSR12.Keywords.ShortFormTypeKeywords sniff + - Ensures the short form of PHP types is used when type casting +- Added new PSR12.Namespaces.CompundNamespaceDepth sniff + - Ensures compound namespace use statements have a max depth of 2 levels + - The max depth can be changed by setting the 'maxDepth' sniff property in a ruleset.xml file +- Added new PSR12.Operators.OperatorSpacing sniff + - Ensures operators are preceded and followed by at least 1 space +- Improved core support for grouped property declarations + - Also improves support in Squiz.WhiteSpace.ScopeKeywordSpacing and Squiz.WhiteSpace.MemberVarSpacing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Commenting.DocComment now produces a NonParamGroup error when tags are mixed in with the @param tag group + - It would previously throw either a NonParamGroup or ParamGroup error depending on the order of tags + - This change allows the NonParamGroup error to be suppressed in a ruleset to allow the @param group to contain other tags + - Thanks to [Phil Davis][@phil-davis] for the patch +- Generic.Commenting.DocComment now continues checks param tags even if the doc comment short description is missing + - This change allows the MissingShort error to be suppressed in a ruleset without all other errors being suppressed as well + - Thanks to [Phil Davis][@phil-davis] for the patch +- Generic.CodeAnalysis.AssignmentInCondition now reports a different error code for assignments found in WHILE conditions + - The return value of a function call is often assigned in a WHILE condition, so this change makes it easier to exclude these cases + - The new code for this error message is Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition + - The error code for all other cases remains as Generic.CodeAnalysis.AssignmentInCondition.Found + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Functions.OpeningFunctionBraceBsdAllman now longer leaves trailing whitespace when moving the opening brace during fixing + - Also applies to fixes made by PEAR.Functions.FunctionDeclaration and Squiz.Functions.MultiLineFunctionDeclaration +- Generic.WhiteSpace.ScopeIndent now does a better job of fixing the indent of multi-line comments +- Generic.WhiteSpace.ScopeIndent now does a better job of fixing the indent of PHP open and close tags +- PEAR.Commenting.FunctionComment now report a different error code for param comment lines with too much padding + - Previously, any lines of a param comment that don't start at the exact comment position got the same error code + - Now, only comment lines with too little padding use ParamCommentAlignment as they are clearly mistakes + - Comment lines with too much padding may be using precision alignment as now use ParamCommentAlignmentExceeded + - This allows for excessive padding to be excluded from a ruleset while continuing to enforce a minimum padding +- PEAR.WhiteSpace.ObjectOperatorIndent now checks the indent of more chained operators + - Previously, it only checked chains beginning with a variable + - Now, it checks chains beginning with function calls, static class names, etc +- Squiz.Arrays.ArrayDeclaration now continues checking array formatting even if the key indent is not correct + - Allows for using different array indent rules while still checking/fixing double arrow and value alignment +- Squiz.Commenting.BlockComment has improved support for tab-indented comments + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.BlockComment auto fixing no longer breaks when two block comments follow each other + - Also stopped single-line block comments from being auto fixed when they are embedded in other code + - Also fixed as issue found when PHPCS annotations were used inside a block comment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.BlockComment.LastLineIndent is now able to be fixed with phpcbf + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.BlockComment now aligns star-prefixed lines under the opening tag while fixing, instead of indenting them + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.FunctionComment.IncorrectTypeHint message no longer contains cut-off suggested type hints +- Squiz.Commenting.InlineComment now uses a new error code for inline comments at the end of a function + - Previously, all inline comments followed by a blank line threw a Squiz.Commenting.InlineComment.SpacingAfter error + - Now, inline comments at the end of a function will instead throw Squiz.Commenting.InlineComment.SpacingAfterAtFunctionEnd + - If you previously excluded SpacingAfter, add an exclusion for SpacingAfterAtFunctionEnd to your ruleset as well + - If you previously only included SpacingAfter, consider including SpacingAfterAtFunctionEnd as well + - The Squiz standard now excludes SpacingAfterAtFunctionEnd as the blank line is checked elsewhere + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.ControlStructures.ControlSignature now errors when a comment follows the closing brace of an earlier body + - Applies to catch, finally, else, elseif, and do/while structures + - The included PSR2 standard now enforces this rule + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Formatting.OperatorBracket.MissingBrackets message has been changed to remove the word "arithmetic" + - The sniff checks more than just arithmetic operators, so the message is now clearer +- Sniffs.Operators.ComparisonOperatorUsage now detects more cases of implicit true comparisons + - It could previously be confused by comparisons used as function arguments +- Squiz.PHP.CommentedOutCode now ignores simple @-style annotation comments so they are not flagged as commented out code + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.PHP.CommentedOutCode now ignores a greater number of short comments so they are not flagged as commented out code + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.PHP.DisallowComparisonAssignment no longer errors when using the null coalescing operator + - Given this operator is used almost exclusively to assign values, it didn't make sense to generate an error +- Squiz.WhiteSpacing.FunctionSpacing now has a property to specify how many blank lines should be before the first class method + - Only applies when a method is the first code block in a class (i.e., there are no member vars before it) + - Override the 'spacingBeforeFirst' property in a ruleset.xml file to change + - If not set, the sniff will use whatever value is set for the existing 'spacing' property +- Squiz.WhiteSpacing.FunctionSpacing now has a property to specify how many blank lines should be after the last class method + - Only applies when a method is the last code block in a class (i.e., there are no member vars after it) + - Override the 'spacingAfterLast' property in a ruleset.xml file to change + - If not set, the sniff will use whatever value is set for the existing 'spacing' property + +### Fixed +- Fixed bug [#1863][sq-1863] : File::findEndOfStatement() not working when passed a scope opener +- Fixed bug [#1876][sq-1876] : PSR2.Namespaces.UseDeclaration not giving error for use statements before the namespace declaration + - Adds a new PSR2.Namespaces.UseDeclaration.UseBeforeNamespace error message +- Fixed bug [#1881][sq-1881] : Generic.Arrays.ArrayIndent is indenting sub-arrays incorrectly when comma not used after the last value +- Fixed bug [#1882][sq-1882] : Conditional with missing braces confused by indirect variables +- Fixed bug [#1915][sq-1915] : JS tokenizer fails to tokenize regular expression proceeded by boolean not operator +- Fixed bug [#1920][sq-1920] : Directory exclude pattern improperly excludes files with names that start the same + - Thanks to [Jeff Puckett][@jpuck] for the patch +- Fixed bug [#1922][sq-1922] : Equal sign alignment check broken when list syntax used before assignment operator +- Fixed bug [#1925][sq-1925] : Generic.Formatting.MultipleStatementAlignment skipping assignments within closures +- Fixed bug [#1931][sq-1931] : Generic opening brace placement sniffs do not correctly support function return types +- Fixed bug [#1932][sq-1932] : Generic.ControlStructures.InlineControlStructure fixer moves new PHPCS annotations +- Fixed bug [#1938][sq-1938] : Generic opening brace placement sniffs incorrectly move PHPCS annotations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1939][sq-1939] : phpcs:set annotations do not cause the line they are on to be ignored + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1949][sq-1949] : Squiz.PHP.DisallowMultipleAssignments false positive when using namespaces with static assignments +- Fixed bug [#1959][sq-1959] : SquizMultiLineFunctionDeclaration error when param has trailing comment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1963][sq-1963] : Squiz.Scope.MemberVarScope does not work for multiline member declaration + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1971][sq-1971] : Short array list syntax not correctly tokenized if short array is the first content in a file +- Fixed bug [#1979][sq-1979] : Tokenizer does not change heredoc to nowdoc token if the start tag contains spaces +- Fixed bug [#1982][sq-1982] : Squiz.Arrays.ArrayDeclaration fixer sometimes puts a comma in front of the last array value +- Fixed bug [#1993][sq-1993] : PSR1/PSR2 not reporting or fixing short open tags +- Fixed bug [#1996][sq-1996] : Custom report paths don't work on case-sensitive filesystems +- Fixed bug [#2006][sq-2006] : Squiz.Functions.FunctionDeclarationArgumentSpacing fixer removes comment between parens when no args + - The SpacingAfterOpenHint error message has been removed + - It is replaced by the existing SpacingAfterOpen message + - The error message format for the SpacingAfterOpen and SpacingBeforeClose messages has been changed + - These used to contain 3 pieces of data, but now only contain 2 + - If you have customised the error messages of this sniff, please review your ruleset after upgrading +- Fixed bug [#2018][sq-2018] : Generic.Formatting.MultipleStatementAlignment does see PHP close tag as end of statement block + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#2027][sq-2027] : PEAR.NamingConventions.ValidFunctionName error when function name includes double underscore + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-1863]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1863 +[sq-1876]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1876 +[sq-1881]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1881 +[sq-1882]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1882 +[sq-1915]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1915 +[sq-1920]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1920 +[sq-1922]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1922 +[sq-1925]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1925 +[sq-1931]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1931 +[sq-1932]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1932 +[sq-1938]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1938 +[sq-1939]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1939 +[sq-1949]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1949 +[sq-1959]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1959 +[sq-1963]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1963 +[sq-1971]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1971 +[sq-1979]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1979 +[sq-1982]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1982 +[sq-1993]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1993 +[sq-1996]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1996 +[sq-2006]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2006 +[sq-2018]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2018 +[sq-2027]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2027 + +## [3.2.3] - 2018-02-21 + +### Changed +- The new phpcs: comment syntax can now be prefixed with an at symbol ( @phpcs: ) + - This restores the behaviour of the previous syntax where these comments are ignored by doc generators +- The current PHP version ID is now used to generate cache files + - This ensures that only cache files generated by the current PHP version are selected + - This change fixes caching issues when using sniffs that produce errors based on the current PHP version +- A new Tokens::$phpcsCommentTokens array is now available for sniff developers to detect phpcs: comment syntax + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The PEAR.Commenting.FunctionComment.Missing error message now includes the name of the function + - Thanks to [Yorman Arias][@cixtor] for the patch +- The PEAR.Commenting.ClassComment.Missing and Squiz.Commenting.ClassComment.Missing error messages now include the name of the class + - Thanks to [Yorman Arias][@cixtor] for the patch +- PEAR.Functions.FunctionCallSignature now only forces alignment at a specific tab stop while fixing + - It was enforcing this during checking, but this meant invalid errors if the OpeningIndent message was being muted + - This fixes incorrect errors when using the PSR2 standard with some code blocks +- Generic.Files.LineLength now ignores lines that only contain phpcs: annotation comments + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.Formatting.MultipleStatementAlignment now skips over arrays containing comments + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.PHP.Syntax now forces display_errors to ON when linting + - Thanks to [Raúl Arellano][@raul338] for the patch +- PSR2.Namespaces.UseDeclaration has improved syntax error handling and closure detection + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.PHP.CommentedOutCode now has improved comment block detection for improved accuracy + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.PHP.NonExecutableCode could fatal error while fixing file with syntax error +- Squiz.PHP.NonExecutableCode now detects unreachable code after a goto statement + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.LanguageConstructSpacing has improved syntax error handling while fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Improved phpcs: annotation syntax handling for a number of sniffs + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Improved auto-fixing of files with incomplete comment blocks for various commenting sniffs + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed test suite compatibility with PHPUnit 7 +- Fixed bug [#1793][sq-1793] : PSR2 forcing exact indent for function call opening statements +- Fixed bug [#1803][sq-1803] : Squiz.WhiteSpace.ScopeKeywordSpacing removes member var name while fixing if no space after scope keyword +- Fixed bug [#1817][sq-1817] : Blank line not enforced after control structure if comment on same line as closing brace +- Fixed bug [#1827][sq-1827] : A phpcs:enable comment is not tokenized correctly if it is outside a phpcs:disable block + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1828][sq-1828] : Squiz.WhiteSpace.SuperfluousWhiteSpace ignoreBlankLines property ignores whitespace after single line comments + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1840][sq-1840] : When a comment has too many asterisks, phpcbf gives FAILED TO FIX error +- Fixed bug [#1867][sq-1867] : Can't use phpcs:ignore where the next line is HTML +- Fixed bug [#1870][sq-1870] : Invalid warning in multiple assignments alignment with closure or anon class +- Fixed bug [#1890][sq-1890] : Incorrect Squiz.WhiteSpace.ControlStructureSpacing.NoLineAfterClose error between catch and finally statements +- Fixed bug [#1891][sq-1891] : Comment on last USE statement causes false positive for PSR2.Namespaces.UseDeclaration.SpaceAfterLastUse + - Thanks to [Matt Coleman][@iammattcoleman], [Daniel Hensby][@dhensby], and [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1901][sq-1901] : Fixed PHPCS annotations in multi-line tab-indented comments + not ignoring whole line for phpcs:set + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-1793]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1793 +[sq-1803]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1803 +[sq-1817]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1817 +[sq-1827]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1827 +[sq-1828]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1828 +[sq-1840]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1840 +[sq-1867]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1867 +[sq-1870]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1870 +[sq-1890]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1890 +[sq-1891]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1891 +[sq-1901]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1901 + +## [3.2.2] - 2017-12-20 + +### Changed +- Disabled STDIN detection on Windows + - This fixes a problem with IDE plugins (e.g., PHPStorm) hanging on Windows + +## [3.2.1] - 2017-12-18 + +### Changed +- Empty diffs are no longer followed by a newline character (request [#1781][sq-1781]) +- Generic.Functions.OpeningFunctionBraceKernighanRitchie no longer complains when the open brace is followed by a close tag + - This makes the sniff more useful when used in templates + - Thanks to [Joseph Zidell][@josephzidell] for the patch + +### Fixed +- Fixed problems with some scripts and plugins waiting for STDIN + - This was a notable problem with IDE plugins (e.g., PHPStorm) and build systems +- Fixed bug [#1782][sq-1782] : Incorrect detection of operator in ternary + anonymous function + +[sq-1781]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1781 +[sq-1782]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1782 + +## [3.2.0] - 2017-12-13 + +### Deprecated +- This release deprecates the @codingStandards comment syntax used for sending commands to PHP_CodeSniffer + - The existing syntax will continue to work in all version 3 releases, but will be removed in version 4 + - The comment formats have been replaced by a shorter syntax: + - @codingStandardsIgnoreFile becomes phpcs:ignoreFile + - @codingStandardsIgnoreStart becomes phpcs:disable + - @codingStandardsIgnoreEnd becomes phpcs:enable + - @codingStandardsIgnoreLine becomes phpcs:ignore + - @codingStandardsChangeSetting becomes phpcs:set + - The new syntax allows for additional developer comments to be added after a -- separator + - This is useful for describing why a code block is being ignored, or why a setting is being changed + - E.g., phpcs:disable -- This code block must be left as-is. + - Comments using the new syntax are assigned new comment token types to allow them to be detected: + - phpcs:ignoreFile has the token T_PHPCS_IGNORE_FILE + - phpcs:disable has the token T_PHPCS_DISABLE + - phpcs:enable has the token T_PHPCS_ENABLE + - phpcs:ignore has the token T_PHPCS_IGNORE + - phpcs:set has the token T_PHPCS_SET + +### Changed +- The phpcs:disable and phpcs:ignore comments can now selectively ignore specific sniffs (request [#604][sq-604]) + - E.g., phpcs:disable Generic.Commenting.Todo.Found for a specific message + - E.g., phpcs:disable Generic.Commenting.Todo for a whole sniff + - E.g., phpcs:disable Generic.Commenting for a whole category of sniffs + - E.g., phpcs:disable Generic for a whole standard + - Multiple sniff codes can be specified by comma separating them + - E.g., phpcs:disable Generic.Commenting.Todo,PSR1.Files +- @codingStandardsIgnoreLine comments now only ignore the following line if they are on a line by themselves + - If they are at the end of an existing line, they will only ignore the line they are on + - Stops some lines from accidentally being ignored + - Same rule applies for the new phpcs:ignore comment syntax +- PSR1.Files.SideEffects now respects the new phpcs:disable comment syntax + - The sniff will no longer check any code that is between phpcs:disable and phpcs:enable comments + - The sniff does not support phpcs:ignore; you must wrap code structures with disable/enable comments + - Previously, there was no way to have this sniff ignore parts of a file +- Fixed a problem where PHPCS would sometimes hang waiting for STDIN, or read incomplete versions of large files + - Thanks to [Arne Jørgensen][@arnested] for the patch +- Array properties specified in ruleset files now have their keys and values trimmed + - This saves having to do this in individual sniffs and stops errors introduced by whitespace in rulesets + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Added phpcs.xsd to allow validation of ruleset XML files + - Thanks to [Renaat De Muynck][@renaatdemuynck] for the contribution +- File paths specified using --stdin-path can now point to fake file locations (request [#1488][sq-1488]) + - Previously, STDIN files using fake file paths were excluded from checking +- Setting an empty basepath (--basepath=) on the CLI will now clear a basepath set directly in a ruleset + - Thanks to [Xaver Loppenstedt][@xalopp] for the patch +- Ignore patterns are now checked on symlink target paths instead of symlink source paths + - Restores previous behaviour of this feature +- Metrics were being double counted when multiple sniffs were recording the same metric +- Added support for bash process substitution + - Thanks to [Scott Dutton][@exussum12] for the contribution +- Files included in the cache file code hash are now sorted to aid in cache file reuse across servers +- Windows BAT files can now be used outside a PEAR install + - You must have the path to PHP set in your PATH environment variable + - Thanks to [Joris Debonnet][@JorisDebonnet] for the patch +- The JS unsigned right shift assignment operator is now properly classified as an assignment operator + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- The AbstractVariableSniff abstract sniff now supports anonymous classes and nested functions + - Also fixes an issue with Squiz.Scope.MemberVarScope where member vars of anonymous classes were not being checked +- Added AbstractArraySniff to make it easier to create sniffs that check array formatting + - Allows for checking of single and multi line arrays easily + - Provides a parsed structure of the array including positions of keys, values, and double arrows +- Added Generic.Arrays.ArrayIndent to enforce a single tab stop indent for array keys in multi-line arrays + - Also ensures the close brace is on a new line and indented to the same level as the original statement + - Allows for the indent size to be set using an "indent" property of the sniff +- Added Generic.PHP.DiscourageGoto to warn about the use of the GOTO language construct + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Generic.Debug.ClosureLinter was not running the gjslint command + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Generic.WhiteSpace.DisallowSpaceIndent now fixes space indents in multi-line block comments + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.WhiteSpace.DisallowSpaceIndent now fixes mixed space/tab indents more accurately + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.WhiteSpace.DisallowTabIndent now fixes tab indents in multi-line block comments + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PEAR.Functions.FunctionDeclaration no longer errors when a function declaration is the first content in a JS file + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PEAR.Functions.FunctionCallSignature now requires the function name to be indented to an exact tab stop + - If the function name is not the start of the statement, the opening statement must be indented correctly instead + - Added a new fixable error code PEAR.Functions.FunctionCallSignature.OpeningIndent for this error +- Squiz.Functions.FunctionDeclarationArgumentSpacing is no longer confused about comments in function declarations + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.PHP.NonExecutableCode error messages now indicate which line the code block ending is on + - Makes it easier to identify where the code block exited or returned + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.Commenting.FunctionComment now supports nullable type hints +- Squiz.Commenting.FunctionCommentThrowTag no longer assigns throw tags inside anon classes to the enclosing function +- Squiz.WhiteSpace.SemicolonSpacing now ignores semicolons used for empty statements inside FOR conditions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.ControlStructures.ControlSignature now allows configuring the number of spaces before the colon in alternative syntax + - Override the 'requiredSpacesBeforeColon' setting in a ruleset.xml file to change + - Default remains at 1 + - Thanks to [Nikola Kovacs][@nkovacs] for the patch +- The Squiz standard now ensures array keys are indented 4 spaces from the main statement + - Previously, this standard aligned keys 1 space from the start of the array keyword +- The Squiz standard now ensures array end braces are aligned with the main statement + - Previously, this standard aligned the close brace with the start of the array keyword +- The standard for PHP_CodeSniffer itself now enforces short array syntax +- The standard for PHP_CodeSniffer itself now uses the Generic.Arrays/ArrayIndent sniff rules +- Improved fixer conflicts and syntax error handling for a number of sniffs + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed bug [#1462][sq-1462] : Error processing cyrillic strings in Tokenizer +- Fixed bug [#1573][sq-1573] : Squiz.WhiteSpace.LanguageConstructSpacing does not properly check for tabs and newlines + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#1590][sq-1590] : InlineControlStructure CBF issue while adding braces to an if that's returning a nested function +- Fixed bug [#1718][sq-1718] : Unclosed strings at EOF sometimes tokenized as T_WHITESPACE by the JS tokenizer +- Fixed bug [#1731][sq-1731] : Directory exclusions do not work as expected when a single file name is passed to phpcs +- Fixed bug [#1737][sq-1737] : Squiz.CSS.EmptyStyleDefinition sees comment as style definition and fails to report error +- Fixed bug [#1746][sq-1746] : Very large reports can sometimes become garbled when using the parallel option +- Fixed bug [#1747][sq-1747] : Squiz.Scope.StaticThisUsage incorrectly looking inside closures +- Fixed bug [#1757][sq-1757] : Unknown type hint "object" in Squiz.Commenting.FunctionComment +- Fixed bug [#1758][sq-1758] : PHPCS gets stuck creating file list when processing circular symlinks +- Fixed bug [#1761][sq-1761] : Generic.WhiteSpace.ScopeIndent error on multi-line function call with static closure argument +- Fixed bug [#1762][sq-1762] : `Generic.WhiteSpace.Disallow[Space/Tab]Indent` not inspecting content before open tag + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1769][sq-1769] : Custom "define" function triggers a warning about declaring new symbols +- Fixed bug [#1776][sq-1776] : Squiz.Scope.StaticThisUsage incorrectly looking inside anon classes +- Fixed bug [#1777][sq-1777] : Generic.WhiteSpace.ScopeIndent incorrect indent errors when self called function proceeded by comment + +[sq-604]: https://github.com/squizlabs/PHP_CodeSniffer/issues/604 +[sq-1462]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1462 +[sq-1488]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1488 +[sq-1573]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1573 +[sq-1590]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1590 +[sq-1718]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1718 +[sq-1731]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1731 +[sq-1737]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1737 +[sq-1746]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1746 +[sq-1747]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1747 +[sq-1757]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1757 +[sq-1758]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1758 +[sq-1761]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1761 +[sq-1762]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1762 +[sq-1769]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1769 +[sq-1776]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1776 +[sq-1777]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1777 + +## [3.1.1] - 2017-10-17 + +### Changed +- Restored preference of non-dist files over dist files for phpcs.xml and phpcs.xml.dist + - The order that the files are searched is now: .phpcs.xml, phpcs.xml, .phpcs.xml.dist, phpcs.xml.dist + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Progress output now correctly shows skipped files +- Progress output now shows 100% when the file list has finished processing (request [#1697][sq-1697]) +- Stopped some IDEs complaining about testing class aliases + - Thanks to [Vytautas Stankus][@svycka] for the patch +- Squiz.Commenting.InlineComment incorrectly identified comment blocks in some cases, muting some errors + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +### Fixed +- Fixed bug [#1512][sq-1512] : PEAR.Functions.FunctionCallSignature enforces spaces when no arguments if required spaces is not 0 +- Fixed bug [#1522][sq-1522] : Squiz Arrays.ArrayDeclaration and Strings.ConcatenationSpacing fixers causing parse errors with here/nowdocs +- Fixed bug [#1570][sq-1570] : Squiz.Arrays.ArrayDeclaration fixer removes comments between array keyword and open parentheses +- Fixed bug [#1604][sq-1604] : File::isReference has problems with some bitwise operators and class property references + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1645][sq-1645] : Squiz.Commenting.InlineComment will fail to fix comments at the end of the file + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1656][sq-1656] : Using the --sniffs argument has a problem with case sensitivity +- Fixed bug [#1657][sq-1657] : Uninitialized string offset: 0 when sniffing CSS +- Fixed bug [#1669][sq-1669] : Temporary expression proceeded by curly brace is detected as function call +- Fixed bug [#1681][sq-1681] : Huge arrays are super slow to scan with Squiz.Arrays.ArrayDeclaration sniff +- Fixed bug [#1694][sq-1694] : Squiz.Arrays.ArrayBracketSpacing is removing some comments during fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1702][sq-1702] : Generic.WhiteSpaceDisallowSpaceIndent fixer bug when line only contains superfluous whitespace + +[sq-1512]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1512 +[sq-1522]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1522 +[sq-1570]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1570 +[sq-1604]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1604 +[sq-1645]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1645 +[sq-1656]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1656 +[sq-1657]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1657 +[sq-1669]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1669 +[sq-1681]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1681 +[sq-1694]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1694 +[sq-1697]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1697 +[sq-1702]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1702 + +## [3.1.0] - 2017-09-20 + +### Changed +- This release includes a change to support newer versions of PHPUnit (versions 4, 5, and 6 are now supported) + - The custom PHP_CodeSniffer test runner now requires a bootstrap file + - Developers with custom standards using the PHP_CodeSniffer test runner will need to do one of the following: + - run your unit tests from the PHP_CodeSniffer root dir so the bootstrap file is included + - specify the PHP_CodeSniffer bootstrap file on the command line: `phpunit --bootstrap=/path/to/phpcs/tests/bootstrap.php` + - require the PHP_CodeSniffer bootstrap file from your own bootstrap file + - If you don't run PHP_CodeSniffer unit tests, this change will not affect you + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- A phpcs.xml or phpcs.xml.dist file now takes precedence over the default_standard config setting + - Thanks to [Björn Fischer][@Fischer-Bjoern] for the patch +- Both phpcs.xml and phpcs.xml.dist files can now be prefixed with a dot (request [#1566][sq-1566]) + - The order that the files are searched is: .phpcs.xml, .phpcs.xml.dist, phpcs.xml, phpcs.xml.dist +- The autoloader will now search for files during unit tests runs from the same locations as during normal phpcs runs + - Allows for easier unit testing of custom standards that use helper classes or custom namespaces +- Include patterns for sniffs now use OR logic instead of AND logic + - Previously, a file had to be in each of the include patterns to be processed by a sniff + - Now, a file has to only be in at least one of the patterns + - This change reflects the original intention of the feature +- PHPCS will now follow symlinks under the list of checked directories + - This previously only worked if you specified the path to a symlink on the command line +- Output from --config-show, --config-set, and --config-delete now includes the path to the loaded config file +- PHPCS now cleanly exits if its config file is not readable + - Previously, a combination of PHP notices and PHPCS errors would be generated +- Comment tokens that start with /** are now always tokenized as docblocks + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- The PHP-supplied T_YIELD and T_YIELD_FROM token have been replicated for older PHP versions + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Added new Generic.CodeAnalysis.AssignmentInCondition sniff to warn about variable assignments inside conditions + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution +- Added Generic.Files.OneObjectStructurePerFile sniff to ensure there is a single class/interface/trait per file + - Thanks to [Mponos George][@gmponos] for the contribution +- Function call sniffs now check variable function names and self/static object creation + - Specific sniffs are Generic.Functions.FunctionCallArgumentSpacing, PEAR.Functions.FunctionCallSignature, and PSR2.Methods.FunctionCallSignature + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Generic.Files.LineLength can now be configured to ignore all comment lines, no matter their length + - Set the ignoreComments property to TRUE (default is FALSE) in your ruleset.xml file to enable this + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Generic.PHP.LowerCaseKeyword now checks self, parent, yield, yield from, and closure (function) keywords + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- PEAR.Functions.FunctionDeclaration now removes a blank line if it creates one by moving the curly brace during fixing +- Squiz.Commenting.FunctionCommentThrowTag now supports PHP 7.1 multi catch exceptions +- Squiz.Formatting.OperatorBracket no longer throws errors for PHP 7.1 multi catch exceptions +- Squiz.Commenting.LongConditionClosingComment now supports finally statements +- Squiz.Formatting.OperatorBracket now correctly fixes pipe separated flags +- Squiz.Formatting.OperatorBracket now correctly fixes statements containing short array syntax +- Squiz.PHP.EmbeddedPhp now properly fixes cases where the only content in an embedded PHP block is a comment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Squiz.WhiteSpace.ControlStructureSpacing now ignores comments when checking blank lines at the top of control structures +- Squiz.WhiteSpace.ObjectOperatorSpacing now detects and fixes spaces around double colons + - Thanks to [Julius Šmatavičius][@bondas83] for the patch +- Squiz.WhiteSpace.MemberVarSpacing can now be configured to check any number of blank lines between member vars + - Set the spacing property (default is 1) in your ruleset.xml file to set the spacing +- Squiz.WhiteSpace.MemberVarSpacing can now be configured to check a different number of blank lines before the first member var + - Set the spacingBeforeFirst property (default is 1) in your ruleset.xml file to set the spacing +- Added a new PHP_CodeSniffer\Util\Tokens::$ooScopeTokens static member var for quickly checking object scope + - Includes T_CLASS, T_ANON_CLASS, T_INTERFACE, and T_TRAIT + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- PHP_CodeSniffer\Files\File::findExtendedClassName() now supports extended interfaces + - Thanks to [Martin Hujer][@mhujer] for the patch + +### Fixed +- Fixed bug [#1550][sq-1550] : Squiz.Commenting.FunctionComment false positive when function contains closure +- Fixed bug [#1577][sq-1577] : Generic.InlineControlStructureSniff breaks with a comment between body and condition in do while loops +- Fixed bug [#1581][sq-1581] : Sniffs not loaded when one-standard directories are being registered in installed_paths +- Fixed bug [#1591][sq-1591] : Autoloader failing to load arbitrary files when installed_paths only set via a custom ruleset +- Fixed bug [#1605][sq-1605] : Squiz.WhiteSpace.OperatorSpacing false positive on unary minus after comment + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1615][sq-1615] : Uncaught RuntimeException when phpcbf fails to fix files +- Fixed bug [#1637][sq-1637] : Generic.WhiteSpaceScopeIndent closure argument indenting incorrect with multi-line strings +- Fixed bug [#1638][sq-1638] : Squiz.WhiteSpace.ScopeClosingBrace closure argument indenting incorrect with multi-line strings +- Fixed bug [#1640][sq-1640] : Squiz.Strings.DoubleQuoteUsage replaces tabs with spaces when fixing + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch + +[sq-1550]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1550 +[sq-1566]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1566 +[sq-1577]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1577 +[sq-1581]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1581 +[sq-1591]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1591 +[sq-1605]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1605 +[sq-1615]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1615 +[sq-1637]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1637 +[sq-1638]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1638 +[sq-1640]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1640 + +## [3.0.2] - 2017-07-18 + +### Changed +- The code report now gracefully handles tokenizer exceptions +- The phpcs and phpcbf scripts are now the only places that exit() in the code + - This allows for easier usage of core PHPCS functions from external scripts + - If you are calling Runner::runPHPCS() or Runner::runPHPCBF() directly, you will get back the full range of exit codes + - If not, catch the new DeepExitException to get the error message ($e->getMessage()) and exit code ($e->getCode()); +- NOWDOC tokens are now considered conditions, just as HEREDOC tokens are + - This makes it easier to find the start and end of a NOWDOC from any token within it + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Custom autoloaders are now only included once in case multiple standards are using the same one + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Improved tokenizing of fallthrough CASE and DEFAULT statements that share a closing statement and use curly braces +- Improved the error message when Squiz.ControlStructures.ControlSignature detects a newline after the closing parenthesis + +### Fixed +- Fixed a problem where the source report was not printing the correct number of errors found +- Fixed a problem where the --cache=/path/to/cachefile CLI argument was not working +- Fixed bug [#1465][sq-1465] : Generic.WhiteSpace.ScopeIndent reports incorrect errors when indenting double arrows in short arrays +- Fixed bug [#1478][sq-1478] : Indentation in fallthrough CASE that contains a closure +- Fixed bug [#1497][sq-1497] : Fatal error if composer prepend-autoloader is set to false + - Thanks to [Kunal Mehta][@legoktm] for the patch +- Fixed bug [#1503][sq-1503] : Alternative control structure syntax not always recognized as scoped +- Fixed bug [#1523][sq-1523] : Fatal error when using the --suffix argument + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1526][sq-1526] : Use of basepath setting can stop PHPCBF being able to write fixed files +- Fixed bug [#1530][sq-1530] : Generic.WhiteSpace.ScopeIndent can increase indent too much for lines within code blocks +- Fixed bug [#1547][sq-1547] : Wrong token type for backslash in use function + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#1549][sq-1549] : Squiz.PHP.EmbeddedPhp fixer conflict with // comment before PHP close tag + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1560][sq-1560] : Squiz.Commenting.FunctionComment fatal error when fixing additional param comment lines that have no indent + +[sq-1465]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1465 +[sq-1478]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1478 +[sq-1497]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1497 +[sq-1503]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1503 +[sq-1523]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1523 +[sq-1526]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1526 +[sq-1530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1530 +[sq-1547]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1547 +[sq-1549]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1549 +[sq-1560]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1560 + +## [3.0.1] - 2017-06-14 + +### Security +- This release contains a fix for a security advisory related to the improper handling of a shell command + - A properly crafted filename would allow for arbitrary code execution when using the --filter=gitmodified command line option + - All version 3 users are encouraged to upgrade to this version, especially if you are checking 3rd-party code + - e.g., you run PHPCS over libraries that you did not write + - e.g., you provide a web service that runs PHPCS over user-uploaded files or 3rd-party repositories + - e.g., you allow external tool paths to be set by user-defined values + - If you are unable to upgrade but you check 3rd-party code, ensure you are not using the Git modified filter + - This advisory does not affect PHP_CodeSniffer version 2. + - Thanks to [Sergei Morozov][@morozov] for the report and patch + +### Changed +- Arguments on the command line now override or merge with those specified in a ruleset.xml file in all cases +- PHPCS now stops looking for a phpcs.xml file as soon as one is found, favoring the closest one to the current dir +- Added missing help text for the --stdin-path CLI option to --help +- Re-added missing help text for the --file-list and --bootstrap CLI options to --help +- Runner::runPHPCS() and Runner::runPHPCBF() now return an exit code instead of exiting directly (request [#1484][sq-1484]) +- The Squiz standard now enforces short array syntax by default +- The autoloader is now working correctly with classes created with class_alias() +- The autoloader will now search for files inside all directories in the installed_paths config var + - This allows autoloading of files inside included custom coding standards without manually requiring them +- You can now specify a namespace for a custom coding standard, used by the autoloader to load non-sniff helper files + - Also used by the autoloader to help other standards directly include sniffs for your standard + - Set the value to the namespace prefix you are using for sniff files (everything up to \Sniffs\) + - e.g., if your namespace format is MyProject\CS\Standard\Sniffs\Category set the namespace to MyProject\CS\Standard + - If omitted, the namespace is assumed to be the same as the directory name containing the ruleset.xml file + - The namespace is set in the ruleset tag of the ruleset.xml file + - e.g., ruleset name="My Coding Standard" namespace="MyProject\CS\Standard" +- Rulesets can now specify custom autoloaders using the new autoload tag + - Autoloaders are included while the ruleset is being processed and before any custom sniffs are included + - Allows for very custom autoloading of helper classes well before the boostrap files are included +- The PEAR standard now includes Squiz.Commenting.DocCommentAlignment + - It previously broke comments onto multiple lines, but didn't align them + +### Fixed +- Fixed a problem where excluding a message from a custom standard's own sniff would exclude the whole sniff + - This caused some PSR2 errors to be under-reported +- Fixed bug [#1442][sq-1442] : T_NULLABLE detection not working for nullable parameters and return type hints in some cases +- Fixed bug [#1447][sq-1447] : Running the unit tests with a PHPUnit config file breaks the test suite + - Unknown arguments were not being handled correctly, but are now stored in $config->unknown +- Fixed bug [#1449][sq-1449] : Generic.Classes.OpeningBraceSameLine doesn't detect comment before opening brace + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1450][sq-1450] : Coding standard located under an installed_path with the same directory name throws an error + - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch +- Fixed bug [#1451][sq-1451] : Sniff exclusions/restrictions don't work with custom sniffs unless they use the PHP_CodeSniffer NS +- Fixed bug [#1454][sq-1454] : Squiz.WhiteSpace.OperatorSpacing is not checking spacing on either side of a short ternary operator + - Thanks to [Mponos George][@gmponos] for the patch +- Fixed bug [#1495][sq-1495] : Setting an invalid installed path breaks all commands +- Fixed bug [#1496][sq-1496] : Squiz.Strings.DoubleQuoteUsage not unescaping dollar sign when fixing + - Thanks to [Michał Bundyra][@michalbundyra] for the patch +- Fixed bug [#1501][sq-1501] : Interactive mode is broken +- Fixed bug [#1504][sq-1504] : PSR2.Namespaces.UseDeclaration hangs fixing use statement with no trailing code + +[sq-1442]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1442 +[sq-1447]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1447 +[sq-1449]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1449 +[sq-1450]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1450 +[sq-1451]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1451 +[sq-1454]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1454 +[sq-1484]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1484 +[sq-1495]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1495 +[sq-1496]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1496 +[sq-1501]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1501 +[sq-1504]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1504 + + +## [3.0.0] - 2017-05-04 + +### Changed +- Added an --ignore-annotations command line argument to ignore all @codingStandards annotations in code comments (request [#811][sq-811]) +- This allows you to force errors to be shown that would otherwise be ignored by code comments + - Also stop files being able to change sniff properties midway through processing +- An error is now reported if no sniffs were registered to be run (request [#1129][sq-1129]) +- The autoloader will now search for files inside the directory of any loaded coding standard + - This allows autoloading of any file inside a custom coding standard without manually requiring them + - Ensure your namespace begins with your coding standard's directory name and follows PSR-4 + - e.g., StandardName\Sniffs\CategoryName\AbstractHelper or StandardName\Helpers\StringSniffHelper +- Fixed an error where STDIN was sometimes not checked when using the --parallel CLI option +- The is_closure index has been removed from the return value of File::getMethodProperties() + - This value was always false because T_FUNCTION tokens are never closures + - Closures have a token type of T_CLOSURE +- The File::isAnonymousFunction() method has been removed + - This function always returned false because it only accepted T_FUNCTION tokens, which are never closures + - Closures have a token type of T_CLOSURE +- Includes all changes from the 2.9.0 release + +### Fixed +- Fixed bug [#834][sq-834] : PSR2.ControlStructures.SwitchDeclaration does not handle if branches with returns + - Thanks to [Fabian Wiget][@fabacino] for the patch + +[sq-811]: https://github.com/squizlabs/PHP_CodeSniffer/issues/811 +[sq-834]: https://github.com/squizlabs/PHP_CodeSniffer/issues/834 +[sq-1129]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1129 + +## [3.0.0RC4] - 2017-03-02 + +### Security +- This release contains a fix for a security advisory related to the improper handling of shell commands + - Uses of shell_exec() and exec() were not escaping filenames and configuration settings in most cases + - A properly crafted filename or configuration option would allow for arbitrary code execution when using some features + - All users are encouraged to upgrade to this version, especially if you are checking 3rd-party code + - e.g., you run PHPCS over libraries that you did not write + - e.g., you provide a web service that runs PHPCS over user-uploaded files or 3rd-party repositories + - e.g., you allow external tool paths to be set by user-defined values + - If you are unable to upgrade but you check 3rd-party code, ensure you are not using the following features: + - The diff report + - The notify-send report + - The Generic.PHP.Syntax sniff + - The Generic.Debug.CSSLint sniff + - The Generic.Debug.ClosureLinter sniff + - The Generic.Debug.JSHint sniff + - The Squiz.Debug.JSLint sniff + - The Squiz.Debug.JavaScriptLint sniff + - The Zend.Debug.CodeAnalyzer sniff + - Thanks to [Klaus Purer][@klausi] for the report + +### Changed +- The indent property of PEAR.Classes.ClassDeclaration has been removed + - Instead of calculating the indent of the brace, it just ensures the brace is aligned with the class keyword + - Other sniffs can be used to ensure the class itself is indented correctly +- Invalid exclude rules inside a ruleset.xml file are now ignored instead of potentially causing out of memory errors + - Using the -vv command line argument now also shows the invalid exclude rule as XML +- Includes all changes from the 2.8.1 release + +### Fixed +- Fixed bug [#1333][sq-1333] : The new autoloader breaks some frameworks with custom autoloaders +- Fixed bug [#1334][sq-1334] : Undefined offset when explaining standard with custom sniffs + +[sq-1333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1333 +[sq-1334]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1334 + +## [3.0.0RC3] - 2017-02-02 + +### Changed +- Added support for ES6 class declarations + - Previously, these class were tokenized as JS objects but are now tokenized as normal T_CLASS structures +- Added support for ES6 method declarations, where the "function" keyword is not used + - Previously, these methods were tokenized as JS objects (fixes bug [#1251][sq-1251]) + - The name of the ES6 method is now assigned the T_FUNCTION keyword and treated like a normal function + - Custom sniffs that support JS and listen for T_FUNCTION tokens can't assume the token represents the word "function" + - Check the contents of the token first, or use $phpcsFile->getDeclarationName($stackPtr) if you just want its name + - There is no change for custom sniffs that only check PHP code +- PHPCBF exit codes have been changed so they are now more useful (request [#1270][sq-1270]) + - Exit code 0 is now used to indicate that no fixable errors were found, and so nothing was fixed + - Exit code 1 is now used to indicate that all fixable errors were fixed correctly + - Exit code 2 is now used to indicate that PHPCBF failed to fix some of the fixable errors it found + - Exit code 3 is now used for general script execution errors +- Added PEAR.Commenting.FileComment.ParamCommentAlignment to check alignment of multi-line param comments +- Includes all changes from the 2.8.0 release + +### Fixed +- Fixed an issue where excluding a file using a @codingStandardsIgnoreFile comment would produce errors + - For PHPCS, it would show empty files being processed + - For PHPCBF, it would produce a PHP error +- Fixed bug [#1233][sq-1233] : Can't set config data inside ruleset.xml file +- Fixed bug [#1241][sq-1241] : CodeSniffer.conf not working with 3.x PHAR file + +[sq-1233]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1233 +[sq-1241]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1241 +[sq-1251]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1251 +[sq-1270]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1270 + +## [3.0.0RC2] - 2016-11-30 + +### Changed +- Made the Runner class easier to use with wrapper scripts +- Full usage information is no longer printed when a usage error is encountered (request [#1186][sq-1186]) + - Makes it a lot easier to find and read the error message that was printed +- Includes all changes from the 2.7.1 release + +### Fixed +- Fixed an undefined var name error that could be produced while running PHPCBF +- Fixed bug [#1167][sq-1167] : 3.0.0RC1 PHAR does not work with PEAR standard +- Fixed bug [#1208][sq-1208] : Excluding files doesn't work when using STDIN with a filename specified + +[sq-1167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1167 +[sq-1186]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1186 +[sq-1208]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1208 + +## [3.0.0RC1] - 2016-09-02 + +### Changed +- Progress output now shows E and W in green when a file has fixable errors or warnings + - Only supported if colors are enabled +- PHPCBF no longer produces verbose output by default (request [#699][sq-699]) + - Use the -v command line argument to show verbose fixing output + - Use the -q command line argument to disable verbose information if enabled by default +- PHPBF now prints a summary report after fixing files + - Report shows files that were fixed, how many errors were fixed, and how many remain +- PHPCBF now supports the -p command line argument to print progress information + - Prints a green F for files where fixes occurred + - Prints a red E for files that could not be fixed due to an error + - Use the -q command line argument to disable progress information if enabled by default +- Running unit tests using --verbose no longer throws errors +- Includes all changes from the 2.7.0 release + +### Fixed +- Fixed shell error appearing on some systems when trying to find executable paths + +[sq-699]: https://github.com/squizlabs/PHP_CodeSniffer/issues/699 + +## [3.0.0a1] - 2016-07-20 + +### Changed +- Min PHP version increased from 5.1.2 to 5.4.0 +- Added optional caching of results between runs (request [#530][sq-530]) + - Enable the cache by using the --cache command line argument + - If you want the cache file written somewhere specific, use --cache=/path/to/cacheFile + - Use the command "phpcs --config-set cache true" to turn caching on by default + - Use the --no-cache command line argument to disable caching if it is being turned on automatically +- Add support for checking file in parallel (request [#421][sq-421]) + - Tell PHPCS how many files to check at once using the --parallel command line argument + - To check 100 files at once, using --parallel=100 + - To disable parallel checking if it is being turned on automatically, use --parallel=1 + - Requires PHP to be compiled with the PCNTL package +- The default encoding has been changed from iso-8859-1 to utf-8 (request [#760][sq-760]) + - The --encoding command line argument still works, but you no longer have to set it to process files as utf-8 + - If encoding is being set to utf-8 in a ruleset or on the CLI, it can be safely removed + - If the iconv PHP extension is not installed, standard non-multibyte aware functions will be used +- Added a new "code" report type to show a code snippet for each error (request [#419][sq-419]) + - The line containing the error is printed, along with 2 lines above and below it to show context + - The location of the errors is underlined in the code snippet if you also use --colors + - Use --report=code to generate this report +- Added support for custom filtering of the file list + - Developers can write their own filter classes to perform custom filtering of the list before the run starts + - Use the command line arg `--filter=/path/to/filter.php` to specify a filter to use + - Extend \PHP_CodeSniffer\Filters\Filter to also support the core PHPCS extension and path filtering + - Extend \PHP_CodeSniffer\Filters\ExactMatch to get the core filtering and the ability to use blacklists and whitelists + - The included \PHP_CodeSniffer\Filters\GitModified filter is a good example of an ExactMatch filter +- Added support for only checking files that have been locally modified or added in a git repo + - Use --filter=gitmodified to check these files + - You still need to give PHPCS a list of files or directories in which to check +- Added automatic discovery of executable paths (request [#571][sq-571]) + - Thanks to [Sergei Morozov][@morozov] for the patch +- You must now pass "-" on the command line to have PHPCS wait for STDIN + - E.g., phpcs --standard=PSR2 - + - You can still pipe content via STDIN as normal as PHPCS will see this and process it + - But without the "-", PHPCS will throw an error if no content or files are passed to it +- All PHP errors generated by sniffs are caught, re-thrown as exceptions, and reported in the standard error reports + - This should stop bugs inside sniffs causing infinite loops + - Also stops invalid reports being produced as errors don't print to the screen directly +- Sniff codes are no longer optional + - If a sniff throws an error or a warning, it must specify an internal code for that message +- The installed_paths config setting can now point directly to a standard + - Previously, it had to always point to the directory in which the standard lives +- Multiple reports can now be specified using the --report command line argument + - Report types are separated by commas + - E.g., --report=full,summary,info + - Previously, you had to use one argument for each report such as --report=full --report=summary --report=info +- You can now set the severity, message type, and exclude patterns for an entire sniff, category, or standard + - Previously, this was only available for a single message +- You can now include a single sniff code in a ruleset instead of having to include an entire sniff + - Including a sniff code will automatically exclude all other messages from that sniff + - If the sniff is already included by an imported standard, set the sniff severity to 0 and include the specific message you want +- PHPCBF no longer uses patch + - Files are now always overwritten + - The --no-patch option has been removed +- Added a --basepath option to strip a directory from the front of file paths in output (request [#470][sq-470]) + - The basepath is absolute or relative to the current directory + - E.g., to output paths relative to current dir in reports, use --basepath=. +- Ignore rules are now checked when using STDIN (request [#733][sq-733]) +- Added an include-pattern tag to rulesets to include a sniff for specific files and folders only (request [#656][sq-656]) + - This is the exact opposite of the exclude-pattern tag + - This option is only usable within sniffs, not globally like exclude-patterns are +- Added a new -m option to stop error messages from being recorded, which saves a lot of memory + - PHPCBF always uses this setting to reduce memory as it never outputs error messages + - Setting the $recordErrors member var inside custom report classes is no longer supported (use -m instead) +- Exit code 2 is now used to indicate fixable errors were found (request [#930][sq-930]) + - Exit code 3 is now used for general script execution errors + - Exit code 1 is used to indicate that coding standard errors were found, but none are fixable + - Exit code 0 is unchanged and continues to mean no coding standard errors found + +### Removed +- The included PHPCS standard has been removed + - All rules are now found inside the phpcs.xml.dist file + - Running "phpcs" without any arguments from a git clone will use this ruleset +- The included SVN pre-commit hook has been removed + - Hooks for version control systems will no longer be maintained within the PHPCS project + +[sq-419]: https://github.com/squizlabs/PHP_CodeSniffer/issues/419 +[sq-421]: https://github.com/squizlabs/PHP_CodeSniffer/issues/421 +[sq-470]: https://github.com/squizlabs/PHP_CodeSniffer/issues/470 +[sq-530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/530 +[sq-571]: https://github.com/squizlabs/PHP_CodeSniffer/pull/571 +[sq-656]: https://github.com/squizlabs/PHP_CodeSniffer/issues/656 +[sq-733]: https://github.com/squizlabs/PHP_CodeSniffer/issues/733 +[sq-760]: https://github.com/squizlabs/PHP_CodeSniffer/issues/760 +[sq-930]: https://github.com/squizlabs/PHP_CodeSniffer/issues/930 + + + + +[3.13.5]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.4...3.13.5 +[3.13.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.3...3.13.4 +[3.13.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.2...3.13.3 +[3.13.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.1...3.13.2 +[3.13.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.0...3.13.1 +[3.13.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.12.2...3.13.0 +[3.12.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.12.1...3.12.2 +[3.12.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.12.0...3.12.1 +[3.12.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.3...3.12.0 +[3.11.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.2...3.11.3 +[3.11.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.1...3.11.2 +[3.11.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.0...3.11.1 +[3.11.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.3...3.11.0 +[3.10.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.2...3.10.3 +[3.10.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.1...3.10.2 +[3.10.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.0...3.10.1 +[3.10.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.2...3.10.0 +[3.9.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.1...3.9.2 +[3.9.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.0...3.9.1 +[3.9.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.8.1...3.9.0 +[3.8.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.8.0...3.8.1 +[3.8.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.7.2...3.8.0 +[3.7.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.7.1...3.7.2 +[3.7.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.7.0...3.7.1 +[3.7.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.6.2...3.7.0 +[3.6.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.6.1...3.6.2 +[3.6.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.6.0...3.6.1 +[3.6.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.8...3.6.0 +[3.5.8]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.7...3.5.8 +[3.5.7]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.6...3.5.7 +[3.5.6]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.5...3.5.6 +[3.5.5]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.4...3.5.5 +[3.5.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.3...3.5.4 +[3.5.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.2...3.5.3 +[3.5.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.1...3.5.2 +[3.5.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.0...3.5.1 +[3.5.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.4.2...3.5.0 +[3.4.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.4.1...3.4.2 +[3.4.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.4.0...3.4.1 +[3.4.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.3.2...3.4.0 +[3.3.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.3.1...3.3.2 +[3.3.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.3.0...3.3.1 +[3.3.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.3...3.3.0 +[3.2.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.2...3.2.3 +[3.2.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.1...3.2.2 +[3.2.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.0...3.2.1 +[3.2.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.1.1...3.2.0 +[3.1.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.1.0...3.1.1 +[3.1.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.2...3.1.0 +[3.0.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.1...3.0.2 +[3.0.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0...3.0.1 +[3.0.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC4...3.0.0 +[3.0.0RC4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC3...3.0.0RC4 +[3.0.0RC3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC2...3.0.0RC3 +[3.0.0RC2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC1...3.0.0RC2 +[3.0.0RC1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0a1...3.0.0RC1 +[3.0.0a1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.9.2...3.0.0a1 + + + +[@aboks]: https://github.com/aboks +[@afilina]: https://github.com/afilina +[@alekitto]: https://github.com/alekitto +[@anbuc]: https://github.com/anbuc +[@AndrewDawes]: https://github.com/AndrewDawes +[@andrewnicols]: https://github.com/andrewnicols +[@andypost]: https://github.com/andypost +[@annechko]: https://github.com/annechko +[@anomiex]: https://github.com/anomiex +[@arnested]: https://github.com/arnested +[@asispts]: https://github.com/asispts +[@axlon]: https://github.com/axlon +[@Benjamin-Loison]: https://github.com/Benjamin-Loison +[@benno5020]: https://github.com/benno5020 +[@biinari]: https://github.com/biinari +[@Billz95]: https://github.com/Billz95 +[@blue32a]: https://github.com/blue32a +[@bondas83]: https://github.com/bondas83 +[@braindawg]: https://github.com/braindawg +[@cixtor]: https://github.com/cixtor +[@codebymikey]: https://github.com/codebymikey +[@costdev]: https://github.com/costdev +[@Daimona]: https://github.com/Daimona +[@DanielEScherzer]: https://github.com/DanielEScherzer +[@DannyvdSluijs]: https://github.com/DannyvdSluijs +[@datengraben]: https://github.com/datengraben +[@derrabus]: https://github.com/derrabus +[@devfrey]: https://github.com/devfrey +[@dhensby]: https://github.com/dhensby +[@dingo-d]: https://github.com/dingo-d +[@duncan3dc]: https://github.com/duncan3dc +[@edorian]: https://github.com/edorian +[@emil-nasso]: https://github.com/emil-nasso +[@enl]: https://github.com/enl +[@exussum12]: https://github.com/exussum12 +[@fabacino]: https://github.com/fabacino +[@fcool]: https://github.com/fcool +[@filips123]: https://github.com/filips123 +[@Fischer-Bjoern]: https://github.com/Fischer-Bjoern +[@fredden]: https://github.com/fredden +[@GaryJones]: https://github.com/GaryJones +[@ghostal]: https://github.com/ghostal +[@gmponos]: https://github.com/gmponos +[@grongor]: https://github.com/grongor +[@gwharton]: https://github.com/gwharton +[@iammattcoleman]: https://github.com/iammattcoleman +[@ivuorinen]: https://github.com/ivuorinen +[@javer]: https://github.com/javer +[@jaymcp]: https://github.com/jaymcp +[@joachim-n]: https://github.com/joachim-n +[@johnpbloch]: https://github.com/johnpbloch +[@JorisDebonnet]: https://github.com/JorisDebonnet +[@josephzidell]: https://github.com/josephzidell +[@jpoliveira08]: https://github.com/jpoliveira08 +[@jpuck]: https://github.com/jpuck +[@jrfnl]: https://github.com/jrfnl +[@klausi]: https://github.com/klausi +[@kukulich]: https://github.com/kukulich +[@legoktm]: https://github.com/legoktm +[@lmanzke]: https://github.com/lmanzke +[@lucc]: https://github.com/lucc +[@Majkl578]: https://github.com/Majkl578 +[@marcospassos]: https://github.com/marcospassos +[@MarkBaker]: https://github.com/MarkBaker +[@martinssipenko]: https://github.com/martinssipenko +[@marvasDE]: https://github.com/marvasDE +[@maryo]: https://github.com/maryo +[@MasterOdin]: https://github.com/MasterOdin +[@MatmaRex]: https://github.com/MatmaRex +[@mhujer]: https://github.com/mhujer +[@michalbundyra]: https://github.com/michalbundyra +[@Morerice]: https://github.com/Morerice +[@mbomb007]: https://github.com/mbomb007 +[@morozov]: https://github.com/morozov +[@NanoSector]: https://github.com/NanoSector +[@ndm2]: https://github.com/ndm2 +[@nicholascus]: https://github.com/nicholascus +[@nkovacs]: https://github.com/nkovacs +[@o5]: https://github.com/o5 +[@ostrolucky]: https://github.com/ostrolucky +[@peterwilsoncc]: https://github.com/peterwilsoncc +[@pfrenssen]: https://github.com/pfrenssen +[@phil-davis]: https://github.com/phil-davis +[@photodude]: https://github.com/photodude +[@przemekhernik]: https://github.com/przemekhernik +[@raul338]: https://github.com/raul338 +[@remicollet]: https://github.com/remicollet +[@renaatdemuynck]: https://github.com/renaatdemuynck +[@rhorber]: https://github.com/rhorber +[@rodrigoprimo]: https://github.com/rodrigoprimo +[@schlessera]: https://github.com/schlessera +[@shivammathur]: https://github.com/shivammathur +[@simonsan]: https://github.com/simonsan +[@SteveTalbot]: https://github.com/SteveTalbot +[@stronk7]: https://github.com/stronk7 +[@svycka]: https://github.com/svycka +[@TomHAnderson]: https://github.com/TomHAnderson +[@thewilkybarkid]: https://github.com/thewilkybarkid +[@thiemowmde]: https://github.com/thiemowmde +[@timoschinkel]: https://github.com/timoschinkel +[@TimWolla]: https://github.com/TimWolla +[@VincentLanglet]: https://github.com/VincentLanglet +[@willemstuursma]: https://github.com/willemstuursma +[@wvega]: https://github.com/wvega +[@xalopp]: https://github.com/xalopp +[@xjm]: https://github.com/xjm diff --git a/app/vendor/squizlabs/php_codesniffer/CHANGELOG-4.x.md b/app/vendor/squizlabs/php_codesniffer/CHANGELOG-4.x.md new file mode 100644 index 000000000..843eb3dc4 --- /dev/null +++ b/app/vendor/squizlabs/php_codesniffer/CHANGELOG-4.x.md @@ -0,0 +1,449 @@ +# Changelog + +The file documents changes to the PHP_CodeSniffer project for the 4.x series of releases. + +## [4.0.1] - 2025-11-10 + +This release includes all improvements and bugfixes from PHP_CodeSniffer [3.13.5]. + +### Added +- Runtime support for PHP 8.5. All known PHP 8.5 deprecation notices have been fixed. + - Syntax support for new PHP 8.5 features will follow in a future release. + - If you find any PHP 8.5 deprecation notices which were missed, please report them. + +### Changed +- The Squiz.ControlStructures.SwitchDeclaration sniff will now flag a PHP close tag as a "wrong opener" and will auto-fix this by inserting a colon. [#1316] +- Various housekeeping, including improvements to the tests and documentation. + +### Fixed +- 4.x regression [#1277]: bring back whitespace tolerance in `phpcs:ignore` comma-separated rule reference lists. + - Note: this bug did not affect `phpcs:disable`/`phpcs:enable` ignore annotations. +- Fixed bug [#968]: Generic.WhiteSpace.ScopeIndent was reporting false positives - and making incorrect fixes - for lines following a line containing an arrow function. + - Thanks to [Soichi Sato][@Soh1121] for the patch. +- Fixed bug [#1216]: Tokenizer/PHP: added more defensive coding to prevent PHP 8.5 "Using null as an array offset" deprecation notices. + - Thanks to [Andrew Lyons][@andrewnicols] for the patch. +- Fixed bug [#1279]: Tokenizer/PHP: on PHP < 8.0, an unclosed attribute (parse error) could end up removing some tokens from the token stream. + - This could lead to false positives and false negative from sniffs, but could also lead to incorrect fixes being made mangling the file under scan. +- Fixed bug [#1315]: Squiz.ControlStructures.SwitchDeclaration: a number of the fixers would get into fixer conflicts with each other if the code under scan contained multiple statements on a line within a `switch`. + - The sniff will now forbid - and auto-fix - multiple statements on one line for `case`/`default` and "case breaking" statements. +- Fixed bug [#1316]: Tokenizer/PHP: a PHP close tag after a `switch` case condition or after a `default` keyword, was not regarded as a "scope_opener" for the `case`/`default` body. +- Fixed bug [#1316]: PSR2.ControlStructures.SwitchDeclaration: the `WrongOpener` error is now also auto-fixable if the wrong opener is a PHP close tag. +- Fixed bug [#1316]: Squiz.PHP.NonExecutableCode would throw false positives when code within a switch control structure would move in and out of PHP. + +[3.13.5]: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/4.x/CHANGELOG-3.x.md#3135---2025-11-04 + +[#968]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/968 +[#1216]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1216 +[#1277]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1277 +[#1279]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1279 +[#1315]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1315 +[#1316]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1316 + + +## [4.0.0] - 2025-09-16 + +This release contains breaking changes. + +Upgrade guides for both [ruleset maintainers/end-users][wiki-upgrade-4.0-end-users], as well as for [sniff developers and integrators][wiki-upgrade-4.0-extenders], have been published to the Wiki. + +You are strongly encouraged to read the upgrade guide applicable to your situation before upgrading. + +This release includes all improvements and bugfixes from PHP_CodeSniffer [4.0.0-beta1], [4.0.0-RC1], [3.13.3] and [3.13.4]. + +### Changed +- Tokenizer/PHP: fully qualified `exit`/`die`/`true`/`false`/`null` will be tokenized as the keyword token and the token `'content'` will include the leading backslash. [#1201] +- Wherever possible based on the PHP 7.2 minimum version, parameter types have been added to all methods. [#1237] +- The supported PHPUnit version constraints have been updated to `^8.4.0 || ^9.3.4 || ^10.5.32 || 11.3.3 - 11.5.28 || ^11.5.31`. [#1247] + - External standards using the PHP_CodeSniffer native framework may need to update their own PHPUnit version constraints. +- Various housekeeping, including improvements to the tests and documentation. + +### Fixed +- Fixed bug [#1082]: new exit codes weren't applied when running `phpcbf` on code provided via STDIN. + - Thanks to [Dan Wallis][@fredden] for the patch. +- Fixed bug [#1172]: `// phpcs:set` for inline array properties did not handle a single item array with the value `true`, `false` or `null` correctly. +- Fixed bug [#1174]: progress bar wasn't showing files as fixed when running `phpcbf` in parallel mode. +- Fixed bug [#1226]: PHP 8.5 "Using null as an array offset" deprecation notice. + +### Other +- Please be aware that the `master` branch has been renamed to `3.x` and the default branch has changed to the `4.x` branch. + - If you contribute to PHP_CodeSniffer, you will need to update your local git clone. + - If you develop against PHP_CodeSniffer and run your tests against dev branches of PHPCS, you will need to update your workflows. + +[3.13.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/CHANGELOG-3.x.md#3133---2025-09-04 +[3.13.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/CHANGELOG-3.x.md#3134---2025-09-05 +[4.0.0-RC1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/CHANGELOG-4.x.md#400rc1---2025-06-18 + +[#1082]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1082 +[#1172]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1172 +[#1174]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1174 +[#1201]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1201 +[#1226]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1226 +[#1237]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1237 +[#1247]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1247 + + +## [4.0.0RC1] - 2025-06-18 + +This release includes all improvements and bugfixes from PHP_CodeSniffer [4.0.0-beta1], [3.13.1] and [3.13.2]. + +### Changed +- The error code `Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingAfterVisbility` has been changed to `Squiz.Functions.FunctionDeclarationArgumentSpacing.SpacingAfterVisibility`. [#1136] +- The following sniff(s) have received efficiency improvements: + - Generic.ControlStructures.InlineControlStructure + - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. + +### Fixed +- Fixed bug [#3889][sq-3889] : A selective `phpcs:enable` could sometimes override a later selective `phpcs:ignore`. + - Thanks to [Brad Jorsch][@anomiex] for the patch +- Fixed bug [#1128] : missing 'parenthesis_owner' index for T_FUNCTION token on PHP < 7.4 when function is named "fn". + +### Other +- The GPG signature for the PHAR files has been rotated. The new fingerprint is: D91D86963AF3A29B6520462297B02DD8E5071466. + +[3.13.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/CHANGELOG-3.x.md#3131---2025-06-13 +[3.13.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/CHANGELOG-3.x.md#3132---2025-06-18 +[4.0.0-beta1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/CHANGELOG-4.x.md#400beta1---2025-05-11 + +[sq-3889]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3889 +[#1128]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1128 +[#1136]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1136 + + +## [4.0.0beta1] - 2025-05-11 + +### Added +- Files without extension can now be scanned if the path is passed in directly. [#2916][sq-2916] + - Previously, files without extension would always be ignored. + - Now, files with no extension are checked if explicitly passed on the command line or specified in a ruleset. + - Files without extension will still be ignored when scanning directories recursively. +- Support for extending a default value for an array property on a sniff from an XML ruleset file. [#15] + - Previously, using `extend="true"` on an property tag for setting an array value could already _extend_ a property value set elsewhere in an (inluded) ruleset. + - Now, you can also add to (extend) a default value as set on the sniff itself. + - Note: the property default value and the values set via the ruleset will be merged. + - This also means that for associative arrays, you can redefine the value for a particular array key. + - For numerically indexed arrays, this means the array will be renumbered. Keep this in mind if the numeric indexes hold meaning. +- Added support for PHP 8.4 properties in interfaces to File::getMemberProperties(). [#2455][sq-2455] + - Note: properties in interfaces is not fully supported yet, it is just this one method which handles them correctly at this moment. +- `Tokens::NAME_TOKENS` containing an array with the tokens used for identifier names. [#3041][sq-3041] +- New sniff `Generic.WhiteSpace.GotoTargetSpacing` to enforce no space between the label of a `goto` target and the colon following it. [#1026] +- An error message is now displayed if no files were checked during a run. [#1595][sq-1595] + - This occurs when all of the specified files matched exclusion rules, or none matched filtering rules. +- An error will be shown when attempting to change an unchangable PHP ini setting using `-d option[=value]` or via the ruleset with ``. [#416] + - Previously, this was silently ignored. + - Attempting to change non-existent ini settings (typo, extension not loaded) will continue to be silently ignored. + +### Changed +- The minimum required PHP version has changed from 5.4.0 to 7.2.0. +- The default coding standard has changed from `PEAR` to `PSR12`. +- Both `phpcs` as well as `phpcbf` will now exit with exit code 0 if no issues were found/remain after fixing. [#184] + - Non auto-fixable issues can be ignored for the exit code determination by setting the new `ignore_non_auto_fixable_on_exit` config flag to `1`. + - For full details on the new exit codes, please refer to the Wiki ["Advanced Usage"](https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Advanced-Usage#understanding-the-exit-codes) page. +- Composer installs no longer include any test files. [#1908][sq-1908] + - The test framework files will still be included to allow for use by external standards. +- All status, debug, and progress output is now sent to STDERR instead of STDOUT. [#1612][sq-1612] + - Only report output now goes through STDOUT. As a result of this, piping output to a file will now only include report output. + - Pipe both STDERR and STDOUT to the same file to capture the entire output of the run. + - The `--report-file` functionality remains untouched. + - With this change in place, timing and memory consumption stats will now be displayed more often as this will no longer interfere with reports. +- The `--extensions` command line argument no longer accepts the tokenizer along with the extension. [#2448][sq-2448] + - Previously, you would check `.module` files as PHP files using `--extensions=module/php`. + - Now, you use `--extensions=module`. +- When processing rulesets, `` directives will be applied based on the nesting level of the ruleset. [#2197][sq-2197] + - Previously, it was not possible to overrule a `` directive set in an included ruleset from the "root" ruleset. + - Now, `` directives set in the "root" ruleset will always "win" over directives in included rulesets. + - When two included rulesets at the same nesting level both set the same directive, the value from the _last_ included ruleset "wins" (= same as before). +- When processing rulesets, `` directives will be applied based on the nesting level of the ruleset. [#2395][sq-2395], [#2597][sq-2597], [#2602][sq-2602] + - Previously, it was not possible to overrule a `` directive set in an included ruleset from the "root" ruleset. + - Now, `` directives set in the "root" ruleset will always "win" over directives in included rulesets. + - When two included rulesets at the same nesting level both set the same directive, the value from the _first_ included ruleset "wins" (= same as before). +- Internal errors will no longer be suppressed when the `--sniffs` CLI argument is used. [#98] +- The `File::getDeclarationName()` method will no longer accept `T_ANON_CLASS` or `T_CLOSURE` tokens. [#3766][sq-3766] + - A `RuntimeException` will be thrown if these tokens are passed. +- The `File::getDeclarationName()` method will now always return a string (or throw an Exception). [#1007] + - Previously, the method would return `null` if the name could not be determined, like during live coding. + Now it will return an empty string in those situations. +- The `File::getMemberProperties()` method will no longer add warnings about possible parse errors. [#2455][sq-2455] + - This means the `Internal.ParseError.InterfaceHasMemberVar` and the `Internal.ParseError.EnumHasMemberVar` error codes have been removed. + - The method will now throw a "$stackPtr is not a class member var" `RuntimeException` for properties declared in enums (parse error). + - Properties declared in interfaces will be analyzed like all other properties, as these are allowed since PHP 8.4. +- None of the included sniffs will warn about possible parse errors any more. [#2455][sq-2455] + - This improves the experience when the file is being checked inside an editor during live coding. + - If you want to detect parse errors, use the `Generic.PHP.Syntax` sniff or a dedicated linter instead. +- The PEAR + PSR2 FunctionCallSignature sniffs will now also examine anonymous class instantiations with parameters. [#47] +- The error code `Squiz.Classes.ValidClassName.NotCamelCaps` has been changed to `Squiz.Classes.ValidClassName.NotPascalCase`. [#2046][sq-2046] + - This reflects that the sniff is actually checking for `ClassName` and not `className`. +- The error code `Squiz.PHP.Heredoc.NotAllowed` has been replaced by `Squiz.PHP.Heredoc.HeredocNotAllowed` and `Squiz.PHP.Heredoc.NowdocNotAllowed`. [#2318][sq-2318] + - This allows for forbidding either heredocs or nowdocs without forbidding both. +- The `PSR12.Files.FileHeader` sniff now has more modular error codes to allow for more selectively applying the rules. [#2729][sq-2729] [#3453][sq-3453] + - The `PSR12.Files.FileHeader.SpacingAfterBlock` error code is replaced by: + - `PSR12.Files.FileHeader.SpacingAfterTagBlock` + - `PSR12.Files.FileHeader.SpacingAfterDocblockBlock` + - `PSR12.Files.FileHeader.SpacingAfterDeclareBlock` + - `PSR12.Files.FileHeader.SpacingAfterNamespaceBlock` + - `PSR12.Files.FileHeader.SpacingAfterUseBlock` + - `PSR12.Files.FileHeader.SpacingAfterUseFunctionBlock` + - `PSR12.Files.FileHeader.SpacingAfterUseConstBlock` + - The `PSR12.Files.FileHeader.SpacingInsideBlock` error code is replaced by: + - `PSR12.Files.FileHeader.SpacingInsideUseBlock` + - `PSR12.Files.FileHeader.SpacingInsideUseFunctionBlock` + - `PSR12.Files.FileHeader.SpacingInsideUseConstBlock` +- The error code `Squiz.Commenting.VariableComment.TagNotAllowed` has been replaced by a dynamic `Squiz.Commenting.VariableComment.[TagName]TagNotAllowed` error code. [#1039] + - This allows for selectively allowing specific tags by excluding the error code for that tag. + - Example: to allow `@link` tags in property docblocks, exclude the `Squiz.Commenting.VariableComment.LinkTagNotAllowed` error code. +- The following sniffs have received performance related improvements: + - PEAR.NamingConventions.ValidVariableName + - PSR2.Classes.PropertyDeclaration + - Squiz.Commenting.VariableComment + - Squiz.Scope.MemberVarScope + - Squiz.WhiteSpace.MemberVarSpacing + - These sniffs will no longer listen to non-variable tokens, nor for variables tokens outside of OO context. [#374] + External sniffs which extend one of these sniffs may need adjustment if they want to retain the old behaviour. +- PHPCS now uses the PHP >= 8.0 native method for tokenizing (namespaced) identifier names. [#3041][sq-3041] + - Before PHP 8.0, PHP would tokenize namespaced names using `T_STRING` and `T_NS_SEPARATOR`. + - From PHP 8.0, PHP uses the tokens `T_NAME_FULLY_QUALIFIED`, `T_NAME_RELATIVE`, and `T_NAME_QUALIFIED` instead. + - PHPCS now uses these new PHP 8.0 tokens no matter what version of PHP is being used to run PHPCS. + - Custom sniffs that use `T_STRING` and `T_NS_SEPARATOR` tokens to look for namespaced names will need to be modified. + - The `Tokens::FUNCTION_NAME_TOKENS`/`Tokens::$functionNameTokens` array now includes the identifier name tokens. +- Closure T_USE tokens, T_ISSET, T_UNSET, T_EMPTY, T_EVAL and T_EXIT tokens now contain parenthesis information. [#23], [#2593][sq-2593] + - Previously, you had to find the opening and closing parenthesis by looking forward through the token stack. + - Now, you can use the `parenthesis_owner`, `parenthesis_opener` and `parenthesis_closer` array indexes. +- The `static` keyword when preceded by `instanceof` will now be tokenized (again) as `T_STATIC`. [#22] + - Previously, the token was (re-)tokenized to `T_STRING`. +- `T_OPEN_TAG` tokens will no longer contain any whitespace. [#593] + - Previously, "long" open tags could include either a single space or a new line character. + - This whitespace will now be tokenized as a `T_WHITESPACE` token. +- `T_GOTO_LABEL` tokens will no longer include the colon following it. [#185] + - The colon belonging with a goto label will now be tokenized separately as `T_GOTO_COLON`. +- Context sensitive keywords used as a label in a `goto` statement will now be tokenized as `T_STRING` to prevent confusing sniffs. [#185] +- All `T_DOC_COMMENT_*` tokens now have the `comment_opener` and `comment_closer` indexes set. [#484] +- The `Tokens::FUNCTION_NAME_TOKENS`/`Tokens::$functionNameTokens` array now includes the `T_ANON_CLASS` token. [#47] +- Type casting for sniff property values set from within a ruleset has been made more consistent. [#708] + - `true` and `false` will now always be set to a boolean value, independently of the case in which the value was provided. + - `null` will now be set to an actual `null` value. Previously, the sniff property would have been set to string `'null'`. + - Array element values will now also get the type casting treatment. Previously, array values would always be strings. +- The `PHP_CodeSniffer\Config::setConfigData()` method is no longer static. [#2675][sq-2675] + - The associated (`private`) `Config::$overriddenDefaults` property is also no longer static. +- The `PHP_CodeSniffer\Config::setSettings()` method is now a `void` method. [#1001] +- The signature of the `DummyFile::setErrorCounts()` method has changed and now expects the following parameters: `$errorCount, $warningCount, $fixableErrorCount, $fixableWarningCount, $fixedErrorCount, $fixedWarningCount`. [#1079] +- The `Generator` classes will now throw a `PHP_CodeSniffer\Exceptions\GeneratorException` when encountering errors in the documentation XML. [#1072] +- The `PHP_CodeSniffer\Generators\HTML::STYLESHEET`, `PHP_CodeSniffer\Util\Timing::MINUTE_IN_MS` and `PHP_CodeSniffer\Util\Timing::SECOND_IN_MS` class constants are no longer `public`. [#1051] +- The `PHP_CodeSniffer\Util\Timing` class is now `final` and marked as an internal class. [#1074] +- The Ruleset class no longer has special behaviour when used in a test context. [#996] +- The minimum required PHPUnit version for the test framework has changed from 4.0 to 8.0. [#994], [#997] + - The test framework is now compatible with PHPUnit 8.x - 11.x (ignoring PHPUnit deprecations related to PHPUnit 12). +- The test framework has been refactored and no longer creates a custom test suite. [#25] + - If tests for an external standard extend the PHPCS native test suite, be sure to read the upgrade guide for more detail. +- The two abstract base test cases have been renamed. [#25] + - Replace `PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest` with `PHP_CodeSniffer\Tests\Standards\AbstractSniffTestCase`. + - Replace `PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest` with `PHP_CodeSniffer\Tests\Core\AbstractMethodTestCase`. +- Tests which extend the `AbstractSniffTestCase` for which no test case files (`.inc` files) can be found, will now be marked as "incomplete". [#998] + - Previously, those tests would silently pass. +- All test case files (`inc`) which would be changed by the sniff under test if running the fixer, are now required to be accompanied by a `*.fixed` file. [#300] + +### Deprecated + +- The static token array properties in the `Tokens` class. Use the corresponding class constants on the Tokens class instead. [#500] +- `PHP_CodeSniffer\Util\Common::$allowedTypes`. Use `PHP_CodeSniffer\Util\Common::ALLOWED_TYPES` instead. [#1043] +- `PHP_CodeSniffer\Tokenizers\PHP::$tstringContexts`. Use `PHP_CodeSniffer\Tokenizers\PHP::T_STRING_CONTEXTS` instead. [#1043] +- `PHP_CodeSniffer\Sniffs\AbstractVariableSniff::$phpReservedVars`. Use `PHP_CodeSniffer\Sniffs\AbstractVariableSniff::PHP_RESERVED_VARS` instead. [#1043] +- `PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff::$magicMethods`. Use `PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff::MAGIC_METHODS` instead. [#1043] + - This also affects the `PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff` class which extends the `CamelCapsFunctionNameSniff`. +- `PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff::$methodsDoubleUnderscore`. Use `PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff::DOUBLE_UNDERSCORE_METHODS` instead. [#1043] + - This also affects the `PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff` class which extends the `CamelCapsFunctionNameSniff`. +- `PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff::$magicFunctions`. Use `PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff::MAGIC_FUNCTIONS` instead. [#1043] + - This also affects the `PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff` class which extends the `CamelCapsFunctionNameSniff`. +- `PHP_CodeSniffer\Standards\Generic\Sniffs\Files\ByteOrderMarkSniff::$bomDefinitions`. Use `PHP_CodeSniffer\Standards\Generic\Sniffs\Files\ByteOrderMarkSniff::BOM_DEFINITIONS` instead. [#1043] +- `PHP_CodeSniffer\Standards\Generic\Sniffs\Files\InlineHTMLSniff::$bomDefinitions`. Use `PHP_CodeSniffer\Standards\Generic\Sniffs\Files\InlineHTMLSniff::BOM_DEFINITIONS` instead. [#1043] +- `PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\CharacterBeforePHPOpeningTagSniff::$bomDefinitions`. Use `PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\CharacterBeforePHPOpeningTagSniff::BOM_DEFINITIONS` instead. [#1043] +- `PHP_CodeSniffer\Standards\Generic\Sniffs\VersionControl\SubversionPropertiesSniff::$properties`. Use `PHP_CodeSniffer\Standards\Generic\Sniffs\VersionControl\SubversionPropertiesSniff::REQUIRED_PROPERTIES` instead. [#1043] +- `PHP_CodeSniffer\Standards\PEAR\Sniffs\Commenting\FileCommentSniff::$tags`. Use `PHP_CodeSniffer\Standards\PEAR\Sniffs\Commenting\FileCommentSniff::EXPECTED_TAGS` instead. [#1043] + - This also affects the `PHP_CodeSniffer\Standards\PEAR\Sniffs\Commenting\ClassCommentSniff` class which extends the `FileCommentSniff`. +- `PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions\ValidFunctionNameSniff::$magicMethods`. Use `PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions\ValidFunctionNameSniff::MAGIC_METHODS` instead. [#1043] + - This also affects the `PHP_CodeSniffer\Standards\Squiz\Sniffs\NamingConventions\ValidFunctionNameSniff` class which extends the PEAR `ValidFunctionNameSniff`. +- `PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions\ValidFunctionNameSniff::$magicFunctions`. Use `PHP_CodeSniffer\Standards\PEAR\Sniffs\NamingConventions\ValidFunctionNameSniff::MAGIC_FUNCTIONS` instead. [#1043] + - This also affects the `PHP_CodeSniffer\Standards\Squiz\Sniffs\NamingConventions\ValidFunctionNameSniff` class which extends the PEAR `ValidFunctionNameSniff`. +- `PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP\DisallowSizeFunctionsInLoopsSniff::$forbiddenFunctions`. Use `PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP\DisallowSizeFunctionsInLoopsSniff::FORBIDDEN_FUNCTIONS` instead. [#1043] +- `PHP_CodeSniffer\Util\Standards::printInstalledStandards()`. Use `echo PHP_CodeSniffer\Util\Standards::prepareInstalledStandardsForDisplay()` instead. [#1054] +- `PHP_CodeSniffer\Config::printConfigData()`. Use `echo PHP_CodeSniffer\Config::prepareConfigDataForDisplay()` instead. [#1055] +- The `Reporter::$totalFixable` and `Reporter::$totalFixed` properties. [#1079] + - Use respectively `(Reporter::$totalFixableErrors + Reporter::$totalFixableWarnings)` and `(Reporter::$totalFixedErrors + Reporter::$totalFixedWarnings)` instead. + +### Removed +- Support for checking the coding standards of CSS and JS files has been removed. [#2448][sq-2448] + - Sniffs which are specifically aimed at CSS/JS files will no longer run. + - All other sniffs will now treat all files under scan as PHP files. + - The JS/CSS tokenizers and all tokens which were specifically for CSS/JS have also been removed. +- Support for sniffs not implementing the `PHP_CodeSniffer\Sniffs\Sniff` interface. See [#694]. +- Support for sniffs not following the naming conventions. See [#689]. +- Support for external standards called "Internal". See [#799]. +- Support for the deprecated `@codingStandard` annotation syntax has been removed. [#1954][sq-1954] + - Use the `phpcs:` or `@phpcs:` syntax instead + - Replace `@codingStandardsIgnoreFile` with `phpcs:ignoreFile` + - Replace `@codingStandardsIgnoreStart` with `phpcs:disable` + - Replace `@codingStandardsIgnoreEnd` with `phpcs:enable` + - Replace `@codingStandardsIgnoreLine` with `phpcs:ignore` + - Replace `@codingStandardsChangeSetting` with `phpcs:set` +- Support for the deprecated `ruleset.xml` array property string-based syntax has been removed. [#1983][sq-1983] + - Previously, an array value could be set using a comma-delimited string `print=>echo,create_function=>null` + - Now, individual array elements are specified using an `element` tag with `key` and `value` attributes + - For example, `` +- The unused `T_ARRAY_HINT` token. [#1997][sq-1997] +- The unused `T_RETURN_TYPE` token. [#1997][sq-1997] +- The `Generic.Debug.ClosureLinter` sniff. [#2448][sq-2448] +- The `Generic.Debug.CSSLint` sniff. [#2448][sq-2448] +- The `Generic.Debug.ESLint` sniff. [#2448][sq-2448] +- The `Generic.Debug.JSHint` sniff. [#2448][sq-2448] +- The `Generic.Formatting.NoSpaceAfterCast` sniff. [#2234][sq-2234] + - Use the `Generic.Formatting.SpaceAfterCast` sniff instead with the `$spacing` property set to `0`. +- The `Generic.Functions.CallTimePassByReference` sniff. [#921] +- The entire `MySource` standard, and all sniffs within. [#2471][sq-2471] +- The `Squiz.Classes.DuplicateProperty` sniff. [#2448][sq-2448] +- The entire `Squiz.CSS` category, and all sniffs within. [#2448][sq-2448] +- The `Squiz.Debug.JavaScriptLint` sniff. [#2448][sq-2448] +- The `Squiz.Debug.JSLint` sniff. [#2448][sq-2448] +- The `Squiz.Objects.DisallowObjectStringIndex` sniff. [#2448][sq-2448] +- The `Squiz.Objects.ObjectMemberComment` sniff. [#2448][sq-2448] +- The `Squiz.WhiteSpace.LanguageConstructSpacing` sniff. [#1953][sq-1953] + - Use the `Generic.WhiteSpace.LanguageConstructSpacing` sniff instead. +- The `Squiz.WhiteSpace.PropertyLabelSpacing` sniff. [#2448][sq-2448] +- The `Zend.Debug.CodeAnalyzer` sniff. [#58] +- The `error` property of sniff `Generic.Strings.UnnecessaryStringConcat`. See [#2823][sq-2823] + - This sniff now always produces errors + - To make this sniff produce warnings, include the following in a `ruleset.xml` or `[.]phpcs.xml[.dist]` file: + ```xml + + warning + + ``` +- The `error` property of sniff `Generic.Formatting.MultipleStatementAlignment`. See [#2823][sq-2823] + - This sniff now always produces warnings + - The `Generic.Formatting.MultipleStatementAlignment.IncorrectWarning` error code has been removed. + - Refer to the `Generic.Formatting.MultipleStatementAlignment.Incorrect` error code instead. + - The `Generic.Formatting.MultipleStatementAlignment.NotSameWarning` error code has been removed. + - Refer to the `Generic.Formatting.MultipleStatementAlignment.NotSame` error code instead. + - To make this sniff produce errors, include the following in a `ruleset.xml` or `[.]phpcs.xml[.dist]` file: + ```xml + + error + + ``` +- The `$ignoreComments` parameter for the `AbstractPatternSniff::__construct()` method. +- Ruleset::setSniffProperty(): support for the old `$settings` parameter format. [#3629][sq-3629] +- Use of the deprecated `auto_detect_line_endings` ini setting. [#3394][sq-3394] + - This removes support for files with `\r` line endings. +- The abstract `PHP_CodeSniffer\Filters\ExactMatch::getBlacklist()` and `PHP_CodeSniffer\Filters\ExactMatch::getWhitelist()` methods. See [#199]. + - These have been replaced by the `ExactMatch::getDisallowedFiles()` and `ExactMatch::getAllowedFiles()` methods. +- The deprecated `PHP_CodeSniffer\Generators\[HTML|Markdown|Text]::print*()` methods. See [#755]. +- Unused static `PHP_CodeSniffer\Reporter::$startTime` property. [#1064] + +### Fixed +- Fixed bug [#185] : goto labels were incorrectly tokenized as `T_STRING` if there was whitespace and/or comments between the label and colon. +- Fixed bug [#1012] : in edge cases, the tokenizer could create some stray `parenthesis_*` keys. +- Fixed bug [#1020] : File::findExtendedClassName() will no longer break on namespace relative class names. +- Fixed bug [#1020] : File::findImplementedInterfaceNames() will no longer break on namespace relative interface names. +- Fixed bug [#1020] : Various sniffs now have better support for ignoring/examining qualified function calls. + +### Other +**Calling all testers!** + +Please help by testing the beta release and reporting any issues you run into. +Upgrade guides for both [ruleset maintainers/end-users][wiki-upgrade-4.0-end-users], as well as for [sniff developers and integrators][wiki-upgrade-4.0-extenders], have been published to the Wiki to help smooth the transition. + +All patches courtesy of [Greg Sherwood][@gsherwood] and [Juliette Reinders Folmer][@jrfnl]. + +Special thanks go out to [Dan Wallis][@fredden] and [Rodrigo Primo][@rodrigoprimo] for their reviews and feedback. + +[wiki-upgrade-4.0-end-users]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-User-Upgrade-Guide +[wiki-upgrade-4.0-extenders]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-Developer-Upgrade-Guide + +[sq-1595]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1595 +[sq-1612]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1612 +[sq-1908]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1908 +[sq-1953]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1953 +[sq-1954]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1954 +[sq-1983]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1983 +[sq-1997]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1997 +[sq-2046]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2046 +[sq-2197]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2197 +[sq-2234]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2234 +[sq-2318]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2318 +[sq-2395]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2395 +[sq-2448]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2448 +[sq-2455]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2455 +[sq-2471]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2471 +[sq-2593]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2593 +[sq-2597]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2597 +[sq-2602]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2602 +[sq-2675]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2675 +[sq-2729]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2729 +[sq-2823]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2823 +[sq-2916]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2916 +[sq-3041]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3041 +[sq-3394]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3394 +[sq-3453]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3453 +[sq-3629]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3629 +[sq-3766]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3766 + +[#15]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/15 +[#22]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/22 +[#23]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/23 +[#25]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/25 +[#47]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/47 +[#58]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/58 +[#98]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/98 +[#184]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/184 +[#185]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/185 +[#199]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/199 +[#300]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/300 +[#374]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/374 +[#416]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/416 +[#484]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/484 +[#500]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/500 +[#593]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/593 +[#689]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/689 +[#694]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/694 +[#708]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/708 +[#755]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/755 +[#799]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/799 +[#921]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/921 +[#994]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/994 +[#996]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/996 +[#997]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/997 +[#998]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/998 +[#1001]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1001 +[#1007]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1007 +[#1012]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1012 +[#1020]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1020 +[#1026]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1026 +[#1039]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1039 +[#1043]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1043 +[#1051]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1051 +[#1054]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1054 +[#1055]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1055 +[#1064]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1064 +[#1072]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1072 +[#1074]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1074 +[#1079]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1079 + + + + +[4.0.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/4.0.0...4.0.1 +[4.0.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/4.0.0RC1...4.0.0 +[4.0.0RC1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/4.0.0beta1...4.0.0RC1 +[4.0.0beta1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.0...4.0.0beta1 + + + + +[@andrewnicols]: https://github.com/andrewnicols +[@anomiex]: https://github.com/anomiex +[@fredden]: https://github.com/fredden +[@gsherwood]: https://github.com/gsherwood +[@jrfnl]: https://github.com/jrfnl +[@rodrigoprimo]: https://github.com/rodrigoprimo +[@Soh1121]: https://github.com/Soh1121 diff --git a/app/vendor/squizlabs/php_codesniffer/CHANGELOG.md b/app/vendor/squizlabs/php_codesniffer/CHANGELOG.md deleted file mode 100644 index 301ceb8b3..000000000 --- a/app/vendor/squizlabs/php_codesniffer/CHANGELOG.md +++ /dev/null @@ -1,8109 +0,0 @@ -# Changelog - -The file documents changes to the PHP_CodeSniffer project. - -## [Unreleased] - -_Nothing yet._ - -## [3.13.4] - 2025-09-05 - -### Fixed -- Fixed bug [#1213]: ability to run tests for external standards using the PHPCS native test framework was broken. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#1214]: PHP 8.5 "Using null as an array offset" deprecation notices. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -[#1213]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1213 -[#1214]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1214 - - -## [3.13.3] - 2025-09-04 - -### Added -- Tokenizer support for PHP 8.4 dereferencing of new expressions without wrapping parentheses. [#1160] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Tokenizer support for PHP 8.4 `abstract` properties. [#1183] - - The `File::getMemberProperties()` method now also supports `abstract` properties through a new `is_abstract` array index in the return value. [#1184] - - Additionally, the following sniffs have been updated to support `abstract` properties: - - Generic.PHP.LowerCaseConstant [#1185] - - Generic.PHP.UpperCaseConstant [#1185] - - PSR2.Classes.PropertyDeclaration [#1188] - - Squiz.Commenting.VariableComment [#1186] - - Squiz.WhiteSpace.MemberVarSpacing [#1187] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches -- Tokenizer support for the PHP 8.4 "exit as a function call" change. [#1201] - - When `exit`/`die` is used as a fully qualified "function call", it will now be tokenized as `T_NS_SEPARATOR` + `T_EXIT`. - - Additionally, the following sniff has been updated to handle fully qualified exit/die correctly: - - Squiz.PHP.NonExecutableCode - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches - -### Changed -- Tokenizer/PHP: fully qualified `true`/`false`/`null` will now be tokenized as `T_NS_SEPARATOR` + `T_TRUE`/`T_FALSE`/`T_NULL`. [#1201] - - Previously, these were tokenized as `T_NS_SEPARATOR` + `T_STRING`. - - Additionally, the following sniffs have been updated to handle fully qualified true/false/null correctly: - - Generic.CodeAnalysis.UnconditionalIfStatement - - Generic.ControlStructures.DisallowYodaConditions - - PEAR.Functions.ValidDefaultValue - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. -- Generic.PHP.Syntax: the sniff is now able to scan input provided via STDIN on non-Windows OSes. [#915] - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- PSR2.ControlStructures.SwitchDeclaration: the `WrongOpener*` error code is now auto-fixable if the identified "wrong opener" is a semi-colon. [#1161] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The PSR2.Classes.PropertyDeclaration will now check that the abstract modifier keyword is placed before a visibility keyword. [#1188] - - Errors will be reported via a new `AbstractAfterVisibility` error code. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Bernhard Zwein][@benno5020], [Rick Kerkhof][@NanoSector], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#1112] : `--parallel` option fails if PHP_CodeSniffer is invoked via bash and the invokation creates a non-PHPCS-managed process. - - Thanks to [Rick Kerkhof][@NanoSector] for the patch. -- Fixed bug [#1113] : fatal error when the specified "files to scan" would result in the same file being added multiple times to the queue. - - This error only occured when `--parallel` scanning was enabled. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#1154] : PEAR.WhiteSpace.ObjectOperatorIndent: false positive when checking multiple chained method calls in a multidimensional array. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#1193] : edge case inconsistency in how empty string array keys for sniff properties are handled. - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#1197] : Squiz.Commenting.FunctionComment: return types containing a class name with underscores would be truncated leading to incorrect results. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -### Other -- The [Wiki documentation] is now publicly editable. :tada: - - Update proposals can be submittted by opening a pull request in the [PHPCSStandards/PHP_CodeSniffer-documentation][docs-repo] repository. - Contributions welcome ! - - Thanks to [Anna Filina][@afilina], [Dan Wallis][@fredden] and [Juliette Reinders Folmer][@jrfnl] for their work on getting this set up. -- The [Phar website] has had a facelift. [#107] - - Thanks to [Bernhard Zwein][@benno5020] for making this happen! - -[Wiki documentation]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki -[docs-repo]: https://github.com/PHPCSStandards/PHP_CodeSniffer-documentation -[Phar website]: https://phars.phpcodesniffer.com/ - -[#107]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/107 -[#915]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/915 -[#1112]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1112 -[#1113]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1113 -[#1154]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1154 -[#1160]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1160 -[#1161]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1161 -[#1183]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1183 -[#1184]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1184 -[#1185]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1185 -[#1186]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1186 -[#1187]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1187 -[#1188]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1188 -[#1193]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1193 -[#1197]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1197 -[#1201]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1201 - - -## [3.13.2] - 2025-06-18 - -### Changed -- The documentation for the following sniffs has been improved: - - Squiz.Classes.SelfMemberReference - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#1135] : Squiz.Functions.FunctionDeclarationArgumentSpacing: typo in new error code `SpacingAfterSetVis\[i\]bility`. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -[#1135]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1135 - - -## [3.13.1] - 2025-06-13 - -### Added -- Added support for PHP 8.4 properties with asymmetric visibility to File::getMemberProperties() through a new `set_scope` array index in the return value. [#1116] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. -- Added support for PHP 8.4 (constructor promoted) properties with asymmetric visibility to File::getMethodParameters() through new `set_visibility` and `set_visibility_token` array indexes in the return value. [#1116] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. -- Added support for PHP 8.4 asymmetric visibility modifiers to the following sniffs: - - Generic.PHP.LowerCaseKeyword [#1117] - - PEAR.NamingConventions.ValidVariableName [#1118] - - PSR2.Classes.PropertyDeclaration [#1119] - - Squiz.Commenting.BlockComment [#1120] - - Squiz.Commenting.DocCommentAlignment [#1120] - - Squiz.Commenting.VariableComment [#1120] - - Squiz.Functions.FunctionDeclarationArgumentSpacing [#1121] - - Squiz.Scope.MemberVarScope [#1122] - - Squiz.WhiteSpace.MemberVarSpacing [#1123] - - Squiz.WhiteSpace.ScopeKeywordSpacing [#1124] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. - -### Changed -- The PSR2.Classes.PropertyDeclaration will now check that a set-visibility modifier keyword is placed after a potential general visibility keyword. [#1119] - - Errors will be reported via a new `AvizKeywordOrder` error code. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The Squiz.Functions.FunctionDeclarationArgumentSpacing will now check spacing after a set-visibility modifier keyword. [#1121] - - Errors will be reported via a new `SpacingAfterSetVisibility` error code. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The Squiz.Scope.MemberVarScope will now flag missing "read" visibility, when "write" visibility is set, under a separate error code `AsymReadMissing`. [#1122] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The documentation for the following sniffs has been improved: - - PEAR.Classes.ClassDeclaration - - Squiz.WhiteSpace.FunctionOpeningBraceSpace - - Thanks to [Brian Dunne][@braindawg] and [Rodrigo Primo][@rodrigoprimo] for the patches. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Dan Wallis][@fredden], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Other -- The latest PHP_CodeSniffer XSD file is now available via the following permalink: . [#1094] - Older XSD files can be referenced via permalinks based on their minor: `https://schema.phpcodesniffer.com/#.#/phpcs.xsd`. -- The GPG signature for the PHAR files has been rotated. The new fingerprint is: D91D86963AF3A29B6520462297B02DD8E5071466. - -[#1094]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1094 -[#1116]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1116 -[#1117]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1117 -[#1118]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1118 -[#1119]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1119 -[#1120]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1120 -[#1121]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1121 -[#1122]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1122 -[#1123]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1123 -[#1124]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1124 - - -## [3.13.0] - 2025-05-11 - -### Added -- Added support for PHP 8.4 asymmetric visibility modifiers to the tokenizer. [#871] - - Thanks to [Daniel Scherzer][@DanielEScherzer] for the patch. -- Added support for PHP 8.4 `final` properties to the following sniffs: - - PSR2.Classes.PropertyDeclaration [#950] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. - -### Changed -- Generic.WhiteSpace.LanguageConstructSpacing: will now also check the spacing after the `goto` language construct keyword. [#917] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The PSR2.Classes.PropertyDeclaration will now check that the `final` modifier keyword is placed before a visibility keyword. [#950] - - Errors will be reported via a new `FinalAfterVisibility` error code. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Improved Help information about the `--reports` CLI flag. [#1078] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The documentation for the following sniffs has been improved: - - PSR1.Files.SideEffects - - PSR2.ControlStructures.SwitchDeclaration - - PSR2.Namespaces.NamespaceDeclaration - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patches. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Deprecated - -- Nearly everything which was soft deprecated before is now hard deprecated and will show deprecation notices: - - This applies to: - - All sniffs which will be removed in 4.0. [#888] - - The deprecated Generator methods. [#889] - - The old array property setting format (via comma separated strings). [#890] - - Sniffs not implementing the `PHP_CodeSniffer\Sniffs\Sniff` interface. [#891] - - Sniffs not following the naming conventions. [#892] - - Standards called Internal. [#893] - - Sniffs which don't listen for PHP, like JS/CSS specific sniffs. [#894] - - The deprecation notices can be silenced by using the `-q` (=quiet) CLI flag. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. - -### Fixed -- Fixed bug [#1040] : Generic.Strings.UnnecessaryHeredoc - false positive for heredocs containing escape sequences. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#1040] : Generic.Strings.UnnecessaryHeredoc - fixer would not clean up escape sequences which aren't necessary in nowdocs. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#1048] : A file under scan would sometimes be updated with partial fixes, even though the file "failed to fix". - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -### Other -**Calling all testers!** - -The first beta release for PHP_CodeSniffer 4.0 has been tagged. Please help by testing the beta release and reporting any issues you run into. -Upgrade guides for both [ruleset maintainers/end-users][wiki-upgrade-guide-users-40], as well as for [sniff developers and integrators][wiki-upgrade-guide-devs-40], have been published to the Wiki to help smooth the transition. - -[wiki-upgrade-guide-users-40]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-User-Upgrade-Guide -[wiki-upgrade-guide-devs-40]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-Developer-Upgrade-Guide - -[#871]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/871 -[#888]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/888 -[#889]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/889 -[#890]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/890 -[#891]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/891 -[#892]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/892 -[#893]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/893 -[#894]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/894 -[#917]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/917 -[#950]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/950 -[#1040]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1040 -[#1048]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1048 -[#1078]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/1078 - -## [3.12.2] - 2025-04-13 - -### Added -- Added support for PHP 8.4 `final` properties to the following sniffs: - - Generic.PHP.LowerCaseConstant [#948] - - Generic.PHP.UpperCaseConstant [#948] - - Squiz.Commenting.DocCommentAlignment [#951] - - Squiz.Commenting.VariableComment [#949] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. - -### Changed -- Tokenizer/PHP: a PHP open tag at the very end of a file will now always be tokenized as T_OPEN_TAG, independently of the PHP version. [#937] - - Previously, a PHP open tag at the end of a file was not tokenized as an open tag on PHP < 7.4 and the tokenization would depend on the `short_open_tag` setting. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- PEAR.Commenting.FunctionComment: improved message for "blank lines between docblock and declaration" check. [#830] -- The documentation for the following sniffs has been improved: - - Generic.Functions.OpeningFunctionBraceBsdAllman - - Generic.Functions.OpeningFunctionBraceKernighanRitchie - - Generic.WhiteSpace.LanguageConstructSpacing - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patches. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#830] : PEAR.Commenting.FunctionComment will no longer remove blank lines within attributes. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#929] : Generic.PHP.ForbiddenFunctions: prevent false positives/negatives for code interlaced with comments. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#934] : Generic.PHP.LowerCaseConstant and Generic.PHP.UpperCaseConstant will now correctly ignore DNF types for properties. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#936] : Squiz.Commenting.FunctionCommentThrowTag: sniff would bow out when function has attributes attached, leading to false negatives. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#940] : Squiz.Commenting.VariableComment: false positive for missing docblock for properties using DNF types. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#944] : Squiz.Commenting.FunctionComment did not support DNF/intersection types in `@param` tags. - - Thanks to [Jeffrey Angenent][@devfrey] for the patch. -- Fixed bug [#945] : Squiz.WhiteSpace.FunctionSpacing would get confused when there are two docblocks above a function declaration. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#947] : Squiz.Commenting.FunctionCommentThrowTag: prevent false positives/negatives for code interlaced with comments. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#951] : Squiz.Commenting.DocCommentAlignment did not examine docblocks for `final` classes. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#955] : Potential race condition, leading to a fatal error, when both the `Diff` + the `Code` reports are requested and caching is on. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#956] : Generic.WhiteSpace.ScopeIndent: undefined array index notice when running in debug mode. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -[#830]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/830 -[#929]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/929 -[#934]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/934 -[#936]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/936 -[#937]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/937 -[#940]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/940 -[#944]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/944 -[#945]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/945 -[#947]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/947 -[#948]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/948 -[#949]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/949 -[#951]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/951 -[#955]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/955 -[#956]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/956 - -## [3.12.1] - 2025-04-04 - -### Added -- Documentation for the following sniffs: - - Squiz.Commenting.BlockComment - - Thanks to [Colin Stewart][@costdev] for the patch. - -### Changed -- Generic.WhiteSpace.HereNowdocIdentifierSpacing: improved error message text. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Deprecated -- The `Generic.Functions.CallTimePassByReference` sniff. See [#921]. - - This sniff will be removed in version 4.0.0. - -### Fixed -- Fixed bug [#906] : Fixer: prevent `InvalidArgumentException`s when displaying verbose information. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#907] : Tokenizer/PHP: tokenization of tokens related to union, intersection and DNF types in combination with PHP 8.4 final properties. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#908] : Tokenizer/PHP: tokenization of `?` in nullable types for readonly properties. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#916] : Tokenizer/PHP: `goto` was not recognized as a terminating statement for a case/default in a switch control structure. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -### Other -- PHP_CodeSniffer 4.0 is coming soon! Interested in a sneak peek ? Join the live stream at any time on April 14, 15, 17 or 18. - Read the open invitation ([#924]) for all the details. - -[#906]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/906 -[#907]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/907 -[#908]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/908 -[#916]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/916 -[#921]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/921 -[#924]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/924 - -## [3.12.0] - 2025-03-18 - -### Added -- Added support for PHP 8.4 `final` properties to File::getMemberProperties() through a new `is_final` array index in the return value. [#834] - - Thanks to [Daniel Scherzer][@DanielEScherzer] for the patch. -- Generators/HTML: each section title now has a unique anchor link, which can be copied when hovering over a title. [#859] - - This should make sharing a link to a specific section of the documentation more straight-forward. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Documentation for the following sniffs: - - Squiz.Classes.ClassFileName - - Squiz.Classes.ValidClassName - - Thanks to [Brian Dunne][@braindawg] for the patches. - -### Changed -- PHPCBF: the messaging when no fixable errors are found will now distinguish between "No violations" (at all) versus "No fixable errors". [#806] - - Thanks to [Peter Wilson][@peterwilsoncc] for the patch. -- The `-h` (Help) option now contains a more extensive list of "config" options which can be set. [#809] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Improved error message when invalid sniff codes are supplied to `--sniffs` or `--exclude` command line arguments. [#344] - - Thanks to [Dan Wallis][@fredden] for the patch. -- Improved error message when an invalid generator name is supplied to the `--generator` command line argument. [#709], [#771] - - The generator name will now also always be handled case-insensitively, independently of the OS used. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- The user will be shown an informative error message for sniffs missing one of the required methods. [#873] - - Previously this would result in a fatal error. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Ruleset processing will now be allowed to run to its conclusion - barring critical errors - before displaying all ruleset errors in one go. [#857] - - Previously an error in a ruleset would cause PHPCS to exit immediately and show only one error at a time. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators: XML documentation files which don't contain any actual documentation will now silently be ignored. [#755] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators: when the `title` attribute is missing, the documentation generation will now fall back to the sniff name as the title. [#820] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators: cleaner output based on the elements of the documentation which are available. [#819], [#821] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators/HTML: improved display of code tables by using semantic HTML. [#854] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Squiz.Classes.ClassFileName: recommend changing the file name instead of changing the class name. [#845] - - This prevents unactionable recommendations due to the file name not translating to a valid PHP symbol name. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Squiz.Functions.FunctionDeclarationArgumentSpacing: incorrect spacing after a comma followed by a promoted property has an improved error message and will now be flagged with the `SpacingBeforePropertyModifier` or `NoSpaceBeforePropertyModifier` error codes. [#792] - - This was previously already flagged, but using either the `SpacingBeforeHint` or `NoSpaceBeforeHint` error code, which was misleading. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Squiz.Functions.FunctionDeclarationArgumentSpacing: the sniff will now also check the spacing after property modifiers for promoted properties in constructor methods. [#792] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Squiz.WhiteSpace.ScopeKeywordSpacing: the sniff will now also check the spacing after the `final` and `abstract` modifier keywords. [#604] - - Thanks to [Klaus Purer][@klausi] for the patch. -- The following sniff(s) have received efficiency improvements: - - Squiz.WhiteSpace.ScopeKeywordSpacing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. -- Incorrectly set inline properties (in test case files) will be silently ignored again. [#884] - - This removes the `Internal.PropertyDoesNotExist` error code. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The AbstractMethodUnitTest class will now flag duplicate test case markers in a test case file. [#773] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Asis Pattisahusiwa][@asispts], [Dan Wallis][@fredden], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Deprecated -All deprecation are slated for removal in PHP_CodeSniffer 4.0. - -- Support for sniffs not implementing the PHPCS `Sniff` interface. See [#694]. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Support for including sniffs which don't comply with the PHPCS naming conventions (by referencing the sniff file directly). See [#689]. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Support for external standards named "Internal". See [#799]. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The following Generator methods are now (soft) deprecated. See [#755]: - - `PHP_CodeSniffer\Generators\Text::printTitle()` in favour of `PHP_CodeSniffer\Generators\Text::getFormattedTitle()` - - `PHP_CodeSniffer\Generators\Text::printTextBlock()` in favour of `PHP_CodeSniffer\Generators\Text::getFormattedTextBlock()` - - `PHP_CodeSniffer\Generators\Text::printCodeComparisonBlock()` in favour of `PHP_CodeSniffer\Generators\Text::getFormattedCodeComparisonBlock()` - - `PHP_CodeSniffer\Generators\Markdown::printHeader()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedHeader()` - - `PHP_CodeSniffer\Generators\Markdown::printFooter()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedFooter()` - - `PHP_CodeSniffer\Generators\Markdown::printTextBlock()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedTextBlock()` - - `PHP_CodeSniffer\Generators\Markdown::printCodeComparisonBlock()` in favour of `PHP_CodeSniffer\Generators\Markdown::getFormattedCodeComparisonBlock()` - - `PHP_CodeSniffer\Generators\HTML::printHeader()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedHeader()` - - `PHP_CodeSniffer\Generators\HTML::printToc()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedToc()` - - `PHP_CodeSniffer\Generators\HTML::printFooter()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedFooter()` - - `PHP_CodeSniffer\Generators\HTML::printTextBlock()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedTextBlock()` - - `PHP_CodeSniffer\Generators\HTML::printCodeComparisonBlock()` in favour of `PHP_CodeSniffer\Generators\HTML::getFormattedCodeComparisonBlock()` - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -### Fixed -- Fixed bug [#794] : Generators: prevent fatal error when the XML documentation does not comply with the expected format. - - It is recommended to validate XML documentation files against the XSD file: - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#814] : Generic.NamingConventions.ConstructorName: prevent potential fatal errors during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#816] : File::getDeclarationName(): prevent incorrect result for unfinished closures during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#817] : Squiz.Classes.ValidClassName: ignore comments when determining the name to be validated. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#825] : Squiz.Classes.ClassDeclaration: false positives when the next thing after a class was a function with an attribute attached. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#826] : Squiz.WhiteSpace.FunctionSpacing: prevent incorrect some results when attributes are attached to a function. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#827] : PEAR.Functions.FunctionDeclaration: fixer conflict over an unfinished closure during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#828] : Squiz.WhiteSpace.MemberVarSpacing: allow for `readonly` properties. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#832] : Squiz.WhiteSpace.MemberVarSpacing: prevent potential fixer conflict during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#833] : Squiz.PHP.EmbeddedPhp: fixer conflict when a PHP open tag for a multi-line snippet is found on the same line as a single-line embedded PHP snippet. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#833] : Squiz.PHP.EmbeddedPhp: incorrect indent calculation in certain specific situations. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#835] : Generic.PHP.DisallowShortOpenTag: don't act on parse errors. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#838] : Squiz.PHP.EmbeddedPhp: no new line before close tag was incorrectly enforced when a preceding OO construct or function had a trailing comment after the close curly. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#840] : Squiz.WhiteSpace.MemberVarSpacing: more accurate reporting on blank lines in the property "pre-amble" (i.e. docblock, attributes). - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#845] : Squiz.Classes.ClassFileName: don't throw an incorrect error for an unfinished OO declaration during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#865] : Setting an array property to an empty array from an XML ruleset now works correctly. - - Previously, the property value would be set to `[0 => '']`. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#866] : Squiz.WhiteSpace.FunctionOpeningBraceSpace: XML docs were not accessible due to an issue with the file name. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -### Other -- A new [wiki page][wiki-about-standards] is available to clarify the difference between a project ruleset and an external standard. - - This wiki page also contains detailed information about the naming conventions external standards must comply with. -- A new [XMLLint validate][xmllint-validate] action runner is available which can be used in CI to validate rulesets for PHP_CodeSniffer against the XSD. - -[wiki-about-standards]: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/About-Standards-for-PHP_CodeSniffer -[xmllint-validate]: https://github.com/marketplace/actions/xmllint-validate - -[#344]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/344 -[#604]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/604 -[#689]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/689 -[#694]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/694 -[#709]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/709 -[#755]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/755 -[#771]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/771 -[#773]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/773 -[#792]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/792 -[#794]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/794 -[#799]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/799 -[#806]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/806 -[#809]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/809 -[#814]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/814 -[#816]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/816 -[#817]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/817 -[#819]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/819 -[#820]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/820 -[#821]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/821 -[#825]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/825 -[#826]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/826 -[#827]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/827 -[#828]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/828 -[#832]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/832 -[#833]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/833 -[#834]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/834 -[#835]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/835 -[#838]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/838 -[#840]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/840 -[#845]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/845 -[#854]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/854 -[#857]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/857 -[#859]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/859 -[#865]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/865 -[#866]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/866 -[#873]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/873 -[#884]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/884 - -## [3.11.3] - 2025-01-23 - -### Changed -- Generic.ControlStructures.InlineControlStructure no longer unnecessarily listens for T_SWITCH tokens. [#595] - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Squiz.Functions.FunctionDeclarationArgumentSpacing: improvements to error message for `SpaceBeforeComma` error. [#783] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The following sniff(s) have received efficiency improvements: - - Squiz.Functions.FunctionDeclarationArgumentSpacing - - Thanks to [Dan Wallis][@fredden] and [Juliette Reinders Folmer][@jrfnl] for the patches. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Michał Bundyra][@michalbundyra], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#620] : Squiz.Functions.FunctionDeclarationArgumentSpacing: newlines after type will now be handled by the fixer. This also prevents a potential fixer conflict. - - Thanks to [Dan Wallis][@fredden] for the patch. -- Fixed bug [#782] : Tokenizer/PHP: prevent an "Undefined array key" notice during live coding for unfinished arrow functions. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: new line after reference token was not flagged nor fixed. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: new line after variadic token was not flagged nor fixed. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: new line before/after the equal sign for default values was not flagged nor fixed when `equalsSpacing` was set to `0`. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: fixer conflict when a new line is found before/after the equal sign for default values and `equalsSpacing` was set to `1`. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: fixer for spacing before/after equal sign could inadvertently remove comment. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#783] : Squiz.Functions.FunctionDeclarationArgumentSpacing: fixer will now handle comments between the end of a parameter and a comma more cleanly. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#784] : Squiz.WhiteSpace.FunctionSpacing: prevent fixer conflict when a multi-line docblock would start on the same line as the function close curly being examined. - - Thanks to [Klaus Purer][@klausi] for the patch - -[#595]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/595 -[#620]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/620 -[#782]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/782 -[#783]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/783 -[#784]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/784 - -## [3.11.2] - 2024-12-11 - -### Changed -- Generators/HTML + Markdown: the output will now be empty (no page header/footer) when there are no docs to display. [#687] - - This is in line with the Text Generator which already didn't produce output if there are no docs. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators/HTML: only display a Table of Contents when there is more than one sniff with documentation. [#697] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators/HTML: improved handling of line breaks in `` blocks. [#723] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators/Markdown: improved compatibility with the variety of available markdown parsers. [#722] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generators/Markdown: improved handling of line breaks in `` blocks. [#737] - - This prevents additional paragraphs from being displayed as code blocks. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Generic.NamingConventions.UpperCaseConstantName: the exact token containing the non-uppercase constant name will now be identified with more accuracy. [#665] - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Generic.Functions.OpeningFunctionBraceKernighanRitchie: minor improvement to the error message wording. [#736] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#527] : Squiz.Arrays.ArrayDeclaration: short lists within a foreach condition should be ignored. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positives and false negatives when code uses unconventional spacing and comments when calling `define()`. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive when a constant named `DEFINE` is encountered. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive for attribute class called `define`. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#665] : Generic.NamingConventions.UpperCaseConstantName: false positive when handling the instantiation of a class named `define`. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#688] : Generators/Markdown could leave error_reporting in an incorrect state. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#698] : Generators/Markdown : link in the documentation footer would not parse as a link. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#738] : Generators/Text: stray blank lines after code sample titles. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#739] : Generators/HTML + Markdown: multi-space whitespace within a code sample title was folded into a single space. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -[#527]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/527 -[#665]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/665 -[#687]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/687 -[#688]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/688 -[#697]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/697 -[#698]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/698 -[#722]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/722 -[#723]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/723 -[#736]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/736 -[#737]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/737 -[#738]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/738 -[#739]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/739 - -## [3.11.1] - 2024-11-16 - -### Changed -- Output from the `--generator=...` feature will respect the OS-expected EOL char in more places. [#671] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Bartosz Dziewoński][@MatmaRex] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#674] : Generic.WhiteSpace.HereNowdocIdentifierSpacing broken XML documentation - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Fixed bug [#675] : InvalidArgumentException when a ruleset includes a sniff by file name and the included sniff does not comply with the PHPCS naming conventions. - - Notwithstanding this fix, it is strongly recommended to ensure custom sniff classes comply with the PHPCS naming conventions. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -[#671]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/671 -[#674]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/674 -[#675]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/675 - -## [3.11.0] - 2024-11-12 - -### Added -- Runtime support for PHP 8.4. All known PHP 8.4 deprecation notices have been fixed. - - Syntax support for new PHP 8.4 features will follow in a future release. - - If you find any PHP 8.4 deprecation notices which were missed, please report them. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. -- Tokenizer support for PHP 8.3 "yield from" expressions with a comment between the keywords. [#529], [#647] - - Sniffs explicitly handling T_YIELD_FROM tokens may need updating. The PR description contains example code for use by sniff developers. - - Additionally, the following sniff has been updated to support "yield from" expressions with comments: - - Generic.WhiteSpace.LanguageConstructSpacing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- New `Generic.WhiteSpace.HereNowdocIdentifierSpacing` sniff. [#586], [#637] - - Forbid whitespace between the `<<<` and the identifier string in heredoc/nowdoc start tokens. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- New `Generic.Strings.UnnecessaryHeredoc` sniff. [#633] - - Warns about heredocs without interpolation or expressions in the body text and can auto-fix these to nowdocs. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Documentation for the following sniffs: - - Generic.Arrays.ArrayIndent - - Squiz.PHP.Heredoc - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for the patches. - -### Changed -- The Common::getSniffCode() method will now throw an InvalidArgumentException exception if an invalid `$sniffClass` is passed. [#524], [#625] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Documentation generated using the `--generator=...` feature will now always be presented in natural order based on the sniff name(s). [#668] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Minor improvements to the display of runtime information. [#658] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Squiz.Commenting.PostStatementComment: trailing annotations in PHP files will now be reported under a separate, non-auto-fixable error code `AnnotationFound`. [#560], [#627] - - This prevents (tooling related) annotations from taking on a different meaning when moved by the fixer. - - The separate error code also allows for selectively excluding it to prevent the sniff from triggering on trailing annotations, while still forbidding other trailing comments. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Squiz.ControlStructures.ForEachLoopDeclaration: the `SpacingAfterOpen` error code has been replaced by the `SpaceAfterOpen` error code. The latter is a pre-existing code. The former appears to have been a typo. [#582] - - Thanks to [Dan Wallis][@fredden] for the patch. -- The following sniff(s) have received efficiency improvements: - - Generic.Classes.DuplicateClassName - - Generic.NamingConventions.ConstructorName - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for the patches. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#3808][sq-3808] : Generic.WhiteSpace.ScopeIndent would throw false positive for tab indented multi-token yield from expression. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#630] : The tokenizer could inadvertently transform "normal" parentheses to DNF parentheses, when a function call was preceded by a switch-case / alternative syntax control structure colon. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#645] : On PHP 5.4, if yield was used as the declaration name for a function declared to return by reference, the function name would incorrectly be tokenized as T_YIELD instead of T_STRING. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#647] : Tokenizer not applying tab replacement in single token "yield from" keywords. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#647] : Generic.WhiteSpace.DisallowSpaceIndent did not flag space indentation in multi-line yield from. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#647] : Generic.WhiteSpace.DisallowTabIndent did not flag tabs inside yield from. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#652] : Generic.NamingConventions.ConstructorName: false positives for PHP-4 style calls to PHP-4 style parent constructor when a method with the same name as the parent class was called on another class. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#652] : Generic.NamingConventions.ConstructorName: false negatives for PHP-4 style calls to parent constructor for function calls with whitespace and comments in unconventional places. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#653] : Generic.Classes.DuplicateClassName : the sniff did not skip namespace keywords used as operators, which could lead to false positives. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#653] : Generic.Classes.DuplicateClassName : sniff going into an infinite loop during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#653] : Generic.Classes.DuplicateClassName : false positives/negatives when a namespace declaration contained whitespace or comments in unconventional places. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#653] : Generic.Classes.DuplicateClassName : namespace for a file going in/out of PHP was not remembered/applied correctly. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-3808]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3808 -[#524]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/524 -[#529]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/529 -[#560]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/560 -[#582]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/582 -[#586]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/586 -[#625]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/625 -[#627]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/627 -[#630]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/630 -[#633]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/633 -[#637]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/637 -[#645]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/645 -[#647]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/647 -[#652]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/652 -[#653]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/653 -[#658]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/658 -[#668]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/668 - -## [3.10.3] - 2024-09-18 - -### Changed -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#553] : Squiz.Classes.SelfMemberReference: false negative(s) when namespace operator was encountered between the namespace declaration and the OO declaration. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#579] : AbstractPatternSniff: potential PHP notice during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#580] : Squiz.Formatting.OperatorBracket: potential PHP notice during live coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#581] : PSR12.ControlStructures.ControlStructureSpacing: prevent fixer conflict by correctly handling multiple empty newlines before the first condition in a multi-line control structure. - - Thanks to [Dan Wallis][@fredden] for the patch. -- Fixed bug [#585] : Tokenizer not applying tab replacement in heredoc/nowdoc openers. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#588] : Squiz.PHP.EmbeddedPhp false positive when checking spaces after a PHP short open tag. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#597] : Generic.PHP.LowerCaseKeyword did not flag nor fix non-lowercase anonymous class keywords. - - Thanks to [Marek Štípek][@maryo] for the patch. -- Fixed bug [#598] : Squiz.PHP.DisallowMultipleAssignments: false positive on assignments to variable property on object stored in array. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#608] : Squiz.Functions.MultiLineFunctionDeclaration did not take (parameter) attributes into account when checking for one parameter per line. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Other -- The provenance of PHAR files associated with a release can now be verified via [GitHub Artifact Attestations][ghattest] using the [GitHub CLI tool][ghcli] with the following command: `gh attestation verify [phpcs|phpcbf].phar -o PHPCSStandards`. [#574] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. - -[#553]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/553 -[#574]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/574 -[#579]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/579 -[#580]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/580 -[#581]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/581 -[#585]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/585 -[#588]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/588 -[#597]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/597 -[#598]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/598 -[#608]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/608 - -[ghcli]: https://cli.github.com/ -[ghattest]: https://docs.github.com/en/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations - -## [3.10.2] - 2024-07-22 - -### Changed -- The following sniff(s) have received efficiency improvements: - - Generic.Functions.FunctionCallArgumentSpacing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The array format of the information passed to the `Reports::generateFileReport()` method is now documented in the Reports interface. [#523] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Bill Ruddock][@biinari], [Dan Wallis][@fredden], [Klaus Purer][@klausi], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#513] : Generic.Functions.FunctionCallArgumentSpacing did not ignore the body of a match expressions passed as a function argument, which could lead to false positives. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#533] : Generic.WhiteSpace.DisallowTabIndent: tab indentation for heredoc/nowdoc closers will no longer be auto-fixed to prevent parse errors. The issue will still be reported. - - The error code for heredoc/nowdoc indentation using tabs has been made more specific - `TabsUsedHeredocCloser` - to allow for selectively excluding the indentation check for heredoc/nowdoc closers. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#534] : Generic.WhiteSpace.DisallowSpaceIndent did not report on space indentation for PHP 7.3 flexible heredoc/nowdoc closers. - - Closers using space indentation will be reported with a dedicated error code: `SpacesUsedHeredocCloser`. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#537] : Squiz.PHP.DisallowMultipleAssignments false positive for list assignments at the start of a new PHP block after an embedded PHP statement. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#551] : Squiz.PHP.DisallowMultipleAssignments prevent false positive for function parameters during live coding. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#554] : Generic.CodeAnalysis.UselessOverridingMethod edge case false negative when the call to the parent method would end on a PHP close tag. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#555] : Squiz.Classes.SelfMemberReference edge case false negative when the namespace declaration would end on a PHP close tag. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[#513]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/513 -[#523]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/523 -[#533]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/533 -[#534]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/534 -[#537]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/537 -[#551]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/551 -[#554]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/554 -[#555]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/555 - -## [3.10.1] - 2024-05-22 - -### Added -- Documentation for the following sniffs: - - Generic.Commenting.DocComment - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. - -### Changed -- The following have received efficiency improvements: - - Type handling in the PHP Tokenizer - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#110], [#437], [#475] : `File::findStartOfStatement()`: the start of statement/expression determination for tokens in parentheses/short array brackets/others scopes, nested within match expressions, was incorrect in most cases. - The trickle down effect of the bug fixes made to the `File::findStartOfStatement()` method, is that the Generic.WhiteSpace.ScopeIndent and the PEAR.WhiteSpace.ScopeIndent sniffs should now be able to correctly determine and fix the indent for match expressions containing nested expressions. - These fixes also fix an issue with the `Squiz.Arrays.ArrayDeclaration` sniff and possibly other, unreported bugs. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#504] : The tokenizer could inadvertently mistake the last parameter in a function call using named arguments for a DNF type. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#508] : Tokenizer/PHP: extra hardening against handling parse errors in the type handling layer. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[#110]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/110 -[#437]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/437 -[#475]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/475 -[#504]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/504 -[#508]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/508 - -## [3.10.0] - 2024-05-20 - -### Added -- Tokenizer support for PHP 8.2 Disjunctive Normal Form (DNF) types. [#3731][sq-3731], [#387], [#461] - - Includes new `T_TYPE_OPEN_PARENTHESIS` and `T_TYPE_CLOSE_PARENTHESIS` tokens to represent the parentheses in DNF types. - - These new tokens, like other parentheses, will have the `parenthesis_opener` and `parenthesis_closer` token array indexes set and the tokens between them will have the `nested_parenthesis` index. - - The `File::getMethodProperties()`, `File::getMethodParameters()` and `File::getMemberProperties()` methods now all support DNF types. [#471], [#472], [#473] - - Additionally, the following sniff has been updated to support DNF types: - - Generic.PHP.LowerCaseType [#478] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches. -- Documentation for the following sniffs: - - Squiz.WhiteSpace.FunctionClosingBraceSpace - - Thanks to [Przemek Hernik][@przemekhernik] for the patch. - -### Changed -- The help screens have received a face-lift for improved usability and readability. [#447] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch and thanks to [Colin Stewart][@costdev], [Gary Jones][@GaryJones] and [@mbomb007] for reviewing. -- The Squiz.Commenting.ClosingDeclarationComment sniff will now also examine and flag closing comments for traits. [#442] - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- The following sniff(s) have efficiency improvements: - - Generic.Arrays.ArrayIndent - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- The autoloader will now always return a boolean value indicating whether it has loaded a class or not. [#479] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Dan Wallis][@fredden], [Danny van der Sluijs][@DannyvdSluijs], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#466] : Generic.Functions.CallTimePassByReference was not flagging call-time pass-by-reference in class instantiations using the self/parent/static keywords. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#494] : edge case bug in tokenization of an empty block comment. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#494] : edge case bug in tokenization of an empty single-line DocBlock. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#499] : Generic.ControlStructures.InlineControlStructure now handles statements with a comment between `else` and `if` correctly. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. - -[sq-3731]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3731 -[#387]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/387 -[#442]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/442 -[#447]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/447 -[#461]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/461 -[#466]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/466 -[#471]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/471 -[#472]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/472 -[#473]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/473 -[#478]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/478 -[#479]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/479 -[#494]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/494 -[#499]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/499 - -## [3.9.2] - 2024-04-24 - -### Changed -- The Generic.ControlStructures.DisallowYodaConditions sniff no longer listens for the null coalesce operator. [#458] - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Dan Wallis][@fredden], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#381] : Squiz.Commenting.ClosingDeclarationComment could throw the wrong error when the close brace being examined is at the very end of a file. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#385] : Generic.CodeAnalysis.JumbledIncrementer improved handling of parse errors/live coding. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#394] : Generic.Functions.CallTimePassByReference was not flagging call-time pass-by-reference in anonymous class instantiations - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#420] : PEAR.Functions.FunctionDeclaration could run into a blocking PHP notice while fixing code containing a parse error. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#421] : File::getMethodProperties() small performance improvement & more defensive coding. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#423] : PEAR.WhiteSpace.ScopeClosingBrace would have a fixer conflict with itself when a close tag was preceded by non-empty inline HTML. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#424] : PSR2.Classes.ClassDeclaration using namespace relative interface names in the extends/implements part of a class declaration would lead to a fixer conflict. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#427] : Squiz.Operators.OperatorSpacing would have a fixer conflict with itself when an operator was preceeded by a new line and the previous line ended in a comment. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#430] : Squiz.ControlStructures.ForLoopDeclaration: fixed potential undefined array index notice - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#431] : PSR2.Classes.ClassDeclaration will no longer try to auto-fix multi-line interface implements statements if these are interlaced with comments on their own line. This prevents a potential fixer conflict. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#453] : Arrow function tokenization was broken when the return type was a stand-alone `true` or `false`; or contained `true` or `false` as part of a union type. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Other -- [ESLint 9.0] has been released and changes the supported configuration file format. - The (deprecated) `Generic.Debug.ESLint` sniff only supports the "old" configuration file formats and when using the sniff to run ESLint, the `ESLINT_USE_FLAT_CONFIG=false` environment variable will need to be set when using ESLint >= 9.0. - For more information, see [#436]. - - -[ESLint 9.0]: https://eslint.org/blog/2024/04/eslint-v9.0.0-released/#flat-config-is-now-the-default-and-has-some-changes - -[#381]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/381 -[#385]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/385 -[#394]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/394 -[#420]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/420 -[#421]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/421 -[#423]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/423 -[#424]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/424 -[#427]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/427 -[#430]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/430 -[#431]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/431 -[#436]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/436 -[#453]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/453 -[#458]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/458 - -## [3.9.1] - 2024-03-31 - -### Added -- Documentation for the following sniffs: - - Generic.PHP.RequireStrictTypes - - Squiz.WhiteSpace.MemberVarSpacing - - Squiz.WhiteSpace.ScopeClosingBrace - - Squiz.WhiteSpace.SuperfluousWhitespace - - Thanks to [Jay McPartland][@jaymcp] and [Rodrigo Primo][@rodrigoprimo] for the patches. - -### Changed -- The following sniffs have received performance related improvements: - - Generic.CodeAnalysis.UselessOverridingMethod - - Generic.Files.ByteOrderMark - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patches. -- Performance improvement for the "Diff" report. Should be most notable for Windows users. [#355] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- The test suite has received some performance improvements. Should be most notable contributors using Windows. [#351] - - External standards with sniff tests using the PHP_CodeSniffer native test framework will also benefit from these changes. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch. -- Various housekeeping, including improvements to the tests and documentation. - - Thanks to [Jay McPartland][@jaymcp], [João Pedro Oliveira][@jpoliveira08], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions. - -### Fixed -- Fixed bug [#289] : Squiz.WhiteSpace.OperatorSpacing and PSR12.Operators.OperatorSpacing : improved fixer conflict protection by more strenuously avoiding handling operators in declare statements. - - Thanks to [Dan Wallis][@fredden] for the patch. -- Fixed bug [#366] : Generic.CodeAnalysis.UselessOverridingMethod : prevent false negative when the declared method name and the called method name do not use the same case. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch. -- Fixed bug [#368] : Squiz.Arrays.ArrayDeclaration fixer did not handle static closures correctly when moving array items to their own line. - - Thanks to [Michał Bundyra][@michalbundyra] for the patch. -- Fixed bug [#404] : Test framework : fixed PHP 8.4 deprecation notice. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[#289]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/289 -[#351]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/351 -[#355]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/355 -[#366]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/366 -[#368]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/368 -[#404]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/404 - -## [3.9.0] - 2024-02-16 - -### Added -- Tokenizer support for PHP 8.3 typed class constants. [#321] - - Additionally, the following sniffs have been updated to support typed class constants: - - Generic.NamingConventions.UpperCaseConstantName [#332] - - Generic.PHP.LowerCaseConstant [#330] - - Generic.PHP.LowerCaseType [#331] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches -- Tokenizer support for PHP 8.3 readonly anonymous classes. [#309] - - Additionally, the following sniffs have been updated to support readonly anonymous classes: - - PSR12.Classes.ClassInstantiation [#324] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches -- New `PHP_CodeSniffer\Sniffs\DeprecatedSniff` interface to allow for marking a sniff as deprecated. [#281] - - If a ruleset uses deprecated sniffs, deprecation notices will be shown to the end-user before the scan starts. - When running in `-q` (quiet) mode, the deprecation notices will be hidden. - - Deprecated sniffs will still run and using them will have no impact on the exit code for a scan. - - In ruleset "explain"-mode (`-e`) an asterix `*` will show next to deprecated sniffs. - - Sniff maintainers are advised to read through the PR description for full details on how to use this feature for their own (deprecated) sniffs. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- New `Generic.CodeAnalysis.RequireExplicitBooleanOperatorPrecedence` sniff. [#197] - - Forbid mixing different binary boolean operators within a single expression without making precedence clear using parentheses - - Thanks to [Tim Düsterhus][@TimWolla] for the contribution -- Squiz.PHP.EmbeddedPhp : the sniff will now also examine the formatting of embedded PHP statements using short open echo tags. [#27] - - Includes a new `ShortOpenEchoNoSemicolon` errorcode to allow for selectively ignoring missing semicolons in single line embedded PHP snippets within short open echo tags. - - The other error codes are the same and do not distinguish between what type of open tag was used. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Documentation for the following sniffs: - - Generic.WhiteSpace.IncrementDecrementSpacing - - PSR12.ControlStructures.ControlStructureSpacing - - PSR12.Files.ImportStatement - - PSR12.Functions.ReturnTypeDeclaration - - PSR12.Properties.ConstantVisibility - - Thanks to [Denis Žoljom][@dingo-d] and [Rodrigo Primo][@rodrigoprimo] for the patches - -### Changed -- The Performance report can now also be used for a `phpcbf` run. [#308] - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Sniff tests which extend the PHPCS native `AbstractSniffUnitTest` class will now show a (non-build-breaking) warning when test case files contain fixable errors/warnings, but there is no corresponding `.fixed` file available in the test suite to verify the fixes against. [#336] - - The warning is only displayed on PHPUnit 7.3.0 and higher. - - The warning will be elevated to a test failure in PHPCS 4.0. - - Thanks to [Dan Wallis][@fredden] for the patch -- The following sniffs have received performance related improvements: - - Squiz.PHP.EmbeddedPhp - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Various housekeeping, including improvements to the tests and documentation - - Thanks to [Dan Wallis][@fredden], [Joachim Noreiko][@joachim-n], [Remi Collet][@remicollet], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions - -### Deprecated -- Support for scanning JavaScript and CSS files. See [#2448][sq-2448]. - - This also means that all sniffs which are only aimed at JavaScript or CSS files are now deprecated. - - The Javascript and CSS Tokenizers, all Javascript and CSS specific sniffs, and support for JS and CSS in select sniffs which support multiple file types, will be removed in version 4.0.0. -- The abstract `PHP_CodeSniffer\Filters\ExactMatch::getBlacklist()` and `PHP_CodeSniffer\Filters\ExactMatch::getWhitelist()` methods are deprecated and will be removed in the 4.0 release. See [#198]. - - In version 4.0, these methods will be replaced with abstract `ExactMatch::getDisallowedFiles()` and `ExactMatch::getAllowedFiles()` methods - - To make Filters extending `ExactMatch` cross-version compatible with both PHP_CodeSniffer 3.9.0+ as well as 4.0+, implement the new `getDisallowedFiles()` and `getAllowedFiles()` methods. - - When both the `getDisallowedFiles()` and `getAllowedFiles()` methods as well as the `getBlacklist()` and `getWhitelist()` are available, the new methods will take precedence over the old methods. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The MySource standard and all sniffs in it. See [#2471][sq-2471]. - - The MySource standard and all sniffs in it will be removed in version 4.0.0. -- The `Zend.Debug.CodeAnalyzer` sniff. See [#277]. - - This sniff will be removed in version 4.0.0. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed bug [#127] : Squiz.Commenting.FunctionComment : The `MissingParamType` error code will now be used instead of `MissingParamName` when a parameter name is provided, but not its type. Additionally, invalid type hint suggestions will no longer be provided in these cases. - - Thanks to [Dan Wallis][@fredden] for the patch -- Fixed bug [#196] : Squiz.PHP.EmbeddedPhp : fixer will no longer leave behind trailing whitespace when moving code to another line. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#196] : Squiz.PHP.EmbeddedPhp : will now determine the needed indent with higher precision in multiple situations. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#196] : Squiz.PHP.EmbeddedPhp : fixer will no longer insert a stray new line when the closer of a multi-line embedded PHP block and the opener of the next multi-line embedded PHP block would be on the same line. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#235] : Generic.CodeAnalysis.ForLoopWithTestFunctionCall : prevent a potential PHP 8.3 deprecation notice during live coding - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch -- Fixed bug [#288] : Generic.WhiteSpace.IncrementDecrementSpacing : error message for post-in/decrement will now correctly inform about new lines found before the operator. - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch -- Fixed bug [#296] : Generic.WhiteSpace.ArbitraryParenthesesSpacing : false positive for non-arbitrary parentheses when these follow the scope closer of a `switch` `case`. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#307] : PSR2.Classes.ClassDeclaration : space between a modifier keyword and the `class` keyword was not checked when the space included a new line or comment. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#325] : Squiz.Operators.IncrementDecrementUsage : the sniff was underreporting when there was (no) whitespace and/or comments in unexpected places. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#335] : PSR12.Files.DeclareStatement : bow out in a certain parse error situation to prevent incorrect auto-fixes from being made. - - Thanks to [Dan Wallis][@fredden] for the patch -- Fixed bug [#340] : Squiz.Commenting.ClosingDeclarationComment : no longer adds a stray newline when adding a missing comment. - - Thanks to [Dan Wallis][@fredden] for the patch - -### Other -- A "Community cc list" has been introduced to ping maintainers of external standards and integrators for input regarding change proposals for PHP_CodeSniffer which may impact them. [#227] - - For anyone who missed the discussion about this and is interested to be on this list, please feel invited to submit a PR to add yourself. - The list is located in the `.github` folder. - -[sq-2448]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2448 -[sq-2471]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2471 -[#27]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/27 -[#127]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/127 -[#196]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/196 -[#197]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/197 -[#198]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/198 -[#227]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/227 -[#235]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/235 -[#277]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/277 -[#281]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/281 -[#288]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/288 -[#296]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/296 -[#307]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/307 -[#308]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/308 -[#309]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/309 -[#321]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/321 -[#324]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/324 -[#325]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/325 -[#330]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/330 -[#331]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/331 -[#332]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/332 -[#335]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/335 -[#336]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/336 -[#340]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/340 - -## [3.8.1] - 2024-01-11 - -### Added -- Documentation has been added for the following sniffs: - - Generic.CodeAnalysis.EmptyPHPStatement - - Generic.Formatting.SpaceBeforeCast - - Generic.PHP.Syntax - - Generic.WhiteSpace.LanguageConstructSpacing - - PSR12.Classes.ClosingBrace - - PSR12.Classes.OpeningBraceSpace - - PSR12.ControlStructures.BooleanOperatorPlacement - - PSR12.Files.OpenTag - - Thanks to [Rodrigo Primo][@rodrigoprimo] and [Denis Žoljom][@dingo-d] for the patches - -### Changed -- GitHub releases will now always only contain unversioned release assets (PHARS + asc files) (same as it previously was in the squizlabs repo). See [#205] for context. - - Thanks to [Shivam Mathur][@shivammathur] for opening a discussion about this -- Various housekeeping, includes improvements to the tests and documentation - - Thanks to [Dan Wallis][@fredden], [Lucas Hoffmann][@lucc], [Rodrigo Primo][@rodrigoprimo] and [Juliette Reinders Folmer][@jrfnl] for their contributions - -### Fixed -- Fixed bug [#124] : Report Full : avoid unnecessarily wrapping lines when `-s` is used - - Thanks to [Brad Jorsch][@anomiex] for the patch -- Fixed bug [#124] : Report Full : fix incorrect bolding of pipes when `-s` is used and messages wraps - - Thanks to [Brad Jorsch][@anomiex] for the patch -- Fixed bug [#150] : Squiz.WhiteSpace.KeywordSpacing : prevent a PHP notice when run during live coding - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#154] : Report Full : delimiter line calculation could go wonky on wide screens when a report contains multi-line messages - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#178] : Squiz.Commenting.VariableComment : docblocks were incorrectly being flagged as missing when a property declaration used PHP native union/intersection type declarations - - Thanks to [Ferdinand Kuhl][@fcool] for the patch -- Fixed bug [#211] : Squiz.Commenting.VariableComment : docblocks were incorrectly being flagged as missing when a property declaration used PHP 8.2+ stand-alone `true`/`false`/`null` type declarations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#211] : Squiz.Commenting.VariableComment : docblocks were incorrectly being flagged as missing when a property declaration used PHP native `parent`, `self` or a namespace relative class name type declaration - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#226] : Generic.CodeAnalysis.ForLoopShouldBeWhileLoop : prevent a potential PHP 8.3 deprecation notice during live coding - - Thanks to [Rodrigo Primo][@rodrigoprimo] for the patch - -[#124]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/124 -[#150]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/150 -[#154]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/154 -[#178]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/178 -[#205]: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/205 -[#211]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/211 -[#226]: https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/226 - -## [3.8.0] - 2023-12-08 - -[Squizlabs/PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) is dead. Long live [PHPCSStandards/PHP_CodeSniffer](https://github.com/PHPCSStandards/PHP_CodeSniffer)! - -### Breaking Changes -- The `squizlabs/PHP_CodeSniffer` repository has been abandoned. The `PHPCSStandards/PHP_CodeSniffer` repository will serve as the continuation of the project. For more information about this change, please read the [announcement](https://github.com/squizlabs/PHP_CodeSniffer/issues/3932). - - Installation of PHP_CodeSniffer via PEAR is no longer supported. - - Users will need to switch to another installation method. - - Note: this does not affect the PEAR sniffs. - - For Composer users, nothing changes. - - **_In contrast to earlier information, the `squizlabs/php_codesniffer` package now points to the new repository and everything will continue to work as before._** - - PHIVE users may need to clear the PHIVE URL cache. - - PHIVE users who don't use the package alias, but refer to the package URL, will need to update the URL from `https://squizlabs.github.io/PHP_CodeSniffer/phars/` to `https://phars.phpcodesniffer.com/phars/`. - - Users who download the PHAR files using curl or wget, will need to update the download URL from `https://squizlabs.github.io/PHP_CodeSniffer/[phpcs|phpcbf].phar` or `https://github.com/squizlabs/PHP_CodeSniffer/releases/latest/download/[phpcs|phpcbf].phar` to `https://phars.phpcodesniffer.com/[phpcs|phpcbf].phar`. - - For users who install PHP_CodeSniffer via the [Setup-PHP](https://github.com/shivammathur/setup-php/) action runner for GitHub Actions, nothing changes. - - Users using a git clone will need to update the clone address from `git@github.com:squizlabs/PHP_CodeSniffer.git` to `git@github.com:PHPCSStandards/PHP_CodeSniffer.git`. - - Contributors will need to fork the new repo and add both the new fork as well as the new repo as remotes to their local git copy of PHP_CodeSniffer. - - Users who have (valid) open issues or pull requests in the `squizlabs/PHP_CodeSniffer` repository are invited to resubmit these to the `PHPCSStandards/PHP_CodeSniffer` repository. - -### Added -- Runtime support for PHP 8.3. All known PHP 8.3 deprecation notices have been fixed - - Syntax support for new PHP 8.3 features will follow in a future release - - If you find any PHP 8.3 deprecation notices which were missed, please report them - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches -- Added support for PHP 8.2 readonly classes to File::getClassProperties() through a new is_readonly array index in the return value - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for PHP 8.2 readonly classes to a number of sniffs - - Generic.CodeAnalysis.UnnecessaryFinalModifier - - PEAR.Commenting.ClassComment - - PEAR.Commenting.FileComment - - PSR1.Files.SideEffects - - PSR2.Classes.ClassDeclaration - - PSR12.Files.FileHeader - - Squiz.Classes.ClassDeclaration - - Squiz.Classes.LowercaseClassKeywords - - Squiz.Commenting.ClassComment - - Squiz.Commenting.DocCommentAlignment - - Squiz.Commenting.FileComment - - Squiz.Commenting.InlineComment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for PHP 8.2 `true` as a stand-alone type declaration - - The `File::getMethodProperties()`, `File::getMethodParameters()` and `File::getMemberProperties()` methods now all support the `true` type - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for PHP 8.2 `true` as a stand-alone type to a number of sniffs - - Generic.PHP.LowerCaseType - - PSr12.Functions.NullableTypeDeclaration - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added a Performance report to allow for finding "slow" sniffs - - To run this report, run PHPCS with --report=Performance. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.RequireStrictTypes : new warning for when there is a declare statement, but the strict_types directive is set to 0 - - The warning can be turned off by excluding the `Generic.PHP.RequireStrictTypes.Disabled` error code - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.FunctionComment : new `ParamNameUnexpectedAmpersandPrefix` error for parameters annotated as passed by reference while the parameter is not passed by reference - - Thanks to [Dan Wallis][@fredden] for the patch -- Documentation has been added for the following sniffs: - - PSR2.Files.ClosingTag - - PSR2.Methods.FunctionCallSignature - - PSR2.Methods.FunctionClosingBrace - - Thanks to [Atsushi Okui][@blue32a] for the patch -- Support for PHPUnit 8 and 9 to the test suite - - Test suites for external standards which run via the PHPCS native test suite can now run on PHPUnit 4-9 (was 4-7) - - If any of these tests use the PHPUnit `setUp()`/`tearDown()` methods or overload the `setUp()` in the `AbstractSniffUnitTest` test case, they will need to be adjusted. See the [PR details for further information](https://github.com/PHPCSStandards/PHP_CodeSniffer/pull/59/commits/bc302dd977877a22c5e60d42a2f6b7d9e9192dab) - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Changed -- Changes have been made to the way PHPCS handles invalid sniff properties being set in a custom ruleset - - Fixes PHP 8.2 deprecation notices for properties set in a (custom) ruleset for complete standards/complete sniff categories - - Invalid sniff properties set for individual sniffs will now result in an error and halt the execution of PHPCS - - A descriptive error message is provided to allow users to fix their ruleset - - Sniff properties set for complete standards/complete sniff categories will now only be set on sniffs which explicitly support the property - - The property will be silently ignored for those sniffs which do not support the property - - Invalid sniff properties set for sniffs via inline annotations will result in an informative `Internal.PropertyDoesNotExist` errror on line 1 of the scanned file, but will not halt the execution of PHPCS - - For sniff developers, it is strongly recommended for sniffs to explicitly declare any user-adjustable public properties - - If dynamic properties need to be supported for a sniff, either declare the magic __set()/__get()/__isset()/__unset() methods on the sniff or let the sniff extend stdClass - - Note: The `#[\AllowDynamicProperties]` attribute will have no effect for properties which are being set in rulesets - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The third parameter for the Ruleset::setSniffProperty() method has been changed to expect an array - - Sniff developers/integrators of PHPCS may need to make some small adjustments to allow for this change - - Existing code will continue to work but will throw a deprecation error - - The backwards compatiblity layer will be removed in PHPCS 4.0 - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- When using `auto` report width (the default) a value of 80 columns will be used if the width cannot be determined - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Sniff error messages are now more informative to help bugs get reported to the correct project - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.CodeAnalysis.UnusedFunctionParameter will now ignore magic methods for which the signature is defined by PHP - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Functions.OpeningFunctionBraceBsdAllman will now check the brace indent before the opening brace for empty functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Functions.OpeningFunctionBraceKernighanRitchie will now check the spacing before the opening brace for empty functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.WhiteSpace.IncrementDecrementSpacing now detects more spacing issues - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PSR2.Classes.PropertyDeclaration now enforces that the readonly modifier comes after the visibility modifier - - PSR2 and PSR12 do not have documented rules for this as they pre-date the readonly modifier - - PSR-PER has been used to confirm the order of this keyword so it can be applied to PSR2 and PSR12 correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PEAR.Commenting.FunctionComment + Squiz.Commenting.FunctionComment: the SpacingAfter error can now be auto-fixed - - Thanks to [Dan Wallis][@fredden] for the patch -- Squiz.PHP.InnerFunctions sniff no longer reports on OO methods for OO structures declared within a function or closure - - Thanks to [@Daimona] for the patch -- Squiz.PHP.NonExecutableCode will now also flag redundant return statements just before a closure close brace - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Runtime performance improvement for PHPCS CLI users. The improvement should be most noticeable for users on Windows. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The following sniffs have received performance related improvements: - - Generic.PHP.LowerCaseConstant - - Generic.PHP.LowerCaseType - - PSR12.Files.OpenTag - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches -- The -e (explain) command will now list sniffs in natural order - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Tests using the PHPCS native test framework with multiple test case files will now run the test case files in numeric order. - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The following sniffs have received minor message readability improvements: - - Generic.Arrays.ArrayIndent - - Generic.Formatting.SpaceAfterCast - - Generic.Formatting.SpaceAfterNot - - Generic.WhiteSpace.SpreadOperatorSpacingAfter - - Squiz.Arrays.ArrayDeclaration - - Squiz.Commenting.DocCommentAlignment - - Squiz.ControlStructures.ControlSignature - - Thanks to [Danny van der Sluijs][@DannyvdSluijs] and [Juliette Reinders Folmer][@jrfnl] for the patches -- Improved README syntax highlighting - - Thanks to [Benjamin Loison][@Benjamin-Loison] for the patch -- Various documentation improvements - - Thanks to [Andrew Dawes][@AndrewDawes], [Danny van der Sluijs][@DannyvdSluijs] and [Juliette Reinders Folmer][@jrfnl] for the patches - -### Removed -- Removed support for installation via PEAR - - Use composer or the PHAR files instead - -### Fixed -- Fixed bug [#2857][sq-2857] : Squiz/NonExecutableCode: prevent false positives when exit is used in a ternary expression or as default with null coalesce - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3386][sq-3386] : PSR1/SideEffects : improved recognition of disable/enable annotations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3557][sq-3557] : Squiz.Arrays.ArrayDeclaration will now ignore PHP 7.4 array unpacking when determining whether an array is associative - - Thanks to [Volker Dusch][@edorian] for the patch -- Fixed bug [#3592][sq-3592] : Squiz/NonExecutableCode: prevent false positives when a PHP 8.0+ inline throw expression is encountered - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3715][sq-3715] : Generic/UnusedFunctionParameter: fixed incorrect errorcode for closures/arrow functions nested within extended classes/classes which implement - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3717][sq-3717] : Squiz.Commenting.FunctionComment: fixed false positive for `InvalidNoReturn` when type is never - - Thanks to [Choraimy Kroonstuiver][@axlon] for the patch -- Fixed bug [#3720][sq-3720] : Generic/RequireStrictTypes : will now bow out silently in case of parse errors/live coding instead of throwing false positives/false negatives - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3720][sq-3720] : Generic/RequireStrictTypes : did not handle multi-directive declare statements - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3722][sq-3722] : Potential "Uninitialized string offset 1" in octal notation backfill - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3736][sq-3736] : PEAR/FunctionDeclaration: prevent fixer removing the close brace (and creating a parse error) when there is no space between the open brace and close brace of a function - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3739][sq-3739] : PEAR/FunctionDeclaration: prevent fixer conflict, and potentially creating a parse error, for unconventionally formatted return types - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3770][sq-3770] : Squiz/NonExecutableCode: prevent false positives for switching between PHP and HTML - - Thanks to [Dan Wallis][@fredden] for the patch -- Fixed bug [#3773][sq-3773] : Tokenizer/PHP: tokenization of the readonly keyword when used in combination with PHP 8.2 disjunctive normal types - - Thanks to [Dan Wallis][@fredden] and [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3776][sq-3776] : Generic/JSHint: error when JSHint is not available - - Thanks to [Dan Wallis][@fredden] for the patch -- Fixed bug [#3777][sq-3777] : Squiz/NonExecutableCode: slew of bug fixes, mostly related to modern PHP - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3778][sq-3778] : Squiz/LowercasePHPFunctions: bug fix for class names in attributes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3779][sq-3779] : Generic/ForbiddenFunctions: bug fix for class names in attributes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3785][sq-3785] : Squiz.Commenting.FunctionComment: potential "Uninitialized string offset 0" when a type contains a duplicate pipe symbol - - Thanks to [Dan Wallis][@fredden] for the patch -- Fixed bug [#3787][sq-3787] : `PEAR/Squiz/[MultiLine]FunctionDeclaration`: allow for PHP 8.1 new in initializers - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3789][sq-3789] : Incorrect tokenization for ternary operator with `match` inside of it - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3790][sq-3790] : PSR12/AnonClassDeclaration: prevent fixer creating parse error when there was no space before the open brace - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3797][sq-3797] : Tokenizer/PHP: more context sensitive keyword fixes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3801][sq-3801] : File::getMethodParameters(): allow for readonly promoted properties without visibility - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3805][sq-3805] : Generic/FunctionCallArgumentSpacing: prevent fixer conflict over PHP 7.3+ trailing comma's in function calls - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3806][sq-3806] : Squiz.PHP.InnerFunctions sniff now correctly reports inner functions declared within a closure - - Thanks to [@Daimona] for the patch -- Fixed bug [#3809][sq-3809] : GitBlame report was broken when passing a basepath - - Thanks to [Chris][@datengraben] for the patch -- Fixed bug [#3813][sq-3813] : Squiz.Commenting.FunctionComment: false positive for parameter name mismatch on parameters annotated as passed by reference - - Thanks to [Dan Wallis][@fredden] for the patch -- Fixed bug [#3833][sq-3833] : Generic.PHP.LowerCaseType: fixed potential undefined array index notice - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3846][sq-3846] : PSR2.Classes.ClassDeclaration.CloseBraceAfterBody : fixer will no longer remove indentation on the close brace line - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3854][sq-3854] : Fatal error when using Gitblame report in combination with `--basepath` and running from project subdirectory - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3856][sq-3856] : PSR12.Traits.UseDeclaration was using the wrong error code - SpacingAfterAs - for spacing issues after the `use` keyword - - These will now be reported using the SpacingAfterUse error code - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3856][sq-3856] : PSR12.Traits.UseDeclaration did not check spacing after `use` keyword for multi-line trait use statements - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3867][sq-3867] : Tokenizer/PHP: union type and intersection type operators were not correctly tokenized for static properties without explicit visibility - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3877][sq-3877] : Filter names can be case-sensitive. The -h help text will now display the correct case for the available filters - - Thanks to [@simonsan] for the patch -- Fixed bug [#3893][sq-3893] : Generic/DocComment : the SpacingAfterTagGroup fixer could accidentally remove ignore annotations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3898][sq-3898] : Squiz/NonExecutableCode : the sniff could get confused over comments in unexpected places - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3904][sq-3904] : Squiz/FunctionSpacing : prevent potential fixer conflict - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3906][sq-3906] : Tokenizer/CSS: bug fix related to the unsupported slash comment syntax - - Thanks to [Dan Wallis][@fredden] for the patch -- Fixed bug [#3913][sq-3913] : Config did not always correctly store unknown "long" arguments in the `$unknown` property - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -Thanks go to [Dan Wallis][@fredden] and [Danny van der Sluijs][@DannyvdSluijs] for reviewing quite a few of the PRs for this release. -Additionally, thanks to [Alexander Turek][@derrabus] for consulting on the repo change over. - -[sq-2857]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2857 -[sq-3386]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3386 -[sq-3557]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3557 -[sq-3592]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3592 -[sq-3715]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3715 -[sq-3717]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3717 -[sq-3720]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3720 -[sq-3722]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3722 -[sq-3736]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3736 -[sq-3739]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3739 -[sq-3770]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3770 -[sq-3773]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3773 -[sq-3776]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3776 -[sq-3777]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3777 -[sq-3778]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3778 -[sq-3779]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3779 -[sq-3785]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3785 -[sq-3787]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3787 -[sq-3789]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3789 -[sq-3790]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3790 -[sq-3797]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3797 -[sq-3801]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3801 -[sq-3805]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3805 -[sq-3806]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3806 -[sq-3809]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3809 -[sq-3813]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3813 -[sq-3833]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3833 -[sq-3846]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3846 -[sq-3854]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3854 -[sq-3856]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3856 -[sq-3867]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3867 -[sq-3877]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3877 -[sq-3893]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3893 -[sq-3898]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3898 -[sq-3904]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3904 -[sq-3906]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3906 -[sq-3913]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3913 - -## [3.7.2] - 2023-02-23 - -### Changed -- Newer versions of Composer will now suggest installing PHPCS using require-dev instead of require - - Thanks to [Gary Jones][@GaryJones] for the patch -- A custom Out Of Memory error will now be shown if PHPCS or PHPCBF run out of memory during a run - - Error message provides actionable information about how to fix the problem and ensures the error is not silent - - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Alain Schlesser][@schlessera] for the patch -- Generic.PHP.LowerCaseType sniff now correctly examines types inside arrow functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Formatting.OperatorBracket no longer reports false positives in match() structures - -### Fixed -- Fixed bug [#3616][sq-3616] : Squiz.PHP.DisallowComparisonAssignment false positive for PHP 8 match expression - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3618][sq-3618] : Generic.WhiteSpace.ArbitraryParenthesesSpacing false positive for return new parent() - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3632][sq-3632] : Short list not tokenized correctly in control structures without braces - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3639][sq-3639] : Tokenizer not applying tab replacement to heredoc/nowdoc closers - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3640][sq-3640] : Generic.WhiteSpace.DisallowTabIndent not reporting errors for PHP 7.3 flexible heredoc/nowdoc syntax - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3645][sq-3645] : PHPCS can show 0 exit code when running in parallel even if child process has fatal error - - Thanks to [Alex Panshin][@enl] for the patch -- Fixed bug [#3653][sq-3653] : False positives for match() in OperatorSpacingSniff - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#3666][sq-3666] : PEAR.Functions.FunctionCallSignature incorrect indent fix when checking mixed HTML/PHP files -- Fixed bug [#3668][sq-3668] : PSR12.Classes.ClassInstantiation.MissingParentheses false positive when instantiating parent classes - - Similar issues also fixed in Generic.Functions.FunctionCallArgumentSpacing and Squiz.Formatting.OperatorBracket - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3672][sq-3672] : Incorrect ScopeIndent.IncorrectExact report for match inside array literal -- Fixed bug [#3694][sq-3694] : Generic.WhiteSpace.SpreadOperatorSpacingAfter does not ignore spread operator in PHP 8.1 first class callables - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-3616]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3616 -[sq-3618]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3618 -[sq-3632]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3632 -[sq-3639]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3639 -[sq-3640]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3640 -[sq-3645]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3645 -[sq-3653]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3653 -[sq-3666]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3666 -[sq-3668]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3668 -[sq-3672]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3672 -[sq-3694]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3694 - -## [3.7.1] - 2022-06-18 - -### Fixed -- Fixed bug [#3609][sq-3609] : Methods/constants with name empty/isset/unset are always reported as error - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-3609]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3609 - -## [3.7.0] - 2022-06-13 - -### Added -- Added support for PHP 8.1 explicit octal notation - - This new syntax has been backfilled for PHP versions less than 8.1 - - Thanks to [Mark Baker][@MarkBaker] for the patch - - Thanks to [Juliette Reinders Folmer][@jrfnl] for additional fixes -- Added support for PHP 8.1 enums - - This new syntax has been backfilled for PHP versions less than 8.1 - - Includes a new T_ENUM_CASE token to represent the case statements inside an enum - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch - - Thanks to [Juliette Reinders Folmer][@jrfnl] for additional core and sniff support -- Added support for the PHP 8.1 readonly token - - Tokenizing of the readonly keyword has been backfilled for PHP versions less than 8.1 - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Added support for PHP 8.1 intersection types - - Includes a new T_TYPE_INTERSECTION token to represent the ampersand character inside intersection types - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch - -### Changed -- File::getMethodParameters now supports the new PHP 8.1 readonly token - - When constructor property promotion is used, a new property_readonly array index is included in the return value - - This is a boolean value indicating if the property is readonly - - If the readonly token is detected, a new readonly_token array index is included in the return value - - This contains the token index of the readonly keyword - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Support for new PHP 8.1 readonly keyword has been added to the following sniffs: - - Generic.PHP.LowerCaseKeyword - - PSR2.Classes.PropertyDeclaration - - Squiz.Commenting.BlockComment - - Squiz.Commenting.DocCommentAlignment - - Squiz.Commenting.VariableComment - - Squiz.WhiteSpace.ScopeKeywordSpacing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patches -- The parallel feature is now more efficient and runs faster in some situations due to improved process management - - Thanks to [Sergei Morozov][@morozov] for the patch -- The list of installed coding standards now has consistent ordering across all platforms - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.UpperCaseConstant and Generic.PHP.LowerCaseConstant now ignore type declarations - - These sniffs now only report errors for true/false/null when used as values - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.LowerCaseType now supports the PHP 8.1 never type - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch - -### Fixed -- Fixed bug [#3502][sq-3502] : A match statement within an array produces Squiz.Arrays.ArrayDeclaration.NoKeySpecified -- Fixed bug [#3503][sq-3503] : Squiz.Commenting.FunctionComment.ThrowsNoFullStop false positive when one line @throw -- Fixed bug [#3505][sq-3505] : The nullsafe operator is not counted in Generic.Metrics.CyclomaticComplexity - - Thanks to [Mark Baker][@MarkBaker] for the patch -- Fixed bug [#3526][sq-3526] : PSR12.Properties.ConstantVisibility false positive when using public final const syntax - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3530][sq-3530] : Line indented incorrectly false positive when using match-expression inside switch case -- Fixed bug [#3534][sq-3534] : Name of typed enum tokenized as T_GOTO_LABEL - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3546][sq-3546] : Tokenizer/PHP: bug fix - parent/static keywords in class instantiations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3550][sq-3550] : False positive from PSR2.ControlStructures.SwitchDeclaration.TerminatingComment when using trailing comment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3575][sq-3575] : Squiz.Scope.MethodScope misses visibility keyword on previous line - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3604][sq-3604] : Tokenizer/PHP: bug fix for double quoted strings using ${ - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-3502]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3502 -[sq-3503]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3503 -[sq-3505]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3505 -[sq-3526]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3526 -[sq-3530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3530 -[sq-3534]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3534 -[sq-3546]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3546 -[sq-3550]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3550 -[sq-3575]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3575 -[sq-3604]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3604 - -## [3.6.2] - 2021-12-13 - -### Changed -- Processing large code bases that use tab indenting inside comments and strings will now be faster - - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch - -### Fixed -- Fixed bug [#3388][sq-3388] : phpcs does not work when run from WSL drives - - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Graham Wharton][@gwharton] for the patch -- Fixed bug [#3422][sq-3422] : Squiz.WhiteSpace.ScopeClosingBrace fixer removes HTML content when fixing closing brace alignment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3437][sq-3437] : PSR12 does not forbid blank lines at the start of the class body - - Added new PSR12.Classes.OpeningBraceSpace sniff to enforce this -- Fixed bug [#3440][sq-3440] : Squiz.WhiteSpace.MemberVarSpacing false positives when attributes used without docblock - - Thanks to [Vadim Borodavko][@javer] for the patch -- Fixed bug [#3448][sq-3448] : PHP 8.1 deprecation notice while generating running time value - - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Andy Postnikov][@andypost] for the patch -- Fixed bug [#3456][sq-3456] : PSR12.Classes.ClassInstantiation.MissingParentheses false positive using attributes on anonymous class - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3460][sq-3460] : Generic.Formatting.MultipleStatementAlignment false positive on closure with parameters - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3468][sq-3468] : do/while loops are double-counted in Generic.Metrics.CyclomaticComplexity - - Thanks to [Mark Baker][@MarkBaker] for the patch -- Fixed bug [#3469][sq-3469] : Ternary Operator and Null Coalescing Operator are not counted in Generic.Metrics.CyclomaticComplexity - - Thanks to [Mark Baker][@MarkBaker] for the patch -- Fixed bug [#3472][sq-3472] : PHP 8 match() expression is not counted in Generic.Metrics.CyclomaticComplexity - - Thanks to [Mark Baker][@MarkBaker] for the patch - -[sq-3388]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3388 -[sq-3422]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3422 -[sq-3437]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3437 -[sq-3440]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3440 -[sq-3448]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3448 -[sq-3456]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3456 -[sq-3460]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3460 -[sq-3468]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3468 -[sq-3469]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3469 -[sq-3472]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3472 - -## [3.6.1] - 2021-10-11 - -### Changed -- PHPCS annotations can now be specified using hash-style comments - - Previously, only slash-style and block-style comments could be used to do things like disable errors - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The new PHP 8.1 tokenization for ampersands has been reverted to use the existing PHP_CodeSniffer method - - The PHP 8.1 tokens T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG and T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG are unused - - Ampersands continue to be tokenized as T_BITWISE_AND for all PHP versions - - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Anna Filina][@afilina] for the patch -- File::getMethodParameters() no longer incorrectly returns argument attributes in the type hint array index - - A new has_attributes array index is available and set to TRUE if the argument has attributes defined - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed an issue where some sniffs would not run on PHP files that only used the short echo tag - - The following sniffs were affected: - - Generic.Files.ExecutableFile - - Generic.Files.LowercasedFilename - - Generic.Files.LineEndings - - Generic.Files.EndFileNewline - - Generic.Files.EndFileNoNewline - - Generic.PHP.ClosingPHPTag - - Generic.PHP.Syntax - - Generic.VersionControl.GitMergeConflict - - Generic.WhiteSpace.DisallowSpaceIndent - - Generic.WhiteSpace.DisallowTabIndent - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.BlockComment now correctly applies rules for block comments after a short echo tag - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Generic.NamingConventions.ConstructorName no longer throws deprecation notices on PHP 8.1 - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed false positives when using attributes in the following sniffs: - - PEAR.Commenting.FunctionComment - - Squiz.Commenting.InlineComment - - Squiz.Commenting.BlockComment - - Squiz.Commenting.VariableComment - - Squiz.WhiteSpace.MemberVarSpacing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3294][sq-3294] : Bug in attribute tokenization when content contains PHP end token or attribute closer on new line - - Thanks to [Alessandro Chitolina][@alekitto] for the patch - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the tests -- Fixed bug [#3296][sq-3296] : PSR2.ControlStructures.SwitchDeclaration takes phpcs:ignore as content of case body -- Fixed bug [#3297][sq-3297] : PSR2.ControlStructures.SwitchDeclaration.TerminatingComment does not handle try/finally blocks - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3302][sq-3302] : PHP 8.0 | Tokenizer/PHP: bugfix for union types using namespace operator - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3303][sq-3303] : findStartOfStatement() doesn't work with T_OPEN_TAG_WITH_ECHO -- Fixed bug [#3316][sq-3316] : Arrow function not tokenized correctly when using null in union type -- Fixed bug [#3317][sq-3317] : Problem with how phpcs handles ignored files when running in parallel - - Thanks to [Emil Andersson][@emil-nasso] for the patch -- Fixed bug [#3324][sq-3324] : PHPCS hangs processing some nested arrow functions inside a function call -- Fixed bug [#3326][sq-3326] : Generic.Formatting.MultipleStatementAlignment error with const DEFAULT - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3333][sq-3333] : Squiz.Objects.ObjectInstantiation: null coalesce operators are not recognized as assignment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3340][sq-3340] : Ensure interface and trait names are always tokenized as T_STRING - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3342][sq-3342] : PSR12/Squiz/PEAR standards all error on promoted properties with docblocks - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3345][sq-3345] : IF statement with no braces and double catch turned into syntax error by auto-fixer - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3352][sq-3352] : PSR2.ControlStructures.SwitchDeclaration can remove comments on the same line as the case statement while fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3357][sq-3357] : Generic.Functions.OpeningFunctionBraceBsdAllman removes return type when additional lines are present - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3362][sq-3362] : Generic.WhiteSpace.ScopeIndent false positive for arrow functions inside arrays -- Fixed bug [#3384][sq-3384] : Squiz.Commenting.FileComment.SpacingAfterComment false positive on empty file -- Fixed bug [#3394][sq-3394] : Fix PHP 8.1 auto_detect_line_endings deprecation notice -- Fixed bug [#3400][sq-3400] : PHP 8.1: prevent deprecation notices about missing return types - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3424][sq-3424] : PHPCS fails when using PHP 8 Constructor property promotion with attributes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3425][sq-3425] : PHP 8.1 | Runner::processChildProcs(): fix passing null to non-nullable bug - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3445][sq-3445] : Nullable parameter after attribute incorrectly tokenized as ternary operator - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-3294]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3294 -[sq-3296]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3296 -[sq-3297]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3297 -[sq-3302]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3302 -[sq-3303]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3303 -[sq-3316]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3316 -[sq-3317]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3317 -[sq-3324]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3324 -[sq-3326]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3326 -[sq-3333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3333 -[sq-3340]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3340 -[sq-3342]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3342 -[sq-3345]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3345 -[sq-3352]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3352 -[sq-3357]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3357 -[sq-3362]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3362 -[sq-3384]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3384 -[sq-3394]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3394 -[sq-3400]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3400 -[sq-3424]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3424 -[sq-3425]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3425 -[sq-3445]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3445 - -## [3.6.0] - 2021-04-09 - -### Added -- Added support for PHP 8.0 union types - - A new T_TYPE_UNION token is available to represent the pipe character - - File::getMethodParameters(), getMethodProperties(), and getMemberProperties() will now return union types - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for PHP 8.0 named function call arguments - - A new T_PARAM_NAME token is available to represent the label with the name of the function argument in it - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for PHP 8.0 attributes - - The PHP-supplied T_ATTRIBUTE token marks the start of an attribute - - A new T_ATTRIBUTE_END token is available to mark the end of an attribute - - New attribute_owner and attribute_closer indexes are available in the tokens array for all tokens inside an attribute - - Tokenizing of attributes has been backfilled for older PHP versions - - The following sniffs have been updated to support attributes: - - PEAR.Commenting.ClassComment - - PEAR.Commenting.FileComment - - PSR1.Files.SideEffects - - PSR12.Files.FileHeader - - Squiz.Commenting.ClassComment - - Squiz.Commenting.FileComment - - Squiz.WhiteSpace.FunctionSpacing - - Thanks to [Vadim Borodavko][@javer] for the patch - - Thanks to [Alessandro Chitolina][@alekitto] for the patch -- Added support for PHP 8.0 dereferencing of text strings with interpolated variables - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for PHP 8.0 match expressions - - Match expressions are now tokenized with parenthesis and scope openers and closers - - Sniffs can listen for the T_MATCH token to process match expressions - - Note that the case and default statements inside match expressions do not have scopes set - - A new T_MATCH_ARROW token is available to represent the arrows in match expressions - - A new T_MATCH_DEFAULT token is available to represent the default keyword in match expressions - - All tokenizing of match expressions has been backfilled for older PHP versions - - The following sniffs have been updated to support match expressions: - - Generic.CodeAnalysis.AssignmentInCondition - - Generic.CodeAnalysis.EmptyPHPStatement - - Thanks to [Vadim Borodavko][@javer] for the patch - - Generic.CodeAnalysis.EmptyStatement - - Generic.PHP.LowerCaseKeyword - - PEAR.ControlStructures.ControlSignature - - PSR12.ControlStructures.BooleanOperatorPlacement - - Squiz.Commenting.LongConditionClosingComment - - Squiz.Commenting.PostStatementComment - - Squiz.ControlStructures.LowercaseDeclaration - - Squiz.ControlStructures.ControlSignature - - Squiz.Formatting.OperatorBracket - - Squiz.PHP.DisallowMultipleAssignments - - Squiz.Objects.ObjectInstantiation - - Squiz.WhiteSpace.ControlStructureSpacing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added Generic.NamingConventions.AbstractClassNamePrefix to enforce that class names are prefixed with "Abstract" - - Thanks to [Anna Borzenko][@annechko] for the contribution -- Added Generic.NamingConventions.InterfaceNameSuffix to enforce that interface names are suffixed with "Interface" - - Thanks to [Anna Borzenko][@annechko] for the contribution -- Added Generic.NamingConventions.TraitNameSuffix to enforce that trait names are suffixed with "Trait" - - Thanks to [Anna Borzenko][@annechko] for the contribution - -### Changed -- The value of the T_FN_ARROW token has changed from "T_FN_ARROW" to "PHPCS_T_FN_ARROW" to avoid package conflicts - - This will have no impact on custom sniffs unless they are specifically looking at the value of the T_FN_ARROW constant - - If sniffs are just using constant to find arrow functions, they will continue to work without modification - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- File::findStartOfStatement() now works correctly when passed the last token in a statement -- File::getMethodParameters() now supports PHP 8.0 constructor property promotion - - Returned method params now include a "property_visibility" and "visibility_token" index if property promotion is detected - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- File::getMethodProperties() now includes a "return_type_end_token" index in the return value - - This indicates the last token in the return type, which is helpful when checking union types - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Include patterns are now ignored when processing STDIN - - Previously, checks using include patterns were excluded when processing STDIN when no file path was provided via --stdin-path - - Now, all include and exclude rules are ignored when no file path is provided, allowing all checks to run - - If you want include and exclude rules enforced when checking STDIN, use --stdin-path to set the file path - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Spaces are now correctly escaped in the paths to external on Windows - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.CodeAnalysis.UnusedFunctionParameter can now be configured to ignore variable usage for specific type hints - - This allows you to suppress warnings for some variables that are not required, but leave warnings for others - - Set the ignoreTypeHints array property to a list of type hints to ignore - - Thanks to [Petr Bugyík][@o5] for the patch -- Generic.Formatting.MultipleStatementAlignment can now align statements at the start of the assignment token - - Previously, the sniff enforced that the values were aligned, even if this meant the assignment tokens were not - - Now, the sniff can enforce that the assignment tokens are aligned, even if this means the values are not - - Set the "alignAtEnd" sniff property to "false" to align the assignment tokens - - The default remains at "true", so the assigned values are aligned - - Thanks to [John P. Bloch][@johnpbloch] for the patch -- Generic.PHP.LowerCaseType now supports checking of typed properties - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.LowerCaseType now supports checking of union types - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PEAR.Commenting.FunctionComment and Squiz.Commenting.FunctionComment sniffs can now ignore private and protected methods - - Set the "minimumVisibility" sniff property to "protected" to ignore private methods - - Set the "minimumVisibility" sniff property to "public" to ignore both private and protected methods - - The default remains at "private", so all methods are checked - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- PEAR.Commenting.FunctionComment and Squiz.Commenting.FunctionComment sniffs can now ignore return tags in any method - - Previously, only `__construct()` and `__destruct()` were ignored - - Set the list of method names to ignore in the "specialMethods" sniff property - - The default remains at "__construct" and "__destruct" only - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- PSR2.ControlStructures.SwitchDeclaration now supports nested switch statements where every branch terminates - - Previously, if a CASE only contained a SWITCH and no direct terminating statement, a fall-through error was displayed - - Now, the error is suppressed if every branch of the SWITCH has a terminating statement - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- The PSR2.Methods.FunctionCallSignature.SpaceBeforeCloseBracket error message is now reported on the closing parenthesis token - - Previously, the error was being reported on the function keyword, leading to confusing line numbers in the error report -- Squiz.Commenting.FunctionComment is now able to ignore function comments that are only inheritdoc statements - - Set the skipIfInheritdoc sniff property to "true" to skip checking function comments if the content is only {@inhertidoc} - - The default remains at "false", so these comments will continue to report errors - - Thanks to [Jess Myrbo][@xjm] for the patch -- Squiz.Commenting.FunctionComment now supports the PHP 8 mixed type - - Thanks to [Vadim Borodavko][@javer] for the patch -- Squiz.PHP.NonExecutableCode now has improved handling of syntax errors - - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch -- Squiz.WhiteSpace.ScopeKeywordSpacing now checks spacing when using PHP 8.0 constructor property promotion - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed an issue that could occur when checking files on network drives, such as with WSL2 on Windows 10 - - This works around a long-standing PHP bug with is_readable() - - Thanks to [Michael S][@codebymikey] for the patch -- Fixed a number of false positives in the Squiz.PHP.DisallowMultipleAssignments sniff - - Sniff no longer errors for default value assignments in arrow functions - - Sniff no longer errors for assignments on first line of closure - - Sniff no longer errors for assignments after a goto label - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#2913][sq-2913] : Generic.WhiteSpace.ScopeIndent false positive when opening and closing tag on same line inside conditional -- Fixed bug [#2992][sq-2992] : Enabling caching using a ruleset produces invalid cache files when using --sniffs and --exclude CLI args -- Fixed bug [#3003][sq-3003] : Squiz.Formatting.OperatorBracket autofix incorrect when assignment used with null coalescing operator -- Fixed bug [#3145][sq-3145] : Autoloading of sniff fails when multiple classes declared in same file -- Fixed bug [#3157][sq-3157] : PSR2.ControlStructures.SwitchDeclaration.BreakIndent false positive when case keyword is not indented -- Fixed bug [#3163][sq-3163] : Undefined index error with pre-commit hook using husky on PHP 7.4 - - Thanks to [Ismo Vuorinen][@ivuorinen] for the patch -- Fixed bug [#3165][sq-3165] : Squiz.PHP.DisallowComparisonAssignment false positive when comparison inside closure -- Fixed bug [#3167][sq-3167] : Generic.WhiteSpace.ScopeIndent false positive when using PHP 8.0 constructor property promotion -- Fixed bug [#3170][sq-3170] : Squiz.WhiteSpace.OperatorSpacing false positive when using negation with string concat - - This also fixes the same issue in the PSR12.Operators.OperatorSpacing sniff -- Fixed bug [#3177][sq-3177] : Incorrect tokenization of GOTO statements in mixed PHP/HTML files - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3184][sq-3184] : PSR2.Namespace.NamespaceDeclaration false positive on namespace operator - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3188][sq-3188] : Squiz.WhiteSpace.ScopeKeywordSpacing false positive for static return type - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3192][sq-3192] : findStartOfStatement doesn't work correctly inside switch - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- Fixed bug [#3195][sq-3195] : Generic.WhiteSpace.ScopeIndent confusing message when combination of tabs and spaces found -- Fixed bug [#3197][sq-3197] : Squiz.NamingConventions.ValidVariableName does not use correct error code for all member vars -- Fixed bug [#3219][sq-3219] : Generic.Formatting.MultipleStatementAlignment false positive for empty anonymous classes and closures -- Fixed bug [#3258][sq-3258] : Squiz.Formatting.OperatorBracket duplicate error messages for unary minus - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3273][sq-3273] : Squiz.Functions.FunctionDeclarationArgumentSpacing reports line break as 0 spaces between parenthesis -- Fixed bug [#3277][sq-3277] : Nullable static return typehint causes whitespace error -- Fixed bug [#3284][sq-3284] : Unused parameter false positive when using array index in arrow function - -[sq-2913]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2913 -[sq-2992]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2992 -[sq-3003]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3003 -[sq-3145]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3145 -[sq-3157]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3157 -[sq-3163]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3163 -[sq-3165]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3165 -[sq-3167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3167 -[sq-3170]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3170 -[sq-3177]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3177 -[sq-3184]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3184 -[sq-3188]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3188 -[sq-3192]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3192 -[sq-3195]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3195 -[sq-3197]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3197 -[sq-3219]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3219 -[sq-3258]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3258 -[sq-3273]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3273 -[sq-3277]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3277 -[sq-3284]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3284 - -## [3.5.8] - 2020-10-23 - -### Removed -- Reverted a change to the way include/exclude patterns are processed for STDIN content - - This change is not backwards compatible and will be re-introduced in version 3.6.0 - -## [3.5.7] - 2020-10-23 - -### Added -- The PHP 8.0 T_NULLSAFE_OBJECT_OPERATOR token has been made available for older versions - - Existing sniffs that check for T_OBJECT_OPERATOR have been modified to apply the same rules for the nullsafe object operator - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The new method of PHP 8.0 tokenizing for namespaced names has been reverted to the pre 8.0 method - - This maintains backwards compatible for existing sniffs on PHP 8.0 - - This change will be removed in PHPCS 4.0 as the PHP 8.0 tokenizing method will be backported for pre 8.0 versions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for changes to the way PHP 8.0 tokenizes hash comments - - The existing PHP 5-7 behaviour has been replicated for version 8, so no sniff changes are required - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Running the unit tests now includes warnings in the found and fixable error code counts - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PSR12.Functions.NullableTypeDeclaration now supports the PHP8 static return type - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Changed -- The autoloader has been changed to fix sniff class name detection issues that may occur when running on PHP 7.4+ - - Thanks to [Eloy Lafuente][@stronk7] for the patch -- PSR12.ControlStructures.BooleanOperatorPlacement.FoundMixed error message is now more accurate when using the allowOnly setting - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch - -### Fixed -- Fixed Squiz.Formatting.OperatorBracket false positive when exiting with a negative number -- Fixed Squiz.PHP.DisallowComparisonAssignment false positive for methods called on an object -- Fixed bug [#2882][sq-2882] : Generic.Arrays.ArrayIndent can request close brace indent to be less than the statement indent level -- Fixed bug [#2883][sq-2883] : Generic.WhiteSpace.ScopeIndent.Incorrect issue after NOWDOC -- Fixed bug [#2975][sq-2975] : Undefined offset in PSR12.Functions.ReturnTypeDeclaration when checking function return type inside ternary -- Fixed bug [#2988][sq-2988] : Undefined offset in Squiz.Strings.ConcatenationSpacing during live coding - - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch -- Fixed bug [#2989][sq-2989] : Incorrect auto-fixing in Generic.ControlStructures.InlineControlStructure during live coding - - Thanks to [Thiemo Kreuz][@thiemowmde] for the patch -- Fixed bug [#3007][sq-3007] : Directory exclude pattern improperly excludes directories with names that start the same - - Thanks to [Steve Talbot][@SteveTalbot] for the patch -- Fixed bug [#3043][sq-3043] : Squiz.WhiteSpace.OperatorSpacing false positive for negation in arrow function - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3049][sq-3049] : Incorrect error with arrow function and parameter passed as reference - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3053][sq-3053] : PSR2 incorrect fix when multiple use statements on same line do not have whitespace between them -- Fixed bug [#3058][sq-3058] : Progress gets unaligned when 100% happens at the end of the available dots -- Fixed bug [#3059][sq-3059] : Squiz.Arrays.ArrayDeclaration false positive when using type casting - - Thanks to [Sergei Morozov][@morozov] for the patch -- Fixed bug [#3060][sq-3060] : Squiz.Arrays.ArrayDeclaration false positive for static functions - - Thanks to [Sergei Morozov][@morozov] for the patch -- Fixed bug [#3065][sq-3065] : Should not fix Squiz.Arrays.ArrayDeclaration.SpaceBeforeComma if comment between element and comma - - Thanks to [Sergei Morozov][@morozov] for the patch -- Fixed bug [#3066][sq-3066] : No support for namespace operator used in type declarations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3075][sq-3075] : PSR12.ControlStructures.BooleanOperatorPlacement false positive when operator is the only content on line -- Fixed bug [#3099][sq-3099] : Squiz.WhiteSpace.OperatorSpacing false positive when exiting with negative number - - Thanks to [Sergei Morozov][@morozov] for the patch -- Fixed bug [#3102][sq-3102] : PSR12.Squiz.OperatorSpacing false positive for default values of arrow functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#3124][sq-3124] : PSR-12 not reporting error for empty lines with only whitespace -- Fixed bug [#3135][sq-3135] : Ignore annotations are broken on PHP 8.0 - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-2882]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2882 -[sq-2883]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2883 -[sq-2975]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2975 -[sq-2988]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2988 -[sq-2989]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2989 -[sq-3007]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3007 -[sq-3043]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3043 -[sq-3049]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3049 -[sq-3053]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3053 -[sq-3058]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3058 -[sq-3059]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3059 -[sq-3060]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3060 -[sq-3065]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3065 -[sq-3066]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3066 -[sq-3075]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3075 -[sq-3099]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3099 -[sq-3102]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3102 -[sq-3124]: https://github.com/squizlabs/PHP_CodeSniffer/issues/3124 -[sq-3135]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3135 - -## [3.5.6] - 2020-08-10 - -### Added -- Added support for PHP 8.0 magic constant dereferencing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added support for changes to the way PHP 8.0 tokenizes comments - - The existing PHP 5-7 behaviour has been replicated for version 8, so no sniff changes are required - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- `File::getMethodProperties()` now detects the PHP 8.0 static return type - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The PHP 8.0 static return type is now supported for arrow functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Changed -- The cache is no longer used if the list of loaded PHP extensions changes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- `Generic.NamingConventions.CamelCapsFunctionName` no longer reports `__serialize` and `__unserialize` as invalid names - - Thanks to [Filip Š][@filips123] for the patch -- `PEAR.NamingConventions.ValidFunctionName` no longer reports `__serialize` and `__unserialize` as invalid names - - Thanks to [Filip Š][@filips123] for the patch -- `Squiz.Scope.StaticThisUsage` now detects usage of `$this` inside closures and arrow functions - - Thanks to [Michał Bundyra][@michalbundyra] for the patch - -### Fixed -- Fixed bug [#2877][sq-2877] : PEAR.Functions.FunctionCallSignature false positive for array of functions - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- Fixed bug [#2888][sq-2888] : PSR12.Files.FileHeader blank line error with multiple namespaces in one file -- Fixed bug [#2926][sq-2926] : phpcs hangs when using arrow functions that return heredoc -- Fixed bug [#2943][sq-2943] : Redundant semicolon added to a file when fixing PSR2.Files.ClosingTag.NotAllowed -- Fixed bug [#2967][sq-2967] : Markdown generator does not output headings correctly - - Thanks to [Petr Bugyík][@o5] for the patch -- Fixed bug [#2977][sq-2977] : File::isReference() does not detect return by reference for closures - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2994][sq-2994] : Generic.Formatting.DisallowMultipleStatements false positive for FOR loop with no body -- Fixed bug [#3033][sq-3033] : Error generated during tokenizing of goto statements on PHP 8 - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-2877]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2877 -[sq-2888]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2888 -[sq-2926]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2926 -[sq-2943]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2943 -[sq-2967]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2967 -[sq-2977]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2977 -[sq-2994]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2994 -[sq-3033]: https://github.com/squizlabs/PHP_CodeSniffer/pull/3033 - -## [3.5.5] - 2020-04-17 - -### Changed -- The T_FN backfill now works more reliably so T_FN tokens only ever represent real arrow functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed an issue where including sniffs using paths containing multiple dots would silently fail -- Generic.CodeAnalysis.EmptyPHPStatement now detects empty statements at the start of control structures - -### Fixed -- Error wording in PEAR.Functions.FunctionCallSignature now always uses "parenthesis" instead of sometimes using "bracket" - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- Fixed bug [#2787][sq-2787] : Squiz.PHP.DisallowMultipleAssignments not ignoring typed property declarations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2810][sq-2810] : PHPCBF fails to fix file with empty statement at start on control structure -- Fixed bug [#2812][sq-2812] : Squiz.Arrays.ArrayDeclaration not detecting some arrays with multiple arguments on the same line - - Thanks to [Jakub Chábek][@grongor] for the patch -- Fixed bug [#2826][sq-2826] : Generic.WhiteSpace.ArbitraryParenthesesSpacing doesn't detect issues for statements directly after a control structure - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- Fixed bug [#2848][sq-2848] : PSR12.Files.FileHeader false positive for file with mixed PHP and HTML and no file header -- Fixed bug [#2849][sq-2849] : Generic.WhiteSpace.ScopeIndent false positive with arrow function inside array -- Fixed bug [#2850][sq-2850] : Generic.PHP.LowerCaseKeyword complains __HALT_COMPILER is uppercase -- Fixed bug [#2853][sq-2853] : Undefined variable error when using Info report - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2865][sq-2865] : Double arrow tokenized as T_STRING when placed after function named "fn" -- Fixed bug [#2867][sq-2867] : Incorrect scope matching when arrow function used inside IF condition -- Fixed bug [#2868][sq-2868] : phpcs:ignore annotation doesn't work inside a docblock -- Fixed bug [#2878][sq-2878] : PSR12.Files.FileHeader conflicts with Generic.Files.LineEndings -- Fixed bug [#2895][sq-2895] : PSR2.Methods.FunctionCallSignature.MultipleArguments false positive with arrow function argument - -[sq-2787]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2787 -[sq-2810]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2810 -[sq-2812]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2812 -[sq-2826]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2826 -[sq-2848]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2848 -[sq-2849]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2849 -[sq-2850]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2850 -[sq-2853]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2853 -[sq-2865]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2865 -[sq-2867]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2867 -[sq-2868]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2868 -[sq-2878]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2878 -[sq-2895]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2895 - -## [3.5.4] - 2020-01-31 - -### Changed -- The PHP 7.4 numeric separator backfill now works correctly for more float formats - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The PHP 7.4 numeric separator backfill is no longer run on PHP version 7.4.0 or greater -- File::getCondition() now accepts a 3rd argument that allows for the closest matching token to be returned - - By default, it continues to return the first matched token found from the top of the file -- Fixed detection of array return types for arrow functions -- Added Generic.PHP.DisallowRequestSuperglobal to ban the use of the $_REQUEST superglobal - - Thanks to [Jeantwan Teuma][@Morerice] for the contribution -- Generic.ControlStructures.InlineControlStructure no longer shows errors for WHILE and FOR statements without a body - - Previously it required these to have curly braces, but there were no statements to enclose in them - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PSR12.ControlStructures.BooleanOperatorPlacement can now be configured to enforce a specific operator position - - By default, the sniff ensures that operators are all at the beginning or end of lines, but not a mix of both - - Set the allowOnly property to "first" to enforce all boolean operators to be at the start of a line - - Set the allowOnly property to "last" to enforce all boolean operators to be at the end of a line - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- PSR12.Files.ImportStatement now auto-fixes import statements by removing the leading slash - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Squiz.ControlStructures.ForLoopDeclaration now has a setting to ignore newline characters - - Default remains FALSE, so newlines are not allowed within FOR definitions - - Override the "ignoreNewlines" setting in a ruleset.xml file to change -- Squiz.PHP.InnerFunctions now handles multiple nested anon classes correctly - -### Fixed -- Fixed bug [#2497][sq-2497] : Sniff properties not set when referencing a sniff using relative paths or non-native slashes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2657][sq-2657] : Squiz.WhiteSpace.FunctionSpacing can remove spaces between comment and first/last method during auto-fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2688][sq-2688] : Case statements not tokenized correctly when switch is contained within ternary -- Fixed bug [#2698][sq-2698] : PHPCS throws errors determining auto report width when shell_exec is disabled - - Thanks to [Matthew Peveler][@MasterOdin] for the patch -- Fixed bug [#2730][sq-2730] : PSR12.ControlStructures.ControlStructureSpacing does not ignore comments between conditions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2732][sq-2732] : PSR12.Files.FileHeader misidentifies file header in mixed content file -- Fixed bug [#2745][sq-2745] : AbstractArraySniff wrong indices when mixed coalesce and ternary values - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#2748][sq-2748] : Wrong end of statement for fn closures - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#2751][sq-2751] : Autoload relative paths first to avoid confusion with files from the global include path - - Thanks to [Klaus Purer][@klausi] for the patch -- Fixed bug [#2763][sq-2763] : PSR12 standard reports errors for multi-line FOR definitions -- Fixed bug [#2768][sq-2768] : Generic.Files.LineLength false positive for non-breakable strings at exactly the soft limit - - Thanks to [Alex Miles][@ghostal] for the patch -- Fixed bug [#2773][sq-2773] : PSR2.Methods.FunctionCallSignature false positive when arrow function has array return type -- Fixed bug [#2790][sq-2790] : PSR12.Traits.UseDeclaration ignores block comments - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- Fixed bug [#2791][sq-2791] : PSR12.Functions.NullableTypeDeclaration false positive when ternary operator used with instanceof - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2802][sq-2802] : Can't specify a report file path using the tilde shortcut -- Fixed bug [#2804][sq-2804] : PHP4-style typed properties not tokenized correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2805][sq-2805] : Undefined Offset notice during live coding of arrow functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2843][sq-2843] : Tokenizer does not support alternative syntax for declare statements - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-2497]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2497 -[sq-2657]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2657 -[sq-2688]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2688 -[sq-2698]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2698 -[sq-2730]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2730 -[sq-2732]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2732 -[sq-2745]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2745 -[sq-2748]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2748 -[sq-2751]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2751 -[sq-2763]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2763 -[sq-2768]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2768 -[sq-2773]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2773 -[sq-2790]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2790 -[sq-2791]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2791 -[sq-2802]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2802 -[sq-2804]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2804 -[sq-2805]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2805 -[sq-2843]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2843 - -## [3.5.3] - 2019-12-04 - -### Changed -- The PHP 7.4 T_FN token has been made available for older versions - - T_FN represents the fn string used for arrow functions - - The double arrow becomes the scope opener, and uses a new T_FN_ARROW token type - - The token after the statement (normally a semicolon) becomes the scope closer - - The token is also associated with the opening and closing parenthesis of the statement - - Any functions named "fn" will have a T_FN token for the function name, but have no scope information - - Thanks to [Michał Bundyra][@michalbundyra] for the help with this change -- PHP 7.4 numeric separators are now tokenized in the same way when using older PHP versions - - Previously, a number like 1_000 would tokenize as T_LNUMBER (1), T_STRING (_000) - - Now, the number tokenizes as T_LNUMBER (1_000) - - Sniff developers should consider how numbers with underscores impact their custom sniffs -- The PHPCS file cache now takes file permissions into account - - The cache is now invalidated for a file when its permissions are changed -- File::getMethodParameters() now supports arrow functions -- File::getMethodProperties() now supports arrow functions -- Added Fixer::changeCodeBlockIndent() to change the indent of a code block while auto-fixing - - Can be used to either increase or decrease the indent - - Useful when moving the start position of something like a closure, where you want the content to also move -- Added Generic.Files.ExecutableFile sniff - - Ensures that files are not executable - - Thanks to [Matthew Peveler][@MasterOdin] for the contribution -- Generic.CodeAnalysis.EmptyPhpStatement now reports unnecessary semicolons after control structure closing braces - - Thanks to [Vincent Langlet][@VincentLanglet] for the patch -- Generic.PHP.LowerCaseKeyword now enforces that the "fn" keyword is lowercase - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Generic.WhiteSpace.ScopeIndent now supports static arrow functions -- PEAR.Functions.FunctionCallSignature now adjusts the indent of function argument contents during auto-fixing - - Previously, only the first line of an argument was changed, leading to inconsistent indents - - This change also applies to PSR2.Methods.FunctionCallSignature -- PSR2.ControlStructures.ControlStructureSpacing now checks whitespace before the closing parenthesis of multi-line control structures - - Previously, it incorrectly applied the whitespace check for single-line definitions only -- PSR12.Functions.ReturnTypeDeclaration now checks the return type of arrow functions - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- PSR12.Traits.UseDeclaration now ensures all trait import statements are grouped together - - Previously, the trait import section of the class ended when the first non-import statement was found - - Checking now continues throughout the class to ensure all statements are grouped together - - This also ensures that empty lines are not requested after an import statement that isn't the last one -- Squiz.Functions.LowercaseFunctionKeywords now enforces that the "fn" keyword is lowercase - - Thanks to [Michał Bundyra][@michalbundyra] for the patch - -### Fixed -- Fixed bug [#2586][sq-2586] : Generic.WhiteSpace.ScopeIndent false positives when indenting open tags at a non tab-stop -- Fixed bug [#2638][sq-2638] : Squiz.CSS.DuplicateClassDefinitionSniff sees comments as part of the class name - - Thanks to [Raphael Horber][@rhorber] for the patch -- Fixed bug [#2640][sq-2640] : Squiz.WhiteSpace.OperatorSpacing false positives for some negation operators - - Thanks to [Jakub Chábek][@grongor] and [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2674][sq-2674] : Squiz.Functions.FunctionDeclarationArgumentSpacing prints wrong argument name in error message -- Fixed bug [#2676][sq-2676] : PSR12.Files.FileHeader locks up when file ends with multiple inline comments -- Fixed bug [#2678][sq-2678] : PSR12.Classes.AnonClassDeclaration incorrectly enforcing that closing brace be on a line by itself -- Fixed bug [#2685][sq-2685] : File::getMethodParameters() setting typeHintEndToken for vars with no type hint - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2694][sq-2694] : AbstractArraySniff produces invalid indices when using ternary operator - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#2702][sq-2702] : Generic.WhiteSpace.ScopeIndent false positive when using ternary operator with short arrays - -[sq-2586]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2586 -[sq-2638]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2638 -[sq-2640]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2640 -[sq-2674]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2674 -[sq-2676]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2676 -[sq-2678]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2678 -[sq-2685]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2685 -[sq-2694]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2694 -[sq-2702]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2702 - -## [3.5.2] - 2019-10-28 - -### Changed -- Generic.ControlStructures.DisallowYodaConditions now returns less false positives - - False positives were being returned for array comparisons, or when performing some function calls -- Squiz.WhiteSpace.SemicolonSpacing.Incorrect error message now escapes newlines and tabs - - Provides a clearer error message as whitespace is now visible - - Also allows for better output for report types such as CSV and XML -- The error message for PSR12.Files.FileHeader.SpacingAfterBlock has been made clearer - - It now uses the wording from the published PSR-12 standard to indicate that blocks must be separated by a blank line - - Thanks to [Craig Duncan][@duncan3dc] for the patch - -### Fixed -- Fixed bug [#2654][sq-2654] : Incorrect indentation for arguments of multiline function calls -- Fixed bug [#2656][sq-2656] : Squiz.WhiteSpace.MemberVarSpacing removes comments before first member var during auto fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2663][sq-2663] : Generic.NamingConventions.ConstructorName complains about old constructor in interfaces -- Fixed bug [#2664][sq-2664] : PSR12.Files.OpenTag incorrectly identifies PHP file with only an opening tag -- Fixed bug [#2665][sq-2665] : PSR12.Files.ImportStatement should not apply to traits -- Fixed bug [#2673][sq-2673] : PSR12.Traits.UseDeclaration does not allow comments or blank lines between use statements - -[sq-2654]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2654 -[sq-2656]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2656 -[sq-2663]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2663 -[sq-2664]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2664 -[sq-2665]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2665 -[sq-2673]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2673 - -## [3.5.1] - 2019-10-17 - -### Changed -- Very very verbose diff report output has slightly changed to improve readability - - Output is printed when running PHPCS with the --report=diff and -vvv command line arguments - - Fully qualified class names have been replaced with sniff codes - - Tokens being changed now display the line number they are on -- PSR2, PSR12, and PEAR standards now correctly check for blank lines at the start of function calls - - This check has been missing from these standards, but has now been implemented - - When using the PEAR standard, the error code is PEAR.Functions.FunctionCallSignature.FirstArgumentPosition - - When using PSR2 or PSR12, the error code is PSR2.Methods.FunctionCallSignature.FirstArgumentPosition -- PSR12.ControlStructures.BooleanOperatorPlacement no longer complains when multiple expressions appear on the same line - - Previously, boolean operators were enforced to appear at the start or end of lines only - - Boolean operators can now appear in the middle of the line -- PSR12.Files.FileHeader no longer ignores comments preceding a use, namespace, or declare statement -- PSR12.Files.FileHeader now allows a hashbang line at the top of the file - -### Fixed -- Fixed bug [#2506][sq-2506] : PSR2 standard can't auto fix multi-line function call inside a string concat statement -- Fixed bug [#2530][sq-2530] : PEAR.Commenting.FunctionComment does not support intersection types in comments -- Fixed bug [#2615][sq-2615] : Constant visibility false positive on non-class constants -- Fixed bug [#2616][sq-2616] : PSR12.Files.FileHeader false positive when file only contains docblock -- Fixed bug [#2619][sq-2619] : PSR12.Files.FileHeader locks up when inline comment is the last content in a file -- Fixed bug [#2621][sq-2621] : PSR12.Classes.AnonClassDeclaration.CloseBraceSameLine false positive for anon class passed as function argument - - Thanks to [Martins Sipenko][@martinssipenko] for the patch -- Fixed bug [#2623][sq-2623] : PSR12.ControlStructures.ControlStructureSpacing not ignoring indentation inside multi-line string arguments -- Fixed bug [#2624][sq-2624] : PSR12.Traits.UseDeclaration doesnt apply the correct indent during auto fixing -- Fixed bug [#2626][sq-2626] : PSR12.Files.FileHeader detects @var annotations as file docblocks -- Fixed bug [#2628][sq-2628] : PSR12.Traits.UseDeclaration does not allow comments above a USE declaration -- Fixed bug [#2632][sq-2632] : Incorrect indentation of lines starting with "static" inside closures -- Fixed bug [#2641][sq-2641] : PSR12.Functions.NullableTypeDeclaration false positive when using new static() - -[sq-2506]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2506 -[sq-2530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2530 -[sq-2615]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2615 -[sq-2616]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2616 -[sq-2619]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2619 -[sq-2621]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2621 -[sq-2623]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2623 -[sq-2624]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2624 -[sq-2626]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2626 -[sq-2628]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2628 -[sq-2632]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2632 -[sq-2641]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2641 - -## [3.5.0] - 2019-09-27 - -### Changed -- The included PSR12 standard is now complete and ready to use - - Check your code using PSR-12 by running PHPCS with --standard=PSR12 -- Added support for PHP 7.4 typed properties - - The nullable operator is now tokenized as T_NULLABLE inside property types, as it is elsewhere - - To get the type of a member var, use the File::getMemberProperties() method, which now contains a "type" array index - - This contains the type of the member var, or a blank string if not specified - - If the type is nullable, the return type will contain the leading ? - - If a type is specified, the position of the first token in the type will be set in a "type_token" array index - - If a type is specified, the position of the last token in the type will be set in a "type_end_token" array index - - If the type is nullable, a "nullable_type" array index will also be set to TRUE - - If the type contains namespace information, it will be cleaned of whitespace and comments in the return value -- The PSR1 standard now correctly bans alternate PHP tags - - Previously, it only banned short open tags and not the pre-7.0 alternate tags -- Added support for only checking files that have been locally staged in a git repo - - Use --filter=gitstaged to check these files - - You still need to give PHPCS a list of files or directories in which to apply the filter - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- JSON reports now end with a newline character -- The phpcs.xsd schema now validates phpcs-only and phpcbf-only attributes correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The tokenizer now correctly identifies inline control structures in more cases -- All helper methods inside the File class now throw RuntimeException instead of TokenizerException - - Some tokenizer methods were also throwing RuntimeException but now correctly throw TokenizerException - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The File::getMethodParameters() method now returns more information, and supports closure USE groups - - If a type hint is specified, the position of the last token in the hint will be set in a "type_hint_end_token" array index - - If a default is specified, the position of the first token in the default value will be set in a "default_token" array index - - If a default is specified, the position of the equals sign will be set in a "default_equal_token" array index - - If the param is not the last, the position of the comma will be set in a "comma_token" array index - - If the param is passed by reference, the position of the reference operator will be set in a "reference_token" array index - - If the param is variable length, the position of the variadic operator will be set in a "variadic_token" array index -- The T_LIST token and it's opening and closing parentheses now contain references to each other in the tokens array - - Uses the same parenthesis_opener/closer/owner indexes as other tokens - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The T_ANON_CLASS token and it's opening and closing parentheses now contain references to each other in the tokens array - - Uses the same parenthesis_opener/closer/owner indexes as other tokens - - Only applicable if the anon class is passing arguments to the constructor - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The PHP 7.4 T_BAD_CHARACTER token has been made available for older versions - - Allows you to safely look for this token, but it will not appear unless checking with PHP 7.4+ -- Metrics are now available for Squiz.WhiteSpace.FunctionSpacing - - Use the "info" report to see blank lines before/after functions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Metrics are now available for Squiz.WhiteSpace.MemberVarSpacing - - Use the "info" report to see blank lines before member vars - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added Generic.ControlStructures.DisallowYodaConditions sniff - - Ban the use of Yoda conditions - - Thanks to [Mponos George][@gmponos] for the contribution -- Added Generic.PHP.RequireStrictTypes sniff - - Enforce the use of a strict types declaration in PHP files -- Added Generic.WhiteSpace.SpreadOperatorSpacingAfter sniff - - Checks whitespace between the spread operator and the variable/function call it applies to - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added PSR12.Classes.AnonClassDeclaration sniff - - Enforces the formatting of anonymous classes -- Added PSR12.Classes.ClosingBrace sniff - - Enforces that closing braces of classes/interfaces/traits/functions are not followed by a comment or statement -- Added PSR12.ControlStructures.BooleanOperatorPlacement sniff - - Enforces that boolean operators between conditions are consistently at the start or end of the line -- Added PSR12.ControlStructures.ControlStructureSpacing sniff - - Enforces that spacing and indents are correct inside control structure parenthesis -- Added PSR12.Files.DeclareStatement sniff - - Enforces the formatting of declare statements within a file -- Added PSR12.Files.FileHeader sniff - - Enforces the order and formatting of file header blocks -- Added PSR12.Files.ImportStatement sniff - - Enforces the formatting of import statements within a file -- Added PSR12.Files.OpenTag sniff - - Enforces that the open tag is on a line by itself when used at the start of a PHP-only file -- Added PSR12.Functions.ReturnTypeDeclaration sniff - - Enforces the formatting of return type declarations in functions and closures -- Added PSR12.Properties.ConstantVisibility sniff - - Enforces that constants must have their visibility defined - - Uses a warning instead of an error due to this conditionally requiring the project to support PHP 7.1+ -- Added PSR12.Traits.UseDeclaration sniff - - Enforces the formatting of trait import statements within a class -- Generic.Files.LineLength ignoreComments property now ignores comments at the end of a line - - Previously, this property was incorrectly causing the sniff to ignore any line that ended with a comment - - Now, the trailing comment is not included in the line length, but the rest of the line is still checked -- Generic.Files.LineLength now only ignores unwrappable comments when the comment is on a line by itself - - Previously, a short unwrappable comment at the end of the line would have the sniff ignore the entire line -- Generic.Functions.FunctionCallArgumentSpacing no longer checks spacing around assignment operators inside function calls - - Use the Squiz.WhiteSpace.OperatorSpacing sniff to enforce spacing around assignment operators - - Note that this sniff checks spacing around all assignment operators, not just inside function calls - - The Generic.Functions.FunctionCallArgumentSpacing.NoSpaceBeforeEquals error has been removed - - Use Squiz.WhiteSpace.OperatorSpacing.NoSpaceBefore instead - - The Generic.Functions.FunctionCallArgumentSpacing.NoSpaceAfterEquals error has been removed - - Use Squiz.WhiteSpace.OperatorSpacing.NoSpaceAfter instead - - This also changes the PEAR/PSR2/PSR12 standards so they no longer check assignment operators inside function calls - - They were previously checking these operators when they should not have - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.WhiteSpace.ScopeIndent no longer performs exact indents checking for chained method calls - - Other sniffs can be used to enforce chained method call indent rules - - Thanks to [Pieter Frenssen][@pfrenssen] for the patch -- PEAR.WhiteSpace.ObjectOperatorIndent now supports multi-level chained statements - - When enabled, chained calls must be indented 1 level more or less than the previous line - - Set the new "multilevel" setting to TRUE in a ruleset.xml file to enable this behaviour - - Thanks to [Marcos Passos][@marcospassos] for the patch -- PSR2.ControlStructures.ControlStructureSpacing now allows whitespace after the opening parenthesis if followed by a comment - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- PSR2.Classes.PropertyDeclaration now enforces a single space after a property type keyword - - The PSR2 standard itself excludes this new check as it is not defined in the written standard - - Using the PSR12 standard will enforce this check -- Squiz.Commenting.BlockComment no longer requires blank line before comment if it's the first content after the PHP open tag - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Functions.FunctionDeclarationArgumentSpacing now has more accurate error messages - - This includes renaming the SpaceAfterDefault error code to SpaceAfterEquals, which reflects the real error -- Squiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a reference operator - - If you don't want this new behaviour, exclude the SpacingAfterReference error message in a ruleset.xml file -- Squiz.Functions.FunctionDeclarationArgumentSpacing now checks for no space after a variadic operator - - If you don't want this new behaviour, exclude the SpacingAfterVariadic error message in a ruleset.xml file -- Squiz.Functions.MultiLineFunctionDeclaration now has improved fixing for the FirstParamSpacing and UseFirstParamSpacing errors -- Squiz.Operators.IncrementDecrementUsage now suggests pre-increment of variables instead of post-increment - - This change does not enforce pre-increment over post-increment; only the suggestion has changed - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.PHP.DisallowMultipleAssignments now has a second error code for when assignments are found inside control structure conditions - - The new error code is Squiz.PHP.DisallowMultipleAssignments.FoundInControlStructure - - All other multiple assignment cases use the existing error code Squiz.PHP.DisallowMultipleAssignments.Found - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.FunctionSpacing now applies beforeFirst and afterLast spacing rules to nested functions - - Previously, these rules only applied to the first and last function in a class, interface, or trait - - These rules now apply to functions nested in any statement block, including other functions and conditions -- Squiz.WhiteSpace.OperatorSpacing now has improved handling of parse errors - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.OperatorSpacing now checks spacing around the instanceof operator - - Thanks to [Jakub Chábek][@grongor] for the patch -- Squiz.WhiteSpace.OperatorSpacing can now enforce a single space before assignment operators - - Previously, the sniff this spacing as multiple assignment operators are sometimes aligned - - Now, you can set the ignoreSpacingBeforeAssignments sniff property to FALSE to enable checking - - Default remains TRUE, so spacing before assignments is not checked by default - - Thanks to [Jakub Chábek][@grongor] for the patch - -### Fixed -- Fixed bug [#2391][sq-2391] : Sniff-specific ignore rules inside rulesets are filtering out too many files - - Thanks to [Juliette Reinders Folmer][@jrfnl] and [Willington Vega][@wvega] for the patch -- Fixed bug [#2478][sq-2478] : FunctionCommentThrowTag.WrongNumber when exception is thrown once but built conditionally -- Fixed bug [#2479][sq-2479] : Generic.WhiteSpace.ScopeIndent error when using array destructing with exact indent checking -- Fixed bug [#2498][sq-2498] : Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed autofix breaks heredoc -- Fixed bug [#2502][sq-2502] : Generic.WhiteSpace.ScopeIndent false positives with nested switch indentation and case fall-through -- Fixed bug [#2504][sq-2504] : Generic.WhiteSpace.ScopeIndent false positives with nested arrays and nowdoc string -- Fixed bug [#2511][sq-2511] : PSR2 standard not checking if closing paren of single-line function declaration is on new line -- Fixed bug [#2512][sq-2512] : Squiz.PHP.NonExecutableCode does not support alternate SWITCH control structure - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2522][sq-2522] : Text generator throws error when code sample line is too long - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2526][sq-2526] : XML report format has bad syntax on Windows - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2529][sq-2529] : Generic.Formatting.MultipleStatementAlignment wrong error for assign in string concat -- Fixed bug [#2534][sq-2534] : Unresolvable installed_paths can lead to open_basedir errors - - Thanks to [Oliver Nowak][@ndm2] for the patch -- Fixed bug [#2541][sq-2541] : Text doc generator does not allow for multi-line rule explanations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2549][sq-2549] : Searching for a phpcs.xml file can throw warnings due to open_basedir restrictions - - Thanks to [Matthew Peveler][@MasterOdin] for the patch -- Fixed bug [#2558][sq-2558] : PHP 7.4 throwing offset syntax with curly braces is deprecated message - - Thanks to [Matthew Peveler][@MasterOdin] for the patch -- Fixed bug [#2561][sq-2561] : PHP 7.4 compatibility fix / implode argument order - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2562][sq-2562] : Inline WHILE triggers SpaceBeforeSemicolon incorrectly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2565][sq-2565] : Generic.ControlStructures.InlineControlStructure confused by mixed short/long tags - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2566][sq-2566] : Author tag email validation doesn't support all TLDs - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2575][sq-2575] : Custom error messages don't have data replaced when cache is enabled -- Fixed bug [#2601][sq-2601] : Squiz.WhiteSpace.FunctionSpacing incorrect fix when spacing is 0 -- Fixed bug [#2608][sq-2608] : PSR2 throws errors for use statements when multiple namespaces are defined in a file - -[sq-2391]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2391 -[sq-2478]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2478 -[sq-2479]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2479 -[sq-2498]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2498 -[sq-2502]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2502 -[sq-2504]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2504 -[sq-2511]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2511 -[sq-2512]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2512 -[sq-2522]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2522 -[sq-2526]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2526 -[sq-2529]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2529 -[sq-2534]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2534 -[sq-2541]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2541 -[sq-2549]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2549 -[sq-2558]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2558 -[sq-2561]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2561 -[sq-2562]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2562 -[sq-2565]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2565 -[sq-2566]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2566 -[sq-2575]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2575 -[sq-2601]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2601 -[sq-2608]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2608 - -## [3.4.2] - 2019-04-11 - -### Changed -- Squiz.Arrays.ArrayDeclaration now has improved handling of syntax errors - -### Fixed -- Fixed an issue where the PCRE JIT on PHP 7.3 caused PHPCS to die when using the parallel option - - PHPCS now disables the PCRE JIT before running -- Fixed bug [#2368][sq-2368] : MySource.PHP.AjaxNullComparison throws error when first function has no doc comment -- Fixed bug [#2414][sq-2414] : Indention false positive in switch/case/if combination -- Fixed bug [#2423][sq-2423] : Squiz.Formatting.OperatorBracket.MissingBrackets error with static -- Fixed bug [#2450][sq-2450] : Indentation false positive when closure containing nested IF conditions used as function argument -- Fixed bug [#2452][sq-2452] : LowercasePHPFunctions sniff failing on "new \File()" -- Fixed bug [#2453][sq-2453] : Squiz.CSS.SemicolonSpacingSniff false positive when style name proceeded by an asterisk - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2464][sq-2464] : Fixer conflict between Generic.WhiteSpace.ScopeIndent and Squiz.WhiteSpace.ScopeClosingBrace when class indented 1 space -- Fixed bug [#2465][sq-2465] : Excluding a sniff by path is not working -- Fixed bug [#2467][sq-2467] : PHP open/close tags inside CSS files are replaced with internal PHPCS token strings when auto fixing - -[sq-2368]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2368 -[sq-2414]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2414 -[sq-2423]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2423 -[sq-2450]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2450 -[sq-2452]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2452 -[sq-2453]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2453 -[sq-2464]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2464 -[sq-2465]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2465 -[sq-2467]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2467 - -## [3.4.1] - 2019-03-19 - -### Changed -- The PEAR installable version of PHPCS was missing some files, which have been re-included in this release - - The code report was not previously available for PEAR installs - - The Generic.Formatting.SpaceBeforeCast sniff was not previously available for PEAR installs - - The Generic.WhiteSpace.LanguageConstructSpacing sniff was not previously available for PEAR installs - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PHPCS will now refuse to run if any of the required PHP extensions are not loaded - - Previously, PHPCS only relied on requirements being checked by PEAR and Composer - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Ruleset XML parsing errors are now displayed in a readable format so they are easier to correct - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The PSR2 standard no longer throws duplicate errors for spacing around FOR loop parentheses - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- T_PHPCS_SET tokens now contain sniffCode, sniffProperty, and sniffPropertyValue indexes - - Sniffs can use this information instead of having to parse the token content manually -- Added more guard code for syntax errors to various CSS sniffs - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Commenting.DocComment error messages now contain the name of the comment tag that caused the error - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.ControlStructures.InlineControlStructure now handles syntax errors correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Debug.JSHint now longer requires rhino and can be run directly from the npm install - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Files.LineEndings no longer adds superfluous new line at the end of JS and CSS files - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Formatting.DisallowMultipleStatements no longer tries to fix lines containing phpcs:ignore statements - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Functions.FunctionCallArgumentSpacing now has improved performance and anonymous class support - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.WhiteSpace.ScopeIndent now respects changes to the "exact" property using phpcs:set mid-way through a file - - This allows you to change the "exact" rule for only some parts of a file -- Generic.WhiteSpace.ScopeIndent now disables exact indent checking inside all arrays - - Previously, this was only done when using long array syntax, but it now works for short array syntax as well -- PEAR.Classes.ClassDeclaration now has improved handling of PHPCS annotations and tab indents -- PSR12.Classes.ClassInstantiation has changed its error code from MissingParenthesis to MissingParentheses -- PSR12.Keywords.ShortFormTypeKeywords now ignores all spacing inside type casts during both checking and fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Classes.LowercaseClassKeywords now examines the class keyword for anonymous classes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.ControlStructures.ControlSignature now has improved handling of parse errors - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.PostStatementComment fixer no longer adds a blank line at the start of a JS file that begins with a comment - - Fixes a conflict between this sniff and the Squiz.WhiteSpace.SuperfluousWhitespace sniff - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.PostStatementComment now ignores comments inside control structure conditions, such as FOR loops - - Fixes a conflict between this sniff and the Squiz.ControlStructures.ForLoopDeclaration sniff - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.FunctionCommentThrowTag now has improved support for unknown exception types and namespaces - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.ControlStructures.ForLoopDeclaration has improved whitespace, closure, and empty expression support - - The SpacingAfterSecondNoThird error code has been removed as part of these fixes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.CSS.ClassDefinitionOpeningBraceSpace now handles comments and indentation correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.CSS.ClassDefinitionClosingBrace now handles comments, indentation, and multiple statements on the same line correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.CSS.Opacity now handles comments correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.CSS.SemicolonSpacing now handles comments and syntax errors correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.PHP.LowercasePHPFunctions now handles use statements, namespaces, and comments correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.FunctionSpacing now fixes function spacing correctly when a function is the first content in a file - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.SuperfluousWhitespace no longer throws errors for spacing between functions and properties in anon classes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Zend.Files.ClosingTag no longer adds a semicolon during fixing of a file that only contains a comment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Zend.NamingConventions.ValidVariableName now supports variables inside anonymous classes correctly - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed bug [#2298][sq-2298] : PSR2.Classes.ClassDeclaration allows extended class on new line - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#2337][sq-2337] : Generic.WhiteSpace.ScopeIndent incorrect error when multi-line function call starts on same line as open tag -- Fixed bug [#2348][sq-2348] : Cache not invalidated when changing a ruleset included by another -- Fixed bug [#2376][sq-2376] : Using __halt_compiler() breaks Generic.PHP.ForbiddenFunctions unless it's last in the function list - - Thanks to [Sijun Zhu][@Billz95] for the patch -- Fixed bug [#2393][sq-2393] : The gitmodified filter will infinitely loop when encountering deleted file paths - - Thanks to [Lucas Manzke][@lmanzke] for the patch -- Fixed bug [#2396][sq-2396] : Generic.WhiteSpace.ScopeIndent incorrect error when multi-line IF condition mixed with HTML -- Fixed bug [#2431][sq-2431] : Use function/const not tokenized as T_STRING when preceded by comment - -[sq-2298]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2298 -[sq-2337]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2337 -[sq-2348]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2348 -[sq-2376]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2376 -[sq-2393]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2393 -[sq-2396]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2396 -[sq-2431]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2431 - -## [3.4.0] - 2018-12-20 - -### Deprecated -- The Generic.Formatting.NoSpaceAfterCast sniff has been deprecated and will be removed in version 4 - - The functionality of this sniff is now available in the Generic.Formatting.SpaceAfterCast sniff - - Include the Generic.Formatting.SpaceAfterCast sniff and set the "spacing" property to "0" - - As soon as possible, replace all instances of the old sniff code with the new sniff code and property setting - - The existing sniff will continue to work until version 4 has been released - -### Changed -- Rule include patterns in a ruleset.xml file are now evaluated as OR instead of AND - - Previously, a file had to match every include pattern and no exclude patterns to be included - - Now, a file must match at least one include pattern and no exclude patterns to be included - - This is a bug fix as include patterns are already documented to work this way -- New token T_BITWISE_NOT added for the bitwise not operator - - This token was previously tokenized as T_NONE - - Any sniffs specifically looking for T_NONE tokens with a tilde as the contents must now also look for T_BITWISE_NOT - - Sniffs can continue looking for T_NONE as well as T_BITWISE_NOT to support older PHP_CodeSniffer versions -- All types of binary casting are now tokenized as T_BINARY_CAST - - Previously, the 'b' in 'b"some string with $var"' would be a T_BINARY_CAST, but only when the string contained a var - - This change ensures the 'b' is always tokenized as T_BINARY_CAST - - This change also converts '(binary)' from T_STRING_CAST to T_BINARY_CAST - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the help with this patch -- Array properties set inside a ruleset.xml file can now extend a previous value instead of always overwriting it - - e.g., if you include a ruleset that defines forbidden functions, can you now add to that list instead of having to redefine it - - To use this feature, add extend="true" to the property tag - - e.g., property name="forbiddenFunctionNames" type="array" extend="true" - - Thanks to [Michael Moravec][@Majkl578] for the patch -- If $XDG_CACHE_HOME is set and points to a valid directory, it will be used for caching instead of the system temp directory -- PHPCBF now disables parallel running if you are passing content on STDIN - - Stops an error from being shown after the fixed output is printed -- The progress report now shows files with tokenizer errors as skipped (S) instead of a warning (W) - - The tokenizer error is still displayed in reports as normal - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The Squiz standard now ensures there is no space between an increment/decrement operator and its variable -- The File::getMethodProperties() method now includes a has_body array index in the return value - - FALSE if the method has no body (as with abstract and interface methods) or TRUE otherwise - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- The File::getTokensAsString() method now throws an exception if the $start param is invalid - - If the $length param is invalid, an empty string will be returned - - Stops an infinite loop when the function is passed invalid data - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added new Generic.CodeAnalysis.EmptyPHPStatement sniff - - Warns when it finds empty PHP open/close tag combinations or superfluous semicolons - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added new Generic.Formatting.SpaceBeforeCast sniff - - Ensures there is exactly 1 space before a type cast, unless the cast statement is indented or multi-line - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added new Generic.VersionControl.GitMergeConflict sniff - - Detects merge conflict artifacts left in files - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added Generic.WhiteSpace.IncrementDecrementSpacing sniff - - Ensures there is no space between the operator and the variable it applies to - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added PSR12.Functions.NullableTypeDeclaration sniff - - Ensures there is no space after the question mark in a nullable type declaration - - Thanks to [Timo Schinkel][@timoschinkel] for the contribution -- A number of sniffs have improved support for methods in anonymous classes - - These sniffs would often throw the same error twice for functions in nested classes - - Error messages have also been changed to be less confusing - - The full list of affected sniffs is: - - Generic.NamingConventions.CamelCapsFunctionName - - PEAR.NamingConventions.ValidFunctionName - - PSR1.Methods.CamelCapsMethodName - - PSR2.Methods.MethodDeclaration - - Squiz.Scope.MethodScope - - Squiz.Scope.StaticThisUsage - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.CodeAnalysis.UnusedFunctionParameter now only skips functions with empty bodies when the class implements an interface - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.CodeAnalysis.UnusedFunctionParameter now has additional error codes to indicate where unused params were found - - The new error code prefixes are: - - FoundInExtendedClass: when the class extends another - - FoundInImplementedInterface: when the class implements an interface - - Found: used in all other cases, including closures - - The new error code suffixes are: - - BeforeLastUsed: the unused param was positioned before the last used param in the function signature - - AfterLastUsed: the unused param was positioned after the last used param in the function signature - - This makes the new error code list for this sniff: - - Found - - FoundBeforeLastUsed - - FoundAfterLastUsed - - FoundInExtendedClass - - FoundInExtendedClassBeforeLastUsed - - FoundInExtendedClassAfterLastUsed - - FoundInImplementedInterface - - FoundInImplementedInterfaceBeforeLastUsed - - FoundInImplementedInterfaceAfterLastUsed - - These errors code make it easier for specific cases to be ignored or promoted using a ruleset.xml file - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Generic.Classes.DuplicateClassName now inspects traits for duplicate names as well as classes and interfaces - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- Generic.Files.InlineHTML now ignores a BOM at the start of the file - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- Generic.PHP.CharacterBeforePHPOpeningTag now ignores a BOM at the start of the file - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- Generic.Formatting.SpaceAfterCast now has a setting to specify how many spaces are required after a type cast - - Default remains 1 - - Override the "spacing" setting in a ruleset.xml file to change - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Formatting.SpaceAfterCast now has a setting to ignore newline characters after a type cast - - Default remains FALSE, so newlines are not allowed - - Override the "ignoreNewlines" setting in a ruleset.xml file to change - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Formatting.SpaceAfterNot now has a setting to specify how many spaces are required after a NOT operator - - Default remains 1 - - Override the "spacing" setting in a ruleset.xml file to change - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Formatting.SpaceAfterNot now has a setting to ignore newline characters after the NOT operator - - Default remains FALSE, so newlines are not allowed - - Override the "ignoreNewlines" setting in a ruleset.xml file to change - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PEAR.Functions.FunctionDeclaration now checks spacing before the opening parenthesis of functions with no body - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- PEAR.Functions.FunctionDeclaration now enforces no space before the semicolon in functions with no body - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- PSR2.Classes.PropertyDeclaration now checks the order of property modifier keywords - - This is a rule that is documented in PSR-2 but was not enforced by the included PSR2 standard until now - - This sniff is also able to fix the order of the modifier keywords if they are incorrect - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PSR2.Methods.MethodDeclaration now checks method declarations inside traits - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- Squiz.Commenting.InlineComment now has better detection of comment block boundaries -- Squiz.Classes.ClassFileName now checks that a trait name matches the filename - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- Squiz.Classes.SelfMemberReference now supports scoped declarations and anonymous classes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Classes.SelfMemberReference now fixes multiple errors at once, increasing fixer performance - - Thanks to [Gabriel Ostrolucký][@ostrolucky] for the patch -- Squiz.Functions.LowercaseFunctionKeywords now checks abstract and final prefixes, and auto-fixes errors - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Objects.ObjectMemberComma.Missing has been renamed to Squiz.Objects.ObjectMemberComma.Found - - The error is thrown when the comma is found but not required, so the error code was incorrect - - If you are referencing the old error code in a ruleset XML file, please use the new code instead - - If you wish to maintain backwards compatibility, you can provide rules for both the old and new codes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.ObjectOperatorSpacing is now more tolerant of parse errors -- Squiz.WhiteSpace.ObjectOperatorSpacing now fixes errors more efficiently - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed bug [#2109][sq-2109] : Generic.Functions.CallTimePassByReference false positive for bitwise and used in function argument -- Fixed bug [#2165][sq-2165] : Conflict between Squiz.Arrays.ArrayDeclaration and ScopeIndent sniffs when heredoc used in array -- Fixed bug [#2167][sq-2167] : Generic.WhiteSpace.ScopeIndent shows invalid error when scope opener indented inside inline HTML -- Fixed bug [#2178][sq-2178] : Generic.NamingConventions.ConstructorName matches methods in anon classes with same name as containing class - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2190][sq-2190] : PEAR.Functions.FunctionCallSignature incorrect error when encountering trailing PHPCS annotation - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2194][sq-2194] : Generic.Whitespace.LanguageConstructSpacing should not be checking namespace operators - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2202][sq-2202] : Squiz.WhiteSpace.OperatorSpacing throws error for negative index when using curly braces for string access - - Same issue fixed in Squiz.Formatting.OperatorBracket - - Thanks to [Andreas Buchenrieder][@anbuc] for the patch -- Fixed bug [#2210][sq-2210] : Generic.NamingConventions.CamelCapsFunctionName not ignoring SoapClient __getCookies() method - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2211][sq-2211] : PSR2.Methods.MethodDeclaration gets confused over comments between modifier keywords - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2212][sq-2212] : FUNCTION and CONST in use groups being tokenized as T_FUNCTION and T_CONST - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- Fixed bug [#2214][sq-2214] : File::getMemberProperties() is recognizing method params as properties - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2236][sq-2236] : Memory info measurement unit is Mb but probably should be MB -- Fixed bug [#2246][sq-2246] : CSS tokenizer does not tokenize class names correctly when they contain the string NEW - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2278][sq-2278] : Squiz.Operators.ComparisonOperatorUsage false positive when inline IF contained in parentheses - - Thanks to [Arnout Boks][@aboks] for the patch -- Fixed bug [#2284][sq-2284] : Squiz.Functions.FunctionDeclarationArgumentSpacing removing type hint during fixing - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#2297][sq-2297] : Anonymous class not tokenized correctly when used as argument to another anon class - - Thanks to [Michał Bundyra][@michalbundyra] for the patch - -[sq-2109]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2109 -[sq-2165]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2165 -[sq-2167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2167 -[sq-2178]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2178 -[sq-2190]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2190 -[sq-2194]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2194 -[sq-2202]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2202 -[sq-2210]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2210 -[sq-2211]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2211 -[sq-2212]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2212 -[sq-2214]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2214 -[sq-2236]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2236 -[sq-2246]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2246 -[sq-2278]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2278 -[sq-2284]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2284 -[sq-2297]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2297 - -## [2.9.2] - 2018-11-08 - -### Changed -- PHPCS should now run under PHP 7.3 without deprecation warnings - - Thanks to [Nick Wilde][@NickDickinsonWilde] for the patch - -### Fixed -- Fixed bug [#1496][sq-1496] : Squiz.Strings.DoubleQuoteUsage not unescaping dollar sign when fixing - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#1549][sq-1549] : Squiz.PHP.EmbeddedPhp fixer conflict with // comment before PHP close tag - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1890][sq-1890] : Incorrect Squiz.WhiteSpace.ControlStructureSpacing.NoLineAfterClose error between catch and finally statements - -## [3.3.2] - 2018-09-24 - -### Changed -- Fixed a problem where the report cache was not being cleared when the sniffs inside a standard were updated -- The info report (--report=info) now has improved formatting for metrics that span multiple lines - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The unit test runner now skips .bak files when looking for test cases - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The Squiz standard now ensures underscores are not used to indicate visibility of private members vars and methods - - Previously, this standard enforced the use of underscores -- Generic.PHP.NoSilencedErrors error messages now contain a code snippet to show the context of the error - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Arrays.ArrayDeclaration no longer reports errors for a comma on a line new after a here/nowdoc - - Also stops a parse error being generated when auto-fixing - - The SpaceBeforeComma error message has been changed to only have one data value instead of two -- Squiz.Commenting.FunctionComment no longer errors when trying to fix indents of multi-line param comments -- Squiz.Formatting.OperatorBracket now correctly fixes statements that contain strings -- Squiz.PHP.CommentedOutCode now ignores more @-style annotations and includes better comment block detection - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed a problem where referencing a relative file path in a ruleset XML file could add unnecessary sniff exclusions - - This didn't actually exclude anything, but caused verbose output to list strange exclusion rules -- Fixed bug [#2110][sq-2110] : Squiz.WhiteSpace.FunctionSpacing is removing indents from the start of functions when fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2115][sq-2115] : Squiz.Commenting.VariableComment not checking var types when the @var line contains a comment -- Fixed bug [#2120][sq-2120] : Tokenizer fails to match T_INLINE_ELSE when used after function call containing closure -- Fixed bug [#2121][sq-2121] : Squiz.PHP.DisallowMultipleAssignments false positive in while loop conditions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2127][sq-2127] : File::findExtendedClassName() doesn't support nested classes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2138][sq-2138] : Tokenizer detects wrong token for PHP ::class feature with spaces -- Fixed bug [#2143][sq-2143] : PSR2.Namespaces.UseDeclaration does not properly fix "use function" and "use const" statements - - Thanks to [Chris Wilkinson][@thewilkybarkid] for the patch -- Fixed bug [#2144][sq-2144] : Squiz.Arrays.ArrayDeclaration does incorrect align calculation in array with cyrillic keys -- Fixed bug [#2146][sq-2146] : Zend.Files.ClosingTag removes closing tag from end of file without inserting a semicolon -- Fixed bug [#2151][sq-2151] : XML schema not updated with the new array property syntax - -[sq-2110]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2110 -[sq-2115]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2115 -[sq-2120]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2120 -[sq-2121]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2121 -[sq-2127]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2127 -[sq-2138]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2138 -[sq-2143]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2143 -[sq-2144]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2144 -[sq-2146]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2146 -[sq-2151]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2151 - -## [3.3.1] - 2018-07-27 - -### Removed -- Support for HHVM has been dropped due to recent unfixed bugs and HHVM refocus on Hack only - - Thanks to [Walt Sorensen][@photodude] and [Juliette Reinders Folmer][@jrfnl] for helping to remove all HHVM exceptions from the core - -### Changed -- The full report (the default report) now has improved word wrapping for multi-line messages and sniff codes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The summary report now sorts files based on their directory location instead of just a basic string sort - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The source report now orders error codes by name when they have the same number of errors - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The junit report no longer generates validation errors with the Jenkins xUnit plugin - - Thanks to [Nikolay Geo][@nicholascus] for the patch -- Generic.Commenting.DocComment no longer generates the SpacingBeforeTags error if tags are the first content in the docblock - - The sniff will still generate a MissingShort error if there is no short comment - - This allows the MissingShort error to be suppressed in a ruleset to make short descriptions optional -- Generic.Functions.FunctionCallArgumentSpacing now properly fixes multi-line function calls with leading commas - - Previously, newlines between function arguments would be removed - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.Syntax will now use PHP_BINARY instead of trying to discover the executable path - - This ensures that the sniff will always syntax check files using the PHP version that PHPCS is running under - - Setting the `php_path` config var will still override this value as normal - - Thanks to [Willem Stuursma-Ruwen][@willemstuursma] for the patch -- PSR2.Namespaces.UseDeclaration now supports commas at the end of group use declarations - - Also improves checking and fixing for use statements containing parse errors - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Arrays.ArrayDeclaration no longer removes the array opening brace while fixing - - This could occur when the opening brace was on a new line and the first array key directly followed - - This change also stops the KeyNotAligned error message being incorrectly reported in these cases -- Squiz.Arrays.ArrayDeclaration no longer tries to change multi-line arrays to single line when they contain comments - - Fixes a conflict between this sniff and some indentation sniffs -- Squiz.Classes.ClassDeclaration no longer enforces spacing rules when a class is followed by a function - - Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff -- The Squiz.Classes.ValidClassName.NotCamelCaps message now references PascalCase instead of CamelCase - - The "CamelCase class name" metric produced by the sniff has been changed to "PascalCase class name" - - This reflects the fact that the class name check is actually a Pascal Case check and not really Camel Case - - Thanks to [Tom H Anderson][@TomHAnderson] for the patch -- Squiz.Commenting.InlineComment no longer enforces spacing rules when an inline comment is followed by a docblock - - Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff -- Squiz.WhiteSpace.OperatorSpacing no longer tries to fix operator spacing if the next content is a comment on a new line - - Fixes a conflict between this sniff and the Squiz.Commenting.PostStatementComment sniff - - Also stops PHPCS annotations from being moved to a different line, potentially changing their meaning - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.FunctionSpacing no longer checks spacing of functions at the top of an embedded PHP block - - Fixes a conflict between this sniff and the Squiz.PHP.EmbeddedPHP sniff - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.MemberVarSpacing no longer checks spacing before member vars that come directly after methods - - Fixes a conflict between this sniff and the Squiz.WhiteSpace.FunctionSpacing sniff -- Squiz.WhiteSpace.SuperfluousWhitespace now recognizes unicode whitespace at the start and end of a file - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed bug [#2029][sq-2029] : Squiz.Scope.MemberVarScope throws fatal error when a property is found in an interface - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2047][sq-2047] : PSR12.Classes.ClassInstantiation false positive when instantiating class from array index -- Fixed bug [#2048][sq-2048] : GenericFormatting.MultipleStatementAlignment false positive when assigning values inside an array -- Fixed bug [#2053][sq-2053] : PSR12.Classes.ClassInstantiation incorrectly fix when using member vars and some variable formats -- Fixed bug [#2065][sq-2065] : Generic.ControlStructures.InlineControlStructure fixing fails when inline control structure contains closure -- Fixed bug [#2072][sq-2072] : Squiz.Arrays.ArrayDeclaration throws NoComma error when array value is a shorthand IF statement -- Fixed bug [#2082][sq-2082] : File with "defined() or define()" syntax triggers PSR1.Files.SideEffects.FoundWithSymbols -- Fixed bug [#2095][sq-2095] : PSR2.Namespaces.NamespaceDeclaration does not handle namespaces defined over multiple lines - -[sq-2029]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2029 -[sq-2047]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2047 -[sq-2048]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2048 -[sq-2053]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2053 -[sq-2065]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2065 -[sq-2072]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2072 -[sq-2082]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2082 -[sq-2095]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2095 - -## [3.3.0] - 2018-06-07 - -### Deprecated -- The Squiz.WhiteSpace.LanguageConstructSpacing sniff has been deprecated and will be removed in version 4 - - The sniff has been moved to the Generic standard, with a new code of Generic.WhiteSpace.LanguageConstructSpacing - - As soon as possible, replace all instances of the old sniff code with the new sniff code in your ruleset.xml files - - The existing Squiz sniff will continue to work until version 4 has been released - - The new Generic sniff now also checks many more language constructs to enforce additional spacing rules - - Thanks to [Mponos George][@gmponos] for the contribution -- The current method for setting array properties in ruleset files has been deprecated and will be removed in version 4 - - Currently, setting an array value uses the string syntax "print=>echo,create_function=>null" - - Now, individual array elements are specified using a new "element" tag with "key" and "value" attributes - - For example, element key="print" value="echo" - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- The T_ARRAY_HINT token has been deprecated and will be removed in version 4 - - The token was used to ensure array type hints were not tokenized as T_ARRAY, but no other type hints were given a special token - - Array type hints now use the standard T_STRING token instead - - Sniffs referencing this token type will continue to run without error until version 4, but will not find any T_ARRAY_HINT tokens -- The T_RETURN_TYPE token has been deprecated and will be removed in version 4 - - The token was used to ensure array/self/parent/callable return types were tokenized consistently - - For namespaced return types, only the last part of the string (the class name) was tokenized as T_RETURN_TYPE - - This was not consistent and so return types are now left using their original token types so they are not skipped by sniffs - - The exception are array return types, which are tokenized as T_STRING instead of T_ARRAY, as they are for type hints - - Sniffs referencing this token type will continue to run without error until version 4, but will not find any T_RETUTN_TYPE tokens - - To get the return type of a function, use the File::getMethodProperties() method, which now contains a "return_type" array index - - This contains the return type of the function or closer, or a blank string if not specified - - If the return type is nullable, the return type will contain the leading ? - - A nullable_return_type array index in the return value will also be set to true - - If the return type contains namespace information, it will be cleaned of whitespace and comments - - To access the original return value string, use the main tokens array - -### Added -- This release contains an incomplete version of the PSR-12 coding standard - - Errors found using this standard should be valid, but it will miss a lot of violations until it is complete - - If you'd like to test and help, you can use the standard by running PHPCS with --standard=PSR12 - -### Changed -- Config values set using --runtime-set now override any config values set in rulesets or the CodeSniffer.conf file -- You can now apply include-pattern rules to individual message codes in a ruleset like you can with exclude-pattern rules - - Previously, include-pattern rules only applied to entire sniffs - - If a message code has both include and exclude patterns, the exclude patterns will be ignored -- Using PHPCS annotations to selectively re-enable sniffs is now more flexible - - Previously, you could only re-enable a sniff/category/standard using the exact same code that was disabled - - Now, you can disable a standard and only re-enable a specific category or sniff - - Or, you can disable a specific sniff and have it re-enable when you re-enable the category or standard -- The value of array sniff properties can now be set using phpcs:set annotations - - e.g., phpcs:set Standard.Category.SniffName property[] key=>value,key2=>value2 - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- PHPCS annotations now remain as T_PHPCS_* tokens instead of reverting to comment tokens when --ignore-annotations is used - - This stops sniffs (especially commenting sniffs) from generating a large number of false errors when ignoring - - Any custom sniffs that are using the T_PHPCS_* tokens to detect annotations may need to be changed to ignore them - - Check $phpcsFile->config->annotations to see if annotations are enabled and ignore when false -- You can now use fully or partially qualified class names for custom reports instead of absolute file paths - - To support this, you must specify an autoload file in your ruleset.xml file and use it to register an autoloader - - Your autoloader will need to load your custom report class when requested - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The JSON report format now does escaping in error source codes as well as error messages - - Thanks to [Martin Vasel][@marvasDE] for the patch -- Invalid installed_paths values are now ignored instead of causing a fatal error -- Improved testability of custom rulesets by allowing the installed standards to be overridden - - Thanks to [Timo Schinkel][@timoschinkel] for the patch -- The key used for caching PHPCS runs now includes all set config values - - This fixes a problem where changing config values (e.g., via --runtime-set) used an incorrect cache file -- The "Function opening brace placement" metric has been separated into function and closure metrics in the info report - - Closures are no longer included in the "Function opening brace placement" metric - - A new "Closure opening brace placement" metric now shows information for closures -- Multi-line T_YIELD_FROM statements are now replicated properly for older PHP versions -- The PSR2 standard no longer produces 2 error messages when the AS keyword in a foreach loop is not lowercase -- Specifying a path to a non-existent dir when using the `--report-[reportType]=/path/to/report` CLI option no longer throws an exception - - This now prints a readable error message, as it does when using `--report-file` -- The File::getMethodParamaters() method now includes a type_hint_token array index in the return value - - Provides the position in the token stack of the first token in the type hint -- The File::getMethodProperties() method now includes a return_type_token array index in the return value - - Provides the position in the token stack of the first token in the return type -- The File::getTokensAsString() method can now optionally return original (non tab-replaced) content - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Removed Squiz.PHP.DisallowObEndFlush from the Squiz standard - - If you use this sniff and want to continue banning ob_end_flush(), use Generic.PHP.ForbiddenFunctions instead - - You will need to set the forbiddenFunctions property in your ruleset.xml file -- Removed Squiz.PHP.ForbiddenFunctions from the Squiz standard - - Replaced by using the forbiddenFunctions property of Generic.PHP.ForbiddenFunctions in the Squiz ruleset.xml - - Functionality of the Squiz standard remains the same, but the error codes are now different - - Previously, Squiz.PHP.ForbiddenFunctions.Found and Squiz.PHP.ForbiddenFunctions.FoundWithAlternative - - Now, Generic.PHP.ForbiddenFunctions.Found and Generic.PHP.ForbiddenFunctions.FoundWithAlternative -- Added new Generic.PHP.LowerCaseType sniff - - Ensures PHP types used for type hints, return types, and type casting are lowercase - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added new Generic.WhiteSpace.ArbitraryParenthesesSpacing sniff - - Generates an error for whitespace inside parenthesis that don't belong to a function call/declaration or control structure - - Generates a warning for any empty parenthesis found - - Allows the required spacing to be set using the spacing sniff property (default is 0) - - Allows newlines to be used by setting the ignoreNewlines sniff property (default is false) - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added new PSR12.Classes.ClassInstantiation sniff - - Ensures parenthesis are used when instantiating a new class -- Added new PSR12.Keywords.ShortFormTypeKeywords sniff - - Ensures the short form of PHP types is used when type casting -- Added new PSR12.Namespaces.CompundNamespaceDepth sniff - - Ensures compound namespace use statements have a max depth of 2 levels - - The max depth can be changed by setting the 'maxDepth' sniff property in a ruleset.xml file -- Added new PSR12.Operators.OperatorSpacing sniff - - Ensures operators are preceded and followed by at least 1 space -- Improved core support for grouped property declarations - - Also improves support in Squiz.WhiteSpace.ScopeKeywordSpacing and Squiz.WhiteSpace.MemberVarSpacing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Commenting.DocComment now produces a NonParamGroup error when tags are mixed in with the @param tag group - - It would previously throw either a NonParamGroup or ParamGroup error depending on the order of tags - - This change allows the NonParamGroup error to be suppressed in a ruleset to allow the @param group to contain other tags - - Thanks to [Phil Davis][@phil-davis] for the patch -- Generic.Commenting.DocComment now continues checks param tags even if the doc comment short description is missing - - This change allows the MissingShort error to be suppressed in a ruleset without all other errors being suppressed as well - - Thanks to [Phil Davis][@phil-davis] for the patch -- Generic.CodeAnalysis.AssignmentInCondition now reports a different error code for assignments found in WHILE conditions - - The return value of a function call is often assigned in a WHILE condition, so this change makes it easier to exclude these cases - - The new code for this error message is Generic.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition - - The error code for all other cases remains as Generic.CodeAnalysis.AssignmentInCondition.Found - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Functions.OpeningFunctionBraceBsdAllman now longer leaves trailing whitespace when moving the opening brace during fixing - - Also applies to fixes made by PEAR.Functions.FunctionDeclaration and Squiz.Functions.MultiLineFunctionDeclaration -- Generic.WhiteSpace.ScopeIndent now does a better job of fixing the indent of multi-line comments -- Generic.WhiteSpace.ScopeIndent now does a better job of fixing the indent of PHP open and close tags -- PEAR.Commenting.FunctionComment now report a different error code for param comment lines with too much padding - - Previously, any lines of a param comment that don't start at the exact comment position got the same error code - - Now, only comment lines with too little padding use ParamCommentAlignment as they are clearly mistakes - - Comment lines with too much padding may be using precision alignment as now use ParamCommentAlignmentExceeded - - This allows for excessive padding to be excluded from a ruleset while continuing to enforce a minimum padding -- PEAR.WhiteSpace.ObjectOperatorIndent now checks the indent of more chained operators - - Previously, it only checked chains beginning with a variable - - Now, it checks chains beginning with function calls, static class names, etc -- Squiz.Arrays.ArrayDeclaration now continues checking array formatting even if the key indent is not correct - - Allows for using different array indent rules while still checking/fixing double arrow and value alignment -- Squiz.Commenting.BlockComment has improved support for tab-indented comments - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.BlockComment auto fixing no longer breaks when two block comments follow each other - - Also stopped single-line block comments from being auto fixed when they are embedded in other code - - Also fixed as issue found when PHPCS annotations were used inside a block comment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.BlockComment.LastLineIndent is now able to be fixed with phpcbf - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.BlockComment now aligns star-prefixed lines under the opening tag while fixing, instead of indenting them - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.FunctionComment.IncorrectTypeHint message no longer contains cut-off suggested type hints -- Squiz.Commenting.InlineComment now uses a new error code for inline comments at the end of a function - - Previously, all inline comments followed by a blank line threw a Squiz.Commenting.InlineComment.SpacingAfter error - - Now, inline comments at the end of a function will instead throw Squiz.Commenting.InlineComment.SpacingAfterAtFunctionEnd - - If you previously excluded SpacingAfter, add an exclusion for SpacingAfterAtFunctionEnd to your ruleset as well - - If you previously only included SpacingAfter, consider including SpacingAfterAtFunctionEnd as well - - The Squiz standard now excludes SpacingAfterAtFunctionEnd as the blank line is checked elsewhere - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.ControlStructures.ControlSignature now errors when a comment follows the closing brace of an earlier body - - Applies to catch, finally, else, elseif, and do/while structures - - The included PSR2 standard now enforces this rule - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Formatting.OperatorBracket.MissingBrackets message has been changed to remove the word "arithmetic" - - The sniff checks more than just arithmetic operators, so the message is now clearer -- Sniffs.Operators.ComparisonOperatorUsage now detects more cases of implicit true comparisons - - It could previously be confused by comparisons used as function arguments -- Squiz.PHP.CommentedOutCode now ignores simple @-style annotation comments so they are not flagged as commented out code - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.PHP.CommentedOutCode now ignores a greater number of short comments so they are not flagged as commented out code - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.PHP.DisallowComparisonAssignment no longer errors when using the null coalescing operator - - Given this operator is used almost exclusively to assign values, it didn't make sense to generate an error -- Squiz.WhiteSpacing.FunctionSpacing now has a property to specify how many blank lines should be before the first class method - - Only applies when a method is the first code block in a class (i.e., there are no member vars before it) - - Override the 'spacingBeforeFirst' property in a ruleset.xml file to change - - If not set, the sniff will use whatever value is set for the existing 'spacing' property -- Squiz.WhiteSpacing.FunctionSpacing now has a property to specify how many blank lines should be after the last class method - - Only applies when a method is the last code block in a class (i.e., there are no member vars after it) - - Override the 'spacingAfterLast' property in a ruleset.xml file to change - - If not set, the sniff will use whatever value is set for the existing 'spacing' property - -### Fixed -- Fixed bug [#1863][sq-1863] : File::findEndOfStatement() not working when passed a scope opener -- Fixed bug [#1876][sq-1876] : PSR2.Namespaces.UseDeclaration not giving error for use statements before the namespace declaration - - Adds a new PSR2.Namespaces.UseDeclaration.UseBeforeNamespace error message -- Fixed bug [#1881][sq-1881] : Generic.Arrays.ArrayIndent is indenting sub-arrays incorrectly when comma not used after the last value -- Fixed bug [#1882][sq-1882] : Conditional with missing braces confused by indirect variables -- Fixed bug [#1915][sq-1915] : JS tokenizer fails to tokenize regular expression proceeded by boolean not operator -- Fixed bug [#1920][sq-1920] : Directory exclude pattern improperly excludes files with names that start the same - - Thanks to [Jeff Puckett][@jpuck] for the patch -- Fixed bug [#1922][sq-1922] : Equal sign alignment check broken when list syntax used before assignment operator -- Fixed bug [#1925][sq-1925] : Generic.Formatting.MultipleStatementAlignment skipping assignments within closures -- Fixed bug [#1931][sq-1931] : Generic opening brace placement sniffs do not correctly support function return types -- Fixed bug [#1932][sq-1932] : Generic.ControlStructures.InlineControlStructure fixer moves new PHPCS annotations -- Fixed bug [#1938][sq-1938] : Generic opening brace placement sniffs incorrectly move PHPCS annotations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1939][sq-1939] : phpcs:set annotations do not cause the line they are on to be ignored - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1949][sq-1949] : Squiz.PHP.DisallowMultipleAssignments false positive when using namespaces with static assignments -- Fixed bug [#1959][sq-1959] : SquizMultiLineFunctionDeclaration error when param has trailing comment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1963][sq-1963] : Squiz.Scope.MemberVarScope does not work for multiline member declaration - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1971][sq-1971] : Short array list syntax not correctly tokenized if short array is the first content in a file -- Fixed bug [#1979][sq-1979] : Tokenizer does not change heredoc to nowdoc token if the start tag contains spaces -- Fixed bug [#1982][sq-1982] : Squiz.Arrays.ArrayDeclaration fixer sometimes puts a comma in front of the last array value -- Fixed bug [#1993][sq-1993] : PSR1/PSR2 not reporting or fixing short open tags -- Fixed bug [#1996][sq-1996] : Custom report paths don't work on case-sensitive filesystems -- Fixed bug [#2006][sq-2006] : Squiz.Functions.FunctionDeclarationArgumentSpacing fixer removes comment between parens when no args - - The SpacingAfterOpenHint error message has been removed - - It is replaced by the existing SpacingAfterOpen message - - The error message format for the SpacingAfterOpen and SpacingBeforeClose messages has been changed - - These used to contain 3 pieces of data, but now only contain 2 - - If you have customised the error messages of this sniff, please review your ruleset after upgrading -- Fixed bug [#2018][sq-2018] : Generic.Formatting.MultipleStatementAlignment does see PHP close tag as end of statement block - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#2027][sq-2027] : PEAR.NamingConventions.ValidFunctionName error when function name includes double underscore - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-1863]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1863 -[sq-1876]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1876 -[sq-1881]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1881 -[sq-1882]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1882 -[sq-1915]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1915 -[sq-1920]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1920 -[sq-1922]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1922 -[sq-1925]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1925 -[sq-1931]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1931 -[sq-1932]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1932 -[sq-1938]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1938 -[sq-1939]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1939 -[sq-1949]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1949 -[sq-1959]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1959 -[sq-1963]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1963 -[sq-1971]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1971 -[sq-1979]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1979 -[sq-1982]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1982 -[sq-1993]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1993 -[sq-1996]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1996 -[sq-2006]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2006 -[sq-2018]: https://github.com/squizlabs/PHP_CodeSniffer/pull/2018 -[sq-2027]: https://github.com/squizlabs/PHP_CodeSniffer/issues/2027 - -## [3.2.3] - 2018-02-21 - -### Changed -- The new phpcs: comment syntax can now be prefixed with an at symbol ( @phpcs: ) - - This restores the behaviour of the previous syntax where these comments are ignored by doc generators -- The current PHP version ID is now used to generate cache files - - This ensures that only cache files generated by the current PHP version are selected - - This change fixes caching issues when using sniffs that produce errors based on the current PHP version -- A new Tokens::$phpcsCommentTokens array is now available for sniff developers to detect phpcs: comment syntax - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The PEAR.Commenting.FunctionComment.Missing error message now includes the name of the function - - Thanks to [Yorman Arias][@cixtor] for the patch -- The PEAR.Commenting.ClassComment.Missing and Squiz.Commenting.ClassComment.Missing error messages now include the name of the class - - Thanks to [Yorman Arias][@cixtor] for the patch -- PEAR.Functions.FunctionCallSignature now only forces alignment at a specific tab stop while fixing - - It was enforcing this during checking, but this meant invalid errors if the OpeningIndent message was being muted - - This fixes incorrect errors when using the PSR2 standard with some code blocks -- Generic.Files.LineLength now ignores lines that only contain phpcs: annotation comments - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Formatting.MultipleStatementAlignment now skips over arrays containing comments - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.Syntax now forces display_errors to ON when linting - - Thanks to [Raúl Arellano][@raul338] for the patch -- PSR2.Namespaces.UseDeclaration has improved syntax error handling and closure detection - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.PHP.CommentedOutCode now has improved comment block detection for improved accuracy - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.PHP.NonExecutableCode could fatal error while fixing file with syntax error -- Squiz.PHP.NonExecutableCode now detects unreachable code after a goto statement - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.LanguageConstructSpacing has improved syntax error handling while fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Improved phpcs: annotation syntax handling for a number of sniffs - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Improved auto-fixing of files with incomplete comment blocks for various commenting sniffs - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed test suite compatibility with PHPUnit 7 -- Fixed bug [#1793][sq-1793] : PSR2 forcing exact indent for function call opening statements -- Fixed bug [#1803][sq-1803] : Squiz.WhiteSpace.ScopeKeywordSpacing removes member var name while fixing if no space after scope keyword -- Fixed bug [#1817][sq-1817] : Blank line not enforced after control structure if comment on same line as closing brace -- Fixed bug [#1827][sq-1827] : A phpcs:enable comment is not tokenized correctly if it is outside a phpcs:disable block - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1828][sq-1828] : Squiz.WhiteSpace.SuperfluousWhiteSpace ignoreBlankLines property ignores whitespace after single line comments - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1840][sq-1840] : When a comment has too many asterisks, phpcbf gives FAILED TO FIX error -- Fixed bug [#1867][sq-1867] : Can't use phpcs:ignore where the next line is HTML -- Fixed bug [#1870][sq-1870] : Invalid warning in multiple assignments alignment with closure or anon class -- Fixed bug [#1890][sq-1890] : Incorrect Squiz.WhiteSpace.ControlStructureSpacing.NoLineAfterClose error between catch and finally statements -- Fixed bug [#1891][sq-1891] : Comment on last USE statement causes false positive for PSR2.Namespaces.UseDeclaration.SpaceAfterLastUse - - Thanks to [Matt Coleman][@iammattcoleman], [Daniel Hensby][@dhensby], and [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1901][sq-1901] : Fixed PHPCS annotations in multi-line tab-indented comments + not ignoring whole line for phpcs:set - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-1793]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1793 -[sq-1803]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1803 -[sq-1817]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1817 -[sq-1827]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1827 -[sq-1828]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1828 -[sq-1840]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1840 -[sq-1867]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1867 -[sq-1870]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1870 -[sq-1890]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1890 -[sq-1891]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1891 -[sq-1901]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1901 - -## [3.2.2] - 2017-12-20 - -### Changed -- Disabled STDIN detection on Windows - - This fixes a problem with IDE plugins (e.g., PHPStorm) hanging on Windows - -## [3.2.1] - 2017-12-18 - -### Changed -- Empty diffs are no longer followed by a newline character (request [#1781][sq-1781]) -- Generic.Functions.OpeningFunctionBraceKernighanRitchie no longer complains when the open brace is followed by a close tag - - This makes the sniff more useful when used in templates - - Thanks to [Joseph Zidell][@josephzidell] for the patch - -### Fixed -- Fixed problems with some scripts and plugins waiting for STDIN - - This was a notable problem with IDE plugins (e.g., PHPStorm) and build systems -- Fixed bug [#1782][sq-1782] : Incorrect detection of operator in ternary + anonymous function - -[sq-1781]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1781 -[sq-1782]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1782 - -## [3.2.0] - 2017-12-13 - -### Deprecated -- This release deprecates the @codingStandards comment syntax used for sending commands to PHP_CodeSniffer - - The existing syntax will continue to work in all version 3 releases, but will be removed in version 4 - - The comment formats have been replaced by a shorter syntax: - - @codingStandardsIgnoreFile becomes phpcs:ignoreFile - - @codingStandardsIgnoreStart becomes phpcs:disable - - @codingStandardsIgnoreEnd becomes phpcs:enable - - @codingStandardsIgnoreLine becomes phpcs:ignore - - @codingStandardsChangeSetting becomes phpcs:set - - The new syntax allows for additional developer comments to be added after a -- separator - - This is useful for describing why a code block is being ignored, or why a setting is being changed - - E.g., phpcs:disable -- This code block must be left as-is. - - Comments using the new syntax are assigned new comment token types to allow them to be detected: - - phpcs:ignoreFile has the token T_PHPCS_IGNORE_FILE - - phpcs:disable has the token T_PHPCS_DISABLE - - phpcs:enable has the token T_PHPCS_ENABLE - - phpcs:ignore has the token T_PHPCS_IGNORE - - phpcs:set has the token T_PHPCS_SET - -### Changed -- The phpcs:disable and phpcs:ignore comments can now selectively ignore specific sniffs (request [#604][sq-604]) - - E.g., phpcs:disable Generic.Commenting.Todo.Found for a specific message - - E.g., phpcs:disable Generic.Commenting.Todo for a whole sniff - - E.g., phpcs:disable Generic.Commenting for a whole category of sniffs - - E.g., phpcs:disable Generic for a whole standard - - Multiple sniff codes can be specified by comma separating them - - E.g., phpcs:disable Generic.Commenting.Todo,PSR1.Files -- @codingStandardsIgnoreLine comments now only ignore the following line if they are on a line by themselves - - If they are at the end of an existing line, they will only ignore the line they are on - - Stops some lines from accidentally being ignored - - Same rule applies for the new phpcs:ignore comment syntax -- PSR1.Files.SideEffects now respects the new phpcs:disable comment syntax - - The sniff will no longer check any code that is between phpcs:disable and phpcs:enable comments - - The sniff does not support phpcs:ignore; you must wrap code structures with disable/enable comments - - Previously, there was no way to have this sniff ignore parts of a file -- Fixed a problem where PHPCS would sometimes hang waiting for STDIN, or read incomplete versions of large files - - Thanks to [Arne Jørgensen][@arnested] for the patch -- Array properties specified in ruleset files now have their keys and values trimmed - - This saves having to do this in individual sniffs and stops errors introduced by whitespace in rulesets - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added phpcs.xsd to allow validation of ruleset XML files - - Thanks to [Renaat De Muynck][@renaatdemuynck] for the contribution -- File paths specified using --stdin-path can now point to fake file locations (request [#1488][sq-1488]) - - Previously, STDIN files using fake file paths were excluded from checking -- Setting an empty basepath (--basepath=) on the CLI will now clear a basepath set directly in a ruleset - - Thanks to [Xaver Loppenstedt][@xalopp] for the patch -- Ignore patterns are now checked on symlink target paths instead of symlink source paths - - Restores previous behaviour of this feature -- Metrics were being double counted when multiple sniffs were recording the same metric -- Added support for bash process substitution - - Thanks to [Scott Dutton][@exussum12] for the contribution -- Files included in the cache file code hash are now sorted to aid in cache file reuse across servers -- Windows BAT files can now be used outside a PEAR install - - You must have the path to PHP set in your PATH environment variable - - Thanks to [Joris Debonnet][@JorisDebonnet] for the patch -- The JS unsigned right shift assignment operator is now properly classified as an assignment operator - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The AbstractVariableSniff abstract sniff now supports anonymous classes and nested functions - - Also fixes an issue with Squiz.Scope.MemberVarScope where member vars of anonymous classes were not being checked -- Added AbstractArraySniff to make it easier to create sniffs that check array formatting - - Allows for checking of single and multi line arrays easily - - Provides a parsed structure of the array including positions of keys, values, and double arrows -- Added Generic.Arrays.ArrayIndent to enforce a single tab stop indent for array keys in multi-line arrays - - Also ensures the close brace is on a new line and indented to the same level as the original statement - - Allows for the indent size to be set using an "indent" property of the sniff -- Added Generic.PHP.DiscourageGoto to warn about the use of the GOTO language construct - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Generic.Debug.ClosureLinter was not running the gjslint command - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Generic.WhiteSpace.DisallowSpaceIndent now fixes space indents in multi-line block comments - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.WhiteSpace.DisallowSpaceIndent now fixes mixed space/tab indents more accurately - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.WhiteSpace.DisallowTabIndent now fixes tab indents in multi-line block comments - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PEAR.Functions.FunctionDeclaration no longer errors when a function declaration is the first content in a JS file - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PEAR.Functions.FunctionCallSignature now requires the function name to be indented to an exact tab stop - - If the function name is not the start of the statement, the opening statement must be indented correctly instead - - Added a new fixable error code PEAR.Functions.FunctionCallSignature.OpeningIndent for this error -- Squiz.Functions.FunctionDeclarationArgumentSpacing is no longer confused about comments in function declarations - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.PHP.NonExecutableCode error messages now indicate which line the code block ending is on - - Makes it easier to identify where the code block exited or returned - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.FunctionComment now supports nullable type hints -- Squiz.Commenting.FunctionCommentThrowTag no longer assigns throw tags inside anon classes to the enclosing function -- Squiz.WhiteSpace.SemicolonSpacing now ignores semicolons used for empty statements inside FOR conditions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.ControlStructures.ControlSignature now allows configuring the number of spaces before the colon in alternative syntax - - Override the 'requiredSpacesBeforeColon' setting in a ruleset.xml file to change - - Default remains at 1 - - Thanks to [Nikola Kovacs][@nkovacs] for the patch -- The Squiz standard now ensures array keys are indented 4 spaces from the main statement - - Previously, this standard aligned keys 1 space from the start of the array keyword -- The Squiz standard now ensures array end braces are aligned with the main statement - - Previously, this standard aligned the close brace with the start of the array keyword -- The standard for PHP_CodeSniffer itself now enforces short array syntax -- The standard for PHP_CodeSniffer itself now uses the Generic.Arrays/ArrayIndent sniff rules -- Improved fixer conflicts and syntax error handling for a number of sniffs - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed bug [#1462][sq-1462] : Error processing cyrillic strings in Tokenizer -- Fixed bug [#1573][sq-1573] : Squiz.WhiteSpace.LanguageConstructSpacing does not properly check for tabs and newlines - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#1590][sq-1590] : InlineControlStructure CBF issue while adding braces to an if that's returning a nested function -- Fixed bug [#1718][sq-1718] : Unclosed strings at EOF sometimes tokenized as T_WHITESPACE by the JS tokenizer -- Fixed bug [#1731][sq-1731] : Directory exclusions do not work as expected when a single file name is passed to phpcs -- Fixed bug [#1737][sq-1737] : Squiz.CSS.EmptyStyleDefinition sees comment as style definition and fails to report error -- Fixed bug [#1746][sq-1746] : Very large reports can sometimes become garbled when using the parallel option -- Fixed bug [#1747][sq-1747] : Squiz.Scope.StaticThisUsage incorrectly looking inside closures -- Fixed bug [#1757][sq-1757] : Unknown type hint "object" in Squiz.Commenting.FunctionComment -- Fixed bug [#1758][sq-1758] : PHPCS gets stuck creating file list when processing circular symlinks -- Fixed bug [#1761][sq-1761] : Generic.WhiteSpace.ScopeIndent error on multi-line function call with static closure argument -- Fixed bug [#1762][sq-1762] : `Generic.WhiteSpace.Disallow[Space/Tab]Indent` not inspecting content before open tag - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1769][sq-1769] : Custom "define" function triggers a warning about declaring new symbols -- Fixed bug [#1776][sq-1776] : Squiz.Scope.StaticThisUsage incorrectly looking inside anon classes -- Fixed bug [#1777][sq-1777] : Generic.WhiteSpace.ScopeIndent incorrect indent errors when self called function proceeded by comment - -[sq-604]: https://github.com/squizlabs/PHP_CodeSniffer/issues/604 -[sq-1462]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1462 -[sq-1488]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1488 -[sq-1573]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1573 -[sq-1590]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1590 -[sq-1718]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1718 -[sq-1731]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1731 -[sq-1737]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1737 -[sq-1746]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1746 -[sq-1747]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1747 -[sq-1757]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1757 -[sq-1758]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1758 -[sq-1761]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1761 -[sq-1762]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1762 -[sq-1769]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1769 -[sq-1776]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1776 -[sq-1777]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1777 - -## [3.1.1] - 2017-10-17 - -### Changed -- Restored preference of non-dist files over dist files for phpcs.xml and phpcs.xml.dist - - The order that the files are searched is now: .phpcs.xml, phpcs.xml, .phpcs.xml.dist, phpcs.xml.dist - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Progress output now correctly shows skipped files -- Progress output now shows 100% when the file list has finished processing (request [#1697][sq-1697]) -- Stopped some IDEs complaining about testing class aliases - - Thanks to [Vytautas Stankus][@svycka] for the patch -- Squiz.Commenting.InlineComment incorrectly identified comment blocks in some cases, muting some errors - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -### Fixed -- Fixed bug [#1512][sq-1512] : PEAR.Functions.FunctionCallSignature enforces spaces when no arguments if required spaces is not 0 -- Fixed bug [#1522][sq-1522] : Squiz Arrays.ArrayDeclaration and Strings.ConcatenationSpacing fixers causing parse errors with here/nowdocs -- Fixed bug [#1570][sq-1570] : Squiz.Arrays.ArrayDeclaration fixer removes comments between array keyword and open parentheses -- Fixed bug [#1604][sq-1604] : File::isReference has problems with some bitwise operators and class property references - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1645][sq-1645] : Squiz.Commenting.InlineComment will fail to fix comments at the end of the file - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1656][sq-1656] : Using the --sniffs argument has a problem with case sensitivity -- Fixed bug [#1657][sq-1657] : Uninitialized string offset: 0 when sniffing CSS -- Fixed bug [#1669][sq-1669] : Temporary expression proceeded by curly brace is detected as function call -- Fixed bug [#1681][sq-1681] : Huge arrays are super slow to scan with Squiz.Arrays.ArrayDeclaration sniff -- Fixed bug [#1694][sq-1694] : Squiz.Arrays.ArrayBracketSpacing is removing some comments during fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1702][sq-1702] : Generic.WhiteSpaceDisallowSpaceIndent fixer bug when line only contains superfluous whitespace - -[sq-1512]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1512 -[sq-1522]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1522 -[sq-1570]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1570 -[sq-1604]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1604 -[sq-1645]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1645 -[sq-1656]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1656 -[sq-1657]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1657 -[sq-1669]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1669 -[sq-1681]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1681 -[sq-1694]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1694 -[sq-1697]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1697 -[sq-1702]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1702 - -## [3.1.0] - 2017-09-20 - -### Changed -- This release includes a change to support newer versions of PHPUnit (versions 4, 5, and 6 are now supported) - - The custom PHP_CodeSniffer test runner now requires a bootstrap file - - Developers with custom standards using the PHP_CodeSniffer test runner will need to do one of the following: - - run your unit tests from the PHP_CodeSniffer root dir so the bootstrap file is included - - specify the PHP_CodeSniffer bootstrap file on the command line: `phpunit --bootstrap=/path/to/phpcs/tests/bootstrap.php` - - require the PHP_CodeSniffer bootstrap file from your own bootstrap file - - If you don't run PHP_CodeSniffer unit tests, this change will not affect you - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- A phpcs.xml or phpcs.xml.dist file now takes precedence over the default_standard config setting - - Thanks to [Björn Fischer][@Fischer-Bjoern] for the patch -- Both phpcs.xml and phpcs.xml.dist files can now be prefixed with a dot (request [#1566][sq-1566]) - - The order that the files are searched is: .phpcs.xml, .phpcs.xml.dist, phpcs.xml, phpcs.xml.dist -- The autoloader will now search for files during unit tests runs from the same locations as during normal phpcs runs - - Allows for easier unit testing of custom standards that use helper classes or custom namespaces -- Include patterns for sniffs now use OR logic instead of AND logic - - Previously, a file had to be in each of the include patterns to be processed by a sniff - - Now, a file has to only be in at least one of the patterns - - This change reflects the original intention of the feature -- PHPCS will now follow symlinks under the list of checked directories - - This previously only worked if you specified the path to a symlink on the command line -- Output from --config-show, --config-set, and --config-delete now includes the path to the loaded config file -- PHPCS now cleanly exits if its config file is not readable - - Previously, a combination of PHP notices and PHPCS errors would be generated -- Comment tokens that start with /** are now always tokenized as docblocks - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- The PHP-supplied T_YIELD and T_YIELD_FROM token have been replicated for older PHP versions - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Added new Generic.CodeAnalysis.AssignmentInCondition sniff to warn about variable assignments inside conditions - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the contribution -- Added Generic.Files.OneObjectStructurePerFile sniff to ensure there is a single class/interface/trait per file - - Thanks to [Mponos George][@gmponos] for the contribution -- Function call sniffs now check variable function names and self/static object creation - - Specific sniffs are Generic.Functions.FunctionCallArgumentSpacing, PEAR.Functions.FunctionCallSignature, and PSR2.Methods.FunctionCallSignature - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Generic.Files.LineLength can now be configured to ignore all comment lines, no matter their length - - Set the ignoreComments property to TRUE (default is FALSE) in your ruleset.xml file to enable this - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.LowerCaseKeyword now checks self, parent, yield, yield from, and closure (function) keywords - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- PEAR.Functions.FunctionDeclaration now removes a blank line if it creates one by moving the curly brace during fixing -- Squiz.Commenting.FunctionCommentThrowTag now supports PHP 7.1 multi catch exceptions -- Squiz.Formatting.OperatorBracket no longer throws errors for PHP 7.1 multi catch exceptions -- Squiz.Commenting.LongConditionClosingComment now supports finally statements -- Squiz.Formatting.OperatorBracket now correctly fixes pipe separated flags -- Squiz.Formatting.OperatorBracket now correctly fixes statements containing short array syntax -- Squiz.PHP.EmbeddedPhp now properly fixes cases where the only content in an embedded PHP block is a comment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.ControlStructureSpacing now ignores comments when checking blank lines at the top of control structures -- Squiz.WhiteSpace.ObjectOperatorSpacing now detects and fixes spaces around double colons - - Thanks to [Julius Šmatavičius][@bondas83] for the patch -- Squiz.WhiteSpace.MemberVarSpacing can now be configured to check any number of blank lines between member vars - - Set the spacing property (default is 1) in your ruleset.xml file to set the spacing -- Squiz.WhiteSpace.MemberVarSpacing can now be configured to check a different number of blank lines before the first member var - - Set the spacingBeforeFirst property (default is 1) in your ruleset.xml file to set the spacing -- Added a new PHP_CodeSniffer\Util\Tokens::$ooScopeTokens static member var for quickly checking object scope - - Includes T_CLASS, T_ANON_CLASS, T_INTERFACE, and T_TRAIT - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PHP_CodeSniffer\Files\File::findExtendedClassName() now supports extended interfaces - - Thanks to [Martin Hujer][@mhujer] for the patch - -### Fixed -- Fixed bug [#1550][sq-1550] : Squiz.Commenting.FunctionComment false positive when function contains closure -- Fixed bug [#1577][sq-1577] : Generic.InlineControlStructureSniff breaks with a comment between body and condition in do while loops -- Fixed bug [#1581][sq-1581] : Sniffs not loaded when one-standard directories are being registered in installed_paths -- Fixed bug [#1591][sq-1591] : Autoloader failing to load arbitrary files when installed_paths only set via a custom ruleset -- Fixed bug [#1605][sq-1605] : Squiz.WhiteSpace.OperatorSpacing false positive on unary minus after comment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1615][sq-1615] : Uncaught RuntimeException when phpcbf fails to fix files -- Fixed bug [#1637][sq-1637] : Generic.WhiteSpaceScopeIndent closure argument indenting incorrect with multi-line strings -- Fixed bug [#1638][sq-1638] : Squiz.WhiteSpace.ScopeClosingBrace closure argument indenting incorrect with multi-line strings -- Fixed bug [#1640][sq-1640] : Squiz.Strings.DoubleQuoteUsage replaces tabs with spaces when fixing - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-1550]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1550 -[sq-1566]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1566 -[sq-1577]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1577 -[sq-1581]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1581 -[sq-1591]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1591 -[sq-1605]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1605 -[sq-1615]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1615 -[sq-1637]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1637 -[sq-1638]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1638 -[sq-1640]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1640 - -## [3.0.2] - 2017-07-18 - -### Changed -- The code report now gracefully handles tokenizer exceptions -- The phpcs and phpcbf scripts are now the only places that exit() in the code - - This allows for easier usage of core PHPCS functions from external scripts - - If you are calling Runner::runPHPCS() or Runner::runPHPCBF() directly, you will get back the full range of exit codes - - If not, catch the new DeepExitException to get the error message ($e->getMessage()) and exit code ($e->getCode()); -- NOWDOC tokens are now considered conditions, just as HEREDOC tokens are - - This makes it easier to find the start and end of a NOWDOC from any token within it - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Custom autoloaders are now only included once in case multiple standards are using the same one - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Improved tokenizing of fallthrough CASE and DEFAULT statements that share a closing statement and use curly braces -- Improved the error message when Squiz.ControlStructures.ControlSignature detects a newline after the closing parenthesis - -### Fixed -- Fixed a problem where the source report was not printing the correct number of errors found -- Fixed a problem where the --cache=/path/to/cachefile CLI argument was not working -- Fixed bug [#1465][sq-1465] : Generic.WhiteSpace.ScopeIndent reports incorrect errors when indenting double arrows in short arrays -- Fixed bug [#1478][sq-1478] : Indentation in fallthrough CASE that contains a closure -- Fixed bug [#1497][sq-1497] : Fatal error if composer prepend-autoloader is set to false - - Thanks to [Kunal Mehta][@legoktm] for the patch -- Fixed bug [#1503][sq-1503] : Alternative control structure syntax not always recognized as scoped -- Fixed bug [#1523][sq-1523] : Fatal error when using the --suffix argument - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1526][sq-1526] : Use of basepath setting can stop PHPCBF being able to write fixed files -- Fixed bug [#1530][sq-1530] : Generic.WhiteSpace.ScopeIndent can increase indent too much for lines within code blocks -- Fixed bug [#1547][sq-1547] : Wrong token type for backslash in use function - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#1549][sq-1549] : Squiz.PHP.EmbeddedPhp fixer conflict with // comment before PHP close tag - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1560][sq-1560] : Squiz.Commenting.FunctionComment fatal error when fixing additional param comment lines that have no indent - -[sq-1465]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1465 -[sq-1478]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1478 -[sq-1497]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1497 -[sq-1503]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1503 -[sq-1523]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1523 -[sq-1526]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1526 -[sq-1530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1530 -[sq-1547]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1547 -[sq-1549]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1549 -[sq-1560]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1560 - -## [3.0.1] - 2017-06-14 - -### Security -- This release contains a fix for a security advisory related to the improper handling of a shell command - - A properly crafted filename would allow for arbitrary code execution when using the --filter=gitmodified command line option - - All version 3 users are encouraged to upgrade to this version, especially if you are checking 3rd-party code - - e.g., you run PHPCS over libraries that you did not write - - e.g., you provide a web service that runs PHPCS over user-uploaded files or 3rd-party repositories - - e.g., you allow external tool paths to be set by user-defined values - - If you are unable to upgrade but you check 3rd-party code, ensure you are not using the Git modified filter - - This advisory does not affect PHP_CodeSniffer version 2. - - Thanks to [Sergei Morozov][@morozov] for the report and patch - -### Changed -- Arguments on the command line now override or merge with those specified in a ruleset.xml file in all cases -- PHPCS now stops looking for a phpcs.xml file as soon as one is found, favoring the closest one to the current dir -- Added missing help text for the --stdin-path CLI option to --help -- Re-added missing help text for the --file-list and --bootstrap CLI options to --help -- Runner::runPHPCS() and Runner::runPHPCBF() now return an exit code instead of exiting directly (request [#1484][sq-1484]) -- The Squiz standard now enforces short array syntax by default -- The autoloader is now working correctly with classes created with class_alias() -- The autoloader will now search for files inside all directories in the installed_paths config var - - This allows autoloading of files inside included custom coding standards without manually requiring them -- You can now specify a namespace for a custom coding standard, used by the autoloader to load non-sniff helper files - - Also used by the autoloader to help other standards directly include sniffs for your standard - - Set the value to the namespace prefix you are using for sniff files (everything up to \Sniffs\) - - e.g., if your namespace format is MyProject\CS\Standard\Sniffs\Category set the namespace to MyProject\CS\Standard - - If omitted, the namespace is assumed to be the same as the directory name containing the ruleset.xml file - - The namespace is set in the ruleset tag of the ruleset.xml file - - e.g., ruleset name="My Coding Standard" namespace="MyProject\CS\Standard" -- Rulesets can now specify custom autoloaders using the new autoload tag - - Autoloaders are included while the ruleset is being processed and before any custom sniffs are included - - Allows for very custom autoloading of helper classes well before the boostrap files are included -- The PEAR standard now includes Squiz.Commenting.DocCommentAlignment - - It previously broke comments onto multiple lines, but didn't align them - -### Fixed -- Fixed a problem where excluding a message from a custom standard's own sniff would exclude the whole sniff - - This caused some PSR2 errors to be under-reported -- Fixed bug [#1442][sq-1442] : T_NULLABLE detection not working for nullable parameters and return type hints in some cases -- Fixed bug [#1447][sq-1447] : Running the unit tests with a PHPUnit config file breaks the test suite - - Unknown arguments were not being handled correctly, but are now stored in $config->unknown -- Fixed bug [#1449][sq-1449] : Generic.Classes.OpeningBraceSameLine doesn't detect comment before opening brace - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1450][sq-1450] : Coding standard located under an installed_path with the same directory name throws an error - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1451][sq-1451] : Sniff exclusions/restrictions don't work with custom sniffs unless they use the PHP_CodeSniffer NS -- Fixed bug [#1454][sq-1454] : Squiz.WhiteSpace.OperatorSpacing is not checking spacing on either side of a short ternary operator - - Thanks to [Mponos George][@gmponos] for the patch -- Fixed bug [#1495][sq-1495] : Setting an invalid installed path breaks all commands -- Fixed bug [#1496][sq-1496] : Squiz.Strings.DoubleQuoteUsage not unescaping dollar sign when fixing - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#1501][sq-1501] : Interactive mode is broken -- Fixed bug [#1504][sq-1504] : PSR2.Namespaces.UseDeclaration hangs fixing use statement with no trailing code - -[sq-1447]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1447 -[sq-1449]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1449 -[sq-1450]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1450 -[sq-1451]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1451 -[sq-1454]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1454 -[sq-1484]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1484 -[sq-1495]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1495 -[sq-1496]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1496 -[sq-1501]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1501 -[sq-1504]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1504 - -## [2.9.1] - 2017-05-22 - -### Fixed -- Fixed bug [#1442][sq-1442] : T_NULLABLE detection not working for nullable parameters and return type hints in some cases -- Fixed bug [#1448][sq-1448] : Generic.Classes.OpeningBraceSameLine doesn't detect comment before opening brace - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch - -[sq-1442]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1442 -[sq-1448]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1448 - -## [3.0.0] - 2017-05-04 - -### Changed -- Added an --ignore-annotations command line argument to ignore all @codingStandards annotations in code comments (request [#811][sq-811]) -- This allows you to force errors to be shown that would otherwise be ignored by code comments - - Also stop files being able to change sniff properties midway through processing -- An error is now reported if no sniffs were registered to be run (request [#1129][sq-1129]) -- The autoloader will now search for files inside the directory of any loaded coding standard - - This allows autoloading of any file inside a custom coding standard without manually requiring them - - Ensure your namespace begins with your coding standard's directory name and follows PSR-4 - - e.g., StandardName\Sniffs\CategoryName\AbstractHelper or StandardName\Helpers\StringSniffHelper -- Fixed an error where STDIN was sometimes not checked when using the --parallel CLI option -- The is_closure index has been removed from the return value of File::getMethodProperties() - - This value was always false because T_FUNCTION tokens are never closures - - Closures have a token type of T_CLOSURE -- The File::isAnonymousFunction() method has been removed - - This function always returned false because it only accepted T_FUNCTION tokens, which are never closures - - Closures have a token type of T_CLOSURE -- Includes all changes from the 2.9.0 release - -### Fixed -- Fixed bug [#834][sq-834] : PSR2.ControlStructures.SwitchDeclaration does not handle if branches with returns - - Thanks to [Fabian Wiget][@fabacino] for the patch - -[sq-811]: https://github.com/squizlabs/PHP_CodeSniffer/issues/811 -[sq-834]: https://github.com/squizlabs/PHP_CodeSniffer/issues/834 -[sq-1129]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1129 - -## [3.0.0RC4] - 2017-03-02 - -### Security -- This release contains a fix for a security advisory related to the improper handling of shell commands - - Uses of shell_exec() and exec() were not escaping filenames and configuration settings in most cases - - A properly crafted filename or configuration option would allow for arbitrary code execution when using some features - - All users are encouraged to upgrade to this version, especially if you are checking 3rd-party code - - e.g., you run PHPCS over libraries that you did not write - - e.g., you provide a web service that runs PHPCS over user-uploaded files or 3rd-party repositories - - e.g., you allow external tool paths to be set by user-defined values - - If you are unable to upgrade but you check 3rd-party code, ensure you are not using the following features: - - The diff report - - The notify-send report - - The Generic.PHP.Syntax sniff - - The Generic.Debug.CSSLint sniff - - The Generic.Debug.ClosureLinter sniff - - The Generic.Debug.JSHint sniff - - The Squiz.Debug.JSLint sniff - - The Squiz.Debug.JavaScriptLint sniff - - The Zend.Debug.CodeAnalyzer sniff - - Thanks to [Klaus Purer][@klausi] for the report - -### Changed -- The indent property of PEAR.Classes.ClassDeclaration has been removed - - Instead of calculating the indent of the brace, it just ensures the brace is aligned with the class keyword - - Other sniffs can be used to ensure the class itself is indented correctly -- Invalid exclude rules inside a ruleset.xml file are now ignored instead of potentially causing out of memory errors - - Using the -vv command line argument now also shows the invalid exclude rule as XML -- Includes all changes from the 2.8.1 release - -### Fixed -- Fixed bug [#1333][sq-1333] : The new autoloader breaks some frameworks with custom autoloaders -- Fixed bug [#1334][sq-1334] : Undefined offset when explaining standard with custom sniffs - -[sq-1333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1333 -[sq-1334]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1334 - -## [3.0.0RC3] - 2017-02-02 - -### Changed -- Added support for ES6 class declarations - - Previously, these class were tokenized as JS objects but are now tokenized as normal T_CLASS structures -- Added support for ES6 method declarations, where the "function" keyword is not used - - Previously, these methods were tokenized as JS objects (fixes bug [#1251][sq-1251]) - - The name of the ES6 method is now assigned the T_FUNCTION keyword and treated like a normal function - - Custom sniffs that support JS and listen for T_FUNCTION tokens can't assume the token represents the word "function" - - Check the contents of the token first, or use $phpcsFile->getDeclarationName($stackPtr) if you just want its name - - There is no change for custom sniffs that only check PHP code -- PHPCBF exit codes have been changed so they are now more useful (request [#1270][sq-1270]) - - Exit code 0 is now used to indicate that no fixable errors were found, and so nothing was fixed - - Exit code 1 is now used to indicate that all fixable errors were fixed correctly - - Exit code 2 is now used to indicate that PHPCBF failed to fix some of the fixable errors it found - - Exit code 3 is now used for general script execution errors -- Added PEAR.Commenting.FileComment.ParamCommentAlignment to check alignment of multi-line param comments -- Includes all changes from the 2.8.0 release - -### Fixed -- Fixed an issue where excluding a file using a @codingStandardsIgnoreFile comment would produce errors - - For PHPCS, it would show empty files being processed - - For PHPCBF, it would produce a PHP error -- Fixed bug [#1233][sq-1233] : Can't set config data inside ruleset.xml file -- Fixed bug [#1241][sq-1241] : CodeSniffer.conf not working with 3.x PHAR file - -[sq-1233]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1233 -[sq-1241]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1241 -[sq-1251]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1251 -[sq-1270]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1270 - -## [3.0.0RC2] - 2016-11-30 - -### Changed -- Made the Runner class easier to use with wrapper scripts -- Full usage information is no longer printed when a usage error is encountered (request [#1186][sq-1186]) - - Makes it a lot easier to find and read the error message that was printed -- Includes all changes from the 2.7.1 release - -### Fixed -- Fixed an undefined var name error that could be produced while running PHPCBF -- Fixed bug [#1167][sq-1167] : 3.0.0RC1 PHAR does not work with PEAR standard -- Fixed bug [#1208][sq-1208] : Excluding files doesn't work when using STDIN with a filename specified - -[sq-1167]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1167 -[sq-1186]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1186 -[sq-1208]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1208 - -## [3.0.0RC1] - 2016-09-02 - -### Changed -- Progress output now shows E and W in green when a file has fixable errors or warnings - - Only supported if colors are enabled -- PHPCBF no longer produces verbose output by default (request [#699][sq-699]) - - Use the -v command line argument to show verbose fixing output - - Use the -q command line argument to disable verbose information if enabled by default -- PHPBF now prints a summary report after fixing files - - Report shows files that were fixed, how many errors were fixed, and how many remain -- PHPCBF now supports the -p command line argument to print progress information - - Prints a green F for files where fixes occurred - - Prints a red E for files that could not be fixed due to an error - - Use the -q command line argument to disable progress information if enabled by default -- Running unit tests using --verbose no longer throws errors -- Includes all changes from the 2.7.0 release - -### Fixed -- Fixed shell error appearing on some systems when trying to find executable paths - -[sq-699]: https://github.com/squizlabs/PHP_CodeSniffer/issues/699 - -## [3.0.0a1] - 2016-07-20 - -### Changed -- Min PHP version increased from 5.1.2 to 5.4.0 -- Added optional caching of results between runs (request [#530][sq-530]) - - Enable the cache by using the --cache command line argument - - If you want the cache file written somewhere specific, use --cache=/path/to/cacheFile - - Use the command "phpcs --config-set cache true" to turn caching on by default - - Use the --no-cache command line argument to disable caching if it is being turned on automatically -- Add support for checking file in parallel (request [#421][sq-421]) - - Tell PHPCS how many files to check at once using the --parallel command line argument - - To check 100 files at once, using --parallel=100 - - To disable parallel checking if it is being turned on automatically, use --parallel=1 - - Requires PHP to be compiled with the PCNTL package -- The default encoding has been changed from iso-8859-1 to utf-8 (request [#760][sq-760]) - - The --encoding command line argument still works, but you no longer have to set it to process files as utf-8 - - If encoding is being set to utf-8 in a ruleset or on the CLI, it can be safely removed - - If the iconv PHP extension is not installed, standard non-multibyte aware functions will be used -- Added a new "code" report type to show a code snippet for each error (request [#419][sq-419]) - - The line containing the error is printed, along with 2 lines above and below it to show context - - The location of the errors is underlined in the code snippet if you also use --colors - - Use --report=code to generate this report -- Added support for custom filtering of the file list - - Developers can write their own filter classes to perform custom filtering of the list before the run starts - - Use the command line arg `--filter=/path/to/filter.php` to specify a filter to use - - Extend \PHP_CodeSniffer\Filters\Filter to also support the core PHPCS extension and path filtering - - Extend \PHP_CodeSniffer\Filters\ExactMatch to get the core filtering and the ability to use blacklists and whitelists - - The included \PHP_CodeSniffer\Filters\GitModified filter is a good example of an ExactMatch filter -- Added support for only checking files that have been locally modified or added in a git repo - - Use --filter=gitmodified to check these files - - You still need to give PHPCS a list of files or directories in which to check -- Added automatic discovery of executable paths (request [#571][sq-571]) - - Thanks to [Sergei Morozov][@morozov] for the patch -- You must now pass "-" on the command line to have PHPCS wait for STDIN - - E.g., phpcs --standard=PSR2 - - - You can still pipe content via STDIN as normal as PHPCS will see this and process it - - But without the "-", PHPCS will throw an error if no content or files are passed to it -- All PHP errors generated by sniffs are caught, re-thrown as exceptions, and reported in the standard error reports - - This should stop bugs inside sniffs causing infinite loops - - Also stops invalid reports being produced as errors don't print to the screen directly -- Sniff codes are no longer optional - - If a sniff throws an error or a warning, it must specify an internal code for that message -- The installed_paths config setting can now point directly to a standard - - Previously, it had to always point to the directory in which the standard lives -- Multiple reports can now be specified using the --report command line argument - - Report types are separated by commas - - E.g., --report=full,summary,info - - Previously, you had to use one argument for each report such as --report=full --report=summary --report=info -- You can now set the severity, message type, and exclude patterns for an entire sniff, category, or standard - - Previously, this was only available for a single message -- You can now include a single sniff code in a ruleset instead of having to include an entire sniff - - Including a sniff code will automatically exclude all other messages from that sniff - - If the sniff is already included by an imported standard, set the sniff severity to 0 and include the specific message you want -- PHPCBF no longer uses patch - - Files are now always overwritten - - The --no-patch option has been removed -- Added a --basepath option to strip a directory from the front of file paths in output (request [#470][sq-470]) - - The basepath is absolute or relative to the current directory - - E.g., to output paths relative to current dir in reports, use --basepath=. -- Ignore rules are now checked when using STDIN (request [#733][sq-733]) -- Added an include-pattern tag to rulesets to include a sniff for specific files and folders only (request [#656][sq-656]) - - This is the exact opposite of the exclude-pattern tag - - This option is only usable within sniffs, not globally like exclude-patterns are -- Added a new -m option to stop error messages from being recorded, which saves a lot of memory - - PHPCBF always uses this setting to reduce memory as it never outputs error messages - - Setting the $recordErrors member var inside custom report classes is no longer supported (use -m instead) -- Exit code 2 is now used to indicate fixable errors were found (request [#930][sq-930]) - - Exit code 3 is now used for general script execution errors - - Exit code 1 is used to indicate that coding standard errors were found, but none are fixable - - Exit code 0 is unchanged and continues to mean no coding standard errors found - -### Removed -- The included PHPCS standard has been removed - - All rules are now found inside the phpcs.xml.dist file - - Running "phpcs" without any arguments from a git clone will use this ruleset -- The included SVN pre-commit hook has been removed - - Hooks for version control systems will no longer be maintained within the PHPCS project - -[sq-419]: https://github.com/squizlabs/PHP_CodeSniffer/issues/419 -[sq-421]: https://github.com/squizlabs/PHP_CodeSniffer/issues/421 -[sq-470]: https://github.com/squizlabs/PHP_CodeSniffer/issues/470 -[sq-530]: https://github.com/squizlabs/PHP_CodeSniffer/issues/530 -[sq-571]: https://github.com/squizlabs/PHP_CodeSniffer/pull/571 -[sq-656]: https://github.com/squizlabs/PHP_CodeSniffer/issues/656 -[sq-733]: https://github.com/squizlabs/PHP_CodeSniffer/issues/733 -[sq-760]: https://github.com/squizlabs/PHP_CodeSniffer/issues/760 -[sq-930]: https://github.com/squizlabs/PHP_CodeSniffer/issues/930 - -## [2.9.0] - 2017-05-04 - -### Changed -- Added Generic.Debug.ESLint sniff to run ESLint over JS files and report errors - - Set eslint path using: phpcs --config-set eslint_path /path/to/eslint - - Thanks to [Ryan McCue][@rmccue] for the contribution -- T_POW is now properly considered an arithmetic operator, and will be checked as such - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- T_SPACESHIP and T_COALESCE are now properly considered comparison operators, and will be checked as such - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHP.DisallowShortOpenTag now warns about possible short open tags even when short_open_tag is set to OFF - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.WhiteSpace.DisallowTabIndent now finds and fixes improper use of spaces anywhere inside the line indent - - Previously, only the first part of the indent was used to determine the indent type - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PEAR.Commenting.ClassComment now supports checking of traits as well as classes and interfaces - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.FunctionCommentThrowTag now supports re-throwing exceptions (request [#946][sq-946]) - - Thanks to [Samuel Levy][@samlev] for the patch -- Squiz.PHP.DisallowMultipleAssignments now ignores PHP4-style member var assignments - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.FunctionSpacing now ignores spacing above functions when they are preceded by inline comments - - Stops conflicts between this sniff and comment spacing sniffs -- Squiz.WhiteSpace.OperatorSpacing no longer checks the equal sign in declare statements - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added missing error codes for a couple of sniffs so they can now be customised as normal - -### Fixed -- Fixed bug [#1266][sq-1266] : PEAR.WhiteSpace.ScopeClosingBrace can throw an error while fixing mixed PHP/HTML -- Fixed bug [#1364][sq-1364] : Yield From values are not recognised as returned values in Squiz FunctionComment sniff -- Fixed bug [#1373][sq-1373] : Error in tab expansion results in white-space of incorrect size - - Thanks to [Mark Clements][@MarkMaldaba] for the patch -- Fixed bug [#1381][sq-1381] : Tokenizer: dereferencing incorrectly identified as short array -- Fixed bug [#1387][sq-1387] : Squiz.ControlStructures.ControlSignature does not handle alt syntax when checking space after closing brace -- Fixed bug [#1392][sq-1392] : Scope indent calculated incorrectly when using array destructuring -- Fixed bug [#1394][sq-1394] : integer type hints appearing as TypeHintMissing instead of ScalarTypeHintMissing - - PHP 7 type hints were also being shown when run under PHP 5 in some cases -- Fixed bug [#1405][sq-1405] : Squiz.WhiteSpace.ScopeClosingBrace fails to fix closing brace within indented PHP tags -- Fixed bug [#1421][sq-1421] : Ternaries used in constant scalar expression for param default misidentified by tokenizer -- Fixed bug [#1431][sq-1431] : PHPCBF can't fix short open tags when they are not followed by a space - - Thanks to [Gonçalo Queirós][@ghunti] for the patch -- Fixed bug [#1432][sq-1432] : PHPCBF can make invalid fixes to inline JS control structures that make use of JS objects - -[sq-946]: https://github.com/squizlabs/PHP_CodeSniffer/pull/946 -[sq-1266]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1266 -[sq-1364]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1364 -[sq-1373]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1373 -[sq-1381]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1381 -[sq-1387]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1387 -[sq-1392]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1392 -[sq-1394]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1394 -[sq-1405]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1405 -[sq-1421]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1421 -[sq-1431]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1431 -[sq-1432]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1432 - -## [2.8.1] - 2017-03-02 - -### Security -- This release contains a fix for a security advisory related to the improper handling of shell commands - - Uses of shell_exec() and exec() were not escaping filenames and configuration settings in most cases - - A properly crafted filename or configuration option would allow for arbitrary code execution when using some features - - All users are encouraged to upgrade to this version, especially if you are checking 3rd-party code - - e.g., you run PHPCS over libraries that you did not write - - e.g., you provide a web service that runs PHPCS over user-uploaded files or 3rd-party repositories - - e.g., you allow external tool paths to be set by user-defined values - - If you are unable to upgrade but you check 3rd-party code, ensure you are not using the following features: - - The diff report - - The notify-send report - - The Generic.PHP.Syntax sniff - - The Generic.Debug.CSSLint sniff - - The Generic.Debug.ClosureLinter sniff - - The Generic.Debug.JSHint sniff - - The Squiz.Debug.JSLint sniff - - The Squiz.Debug.JavaScriptLint sniff - - The Zend.Debug.CodeAnalyzer sniff - - Thanks to [Klaus Purer][@klausi] for the report - -### Changed -- The PHP-supplied T_COALESCE_EQUAL token has been replicated for PHP versions before 7.2 -- PEAR.Functions.FunctionDeclaration now reports an error for blank lines found inside a function declaration -- PEAR.Functions.FunctionDeclaration no longer reports indent errors for blank lines in a function declaration -- Squiz.Functions.MultiLineFunctionDeclaration no longer reports errors for blank lines in a function declaration - - It would previously report that only one argument is allowed per line -- Squiz.Commenting.FunctionComment now corrects multi-line param comment padding more accurately -- Squiz.Commenting.FunctionComment now properly fixes pipe-separated param types -- Squiz.Commenting.FunctionComment now works correctly when function return types also contain a comment - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.ControlStructures.InlineIfDeclaration now supports the elvis operator - - As this is not a real PHP operator, it enforces no spaces between ? and : when the THEN statement is empty -- Squiz.ControlStructures.InlineIfDeclaration is now able to fix the spacing errors it reports - -### Fixed -- Fixed bug [#1340][sq-1340] : STDIN file contents not being populated in some cases - - Thanks to [David Biňovec][@david-binda] for the patch -- Fixed bug [#1344][sq-1344] : PEAR.Functions.FunctionCallSignatureSniff throws error for blank comment lines -- Fixed bug [#1347][sq-1347] : PSR2.Methods.FunctionCallSignature strips some comments during fixing - - Thanks to [Algirdas Gurevicius][@uniquexor] for the patch -- Fixed bug [#1349][sq-1349] : Squiz.Strings.DoubleQuoteUsage.NotRequired message is badly formatted when string contains a CR newline char - - Thanks to [Algirdas Gurevicius][@uniquexor] for the patch -- Fixed bug [#1350][sq-1350] : Invalid Squiz.Formatting.OperatorBracket error when using namespaces -- Fixed bug [#1369][sq-1369] : Empty line in multi-line function declaration cause infinite loop - -[sq-1340]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1340 -[sq-1344]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1344 -[sq-1347]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1347 -[sq-1349]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1349 -[sq-1350]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1350 -[sq-1369]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1369 - -## [2.8.0] - 2017-02-02 - -### Changed -- The Internal.NoCodeFound error is no longer generated for content sourced from STDIN - - This should stop some Git hooks generating errors because PHPCS is trying to process the refs passed on STDIN -- Squiz.Commenting.DocCommentAlignment now checks comments on class properties defined using the VAR keyword - - Thanks to [Klaus Purer][@klausi] for the patch -- The getMethodParameters() method now recognises "self" as a valid type hint - - The return array now contains a new "content" index containing the raw content of the param definition - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The getMethodParameters() method now supports nullable types - - The return array now contains a new "nullable_type" index set to true or false for each method param - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The getMethodParameters() method now supports closures - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added more guard code for JS files with syntax errors (request [#1271][sq-1271] and request [#1272][sq-1272]) -- Added more guard code for CSS files with syntax errors (request [#1304][sq-1304]) -- PEAR.Commenting.FunctionComment fixers now correctly handle multi-line param comments -- AbstractVariableSniff now supports anonymous classes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.NamingConventions.ConstructorName and PEAR.NamingConventions.ValidVariable now support anonymous classes -- Generic.NamingConventions.CamelCapsFunctionName and PEAR.NamingConventions.ValidFunctionName now support anonymous classes - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.CodeAnalysis.UnusedFunctionParameter and PEAR.Functions.ValidDefaultValue now support closures - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- PEAR.NamingConventions.ValidClassName and Squiz.Classes.ValidClassName now support traits - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.Functions.FunctionCallArgumentSpacing now supports closures other PHP-provided functions - - Thanks to [Algirdas Gurevicius][@uniquexor] for the patch -- Fixed an error where a nullable type character was detected as an inline then token - - A new T_NULLABLE token has been added to represent the ? nullable type character - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Squiz.WhiteSpace.SemicolonSpacing no longer removes comments while fixing the placement of semicolons - - Thanks to [Algirdas Gurevicius][@uniquexor] for the patch - -### Fixed -- Fixed bug [#1230][sq-1230] : JS tokeniser incorrectly tokenises bitwise shifts as comparison - - Thanks to [Ryan McCue][@rmccue] for the patch -- Fixed bug [#1237][sq-1237] : Uninitialized string offset in PHP Tokenizer on PHP 5.2 -- Fixed bug [#1239][sq-1239] : Warning when static method name is 'default' -- Fixed bug [#1240][sq-1240] : False positive for function names starting with triple underscore - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1245][sq-1245] : SELF is not recognised as T_SELF token in: return new self -- Fixed bug [#1246][sq-1246] : A mix of USE statements with and without braces can cause the tokenizer to mismatch brace tokens - - Thanks to [Michał Bundyra][@michalbundyra] for the patch -- Fixed bug [#1249][sq-1249] : GitBlame report requires a .git directory -- Fixed bug [#1252][sq-1252] : Squiz.Strings.ConcatenationSpacing fix creates syntax error when joining a number to a string -- Fixed bug [#1253][sq-1253] : Generic.ControlStructures.InlineControlStructure fix creates syntax error fixing if-try/catch -- Fixed bug [#1255][sq-1255] : Inconsistent indentation check results when ELSE on new line -- Fixed bug [#1257][sq-1257] : Double dash in CSS class name can lead to "Named colours are forbidden" false positives -- Fixed bug [#1260][sq-1260] : Syntax errors not being shown when error_prepend_string is set - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Fixed bug [#1264][sq-1264] : Array return type hint is sometimes detected as T_ARRAY_HINT instead of T_RETURN_TYPE - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#1265][sq-1265] : ES6 arrow function raises unexpected operator spacing errors -- Fixed bug [#1267][sq-1267] : Fixer incorrectly handles filepaths with repeated dir names - - Thanks to [Sergey Ovchinnikov][@orx0r] for the patch -- Fixed bug [#1276][sq-1276] : Commenting.FunctionComment.InvalidReturnVoid conditional issue with anonymous classes -- Fixed bug [#1277][sq-1277] : Squiz.PHP.DisallowMultipleAssignments.Found error when var assignment is on the same line as an open tag -- Fixed bug [#1284][sq-1284] : Squiz.Arrays.ArrayBracketSpacing.SpaceBeforeBracket false positive match for short list syntax - -[sq-1230]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1230 -[sq-1237]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1237 -[sq-1239]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1239 -[sq-1240]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1240 -[sq-1245]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1245 -[sq-1246]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1246 -[sq-1249]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1249 -[sq-1252]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1252 -[sq-1253]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1253 -[sq-1255]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1255 -[sq-1257]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1257 -[sq-1260]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1260 -[sq-1264]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1264 -[sq-1265]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1265 -[sq-1267]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1267 -[sq-1271]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1271 -[sq-1272]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1272 -[sq-1276]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1276 -[sq-1277]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1277 -[sq-1284]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1284 -[sq-1304]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1304 - -## [2.7.1] - 2016-11-30 - -### Changed -- Squiz.ControlStructures.ControlSignature.SpaceAfterCloseParenthesis fix now removes unnecessary whitespace -- Squiz.Formatting.OperatorBracket no longer errors for negative array indexes used within a function call -- Squiz.PHP.EmbeddedPhp no longer expects a semicolon after statements that are only opening a scope -- Fixed a problem where the content of T_DOC_COMMENT_CLOSE_TAG tokens could sometimes be (boolean) false -- Developers of custom standards with custom test runners can now have their standards ignored by the built-in test runner - - Set the value of an environment variable called PHPCS_IGNORE_TESTS with a comma separated list of your standard names - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- The unit test runner now loads the test sniff outside of the standard's ruleset so that exclude rules do not get applied - - This may have caused problems when testing custom sniffs inside custom standards - - Also makes the unit tests runs a little faster -- The SVN pre-commit hook now works correctly when installed via composer - - Thanks to [Sergey][@sserbin] for the patch - -### Fixed -- Fixed bug [#1135][sq-1135] : PEAR.ControlStructures.MultiLineCondition.CloseBracketNewLine not detected if preceded by multiline function call -- Fixed bug [#1138][sq-1138] : PEAR.ControlStructures.MultiLineCondition.Alignment not detected if closing brace is first token on line -- Fixed bug [#1141][sq-1141] : Sniffs that check EOF newlines don't detect newlines properly when the last token is a doc block -- Fixed bug [#1150][sq-1150] : Squiz.Strings.EchoedStrings does not properly fix bracketed statements -- Fixed bug [#1156][sq-1156] : Generic.Formatting.DisallowMultipleStatements errors when multiple short echo tags are used on the same line - - Thanks to [Nikola Kovacs][@nkovacs] for the patch -- Fixed bug [#1161][sq-1161] : Absolute report path is treated like a relative path if it also exists within the current directory -- Fixed bug [#1170][sq-1170] : Javascript regular expression literal not recognized after comparison operator -- Fixed bug [#1180][sq-1180] : Class constant named FUNCTION is incorrectly tokenized -- Fixed bug [#1181][sq-1181] : Squiz.Operators.IncrementDecrementUsage.NoBrackets false positive when incrementing properties - - Thanks to [Jürgen Henge-Ernst][@hernst42] for the patch -- Fixed bug [#1188][sq-1188] : Generic.WhiteSpace.ScopeIndent issues with inline HTML and multi-line function signatures -- Fixed bug [#1190][sq-1190] : phpcbf on if/else with trailing comment generates erroneous code -- Fixed bug [#1191][sq-1191] : Javascript sniffer fails with function called "Function" -- Fixed bug [#1203][sq-1203] : Inconsistent behavior of PHP_CodeSniffer_File::findEndOfStatement -- Fixed bug [#1218][sq-1218] : CASE conditions using class constants named NAMESPACE/INTERFACE/TRAIT etc are incorrectly tokenized -- Fixed bug [#1221][sq-1221] : Indented function call with multiple closure arguments can cause scope indent error -- Fixed bug [#1224][sq-1224] : PHPCBF fails to fix code with heredoc/nowdoc as first argument to a function - -[sq-1135]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1135 -[sq-1138]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1138 -[sq-1141]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1141 -[sq-1150]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1150 -[sq-1156]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1156 -[sq-1161]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1161 -[sq-1170]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1170 -[sq-1180]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1180 -[sq-1181]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1181 -[sq-1188]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1188 -[sq-1190]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1190 -[sq-1191]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1191 -[sq-1203]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1203 -[sq-1218]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1218 -[sq-1221]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1221 -[sq-1224]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1224 - -## [2.7.0] - 2016-09-02 - -### Changed -- Added --file-list command line argument to allow a list of files and directories to be specified in an external file - - Useful if you have a generated list of files to check that would be too long for the command line - - File and directory paths are listed one per line - - Usage is: phpcs --file-list=/path/to/file-list ... - - Thanks to [Blotzu][@andrei-propertyguru] for the patch -- Values set using @codingStandardsChangeSetting comments can now contain spaces -- Sniff unit tests can now specify a list of test files instead of letting the runner pick them (request [#1078][sq-1078]) - - Useful if a sniff needs to exclude files based on the environment, or is checking filenames - - Override the new getTestFiles() method to specify your own list of test files -- Generic.Functions.OpeningFunctionBraceKernighanRitchie now ignores spacing for function return types - - The sniff code Generic.Functions.OpeningFunctionBraceKernighanRitchie.SpaceAfterBracket has been removed - - Replaced by Generic.Functions.OpeningFunctionBraceKernighanRitchie.SpaceBeforeBrace - - The new error message is slightly clearer as it indicates that a single space is needed before the brace -- Squiz.Commenting.LongConditionClosingComment now allows for the length of a code block to be configured - - Set the lineLimit property (default is 20) in your ruleset.xml file to set the code block length - - When the code block length is reached, the sniff will enforce a closing comment after the closing brace - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.Commenting.LongConditionClosingComment now allows for the end comment format to be configured - - Set the commentFormat property (default is "//end %s") in your ruleset.xml file to set the format - - The placeholder %s will be replaced with the type of condition opener, e.g., "//end foreach" - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Generic.PHPForbiddenFunctions now allows forbidden functions to have mixed case - - Previously, it would only do a strtolower comparison - - Error message now shows what case was found in the code and what the correct case should be - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added Generic.Classes.OpeningBraceSameLine to ensure opening brace of class/interface/trait is on the same line as the declaration - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added Generic.PHP.BacktickOperator to ban the use of the backtick operator for running shell commands - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Added Generic.PHP.DisallowAlternativePHPTags to ban the use of alternate PHP tags - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Squiz.WhiteSpace.LanguageConstructSpacing no longer checks for spaces if parenthesis are being used (request [#1062][sq-1062]) - - Makes this sniff more compatible with those that check parenthesis spacing of function calls -- Squiz.WhiteSpace.ObjectOperatorSpacing now has a setting to ignore newline characters around object operators - - Default remains FALSE, so newlines are not allowed - - Override the "ignoreNewlines" setting in a ruleset.xml file to change - - Thanks to [Alex Howansky][@AlexHowansky] for the patch -- Squiz.Scope.MethodScope now sniffs traits as well as classes and interfaces - - Thanks to [Jesse Donat][@donatj] for the patch -- PHPCBF is now able to fix Squiz.SelfMemberReference.IncorrectCase errors - - Thanks to [Nikola Kovacs][@nkovacs] for the patch -- PHPCBF is now able to fix Squiz.Commenting.VariableComment.IncorrectVarType - - Thanks to [Walt Sorensen][@photodude] for the patch -- PHPCBF is now able to fix Generic.PHP.DisallowShortOpenTag - - Thanks to [Juliette Reinders Folmer][@jrfnl] for the patch -- Improved the formatting of the end brace when auto fixing InlineControlStructure errors (request [#1121][sq-1121]) -- Generic.Functions.OpeningFunctionBraceKernighanRitchie.BraceOnNewLine fix no longer leaves blank line after brace (request [#1085][sq-1085]) -- Generic UpperCaseConstantNameSniff now allows lowercase namespaces in constant definitions - - Thanks to [Daniel Schniepp][@dschniepp] for the patch -- Squiz DoubleQuoteUsageSniff is now more tolerant of syntax errors caused by mismatched string tokens -- A few sniffs that produce errors based on the current PHP version can now be told to run using a specific PHP version - - Set the `php_version` config var using `--config-set`, `--runtime-set`, or in a ruleset to specify a specific PHP version - - The format of the PHP version is the same as the `PHP_VERSION_ID` constant (e.g., 50403 for version 5.4.3) - - Supported sniffs are Generic.PHP.DisallowAlternativePHPTags, PSR1.Classes.ClassDeclaration, Squiz.Commenting.FunctionComment - - Thanks to [Finlay Beaton][@ofbeaton] for the patch - -### Fixed -- Fixed bug [#985][sq-985] : Duplicate class definition detection generates false-positives in media queries - - Thanks to [Raphael Horber][@rhorber] for the patch -- Fixed bug [#1014][sq-1014] : Squiz VariableCommentSniff doesn't always detect a missing comment -- Fixed bug [#1066][sq-1066] : Undefined index: quiet in `CLI.php` during unit test run with `-v` command line arg -- Fixed bug [#1072][sq-1072] : Squiz.SelfMemberReference.NotUsed not detected if leading namespace separator is used -- Fixed bug [#1089][sq-1089] : Rulesets cannot be loaded if the path contains urlencoded characters -- Fixed bug [#1091][sq-1091] : PEAR and Squiz FunctionComment sniffs throw errors for some invalid @param line formats -- Fixed bug [#1092][sq-1092] : PEAR.Functions.ValidDefaultValue should not flag type hinted methods with a NULL default argument -- Fixed bug [#1095][sq-1095] : Generic LineEndings sniff replaces tabs with spaces with --tab-width is set -- Fixed bug [#1096][sq-1096] : Squiz FunctionDeclarationArgumentSpacing gives incorrect error/fix when variadic operator is followed by a space -- Fixed bug [#1099][sq-1099] : Group use declarations are incorrectly fixed by the PSR2 standard - - Thanks to [Jason McCreary][@jasonmccreary] for the patch -- Fixed bug [#1101][sq-1101] : Incorrect indent errors when breaking out of PHP inside an IF statement -- Fixed bug [#1102][sq-1102] : Squiz.Formatting.OperatorBracket.MissingBrackets faulty bracketing fix -- Fixed bug [#1109][sq-1109] : Wrong scope indent reported in anonymous class -- Fixed bug [#1112][sq-1112] : File docblock not recognized when require_once follows it -- Fixed bug [#1120][sq-1120] : InlineControlStructureSniff does not handle auto-fixing for control structures that make function calls -- Fixed bug [#1124][sq-1124] : Squiz.Operators.ComparisonOperatorUsage does not detect bracketed conditions for inline IF statements - - Thanks to [Raphael Horber][@rhorber] for the patch - -[sq-985]: https://github.com/squizlabs/PHP_CodeSniffer/issues/985 -[sq-1014]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1014 -[sq-1062]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1062 -[sq-1066]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1066 -[sq-1072]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1072 -[sq-1078]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1078 -[sq-1085]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1085 -[sq-1089]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1089 -[sq-1091]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1091 -[sq-1092]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1092 -[sq-1095]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1095 -[sq-1096]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1096 -[sq-1099]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1099 -[sq-1101]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1101 -[sq-1102]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1102 -[sq-1109]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1109 -[sq-1112]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1112 -[sq-1120]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1120 -[sq-1121]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1121 -[sq-1124]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1124 - -## [2.6.2] - 2016-07-14 - -### Changed -- Added a new --exclude CLI argument to exclude a list of sniffs from checking and fixing (request [#904][sq-904]) - - Accepts the same sniff codes as the --sniffs command line argument, but provides the opposite functionality -- Added a new -q command line argument to disable progress and verbose information from being printed (request [#969][sq-969]) - - Useful if a coding standard hard-codes progress or verbose output but you want PHPCS to be quiet - - Use the command "phpcs --config-set quiet true" to turn quiet mode on by default -- Generic LineLength sniff no longer errors for comments that cannot be broken out onto a new line (request [#766][sq-766]) - - A typical case is a comment that contains a very long URL - - The comment is ignored if putting the URL on an indented new comment line would be longer than the allowed length -- Settings extensions in a ruleset no longer causes PHP notices during unit testing - - Thanks to [Klaus Purer][@klausi] for the patch -- Version control reports now show which errors are fixable if you are showing sources -- Added a new sniff to enforce a single space after a NOT operator (request [#1051][sq-1051]) - - Include in a ruleset using the code Generic.Formatting.SpaceAfterNot -- The Squiz.Commenting.BlockComment sniff now supports tabs for indenting comment lines (request [#1056][sq-1056]) - -### Fixed -- Fixed bug [#790][sq-790] : Incorrect missing @throws error in methods that use closures -- Fixed bug [#908][sq-908] : PSR2 standard is not checking that closing brace is on line following the body -- Fixed bug [#945][sq-945] : Incorrect indent behavior using deep-nested function and arrays -- Fixed bug [#961][sq-961] : Two anonymous functions passed as function/method arguments cause indentation false positive -- Fixed bug [#1005][sq-1005] : Using global composer vendor autoload breaks PHP lowercase built-in function sniff - - Thanks to [Michael Butler][@michaelbutler] for the patch -- Fixed bug [#1007][sq-1007] : Squiz Unreachable code detection is not working properly with a closure inside a case -- Fixed bug [#1023][sq-1023] : PSR2.Classes.ClassDeclaration fails if class extends base class and "implements" is on trailing line -- Fixed bug [#1026][sq-1026] : Arrays in comma delimited class properties cause ScopeIndent to increase indent -- Fixed bug [#1028][sq-1028] : Squiz ArrayDeclaration incorrectly fixes multi-line array where end bracket is not on a new line -- Fixed bug [#1034][sq-1034] : Squiz FunctionDeclarationArgumentSpacing gives incorrect error when first arg is a variadic -- Fixed bug [#1036][sq-1036] : Adjacent assignments aligned analysis statement wrong -- Fixed bug [#1049][sq-1049] : Version control reports can show notices when the report width is very small -- Fixed bug [#21050][pear-21050] : PEAR MultiLineCondition sniff suppresses errors on last condition line - -[sq-766]: https://github.com/squizlabs/PHP_CodeSniffer/issues/766 -[sq-790]: https://github.com/squizlabs/PHP_CodeSniffer/issues/790 -[sq-904]: https://github.com/squizlabs/PHP_CodeSniffer/issues/904 -[sq-908]: https://github.com/squizlabs/PHP_CodeSniffer/issues/908 -[sq-945]: https://github.com/squizlabs/PHP_CodeSniffer/issues/945 -[sq-961]: https://github.com/squizlabs/PHP_CodeSniffer/issues/961 -[sq-969]: https://github.com/squizlabs/PHP_CodeSniffer/issues/969 -[sq-1005]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1005 -[sq-1007]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1007 -[sq-1023]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1023 -[sq-1026]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1026 -[sq-1028]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1028 -[sq-1034]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1034 -[sq-1036]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1036 -[sq-1049]: https://github.com/squizlabs/PHP_CodeSniffer/pull/1049 -[sq-1051]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1051 -[sq-1056]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1056 -[pear-21050]: https://pear.php.net/bugs/bug.php?id=21050 - -## [2.6.1] - 2016-05-31 - -### Changed -- The PHP-supplied T_COALESCE token has been replicated for PHP versions before 7.0 -- Function return types of self, parent and callable are now tokenized as T_RETURN_TYPE - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- The default_standard config setting now allows multiple standards to be listed, like on the command line - - Thanks to [Michael Mayer][@schnittstabil] for the patch -- Installations done via composer now only include the composer autoloader for PHP 5.3.2+ (request [#942][sq-942]) -- Added a rollbackChangeset() method to the Fixer class to purposely rollback the active changeset - -### Fixed -- Fixed bug [#940][sq-940] : Auto-fixing issue encountered with inconsistent use of braces -- Fixed bug [#943][sq-943] : Squiz.PHP.InnerFunctions.NotAllowed reported in anonymous classes -- Fixed bug [#944][sq-944] : PHP warning when running the latest phar -- Fixed bug [#951][sq-951] : InlineIfDeclaration: invalid error produced with UTF-8 string -- Fixed bug [#957][sq-957] : Operator spacing sniff errors when plus is used as part of a number - - Thanks to [Klaus Purer][@klausi] for the patch -- Fixed bug [#959][sq-959] : Call-time pass-by-reference false positive if there is a square bracket before the ampersand - - Thanks to [Konstantin Leboev][@realmfoo] for the patch -- Fixed bug [#962][sq-962] : Null coalescing operator (??) not detected as a token - - Thanks to [Joel Posti][@joelposti] for the patch -- Fixed bug [#973][sq-973] : Anonymous class declaration and PSR1.Files.SideEffects.FoundWithSymbols -- Fixed bug [#974][sq-974] : Error when file ends with "function" -- Fixed bug [#979][sq-979] : Anonymous function with return type hint is not refactored as expected -- Fixed bug [#983][sq-983] : Squiz.WhiteSpace.MemberVarSpacing.AfterComment fails to fix error when comment is not a docblock -- Fixed bug [#1010][sq-1010] : Squiz NonExecutableCode sniff does not detect boolean OR - - Thanks to [Derek Henderson][@2shediac] for the patch -- Fixed bug [#1015][sq-1015] : The Squiz.Commenting.FunctionComment sniff doesn't allow description in @return tag - - Thanks to [Alexander Obuhovich][@aik099] for the patch -- Fixed bug [#1022][sq-1022] : Duplicate spaces after opening bracket error with PSR2 standard -- Fixed bug [#1025][sq-1025] : Syntax error in JS file can cause undefined index for parenthesis_closer - -[sq-940]: https://github.com/squizlabs/PHP_CodeSniffer/issues/940 -[sq-942]: https://github.com/squizlabs/PHP_CodeSniffer/issues/942 -[sq-943]: https://github.com/squizlabs/PHP_CodeSniffer/issues/943 -[sq-944]: https://github.com/squizlabs/PHP_CodeSniffer/issues/944 -[sq-951]: https://github.com/squizlabs/PHP_CodeSniffer/issues/951 -[sq-957]: https://github.com/squizlabs/PHP_CodeSniffer/pull/957 -[sq-959]: https://github.com/squizlabs/PHP_CodeSniffer/issues/959 -[sq-962]: https://github.com/squizlabs/PHP_CodeSniffer/issues/962 -[sq-973]: https://github.com/squizlabs/PHP_CodeSniffer/issues/973 -[sq-974]: https://github.com/squizlabs/PHP_CodeSniffer/issues/974 -[sq-979]: https://github.com/squizlabs/PHP_CodeSniffer/issues/979 -[sq-983]: https://github.com/squizlabs/PHP_CodeSniffer/issues/983 -[sq-1010]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1010 -[sq-1015]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1015 -[sq-1022]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1022 -[sq-1025]: https://github.com/squizlabs/PHP_CodeSniffer/issues/1025 - -## [2.6.0] - 2016-04-04 - -### Changed -- Paths used when setting CLI arguments inside ruleset.xml files are now relative to the ruleset location (request [#847][sq-847]) - - This change only applies to paths within ARG tags, used to set CLI arguments - - Previously, the paths were relative to the directory PHPCS was being run from - - Absolute paths are still allowed and work the same way they always have - - This change allows ruleset.xml files to be more portable -- Content passed via STDIN will now be processed even if files are specified on the command line or in a ruleset -- When passing content via STDIN, you can now specify the file path to use on the command line (request [#934][sq-934]) - - This allows sniffs that check file paths to work correctly - - This is the same functionality provided by the phpcs_input_file line, except it is available on the command line -- Files processed with custom tokenizers will no longer be skipped if they appear minified (request [#877][sq-877]) - - If the custom tokenizer wants minified files skipped, it can set a $skipMinified member var to TRUE - - See the included JS and CSS tokenizers for an example -- Config vars set in ruleset.xml files are now processed earlier, allowing them to be used during sniff registration - - Among other things, this allows the installed_paths config var to be set in ruleset.xml files - - Thanks to [Pieter Frenssen][@pfrenssen] for the patch -- Improved detection of regular expressions in the JS tokenizer -- Generic PHP Syntax sniff now uses PHP_BINARY (if available) to determine the path to PHP if no other path is available - - You can still manually set `php_path` to use a specific binary for testing - - Thanks to [Andrew Berry][@deviantintegral] for the patch -- The PHP-supplied T_POW_EQUAL token has been replicated for PHP versions before 5.6 -- Added support for PHP7 use group declarations (request [#878][sq-878]) - - New tokens T_OPEN_USE_GROUP and T_CLOSE_USE_GROUP are assigned to the open and close curly braces -- Generic ScopeIndent sniff now reports errors for every line that needs the indent changed (request [#903][sq-903]) - - Previously, it ignored lines that were indented correctly in the context of their block - - This change produces more technically accurate error messages, but is much more verbose -- The PSR2 and Squiz standards now allow multi-line default values in function declarations (request [#542][sq-542]) - - Previously, these would automatically make the function a multi-line declaration -- Squiz InlineCommentSniff now allows docblocks on require(_once) and include(_once) statements - - Thanks to [Gary Jones][@GaryJones] for the patch -- Squiz and PEAR Class and File sniffs no longer assume the first comment in a file is always a file comment - - phpDocumentor assigns the comment to the file only if it is not followed by a structural element - - These sniffs now follow this same rule -- Squiz ClassCommentSniff no longer checks for blank lines before class comments - - Removes the error Squiz.Commenting.ClassComment.SpaceBefore -- Renamed Squiz.CSS.Opacity.SpacingAfterPoint to Squiz.CSS.Opacity.DecimalPrecision - - Please update your ruleset if you are referencing this error code directly -- Fixed PHP tokenizer problem that caused an infinite loop when checking a comment with specific content -- Generic Disallow Space and Tab indent sniffs now detect and fix indents inside embedded HTML chunks (request [#882][sq-882]) -- Squiz CSS IndentationSniff no longer assumes the class opening brace is at the end of a line -- Squiz FunctionCommentThrowTagSniff now ignores non-docblock comments -- Squiz ComparisonOperatorUsageSniff now allows conditions like while(true) -- PEAR FunctionCallSignatureSniff (and the Squiz and PSR2 sniffs that use it) now correctly check the first argument - - Further fix for bug [#698][sq-698] - -### Fixed -- Fixed bug [#791][sq-791] : codingStandardsChangeSetting settings not working with namespaces -- Fixed bug [#872][sq-872] : Incorrect detection of blank lines between CSS class names -- Fixed bug [#879][sq-879] : Generic InlineControlStructureSniff can create parse error when case/if/elseif/else have mixed brace and braceless definitions -- Fixed bug [#883][sq-883] : PSR2 is not checking for blank lines at the start and end of control structures -- Fixed bug [#884][sq-884] : Incorrect indentation notice for anonymous classes -- Fixed bug [#887][sq-887] : Using curly braces for a shared CASE/DEFAULT statement can generate an error in PSR2 SwitchDeclaration -- Fixed bug [#889][sq-889] : Closure inside catch/else/elseif causes indentation error -- Fixed bug [#890][sq-890] : Function call inside returned short array value can cause indentation error inside CASE statements -- Fixed bug [#897][sq-897] : Generic.Functions.CallTimePassByReference.NotAllowed false positive when short array syntax -- Fixed bug [#900][sq-900] : Squiz.Functions.FunctionDeclarationArgumentSpacing bug when no space between type hint and argument -- Fixed bug [#902][sq-902] : T_OR_EQUAL and T_POW_EQUAL are not seen as assignment tokens -- Fixed bug [#910][sq-910] : Unrecognized "extends" and indentation on anonymous classes -- Fixed bug [#915][sq-915] : JS Tokenizer generates errors when processing some decimals -- Fixed bug [#928][sq-928] : Endless loop when sniffing a PHP file with a git merge conflict inside a function -- Fixed bug [#937][sq-937] : Shebang can cause PSR1 SideEffects warning - - Thanks to [Clay Loveless][@claylo] for the patch -- Fixed bug [#938][sq-938] : CallTimePassByReferenceSniff ignores functions with return value - -[sq-542]: https://github.com/squizlabs/PHP_CodeSniffer/issues/542 -[sq-791]: https://github.com/squizlabs/PHP_CodeSniffer/issues/791 -[sq-847]: https://github.com/squizlabs/PHP_CodeSniffer/issues/847 -[sq-872]: https://github.com/squizlabs/PHP_CodeSniffer/issues/872 -[sq-877]: https://github.com/squizlabs/PHP_CodeSniffer/issues/877 -[sq-878]: https://github.com/squizlabs/PHP_CodeSniffer/issues/878 -[sq-879]: https://github.com/squizlabs/PHP_CodeSniffer/issues/879 -[sq-882]: https://github.com/squizlabs/PHP_CodeSniffer/issues/882 -[sq-883]: https://github.com/squizlabs/PHP_CodeSniffer/issues/883 -[sq-884]: https://github.com/squizlabs/PHP_CodeSniffer/issues/884 -[sq-887]: https://github.com/squizlabs/PHP_CodeSniffer/issues/887 -[sq-889]: https://github.com/squizlabs/PHP_CodeSniffer/issues/889 -[sq-890]: https://github.com/squizlabs/PHP_CodeSniffer/issues/890 -[sq-897]: https://github.com/squizlabs/PHP_CodeSniffer/issues/897 -[sq-900]: https://github.com/squizlabs/PHP_CodeSniffer/issues/900 -[sq-902]: https://github.com/squizlabs/PHP_CodeSniffer/issues/902 -[sq-903]: https://github.com/squizlabs/PHP_CodeSniffer/issues/903 -[sq-910]: https://github.com/squizlabs/PHP_CodeSniffer/issues/910 -[sq-915]: https://github.com/squizlabs/PHP_CodeSniffer/issues/915 -[sq-928]: https://github.com/squizlabs/PHP_CodeSniffer/issues/928 -[sq-934]: https://github.com/squizlabs/PHP_CodeSniffer/issues/934 -[sq-937]: https://github.com/squizlabs/PHP_CodeSniffer/pull/937 -[sq-938]: https://github.com/squizlabs/PHP_CodeSniffer/issues/938 - -## [2.5.1] - 2016-01-20 - -### Changed -- The PHP-supplied T_SPACESHIP token has been replicated for PHP versions before 7.0 -- T_SPACESHIP is now correctly identified as an operator - - Thanks to [Alexander Obuhovich][@aik099] for the patch -- Generic LowerCaseKeyword now ensures array type hints are lowercase as well - - Thanks to [Mathieu Rochette][@mathroc] for the patch -- Squiz ComparisonOperatorUsageSniff no longer hangs on JS FOR loops that don't use semicolons -- PHP_CodesSniffer now includes the composer `autoload.php` file, if there is one - - Thanks to [Klaus Purer][@klausi] for the patch -- Added error Squiz.Commenting.FunctionComment.ScalarTypeHintMissing for PHP7 only (request [#858][sq-858]) - - These errors were previously reported as Squiz.Commenting.FunctionComment.TypeHintMissing on PHP7 - - Disable this error message in a ruleset.xml file if your code needs to run on both PHP5 and PHP7 -- The PHP 5.6 __debugInfo magic method no longer produces naming convention errors - - Thanks to [Michael Nowack][@syranez] for the patch -- PEAR and Squiz FunctionComment sniffs now support variadic functions (request [#841][sq-841]) - -### Fixed -- Fixed bug [#622][sq-622] : Wrong detection of Squiz.CSS.DuplicateStyleDefinition with media queries -- Fixed bug [#752][sq-752] : The missing exception error is reported in first found DocBlock -- Fixed bug [#794][sq-794] : PSR2 MultiLineFunctionDeclaration forbids comments after opening parenthesis of a multiline call -- Fixed bug [#820][sq-820] : PEAR/PSR2 FunctionCallSignature sniffs suggest wrong indent when there are multiple arguments on a line -- Fixed bug [#822][sq-822] : Ruleset hard-coded file paths are not used if not running from the same directory as the ruleset -- Fixed bug [#825][sq-825] : FunctionCallArgumentSpacing sniff complains about more than one space before comment in multi-line function call -- Fixed bug [#828][sq-828] : Null classname is tokenized as T_NULL instead of T_STRING -- Fixed bug [#829][sq-829] : Short array argument not fixed correctly when multiple function arguments are on the same line -- Fixed bug [#831][sq-831] : PHPCS freezes in an infinite loop under Windows if no standard is passed -- Fixed bug [#832][sq-832] : Tokenizer does not support context sensitive parsing - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#835][sq-835] : PEAR.Functions.FunctionCallSignature broken when closure uses return types -- Fixed bug [#838][sq-838] : CSS indentation fixer changes color codes - - Thanks to [Klaus Purer][@klausi] for the patch -- Fixed bug [#839][sq-839] : "__()" method is marked as not camel caps - - Thanks to [Tim Bezhashvyly][@tim-bezhashvyly] for the patch -- Fixed bug [#852][sq-852] : Generic.Commenting.DocComment not finding errors when long description is omitted -- Fixed bug [#854][sq-854] : Return typehints in interfaces are not reported as T_RETURN_TYPE - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#855][sq-855] : Capital letter detection for multibyte strings doesn't work correctly -- Fixed bug [#857][sq-857] : PSR2.ControlStructure.SwitchDeclaration shouldn't check indent of curly brace closers -- Fixed bug [#859][sq-859] : Switch statement indention issue when returning function call with closure -- Fixed bug [#861][sq-861] : Single-line arrays and function calls can generate incorrect indentation errors -- Fixed bug [#867][sq-867] : Squiz.Strings.DoubleQuoteUsage broken for some escape codes - - Thanks to [Jack Blower][@ElvenSpellmaker] for the help with the fix -- Fixed bug [#21005][pear-21005] : Incorrect indent detection when multiple properties are initialized to arrays -- Fixed bug [#21010][pear-21010] : Incorrect missing colon detection in CSS when first style is not on new line -- Fixed bug [#21011][pear-21011] : Incorrect error message text when newline found after opening brace - -[sq-622]: https://github.com/squizlabs/PHP_CodeSniffer/issues/622 -[sq-752]: https://github.com/squizlabs/PHP_CodeSniffer/issues/752 -[sq-794]: https://github.com/squizlabs/PHP_CodeSniffer/issues/794 -[sq-820]: https://github.com/squizlabs/PHP_CodeSniffer/issues/820 -[sq-822]: https://github.com/squizlabs/PHP_CodeSniffer/issues/822 -[sq-825]: https://github.com/squizlabs/PHP_CodeSniffer/issues/825 -[sq-828]: https://github.com/squizlabs/PHP_CodeSniffer/issues/828 -[sq-829]: https://github.com/squizlabs/PHP_CodeSniffer/issues/829 -[sq-831]: https://github.com/squizlabs/PHP_CodeSniffer/issues/831 -[sq-832]: https://github.com/squizlabs/PHP_CodeSniffer/issues/832 -[sq-835]: https://github.com/squizlabs/PHP_CodeSniffer/issues/835 -[sq-838]: https://github.com/squizlabs/PHP_CodeSniffer/pull/838 -[sq-839]: https://github.com/squizlabs/PHP_CodeSniffer/issues/839 -[sq-841]: https://github.com/squizlabs/PHP_CodeSniffer/issues/841 -[sq-852]: https://github.com/squizlabs/PHP_CodeSniffer/issues/852 -[sq-854]: https://github.com/squizlabs/PHP_CodeSniffer/issues/854 -[sq-855]: https://github.com/squizlabs/PHP_CodeSniffer/pull/855 -[sq-857]: https://github.com/squizlabs/PHP_CodeSniffer/issues/857 -[sq-858]: https://github.com/squizlabs/PHP_CodeSniffer/issues/858 -[sq-859]: https://github.com/squizlabs/PHP_CodeSniffer/issues/859 -[sq-861]: https://github.com/squizlabs/PHP_CodeSniffer/issues/861 -[sq-867]: https://github.com/squizlabs/PHP_CodeSniffer/issues/867 -[pear-21005]: https://pear.php.net/bugs/bug.php?id=21005 -[pear-21010]: https://pear.php.net/bugs/bug.php?id=21010 -[pear-21011]: https://pear.php.net/bugs/bug.php?id=21011 - -## [2.5.0] - 2015-12-11 - -### Changed -- PHPCS will now look for a phpcs.xml file in parent directories as well as the current directory (request [#626][sq-626]) -- PHPCS will now use a phpcs.xml file even if files are specified on the command line - - This file is still only used if no standard is specified on the command line -- Added support for a phpcs.xml.dist file (request [#583][sq-583]) - - If both a phpcs.xml and phpcs.xml.dist file are present, the phpcs.xml file will be used -- Added support for setting PHP ini values in ruleset.xml files (request [#560][sq-560]) - - Setting the value of the new ini tags to name="memory_limit" value="32M" is the same as -d memory_limit=32M -- Added support for one or more bootstrap files to be run before processing begins - - Use the --bootstrap=file,file,file command line argument to include bootstrap files - - Useful if you want to override some of the high-level settings of PHPCS or PHPCBF - - Thanks to [John Maguire][@johnmaguire] for the patch -- Added additional verbose output for CSS tokenizing -- Squiz ComparisonOperatorUsageSniff now checks FOR, WHILE and DO-WHILE statements - - Thanks to [Arnout Boks][@aboks] for the patch - -### Fixed -- Fixed bug [#660][sq-660] : Syntax checks can fail on Windows with PHP5.6 -- Fixed bug [#784][sq-784] : $this->trait is seen as a T_TRAIT token -- Fixed bug [#786][sq-786] : Switch indent issue with short array notation -- Fixed bug [#787][sq-787] : SpacingAfterDefaultBreak confused by multi-line statements -- Fixed bug [#797][sq-797] : Parsing CSS url() value breaks further parsing -- Fixed bug [#805][sq-805] : Squiz.Commenting.FunctionComment.InvalidTypeHint on Scalar types on PHP7 -- Fixed bug [#807][sq-807] : Cannot fix line endings when open PHP tag is not on the first line -- Fixed bug [#808][sq-808] : JS tokenizer incorrectly setting some function and class names to control structure tokens -- Fixed bug [#809][sq-809] : PHPCBF can break a require_once statement with a space before the open parenthesis -- Fixed bug [#813][sq-813] : PEAR FunctionCallSignature checks wrong indent when first token on line is part of a multi-line string - -[sq-560]: https://github.com/squizlabs/PHP_CodeSniffer/issues/560 -[sq-583]: https://github.com/squizlabs/PHP_CodeSniffer/issues/583 -[sq-626]: https://github.com/squizlabs/PHP_CodeSniffer/issues/626 -[sq-660]: https://github.com/squizlabs/PHP_CodeSniffer/pull/660 -[sq-784]: https://github.com/squizlabs/PHP_CodeSniffer/issues/784 -[sq-786]: https://github.com/squizlabs/PHP_CodeSniffer/issues/786 -[sq-787]: https://github.com/squizlabs/PHP_CodeSniffer/issues/787 -[sq-797]: https://github.com/squizlabs/PHP_CodeSniffer/issues/797 -[sq-805]: https://github.com/squizlabs/PHP_CodeSniffer/issues/805 -[sq-807]: https://github.com/squizlabs/PHP_CodeSniffer/issues/807 -[sq-808]: https://github.com/squizlabs/PHP_CodeSniffer/issues/808 -[sq-809]: https://github.com/squizlabs/PHP_CodeSniffer/issues/809 -[sq-813]: https://github.com/squizlabs/PHP_CodeSniffer/issues/813 - -## [2.4.0] - 2015-11-24 - -### Changed -- Added support for PHP 7 anonymous classes - - Anonymous classes are now tokenized as T_ANON_CLASS and ignored by normal class sniffs -- Added support for PHP 7 function return type declarations - - Return types are now tokenized as T_RETURN_TYPE -- Fixed tokenizing of the XOR operator, which was incorrectly identified as a power operator (bug [#765][sq-765]) - - The T_POWER token has been removed and replaced by the T_BITWISE_XOR token - - The PHP-supplied T_POW token has been replicated for PHP versions before 5.6 -- Traits are now tokenized in PHP versions before 5.4 to make testing easier -- Improved regular expression detection in JS files -- PEAR FunctionCallSignatureSniff now properly detects indents in more mixed HTML/PHP code blocks -- Full report now properly indents lines when newlines are found inside error messages -- Generating documentation without specifying a standard now uses the default standard instead - - Thanks to [Ken Guest][@kenguest] for the patch -- Generic InlineControlStructureSniff now supports braceless do/while loops in JS - - Thanks to [Pieter Frenssen][@pfrenssen] for the patch -- Added more guard code for function declarations with syntax errors - - Thanks to Yun Young-jin for the patch -- Added more guard code for foreach declarations with syntax errors - - Thanks to [Johan de Ruijter][@johanderuijter] for the patch -- Added more guard code for class declarations with syntax errors -- Squiz ArrayDeclarationSniff now has guard code for arrays with syntax errors -- Generic InlineControlStructureSniff now correctly fixes ELSEIF statements - -### Fixed -- Fixed bug [#601][sq-601] : Expected type hint int[]; found array in Squiz FunctionCommentSniff - - Thanks to [Scato Eggen][@scato] for the patch -- Fixed bug [#625][sq-625] : Consider working around T_HASHBANG in HHVM 3.5.x and 3.6.x - - Thanks to [Kunal Mehta][@legoktm] for the patch -- Fixed bug [#692][sq-692] : Comment tokenizer can break when using mbstring function overloading -- Fixed bug [#694][sq-694] : Long sniff codes can cause PHP warnings in source report when showing error codes -- Fixed bug [#698][sq-698] : PSR2.Methods.FunctionCallSignature.Indent forces exact indent of ternary operator parameters -- Fixed bug [#704][sq-704] : ScopeIndent can fail when an opening parenthesis is on a line by itself -- Fixed bug [#707][sq-707] : Squiz MethodScopeSniff doesn't handle nested functions -- Fixed bug [#709][sq-709] : Squiz.Sniffs.Whitespace.ScopeClosingBraceSniff marking indented endif in mixed inline HTML blocks -- Fixed bug [#711][sq-711] : Sniffing from STDIN shows Generic.Files.LowercasedFilename.NotFound error -- Fixed bug [#714][sq-714] : Fixes suppression of errors using docblocks - - Thanks to [Andrzej Karmazyn][@akarmazyn] for the patch -- Fixed bug [#716][sq-716] : JSON report is invalid when messages contain newlines or tabs - - Thanks to [Pieter Frenssen][@pfrenssen] for the patch -- Fixed bug [#723][sq-723] : ScopeIndent can fail when multiple array closers are on the same line -- Fixed bug [#730][sq-730] : ScopeIndent can fail when a short array opening square bracket is on a line by itself -- Fixed bug [#732][sq-732] : PHP Notice if @package name is made up of all invalid characters - - Adds new error code PEAR.Commenting.FileComment.InvalidPackageValue -- Fixed bug [#748][sq-748] : Auto fix for Squiz.Commenting.BlockComment.WrongEnd is incorrect - - Thanks to [J.D. Grimes][@JDGrimes] for the patch -- Fixed bug [#753][sq-753] : PSR2 standard shouldn't require space after USE block when next code is a closing tag -- Fixed bug [#768][sq-768] : PEAR FunctionCallSignature sniff forbids comments after opening parenthesis of a multiline call -- Fixed bug [#769][sq-769] : Incorrect detection of variable reference operator when used with short array syntax - - Thanks to [Klaus Purer][@klausi] for the patch -- Fixed bug [#772][sq-772] : Syntax error when using PHPCBF on alternative style foreach loops -- Fixed bug [#773][sq-773] : Syntax error when stripping trailing PHP close tag and previous statement has no semicolon -- Fixed bug [#778][sq-778] : PHPCBF creates invalid PHP for inline FOREACH containing multiple control structures -- Fixed bug [#781][sq-781] : Incorrect checking for PHP7 return types on multi-line function declarations -- Fixed bug [#782][sq-782] : Conditional function declarations cause fixing conflicts in Squiz standard - - Squiz.ControlStructures.ControlSignature no longer enforces a single newline after open brace - - Squiz.WhiteSpace.ControlStructureSpacing can be used to check spacing at the start/end of control structures - -[sq-601]: https://github.com/squizlabs/PHP_CodeSniffer/issues/601 -[sq-625]: https://github.com/squizlabs/PHP_CodeSniffer/issues/625 -[sq-692]: https://github.com/squizlabs/PHP_CodeSniffer/pull/692 -[sq-694]: https://github.com/squizlabs/PHP_CodeSniffer/issues/694 -[sq-698]: https://github.com/squizlabs/PHP_CodeSniffer/issues/698 -[sq-704]: https://github.com/squizlabs/PHP_CodeSniffer/issues/704 -[sq-707]: https://github.com/squizlabs/PHP_CodeSniffer/pull/707 -[sq-709]: https://github.com/squizlabs/PHP_CodeSniffer/issues/709 -[sq-711]: https://github.com/squizlabs/PHP_CodeSniffer/issues/711 -[sq-714]: https://github.com/squizlabs/PHP_CodeSniffer/pull/714 -[sq-716]: https://github.com/squizlabs/PHP_CodeSniffer/pull/716 -[sq-723]: https://github.com/squizlabs/PHP_CodeSniffer/issues/723 -[sq-730]: https://github.com/squizlabs/PHP_CodeSniffer/pull/730 -[sq-732]: https://github.com/squizlabs/PHP_CodeSniffer/pull/732 -[sq-748]: https://github.com/squizlabs/PHP_CodeSniffer/pull/748 -[sq-753]: https://github.com/squizlabs/PHP_CodeSniffer/issues/753 -[sq-765]: https://github.com/squizlabs/PHP_CodeSniffer/issues/765 -[sq-768]: https://github.com/squizlabs/PHP_CodeSniffer/issues/768 -[sq-769]: https://github.com/squizlabs/PHP_CodeSniffer/pull/769 -[sq-772]: https://github.com/squizlabs/PHP_CodeSniffer/issues/772 -[sq-773]: https://github.com/squizlabs/PHP_CodeSniffer/issues/773 -[sq-778]: https://github.com/squizlabs/PHP_CodeSniffer/issues/778 -[sq-781]: https://github.com/squizlabs/PHP_CodeSniffer/issues/781 -[sq-782]: https://github.com/squizlabs/PHP_CodeSniffer/issues/782 - -## [2.3.4] - 2015-09-09 - -### Changed -- JSON report format now includes the fixable status for each error message and the total number of fixable errors -- Added more guard code for function declarations with syntax errors -- Added tokenizer support for the PHP declare construct - - Thanks to [Andy Blyler][@ablyler] for the patch -- Generic UnnecessaryStringConcatSniff can now allow strings concatenated over multiple lines - - Set the allowMultiline property to TRUE (default is FALSE) in your ruleset.xml file to enable this - - By default, concat used only for getting around line length limits still generates an error - - Thanks to [Stefan Lenselink][@stefanlenselink] for the contribution -- Invalid byte sequences no longer throw iconv_strlen() errors (request [#639][sq-639]) - - Thanks to [Willem Stuursma][@willemstuursma] for the patch -- Generic TodoSniff and FixmeSniff are now better at processing strings with invalid characters -- PEAR FunctionCallSignatureSniff now ignores indentation of inline HTML content -- Squiz ControlSignatureSniff now supports control structures with only inline HTML content - -### Fixed -- Fixed bug [#636][sq-636] : Some class names cause CSS tokenizer to hang -- Fixed bug [#638][sq-638] : VCS blame reports output error content from the blame commands for files not under VC -- Fixed bug [#642][sq-642] : Method params incorrectly detected when default value uses short array syntax - - Thanks to [Josh Davis][@joshdavis11] for the patch -- Fixed bug [#644][sq-644] : PEAR ScopeClosingBrace sniff does not work with mixed HTML/PHP -- Fixed bug [#645][sq-645] : FunctionSignature and ScopeIndent sniffs don't detect indents correctly when PHP open tag is not on a line by itself -- Fixed bug [#648][sq-648] : Namespace not tokenized correctly when followed by multiple use statements -- Fixed bug [#654][sq-654] : Comments affect indent check for BSDAllman brace style -- Fixed bug [#658][sq-658] : Squiz.Functions.FunctionDeclarationSpacing error for multi-line declarations with required spaces greater than zero - - Thanks to [J.D. Grimes][@JDGrimes] for the patch -- Fixed bug [#663][sq-663] : No space after class name generates: Class name "" is not in camel caps format -- Fixed bug [#667][sq-667] : Scope indent check can go into infinite loop due to some parse errors -- Fixed bug [#670][sq-670] : Endless loop in PSR1 SideEffects sniffer if no semicolon after last statement - - Thanks to [Thomas Jarosch][@thomasjfox] for the patch -- Fixed bug [#672][sq-672] : Call-time pass-by-reference false positive -- Fixed bug [#683][sq-683] : Comments are incorrectly reported by PSR2.ControlStructures.SwitchDeclaration sniff -- Fixed bug [#687][sq-687] : ScopeIndent does not check indent correctly for method prefixes like public and abstract -- Fixed bug [#689][sq-689] : False error on some comments after class closing brace - -[sq-636]: https://github.com/squizlabs/PHP_CodeSniffer/issues/636 -[sq-638]: https://github.com/squizlabs/PHP_CodeSniffer/issues/638 -[sq-639]: https://github.com/squizlabs/PHP_CodeSniffer/pull/639 -[sq-642]: https://github.com/squizlabs/PHP_CodeSniffer/pull/642 -[sq-644]: https://github.com/squizlabs/PHP_CodeSniffer/issues/644 -[sq-645]: https://github.com/squizlabs/PHP_CodeSniffer/issues/645 -[sq-648]: https://github.com/squizlabs/PHP_CodeSniffer/issues/648 -[sq-654]: https://github.com/squizlabs/PHP_CodeSniffer/issues/654 -[sq-658]: https://github.com/squizlabs/PHP_CodeSniffer/pull/658 -[sq-663]: https://github.com/squizlabs/PHP_CodeSniffer/issues/663 -[sq-667]: https://github.com/squizlabs/PHP_CodeSniffer/issues/667 -[sq-670]: https://github.com/squizlabs/PHP_CodeSniffer/pull/670 -[sq-672]: https://github.com/squizlabs/PHP_CodeSniffer/issues/672 -[sq-683]: https://github.com/squizlabs/PHP_CodeSniffer/issues/683 -[sq-687]: https://github.com/squizlabs/PHP_CodeSniffer/issues/687 -[sq-689]: https://github.com/squizlabs/PHP_CodeSniffer/issues/689 - -## [2.3.3] - 2015-06-24 - -### Changed -- Improved the performance of the CSS tokenizer, especially on very large CSS files (thousands of lines) - - Thanks to [Klaus Purer][@klausi] for the patch -- Defined tokens for lower PHP versions are now phpcs-specific strings instead of ints - - Stops conflict with other projects, like PHP_CodeCoverage -- Added more guard code for syntax errors to various sniffs -- Improved support for older HHVM versions - - Thanks to [Kunal Mehta][@legoktm] for the patch -- Squiz ValidLogicalOperatorsSniff now ignores XOR as type casting is different when using the ^ operator (request [#567][sq-567]) -- Squiz CommentedOutCodeSniff is now better at ignoring URLs inside comments -- Squiz ControlSignatureSniff is now better at checking embedded PHP code -- Squiz ScopeClosingBraceSniff is now better at checking embedded PHP code - -### Fixed -- Fixed bug [#584][sq-584] : Squiz.Arrays.ArrayDeclaration sniff gives incorrect NoComma error for multiline string values -- Fixed bug [#589][sq-589] : PEAR.Functions.FunctionCallSignature sniff not checking all function calls -- Fixed bug [#592][sq-592] : USE statement tokenizing can sometimes result in mismatched scopes -- Fixed bug [#594][sq-594] : Tokenizer issue on closure that returns by reference -- Fixed bug [#595][sq-595] : Colons in CSS selectors within media queries throw false positives - - Thanks to [Klaus Purer][@klausi] for the patch -- Fixed bug [#598][sq-598] : PHPCBF can break function/use closure brace placement -- Fixed bug [#603][sq-603] : Squiz ControlSignatureSniff hard-codes opener type while fixing -- Fixed bug [#605][sq-605] : Auto report-width specified in ruleset.xml ignored -- Fixed bug [#611][sq-611] : Invalid numeric literal on CSS files under PHP7 -- Fixed bug [#612][sq-612] : Multi-file diff generating incorrectly if files do not end with EOL char -- Fixed bug [#615][sq-615] : Squiz OperatorBracketSniff incorrectly reports and fixes operations using self:: -- Fixed bug [#616][sq-616] : Squiz DisallowComparisonAssignmentSniff inconsistent errors with inline IF statements -- Fixed bug [#617][sq-617] : Space after switch keyword in PSR-2 is not being enforced -- Fixed bug [#621][sq-621] : PSR2 SwitchDeclaration sniff doesn't detect, or correctly fix, case body on same line as statement - -[sq-567]: https://github.com/squizlabs/PHP_CodeSniffer/issues/567 -[sq-584]: https://github.com/squizlabs/PHP_CodeSniffer/issues/584 -[sq-589]: https://github.com/squizlabs/PHP_CodeSniffer/issues/589 -[sq-592]: https://github.com/squizlabs/PHP_CodeSniffer/issues/592 -[sq-594]: https://github.com/squizlabs/PHP_CodeSniffer/issues/594 -[sq-595]: https://github.com/squizlabs/PHP_CodeSniffer/pull/595 -[sq-598]: https://github.com/squizlabs/PHP_CodeSniffer/issues/598 -[sq-603]: https://github.com/squizlabs/PHP_CodeSniffer/issues/603 -[sq-605]: https://github.com/squizlabs/PHP_CodeSniffer/issues/605 -[sq-611]: https://github.com/squizlabs/PHP_CodeSniffer/issues/611 -[sq-612]: https://github.com/squizlabs/PHP_CodeSniffer/issues/612 -[sq-615]: https://github.com/squizlabs/PHP_CodeSniffer/issues/615 -[sq-616]: https://github.com/squizlabs/PHP_CodeSniffer/issues/616 -[sq-617]: https://github.com/squizlabs/PHP_CodeSniffer/issues/617 -[sq-621]: https://github.com/squizlabs/PHP_CodeSniffer/issues/621 - -## [2.3.2] - 2015-04-29 - -### Changed -- The error message for PSR2.ControlStructures.SwitchDeclaration.WrongOpenercase is now clearer (request [#579][sq-579]) - -### Fixed -- Fixed bug [#545][sq-545] : Long list of CASE statements can cause tokenizer to reach a depth limit -- Fixed bug [#565][sq-565] : Squiz.WhiteSpace.OperatorSpacing reports negative number in short array - - Thanks to [Vašek Purchart][@VasekPurchart] for the patch - - Same fix also applied to Squiz.Formatting.OperatorBracket -- Fixed bug [#569][sq-569] : Generic ScopeIndentSniff throws PHP notices in JS files -- Fixed bug [#570][sq-570] : Phar class fatals in PHP less than 5.3 - -[sq-545]: https://github.com/squizlabs/PHP_CodeSniffer/issues/545 -[sq-565]: https://github.com/squizlabs/PHP_CodeSniffer/pull/565 -[sq-569]: https://github.com/squizlabs/PHP_CodeSniffer/pull/569 -[sq-570]: https://github.com/squizlabs/PHP_CodeSniffer/issues/570 -[sq-579]: https://github.com/squizlabs/PHP_CodeSniffer/issues/579 - -## [2.3.1] - 2015-04-23 - -### Changed -- PHPCS can now exit with 0 even if errors are found - - Set the ignore_errors_on_exit config variable to 1 to set this behaviour - - Use with the ignore_warnings_on_exit config variable to never return a non-zero exit code -- Added Generic DisallowLongArraySyntaxSniff to enforce the use of the PHP short array syntax (request [#483][sq-483]) - - Thanks to [Xaver Loppenstedt][@xalopp] for helping with tests -- Added Generic DisallowShortArraySyntaxSniff to ban the use of the PHP short array syntax (request [#483][sq-483]) - - Thanks to [Xaver Loppenstedt][@xalopp] for helping with tests -- Generic ScopeIndentSniff no longer does exact checking for content inside parenthesis (request [#528][sq-528]) - - Only applies to custom coding standards that set the "exact" flag to TRUE -- Squiz ConcatenationSpacingSniff now has a setting to ignore newline characters around operators (request [#511][sq-511]) - - Default remains FALSE, so newlines are not allowed - - Override the "ignoreNewlines" setting in a ruleset.xml file to change -- Squiz InlineCommentSniff no longer checks the last char of a comment if the first char is not a letter (request [#505][sq-505]) -- The Squiz standard has increased the max padding for statement alignment from 12 to 20 - -### Fixed -- Fixed bug [#479][sq-479] : Yielded values are not recognised as returned values in Squiz FunctionComment sniff -- Fixed bug [#512][sq-512] : Endless loop whilst parsing mixture of control structure styles -- Fixed bug [#515][sq-515] : Spaces in JS block incorrectly flagged as indentation error -- Fixed bug [#523][sq-523] : Generic ScopeIndent errors for IF in FINALLY -- Fixed bug [#527][sq-527] : Closure inside IF statement is not tokenized correctly -- Fixed bug [#529][sq-529] : Squiz.Strings.EchoedStrings gives false positive when echoing using an inline condition -- Fixed bug [#537][sq-537] : Using --config-set is breaking phpcs.phar -- Fixed bug [#543][sq-543] : SWITCH with closure in condition generates inline control structure error -- Fixed bug [#551][sq-551] : Multiple catch blocks not checked in Squiz.ControlStructures.ControlSignature sniff -- Fixed bug [#554][sq-554] : ScopeIndentSniff causes errors when encountering an unmatched parenthesis -- Fixed bug [#558][sq-558] : PHPCBF adds brace for ELSE IF split over multiple lines -- Fixed bug [#564][sq-564] : Generic MultipleStatementAlignment sniff reports incorrect errors for multiple assignments on a single line - -[sq-479]: https://github.com/squizlabs/PHP_CodeSniffer/issues/479 -[sq-483]: https://github.com/squizlabs/PHP_CodeSniffer/issues/483 -[sq-505]: https://github.com/squizlabs/PHP_CodeSniffer/issues/505 -[sq-511]: https://github.com/squizlabs/PHP_CodeSniffer/issues/511 -[sq-512]: https://github.com/squizlabs/PHP_CodeSniffer/issues/512 -[sq-515]: https://github.com/squizlabs/PHP_CodeSniffer/issues/515 -[sq-523]: https://github.com/squizlabs/PHP_CodeSniffer/issues/523 -[sq-527]: https://github.com/squizlabs/PHP_CodeSniffer/issues/527 -[sq-528]: https://github.com/squizlabs/PHP_CodeSniffer/issues/528 -[sq-529]: https://github.com/squizlabs/PHP_CodeSniffer/issues/529 -[sq-537]: https://github.com/squizlabs/PHP_CodeSniffer/issues/537 -[sq-543]: https://github.com/squizlabs/PHP_CodeSniffer/issues/543 -[sq-551]: https://github.com/squizlabs/PHP_CodeSniffer/issues/551 -[sq-554]: https://github.com/squizlabs/PHP_CodeSniffer/issues/554 -[sq-558]: https://github.com/squizlabs/PHP_CodeSniffer/issues/558 -[sq-564]: https://github.com/squizlabs/PHP_CodeSniffer/issues/564 - -## [2.3.0] - 2015-03-04 - -### Changed -- The existence of the main config file is now cached to reduce is_file() calls when it doesn't exist (request [#486][sq-486]) -- Abstract classes inside the Sniffs directory are now ignored even if they are named `[Name]Sniff.php` (request [#476][sq-476]) - - Thanks to [David Vernet][@Decave] for the patch -- PEAR and Squiz FileComment sniffs no longer have @ in their error codes - - e.g., PEAR.Commenting.FileComment.Duplicate@categoryTag becomes PEAR.Commenting.FileComment.DuplicateCategoryTag - - e.g., Squiz.Commenting.FileComment.Missing@categoryTag becomes Squiz.Commenting.FileComment.MissingCategoryTag -- PEAR MultiLineConditionSniff now allows comment lines inside multi-line IF statement conditions - - Thanks to [Klaus Purer][@klausi] for the patch -- Generic ForbiddenFunctionsSniff now supports setting null replacements in ruleset files (request [#263][sq-263]) -- Generic opening function brace sniffs now support checking of closures - - Set the checkClosures property to TRUE (default is FALSE) in your ruleset.xml file to enable this - - Can also set the checkFunctions property to FALSE (default is TRUE) in your ruleset.xml file to only check closures - - Affects OpeningFunctionBraceBsdAllmanSniff and OpeningFunctionBraceKernighanRitchieSniff -- Generic OpeningFunctionBraceKernighanRitchieSniff can now fix all the errors it finds -- Generic OpeningFunctionBraceKernighanRitchieSniff now allows empty functions with braces next to each other -- Generic OpeningFunctionBraceBsdAllmanSniff now allows empty functions with braces next to each other -- Improved auto report width for the "full" report -- Improved conflict detection during auto fixing -- Generic ScopeIndentSniff is no longer confused by empty closures -- Squiz ControlSignatureSniff now always ignores comments (fixes bug [#490][sq-490]) - - Include the Squiz.Commenting.PostStatementComment sniff in your ruleset.xml to ban these comments again -- Squiz OperatorSpacingSniff no longer throws errors for code in the form ($foo || -1 === $bar) -- Fixed errors tokenizing T_ELSEIF tokens on HHVM 3.5 -- Squiz ArrayDeclarationSniff is no longer tricked by comments after array values -- PEAR IncludingFileSniff no longer produces invalid code when removing parenthesis from require/include statements - -### Fixed -- Fixed bug [#415][sq-415] : The @codingStandardsIgnoreStart has no effect during fixing -- Fixed bug [#432][sq-432] : Properties of custom sniffs cannot be configured -- Fixed bug [#453][sq-453] : PSR2 standard does not allow closing tag for mixed PHP/HTML files -- Fixed bug [#457][sq-457] : FunctionCallSignature sniffs do not support here/nowdoc syntax and can cause syntax error when fixing -- Fixed bug [#466][sq-466] : PropertyLabelSpacing JS fixer issue when there is no space after colon -- Fixed bug [#473][sq-473] : Writing a report for an empty folder to existing file includes the existing contents -- Fixed bug [#485][sq-485] : PHP notice in Squiz.Commenting.FunctionComment when checking malformed @throws comment -- Fixed bug [#491][sq-491] : Generic InlineControlStructureSniff can correct with missing semicolon - - Thanks to [Jesse Donat][@donatj] for the patch -- Fixed bug [#492][sq-492] : Use statements don't increase the scope indent -- Fixed bug [#493][sq-493] : PSR1_Sniffs_Methods_CamelCapsMethodNameSniff false positives for some magic method detection - - Thanks to [Andreas Möller][@localheinz] for the patch -- Fixed bug [#496][sq-496] : Closures in PSR2 are not checked for a space after the function keyword -- Fixed bug [#497][sq-497] : Generic InlineControlStructureSniff does not support alternative SWITCH syntax -- Fixed bug [#500][sq-500] : Functions not supported as values in Squiz ArrayDeclaration sniff -- Fixed bug [#501][sq-501] : ScopeClosingBrace and ScopeIndent conflict with closures used as array values - - Generic ScopeIndentSniff may now report fewer errors for closures, but perform the same fixes -- Fixed bug [#502][sq-502] : PSR1 SideEffectsSniff sees declare() statements as side effects - -[sq-415]: https://github.com/squizlabs/PHP_CodeSniffer/issues/415 -[sq-432]: https://github.com/squizlabs/PHP_CodeSniffer/issues/432 -[sq-453]: https://github.com/squizlabs/PHP_CodeSniffer/issues/453 -[sq-457]: https://github.com/squizlabs/PHP_CodeSniffer/issues/457 -[sq-466]: https://github.com/squizlabs/PHP_CodeSniffer/issues/466 -[sq-473]: https://github.com/squizlabs/PHP_CodeSniffer/issues/473 -[sq-476]: https://github.com/squizlabs/PHP_CodeSniffer/issues/476 -[sq-485]: https://github.com/squizlabs/PHP_CodeSniffer/issues/485 -[sq-486]: https://github.com/squizlabs/PHP_CodeSniffer/issues/486 -[sq-490]: https://github.com/squizlabs/PHP_CodeSniffer/issues/490 -[sq-491]: https://github.com/squizlabs/PHP_CodeSniffer/pull/491 -[sq-492]: https://github.com/squizlabs/PHP_CodeSniffer/pull/492 -[sq-493]: https://github.com/squizlabs/PHP_CodeSniffer/pull/493 -[sq-496]: https://github.com/squizlabs/PHP_CodeSniffer/issues/496 -[sq-497]: https://github.com/squizlabs/PHP_CodeSniffer/issues/497 -[sq-500]: https://github.com/squizlabs/PHP_CodeSniffer/issues/500 -[sq-501]: https://github.com/squizlabs/PHP_CodeSniffer/issues/501 -[sq-502]: https://github.com/squizlabs/PHP_CodeSniffer/issues/502 - -## [2.2.0] - 2015-01-22 - -### Changed -- Added (hopefully) tastefully used colors to report and progress output for the phpcs command - - Use the --colors command line argument to use colors in output - - Use the command "phpcs --config-set colors true" to turn colors on by default - - Use the --no-colors command line argument to turn colors off when the config value is set -- Added support for using the full terminal width for report output - - Use the --report-width=auto command line argument to auto-size the reports - - Use the command "phpcs --config-set report_width auto" to use auto-sizing by default -- Reports will now size to fit inside the report width setting instead of always using padding to fill the space -- If no files or standards are specified, PHPCS will now look for a phpcs.xml file in the current directory - - This file has the same format as a standard ruleset.xml file - - The phpcs.xml file should specify (at least) files to process and a standard/sniffs to use - - Useful for running the phpcs and phpcbf commands without any arguments at the top of a repository -- Default file paths can now be specified in a ruleset.xml file using the "file" tag - - File paths are only processed if no files were specified on the command line -- Extensions specified on the CLI are now merged with those set in ruleset.xml files - - Previously, the ruleset.xml file setting replaced the CLI setting completely -- Squiz coding standard now requires lowercase PHP constants (true, false and null) - - Removed Squiz.NamingConventions.ConstantCase sniff as the rule is now consistent across PHP and JS files -- Squiz FunctionOpeningBraceSpaceSniff no longer does additional checks for JS functions - - PHP and JS functions and closures are now treated the same way -- Squiz MultiLineFunctionDeclarationSniff now supports JS files -- Interactive mode no longer breaks if you also specify a report type on the command line -- PEAR InlineCommentSniff now fixes the Perl-style comments that it finds (request [#375][sq-375]) -- PSR2 standard no longer fixes the placement of docblock open tags as comments are excluded from this standard -- PSR2 standard now sets a default tab width of 4 spaces -- Generic DocCommentSniff now only disallows lowercase letters at the start of a long/short comment (request [#377][sq-377]) - - All non-letter characters are now allowed, including markdown special characters and numbers -- Generic DisallowMultipleStatementsSniff now allows multiple open/close tags on the same line (request [#423][sq-423]) -- Generic CharacterBeforePHPOpeningTagSniff now only checks the first PHP tag it finds (request [#423][sq-423]) -- Generic CharacterBeforePHPOpeningTagSniff now allows a shebang line at the start of the file (request [#20481][pear-20481]) -- Generic InlineHTMLUnitTest now allows a shebang line at the start of the file (request [#20481][pear-20481]) -- PEAR ObjectOperatorIndentSniff now only checks object operators at the start of a line -- PEAR FileComment and ClassComment sniffs no longer have @ in their error codes - - E.g., PEAR.Commenting.FileComment.Missing@categoryTag becomes PEAR.Commenting.FileComment.MissingCategoryTag - - Thanks to [Grzegorz Rygielski][@grzr] for the patch -- Squiz ControlStructureSpacingSniff no longer enforces a blank line before CATCH statements -- Squiz FunctionCommentSniff now fixes the return type in the @return tag (request [#392][sq-392]) -- Squiz BlockCommentSniff now only disallows lowercase letters at the start of the comment -- Squiz InlineCommentSniff now only disallows lowercase letters at the start of the comment -- Squiz OperatorSpacingSniff now has a setting to ignore newline characters around operators (request [#348][sq-348]) - - Default remains FALSE, so newlines are not allowed - - Override the "ignoreNewlines" setting in a ruleset.xml file to change -- PSR2 ControlStructureSpacingSniff now checks for, and fixes, newlines after the opening parenthesis -- Added a markdown document generator (--generator=markdown to use) - - Thanks to [Stefano Kowalke][@Konafets] for the contribution - -### Fixed -- Fixed bug [#379][sq-379] : Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast incorrectly detects comments -- Fixed bug [#382][sq-382] : JS tokenizer incorrect for inline conditionally created immediately invoked anon function -- Fixed bug [#383][sq-383] : Squiz.Arrays.ArrayDeclaration.ValueNoNewline incorrectly detects nested arrays -- Fixed bug [#386][sq-386] : Undefined offset in Squiz.FunctionComment sniff when param has no comment -- Fixed bug [#390][sq-390] : Indentation of non-control structures isn't adjusted when containing structure is fixed -- Fixed bug [#400][sq-400] : InlineControlStructureSniff fails to fix when statement has no semicolon -- Fixed bug [#401][sq-401] : PHPCBF no-patch option shows an error when there are no fixable violations in a file -- Fixed bug [#405][sq-405] : The "Squiz.WhiteSpace.FunctionSpacing" sniff removes class "}" during fixing -- Fixed bug [#407][sq-407] : PEAR.ControlStructures.MultiLineCondition doesn't account for comments at the end of lines -- Fixed bug [#410][sq-410] : The "Squiz.WhiteSpace.MemberVarSpacing" not respecting "var" -- Fixed bug [#411][sq-411] : Generic.WhiteSpace.ScopeIndent.Incorrect - false positive with multiple arrays in argument list -- Fixed bug [#412][sq-412] : PSR2 multi-line detection doesn't work for inline IF and string concats -- Fixed bug [#414][sq-414] : Squiz.WhiteSpace.MemberVarSpacing - inconsistent checking of member vars with comment -- Fixed bug [#433][sq-433] : Wrong detection of Squiz.Arrays.ArrayDeclaration.KeyNotAligned when key contains space -- Fixed bug [#434][sq-434] : False positive for spacing around "=>" in inline array within foreach -- Fixed bug [#452][sq-452] : Ruleset exclude-pattern for specific sniff code ignored when using CLI --ignore option -- Fixed bug [#20482][pear-20482] : Scope indent sniff can get into infinite loop when processing a parse error - -[sq-348]: https://github.com/squizlabs/PHP_CodeSniffer/issues/348 -[sq-375]: https://github.com/squizlabs/PHP_CodeSniffer/issues/375 -[sq-377]: https://github.com/squizlabs/PHP_CodeSniffer/issues/377 -[sq-379]: https://github.com/squizlabs/PHP_CodeSniffer/issues/379 -[sq-382]: https://github.com/squizlabs/PHP_CodeSniffer/issues/382 -[sq-383]: https://github.com/squizlabs/PHP_CodeSniffer/issues/383 -[sq-386]: https://github.com/squizlabs/PHP_CodeSniffer/issues/386 -[sq-390]: https://github.com/squizlabs/PHP_CodeSniffer/issues/390 -[sq-392]: https://github.com/squizlabs/PHP_CodeSniffer/issues/392 -[sq-400]: https://github.com/squizlabs/PHP_CodeSniffer/issues/400 -[sq-401]: https://github.com/squizlabs/PHP_CodeSniffer/issues/401 -[sq-405]: https://github.com/squizlabs/PHP_CodeSniffer/issues/405 -[sq-407]: https://github.com/squizlabs/PHP_CodeSniffer/issues/407 -[sq-410]: https://github.com/squizlabs/PHP_CodeSniffer/issues/410 -[sq-411]: https://github.com/squizlabs/PHP_CodeSniffer/issues/411 -[sq-412]: https://github.com/squizlabs/PHP_CodeSniffer/issues/412 -[sq-414]: https://github.com/squizlabs/PHP_CodeSniffer/issues/414 -[sq-423]: https://github.com/squizlabs/PHP_CodeSniffer/issues/423 -[sq-433]: https://github.com/squizlabs/PHP_CodeSniffer/issues/433 -[sq-434]: https://github.com/squizlabs/PHP_CodeSniffer/issues/434 -[sq-452]: https://github.com/squizlabs/PHP_CodeSniffer/issues/452 -[pear-20481]: https://pear.php.net/bugs/bug.php?id=20481 -[pear-20482]: https://pear.php.net/bugs/bug.php?id=20482 - -## [2.1.0] - 2014-12-18 - -### Changed -- Time and memory output is now shown if progress information is also shown (request [#335][sq-335]) -- A tilde can now be used to reference a user's home directory in a path to a standard (request [#353][sq-353]) -- Added PHP_CodeSniffer_File::findStartOfStatement() to find the first non-whitespace token in a statement - - Possible alternative for code using PHP_CodeSniffer_File::findPrevious() with the local flag set -- Added PHP_CodeSniffer_File::findEndOfStatement() to find the last non-whitespace token in a statement - - Possible alternative for code using PHP_CodeSniffer_File::findNext() with the local flag set -- Generic opening function brace sniffs now ensure the opening brace is the last content on the line - - Affects OpeningFunctionBraceBsdAllmanSniff and OpeningFunctionBraceKernighanRitchieSniff - - Also enforced in PEAR FunctionDeclarationSniff and Squiz MultiLineFunctionDeclarationSniff -- Generic DisallowTabIndentSniff now replaces tabs everywhere it finds them, except in strings and here/now docs -- Generic EmptyStatementSniff error codes now contain the type of empty statement detected (request [#314][sq-314]) - - All messages generated by this sniff are now errors (empty CATCH was previously a warning) - - Message code `Generic.CodeAnalysis.EmptyStatement.NotAllowed` has been removed - - Message code `Generic.CodeAnalysis.EmptyStatement.NotAllowedWarning` has been removed - - New message codes have the format `Generic.CodeAnalysis.EmptyStatement.Detected[TYPE]` - - Example code is `Generic.CodeAnalysis.EmptyStatement.DetectedCATCH` - - You can now use a custom ruleset to change messages to warnings and to exclude them -- PEAR and Squiz FunctionCommentSniffs no longer ban `@return` tags for constructors and destructors - - Removed message PEAR.Commenting.FunctionComment.ReturnNotRequired - - Removed message Squiz.Commenting.FunctionComment.ReturnNotRequired - - Change initiated by request [#324][sq-324] and request [#369][sq-369] -- Squiz EmptyStatementSniff has been removed - - Squiz standard now includes Generic EmptyStatementSniff and turns off the empty CATCH error -- Squiz ControlSignatureSniff fixes now retain comments between the closing parenthesis and open brace -- Squiz SuperfluousWhitespaceSniff now checks for extra blank lines inside closures - - Thanks to [Sertan Danis][@sertand] for the patch -- Squiz ArrayDeclarationSniff now skips function calls while checking multi-line arrays - -### Fixed -- Fixed bug [#337][sq-337] : False positive with anonymous functions in Generic_Sniffs_WhiteSpace_ScopeIndentSniff -- Fixed bug [#339][sq-339] : reformatting brace location can result in broken code -- Fixed bug [#342][sq-342] : Nested ternary operators not tokenized correctly -- Fixed bug [#345][sq-345] : Javascript regex not tokenized when inside array -- Fixed bug [#346][sq-346] : PHP path can't be determined in some cases in "phpcs.bat" (on Windows XP) -- Fixed bug [#358][sq-358] : False positives for Generic_Sniffs_WhiteSpace_ScopeIndentSniff -- Fixed bug [#361][sq-361] : Sniff-specific exclude patterns don't work for Windows -- Fixed bug [#364][sq-364] : Don't interpret "use function" as declaration -- Fixed bug [#366][sq-366] : phpcbf with PSR2 errors on control structure alternative syntax -- Fixed bug [#367][sq-367] : Nested Anonymous Functions Causing False Negative -- Fixed bug [#371][sq-371] : Shorthand binary cast causes tokenizer errors - - New token T_BINARY_CAST added for the b"string" cast format (the 'b' is the T_BINARY_CAST token) -- Fixed bug [#372][sq-372] : phpcbf parse problem, wrong brace placement for inline IF -- Fixed bug [#373][sq-373] : Double quote usage fix removing too many double quotes -- Fixed bug [#20196][pear-20196] : 1.5.2 breaks scope_closer position - -[sq-314]: https://github.com/squizlabs/PHP_CodeSniffer/issues/314 -[sq-324]: https://github.com/squizlabs/PHP_CodeSniffer/issues/324 -[sq-335]: https://github.com/squizlabs/PHP_CodeSniffer/issues/335 -[sq-337]: https://github.com/squizlabs/PHP_CodeSniffer/issues/337 -[sq-339]: https://github.com/squizlabs/PHP_CodeSniffer/issues/339 -[sq-342]: https://github.com/squizlabs/PHP_CodeSniffer/issues/342 -[sq-345]: https://github.com/squizlabs/PHP_CodeSniffer/issues/345 -[sq-346]: https://github.com/squizlabs/PHP_CodeSniffer/issues/346 -[sq-353]: https://github.com/squizlabs/PHP_CodeSniffer/issues/353 -[sq-358]: https://github.com/squizlabs/PHP_CodeSniffer/issues/358 -[sq-361]: https://github.com/squizlabs/PHP_CodeSniffer/issues/361 -[sq-364]: https://github.com/squizlabs/PHP_CodeSniffer/pull/364 -[sq-366]: https://github.com/squizlabs/PHP_CodeSniffer/issues/366 -[sq-367]: https://github.com/squizlabs/PHP_CodeSniffer/issues/367 -[sq-369]: https://github.com/squizlabs/PHP_CodeSniffer/issues/369 -[sq-371]: https://github.com/squizlabs/PHP_CodeSniffer/issues/371 -[sq-372]: https://github.com/squizlabs/PHP_CodeSniffer/issues/372 -[sq-373]: https://github.com/squizlabs/PHP_CodeSniffer/issues/373 -[pear-20196]: https://pear.php.net/bugs/bug.php?id=20196 - -## [2.0.0] - 2014-12-05 - -### Changed -- JS tokenizer now sets functions as T_CLOSUREs if the function is anonymous -- JS tokenizer now sets all objects to T_OBJECT - - Object end braces are set to a new token T_CLOSE_OBJECT - - T_OBJECT tokens no longer act like scopes; i.e., they have no condition/opener/closer - - T_PROPERTY tokens no longer act like scopes; i.e., they have no condition/opener/closer - - T_OBJECT tokens have a bracket_closer instead, which can be used to find the ending - - T_CLOSE_OBJECT tokens have a bracket_opener -- Improved regular expression detection in the JS tokenizer -- You can now get PHP_CodeSniffer to ignore a single line by putting @codingStandardsIgnoreLine in a comment - - When the comment is found, the comment line and the following line will be ignored - - Thanks to [Andy Bulford][@abulford] for the contribution -- PHPCBF now prints output when it is changing into directories -- Improved conflict detection during auto fixing -- The -vvv command line argument will now output the current file content for each loop during fixing -- Generic ScopeIndentSniff now checks that open/close PHP tags are aligned to the correct column -- PEAR FunctionCallSignatureSniff now checks indent of closing parenthesis even if it is not on a line by itself -- PEAR FunctionCallSignatureSniff now supports JS files -- PEAR MultiLineConditionSniff now supports JS files -- Squiz DocCommentAlignmentSniff now supports JS files -- Fixed a problem correcting the closing brace line in Squiz ArrayDeclarationSniff -- Fixed a problem auto-fixing the Squiz.WhiteSpace.FunctionClosingBraceSpace.SpacingBeforeNestedClose error -- Squiz EmbeddedPhpSniff no longer reports incorrect alignment of tags when they are not on new lines -- Squiz EmbeddedPhpSniff now aligns open tags correctly when moving them onto a new line -- Improved fixing of arrays with multiple values in Squiz ArrayDeclarationSniff -- Improved detection of function comments in Squiz FunctionCommentSpacingSniff -- Improved fixing of lines after cases statements in Squiz SwitchDeclarationSniff - -### Fixed -- Fixed bug [#311][sq-311] : Suppression of function prototype breaks checking of lines within function -- Fixed bug [#320][sq-320] : Code sniffer indentation issue -- Fixed bug [#333][sq-333] : Nested ternary operators causing problems - -[sq-320]: https://github.com/squizlabs/PHP_CodeSniffer/issues/320 -[sq-333]: https://github.com/squizlabs/PHP_CodeSniffer/issues/333 - -## [1.5.6] - 2014-12-05 - -### Changed -- JS tokenizer now detects xor statements correctly -- The --config-show command now pretty-prints the config values - - Thanks to [Ken Guest][@kenguest] for the patch -- Setting and removing config values now catches exceptions if the config file is not writable - - Thanks to [Ken Guest][@kenguest] for the patch -- Setting and removing config values now prints a message to confirm the action and show old values -- You can now get PHP_CodeSniffer to ignore a single line by putting @codingStandardsIgnoreLine in a comment - - When the comment is found, the comment line and the following line will be ignored - - Thanks to [Andy Bulford][@abulford] for the contribution -- Generic ConstructorNameSniff no longer errors for PHP4 style constructors when __construct() is present - - Thanks to [Thibaud Fabre][@fabre-thibaud] for the patch - -### Fixed -- Fixed bug [#280][sq-280] : The --config-show option generates error when there is no config file -- Fixed bug [#306][sq-306] : File containing only a namespace declaration raises undefined index notice -- Fixed bug [#308][sq-308] : Squiz InlineIfDeclarationSniff fails on ternary operators inside closure -- Fixed bug [#310][sq-310] : Variadics not recognized by tokenizer -- Fixed bug [#311][sq-311] : Suppression of function prototype breaks checking of lines within function - -[sq-311]: https://github.com/squizlabs/PHP_CodeSniffer/issues/311 - -## [2.0.0RC4] - 2014-11-07 - -### Changed -- JS tokenizer now detects xor statements correctly -- Improved detection of properties and objects in the JS tokenizer -- Generic ScopeIndentSniff can now fix indents using tabs instead of spaces - - Set the tabIndent property to TRUE in your ruleset.xml file to enable this - - It is important to also set a tab-width setting, either in the ruleset or on the command line, for accuracy -- Generic ScopeIndentSniff now checks and auto-fixes JS files -- Generic DisallowSpaceIndentSniff is now able to replace space indents with tab indents during fixing -- Support for phpcs-only and phpcbf-only attributes has been added to all ruleset.xml elements - - Allows parts of the ruleset to only apply when using a specific tool - - Useful for doing things like excluding indent fixes but still reporting indent errors -- Unit tests can now set command line arguments during a test run - - Override getCliValues() and pass an array of CLI arguments for each file being tested -- File-wide sniff properties can now be set using T_INLINE_HTML content during unit test runs - - Sniffs that start checking at the open tag can only, normally, have properties set using a ruleset -- Generic ConstructorNameSniff no longer errors for PHP4 style constructors when __construct() is present - - Thanks to [Thibaud Fabre][@fabre-thibaud] for the patch -- Generic DocCommentSniff now checks that the end comment tag is on a new line -- Generic MultipleStatementAlignmentSniff no longer skips assignments for closures -- Squiz DocCommentAlignment sniff now has better checking for single line doc block -- Running unit tests with the -v CLI argument no longer generates PHP errors - -### Fixed -- Fixed bug [#295][sq-295] : ScopeIndentSniff hangs when processing nested closures -- Fixed bug [#298][sq-298] : False positive in ScopeIndentSniff when anonymous functions are used with method chaining -- Fixed bug [#302][sq-302] : Fixing code in Squiz InlineComment sniff can remove some comment text -- Fixed bug [#303][sq-303] : Open and close tag on same line can cause a PHP notice checking scope indent -- Fixed bug [#306][sq-306] : File containing only a namespace declaration raises undefined index notice -- Fixed bug [#307][sq-307] : Conditional breaks in case statements get incorrect indentations -- Fixed bug [#308][sq-308] : Squiz InlineIfDeclarationSniff fails on ternary operators inside closure -- Fixed bug [#310][sq-310] : Variadics not recognized by tokenizer - -[sq-295]: https://github.com/squizlabs/PHP_CodeSniffer/issues/295 -[sq-298]: https://github.com/squizlabs/PHP_CodeSniffer/issues/298 -[sq-302]: https://github.com/squizlabs/PHP_CodeSniffer/issues/302 -[sq-303]: https://github.com/squizlabs/PHP_CodeSniffer/issues/303 -[sq-306]: https://github.com/squizlabs/PHP_CodeSniffer/issues/306 -[sq-307]: https://github.com/squizlabs/PHP_CodeSniffer/issues/307 -[sq-308]: https://github.com/squizlabs/PHP_CodeSniffer/issues/308 -[sq-310]: https://github.com/squizlabs/PHP_CodeSniffer/issues/310 - -## [2.0.0RC3] - 2014-10-16 - -### Changed -- Improved default output for PHPCBF and removed the options to print verbose and progress output -- If a .fixed file is supplied for a unit test file, the auto fixes will be checked against it during testing - - See Generic ScopeIndentUnitTest.inc and ScopeIndentUnitTest.inc.fixed for an example -- Fixer token replacement methods now return TRUE if the change was accepted and FALSE if rejected -- The --config-show command now pretty-prints the config values - - Thanks to [Ken Guest][@kenguest] for the patch -- Setting and removing config values now catches exceptions if the config file is not writable - - Thanks to [Ken Guest][@kenguest] for the patch -- Setting and removing config values now prints a message to confirm the action and show old values -- Generic ScopeIndentSniff has been completely rewritten to improve fixing and embedded PHP detection -- Generic DisallowTabIndent and DisallowSpaceIndent sniffs now detect indents at the start of block comments -- Generic DisallowTabIndent and DisallowSpaceIndent sniffs now detect indents inside multi-line strings -- Generic DisallowTabIndentSniff now replaces tabs inside doc block comments -- Squiz ControlStructureSpacingSniff error codes have been corrected; they were reversed -- Squiz EmbeddedPhpSniff now checks open and close tag indents and fixes some errors -- Squiz FileCommentSniff no longer throws incorrect blank line before comment errors in JS files -- Squiz ClassDeclarationSniff now has better checking for blank lines after a closing brace -- Removed error Squiz.Classes.ClassDeclaration.NoNewlineAfterCloseBrace (request [#285][sq-285]) - - Already handled by Squiz.Classes.ClassDeclaration.CloseBraceSameLine - -### Fixed -- Fixed bug [#280][sq-280] : The --config-show option generates error when there is no config file - -[sq-280]: https://github.com/squizlabs/PHP_CodeSniffer/issues/280 -[sq-285]: https://github.com/squizlabs/PHP_CodeSniffer/issues/285 - -## [2.0.0RC2] - 2014-09-26 - -### Changed -- Minified JS and CSS files are now detected and skipped (fixes bug [#252][sq-252] and bug [#19899][pear-19899]) - - A warning will be added to the file so it can be found in the report and ignored in the future -- Fixed incorrect length of JS object operator tokens -- PHP tokenizer no longer converts class/function names to special tokens types - - Class/function names such as parent and true would become special tokens such as T_PARENT and T_TRUE -- PHPCS can now exit with 0 if only warnings were found (request [#262][sq-262]) - - Set the ignore_warnings_on_exit config variable to 1 to set this behaviour - - Default remains at exiting with 0 only if no errors and no warnings were found - - Also changes return value of PHP_CodeSniffer_Reporting::printReport() -- Rulesets can now set associative array properties - - property `name="[property]" type="array" value="foo=>bar,baz=>qux"` -- Generic ForbiddenFunctionsSniff now has a public property called forbiddenFunctions (request [#263][sq-263]) - - Override the property in a ruleset.xml file to define forbidden functions and their replacements - - A replacement of NULL indicates that no replacement is available - - e.g., value="delete=>unset,print=>echo,create_function=>null" - - Custom sniffs overriding this one will need to change the visibility of their member var -- Improved closure support in Generic ScopeIndentSniff -- Improved indented PHP tag support in Generic ScopeIndentSniff -- Improved fixing of mixed line indents in Generic ScopeIndentSniff -- Added conflict detection to the file fixer - - If 2 sniffs look to be conflicting, one change will be ignored to allow a fix to occur -- Generic CamelCapsFunctionNameSniff now ignores a single leading underscore - - Thanks to [Alex Slobodiskiy][@xt99] for the patch -- Standards can now be located within hidden directories (further fix for bug [#20323][pear-20323]) - - Thanks to [Klaus Purer][@klausi] for the patch -- Sniff ignore patterns now replace Win dir separators like file ignore patterns already did -- Exclude patterns now use backtick delimiters, allowing all special characters to work correctly again - - Thanks to [Jeremy Edgell][@jedgell] for the patch -- Errors converted to warnings in a ruleset (and vice versa) now retain their fixable status - - Thanks to [Alexander Obuhovich][@aik099] for the patch -- Squiz ConcatenationSpacingSniff now has a setting to specify how many spaces there should be around concat operators - - Default remains at 0 - - Override the "spacing" setting in a ruleset.xml file to change -- Added auto-fixes for Squiz InlineCommentSniff -- Generic DocCommentSniff now correctly fixes additional blank lines at the end of a comment -- Squiz OperatorBracketSniff now correctly fixes operations that include arrays -- Zend ClosingTagSniff fix now correctly leaves closing tags when followed by HTML -- Added Generic SyntaxSniff to check for syntax errors in PHP files - - Thanks to [Blaine Schmeisser][@bayleedev] for the contribution -- Added Generic OneTraitPerFileSniff to check that only one trait is defined in each file - - Thanks to [Alexander Obuhovich][@aik099] for the contribution -- Squiz DiscouragedFunctionsSniff now warns about var_dump() -- PEAR ValidFunctionNameSniff no longer throws an error for _() -- Squiz and PEAR FunctionCommentSniffs now support _() -- Generic DisallowTabIndentSniff now checks for, and fixes, mixed indents again -- Generic UpperCaseConstantSniff and LowerCaseConstantSniff now ignore function names - -### Fixed -- Fixed bug [#243][sq-243] : Missing DocBlock not detected -- Fixed bug [#248][sq-248] : FunctionCommentSniff expects ampersand on param name -- Fixed bug [#265][sq-265] : False positives with type hints in ForbiddenFunctionsSniff -- Fixed bug [#20373][pear-20373] : Inline comment sniff tab handling way -- Fixed bug [#20377][pear-20377] : Error when trying to execute phpcs with report=json -- Fixed bug [#20378][pear-20378] : Report appended to existing file if no errors found in run -- Fixed bug [#20381][pear-20381] : Invalid "Comment closer must be on a new line" - - Thanks to [Brad Kent][@bkdotcom] for the patch -- Fixed bug [#20402][pear-20402] : SVN pre-commit hook fails due to unknown argument error - -[sq-243]: https://github.com/squizlabs/PHP_CodeSniffer/issues/243 -[sq-252]: https://github.com/squizlabs/PHP_CodeSniffer/issues/252 -[sq-262]: https://github.com/squizlabs/PHP_CodeSniffer/issues/262 -[sq-263]: https://github.com/squizlabs/PHP_CodeSniffer/issues/263 -[pear-19899]: https://pear.php.net/bugs/bug.php?id=19899 -[pear-20377]: https://pear.php.net/bugs/bug.php?id=20377 -[pear-20402]: https://pear.php.net/bugs/bug.php?id=20402 - -## [1.5.5] - 2014-09-25 - -### Changed -- PHP tokenizer no longer converts class/function names to special tokens types - - Class/function names such as parent and true would become special tokens such as T_PARENT and T_TRUE -- Improved closure support in Generic ScopeIndentSniff -- Improved indented PHP tag support in Generic ScopeIndentSniff -- Generic CamelCapsFunctionNameSniff now ignores a single leading underscore - - Thanks to [Alex Slobodiskiy][@xt99] for the patch -- Standards can now be located within hidden directories (further fix for bug [#20323][pear-20323]) - - Thanks to [Klaus Purer][@klausi] for the patch -- Added Generic SyntaxSniff to check for syntax errors in PHP files - - Thanks to [Blaine Schmeisser][@bayleedev] for the contribution -- Squiz DiscouragedFunctionsSniff now warns about var_dump() -- PEAR ValidFunctionNameSniff no longer throws an error for _() -- Squiz and PEAR FunctionCommentSnif now support _() -- Generic UpperCaseConstantSniff and LowerCaseConstantSniff now ignore function names - -### Fixed -- Fixed bug [#248][sq-248] : FunctionCommentSniff expects ampersand on param name -- Fixed bug [#265][sq-265] : False positives with type hints in ForbiddenFunctionsSniff -- Fixed bug [#20373][pear-20373] : Inline comment sniff tab handling way -- Fixed bug [#20378][pear-20378] : Report appended to existing file if no errors found in run -- Fixed bug [#20381][pear-20381] : Invalid "Comment closer must be on a new line" - - Thanks to [Brad Kent][@bkdotcom] for the patch -- Fixed bug [#20386][pear-20386] : Squiz.Commenting.ClassComment.SpacingBefore thrown if first block comment - -[sq-248]: https://github.com/squizlabs/PHP_CodeSniffer/issues/248 -[sq-265]: https://github.com/squizlabs/PHP_CodeSniffer/pull/265 -[pear-20373]: https://pear.php.net/bugs/bug.php?id=20373 -[pear-20378]: https://pear.php.net/bugs/bug.php?id=20378 -[pear-20381]: https://pear.php.net/bugs/bug.php?id=20381 -[pear-20386]: https://pear.php.net/bugs/bug.php?id=20386 - -## [2.0.0RC1] - 2014-08-06 - -### Changed -- PHPCBF will now fix incorrect newline characters in a file -- PHPCBF now exits cleanly when there are no errors to fix -- Added phpcbf.bat file for Windows -- Verbose option no longer errors when using a phar file with a space in the path -- Fixed a reporting error when using HHVM - - Thanks to [Martins Sipenko][@martinssipenko] for the patch -- addFixableError() and addFixableWarning() now only return true if the fixer is enabled - - Saves checking ($phpcsFile->fixer->enabled === true) before every fix -- Added addErrorOnLine() and addWarningOnLine() to add a non-fixable violation to a line at column 1 - - Useful if you are generating errors using an external tool or parser and only know line numbers - - Thanks to [Ondřej Mirtes][@ondrejmirtes] for the patch -- CSS tokenizer now identifies embedded PHP code using the new T_EMBEDDED_PHP token type - - The entire string of PHP is contained in a single token -- PHP tokenizer contains better detection of short array syntax -- Unit test runner now also test any standards installed under the installed_paths config var -- Exclude patterns now use {} delimiters, allowing the | special character to work correctly again -- The filtering component of the --extensions argument is now ignored again when passing filenames - - Can still be used to specify a custom tokenizer for each extension when passing filenames - - If no tokenizer is specified, default values will be used for common file extensions -- Diff report now produces relative paths on Windows, where possible (further fix for bug [#20234][pear-20234]) -- If a token's content has been modified by the tab-width setting, it will now have an orig_content in the tokens array -- Generic DisallowSpaceIndent and DisallowTabIndent sniffs now check original indent content even when tab-width is set - - Previously, setting --tab-width would force both to check the indent as spaces -- Fixed a problem where PHPCBF could replace tabs with too many spaces when changing indents -- Fixed a problem that could occur with line numbers when using HHVM to check files with Windows newline characters -- Removed use of sys_get_temp_dir() as this is not supported by the min PHP version -- Squiz ArrayDeclarationSniff now supports short array syntax -- Squiz ControlSignatureSniff no longer uses the Abstract Pattern sniff - - If you are extending this sniff, you'll need to rewrite your code - - The rewrite allows this sniff to fix all control structure formatting issues it finds -- The installed_paths config var now accepts relative paths - - The paths are relative to the PHP_CodeSniffer install directory - - Thanks to [Weston Ruter][@westonruter] for the patch -- Generic ScopeIndentSniff now accounts for different open tag indents -- PEAR FunctionDeclarationSniff now ignores short arrays when checking indent - - Thanks to [Daniel Tschinder][@danez] for the patch -- PSR2 FunctionCallSignatureSniff now treats multi-line strings as a single-line argument, like arrays and closures - - Thanks to [Dawid Nowak][@MacDada] for the patch -- PSR2 UseDeclarationSniff now checks for a single space after the USE keyword -- Generic ForbiddenFunctionsSniff now detects calls to functions in the global namespace - - Thanks to [Ole Martin Handeland][@olemartinorg] for the patch -- Generic LowerCaseConstantSniff and UpperCaseConstantSniff now ignore namespaces beginning with TRUE/FALSE/NULL - - Thanks to [Renan Gonçalves][@renan] for the patch -- Squiz InlineCommentSniff no longer requires a blank line after post-statement comments (request [#20299][pear-20299]) -- Squiz SelfMemberReferenceSniff now works correctly with namespaces -- Squiz FunctionCommentSniff is now more relaxed when checking namespaced type hints -- Tab characters are now encoded in abstract pattern error messages - - Thanks to [Blaine Schmeisser][@bayleedev] for the patch -- Invalid sniff codes passed to --sniffs now show a friendly error message (request [#20313][pear-20313]) -- Generic LineLengthSniff now shows a warning if the iconv module is disabled (request [#20314][pear-20314]) -- Source report no longer shows errors if category or sniff names ends in an uppercase error - - Thanks to [Jonathan Marcil][@jmarcil] for the patch - -### Fixed -- Fixed bug [#20261][pear-20261] : phpcbf has an endless fixing loop -- Fixed bug [#20268][pear-20268] : Incorrect documentation titles in PEAR documentation -- Fixed bug [#20296][pear-20296] : new array notion in function comma check fails -- Fixed bug [#20297][pear-20297] : phar does not work when renamed it to phpcs -- Fixed bug [#20307][pear-20307] : PHP_CodeSniffer_Standards_AbstractVariableSniff analyze traits -- Fixed bug [#20308][pear-20308] : Squiz.ValidVariableNameSniff - wrong variable usage -- Fixed bug [#20309][pear-20309] : Use "member variable" term in sniff "processMemberVar" method -- Fixed bug [#20310][pear-20310] : PSR2 does not check for space after function name -- Fixed bug [#20322][pear-20322] : Display rules set to type=error even when suppressing warnings -- Fixed bug [#20323][pear-20323] : PHPCS tries to load sniffs from hidden directories -- Fixed bug [#20346][pear-20346] : Fixer endless loop with Squiz.CSS sniffs -- Fixed bug [#20355][pear-20355] : No sniffs are registered with PHAR on Windows - -[pear-20261]: https://pear.php.net/bugs/bug.php?id=20261 -[pear-20297]: https://pear.php.net/bugs/bug.php?id=20297 -[pear-20346]: https://pear.php.net/bugs/bug.php?id=20346 -[pear-20355]: https://pear.php.net/bugs/bug.php?id=20355 - -## [1.5.4] - 2014-08-06 - -### Changed -- Removed use of sys_get_temp_dir() as this is not supported by the min PHP version -- The installed_paths config var now accepts relative paths - - The paths are relative to the PHP_CodeSniffer install directory - - Thanks to [Weston Ruter][@westonruter] for the patch -- Generic ScopeIndentSniff now accounts for different open tag indents -- PEAR FunctionDeclarationSniff now ignores short arrays when checking indent - - Thanks to [Daniel Tschinder][@danez] for the patch -- PSR2 FunctionCallSignatureSniff now treats multi-line strings as a single-line argument, like arrays and closures - - Thanks to [Dawid Nowak][@MacDada] for the patch -- Generic ForbiddenFunctionsSniff now detects calls to functions in the global namespace - - Thanks to [Ole Martin Handeland][@olemartinorg] for the patch -- Generic LowerCaseConstantSniff and UpperCaseConstantSniff now ignore namespaces beginning with TRUE/FALSE/NULL - - Thanks to [Renan Gonçalves][@renan] for the patch -- Squiz InlineCommentSniff no longer requires a blank line after post-statement comments (request [#20299][pear-20299]) -- Squiz SelfMemberReferenceSniff now works correctly with namespaces -- Tab characters are now encoded in abstract pattern error messages - - Thanks to [Blaine Schmeisser][@bayleedev] for the patch -- Invalid sniff codes passed to --sniffs now show a friendly error message (request [#20313][pear-20313]) -- Generic LineLengthSniff now shows a warning if the iconv module is disabled (request [#20314][pear-20314]) -- Source report no longer shows errors if category or sniff names ends in an uppercase error - - Thanks to [Jonathan Marcil][@jmarcil] for the patch - -### Fixed -- Fixed bug [#20268][pear-20268] : Incorrect documentation titles in PEAR documentation -- Fixed bug [#20296][pear-20296] : new array notion in function comma check fails -- Fixed bug [#20307][pear-20307] : PHP_CodeSniffer_Standards_AbstractVariableSniff analyze traits -- Fixed bug [#20308][pear-20308] : Squiz.ValidVariableNameSniff - wrong variable usage -- Fixed bug [#20309][pear-20309] : Use "member variable" term in sniff "processMemberVar" method -- Fixed bug [#20310][pear-20310] : PSR2 does not check for space after function name -- Fixed bug [#20322][pear-20322] : Display rules set to type=error even when suppressing warnings -- Fixed bug [#20323][pear-20323] : PHPCS tries to load sniffs from hidden directories - -[pear-20268]: https://pear.php.net/bugs/bug.php?id=20268 -[pear-20296]: https://pear.php.net/bugs/bug.php?id=20296 -[pear-20299]: https://pear.php.net/bugs/bug.php?id=20299 -[pear-20307]: https://pear.php.net/bugs/bug.php?id=20307 -[pear-20308]: https://pear.php.net/bugs/bug.php?id=20308 -[pear-20309]: https://pear.php.net/bugs/bug.php?id=20309 -[pear-20310]: https://pear.php.net/bugs/bug.php?id=20310 -[pear-20313]: https://pear.php.net/bugs/bug.php?id=20313 -[pear-20314]: https://pear.php.net/bugs/bug.php?id=20314 -[pear-20322]: https://pear.php.net/bugs/bug.php?id=20322 -[pear-20323]: https://pear.php.net/bugs/bug.php?id=20323 - -## [2.0.0a2] - 2014-05-01 - -### Changed -- Added report type --report=info to show information about the checked code to make building a standard easier - - Checks a number of things, such as what line length you use, and spacing are brackets, but not everything - - Still highly experimental -- Generic LineLengthSniff now shows warnings for long lines referring to licence and VCS information - - It previously ignored these lines, but at the expense of performance -- Generic DisallowTabIndent and DisallowSpaceIndent sniffs no longer error when detecting mixed indent types - - Only the first type of indent found on a line (space or indent) is considered -- Lots of little performance improvements that can add up to a substantial saving over large code bases - - Added a "length" array index to tokens so you don't need to call strlen() of them, or deal with encoding - - Can now use isset() to find tokens inside the PHP_CodeSniffer_Tokens static vars instead of in_array() -- Custom reports can now specify a $recordErrors member var; this previously only worked for built-in reports - - When set to FALSE, error messages will not be recorded and only totals will be returned - - This can save significant memory while processing a large code base -- Removed dependence on PHP_Timer -- PHP tokenizer now supports DEFAULT statements opened with a T_SEMICOLON -- The Squiz and PHPCS standards have increased the max padding for statement alignment from 8 to 12 -- Squiz EchoedStringsSniff now supports statements without a semicolon, such as PHP embedded in HTML -- Squiz DoubleQuoteUsageSniff now properly replaces escaped double quotes when fixing a doubled quoted string -- Improved detection of nested IF statements that use the alternate IF/ENDIF syntax -- PSR1 CamelCapsMethodNameSniff now ignores magic methods - - Thanks to [Eser Ozvataf][@eser] for the patch -- PSR1 SideEffectsSniff now ignores methods named define() -- PSR1 and PEAR ClassDeclarationSniffs now support traits (request [#20208][pear-20208]) -- PSR2 ControlStructureSpacingSniff now allows newlines before/after parentheses - - Thanks to [Maurus Cuelenaere][@mcuelenaere] for the patch -- PSR2 ControlStructureSpacingSniff now checks TRY and CATCH statements -- Squiz SuperfluousWhitespaceSniff now detects whitespace at the end of block comment lines - - Thanks to [Klaus Purer][@klausi] for the patch -- Squiz LowercasePHPFunctionsSniff no longer reports errors for namespaced functions - - Thanks to [Max Galbusera][@maxgalbu] for the patch -- Squiz SwitchDeclarationSniff now allows exit() as a breaking statement for case/default -- Squiz ValidVariableNameSniff and Zend ValidVariableNameSniff now ignore additional PHP reserved vars - - Thanks to Mikuláš Dítě and Adrian Crepaz for the patch -- Sniff code Squiz.WhiteSpace.MemberVarSpacing.After changed to Squiz.WhiteSpace.MemberVarSpacing.Incorrect (request [#20241][pear-20241]) - -### Fixed -- Fixed bug [#20200][pear-20200] : Invalid JSON produced with specific error message -- Fixed bug [#20204][pear-20204] : Ruleset exclude checks are case sensitive -- Fixed bug [#20213][pear-20213] : Invalid error, Inline IF must be declared on single line -- Fixed bug [#20225][pear-20225] : array_merge() that takes more than one line generates error -- Fixed bug [#20230][pear-20230] : Squiz ControlStructureSpacing sniff assumes specific condition formatting -- Fixed bug [#20234][pear-20234] : phpcbf patch command absolute paths -- Fixed bug [#20240][pear-20240] : Squiz block comment sniff fails when newline present -- Fixed bug [#20247][pear-20247] : The Squiz.WhiteSpace.ControlStructureSpacing sniff and do-while - - Thanks to [Alexander Obuhovich][@aik099] for the patch -- Fixed bug [#20248][pear-20248] : The Squiz_Sniffs_WhiteSpace_ControlStructureSpacingSniff sniff and empty scope -- Fixed bug [#20252][pear-20252] : Unitialized string offset when package name starts with underscore - -[pear-20234]: https://pear.php.net/bugs/bug.php?id=20234 - -## [1.5.3] - 2014-05-01 - -### Changed -- Improved detection of nested IF statements that use the alternate IF/ENDIF syntax -- PHP tokenizer now supports DEFAULT statements opened with a T_SEMICOLON -- PSR1 CamelCapsMethodNameSniff now ignores magic methods - - Thanks to [Eser Ozvataf][@eser] for the patch -- PSR1 SideEffectsSniff now ignores methods named define() -- PSR1 and PEAR ClassDeclarationSniffs now support traits (request [#20208][pear-20208]) -- PSR2 ControlStructureSpacingSniff now allows newlines before/after parentheses - - Thanks to [Maurus Cuelenaere][@mcuelenaere] for the patch -- Squiz LowercasePHPFunctionsSniff no longer reports errors for namespaced functions - - Thanks to [Max Galbusera][@maxgalbu] for the patch -- Squiz SwitchDeclarationSniff now allows exit() as a breaking statement for case/default -- Squiz ValidVariableNameSniff and Zend ValidVariableNameSniff now ignore additional PHP reserved vars - - Thanks to Mikuláš Dítě and Adrian Crepaz for the patch -- Sniff code Squiz.WhiteSpace.MemberVarSpacing.After changed to Squiz.WhiteSpace.MemberVarSpacing.Incorrect (request [#20241][pear-20241]) - -### Fixed -- Fixed bug [#20200][pear-20200] : Invalid JSON produced with specific error message -- Fixed bug [#20204][pear-20204] : Ruleset exclude checks are case sensitive -- Fixed bug [#20213][pear-20213] : Invalid error, Inline IF must be declared on single line -- Fixed bug [#20225][pear-20225] : array_merge() that takes more than one line generates error -- Fixed bug [#20230][pear-20230] : Squiz ControlStructureSpacing sniff assumes specific condition formatting -- Fixed bug [#20240][pear-20240] : Squiz block comment sniff fails when newline present -- Fixed bug [#20247][pear-20247] : The Squiz.WhiteSpace.ControlStructureSpacing sniff and do-while - - Thanks to [Alexander Obuhovich][@aik099] for the patch -- Fixed bug [#20248][pear-20248] : The Squiz_Sniffs_WhiteSpace_ControlStructureSpacingSniff sniff and empty scope -- Fixed bug [#20252][pear-20252] : Uninitialized string offset when package name starts with underscore - -[pear-20200]: https://pear.php.net/bugs/bug.php?id=20200 -[pear-20204]: https://pear.php.net/bugs/bug.php?id=20204 -[pear-20208]: https://pear.php.net/bugs/bug.php?id=20208 -[pear-20213]: https://pear.php.net/bugs/bug.php?id=20213 -[pear-20225]: https://pear.php.net/bugs/bug.php?id=20225 -[pear-20230]: https://pear.php.net/bugs/bug.php?id=20230 -[pear-20240]: https://pear.php.net/bugs/bug.php?id=20240 -[pear-20241]: https://pear.php.net/bugs/bug.php?id=20241 -[pear-20247]: https://pear.php.net/bugs/bug.php?id=20247 -[pear-20248]: https://pear.php.net/bugs/bug.php?id=20248 -[pear-20252]: https://pear.php.net/bugs/bug.php?id=20252 - -## [2.0.0a1] - 2014-02-05 - -### Changed -- Added the phpcbf script to automatically fix many errors found by the phpcs script -- Added report type --report=diff to show suggested changes to fix coding standard violations -- The --report argument now allows for custom reports to be used - - Use the full path to your custom report class as the report name -- The --extensions argument is now respected when passing filenames; not just with directories -- The --extensions argument now allows you to specify the tokenizer for each extension - - e.g., `--extensions=module/php,es/js` -- Command line arguments can now be set in ruleset files - - e.g., `arg name="report" value="summary"` (print summary report; same as `--report=summary`) - - e.g., `arg value="sp"` (print source and progress information; same as `-sp`) - - The `-vvv`, `--sniffs`, `--standard` and `-l` command line arguments cannot be set in this way -- Sniff process() methods can now optionally return a token to ignore up to - - If returned, the sniff will not be executed again until the passed token is reached in the file - - Useful if you are looking for tokens like T_OPEN_TAG but only want to process the first one -- Removed the comment parser classes and replaced it with a simple comment tokenizer - - T_DOC_COMMENT tokens are now tokenized into T_DOC_COMMENT_* tokens so they can be used more easily - - This change requires a significant rewrite of sniffs that use the comment parser - - This change requires minor changes to sniffs that listen for T_DOC_COMMENT tokens directly -- Added Generic DocCommentSniff to check generic doc block formatting - - Removed doc block formatting checks from PEAR ClassCommentSniff - - Removed doc block formatting checks from PEAR FileCommentSniff - - Removed doc block formatting checks from PEAR FunctionCommentSniff - - Removed doc block formatting checks from Squiz ClassCommentSniff - - Removed doc block formatting checks from Squiz FileCommentSniff - - Removed doc block formatting checks from Squiz FunctionCommentSniff - - Removed doc block formatting checks from Squiz VariableCommentSniff -- Squiz DocCommentAlignmentSniff has had its error codes changed - - NoSpaceBeforeTag becomes NoSpaceAfterStar - - SpaceBeforeTag becomes SpaceAfterStar - - SpaceBeforeAsterisk becomes SpaceBeforeStar -- Generic MultipleStatementAlignment now aligns assignments within a block so they fit within their max padding setting - - The sniff previously requested the padding as 1 space if max padding was exceeded - - It now aligns the assignment with surrounding assignments if it can - - Removed property ignoreMultiline as multi-line assignments are now handled correctly and should not be ignored -- Squiz FunctionClosingBraceSpaceSniff now requires a blank line before the brace in all cases except function args -- Added error Squiz.Commenting.ClassComment.SpacingAfter to ensure there are no blank lines after a class comment -- Added error Squiz.WhiteSpace.MemberVarSpacing.AfterComment to ensure there are no blank lines after a member var comment - - Fixes have also been corrected to not strip the member var comment or indent under some circumstances - - Thanks to [Mark Scherer][@dereuromark] for help with this fix -- Added error Squiz.Commenting.FunctionCommentThrowTag.Missing to ensure a throw is documented -- Removed error Squiz.Commenting.FunctionCommentThrowTag.WrongType -- Content passed via STDIN can now specify the filename to use so that sniffs can run the correct filename checks - - Ensure the first line of the content is: phpcs_input_file: /path/to/file -- Squiz coding standard now enforces no closing PHP tag at the end of a pure PHP file -- Squiz coding standard now enforces a single newline character at the end of the file -- Squiz ClassDeclarationSniff no longer checks for a PHP ending tag after a class definition -- Squiz ControlStructureSpacingSniff now checks TRY and CATCH statements as well -- Removed MySource ChannelExceptionSniff - -## [1.5.2] - 2014-02-05 - -### Changed -- Improved support for the PHP 5.5. classname::class syntax - - PSR2 SwitchDeclarationSniff no longer throws errors when this syntax is used in CASE conditions -- Improved support for negative checks of instanceOf in Squiz ComparisonOperatorUsageSniff - - Thanks to [Martin Winkel][@storeman] for the patch -- Generic FunctionCallArgumentSpacingSniff now longer complains about space before comma when using here/nowdocs - - Thanks to [Richard van Velzen][@rvanvelzen] for the patch -- Generic LowerCaseConstantSniff and UpperCaseConstantSniff now ignore class constants - - Thanks to [Kristopher Wilson][@mrkrstphr] for the patch -- PEAR FunctionCallSignatureSniff now has settings to specify how many spaces should appear before/after parentheses - - Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change - - Default remains at 0 for both - - Thanks to [Astinus Eberhard][@Astinus-Eberhard] for the patch -- PSR2 ControlStructureSpacingSniff now has settings to specify how many spaces should appear before/after parentheses - - Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change - - Default remains at 0 for both - - Thanks to [Astinus Eberhard][@Astinus-Eberhard] for the patch -- Squiz ForEachLoopDeclarationSniff now has settings to specify how many spaces should appear before/after parentheses - - Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change - - Default remains at 0 for both - - Thanks to [Astinus Eberhard][@Astinus-Eberhard] for the patch -- Squiz ForLoopDeclarationSniff now has settings to specify how many spaces should appear before/after parentheses - - Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change - - Default remains at 0 for both - - Thanks to [Astinus Eberhard][@Astinus-Eberhard] for the patch -- Squiz FunctionDeclarationArgumentSpacingSniff now has settings to specify how many spaces should appear before/after parentheses - - Override the 'requiredSpacesAfterOpen' and 'requiredSpacesBeforeClose' settings in a ruleset.xml file to change - - Default remains at 0 for both - - Thanks to [Astinus Eberhard][@Astinus-Eberhard] for the patch -- Removed UnusedFunctionParameter, CyclomaticComplexity and NestingLevel from the Squiz standard -- Generic FixmeSniff and TodoSniff now work correctly with accented characters - -### Fixed -- Fixed bug [#20145][pear-20145] : Custom ruleset preferences directory over installed standard -- Fixed bug [#20147][pear-20147] : phpcs-svn-pre-commit - no more default error report -- Fixed bug [#20151][pear-20151] : Problem handling "if(): ... else: ... endif;" syntax -- Fixed bug [#20190][pear-20190] : Invalid regex in Squiz_Sniffs_WhiteSpace_SuperfluousWhitespaceSniff - -[pear-20145]: https://pear.php.net/bugs/bug.php?id=20145 -[pear-20147]: https://pear.php.net/bugs/bug.php?id=20147 -[pear-20151]: https://pear.php.net/bugs/bug.php?id=20151 -[pear-20190]: https://pear.php.net/bugs/bug.php?id=20190 - -## [1.5.1] - 2013-12-12 - -### Changed -- Config values can now be set at runtime using the command line argument `--runtime-set key value` - - Runtime values are the same as config values, but are not written to the main config file - - Thanks to [Wim Godden][@wimg] for the patch -- Config values can now be set in ruleset files - - e.g., config name="zend_ca_path" value="/path/to/ZendCodeAnalyzer" - - Can not be used to set config values that override command line values, such as show_warnings - - Thanks to [Jonathan Marcil][@jmarcil] for helping with the patch -- Added a new installed_paths config value to allow for the setting of directories that contain standards - - By default, standards have to be installed into the CodeSniffer/Standards directory to be considered installed - - New config value allows a list of paths to be set in addition to this internal path - - Installed standards appear when using the -i arg, and can be referenced in rulesets using only their name - - Set paths by running: phpcs --config-set installed_paths /path/one,/path/two,... -- PSR2 ClassDeclarationSniff now allows a list of extended interfaces to be split across multiple lines -- Squiz DoubleQuoteUsageSniff now allows \b in double quoted strings -- Generic ForbiddenFunctionsSniff now ignores object creation - - This is a further fix for bug [#20100][pear-20100] : incorrect Function mysql() has been deprecated report - -### Fixed -- Fixed bug [#20136][pear-20136] : Squiz_Sniffs_WhiteSpace_ScopeKeywordSpacingSniff and Traits -- Fixed bug [#20138][pear-20138] : Protected property underscore and camel caps issue (in trait with Zend) - - Thanks to [Gaetan Rousseau][@Naelyth] for the patch -- Fixed bug [#20139][pear-20139] : No report file generated on success - -[pear-20136]: https://pear.php.net/bugs/bug.php?id=20136 -[pear-20138]: https://pear.php.net/bugs/bug.php?id=20138 -[pear-20139]: https://pear.php.net/bugs/bug.php?id=20139 - -## [1.5.0] - 2013-11-28 - -### Changed -- Doc generation is now working again for installed standards - - Includes a fix for limiting the docs to specific sniffs -- Generic ScopeIndentSniff now allows for ignored tokens to be set via ruleset.xml files - - E.g., to ignore comments, override a property using: - - name="ignoreIndentationTokens" type="array" value="T_COMMENT,T_DOC_COMMENT" -- PSR2 standard now ignores comments when checking indentation rules -- Generic UpperCaseConstantNameSniff no longer reports errors where constants are used (request [#20090][pear-20090]) - - It still reports errors where constants are defined -- Individual messages can now be excluded in ruleset.xml files using the exclude tag (request [#20091][pear-20091]) - - Setting message severity to 0 continues to be supported -- Squiz OperatorSpacingSniff no longer throws errors for the ?: short ternary operator - - Thanks to [Antoine Musso][@hashar] for the patch -- Comment parser now supports non-English characters when splitting comment lines into words - - Thanks to [Nik Sun][@CandySunPlus] for the patch -- Exit statements are now recognised as valid closers for CASE and DEFAULT blocks - - Thanks to [Maksim Kochkin][@ksimka] for the patch -- PHP_CodeSniffer_CLI::process() can now be passed an incomplete array of CLI values - - Missing values will be set to the CLI defaults - - Thanks to [Maksim Kochkin][@ksimka] for the patch - -### Fixed -- Fixed bug [#20093][pear-20093] : Bug with ternary operator token -- Fixed bug [#20097][pear-20097] : `CLI.php` throws error in PHP 5.2 -- Fixed bug [#20100][pear-20100] : incorrect Function mysql() has been deprecated report -- Fixed bug [#20119][pear-20119] : PHP warning: invalid argument to str_repeat() in SVN blame report with -s -- Fixed bug [#20123][pear-20123] : PSR2 complains about an empty second statement in for-loop -- Fixed bug [#20131][pear-20131] : PHP errors in svnblame report, if there are files not under version control -- Fixed bug [#20133][pear-20133] : Allow "HG: hg_id" as value for @version tag - -[pear-20090]: https://pear.php.net/bugs/bug.php?id=20090 -[pear-20091]: https://pear.php.net/bugs/bug.php?id=20091 -[pear-20093]: https://pear.php.net/bugs/bug.php?id=20093 - -## [1.4.8] - 2013-11-26 - -### Changed -- Generic ScopeIndentSniff now allows for ignored tokens to be set via ruleset.xml files - - E.g., to ignore comments, override a property using: - - name="ignoreIndentationTokens" type="array" value="T_COMMENT,T_DOC_COMMENT" -- PSR2 standard now ignores comments when checking indentation rules -- Squiz OperatorSpacingSniff no longer throws errors for the ?: short ternary operator - - Thanks to [Antoine Musso][@hashar] for the patch -- Comment parser now supports non-English characters when splitting comment lines into words - - Thanks to [Nik Sun][@CandySunPlus] for the patch -- Exit statements are now recognised as valid closers for CASE and DEFAULT blocks - - Thanks to [Maksim Kochkin][@ksimka] for the patch -- PHP_CodeSniffer_CLI::process() can now be passed an incomplete array of CLI values - - Missing values will be set to the CLI defaults - - Thanks to [Maksim Kochkin][@ksimka] for the patch - -### Fixed -- Fixed bug [#20097][pear-20097] : `CLI.php` throws error in PHP 5.2 -- Fixed bug [#20100][pear-20100] : incorrect Function mysql() has been deprecated report -- Fixed bug [#20119][pear-20119] : PHP warning: invalid argument to str_repeat() in SVN blame report with -s -- Fixed bug [#20123][pear-20123] : PSR2 complains about an empty second statement in for-loop -- Fixed bug [#20131][pear-20131] : PHP errors in svnblame report, if there are files not under version control -- Fixed bug [#20133][pear-20133] : Allow "HG: hg_id" as value for @version tag - -[pear-20097]: https://pear.php.net/bugs/bug.php?id=20097 -[pear-20100]: https://pear.php.net/bugs/bug.php?id=20100 -[pear-20119]: https://pear.php.net/bugs/bug.php?id=20119 -[pear-20123]: https://pear.php.net/bugs/bug.php?id=20123 -[pear-20131]: https://pear.php.net/bugs/bug.php?id=20131 -[pear-20133]: https://pear.php.net/bugs/bug.php?id=20133 - -## [1.5.0RC4] - 2013-09-26 - -### Changed -- You can now restrict violations to individual sniff codes using the --sniffs command line argument - - Previously, this only restricted violations to an entire sniff and not individual messages - - If you have scripts calling PHP_CodeSniffer::process() or creating PHP_CodeSniffer_File objects, you must update your code - - The array of restrictions passed to PHP_CodeSniffer::process() must now be an array of sniff codes instead of class names - - The PHP_CodeSniffer_File::__construct() method now requires an array of restrictions to be passed -- Doc generation is now working again -- Progress information now shows the percentage complete at the end of each line -- Added report type --report=junit to show the error list in a JUnit compatible format - - Thanks to [Oleg Lobach][@bladeofsteel] for the contribution -- Added support for the PHP 5.4 callable type hint -- Fixed problem where some file content could be ignored when checking STDIN -- Version information is now printed when installed via composer or run from a Git clone (request [#20050][pear-20050]) -- Added Squiz DisallowBooleanStatementSniff to ban boolean operators outside of control structure conditions -- The CSS tokenizer is now more reliable when encountering 'list' and 'break' strings -- Coding standard ignore comments can now appear instead doc blocks as well as inline comments - - Thanks to [Stuart Langley][@sjlangley] for the patch -- Generic LineLengthSniff now ignores SVN URL and Head URL comments - - Thanks to [Karl DeBisschop][@kdebisschop] for the patch -- PEAR MultiLineConditionSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- PEAR MultiLineAssignmentSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- PEAR FunctionDeclarationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- Squiz SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- Squiz CSS IndentationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Hugo Fonseca][@fonsecas72] for the patch -- Squiz and MySource File and Function comment sniffs now allow all tags and don't require a particular licence -- Squiz standard now allows lines to be 120 characters long before warning; up from 85 -- Squiz LowercaseStyleDefinitionSniff no longer throws errors for class names in nested style definitions -- Squiz ClassFileNameSniff no longer throws errors when checking STDIN -- Squiz CSS sniffs no longer generate errors for IE filters -- Squiz CSS IndentationSniff no longer sees comments as blank lines -- Squiz LogicalOperatorSpacingSniff now ignores whitespace at the end of a line -- Squiz.Scope.MethodScope.Missing error message now mentions 'visibility' instead of 'scope modifier' - - Thanks to [Renat Akhmedyanov][@r3nat] for the patch -- Added support for the PSR2 multi-line arguments errata -- The PSR2 standard no longer throws errors for additional spacing after a type hint -- PSR UseDeclarationSniff no longer throws errors for USE statements inside TRAITs - -### Fixed -- Fixed cases where code was incorrectly assigned the T_GOTO_LABEL token when used in a complex CASE condition -- Fixed bug [#20026][pear-20026] : Check for multi-line arrays that should be single-line is slightly wrong - - Adds new error message for single-line arrays that end with a comma -- Fixed bug [#20029][pear-20029] : ForbiddenFunction sniff incorrectly recognizes methods in USE clauses -- Fixed bug [#20043][pear-20043] : Mis-interpretation of Foo::class -- Fixed bug [#20044][pear-20044] : PSR1 camelCase check does not ignore leading underscores -- Fixed bug [#20045][pear-20045] : Errors about indentation for closures with multi-line 'use' in functions -- Fixed bug [#20051][pear-20051] : Undefined index: scope_opener / scope_closer - - Thanks to [Anthon Pang][@robocoder] for the patch - -[pear-20051]: https://pear.php.net/bugs/bug.php?id=20051 - -## [1.4.7] - 2013-09-26 - -### Changed -- Added report type --report=junit to show the error list in a JUnit compatible format - - Thanks to [Oleg Lobach][@bladeofsteel] for the contribution -- Added support for the PHP 5.4 callable type hint -- Fixed problem where some file content could be ignored when checking STDIN -- Version information is now printed when installed via composer or run from a Git clone (request [#20050][pear-20050]) -- The CSS tokenizer is now more reliable when encountering 'list' and 'break' strings -- Coding standard ignore comments can now appear instead doc blocks as well as inline comments - - Thanks to [Stuart Langley][@sjlangley] for the patch -- Generic LineLengthSniff now ignores SVN URL and Head URL comments - - Thanks to [Karl DeBisschop][@kdebisschop] for the patch -- PEAR MultiLineConditionSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- PEAR MultiLineAssignmentSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- PEAR FunctionDeclarationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- Squiz SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Szabolcs Sulik][@blerou] for the patch -- Squiz CSS IndentationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the 'indent' setting in a ruleset.xml file to change - - Thanks to [Hugo Fonseca][@fonsecas72] for the patch -- Squiz and MySource File and Function comment sniffs now allow all tags and don't require a particular licence -- Squiz LowercaseStyleDefinitionSniff no longer throws errors for class names in nested style definitions -- Squiz ClassFileNameSniff no longer throws errors when checking STDIN -- Squiz CSS sniffs no longer generate errors for IE filters -- Squiz CSS IndentationSniff no longer sees comments as blank lines -- Squiz LogicalOperatorSpacingSniff now ignores whitespace at the end of a line -- Squiz.Scope.MethodScope.Missing error message now mentions 'visibility' instead of 'scope modifier' - - Thanks to [Renat Akhmedyanov][@r3nat] for the patch -- Added support for the PSR2 multi-line arguments errata -- The PSR2 standard no longer throws errors for additional spacing after a type hint -- PSR UseDeclarationSniff no longer throws errors for USE statements inside TRAITs - -### Fixed -- Fixed bug [#20026][pear-20026] : Check for multi-line arrays that should be single-line is slightly wrong - - Adds new error message for single-line arrays that end with a comma -- Fixed bug [#20029][pear-20029] : ForbiddenFunction sniff incorrectly recognizes methods in USE clauses -- Fixed bug [#20043][pear-20043] : Mis-interpretation of Foo::class -- Fixed bug [#20044][pear-20044] : PSR1 camelCase check does not ignore leading underscores -- Fixed bug [#20045][pear-20045] : Errors about indentation for closures with multi-line 'use' in functions - -[pear-20026]: https://pear.php.net/bugs/bug.php?id=20026 -[pear-20029]: https://pear.php.net/bugs/bug.php?id=20029 -[pear-20043]: https://pear.php.net/bugs/bug.php?id=20043 -[pear-20044]: https://pear.php.net/bugs/bug.php?id=20044 -[pear-20045]: https://pear.php.net/bugs/bug.php?id=20045 -[pear-20050]: https://pear.php.net/bugs/bug.php?id=20050 - -## [1.5.0RC3] - 2013-07-25 - -### Changed -- Added report type --report=json to show the error list and total counts for all checked files - - Thanks to [Jeffrey Fisher][@jeffslofish] for the contribution -- PHP_CodeSniffer::isCamelCaps now allows for acronyms at the start of a string if the strict flag is FALSE - - acronyms are defined as at least 2 uppercase characters in a row - - e.g., the following is now valid camel caps with strict set to FALSE: XMLParser -- The PHP tokenizer now tokenizes goto labels as T_GOTO_LABEL instead of T_STRING followed by T_COLON -- The JS tokenizer now has support for the T_THROW token -- Symlinked directories inside CodeSniffer/Standards and in ruleset.xml files are now supported - - Only available since PHP 5.2.11 and 5.3.1 - - Thanks to [Maik Penz][@goatherd] for the patch -- The JS tokenizer now correctly identifies T_INLINE_ELSE tokens instead of leaving them as T_COLON - - Thanks to [Arnout Boks][@aboks] for the patch -- Explaining a standard (phpcs -e) that uses namespaces now works correctly -- Restricting a check to specific sniffs (phpcs --sniffs=...) now works correctly with namespaced sniffs - - Thanks to [Maik Penz][@goatherd] for the patch -- Docs added for the entire Generic standard, and many sniffs from other standards are now documented as well - - Thanks to [Spencer Rinehart][@nubs] for the contribution -- Clearer error message for when the sniff class name does not match the directory structure -- Generated HTML docs now correctly show the open PHP tag in code comparison blocks -- Added Generic InlineHTMLSniff to ensure a file only contains PHP code -- Added Squiz ShorthandSizeSniff to check that CSS sizes are using shorthand notation only when 1 or 2 values are used -- Added Squiz ForbiddenStylesSniff to ban the use of some deprecated browser-specific styles -- Added Squiz NamedColoursSniff to ban the use of colour names -- PSR2 standard no longer enforces no whitespace between the closing parenthesis of a function call and the semicolon -- PSR2 ClassDeclarationSniff now ignores empty classes when checking the end brace position -- PSR2 SwitchDeclarationSniff no longer reports errors for empty lines between CASE statements -- PEAR ObjectOperatorIndentSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the indent setting in a ruleset.xml file to change - - Thanks to [Andrey Mindubaev][@covex-nn] for the patch -- Squiz FileExtensionSniff now supports traits - - Thanks to [Lucas Green][@mythril] for the patch -- Squiz ArrayDeclarationSniff no longer reports errors for no comma at the end of a line that contains a function call -- Squiz SwitchDeclarationSniff now supports T_CONTINUE and T_THROW as valid case/default breaking statements -- Squiz CommentedOutCodeSniff is now better at ignoring commented out HTML, XML and regular expressions -- Squiz DisallowComparisonAssignmentSniff no longer throws errors for the third expression in a FOR statement -- Squiz ColourDefinitionSniff no longer throws errors for some CSS class names -- Squiz ControlStructureSpacingSniff now supports all types of CASE/DEFAULT breaking statements -- Generic CallTimePassByReferenceSniff now reports errors for functions called using a variable - - Thanks to [Maik Penz][@goatherd] for the patch -- Generic ConstructorNameSniff no longer throws a notice for abstract constructors inside abstract classes - - Thanks to [Spencer Rinehart][@nubs] for the patch -- Squiz ComparisonOperatorUsageSniff now checks inside elseif statements - - Thanks to [Arnout Boks][@aboks] for the patch -- Squiz OperatorSpacingSniff now reports errors for no spacing around inline then and else tokens - - Thanks to [Arnout Boks][@aboks] for the patch - -### Fixed -- Fixed bug [#19811][pear-19811] : Comments not ignored in all cases in AbstractPatternSniff - - Thanks to [Erik Wiffin][@erikwiffin] for the patch -- Fixed bug [#19892][pear-19892] : ELSE with no braces causes incorrect SWITCH break statement indentation error -- Fixed bug [#19897][pear-19897] : Indenting warnings in templates not consistent -- Fixed bug [#19908][pear-19908] : PEAR MultiLineCondition Does Not Apply elseif -- Fixed bug [#19930][pear-19930] : option --report-file generate an empty file -- Fixed bug [#19935][pear-19935] : notify-send reports do not vanish in gnome-shell - - Thanks to [Christian Weiske][@cweiske] for the patch -- Fixed bug [#19944][pear-19944] : docblock squiz sniff "return void" trips over return in lambda function -- Fixed bug [#19953][pear-19953] : PSR2 - Spaces before interface name for abstract class -- Fixed bug [#19956][pear-19956] : phpcs warns for Type Hint missing Resource -- Fixed bug [#19957][pear-19957] : Does not understand trait method aliasing -- Fixed bug [#19968][pear-19968] : Permission denied on excluded directory -- Fixed bug [#19969][pear-19969] : Sniffs with namespace not recognized in reports -- Fixed bug [#19997][pear-19997] : Class names incorrectly detected as constants - -[pear-19930]: https://pear.php.net/bugs/bug.php?id=19930 - -## [1.4.6] - 2013-07-25 - -### Changed -- Added report type --report=json to show the error list and total counts for all checked files - - Thanks to [Jeffrey Fisher][@jeffslofish] for the contribution -- The JS tokenizer now has support for the T_THROW token -- Symlinked directories inside CodeSniffer/Standards and in ruleset.xml files are now supported - - Only available since PHP 5.2.11 and 5.3.1 - - Thanks to [Maik Penz][@goatherd] for the patch -- The JS tokenizer now correctly identifies T_INLINE_ELSE tokens instead of leaving them as T_COLON - - Thanks to [Arnout Boks][@aboks] for the patch -- Explaining a standard (phpcs -e) that uses namespaces now works correctly -- Restricting a check to specific sniffs (phpcs --sniffs=...) now works correctly with namespaced sniffs - - Thanks to [Maik Penz][@goatherd] for the patch -- Docs added for the entire Generic standard, and many sniffs from other standards are now documented as well - - Thanks to [Spencer Rinehart][@nubs] for the contribution -- Clearer error message for when the sniff class name does not match the directory structure -- Generated HTML docs now correctly show the open PHP tag in code comparison blocks -- Added Generic InlineHTMLSniff to ensure a file only contains PHP code -- Added Squiz ShorthandSizeSniff to check that CSS sizes are using shorthand notation only when 1 or 2 values are used -- Added Squiz ForbiddenStylesSniff to ban the use of some deprecated browser-specific styles -- Added Squiz NamedColoursSniff to ban the use of colour names -- PSR2 standard no longer enforces no whitespace between the closing parenthesis of a function call and the semicolon -- PSR2 ClassDeclarationSniff now ignores empty classes when checking the end brace position -- PSR2 SwitchDeclarationSniff no longer reports errors for empty lines between CASE statements -- PEAR ObjectOperatorIndentSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the indent setting in a ruleset.xml file to change - - Thanks to [Andrey Mindubaev][@covex-nn] for the patch -- Squiz FileExtensionSniff now supports traits - - Thanks to [Lucas Green][@mythril] for the patch -- Squiz ArrayDeclarationSniff no longer reports errors for no comma at the end of a line that contains a function call -- Squiz SwitchDeclarationSniff now supports T_CONTINUE and T_THROW as valid case/default breaking statements -- Squiz CommentedOutCodeSniff is now better at ignoring commented out HTML, XML and regular expressions -- Squiz DisallowComparisonAssignmentSniff no longer throws errors for the third expression in a FOR statement -- Squiz ColourDefinitionSniff no longer throws errors for some CSS class names -- Squiz ControlStructureSpacingSniff now supports all types of CASE/DEFAULT breaking statements -- Generic CallTimePassByReferenceSniff now reports errors for functions called using a variable - - Thanks to [Maik Penz][@goatherd] for the patch -- Generic ConstructorNameSniff no longer throws a notice for abstract constructors inside abstract classes - - Thanks to [Spencer Rinehart][@nubs] for the patch -- Squiz ComparisonOperatorUsageSniff now checks inside elseif statements - - Thanks to [Arnout Boks][@aboks] for the patch -- Squiz OperatorSpacingSniff now reports errors for no spacing around inline then and else tokens - - Thanks to [Arnout Boks][@aboks] for the patch - -### Fixed -- Fixed bug [#19811][pear-19811] : Comments not ignored in all cases in AbstractPatternSniff - - Thanks to [Erik Wiffin][@erikwiffin] for the patch -- Fixed bug [#19892][pear-19892] : ELSE with no braces causes incorrect SWITCH break statement indentation error -- Fixed bug [#19897][pear-19897] : Indenting warnings in templates not consistent -- Fixed bug [#19908][pear-19908] : PEAR MultiLineCondition Does Not Apply elseif -- Fixed bug [#19913][pear-19913] : Running phpcs in interactive mode causes warnings - - Thanks to [Harald Franndorfer][pear-gemineye] for the patch -- Fixed bug [#19935][pear-19935] : notify-send reports do not vanish in gnome-shell - - Thanks to [Christian Weiske][@cweiske] for the patch -- Fixed bug [#19944][pear-19944] : docblock squiz sniff "return void" trips over return in lambda function -- Fixed bug [#19953][pear-19953] : PSR2 - Spaces before interface name for abstract class -- Fixed bug [#19956][pear-19956] : phpcs warns for Type Hint missing Resource -- Fixed bug [#19957][pear-19957] : Does not understand trait method aliasing -- Fixed bug [#19968][pear-19968] : Permission denied on excluded directory -- Fixed bug [#19969][pear-19969] : Sniffs with namespace not recognized in reports -- Fixed bug [#19997][pear-19997] : Class names incorrectly detected as constants - -[pear-19811]: https://pear.php.net/bugs/bug.php?id=19811 -[pear-19892]: https://pear.php.net/bugs/bug.php?id=19892 -[pear-19897]: https://pear.php.net/bugs/bug.php?id=19897 -[pear-19908]: https://pear.php.net/bugs/bug.php?id=19908 -[pear-19913]: https://pear.php.net/bugs/bug.php?id=19913 -[pear-19935]: https://pear.php.net/bugs/bug.php?id=19935 -[pear-19944]: https://pear.php.net/bugs/bug.php?id=19944 -[pear-19953]: https://pear.php.net/bugs/bug.php?id=19953 -[pear-19956]: https://pear.php.net/bugs/bug.php?id=19956 -[pear-19957]: https://pear.php.net/bugs/bug.php?id=19957 -[pear-19968]: https://pear.php.net/bugs/bug.php?id=19968 -[pear-19969]: https://pear.php.net/bugs/bug.php?id=19969 -[pear-19997]: https://pear.php.net/bugs/bug.php?id=19997 - -## [1.5.0RC2] - 2013-04-04 - -### Changed -- Ruleset processing has been rewritten to be more predictable - - Provides much better support for relative paths inside ruleset files - - May mean that sniffs that were previously ignored are now being included when importing external rulesets - - Ruleset processing output can be seen by using the -vv command line argument - - Internal sniff registering functions have all changed, so please review custom scripts -- You can now pass multiple coding standards on the command line, comma separated (request [#19144][pear-19144]) - - Works with built-in or custom standards and rulesets, or a mix of both -- You can now exclude directories or whole standards in a ruleset XML file (request [#19731][pear-19731]) - - e.g., exclude "Generic.Commenting" or just "Generic" - - You can also pass in a path to a directory instead, if you know it -- Added Generic LowerCaseKeywordSniff to ensure all PHP keywords are defined in lowercase - - The PSR2 and Squiz standards now use this sniff -- Added Generic SAPIUsageSniff to ensure the `PHP_SAPI` constant is used instead of `php_sapi_name()` (request [#19863][pear-19863]) -- Squiz FunctionSpacingSniff now has a setting to specify how many lines there should between functions (request [#19843][pear-19843]) - - Default remains at 2 - - Override the "spacing" setting in a ruleset.xml file to change -- Squiz LowercasePHPFunctionSniff no longer throws errors for the limited set of PHP keywords it was checking - - Add a rule for Generic.PHP.LowerCaseKeyword to your ruleset to replicate this functionality -- Added support for the PHP 5.4 T_CALLABLE token so it can be used in lower PHP versions -- Generic EndFileNoNewlineSniff now supports checking of CSS and JS files -- PSR2 SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the indent setting in a ruleset.xml file to change - - Thanks to [Asher Snyder][@asnyder] for the patch -- Generic ScopeIndentSniff now has a setting to specify a list of tokens that should be ignored - - The first token on the line is checked and the whole line is ignored if the token is in the array - - Thanks to [Eloy Lafuente][@stronk7] for the patch -- Squiz LowercaseClassKeywordsSniff now checks for the TRAIT keyword - - Thanks to [Anthon Pang][@robocoder] for the patch -- If you create your own PHP_CodeSniffer object, PHPCS will no longer exit when an unknown argument is found - - This allows you to create wrapper scripts for PHPCS more easily -- PSR2 MethodDeclarationSniff no longer generates a notice for methods named "_" - - Thanks to [Bart S][@zBart] for the patch -- Squiz BlockCommentSniff no longer reports that a blank line between a scope closer and block comment is invalid -- Generic DuplicateClassNameSniff no longer reports an invalid error if multiple PHP open tags exist in a file -- Generic DuplicateClassNameSniff no longer reports duplicate errors if multiple PHP open tags exist in a file - -### Fixed -- Fixed bug [#19819][pear-19819] : Freeze with syntax error in use statement -- Fixed bug [#19820][pear-19820] : Wrong message level in Generic_Sniffs_CodeAnalysis_EmptyStatementSniff -- Fixed bug [#19859][pear-19859] : CodeSniffer::setIgnorePatterns API changed -- Fixed bug [#19871][pear-19871] : findExtendedClassName doesn't return FQCN on namespaced classes -- Fixed bug [#19879][pear-19879] : bitwise and operator interpreted as reference by value - -[pear-19144]: https://pear.php.net/bugs/bug.php?id=19144 -[pear-19731]: https://pear.php.net/bugs/bug.php?id=19731 - -## [1.4.5] - 2013-04-04 - -### Changed -- Added Generic LowerCaseKeywordSniff to ensure all PHP keywords are defined in lowercase - - The PSR2 and Squiz standards now use this sniff -- Added Generic SAPIUsageSniff to ensure the `PHP_SAPI` constant is used instead of `php_sapi_name()` (request [#19863][pear-19863]) -- Squiz FunctionSpacingSniff now has a setting to specify how many lines there should between functions (request [#19843][pear-19843]) - - Default remains at 2 - - Override the "spacing" setting in a ruleset.xml file to change -- Squiz LowercasePHPFunctionSniff no longer throws errors for the limited set of PHP keywords it was checking - - Add a rule for Generic.PHP.LowerCaseKeyword to your ruleset to replicate this functionality -- Added support for the PHP 5.4 T_CALLABLE token so it can be used in lower PHP versions -- Generic EndFileNoNewlineSniff now supports checking of CSS and JS files -- PSR2 SwitchDeclarationSniff now has a setting to specify how many spaces code should be indented - - Default remains at 4; override the indent setting in a ruleset.xml file to change - - Thanks to [Asher Snyder][@asnyder] for the patch -- Generic ScopeIndentSniff now has a setting to specify a list of tokens that should be ignored - - The first token on the line is checked and the whole line is ignored if the token is in the array - - Thanks to [Eloy Lafuente][@stronk7] for the patch -- Squiz LowercaseClassKeywordsSniff now checks for the TRAIT keyword - - Thanks to [Anthon Pang][@robocoder] for the patch -- If you create your own PHP_CodeSniffer object, PHPCS will no longer exit when an unknown argument is found - - This allows you to create wrapper scripts for PHPCS more easily -- PSR2 MethodDeclarationSniff no longer generates a notice for methods named "_" - - Thanks to [Bart S][@zBart] for the patch -- Squiz BlockCommentSniff no longer reports that a blank line between a scope closer and block comment is invalid -- Generic DuplicateClassNameSniff no longer reports an invalid error if multiple PHP open tags exist in a file -- Generic DuplicateClassNameSniff no longer reports duplicate errors if multiple PHP open tags exist in a file - -### Fixed -- Fixed bug [#19819][pear-19819] : Freeze with syntax error in use statement -- Fixed bug [#19820][pear-19820] : Wrong message level in Generic_Sniffs_CodeAnalysis_EmptyStatementSniff -- Fixed bug [#19859][pear-19859] : CodeSniffer::setIgnorePatterns API changed -- Fixed bug [#19871][pear-19871] : findExtendedClassName doesn't return FQCN on namespaced classes -- Fixed bug [#19879][pear-19879] : bitwise and operator interpreted as reference by value - -[pear-19819]: https://pear.php.net/bugs/bug.php?id=19819 -[pear-19820]: https://pear.php.net/bugs/bug.php?id=19820 -[pear-19843]: https://pear.php.net/bugs/bug.php?id=19843 -[pear-19859]: https://pear.php.net/bugs/bug.php?id=19859 -[pear-19863]: https://pear.php.net/bugs/bug.php?id=19863 -[pear-19871]: https://pear.php.net/bugs/bug.php?id=19871 -[pear-19879]: https://pear.php.net/bugs/bug.php?id=19879 - -## [1.5.0RC1] - 2013-02-08 - -### Changed -- Reports have been completely rewritten to consume far less memory - - Each report is incrementally written to the file system during a run and then printed out when the run ends - - There is no longer a need to keep the list of errors and warnings in memory during a run -- Multi-file sniff support has been removed because they are too memory intensive - - If you have a custom multi-file sniff, you can convert it into a standard sniff quite easily - - See `CodeSniffer/Standards/Generic/Sniffs/Classes/DuplicateClassNameSniff.php` for an example - -## [1.4.4] - 2013-02-07 - -### Changed -- Ignored lines no longer cause the summary report to show incorrect error and warning counts - - Thanks to [Bert Van Hauwaert][@becoded] for the patch -- Added Generic CSSLintSniff to run CSSLint over a CSS file and report warnings - - Set full command to run CSSLint using phpcs --config-set csslint_path /path/to/csslint - - Thanks to [Roman Levishchenko][@index0h] for the contribution -- Added PSR2 ControlStructureSpacingSniff to ensure there are no spaces before and after parenthesis in control structures - - Fixes bug [#19732][pear-19732] : PSR2: some control structures errors not reported -- Squiz commenting sniffs now support non-English characters when checking for capital letters - - Thanks to [Roman Levishchenko][@index0h] for the patch -- Generic EndFileNewlineSniff now supports JS and CSS files - - Thanks to [Denis Ryabkov][@dryabkov] for the patch -- PSR1 SideEffectsSniff no longer reports constant declarations as side effects -- Notifysend report now supports notify-send versions before 0.7.3 - - Thanks to [Ken Guest][@kenguest] for the patch -- PEAR and Squiz FunctionCommentSniffs no longer report errors for misaligned argument comments when they are blank - - Thanks to [Thomas Peterson][@boonkerz] for the patch -- Squiz FunctionDeclarationArgumentSpacingSniff now works correctly for equalsSpacing values greater than 0 - - Thanks to [Klaus Purer][@klausi] for the patch -- Squiz SuperfluousWhitespaceSniff no longer throws errors for CSS files with no newline at the end -- Squiz SuperfluousWhitespaceSniff now allows a single newline at the end of JS and CSS files - -### Fixed -- Fixed bug [#19755][pear-19755] : Token of T_CLASS type has no scope_opener and scope_closer keys -- Fixed bug [#19759][pear-19759] : Squiz.PHP.NonExecutableCode fails for return function()... -- Fixed bug [#19763][pear-19763] : Use statements for traits not recognised correctly for PSR2 code style -- Fixed bug [#19764][pear-19764] : Instead of for traits throws uppercase constant name errors -- Fixed bug [#19772][pear-19772] : PSR2_Sniffs_Namespaces_UseDeclarationSniff does not properly recognize last use -- Fixed bug [#19775][pear-19775] : False positive in NonExecutableCode sniff when not using curly braces -- Fixed bug [#19782][pear-19782] : Invalid found size functions in loop when using object operator -- Fixed bug [#19799][pear-19799] : config folder is not created automatically -- Fixed bug [#19804][pear-19804] : JS Tokenizer wrong /**/ parsing - -[pear-19732]: https://pear.php.net/bugs/bug.php?id=19732 -[pear-19755]: https://pear.php.net/bugs/bug.php?id=19755 -[pear-19759]: https://pear.php.net/bugs/bug.php?id=19759 -[pear-19763]: https://pear.php.net/bugs/bug.php?id=19763 -[pear-19764]: https://pear.php.net/bugs/bug.php?id=19764 -[pear-19772]: https://pear.php.net/bugs/bug.php?id=19772 -[pear-19775]: https://pear.php.net/bugs/bug.php?id=19775 -[pear-19782]: https://pear.php.net/bugs/bug.php?id=19782 -[pear-19799]: https://pear.php.net/bugs/bug.php?id=19799 -[pear-19804]: https://pear.php.net/bugs/bug.php?id=19804 - -## [1.4.3] - 2012-12-04 - -### Changed -- Added support for the PHP 5.5 T_FINALLY token to detect try/catch/finally statements -- Added empty CodeSniffer.conf to enable config settings for Composer installs -- Added Generic EndFileNoNewlineSniff to ensure there is no newline at the end of a file -- Autoloader can now load PSR-0 compliant classes - - Thanks to [Maik Penz][@goatherd] for the patch -- Squiz NonExecutableCodeSniff no longer throws error for multi-line RETURNs inside CASE statements - - Thanks to [Marc Ypes][@ceeram] for the patch -- Squiz OperatorSpacingSniff no longer reports errors for negative numbers inside inline THEN statements - - Thanks to [Klaus Purer][@klausi] for the patch -- Squiz OperatorSpacingSniff no longer reports errors for the assignment of operations involving negative numbers -- Squiz SelfMemberReferenceSniff can no longer get into an infinite loop when checking a static call with a namespace - - Thanks to [Andy Grunwald][@andygrunwald] for the patch - -### Fixed -- Fixed bug [#19699][pear-19699] : Generic.Files.LineLength giving false positives when tab-width is used -- Fixed bug [#19726][pear-19726] : Wrong number of spaces expected after instanceof static -- Fixed bug [#19727][pear-19727] : PSR2: no error reported when using } elseif { - -[pear-19699]: https://pear.php.net/bugs/bug.php?id=19699 -[pear-19726]: https://pear.php.net/bugs/bug.php?id=19726 -[pear-19727]: https://pear.php.net/bugs/bug.php?id=19727 - -## [1.4.2] - 2012-11-09 - -### Changed -- PHP_CodeSniffer can now be installed using Composer - - Require `squizlabs/php_codesniffer` in your `composer.json` file - - Thanks to [Rob Bast][@alcohol], [Stephen Rees-Carter][@valorin], [Stefano Kowalke][@Konafets] and [Ivan Habunek][@ihabunek] for help with this -- Squiz BlockCommentSniff and InlineCommentSniff no longer report errors for trait block comments -- Squiz SelfMemberReferenceSniff now supports namespaces - - Thanks to [Andy Grunwald][@andygrunwald] for the patch -- Squiz FileCommentSniff now uses tag names inside the error codes for many messages - - This allows you to exclude specific missing, out of order etc., tags -- Squiz SuperfluousWhitespaceSniff now has an option to ignore blank lines - - This will stop errors being reported for lines that contain only whitespace - - Set the ignoreBlankLines property to TRUE in your ruleset.xml file to enable this -- PSR2 no longer reports errors for whitespace at the end of blank lines - -### Fixed -- Fixed gitblame report not working on Windows - - Thanks to [Rogerio Prado de Jesus][@rogeriopradoj] -- Fixed an incorrect error in Squiz OperatorSpacingSniff for default values inside a closure definition -- Fixed bug [#19691][pear-19691] : SubversionPropertiesSniff fails to find missing properties - - Thanks to [Kevin Winahradsky][pear-kwinahradsky] for the patch -- Fixed bug [#19692][pear-19692] : DisallowMultipleAssignments is triggered by a closure -- Fixed bug [#19693][pear-19693] : exclude-patterns no longer work on specific messages -- Fixed bug [#19694][pear-19694] : Squiz.PHP.LowercasePHPFunctions incorrectly matches return by ref functions - -[pear-19691]: https://pear.php.net/bugs/bug.php?id=19691 -[pear-19692]: https://pear.php.net/bugs/bug.php?id=19692 -[pear-19693]: https://pear.php.net/bugs/bug.php?id=19693 -[pear-19694]: https://pear.php.net/bugs/bug.php?id=19694 - -## [1.4.1] - 2012-11-02 - -### Changed -- All ignore patterns have been reverted to being checked against the absolute path of a file - - Patterns can be specified to be relative in a ruleset.xml file, but nowhere else - - e.g., `^tests/*` -- Added support for PHP tokenizing of T_INLINE_ELSE colons, so this token type is now available - - Custom sniffs that rely on looking for T_COLON tokens inside inline if statements must be changed to use the new token - - Fixes bug [#19666][pear-19666] : PSR1.Files.SideEffects throws a notice Undefined index: scope_closer -- Messages can now be changed from errors to warnings (and vice versa) inside ruleset.xml files - - As you would with "message" and "severity", specify a "type" tag under a "rule" tag and set the value to "error" or "warning" -- PHP_CodeSniffer will now generate a warning on files that it detects have mixed line endings - - This warning has the code Internal.LineEndings.Mixed and can be overridden in a ruleset.xml file - - Thanks to [Vit Brunner][@tasuki] for help with this -- Sniffs inside PHP 5.3 namespaces are now supported, along with the existing underscore-style emulated namespaces - - For example: namespace MyStandard\Sniffs\Arrays; class ArrayDeclarationSniff implements \PHP_CodeSniffer_Sniff { ... - - Thanks to [Till Klampaeckel][@till] for the patch -- Generic DuplicateClassNameSniff is no longer a multi-file sniff, so it won't max out your memory - - Multi-file sniff support should be considered deprecated as standard sniffs can now do the same thing -- Added Generic DisallowSpaceIndent to check that files are indented using tabs -- Added Generic OneClassPerFileSniff to check that only one class is defined in each file - - Thanks to [Andy Grunwald][@andygrunwald] for the contribution -- Added Generic OneInterfacePerFileSniff to check that only one interface is defined in each file - - Thanks to [Andy Grunwald][@andygrunwald] for the contribution -- Added Generic LowercasedFilenameSniff to check that filenames are lowercase - - Thanks to [Andy Grunwald][@andygrunwald] for the contribution -- Added Generic ClosingPHPTagSniff to check that each open PHP tag has a corresponding close tag - - Thanks to [Andy Grunwald][@andygrunwald] for the contribution -- Added Generic CharacterBeforePHPOpeningTagSniff to check that the open PHP tag is the first content in a file - - Thanks to [Andy Grunwald][@andygrunwald] for the contribution -- Fixed incorrect errors in Squiz OperatorBracketSniff and OperatorSpacingSniff for negative numbers in CASE statements - - Thanks to [Arnout Boks][@aboks] for the patch -- Generic CamelCapsFunctionNameSniff no longer enforces exact case matching for PHP magic methods -- Generic CamelCapsFunctionNameSniff no longer throws errors for overridden SOAPClient methods prefixed with double underscores - - Thanks to [Dorian Villet][@gnutix] for the patch -- PEAR ValidFunctionNameSniff now supports traits -- PSR1 ClassDeclarationSniff no longer throws an error for non-namespaced code if PHP version is less than 5.3.0 - -### Fixed -- Fixed bug [#19616][pear-19616] : Nested switches cause false error in PSR2 -- Fixed bug [#19629][pear-19629] : PSR2 error for inline comments on multi-line argument lists -- Fixed bug [#19644][pear-19644] : Alternative syntax, e.g. if/endif triggers Inline Control Structure error -- Fixed bug [#19655][pear-19655] : Closures reporting as multi-line when they are not -- Fixed bug [#19675][pear-19675] : Improper indent of nested anonymous function bodies in a call -- Fixed bug [#19685][pear-19685] : PSR2 catch-22 with empty third statement in for loop -- Fixed bug [#19687][pear-19687] : Anonymous functions inside arrays marked as indented incorrectly in PSR2 - -[pear-19616]: https://pear.php.net/bugs/bug.php?id=19616 -[pear-19629]: https://pear.php.net/bugs/bug.php?id=19629 -[pear-19644]: https://pear.php.net/bugs/bug.php?id=19644 -[pear-19655]: https://pear.php.net/bugs/bug.php?id=19655 -[pear-19666]: https://pear.php.net/bugs/bug.php?id=19666 -[pear-19675]: https://pear.php.net/bugs/bug.php?id=19675 -[pear-19685]: https://pear.php.net/bugs/bug.php?id=19685 -[pear-19687]: https://pear.php.net/bugs/bug.php?id=19687 - -## [1.4.0] - 2012-09-26 - -### Changed -- Added PSR1 and PSR2 coding standards that can be used to check your code against these guidelines -- PHP 5.4 short array syntax is now detected and tokens are assigned to the open and close characters - - New tokens are T_OPEN_SHORT_ARRAY and T_CLOSE_SHORT_ARRAY as PHP does not define its own -- Added the ability to explain a coding standard by listing the sniffs that it includes - - The sniff list includes all imported and native sniffs - - Explain a standard by using the `-e` and `--standard=[standard]` command line arguments - - E.g., `phpcs -e --standard=Squiz` - - Thanks to [Ben Selby][@benmatselby] for the idea -- Added report to show results using notify-send - - Use --report=notifysend to generate the report - - Thanks to [Christian Weiske][@cweiske] for the contribution -- The JS tokenizer now recognises RETURN as a valid closer for CASE and DEFAULT inside switch statements -- AbstractPatternSniff now sets the ignoreComments option using a public var rather than through the constructor - - This allows the setting to be overwritten in ruleset.xml files - - Old method remains for backwards compatibility -- Generic LowerCaseConstantSniff and UpperCaseConstantSniff no longer report errors on classes named True, False or Null -- PEAR ValidFunctionNameSniff no longer enforces exact case matching for PHP magic methods -- Squiz SwitchDeclarationSniff now allows RETURN statements to close a CASE or DEFAULT statement -- Squiz BlockCommentSniff now correctly reports an error for blank lines before blocks at the start of a control structure - -### Fixed -- Fixed a PHP notice generated when loading custom array settings from a ruleset.xml file -- Fixed bug [#17908][pear-17908] : CodeSniffer does not recognise optional @params - - Thanks to [Pete Walker][pear-pete] for the patch -- Fixed bug [#19538][pear-19538] : Function indentation code sniffer checks inside short arrays -- Fixed bug [#19565][pear-19565] : Non-Executable Code Sniff Broken for Case Statements with both return and break -- Fixed bug [#19612][pear-19612] : Invalid @package suggestion - -[pear-17908]: https://pear.php.net/bugs/bug.php?id=17908 -[pear-19538]: https://pear.php.net/bugs/bug.php?id=19538 -[pear-19565]: https://pear.php.net/bugs/bug.php?id=19565 -[pear-19612]: https://pear.php.net/bugs/bug.php?id=19612 - -## [1.3.6] - 2012-08-08 - -### Changed -- Memory usage has been dramatically reduced when using the summary report - - Reduced memory is only available when displaying a single summary report to the screen - - PHP_CodeSniffer will not generate any messages in this case, storing only error counts instead - - Impact is most notable with very high error and warning counts -- Significantly improved the performance of Squiz NonExecutableCodeSniff -- Ignore patterns now check the relative path of a file based on the dir being checked - - Allows ignore patterns to become more generic as the path to the code is no longer included when checking - - Thanks to [Kristof Coomans][@kristofser] for the patch -- Sniff settings can now be changed by specifying a special comment format inside a file - - e.g., // @codingStandardsChangeSetting PEAR.Functions.FunctionCallSignature allowMultipleArguments false - - If you change a setting, don't forget to change it back -- Added Generic EndFileNewlineSniff to ensure PHP files end with a newline character -- PEAR FunctionCallSignatureSniff now includes a setting to force one argument per line in multi-line calls - - Set allowMultipleArguments to false -- Squiz standard now enforces one argument per line in multi-line function calls -- Squiz FunctionDeclarationArgumentSpacingSniff now supports closures -- Squiz OperatorSpacingSniff no longer throws an error for negative values inside an inline THEN statement - - Thanks to [Klaus Purer][@klausi] for the patch -- Squiz FunctionCommentSniff now throws an error for not closing a comment with */ - - Thanks to [Klaus Purer][@klausi] for the patch -- Summary report no longer shows two lines of PHP_Timer output when showing sources - -### Fixed -- Fixed undefined variable error in PEAR FunctionCallSignatureSniff for lines with no indent -- Fixed bug [#19502][pear-19502] : Generic.Files.LineEndingsSniff fails if no new-lines in file -- Fixed bug [#19508][pear-19508] : switch+return: Closing brace indented incorrectly -- Fixed bug [#19532][pear-19532] : The PSR-2 standard don't recognize Null in class names -- Fixed bug [#19546][pear-19546] : Error thrown for __call() method in traits - -[pear-19502]: https://pear.php.net/bugs/bug.php?id=19502 -[pear-19508]: https://pear.php.net/bugs/bug.php?id=19508 -[pear-19532]: https://pear.php.net/bugs/bug.php?id=19532 -[pear-19546]: https://pear.php.net/bugs/bug.php?id=19546 - -## [1.3.5] - 2012-07-12 - -### Changed -- Added Generic CamelCapsFunctionNameSniff to just check if function and method names use camel caps - - Does not allow underscore prefixes for private/protected methods - - Defaults to strict checking, where two uppercase characters can not be next to each other - - Strict checking can be disabled in a ruleset.xml file -- Squiz FunctionDeclarationArgumentSpacing now has a setting to specify how many spaces should surround equals signs - - Default remains at 0 - - Override the equalsSpacing setting in a ruleset.xml file to change -- Squiz ClassDeclarationSniff now throws errors for > 1 space before extends/implements class name with ns separator -- Squiz standard now warns about deprecated functions using Generic DeprecatedFunctionsSniff -- PEAR FunctionDeclarationSniff now reports an error for multiple spaces after the FUNCTION keyword and around USE -- PEAR FunctionDeclarationSniff now supports closures -- Squiz MultiLineFunctionDeclarationSniff now supports closures -- Exclude rules written for Unix systems will now work correctly on Windows - - Thanks to [Walter Tamboer][@waltertamboer] for the patch -- The PHP tokenizer now recognises T_RETURN as a valid closer for T_CASE and T_DEFAULT inside switch statements - -### Fixed -- Fixed duplicate message codes in Generic OpeningFunctionBraceKernighanRitchieSniff -- Fixed bug [#18651][pear-18651] : PHPUnit Test cases for custom standards are not working on Windows -- Fixed bug [#19416][pear-19416] : Shorthand arrays cause bracket spacing errors -- Fixed bug [#19421][pear-19421] : phpcs doesn't recognize ${x} as equivalent to $x -- Fixed bug [#19428][pear-19428] : PHPCS Report "hgblame" doesn't support windows paths - - Thanks to [Justin Rovang][@rovangju] for the patch -- Fixed bug [#19448][pear-19448] : Problem with detecting remote standards -- Fixed bug [#19463][pear-19463] : Anonymous functions incorrectly being flagged by NonExecutableCodeSniff -- Fixed bug [#19469][pear-19469] : PHP_CodeSniffer_File::getMemberProperties() sets wrong scope -- Fixed bug [#19471][pear-19471] : phpcs on Windows, when using Zend standard, doesn't catch problems - - Thanks to [Ivan Habunek][@ihabunek] for the patch -- Fixed bug [#19478][pear-19478] : Incorrect indent detection in PEAR standard - - Thanks to [Shane Auckland][@shanethehat] for the patch -- Fixed bug [#19483][pear-19483] : Blame Reports fail with space in directory name - -[pear-18651]: https://pear.php.net/bugs/bug.php?id=18651 -[pear-19416]: https://pear.php.net/bugs/bug.php?id=19416 -[pear-19421]: https://pear.php.net/bugs/bug.php?id=19421 -[pear-19428]: https://pear.php.net/bugs/bug.php?id=19428 -[pear-19448]: https://pear.php.net/bugs/bug.php?id=19448 -[pear-19463]: https://pear.php.net/bugs/bug.php?id=19463 -[pear-19469]: https://pear.php.net/bugs/bug.php?id=19469 -[pear-19471]: https://pear.php.net/bugs/bug.php?id=19471 -[pear-19478]: https://pear.php.net/bugs/bug.php?id=19478 -[pear-19483]: https://pear.php.net/bugs/bug.php?id=19483 - -## [1.3.4] - 2012-05-17 - -### Changed -- Added missing package.xml entries for new Generic FixmeSniff - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Expected indents for PEAR ScopeClosingBraceSniff and FunctionCallSignatureSniff can now be set in ruleset files - - Both sniffs use a variable called "indent" - - Thanks to [Thomas Despoix][pear-tomdesp] for the patch -- Standards designed to be installed in the PHPCS Standards dir will now work outside this dir as well - - In particular, allows the Drupal CS to work without needing to symlink it into the PHPCS install - - Thanks to [Peter Philipp][@das-peter] for the patch -- Rule references for standards, directories and specific sniffs can now be relative in ruleset.xml files - - For example: `ref="../MyStandard/Sniffs/Commenting/DisallowHashCommentsSniff.php"` -- Symlinked standards now work correctly, allowing aliasing of installed standards (request [#19417][pear-19417]) - - Thanks to [Tom Klingenberg][@ktomk] for the patch -- Squiz ObjectInstantiationSniff now allows objects to be returned without assigning them to a variable -- Added Squiz.Commenting.FileComment.MissingShort error message for file comments that only contains tags - - Also stops undefined index errors being generated for these comments -- Debug option -vv now shows tokenizer status for CSS files -- Added support for new gjslint error formats - - Thanks to [Meck][@yesmeck] for the patch -- Generic ScopeIndentSniff now allows comment indents to not be exact even if the exact flag is set - - The start of the comment is still checked for exact indentation as normal -- Fixed an issue in AbstractPatternSniff where comments were not being ignored in some cases -- Fixed an issue in Zend ClosingTagSniff where the closing tag was not always being detected correctly - - Thanks to [Jonathan Robson][@jnrbsn] for the patch -- Fixed an issue in Generic FunctionCallArgumentSpacingSniff where closures could cause incorrect errors -- Fixed an issue in Generic UpperCaseConstantNameSniff where errors were incorrectly reported on goto statements - - Thanks to [Tom Klingenberg][@ktomk] for the patch -- PEAR FileCommentSniff and ClassCommentSniff now support author emails with a single character in the local part - - E.g., `a@me.com` - - Thanks to Denis Shapkin for the patch - -### Fixed -- Fixed bug [#19290][pear-19290] : Generic indent sniffer fails for anonymous functions -- Fixed bug [#19324][pear-19324] : Setting show_warnings configuration option does not work -- Fixed bug [#19354][pear-19354] : Not recognizing references passed to method -- Fixed bug [#19361][pear-19361] : CSS tokenizer generates errors when PHP embedded in CSS file -- Fixed bug [#19374][pear-19374] : HEREDOC/NOWDOC Indentation problems -- Fixed bug [#19381][pear-19381] : traits and indentations in traits are not handled properly -- Fixed bug [#19394][pear-19394] : Notice in NonExecutableCodeSniff -- Fixed bug [#19402][pear-19402] : Syntax error when executing phpcs on Windows with parens in PHP path - - Thanks to [Tom Klingenberg][@ktomk] for the patch -- Fixed bug [#19411][pear-19411] : magic method error on __construct() - - The fix required a rewrite of AbstractScopeSniff, so please test any sniffs that extend this class -- Fixed bug [#19412][pear-19412] : Incorrect error about assigning objects to variables when inside inline IF -- Fixed bug [#19413][pear-19413] : PHP_CodeSniffer thinks I haven't used a parameter when I have -- Fixed bug [#19414][pear-19414] : PHP_CodeSniffer seems to not track variables correctly in heredocs - -[pear-19290]: https://pear.php.net/bugs/bug.php?id=19290 -[pear-19324]: https://pear.php.net/bugs/bug.php?id=19324 -[pear-19354]: https://pear.php.net/bugs/bug.php?id=19354 -[pear-19361]: https://pear.php.net/bugs/bug.php?id=19361 -[pear-19374]: https://pear.php.net/bugs/bug.php?id=19374 -[pear-19381]: https://pear.php.net/bugs/bug.php?id=19381 -[pear-19394]: https://pear.php.net/bugs/bug.php?id=19394 -[pear-19402]: https://pear.php.net/bugs/bug.php?id=19402 -[pear-19411]: https://pear.php.net/bugs/bug.php?id=19411 -[pear-19412]: https://pear.php.net/bugs/bug.php?id=19412 -[pear-19413]: https://pear.php.net/bugs/bug.php?id=19413 -[pear-19414]: https://pear.php.net/bugs/bug.php?id=19414 -[pear-19417]: https://pear.php.net/bugs/bug.php?id=19417 - -## [1.3.3] - 2012-02-07 - -### Changed -- Added new Generic FixmeSniff that shows error messages for all FIXME comments left in your code - - Thanks to [Sam Graham][@illusori] for the contribution -- The maxPercentage setting in the Squiz CommentedOutCodeSniff can now be overridden in a ruleset.xml file - - Thanks to [Volker Dusch][@edorian] for the patch -- The Checkstyle and XML reports now use XMLWriter - - Only change in output is that empty file tags are no longer produced for files with no violations - - Thanks to [Sebastian Bergmann][@sebastianbergmann] for the patch -- Added PHP_CodeSniffer_Tokens::$bracketTokens to give sniff writers fast access to open and close bracket tokens -- Fixed an issue in AbstractPatternSniff where EOL tokens were not being correctly checked in some cases -- PHP_CodeSniffer_File::getTokensAsString() now detects incorrect length value (request [#19313][pear-19313]) - -### Fixed -- Fixed bug [#19114][pear-19114] : CodeSniffer checks extension even for single file -- Fixed bug [#19171][pear-19171] : Show sniff codes option is ignored by some report types - - Thanks to [Dominic Scheirlinck][@dominics] for the patch -- Fixed bug [#19188][pear-19188] : Lots of PHP Notices when analyzing the Symfony framework - - First issue was list-style.. lines in CSS files not properly adjusting open/close bracket positions - - Second issue was notices caused by bug [#19137][pear-19137] -- Fixed bug [#19208][pear-19208] : UpperCaseConstantName reports class members - - Was also a problem with LowerCaseConstantName as well -- Fixed bug [#19256][pear-19256] : T_DOC_COMMENT in CSS files breaks ClassDefinitionNameSpacingSniff - - Thanks to [Klaus Purer][@klausi] for the patch -- Fixed bug [#19264][pear-19264] : Squiz.PHP.NonExecutableCode does not handle RETURN in CASE without BREAK -- Fixed bug [#19270][pear-19270] : DuplicateClassName does not handle namespaces correctly -- Fixed bug [#19283][pear-19283] : CSS @media rules cause false positives - - Thanks to [Klaus Purer][@klausi] for the patch - -[pear-19114]: https://pear.php.net/bugs/bug.php?id=19114 -[pear-19137]: https://pear.php.net/bugs/bug.php?id=19137 -[pear-19171]: https://pear.php.net/bugs/bug.php?id=19171 -[pear-19188]: https://pear.php.net/bugs/bug.php?id=19188 -[pear-19208]: https://pear.php.net/bugs/bug.php?id=19208 -[pear-19256]: https://pear.php.net/bugs/bug.php?id=19256 -[pear-19264]: https://pear.php.net/bugs/bug.php?id=19264 -[pear-19270]: https://pear.php.net/bugs/bug.php?id=19270 -[pear-19283]: https://pear.php.net/bugs/bug.php?id=19283 -[pear-19313]: https://pear.php.net/bugs/bug.php?id=19313 - -## [1.3.2] - 2011-12-01 - -### Changed -- Added Generic JSHintSniff to run jshint.js over a JS file and report warnings - - Set jshint path using phpcs --config-set jshint_path /path/to/jshint-rhino.js - - Set rhino path using phpcs --config-set rhino_path /path/to/rhino - - Thanks to Alexander Weiß for the contribution -- Nowdocs are now tokenized using PHP_CodeSniffer specific T_NOWDOC tokens for easier identification -- Generic UpperCaseConstantNameSniff no longer throws errors for namespaces - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Squiz NonExecutableCodeSniff now detects code after thrown exceptions - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Squiz OperatorSpacingSniff now ignores references - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Squiz FunctionCommentSniff now reports a missing function comment if it finds a standard code comment instead -- Squiz FunctionCommentThrownTagSniff no longer reports errors if it can't find a function comment - -### Fixed -- Fixed unit tests not running under Windows - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#18964][pear-18964] : "$stackPtr must be of type T_VARIABLE" on heredocs and nowdocs -- Fixed bug [#18973][pear-18973] : phpcs is looking for variables in a nowdoc -- Fixed bug [#18974][pear-18974] : Blank line causes "Multi-line function call not indented correctly" - - Adds new error message to ban empty lines in multi-line function calls -- Fixed bug [#18975][pear-18975] : "Closing parenthesis must be on a line by itself" also causes indentation error - -[pear-18964]: https://pear.php.net/bugs/bug.php?id=18964 -[pear-18973]: https://pear.php.net/bugs/bug.php?id=18973 -[pear-18974]: https://pear.php.net/bugs/bug.php?id=18974 -[pear-18975]: https://pear.php.net/bugs/bug.php?id=18975 - -## 1.3.1 - 2011-11-03 - -### Changed -- All report file command line arguments now work with relative paths (request [#17240][pear-17240]) -- The extensions command line argument now supports multi-part file extensions (request [#17227][pear-17227]) -- Added report type --report=hgblame to show number of errors/warnings committed by authors in a Mercurial repository - - Has the same functionality as the svnblame report - - Thanks to [Ben Selby][@benmatselby] for the patch -- Added T_BACKTICK token type to make detection of backticks easier (request [#18799][pear-18799]) -- Added pattern matching support to Generic ForbiddenFunctionsSniff - - If you are extending it and overriding register() or addError() you will need to review your sniff -- Namespaces are now recognised as scope openers, although they do not require braces (request [#18043][pear-18043]) -- Added new ByteOrderMarkSniff to Generic standard (request [#18194][pear-18194]) - - Throws an error if a byte order mark is found in any PHP file - - Thanks to [Piotr Karas][pear-ryba] for the contribution -- PHP_Timer output is no longer included in reports when being written to a file (request [#18252][pear-18252]) - - Also now shown for all report types if nothing is being printed to the screen -- Generic DeprecatedFunctionSniff now reports functions as deprecated and not simply forbidden (request [#18288][pear-18288]) -- PHPCS now accepts file contents from STDIN (request [#18447][pear-18447]) - - Example usage: `cat temp.php | phpcs [options]` -OR- `phpcs [options] < temp.php` - - Not every sniff will work correctly due to the lack of a valid file path -- PHP_CodeSniffer_Exception no longer extends PEAR_Exception (request [#18483][pear-18483]) - - PEAR_Exception added a requirement that PEAR had to be installed - - PHP_CodeSniffer is not used as a library, so unlikely to have any impact -- PEAR FileCommentSniff now allows GIT IDs in the version tag (request [#14874][pear-14874]) -- AbstractVariableSniff now supports heredocs - - Also includes some variable detection fixes - - Thanks to [Sam Graham][@illusori] for the patch -- Squiz FileCommentSniff now enforces rule that package names cannot start with the word Squiz -- MySource AssignThisSniff now allows "this" to be assigned to the private var _self -- PEAR ClassDeclaration sniff now supports indentation checks when using the alternate namespace syntax - - PEAR.Classes.ClassDeclaration.SpaceBeforeBrace message now contains 2 variables instead of 1 - - Sniff allows overriding of the default indent level, which is set to 4 - - Fixes bug [#18933][pear-18933] : Alternative namespace declaration syntax confuses scope sniffs - -### Fixed -- Fixed issue in Squiz FileCommentSniff where suggested package name was the same as the incorrect package name -- Fixed some issues with Squiz ArrayDeclarationSniff when using function calls in array values -- Fixed doc generation so it actually works again - - Also now works when being run from an SVN checkout as well as when installed as a PEAR package - - Should fix bug [#18949][pear-18949] : Call to private method from static -- Fixed bug [#18465][pear-18465] : "self::" does not work in lambda functions - - Also corrects conversion of T_FUNCTION tokens to T_CLOSURE, which was not fixing token condition arrays -- Fixed bug [#18543][pear-18543] : CSS Tokenizer deletes too many # -- Fixed bug [#18624][pear-18624] : @throws namespace problem - - Thanks to [Gavin Davies][pear-boxgav] for the patch -- Fixed bug [#18628][pear-18628] : Generic.Files.LineLength gives incorrect results with Windows line-endings -- Fixed bug [#18633][pear-18633] : CSS Tokenizer doesn't replace T_LIST tokens inside some styles -- Fixed bug [#18657][pear-18657] : anonymous functions wrongly indented -- Fixed bug [#18670][pear-18670] : UpperCaseConstantNameSniff fails on dynamic retrieval of class constant -- Fixed bug [#18709][pear-18709] : Code sniffer sniffs file even if it's in --ignore - - Thanks to [Artem Lopata][@biozshock] for the patch -- Fixed bug [#18762][pear-18762] : Incorrect handling of define and constant in UpperCaseConstantNameSniff - - Thanks to [Thomas Baker][pear-bakert] for the patch -- Fixed bug [#18769][pear-18769] : CSS Tokenizer doesn't replace T_BREAK tokens inside some styles -- Fixed bug [#18835][pear-18835] : Unreachable errors of inline returns of closure functions - - Thanks to [Patrick Schmidt][pear-woellchen] for the patch -- Fixed bug [#18839][pear-18839] : Fix miscount of warnings in `AbstractSniffUnitTest.php` - - Thanks to [Sam Graham][@illusori] for the patch -- Fixed bug [#18844][pear-18844] : Generic_Sniffs_CodeAnalysis_UnusedFunctionParameterSniff with empty body - - Thanks to [Dmitri Medvedev][pear-dvino] for the patch -- Fixed bug [#18847][pear-18847] : Running Squiz_Sniffs_Classes_ClassDeclarationSniff results in PHP notice -- Fixed bug [#18868][pear-18868] : jslint+rhino: errors/warnings not detected - - Thanks to [Christian Weiske][@cweiske] for the patch -- Fixed bug [#18879][pear-18879] : phpcs-svn-pre-commit requires escapeshellarg - - Thanks to [Bjorn Katuin][pear-bjorn] for the patch -- Fixed bug [#18951][pear-18951] : weird behaviour with closures and multi-line use () params - -[pear-14874]: https://pear.php.net/bugs/bug.php?id=14874 -[pear-17227]: https://pear.php.net/bugs/bug.php?id=17227 -[pear-17240]: https://pear.php.net/bugs/bug.php?id=17240 -[pear-18043]: https://pear.php.net/bugs/bug.php?id=18043 -[pear-18194]: https://pear.php.net/bugs/bug.php?id=18194 -[pear-18252]: https://pear.php.net/bugs/bug.php?id=18252 -[pear-18288]: https://pear.php.net/bugs/bug.php?id=18288 -[pear-18447]: https://pear.php.net/bugs/bug.php?id=18447 -[pear-18465]: https://pear.php.net/bugs/bug.php?id=18465 -[pear-18483]: https://pear.php.net/bugs/bug.php?id=18483 -[pear-18543]: https://pear.php.net/bugs/bug.php?id=18543 -[pear-18624]: https://pear.php.net/bugs/bug.php?id=18624 -[pear-18628]: https://pear.php.net/bugs/bug.php?id=18628 -[pear-18633]: https://pear.php.net/bugs/bug.php?id=18633 -[pear-18657]: https://pear.php.net/bugs/bug.php?id=18657 -[pear-18670]: https://pear.php.net/bugs/bug.php?id=18670 -[pear-18709]: https://pear.php.net/bugs/bug.php?id=18709 -[pear-18762]: https://pear.php.net/bugs/bug.php?id=18762 -[pear-18769]: https://pear.php.net/bugs/bug.php?id=18769 -[pear-18799]: https://pear.php.net/bugs/bug.php?id=18799 -[pear-18835]: https://pear.php.net/bugs/bug.php?id=18835 -[pear-18839]: https://pear.php.net/bugs/bug.php?id=18839 -[pear-18844]: https://pear.php.net/bugs/bug.php?id=18844 -[pear-18847]: https://pear.php.net/bugs/bug.php?id=18847 -[pear-18868]: https://pear.php.net/bugs/bug.php?id=18868 -[pear-18879]: https://pear.php.net/bugs/bug.php?id=18879 -[pear-18933]: https://pear.php.net/bugs/bug.php?id=18933 -[pear-18949]: https://pear.php.net/bugs/bug.php?id=18949 -[pear-18951]: https://pear.php.net/bugs/bug.php?id=18951 - -## 1.3.0 - 2011-03-17 - -### Changed -- Add a new token T_CLOSURE that replaces T_FUNCTION if the function keyword is anonymous -- Many Squiz sniffs no longer report errors when checking closures; they are now ignored -- Fixed some error messages in PEAR MultiLineConditionSniff that were not using placeholders for message data -- AbstractVariableSniff now correctly finds variable names wrapped with curly braces inside double quoted strings -- PEAR FunctionDeclarationSniff now ignores arrays in argument default values when checking multi-line declarations - -### Fixed -- Fixed bug [#18200][pear-18200] : Using custom named ruleset file as standard no longer works -- Fixed bug [#18196][pear-18196] : PEAR MultiLineCondition.SpaceBeforeOpenBrace not consistent with newline chars -- Fixed bug [#18204][pear-18204] : FunctionCommentThrowTag picks wrong exception type when throwing function call -- Fixed bug [#18222][pear-18222] : Add __invoke method to PEAR standard -- Fixed bug [#18235][pear-18235] : Invalid error generation in Squiz.Commenting.FunctionCommentThrowTag -- Fixed bug [#18250][pear-18250] : --standard with relative path skips Standards' "implicit" sniffs -- Fixed bug [#18274][pear-18274] : Multi-line IF and function call indent rules conflict -- Fixed bug [#18282][pear-18282] : Squiz doesn't handle final keyword before function comments - - Thanks to [Dave Perrett][pear-recurser] for the patch -- Fixed bug [#18336][pear-18336] : Function isUnderscoreName gives PHP notices - -[pear-18196]: https://pear.php.net/bugs/bug.php?id=18196 -[pear-18200]: https://pear.php.net/bugs/bug.php?id=18200 -[pear-18204]: https://pear.php.net/bugs/bug.php?id=18204 -[pear-18222]: https://pear.php.net/bugs/bug.php?id=18222 -[pear-18235]: https://pear.php.net/bugs/bug.php?id=18235 -[pear-18250]: https://pear.php.net/bugs/bug.php?id=18250 -[pear-18274]: https://pear.php.net/bugs/bug.php?id=18274 -[pear-18282]: https://pear.php.net/bugs/bug.php?id=18282 -[pear-18336]: https://pear.php.net/bugs/bug.php?id=18336 - -## 1.3.0RC2 - 2011-01-14 - -### Changed -- You can now print multiple reports for each run and print each to the screen or a file (request [#12434][pear-12434]) - - Format is `--report-[report][=file]` (e.g., `--report-xml=out.xml`) - - Printing to screen is done by leaving `[file]` empty (e.g., `--report-xml`) - - Multiple reports can be specified in this way (e.g., `--report-summary --report-xml=out.xml`) - - The standard `--report` and `--report-file` command line arguments are unchanged -- Added `-d` command line argument to set `php.ini` settings while running (request [#17244][pear-17244]) - - Usage is: `phpcs -d memory_limit=32M -d ...` - - Thanks to [Ben Selby][@benmatselby] for the patch -- Added -p command line argument to show progress during a run - - Dot means pass, E means errors found, W means only warnings found and S means skipped file - - Particularly good for runs where you are checking more than 100 files - - Enable by default with --config-set show_progress 1 - - Will not print anything if you are already printing verbose output - - This has caused a big change in the way PHP_CodeSniffer processes files (API changes around processing) -- You can now add exclude rules for individual sniffs or error messages (request [#17903][pear-17903]) - - Only available when using a ruleset.xml file to specify rules - - Uses the same exclude-pattern tags as normal but allows them inside rule tags -- Using the -vvv option will now print a list of sniffs executed for each file and how long they took to process -- Added Generic ClosureLinterSniff to run Google's gjslint over your JS files -- The XML and CSV reports now include the severity of the error (request [#18165][pear-18165]) - - The Severity column in the CSV report has been renamed to Type, and a new Severity column added for this -- Fixed issue with Squiz FunctionCommentSniff reporting incorrect type hint when default value uses namespace - - Thanks to Anti Veeranna for the patch -- Generic FileLengthSniff now uses iconv_strlen to check line length if an encoding is specified (request [#14237][pear-14237]) -- Generic UnnecessaryStringConcatSniff now allows strings to be combined to form a PHP open or close tag -- Squiz SwitchDeclarationSniff no longer reports indentation errors for BREAK statements inside IF conditions -- Interactive mode now always prints the full error report (ignores command line) -- Improved regular expression detection in JavaScript files - - Added new T_TYPEOF token that can be used to target the typeof JS operator - - Fixes bug [#17611][pear-17611] : Regular expression tokens not recognised -- Squiz ScopeIndentSniff removed - - Squiz standard no longer requires additional indents between ob_* methods - - Also removed Squiz OutputBufferingIndentSniff that was checking the same thing -- PHP_CodeSniffer_File::getMemberProperties() performance improved significantly - - Improves performance of Squiz ValidVariableNameSniff significantly -- Squiz OperatorSpacingSniff performance improved significantly -- Squiz NonExecutableCodeSniff performance improved significantly - - Will throw duplicate errors in some cases now, but these should be rare -- MySource IncludeSystemSniff performance improved significantly -- MySource JoinStringsSniff no longer reports an error when using join() on a named JS array -- Warnings are now reported for each file when they cannot be opened instead of stopping the script - - Hide warnings with the -n command line argument - - Can override the warnings using the code Internal.DetectLineEndings - -### Fixed -- Fixed bug [#17693][pear-17693] : issue with pre-commit hook script with filenames that start with v -- Fixed bug [#17860][pear-17860] : isReference function fails with references in array - - Thanks to [Lincoln Maskey][pear-ljmaskey] for the patch -- Fixed bug [#17902][pear-17902] : Cannot run tests when tests are symlinked into tests dir - - Thanks to [Matt Button][@BRMatt] for the patch -- Fixed bug [#17928][pear-17928] : Improve error message for Generic_Sniffs_PHP_UpperCaseConstantSniff - - Thanks to [Stefano Kowalke][@Konafets] for the patch -- Fixed bug [#18039][pear-18039] : JS Tokenizer crash when ] is last character in file -- Fixed bug [#18047][pear-18047] : Incorrect handling of namespace aliases as constants - - Thanks to [Dmitri Medvedev][pear-dvino] for the patch -- Fixed bug [#18072][pear-18072] : Impossible to exclude path from processing when symlinked -- Fixed bug [#18073][pear-18073] : Squiz.PHP.NonExecutableCode fault -- Fixed bug [#18117][pear-18117] : PEAR coding standard: Method constructor not sniffed as a function -- Fixed bug [#18135][pear-18135] : Generic FunctionCallArgumentSpacingSniff reports function declaration errors -- Fixed bug [#18140][pear-18140] : Generic scope indent in exact mode: strange expected/found values for switch -- Fixed bug [#18145][pear-18145] : Sniffs are not loaded for custom ruleset file - - Thanks to [Scott McCammon][pear-mccammos] for the patch -- Fixed bug [#18152][pear-18152] : While and do-while with AbstractPatternSniff -- Fixed bug [#18191][pear-18191] : Squiz.PHP.LowercasePHPFunctions does not work with new Date() -- Fixed bug [#18193][pear-18193] : CodeSniffer doesn't reconize CR (\r) line endings - -[pear-12434]: https://pear.php.net/bugs/bug.php?id=12434 -[pear-14237]: https://pear.php.net/bugs/bug.php?id=14237 -[pear-17244]: https://pear.php.net/bugs/bug.php?id=17244 -[pear-17611]: https://pear.php.net/bugs/bug.php?id=17611 -[pear-17693]: https://pear.php.net/bugs/bug.php?id=17693 -[pear-17860]: https://pear.php.net/bugs/bug.php?id=17860 -[pear-17902]: https://pear.php.net/bugs/bug.php?id=17902 -[pear-17903]: https://pear.php.net/bugs/bug.php?id=17903 -[pear-17928]: https://pear.php.net/bugs/bug.php?id=17928 -[pear-18039]: https://pear.php.net/bugs/bug.php?id=18039 -[pear-18047]: https://pear.php.net/bugs/bug.php?id=18047 -[pear-18072]: https://pear.php.net/bugs/bug.php?id=18072 -[pear-18073]: https://pear.php.net/bugs/bug.php?id=18073 -[pear-18117]: https://pear.php.net/bugs/bug.php?id=18117 -[pear-18135]: https://pear.php.net/bugs/bug.php?id=18135 -[pear-18140]: https://pear.php.net/bugs/bug.php?id=18140 -[pear-18145]: https://pear.php.net/bugs/bug.php?id=18145 -[pear-18152]: https://pear.php.net/bugs/bug.php?id=18152 -[pear-18165]: https://pear.php.net/bugs/bug.php?id=18165 -[pear-18191]: https://pear.php.net/bugs/bug.php?id=18191 -[pear-18193]: https://pear.php.net/bugs/bug.php?id=18193 - -## 1.3.0RC1 - 2010-09-03 - -### Changed -- Added exclude pattern support to ruleset.xml file so you can specify ignore patterns in a standard (request [#17683][pear-17683]) - - Use new exclude-pattern tags to include the ignore rules into your ruleset.xml file - - See CodeSniffer/Standards/PHPCS/ruleset.xml for an example -- Added new --encoding command line argument to specify the encoding of the files being checked - - When set to utf-8, stops the XML-based reports from double-encoding - - When set to something else, helps the XML-based reports encode to utf-8 - - Default value is iso-8859-1 but can be changed with `--config-set encoding [value]` -- The report is no longer printed to screen when using the --report-file command line option (request [#17467][pear-17467]) - - If you want to print it to screen as well, use the -v command line argument -- The SVN and GIT blame reports now also show percentage of reported errors per author (request [#17606][pear-17606]) - - Thanks to [Ben Selby][@benmatselby] for the patch -- Updated the SVN pre-commit hook to work with the new severity levels feature -- Generic SubversionPropertiesSniff now allows properties to have NULL values (request [#17682][pear-17682]) - - A null value indicates that the property should exist but the value should not be checked -- Generic UpperCaseConstantName Sniff now longer complains about the PHPUnit_MAIN_METHOD constant (request [#17798][pear-17798]) -- Squiz FileComment sniff now checks JS files as well as PHP files -- Squiz FunctionCommentSniff now supports namespaces in type hints - -### Fixed -- Fixed a problem in Squiz OutputBufferingIndentSniff where block comments were reported as not indented -- Fixed bug [#17092][pear-17092] : Problems with utf8_encode and htmlspecialchars with non-ascii chars - - Use the new --encoding=utf-8 command line argument if your files are utf-8 encoded -- Fixed bug [#17629][pear-17629] : PHP_CodeSniffer_Tokens::$booleanOperators missing T_LOGICAL_XOR - - Thanks to [Matthew Turland][@elazar] for the patch -- Fixed bug [#17699][pear-17699] : Fatal error generating code coverage with PHPUnit 5.3.0RC1 -- Fixed bug [#17718][pear-17718] : Namespace 'use' statement: used global class name is recognized as constant -- Fixed bug [#17734][pear-17734] : Generic SubversionPropertiesSniff complains on non SVN files -- Fixed bug [#17742][pear-17742] : EmbeddedPhpSniff reacts negatively to file without closing PHP tag -- Fixed bug [#17823][pear-17823] : Notice: Please no longer include `PHPUnit/Framework.php` - -[pear-17092]: https://pear.php.net/bugs/bug.php?id=17092 -[pear-17467]: https://pear.php.net/bugs/bug.php?id=17467 -[pear-17606]: https://pear.php.net/bugs/bug.php?id=17606 -[pear-17629]: https://pear.php.net/bugs/bug.php?id=17629 -[pear-17682]: https://pear.php.net/bugs/bug.php?id=17682 -[pear-17683]: https://pear.php.net/bugs/bug.php?id=17683 -[pear-17699]: https://pear.php.net/bugs/bug.php?id=17699 -[pear-17718]: https://pear.php.net/bugs/bug.php?id=17718 -[pear-17734]: https://pear.php.net/bugs/bug.php?id=17734 -[pear-17742]: https://pear.php.net/bugs/bug.php?id=17742 -[pear-17798]: https://pear.php.net/bugs/bug.php?id=17798 -[pear-17823]: https://pear.php.net/bugs/bug.php?id=17823 - -## 1.3.0a1 - 2010-07-15 - -### Changed -- All `CodingStandard.php` files have been replaced by `ruleset.xml` files - - Custom standards will need to be converted over to this new format to continue working -- You can specify a path to your own custom ruleset.xml file by using the --standard command line arg - - e.g., phpcs --standard=/path/to/my/ruleset.xml -- Added a new report type --report=gitblame to show how many errors and warnings were committed by each author - - Has the same functionality as the svnblame report - - Thanks to [Ben Selby][@benmatselby] for the patch -- A new token type T_DOLLAR has been added to allow you to sniff for variable variables (feature request [#17095][pear-17095]) - - Thanks to [Ian Young][pear-youngian] for the patch -- JS tokenizer now supports T_POWER (^) and T_MOD_EQUAL (%=) tokens (feature request [#17441][pear-17441]) -- If you have PHP_Timer installed, you'll now get a time/memory summary at the end of a script run - - Only happens when printing reports that are designed to be read on the command line -- Added Generic DeprecatedFunctionsSniff to warn about the use of deprecated functions (feature request [#16694][pear-16694]) - - Thanks to [Sebastian Bergmann][@sebastianbergmann] for the patch -- Added Squiz LogicalOperatorSniff to ensure that logical operators are surrounded by single spaces -- Added MySource ChannelExceptionSniff to ensure action files only throw ChannelException -- Added new method getClassProperties() for sniffs to use to determine if a class is abstract and/or final - - Thanks to [Christian Kaps][@akkie] for the patch -- Generic UpperCaseConstantSniff no longer throws errors about namespaces - - Thanks to [Christian Kaps][@akkie] for the patch -- Squiz OperatorBracketSniff now correctly checks value assignments in arrays -- Squiz LongConditionClosingCommentSniff now requires a comment for long CASE statements that use curly braces -- Squiz LongConditionClosingCommentSniff now requires an exact comment match on the brace -- MySource IncludeSystemSniff now ignores DOMDocument usage -- MySource IncludeSystemSniff no longer requires inclusion of systems that are being implemented -- Removed found and expected messages from Squiz ConcatenationSpacingSniff because they were messy and not helpful - -### Fixed -- Fixed a problem where Generic CodeAnalysisSniff could show warnings if checking multi-line strings -- Fixed error messages in Squiz ArrayDeclarationSniff reporting incorrect number of found and expected spaces -- Fixed bug [#17048][pear-17048] : False positive in Squiz_WhiteSpace_ScopeKeywordSpacingSniff -- Fixed bug [#17054][pear-17054] : phpcs more strict than PEAR CS regarding function parameter spacing -- Fixed bug [#17096][pear-17096] : Notice: Undefined index: `scope_condition` in `ScopeClosingBraceSniff.php` - - Moved PEAR.Functions.FunctionCallArgumentSpacing to Generic.Functions.FunctionCallArgumentSpacing -- Fixed bug [#17144][pear-17144] : Deprecated: Function eregi() is deprecated -- Fixed bug [#17236][pear-17236] : PHP Warning due to token_get_all() in DoubleQuoteUsageSniff -- Fixed bug [#17243][pear-17243] : Alternate Switch Syntax causes endless loop of Notices in SwitchDeclaration -- Fixed bug [#17313][pear-17313] : Bug with switch case structure -- Fixed bug [#17331][pear-17331] : Possible parse error: interfaces may not include member vars -- Fixed bug [#17337][pear-17337] : CSS tokenizer fails on quotes urls -- Fixed bug [#17420][pear-17420] : Uncaught exception when comment before function brace -- Fixed bug [#17503][pear-17503] : closures formatting is not supported - -[pear-16694]: https://pear.php.net/bugs/bug.php?id=16694 -[pear-17048]: https://pear.php.net/bugs/bug.php?id=17048 -[pear-17054]: https://pear.php.net/bugs/bug.php?id=17054 -[pear-17095]: https://pear.php.net/bugs/bug.php?id=17095 -[pear-17096]: https://pear.php.net/bugs/bug.php?id=17096 -[pear-17144]: https://pear.php.net/bugs/bug.php?id=17144 -[pear-17236]: https://pear.php.net/bugs/bug.php?id=17236 -[pear-17243]: https://pear.php.net/bugs/bug.php?id=17243 -[pear-17313]: https://pear.php.net/bugs/bug.php?id=17313 -[pear-17331]: https://pear.php.net/bugs/bug.php?id=17331 -[pear-17337]: https://pear.php.net/bugs/bug.php?id=17337 -[pear-17420]: https://pear.php.net/bugs/bug.php?id=17420 -[pear-17441]: https://pear.php.net/bugs/bug.php?id=17441 -[pear-17503]: https://pear.php.net/bugs/bug.php?id=17503 - -## 1.2.2 - 2010-01-27 - -### Changed -- The core PHP_CodeSniffer_File methods now understand the concept of closures (feature request [#16866][pear-16866]) - - Thanks to [Christian Kaps][@akkie] for the sample code -- Sniffs can now specify violation codes for each error and warning they add - - Future versions will allow you to override messages and severities using these codes - - Specifying a code is optional, but will be required if you wish to support overriding -- All reports have been broken into separate classes - - Command line usage and report output remains the same - - Thanks to Gabriele Santini for the patch -- Added an interactive mode that can be enabled using the -a command line argument - - Scans files and stops when it finds a file with errors - - Waits for user input to recheck the file (hopefully you fixed the errors) or skip the file - - Useful for very large code bases where full rechecks take a while -- The reports now show the correct number of errors and warnings found -- The isCamelCaps method now allows numbers in class names -- The JS tokenizer now correctly identifies boolean and bitwise AND and OR tokens -- The JS tokenizer now correctly identifies regular expressions used in conditions -- PEAR ValidFunctionNameSniff now ignores closures -- Squiz standard now uses the PEAR setting of 85 chars for LineLengthSniff -- Squiz ControlStructureSpacingSniff now ensure there are no spaces around parentheses -- Squiz LongConditionClosingCommentSniff now checks for comments at the end of try/catch statements -- Squiz LongConditionClosingCommentSniff now checks validity of comments for short structures if they exist -- Squiz IncrementDecrementUsageSniff now has better checking to ensure it only looks at simple variable assignments -- Squiz PostStatementCommentSniff no longer throws errors for end function comments -- Squiz InlineCommentSniff no longer throws errors for end function comments -- Squiz OperatorBracketSniff now allows simple arithmetic operations in SWITCH conditions -- Squiz ValidFunctionNameSniff now ignores closures -- Squiz MethodScopeSniff now ignores closures -- Squiz ClosingDeclarationCommentSniff now ignores closures -- Squiz GlobalFunctionSniff now ignores closures -- Squiz DisallowComparisonAssignmentSniff now ignores the assigning of arrays -- Squiz DisallowObjectStringIndexSniff now allows indexes that contain dots and reserved words -- Squiz standard now throws nesting level and cyclomatic complexity errors at much higher levels -- Squiz CommentedOutCodeSniff now ignores common comment framing characters -- Squiz ClassCommentSniff now ensures the open comment tag is the only content on the first line -- Squiz FileCommentSniff now ensures the open comment tag is the only content on the first line -- Squiz FunctionCommentSniff now ensures the open comment tag is the only content on the first line -- Squiz VariableCommentSniff now ensures the open comment tag is the only content on the first line -- Squiz NonExecutableCodeSniff now warns about empty return statements that are not required -- Removed ForbiddenStylesSniff from Squiz standard - - It is now in the MySource standard as BrowserSpecificStylesSniff - - New BrowserSpecificStylesSniff ignores files with browser-specific suffixes -- MySource IncludeSystemSniff no longer throws errors when extending the Exception class -- MySource IncludeSystemSniff no longer throws errors for the abstract widget class -- MySource IncludeSystemSniff and UnusedSystemSniff now allow includes inside IF statements -- MySource IncludeSystemSniff no longer throws errors for included widgets inside methods -- MySource GetRequestDataSniff now throws errors for using $_FILES -- MySource CreateWidgetTypeCallbackSniff now allows return statements in nested functions -- MySource DisallowSelfActionsSniff now ignores abstract classes - -### Fixed -- Fixed a problem with the SVN pre-commit hook for PHP versions without vertical whitespace regex support -- Fixed bug [#16740][pear-16740] : False positives for heredoc strings and unused parameter sniff -- Fixed bug [#16794][pear-16794] : ValidLogicalOperatorsSniff doesn't report operators not in lowercase -- Fixed bug [#16804][pear-16804] : Report filename is shortened too much -- Fixed bug [#16821][pear-16821] : Bug in Squiz_Sniffs_WhiteSpace_OperatorSpacingSniff - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#16836][pear-16836] : Notice raised when using semicolon to open case -- Fixed bug [#16855][pear-16855] : Generic standard sniffs incorrectly for define() method -- Fixed bug [#16865][pear-16865] : Two bugs in Squiz_Sniffs_WhiteSpace_OperatorSpacingSniff - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#16902][pear-16902] : Inline If Declaration bug -- Fixed bug [#16960][pear-16960] : False positive for late static binding in Squiz/ScopeKeywordSpacingSniff - - Thanks to [Jakub Tománek][pear-thezero] for the patch -- Fixed bug [#16976][pear-16976] : The phpcs attempts to process symbolic links that don't resolve to files -- Fixed bug [#17017][pear-17017] : Including one file in the files sniffed alters errors reported for another file - -[pear-16740]: https://pear.php.net/bugs/bug.php?id=16740 -[pear-16794]: https://pear.php.net/bugs/bug.php?id=16794 -[pear-16804]: https://pear.php.net/bugs/bug.php?id=16804 -[pear-16821]: https://pear.php.net/bugs/bug.php?id=16821 -[pear-16836]: https://pear.php.net/bugs/bug.php?id=16836 -[pear-16855]: https://pear.php.net/bugs/bug.php?id=16855 -[pear-16865]: https://pear.php.net/bugs/bug.php?id=16865 -[pear-16866]: https://pear.php.net/bugs/bug.php?id=16866 -[pear-16902]: https://pear.php.net/bugs/bug.php?id=16902 -[pear-16960]: https://pear.php.net/bugs/bug.php?id=16960 -[pear-16976]: https://pear.php.net/bugs/bug.php?id=16976 -[pear-17017]: https://pear.php.net/bugs/bug.php?id=17017 - -## 1.2.1 - 2009-11-17 - -### Changed -- Added a new report type --report=svnblame to show how many errors and warnings were committed by each author - - Also shows the percentage of their code that are errors and warnings - - Requires you to have the SVN command in your path - - Make sure SVN is storing usernames and passwords (if required) or you will need to enter them for each file - - You can also use the -s command line argument to see the different types of errors authors are committing - - You can use the -v command line argument to see all authors, even if they have no errors or warnings -- Added a new command line argument --report-width to allow you to set the column width of screen reports - - Reports won't accept values less than 70 or else they get too small - - Can also be set via a config var: phpcs --config-set report_width 100 -- You can now get PHP_CodeSniffer to ignore a whole file by adding @codingStandardsIgnoreFile in the content - - If you put it in the first two lines the file won't even be tokenized, so it will be much quicker -- Reports now print their file lists in alphabetical order -- PEAR FunctionDeclarationSniff now reports error for incorrect closing bracket placement in multi-line definitions -- Added Generic CallTimePassByReferenceSniff to prohibit the passing of variables into functions by reference - - Thanks to Florian Grandel for the contribution -- Added Squiz DisallowComparisonAssignmentSniff to ban the assignment of comparison values to a variable -- Added Squiz DuplicateStyleDefinitionSniff to check for duplicate CSS styles in a single class block -- Squiz ArrayDeclarationSniff no longer checks the case of array indexes because that is not its job -- Squiz PostStatementCommentSniff now allows end comments for class member functions -- Squiz InlineCommentSniff now supports the checking of JS files -- MySource CreateWidgetTypeCallbackSniff now allows the callback to be passed to another function -- MySource CreateWidgetTypeCallbackSniff now correctly ignores callbacks used inside conditions -- Generic MultipleStatementAlignmentSniff now enforces a single space before equals sign if max padding is reached -- Fixed a problem in the JS tokenizer where regular expressions containing \// were not converted correctly -- Fixed a problem tokenizing CSS files where multiple ID targets on a line would look like comments -- Fixed a problem tokenizing CSS files where class names containing a colon looked like style definitions -- Fixed a problem tokenizing CSS files when style statements had empty url() calls -- Fixed a problem tokenizing CSS colours with the letter E in first half of the code -- Squiz ColonSpacingSniff now ensures it is only checking style definitions in CSS files and not class names -- Squiz DisallowComparisonAssignmentSniff no longer reports errors when assigning the return value of a function -- CSS tokenizer now correctly supports multi-line comments -- When only the case of var names differ for function comments, the error now indicates the case is different - -### Fixed -- Fixed an issue with Generic UnnecessaryStringConcatSniff where it incorrectly suggested removing a concat -- Fixed bug [#16530][pear-16530] : ScopeIndentSniff reports false positive -- Fixed bug [#16533][pear-16533] : Duplicate errors and warnings -- Fixed bug [#16563][pear-16563] : Check file extensions problem in phpcs-svn-pre-commit - - Thanks to [Kaijung Chen][pear-et3w503] for the patch -- Fixed bug [#16592][pear-16592] : Object operator indentation incorrect when first operator is on a new line -- Fixed bug [#16641][pear-16641] : Notice output -- Fixed bug [#16682][pear-16682] : Squiz_Sniffs_Strings_DoubleQuoteUsageSniff reports string "\0" as invalid -- Fixed bug [#16683][pear-16683] : Typing error in PHP_CodeSniffer_CommentParser_AbstractParser -- Fixed bug [#16684][pear-16684] : Bug in Squiz_Sniffs_PHP_NonExecutableCodeSniff -- Fixed bug [#16692][pear-16692] : Spaces in paths in Squiz_Sniffs_Debug_JavaScriptLintSniff - - Thanks to [Jaroslav Hanslík][@kukulich] for the patch -- Fixed bug [#16696][pear-16696] : Spelling error in MultiLineConditionSniff -- Fixed bug [#16697][pear-16697] : MultiLineConditionSniff incorrect result with inline IF -- Fixed bug [#16698][pear-16698] : Notice in JavaScript Tokenizer -- Fixed bug [#16736][pear-16736] : Multi-files sniffs aren't processed when FILE is a single directory - - Thanks to [Alexey Shein][pear-conf] for the patch -- Fixed bug [#16792][pear-16792] : Bug in Generic_Sniffs_PHP_ForbiddenFunctionsSniff - -[pear-16530]: https://pear.php.net/bugs/bug.php?id=16530 -[pear-16533]: https://pear.php.net/bugs/bug.php?id=16533 -[pear-16563]: https://pear.php.net/bugs/bug.php?id=16563 -[pear-16592]: https://pear.php.net/bugs/bug.php?id=16592 -[pear-16641]: https://pear.php.net/bugs/bug.php?id=16641 -[pear-16682]: https://pear.php.net/bugs/bug.php?id=16682 -[pear-16683]: https://pear.php.net/bugs/bug.php?id=16683 -[pear-16684]: https://pear.php.net/bugs/bug.php?id=16684 -[pear-16692]: https://pear.php.net/bugs/bug.php?id=16692 -[pear-16696]: https://pear.php.net/bugs/bug.php?id=16696 -[pear-16697]: https://pear.php.net/bugs/bug.php?id=16697 -[pear-16698]: https://pear.php.net/bugs/bug.php?id=16698 -[pear-16736]: https://pear.php.net/bugs/bug.php?id=16736 -[pear-16792]: https://pear.php.net/bugs/bug.php?id=16792 - -## 1.2.0 - 2009-08-17 - -### Changed -- Installed standards are now favoured over custom standards when using the cmd line arg with relative paths -- Unit tests now use a lot less memory while running -- Squiz standard now uses Generic EmptyStatementSniff but throws errors instead of warnings -- Squiz standard now uses Generic UnusedFunctionParameterSniff -- Removed unused ValidArrayIndexNameSniff from the Squiz standard - -### Fixed -- Fixed bug [#16424][pear-16424] : SubversionPropertiesSniff print PHP Warning -- Fixed bug [#16450][pear-16450] : Constant `PHP_CODESNIFFER_VERBOSITY` already defined (unit tests) -- Fixed bug [#16453][pear-16453] : function declaration long line splitted error -- Fixed bug [#16482][pear-16482] : phpcs-svn-pre-commit ignores extensions parameter - -[pear-16424]: https://pear.php.net/bugs/bug.php?id=16424 -[pear-16450]: https://pear.php.net/bugs/bug.php?id=16450 -[pear-16453]: https://pear.php.net/bugs/bug.php?id=16453 -[pear-16482]: https://pear.php.net/bugs/bug.php?id=16482 - -## 1.2.0RC3 - 2009-07-07 - -### Changed -- You can now use @codingStandardsIgnoreStart and @...End comments to suppress messages (feature request [#14002][pear-14002]) -- A warning is now included for files without any code when short_open_tag is set to Off (feature request [#12952][pear-12952]) -- You can now use relative paths to your custom standards with the --standard cmd line arg (feature request [#14967][pear-14967]) -- You can now override magic methods and functions in PEAR ValidFunctionNameSniff (feature request [#15830][pear-15830]) -- MySource IncludeSystemSniff now recognises widget action classes -- MySource IncludeSystemSniff now knows about unit test classes and changes rules accordingly - -[pear-12952]: https://pear.php.net/bugs/bug.php?id=12952 -[pear-14002]: https://pear.php.net/bugs/bug.php?id=14002 -[pear-14967]: https://pear.php.net/bugs/bug.php?id=14967 -[pear-15830]: https://pear.php.net/bugs/bug.php?id=15830 - -## 1.2.0RC2 - 2009-05-25 - -### Changed -- Test suite can now be run using the full path to `AllTests.php` (feature request [#16179][pear-16179]) - -### Fixed -- Fixed bug [#15980][pear-15980] : PHP_CodeSniffer change PHP current directory - - Thanks to [Dolly Aswin Harahap][pear-dollyaswin] for the patch -- Fixed bug [#16001][pear-16001] : Notice triggered -- Fixed bug [#16054][pear-16054] : phpcs-svn-pre-commit not showing any errors -- Fixed bug [#16071][pear-16071] : Fatal error: Uncaught PHP_CodeSniffer_Exception -- Fixed bug [#16170][pear-16170] : Undefined Offset -1 in `MultiLineConditionSniff.php` on line 68 -- Fixed bug [#16175][pear-16175] : Bug in Squiz-IncrementDecrementUsageSniff - -[pear-15980]: https://pear.php.net/bugs/bug.php?id=15980 -[pear-16001]: https://pear.php.net/bugs/bug.php?id=16001 -[pear-16054]: https://pear.php.net/bugs/bug.php?id=16054 -[pear-16071]: https://pear.php.net/bugs/bug.php?id=16071 -[pear-16170]: https://pear.php.net/bugs/bug.php?id=16170 -[pear-16175]: https://pear.php.net/bugs/bug.php?id=16175 -[pear-16179]: https://pear.php.net/bugs/bug.php?id=16179 - -## 1.2.0RC1 - 2009-03-09 - -### Changed -- Reports that are output to a file now include a trailing newline at the end of the file -- Fixed sniff names not shown in -vvv token processing output -- Added Generic SubversionPropertiesSniff to check that specific svn props are set for files - - Thanks to Jack Bates for the contribution -- The PHP version check can now be overridden in classes that extend PEAR FileCommentSniff - - Thanks to [Helgi Þormar Þorbjörnsson][@helgi] for the suggestion -- Added Generic ConstructorNameSniff to check for PHP4 constructor name usage - - Thanks to Leif Wickland for the contribution -- Squiz standard now supports multi-line function and condition sniffs from PEAR standard -- Squiz standard now uses Generic ConstructorNameSniff -- Added MySource GetRequestDataSniff to ensure REQUEST, GET and POST are not accessed directly -- Squiz OperatorBracketSniff now allows square brackets in simple unbracketed operations - -### Fixed -- Fixed the incorrect tokenizing of multi-line block comments in CSS files -- Fixed bug [#15383][pear-15383] : Uncaught PHP_CodeSniffer_Exception -- Fixed bug [#15408][pear-15408] : An unexpected exception has been caught: Undefined offset: 2 -- Fixed bug [#15519][pear-15519] : Uncaught PHP_CodeSniffer_Exception -- Fixed bug [#15624][pear-15624] : Pre-commit hook fails with PHP errors -- Fixed bug [#15661][pear-15661] : Uncaught PHP_CodeSniffer_Exception -- Fixed bug [#15722][pear-15722] : "declare(encoding = 'utf-8');" leads to "Missing file doc comment" -- Fixed bug [#15910][pear-15910] : Object operator indention not calculated correctly - -[pear-15383]: https://pear.php.net/bugs/bug.php?id=15383 -[pear-15408]: https://pear.php.net/bugs/bug.php?id=15408 -[pear-15519]: https://pear.php.net/bugs/bug.php?id=15519 -[pear-15624]: https://pear.php.net/bugs/bug.php?id=15624 -[pear-15661]: https://pear.php.net/bugs/bug.php?id=15661 -[pear-15722]: https://pear.php.net/bugs/bug.php?id=15722 -[pear-15910]: https://pear.php.net/bugs/bug.php?id=15910 - -## 1.2.0a1 - 2008-12-18 - -### Changed -- PHP_CodeSniffer now has a CSS tokenizer for checking CSS files -- Added support for a new multi-file sniff that sniffs all processed files at once -- Added new output format --report=emacs to output errors using the emacs standard compile output format - - Thanks to Len Trigg for the contribution -- Reports can now be written to a file using the --report-file command line argument (feature request [#14953][pear-14953]) - - The report is also written to screen when using this argument -- The CheckStyle, CSV and XML reports now include a source for each error and warning (feature request [#13242][pear-13242]) - - A new report type --report=source can be used to show you the most common errors in your files -- Added new command line argument -s to show error sources in all reports -- Added new command line argument --sniffs to specify a list of sniffs to restrict checking to - - Uses the sniff source codes that are optionally displayed in reports -- Changed the max width of error lines from 80 to 79 chars to stop blank lines in the default windows cmd window -- PHP_CodeSniffer now has a token for an asperand (@ symbol) so sniffs can listen for them - - Thanks to Andy Brockhurst for the patch -- Added Generic DuplicateClassNameSniff that will warn if the same class name is used in multiple files - - Not currently used by any standard; more of a multi-file sniff sample than anything useful -- Added Generic NoSilencedErrorsSniff that warns if PHP errors are being silenced using the @ symbol - - Thanks to Andy Brockhurst for the contribution -- Added Generic UnnecessaryStringConcatSniff that checks for two strings being concatenated -- Added PEAR FunctionDeclarationSniff to enforce the new multi-line function declaration PEAR standard -- Added PEAR MultiLineAssignmentSniff to enforce the correct indentation of multi-line assignments -- Added PEAR MultiLineConditionSniff to enforce the new multi-line condition PEAR standard -- Added PEAR ObjectOperatorIndentSniff to enforce the new chained function call PEAR standard -- Added MySource DisallowSelfActionSniff to ban the use of self::method() calls in Action classes -- Added MySource DebugCodeSniff to ban the use of Debug::method() calls -- Added MySource CreateWidgetTypeCallback sniff to check callback usage in widget type create methods -- Added Squiz DisallowObjectStringIndexSniff that forces object dot notation in JavaScript files - - Thanks to [Sertan Danis][@sertand] for the contribution -- Added Squiz DiscouragedFunctionsSniff to warn when using debug functions -- Added Squiz PropertyLabelSniff to check whitespace around colons in JS property and label declarations -- Added Squiz DuplicatePropertySniff to check for duplicate property names in JS classes -- Added Squiz ColonSpacingSniff to check for spacing around colons in CSS style definitions -- Added Squiz SemicolonSpacingSniff to check for spacing around semicolons in CSS style definitions -- Added Squiz IndentationSniff to check for correct indentation of CSS files -- Added Squiz ColourDefinitionSniff to check that CSS colours are defined in uppercase and using shorthand -- Added Squiz EmptyStyleDefinitionSniff to check for CSS style definitions without content -- Added Squiz EmptyClassDefinitionSniff to check for CSS class definitions without content -- Added Squiz ClassDefinitionOpeningBraceSpaceSniff to check for spaces around opening brace of CSS class definitions -- Added Squiz ClassDefinitionClosingBraceSpaceSniff to check for a single blank line after CSS class definitions -- Added Squiz ClassDefinitionNameSpacingSniff to check for a blank lines inside CSS class definition names -- Added Squiz DisallowMultipleStyleDefinitionsSniff to check for multiple style definitions on a single line -- Added Squiz DuplicateClassDefinitionSniff to check for duplicate CSS class blocks that can be merged -- Added Squiz ForbiddenStylesSniff to check for usage of browser specific styles -- Added Squiz OpacitySniff to check for incorrect opacity values in CSS -- Added Squiz LowercaseStyleDefinitionSniff to check for styles that are not defined in lowercase -- Added Squiz MissingColonSniff to check for style definitions where the colon has been forgotten -- Added Squiz MultiLineFunctionDeclarationSniff to check that multi-line declarations contain one param per line -- Added Squiz JSLintSniff to check for JS errors using the jslint.js script through Rhino - - Set jslint path using phpcs --config-set jslint_path /path/to/jslint.js - - Set rhino path using phpcs --config-set rhino_path /path/to/rhino -- Added Generic TodoSniff that warns about comments that contain the word TODO -- Removed MultipleStatementAlignmentSniff from the PEAR standard as alignment is now optional -- Generic ForbiddenFunctionsSniff now has protected member var to specify if it should use errors or warnings -- Generic MultipleStatementAlignmentSniff now has correct error message if assignment is on a new line -- Generic MultipleStatementAlignmentSniff now has protected member var to allow it to ignore multi-line assignments -- Generic LineEndingsSniff now supports checking of JS files -- Generic LineEndingsSniff now supports checking of CSS files -- Generic DisallowTabIndentSniff now supports checking of CSS files -- Squiz DoubleQuoteUsageSniff now bans the use of variables in double quoted strings in favour of concatenation -- Squiz SuperfluousWhitespaceSniff now supports checking of JS files -- Squiz SuperfluousWhitespaceSniff now supports checking of CSS files -- Squiz DisallowInlineIfSniff now supports checking of JS files -- Squiz SemicolonSpacingSniff now supports checking of JS files -- Squiz PostStatementCommentSniff now supports checking of JS files -- Squiz FunctionOpeningBraceSpacingSniff now supports checking of JS files -- Squiz FunctionClosingBraceSpacingSniff now supports checking of JS files - - Empty JS functions must have their opening and closing braces next to each other -- Squiz ControlStructureSpacingSniff now supports checking of JS files -- Squiz LongConditionClosingCommentSniff now supports checking of JS files -- Squiz OperatorSpacingSniff now supports checking of JS files -- Squiz SwitchDeclarationSniff now supports checking of JS files -- Squiz CommentedOutCodeSniff now supports checking of CSS files -- Squiz DisallowSizeFunctionsInLoopsSniff now supports checking of JS files for the use of object.length -- Squiz DisallowSizeFunctionsInLoopsSniff no longer complains about size functions outside of the FOR condition -- Squiz ControlStructureSpacingSniff now bans blank lines at the end of a control structure -- Squiz ForLoopDeclarationSniff no longer throws errors for JS FOR loops without semicolons -- Squiz MultipleStatementAlignmentSniff no longer throws errors if a statement would take more than 8 spaces to align -- Squiz standard now uses Generic TodoSniff -- Squiz standard now uses Generic UnnecessaryStringConcatSniff -- Squiz standard now uses PEAR MultiLineAssignmentSniff -- Squiz standard now uses PEAR MultiLineConditionSniff -- Zend standard now uses OpeningFunctionBraceBsdAllmanSniff (feature request [#14647][pear-14647]) -- MySource JoinStringsSniff now bans the use of inline array joins and suggests the + operator -- Fixed incorrect errors that can be generated from abstract scope sniffs when moving to a new file -- Core tokenizer now matches orphaned curly braces in the same way as square brackets -- Whitespace tokens at the end of JS files are now added to the token stack -- JavaScript tokenizer now identifies properties and labels as new token types -- JavaScript tokenizer now identifies object definitions as a new token type and matches curly braces for them -- JavaScript tokenizer now identifies DIV_EQUAL and MUL_EQUAL tokens -- Improved regular expression detection in the JavaScript tokenizer -- Improve AbstractPatternSniff support so it can listen for any token type, not just weighted tokens - -### Fixed -- Fixed Squiz DoubleQuoteUsageSniff so it works correctly with short_open_tag=Off -- Fixed bug [#14409][pear-14409] : Output of warnings to log file -- Fixed bug [#14520][pear-14520] : Notice: Undefined offset: 1 in `CodeSniffer/File.php` on line -- Fixed bug [#14637][pear-14637] : Call to processUnknownArguments() misses second parameter $pos - - Thanks to [Peter Buri][pear-burci] for the patch -- Fixed bug [#14889][pear-14889] : Lack of clarity: licence or license -- Fixed bug [#15008][pear-15008] : Nested Parentheses in Control Structure Sniffs -- Fixed bug [#15091][pear-15091] : pre-commit hook attempts to sniff folders - - Thanks to [Bruce Weirdan][pear-weirdan] for the patch -- Fixed bug [#15124][pear-15124] : `AbstractParser.php` uses deprecated `split()` function - - Thanks to [Sebastian Bergmann][@sebastianbergmann] for the patch -- Fixed bug [#15188][pear-15188] : PHPCS vs HEREDOC strings -- Fixed bug [#15231][pear-15231] : Notice: Uninitialized string offset: 0 in `FileCommentSniff.php` on line 555 -- Fixed bug [#15336][pear-15336] : Notice: Undefined offset: 2 in `CodeSniffer/File.php` on line - -[pear-13242]: https://pear.php.net/bugs/bug.php?id=13242 -[pear-14409]: https://pear.php.net/bugs/bug.php?id=14409 -[pear-14520]: https://pear.php.net/bugs/bug.php?id=14520 -[pear-14637]: https://pear.php.net/bugs/bug.php?id=14637 -[pear-14647]: https://pear.php.net/bugs/bug.php?id=14647 -[pear-14889]: https://pear.php.net/bugs/bug.php?id=14889 -[pear-14953]: https://pear.php.net/bugs/bug.php?id=14953 -[pear-15008]: https://pear.php.net/bugs/bug.php?id=15008 -[pear-15091]: https://pear.php.net/bugs/bug.php?id=15091 -[pear-15124]: https://pear.php.net/bugs/bug.php?id=15124 -[pear-15188]: https://pear.php.net/bugs/bug.php?id=15188 -[pear-15231]: https://pear.php.net/bugs/bug.php?id=15231 -[pear-15336]: https://pear.php.net/bugs/bug.php?id=15336 - -## 1.1.0 - 2008-07-14 - -### Changed -- PEAR FileCommentSniff now allows tag orders to be overridden in child classes - - Thanks to Jeff Hodsdon for the patch -- Added Generic DisallowMultipleStatementsSniff to ensure there is only one statement per line -- Squiz standard now uses DisallowMultipleStatementsSniff - -### Fixed -- Fixed error in Zend ValidVariableNameSniff when checking vars in form: $class->{$var} -- Fixed bug [#14077][pear-14077] : Fatal error: Uncaught PHP_CodeSniffer_Exception: $stackPtr is not a class member -- Fixed bug [#14168][pear-14168] : Global Function -> Static Method and __autoload() -- Fixed bug [#14238][pear-14238] : Line length not checked at last line of a file -- Fixed bug [#14249][pear-14249] : wrong detection of scope_opener -- Fixed bug [#14250][pear-14250] : ArrayDeclarationSniff emit warnings at malformed array -- Fixed bug [#14251][pear-14251] : --extensions option doesn't work - -## 1.1.0RC3 - 2008-07-03 - -### Changed -- PEAR FileCommentSniff now allows tag orders to be overridden in child classes - - Thanks to Jeff Hodsdon for the patch -- Added Generic DisallowMultipleStatementsSniff to ensure there is only one statement per line -- Squiz standard now uses DisallowMultipleStatementsSniff - -### Fixed -- Fixed error in Zend ValidVariableNameSniff when checking vars in form: $class->{$var} -- Fixed bug [#14077][pear-14077] : Fatal error: Uncaught PHP_CodeSniffer_Exception: $stackPtr is not a class member -- Fixed bug [#14168][pear-14168] : Global Function -> Static Method and __autoload() -- Fixed bug [#14238][pear-14238] : Line length not checked at last line of a file -- Fixed bug [#14249][pear-14249] : wrong detection of scope_opener -- Fixed bug [#14250][pear-14250] : ArrayDeclarationSniff emit warnings at malformed array -- Fixed bug [#14251][pear-14251] : --extensions option doesn't work - -[pear-14077]: https://pear.php.net/bugs/bug.php?id=14077 -[pear-14168]: https://pear.php.net/bugs/bug.php?id=14168 -[pear-14238]: https://pear.php.net/bugs/bug.php?id=14238 -[pear-14249]: https://pear.php.net/bugs/bug.php?id=14249 -[pear-14250]: https://pear.php.net/bugs/bug.php?id=14250 -[pear-14251]: https://pear.php.net/bugs/bug.php?id=14251 - -## 1.1.0RC2 - 2008-06-13 - -### Changed -- Permission denied errors now stop script execution but still display current errors (feature request [#14076][pear-14076]) -- Added Squiz ValidArrayIndexNameSniff to ensure array indexes do not use camel case -- Squiz ArrayDeclarationSniff now ensures arrays are not declared with camel case index values -- PEAR ValidVariableNameSniff now alerts about a possible parse error for member vars inside an interface - -### Fixed -- Fixed bug [#13921][pear-13921] : js parsing fails for comments on last line of file -- Fixed bug [#13922][pear-13922] : crash in case of malformed (but tokenized) PHP file - - PEAR and Squiz ClassDeclarationSniff now throw warnings for possible parse errors - - Squiz ValidClassNameSniff now throws warning for possible parse errors - - Squiz ClosingDeclarationCommentSniff now throws additional warnings for parse errors - -[pear-13921]: https://pear.php.net/bugs/bug.php?id=13921 -[pear-13922]: https://pear.php.net/bugs/bug.php?id=13922 -[pear-14076]: https://pear.php.net/bugs/bug.php?id=14076 - -## 1.1.0RC1 - 2008-05-13 - -### Changed -- Added support for multiple tokenizers so PHP_CodeSniffer can check more than just PHP files - - PHP_CodeSniffer now has a JS tokenizer for checking JavaScript files - - Sniffs need to be updated to work with additional tokenizers, or new sniffs written for them -- phpcs now exits with status 2 if the tokenizer extension has been disabled (feature request [#13269][pear-13269]) -- Added scripts/phpcs-svn-pre-commit that can be used as an SVN pre-commit hook - - Also reworked the way the phpcs script works to make it easier to wrap it with other functionality - - Thanks to Jack Bates for the contribution -- Fixed error in phpcs error message when a supplied file does not exist -- Fixed a cosmetic error in AbstractPatternSniff where the "found" string was missing some content -- Added sniffs that implement part of the PMD rule catalog to the Generic standard - - Thanks to [Manuel Pichler][@manuelpichler] for the contribution of all these sniffs. -- Squiz FunctionCommentThrowTagSniff no longer throws errors for function that only throw variables -- Generic ScopeIndentSniff now has private member to enforce exact indent matching -- Replaced Squiz DisallowCountInLoopsSniff with Squiz DisallowSizeFunctionsInLoopsSniff - - Thanks to Jan Miczaika for the sniff -- Squiz BlockCommentSniff now checks inline doc block comments -- Squiz InlineCommentSniff now checks inline doc block comments -- Squiz BlockCommentSniff now checks for no blank line before first comment in a function -- Squiz DocCommentAlignmentSniff now ignores inline doc block comments -- Squiz ControlStructureSpacingSniff now ensures no blank lines at the start of control structures -- Squiz ControlStructureSpacingSniff now ensures no blank lines between control structure closing braces -- Squiz IncrementDecrementUsageSniff now ensures inc/dec ops are bracketed in string concats -- Squiz IncrementDecrementUsageSniff now ensures inc/dec ops are not used in arithmetic operations -- Squiz FunctionCommentSniff no longer throws errors if return value is mixed but function returns void somewhere -- Squiz OperatorBracketSniff no allows function call brackets to count as operator brackets -- Squiz DoubleQuoteUsageSniff now supports \x \f and \v (feature request [#13365][pear-13365]) -- Squiz ComparisonOperatorUsageSniff now supports JS files -- Squiz ControlSignatureSniff now supports JS files -- Squiz ForLoopDeclarationSniff now supports JS files -- Squiz OperatorBracketSniff now supports JS files -- Squiz InlineControlStructureSniff now supports JS files -- Generic LowerCaseConstantSniff now supports JS files -- Generic DisallowTabIndentSniff now supports JS files -- Generic MultipleStatementAlignmentSniff now supports JS files -- Added Squiz ObjectMemberCommaSniff to ensure the last member of a JS object is not followed by a comma -- Added Squiz ConstantCaseSniff to ensure the PHP constants are uppercase and JS lowercase -- Added Squiz JavaScriptLintSniff to check JS files with JSL - - Set path using phpcs --config-set jsl_path /path/to/jsl -- Added MySource FirebugConsoleSniff to ban the use of "console" for JS variable and function names -- Added MySource JoinStringsSniff to enforce the use of join() to concatenate JS strings -- Added MySource AssignThisSniff to ensure this is only assigned to a var called self -- Added MySource DisallowNewWidgetSniff to ban manual creation of widget objects -- Removed warning shown in Zend CodeAnalyzerSniff when the ZCA path is not set - -### Fixed -- Fixed error in Squiz ValidVariableNameSniff when checking vars in the form $obj->$var -- Fixed error in Squiz DisallowMultipleAssignmentsSniff when checking vars in the form $obj->$var -- Fixed error in Squiz InlineCommentSniff where comments for class constants were seen as inline -- Fixed error in Squiz BlockCommentSniff where comments for class constants were not ignored -- Fixed error in Squiz OperatorBracketSniff where negative numbers were ignored during comparisons -- Fixed error in Squiz FunctionSpacingSniff where functions after member vars reported incorrect spacing -- Fixed bug [#13062][pear-13062] : Interface comments aren't handled in PEAR standard - - Thanks to [Manuel Pichler][@manuelpichler] for the path -- Fixed bug [#13119][pear-13119] : PHP minimum requirement need to be fix -- Fixed bug [#13156][pear-13156] : Bug in Squiz_Sniffs_PHP_NonExecutableCodeSniff -- Fixed bug [#13158][pear-13158] : Strange behaviour in AbstractPatternSniff -- Fixed bug [#13169][pear-13169] : Undefined variables -- Fixed bug [#13178][pear-13178] : Catch exception in `File.php` -- Fixed bug [#13254][pear-13254] : Notices output in checkstyle report causes XML issues -- Fixed bug [#13446][pear-13446] : crash with src of phpMyAdmin - - Thanks to [Manuel Pichler][@manuelpichler] for the path - -[pear-13062]: https://pear.php.net/bugs/bug.php?id=13062 -[pear-13119]: https://pear.php.net/bugs/bug.php?id=13119 -[pear-13156]: https://pear.php.net/bugs/bug.php?id=13156 -[pear-13158]: https://pear.php.net/bugs/bug.php?id=13158 -[pear-13169]: https://pear.php.net/bugs/bug.php?id=13169 -[pear-13178]: https://pear.php.net/bugs/bug.php?id=13178 -[pear-13254]: https://pear.php.net/bugs/bug.php?id=13254 -[pear-13269]: https://pear.php.net/bugs/bug.php?id=13269 -[pear-13365]: https://pear.php.net/bugs/bug.php?id=13365 -[pear-13446]: https://pear.php.net/bugs/bug.php?id=13446 - -## 1.0.1a1 - 2008-04-21 - -### Changed -- Fixed error in PEAR ValidClassNameSniff when checking class names with double underscores -- Moved Squiz InlineControlStructureSniff into Generic standard -- PEAR standard now throws warnings for inline control structures -- Squiz OutputBufferingIndentSniff now ignores the indentation of inline HTML -- MySource IncludeSystemSniff now ignores usage of ZipArchive -- Removed "function" from error messages for Generic function brace sniffs (feature request [#13820][pear-13820]) -- Generic UpperCaseConstantSniff no longer throws errors for declare(ticks = ...) - - Thanks to Josh Snyder for the patch -- Squiz ClosingDeclarationCommentSniff and AbstractVariableSniff now throw warnings for possible parse errors - -### Fixed -- Fixed bug [#13827][pear-13827] : AbstractVariableSniff throws "undefined index" -- Fixed bug [#13846][pear-13846] : Bug in Squiz.NonExecutableCodeSniff -- Fixed bug [#13849][pear-13849] : infinite loop in PHP_CodeSniffer_File::findNext() - -[pear-13820]: https://pear.php.net/bugs/bug.php?id=13820 -[pear-13827]: https://pear.php.net/bugs/bug.php?id=13827 -[pear-13846]: https://pear.php.net/bugs/bug.php?id=13846 -[pear-13849]: https://pear.php.net/bugs/bug.php?id=13849 - -## 1.0.1 - 2008-02-04 - -### Changed -- Squiz ArrayDeclarationSniff now throws error if the array keyword is followed by a space -- Squiz ArrayDeclarationSniff now throws error for empty multi-line arrays -- Squiz ArrayDeclarationSniff now throws error for multi-line arrays with a single value -- Squiz DocCommentAlignmentSniff now checks for a single space before tags inside docblocks -- Squiz ForbiddenFunctionsSniff now disallows is_null() to force use of (=== NULL) instead -- Squiz VariableCommentSniff now continues throwing errors after the first one is found -- Squiz SuperfluousWhitespaceSniff now throws errors for multiple blank lines inside functions -- MySource IncludedSystemSniff now checks extended class names -- MySource UnusedSystemSniff now checks extended and implemented class names -- MySource IncludedSystemSniff now supports includeWidget() -- MySource UnusedSystemSniff now supports includeWidget() -- Added PEAR ValidVariableNameSniff to check that only private member vars are prefixed with an underscore -- Added Squiz DisallowCountInLoopsSniff to check for the use of count() in FOR and WHILE loop conditions -- Added MySource UnusedSystemSniff to check for included classes that are never used - -### Fixed -- Fixed a problem that caused the parentheses map to sometimes contain incorrect values -- Fixed bug [#12767][pear-12767] : Cant run phpcs from dir with PEAR subdir -- Fixed bug [#12773][pear-12773] : Reserved variables are not detected in strings - - Thanks to [Wilfried Loche][pear-wloche] for the patch -- Fixed bug [#12832][pear-12832] : Tab to space conversion does not work -- Fixed bug [#12888][pear-12888] : extra space indentation = Notice: Uninitialized string offset... -- Fixed bug [#12909][pear-12909] : Default generateDocs function does not work under linux - - Thanks to [Paul Smith][pear-thing2b] for the patch -- Fixed bug [#12957][pear-12957] : PHP 5.3 magic method __callStatic - - Thanks to [Manuel Pichler][@manuelpichler] for the patch - -[pear-12767]: https://pear.php.net/bugs/bug.php?id=12767 -[pear-12773]: https://pear.php.net/bugs/bug.php?id=12773 -[pear-12832]: https://pear.php.net/bugs/bug.php?id=12832 -[pear-12888]: https://pear.php.net/bugs/bug.php?id=12888 -[pear-12909]: https://pear.php.net/bugs/bug.php?id=12909 -[pear-12957]: https://pear.php.net/bugs/bug.php?id=12957 - -## 1.0.0 - 2007-12-21 - -### Changed -- You can now specify the full path to a coding standard on the command line (feature request [#11886][pear-11886]) - - This allows you to use standards that are stored outside of PHP_CodeSniffer's own Standard dir - - You can also specify full paths in the `CodingStandard.php` include and exclude methods - - Classes, dirs and files need to be names as if the standard was part of PHP_CodeSniffer - - Thanks to Dirk Thomas for the doc generator patch and testing -- Modified the scope map to keep checking after 3 lines for some tokens (feature request [#12561][pear-12561]) - - Those tokens that must have an opener (like T_CLASS) now keep looking until EOF - - Other tokens (like T_FUNCTION) still stop after 3 lines for performance -- You can now escape commas in ignore patterns so they can be matched in file names - - Thanks to [Carsten Wiedmann][pear-cwiedmann] for the patch -- Config data is now cached in a global var so the file system is not hit so often - - You can also set config data temporarily for the script if you are using your own external script - - Pass TRUE as the third argument to PHP_CodeSniffer::setConfigData() -- PEAR ClassDeclarationSniff no longer throws errors for multi-line class declarations -- Squiz ClassDeclarationSniff now ensures there is one blank line after a class closing brace -- Squiz ClassDeclarationSniff now throws errors for a missing end PHP tag after the end class tag -- Squiz IncrementDecrementUsageSniff no longer throws errors when -= and += are being used with vars -- Squiz SwitchDeclarationSniff now throws errors for switch statements that do not contain a case statement - - Thanks to [Sertan Danis][@sertand] for the patch -- MySource IncludeSystemSniff no longer throws errors for the Util package - -### Fixed -- Fixed bug [#12621][pear-12621] : "space after AS" check is wrong - - Thanks to [Satoshi Oikawa][pear-renoiv] for the patch -- Fixed bug [#12645][pear-12645] : error message is wrong - - Thanks to [Satoshi Oikawa][pear-renoiv] for the patch -- Fixed bug [#12651][pear-12651] : Increment/Decrement Operators Usage at -1 - -[pear-11886]: https://pear.php.net/bugs/bug.php?id=11886 -[pear-12561]: https://pear.php.net/bugs/bug.php?id=12561 -[pear-12621]: https://pear.php.net/bugs/bug.php?id=12621 -[pear-12645]: https://pear.php.net/bugs/bug.php?id=12645 -[pear-12651]: https://pear.php.net/bugs/bug.php?id=12651 - -## 1.0.0RC3 - 2007-11-30 - -### Changed -- Added new command line argument --tab-width that will convert tabs to spaces before testing - - This allows you to use the existing sniffs that check for spaces even when you use tabs - - Can also be set via a config var: phpcs --config-set tab_width 4 - - A value of zero (the default) tells PHP_CodeSniffer not to replace tabs with spaces -- You can now change the default report format from "full" to something else - - Run: phpcs `--config-set report_format [format]` -- Improved performance by optimising the way the scope map is created during tokenizing -- Added new Squiz DisallowInlineIfSniff to disallow the usage of inline IF statements -- Fixed incorrect errors being thrown for nested switches in Squiz SwitchDeclarationSniff -- PEAR FunctionCommentSniff no longer complains about missing comments for @throws tags -- PEAR FunctionCommentSniff now throws error for missing exception class name for @throws tags -- PHP_CodeSniffer_File::isReference() now correctly returns for functions that return references -- Generic LineLengthSniff no longer warns about @version lines with CVS or SVN id tags -- Generic LineLengthSniff no longer warns about @license lines with long URLs -- Squiz FunctionCommentThrowTagSniff no longer complains about throwing variables -- Squiz ComparisonOperatorUsageSniff no longer throws incorrect errors for inline IF statements -- Squiz DisallowMultipleAssignmentsSniff no longer throws errors for assignments in inline IF statements - -### Fixed -- Fixed bug [#12455][pear-12455] : CodeSniffer treats content inside heredoc as PHP code -- Fixed bug [#12471][pear-12471] : Checkstyle report is broken -- Fixed bug [#12476][pear-12476] : PHP4 destructors are reported as error -- Fixed bug [#12513][pear-12513] : Checkstyle XML messages need to be utf8_encode()d - - Thanks to [Sebastian Bergmann][@sebastianbergmann] for the patch. -- Fixed bug [#12517][pear-12517] : getNewlineAfter() and dos files - -[pear-12455]: https://pear.php.net/bugs/bug.php?id=12455 -[pear-12471]: https://pear.php.net/bugs/bug.php?id=12471 -[pear-12476]: https://pear.php.net/bugs/bug.php?id=12476 -[pear-12513]: https://pear.php.net/bugs/bug.php?id=12513 -[pear-12517]: https://pear.php.net/bugs/bug.php?id=12517 - -## 1.0.0RC2 - 2007-11-14 - -### Changed -- Added a new Checkstyle report format - - Like the current XML format but modified to look like Checkstyle output - - Thanks to [Manuel Pichler][@manuelpichler] for helping get the format correct -- You can now hide warnings by default - - Run: phpcs --config-set show_warnings 0 - - If warnings are hidden by default, use the new -w command line argument to override -- Added new command line argument --config-delete to delete a config value and revert to the default -- Improved overall performance by optimising tokenizing and next/prev methods (feature request [#12421][pear-12421]) - - Thanks to [Christian Weiske][@cweiske] for the patch -- Added FunctionCallSignatureSniff to Squiz standard -- Added @subpackage support to file and class comment sniffs in PEAR standard (feature request [#12382][pear-12382]) - - Thanks to [Carsten Wiedmann][pear-cwiedmann] for the patch -- An error is now displayed if you use a PHP version less than 5.1.0 (feature request [#12380][pear-12380]) - - Thanks to [Carsten Wiedmann][pear-cwiedmann] for the patch -- phpcs now exits with status 2 if it receives invalid input (feature request [#12380][pear-12380]) - - This is distinct from status 1, which indicates errors or warnings were found -- Added new Squiz LanguageConstructSpacingSniff to throw errors for additional whitespace after echo etc. -- Removed Squiz ValidInterfaceNameSniff -- PEAR FunctionCommentSniff no longer complains about unknown tags - -### Fixed -- Fixed incorrect errors about missing function comments in PEAR FunctionCommentSniff -- Fixed incorrect function docblock detection in Squiz FunctionCommentSniff -- Fixed incorrect errors for list() in Squiz DisallowMultipleAssignmentsSniff -- Errors no longer thrown if control structure is followed by a CASE's BREAK in Squiz ControlStructureSpacingSniff -- Fixed bug [#12368][pear-12368] : Autoloader cannot be found due to include_path override - - Thanks to [Richard Quadling][pear-rquadling] for the patch -- Fixed bug [#12378][pear-12378] : equal sign alignments problem with while() - -[pear-12368]: https://pear.php.net/bugs/bug.php?id=12368 -[pear-12378]: https://pear.php.net/bugs/bug.php?id=12378 -[pear-12380]: https://pear.php.net/bugs/bug.php?id=12380 -[pear-12382]: https://pear.php.net/bugs/bug.php?id=12382 -[pear-12421]: https://pear.php.net/bugs/bug.php?id=12421 - -## 1.0.0RC1 - 2007-11-01 - -### Changed -- Main phpcs script can now be run from a CVS checkout without installing the package -- Added a new CSV report format - - Header row indicates what position each element is in - - Always use the header row to determine positions rather than assuming the format, as it may change -- XML and CSV report formats now contain information about which column the error occurred at - - Useful if you want to highlight the token that caused the error in a custom application -- Square bracket tokens now have bracket_opener and bracket_closer set -- Added new Squiz SemicolonSpacingSniff to throw errors if whitespace is found before a semicolon -- Added new Squiz ArrayBracketSpacingSniff to throw errors if whitespace is found around square brackets -- Added new Squiz ObjectOperatorSpacingSniff to throw errors if whitespace is found around object operators -- Added new Squiz DisallowMultipleAssignmentsSniff to throw errors if multiple assignments are on the same line -- Added new Squiz ScopeKeywordSpacingSniff to throw errors if there is not a single space after a scope modifier -- Added new Squiz ObjectInstantiationSniff to throw errors if new objects are not assigned to a variable -- Added new Squiz FunctionDuplicateArgumentSniff to throw errors if argument is declared multiple times in a function -- Added new Squiz FunctionOpeningBraceSpaceSniff to ensure there are no blank lines after a function open brace -- Added new Squiz CommentedOutCodeSniff to warn about comments that looks like they are commented out code blocks -- Added CyclomaticComplexitySniff to Squiz standard -- Added NestingLevelSniff to Squiz standard -- Squiz ForbiddenFunctionsSniff now recommends echo() instead of print() -- Squiz ValidLogicalOperatorsSniff now recommends ^ instead of xor -- Squiz SwitchDeclarationSniff now contains more checks - - A single space is required after the case keyword - - No space is allowed before the colon in a case or default statement - - All switch statements now require a default case - - Default case must contain a break statement - - Empty default case must contain a comment describing why the default is ignored - - Empty case statements are not allowed - - Case and default statements must not be followed by a blank line - - Break statements must be followed by a blank line or the closing brace - - There must be no blank line before a break statement -- Squiz standard is now using the PEAR IncludingFileSniff -- PEAR ClassCommentSniff no longer complains about unknown tags -- PEAR FileCommentSniff no longer complains about unknown tags -- PEAR FileCommentSniff now accepts multiple @copyright tags -- Squiz BlockCommentSniff now checks that comment starts with a capital letter -- Squiz InlineCommentSniff now has better checking to ensure comment starts with a capital letter -- Squiz ClassCommentSniff now checks that short and long comments start with a capital letter -- Squiz FunctionCommentSniff now checks that short, long and param comments start with a capital letter -- Squiz VariableCommentSniff now checks that short and long comments start with a capital letter - -### Fixed -- Fixed error with multi-token array indexes in Squiz ArrayDeclarationSniff -- Fixed error with checking shorthand IF statements without a semicolon in Squiz InlineIfDeclarationSniff -- Fixed error where constants used as default values in function declarations were seen as type hints -- Fixed bug [#12316][pear-12316] : PEAR is no longer the default standard -- Fixed bug [#12321][pear-12321] : wrong detection of missing function docblock - -[pear-12316]: https://pear.php.net/bugs/bug.php?id=12316 -[pear-12321]: https://pear.php.net/bugs/bug.php?id=12321 - -## 0.9.0 - 2007-09-24 - -### Changed -- Added a config system for setting config data across phpcs runs -- You can now change the default coding standard from PEAR to something else - - Run: phpcs `--config-set default_standard [standard]` -- Added new Zend coding standard to check code against the Zend Framework standards - - The complete standard is not yet implemented - - Specify --standard=Zend to use - - Thanks to Johann-Peter Hartmann for the contribution of some sniffs - - Thanks to Holger Kral for the Code Analyzer sniff - -## 0.8.0 - 2007-08-08 - -### Changed -- Added new XML report format; --report=xml (feature request [#11535][pear-11535]) - - Thanks to [Brett Bieber][@saltybeagle] for the patch -- Added new command line argument --ignore to specify a list of files to skip (feature request [#11556][pear-11556]) -- Added PHPCS and MySource coding standards into the core install -- Scope map no longer gets confused by curly braces that act as string offsets -- Removed `CodeSniffer/SniffException.php` as it is no longer used -- Unit tests can now be run directly from a CVS checkout -- Made private vars and functions protected in PHP_CodeSniffer class so this package can be overridden -- Added new Metrics category to Generic coding standard - - Contains Cyclomatic Complexity and Nesting Level sniffs - - Thanks to Johann-Peter Hartmann for the contribution -- Added new Generic DisallowTabIndentSniff to throw errors if tabs are used for indentation (feature request [#11738][pear-11738]) - - PEAR and Squiz standards use this new sniff to throw more specific indentation errors -- Generic MultipleStatementAlignmentSniff has new private var to set a padding size limit (feature request [#11555][pear-11555]) -- Generic MultipleStatementAlignmentSniff can now handle assignments that span multiple lines (feature request [#11561][pear-11561]) -- Generic LineLengthSniff now has a max line length after which errors are thrown instead of warnings - - BC BREAK: Override the protected member var absoluteLineLimit and set it to zero in custom LineLength sniffs - - Thanks to Johann-Peter Hartmann for the contribution -- Comment sniff errors about incorrect tag orders are now more descriptive (feature request [#11693][pear-11693]) - -### Fixed -- Fixed bug [#11473][pear-11473] : Invalid CamelCaps name when numbers used in names - -[pear-11473]: https://pear.php.net/bugs/bug.php?id=11473 -[pear-11535]: https://pear.php.net/bugs/bug.php?id=11535 -[pear-11555]: https://pear.php.net/bugs/bug.php?id=11555 -[pear-11556]: https://pear.php.net/bugs/bug.php?id=11556 -[pear-11561]: https://pear.php.net/bugs/bug.php?id=11561 -[pear-11693]: https://pear.php.net/bugs/bug.php?id=11693 -[pear-11738]: https://pear.php.net/bugs/bug.php?id=11738 - -## 0.7.0 - 2007-07-02 - -### Changed -- BC BREAK: EOL character is now auto-detected and used instead of hard-coded \n - - Pattern sniffs must now specify "EOL" instead of "\n" or "\r\n" to use auto-detection - - Please use $phpcsFile->eolChar to check for newlines instead of hard-coding "\n" or "\r\n" - - Comment parser classes now require you to pass $phpcsFile as an additional argument -- BC BREAK: Included and excluded sniffs now require `.php` extension - - Please update your coding standard classes and add `.php` to all sniff entries - - See `CodeSniffer/Standards/PEAR/PEARCodingStandard.php` for an example -- Fixed error where including a directory of sniffs in a coding standard class did not work -- Coding standard classes can now specify a list of sniffs to exclude as well as include (feature request [#11056][pear-11056]) -- Two uppercase characters can now be placed side-by-side in class names in Squiz ValidClassNameSniff -- SVN tags now allowed in PEAR file doc blocks (feature request [#11038][pear-11038]) - - Thanks to [Torsten Roehr][pear-troehr] for the patch -- Private methods in commenting sniffs and comment parser are now protected (feature request [#11087][pear-11087]) -- Added Generic LineEndingsSniff to check the EOL character of a file -- PEAR standard now only throws one error per file for incorrect line endings (eg. /r/n) -- Command line arg -v now shows number of registered sniffs -- Command line arg -vvv now shows list of registered sniffs -- Squiz ControlStructureSpacingSniff no longer throws errors if the control structure is at the end of the script -- Squiz FunctionCommentSniff now throws error for "return void" if function has return statement -- Squiz FunctionCommentSniff now throws error for functions that return void but specify something else -- Squiz ValidVariableNameSniff now allows multiple uppercase letters in a row -- Squiz ForEachLoopDeclarationSniff now throws error for AS keyword not being lowercase -- Squiz SwitchDeclarationSniff now throws errors for CASE/DEFAULT/BREAK keywords not being lowercase -- Squiz ArrayDeclarationSniff now handles multi-token array values when checking alignment -- Squiz standard now enforces a space after cast tokens -- Generic MultipleStatementAlignmentSniff no longer gets confused by assignments inside FOR conditions -- Generic MultipleStatementAlignmentSniff no longer gets confused by the use of list() -- Added Generic SpaceAfterCastSniff to ensure there is a single space after a cast token -- Added Generic NoSpaceAfterCastSniff to ensure there is no whitespace after a cast token -- Added PEAR ClassDeclarationSniff to ensure the opening brace of a class is on the line after the keyword -- Added Squiz ScopeClosingBraceSniff to ensure closing braces are aligned correctly -- Added Squiz EvalSniff to discourage the use of eval() -- Added Squiz LowercaseDeclarationSniff to ensure all declaration keywords are lowercase -- Added Squiz LowercaseClassKeywordsSniff to ensure all class declaration keywords are lowercase -- Added Squiz LowercaseFunctionKeywordsSniff to ensure all function declaration keywords are lowercase -- Added Squiz LowercasePHPFunctionsSniff to ensure all calls to inbuilt PHP functions are lowercase -- Added Squiz CastSpacingSniff to ensure cast statements don't contain whitespace -- Errors no longer thrown when checking 0 length files with verbosity on - -### Fixed -- Fixed bug [#11105][pear-11105] : getIncludedSniffs() not working anymore - - Thanks to [Blair Robertson][pear-adviva] for the patch -- Fixed bug [#11120][pear-11120] : Uninitialized string offset in `AbstractParser.php` on line 200 - -[pear-11038]: https://pear.php.net/bugs/bug.php?id=11038 -[pear-11056]: https://pear.php.net/bugs/bug.php?id=11056 -[pear-11087]: https://pear.php.net/bugs/bug.php?id=11087 -[pear-11105]: https://pear.php.net/bugs/bug.php?id=11105 -[pear-11120]: https://pear.php.net/bugs/bug.php?id=11120 - -## 0.6.0 - 2007-05-15 - -### Changed -- The number of errors and warnings found is now shown for each file while checking the file if verbosity is enabled -- Now using PHP_EOL instead of hard-coded \n so output looks good on Windows (feature request [#10761][pear-10761]) - - Thanks to [Carsten Wiedmann][pear-cwiedmann] for the patch. -- phpcs now exits with status 0 (no errors) or 1 (errors found) (feature request [#10348][pear-10348]) -- Added new -l command line argument to stop recursion into directories (feature request [#10979][pear-10979]) - -### Fixed -- Fixed variable name error causing incorrect error message in Squiz ValidVariableNameSniff -- Fixed bug [#10757][pear-10757] : Error in ControlSignatureSniff -- Fixed bugs [#10751][pear-10751], [#10777][pear-10777] : Sniffer class paths handled incorrectly in Windows - - Thanks to [Carsten Wiedmann][pear-cwiedmann] for the patch. -- Fixed bug [#10961][pear-10961] : Error "Last parameter comment requires a blank newline after it" thrown -- Fixed bug [#10983][pear-10983] : phpcs outputs notices when checking invalid PHP -- Fixed bug [#10980][pear-10980] : Incorrect warnings for equals sign - -[pear-10348]: https://pear.php.net/bugs/bug.php?id=10348 -[pear-10751]: https://pear.php.net/bugs/bug.php?id=10751 -[pear-10757]: https://pear.php.net/bugs/bug.php?id=10757 -[pear-10761]: https://pear.php.net/bugs/bug.php?id=10761 -[pear-10777]: https://pear.php.net/bugs/bug.php?id=10777 -[pear-10961]: https://pear.php.net/bugs/bug.php?id=10961 -[pear-10979]: https://pear.php.net/bugs/bug.php?id=10979 -[pear-10980]: https://pear.php.net/bugs/bug.php?id=10980 -[pear-10983]: https://pear.php.net/bugs/bug.php?id=10983 - -## 0.5.0 - 2007-04-17 - -### Changed -- BC BREAK: Coding standards now require a class to be added so PHP_CodeSniffer can get information from them - - Please read the end user docs for info about the new class required for all coding standards -- Coding standards can now include sniffs from other standards, or whole standards, without writing new sniff files -- PHP_CodeSniffer_File::isReference() now correctly returns for references in function declarations -- PHP_CodeSniffer_File::isReference() now returns false if you don't pass it a T_BITWISE_AND token -- PHP_CodeSniffer_File now stores the absolute path to the file so sniffs can check file locations correctly -- Fixed undefined index error in AbstractVariableSniff for variables inside an interface function definition -- Added MemberVarSpacingSniff to Squiz standard to enforce one-line spacing between member vars -- Add FunctionCommentThrowTagSniff to Squiz standard to check that @throws tags are correct - -### Fixed -- Fixed problems caused by references and type hints in Squiz FunctionDeclarationArgumentSpacingSniff -- Fixed problems with errors not being thrown for some misaligned @param comments in Squiz FunctionCommentSniff -- Fixed badly spaced comma error being thrown for "extends" class in Squiz ClassDeclarationSniff -- Errors no longer thrown for class method names in Generic ForbiddenFunctionsSniff -- Errors no longer thrown for type hints in front of references in Generic UpperCaseConstantNameSniff -- Errors no longer thrown for correctly indented buffered lines in Squiz ScopeIndexSniff -- Errors no longer thrown for user-defined functions named as forbidden functions in Generic ForbiddenFunctionsSniff -- Errors no longer thrown on __autoload functions in PEAR ValidFunctionNameSniff -- Errors now thrown for __autoload methods in PEAR ValidFunctionNameSniff -- Errors now thrown if constructors or destructors have @return tags in Squiz FunctionCommentSniff -- Errors now thrown if @throws tags don't start with a capital and end with a full stop in Squiz FunctionCommentSniff -- Errors now thrown for invalid @var tag values in Squiz VariableCommentSniff -- Errors now thrown for missing doc comment in Squiz VariableCommentSniff -- Errors now thrown for unspaced operators in FOR loop declarations in Squiz OperatorSpacingSniff -- Errors now thrown for using ob_get_clean/flush functions to end buffers in Squiz OutputBufferingIndentSniff -- Errors now thrown for all missing member variable comments in Squiz VariableCommentSniff - -## 0.4.0 - 2007-02-19 - -### Changed -- Standard name specified with --standard command line argument is no longer case sensitive -- Long error and warning messages are now wrapped to 80 characters in the full error report (thanks Endre Czirbesz) -- Shortened a lot of error and warning messages so they don't take up so much room -- Squiz FunctionCommentSniff now checks that param comments start with a capital letter and end with a full stop -- Squiz FunctionSpacingSniff now reports incorrect lines below function on closing brace, not function keyword -- Squiz FileCommentSniff now checks that there are no blank lines between the open PHP tag and the comment -- PHP_CodeSniffer_File::isReference() now returns correctly when checking refs on right side of => - -### Fixed -- Fixed incorrect error with switch closing brace in Squiz SwitchDeclarationSniff -- Fixed missing error when multiple statements are not aligned correctly with object operators -- Fixed incorrect errors for some PHP special variables in Squiz ValidVariableNameSniff -- Fixed incorrect errors for arrays that only contain other arrays in Squiz ArrayDeclarationSniff -- Fixed bug [#9844][pear-9844] : throw new Exception(\n accidentally reported as error but it ain't - -[pear-9844]: https://pear.php.net/bugs/bug.php?id=9844 - -## 0.3.0 - 2007-01-11 - -### Changed -- Updated package.xml to version 2 -- Specifying coding standard on command line is now optional, even if you have multiple standards installed - - PHP_CodeSniffer uses the PEAR coding standard by default if no standard is specified -- New command line option, --extensions, to specify a comma separated list of file extensions to check -- Converted all unit tests to PHPUnit 3 format -- Added new coding standard, Squiz, that can be used as an alternative to PEAR - - also contains more examples of sniffs - - some may be moved into the Generic coding standard if required -- Added MultipleStatementAlignmentSniff to Generic standard -- Added ScopeIndentSniff to Generic standard -- Added ForbiddenFunctionsSniff to Generic standard -- Added FileCommentSniff to PEAR standard -- Added ClassCommentSniff to PEAR standard -- Added FunctionCommentSniff to PEAR standard -- Change MultipleStatementSniff to MultipleStatementAlignmentSniff in PEAR standard -- Replaced Methods directory with Functions directory in Generic and PEAR standards - - also renamed some of the sniffs in those directories -- Updated file, class and method comments for all files - -### Fixed -- Fixed bug [#9274][pear-9274] : nested_parenthesis element not set for open and close parenthesis tokens -- Fixed bug [#9411][pear-9411] : too few pattern characters cause incorrect error report - -[pear-9411]: https://pear.php.net/bugs/bug.php?id=9411 - -## 0.2.1 - 2006-11-09 - -### Fixed -- Fixed bug [#9274][pear-9274] : nested_parenthesis element not set for open and close parenthesis tokens - -[pear-9274]: https://pear.php.net/bugs/bug.php?id=9274 - -## 0.2.0 - 2006-10-13 - -### Changed -- Added a generic standards package that will contain generic sniffs to be used in specific coding standards - - thanks to Frederic Poeydomenge for the idea -- Changed PEAR standard to use generic sniffs where available -- Added LowerCaseConstantSniff to Generic standard -- Added UpperCaseConstantSniff to Generic standard -- Added DisallowShortOpenTagSniff to Generic standard -- Added LineLengthSniff to Generic standard -- Added UpperCaseConstantNameSniff to Generic standard -- Added OpeningMethodBraceBsdAllmanSniff to Generic standard (contrib by Frederic Poeydomenge) -- Added OpeningMethodBraceKernighanRitchieSniff to Generic standard (contrib by Frederic Poeydomenge) -- Added framework for core PHP_CodeSniffer unit tests -- Added unit test for PHP_CodeSniffer:isCamelCaps method -- ScopeClosingBraceSniff now checks indentation of BREAK statements -- Added new command line arg (-vv) to show developer debug output - -### Fixed -- Fixed some coding standard errors -- Fixed bug [#8834][pear-8834] : Massive memory consumption -- Fixed bug [#8836][pear-8836] : path case issues in package.xml -- Fixed bug [#8843][pear-8843] : confusion on nested switch() -- Fixed bug [#8841][pear-8841] : comments taken as whitespace -- Fixed bug [#8884][pear-8884] : another problem with nested switch() statements - -[pear-8834]: https://pear.php.net/bugs/bug.php?id=8834 -[pear-8836]: https://pear.php.net/bugs/bug.php?id=8836 -[pear-8841]: https://pear.php.net/bugs/bug.php?id=8841 -[pear-8843]: https://pear.php.net/bugs/bug.php?id=8843 -[pear-8884]: https://pear.php.net/bugs/bug.php?id=8884 - -## 0.1.1 - 2006-09-25 - -### Changed -- Added unit tests for all PEAR sniffs -- Exception class now extends from PEAR_Exception - -### Fixed -- Fixed summary report so files without errors but with warnings are not shown when warnings are hidden - -## 0.1.0 - 2006-09-19 - -### Changed -- Reorganised package contents to conform to PEAR standards -- Changed version numbering to conform to PEAR standards -- Removed duplicate `require_once()` of `Exception.php` from `CodeSniffer.php` - -## 0.0.5 - 2006-09-18 - -### Fixed -- Fixed `.bat` file for situation where `php.ini` cannot be found so `include_path` is not set - -## 0.0.4 - 2006-08-28 - -### Changed -- Added .bat file for easier running of PHP_CodeSniffer on Windows -- Sniff that checks method names now works for PHP4 style code where there is no scope keyword -- Sniff that checks method names now works for PHP4 style constructors -- Sniff that checks method names no longer incorrectly reports error with magic methods -- Sniff that checks method names now reports errors with non-magic methods prefixed with __ -- Sniff that checks for constant names no longer incorrectly reports errors with heredoc strings -- Sniff that checks for constant names no longer incorrectly reports errors with created objects -- Sniff that checks indentation no longer incorrectly reports errors with heredoc strings -- Sniff that checks indentation now correctly reports errors with improperly indented multi-line strings -- Sniff that checks function declarations now checks for spaces before and after an equals sign for default values -- Sniff that checks function declarations no longer incorrectly reports errors with multi-line declarations -- Sniff that checks included code no longer incorrectly reports errors when return value is used conditionally -- Sniff that checks opening brace of function no longer incorrectly reports errors with multi-line declarations -- Sniff that checks spacing after commas in function calls no longer reports too many errors for some code -- Sniff that checks control structure declarations now gives more descriptive error message - -## 0.0.3 - 2006-08-22 - -### Changed -- Added sniff to check for invalid class and interface names -- Added sniff to check for invalid function and method names -- Added sniff to warn if line is greater than 85 characters -- Added sniff to check that function calls are in the correct format -- Added command line arg to print current version (--version) - -### Fixed -- Fixed error where comments were not allowed on the same line as a control structure declaration - -## 0.0.2 - 2006-07-25 - -### Changed -- Removed the including of checked files to stop errors caused by parsing them -- Removed the use of reflection so checked files do not have to be included -- Memory usage has been greatly reduced -- Much faster tokenizing and checking times -- Reworked the PEAR coding standard sniffs (much faster now) -- Fix some bugs with the PEAR scope indentation standard -- Better checking for installed coding standards -- Can now accept multiple files and dirs on the command line -- Added an option to list installed coding standards -- Added an option to print a summary report (number of errors and warnings shown for each file) -- Added an option to hide warnings from reports -- Added an option to print verbose output (so you know what is going on) -- Reordered command line args to put switches first (although order is not enforced) -- Switches can now be specified together (e.g. `phpcs -nv`) as well as separately (`phpcs -n -v`) - -## 0.0.1 - 2006-07-19 - -### Added -- Initial preview release - - - -[Unreleased]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/master...HEAD -[3.13.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.3...3.13.4 -[3.13.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.2...3.13.3 -[3.13.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.1...3.13.2 -[3.13.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.13.0...3.13.1 -[3.13.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.12.2...3.13.0 -[3.12.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.12.1...3.12.2 -[3.12.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.12.0...3.12.1 -[3.12.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.3...3.12.0 -[3.11.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.2...3.11.3 -[3.11.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.1...3.11.2 -[3.11.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.11.0...3.11.1 -[3.11.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.3...3.11.0 -[3.10.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.2...3.10.3 -[3.10.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.1...3.10.2 -[3.10.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.10.0...3.10.1 -[3.10.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.2...3.10.0 -[3.9.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.1...3.9.2 -[3.9.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.9.0...3.9.1 -[3.9.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.8.1...3.9.0 -[3.8.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.8.0...3.8.1 -[3.8.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.7.2...3.8.0 -[3.7.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.7.1...3.7.2 -[3.7.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.7.0...3.7.1 -[3.7.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.6.2...3.7.0 -[3.6.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.6.1...3.6.2 -[3.6.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.6.0...3.6.1 -[3.6.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.8...3.6.0 -[3.5.8]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.7...3.5.8 -[3.5.7]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.6...3.5.7 -[3.5.6]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.5...3.5.6 -[3.5.5]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.4...3.5.5 -[3.5.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.3...3.5.4 -[3.5.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.2...3.5.3 -[3.5.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.1...3.5.2 -[3.5.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.5.0...3.5.1 -[3.5.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.4.2...3.5.0 -[3.4.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.4.1...3.4.2 -[3.4.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.4.0...3.4.1 -[3.4.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.3.2...3.4.0 -[3.3.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.3.1...3.3.2 -[3.3.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.3.0...3.3.1 -[3.3.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.3...3.3.0 -[3.2.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.2...3.2.3 -[3.2.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.1...3.2.2 -[3.2.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.2.0...3.2.1 -[3.2.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.1.1...3.2.0 -[3.1.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.1.0...3.1.1 -[3.1.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.2...3.1.0 -[3.0.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.1...3.0.2 -[3.0.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0...3.0.1 -[3.0.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC4...3.0.0 -[3.0.0RC4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC3...3.0.0RC4 -[3.0.0RC3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC2...3.0.0RC3 -[3.0.0RC2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0RC1...3.0.0RC2 -[3.0.0RC1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/3.0.0a1...3.0.0RC1 -[3.0.0a1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.9.2...3.0.0a1 -[2.9.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.9.1...2.9.2 -[2.9.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.9.0...2.9.1 -[2.9.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.8.1...2.9.0 -[2.8.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.8.0...2.8.1 -[2.8.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.7.1...2.8.0 -[2.7.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.7.0...2.7.1 -[2.7.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.6.2...2.7.0 -[2.6.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.6.1...2.6.2 -[2.6.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.6.0...2.6.1 -[2.6.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.5.1...2.6.0 -[2.5.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.5.0...2.5.1 -[2.5.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.4.0...2.5.0 -[2.4.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.3.4...2.4.0 -[2.3.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.3.3...2.3.4 -[2.3.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.3.2...2.3.3 -[2.3.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.3.1...2.3.2 -[2.3.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.3.0...2.3.1 -[2.3.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.2.0...2.3.0 -[2.2.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.1.0...2.2.0 -[2.1.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.0.0...2.1.0 -[2.0.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.0.0RC4...2.0.0 -[2.0.0RC4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.0.0RC3...2.0.0RC4 -[2.0.0RC3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.0.0RC2...2.0.0RC3 -[2.0.0RC2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.0.0RC1...2.0.0RC2 -[2.0.0RC1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.0.0a2...2.0.0RC1 -[2.0.0a2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/2.0.0a1...2.0.0a2 -[2.0.0a1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.6...2.0.0a1 -[1.5.6]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.5...1.5.6 -[1.5.5]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.4...1.5.5 -[1.5.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.3...1.5.4 -[1.5.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.2...1.5.3 -[1.5.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.1...1.5.2 -[1.5.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.0...1.5.1 -[1.5.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.0RC4...1.5.0 -[1.5.0RC4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.0RC3...1.5.0RC4 -[1.5.0RC3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.0RC2...1.5.0RC3 -[1.5.0RC2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.5.0RC1...1.5.0RC2 -[1.5.0RC1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.8...1.5.0RC1 -[1.4.8]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.7...1.4.8 -[1.4.7]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.6...1.4.7 -[1.4.6]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.5...1.4.6 -[1.4.5]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.4...1.4.5 -[1.4.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.3...1.4.4 -[1.4.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.2...1.4.3 -[1.4.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.1...1.4.2 -[1.4.1]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.4.0...1.4.1 -[1.4.0]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.3.6...1.4.0 -[1.3.6]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.3.5...1.3.6 -[1.3.5]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.3.4...1.3.5 -[1.3.4]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.3.3...1.3.4 -[1.3.3]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.3.2...1.3.3 -[1.3.2]: https://github.com/PHPCSStandards/PHP_CodeSniffer/compare/1.3.1...1.3.2 - - - -[@2shediac]: https://github.com/2shediac -[@ablyler]: https://github.com/ablyler -[@aboks]: https://github.com/aboks -[@abulford]: https://github.com/abulford -[@afilina]: https://github.com/afilina -[@aik099]: https://github.com/aik099 -[@akarmazyn]: https://github.com/akarmazyn -[@akkie]: https://github.com/akkie -[@alcohol]: https://github.com/alcohol -[@alekitto]: https://github.com/alekitto -[@AlexHowansky]: https://github.com/AlexHowansky -[@anbuc]: https://github.com/anbuc -[@andrei-propertyguru]: https://github.com/andrei-propertyguru -[@AndrewDawes]: https://github.com/AndrewDawes -[@andygrunwald]: https://github.com/andygrunwald -[@andypost]: https://github.com/andypost -[@annechko]: https://github.com/annechko -[@anomiex]: https://github.com/anomiex -[@arnested]: https://github.com/arnested -[@asispts]: https://github.com/asispts -[@asnyder]: https://github.com/asnyder -[@Astinus-Eberhard]: https://github.com/Astinus-Eberhard -[@axlon]: https://github.com/axlon -[@bayleedev]: https://github.com/bayleedev -[@becoded]: https://github.com/becoded -[@Benjamin-Loison]: https://github.com/Benjamin-Loison -[@benmatselby]: https://github.com/benmatselby -[@benno5020]: https://github.com/benno5020 -[@biinari]: https://github.com/biinari -[@Billz95]: https://github.com/Billz95 -[@biozshock]: https://github.com/biozshock -[@bkdotcom]: https://github.com/bkdotcom -[@bladeofsteel]: https://github.com/bladeofsteel -[@blerou]: https://github.com/blerou -[@blue32a]: https://github.com/blue32a -[@bondas83]: https://github.com/bondas83 -[@boonkerz]: https://github.com/boonkerz -[@braindawg]: https://github.com/braindawg -[@BRMatt]: https://github.com/BRMatt -[@CandySunPlus]: https://github.com/CandySunPlus -[@ceeram]: https://github.com/ceeram -[@cixtor]: https://github.com/cixtor -[@claylo]: https://github.com/claylo -[@codebymikey]: https://github.com/codebymikey -[@costdev]: https://github.com/costdev -[@covex-nn]: https://github.com/covex-nn -[@cweiske]: https://github.com/cweiske -[@Daimona]: https://github.com/Daimona -[@danez]: https://github.com/danez -[@DanielEScherzer]: https://github.com/DanielEScherzer -[@DannyvdSluijs]: https://github.com/DannyvdSluijs -[@das-peter]: https://github.com/das-peter -[@datengraben]: https://github.com/datengraben -[@david-binda]: https://github.com/david-binda -[@Decave]: https://github.com/Decave -[@dereuromark]: https://github.com/dereuromark -[@derrabus]: https://github.com/derrabus -[@devfrey]: https://github.com/devfrey -[@deviantintegral]: https://github.com/deviantintegral -[@dhensby]: https://github.com/dhensby -[@dingo-d]: https://github.com/dingo-d -[@dominics]: https://github.com/dominics -[@donatj]: https://github.com/donatj -[@dryabkov]: https://github.com/dryabkov -[@dschniepp]: https://github.com/dschniepp -[@duncan3dc]: https://github.com/duncan3dc -[@edorian]: https://github.com/edorian -[@elazar]: https://github.com/elazar -[@ElvenSpellmaker]: https://github.com/ElvenSpellmaker -[@emil-nasso]: https://github.com/emil-nasso -[@enl]: https://github.com/enl -[@erikwiffin]: https://github.com/erikwiffin -[@eser]: https://github.com/eser -[@exussum12]: https://github.com/exussum12 -[@fabacino]: https://github.com/fabacino -[@fabre-thibaud]: https://github.com/fabre-thibaud -[@fcool]: https://github.com/fcool -[@filips123]: https://github.com/filips123 -[@Fischer-Bjoern]: https://github.com/Fischer-Bjoern -[@fonsecas72]: https://github.com/fonsecas72 -[@fredden]: https://github.com/fredden -[@GaryJones]: https://github.com/GaryJones -[@ghostal]: https://github.com/ghostal -[@ghunti]: https://github.com/ghunti -[@gmponos]: https://github.com/gmponos -[@gnutix]: https://github.com/gnutix -[@goatherd]: https://github.com/goatherd -[@grongor]: https://github.com/grongor -[@grzr]: https://github.com/grzr -[@gwharton]: https://github.com/gwharton -[@hashar]: https://github.com/hashar -[@helgi]: https://github.com/helgi -[@hernst42]: https://github.com/hernst42 -[@iammattcoleman]: https://github.com/iammattcoleman -[@ihabunek]: https://github.com/ihabunek -[@illusori]: https://github.com/illusori -[@index0h]: https://github.com/index0h -[@ivuorinen]: https://github.com/ivuorinen -[@jasonmccreary]: https://github.com/jasonmccreary -[@javer]: https://github.com/javer -[@jaymcp]: https://github.com/jaymcp -[@JDGrimes]: https://github.com/JDGrimes -[@jedgell]: https://github.com/jedgell -[@jeffslofish]: https://github.com/jeffslofish -[@jmarcil]: https://github.com/jmarcil -[@jnrbsn]: https://github.com/jnrbsn -[@joachim-n]: https://github.com/joachim-n -[@joelposti]: https://github.com/joelposti -[@johanderuijter]: https://github.com/johanderuijter -[@johnmaguire]: https://github.com/johnmaguire -[@johnpbloch]: https://github.com/johnpbloch -[@JorisDebonnet]: https://github.com/JorisDebonnet -[@josephzidell]: https://github.com/josephzidell -[@joshdavis11]: https://github.com/joshdavis11 -[@jpoliveira08]: https://github.com/jpoliveira08 -[@jpuck]: https://github.com/jpuck -[@jrfnl]: https://github.com/jrfnl -[@kdebisschop]: https://github.com/kdebisschop -[@kenguest]: https://github.com/kenguest -[@klausi]: https://github.com/klausi -[@Konafets]: https://github.com/Konafets -[@kristofser]: https://github.com/kristofser -[@ksimka]: https://github.com/ksimka -[@ktomk]: https://github.com/ktomk -[@kukulich]: https://github.com/kukulich -[@legoktm]: https://github.com/legoktm -[@lmanzke]: https://github.com/lmanzke -[@localheinz]: https://github.com/localheinz -[@lucc]: https://github.com/lucc -[@MacDada]: https://github.com/MacDada -[@Majkl578]: https://github.com/Majkl578 -[@manuelpichler]: https://github.com/manuelpichler -[@marcospassos]: https://github.com/marcospassos -[@MarkBaker]: https://github.com/MarkBaker -[@MarkMaldaba]: https://github.com/MarkMaldaba -[@martinssipenko]: https://github.com/martinssipenko -[@marvasDE]: https://github.com/marvasDE -[@maryo]: https://github.com/maryo -[@MasterOdin]: https://github.com/MasterOdin -[@mathroc]: https://github.com/mathroc -[@MatmaRex]: https://github.com/MatmaRex -[@maxgalbu]: https://github.com/maxgalbu -[@mcuelenaere]: https://github.com/mcuelenaere -[@mhujer]: https://github.com/mhujer -[@michaelbutler]: https://github.com/michaelbutler -[@michalbundyra]: https://github.com/michalbundyra -[@Morerice]: https://github.com/Morerice -[@mbomb007]: https://github.com/mbomb007 -[@morozov]: https://github.com/morozov -[@mrkrstphr]: https://github.com/mrkrstphr -[@mythril]: https://github.com/mythril -[@Naelyth]: https://github.com/Naelyth -[@NanoSector]: https://github.com/NanoSector -[@ndm2]: https://github.com/ndm2 -[@nicholascus]: https://github.com/nicholascus -[@NickDickinsonWilde]: https://github.com/NickDickinsonWilde -[@nkovacs]: https://github.com/nkovacs -[@nubs]: https://github.com/nubs -[@o5]: https://github.com/o5 -[@ofbeaton]: https://github.com/ofbeaton -[@olemartinorg]: https://github.com/olemartinorg -[@ondrejmirtes]: https://github.com/ondrejmirtes -[@orx0r]: https://github.com/orx0r -[@ostrolucky]: https://github.com/ostrolucky -[@peterwilsoncc]: https://github.com/peterwilsoncc -[@pfrenssen]: https://github.com/pfrenssen -[@phil-davis]: https://github.com/phil-davis -[@photodude]: https://github.com/photodude -[@przemekhernik]: https://github.com/przemekhernik -[@r3nat]: https://github.com/r3nat -[@raul338]: https://github.com/raul338 -[@realmfoo]: https://github.com/realmfoo -[@remicollet]: https://github.com/remicollet -[@renaatdemuynck]: https://github.com/renaatdemuynck -[@renan]: https://github.com/renan -[@rhorber]: https://github.com/rhorber -[@rmccue]: https://github.com/rmccue -[@robocoder]: https://github.com/robocoder -[@rodrigoprimo]: https://github.com/rodrigoprimo -[@rogeriopradoj]: https://github.com/rogeriopradoj -[@rovangju]: https://github.com/rovangju -[@rvanvelzen]: https://github.com/rvanvelzen -[@saltybeagle]: https://github.com/saltybeagle -[@samlev]: https://github.com/samlev -[@scato]: https://github.com/scato -[@schlessera]: https://github.com/schlessera -[@schnittstabil]: https://github.com/schnittstabil -[@sebastianbergmann]: https://github.com/sebastianbergmann -[@sertand]: https://github.com/sertand -[@shanethehat]: https://github.com/shanethehat -[@shivammathur]: https://github.com/shivammathur -[@simonsan]: https://github.com/simonsan -[@sjlangley]: https://github.com/sjlangley -[@sserbin]: https://github.com/sserbin -[@stefanlenselink]: https://github.com/stefanlenselink -[@SteveTalbot]: https://github.com/SteveTalbot -[@storeman]: https://github.com/storeman -[@stronk7]: https://github.com/stronk7 -[@svycka]: https://github.com/svycka -[@syranez]: https://github.com/syranez -[@tasuki]: https://github.com/tasuki -[@tim-bezhashvyly]: https://github.com/tim-bezhashvyly -[@TomHAnderson]: https://github.com/TomHAnderson -[@thewilkybarkid]: https://github.com/thewilkybarkid -[@thiemowmde]: https://github.com/thiemowmde -[@thomasjfox]: https://github.com/thomasjfox -[@till]: https://github.com/till -[@timoschinkel]: https://github.com/timoschinkel -[@TimWolla]: https://github.com/TimWolla -[@uniquexor]: https://github.com/uniquexor -[@valorin]: https://github.com/valorin -[@VasekPurchart]: https://github.com/VasekPurchart -[@VincentLanglet]: https://github.com/VincentLanglet -[@waltertamboer]: https://github.com/waltertamboer -[@westonruter]: https://github.com/westonruter -[@willemstuursma]: https://github.com/willemstuursma -[@wimg]: https://github.com/wimg -[@wvega]: https://github.com/wvega -[@xalopp]: https://github.com/xalopp -[@xjm]: https://github.com/xjm -[@xt99]: https://github.com/xt99 -[@yesmeck]: https://github.com/yesmeck -[@zBart]: https://github.com/zBart -[pear-adviva]: https://pear.php.net/user/adviva -[pear-bakert]: https://pear.php.net/user/bakert -[pear-bjorn]: https://pear.php.net/user/bjorn -[pear-boxgav]: https://pear.php.net/user/boxgav -[pear-burci]: https://pear.php.net/user/burci -[pear-conf]: https://pear.php.net/user/conf -[pear-cwiedmann]: https://pear.php.net/user/cwiedmann -[pear-dollyaswin]: https://pear.php.net/user/dollyaswin -[pear-dvino]: https://pear.php.net/user/dvino -[pear-et3w503]: https://pear.php.net/user/et3w503 -[pear-gemineye]: https://pear.php.net/user/gemineye -[pear-kwinahradsky]: https://pear.php.net/user/kwinahradsky -[pear-ljmaskey]: https://pear.php.net/user/ljmaskey -[pear-mccammos]: https://pear.php.net/user/mccammos -[pear-pete]: https://pear.php.net/user/pete -[pear-recurser]: https://pear.php.net/user/recurser -[pear-renoiv]: https://pear.php.net/user/renoiv -[pear-rquadling]: https://pear.php.net/user/rquadling -[pear-ryba]: https://pear.php.net/user/ryba -[pear-thezero]: https://pear.php.net/user/thezero -[pear-thing2b]: https://pear.php.net/user/thing2b -[pear-tomdesp]: https://pear.php.net/user/tomdesp -[pear-troehr]: https://pear.php.net/user/troehr -[pear-weirdan]: https://pear.php.net/user/weirdan -[pear-wloche]: https://pear.php.net/user/wloche -[pear-woellchen]: https://pear.php.net/user/woellchen -[pear-youngian]: https://pear.php.net/user/youngian diff --git a/app/vendor/squizlabs/php_codesniffer/CodeSniffer.conf.dist b/app/vendor/squizlabs/php_codesniffer/CodeSniffer.conf.dist index f95058faa..9477413da 100644 --- a/app/vendor/squizlabs/php_codesniffer/CodeSniffer.conf.dist +++ b/app/vendor/squizlabs/php_codesniffer/CodeSniffer.conf.dist @@ -1,9 +1,9 @@ 'PSR2', - 'report_format' => 'summary', - 'show_warnings' => '0', - 'show_progress' => '1', - 'report_width' => '120', -); +$phpCodeSnifferConfig = [ + 'default_standard' => 'PSR12', + 'report_format' => 'summary', + 'show_warnings' => '0', + 'show_progress' => '1', + 'report_width' => '120', +]; ?> diff --git a/app/vendor/squizlabs/php_codesniffer/README.md b/app/vendor/squizlabs/php_codesniffer/README.md index 18031378d..79d60a2b3 100644 --- a/app/vendor/squizlabs/php_codesniffer/README.md +++ b/app/vendor/squizlabs/php_codesniffer/README.md @@ -3,13 +3,13 @@ - -'; - - // Use the correct line endings based on the OS. - return str_replace("\n", PHP_EOL, $output).PHP_EOL; - } - - /** - * Retrieve the _real_ footer of the HTML page. - * - * @return string - */ - public function getRealFooter() - { - return parent::getFormattedFooter(); - } - - /** - * [VISIBILITY WIDENING ONLY] Print the header of the HTML page. - * - * @return void - */ - public function printHeader() - { - parent::printHeader(); - } - - /** - * [VISIBILITY WIDENING ONLY] Print the table of contents for the standard. - * - * @return void - */ - public function printToc() - { - parent::printToc(); - } - - /** - * [VISIBILITY WIDENING ONLY] Print the footer of the HTML page. - * - * @return void - */ - public function printFooter() - { - parent::printFooter(); - } -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/MarkdownDouble.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/MarkdownDouble.php deleted file mode 100644 index 79dc6b0bf..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/MarkdownDouble.php +++ /dev/null @@ -1,68 +0,0 @@ -getTitle($doc), PHP_EOL; - } -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonBlankLinesStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonBlankLinesStandard.xml deleted file mode 100644 index bcaf82bbb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonBlankLinesStandard.xml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonBlockLengthStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonBlockLengthStandard.xml deleted file mode 100644 index c479a7fd0..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonBlockLengthStandard.xml +++ /dev/null @@ -1,35 +0,0 @@ - - - - - - - $one = 10; - ]]> - - - $a = 10; - ]]> - - - - - echo $foo; - ]]> - - - print $foo; - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonEncodingStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonEncodingStandard.xml deleted file mode 100644 index c366553f3..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonEncodingStandard.xml +++ /dev/null @@ -1,42 +0,0 @@ - - - - - - - $f; -$g = $h <= $i; -$j = $k >= $l; -$m = $n <=> $o; - ]]> - - - - -// The above PHP tag is specifically testing -// handling of that in generated HTML doc. - -// Now let's also check the handling of -// comparison operators in code samples -// in combination with "em" tags. -$a = $b < $c; -$d = $e > $f; -$g = $h <= $i; -$j = $k >= $l; -$m = $n <=> $o; - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonLineLengthStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonLineLengthStandard.xml deleted file mode 100644 index b4431ea84..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeComparisonLineLengthStandard.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - Countable, Serializable -{ -} - ]]> - - - foobar($param1, $param2) {} -} - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeTitleLineWrappingStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeTitleLineWrappingStandard.xml deleted file mode 100644 index b773f7a88..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeTitleLineWrappingStandard.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeTitleWhitespaceStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeTitleWhitespaceStandard.xml deleted file mode 100644 index 282972025..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/CodeTitleWhitespaceStandard.xml +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleCaseStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleCaseStandard.xml deleted file mode 100644 index a4078e3de..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleCaseStandard.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleLengthStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleLengthStandard.xml deleted file mode 100644 index 244892764..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleLengthStandard.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitlePCREFallbackStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitlePCREFallbackStandard.xml deleted file mode 100644 index 1aa3849bd..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitlePCREFallbackStandard.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug1Standard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug1Standard.xml deleted file mode 100644 index 4edae6918..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug1Standard.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug2Standard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug2Standard.xml deleted file mode 100644 index 43956e3fc..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug2Standard.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug3Standard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug3Standard.xml deleted file mode 100644 index 43956e3fc..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/DocumentationTitleToAnchorSlug3Standard.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardBlankLinesStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardBlankLinesStandard.xml deleted file mode 100644 index 10c47bf46..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardBlankLinesStandard.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardEncodingStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardEncodingStandard.xml deleted file mode 100644 index 3e34c3f9f..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardEncodingStandard.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - tags in standard descriptions is allowed and their handling should be safeguarded. - Other tags, like link, bold, are not allowed and will be encoded for display when the HTML or Markdown report is used. - ]]> - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardIndentStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardIndentStandard.xml deleted file mode 100644 index b2ec6c5e3..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardIndentStandard.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardLineWrappingStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardLineWrappingStandard.xml deleted file mode 100644 index 66bbb9627..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Content/StandardLineWrappingStandard.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonMismatchedCodeElmsStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonMismatchedCodeElmsStandard.xml deleted file mode 100644 index d0cfff411..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonMismatchedCodeElmsStandard.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonMissingCodeElmStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonMissingCodeElmStandard.xml deleted file mode 100644 index 999901ebb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonMissingCodeElmStandard.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonNoCodeStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonNoCodeStandard.xml deleted file mode 100644 index 54b50ff8d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonNoCodeStandard.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonNoContentStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonNoContentStandard.xml deleted file mode 100644 index 0dfb12fa0..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonNoContentStandard.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonOneEmptyCodeElmStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonOneEmptyCodeElmStandard.xml deleted file mode 100644 index b40674413..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonOneEmptyCodeElmStandard.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonTwoEmptyCodeElmsStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonTwoEmptyCodeElmsStandard.xml deleted file mode 100644 index e6cb07145..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeComparisonTwoEmptyCodeElmsStandard.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeTitleEmptyStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeTitleEmptyStandard.xml deleted file mode 100644 index 034bdf2fd..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeTitleEmptyStandard.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeTitleMissingStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeTitleMissingStandard.xml deleted file mode 100644 index 89599dd2b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/CodeTitleMissingStandard.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/DocumentationTitleEmptyStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/DocumentationTitleEmptyStandard.xml deleted file mode 100644 index c3ab071d1..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/DocumentationTitleEmptyStandard.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - class Code {} - ]]> - - - class Comparison {} - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/DocumentationTitleMissingStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/DocumentationTitleMissingStandard.xml deleted file mode 100644 index 974071d9f..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/DocumentationTitleMissingStandard.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - class Code {} - ]]> - - - class Comparison {} - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/StandardNoContentStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/StandardNoContentStandard.xml deleted file mode 100644 index e6934706a..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Invalid/StandardNoContentStandard.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - class Code {} - ]]> - - - class Comparison {} - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/NoContentStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/NoContentStandard.xml deleted file mode 100644 index 83afee8e8..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/NoContentStandard.xml +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/NoDocumentationElementStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/NoDocumentationElementStandard.xml deleted file mode 100644 index ca8290f1b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/NoDocumentationElementStandard.xml +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneCodeComparisonNoStandardStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneCodeComparisonNoStandardStandard.xml deleted file mode 100644 index c2af9098a..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneCodeComparisonNoStandardStandard.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - class Code {} - ]]> - - - class Comparison {} - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockCodeComparisonStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockCodeComparisonStandard.xml deleted file mode 100644 index c3ce35cd7..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockCodeComparisonStandard.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - class Code {} - ]]> - - - class Comparison {} - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockNoCodeStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockNoCodeStandard.xml deleted file mode 100644 index fc014949e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockNoCodeStandard.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockTwoCodeComparisonsStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockTwoCodeComparisonsStandard.xml deleted file mode 100644 index 19559e672..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/OneStandardBlockTwoCodeComparisonsStandard.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - class Code {} - ]]> - - - class Comparison {} - ]]> - - - - - $one = 10; - ]]> - - - $a = 10; - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksNoCodeStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksNoCodeStandard.xml deleted file mode 100644 index f5f621ecd..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksNoCodeStandard.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksOneCodeComparisonStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksOneCodeComparisonStandard.xml deleted file mode 100644 index a5b3a3216..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksOneCodeComparisonStandard.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - Code {} - ]]> - - - Comparison {} - ]]> - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksThreeCodeComparisonsStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksThreeCodeComparisonsStandard.xml deleted file mode 100644 index 540ac7eaf..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Structure/TwoStandardBlocksThreeCodeComparisonsStandard.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - class Code {} - ]]> - - - class Comparison {} - ]]> - - - - - - - - $one = 10; - ]]> - - - $a = 10; - ]]> - - - - - echo $foo; - ]]> - - - print $foo; - ]]> - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/ElementAtWrongLevelStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/ElementAtWrongLevelStandard.xml deleted file mode 100644 index 68519dd2b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/ElementAtWrongLevelStandard.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/OneElmAtWrongLevelStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/OneElmAtWrongLevelStandard.xml deleted file mode 100644 index 6c1dd164a..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/OneElmAtWrongLevelStandard.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/SuperfluousCodeElementStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/SuperfluousCodeElementStandard.xml deleted file mode 100644 index 333786a33..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/SuperfluousCodeElementStandard.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/UnknownElementStandard.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/UnknownElementStandard.xml deleted file mode 100644 index c9ec3227f..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Docs/Unsupported/UnknownElementStandard.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Sniffs/Content/CodeComparisonBlankLinesSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Sniffs/Content/CodeComparisonBlankLinesSniff.php deleted file mode 100644 index 1e56bf9cf..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/Fixtures/StandardWithDocs/Sniffs/Content/CodeComparisonBlankLinesSniff.php +++ /dev/null @@ -1,12 +0,0 @@ - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/GeneratorTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/GeneratorTest.php deleted file mode 100644 index 8fb0ee251..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/GeneratorTest.php +++ /dev/null @@ -1,227 +0,0 @@ - $expected The expected list of found docs. - * - * @dataProvider dataConstructor - * - * @return void - */ - public function testConstructor($standard, array $expected) - { - // Set up the ruleset. - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $generator = new MockGenerator($ruleset); - $this->assertSame($expected, $generator->docFiles); - - }//end testConstructor() - - - /** - * Data provider. - * - * @return array>> - */ - public static function dataConstructor() - { - $pathToDocsInFixture = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'; - $pathToDocsInFixture .= DIRECTORY_SEPARATOR.'StandardWithDocs'; - $pathToDocsInFixture .= DIRECTORY_SEPARATOR.'Docs'.DIRECTORY_SEPARATOR; - - return [ - 'Standard without docs' => [ - 'standard' => __DIR__.'/NoDocsTest.xml', - 'expected' => [], - ], - 'Standard with an invalid doc file' => [ - 'standard' => __DIR__.'/NoValidDocsTest.xml', - 'expected' => [ - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'NoDocumentationElementStandard.xml', - ], - ], - 'Standard with one doc file' => [ - 'standard' => __DIR__.'/OneDocTest.xml', - 'expected' => [ - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'OneStandardBlockNoCodeStandard.xml', - ], - ], - 'Standard with multiple doc files' => [ - 'standard' => __DIR__.'/StructureDocsTest.xml', - 'expected' => [ - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'NoContentStandard.xml', - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'OneCodeComparisonNoStandardStandard.xml', - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'OneStandardBlockCodeComparisonStandard.xml', - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'OneStandardBlockNoCodeStandard.xml', - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'OneStandardBlockTwoCodeComparisonsStandard.xml', - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'TwoStandardBlocksNoCodeStandard.xml', - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'TwoStandardBlocksOneCodeComparisonStandard.xml', - $pathToDocsInFixture.'Structure'.DIRECTORY_SEPARATOR.'TwoStandardBlocksThreeCodeComparisonsStandard.xml', - ], - ], - ]; - - }//end dataConstructor() - - - /** - * Verify that an XML doc which isn't valid documentation yields an Exception to warn devs. - * - * This should not be hidden via defensive coding! - * - * @return void - */ - public function testGeneratingInvalidDocsResultsInException() - { - // Set up the ruleset. - $standard = __DIR__.'/NoValidDocsTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - if (PHP_VERSION_ID >= 80000) { - $exception = 'TypeError'; - $message = 'processSniff(): Argument #1 ($doc) must be of type DOMNode, null given'; - } else if (PHP_VERSION_ID >= 70000) { - $exception = 'TypeError'; - $message = 'processSniff() must be an instance of DOMNode, null given'; - } else { - $exception = 'PHPUnit_Framework_Error'; - $message = 'processSniff() must be an instance of DOMNode, null given'; - } - - if (method_exists($this, 'expectExceptionMessage') === true) { - // PHPUnit 5.2.0+. - $this->expectException($exception); - $this->expectExceptionMessage($message); - } else { - // Ancient PHPUnit. - $this->setExpectedException($exception, $message); - } - - $generator = new MockGenerator($ruleset); - $generator->generate(); - - }//end testGeneratingInvalidDocsResultsInException() - - - /** - * Verify the wiring for the generate() function. - * - * @param string $standard The standard to use for the test. - * @param string $expected The expected function output. - * - * @dataProvider dataGeneratingDocs - * - * @return void - */ - public function testGeneratingDocs($standard, $expected) - { - // Set up the ruleset. - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $this->expectOutputString($expected); - - $generator = new MockGenerator($ruleset); - $generator->generate(); - - }//end testGeneratingDocs() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataGeneratingDocs() - { - $multidocExpected = []; - $multidocExpected[] = 'No Content'; - $multidocExpected[] = 'Code Comparison Only, Missing Standard Block'; - $multidocExpected[] = 'One Standard Block, Code Comparison'; - $multidocExpected[] = 'One Standard Block, No Code'; - $multidocExpected[] = 'One Standard Block, Two Code Comparisons'; - $multidocExpected[] = 'Two Standard Blocks, No Code'; - $multidocExpected[] = 'Two Standard Blocks, One Code Comparison'; - $multidocExpected[] = 'Two Standard Blocks, Three Code Comparisons'; - $multidocExpected = implode(PHP_EOL, $multidocExpected).PHP_EOL; - - return [ - 'Standard without docs' => [ - 'standard' => __DIR__.'/NoDocsTest.xml', - 'expected' => '', - ], - 'Standard with one doc file' => [ - 'standard' => __DIR__.'/OneDocTest.xml', - 'expected' => 'One Standard Block, No Code'.PHP_EOL, - ], - 'Standard with multiple doc files' => [ - 'standard' => __DIR__.'/StructureDocsTest.xml', - 'expected' => $multidocExpected, - ], - ]; - - }//end dataGeneratingDocs() - - - /** - * Verify that if the `` title is missing, it will fallback to the file name - * and split the CamelCaps name correctly. - * - * @return void - */ - public function testGetTitleFallbackToFilename() - { - // Set up the ruleset. - $standard = __DIR__.'/AllValidDocsTest.xml'; - $sniffs = 'StandardWithDocs.Content.DocumentationTitlePCREFallback'; - $config = new ConfigDouble(["--standard=$standard", "--sniffs=$sniffs"]); - $ruleset = new Ruleset($config); - - // In tests, the `--sniffs` setting doesn't work out of the box. - $sniffParts = explode('.', $sniffs); - $sniffFile = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.$sniffParts[0].DIRECTORY_SEPARATOR; - $sniffFile .= 'Sniffs'.DIRECTORY_SEPARATOR.$sniffParts[1].DIRECTORY_SEPARATOR.$sniffParts[2].'Sniff.php'; - - $sniffParts = array_map('strtolower', $sniffParts); - $sniffName = $sniffParts[0].'\sniffs\\'.$sniffParts[1].'\\'.$sniffParts[2].'sniff'; - $restrictions = [$sniffName => true]; - $ruleset->registerSniffs([$sniffFile], $restrictions, []); - - // Make the test OS independent. - $this->expectOutputString('Documentation Title PCRE Fallback'.PHP_EOL); - - $generator = new MockGenerator($ruleset); - $generator->generate(); - - }//end testGetTitleFallbackToFilename() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/HTMLTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/HTMLTest.php deleted file mode 100644 index 91cd7d1e5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/HTMLTest.php +++ /dev/null @@ -1,426 +0,0 @@ -assertNotFalse($expected, 'Output expectation file could not be found'); - - // Make the test OS independent. - $expected = str_replace("\n", PHP_EOL, $expected); - $this->expectOutputString($expected); - - $generator = new HTMLDouble($ruleset); - $generator->generate(); - - }//end testDocs() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataDocs() - { - return [ - 'Standard without docs' => [ - 'standard' => __DIR__.'/NoDocsTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Standard with one doc file' => [ - 'standard' => __DIR__.'/OneDocTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputOneDoc.html', - ], - 'Standard with multiple doc files' => [ - 'standard' => __DIR__.'/StructureDocsTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStructureDocs.html', - ], - ]; - - }//end dataDocs() - - - /** - * Test the generated docs for the handling of specific parts of the documentation. - * - * @param string $sniffs The specific fixture sniffs to verify the docs for. - * @param string $pathToExpected Path to a file containing the expected function output. - * - * @dataProvider dataDocSpecifics - * - * @return void - */ - public function testDocSpecifics($sniffs, $pathToExpected) - { - // Set up the ruleset. - $standard = __DIR__.'/AllValidDocsTest.xml'; - $config = new ConfigDouble(["--standard=$standard", "--sniffs=$sniffs"]); - $ruleset = new Ruleset($config); - - // In tests, the `--sniffs` setting doesn't work out of the box. - $sniffParts = explode('.', $sniffs); - $sniffFile = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.$sniffParts[0].DIRECTORY_SEPARATOR; - $sniffFile .= 'Sniffs'.DIRECTORY_SEPARATOR.$sniffParts[1].DIRECTORY_SEPARATOR.$sniffParts[2].'Sniff.php'; - - $sniffParts = array_map('strtolower', $sniffParts); - $sniffName = $sniffParts[0].'\sniffs\\'.$sniffParts[1].'\\'.$sniffParts[2].'sniff'; - $restrictions = [$sniffName => true]; - $ruleset->registerSniffs([$sniffFile], $restrictions, []); - - $expected = file_get_contents($pathToExpected); - $this->assertNotFalse($expected, 'Output expectation file could not be found'); - - // Make the test OS independent. - $expected = str_replace("\n", PHP_EOL, $expected); - $this->expectOutputString($expected); - - $generator = new HTMLDouble($ruleset); - $generator->generate(); - - }//end testDocSpecifics() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataDocSpecifics() - { - return [ - 'Documentation title: case' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitleCase', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitleCase.html', - ], - 'Documentation title: length' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitleLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitleLength.html', - ], - 'Documentation title: fallback to file name' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitlePCREFallback', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitlePCREFallback.html', - ], - 'Standard Element: blank line handling' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardBlankLines', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardBlankLines.html', - ], - 'Standard Element: encoding of special characters' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardEncoding', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardEncoding.html', - ], - 'Standard Element: indent handling' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardIndent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardIndent.html', - ], - 'Standard Element: line wrapping' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardLineWrapping', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardLineWrapping.html', - ], - 'Code Title: line wrapping' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeTitleLineWrapping', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeTitleLineWrapping.html', - ], - 'Code Title: whitespace handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeTitleWhitespace', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeTitleWhitespace.html', - ], - 'Code Comparison: blank line handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonBlankLines', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonBlankLines.html', - ], - 'Code Comparison: different block lengths' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonBlockLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonBlockLength.html', - ], - 'Code Comparison: encoding of special characters' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonEncoding', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonEncoding.html', - ], - 'Code Comparison: line length handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonLineLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonLineLength.html', - ], - 'Unsupported: element at the wrong level' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.ElementAtWrongLevel', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Unsupported: one correct elm, one at wrong level' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.OneElmAtWrongLevel', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputUnsupportedOneElmAtWrongLevel.html', - ], - 'Unsupported: superfluous code element' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.SuperfluousCodeElement', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputUnsupportedSuperfluousCodeElement.html', - ], - 'Unsupported: unknown element' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.UnknownElement', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Invalid: code comparison mismatched code elms' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonMismatchedCodeElms', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.html', - ], - 'Invalid: code comparison only has one code elm' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonMissingCodeElm', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.html', - ], - 'Invalid: code elements have no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonNoCode', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonNoCode.html', - ], - 'Invalid: code comparison element has no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonNoContent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonNoContent.html', - ], - 'Invalid: code comparison two code elms, one empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonOneEmptyCodeElm', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonOneEmptyCodeElm.html', - ], - 'Invalid: code comparison two empty code elms' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonTwoEmptyCodeElms', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonTwoEmptyCodeElms.html', - ], - 'Invalid: code title attributes are empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeTitleEmpty', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeTitleEmpty.html', - ], - 'Invalid: code title attributes missing' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeTitleMissing', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeTitleMissing.html', - ], - 'Invalid: documentation title attribute is empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.DocumentationTitleEmpty', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidDocumentationTitleEmpty.html', - ], - 'Invalid: documentation title attribute missing' => [ - 'sniffs' => 'StandardWithDocs.Invalid.DocumentationTitleMissing', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidDocumentationTitleMissing.html', - ], - 'Invalid: standard element has no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.StandardNoContent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidStandardNoContent.html', - ], - ]; - - }//end dataDocSpecifics() - - - /** - * Test anchor links in the generated docs are slugified and unique. - * - * @return void - */ - public function testAnchorLinks() - { - // Set up the ruleset. - $standard = __DIR__.'/AnchorLinksTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $pathToExpected = __DIR__.'/Expectations/ExpectedOutputDocumentationTitleToAnchorSlug.html'; - $expected = file_get_contents($pathToExpected); - $this->assertNotFalse($expected, 'Output expectation file could not be found'); - - // Make the test OS independent. - $expected = str_replace("\n", PHP_EOL, $expected); - $this->expectOutputString($expected); - - $generator = new HTMLDouble($ruleset); - $generator->generate(); - - }//end testAnchorLinks() - - - /** - * Test the generated footer. - * - * @return void - */ - public function testFooter() - { - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $regex = '`^
    '; - $regex .= 'Documentation generated on [A-Z][a-z]{2}, [0-9]{2} [A-Z][a-z]{2} 20[0-9]{2} [0-2][0-9](?::[0-5][0-9]){2} [+-][0-9]{4}'; - $regex .= ' by PHP_CodeSniffer [3-9]\.[0-9]+.[0-9]+'; - $regex .= '
    \R \R\R$`'; - - $generator = new HTMLDouble($ruleset); - $footer = $generator->getRealFooter(); - - if (method_exists($this, 'assertMatchesRegularExpression') === true) { - $this->assertMatchesRegularExpression($regex, $footer); - } else { - // PHPUnit < 9.1.0. - $this->assertRegExp($regex, $footer); - } - - }//end testFooter() - - - /** - * Safeguard that the footer logic doesn't permanently change the error level. - * - * @runInSeparateProcess - * @preserveGlobalState disabled - * - * @return void - */ - public function testFooterResetsErrorReportingToOriginalSetting() - { - $expected = error_reporting(); - - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $generator = new HTMLDouble($ruleset); - $generator->getRealFooter(); - - $this->assertSame($expected, error_reporting()); - - }//end testFooterResetsErrorReportingToOriginalSetting() - - - /** - * Safeguard that users won't see a PHP warning about the timezone not being set when calling date(). - * - * The warning we don't want to see is: - * "date(): It is not safe to rely on the system's timezone settings. You are *required* to use - * the date.timezone setting or the date_default_timezone_set() function. In case you used any of - * those methods and you are still getting this warning, you most likely misspelled the timezone - * identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select - * your timezone." - * - * JRF: Based on my tests, the warning only occurs on PHP < 7.0, but never a bad thing to safeguard this - * on a wider range of PHP versions. - * - * Note: as of PHP 8.2, PHP no longer accepts an empty string as timezone and will use `UTC` instead, - * so the warning on calling date() in the code itself would not display anyway. - * - * @requires PHP < 8.2 - * - * @doesNotPerformAssertions - * - * @return void - */ - public function testFooterDoesntThrowWarningOnMissingTimezone() - { - $originalIni = @ini_set('date.timezone', ''); - - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $generator = new HTMLDouble($ruleset); - $generator->getRealFooter(); - - // Reset the timezone to its original state. - ini_set('date.timezone', $originalIni); - - }//end testFooterDoesntThrowWarningOnMissingTimezone() - - - /** - * Perfunctory test to verify that extenders which call deprecated methods will see a deprecation notice. - * - * Note: not all deprecated methods are tested as some need arguments. - * - * @param string $methodName Name of the deprecated method to test. - * - * @dataProvider dataCallingDeprecatedMethodThrowsDeprecationNotice - * - * @return void - */ - public function testCallingDeprecatedMethodThrowsDeprecationNotice($methodName) - { - $exceptionClass = 'PHPUnit\Framework\Error\Deprecated'; - if (class_exists($exceptionClass) === false) { - $exceptionClass = 'PHPUnit_Framework_Error_Deprecated'; - } - - $regex = '`^The PHP_CodeSniffer\\\\Generators\\\\HTML::%s\(\) method is deprecated\. Use "echo [^\s]+::%s\(\)" instead\.$`'; - $regex = sprintf($regex, preg_quote($methodName, '`'), str_replace('print', 'getFormatted', $methodName)); - - if (method_exists($this, 'expectExceptionMessageMatches') === true) { - $this->expectException($exceptionClass); - $this->expectExceptionMessageMatches($regex); - } else if (method_exists($this, 'expectExceptionMessageRegExp') === true) { - // PHPUnit < 8.4.0. - $this->expectException($exceptionClass); - $this->expectExceptionMessageRegExp($regex); - } else { - // PHPUnit < 5.2.0. - $this->setExpectedExceptionRegExp($exceptionClass, $regex); - } - - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $generator = new HTMLDouble($ruleset); - $generator->$methodName(); - - }//end testCallingDeprecatedMethodThrowsDeprecationNotice() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataCallingDeprecatedMethodThrowsDeprecationNotice() - { - return [ - 'printHeader()' => ['printHeader'], - 'printToc()' => ['printToc'], - 'printFooter()' => ['printFooter'], - ]; - - }//end dataCallingDeprecatedMethodThrowsDeprecationNotice() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/MarkdownTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/MarkdownTest.php deleted file mode 100644 index f9fd47796..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/MarkdownTest.php +++ /dev/null @@ -1,397 +0,0 @@ -assertNotFalse($expected, 'Output expectation file could not be found'); - - // Make the test OS independent. - $expected = str_replace("\n", PHP_EOL, $expected); - $this->expectOutputString($expected); - - $generator = new MarkdownDouble($ruleset); - $generator->generate(); - - }//end testDocs() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataDocs() - { - return [ - 'Standard without docs' => [ - 'standard' => __DIR__.'/NoDocsTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Standard with one doc file' => [ - 'standard' => __DIR__.'/OneDocTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputOneDoc.md', - ], - 'Standard with multiple doc files' => [ - 'standard' => __DIR__.'/StructureDocsTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStructureDocs.md', - ], - ]; - - }//end dataDocs() - - - /** - * Test the generated docs for the handling of specific parts of the documentation. - * - * @param string $sniffs The specific fixture sniffs to verify the docs for. - * @param string $pathToExpected Path to a file containing the expected function output. - * - * @dataProvider dataDocSpecifics - * - * @return void - */ - public function testDocSpecifics($sniffs, $pathToExpected) - { - // Set up the ruleset. - $standard = __DIR__.'/AllValidDocsTest.xml'; - $config = new ConfigDouble(["--standard=$standard", "--sniffs=$sniffs"]); - $ruleset = new Ruleset($config); - - // In tests, the `--sniffs` setting doesn't work out of the box. - $sniffParts = explode('.', $sniffs); - $sniffFile = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.$sniffParts[0].DIRECTORY_SEPARATOR; - $sniffFile .= 'Sniffs'.DIRECTORY_SEPARATOR.$sniffParts[1].DIRECTORY_SEPARATOR.$sniffParts[2].'Sniff.php'; - - $sniffParts = array_map('strtolower', $sniffParts); - $sniffName = $sniffParts[0].'\sniffs\\'.$sniffParts[1].'\\'.$sniffParts[2].'sniff'; - $restrictions = [$sniffName => true]; - $ruleset->registerSniffs([$sniffFile], $restrictions, []); - - $expected = file_get_contents($pathToExpected); - $this->assertNotFalse($expected, 'Output expectation file could not be found'); - - // Make the test OS independent. - $expected = str_replace("\n", PHP_EOL, $expected); - $this->expectOutputString($expected); - - $generator = new MarkdownDouble($ruleset); - $generator->generate(); - - }//end testDocSpecifics() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataDocSpecifics() - { - return [ - 'Documentation title: case' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitleCase', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitleCase.md', - ], - 'Documentation title: length' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitleLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitleLength.md', - ], - 'Documentation title: fallback to file name' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitlePCREFallback', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitlePCREFallback.md', - ], - 'Standard Element: blank line handling' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardBlankLines', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardBlankLines.md', - ], - 'Standard Element: encoding of special characters' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardEncoding', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardEncoding.md', - ], - 'Standard Element: indent handling' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardIndent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardIndent.md', - ], - 'Standard Element: line wrapping' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardLineWrapping', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardLineWrapping.md', - ], - 'Code Title: line wrapping' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeTitleLineWrapping', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeTitleLineWrapping.md', - ], - 'Code Title: whitespace handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeTitleWhitespace', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeTitleWhitespace.md', - ], - 'Code Comparison: blank line handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonBlankLines', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonBlankLines.md', - ], - 'Code Comparison: different block lengths' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonBlockLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonBlockLength.md', - ], - 'Code Comparison: encoding of special characters' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonEncoding', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonEncoding.md', - ], - 'Code Comparison: line length handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonLineLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonLineLength.md', - ], - 'Unsupported: element at the wrong level' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.ElementAtWrongLevel', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Unsupported: one correct elm, one at wrong level' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.OneElmAtWrongLevel', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputUnsupportedOneElmAtWrongLevel.md', - ], - 'Unsupported: superfluous code element' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.SuperfluousCodeElement', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputUnsupportedSuperfluousCodeElement.md', - ], - 'Unsupported: unknown element' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.UnknownElement', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Invalid: code comparison mismatched code elms' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonMismatchedCodeElms', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.md', - ], - 'Invalid: code comparison only has one code elm' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonMissingCodeElm', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.md', - ], - 'Invalid: code elements have no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonNoCode', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonNoCode.md', - ], - 'Invalid: code comparison element has no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonNoContent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonNoContent.md', - ], - 'Invalid: code comparison two code elms, one empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonOneEmptyCodeElm', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonOneEmptyCodeElm.md', - ], - 'Invalid: code comparison two empty code elms' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonTwoEmptyCodeElms', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonTwoEmptyCodeElms.md', - ], - 'Invalid: code title attributes are empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeTitleEmpty', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeTitleEmpty.md', - ], - 'Invalid: code title attributes missing' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeTitleMissing', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeTitleMissing.md', - ], - 'Invalid: documentation title attribute is empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.DocumentationTitleEmpty', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidDocumentationTitleEmpty.md', - ], - 'Invalid: documentation title attribute missing' => [ - 'sniffs' => 'StandardWithDocs.Invalid.DocumentationTitleMissing', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidDocumentationTitleMissing.md', - ], - 'Invalid: standard element has no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.StandardNoContent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidStandardNoContent.md', - ], - ]; - - }//end dataDocSpecifics() - - - /** - * Test the generated footer. - * - * @return void - */ - public function testFooter() - { - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $regex = '`^\RDocumentation generated on [A-Z][a-z]{2}, [0-9]{2} [A-Z][a-z]{2} 20[0-9]{2} [0-2][0-9](?::[0-5][0-9]){2} [+-][0-9]{4}'; - $regex .= ' by \[PHP_CodeSniffer [3-9]\.[0-9]+.[0-9]+\]\(https://github\.com/PHPCSStandards/PHP_CodeSniffer\)\R$`'; - - $generator = new MarkdownDouble($ruleset); - $footer = $generator->getRealFooter(); - - if (method_exists($this, 'assertMatchesRegularExpression') === true) { - $this->assertMatchesRegularExpression($regex, $footer); - } else { - // PHPUnit < 9.1.0. - $this->assertRegExp($regex, $footer); - } - - }//end testFooter() - - - /** - * Safeguard that the footer logic doesn't permanently change the error level. - * - * @runInSeparateProcess - * @preserveGlobalState disabled - * - * @return void - */ - public function testFooterResetsErrorReportingToOriginalSetting() - { - $expected = error_reporting(); - - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $generator = new MarkdownDouble($ruleset); - $generator->getRealFooter(); - - $this->assertSame($expected, error_reporting()); - - }//end testFooterResetsErrorReportingToOriginalSetting() - - - /** - * Safeguard that users won't see a PHP warning about the timezone not being set when calling date(). - * - * The warning we don't want to see is: - * "date(): It is not safe to rely on the system's timezone settings. You are *required* to use - * the date.timezone setting or the date_default_timezone_set() function. In case you used any of - * those methods and you are still getting this warning, you most likely misspelled the timezone - * identifier. We selected the timezone 'UTC' for now, but please set date.timezone to select - * your timezone." - * - * JRF: Based on my tests, the warning only occurs on PHP < 7.0, but never a bad thing to safeguard this - * on a wider range of PHP versions. - * - * Note: as of PHP 8.2, PHP no longer accepts an empty string as timezone and will use `UTC` instead, - * so the warning on calling date() in the code itself would not display anyway. - * - * @requires PHP < 8.2 - * - * @doesNotPerformAssertions - * - * @return void - */ - public function testFooterDoesntThrowWarningOnMissingTimezone() - { - $originalIni = @ini_set('date.timezone', ''); - - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $generator = new MarkdownDouble($ruleset); - $generator->getRealFooter(); - - // Reset the timezone to its original state. - ini_set('date.timezone', $originalIni); - - }//end testFooterDoesntThrowWarningOnMissingTimezone() - - - /** - * Perfunctory test to verify that extenders which call deprecated methods will see a deprecation notice. - * - * Note: not all deprecated methods are tested as some need arguments. - * - * @param string $methodName Name of the deprecated method to test. - * - * @dataProvider dataCallingDeprecatedMethodThrowsDeprecationNotice - * - * @return void - */ - public function testCallingDeprecatedMethodThrowsDeprecationNotice($methodName) - { - $exceptionClass = 'PHPUnit\Framework\Error\Deprecated'; - if (class_exists($exceptionClass) === false) { - $exceptionClass = 'PHPUnit_Framework_Error_Deprecated'; - } - - $regex = '`^The PHP_CodeSniffer\\\\Generators\\\\Markdown::%s\(\) method is deprecated\. Use "echo [^\s]+::%s\(\)" instead\.$`'; - $regex = sprintf($regex, preg_quote($methodName, '`'), str_replace('print', 'getFormatted', $methodName)); - - if (method_exists($this, 'expectExceptionMessageMatches') === true) { - $this->expectException($exceptionClass); - $this->expectExceptionMessageMatches($regex); - } else if (method_exists($this, 'expectExceptionMessageRegExp') === true) { - // PHPUnit < 8.4.0. - $this->expectException($exceptionClass); - $this->expectExceptionMessageRegExp($regex); - } else { - // PHPUnit < 5.2.0. - $this->setExpectedExceptionRegExp($exceptionClass, $regex); - } - - // Set up the ruleset. - $standard = __DIR__.'/OneDocTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $generator = new MarkdownDouble($ruleset); - $generator->$methodName(); - - }//end testCallingDeprecatedMethodThrowsDeprecationNotice() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataCallingDeprecatedMethodThrowsDeprecationNotice() - { - return [ - 'printHeader()' => ['printHeader'], - 'printFooter()' => ['printFooter'], - ]; - - }//end dataCallingDeprecatedMethodThrowsDeprecationNotice() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/NoDocsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/NoDocsTest.xml deleted file mode 100644 index efb29990a..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/NoDocsTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/NoValidDocsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/NoValidDocsTest.xml deleted file mode 100644 index 9f5c9c493..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/NoValidDocsTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/OneDocTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/OneDocTest.xml deleted file mode 100644 index 50e64a884..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/OneDocTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/StructureDocsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/StructureDocsTest.xml deleted file mode 100644 index 6199e2873..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/StructureDocsTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/TextTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/TextTest.php deleted file mode 100644 index 90bb7bf89..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Generators/TextTest.php +++ /dev/null @@ -1,245 +0,0 @@ -assertNotFalse($expected, 'Output expectation file could not be found'); - - // Make the test OS independent. - $expected = str_replace("\n", PHP_EOL, $expected); - $this->expectOutputString($expected); - - $generator = new Text($ruleset); - $generator->generate(); - - }//end testDocs() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataDocs() - { - return [ - 'Standard without docs' => [ - 'standard' => __DIR__.'/NoDocsTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Standard with one doc file' => [ - 'standard' => __DIR__.'/OneDocTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputOneDoc.txt', - ], - 'Standard with multiple doc files' => [ - 'standard' => __DIR__.'/StructureDocsTest.xml', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStructureDocs.txt', - ], - ]; - - }//end dataDocs() - - - /** - * Test the generated docs for the handling of specific parts of the documentation. - * - * @param string $sniffs The specific fixture sniffs to verify the docs for. - * @param string $pathToExpected Path to a file containing the expected function output. - * - * @dataProvider dataDocSpecifics - * - * @return void - */ - public function testDocSpecifics($sniffs, $pathToExpected) - { - // Set up the ruleset. - $standard = __DIR__.'/AllValidDocsTest.xml'; - $config = new ConfigDouble(["--standard=$standard", "--sniffs=$sniffs"]); - $ruleset = new Ruleset($config); - - // In tests, the `--sniffs` setting doesn't work out of the box. - $sniffParts = explode('.', $sniffs); - $sniffFile = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.$sniffParts[0].DIRECTORY_SEPARATOR; - $sniffFile .= 'Sniffs'.DIRECTORY_SEPARATOR.$sniffParts[1].DIRECTORY_SEPARATOR.$sniffParts[2].'Sniff.php'; - - $sniffParts = array_map('strtolower', $sniffParts); - $sniffName = $sniffParts[0].'\sniffs\\'.$sniffParts[1].'\\'.$sniffParts[2].'sniff'; - $restrictions = [$sniffName => true]; - $ruleset->registerSniffs([$sniffFile], $restrictions, []); - - $expected = file_get_contents($pathToExpected); - $this->assertNotFalse($expected, 'Output expectation file could not be found'); - - // Make the test OS independent. - $expected = str_replace("\n", PHP_EOL, $expected); - $this->expectOutputString($expected); - - $generator = new Text($ruleset); - $generator->generate(); - - }//end testDocSpecifics() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataDocSpecifics() - { - return [ - 'Documentation title: case' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitleCase', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitleCase.txt', - ], - 'Documentation title: length' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitleLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitleLength.txt', - ], - 'Documentation title: fallback to file name' => [ - 'sniffs' => 'StandardWithDocs.Content.DocumentationTitlePCREFallback', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputDocumentationTitlePCREFallback.txt', - ], - 'Standard Element: blank line handling' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardBlankLines', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardBlankLines.txt', - ], - 'Standard Element: encoding of special characters' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardEncoding', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardEncoding.txt', - ], - 'Standard Element: indent handling' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardIndent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardIndent.txt', - ], - 'Standard Element: line wrapping' => [ - 'sniffs' => 'StandardWithDocs.Content.StandardLineWrapping', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputStandardLineWrapping.txt', - ], - 'Code Title: line wrapping' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeTitleLineWrapping', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeTitleLineWrapping.txt', - ], - 'Code Title: whitespace handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeTitleWhitespace', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeTitleWhitespace.txt', - ], - 'Code Comparison: blank line handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonBlankLines', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonBlankLines.txt', - ], - 'Code Comparison: different block lengths' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonBlockLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonBlockLength.txt', - ], - 'Code Comparison: encoding of special characters' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonEncoding', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonEncoding.txt', - ], - 'Code Comparison: line length handling' => [ - 'sniffs' => 'StandardWithDocs.Content.CodeComparisonLineLength', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputCodeComparisonLineLength.txt', - ], - 'Unsupported: element at the wrong level' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.ElementAtWrongLevel', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Unsupported: one correct elm, one at wrong level' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.OneElmAtWrongLevel', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputUnsupportedOneElmAtWrongLevel.txt', - ], - 'Unsupported: superfluous code element' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.SuperfluousCodeElement', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputUnsupportedSuperfluousCodeElement.txt', - ], - 'Unsupported: unknown element' => [ - 'sniffs' => 'StandardWithDocs.Unsupported.UnknownElement', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputEmpty.txt', - ], - 'Invalid: code comparison mismatched code elms' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonMismatchedCodeElms', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonMismatchedCodeElms.txt', - ], - 'Invalid: code comparison only has one code elm' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonMissingCodeElm', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonMissingCodeElm.txt', - ], - 'Invalid: code elements have no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonNoCode', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonNoCode.txt', - ], - 'Invalid: code comparison element has no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonNoContent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonNoContent.txt', - ], - 'Invalid: code comparison two code elms, one empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonOneEmptyCodeElm', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonOneEmptyCodeElm.txt', - ], - 'Invalid: code comparison two empty code elms' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeComparisonTwoEmptyCodeElms', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeComparisonTwoEmptyCodeElms.txt', - ], - 'Invalid: code title attributes are empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeTitleEmpty', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeTitleEmpty.txt', - ], - 'Invalid: code title attributes missing' => [ - 'sniffs' => 'StandardWithDocs.Invalid.CodeTitleMissing', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidCodeTitleMissing.txt', - ], - 'Invalid: documentation title attribute is empty' => [ - 'sniffs' => 'StandardWithDocs.Invalid.DocumentationTitleEmpty', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidDocumentationTitleEmpty.txt', - ], - 'Invalid: documentation title attribute missing' => [ - 'sniffs' => 'StandardWithDocs.Invalid.DocumentationTitleMissing', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidDocumentationTitleMissing.txt', - ], - 'Invalid: standard element has no content' => [ - 'sniffs' => 'StandardWithDocs.Invalid.StandardNoContent', - 'pathToExpected' => __DIR__.'/Expectations/ExpectedOutputInvalidStandardNoContent.txt', - ], - ]; - - }//end dataDocSpecifics() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/AbstractRulesetTestCase.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/AbstractRulesetTestCase.php deleted file mode 100644 index 41c639443..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/AbstractRulesetTestCase.php +++ /dev/null @@ -1,115 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHPUnit\Framework\TestCase; - -abstract class AbstractRulesetTestCase extends TestCase -{ - - /** - * The fully qualified name of the PHPCS runtime exception class. - * - * @var string - */ - const RUNTIME_EXCEPTION = 'PHP_CodeSniffer\Exceptions\RuntimeException'; - - - /** - * Asserts that an object has a specified property in a PHPUnit cross-version compatible manner. - * - * @param string $propertyName The name of the property. - * @param object $object The object on which to check whether the property exists. - * @param string $message Optional failure message to display. - * - * @return void - */ - protected function assertXObjectHasProperty($propertyName, $object, $message='') - { - if (method_exists($this, 'assertObjectHasProperty') === true) { - $this->assertObjectHasProperty($propertyName, $object, $message); - } else { - // PHPUnit < 9.6.11. - $this->assertObjectHasAttribute($propertyName, $object, $message); - } - - }//end assertXObjectHasProperty() - - - /** - * Asserts that an object does not have a specified property - * in a PHPUnit cross-version compatible manner. - * - * @param string $propertyName The name of the property. - * @param object $object The object on which to check whether the property exists. - * @param string $message Optional failure message to display. - * - * @return void - */ - protected function assertXObjectNotHasProperty($propertyName, $object, $message='') - { - if (method_exists($this, 'assertObjectNotHasProperty') === true) { - $this->assertObjectNotHasProperty($propertyName, $object, $message); - } else { - // PHPUnit < 9.6.11. - $this->assertObjectNotHasAttribute($propertyName, $object, $message); - } - - }//end assertXObjectNotHasProperty() - - - /** - * Helper method to tell PHPUnit to expect a PHPCS RuntimeException with a certain message - * in a PHPUnit cross-version compatible manner. - * - * @param string $message The expected exception message. - * - * @return void - */ - protected function expectRuntimeExceptionMessage($message) - { - if (method_exists($this, 'expectException') === true) { - // PHPUnit 5+. - $this->expectException(self::RUNTIME_EXCEPTION); - $this->expectExceptionMessage($message); - } else { - // PHPUnit 4. - $this->setExpectedException(self::RUNTIME_EXCEPTION, $message); - } - - }//end expectRuntimeExceptionMessage() - - - /** - * Helper method to tell PHPUnit to expect a PHPCS RuntimeException which matches a regex patten - * in a PHPUnit cross-version compatible manner. - * - * @param string $regex The regex which should match. - * - * @return void - */ - protected function expectRuntimeExceptionRegex($regex) - { - if (method_exists($this, 'expectExceptionMessageMatches') === true) { - $this->expectException(self::RUNTIME_EXCEPTION); - $this->expectExceptionMessageMatches($regex); - } else if (method_exists($this, 'expectExceptionMessageRegExp') === true) { - // PHPUnit < 8.4.0. - $this->expectException(self::RUNTIME_EXCEPTION); - $this->expectExceptionMessageRegExp($regex); - } else { - // PHPUnit < 5.2.0. - $this->setExpectedExceptionRegExp(self::RUNTIME_EXCEPTION, $regex); - } - - }//end expectRuntimeExceptionRegex() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ConstructorNoSniffsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ConstructorNoSniffsTest.xml deleted file mode 100644 index cc61e3c53..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ConstructorNoSniffsTest.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - . - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ConstructorTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ConstructorTest.php deleted file mode 100644 index eaea6c239..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ConstructorTest.php +++ /dev/null @@ -1,293 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Autoload; -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test various aspects of the Ruleset::__construct() method not covered via other tests. - * - * @covers \PHP_CodeSniffer\Ruleset::__construct - */ -final class ConstructorTest extends AbstractRulesetTestCase -{ - - - /** - * Test setting the ruleset name. - * - * @param array $cliArgs The CLI args to pass to the Config. - * @param string $expected The expected set ruleset name. - * - * @dataProvider dataHandlingStandardsPassedViaCLI - * - * @return void - */ - public function testHandlingStandardsPassedViaCLI($cliArgs, $expected) - { - $config = new ConfigDouble($cliArgs); - $ruleset = new Ruleset($config); - - $this->assertSame($expected, $ruleset->name); - - }//end testHandlingStandardsPassedViaCLI() - - - /** - * Data provider. - * - * @see testHandlingStandardsPassedViaCLI() - * - * @return array>> - */ - public static function dataHandlingStandardsPassedViaCLI() - { - return [ - 'Single standard passed' => [ - 'cliArgs' => ['--standard=PSR1'], - 'expected' => 'PSR1', - ], - 'Multiple standards passed' => [ - 'cliArgs' => ['--standard=PSR1,Zend'], - 'expected' => 'PSR1, Zend', - ], - 'Absolute path to standard directory passed' => [ - 'cliArgs' => [ - '--standard='.__DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'TestStandard', - // Limit this to a valid sniff to prevent running into error messages unrelated to what - // is being tested here. - '--sniffs=TestStandard.ValidSniffs.RegisterEmptyArray', - ], - 'expected' => 'TestStandard', - ], - ]; - - }//end dataHandlingStandardsPassedViaCLI() - - - /** - * Verify that standards are registered with the Autoloader. - * - * @param array $cliArgs The CLI args to pass to the Config. - * @param array $expected Minimum set of standards expected to be registered with the autoloader. - * - * @dataProvider dataStandardsAreRegisteredWithAutoloader - * - * @return void - */ - public function testStandardsAreRegisteredWithAutoloader($cliArgs, $expected) - { - $config = new ConfigDouble($cliArgs); - new Ruleset($config); - - $autoloadPaths = Autoload::getSearchPaths(); - - // Note: doing a full comparison of the Autoloader registered standards would make this test unstable - // as the `CodeSniffer.conf` of the user running the tests could interfer if they have additional - // external standards registered. - // Also note that `--runtime-set` is being used to set `installed_paths` to prevent making any changes to - // the `CodeSniffer.conf` file of the user running the tests. - foreach ($expected as $path => $namespacedStandardName) { - $this->assertArrayHasKey($path, $autoloadPaths, "Path $path has not been registered with the autoloader"); - $this->assertSame($namespacedStandardName, $autoloadPaths[$path], 'Expected (namespaced) standard name does not match'); - } - - }//end testStandardsAreRegisteredWithAutoloader() - - - /** - * Data provider. - * - * @see testStandardsAreRegisteredWithAutoloader() - * - * @return array>> - */ - public static function dataStandardsAreRegisteredWithAutoloader() - { - $basePath = dirname(dirname(dirname(__DIR__))).DIRECTORY_SEPARATOR.'src'.DIRECTORY_SEPARATOR.'Standards'.DIRECTORY_SEPARATOR; - $defaultPaths = [ - $basePath.'MySource' => 'MySource', - $basePath.'PEAR' => 'PEAR', - $basePath.'PSR1' => 'PSR1', - $basePath.'PSR12' => 'PSR12', - $basePath.'PSR2' => 'PSR2', - $basePath.'Squiz' => 'Squiz', - $basePath.'Zend' => 'Zend', - ]; - - $data = [ - 'Default standards' => [ - 'cliArgs' => [ - '--standard=PSR1', - '--runtime-set installed_paths .', - ], - 'expected' => $defaultPaths, - ], - ]; - - $extraInstalledPath = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'DirectoryExpansion'; - $extraInstalledPath .= DIRECTORY_SEPARATOR.'.hiddenAbove'.DIRECTORY_SEPARATOR.'src'.DIRECTORY_SEPARATOR.'MyStandard'; - $data['Additional non-namespaced standard'] = [ - 'cliArgs' => [ - '--standard=MyStandard', - '--runtime-set', - 'installed_paths', - $extraInstalledPath, - ], - 'expected' => ($defaultPaths + [$extraInstalledPath => 'MyStandard']), - ]; - - $extraInstalledPath = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'TestStandard'; - $data['Additional namespaced standard'] = [ - 'cliArgs' => [ - '--standard=TestStandard', - '--runtime-set', - 'installed_paths', - $extraInstalledPath, - // Limit this to a valid sniff to prevent running into error messages unrelated to what - // is being tested here. - '--sniffs=TestStandard.ValidSniffs.RegisterEmptyArray', - ], - 'expected' => ($defaultPaths + [$extraInstalledPath => 'Fixtures\TestStandard']), - ]; - - return $data; - - }//end dataStandardsAreRegisteredWithAutoloader() - - - /** - * Verify handling of sniff restrictions in combination with the caching setting. - * - * @param array $cliArgs The CLI args to pass to the Config. - * @param bool $cache Whether to turn the cache on or off. - * @param array $expected Sniffs which are expected to have been registered. - * - * @dataProvider dataCachingVersusRestrictions - * - * @return void - */ - public function testCachingVersusRestrictions($cliArgs, $cache, $expected) - { - $config = new ConfigDouble($cliArgs); - - // Overrule the cache setting (which is being ignored in the Config when the tests are running). - $config->cache = $cache; - - $ruleset = new Ruleset($config); - - $actual = array_keys($ruleset->sniffs); - sort($actual); - - $this->assertSame($expected, $actual); - - }//end testCachingVersusRestrictions() - - - /** - * Data provider. - * - * Note: the test cases only use `--exclude` to restrict, - * - * @see testCachingVersusRestrictions() - * - * @return array>> - */ - public static function dataCachingVersusRestrictions() - { - $completeSet = [ - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\Files\\ByteOrderMarkSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\DisallowAlternativePHPTagsSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\DisallowShortOpenTagSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Classes\\ClassDeclarationSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Files\\SideEffectsSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Methods\\CamelCapsMethodNameSniff', - 'PHP_CodeSniffer\\Standards\\Squiz\\Sniffs\\Classes\\ValidClassNameSniff', - ]; - - return [ - 'No restrictions, cache off' => [ - 'cliArgs' => ['--standard=PSR1'], - 'cache' => false, - 'expected' => $completeSet, - ], - 'Has exclusions, cache off' => [ - 'cliArgs' => [ - '--standard=PSR1', - '--exclude=Generic.Files.ByteOrderMark,Generic.PHP.DisallowShortOpenTag,PSR1.Files.SideEffects,Generic.PHP.DisallowAlternativePHPTags', - ], - 'cache' => false, - 'expected' => [ - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Classes\\ClassDeclarationSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Methods\\CamelCapsMethodNameSniff', - 'PHP_CodeSniffer\\Standards\\Squiz\\Sniffs\\Classes\\ValidClassNameSniff', - ], - ], - 'Has sniff selection, cache off' => [ - 'cliArgs' => [ - '--standard=PSR1', - '--sniffs=Generic.Files.ByteOrderMark,Generic.PHP.DisallowShortOpenTag,PSR1.Files.SideEffects,Generic.PHP.DisallowAlternativePHPTags', - ], - 'cache' => false, - 'expected' => [ - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\Files\\ByteOrderMarkSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\DisallowAlternativePHPTagsSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\DisallowShortOpenTagSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Files\\SideEffectsSniff', - ], - ], - 'No restrictions, cache on' => [ - 'cliArgs' => ['--standard=PSR1'], - 'cache' => true, - 'expected' => $completeSet, - ], - 'Has exclusions, cache on' => [ - 'cliArgs' => [ - '--standard=PSR1', - '--exclude=Generic.Files.ByteOrderMark,Generic.PHP.DisallowAlternativePHPTags,Generic.PHP.DisallowShortOpenTag,PSR1.Files.SideEffects', - ], - 'cache' => true, - 'expected' => $completeSet, - ], - - /* - * "Has sniff selection, cache on" case cannot be tested due to the `Ruleset` class - * containing special handling of sniff selection when the tests are running. - */ - - ]; - - }//end dataCachingVersusRestrictions() - - - /** - * Test an exception is thrown when no sniffs have been registered via the ruleset. - * - * @return void - */ - public function testNoSniffsRegisteredException() - { - $standard = __DIR__.'/ConstructorNoSniffsTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $message = 'ERROR: No sniffs were registered.'.PHP_EOL.PHP_EOL; - $this->expectRuntimeExceptionMessage($message); - - new Ruleset($config); - - }//end testNoSniffsRegisteredException() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/DisplayCachedMessagesTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/DisplayCachedMessagesTest.php deleted file mode 100644 index f58aefe8e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/DisplayCachedMessagesTest.php +++ /dev/null @@ -1,312 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; -use PHP_CodeSniffer\Util\MessageCollector; -use ReflectionMethod; -use ReflectionProperty; - -/** - * Test error handling for the Ruleset. - * - * Note: this is purely a unit test of the `displayCachedMessages()` method. - * The errors themselves are mocked. - * - * @covers \PHP_CodeSniffer\Ruleset::displayCachedMessages - */ -final class DisplayCachedMessagesTest extends AbstractRulesetTestCase -{ - - - /** - * Test that no exception nor output is generated when there are no cached messsages. - * - * @return void - */ - public function testDisplayCachedMessagesStaysSilentWithoutErrors() - { - $ruleset = $this->getPlainRuleset(); - - $this->expectOutputString(''); - - $this->invokeDisplayCachedMessages($ruleset); - - }//end testDisplayCachedMessagesStaysSilentWithoutErrors() - - - /** - * Verify that blocking errors encountered while loading the ruleset(s) result in an exception being thrown. - * - * @param array $messages The messages encountered. - * @param string $expected The expected function output to screen (via an internally handled exception). - * - * @dataProvider dataBlockingErrorsAreDisplayedViaAnException - * - * @return void - */ - public function testBlockingErrorsAreDisplayedViaAnException($messages, $expected) - { - $ruleset = $this->getPlainRuleset(); - $this->mockCachedMessages($ruleset, $messages); - - $this->expectRuntimeExceptionMessage($expected); - - $this->invokeDisplayCachedMessages($ruleset); - - }//end testBlockingErrorsAreDisplayedViaAnException() - - - /** - * Data provider. - * - * @see testBlockingErrorsAreDisplayedViaAnException() - * - * @return array>> - */ - public static function dataBlockingErrorsAreDisplayedViaAnException() - { - return [ - 'One error' => [ - 'messages' => ['This is a serious blocking issue' => MessageCollector::ERROR], - 'expected' => 'ERROR: This is a serious blocking issue'.PHP_EOL.PHP_EOL, - ], - 'Multiple blocking errors' => [ - 'messages' => [ - 'This is a serious blocking issue' => MessageCollector::ERROR, - 'And here is another one' => MessageCollector::ERROR, - 'OMG, why do you think that would work ?' => MessageCollector::ERROR, - ], - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - 'expected' => 'ERROR: This is a serious blocking issue'.PHP_EOL - . 'ERROR: And here is another one'.PHP_EOL - . 'ERROR: OMG, why do you think that would work ?'.PHP_EOL.PHP_EOL, - // phpcs:enable - ], - 'Mix of blocking and non-blocking errors' => [ - 'messages' => [ - 'This is a serious blocking issue' => MessageCollector::ERROR, - 'Something something deprecated and will be removed in v x.x.x' => MessageCollector::DEPRECATED, - 'Careful, this may not be correct' => MessageCollector::NOTICE, - ], - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - 'expected' => 'ERROR: This is a serious blocking issue'.PHP_EOL - . 'NOTICE: Careful, this may not be correct'.PHP_EOL - . 'DEPRECATED: Something something deprecated and will be removed in v x.x.x'.PHP_EOL.PHP_EOL, - // phpcs:enable - ], - ]; - - }//end dataBlockingErrorsAreDisplayedViaAnException() - - - /** - * Test display of non-blocking messages encountered while loading the ruleset(s). - * - * @param array $messages The messages encountered. - * @param string $expected The expected function output to screen. - * - * @dataProvider dataNonBlockingErrorsGenerateOutput - * - * @return void - */ - public function testNonBlockingErrorsGenerateOutput($messages, $expected) - { - $ruleset = $this->getPlainRuleset(); - $this->mockCachedMessages($ruleset, $messages); - - $this->expectOutputString($expected); - - $this->invokeDisplayCachedMessages($ruleset); - - }//end testNonBlockingErrorsGenerateOutput() - - - /** - * Data provider. - * - * @see testNonBlockingErrorsGenerateOutput() - * - * @return array>> - */ - public static function dataNonBlockingErrorsGenerateOutput() - { - return [ - 'One deprecation' => [ - 'messages' => ['My deprecation message' => MessageCollector::DEPRECATED], - 'expected' => 'DEPRECATED: My deprecation message'.PHP_EOL.PHP_EOL, - ], - 'One notice' => [ - 'messages' => ['My notice message' => MessageCollector::NOTICE], - 'expected' => 'NOTICE: My notice message'.PHP_EOL.PHP_EOL, - ], - 'One warning' => [ - 'messages' => ['My warning message' => MessageCollector::WARNING], - 'expected' => 'WARNING: My warning message'.PHP_EOL.PHP_EOL, - ], - 'Multiple non-blocking errors' => [ - 'messages' => [ - 'Something something deprecated and will be removed in v x.x.x' => MessageCollector::DEPRECATED, - 'Something is not supported and support may be removed' => MessageCollector::WARNING, - 'Some other deprecation notice' => MessageCollector::DEPRECATED, - 'Careful, this may not be correct' => MessageCollector::NOTICE, - ], - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - 'expected' => 'WARNING: Something is not supported and support may be removed'.PHP_EOL - .'NOTICE: Careful, this may not be correct'.PHP_EOL - .'DEPRECATED: Something something deprecated and will be removed in v x.x.x'.PHP_EOL - .'DEPRECATED: Some other deprecation notice'.PHP_EOL.PHP_EOL, - // phpcs:enable - ], - ]; - - }//end dataNonBlockingErrorsGenerateOutput() - - - /** - * Test that blocking errors will always show, independently of specific command-line options being used. - * - * @param array $configArgs Arguments to pass to the Config. - * - * @dataProvider dataSelectiveDisplayOfMessages - * - * @return void - */ - public function testBlockingErrorsAlwaysShow($configArgs) - { - $config = new ConfigDouble($configArgs); - $ruleset = new Ruleset($config); - - $message = 'Some serious error'; - $errors = [$message => MessageCollector::ERROR]; - $this->mockCachedMessages($ruleset, $errors); - - $this->expectRuntimeExceptionMessage('ERROR: '.$message.PHP_EOL); - - $this->invokeDisplayCachedMessages($ruleset); - - }//end testBlockingErrorsAlwaysShow() - - - /** - * Test that non-blocking messsages will not show when specific command-line options are being used. - * - * @param array $configArgs Arguments to pass to the Config. - * - * @dataProvider dataSelectiveDisplayOfMessages - * - * @return void - */ - public function testNonBlockingErrorsDoNotShowUnderSpecificCircumstances($configArgs) - { - $config = new ConfigDouble($configArgs); - $ruleset = new Ruleset($config); - $this->mockCachedMessages($ruleset, ['Deprecation notice' => MessageCollector::DEPRECATED]); - - $this->expectOutputString(''); - - $this->invokeDisplayCachedMessages($ruleset); - - }//end testNonBlockingErrorsDoNotShowUnderSpecificCircumstances() - - - /** - * Data provider. - * - * @see testBlockingErrorsAlwaysShow() - * @see testNonBlockingErrorsDoNotShow() - * - * @return array>> - */ - public static function dataSelectiveDisplayOfMessages() - { - $data = [ - 'Explain mode' => [ - 'configArgs' => ['-e'], - ], - 'Quiet mode' => [ - 'configArgs' => ['-q'], - ], - ]; - - // Setting the `--generator` arg is only supported when running `phpcs`. - if (PHP_CODESNIFFER_CBF === false) { - $data['Documentation is requested'] = [ - 'configArgs' => ['--generator=text'], - ]; - } - - return $data; - - }//end dataSelectiveDisplayOfMessages() - - - /** - * Test Helper. - * - * @return \PHP_CodeSniffer\Ruleset - */ - private function getPlainRuleset() - { - static $ruleset; - - if (isset($ruleset) === false) { - $config = new ConfigDouble(); - $ruleset = new Ruleset($config); - } - - return $ruleset; - - }//end getPlainRuleset() - - - /** - * Add mock messages to the message cache. - * - * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset object. - * @param array $messages The messages to add to the message cache. - * - * @return void - */ - private function mockCachedMessages(Ruleset $ruleset, $messages) - { - $reflProperty = new ReflectionProperty($ruleset, 'msgCache'); - (PHP_VERSION_ID < 80100) && $reflProperty->setAccessible(true); - - $msgCache = $reflProperty->getValue($ruleset); - foreach ($messages as $msg => $type) { - $msgCache->add($msg, $type); - } - - (PHP_VERSION_ID < 80100) && $reflProperty->setAccessible(false); - - }//end mockCachedMessages() - - - /** - * Invoke the display of the cached messages. - * - * @param \PHP_CodeSniffer\Ruleset $ruleset The ruleset object. - * - * @return void - */ - private function invokeDisplayCachedMessages(Ruleset $ruleset) - { - $reflMethod = new ReflectionMethod($ruleset, 'displayCachedMessages'); - (PHP_VERSION_ID < 80100) && $reflMethod->setAccessible(true); - $reflMethod->invoke($ruleset); - (PHP_VERSION_ID < 80100) && $reflMethod->setAccessible(false); - - }//end invokeDisplayCachedMessages() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceCaseMismatch1Test.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceCaseMismatch1Test.xml deleted file mode 100644 index e72c4b9dd..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceCaseMismatch1Test.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceCaseMismatch2Test.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceCaseMismatch2Test.xml deleted file mode 100644 index a10137491..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceCaseMismatch2Test.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathFailTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathFailTest.xml deleted file mode 100644 index 5298b54af..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathFailTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathTest.php deleted file mode 100644 index 10a4dd981..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathTest.php +++ /dev/null @@ -1,121 +0,0 @@ - - * @copyright 2025 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test home path handling in the Ruleset::expandRulesetReference() method. - * - * @covers \PHP_CodeSniffer\Ruleset::expandRulesetReference - */ -final class ExpandRulesetReferenceHomePathTest extends AbstractRulesetTestCase -{ - - /** - * Original value of the user's home path environment variable. - * - * @var string|false Path or false is the `HOME` environment variable is not available. - */ - private static $homepath = false; - - - /** - * Store the user's home path. - * - * @beforeClass - * - * @return void - */ - public static function storeHomePath() - { - self::$homepath = getenv('HOME'); - - }//end storeHomePath() - - - /** - * Restore the user's home path environment variable in case the test changed it or created it. - * - * @afterClass - * - * @return void - */ - public static function restoreHomePath() - { - if (is_string(self::$homepath) === true) { - putenv('HOME='.self::$homepath); - } else { - // Remove the environment variable as it didn't exist before. - putenv('HOME'); - } - - }//end restoreHomePath() - - - /** - * Set the home path to an alternative location. - * - * @before - * - * @return void - */ - protected function setHomePath() - { - $fakeHomePath = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR.'FakeHomePath'; - putenv("HOME=$fakeHomePath"); - - }//end setHomePath() - - - /** - * Verify that a sniff reference with the magic "home path" placeholder gets expanded correctly - * and finds sniffs if the path exists underneath the "home path". - * - * @return void - */ - public function testHomePathRefGetsExpandedAndFindsSniff() - { - // Set up the ruleset. - $standard = __DIR__.'/ExpandRulesetReferenceHomePathTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $expected = ['MyStandard.Category.Valid' => 'FakeHomePath\\MyStandard\\Sniffs\\Category\\ValidSniff']; - - $this->assertSame($expected, $ruleset->sniffCodes); - - }//end testHomePathRefGetsExpandedAndFindsSniff() - - - /** - * Verify that a sniff reference with the magic "home path" placeholder gets expanded correctly - * and still fails to find sniffs if the path doesn't exists underneath the "home path". - * - * @return void - */ - public function testHomePathRefGetsExpandedAndThrowsExceptionWhenPathIsInvalid() - { - // Set up the ruleset. - $standard = __DIR__.'/ExpandRulesetReferenceHomePathFailTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $exceptionMessage = 'ERROR: Referenced sniff "~/src/MyStandard/Sniffs/DoesntExist/" does not exist.'.PHP_EOL; - $exceptionMessage .= 'ERROR: No sniffs were registered.'.PHP_EOL.PHP_EOL; - $this->expectRuntimeExceptionMessage($exceptionMessage); - - new Ruleset($config); - - }//end testHomePathRefGetsExpandedAndThrowsExceptionWhenPathIsInvalid() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathTest.xml deleted file mode 100644 index e21f2a6e0..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceHomePathTest.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalIgnoreTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalIgnoreTest.xml deleted file mode 100644 index edd9b1e87..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalIgnoreTest.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - 0 - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalStandardTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalStandardTest.xml deleted file mode 100644 index d01c68cfb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalStandardTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalTest.php deleted file mode 100644 index 5f0180dac..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInternalTest.php +++ /dev/null @@ -1,71 +0,0 @@ - - * @copyright 2025 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test handling of "internal" references in the Ruleset::expandRulesetReference() method. - * - * @covers \PHP_CodeSniffer\Ruleset::expandRulesetReference - */ -final class ExpandRulesetReferenceInternalTest extends AbstractRulesetTestCase -{ - - - /** - * Verify that a ruleset reference starting with "Internal." (including the dot) doesn't cause any sniffs to be registered. - * - * @return void - */ - public function testInternalRefDoesNotGetExpanded() - { - // Set up the ruleset. - $standard = __DIR__.'/ExpandRulesetReferenceInternalIgnoreTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $expected = ['Generic.PHP.BacktickOperator' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\BacktickOperatorSniff']; - - $this->assertSame($expected, $ruleset->sniffCodes); - - }//end testInternalRefDoesNotGetExpanded() - - - /** - * While definitely not recommended, including a standard named "Internal", _does_ allow for sniffs to be registered. - * - * Note: customizations (exclusions/property setting etc) for individual sniffs may not always be handled correctly, - * which is why naming a standard "Internal" is definitely not recommended. - * - * @return void - */ - public function testInternalStandardDoesGetExpanded() - { - $message = 'DEPRECATED: The name "Internal" is reserved for internal use. A PHP_CodeSniffer standard should not be called "Internal".'.PHP_EOL; - $message .= 'Contact the maintainer of the standard to fix this.'.PHP_EOL.PHP_EOL; - - $this->expectOutputString($message); - - // Set up the ruleset. - $standard = __DIR__.'/ExpandRulesetReferenceInternalStandardTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $expected = ['Internal.Valid.Valid' => 'Fixtures\\Internal\\Sniffs\\Valid\\ValidSniff']; - - $this->assertSame($expected, $ruleset->sniffCodes); - - }//end testInternalStandardDoesGetExpanded() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode1Test.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode1Test.xml deleted file mode 100644 index a5531bda4..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode1Test.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode2Test.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode2Test.xml deleted file mode 100644 index c18ba25c5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode2Test.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode3Test.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode3Test.xml deleted file mode 100644 index 46ac2641f..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidErrorCode3Test.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidHomePathRefTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidHomePathRefTest.xml deleted file mode 100644 index 349449edf..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceInvalidHomePathRefTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceMissingFileTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceMissingFileTest.xml deleted file mode 100644 index 18e8c390b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceMissingFileTest.xml +++ /dev/null @@ -1,7 +0,0 @@ - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceTest.php deleted file mode 100644 index 284bdf7fb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceTest.php +++ /dev/null @@ -1,134 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test various aspects of the Ruleset::expandRulesetReference() method not covered by other tests. - * - * @covers \PHP_CodeSniffer\Ruleset::expandRulesetReference - */ -final class ExpandRulesetReferenceTest extends AbstractRulesetTestCase -{ - - - /** - * Test handling of path references relative to the originally included ruleset. - * - * @return void - */ - public function testRulesetRelativePathReferences() - { - // Set up the ruleset. - $standard = __DIR__.'/ExpandRulesetReferenceTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $expected = [ - 'ExternalA.CheckSomething.Valid' => 'Fixtures\\ExternalA\\Sniffs\\CheckSomething\\ValidSniff', - 'TestStandard.ValidSniffs.RegisterEmptyArray' => 'Fixtures\\TestStandard\\Sniffs\\ValidSniffs\\RegisterEmptyArraySniff', - 'ExternalB.CheckMore.Valid' => 'Fixtures\\ExternalB\\Sniffs\\CheckMore\\ValidSniff', - ]; - - $this->assertSame($expected, $ruleset->sniffCodes); - - }//end testRulesetRelativePathReferences() - - - /** - * Test that an exception is thrown if a ruleset contains an unresolvable reference. - * - * @param string $standard The standard to use for the test. - * @param string $replacement The reference which will be used in the exception message. - * - * @dataProvider dataUnresolvableReferenceThrowsException - * - * @return void - */ - public function testUnresolvableReferenceThrowsException($standard, $replacement) - { - // Set up the ruleset. - $standard = __DIR__.'/'.$standard; - $config = new ConfigDouble(["--standard=$standard"]); - - $exceptionMessage = 'ERROR: Referenced sniff "%s" does not exist.'.PHP_EOL; - $exceptionMessage .= 'ERROR: No sniffs were registered.'.PHP_EOL.PHP_EOL; - $this->expectRuntimeExceptionMessage(sprintf($exceptionMessage, $replacement)); - - new Ruleset($config); - - }//end testUnresolvableReferenceThrowsException() - - - /** - * Data provider. - * - * @see testUnresolvableReferenceThrowsException() - * - * @return array> - */ - public static function dataUnresolvableReferenceThrowsException() - { - $data = [ - 'Referencing a non-existent XML file' => [ - 'standard' => 'ExpandRulesetReferenceMissingFileTest.xml', - 'replacement' => './MissingFile.xml', - ], - 'Referencing an invalid directory starting with "~"' => [ - 'standard' => 'ExpandRulesetReferenceInvalidHomePathRefTest.xml', - 'replacement' => '~/src/Standards/Squiz/Sniffs/Files/', - ], - 'Referencing an unknown standard' => [ - 'standard' => 'ExpandRulesetReferenceUnknownStandardTest.xml', - 'replacement' => 'UnknownStandard', - ], - 'Referencing a non-existent category in a known standard' => [ - 'standard' => 'ExpandRulesetReferenceUnknownCategoryTest.xml', - 'replacement' => 'TestStandard.UnknownCategory', - ], - 'Referencing a non-existent sniff in a known standard' => [ - 'standard' => 'ExpandRulesetReferenceUnknownSniffTest.xml', - 'replacement' => 'TestStandard.InvalidSniffs.UnknownRule', - ], - 'Referencing an invalid error code - no standard name' => [ - 'standard' => 'ExpandRulesetReferenceInvalidErrorCode1Test.xml', - 'replacement' => '.Invalid.Undetermined.Found', - ], - 'Referencing an invalid error code - no category name' => [ - 'standard' => 'ExpandRulesetReferenceInvalidErrorCode2Test.xml', - 'replacement' => 'Standard..Undetermined.Found', - ], - 'Referencing an invalid error code - no sniff name' => [ - 'standard' => 'ExpandRulesetReferenceInvalidErrorCode3Test.xml', - 'replacement' => 'Standard.Invalid..Found', - ], - ]; - - // Add tests which are only relevant for case-sensitive OSes. - if (stripos(PHP_OS, 'WIN') === false) { - $data['Referencing an existing sniff, but there is a case mismatch (OS-dependent) [1]'] = [ - 'standard' => 'ExpandRulesetReferenceCaseMismatch1Test.xml', - 'replacement' => 'psr12.functions.nullabletypedeclaration', - ]; - $data['Referencing an existing sniff, but there is a case mismatch (OS-dependent) [2]'] = [ - 'standard' => 'ExpandRulesetReferenceCaseMismatch2Test.xml', - 'replacement' => 'PSR12.Functions.ReturntypeDeclaration', - ]; - } - - return $data; - - }//end dataUnresolvableReferenceThrowsException() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceTest.xml deleted file mode 100644 index f3147c5e1..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceTest.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownCategoryTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownCategoryTest.xml deleted file mode 100644 index 17ec1a7bd..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownCategoryTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownSniffTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownSniffTest.xml deleted file mode 100644 index 8cff25e1c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownSniffTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownStandardTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownStandardTest.xml deleted file mode 100644 index c8b56b10e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandRulesetReferenceUnknownStandardTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandSniffDirectoryTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandSniffDirectoryTest.php deleted file mode 100644 index ddd3a5148..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandSniffDirectoryTest.php +++ /dev/null @@ -1,67 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test the Ruleset::expandSniffDirectory() method. - * - * @covers \PHP_CodeSniffer\Ruleset::expandSniffDirectory - */ -final class ExpandSniffDirectoryTest extends TestCase -{ - - - /** - * Test finding sniff files based on a given directory. - * - * This test verifies that: - * - Hidden (sub)directories are ignored, but the given directory is allowed to be within a hidden directory. - * - Hidden files are ignored. - * - Files without a "php" extension are ignored. - * - Files without a "Sniff" suffix in the file name are ignored. - * - * Note: the "[Another]AbstractSniff" files will be found and included in the return value - * from `Ruleset::expandSniffDirectory()`. - * Those are filtered out later in the `Ruleset::registerSniffs()` method. - * - * @return void - */ - public function testExpandSniffDirectory() - { - // Set up the ruleset. - $standard = __DIR__.'/ExpandSniffDirectoryTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $expectedPathToRuleset = __DIR__.'/Fixtures/DirectoryExpansion/.hiddenAbove/src/MyStandard/ruleset.xml'; - $expectedPathToRuleset = realpath($expectedPathToRuleset); - $this->assertNotFalse($expectedPathToRuleset, 'Ruleset file could not be found'); - $this->assertContains($expectedPathToRuleset, $ruleset->paths, 'Ruleset file not included in the "seen ruleset paths"'); - - $expectedSniffCodes = [ - 'MyStandard.CategoryA.FindMe' => 'MyStandard\\Sniffs\\CategoryA\\FindMeSniff', - 'MyStandard.CategoryB.FindMe' => 'MyStandard\\Sniffs\\CategoryB\\FindMeSniff', - ]; - - // Sort the value to make the tests stable as different OSes will read directories - // in a different order and the order is not relevant for these tests. Just the values. - $actual = $ruleset->sniffCodes; - ksort($actual); - - $this->assertSame($expectedSniffCodes, $actual, 'Registered sniffs do not match expectation'); - - }//end testExpandSniffDirectory() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandSniffDirectoryTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandSniffDirectoryTest.xml deleted file mode 100644 index 158805e5c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExpandSniffDirectoryTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainCustomRulesetTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainCustomRulesetTest.xml deleted file mode 100644 index 77b6c2c87..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainCustomRulesetTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainSingleSniffTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainSingleSniffTest.xml deleted file mode 100644 index d345779d1..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainSingleSniffTest.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainTest.php deleted file mode 100644 index 38c74be31..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ExplainTest.php +++ /dev/null @@ -1,212 +0,0 @@ - - * @copyright 2023 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test the Ruleset::explain() function. - * - * @covers \PHP_CodeSniffer\Ruleset::explain - */ -final class ExplainTest extends TestCase -{ - - - /** - * Test the output of the "explain" command. - * - * @return void - */ - public function testExplain() - { - // Set up the ruleset. - $config = new ConfigDouble(['--standard=PSR1', '-e']); - $ruleset = new Ruleset($config); - - $expected = PHP_EOL; - $expected .= 'The PSR1 standard contains 8 sniffs'.PHP_EOL.PHP_EOL; - $expected .= 'Generic (4 sniffs)'.PHP_EOL; - $expected .= '------------------'.PHP_EOL; - $expected .= ' Generic.Files.ByteOrderMark'.PHP_EOL; - $expected .= ' Generic.NamingConventions.UpperCaseConstantName'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowAlternativePHPTags'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowShortOpenTag'.PHP_EOL.PHP_EOL; - $expected .= 'PSR1 (3 sniffs)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' PSR1.Classes.ClassDeclaration'.PHP_EOL; - $expected .= ' PSR1.Files.SideEffects'.PHP_EOL; - $expected .= ' PSR1.Methods.CamelCapsMethodName'.PHP_EOL.PHP_EOL; - $expected .= 'Squiz (1 sniff)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' Squiz.Classes.ValidClassName'.PHP_EOL; - - $this->expectOutputString($expected); - - $ruleset->explain(); - - }//end testExplain() - - - /** - * Test the output of the "explain" command is not influenced by a user set report width. - * - * @return void - */ - public function testExplainAlwaysDisplaysCompleteSniffName() - { - // Set up the ruleset. - $config = new ConfigDouble(['--standard=PSR1', '-e', '--report-width=30']); - $ruleset = new Ruleset($config); - - $expected = PHP_EOL; - $expected .= 'The PSR1 standard contains 8 sniffs'.PHP_EOL.PHP_EOL; - $expected .= 'Generic (4 sniffs)'.PHP_EOL; - $expected .= '------------------'.PHP_EOL; - $expected .= ' Generic.Files.ByteOrderMark'.PHP_EOL; - $expected .= ' Generic.NamingConventions.UpperCaseConstantName'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowAlternativePHPTags'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowShortOpenTag'.PHP_EOL.PHP_EOL; - $expected .= 'PSR1 (3 sniffs)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' PSR1.Classes.ClassDeclaration'.PHP_EOL; - $expected .= ' PSR1.Files.SideEffects'.PHP_EOL; - $expected .= ' PSR1.Methods.CamelCapsMethodName'.PHP_EOL.PHP_EOL; - $expected .= 'Squiz (1 sniff)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' Squiz.Classes.ValidClassName'.PHP_EOL; - - $this->expectOutputString($expected); - - $ruleset->explain(); - - }//end testExplainAlwaysDisplaysCompleteSniffName() - - - /** - * Test the output of the "explain" command when a ruleset only contains a single sniff. - * - * This is mostly about making sure that the summary line uses the correct grammar. - * - * @return void - */ - public function testExplainSingleSniff() - { - // Set up the ruleset. - $standard = __DIR__.'/ExplainSingleSniffTest.xml'; - $config = new ConfigDouble(["--standard=$standard", '-e']); - $ruleset = new Ruleset($config); - - $expected = PHP_EOL; - $expected .= 'The ExplainSingleSniffTest standard contains 1 sniff'.PHP_EOL.PHP_EOL; - $expected .= 'Squiz (1 sniff)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' Squiz.Scope.MethodScope'.PHP_EOL; - - $this->expectOutputString($expected); - - $ruleset->explain(); - - }//end testExplainSingleSniff() - - - /** - * Test that "explain" works correctly with custom rulesets. - * - * Verifies that: - * - The "standard" name is taken from the custom ruleset. - * - Any and all sniff additions and exclusions in the ruleset are taken into account correctly. - * - That the displayed list will have both the standards as well as the sniff names - * ordered alphabetically. - * - * @return void - */ - public function testExplainCustomRuleset() - { - // Set up the ruleset. - $standard = __DIR__.'/ExplainCustomRulesetTest.xml'; - $config = new ConfigDouble(["--standard=$standard", '-e']); - $ruleset = new Ruleset($config); - - $expected = PHP_EOL; - $expected .= 'The ExplainCustomRulesetTest standard contains 10 sniffs'.PHP_EOL.PHP_EOL; - $expected .= 'Generic (4 sniffs)'.PHP_EOL; - $expected .= '------------------'.PHP_EOL; - $expected .= ' Generic.Files.ByteOrderMark'.PHP_EOL; - $expected .= ' Generic.NamingConventions.UpperCaseConstantName'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowAlternativePHPTags'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowShortOpenTag'.PHP_EOL.PHP_EOL; - $expected .= 'PSR1 (2 sniffs)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' PSR1.Classes.ClassDeclaration'.PHP_EOL; - $expected .= ' PSR1.Methods.CamelCapsMethodName'.PHP_EOL.PHP_EOL; - $expected .= 'PSR12 (2 sniffs)'.PHP_EOL; - $expected .= '----------------'.PHP_EOL; - $expected .= ' PSR12.ControlStructures.BooleanOperatorPlacement'.PHP_EOL; - $expected .= ' PSR12.ControlStructures.ControlStructureSpacing'.PHP_EOL.PHP_EOL; - $expected .= 'Squiz (2 sniffs)'.PHP_EOL; - $expected .= '----------------'.PHP_EOL; - $expected .= ' Squiz.Classes.ValidClassName'.PHP_EOL; - $expected .= ' Squiz.Scope.MethodScope'.PHP_EOL; - - $this->expectOutputString($expected); - - $ruleset->explain(); - - }//end testExplainCustomRuleset() - - - /** - * Test the output of the "explain" command for a standard containing both deprecated - * and non-deprecated sniffs. - * - * Tests that: - * - Deprecated sniffs are marked with an asterix in the list. - * - A footnote is displayed explaining the asterix. - * - And that the "standard uses # deprecated sniffs" listing is **not** displayed. - * - * @return void - */ - public function testExplainWithDeprecatedSniffs() - { - // Set up the ruleset. - $standard = __DIR__."/ShowSniffDeprecationsTest.xml"; - $config = new ConfigDouble(["--standard=$standard", '-e']); - $ruleset = new Ruleset($config); - - $expected = PHP_EOL; - $expected .= 'The ShowSniffDeprecationsTest standard contains 11 sniffs'.PHP_EOL.PHP_EOL; - - $expected .= 'TestStandard (11 sniffs)'.PHP_EOL; - $expected .= '------------------------'.PHP_EOL; - $expected .= ' TestStandard.Deprecated.WithLongReplacement *'.PHP_EOL; - $expected .= ' TestStandard.Deprecated.WithoutReplacement *'.PHP_EOL; - $expected .= ' TestStandard.Deprecated.WithReplacement *'.PHP_EOL; - $expected .= ' TestStandard.Deprecated.WithReplacementContainingLinuxNewlines *'.PHP_EOL; - $expected .= ' TestStandard.Deprecated.WithReplacementContainingNewlines *'.PHP_EOL; - $expected .= ' TestStandard.SetProperty.AllowedAsDeclared'.PHP_EOL; - $expected .= ' TestStandard.SetProperty.AllowedViaMagicMethod'.PHP_EOL; - $expected .= ' TestStandard.SetProperty.AllowedViaStdClass'.PHP_EOL; - $expected .= ' TestStandard.SetProperty.NotAllowedViaAttribute'.PHP_EOL; - $expected .= ' TestStandard.SetProperty.PropertyTypeHandling'.PHP_EOL; - $expected .= ' TestStandard.ValidSniffs.RegisterEmptyArray'.PHP_EOL.PHP_EOL; - - $expected .= '* Sniffs marked with an asterisk are deprecated.'.PHP_EOL; - - $this->expectOutputString($expected); - - $ruleset->explain(); - - }//end testExplainWithDeprecatedSniffs() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/BrokenNamingConventions/Sniffs/Category/Sniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/BrokenNamingConventions/Sniffs/Category/Sniff.php deleted file mode 100644 index 9da190d17..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/BrokenNamingConventions/Sniffs/Category/Sniff.php +++ /dev/null @@ -1,24 +0,0 @@ - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ExternalA/Sniffs/CheckSomething/ValidSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ExternalA/Sniffs/CheckSomething/ValidSniff.php deleted file mode 100644 index 51061e3b5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ExternalA/Sniffs/CheckSomething/ValidSniff.php +++ /dev/null @@ -1,25 +0,0 @@ - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ExternalB/Sniffs/CheckMore/ValidSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ExternalB/Sniffs/CheckMore/ValidSniff.php deleted file mode 100644 index 1584f7050..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ExternalB/Sniffs/CheckMore/ValidSniff.php +++ /dev/null @@ -1,25 +0,0 @@ - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/FakeHomePath/src/MyStandard/Sniffs/Category/ValidSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/FakeHomePath/src/MyStandard/Sniffs/Category/ValidSniff.php deleted file mode 100644 index 9346df9eb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/FakeHomePath/src/MyStandard/Sniffs/Category/ValidSniff.php +++ /dev/null @@ -1,25 +0,0 @@ - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/Internal/Sniffs/Valid/ValidSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/Internal/Sniffs/Valid/ValidSniff.php deleted file mode 100644 index e7a04f495..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/Internal/Sniffs/Valid/ValidSniff.php +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/InvalidNoSniffsDir/Sniffs b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/InvalidNoSniffsDir/Sniffs deleted file mode 100644 index e69de29bb..000000000 diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/InvalidNoSniffsDir/ruleset.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/InvalidNoSniffsDir/ruleset.xml deleted file mode 100644 index 5b0897c47..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/InvalidNoSniffsDir/ruleset.xml +++ /dev/null @@ -1,4 +0,0 @@ - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ProcessRulesetAutoloadLoadAlways.1.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ProcessRulesetAutoloadLoadAlways.1.php deleted file mode 100644 index 2b1fadaf5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/ProcessRulesetAutoloadLoadAlways.1.php +++ /dev/null @@ -1,8 +0,0 @@ -string,10=>10,float=>1.5,=>,null=>null,true=>true,false=>false -// phpcs:set TestStandard.SetProperty.PropertyTypeHandling expectsEmptyArray[] - -// phpcs:set TestStandard.SetProperty.PropertyTypeHandling expectsOldSchoolArrayWithOnlyValues[] string, 10, 1.5, , null, true, false -// phpcs:set TestStandard.SetProperty.PropertyTypeHandling expectsOldSchoolArrayWithKeysAndValues[] string=>string,10=>10,float=>1.5,=>,null=>null,true=>true,false=>false -// phpcs:set TestStandard.SetProperty.PropertyTypeHandling expectsOldSchoolEmptyArray[] - -echo 'hello!'; diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/Deprecated/WithLongReplacementSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/Deprecated/WithLongReplacementSniff.php deleted file mode 100644 index 659d89ee2..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/Deprecated/WithLongReplacementSniff.php +++ /dev/null @@ -1,41 +0,0 @@ -magic[$name] = $value; - } - - public function __get($name) - { - if (isset($this->magic[$name])) { - return $this->magic[$name]; - } - - return null; - } - - public function register() - { - return [T_WHITESPACE]; - } - - public function process(File $phpcsFile, $stackPtr) - { - // Do something. - } -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SetProperty/AllowedViaStdClassSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SetProperty/AllowedViaStdClassSniff.php deleted file mode 100644 index 0f58b2e00..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SetProperty/AllowedViaStdClassSniff.php +++ /dev/null @@ -1,26 +0,0 @@ - - */ - public $expectsArrayWithOnlyValues; - - /** - * Used to verify that array properties with keys get parsed to a proper array. - * - * @var array - */ - public $expectsArrayWithKeysAndValues; - - /** - * Used to verify that array properties can get extended. - * - * @var array - */ - public $expectsArrayWithExtendedValues; - - /** - * Used to verify that array properties can get extended. - * - * @var array - */ - public $expectsArrayWithExtendedKeysAndValues; - - /** - * Used to verify that array properties allow for setting a property to an empty array. - * - * @var array - */ - public $expectsEmptyArray; - - /** - * Used to verify that array properties passed as a string get parsed to a proper array. - * - * @var array - */ - public $expectsOldSchoolArrayWithOnlyValues; - - /** - * Used to verify that array properties passed as a string with keys get parsed to a proper array. - * - * @var array - */ - public $expectsOldSchoolArrayWithKeysAndValues; - - /** - * Used to verify that array properties passed as a string can get extended. - * - * @var array - */ - public $expectsOldSchoolArrayWithExtendedValues; - - /** - * Used to verify that array properties passed as a string can get extended. - * - * @var array - */ - public $expectsOldSchoolArrayWithExtendedKeysAndValues; - - /** - * Used to verify that array properties passed as a string allow for setting a property to an empty array. - * - * @var array - */ - public $expectsOldSchoolEmptyArray; - - public function register() - { - return [T_ECHO]; - } - - public function process(File $phpcsFile, $stackPtr) - { - // Do something. - } -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ImplementsDeprecatedInterfaceSniff.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ImplementsDeprecatedInterfaceSniff.php deleted file mode 100644 index af095072b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SupportedTokenizers/ImplementsDeprecatedInterfaceSniff.php +++ /dev/null @@ -1,46 +0,0 @@ - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIgnorePatternsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIgnorePatternsTest.php deleted file mode 100644 index ae6b8bea5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIgnorePatternsTest.php +++ /dev/null @@ -1,111 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test the Ruleset::getIgnorePatterns() method. - * - * @covers \PHP_CodeSniffer\Ruleset::getIgnorePatterns - */ -final class GetIgnorePatternsTest extends TestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - private static $ruleset; - - - /** - * Initialize the config and ruleset objects for this test. - * - * @beforeClass - * - * @return void - */ - public static function initializeConfigAndRuleset() - { - // Set up the ruleset. - $standard = __DIR__."/GetIgnorePatternsTest.xml"; - $config = new ConfigDouble(["--standard=$standard"]); - self::$ruleset = new Ruleset($config); - - }//end initializeConfigAndRuleset() - - - /** - * Test retrieving ignore patterns. - * - * @param string|null $listener The listener to get patterns for or null for all patterns. - * @param array> $expected The expected function output. - * - * @dataProvider dataGetIgnorePatterns - * - * @return void - */ - public function testGetIgnorePatterns($listener, $expected) - { - $this->assertSame($expected, self::$ruleset->getIgnorePatterns($listener)); - - }//end testGetIgnorePatterns() - - - /** - * Data provider. - * - * @see self::testGetIgnorePatterns() - * - * @return array>|null>> - */ - public static function dataGetIgnorePatterns() - { - return [ - 'All ignore patterns' => [ - 'listener' => null, - 'expected' => [ - 'PSR1.Classes.ClassDeclaration' => [ - './src/*/file.php' => 'absolute', - './bin/' => 'relative', - ], - 'Generic.Formatting.SpaceAfterCast' => [ - './src/*/test\\.php$' => 'absolute', - ], - './tests/' => 'absolute', - './vendor/*' => 'absolute', - '*/node-modules/*' => 'relative', - ], - ], - 'Ignore patterns for PSR1.Classes.ClassDeclaration' => [ - 'listener' => 'PSR1.Classes.ClassDeclaration', - 'expected' => [ - './src/*/file.php' => 'absolute', - './bin/' => 'relative', - ], - ], - 'Ignore patterns for Generic.Formatting.SpaceAfterCast' => [ - 'listener' => 'Generic.Formatting.SpaceAfterCast', - 'expected' => ['./src/*/test\\.php$' => 'absolute'], - ], - 'Ignore patterns for sniff without ignore patterns' => [ - 'listener' => 'PSR1.Files.SideEffects', - 'expected' => [], - ], - ]; - - }//end dataGetIgnorePatterns() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIgnorePatternsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIgnorePatternsTest.xml deleted file mode 100644 index a0496c802..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIgnorePatternsTest.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - ./tests/ - ./vendor/* - */node-modules/* - - - - - ./src/*/file.php - ./bin/ - - - - ./src/*/test\.php$ - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIncludePatternsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIncludePatternsTest.php deleted file mode 100644 index a38401b61..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIncludePatternsTest.php +++ /dev/null @@ -1,108 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test the Ruleset::getIncludePatterns() method. - * - * @covers \PHP_CodeSniffer\Ruleset::getIncludePatterns - */ -final class GetIncludePatternsTest extends TestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - private static $ruleset; - - - /** - * Initialize the config and ruleset objects for this test. - * - * @beforeClass - * - * @return void - */ - public static function initializeConfigAndRuleset() - { - // Set up the ruleset. - $standard = __DIR__."/GetIncludePatternsTest.xml"; - $config = new ConfigDouble(["--standard=$standard"]); - self::$ruleset = new Ruleset($config); - - }//end initializeConfigAndRuleset() - - - /** - * Test retrieving include patterns. - * - * @param string|null $listener The listener to get patterns for or null for all patterns. - * @param array> $expected The expected function output. - * - * @dataProvider dataGetIncludePatterns - * - * @return void - */ - public function testGetIncludePatterns($listener, $expected) - { - $this->assertSame($expected, self::$ruleset->getIncludePatterns($listener)); - - }//end testGetIncludePatterns() - - - /** - * Data provider. - * - * @see self::testGetIncludePatterns() - * - * @return array>|null>> - */ - public static function dataGetIncludePatterns() - { - return [ - 'All include patterns' => [ - 'listener' => null, - 'expected' => [ - 'PSR1.Classes.ClassDeclaration' => [ - './src/*/file.php' => 'absolute', - './bin/' => 'relative', - ], - 'Generic.Formatting.SpaceAfterCast' => [ - './src/*/test\\.php$' => 'absolute', - ], - ], - ], - 'Include patterns for PSR1.Classes.ClassDeclaration' => [ - 'listener' => 'PSR1.Classes.ClassDeclaration', - 'expected' => [ - './src/*/file.php' => 'absolute', - './bin/' => 'relative', - ], - ], - 'Include patterns for Generic.Formatting.SpaceAfterCast' => [ - 'listener' => 'Generic.Formatting.SpaceAfterCast', - 'expected' => ['./src/*/test\\.php$' => 'absolute'], - ], - 'Include patterns for sniff without include patterns' => [ - 'listener' => 'PSR1.Files.SideEffects', - 'expected' => [], - ], - ]; - - }//end dataGetIncludePatterns() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIncludePatternsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIncludePatternsTest.xml deleted file mode 100644 index e59c89917..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/GetIncludePatternsTest.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - ./src/*/file.php - ./bin/ - - - - ./src/*/test\.php$ - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersNamingConventionsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersNamingConventionsTest.php deleted file mode 100644 index d93840521..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersNamingConventionsTest.php +++ /dev/null @@ -1,82 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test handling of sniffs not following the PHPCS naming conventions in the Ruleset::populateTokenListeners() method. - * - * @covers \PHP_CodeSniffer\Ruleset::populateTokenListeners - */ -final class PopulateTokenListenersNamingConventionsTest extends TestCase -{ - - - /** - * Verify a warning is shown for sniffs not complying with the PHPCS naming conventions. - * - * Including sniffs which do not comply with the PHPCS naming conventions is soft deprecated since - * PHPCS 3.12.0, hard deprecated since PHPCS 3.13.0 and support will be removed in PHPCS 4.0.0. - * - * @return void - */ - public function testBrokenNamingConventions() - { - // Set up the ruleset. - $standard = __DIR__.'/PopulateTokenListenersNamingConventionsTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - // The "Generic.PHP.BacktickOperator" sniff is the only valid sniff. - $expectedSniffCodes = [ - '..NoNamespace' => 'NoNamespaceSniff', - '.Sniffs.MissingCategoryDir' => 'BrokenNamingConventions\\Sniffs\\MissingCategoryDirSniff', - '.Sniffs.PartialNamespace' => 'Sniffs\\PartialNamespaceSniff', - 'BrokenNamingConventions.Category.' => 'BrokenNamingConventions\\Sniffs\\Category\\Sniff', - 'BrokenNamingConventions.Sniffs.CategoryCalledSniffs' => 'BrokenNamingConventions\\Sniffs\\Sniffs\\CategoryCalledSniffsSniff', - 'Generic.PHP.BacktickOperator' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\BacktickOperatorSniff', - 'Sniffs.SubDir.TooDeeplyNested' => 'BrokenNamingConventions\\Sniffs\\Category\\SubDir\\TooDeeplyNestedSniff', - ]; - - // Sort the value to make the tests stable as different OSes will read directories - // in a different order and the order is not relevant for these tests. Just the values. - $actual = $ruleset->sniffCodes; - ksort($actual); - - $this->assertSame($expectedSniffCodes, $actual, 'Registered sniffs do not match expectation'); - - $expectedMessage = 'DEPRECATED: The sniff BrokenNamingConventions\\Sniffs\\MissingCategoryDirSniff does not comply'; - $expectedMessage .= ' with the PHP_CodeSniffer naming conventions. This will no longer be supported in PHPCS 4.0.'.PHP_EOL; - $expectedMessage .= 'Contact the sniff author to fix the sniff.'.PHP_EOL; - $expectedMessage .= 'DEPRECATED: The sniff NoNamespaceSniff does not comply with the PHP_CodeSniffer naming conventions.'; - $expectedMessage .= ' This will no longer be supported in PHPCS 4.0.'.PHP_EOL; - $expectedMessage .= 'Contact the sniff author to fix the sniff.'.PHP_EOL; - $expectedMessage .= 'DEPRECATED: The sniff Sniffs\\PartialNamespaceSniff does not comply with the PHP_CodeSniffer naming conventions.'; - $expectedMessage .= ' This will no longer be supported in PHPCS 4.0.'.PHP_EOL; - $expectedMessage .= 'Contact the sniff author to fix the sniff.'.PHP_EOL; - $expectedMessage .= 'DEPRECATED: The sniff BrokenNamingConventions\\Sniffs\\Category\\Sniff does not comply'; - $expectedMessage .= ' with the PHP_CodeSniffer naming conventions. This will no longer be supported in PHPCS 4.0.'.PHP_EOL; - $expectedMessage .= 'Contact the sniff author to fix the sniff.'.PHP_EOL; - $expectedMessage .= 'DEPRECATED: The sniff BrokenNamingConventions\\Sniffs\\Sniffs\\CategoryCalledSniffsSniff does not'; - $expectedMessage .= ' comply with the PHP_CodeSniffer naming conventions. This will no longer be supported in PHPCS 4.0.'.PHP_EOL; - $expectedMessage .= 'Contact the sniff author to fix the sniff.'.PHP_EOL; - $expectedMessage .= 'DEPRECATED: The sniff BrokenNamingConventions\\Sniffs\\Category\\SubDir\\TooDeeplyNestedSniff'; - $expectedMessage .= ' does not comply with the PHP_CodeSniffer naming conventions. This will no longer be supported in PHPCS 4.0.'.PHP_EOL; - $expectedMessage .= 'Contact the sniff author to fix the sniff.'.PHP_EOL.PHP_EOL; - - $this->expectOutputString($expectedMessage); - - }//end testBrokenNamingConventions() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersNamingConventionsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersNamingConventionsTest.xml deleted file mode 100644 index 58e54a92c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersNamingConventionsTest.xml +++ /dev/null @@ -1,24 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersRegisterNoArrayTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersRegisterNoArrayTest.xml deleted file mode 100644 index 23c59c00a..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersRegisterNoArrayTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersSupportedTokenizersTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersSupportedTokenizersTest.php deleted file mode 100644 index 87e6da802..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersSupportedTokenizersTest.php +++ /dev/null @@ -1,111 +0,0 @@ - - * @copyright 2025 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test the Ruleset::populateTokenListeners() method shows a deprecation notice for sniffs supporting JS and/or CSS tokenizers. - * - * @covers \PHP_CodeSniffer\Ruleset::populateTokenListeners - */ -final class PopulateTokenListenersSupportedTokenizersTest extends AbstractRulesetTestCase -{ - - /** - * The Config object. - * - * @var \PHP_CodeSniffer\Config - */ - private static $config; - - - /** - * Initialize the config and ruleset objects for this test. - * - * @beforeClass - * - * @return void - */ - public static function initializeConfig() - { - // Set up the ruleset. - $standard = __DIR__.'/PopulateTokenListenersSupportedTokenizersTest.xml'; - self::$config = new ConfigDouble(["--standard=$standard"]); - - }//end initializeConfig() - - - /** - * Verify that a deprecation notice is shown if a non-deprecated sniff supports the JS/CSS tokenizer(s). - * - * Additionally, this test verifies that: - * - No deprecation notice is thrown if the complete sniff is deprecated. - * - No deprecation notice is thrown when the sniff _also_ supports PHP. - * - No deprecation notice is thrown when no tokenizers are supported (not sure why anyone would do that, but :shrug:). - * - * {@internal The test uses a data provider to verify the messages as the _order_ of the messages depends - * on the OS on which the tests are run (order in which files are retrieved), which makes the order within the - * complete message too unpredictable to test in one go.} - * - * @param string $expected The expected message output in regex format. - * - * @dataProvider dataDeprecatedTokenizersTriggerDeprecationNotice - * - * @return void - */ - public function testDeprecatedTokenizersTriggerDeprecationNotice($expected) - { - $this->expectOutputRegex($expected); - - new Ruleset(self::$config); - - }//end testDeprecatedTokenizersTriggerDeprecationNotice() - - - /** - * Data provider. - * - * @see testDeprecatedTokenizersTriggerDeprecationNotice() - * - * @return array> - */ - public static function dataDeprecatedTokenizersTriggerDeprecationNotice() - { - $cssJsDeprecated = '`DEPRECATED: Scanning CSS/JS files is deprecated and support will be removed in PHP_CodeSniffer 4\.0\.\R'; - $cssJsDeprecated .= 'The %1$s sniff is listening for %2$s\.\R`'; - - $customTokenizer = '`DEPRECATED: Support for custom tokenizers will be removed in PHP_CodeSniffer 4\.0\.\R'; - $customTokenizer .= 'The %1$s sniff is listening for %2$s\.\R`'; - - return [ - 'Listens for CSS' => [ - 'expected' => sprintf($cssJsDeprecated, 'TestStandard.SupportedTokenizers.ListensForCSS', 'CSS'), - ], - 'Listens for JS' => [ - 'expected' => sprintf($cssJsDeprecated, 'TestStandard.SupportedTokenizers.ListensForJS', 'JS'), - ], - 'Listens for both CSS and JS' => [ - 'expected' => sprintf($cssJsDeprecated, 'TestStandard.SupportedTokenizers.ListensForCSSAndJS', 'CSS, JS'), - ], - 'Listens for CSS and something unrecognized' => [ - 'expected' => sprintf($cssJsDeprecated, 'TestStandard.SupportedTokenizers.ListensForCSSAndUnrecognized', 'CSS, Unrecognized'), - ], - 'Listens for only unrecognized tokenizers' => [ - 'expected' => sprintf($customTokenizer, 'TestStandard.SupportedTokenizers.ListensForUnrecognizedTokenizers', 'SCSS, TypeScript'), - ], - ]; - - }//end dataDeprecatedTokenizersTriggerDeprecationNotice() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersSupportedTokenizersTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersSupportedTokenizersTest.xml deleted file mode 100644 index 377cb2f6a..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersSupportedTokenizersTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersTest.php deleted file mode 100644 index 54729ed39..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersTest.php +++ /dev/null @@ -1,553 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; -use PHP_CodeSniffer\Util\Tokens; -use ReflectionObject; -use ReflectionProperty; - -/** - * Test the Ruleset::populateTokenListeners() method. - * - * @covers \PHP_CodeSniffer\Ruleset::populateTokenListeners - */ -final class PopulateTokenListenersTest extends AbstractRulesetTestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - private static $ruleset; - - - /** - * Initialize the config and ruleset objects for this test only once (but do allow recording code coverage). - * - * @before - * - * @return void - */ - protected function initializeConfigAndRuleset() - { - if (isset(self::$ruleset) === false) { - // Set up the ruleset. - $standard = __DIR__.'/PopulateTokenListenersTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - self::$ruleset = new Ruleset($config); - } - - }//end initializeConfigAndRuleset() - - - /** - * Test an exception is thrown when the register() method of a sniff doesn't return an array. - * - * @return void - */ - public function testSniffWhereRegisterDoesNotReturnAnArrayThrowsException() - { - $standard = __DIR__.'/PopulateTokenListenersRegisterNoArrayTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $sniffClass = 'Fixtures\\TestStandard\\Sniffs\\InvalidSniffs\\RegisterNoArraySniff'; - $message = "ERROR: The sniff {$sniffClass}::register() method must return an array.".PHP_EOL.PHP_EOL; - $this->expectRuntimeExceptionMessage($message); - - new Ruleset($config); - - // Verify that the sniff has not been registered/has been unregistered. - // These assertions will only take effect for PHPUnit 10+. - $this->assertArrayNotHasKey($sniffClass, self::$ruleset->sniffs, "Sniff class $sniffClass is listed in registered sniffs"); - $this->assertArrayNotHasKey('TestStandard.InvalidSniffs.RegisterNoArray', self::$ruleset->sniffCodes, 'Sniff code is registered'); - - }//end testSniffWhereRegisterDoesNotReturnAnArrayThrowsException() - - - /** - * Test that a sniff not registering any tokens is not listed as a listener. - * - * @return void - */ - public function testSniffWithRegisterMethodReturningEmptyArrayIsSilentlyIgnored() - { - $target = 'Fixtures\\TestStandard\\Sniffs\\ValidSniffs\\RegisterEmptyArraySniff'; - - foreach (self::$ruleset->tokenListeners as $token => $listeners) { - $this->assertTrue(is_array($listeners), 'No listeners registered for token'.Tokens::tokenName($token)); - $this->assertArrayNotHasKey( - $target, - $listeners, - sprintf('Found the %s sniff registered for token %s', $target, Tokens::tokenName($token)) - ); - } - - }//end testSniffWithRegisterMethodReturningEmptyArrayIsSilentlyIgnored() - - - /** - * Tests that sniffs registering tokens, will end up listening to these tokens. - * - * @param string $sniffClass The FQN for the sniff class to check. - * @param int $expectedCount Expected number of tokens to which the sniff should be listening. - * - * @dataProvider dataSniffListensToTokenss - * - * @return void - */ - public function testRegistersSniffsToListenToTokens($sniffClass, $expectedCount) - { - $counter = 0; - - foreach (self::$ruleset->tokenListeners as $listeners) { - if (isset($listeners[$sniffClass]) === true) { - ++$counter; - } - } - - $this->assertSame($expectedCount, $counter); - - }//end testRegistersSniffsToListenToTokens() - - - /** - * Data provider. - * - * @see testSniffListensToTokens() - * - * @return array> - */ - public static function dataSniffListensToTokenss() - { - return [ - 'TestStandard.SupportedTokenizers.ListensForPHPAndCSSAndJS' => [ - 'sniffClass' => 'Fixtures\\TestStandard\\Sniffs\\SupportedTokenizers\\ListensForPHPAndCSSAndJSSniff', - 'expectedCount' => 2, - ], - 'Generic.NamingConventions.UpperCaseConstantName' => [ - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff', - 'expectedCount' => 2, - ], - 'PSR1.Files.SideEffects' => [ - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Files\\SideEffectsSniff', - 'expectedCount' => 1, - ], - 'PSR12.ControlStructures.BooleanOperatorPlacement' => [ - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\PSR12\\Sniffs\\ControlStructures\\BooleanOperatorPlacementSniff', - 'expectedCount' => 5, - ], - 'Squiz.ControlStructures.ForEachLoopDeclaration' => [ - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\Squiz\\Sniffs\\ControlStructures\\ForEachLoopDeclarationSniff', - 'expectedCount' => 1, - ], - 'TestStandard.Deprecated.WithReplacement' => [ - 'sniffClass' => 'Fixtures\\TestStandard\\Sniffs\\Deprecated\\WithReplacementSniff', - 'expectedCount' => 1, - ], - 'TestStandard.ValidSniffs.RegisterEmptyArray' => [ - 'sniffClass' => 'Fixtures\\TestStandard\\Sniffs\\ValidSniffs\\RegisterEmptyArraySniff', - 'expectedCount' => 0, - ], - ]; - - }//end dataSniffListensToTokenss() - - - /** - * Test that deprecated sniffs get recognized and added to the $deprecatedSniffs list. - * - * @return void - */ - public function testRegistersWhenADeprecatedSniffIsLoaded() - { - $property = new ReflectionProperty(self::$ruleset, 'deprecatedSniffs'); - (PHP_VERSION_ID < 80100) && $property->setAccessible(true); - $actualValue = $property->getValue(self::$ruleset); - (PHP_VERSION_ID < 80100) && $property->setAccessible(false); - - // Only verify there is one deprecated sniff registered. - // There are other tests which test the deprecated sniff handling in more detail. - $this->assertTrue(is_array($actualValue)); - $this->assertCount(1, $actualValue); - - }//end testRegistersWhenADeprecatedSniffIsLoaded() - - - /** - * Verify that the setting of properties on a sniff was not triggered when there are no properties being set. - * - * @return void - */ - public function testDoesntTriggerPropertySettingForNoProperties() - { - $sniffClass = 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff'; - - // Verify that our target sniff has been registered. - $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, "Sniff class $sniffClass not listed in registered sniffs"); - - $sniffObject = self::$ruleset->sniffs[$sniffClass]; - $reflection = new ReflectionObject($sniffObject); - - // Just making sure there are no properties on the sniff object (which doesn't have declared properties). - $this->assertSame([], $reflection->getProperties(), "Unexpected properties found on sniff class $sniffClass"); - - }//end testDoesntTriggerPropertySettingForNoProperties() - - - /** - * Verify that the setting of properties on a sniff was triggered. - * - * @param string $sniffClass The FQN for the sniff class on which the property should be set. - * @param string $propertyName The property name. - * @param string $expected The expected property value. - * - * @dataProvider dataTriggersPropertySettingWhenPropertiesProvided - * - * @return void - */ - public function testTriggersPropertySettingWhenPropertiesProvided($sniffClass, $propertyName, $expected) - { - // Verify that our target sniff has been registered. - $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, "Sniff class $sniffClass not listed in registered sniffs"); - - $sniffObject = self::$ruleset->sniffs[$sniffClass]; - - // Verify the property has been set. - $this->assertSame($expected, $sniffObject->$propertyName, "Property on sniff class $sniffClass set to unexpected value"); - - }//end testTriggersPropertySettingWhenPropertiesProvided() - - - /** - * Data provider. - * - * @see testTriggersPropertySettingWhenPropertiesProvided() - * - * @return array> - */ - public static function dataTriggersPropertySettingWhenPropertiesProvided() - { - return [ - 'Sniff with single property being set' => [ - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\PSR12\\Sniffs\\ControlStructures\\BooleanOperatorPlacementSniff', - 'propertyName' => 'allowOnly', - 'expected' => 'first', - ], - 'Sniff with multiple properties being set - first property' => [ - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\Squiz\\Sniffs\\ControlStructures\\ForEachLoopDeclarationSniff', - 'propertyName' => 'requiredSpacesAfterOpen', - 'expected' => '3', - ], - 'Sniff with multiple properties being set - second property' => [ - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\Squiz\\Sniffs\\ControlStructures\\ForEachLoopDeclarationSniff', - 'propertyName' => 'requiredSpacesBeforeClose', - 'expected' => '8', - ], - ]; - - }//end dataTriggersPropertySettingWhenPropertiesProvided() - - - /** - * Verifies that the "class" and "source" indexes get set. - * - * @return void - */ - public function testSetsClassAndSourceIndexes() - { - foreach (self::$ruleset->tokenListeners as $token => $listeners) { - $this->assertTrue(is_array($listeners), 'No listeners registered for token'.Tokens::tokenName($token)); - - foreach ($listeners as $className => $details) { - $this->assertArrayHasKey( - 'class', - $details, - sprintf('"tokenizers" key missing for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - - $this->assertSame( - $className, - $details['class'], - sprintf('Unexpected value for "class" key for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - - $this->assertArrayHasKey( - 'source', - $details, - sprintf('"source" key missing for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - - $this->assertTrue( - is_string($details['source']), - sprintf('Value for "source" key is not a string for token %s', Tokens::tokenName($token)) - ); - - $expected = '.'.substr($className, (strrpos($className, '\\') + 1), -5); - - $this->assertStringEndsWith( - $expected, - $details['source'], - sprintf('Unexpected value for "source" key for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - }//end foreach - }//end foreach - - }//end testSetsClassAndSourceIndexes() - - - /** - * Verifies that sniffs by default are listening for PHP files only. - * - * @return void - */ - public function testSetsSupportedTokenizersToPHPByDefault() - { - $exclude = 'Fixtures\\TestStandard\\Sniffs\\SupportedTokenizers\\ListensForPHPAndCSSAndJSSniff'; - $expected = ['PHP' => 'PHP']; - - foreach (self::$ruleset->tokenListeners as $token => $listeners) { - $this->assertTrue(is_array($listeners), 'No listeners registered for token'.Tokens::tokenName($token)); - - foreach ($listeners as $className => $details) { - if ($className === $exclude) { - // Skip this one as it is the one sniff for which things will be different. - continue; - } - - $this->assertArrayHasKey( - 'tokenizers', - $details, - sprintf('"tokenizers" key missing for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - - $this->assertSame( - $expected, - $details['tokenizers'], - sprintf('Unexpected value for "tokenizers" key for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - } - }//end foreach - - }//end testSetsSupportedTokenizersToPHPByDefault() - - - /** - * Test that if a sniff has the $supportedTokenizers property set, the tokenizers listed there - * will be registered in the listeners array. - * - * @param int $token The token constant for which the sniff should be registered. - * - * @dataProvider dataSetsSupportedTokenizersWhenProvidedBySniff - * - * @return void - */ - public function testSetsSupportedTokenizersWhenProvidedBySniff($token) - { - $sniffClass = 'Fixtures\\TestStandard\\Sniffs\\SupportedTokenizers\\ListensForPHPAndCSSAndJSSniff'; - $expected = [ - 'PHP' => 'PHP', - 'JS' => 'JS', - 'CSS' => 'CSS', - ]; - - $this->assertArrayHasKey( - $token, - self::$ruleset->tokenListeners, - sprintf('The token constant %s is not registered to the listeners array', Tokens::tokenName($token)) - ); - $this->assertArrayHasKey( - $sniffClass, - self::$ruleset->tokenListeners[$token], - sprintf('The sniff class %s is not registered for token %s', $sniffClass, Tokens::tokenName($token)) - ); - $this->assertArrayHasKey( - 'tokenizers', - self::$ruleset->tokenListeners[$token][$sniffClass], - sprintf('"tokenizers" key missing for sniff class %s for token %s', $sniffClass, Tokens::tokenName($token)) - ); - - $this->assertSame( - $expected, - self::$ruleset->tokenListeners[$token][$sniffClass]['tokenizers'], - sprintf('Unexpected value for "tokenizers" key for sniff class %s for token %s', $sniffClass, Tokens::tokenName($token)) - ); - - }//end testSetsSupportedTokenizersWhenProvidedBySniff() - - - /** - * Data provider. - * - * @see testSetsSupportedTokenizersWhenProvidedBySniff() - * - * @return array> - */ - public static function dataSetsSupportedTokenizersWhenProvidedBySniff() - { - return [ - 'T_OPEN_TAG' => [T_OPEN_TAG], - 'T_OPEN_TAG_WITH_ECHO' => [T_OPEN_TAG_WITH_ECHO], - ]; - - }//end dataSetsSupportedTokenizersWhenProvidedBySniff() - - - /** - * Verifies that by default no explicit include patterns are registered for sniffs. - * - * @return void - */ - public function testSetsIncludePatternsToEmptyArrayByDefault() - { - $exclude = 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff'; - - foreach (self::$ruleset->tokenListeners as $token => $listeners) { - $this->assertTrue(is_array($listeners), 'No listeners registered for token'.Tokens::tokenName($token)); - - foreach ($listeners as $className => $details) { - if ($className === $exclude) { - // Skip this one as it is the one sniff for which things will be different. - continue; - } - - $this->assertArrayHasKey( - 'include', - $details, - sprintf('"include" key missing for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - - $this->assertSame( - [], - $details['include'], - sprintf('Unexpected value for "include" key for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - } - }//end foreach - - }//end testSetsIncludePatternsToEmptyArrayByDefault() - - - /** - * Verifies that by default no explicit ignore patterns are registered for sniffs. - * - * @return void - */ - public function testSetsIgnorePatternsToEmptyArrayByDefault() - { - $exclude = 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Files\\SideEffectsSniff'; - - foreach (self::$ruleset->tokenListeners as $token => $listeners) { - $this->assertTrue(is_array($listeners), 'No listeners registered for token'.Tokens::tokenName($token)); - - foreach ($listeners as $className => $details) { - if ($className === $exclude) { - // Skip this one as it is the one sniff for which things will be different. - continue; - } - - $this->assertArrayHasKey( - 'ignore', - $details, - sprintf('"ignore" key missing for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - - $this->assertSame( - [], - $details['ignore'], - sprintf('Unexpected value for "ignore" key for sniff class %s for token %s', $className, Tokens::tokenName($token)) - ); - } - }//end foreach - - }//end testSetsIgnorePatternsToEmptyArrayByDefault() - - - /** - * Tests that if there are <[include|exclude]-pattern> directives set on a sniff, these are set for the relevant listeners. - * - * Includes verification that the transformation of "regex"-like patterns is handled correctly. - * - * @param int|string $token A token constant on which the sniff should be registered. - * @param string $sniffClass The FQN for the sniff class on which the patterns should be registered. - * @param string $patternType The type of patterns expected to be registered for the sniff. - * - * @dataProvider dataSetsIncludeAndIgnorePatterns - * - * @return void - */ - public function testSetsIncludeAndIgnorePatterns($token, $sniffClass, $patternType) - { - $expected = [ - '/no-transformation/', - '/simple.*transformation/.*', - '/escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.css', - '/pat?tern(is|regex)\\.php$', - ]; - - $this->assertArrayHasKey( - $token, - self::$ruleset->tokenListeners, - sprintf('The token constant %s is not registered to the listeners array', Tokens::tokenName($token)) - ); - $this->assertArrayHasKey( - $sniffClass, - self::$ruleset->tokenListeners[$token], - sprintf('The sniff class %s is not registered for token %s', $sniffClass, Tokens::tokenName($token)) - ); - $this->assertArrayHasKey( - $patternType, - self::$ruleset->tokenListeners[$token][$sniffClass], - sprintf('"%s" key missing for sniff class %s for token %s', $patternType, $sniffClass, Tokens::tokenName($token)) - ); - - $this->assertSame( - $expected, - self::$ruleset->tokenListeners[$token][$sniffClass][$patternType], - sprintf('Unexpected value for "%s" key for sniff class %s for token %s', $patternType, $sniffClass, Tokens::tokenName($token)) - ); - - }//end testSetsIncludeAndIgnorePatterns() - - - /** - * Data provider. - * - * @see testSetsIncludeAndIgnorePatterns() - * - * @return array> - */ - public static function dataSetsIncludeAndIgnorePatterns() - { - return [ - 'Sniff with s in the ruleset - first token' => [ - 'token' => T_STRING, - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff', - 'patternType' => 'include', - ], - 'Sniff with s in the ruleset - second token' => [ - 'token' => T_CONST, - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff', - 'patternType' => 'include', - ], - 'Sniff with s in the ruleset' => [ - 'token' => T_OPEN_TAG, - 'sniffClass' => 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Files\\SideEffectsSniff', - 'patternType' => 'ignore', - ], - ]; - - }//end dataSetsIncludeAndIgnorePatterns() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersTest.xml deleted file mode 100644 index 1b6ed1a48..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PopulateTokenListenersTest.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - /no-transformation/ - /simple*transformation/* - /escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.css - /pat?tern(is|regex)\.php$ - - - - - /no-transformation/ - /simple*transformation/* - /escaped\\,comma/becomes/comma/to/allow/commas/in/filenames.css - /pat?tern(is|regex)\.php$ - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleInvalidTypeTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleInvalidTypeTest.php deleted file mode 100644 index d43958c77..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleInvalidTypeTest.php +++ /dev/null @@ -1,43 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test handling of invalid type elements. - * - * @covers \PHP_CodeSniffer\Ruleset::processRule - */ -final class ProcessRuleInvalidTypeTest extends AbstractRulesetTestCase -{ - - - /** - * Test displaying an error when an invalid type is given. - * - * @return void - */ - public function testInvalidTypeHandling() - { - $standard = __DIR__.'/ProcessRuleInvalidTypeTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $message = 'ERROR: Message type "notice" for "Generic.Files.ByteOrderMark" is invalid; must be "error" or "warning".'.PHP_EOL.PHP_EOL; - $this->expectRuntimeExceptionMessage($message); - - new Ruleset($config); - - }//end testInvalidTypeHandling() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleInvalidTypeTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleInvalidTypeTest.xml deleted file mode 100644 index 4883e9102..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleInvalidTypeTest.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - notice - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleShouldProcessElementTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleShouldProcessElementTest.php deleted file mode 100644 index c6c9e2160..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleShouldProcessElementTest.php +++ /dev/null @@ -1,666 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test handling of `phpc(cs|cbf)-only` instructions at rule level. - * - * @covers \PHP_CodeSniffer\Ruleset::processRule - * @covers \PHP_CodeSniffer\Ruleset::shouldProcessElement - */ -final class ProcessRuleShouldProcessElementTest extends AbstractRulesetTestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - private static $ruleset; - - - /** - * Initialize the config and ruleset objects for this test. - * - * @before - * - * @return void - */ - protected function initializeConfigAndRuleset() - { - if (isset(self::$ruleset) === false) { - // Set up the ruleset. - $standard = __DIR__.'/ProcessRuleShouldProcessElementTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - self::$ruleset = new Ruleset($config); - } - - }//end initializeConfigAndRuleset() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessSeverityCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $key = 'severity'; - - // Verify that the non-selective severity directive IS applied. - $sniffCode = 'Internal.NoCodeFound'; - $this->assertRulesetPropertySame(0, $sniffCode, $key); - - $sniffCode = 'PSR1.Files.SideEffects'; - $this->assertRulesetPropertySame(3, $sniffCode, $key); - - // Verify that the CS-only severity directive IS applied. - $sniffCode = 'Generic.Metrics.CyclomaticComplexity'; - $this->assertRulesetPropertySame(2, $sniffCode, $key); - - // Verify that the CBF-only severity directive is NOT applied. - $sniffCode = 'PSR2.Namespaces.NamespaceDeclaration'; - $this->assertNotHasRulesetDirective($sniffCode, $key); - - }//end testShouldProcessSeverityCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessSeverityCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $key = 'severity'; - - // Verify that the non-selective severity directive IS applied. - $sniffCode = 'PSR1.Files.SideEffects'; - $this->assertRulesetPropertySame(3, $sniffCode, $key); - - // Verify that the CS-only severity directive is NOT applied. - $sniffCode = 'Generic.Metrics.CyclomaticComplexity'; - $this->assertNotHasRulesetDirective($sniffCode, $key); - - // Verify that the CBF-only severity directive IS applied. - $sniffCode = 'PSR2.Namespaces.NamespaceDeclaration'; - $this->assertRulesetPropertySame(4, $sniffCode, $key); - - }//end testShouldProcessSeverityCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessTypeCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $key = 'type'; - - // Verify that the non-selective type directive IS applied. - $sniffCode = 'PSR1.Files.SideEffects'; - $this->assertRulesetPropertySame('warning', $sniffCode, $key); - - // Verify that the CS-only type directive IS applied. - $sniffCode = 'Generic.Metrics.CyclomaticComplexity'; - $this->assertRulesetPropertySame('warning', $sniffCode, $key); - - // Verify that the CBF-only type directive is NOT applied. - $sniffCode = 'PSR2.Namespaces.NamespaceDeclaration'; - $this->assertNotHasRulesetDirective($sniffCode, $key); - - }//end testShouldProcessTypeCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessTypeCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $key = 'type'; - - // Verify that the non-selective type directive IS applied. - $sniffCode = 'PSR1.Files.SideEffects'; - $this->assertRulesetPropertySame('warning', $sniffCode, $key); - - // Verify that the CS-only type directive is NOT applied. - $sniffCode = 'Generic.Metrics.CyclomaticComplexity'; - $this->assertNotHasRulesetDirective($sniffCode, $key); - - // Verify that the CBF-only type directive IS applied. - $sniffCode = 'PSR2.Namespaces.NamespaceDeclaration'; - $this->assertRulesetPropertySame('error', $sniffCode, $key); - - }//end testShouldProcessTypeCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessMessageCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $key = 'message'; - - // Verify that the non-selective message directive IS applied. - $sniffCode = 'PSR1.Files.SideEffects'; - $this->assertRulesetPropertySame('A different warning message', $sniffCode, $key); - - // Verify that the CS-only message directive IS applied. - $sniffCode = 'Generic.Metrics.CyclomaticComplexity'; - $this->assertRulesetPropertySame('A different warning but only for phpcs', $sniffCode, $key); - - // Verify that the CBF-only message directive is NOT applied. - $sniffCode = 'PSR2.Namespaces.NamespaceDeclaration'; - $this->assertNotHasRulesetDirective($sniffCode, $key); - - }//end testShouldProcessMessageCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessMessageCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $key = 'message'; - - // Verify that the non-selective message directive IS applied. - $sniffCode = 'Internal.NoCodeFound'; - $this->assertRulesetPropertySame("We don't to be notified if files don't contain code", $sniffCode, $key); - - $sniffCode = 'PSR1.Files.SideEffects'; - $this->assertRulesetPropertySame('A different warning message', $sniffCode, $key); - - // Verify that the CS-only message directive is NOT applied. - $sniffCode = 'Generic.Metrics.CyclomaticComplexity'; - $this->assertNotHasRulesetDirective($sniffCode, $key); - - // Verify that the CBF-only message directive IS applied. - $sniffCode = 'PSR2.Namespaces.NamespaceDeclaration'; - $this->assertRulesetPropertySame('A different warning but only for phpcbf', $sniffCode, $key); - - }//end testShouldProcessMessageCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessIncludePatternCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $includedKey = './vendor/'; - - // Verify that the non-selective include-pattern directive IS applied. - $sniffCode = 'PSR1.Methods.CamelCapsMethodName'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->includePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($includedKey, self::$ruleset->includePatterns[$sniffCode], "Include pattern for sniff $sniffCode not registered"); - - // Verify that the CS-only include-pattern directive IS applied. - $sniffCode = 'Generic.Files.LineLength'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->includePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($includedKey, self::$ruleset->includePatterns[$sniffCode], "Include pattern for sniff $sniffCode not registered"); - - // Verify that the CBF-only include-pattern directive is NOT applied. - $sniffCode = 'PSR2.Files.ClosingTag'; - $this->assertArrayNotHasKey($sniffCode, self::$ruleset->includePatterns, "Sniff $sniffCode was registered"); - - }//end testShouldProcessIncludePatternCsonly() - - - /** - * Verify that in CS mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessIncludePatternCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $includedKey = './vendor/'; - - // Verify that the non-selective include-pattern directive IS applied. - $sniffCode = 'PSR1.Methods.CamelCapsMethodName'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->includePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($includedKey, self::$ruleset->includePatterns[$sniffCode], "Include pattern for sniff $sniffCode not registered"); - - // Verify that the CS-only include-pattern directive is NOT applied. - $sniffCode = 'Generic.Files.LineLength'; - $this->assertArrayNotHasKey($sniffCode, self::$ruleset->includePatterns, "Sniff $sniffCode was registered"); - - // Verify that the CBF-only include-pattern directive is IS applied. - $sniffCode = 'PSR2.Files.ClosingTag'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->includePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($includedKey, self::$ruleset->includePatterns[$sniffCode], "Include pattern for sniff $sniffCode not registered"); - - }//end testShouldProcessIncludePatternCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessExcludePatternCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $excludedKey = './tests/'; - - // Verify that the non-selective exclude-pattern directive IS applied. - $sniffCode = 'PSR1.Classes.ClassDeclaration'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->ignorePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($excludedKey, self::$ruleset->ignorePatterns[$sniffCode], "Ignore pattern for sniff $sniffCode not registered"); - - // Verify that the CS-only exclude-pattern directive IS applied. - $sniffCode = 'Generic.Formatting.SpaceAfterCast'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->ignorePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($excludedKey, self::$ruleset->ignorePatterns[$sniffCode], "Ignore pattern for sniff $sniffCode not registered"); - - // Verify that the CBF-only exclude-pattern directive is NOT applied. - $sniffCode = 'PSR2.Methods.FunctionClosingBrace'; - $this->assertArrayNotHasKey($sniffCode, self::$ruleset->ignorePatterns, "Sniff $sniffCode was registered"); - - }//end testShouldProcessExcludePatternCsonly() - - - /** - * Verify that in CS mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessExcludePatternCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $excludedKey = './tests/'; - - // Verify that the non-selective exclude-pattern directive IS applied. - $sniffCode = 'PSR1.Classes.ClassDeclaration'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->ignorePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($excludedKey, self::$ruleset->ignorePatterns[$sniffCode], "Ignore pattern for sniff $sniffCode not registered"); - - // Verify that the CS-only exclude-pattern directive is NOT applied. - $sniffCode = 'Generic.Formatting.SpaceAfterCast'; - $this->assertArrayNotHasKey($sniffCode, self::$ruleset->ignorePatterns, "Sniff $sniffCode was registered"); - - // Verify that the CBF-only exclude-pattern directive is IS applied. - $sniffCode = 'PSR2.Methods.FunctionClosingBrace'; - $this->assertArrayHasKey($sniffCode, self::$ruleset->ignorePatterns, "Sniff $sniffCode not registered"); - $this->assertArrayHasKey($excludedKey, self::$ruleset->ignorePatterns[$sniffCode], "Ignore pattern for sniff $sniffCode not registered"); - - }//end testShouldProcessExcludePatternCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessPropertiesCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $csSniffClass = 'PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff'; - $cbfSniffClass = 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff'; - - $propertyName = 'indent'; - $propertyDefault = 4; - $propertyChanged = '2'; - - // Verify that the CS-only property directive IS applied. - $this->assertArrayHasKey($csSniffClass, self::$ruleset->sniffs, "Sniff $csSniffClass not registered"); - $this->assertXObjectHasProperty($propertyName, self::$ruleset->sniffs[$csSniffClass]); - - $actualValue = self::$ruleset->sniffs[$csSniffClass]->$propertyName; - $this->assertSame($propertyChanged, $actualValue, 'cs-only property change directive not applied'); - - // Verify that the CBF-only property directive is NOT applied. - $this->assertArrayHasKey($cbfSniffClass, self::$ruleset->sniffs, "Sniff $cbfSniffClass not registered"); - $this->assertXObjectHasProperty($propertyName, self::$ruleset->sniffs[$cbfSniffClass]); - - $actualValue = self::$ruleset->sniffs[$cbfSniffClass]->$propertyName; - $this->assertSame($propertyDefault, $actualValue, 'cbf-only property change directive was applied'); - - }//end testShouldProcessPropertiesCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessPropertiesCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $csSniffClass = 'PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff'; - $cbfSniffClass = 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff'; - - $propertyName = 'indent'; - $propertyDefault = 4; - $propertyChanged = '2'; - - // Verify that the CS-only property directive is NOT applied. - $this->assertArrayHasKey($csSniffClass, self::$ruleset->sniffs, "Sniff $csSniffClass not registered"); - $this->assertXObjectHasProperty($propertyName, self::$ruleset->sniffs[$csSniffClass]); - - $actualValue = self::$ruleset->sniffs[$csSniffClass]->$propertyName; - $this->assertSame($propertyDefault, $actualValue, 'cs-only property change directive was applied'); - - // Verify that the CBF-only property directive IS applied. - $this->assertArrayHasKey($cbfSniffClass, self::$ruleset->sniffs, "Sniff $cbfSniffClass not registered"); - $this->assertXObjectHasProperty($propertyName, self::$ruleset->sniffs[$cbfSniffClass]); - - $actualValue = self::$ruleset->sniffs[$cbfSniffClass]->$propertyName; - $this->assertSame($propertyChanged, $actualValue, 'cbf-only property change directive not applied'); - - }//end testShouldProcessPropertiesCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessPropertyCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - // Verify the sniff is registed. - $sniffClass = 'PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\ScopeIndentSniff'; - $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, "Sniff $sniffClass not registered"); - - $sniffObject = self::$ruleset->sniffs[$sniffClass]; - - // Verify that the non-selective property directive IS applied. - $propertyName = 'exact'; - $expected = true; - - $this->assertXObjectHasProperty($propertyName, $sniffObject); - $this->assertSame($expected, $sniffObject->$propertyName, 'Non-selective property change directive not applied'); - - // Verify that the CS-only property directive IS applied. - $propertyName = 'indent'; - $expected = '2'; - - $this->assertXObjectHasProperty($propertyName, $sniffObject); - $this->assertSame($expected, $sniffObject->$propertyName, 'cs-only property change directive not applied'); - - // Verify that the CBF-only property directive is NOT applied. - $propertyName = 'tabIndent'; - $expectedDefault = false; - - $this->assertXObjectHasProperty($propertyName, $sniffObject); - $this->assertSame($expectedDefault, $sniffObject->$propertyName, 'cbf-only property change directive was applied'); - - }//end testShouldProcessPropertyCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessPropertyCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - // Verify the sniff is registed. - $sniffClass = 'PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\ScopeIndentSniff'; - $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, "Sniff $sniffClass not registered"); - - $sniffObject = self::$ruleset->sniffs[$sniffClass]; - - // Verify that the non-selective property directive IS applied. - $propertyName = 'exact'; - $expected = true; - - $this->assertXObjectHasProperty($propertyName, $sniffObject); - $this->assertSame($expected, $sniffObject->$propertyName, 'Non-selective property change directive not applied'); - - // Verify that the CS-only property directive is NOT applied. - $propertyName = 'indent'; - $expectedDefault = 4; - - $this->assertXObjectHasProperty($propertyName, $sniffObject); - $this->assertSame($expectedDefault, $sniffObject->$propertyName, 'cs-only property change directive was applied'); - - // Verify that the CBF-only property directive IS applied. - $propertyName = 'tabIndent'; - $expected = true; - - $this->assertXObjectHasProperty($propertyName, $sniffObject); - $this->assertSame($expected, $sniffObject->$propertyName, 'cbf-only property change directive not applied'); - - }//end testShouldProcessPropertyCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are set and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessElementCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $expected = [ - // Non-selective element directive. - 'T_COMMENT', - // Phpcs-only element directive. - 'T_CLASS', - // Non-selective element directive via `extend`. - 'T_BACKTICK', - // Phpcs-only element directive via `extend`. - 'T_INTERFACE', - ]; - - $this->verifyShouldProcessElement($expected); - - }//end testShouldProcessElementCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are set and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessElementCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $expected = [ - // Non-selective element directive. - 'T_COMMENT', - // Phpcbf-only element directive. - 'T_ENUM', - // Non-selective element directive via `extend`. - 'T_BACKTICK', - // Phpcbf-only element directive via `extend`. - 'T_TRAIT', - ]; - - $this->verifyShouldProcessElement($expected); - - }//end testShouldProcessElementCbfonly() - - - /** - * Verify that directives are set correctly. - * - * @param array $expected Expected sniff property value. - * - * @return void - */ - private function verifyShouldProcessElement($expected) - { - // Verify the sniff is registed. - $sniffClass = 'PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\ScopeIndentSniff'; - $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, "Sniff $sniffClass not registered"); - - // Verify the target property exists. - $sniffObject = self::$ruleset->sniffs[$sniffClass]; - $propertyName = 'ignoreIndentationTokens'; - - $this->assertXObjectHasProperty($propertyName, $sniffObject); - - // Verify the value. - $actualValue = $sniffObject->$propertyName; - $this->assertSame($expected, $actualValue, 'Selective element directives not applied correctly'); - - }//end verifyShouldProcessElement() - - - /** - * Custom assertion to verify that a Ruleset `$ruleset` property has a certain directive set for a certain sniff code. - * - * @param string $sniffCode Sniff code. - * @param string $key Array key. - * - * @return void - */ - private function assertHasRulesetDirective($sniffCode, $key) - { - $this->assertArrayHasKey($sniffCode, self::$ruleset->ruleset, "Sniff $sniffCode not registered"); - $this->assertTrue(is_array(self::$ruleset->ruleset[$sniffCode]), "Sniff $sniffCode is not an array"); - $this->assertArrayHasKey($key, self::$ruleset->ruleset[$sniffCode], "Directive $key not registered for sniff $sniffCode"); - - }//end assertHasRulesetDirective() - - - /** - * Custom assertion to verify that a Ruleset `$ruleset` property does NOT have a certain directive set for a certain sniff code. - * - * @param string $sniffCode Sniff code. - * @param string $key Array key. - * - * @return void - */ - private function assertNotHasRulesetDirective($sniffCode, $key) - { - if (isset(self::$ruleset->ruleset[$sniffCode]) === true - && is_array(self::$ruleset->ruleset[$sniffCode]) === true - && isset(self::$ruleset->ruleset[$sniffCode][$key]) === true - ) { - $this->fail("Directive $key is registered for sniff $sniffCode"); - } - - }//end assertNotHasRulesetDirective() - - - /** - * Custom assertion to verify that the value of a certain directive for a certain sniff code on the ruleset is correct. - * - * @param mixed $expected Expected value. - * @param string $sniffCode Sniff code. - * @param string $key Array key. - * - * @return void - */ - private function assertRulesetPropertySame($expected, $sniffCode, $key) - { - $this->assertHasRulesetDirective($sniffCode, $key); - - $actual = self::$ruleset->ruleset[$sniffCode][$key]; - $this->assertSame($expected, $actual, "Value for $key on sniff $sniffCode does not meet expectations"); - - }//end assertRulesetPropertySame() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleShouldProcessElementTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleShouldProcessElementTest.xml deleted file mode 100644 index a8a6f4d7e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRuleShouldProcessElementTest.xml +++ /dev/null @@ -1,105 +0,0 @@ - - - - - - 0 - We don't to be notified if files don't contain code - - - - 3 - warning - A different warning message - - - - ./vendor/ - - - - ./tests/ - - - - - - - 2 - warning - A different warning but only for phpcs - - - - ./vendor/ - - - - ./tests/ - - - - - - - - - - - 4 - error - A different warning but only for phpcbf - - - - ./vendor/ - - - - ./tests/ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoExpandSniffsDirectoryTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoExpandSniffsDirectoryTest.xml deleted file mode 100644 index 5290782d1..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoExpandSniffsDirectoryTest.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadFileNotFoundTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadFileNotFoundTest.xml deleted file mode 100644 index 6df4c63fa..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadFileNotFoundTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - ./tests/Core/Ruleset/Fixtures/ThisFileDoesNotExist.php - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadTest.php deleted file mode 100644 index 1f6e289e6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadTest.php +++ /dev/null @@ -1,164 +0,0 @@ - instructions. - * - * @author Juliette Reinders Folmer - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test handling of instructions. - * - * Note: these tests need to run in separate processes as otherwise we cannot - * reliably determine whether or not the correct files were loaded as the - * underlying code uses `include_once`. - * - * @runTestsInSeparateProcesses - * @preserveGlobalState disabled - * - * @covers \PHP_CodeSniffer\Ruleset::processRuleset - */ -final class ProcessRulesetAutoloadTest extends AbstractRulesetTestCase -{ - - - /** - * Verify that in CS mode, phpcs-only directives are respected and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessAutoloadCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $originallyIncludes = get_included_files(); - - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetAutoloadTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - $finalIncludes = get_included_files(); - $diff = array_diff($finalIncludes, $originallyIncludes); - - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.1.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.1.php autoload file was not loaded' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.2.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.2.php autoload file was not loaded' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.3.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.3.php autoload file was not loaded' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.4.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.4.php autoload file was not loaded' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadPhpcsOnly.php'), - $diff, - 'ProcessRulesetAutoloadLoadPhpcsOnly.php autoload file was not loaded' - ); - $this->assertNotContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadPhpcbfOnly.php'), - $diff, - 'ProcessRulesetAutoloadLoadPhpcbfOnly.php autoload file was loaded, while it shouldn\'t have been' - ); - - }//end testShouldProcessAutoloadCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are respected and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessAutoloadCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $originallyIncludes = get_included_files(); - - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetAutoloadTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - $finalIncludes = get_included_files(); - $diff = array_diff($finalIncludes, $originallyIncludes); - - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.1.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.1.php autoload file was not loaded' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.2.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.2.php autoload file was not loaded' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.3.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.3.php autoload file was not loaded' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadAlways.4.php'), - $diff, - 'ProcessRulesetAutoloadLoadAlways.4.php autoload file was not loaded' - ); - $this->assertNotContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadPhpcsOnly.php'), - $diff, - 'ProcessRulesetAutoloadLoadPhpcsOnly.php autoload file was loaded, while it shouldn\'t have been' - ); - $this->assertContains( - __DIR__.str_replace('/', DIRECTORY_SEPARATOR, '/Fixtures/ProcessRulesetAutoloadLoadPhpcbfOnly.php'), - $diff, - 'ProcessRulesetAutoloadLoadPhpcbfOnly.php autoload file was not loaded' - ); - - }//end testShouldProcessAutoloadCbfonly() - - - /** - * Test an exception is thrown when the directive points to a file which doesn't exist. - * - * @return void - */ - public function testFileNotFoundException() - { - $exceptionMsg = 'ERROR: The specified autoload file "./tests/Core/Ruleset/Fixtures/ThisFileDoesNotExist.php" does not exist'; - $this->expectRuntimeExceptionMessage($exceptionMsg); - - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetAutoloadFileNotFoundTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - }//end testFileNotFoundException() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadTest.xml deleted file mode 100644 index f886288e8..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetAutoloadTest.xml +++ /dev/null @@ -1,37 +0,0 @@ - - - - . - - - - ./Fixtures/ProcessRulesetAutoloadLoadAlways.1.php - Fixtures/ProcessRulesetAutoloadLoadAlways.2.php - - - ./tests/Core/Ruleset/Fixtures/ProcessRulesetAutoloadLoadAlways.3.php - tests/Core/Ruleset/Fixtures/ProcessRulesetAutoloadLoadAlways.4.php - - - ./tests/Core/Ruleset/Fixtures/ProcessRulesetAutoloadLoadPhpcsOnly.php - - - ./tests/Core/Ruleset/Fixtures/ProcessRulesetAutoloadLoadPhpcbfOnly.php - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetEmptyFileTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetEmptyFileTest.xml deleted file mode 100644 index e69de29bb..000000000 diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetMultiErrorTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetMultiErrorTest.xml deleted file mode 100644 index 211b5683e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetMultiErrorTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetSingleErrorTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetSingleErrorTest.xml deleted file mode 100644 index 37aeef6bb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetSingleErrorTest.xml +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetTest.php deleted file mode 100644 index 2798c2fc6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetBrokenRulesetTest.php +++ /dev/null @@ -1,96 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Test handling of broken ruleset files. - * - * Note: these tests need to run in separate processes as otherwise they run into - * some weirdness with the libxml_get_errors()/libxml_clear_errors() functions - * (duplicate error messages). - * - * @runTestsInSeparateProcesses - * @preserveGlobalState disabled - * - * @group Windows - * - * @covers \PHP_CodeSniffer\Ruleset::processRuleset - */ -final class ProcessRulesetBrokenRulesetTest extends AbstractRulesetTestCase -{ - - - /** - * Test displaying an informative error message when an empty XML ruleset file is encountered. - * - * @return void - */ - public function testBrokenRulesetEmptyFile() - { - $standard = __DIR__.'/ProcessRulesetBrokenRulesetEmptyFileTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $regex = '`^ERROR: Ruleset \S+ProcessRulesetBrokenRulesetEmptyFileTest\.xml is not valid\R'; - $regex .= '(- On line 1, column 1: Document is empty\R)?$`'; - - $this->expectRuntimeExceptionRegex($regex); - - new Ruleset($config); - - }//end testBrokenRulesetEmptyFile() - - - /** - * Test displaying an informative error message for a broken XML ruleset with a single XML error. - * - * @return void - */ - public function testBrokenRulesetSingleError() - { - $standard = __DIR__.'/ProcessRulesetBrokenRulesetSingleErrorTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $regex = '`^ERROR: Ruleset \S+ProcessRulesetBrokenRulesetSingleErrorTest\.xml is not valid\R'; - $regex .= '- On line 3, column 1: (Premature end of data in tag ruleset line 2|EndTag: \'expectRuntimeExceptionRegex($regex); - - new Ruleset($config); - - }//end testBrokenRulesetSingleError() - - - /** - * Test displaying an informative error message for a broken XML ruleset with multiple XML errors. - * - * @return void - */ - public function testBrokenRulesetMultiError() - { - $standard = __DIR__.'/ProcessRulesetBrokenRulesetMultiErrorTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $regex = '`^ERROR: Ruleset \S+ProcessRulesetBrokenRulesetMultiErrorTest\.xml is not valid\R'; - $regex .= '- On line 8, column 12: Opening and ending tag mismatch: property line 7 and rule\R'; - $regex .= '- On line 10, column 11: Opening and ending tag mismatch: properties line [57] and ruleset\R'; - $regex .= '(- On line 11, column 1: (Premature end of data in tag rule(set)? line [24]|EndTag: \'expectRuntimeExceptionRegex($regex); - - new Ruleset($config); - - }//end testBrokenRulesetMultiError() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetExcludeSniffGroupTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetExcludeSniffGroupTest.xml deleted file mode 100644 index 5aa4aede2..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetExcludeSniffGroupTest.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetInvalidNoSniffsDirTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetInvalidNoSniffsDirTest.xml deleted file mode 100644 index 598743589..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetInvalidNoSniffsDirTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetMiscTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetMiscTest.xml deleted file mode 100644 index 7adef2287..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetMiscTest.xml +++ /dev/null @@ -1,25 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetShouldProcessElementTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetShouldProcessElementTest.php deleted file mode 100644 index 59fce1b19..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetShouldProcessElementTest.php +++ /dev/null @@ -1,391 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Config; -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test handling of `phpc(cs|cbf)-only` instructions at ruleset level. - * - * @covers \PHP_CodeSniffer\Ruleset::processRuleset - * @covers \PHP_CodeSniffer\Ruleset::shouldProcessElement - */ -final class ProcessRulesetShouldProcessElementTest extends TestCase -{ - - /** - * Cache to store the original ini values for ini settings being changed in these tests. - * - * @var array - */ - private static $originalIniValues = [ - 'bcmath.scale' => null, - 'docref_root' => null, - 'user_agent' => null, - ]; - - /** - * The Config object. - * - * @var \PHP_CodeSniffer\Tests\ConfigDouble - */ - private static $config; - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - private static $ruleset; - - - /** - * Store the original ini values to allow for restoring them after the tests. - * - * @beforeClass - * - * @return void - */ - public static function saveOriginalIniValues() - { - foreach (self::$originalIniValues as $name => $null) { - $value = ini_get($name); - if ($value !== false) { - self::$originalIniValues[$name] = $value; - } - } - - }//end saveOriginalIniValues() - - - /** - * Initialize the config and ruleset objects for this test only once (but do allow recording code coverage). - * - * @before - * - * @return void - */ - protected function initializeConfigAndRuleset() - { - if (isset(self::$ruleset) === false) { - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetShouldProcessElementTest.xml'; - self::$config = new ConfigDouble(["--standard=$standard"]); - self::$ruleset = new Ruleset(self::$config); - } - - }//end initializeConfigAndRuleset() - - - /** - * Destroy the Config object and restore the ini values after the tests. - * - * @afterClass - * - * @return void - */ - public static function restoreOriginalValues() - { - // Explicitly trigger __destruct() on the ConfigDouble to reset the Config statics. - // The explicit method call prevents potential stray test-local references to the $config object - // preventing the destructor from running the clean up (which without stray references would be - // automagically triggered when this object is destroyed, but we can't definitively rely on that). - if (isset(self::$config) === true) { - self::$config->__destruct(); - } - - foreach (self::$originalIniValues as $name => $value) { - if ($value === null) { - continue; - } - - ini_set($name, $value); - } - - }//end restoreOriginalValues() - - - /** - * Verify that in CS mode, phpcs-only directives are respected and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessConfigCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $this->assertSame('true', Config::getConfigData('neither'), 'Non-selective config directive was not applied.'); - $this->assertSame('true', Config::getConfigData('csOnly'), 'CS-only config directive was not applied.'); - $this->assertSame(null, Config::getConfigData('cbfOnly'), 'CBF-only config directive was applied, while it shouldn\'t have been.'); - - }//end testShouldProcessConfigCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are respected and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessConfigCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $this->assertSame('true', Config::getConfigData('neither'), 'Non-selective config directive was not applied.'); - $this->assertSame(null, Config::getConfigData('csOnly'), 'CS-only config directive was applied, while it shouldn\'t have been.'); - $this->assertSame('true', Config::getConfigData('cbfOnly'), 'CBF-only config directive was not applied.'); - - }//end testShouldProcessConfigCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are respected and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessArgCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $expectedExtensions = [ - 'php' => 'PHP', - 'phpt' => 'PHP', - ]; - $expectedReports = ['full' => null]; - - $this->assertSame($expectedExtensions, self::$config->extensions, 'Non-selective arg directive was not applied.'); - $this->assertTrue(self::$config->showProgress, 'Non-selective short arg directive was not applied [1].'); - $this->assertTrue(self::$config->showSources, 'Non-selective short arg directive was not applied [2].'); - $this->assertTrue(self::$config->colors, 'CS-only arg directive was not applied.'); - $this->assertSame($expectedReports, self::$config->reports, 'CBF-only arg directive was applied, while it shouldn\'t have been.'); - - }//end testShouldProcessArgCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are respected and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessArgCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $expectedExtensions = [ - 'php' => 'PHP', - 'phpt' => 'PHP', - ]; - $expectedReports = ['summary' => null]; - - $this->assertSame($expectedExtensions, self::$config->extensions, 'Non-selective arg directive was not applied.'); - $this->assertTrue(self::$config->showProgress, 'Non-selective short arg directive was not applied [1].'); - $this->assertTrue(self::$config->showSources, 'Non-selective short arg directive was not applied [2].'); - $this->assertFalse(self::$config->colors, 'CS-only arg directive was applied, while it shouldn\'t have been.'); - $this->assertSame($expectedReports, self::$config->reports, 'CBF-only arg directive was not applied.'); - - }//end testShouldProcessArgCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are respected and phpcbf-only - * directives are ignored. - * - * @requires extension bcmath - * - * @return void - */ - public function testShouldProcessIniCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $this->assertSame('2', ini_get('bcmath.scale'), 'Non-selective ini directive was not applied.'); - $this->assertSame('path/to/docs/', ini_get('docref_root'), 'CS-only ini directive was not applied.'); - $this->assertSame('', ini_get('user_agent'), 'CBF-only ini directive was applied, while it shouldn\'t have been.'); - - }//end testShouldProcessIniCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are respected and phpcs-only - * directives are ignored. - * - * @group CBF - * @requires extension bcmath - * - * @return void - */ - public function testShouldProcessIniCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $this->assertSame('2', ini_get('bcmath.scale'), 'Non-selective ini directive was not applied.'); - $this->assertSame('', ini_get('docref_root'), 'CS-only ini directive was applied, while it shouldn\'t have been..'); - $this->assertSame('Never mind', ini_get('user_agent'), 'CBF-only ini directive was not applied.'); - - }//end testShouldProcessIniCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are respected and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessExcludePatternCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $expected = [ - './tests/' => 'absolute', - './vendor/' => 'absolute', - ]; - - $this->assertSame($expected, self::$ruleset->ignorePatterns); - - }//end testShouldProcessExcludePatternCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are respected and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessExcludePatternCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $expected = [ - './tests/' => 'absolute', - './node-modules/' => 'absolute', - ]; - - $this->assertSame($expected, self::$ruleset->ignorePatterns); - - }//end testShouldProcessExcludePatternCbfonly() - - - /** - * Verify that in CS mode, phpcs-only directives are respected and phpcbf-only - * directives are ignored. - * - * @return void - */ - public function testShouldProcessRuleCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $this->assertArrayHasKey('PEAR.Formatting.MultiLineAssignment', self::$ruleset->sniffCodes); - $this->assertArrayHasKey('Generic.Arrays.ArrayIndent', self::$ruleset->sniffCodes); - $this->assertArrayNotHasKey('PSR2.Classes.ClassDeclaration', self::$ruleset->sniffCodes); - - }//end testShouldProcessRuleCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only directives are respected and phpcs-only - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessRuleCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $this->assertArrayHasKey('PEAR.Formatting.MultiLineAssignment', self::$ruleset->sniffCodes); - $this->assertArrayNotHasKey('Generic.Arrays.ArrayIndent', self::$ruleset->sniffCodes); - $this->assertArrayHasKey('PSR2.Classes.ClassDeclaration', self::$ruleset->sniffCodes); - - }//end testShouldProcessRuleCbfonly() - - - /** - * Verify that in CS mode, phpcs-only in directives are respected and phpcbf-only in - * directives are ignored. - * - * @return void - */ - public function testShouldProcessRuleExcludeCsonly() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $expected = [ - 'PEAR.Formatting.MultiLineAssignment.Indent' => [ - 'severity' => 0, - ], - ]; - - $this->assertSame($expected, self::$ruleset->ruleset); - - }//end testShouldProcessRuleExcludeCsonly() - - - /** - * Verify that in CBF mode, phpcbf-only in directives are respected and phpcs-only in - * directives are ignored. - * - * @group CBF - * - * @return void - */ - public function testShouldProcessRuleExcludeCbfonly() - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $expected = [ - 'PEAR.Formatting.MultiLineAssignment.EqualSignLine' => [ - 'severity' => 0, - ], - ]; - - $this->assertSame($expected, self::$ruleset->ruleset); - - }//end testShouldProcessRuleExcludeCbfonly() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetShouldProcessElementTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetShouldProcessElementTest.xml deleted file mode 100644 index 2a2566722..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetShouldProcessElementTest.xml +++ /dev/null @@ -1,54 +0,0 @@ - - - - . - - - - - - - - ./tests/ - - - - - - - - - ./vendor/ - - - - - - - - - - - - - ./node-modules/ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetTest.php deleted file mode 100644 index d37c03102..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ProcessRulesetTest.php +++ /dev/null @@ -1,266 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test various aspects of the Ruleset::processRuleset() method not covered via other tests. - * - * @covers \PHP_CodeSniffer\Ruleset::processRuleset - */ -final class ProcessRulesetTest extends TestCase -{ - - - /** - * Verify that a registered standard which doesn't have a "Sniffs" directory, but does have a file - * called "Sniffs" doesn't result in any errors being thrown. - * - * @return void - */ - public function testSniffsFileNotDirectory() - { - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetInvalidNoSniffsDirTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $expected = ['Generic.PHP.BacktickOperator' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\BacktickOperatorSniff']; - - $this->assertSame($expected, $ruleset->sniffCodes); - - }//end testSniffsFileNotDirectory() - - - /** - * Verify that all sniffs in a registered standard included in a ruleset automatically get added. - * - * @return void - */ - public function testAutoExpandSniffsDirectory() - { - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetAutoExpandSniffsDirectoryTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $std = 'TestStandard'; - $sniffDir = 'Fixtures\TestStandard\Sniffs'; - $expected = [ - "$std.Deprecated.WithLongReplacement" => "$sniffDir\Deprecated\WithLongReplacementSniff", - "$std.Deprecated.WithReplacement" => "$sniffDir\Deprecated\WithReplacementSniff", - "$std.Deprecated.WithReplacementContainingLinuxNewlines" => "$sniffDir\Deprecated\WithReplacementContainingLinuxNewlinesSniff", - "$std.Deprecated.WithReplacementContainingNewlines" => "$sniffDir\Deprecated\WithReplacementContainingNewlinesSniff", - "$std.Deprecated.WithoutReplacement" => "$sniffDir\Deprecated\WithoutReplacementSniff", - "$std.DeprecatedInvalid.EmptyDeprecationVersion" => "$sniffDir\DeprecatedInvalid\EmptyDeprecationVersionSniff", - "$std.DeprecatedInvalid.EmptyRemovalVersion" => "$sniffDir\DeprecatedInvalid\EmptyRemovalVersionSniff", - "$std.DeprecatedInvalid.InvalidDeprecationMessage" => "$sniffDir\DeprecatedInvalid\InvalidDeprecationMessageSniff", - "$std.DeprecatedInvalid.InvalidDeprecationVersion" => "$sniffDir\DeprecatedInvalid\InvalidDeprecationVersionSniff", - "$std.DeprecatedInvalid.InvalidRemovalVersion" => "$sniffDir\DeprecatedInvalid\InvalidRemovalVersionSniff", - "$std.MissingInterface.ValidImplements" => "$sniffDir\MissingInterface\ValidImplementsSniff", - "$std.MissingInterface.ValidImplementsViaAbstract" => "$sniffDir\MissingInterface\ValidImplementsViaAbstractSniff", - "$std.SetProperty.AllowedAsDeclared" => "$sniffDir\SetProperty\AllowedAsDeclaredSniff", - "$std.SetProperty.AllowedViaMagicMethod" => "$sniffDir\SetProperty\AllowedViaMagicMethodSniff", - "$std.SetProperty.AllowedViaStdClass" => "$sniffDir\SetProperty\AllowedViaStdClassSniff", - "$std.SetProperty.NotAllowedViaAttribute" => "$sniffDir\SetProperty\NotAllowedViaAttributeSniff", - "$std.SetProperty.PropertyTypeHandling" => "$sniffDir\SetProperty\PropertyTypeHandlingSniff", - "$std.ValidSniffs.RegisterEmptyArray" => "$sniffDir\ValidSniffs\RegisterEmptyArraySniff", - ]; - - // Sort the value to make the tests stable as different OSes will read directories - // in a different order and the order is not relevant for these tests. Just the values. - $actual = $ruleset->sniffCodes; - ksort($actual); - - $this->assertSame($expected, $actual); - - }//end testAutoExpandSniffsDirectory() - - - /** - * Verify handling of exclusions of groups of sniffs after inclusion via an even larger "group". - * - * @return void - */ - public function testExcludeSniffGroup() - { - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetExcludeSniffGroupTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $expected = [ - 'PSR1.Classes.ClassDeclaration' => 'PHP_CodeSniffer\Standards\PSR1\Sniffs\Classes\ClassDeclarationSniff', - 'PSR1.Methods.CamelCapsMethodName' => 'PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff', - ]; - - // Sort the value to make the tests stable as different OSes will read directories - // in a different order and the order is not relevant for these tests. Just the values. - $actual = $ruleset->sniffCodes; - ksort($actual); - - $this->assertSame($expected, $actual); - - }//end testExcludeSniffGroup() - - - /* - * No test for without "name" as there is nothing we can assert to verify it's being ignored. - */ - - - /** - * Test that an `` directive without a "value" attribute will be set to the ini equivalent of `true`. - * - * @return void - */ - public function testIniWithoutValue() - { - $originalValue = ini_get('user_agent'); - - // Set up the ruleset. - $this->getMiscRuleset(); - - $actualValue = ini_get('user_agent'); - // Reset the ini to its original value before the assertion to ensure it's never left in an incorrect state. - if ($originalValue !== false) { - ini_set('user_agent', $originalValue); - } - - $this->assertSame('1', $actualValue); - - }//end testIniWithoutValue() - - - /** - * Verify that inclusion of a single error code: - * - Includes the sniff, but sets "severity" for the sniff to 0; - * - Sets "severity" for the specific error code included to 5.; - * - * @return void - */ - public function testIncludeSingleErrorCode() - { - // Set up the ruleset. - $ruleset = $this->getMiscRuleset(); - - $key = 'severity'; - - $sniffCode = 'Generic.PHP.RequireStrictTypes'; - $this->assertArrayHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode not registered"); - $this->assertTrue(is_array($ruleset->ruleset[$sniffCode]), "Sniff $sniffCode is not an array"); - $this->assertArrayHasKey($key, $ruleset->ruleset[$sniffCode], "Directive $key not registered for sniff $sniffCode"); - $this->assertSame(0, $ruleset->ruleset[$sniffCode][$key], "$key has unexpected value for sniff $sniffCode"); - - $sniffCode = 'Generic.PHP.RequireStrictTypes.MissingDeclaration'; - $this->assertArrayHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode not registered"); - $this->assertTrue(is_array($ruleset->ruleset[$sniffCode]), "Sniff $sniffCode is not an array"); - $this->assertArrayHasKey($key, $ruleset->ruleset[$sniffCode], "Directive $key not registered for sniff $sniffCode"); - $this->assertSame(5, $ruleset->ruleset[$sniffCode][$key], "$key has unexpected value for sniff $sniffCode"); - - }//end testIncludeSingleErrorCode() - - - /** - * Verify that if all error codes, save one, from a sniff were previously excluded, an include for an additional - * error code from that same sniff will be respected. - * - * @return void - */ - public function testErrorCodeIncludeAfterExclude() - { - // Set up the ruleset. - $ruleset = $this->getMiscRuleset(); - - $key = 'severity'; - - $sniffCode = 'PEAR.Files.IncludingFile'; - $this->assertArrayHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode not registered"); - $this->assertTrue(is_array($ruleset->ruleset[$sniffCode]), "Sniff $sniffCode is not an array"); - $this->assertArrayHasKey($key, $ruleset->ruleset[$sniffCode], "Directive $key not registered for sniff $sniffCode"); - $this->assertSame(0, $ruleset->ruleset[$sniffCode][$key], "$key has unexpected value for sniff $sniffCode"); - - $sniffCode = 'PEAR.Files.IncludingFile.BracketsNotRequired'; - $this->assertArrayHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode not registered"); - $this->assertTrue(is_array($ruleset->ruleset[$sniffCode]), "Sniff $sniffCode is not an array"); - $this->assertArrayHasKey($key, $ruleset->ruleset[$sniffCode], "Directive $key not registered for sniff $sniffCode"); - $this->assertSame(5, $ruleset->ruleset[$sniffCode][$key], "$key has unexpected value for sniff $sniffCode"); - - $sniffCode = 'PEAR.Files.IncludingFile.UseRequire'; - $this->assertArrayHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode not registered"); - $this->assertTrue(is_array($ruleset->ruleset[$sniffCode]), "Sniff $sniffCode is not an array"); - $this->assertArrayHasKey($key, $ruleset->ruleset[$sniffCode], "Directive $key not registered for sniff $sniffCode"); - $this->assertSame(5, $ruleset->ruleset[$sniffCode][$key], "$key has unexpected value for sniff $sniffCode"); - - }//end testErrorCodeIncludeAfterExclude() - - - /** - * Verify that a element without a "ref" is completely ignored. - * - * @return void - */ - public function testRuleWithoutRefIsIgnored() - { - // Set up the ruleset. - $ruleset = $this->getMiscRuleset(); - - $sniffCode = 'Generic.Metrics.CyclomaticComplexity'; - $this->assertArrayNotHasKey($sniffCode, $ruleset->sniffCodes, "Sniff $sniffCode registered"); - $this->assertArrayNotHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode adjusted"); - - }//end testRuleWithoutRefIsIgnored() - - - /** - * Verify that no "ruleset adjustments" are registered via an `` without a "name". - * - * @return void - */ - public function testRuleExcludeWithoutNameIsIgnored() - { - // Set up the ruleset. - $ruleset = $this->getMiscRuleset(); - - $sniffCode = 'Generic.PHP.BacktickOperator'; - $this->assertArrayHasKey($sniffCode, $ruleset->sniffCodes, "Sniff $sniffCode not registered"); - $this->assertArrayNotHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode adjusted"); - - $sniffCode = 'Generic.PHP.BacktickOperator.Found'; - $this->assertArrayNotHasKey($sniffCode, $ruleset->ruleset, "Sniff $sniffCode adjusted"); - - }//end testRuleExcludeWithoutNameIsIgnored() - - - /** - * Test Helper. - * - * @return \PHP_CodeSniffer\Ruleset - */ - private function getMiscRuleset() - { - static $ruleset; - - if (isset($ruleset) === false) { - // Set up the ruleset. - $standard = __DIR__.'/ProcessRulesetMiscTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - } - - return $ruleset; - - }//end getMiscRuleset() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingInlineTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingInlineTest.xml deleted file mode 100644 index 8f276f81e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingInlineTest.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingTest.php deleted file mode 100644 index de71ba398..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingTest.php +++ /dev/null @@ -1,335 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Files\LocalFile; -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test the handling of property value types for properties set via the ruleset and inline. - * - * @covers \PHP_CodeSniffer\Ruleset::processRule - * @covers \PHP_CodeSniffer\Ruleset::setSniffProperty - */ -final class PropertyTypeHandlingTest extends TestCase -{ - - /** - * Sniff code for the sniff used in these tests. - * - * @var string - */ - const SNIFF_CODE = 'TestStandard.SetProperty.PropertyTypeHandling'; - - /** - * Class name of the sniff used in these tests. - * - * @var string - */ - const SNIFF_CLASS = 'Fixtures\\TestStandard\\Sniffs\\SetProperty\\PropertyTypeHandlingSniff'; - - - /** - * Verify a deprecation notice is shown when an array property is set from the ruleset using a comma-separated string. - * - * Support for this format was (soft) deprecated in PHPCS 3.3.0. - * - * @return void - */ - public function testUsingOldSchoolArrayFormatShowsDeprecationNotice() - { - $regex = '`^('; - $regex .= 'DEPRECATED: Passing an array of values to a property using a comma-separated string\R'; - $regex .= 'was deprecated in PHP_CodeSniffer 3\.3\.0\. Support will be removed in PHPCS 4\.0\.0\.\R'; - $regex .= 'The deprecated syntax was used for property "expectsOldSchool(?:EmptyArray|ArrayWith(?:Extended|Only)?(?:KeysAnd)?Values)"\R'; - $regex .= 'for sniff "'; - $regex .= '(?:\./tests/Core/Ruleset/Fixtures/TestStandard/Sniffs/SetProperty/PropertyTypeHandlingSniff\.php|TestStandard\.SetProperty\.PropertyTypeHandling)'; - $regex .= '"\.\R'; - $regex .= 'Pass array values via nodes instead\.\R'; - $regex .= '){14}\R$`'; - - $this->expectOutputRegex($regex); - - // Set up the ruleset. - $standard = __DIR__.'/PropertyTypeHandlingTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - }//end testUsingOldSchoolArrayFormatShowsDeprecationNotice() - - - /** - * Test the value type handling for properties set via a ruleset. - * - * @param string $propertyName Property name. - * @param mixed $expected Expected property value. - * - * @dataProvider dataTypeHandling - * @dataProvider dataArrayPropertyExtending - * - * @return void - */ - public function testTypeHandlingWhenSetViaRuleset($propertyName, $expected) - { - $sniffObject = $this->getSniffObjectForRuleset(); - - $this->assertSame($expected, $sniffObject->$propertyName); - - }//end testTypeHandlingWhenSetViaRuleset() - - - /** - * Test the value type handling for properties set inline in a test case file. - * - * @param string $propertyName Property name. - * @param mixed $expected Expected property value. - * - * @dataProvider dataTypeHandling - * - * @return void - */ - public function testTypeHandlingWhenSetInline($propertyName, $expected) - { - $sniffObject = $this->getSniffObjectAfterProcessingFile(); - - $this->assertSame($expected, $sniffObject->$propertyName); - - }//end testTypeHandlingWhenSetInline() - - - /** - * Data provider. - * - * @see self::testTypeHandlingWhenSetViaRuleset() - * @see self::testTypeHandlingWhenSetInline() - * - * @return array> - */ - public static function dataTypeHandling() - { - $expectedArrayOnlyValues = [ - 'string', - '10', - '1.5', - '', - 'null', - 'true', - 'false', - ]; - $expectedArrayKeysAndValues = [ - 'string' => 'string', - 10 => '10', - 'float' => '1.5', - 11 => '', - 'null' => 'null', - 'true' => 'true', - 'false' => 'false', - ]; - - return [ - 'String value (default)' => [ - 'propertyName' => 'expectsString', - 'expected' => 'arbitraryvalue', - ], - 'String value with whitespace gets trimmed' => [ - 'propertyName' => 'expectsTrimmedString', - 'expected' => 'some value', - ], - 'String with whitespace only value becomes null' => [ - 'propertyName' => 'emptyStringBecomesNull', - 'expected' => null, - ], - 'Integer value gets set as string' => [ - 'propertyName' => 'expectsIntButAcceptsString', - 'expected' => '12345', - ], - 'Float value gets set as string' => [ - 'propertyName' => 'expectsFloatButAcceptsString', - 'expected' => '12.345', - ], - 'Null value gets set as string' => [ - 'propertyName' => 'expectsNull', - 'expected' => 'null', - ], - 'Null (uppercase) value gets set as string' => [ - 'propertyName' => 'expectsNullCase', - 'expected' => 'NULL', - ], - 'True value gets set as boolean' => [ - 'propertyName' => 'expectsBooleanTrue', - 'expected' => true, - ], - 'True (mixed case) value gets set as string' => [ - 'propertyName' => 'expectsBooleanTrueCase', - 'expected' => 'True', - ], - 'True (with spaces) value gets set as boolean' => [ - 'propertyName' => 'expectsBooleanTrueTrimmed', - 'expected' => true, - ], - 'False value gets set as boolean' => [ - 'propertyName' => 'expectsBooleanFalse', - 'expected' => false, - ], - 'False (mixed case) value gets set as string' => [ - 'propertyName' => 'expectsBooleanFalseCase', - 'expected' => 'fALSe', - ], - 'False (with spaces) value gets set as boolean' => [ - 'propertyName' => 'expectsBooleanFalseTrimmed', - 'expected' => false, - ], - 'Array with only values (new style)' => [ - 'propertyName' => 'expectsArrayWithOnlyValues', - 'expected' => $expectedArrayOnlyValues, - ], - 'Array with keys and values (new style)' => [ - 'propertyName' => 'expectsArrayWithKeysAndValues', - 'expected' => $expectedArrayKeysAndValues, - ], - 'Empty array (new style)' => [ - 'propertyName' => 'expectsEmptyArray', - 'expected' => [], - ], - 'Array with only values (old style)' => [ - 'propertyName' => 'expectsOldSchoolArrayWithOnlyValues', - 'expected' => $expectedArrayOnlyValues, - ], - 'Array with keys and values (old style)' => [ - 'propertyName' => 'expectsOldSchoolArrayWithKeysAndValues', - 'expected' => $expectedArrayKeysAndValues, - ], - 'Empty array (old style)' => [ - 'propertyName' => 'expectsOldSchoolEmptyArray', - 'expected' => [], - ], - ]; - - }//end dataTypeHandling() - - - /** - * Data provider. - * - * Array property extending is a feature which is only supported from a ruleset, not for inline property setting. - * - * @see self::testTypeHandlingWhenSetViaRuleset() - * - * @return array> - */ - public static function dataArrayPropertyExtending() - { - $expectedArrayOnlyValuesExtended = [ - 'string', - '15', - 'another string', - ]; - $expectedArrayKeysAndValuesExtended = [ - 10 => '10', - 'string' => 'string', - 15 => '15', - 'another string' => 'another string', - ]; - - return [ - 'Array with only values extended (new style)' => [ - 'propertyName' => 'expectsArrayWithExtendedValues', - 'expected' => $expectedArrayOnlyValuesExtended, - ], - 'Array with keys and values extended (new style)' => [ - 'propertyName' => 'expectsArrayWithExtendedKeysAndValues', - 'expected' => $expectedArrayKeysAndValuesExtended, - ], - 'Array with only values extended (old style)' => [ - 'propertyName' => 'expectsOldSchoolArrayWithExtendedValues', - 'expected' => $expectedArrayOnlyValuesExtended, - ], - 'Array with keys and values extended (old style)' => [ - 'propertyName' => 'expectsOldSchoolArrayWithExtendedKeysAndValues', - 'expected' => $expectedArrayKeysAndValuesExtended, - ], - ]; - - }//end dataArrayPropertyExtending() - - - /** - * Test Helper. - * - * Note: the deprecations for using comma-separated string to pass an array, are silenced in this helper - * as that's not what's being tested here. - * - * @see self::testTypeHandlingWhenSetViaRuleset() - * - * @return \PHP_CodeSniffer\Sniffs\Sniff - */ - private function getSniffObjectForRuleset() - { - static $sniffObject; - - if (isset($sniffObject) === false) { - // Set up the ruleset. - $standard = __DIR__.'/PropertyTypeHandlingTest.xml'; - $config = new ConfigDouble(["--standard=$standard", '-q']); - $ruleset = new Ruleset($config); - - // Verify that our target sniff has been registered. - $this->assertArrayHasKey(self::SNIFF_CODE, $ruleset->sniffCodes, 'Target sniff not registered'); - $this->assertSame(self::SNIFF_CLASS, $ruleset->sniffCodes[self::SNIFF_CODE], 'Target sniff not registered with the correct class'); - $this->assertArrayHasKey(self::SNIFF_CLASS, $ruleset->sniffs, 'Sniff class not listed in registered sniffs'); - - $sniffObject = $ruleset->sniffs[self::SNIFF_CLASS]; - } - - return $sniffObject; - - }//end getSniffObjectForRuleset() - - - /** - * Test Helper - * - * @see self::testTypeHandlingWhenSetInline() - * - * @return \PHP_CodeSniffer\Sniffs\Sniff - */ - private function getSniffObjectAfterProcessingFile() - { - static $sniffObject; - - if (isset($sniffObject) === false) { - // Set up the ruleset. - $standard = __DIR__.'/PropertyTypeHandlingInlineTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - // Verify that our target sniff has been registered. - $this->assertArrayHasKey(self::SNIFF_CODE, $ruleset->sniffCodes, 'Target sniff not registered'); - $this->assertSame(self::SNIFF_CLASS, $ruleset->sniffCodes[self::SNIFF_CODE], 'Target sniff not registered with the correct class'); - $this->assertArrayHasKey(self::SNIFF_CLASS, $ruleset->sniffs, 'Sniff class not listed in registered sniffs'); - - $sniffObject = $ruleset->sniffs[self::SNIFF_CLASS]; - - // Process the file with inline phpcs:set annotations. - $testFile = realpath(__DIR__.'/Fixtures/PropertyTypeHandlingInline.inc'); - $this->assertNotFalse($testFile); - - $phpcsFile = new LocalFile($testFile, $ruleset, $config); - $phpcsFile->process(); - } - - return $sniffObject; - - }//end getSniffObjectAfterProcessingFile() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingTest.xml deleted file mode 100644 index eaca66753..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/PropertyTypeHandlingTest.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceInvalidTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceInvalidTest.xml deleted file mode 100644 index d3886c478..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceInvalidTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceTest.php deleted file mode 100644 index 89c82c028..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceTest.php +++ /dev/null @@ -1,65 +0,0 @@ - - * @copyright 2025 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Tests deprecation of support for sniffs not implementing the PHPCS `Sniff` interface. - * - * @covers \PHP_CodeSniffer\Ruleset::registerSniffs - */ -final class RegisterSniffsMissingInterfaceTest extends TestCase -{ - - - /** - * Test that no deprecation is shown when sniffs implement the `PHP_CodeSniffer\Sniffs\Sniff` interface. - * - * @return void - */ - public function testNoNoticesForSniffsImplementingInterface() - { - // Set up the ruleset. - $standard = __DIR__.'/RegisterSniffsMissingInterfaceValidTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $this->expectOutputString(''); - - new Ruleset($config); - - }//end testNoNoticesForSniffsImplementingInterface() - - - /** - * Test that a deprecation notice is shown if a sniff doesn't implement the Sniff interface. - * - * @return void - */ - public function testDeprecationNoticeWhenSniffDoesntImplementInterface() - { - // Set up the ruleset. - $standard = __DIR__.'/RegisterSniffsMissingInterfaceInvalidTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - - $expected = 'DEPRECATED: All sniffs must implement the PHP_CodeSniffer\\Sniffs\\Sniff interface.'.PHP_EOL; - $expected .= 'Interface not implemented for sniff Fixtures\\TestStandard\\Sniffs\\MissingInterface\\InvalidImplementsWithoutImplementSniff.'.PHP_EOL; - $expected .= 'Contact the sniff author to fix the sniff.'.PHP_EOL.PHP_EOL; - - $this->expectOutputString($expected); - - new Ruleset($config); - - }//end testDeprecationNoticeWhenSniffDoesntImplementInterface() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceValidTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceValidTest.xml deleted file mode 100644 index ed5220ce8..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsMissingInterfaceValidTest.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoProcessTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoProcessTest.xml deleted file mode 100644 index 3a40aac05..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoProcessTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterOrProcessTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterOrProcessTest.xml deleted file mode 100644 index 8941342e0..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterOrProcessTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterTest.xml deleted file mode 100644 index f0ab808fa..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffTest.php deleted file mode 100644 index 1efe5cdba..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsRejectsInvalidSniffTest.php +++ /dev/null @@ -1,80 +0,0 @@ - - * @copyright 2025 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Tests that invalid sniffs will be rejected with an informative error message. - * - * @covers \PHP_CodeSniffer\Ruleset::registerSniffs - */ -final class RegisterSniffsRejectsInvalidSniffTest extends AbstractRulesetTestCase -{ - - - /** - * Verify that an error is thrown if an invalid sniff class is loaded. - * - * @param string $standard The standard to use for the test. - * @param string $methodName The name of the missing method. - * - * @dataProvider dataExceptionIsThrownOnMissingInterfaceMethod - * - * @return void - */ - public function testExceptionIsThrownOnMissingInterfaceMethod($standard, $methodName) - { - // Set up the ruleset. - $standard = __DIR__.'/'.$standard; - $config = new ConfigDouble(["--standard=$standard"]); - - $regex = "`(^|\R)ERROR: Sniff class \S+Sniff is missing required method $methodName\(\)\.\R`"; - $this->expectRuntimeExceptionRegex($regex); - - new Ruleset($config); - - }//end testExceptionIsThrownOnMissingInterfaceMethod() - - - /** - * Data provider. - * - * @see testExceptionIsThrownOnMissingInterfaceMethod() - * - * @return array> - */ - public static function dataExceptionIsThrownOnMissingInterfaceMethod() - { - return [ - 'Missing register() method' => [ - 'standard' => 'RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterTest.xml', - 'methodName' => 'register', - ], - 'Missing process() method' => [ - 'standard' => 'RegisterSniffsRejectsInvalidSniffNoImplementsNoProcessTest.xml', - 'methodName' => 'process', - ], - 'Missing both, checking register() method' => [ - 'standard' => 'RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterOrProcessTest.xml', - 'methodName' => 'register', - ], - 'Missing both, checking process() method' => [ - 'standard' => 'RegisterSniffsRejectsInvalidSniffNoImplementsNoRegisterOrProcessTest.xml', - 'methodName' => 'process', - ], - ]; - - }//end dataExceptionIsThrownOnMissingInterfaceMethod() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsTest.php deleted file mode 100644 index 1ed3ee182..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RegisterSniffsTest.php +++ /dev/null @@ -1,293 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Test the Ruleset::registerSniffs() method. - * - * @covers \PHP_CodeSniffer\Ruleset::registerSniffs - */ -final class RegisterSniffsTest extends TestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - private static $ruleset; - - /** - * Original value of the $sniffs property on the Ruleset. - * - * @var array - */ - private static $originalSniffs = []; - - /** - * List of Standards dir relative sniff files loaded for the PSR1 standard. - * - * @var array - */ - private static $psr1SniffFiles = [ - 'Generic/Sniffs/Files/ByteOrderMarkSniff.php', - 'Generic/Sniffs/NamingConventions/UpperCaseConstantNameSniff.php', - 'Generic/Sniffs/PHP/DisallowAlternativePHPTagsSniff.php', - 'Generic/Sniffs/PHP/DisallowShortOpenTagSniff.php', - 'PSR1/Sniffs/Classes/ClassDeclarationSniff.php', - 'PSR1/Sniffs/Files/SideEffectsSniff.php', - 'PSR1/Sniffs/Methods/CamelCapsMethodNameSniff.php', - 'Squiz/Sniffs/Classes/ValidClassNameSniff.php', - ]; - - /** - * Absolute paths to the sniff files loaded for the PSR1 standard. - * - * @var array - */ - private static $psr1SniffAbsolutePaths = []; - - - /** - * Initialize the config and ruleset objects which will be used for some of these tests. - * - * @beforeClass - * - * @return void - */ - public static function initializeConfigAndRuleset() - { - // Set up the ruleset. - $config = new ConfigDouble(['--standard=PSR1']); - self::$ruleset = new Ruleset($config); - - // Remember the original value of the Ruleset::$sniff property as the tests adjust it. - self::$originalSniffs = self::$ruleset->sniffs; - - // Sort the value to make the tests stable as different OSes will read directories - // in a different order and the order is not relevant for these tests. Just the values. - ksort(self::$originalSniffs); - - // Update the sniff file list. - $standardsDir = dirname(dirname(dirname(__DIR__))).DIRECTORY_SEPARATOR; - $standardsDir .= 'src'.DIRECTORY_SEPARATOR.'Standards'.DIRECTORY_SEPARATOR; - - self::$psr1SniffAbsolutePaths = self::relativeToAbsoluteSniffFiles($standardsDir, self::$psr1SniffFiles); - - }//end initializeConfigAndRuleset() - - - /** - * Convert relative paths to absolute paths and ensure the paths use the correct OS-specific directory separator. - * - * @param string $baseDir Directory to which these paths are relative to. Including trailing slash. - * @param array $relativePaths Relative paths. - * - * @return array - */ - public static function relativeToAbsoluteSniffFiles($baseDir, $relativePaths) - { - $fileList = []; - foreach ($relativePaths as $sniffName) { - $sniffFile = str_replace('/', DIRECTORY_SEPARATOR, $sniffName); - $sniffFile = $baseDir.$sniffFile; - $fileList[] = $sniffFile; - } - - return $fileList; - - }//end relativeToAbsoluteSniffFiles() - - - /** - * Clear out the Ruleset::$sniffs property. - * - * @before - * - * @return void - */ - protected function clearOutSniffs() - { - // Clear out the Ruleset::$sniffs property. - self::$ruleset->sniffs = []; - - }//end clearOutSniffs() - - - /** - * Test that registering sniffs works as expected (simple base test case). - * - * @return void - */ - public function testRegisteredSniffsShouldBeTheSame() - { - self::$ruleset->registerSniffs(self::$psr1SniffAbsolutePaths, [], []); - - // Make sure the same sniff list was recreated (but without the objects having been created yet). - $this->assertSame(array_keys(self::$originalSniffs), array_keys(self::$ruleset->sniffs)); - $this->assertSame(array_keys(self::$originalSniffs), array_values(self::$ruleset->sniffs)); - - }//end testRegisteredSniffsShouldBeTheSame() - - - /** - * Test that if only specific sniffs are requested, only those are registered. - * - * {@internal Can't test this via the CLI arguments due to some code in the Ruleset class - * related to sniff tests.} - * - * @return void - */ - public function testRegisteredSniffsWithRestrictions() - { - $restrictions = [ - 'psr1\\sniffs\\classes\\classdeclarationsniff' => true, - 'psr1\\sniffs\\files\\sideeffectssniff' => true, - 'psr1\\sniffs\\methods\\camelcapsmethodnamesniff' => true, - ]; - - $expected = [ - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Classes\\ClassDeclarationSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Files\\SideEffectsSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Methods\\CamelCapsMethodNameSniff', - ]; - - self::$ruleset->registerSniffs(self::$psr1SniffAbsolutePaths, $restrictions, []); - - $this->assertSame($expected, array_keys(self::$ruleset->sniffs)); - - }//end testRegisteredSniffsWithRestrictions() - - - /** - * Test that sniffs excluded via the CLI are not registered. - * - * @return void - */ - public function testRegisteredSniffsWithExclusions() - { - // Set up the ruleset. - $args = [ - '--standard=PSR1', - '--exclude=PSR1.Classes.ClassDeclaration,PSR1.Files.SideEffects,PSR1.Methods.CamelCapsMethodName', - ]; - $config = new ConfigDouble($args); - $ruleset = new Ruleset($config); - - $expected = [ - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\Files\\ByteOrderMarkSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\NamingConventions\\UpperCaseConstantNameSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\DisallowAlternativePHPTagsSniff', - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\DisallowShortOpenTagSniff', - 'PHP_CodeSniffer\\Standards\\Squiz\\Sniffs\\Classes\\ValidClassNameSniff', - ]; - - $actual = array_keys($ruleset->sniffs); - sort($actual); - - $this->assertSame($expected, $actual); - - }//end testRegisteredSniffsWithExclusions() - - - /** - * Test combining requesting specific sniffs and excluding a subset of those. - * - * @return void - */ - public function testRegisteredSniffsBothRestrictionsAndExclusions() - { - $restrictions = [ - 'generic\\sniffs\\namingconventions\\uppercaseconstantnamesniff' => true, - 'generic\\sniffs\\php\\disallowalternativephptagssniff' => true, - 'generic\\sniffs\\php\\disallowshortopentagsniff' => true, - 'psr1\\sniffs\\classes\\classdeclarationsniff' => true, - 'squiz\\sniffs\\classes\\validclassnamesniff' => true, - ]; - - $exclusions = [ - 'squiz\\sniffs\\classes\\validclassnamesniff' => true, - 'generic\\sniffs\\php\\disallowalternativephptagssniff' => true, - 'generic\\sniffs\\namingconventions\\uppercaseconstantnamesniff' => true, - ]; - - $expected = [ - 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\PHP\\DisallowShortOpenTagSniff', - 'PHP_CodeSniffer\\Standards\\PSR1\\Sniffs\\Classes\\ClassDeclarationSniff', - ]; - - self::$ruleset->registerSniffs(self::$psr1SniffAbsolutePaths, $restrictions, $exclusions); - - $this->assertSame($expected, array_keys(self::$ruleset->sniffs)); - - }//end testRegisteredSniffsBothRestrictionsAndExclusions() - - - /** - * Verify that abstract sniffs are filtered out and not registered. - * - * @return void - */ - public function testRegisterSniffsFiltersOutAbstractClasses() - { - $extraPathsBaseDir = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR; - $extraPaths = [ - 'DirectoryExpansion/.hiddenAbove/src/MyStandard/Sniffs/AbstractSniff.php', - 'DirectoryExpansion/.hiddenAbove/src/MyStandard/Sniffs/CategoryB/AnotherAbstractSniff.php', - ]; - $extraPaths = self::relativeToAbsoluteSniffFiles($extraPathsBaseDir, $extraPaths); - - $fileList = self::$psr1SniffAbsolutePaths; - foreach ($extraPaths as $path) { - $fileList[] = $path; - } - - self::$ruleset->registerSniffs($fileList, [], []); - - // Make sure the same sniff list was recreated (but without the objects having been created yet). - $this->assertSame(array_keys(self::$originalSniffs), array_keys(self::$ruleset->sniffs)); - $this->assertSame(array_keys(self::$originalSniffs), array_values(self::$ruleset->sniffs)); - - }//end testRegisterSniffsFiltersOutAbstractClasses() - - - /** - * Test that sniff files not in a "/Sniffs/" directory are filtered out and not registered. - * - * @return void - */ - public function testRegisteredSniffsFiltersOutFilePathsWithoutSniffsDir() - { - $extraPathsBaseDir = __DIR__.DIRECTORY_SEPARATOR.'Fixtures'.DIRECTORY_SEPARATOR; - $extraPaths = [ - 'DirectoryExpansion/.hiddenAbove/src/MyStandard/Utils/NotInSniffsDirSniff.php', - 'DirectoryExpansion/.hiddenAbove/src/MyStandard/Utils/SubDir/NotInSniffsDirSniff.php', - ]; - $extraPaths = self::relativeToAbsoluteSniffFiles($extraPathsBaseDir, $extraPaths); - - $fileList = self::$psr1SniffAbsolutePaths; - foreach ($extraPaths as $path) { - $fileList[] = $path; - } - - self::$ruleset->registerSniffs($fileList, [], []); - - // Make sure the same sniff list was recreated (but without the objects having been created yet). - $this->assertSame(array_keys(self::$originalSniffs), array_keys(self::$ruleset->sniffs)); - $this->assertSame(array_keys(self::$originalSniffs), array_values(self::$ruleset->sniffs)); - - }//end testRegisteredSniffsFiltersOutFilePathsWithoutSniffsDir() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.php deleted file mode 100644 index 6eb0d1a20..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.php +++ /dev/null @@ -1,119 +0,0 @@ - - * @copyright 2019 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Ruleset class using a Linux-style absolute path to include a sniff. - * - * @covers \PHP_CodeSniffer\Ruleset - */ -final class RuleInclusionAbsoluteLinuxTest extends TestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - protected $ruleset; - - /** - * Path to the ruleset file. - * - * @var string - */ - private $standard = ''; - - /** - * The original content of the ruleset. - * - * @var string - */ - private $contents = ''; - - - /** - * Initialize the config and ruleset objects. - * - * @before - * - * @return void - */ - protected function initializeConfigAndRuleset() - { - $this->standard = __DIR__.'/'.basename(__FILE__, '.php').'.xml'; - $repoRootDir = dirname(dirname(dirname(__DIR__))); - - // On-the-fly adjust the ruleset test file to be able to test sniffs included with absolute paths. - $contents = file_get_contents($this->standard); - $this->contents = $contents; - - $newPath = $repoRootDir; - if (DIRECTORY_SEPARATOR === '\\') { - $newPath = str_replace('\\', '/', $repoRootDir); - } - - $adjusted = str_replace('%path_slash_forward%', $newPath, $contents); - - if (file_put_contents($this->standard, $adjusted) === false) { - $this->markTestSkipped('On the fly ruleset adjustment failed'); - } - - // Initialize the config and ruleset objects for the test. - $config = new ConfigDouble(["--standard={$this->standard}"]); - $this->ruleset = new Ruleset($config); - - }//end initializeConfigAndRuleset() - - - /** - * Reset ruleset file. - * - * @after - * - * @return void - */ - protected function resetRuleset() - { - file_put_contents($this->standard, $this->contents); - - }//end resetRuleset() - - - /** - * Test that sniffs registed with a Linux absolute path are correctly recognized and that - * properties are correctly set for them. - * - * @return void - */ - public function testLinuxStylePathRuleInclusion() - { - // Test that the sniff is correctly registered. - $this->assertCount(1, $this->ruleset->sniffCodes); - $this->assertArrayHasKey('Generic.Formatting.SpaceAfterNot', $this->ruleset->sniffCodes); - $this->assertSame( - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterNotSniff', - $this->ruleset->sniffCodes['Generic.Formatting.SpaceAfterNot'] - ); - - // Test that the sniff properties are correctly set. - $this->assertSame( - '10', - $this->ruleset->sniffs['PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterNotSniff']->spacing - ); - - }//end testLinuxStylePathRuleInclusion() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.xml deleted file mode 100644 index d2cb7c3aa..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteLinuxTest.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php deleted file mode 100644 index fc5d65488..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.php +++ /dev/null @@ -1,116 +0,0 @@ - - * @copyright 2019 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Ruleset class using a Windows-style absolute path to include a sniff. - * - * @covers \PHP_CodeSniffer\Ruleset - * @requires OS ^WIN.*. - * @group Windows - */ -final class RuleInclusionAbsoluteWindowsTest extends TestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - protected $ruleset; - - /** - * Path to the ruleset file. - * - * @var string - */ - private $standard = ''; - - /** - * The original content of the ruleset. - * - * @var string - */ - private $contents = ''; - - - /** - * Initialize the config and ruleset objects. - * - * @before - * - * @return void - */ - protected function initializeConfigAndRuleset() - { - $this->standard = __DIR__.'/'.basename(__FILE__, '.php').'.xml'; - $repoRootDir = dirname(dirname(dirname(__DIR__))); - - // On-the-fly adjust the ruleset test file to be able to test sniffs included with absolute paths. - $contents = file_get_contents($this->standard); - $this->contents = $contents; - - $adjusted = str_replace('%path_slash_back%', $repoRootDir, $contents); - - if (file_put_contents($this->standard, $adjusted) === false) { - $this->markTestSkipped('On the fly ruleset adjustment failed'); - } - - // Initialize the config and ruleset objects for the test. - $config = new ConfigDouble(["--standard={$this->standard}"]); - $this->ruleset = new Ruleset($config); - - }//end initializeConfigAndRuleset() - - - /** - * Reset ruleset file. - * - * @after - * - * @return void - */ - protected function resetRuleset() - { - file_put_contents($this->standard, $this->contents); - - }//end resetRuleset() - - - /** - * Test that sniffs registed with a Windows absolute path are correctly recognized and that - * properties are correctly set for them. - * - * @return void - */ - public function testWindowsStylePathRuleInclusion() - { - // Test that the sniff is correctly registered. - $this->assertCount(1, $this->ruleset->sniffCodes); - $this->assertArrayHasKey('Generic.Formatting.SpaceAfterCast', $this->ruleset->sniffCodes); - $this->assertSame( - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterCastSniff', - $this->ruleset->sniffCodes['Generic.Formatting.SpaceAfterCast'] - ); - - // Test that the sniff property is correctly set. - $this->assertSame( - '10', - $this->ruleset->sniffs['PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\SpaceAfterCastSniff']->spacing - ); - - }//end testWindowsStylePathRuleInclusion() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.xml deleted file mode 100644 index 8f22b147e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionAbsoluteWindowsTest.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest-include.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest-include.xml deleted file mode 100644 index e13f4b7c2..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest-include.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest.php deleted file mode 100644 index d91a6c259..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest.php +++ /dev/null @@ -1,479 +0,0 @@ - - * @copyright 2019 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Tests for the \PHP_CodeSniffer\Ruleset class. - * - * @covers \PHP_CodeSniffer\Ruleset - */ -final class RuleInclusionTest extends AbstractRulesetTestCase -{ - - /** - * The Ruleset object. - * - * @var \PHP_CodeSniffer\Ruleset - */ - protected static $ruleset; - - /** - * Path to the ruleset file. - * - * @var string - */ - private static $standard = ''; - - /** - * The original content of the ruleset. - * - * @var string - */ - private static $contents = ''; - - - /** - * Initialize the config and ruleset objects based on the `RuleInclusionTest.xml` ruleset file. - * - * @before - * - * @return void - */ - protected function initializeConfigAndRuleset() - { - if (self::$standard === '') { - $standard = __DIR__.'/'.basename(__FILE__, '.php').'.xml'; - self::$standard = $standard; - - // On-the-fly adjust the ruleset test file to be able to test - // sniffs included with relative paths. - $contents = file_get_contents($standard); - self::$contents = $contents; - - $repoRootDir = basename(dirname(dirname(dirname(__DIR__)))); - - $newPath = $repoRootDir; - if (DIRECTORY_SEPARATOR === '\\') { - $newPath = str_replace('\\', '/', $repoRootDir); - } - - $adjusted = str_replace('%path_root_dir%', $newPath, $contents); - - if (file_put_contents($standard, $adjusted) === false) { - self::markTestSkipped('On the fly ruleset adjustment failed'); - } - - $config = new ConfigDouble(["--standard=$standard"]); - self::$ruleset = new Ruleset($config); - }//end if - - }//end initializeConfigAndRuleset() - - - /** - * Reset ruleset file. - * - * @after - * - * @return void - */ - public function resetRuleset() - { - file_put_contents(self::$standard, self::$contents); - - }//end resetRuleset() - - - /** - * Test that sniffs are registered. - * - * @return void - */ - public function testHasSniffCodes() - { - $this->assertCount(49, self::$ruleset->sniffCodes); - - }//end testHasSniffCodes() - - - /** - * Test that sniffs are correctly registered, independently of the syntax used to include the sniff. - * - * @param string $key Expected array key. - * @param string $value Expected array value. - * - * @dataProvider dataRegisteredSniffCodes - * - * @return void - */ - public function testRegisteredSniffCodes($key, $value) - { - $this->assertArrayHasKey($key, self::$ruleset->sniffCodes); - $this->assertSame($value, self::$ruleset->sniffCodes[$key]); - - }//end testRegisteredSniffCodes() - - - /** - * Data provider. - * - * @see self::testRegisteredSniffCodes() - * - * @return array> - */ - public static function dataRegisteredSniffCodes() - { - return [ - [ - 'PSR2.Classes.ClassDeclaration', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff', - ], - [ - 'PSR2.Classes.PropertyDeclaration', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\PropertyDeclarationSniff', - ], - [ - 'PSR2.ControlStructures.ControlStructureSpacing', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ControlStructureSpacingSniff', - ], - [ - 'PSR2.ControlStructures.ElseIfDeclaration', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\ElseIfDeclarationSniff', - ], - [ - 'PSR2.ControlStructures.SwitchDeclaration', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\SwitchDeclarationSniff', - ], - [ - 'PSR2.Files.ClosingTag', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Files\ClosingTagSniff', - ], - [ - 'PSR2.Files.EndFileNewline', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Files\EndFileNewlineSniff', - ], - [ - 'PSR2.Methods.FunctionCallSignature', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionCallSignatureSniff', - ], - [ - 'PSR2.Methods.FunctionClosingBrace', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionClosingBraceSniff', - ], - [ - 'PSR2.Methods.MethodDeclaration', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\MethodDeclarationSniff', - ], - [ - 'PSR2.Namespaces.NamespaceDeclaration', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces\NamespaceDeclarationSniff', - ], - [ - 'PSR2.Namespaces.UseDeclaration', - 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Namespaces\UseDeclarationSniff', - ], - [ - 'PSR1.Classes.ClassDeclaration', - 'PHP_CodeSniffer\Standards\PSR1\Sniffs\Classes\ClassDeclarationSniff', - ], - [ - 'PSR1.Files.SideEffects', - 'PHP_CodeSniffer\Standards\PSR1\Sniffs\Files\SideEffectsSniff', - ], - [ - 'PSR1.Methods.CamelCapsMethodName', - 'PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff', - ], - [ - 'Generic.PHP.DisallowAlternativePHPTags', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\DisallowAlternativePHPTagsSniff', - ], - [ - 'Generic.PHP.DisallowShortOpenTag', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\DisallowShortOpenTagSniff', - ], - [ - 'Generic.Files.ByteOrderMark', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\ByteOrderMarkSniff', - ], - [ - 'Squiz.Classes.ValidClassName', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes\ValidClassNameSniff', - ], - [ - 'Generic.NamingConventions.UpperCaseConstantName', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\UpperCaseConstantNameSniff', - ], - [ - 'Generic.Files.LineEndings', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineEndingsSniff', - ], - [ - 'Generic.Files.LineLength', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff', - ], - [ - 'Squiz.WhiteSpace.SuperfluousWhitespace', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\SuperfluousWhitespaceSniff', - ], - [ - 'Generic.Formatting.DisallowMultipleStatements', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Formatting\DisallowMultipleStatementsSniff', - ], - [ - 'Generic.WhiteSpace.ScopeIndent', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\ScopeIndentSniff', - ], - [ - 'Generic.WhiteSpace.DisallowTabIndent', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\DisallowTabIndentSniff', - ], - [ - 'Generic.PHP.LowerCaseKeyword', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseKeywordSniff', - ], - [ - 'Generic.PHP.LowerCaseConstant', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\LowerCaseConstantSniff', - ], - [ - 'Squiz.Scope.MethodScope', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Scope\MethodScopeSniff', - ], - [ - 'Squiz.WhiteSpace.ScopeKeywordSpacing', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\ScopeKeywordSpacingSniff', - ], - [ - 'Squiz.Functions.FunctionDeclaration', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\FunctionDeclarationSniff', - ], - [ - 'Squiz.Functions.LowercaseFunctionKeywords', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\LowercaseFunctionKeywordsSniff', - ], - [ - 'Squiz.Functions.FunctionDeclarationArgumentSpacing', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\FunctionDeclarationArgumentSpacingSniff', - ], - [ - 'PEAR.Functions.ValidDefaultValue', - 'PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\ValidDefaultValueSniff', - ], - [ - 'Squiz.Functions.MultiLineFunctionDeclaration', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Functions\MultiLineFunctionDeclarationSniff', - ], - [ - 'Generic.Functions.FunctionCallArgumentSpacing', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Functions\FunctionCallArgumentSpacingSniff', - ], - [ - 'Squiz.ControlStructures.ControlSignature', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ControlSignatureSniff', - ], - [ - 'Squiz.WhiteSpace.ControlStructureSpacing', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\ControlStructureSpacingSniff', - ], - [ - 'Squiz.WhiteSpace.ScopeClosingBrace', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\WhiteSpace\ScopeClosingBraceSniff', - ], - [ - 'Squiz.ControlStructures.ForEachLoopDeclaration', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ForEachLoopDeclarationSniff', - ], - [ - 'Squiz.ControlStructures.ForLoopDeclaration', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\ForLoopDeclarationSniff', - ], - [ - 'Squiz.ControlStructures.LowercaseDeclaration', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\ControlStructures\LowercaseDeclarationSniff', - ], - [ - 'Generic.ControlStructures.InlineControlStructure', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\ControlStructures\InlineControlStructureSniff', - ], - [ - 'PSR12.Operators.OperatorSpacing', - 'PHP_CodeSniffer\Standards\PSR12\Sniffs\Operators\OperatorSpacingSniff', - ], - [ - 'Generic.Arrays.ArrayIndent', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff', - ], - [ - 'Generic.Metrics.CyclomaticComplexity', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\CyclomaticComplexitySniff', - ], - [ - 'Squiz.Files.FileExtension', - 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Files\FileExtensionSniff', - ], - [ - 'Generic.NamingConventions.CamelCapsFunctionName', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff', - ], - [ - 'Generic.Metrics.NestingLevel', - 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\NestingLevelSniff', - ], - ]; - - }//end dataRegisteredSniffCodes() - - - /** - * Test that setting properties for standards, categories, sniffs works for all supported rule - * inclusion methods. - * - * @param string $sniffClass The name of the sniff class. - * @param string $propertyName The name of the changed property. - * @param string|int|bool $expectedValue The value expected for the property. - * - * @dataProvider dataSettingProperties - * - * @return void - */ - public function testSettingProperties($sniffClass, $propertyName, $expectedValue) - { - $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs); - $this->assertXObjectHasProperty($propertyName, self::$ruleset->sniffs[$sniffClass]); - - $actualValue = self::$ruleset->sniffs[$sniffClass]->$propertyName; - $this->assertSame($expectedValue, $actualValue); - - }//end testSettingProperties() - - - /** - * Data provider. - * - * @see self::testSettingProperties() - * - * @return array> - */ - public static function dataSettingProperties() - { - return [ - 'Set property for complete standard: PSR2 ClassDeclaration' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Classes\ClassDeclarationSniff', - 'propertyName' => 'indent', - 'expectedValue' => '20', - ], - 'Set property for complete standard: PSR2 SwitchDeclaration' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\ControlStructures\SwitchDeclarationSniff', - 'propertyName' => 'indent', - 'expectedValue' => '20', - ], - 'Set property for complete standard: PSR2 FunctionCallSignature' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionCallSignatureSniff', - 'propertyName' => 'indent', - 'expectedValue' => '20', - ], - 'Set property for complete category: PSR12 OperatorSpacing' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\PSR12\Sniffs\Operators\OperatorSpacingSniff', - 'propertyName' => 'ignoreSpacingBeforeAssignments', - 'expectedValue' => false, - ], - 'Set property for individual sniff: Generic ArrayIndent' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Arrays\ArrayIndentSniff', - 'propertyName' => 'indent', - 'expectedValue' => '2', - ], - 'Set property for individual sniff using sniff file inclusion: Generic LineLength' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff', - 'propertyName' => 'lineLimit', - 'expectedValue' => '10', - ], - 'Set property for individual sniff using sniff file inclusion: CamelCapsFunctionName' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\NamingConventions\CamelCapsFunctionNameSniff', - 'propertyName' => 'strict', - 'expectedValue' => false, - ], - 'Set property for individual sniff via included ruleset: NestingLevel - nestingLevel' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\NestingLevelSniff', - 'propertyName' => 'nestingLevel', - 'expectedValue' => '2', - ], - 'Set property for all sniffs in an included ruleset: NestingLevel - absoluteNestingLevel' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\NestingLevelSniff', - 'propertyName' => 'absoluteNestingLevel', - 'expectedValue' => true, - ], - - // Testing that setting a property at error code level does *not* work. - 'Set property for error code will not change the sniff property value: CyclomaticComplexity' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics\CyclomaticComplexitySniff', - 'propertyName' => 'complexity', - 'expectedValue' => 10, - ], - ]; - - }//end dataSettingProperties() - - - /** - * Test that setting properties for standards, categories on sniffs which don't support the property will - * silently ignore the property and not set it. - * - * @param string $sniffClass The name of the sniff class. - * @param string $propertyName The name of the property which should not be set. - * - * @dataProvider dataSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails - * - * @return void - */ - public function testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails($sniffClass, $propertyName) - { - $this->assertArrayHasKey($sniffClass, self::$ruleset->sniffs, 'Sniff class '.$sniffClass.' not listed in registered sniffs'); - $this->assertXObjectNotHasProperty($propertyName, self::$ruleset->sniffs[$sniffClass]); - - }//end testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails() - - - /** - * Data provider. - * - * @see self::testSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails() - * - * @return array> - */ - public static function dataSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails() - { - return [ - 'Set property for complete standard: PSR2 ClassDeclaration' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\PSR1\Sniffs\Classes\ClassDeclarationSniff', - 'propertyName' => 'setforallsniffs', - ], - 'Set property for complete standard: PSR2 FunctionCallSignature' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\PSR2\Sniffs\Methods\FunctionCallSignatureSniff', - 'propertyName' => 'setforallsniffs', - ], - 'Set property for complete category: PSR12 OperatorSpacing' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\PSR12\Sniffs\Operators\OperatorSpacingSniff', - 'propertyName' => 'setforallincategory', - ], - 'Set property for all sniffs in included category directory' => [ - 'sniffClass' => 'PHP_CodeSniffer\Standards\Squiz\Sniffs\Files\FileExtensionSniff', - 'propertyName' => 'setforsquizfilessniffs', - ], - ]; - - }//end dataSettingInvalidPropertiesOnStandardsAndCategoriesSilentlyFails() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest.xml deleted file mode 100644 index 0cc4044f5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/RuleInclusionTest.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedAsDeclaredTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedAsDeclaredTest.xml deleted file mode 100644 index 12a947dbb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedAsDeclaredTest.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedViaMagicMethodTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedViaMagicMethodTest.xml deleted file mode 100644 index 26d556019..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedViaMagicMethodTest.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedViaStdClassTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedViaStdClassTest.xml deleted file mode 100644 index e5f407250..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAllowedViaStdClassTest.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml deleted file mode 100644 index 4563c9c73..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml deleted file mode 100644 index c206a06de..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml deleted file mode 100644 index 179cdd461..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyNotAllowedViaAttributeTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyNotAllowedViaAttributeTest.xml deleted file mode 100644 index 5ff0fd217..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyNotAllowedViaAttributeTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyThrowsErrorOnInvalidPropertyTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyThrowsErrorOnInvalidPropertyTest.xml deleted file mode 100644 index 3646d65d2..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetPropertyThrowsErrorOnInvalidPropertyTest.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetSniffPropertyTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetSniffPropertyTest.php deleted file mode 100644 index b9d9ac1f2..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/SetSniffPropertyTest.php +++ /dev/null @@ -1,421 +0,0 @@ - - * @copyright 2022 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; -use ReflectionObject; - -/** - * These tests specifically focus on the changes made to work around the PHP 8.2 dynamic properties deprecation. - * - * @covers \PHP_CodeSniffer\Ruleset::setSniffProperty - */ -final class SetSniffPropertyTest extends AbstractRulesetTestCase -{ - - - /** - * Test that setting a property via the ruleset works in all situations which allow for it. - * - * @param string $name Name of the test. Used for the sniff name, the ruleset file name etc. - * - * @dataProvider dataSniffPropertiesGetSetWhenAllowed - * - * @return void - */ - public function testSniffPropertiesGetSetWhenAllowed($name) - { - $sniffCode = "TestStandard.SetProperty.{$name}"; - $sniffClass = 'Fixtures\TestStandard\Sniffs\SetProperty\\'.$name.'Sniff'; - $properties = [ - 'arbitrarystring' => 'arbitraryvalue', - 'arbitraryarray' => [ - 'mykey' => 'myvalue', - 'otherkey' => 'othervalue', - ], - ]; - - // Set up the ruleset. - $standard = __DIR__."/SetProperty{$name}Test.xml"; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - // Verify that the sniff has been registered. - $this->assertGreaterThan(0, count($ruleset->sniffCodes), 'No sniff codes registered'); - - // Verify that our target sniff has been registered. - $this->assertArrayHasKey($sniffCode, $ruleset->sniffCodes, 'Target sniff not registered'); - $this->assertSame($sniffClass, $ruleset->sniffCodes[$sniffCode], 'Target sniff not registered with the correct class'); - - // Test that the property as declared in the ruleset has been set on the sniff. - $this->assertArrayHasKey($sniffClass, $ruleset->sniffs, 'Sniff class not listed in registered sniffs'); - - $sniffObject = $ruleset->sniffs[$sniffClass]; - foreach ($properties as $name => $expectedValue) { - $this->assertSame($expectedValue, $sniffObject->$name, 'Property value not set to expected value'); - } - - }//end testSniffPropertiesGetSetWhenAllowed() - - - /** - * Data provider. - * - * @see self::testSniffPropertiesGetSetWhenAllowed() - * - * @return array> - */ - public static function dataSniffPropertiesGetSetWhenAllowed() - { - return [ - 'Property allowed as explicitly declared' => ['AllowedAsDeclared'], - 'Property allowed as sniff extends stdClass' => ['AllowedViaStdClass'], - 'Property allowed as sniff has magic __set() method' => ['AllowedViaMagicMethod'], - ]; - - }//end dataSniffPropertiesGetSetWhenAllowed() - - - /** - * Test that setting a property for a category will apply it correctly to those sniffs which support the - * property, but won't apply it to sniffs which don't. - * - * Note: this test intentionally uses the `PEAR.Functions` category as two sniffs in that category - * have a public property with the same name (`indent`) and one sniff doesn't, which makes it a great - * test case for this. - * - * @return void - */ - public function testSetPropertyAppliesPropertyToMultipleSniffsInCategory() - { - $propertyName = 'indent'; - $expectedValue = '10'; - - // Set up the ruleset. - $standard = __DIR__.'/SetPropertyAppliesPropertyToMultipleSniffsInCategoryTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - // Test that the two sniffs which support the property have received the value. - $sniffClass = 'PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\FunctionCallSignatureSniff'; - $this->assertArrayHasKey($sniffClass, $ruleset->sniffs, 'Sniff class '.$sniffClass.' not listed in registered sniffs'); - $sniffObject = $ruleset->sniffs[$sniffClass]; - $this->assertSame($expectedValue, $sniffObject->$propertyName, 'Property value not set to expected value for '.$sniffClass); - - $sniffClass = 'PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\FunctionDeclarationSniff'; - $this->assertArrayHasKey($sniffClass, $ruleset->sniffs, 'Sniff class '.$sniffClass.' not listed in registered sniffs'); - $sniffObject = $ruleset->sniffs[$sniffClass]; - $this->assertSame($expectedValue, $sniffObject->$propertyName, 'Property value not set to expected value for '.$sniffClass); - - // Test that the property doesn't get set for the one sniff which doesn't support the property. - $sniffClass = 'PHP_CodeSniffer\Standards\PEAR\Sniffs\Functions\ValidDefaultValueSniff'; - $this->assertArrayHasKey($sniffClass, $ruleset->sniffs, 'Sniff class '.$sniffClass.' not listed in registered sniffs'); - - $hasProperty = (new ReflectionObject($ruleset->sniffs[$sniffClass]))->hasProperty($propertyName); - $errorMsg = sprintf('Property %s registered for sniff %s which does not support it', $propertyName, $sniffClass); - $this->assertFalse($hasProperty, $errorMsg); - - }//end testSetPropertyAppliesPropertyToMultipleSniffsInCategory() - - - /** - * Test that attempting to set a non-existent property directly on a sniff will throw an error - * when the sniff does not explicitly declare the property, extends stdClass or has magic methods. - * - * @return void - */ - public function testSetPropertyThrowsErrorOnInvalidProperty() - { - $exceptionMsg = 'ERROR: Property "indentation" does not exist on sniff Generic.Arrays.ArrayIndent.'.PHP_EOL.PHP_EOL; - $this->expectRuntimeExceptionMessage($exceptionMsg); - - // Set up the ruleset. - $standard = __DIR__.'/SetPropertyThrowsErrorOnInvalidPropertyTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - }//end testSetPropertyThrowsErrorOnInvalidProperty() - - - /** - * Test that attempting to set a non-existent property directly on a sniff will throw an error - * when the sniff does not explicitly declare the property, extends stdClass or has magic methods, - * even though the sniff has the PHP 8.2 `#[AllowDynamicProperties]` attribute set. - * - * @return void - */ - public function testSetPropertyThrowsErrorWhenPropertyOnlyAllowedViaAttribute() - { - $exceptionMsg = 'ERROR: Property "arbitrarystring" does not exist on sniff TestStandard.SetProperty.NotAllowedViaAttribute.'.PHP_EOL.PHP_EOL; - $this->expectRuntimeExceptionMessage($exceptionMsg); - - // Set up the ruleset. - $standard = __DIR__.'/SetPropertyNotAllowedViaAttributeTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - }//end testSetPropertyThrowsErrorWhenPropertyOnlyAllowedViaAttribute() - - - /** - * Test that attempting to set a non-existent property on a sniff when the property directive is - * for the whole standard, does not yield an error. - * - * @doesNotPerformAssertions - * - * @return void - */ - public function testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandard() - { - // Set up the ruleset. - $standard = __DIR__.'/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandardTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - }//end testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForStandard() - - - /** - * Test that attempting to set a non-existent property on a sniff when the property directive is - * for a whole category, does not yield an error. - * - * @doesNotPerformAssertions - * - * @return void - */ - public function testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategory() - { - // Set up the ruleset. - $standard = __DIR__.'/SetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategoryTest.xml'; - $config = new ConfigDouble(["--standard=$standard"]); - new Ruleset($config); - - }//end testSetPropertyDoesNotThrowErrorOnInvalidPropertyWhenSetForCategory() - - - /** - * Test that attempting to set a property for a sniff which isn't registered will be ignored. - * - * @return void - */ - public function testDirectCallIgnoredPropertyForUnusedSniff() - { - $sniffCode = 'Generic.Formatting.SpaceAfterCast'; - $sniffClass = 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\Formatting\\SpaceAfterCastSniff'; - - // Set up the ruleset. - $config = new ConfigDouble(['--standard=PSR1']); - $ruleset = new Ruleset($config); - - $ruleset->setSniffProperty( - $sniffClass, - 'ignoreNewlines', - [ - 'scope' => 'sniff', - 'value' => true, - ] - ); - - // Verify that there are sniffs registered. - $this->assertGreaterThan(0, count($ruleset->sniffCodes), 'No sniff codes registered'); - - // Verify that our target sniff has NOT been registered after attempting to set the property. - $this->assertArrayNotHasKey($sniffCode, $ruleset->sniffCodes, 'Unused sniff was registered in sniffCodes, but shouldn\'t have been'); - $this->assertArrayNotHasKey($sniffClass, $ruleset->sniffs, 'Unused sniff was registered in sniffs, but shouldn\'t have been'); - - }//end testDirectCallIgnoredPropertyForUnusedSniff() - - - /** - * Test that setting a property via a direct call to the Ruleset::setSniffProperty() method - * sets the property correctly when using the new $settings array format. - * - * @return void - */ - public function testDirectCallWithNewArrayFormatSetsProperty() - { - $name = 'AllowedAsDeclared'; - $sniffCode = "TestStandard.SetProperty.{$name}"; - $sniffClass = 'Fixtures\TestStandard\Sniffs\SetProperty\\'.$name.'Sniff'; - - // Set up the ruleset. - $standard = __DIR__."/SetProperty{$name}Test.xml"; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $propertyName = 'arbitrarystring'; - $propertyValue = 'new value'; - - $ruleset->setSniffProperty( - $sniffClass, - $propertyName, - [ - 'scope' => 'sniff', - 'value' => $propertyValue, - ] - ); - - // Verify that the sniff has been registered. - $this->assertGreaterThan(0, count($ruleset->sniffCodes), 'No sniff codes registered'); - - // Verify that our target sniff has been registered. - $this->assertArrayHasKey($sniffCode, $ruleset->sniffCodes, 'Target sniff not registered'); - $this->assertSame($sniffClass, $ruleset->sniffCodes[$sniffCode], 'Target sniff not registered with the correct class'); - - // Test that the property as declared in the ruleset has been set on the sniff. - $this->assertArrayHasKey($sniffClass, $ruleset->sniffs, 'Sniff class not listed in registered sniffs'); - - $sniffObject = $ruleset->sniffs[$sniffClass]; - $this->assertSame($propertyValue, $sniffObject->$propertyName, 'Property value not set to expected value'); - - }//end testDirectCallWithNewArrayFormatSetsProperty() - - - /** - * Test that setting a property via a direct call to the Ruleset::setSniffProperty() method - * sets the property correctly when using the old $settings array format. - * - * Tested by silencing the deprecation notice as otherwise the test would fail on the deprecation notice. - * - * @param mixed $propertyValue Value for the property to set. - * - * @dataProvider dataDirectCallWithOldArrayFormatSetsProperty - * - * @return void - */ - public function testDirectCallWithOldArrayFormatSetsProperty($propertyValue) - { - $name = 'AllowedAsDeclared'; - $sniffCode = "TestStandard.SetProperty.{$name}"; - $sniffClass = 'Fixtures\TestStandard\Sniffs\SetProperty\\'.$name.'Sniff'; - - // Set up the ruleset. - $standard = __DIR__."/SetProperty{$name}Test.xml"; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $propertyName = 'arbitrarystring'; - - @$ruleset->setSniffProperty( - $sniffClass, - $propertyName, - $propertyValue - ); - - // Verify that the sniff has been registered. - $this->assertGreaterThan(0, count($ruleset->sniffCodes), 'No sniff codes registered'); - - // Verify that our target sniff has been registered. - $this->assertArrayHasKey($sniffCode, $ruleset->sniffCodes, 'Target sniff not registered'); - $this->assertSame($sniffClass, $ruleset->sniffCodes[$sniffCode], 'Target sniff not registered with the correct class'); - - // Test that the property as declared in the ruleset has been set on the sniff. - $this->assertArrayHasKey($sniffClass, $ruleset->sniffs, 'Sniff class not listed in registered sniffs'); - - $sniffObject = $ruleset->sniffs[$sniffClass]; - $this->assertSame($propertyValue, $sniffObject->$propertyName, 'Property value not set to expected value'); - - }//end testDirectCallWithOldArrayFormatSetsProperty() - - - /** - * Data provider. - * - * @see self::testDirectCallWithOldArrayFormatSetsProperty() - * - * @return array> - */ - public static function dataDirectCallWithOldArrayFormatSetsProperty() - { - return [ - 'Property value is not an array (boolean)' => [ - 'propertyValue' => false, - ], - 'Property value is not an array (string)' => [ - 'propertyValue' => 'a string', - ], - 'Property value is an empty array' => [ - 'propertyValue' => [], - ], - 'Property value is an array without keys' => [ - 'propertyValue' => [ - 'value', - false, - ], - ], - 'Property value is an array without the "scope" or "value" keys' => [ - 'propertyValue' => [ - 'key1' => 'value', - 'key2' => false, - ], - ], - 'Property value is an array without the "scope" key' => [ - 'propertyValue' => [ - 'key1' => 'value', - 'value' => true, - ], - ], - 'Property value is an array without the "value" key' => [ - 'propertyValue' => [ - 'scope' => 'value', - 'key2' => 1234, - ], - ], - ]; - - }//end dataDirectCallWithOldArrayFormatSetsProperty() - - - /** - * Test that setting a property via a direct call to the Ruleset::setSniffProperty() method - * throws a deprecation notice when using the old $settings array format. - * - * Note: as PHPUnit stops as soon as it sees the deprecation notice, the setting of the property - * value is not tested here. - * - * @return void - */ - public function testDirectCallWithOldArrayFormatThrowsDeprecationNotice() - { - $exceptionClass = 'PHPUnit\Framework\Error\Deprecated'; - if (class_exists($exceptionClass) === false) { - $exceptionClass = 'PHPUnit_Framework_Error_Deprecated'; - } - - $exceptionMsg = 'the format of the $settings parameter has changed from (mixed) $value to array(\'scope\' => \'sniff|standard\', \'value\' => $value). Please update your integration code. See PR #3629 for more information.'; - - if (method_exists($this, 'expectException') === true) { - $this->expectException($exceptionClass); - $this->expectExceptionMessage($exceptionMsg); - } else { - // PHPUnit < 5.2.0. - $this->setExpectedException($exceptionClass, $exceptionMsg); - } - - $name = 'AllowedAsDeclared'; - $sniffClass = 'Fixtures\TestStandard\Sniffs\SetProperty\\'.$name.'Sniff'; - - // Set up the ruleset. - $standard = __DIR__."/SetProperty{$name}Test.xml"; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $ruleset->setSniffProperty( - $sniffClass, - 'arbitrarystring', - ['key' => 'value'] - ); - - }//end testDirectCallWithOldArrayFormatThrowsDeprecationNotice() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsEmptyDeprecationVersionTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsEmptyDeprecationVersionTest.xml deleted file mode 100644 index 4b7b66608..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsEmptyDeprecationVersionTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsEmptyRemovalVersionTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsEmptyRemovalVersionTest.xml deleted file mode 100644 index d22ec24e6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsEmptyRemovalVersionTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidDeprecationMessageTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidDeprecationMessageTest.xml deleted file mode 100644 index fb80426f3..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidDeprecationMessageTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidDeprecationVersionTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidDeprecationVersionTest.xml deleted file mode 100644 index 2a8aedd74..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidDeprecationVersionTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidRemovalVersionTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidRemovalVersionTest.xml deleted file mode 100644 index 6a16178b5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsInvalidRemovalVersionTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsOrderTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsOrderTest.xml deleted file mode 100644 index 9c4ce1b6e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsOrderTest.xml +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsReportWidthTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsReportWidthTest.xml deleted file mode 100644 index c198d684d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsReportWidthTest.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsTest.php deleted file mode 100644 index db793fdeb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsTest.php +++ /dev/null @@ -1,540 +0,0 @@ - - * @copyright 2024 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Ruleset; - -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\Ruleset\AbstractRulesetTestCase; - -/** - * Tests PHPCS native handling of sniff deprecations. - * - * @covers \PHP_CodeSniffer\Ruleset::hasSniffDeprecations - * @covers \PHP_CodeSniffer\Ruleset::showSniffDeprecations - */ -final class ShowSniffDeprecationsTest extends AbstractRulesetTestCase -{ - - - /** - * Test the return value of the hasSniffDeprecations() method. - * - * @param string $standard The standard to use for the test. - * @param bool $expected The expected function return value. - * - * @dataProvider dataHasSniffDeprecations - * - * @return void - */ - public function testHasSniffDeprecations($standard, $expected) - { - $config = new ConfigDouble(['.', "--standard=$standard"]); - $ruleset = new Ruleset($config); - - $this->assertSame($expected, $ruleset->hasSniffDeprecations()); - - }//end testHasSniffDeprecations() - - - /** - * Data provider. - * - * @see testHasSniffDeprecations() - * - * @return array> - */ - public static function dataHasSniffDeprecations() - { - return [ - 'Standard not using deprecated sniffs: PSR1' => [ - 'standard' => 'PSR1', - 'expected' => false, - ], - 'Standard using deprecated sniffs: Test Fixture' => [ - 'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml', - 'expected' => true, - ], - ]; - - }//end dataHasSniffDeprecations() - - - /** - * Test that the listing with deprecated sniffs will not show when specific command-line options are being used [1]. - * - * @param string $standard The standard to use for the test. - * @param array $additionalArgs Optional. Additional arguments to pass. - * - * @dataProvider dataDeprecatedSniffsListDoesNotShow - * - * @return void - */ - public function testDeprecatedSniffsListDoesNotShow($standard, $additionalArgs=[]) - { - $args = $additionalArgs; - $args[] = '.'; - $args[] = "--standard=$standard"; - - $config = new ConfigDouble($args); - $ruleset = new Ruleset($config); - - $this->expectOutputString(''); - - $ruleset->showSniffDeprecations(); - - }//end testDeprecatedSniffsListDoesNotShow() - - - /** - * Data provider. - * - * @see testDeprecatedSniffsListDoesNotShow() - * - * @return array>> - */ - public static function dataDeprecatedSniffsListDoesNotShow() - { - return [ - 'Standard not using deprecated sniffs: PSR1' => [ - 'standard' => 'PSR1', - ], - 'Standard using deprecated sniffs; explain mode' => [ - 'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml', - 'additionalArgs' => ['-e'], - ], - 'Standard using deprecated sniffs; quiet mode' => [ - 'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml', - 'additionalArgs' => ['-q'], - ], - ]; - - }//end dataDeprecatedSniffsListDoesNotShow() - - - /** - * Test that the listing with deprecated sniffs will not show when specific command-line options are being used [2]. - * - * {@internal Separate test method for the same thing as this test will only work in CS mode.} - * - * @param string $standard The standard to use for the test. - * @param array $additionalArgs Optional. Additional arguments to pass. - * - * @dataProvider dataDeprecatedSniffsListDoesNotShowNeedsCsMode - * - * @return void - */ - public function testDeprecatedSniffsListDoesNotShowNeedsCsMode($standard, $additionalArgs=[]) - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $this->testDeprecatedSniffsListDoesNotShow($standard, $additionalArgs); - - }//end testDeprecatedSniffsListDoesNotShowNeedsCsMode() - - - /** - * Data provider. - * - * @see testDeprecatedSniffsListDoesNotShowNeedsCsMode() - * - * @return array>> - */ - public static function dataDeprecatedSniffsListDoesNotShowNeedsCsMode() - { - return [ - 'Standard using deprecated sniffs; documentation is requested' => [ - 'standard' => __DIR__.'/ShowSniffDeprecationsTest.xml', - 'additionalArgs' => ['--generator=text'], - ], - ]; - - }//end dataDeprecatedSniffsListDoesNotShowNeedsCsMode() - - - /** - * Test that the listing with deprecated sniffs will not show when using a standard containing deprecated sniffs, - * but only running select non-deprecated sniffs (using `--sniffs=...`). - * - * @return void - */ - public function testDeprecatedSniffsListDoesNotShowWhenSelectedSniffsAreNotDeprecated() - { - $standard = __DIR__.'/ShowSniffDeprecationsTest.xml'; - $config = new ConfigDouble(['.', "--standard=$standard"]); - $ruleset = new Ruleset($config); - - /* - * Apply sniff restrictions. - * For tests we need to manually trigger this if the standard is "installed", like with the fixtures these tests use. - */ - - $restrictions = []; - $sniffs = [ - 'TestStandard.SetProperty.AllowedAsDeclared', - 'TestStandard.SetProperty.AllowedViaStdClass', - ]; - foreach ($sniffs as $sniffCode) { - $parts = explode('.', strtolower($sniffCode)); - $sniffName = $parts[0].'\\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff'; - $restrictions[strtolower($sniffName)] = true; - } - - $sniffFiles = []; - $allSniffs = $ruleset->sniffCodes; - foreach ($allSniffs as $sniffName) { - $sniffFile = str_replace('\\', DIRECTORY_SEPARATOR, $sniffName); - $sniffFile = __DIR__.DIRECTORY_SEPARATOR.$sniffFile.'.php'; - $sniffFiles[] = $sniffFile; - } - - $ruleset->registerSniffs($sniffFiles, $restrictions, []); - $ruleset->populateTokenListeners(); - - $this->expectOutputString(''); - - $ruleset->showSniffDeprecations(); - - }//end testDeprecatedSniffsListDoesNotShowWhenSelectedSniffsAreNotDeprecated() - - - /** - * Test that the listing with deprecated sniffs will not show when using a standard containing deprecated sniffs, - * but all deprecated sniffs have been excluded from the run (using `--exclude=...`). - * - * @return void - */ - public function testDeprecatedSniffsListDoesNotShowWhenAllDeprecatedSniffsAreExcluded() - { - $standard = __DIR__.'/ShowSniffDeprecationsTest.xml'; - $config = new ConfigDouble(['.', "--standard=$standard"]); - $ruleset = new Ruleset($config); - - /* - * Apply sniff restrictions. - * For tests we need to manually trigger this if the standard is "installed", like with the fixtures these tests use. - */ - - $exclusions = []; - $exclude = [ - 'TestStandard.Deprecated.WithLongReplacement', - 'TestStandard.Deprecated.WithoutReplacement', - 'TestStandard.Deprecated.WithReplacement', - 'TestStandard.Deprecated.WithReplacementContainingLinuxNewlines', - 'TestStandard.Deprecated.WithReplacementContainingNewlines', - ]; - foreach ($exclude as $sniffCode) { - $parts = explode('.', strtolower($sniffCode)); - $sniffName = $parts[0].'\\sniffs\\'.$parts[1].'\\'.$parts[2].'sniff'; - $exclusions[strtolower($sniffName)] = true; - } - - $sniffFiles = []; - $allSniffs = $ruleset->sniffCodes; - foreach ($allSniffs as $sniffName) { - $sniffFile = str_replace('\\', DIRECTORY_SEPARATOR, $sniffName); - $sniffFile = __DIR__.DIRECTORY_SEPARATOR.$sniffFile.'.php'; - $sniffFiles[] = $sniffFile; - } - - $ruleset->registerSniffs($sniffFiles, [], $exclusions); - $ruleset->populateTokenListeners(); - - $this->expectOutputString(''); - - $ruleset->showSniffDeprecations(); - - }//end testDeprecatedSniffsListDoesNotShowWhenAllDeprecatedSniffsAreExcluded() - - - /** - * Test various aspects of the deprecated sniffs warning. - * - * This tests a number of different aspects: - * 1. That the summary line uses the correct grammar when there is are multiple deprecated sniffs. - * 2. That there is no trailing whitespace when the sniff does not provide a custom message. - * 3. That custom messages containing new line characters (any type) are handled correctly and - * that those new line characters are converted to the OS supported new line char. - * - * @return void - */ - public function testDeprecatedSniffsWarning() - { - $standard = __DIR__.'/ShowSniffDeprecationsTest.xml'; - $config = new ConfigDouble(["--standard=$standard", '--no-colors']); - $ruleset = new Ruleset($config); - - $expected = 'WARNING: The ShowSniffDeprecationsTest standard uses 5 deprecated sniffs'.PHP_EOL; - $expected .= '--------------------------------------------------------------------------------'.PHP_EOL; - $expected .= '- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL; - $expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL; - $expected .= ' Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel'.PHP_EOL; - $expected .= ' vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed.'.PHP_EOL; - $expected .= ' Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In'.PHP_EOL; - $expected .= ' lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL; - $expected .= ' eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat.'.PHP_EOL; - $expected .= ' Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt'.PHP_EOL; - $expected .= ' dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum'.PHP_EOL; - $expected .= ' semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget'.PHP_EOL; - $expected .= ' libero.'.PHP_EOL; - $expected .= '- TestStandard.Deprecated.WithoutReplacement'.PHP_EOL; - $expected .= ' This sniff has been deprecated since v3.4.0 and will be removed in v4.0.0.'.PHP_EOL; - $expected .= '- TestStandard.Deprecated.WithReplacement'.PHP_EOL; - $expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL; - $expected .= ' Use the Stnd.Category.OtherSniff sniff instead.'.PHP_EOL; - $expected .= '- TestStandard.Deprecated.WithReplacementContainingLinuxNewlines'.PHP_EOL; - $expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL; - $expected .= ' Lorem ipsum dolor sit amet, consectetur adipiscing elit.'.PHP_EOL; - $expected .= ' Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium'.PHP_EOL; - $expected .= ' sed.'.PHP_EOL; - $expected .= ' Fusce egestas congue massa semper cursus. Donec quis pretium tellus.'.PHP_EOL; - $expected .= ' In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL; - $expected .= ' eros sapien at sem.'.PHP_EOL; - $expected .= ' Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum'.PHP_EOL; - $expected .= ' lectus at egestas.'.PHP_EOL; - $expected .= '- TestStandard.Deprecated.WithReplacementContainingNewlines'.PHP_EOL; - $expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL; - $expected .= ' Lorem ipsum dolor sit amet, consectetur adipiscing elit.'.PHP_EOL; - $expected .= ' Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium'.PHP_EOL; - $expected .= ' sed.'.PHP_EOL; - $expected .= ' Fusce egestas congue massa semper cursus. Donec quis pretium tellus.'.PHP_EOL; - $expected .= ' In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL; - $expected .= ' eros sapien at sem.'.PHP_EOL; - $expected .= ' Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum'.PHP_EOL; - $expected .= ' lectus at egestas'.PHP_EOL.PHP_EOL; - $expected .= 'Deprecated sniffs are still run, but will stop working at some point in the'.PHP_EOL; - $expected .= 'future.'.PHP_EOL.PHP_EOL; - - $this->expectOutputString($expected); - - $ruleset->showSniffDeprecations(); - - }//end testDeprecatedSniffsWarning() - - - /** - * Test the report width is respected when displaying the deprecated sniffs warning. - * - * This tests the following aspects: - * 1. That the summary line uses the correct grammar when there is a single deprecated sniff. - * 2. That the separator line below the summary maximizes at the longest line length. - * 3. That the word wrapping respects the maximum report width. - * 4. That the sniff name is truncated if it is longer than the max report width. - * - * @param int $reportWidth Report width for the test. - * @param string $expectedOutput Expected output. - * - * @dataProvider dataReportWidthIsRespected - * - * @return void - */ - public function testReportWidthIsRespected($reportWidth, $expectedOutput) - { - // Set up the ruleset. - $standard = __DIR__.'/ShowSniffDeprecationsReportWidthTest.xml'; - $config = new ConfigDouble(['.', "--standard=$standard", "--report-width=$reportWidth", '--no-colors']); - $ruleset = new Ruleset($config); - - $this->expectOutputString($expectedOutput); - - $ruleset->showSniffDeprecations(); - - }//end testReportWidthIsRespected() - - - /** - * Data provider. - * - * @see testReportWidthIsRespected() - * - * @return array> - */ - public static function dataReportWidthIsRespected() - { - $summaryLine = 'WARNING: The ShowSniffDeprecationsTest standard uses 1 deprecated sniff'.PHP_EOL; - - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - return [ - 'Report width small: 40; with truncated sniff name and wrapped header and footer lines' => [ - 'reportWidth' => 40, - 'expectedOutput' => 'WARNING: The ShowSniffDeprecationsTest'.PHP_EOL - .'standard uses 1 deprecated sniff'.PHP_EOL - .'----------------------------------------'.PHP_EOL - .'- TestStandard.Deprecated.WithLongR...'.PHP_EOL - .' This sniff has been deprecated since'.PHP_EOL - .' v3.8.0 and will be removed in'.PHP_EOL - .' v4.0.0. Lorem ipsum dolor sit amet,'.PHP_EOL - .' consectetur adipiscing elit. Fusce'.PHP_EOL - .' vel vestibulum nunc. Sed luctus'.PHP_EOL - .' dolor tortor, eu euismod purus'.PHP_EOL - .' pretium sed. Fusce egestas congue'.PHP_EOL - .' massa semper cursus. Donec quis'.PHP_EOL - .' pretium tellus. In lacinia, augue ut'.PHP_EOL - .' ornare porttitor, diam nunc faucibus'.PHP_EOL - .' purus, et accumsan eros sapien at'.PHP_EOL - .' sem. Sed pulvinar aliquam malesuada.'.PHP_EOL - .' Aliquam erat volutpat. Mauris'.PHP_EOL - .' gravida rutrum lectus at egestas.'.PHP_EOL - .' Fusce tempus elit in tincidunt'.PHP_EOL - .' dictum. Suspendisse dictum egestas'.PHP_EOL - .' sapien, eget ullamcorper metus'.PHP_EOL - .' elementum semper. Vestibulum sem'.PHP_EOL - .' justo, consectetur ac tincidunt et,'.PHP_EOL - .' finibus eget libero.'.PHP_EOL.PHP_EOL - .'Deprecated sniffs are still run, but'.PHP_EOL - .'will stop working at some point in the'.PHP_EOL - .'future.'.PHP_EOL.PHP_EOL, - ], - 'Report width default: 80' => [ - 'reportWidth' => 80, - 'expectedOutput' => $summaryLine.str_repeat('-', 80).PHP_EOL - .'- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL - .' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL - .' Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel'.PHP_EOL - .' vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed.'.PHP_EOL - .' Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In'.PHP_EOL - .' lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan'.PHP_EOL - .' eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat.'.PHP_EOL - .' Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt'.PHP_EOL - .' dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum'.PHP_EOL - .' semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget'.PHP_EOL - .' libero.'.PHP_EOL.PHP_EOL - .'Deprecated sniffs are still run, but will stop working at some point in the'.PHP_EOL - .'future.'.PHP_EOL.PHP_EOL, - ], - 'Report width matches longest line: 666; the message should not wrap' => [ - // Length = 4 padding + 75 base line + 587 custom message. - 'reportWidth' => 666, - 'expectedOutput' => $summaryLine.str_repeat('-', 666).PHP_EOL - .'- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL - .' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed. Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget libero.' - .PHP_EOL.PHP_EOL - .'Deprecated sniffs are still run, but will stop working at some point in the future.'.PHP_EOL.PHP_EOL, - ], - 'Report width wide: 1000; delimiter line length should match longest line' => [ - 'reportWidth' => 1000, - 'expectedOutput' => $summaryLine.str_repeat('-', 666).PHP_EOL - .'- TestStandard.Deprecated.WithLongReplacement'.PHP_EOL - .' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Fusce vel vestibulum nunc. Sed luctus dolor tortor, eu euismod purus pretium sed. Fusce egestas congue massa semper cursus. Donec quis pretium tellus. In lacinia, augue ut ornare porttitor, diam nunc faucibus purus, et accumsan eros sapien at sem. Sed pulvinar aliquam malesuada. Aliquam erat volutpat. Mauris gravida rutrum lectus at egestas. Fusce tempus elit in tincidunt dictum. Suspendisse dictum egestas sapien, eget ullamcorper metus elementum semper. Vestibulum sem justo, consectetur ac tincidunt et, finibus eget libero.' - .PHP_EOL.PHP_EOL - .'Deprecated sniffs are still run, but will stop working at some point in the future.'.PHP_EOL.PHP_EOL, - ], - ]; - // phpcs:enable - - }//end dataReportWidthIsRespected() - - - /** - * Test deprecated sniffs are listed alphabetically in the deprecated sniffs warning. - * - * Additionally, this test verifies that deprecated sniffs are still registered to run. - * - * @return void - */ - public function testDeprecatedSniffsAreListedAlphabetically() - { - // Set up the ruleset. - $standard = __DIR__.'/ShowSniffDeprecationsOrderTest.xml'; - $config = new ConfigDouble(["--standard=$standard", '--no-colors']); - $ruleset = new Ruleset($config); - - $expected = 'WARNING: The ShowSniffDeprecationsTest standard uses 2 deprecated sniffs'.PHP_EOL; - $expected .= '--------------------------------------------------------------------------------'.PHP_EOL; - $expected .= '- TestStandard.Deprecated.WithoutReplacement'.PHP_EOL; - $expected .= ' This sniff has been deprecated since v3.4.0 and will be removed in v4.0.0.'.PHP_EOL; - $expected .= '- TestStandard.Deprecated.WithReplacement'.PHP_EOL; - $expected .= ' This sniff has been deprecated since v3.8.0 and will be removed in v4.0.0.'.PHP_EOL; - $expected .= ' Use the Stnd.Category.OtherSniff sniff instead.'.PHP_EOL.PHP_EOL; - $expected .= 'Deprecated sniffs are still run, but will stop working at some point in the'.PHP_EOL; - $expected .= 'future.'.PHP_EOL.PHP_EOL; - - $this->expectOutputString($expected); - - $ruleset->showSniffDeprecations(); - - // Verify that the sniffs have been registered to run. - $this->assertCount(2, $ruleset->sniffCodes, 'Incorrect number of sniff codes registered'); - $this->assertArrayHasKey( - 'TestStandard.Deprecated.WithoutReplacement', - $ruleset->sniffCodes, - 'WithoutReplacement sniff not registered' - ); - $this->assertArrayHasKey( - 'TestStandard.Deprecated.WithReplacement', - $ruleset->sniffCodes, - 'WithReplacement sniff not registered' - ); - - }//end testDeprecatedSniffsAreListedAlphabetically() - - - /** - * Test that an exception is thrown when any of the interface required methods does not - * comply with the return type/value requirements. - * - * @param string $standard The standard to use for the test. - * @param string $exceptionMessage The contents of the expected exception message. - * - * @dataProvider dataExceptionIsThrownOnIncorrectlyImplementedInterface - * - * @return void - */ - public function testExceptionIsThrownOnIncorrectlyImplementedInterface($standard, $exceptionMessage) - { - $this->expectRuntimeExceptionMessage($exceptionMessage); - - // Set up the ruleset. - $standard = __DIR__.'/'.$standard; - $config = new ConfigDouble(["--standard=$standard"]); - $ruleset = new Ruleset($config); - - $ruleset->showSniffDeprecations(); - - }//end testExceptionIsThrownOnIncorrectlyImplementedInterface() - - - /** - * Data provider. - * - * @see testExceptionIsThrownOnIncorrectlyImplementedInterface() - * - * @return array> - */ - public static function dataExceptionIsThrownOnIncorrectlyImplementedInterface() - { - return [ - 'getDeprecationVersion() does not return a string' => [ - 'standard' => 'ShowSniffDeprecationsInvalidDeprecationVersionTest.xml', - 'exceptionMessage' => 'ERROR: The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\InvalidDeprecationVersionSniff::getDeprecationVersion() method must return a non-empty string, received double', - ], - 'getRemovalVersion() does not return a string' => [ - 'standard' => 'ShowSniffDeprecationsInvalidRemovalVersionTest.xml', - 'exceptionMessage' => 'ERROR: The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\InvalidRemovalVersionSniff::getRemovalVersion() method must return a non-empty string, received array', - ], - 'getDeprecationMessage() does not return a string' => [ - 'standard' => 'ShowSniffDeprecationsInvalidDeprecationMessageTest.xml', - 'exceptionMessage' => 'ERROR: The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\InvalidDeprecationMessageSniff::getDeprecationMessage() method must return a string, received object', - ], - 'getDeprecationVersion() returns an empty string' => [ - 'standard' => 'ShowSniffDeprecationsEmptyDeprecationVersionTest.xml', - 'exceptionMessage' => 'ERROR: The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\EmptyDeprecationVersionSniff::getDeprecationVersion() method must return a non-empty string, received ""', - ], - 'getRemovalVersion() returns an empty string' => [ - 'standard' => 'ShowSniffDeprecationsEmptyRemovalVersionTest.xml', - 'exceptionMessage' => 'ERROR: The Fixtures\TestStandard\Sniffs\DeprecatedInvalid\EmptyRemovalVersionSniff::getRemovalVersion() method must return a non-empty string, received ""', - ], - ]; - - }//end dataExceptionIsThrownOnIncorrectlyImplementedInterface() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsTest.xml b/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsTest.xml deleted file mode 100644 index 91bef9684..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Ruleset/ShowSniffDeprecationsTest.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/AbstractRunnerTestCase.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/AbstractRunnerTestCase.php deleted file mode 100644 index ae5905bc6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/AbstractRunnerTestCase.php +++ /dev/null @@ -1,19 +0,0 @@ -markTestSkipped('This test needs CS mode to run'); - } - - $this->checkProgressDot($colors, $code, $sniffs, $expected); - - }//end testProgressDotCs() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataProgressDotCs() - { - return [ - 'No colors: Dot: no errors, no warnings' => [ - 'colors' => false, - 'code' => ' 'Generic.PHP.LowerCaseConstant', - 'expected' => '.', - ], - 'No colors: E: has error' => [ - 'colors' => false, - 'code' => ' 'Generic.CodeAnalysis.RequireExplicitBooleanOperatorPrecedence', - 'expected' => 'E', - ], - 'No colors: W: has warning' => [ - 'colors' => false, - 'code' => ' 'Generic.Commenting.Todo', - 'expected' => 'W', - ], - - 'Colors: Dot: no errors, no warnings' => [ - 'colors' => true, - 'code' => ' 'Generic.PHP.LowerCaseConstant', - 'expected' => '.', - ], - 'Colors: E: has error (red)' => [ - 'colors' => true, - 'code' => ' 'Generic.CodeAnalysis.RequireExplicitBooleanOperatorPrecedence', - 'expected' => "\033[31m".'E'."\033[0m", - ], - 'Colors: E: has fixable error (green)' => [ - 'colors' => true, - 'code' => ' 'Generic.Arrays.DisallowLongArraySyntax', - 'expected' => "\033[32m".'E'."\033[0m", - ], - 'Colors: W: has warning (yellow)' => [ - 'colors' => true, - 'code' => ' 'Generic.Commenting.Todo', - 'expected' => "\033[33m".'W'."\033[0m", - ], - 'Colors: W: has fixable warning (green)' => [ - 'colors' => true, - 'code' => ' 'Generic.CodeAnalysis.EmptyPHPStatement', - 'expected' => "\033[32m".'W'."\033[0m", - ], - ]; - - }//end dataProgressDotCs() - - - /** - * Verify the correct progress indicator is used for a file in CBF mode. - * - * @param bool $colors Whether to enable colors or not. - * @param string $code Code snippet to process. - * @param string $sniffs Comma-separated list of sniff(s) to run against the code snippet. - * @param string $expected Expected output of the progress printer. - * - * @dataProvider dataProgressDotCbf - * - * @group CBF - * - * @return void - */ - public function testProgressDotCbf($colors, $code, $sniffs, $expected) - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $this->checkProgressDot($colors, $code, $sniffs, $expected, true); - - }//end testProgressDotCbf() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataProgressDotCbf() - { - return [ - 'No colors: Dot: no errors, no warnings' => [ - 'colors' => false, - 'code' => ' 'Generic.PHP.LowerCaseConstant', - 'expected' => '.', - ], - 'No colors: F: fixes made' => [ - 'colors' => false, - 'code' => ' 'Generic.Arrays.DisallowLongArraySyntax', - 'expected' => 'F', - ], - 'No colors: E: has fixer conflict' => [ - 'colors' => false, - 'code' => ' 'Generic.Arrays.DisallowLongArraySyntax,Generic.Arrays.DisallowShortArraySyntax', - 'expected' => 'E', - ], - - 'Colors: Dot: no errors, no warnings (no color)' => [ - 'colors' => true, - 'code' => ' 'Generic.PHP.LowerCaseConstant', - 'expected' => '.', - ], - 'Colors: F: fixes made (green)' => [ - 'colors' => true, - 'code' => ' 'Generic.Arrays.DisallowLongArraySyntax', - 'expected' => "\033[32m".'F'."\033[0m", - ], - 'Colors: E: has fixer conflict (red)' => [ - 'colors' => true, - 'code' => ' 'Generic.Arrays.DisallowLongArraySyntax,Generic.Arrays.DisallowShortArraySyntax', - 'expected' => "\033[31m".'E'."\033[0m", - ], - ]; - - }//end dataProgressDotCbf() - - - /** - * Verify the correct progress indicator is used for a file in CBF mode. - * - * @param bool $colors Whether to enable colors or not. - * @param string $code Code snippet to process. - * @param string $sniffs Comma-separated list of sniff(s) to run against the code snippet. - * @param string $expected Expected output of the progress printer. - * @param bool $enableFixer Whether to fix the code or not. - * - * @return void - */ - private function checkProgressDot($colors, $code, $sniffs, $expected, $enableFixer=false) - { - $this->expectOutputString($expected); - - $config = new ConfigDouble(['-p']); - $config->colors = $colors; - $config->standards = ['Generic']; - $config->sniffs = explode(',', $sniffs); - $ruleset = new Ruleset($config); - - $runner = new Runner(); - $runner->config = $config; - - $file = new DummyFile($code, $ruleset, $config); - $file->process(); - - if ($enableFixer === true) { - $file->fixer->fixFile(); - } - - $runner->printProgress($file, 2, 1); - - }//end checkProgressDot() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/PrintProgressTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/PrintProgressTest.php deleted file mode 100644 index 93535417e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/PrintProgressTest.php +++ /dev/null @@ -1,235 +0,0 @@ -standards = ['Generic']; - self::$config->sniffs = ['Generic.PHP.LowerCaseConstant']; - self::$ruleset = new Ruleset(self::$config); - - self::$runner = new Runner(); - self::$runner->config = self::$config; - - // Simple file which won't have any errors against the above sniff. - $content = 'process(); - - }//end initializeConfigRulesetRunner() - - - /** - * Reset some flags between tests. - * - * @after - * - * @return void - */ - protected function resetObjectFlags() - { - self::$config->showProgress = true; - self::$fileWithoutErrorsOrWarnings->ignored = false; - - }//end resetObjectFlags() - - - /** - * Destroy the Config object after the test to reset statics. - * - * @afterClass - * - * @return void - */ - public static function reset() - { - // Explicitly trigger __destruct() on the ConfigDouble to reset the Config statics. - // The explicit method call prevents potential stray test-local references to the $config object - // preventing the destructor from running the clean up (which without stray references would be - // automagically triggered when this object is destroyed, but we can't definitively rely on that). - self::$config->__destruct(); - - }//end reset() - - - /** - * Verify that if progress reporting is disabled, no progress dots will show. - * - * @return void - */ - public function testNoProgressIsShownWhenDisabled() - { - $this->expectOutputString(''); - - self::$config->showProgress = false; - - for ($i = 1; $i <= 10; $i++) { - self::$runner->printProgress(self::$fileWithoutErrorsOrWarnings, 3, $i); - } - - }//end testNoProgressIsShownWhenDisabled() - - - /** - * Verify ignored files will be marked with an "S" for "skipped". - * - * @return void - */ - public function testProgressDotSkippedFiles() - { - $nrOfFiles = 10; - $this->expectOutputString('.S.S.S.S.S 10 / 10 (100%)'.PHP_EOL); - - for ($i = 1; $i <= $nrOfFiles; $i++) { - if (($i % 2) === 0) { - self::$fileWithoutErrorsOrWarnings->ignored = true; - } else { - self::$fileWithoutErrorsOrWarnings->ignored = false; - } - - self::$runner->printProgress(self::$fileWithoutErrorsOrWarnings, $nrOfFiles, $i); - } - - }//end testProgressDotSkippedFiles() - - - /** - * Verify the handling of the summary at the end of each line. - * - * @param int $nrOfFiles The number of files in the scan. - * @param string $expected The expected progress information output. - * - * @dataProvider dataEndOfLineSummary - * - * @return void - */ - public function testEndOfLineSummary($nrOfFiles, $expected) - { - $this->expectOutputString($expected); - - for ($i = 1; $i <= $nrOfFiles; $i++) { - self::$runner->printProgress(self::$fileWithoutErrorsOrWarnings, $nrOfFiles, $i); - } - - }//end testEndOfLineSummary() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataEndOfLineSummary() - { - $fullLineOfDots = str_repeat('.', 60); - - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Favour test readability. - return [ - 'Less than 60 files (23)' => [ - 'nrOfFiles' => 23, - 'expected' => str_repeat('.', 23).' 23 / 23 (100%)'.PHP_EOL, - ], - 'Exactly 60 files' => [ - 'nrOfFiles' => 60, - 'expected' => $fullLineOfDots.' 60 / 60 (100%)'.PHP_EOL, - ], - 'Between 60 and 120 files (71)' => [ - 'nrOfFiles' => 71, - 'expected' => $fullLineOfDots.' 60 / 71 (85%)'.PHP_EOL - .str_repeat('.', 11).str_repeat(' ', 49).' 71 / 71 (100%)'.PHP_EOL, - ], - 'More than 120 files (162)' => [ - 'nrOfFiles' => 162, - 'expected' => $fullLineOfDots.' 60 / 162 (37%)'.PHP_EOL - .$fullLineOfDots.' 120 / 162 (74%)'.PHP_EOL - .str_repeat('.', 42).str_repeat(' ', 18).' 162 / 162 (100%)'.PHP_EOL, - ], - // More than anything, this tests that the padding of the numbers is handled correctly. - 'More than 1000 files (1234)' => [ - 'nrOfFiles' => 1234, - 'expected' => $fullLineOfDots.' 60 / 1234 (5%)'.PHP_EOL - .$fullLineOfDots.' 120 / 1234 (10%)'.PHP_EOL - .$fullLineOfDots.' 180 / 1234 (15%)'.PHP_EOL - .$fullLineOfDots.' 240 / 1234 (19%)'.PHP_EOL - .$fullLineOfDots.' 300 / 1234 (24%)'.PHP_EOL - .$fullLineOfDots.' 360 / 1234 (29%)'.PHP_EOL - .$fullLineOfDots.' 420 / 1234 (34%)'.PHP_EOL - .$fullLineOfDots.' 480 / 1234 (39%)'.PHP_EOL - .$fullLineOfDots.' 540 / 1234 (44%)'.PHP_EOL - .$fullLineOfDots.' 600 / 1234 (49%)'.PHP_EOL - .$fullLineOfDots.' 660 / 1234 (53%)'.PHP_EOL - .$fullLineOfDots.' 720 / 1234 (58%)'.PHP_EOL - .$fullLineOfDots.' 780 / 1234 (63%)'.PHP_EOL - .$fullLineOfDots.' 840 / 1234 (68%)'.PHP_EOL - .$fullLineOfDots.' 900 / 1234 (73%)'.PHP_EOL - .$fullLineOfDots.' 960 / 1234 (78%)'.PHP_EOL - .$fullLineOfDots.' 1020 / 1234 (83%)'.PHP_EOL - .$fullLineOfDots.' 1080 / 1234 (88%)'.PHP_EOL - .$fullLineOfDots.' 1140 / 1234 (92%)'.PHP_EOL - .$fullLineOfDots.' 1200 / 1234 (97%)'.PHP_EOL - .str_repeat('.', 34).str_repeat(' ', 26).' 1234 / 1234 (100%)'.PHP_EOL, - ], - ]; - // phpcs:enable - - }//end dataEndOfLineSummary() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/RunPHPCSExplainTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/RunPHPCSExplainTest.php deleted file mode 100644 index 479fe5ce9..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/RunPHPCSExplainTest.php +++ /dev/null @@ -1,73 +0,0 @@ - - * @copyright 2023 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Runner; - -use PHP_CodeSniffer\Runner; -use PHP_CodeSniffer\Tests\Core\Runner\AbstractRunnerTestCase; - -/** - * Tests the wiring in of the explain functionality in the Runner class. - * - * @covers \PHP_CodeSniffer\Runner::runPHPCS - */ -final class RunPHPCSExplainTest extends AbstractRunnerTestCase -{ - - - /** - * Test that each standard passed on the command-line is explained separately. - * - * @return void - */ - public function testExplainWillExplainEachStandardSeparately() - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $standard = dirname(__DIR__).'/Ruleset/ExplainSingleSniffTest.xml'; - $_SERVER['argv'] = [ - 'phpcs', - '-e', - "--standard=PSR1,$standard", - '--report-width=80', - ]; - - $expected = PHP_EOL; - $expected .= 'The PSR1 standard contains 8 sniffs'.PHP_EOL.PHP_EOL; - $expected .= 'Generic (4 sniffs)'.PHP_EOL; - $expected .= '------------------'.PHP_EOL; - $expected .= ' Generic.Files.ByteOrderMark'.PHP_EOL; - $expected .= ' Generic.NamingConventions.UpperCaseConstantName'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowAlternativePHPTags'.PHP_EOL; - $expected .= ' Generic.PHP.DisallowShortOpenTag'.PHP_EOL.PHP_EOL; - $expected .= 'PSR1 (3 sniffs)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' PSR1.Classes.ClassDeclaration'.PHP_EOL; - $expected .= ' PSR1.Files.SideEffects'.PHP_EOL; - $expected .= ' PSR1.Methods.CamelCapsMethodName'.PHP_EOL.PHP_EOL; - $expected .= 'Squiz (1 sniff)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' Squiz.Classes.ValidClassName'.PHP_EOL.PHP_EOL; - - $expected .= 'The ExplainSingleSniffTest standard contains 1 sniff'.PHP_EOL.PHP_EOL; - $expected .= 'Squiz (1 sniff)'.PHP_EOL; - $expected .= '---------------'.PHP_EOL; - $expected .= ' Squiz.Scope.MethodScope'.PHP_EOL; - - $this->expectOutputString($expected); - - $runner = new Runner(); - $runner->runPHPCS(); - - }//end testExplainWillExplainEachStandardSeparately() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/RunPHPCSGeneratorTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/RunPHPCSGeneratorTest.php deleted file mode 100644 index 0bc89f220..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Runner/RunPHPCSGeneratorTest.php +++ /dev/null @@ -1,72 +0,0 @@ -markTestSkipped('This test needs CS mode to run'); - } - - $standard = dirname(__DIR__).'/Generators/OneDocTest.xml'; - $_SERVER['argv'] = [ - 'phpcs', - '--generator=Text', - "--standard=$standard,PSR1", - '--report-width=80', - ]; - - $regex = '`^ - \R* # Optional blank line at the start. - (?: - (?P-++\R) # Line with dashes. - \|[ ]GENERATORTEST[ ]CODING[ ]STANDARD:[ ][^\|]+\|\R # Doc title line with prefix expected for first standard. - (?P>delimiter) # Line with dashes. - \R(?:[^\r\n]+\R)+\R{2} # Standard description. - ) # Only expect this group once. - (?: - (?P>delimiter) # Line with dashes. - \|[ ]PSR1[ ]CODING[ ]STANDARD:[ ][^\|]+\|\R # Doc title line with prefix expected for second standard. - (?P>delimiter) # Line with dashes. - \R(?:[^\r\n]+\R)+\R # Standard description. - (?: - -+[ ]CODE[ ]COMPARISON[ ]-+\R # Code Comparison starter line with dashes. - (?:(?:[^\r\n]+\R)+(?P>delimiter)){2} # Arbitrary text followed by a delimiter line. - )* # Code comparison is optional and can exist multiple times. - \R+ - ){3,} # This complete group should occur at least three times. - `x'; - - $this->expectOutputRegex($regex); - - $runner = new Runner(); - $runner->runPHPCS(); - - }//end testGeneratorWillShowEachStandardSeparately() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTest.inc deleted file mode 100644 index 488229589..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTest.inc +++ /dev/null @@ -1,51 +0,0 @@ -1,'2'=>2,'3'=>3]; - -/* testMissingKeys */ -$foo = ['1'=>1,2,'3'=>3]; - -/* testMultiTokenKeys */ -$paths = array( - Init::ROOT_DIR.'/a' => 'a', - Init::ROOT_DIR.'/b' => 'b', -); - -/* testMissingKeysCoalesceTernary */ -return [ - $a => static function () { return [1,2,3]; }, - $b ?? $c, - $d ? [$e] : [$f], -]; - -/* testTernaryValues */ -$foo = [ - '1' => $row['status'] === 'rejected' - ? self::REJECTED_CODE - : self::VERIFIED_CODE, - '2' => in_array($row['status'], array('notverified', 'unverified'), true) - ? self::STATUS_PENDING - : self::STATUS_VERIFIED, - '3' => strtotime($row['date']), -]; - -/* testHeredocValues */ -$foo = array( - << '1', - 2 => fn ($x) => yield 'a' => $x, - 3 => '3', -); diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTest.php deleted file mode 100644 index 993603a53..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTest.php +++ /dev/null @@ -1,297 +0,0 @@ - - * @copyright 2006-2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Sniffs; - -use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest; - -/** - * Tests for the \PHP_CodeSniffer\Sniffs\AbstractArraySniff. - * - * @covers \PHP_CodeSniffer\Sniffs\AbstractArraySniff - */ -final class AbstractArraySniffTest extends AbstractMethodUnitTest -{ - - /** - * The sniff objects we are testing. - * - * This extends the \PHP_CodeSniffer\Sniffs\AbstractArraySniff class to make the - * internal workings of the sniff observable. - * - * @var \PHP_CodeSniffer\Tests\Core\Sniffs\AbstractArraySniffTestable - */ - protected static $sniff; - - - /** - * Initialize & tokenize \PHP_CodeSniffer\Files\File with code from the test case file. - * - * The test case file for a unit test class has to be in the same directory - * directory and use the same file name as the test class, using the .inc extension. - * - * @beforeClass - * - * @return void - */ - public static function initializeFile() - { - self::$sniff = new AbstractArraySniffTestable(); - parent::initializeFile(); - - }//end initializeFile() - - - /** - * Test an array of simple values only. - * - * @return void - */ - public function testSimpleValues() - { - $token = $this->getTargetToken('/* testSimpleValues */', T_OPEN_SHORT_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => ['value_start' => ($token + 1)], - 1 => ['value_start' => ($token + 3)], - 2 => ['value_start' => ($token + 5)], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testSimpleValues() - - - /** - * Test an array of simple keys and values. - * - * @return void - */ - public function testSimpleKeyValues() - { - $token = $this->getTargetToken('/* testSimpleKeyValues */', T_OPEN_SHORT_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => [ - 'index_start' => ($token + 1), - 'index_end' => ($token + 1), - 'arrow' => ($token + 2), - 'value_start' => ($token + 3), - ], - 1 => [ - 'index_start' => ($token + 5), - 'index_end' => ($token + 5), - 'arrow' => ($token + 6), - 'value_start' => ($token + 7), - ], - 2 => [ - 'index_start' => ($token + 9), - 'index_end' => ($token + 9), - 'arrow' => ($token + 10), - 'value_start' => ($token + 11), - ], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testSimpleKeyValues() - - - /** - * Test an array of simple keys and values. - * - * @return void - */ - public function testMissingKeys() - { - $token = $this->getTargetToken('/* testMissingKeys */', T_OPEN_SHORT_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => [ - 'index_start' => ($token + 1), - 'index_end' => ($token + 1), - 'arrow' => ($token + 2), - 'value_start' => ($token + 3), - ], - 1 => [ - 'value_start' => ($token + 5), - ], - 2 => [ - 'index_start' => ($token + 7), - 'index_end' => ($token + 7), - 'arrow' => ($token + 8), - 'value_start' => ($token + 9), - ], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testMissingKeys() - - - /** - * Test an array with keys that span multiple tokens. - * - * @return void - */ - public function testMultiTokenKeys() - { - $token = $this->getTargetToken('/* testMultiTokenKeys */', T_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => [ - 'index_start' => ($token + 4), - 'index_end' => ($token + 8), - 'arrow' => ($token + 10), - 'value_start' => ($token + 12), - ], - 1 => [ - 'index_start' => ($token + 16), - 'index_end' => ($token + 20), - 'arrow' => ($token + 22), - 'value_start' => ($token + 24), - ], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testMultiTokenKeys() - - - /** - * Test an array of simple keys and values. - * - * @return void - */ - public function testMissingKeysCoalesceTernary() - { - $token = $this->getTargetToken('/* testMissingKeysCoalesceTernary */', T_OPEN_SHORT_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => [ - 'index_start' => ($token + 3), - 'index_end' => ($token + 3), - 'arrow' => ($token + 5), - 'value_start' => ($token + 7), - ], - 1 => [ - 'value_start' => ($token + 31), - ], - 2 => [ - 'value_start' => ($token + 39), - ], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testMissingKeysCoalesceTernary() - - - /** - * Test an array of ternary values. - * - * @return void - */ - public function testTernaryValues() - { - $token = $this->getTargetToken('/* testTernaryValues */', T_OPEN_SHORT_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => [ - 'index_start' => ($token + 3), - 'index_end' => ($token + 3), - 'arrow' => ($token + 5), - 'value_start' => ($token + 7), - ], - 1 => [ - 'index_start' => ($token + 32), - 'index_end' => ($token + 32), - 'arrow' => ($token + 34), - 'value_start' => ($token + 36), - ], - 2 => [ - 'index_start' => ($token + 72), - 'index_end' => ($token + 72), - 'arrow' => ($token + 74), - 'value_start' => ($token + 76), - ], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testTernaryValues() - - - /** - * Test an array of heredocs. - * - * @return void - */ - public function testHeredocValues() - { - $token = $this->getTargetToken('/* testHeredocValues */', T_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => [ - 'value_start' => ($token + 4), - ], - 1 => [ - 'value_start' => ($token + 10), - ], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testHeredocValues() - - - /** - * Test an array of with an arrow function as a value. - * - * @return void - */ - public function testArrowFunctionValue() - { - $token = $this->getTargetToken('/* testArrowFunctionValue */', T_ARRAY); - self::$sniff->process(self::$phpcsFile, $token); - - $expected = [ - 0 => [ - 'index_start' => ($token + 4), - 'index_end' => ($token + 4), - 'arrow' => ($token + 6), - 'value_start' => ($token + 8), - ], - 1 => [ - 'index_start' => ($token + 12), - 'index_end' => ($token + 12), - 'arrow' => ($token + 14), - 'value_start' => ($token + 16), - ], - 2 => [ - 'index_start' => ($token + 34), - 'index_end' => ($token + 34), - 'arrow' => ($token + 36), - 'value_start' => ($token + 38), - ], - ]; - - $this->assertSame($expected, self::$sniff->indicies); - - }//end testArrowFunctionValue() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTestable.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTestable.php deleted file mode 100644 index 751b01a8b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Sniffs/AbstractArraySniffTestable.php +++ /dev/null @@ -1,65 +0,0 @@ - - * @copyright 2006-2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Sniffs; - -use PHP_CodeSniffer\Sniffs\AbstractArraySniff; - -class AbstractArraySniffTestable extends AbstractArraySniff -{ - - /** - * The array indicies that were found during processing. - * - * @var array - */ - public $indicies = []; - - - /** - * Processes a single-line array definition. - * - * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being checked. - * @param int $stackPtr The position of the current token - * in the stack passed in $tokens. - * @param int $arrayStart The token that starts the array definition. - * @param int $arrayEnd The token that ends the array definition. - * @param array $indices An array of token positions for the array keys, - * double arrows, and values. - * - * @return void - */ - public function processSingleLineArray($phpcsFile, $stackPtr, $arrayStart, $arrayEnd, $indices) - { - $this->indicies = $indices; - - }//end processSingleLineArray() - - - /** - * Processes a multi-line array definition. - * - * @param \PHP_CodeSniffer\Files\File $phpcsFile The current file being checked. - * @param int $stackPtr The position of the current token - * in the stack passed in $tokens. - * @param int $arrayStart The token that starts the array definition. - * @param int $arrayEnd The token that ends the array definition. - * @param array $indices An array of token positions for the array keys, - * double arrows, and values. - * - * @return void - */ - public function processMultiLineArray($phpcsFile, $stackPtr, $arrayStart, $arrayEnd, $indices) - { - $this->indicies = $indices; - - }//end processMultiLineArray() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Standards/StandardRulesetsQATest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Standards/StandardRulesetsQATest.php deleted file mode 100644 index baba45743..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Standards/StandardRulesetsQATest.php +++ /dev/null @@ -1,82 +0,0 @@ -assertSame('', $seenOutput); - - // Make sure sniffs were registered. - $this->assertGreaterThanOrEqual(1, count($ruleset->sniffCodes)); - - }//end testBuildInStandardsDoNotContainErrors() - - - /** - * Data provider. - * - * @see self::testBuildInStandardsDoNotContainErrors() - * - * @return array> - */ - public static function dataBuildInStandards() - { - // Get a list of all build-in, PHPCS native standards. - $sep = DIRECTORY_SEPARATOR; - $targetDir = dirname(dirname(dirname(__DIR__))).$sep.'src'.$sep.'Standards'.$sep; - $rulesetFiles = glob($targetDir.'*'.$sep.'ruleset.xml'); - - $data = []; - foreach ($rulesetFiles as $file) { - $standardName = basename(dirname($file)); - $data[$standardName] = [ - 'standard' => $standardName, - ]; - } - - return $data; - - }//end dataBuildInStandards() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/AbstractTokenizerTestCase.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/AbstractTokenizerTestCase.php deleted file mode 100644 index aee3aa602..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/AbstractTokenizerTestCase.php +++ /dev/null @@ -1,147 +0,0 @@ - - * @copyright 2018-2019 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers; - -use PHP_CodeSniffer\Files\DummyFile; -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Tests\Core\AbstractMethodUnitTest; -use PHPUnit\Framework\TestCase; -use ReflectionProperty; - -abstract class AbstractTokenizerTestCase extends TestCase -{ - - /** - * The file extension of the test case file (without leading dot). - * - * This allows child classes to overrule the default `inc` with, for instance, - * `js` or `css` when applicable. - * - * @var string - */ - protected $fileExtension = 'inc'; - - /** - * The tab width setting to use when tokenizing the file. - * - * This allows for test case files to use a different tab width than the default. - * - * @var integer - */ - protected $tabWidth = 4; - - /** - * The \PHP_CodeSniffer\Files\File object containing the parsed contents of the test case file. - * - * @var \PHP_CodeSniffer\Files\File - */ - protected $phpcsFile; - - - /** - * Initialize & tokenize \PHP_CodeSniffer\Files\File with code from the test case file. - * - * The test case file for a unit test class has to be in the same directory - * directory and use the same file name as the test class, using the .inc extension. - * - * @before - * - * @return void - */ - protected function initializeFile() - { - if (isset($this->phpcsFile) === false) { - $_SERVER['argv'] = []; - $config = new ConfigDouble(); - - // Also set a tab-width to enable testing tab-replaced vs `orig_content`. - $config->tabWidth = $this->tabWidth; - - $ruleset = new Ruleset($config); - - // Default to a file with the same name as the test class. Extension is property based. - $relativeCN = str_replace(__NAMESPACE__, '', get_called_class()); - $relativePath = str_replace('\\', DIRECTORY_SEPARATOR, $relativeCN); - $pathToTestFile = realpath(__DIR__).$relativePath.'.'.$this->fileExtension; - - // Make sure the file gets parsed correctly based on the file type. - $contents = 'phpcs_input_file: '.$pathToTestFile.PHP_EOL; - $contents .= file_get_contents($pathToTestFile); - - $this->phpcsFile = new DummyFile($contents, $ruleset, $config); - $this->phpcsFile->parse(); - }//end if - - }//end initializeFile() - - - /** - * Test QA: verify that a test case file does not contain any duplicate test markers. - * - * When a test case file contains a lot of test cases, it is easy to overlook that a test marker name - * is already in use. - * A test wouldn't necessarily fail on this, but would not be testing what is intended to be tested as - * it would be verifying token properties for the wrong token. - * - * This test safeguards against this. - * - * @coversNothing - * - * @return void - */ - public function testTestMarkersAreUnique() - { - AbstractMethodUnitTest::assertTestMarkersAreUnique($this->phpcsFile); - - }//end testTestMarkersAreUnique() - - - /** - * Get the token pointer for a target token based on a specific comment found on the line before. - * - * Note: the test delimiter comment MUST start with "/* test" to allow this function to - * distinguish between comments used *in* a test and test delimiters. - * - * @param string $commentString The delimiter comment to look for. - * @param int|string|array $tokenType The type of token(s) to look for. - * @param string $tokenContent Optional. The token content for the target token. - * - * @return int - */ - protected function getTargetToken($commentString, $tokenType, $tokenContent=null) - { - return AbstractMethodUnitTest::getTargetTokenFromFile($this->phpcsFile, $commentString, $tokenType, $tokenContent); - - }//end getTargetToken() - - - /** - * Clear the static "resolved tokens" cache property on the Tokenizer\PHP class. - * - * This method should be used selectively by tests to ensure the code under test is actually hit - * by the test testing the code. - * - * @return void - */ - public static function clearResolvedTokensCache() - { - $property = new ReflectionProperty('PHP_CodeSniffer\Tokenizers\PHP', 'resolveTokenCache'); - (PHP_VERSION_ID < 80100) && $property->setAccessible(true); - $property->setValue(null, []); - (PHP_VERSION_ID < 80100) && $property->setAccessible(false); - - }//end clearResolvedTokensCache() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/CommentTestCase.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/CommentTestCase.php deleted file mode 100644 index 625029db1..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/CommentTestCase.php +++ /dev/null @@ -1,117 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -/** - * Base class for testing DocBlock comment tokenization. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -abstract class CommentTestCase extends AbstractTokenizerTestCase -{ - - - /** - * Test whether the docblock opener and closer have the expected extra keys. - * - * @param string $marker The comment prefacing the target token. - * @param int $closerOffset The offset of the closer from the opener. - * @param array $expectedTags The expected tags offsets array. - * - * @dataProvider dataDocblockOpenerCloser - * - * @return void - */ - public function testDocblockOpenerCloser($marker, $closerOffset, $expectedTags) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($marker, [T_DOC_COMMENT_OPEN_TAG]); - - $opener = $tokens[$target]; - - $this->assertArrayHasKey('comment_closer', $opener, 'Comment opener: comment_closer index is not set'); - $this->assertArrayHasKey('comment_tags', $opener, 'Comment opener: comment_tags index is not set'); - - $expectedCloser = ($target + $closerOffset); - $this->assertSame($expectedCloser, $opener['comment_closer'], 'Comment opener: comment_closer not set to the expected stack pointer'); - - // Update the tags expectations. - foreach ($expectedTags as $i => $ptr) { - $expectedTags[$i] += $target; - } - - $this->assertSame($expectedTags, $opener['comment_tags'], 'Comment opener: recorded tags do not match expected tags'); - - $closer = $tokens[$opener['comment_closer']]; - - $this->assertArrayHasKey('comment_opener', $closer, 'Comment closer: comment_opener index is not set'); - $this->assertSame($target, $closer['comment_opener'], 'Comment closer: comment_opener not set to the expected stack pointer'); - - }//end testDocblockOpenerCloser() - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - abstract public static function dataDocblockOpenerCloser(); - - - /** - * Test helper. Check a token sequence complies with an expected token sequence. - * - * @param int $startPtr The position in the file to start checking from. - * @param array> $expectedSequence The consecutive token constants and their contents to expect. - * - * @return void - */ - protected function checkTokenSequence($startPtr, array $expectedSequence) - { - $tokens = $this->phpcsFile->getTokens(); - - $sequenceKey = 0; - $sequenceCount = count($expectedSequence); - - for ($i = $startPtr; $sequenceKey < $sequenceCount; $i++, $sequenceKey++) { - $currentItem = $expectedSequence[$sequenceKey]; - $expectedCode = key($currentItem); - $expectedType = Tokens::tokenName($expectedCode); - $expectedContent = current($currentItem); - $errorMsgSuffix = PHP_EOL.'(StackPtr: '.$i.' | Position in sequence: '.$sequenceKey.' | Expected: '.$expectedType.')'; - - $this->assertSame( - $expectedCode, - $tokens[$i]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$i]['code']).', not '.$expectedType.' (code)'.$errorMsgSuffix - ); - - $this->assertSame( - $expectedType, - $tokens[$i]['type'], - 'Token tokenized as '.$tokens[$i]['type'].', not '.$expectedType.' (type)'.$errorMsgSuffix - ); - - $this->assertSame( - $expectedContent, - $tokens[$i]['content'], - 'Token content did not match expectations'.$errorMsgSuffix - ); - }//end for - - }//end checkTokenSequence() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding1Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding1Test.inc deleted file mode 100644 index a43c7d9b2..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding1Test.inc +++ /dev/null @@ -1,6 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -/** - * Tests that unclosed docblocks during live coding are handled correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -final class LiveCoding1Test extends CommentTestCase -{ - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - public static function dataDocblockOpenerCloser() - { - return [ - 'live coding: unclosed docblock, no blank line at end of file' => [ - 'marker' => '/* testLiveCoding */', - 'closerOffset' => 8, - 'expectedTags' => [], - ], - ]; - - }//end dataDocblockOpenerCloser() - - - /** - * Verify tokenization of the DocBlock. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testLiveCoding() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Unclosed docblock, live coding.... with no blank line at end of file.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testLiveCoding() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding2Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding2Test.inc deleted file mode 100644 index b113645b5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding2Test.inc +++ /dev/null @@ -1,5 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -/** - * Tests that unclosed docblocks during live coding are handled correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -final class LiveCoding2Test extends CommentTestCase -{ - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - public static function dataDocblockOpenerCloser() - { - return [ - 'live coding: unclosed docblock with blank line at end of file' => [ - 'marker' => '/* testLiveCoding */', - 'closerOffset' => 7, - 'expectedTags' => [], - ], - ]; - - }//end dataDocblockOpenerCloser() - - - /** - * Verify tokenization of the DocBlock. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testLiveCoding() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Unclosed docblock, live coding.... with a blank line at end of file.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_CLOSE_TAG => ''], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testLiveCoding() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding3Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding3Test.inc deleted file mode 100644 index 9b81a434d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding3Test.inc +++ /dev/null @@ -1,4 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -/** - * Tests that unclosed docblocks during live coding are handled correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -final class LiveCoding3Test extends CommentTestCase -{ - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - public static function dataDocblockOpenerCloser() - { - return [ - 'live coding: unclosed docblock, no contents, no blank line at end of file' => [ - 'marker' => '/* testLiveCoding */', - 'closerOffset' => 1, - 'expectedTags' => [], - ], - ]; - - }//end dataDocblockOpenerCloser() - - - /** - * Verify tokenization of the DocBlock. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testLiveCoding() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_CLOSE_TAG => ''], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testLiveCoding() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding4Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding4Test.inc deleted file mode 100644 index 1561e7156..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/LiveCoding4Test.inc +++ /dev/null @@ -1,7 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -/** - * Tests that unclosed docblocks during live coding are handled correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -final class LiveCoding4Test extends CommentTestCase -{ - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - public static function dataDocblockOpenerCloser() - { - return [ - 'live coding: unclosed docblock, trailing whitespace on last line, no blank line at end of file' => [ - 'marker' => '/* testLiveCoding */', - 'closerOffset' => 15, - 'expectedTags' => [], - ], - ]; - - }//end dataDocblockOpenerCloser() - - - /** - * Verify tokenization of the DocBlock. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testLiveCoding() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'The last line of this test must have trailing whitespace.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'So, be careful when saving this file!'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => ''], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testLiveCoding() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/MultiLineDocBlockTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/MultiLineDocBlockTest.inc deleted file mode 100644 index f33afcd6a..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/MultiLineDocBlockTest.inc +++ /dev/null @@ -1,81 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -/** - * Tests that multiline docblocks are tokenized correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -final class MultiLineDocBlockTest extends CommentTestCase -{ - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - public static function dataDocblockOpenerCloser() - { - return [ - 'Multi line docblock: no contents' => [ - 'marker' => '/* testEmptyDocblock */', - 'closerOffset' => 3, - 'expectedTags' => [], - ], - 'Multi line docblock: variety of text and tags' => [ - 'marker' => '/* testMultilineDocblock */', - 'closerOffset' => 95, - // phpcs:ignore Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed - 'expectedTags' => [21, 29, 36, 46, 56, 63, 73, 80, 90], - ], - 'Multi line docblock: no leading stars' => [ - 'marker' => '/* testMultilineDocblockNoStars */', - 'closerOffset' => 32, - // phpcs:ignore Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed - 'expectedTags' => [10, 16, 21, 27], - ], - 'Multi line docblock: indented' => [ - 'marker' => '/* testMultilineDocblockIndented */', - 'closerOffset' => 60, - // phpcs:ignore Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed - 'expectedTags' => [21, 28, 38, 45, 55], - ], - 'Multi line docblock: opener not on own line' => [ - 'marker' => '/* testMultilineDocblockOpenerNotOnOwnLine */', - 'closerOffset' => 10, - 'expectedTags' => [], - ], - 'Multi line docblock: closer not on own line' => [ - 'marker' => '/* testMultilineDocblockCloserNotOnOwnLine */', - 'closerOffset' => 11, - 'expectedTags' => [], - ], - 'Multi line docblock: stars not aligned' => [ - 'marker' => '/* testMultilineDocblockStarsNotAligned */', - 'closerOffset' => 26, - 'expectedTags' => [], - ], - ]; - - }//end dataDocblockOpenerCloser() - - - /** - * Verify tokenization of an empty, multi-line DocBlock. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testEmptyDocblock() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testEmptyDocblock() - - - /** - * Verify tokenization of a multi-line DocBlock containing all possible tokens. - * - * @return void - */ - public function testMultilineDocblock() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'This is a multi-line docblock.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'With blank lines, stars, tags, and tag descriptions.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tagWithoutDescription'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@since'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => '10.3'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@deprecated'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => '11.5'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@requires'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'PHP 7.1 -- PHPUnit tag.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tag-with-dashes-is-suppported'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Description.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tag_with_underscores'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Description.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@param'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'string $p1 Description 1.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@param'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'int|false $p2 Description 2.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@return'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'void'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultilineDocblock() - - - /** - * Verify tokenization of a multi-line DocBlock with extra starts for the opener/closer and no stars on the lines between. - * - * @return void - */ - public function testMultilineDocblockNoStars() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/****'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'This is a multi-line docblock, but the lines are not marked with stars.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Then again, the opener and closer have an abundance of stars.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@since'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => '10.3'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@param'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'string $p1 Description 1.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@param'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'int|false $p2 Description 2.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@return'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'void'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '**/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultilineDocblockNoStars() - - - /** - * Verify tokenization of a multi-line, indented DocBlock. - * - * @return void - */ - public function testMultilineDocblockIndented() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'This is a multi-line indented docblock.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'With blank lines, stars, tags, and tag descriptions.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@since'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => '10.3'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@deprecated'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => '11.5'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@param'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'string $p1 Description 1.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@param'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'int|false $p2 Description 2.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@return'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'void'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultilineDocblockIndented() - - - /** - * Verify tokenization of a multi-line DocBlock, where the opener is not on its own line. - * - * @return void - */ - public function testMultilineDocblockOpenerNotOnOwnLine() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Start of description'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'description continued.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultilineDocblockOpenerNotOnOwnLine() - - - /** - * Verify tokenization of a multi-line DocBlock, where the closer is not on its own line. - * - * @return void - */ - public function testMultilineDocblockCloserNotOnOwnLine() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Start of description'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'description continued. '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultilineDocblockCloserNotOnOwnLine() - - - /** - * Verify tokenization of a multi-line DocBlock with inconsistent indentation. - * - * @return void - */ - public function testMultilineDocblockStarsNotAligned() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Start of description.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Line below this is missing a star.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Text'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Star indented.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Closer indented.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultilineDocblockStarsNotAligned() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/PhpcsAnnotationsInDocBlockTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/PhpcsAnnotationsInDocBlockTest.inc deleted file mode 100644 index d74f68d24..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/PhpcsAnnotationsInDocBlockTest.inc +++ /dev/null @@ -1,116 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -/** - * Tests that PHPCS native annotations in docblocks are tokenized correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -final class PhpcsAnnotationsInDocBlockTest extends CommentTestCase -{ - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - public static function dataDocblockOpenerCloser() - { - return [ - 'Single-line: @phpcs:ignoreFile annotation' => [ - 'marker' => '/* testSingleLineDocIgnoreFileAnnotation */', - 'closerOffset' => 3, - 'expectedTags' => [], - ], - 'Single-line: @phpcs:ignore annotation' => [ - 'marker' => '/* testSingleLineDocIgnoreAnnotation */', - 'closerOffset' => 3, - 'expectedTags' => [], - ], - 'Single-line: @phpcs:disable annotation' => [ - 'marker' => '/* testSingleLineDocDisableAnnotation */', - 'closerOffset' => 3, - 'expectedTags' => [], - ], - 'Single-line: @phpcs:enable annotation; no whitespace' => [ - 'marker' => '/* testSingleLineDocEnableAnnotationNoWhitespace */', - 'closerOffset' => 2, - 'expectedTags' => [], - ], - - 'Multi-line: @phpcs:ignoreFile at the start' => [ - 'marker' => '/* testMultiLineDocIgnoreFileAnnotationAtStart */', - 'closerOffset' => 13, - 'expectedTags' => [], - ], - 'Multi-line: @phpcs:ignore at the start' => [ - 'marker' => '/* testMultiLineDocIgnoreAnnotationAtStart */', - 'closerOffset' => 13, - 'expectedTags' => [10], - ], - 'Multi-line: @phpcs:disable at the start' => [ - 'marker' => '/* testMultiLineDocDisableAnnotationAtStart */', - 'closerOffset' => 13, - 'expectedTags' => [], - ], - 'Multi-line: @phpcs:enable at the start' => [ - 'marker' => '/* testMultiLineDocEnableAnnotationAtStart */', - 'closerOffset' => 18, - 'expectedTags' => [13], - ], - - 'Multi-line: @phpcs:ignoreFile in the middle' => [ - 'marker' => '/* testMultiLineDocIgnoreFileAnnotationInMiddle */', - 'closerOffset' => 21, - 'expectedTags' => [], - ], - 'Multi-line: @phpcs:ignore in the middle' => [ - 'marker' => '/* testMultiLineDocIgnoreAnnotationInMiddle */', - 'closerOffset' => 23, - 'expectedTags' => [5], - ], - 'Multi-line: @phpcs:disable in the middle' => [ - 'marker' => '/* testMultiLineDocDisableAnnotationInMiddle */', - 'closerOffset' => 26, - 'expectedTags' => [21], - ], - 'Multi-line: @phpcs:enable in the middle' => [ - 'marker' => '/* testMultiLineDocEnableAnnotationInMiddle */', - 'closerOffset' => 24, - 'expectedTags' => [21], - ], - - 'Multi-line: @phpcs:ignoreFile at the end' => [ - 'marker' => '/* testMultiLineDocIgnoreFileAnnotationAtEnd */', - 'closerOffset' => 16, - 'expectedTags' => [5], - ], - 'Multi-line: @phpcs:ignore at the end' => [ - 'marker' => '/* testMultiLineDocIgnoreAnnotationAtEnd */', - 'closerOffset' => 16, - 'expectedTags' => [], - ], - 'Multi-line: @phpcs:disable at the end' => [ - 'marker' => '/* testMultiLineDocDisableAnnotationAtEnd */', - 'closerOffset' => 18, - 'expectedTags' => [5], - ], - 'Multi-line: @phpcs:enable at the end' => [ - 'marker' => '/* testMultiLineDocEnableAnnotationAtEnd */', - 'closerOffset' => 16, - 'expectedTags' => [], - ], - ]; - - }//end dataDocblockOpenerCloser() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testSingleLineDocIgnoreFileAnnotation() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocIgnoreFileAnnotation() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation. - * - * @return void - */ - public function testSingleLineDocIgnoreAnnotation() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName -- With reason '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocIgnoreAnnotation() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS disable annotation. - * - * @return void - */ - public function testSingleLineDocDisableAnnotation() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName,Stnd.Other '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocDisableAnnotation() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS enable annotation. - * - * @return void - */ - public function testSingleLineDocEnableAnnotationNoWhitespace() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat.SniffName'], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocEnableAnnotationNoWhitespace() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation at the start. - * - * @return void - */ - public function testMultiLineDocIgnoreFileAnnotationAtStart() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Something.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocIgnoreFileAnnotationAtStart() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation at the start. - * - * @return void - */ - public function testMultiLineDocIgnoreAnnotationAtStart() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tag'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocIgnoreAnnotationAtStart() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS disable annotation at the start. - * - * @return void - */ - public function testMultiLineDocDisableAnnotationAtStart() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName -- Ensure PHPCS annotations are also retokenized correctly.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Something.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocDisableAnnotationAtStart() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS enable annotation at the start. - * - * @return void - */ - public function testMultiLineDocEnableAnnotationAtStart() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat,Stnd.Other'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tag'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'With description.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocEnableAnnotationAtStart() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation in the middle. - * - * @return void - */ - public function testMultiLineDocIgnoreFileAnnotationInMiddle() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Something.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocIgnoreFileAnnotationInMiddle() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation in the middle. - * - * @return void - */ - public function testMultiLineDocIgnoreAnnotationInMiddle() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tagBefore'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'With Description'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Something.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocIgnoreAnnotationInMiddle() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS disable annotation in the middle. - * - * @return void - */ - public function testMultiLineDocDisableAnnotationInMiddle() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName -- Ensure PHPCS annotations are also retokenized correctly.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tagAfter'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'With Description'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocDisableAnnotationInMiddle() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS enable annotation in the middle. - * - * @return void - */ - public function testMultiLineDocEnableAnnotationInMiddle() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat,Stnd.Other'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tagAfter'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocEnableAnnotationInMiddle() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignoreFile annotation at the end. - * - * @return void - */ - public function testMultiLineDocIgnoreFileAnnotationAtEnd() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tagBefore'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE_FILE => '@phpcs:ignoreFile'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocIgnoreFileAnnotationAtEnd() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS ignore annotation at the end. - * - * @return void - */ - public function testMultiLineDocIgnoreAnnotationAtEnd() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_IGNORE => '@phpcs:ignore Stnd.Cat.SniffName'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocIgnoreAnnotationAtEnd() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS disable annotation at the end. - * - * @return void - */ - public function testMultiLineDocDisableAnnotationAtEnd() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@tagBefore'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'With Description.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_DISABLE => '@phpcs:disable Stnd.Cat.SniffName -- Ensure PHPCS annotations are also retokenized correctly.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocDisableAnnotationAtEnd() - - - /** - * Verify tokenization of a single line DocBlock containing a PHPCS enable annotation at the end. - * - * @return void - */ - public function testMultiLineDocEnableAnnotationAtEnd() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Check tokenization of PHPCS annotations within docblocks.'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STAR => '*'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_PHPCS_ENABLE => '@phpcs:enable Stnd.Cat,Stnd.Other'], - [T_DOC_COMMENT_WHITESPACE => "\n"], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testMultiLineDocEnableAnnotationAtEnd() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/SingleLineDocBlockTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/SingleLineDocBlockTest.inc deleted file mode 100644 index 88b05ea43..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Comment/SingleLineDocBlockTest.inc +++ /dev/null @@ -1,26 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Comment; - -/** - * Tests that single line docblocks are tokenized correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\Comment - */ -final class SingleLineDocBlockTest extends CommentTestCase -{ - - - /** - * Data provider. - * - * @see testDocblockOpenerCloser() - * - * @return array>> - */ - public static function dataDocblockOpenerCloser() - { - return [ - 'Single line docblock: empty, no whitespace' => [ - 'marker' => '/* testEmptyDocblockNoWhiteSpace */', - 'closerOffset' => 1, - 'expectedTags' => [], - ], - 'Single line docblock: only whitespace' => [ - 'marker' => '/* testEmptyDocblockWithWhiteSpace */', - 'closerOffset' => 2, - 'expectedTags' => [], - ], - 'Single line docblock: just text' => [ - 'marker' => '/* testSingleLineDocblockNoTag */', - 'closerOffset' => 3, - 'expectedTags' => [], - ], - 'Single line docblock: @var type before name' => [ - 'marker' => '/* testSingleLineDocblockWithTag1 */', - 'closerOffset' => 5, - 'expectedTags' => [2], - ], - 'Single line docblock: @var name before type' => [ - 'marker' => '/* testSingleLineDocblockWithTag2 */', - 'closerOffset' => 5, - 'expectedTags' => [2], - ], - 'Single line docblock: @see with description' => [ - 'marker' => '/* testSingleLineDocblockWithTag3 */', - 'closerOffset' => 5, - 'expectedTags' => [2], - ], - ]; - - }//end dataDocblockOpenerCloser() - - - /** - * Verify an empty block comment is tokenized as T_COMMENT, not as a docblock. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testEmptyBlockCommentNoWhiteSpace() - { - $expectedSequence = [ - [T_COMMENT => '/**/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', [T_COMMENT, T_DOC_COMMENT_OPEN_TAG]); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testEmptyBlockCommentNoWhiteSpace() - - - /** - * Verify tokenization of an empty, single line DocBlock without whitespace between the opener and closer. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testEmptyDocblockNoWhiteSpace() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testEmptyDocblockNoWhiteSpace() - - - /** - * Verify tokenization of an empty, single line DocBlock. - * - * @return void - */ - public function testEmptyDocblockWithWhiteSpace() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testEmptyDocblockWithWhiteSpace() - - - /** - * Verify tokenization of a single line DocBlock. - * - * @return void - */ - public function testSingleLineDocblockNoTag() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Just some text '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocblockNoTag() - - - /** - * Verify tokenization of a single line DocBlock with a tag. - * - * @return void - */ - public function testSingleLineDocblockWithTag1() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@var'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => '\SomeClass[] $var '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocblockWithTag1() - - - /** - * Verify tokenization of a single line DocBlock with a tag. - * - * @return void - */ - public function testSingleLineDocblockWithTag2() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@var'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => '$var \SomeClass[] '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocblockWithTag2() - - - /** - * Verify tokenization of a single line DocBlock with a tag. - * - * @return void - */ - public function testSingleLineDocblockWithTag3() - { - $expectedSequence = [ - [T_DOC_COMMENT_OPEN_TAG => '/**'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_TAG => '@see'], - [T_DOC_COMMENT_WHITESPACE => ' '], - [T_DOC_COMMENT_STRING => 'Something::Else '], - [T_DOC_COMMENT_CLOSE_TAG => '*/'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_DOC_COMMENT_OPEN_TAG); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testSingleLineDocblockWithTag3() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AnonClassParenthesisOwnerTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AnonClassParenthesisOwnerTest.inc deleted file mode 100644 index 3ee1afd0d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AnonClassParenthesisOwnerTest.inc +++ /dev/null @@ -1,29 +0,0 @@ - - * @copyright 2019 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class AnonClassParenthesisOwnerTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that anonymous class tokens without parenthesis do not get assigned a parenthesis owner. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataAnonClassNoParentheses - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testAnonClassNoParentheses($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $anonClass = $this->getTargetToken($testMarker, T_ANON_CLASS); - $this->assertArrayNotHasKey('parenthesis_owner', $tokens[$anonClass]); - $this->assertArrayNotHasKey('parenthesis_opener', $tokens[$anonClass]); - $this->assertArrayNotHasKey('parenthesis_closer', $tokens[$anonClass]); - - }//end testAnonClassNoParentheses() - - - /** - * Test that the next open/close parenthesis after an anonymous class without parenthesis - * do not get assigned the anonymous class as a parenthesis owner. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataAnonClassNoParentheses - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testAnonClassNoParenthesesNextOpenClose($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $function = $this->getTargetToken($testMarker, T_FUNCTION); - - $opener = $this->getTargetToken($testMarker, T_OPEN_PARENTHESIS); - $this->assertArrayHasKey('parenthesis_owner', $tokens[$opener]); - $this->assertSame($function, $tokens[$opener]['parenthesis_owner']); - - $closer = $this->getTargetToken($testMarker, T_CLOSE_PARENTHESIS); - $this->assertArrayHasKey('parenthesis_owner', $tokens[$closer]); - $this->assertSame($function, $tokens[$closer]['parenthesis_owner']); - - }//end testAnonClassNoParenthesesNextOpenClose() - - - /** - * Data provider. - * - * @see testAnonClassNoParentheses() - * @see testAnonClassNoParenthesesNextOpenClose() - * - * @return array> - */ - public static function dataAnonClassNoParentheses() - { - return [ - 'plain' => [ - 'testMarker' => '/* testNoParentheses */', - ], - 'readonly' => [ - 'testMarker' => '/* testReadonlyNoParentheses */', - ], - 'declaration contains comments and extra whitespace' => [ - 'testMarker' => '/* testNoParenthesesAndEmptyTokens */', - ], - ]; - - }//end dataAnonClassNoParentheses() - - - /** - * Test that anonymous class tokens with parenthesis get assigned a parenthesis owner, - * opener and closer; and that the opener/closer get the anonymous class assigned as owner. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataAnonClassWithParentheses - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testAnonClassWithParentheses($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $anonClass = $this->getTargetToken($testMarker, T_ANON_CLASS); - $opener = $this->getTargetToken($testMarker, T_OPEN_PARENTHESIS); - $closer = $this->getTargetToken($testMarker, T_CLOSE_PARENTHESIS); - - $this->assertArrayHasKey('parenthesis_owner', $tokens[$anonClass]); - $this->assertArrayHasKey('parenthesis_opener', $tokens[$anonClass]); - $this->assertArrayHasKey('parenthesis_closer', $tokens[$anonClass]); - $this->assertSame($anonClass, $tokens[$anonClass]['parenthesis_owner']); - $this->assertSame($opener, $tokens[$anonClass]['parenthesis_opener']); - $this->assertSame($closer, $tokens[$anonClass]['parenthesis_closer']); - - $this->assertArrayHasKey('parenthesis_owner', $tokens[$opener]); - $this->assertArrayHasKey('parenthesis_opener', $tokens[$opener]); - $this->assertArrayHasKey('parenthesis_closer', $tokens[$opener]); - $this->assertSame($anonClass, $tokens[$opener]['parenthesis_owner']); - $this->assertSame($opener, $tokens[$opener]['parenthesis_opener']); - $this->assertSame($closer, $tokens[$opener]['parenthesis_closer']); - - $this->assertArrayHasKey('parenthesis_owner', $tokens[$closer]); - $this->assertArrayHasKey('parenthesis_opener', $tokens[$closer]); - $this->assertArrayHasKey('parenthesis_closer', $tokens[$closer]); - $this->assertSame($anonClass, $tokens[$closer]['parenthesis_owner']); - $this->assertSame($opener, $tokens[$closer]['parenthesis_opener']); - $this->assertSame($closer, $tokens[$closer]['parenthesis_closer']); - - }//end testAnonClassWithParentheses() - - - /** - * Data provider. - * - * @see testAnonClassWithParentheses() - * - * @return array> - */ - public static function dataAnonClassWithParentheses() - { - return [ - 'plain' => [ - 'testMarker' => '/* testWithParentheses */', - ], - 'readonly' => [ - 'testMarker' => '/* testReadonlyWithParentheses */', - ], - 'declaration contains comments and extra whitespace' => [ - 'testMarker' => '/* testWithParenthesesAndEmptyTokens */', - ], - ]; - - }//end dataAnonClassWithParentheses() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ArrayKeywordTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ArrayKeywordTest.inc deleted file mode 100644 index 6d8adfcba..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ArrayKeywordTest.inc +++ /dev/null @@ -1,58 +0,0 @@ - 10); - -/* testArrayWithComment */ -$var = Array /*comment*/ (1 => 10); - -/* testNestingArray */ -$var = array( - /* testNestedArray */ - array( - 'key' => 'value', - - /* testClosureReturnType */ - 'closure' => function($a) use($global) : Array {}, - ), -); - -/* testFunctionDeclarationParamType */ -function typedParam(array $a) {} - -/* testFunctionDeclarationReturnType */ -function returnType($a) : int|array|null {} - -class Bar { - /* testClassConst */ - const ARRAY = []; - - /* testClassMethod */ - public function array() {} - - /* testOOConstType */ - const array /* testTypedOOConstName */ ARRAY = /* testOOConstDefault */ array(); - - /* testOOPropertyType */ - protected array $property; -} - -class DNFTypes { - /* testOOConstDNFType */ - const (A&B)|array|(C&D) NAME = []; - - /* testOOPropertyDNFType */ - protected (A&B)|ARRAY|null $property; - - /* testFunctionDeclarationParamDNFType */ - public function name(null|array|(A&B) $param) { - /* testClosureDeclarationParamDNFType */ - $cl = function ( array|(A&B) $param) {}; - - /* testArrowDeclarationReturnDNFType */ - $arrow = fn($a): (A&B)|Array => new $a; - } -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ArrayKeywordTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ArrayKeywordTest.php deleted file mode 100644 index f94971d9d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ArrayKeywordTest.php +++ /dev/null @@ -1,200 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class ArrayKeywordTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the array keyword is correctly tokenized as `T_ARRAY`. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent Optional. The token content to look for. - * - * @dataProvider dataArrayKeyword - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testArrayKeyword($testMarker, $testContent='array') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_ARRAY, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_ARRAY, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_ARRAY (code)'); - $this->assertSame('T_ARRAY', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_ARRAY (type)'); - - }//end testArrayKeyword() - - - /** - * Data provider. - * - * @see testArrayKeyword() - * - * @return array> - */ - public static function dataArrayKeyword() - { - return [ - 'empty array' => [ - 'testMarker' => '/* testEmptyArray */', - ], - 'array with space before parenthesis' => [ - 'testMarker' => '/* testArrayWithSpace */', - ], - 'array with comment before parenthesis' => [ - 'testMarker' => '/* testArrayWithComment */', - 'testContent' => 'Array', - ], - 'nested: outer array' => [ - 'testMarker' => '/* testNestingArray */', - ], - 'nested: inner array' => [ - 'testMarker' => '/* testNestedArray */', - ], - 'OO constant default value' => [ - 'testMarker' => '/* testOOConstDefault */', - ], - ]; - - }//end dataArrayKeyword() - - - /** - * Test that the array keyword when used in a type declaration is correctly tokenized as `T_STRING`. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent Optional. The token content to look for. - * - * @dataProvider dataArrayType - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testArrayType($testMarker, $testContent='array') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_ARRAY, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testArrayType() - - - /** - * Data provider. - * - * @see testArrayType() - * - * @return array> - */ - public static function dataArrayType() - { - return [ - 'closure return type' => [ - 'testMarker' => '/* testClosureReturnType */', - 'testContent' => 'Array', - ], - 'function param type' => [ - 'testMarker' => '/* testFunctionDeclarationParamType */', - ], - 'function union return type' => [ - 'testMarker' => '/* testFunctionDeclarationReturnType */', - ], - 'OO constant type' => [ - 'testMarker' => '/* testOOConstType */', - ], - 'OO property type' => [ - 'testMarker' => '/* testOOPropertyType */', - ], - - 'OO constant DNF type' => [ - 'testMarker' => '/* testOOConstDNFType */', - ], - 'OO property DNF type' => [ - 'testMarker' => '/* testOOPropertyDNFType */', - 'testContent' => 'ARRAY', - ], - 'function param DNF type' => [ - 'testMarker' => '/* testFunctionDeclarationParamDNFType */', - ], - 'closure param DNF type' => [ - 'testMarker' => '/* testClosureDeclarationParamDNFType */', - ], - 'arrow return DNF type' => [ - 'testMarker' => '/* testArrowDeclarationReturnDNFType */', - 'testContent' => 'Array', - ], - ]; - - }//end dataArrayType() - - - /** - * Verify that the retokenization of `T_ARRAY` tokens to `T_STRING` is handled correctly - * for tokens with the contents 'array' which aren't in actual fact the array keyword. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataNotArrayKeyword - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNotArrayKeyword($testMarker, $testContent='array') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_ARRAY, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testNotArrayKeyword() - - - /** - * Data provider. - * - * @see testNotArrayKeyword() - * - * @return array> - */ - public static function dataNotArrayKeyword() - { - return [ - 'class-constant-name' => [ - 'testMarker' => '/* testClassConst */', - 'testContent' => 'ARRAY', - ], - 'class-method-name' => [ - 'testMarker' => '/* testClassMethod */', - ], - 'class-constant-name-after-type' => [ - 'testMarker' => '/* testTypedOOConstName */', - 'testContent' => 'ARRAY', - ], - ]; - - }//end dataNotArrayKeyword() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AttributesTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AttributesTest.inc deleted file mode 100644 index 9d56c0952..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AttributesTest.inc +++ /dev/null @@ -1,90 +0,0 @@ - 'foobar'])] -function attribute_with_params_on_function_test() {} - -/* testAttributeWithShortClosureParameter */ -#[AttributeWithParams(static fn ($value) => ! $value)] -function attribute_with_short_closure_param_test() {} - -/* testTwoAttributeOnTheSameLine */ -#[CustomAttribute] #[AttributeWithParams('foo')] -function two_attribute_on_same_line_test() {} - -/* testAttributeAndCommentOnTheSameLine */ -#[CustomAttribute] // This is a comment -function attribute_and_line_comment_on_same_line_test() {} - -/* testAttributeGrouping */ -#[CustomAttribute, AttributeWithParams('foo'), AttributeWithParams('foo', bar: ['bar' => 'foobar'])] -function attribute_grouping_test() {} - -/* testAttributeMultiline */ -#[ - CustomAttribute, - AttributeWithParams('foo'), - AttributeWithParams('foo', bar: ['bar' => 'foobar']) -] -function attribute_multiline_test() {} - -/* testAttributeMultilineWithComment */ -#[ - CustomAttribute, // comment - AttributeWithParams(/* another comment */ 'foo'), - AttributeWithParams('foo', bar: ['bar' => 'foobar']) -] -function attribute_multiline_with_comment_test() {} - -/* testSingleAttributeOnParameter */ -function single_attribute_on_parameter_test(#[ParamAttribute] int $param) {} - -/* testMultipleAttributesOnParameter */ -function multiple_attributes_on_parameter_test(#[ParamAttribute, AttributeWithParams(/* another comment */ 'foo')] int $param) {} - -/* testFqcnAttribute */ -#[Boo\QualifiedName, \Foo\FullyQualifiedName('foo')] -function fqcn_attribute_test() {} - -/* testNestedAttributes */ -#[Boo\QualifiedName(fn (#[AttributeOne('boo')] $value) => (string) $value)] -function nested_attributes_test() {} - -/* testMultilineAttributesOnParameter */ -function multiline_attributes_on_parameter_test(#[ - AttributeWithParams( - 'foo' - ) - ] int $param) {} - -/* testAttributeContainingTextLookingLikeCloseTag */ -#[DeprecationReason('reason: ')] -function attribute_containing_text_looking_like_close_tag() {} - -/* testAttributeContainingMultilineTextLookingLikeCloseTag */ -#[DeprecationReason( - 'reason: ' -)] -function attribute_containing_mulitline_text_looking_like_close_tag() {} - -/* testInvalidAttribute */ -#[ThisIsNotAnAttribute -function invalid_attribute_test() {} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AttributesTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AttributesTest.php deleted file mode 100644 index bc15a1930..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/AttributesTest.php +++ /dev/null @@ -1,700 +0,0 @@ - - * @copyright 2019 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class AttributesTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that attributes are parsed correctly. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param array $tokenCodes The codes of tokens inside the attributes. - * - * @dataProvider dataAttribute - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::findCloser - * @covers PHP_CodeSniffer\Tokenizers\PHP::parsePhpAttribute - * - * @return void - */ - public function testAttribute($testMarker, $tokenCodes) - { - $tokens = $this->phpcsFile->getTokens(); - - // Calculate the number of tokens between opener and closer (excluding the opener, including the closer). - $length = (count($tokenCodes) + 1); - - $attribute = $this->getTargetToken($testMarker, T_ATTRIBUTE); - $this->assertArrayHasKey('attribute_closer', $tokens[$attribute]); - - $closer = $tokens[$attribute]['attribute_closer']; - $this->assertSame(($attribute + $length), $closer); - - $this->assertSame(T_ATTRIBUTE_END, $tokens[$closer]['code']); - - $this->assertSame($tokens[$attribute]['attribute_opener'], $tokens[$closer]['attribute_opener']); - $this->assertSame($tokens[$attribute]['attribute_closer'], $tokens[$closer]['attribute_closer']); - - $map = array_map( - function ($token) use ($attribute, $length) { - $this->assertArrayHasKey('attribute_closer', $token); - $this->assertSame(($attribute + $length), $token['attribute_closer']); - - return $token['code']; - }, - array_slice($tokens, ($attribute + 1), ($length - 1)) - ); - - $this->assertSame($tokenCodes, $map); - - }//end testAttribute() - - - /** - * Data provider. - * - * @see testAttribute() - * - * @return array>> - */ - public static function dataAttribute() - { - return [ - 'class attribute' => [ - 'testMarker' => '/* testAttribute */', - 'tokenCodes' => [ - T_STRING, - ], - ], - 'class attribute with param' => [ - 'testMarker' => '/* testAttributeWithParams */', - 'tokenCodes' => [ - T_STRING, - T_OPEN_PARENTHESIS, - T_STRING, - T_DOUBLE_COLON, - T_STRING, - T_CLOSE_PARENTHESIS, - ], - ], - 'class attribute with named param' => [ - 'testMarker' => '/* testAttributeWithNamedParam */', - 'tokenCodes' => [ - T_STRING, - T_OPEN_PARENTHESIS, - T_PARAM_NAME, - T_COLON, - T_WHITESPACE, - T_STRING, - T_DOUBLE_COLON, - T_STRING, - T_CLOSE_PARENTHESIS, - ], - ], - 'function attribute' => [ - 'testMarker' => '/* testAttributeOnFunction */', - 'tokenCodes' => [ - T_STRING, - ], - ], - 'function attribute with params' => [ - 'testMarker' => '/* testAttributeOnFunctionWithParams */', - 'tokenCodes' => [ - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_COMMA, - T_WHITESPACE, - T_PARAM_NAME, - T_COLON, - T_WHITESPACE, - T_OPEN_SHORT_ARRAY, - T_CONSTANT_ENCAPSED_STRING, - T_WHITESPACE, - T_DOUBLE_ARROW, - T_WHITESPACE, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_SHORT_ARRAY, - T_CLOSE_PARENTHESIS, - ], - ], - 'function attribute with arrow function as param' => [ - 'testMarker' => '/* testAttributeWithShortClosureParameter */', - 'tokenCodes' => [ - T_STRING, - T_OPEN_PARENTHESIS, - T_STATIC, - T_WHITESPACE, - T_FN, - T_WHITESPACE, - T_OPEN_PARENTHESIS, - T_VARIABLE, - T_CLOSE_PARENTHESIS, - T_WHITESPACE, - T_FN_ARROW, - T_WHITESPACE, - T_BOOLEAN_NOT, - T_WHITESPACE, - T_VARIABLE, - T_CLOSE_PARENTHESIS, - ], - ], - 'function attribute; multiple comma separated classes' => [ - 'testMarker' => '/* testAttributeGrouping */', - 'tokenCodes' => [ - T_STRING, - T_COMMA, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_PARENTHESIS, - T_COMMA, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_COMMA, - T_WHITESPACE, - T_PARAM_NAME, - T_COLON, - T_WHITESPACE, - T_OPEN_SHORT_ARRAY, - T_CONSTANT_ENCAPSED_STRING, - T_WHITESPACE, - T_DOUBLE_ARROW, - T_WHITESPACE, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_SHORT_ARRAY, - T_CLOSE_PARENTHESIS, - ], - ], - 'function attribute; multiple comma separated classes, one per line' => [ - 'testMarker' => '/* testAttributeMultiline */', - 'tokenCodes' => [ - T_WHITESPACE, - T_WHITESPACE, - T_STRING, - T_COMMA, - T_WHITESPACE, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_PARENTHESIS, - T_COMMA, - T_WHITESPACE, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_COMMA, - T_WHITESPACE, - T_PARAM_NAME, - T_COLON, - T_WHITESPACE, - T_OPEN_SHORT_ARRAY, - T_CONSTANT_ENCAPSED_STRING, - T_WHITESPACE, - T_DOUBLE_ARROW, - T_WHITESPACE, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_SHORT_ARRAY, - T_CLOSE_PARENTHESIS, - T_WHITESPACE, - ], - ], - 'function attribute; multiple comma separated classes, one per line, with comments' => [ - 'testMarker' => '/* testAttributeMultilineWithComment */', - 'tokenCodes' => [ - T_WHITESPACE, - T_WHITESPACE, - T_STRING, - T_COMMA, - T_WHITESPACE, - T_COMMENT, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_COMMENT, - T_WHITESPACE, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_PARENTHESIS, - T_COMMA, - T_WHITESPACE, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_COMMA, - T_WHITESPACE, - T_PARAM_NAME, - T_COLON, - T_WHITESPACE, - T_OPEN_SHORT_ARRAY, - T_CONSTANT_ENCAPSED_STRING, - T_WHITESPACE, - T_DOUBLE_ARROW, - T_WHITESPACE, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_SHORT_ARRAY, - T_CLOSE_PARENTHESIS, - T_WHITESPACE, - ], - ], - 'function attribute; using partially qualified and fully qualified class names' => [ - 'testMarker' => '/* testFqcnAttribute */', - 'tokenCodes' => [ - T_STRING, - T_NS_SEPARATOR, - T_STRING, - T_COMMA, - T_WHITESPACE, - T_NS_SEPARATOR, - T_STRING, - T_NS_SEPARATOR, - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_PARENTHESIS, - ], - ], - ]; - - }//end dataAttribute() - - - /** - * Test that multiple attributes on the same line are parsed correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::findCloser - * @covers PHP_CodeSniffer\Tokenizers\PHP::parsePhpAttribute - * - * @return void - */ - public function testTwoAttributesOnTheSameLine() - { - $tokens = $this->phpcsFile->getTokens(); - - $attribute = $this->getTargetToken('/* testTwoAttributeOnTheSameLine */', T_ATTRIBUTE); - $this->assertArrayHasKey('attribute_closer', $tokens[$attribute]); - - $closer = $tokens[$attribute]['attribute_closer']; - $this->assertSame(T_WHITESPACE, $tokens[($closer + 1)]['code']); - $this->assertSame(T_ATTRIBUTE, $tokens[($closer + 2)]['code']); - $this->assertArrayHasKey('attribute_closer', $tokens[($closer + 2)]); - - }//end testTwoAttributesOnTheSameLine() - - - /** - * Test that attribute followed by a line comment is parsed correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::findCloser - * @covers PHP_CodeSniffer\Tokenizers\PHP::parsePhpAttribute - * - * @return void - */ - public function testAttributeAndLineComment() - { - $tokens = $this->phpcsFile->getTokens(); - - $attribute = $this->getTargetToken('/* testAttributeAndCommentOnTheSameLine */', T_ATTRIBUTE); - $this->assertArrayHasKey('attribute_closer', $tokens[$attribute]); - - $closer = $tokens[$attribute]['attribute_closer']; - $this->assertSame(T_WHITESPACE, $tokens[($closer + 1)]['code']); - $this->assertSame(T_COMMENT, $tokens[($closer + 2)]['code']); - - }//end testAttributeAndLineComment() - - - /** - * Test that attributes on function declaration parameters are parsed correctly. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param int $position The token position (starting from T_FUNCTION) of T_ATTRIBUTE token. - * @param array $tokenCodes The codes of tokens inside the attributes. - * - * @dataProvider dataAttributeOnParameters - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::findCloser - * @covers PHP_CodeSniffer\Tokenizers\PHP::parsePhpAttribute - * - * @return void - */ - public function testAttributeOnParameters($testMarker, $position, array $tokenCodes) - { - $tokens = $this->phpcsFile->getTokens(); - - // Calculate the number of tokens between opener and closer (excluding the opener, including the closer). - $length = (count($tokenCodes) + 1); - - $function = $this->getTargetToken($testMarker, T_FUNCTION); - $attribute = ($function + $position); - - $this->assertSame(T_ATTRIBUTE, $tokens[$attribute]['code']); - $this->assertArrayHasKey('attribute_closer', $tokens[$attribute]); - - $this->assertSame(($attribute + $length), $tokens[$attribute]['attribute_closer']); - - $closer = $tokens[$attribute]['attribute_closer']; - $this->assertSame(T_WHITESPACE, $tokens[($closer + 1)]['code']); - $this->assertSame(T_STRING, $tokens[($closer + 2)]['code']); - $this->assertSame('int', $tokens[($closer + 2)]['content']); - - $this->assertSame(T_VARIABLE, $tokens[($closer + 4)]['code']); - $this->assertSame('$param', $tokens[($closer + 4)]['content']); - - $map = array_map( - function ($token) use ($attribute, $length) { - $this->assertArrayHasKey('attribute_closer', $token); - $this->assertSame(($attribute + $length), $token['attribute_closer']); - - return $token['code']; - }, - array_slice($tokens, ($attribute + 1), ($length - 1)) - ); - - $this->assertSame($tokenCodes, $map); - - }//end testAttributeOnParameters() - - - /** - * Data provider. - * - * @see testAttributeOnParameters() - * - * @return array>> - */ - public static function dataAttributeOnParameters() - { - return [ - 'parameter attribute; single, inline' => [ - 'testMarker' => '/* testSingleAttributeOnParameter */', - 'position' => 4, - 'tokenCodes' => [ - T_STRING, - ], - ], - 'parameter attribute; multiple comma separated, inline' => [ - 'testMarker' => '/* testMultipleAttributesOnParameter */', - 'position' => 4, - 'tokenCodes' => [ - T_STRING, - T_COMMA, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_COMMENT, - T_WHITESPACE, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_PARENTHESIS, - ], - ], - 'parameter attribute; single, multiline' => [ - 'testMarker' => '/* testMultilineAttributesOnParameter */', - 'position' => 4, - 'tokenCodes' => [ - T_WHITESPACE, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_WHITESPACE, - T_WHITESPACE, - T_CONSTANT_ENCAPSED_STRING, - T_WHITESPACE, - T_WHITESPACE, - T_CLOSE_PARENTHESIS, - T_WHITESPACE, - T_WHITESPACE, - ], - ], - ]; - - }//end dataAttributeOnParameters() - - - /** - * Test that an attribute containing text which looks like a PHP close tag is tokenized correctly. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param array> $expectedTokensAttribute The codes of tokens inside the attributes. - * @param array $expectedTokensAfter The codes of tokens after the attributes. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::parsePhpAttribute - * - * @dataProvider dataAttributeOnTextLookingLikeCloseTag - * - * @return void - */ - public function testAttributeContainingTextLookingLikeCloseTag($testMarker, array $expectedTokensAttribute, array $expectedTokensAfter) - { - $tokens = $this->phpcsFile->getTokens(); - - // Calculate the number of tokens between opener and closer (excluding the opener, including the closer). - $length = count($expectedTokensAttribute); - - $attribute = $this->getTargetToken($testMarker, T_ATTRIBUTE); - - $this->assertSame('T_ATTRIBUTE', $tokens[$attribute]['type']); - $this->assertArrayHasKey('attribute_closer', $tokens[$attribute]); - - $closer = $tokens[$attribute]['attribute_closer']; - $this->assertSame(($attribute + $length), $closer); - $this->assertSame(T_ATTRIBUTE_END, $tokens[$closer]['code']); - $this->assertSame('T_ATTRIBUTE_END', $tokens[$closer]['type']); - - $this->assertSame($tokens[$attribute]['attribute_opener'], $tokens[$closer]['attribute_opener']); - $this->assertSame($tokens[$attribute]['attribute_closer'], $tokens[$closer]['attribute_closer']); - - $i = ($attribute + 1); - foreach ($expectedTokensAttribute as $item) { - list($expectedType, $expectedContents) = $item; - $this->assertSame($expectedType, $tokens[$i]['type']); - $this->assertSame($expectedContents, $tokens[$i]['content']); - $this->assertArrayHasKey('attribute_opener', $tokens[$i]); - $this->assertArrayHasKey('attribute_closer', $tokens[$i]); - ++$i; - } - - $i = ($closer + 1); - foreach ($expectedTokensAfter as $expectedCode) { - $this->assertSame($expectedCode, $tokens[$i]['code']); - ++$i; - } - - }//end testAttributeContainingTextLookingLikeCloseTag() - - - /** - * Data provider. - * - * @see dataAttributeOnTextLookingLikeCloseTag() - * - * @return array>|array>> - */ - public static function dataAttributeOnTextLookingLikeCloseTag() - { - return [ - 'function attribute; string param with "?>"' => [ - 'testMarker' => '/* testAttributeContainingTextLookingLikeCloseTag */', - 'expectedTokensAttribute' => [ - [ - 'T_STRING', - 'DeprecationReason', - ], - [ - 'T_OPEN_PARENTHESIS', - '(', - ], - [ - 'T_CONSTANT_ENCAPSED_STRING', - "'reason: '", - ], - [ - 'T_CLOSE_PARENTHESIS', - ')', - ], - [ - 'T_ATTRIBUTE_END', - ']', - ], - ], - 'expectedTokensAfter' => [ - T_WHITESPACE, - T_FUNCTION, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CLOSE_PARENTHESIS, - T_WHITESPACE, - T_OPEN_CURLY_BRACKET, - T_CLOSE_CURLY_BRACKET, - ], - ], - 'function attribute; string param with "?>"; multiline' => [ - 'testMarker' => '/* testAttributeContainingMultilineTextLookingLikeCloseTag */', - 'expectedTokensAttribute' => [ - [ - 'T_STRING', - 'DeprecationReason', - ], - [ - 'T_OPEN_PARENTHESIS', - '(', - ], - [ - 'T_WHITESPACE', - "\n", - ], - [ - 'T_WHITESPACE', - " ", - ], - [ - 'T_CONSTANT_ENCAPSED_STRING', - "'reason: '", - ], - [ - 'T_WHITESPACE', - "\n", - ], - [ - 'T_CLOSE_PARENTHESIS', - ')', - ], - [ - 'T_ATTRIBUTE_END', - ']', - ], - ], - 'expectedTokensAfter' => [ - T_WHITESPACE, - T_FUNCTION, - T_WHITESPACE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CLOSE_PARENTHESIS, - T_WHITESPACE, - T_OPEN_CURLY_BRACKET, - T_CLOSE_CURLY_BRACKET, - ], - ], - ]; - - }//end dataAttributeOnTextLookingLikeCloseTag() - - - /** - * Test that invalid attribute (or comment starting with #[ and without ]) are parsed correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::findCloser - * @covers PHP_CodeSniffer\Tokenizers\PHP::parsePhpAttribute - * - * @return void - */ - public function testInvalidAttribute() - { - $tokens = $this->phpcsFile->getTokens(); - - $attribute = $this->getTargetToken('/* testInvalidAttribute */', T_ATTRIBUTE); - - $this->assertArrayHasKey('attribute_closer', $tokens[$attribute]); - $this->assertNull($tokens[$attribute]['attribute_closer']); - - }//end testInvalidAttribute() - - - /** - * Test that nested attributes are parsed correctly. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::findCloser - * @covers PHP_CodeSniffer\Tokenizers\PHP::parsePhpAttribute - * @covers PHP_CodeSniffer\Tokenizers\PHP::createAttributesNestingMap - * - * @return void - */ - public function testNestedAttributes() - { - $tokens = $this->phpcsFile->getTokens(); - $tokenCodes = [ - T_STRING, - T_NS_SEPARATOR, - T_STRING, - T_OPEN_PARENTHESIS, - T_FN, - T_WHITESPACE, - T_OPEN_PARENTHESIS, - T_ATTRIBUTE, - T_STRING, - T_OPEN_PARENTHESIS, - T_CONSTANT_ENCAPSED_STRING, - T_CLOSE_PARENTHESIS, - T_ATTRIBUTE_END, - T_WHITESPACE, - T_VARIABLE, - T_CLOSE_PARENTHESIS, - T_WHITESPACE, - T_FN_ARROW, - T_WHITESPACE, - T_STRING_CAST, - T_WHITESPACE, - T_VARIABLE, - T_CLOSE_PARENTHESIS, - ]; - - // Calculate the number of tokens between opener and closer (excluding the opener, including the closer). - $outerAttributeLength = (count($tokenCodes) + 1); - - $attribute = $this->getTargetToken('/* testNestedAttributes */', T_ATTRIBUTE); - $this->assertArrayHasKey('attribute_closer', $tokens[$attribute]); - - $closer = $tokens[$attribute]['attribute_closer']; - $this->assertSame(($attribute + $outerAttributeLength), $closer); - - $this->assertSame(T_ATTRIBUTE_END, $tokens[$closer]['code']); - - $this->assertSame($tokens[$attribute]['attribute_opener'], $tokens[$closer]['attribute_opener']); - $this->assertSame($tokens[$attribute]['attribute_closer'], $tokens[$closer]['attribute_closer']); - - $this->assertArrayNotHasKey('nested_attributes', $tokens[$attribute]); - $this->assertArrayHasKey('nested_attributes', $tokens[($attribute + 8)]); - $this->assertSame([$attribute => ($attribute + $outerAttributeLength)], $tokens[($attribute + 8)]['nested_attributes']); - - $test = function (array $tokens, $outerAttributeLength, $nestedMap) use ($attribute) { - foreach ($tokens as $token) { - $this->assertArrayHasKey('attribute_closer', $token); - $this->assertSame(($attribute + $outerAttributeLength), $token['attribute_closer']); - $this->assertSame($nestedMap, $token['nested_attributes']); - } - }; - - // Length here is 8 (nested attribute offset) + 5 (real length). - $innerAttributeLength = (8 + 5); - - $test(array_slice($tokens, ($attribute + 1), 7), $outerAttributeLength, [$attribute => $attribute + $outerAttributeLength]); - $test(array_slice($tokens, ($attribute + 8), 1), $innerAttributeLength, [$attribute => $attribute + $outerAttributeLength]); - - $test( - array_slice($tokens, ($attribute + 9), 4), - $innerAttributeLength, - [ - $attribute => $attribute + $outerAttributeLength, - $attribute + 8 => $attribute + 13, - ] - ); - - $test(array_slice($tokens, ($attribute + 13), 1), $innerAttributeLength, [$attribute => $attribute + $outerAttributeLength]); - $test(array_slice($tokens, ($attribute + 14), 10), $outerAttributeLength, [$attribute => $attribute + $outerAttributeLength]); - - $map = array_map( - static function ($token) { - return $token['code']; - }, - array_slice($tokens, ($attribute + 1), ($outerAttributeLength - 1)) - ); - - $this->assertSame($tokenCodes, $map); - - }//end testNestedAttributes() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillAsymmetricVisibilityTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillAsymmetricVisibilityTest.inc deleted file mode 100644 index aaf050ad5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillAsymmetricVisibilityTest.inc +++ /dev/null @@ -1,60 +0,0 @@ - - * @copyright 2025 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Tests the support of PHP 8.4 asymmetric visibility. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - */ -final class BackfillAsymmetricVisibilityTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the asymmetric visibility keywords are tokenized as such. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $testType The expected token type - * @param string $testContent The token content to look for - * - * @dataProvider dataAsymmetricVisibility - * - * @return void - */ - public function testAsymmetricVisibility($testMarker, $testType, $testContent) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken( - $testMarker, - [ - T_PUBLIC_SET, - T_PROTECTED_SET, - T_PRIVATE_SET, - ] - ); - $tokenArray = $tokens[$target]; - - $this->assertSame( - $testType, - $tokenArray['type'], - 'Token tokenized as '.$tokenArray['type'].' (type)' - ); - $this->assertSame( - constant($testType), - $tokenArray['code'], - 'Token tokenized as '.$tokenArray['type'].' (code)' - ); - $this->assertSame( - $testContent, - $tokenArray['content'], - 'Token tokenized as '.$tokenArray['type'].' (content)' - ); - - }//end testAsymmetricVisibility() - - - /** - * Data provider. - * - * @see testAsymmetricVisibility() - * - * @return array> - */ - public static function dataAsymmetricVisibility() - { - return [ - // Normal property declarations. - 'property, public set, no read visibility, lowercase' => [ - 'testMarker' => '/* testPublicSetProperty */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'public(set)', - ], - 'property, public set, no read visibility, uppercase' => [ - 'testMarker' => '/* testPublicSetPropertyUC */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'PUBLIC(SET)', - ], - 'property, public set, has read visibility, lowercase' => [ - 'testMarker' => '/* testPublicPublicSetProperty */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'public(set)', - ], - 'property, public set, has read visibility, uppercase' => [ - 'testMarker' => '/* testPublicPublicSetPropertyUC */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'PUBLIC(SET)', - ], - 'property, protected set, no read visibility, lowercase' => [ - 'testMarker' => '/* testProtectedSetProperty */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'protected(set)', - ], - 'property, protected set, no read visibility, uppercase' => [ - 'testMarker' => '/* testProtectedSetPropertyUC */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'PROTECTED(SET)', - ], - 'property, protected set, has read visibility, lowercase' => [ - 'testMarker' => '/* testPublicProtectedSetProperty */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'protected(set)', - ], - 'property, protected set, has read visibility, uppercase' => [ - 'testMarker' => '/* testPublicProtectedSetPropertyUC */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'PROTECTED(SET)', - ], - 'property, private set, no read visibility, lowercase' => [ - 'testMarker' => '/* testPrivateSetProperty */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'private(set)', - ], - 'property, private set, no read visibility, uppercase' => [ - 'testMarker' => '/* testPrivateSetPropertyUC */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'PRIVATE(SET)', - ], - 'property, private set, has read visibility, lowercase' => [ - 'testMarker' => '/* testPublicPrivateSetProperty */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'private(set)', - ], - 'property, private set, has read visibility, uppercase' => [ - 'testMarker' => '/* testPublicPrivateSetPropertyUC */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'PRIVATE(SET)', - ], - - // Constructor property promotion. - 'promotion, public set, no read visibility, lowercase' => [ - 'testMarker' => '/* testPublicSetCPP */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'public(set)', - ], - 'promotion, public set, no read visibility, uppercase' => [ - 'testMarker' => '/* testPublicSetCPPUC */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'PUBLIC(SET)', - ], - 'promotion, public set, has read visibility, lowercase' => [ - 'testMarker' => '/* testPublicPublicSetCPP */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'public(set)', - ], - 'promotion, public set, has read visibility, uppercase' => [ - 'testMarker' => '/* testPublicPublicSetCPPUC */', - 'testType' => 'T_PUBLIC_SET', - 'testContent' => 'PUBLIC(SET)', - ], - 'promotion, protected set, no read visibility, lowercase' => [ - 'testMarker' => '/* testProtectedSetCPP */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'protected(set)', - ], - 'promotion, protected set, no read visibility, uppercase' => [ - 'testMarker' => '/* testProtectedSetCPPUC */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'PROTECTED(SET)', - ], - 'promotion, protected set, has read visibility, lowercase' => [ - 'testMarker' => '/* testPublicProtectedSetCPP */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'protected(set)', - ], - 'promotion, protected set, has read visibility, uppercase' => [ - 'testMarker' => '/* testPublicProtectedSetCPPUC */', - 'testType' => 'T_PROTECTED_SET', - 'testContent' => 'PROTECTED(SET)', - ], - 'promotion, private set, no read visibility, lowercase' => [ - 'testMarker' => '/* testPrivateSetCPP */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'private(set)', - ], - 'promotion, private set, no read visibility, uppercase' => [ - 'testMarker' => '/* testPrivateSetCPPUC */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'PRIVATE(SET)', - ], - 'promotion, private set, has read visibility, lowercase' => [ - 'testMarker' => '/* testPublicPrivateSetCPP */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'private(set)', - ], - 'promotion, private set, has read visibility, uppercase' => [ - 'testMarker' => '/* testPublicPrivateSetCPPUC */', - 'testType' => 'T_PRIVATE_SET', - 'testContent' => 'PRIVATE(SET)', - ], - ]; - - }//end dataAsymmetricVisibility() - - - /** - * Test that things that are not asymmetric visibility keywords are not - * tokenized as such. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $testType The expected token type - * @param string $testContent The token content to look for - * - * @dataProvider dataNotAsymmetricVisibility - * - * @return void - */ - public function testNotAsymmetricVisibility($testMarker, $testType, $testContent) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken( - $testMarker, - [constant($testType)], - $testContent - ); - $tokenArray = $tokens[$target]; - - $this->assertSame( - $testType, - $tokenArray['type'], - 'Token tokenized as '.$tokenArray['type'].' (type)' - ); - $this->assertSame( - constant($testType), - $tokenArray['code'], - 'Token tokenized as '.$tokenArray['type'].' (code)' - ); - - }//end testNotAsymmetricVisibility() - - - /** - * Data provider. - * - * @see testNotAsymmetricVisibility() - * - * @return array> - */ - public static function dataNotAsymmetricVisibility() - { - return [ - 'property, invalid case 1' => [ - 'testMarker' => '/* testInvalidUnsetProperty */', - 'testType' => 'T_PUBLIC', - 'testContent' => 'public', - ], - 'property, invalid case 2' => [ - 'testMarker' => '/* testInvalidSpaceProperty */', - 'testType' => 'T_PUBLIC', - 'testContent' => 'public', - ], - 'property, invalid case 3' => [ - 'testMarker' => '/* testInvalidCommentProperty */', - 'testType' => 'T_PROTECTED', - 'testContent' => 'protected', - ], - 'property, invalid case 4' => [ - 'testMarker' => '/* testInvalidGetProperty */', - 'testType' => 'T_PRIVATE', - 'testContent' => 'private', - ], - 'property, invalid case 5' => [ - 'testMarker' => '/* testInvalidNoParenProperty */', - 'testType' => 'T_PRIVATE', - 'testContent' => 'private', - ], - - // Constructor property promotion. - 'promotion, invalid case 1' => [ - 'testMarker' => '/* testInvalidUnsetCPP */', - 'testType' => 'T_PUBLIC', - 'testContent' => 'public', - ], - 'promotion, invalid case 2' => [ - 'testMarker' => '/* testInvalidSpaceCPP */', - 'testType' => 'T_PUBLIC', - 'testContent' => 'public', - ], - 'promotion, invalid case 3' => [ - 'testMarker' => '/* testInvalidCommentCPP */', - 'testType' => 'T_PROTECTED', - 'testContent' => 'protected', - ], - 'promotion, invalid case 4' => [ - 'testMarker' => '/* testInvalidGetCPP */', - 'testType' => 'T_PRIVATE', - 'testContent' => 'private', - ], - 'promotion, invalid case 5' => [ - 'testMarker' => '/* testInvalidNoParenCPP */', - 'testType' => 'T_PRIVATE', - 'testContent' => 'private', - ], - - // Context sensitivitiy. - 'protected as function name' => [ - 'testMarker' => '/* testProtectedFunctionName */', - 'testType' => 'T_STRING', - 'testContent' => 'protected', - ], - 'public as function name' => [ - 'testMarker' => '/* testPublicFunctionName */', - 'testType' => 'T_STRING', - 'testContent' => 'public', - ], - 'set as parameter type' => [ - 'testMarker' => '/* testSetParameterType */', - 'testType' => 'T_STRING', - 'testContent' => 'Set', - ], - - // Live coding. - 'live coding' => [ - 'testMarker' => '/* testLiveCoding */', - 'testType' => 'T_PRIVATE', - 'testContent' => 'private', - ], - ]; - - }//end dataNotAsymmetricVisibility() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillEnumTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillEnumTest.inc deleted file mode 100644 index 16624ecce..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillEnumTest.inc +++ /dev/null @@ -1,91 +0,0 @@ -enum = 'foo'; - } -} - -/* testEnumUsedAsFunctionName */ -function enum() -{ -} - -/* testDeclarationContainingComment */ -enum /* comment */ Name -{ - case SOME_CASE; -} - -/* testEnumUsedAsNamespaceName */ -namespace Enum; -/* testEnumUsedAsPartOfNamespaceName */ -namespace My\Enum\Collection; -/* testEnumUsedInObjectInitialization */ -$obj = new Enum; -/* testEnumAsFunctionCall */ -$var = enum($a, $b); -/* testEnumAsFunctionCallWithNamespace */ -var = namespace\enum(); -/* testClassConstantFetchWithEnumAsClassName */ -echo Enum::CONSTANT; -/* testClassConstantFetchWithEnumAsConstantName */ -echo ClassName::ENUM; - -/* testParseErrorMissingName */ -enum { - case SOME_CASE; -} - -/* testParseErrorLiveCoding */ -// This must be the last test in the file. -enum diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillEnumTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillEnumTest.php deleted file mode 100644 index 9b313ca69..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillEnumTest.php +++ /dev/null @@ -1,226 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class BackfillEnumTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the "enum" keyword is tokenized as such. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $testContent The token content to look for. - * @param int $openerOffset Offset to find expected scope opener. - * @param int $closerOffset Offset to find expected scope closer. - * - * @dataProvider dataEnums - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testEnums($testMarker, $testContent, $openerOffset, $closerOffset) - { - $tokens = $this->phpcsFile->getTokens(); - $enum = $this->getTargetToken($testMarker, [T_ENUM, T_STRING], $testContent); - $tokenArray = $tokens[$enum]; - - $this->assertSame(T_ENUM, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM (code)'); - $this->assertSame('T_ENUM', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM (type)'); - - $this->assertArrayHasKey('scope_condition', $tokenArray); - $this->assertArrayHasKey('scope_opener', $tokenArray); - $this->assertArrayHasKey('scope_closer', $tokenArray); - - $this->assertSame($enum, $tokenArray['scope_condition']); - - $scopeOpener = $tokenArray['scope_opener']; - $scopeCloser = $tokenArray['scope_closer']; - - $expectedScopeOpener = ($enum + $openerOffset); - $expectedScopeCloser = ($enum + $closerOffset); - - $this->assertSame($expectedScopeOpener, $scopeOpener); - $this->assertArrayHasKey('scope_condition', $tokens[$scopeOpener]); - $this->assertArrayHasKey('scope_opener', $tokens[$scopeOpener]); - $this->assertArrayHasKey('scope_closer', $tokens[$scopeOpener]); - $this->assertSame($enum, $tokens[$scopeOpener]['scope_condition']); - $this->assertSame($scopeOpener, $tokens[$scopeOpener]['scope_opener']); - $this->assertSame($scopeCloser, $tokens[$scopeOpener]['scope_closer']); - - $this->assertSame($expectedScopeCloser, $scopeCloser); - $this->assertArrayHasKey('scope_condition', $tokens[$scopeCloser]); - $this->assertArrayHasKey('scope_opener', $tokens[$scopeCloser]); - $this->assertArrayHasKey('scope_closer', $tokens[$scopeCloser]); - $this->assertSame($enum, $tokens[$scopeCloser]['scope_condition']); - $this->assertSame($scopeOpener, $tokens[$scopeCloser]['scope_opener']); - $this->assertSame($scopeCloser, $tokens[$scopeCloser]['scope_closer']); - - }//end testEnums() - - - /** - * Data provider. - * - * @see testEnums() - * - * @return array> - */ - public static function dataEnums() - { - return [ - 'enum - pure' => [ - 'testMarker' => '/* testPureEnum */', - 'testContent' => 'enum', - 'openerOffset' => 4, - 'closerOffset' => 12, - ], - 'enum - backed int' => [ - 'testMarker' => '/* testBackedIntEnum */', - 'testContent' => 'enum', - 'openerOffset' => 7, - 'closerOffset' => 29, - ], - 'enum - backed string' => [ - 'testMarker' => '/* testBackedStringEnum */', - 'testContent' => 'enum', - 'openerOffset' => 8, - 'closerOffset' => 30, - ], - 'enum - backed int + implements' => [ - 'testMarker' => '/* testComplexEnum */', - 'testContent' => 'enum', - 'openerOffset' => 11, - 'closerOffset' => 72, - ], - 'enum keyword when "enum" is the name for the construct (yes, this is allowed)' => [ - 'testMarker' => '/* testEnumWithEnumAsClassName */', - 'testContent' => 'enum', - 'openerOffset' => 6, - 'closerOffset' => 7, - ], - 'enum - keyword is case insensitive' => [ - 'testMarker' => '/* testEnumIsCaseInsensitive */', - 'testContent' => 'EnUm', - 'openerOffset' => 4, - 'closerOffset' => 5, - ], - 'enum - declaration containing comment' => [ - 'testMarker' => '/* testDeclarationContainingComment */', - 'testContent' => 'enum', - 'openerOffset' => 6, - 'closerOffset' => 14, - ], - ]; - - }//end dataEnums() - - - /** - * Test that "enum" when not used as the keyword is still tokenized as `T_STRING`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $testContent The token content to look for. - * - * @dataProvider dataNotEnums - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNotEnums($testMarker, $testContent) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_ENUM, T_STRING], $testContent); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testNotEnums() - - - /** - * Data provider. - * - * @see testNotEnums() - * - * @return array> - */ - public static function dataNotEnums() - { - return [ - 'not enum - construct named enum' => [ - 'testMarker' => '/* testEnumAsClassNameAfterEnumKeyword */', - 'testContent' => 'Enum', - ], - 'not enum - class named enum' => [ - 'testMarker' => '/* testEnumUsedAsClassName */', - 'testContent' => 'Enum', - ], - 'not enum - class constant named enum' => [ - 'testMarker' => '/* testEnumUsedAsClassConstantName */', - 'testContent' => 'ENUM', - ], - 'not enum - method named enum' => [ - 'testMarker' => '/* testEnumUsedAsMethodName */', - 'testContent' => 'enum', - ], - 'not enum - class property named enum' => [ - 'testMarker' => '/* testEnumUsedAsPropertyName */', - 'testContent' => 'enum', - ], - 'not enum - global function named enum' => [ - 'testMarker' => '/* testEnumUsedAsFunctionName */', - 'testContent' => 'enum', - ], - 'not enum - namespace named enum' => [ - 'testMarker' => '/* testEnumUsedAsNamespaceName */', - 'testContent' => 'Enum', - ], - 'not enum - part of namespace named enum' => [ - 'testMarker' => '/* testEnumUsedAsPartOfNamespaceName */', - 'testContent' => 'Enum', - ], - 'not enum - class instantiation for class enum' => [ - 'testMarker' => '/* testEnumUsedInObjectInitialization */', - 'testContent' => 'Enum', - ], - 'not enum - function call' => [ - 'testMarker' => '/* testEnumAsFunctionCall */', - 'testContent' => 'enum', - ], - 'not enum - namespace relative function call' => [ - 'testMarker' => '/* testEnumAsFunctionCallWithNamespace */', - 'testContent' => 'enum', - ], - 'not enum - class constant fetch with enum as class name' => [ - 'testMarker' => '/* testClassConstantFetchWithEnumAsClassName */', - 'testContent' => 'Enum', - ], - 'not enum - class constant fetch with enum as constant name' => [ - 'testMarker' => '/* testClassConstantFetchWithEnumAsConstantName */', - 'testContent' => 'ENUM', - ], - 'parse error, not enum - enum declaration without name' => [ - 'testMarker' => '/* testParseErrorMissingName */', - 'testContent' => 'enum', - ], - 'parse error, not enum - enum declaration with curlies' => [ - 'testMarker' => '/* testParseErrorLiveCoding */', - 'testContent' => 'enum', - ], - ]; - - }//end dataNotEnums() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillExplicitOctalNotationTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillExplicitOctalNotationTest.inc deleted file mode 100644 index eb907ed39..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillExplicitOctalNotationTest.inc +++ /dev/null @@ -1,31 +0,0 @@ - - * @copyright 2019 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class BackfillExplicitOctalNotationTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that explicitly-defined octal values are tokenized as a single number and not as a number and a string. - * - * @param string $marker The comment which prefaces the target token in the test file. - * @param string $value The expected content of the token. - * @param int|string $nextToken The expected next token. - * @param string $nextContent The expected content of the next token. - * - * @dataProvider dataExplicitOctalNotation - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testExplicitOctalNotation($marker, $value, $nextToken, $nextContent) - { - $tokens = $this->phpcsFile->getTokens(); - - $number = $this->getTargetToken($marker, [T_LNUMBER]); - - $this->assertSame($value, $tokens[$number]['content'], 'Content of integer token does not match expectation'); - - $this->assertSame($nextToken, $tokens[($number + 1)]['code'], 'Next token is not the expected type, but '.$tokens[($number + 1)]['type']); - $this->assertSame($nextContent, $tokens[($number + 1)]['content'], 'Next token did not have the expected contents'); - - }//end testExplicitOctalNotation() - - - /** - * Data provider. - * - * @see testExplicitOctalNotation() - * - * @return array> - */ - public static function dataExplicitOctalNotation() - { - return [ - 'Explicit octal' => [ - 'marker' => '/* testExplicitOctal */', - 'value' => '0o137041', - 'nextToken' => T_SEMICOLON, - 'nextContent' => ';', - ], - 'Explicit octal - capitalized O' => [ - 'marker' => '/* testExplicitOctalCapitalised */', - 'value' => '0O137041', - 'nextToken' => T_SEMICOLON, - 'nextContent' => ';', - ], - 'Explicit octal - with numeric literal separator' => [ - 'marker' => '/* testExplicitOctalWithNumericSeparator */', - 'value' => '0o137_041', - 'nextToken' => T_SEMICOLON, - 'nextContent' => ';', - ], - 'Invalid explicit octal - numeric literal separator directly after "0o"' => [ - 'marker' => '/* testInvalid1 */', - 'value' => '0', - 'nextToken' => T_STRING, - 'nextContent' => 'o_137', - ], - 'Invalid explicit octal - numeric literal separator directly after "0O" (capitalized O)' => [ - 'marker' => '/* testInvalid2 */', - 'value' => '0', - 'nextToken' => T_STRING, - 'nextContent' => 'O_41', - ], - 'Invalid explicit octal - number out of octal range' => [ - 'marker' => '/* testInvalid3 */', - 'value' => '0', - 'nextToken' => T_STRING, - 'nextContent' => 'o91', - ], - 'Invalid explicit octal - part of the number out of octal range' => [ - 'marker' => '/* testInvalid4 */', - 'value' => '0O2', - 'nextToken' => T_LNUMBER, - 'nextContent' => '82', - ], - 'Invalid explicit octal - part of the number out of octal range with numeric literal separator after' => [ - 'marker' => '/* testInvalid5 */', - 'value' => '0o2', - 'nextToken' => T_LNUMBER, - 'nextContent' => '8_2', - ], - 'Invalid explicit octal - part of the number out of octal range with numeric literal separator before' => [ - 'marker' => '/* testInvalid6 */', - 'value' => '0o2', - 'nextToken' => T_STRING, - 'nextContent' => '_82', - ], - 'Invalid explicit octal - explicit notation without number' => [ - 'marker' => '/* testInvalid7 */', - 'value' => '0', - 'nextToken' => T_STRING, - 'nextContent' => 'o', - ], - ]; - - }//end dataExplicitOctalNotation() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenParseErrorTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenParseErrorTest.inc deleted file mode 100644 index ce247e991..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenParseErrorTest.inc +++ /dev/null @@ -1,5 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class BackfillFnTokenParseErrorTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify that un unfinished arrow function during live coding doesn't cause a "Undefined array key "parenthesis_closer"" error. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testUnfinishedArrowFunction() - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken('/* testLiveCoding */', [T_STRING, T_FN], 'fn'); - $tokenArray = $tokens[$token]; - - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING'); - - $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); - $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); - $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); - $this->assertArrayNotHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is set'); - $this->assertArrayNotHasKey('parenthesis_opener', $tokenArray, 'Parenthesis opener is set'); - $this->assertArrayNotHasKey('parenthesis_closer', $tokenArray, 'Parenthesis closer is set'); - - }//end testUnfinishedArrowFunction() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenTest.inc deleted file mode 100644 index 8930d4fbf..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenTest.inc +++ /dev/null @@ -1,228 +0,0 @@ - $x + $y; - -/* testMixedCase */ -$fn1 = Fn($x) => $x + $y; - -/* testWhitespace */ -$fn1 = fn ($x) => $x + $y; - -/* testComment */ -$fn1 = fn /* comment here */ ($x) => $x + $y; - -/* testHeredoc */ -$fn1 = fn() => << /* testNestedInner */ fn($y) => $x * $y + $z; - -/* testNestedSharedCloserOuter */ -$foo = foo(fn() => /* testNestedSharedCloserInner */ fn() => bar() === true); - -/* testFunctionCall */ -$extended = fn($c) => $callable($factory($c), $c); - -/* testChainedFunctionCall */ -$result = Collection::from([1, 2]) - ->map(fn($v) => $v * 2) - ->reduce(/* testFunctionArgument */ fn($tmp, $v) => $tmp + $v, 0); - -/* testClosure */ -$extended = fn($c) => $callable(function() { - for ($x = 1; $x < 10; $x++) { - echo $x; - } - - echo 'done'; -}, $c); - -/* testArrayIndex */ -$found = in_array_cb($needle, $haystack, fn($array, $needle) => $array[2] === $needle); - -$result = array_map( - /* testReturnType */ - static fn(int $number) : int => $number + 1, - $numbers -); - -/* testReference */ -fn&($x) => $x; - -/* testGrouped */ -(fn($x) => $x) + $y; - -/* testArrayValue */ -$a = [ - 'a' => fn() => return 1, -]; - -/* testArrayValueNoTrailingComma */ -$a = [ - 'a' => fn() => foo() -]; - -/* testYield */ -$a = fn($x) => yield 'k' => $x; - -/* testNullableUnqualifiedClassName */ -$a = fn(?\DateTime $x) : ?\DateTime => $x; - -/* testNamespaceRelativeClassNameInTypes */ -$fn = fn(namespace\Foo $a) : ?namespace\Foo => $a; - -/* testSelfReturnType */ -fn(self $a) : self => $a; - -/* testParentReturnType */ -fn(parent $a) : parent => $a; - -/* testCallableReturnType */ -fn(callable $a) : callable => $a; - -/* testArrayReturnType */ -fn(array $a) : array => $a; - -/* testStaticReturnType */ -fn(array $a) : static => $a; - -/* testFalseReturnType */ -fn(array $a) : false => $a; - -/* testTrueReturnType */ -fn(array $a) : True => $a; - -/* testNullReturnType */ -fn(array $a) : null => $a; - -/* testUnionParamType */ -$arrowWithUnionParam = fn(int|float $param) : SomeClass => new SomeClass($param); - -/* testUnionReturnType */ -$arrowWithUnionReturn = fn($param) : int|float => $param | 10; - -/* testUnionReturnTypeWithTrue */ -$arrowWithUnionReturn = fn($param) : int|true => $param | 10; - -/* testUnionReturnTypeWithFalse */ -$arrowWithUnionReturn = fn($param) : string|FALSE => $param | 10; - -/* testIntersectionParamType */ -$arrowWithIntersectionParam = fn(Traversable&Countable $param) : int => (new SomeClass($param))->getValue(); - -/* testIntersectionReturnType */ -$arrowWithIntersectionReturn = fn($param) : \MyFoo&SomeInterface => new SomeClass($param); - -/* testDNFParamType */ -$arrowWithDNFParam = fn((Traversable&Countable)|null $param) : SomeClass => new SomeClass($param) ?? null; - -/* testDNFReturnType */ -$arrowWithDNFReturn = fn($param) : false|(\MyFoo&SomeInterface) => new \MyFoo($param) ?? false; - -/* testDNFParamTypeWithReturnByRef */ -$arrowWithDNFParamReturnByRef = fn &((A&B)|null $param) => $param * 10; - -/* testTernary */ -$fn = fn($a) => $a ? /* testTernaryThen */ fn() : string => 'a' : /* testTernaryElse */ fn() : string => 'b'; - -/* testTernaryWithTypes */ -$fn = fn(int|null $a) : array|null => $a ? null : []; - -function matchInArrow($x) { - /* testWithMatchValue */ - $fn = fn($x) => match(true) { - 1, 2, 3, 4, 5 => 'foo', - default => 'bar', - }; -} - -function matchInArrowAndMore($x) { - /* testWithMatchValueAndMore */ - $fn = fn($x) => match(true) { - 1, 2, 3, 4, 5 => 'foo', - default => 'bar', - } . 'suffix'; -} - -function arrowFunctionInMatchWithTrailingComma($x) { - return match ($x) { - /* testInMatchNotLastValue */ - 1 => fn($y) => callMe($y), - /* testInMatchLastValueWithTrailingComma */ - default => fn($y) => callThem($y), - }; -} - -function arrowFunctionInMatchNoTrailingComma1($x) { - return match ($x) { - 1 => fn($y) => callMe($y), - /* testInMatchLastValueNoTrailingComma1 */ - default => fn($y) => callThem($y) - }; -} - -function arrowFunctionInMatchNoTrailingComma2($x) { - return match ($x) { - /* testInMatchLastValueNoTrailingComma2 */ - default => fn($y) => 5 * $y - }; -} - -/* testConstantDeclaration */ -const FN = 'a'; - -/* testConstantDeclarationLower */ -const fn = 'a'; - -class Foo { - /* testStaticMethodName */ - public static function fn($param) { - /* testNestedInMethod */ - $fn = fn($c) => $callable($factory($c), $c); - } - - public function foo() { - /* testPropertyAssignment */ - $this->fn = 'a'; - } -} - -$anon = new class() { - /* testAnonClassMethodName */ - protected function fN($param) { - } -} - -/* testNonArrowStaticMethodCall */ -$a = Foo::fn($param); - -/* testNonArrowConstantAccess */ -$a = MyClass::FN; - -/* testNonArrowConstantAccessMixed */ -$a = MyClass::Fn; - -/* testNonArrowObjectMethodCall */ -$a = $obj->fn($param); - -/* testNonArrowObjectMethodCallUpper */ -$a = $obj->FN($param); - -/* testNonArrowNamespacedFunctionCall */ -$a = MyNS\Sub\Fn($param); - -/* testNonArrowNamespaceOperatorFunctionCall */ -$a = namespace\fn($param); - -/* testNonArrowFunctionNameWithUnionTypes */ -function fn(int|float $param) : string|null {} - -/* testLiveCoding */ -// Intentional parse error. This has to be the last test in the file. -$fn = fn diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenTest.php deleted file mode 100644 index e265650ff..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillFnTokenTest.php +++ /dev/null @@ -1,967 +0,0 @@ - - * @copyright 2019 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class BackfillFnTokenTest extends AbstractTokenizerTestCase -{ - - - /** - * Test simple arrow functions. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataSimple - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testSimple($testMarker) - { - $token = $this->getTargetToken($testMarker, T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 12); - - }//end testSimple() - - - /** - * Data provider. - * - * @see testSimple() - * - * @return array> - */ - public static function dataSimple() - { - return [ - 'standard' => [ - 'testMarker' => '/* testStandard */', - ], - 'mixed case' => [ - 'testMarker' => '/* testMixedCase */', - ], - ]; - - }//end dataSimple() - - - /** - * Test whitespace inside arrow function definitions. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testWhitespace() - { - $token = $this->getTargetToken('/* testWhitespace */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 6, 13); - - }//end testWhitespace() - - - /** - * Test comments inside arrow function definitions. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testComment() - { - $token = $this->getTargetToken('/* testComment */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 8, 15); - - }//end testComment() - - - /** - * Test heredocs inside arrow function definitions. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testHeredoc() - { - $token = $this->getTargetToken('/* testHeredoc */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 4, 9); - - }//end testHeredoc() - - - /** - * Test nested arrow functions. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNestedOuter() - { - $token = $this->getTargetToken('/* testNestedOuter */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 25); - - }//end testNestedOuter() - - - /** - * Test nested arrow functions. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNestedInner() - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken('/* testNestedInner */', T_FN); - $this->backfillHelper($token, true); - - $expectedScopeOpener = ($token + 5); - $expectedScopeCloser = ($token + 16); - - $this->assertSame($expectedScopeOpener, $tokens[$token]['scope_opener'], 'Scope opener is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$token]['scope_closer'], 'Scope closer is not the semicolon token'); - - $opener = $tokens[$token]['scope_opener']; - $this->assertSame($expectedScopeOpener, $tokens[$opener]['scope_opener'], 'Opener scope opener is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$opener]['scope_closer'], 'Opener scope closer is not the semicolon token'); - - $closer = $tokens[$token]['scope_closer']; - $this->assertSame(($token - 4), $tokens[$closer]['scope_opener'], 'Closer scope opener is not the arrow token of the "outer" arrow function (shared scope closer)'); - $this->assertSame($expectedScopeCloser, $tokens[$closer]['scope_closer'], 'Closer scope closer is not the semicolon token'); - - }//end testNestedInner() - - - /** - * Test nested arrow functions with a shared closer. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNestedSharedCloser() - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken('/* testNestedSharedCloserOuter */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 4, 20); - - $token = $this->getTargetToken('/* testNestedSharedCloserInner */', T_FN); - $this->backfillHelper($token, true); - - $expectedScopeOpener = ($token + 4); - $expectedScopeCloser = ($token + 12); - - $this->assertSame($expectedScopeOpener, $tokens[$token]['scope_opener'], 'Scope opener for "inner" arrow function is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$token]['scope_closer'], 'Scope closer for "inner" arrow function is not the TRUE token'); - - $opener = $tokens[$token]['scope_opener']; - $this->assertSame($expectedScopeOpener, $tokens[$opener]['scope_opener'], 'Opener scope opener for "inner" arrow function is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$opener]['scope_closer'], 'Opener scope closer for "inner" arrow function is not the semicolon token'); - - $closer = $tokens[$token]['scope_closer']; - $this->assertSame(($token - 4), $tokens[$closer]['scope_opener'], 'Closer scope opener for "inner" arrow function is not the arrow token of the "outer" arrow function (shared scope closer)'); - $this->assertSame($expectedScopeCloser, $tokens[$closer]['scope_closer'], 'Closer scope closer for "inner" arrow function is not the TRUE token'); - - }//end testNestedSharedCloser() - - - /** - * Test arrow functions that call functions. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testFunctionCall() - { - $token = $this->getTargetToken('/* testFunctionCall */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 17); - - }//end testFunctionCall() - - - /** - * Test arrow functions that are included in chained calls. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testChainedFunctionCall() - { - $token = $this->getTargetToken('/* testChainedFunctionCall */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 12, 'bracket'); - - }//end testChainedFunctionCall() - - - /** - * Test arrow functions that are used as function arguments. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testFunctionArgument() - { - $token = $this->getTargetToken('/* testFunctionArgument */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 8, 15, 'comma'); - - }//end testFunctionArgument() - - - /** - * Test arrow functions that use closures. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testClosure() - { - $token = $this->getTargetToken('/* testClosure */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 60, 'comma'); - - }//end testClosure() - - - /** - * Test arrow functions using an array index. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testArrayIndex() - { - $token = $this->getTargetToken('/* testArrayIndex */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 8, 17, 'comma'); - - }//end testArrayIndex() - - - /** - * Test arrow functions with a return type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testReturnType() - { - $token = $this->getTargetToken('/* testReturnType */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 11, 18, 'comma'); - - }//end testReturnType() - - - /** - * Test arrow functions that return a reference. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testReference() - { - $token = $this->getTargetToken('/* testReference */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 6, 9); - - }//end testReference() - - - /** - * Test arrow functions that are grouped by parenthesis. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testGrouped() - { - $token = $this->getTargetToken('/* testGrouped */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 8); - - }//end testGrouped() - - - /** - * Test arrow functions that are used as array values. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testArrayValue() - { - $token = $this->getTargetToken('/* testArrayValue */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 4, 9, 'comma'); - - }//end testArrayValue() - - - /** - * Test arrow functions that are used as array values with no trailing comma. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testArrayValueNoTrailingComma() - { - $token = $this->getTargetToken('/* testArrayValueNoTrailingComma */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 4, 8, 'closing parenthesis'); - - }//end testArrayValueNoTrailingComma() - - - /** - * Test arrow functions that use the yield keyword. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testYield() - { - $token = $this->getTargetToken('/* testYield */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 14); - - }//end testYield() - - - /** - * Test arrow functions that use nullable type with unqualified class name. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNullableUnqualifiedClassName() - { - $token = $this->getTargetToken('/* testNullableUnqualifiedClassName */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 15, 18); - - }//end testNullableUnqualifiedClassName() - - - /** - * Test arrow functions that use namespace relative class name in the return type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNamespaceRelativeClassNameInTypes() - { - $token = $this->getTargetToken('/* testNamespaceRelativeClassNameInTypes */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 16, 19); - - }//end testNamespaceRelativeClassNameInTypes() - - - /** - * Test arrow functions that use keyword return types. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataKeywordReturnTypes - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testKeywordReturnTypes($testMarker) - { - $token = $this->getTargetToken($testMarker, T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 11, 14); - - }//end testKeywordReturnTypes() - - - /** - * Data provider. - * - * @see testKeywordReturnTypes() - * - * @return array> - */ - public static function dataKeywordReturnTypes() - { - return [ - 'self' => [ - 'testMarker' => '/* testSelfReturnType */', - ], - 'parent' => [ - 'testMarker' => '/* testParentReturnType */', - ], - 'callable' => [ - 'testMarker' => '/* testCallableReturnType */', - ], - 'array' => [ - 'testMarker' => '/* testArrayReturnType */', - ], - 'static' => [ - 'testMarker' => '/* testStaticReturnType */', - ], - 'false' => [ - 'testMarker' => '/* testFalseReturnType */', - ], - 'true' => [ - 'testMarker' => '/* testTrueReturnType */', - ], - 'null' => [ - 'testMarker' => '/* testNullReturnType */', - ], - ]; - - }//end dataKeywordReturnTypes() - - - /** - * Test arrow function with a union parameter type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testUnionParamType() - { - $token = $this->getTargetToken('/* testUnionParamType */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 13, 21); - - }//end testUnionParamType() - - - /** - * Test arrow function with a union return type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testUnionReturnType() - { - $token = $this->getTargetToken('/* testUnionReturnType */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 11, 18); - - }//end testUnionReturnType() - - - /** - * Test arrow function with a union return type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testUnionReturnTypeWithTrue() - { - $token = $this->getTargetToken('/* testUnionReturnTypeWithTrue */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 11, 18); - - }//end testUnionReturnTypeWithTrue() - - - /** - * Test arrow function with a union return type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testUnionReturnTypeWithFalse() - { - $token = $this->getTargetToken('/* testUnionReturnTypeWithFalse */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 11, 18); - - }//end testUnionReturnTypeWithFalse() - - - /** - * Test arrow function with an intersection parameter type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testIntersectionParamType() - { - $token = $this->getTargetToken('/* testIntersectionParamType */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 13, 27); - - }//end testIntersectionParamType() - - - /** - * Test arrow function with an intersection return type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testIntersectionReturnType() - { - $token = $this->getTargetToken('/* testIntersectionReturnType */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 12, 20); - - }//end testIntersectionReturnType() - - - /** - * Test arrow function with a DNF parameter type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testDNFParamType() - { - $token = $this->getTargetToken('/* testDNFParamType */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 17, 29); - - }//end testDNFParamType() - - - /** - * Test arrow function with a DNF return type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testDNFReturnType() - { - $token = $this->getTargetToken('/* testDNFReturnType */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 16, 29); - - }//end testDNFReturnType() - - - /** - * Test arrow function which returns by reference with a DNF parameter type. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testDNFParamTypeWithReturnByRef() - { - $token = $this->getTargetToken('/* testDNFParamTypeWithReturnByRef */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 15, 22); - - }//end testDNFParamTypeWithReturnByRef() - - - /** - * Test arrow functions used in ternary operators. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testTernary() - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken('/* testTernary */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 40); - - $token = $this->getTargetToken('/* testTernaryThen */', T_FN); - $this->backfillHelper($token); - - $expectedScopeOpener = ($token + 8); - $expectedScopeCloser = ($token + 12); - - $this->assertSame($expectedScopeOpener, $tokens[$token]['scope_opener'], 'Scope opener for THEN is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$token]['scope_closer'], 'Scope closer for THEN is not the semicolon token'); - - $opener = $tokens[$token]['scope_opener']; - $this->assertSame($expectedScopeOpener, $tokens[$opener]['scope_opener'], 'Opener scope opener for THEN is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$opener]['scope_closer'], 'Opener scope closer for THEN is not the semicolon token'); - - $closer = $tokens[$token]['scope_closer']; - $this->assertSame($expectedScopeOpener, $tokens[$closer]['scope_opener'], 'Closer scope opener for THEN is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$closer]['scope_closer'], 'Closer scope closer for THEN is not the semicolon token'); - - $token = $this->getTargetToken('/* testTernaryElse */', T_FN); - $this->backfillHelper($token, true); - - $expectedScopeOpener = ($token + 8); - $expectedScopeCloser = ($token + 11); - - $this->assertSame($expectedScopeOpener, $tokens[$token]['scope_opener'], 'Scope opener for ELSE is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$token]['scope_closer'], 'Scope closer for ELSE is not the semicolon token'); - - $opener = $tokens[$token]['scope_opener']; - $this->assertSame($expectedScopeOpener, $tokens[$opener]['scope_opener'], 'Opener scope opener for ELSE is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$opener]['scope_closer'], 'Opener scope closer for ELSE is not the semicolon token'); - - $closer = $tokens[$token]['scope_closer']; - $this->assertSame(($token - 24), $tokens[$closer]['scope_opener'], 'Closer scope opener for ELSE is not the arrow token of the "outer" arrow function (shared scope closer)'); - $this->assertSame($expectedScopeCloser, $tokens[$closer]['scope_closer'], 'Closer scope closer for ELSE is not the semicolon token'); - - }//end testTernary() - - - /** - * Test typed arrow functions used in ternary operators. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testTernaryWithTypes() - { - $token = $this->getTargetToken('/* testTernaryWithTypes */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 15, 27); - - }//end testTernaryWithTypes() - - - /** - * Test arrow function returning a match control structure. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testWithMatchValue() - { - $token = $this->getTargetToken('/* testWithMatchValue */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 44); - - }//end testWithMatchValue() - - - /** - * Test arrow function returning a match control structure with something behind it. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testWithMatchValueAndMore() - { - $token = $this->getTargetToken('/* testWithMatchValueAndMore */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 48); - - }//end testWithMatchValueAndMore() - - - /** - * Test match control structure returning arrow functions. - * - * @param string $testMarker The comment prefacing the target token. - * @param int $openerOffset The expected offset of the scope opener in relation to the testMarker. - * @param int $closerOffset The expected offset of the scope closer in relation to the testMarker. - * @param string $expectedCloserType The type of token expected for the scope closer. - * @param string $expectedCloserFriendlyName A friendly name for the type of token expected for the scope closer - * to be used in the error message for failing tests. - * - * @dataProvider dataInMatchValue - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testInMatchValue($testMarker, $openerOffset, $closerOffset, $expectedCloserType, $expectedCloserFriendlyName) - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, $openerOffset, $closerOffset, $expectedCloserFriendlyName); - - $this->assertSame($expectedCloserType, $tokens[($token + $closerOffset)]['type'], 'Mismatched scope closer type'); - - }//end testInMatchValue() - - - /** - * Data provider. - * - * @see testInMatchValue() - * - * @return array> - */ - public static function dataInMatchValue() - { - return [ - 'not_last_value' => [ - 'testMarker' => '/* testInMatchNotLastValue */', - 'openerOffset' => 5, - 'closerOffset' => 11, - 'expectedCloserType' => 'T_COMMA', - 'expectedCloserFriendlyName' => 'comma', - ], - 'last_value_with_trailing_comma' => [ - 'testMarker' => '/* testInMatchLastValueWithTrailingComma */', - 'openerOffset' => 5, - 'closerOffset' => 11, - 'expectedCloserType' => 'T_COMMA', - 'expectedCloserFriendlyName' => 'comma', - ], - 'last_value_without_trailing_comma_1' => [ - 'testMarker' => '/* testInMatchLastValueNoTrailingComma1 */', - 'openerOffset' => 5, - 'closerOffset' => 10, - 'expectedCloserType' => 'T_CLOSE_PARENTHESIS', - 'expectedCloserFriendlyName' => 'close parenthesis', - ], - 'last_value_without_trailing_comma_2' => [ - 'testMarker' => '/* testInMatchLastValueNoTrailingComma2 */', - 'openerOffset' => 5, - 'closerOffset' => 11, - 'expectedCloserType' => 'T_VARIABLE', - 'expectedCloserFriendlyName' => '$y variable', - ], - ]; - - }//end dataInMatchValue() - - - /** - * Test arrow function nested within a method declaration. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNestedInMethod() - { - $token = $this->getTargetToken('/* testNestedInMethod */', T_FN); - $this->backfillHelper($token); - $this->scopePositionTestHelper($token, 5, 17); - - }//end testNestedInMethod() - - - /** - * Verify that "fn" keywords which are not arrow functions get tokenized as T_STRING and don't - * have the extra token array indexes. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataNotAnArrowFunction - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNotAnArrowFunction($testMarker, $testContent='fn') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_STRING, T_FN], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING'); - - $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); - $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); - $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); - $this->assertArrayNotHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is set'); - $this->assertArrayNotHasKey('parenthesis_opener', $tokenArray, 'Parenthesis opener is set'); - $this->assertArrayNotHasKey('parenthesis_closer', $tokenArray, 'Parenthesis closer is set'); - - }//end testNotAnArrowFunction() - - - /** - * Data provider. - * - * @see testNotAnArrowFunction() - * - * @return array> - */ - public static function dataNotAnArrowFunction() - { - return [ - 'name of a function, context: declaration' => [ - 'testMarker' => '/* testFunctionName */', - ], - 'name of a constant, context: declaration using "const" keyword - uppercase' => [ - 'testMarker' => '/* testConstantDeclaration */', - 'testContent' => 'FN', - ], - 'name of a constant, context: declaration using "const" keyword - lowercase' => [ - 'testMarker' => '/* testConstantDeclarationLower */', - 'testContent' => 'fn', - ], - 'name of a (static) method, context: declaration' => [ - 'testMarker' => '/* testStaticMethodName */', - ], - 'name of a property, context: property access' => [ - 'testMarker' => '/* testPropertyAssignment */', - ], - 'name of a method, context: declaration in an anon class - mixed case' => [ - 'testMarker' => '/* testAnonClassMethodName */', - 'testContent' => 'fN', - ], - 'name of a method, context: static method call' => [ - 'testMarker' => '/* testNonArrowStaticMethodCall */', - ], - 'name of a constant, context: constant access - uppercase' => [ - 'testMarker' => '/* testNonArrowConstantAccess */', - 'testContent' => 'FN', - ], - 'name of a constant, context: constant access - mixed case' => [ - 'testMarker' => '/* testNonArrowConstantAccessMixed */', - 'testContent' => 'Fn', - ], - 'name of a method, context: method call on object - lowercase' => [ - 'testMarker' => '/* testNonArrowObjectMethodCall */', - ], - 'name of a method, context: method call on object - uppercase' => [ - 'testMarker' => '/* testNonArrowObjectMethodCallUpper */', - 'testContent' => 'FN', - ], - 'name of a (namespaced) function, context: partially qualified function call' => [ - 'testMarker' => '/* testNonArrowNamespacedFunctionCall */', - 'testContent' => 'Fn', - ], - 'name of a (namespaced) function, context: namespace relative function call' => [ - 'testMarker' => '/* testNonArrowNamespaceOperatorFunctionCall */', - ], - 'name of a function, context: declaration with union types for param and return' => [ - 'testMarker' => '/* testNonArrowFunctionNameWithUnionTypes */', - ], - 'unknown - live coding/parse error' => [ - 'testMarker' => '/* testLiveCoding */', - ], - ]; - - }//end dataNotAnArrowFunction() - - - /** - * Helper function to check that all token keys are correctly set for T_FN tokens. - * - * @param int $token The T_FN token to check. - * @param bool $skipScopeCloserCheck Whether to skip the scope closer check. - * This should be set to "true" when testing nested arrow functions, - * where the "inner" arrow function shares a scope closer with the - * "outer" arrow function, as the 'scope_condition' for the scope closer - * of the "inner" arrow function will point to the "outer" arrow function. - * - * @return void - */ - private function backfillHelper($token, $skipScopeCloserCheck=false) - { - $tokens = $this->phpcsFile->getTokens(); - - $this->assertArrayHasKey('scope_condition', $tokens[$token], 'Scope condition is not set'); - $this->assertArrayHasKey('scope_opener', $tokens[$token], 'Scope opener is not set'); - $this->assertArrayHasKey('scope_closer', $tokens[$token], 'Scope closer is not set'); - $this->assertSame($tokens[$token]['scope_condition'], $token, 'Scope condition is not the T_FN token'); - $this->assertArrayHasKey('parenthesis_owner', $tokens[$token], 'Parenthesis owner is not set'); - $this->assertArrayHasKey('parenthesis_opener', $tokens[$token], 'Parenthesis opener is not set'); - $this->assertArrayHasKey('parenthesis_closer', $tokens[$token], 'Parenthesis closer is not set'); - $this->assertSame($tokens[$token]['parenthesis_owner'], $token, 'Parenthesis owner is not the T_FN token'); - - $opener = $tokens[$token]['scope_opener']; - $this->assertArrayHasKey('scope_condition', $tokens[$opener], 'Opener scope condition is not set'); - $this->assertArrayHasKey('scope_opener', $tokens[$opener], 'Opener scope opener is not set'); - $this->assertArrayHasKey('scope_closer', $tokens[$opener], 'Opener scope closer is not set'); - $this->assertSame($tokens[$opener]['scope_condition'], $token, 'Opener scope condition is not the T_FN token'); - $this->assertSame(T_FN_ARROW, $tokens[$opener]['code'], 'Arrow scope opener not tokenized as T_FN_ARROW (code)'); - $this->assertSame('T_FN_ARROW', $tokens[$opener]['type'], 'Arrow scope opener not tokenized as T_FN_ARROW (type)'); - - $closer = $tokens[$token]['scope_closer']; - $this->assertArrayHasKey('scope_condition', $tokens[$closer], 'Closer scope condition is not set'); - $this->assertArrayHasKey('scope_opener', $tokens[$closer], 'Closer scope opener is not set'); - $this->assertArrayHasKey('scope_closer', $tokens[$closer], 'Closer scope closer is not set'); - if ($skipScopeCloserCheck === false) { - $this->assertSame($tokens[$closer]['scope_condition'], $token, 'Closer scope condition is not the T_FN token'); - } - - $opener = $tokens[$token]['parenthesis_opener']; - $this->assertArrayHasKey('parenthesis_owner', $tokens[$opener], 'Opening parenthesis owner is not set'); - $this->assertSame($tokens[$opener]['parenthesis_owner'], $token, 'Opening parenthesis owner is not the T_FN token'); - - $closer = $tokens[$token]['parenthesis_closer']; - $this->assertArrayHasKey('parenthesis_owner', $tokens[$closer], 'Closing parenthesis owner is not set'); - $this->assertSame($tokens[$closer]['parenthesis_owner'], $token, 'Closing parenthesis owner is not the T_FN token'); - - }//end backfillHelper() - - - /** - * Helper function to check that the scope opener/closer positions are correctly set for T_FN tokens. - * - * @param int $token The T_FN token to check. - * @param int $openerOffset The expected offset of the scope opener in relation to - * the fn keyword. - * @param int $closerOffset The expected offset of the scope closer in relation to - * the fn keyword. - * @param string $expectedCloserType Optional. The type of token expected for the scope closer. - * - * @return void - */ - private function scopePositionTestHelper($token, $openerOffset, $closerOffset, $expectedCloserType='semicolon') - { - $tokens = $this->phpcsFile->getTokens(); - $expectedScopeOpener = ($token + $openerOffset); - $expectedScopeCloser = ($token + $closerOffset); - - $this->assertSame($expectedScopeOpener, $tokens[$token]['scope_opener'], 'Scope opener is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$token]['scope_closer'], 'Scope closer is not the '.$expectedCloserType.' token'); - - $opener = $tokens[$token]['scope_opener']; - $this->assertSame($expectedScopeOpener, $tokens[$opener]['scope_opener'], 'Opener scope opener is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$opener]['scope_closer'], 'Opener scope closer is not the '.$expectedCloserType.' token'); - - $closer = $tokens[$token]['scope_closer']; - $this->assertSame($expectedScopeOpener, $tokens[$closer]['scope_opener'], 'Closer scope opener is not the arrow token'); - $this->assertSame($expectedScopeCloser, $tokens[$closer]['scope_closer'], 'Closer scope closer is not the '.$expectedCloserType.' token'); - - }//end scopePositionTestHelper() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.inc deleted file mode 100644 index 095a4d7df..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.inc +++ /dev/null @@ -1,319 +0,0 @@ - 'Zero', - 1 => 'One', - 2 => 'Two', - }; -} - -function matchNoTrailingComma($bool) { - /* testMatchNoTrailingComma */ - echo match ($bool) { - true => "true\n", - false => "false\n" - }; -} - -function matchWithDefault($i) { - /* testMatchWithDefault */ - return match ($i) { - 1 => 1, - 2 => 2, - default => 'default', - }; -} - -function matchExpressionInCondition($i) { - /* testMatchExpressionInCondition */ - return match (true) { - $i >= 50 => '50+', - $i >= 40 => '40-50', - $i >= 30 => '30-40', - $i >= 20 => '20-30', - $i >= 10 => '10-20', - default => '0-10', - }; -} - -function matchMultiCase($day) { - /* testMatchMultiCase */ - return match ($day) { - 1, 7 => false, - 2, 3, 4, 5, 6 => true, - }; -} - -function matchMultiCaseTrailingCommaInCase($bool) { - /* testMatchMultiCaseTrailingCommaInCase */ - echo match ($bool) { - false, - 0, - => "false\n", - true, - 1, - => "true\n", - default, - => "not bool\n", - }; -} - -assert((function () { - /* testMatchInClosureNotLowercase */ - Match ('foo') { - 'foo', 'bar' => false, - 'baz' => 'a', - default => 'b', - }; -})()); - -function matchInArrowFunction($x) { - /* testMatchInArrowFunction */ - $fn = fn($x) => match(true) { - 1, 2, 3, 4, 5 => 'foo', - default => 'bar', - }; -} - -function arrowFunctionInMatchNoTrailingComma($x) { - /* testArrowFunctionInMatchNoTrailingComma */ - return match ($x) { - 1 => fn($y) => callMe($y), - default => fn($y) => callThem($y) - }; -} - -/* testMatchInFunctionCallParamNotLowercase */ -var_dump(MATCH ( 'foo' ) { - 'foo' => dump_and_return('foo'), - 'bar' => dump_and_return('bar'), -}); - -/* testMatchInMethodCallParam */ -Test::usesValue(match(true) { true => $i }); - -/* testMatchDiscardResult */ -match (1) { - 1 => print "Executed\n", -}; - -/* testMatchWithDuplicateConditionsWithComments */ -echo match /*comment*/ ( $value /*comment*/ ) { - // Comment. - 2, 1 => '2, 1', - 1 => 1, - 3 => 3, - 4 => 4, - 5 => 5, -}; - -/* testNestedMatchOuter */ -$x = match ($y) { - /* testNestedMatchInner */ - default => match ($z) { 1 => 1 }, -}; - -/* testMatchInTernaryCondition */ -$x = match ($test) { 1 => 'a', 2 => 'b' } ? - /* testMatchInTernaryThen */ match ($test) { 1 => 'a', 2 => 'b' } : - /* testMatchInTernaryElse */ match ($notTest) { 3 => 'a', 4 => 'b' }; - -/* testMatchInArrayValue */ -$array = array( - match ($test) { 1 => 'a', 2 => 'b' }, -); - -/* testMatchInArrayKey */ -$array = [ - match ($test) { 1 => 'a', 2 => 'b' } => 'dynamic keys, woho!', -]; - -/* testMatchreturningArray */ -$matcher = match ($x) { - 0 => array( 0 => 1, 'a' => 2, 'b' => 3 ), - 1 => [1, 2, 3], - 2 => array( 1, [1, 2, 3], 2, 3), - 3 => [ 0 => 1, 'a' => array(1, 2, 3), 'b' => 2, 3], -}; - -/* testSwitchContainingMatch */ -switch ($something) { - /* testMatchWithDefaultNestedInSwitchCase1 */ - case 'foo': - $var = [1, 2, 3]; - $var = match ($i) { - 1 => 1, - default => 'default', - }; - continue 2; - - /* testMatchWithDefaultNestedInSwitchCase2 */ - case 'bar' ; - $i = callMe($a, $b); - return match ($i) { - 1 => 1, - default => 'default', - }; - - /* testMatchWithDefaultNestedInSwitchDefault */ - default: - echo 'something', match ($i) { - 1 => 1, - default => 'default', - }; - break; -} - -/* testMatchContainingSwitch */ -$x = match ($y) { - 5, 8 => function($z) { - /* testSwitchNestedInMatch1 */ - switch($z) { - case 'a': - $var = [1, 2, 3]; - return 'a'; - /* testSwitchDefaultNestedInMatchCase */ - default: - $i = callMe($a, $b); - return 'default1'; - } - }, - default => function($z) { - /* testSwitchNestedInMatch2 */ - switch($z) { - case 'a'; - $i = callMe($a, $b); - return 'b'; - /* testSwitchDefaultNestedInMatchDefault */ - default; - $var = [1, 2, 3]; - return 'default2'; - } - } -}; - -/* testMatchNoCases */ -// Intentional fatal error. -$x = match (true) {}; - -/* testMatchMultiDefault */ -// Intentional fatal error. -echo match (1) { - default => 'foo', - 1 => 'bar', - 2 => 'baz', - default => 'qux', -}; - -/* testNoMatchStaticMethodCall */ -$a = Foo::match($param); - -/* testNoMatchClassConstantAccess */ -$a = MyClass::MATCH; - -/* testNoMatchClassConstantArrayAccessMixedCase */ -$a = MyClass::Match[$a]; - -/* testNoMatchMethodCall */ -$a = $obj->match($param); - -/* testNoMatchMethodCallUpper */ -$a = $obj??->MATCH()->chain($param); - -/* testNoMatchPropertyAccess */ -$a = $obj->match; - -/* testNoMatchNamespacedFunctionCall */ -// Intentional fatal error. -$a = MyNS\Sub\match($param); - -/* testNoMatchNamespaceOperatorFunctionCall */ -// Intentional fatal error. -$a = namespace\match($param); - -interface MatchInterface { - /* testNoMatchInterfaceMethodDeclaration */ - public static function match($param); -} - -class MatchClass { - /* testNoMatchClassConstantDeclarationLower */ - const match = 'a'; - - /* testNoMatchClassMethodDeclaration */ - public static function match($param) { - /* testNoMatchPropertyAssignment */ - $this->match = 'a'; - } -} - -/* testNoMatchClassInstantiation */ -$obj = new Match(); - -$anon = new class() { - /* testNoMatchAnonClassMethodDeclaration */ - protected function maTCH($param) { - } -}; - -/* testNoMatchClassDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -class Match {} - -/* testNoMatchInterfaceDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -interface Match {} - -/* testNoMatchTraitDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -trait Match {} - -/* testNoMatchConstantDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -const MATCH = '1'; - -/* testNoMatchFunctionDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -function match() {} - -/* testNoMatchNamespaceDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -namespace Match {} - -/* testNoMatchExtendedClassDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -class Foo extends Match {} - -/* testNoMatchImplementedClassDeclaration */ -// Intentional fatal error. Match is now a reserved keyword. -class Bar implements Match {} - -/* testNoMatchInUseStatement */ -// Intentional fatal error in PHP < 8. Match is now a reserved keyword. -use Match\me; - -function brokenMatchNoCurlies($x) { - /* testNoMatchMissingCurlies */ - // Intentional fatal error. New control structure is not supported without curly braces. - return match ($x) - 0 => 'Zero', - 1 => 'One', - 2 => 'Two', - ; -} - -function brokenMatchAlternativeSyntax($x) { - /* testNoMatchAlternativeSyntax */ - // Intentional fatal error. Alternative syntax is not supported. - return match ($x) : - 0 => 'Zero', - 1 => 'One', - 2 => 'Two', - endmatch; -} - -/* testLiveCoding */ -// Intentional parse error. This has to be the last test in the file. -echo match diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.php deleted file mode 100644 index 8214ea1a9..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillMatchTokenTest.php +++ /dev/null @@ -1,555 +0,0 @@ - - * @copyright 2020-2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class BackfillMatchTokenTest extends AbstractTokenizerTestCase -{ - - - /** - * Test tokenization of match expressions. - * - * @param string $testMarker The comment prefacing the target token. - * @param int $openerOffset The expected offset of the scope opener in relation to the testMarker. - * @param int $closerOffset The expected offset of the scope closer in relation to the testMarker. - * @param string $testContent The token content to look for. - * - * @dataProvider dataMatchExpression - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testMatchExpression($testMarker, $openerOffset, $closerOffset, $testContent='match') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_STRING, T_MATCH], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_MATCH, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH (code)'); - $this->assertSame('T_MATCH', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH (type)'); - - $this->scopeTestHelper($token, $openerOffset, $closerOffset); - $this->parenthesisTestHelper($token); - - }//end testMatchExpression() - - - /** - * Data provider. - * - * @see testMatchExpression() - * - * @return array> - */ - public static function dataMatchExpression() - { - return [ - 'simple_match' => [ - 'testMarker' => '/* testMatchSimple */', - 'openerOffset' => 6, - 'closerOffset' => 33, - ], - 'no_trailing_comma' => [ - 'testMarker' => '/* testMatchNoTrailingComma */', - 'openerOffset' => 6, - 'closerOffset' => 24, - ], - 'with_default_case' => [ - 'testMarker' => '/* testMatchWithDefault */', - 'openerOffset' => 6, - 'closerOffset' => 33, - ], - 'expression_in_condition' => [ - 'testMarker' => '/* testMatchExpressionInCondition */', - 'openerOffset' => 6, - 'closerOffset' => 77, - ], - 'multicase' => [ - 'testMarker' => '/* testMatchMultiCase */', - 'openerOffset' => 6, - 'closerOffset' => 40, - ], - 'multicase_trailing_comma_in_case' => [ - 'testMarker' => '/* testMatchMultiCaseTrailingCommaInCase */', - 'openerOffset' => 6, - 'closerOffset' => 47, - ], - 'in_closure_not_lowercase' => [ - 'testMarker' => '/* testMatchInClosureNotLowercase */', - 'openerOffset' => 6, - 'closerOffset' => 36, - 'testContent' => 'Match', - ], - 'in_arrow_function' => [ - 'testMarker' => '/* testMatchInArrowFunction */', - 'openerOffset' => 5, - 'closerOffset' => 36, - ], - 'arrow_function_in_match_no_trailing_comma' => [ - 'testMarker' => '/* testArrowFunctionInMatchNoTrailingComma */', - 'openerOffset' => 6, - 'closerOffset' => 44, - ], - 'in_function_call_param_not_lowercase' => [ - 'testMarker' => '/* testMatchInFunctionCallParamNotLowercase */', - 'openerOffset' => 8, - 'closerOffset' => 32, - 'testContent' => 'MATCH', - ], - 'in_method_call_param' => [ - 'testMarker' => '/* testMatchInMethodCallParam */', - 'openerOffset' => 5, - 'closerOffset' => 13, - ], - 'discard_result' => [ - 'testMarker' => '/* testMatchDiscardResult */', - 'openerOffset' => 6, - 'closerOffset' => 18, - ], - 'duplicate_conditions_and_comments' => [ - 'testMarker' => '/* testMatchWithDuplicateConditionsWithComments */', - 'openerOffset' => 12, - 'closerOffset' => 59, - ], - 'nested_match_outer' => [ - 'testMarker' => '/* testNestedMatchOuter */', - 'openerOffset' => 6, - 'closerOffset' => 33, - ], - 'nested_match_inner' => [ - 'testMarker' => '/* testNestedMatchInner */', - 'openerOffset' => 6, - 'closerOffset' => 14, - ], - 'ternary_condition' => [ - 'testMarker' => '/* testMatchInTernaryCondition */', - 'openerOffset' => 6, - 'closerOffset' => 21, - ], - 'ternary_then' => [ - 'testMarker' => '/* testMatchInTernaryThen */', - 'openerOffset' => 6, - 'closerOffset' => 21, - ], - 'ternary_else' => [ - 'testMarker' => '/* testMatchInTernaryElse */', - 'openerOffset' => 6, - 'closerOffset' => 21, - ], - 'array_value' => [ - 'testMarker' => '/* testMatchInArrayValue */', - 'openerOffset' => 6, - 'closerOffset' => 21, - ], - 'array_key' => [ - 'testMarker' => '/* testMatchInArrayKey */', - 'openerOffset' => 6, - 'closerOffset' => 21, - ], - 'returning_array' => [ - 'testMarker' => '/* testMatchreturningArray */', - 'openerOffset' => 6, - 'closerOffset' => 125, - ], - 'nested_in_switch_case_1' => [ - 'testMarker' => '/* testMatchWithDefaultNestedInSwitchCase1 */', - 'openerOffset' => 6, - 'closerOffset' => 25, - ], - 'nested_in_switch_case_2' => [ - 'testMarker' => '/* testMatchWithDefaultNestedInSwitchCase2 */', - 'openerOffset' => 6, - 'closerOffset' => 25, - ], - 'nested_in_switch_default' => [ - 'testMarker' => '/* testMatchWithDefaultNestedInSwitchDefault */', - 'openerOffset' => 6, - 'closerOffset' => 25, - ], - 'match_with_nested_switch' => [ - 'testMarker' => '/* testMatchContainingSwitch */', - 'openerOffset' => 6, - 'closerOffset' => 180, - ], - 'no_cases' => [ - 'testMarker' => '/* testMatchNoCases */', - 'openerOffset' => 6, - 'closerOffset' => 7, - ], - 'multi_default' => [ - 'testMarker' => '/* testMatchMultiDefault */', - 'openerOffset' => 6, - 'closerOffset' => 40, - ], - ]; - - }//end dataMatchExpression() - - - /** - * Verify that "match" keywords which are not match control structures get tokenized as T_STRING - * and don't have the extra token array indexes. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataNotAMatchStructure - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNotAMatchStructure($testMarker, $testContent='match') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_STRING, T_MATCH], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); - $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); - $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); - $this->assertArrayNotHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is set'); - $this->assertArrayNotHasKey('parenthesis_opener', $tokenArray, 'Parenthesis opener is set'); - $this->assertArrayNotHasKey('parenthesis_closer', $tokenArray, 'Parenthesis closer is set'); - - $next = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($token + 1), null, true); - if ($next !== false && $tokens[$next]['code'] === T_OPEN_PARENTHESIS) { - $this->assertArrayNotHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is set for opener after'); - } - - }//end testNotAMatchStructure() - - - /** - * Data provider. - * - * @see testNotAMatchStructure() - * - * @return array> - */ - public static function dataNotAMatchStructure() - { - return [ - 'static_method_call' => [ - 'testMarker' => '/* testNoMatchStaticMethodCall */', - ], - 'class_constant_access' => [ - 'testMarker' => '/* testNoMatchClassConstantAccess */', - 'testContent' => 'MATCH', - ], - 'class_constant_array_access' => [ - 'testMarker' => '/* testNoMatchClassConstantArrayAccessMixedCase */', - 'testContent' => 'Match', - ], - 'method_call' => [ - 'testMarker' => '/* testNoMatchMethodCall */', - ], - 'method_call_uppercase' => [ - 'testMarker' => '/* testNoMatchMethodCallUpper */', - 'testContent' => 'MATCH', - ], - 'property_access' => [ - 'testMarker' => '/* testNoMatchPropertyAccess */', - ], - 'namespaced_function_call' => [ - 'testMarker' => '/* testNoMatchNamespacedFunctionCall */', - ], - 'namespace_operator_function_call' => [ - 'testMarker' => '/* testNoMatchNamespaceOperatorFunctionCall */', - ], - 'interface_method_declaration' => [ - 'testMarker' => '/* testNoMatchInterfaceMethodDeclaration */', - ], - 'class_constant_declaration' => [ - 'testMarker' => '/* testNoMatchClassConstantDeclarationLower */', - ], - 'class_method_declaration' => [ - 'testMarker' => '/* testNoMatchClassMethodDeclaration */', - ], - 'property_assigment' => [ - 'testMarker' => '/* testNoMatchPropertyAssignment */', - ], - 'class_instantiation' => [ - 'testMarker' => '/* testNoMatchClassInstantiation */', - 'testContent' => 'Match', - ], - 'anon_class_method_declaration' => [ - 'testMarker' => '/* testNoMatchAnonClassMethodDeclaration */', - 'testContent' => 'maTCH', - ], - 'class_declaration' => [ - 'testMarker' => '/* testNoMatchClassDeclaration */', - 'testContent' => 'Match', - ], - 'interface_declaration' => [ - 'testMarker' => '/* testNoMatchInterfaceDeclaration */', - 'testContent' => 'Match', - ], - 'trait_declaration' => [ - 'testMarker' => '/* testNoMatchTraitDeclaration */', - 'testContent' => 'Match', - ], - 'constant_declaration' => [ - 'testMarker' => '/* testNoMatchConstantDeclaration */', - 'testContent' => 'MATCH', - ], - 'function_declaration' => [ - 'testMarker' => '/* testNoMatchFunctionDeclaration */', - ], - 'namespace_declaration' => [ - 'testMarker' => '/* testNoMatchNamespaceDeclaration */', - 'testContent' => 'Match', - ], - 'class_extends_declaration' => [ - 'testMarker' => '/* testNoMatchExtendedClassDeclaration */', - 'testContent' => 'Match', - ], - 'class_implements_declaration' => [ - 'testMarker' => '/* testNoMatchImplementedClassDeclaration */', - 'testContent' => 'Match', - ], - 'use_statement' => [ - 'testMarker' => '/* testNoMatchInUseStatement */', - 'testContent' => 'Match', - ], - 'unsupported_inline_control_structure' => [ - 'testMarker' => '/* testNoMatchMissingCurlies */', - ], - 'unsupported_alternative_syntax' => [ - 'testMarker' => '/* testNoMatchAlternativeSyntax */', - ], - 'live_coding' => [ - 'testMarker' => '/* testLiveCoding */', - ], - ]; - - }//end dataNotAMatchStructure() - - - /** - * Verify that the tokenization of switch structures is not affected by the backfill. - * - * @param string $testMarker The comment prefacing the target token. - * @param int $openerOffset The expected offset of the scope opener in relation to the testMarker. - * @param int $closerOffset The expected offset of the scope closer in relation to the testMarker. - * - * @dataProvider dataSwitchExpression - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testSwitchExpression($testMarker, $openerOffset, $closerOffset) - { - $token = $this->getTargetToken($testMarker, T_SWITCH); - - $this->scopeTestHelper($token, $openerOffset, $closerOffset); - $this->parenthesisTestHelper($token); - - }//end testSwitchExpression() - - - /** - * Data provider. - * - * @see testSwitchExpression() - * - * @return array> - */ - public static function dataSwitchExpression() - { - return [ - 'switch_containing_match' => [ - 'testMarker' => '/* testSwitchContainingMatch */', - 'openerOffset' => 6, - 'closerOffset' => 174, - ], - 'match_containing_switch_1' => [ - 'testMarker' => '/* testSwitchNestedInMatch1 */', - 'openerOffset' => 5, - 'closerOffset' => 63, - ], - 'match_containing_switch_2' => [ - 'testMarker' => '/* testSwitchNestedInMatch2 */', - 'openerOffset' => 5, - 'closerOffset' => 63, - ], - ]; - - }//end dataSwitchExpression() - - - /** - * Verify that the tokenization of a switch case/default structure containing a match structure - * or contained *in* a match structure is not affected by the backfill. - * - * @param string $testMarker The comment prefacing the target token. - * @param int $openerOffset The expected offset of the scope opener in relation to the testMarker. - * @param int $closerOffset The expected offset of the scope closer in relation to the testMarker. - * - * @dataProvider dataSwitchCaseVersusMatch - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testSwitchCaseVersusMatch($testMarker, $openerOffset, $closerOffset) - { - $token = $this->getTargetToken($testMarker, [T_CASE, T_DEFAULT]); - - $this->scopeTestHelper($token, $openerOffset, $closerOffset); - - }//end testSwitchCaseVersusMatch() - - - /** - * Data provider. - * - * @see testSwitchCaseVersusMatch() - * - * @return array> - */ - public static function dataSwitchCaseVersusMatch() - { - return [ - 'switch_with_nested_match_case_1' => [ - 'testMarker' => '/* testMatchWithDefaultNestedInSwitchCase1 */', - 'openerOffset' => 3, - 'closerOffset' => 55, - ], - 'switch_with_nested_match_case_2' => [ - 'testMarker' => '/* testMatchWithDefaultNestedInSwitchCase2 */', - 'openerOffset' => 4, - 'closerOffset' => 21, - ], - 'switch_with_nested_match_default_case' => [ - 'testMarker' => '/* testMatchWithDefaultNestedInSwitchDefault */', - 'openerOffset' => 1, - 'closerOffset' => 38, - ], - 'match_with_nested_switch_case' => [ - 'testMarker' => '/* testSwitchDefaultNestedInMatchCase */', - 'openerOffset' => 1, - 'closerOffset' => 18, - ], - 'match_with_nested_switch_default_case' => [ - 'testMarker' => '/* testSwitchDefaultNestedInMatchDefault */', - 'openerOffset' => 1, - 'closerOffset' => 20, - ], - ]; - - }//end dataSwitchCaseVersusMatch() - - - /** - * Helper function to verify that all scope related array indexes for a control structure - * are set correctly. - * - * @param int $token The control structure token to check. - * @param int $openerOffset The expected offset of the scope opener in relation to - * the control structure token. - * @param int $closerOffset The expected offset of the scope closer in relation to - * the control structure token. - * @param bool $skipScopeCloserCheck Whether to skip the scope closer check. - * This should be set to "true" when testing nested arrow functions, - * where the "inner" arrow function shares a scope closer with the - * "outer" arrow function, as the 'scope_condition' for the scope closer - * of the "inner" arrow function will point to the "outer" arrow function. - * - * @return void - */ - private function scopeTestHelper($token, $openerOffset, $closerOffset, $skipScopeCloserCheck=false) - { - $tokens = $this->phpcsFile->getTokens(); - $tokenArray = $tokens[$token]; - $tokenType = $tokenArray['type']; - $expectedScopeOpener = ($token + $openerOffset); - $expectedScopeCloser = ($token + $closerOffset); - - $this->assertArrayHasKey('scope_condition', $tokenArray, 'Scope condition is not set'); - $this->assertArrayHasKey('scope_opener', $tokenArray, 'Scope opener is not set'); - $this->assertArrayHasKey('scope_closer', $tokenArray, 'Scope closer is not set'); - $this->assertSame($token, $tokenArray['scope_condition'], 'Scope condition is not the '.$tokenType.' token'); - $this->assertSame($expectedScopeOpener, $tokenArray['scope_opener'], 'Scope opener of the '.$tokenType.' token incorrect'); - $this->assertSame($expectedScopeCloser, $tokenArray['scope_closer'], 'Scope closer of the '.$tokenType.' token incorrect'); - - $opener = $tokenArray['scope_opener']; - $this->assertArrayHasKey('scope_condition', $tokens[$opener], 'Opener scope condition is not set'); - $this->assertArrayHasKey('scope_opener', $tokens[$opener], 'Opener scope opener is not set'); - $this->assertArrayHasKey('scope_closer', $tokens[$opener], 'Opener scope closer is not set'); - $this->assertSame($token, $tokens[$opener]['scope_condition'], 'Opener scope condition is not the '.$tokenType.' token'); - $this->assertSame($expectedScopeOpener, $tokens[$opener]['scope_opener'], $tokenType.' opener scope opener token incorrect'); - $this->assertSame($expectedScopeCloser, $tokens[$opener]['scope_closer'], $tokenType.' opener scope closer token incorrect'); - - $closer = $tokenArray['scope_closer']; - $this->assertArrayHasKey('scope_condition', $tokens[$closer], 'Closer scope condition is not set'); - $this->assertArrayHasKey('scope_opener', $tokens[$closer], 'Closer scope opener is not set'); - $this->assertArrayHasKey('scope_closer', $tokens[$closer], 'Closer scope closer is not set'); - if ($skipScopeCloserCheck === false) { - $this->assertSame($token, $tokens[$closer]['scope_condition'], 'Closer scope condition is not the '.$tokenType.' token'); - } - - $this->assertSame($expectedScopeOpener, $tokens[$closer]['scope_opener'], $tokenType.' closer scope opener token incorrect'); - $this->assertSame($expectedScopeCloser, $tokens[$closer]['scope_closer'], $tokenType.' closer scope closer token incorrect'); - - if (($opener + 1) !== $closer) { - for ($i = ($opener + 1); $i < $closer; $i++) { - $this->assertArrayHasKey( - $token, - $tokens[$i]['conditions'], - $tokenType.' condition not added for token belonging to the '.$tokenType.' structure' - ); - } - } - - }//end scopeTestHelper() - - - /** - * Helper function to verify that all parenthesis related array indexes for a control structure - * token are set correctly. - * - * @param int $token The position of the control structure token. - * - * @return void - */ - private function parenthesisTestHelper($token) - { - $tokens = $this->phpcsFile->getTokens(); - $tokenArray = $tokens[$token]; - $tokenType = $tokenArray['type']; - - $this->assertArrayHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is not set'); - $this->assertArrayHasKey('parenthesis_opener', $tokenArray, 'Parenthesis opener is not set'); - $this->assertArrayHasKey('parenthesis_closer', $tokenArray, 'Parenthesis closer is not set'); - $this->assertSame($token, $tokenArray['parenthesis_owner'], 'Parenthesis owner is not the '.$tokenType.' token'); - - $opener = $tokenArray['parenthesis_opener']; - $this->assertArrayHasKey('parenthesis_owner', $tokens[$opener], 'Opening parenthesis owner is not set'); - $this->assertSame($token, $tokens[$opener]['parenthesis_owner'], 'Opening parenthesis owner is not the '.$tokenType.' token'); - - $closer = $tokenArray['parenthesis_closer']; - $this->assertArrayHasKey('parenthesis_owner', $tokens[$closer], 'Closing parenthesis owner is not set'); - $this->assertSame($token, $tokens[$closer]['parenthesis_owner'], 'Closing parenthesis owner is not the '.$tokenType.' token'); - - }//end parenthesisTestHelper() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillNumericSeparatorTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillNumericSeparatorTest.inc deleted file mode 100644 index d8559705c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillNumericSeparatorTest.inc +++ /dev/null @@ -1,94 +0,0 @@ - - * @copyright 2019 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class BackfillNumericSeparatorTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that numbers using numeric separators are tokenized correctly. - * - * @param string $marker The comment which prefaces the target token in the test file. - * @param string $type The expected token type. - * @param string $value The expected token content. - * - * @dataProvider dataTestBackfill - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testBackfill($marker, $type, $value) - { - $tokens = $this->phpcsFile->getTokens(); - $number = $this->getTargetToken($marker, [T_LNUMBER, T_DNUMBER]); - $tokenArray = $tokens[$number]; - - $this->assertSame(constant($type), $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not '.$type.' (code)'); - $this->assertSame($type, $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not '.$type.' (type)'); - $this->assertSame($value, $tokenArray['content']); - - }//end testBackfill() - - - /** - * Data provider. - * - * @see testBackfill() - * - * @return array> - */ - public static function dataTestBackfill() - { - $testHexType = 'T_LNUMBER'; - if (PHP_INT_MAX < 0xCAFEF00D) { - $testHexType = 'T_DNUMBER'; - } - - $testHexMultipleType = 'T_LNUMBER'; - if (PHP_INT_MAX < 0x42726F776E) { - $testHexMultipleType = 'T_DNUMBER'; - } - - $testIntMoreThanMaxType = 'T_LNUMBER'; - if (PHP_INT_MAX < 10223372036854775807) { - $testIntMoreThanMaxType = 'T_DNUMBER'; - } - - return [ - 'decimal integer' => [ - 'marker' => '/* testSimpleLNumber */', - 'type' => 'T_LNUMBER', - 'value' => '1_000_000_000', - ], - 'float' => [ - 'marker' => '/* testSimpleDNumber */', - 'type' => 'T_DNUMBER', - 'value' => '107_925_284.88', - ], - 'float, scientific notation, negative exponent with sigh' => [ - 'marker' => '/* testFloat */', - 'type' => 'T_DNUMBER', - 'value' => '6.674_083e-11', - ], - 'float, scientific notation, positive exponent with sign' => [ - 'marker' => '/* testFloat2 */', - 'type' => 'T_DNUMBER', - 'value' => '6.674_083e+11', - ], - 'float, scientific notation, positive exponent without sign' => [ - 'marker' => '/* testFloat3 */', - 'type' => 'T_DNUMBER', - 'value' => '1_2.3_4e1_23', - ], - 'hexidecimal integer/float' => [ - 'marker' => '/* testHex */', - 'type' => $testHexType, - 'value' => '0xCAFE_F00D', - ], - 'hexidecimal integer/float with multiple underscores' => [ - 'marker' => '/* testHexMultiple */', - 'type' => $testHexMultipleType, - 'value' => '0x42_72_6F_77_6E', - ], - 'hexidecimal integer' => [ - 'marker' => '/* testHexInt */', - 'type' => 'T_LNUMBER', - 'value' => '0x42_72_6F', - ], - 'binary integer' => [ - 'marker' => '/* testBinary */', - 'type' => 'T_LNUMBER', - 'value' => '0b0101_1111', - ], - 'octal integer' => [ - 'marker' => '/* testOctal */', - 'type' => 'T_LNUMBER', - 'value' => '0137_041', - ], - 'octal integer using explicit octal notation' => [ - 'marker' => '/* testExplicitOctal */', - 'type' => 'T_LNUMBER', - 'value' => '0o137_041', - ], - 'octal integer using explicit octal notation with capital O' => [ - 'marker' => '/* testExplicitOctalCapitalised */', - 'type' => 'T_LNUMBER', - 'value' => '0O137_041', - ], - 'integer more than PHP_INT_MAX becomes a float' => [ - 'marker' => '/* testIntMoreThanMax */', - 'type' => $testIntMoreThanMaxType, - 'value' => '10_223_372_036_854_775_807', - ], - ]; - - }//end dataTestBackfill() - - - /** - * Test that numbers using numeric separators which are considered parse errors and/or - * which aren't relevant to the backfill, do not incorrectly trigger the backfill anyway. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param array> $expectedTokens The token type and content of the expected token sequence. - * - * @dataProvider dataNoBackfill - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNoBackfill($testMarker, $expectedTokens) - { - $tokens = $this->phpcsFile->getTokens(); - $number = $this->getTargetToken($testMarker, [T_LNUMBER, T_DNUMBER]); - - foreach ($expectedTokens as $key => $expectedToken) { - $i = ($number + $key); - $this->assertSame( - $expectedToken['code'], - $tokens[$i]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$i]['code']).', not '.Tokens::tokenName($expectedToken['code']) - ); - $this->assertSame($expectedToken['content'], $tokens[$i]['content']); - } - - }//end testNoBackfill() - - - /** - * Data provider. - * - * @see testBackfill() - * - * @return array>>> - */ - public static function dataNoBackfill() - { - return [ - 'invalid: trailing underscore' => [ - 'testMarker' => '/* testInvalid1 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '100', - ], - [ - 'code' => T_STRING, - 'content' => '_', - ], - ], - ], - 'invalid: two consecutive underscores' => [ - 'testMarker' => '/* testInvalid2 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '1', - ], - [ - 'code' => T_STRING, - 'content' => '__1', - ], - ], - ], - 'invalid: underscore directly before decimal point' => [ - 'testMarker' => '/* testInvalid3 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '1', - ], - [ - 'code' => T_STRING, - 'content' => '_', - ], - [ - 'code' => T_DNUMBER, - 'content' => '.0', - ], - ], - ], - 'invalid: underscore directly after decimal point' => [ - 'testMarker' => '/* testInvalid4 */', - 'expectedTokens' => [ - [ - 'code' => T_DNUMBER, - 'content' => '1.', - ], - [ - 'code' => T_STRING, - 'content' => '_0', - ], - ], - ], - 'invalid: hex int - underscore directly after x' => [ - 'testMarker' => '/* testInvalid5 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '0', - ], - [ - 'code' => T_STRING, - 'content' => 'x_123', - ], - ], - ], - 'invalid: binary int - underscore directly after b' => [ - 'testMarker' => '/* testInvalid6 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '0', - ], - [ - 'code' => T_STRING, - 'content' => 'b_101', - ], - ], - ], - 'invalid: scientific float - underscore directly before e' => [ - 'testMarker' => '/* testInvalid7 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '1', - ], - [ - 'code' => T_STRING, - 'content' => '_e2', - ], - ], - ], - 'invalid: scientific float - underscore directly after e' => [ - 'testMarker' => '/* testInvalid8 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '1', - ], - [ - 'code' => T_STRING, - 'content' => 'e_2', - ], - ], - ], - 'invalid: space between parts of the number' => [ - 'testMarker' => '/* testInvalid9 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '107_925_284', - ], - [ - 'code' => T_WHITESPACE, - 'content' => ' ', - ], - [ - 'code' => T_DNUMBER, - 'content' => '.88', - ], - ], - ], - 'invalid: comment within the number' => [ - 'testMarker' => '/* testInvalid10 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '107_925_284', - ], - [ - 'code' => T_COMMENT, - 'content' => '/*comment*/', - ], - [ - 'code' => T_DNUMBER, - 'content' => '.88', - ], - ], - ], - 'invalid: explicit octal int - underscore directly after o' => [ - 'testMarker' => '/* testInvalid11 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '0', - ], - [ - 'code' => T_STRING, - 'content' => 'o_137', - ], - ], - ], - 'invalid: explicit octal int - underscore directly after capital O' => [ - 'testMarker' => '/* testInvalid12 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '0', - ], - [ - 'code' => T_STRING, - 'content' => 'O_41', - ], - ], - ], - 'calculations should be untouched - int - int' => [ - 'testMarker' => '/* testCalc1 */', - 'expectedTokens' => [ - [ - 'code' => T_LNUMBER, - 'content' => '667_083', - ], - [ - 'code' => T_WHITESPACE, - 'content' => ' ', - ], - [ - 'code' => T_MINUS, - 'content' => '-', - ], - [ - 'code' => T_WHITESPACE, - 'content' => ' ', - ], - [ - 'code' => T_LNUMBER, - 'content' => '11', - ], - ], - ], - 'calculations should be untouched - scientific float + int' => [ - 'testMarker' => '/* test Calc2 */', - 'expectedTokens' => [ - [ - 'code' => T_DNUMBER, - 'content' => '6.674_08e3', - ], - [ - 'code' => T_WHITESPACE, - 'content' => ' ', - ], - [ - 'code' => T_PLUS, - 'content' => '+', - ], - [ - 'code' => T_WHITESPACE, - 'content' => ' ', - ], - [ - 'code' => T_LNUMBER, - 'content' => '11', - ], - ], - ], - ]; - - }//end dataNoBackfill() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillReadonlyTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillReadonlyTest.inc deleted file mode 100644 index eb36e3870..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillReadonlyTest.inc +++ /dev/null @@ -1,156 +0,0 @@ -readonly = 'foo'; - - /* testReadonlyPropertyInTernaryOperator */ - $isReadonly = $this->readonly ? true : false; - } -} - -/* testReadonlyUsedAsFunctionName */ -function readonly() {} - -/* testReadonlyUsedAsFunctionNameWithReturnByRef */ -function &readonly() {} - -/* testReadonlyUsedAsNamespaceName */ -namespace Readonly; -/* testReadonlyUsedAsPartOfNamespaceName */ -namespace My\Readonly\Collection; -/* testReadonlyAsFunctionCall */ -$var = readonly($a, $b); -/* testReadonlyAsNamespacedFunctionCall */ -$var = My\NS\readonly($a, $b); -/* testReadonlyAsNamespaceRelativeFunctionCall */ -$var = namespace\ReadOnly($a, $b); -/* testReadonlyAsMethodCall */ -$var = $obj->readonly($a, $b); -/* testReadonlyAsNullsafeMethodCall */ -$var = $obj?->readOnly($a, $b); -/* testReadonlyAsStaticMethodCallWithSpace */ -$var = ClassName::readonly ($a, $b); -/* testClassConstantFetchWithReadonlyAsConstantName */ -echo ClassName::READONLY; - -/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */ -$var = readonly /* comment */ (); - -// These test cases are inspired by -// https://github.com/php/php-src/commit/08b75395838b4b42a41e3c70684fa6c6b113eee0 -class ReadonlyWithDisjunctiveNormalForm -{ - /* testReadonlyPropertyDNFTypeUnqualified */ - readonly (B&C)|A $h; - - /* testReadonlyPropertyDNFTypeFullyQualified */ - public readonly (\Fully\Qualified\B&\Full\C)|\Foo\Bar $j; - - /* testReadonlyPropertyDNFTypePartiallyQualified */ - protected readonly (Partially\Qualified&C)|A $l; - - /* testReadonlyPropertyDNFTypeRelativeName */ - private readonly (namespace\Relative&C)|A $n; - - /* testReadonlyPropertyDNFTypeMultipleSets */ - private readonly (A&C)|(B&C)|(C&D) $m; - - /* testReadonlyPropertyDNFTypeWithArray */ - private readonly (B & C)|array $o; - - /* testReadonlyPropertyDNFTypeWithSpacesAndComments */ - private readonly ( B & C /*something*/) | A $q; - - public function __construct( - /* testReadonlyConstructorPropertyPromotionWithDNF */ - private readonly (B&C)|A $b1, - /* testReadonlyConstructorPropertyPromotionWithDNFAndReference */ - readonly (B&C)|A &$b2, - ) {} - - /* testReadonlyUsedAsMethodNameWithDNFParam */ - public function readonly (A&B $param): void {} -} - -/* testReadonlyAnonClassWithParens */ -$anon = new readonly class() {}; - -/* testReadonlyAnonClassWithoutParens */ -$anon = new Readonly class {}; - -/* testReadonlyAnonClassWithCommentsAndWhitespace */ -$anon = new -// comment -READONLY -// phpcs:ignore Stnd.Cat.Sniff -class {}; - -/* testParseErrorLiveCoding */ -// This must be the last test in the file. -readonly diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillReadonlyTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillReadonlyTest.php deleted file mode 100644 index 89dc3e19d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BackfillReadonlyTest.php +++ /dev/null @@ -1,271 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class BackfillReadonlyTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the "readonly" keyword is tokenized as such. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $testContent Optional. The token content to look for. - * Defaults to lowercase "readonly". - * - * @dataProvider dataReadonly - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testReadonly($testMarker, $testContent='readonly') - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_READONLY, T_STRING], $testContent); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_READONLY, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_READONLY (code)'); - $this->assertSame('T_READONLY', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_READONLY (type)'); - - }//end testReadonly() - - - /** - * Data provider. - * - * @see testReadonly() - * - * @return array> - */ - public static function dataReadonly() - { - return [ - 'property declaration, no visibility' => [ - 'testMarker' => '/* testReadonlyProperty */', - ], - 'property declaration, var keyword before' => [ - 'testMarker' => '/* testVarReadonlyProperty */', - ], - 'property declaration, var keyword after' => [ - 'testMarker' => '/* testReadonlyVarProperty */', - ], - 'property declaration, static before' => [ - 'testMarker' => '/* testStaticReadonlyProperty */', - ], - 'property declaration, static after' => [ - 'testMarker' => '/* testReadonlyStaticProperty */', - ], - 'constant declaration, with visibility' => [ - 'testMarker' => '/* testConstReadonlyProperty */', - ], - 'property declaration, missing type' => [ - 'testMarker' => '/* testReadonlyPropertyWithoutType */', - ], - 'property declaration, public before' => [ - 'testMarker' => '/* testPublicReadonlyProperty */', - ], - 'property declaration, protected before' => [ - 'testMarker' => '/* testProtectedReadonlyProperty */', - ], - 'property declaration, private before' => [ - 'testMarker' => '/* testPrivateReadonlyProperty */', - ], - 'property declaration, public after' => [ - 'testMarker' => '/* testPublicReadonlyPropertyWithReadonlyFirst */', - ], - 'property declaration, protected after' => [ - 'testMarker' => '/* testProtectedReadonlyPropertyWithReadonlyFirst */', - ], - 'property declaration, private after' => [ - 'testMarker' => '/* testPrivateReadonlyPropertyWithReadonlyFirst */', - ], - 'property declaration, private before, comments in declaration' => [ - 'testMarker' => '/* testReadonlyWithCommentsInDeclaration */', - ], - 'property declaration, private before, nullable type' => [ - 'testMarker' => '/* testReadonlyWithNullableProperty */', - ], - 'property declaration, private before, union type, null first' => [ - 'testMarker' => '/* testReadonlyNullablePropertyWithUnionTypeHintAndNullFirst */', - ], - 'property declaration, private before, union type, null last' => [ - 'testMarker' => '/* testReadonlyNullablePropertyWithUnionTypeHintAndNullLast */', - ], - 'property declaration, private before, array type' => [ - 'testMarker' => '/* testReadonlyPropertyWithArrayTypeHint */', - ], - 'property declaration, private before, self type' => [ - 'testMarker' => '/* testReadonlyPropertyWithSelfTypeHint */', - ], - 'property declaration, private before, parent type' => [ - 'testMarker' => '/* testReadonlyPropertyWithParentTypeHint */', - ], - 'property declaration, private before, FQN type' => [ - 'testMarker' => '/* testReadonlyPropertyWithFullyQualifiedTypeHint */', - ], - 'property declaration, public before, mixed case' => [ - 'testMarker' => '/* testReadonlyIsCaseInsensitive */', - 'testContent' => 'ReAdOnLy', - ], - 'property declaration, constructor property promotion' => [ - 'testMarker' => '/* testReadonlyConstructorPropertyPromotion */', - ], - 'property declaration, constructor property promotion with reference, mixed case' => [ - 'testMarker' => '/* testReadonlyConstructorPropertyPromotionWithReference */', - 'testContent' => 'ReadOnly', - ], - 'property declaration, in anonymous class' => [ - 'testMarker' => '/* testReadonlyPropertyInAnonymousClass */', - ], - 'property declaration, no visibility, DNF type, unqualified' => [ - 'testMarker' => '/* testReadonlyPropertyDNFTypeUnqualified */', - ], - 'property declaration, public before, DNF type, fully qualified' => [ - 'testMarker' => '/* testReadonlyPropertyDNFTypeFullyQualified */', - ], - 'property declaration, protected before, DNF type, partially qualified' => [ - 'testMarker' => '/* testReadonlyPropertyDNFTypePartiallyQualified */', - ], - 'property declaration, private before, DNF type, namespace relative name' => [ - 'testMarker' => '/* testReadonlyPropertyDNFTypeRelativeName */', - ], - 'property declaration, private before, DNF type, multiple sets' => [ - 'testMarker' => '/* testReadonlyPropertyDNFTypeMultipleSets */', - ], - 'property declaration, private before, DNF type, union with array' => [ - 'testMarker' => '/* testReadonlyPropertyDNFTypeWithArray */', - ], - 'property declaration, private before, DNF type, with spaces and comment' => [ - 'testMarker' => '/* testReadonlyPropertyDNFTypeWithSpacesAndComments */', - ], - 'property declaration, constructor property promotion, DNF type' => [ - 'testMarker' => '/* testReadonlyConstructorPropertyPromotionWithDNF */', - ], - 'property declaration, constructor property promotion, DNF type and reference' => [ - 'testMarker' => '/* testReadonlyConstructorPropertyPromotionWithDNFAndReference */', - ], - 'anon class declaration, with parentheses' => [ - 'testMarker' => '/* testReadonlyAnonClassWithParens */', - ], - 'anon class declaration, without parentheses' => [ - 'testMarker' => '/* testReadonlyAnonClassWithoutParens */', - 'testContent' => 'Readonly', - ], - 'anon class declaration, with comments and whitespace' => [ - 'testMarker' => '/* testReadonlyAnonClassWithCommentsAndWhitespace */', - 'testContent' => 'READONLY', - ], - 'live coding / parse error' => [ - 'testMarker' => '/* testParseErrorLiveCoding */', - ], - ]; - - }//end dataReadonly() - - - /** - * Test that "readonly" when not used as the keyword is still tokenized as `T_STRING`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $testContent Optional. The token content to look for. - * Defaults to lowercase "readonly". - * - * @dataProvider dataNotReadonly - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNotReadonly($testMarker, $testContent='readonly') - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_READONLY, T_STRING], $testContent); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testNotReadonly() - - - /** - * Data provider. - * - * @see testNotReadonly() - * - * @return array> - */ - public static function dataNotReadonly() - { - return [ - 'name of a constant, context: declaration using "const" keyword, uppercase' => [ - 'testMarker' => '/* testReadonlyUsedAsClassConstantName */', - 'testContent' => 'READONLY', - ], - 'name of a method, context: declaration' => [ - 'testMarker' => '/* testReadonlyUsedAsMethodName */', - ], - 'name of a property, context: property access' => [ - 'testMarker' => '/* testReadonlyUsedAsPropertyName */', - ], - 'name of a property, context: property access in ternary' => [ - 'testMarker' => '/* testReadonlyPropertyInTernaryOperator */', - ], - 'name of a function, context: declaration' => [ - 'testMarker' => '/* testReadonlyUsedAsFunctionName */', - ], - 'name of a function, context: declaration with return by ref' => [ - 'testMarker' => '/* testReadonlyUsedAsFunctionNameWithReturnByRef */', - ], - 'name of namespace, context: declaration, mixed case' => [ - 'testMarker' => '/* testReadonlyUsedAsNamespaceName */', - 'testContent' => 'Readonly', - ], - 'partial name of namespace, context: declaration, mixed case' => [ - 'testMarker' => '/* testReadonlyUsedAsPartOfNamespaceName */', - 'testContent' => 'Readonly', - ], - 'name of a function, context: call' => [ - 'testMarker' => '/* testReadonlyAsFunctionCall */', - ], - 'name of a namespaced function, context: partially qualified call' => [ - 'testMarker' => '/* testReadonlyAsNamespacedFunctionCall */', - ], - 'name of a function, context: namespace relative call, mixed case' => [ - 'testMarker' => '/* testReadonlyAsNamespaceRelativeFunctionCall */', - 'testContent' => 'ReadOnly', - ], - 'name of a method, context: method call on object' => [ - 'testMarker' => '/* testReadonlyAsMethodCall */', - ], - 'name of a method, context: nullsafe method call on object' => [ - 'testMarker' => '/* testReadonlyAsNullsafeMethodCall */', - 'testContent' => 'readOnly', - ], - 'name of a method, context: static method call with space after' => [ - 'testMarker' => '/* testReadonlyAsStaticMethodCallWithSpace */', - ], - 'name of a constant, context: constant access - uppercase' => [ - 'testMarker' => '/* testClassConstantFetchWithReadonlyAsConstantName */', - 'testContent' => 'READONLY', - ], - 'name of a function, context: call with space and comment between keyword and parens' => [ - 'testMarker' => '/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */', - ], - 'name of a method, context: declaration with DNF parameter' => [ - 'testMarker' => '/* testReadonlyUsedAsMethodNameWithDNFParam */', - ], - ]; - - }//end dataNotReadonly() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BitwiseOrTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BitwiseOrTest.inc deleted file mode 100644 index 6e7d58890..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BitwiseOrTest.inc +++ /dev/null @@ -1,213 +0,0 @@ - $param | $int; - -/* testTypeUnionArrowReturnType */ -$arrowWithReturnType = fn ($param) : int|null => $param * 10; - -/* testBitwiseOrInArrayKey */ -$array = array( - A | B => /* testBitwiseOrInArrayValue */ B | C -); - -/* testBitwiseOrInShortArrayKey */ -$array = [ - A | B => /* testBitwiseOrInShortArrayValue */ B | C -]; - -/* testBitwiseOrTryCatch */ -try { -} catch ( ExceptionA | ExceptionB $e ) { -} - -/* testBitwiseOrNonArrowFnFunctionCall */ -$obj->fn($something | $else); - -/* testTypeUnionNonArrowFunctionDeclaration */ -function &fn(int|false $something) {} - -/* testTypeUnionPHP82TrueFirst */ -function trueTypeParam(true|null $param) {} - -/* testTypeUnionPHP82TrueMiddle */ -function trueTypeReturn($param): array|true|null {} - -/* testTypeUnionPHP82TrueLast */ -$closure = function ($param): array|true {} - -/* testLiveCoding */ -// Intentional parse error. This has to be the last test in the file. -return function( type| diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BitwiseOrTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BitwiseOrTest.php deleted file mode 100644 index 17febdc45..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/BitwiseOrTest.php +++ /dev/null @@ -1,170 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class BitwiseOrTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that non-union type bitwise or tokens are still tokenized as bitwise or. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataBitwiseOr - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testBitwiseOr($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_BITWISE_OR, T_TYPE_UNION]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_BITWISE_OR, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_BITWISE_OR (code)'); - $this->assertSame('T_BITWISE_OR', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_BITWISE_OR (type)'); - - }//end testBitwiseOr() - - - /** - * Data provider. - * - * @see testBitwiseOr() - * - * @return array> - */ - public static function dataBitwiseOr() - { - return [ - 'in simple assignment 1' => ['/* testBitwiseOr1 */'], - 'in simple assignment 2' => ['/* testBitwiseOr2 */'], - 'in OO constant default value' => ['/* testBitwiseOrOOConstDefaultValue */'], - 'in property default value' => ['/* testBitwiseOrPropertyDefaultValue */'], - 'in method parameter default value' => ['/* testBitwiseOrParamDefaultValue */'], - 'in return statement' => ['/* testBitwiseOr3 */'], - 'in closure parameter default value' => ['/* testBitwiseOrClosureParamDefault */'], - 'in OO constant default value DNF-like' => ['/* testBitwiseOrOOConstDefaultValueDNF */'], - 'in property default value DNF-like' => ['/* testBitwiseOrPropertyDefaultValueDNF */'], - 'in method parameter default value DNF-like' => ['/* testBitwiseOrParamDefaultValueDNF */'], - 'in arrow function parameter default value' => ['/* testBitwiseOrArrowParamDefault */'], - 'in arrow function return expression' => ['/* testBitwiseOrArrowExpression */'], - 'in long array key' => ['/* testBitwiseOrInArrayKey */'], - 'in long array value' => ['/* testBitwiseOrInArrayValue */'], - 'in short array key' => ['/* testBitwiseOrInShortArrayKey */'], - 'in short array value' => ['/* testBitwiseOrInShortArrayValue */'], - 'in catch condition' => ['/* testBitwiseOrTryCatch */'], - 'in parameter in function call' => ['/* testBitwiseOrNonArrowFnFunctionCall */'], - 'live coding / undetermined' => ['/* testLiveCoding */'], - ]; - - }//end dataBitwiseOr() - - - /** - * Test that bitwise or tokens when used as part of a union type are tokenized as `T_TYPE_UNION`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataTypeUnion - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testTypeUnion($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_BITWISE_OR, T_TYPE_UNION]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_TYPE_UNION, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_TYPE_UNION (code)'); - $this->assertSame('T_TYPE_UNION', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_TYPE_UNION (type)'); - - }//end testTypeUnion() - - - /** - * Data provider. - * - * @see testTypeUnion() - * - * @return array> - */ - public static function dataTypeUnion() - { - return [ - 'type for OO constant' => ['/* testTypeUnionOOConstSimple */'], - 'type for OO constant, reversed modifier order' => ['/* testTypeUnionOOConstReverseModifierOrder */'], - 'type for OO constant, first of multi-union' => ['/* testTypeUnionOOConstMulti1 */'], - 'type for OO constant, middle of multi-union + comments' => ['/* testTypeUnionOOConstMulti2 */'], - 'type for OO constant, last of multi-union' => ['/* testTypeUnionOOConstMulti3 */'], - 'type for OO constant, using namespace relative names' => ['/* testTypeUnionOOConstNamespaceRelative */'], - 'type for OO constant, using partially qualified names' => ['/* testTypeUnionOOConstPartiallyQualified */'], - 'type for OO constant, using fully qualified names' => ['/* testTypeUnionOOConstFullyQualified */'], - 'type for static property' => ['/* testTypeUnionPropertySimple */'], - 'type for static property, reversed modifier order' => ['/* testTypeUnionPropertyReverseModifierOrder */'], - 'type for property, first of multi-union' => ['/* testTypeUnionPropertyMulti1 */'], - 'type for property, middle of multi-union, also comments' => ['/* testTypeUnionPropertyMulti2 */'], - 'type for property, last of multi-union' => ['/* testTypeUnionPropertyMulti3 */'], - 'type for property using namespace relative names' => ['/* testTypeUnionPropertyNamespaceRelative */'], - 'type for property using partially qualified names' => ['/* testTypeUnionPropertyPartiallyQualified */'], - 'type for property using fully qualified names' => ['/* testTypeUnionPropertyFullyQualified */'], - 'type for readonly property' => ['/* testTypeUnionPropertyWithReadOnlyKeyword */'], - 'type for static readonly property' => ['/* testTypeUnionPropertyWithStaticAndReadOnlyKeywords */'], - 'type for readonly property using var keyword' => ['/* testTypeUnionPropertyWithVarAndReadOnlyKeywords */'], - 'type for readonly property, reversed modifier order' => ['/* testTypeUnionPropertyWithReadOnlyKeywordFirst */'], - 'type for readonly property, no visibility' => ['/* testTypeUnionPropertyWithOnlyReadOnlyKeyword */'], - 'type for static property, no visibility' => ['/* testTypeUnionPropertyWithOnlyStaticKeyword */'], - 'type for final property, no visibility' => ['/* testTypeUnionWithPHP84FinalKeyword */'], - 'type for final property, reversed modifier order' => ['/* testTypeUnionWithPHP84FinalKeywordFirst */'], - 'type for final property, no visibility, FQN type' => ['/* testTypeUnionWithPHP84FinalKeywordAndFQN */'], - 'type for private(set) property' => ['/* testTypeUnionPropertyPrivateSet */'], - 'type for public private(set) property' => ['/* testTypeUnionPropertyPublicPrivateSet */'], - 'type for protected(set) property' => ['/* testTypeUnionPropertyProtected */'], - 'type for public protected(set) property' => ['/* testTypeUnionPropertyPublicProtected */'], - 'type for abstract property, no visibility' => ['/* testTypeUnionWithPHP84AbstractKeyword */'], - 'type for abstract property, reversed modifier order' => ['/* testTypeUnionWithPHP84AbstractKeywordFirst */'], - 'type for abstract property, no visibility, FQN type' => ['/* testTypeUnionWithPHP84AbstractKeywordAndFQN */'], - 'type for method parameter' => ['/* testTypeUnionParam1 */'], - 'type for method parameter, first in multi-union' => ['/* testTypeUnionParam2 */'], - 'type for method parameter, last in multi-union' => ['/* testTypeUnionParam3 */'], - 'type for method parameter with namespace relative names' => ['/* testTypeUnionParamNamespaceRelative */'], - 'type for method parameter with partially qualified names' => ['/* testTypeUnionParamPartiallyQualified */'], - 'type for method parameter with fully qualified names' => ['/* testTypeUnionParamFullyQualified */'], - 'type for property in constructor property promotion' => ['/* testTypeUnionConstructorPropertyPromotion */'], - 'return type for method' => ['/* testTypeUnionReturnType */'], - 'return type for method, first of multi-union' => ['/* testTypeUnionAbstractMethodReturnType1 */'], - 'return type for method, last of multi-union' => ['/* testTypeUnionAbstractMethodReturnType2 */'], - 'return type for method with namespace relative names' => ['/* testTypeUnionReturnTypeNamespaceRelative */'], - 'return type for method with partially qualified names' => ['/* testTypeUnionReturnPartiallyQualified */'], - 'return type for method with fully qualified names' => ['/* testTypeUnionReturnFullyQualified */'], - 'type for function parameter with reference' => ['/* testTypeUnionWithReference */'], - 'type for function parameter with spread operator' => ['/* testTypeUnionWithSpreadOperator */'], - 'DNF type for OO constant, union before DNF' => ['/* testTypeUnionConstantTypeUnionBeforeDNF */'], - 'DNF type for property, union after DNF' => ['/* testTypeUnionPropertyTypeUnionAfterDNF */'], - 'DNF type for function param, union before and after DNF' => ['/* testTypeUnionParamUnionBeforeAndAfterDNF */'], - 'DNF type for function return, union after DNF with null' => ['/* testTypeUnionReturnTypeUnionAfterDNF */'], - 'type for closure parameter with illegal nullable' => ['/* testTypeUnionClosureParamIllegalNullable */'], - 'return type for closure' => ['/* testTypeUnionClosureReturn */'], - 'type for arrow function parameter' => ['/* testTypeUnionArrowParam */'], - 'return type for arrow function' => ['/* testTypeUnionArrowReturnType */'], - 'type for function parameter, return by ref' => ['/* testTypeUnionNonArrowFunctionDeclaration */'], - 'type for function param with true type first' => ['/* testTypeUnionPHP82TrueFirst */'], - 'return type for function with true type middle' => ['/* testTypeUnionPHP82TrueMiddle */'], - 'return type for closure with true type last' => ['/* testTypeUnionPHP82TrueLast */'], - ]; - - }//end dataTypeUnion() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.inc deleted file mode 100644 index 3a591f5aa..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.inc +++ /dev/null @@ -1,253 +0,0 @@ - 'a', - 2 => 'b', - /* testMatchDefaultIsKeyword */ default => 'default', -}; - -$closure = /* testFnIsKeyword */ fn () => 'string'; - -function () { - /* testYieldIsKeyword */ yield $f; - /* testYieldFromIsKeyword */ yield from someFunction(); -}; - -/* testDeclareIsKeyword */ declare(ticks=1): -/* testEndDeclareIsKeyword */ enddeclare; - -if (true /* testAndIsKeyword */ and false /* testOrIsKeyword */ or null /* testXorIsKeyword */ xor 0) { - -} - -$anonymousClass = new /* testAnonymousClassIsKeyword */ class {}; -$anonymousClass2 = new class /* testExtendsInAnonymousClassIsKeyword */ extends SomeParent {}; -$anonymousClass3 = new class /* testImplementsInAnonymousClassIsKeyword */ implements SomeInterface {}; - -$instantiated = new /* testClassInstantiationStaticIsKeyword */ static($param); - -class Foo extends /* testNamespaceInNameIsKeyword */ namespace\Exception -{} - -function /* testKeywordAfterFunctionShouldBeString */ eval() {} -function /* testKeywordAfterFunctionByRefShouldBeString */ &switch() {} - -function /* testKeywordStaticAfterFunctionByRefShouldBeString */ &static() {} - -/* testKeywordAsFunctionCallNameShouldBeStringStatic */ static(); -$obj-> /* testKeywordAsMethodCallNameShouldBeStringStatic */ static(); - -$function = /* testStaticIsKeywordBeforeClosure */ static function(/* testStaticIsKeywordWhenParamType */ static $param) {}; -$arrow = /* testStaticIsKeywordBeforeArrow */ static fn(): /* testStaticIsKeywordWhenReturnType */ static => 10; - -/* testKeywordAsFunctionCallNameShouldBeStringStaticDNFLookaLike */ -$obj->static((CONST_A&CONST_B)|CONST_C | $var); - -class DNF { - public /* testStaticIsKeywordPropertyModifierBeforeDNF */ static (DN&F)|null $dnfProp; -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.php deleted file mode 100644 index b2d14a9d9..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ContextSensitiveKeywordsTest.php +++ /dev/null @@ -1,576 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class ContextSensitiveKeywordsTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that context sensitive keyword is tokenized as string when it should be string. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataStrings - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testStrings($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, (Tokens::$contextSensitiveKeywords + [T_STRING])); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testStrings() - - - /** - * Data provider. - * - * @see testStrings() - * - * @return array> - */ - public static function dataStrings() - { - return [ - 'constant declaration: abstract' => ['/* testAbstract */'], - 'constant declaration: array' => ['/* testArray */'], - 'constant declaration: as' => ['/* testAs */'], - 'constant declaration: break' => ['/* testBreak */'], - 'constant declaration: callable' => ['/* testCallable */'], - 'constant declaration: case' => ['/* testCase */'], - 'constant declaration: catch' => ['/* testCatch */'], - 'constant declaration: class' => ['/* testClass */'], - 'constant declaration: clone' => ['/* testClone */'], - 'constant declaration: const' => ['/* testConst */'], - 'constant declaration: continue' => ['/* testContinue */'], - 'constant declaration: declare' => ['/* testDeclare */'], - 'constant declaration: default' => ['/* testDefault */'], - 'constant declaration: do' => ['/* testDo */'], - 'constant declaration: echo' => ['/* testEcho */'], - 'constant declaration: else' => ['/* testElse */'], - 'constant declaration: elseif' => ['/* testElseIf */'], - 'constant declaration: empty' => ['/* testEmpty */'], - 'constant declaration: enddeclare' => ['/* testEndDeclare */'], - 'constant declaration: endfor' => ['/* testEndFor */'], - 'constant declaration: endforeach' => ['/* testEndForeach */'], - 'constant declaration: endif' => ['/* testEndIf */'], - 'constant declaration: endswitch' => ['/* testEndSwitch */'], - 'constant declaration: endwhile' => ['/* testEndWhile */'], - 'constant declaration: enum' => ['/* testEnum */'], - 'constant declaration: eval' => ['/* testEval */'], - 'constant declaration: exit' => ['/* testExit */'], - 'constant declaration: extends' => ['/* testExtends */'], - 'constant declaration: final' => ['/* testFinal */'], - 'constant declaration: finally' => ['/* testFinally */'], - 'constant declaration: fn' => ['/* testFn */'], - 'constant declaration: for' => ['/* testFor */'], - 'constant declaration: foreach' => ['/* testForeach */'], - 'constant declaration: function' => ['/* testFunction */'], - 'constant declaration: global' => ['/* testGlobal */'], - 'constant declaration: goto' => ['/* testGoto */'], - 'constant declaration: if' => ['/* testIf */'], - 'constant declaration: implements' => ['/* testImplements */'], - 'constant declaration: include' => ['/* testInclude */'], - 'constant declaration: include_once' => ['/* testIncludeOnce */'], - 'constant declaration: instanceof' => ['/* testInstanceOf */'], - 'constant declaration: insteadof' => ['/* testInsteadOf */'], - 'constant declaration: interface' => ['/* testInterface */'], - 'constant declaration: isset' => ['/* testIsset */'], - 'constant declaration: list' => ['/* testList */'], - 'constant declaration: match' => ['/* testMatch */'], - 'constant declaration: namespace' => ['/* testNamespace */'], - 'constant declaration: new' => ['/* testNew */'], - 'constant declaration: print' => ['/* testPrint */'], - 'constant declaration: private' => ['/* testPrivate */'], - 'constant declaration: protected' => ['/* testProtected */'], - 'constant declaration: public' => ['/* testPublic */'], - 'constant declaration: readonly' => ['/* testReadonly */'], - 'constant declaration: require' => ['/* testRequire */'], - 'constant declaration: require_once' => ['/* testRequireOnce */'], - 'constant declaration: return' => ['/* testReturn */'], - 'constant declaration: static' => ['/* testStatic */'], - 'constant declaration: switch' => ['/* testSwitch */'], - 'constant declaration: throws' => ['/* testThrows */'], - 'constant declaration: trait' => ['/* testTrait */'], - 'constant declaration: try' => ['/* testTry */'], - 'constant declaration: unset' => ['/* testUnset */'], - 'constant declaration: use' => ['/* testUse */'], - 'constant declaration: var' => ['/* testVar */'], - 'constant declaration: while' => ['/* testWhile */'], - 'constant declaration: yield' => ['/* testYield */'], - 'constant declaration: yield_from' => ['/* testYieldFrom */'], - 'constant declaration: and' => ['/* testAnd */'], - 'constant declaration: or' => ['/* testOr */'], - 'constant declaration: xor' => ['/* testXor */'], - - 'constant declaration: array in type' => ['/* testArrayIsTstringInConstType */'], - 'constant declaration: array, name after type' => ['/* testArrayNameForTypedConstant */'], - 'constant declaration: static, name after type' => ['/* testStaticIsNameForTypedConstant */'], - 'constant declaration: private, name after type' => ['/* testPrivateNameForUnionTypedConstant */'], - 'constant declaration: final, name after type' => ['/* testFinalNameForIntersectionTypedConstant */'], - - 'namespace declaration: class' => ['/* testKeywordAfterNamespaceShouldBeString */'], - 'namespace declaration (partial): my' => ['/* testNamespaceNameIsString1 */'], - 'namespace declaration (partial): class' => ['/* testNamespaceNameIsString2 */'], - 'namespace declaration (partial): foreach' => ['/* testNamespaceNameIsString3 */'], - - 'function declaration: eval' => ['/* testKeywordAfterFunctionShouldBeString */'], - 'function declaration with return by ref: switch' => ['/* testKeywordAfterFunctionByRefShouldBeString */'], - 'function declaration with return by ref: static' => ['/* testKeywordStaticAfterFunctionByRefShouldBeString */'], - - 'function call: static' => ['/* testKeywordAsFunctionCallNameShouldBeStringStatic */'], - 'method call: static' => ['/* testKeywordAsMethodCallNameShouldBeStringStatic */'], - 'method call: static with dnf look a like param' => ['/* testKeywordAsFunctionCallNameShouldBeStringStaticDNFLookaLike */'], - ]; - - }//end dataStrings() - - - /** - * Test that context sensitive keyword is tokenized as keyword when it should be keyword. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $expectedTokenType The expected token type. - * - * @dataProvider dataKeywords - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testKeywords($testMarker, $expectedTokenType) - { - $tokenTargets = Tokens::$contextSensitiveKeywords; - $tokenTargets[] = T_STRING; - $tokenTargets[] = T_ANON_CLASS; - $tokenTargets[] = T_MATCH_DEFAULT; - $tokenTargets[] = T_PRIVATE_SET; - $tokenTargets[] = T_PROTECTED_SET; - $tokenTargets[] = T_PUBLIC_SET; - - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, $tokenTargets); - $tokenArray = $tokens[$target]; - - $this->assertSame( - constant($expectedTokenType), - $tokenArray['code'], - 'Token tokenized as '.$tokenArray['type'].', not '.$expectedTokenType.' (code)' - ); - $this->assertSame( - $expectedTokenType, - $tokenArray['type'], - 'Token tokenized as '.$tokenArray['type'].', not '.$expectedTokenType.' (type)' - ); - - }//end testKeywords() - - - /** - * Data provider. - * - * @see testKeywords() - * - * @return array> - */ - public static function dataKeywords() - { - return [ - 'namespace: declaration' => [ - 'testMarker' => '/* testNamespaceIsKeyword */', - 'expectedTokenType' => 'T_NAMESPACE', - ], - 'array: default value in const decl' => [ - 'testMarker' => '/* testArrayIsKeywordInConstDefault */', - 'expectedTokenType' => 'T_ARRAY', - ], - 'static: type in constant declaration' => [ - 'testMarker' => '/* testStaticIsKeywordAsConstType */', - 'expectedTokenType' => 'T_STATIC', - ], - 'static: value in constant declaration' => [ - 'testMarker' => '/* testStaticIsKeywordAsConstDefault */', - 'expectedTokenType' => 'T_STATIC', - ], - - 'abstract: class declaration' => [ - 'testMarker' => '/* testAbstractIsKeyword */', - 'expectedTokenType' => 'T_ABSTRACT', - ], - 'class: declaration' => [ - 'testMarker' => '/* testClassIsKeyword */', - 'expectedTokenType' => 'T_CLASS', - ], - 'extends: in class declaration' => [ - 'testMarker' => '/* testExtendsIsKeyword */', - 'expectedTokenType' => 'T_EXTENDS', - ], - 'implements: in class declaration' => [ - 'testMarker' => '/* testImplementsIsKeyword */', - 'expectedTokenType' => 'T_IMPLEMENTS', - ], - 'use: in trait import' => [ - 'testMarker' => '/* testUseIsKeyword */', - 'expectedTokenType' => 'T_USE', - ], - 'insteadof: in trait import' => [ - 'testMarker' => '/* testInsteadOfIsKeyword */', - 'expectedTokenType' => 'T_INSTEADOF', - ], - 'as: in trait import' => [ - 'testMarker' => '/* testAsIsKeyword */', - 'expectedTokenType' => 'T_AS', - ], - 'const: declaration' => [ - 'testMarker' => '/* testConstIsKeyword */', - 'expectedTokenType' => 'T_CONST', - ], - 'private: property declaration' => [ - 'testMarker' => '/* testPrivateIsKeyword */', - 'expectedTokenType' => 'T_PRIVATE', - ], - 'protected: property declaration' => [ - 'testMarker' => '/* testProtectedIsKeyword */', - 'expectedTokenType' => 'T_PROTECTED', - ], - 'public: property declaration' => [ - 'testMarker' => '/* testPublicIsKeyword */', - 'expectedTokenType' => 'T_PUBLIC', - ], - 'private(set): property declaration' => [ - 'testMarker' => '/* testPrivateSetIsKeyword */', - 'expectedTokenType' => 'T_PRIVATE_SET', - ], - 'protected(set): property declaration' => [ - 'testMarker' => '/* testProtectedSetIsKeyword */', - 'expectedTokenType' => 'T_PROTECTED_SET', - ], - 'public(set): property declaration' => [ - 'testMarker' => '/* testPublicSetIsKeyword */', - 'expectedTokenType' => 'T_PUBLIC_SET', - ], - 'var: property declaration' => [ - 'testMarker' => '/* testVarIsKeyword */', - 'expectedTokenType' => 'T_VAR', - ], - 'static: property declaration' => [ - 'testMarker' => '/* testStaticIsKeyword */', - 'expectedTokenType' => 'T_STATIC', - ], - 'readonly: property declaration' => [ - 'testMarker' => '/* testReadonlyIsKeywordForProperty */', - 'expectedTokenType' => 'T_READONLY', - ], - 'final: function declaration' => [ - 'testMarker' => '/* testFinalIsKeyword */', - 'expectedTokenType' => 'T_FINAL', - ], - 'function: declaration' => [ - 'testMarker' => '/* testFunctionIsKeyword */', - 'expectedTokenType' => 'T_FUNCTION', - ], - 'callable: param type declaration' => [ - 'testMarker' => '/* testCallableIsKeyword */', - 'expectedTokenType' => 'T_CALLABLE', - ], - 'readonly: anon class declaration' => [ - 'testMarker' => '/* testReadonlyIsKeywordForAnonClass */', - 'expectedTokenType' => 'T_READONLY', - ], - 'return: statement' => [ - 'testMarker' => '/* testReturnIsKeyword */', - 'expectedTokenType' => 'T_RETURN', - ], - - 'interface: declaration' => [ - 'testMarker' => '/* testInterfaceIsKeyword */', - 'expectedTokenType' => 'T_INTERFACE', - ], - 'trait: declaration' => [ - 'testMarker' => '/* testTraitIsKeyword */', - 'expectedTokenType' => 'T_TRAIT', - ], - 'enum: declaration' => [ - 'testMarker' => '/* testEnumIsKeyword */', - 'expectedTokenType' => 'T_ENUM', - ], - - 'new: named instantiation' => [ - 'testMarker' => '/* testNewIsKeyword */', - 'expectedTokenType' => 'T_NEW', - ], - 'instanceof: comparison' => [ - 'testMarker' => '/* testInstanceOfIsKeyword */', - 'expectedTokenType' => 'T_INSTANCEOF', - ], - 'clone' => [ - 'testMarker' => '/* testCloneIsKeyword */', - 'expectedTokenType' => 'T_CLONE', - ], - - 'if' => [ - 'testMarker' => '/* testIfIsKeyword */', - 'expectedTokenType' => 'T_IF', - ], - 'empty' => [ - 'testMarker' => '/* testEmptyIsKeyword */', - 'expectedTokenType' => 'T_EMPTY', - ], - 'elseif' => [ - 'testMarker' => '/* testElseIfIsKeyword */', - 'expectedTokenType' => 'T_ELSEIF', - ], - 'else' => [ - 'testMarker' => '/* testElseIsKeyword */', - 'expectedTokenType' => 'T_ELSE', - ], - 'endif' => [ - 'testMarker' => '/* testEndIfIsKeyword */', - 'expectedTokenType' => 'T_ENDIF', - ], - - 'for' => [ - 'testMarker' => '/* testForIsKeyword */', - 'expectedTokenType' => 'T_FOR', - ], - 'endfor' => [ - 'testMarker' => '/* testEndForIsKeyword */', - 'expectedTokenType' => 'T_ENDFOR', - ], - - 'foreach' => [ - 'testMarker' => '/* testForeachIsKeyword */', - 'expectedTokenType' => 'T_FOREACH', - ], - 'endforeach' => [ - 'testMarker' => '/* testEndForeachIsKeyword */', - 'expectedTokenType' => 'T_ENDFOREACH', - ], - - 'switch' => [ - 'testMarker' => '/* testSwitchIsKeyword */', - 'expectedTokenType' => 'T_SWITCH', - ], - 'case: in switch' => [ - 'testMarker' => '/* testCaseIsKeyword */', - 'expectedTokenType' => 'T_CASE', - ], - 'default: in switch' => [ - 'testMarker' => '/* testDefaultIsKeyword */', - 'expectedTokenType' => 'T_DEFAULT', - ], - 'endswitch' => [ - 'testMarker' => '/* testEndSwitchIsKeyword */', - 'expectedTokenType' => 'T_ENDSWITCH', - ], - 'break: in switch' => [ - 'testMarker' => '/* testBreakIsKeyword */', - 'expectedTokenType' => 'T_BREAK', - ], - 'continue: in switch' => [ - 'testMarker' => '/* testContinueIsKeyword */', - 'expectedTokenType' => 'T_CONTINUE', - ], - - 'do' => [ - 'testMarker' => '/* testDoIsKeyword */', - 'expectedTokenType' => 'T_DO', - ], - 'while' => [ - 'testMarker' => '/* testWhileIsKeyword */', - 'expectedTokenType' => 'T_WHILE', - ], - 'endwhile' => [ - 'testMarker' => '/* testEndWhileIsKeyword */', - 'expectedTokenType' => 'T_ENDWHILE', - ], - - 'try' => [ - 'testMarker' => '/* testTryIsKeyword */', - 'expectedTokenType' => 'T_TRY', - ], - 'throw: statement' => [ - 'testMarker' => '/* testThrowIsKeyword */', - 'expectedTokenType' => 'T_THROW', - ], - 'catch' => [ - 'testMarker' => '/* testCatchIsKeyword */', - 'expectedTokenType' => 'T_CATCH', - ], - 'finally' => [ - 'testMarker' => '/* testFinallyIsKeyword */', - 'expectedTokenType' => 'T_FINALLY', - ], - - 'global' => [ - 'testMarker' => '/* testGlobalIsKeyword */', - 'expectedTokenType' => 'T_GLOBAL', - ], - 'echo' => [ - 'testMarker' => '/* testEchoIsKeyword */', - 'expectedTokenType' => 'T_ECHO', - ], - 'print: statement' => [ - 'testMarker' => '/* testPrintIsKeyword */', - 'expectedTokenType' => 'T_PRINT', - ], - 'die: statement' => [ - 'testMarker' => '/* testDieIsKeyword */', - 'expectedTokenType' => 'T_EXIT', - ], - 'eval' => [ - 'testMarker' => '/* testEvalIsKeyword */', - 'expectedTokenType' => 'T_EVAL', - ], - 'exit: statement' => [ - 'testMarker' => '/* testExitIsKeyword */', - 'expectedTokenType' => 'T_EXIT', - ], - 'isset' => [ - 'testMarker' => '/* testIssetIsKeyword */', - 'expectedTokenType' => 'T_ISSET', - ], - 'unset' => [ - 'testMarker' => '/* testUnsetIsKeyword */', - 'expectedTokenType' => 'T_UNSET', - ], - '\\die: statement (fully qualified)' => [ - 'testMarker' => '/* testFullyQualifiedDieIsKeyword */', - 'expectedTokenType' => 'T_EXIT', - ], - '\\exit: statement (fully qualified)' => [ - 'testMarker' => '/* testFullyQualifiedExitIsKeyword */', - 'expectedTokenType' => 'T_EXIT', - ], - - 'include' => [ - 'testMarker' => '/* testIncludeIsKeyword */', - 'expectedTokenType' => 'T_INCLUDE', - ], - 'include_once' => [ - 'testMarker' => '/* testIncludeOnceIsKeyword */', - 'expectedTokenType' => 'T_INCLUDE_ONCE', - ], - 'require' => [ - 'testMarker' => '/* testRequireIsKeyword */', - 'expectedTokenType' => 'T_REQUIRE', - ], - 'require_once' => [ - 'testMarker' => '/* testRequireOnceIsKeyword */', - 'expectedTokenType' => 'T_REQUIRE_ONCE', - ], - - 'list' => [ - 'testMarker' => '/* testListIsKeyword */', - 'expectedTokenType' => 'T_LIST', - ], - 'goto' => [ - 'testMarker' => '/* testGotoIsKeyword */', - 'expectedTokenType' => 'T_GOTO', - ], - 'match' => [ - 'testMarker' => '/* testMatchIsKeyword */', - 'expectedTokenType' => 'T_MATCH', - ], - 'default: in match expression' => [ - 'testMarker' => '/* testMatchDefaultIsKeyword */', - 'expectedTokenType' => 'T_MATCH_DEFAULT', - ], - 'fn' => [ - 'testMarker' => '/* testFnIsKeyword */', - 'expectedTokenType' => 'T_FN', - ], - - 'yield' => [ - 'testMarker' => '/* testYieldIsKeyword */', - 'expectedTokenType' => 'T_YIELD', - ], - 'yield from' => [ - 'testMarker' => '/* testYieldFromIsKeyword */', - 'expectedTokenType' => 'T_YIELD_FROM', - ], - - 'declare' => [ - 'testMarker' => '/* testDeclareIsKeyword */', - 'expectedTokenType' => 'T_DECLARE', - ], - 'enddeclare' => [ - 'testMarker' => '/* testEndDeclareIsKeyword */', - 'expectedTokenType' => 'T_ENDDECLARE', - ], - - 'and: in if' => [ - 'testMarker' => '/* testAndIsKeyword */', - 'expectedTokenType' => 'T_LOGICAL_AND', - ], - 'or: in if' => [ - 'testMarker' => '/* testOrIsKeyword */', - 'expectedTokenType' => 'T_LOGICAL_OR', - ], - 'xor: in if' => [ - 'testMarker' => '/* testXorIsKeyword */', - 'expectedTokenType' => 'T_LOGICAL_XOR', - ], - - 'class: anon class declaration' => [ - 'testMarker' => '/* testAnonymousClassIsKeyword */', - 'expectedTokenType' => 'T_ANON_CLASS', - ], - 'extends: anon class declaration' => [ - 'testMarker' => '/* testExtendsInAnonymousClassIsKeyword */', - 'expectedTokenType' => 'T_EXTENDS', - ], - 'implements: anon class declaration' => [ - 'testMarker' => '/* testImplementsInAnonymousClassIsKeyword */', - 'expectedTokenType' => 'T_IMPLEMENTS', - ], - 'static: class instantiation' => [ - 'testMarker' => '/* testClassInstantiationStaticIsKeyword */', - 'expectedTokenType' => 'T_STATIC', - ], - 'namespace: operator' => [ - 'testMarker' => '/* testNamespaceInNameIsKeyword */', - 'expectedTokenType' => 'T_NAMESPACE', - ], - - 'static: closure declaration' => [ - 'testMarker' => '/* testStaticIsKeywordBeforeClosure */', - 'expectedTokenType' => 'T_STATIC', - ], - 'static: parameter type (illegal)' => [ - 'testMarker' => '/* testStaticIsKeywordWhenParamType */', - 'expectedTokenType' => 'T_STATIC', - ], - 'static: arrow function declaration' => [ - 'testMarker' => '/* testStaticIsKeywordBeforeArrow */', - 'expectedTokenType' => 'T_STATIC', - ], - 'static: return type for arrow function' => [ - 'testMarker' => '/* testStaticIsKeywordWhenReturnType */', - 'expectedTokenType' => 'T_STATIC', - ], - 'static: property modifier before DNF' => [ - 'testMarker' => '/* testStaticIsKeywordPropertyModifierBeforeDNF */', - 'expectedTokenType' => 'T_STATIC', - ], - ]; - - }//end dataKeywords() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesParseError1Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesParseError1Test.inc deleted file mode 100644 index a6cf511c2..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesParseError1Test.inc +++ /dev/null @@ -1,17 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class DNFTypesParseError1Test extends AbstractTokenizerTestCase -{ - - - /** - * Document handling for a DNF type / parse error where the last significant type specific token is an open parenthesis. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataBrokenDNFTypeCantEndOnOpenParenthesis - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testBrokenDNFTypeCantEndOnOpenParenthesis($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $openPtr = $this->getTargetToken($testMarker, [T_OPEN_PARENTHESIS, T_TYPE_OPEN_PARENTHESIS], '('); - $token = $tokens[$openPtr]; - - // Verify that the open parenthesis is tokenized as a normal parenthesis. - $this->assertSame(T_OPEN_PARENTHESIS, $token['code'], 'Token tokenized as '.$token['type'].', not T_OPEN_PARENTHESIS (code)'); - $this->assertSame('T_OPEN_PARENTHESIS', $token['type'], 'Token tokenized as '.$token['type'].', not T_OPEN_PARENTHESIS (type)'); - - // Verify that the type union is still tokenized as T_BITWISE_OR as the type declaration - // is not recognized as a valid type declaration. - $unionPtr = $this->getTargetToken($testMarker, [T_BITWISE_OR, T_TYPE_UNION], '|'); - $token = $tokens[$unionPtr]; - - $this->assertSame(T_BITWISE_OR, $token['code'], 'Token tokenized as '.$token['type'].', not T_BITWISE_OR (code)'); - $this->assertSame('T_BITWISE_OR', $token['type'], 'Token tokenized as '.$token['type'].', not T_BITWISE_OR (type)'); - - }//end testBrokenDNFTypeCantEndOnOpenParenthesis() - - - /** - * Data provider. - * - * @see testBrokenDNFTypeCantEndOnOpenParenthesis() - * - * @return array> - */ - public static function dataBrokenDNFTypeCantEndOnOpenParenthesis() - { - return [ - 'OO const type' => ['/* testBrokenConstDNFTypeEndOnOpenParenthesis */'], - 'OO property type' => ['/* testBrokenPropertyDNFTypeEndOnOpenParenthesis */'], - 'Parameter type' => ['/* testBrokenParamDNFTypeEndOnOpenParenthesis */'], - 'Return type' => ['/* testBrokenReturnDNFTypeEndOnOpenParenthesis */'], - ]; - - }//end dataBrokenDNFTypeCantEndOnOpenParenthesis() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesParseError2Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesParseError2Test.inc deleted file mode 100644 index 792975828..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesParseError2Test.inc +++ /dev/null @@ -1,48 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class DNFTypesParseError2Test extends AbstractTokenizerTestCase -{ - - - /** - * Document handling for a DNF type / parse error where the type declaration contains an unmatched parenthesis. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - // Verify that the type union is still tokenized as T_BITWISE_OR as the type declaration - // is not recognized as a valid type declaration. - $unionPtr = $this->getTargetToken($testMarker, [T_BITWISE_OR, T_TYPE_UNION], '|'); - $token = $tokens[$unionPtr]; - - $this->assertSame(T_BITWISE_OR, $token['code'], 'Token tokenized as '.$token['type'].', not T_BITWISE_OR (code)'); - $this->assertSame('T_BITWISE_OR', $token['type'], 'Token tokenized as '.$token['type'].', not T_BITWISE_OR (type)'); - - // Verify that the unmatched open parenthesis is tokenized as a normal parenthesis. - $openPtr = $this->getTargetToken($testMarker, [T_OPEN_PARENTHESIS, T_TYPE_OPEN_PARENTHESIS], '('); - $token = $tokens[$openPtr]; - - $this->assertSame(T_OPEN_PARENTHESIS, $token['code'], 'Token tokenized as '.$token['type'].', not T_OPEN_PARENTHESIS (code)'); - $this->assertSame('T_OPEN_PARENTHESIS', $token['type'], 'Token tokenized as '.$token['type'].', not T_OPEN_PARENTHESIS (type)'); - - // Verify that the type intersection is still tokenized as T_BITWISE_AND as the type declaration - // is not recognized as a valid type declaration. - $intersectPtr = $this->getTargetToken($testMarker, [T_BITWISE_AND, T_TYPE_INTERSECTION], '&'); - $token = $tokens[$intersectPtr]; - - $this->assertSame(T_BITWISE_AND, $token['code'], 'Token tokenized as '.$token['type'].', not T_BITWISE_AND (code)'); - $this->assertSame('T_BITWISE_AND', $token['type'], 'Token tokenized as '.$token['type'].', not T_BITWISE_AND (type)'); - - }//end testBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens() - - - /** - * Data provider. - * - * @see testBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens() - * - * @return array> - */ - public static function dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens() - { - return [ - 'OO const type' => ['/* testBrokenConstDNFTypeParensMissingClose */'], - 'OO property type' => ['/* testBrokenPropertyDNFTypeParensMissingClose */'], - 'Parameter type' => ['/* testBrokenParamDNFTypeParensMissingClose */'], - 'Return type' => ['/* testBrokenReturnDNFTypeParensMissingClose */'], - ]; - - }//end dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingCloseParens() - - - /** - * Document handling for a DNF type / parse error where the type declaration contains an unmatched parenthesis. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - // Verify that the type union is still tokenized as T_BITWISE_OR as the type declaration - // is not recognized as a valid type declaration. - $unionPtr = $this->getTargetToken($testMarker, [T_BITWISE_OR, T_TYPE_UNION], '|'); - $token = $tokens[$unionPtr]; - - $this->assertSame(T_BITWISE_OR, $token['code'], 'Token tokenized as '.$token['type'].', not T_BITWISE_OR (code)'); - $this->assertSame('T_BITWISE_OR', $token['type'], 'Token tokenized as '.$token['type'].', not T_BITWISE_OR (type)'); - - // Verify that the unmatched open parenthesis is tokenized as a normal parenthesis. - $closePtr = $this->getTargetToken($testMarker, [T_CLOSE_PARENTHESIS, T_TYPE_CLOSE_PARENTHESIS], ')'); - $token = $tokens[$closePtr]; - - $this->assertSame(T_CLOSE_PARENTHESIS, $token['code'], 'Token tokenized as '.$token['type'].', not T_CLOSE_PARENTHESIS (code)'); - $this->assertSame('T_CLOSE_PARENTHESIS', $token['type'], 'Token tokenized as '.$token['type'].', not T_CLOSE_PARENTHESIS (type)'); - - // Verify that the type intersection is still tokenized as T_BITWISE_AND as the type declaration - // is not recognized as a valid type declaration. - $intersectPtr = $this->getTargetToken($testMarker, [T_BITWISE_AND, T_TYPE_INTERSECTION], '&'); - $token = $tokens[$intersectPtr]; - - $this->assertSame(T_BITWISE_AND, $token['code'], 'Token tokenized as '.$token['type'].', not T_BITWISE_AND (code)'); - $this->assertSame('T_BITWISE_AND', $token['type'], 'Token tokenized as '.$token['type'].', not T_BITWISE_AND (type)'); - - }//end testBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens() - - - /** - * Data provider. - * - * @see testBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens() - * - * @return array> - */ - public static function dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens() - { - return [ - 'OO const type' => ['/* testBrokenConstDNFTypeParensMissingOpen */'], - 'OO property type' => ['/* testBrokenPropertyDNFTypeParensMissingOpen */'], - 'Parameter type' => ['/* testBrokenParamDNFTypeParensMissingOpen */'], - 'Return type' => ['/* testBrokenReturnDNFTypeParensMissingOpen */'], - ]; - - }//end dataBrokenDNFTypeParensShouldAlwaysBeAPairMissingOpenParens() - - - /** - * Document handling for a DNF type / parse error where the type declaration contains an unmatched parenthesis, - * but also contains a set of matched parentheses. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $startPtr = $this->getTargetToken($testMarker, [T_OPEN_PARENTHESIS, T_TYPE_OPEN_PARENTHESIS], '('); - - for ($i = $startPtr; $i < $this->phpcsFile->numTokens; $i++) { - if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { - continue; - } - - if ($tokens[$i]['code'] === T_EQUAL - || $tokens[$i]['code'] === T_VARIABLE - || $tokens[$i]['code'] === T_OPEN_CURLY_BRACKET - ) { - // Reached the end of the type. - break; - } - - $errorPrefix = 'Token tokenized as '.$tokens[$i]['type']; - - // Verify that type tokens have not been retokenized to `T_TYPE_*` tokens for broken type declarations. - switch ($tokens[$i]['content']) { - case '|': - $this->assertSame(T_BITWISE_OR, $tokens[$i]['code'], $errorPrefix.', not T_BITWISE_OR (code)'); - $this->assertSame('T_BITWISE_OR', $tokens[$i]['type'], $errorPrefix.', not T_BITWISE_OR (type)'); - break; - - case '&': - $this->assertSame(T_BITWISE_AND, $tokens[$i]['code'], $errorPrefix.', not T_BITWISE_AND (code)'); - $this->assertSame('T_BITWISE_AND', $tokens[$i]['type'], $errorPrefix.', not T_BITWISE_AND (type)'); - break; - - case '(': - // Verify that the open parenthesis is tokenized as a normal parenthesis. - $this->assertSame(T_OPEN_PARENTHESIS, $tokens[$i]['code'], $errorPrefix.', not T_OPEN_PARENTHESIS (code)'); - $this->assertSame('T_OPEN_PARENTHESIS', $tokens[$i]['type'], $errorPrefix.', not T_OPEN_PARENTHESIS (type)'); - break; - - case ')': - $this->assertSame(T_CLOSE_PARENTHESIS, $tokens[$i]['code'], $errorPrefix.', not T_CLOSE_PARENTHESIS (code)'); - $this->assertSame('T_CLOSE_PARENTHESIS', $tokens[$i]['type'], $errorPrefix.', not T_CLOSE_PARENTHESIS (type)'); - break; - - default: - break; - }//end switch - }//end for - - }//end testBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched() - - - /** - * Data provider. - * - * @see testBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched() - * - * @return array> - */ - public static function dataBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched() - { - return [ - 'OO const type - missing one close parenthesis' => ['/* testBrokenConstDNFTypeParensMissingOneClose */'], - 'OO property type - missing one open parenthesis' => ['/* testBrokenPropertyDNFTypeParensMissingOneOpen */'], - 'Parameter type - missing one close parenthesis' => ['/* testBrokenParamDNFTypeParensMissingOneClose */'], - 'Return type - missing one open parenthesis' => ['/* testBrokenReturnDNFTypeParensMissingOneOpen */'], - ]; - - }//end dataBrokenDNFTypeParensShouldAlwaysBeAPairMatchedAndUnmatched() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesTest.inc deleted file mode 100644 index 877d57ed9..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesTest.inc +++ /dev/null @@ -1,288 +0,0 @@ - 10 ) {} - -/* testParensOwnerFor */ -for ($i =0; $i < /* testParensNoOwnerInForCondition */ ( CONST_A & CONST_B ); $i++ ); - -/* testParensOwnerMatch */ -$match = match(CONST_A & CONST_B) { - default => $a, -}; - -/* testParensOwnerArray */ -$array = array ( - 'text', - \CONST_A & \Fully\Qualified\CONST_B, - /* testParensNoOwnerFunctionCallWithAmpersandInCallable */ - do_something($a, /* testParensOwnerArrowFn */ fn($b) => $a & $b, $c), -); - -/* testParensOwnerListWithRefVars */ -list(&$a, &$b) = $array; - -/* testParensNoOwnerFunctionCallwithDNFLookALikeParam */ -$obj->static((CONST_A&CONST_B)|CONST_C | $var); - -/* testParensNoOwnerFunctionCallWithDNFLookALikeNamedParamPlain */ -callMe(label: false); - -/* testParensNoOwnerFunctionCallWithDNFLookALikeNamedParamUnion */ -callMe(label: CONST_A | CONST_B); - -/* testParensNoOwnerFunctionCallWithDNFLookALikeNamedParamIntersect */ -callMe(label: CONST_A & CONST_B); - -\Z1\call11( - /* testParensNoOwnerFunctionCallInNamedParam */ - param1: \Z2\call12(), - /* testParensOwnerArrowFunctionInNamedParam */ - param2: fn (): /* testDNFTypeArrowFnReturnInNamedParam */ int|(\Countable&\Iterable) - /* testParensNoOwnerFunctionCallInArrowFnReturn */ - => \Z3\call13(), - /* testParensOwnerClosureInNamedParam */ - param3: function (): /* testDNFTypeClosureReturnInNamedParam */ int|(\DateTime&\ArrayObject) { - /* testParensNoOwnerFunctionCallInClosureReturn */ - return \Z4\call14(); - }, -); - -/* testSwitchControlStructureCondition */ -switch (CONST_A | CONST_B) { - /* testFunctionCallInSwitchCaseCondition */ - case get_bool(): - /* testFunctionCallInSwitchCaseBody */ - \Name\functionInSwitch(); - break; - - default: - /* testFunctionCallInSwitchDefaultBody */ - functionInSwitch(); - break; -} - -/* testIfAlternativeSyntaxCondition */ -if (true): - /* testFunctionCallInIfBody */ - \B\call(); -/* testElseIfAlternativeSyntaxCondition */ -elseif (10): - /* testFunctionCallInElseIfBody */ - C\call(); -else: - /* testFunctionCallInElseBody */ - \C\call3(); -endif; - -gotolabel: - /* testFunctionCallInGotoBody */ - \doSomething(); - -/* testWhileAlternativeSyntaxCondition */ -while ($c3): - /* testFunctionCallInWhileBody */ - \D\call4(); -endwhile; - -/* testForAlternativeSyntaxCondition */ -for ($i = 0; $i < 10; $i++): - /* testFunctionCallInForBody */ - \F\call5(); -endfor; - -/* testForEachAlternativeSyntaxCondition */ -foreach ($array as $key => $value): - /* testFunctionCallInForeachBody */ - \G\call6(); -endforeach; - -/* - * DNF parentheses. - */ - -abstract class DNFTypes { - /* testDNFTypeOOConstUnqualifiedClasses */ - public const (A&B)|D UNQUALIFIED = new Foo; - - /* testDNFTypeOOConstReverseModifierOrder */ - protected final const int|(Foo&Bar)|float MODIFIERS_REVERSED /* testParensNoOwnerOOConstDefaultValue */ = (E_WARNING & E_NOTICE) | E_DEPRECATED; - - const - /* testDNFTypeOOConstMulti1 */ - (A&B) | - /* testDNFTypeOOConstMulti2 */ - (C&D) | // phpcs:ignore Stnd.Cat.Sniff - /* testDNFTypeOOConstMulti3 */ - (Y&D) - | null MULTI_DNF = null; - - /* testDNFTypeOOConstNamespaceRelative */ - final protected const (namespace\Sub\NameA&namespace\Sub\NameB)|namespace\Sub\NameC NAMESPACE_RELATIVE = new namespace\Sub\NameB; - - /* testDNFTypeOOConstPartiallyQualified */ - const Partially\Qualified\NameC|(Partially\Qualified\NameA&Partially\Qualified\NameB) PARTIALLY_QUALIFIED = new Partially\Qualified\NameA; - - /* testDNFTypeOOConstFullyQualified */ - const (\Fully\Qualified\NameA&\Fully\Qualified\NameB)|\Fully\Qualified\NameC FULLY_QUALIFIED = new \Fully\Qualified\NameB(); - - /* testDNFTypePropertyUnqualifiedClasses */ - public static (Foo&Bar)|array $obj; - - /* testDNFTypePropertyReverseModifierOrder */ - static protected string|(A&B)|int $dnf /* testParensNoOwnerPropertyDefaultValue1 */ = ( E_WARNING & E_NOTICE ) | /* testParensNoOwnerPropertyDefaultValue2 */ (E_ALL & E_DEPRECATED); - - private - /* testDNFTypePropertyMultiNamespaceRelative */ - (namespace\Sub\NameA&namespace\Sub\NameB) | - /* testDNFTypePropertyMultiPartiallyQualified */ - (Partially\Qualified\NameA&Partially\Qualified\NameB) | // phpcs:ignore Stnd.Cat.Sniff - false - /* testDNFTypePropertyMultiFullyQualified */ - | (\Fully\Qualified\NameA&\Fully\Qualified\NameB) $multiDnf; - - /* testDNFTypePropertyWithReadOnlyKeyword1 */ - protected readonly (A&B) | /* testDNFTypePropertyWithReadOnlyKeyword2 */ (C&D) $readonly; - - /* testDNFTypePropertyWithStaticAndReadOnlyKeywords */ - static readonly (A&B&C)|array $staticReadonly; - - /* testDNFTypePropertyWithOnlyStaticKeyword */ - static (A&B&C)|true $onlyStaticModified; - - /* testDNFTypeWithPHP84FinalKeyword */ - final (className&InterfaceName)|false $finalKeywordA; - - /* testDNFTypeWithPHP84FinalKeywordAndStatic */ - final static (\className&\InterfaceName)|false $finalKeywordB; - - /* testDNFTypePropertyWithPrivateSet */ - private(set) (A&B&C)|true $asym1; - - /* testDNFTypePropertyWithPublicPrivateSet */ - public private(set) (A&B&C)|true $asym2; - - /* testDNFTypePropertyWithProtectedSet */ - protected(set) (A&B&C)|true $asym3; - - /* testDNFTypePropertyWithPublicProtectedSet */ - public protected(set) (A&B&C)|true $asym4; - - /* testDNFTypeWithPHP84AbstractKeyword */ - abstract (className&InterfaceName)|false $abstractKeywordA { set; } - - /* testDNFTypeWithPHP84AbstractKeywordAndPublic */ - abstract public (\className&\InterfaceName)|false $abstractKeywordB { get; } - - public function paramTypes( - /* testDNFTypeParam1WithAttribute */ - #[MyAttribute] - (\Foo&Bar)|int|float $paramA /* testParensNoOwnerParamDefaultValue */ = SOMETHING | (CONSTANT_A & CONSTANT_B), - - /* testDNFTypeParam2 */ - (Foo&\Bar) /* testDNFTypeParam3 */ |(Baz&Fop) &...$paramB, - ) { - /* testParensNoOwnerInReturnValue1 */ - return ( - /* testParensNoOwnerInReturnValue2 */ - ($a1 & $b1) | - /* testParensNoOwnerInReturnValue3 */ - ($a2 & $b2) - ) + $c; - } - - public function identifierNames( - /* testDNFTypeParamNamespaceRelative */ - (namespace\Sub\NameA&namespace\Sub\NameB)|false $paramA, - /* testDNFTypeParamPartiallyQualified */ - Partially\Qualified\NameC|(Partially\Qualified\NameA&Partially\Qualified\NameB) $paramB, - /* testDNFTypeParamFullyQualified */ - name|(\Fully\Qualified\NameA&\Fully\Qualified\NameB) $paramC, - ) {} - - public function __construct( - /* testDNFTypeConstructorPropertyPromotion1 */ - public (A&B)| /* testDNFTypeConstructorPropertyPromotion2 */ (A&D) $property - ) {} - - public function returnType()/* testDNFTypeReturnType1 */ : A|(B&D)|/* testDNFTypeReturnType2 */(B&W)|null {} - - abstract public function abstractMethod(): /* testDNFTypeAbstractMethodReturnType1 */ (X&Y) /* testDNFTypeAbstractMethodReturnType2 */ |(W&Z); - - public function identifierNamesReturnRelative( - ) : /* testDNFTypeReturnTypeNamespaceRelative */ (namespace\Sub\NameA&namespace\Sub\NameB)|namespace\Sub\NameC {} - - public function identifierNamesReturnPQ( - ) : /* testDNFTypeReturnPartiallyQualified */Partially\Qualified\NameA|(Partially\Qualified\NameB&Partially\Qualified\NameC) {} - - // Illegal type: segments which are strict subsets of others are disallowed, but that's not the concern of the tokenizer. - public function identifierNamesReturnFQ( - ) /* testDNFTypeReturnFullyQualified */ : (\Fully\Qualified\NameA&\Fully\Qualified\NameB)|\Fully\Qualified\NameB {} -} - -function globalFunctionWithSpreadAndReference( - /* testDNFTypeWithReference */ - float|(B&A) &$paramA, - /* testDNFTypeWithSpreadOperator */ - string|(B&D) ...$paramB -) {} - - -$closureWithParamType = function ( /* testDNFTypeClosureParamIllegalNullable */ ?(A&B)|bool $string) {}; - -/* testParensOwnerClosureAmpersandInDefaultValue */ -$closureWithReturnType = function ($string = NONSENSE & FAKE) /* testDNFTypeClosureReturn */ : (\Package\MyA&PackageB)|null {}; - -$closureWithUseAndReturnType = function ($foo) use ($a) /* testDNFTypeClosureWithUseReturn */ : null|(Foo&\Bar)|false {}; - -/* testParensOwnerArrowDNFUsedWithin */ -$arrowWithParamType = fn ( - /* testDNFTypeArrowParam */ - int|(A&B&C)|array $param, - /* testParensNoOwnerAmpersandInDefaultValue */ ?int $int = (CONSTA & CONSTB )| CONST_C -) - /* testParensNoOwnerInArrowReturnExpression */ - => ($param & $foo ) | $int; - -$arrowWithReturnType = fn ($param) : /* testDNFTypeArrowReturnType */ int|(A&B) => $param * 10; - -$arrowWithParamReturnByRef = fn &( - /* testDNFTypeArrowParamWithReturnByRef */ - (A&B)|null $param -) => $param * 10; - -function InvalidSyntaxes( - /* testDNFTypeParamIllegalUnnecessaryParens */ - (A&B) $parensNotNeeded, - - /* testDNFTypeParamIllegalIntersectUnionReversed */ - A&(B|D) $onlyIntersectAllowedWithinParensAndUnionOutside, - - /* testDNFTypeParamIllegalNestedParens */ - A|(B&(D|W)|null) $nestedParensNotAllowed, -) {} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesTest.php deleted file mode 100644 index 312df1b37..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DNFTypesTest.php +++ /dev/null @@ -1,557 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class DNFTypesTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that parentheses when **not** used in a type declaration are correctly tokenized. - * - * @param string $testMarker The comment prefacing the target token. - * @param bool $skipCheckInside Optional. Skip checking correct token type inside the parentheses. - * Use judiciously for combined normal + DNF tests only. - * - * @dataProvider dataNormalParentheses - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNormalParentheses($testMarker, $skipCheckInside=false) - { - $tokens = $this->phpcsFile->getTokens(); - - $openPtr = $this->getTargetToken($testMarker, [T_OPEN_PARENTHESIS, T_TYPE_OPEN_PARENTHESIS]); - $opener = $tokens[$openPtr]; - - $this->assertSame('(', $opener['content'], 'Content of type open parenthesis is not "("'); - $this->assertSame(T_OPEN_PARENTHESIS, $opener['code'], 'Token tokenized as '.$opener['type'].', not T_OPEN_PARENTHESIS (code)'); - $this->assertSame('T_OPEN_PARENTHESIS', $opener['type'], 'Token tokenized as '.$opener['type'].', not T_OPEN_PARENTHESIS (type)'); - - $closePtr = $opener['parenthesis_closer']; - $closer = $tokens[$closePtr]; - - $this->assertSame(')', $closer['content'], 'Content of type close parenthesis is not ")"'); - $this->assertSame(T_CLOSE_PARENTHESIS, $closer['code'], 'Token tokenized as '.$closer['type'].', not T_CLOSE_PARENTHESIS (code)'); - $this->assertSame('T_CLOSE_PARENTHESIS', $closer['type'], 'Token tokenized as '.$closer['type'].', not T_CLOSE_PARENTHESIS (type)'); - - if ($skipCheckInside === false) { - for ($i = ($openPtr + 1); $i < $closePtr; $i++) { - // If there are ampersands, make sure these are tokenized as bitwise and. - if ($tokens[$i]['content'] === '&') { - $this->assertSame(T_BITWISE_AND, $tokens[$i]['code'], 'Token tokenized as '.$tokens[$i]['type'].', not T_BITWISE_AND (code)'); - $this->assertSame('T_BITWISE_AND', $tokens[$i]['type'], 'Token tokenized as '.$tokens[$i]['type'].', not T_BITWISE_AND (type)'); - } - - // If there are pipes, make sure these are tokenized as bitwise or. - if ($tokens[$i]['content'] === '|') { - $this->assertSame(T_BITWISE_OR, $tokens[$i]['code'], 'Token tokenized as '.$tokens[$i]['type'].', not T_BITWISE_OR (code)'); - $this->assertSame('T_BITWISE_OR', $tokens[$i]['type'], 'Token tokenized as '.$tokens[$i]['type'].', not T_BITWISE_OR (type)'); - } - } - } - - $before = $this->phpcsFile->findPrevious(Tokens::$emptyTokens, ($openPtr - 1), null, true); - if ($before !== false && $tokens[$before]['content'] === '|') { - $this->assertSame( - T_BITWISE_OR, - $tokens[$before]['code'], - 'Token before tokenized as '.$tokens[$before]['type'].', not T_BITWISE_OR (code)' - ); - $this->assertSame( - 'T_BITWISE_OR', - $tokens[$before]['type'], - 'Token before tokenized as '.$tokens[$before]['type'].', not T_BITWISE_OR (type)' - ); - } - - $after = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($closePtr + 1), null, true); - if ($after !== false && $tokens[$after]['content'] === '|') { - $this->assertSame( - T_BITWISE_OR, - $tokens[$after]['code'], - 'Token after tokenized as '.$tokens[$after]['type'].', not T_BITWISE_OR (code)' - ); - $this->assertSame( - 'T_BITWISE_OR', - $tokens[$after]['type'], - 'Token after tokenized as '.$tokens[$after]['type'].', not T_BITWISE_OR (type)' - ); - } - - }//end testNormalParentheses() - - - /** - * Data provider. - * - * @see testNormalParentheses() - * - * @return array> - */ - public static function dataNormalParentheses() - { - // "Owner" offsets are relative to the open parenthesis. - return [ - 'parens without owner' => [ - 'testMarker' => '/* testParensNoOwner */', - ], - 'parens without owner in ternary then' => [ - 'testMarker' => '/* testParensNoOwnerInTernary */', - ], - 'parens without owner in short ternary' => [ - 'testMarker' => '/* testParensNoOwnerInShortTernary */', - ], - 'parens without owner in ternary then (fn call in inline then)' => [ - 'testMarker' => '/* testFnCallParensNoOwnerInTernaryA */', - ], - 'parens without owner in ternary then (fn call in inline else)' => [ - 'testMarker' => '/* testFnCallParensNoOwnerInTernaryB */', - ], - 'parens without owner in short ternary (fn call)' => [ - 'testMarker' => '/* testPFnCallarensNoOwnerInShortTernary */', - ], - 'parens with owner: function; & in default value' => [ - 'testMarker' => '/* testParensOwnerFunctionAmpersandInDefaultValue */', - ], - 'parens with owner: closure; param declared by & ref' => [ - 'testMarker' => '/* testParensOwnerClosureAmpersandParamRef */', - ], - 'parens with owner: if' => [ - 'testMarker' => '/* testParensOwnerIf */', - ], - 'parens without owner in if condition' => [ - 'testMarker' => '/* testParensNoOwnerInIfCondition */', - ], - 'parens with owner: for' => [ - 'testMarker' => '/* testParensOwnerFor */', - ], - 'parens without owner in for condition' => [ - 'testMarker' => '/* testParensNoOwnerInForCondition */', - ], - 'parens with owner: match' => [ - 'testMarker' => '/* testParensOwnerMatch */', - ], - 'parens with owner: array' => [ - 'testMarker' => '/* testParensOwnerArray */', - ], - 'parens without owner in array; function call with & in callable' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallWithAmpersandInCallable */', - ], - 'parens with owner: fn; & in return value' => [ - 'testMarker' => '/* testParensOwnerArrowFn */', - ], - 'parens with owner: list with reference vars' => [ - 'testMarker' => '/* testParensOwnerListWithRefVars */', - ], - 'parens without owner, function call with DNF look-a-like param' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallwithDNFLookALikeParam */', - ], - 'parens without owner, function call, named param' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallWithDNFLookALikeNamedParamPlain */', - ], - 'parens without owner, function call, named param + bitwise or' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallWithDNFLookALikeNamedParamUnion */', - ], - 'parens without owner, function call, named param + bitwise and' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallWithDNFLookALikeNamedParamIntersect */', - ], - 'parens without owner, function call in named param' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallInNamedParam */', - ], - 'parens with owner: fn; in named param' => [ - 'testMarker' => '/* testParensOwnerArrowFunctionInNamedParam */', - ], - 'parens without owner, function call in named param arrow return' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallInArrowFnReturn */', - ], - 'parens with owner: closure; in named param' => [ - 'testMarker' => '/* testParensOwnerClosureInNamedParam */', - ], - 'parens without owner, function call, named param closure return' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallInClosureReturn */', - ], - 'parens with owner: switch condition' => [ - 'testMarker' => '/* testSwitchControlStructureCondition */', - ], - 'parens without owner in switch-case condition' => [ - 'testMarker' => '/* testFunctionCallInSwitchCaseCondition */', - ], - 'parens without owner in switch-case body' => [ - 'testMarker' => '/* testFunctionCallInSwitchCaseBody */', - ], - 'parens without owner in switch-default body' => [ - 'testMarker' => '/* testFunctionCallInSwitchDefaultBody */', - ], - 'parens with owner: if condition, alternative syntax' => [ - 'testMarker' => '/* testIfAlternativeSyntaxCondition */', - ], - 'parens without owner in if body, alternative syntax' => [ - 'testMarker' => '/* testFunctionCallInIfBody */', - ], - 'parens with owner: elseif condition, alternative syntax' => [ - 'testMarker' => '/* testElseIfAlternativeSyntaxCondition */', - ], - 'parens without owner in elseif body, alternative syntax' => [ - 'testMarker' => '/* testFunctionCallInElseIfBody */', - ], - 'parens without owner in else body, alternative syntax' => [ - 'testMarker' => '/* testFunctionCallInElseBody */', - ], - 'parens without owner in goto body' => [ - 'testMarker' => '/* testFunctionCallInGotoBody */', - ], - 'parens with owner: while condition, alternative syntax' => [ - 'testMarker' => '/* testWhileAlternativeSyntaxCondition */', - ], - 'parens without owner in while body, alternative syntax' => [ - 'testMarker' => '/* testFunctionCallInWhileBody */', - ], - 'parens with owner: for condition, alternative syntax' => [ - 'testMarker' => '/* testForAlternativeSyntaxCondition */', - ], - 'parens without owner in for body, alternative syntax' => [ - 'testMarker' => '/* testFunctionCallInForBody */', - ], - 'parens with owner: foreach condition, alternative syntax' => [ - 'testMarker' => '/* testForEachAlternativeSyntaxCondition */', - ], - 'parens without owner in foreach body, alternative syntax' => [ - 'testMarker' => '/* testFunctionCallInForeachBody */', - ], - - 'parens without owner in OO const default value' => [ - 'testMarker' => '/* testParensNoOwnerOOConstDefaultValue */', - ], - 'parens without owner in property default 1' => [ - 'testMarker' => '/* testParensNoOwnerPropertyDefaultValue1 */', - ], - 'parens without owner in property default 2' => [ - 'testMarker' => '/* testParensNoOwnerPropertyDefaultValue2 */', - ], - 'parens without owner in param default value' => [ - 'testMarker' => '/* testParensNoOwnerParamDefaultValue */', - ], - 'parens without owner in return statement 1' => [ - 'testMarker' => '/* testParensNoOwnerInReturnValue1 */', - ], - 'parens without owner in return statement 2' => [ - 'testMarker' => '/* testParensNoOwnerInReturnValue2 */', - ], - 'parens without owner in return statement 3' => [ - 'testMarker' => '/* testParensNoOwnerInReturnValue3 */', - ], - 'parens with owner: closure; & in default value' => [ - 'testMarker' => '/* testParensOwnerClosureAmpersandInDefaultValue */', - ], - 'parens with owner: fn; dnf used within' => [ - 'testMarker' => '/* testParensOwnerArrowDNFUsedWithin */', - 'skipCheckInside' => true, - ], - 'parens without owner: default value for param in arrow function' => [ - 'testMarker' => '/* testParensNoOwnerAmpersandInDefaultValue */', - ], - 'parens without owner in arrow function return expression' => [ - 'testMarker' => '/* testParensNoOwnerInArrowReturnExpression */', - ], - ]; - - }//end dataNormalParentheses() - - - /** - * Test that parentheses when used in a DNF type declaration are correctly tokenized. - * - * Includes verifying that: - * - the tokens between the parentheses all have a "nested_parenthesis" key. - * - all ampersands between the parentheses are tokenized as T_TYPE_INTERSECTION. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataDNFTypeParentheses - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testDNFTypeParentheses($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $openPtr = $this->getTargetToken($testMarker, [T_OPEN_PARENTHESIS, T_TYPE_OPEN_PARENTHESIS]); - $opener = $tokens[$openPtr]; - - $this->assertSame('(', $opener['content'], 'Content of type open parenthesis is not "("'); - $this->assertSame(T_TYPE_OPEN_PARENTHESIS, $opener['code'], 'Token tokenized as '.$opener['type'].', not T_TYPE_OPEN_PARENTHESIS (code)'); - $this->assertSame('T_TYPE_OPEN_PARENTHESIS', $opener['type'], 'Token tokenized as '.$opener['type'].', not T_TYPE_OPEN_PARENTHESIS (type)'); - - $closePtr = $opener['parenthesis_closer']; - $closer = $tokens[$closePtr]; - - $this->assertSame(')', $closer['content'], 'Content of type close parenthesis is not ")"'); - $this->assertSame(T_TYPE_CLOSE_PARENTHESIS, $closer['code'], 'Token tokenized as '.$closer['type'].', not T_TYPE_CLOSE_PARENTHESIS (code)'); - $this->assertSame('T_TYPE_CLOSE_PARENTHESIS', $closer['type'], 'Token tokenized as '.$closer['type'].', not T_TYPE_CLOSE_PARENTHESIS (type)'); - - $intersectionCount = 0; - for ($i = ($openPtr + 1); $i < $closePtr; $i++) { - if ($tokens[$i]['content'] === '&') { - $this->assertSame( - T_TYPE_INTERSECTION, - $tokens[$i]['code'], - 'Token tokenized as '.$tokens[$i]['type'].', not T_TYPE_INTERSECTION (code)' - ); - $this->assertSame( - 'T_TYPE_INTERSECTION', - $tokens[$i]['type'], - 'Token tokenized as '.$tokens[$i]['type'].', not T_TYPE_INTERSECTION (type)' - ); - ++$intersectionCount; - } - - // Not valid, but that's irrelevant for the tokenization. - if ($tokens[$i]['content'] === '|') { - $this->assertSame(T_TYPE_UNION, $tokens[$i]['code'], 'Token tokenized as '.$tokens[$i]['type'].', not T_TYPE_UNION (code)'); - $this->assertSame('T_TYPE_UNION', $tokens[$i]['type'], 'Token tokenized as '.$tokens[$i]['type'].', not T_TYPE_UNION (type)'); - - // For the purposes of this test, presume it was intended as an intersection. - ++$intersectionCount; - } - }//end for - - $this->assertGreaterThanOrEqual(1, $intersectionCount, 'Did not find an intersection "&" between the DNF type parentheses'); - - $before = $this->phpcsFile->findPrevious(Tokens::$emptyTokens, ($openPtr - 1), null, true); - if ($before !== false && $tokens[$before]['content'] === '|') { - $this->assertSame( - T_TYPE_UNION, - $tokens[$before]['code'], - 'Token before tokenized as '.$tokens[$before]['type'].', not T_TYPE_UNION (code)' - ); - $this->assertSame( - 'T_TYPE_UNION', - $tokens[$before]['type'], - 'Token before tokenized as '.$tokens[$before]['type'].', not T_TYPE_UNION (type)' - ); - } - - // Invalid, but that's not relevant for the tokenization. - if ($before !== false && $tokens[$before]['content'] === '?') { - $this->assertSame( - T_NULLABLE, - $tokens[$before]['code'], - 'Token before tokenized as '.$tokens[$before]['type'].', not T_NULLABLE (code)' - ); - $this->assertSame( - 'T_NULLABLE', - $tokens[$before]['type'], - 'Token before tokenized as '.$tokens[$before]['type'].', not T_NULLABLE (type)' - ); - } - - $after = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($closePtr + 1), null, true); - if ($after !== false && $tokens[$after]['content'] === '|') { - $this->assertSame( - T_TYPE_UNION, - $tokens[$after]['code'], - 'Token after tokenized as '.$tokens[$after]['type'].', not T_TYPE_UNION (code)' - ); - $this->assertSame( - 'T_TYPE_UNION', - $tokens[$after]['type'], - 'Token after tokenized as '.$tokens[$after]['type'].', not T_TYPE_UNION (type)' - ); - } - - }//end testDNFTypeParentheses() - - - /** - * Data provider. - * - * @see testDNFTypeParentheses() - * - * @return array> - */ - public static function dataDNFTypeParentheses() - { - return [ - 'arrow function return type: in named parameter' => [ - 'testMarker' => '/* testDNFTypeArrowFnReturnInNamedParam */', - ], - 'closure return type: in named parameter' => [ - 'testMarker' => '/* testDNFTypeClosureReturnInNamedParam */', - ], - - 'OO const type: unqualified classes' => [ - 'testMarker' => '/* testDNFTypeOOConstUnqualifiedClasses */', - ], - 'OO const type: modifiers in reverse order' => [ - 'testMarker' => '/* testDNFTypeOOConstReverseModifierOrder */', - ], - 'OO const type: multi-dnf part 1' => [ - 'testMarker' => '/* testDNFTypeOOConstMulti1 */', - ], - 'OO const type: multi-dnf part 2' => [ - 'testMarker' => '/* testDNFTypeOOConstMulti2 */', - ], - 'OO const type: multi-dnf part 3' => [ - 'testMarker' => '/* testDNFTypeOOConstMulti3 */', - ], - 'OO const type: namespace relative classes' => [ - 'testMarker' => '/* testDNFTypeOOConstNamespaceRelative */', - ], - 'OO const type: partially qualified classes' => [ - 'testMarker' => '/* testDNFTypeOOConstPartiallyQualified */', - ], - 'OO const type: fully qualified classes' => [ - 'testMarker' => '/* testDNFTypeOOConstFullyQualified */', - ], - - 'OO property type: unqualified classes' => [ - 'testMarker' => '/* testDNFTypePropertyUnqualifiedClasses */', - ], - 'OO property type: modifiers in reverse order' => [ - 'testMarker' => '/* testDNFTypePropertyReverseModifierOrder */', - ], - 'OO property type: multi-dnf namespace relative classes' => [ - 'testMarker' => '/* testDNFTypePropertyMultiNamespaceRelative */', - ], - 'OO property type: multi-dnf partially qualified classes' => [ - 'testMarker' => '/* testDNFTypePropertyMultiPartiallyQualified */', - ], - 'OO property type: multi-dnf fully qualified classes' => [ - 'testMarker' => '/* testDNFTypePropertyMultiFullyQualified */', - ], - 'OO property type: multi-dnf with readonly keyword 1' => [ - 'testMarker' => '/* testDNFTypePropertyWithReadOnlyKeyword1 */', - ], - 'OO property type: multi-dnf with readonly keyword 2' => [ - 'testMarker' => '/* testDNFTypePropertyWithReadOnlyKeyword2 */', - ], - 'OO property type: with static and readonly keywords' => [ - 'testMarker' => '/* testDNFTypePropertyWithStaticAndReadOnlyKeywords */', - ], - 'OO property type: with only static keyword' => [ - 'testMarker' => '/* testDNFTypePropertyWithOnlyStaticKeyword */', - ], - 'OO property type: with only final keyword' => [ - 'testMarker' => '/* testDNFTypeWithPHP84FinalKeyword */', - ], - 'OO property type: with final and static keyword' => [ - 'testMarker' => '/* testDNFTypeWithPHP84FinalKeywordAndStatic */', - ], - 'OO property type: asymmetric visibility, private(set)' => [ - 'testMarker' => '/* testDNFTypePropertyWithPrivateSet */', - ], - 'OO property type: asymmetric vis, public private(set)' => [ - 'testMarker' => '/* testDNFTypePropertyWithPublicPrivateSet */', - ], - 'OO property type: asymmetric visibility, protected(set)' => [ - 'testMarker' => '/* testDNFTypePropertyWithProtectedSet */', - ], - 'OO property type: asymmetric vis, public protected(set)' => [ - 'testMarker' => '/* testDNFTypePropertyWithPublicProtectedSet */', - ], - 'OO property type: with only abstract keyword' => [ - 'testMarker' => '/* testDNFTypeWithPHP84AbstractKeyword */', - ], - 'OO property type: with abstract and public keyword' => [ - 'testMarker' => '/* testDNFTypeWithPHP84AbstractKeywordAndPublic */', - ], - - 'OO method param type: first param' => [ - 'testMarker' => '/* testDNFTypeParam1WithAttribute */', - ], - 'OO method param type: second param, first DNF' => [ - 'testMarker' => '/* testDNFTypeParam2 */', - ], - 'OO method param type: second param, second DNF' => [ - 'testMarker' => '/* testDNFTypeParam3 */', - ], - 'OO method param type: namespace relative classes' => [ - 'testMarker' => '/* testDNFTypeParamNamespaceRelative */', - ], - 'OO method param type: partially qualified classes' => [ - 'testMarker' => '/* testDNFTypeParamPartiallyQualified */', - ], - 'OO method param type: fully qualified classes' => [ - 'testMarker' => '/* testDNFTypeParamFullyQualified */', - ], - 'Constructor property promotion with multi DNF 1' => [ - 'testMarker' => '/* testDNFTypeConstructorPropertyPromotion1 */', - ], - 'Constructor property promotion with multi DNF 2' => [ - 'testMarker' => '/* testDNFTypeConstructorPropertyPromotion2 */', - ], - 'OO method return type: multi DNF 1' => [ - 'testMarker' => '/* testDNFTypeReturnType1 */', - ], - 'OO method return type: multi DNF 2' => [ - 'testMarker' => '/* testDNFTypeReturnType2 */', - ], - 'OO abstract method return type: multi DNF 1' => [ - 'testMarker' => '/* testDNFTypeAbstractMethodReturnType1 */', - ], - 'OO abstract method return type: multi DNF 2' => [ - 'testMarker' => '/* testDNFTypeAbstractMethodReturnType2 */', - ], - 'OO method return type: namespace relative classes' => [ - 'testMarker' => '/* testDNFTypeReturnTypeNamespaceRelative */', - ], - 'OO method return type: partially qualified classes' => [ - 'testMarker' => '/* testDNFTypeReturnPartiallyQualified */', - ], - 'OO method return type: fully qualified classes' => [ - 'testMarker' => '/* testDNFTypeReturnFullyQualified */', - ], - 'function param type: with reference' => [ - 'testMarker' => '/* testDNFTypeWithReference */', - ], - 'function param type: with spread' => [ - 'testMarker' => '/* testDNFTypeWithSpreadOperator */', - ], - 'closure param type: with illegal nullable' => [ - 'testMarker' => '/* testDNFTypeClosureParamIllegalNullable */', - ], - 'closure return type' => [ - 'testMarker' => '/* testDNFTypeClosureReturn */', - ], - 'closure with use return type' => [ - 'testMarker' => '/* testDNFTypeClosureWithUseReturn */', - ], - - 'arrow function param type' => [ - 'testMarker' => '/* testDNFTypeArrowParam */', - ], - 'arrow function return type' => [ - 'testMarker' => '/* testDNFTypeArrowReturnType */', - ], - 'arrow function param type with return by ref' => [ - 'testMarker' => '/* testDNFTypeArrowParamWithReturnByRef */', - ], - - 'illegal syntax: unnecessary parentheses (no union)' => [ - 'testMarker' => '/* testDNFTypeParamIllegalUnnecessaryParens */', - ], - 'illegal syntax: union within parentheses, intersect outside' => [ - 'testMarker' => '/* testDNFTypeParamIllegalIntersectUnionReversed */', - ], - 'illegal syntax: nested parentheses' => [ - 'testMarker' => '/* testDNFTypeParamIllegalNestedParens */', - ], - ]; - - }//end dataDNFTypeParentheses() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DefaultKeywordTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DefaultKeywordTest.inc deleted file mode 100644 index 648149d2f..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DefaultKeywordTest.inc +++ /dev/null @@ -1,203 +0,0 @@ - 1, - 2 => 2, - /* testSimpleMatchDefault */ - default => 'default', - }; -} - -function switchWithDefault($i) { - switch ($i) { - case 1: - return 1; - case 2: - return 2; - /* testSimpleSwitchDefault */ - default: - return 'default'; - } -} - -function switchWithDefaultAndCurlies($i) { - switch ($i) { - case 1: - return 1; - case 2: - return 2; - /* testSimpleSwitchDefaultWithCurlies */ - default: { - return 'default'; - } - } -} - -function matchWithDefaultInSwitch() { - switch ($something) { - case 'foo': - $var = [1, 2, 3]; - $var = match ($i) { - 1 => 1, - /* testMatchDefaultNestedInSwitchCase1 */ - default => 'default', - }; - continue; - - case 'bar' : - $i = callMe($a, $b); - return match ($i) { - 1 => 1, - /* testMatchDefaultNestedInSwitchCase2 */ - default => 'default', - }; - - /* testSwitchDefault */ - default; - echo 'something', match ($i) { - 1, => 1, - /* testMatchDefaultNestedInSwitchDefault */ - default, => 'default', - }; - break; - } -} - -function switchWithDefaultInMatch() { - $x = match ($y) { - 5, 8 => function($z) { - switch($z) { - case 'a'; - $var = [1, 2, 3]; - return 'a'; - /* testSwitchDefaultNestedInMatchCase */ - default: - $var = [1, 2, 3]; - return 'default1'; - } - }, - /* testMatchDefault */ - default => function($z) { - switch($z) { - case 'a': - $i = callMe($a, $b); - return 'b'; - /* testSwitchDefaultNestedInMatchDefault */ - default: - $i = callMe($a, $b); - return 'default2'; - } - } - }; -} - -function shortArrayWithConstantKey() { - $arr = [ - /* testClassConstantAsShortArrayKey */ - SomeClass::DEFAULT => 1, - /* testClassPropertyAsShortArrayKey */ - SomeClass->DEFAULT => 1, - /* testNamespacedConstantAsShortArrayKey */ - // Intentional parse error PHP < 8.0. Reserved keyword used as namespaced constant. - SomeNamespace\DEFAULT => 1, - /* testFQNGlobalConstantAsShortArrayKey */ - // Intentional parse error in PHP < 8.0. Reserved keyword used as global constant. - \DEFAULT => 1, - ]; -} - -function longArrayWithConstantKey() { - $arr = array( - /* testClassConstantAsLongArrayKey */ - SomeClass::DEFAULT => 1, - ); -} - -function yieldWithConstantKey() { - /* testClassConstantAsYieldKey */ - yield SomeClass::DEFAULT => 1; -} - -function longArrayWithConstantKeyNestedInMatch() { - return match($x) { - /* testMatchDefaultWithNestedLongArrayWithClassConstantKey */ - DEFAULT => array( - /* testClassConstantAsLongArrayKeyNestedInMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultWithNestedLongArrayWithClassConstantKeyLevelDown */ - DEFAULT => array( - /* testClassConstantAsLongArrayKeyNestedInMatchLevelDown */ - SomeClass::DEFAULT => 1, - ), - }, - ), - }; -} - -function shortArrayWithConstantKeyNestedInMatch() { - return match($x) { - /* testMatchDefaultWithNestedShortArrayWithClassConstantKey */ - DEFAULT => [ - /* testClassConstantAsShortArrayKeyNestedInMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultWithNestedShortArrayWithClassConstantKeyLevelDown */ - DEFAULT => [ - /* testClassConstantAsShortArrayKeyNestedInMatchLevelDown */ - SomeClass::DEFAULT => 1, - ], - }, - ], - }; -} - - -function longArrayWithConstantKeyWithNestedMatch() { - return array( - /* testClassConstantAsLongArrayKeyWithNestedMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultNestedInLongArray */ - DEFAULT => 'foo' - }, - ); -} - -function shortArrayWithConstantKeyWithNestedMatch() { - return [ - /* testClassConstantAsShortArrayKeyWithNestedMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultNestedInShortArray */ - DEFAULT => 'foo' - }, - ]; -} - -function switchWithConstantNonDefault($i) { - switch ($i) { - /* testClassConstantInSwitchCase */ - case SomeClass::DEFAULT: - return 1; - - /* testClassPropertyInSwitchCase */ - case SomeClass->DEFAULT: - return 2; - - /* testNamespacedConstantInSwitchCase */ - // Intentional parse error PHP < 8.0. Reserved keyword used as constant. - case SomeNamespace\DEFAULT: - return 2; - - /* testNamespaceRelativeConstantInSwitchCase */ - // Intentional parse error PHP < 8.0. Reserved keyword used as global constant. - case namespace\DEFAULT: - return 2; - } -} - -class Foo { - /* testClassConstant */ - const DEFAULT = 'foo'; - - /* testMethodDeclaration */ - public function default() {} -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DefaultKeywordTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DefaultKeywordTest.php deleted file mode 100644 index c398aa6cb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DefaultKeywordTest.php +++ /dev/null @@ -1,255 +0,0 @@ - - * @copyright 2020-2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class DefaultKeywordTest extends AbstractTokenizerTestCase -{ - - - /** - * Test the retokenization of the `default` keyword for match structure to `T_MATCH_DEFAULT`. - * - * Note: Cases and default structures within a match structure do *NOT* get case/default scope - * conditions, in contrast to case and default structures in switch control structures. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataMatchDefault - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testMatchDefault($testMarker, $testContent='default') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_MATCH_DEFAULT, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH_DEFAULT (code)'); - $this->assertSame('T_MATCH_DEFAULT', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH_DEFAULT (type)'); - - }//end testMatchDefault() - - - /** - * Data provider. - * - * @see testMatchDefault() - * - * @return array> - */ - public static function dataMatchDefault() - { - return [ - 'simple_match_default' => [ - 'testMarker' => '/* testSimpleMatchDefault */', - ], - 'match_default_in_switch_case_1' => [ - 'testMarker' => '/* testMatchDefaultNestedInSwitchCase1 */', - ], - 'match_default_in_switch_case_2' => [ - 'testMarker' => '/* testMatchDefaultNestedInSwitchCase2 */', - ], - 'match_default_in_switch_default' => [ - 'testMarker' => '/* testMatchDefaultNestedInSwitchDefault */', - ], - 'match_default_containing_switch' => [ - 'testMarker' => '/* testMatchDefault */', - ], - - 'match_default_with_nested_long_array_and_default_key' => [ - 'testMarker' => '/* testMatchDefaultWithNestedLongArrayWithClassConstantKey */', - 'testContent' => 'DEFAULT', - ], - 'match_default_with_nested_long_array_and_default_key_2' => [ - 'testMarker' => '/* testMatchDefaultWithNestedLongArrayWithClassConstantKeyLevelDown */', - 'testContent' => 'DEFAULT', - ], - 'match_default_with_nested_short_array_and_default_key' => [ - 'testMarker' => '/* testMatchDefaultWithNestedShortArrayWithClassConstantKey */', - 'testContent' => 'DEFAULT', - ], - 'match_default_with_nested_short_array_and_default_key_2' => [ - 'testMarker' => '/* testMatchDefaultWithNestedShortArrayWithClassConstantKeyLevelDown */', - 'testContent' => 'DEFAULT', - ], - 'match_default_in_long_array' => [ - 'testMarker' => '/* testMatchDefaultNestedInLongArray */', - 'testContent' => 'DEFAULT', - ], - 'match_default_in_short_array' => [ - 'testMarker' => '/* testMatchDefaultNestedInShortArray */', - 'testContent' => 'DEFAULT', - ], - ]; - - }//end dataMatchDefault() - - - /** - * Verify that the retokenization of `T_DEFAULT` tokens in match constructs, doesn't negatively - * impact the tokenization of `T_DEFAULT` tokens in switch control structures. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataSwitchDefault - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testSwitchDefault($testMarker, $testContent='default') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_DEFAULT, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_DEFAULT (code)'); - $this->assertSame('T_DEFAULT', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_DEFAULT (type)'); - - }//end testSwitchDefault() - - - /** - * Data provider. - * - * @see testSwitchDefault() - * - * @return array> - */ - public static function dataSwitchDefault() - { - return [ - 'simple_switch_default' => [ - 'testMarker' => '/* testSimpleSwitchDefault */', - ], - 'simple_switch_default_with_curlies' => [ - 'testMarker' => '/* testSimpleSwitchDefaultWithCurlies */', - ], - 'switch_default_toplevel' => [ - 'testMarker' => '/* testSwitchDefault */', - ], - 'switch_default_nested_in_match_case' => [ - 'testMarker' => '/* testSwitchDefaultNestedInMatchCase */', - ], - 'switch_default_nested_in_match_default' => [ - 'testMarker' => '/* testSwitchDefaultNestedInMatchDefault */', - ], - ]; - - }//end dataSwitchDefault() - - - /** - * Verify that the retokenization of `T_DEFAULT` tokens in match constructs, doesn't negatively - * impact the tokenization of `T_STRING` tokens with the contents 'default' which aren't in - * actual fact the default keyword. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataNotDefaultKeyword - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testNotDefaultKeyword($testMarker, $testContent='DEFAULT') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testNotDefaultKeyword() - - - /** - * Data provider. - * - * @see testNotDefaultKeyword() - * - * @return array> - */ - public static function dataNotDefaultKeyword() - { - return [ - 'class-constant-as-short-array-key' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKey */', - ], - 'class-property-as-short-array-key' => [ - 'testMarker' => '/* testClassPropertyAsShortArrayKey */', - ], - 'namespaced-constant-as-short-array-key' => [ - 'testMarker' => '/* testNamespacedConstantAsShortArrayKey */', - ], - 'fqn-global-constant-as-short-array-key' => [ - 'testMarker' => '/* testFQNGlobalConstantAsShortArrayKey */', - ], - 'class-constant-as-long-array-key' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKey */', - ], - 'class-constant-as-yield-key' => [ - 'testMarker' => '/* testClassConstantAsYieldKey */', - ], - - 'class-constant-as-long-array-key-nested-in-match' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKeyNestedInMatch */', - ], - 'class-constant-as-long-array-key-nested-in-match-2' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKeyNestedInMatchLevelDown */', - ], - 'class-constant-as-short-array-key-nested-in-match' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKeyNestedInMatch */', - ], - 'class-constant-as-short-array-key-nested-in-match-2' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKeyNestedInMatchLevelDown */', - ], - 'class-constant-as-long-array-key-with-nested-match' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKeyWithNestedMatch */', - ], - 'class-constant-as-short-array-key-with-nested-match' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKeyWithNestedMatch */', - ], - - 'class-constant-in-switch-case' => [ - 'testMarker' => '/* testClassConstantInSwitchCase */', - ], - 'class-property-in-switch-case' => [ - 'testMarker' => '/* testClassPropertyInSwitchCase */', - ], - 'namespaced-constant-in-switch-case' => [ - 'testMarker' => '/* testNamespacedConstantInSwitchCase */', - ], - 'namespace-relative-constant-in-switch-case' => [ - 'testMarker' => '/* testNamespaceRelativeConstantInSwitchCase */', - ], - - 'class-constant-declaration' => [ - 'testMarker' => '/* testClassConstant */', - ], - 'class-method-declaration' => [ - 'testMarker' => '/* testMethodDeclaration */', - 'testContent' => 'default', - ], - ]; - - }//end dataNotDefaultKeyword() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleArrowTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleArrowTest.inc deleted file mode 100644 index b67b06601..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleArrowTest.inc +++ /dev/null @@ -1,281 +0,0 @@ - 'Zero', - ); -} - -function simpleShortArray($x) { - return [ - /* testShortArrayArrowSimple */ - 0 => 'Zero', - ]; -} - -function simpleLongList($x) { - list( - /* testLongListArrowSimple */ - 0 => $a, - ) = $x; -} - -function simpleShortList($x) { - [ - /* testShortListArrowSimple */ - 0 => $a, - ] = $x; -} - -function simpleYield($x) { - $i = 0; - foreach (explode("\n", $x) as $line) { - /* testYieldArrowSimple */ - yield ++$i => $line; - } -} - -function simpleForeach($x) { - /* testForeachArrowSimple */ - foreach ($x as $k => $value) {} -} - -function simpleMatch($x) { - return match ($x) { - /* testMatchArrowSimpleSingleCase */ - 0 => 'Zero', - /* testMatchArrowSimpleMultiCase */ - 2, 4, 6 => 'Zero', - /* testMatchArrowSimpleSingleCaseWithTrailingComma */ - 1, => 'Zero', - /* testMatchArrowSimpleMultiCaseWithTrailingComma */ - 3, 5, => 'Zero', - }; -} - -function simpleArrowFunction($y) { - /* testFnArrowSimple */ - return fn ($y) => callMe($y); -} - -function matchNestedInMatch() { - $x = match ($y) { - /* testMatchArrowNestedMatchOuter */ - default, => match ($z) { - /* testMatchArrowNestedMatchInner */ - 1 => 1 - }, - }; -} - -function matchNestedInLongArrayValue() { - $array = array( - /* testLongArrayArrowWithNestedMatchValue1 */ - 'a' => match ($test) { - /* testMatchArrowInLongArrayValue1 */ - 1 => 'a', - /* testMatchArrowInLongArrayValue2 */ - 2 => 'b' - }, - /* testLongArrayArrowWithNestedMatchValue2 */ - $i => match ($test) { - /* testMatchArrowInLongArrayValue3 */ - 1 => 'a', - }, - ); -} - -function matchNestedInShortArrayValue() { - $array = [ - /* testShortArrayArrowWithNestedMatchValue1 */ - 'a' => match ($test) { - /* testMatchArrowInShortArrayValue1 */ - 1 => 'a', - /* testMatchArrowInShortArrayValue2 */ - 2 => 'b' - }, - /* testShortArrayArrowWithNestedMatchValue2 */ - $i => match ($test) { - /* testMatchArrowInShortArrayValue3 */ - 1 => 'a', - }, - ]; -} - -function matchNestedInLongArrayKey() { - $array = array( - match ($test) { /* testMatchArrowInLongArrayKey1 */ 1 => 'a', /* testMatchArrowInLongArrayKey2 */ 2 => 'b' } - /* testLongArrayArrowWithMatchKey */ - => 'dynamic keys, woho!', - ); -} - -function matchNestedInShortArrayKey() { - $array = [ - match ($test) { /* testMatchArrowInShortArrayKey1 */ 1 => 'a', /* testMatchArrowInShortArrayKey2 */ 2 => 'b' } - /* testShortArrayArrowWithMatchKey */ - => 'dynamic keys, woho!', - ]; -} - -function arraysNestedInMatch() { - $matcher = match ($x) { - /* testMatchArrowWithLongArrayBodyWithKeys */ - 0 => array( - /* testLongArrayArrowInMatchBody1 */ - 0 => 1, - /* testLongArrayArrowInMatchBody2 */ - 'a' => 2, - /* testLongArrayArrowInMatchBody3 */ - 'b' => 3 - ), - /* testMatchArrowWithShortArrayBodyWithoutKeys */ - 1 => [1, 2, 3], - /* testMatchArrowWithLongArrayBodyWithoutKeys */ - 2 => array( 1, [1, 2, 3], 2, 3), - /* testMatchArrowWithShortArrayBodyWithKeys */ - 3 => [ - /* testShortArrayArrowInMatchBody1 */ - 0 => 1, - /* testShortArrayArrowInMatchBody2 */ - 'a' => array(1, 2, 3), - /* testShortArrayArrowInMatchBody3 */ - 'b' => 2, - 3 - ], - /* testShortArrayArrowinMatchCase1 */ - [4 => 'a', /* testShortArrayArrowinMatchCase2 */ 5 => 6] - /* testMatchArrowWithShortArrayWithKeysAsCase */ - => 'match with array as case value', - /* testShortArrayArrowinMatchCase3 */ - [4 => 'a'], /* testLongArrayArrowinMatchCase4 */ array(5 => 6), - /* testMatchArrowWithMultipleArraysWithKeysAsCase */ - => 'match with multiple arrays as case value', - }; -} - -function matchNestedInArrowFunction($x) { - /* testFnArrowWithMatchInValue */ - $fn = fn($x) => match(true) { - /* testMatchArrowInFnBody1 */ - 1, 2, 3, 4, 5 => 'foo', - /* testMatchArrowInFnBody2 */ - default => 'bar', - }; -} - -function arrowFunctionsNestedInMatch($x) { - return match ($x) { - /* testMatchArrowWithFnBody1 */ - 1 => /* testFnArrowInMatchBody1 */ fn($y) => callMe($y), - /* testMatchArrowWithFnBody2 */ - default => /* testFnArrowInMatchBody2 */ fn($y) => callThem($y) - }; -} - -function matchShortArrayMismash() { - $array = [ - match ($test) { - /* testMatchArrowInComplexShortArrayKey1 */ - 1 => [ /* testShortArrayArrowInComplexMatchValueinShortArrayKey */ 1 => 'a'], - /* testMatchArrowInComplexShortArrayKey2 */ - 2 => 'b' - /* testShortArrayArrowInComplexMatchArrayMismash */ - } => match ($test) { - /* testMatchArrowInComplexShortArrayValue1 */ - 1 => [ /* testShortArrayArrowInComplexMatchValueinShortArrayValue */ 1 => 'a'], - /* testMatchArrowInComplexShortArrayValue2 */ - 2 => /* testFnArrowInComplexMatchValueInShortArrayValue */ fn($y) => callMe($y) - }, - ]; -} - - -function longListInMatch($x, $y) { - return match($x) { - /* testMatchArrowWithLongListBody */ - 1 => list('a' => $a, /* testLongListArrowInMatchBody */ 'b' => $b, 'c' => list('d' => $c)) = $y, - /* testLongListArrowInMatchCase */ - list('a' => $a, 'b' => $b) = $y /* testMatchArrowWithLongListInCase */ => 'something' - }; -} - -function shortListInMatch($x, $y) { - return match($x) { - /* testMatchArrowWithShortListBody */ - 1 => ['a' => $a, 'b' => $b, 'c' => /* testShortListArrowInMatchBody */ ['d' => $c]] = $y, - /* testShortListArrowInMatchCase */ - ['a' => $a, 'b' => $b] = $y /* testMatchArrowWithShortListInCase */ => 'something' - }; -} - -function matchInLongList() { - /* testMatchArrowInLongListKey */ - list(match($x) {1 => 1, 2 => 2} /* testLongListArrowWithMatchInKey */ => $a) = $array; -} - -function matchInShortList() { - /* testMatchArrowInShortListKey */ - [match($x) {1 => 1, 2 => 2} /* testShortListArrowWithMatchInKey */ => $a] = $array; -} - -function longArrayWithConstantKey() { - $arr = array( - /* testLongArrayArrowWithClassConstantKey */ - SomeClass::DEFAULT => 1, - ); -} - -function shortArrayWithConstantKey() { - $arr = [ - /* testShortArrayArrowWithClassConstantKey */ - SomeClass::DEFAULT => 1, - ]; -} - -function yieldWithConstantKey() { - /* testYieldArrowWithClassConstantKey */ - yield SomeClass::DEFAULT => 1; -} - -function longArrayWithConstantKeyNestedInMatch() { - return match($x) { - /* testMatchArrowWithNestedLongArrayWithClassConstantKey */ - default => array( - /* testLongArrayArrowWithClassConstantKeyNestedInMatch */ - SomeClass::DEFAULT => 1, - ), - }; -} - -function shortArrayWithConstantKeyNestedInMatch() { - return match($x) { - /* testMatchArrowWithNestedShortArrayWithClassConstantKey */ - default => [ - /* testShortArrayArrowWithClassConstantKeyNestedInMatch */ - SomeClass::DEFAULT => 1, - ], - }; -} - - -function longArrayWithConstantKeyWithNestedMatch() { - return array( - /* testLongArrayArrowWithClassConstantKeyWithNestedMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchArrowNestedInLongArrayWithClassConstantKey */ - default => 'foo' - }, - ); -} - -function shortArrayWithConstantKeyWithNestedMatch() { - return [ - /* testShortArrayArrowWithClassConstantKeyWithNestedMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchArrowNestedInShortArrayWithClassConstantKey */ - default => 'foo' - }, - ]; -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleArrowTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleArrowTest.php deleted file mode 100644 index 5258d9c16..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleArrowTest.php +++ /dev/null @@ -1,237 +0,0 @@ - - * @copyright 2020-2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class DoubleArrowTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that "normal" double arrows are correctly tokenized as `T_DOUBLE_ARROW`. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataDoubleArrow - * @coversNothing - * - * @return void - */ - public function testDoubleArrow($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_DOUBLE_ARROW, T_MATCH_ARROW, T_FN_ARROW]); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_DOUBLE_ARROW, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_DOUBLE_ARROW (code)'); - $this->assertSame('T_DOUBLE_ARROW', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_DOUBLE_ARROW (type)'); - - }//end testDoubleArrow() - - - /** - * Data provider. - * - * @see testDoubleArrow() - * - * @return array> - */ - public static function dataDoubleArrow() - { - return [ - 'simple_long_array' => ['/* testLongArrayArrowSimple */'], - 'simple_short_array' => ['/* testShortArrayArrowSimple */'], - 'simple_long_list' => ['/* testLongListArrowSimple */'], - 'simple_short_list' => ['/* testShortListArrowSimple */'], - 'simple_yield' => ['/* testYieldArrowSimple */'], - 'simple_foreach' => ['/* testForeachArrowSimple */'], - - 'long_array_with_match_value_1' => ['/* testLongArrayArrowWithNestedMatchValue1 */'], - 'long_array_with_match_value_2' => ['/* testLongArrayArrowWithNestedMatchValue2 */'], - 'short_array_with_match_value_1' => ['/* testShortArrayArrowWithNestedMatchValue1 */'], - 'short_array_with_match_value_2' => ['/* testShortArrayArrowWithNestedMatchValue2 */'], - - 'long_array_with_match_key' => ['/* testLongArrayArrowWithMatchKey */'], - 'short_array_with_match_key' => ['/* testShortArrayArrowWithMatchKey */'], - - 'long_array_in_match_body_1' => ['/* testLongArrayArrowInMatchBody1 */'], - 'long_array_in_match_body_2' => ['/* testLongArrayArrowInMatchBody2 */'], - 'long_array_in_match_body_3' => ['/* testLongArrayArrowInMatchBody3 */'], - 'short_array_in_match_body_1' => ['/* testShortArrayArrowInMatchBody1 */'], - 'short_array_in_match_body_2' => ['/* testShortArrayArrowInMatchBody2 */'], - 'short_array_in_match_body_3' => ['/* testShortArrayArrowInMatchBody3 */'], - - 'short_array_in_match_case_1' => ['/* testShortArrayArrowinMatchCase1 */'], - 'short_array_in_match_case_2' => ['/* testShortArrayArrowinMatchCase2 */'], - 'short_array_in_match_case_3' => ['/* testShortArrayArrowinMatchCase3 */'], - 'long_array_in_match_case_4' => ['/* testLongArrayArrowinMatchCase4 */'], - - 'in_complex_short_array_key_match_value' => ['/* testShortArrayArrowInComplexMatchValueinShortArrayKey */'], - 'in_complex_short_array_toplevel' => ['/* testShortArrayArrowInComplexMatchArrayMismash */'], - 'in_complex_short_array_value_match_value' => ['/* testShortArrayArrowInComplexMatchValueinShortArrayValue */'], - - 'long_list_in_match_body' => ['/* testLongListArrowInMatchBody */'], - 'long_list_in_match_case' => ['/* testLongListArrowInMatchCase */'], - 'short_list_in_match_body' => ['/* testShortListArrowInMatchBody */'], - 'short_list_in_match_case' => ['/* testShortListArrowInMatchCase */'], - 'long_list_with_match_in_key' => ['/* testLongListArrowWithMatchInKey */'], - 'short_list_with_match_in_key' => ['/* testShortListArrowWithMatchInKey */'], - - 'long_array_with_constant_default_in_key' => ['/* testLongArrayArrowWithClassConstantKey */'], - 'short_array_with_constant_default_in_key' => ['/* testShortArrayArrowWithClassConstantKey */'], - 'yield_with_constant_default_in_key' => ['/* testYieldArrowWithClassConstantKey */'], - - 'long_array_with_default_in_key_in_match' => ['/* testLongArrayArrowWithClassConstantKeyNestedInMatch */'], - 'short_array_with_default_in_key_in_match' => ['/* testShortArrayArrowWithClassConstantKeyNestedInMatch */'], - 'long_array_with_default_in_key_with_match' => ['/* testLongArrayArrowWithClassConstantKeyWithNestedMatch */'], - 'short_array_with_default_in_key_with_match' => ['/* testShortArrayArrowWithClassConstantKeyWithNestedMatch */'], - ]; - - }//end dataDoubleArrow() - - - /** - * Test that double arrows in match expressions which are the demarkation between a case and the return value - * are correctly tokenized as `T_MATCH_ARROW`. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataMatchArrow - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testMatchArrow($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_DOUBLE_ARROW, T_MATCH_ARROW, T_FN_ARROW]); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_MATCH_ARROW, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH_ARROW (code)'); - $this->assertSame('T_MATCH_ARROW', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_MATCH_ARROW (type)'); - - }//end testMatchArrow() - - - /** - * Data provider. - * - * @see testMatchArrow() - * - * @return array> - */ - public static function dataMatchArrow() - { - return [ - 'single_case' => ['/* testMatchArrowSimpleSingleCase */'], - 'multi_case' => ['/* testMatchArrowSimpleMultiCase */'], - 'single_case_with_trailing_comma' => ['/* testMatchArrowSimpleSingleCaseWithTrailingComma */'], - 'multi_case_with_trailing_comma' => ['/* testMatchArrowSimpleMultiCaseWithTrailingComma */'], - 'match_nested_outer' => ['/* testMatchArrowNestedMatchOuter */'], - 'match_nested_inner' => ['/* testMatchArrowNestedMatchInner */'], - - 'in_long_array_value_1' => ['/* testMatchArrowInLongArrayValue1 */'], - 'in_long_array_value_2' => ['/* testMatchArrowInLongArrayValue2 */'], - 'in_long_array_value_3' => ['/* testMatchArrowInLongArrayValue3 */'], - 'in_short_array_value_1' => ['/* testMatchArrowInShortArrayValue1 */'], - 'in_short_array_value_2' => ['/* testMatchArrowInShortArrayValue2 */'], - 'in_short_array_value_3' => ['/* testMatchArrowInShortArrayValue3 */'], - - 'in_long_array_key_1' => ['/* testMatchArrowInLongArrayKey1 */'], - 'in_long_array_key_2' => ['/* testMatchArrowInLongArrayKey2 */'], - 'in_short_array_key_1' => ['/* testMatchArrowInShortArrayKey1 */'], - 'in_short_array_key_2' => ['/* testMatchArrowInShortArrayKey2 */'], - - 'with_long_array_value_with_keys' => ['/* testMatchArrowWithLongArrayBodyWithKeys */'], - 'with_short_array_value_without_keys' => ['/* testMatchArrowWithShortArrayBodyWithoutKeys */'], - 'with_long_array_value_without_keys' => ['/* testMatchArrowWithLongArrayBodyWithoutKeys */'], - 'with_short_array_value_with_keys' => ['/* testMatchArrowWithShortArrayBodyWithKeys */'], - - 'with_short_array_with_keys_as_case' => ['/* testMatchArrowWithShortArrayWithKeysAsCase */'], - 'with_multiple_arrays_with_keys_as_case' => ['/* testMatchArrowWithMultipleArraysWithKeysAsCase */'], - - 'in_fn_body_case' => ['/* testMatchArrowInFnBody1 */'], - 'in_fn_body_default' => ['/* testMatchArrowInFnBody2 */'], - 'with_fn_body_case' => ['/* testMatchArrowWithFnBody1 */'], - 'with_fn_body_default' => ['/* testMatchArrowWithFnBody2 */'], - - 'in_complex_short_array_key_1' => ['/* testMatchArrowInComplexShortArrayKey1 */'], - 'in_complex_short_array_key_2' => ['/* testMatchArrowInComplexShortArrayKey2 */'], - 'in_complex_short_array_value_1' => ['/* testMatchArrowInComplexShortArrayValue1 */'], - 'in_complex_short_array_value_2' => ['/* testMatchArrowInComplexShortArrayValue2 */'], - - 'with_long_list_in_body' => ['/* testMatchArrowWithLongListBody */'], - 'with_long_list_in_case' => ['/* testMatchArrowWithLongListInCase */'], - 'with_short_list_in_body' => ['/* testMatchArrowWithShortListBody */'], - 'with_short_list_in_case' => ['/* testMatchArrowWithShortListInCase */'], - 'in_long_list_key' => ['/* testMatchArrowInLongListKey */'], - 'in_short_list_key' => ['/* testMatchArrowInShortListKey */'], - - 'with_long_array_value_with_default_key' => ['/* testMatchArrowWithNestedLongArrayWithClassConstantKey */'], - 'with_short_array_value_with_default_key' => ['/* testMatchArrowWithNestedShortArrayWithClassConstantKey */'], - 'in_long_array_value_with_default_key' => ['/* testMatchArrowNestedInLongArrayWithClassConstantKey */'], - 'in_short_array_value_with_default_key' => ['/* testMatchArrowNestedInShortArrayWithClassConstantKey */'], - ]; - - }//end dataMatchArrow() - - - /** - * Test that double arrows used as the scope opener for an arrow function - * are correctly tokenized as `T_FN_ARROW`. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataFnArrow - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testFnArrow($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_DOUBLE_ARROW, T_MATCH_ARROW, T_FN_ARROW]); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_FN_ARROW, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_FN_ARROW (code)'); - $this->assertSame('T_FN_ARROW', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_FN_ARROW (type)'); - - }//end testFnArrow() - - - /** - * Data provider. - * - * @see testFnArrow() - * - * @return array> - */ - public static function dataFnArrow() - { - return [ - 'simple_fn' => ['/* testFnArrowSimple */'], - - 'with_match_as_value' => ['/* testFnArrowWithMatchInValue */'], - 'in_match_value_case' => ['/* testFnArrowInMatchBody1 */'], - 'in_match_value_default' => ['/* testFnArrowInMatchBody2 */'], - - 'in_complex_match_value_in_short_array' => ['/* testFnArrowInComplexMatchValueInShortArrayValue */'], - ]; - - }//end dataFnArrow() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleQuotedStringTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleQuotedStringTest.inc deleted file mode 100644 index 62535b1e4..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleQuotedStringTest.inc +++ /dev/null @@ -1,52 +0,0 @@ -bar"; -/* testProperty2 */ -"{$foo->bar}"; - -/* testMethod1 */ -"{$foo->bar()}"; - -/* testClosure1 */ -"{$foo()}"; - -/* testChain1 */ -"{$foo['bar']->baz()()}"; - -/* testVariableVar1 */ -"${$bar}"; -/* testVariableVar2 */ -"${(foo)}"; -/* testVariableVar3 */ -"${foo->bar}"; - -/* testNested1 */ -"${foo["${bar}"]}"; -/* testNested2 */ -"${foo["${bar['baz']}"]}"; -/* testNested3 */ -"${foo->{$baz}}"; -/* testNested4 */ -"${foo->{${'a'}}}"; -/* testNested5 */ -"${foo->{"${'a'}"}}"; - -/* testParseError */ -"${foo["${bar diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleQuotedStringTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleQuotedStringTest.php deleted file mode 100644 index aa0817a46..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/DoubleQuotedStringTest.php +++ /dev/null @@ -1,144 +0,0 @@ - - * @copyright 2022 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class DoubleQuotedStringTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that double quoted strings contain the complete string. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $expectedContent The expected content of the double quoted string. - * - * @dataProvider dataDoubleQuotedString - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testDoubleQuotedString($testMarker, $expectedContent) - { - $tokens = $this->phpcsFile->getTokens(); - - $target = $this->getTargetToken($testMarker, T_DOUBLE_QUOTED_STRING); - $this->assertSame($expectedContent, $tokens[$target]['content']); - - }//end testDoubleQuotedString() - - - /** - * Data provider. - * - * Type reference: - * 1. Directly embedded variables. - * 2. Braces outside the variable. - * 3. Braces after the dollar sign. - * 4. Variable variables and expressions. - * - * @link https://wiki.php.net/rfc/deprecate_dollar_brace_string_interpolation - * - * @see testDoubleQuotedString() - * - * @return array> - */ - public static function dataDoubleQuotedString() - { - return [ - 'Type 1: simple variable' => [ - 'testMarker' => '/* testSimple1 */', - 'expectedContent' => '"$foo"', - ], - 'Type 2: simple variable' => [ - 'testMarker' => '/* testSimple2 */', - 'expectedContent' => '"{$foo}"', - ], - 'Type 3: simple variable' => [ - 'testMarker' => '/* testSimple3 */', - 'expectedContent' => '"${foo}"', - ], - 'Type 1: array offset' => [ - 'testMarker' => '/* testDIM1 */', - 'expectedContent' => '"$foo[bar]"', - ], - 'Type 2: array offset' => [ - 'testMarker' => '/* testDIM2 */', - 'expectedContent' => '"{$foo[\'bar\']}"', - ], - 'Type 3: array offset' => [ - 'testMarker' => '/* testDIM3 */', - 'expectedContent' => '"${foo[\'bar\']}"', - ], - 'Type 1: object property' => [ - 'testMarker' => '/* testProperty1 */', - 'expectedContent' => '"$foo->bar"', - ], - 'Type 2: object property' => [ - 'testMarker' => '/* testProperty2 */', - 'expectedContent' => '"{$foo->bar}"', - ], - 'Type 2: object method call' => [ - 'testMarker' => '/* testMethod1 */', - 'expectedContent' => '"{$foo->bar()}"', - ], - 'Type 2: closure function call' => [ - 'testMarker' => '/* testClosure1 */', - 'expectedContent' => '"{$foo()}"', - ], - 'Type 2: chaining various syntaxes' => [ - 'testMarker' => '/* testChain1 */', - 'expectedContent' => '"{$foo[\'bar\']->baz()()}"', - ], - 'Type 4: variable variables' => [ - 'testMarker' => '/* testVariableVar1 */', - 'expectedContent' => '"${$bar}"', - ], - 'Type 4: variable constants' => [ - 'testMarker' => '/* testVariableVar2 */', - 'expectedContent' => '"${(foo)}"', - ], - 'Type 4: object property' => [ - 'testMarker' => '/* testVariableVar3 */', - 'expectedContent' => '"${foo->bar}"', - ], - 'Type 4: variable variable nested in array offset' => [ - 'testMarker' => '/* testNested1 */', - 'expectedContent' => '"${foo["${bar}"]}"', - ], - 'Type 4: variable array offset nested in array offset' => [ - 'testMarker' => '/* testNested2 */', - 'expectedContent' => '"${foo["${bar[\'baz\']}"]}"', - ], - 'Type 4: variable object property' => [ - 'testMarker' => '/* testNested3 */', - 'expectedContent' => '"${foo->{$baz}}"', - ], - 'Type 4: variable object property - complex with single quotes' => [ - 'testMarker' => '/* testNested4 */', - 'expectedContent' => '"${foo->{${\'a\'}}}"', - ], - 'Type 4: variable object property - complex with single and double quotes' => [ - 'testMarker' => '/* testNested5 */', - 'expectedContent' => '"${foo->{"${\'a\'}"}}"', - ], - 'Type 4: live coding/parse error' => [ - 'testMarker' => '/* testParseError */', - 'expectedContent' => '"${foo["${bar -', - ], - ]; - - }//end dataDoubleQuotedString() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/EnumCaseTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/EnumCaseTest.inc deleted file mode 100644 index adcce6817..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/EnumCaseTest.inc +++ /dev/null @@ -1,97 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class EnumCaseTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the enum "case" is converted to T_ENUM_CASE. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataEnumCases - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testEnumCases($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $enumCase = $this->getTargetToken($testMarker, [T_ENUM_CASE, T_CASE]); - $tokenArray = $tokens[$enumCase]; - - $this->assertSame(T_ENUM_CASE, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM_CASE (code)'); - $this->assertSame('T_ENUM_CASE', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM_CASE (type)'); - - }//end testEnumCases() - - - /** - * Data provider. - * - * @see testEnumCases() - * - * @return array> - */ - public static function dataEnumCases() - { - return [ - 'enum case, no value' => ['/* testPureEnumCase */'], - 'enum case, integer value' => ['/* testBackingIntegerEnumCase */'], - 'enum case, string value' => ['/* testBackingStringEnumCase */'], - 'enum case, integer value in more complex enum' => ['/* testEnumCaseInComplexEnum */'], - 'enum case, keyword in mixed case' => ['/* testEnumCaseIsCaseInsensitive */'], - 'enum case, after switch statement' => ['/* testEnumCaseAfterSwitch */'], - 'enum case, after switch statement using alternative syntax' => ['/* testEnumCaseAfterSwitchWithEndSwitch */'], - ]; - - }//end dataEnumCases() - - - /** - * Test that "case" that is not enum case is still tokenized as `T_CASE`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataNotEnumCases - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNotEnumCases($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $case = $this->getTargetToken($testMarker, [T_ENUM_CASE, T_CASE]); - $tokenArray = $tokens[$case]; - - $this->assertSame(T_CASE, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_CASE (code)'); - $this->assertSame('T_CASE', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_CASE (type)'); - - }//end testNotEnumCases() - - - /** - * Data provider. - * - * @see testNotEnumCases() - * - * @return array> - */ - public static function dataNotEnumCases() - { - return [ - 'switch case with constant, semicolon condition end' => ['/* testCaseWithSemicolonIsNotEnumCase */'], - 'switch case with constant, colon condition end' => ['/* testCaseWithConstantIsNotEnumCase */'], - 'switch case with constant, comparison' => ['/* testCaseWithConstantAndIdenticalIsNotEnumCase */'], - 'switch case with constant, assignment' => ['/* testCaseWithAssigmentToConstantIsNotEnumCase */'], - 'switch case with constant, keyword in mixed case' => ['/* testIsNotEnumCaseIsCaseInsensitive */'], - 'switch case, body in curlies declares enum' => ['/* testCaseInSwitchWhenCreatingEnumInSwitch1 */'], - 'switch case, body after semicolon declares enum' => ['/* testCaseInSwitchWhenCreatingEnumInSwitch2 */'], - ]; - - }//end dataNotEnumCases() - - - /** - * Test that "case" that is not enum case is still tokenized as `T_CASE`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataKeywordAsEnumCaseNameShouldBeString - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testKeywordAsEnumCaseNameShouldBeString($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $enumCaseName = $this->getTargetToken($testMarker, [T_STRING, T_INTERFACE, T_TRAIT, T_ENUM, T_FUNCTION, T_FALSE, T_DEFAULT, T_ARRAY]); - $tokenArray = $tokens[$enumCaseName]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testKeywordAsEnumCaseNameShouldBeString() - - - /** - * Data provider. - * - * @see testKeywordAsEnumCaseNameShouldBeString() - * - * @return array> - */ - public static function dataKeywordAsEnumCaseNameShouldBeString() - { - return [ - '"interface" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString1 */'], - '"trait" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString2 */'], - '"enum" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString3 */'], - '"function" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString4 */'], - '"false" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString5 */'], - '"default" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString6 */'], - '"array" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString7 */'], - '"exit" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString8 */'], - ]; - - }//end dataKeywordAsEnumCaseNameShouldBeString() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ExitKeywordTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ExitKeywordTest.inc deleted file mode 100644 index d3c151837..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ExitKeywordTest.inc +++ /dev/null @@ -1,106 +0,0 @@ -exit; - -/* testNotDieOOPropertyAccess */ -$obj->DIE; - -/* testNotExitOOMethodCall */ -$obj->exit(); - -/* testNotDieOOMethodCall */ -$obj->die(); - -class NotReserved { - /* testNotExitOOConstDeclaration */ - const exit = 10; - - /* testNotDieOOConstDeclaration */ - const die = 'status'; - - /* testNotExitOOMethodDeclaration */ - function Exit() {} - - /* testNotDieOOMethodDeclaration */ - function die() {} -} - -/* testNotExitParamName */ -callMe(exit: 10); - -/* testNotDieParamName */ -callMe(die: 'status'); - -/* testNotExitNamespacedName */ -use My\exit\NameA; - -/* testNotDieNamespacedName */ -use My\die\NameB; - -/* testExitAsFQConstant */ -// Intentional parse error. This is not allowed in PHP, but that's not the concern of the tokenizer. Should still be handled correctly. -\exit; - -/* testDieAsFQConstant */ -// Intentional parse error. This is not allowed in PHP, but that's not the concern of the tokenizer. Should still be handled correctly. -\die; - -/* testNotExitConstantDeclaration */ -// Intentional parse error. This is not allowed in PHP, but that's not the concern of the tokenizer. Should still be handled correctly. -const exit = 10; - -/* testNotDieConstantDeclaration */ -// Intentional parse error. This is not allowed in PHP, but that's not the concern of the tokenizer. Should still be handled correctly. -const die = 'status'; - -/* testNotExitFunctionDeclaration */ -// Intentional parse error. This is not allowed in PHP, but that's not the concern of the tokenizer. Should still be handled correctly. -function exit() {} - -/* testNotDieFunctionDeclaration */ -// Intentional parse error. This is not allowed in PHP, but that's not the concern of the tokenizer. Should still be handled correctly. -function die() {} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ExitKeywordTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ExitKeywordTest.php deleted file mode 100644 index f1dc7aad5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ExitKeywordTest.php +++ /dev/null @@ -1,229 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class ExitKeywordTest extends AbstractTokenizerTestCase -{ - - - /** - * Test the retokenization of the `exit`/`die` keywords to T_EXIT. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataExitIsKeyword - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testExitIsKeyword($testMarker, $testContent) - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_EXIT, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_EXIT, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_EXIT (code)'); - $this->assertSame('T_EXIT', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_EXIT (type)'); - - }//end testExitIsKeyword() - - - /** - * Data provider. - * - * @see testExitIsKeyword() - * - * @return array> - */ - public static function dataExitIsKeyword() - { - return [ - 'exit as constant' => [ - 'testMarker' => '/* testExitAsConstant */', - 'testContent' => 'exit', - ], - 'die as constant' => [ - 'testMarker' => '/* testDieAsConstant */', - 'testContent' => 'die', - ], - 'exit as constant; mixed case' => [ - 'testMarker' => '/* testExitAsConstantMixedCase */', - 'testContent' => 'Exit', - ], - 'die as constant; uppercase' => [ - 'testMarker' => '/* testDieAsConstantUppercase */', - 'testContent' => 'DIE', - ], - 'exit as function call; no parameters' => [ - 'testMarker' => '/* testExitAsFunctionCallNoParam */', - 'testContent' => 'exit', - ], - 'die as function call; no parameters' => [ - 'testMarker' => '/* testDieAsFunctionCallNoParam */', - 'testContent' => 'die', - ], - 'exit as function call; with parameters' => [ - 'testMarker' => '/* testExitAsFunctionCallWithParam */', - 'testContent' => 'exit', - ], - 'die as function call; with parameters' => [ - 'testMarker' => '/* testDieAsFunctionCallWithParam */', - 'testContent' => 'die', - ], - 'exit as function call; uppercase' => [ - 'testMarker' => '/* testExitAsFunctionCallUppercase */', - 'testContent' => 'EXIT', - ], - 'die as function call; mixed case' => [ - 'testMarker' => '/* testDieAsFunctionCallMixedCase */', - 'testContent' => 'dIE', - ], - 'exit as fully qualified function call; with parameters' => [ - 'testMarker' => '/* testExitAsFQFunctionCallWithParam */', - 'testContent' => 'exit', - ], - 'die as fully qualified function call; no parameters' => [ - 'testMarker' => '/* testDieAsFQFunctionCallNoParam */', - 'testContent' => 'die', - ], - 'exit as fully qualified constant (illegal)' => [ - 'testMarker' => '/* testExitAsFQConstant */', - 'testContent' => 'exit', - ], - 'die as fully qualified constant (illegal)' => [ - 'testMarker' => '/* testDieAsFQConstant */', - 'testContent' => 'die', - ], - ]; - - }//end dataExitIsKeyword() - - - /** - * Verify that the retokenization of `T_EXIT` tokens doesn't negatively impact the tokenization - * of `T_STRING` tokens with the contents "exit" or "die" which aren't in actual fact the keyword. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * @param string $expected The expected token type. Defaults to `T_STRING`. - * - * @dataProvider dataNotExitKeyword - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNotExitKeyword($testMarker, $testContent, $expected='T_STRING') - { - $tokens = $this->phpcsFile->getTokens(); - $tokenCode = constant($expected); - - $token = $this->getTargetToken($testMarker, [T_EXIT, $tokenCode], $testContent); - $tokenArray = $tokens[$token]; - - $this->assertSame($tokenCode, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not '.$expected.' (code)'); - $this->assertSame($expected, $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not '.$expected.' (type)'); - - }//end testNotExitKeyword() - - - /** - * Data provider. - * - * @see testNotExitKeyword() - * - * @return array> - */ - public static function dataNotExitKeyword() - { - return [ - 'exit not keyword: OO constant use' => [ - 'testMarker' => '/* testNotExitOOConstantAccess */', - 'testContent' => 'exit', - ], - 'die not keyword: OO constant use' => [ - 'testMarker' => '/* testNotDieOOConstantAccess */', - 'testContent' => 'die', - ], - 'exit not keyword: OO property access' => [ - 'testMarker' => '/* testNotExitOOPropertyAccess */', - 'testContent' => 'exit', - ], - 'die not keyword: OO property access' => [ - 'testMarker' => '/* testNotDieOOPropertyAccess */', - 'testContent' => 'DIE', - ], - 'exit not keyword: OO method call' => [ - 'testMarker' => '/* testNotExitOOMethodCall */', - 'testContent' => 'exit', - ], - 'die not keyword: OO method call' => [ - 'testMarker' => '/* testNotDieOOMethodCall */', - 'testContent' => 'die', - ], - 'exit not keyword: OO constant declaration' => [ - 'testMarker' => '/* testNotExitOOConstDeclaration */', - 'testContent' => 'exit', - ], - 'die not keyword: OO constant declaration' => [ - 'testMarker' => '/* testNotDieOOConstDeclaration */', - 'testContent' => 'die', - ], - 'exit not keyword: OO method declaration' => [ - 'testMarker' => '/* testNotExitOOMethodDeclaration */', - 'testContent' => 'Exit', - ], - 'die not keyword: OO method declaration' => [ - 'testMarker' => '/* testNotDieOOMethodDeclaration */', - 'testContent' => 'die', - ], - 'exit not keyword: parameter label for named param' => [ - 'testMarker' => '/* testNotExitParamName */', - 'testContent' => 'exit', - 'expected' => 'T_PARAM_NAME', - ], - 'die not keyword: parameter label for named param' => [ - 'testMarker' => '/* testNotDieParamName */', - 'testContent' => 'die', - 'expected' => 'T_PARAM_NAME', - ], - 'exit not keyword: part of a namespaced name' => [ - 'testMarker' => '/* testNotExitNamespacedName */', - 'testContent' => 'exit', - ], - 'die not keyword: part of a namespaced name' => [ - 'testMarker' => '/* testNotDieNamespacedName */', - 'testContent' => 'die', - ], - 'exit not keyword: global constant declaration (illegal)' => [ - 'testMarker' => '/* testNotExitConstantDeclaration */', - 'testContent' => 'exit', - ], - 'die not keyword: global constant declaration (illegal)' => [ - 'testMarker' => '/* testNotDieConstantDeclaration */', - 'testContent' => 'die', - ], - 'exit not keyword: global function declaration (illegal)' => [ - 'testMarker' => '/* testNotExitFunctionDeclaration */', - 'testContent' => 'exit', - ], - 'die not keyword: global function declaration (illegal)' => [ - 'testMarker' => '/* testNotDieFunctionDeclaration */', - 'testContent' => 'die', - ], - ]; - - }//end dataNotExitKeyword() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/FinallyTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/FinallyTest.inc deleted file mode 100644 index e65600b6b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/FinallyTest.inc +++ /dev/null @@ -1,40 +0,0 @@ -finally = 'foo'; - } -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/FinallyTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/FinallyTest.php deleted file mode 100644 index e73dde122..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/FinallyTest.php +++ /dev/null @@ -1,98 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class FinallyTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the finally keyword is tokenized as such. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataFinallyKeyword - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testFinallyKeyword($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_FINALLY, T_STRING]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_FINALLY, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_FINALLY (code)'); - $this->assertSame('T_FINALLY', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_FINALLY (type)'); - - }//end testFinallyKeyword() - - - /** - * Data provider. - * - * @see testFinallyKeyword() - * - * @return array> - */ - public static function dataFinallyKeyword() - { - return [ - 'finally after try and catch' => ['/* testTryCatchFinally */'], - 'finally between try and catch' => ['/* testTryFinallyCatch */'], - 'finally after try, no catch' => ['/* testTryFinally */'], - ]; - - }//end dataFinallyKeyword() - - - /** - * Test that 'finally' when not used as the reserved keyword is tokenized as `T_STRING`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataFinallyNonKeyword - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testFinallyNonKeyword($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_FINALLY, T_STRING]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testFinallyNonKeyword() - - - /** - * Data provider. - * - * @see testFinallyNonKeyword() - * - * @return array> - */ - public static function dataFinallyNonKeyword() - { - return [ - 'finally used as class constant name' => ['/* testFinallyUsedAsClassConstantName */'], - 'finally used as method name' => ['/* testFinallyUsedAsMethodName */'], - 'finally used as property name' => ['/* testFinallyUsedAsPropertyName */'], - ]; - - }//end dataFinallyNonKeyword() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/GotoLabelTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/GotoLabelTest.inc deleted file mode 100644 index 249064a23..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/GotoLabelTest.inc +++ /dev/null @@ -1,85 +0,0 @@ - -
    - - - -
    - -
    - - property: - // Do something. - break; -} - -switch (true) { - /* testNotGotoDeclarationGlobalConstantInTernary */ - case $x === ($cond) ? CONST_A : CONST_B: - // Do something. - break; -} - -/* testNotGotoDeclarationEnumWithType */ -enum Suit: string implements Colorful, CardGame {} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/GotoLabelTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/GotoLabelTest.php deleted file mode 100644 index 09bb6fe2f..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/GotoLabelTest.php +++ /dev/null @@ -1,194 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Tests the tokenization of goto declarations and statements. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - */ -final class GotoLabelTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify that the label in a goto statement is tokenized as T_STRING. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to expect. - * - * @dataProvider dataGotoStatement - * - * @return void - */ - public function testGotoStatement($testMarker, $testContent) - { - $tokens = $this->phpcsFile->getTokens(); - - $label = $this->getTargetToken($testMarker, T_STRING); - - $this->assertTrue(is_int($label)); - $this->assertSame($testContent, $tokens[$label]['content']); - - }//end testGotoStatement() - - - /** - * Data provider. - * - * @see testGotoStatement() - * - * @return array> - */ - public static function dataGotoStatement() - { - return [ - 'label for goto statement' => [ - 'testMarker' => '/* testGotoStatement */', - 'testContent' => 'marker', - ], - 'label for goto statement in loop, keyword capitalized' => [ - 'testMarker' => '/* testGotoStatementInLoop */', - 'testContent' => 'end', - ], - 'label for goto statement in switch' => [ - 'testMarker' => '/* testGotoStatementInSwitch */', - 'testContent' => 'def', - ], - 'label for goto statement within function' => [ - 'testMarker' => '/* testGotoStatementInFunction */', - 'testContent' => 'label', - ], - ]; - - }//end dataGotoStatement() - - - /** - * Verify that the label in a goto declaration is tokenized as T_GOTO_LABEL. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to expect. - * - * @dataProvider dataGotoDeclaration - * - * @return void - */ - public function testGotoDeclaration($testMarker, $testContent) - { - $tokens = $this->phpcsFile->getTokens(); - - $label = $this->getTargetToken($testMarker, T_GOTO_LABEL); - - $this->assertTrue(is_int($label)); - $this->assertSame($testContent, $tokens[$label]['content']); - - }//end testGotoDeclaration() - - - /** - * Data provider. - * - * @see testGotoDeclaration() - * - * @return array> - */ - public static function dataGotoDeclaration() - { - return [ - 'label in goto declaration - marker' => [ - 'testMarker' => '/* testGotoDeclaration */', - 'testContent' => 'marker:', - ], - 'label in goto declaration - end' => [ - 'testMarker' => '/* testGotoDeclarationOutsideLoop */', - 'testContent' => 'end:', - ], - 'label in goto declaration - def' => [ - 'testMarker' => '/* testGotoDeclarationInSwitch */', - 'testContent' => 'def:', - ], - 'label in goto declaration - label' => [ - 'testMarker' => '/* testGotoDeclarationInFunction */', - 'testContent' => 'label:', - ], - ]; - - }//end dataGotoDeclaration() - - - /** - * Verify that the constant used in a switch - case statement is not confused with a goto label. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to expect. - * - * @dataProvider dataNotAGotoDeclaration - * - * @return void - */ - public function testNotAGotoDeclaration($testMarker, $testContent) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_GOTO_LABEL, T_STRING], $testContent); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testNotAGotoDeclaration() - - - /** - * Data provider. - * - * @see testNotAGotoDeclaration() - * - * @return array> - */ - public static function dataNotAGotoDeclaration() - { - return [ - 'not goto label - global constant followed by switch-case colon' => [ - 'testMarker' => '/* testNotGotoDeclarationGlobalConstant */', - 'testContent' => 'CONSTANT', - ], - 'not goto label - namespaced constant followed by switch-case colon' => [ - 'testMarker' => '/* testNotGotoDeclarationNamespacedConstant */', - 'testContent' => 'CONSTANT', - ], - 'not goto label - class constant followed by switch-case colon' => [ - 'testMarker' => '/* testNotGotoDeclarationClassConstant */', - 'testContent' => 'CONSTANT', - ], - 'not goto label - class property use followed by switch-case colon' => [ - 'testMarker' => '/* testNotGotoDeclarationClassProperty */', - 'testContent' => 'property', - ], - 'not goto label - global constant followed by ternary else' => [ - 'testMarker' => '/* testNotGotoDeclarationGlobalConstantInTernary */', - 'testContent' => 'CONST_A', - ], - 'not goto label - global constant after ternary else' => [ - 'testMarker' => '/* testNotGotoDeclarationGlobalConstantInTernary */', - 'testContent' => 'CONST_B', - ], - 'not goto label - name of backed enum' => [ - 'testMarker' => '/* testNotGotoDeclarationEnumWithType */', - 'testContent' => 'Suit', - ], - ]; - - }//end dataNotAGotoDeclaration() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocNowdocTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocNowdocTest.inc deleted file mode 100644 index 5041dda15..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocNowdocTest.inc +++ /dev/null @@ -1,39 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -/** - * Tests the tokenization for heredoc/nowdoc constructs. - * - * Verifies that: - * - Nowdoc opener/closers are retokenized from `T_[START_|END_]HEREDOC` to `T_[START_|END_]NOWDOC`. - * - The contents of the heredoc/nowdoc is tokenized as `T_HEREDOC`/`T_NOWDOC`. - * - Each line of the contents has its own token, which includes the new line char. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - */ -final class HeredocNowdocTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify tokenization a heredoc construct. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testHeredocSingleLine() - { - $expectedSequence = [ - [T_START_HEREDOC => '<< 'Some $var text'."\n"], - [T_END_HEREDOC => 'EOD'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_START_HEREDOC); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testHeredocSingleLine() - - - /** - * Verify tokenization a nowdoc construct. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testNowdocSingleLine() - { - $expectedSequence = [ - [T_START_NOWDOC => "<<<'MARKER'\n"], - [T_NOWDOC => 'Some text'."\n"], - [T_END_NOWDOC => 'MARKER'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_START_NOWDOC); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testNowdocSingleLine() - - - /** - * Verify tokenization a multiline heredoc construct. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testHeredocMultiLine() - { - $expectedSequence = [ - [T_START_HEREDOC => '<<<"😬"'."\n"], - [T_HEREDOC => 'Lorum ipsum'."\n"], - [T_HEREDOC => 'Some $var text'."\n"], - [T_HEREDOC => 'dolor sit amet'."\n"], - [T_END_HEREDOC => '😬'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_START_HEREDOC); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testHeredocMultiLine() - - - /** - * Verify tokenization a multiline testNowdocSingleLine construct. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testNowdocMultiLine() - { - $expectedSequence = [ - [T_START_NOWDOC => "<<<'multi_line'\n"], - [T_NOWDOC => 'Lorum ipsum'."\n"], - [T_NOWDOC => 'Some text'."\n"], - [T_NOWDOC => 'dolor sit amet'."\n"], - [T_END_NOWDOC => 'multi_line'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_START_NOWDOC); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testNowdocMultiLine() - - - /** - * Verify tokenization a multiline heredoc construct. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testHeredocEndsOnBlankLine() - { - $expectedSequence = [ - [T_START_HEREDOC => '<< 'Lorum ipsum'."\n"], - [T_HEREDOC => 'dolor sit amet'."\n"], - [T_HEREDOC => "\n"], - [T_END_HEREDOC => 'EOD'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_START_HEREDOC); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testHeredocEndsOnBlankLine() - - - /** - * Verify tokenization a multiline testNowdocSingleLine construct. - * - * @phpcs:disable Squiz.Arrays.ArrayDeclaration.SpaceBeforeDoubleArrow -- Readability is better with alignment. - * - * @return void - */ - public function testNowdocEndsOnBlankLine() - { - $expectedSequence = [ - [T_START_NOWDOC => "<<<'EOD'\n"], - [T_NOWDOC => 'Lorum ipsum'."\n"], - [T_NOWDOC => 'dolor sit amet'."\n"], - [T_NOWDOC => "\n"], - [T_END_NOWDOC => 'EOD'], - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_START_NOWDOC); - - $this->checkTokenSequence($target, $expectedSequence); - - }//end testNowdocEndsOnBlankLine() - - - /** - * Test helper. Check a token sequence complies with an expected token sequence. - * - * @param int $startPtr The position in the file to start checking from. - * @param array> $expectedSequence The consecutive token constants and their contents to expect. - * - * @return void - */ - private function checkTokenSequence($startPtr, array $expectedSequence) - { - $tokens = $this->phpcsFile->getTokens(); - - $sequenceKey = 0; - $sequenceCount = count($expectedSequence); - - for ($i = $startPtr; $sequenceKey < $sequenceCount; $i++, $sequenceKey++) { - $currentItem = $expectedSequence[$sequenceKey]; - $expectedCode = key($currentItem); - $expectedType = Tokens::tokenName($expectedCode); - $expectedContent = current($currentItem); - $errorMsgSuffix = PHP_EOL.'(StackPtr: '.$i.' | Position in sequence: '.$sequenceKey.' | Expected: '.$expectedType.')'; - - $this->assertSame( - $expectedCode, - $tokens[$i]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$i]['code']).', not '.$expectedType.' (code)'.$errorMsgSuffix - ); - - $this->assertSame( - $expectedType, - $tokens[$i]['type'], - 'Token tokenized as '.$tokens[$i]['type'].', not '.$expectedType.' (type)'.$errorMsgSuffix - ); - - $this->assertSame( - $expectedContent, - $tokens[$i]['content'], - 'Token content did not match expectations'.$errorMsgSuffix - ); - }//end for - - }//end checkTokenSequence() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocParseErrorTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocParseErrorTest.inc deleted file mode 100644 index d552b1283..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocParseErrorTest.inc +++ /dev/null @@ -1,11 +0,0 @@ ->>>>>> master diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocParseErrorTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocParseErrorTest.php deleted file mode 100644 index 877706fb4..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocParseErrorTest.php +++ /dev/null @@ -1,41 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Tests the tokenization for an unclosed heredoc construct. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - */ -final class HeredocParseErrorTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify that a heredoc (and nowdoc) start token is retokenized to T_STRING if no closer is found. - * - * @return void - */ - public function testMergeConflict() - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken('/* testUnclosedHeredoc */', [T_START_HEREDOC, T_STRING], '<<< HEAD'."\n"); - $tokenArray = $tokens[$token]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_START_HEREDOC (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_START_HEREDOC (type)'); - - }//end testMergeConflict() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocStringTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocStringTest.inc deleted file mode 100644 index ae43e24a5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocStringTest.inc +++ /dev/null @@ -1,193 +0,0 @@ -bar -EOD; - -/* testProperty2 */ -$heredoc = <<<"EOD" -{$foo->bar} -EOD; - -/* testMethod1 */ -$heredoc = <<bar()} -EOD; - -/* testClosure1 */ -$heredoc = <<<"EOD" -{$foo()} -EOD; - -/* testChain1 */ -$heredoc = <<baz()()} -EOD; - -/* testVariableVar1 */ -$heredoc = <<<"EOD" -${$bar} -EOD; - -/* testVariableVar2 */ -$heredoc = <<bar} -EOD; - -/* testNested1 */ -$heredoc = <<{$baz}} -EOD; - -/* testNested4 */ -$heredoc = <<<"EOD" -${foo->{${'a'}}} -EOD; - -/* testNested5 */ -$heredoc = <<{"${'a'}"}} -EOD; - -/* testSimple1Wrapped */ -$heredoc = <<bar Something -EOD; - -/* testProperty2Wrapped */ -$heredoc = <<<"EOD" -Do {$foo->bar} Something -EOD; - -/* testMethod1Wrapped */ -$heredoc = <<bar()} Something -EOD; - -/* testClosure1Wrapped */ -$heredoc = <<<"EOD" -Do {$foo()} Something -EOD; - -/* testChain1Wrapped */ -$heredoc = <<baz()()} Something -EOD; - -/* testVariableVar1Wrapped */ -$heredoc = <<<"EOD" -Do ${$bar} Something -EOD; - -/* testVariableVar2Wrapped */ -$heredoc = <<bar} Something -EOD; - -/* testNested1Wrapped */ -$heredoc = <<{$baz}} Something -EOD; - -/* testNested4Wrapped */ -$heredoc = <<<"EOD" -Do ${foo->{${'a'}}} Something -EOD; - -/* testNested5Wrapped */ -$heredoc = <<{"${'a'}"}} Something -EOD; diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocStringTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocStringTest.php deleted file mode 100644 index c31c17538..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/HeredocStringTest.php +++ /dev/null @@ -1,161 +0,0 @@ - - * @copyright 2022 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class HeredocStringTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that heredoc strings contain the complete interpolated string. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $expectedContent The expected content of the heredoc string. - * - * @dataProvider dataHeredocString - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testHeredocString($testMarker, $expectedContent) - { - $tokens = $this->phpcsFile->getTokens(); - - $target = $this->getTargetToken($testMarker, T_HEREDOC); - $this->assertSame($expectedContent."\n", $tokens[$target]['content']); - - }//end testHeredocString() - - - /** - * Test that heredoc strings contain the complete interpolated string when combined with other texts. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $expectedContent The expected content of the heredoc string. - * - * @dataProvider dataHeredocString - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testHeredocStringWrapped($testMarker, $expectedContent) - { - $tokens = $this->phpcsFile->getTokens(); - - $testMarker = substr($testMarker, 0, -3).'Wrapped */'; - $target = $this->getTargetToken($testMarker, T_HEREDOC); - $this->assertSame('Do '.$expectedContent." Something\n", $tokens[$target]['content']); - - }//end testHeredocStringWrapped() - - - /** - * Data provider. - * - * Type reference: - * 1. Directly embedded variables. - * 2. Braces outside the variable. - * 3. Braces after the dollar sign. - * 4. Variable variables and expressions. - * - * @link https://wiki.php.net/rfc/deprecate_dollar_brace_string_interpolation - * - * @see testHeredocString() - * - * @return array> - */ - public static function dataHeredocString() - { - return [ - 'Type 1: simple variable' => [ - 'testMarker' => '/* testSimple1 */', - 'expectedContent' => '$foo', - ], - 'Type 2: simple variable' => [ - 'testMarker' => '/* testSimple2 */', - 'expectedContent' => '{$foo}', - ], - 'Type 3: simple variable' => [ - 'testMarker' => '/* testSimple3 */', - 'expectedContent' => '${foo}', - ], - 'Type 1: array offset' => [ - 'testMarker' => '/* testDIM1 */', - 'expectedContent' => '$foo[bar]', - ], - 'Type 2: array offset' => [ - 'testMarker' => '/* testDIM2 */', - 'expectedContent' => '{$foo[\'bar\']}', - ], - 'Type 3: array offset' => [ - 'testMarker' => '/* testDIM3 */', - 'expectedContent' => '${foo[\'bar\']}', - ], - 'Type 1: object property' => [ - 'testMarker' => '/* testProperty1 */', - 'expectedContent' => '$foo->bar', - ], - 'Type 2: object property' => [ - 'testMarker' => '/* testProperty2 */', - 'expectedContent' => '{$foo->bar}', - ], - 'Type 2: object method call' => [ - 'testMarker' => '/* testMethod1 */', - 'expectedContent' => '{$foo->bar()}', - ], - 'Type 2: closure function call' => [ - 'testMarker' => '/* testClosure1 */', - 'expectedContent' => '{$foo()}', - ], - 'Type 2: chaining various syntaxes' => [ - 'testMarker' => '/* testChain1 */', - 'expectedContent' => '{$foo[\'bar\']->baz()()}', - ], - 'Type 4: variable variables' => [ - 'testMarker' => '/* testVariableVar1 */', - 'expectedContent' => '${$bar}', - ], - 'Type 4: variable constants' => [ - 'testMarker' => '/* testVariableVar2 */', - 'expectedContent' => '${(foo)}', - ], - 'Type 4: object property' => [ - 'testMarker' => '/* testVariableVar3 */', - 'expectedContent' => '${foo->bar}', - ], - 'Type 4: variable variable nested in array offset' => [ - 'testMarker' => '/* testNested1 */', - 'expectedContent' => '${foo["${bar}"]}', - ], - 'Type 4: variable array offset nested in array offset' => [ - 'testMarker' => '/* testNested2 */', - 'expectedContent' => '${foo["${bar[\'baz\']}"]}', - ], - 'Type 4: variable object property' => [ - 'testMarker' => '/* testNested3 */', - 'expectedContent' => '${foo->{$baz}}', - ], - 'Type 4: variable object property - complex with single quotes' => [ - 'testMarker' => '/* testNested4 */', - 'expectedContent' => '${foo->{${\'a\'}}}', - ], - 'Type 4: variable object property - complex with single and double quotes' => [ - 'testMarker' => '/* testNested5 */', - 'expectedContent' => '${foo->{"${\'a\'}"}}', - ], - ]; - - }//end dataHeredocString() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NamedFunctionCallArgumentsTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NamedFunctionCallArgumentsTest.inc deleted file mode 100644 index 7513ad70b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NamedFunctionCallArgumentsTest.inc +++ /dev/null @@ -1,419 +0,0 @@ -getPos(skip: false), - count: count(array_or_countable: $array), - value: 50 -); - -array_fill( - start_index: /* testNestedFunctionCallInner1 */ $obj->getPos(skip: false), - count: /* testNestedFunctionCallInner2 */ count(array_or_countable: $array), - value: 50 -); - -/* testNamespaceRelativeFunction */ -namespace\function_name(label:$string, more: false); - -/* testPartiallyQualifiedFunction */ -Partially\Qualified\function_name(label:$string, more: false); - -/* testFullyQualifiedFunction */ -\Fully\Qualified\function_name(label: $string, more:false); - -/* testVariableFunction */ -$fn(label: $string, more:false); - -/* testVariableVariableFunction */ -${$fn}(label: $string, more:false); - -/* testMethodCall */ -$obj->methodName(label: $foo, more: $bar); - -/* testVariableMethodCall */ -$obj->{$var}(label: $foo, more: $bar); - -/* testClassInstantiation */ -$obj = new MyClass(label: $string, more:false); - -/* testClassInstantiationSelf */ -$obj = new self(label: $string, more:true); - -/* testClassInstantiationStatic */ -$obj = new static(label: $string, more:false); - -/* testAnonClass */ -$anon = new class(label: $string, more: false) { - public function __construct($label, $more) {} -}; - -function myfoo( $💩💩💩, $Пасха, $_valid) {} -/* testNonAsciiNames */ -foo(💩💩💩: [], Пасха: 'text', _valid: 123); - -/* testMixedPositionalAndNamedArgsWithTernary */ -foo( $cond ? true : false, name: $value2 ); - -/* testNamedArgWithTernary */ -foo( label: $cond ? true : false, more: $cond ? CONSTANT_A : CONSTANT_B ); - -/* testTernaryWithFunctionCallsInThenElse */ -echo $cond ? foo( label: $something ) : foo( more: $something_else ); - -/* testTernaryWithConstantsInThenElse */ -echo $cond ? CONSTANT_NAME : OTHER_CONSTANT; - -switch ($s) { - /* testSwitchCaseWithConstant */ - case MY_CONSTANT: - // Do something. - break; - - /* testSwitchCaseWithClassProperty */ - case $obj->property: - // Do something. - break; - - /* testSwitchDefault */ - default: - // Do something. - break; -} - -/* testTernaryWithClosuresAndReturnTypes */ -$closure = $cond ? function() : bool {return true;} : function() : int {return 123;}; - -/* testTernaryWithArrowFunctionsAndReturnTypes */ -$fn = $cond ? fn() : bool => true : fn() : int => 123; - -/* testPHP84Exit */ -// Exit is a language construct, not a function prior to PHP 8.4. Prior to PHP 8.4, named params were not supported, handle it anyway. -exit(status: $value); - -/* testPHP84Die */ -// Die is a language construct, not a function prior to PHP 8.4. Prior to PHP 8.4, named params were not supported, handle it anyway. -die(status: $value); - -/* testPHP84FullyQualifiedExit */ -// Exit is a language construct, not a function prior to PHP 8.4. Prior to PHP 8.4, named params were not supported, handle it anyway. -\exit(status: $value); - -/* testPHP84FullyQualifiedDie */ -// Die is a language construct, not a function prior to PHP 8.4. Prior to PHP 8.4, named params were not supported, handle it anyway. -\die(status: $value); - - -/* testCompileErrorNamedBeforePositional */ -// Not the concern of PHPCS. Should still be handled. -test(param: $bar, $foo); - -/* testDuplicateName1 */ -// Error Exception, but not the concern of PHPCS. Should still be handled. -test(param: 1, /* testDuplicateName2 */ param: 2); - -/* testIncorrectOrderWithVariadic */ -// Error Exception, but not the concern of PHPCS. Should still be handled. -array_fill(start_index: 0, ...[100, 50]); - -/* testCompileErrorIncorrectOrderWithVariadic */ -// Not the concern of PHPCS. Should still be handled. -test(...$values, param: $value); // Compile-time error - -/* testParseErrorNoValue */ -// Not the concern of PHPCS. Should still be handled. -test(param1:, param2:); - -/* testParseErrorDynamicName */ -// Parse error. Ignore. -function_name($variableStoringParamName: $value); - -/* testParseErrorEmpty */ -// Empty is a language construct, not a function. Named params not supported, handle it anyway. -empty(variable: $value); - -/* testParseErrorEval */ -// Eval is a language construct, not a function. Named params not supported, handle it anyway. -eval(code: $value); - -/* testParseErrorArbitraryParentheses */ -// Parse error. Not named param, handle it anyway. -$calc = (something: $value / $other); - - -/* testReservedKeywordAbstract1 */ -foobar(abstract: $value, /* testReservedKeywordAbstract2 */ abstract: $value); - -/* testReservedKeywordAnd1 */ -foobar(and: $value, /* testReservedKeywordAnd2 */ and: $value); - -/* testReservedKeywordArray1 */ -foobar(array: $value, /* testReservedKeywordArray2 */ array: $value); - -/* testReservedKeywordAs1 */ -foobar(as: $value, /* testReservedKeywordAs2 */ as: $value); - -/* testReservedKeywordBreak1 */ -foobar(break: $value, /* testReservedKeywordBreak2 */ break: $value); - -/* testReservedKeywordCallable1 */ -foobar(callable: $value, /* testReservedKeywordCallable2 */ callable: $value); - -/* testReservedKeywordCase1 */ -foobar(case: $value, /* testReservedKeywordCase2 */ case: $value); - -/* testReservedKeywordCatch1 */ -foobar(catch: $value, /* testReservedKeywordCatch2 */ catch: $value); - -/* testReservedKeywordClass1 */ -foobar(class: $value, /* testReservedKeywordClass2 */ class: $value); - -/* testReservedKeywordClone1 */ -foobar(clone: $value, /* testReservedKeywordClone2 */ clone: $value); - -/* testReservedKeywordConst1 */ -foobar(const: $value, /* testReservedKeywordConst2 */ const: $value); - -/* testReservedKeywordContinue1 */ -foobar(continue: $value, /* testReservedKeywordContinue2 */ continue: $value); - -/* testReservedKeywordDeclare1 */ -foobar(declare: $value, /* testReservedKeywordDeclare2 */ declare: $value); - -/* testReservedKeywordDefault1 */ -foobar(default: $value, /* testReservedKeywordDefault2 */ default: $value); - -/* testReservedKeywordDie1 */ -foobar(die: $value, /* testReservedKeywordDie2 */ die: $value); - -/* testReservedKeywordDo1 */ -foobar(do: $value, /* testReservedKeywordDo2 */ do: $value); - -/* testReservedKeywordEcho1 */ -foobar(echo: $value, /* testReservedKeywordEcho2 */ echo: $value); - -/* testReservedKeywordElse1 */ -foobar(else: $value, /* testReservedKeywordElse2 */ else: $value); - -/* testReservedKeywordElseif1 */ -foobar(elseif: $value, /* testReservedKeywordElseif2 */ elseif: $value); - -/* testReservedKeywordEmpty1 */ -foobar(empty: $value, /* testReservedKeywordEmpty2 */ empty: $value); - -/* testReservedKeywordEnum1 */ -foobar(enum: $value, /* testReservedKeywordEnum2 */ enum: $value); - -/* testReservedKeywordEnddeclare1 */ -foobar(enddeclare: $value, /* testReservedKeywordEnddeclare2 */ enddeclare: $value); - -/* testReservedKeywordEndfor1 */ -foobar(endfor: $value, /* testReservedKeywordEndfor2 */ endfor: $value); - -/* testReservedKeywordEndforeach1 */ -foobar(endforeach: $value, /* testReservedKeywordEndforeach2 */ endforeach: $value); - -/* testReservedKeywordEndif1 */ -foobar(endif: $value, /* testReservedKeywordEndif2 */ endif: $value); - -/* testReservedKeywordEndswitch1 */ -foobar(endswitch: $value, /* testReservedKeywordEndswitch2 */ endswitch: $value); - -/* testReservedKeywordEndwhile1 */ -foobar(endwhile: $value, /* testReservedKeywordEndwhile2 */ endwhile: $value); - -/* testReservedKeywordEval1 */ -foobar(eval: $value, /* testReservedKeywordEval2 */ eval: $value); - -/* testReservedKeywordExit1 */ -foobar(exit: $value, /* testReservedKeywordExit2 */ exit: $value); - -/* testReservedKeywordExtends1 */ -foobar(extends: $value, /* testReservedKeywordExtends2 */ extends: $value); - -/* testReservedKeywordFinal1 */ -foobar(final: $value, /* testReservedKeywordFinal2 */ final: $value); - -/* testReservedKeywordFinally1 */ -foobar(finally: $value, /* testReservedKeywordFinally2 */ finally: $value); - -/* testReservedKeywordFn1 */ -foobar(fn: $value, /* testReservedKeywordFn2 */ fn: $value); - -/* testReservedKeywordFor1 */ -foobar(for: $value, /* testReservedKeywordFor2 */ for: $value); - -/* testReservedKeywordForeach1 */ -foobar(foreach: $value, /* testReservedKeywordForeach2 */ foreach: $value); - -/* testReservedKeywordFunction1 */ -foobar(function: $value, /* testReservedKeywordFunction2 */ function: $value); - -/* testReservedKeywordGlobal1 */ -foobar(global: $value, /* testReservedKeywordGlobal2 */ global: $value); - -/* testReservedKeywordGoto1 */ -foobar(goto: $value, /* testReservedKeywordGoto2 */ goto: $value); - -/* testReservedKeywordIf1 */ -foobar(if: $value, /* testReservedKeywordIf2 */ if: $value); - -/* testReservedKeywordImplements1 */ -foobar(implements: $value, /* testReservedKeywordImplements2 */ implements: $value); - -/* testReservedKeywordInclude1 */ -foobar(include: $value, /* testReservedKeywordInclude2 */ include: $value); - -/* testReservedKeywordInclude_once1 */ -foobar(include_once: $value, /* testReservedKeywordInclude_once2 */ include_once: $value); - -/* testReservedKeywordInstanceof1 */ -foobar(instanceof: $value, /* testReservedKeywordInstanceof2 */ instanceof: $value); - -/* testReservedKeywordInsteadof1 */ -foobar(insteadof: $value, /* testReservedKeywordInsteadof2 */ insteadof: $value); - -/* testReservedKeywordInterface1 */ -foobar(interface: $value, /* testReservedKeywordInterface2 */ interface: $value); - -/* testReservedKeywordIsset1 */ -foobar(isset: $value, /* testReservedKeywordIsset2 */ isset: $value); - -/* testReservedKeywordList1 */ -foobar(list: $value, /* testReservedKeywordList2 */ list: $value); - -/* testReservedKeywordMatch1 */ -foobar(match: $value, /* testReservedKeywordMatch2 */ match: $value); - -/* testReservedKeywordNamespace1 */ -foobar(namespace: $value, /* testReservedKeywordNamespace2 */ namespace: $value); - -/* testReservedKeywordNew1 */ -foobar(new: $value, /* testReservedKeywordNew2 */ new: $value); - -/* testReservedKeywordOr1 */ -foobar(or: $value, /* testReservedKeywordOr2 */ or: $value); - -/* testReservedKeywordPrint1 */ -foobar(print: $value, /* testReservedKeywordPrint2 */ print: $value); - -/* testReservedKeywordPrivate1 */ -foobar(private: $value, /* testReservedKeywordPrivate2 */ private: $value); - -/* testReservedKeywordProtected1 */ -foobar(protected: $value, /* testReservedKeywordProtected2 */ protected: $value); - -/* testReservedKeywordPublic1 */ -foobar(public: $value, /* testReservedKeywordPublic2 */ public: $value); - -/* testReservedKeywordReadonly1 */ -foobar(readonly: $value, /* testReservedKeywordReadonly2 */ readonly: $value); - -/* testReservedKeywordRequire1 */ -foobar(require: $value, /* testReservedKeywordRequire2 */ require: $value); - -/* testReservedKeywordRequire_once1 */ -foobar(require_once: $value, /* testReservedKeywordRequire_once2 */ require_once: $value); - -/* testReservedKeywordReturn1 */ -foobar(return: $value, /* testReservedKeywordReturn2 */ return: $value); - -/* testReservedKeywordStatic1 */ -foobar(static: $value, /* testReservedKeywordStatic2 */ static: $value); - -/* testReservedKeywordSwitch1 */ -foobar(switch: $value, /* testReservedKeywordSwitch2 */ switch: $value); - -/* testReservedKeywordThrow1 */ -foobar(throw: $value, /* testReservedKeywordThrow2 */ throw: $value); - -/* testReservedKeywordTrait1 */ -foobar(trait: $value, /* testReservedKeywordTrait2 */ trait: $value); - -/* testReservedKeywordTry1 */ -foobar(try: $value, /* testReservedKeywordTry2 */ try: $value); - -/* testReservedKeywordUnset1 */ -foobar(unset: $value, /* testReservedKeywordUnset2 */ unset: $value); - -/* testReservedKeywordUse1 */ -foobar(use: $value, /* testReservedKeywordUse2 */ use: $value); - -/* testReservedKeywordVar1 */ -foobar(var: $value, /* testReservedKeywordVar2 */ var: $value); - -/* testReservedKeywordWhile1 */ -foobar(while: $value, /* testReservedKeywordWhile2 */ while: $value); - -/* testReservedKeywordXor1 */ -foobar(xor: $value, /* testReservedKeywordXor2 */ xor: $value); - -/* testReservedKeywordYield1 */ -foobar(yield: $value, /* testReservedKeywordYield2 */ yield: $value); - -/* testReservedKeywordInt1 */ -foobar(int: $value, /* testReservedKeywordInt2 */ int: $value); - -/* testReservedKeywordFloat1 */ -foobar(float: $value, /* testReservedKeywordFloat2 */ float: $value); - -/* testReservedKeywordBool1 */ -foobar(bool: $value, /* testReservedKeywordBool2 */ bool: $value); - -/* testReservedKeywordString1 */ -foobar(string: $value, /* testReservedKeywordString2 */ string: $value); - -/* testReservedKeywordTrue1 */ -foobar(true: $value, /* testReservedKeywordTrue2 */ true: $value); - -/* testReservedKeywordFalse1 */ -foobar(false: $value, /* testReservedKeywordFalse2 */ false: $value); - -/* testReservedKeywordNull1 */ -foobar(null: $value, /* testReservedKeywordNull2 */ null: $value); - -/* testReservedKeywordVoid1 */ -foobar(void: $value, /* testReservedKeywordVoid2 */ void: $value); - -/* testReservedKeywordIterable1 */ -foobar(iterable: $value, /* testReservedKeywordIterable2 */ iterable: $value); - -/* testReservedKeywordObject1 */ -foobar(object: $value, /* testReservedKeywordObject2 */ object: $value); - -/* testReservedKeywordResource1 */ -foobar(resource: $value, /* testReservedKeywordResource2 */ resource: $value); - -/* testReservedKeywordMixed1 */ -foobar(mixed: $value, /* testReservedKeywordMixed2 */ mixed: $value); - -/* testReservedKeywordNumeric1 */ -foobar(numeric: $value, /* testReservedKeywordNumeric2 */ numeric: $value); - -/* testReservedKeywordParent1 */ -foobar(parent: $value, /* testReservedKeywordParent2 */ parent: $value); - -/* testReservedKeywordSelf1 */ -foobar(self: $value, /* testReservedKeywordSelf2 */ self: $value); - -/* testReservedKeywordNever1 */ -foobar(never: $value, /* testReservedKeywordNever2 */ never: $value); diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NamedFunctionCallArgumentsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NamedFunctionCallArgumentsTest.php deleted file mode 100644 index d5259e42c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NamedFunctionCallArgumentsTest.php +++ /dev/null @@ -1,992 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class NamedFunctionCallArgumentsTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify that parameter labels are tokenized as T_PARAM_NAME and that - * the colon after it is tokenized as a T_COLON. - * - * @param string $testMarker The comment prefacing the target token. - * @param array $parameters The token content for each parameter label to look for. - * - * @dataProvider dataNamedFunctionCallArguments - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNamedFunctionCallArguments($testMarker, $parameters) - { - $tokens = $this->phpcsFile->getTokens(); - - foreach ($parameters as $content) { - $label = $this->getTargetToken($testMarker, [T_STRING, T_PARAM_NAME], $content); - - $this->assertSame( - T_PARAM_NAME, - $tokens[$label]['code'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_PARAM_NAME (code)' - ); - $this->assertSame( - 'T_PARAM_NAME', - $tokens[$label]['type'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_PARAM_NAME (type)' - ); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - }//end foreach - - }//end testNamedFunctionCallArguments() - - - /** - * Data provider. - * - * @see testNamedFunctionCallArguments() - * - * @return array>> - */ - public static function dataNamedFunctionCallArguments() - { - return [ - 'function call, single line, all named args' => [ - 'testMarker' => '/* testNamedArgs */', - 'parameters' => [ - 'start_index', - 'count', - 'value', - ], - ], - 'function call, multi-line, all named args' => [ - 'testMarker' => '/* testNamedArgsMultiline */', - 'parameters' => [ - 'start_index', - 'count', - 'value', - ], - ], - 'function call, single line, all named args; comments and whitespace' => [ - 'testMarker' => '/* testNamedArgsWithWhitespaceAndComments */', - 'parameters' => [ - 'start_index', - 'count', - 'value', - ], - ], - 'function call, single line, mixed positional and named args' => [ - 'testMarker' => '/* testMixedPositionalAndNamedArgs */', - 'parameters' => [ - 'double_encode', - ], - ], - 'function call containing nested function call values' => [ - 'testMarker' => '/* testNestedFunctionCallOuter */', - 'parameters' => [ - 'start_index', - 'count', - 'value', - ], - ], - 'function call nested in named arg [1]' => [ - 'testMarker' => '/* testNestedFunctionCallInner1 */', - 'parameters' => [ - 'skip', - ], - ], - 'function call nested in named arg [2]' => [ - 'testMarker' => '/* testNestedFunctionCallInner2 */', - 'parameters' => [ - 'array_or_countable', - ], - ], - 'namespace relative function call' => [ - 'testMarker' => '/* testNamespaceRelativeFunction */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'partially qualified function call' => [ - 'testMarker' => '/* testPartiallyQualifiedFunction */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'fully qualified function call' => [ - 'testMarker' => '/* testFullyQualifiedFunction */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'variable function call' => [ - 'testMarker' => '/* testVariableFunction */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'variable variable function call' => [ - 'testMarker' => '/* testVariableVariableFunction */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'method call' => [ - 'testMarker' => '/* testMethodCall */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'variable method call' => [ - 'testMarker' => '/* testVariableMethodCall */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'class instantiation' => [ - 'testMarker' => '/* testClassInstantiation */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'class instantiation with "self"' => [ - 'testMarker' => '/* testClassInstantiationSelf */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'class instantiation with "static"' => [ - 'testMarker' => '/* testClassInstantiationStatic */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'anonymous class instantiation' => [ - 'testMarker' => '/* testAnonClass */', - 'parameters' => [ - 'label', - 'more', - ], - ], - 'function call with non-ascii characters in the variable name labels' => [ - 'testMarker' => '/* testNonAsciiNames */', - 'parameters' => [ - '💩💩💩', - 'Пасха', - '_valid', - ], - ], - 'PHP 8.4+: named arg in exit()' => [ - 'testMarker' => '/* testPHP84Exit */', - 'parameters' => [ - 'status', - ], - ], - 'PHP 8.4+: named arg in die()' => [ - 'testMarker' => '/* testPHP84Die */', - 'parameters' => [ - 'status', - ], - ], - 'PHP 8.4+: named arg in fully qualified exit()' => [ - 'testMarker' => '/* testPHP84FullyQualifiedExit */', - 'parameters' => [ - 'status', - ], - ], - 'PHP 8.4+: named arg in fully qualified die()' => [ - 'testMarker' => '/* testPHP84FullyQualifiedDie */', - 'parameters' => [ - 'status', - ], - ], - - // Coding errors which should still be handled. - 'invalid: named arg before positional (compile error)' => [ - 'testMarker' => '/* testCompileErrorNamedBeforePositional */', - 'parameters' => [ - 'param', - ], - ], - 'invalid: duplicate parameter name [1]' => [ - 'testMarker' => '/* testDuplicateName1 */', - 'parameters' => [ - 'param', - ], - ], - 'invalid: duplicate parameter name [2]' => [ - 'testMarker' => '/* testDuplicateName2 */', - 'parameters' => [ - 'param', - ], - ], - 'invalid: named arg before variadic (error exception)' => [ - 'testMarker' => '/* testIncorrectOrderWithVariadic */', - 'parameters' => [ - 'start_index', - ], - ], - 'invalid: named arg after variadic (compile error)' => [ - 'testMarker' => '/* testCompileErrorIncorrectOrderWithVariadic */', - 'parameters' => [ - 'param', - ], - ], - 'invalid: named arg without value (parse error)' => [ - 'testMarker' => '/* testParseErrorNoValue */', - 'parameters' => [ - 'param1', - 'param2', - ], - ], - 'invalid: named arg in empty() (parse error)' => [ - 'testMarker' => '/* testParseErrorEmpty */', - 'parameters' => [ - 'variable', - ], - ], - 'invalid: named arg in eval() (parse error)' => [ - 'testMarker' => '/* testParseErrorEval */', - 'parameters' => [ - 'code', - ], - ], - 'invalid: named arg in arbitrary parentheses (parse error)' => [ - 'testMarker' => '/* testParseErrorArbitraryParentheses */', - 'parameters' => [ - 'something', - ], - ], - ]; - - }//end dataNamedFunctionCallArguments() - - - /** - * Verify that other T_STRING tokens within a function call are still tokenized as T_STRING. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $content The token content to look for. - * - * @dataProvider dataOtherTstringInFunctionCall - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testOtherTstringInFunctionCall($testMarker, $content) - { - $tokens = $this->phpcsFile->getTokens(); - - $label = $this->getTargetToken($testMarker, [T_STRING, T_PARAM_NAME], $content); - - $this->assertSame( - T_STRING, - $tokens[$label]['code'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_STRING (code)' - ); - $this->assertSame( - 'T_STRING', - $tokens[$label]['type'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_STRING (type)' - ); - - }//end testOtherTstringInFunctionCall() - - - /** - * Data provider. - * - * @see testOtherTstringInFunctionCall() - * - * @return array> - */ - public static function dataOtherTstringInFunctionCall() - { - return [ - 'not arg name - global constant' => [ - 'testMarker' => '/* testPositionalArgs */', - 'content' => 'START_INDEX', - ], - 'not arg name - fully qualified constant' => [ - 'testMarker' => '/* testPositionalArgs */', - 'content' => 'COUNT', - ], - 'not arg name - namespace relative constant' => [ - 'testMarker' => '/* testPositionalArgs */', - 'content' => 'VALUE', - ], - 'not arg name - unqualified function call' => [ - 'testMarker' => '/* testNestedFunctionCallInner2 */', - 'content' => 'count', - ], - ]; - - }//end dataOtherTstringInFunctionCall() - - - /** - * Verify whether the colons are tokenized correctly when a ternary is used in a mixed - * positional and named arguments function call. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testMixedPositionalAndNamedArgsWithTernary() - { - $tokens = $this->phpcsFile->getTokens(); - - $true = $this->getTargetToken('/* testMixedPositionalAndNamedArgsWithTernary */', T_TRUE); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($true + 1), null, true); - - $this->assertSame( - T_INLINE_ELSE, - $tokens[$colon]['code'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (code)' - ); - $this->assertSame( - 'T_INLINE_ELSE', - $tokens[$colon]['type'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (type)' - ); - - $label = $this->getTargetToken('/* testMixedPositionalAndNamedArgsWithTernary */', T_PARAM_NAME, 'name'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - }//end testMixedPositionalAndNamedArgsWithTernary() - - - /** - * Verify whether the colons are tokenized correctly when a ternary is used - * in a named arguments function call. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNamedArgWithTernary() - { - $tokens = $this->phpcsFile->getTokens(); - - /* - * First argument. - */ - - $label = $this->getTargetToken('/* testNamedArgWithTernary */', T_PARAM_NAME, 'label'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'First arg: Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'First arg: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'First arg: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - $true = $this->getTargetToken('/* testNamedArgWithTernary */', T_TRUE); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($true + 1), null, true); - - $this->assertSame( - T_INLINE_ELSE, - $tokens[$colon]['code'], - 'First arg ternary: Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (code)' - ); - $this->assertSame( - 'T_INLINE_ELSE', - $tokens[$colon]['type'], - 'First arg ternary: Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (type)' - ); - - /* - * Second argument. - */ - - $label = $this->getTargetToken('/* testNamedArgWithTernary */', T_PARAM_NAME, 'more'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'Second arg: Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Second arg: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Second arg: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - $true = $this->getTargetToken('/* testNamedArgWithTernary */', T_STRING, 'CONSTANT_A'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($true + 1), null, true); - - $this->assertSame( - T_INLINE_ELSE, - $tokens[$colon]['code'], - 'Second arg ternary: Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (code)' - ); - $this->assertSame( - 'T_INLINE_ELSE', - $tokens[$colon]['type'], - 'Second arg ternary: Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (type)' - ); - - }//end testNamedArgWithTernary() - - - /** - * Verify whether the colons are tokenized correctly when named arguments - * function calls are used in a ternary. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testTernaryWithFunctionCallsInThenElse() - { - $tokens = $this->phpcsFile->getTokens(); - - /* - * Then. - */ - - $label = $this->getTargetToken('/* testTernaryWithFunctionCallsInThenElse */', T_PARAM_NAME, 'label'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'Function in then: Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Function in then: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Function in then: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - $closeParens = $this->getTargetToken('/* testTernaryWithFunctionCallsInThenElse */', T_CLOSE_PARENTHESIS); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($closeParens + 1), null, true); - - $this->assertSame( - T_INLINE_ELSE, - $tokens[$colon]['code'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (code)' - ); - $this->assertSame( - 'T_INLINE_ELSE', - $tokens[$colon]['type'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (type)' - ); - - /* - * Else. - */ - - $label = $this->getTargetToken('/* testTernaryWithFunctionCallsInThenElse */', T_PARAM_NAME, 'more'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'Function in else: Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Function in else: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Function in else: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - }//end testTernaryWithFunctionCallsInThenElse() - - - /** - * Verify whether the colons are tokenized correctly when constants are used in a ternary. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testTernaryWithConstantsInThenElse() - { - $tokens = $this->phpcsFile->getTokens(); - - $constant = $this->getTargetToken('/* testTernaryWithConstantsInThenElse */', T_STRING, 'CONSTANT_NAME'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($constant + 1), null, true); - - $this->assertSame( - T_INLINE_ELSE, - $tokens[$colon]['code'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (code)' - ); - $this->assertSame( - 'T_INLINE_ELSE', - $tokens[$colon]['type'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_INLINE_ELSE (type)' - ); - - }//end testTernaryWithConstantsInThenElse() - - - /** - * Verify whether the colons are tokenized correctly in a switch statement. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testSwitchStatement() - { - $tokens = $this->phpcsFile->getTokens(); - - $label = $this->getTargetToken('/* testSwitchCaseWithConstant */', T_STRING, 'MY_CONSTANT'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'First case: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'First case: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - $label = $this->getTargetToken('/* testSwitchCaseWithClassProperty */', T_STRING, 'property'); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Second case: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Second case: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - $default = $this->getTargetToken('/* testSwitchDefault */', T_DEFAULT); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($default + 1), null, true); - - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Default case: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Default case: Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - }//end testSwitchStatement() - - - /** - * Verify that a variable parameter label (parse error) is still tokenized as T_VARIABLE. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testParseErrorVariableLabel() - { - $tokens = $this->phpcsFile->getTokens(); - - $label = $this->getTargetToken('/* testParseErrorDynamicName */', [T_VARIABLE, T_PARAM_NAME], '$variableStoringParamName'); - - $this->assertSame( - T_VARIABLE, - $tokens[$label]['code'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_VARIABLE (code)' - ); - $this->assertSame( - 'T_VARIABLE', - $tokens[$label]['type'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_VARIABLE (type)' - ); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - }//end testParseErrorVariableLabel() - - - /** - * Verify whether the colons are tokenized correctly when a return type is used for an inline - * closure/arrow function declaration in a ternary. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataOtherColonsInTernary - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testOtherColonsInTernary($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $startOfStatement = $this->getTargetToken($testMarker, T_VARIABLE); - - // Walk the statement and check the tokenization. - // There should be no T_PARAM_NAME tokens. - // First colon should be T_COLON for the return type. - // Second colon should be T_INLINE_ELSE for the ternary. - // Third colon should be T_COLON for the return type. - $colonCount = 0; - for ($i = ($startOfStatement + 1); $tokens[$i]['line'] === $tokens[$startOfStatement]['line']; $i++) { - $this->assertNotSame(T_PARAM_NAME, $tokens[$i]['code'], "Token $i is tokenized as parameter label"); - - if ($tokens[$i]['content'] === ':') { - ++$colonCount; - - if ($colonCount === 1) { - $this->assertSame(T_COLON, $tokens[$i]['code'], 'First colon is not tokenized as T_COLON'); - } else if ($colonCount === 2) { - $this->assertSame(T_INLINE_ELSE, $tokens[$i]['code'], 'Second colon is not tokenized as T_INLINE_ELSE'); - } else if ($colonCount === 3) { - $this->assertSame(T_COLON, $tokens[$i]['code'], 'Third colon is not tokenized as T_COLON'); - } else { - $this->fail('Unexpected colon encountered in statement'); - } - } - } - - }//end testOtherColonsInTernary() - - - /** - * Data provider. - * - * @see testOtherColonsInTernary() - * - * @return array> - */ - public static function dataOtherColonsInTernary() - { - return [ - 'closures with return types in ternary' => [ - 'testMarker' => '/* testTernaryWithClosuresAndReturnTypes */', - ], - 'arrow functions with return types in ternary' => [ - 'testMarker' => '/* testTernaryWithArrowFunctionsAndReturnTypes */', - ], - ]; - - }//end dataOtherColonsInTernary() - - - /** - * Verify that reserved keywords used as a parameter label are tokenized as T_PARAM_NAME - * and that the colon after it is tokenized as a T_COLON. - * - * @param string $testMarker The comment prefacing the target token. - * @param array $tokenTypes The token codes to look for. - * @param string $tokenContent The token content to look for. - * - * @dataProvider dataReservedKeywordsAsName - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testReservedKeywordsAsName($testMarker, $tokenTypes, $tokenContent) - { - $tokens = $this->phpcsFile->getTokens(); - $label = $this->getTargetToken($testMarker, $tokenTypes, $tokenContent); - - $this->assertSame( - T_PARAM_NAME, - $tokens[$label]['code'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_PARAM_NAME (code)' - ); - $this->assertSame( - 'T_PARAM_NAME', - $tokens[$label]['type'], - 'Token tokenized as '.$tokens[$label]['type'].', not T_PARAM_NAME (type)' - ); - - // Get the next non-empty token. - $colon = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true); - - $this->assertSame( - ':', - $tokens[$colon]['content'], - 'Next token after parameter name is not a colon. Found: '.$tokens[$colon]['content'] - ); - $this->assertSame( - T_COLON, - $tokens[$colon]['code'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (code)' - ); - $this->assertSame( - 'T_COLON', - $tokens[$colon]['type'], - 'Token tokenized as '.$tokens[$colon]['type'].', not T_COLON (type)' - ); - - }//end testReservedKeywordsAsName() - - - /** - * Data provider. - * - * @see testReservedKeywordsAsName() - * - * @return array>> - */ - public static function dataReservedKeywordsAsName() - { - $reservedKeywords = [ - // '__halt_compiler', NOT TESTABLE - 'abstract', - 'and', - 'array', - 'as', - 'break', - 'callable', - 'case', - 'catch', - 'class', - 'clone', - 'const', - 'continue', - 'declare', - 'default', - 'die', - 'do', - 'echo', - 'else', - 'elseif', - 'empty', - 'enddeclare', - 'endfor', - 'endforeach', - 'endif', - 'endswitch', - 'endwhile', - 'enum', - 'eval', - 'exit', - 'extends', - 'final', - 'finally', - 'fn', - 'for', - 'foreach', - 'function', - 'global', - 'goto', - 'if', - 'implements', - 'include', - 'include_once', - 'instanceof', - 'insteadof', - 'interface', - 'isset', - 'list', - 'match', - 'namespace', - 'new', - 'or', - 'print', - 'private', - 'protected', - 'public', - 'readonly', - 'require', - 'require_once', - 'return', - 'static', - 'switch', - 'throw', - 'trait', - 'try', - 'unset', - 'use', - 'var', - 'while', - 'xor', - 'yield', - 'int', - 'float', - 'bool', - 'string', - 'true', - 'false', - 'null', - 'void', - 'iterable', - 'object', - 'resource', - 'mixed', - 'numeric', - 'never', - - // Not reserved keyword, but do have their own token in PHPCS. - 'parent', - 'self', - ]; - - $data = []; - - foreach ($reservedKeywords as $keyword) { - $tokensTypes = [ - T_PARAM_NAME, - T_STRING, - T_GOTO_LABEL, - ]; - $tokenName = 'T_'.strtoupper($keyword); - - if ($keyword === 'and') { - $tokensTypes[] = T_LOGICAL_AND; - } else if ($keyword === 'die') { - $tokensTypes[] = T_EXIT; - } else if ($keyword === 'or') { - $tokensTypes[] = T_LOGICAL_OR; - } else if ($keyword === 'xor') { - $tokensTypes[] = T_LOGICAL_XOR; - } else if ($keyword === '__halt_compiler') { - $tokensTypes[] = T_HALT_COMPILER; - } else if (defined($tokenName) === true) { - $tokensTypes[] = constant($tokenName); - } - - $data[$keyword.'FirstParam'] = [ - '/* testReservedKeyword'.ucfirst($keyword).'1 */', - $tokensTypes, - $keyword, - ]; - - $data[$keyword.'SecondParam'] = [ - '/* testReservedKeyword'.ucfirst($keyword).'2 */', - $tokensTypes, - $keyword, - ]; - }//end foreach - - return $data; - - }//end dataReservedKeywordsAsName() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullableVsInlineThenTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullableVsInlineThenTest.inc deleted file mode 100644 index ce2539120..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullableVsInlineThenTest.inc +++ /dev/null @@ -1,25 +0,0 @@ -phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_NULLABLE, T_INLINE_THEN]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_NULLABLE, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_NULLABLE (code)'); - $this->assertSame('T_NULLABLE', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_NULLABLE (type)'); - - }//end testNullable() - - - /** - * Data provider. - * - * @see testNullable() - * - * @return array> - */ - public static function dataNullable() - { - return [ - 'property declaration, readonly, no visibility' => ['/* testNullableReadonlyOnly */'], - 'property declaration, private set' => ['/* testNullablePrivateSet */'], - 'property declaration, public and protected set' => ['/* testNullablePublicProtectedSet */'], - 'property declaration, final, no visibility' => ['/* testNullableFinalOnly */'], - 'property declaration, abstract, no visibility' => ['/* testNullableAbstractOnly */'], - ]; - - }//end dataNullable() - - - /** - * Test that a "?" when used as part of a ternary expression is tokenized as `T_INLINE_THEN`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataInlineThen - * - * @return void - */ - public function testInlineThen($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_NULLABLE, T_INLINE_THEN]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_INLINE_THEN, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_INLINE_THEN (code)'); - $this->assertSame('T_INLINE_THEN', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_INLINE_THEN (type)'); - - }//end testInlineThen() - - - /** - * Data provider. - * - * @see testInlineThen() - * - * @return array> - */ - public static function dataInlineThen() - { - return [ - 'ternary in property default value' => ['/* testInlineThenInPropertyDefaultValue */'], - ]; - - }//end dataInlineThen() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullsafeObjectOperatorTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullsafeObjectOperatorTest.inc deleted file mode 100644 index 982841eac..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullsafeObjectOperatorTest.inc +++ /dev/null @@ -1,29 +0,0 @@ -foo; - -/* testNullsafeObjectOperator */ -echo $obj?->foo; - -/* testNullsafeObjectOperatorWriteContext */ -// Intentional parse error, but not the concern of the tokenizer. -$foo?->bar->baz = 'baz'; - -/* testTernaryThen */ -echo $obj ? $obj->prop : $other->prop; - -/* testParseErrorWhitespaceNotAllowed */ -echo $obj ? - -> foo; - -/* testParseErrorCommentNotAllowed */ -echo $obj ?/*comment*/-> foo; - -/* testLiveCoding */ -// Intentional parse error. This has to be the last test in the file. -echo $obj? diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullsafeObjectOperatorTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullsafeObjectOperatorTest.php deleted file mode 100644 index 368fee4db..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/NullsafeObjectOperatorTest.php +++ /dev/null @@ -1,144 +0,0 @@ -= 8.0 nullsafe object operator. - * - * @author Juliette Reinders Folmer - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class NullsafeObjectOperatorTest extends AbstractTokenizerTestCase -{ - - /** - * Tokens to search for. - * - * @var array - */ - protected $find = [ - T_NULLSAFE_OBJECT_OPERATOR, - T_OBJECT_OPERATOR, - T_INLINE_THEN, - ]; - - - /** - * Test that a normal object operator is still tokenized as such. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testObjectOperator() - { - $tokens = $this->phpcsFile->getTokens(); - - $operator = $this->getTargetToken('/* testObjectOperator */', $this->find); - $this->assertSame(T_OBJECT_OPERATOR, $tokens[$operator]['code'], 'Failed asserting code is object operator'); - $this->assertSame('T_OBJECT_OPERATOR', $tokens[$operator]['type'], 'Failed asserting type is object operator'); - - }//end testObjectOperator() - - - /** - * Test that a nullsafe object operator is tokenized as such. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataNullsafeObjectOperator - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testNullsafeObjectOperator($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $operator = $this->getTargetToken($testMarker, $this->find); - $this->assertSame(T_NULLSAFE_OBJECT_OPERATOR, $tokens[$operator]['code'], 'Failed asserting code is nullsafe object operator'); - $this->assertSame('T_NULLSAFE_OBJECT_OPERATOR', $tokens[$operator]['type'], 'Failed asserting type is nullsafe object operator'); - - }//end testNullsafeObjectOperator() - - - /** - * Data provider. - * - * @see testNullsafeObjectOperator() - * - * @return array> - */ - public static function dataNullsafeObjectOperator() - { - return [ - 'nullsafe operator' => ['/* testNullsafeObjectOperator */'], - 'illegal nullsafe operator (write context)' => ['/* testNullsafeObjectOperatorWriteContext */'], - ]; - - }//end dataNullsafeObjectOperator() - - - /** - * Test that a question mark not followed by an object operator is tokenized as T_TERNARY_THEN. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param bool $testObjectOperator Whether to test for the next non-empty token being tokenized - * as an object operator. - * - * @dataProvider dataTernaryThen - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testTernaryThen($testMarker, $testObjectOperator=false) - { - $tokens = $this->phpcsFile->getTokens(); - - $operator = $this->getTargetToken($testMarker, $this->find); - $this->assertSame(T_INLINE_THEN, $tokens[$operator]['code'], 'Failed asserting code is inline then'); - $this->assertSame('T_INLINE_THEN', $tokens[$operator]['type'], 'Failed asserting type is inline then'); - - if ($testObjectOperator === true) { - $next = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($operator + 1), null, true); - $this->assertSame(T_OBJECT_OPERATOR, $tokens[$next]['code'], 'Failed asserting code is object operator'); - $this->assertSame('T_OBJECT_OPERATOR', $tokens[$next]['type'], 'Failed asserting type is object operator'); - } - - }//end testTernaryThen() - - - /** - * Data provider. - * - * @see testTernaryThen() - * - * @return array> - */ - public static function dataTernaryThen() - { - return [ - 'ternary then' => [ - 'testMarker' => '/* testTernaryThen */', - ], - 'whitespace between question mark and object operator' => [ - 'testMarker' => '/* testParseErrorWhitespaceNotAllowed */', - 'testObjectOperator' => true, - ], - 'comment between question mark and object operator' => [ - 'testMarker' => '/* testParseErrorCommentNotAllowed */', - 'testObjectOperator' => true, - ], - 'parse error/live coding' => [ - 'testMarker' => '/* testLiveCoding */', - ], - ]; - - }//end dataTernaryThen() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.inc deleted file mode 100644 index 9acb05a36..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.inc +++ /dev/null @@ -1,261 +0,0 @@ - $param->get(); - } -} - -/* testFalseIsKeywordUppercase */ -if ($a === FALSE) { -/* testTrueIsKeywordMixedCase */ -} elseif ( $b === True) { -/* testNullIsKeywordUppercase */ -} elseif ($c === NULL) {} - -/* testFullyQualifiedFalseIsKeyword */ -$a = \false; -/* testFullyQualifiedTrueIsKeyword */ -$b = \true; -/* testFullyQualifiedNullIsKeyword */ -$c = \null; diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.php deleted file mode 100644 index 12c70c9d1..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/OtherContextSensitiveKeywordsTest.php +++ /dev/null @@ -1,745 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Tests the conversion of PHPCS native context sensitive keyword tokens to T_STRING. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::standardiseToken - */ -final class OtherContextSensitiveKeywordsTest extends AbstractTokenizerTestCase -{ - - - /** - * Clear the "resolved tokens" cache before running this test as otherwise the code - * under test may not be run during the test. - * - * @beforeClass - * - * @return void - */ - public static function clearTokenCache() - { - parent::clearResolvedTokensCache(); - - }//end clearTokenCache() - - - /** - * Test that context sensitive keyword is tokenized as string when it should be string. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataStrings - * - * @return void - */ - public function testStrings($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_STRING, T_NULL, T_FALSE, T_TRUE, T_PARENT, T_SELF]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testStrings() - - - /** - * Data provider. - * - * @see testStrings() - * - * @return array> - */ - public static function dataStrings() - { - return [ - 'constant declaration: parent' => ['/* testKeywordParentAsConstantNameShouldBeString */'], - 'constant declaration: self' => ['/* testKeywordSelfAsConstantNameShouldBeString */'], - 'constant declaration: false' => ['/* testKeywordFalseAsConstantNameShouldBeString */'], - 'constant declaration: true' => ['/* testKeywordTrueAsConstantNameShouldBeString */'], - 'constant declaration: null' => ['/* testKeywordNullAsConstantNameShouldBeString */'], - - 'function declaration with return by ref: self' => ['/* testKeywordSelfAfterFunctionByRefShouldBeString */'], - 'function declaration with return by ref: parent' => ['/* testKeywordParentAfterFunctionByRefShouldBeString */'], - 'function declaration with return by ref: false' => ['/* testKeywordFalseAfterFunctionByRefShouldBeString */'], - 'function declaration with return by ref: true' => ['/* testKeywordTrueAfterFunctionByRefShouldBeString */'], - 'function declaration with return by ref: null' => ['/* testKeywordNullAfterFunctionByRefShouldBeString */'], - - 'function call: self' => ['/* testKeywordAsFunctionCallNameShouldBeStringSelf */'], - 'function call: parent' => ['/* testKeywordAsFunctionCallNameShouldBeStringParent */'], - 'function call: false' => ['/* testKeywordAsFunctionCallNameShouldBeStringFalse */'], - 'function call: true' => ['/* testKeywordAsFunctionCallNameShouldBeStringTrue */'], - 'function call: null; with comment between keyword and parentheses' => ['/* testKeywordAsFunctionCallNameShouldBeStringNull */'], - - 'class instantiation: false' => ['/* testClassInstantiationFalseIsString */'], - 'class instantiation: true' => ['/* testClassInstantiationTrueIsString */'], - 'class instantiation: null' => ['/* testClassInstantiationNullIsString */'], - - 'constant declaration: false as name after type' => ['/* testFalseIsNameForTypedConstant */'], - 'constant declaration: true as name after type' => ['/* testTrueIsNameForTypedConstant */'], - 'constant declaration: null as name after type' => ['/* testNullIsNameForTypedConstant */'], - 'constant declaration: self as name after type' => ['/* testSelfIsNameForTypedConstant */'], - 'constant declaration: parent as name after type' => ['/* testParentIsNameForTypedConstant */'], - ]; - - }//end dataStrings() - - - /** - * Test that context sensitive keyword is tokenized as keyword when it should be keyword. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $expectedTokenType The expected token type. - * - * @dataProvider dataKeywords - * - * @return void - */ - public function testKeywords($testMarker, $expectedTokenType) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_STRING, T_NULL, T_FALSE, T_TRUE, T_PARENT, T_SELF]); - $tokenArray = $tokens[$target]; - - $this->assertSame( - constant($expectedTokenType), - $tokenArray['code'], - 'Token tokenized as '.$tokenArray['type'].', not '.$expectedTokenType.' (code)' - ); - $this->assertSame( - $expectedTokenType, - $tokenArray['type'], - 'Token tokenized as '.$tokenArray['type'].', not '.$expectedTokenType.' (type)' - ); - - }//end testKeywords() - - - /** - * Data provider. - * - * @see testKeywords() - * - * @return array> - */ - public static function dataKeywords() - { - return [ - 'self: param type declaration' => [ - 'testMarker' => '/* testSelfIsKeyword */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: param type declaration' => [ - 'testMarker' => '/* testParentIsKeyword */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'parent: class instantiation' => [ - 'testMarker' => '/* testClassInstantiationParentIsKeyword */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: class instantiation' => [ - 'testMarker' => '/* testClassInstantiationSelfIsKeyword */', - 'expectedTokenType' => 'T_SELF', - ], - - 'false: param type declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsParamType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: param type declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsParamType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: param type declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsParamType */', - 'expectedTokenType' => 'T_NULL', - ], - 'false: return type declaration in union' => [ - 'testMarker' => '/* testFalseIsKeywordAsReturnType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: return type declaration in union' => [ - 'testMarker' => '/* testTrueIsKeywordAsReturnType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: return type declaration in union' => [ - 'testMarker' => '/* testNullIsKeywordAsReturnType */', - 'expectedTokenType' => 'T_NULL', - ], - 'false: in comparison' => [ - 'testMarker' => '/* testFalseIsKeywordInComparison */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: in comparison' => [ - 'testMarker' => '/* testTrueIsKeywordInComparison */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: in comparison' => [ - 'testMarker' => '/* testNullIsKeywordInComparison */', - 'expectedTokenType' => 'T_NULL', - ], - - 'false: type in OO constant declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsConstType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: type in OO constant declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsConstType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: type in OO constant declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsConstType */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: type in OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstType */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: type in OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstType */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: value in constant declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsConstDefault */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: value in constant declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsConstDefault */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: value in constant declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsConstDefault */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: value in constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstDefault */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: value in constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstDefault */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: type in property declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsPropertyType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: type in property declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsPropertyType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: type in property declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsPropertyType */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: type in property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyType */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: type in property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyType */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: value in property declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsPropertyDefault */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: value in property declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsPropertyDefault */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: value in property declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsPropertyDefault */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: value in property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyDefault */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: value in property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyDefault */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: first in union type for OO constant declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsConstUnionTypeFirst */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: first in union type for OO constant declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsConstUnionTypeFirst */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: first in union type for OO constant declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsConstUnionTypeFirst */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: first in union type for OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstUnionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in union type for OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstUnionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: middle in union type for OO constant declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsConstUnionTypeMiddle */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: middle in union type for OO constant declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsConstUnionTypeMiddle */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: middle in union type for OO constant declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsConstUnionTypeMiddle */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: middle in union type for OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstUnionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in union type for OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstUnionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: last in union type for OO constant declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsConstUnionTypeLast */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: last in union type for OO constant declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsConstUnionTypeLast */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: last in union type for OO constant declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsConstUnionTypeLast */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: last in union type for OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstUnionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in union type for OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstUnionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: first in union type for property declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsPropertyUnionTypeFirst */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: first in union type for property declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsPropertyUnionTypeFirst */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: first in union type for property declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsPropertyUnionTypeFirst */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: first in union type for property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyUnionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in union type for property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyUnionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: middle in union type for property declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsPropertyUnionTypeMiddle */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: middle in union type for property declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsPropertyUnionTypeMiddle */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: middle in union type for property declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsPropertyUnionTypeMiddle */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: middle in union type for property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyUnionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in union type for property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyUnionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: last in union type for property declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsPropertyUnionTypeLast */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: last in union type for property declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsPropertyUnionTypeLast */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: last in union type for property declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsPropertyUnionTypeLast */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: last in union type for property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyUnionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in union type for property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyUnionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: first in union type for param declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsParamUnionTypeFirst */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: first in union type for param declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsParamUnionTypeFirst */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: first in union type for param declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsParamUnionTypeFirst */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: first in union type for param declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsParamUnionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in union type for param declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsParamUnionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: middle in union type for param declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsParamUnionTypeMiddle */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: middle in union type for param declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsParamUnionTypeMiddle */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: middle in union type for param declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsParamUnionTypeMiddle */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: middle in union type for param declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsParamUnionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in union type for param declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsParamUnionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: last in union type for param declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsParamUnionTypeLast */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: last in union type for param declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsParamUnionTypeLast */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: last in union type for param declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsParamUnionTypeLast */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: last in union type for param declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsParamUnionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in union type for param declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsParamUnionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: first in union type for return declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsReturnUnionTypeFirst */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: first in union type for return declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsReturnUnionTypeFirst */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: first in union type for return declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsReturnUnionTypeFirst */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: first in union type for return declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsReturnUnionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in union type for return declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsReturnUnionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: middle in union type for return declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsReturnUnionTypeMiddle */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: middle in union type for return declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsReturnUnionTypeMiddle */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: middle in union type for return declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsReturnUnionTypeMiddle */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: middle in union type for return declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsReturnUnionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in union type for return declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsReturnUnionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: last in union type for return declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsReturnUnionTypeLast */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: last in union type for return declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsReturnUnionTypeLast */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: last in union type for return declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsReturnUnionTypeLast */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: last in union type for return declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsReturnUnionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in union type for return declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsReturnUnionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'self: first in intersection type for OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstIntersectionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in intersection type for OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstIntersectionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: middle in intersection type for OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in intersection type for OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: last in intersection type for OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstIntersectionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in intersection type for OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstIntersectionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'self: first in intersection type for property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyIntersectionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in intersection type for property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyIntersectionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: middle in intersection type for property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in intersection type for property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: last in intersection type for property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyIntersectionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in intersection type for property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyIntersectionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'self: first in intersection type for param declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsParamIntersectionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in intersection type for param declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsParamIntersectionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: middle in intersection type for param declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsParamIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in intersection type for param declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsParamIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: last in intersection type for param declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsParamIntersectionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in intersection type for param declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsParamIntersectionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'self: first in intersection type for return declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsReturnIntersectionTypeFirst */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: first in intersection type for return declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsReturnIntersectionTypeFirst */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: middle in intersection type for return declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsReturnIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: middle in intersection type for return declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsReturnIntersectionTypeMiddle */', - 'expectedTokenType' => 'T_PARENT', - ], - 'self: last in intersection type for return declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsReturnIntersectionTypeLast */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: last in intersection type for return declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsReturnIntersectionTypeLast */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: DNF type in OO constant declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsConstDNFType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: DNF type in OO constant declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsConstDNFType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: DNF type in OO constant declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsConstDNFType */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: DNF type in OO constant declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsConstDNFType */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: DNF type in OO constant declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsConstDNFType */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: DNF type in property declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsPropertyDNFType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: DNF type in property declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsPropertyDNFType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: DNF type in property declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsPropertyDNFType */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: DNF type in property declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsPropertyDNFType */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: DNF type in property declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsPropertyDNFType */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: DNF type in function param declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsParamDNFType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'false: DNF type in function return declaration' => [ - 'testMarker' => '/* testFalseIsKeywordAsReturnDNFType */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: DNF type in function param declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsParamDNFType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'true: DNF type in function return declaration' => [ - 'testMarker' => '/* testTrueIsKeywordAsReturnDNFType */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: DNF type in function param declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsParamDNFType */', - 'expectedTokenType' => 'T_NULL', - ], - 'null: DNF type in function return declaration' => [ - 'testMarker' => '/* testNullIsKeywordAsReturnDNFType */', - 'expectedTokenType' => 'T_NULL', - ], - 'self: DNF type in function param declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsParamDNFType */', - 'expectedTokenType' => 'T_SELF', - ], - 'self: DNF type in function return declaration' => [ - 'testMarker' => '/* testSelfIsKeywordAsReturnDNFType */', - 'expectedTokenType' => 'T_SELF', - ], - 'parent: DNF type in function param declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsParamDNFType */', - 'expectedTokenType' => 'T_PARENT', - ], - 'parent: DNF type in function return declaration' => [ - 'testMarker' => '/* testParentIsKeywordAsReturnDNFType */', - 'expectedTokenType' => 'T_PARENT', - ], - - 'false: in comparison, uppercase' => [ - 'testMarker' => '/* testFalseIsKeywordUppercase */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: in comparison, mixed case' => [ - 'testMarker' => '/* testTrueIsKeywordMixedCase */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: in comparison, uppercase' => [ - 'testMarker' => '/* testNullIsKeywordUppercase */', - 'expectedTokenType' => 'T_NULL', - ], - 'false: in assignment, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedFalseIsKeyword */', - 'expectedTokenType' => 'T_FALSE', - ], - 'true: in assignment, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedTrueIsKeyword */', - 'expectedTokenType' => 'T_TRUE', - ], - 'null: in assignment, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedNullIsKeyword */', - 'expectedTokenType' => 'T_NULL', - ], - ]; - - }//end dataKeywords() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF1Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF1Test.inc deleted file mode 100644 index 2244b3891..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF1Test.inc +++ /dev/null @@ -1,4 +0,0 @@ - -phpcsFile->getTokens(); - $stackPtr = $this->getTargetToken('/* testLongOpenTagEndOfFileSpaceNoNewLine */', [T_OPEN_TAG, T_STRING, T_INLINE_HTML]); - - $this->assertSame( - T_OPEN_TAG, - $tokens[$stackPtr]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$stackPtr]['code']).', not T_OPEN_TAG (code)' - ); - $this->assertSame( - 'T_OPEN_TAG', - $tokens[$stackPtr]['type'], - 'Token tokenized as '.$tokens[$stackPtr]['type'].', not T_OPEN_TAG (type)' - ); - $this->assertSame('assertArrayNotHasKey(($stackPtr + 1), $tokens); - - }//end testLongOpenTagAtEndOfFile() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF2Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF2Test.inc deleted file mode 100644 index 191bdae16..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF2Test.inc +++ /dev/null @@ -1,4 +0,0 @@ - -phpcsFile->getTokens(); - $stackPtr = $this->getTargetToken('/* testLongOpenTagEndOfFileNoSpaceNoNewLine */', [T_OPEN_TAG, T_STRING, T_INLINE_HTML]); - - $this->assertSame( - T_OPEN_TAG, - $tokens[$stackPtr]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$stackPtr]['code']).', not T_OPEN_TAG (code)' - ); - $this->assertSame( - 'T_OPEN_TAG', - $tokens[$stackPtr]['type'], - 'Token tokenized as '.$tokens[$stackPtr]['type'].', not T_OPEN_TAG (type)' - ); - $this->assertSame('assertArrayNotHasKey(($stackPtr + 1), $tokens); - - }//end testLongOpenTagAtEndOfFile() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF3Test.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF3Test.inc deleted file mode 100644 index 583314db3..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/PHPOpenTagEOF3Test.inc +++ /dev/null @@ -1,4 +0,0 @@ - -phpcsFile->getTokens(); - $stackPtr = $this->getTargetToken('/* testLongOpenTagEndOfFileNoSpaceNoNewLineUppercase */', [T_OPEN_TAG, T_STRING, T_INLINE_HTML]); - - $this->assertSame( - T_OPEN_TAG, - $tokens[$stackPtr]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$stackPtr]['code']).', not T_OPEN_TAG (code)' - ); - $this->assertSame( - 'T_OPEN_TAG', - $tokens[$stackPtr]['type'], - 'Token tokenized as '.$tokens[$stackPtr]['type'].', not T_OPEN_TAG (type)' - ); - $this->assertSame('assertArrayNotHasKey(($stackPtr + 1), $tokens); - - }//end testLongOpenTagAtEndOfFile() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ResolveSimpleTokenTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ResolveSimpleTokenTest.inc deleted file mode 100644 index d7383d8e6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ResolveSimpleTokenTest.inc +++ /dev/null @@ -1,51 +0,0 @@ - $var; - -/* testBooleanNot */ -$a = ! $var; - -/* testComma */ -echo $a, $b, $c; - -/* testAsperand */ -$a = @callMe(); - -/* testDollarAndCurlies */ -echo ${$var}; - -/* testBacktick */ -$a = `ls -e`; diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ResolveSimpleTokenTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ResolveSimpleTokenTest.php deleted file mode 100644 index 06a130c24..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ResolveSimpleTokenTest.php +++ /dev/null @@ -1,433 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -/** - * Tests that simple tokens are assigned the correct token type and code. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::resolveSimpleToken - */ -final class ResolveSimpleTokenTest extends AbstractTokenizerTestCase -{ - - - /** - * Clear the "resolved tokens" cache before running this test as otherwise the code - * under test may not be run during the test. - * - * @beforeClass - * - * @return void - */ - public static function clearTokenCache() - { - parent::clearResolvedTokensCache(); - - }//end clearTokenCache() - - - /** - * Verify tokenization of parentheses, square brackets, curly brackets and a switch colon. - * - * @return void - */ - public function testBracesAndColon() - { - $expectedSequence = [ - T_OPEN_PARENTHESIS, - T_VARIABLE, - T_OPEN_SQUARE_BRACKET, - T_LNUMBER, - T_CLOSE_SQUARE_BRACKET, - T_CLOSE_PARENTHESIS, - T_OPEN_CURLY_BRACKET, - T_CASE, - T_STRING, - T_COLON, - T_BREAK, - T_SEMICOLON, - T_CLOSE_CURLY_BRACKET, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_SWITCH); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testBracesAndColon() - - - /** - * Verify tokenization of colon after named parameter. - * - * @return void - */ - public function testNamedParamColon() - { - $expectedSequence = [ - T_OPEN_PARENTHESIS, - T_PARAM_NAME, - T_COLON, - T_VARIABLE, - T_CLOSE_PARENTHESIS, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_STRING); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testNamedParamColon() - - - /** - * Verify tokenization of colon for a return type. - * - * @return void - */ - public function testReturnTypeColon() - { - $expectedSequence = [ - T_EQUAL, - T_CLOSURE, - T_OPEN_PARENTHESIS, - T_CLOSE_PARENTHESIS, - T_COLON, - T_STRING, - T_OPEN_CURLY_BRACKET, - T_CLOSE_CURLY_BRACKET, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_VARIABLE); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testReturnTypeColon() - - - /** - * Verify tokenization of a concatenation operator. - * - * @return void - */ - public function testConcat() - { - $expectedSequence = [ - T_STRING_CONCAT, - T_VARIABLE, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_CONSTANT_ENCAPSED_STRING); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testConcat() - - - /** - * Verify tokenization of simple math operators. - * - * @return void - */ - public function testSimpleMathTokens() - { - $expectedSequence = [ - T_EQUAL, - T_LNUMBER, - T_MULTIPLY, - T_LNUMBER, - T_DIVIDE, - T_LNUMBER, - T_PLUS, - T_LNUMBER, - T_MINUS, - T_LNUMBER, - T_MODULUS, - T_LNUMBER, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_VARIABLE); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testSimpleMathTokens() - - - /** - * Verify tokenization of unary plus/minus operators. - * - * @return void - */ - public function testUnaryPlusMinus() - { - $expectedSequence = [ - T_EQUAL, - T_PLUS, - T_LNUMBER, - T_DIVIDE, - T_MINUS, - T_LNUMBER, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_VARIABLE); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testUnaryPlusMinus() - - - /** - * Verify tokenization of bitwise operator tokens. - * - * @return void - */ - public function testBitwiseTokens() - { - $expectedSequence = [ - T_EQUAL, - T_STRING, - T_BITWISE_XOR, - T_STRING, - T_BITWISE_AND, - T_STRING, - T_BITWISE_OR, - T_STRING, - T_BITWISE_NOT, - T_STRING, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_VARIABLE); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testBitwiseTokens() - - - /** - * Verify tokenization of bitwise operator tokens. - * - * @return void - */ - public function testBitwiseOrInCatch() - { - $expectedSequence = [ - T_OPEN_PARENTHESIS, - T_STRING, - T_BITWISE_OR, - T_STRING, - T_VARIABLE, - T_CLOSE_PARENTHESIS, - T_OPEN_CURLY_BRACKET, - T_CLOSE_CURLY_BRACKET, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_CATCH); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testBitwiseOrInCatch() - - - /** - * Verify tokenization of a less than operator. - * - * @return void - */ - public function testLessThan() - { - $expectedSequence = [ - T_LESS_THAN, - T_VARIABLE, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_LNUMBER); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testLessThan() - - - /** - * Verify tokenization of a greater than operator. - * - * @return void - */ - public function testGreaterThan() - { - $expectedSequence = [ - T_GREATER_THAN, - T_VARIABLE, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_LNUMBER); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testGreaterThan() - - - /** - * Verify tokenization of a boolean not operator. - * - * @return void - */ - public function testBooleanNot() - { - $expectedSequence = [ - T_BOOLEAN_NOT, - T_VARIABLE, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_EQUAL); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testBooleanNot() - - - /** - * Verify tokenization of commas. - * - * @return void - */ - public function testComma() - { - $expectedSequence = [ - T_COMMA, - T_VARIABLE, - T_COMMA, - T_VARIABLE, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_VARIABLE); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testComma() - - - /** - * Verify tokenization of the silence operator. - * - * @return void - */ - public function testAsperand() - { - $expectedSequence = [ - T_ASPERAND, - T_STRING, - T_OPEN_PARENTHESIS, - T_CLOSE_PARENTHESIS, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_EQUAL); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testAsperand() - - - /** - * Verify tokenization of the dollar token and curlies for a variable variable. - * - * @return void - */ - public function testDollarAndCurlies() - { - $expectedSequence = [ - T_DOLLAR, - T_OPEN_CURLY_BRACKET, - T_VARIABLE, - T_CLOSE_CURLY_BRACKET, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_ECHO); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testDollarAndCurlies() - - - /** - * Verify tokenization of the backtick operator. - * - * @return void - */ - public function testBacktick() - { - $expectedSequence = [ - T_BACKTICK, - T_ENCAPSED_AND_WHITESPACE, - T_BACKTICK, - T_SEMICOLON, - ]; - - $target = $this->getTargetToken('/* '.__FUNCTION__.' */', T_EQUAL); - - $this->checkTokenSequence(($target + 1), $expectedSequence); - - }//end testBacktick() - - - /** - * Test helper. Check a token sequence complies with an expected token sequence. - * - * @param int $startPtr The position in the file to start checking from. - * @param array $expectedSequence The consecutive token constants to expect. - * - * @return void - */ - private function checkTokenSequence($startPtr, array $expectedSequence) - { - $tokens = $this->phpcsFile->getTokens(); - - $sequenceKey = 0; - $sequenceCount = count($expectedSequence); - - for ($i = $startPtr; $sequenceKey < $sequenceCount; $i++) { - if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { - // Ignore whitespace and comments, not interested in the tokenization of those for these tests. - continue; - } - - $expectedTokenName = Tokens::tokenName($expectedSequence[$sequenceKey]); - - $this->assertSame( - $expectedSequence[$sequenceKey], - $tokens[$i]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$i]['code']).', not '.$expectedTokenName.' (code)' - ); - - $this->assertSame( - $expectedTokenName, - $tokens[$i]['type'], - 'Token tokenized as '.$tokens[$i]['type'].', not '.$expectedTokenName.' (type)' - ); - - ++$sequenceKey; - }//end for - - }//end checkTokenSequence() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ShortArrayTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ShortArrayTest.inc deleted file mode 100644 index cf3b91eee..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ShortArrayTest.inc +++ /dev/null @@ -1,128 +0,0 @@ -function_call()[$x]; - -/* testStaticMethodCallDereferencing */ -$var = ClassName::function_call()[$x]; - -/* testPropertyDereferencing */ -$var = $obj->property[2]; - -/* testPropertyDereferencingWithInaccessibleName */ -$var = $ref->{'ref-type'}[1]; - -/* testStaticPropertyDereferencing */ -$var ClassName::$property[2]; - -/* testStringDereferencing */ -$var = 'PHP'[1]; - -/* testStringDereferencingDoubleQuoted */ -$var = "PHP"[$y]; - -/* testConstantDereferencing */ -$var = MY_CONSTANT[1]; - -/* testClassConstantDereferencing */ -$var ClassName::CONSTANT_NAME[2]; - -/* testMagicConstantDereferencing */ -$var = __FILE__[0]; - -/* testArrayAccessCurlyBraces */ -$var = $array{'key'}['key']; - -/* testArrayLiteralDereferencing */ -echo array(1, 2, 3)[0]; - -echo [1, 2, 3]/* testShortArrayLiteralDereferencing */[0]; - -/* testClassMemberDereferencingOnInstantiation1 */ -(new foo)[0]; - -/* testClassMemberDereferencingOnInstantiation2 */ -$a = (new Foo( array(1, array(4, 5), 3) ))[1][0]; - -/* testClassMemberDereferencingOnClone */ -echo (clone $iterable)[20]; - -/* testNullsafeMethodCallDereferencing */ -$var = $obj?->function_call()[$x]; - -/* testInterpolatedStringDereferencing */ -$var = "PHP{$rocks}"[1]; - -/* testNewAnonClassNoParenthesesExpressionDereferencing */ -$a = new class {}[0]; - -$a = new class (['value']) - /* testNewAnonClassParenthesesExpressionDereferencing */ - {}[0]; - -/* testNewAnonClassExtendsExpressionDereferencing */ -$a = new readonly class extends ArrayObject {}[0]; - -/* testNewAnonClassImplementsExpressionDereferencing */ -$a = new class implements ArrayAccess {}[0]; - -/* - * Short array brackets. - */ - -/* testShortArrayDeclarationEmpty */ -$array = []; - -/* testShortArrayDeclarationWithOneValue */ -$array = [1]; - -/* testShortArrayDeclarationWithMultipleValues */ -$array = [1, 2, 3]; - -/* testShortArrayDeclarationWithDereferencing */ -echo [1, 2, 3][0]; - -/* testShortListDeclaration */ -[ $a, $b ] = $array; - -[ $a, $b, /* testNestedListDeclaration */, [$c, $d]] = $array; - -/* testArrayWithinFunctionCall */ -$var = functionCall([$x, $y]); - -if ( true ) { - /* testShortListDeclarationAfterBracedControlStructure */ - [ $a ] = [ 'hi' ]; -} - -if ( true ) - /* testShortListDeclarationAfterNonBracedControlStructure */ - [ $a ] = [ 'hi' ]; - -if ( true ) : - /* testShortListDeclarationAfterAlternativeControlStructure */ - [ $a ] = [ 'hi' ]; -endif; - -class Foo extends ArrayObject {} -/* testShortListDeclarationAfterClassDeclaration */ -[$a] = ['hi']; - -/* testLiveCoding */ -// Intentional parse error. This has to be the last test in the file. -$array = [ diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ShortArrayTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ShortArrayTest.php deleted file mode 100644 index 456ee4796..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/ShortArrayTest.php +++ /dev/null @@ -1,146 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class ShortArrayTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that real square brackets are still tokenized as square brackets. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataSquareBrackets - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testSquareBrackets($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $opener = $this->getTargetToken($testMarker, [T_OPEN_SQUARE_BRACKET, T_OPEN_SHORT_ARRAY]); - $tokenArray = $tokens[$opener]; - - $this->assertSame(T_OPEN_SQUARE_BRACKET, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_OPEN_SQUARE_BRACKET (code)'); - $this->assertSame('T_OPEN_SQUARE_BRACKET', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_OPEN_SQUARE_BRACKET (type)'); - - if (isset($tokens[$opener]['bracket_closer']) === true) { - $closer = $tokens[$opener]['bracket_closer']; - $tokenArray = $tokens[$closer]; - - $this->assertSame(T_CLOSE_SQUARE_BRACKET, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_CLOSE_SQUARE_BRACKET (code)'); - $this->assertSame('T_CLOSE_SQUARE_BRACKET', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_CLOSE_SQUARE_BRACKET (type)'); - } - - }//end testSquareBrackets() - - - /** - * Data provider. - * - * @see testSquareBrackets() - * - * @return array> - */ - public static function dataSquareBrackets() - { - return [ - 'array access 1' => ['/* testArrayAccess1 */'], - 'array access 2' => ['/* testArrayAccess2 */'], - 'array assignment' => ['/* testArrayAssignment */'], - 'function call dereferencing' => ['/* testFunctionCallDereferencing */'], - 'method call dereferencing' => ['/* testMethodCallDereferencing */'], - 'static method call dereferencing' => ['/* testStaticMethodCallDereferencing */'], - 'property dereferencing' => ['/* testPropertyDereferencing */'], - 'property dereferencing with inaccessable name' => ['/* testPropertyDereferencingWithInaccessibleName */'], - 'static property dereferencing' => ['/* testStaticPropertyDereferencing */'], - 'string dereferencing single quotes' => ['/* testStringDereferencing */'], - 'string dereferencing double quotes' => ['/* testStringDereferencingDoubleQuoted */'], - 'global constant dereferencing' => ['/* testConstantDereferencing */'], - 'class constant dereferencing' => ['/* testClassConstantDereferencing */'], - 'magic constant dereferencing' => ['/* testMagicConstantDereferencing */'], - 'array access with curly braces' => ['/* testArrayAccessCurlyBraces */'], - 'array literal dereferencing' => ['/* testArrayLiteralDereferencing */'], - 'short array literal dereferencing' => ['/* testShortArrayLiteralDereferencing */'], - 'class member dereferencing on instantiation 1' => ['/* testClassMemberDereferencingOnInstantiation1 */'], - 'class member dereferencing on instantiation 2' => ['/* testClassMemberDereferencingOnInstantiation2 */'], - 'class member dereferencing on clone' => ['/* testClassMemberDereferencingOnClone */'], - 'nullsafe method call dereferencing' => ['/* testNullsafeMethodCallDereferencing */'], - 'interpolated string dereferencing' => ['/* testInterpolatedStringDereferencing */'], - 'new anonymous class expression dereferencing 1' => ['/* testNewAnonClassNoParenthesesExpressionDereferencing */'], - 'new anonymous class expression dereferencing 2' => ['/* testNewAnonClassParenthesesExpressionDereferencing */'], - 'new anonymous class expression dereferencing 3' => ['/* testNewAnonClassExtendsExpressionDereferencing */'], - 'new anonymous class expression dereferencing 4' => ['/* testNewAnonClassImplementsExpressionDereferencing */'], - 'live coding' => ['/* testLiveCoding */'], - ]; - - }//end dataSquareBrackets() - - - /** - * Test that short arrays and short lists are still tokenized as short arrays. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataShortArrays - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testShortArrays($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $opener = $this->getTargetToken($testMarker, [T_OPEN_SQUARE_BRACKET, T_OPEN_SHORT_ARRAY]); - $tokenArray = $tokens[$opener]; - - $this->assertSame(T_OPEN_SHORT_ARRAY, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_OPEN_SHORT_ARRAY (code)'); - $this->assertSame('T_OPEN_SHORT_ARRAY', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_OPEN_SHORT_ARRAY (type)'); - - if (isset($tokens[$opener]['bracket_closer']) === true) { - $closer = $tokens[$opener]['bracket_closer']; - $tokenArray = $tokens[$closer]; - - $this->assertSame(T_CLOSE_SHORT_ARRAY, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_CLOSE_SHORT_ARRAY (code)'); - $this->assertSame('T_CLOSE_SHORT_ARRAY', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_CLOSE_SHORT_ARRAY (type)'); - } - - }//end testShortArrays() - - - /** - * Data provider. - * - * @see testShortArrays() - * - * @return array> - */ - public static function dataShortArrays() - { - return [ - 'short array empty' => ['/* testShortArrayDeclarationEmpty */'], - 'short array with value' => ['/* testShortArrayDeclarationWithOneValue */'], - 'short array with values' => ['/* testShortArrayDeclarationWithMultipleValues */'], - 'short array with dereferencing' => ['/* testShortArrayDeclarationWithDereferencing */'], - 'short list' => ['/* testShortListDeclaration */'], - 'short list nested' => ['/* testNestedListDeclaration */'], - 'short array within function call' => ['/* testArrayWithinFunctionCall */'], - 'short list after braced control structure' => ['/* testShortListDeclarationAfterBracedControlStructure */'], - 'short list after non-braced control structure' => ['/* testShortListDeclarationAfterNonBracedControlStructure */'], - 'short list after alternative control structure' => ['/* testShortListDeclarationAfterAlternativeControlStructure */'], - 'short list after class declaration' => ['/* testShortListDeclarationAfterClassDeclaration */'], - ]; - - }//end dataShortArrays() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/StableCommentWhitespaceTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/StableCommentWhitespaceTest.inc deleted file mode 100644 index 3bf013c66..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/StableCommentWhitespaceTest.inc +++ /dev/null @@ -1,139 +0,0 @@ - - - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class StableCommentWhitespaceTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that comment tokenization with new lines at the end of the comment is stable. - * - * @param string $testMarker The comment prefacing the test. - * @param array> $expectedTokens The tokenization expected. - * - * @dataProvider dataCommentTokenization - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testCommentTokenization($testMarker, $expectedTokens) - { - $tokens = $this->phpcsFile->getTokens(); - $comment = $this->getTargetToken($testMarker, Tokens::$commentTokens); - - foreach ($expectedTokens as $tokenInfo) { - $this->assertSame( - constant($tokenInfo['type']), - $tokens[$comment]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$comment]['code']).', not '.$tokenInfo['type'].' (code)' - ); - $this->assertSame( - $tokenInfo['type'], - $tokens[$comment]['type'], - 'Token tokenized as '.$tokens[$comment]['type'].', not '.$tokenInfo['type'].' (type)' - ); - $this->assertSame($tokenInfo['content'], $tokens[$comment]['content']); - - ++$comment; - } - - }//end testCommentTokenization() - - - /** - * Data provider. - * - * @see testCommentTokenization() - * - * @return array>>> - */ - public static function dataCommentTokenization() - { - return [ - 'slash comment, single line' => [ - 'testMarker' => '/* testSingleLineSlashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, single line, trailing' => [ - 'testMarker' => '/* testSingleLineSlashCommentTrailing */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash ignore annotation, single line' => [ - 'testMarker' => '/* testSingleLineSlashAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_PHPCS_DISABLE', - 'content' => '// phpcs:disable Stnd.Cat -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line' => [ - 'testMarker' => '/* testMultiLineSlashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, indented' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithIndent */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, ignore annotation as first line' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithAnnotationStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, ignore annotation as middle line' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithAnnotationMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// @phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, ignore annotation as last line' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithAnnotationEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star comment, single line' => [ - 'testMarker' => '/* testSingleLineStarComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Single line star comment */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star comment, single line, trailing' => [ - 'testMarker' => '/* testSingleLineStarCommentTrailing */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Comment */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star ignore annotation, single line' => [ - 'testMarker' => '/* testSingleLineStarAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '/* phpcs:ignore Stnd.Cat */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star comment, multi-line' => [ - 'testMarker' => '/* testMultiLineStarComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment3 */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star comment, multi-line, indented' => [ - 'testMarker' => '/* testMultiLineStarCommentWithIndent */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment3 */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star comment, multi-line, ignore annotation as first line' => [ - 'testMarker' => '/* testMultiLineStarCommentWithAnnotationStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '/* @phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment3 */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star comment, multi-line, ignore annotation as middle line' => [ - 'testMarker' => '/* testMultiLineStarCommentWithAnnotationMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Comment1 -', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => ' * phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment3 */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'star comment, multi-line, ignore annotation as last line' => [ - 'testMarker' => '/* testMultiLineStarCommentWithAnnotationEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' * Comment2 -', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => ' * phpcs:ignore Stnd.Cat */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - - 'docblock comment, single line' => [ - 'testMarker' => '/* testSingleLineDocblockComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_DOC_COMMENT_OPEN_TAG', - 'content' => '/**', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment ', - ], - [ - 'type' => 'T_DOC_COMMENT_CLOSE_TAG', - 'content' => '*/', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'docblock comment, single line, trailing' => [ - 'testMarker' => '/* testSingleLineDocblockCommentTrailing */', - 'expectedTokens' => [ - [ - 'type' => 'T_DOC_COMMENT_OPEN_TAG', - 'content' => '/**', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment ', - ], - [ - 'type' => 'T_DOC_COMMENT_CLOSE_TAG', - 'content' => '*/', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'docblock ignore annotation, single line' => [ - 'testMarker' => '/* testSingleLineDocblockAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_DOC_COMMENT_OPEN_TAG', - 'content' => '/**', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => 'phpcs:ignore Stnd.Cat.Sniff ', - ], - [ - 'type' => 'T_DOC_COMMENT_CLOSE_TAG', - 'content' => '*/', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - - 'docblock comment, multi-line' => [ - 'testMarker' => '/* testMultiLineDocblockComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_DOC_COMMENT_OPEN_TAG', - 'content' => '/**', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment1', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment2', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_TAG', - 'content' => '@tag', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_CLOSE_TAG', - 'content' => '*/', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'docblock comment, multi-line, indented' => [ - 'testMarker' => '/* testMultiLineDocblockCommentWithIndent */', - 'expectedTokens' => [ - [ - 'type' => 'T_DOC_COMMENT_OPEN_TAG', - 'content' => '/**', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment1', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment2', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_TAG', - 'content' => '@tag', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_CLOSE_TAG', - 'content' => '*/', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'docblock comment, multi-line, ignore annotation' => [ - 'testMarker' => '/* testMultiLineDocblockCommentWithAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_DOC_COMMENT_OPEN_TAG', - 'content' => '/**', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => 'phpcs:ignore Stnd.Cat', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_TAG', - 'content' => '@tag', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_CLOSE_TAG', - 'content' => '*/', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'docblock comment, multi-line, ignore annotation as tag' => [ - 'testMarker' => '/* testMultiLineDocblockCommentWithTagAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_DOC_COMMENT_OPEN_TAG', - 'content' => '/**', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '@phpcs:ignore Stnd.Cat', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STAR', - 'content' => '*', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_TAG', - 'content' => '@tag', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_STRING', - 'content' => 'Comment', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_DOC_COMMENT_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_DOC_COMMENT_CLOSE_TAG', - 'content' => '*/', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, single line' => [ - 'testMarker' => '/* testSingleLineHashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, single line, trailing' => [ - 'testMarker' => '/* testSingleLineHashCommentTrailing */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, multi-line' => [ - 'testMarker' => '/* testMultiLineHashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, multi-line, indented' => [ - 'testMarker' => '/* testMultiLineHashCommentWithIndent */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment1 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment2 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, single line, without new line at end' => [ - 'testMarker' => '/* testSingleLineSlashCommentNoNewLineAtEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Slash ', - ], - [ - 'type' => 'T_CLOSE_TAG', - 'content' => '?> -', - ], - ], - ], - 'hash comment, single line, without new line at end' => [ - 'testMarker' => '/* testSingleLineHashCommentNoNewLineAtEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Hash ', - ], - [ - 'type' => 'T_CLOSE_TAG', - 'content' => '?> -', - ], - ], - ], - 'unclosed star comment at end of file' => [ - 'testMarker' => '/* testCommentAtEndOfFile */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Comment', - ], - ], - ], - ]; - - }//end dataCommentTokenization() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/StableCommentWhitespaceWinTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/StableCommentWhitespaceWinTest.inc deleted file mode 100644 index 6ca7026d4..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/StableCommentWhitespaceWinTest.inc +++ /dev/null @@ -1,63 +0,0 @@ - - - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class StableCommentWhitespaceWinTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that comment tokenization with new lines at the end of the comment is stable. - * - * @param string $testMarker The comment prefacing the test. - * @param array> $expectedTokens The tokenization expected. - * - * @dataProvider dataCommentTokenization - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testCommentTokenization($testMarker, $expectedTokens) - { - $tokens = $this->phpcsFile->getTokens(); - $comment = $this->getTargetToken($testMarker, Tokens::$commentTokens); - - foreach ($expectedTokens as $tokenInfo) { - $this->assertSame( - constant($tokenInfo['type']), - $tokens[$comment]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$comment]['code']).', not '.$tokenInfo['type'].' (code)' - ); - $this->assertSame( - $tokenInfo['type'], - $tokens[$comment]['type'], - 'Token tokenized as '.$tokens[$comment]['type'].', not '.$tokenInfo['type'].' (type)' - ); - $this->assertSame($tokenInfo['content'], $tokens[$comment]['content']); - - ++$comment; - } - - }//end testCommentTokenization() - - - /** - * Data provider. - * - * @see testCommentTokenization() - * - * @return array>>> - */ - public static function dataCommentTokenization() - { - return [ - 'slash comment, single line' => [ - 'testMarker' => '/* testSingleLineSlashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, single line, trailing' => [ - 'testMarker' => '/* testSingleLineSlashCommentTrailing */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash ignore annotation, single line' => [ - 'testMarker' => '/* testSingleLineSlashAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_PHPCS_DISABLE', - 'content' => '// phpcs:disable Stnd.Cat -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line' => [ - 'testMarker' => '/* testMultiLineSlashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, indented' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithIndent */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, ignore annotation as first line' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithAnnotationStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, ignore annotation as middle line' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithAnnotationMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// @phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, multi-line, ignore annotation as last line' => [ - 'testMarker' => '/* testMultiLineSlashCommentWithAnnotationEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// Comment2 -', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// phpcs:ignore Stnd.Cat -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'slash comment, single line, without new line at end' => [ - 'testMarker' => '/* testSingleLineSlashCommentNoNewLineAtEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '// Slash ', - ], - [ - 'type' => 'T_CLOSE_TAG', - 'content' => '?> -', - ], - ], - ], - 'hash comment, single line' => [ - 'testMarker' => '/* testSingleLineHashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, single line, trailing' => [ - 'testMarker' => '/* testSingleLineHashCommentTrailing */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, multi-line' => [ - 'testMarker' => '/* testMultiLineHashComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment2 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, multi-line, indented' => [ - 'testMarker' => '/* testMultiLineHashCommentWithIndent */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment1 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment2 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '# Comment3 -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'hash comment, single line, without new line at end' => [ - 'testMarker' => '/* testSingleLineHashCommentNoNewLineAtEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '# Hash ', - ], - [ - 'type' => 'T_CLOSE_TAG', - 'content' => '?> -', - ], - ], - ], - 'unclosed star comment at end of file' => [ - 'testMarker' => '/* testCommentAtEndOfFile */', - 'expectedTokens' => [ - [ - 'type' => 'T_COMMENT', - 'content' => '/* Comment', - ], - ], - ], - ]; - - }//end dataCommentTokenization() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypeIntersectionTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypeIntersectionTest.inc deleted file mode 100644 index c5792d6c6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypeIntersectionTest.inc +++ /dev/null @@ -1,185 +0,0 @@ - $param & $int; - -/* testTypeIntersectionArrowReturnType */ -$arrowWithReturnType = fn ($param) : Foo&Bar => $param * 10; - -/* testBitwiseAndInArrayKey */ -$array = array( - A & B => /* testBitwiseAndInArrayValue */ B & C -); - -/* testBitwiseAndInShortArrayKey */ -$array = [ - A & B => /* testBitwiseAndInShortArrayValue */ B & C -]; - -/* testBitwiseAndNonArrowFnFunctionCall */ -$obj->fn($something & $else); - -/* testBitwiseAnd6 */ -function &fn(/* testTypeIntersectionNonArrowFunctionDeclaration */ Foo&Bar $something) {} - -/* testTypeIntersectionWithInvalidTypes */ -function (int&string $var) {}; - -/* testLiveCoding */ -// Intentional parse error. This has to be the last test in the file. -return function( Foo& diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypeIntersectionTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypeIntersectionTest.php deleted file mode 100644 index 210a106d6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypeIntersectionTest.php +++ /dev/null @@ -1,165 +0,0 @@ - - * @author Jaroslav Hanslík - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class TypeIntersectionTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that non-intersection type bitwise and tokens are still tokenized as bitwise and. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataBitwiseAnd - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testBitwiseAnd($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_BITWISE_AND, T_TYPE_INTERSECTION]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_BITWISE_AND, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_BITWISE_AND (code)'); - $this->assertSame('T_BITWISE_AND', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_BITWISE_AND (type)'); - - }//end testBitwiseAnd() - - - /** - * Data provider. - * - * @see testBitwiseAnd() - * - * @return array> - */ - public static function dataBitwiseAnd() - { - return [ - 'in simple assignment 1' => ['/* testBitwiseAnd1 */'], - 'in simple assignment 2' => ['/* testBitwiseAnd2 */'], - 'in OO constant default value' => ['/* testBitwiseAndOOConstDefaultValue */'], - 'in property default value' => ['/* testBitwiseAndPropertyDefaultValue */'], - 'in method parameter default value' => ['/* testBitwiseAndParamDefaultValue */'], - 'reference for method parameter' => ['/* testBitwiseAnd3 */'], - 'in return statement' => ['/* testBitwiseAnd4 */'], - 'reference for function parameter' => ['/* testBitwiseAnd5 */'], - 'in OO constant default value DNF-like' => ['/* testBitwiseAndOOConstDefaultValueDNF */'], - 'in property default value DNF-like' => ['/* testBitwiseAndPropertyDefaultValueDNF */'], - 'in method parameter default value DNF-like' => ['/* testBitwiseAndParamDefaultValueDNF */'], - 'in closure parameter default value' => ['/* testBitwiseAndClosureParamDefault */'], - 'in arrow function parameter default value' => ['/* testBitwiseAndArrowParamDefault */'], - 'in arrow function return expression' => ['/* testBitwiseAndArrowExpression */'], - 'in long array key' => ['/* testBitwiseAndInArrayKey */'], - 'in long array value' => ['/* testBitwiseAndInArrayValue */'], - 'in short array key' => ['/* testBitwiseAndInShortArrayKey */'], - 'in short array value' => ['/* testBitwiseAndInShortArrayValue */'], - 'in parameter in function call' => ['/* testBitwiseAndNonArrowFnFunctionCall */'], - 'function return by reference' => ['/* testBitwiseAnd6 */'], - 'live coding / undetermined' => ['/* testLiveCoding */'], - ]; - - }//end dataBitwiseAnd() - - - /** - * Test that bitwise and tokens when used as part of a intersection type are tokenized as `T_TYPE_INTERSECTION`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataTypeIntersection - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testTypeIntersection($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_BITWISE_AND, T_TYPE_INTERSECTION]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_TYPE_INTERSECTION, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_TYPE_INTERSECTION (code)'); - $this->assertSame('T_TYPE_INTERSECTION', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_TYPE_INTERSECTION (type)'); - - }//end testTypeIntersection() - - - /** - * Data provider. - * - * @see testTypeIntersection() - * - * @return array> - */ - public static function dataTypeIntersection() - { - return [ - 'type for OO constant' => ['/* testTypeIntersectionOOConstSimple */'], - 'type for OO constant, reversed modifier order' => ['/* testTypeIntersectionOOConstReverseModifierOrder */'], - 'type for OO constant, first of multi-intersect' => ['/* testTypeIntersectionOOConstMulti1 */'], - 'type for OO constant, middle of multi-intersect + comments' => ['/* testTypeIntersectionOOConstMulti2 */'], - 'type for OO constant, last of multi-intersect' => ['/* testTypeIntersectionOOConstMulti3 */'], - 'type for OO constant, using namespace relative names' => ['/* testTypeIntersectionOOConstNamespaceRelative */'], - 'type for OO constant, using partially qualified names' => ['/* testTypeIntersectionOOConstPartiallyQualified */'], - 'type for OO constant, using fully qualified names' => ['/* testTypeIntersectionOOConstFullyQualified */'], - 'type for static property' => ['/* testTypeIntersectionPropertySimple */'], - 'type for static property, reversed modifier order' => ['/* testTypeIntersectionPropertyReverseModifierOrder */'], - 'type for property, first of multi-intersect' => ['/* testTypeIntersectionPropertyMulti1 */'], - 'type for property, middle of multi-intersect, also comments' => ['/* testTypeIntersectionPropertyMulti2 */'], - 'type for property, last of multi-intersect' => ['/* testTypeIntersectionPropertyMulti3 */'], - 'type for property using namespace relative names' => ['/* testTypeIntersectionPropertyNamespaceRelative */'], - 'type for property using partially qualified names' => ['/* testTypeIntersectionPropertyPartiallyQualified */'], - 'type for property using fully qualified names' => ['/* testTypeIntersectionPropertyFullyQualified */'], - 'type for readonly property' => ['/* testTypeIntersectionPropertyWithReadOnlyKeyword */'], - 'type for static readonly property' => ['/* testTypeIntersectionPropertyWithStaticKeyword */'], - 'type for final property' => ['/* testTypeIntersectionWithPHP84FinalKeyword */'], - 'type for final property reversed modifier order' => ['/* testTypeIntersectionWithPHP84FinalKeywordFirst */'], - 'type for asymmetric visibility (private(set)) property' => ['/* testTypeIntersectionPropertyWithPrivateSet */'], - 'type for asymmetric visibility (public private(set)) prop' => ['/* testTypeIntersectionPropertyWithPublicPrivateSet */'], - 'type for asymmetric visibility (protected(set)) property' => ['/* testTypeIntersectionPropertyWithProtectedSet */'], - 'type for asymmetric visibility (public protected(set)) prop' => ['/* testTypeIntersectionPropertyWithPublicProtectedSet */'], - 'type for abstract property' => ['/* testTypeIntersectionWithPHP84AbstractKeyword */'], - 'type for abstract property reversed modifier order' => ['/* testTypeIntersectionWithPHP84AbstractKeywordFirst */'], - 'type for method parameter' => ['/* testTypeIntersectionParam1 */'], - 'type for method parameter, first in multi-intersect' => ['/* testTypeIntersectionParam2 */'], - 'type for method parameter, last in multi-intersect' => ['/* testTypeIntersectionParam3 */'], - 'type for method parameter with namespace relative names' => ['/* testTypeIntersectionParamNamespaceRelative */'], - 'type for method parameter with partially qualified names' => ['/* testTypeIntersectionParamPartiallyQualified */'], - 'type for method parameter with fully qualified names' => ['/* testTypeIntersectionParamFullyQualified */'], - 'type for property in constructor property promotion' => ['/* testTypeIntersectionConstructorPropertyPromotion */'], - 'return type for method' => ['/* testTypeIntersectionReturnType */'], - 'return type for method, first of multi-intersect' => ['/* testTypeIntersectionAbstractMethodReturnType1 */'], - 'return type for method, last of multi-intersect' => ['/* testTypeIntersectionAbstractMethodReturnType2 */'], - 'return type for method with namespace relative names' => ['/* testTypeIntersectionReturnTypeNamespaceRelative */'], - 'return type for method with partially qualified names' => ['/* testTypeIntersectionReturnPartiallyQualified */'], - 'return type for method with fully qualified names' => ['/* testTypeIntersectionReturnFullyQualified */'], - 'type for function parameter with reference' => ['/* testTypeIntersectionWithReference */'], - 'type for function parameter with spread operator' => ['/* testTypeIntersectionWithSpreadOperator */'], - 'DNF type for OO constant, union before DNF' => ['/* testTypeIntersectionConstantTypeUnionBeforeDNF */'], - 'DNF type for property, union after DNF' => ['/* testTypeIntersectionPropertyTypeUnionAfterDNF */'], - 'DNF type for function param, union before and after DNF' => ['/* testTypeIntersectionParamUnionBeforeAndAfterDNF */'], - 'DNF type for function return, union after DNF with null' => ['/* testTypeIntersectionReturnTypeUnionAfterDNF */'], - 'type for closure parameter with illegal nullable' => ['/* testTypeIntersectionClosureParamIllegalNullable */'], - 'return type for closure' => ['/* testTypeIntersectionClosureReturn */'], - 'type for arrow function parameter' => ['/* testTypeIntersectionArrowParam */'], - 'return type for arrow function' => ['/* testTypeIntersectionArrowReturnType */'], - 'type for function parameter, return by ref' => ['/* testTypeIntersectionNonArrowFunctionDeclaration */'], - 'type for function parameter with invalid types' => ['/* testTypeIntersectionWithInvalidTypes */'], - ]; - - }//end dataTypeIntersection() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypedConstantsTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypedConstantsTest.inc deleted file mode 100644 index 4c6212b78..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypedConstantsTest.inc +++ /dev/null @@ -1,156 +0,0 @@ -const ? 0 : 1; - -/* testGlobalConstantCannotBeTyped */ -const GLOBAL_UNTYPED = true; - -/* testGlobalConstantTypedShouldStillBeHandled */ -const ?int GLOBAL_TYPED = true; - -class ClassWithPlainTypedConstants { - /* testClassConstFinalUntyped */ - final const FINAL_UNTYPED = true; - - /* testClassConstVisibilityUntyped */ - public const /*comment*/VISIBLE_UNTYPED = true; - - /* testClassConstTypedTrue */ - const true TYPED_TRUE = true; - /* testClassConstTypedFalse */ - final const false TYPED_FALSE = false; - /* testClassConstTypedNull */ - public const null TYPED_NULL = null; - /* testClassConstTypedBool */ - final protected const/*comment*/bool TYPED_BOOL = false; - /* testClassConstTypedInt */ - private const int TYPED_INT = 0; - /* testClassConstTypedFloat */ - const float TYPED_FLOAT = 0.5; - /* testClassConstTypedString */ - public final const string/*comment*/TYPED_STRING = 'string'; - /* testClassConstTypedArray */ - private final const array TYPED_ARRAY = []; - /* testClassConstTypedObject */ - const - object - TYPED_OBJECT = MyClass::getInstance(); - /* testClassConstTypedIterable */ - const iterable typed_iterable = []; - /* testClassConstTypedMixed */ - const mixed TYPED_MIXED = 'string'; - - /* testClassConstTypedClassUnqualified */ - const MyClass TYPED_UNQUALIFIED_CLASSNAME = MyClass::getInstance(); - /* testClassConstTypedClassFullyQualified */ - public const \MyClass TYPED_FULLY_QUALIFIED_CLASSNAME = MyClass::getInstance(); - /* testClassConstTypedClassNamespaceRelative */ - protected const namespace\MyClass TYPED_NAMESPACE_RELATIVE_CLASSNAME = MyClass::getInstance(); - /* testClassConstTypedClassPartiallyQualified */ - private const Partial\MyClass TYPED_PARTIALLY_QUALIFIED_CLASSNAME = MyClass::getInstance(); - /* testClassConstTypedParent */ - const parent TYPED_PARENT = parent::getInstance(); - - // Illegal types - the fact that these are not allowed in PHP is not the concern of the PHPCS tokenizer. - /* testClassConstTypedCallable */ - protected const callable TYPED_CALLABLE = 'function_name'; - /* testClassConstTypedVoid */ - protected const void TYPED_VOID = null; - /* testClassConstTypedNever */ - protected const NEVER TYPED_NEVER = null; -} - -trait TraitWithNullableTypedConstants { - /* testTraitConstTypedNullableTrue */ - const ?true TYPED_TRUE = true; - /* testTraitConstTypedNullableFalse */ - final const ?false TYPED_FALSE = false; - /* testTraitConstTypedNullableNull */ - public const ?null TYPED_NULL = null; - /* testTraitConstTypedNullableBool */ - final protected const ?bool TYPED_BOOL = false; - /* testTraitConstTypedNullableInt */ - private const ?int TYPED_INT = 0; - /* testTraitConstTypedNullableFloat */ - const ? /*comment*/ float TYPED_FLOAT = 0.5; - /* testTraitConstTypedNullableString */ - public final const ?string TYPED_STRING = 'string'; - /* testTraitConstTypedNullableArray */ - private final const ? array TYPED_ARRAY = []; - /* testTraitConstTypedNullableObject */ - const ?object TYPED_OBJECT = MyClass::getInstance(); - /* testTraitConstTypedNullableIterable */ - const ?iterable TYPED_ITERABLE = []; - /* testTraitConstTypedNullableMixed */ - const ?mixed TYPED_MIXED = 'string'; - - /* testTraitConstTypedNullableClassUnqualified */ - const ?MyClass TYPED_UNQUALIFIED_CLASSNAME = MyClass::getInstance(); - /* testTraitConstTypedNullableClassFullyQualified */ - public const ?\MyClass TYPED_FULLY_QUALIFIED_CLASSNAME = MyClass::getInstance(); - /* testTraitConstTypedNullableClassNamespaceRelative */ - protected const ?namespace\MyClass TYPED_NAMESPACE_RELATIVE_CLASSNAME = MyClass::getInstance(); - /* testTraitConstTypedNullableClassPartiallyQualified */ - private const ?Partial\MyClass TYPED_PARTIALLY_QUALIFIED_CLASSNAME = MyClass::getInstance(); - /* testTraitConstTypedNullableParent */ - const ?parent TYPED_PARENT = parent::getInstance(); -} - -interface InterfaceWithUnionTypedConstants { - /* testInterfaceConstTypedUnionTrueNull */ - const true|null /*comment*/ UNION_TRUE_NULL = true; - /* testInterfaceConstTypedUnionArrayObject */ - const array|object UNION_ARRAY_OBJECT = []; - /* testInterfaceConstTypedUnionStringArrayInt */ - const string | array | int UNION_STRING_ARRAY_INT = 'array middle'; - /* testInterfaceConstTypedUnionFloatBoolArray */ - const float /*comment*/| bool|array UNION_FLOAT_BOOL_ARRAY = false; - /* testInterfaceConstTypedUnionIterableFalse */ - const iterable|false UNION_ITERABLE_FALSE = false; - /* testInterfaceConstTypedUnionUnqualifiedNamespaceRelative */ - const Unqualified|namespace\Relative UNION_UNQUALIFIED_NSRELATIVE = new Unqualified(); - /* testInterfaceConstTypedUnionFullyQualifiedPartiallyQualified */ - const \Fully\Qualified|Partially\Qualified UNION_FQN_PARTIAL = new Partial\Qualified; -} - -enum EnumWithIntersectionTypedConstants { - // Illegal types in a class, but legal in an enum. - /* testEnumConstTypedSelf */ - final const self TYPED_SELF = self::getInstance(); - /* testEnumConstTypedStatic */ - const static TYPED_STATIC = static::getInstance(); - /* testEnumConstTypedNullableSelf */ - public const ?self TYPED_SELF = self::getInstance(); - /* testEnumConstTypedNullableStatic */ - const ?static TYPED_STATIC = static::getInstance(); - - /* testEnumConstTypedIntersectUnqualifiedNamespaceRelative */ - const Unqualified&namespace\Relative UNION_UNQUALIFIED_NSRELATIVE = new Unqualified(); - /* testEnumConstTypedIntersectFullyQualifiedPartiallyQualified */ - const \Fully\Qualified&Partially\Qualified UNION_FQN_PARTIAL = new Partial\Qualified; -} - -$anonClassWithDNFTypes = new class() extends Something { - /* testAnonClassConstDNFTypeNullAfter */ - const (A&B)|null DNF_OR_NULL_1 = null; - /* testAnonClassConstDNFTypeNullBefore */ - public final const NULL|(A&B) DNF_OR_NULL_2 = null; - /* testAnonClassConstDNFTypeFalseBefore */ - final const false|(C&D) DNF_OR_FALSE = false; - /* testAnonClassConstDNFTypeTrueAfter */ - private final const ( F & G ) | true DNF_OR_ARRAY = true; - /* testAnonClassConstDNFTypeTrueBeforeFalseAfter */ - public const TRUE|(SplBool&Stringable)|FALSE DNF_OR_BOOL = true; - /* testAnonClassConstDNFTypeArrayAfter */ - final protected const (Traversable&Countable)|array DNF_OR_ARRAY_1 = []; - /* testAnonClassConstDNFTypeArrayBefore */ - private const array /*comment*/ | ( Traversable /*comment*/ & Countable ) DNF_OR_ARRAY_2 = new MyClass; - /* testAnonClassConstDNFTypeInvalidNullable */ - const ? (Invalid&Fatal)|NullableNotAllowed DNF = null; - - /* testAnonClassConstDNFTypeFQNRelativePartiallyQualified */ - const (\FQN&namespace\Relative)|Partially\Qualified DNF_CLASSNAME = MyClass::getInstance(); - /* testAnonClassConstDNFTypeParentSelfStatic */ - const (parent&self)|static DNF_PARENT = parent::getInstance(); -}; diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypedConstantsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypedConstantsTest.php deleted file mode 100644 index 6968c4ef8..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/TypedConstantsTest.php +++ /dev/null @@ -1,668 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class TypedConstantsTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that a ? after a "const" which is not the constant keyword is tokenized as ternary then, not as the nullable operator. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testTernaryIsInlineThen() - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken('/* testTernaryIsTernaryAfterConst */', [T_NULLABLE, T_INLINE_THEN]); - - $this->assertSame( - T_INLINE_THEN, - $tokens[$target]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$target]['code']).', not T_INLINE_THEN (code)' - ); - $this->assertSame( - 'T_INLINE_THEN', - $tokens[$target]['type'], - 'Token tokenized as '.$tokens[$target]['type'].', not T_INLINE_THEN (type)' - ); - - }//end testTernaryIsInlineThen() - - - /** - * Test the token name for an untyped constant is tokenized as T_STRING. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataUntypedConstant - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testUntypedConstant($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, T_CONST); - - for ($i = ($target + 1); $tokens[$i]['code'] !== T_EQUAL; $i++) { - if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { - // Ignore whitespace and comments, not interested in the tokenization of those. - continue; - } - - $this->assertSame( - T_STRING, - $tokens[$i]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$i]['code']).', not T_STRING (code)' - ); - $this->assertSame( - 'T_STRING', - $tokens[$i]['type'], - 'Token tokenized as '.$tokens[$i]['type'].', not T_STRING (type)' - ); - } - - }//end testUntypedConstant() - - - /** - * Data provider. - * - * @see testUntypedConstant() - * - * @return array> - */ - public static function dataUntypedConstant() - { - return [ - 'non OO constant (untyped)' => [ - 'testMarker' => '/* testGlobalConstantCannotBeTyped */', - ], - 'OO constant, final, untyped' => [ - 'testMarker' => '/* testClassConstFinalUntyped */', - ], - 'OO constant, public, untyped, with comment' => [ - 'testMarker' => '/* testClassConstVisibilityUntyped */', - ], - ]; - - }//end dataUntypedConstant() - - - /** - * Test the tokens in the type of a typed constant as well as the constant name are tokenized correctly. - * - * @param string $testMarker The comment prefacing the target token. - * @param array $sequence The expected token sequence. - * - * @dataProvider dataTypedConstant - * @dataProvider dataNullableTypedConstant - * @dataProvider dataUnionTypedConstant - * @dataProvider dataIntersectionTypedConstant - * @dataProvider dataDNFTypedConstant - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * @covers PHP_CodeSniffer\Tokenizers\PHP::processAdditional - * - * @return void - */ - public function testTypedConstant($testMarker, array $sequence) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, T_CONST); - - $current = 0; - for ($i = ($target + 1); $tokens[$i]['code'] !== T_EQUAL; $i++) { - if (isset(Tokens::$emptyTokens[$tokens[$i]['code']]) === true) { - // Ignore whitespace and comments, not interested in the tokenization of those. - continue; - } - - $this->assertSame( - $sequence[$current], - $tokens[$i]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$i]['code']).', not '.Tokens::tokenName($sequence[$current]).' (code)' - ); - - ++$current; - } - - }//end testTypedConstant() - - - /** - * Data provider. - * - * @see testTypedConstant() - * - * @return array>> - */ - public static function dataTypedConstant() - { - $data = [ - 'simple type: true' => [ - 'testMarker' => '/* testClassConstTypedTrue */', - 'sequence' => [T_TRUE], - ], - 'simple type: false' => [ - 'testMarker' => '/* testClassConstTypedFalse */', - 'sequence' => [T_FALSE], - ], - 'simple type: null' => [ - 'testMarker' => '/* testClassConstTypedNull */', - 'sequence' => [T_NULL], - ], - 'simple type: bool' => [ - 'testMarker' => '/* testClassConstTypedBool */', - 'sequence' => [T_STRING], - ], - 'simple type: int' => [ - 'testMarker' => '/* testClassConstTypedInt */', - 'sequence' => [T_STRING], - ], - 'simple type: float' => [ - 'testMarker' => '/* testClassConstTypedFloat */', - 'sequence' => [T_STRING], - ], - 'simple type: string' => [ - 'testMarker' => '/* testClassConstTypedString */', - 'sequence' => [T_STRING], - ], - 'simple type: array' => [ - 'testMarker' => '/* testClassConstTypedArray */', - 'sequence' => [T_STRING], - ], - 'simple type: object' => [ - 'testMarker' => '/* testClassConstTypedObject */', - 'sequence' => [T_STRING], - ], - 'simple type: iterable' => [ - 'testMarker' => '/* testClassConstTypedIterable */', - 'sequence' => [T_STRING], - ], - 'simple type: mixed' => [ - 'testMarker' => '/* testClassConstTypedMixed */', - 'sequence' => [T_STRING], - ], - 'simple type: unqualified name' => [ - 'testMarker' => '/* testClassConstTypedClassUnqualified */', - 'sequence' => [T_STRING], - ], - 'simple type: fully qualified name' => [ - 'testMarker' => '/* testClassConstTypedClassFullyQualified */', - 'sequence' => [ - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'simple type: namespace relative name' => [ - 'testMarker' => '/* testClassConstTypedClassNamespaceRelative */', - 'sequence' => [ - T_NAMESPACE, - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'simple type: partially qualified name' => [ - 'testMarker' => '/* testClassConstTypedClassPartiallyQualified */', - 'sequence' => [ - T_STRING, - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'simple type: parent' => [ - 'testMarker' => '/* testClassConstTypedParent */', - 'sequence' => [T_PARENT], - ], - - 'simple type: callable (invalid)' => [ - 'testMarker' => '/* testClassConstTypedCallable */', - 'sequence' => [T_CALLABLE], - ], - 'simple type: void (invalid)' => [ - 'testMarker' => '/* testClassConstTypedVoid */', - 'sequence' => [T_STRING], - ], - 'simple type: NEVER (invalid)' => [ - 'testMarker' => '/* testClassConstTypedNever */', - 'sequence' => [T_STRING], - ], - - 'simple type: self (only valid in enum)' => [ - 'testMarker' => '/* testEnumConstTypedSelf */', - 'sequence' => [T_SELF], - ], - 'simple type: static (only valid in enum)' => [ - 'testMarker' => '/* testEnumConstTypedStatic */', - 'sequence' => [T_STATIC], - ], - ]; - - // The constant name, as the last token in the sequence, is always T_STRING. - foreach ($data as $key => $value) { - $data[$key]['sequence'][] = T_STRING; - } - - return $data; - - }//end dataTypedConstant() - - - /** - * Data provider. - * - * @see testTypedConstant() - * - * @return array>> - */ - public static function dataNullableTypedConstant() - { - $data = [ - // Global constants cannot be typed in PHP, but that's not our concern. - 'global typed constant, invalid, ?int' => [ - 'testMarker' => '/* testGlobalConstantTypedShouldStillBeHandled */', - 'sequence' => [T_STRING], - ], - - // OO constants. - 'nullable type: true' => [ - 'testMarker' => '/* testTraitConstTypedNullableTrue */', - 'sequence' => [T_TRUE], - ], - 'nullable type: false' => [ - 'testMarker' => '/* testTraitConstTypedNullableFalse */', - 'sequence' => [T_FALSE], - ], - 'nullable type: null' => [ - 'testMarker' => '/* testTraitConstTypedNullableNull */', - 'sequence' => [T_NULL], - ], - 'nullable type: bool' => [ - 'testMarker' => '/* testTraitConstTypedNullableBool */', - 'sequence' => [T_STRING], - ], - 'nullable type: int' => [ - 'testMarker' => '/* testTraitConstTypedNullableInt */', - 'sequence' => [T_STRING], - ], - 'nullable type: float' => [ - 'testMarker' => '/* testTraitConstTypedNullableFloat */', - 'sequence' => [T_STRING], - ], - 'nullable type: string' => [ - 'testMarker' => '/* testTraitConstTypedNullableString */', - 'sequence' => [T_STRING], - ], - 'nullable type: array' => [ - 'testMarker' => '/* testTraitConstTypedNullableArray */', - 'sequence' => [T_STRING], - ], - 'nullable type: object' => [ - 'testMarker' => '/* testTraitConstTypedNullableObject */', - 'sequence' => [T_STRING], - ], - 'nullable type: iterable' => [ - 'testMarker' => '/* testTraitConstTypedNullableIterable */', - 'sequence' => [T_STRING], - ], - 'nullable type: mixed' => [ - 'testMarker' => '/* testTraitConstTypedNullableMixed */', - 'sequence' => [T_STRING], - ], - 'nullable type: unqualified name' => [ - 'testMarker' => '/* testTraitConstTypedNullableClassUnqualified */', - 'sequence' => [T_STRING], - ], - 'nullable type: fully qualified name' => [ - 'testMarker' => '/* testTraitConstTypedNullableClassFullyQualified */', - 'sequence' => [ - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'nullable type: namespace relative name' => [ - 'testMarker' => '/* testTraitConstTypedNullableClassNamespaceRelative */', - 'sequence' => [ - T_NAMESPACE, - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'nullable type: partially qualified name' => [ - 'testMarker' => '/* testTraitConstTypedNullableClassPartiallyQualified */', - 'sequence' => [ - T_STRING, - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'nullable type: parent' => [ - 'testMarker' => '/* testTraitConstTypedNullableParent */', - 'sequence' => [T_PARENT], - ], - - 'nullable type: self (only valid in enum)' => [ - 'testMarker' => '/* testEnumConstTypedNullableSelf */', - 'sequence' => [T_SELF], - ], - 'nullable type: static (only valid in enum)' => [ - 'testMarker' => '/* testEnumConstTypedNullableStatic */', - 'sequence' => [T_STATIC], - ], - ]; - - // The nullable operator, as the first token in the sequence, is always T_NULLABLE. - // The constant name, as the last token in the sequence, is always T_STRING. - foreach ($data as $key => $value) { - array_unshift($data[$key]['sequence'], T_NULLABLE); - $data[$key]['sequence'][] = T_STRING; - } - - return $data; - - }//end dataNullableTypedConstant() - - - /** - * Data provider. - * - * @see testTypedConstant() - * - * @return array>> - */ - public static function dataUnionTypedConstant() - { - $data = [ - 'union type: true|null' => [ - 'testMarker' => '/* testInterfaceConstTypedUnionTrueNull */', - 'sequence' => [ - T_TRUE, - T_TYPE_UNION, - T_NULL, - ], - ], - 'union type: array|object' => [ - 'testMarker' => '/* testInterfaceConstTypedUnionArrayObject */', - 'sequence' => [ - T_STRING, - T_TYPE_UNION, - T_STRING, - ], - ], - 'union type: string|array|int' => [ - 'testMarker' => '/* testInterfaceConstTypedUnionStringArrayInt */', - 'sequence' => [ - T_STRING, - T_TYPE_UNION, - T_STRING, - T_TYPE_UNION, - T_STRING, - ], - ], - 'union type: float|bool|array' => [ - 'testMarker' => '/* testInterfaceConstTypedUnionFloatBoolArray */', - 'sequence' => [ - T_STRING, - T_TYPE_UNION, - T_STRING, - T_TYPE_UNION, - T_STRING, - ], - ], - 'union type: iterable|false' => [ - 'testMarker' => '/* testInterfaceConstTypedUnionIterableFalse */', - 'sequence' => [ - T_STRING, - T_TYPE_UNION, - T_FALSE, - ], - ], - 'union type: Unqualified|Namespace\Relative' => [ - 'testMarker' => '/* testInterfaceConstTypedUnionUnqualifiedNamespaceRelative */', - 'sequence' => [ - T_STRING, - T_TYPE_UNION, - T_NAMESPACE, - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'union type: FQN|Partial' => [ - 'testMarker' => '/* testInterfaceConstTypedUnionFullyQualifiedPartiallyQualified */', - 'sequence' => [ - T_NS_SEPARATOR, - T_STRING, - T_NS_SEPARATOR, - T_STRING, - T_TYPE_UNION, - T_STRING, - T_NS_SEPARATOR, - T_STRING, - ], - ], - ]; - - // The constant name, as the last token in the sequence, is always T_STRING. - foreach ($data as $key => $value) { - $data[$key]['sequence'][] = T_STRING; - } - - return $data; - - }//end dataUnionTypedConstant() - - - /** - * Data provider. - * - * @see testTypedConstant() - * - * @return array>> - */ - public static function dataIntersectionTypedConstant() - { - $data = [ - 'intersection type: Unqualified&Namespace\Relative' => [ - 'testMarker' => '/* testEnumConstTypedIntersectUnqualifiedNamespaceRelative */', - 'sequence' => [ - T_STRING, - T_TYPE_INTERSECTION, - T_NAMESPACE, - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'intersection type: FQN&Partial' => [ - 'testMarker' => '/* testEnumConstTypedIntersectFullyQualifiedPartiallyQualified */', - 'sequence' => [ - T_NS_SEPARATOR, - T_STRING, - T_NS_SEPARATOR, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_NS_SEPARATOR, - T_STRING, - ], - ], - ]; - - // The constant name, as the last token in the sequence, is always T_STRING. - foreach ($data as $key => $value) { - $data[$key]['sequence'][] = T_STRING; - } - - return $data; - - }//end dataIntersectionTypedConstant() - - - /** - * Data provider. - * - * @see testTypedConstant() - * - * @return array>> - */ - public static function dataDNFTypedConstant() - { - $data = [ - 'DNF type: null after' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeNullAfter */', - 'sequence' => [ - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - T_TYPE_UNION, - T_NULL, - ], - ], - 'DNF type: null before' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeNullBefore */', - 'sequence' => [ - T_NULL, - T_TYPE_UNION, - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - ], - ], - 'DNF type: false before' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeFalseBefore */', - 'sequence' => [ - T_FALSE, - T_TYPE_UNION, - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - ], - ], - 'DNF type: true after' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeTrueAfter */', - 'sequence' => [ - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - T_TYPE_UNION, - T_TRUE, - ], - ], - 'DNF type: true before, false after' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeTrueBeforeFalseAfter */', - 'sequence' => [ - T_TRUE, - T_TYPE_UNION, - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - T_TYPE_UNION, - T_FALSE, - ], - ], - 'DNF type: array after' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeArrayAfter */', - 'sequence' => [ - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - T_TYPE_UNION, - T_STRING, - ], - ], - 'DNF type: array before' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeArrayBefore */', - 'sequence' => [ - T_STRING, - T_TYPE_UNION, - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - ], - ], - 'DNF type: invalid nullable DNF' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeInvalidNullable */', - 'sequence' => [ - T_NULLABLE, - T_TYPE_OPEN_PARENTHESIS, - T_STRING, - T_TYPE_INTERSECTION, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - T_TYPE_UNION, - T_STRING, - ], - ], - 'DNF type: FQN/namespace relative/partially qualified names' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeFQNRelativePartiallyQualified */', - 'sequence' => [ - T_TYPE_OPEN_PARENTHESIS, - T_NS_SEPARATOR, - T_STRING, - T_TYPE_INTERSECTION, - T_NAMESPACE, - T_NS_SEPARATOR, - T_STRING, - T_TYPE_CLOSE_PARENTHESIS, - T_TYPE_UNION, - T_STRING, - T_NS_SEPARATOR, - T_STRING, - ], - ], - 'DNF type: invalid self/parent/static' => [ - 'testMarker' => '/* testAnonClassConstDNFTypeParentSelfStatic */', - 'sequence' => [ - T_TYPE_OPEN_PARENTHESIS, - T_PARENT, - T_TYPE_INTERSECTION, - T_SELF, - T_TYPE_CLOSE_PARENTHESIS, - T_TYPE_UNION, - T_STATIC, - ], - ], - ]; - - // The constant name, as the last token in the sequence, is always T_STRING. - foreach ($data as $key => $value) { - $data[$key]['sequence'][] = T_STRING; - } - - return $data; - - }//end dataDNFTypedConstant() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/UndoNamespacedNameSingleTokenTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/UndoNamespacedNameSingleTokenTest.inc deleted file mode 100644 index 50dccbdbc..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/UndoNamespacedNameSingleTokenTest.inc +++ /dev/null @@ -1,200 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -final class UndoNamespacedNameSingleTokenTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that identifier names are tokenized the same across PHP versions, based on the PHP 5/7 tokenization. - * - * @param string $testMarker The comment prefacing the test. - * @param array> $expectedTokens The tokenization expected. - * - * @dataProvider dataIdentifierTokenization - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - * - * @return void - */ - public function testIdentifierTokenization($testMarker, $expectedTokens) - { - $tokens = $this->phpcsFile->getTokens(); - $identifier = $this->getTargetToken($testMarker, constant($expectedTokens[0]['type'])); - - foreach ($expectedTokens as $tokenInfo) { - $this->assertSame( - constant($tokenInfo['type']), - $tokens[$identifier]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$identifier]['code']).', not '.$tokenInfo['type'].' (code)' - ); - $this->assertSame( - $tokenInfo['type'], - $tokens[$identifier]['type'], - 'Token tokenized as '.$tokens[$identifier]['type'].', not '.$tokenInfo['type'].' (type)' - ); - $this->assertSame($tokenInfo['content'], $tokens[$identifier]['content']); - - ++$identifier; - } - - }//end testIdentifierTokenization() - - - /** - * Data provider. - * - * @see testIdentifierTokenization() - * - * @return array>>> - */ - public static function dataIdentifierTokenization() - { - return [ - 'namespace declaration' => [ - 'testMarker' => '/* testNamespaceDeclaration */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Package', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'namespace declaration, multi-level' => [ - 'testMarker' => '/* testNamespaceDeclarationWithLevels */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'SubLevel', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Domain', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'import use statement, class' => [ - 'testMarker' => '/* testUseStatement */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'import use statement, class, multi-level' => [ - 'testMarker' => '/* testUseStatementWithLevels */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Domain', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'import use statement, function' => [ - 'testMarker' => '/* testFunctionUseStatement */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'function', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'import use statement, function, multi-level' => [ - 'testMarker' => '/* testFunctionUseStatementWithLevels */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'function', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_in_ns', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'import use statement, constant' => [ - 'testMarker' => '/* testConstantUseStatement */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'const', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'CONSTANT_NAME', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'import use statement, constant, multi-level' => [ - 'testMarker' => '/* testConstantUseStatementWithLevels */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'const', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'OTHER_CONSTANT', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'import use statement, multi-statement, unqualified class' => [ - 'testMarker' => '/* testMultiUseUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'UnqualifiedClassName', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - ], - ], - 'import use statement, multi-statement, partially qualified class' => [ - 'testMarker' => '/* testMultiUsePartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Sublevel', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'PartiallyClassName', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'group use statement, multi-level prefix, mix inside group' => [ - 'testMarker' => '/* testGroupUseStatement */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_OPEN_USE_GROUP', - 'content' => '{', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'AnotherDomain', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_grouped', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'const', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'CONSTANT_GROUPED', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Sub', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'YetAnotherDomain', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'SubLevelA', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_grouped_too', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'const', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'SubLevelB', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'CONSTANT_GROUPED_TOO', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_CLOSE_USE_GROUP', - 'content' => '}', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'class declaration' => [ - 'testMarker' => '/* testClassName */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'MyClass', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'class declaration, extends fully qualified name' => [ - 'testMarker' => '/* testExtendedFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'FQN', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'class declaration, implements namespace relative name' => [ - 'testMarker' => '/* testImplementsRelative */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'namespace', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - ], - ], - 'class declaration, implements fully qualified name' => [ - 'testMarker' => '/* testImplementsFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Fully', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Qualified', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - ], - ], - 'class declaration, implements unqualified name' => [ - 'testMarker' => '/* testImplementsUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Unqualified', - ], - [ - 'type' => 'T_COMMA', - 'content' => ',', - ], - ], - ], - 'class declaration, implements partially qualified name' => [ - 'testMarker' => '/* testImplementsPartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Sub', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'method declaration' => [ - 'testMarker' => '/* testFunctionName */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'function_name', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'param type declaration, namespace relative name' => [ - 'testMarker' => '/* testTypeDeclarationRelative */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'namespace', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_TYPE_UNION', - 'content' => '|', - ], - [ - 'type' => 'T_STRING', - 'content' => 'object', - ], - ], - ], - 'param type declaration, fully qualified name' => [ - 'testMarker' => '/* testTypeDeclarationFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Fully', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Qualified', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'param type declaration, unqualified name' => [ - 'testMarker' => '/* testTypeDeclarationUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Unqualified', - ], - [ - 'type' => 'T_TYPE_UNION', - 'content' => '|', - ], - [ - 'type' => 'T_FALSE', - 'content' => 'false', - ], - ], - ], - 'param type declaration, partially qualified name' => [ - 'testMarker' => '/* testTypeDeclarationPartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_NULLABLE', - 'content' => '?', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Sublevel', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'return type declaration, fully qualified name' => [ - 'testMarker' => '/* testReturnTypeFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NULLABLE', - 'content' => '?', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'function call, namespace relative name' => [ - 'testMarker' => '/* testFunctionCallRelative */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'NameSpace', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_name', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'function call, fully qualified name' => [ - 'testMarker' => '/* testFunctionCallFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Package', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_name', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'function call, unqualified name' => [ - 'testMarker' => '/* testFunctionCallUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'function_name', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'function call, partially qualified name' => [ - 'testMarker' => '/* testFunctionCallPartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_name', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'catch, namespace relative name' => [ - 'testMarker' => '/* testCatchRelative */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'namespace', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'SubLevel', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Exception', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'catch, fully qualified name' => [ - 'testMarker' => '/* testCatchFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Exception', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'catch, unqualified name' => [ - 'testMarker' => '/* testCatchUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Exception', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'catch, partially qualified name' => [ - 'testMarker' => '/* testCatchPartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Exception', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'class instantiation, namespace relative name' => [ - 'testMarker' => '/* testNewRelative */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'namespace', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'class instantiation, fully qualified name' => [ - 'testMarker' => '/* testNewFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Vendor', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'class instantiation, unqualified name' => [ - 'testMarker' => '/* testNewUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'class instantiation, partially qualified name' => [ - 'testMarker' => '/* testNewPartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'double colon class access, namespace relative name' => [ - 'testMarker' => '/* testDoubleColonRelative */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'namespace', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_DOUBLE_COLON', - 'content' => '::', - ], - ], - ], - 'double colon class access, fully qualified name' => [ - 'testMarker' => '/* testDoubleColonFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_DOUBLE_COLON', - 'content' => '::', - ], - ], - ], - 'double colon class access, unqualified name' => [ - 'testMarker' => '/* testDoubleColonUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_DOUBLE_COLON', - 'content' => '::', - ], - ], - ], - 'double colon class access, partially qualified name' => [ - 'testMarker' => '/* testDoubleColonPartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Level', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_DOUBLE_COLON', - 'content' => '::', - ], - ], - ], - 'instanceof, namespace relative name' => [ - 'testMarker' => '/* testInstanceOfRelative */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'namespace', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'instanceof, fully qualified name' => [ - 'testMarker' => '/* testInstanceOfFQN */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Full', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_CLOSE_PARENTHESIS', - 'content' => ')', - ], - ], - ], - 'instanceof, unqualified name' => [ - 'testMarker' => '/* testInstanceOfUnqualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'instanceof, partially qualified name' => [ - 'testMarker' => '/* testInstanceOfPartiallyQualified */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Partially', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'ClassName', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'exit in partially qualified name (start)' => [ - 'testMarker' => '/* testExitInNamespacedNameStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Exit', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'exit in fully qualified name (middle)' => [ - 'testMarker' => '/* testExitInNamespacedNameMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'exit', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'exit in fully qualified name (end)' => [ - 'testMarker' => '/* testExitInNamespacedNameEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Exit', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'PHP 8.4 exit as function call, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedExitFunctionCall */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_EXIT', - 'content' => 'Exit', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'exit as constant, fully qualified (illegal)' => [ - 'testMarker' => '/* testFullyQualifiedExitConstant */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_EXIT', - 'content' => 'exit', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'die in partially qualified name (start)' => [ - 'testMarker' => '/* testDieInNamespacedNameStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Die', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'die in fully qualified name (middle)' => [ - 'testMarker' => '/* testDieInNamespacedNameMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'die', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'die in fully qualified name (end)' => [ - 'testMarker' => '/* testDieInNamespacedNameEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'DIE', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'PHP 8.4 die as function call, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedDieFunctionCall */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_EXIT', - 'content' => 'die', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'die as constant, fully qualified (illegal)' => [ - 'testMarker' => '/* testFullyQualifiedDieConstant */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_EXIT', - 'content' => 'DIE', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'false in partially qualified name (start)' => [ - 'testMarker' => '/* testFalseInNamespacedNameStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'False', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'false in fully qualified name (middle)' => [ - 'testMarker' => '/* testFalseInNamespacedNameMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'false', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'false in fully qualified name (end)' => [ - 'testMarker' => '/* testFalseInNamespacedNameEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'FALSE', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'false, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedFalse */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_FALSE', - 'content' => 'false', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'true in partially qualified name (start)' => [ - 'testMarker' => '/* testTrueInNamespacedNameStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'True', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'true in fully qualified name (middle)' => [ - 'testMarker' => '/* testTrueInNamespacedNameMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'true', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'true in fully qualified name (end)' => [ - 'testMarker' => '/* testTrueInNamespacedNameEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'True', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'true, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedTrue */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_TRUE', - 'content' => 'TRUE', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'null in partially qualified name (start)' => [ - 'testMarker' => '/* testNullInNamespacedNameStart */', - 'expectedTokens' => [ - [ - 'type' => 'T_STRING', - 'content' => 'Null', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'null in fully qualified name (middle)' => [ - 'testMarker' => '/* testNullInNamespacedNameMiddle */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Null', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'null in fully qualified name (end)' => [ - 'testMarker' => '/* testNullInNamespacedNameEnd */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Not', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'null', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - 'null, fully qualified' => [ - 'testMarker' => '/* testFullyQualifiedNull */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_NULL', - 'content' => 'Null', - ], - [ - 'type' => 'T_SEMICOLON', - 'content' => ';', - ], - ], - ], - - 'function call, namespace relative, with whitespace (invalid in PHP 8)' => [ - 'testMarker' => '/* testInvalidInPHP8Whitespace */', - 'expectedTokens' => [ - [ - 'type' => 'T_NAMESPACE', - 'content' => 'namespace', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Sublevel', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_STRING', - 'content' => 'function_name', - ], - [ - 'type' => 'T_OPEN_PARENTHESIS', - 'content' => '(', - ], - ], - ], - 'double colon class access, fully qualified, with whitespace and comments (invalid in PHP 8)' => [ - 'testMarker' => '/* testInvalidInPHP8Comments */', - 'expectedTokens' => [ - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Fully', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// phpcs:ignore Stnd.Cat.Sniff -- for reasons -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Qualified', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '/* comment */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_NS_SEPARATOR', - 'content' => '\\', - ], - [ - 'type' => 'T_STRING', - 'content' => 'Name', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - ]; - - }//end dataIdentifierTokenization() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/YieldTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/YieldTest.inc deleted file mode 100644 index 3130b8460..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/YieldTest.inc +++ /dev/null @@ -1,77 +0,0 @@ -yield; - - /* testYieldUsedAsPropertyName2 */ - echo $obj?->yield(); - - /* testYieldUsedForClassConstantAccess1 */ - echo MyClass::YIELD; - /* testFromUsedForClassConstantAccess1 */ - echo MyClass::FROM; - } - - /* testYieldUsedAsMethodNameReturnByRef */ - public function &yield() {} -} - -function myGen() { - /* testYieldLiveCoding */ - yield diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/YieldTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/YieldTest.php deleted file mode 100644 index efb12096c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/PHP/YieldTest.php +++ /dev/null @@ -1,448 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; -use PHP_CodeSniffer\Util\Tokens; - -/** - * Tests the tokenization of the `yield` and `yield from` keywords. - * - * @covers PHP_CodeSniffer\Tokenizers\PHP::tokenize - */ -final class YieldTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the yield keyword is tokenized as such. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $expectedContent Expected token content. - * - * @dataProvider dataYieldKeyword - * - * @return void - */ - public function testYieldKeyword($testMarker, $expectedContent) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_YIELD, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD (code)'); - - // This assertion would fail on PHP 5.4 with PHPUnit 4 as PHPUnit polyfills the `T_YIELD` token too, but - // with a different value, which causes the token 'type' to be set to `UNKNOWN`. - // This issue _only_ occurs when running the tests, not when running PHPCS outside of a test situation. - // The PHPUnit polyfilled token is declared in the PHP_CodeCoverage_Report_HTML_Renderer_File class - // in vendor/phpunit/php-code-coverage/src/CodeCoverage/Report/HTML/Renderer/File.php. - if (PHP_VERSION_ID >= 50500) { - $this->assertSame('T_YIELD', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD (type)'); - } - - $this->assertSame($expectedContent, $tokenArray['content'], 'Token content does not match expectation'); - - }//end testYieldKeyword() - - - /** - * Data provider. - * - * @see testYieldKeyword() - * - * @return array> - */ - public static function dataYieldKeyword() - { - return [ - 'yield' => [ - 'testMarker' => '/* testYield */', - 'expectedContent' => 'yield', - ], - 'yield followed by comment' => [ - 'testMarker' => '/* testYieldFollowedByComment */', - 'expectedContent' => 'YIELD', - ], - 'yield at end of file, live coding' => [ - 'testMarker' => '/* testYieldLiveCoding */', - 'expectedContent' => 'yield', - ], - ]; - - }//end dataYieldKeyword() - - - /** - * Test that the yield from keyword is tokenized as a single token when it in on a single line - * and only has whitespace between the words. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param string $expectedContent Expected token content. - * - * @dataProvider dataYieldFromKeywordSingleToken - * - * @return void - */ - public function testYieldFromKeywordSingleToken($testMarker, $expectedContent) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_YIELD_FROM, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD_FROM (code)'); - $this->assertSame('T_YIELD_FROM', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_YIELD_FROM (type)'); - - if (isset($tokenArray['orig_content']) === true) { - $this->assertSame($expectedContent, $tokenArray['orig_content'], 'Token (orig) content does not match expectation'); - } else { - $this->assertSame($expectedContent, $tokenArray['content'], 'Token content does not match expectation'); - } - - }//end testYieldFromKeywordSingleToken() - - - /** - * Data provider. - * - * @see testYieldFromKeywordSingleToken() - * - * @return array> - */ - public static function dataYieldFromKeywordSingleToken() - { - return [ - 'yield from' => [ - 'testMarker' => '/* testYieldFrom */', - 'expectedContent' => 'yield from', - ], - 'yield from with extra space between' => [ - 'testMarker' => '/* testYieldFromWithExtraSpacesBetween */', - 'expectedContent' => 'Yield From', - ], - 'yield from with tab between' => [ - 'testMarker' => '/* testYieldFromWithTabBetween */', - 'expectedContent' => 'yield from', - ], - ]; - - }//end dataYieldFromKeywordSingleToken() - - - /** - * Test that the yield from keyword is tokenized as a single token when it in on a single line - * and only has whitespace between the words. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param array> $expectedTokens The tokenization expected. - * - * @dataProvider dataYieldFromKeywordMultiToken - * - * @return void - */ - public function testYieldFromKeywordMultiToken($testMarker, $expectedTokens) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]); - - foreach ($expectedTokens as $nr => $tokenInfo) { - $this->assertSame( - constant($tokenInfo['type']), - $tokens[$target]['code'], - 'Token tokenized as '.Tokens::tokenName($tokens[$target]['code']).', not '.$tokenInfo['type'].' (code)' - ); - $this->assertSame( - $tokenInfo['type'], - $tokens[$target]['type'], - 'Token tokenized as '.$tokens[$target]['type'].', not '.$tokenInfo['type'].' (type)' - ); - $this->assertSame( - $tokenInfo['content'], - $tokens[$target]['content'], - 'Content of token '.($nr + 1).' ('.$tokens[$target]['type'].') does not match expectations' - ); - - ++$target; - } - - }//end testYieldFromKeywordMultiToken() - - - /** - * Data provider. - * - * @see testYieldFromKeywordMultiToken() - * - * @return array>>> - */ - public static function dataYieldFromKeywordMultiToken() - { - return [ - 'yield from with new line' => [ - 'testMarker' => '/* testYieldFromSplitByNewLines */', - 'expectedTokens' => [ - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'yield', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'FROM', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'yield from with comment' => [ - 'testMarker' => '/* testYieldFromSplitByComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'yield', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '/* comment */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'from', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'yield from with trailing comment' => [ - 'testMarker' => '/* testYieldFromWithTrailingComment */', - 'expectedTokens' => [ - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'yield', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'from', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'yield from with trailing annotation' => [ - 'testMarker' => '/* testYieldFromWithTrailingAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'yield', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_PHPCS_IGNORE', - 'content' => '// phpcs:ignore Stnd.Cat.Sniff -- for reasons. -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'from', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - ], - ], - 'yield from with new line and comment' => [ - 'testMarker' => '/* testYieldFromSplitByNewLineAndComments */', - 'expectedTokens' => [ - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'yield', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '/* comment line 1 -', - ], - [ - 'type' => 'T_COMMENT', - 'content' => ' line 2 */', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_COMMENT', - 'content' => '// another comment -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'from', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - 'yield from with new line and annotation' => [ - 'testMarker' => '/* testYieldFromSplitByNewLineAndAnnotation */', - 'expectedTokens' => [ - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'YIELD', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_PHPCS_DISABLE', - 'content' => '// @phpcs:disable Stnd.Cat.Sniff -- for reasons. -', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' ', - ], - [ - 'type' => 'T_YIELD_FROM', - 'content' => 'From', - ], - [ - 'type' => 'T_WHITESPACE', - 'content' => ' -', - ], - ], - ], - ]; - - }//end dataYieldFromKeywordMultiToken() - - - /** - * Test that 'yield' or 'from' when not used as the reserved keyword are tokenized as `T_STRING`. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataYieldNonKeyword - * - * @return void - */ - public function testYieldNonKeyword($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_YIELD, T_YIELD_FROM, T_STRING]); - $tokenArray = $tokens[$target]; - - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - $this->assertSame('T_STRING', $tokenArray['type'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (type)'); - - }//end testYieldNonKeyword() - - - /** - * Data provider. - * - * @see testYieldNonKeyword() - * - * @return array> - */ - public static function dataYieldNonKeyword() - { - return [ - 'yield used as class name' => ['/* testYieldUsedAsClassName */'], - 'yield used as class constant name' => ['/* testYieldUsedAsClassConstantName */'], - 'yield used as method name' => ['/* testYieldUsedAsMethodName */'], - 'yield used as property access 1' => ['/* testYieldUsedAsPropertyName1 */'], - 'yield used as property access 2' => ['/* testYieldUsedAsPropertyName2 */'], - 'yield used as class constant access' => ['/* testYieldUsedForClassConstantAccess1 */'], - 'from used as class constant access' => ['/* testFromUsedForClassConstantAccess1 */'], - 'yield used as method name with ref' => ['/* testYieldUsedAsMethodNameReturnByRef */'], - ]; - - }//end dataYieldNonKeyword() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateParenthesisNestingMapDNFTypesTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateParenthesisNestingMapDNFTypesTest.inc deleted file mode 100644 index 89031bd19..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateParenthesisNestingMapDNFTypesTest.inc +++ /dev/null @@ -1,185 +0,0 @@ - 10 ) {} - -/* testParensOwnerFor */ -for ($i =0; $i < /* testParensNoOwnerInForCondition */ ( CONST_A & CONST_B ); $i++ ); - -/* testParensOwnerMatch */ -$match = match(CONST_A & CONST_B) { - default => $a, -}; - -/* testParensOwnerArray */ -$array = array ( - 'text', - \CONST_A & \Fully\Qualified\CONST_B, - /* testParensNoOwnerFunctionCallWithAmpersandInCallable */ - do_something($a, /* testParensOwnerArrowFn */ fn($b) => $a & $b, $c), -); - -/* testParensOwnerListWithRefVars */ -list(&$a, &$b) = $array; - -/* testParensNoOwnerFunctionCallwithDNFLookALikeParam */ -$obj->static((CONST_A&CONST_B)|CONST_C | $var); - - -/* - * DNF parentheses. - */ - -abstract class DNFTypes { - /* testDNFTypeOOConstUnqualifiedClasses */ - public const (A&B)|D UNQUALIFIED = new Foo; - - /* testDNFTypeOOConstReverseModifierOrder */ - protected final const int|(Foo&Bar)|float MODIFIERS_REVERSED /* testParensNoOwnerOOConstDefaultValue */ = (E_WARNING & E_NOTICE) | E_DEPRECATED; - - const - /* testDNFTypeOOConstMulti1 */ - (A&B) | - /* testDNFTypeOOConstMulti2 */ - (C&D) | // phpcs:ignore Stnd.Cat.Sniff - /* testDNFTypeOOConstMulti3 */ - (Y&D) - | null MULTI_DNF = null; - - /* testDNFTypeOOConstNamespaceRelative */ - final protected const (namespace\Sub\NameA&namespace\Sub\NameB)|namespace\Sub\NameC NAMESPACE_RELATIVE = new namespace\Sub\NameB; - - /* testDNFTypeOOConstPartiallyQualified */ - const Partially\Qualified\NameC|(Partially\Qualified\NameA&Partially\Qualified\NameB) PARTIALLY_QUALIFIED = new Partially\Qualified\NameA; - - /* testDNFTypeOOConstFullyQualified */ - const (\Fully\Qualified\NameA&\Fully\Qualified\NameB)|\Fully\Qualified\NameC FULLY_QUALIFIED = new \Fully\Qualified\NameB(); - - /* testDNFTypePropertyUnqualifiedClasses */ - public static (Foo&Bar)|array $obj; - - /* testDNFTypePropertyReverseModifierOrder */ - static protected string|(A&B)|int $dnf /* testParensNoOwnerPropertyDefaultValue1 */ = ( E_WARNING & E_NOTICE ) | /* testParensNoOwnerPropertyDefaultValue2 */ (E_ALL & E_DEPRECATED); - - private - /* testDNFTypePropertyMultiNamespaceRelative */ - (namespace\Sub\NameA&namespace\Sub\NameB) | - /* testDNFTypePropertyMultiPartiallyQualified */ - (Partially\Qualified\NameA&Partially\Qualified\NameB) | // phpcs:ignore Stnd.Cat.Sniff - false - /* testDNFTypePropertyMultiFullyQualified */ - | (\Fully\Qualified\NameA&\Fully\Qualified\NameB) $multiDnf; - - /* testDNFTypePropertyWithReadOnlyKeyword1 */ - protected readonly (A&B) | /* testDNFTypePropertyWithReadOnlyKeyword2 */ (C&D) $readonly; - - /* testDNFTypePropertyWithStaticAndReadOnlyKeywords */ - static readonly (A&B&C)|array $staticReadonly; - - /* testDNFTypePropertyWithOnlyStaticKeyword */ - static (A&B&C)|true $onlyStaticModified; - - public function paramTypes( - /* testDNFTypeParam1WithAttribute */ - #[MyAttribute] - (\Foo&Bar)|int|float $paramA /* testParensNoOwnerParamDefaultValue */ = SOMETHING | (CONSTANT_A & CONSTANT_B), - - /* testDNFTypeParam2 */ - (Foo&\Bar) /* testDNFTypeParam3 */ |(Baz&Fop) &...$paramB, - ) { - /* testParensNoOwnerInReturnValue1 */ - return ( - /* testParensNoOwnerInReturnValue2 */ - ($a1 & $b1) | - /* testParensNoOwnerInReturnValue3 */ - ($a2 & $b2) - ) + $c; - } - - public function identifierNames( - /* testDNFTypeParamNamespaceRelative */ - (namespace\Sub\NameA&namespace\Sub\NameB)|false $paramA, - /* testDNFTypeParamPartiallyQualified */ - Partially\Qualified\NameC|(Partially\Qualified\NameA&Partially\Qualified\NameB) $paramB, - /* testDNFTypeParamFullyQualified */ - name|(\Fully\Qualified\NameA&\Fully\Qualified\NameB) $paramC, - ) {} - - public function __construct( - /* testDNFTypeConstructorPropertyPromotion1 */ - public (A&B)| /* testDNFTypeConstructorPropertyPromotion2 */ (A&D) $property - ) {} - - public function returnType()/* testDNFTypeReturnType1 */ : A|(B&D)|/* testDNFTypeReturnType2 */(B&W)|null {} - - abstract public function abstractMethod(): /* testDNFTypeAbstractMethodReturnType1 */ (X&Y) /* testDNFTypeAbstractMethodReturnType2 */ |(W&Z); - - public function identifierNamesReturnRelative( - ) : /* testDNFTypeReturnTypeNamespaceRelative */ (namespace\Sub\NameA&namespace\Sub\NameB)|namespace\Sub\NameC {} - - public function identifierNamesReturnPQ( - ) : /* testDNFTypeReturnPartiallyQualified */Partially\Qualified\NameA|(Partially\Qualified\NameB&Partially\Qualified\NameC) {} - - // Illegal type: segments which are strict subsets of others are disallowed, but that's not the concern of the tokenizer. - public function identifierNamesReturnFQ( - ) /* testDNFTypeReturnFullyQualified */ : (\Fully\Qualified\NameA&\Fully\Qualified\NameB)|\Fully\Qualified\NameB {} -} - -function globalFunctionWithSpreadAndReference( - /* testDNFTypeWithReference */ - float|(B&A) &$paramA, - /* testDNFTypeWithSpreadOperator */ - string|(B&D) ...$paramB -) {} - - -$closureWithParamType = function ( /* testDNFTypeClosureParamIllegalNullable */ ?(A&B)|bool $string) {}; - -/* testParensOwnerClosureAmpersandInDefaultValue */ -$closureWithReturnType = function ($string = NONSENSE & FAKE) /* testDNFTypeClosureReturn */ : (\Package\MyA&PackageB)|null {}; - -/* testParensOwnerArrowDNFUsedWithin */ -$arrowWithParamType = fn ( - /* testDNFTypeArrowParam */ - int|(A&B&C)|array $param, - /* testParensNoOwnerAmpersandInDefaultValue */ ?int $int = (CONSTA & CONSTB )| CONST_C -) - /* testParensNoOwnerInArrowReturnExpression */ - => ($param & $foo ) | $int; - -$arrowWithReturnType = fn ($param) : /* testDNFTypeArrowReturnType */ int|(A&B) => $param * 10; - -$arrowWithParamReturnByRef = fn &( - /* testDNFTypeArrowParamWithReturnByRef */ - (A&B)|null $param -) => $param * 10; - -function InvalidSyntaxes( - /* testDNFTypeParamIllegalUnnecessaryParens */ - (A&B) $parensNotNeeded, - - /* testDNFTypeParamIllegalIntersectUnionReversed */ - A&(B|D) $onlyIntersectAllowedWithinParensAndUnionOutside, - - /* testDNFTypeParamIllegalNestedParens */ - A|(B&(D|W)|null) $nestedParensNotAllowed, -) {} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateParenthesisNestingMapDNFTypesTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateParenthesisNestingMapDNFTypesTest.php deleted file mode 100644 index d8393387c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateParenthesisNestingMapDNFTypesTest.php +++ /dev/null @@ -1,374 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class CreateParenthesisNestingMapDNFTypesTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that parentheses when **not** used in a type declaration are correctly tokenized. - * - * @param string $testMarker The comment prefacing the target token. - * @param int|false $owner Optional. The parentheses owner or false when no parentheses owner is expected. - * - * @dataProvider dataNormalParentheses - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createParenthesisNestingMap - * - * @return void - */ - public function testNormalParentheses($testMarker, $owner=false) - { - $tokens = $this->phpcsFile->getTokens(); - - $openPtr = $this->getTargetToken($testMarker, [T_OPEN_PARENTHESIS, T_TYPE_OPEN_PARENTHESIS]); - $opener = $tokens[$openPtr]; - - // Make sure we're looking at the right token. - $this->assertSame(T_OPEN_PARENTHESIS, $opener['code'], 'Token tokenized as '.$opener['type'].', not T_OPEN_PARENTHESIS (code)'); - - if ($owner !== false) { - $this->assertArrayHasKey('parenthesis_owner', $opener, 'Parenthesis owner is not set'); - $this->assertSame(($openPtr + $owner), $opener['parenthesis_owner'], 'Opener parenthesis owner is not the expected token'); - } else { - $this->assertArrayNotHasKey('parenthesis_owner', $opener, 'Parenthesis owner is set'); - } - - $this->assertArrayHasKey('parenthesis_opener', $opener, 'Parenthesis opener is not set'); - $this->assertArrayHasKey('parenthesis_closer', $opener, 'Parenthesis closer is not set'); - $this->assertSame($openPtr, $opener['parenthesis_opener'], 'Parenthesis opener is not the expected token'); - - $closePtr = $opener['parenthesis_closer']; - $closer = $tokens[$closePtr]; - - // Make sure we're looking at the right token. - $this->assertSame(T_CLOSE_PARENTHESIS, $closer['code'], 'Token tokenized as '.$closer['type'].', not T_CLOSE_PARENTHESIS (code)'); - - if ($owner !== false) { - $this->assertArrayHasKey('parenthesis_owner', $closer, 'Parenthesis owner is not set'); - $this->assertSame(($openPtr + $owner), $closer['parenthesis_owner'], 'Closer parenthesis owner is not the expected token'); - } else { - $this->assertArrayNotHasKey('parenthesis_owner', $closer, 'Parenthesis owner is set'); - } - - $this->assertArrayHasKey('parenthesis_opener', $closer, 'Parenthesis opener is not set'); - $this->assertArrayHasKey('parenthesis_closer', $closer, 'Parenthesis closer is not set'); - $this->assertSame($closePtr, $closer['parenthesis_closer'], 'Parenthesis closer is not the expected token'); - - for ($i = ($openPtr + 1); $i < $closePtr; $i++) { - $this->assertArrayHasKey('nested_parenthesis', $tokens[$i], "Nested parenthesis key not set on token $i ({$tokens[$i]['type']})"); - $this->assertArrayHasKey($openPtr, $tokens[$i]['nested_parenthesis'], 'Nested parenthesis is missing target parentheses set'); - $this->assertSame($closePtr, $tokens[$i]['nested_parenthesis'][$openPtr], 'Nested parenthesis closer not set correctly'); - } - - }//end testNormalParentheses() - - - /** - * Data provider. - * - * @see testNormalParentheses() - * - * @return array> - */ - public static function dataNormalParentheses() - { - // "Owner" offsets are relative to the open parenthesis. - return [ - 'parens without owner' => [ - 'testMarker' => '/* testParensNoOwner */', - ], - 'parens without owner in ternary then' => [ - 'testMarker' => '/* testParensNoOwnerInTernary */', - ], - 'parens without owner in short ternary' => [ - 'testMarker' => '/* testParensNoOwnerInShortTernary */', - ], - 'parens with owner: function; & in default value' => [ - 'testMarker' => '/* testParensOwnerFunctionAmpersandInDefaultValue */', - 'owner' => -3, - ], - 'parens with owner: closure; param declared by & ref' => [ - 'testMarker' => '/* testParensOwnerClosureAmpersandParamRef */', - 'owner' => -1, - ], - 'parens with owner: if' => [ - 'testMarker' => '/* testParensOwnerIf */', - 'owner' => -2, - ], - 'parens without owner in if condition' => [ - 'testMarker' => '/* testParensNoOwnerInIfCondition */', - ], - 'parens with owner: for' => [ - 'testMarker' => '/* testParensOwnerFor */', - 'owner' => -2, - ], - 'parens without owner in for condition' => [ - 'testMarker' => '/* testParensNoOwnerInForCondition */', - ], - 'parens with owner: match' => [ - 'testMarker' => '/* testParensOwnerMatch */', - 'owner' => -1, - ], - 'parens with owner: array' => [ - 'testMarker' => '/* testParensOwnerArray */', - 'owner' => -2, - ], - 'parens without owner in array; function call with & in callable' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallWithAmpersandInCallable */', - ], - 'parens with owner: fn; & in return value' => [ - 'testMarker' => '/* testParensOwnerArrowFn */', - 'owner' => -1, - ], - 'parens with owner: list with reference vars' => [ - 'testMarker' => '/* testParensOwnerListWithRefVars */', - 'owner' => -1, - ], - 'parens without owner, function call with DNF look-a-like param' => [ - 'testMarker' => '/* testParensNoOwnerFunctionCallwithDNFLookALikeParam */', - ], - - 'parens without owner in OO const default value' => [ - 'testMarker' => '/* testParensNoOwnerOOConstDefaultValue */', - ], - 'parens without owner in property default 1' => [ - 'testMarker' => '/* testParensNoOwnerPropertyDefaultValue1 */', - ], - 'parens without owner in property default 2' => [ - 'testMarker' => '/* testParensNoOwnerPropertyDefaultValue2 */', - ], - 'parens without owner in param default value' => [ - 'testMarker' => '/* testParensNoOwnerParamDefaultValue */', - ], - 'parens without owner in return statement 1' => [ - 'testMarker' => '/* testParensNoOwnerInReturnValue1 */', - ], - 'parens without owner in return statement 2' => [ - 'testMarker' => '/* testParensNoOwnerInReturnValue2 */', - ], - 'parens without owner in return statement 3' => [ - 'testMarker' => '/* testParensNoOwnerInReturnValue3 */', - ], - 'parens with owner: closure; & in default value' => [ - 'testMarker' => '/* testParensOwnerClosureAmpersandInDefaultValue */', - 'owner' => -2, - ], - 'parens with owner: fn; dnf used within' => [ - 'testMarker' => '/* testParensOwnerArrowDNFUsedWithin */', - 'owner' => -2, - ], - 'parens without owner: default value for param in arrow function' => [ - 'testMarker' => '/* testParensNoOwnerAmpersandInDefaultValue */', - ], - 'parens without owner in arrow function return expression' => [ - 'testMarker' => '/* testParensNoOwnerInArrowReturnExpression */', - ], - ]; - - }//end dataNormalParentheses() - - - /** - * Test that parentheses when used in a DNF type declaration are correctly tokenized. - * - * Includes verifying that: - * - the tokens between the parentheses all have a "nested_parenthesis" key. - * - all ampersands between the parentheses are tokenized as T_TYPE_INTERSECTION. - * - * @param string $testMarker The comment prefacing the target token. - * - * @dataProvider dataDNFTypeParentheses - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createParenthesisNestingMap - * - * @return void - */ - public function testDNFTypeParentheses($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - - $openPtr = $this->getTargetToken($testMarker, [T_OPEN_PARENTHESIS, T_TYPE_OPEN_PARENTHESIS]); - $opener = $tokens[$openPtr]; - - // Make sure we're looking at the right token. - $this->assertSame(T_TYPE_OPEN_PARENTHESIS, $opener['code'], 'Token tokenized as '.$opener['type'].', not T_TYPE_OPEN_PARENTHESIS (code)'); - - $this->assertArrayNotHasKey('parenthesis_owner', $opener, 'Parenthesis owner is set'); - $this->assertArrayHasKey('parenthesis_opener', $opener, 'Parenthesis opener is not set'); - $this->assertArrayHasKey('parenthesis_closer', $opener, 'Parenthesis closer is not set'); - $this->assertSame($openPtr, $opener['parenthesis_opener'], 'Parenthesis opener is not the expected token'); - - $closePtr = $opener['parenthesis_closer']; - $closer = $tokens[$closePtr]; - - // Make sure we're looking at the right token. - $this->assertSame(T_TYPE_CLOSE_PARENTHESIS, $closer['code'], 'Token tokenized as '.$closer['type'].', not T_TYPE_CLOSE_PARENTHESIS (code)'); - - $this->assertArrayNotHasKey('parenthesis_owner', $closer, 'Parenthesis owner is set'); - $this->assertArrayHasKey('parenthesis_opener', $closer, 'Parenthesis opener is not set'); - $this->assertArrayHasKey('parenthesis_closer', $closer, 'Parenthesis closer is not set'); - $this->assertSame($closePtr, $closer['parenthesis_closer'], 'Parenthesis closer is not the expected token'); - - for ($i = ($openPtr + 1); $i < $closePtr; $i++) { - $this->assertArrayHasKey('nested_parenthesis', $tokens[$i], "Nested parenthesis key not set on token $i ({$tokens[$i]['type']})"); - $this->assertArrayHasKey($openPtr, $tokens[$i]['nested_parenthesis'], 'Nested parenthesis is missing target parentheses set'); - $this->assertSame($closePtr, $tokens[$i]['nested_parenthesis'][$openPtr], 'Nested parenthesis closer not set correctly'); - }//end for - - }//end testDNFTypeParentheses() - - - /** - * Data provider. - * - * @see testDNFTypeParentheses() - * - * @return array> - */ - public static function dataDNFTypeParentheses() - { - return [ - 'OO const type: unqualified classes' => [ - 'testMarker' => '/* testDNFTypeOOConstUnqualifiedClasses */', - ], - 'OO const type: modifiers in reverse order' => [ - 'testMarker' => '/* testDNFTypeOOConstReverseModifierOrder */', - ], - 'OO const type: multi-dnf part 1' => [ - 'testMarker' => '/* testDNFTypeOOConstMulti1 */', - ], - 'OO const type: multi-dnf part 2' => [ - 'testMarker' => '/* testDNFTypeOOConstMulti2 */', - ], - 'OO const type: multi-dnf part 3' => [ - 'testMarker' => '/* testDNFTypeOOConstMulti3 */', - ], - 'OO const type: namespace relative classes' => [ - 'testMarker' => '/* testDNFTypeOOConstNamespaceRelative */', - ], - 'OO const type: partially qualified classes' => [ - 'testMarker' => '/* testDNFTypeOOConstPartiallyQualified */', - ], - 'OO const type: fully qualified classes' => [ - 'testMarker' => '/* testDNFTypeOOConstFullyQualified */', - ], - - 'OO property type: unqualified classes' => [ - 'testMarker' => '/* testDNFTypePropertyUnqualifiedClasses */', - ], - 'OO property type: modifiers in reverse order' => [ - 'testMarker' => '/* testDNFTypePropertyReverseModifierOrder */', - ], - 'OO property type: multi-dnf namespace relative classes' => [ - 'testMarker' => '/* testDNFTypePropertyMultiNamespaceRelative */', - ], - 'OO property type: multi-dnf partially qualified classes' => [ - 'testMarker' => '/* testDNFTypePropertyMultiPartiallyQualified */', - ], - 'OO property type: multi-dnf fully qualified classes' => [ - 'testMarker' => '/* testDNFTypePropertyMultiFullyQualified */', - ], - - 'OO property type: multi-dnf with readonly keyword 1' => [ - 'testMarker' => '/* testDNFTypePropertyWithReadOnlyKeyword1 */', - ], - 'OO property type: multi-dnf with readonly keyword 2' => [ - 'testMarker' => '/* testDNFTypePropertyWithReadOnlyKeyword2 */', - ], - 'OO property type: with static and readonly keywords' => [ - 'testMarker' => '/* testDNFTypePropertyWithStaticAndReadOnlyKeywords */', - ], - 'OO property type: with only static keyword' => [ - 'testMarker' => '/* testDNFTypePropertyWithOnlyStaticKeyword */', - ], - 'OO method param type: first param' => [ - 'testMarker' => '/* testDNFTypeParam1WithAttribute */', - ], - 'OO method param type: second param, first DNF' => [ - 'testMarker' => '/* testDNFTypeParam2 */', - ], - 'OO method param type: second param, second DNF' => [ - 'testMarker' => '/* testDNFTypeParam3 */', - ], - 'OO method param type: namespace relative classes' => [ - 'testMarker' => '/* testDNFTypeParamNamespaceRelative */', - ], - 'OO method param type: partially qualified classes' => [ - 'testMarker' => '/* testDNFTypeParamPartiallyQualified */', - ], - 'OO method param type: fully qualified classes' => [ - 'testMarker' => '/* testDNFTypeParamFullyQualified */', - ], - 'Constructor property promotion with multi DNF 1' => [ - 'testMarker' => '/* testDNFTypeConstructorPropertyPromotion1 */', - ], - 'Constructor property promotion with multi DNF 2' => [ - 'testMarker' => '/* testDNFTypeConstructorPropertyPromotion2 */', - ], - 'OO method return type: multi DNF 1' => [ - 'testMarker' => '/* testDNFTypeReturnType1 */', - ], - 'OO method return type: multi DNF 2' => [ - 'testMarker' => '/* testDNFTypeReturnType2 */', - ], - 'OO abstract method return type: multi DNF 1' => [ - 'testMarker' => '/* testDNFTypeAbstractMethodReturnType1 */', - ], - 'OO abstract method return type: multi DNF 2' => [ - 'testMarker' => '/* testDNFTypeAbstractMethodReturnType2 */', - ], - 'OO method return type: namespace relative classes' => [ - 'testMarker' => '/* testDNFTypeReturnTypeNamespaceRelative */', - ], - 'OO method return type: partially qualified classes' => [ - 'testMarker' => '/* testDNFTypeReturnPartiallyQualified */', - ], - 'OO method return type: fully qualified classes' => [ - 'testMarker' => '/* testDNFTypeReturnFullyQualified */', - ], - 'function param type: with reference' => [ - 'testMarker' => '/* testDNFTypeWithReference */', - ], - 'function param type: with spread' => [ - 'testMarker' => '/* testDNFTypeWithSpreadOperator */', - ], - 'closure param type: with illegal nullable' => [ - 'testMarker' => '/* testDNFTypeClosureParamIllegalNullable */', - ], - 'closure return type' => [ - 'testMarker' => '/* testDNFTypeClosureReturn */', - ], - 'arrow function param type' => [ - 'testMarker' => '/* testDNFTypeArrowParam */', - ], - 'arrow function return type' => [ - 'testMarker' => '/* testDNFTypeArrowReturnType */', - ], - 'arrow function param type with return by ref' => [ - 'testMarker' => '/* testDNFTypeArrowParamWithReturnByRef */', - ], - - 'illegal syntax: unnecessary parentheses (no union)' => [ - 'testMarker' => '/* testDNFTypeParamIllegalUnnecessaryParens */', - ], - 'illegal syntax: union within parentheses, intersect outside' => [ - 'testMarker' => '/* testDNFTypeParamIllegalIntersectUnionReversed */', - ], - 'illegal syntax: nested parentheses' => [ - 'testMarker' => '/* testDNFTypeParamIllegalNestedParens */', - ], - ]; - - }//end dataDNFTypeParentheses() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapHeredocNowdocCloserTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapHeredocNowdocCloserTest.inc deleted file mode 100644 index a800980b8..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapHeredocNowdocCloserTest.inc +++ /dev/null @@ -1,43 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Heredoc/nowdoc closer token test. - * - * @requires PHP 7.3 - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createPositionMap - */ -final class CreatePositionMapHeredocNowdocCloserTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify that leading (indent) whitespace in a heredoc/nowdoc closer token get the tab replacement treatment. - * - * @param string $testMarker The comment prefacing the target token. - * @param array $expected Expectations for the token array. - * - * @dataProvider dataHeredocNowdocCloserTabReplacement - * - * @return void - */ - public function testHeredocNowdocCloserTabReplacement($testMarker, $expected) - { - $tokens = $this->phpcsFile->getTokens(); - - $closer = $this->getTargetToken($testMarker, [T_END_HEREDOC, T_END_NOWDOC]); - - foreach ($expected as $key => $value) { - if ($key === 'orig_content' && $value === null) { - $this->assertArrayNotHasKey($key, $tokens[$closer], "Unexpected 'orig_content' key found in the token array."); - continue; - } - - $this->assertArrayHasKey($key, $tokens[$closer], "Key $key not found in the token array."); - $this->assertSame($value, $tokens[$closer][$key], "Value for key $key does not match expectation."); - } - - }//end testHeredocNowdocCloserTabReplacement() - - - /** - * Data provider. - * - * @see testHeredocNowdocCloserTabReplacement() - * - * @return array>> - */ - public static function dataHeredocNowdocCloserTabReplacement() - { - return [ - 'Heredoc closer without indent' => [ - 'testMarker' => '/* testHeredocCloserNoIndent */', - 'expected' => [ - 'length' => 3, - 'content' => 'EOD', - 'orig_content' => null, - ], - ], - 'Nowdoc closer without indent' => [ - 'testMarker' => '/* testNowdocCloserNoIndent */', - 'expected' => [ - 'length' => 3, - 'content' => 'EOD', - 'orig_content' => null, - ], - ], - 'Heredoc closer with indent, spaces' => [ - 'testMarker' => '/* testHeredocCloserSpaceIndent */', - 'expected' => [ - 'length' => 7, - 'content' => ' END', - 'orig_content' => null, - ], - ], - 'Nowdoc closer with indent, spaces' => [ - 'testMarker' => '/* testNowdocCloserSpaceIndent */', - 'expected' => [ - 'length' => 8, - 'content' => ' END', - 'orig_content' => null, - ], - ], - 'Heredoc closer with indent, tabs' => [ - 'testMarker' => '/* testHeredocCloserTabIndent */', - 'expected' => [ - 'length' => 8, - 'content' => ' END', - 'orig_content' => ' END', - ], - ], - 'Nowdoc closer with indent, tabs' => [ - 'testMarker' => '/* testNowdocCloserTabIndent */', - 'expected' => [ - 'length' => 7, - 'content' => ' END', - 'orig_content' => ' END', - ], - ], - ]; - - }//end dataHeredocNowdocCloserTabReplacement() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapHeredocNowdocOpenerTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapHeredocNowdocOpenerTest.inc deleted file mode 100644 index dc2b2f2dc..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapHeredocNowdocOpenerTest.inc +++ /dev/null @@ -1,31 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Heredoc/nowdoc opener token test. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createPositionMap - */ -final class CreatePositionMapHeredocNowdocOpenerTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify that spaces/tabs in a heredoc/nowdoc opener token get the tab replacement treatment. - * - * @param string $testMarker The comment prefacing the target token. - * @param array $expected Expectations for the token array. - * - * @dataProvider dataHeredocNowdocOpenerTabReplacement - * - * @return void - */ - public function testHeredocNowdocOpenerTabReplacement($testMarker, $expected) - { - $tokens = $this->phpcsFile->getTokens(); - $opener = $this->getTargetToken($testMarker, [T_START_HEREDOC, T_START_NOWDOC]); - - foreach ($expected as $key => $value) { - if ($key === 'orig_content' && $value === null) { - $this->assertArrayNotHasKey($key, $tokens[$opener], "Unexpected 'orig_content' key found in the token array."); - continue; - } - - $this->assertArrayHasKey($key, $tokens[$opener], "Key $key not found in the token array."); - $this->assertSame($value, $tokens[$opener][$key], "Value for key $key does not match expectation."); - } - - }//end testHeredocNowdocOpenerTabReplacement() - - - /** - * Data provider. - * - * @see testHeredocNowdocOpenerTabReplacement() - * - * @return array>> - */ - public static function dataHeredocNowdocOpenerTabReplacement() - { - return [ - 'Heredoc opener without space' => [ - 'testMarker' => '/* testHeredocOpenerNoSpace */', - 'expected' => [ - 'length' => 6, - 'content' => '<< null, - ], - ], - 'Nowdoc opener without space' => [ - 'testMarker' => '/* testNowdocOpenerNoSpace */', - 'expected' => [ - 'length' => 8, - 'content' => "<<<'EOD' -", - 'orig_content' => null, - ], - ], - 'Heredoc opener with space(s)' => [ - 'testMarker' => '/* testHeredocOpenerHasSpace */', - 'expected' => [ - 'length' => 7, - 'content' => '<<< END -', - 'orig_content' => null, - ], - ], - 'Nowdoc opener with space(s)' => [ - 'testMarker' => '/* testNowdocOpenerHasSpace */', - 'expected' => [ - 'length' => 21, - 'content' => "<<< 'END' -", - 'orig_content' => null, - ], - ], - 'Heredoc opener with tab(s)' => [ - 'testMarker' => '/* testHeredocOpenerHasTab */', - 'expected' => [ - 'length' => 18, - 'content' => '<<< "END" -', - 'orig_content' => '<<< "END" -', - ], - ], - 'Nowdoc opener with tab(s)' => [ - 'testMarker' => '/* testNowdocOpenerHasTab */', - 'expected' => [ - 'length' => 11, - 'content' => "<<< 'END' -", - 'orig_content' => "<<< 'END' -", - ], - ], - ]; - - }//end dataHeredocNowdocOpenerTabReplacement() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapTabWidth0Test.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapTabWidth0Test.php deleted file mode 100644 index fd47bf7da..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapTabWidth0Test.php +++ /dev/null @@ -1,107 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -/** - * Tab replacement test using tab width 0, means no tab replacement will take place. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createPositionMap - */ -final class CreatePositionMapTabWidth0Test extends ReplaceTabsInTokenTestCase -{ - - /** - * The tab width setting to use when tokenizing the file. - * - * @var integer - */ - protected $tabWidth = 0; - - - /** - * Data provider helper. - * - * @see ReplaceTabsInTokenTestCase::dataTabReplacement() - * - * @return array> - */ - public static function getTabReplacementExpected() - { - return [ - 'Tab indentation' => [ - 'length' => 2, - 'content' => ' ', - 'orig_content' => null, - ], - 'Mixed tab/space indentation' => [ - 'length' => 3, - 'content' => ' ', - 'orig_content' => null, - ], - 'Inline: single tab in text string' => [ - 'length' => 15, - 'content' => "'tab separated'", - 'orig_content' => null, - ], - 'Inline: single tab between each word in text string' => [ - 'length' => 24, - 'content' => '"tab $between each word"', - 'orig_content' => null, - ], - 'Inline: multiple tabs in heredoc' => [ - 'length' => 15, - 'content' => 'tab separated -', - 'orig_content' => null, - ], - 'Inline: multiple tabs between each word in nowdoc' => [ - 'length' => 27, - 'content' => 'tab between each word -', - 'orig_content' => null, - ], - 'Inline: mixed spaces/tabs in text string' => [ - 'length' => 20, - 'content' => "'tab separated'", - 'orig_content' => null, - ], - 'Inline: mixed spaces/tabs between each word in text string' => [ - 'length' => 31, - 'content' => '"tab $between each word"', - 'orig_content' => null, - ], - 'Inline: tab becomes single space in comment (with tabwidth 4)' => [ - 'length' => 50, - 'content' => '// -123 With tabwidth 4, the tab size should be 1. -', - 'orig_content' => null, - ], - 'Inline: tab becomes 2 spaces in comment (with tabwidth 4)' => [ - 'length' => 52, - 'content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - 'orig_content' => null, - ], - 'Inline: tab becomes 3 spaces in doc comment string (with tabwidth 4)' => [ - 'length' => 45, - 'content' => '-1 With tabwidth 4, the tab size should be 3.', - 'orig_content' => null, - ], - 'Inline: tab becomes 4 spaces in comment (with tabwidth 4)' => [ - 'length' => 47, - 'content' => '// - With tabwidth 4, the tab size should be 4. -', - 'orig_content' => null, - ], - ]; - - }//end getTabReplacementExpected() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapYieldFromTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapYieldFromTest.inc deleted file mode 100644 index 59365dd5c..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreatePositionMapYieldFromTest.inc +++ /dev/null @@ -1,15 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Yield from token test. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createPositionMap - */ -final class CreatePositionMapYieldFromTest extends AbstractTokenizerTestCase -{ - - - /** - * Verify that spaces/tabs in "yield from" tokens get the tab replacement treatment. - * - * @param string $testMarker The comment prefacing the target token. - * @param array $expected Expectations for the token array. - * @param string $content Optional. The test token content to search for. - * Defaults to null. - * - * @dataProvider dataYieldFromTabReplacement - * - * @return void - */ - public function testYieldFromTabReplacement($testMarker, $expected, $content=null) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, [T_YIELD_FROM], $content); - - foreach ($expected as $key => $value) { - if ($key === 'orig_content' && $value === null) { - $this->assertArrayNotHasKey($key, $tokens[$target], "Unexpected 'orig_content' key found in the token array."); - continue; - } - - $this->assertArrayHasKey($key, $tokens[$target], "Key $key not found in the token array."); - $this->assertSame($value, $tokens[$target][$key], "Value for key $key does not match expectation."); - } - - }//end testYieldFromTabReplacement() - - - /** - * Data provider. - * - * @see testYieldFromTabReplacement() - * - * @return array>> - */ - public static function dataYieldFromTabReplacement() - { - return [ - 'Yield from, single line, single space' => [ - 'testMarker' => '/* testYieldFromHasSingleSpace */', - 'expected' => [ - 'length' => 10, - 'content' => 'yield from', - 'orig_content' => null, - ], - ], - 'Yield from, single line, multiple spaces' => [ - 'testMarker' => '/* testYieldFromHasMultiSpace */', - 'expected' => [ - 'length' => 14, - 'content' => 'yield from', - 'orig_content' => null, - ], - ], - 'Yield from, single line, has tabs' => [ - 'testMarker' => '/* testYieldFromHasTabs */', - 'expected' => [ - 'length' => 16, - 'content' => 'yield from', - 'orig_content' => 'yield from', - ], - ], - 'Yield from, single line, mix of tabs and spaces' => [ - 'testMarker' => '/* testYieldFromMixedTabsSpaces */', - 'expected' => [ - 'length' => 20, - 'content' => 'Yield From', - 'orig_content' => 'Yield From', - ], - ], - ]; - - }//end dataYieldFromTabReplacement() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateTokenMapArrayParenthesesTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateTokenMapArrayParenthesesTest.inc deleted file mode 100644 index 6d8adfcba..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateTokenMapArrayParenthesesTest.inc +++ /dev/null @@ -1,58 +0,0 @@ - 10); - -/* testArrayWithComment */ -$var = Array /*comment*/ (1 => 10); - -/* testNestingArray */ -$var = array( - /* testNestedArray */ - array( - 'key' => 'value', - - /* testClosureReturnType */ - 'closure' => function($a) use($global) : Array {}, - ), -); - -/* testFunctionDeclarationParamType */ -function typedParam(array $a) {} - -/* testFunctionDeclarationReturnType */ -function returnType($a) : int|array|null {} - -class Bar { - /* testClassConst */ - const ARRAY = []; - - /* testClassMethod */ - public function array() {} - - /* testOOConstType */ - const array /* testTypedOOConstName */ ARRAY = /* testOOConstDefault */ array(); - - /* testOOPropertyType */ - protected array $property; -} - -class DNFTypes { - /* testOOConstDNFType */ - const (A&B)|array|(C&D) NAME = []; - - /* testOOPropertyDNFType */ - protected (A&B)|ARRAY|null $property; - - /* testFunctionDeclarationParamDNFType */ - public function name(null|array|(A&B) $param) { - /* testClosureDeclarationParamDNFType */ - $cl = function ( array|(A&B) $param) {}; - - /* testArrowDeclarationReturnDNFType */ - $arrow = fn($a): (A&B)|Array => new $a; - } -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateTokenMapArrayParenthesesTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateTokenMapArrayParenthesesTest.php deleted file mode 100644 index e811211fd..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/CreateTokenMapArrayParenthesesTest.php +++ /dev/null @@ -1,212 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class CreateTokenMapArrayParenthesesTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the array keyword is correctly tokenized as `T_ARRAY`. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent Optional. The token content to look for. - * - * @dataProvider dataArrayKeyword - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createTokenMap - * - * @return void - */ - public function testArrayKeyword($testMarker, $testContent='array') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_ARRAY, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - // Make sure we're looking at the right token. - $this->assertSame(T_ARRAY, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_ARRAY (code)'); - - $this->assertArrayHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is not set'); - $this->assertArrayHasKey('parenthesis_opener', $tokenArray, 'Parenthesis opener is not set'); - $this->assertArrayHasKey('parenthesis_closer', $tokenArray, 'Parenthesis closer is not set'); - - }//end testArrayKeyword() - - - /** - * Data provider. - * - * @see testArrayKeyword() - * - * @return array> - */ - public static function dataArrayKeyword() - { - return [ - 'empty array' => [ - 'testMarker' => '/* testEmptyArray */', - ], - 'array with space before parenthesis' => [ - 'testMarker' => '/* testArrayWithSpace */', - ], - 'array with comment before parenthesis' => [ - 'testMarker' => '/* testArrayWithComment */', - 'testContent' => 'Array', - ], - 'nested: outer array' => [ - 'testMarker' => '/* testNestingArray */', - ], - 'nested: inner array' => [ - 'testMarker' => '/* testNestedArray */', - ], - 'OO constant default value' => [ - 'testMarker' => '/* testOOConstDefault */', - ], - ]; - - }//end dataArrayKeyword() - - - /** - * Test that the array keyword when used in a type declaration is correctly tokenized as `T_STRING`. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent Optional. The token content to look for. - * - * @dataProvider dataArrayType - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createTokenMap - * - * @return void - */ - public function testArrayType($testMarker, $testContent='array') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_ARRAY, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - // Make sure we're looking at the right token. - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - - $this->assertArrayNotHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is set'); - $this->assertArrayNotHasKey('parenthesis_opener', $tokenArray, 'Parenthesis opener is set'); - $this->assertArrayNotHasKey('parenthesis_closer', $tokenArray, 'Parenthesis closer is set'); - - }//end testArrayType() - - - /** - * Data provider. - * - * @see testArrayType() - * - * @return array> - */ - public static function dataArrayType() - { - return [ - 'closure return type' => [ - 'testMarker' => '/* testClosureReturnType */', - 'testContent' => 'Array', - ], - 'function param type' => [ - 'testMarker' => '/* testFunctionDeclarationParamType */', - ], - 'function union return type' => [ - 'testMarker' => '/* testFunctionDeclarationReturnType */', - ], - 'OO constant type' => [ - 'testMarker' => '/* testOOConstType */', - ], - 'OO property type' => [ - 'testMarker' => '/* testOOPropertyType */', - ], - - 'OO constant DNF type' => [ - 'testMarker' => '/* testOOConstDNFType */', - ], - 'OO property DNF type' => [ - 'testMarker' => '/* testOOPropertyDNFType */', - 'testContent' => 'ARRAY', - ], - 'function param DNF type' => [ - 'testMarker' => '/* testFunctionDeclarationParamDNFType */', - ], - 'closure param DNF type' => [ - 'testMarker' => '/* testClosureDeclarationParamDNFType */', - ], - 'arrow return DNF type' => [ - 'testMarker' => '/* testArrowDeclarationReturnDNFType */', - 'testContent' => 'Array', - ], - ]; - - }//end dataArrayType() - - - /** - * Verify that the retokenization of `T_ARRAY` tokens to `T_STRING` is handled correctly - * for tokens with the contents 'array' which aren't in actual fact the array keyword. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataNotArrayKeyword - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::createTokenMap - * - * @return void - */ - public function testNotArrayKeyword($testMarker, $testContent='array') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_ARRAY, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - // Make sure we're looking at the right token. - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - - $this->assertArrayNotHasKey('parenthesis_owner', $tokenArray, 'Parenthesis owner is set'); - $this->assertArrayNotHasKey('parenthesis_opener', $tokenArray, 'Parenthesis opener is set'); - $this->assertArrayNotHasKey('parenthesis_closer', $tokenArray, 'Parenthesis closer is set'); - - }//end testNotArrayKeyword() - - - /** - * Data provider. - * - * @see testNotArrayKeyword() - * - * @return array> - */ - public static function dataNotArrayKeyword() - { - return [ - 'class-constant-name' => [ - 'testMarker' => '/* testClassConst */', - 'testContent' => 'ARRAY', - ], - 'class-method-name' => [ - 'testMarker' => '/* testClassMethod */', - ], - 'class-constant-name-after-type' => [ - 'testMarker' => '/* testTypedOOConstName */', - 'testContent' => 'ARRAY', - ], - ]; - - }//end dataNotArrayKeyword() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.inc deleted file mode 100644 index c41aeddbe..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.inc +++ /dev/null @@ -1,134 +0,0 @@ - $num) - return bar( - baz( - "foobarbaz" - ) - ); - break; -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.php deleted file mode 100644 index 2b185c572..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapCaseKeywordConditionsTest.php +++ /dev/null @@ -1,272 +0,0 @@ - - * @copyright 2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class RecurseScopeMapCaseKeywordConditionsTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that enum "case" tokens does not get scope indexes. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataEnumCases - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testEnumCases($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $enumCase = $this->getTargetToken($testMarker, [T_ENUM_CASE, T_CASE]); - $tokenArray = $tokens[$enumCase]; - - // Make sure we're looking at the right token. - $this->assertSame(T_ENUM_CASE, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_ENUM_CASE (code)'); - - $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); - $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); - $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); - - }//end testEnumCases() - - - /** - * Data provider. - * - * @see testEnumCases() - * - * @return array> - */ - public static function dataEnumCases() - { - return [ - 'enum case, no value' => ['/* testPureEnumCase */'], - 'enum case, integer value' => ['/* testBackingIntegerEnumCase */'], - 'enum case, string value' => ['/* testBackingStringEnumCase */'], - 'enum case, integer value in more complex enum' => ['/* testEnumCaseInComplexEnum */'], - 'enum case, keyword in mixed case' => ['/* testEnumCaseIsCaseInsensitive */'], - 'enum case, after switch statement' => ['/* testEnumCaseAfterSwitch */'], - 'enum case, after switch statement using alternative syntax' => ['/* testEnumCaseAfterSwitchWithEndSwitch */'], - ]; - - }//end dataEnumCases() - - - /** - * Test that switch "case" tokens do get the scope indexes. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param array $expectedTokens The expected token codes for the scope opener/closer. - * @param string|null $testCloserMarker Optional. The comment which prefaces the scope closer if different - * from the test marker. - * - * @dataProvider dataNotEnumCases - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testNotEnumCases($testMarker, $expectedTokens, $testCloserMarker=null) - { - $tokens = $this->phpcsFile->getTokens(); - $caseIndex = $this->getTargetToken($testMarker, [T_ENUM_CASE, T_CASE]); - $tokenArray = $tokens[$caseIndex]; - - $scopeCloserMarker = $testMarker; - if (isset($testCloserMarker) === true) { - $scopeCloserMarker = $testCloserMarker; - } - - $expectedScopeCondition = $caseIndex; - $expectedScopeOpener = $this->getTargetToken($testMarker, $expectedTokens['scope_opener']); - $expectedScopeCloser = $this->getTargetToken($scopeCloserMarker, $expectedTokens['scope_closer']); - - // Make sure we're looking at the right token. - $this->assertSame(T_CASE, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_CASE (code)'); - - $this->assertArrayHasKey('scope_condition', $tokenArray, 'Scope condition is not set'); - $this->assertSame( - $expectedScopeCondition, - $tokenArray['scope_condition'], - sprintf( - 'Scope condition not set correctly; expected T_CASE, found %s.', - $tokens[$tokenArray['scope_condition']]['type'] - ) - ); - - $this->assertArrayHasKey('scope_opener', $tokenArray, 'Scope opener is not set'); - $this->assertSame( - $expectedScopeOpener, - $tokenArray['scope_opener'], - sprintf( - 'Scope opener not set correctly; expected %s, found %s.', - $tokens[$expectedScopeOpener]['type'], - $tokens[$tokenArray['scope_opener']]['type'] - ) - ); - - $this->assertArrayHasKey('scope_closer', $tokenArray, 'Scope closer is not set'); - $this->assertSame( - $expectedScopeCloser, - $tokenArray['scope_closer'], - sprintf( - 'Scope closer not set correctly; expected %s, found %s.', - $tokens[$expectedScopeCloser]['type'], - $tokens[$tokenArray['scope_closer']]['type'] - ) - ); - - }//end testNotEnumCases() - - - /** - * Data provider. - * - * @see testNotEnumCases() - * - * @return array>> - */ - public static function dataNotEnumCases() - { - return [ - 'switch case with constant, semicolon condition end' => [ - 'testMarker' => '/* testCaseWithSemicolonIsNotEnumCase */', - 'expectedTokens' => [ - 'scope_opener' => T_SEMICOLON, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - ], - 'switch case with constant, colon condition end' => [ - 'testMarker' => '/* testCaseWithConstantIsNotEnumCase */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testCloserMarker' => '/* testCaseConstantCloserMarker */', - ], - 'switch case with constant, comparison' => [ - 'testMarker' => '/* testCaseWithConstantAndIdenticalIsNotEnumCase */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testCloserMarker' => '/* testCaseConstantCloserMarker */', - ], - 'switch case with constant, assignment' => [ - 'testMarker' => '/* testCaseWithAssignmentToConstantIsNotEnumCase */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testCloserMarker' => '/* testCaseConstantCloserMarker */', - ], - 'switch case with constant, keyword in mixed case' => [ - 'testMarker' => '/* testIsNotEnumCaseIsCaseInsensitive */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testCloserMarker' => '/* testCaseConstantCloserMarker */', - ], - 'switch case, body in curlies declares enum' => [ - 'testMarker' => '/* testCaseInSwitchWhenCreatingEnumInSwitch1 */', - 'expectedTokens' => [ - 'scope_opener' => T_OPEN_CURLY_BRACKET, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testCloserMarker' => '/* testCaseInSwitchWhenCreatingEnumInSwitch1CloserMarker */', - ], - 'switch case, body after semicolon declares enum' => [ - 'testMarker' => '/* testCaseInSwitchWhenCreatingEnumInSwitch2 */', - 'expectedTokens' => [ - 'scope_opener' => T_SEMICOLON, - 'scope_closer' => T_BREAK, - ], - 'testCloserMarker' => '/* testCaseInSwitchWhenCreatingEnumInSwitch2CloserMarker */', - ], - 'switch case, shared closer with switch' => [ - 'testMarker' => '/* testSwitchCaseScopeCloserSharedWithSwitch */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_ENDSWITCH, - ], - ], - 'switch case, nested inline if/elseif/else with and without braces' => [ - 'testMarker' => '/* testSwitchCaseNestedIfWithAndWithoutBraces */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_BREAK, - ], - ], - 'switch case, nested inline if' => [ - 'testMarker' => '/* testSwitchCaseNestedInlineIfWithMoreThanThreeLines */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_BREAK, - ], - ], - ]; - - }//end dataNotEnumCases() - - - /** - * Test that a "case" keyword which is not a switch or enum case, does not get the scope indexes. - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * - * @dataProvider dataKeywordAsEnumCaseNameShouldBeString - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testKeywordAsEnumCaseNameShouldBeString($testMarker) - { - $tokens = $this->phpcsFile->getTokens(); - $enumCaseName = $this->getTargetToken($testMarker, [T_STRING, T_INTERFACE, T_TRAIT, T_ENUM, T_FUNCTION, T_FALSE, T_DEFAULT, T_ARRAY]); - $tokenArray = $tokens[$enumCaseName]; - - // Make sure we're looking at the right token. - $this->assertSame(T_STRING, $tokenArray['code'], 'Token tokenized as '.$tokenArray['type'].', not T_STRING (code)'); - - $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); - $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); - $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); - - }//end testKeywordAsEnumCaseNameShouldBeString() - - - /** - * Data provider. - * - * @see testKeywordAsEnumCaseNameShouldBeString() - * - * @return array> - */ - public static function dataKeywordAsEnumCaseNameShouldBeString() - { - return [ - '"interface" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString1 */'], - '"trait" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString2 */'], - '"enum" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString3 */'], - '"function" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString4 */'], - '"false" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString5 */'], - '"default" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString6 */'], - '"array" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString7 */'], - '"exit" as case name' => ['/* testKeywordAsEnumCaseNameShouldBeString8 */'], - ]; - - }//end dataKeywordAsEnumCaseNameShouldBeString() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.inc deleted file mode 100644 index c98f518cb..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.inc +++ /dev/null @@ -1,231 +0,0 @@ - 1, - 2 => 2, - /* testSimpleMatchDefault */ - default => 'default', - }; -} - -function switchWithDefault($i) { - switch ($i) { - case 1: - return 1; - case 2: - return 2; - /* testSimpleSwitchDefault */ - default: - return 'default'; - } -} - -function switchWithDefaultAndCurlies($i) { - switch ($i) { - case 1: - return 1; - case 2: - return 2; - /* testSimpleSwitchDefaultWithCurlies */ - default: /* testSimpleSwitchDefaultWithCurliesScopeOpener */ { - /* testSimpleSwitchDefaultWithCurliesConditionStop */ - return 'default'; - /* testSimpleSwitchDefaultWithCurliesScopeCloser */ - } - } -} - -function matchWithDefaultInSwitch() { - switch ($something) { - case 'foo': - $var = [1, 2, 3]; - $var = match ($i) { - 1 => 1, - /* testMatchDefaultNestedInSwitchCase1 */ - default => 'default', - }; - continue; - - case 'bar' : - $i = callMe($a, $b); - return match ($i) { - 1 => 1, - /* testMatchDefaultNestedInSwitchCase2 */ - default => 'default', - }; - - /* testSwitchDefault */ - default; - echo 'something', match ($i) { - 1, => 1, - /* testMatchDefaultNestedInSwitchDefault */ - default, => 'default', - }; - /* testSwitchDefaultCloserMarker */ - break; - } -} - -function switchWithDefaultInMatch() { - $x = match ($y) { - 5, 8 => function($z) { - switch($z) { - case 'a'; - $var = [1, 2, 3]; - return 'a'; - /* testSwitchDefaultNestedInMatchCase */ - default: - $var = [1, 2, 3]; - return 'default1'; - } - }, - /* testMatchDefault */ - default => function($z) { - switch($z) { - case 'a': - $i = callMe($a, $b); - return 'b'; - /* testSwitchDefaultNestedInMatchDefault */ - default: - $i = callMe($a, $b); - return 'default2'; - } - } - }; -} - -function switchAndDefaultSharingScopeCloser($i) { - switch ($i): - /* testSwitchAndDefaultSharingScopeCloser */ - default: - echo 'one'; - /* testSwitchAndDefaultSharingScopeCloserScopeCloser */ - endswitch; -} - -function switchDefaultNestedIfWithAndWithoutBraces($i, $foo, $baz) { - switch ($i) { - /* testSwitchDefaultNestedIfWithAndWithoutBraces */ - default: - if ($foo) { - return true; - } elseif ($baz) - return true; - else { - echo 'else'; - } - /* testSwitchDefaultNestedIfWithAndWithoutBracesScopeCloser */ - break; - } -} - -function shortArrayWithConstantKey() { - $arr = [ - /* testClassConstantAsShortArrayKey */ - SomeClass::DEFAULT => 1, - /* testClassPropertyAsShortArrayKey */ - SomeClass->DEFAULT => 1, - /* testNamespacedConstantAsShortArrayKey */ - // Intentional parse error PHP < 8.0. Reserved keyword used as namespaced constant. - SomeNamespace\DEFAULT => 1, - /* testFQNGlobalConstantAsShortArrayKey */ - // Intentional parse error in PHP < 8.0. Reserved keyword used as global constant. - \DEFAULT => 1, - ]; -} - -function longArrayWithConstantKey() { - $arr = array( - /* testClassConstantAsLongArrayKey */ - SomeClass::DEFAULT => 1, - ); -} - -function yieldWithConstantKey() { - /* testClassConstantAsYieldKey */ - yield SomeClass::DEFAULT => 1; -} - -function longArrayWithConstantKeyNestedInMatch() { - return match($x) { - /* testMatchDefaultWithNestedLongArrayWithClassConstantKey */ - DEFAULT => array( - /* testClassConstantAsLongArrayKeyNestedInMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultWithNestedLongArrayWithClassConstantKeyLevelDown */ - DEFAULT => array( - /* testClassConstantAsLongArrayKeyNestedInMatchLevelDown */ - SomeClass::DEFAULT => 1, - ), - }, - ), - }; -} - -function shortArrayWithConstantKeyNestedInMatch() { - return match($x) { - /* testMatchDefaultWithNestedShortArrayWithClassConstantKey */ - DEFAULT => [ - /* testClassConstantAsShortArrayKeyNestedInMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultWithNestedShortArrayWithClassConstantKeyLevelDown */ - DEFAULT => [ - /* testClassConstantAsShortArrayKeyNestedInMatchLevelDown */ - SomeClass::DEFAULT => 1, - ], - }, - ], - }; -} - - -function longArrayWithConstantKeyWithNestedMatch() { - return array( - /* testClassConstantAsLongArrayKeyWithNestedMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultNestedInLongArray */ - DEFAULT => 'foo' - }, - ); -} - -function shortArrayWithConstantKeyWithNestedMatch() { - return [ - /* testClassConstantAsShortArrayKeyWithNestedMatch */ - SomeClass::DEFAULT => match($x) { - /* testMatchDefaultNestedInShortArray */ - DEFAULT => 'foo' - }, - ]; -} - -function switchWithConstantNonDefault($i) { - switch ($i) { - /* testClassConstantInSwitchCase */ - case SomeClass::DEFAULT: - return 1; - - /* testClassPropertyInSwitchCase */ - case SomeClass->DEFAULT: - return 2; - - /* testNamespacedConstantInSwitchCase */ - // Intentional parse error PHP < 8.0. Reserved keyword used as constant. - case SomeNamespace\DEFAULT: - return 2; - - /* testNamespaceRelativeConstantInSwitchCase */ - // Intentional parse error PHP < 8.0. Reserved keyword used as global constant. - case namespace\DEFAULT: - return 2; - } -} - -class Foo { - /* testClassConstant */ - const DEFAULT = 'foo'; - - /* testMethodDeclaration */ - public function default() {} -} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.php deleted file mode 100644 index 9b40fe109..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapDefaultKeywordConditionsTest.php +++ /dev/null @@ -1,487 +0,0 @@ - - * @copyright 2020-2021 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class RecurseScopeMapDefaultKeywordConditionsTest extends AbstractTokenizerTestCase -{ - - /** - * Condition stop tokens when `default` is used with curlies. - * - * @var array - */ - protected $conditionStopTokens = [ - T_BREAK, - T_CONTINUE, - T_EXIT, - T_GOTO, - T_RETURN, - T_THROW, - ]; - - - /** - * Test that match "default" tokens does not get scope indexes. - * - * Note: Cases and default structures within a match structure do *NOT* get case/default scope - * conditions, in contrast to case and default structures in switch control structures. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataMatchDefault - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testMatchDefault($testMarker, $testContent='default') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - // Make sure we're looking at the right token. - $this->assertSame( - T_MATCH_DEFAULT, - $tokenArray['code'], - sprintf('Token tokenized as %s, not T_MATCH_DEFAULT (code). Marker: %s.', $tokenArray['type'], $testMarker) - ); - - $this->assertArrayNotHasKey( - 'scope_condition', - $tokenArray, - sprintf('Scope condition is set. Marker: %s.', $testMarker) - ); - $this->assertArrayNotHasKey( - 'scope_opener', - $tokenArray, - sprintf('Scope opener is set. Marker: %s.', $testMarker) - ); - $this->assertArrayNotHasKey( - 'scope_closer', - $tokenArray, - sprintf('Scope closer is set. Marker: %s.', $testMarker) - ); - - }//end testMatchDefault() - - - /** - * Data provider. - * - * @see testMatchDefault() - * - * @return array> - */ - public static function dataMatchDefault() - { - return [ - 'simple_match_default' => [ - 'testMarker' => '/* testSimpleMatchDefault */', - ], - 'match_default_in_switch_case_1' => [ - 'testMarker' => '/* testMatchDefaultNestedInSwitchCase1 */', - ], - 'match_default_in_switch_case_2' => [ - 'testMarker' => '/* testMatchDefaultNestedInSwitchCase2 */', - ], - 'match_default_in_switch_default' => [ - 'testMarker' => '/* testMatchDefaultNestedInSwitchDefault */', - ], - 'match_default_containing_switch' => [ - 'testMarker' => '/* testMatchDefault */', - ], - - 'match_default_with_nested_long_array_and_default_key' => [ - 'testMarker' => '/* testMatchDefaultWithNestedLongArrayWithClassConstantKey */', - 'testContent' => 'DEFAULT', - ], - 'match_default_with_nested_long_array_and_default_key_2' => [ - 'testMarker' => '/* testMatchDefaultWithNestedLongArrayWithClassConstantKeyLevelDown */', - 'testContent' => 'DEFAULT', - ], - 'match_default_with_nested_short_array_and_default_key' => [ - 'testMarker' => '/* testMatchDefaultWithNestedShortArrayWithClassConstantKey */', - 'testContent' => 'DEFAULT', - ], - 'match_default_with_nested_short_array_and_default_key_2' => [ - 'testMarker' => '/* testMatchDefaultWithNestedShortArrayWithClassConstantKeyLevelDown */', - 'testContent' => 'DEFAULT', - ], - 'match_default_in_long_array' => [ - 'testMarker' => '/* testMatchDefaultNestedInLongArray */', - 'testContent' => 'DEFAULT', - ], - 'match_default_in_short_array' => [ - 'testMarker' => '/* testMatchDefaultNestedInShortArray */', - 'testContent' => 'DEFAULT', - ], - ]; - - }//end dataMatchDefault() - - - /** - * Test that switch "default" tokens do get the scope indexes. - * - * Note: Cases and default structures within a switch control structure *do* get case/default scope - * conditions. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $openerMarker The comment prefacing the scope opener token. - * @param string $closerMarker The comment prefacing the scope closer token. - * @param string|null $conditionStopMarker The expected offset in relation to the testMarker, after which tokens stop - * having T_DEFAULT as a scope condition. - * @param string $testContent The token content to look for. - * @param bool $sharedScopeCloser Whether to skip checking for the `scope_condition` of the - * scope closer. Needed when the default and switch - * structures share a scope closer. See - * https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/810. - * - * @dataProvider dataSwitchDefault - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testSwitchDefault($testMarker, $openerMarker, $closerMarker, $conditionStopMarker=null, $testContent='default', $sharedScopeCloser=false) - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - $expectedScopeOpener = $this->getTargetToken($openerMarker, [T_COLON, T_OPEN_CURLY_BRACKET, T_SEMICOLON]); - $expectedScopeCloser = $this->getTargetToken($closerMarker, [T_BREAK, T_CLOSE_CURLY_BRACKET, T_RETURN, T_ENDSWITCH]); - - // Make sure we're looking at the right token. - $this->assertSame( - T_DEFAULT, - $tokenArray['code'], - sprintf('Token tokenized as %s, not T_DEFAULT (code). Marker: %s.', $tokenArray['type'], $testMarker) - ); - - $this->assertArrayHasKey( - 'scope_condition', - $tokenArray, - sprintf('Scope condition is not set. Marker: %s.', $testMarker) - ); - $this->assertArrayHasKey( - 'scope_opener', - $tokenArray, - sprintf('Scope opener is not set. Marker: %s.', $testMarker) - ); - $this->assertArrayHasKey( - 'scope_closer', - $tokenArray, - sprintf('Scope closer is not set. Marker: %s.', $testMarker) - ); - $this->assertSame( - $token, - $tokenArray['scope_condition'], - sprintf('Scope condition is not the T_DEFAULT token. Marker: %s.', $testMarker) - ); - $this->assertSame( - $expectedScopeOpener, - $tokenArray['scope_opener'], - sprintf('Scope opener of the T_DEFAULT token incorrect. Marker: %s.', $testMarker) - ); - $this->assertSame( - $expectedScopeCloser, - $tokenArray['scope_closer'], - sprintf('Scope closer of the T_DEFAULT token incorrect. Marker: %s.', $testMarker) - ); - - $opener = $tokenArray['scope_opener']; - $this->assertArrayHasKey( - 'scope_condition', - $tokens[$opener], - sprintf('Opener scope condition is not set. Marker: %s.', $openerMarker) - ); - $this->assertArrayHasKey( - 'scope_opener', - $tokens[$opener], - sprintf('Opener scope opener is not set. Marker: %s.', $openerMarker) - ); - $this->assertArrayHasKey( - 'scope_closer', - $tokens[$opener], - sprintf('Opener scope closer is not set. Marker: %s.', $openerMarker) - ); - $this->assertSame( - $token, - $tokens[$opener]['scope_condition'], - sprintf('Opener scope condition is not the T_DEFAULT token. Marker: %s.', $openerMarker) - ); - $this->assertSame( - $expectedScopeOpener, - $tokens[$opener]['scope_opener'], - sprintf('T_DEFAULT opener scope opener token incorrect. Marker: %s.', $openerMarker) - ); - $this->assertSame( - $expectedScopeCloser, - $tokens[$opener]['scope_closer'], - sprintf('T_DEFAULT opener scope closer token incorrect. Marker: %s.', $openerMarker) - ); - - $closer = $expectedScopeCloser; - - if ($sharedScopeCloser === false) { - $closer = $tokenArray['scope_closer']; - $this->assertArrayHasKey( - 'scope_condition', - $tokens[$closer], - sprintf('Closer scope condition is not set. Marker: %s.', $closerMarker) - ); - $this->assertArrayHasKey( - 'scope_opener', - $tokens[$closer], - sprintf('Closer scope opener is not set. Marker: %s.', $closerMarker) - ); - $this->assertArrayHasKey( - 'scope_closer', - $tokens[$closer], - sprintf('Closer scope closer is not set. Marker: %s.', $closerMarker) - ); - $this->assertSame( - $token, - $tokens[$closer]['scope_condition'], - sprintf('Closer scope condition is not the T_DEFAULT token. Marker: %s.', $closerMarker) - ); - $this->assertSame( - $expectedScopeOpener, - $tokens[$closer]['scope_opener'], - sprintf('T_DEFAULT closer scope opener token incorrect. Marker: %s.', $closerMarker) - ); - $this->assertSame( - $expectedScopeCloser, - $tokens[$closer]['scope_closer'], - sprintf('T_DEFAULT closer scope closer token incorrect. Marker: %s.', $closerMarker) - ); - }//end if - - if (($opener + 1) !== $closer) { - $end = $closer; - if (isset($conditionStopMarker) === true) { - $end = ( $this->getTargetToken($conditionStopMarker, $this->conditionStopTokens) + 1); - } - - for ($i = ($opener + 1); $i < $end; $i++) { - $this->assertArrayHasKey( - $token, - $tokens[$i]['conditions'], - sprintf('T_DEFAULT condition not added for token belonging to the T_DEFAULT structure. Marker: %s.', $testMarker) - ); - } - }//end if - - }//end testSwitchDefault() - - - /** - * Data provider. - * - * @see testSwitchDefault() - * - * @return array> - */ - public static function dataSwitchDefault() - { - return [ - 'simple_switch_default' => [ - 'testMarker' => '/* testSimpleSwitchDefault */', - 'openerMarker' => '/* testSimpleSwitchDefault */', - 'closerMarker' => '/* testSimpleSwitchDefault */', - ], - 'simple_switch_default_with_curlies' => [ - // For a default structure with curly braces, the scope opener - // will be the open curly and the closer the close curly. - // However, scope conditions will not be set for open to close, - // but only for the open token up to the "break/return/continue" etc. - 'testMarker' => '/* testSimpleSwitchDefaultWithCurlies */', - 'openerMarker' => '/* testSimpleSwitchDefaultWithCurliesScopeOpener */', - 'closerMarker' => '/* testSimpleSwitchDefaultWithCurliesScopeCloser */', - 'conditionStopMarker' => '/* testSimpleSwitchDefaultWithCurliesConditionStop */', - ], - 'switch_default_toplevel' => [ - 'testMarker' => '/* testSwitchDefault */', - 'openerMarker' => '/* testSwitchDefault */', - 'closerMarker' => '/* testSwitchDefaultCloserMarker */', - ], - 'switch_default_nested_in_match_case' => [ - 'testMarker' => '/* testSwitchDefaultNestedInMatchCase */', - 'openerMarker' => '/* testSwitchDefaultNestedInMatchCase */', - 'closerMarker' => '/* testSwitchDefaultNestedInMatchCase */', - ], - 'switch_default_nested_in_match_default' => [ - 'testMarker' => '/* testSwitchDefaultNestedInMatchDefault */', - 'openerMarker' => '/* testSwitchDefaultNestedInMatchDefault */', - 'closerMarker' => '/* testSwitchDefaultNestedInMatchDefault */', - ], - 'switch_and_default_sharing_scope_closer' => [ - 'testMarker' => '/* testSwitchAndDefaultSharingScopeCloser */', - 'openerMarker' => '/* testSwitchAndDefaultSharingScopeCloser */', - 'closerMarker' => '/* testSwitchAndDefaultSharingScopeCloserScopeCloser */', - 'conditionStopMarker' => null, - 'testContent' => 'default', - 'sharedScopeCloser' => true, - ], - 'switch_and_default_with_nested_if_with_and_without_braces' => [ - 'testMarker' => '/* testSwitchDefaultNestedIfWithAndWithoutBraces */', - 'openerMarker' => '/* testSwitchDefaultNestedIfWithAndWithoutBraces */', - 'closerMarker' => '/* testSwitchDefaultNestedIfWithAndWithoutBracesScopeCloser */', - ], - ]; - - }//end dataSwitchDefault() - - - /** - * Test that a "default" keyword which is not a switch or match default, does not get the scope indexes. - * - * @param string $testMarker The comment prefacing the target token. - * @param string $testContent The token content to look for. - * - * @dataProvider dataNotDefaultKeyword - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testNotDefaultKeyword($testMarker, $testContent='DEFAULT') - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken($testMarker, [T_MATCH_DEFAULT, T_DEFAULT, T_STRING], $testContent); - $tokenArray = $tokens[$token]; - - // Make sure we're looking at the right token. - $this->assertSame( - T_STRING, - $tokenArray['code'], - sprintf('Token tokenized as %s, not T_STRING (code). Marker: %s.', $tokenArray['type'], $testMarker) - ); - - $this->assertArrayNotHasKey( - 'scope_condition', - $tokenArray, - sprintf('Scope condition is set. Marker: %s.', $testMarker) - ); - $this->assertArrayNotHasKey( - 'scope_opener', - $tokenArray, - sprintf('Scope opener is set. Marker: %s.', $testMarker) - ); - $this->assertArrayNotHasKey( - 'scope_closer', - $tokenArray, - sprintf('Scope closer is set. Marker: %s.', $testMarker) - ); - - }//end testNotDefaultKeyword() - - - /** - * Data provider. - * - * @see testNotDefaultKeyword() - * - * @return array> - */ - public static function dataNotDefaultKeyword() - { - return [ - 'class-constant-as-short-array-key' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKey */', - ], - 'class-property-as-short-array-key' => [ - 'testMarker' => '/* testClassPropertyAsShortArrayKey */', - ], - 'namespaced-constant-as-short-array-key' => [ - 'testMarker' => '/* testNamespacedConstantAsShortArrayKey */', - ], - 'fqn-global-constant-as-short-array-key' => [ - 'testMarker' => '/* testFQNGlobalConstantAsShortArrayKey */', - ], - 'class-constant-as-long-array-key' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKey */', - ], - 'class-constant-as-yield-key' => [ - 'testMarker' => '/* testClassConstantAsYieldKey */', - ], - - 'class-constant-as-long-array-key-nested-in-match' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKeyNestedInMatch */', - ], - 'class-constant-as-long-array-key-nested-in-match-2' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKeyNestedInMatchLevelDown */', - ], - 'class-constant-as-short-array-key-nested-in-match' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKeyNestedInMatch */', - ], - 'class-constant-as-short-array-key-nested-in-match-2' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKeyNestedInMatchLevelDown */', - ], - 'class-constant-as-long-array-key-with-nested-match' => [ - 'testMarker' => '/* testClassConstantAsLongArrayKeyWithNestedMatch */', - ], - 'class-constant-as-short-array-key-with-nested-match' => [ - 'testMarker' => '/* testClassConstantAsShortArrayKeyWithNestedMatch */', - ], - - 'class-constant-in-switch-case' => [ - 'testMarker' => '/* testClassConstantInSwitchCase */', - ], - 'class-property-in-switch-case' => [ - 'testMarker' => '/* testClassPropertyInSwitchCase */', - ], - 'namespaced-constant-in-switch-case' => [ - 'testMarker' => '/* testNamespacedConstantInSwitchCase */', - ], - 'namespace-relative-constant-in-switch-case' => [ - 'testMarker' => '/* testNamespaceRelativeConstantInSwitchCase */', - ], - - 'class-constant-declaration' => [ - 'testMarker' => '/* testClassConstant */', - ], - 'class-method-declaration' => [ - 'testMarker' => '/* testMethodDeclaration */', - 'testContent' => 'default', - ], - ]; - - }//end dataNotDefaultKeyword() - - - /** - * Test a specific edge case where a scope opener would be incorrectly set. - * - * @link https://github.com/squizlabs/PHP_CodeSniffer/issues/3326 - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testIssue3326() - { - $tokens = $this->phpcsFile->getTokens(); - - $token = $this->getTargetToken('/* testClassConstant */', [T_SEMICOLON]); - $tokenArray = $tokens[$token]; - - $this->assertArrayNotHasKey('scope_condition', $tokenArray, 'Scope condition is set'); - $this->assertArrayNotHasKey('scope_opener', $tokenArray, 'Scope opener is set'); - $this->assertArrayNotHasKey('scope_closer', $tokenArray, 'Scope closer is set'); - - }//end testIssue3326() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapIfKeywordConditionsTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapIfKeywordConditionsTest.inc deleted file mode 100644 index e303c3850..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapIfKeywordConditionsTest.inc +++ /dev/null @@ -1,13 +0,0 @@ - - * @author Rodrigo Primo - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class RecurseScopeMapIfKeywordConditionsTest extends AbstractTokenizerTestCase -{ - - - /** - * Tests setting the scope for T_IF token with nested case statement missing break statement. - * - * @link https://github.com/squizlabs/PHP_CodeSniffer/issues/497#ref-commit-fddc61a - * - * @covers \PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testIfElseWithNestedCaseMissingBreakSharedClosers() - { - - $tokens = $this->phpcsFile->getTokens(); - $ifTestMarker = '/* testIfElseWithNestedCaseMissingBreak */'; - $ifCloserTestMarker = '/* testIfElseWithNestedCaseMissingBreakCloser */'; - $ifTokenIndex = $this->getTargetToken($ifTestMarker, T_IF); - $tokenArray = $tokens[$ifTokenIndex]; - - $expectedScopeCondition = $ifTokenIndex; - $expectedScopeOpener = $this->getTargetToken($ifTestMarker, T_COLON); - $expectedScopeCloser = $this->getTargetToken($ifCloserTestMarker, T_ELSE); - - $this->assertArrayHasKey('scope_condition', $tokenArray, 'Scope condition not set'); - $this->assertSame( - $expectedScopeCondition, - $tokenArray['scope_condition'], - sprintf( - 'Scope condition not set correctly; expected T_IF, found %s', - $tokens[$tokenArray['scope_condition']]['type'] - ) - ); - - $this->assertArrayHasKey('scope_opener', $tokenArray, 'Scope opener not set'); - $this->assertSame( - $expectedScopeOpener, - $tokenArray['scope_opener'], - sprintf( - 'Scope opener not set correctly; expected %s, found %s', - $tokens[$expectedScopeOpener]['type'], - $tokens[$tokenArray['scope_opener']]['type'] - ) - ); - - $this->assertArrayHasKey('scope_closer', $tokenArray, 'Scope closer not set'); - $this->assertSame( - $expectedScopeCloser, - $tokenArray['scope_closer'], - sprintf( - 'Scope closer not set correctly; expected %s, found %s', - $tokens[$expectedScopeCloser]['type'], - $tokens[$tokenArray['scope_closer']]['type'] - ) - ); - - }//end testIfElseWithNestedCaseMissingBreakSharedClosers() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.inc deleted file mode 100644 index 6df910bed..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.inc +++ /dev/null @@ -1,60 +0,0 @@ - $obj->{$foo . $bar})()) /* testSwitchArrowFunctionWithinConditionScopeOpener */ { - case 1: - return 'test'; -/* testSwitchArrowFunctionWithinConditionScopeCloser */ -} - -/* testSwitchArrowFunctionWithReturnTypeWithinCondition */ -switch((fn(): string => $condition ? 'foo' : 'bar')()) /* testSwitchArrowFunctionWithReturnTypeWithinConditionScopeOpener */ : - /* testSwitchArrowFunctionWithReturnTypeWithinConditionEnsureTestWillNotPickUpWrongColon */ - case 1: - return 'test'; -/* testSwitchArrowFunctionWithReturnTypeWithinConditionScopeCloser */ -endswitch; diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.php deleted file mode 100644 index dd6634ace..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapSwitchTokenScopeTest.php +++ /dev/null @@ -1,160 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class RecurseScopeMapSwitchTokenScopeTest extends AbstractTokenizerTestCase -{ - - - /** - * Tests setting the scope for T_SWITCH token (normal and alternative syntax). - * - * @param string $testMarker The comment which prefaces the target token in the test file. - * @param array $expectedTokens The expected token codes for the scope opener/closer. - * @param string|null $testOpenerMarker Optional. The comment which prefaces the scope opener if different - * from the test marker. - * @param string|null $testCloserMarker Optional. The comment which prefaces the scope closer if different - * from the test marker. - * - * @link https://github.com/squizlabs/PHP_CodeSniffer/issues/497#ref-commit-b24b96b - * - * @dataProvider dataSwitchScope - * @covers \PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testSwitchScope($testMarker, $expectedTokens, $testOpenerMarker=null, $testCloserMarker=null) - { - $tokens = $this->phpcsFile->getTokens(); - $switchIndex = $this->getTargetToken($testMarker, [T_SWITCH]); - $tokenArray = $tokens[$switchIndex]; - - $scopeOpenerMarker = $testMarker; - if (isset($testOpenerMarker) === true) { - $scopeOpenerMarker = $testOpenerMarker; - } - - $scopeCloserMarker = $testMarker; - if (isset($testCloserMarker) === true) { - $scopeCloserMarker = $testCloserMarker; - } - - $expectedScopeCondition = $switchIndex; - $expectedScopeOpener = $this->getTargetToken($scopeOpenerMarker, $expectedTokens['scope_opener']); - $expectedScopeCloser = $this->getTargetToken($scopeCloserMarker, $expectedTokens['scope_closer']); - - $this->assertArrayHasKey('scope_condition', $tokenArray, 'Scope condition not set'); - $this->assertSame( - $expectedScopeCondition, - $tokenArray['scope_condition'], - sprintf( - 'Scope condition not set correctly; expected T_SWITCH, found %s', - $tokens[$tokenArray['scope_condition']]['type'] - ) - ); - - $this->assertArrayHasKey('scope_opener', $tokenArray, 'Scope opener not set'); - $this->assertSame( - $expectedScopeOpener, - $tokenArray['scope_opener'], - sprintf( - 'Scope opener not set correctly; expected %s, found %s', - $tokens[$expectedScopeOpener]['type'], - $tokens[$tokenArray['scope_opener']]['type'] - ) - ); - - $this->assertArrayHasKey('scope_closer', $tokenArray, 'Scope closer not set'); - $this->assertSame( - $expectedScopeCloser, - $tokenArray['scope_closer'], - sprintf( - 'Scope closer not set correctly; expected %s, found %s', - $tokens[$expectedScopeCloser]['type'], - $tokens[$tokenArray['scope_closer']]['type'] - ) - ); - - }//end testSwitchScope() - - - /** - * Data provider. - * - * @see testSwitchScope() - * - * @return array|null>> - */ - public static function dataSwitchScope() - { - return [ - 'switch normal syntax' => [ - 'testMarker' => '/* testSwitchNormalSyntax */', - 'expectedTokens' => [ - 'scope_opener' => T_OPEN_CURLY_BRACKET, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testOpenerMarker' => null, - 'testCloserMarker' => '/* testSwitchNormalSyntaxScopeCloser */', - ], - 'switch alternative syntax' => [ - 'testMarker' => '/* testSwitchAlternativeSyntax */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_ENDSWITCH, - ], - 'testOpenerMarker' => null, - 'testCloserMarker' => '/* testSwitchAlternativeSyntaxScopeCloser */', - ], - 'switch with closure in the condition' => [ - 'testMarker' => '/* testSwitchClosureWithinCondition */', - 'expectedTokens' => [ - 'scope_opener' => T_OPEN_CURLY_BRACKET, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testOpenerMarker' => '/* testSwitchClosureWithinConditionScopeOpener */', - 'testCloserMarker' => '/* testSwitchClosureWithinConditionScopeCloser */', - ], - 'switch alternative syntax with closure containing return type in the condition' => [ - 'testMarker' => '/* testSwitchClosureWithReturnTypeWithinCondition */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_ENDSWITCH, - ], - 'testOpenerMarker' => '/* testSwitchClosureWithReturnTypeWithinConditionScopeOpener */', - 'testCloserMarker' => '/* testSwitchClosureWithReturnTypeWithinConditionScopeCloser */', - ], - 'switch with arrow function in the condition' => [ - 'testMarker' => '/* testSwitchArrowFunctionWithinCondition */', - 'expectedTokens' => [ - 'scope_opener' => T_OPEN_CURLY_BRACKET, - 'scope_closer' => T_CLOSE_CURLY_BRACKET, - ], - 'testOpenerMarker' => '/* testSwitchArrowFunctionWithinConditionScopeOpener */', - 'testCloserMarker' => '/* testSwitchArrowFunctionWithinConditionScopeCloser */', - ], - 'switch alternative syntax with arrow function containing return type in the condition' => [ - 'testMarker' => '/* testSwitchArrowFunctionWithReturnTypeWithinCondition */', - 'expectedTokens' => [ - 'scope_opener' => T_COLON, - 'scope_closer' => T_ENDSWITCH, - ], - 'testOpenerMarker' => '/* testSwitchArrowFunctionWithReturnTypeWithinConditionScopeOpener */', - 'testCloserMarker' => '/* testSwitchArrowFunctionWithReturnTypeWithinConditionScopeCloser */', - ], - - ]; - - }//end dataSwitchScope() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapWithNamespaceOperatorTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapWithNamespaceOperatorTest.inc deleted file mode 100644 index 38e5a47d5..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapWithNamespaceOperatorTest.inc +++ /dev/null @@ -1,19 +0,0 @@ - new namespace\Baz; diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapWithNamespaceOperatorTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapWithNamespaceOperatorTest.php deleted file mode 100644 index c6acda727..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/RecurseScopeMapWithNamespaceOperatorTest.php +++ /dev/null @@ -1,98 +0,0 @@ - - * @copyright 2020 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -final class RecurseScopeMapWithNamespaceOperatorTest extends AbstractTokenizerTestCase -{ - - - /** - * Test that the scope opener/closers are set correctly when the namespace keyword is encountered as an operator. - * - * @param string $testMarker The comment which prefaces the target tokens in the test file. - * @param array $tokenTypes The token type to search for. - * @param array $open Optional. The token type for the scope opener. - * @param array $close Optional. The token type for the scope closer. - * - * @dataProvider dataScopeSetting - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::recurseScopeMap - * - * @return void - */ - public function testScopeSetting($testMarker, $tokenTypes, $open=[T_OPEN_CURLY_BRACKET], $close=[T_CLOSE_CURLY_BRACKET]) - { - $tokens = $this->phpcsFile->getTokens(); - - $target = $this->getTargetToken($testMarker, $tokenTypes); - $opener = $this->getTargetToken($testMarker, $open); - $closer = $this->getTargetToken($testMarker, $close); - - $this->assertArrayHasKey('scope_opener', $tokens[$target], 'Scope opener missing'); - $this->assertArrayHasKey('scope_closer', $tokens[$target], 'Scope closer missing'); - $this->assertSame($opener, $tokens[$target]['scope_opener'], 'Scope opener not same'); - $this->assertSame($closer, $tokens[$target]['scope_closer'], 'Scope closer not same'); - - $this->assertArrayHasKey('scope_opener', $tokens[$opener], 'Scope opener missing for open curly'); - $this->assertArrayHasKey('scope_closer', $tokens[$opener], 'Scope closer missing for open curly'); - $this->assertSame($opener, $tokens[$opener]['scope_opener'], 'Scope opener not same for open curly'); - $this->assertSame($closer, $tokens[$opener]['scope_closer'], 'Scope closer not same for open curly'); - - $this->assertArrayHasKey('scope_opener', $tokens[$closer], 'Scope opener missing for close curly'); - $this->assertArrayHasKey('scope_closer', $tokens[$closer], 'Scope closer missing for close curly'); - $this->assertSame($opener, $tokens[$closer]['scope_opener'], 'Scope opener not same for close curly'); - $this->assertSame($closer, $tokens[$closer]['scope_closer'], 'Scope closer not same for close curly'); - - }//end testScopeSetting() - - - /** - * Data provider. - * - * @see testScopeSetting() - * - * @return array>> - */ - public static function dataScopeSetting() - { - return [ - 'class which extends namespace relative name' => [ - 'testMarker' => '/* testClassExtends */', - 'tokenTypes' => [T_CLASS], - ], - 'class which implements namespace relative name' => [ - 'testMarker' => '/* testClassImplements */', - 'tokenTypes' => [T_ANON_CLASS], - ], - 'interface which extend namespace relative name' => [ - 'testMarker' => '/* testInterfaceExtends */', - 'tokenTypes' => [T_INTERFACE], - ], - 'namespace relative name in function return type' => [ - 'testMarker' => '/* testFunctionReturnType */', - 'tokenTypes' => [T_FUNCTION], - ], - 'namespace relative name in closure return type' => [ - 'testMarker' => '/* testClosureReturnType */', - 'tokenTypes' => [T_CLOSURE], - ], - 'namespace relative name in arrow function return type' => [ - 'testMarker' => '/* testArrowFunctionReturnType */', - 'tokenTypes' => [T_FN], - 'open' => [T_FN_ARROW], - 'close' => [T_SEMICOLON], - ], - ]; - - }//end dataScopeSetting() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenMiscTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenMiscTest.php deleted file mode 100644 index f4bd711a6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenMiscTest.php +++ /dev/null @@ -1,124 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use PHP_CodeSniffer\Files\DummyFile; -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHPUnit\Framework\TestCase; - -/** - * Miscellaneous tests for tab replacement. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::replaceTabsInToken - */ -final class ReplaceTabsInTokenMiscTest extends TestCase -{ - - - /** - * Test that when no tab width is set or passed, the tab width will be set to 1. - * - * @return void - */ - public function testTabWidthNotSet() - { - $config = new ConfigDouble(); - $ruleset = new Ruleset($config); - - $content = <<parse(); - - $tokens = $phpcsFile->getTokens(); - $target = $phpcsFile->findNext(T_WHITESPACE, 0); - - // Verify initial state. - $this->assertTrue(is_int($target), 'Target token was not found'); - $this->assertSame(' ', $tokens[$target]['content'], 'Content after initial parsing does not contain tabs'); - $this->assertSame(2, $tokens[$target]['length'], 'Length after initial parsing is not as expected'); - $this->assertArrayNotHasKey('orig_content', $tokens[$target], "Key 'orig_content' found in the initial token array."); - - $phpcsFile->tokenizer->replaceTabsInToken($tokens[$target]); - - // Verify tab replacement. - $this->assertSame(' ', $tokens[$target]['content'], 'Content after tab replacement is not as expected'); - $this->assertSame(2, $tokens[$target]['length'], 'Length after tab replacement is not as expected'); - $this->assertArrayHasKey('orig_content', $tokens[$target], "Key 'orig_content' not found in the token array."); - - }//end testTabWidthNotSet() - - - /** - * Test that the length calculation handles text in non-ascii encodings correctly. - * - * @requires extension iconv - * - * @return void - */ - public function testLengthSettingRespectsEncoding() - { - $config = new ConfigDouble(); - $config->tabWidth = 4; - $ruleset = new Ruleset($config); - - $content = <<parse(); - - $tokens = $phpcsFile->getTokens(); - $target = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, 0); - - $this->assertTrue(is_int($target), 'Target token was not found'); - $this->assertSame("'пасха пасха'", $tokens[$target]['content'], 'Content is not as expected'); - $this->assertSame(17, $tokens[$target]['length'], 'Length is not as expected'); - $this->assertArrayHasKey('orig_content', $tokens[$target], "Key 'orig_content' not found in the token array."); - $this->assertSame("'пасха пасха'", $tokens[$target]['orig_content'], 'Orig_content is not as expected'); - - }//end testLengthSettingRespectsEncoding() - - - /** - * Test that the length calculation falls back to byte length if iconv detects an illegal character. - * - * @requires extension iconv - * - * @return void - */ - public function testLengthSettingFallsBackToBytesWhenTextContainsIllegalChars() - { - $config = new ConfigDouble(); - $config->tabWidth = 4; - $ruleset = new Ruleset($config); - - $content = <<parse(); - - $tokens = $phpcsFile->getTokens(); - $target = $phpcsFile->findNext(T_CONSTANT_ENCAPSED_STRING, 0); - - $this->assertTrue(is_int($target), 'Target token was not found'); - $this->assertSame(11, $tokens[$target]['length'], 'Length is not as expected'); - $this->assertArrayHasKey('orig_content', $tokens[$target], "Key 'orig_content' not found in the token array."); - - }//end testLengthSettingFallsBackToBytesWhenTextContainsIllegalChars() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth1Test.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth1Test.php deleted file mode 100644 index 296215345..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth1Test.php +++ /dev/null @@ -1,111 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -/** - * Tab replacement test using tab width 1. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::replaceTabsInToken - */ -final class ReplaceTabsInTokenTabWidth1Test extends ReplaceTabsInTokenTestCase -{ - - /** - * The tab width setting to use when tokenizing the file. - * - * @var integer - */ - protected $tabWidth = 1; - - - /** - * Data provider helper. - * - * @see ReplaceTabsInTokenTestCase::dataTabReplacement() - * - * @return array> - */ - public static function getTabReplacementExpected() - { - return [ - 'Tab indentation' => [ - 'length' => 2, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Mixed tab/space indentation' => [ - 'length' => 3, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Inline: single tab in text string' => [ - 'length' => 15, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: single tab between each word in text string' => [ - 'length' => 24, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: multiple tabs in heredoc' => [ - 'length' => 15, - 'content' => 'tab separated -', - 'orig_content' => 'tab separated -', - ], - 'Inline: multiple tabs between each word in nowdoc' => [ - 'length' => 27, - 'content' => 'tab between each word -', - 'orig_content' => 'tab between each word -', - ], - 'Inline: mixed spaces/tabs in text string' => [ - 'length' => 20, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: mixed spaces/tabs between each word in text string' => [ - 'length' => 31, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: tab becomes single space in comment (with tabwidth 4)' => [ - 'length' => 50, - 'content' => '// -123 With tabwidth 4, the tab size should be 1. -', - 'orig_content' => '// -123 With tabwidth 4, the tab size should be 1. -', - ], - 'Inline: tab becomes 2 spaces in comment (with tabwidth 4)' => [ - 'length' => 52, - 'content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - 'orig_content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - ], - 'Inline: tab becomes 3 spaces in doc comment string (with tabwidth 4)' => [ - 'length' => 45, - 'content' => '-1 With tabwidth 4, the tab size should be 3.', - 'orig_content' => '-1 With tabwidth 4, the tab size should be 3.', - ], - 'Inline: tab becomes 4 spaces in comment (with tabwidth 4)' => [ - 'length' => 47, - 'content' => '// - With tabwidth 4, the tab size should be 4. -', - 'orig_content' => '// - With tabwidth 4, the tab size should be 4. -', - ], - ]; - - }//end getTabReplacementExpected() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth2Test.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth2Test.php deleted file mode 100644 index 92de221d8..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth2Test.php +++ /dev/null @@ -1,111 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -/** - * Tab replacement test using tab width 2. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::replaceTabsInToken - */ -final class ReplaceTabsInTokenTabWidth2Test extends ReplaceTabsInTokenTestCase -{ - - /** - * The tab width setting to use when tokenizing the file. - * - * @var integer - */ - protected $tabWidth = 2; - - - /** - * Data provider helper. - * - * @see ReplaceTabsInTokenTestCase::dataTabReplacement() - * - * @return array> - */ - public static function getTabReplacementExpected() - { - return [ - 'Tab indentation' => [ - 'length' => 4, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Mixed tab/space indentation' => [ - 'length' => 4, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Inline: single tab in text string' => [ - 'length' => 15, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: single tab between each word in text string' => [ - 'length' => 26, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: multiple tabs in heredoc' => [ - 'length' => 17, - 'content' => 'tab separated -', - 'orig_content' => 'tab separated -', - ], - 'Inline: multiple tabs between each word in nowdoc' => [ - 'length' => 34, - 'content' => 'tab between each word -', - 'orig_content' => 'tab between each word -', - ], - 'Inline: mixed spaces/tabs in text string' => [ - 'length' => 23, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: mixed spaces/tabs between each word in text string' => [ - 'length' => 32, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: tab becomes single space in comment (with tabwidth 4)' => [ - 'length' => 50, - 'content' => '// -123 With tabwidth 4, the tab size should be 1. -', - 'orig_content' => '// -123 With tabwidth 4, the tab size should be 1. -', - ], - 'Inline: tab becomes 2 spaces in comment (with tabwidth 4)' => [ - 'length' => 53, - 'content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - 'orig_content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - ], - 'Inline: tab becomes 3 spaces in doc comment string (with tabwidth 4)' => [ - 'length' => 45, - 'content' => '-1 With tabwidth 4, the tab size should be 3.', - 'orig_content' => '-1 With tabwidth 4, the tab size should be 3.', - ], - 'Inline: tab becomes 4 spaces in comment (with tabwidth 4)' => [ - 'length' => 48, - 'content' => '// - With tabwidth 4, the tab size should be 4. -', - 'orig_content' => '// - With tabwidth 4, the tab size should be 4. -', - ], - ]; - - }//end getTabReplacementExpected() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth4Test.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth4Test.php deleted file mode 100644 index 5f7418798..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth4Test.php +++ /dev/null @@ -1,111 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -/** - * Tab replacement test using tab width 4. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::replaceTabsInToken - */ -final class ReplaceTabsInTokenTabWidth4Test extends ReplaceTabsInTokenTestCase -{ - - /** - * The tab width setting to use when tokenizing the file. - * - * @var integer - */ - protected $tabWidth = 4; - - - /** - * Data provider helper. - * - * @see ReplaceTabsInTokenTestCase::dataTabReplacement() - * - * @return array> - */ - public static function getTabReplacementExpected() - { - return [ - 'Tab indentation' => [ - 'length' => 8, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Mixed tab/space indentation' => [ - 'length' => 6, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Inline: single tab in text string' => [ - 'length' => 17, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: single tab between each word in text string' => [ - 'length' => 32, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: multiple tabs in heredoc' => [ - 'length' => 21, - 'content' => 'tab separated -', - 'orig_content' => 'tab separated -', - ], - 'Inline: multiple tabs between each word in nowdoc' => [ - 'length' => 48, - 'content' => 'tab between each word -', - 'orig_content' => 'tab between each word -', - ], - 'Inline: mixed spaces/tabs in text string' => [ - 'length' => 25, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: mixed spaces/tabs between each word in text string' => [ - 'length' => 36, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: tab becomes single space in comment (with tabwidth 4)' => [ - 'length' => 50, - 'content' => '// -123 With tabwidth 4, the tab size should be 1. -', - 'orig_content' => '// -123 With tabwidth 4, the tab size should be 1. -', - ], - 'Inline: tab becomes 2 spaces in comment (with tabwidth 4)' => [ - 'length' => 53, - 'content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - 'orig_content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - ], - 'Inline: tab becomes 3 spaces in doc comment string (with tabwidth 4)' => [ - 'length' => 47, - 'content' => '-1 With tabwidth 4, the tab size should be 3.', - 'orig_content' => '-1 With tabwidth 4, the tab size should be 3.', - ], - 'Inline: tab becomes 4 spaces in comment (with tabwidth 4)' => [ - 'length' => 50, - 'content' => '// - With tabwidth 4, the tab size should be 4. -', - 'orig_content' => '// - With tabwidth 4, the tab size should be 4. -', - ], - ]; - - }//end getTabReplacementExpected() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth5Test.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth5Test.php deleted file mode 100644 index 361894fb9..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTabWidth5Test.php +++ /dev/null @@ -1,111 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -/** - * Tab replacement test using tab width 5. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::replaceTabsInToken - */ -final class ReplaceTabsInTokenTabWidth5Test extends ReplaceTabsInTokenTestCase -{ - - /** - * The tab width setting to use when tokenizing the file. - * - * @var integer - */ - protected $tabWidth = 5; - - - /** - * Data provider helper. - * - * @see ReplaceTabsInTokenTestCase::dataTabReplacement() - * - * @return array> - */ - public static function getTabReplacementExpected() - { - return [ - 'Tab indentation' => [ - 'length' => 10, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Mixed tab/space indentation' => [ - 'length' => 7, - 'content' => ' ', - 'orig_content' => ' ', - ], - 'Inline: single tab in text string' => [ - 'length' => 15, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: single tab between each word in text string' => [ - 'length' => 25, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: multiple tabs in heredoc' => [ - 'length' => 24, - 'content' => 'tab separated -', - 'orig_content' => 'tab separated -', - ], - 'Inline: multiple tabs between each word in nowdoc' => [ - 'length' => 54, - 'content' => 'tab between each word -', - 'orig_content' => 'tab between each word -', - ], - 'Inline: mixed spaces/tabs in text string' => [ - 'length' => 30, - 'content' => "'tab separated'", - 'orig_content' => "'tab separated'", - ], - 'Inline: mixed spaces/tabs between each word in text string' => [ - 'length' => 35, - 'content' => '"tab $between each word"', - 'orig_content' => '"tab $between each word"', - ], - 'Inline: tab becomes single space in comment (with tabwidth 4)' => [ - 'length' => 52, - 'content' => '// -123 With tabwidth 4, the tab size should be 1. -', - 'orig_content' => '// -123 With tabwidth 4, the tab size should be 1. -', - ], - 'Inline: tab becomes 2 spaces in comment (with tabwidth 4)' => [ - 'length' => 55, - 'content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - 'orig_content' => '/* -12 With tabwidth 4, the tab size should be 2. */', - ], - 'Inline: tab becomes 3 spaces in doc comment string (with tabwidth 4)' => [ - 'length' => 49, - 'content' => '-1 With tabwidth 4, the tab size should be 3.', - 'orig_content' => '-1 With tabwidth 4, the tab size should be 3.', - ], - 'Inline: tab becomes 4 spaces in comment (with tabwidth 4)' => [ - 'length' => 47, - 'content' => '// - With tabwidth 4, the tab size should be 4. -', - 'orig_content' => '// - With tabwidth 4, the tab size should be 4. -', - ], - ]; - - }//end getTabReplacementExpected() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTest.inc b/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTest.inc deleted file mode 100644 index e6046500e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Tokenizers/Tokenizer/ReplaceTabsInTokenTest.inc +++ /dev/null @@ -1,46 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Tokenizers\Tokenizer; - -use Exception; -use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase; - -/** - * Tab replacement test case. - * - * @covers PHP_CodeSniffer\Tokenizers\Tokenizer::replaceTabsInToken - */ -abstract class ReplaceTabsInTokenTestCase extends AbstractTokenizerTestCase -{ - - /** - * The name of the test case file used by this test. - * - * @var string - */ - private static $caseFileName; - - - /** - * Make a copy the test case file we want to use for this test (as the file will be used by multiple tests). - * - * @beforeClass - * - * @return void - * - * @throws \Exception In case the base test case file would not be available. - */ - public static function copyCaseFile() - { - $relativeCN = str_replace(__NAMESPACE__.'\\', '', get_called_class()); - self::$caseFileName = __DIR__.DIRECTORY_SEPARATOR.$relativeCN.'.inc'; - - $baseFileName = realpath(__DIR__.'/ReplaceTabsInTokenTest.inc'); - if (is_string($baseFileName) === false) { - throw new Exception('Base test case file "ReplaceTabsInTokenTest.inc" not found'); - } - - if (copy($baseFileName, self::$caseFileName) === false) { - throw new Exception(sprintf('Failed to copy test case file "ReplaceTabsInTokenTest.inc" to %s', self::$caseFileName)); - } - - }//end copyCaseFile() - - - /** - * Delete the copied test case file after use. - * - * @afterClass - * - * @return void - */ - public static function deleteCaseFile() - { - @unlink(self::$caseFileName); - - }//end deleteCaseFile() - - - /** - * Verify that if a token not containing tabs would be passed to the replaceTabsInToken() method, - * yes, the `orig_content` key is added, but no changes are made to the token `content` or `length` values. - * - * @param string $testMarker The comment prefacing the target token. - * @param int|string $testTarget Token code to look for. - * @param array $expected Expectations for the token array. - * @param int $offset Optional. Offset from the target token to get to the _real_ target. - * This is specifically needed to target indentation whitespace. - * - * @dataProvider dataNoReplacementsAreMadeWhenNoTabsAreFound - * - * @return void - */ - public function testNoReplacementsAreMadeWhenNoTabsAreFound($testMarker, $testTarget, $expected, $offset=0) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, $testTarget); - $target += $offset; - - foreach ($expected as $key => $value) { - if ($key === 'orig_content' && $value === null) { - $this->assertArrayNotHasKey($key, $tokens[$target], "Unexpected 'orig_content' key found in the token array."); - continue; - } - - $this->assertArrayHasKey($key, $tokens[$target], "Key $key not found in the token array."); - $this->assertSame($value, $tokens[$target][$key], "Value for key $key does not match expectation."); - } - - }//end testNoReplacementsAreMadeWhenNoTabsAreFound() - - - /** - * Data provider. - * - * @see testNoReplacementsAreMadeWhenNoTabsAreFound() - * - * @return array>> - */ - public static function dataNoReplacementsAreMadeWhenNoTabsAreFound() - { - return [ - 'Indentation whitespace, only spaces' => [ - 'testMarker' => '/* testNoReplacementNeeded */', - 'testTarget' => T_WHITESPACE, - 'expected' => [ - 'length' => 4, - 'content' => ' ', - 'orig_content' => null, - ], - 'offset' => 1, - ], - 'Trailing comment not containing any tabs' => [ - 'testMarker' => '/* testNoReplacementNeeded */', - 'testTarget' => T_COMMENT, - 'expected' => [ - 'length' => 35, - 'content' => '// Comment not containing any tabs. -', - 'orig_content' => null, - ], - ], - ]; - - }//end dataNoReplacementsAreMadeWhenNoTabsAreFound() - - - /** - * Test tab replacement in tokens. - * - * @param string $testMarker The comment prefacing the target token. - * @param int|string $testTarget Token code to look for. - * @param array $expected Expectations for the token array. - * @param int $offset Optional. Offset from the target token to get to the _real_ target. - * This is specifically needed to target indentation whitespace. - * - * @dataProvider dataTabReplacement - * - * @return void - */ - public function testTabReplacement($testMarker, $testTarget, $expected, $offset=0) - { - $tokens = $this->phpcsFile->getTokens(); - $target = $this->getTargetToken($testMarker, $testTarget); - $target += $offset; - - foreach ($expected as $key => $value) { - if ($key === 'orig_content' && $value === null) { - $this->assertArrayNotHasKey($key, $tokens[$target], "Unexpected 'orig_content' key found in the token array."); - continue; - } - - $this->assertArrayHasKey($key, $tokens[$target], "Key $key not found in the token array."); - $this->assertSame($value, $tokens[$target][$key], "Value for key $key does not match expectation."); - } - - }//end testTabReplacement() - - - /** - * Data provider. - * - * @see testTabReplacement() - * - * @return array>> - * - * @throws \Exception When the getTabReplacementExpected() method doesn't provide data in the correct format. - */ - public static function dataTabReplacement() - { - $data = [ - 'Tab indentation' => [ - 'testMarker' => '/* testTabIndentation */', - 'testTarget' => T_WHITESPACE, - ], - 'Mixed tab/space indentation' => [ - 'testMarker' => '/* testMixedIndentation */', - 'testTarget' => T_WHITESPACE, - ], - 'Inline: single tab in text string' => [ - 'testMarker' => '/* testInlineSingleTab */', - 'testTarget' => T_CONSTANT_ENCAPSED_STRING, - ], - 'Inline: single tab between each word in text string' => [ - 'testMarker' => '/* testInlineSingleTabBetweenEachWord */', - 'testTarget' => T_DOUBLE_QUOTED_STRING, - ], - 'Inline: multiple tabs in heredoc' => [ - 'testMarker' => '/* testInlineMultiTab */', - 'testTarget' => T_HEREDOC, - ], - 'Inline: multiple tabs between each word in nowdoc' => [ - 'testMarker' => '/* testInlineMultipleTabsBetweenEachWord */', - 'testTarget' => T_NOWDOC, - ], - 'Inline: mixed spaces/tabs in text string' => [ - 'testMarker' => '/* testInlineMixedSpacesTabs */', - 'testTarget' => T_CONSTANT_ENCAPSED_STRING, - ], - 'Inline: mixed spaces/tabs between each word in text string' => [ - 'testMarker' => '/* testInlineMixedSpacesTabsBetweenEachWord */', - 'testTarget' => T_DOUBLE_QUOTED_STRING, - ], - 'Inline: tab becomes single space in comment (with tabwidth 4)' => [ - 'testMarker' => '/* testInlineSize1 */', - 'testTarget' => T_COMMENT, - ], - 'Inline: tab becomes 2 spaces in comment (with tabwidth 4)' => [ - 'testMarker' => '/* testInlineSize2 */', - 'testTarget' => T_COMMENT, - ], - 'Inline: tab becomes 3 spaces in doc comment string (with tabwidth 4)' => [ - 'testMarker' => '/* testInlineSize3 */', - 'testTarget' => T_DOC_COMMENT_STRING, - ], - 'Inline: tab becomes 4 spaces in comment (with tabwidth 4)' => [ - 'testMarker' => '/* testInlineSize4 */', - 'testTarget' => T_COMMENT, - ], - ]; - - $expectations = static::getTabReplacementExpected(); - - foreach ($data as $key => $value) { - if (isset($expectations[$key]) === false || is_array($expectations[$key]) === false) { - throw new Exception( - sprintf('Invalid getTabReplacementExpected() method. Missing expectation array for the "%s" test case', $key) - ); - } - - if (isset($expectations[$key]['length'], $expectations[$key]['content']) === false - || array_key_exists('orig_content', $expectations[$key]) === false - ) { - throw new Exception( - sprintf('Invalid expectation array for the "%s" test case. The array must contain the "length", "content" and "orig_content" keys', $key) - ); - } - - $data[$key]['expected'] = $expectations[$key]; - } - - // Set offset for test cases targetting whitespace. - $data['Tab indentation']['offset'] = 1; - $data['Mixed tab/space indentation']['offset'] = 1; - - return $data; - - }//end dataTabReplacement() - - - /** - * Data provider helper. - * - * Should be declared in child classes to set the expectations for the token array. - * - * @see dataTabReplacement() - * - * @return array> - */ - abstract public static function getTabReplacementExpected(); - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/EscapeshellcmdTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/EscapeshellcmdTest.php deleted file mode 100644 index 2844c4a32..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/EscapeshellcmdTest.php +++ /dev/null @@ -1,91 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Common; - -use PHP_CodeSniffer\Util\Common; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Common::escapeshellcmd() method. - * - * @covers \PHP_CodeSniffer\Util\Common::escapeshellcmd - * @group Windows - */ -final class EscapeshellcmdTest extends TestCase -{ - - - /** - * Test escaping shell commands. - * - * @param string $command The command provided. - * @param string $expected Expected function output. - * @param string $expectedWin Optional. Expected function output on Windows. - * Only needs to be passed if the output on Windows would be different. - * - * @dataProvider dataEscapeshellcmd - * - * @return void - */ - public function testEscapeshellcmd($command, $expected, $expectedWin=null) - { - if (stripos(PHP_OS, 'WIN') === 0 && empty($expectedWin) === false) { - $expected = $expectedWin; - } - - $this->assertSame($expected, Common::escapeshellcmd($command)); - - }//end testEscapeshellcmd() - - - /** - * Data provider. - * - * Note: we're only testing the PHPCS functionality, not the PHP native `escapeshellcmd()` - * function (as that's not our responsibility). - * - * @see testEscapeshellcmd() - * - * @return array> - */ - public static function dataEscapeshellcmd() - { - return [ - 'Command is empty string' => [ - 'command' => '', - 'expected' => '', - ], - 'Command is simple string' => [ - 'command' => 'csslint', - 'expected' => 'csslint', - ], - 'Command containing characters which PHP escapes' => [ - 'command' => '&#;`|*?~<>^()[]{}$\,%!', - 'expected' => '\&\#\;\`\|\*\?\~\<\>\^\(\)\[\]\{\}\$\\\\,%!', - 'expectedWin' => '^&^#^;^`^|^*^?^~^<^>^^^(^)^[^]^{^}^$^\,^%^!', - ], - // @link https://github.com/squizlabs/PHP_CodeSniffer/pull/3214 - 'Command containing spaces, which can cause problems on Windows' => [ - 'command' => 'C:\Program Files\nodejs\csslint.cmd', - 'expected' => 'C:\\\\Program Files\\\\nodejs\\\\csslint.cmd', - 'expectedWin' => 'C:^\Program^ Files^\nodejs^\csslint.cmd', - ], - // @link https://github.com/php/doc-en/pull/511 - 'Command containing spaces with additional arguments' => [ - 'command' => 'php -f ./~home/path to/file.php', - 'expected' => 'php -f ./\~home/path to/file.php', - 'expectedWin' => 'php^ -f^ ./^~home/path^ to/file.php', - ], - ]; - - }//end dataEscapeshellcmd() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/GetSniffCodeTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/GetSniffCodeTest.php deleted file mode 100644 index 444ea5eb0..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/GetSniffCodeTest.php +++ /dev/null @@ -1,212 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Common; - -use PHP_CodeSniffer\Util\Common; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Common::getSniffCode() method. - * - * @covers \PHP_CodeSniffer\Util\Common::getSniffCode - */ -final class GetSniffCodeTest extends TestCase -{ - - - /** - * Test receiving an expected exception when the $sniffClass parameter is not passed a string value or is passed an empty string. - * - * @param mixed $input NOT a fully qualified sniff class name. - * - * @dataProvider dataGetSniffCodeThrowsExceptionOnInvalidInput - * - * @return void - */ - public function testGetSniffCodeThrowsExceptionOnInvalidInput($input) - { - $exception = 'InvalidArgumentException'; - $message = 'The $sniffClass parameter must be a non-empty string'; - - if (method_exists($this, 'expectException') === true) { - // PHPUnit 5+. - $this->expectException($exception); - $this->expectExceptionMessage($message); - } else { - // PHPUnit 4. - $this->setExpectedException($exception, $message); - } - - Common::getSniffCode($input); - - }//end testGetSniffCodeThrowsExceptionOnInvalidInput() - - - /** - * Data provider. - * - * @see testGetSniffCodeThrowsExceptionOnInvalidInput() - * - * @return array> - */ - public static function dataGetSniffCodeThrowsExceptionOnInvalidInput() - { - return [ - 'Class name is not a string' => [true], - 'Class name is empty' => [''], - ]; - - }//end dataGetSniffCodeThrowsExceptionOnInvalidInput() - - - /** - * Test receiving an expected exception when the $sniffClass parameter is not passed a value which - * could be a fully qualified sniff(test) class name. - * - * @param string $input String input which can not be a fully qualified sniff(test) class name. - * - * @dataProvider dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass - * - * @return void - */ - public function testGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass($input) - { - $exception = 'InvalidArgumentException'; - $message = 'The $sniffClass parameter was not passed a fully qualified sniff(test) class name. Received:'; - - if (method_exists($this, 'expectException') === true) { - // PHPUnit 5+. - $this->expectException($exception); - $this->expectExceptionMessage($message); - } else { - // PHPUnit 4. - $this->setExpectedException($exception, $message); - } - - Common::getSniffCode($input); - - }//end testGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass() - - - /** - * Data provider. - * - * @see testGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass() - * - * @return array> - */ - public static function dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass() - { - return [ - 'Unqualified class name' => ['ClassName'], - 'Fully qualified class name, not enough parts' => ['Fully\\Qualified\\ClassName'], - 'Fully qualified class name, doesn\'t end on Sniff or UnitTest' => ['Fully\\Sniffs\\Qualified\\ClassName'], - ]; - - }//end dataGetSniffCodeThrowsExceptionOnInputWhichIsNotASniffTestClass() - - - /** - * Test transforming a sniff class name to a sniff code. - * - * @param string $fqnClass A fully qualified sniff class name. - * @param string $expected Expected function output. - * - * @dataProvider dataGetSniffCode - * - * @return void - */ - public function testGetSniffCode($fqnClass, $expected) - { - $this->assertSame($expected, Common::getSniffCode($fqnClass)); - - }//end testGetSniffCode() - - - /** - * Data provider. - * - * @see testGetSniffCode() - * - * @return array> - */ - public static function dataGetSniffCode() - { - return [ - 'PHPCS native sniff' => [ - 'fqnClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Sniffs\\Arrays\\ArrayIndentSniff', - 'expected' => 'Generic.Arrays.ArrayIndent', - ], - 'Class is a PHPCS native test class' => [ - 'fqnClass' => 'PHP_CodeSniffer\\Standards\\Generic\\Tests\\Arrays\\ArrayIndentUnitTest', - 'expected' => 'Generic.Arrays.ArrayIndent', - ], - 'Sniff in external standard without namespace prefix' => [ - 'fqnClass' => 'MyStandard\\Sniffs\\PHP\\MyNameSniff', - 'expected' => 'MyStandard.PHP.MyName', - ], - 'Test in external standard without namespace prefix' => [ - 'fqnClass' => 'MyStandard\\Tests\\PHP\\MyNameUnitTest', - 'expected' => 'MyStandard.PHP.MyName', - ], - 'Sniff in external standard with namespace prefix' => [ - 'fqnClass' => 'Vendor\\Package\\MyStandard\\Sniffs\\Category\\AnalyzeMeSniff', - 'expected' => 'MyStandard.Category.AnalyzeMe', - ], - 'Test in external standard with namespace prefix' => [ - 'fqnClass' => 'Vendor\\Package\\MyStandard\\Tests\\Category\\AnalyzeMeUnitTest', - 'expected' => 'MyStandard.Category.AnalyzeMe', - ], - - /* - * These are not valid sniff codes and is an undesirable result, but can't be helped - * as changing this would be a BC-break. - * Supporting these to allow for tags directly including sniff files. - * See: https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/675 - */ - - 'Fully qualified class name, ends on Sniff, but isn\'t' => [ - 'fqnClass' => 'Fully\\Sniffs\\AbstractSomethingSniff', - 'expected' => '.Sniffs.AbstractSomething', - ], - 'Sniff provided via file include and doesn\'t comply with naming conventions [1]' => [ - 'fqnClass' => 'CheckMeSniff', - 'expected' => '..CheckMe', - ], - 'Sniff provided via file include and doesn\'t comply with naming conventions [2]' => [ - 'fqnClass' => 'CompanyName\\CheckMeSniff', - 'expected' => '.CompanyName.CheckMe', - ], - 'Sniff provided via file include and doesn\'t comply with naming conventions [3]' => [ - 'fqnClass' => 'CompanyName\\Sniffs\\CheckMeSniff', - 'expected' => '.Sniffs.CheckMe', - ], - 'Sniff provided via file include and doesn\'t comply with naming conventions [4]' => [ - 'fqnClass' => 'CompanyName\\CustomSniffs\\Whatever\\CheckMeSniff', - 'expected' => 'CompanyName.Whatever.CheckMe', - ], - 'Sniff provided via file include and doesn\'t comply with naming conventions [5]' => [ - 'fqnClass' => 'CompanyName\\Sniffs\\Category\\Sniff', - 'expected' => 'CompanyName.Category.', - ], - 'Sniff provided via file include and doesn\'t comply with naming conventions [6]' => [ - 'fqnClass' => 'CompanyName\\Tests\\Category\\UnitTest', - 'expected' => 'CompanyName.Category.', - ], - 'Sniff provided via file include and doesn\'t comply with naming conventions [7]' => [ - 'fqnClass' => 'Sniffs\\Category\\NamedSniff', - 'expected' => '.Category.Named', - ], - ]; - - }//end dataGetSniffCode() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/IsCamelCapsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/IsCamelCapsTest.php deleted file mode 100644 index 609334aa6..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/IsCamelCapsTest.php +++ /dev/null @@ -1,512 +0,0 @@ - - * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Common; - -use PHP_CodeSniffer\Util\Common; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Common::isCamelCaps method. - * - * @covers \PHP_CodeSniffer\Util\Common::isCamelCaps - */ -final class IsCamelCapsTest extends TestCase -{ - - - /** - * Test valid public function/method names. - * - * @param string $name The tested name. - * @param bool $strict Value of the $strict flag. - * - * @dataProvider dataValidNotClassFormatPublic - * - * @return void - */ - public function testValidNotClassFormatPublic($name, $strict) - { - $this->assertTrue(Common::isCamelCaps($name, false, true, $strict)); - - }//end testValidNotClassFormatPublic() - - - /** - * Data provider. - * - * @see testValidNotClassFormatPublic() - * - * @return array> - */ - public static function dataValidNotClassFormatPublic() - { - return [ - 'lower camelCase string in strict mode' => [ - 'name' => 'thisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with acronym in relaxed mode' => [ - 'name' => 'thisISCamelCaps', - 'strict' => false, - ], - 'lower camelCase string with initial acronym' => [ - 'name' => 'ISThisCamelCaps', - 'strict' => false, - ], - ]; - - }//end dataValidNotClassFormatPublic() - - - /** - * Test invalid public function/method names. - * - * @param string $name The tested name. - * - * @dataProvider dataInvalidNotClassFormatPublic - * - * @return void - */ - public function testInvalidNotClassFormatPublic($name) - { - $this->assertFalse(Common::isCamelCaps($name, false, true, true)); - - }//end testInvalidNotClassFormatPublic() - - - /** - * Data provider. - * - * @see testInvalidNotClassFormatPublic() - * - * @return array> - */ - public static function dataInvalidNotClassFormatPublic() - { - return [ - 'string with initial underscore (invalid when $public is true)' => [ - 'name' => '_thisIsCamelCaps', - ], - 'lower camelCase string with acronym (invalid when $strict is true)' => [ - 'name' => 'thisISCamelCaps', - ], - 'lower camelCase string with initial acronym (invalid when $strict is true)' => [ - 'name' => 'ISThisCamelCaps', - ], - 'PascalCase string' => [ - 'name' => 'ThisIsCamelCaps', - ], - 'lower camelCase string with initial digit' => [ - 'name' => '3thisIsCamelCaps', - ], - 'lower camelCase string with initial illegal character: *' => [ - 'name' => '*thisIsCamelCaps', - ], - 'lower camelCase string with initial illegal character: -' => [ - 'name' => '-thisIsCamelCaps', - ], - 'lower camelCase string with initial illegal character: é' => [ - 'name' => 'éCamelCaps', - ], - 'lower camelCase string with medial illegal character: *' => [ - 'name' => 'this*IsCamelCaps', - ], - 'lower camelCase string with medial illegal character: -' => [ - 'name' => 'this-IsCamelCaps', - ], - 'lower camelCase string with medial illegal character: é' => [ - // No camels were harmed in the cspell:disable-next-line. - 'name' => 'thisIsCamélCaps', - ], - 'lower camelCase string with single medial underscore' => [ - 'name' => 'this_IsCamelCaps', - ], - 'snake_case string' => [ - 'name' => 'this_is_camel_caps', - ], - 'empty string' => [ - 'name' => '', - ], - ]; - - }//end dataInvalidNotClassFormatPublic() - - - /** - * Test valid private method names. - * - * @param string $name The tested name. - * @param bool $strict Value of the $strict flag. - * - * @dataProvider dataValidNotClassFormatPrivate - * - * @return void - */ - public function testValidNotClassFormatPrivate($name, $strict) - { - $this->assertTrue(Common::isCamelCaps($name, false, false, $strict)); - - }//end testValidNotClassFormatPrivate() - - - /** - * Data provider. - * - * @see testValidNotClassFormatPrivate() - * - * @return array> - */ - public static function dataValidNotClassFormatPrivate() - { - return [ - 'lower camelCase string with initial underscore' => [ - 'name' => '_thisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with acronym and initial underscore' => [ - 'name' => '_thisISCamelCaps', - 'strict' => false, - ], - 'lower camelCase string with acronym after initial underscore' => [ - 'name' => '_ISThisCamelCaps', - 'strict' => false, - ], - 'numeronym with initial underscore and capital after digit' => [ - 'name' => '_i18N', - 'strict' => true, - ], - 'numeronym with initial underscore and lowercase character after digit' => [ - 'name' => '_i18n', - 'strict' => true, - ], - ]; - - }//end dataValidNotClassFormatPrivate() - - - /** - * Test invalid private method names. - * - * @param string $name The tested name. - * @param bool $strict Value of the $strict flag. - * - * @dataProvider dataInvalidNotClassFormatPrivate - * - * @return void - */ - public function testInvalidNotClassFormatPrivate($name, $strict) - { - $this->assertFalse(Common::isCamelCaps($name, false, false, $strict)); - - }//end testInvalidNotClassFormatPrivate() - - - /** - * Data provider. - * - * @see testInvalidNotClassFormatPrivate() - * - * @return array> - */ - public static function dataInvalidNotClassFormatPrivate() - { - return [ - 'lower camelCase string without initial underscore' => [ - 'name' => 'thisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with initial underscore, but with an acronym, in strict mode' => [ - 'name' => '_thisISCamelCaps', - 'strict' => true, - ], - 'PascalCase string with initial underscore' => [ - 'name' => '_ThisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with two initial underscores' => [ - 'name' => '__thisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with two initial underscores and acronym in relaxed mode' => [ - 'name' => '__thisISCamelCaps', - 'strict' => false, - ], - 'lower camelCase string with initial digit' => [ - 'name' => '3thisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with initial illegal character: *' => [ - 'name' => '*thisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with initial illegal character: -' => [ - 'name' => '-thisIsCamelCaps', - 'strict' => true, - ], - 'lower camelCase string with initial illegal character: é' => [ - 'name' => 'éCamelCaps', - 'strict' => true, - ], - 'snake_case string with initial underscore' => [ - 'name' => '_this_is_camel_caps', - 'strict' => true, - ], - 'single underscore' => [ - 'name' => '_', - 'strict' => true, - ], - 'empty string' => [ - 'name' => '', - 'strict' => true, - ], - ]; - - }//end dataInvalidNotClassFormatPrivate() - - - /** - * Test valid class names. - * - * @param string $name The tested name. - * @param bool $strict Value of the $strict flag. - * - * @dataProvider dataValidClassFormatPublic - * - * @return void - */ - public function testValidClassFormatPublic($name, $strict) - { - $this->assertTrue(Common::isCamelCaps($name, true, true, $strict)); - - }//end testValidClassFormatPublic() - - - /** - * Data provider. - * - * @see testValidClassFormatPublic() - * - * @return array> - */ - public static function dataValidClassFormatPublic() - { - return [ - 'PascalCase string' => [ - 'name' => 'ThisIsCamelCaps', - 'strict' => true, - ], - 'PascalCase string with acronym' => [ - 'name' => 'ThisISCamelCaps', - 'strict' => false, - ], - 'PascalCase string with digit between words' => [ - 'name' => 'This3IsCamelCaps', - 'strict' => false, - ], - 'PascalCase string with digit inside word' => [ - 'name' => 'Th1sIsCamelCaps', - 'strict' => false, - ], - 'Single capital (strict)' => [ - 'name' => 'A', - 'strict' => true, - ], - 'Single capital with digit (strict)' => [ - 'name' => 'A1', - 'strict' => true, - ], - 'Single capital (relaxed)' => [ - 'name' => 'A', - 'strict' => false, - ], - 'Single capital with digit (relaxed)' => [ - 'name' => 'A1', - 'strict' => false, - ], - ]; - - }//end dataValidClassFormatPublic() - - - /** - * Test invalid class names. - * - * @param string $name The tested name. - * - * @dataProvider dataInvalidClassFormat - * - * @return void - */ - public function testInvalidClassFormat($name) - { - $this->assertFalse(Common::isCamelCaps($name, true)); - - }//end testInvalidClassFormat() - - - /** - * Data provider. - * - * @see testInvalidClassFormat() - * - * @return array> - */ - public static function dataInvalidClassFormat() - { - return [ - 'lower camelCase string' => [ - 'name' => 'thisIsCamelCaps', - ], - 'PascalCase string with medial illegal character: -' => [ - 'name' => 'This-IsCamelCaps', - ], - 'capitalised snake case' => [ - 'name' => 'This_Is_Camel_Caps', - ], - 'empty string' => [ - 'name' => '', - ], - ]; - - }//end dataInvalidClassFormat() - - - /** - * Test invalid class names with the public flag set. - * - * Note that the public flag is ignored if the class format - * flag is set, so these names are all invalid. - * - * @param string $name The tested name. - * @param bool $public Value of the $public flag. - * - * @dataProvider dataInvalidClassFormatWithPublicFlag - * - * @return void - */ - public function testInvalidClassFormatWithPublicFlag($name, $public) - { - $this->assertFalse(Common::isCamelCaps($name, true, $public)); - - }//end testInvalidClassFormatWithPublicFlag() - - - /** - * Data provider. - * - * @see testInvalidClassFormatWithPublicFlag() - * - * @return array> - */ - public static function dataInvalidClassFormatWithPublicFlag() - { - return [ - 'PascalCase string with initial underscore (public)' => [ - 'name' => '_ThisIsCamelCaps', - 'public' => true, - ], - 'PascalCase string with initial underscore (private)' => [ - 'name' => '_ThisIsCamelCaps', - 'public' => false, - ], - 'empty string (public)' => [ - 'name' => '', - 'public' => true, - ], - 'empty string (private)' => [ - 'name' => '', - 'public' => false, - ], - ]; - - }//end dataInvalidClassFormatWithPublicFlag() - - - /** - * Test valid strings with default arguments. - * - * @param string $name The tested name. - * - * @dataProvider dataValidDefaultArguments - * - * @return void - */ - public function testValidDefaultArguments($name) - { - $this->assertTrue(Common::isCamelCaps($name)); - - }//end testValidDefaultArguments() - - - /** - * Data provider. - * - * @see testValidDefaultArguments() - * - * @return array> - */ - public static function dataValidDefaultArguments() - { - return [ - 'lower camelCase string' => [ - 'name' => 'thisIsCamelCaps', - ], - 'lower camelCase string with medial digit' => [ - 'name' => 'this3IsCamelCaps', - ], - ]; - - }//end dataValidDefaultArguments() - - - /** - * Test invalid strings with default arguments. - * - * @param string $name The tested name. - * - * @dataProvider dataInvalidDefaultArguments - * - * @return void - */ - public function testInvalidDefaultArguments($name) - { - $this->assertFalse(Common::isCamelCaps($name)); - - }//end testInvalidDefaultArguments() - - - /** - * Data provider. - * - * @see testInvalidDefaultArguments() - * - * @return array> - */ - public static function dataInvalidDefaultArguments() - { - return [ - 'PascalCase string' => [ - 'name' => 'ThisIsCamelCaps', - ], - 'PascalCase string with acronym' => [ - 'name' => 'ThisISCamelCaps', - ], - 'lower camelCase string with initial underscore' => [ - 'name' => '_thisIsCamelCaps', - ], - 'lower camelCase string with acronym' => [ - 'name' => 'thisISCamelCaps', - ], - ]; - - }//end dataInvalidDefaultArguments() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/PrepareForOutputTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/PrepareForOutputTest.php deleted file mode 100644 index 8eb2fc22f..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/PrepareForOutputTest.php +++ /dev/null @@ -1,113 +0,0 @@ -assertSame($expected, Common::prepareForOutput($content, $exclude)); - - }//end testPrepareForOutput() - - - /** - * Test formatting whitespace characters, on Windows. - * - * @param string $content The content to prepare. - * @param string[] $exclude A list of characters to leave invisible. - * @param string $expected Expected function output (unused in this test). - * @param string $expectedWin Expected function output on Windows. - * - * @requires OS ^WIN.*. - * @dataProvider dataPrepareForOutput - * - * @return void - */ - public function testPrepareForOutputWindows($content, $exclude, $expected, $expectedWin) - { - $this->assertSame($expectedWin, Common::prepareForOutput($content, $exclude)); - - }//end testPrepareForOutputWindows() - - - /** - * Data provider. - * - * @see testPrepareForOutput() - * @see testPrepareForOutputWindows() - * - * @return array> - */ - public static function dataPrepareForOutput() - { - return [ - 'Special characters are replaced with their escapes' => [ - 'content' => "\r\n\t", - 'exclude' => [], - 'expected' => "\033[30;1m\\r\033[0m\033[30;1m\\n\033[0m\033[30;1m\\t\033[0m", - 'expectedWin' => "\\r\\n\\t", - ], - 'Spaces are replaced with a unique mark' => [ - 'content' => " ", - 'exclude' => [], - 'expected' => "\033[30;1m·\033[0m\033[30;1m·\033[0m\033[30;1m·\033[0m\033[30;1m·\033[0m", - 'expectedWin' => " ", - ], - 'Other characters are unaffected' => [ - 'content' => "{echo 1;}", - 'exclude' => [], - 'expected' => "{echo\033[30;1m·\033[0m1;}", - 'expectedWin' => "{echo 1;}", - ], - 'No replacements' => [ - 'content' => 'nothing-should-be-replaced', - 'exclude' => [], - 'expected' => 'nothing-should-be-replaced', - 'expectedWin' => 'nothing-should-be-replaced', - ], - 'Excluded whitespace characters are unaffected' => [ - 'content' => "\r\n\t ", - 'exclude' => [ - "\r", - "\n", - ], - 'expected' => "\r\n\033[30;1m\\t\033[0m\033[30;1m·\033[0m", - 'expectedWin' => "\r\n\\t ", - ], - ]; - - }//end dataPrepareForOutput() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/StripColorsTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/StripColorsTest.php deleted file mode 100644 index ff253b8b8..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/StripColorsTest.php +++ /dev/null @@ -1,96 +0,0 @@ - - * @copyright 2024 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Common; - -use PHP_CodeSniffer\Util\Common; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Common::stripColors() method. - * - * @covers \PHP_CodeSniffer\Util\Common::stripColors - */ -final class StripColorsTest extends TestCase -{ - - - /** - * Test stripping color codes from a text. - * - * @param string $text The text provided. - * @param string $expected Expected function output. - * - * @dataProvider dataStripColors - * - * @return void - */ - public function testStripColors($text, $expected) - { - $this->assertSame($expected, Common::stripColors($text)); - - }//end testStripColors() - - - /** - * Data provider. - * - * @see testStripColors() - * - * @return array> - */ - public static function dataStripColors() - { - return [ - 'Text is empty' => [ - 'text' => '', - 'expected' => '', - ], - 'Text enclosed in color code' => [ - 'text' => "\033[36mSome text\033[0m", - 'expected' => 'Some text', - ], - 'Text containing color code' => [ - 'text' => "Some text \033[33mSome other text", - 'expected' => 'Some text Some other text', - ], - 'Text enclosed in color code, bold' => [ - 'text' => "\033[1;32mSome text\033[0m", - 'expected' => 'Some text', - ], - 'Text enclosed in color code, with escaped text' => [ - 'text' => "\033[30;1m\\n\033[0m", - 'expected' => '\n', - ], - 'Text enclosed in color code, bold, dark, italic' => [ - 'text' => "\033[1;2;3mtext\033[0m", - 'expected' => 'text', - ], - 'Text enclosed in color code, foreground color' => [ - 'text' => "\033[38;5;255mtext\033[0m", - 'expected' => 'text', - ], - 'Text enclosed in color code, foreground color and background color' => [ - 'text' => "\033[38;5;200;48;5;255mtext\033[0m", - 'expected' => 'text', - ], - 'Multiline text containing multiple color codes' => [ - 'text' => "First \033[36mSecond\033[0m -Third \033[1;2;3mFourth -Next line\033[0m Last", - 'expected' => 'First Second -Third Fourth -Next line Last', - ], - ]; - - }//end dataStripColors() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/SuggestTypeTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/SuggestTypeTest.php deleted file mode 100644 index 48bb6df1d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Common/SuggestTypeTest.php +++ /dev/null @@ -1,224 +0,0 @@ - - * @copyright 2019 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Common; - -use PHP_CodeSniffer\Util\Common; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Common::suggestType() method. - * - * @covers \PHP_CodeSniffer\Util\Common::suggestType - */ -final class SuggestTypeTest extends TestCase -{ - - - /** - * Test passing an empty type to the suggestType() method. - * - * @return void - */ - public function testSuggestTypeEmpty() - { - $this->assertSame('', Common::suggestType('')); - - }//end testSuggestTypeEmpty() - - - /** - * Test passing one of the allowed types to the suggestType() method. - * - * @param string $varType The type. - * - * @dataProvider dataSuggestTypeAllowedType - * - * @return void - */ - public function testSuggestTypeAllowedType($varType) - { - $result = Common::suggestType($varType); - $this->assertSame($varType, $result); - - }//end testSuggestTypeAllowedType() - - - /** - * Data provider. - * - * @see testSuggestTypeAllowedType() - * - * @return array> - */ - public static function dataSuggestTypeAllowedType() - { - $data = []; - foreach (Common::$allowedTypes as $type) { - $data['Type: '.$type] = [$type]; - } - - return $data; - - }//end dataSuggestTypeAllowedType() - - - /** - * Test passing one of the allowed types in the wrong case to the suggestType() method. - * - * @param string $varType The type found. - * @param string $expected Expected suggested type. - * - * @dataProvider dataSuggestTypeAllowedTypeWrongCase - * - * @return void - */ - public function testSuggestTypeAllowedTypeWrongCase($varType, $expected) - { - $result = Common::suggestType($varType); - $this->assertSame($expected, $result); - - }//end testSuggestTypeAllowedTypeWrongCase() - - - /** - * Data provider. - * - * @see testSuggestTypeAllowedTypeWrongCase() - * - * @return array> - */ - public static function dataSuggestTypeAllowedTypeWrongCase() - { - $data = []; - foreach (Common::$allowedTypes as $type) { - $data['Mixed case: '.$type] = [ - 'varType' => ucfirst($type), - 'expected' => $type, - ]; - $data['Uppercase: '.$type] = [ - 'varType' => strtoupper($type), - 'expected' => $type, - ]; - } - - return $data; - - }//end dataSuggestTypeAllowedTypeWrongCase() - - - /** - * Test the suggestType() method for all other cases. - * - * @param string $varType The type found. - * @param string $expected Expected suggested type. - * - * @dataProvider dataSuggestTypeOther - * - * @return void - */ - public function testSuggestTypeOther($varType, $expected) - { - $result = Common::suggestType($varType); - $this->assertSame($expected, $result); - - }//end testSuggestTypeOther() - - - /** - * Data provider. - * - * @see testSuggestTypeOther() - * - * @return array> - */ - public static function dataSuggestTypeOther() - { - return [ - // Short forms. - 'Short form type: bool, lowercase' => [ - 'varType' => 'bool', - 'expected' => 'boolean', - ], - 'Short form type: bool, uppercase' => [ - 'varType' => 'BOOL', - 'expected' => 'boolean', - ], - 'Short form type: double, lowercase' => [ - 'varType' => 'double', - 'expected' => 'float', - ], - 'Short form type: real, mixed case' => [ - 'varType' => 'Real', - 'expected' => 'float', - ], - 'Short form type: double, mixed case' => [ - 'varType' => 'DoUbLe', - 'expected' => 'float', - ], - 'Short form type: int, lowercase' => [ - 'varType' => 'int', - 'expected' => 'integer', - ], - 'Short form type: int, uppercase' => [ - 'varType' => 'INT', - 'expected' => 'integer', - ], - - // Array types. - 'Array type: mixed case keyword, empty parentheses' => [ - 'varType' => 'Array()', - 'expected' => 'array', - ], - 'Array type: short form type as value within the parentheses' => [ - 'varType' => 'array(real)', - 'expected' => 'array(float)', - ], - 'Array type: short form type as key within the parentheses' => [ - 'varType' => 'array(int => object)', - 'expected' => 'array(integer => object)', - ], - 'Array type: valid specification' => [ - 'varType' => 'array(integer => array(string => resource))', - 'expected' => 'array(integer => array(string => resource))', - ], - 'Array type: short form + uppercase types within the parentheses' => [ - 'varType' => 'ARRAY(BOOL => DOUBLE)', - 'expected' => 'array(boolean => float)', - ], - 'Array type: no space around the arrow within the parentheses' => [ - 'varType' => 'array(string=>resource)', - 'expected' => 'array(string => resource)', - ], - - // Incomplete array type. - 'Array type: incomplete specification' => [ - 'varType' => 'array(int =>', - 'expected' => 'array', - ], - - // Custom types are returned unchanged. - 'Unknown type: " => "' => [ - 'varType' => ' => ', - 'expected' => ' => ', - ], - 'Unknown type: "string[]"' => [ - 'varType' => 'string[]', - 'expected' => 'string[]', - ], - 'Unknown type: "\DateTime"' => [ - 'varType' => '\DateTime', - 'expected' => '\DateTime', - ], - ]; - - }//end dataSuggestTypeOther() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Help/HelpTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Help/HelpTest.php deleted file mode 100644 index d6165e22d..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Help/HelpTest.php +++ /dev/null @@ -1,792 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Help; - -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Util\Help; -use PHPUnit\Framework\TestCase; -use ReflectionMethod; -use ReflectionProperty; - -/** - * Test the Help class. - * - * @covers \PHP_CodeSniffer\Util\Help - */ -final class HelpTest extends TestCase -{ - - - /** - * QA check: verify that the category names are at most the minimum screen width - * and that option argument names are always at most half the length of the minimum screen width. - * - * If this test would start failing, either wrapping of argument info would need to be implemented - * or the minimum screen width needs to be upped. - * - * @coversNothing - * - * @return void - */ - public function testQaArgumentNamesAreWithinAcceptableBounds() - { - $help = new Help(new ConfigDouble(), []); - $allOptions = $this->invokeReflectionMethod($help, 'getAllOptions'); - - $this->assertGreaterThan(0, count($allOptions), 'No categories found'); - - $minScreenWidth = Help::MIN_WIDTH; - $maxArgWidth = ($minScreenWidth / 2); - - foreach ($allOptions as $category => $options) { - $this->assertLessThanOrEqual( - Help::MIN_WIDTH, - strlen($category), - "Category name $category is longer than the minimum screen width of $minScreenWidth" - ); - - foreach ($options as $option) { - if (isset($option['argument']) === false) { - continue; - } - - $this->assertLessThanOrEqual( - $maxArgWidth, - strlen($option['argument']), - "Option name {$option['argument']} is longer than the half the minimum screen width of $minScreenWidth" - ); - } - } - - }//end testQaArgumentNamesAreWithinAcceptableBounds() - - - /** - * QA check: verify that each option only contains a spacer, text or argument + description combo. - * - * @coversNothing - * - * @return void - */ - public function testQaValidCategoryOptionDefinitions() - { - $help = new Help(new ConfigDouble(), []); - $allOptions = $this->invokeReflectionMethod($help, 'getAllOptions'); - - $this->assertGreaterThan(0, count($allOptions), 'No categories found'); - - foreach ($allOptions as $category => $options) { - $this->assertGreaterThan(0, count($options), "No options found in category $category"); - - foreach ($options as $name => $option) { - if (isset($option['spacer']) === true) { - $this->assertStringStartsWith('blank-line', $name, 'The name for spacer items should start with "blank-line"'); - } - - $this->assertFalse( - isset($option['spacer'], $option['text']), - "Option $name: spacer and text should not be combined in one option" - ); - $this->assertFalse( - isset($option['spacer'], $option['argument']), - "Option $name: spacer and argument should not be combined in one option" - ); - $this->assertFalse( - isset($option['spacer'], $option['description']), - "Option $name: spacer and description should not be combined in one option" - ); - $this->assertFalse( - isset($option['text'], $option['argument']), - "Option $name: text and argument should not be combined in one option" - ); - $this->assertFalse( - isset($option['text'], $option['description']), - "Option $name: text and description should not be combined in one option" - ); - - if (isset($option['argument']) === true) { - $this->assertArrayHasKey( - 'description', - $option, - "Option $name: an argument should always be accompanied by a description" - ); - } - - if (isset($option['description']) === true) { - $this->assertArrayHasKey( - 'argument', - $option, - "Option $name: a description should always be accompanied by an argument" - ); - } - }//end foreach - }//end foreach - - }//end testQaValidCategoryOptionDefinitions() - - - /** - * Test receiving an expected exception when the shortOptions parameter is not passed a string value. - * - * @return void - */ - public function testConstructorInvalidArgumentException() - { - $exception = 'InvalidArgumentException'; - $message = 'The $shortOptions parameter must be a string'; - - if (method_exists($this, 'expectException') === true) { - // PHPUnit 5+. - $this->expectException($exception); - $this->expectExceptionMessage($message); - } else { - // PHPUnit 4. - $this->setExpectedException($exception, $message); - } - - new Help(new ConfigDouble(), [], []); - - }//end testConstructorInvalidArgumentException() - - - /** - * Test filtering of the options by requested options. - * - * Tests that: - * - Options not explicitly requested are removed. - * - Short options passed via the longOptions array are still respected. - * - A category gets removed if all options are removed, even if the category still has spacers. - * - * @param array $longOptions The long options which should be displayed. - * @param string $shortOptions The short options which should be displayed. - * @param array $expected The categories expected after filtering with the number - * of expected help items per category. - * - * @dataProvider dataOptionFiltering - * - * @return void - */ - public function testOptionFiltering($longOptions, $shortOptions, $expected) - { - $help = new Help(new ConfigDouble(), $longOptions, $shortOptions); - - $activeOptions = $this->getReflectionProperty($help, 'activeOptions'); - - // Simplify the value to make it comparible. - foreach ($activeOptions as $category => $options) { - $activeOptions[$category] = count($options); - } - - $this->assertSame($expected, $activeOptions, 'Option count per category does not match'); - - }//end testOptionFiltering() - - - /** - * Data provider. - * - * @return array|array>> - */ - public static function dataOptionFiltering() - { - $allLongOptions = explode(',', Help::DEFAULT_LONG_OPTIONS); - $allLongOptions[] = 'cache'; - $allLongOptions[] = 'no-cache'; - $allLongOptions[] = 'report'; - $allLongOptions[] = 'report-file'; - $allLongOptions[] = 'report-report'; - $allLongOptions[] = 'runtime-set'; - $allLongOptions[] = 'config-explain'; - $allLongOptions[] = 'config-set'; - $allLongOptions[] = 'config-delete'; - $allLongOptions[] = 'config-show'; - $allLongOptions[] = 'generator'; - $allLongOptions[] = 'suffix'; - - $allShortOptions = Help::DEFAULT_SHORT_OPTIONS.'saem'; - - return [ - 'No options' => [ - 'longOptions' => [], - 'shortOptions' => '', - 'expected' => [], - ], - 'Invalid options have no influence' => [ - 'longOptions' => [ - 'doesnotexist', - 'invalid', - ], - 'shortOptions' => 'bjrz', - 'expected' => [], - ], - 'Short options passed as long options works fine' => [ - 'longOptions' => [ - 's', - 'suffix', - 'a', - 'e', - 'colors', - ], - 'shortOptions' => '', - 'expected' => [ - 'Rule Selection Options' => 1, - 'Run Options' => 2, - 'Reporting Options' => 2, - ], - ], - 'All options' => [ - 'longOptions' => $allLongOptions, - 'shortOptions' => $allShortOptions, - 'expected' => [ - 'Scan targets' => 8, - 'Rule Selection Options' => 7, - 'Run Options' => 8, - 'Reporting Options' => 19, - 'Configuration Options' => 8, - 'Miscellaneous Options' => 5, - ], - ], - 'Default options only' => [ - 'longOptions' => explode(',', Help::DEFAULT_LONG_OPTIONS), - 'shortOptions' => Help::DEFAULT_SHORT_OPTIONS, - 'expected' => [ - 'Scan targets' => 8, - 'Rule Selection Options' => 5, - 'Run Options' => 4, - 'Reporting Options' => 14, - 'Configuration Options' => 4, - 'Miscellaneous Options' => 5, - ], - ], - 'Only one category' => [ - 'longOptions' => [ - 'file', - 'stdin-path', - 'file-list', - 'filter', - 'ignore', - 'extensions', - ], - 'shortOptions' => '-l', - 'expected' => [ - 'Scan targets' => 8, - ], - ], - 'All except one category' => [ - 'longOptions' => array_diff($allLongOptions, ['version', 'vv', 'vvv']), - 'shortOptions' => str_replace(['h', 'v'], '', $allShortOptions), - 'expected' => [ - 'Scan targets' => 8, - 'Rule Selection Options' => 7, - 'Run Options' => 8, - 'Reporting Options' => 19, - 'Configuration Options' => 8, - ], - ], - ]; - - }//end dataOptionFiltering() - - - /** - * Test filtering of the options by requested options does not leave stray spacers at the start - * or end of a category and that a category does not contain two consecutive spacers. - * - * {@internal Careful! This test may need updates to still test what it is supposed to test - * if/when the defined options in Help::getAllOptions() change.} - * - * @param array $longOptions The long options which should be displayed. - * @param string $shortOptions The short options which should be displayed. - * - * @dataProvider dataOptionFilteringSpacerHandling - * - * @return void - */ - public function testOptionFilteringSpacerHandling($longOptions, $shortOptions) - { - $help = new Help(new ConfigDouble(), $longOptions, $shortOptions); - - $activeOptions = $this->getReflectionProperty($help, 'activeOptions'); - - $this->assertNotEmpty($activeOptions, 'Active options is empty, test is invalid'); - - foreach ($activeOptions as $options) { - $first = reset($options); - $this->assertArrayNotHasKey('spacer', $first, 'Found spacer at start of category'); - - $last = end($options); - $this->assertArrayNotHasKey('spacer', $last, 'Found spacer at end of category'); - - $previousWasSpacer = false; - foreach ($options as $option) { - $this->assertFalse((isset($option['spacer']) && $previousWasSpacer === true), 'Consecutive spacers found'); - $previousWasSpacer = isset($option['spacer']); - } - } - - }//end testOptionFilteringSpacerHandling() - - - /** - * Data provider. - * - * @return array>> - */ - public static function dataOptionFilteringSpacerHandling() - { - return [ - 'No spacer at start of category' => [ - 'longOptions' => ['generator'], - 'shortOptions' => 'ie', - ], - 'No spacer at end of category' => [ - 'longOptions' => [ - 'encoding', - 'tab-width', - ], - 'shortOptions' => '', - ], - 'No consecutive spacers within category' => [ - 'longOptions' => [ - 'report', - 'report-file', - 'report-report', - 'report-width', - 'basepath', - 'ignore-annotations', - 'colors', - 'no-colors', - ], - 'shortOptions' => 'spqm', - ], - ]; - - }//end dataOptionFilteringSpacerHandling() - - - /** - * Test that if no short/long options are passed, only usage information is displayed (CS mode). - * - * @param array $cliArgs Command line arguments. - * @param string $expectedRegex Regex to validate expected output. - * - * @dataProvider dataDisplayUsage - * - * @return void - */ - public function testDisplayUsageCS($cliArgs, $expectedRegex) - { - if (PHP_CODESNIFFER_CBF === true) { - $this->markTestSkipped('This test needs CS mode to run'); - } - - $expectedRegex = str_replace('phpc(bf|s)', 'phpcs', $expectedRegex); - $this->verifyDisplayUsage($cliArgs, $expectedRegex); - - }//end testDisplayUsageCS() - - - /** - * Test that if no short/long options are passed, only usage information is displayed (CBF mode). - * - * @param array $cliArgs Command line arguments. - * @param string $expectedRegex Regex to validate expected output. - * - * @dataProvider dataDisplayUsage - * @group CBF - * - * @return void - */ - public function testDisplayUsageCBF($cliArgs, $expectedRegex) - { - if (PHP_CODESNIFFER_CBF === false) { - $this->markTestSkipped('This test needs CBF mode to run'); - } - - $expectedRegex = str_replace('phpc(bf|s)', 'phpcbf', $expectedRegex); - $this->verifyDisplayUsage($cliArgs, $expectedRegex); - - }//end testDisplayUsageCBF() - - - /** - * Helper method to test that if no short/long options are passed, only usage information is displayed - * (and displayed correctly). - * - * @param array $cliArgs Command line arguments. - * @param string $expectedRegex Regex to validate expected output. - * - * @return void - */ - private function verifyDisplayUsage($cliArgs, $expectedRegex) - { - $help = new Help(new ConfigDouble($cliArgs), []); - - $this->expectOutputRegex($expectedRegex); - - $help->display(); - - }//end verifyDisplayUsage() - - - /** - * Data provider. - * - * @return array>> - */ - public static function dataDisplayUsage() - { - return [ - 'Usage without colors' => [ - 'cliArgs' => ['--no-colors'], - 'expectedRegex' => '`^\s*Usage:\s+phpc(bf|s) \[options\] \\s+$`', - ], - 'Usage with colors' => [ - 'cliArgs' => ['--colors'], - 'expectedRegex' => '`^\s*\\033\[33mUsage:\\033\[0m\s+phpc(bf|s) \[options\] \\s+$`', - ], - ]; - - }//end dataDisplayUsage() - - - /** - * Test the column width calculations. - * - * This tests the following aspects: - * 1. That the report width is never less than Help::MIN_WIDTH, even when a smaller width is passed. - * 2. That the first column width is calculated correctly and is based on the longest argument. - * 3. That the word wrapping of the description respects the maximum report width. - * 4. That if the description is being wrapped, the indent for the second line is calculated correctly. - * - * @param int $reportWidth Report width for the test. - * @param array $longOptions The long options which should be displayed. - * @param string $expectedOutput Expected output. - * - * @dataProvider dataReportWidthCalculations - * - * @return void - */ - public function testReportWidthCalculations($reportWidth, $longOptions, $expectedOutput) - { - $config = new ConfigDouble(["--report-width=$reportWidth", '--no-colors']); - $help = new Help($config, $longOptions); - - $this->invokeReflectionMethod($help, 'printCategories'); - - $this->expectOutputString($expectedOutput); - - }//end testReportWidthCalculations() - - - /** - * Data provider. - * - * @return array>> - */ - public static function dataReportWidthCalculations() - { - $longOptions = [ - 'e', - 'generator', - ]; - - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - return [ - 'Report width small: 40; forces report width to minimum width of 60' => [ - 'reportWidth' => 40, - 'longOptions' => $longOptions, - 'expectedOutput' => PHP_EOL.'Rule Selection Options:'.PHP_EOL - .' -e Explain a standard by showing the'.PHP_EOL - .' names of all the sniffs it'.PHP_EOL - .' includes.'.PHP_EOL - .' --generator= Show documentation for a standard.'.PHP_EOL - .' Use either the "HTML", "Markdown"'.PHP_EOL - .' or "Text" generator.'.PHP_EOL, - ], - 'Report width is minimum: 60 (= self::MIN_WIDTH)' => [ - 'reportWidth' => Help::MIN_WIDTH, - 'longOptions' => $longOptions, - 'expectedOutput' => PHP_EOL.'Rule Selection Options:'.PHP_EOL - .' -e Explain a standard by showing the'.PHP_EOL - .' names of all the sniffs it'.PHP_EOL - .' includes.'.PHP_EOL - .' --generator= Show documentation for a standard.'.PHP_EOL - .' Use either the "HTML", "Markdown"'.PHP_EOL - .' or "Text" generator.'.PHP_EOL, - ], - 'Report width matches length for one line, not the other: 96; only one should wrap' => [ - 'reportWidth' => 96, - 'longOptions' => $longOptions, - 'expectedOutput' => PHP_EOL.'Rule Selection Options:'.PHP_EOL - .' -e Explain a standard by showing the names of all the sniffs it includes.'.PHP_EOL - .' --generator= Show documentation for a standard. Use either the "HTML", "Markdown"'.PHP_EOL - .' or "Text" generator.'.PHP_EOL, - ], - 'Report width matches longest line: 119; the messages should not wrap and there should be no stray new line at the end' => [ - 'reportWidth' => 119, - 'longOptions' => $longOptions, - 'expectedOutput' => PHP_EOL.'Rule Selection Options:'.PHP_EOL - .' -e Explain a standard by showing the names of all the sniffs it includes.'.PHP_EOL - .' --generator= Show documentation for a standard. Use either the "HTML", "Markdown" or "Text" generator.'.PHP_EOL, - ], - ]; - // phpcs:enable - - }//end dataReportWidthCalculations() - - - /** - * Verify that variable elements in an argument specification get colorized correctly. - * - * @param string $input String to colorize. - * @param string $expected Expected function output. - * - * @dataProvider dataColorizeVariableInput - * - * @return void - */ - public function testColorizeVariableInput($input, $expected) - { - $help = new Help(new ConfigDouble(), []); - $result = $this->invokeReflectionMethod($help, 'colorizeVariableInput', $input); - - $this->assertSame($expected, $result); - - }//end testColorizeVariableInput() - - - /** - * Data provider. - * - * @return array>> - */ - public static function dataColorizeVariableInput() - { - return [ - 'Empty string' => [ - 'input' => '', - 'expected' => '', - ], - 'String without variable element(s)' => [ - 'input' => 'This is text', - 'expected' => 'This is text', - ], - 'String with variable element' => [ - 'input' => 'This text', - 'expected' => "This \033[36m\033[32m text", - ], - 'String with multiple variable elements' => [ - 'input' => ' is ', - 'expected' => "\033[36m\033[32m is \033[36m\033[32m", - ], - 'String with unclosed variable element' => [ - 'input' => 'This 'This [ - 'input' => ' text>', - 'expected' => "\033[36m text>\033[32m", - ], - 'String with nested elements and surrounding text' => [ - 'input' => 'Start text> end', - 'expected' => "Start \033[36m text>\033[32m end", - ], - ]; - - }//end dataColorizeVariableInput() - - - /** - * Test the various option types within a category get displayed correctly. - * - * @param array> $input The options to print. - * @param array $expectedRegex Regexes to validate expected output. - * - * @dataProvider dataPrintCategoryOptions - * - * @return void - */ - public function testPrintCategoryOptionsNoColor($input, $expectedRegex) - { - $config = new ConfigDouble(['--no-colors']); - $help = new Help($config, []); - - $this->setReflectionProperty($help, 'activeOptions', ['cat' => $input]); - $this->invokeReflectionMethod($help, 'setMaxOptionNameLength'); - $this->invokeReflectionMethod($help, 'printCategoryOptions', $input); - - $this->expectOutputRegex($expectedRegex['no-color']); - - }//end testPrintCategoryOptionsNoColor() - - - /** - * Test the various option types within a category get displayed correctly. - * - * @param array> $input The options to print. - * @param array $expectedRegex Regexes to validate expected output. - * - * @dataProvider dataPrintCategoryOptions - * - * @return void - */ - public function testPrintCategoryOptionsColor($input, $expectedRegex) - { - $config = new ConfigDouble(['--colors']); - $help = new Help($config, []); - - $this->setReflectionProperty($help, 'activeOptions', ['cat' => $input]); - $this->invokeReflectionMethod($help, 'setMaxOptionNameLength'); - $this->invokeReflectionMethod($help, 'printCategoryOptions', $input); - - $this->expectOutputRegex($expectedRegex['color']); - - }//end testPrintCategoryOptionsColor() - - - /** - * Data provider. - * - * @return array>|array>> - */ - public static function dataPrintCategoryOptions() - { - $indentLength = strlen(Help::INDENT); - $gutterLength = strlen(Help::GUTTER); - - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - // phpcs:disable Generic.Strings.UnnecessaryStringConcat.Found -- Test readability is more important. - return [ - 'Input: arg, spacer, arg; new lines in description get preserved' => [ - 'input' => [ - 'short-option' => [ - 'argument' => '-a', - 'description' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', - ], - 'blank-line' => [ - 'spacer' => '', - ], - 'long-option-multi-line-description' => [ - 'argument' => '--something=', - 'description' => 'Proin sit amet malesuada libero, finibus bibendum tortor. Nulla vitae quam nec orci finibus pharetra.' - ."\n".'Nam eget blandit dui.', - ], - ], - 'expectedRegex' => [ - 'no-color' => '`^ {'.$indentLength.'}-a {15} {'.$gutterLength.'}Lorem ipsum dolor sit amet, consectetur adipiscing elit\.\R' - .'\R' - .' {'.$indentLength.'}--something= {'.$gutterLength.'}Proin sit amet malesuada libero, finibus bibendum tortor\.\R' - .' {'.($indentLength + 17).'} {'.$gutterLength.'}Nulla vitae quam nec orci finibus pharetra\.\R' - .' {'.($indentLength + 17).'} {'.$gutterLength.'}Nam eget blandit dui\.\R$`', - 'color' => '`^ {'.$indentLength.'}\\033\[32m-a {15}\\033\[0m {'.$gutterLength.'}Lorem ipsum dolor sit amet, consectetur adipiscing elit\.\R' - .'\R' - .' {'.$indentLength.'}\\033\[32m--something=\\033\[36m\\033\[32m\\033\[0m {'.$gutterLength.'}Proin sit amet malesuada libero, finibus bibendum tortor\.\R' - .' {'.($indentLength + 17).'} {'.$gutterLength.'}Nulla vitae quam nec orci finibus pharetra\.\R' - .' {'.($indentLength + 17).'} {'.$gutterLength.'}Nam eget blandit dui\.\R$`', - ], - ], - 'Input: text, arg, text; multi-line text gets wrapped' => [ - 'input' => [ - 'single-line-text' => [ - 'text' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', - ], - 'argument-description' => [ - 'argument' => '--something', - 'description' => 'Fusce dapibus sodales est eu sodales.', - ], - 'multi-line-text-gets-wrapped' => [ - 'text' => 'Maecenas vulputate ligula vel feugiat finibus. Mauris sem dui, pretium in turpis auctor, consectetur ultrices lorem.', - ], - ], - 'expectedRegex' => [ - 'no-color' => '`^ {'.$indentLength.'}Lorem ipsum dolor sit amet, consectetur adipiscing elit\.\R' - .' {'.$indentLength.'}--something {'.$gutterLength.'}Fusce dapibus sodales est eu sodales\.\R' - .' {'.$indentLength.'}Maecenas vulputate ligula vel feugiat finibus. Mauris sem dui, pretium in\R' - .' {'.$indentLength.'}turpis auctor, consectetur ultrices lorem\.\R$`', - 'color' => '`^ {'.$indentLength.'}Lorem ipsum dolor sit amet, consectetur adipiscing elit\.\R' - .' {'.$indentLength.'}\\033\[32m--something\\033\[0m {'.$gutterLength.'}Fusce dapibus sodales est eu sodales\.\R' - .' {'.$indentLength.'}Maecenas vulputate ligula vel feugiat finibus. Mauris sem dui, pretium in\R' - .' {'.$indentLength.'}turpis auctor, consectetur ultrices lorem\.\R$`', - ], - ], - ]; - // phpcs:enable - - }//end dataPrintCategoryOptions() - - - /** - * Test Helper: invoke a reflected method which is not publicly accessible. - * - * @param \PHP_CodeSniffer\Util\Help $help Instance of a Help object. - * @param string $methodName The name of the method to invoke. - * @param mixed $params Optional. Parameters to pass to the method invocation. - * - * @return mixed - */ - private function invokeReflectionMethod(Help $help, $methodName, $params=null) - { - $reflMethod = new ReflectionMethod($help, $methodName); - (PHP_VERSION_ID < 80100) && $reflMethod->setAccessible(true); - - if ($params === null) { - $returnValue = $reflMethod->invoke($help); - } else { - $returnValue = $reflMethod->invoke($help, $params); - } - - (PHP_VERSION_ID < 80100) && $reflMethod->setAccessible(false); - - return $returnValue; - - }//end invokeReflectionMethod() - - - /** - * Test Helper: retrieve the value of property which is not publicly accessible. - * - * @param \PHP_CodeSniffer\Util\Help $help Instance of a Help object. - * @param string $properyName The name of the property to retrieve. - * - * @return mixed - */ - private function getReflectionProperty(Help $help, $properyName) - { - $reflProperty = new ReflectionProperty($help, $properyName); - (PHP_VERSION_ID < 80100) && $reflProperty->setAccessible(true); - $returnValue = $reflProperty->getValue($help); - (PHP_VERSION_ID < 80100) && $reflProperty->setAccessible(false); - - return $returnValue; - - }//end getReflectionProperty() - - - /** - * Test Helper: set the value of property which is not publicly accessible. - * - * @param \PHP_CodeSniffer\Util\Help $help Instance of a Help object. - * @param string $properyName The name of the property to set. - * @param mixed $value The value to set. - * - * @return void - */ - private function setReflectionProperty(Help $help, $properyName, $value) - { - $reflProperty = new ReflectionProperty($help, $properyName); - (PHP_VERSION_ID < 80100) && $reflProperty->setAccessible(true); - $reflProperty->setValue($help, $value); - (PHP_VERSION_ID < 80100) && $reflProperty->setAccessible(false); - - }//end setReflectionProperty() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/MessageCollector/MessageCollectorTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/MessageCollector/MessageCollectorTest.php deleted file mode 100644 index faa98ca41..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/MessageCollector/MessageCollectorTest.php +++ /dev/null @@ -1,538 +0,0 @@ -expectException($exception); - $this->expectExceptionMessage($exceptionMsg); - } else { - // PHPUnit 4. - $this->setExpectedException($exception, $exceptionMsg); - } - - $msgCollector = new MessageCollector(); - $msgCollector->add($message); - - }//end testAddingNonStringMessageResultsInException() - - - /** - * Data provider. - * - * @see testAddingNonStringMessageResultsInException() - * - * @return array> - */ - public static function dataAddingNonStringMessageResultsInException() - { - return [ - 'null' => [null], - 'boolean' => [true], - 'integer' => [10], - 'array' => [['something' => 'incorrect']], - ]; - - }//end dataAddingNonStringMessageResultsInException() - - - /** - * Verify that passing a message type which is not one of the predefined types is rejected with an exception. - * - * @param mixed $type The invalid "type" to pass. - * - * @dataProvider dataAddingMessageWithUnsupportedMessageTypeResultsInException - * - * @return void - */ - public function testAddingMessageWithUnsupportedMessageTypeResultsInException($type) - { - $exception = 'InvalidArgumentException'; - $exceptionMsg = 'The message $type should be one of the predefined MessageCollector constants. Received: '; - if (method_exists($this, 'expectException') === true) { - // PHPUnit 5+. - $this->expectException($exception); - $this->expectExceptionMessage($exceptionMsg); - } else { - // PHPUnit 4. - $this->setExpectedException($exception, $exceptionMsg); - } - - $msgCollector = new MessageCollector(); - $msgCollector->add('Message', $type); - - }//end testAddingMessageWithUnsupportedMessageTypeResultsInException() - - - /** - * Data provider. - * - * @see testAddingMessageWithUnsupportedMessageTypeResultsInException() - * - * @return array> - */ - public static function dataAddingMessageWithUnsupportedMessageTypeResultsInException() - { - return [ - 'null' => [null], - 'boolean' => [true], - 'string' => ['DEPRECATED'], - 'integer which doesn\'t match any of the message type constants: -235' => [-235], - 'integer which doesn\'t match any of the message type constants: 0' => [0], - 'integer which doesn\'t match any of the message type constants: 3' => [3], - 'integer which doesn\'t match any of the message type constants: 6' => [6], - 'integer which doesn\'t match any of the message type constants: 123' => [123], - 'integer which doesn\'t match any of the message type constants: PHP_INT_MAX' => [PHP_INT_MAX], - ]; - - }//end dataAddingMessageWithUnsupportedMessageTypeResultsInException() - - - /** - * Verify that the `containsBlockingErrors()` method correctly identifies whether the collected messages - * include messages which are blocking (errors), or only include non-blocking (warnings, notices, - * deprecations) messages. - * - * @param array $messages The messages to display. - * Key is the message, value is the error level. - * @param bool $expected The expected function output. - * - * @dataProvider dataContainsBlockingErrors - * - * @return void - */ - public function testContainsBlockingErrors($messages, $expected) - { - $msgCollector = new MessageCollector(); - $this->createErrorCache($msgCollector, $messages); - - $this->assertSame($expected, $msgCollector->containsBlockingErrors()); - - }//end testContainsBlockingErrors() - - - /** - * Data provider. - * - * @see testContainsBlockingErrors() - * - * @return array|bool>> - */ - public static function dataContainsBlockingErrors() - { - return [ - 'No messages' => [ - 'messages' => [], - 'expected' => false, - ], - 'Only non-blocking messages' => [ - 'messages' => [ - 'First message' => MessageCollector::WARNING, - 'Second message' => MessageCollector::NOTICE, - 'Third message' => MessageCollector::DEPRECATED, - ], - 'expected' => false, - ], - 'Only blocking messages' => [ - 'messages' => [ - 'First message' => MessageCollector::ERROR, - 'Second message' => MessageCollector::ERROR, - 'Third message' => MessageCollector::ERROR, - ], - 'expected' => true, - ], - 'Mix of blocking and non-blocking messages' => [ - 'messages' => [ - 'First message' => MessageCollector::DEPRECATED, - 'Second message' => MessageCollector::ERROR, - 'Third message' => MessageCollector::WARNING, - ], - 'expected' => true, - ], - ]; - - }//end dataContainsBlockingErrors() - - - /** - * Test displaying non-blocking messages only. - * - * Verifies that: - * - Each message is prefixed with the appropriate prefix. - * - The default message order is observed. - * - The messages use the appropriate OS-specific EOL character. - * - * @param array $messages The messages to display. - * Key is the message, value is the error level. - * @param string $expected The expected exception message. - * - * @dataProvider dataDisplayingNonBlockingMessages - * - * @return void - */ - public function testDisplayingNonBlockingMessages($messages, $expected) - { - $msgCollector = new MessageCollector(); - $this->createErrorCache($msgCollector, $messages); - - $this->expectOutputString($expected); - - $msgCollector->display(); - - }//end testDisplayingNonBlockingMessages() - - - /** - * Data provider. - * - * @see testDisplayingNonBlockingMessages() - * - * @return array|string>> - */ - public static function dataDisplayingNonBlockingMessages() - { - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - return [ - 'No messages' => [ - 'messages' => [], - 'expected' => '', - ], - 'One warning' => [ - 'messages' => [ - 'This is a warning' => MessageCollector::WARNING, - ], - 'expected' => 'WARNING: This is a warning'.PHP_EOL.PHP_EOL, - ], - 'One notice' => [ - 'messages' => [ - 'This is a notice' => MessageCollector::NOTICE, - ], - 'expected' => 'NOTICE: This is a notice'.PHP_EOL.PHP_EOL, - ], - 'One deprecation' => [ - 'messages' => [ - 'This is a deprecation' => MessageCollector::DEPRECATED, - ], - 'expected' => 'DEPRECATED: This is a deprecation'.PHP_EOL.PHP_EOL, - ], - 'Multiple warnings' => [ - 'messages' => [ - 'First warning' => MessageCollector::WARNING, - 'Second warning' => MessageCollector::WARNING, - ], - 'expected' => 'WARNING: First warning'.PHP_EOL - .'WARNING: Second warning'.PHP_EOL.PHP_EOL, - ], - 'Multiple notices' => [ - 'messages' => [ - 'First notice' => MessageCollector::NOTICE, - 'Second notice' => MessageCollector::NOTICE, - 'Third notice' => MessageCollector::NOTICE, - ], - 'expected' => 'NOTICE: First notice'.PHP_EOL - .'NOTICE: Second notice'.PHP_EOL - .'NOTICE: Third notice'.PHP_EOL.PHP_EOL, - ], - 'Multiple deprecations' => [ - 'messages' => [ - 'First deprecation' => MessageCollector::DEPRECATED, - 'Second deprecation' => MessageCollector::DEPRECATED, - ], - 'expected' => 'DEPRECATED: First deprecation'.PHP_EOL - .'DEPRECATED: Second deprecation'.PHP_EOL.PHP_EOL, - ], - 'All together now' => [ - 'messages' => [ - 'First deprecation' => MessageCollector::DEPRECATED, - 'Second warning' => MessageCollector::WARNING, - 'Third notice' => MessageCollector::NOTICE, - 'Fourth warning' => MessageCollector::WARNING, - ], - 'expected' => 'WARNING: Second warning'.PHP_EOL - .'WARNING: Fourth warning'.PHP_EOL - .'NOTICE: Third notice'.PHP_EOL - .'DEPRECATED: First deprecation'.PHP_EOL.PHP_EOL, - ], - ]; - // phpcs:enable - - }//end dataDisplayingNonBlockingMessages() - - - /** - * Test displaying message collections containing blocking messages. - * - * Verifies that: - * - Each message is prefixed with the appropriate prefix. - * - The default message order is observed. - * - The messages use the appropriate OS-specific EOL character. - * - * @param array $messages The messages to display. - * Key is the message, value is the error level. - * @param string $expected The expected exception message. - * - * @dataProvider dataDisplayingBlockingErrors - * - * @return void - */ - public function testDisplayingBlockingErrors($messages, $expected) - { - $exception = 'PHP_CodeSniffer\Exceptions\RuntimeException'; - if (method_exists($this, 'expectException') === true) { - // PHPUnit 5+. - $this->expectException($exception); - $this->expectExceptionMessage($expected); - } else { - // PHPUnit 4. - $this->setExpectedException($exception, $expected); - } - - $msgCollector = new MessageCollector(); - $this->createErrorCache($msgCollector, $messages); - $msgCollector->display(); - - }//end testDisplayingBlockingErrors() - - - /** - * Data provider. - * - * @see testDisplayingBlockingErrors() - * - * @return array|string>> - */ - public static function dataDisplayingBlockingErrors() - { - // phpcs:disable Squiz.Strings.ConcatenationSpacing.PaddingFound -- Test readability is more important. - return [ - 'Single error' => [ - 'messages' => [ - 'This is an error' => MessageCollector::ERROR, - ], - 'expected' => 'ERROR: This is an error'.PHP_EOL.PHP_EOL, - ], - 'Multiple errors' => [ - 'messages' => [ - 'First error' => MessageCollector::ERROR, - 'Second error' => MessageCollector::ERROR, - ], - 'expected' => 'ERROR: First error'.PHP_EOL - .'ERROR: Second error'.PHP_EOL.PHP_EOL, - ], - 'Errors mixed with non-blocking messages' => [ - 'messages' => [ - 'First deprecation' => MessageCollector::DEPRECATED, - 'Second warning' => MessageCollector::WARNING, - 'Third notice' => MessageCollector::NOTICE, - 'Fourth error' => MessageCollector::ERROR, - 'Fifth warning' => MessageCollector::WARNING, - 'Sixth error' => MessageCollector::ERROR, - 'Seventh deprecation' => MessageCollector::DEPRECATED, - ], - 'expected' => 'ERROR: Fourth error'.PHP_EOL - .'ERROR: Sixth error'.PHP_EOL - .'WARNING: Second warning'.PHP_EOL - .'WARNING: Fifth warning'.PHP_EOL - .'NOTICE: Third notice'.PHP_EOL - .'DEPRECATED: First deprecation'.PHP_EOL - .'DEPRECATED: Seventh deprecation'.PHP_EOL.PHP_EOL, - ], - ]; - // phpcs:enable - - }//end dataDisplayingBlockingErrors() - - - /** - * Verify and safeguard that adding the same message twice is accepted when messages have different error levels. - * - * Note: have multiple messages with the exact same text is not great for conveying information - * to the end-user, but that's not the concern of the MessageCollector class. - * - * @return void - */ - public function testNonUniqueMessagesWithDifferentErrorLevelAreAccepted() - { - $message = 'Trying to add the same message twice'; - $msgCollector = new MessageCollector(); - $msgCollector->add($message, MessageCollector::NOTICE); - $msgCollector->add($message, MessageCollector::WARNING); - - $expected = 'WARNING: Trying to add the same message twice'.PHP_EOL; - $expected .= 'NOTICE: Trying to add the same message twice'.PHP_EOL.PHP_EOL; - $this->expectOutputString($expected); - - $msgCollector->display(); - - }//end testNonUniqueMessagesWithDifferentErrorLevelAreAccepted() - - - /** - * Verify and safeguard that adding the same message twice is accepted when messages have the same error level. - * - * Note: have multiple messages with the exact same text is not great for conveying information - * to the end-user, but that's not the concern of the MessageCollector class. - * - * @return void - */ - public function testNonUniqueMessagesWithSameErrorLevelAreAccepted() - { - $message = 'Trying to add the same message twice'; - $msgCollector = new MessageCollector(); - $msgCollector->add($message, MessageCollector::NOTICE); - $msgCollector->add($message, MessageCollector::NOTICE); - - $expected = 'NOTICE: Trying to add the same message twice'.PHP_EOL; - $expected .= 'NOTICE: Trying to add the same message twice'.PHP_EOL.PHP_EOL; - $this->expectOutputString($expected); - - $msgCollector->display(); - - }//end testNonUniqueMessagesWithSameErrorLevelAreAccepted() - - - /** - * Ensure that the message cache is cleared when the collected messages are displayed. - * - * @return void - */ - public function testCallingDisplayTwiceWillNotShowMessagesTwice() - { - $messages = [ - 'First notice' => MessageCollector::NOTICE, - 'Second deprecation' => MessageCollector::DEPRECATED, - 'Third notice' => MessageCollector::NOTICE, - 'Fourth warning' => MessageCollector::WARNING, - ]; - - $msgCollector = new MessageCollector(); - $this->createErrorCache($msgCollector, $messages); - - $expected = 'WARNING: Fourth warning'.PHP_EOL; - $expected .= 'NOTICE: First notice'.PHP_EOL; - $expected .= 'NOTICE: Third notice'.PHP_EOL; - $expected .= 'DEPRECATED: Second deprecation'.PHP_EOL.PHP_EOL; - $this->expectOutputString($expected); - - $msgCollector->display(); - $msgCollector->display(); - - }//end testCallingDisplayTwiceWillNotShowMessagesTwice() - - - /** - * Test that messages are ordered correctly. - * - * @param string $order The display order. - * @param string $expected The expected output. - * - * @dataProvider dataDisplayOrderHandling - * - * @return void - */ - public function testDisplayOrderHandling($order, $expected) - { - $messages = [ - 'First notice' => MessageCollector::NOTICE, - 'Second deprecation' => MessageCollector::DEPRECATED, - 'Third notice' => MessageCollector::NOTICE, - 'Fourth warning' => MessageCollector::WARNING, - ]; - - $msgCollector = new MessageCollector(); - $this->createErrorCache($msgCollector, $messages); - - $this->expectOutputString($expected); - - $msgCollector->display($order); - - }//end testDisplayOrderHandling() - - - /** - * Data provider. - * - * @see testDisplayOrderHandling() - * - * @return array> - */ - public static function dataDisplayOrderHandling() - { - $expectedForSeverity = 'WARNING: Fourth warning'.PHP_EOL; - $expectedForSeverity .= 'NOTICE: First notice'.PHP_EOL; - $expectedForSeverity .= 'NOTICE: Third notice'.PHP_EOL; - $expectedForSeverity .= 'DEPRECATED: Second deprecation'.PHP_EOL.PHP_EOL; - - $expectedForReceived = 'NOTICE: First notice'.PHP_EOL; - $expectedForReceived .= 'DEPRECATED: Second deprecation'.PHP_EOL; - $expectedForReceived .= 'NOTICE: Third notice'.PHP_EOL; - $expectedForReceived .= 'WARNING: Fourth warning'.PHP_EOL.PHP_EOL; - - return [ - 'Order by severity' => [ - 'order' => MessageCollector::ORDERBY_SEVERITY, - 'expected' => $expectedForSeverity, - ], - 'Order by received' => [ - 'order' => MessageCollector::ORDERBY_RECEIVED, - 'expected' => $expectedForReceived, - ], - 'Invalid order defaults to severity' => [ - 'order' => 'unknown order', - 'expected' => $expectedForSeverity, - ], - ]; - - }//end dataDisplayOrderHandling() - - - /** - * Test helper. - * - * @param \PHP_CodeSniffer\Util\MessageCollector $collector The error cache object. - * @param array $messages The error messages to add to the cache. - * Key is the message, value is the error level. - * - * @return void - */ - private function createErrorCache(MessageCollector $collector, $messages) - { - foreach ($messages as $msg => $type) { - $collector->add($msg, $type); - } - - }//end createErrorCache() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Timing/GetHumanReadableDurationTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Timing/GetHumanReadableDurationTest.php deleted file mode 100644 index 93b3d05e1..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Timing/GetHumanReadableDurationTest.php +++ /dev/null @@ -1,114 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Timing; - -use PHP_CodeSniffer\Util\Timing; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Timing::getHumanReadableDuration() method. - * - * @covers \PHP_CodeSniffer\Util\Timing::getHumanReadableDuration - */ -final class GetHumanReadableDurationTest extends TestCase -{ - - - /** - * Test the method. - * - * @param int|float $duration A duration in milliseconds. - * @param string $expected The expected human readable string. - * - * @dataProvider dataGetHumanReadableDuration - * - * @return void - */ - public function testGetHumanReadableDuration($duration, $expected) - { - $this->assertSame($expected, Timing::getHumanReadableDuration($duration)); - - }//end testGetHumanReadableDuration() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataGetHumanReadableDuration() - { - return [ - 'Duration: 0' => [ - 'duration' => 0, - 'expected' => '0ms', - ], - 'Duration: 13 milliseconds' => [ - 'duration' => 13.232101565, - 'expected' => '13ms', - ], - 'Duration: 14 milliseconds' => [ - 'duration' => 13.916015625, - 'expected' => '14ms', - ], - 'Duration: 999 milliseconds' => [ - 'duration' => 999.2236, - 'expected' => '999ms', - ], - 'Duration: 999+ milliseconds' => [ - 'duration' => 999.89236, - 'expected' => '1000ms', - ], - 'Duration: 1 second' => [ - 'duration' => 1000, - 'expected' => '1 secs', - ], - 'Duration: slightly more than 1 second' => [ - 'duration' => 1001.178215, - 'expected' => '1 secs', - ], - 'Duration: just under a 1 minute' => [ - 'duration' => 59999.3851, - 'expected' => '60 secs', - ], - 'Duration: exactly 1 minute' => [ - 'duration' => 60000, - 'expected' => '1 mins', - ], - 'Duration: slightly more than 1 minute' => [ - 'duration' => 60001.7581235, - 'expected' => '1 mins', - ], - 'Duration: 1 minute, just under half a second' => [ - 'duration' => 60499.83639, - 'expected' => '1 mins, 0.5 secs', - ], - 'Duration: 1 minute, just over half a second' => [ - 'duration' => 60501.961238, - 'expected' => '1 mins, 0.5 secs', - ], - 'Duration: 1 minute, 1 second' => [ - 'duration' => 61000, - 'expected' => '1 mins, 1 secs', - ], - 'Duration: exactly 1 hour' => [ - 'duration' => 3600000, - 'expected' => '60 mins', - ], - 'Duration: 89.4 mins' => [ - 'duration' => 5364000, - 'expected' => '89 mins, 24 secs', - ], - ]; - - }//end dataGetHumanReadableDuration() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Timing/TimingTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Timing/TimingTest.php deleted file mode 100644 index 87c2a6495..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Timing/TimingTest.php +++ /dev/null @@ -1,121 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Timing; - -use PHP_CodeSniffer\Util\Timing; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Timing class. - * - * {@internal These tests need to run in separate processes as the Timing class uses static properties - * to keep track of the start time and whether or not the runtime has been printed and these - * can't be unset/reset once set.} - * - * @covers \PHP_CodeSniffer\Util\Timing - * - * @runTestsInSeparateProcesses - * @preserveGlobalState disabled - */ -final class TimingTest extends TestCase -{ - - - /** - * Verify that getDuration() returns 0 when the timer wasn't started. - * - * @return void - */ - public function testGetDurationWithoutStartReturnsZero() - { - $this->assertSame(0, Timing::getDuration()); - - }//end testGetDurationWithoutStartReturnsZero() - - - /** - * Verify that getDuration() returns the time in milliseconds. - * - * @return void - */ - public function testGetDurationWithStartReturnsMilliseconds() - { - Timing::startTiming(); - usleep(1500); - $duration = Timing::getDuration(); - - $this->assertTrue(is_float($duration)); - - }//end testGetDurationWithStartReturnsMilliseconds() - - - /** - * Verify that printRunTime() doesn't print anything if the timer wasn't started. - * - * @return void - */ - public function testTimeIsNotPrintedIfTimerWasNeverStarted() - { - $this->expectOutputString(''); - Timing::printRunTime(); - - }//end testTimeIsNotPrintedIfTimerWasNeverStarted() - - - /** - * Verify that printRunTime() doesn't print anything if the timer wasn't started. - * - * @return void - */ - public function testTimeIsNotPrintedIfTimerWasNeverStartedEvenWhenForced() - { - $this->expectOutputString(''); - Timing::printRunTime(true); - - }//end testTimeIsNotPrintedIfTimerWasNeverStartedEvenWhenForced() - - - /** - * Verify that printRunTime() when called multiple times only prints the runtime information once. - * - * @return void - */ - public function testTimeIsPrintedOnlyOnce() - { - $this->expectOutputRegex('`^Time: [0-9]+ms; Memory: [0-9\.]+MB'.PHP_EOL.PHP_EOL.'$`'); - - Timing::startTiming(); - usleep(2000); - Timing::printRunTime(); - Timing::printRunTime(); - Timing::printRunTime(); - - }//end testTimeIsPrintedOnlyOnce() - - - /** - * Verify that printRunTime() when called multiple times prints the runtime information multiple times if forced. - * - * @return void - */ - public function testTimeIsPrintedMultipleTimesOnlyIfForced() - { - $this->expectOutputRegex('`^(Time: [0-9]+ms; Memory: [0-9\.]+MB'.PHP_EOL.PHP_EOL.'){3}$`'); - - Timing::startTiming(); - usleep(2000); - Timing::printRunTime(true); - Timing::printRunTime(true); - Timing::printRunTime(true); - - }//end testTimeIsPrintedMultipleTimesOnlyIfForced() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Tokens/GetHighestWeightedTokenTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Tokens/GetHighestWeightedTokenTest.php deleted file mode 100644 index e0bd014c9..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Tokens/GetHighestWeightedTokenTest.php +++ /dev/null @@ -1,162 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Tokens; - -use PHP_CodeSniffer\Util\Tokens; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Tokens::getHighestWeightedToken() method. - * - * @covers \PHP_CodeSniffer\Util\Tokens::getHighestWeightedToken - */ -final class GetHighestWeightedTokenTest extends TestCase -{ - - - /** - * Test the method. - * - * @param array $tokens The tokens to find the heighest weighted one. - * @param int|false $expected The expected function return value. - * - * @dataProvider dataGetHighestWeightedToken - * - * @return void - */ - public function testGetHighestWeightedToken($tokens, $expected) - { - $this->assertSame($expected, Tokens::getHighestWeightedToken($tokens)); - - }//end testGetHighestWeightedToken() - - - /** - * Data provider. - * - * @return array>> - */ - public static function dataGetHighestWeightedToken() - { - $data = [ - 'Array of non-tokens passed, returns first' => [ - 'tokens' => [ - PHP_SAPI, - PHP_MAJOR_VERSION, - PHP_OS, - ], - 'expected' => PHP_SAPI, - ], - 'No weightings available for any of the selected tokens, first one wins' => [ - 'tokens' => [ - T_VARIABLE, - T_STRING, - T_EXTENDS, - T_IMPLEMENTS, - ], - 'expected' => T_VARIABLE, - ], - 'single token always returns that token' => [ - 'tokens' => [T_VARIABLE], - 'expected' => T_VARIABLE, - ], - 'Unknown and known token, known token wins' => [ - 'tokens' => [ - T_VARIABLE, - T_SELF, - ], - 'expected' => T_SELF, - ], - 'Known and unknown token, known token wins' => [ - 'tokens' => [ - T_CLOSURE, - T_STRING, - ], - 'expected' => T_CLOSURE, - ], - 'Two tokens with equal weights passed, first one wins' => [ - 'tokens' => [ - T_CLOSURE, - T_FUNCTION, - ], - 'expected' => T_CLOSURE, - ], - 'Five tokens with equal weights passed, first one wins' => [ - 'tokens' => [ - T_NAMESPACE, - T_TRAIT, - T_ENUM, - T_CLASS, - T_INTERFACE, - ], - 'expected' => T_NAMESPACE, - ], - 'Tokens with different weights passed, heightest (25) wins' => [ - 'tokens' => [ - T_BITWISE_OR, - T_SELF, - T_MUL_EQUAL, - ], - 'expected' => T_SELF, - ], - 'Tokens with different weights passed, heightest (50) wins' => [ - 'tokens' => [ - T_BITWISE_XOR, - T_CATCH, - T_SPACESHIP, - T_PARENT, - ], - 'expected' => T_CATCH, - ], - ]; - - $high100 = [ - T_MULTIPLY, - T_BITWISE_AND, - T_SELF, - T_FOREACH, - T_CLOSURE, - ]; - $data['Tokens with different weights passed, ordered low-high, heightest (100) wins'] = [ - 'tokens' => $high100, - 'expected' => T_CLOSURE, - ]; - - shuffle($high100); - $data['Tokens with different weights passed, order random, heightest (100) wins'] = [ - 'tokens' => $high100, - 'expected' => T_CLOSURE, - ]; - - $high1000 = [ - T_ENUM, - T_FUNCTION, - T_ELSEIF, - T_PARENT, - T_BITWISE_OR, - T_MODULUS, - ]; - $data['Tokens with different weights passed, ordered low-high, heightest (1000) wins'] = [ - 'tokens' => $high1000, - 'expected' => T_ENUM, - ]; - - shuffle($high1000); - $data['Tokens with different weights passed, order random, heightest (1000) wins'] = [ - 'tokens' => $high1000, - 'expected' => T_ENUM, - ]; - - return $data; - - }//end dataGetHighestWeightedToken() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Tokens/TokenNameTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Tokens/TokenNameTest.php deleted file mode 100644 index 43c6d695b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Core/Util/Tokens/TokenNameTest.php +++ /dev/null @@ -1,197 +0,0 @@ - - * @copyright 2024 PHPCSStandards and contributors - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Core\Util\Tokens; - -use PHP_CodeSniffer\Util\Tokens; -use PHPUnit\Framework\TestCase; - -/** - * Tests for the \PHP_CodeSniffer\Util\Tokens::tokenName() method. - * - * @covers \PHP_CodeSniffer\Util\Tokens::tokenName - */ -final class TokenNameTest extends TestCase -{ - - - /** - * Test the method. - * - * @param int|string $tokenCode The PHP/PHPCS token code to get the name for. - * @param string $expected The expected token name. - * - * @dataProvider dataTokenName - * @dataProvider dataPolyfilledPHPNativeTokens - * - * @return void - */ - public function testTokenName($tokenCode, $expected) - { - $this->assertSame($expected, Tokens::tokenName($tokenCode)); - - }//end testTokenName() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataTokenName() - { - return [ - 'PHP native token: T_ECHO' => [ - 'tokenCode' => T_ECHO, - 'expected' => 'T_ECHO', - ], - 'PHP native token: T_FUNCTION' => [ - 'tokenCode' => T_FUNCTION, - 'expected' => 'T_FUNCTION', - ], - 'PHPCS native token: T_CLOSURE' => [ - 'tokenCode' => T_CLOSURE, - 'expected' => 'T_CLOSURE', - ], - 'PHPCS native token: T_STRING_CONCAT' => [ - 'tokenCode' => T_STRING_CONCAT, - 'expected' => 'T_STRING_CONCAT', - ], - - // Document the current behaviour for invalid input. - // This behaviour is subject to change. - 'Non-token integer passed' => [ - 'tokenCode' => 100000, - 'expected' => 'UNKNOWN', - ], - 'Non-token string passed' => [ - 'tokenCode' => 'something', - 'expected' => 'ing', - ], - ]; - - }//end dataTokenName() - - - /** - * Data provider. - * - * @return array> - */ - public static function dataPolyfilledPHPNativeTokens() - { - return [ - 'PHP 5.5 native token, polyfilled: T_FINALLY' => [ - 'tokenCode' => T_FINALLY, - 'expected' => 'T_FINALLY', - ], - 'PHP 5.5 native token, polyfilled: T_YIELD' => [ - 'tokenCode' => T_YIELD, - 'expected' => 'T_YIELD', - ], - - 'PHP 5.6 native token, polyfilled: T_ELLIPSIS' => [ - 'tokenCode' => T_ELLIPSIS, - 'expected' => 'T_ELLIPSIS', - ], - 'PHP 5.6 native token, polyfilled: T_POW' => [ - 'tokenCode' => T_POW, - 'expected' => 'T_POW', - ], - 'PHP 5.6 native token, polyfilled: T_POW_EQUAL' => [ - 'tokenCode' => T_POW_EQUAL, - 'expected' => 'T_POW_EQUAL', - ], - - 'PHP 7.0 native token, polyfilled: T_SPACESHIP' => [ - 'tokenCode' => T_SPACESHIP, - 'expected' => 'T_SPACESHIP', - ], - 'PHP 7.0 native token, polyfilled: T_COALESCE' => [ - 'tokenCode' => T_COALESCE, - 'expected' => 'T_COALESCE', - ], - 'PHP 7.0 native token, polyfilled: T_YIELD_FROM' => [ - 'tokenCode' => T_YIELD_FROM, - 'expected' => 'T_YIELD_FROM', - ], - - 'PHP 7.4 native token, polyfilled: T_COALESCE_EQUAL' => [ - 'tokenCode' => T_COALESCE_EQUAL, - 'expected' => 'T_COALESCE_EQUAL', - ], - 'PHP 7.4 native token, polyfilled: T_BAD_CHARACTER' => [ - 'tokenCode' => T_BAD_CHARACTER, - 'expected' => 'T_BAD_CHARACTER', - ], - 'PHP 7.4 native token, polyfilled: T_FN' => [ - 'tokenCode' => T_FN, - 'expected' => 'T_FN', - ], - - 'PHP 8.0 native token, polyfilled: T_NULLSAFE_OBJECT_OPERATOR' => [ - 'tokenCode' => T_NULLSAFE_OBJECT_OPERATOR, - 'expected' => 'T_NULLSAFE_OBJECT_OPERATOR', - ], - 'PHP 8.0 native token, polyfilled: T_NAME_QUALIFIED' => [ - 'tokenCode' => T_NAME_QUALIFIED, - 'expected' => 'T_NAME_QUALIFIED', - ], - 'PHP 8.0 native token, polyfilled: T_NAME_FULLY_QUALIFIED' => [ - 'tokenCode' => T_NAME_FULLY_QUALIFIED, - 'expected' => 'T_NAME_FULLY_QUALIFIED', - ], - 'PHP 8.0 native token, polyfilled: T_NAME_RELATIVE' => [ - 'tokenCode' => T_NAME_RELATIVE, - 'expected' => 'T_NAME_RELATIVE', - ], - 'PHP 8.0 native token, polyfilled: T_MATCH' => [ - 'tokenCode' => T_MATCH, - 'expected' => 'T_MATCH', - ], - 'PHP 8.0 native token, polyfilled: T_ATTRIBUTE' => [ - 'tokenCode' => T_ATTRIBUTE, - 'expected' => 'T_ATTRIBUTE', - ], - - 'PHP 8.1 native token, polyfilled: T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG' => [ - 'tokenCode' => T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG, - 'expected' => 'T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG', - ], - 'PHP 8.1 native token, polyfilled: T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG' => [ - 'tokenCode' => T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG, - 'expected' => 'T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG', - ], - 'PHP 8.1 native token, polyfilled: T_READONLY' => [ - 'tokenCode' => T_READONLY, - 'expected' => 'T_READONLY', - ], - 'PHP 8.1 native token, polyfilled: T_ENUM' => [ - 'tokenCode' => T_ENUM, - 'expected' => 'T_ENUM', - ], - - 'PHP 8.4 native token, polyfilled: T_PUBLIC_SET' => [ - 'tokenCode' => T_PUBLIC_SET, - 'expected' => 'T_PUBLIC_SET', - ], - 'PHP 8.4 native token, polyfilled: T_PROTECTED_SET' => [ - 'tokenCode' => T_PROTECTED_SET, - 'expected' => 'T_PROTECTED_SET', - ], - 'PHP 8.4 native token, polyfilled: T_PRIVATE_SET' => [ - 'tokenCode' => T_PRIVATE_SET, - 'expected' => 'T_PRIVATE_SET', - ], - ]; - - }//end dataPolyfilledPHPNativeTokens() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc deleted file mode 100644 index 700fe7a7b..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc +++ /dev/null @@ -1,18 +0,0 @@ - - - The coding standard for end to end tests. - - - - . - - - - - - diff --git a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/exit_code_test.sh b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/exit_code_test.sh new file mode 100644 index 000000000..ced50e0a2 --- /dev/null +++ b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/exit_code_test.sh @@ -0,0 +1,73 @@ +#!/usr/bin/env bash + +function tear_down() { + rm -f tests/EndToEnd/Fixtures/*.fixed +} + +function test_phpcs_exit_code_clean_file() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc + assert_exit_code 0 +} +function test_phpcs_exit_code_clean_stdin() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc + assert_exit_code 0 +} +function test_phpcbf_exit_code_clean_file() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc + assert_exit_code 0 +} +function test_phpcbf_exit_code_clean_stdin() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc + assert_exit_code 0 +} + +function test_phpcs_exit_code_fixable_file() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithStyleError.inc + assert_exit_code 1 +} +function test_phpcs_exit_code_fixable_stdin() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassWithStyleError.inc + assert_exit_code 1 +} +function test_phpcbf_exit_code_fixable_file() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithStyleError.inc + assert_exit_code 0 +} +function test_phpcbf_exit_code_fixable_stdin() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassWithStyleError.inc + assert_exit_code 0 +} + +function test_phpcs_exit_code_non_fixable_file() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithUnfixableStyleError.inc + assert_exit_code 2 +} +function test_phpcs_exit_code_non_fixable_stdin() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassWithUnfixableStyleError.inc + assert_exit_code 2 +} +function test_phpcbf_exit_code_non_fixable_file() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithUnfixableStyleError.inc + assert_exit_code 2 +} +function test_phpcbf_exit_code_non_fixable_stdin() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassWithUnfixableStyleError.inc + assert_exit_code 2 +} + +function test_phpcs_exit_code_fixable_and_non_fixable_file() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithTwoStyleErrors.inc + assert_exit_code 3 +} +function test_phpcs_exit_code_fixable_and_non_fixable_stdin() { + bin/phpcs --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassWithTwoStyleErrors.inc + assert_exit_code 3 +} +function test_phpcbf_exit_code_fixable_and_non_fixable_file() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithTwoStyleErrors.inc + assert_exit_code 2 +} +function test_phpcbf_exit_code_fixable_and_non_fixable_stdin() { + bin/phpcbf --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist < tests/EndToEnd/Fixtures/ClassWithTwoStyleErrors.inc + assert_exit_code 2 +} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/outofmemory_test.sh b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/outofmemory_test.sh new file mode 100644 index 000000000..01e66cccc --- /dev/null +++ b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/outofmemory_test.sh @@ -0,0 +1,25 @@ +#!/usr/bin/env bash + +function tear_down() { + rm -f tests/EndToEnd/Fixtures/*.fixed +} + +function test_phpcs_out_of_memory_error_handling() { + OUTPUT="$( { bin/phpcs -d memory_limit=4M --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/; } 2>&1)" + # The exact exit code is not our concern, just that it's non-zero. + assert_unsuccessful_code + + assert_contains "The PHP_CodeSniffer \"phpcs\" command ran out of memory." "$OUTPUT" + assert_contains "Either raise the \"memory_limit\" of PHP in the php.ini file or raise the memory limit at runtime" "$OUTPUT" + assert_contains "using \"phpcs -d memory_limit=512M\" (replace 512M with the desired memory limit)." "$OUTPUT" +} + +function test_phpcbf_out_of_memory_error_handling() { + OUTPUT="$( { bin/phpcbf -d memory_limit=4M --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ --suffix=.fixed; } 2>&1)" + # The exact exit code is not our concern, just that it's non-zero. + assert_unsuccessful_code + + assert_contains "The PHP_CodeSniffer \"phpcbf\" command ran out of memory." "$OUTPUT" + assert_contains "Either raise the \"memory_limit\" of PHP in the php.ini file or raise the memory limit at runtime" "$OUTPUT" + assert_contains "using \"phpcbf -d memory_limit=512M\" (replace 512M with the desired memory limit)." "$OUTPUT" +} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcbf_test.sh b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcbf_test.sh index 388683234..4343f1eaa 100644 --- a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcbf_test.sh +++ b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcbf_test.sh @@ -1,31 +1,38 @@ #!/usr/bin/env bash function tear_down() { - rm -r tests/EndToEnd/Fixtures/*.fixed + rm -rf tests/EndToEnd/Fixtures/*.fixed } function test_phpcbf_is_working() { - OUTPUT="$(bin/phpcbf --no-cache --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc tests/EndToEnd/Fixtures/ClassTwoWithoutStyleError.inc)" + OUTPUT="$( { bin/phpcbf --no-cache --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc tests/EndToEnd/Fixtures/ClassTwoWithoutStyleError.inc; } 2>&1 )" assert_successful_code assert_contains "No violations were found" "$OUTPUT" } function test_phpcbf_is_working_in_parallel() { - OUTPUT="$(bin/phpcbf --no-cache --parallel=2 --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc tests/EndToEnd/Fixtures/ClassTwoWithoutStyleError.inc)" + OUTPUT="$( { bin/phpcbf --no-cache --parallel=2 --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassOneWithoutStyleError.inc tests/EndToEnd/Fixtures/ClassTwoWithoutStyleError.inc; } 2>&1 )" assert_successful_code assert_contains "No violations were found" "$OUTPUT" } function test_phpcbf_returns_error_on_issues() { - OUTPUT="$(bin/phpcbf --no-colors --no-cache --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithStyleError.inc)" - assert_exit_code 1 + OUTPUT="$( { bin/phpcbf --no-colors --parallel=1 --no-cache --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithStyleError.inc; } 2>&1 )" + assert_successful_code assert_contains "F 1 / 1 (100%)" "$OUTPUT" assert_contains "A TOTAL OF 1 ERROR WERE FIXED IN 1 FILE" "$OUTPUT" } +function test_phpcbf_progressbar_shows_fixes_with_parallel_on() { + OUTPUT="$( { bin/phpcbf --no-colors --parallel=10 --no-cache --suffix=.fixed --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithStyleError.inc; } 2>&1 )" + assert_successful_code + + assert_contains "F 1 / 1 (100%)" "$OUTPUT" +} + function test_phpcbf_bug_1112() { # See https://github.com/PHPCSStandards/PHP_CodeSniffer/issues/1112 if [[ "$(uname)" == "Darwin" ]]; then diff --git a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcs_test.sh b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcs_test.sh index 3bdf41708..dcc643b03 100644 --- a/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcs_test.sh +++ b/app/vendor/squizlabs/php_codesniffer/tests/EndToEnd/phpcs_test.sh @@ -9,8 +9,8 @@ function test_phpcs_is_working_in_parallel() { } function test_phpcs_returns_error_on_issues() { - OUTPUT="$(bin/phpcs --no-colors --no-cache --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithStyleError.inc)" - assert_exit_code 2 + OUTPUT="$( { bin/phpcs --no-colors --no-cache --standard=tests/EndToEnd/Fixtures/endtoend.xml.dist tests/EndToEnd/Fixtures/ClassWithStyleError.inc; } 2>&1 )" + assert_exit_code 1 assert_contains "E 1 / 1 (100%)" "$OUTPUT" assert_contains "FOUND 1 ERROR AFFECTING 1 LINE" "$OUTPUT" diff --git a/app/vendor/squizlabs/php_codesniffer/tests/FileList.php b/app/vendor/squizlabs/php_codesniffer/tests/FileList.php deleted file mode 100644 index ac3c944f3..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/FileList.php +++ /dev/null @@ -1,98 +0,0 @@ - - * @copyright 2019 Juliette Reinders Folmer. All rights reserved. - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests; - -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; -use RegexIterator; - -class FileList -{ - - /** - * The path to the project root directory. - * - * @var string - */ - protected $rootPath; - - /** - * Recursive directory iterator. - * - * @var \DirectoryIterator - */ - public $fileIterator; - - /** - * Base regex to use if no filter regex is provided. - * - * Matches based on: - * - File path starts with the project root (replacement done in constructor). - * - Don't match .git/ files. - * - Don't match dot files, i.e. "." or "..". - * - Don't match backup files. - * - Match everything else in a case-insensitive manner. - * - * @var string - */ - private $baseRegex = '`^%s(?!\.git/)(?!(.*/)?\.+$)(?!.*\.(bak|orig)).*$`Dix'; - - - /** - * Constructor. - * - * @param string $directory The directory to examine. - * @param string $rootPath Path to the project root. - * @param string $filter PCRE regular expression to filter the file list with. - */ - public function __construct($directory, $rootPath='', $filter='') - { - $this->rootPath = $rootPath; - - $directory = new RecursiveDirectoryIterator( - $directory, - RecursiveDirectoryIterator::UNIX_PATHS - ); - $flattened = new RecursiveIteratorIterator( - $directory, - RecursiveIteratorIterator::LEAVES_ONLY, - RecursiveIteratorIterator::CATCH_GET_CHILD - ); - - if ($filter === '') { - $filter = sprintf($this->baseRegex, preg_quote($this->rootPath)); - } - - $this->fileIterator = new RegexIterator($flattened, $filter); - - return $this; - - }//end __construct() - - - /** - * Retrieve the filtered file list as an array. - * - * @return array - */ - public function getList() - { - $fileList = []; - - foreach ($this->fileIterator as $file) { - $fileList[] = str_replace($this->rootPath, '', $file); - } - - return $fileList; - - }//end getList() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Standards/AbstractSniffTestCase.php b/app/vendor/squizlabs/php_codesniffer/tests/Standards/AbstractSniffTestCase.php new file mode 100644 index 000000000..c97c5b8c2 --- /dev/null +++ b/app/vendor/squizlabs/php_codesniffer/tests/Standards/AbstractSniffTestCase.php @@ -0,0 +1,470 @@ + + * @copyright 2006-2023 Squiz Pty Ltd (ABN 77 084 670 600) + * @copyright 2023 PHPCSStandards and contributors + * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/licence.txt BSD Licence + */ + +namespace PHP_CodeSniffer\Tests\Standards; + +use DirectoryIterator; +use PHP_CodeSniffer\Config; +use PHP_CodeSniffer\Exceptions\RuntimeException; +use PHP_CodeSniffer\Files\LocalFile; +use PHP_CodeSniffer\Ruleset; +use PHP_CodeSniffer\Tests\ConfigDouble; +use PHP_CodeSniffer\Util\Common; +use PHPUnit\Framework\TestCase; +use ReflectionClass; + +abstract class AbstractSniffTestCase extends TestCase +{ + + /** + * Ruleset template with placeholders. + * + * @var string + */ + private const RULESET_TEMPLATE = <<<'TEMPLATE' + + + Temporary ruleset used by the AbstractSniffUnitTest class. + + + + +TEMPLATE; + + /** + * Placeholders used in the ruleset template which need to be replaced. + * + * @var array + */ + private const SEARCH_FOR = [ + '[STANDARDNAME]', + '[SNIFFFILEREF]', + ]; + + /** + * Location where the temporary ruleset file will be saved. + * + * @var string + */ + private const RULESET_FILENAME = __DIR__ . '/sniffStnd.xml'; + + /** + * Cache for the Config object. + * + * @var \PHP_CodeSniffer\Tests\ConfigDouble + */ + private static $config; + + /** + * Extensions to disregard when gathering the test files. + * + * @var array + */ + private $ignoreExtensions = [ + 'php' => 'php', + 'fixed' => 'fixed', + 'bak' => 'bak', + 'orig' => 'orig', + ]; + + + /** + * Clean up temporary ruleset file. + * + * @return void + */ + public static function tearDownAfterClass(): void + { + @unlink(self::RULESET_FILENAME); + } + + + /** + * Get a list of all test files to check. + * + * These will have the same base as the sniff name but different extensions. + * We ignore the .php file as it is the test class. + * + * @param string $testFileBase The base path that the unit tests files will have. + * + * @return string[] + */ + protected function getTestFiles(string $testFileBase) + { + $testFiles = []; + + $dir = dirname($testFileBase); + $di = new DirectoryIterator($dir); + + foreach ($di as $file) { + $path = $file->getPathname(); + if (substr($path, 0, strlen($testFileBase)) === $testFileBase) { + $extension = $file->getExtension(); + if (isset($this->ignoreExtensions[$extension]) === false) { + $testFiles[] = $path; + } + } + } + + // Put them in order. + sort($testFiles, SORT_NATURAL); + + return $testFiles; + } + + + /** + * Should this test be skipped for some reason. + * + * @return boolean + */ + protected function shouldSkipTest() + { + return false; + } + + + /** + * Tests the extending classes Sniff class. + * + * @return void + * + * @throws \PHP_CodeSniffer\Exceptions\RuntimeException + */ + final public function testSniff() + { + // Skip this test if we can't run in this environment. + if ($this->shouldSkipTest() === true) { + $this->markTestSkipped(); + } + + $sniffCode = Common::getSniffCode(static::class); + $sniffCodeParts = explode('.', $sniffCode); + $standardName = $sniffCodeParts[0]; + + $testFileBase = (new ReflectionClass(static::class))->getFileName(); + $testFileBase = substr($testFileBase, 0, -3); + + // Get a list of all test files to check. + $testFiles = $this->getTestFiles($testFileBase); + if (empty($testFiles) === true) { + $this->markTestIncomplete('No test case files found for ' . static::class); + } + + $sniffFile = preg_replace('`[/\\\\]Tests[/\\\\]`', DIRECTORY_SEPARATOR . 'Sniffs' . DIRECTORY_SEPARATOR, $testFileBase); + $sniffFile = str_replace('UnitTest.', 'Sniff.php', $sniffFile); + + if (file_exists($sniffFile) === false) { + $this->fail(sprintf('ERROR: Sniff file %s for test %s does not appear to exist', $sniffFile, static::class)); + } + + $replacements = [ + $standardName, + $sniffFile, + ]; + $rulesetContents = str_replace(self::SEARCH_FOR, $replacements, self::RULESET_TEMPLATE); + + if (file_put_contents(self::RULESET_FILENAME, $rulesetContents) === false) { + throw new RuntimeException('Failed to write custom ruleset file'); + } + + if (isset(self::$config) === true) { + $config = self::$config; + } else { + $config = new ConfigDouble(); + $config->cache = false; + self::$config = $config; + } + + $config->standards = [self::RULESET_FILENAME]; + $config->sniffs = [$sniffCode]; + $config->ignored = []; + + $ruleset = new Ruleset($config); + + $failureMessages = []; + foreach ($testFiles as $testFile) { + $filename = basename($testFile); + $oldConfig = $config->getSettings(); + + try { + $this->setCliValues($filename, $config); + $phpcsFile = new LocalFile($testFile, $ruleset, $config); + $phpcsFile->process(); + } catch (RuntimeException $e) { + $this->fail('An unexpected exception has been caught: ' . $e->getMessage()); + } + + $failures = $this->generateFailureMessages($phpcsFile); + $failureMessages = array_merge($failureMessages, $failures); + + if ($phpcsFile->getFixableCount() > 0) { + // Attempt to fix the errors. + $phpcsFile->fixer->fixFile(); + $fixable = $phpcsFile->getFixableCount(); + if ($fixable > 0) { + $failureMessages[] = "Failed to fix $fixable fixable violations in $filename"; + } + + // Check for a .fixed file to check for accuracy of fixes. + $fixedFile = $testFile . '.fixed'; + $filename = basename($testFile); + if (file_exists($fixedFile) === true) { + if ($phpcsFile->fixer->getContents() !== file_get_contents($fixedFile)) { + // Only generate the (expensive) diff if a difference is expected. + $diff = $phpcsFile->fixer->generateDiff($fixedFile); + if (trim($diff) !== '') { + $fixedFilename = basename($fixedFile); + $failureMessages[] = "Fixed version of $filename does not match expected version in $fixedFilename; the diff is\n$diff"; + } + } + } else { + $diff = trim($phpcsFile->fixer->generateDiff($testFile)); + $failureMessages[] = "Missing fixed version of $filename to verify the accuracy of fixes, while the sniff is making fixes against the test case file; the diff is\n$diff"; + } + } + + // Restore the config. + $config->setSettings($oldConfig); + } + + if (empty($failureMessages) === false) { + $this->fail(implode(PHP_EOL, $failureMessages)); + } + } + + + /** + * Generate a list of test failures for a given sniffed file. + * + * @param \PHP_CodeSniffer\Files\LocalFile $file The file being tested. + * + * @return array + * @throws \PHP_CodeSniffer\Exceptions\RuntimeException + */ + public function generateFailureMessages(LocalFile $file) + { + $testFile = $file->getFilename(); + + $foundErrors = $file->getErrors(); + $foundWarnings = $file->getWarnings(); + $expectedErrors = $this->getErrorList(basename($testFile)); + $expectedWarnings = $this->getWarningList(basename($testFile)); + + if (is_array($expectedErrors) === false) { + throw new RuntimeException('getErrorList() must return an array'); + } + + if (is_array($expectedWarnings) === false) { + throw new RuntimeException('getWarningList() must return an array'); + } + + /* + We merge errors and warnings together to make it easier + to iterate over them and produce the errors string. In this way, + we can report on errors and warnings in the same line even though + it's not really structured to allow that. + */ + + $allProblems = []; + $failureMessages = []; + + foreach ($foundErrors as $line => $lineErrors) { + foreach ($lineErrors as $column => $errors) { + if (isset($allProblems[$line]) === false) { + $allProblems[$line] = [ + 'expected_errors' => 0, + 'expected_warnings' => 0, + 'found_errors' => [], + 'found_warnings' => [], + ]; + } + + $foundErrorsTemp = []; + foreach ($allProblems[$line]['found_errors'] as $foundError) { + $foundErrorsTemp[] = $foundError; + } + + $errorsTemp = []; + foreach ($errors as $foundError) { + $errorsTemp[] = $foundError['message'] . ' (' . $foundError['source'] . ')'; + } + + $allProblems[$line]['found_errors'] = array_merge($foundErrorsTemp, $errorsTemp); + } + + if (isset($expectedErrors[$line]) === true) { + $allProblems[$line]['expected_errors'] = $expectedErrors[$line]; + } else { + $allProblems[$line]['expected_errors'] = 0; + } + + unset($expectedErrors[$line]); + } + + foreach ($expectedErrors as $line => $numErrors) { + if (isset($allProblems[$line]) === false) { + $allProblems[$line] = [ + 'expected_errors' => 0, + 'expected_warnings' => 0, + 'found_errors' => [], + 'found_warnings' => [], + ]; + } + + $allProblems[$line]['expected_errors'] = $numErrors; + } + + foreach ($foundWarnings as $line => $lineWarnings) { + foreach ($lineWarnings as $column => $warnings) { + if (isset($allProblems[$line]) === false) { + $allProblems[$line] = [ + 'expected_errors' => 0, + 'expected_warnings' => 0, + 'found_errors' => [], + 'found_warnings' => [], + ]; + } + + $foundWarningsTemp = []; + foreach ($allProblems[$line]['found_warnings'] as $foundWarning) { + $foundWarningsTemp[] = $foundWarning; + } + + $warningsTemp = []; + foreach ($warnings as $warning) { + $warningsTemp[] = $warning['message'] . ' (' . $warning['source'] . ')'; + } + + $allProblems[$line]['found_warnings'] = array_merge($foundWarningsTemp, $warningsTemp); + } + + if (isset($expectedWarnings[$line]) === true) { + $allProblems[$line]['expected_warnings'] = $expectedWarnings[$line]; + } else { + $allProblems[$line]['expected_warnings'] = 0; + } + + unset($expectedWarnings[$line]); + } + + foreach ($expectedWarnings as $line => $numWarnings) { + if (isset($allProblems[$line]) === false) { + $allProblems[$line] = [ + 'expected_errors' => 0, + 'expected_warnings' => 0, + 'found_errors' => [], + 'found_warnings' => [], + ]; + } + + $allProblems[$line]['expected_warnings'] = $numWarnings; + } + + // Order the messages by line number. + ksort($allProblems); + + foreach ($allProblems as $line => $problems) { + $numErrors = count($problems['found_errors']); + $numWarnings = count($problems['found_warnings']); + $expectedErrors = $problems['expected_errors']; + $expectedWarnings = $problems['expected_warnings']; + + $errors = ''; + $foundString = ''; + + if ($expectedErrors !== $numErrors || $expectedWarnings !== $numWarnings) { + $lineMessage = "[LINE $line]"; + $expectedMessage = 'Expected '; + $foundMessage = 'in ' . basename($testFile) . ' but found '; + + if ($expectedErrors !== $numErrors) { + $expectedMessage .= "$expectedErrors error(s)"; + $foundMessage .= "$numErrors error(s)"; + if ($numErrors !== 0) { + $foundString .= 'error(s)'; + $errors .= implode(PHP_EOL . ' -> ', $problems['found_errors']); + } + + if ($expectedWarnings !== $numWarnings) { + $expectedMessage .= ' and '; + $foundMessage .= ' and '; + if ($numWarnings !== 0) { + if ($foundString !== '') { + $foundString .= ' and '; + } + } + } + } + + if ($expectedWarnings !== $numWarnings) { + $expectedMessage .= "$expectedWarnings warning(s)"; + $foundMessage .= "$numWarnings warning(s)"; + if ($numWarnings !== 0) { + $foundString .= 'warning(s)'; + if (empty($errors) === false) { + $errors .= PHP_EOL . ' -> '; + } + + $errors .= implode(PHP_EOL . ' -> ', $problems['found_warnings']); + } + } + + $fullMessage = "$lineMessage $expectedMessage $foundMessage."; + if ($errors !== '') { + $fullMessage .= " The $foundString found were:" . PHP_EOL . " -> $errors"; + } + + $failureMessages[] = $fullMessage; + } + } + + return $failureMessages; + } + + + /** + * Get a list of CLI values to set before the file is tested. + * + * @param string $testFile The name of the file being tested. + * @param \PHP_CodeSniffer\Config $config The config data for the run. + * + * @return void + */ + public function setCliValues(string $testFile, Config $config) + { + } + + + /** + * Returns the lines where errors should occur. + * + * The key of the array should represent the line number and the value + * should represent the number of errors that should occur on that line. + * + * @return array + */ + abstract protected function getErrorList(); + + + /** + * Returns the lines where warnings should occur. + * + * The key of the array should represent the line number and the value + * should represent the number of warnings that should occur on that line. + * + * @return array + */ + abstract protected function getWarningList(); +} diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Standards/AbstractSniffUnitTest.php b/app/vendor/squizlabs/php_codesniffer/tests/Standards/AbstractSniffUnitTest.php deleted file mode 100644 index ccd90c513..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Standards/AbstractSniffUnitTest.php +++ /dev/null @@ -1,468 +0,0 @@ - - * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Standards; - -use DirectoryIterator; -use PHP_CodeSniffer\Exceptions\RuntimeException; -use PHP_CodeSniffer\Files\LocalFile; -use PHP_CodeSniffer\Ruleset; -use PHP_CodeSniffer\Tests\ConfigDouble; -use PHP_CodeSniffer\Util\Common; -use PHPUnit\Framework\TestCase; - -abstract class AbstractSniffUnitTest extends TestCase -{ - - /** - * Enable or disable the backup and restoration of the $GLOBALS array. - * Overwrite this attribute in a child class of TestCase. - * Setting this attribute in setUp() has no effect! - * - * @var boolean - */ - protected $backupGlobals = false; - - /** - * The path to the standard's main directory. - * - * @var string - */ - public $standardsDir = null; - - /** - * The path to the standard's test directory. - * - * @var string - */ - public $testsDir = null; - - - /** - * Sets up this unit test. - * - * @before - * - * @return void - */ - protected function setUpPrerequisites() - { - $class = get_class($this); - $this->standardsDir = $GLOBALS['PHP_CODESNIFFER_STANDARD_DIRS'][$class]; - $this->testsDir = $GLOBALS['PHP_CODESNIFFER_TEST_DIRS'][$class]; - - }//end setUpPrerequisites() - - - /** - * Get a list of all test files to check. - * - * These will have the same base as the sniff name but different extensions. - * We ignore the .php file as it is the class. - * - * @param string $testFileBase The base path that the unit tests files will have. - * - * @return string[] - */ - protected function getTestFiles($testFileBase) - { - $testFiles = []; - - $dir = substr($testFileBase, 0, strrpos($testFileBase, DIRECTORY_SEPARATOR)); - $di = new DirectoryIterator($dir); - - foreach ($di as $file) { - $path = $file->getPathname(); - if (substr($path, 0, strlen($testFileBase)) === $testFileBase) { - if ($path !== $testFileBase.'php' && substr($path, -5) !== 'fixed' && substr($path, -4) !== '.bak') { - $testFiles[] = $path; - } - } - } - - // Put them in order. - sort($testFiles, SORT_NATURAL); - - return $testFiles; - - }//end getTestFiles() - - - /** - * Should this test be skipped for some reason. - * - * @return boolean - */ - protected function shouldSkipTest() - { - return false; - - }//end shouldSkipTest() - - - /** - * Tests the extending classes Sniff class. - * - * @return void - * @throws \PHPUnit\Framework\Exception - */ - final public function testSniff() - { - // Skip this test if we can't run in this environment. - if ($this->shouldSkipTest() === true) { - $this->markTestSkipped(); - } - - $sniffCode = Common::getSniffCode(get_class($this)); - list($standardName, $categoryName, $sniffName) = explode('.', $sniffCode); - - $testFileBase = $this->testsDir.$categoryName.DIRECTORY_SEPARATOR.$sniffName.'UnitTest.'; - - // Get a list of all test files to check. - $testFiles = $this->getTestFiles($testFileBase); - $GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES'][] = $testFiles; - - if (isset($GLOBALS['PHP_CODESNIFFER_CONFIG']) === true) { - $config = $GLOBALS['PHP_CODESNIFFER_CONFIG']; - } else { - $config = new ConfigDouble(); - $config->cache = false; - $GLOBALS['PHP_CODESNIFFER_CONFIG'] = $config; - } - - $config->standards = [$standardName]; - $config->sniffs = [$sniffCode]; - $config->ignored = []; - - if (isset($GLOBALS['PHP_CODESNIFFER_RULESETS']) === false) { - $GLOBALS['PHP_CODESNIFFER_RULESETS'] = []; - } - - if (isset($GLOBALS['PHP_CODESNIFFER_RULESETS'][$standardName]) === false) { - $ruleset = new Ruleset($config); - $GLOBALS['PHP_CODESNIFFER_RULESETS'][$standardName] = $ruleset; - } - - $ruleset = $GLOBALS['PHP_CODESNIFFER_RULESETS'][$standardName]; - - $sniffFile = $this->standardsDir.DIRECTORY_SEPARATOR.'Sniffs'.DIRECTORY_SEPARATOR.$categoryName.DIRECTORY_SEPARATOR.$sniffName.'Sniff.php'; - - $sniffClassName = substr(get_class($this), 0, -8).'Sniff'; - $sniffClassName = str_replace('\Tests\\', '\Sniffs\\', $sniffClassName); - $sniffClassName = Common::cleanSniffClass($sniffClassName); - - $restrictions = [strtolower($sniffClassName) => true]; - $ruleset->registerSniffs([$sniffFile], $restrictions, []); - $ruleset->populateTokenListeners(); - - $failureMessages = []; - foreach ($testFiles as $testFile) { - $filename = basename($testFile); - $oldConfig = $config->getSettings(); - - try { - $this->setCliValues($filename, $config); - $phpcsFile = new LocalFile($testFile, $ruleset, $config); - $phpcsFile->process(); - } catch (RuntimeException $e) { - $this->fail('An unexpected exception has been caught: '.$e->getMessage()); - } - - $failures = $this->generateFailureMessages($phpcsFile); - $failureMessages = array_merge($failureMessages, $failures); - - if ($phpcsFile->getFixableCount() > 0) { - // Attempt to fix the errors. - $phpcsFile->fixer->fixFile(); - $fixable = $phpcsFile->getFixableCount(); - if ($fixable > 0) { - $failureMessages[] = "Failed to fix $fixable fixable violations in $filename"; - } - - // Check for a .fixed file to check for accuracy of fixes. - $fixedFile = $testFile.'.fixed'; - $filename = basename($testFile); - if (file_exists($fixedFile) === true) { - if ($phpcsFile->fixer->getContents() !== file_get_contents($fixedFile)) { - // Only generate the (expensive) diff if a difference is expected. - $diff = $phpcsFile->fixer->generateDiff($fixedFile); - if (trim($diff) !== '') { - $fixedFilename = basename($fixedFile); - $failureMessages[] = "Fixed version of $filename does not match expected version in $fixedFilename; the diff is\n$diff"; - } - } - } else if (is_callable([$this, 'addWarning']) === true) { - $this->addWarning("Missing fixed version of $filename to verify the accuracy of fixes, while the sniff is making fixes against the test case file"); - } - }//end if - - // Restore the config. - $config->setSettings($oldConfig); - }//end foreach - - if (empty($failureMessages) === false) { - $this->fail(implode(PHP_EOL, $failureMessages)); - } - - }//end testSniff() - - - /** - * Generate a list of test failures for a given sniffed file. - * - * @param \PHP_CodeSniffer\Files\LocalFile $file The file being tested. - * - * @return array - * @throws \PHP_CodeSniffer\Exceptions\RuntimeException - */ - public function generateFailureMessages(LocalFile $file) - { - $testFile = $file->getFilename(); - - $foundErrors = $file->getErrors(); - $foundWarnings = $file->getWarnings(); - $expectedErrors = $this->getErrorList(basename($testFile)); - $expectedWarnings = $this->getWarningList(basename($testFile)); - - if (is_array($expectedErrors) === false) { - throw new RuntimeException('getErrorList() must return an array'); - } - - if (is_array($expectedWarnings) === false) { - throw new RuntimeException('getWarningList() must return an array'); - } - - /* - We merge errors and warnings together to make it easier - to iterate over them and produce the errors string. In this way, - we can report on errors and warnings in the same line even though - it's not really structured to allow that. - */ - - $allProblems = []; - $failureMessages = []; - - foreach ($foundErrors as $line => $lineErrors) { - foreach ($lineErrors as $column => $errors) { - if (isset($allProblems[$line]) === false) { - $allProblems[$line] = [ - 'expected_errors' => 0, - 'expected_warnings' => 0, - 'found_errors' => [], - 'found_warnings' => [], - ]; - } - - $foundErrorsTemp = []; - foreach ($allProblems[$line]['found_errors'] as $foundError) { - $foundErrorsTemp[] = $foundError; - } - - $errorsTemp = []; - foreach ($errors as $foundError) { - $errorsTemp[] = $foundError['message'].' ('.$foundError['source'].')'; - - $source = $foundError['source']; - if (in_array($source, $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES'], true) === false) { - $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES'][] = $source; - } - - if ($foundError['fixable'] === true - && in_array($source, $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES'], true) === false - ) { - $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES'][] = $source; - } - } - - $allProblems[$line]['found_errors'] = array_merge($foundErrorsTemp, $errorsTemp); - }//end foreach - - if (isset($expectedErrors[$line]) === true) { - $allProblems[$line]['expected_errors'] = $expectedErrors[$line]; - } else { - $allProblems[$line]['expected_errors'] = 0; - } - - unset($expectedErrors[$line]); - }//end foreach - - foreach ($expectedErrors as $line => $numErrors) { - if (isset($allProblems[$line]) === false) { - $allProblems[$line] = [ - 'expected_errors' => 0, - 'expected_warnings' => 0, - 'found_errors' => [], - 'found_warnings' => [], - ]; - } - - $allProblems[$line]['expected_errors'] = $numErrors; - } - - foreach ($foundWarnings as $line => $lineWarnings) { - foreach ($lineWarnings as $column => $warnings) { - if (isset($allProblems[$line]) === false) { - $allProblems[$line] = [ - 'expected_errors' => 0, - 'expected_warnings' => 0, - 'found_errors' => [], - 'found_warnings' => [], - ]; - } - - $foundWarningsTemp = []; - foreach ($allProblems[$line]['found_warnings'] as $foundWarning) { - $foundWarningsTemp[] = $foundWarning; - } - - $warningsTemp = []; - foreach ($warnings as $warning) { - $warningsTemp[] = $warning['message'].' ('.$warning['source'].')'; - - $source = $warning['source']; - if (in_array($source, $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES'], true) === false) { - $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES'][] = $source; - } - - if ($warning['fixable'] === true - && in_array($source, $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES'], true) === false - ) { - $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES'][] = $source; - } - } - - $allProblems[$line]['found_warnings'] = array_merge($foundWarningsTemp, $warningsTemp); - }//end foreach - - if (isset($expectedWarnings[$line]) === true) { - $allProblems[$line]['expected_warnings'] = $expectedWarnings[$line]; - } else { - $allProblems[$line]['expected_warnings'] = 0; - } - - unset($expectedWarnings[$line]); - }//end foreach - - foreach ($expectedWarnings as $line => $numWarnings) { - if (isset($allProblems[$line]) === false) { - $allProblems[$line] = [ - 'expected_errors' => 0, - 'expected_warnings' => 0, - 'found_errors' => [], - 'found_warnings' => [], - ]; - } - - $allProblems[$line]['expected_warnings'] = $numWarnings; - } - - // Order the messages by line number. - ksort($allProblems); - - foreach ($allProblems as $line => $problems) { - $numErrors = count($problems['found_errors']); - $numWarnings = count($problems['found_warnings']); - $expectedErrors = $problems['expected_errors']; - $expectedWarnings = $problems['expected_warnings']; - - $errors = ''; - $foundString = ''; - - if ($expectedErrors !== $numErrors || $expectedWarnings !== $numWarnings) { - $lineMessage = "[LINE $line]"; - $expectedMessage = 'Expected '; - $foundMessage = 'in '.basename($testFile).' but found '; - - if ($expectedErrors !== $numErrors) { - $expectedMessage .= "$expectedErrors error(s)"; - $foundMessage .= "$numErrors error(s)"; - if ($numErrors !== 0) { - $foundString .= 'error(s)'; - $errors .= implode(PHP_EOL.' -> ', $problems['found_errors']); - } - - if ($expectedWarnings !== $numWarnings) { - $expectedMessage .= ' and '; - $foundMessage .= ' and '; - if ($numWarnings !== 0) { - if ($foundString !== '') { - $foundString .= ' and '; - } - } - } - } - - if ($expectedWarnings !== $numWarnings) { - $expectedMessage .= "$expectedWarnings warning(s)"; - $foundMessage .= "$numWarnings warning(s)"; - if ($numWarnings !== 0) { - $foundString .= 'warning(s)'; - if (empty($errors) === false) { - $errors .= PHP_EOL.' -> '; - } - - $errors .= implode(PHP_EOL.' -> ', $problems['found_warnings']); - } - } - - $fullMessage = "$lineMessage $expectedMessage $foundMessage."; - if ($errors !== '') { - $fullMessage .= " The $foundString found were:".PHP_EOL." -> $errors"; - } - - $failureMessages[] = $fullMessage; - }//end if - }//end foreach - - return $failureMessages; - - }//end generateFailureMessages() - - - /** - * Get a list of CLI values to set before the file is tested. - * - * @param string $filename The name of the file being tested. - * @param \PHP_CodeSniffer\Config $config The config data for the run. - * - * @return void - */ - public function setCliValues($filename, $config) - { - - }//end setCliValues() - - - /** - * Returns the lines where errors should occur. - * - * The key of the array should represent the line number and the value - * should represent the number of errors that should occur on that line. - * - * @return array - */ - abstract protected function getErrorList(); - - - /** - * Returns the lines where warnings should occur. - * - * The key of the array should represent the line number and the value - * should represent the number of warnings that should occur on that line. - * - * @return array - */ - abstract protected function getWarningList(); - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/Standards/AllSniffs.php b/app/vendor/squizlabs/php_codesniffer/tests/Standards/AllSniffs.php deleted file mode 100644 index 1e273e28e..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/Standards/AllSniffs.php +++ /dev/null @@ -1,114 +0,0 @@ - - * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests\Standards; - -use PHP_CodeSniffer\Autoload; -use PHP_CodeSniffer\Util\Standards; -use PHPUnit\Framework\TestSuite; -use PHPUnit\TextUI\TestRunner; -use RecursiveDirectoryIterator; -use RecursiveIteratorIterator; - -class AllSniffs -{ - - - /** - * Prepare the test runner. - * - * @return void - */ - public static function main() - { - TestRunner::run(self::suite()); - - }//end main() - - - /** - * Add all sniff unit tests into a test suite. - * - * Sniff unit tests are found by recursing through the 'Tests' directory - * of each installed coding standard. - * - * @return \PHPUnit\Framework\TestSuite - */ - public static function suite() - { - $GLOBALS['PHP_CODESNIFFER_SNIFF_CODES'] = []; - $GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES'] = []; - $GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES'] = []; - - $suite = new TestSuite('PHP CodeSniffer Standards'); - - // Optionally allow for ignoring the tests for one or more standards. - $ignoreTestsForStandards = getenv('PHPCS_IGNORE_TESTS'); - if ($ignoreTestsForStandards === false) { - $ignoreTestsForStandards = []; - } else { - $ignoreTestsForStandards = explode(',', $ignoreTestsForStandards); - } - - $installedStandards = self::getInstalledStandardDetails(); - - foreach ($installedStandards as $standard => $details) { - Autoload::addSearchPath($details['path'], $details['namespace']); - - if (in_array($standard, $ignoreTestsForStandards, true) === true) { - continue; - } - - $testsDir = $details['path'].DIRECTORY_SEPARATOR.'Tests'.DIRECTORY_SEPARATOR; - if (is_dir($testsDir) === false) { - // No tests for this standard. - continue; - } - - $di = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($testsDir)); - - foreach ($di as $file) { - // Skip hidden files. - if (substr($file->getFilename(), 0, 1) === '.') { - continue; - } - - // Tests must have the extension 'php'. - $parts = explode('.', $file); - $ext = array_pop($parts); - if ($ext !== 'php') { - continue; - } - - $className = Autoload::loadFile($file->getPathname()); - $GLOBALS['PHP_CODESNIFFER_STANDARD_DIRS'][$className] = $details['path']; - $GLOBALS['PHP_CODESNIFFER_TEST_DIRS'][$className] = $testsDir; - $suite->addTestSuite($className); - } - }//end foreach - - return $suite; - - }//end suite() - - - /** - * Get the details of all coding standards installed. - * - * @return array - * @see Standards::getInstalledStandardDetails() - */ - protected static function getInstalledStandardDetails() - { - return Standards::getInstalledStandardDetails(true); - - }//end getInstalledStandardDetails() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/TestSuite.php b/app/vendor/squizlabs/php_codesniffer/tests/TestSuite.php deleted file mode 100644 index 4598a8562..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/TestSuite.php +++ /dev/null @@ -1,35 +0,0 @@ - - * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests; - -use PHPUnit\Framework\TestResult; -use PHPUnit\Framework\TestSuite as PHPUnit_TestSuite; - -class TestSuite extends PHPUnit_TestSuite -{ - - - /** - * Runs the tests and collects their result in a TestResult. - * - * @param \PHPUnit\Framework\TestResult $result A test result. - * - * @return \PHPUnit\Framework\TestResult - */ - public function run(TestResult $result=null) - { - $result = parent::run($result); - printPHPCodeSnifferTestOutput(); - return $result; - - }//end run() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/TestSuite7.php b/app/vendor/squizlabs/php_codesniffer/tests/TestSuite7.php deleted file mode 100644 index ad0947c58..000000000 --- a/app/vendor/squizlabs/php_codesniffer/tests/TestSuite7.php +++ /dev/null @@ -1,35 +0,0 @@ - - * @copyright 2006-2015 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence - */ - -namespace PHP_CodeSniffer\Tests; - -use PHPUnit\Framework\TestResult; -use PHPUnit\Framework\TestSuite as PHPUnit_TestSuite; - -class TestSuite extends PHPUnit_TestSuite -{ - - - /** - * Runs the tests and collects their result in a TestResult. - * - * @param \PHPUnit\Framework\TestResult|null $result A test result. - * - * @return \PHPUnit\Framework\TestResult - */ - public function run(?TestResult $result=null): TestResult - { - $result = parent::run($result); - printPHPCodeSnifferTestOutput(); - return $result; - - }//end run() - - -}//end class diff --git a/app/vendor/squizlabs/php_codesniffer/tests/bootstrap.php b/app/vendor/squizlabs/php_codesniffer/tests/bootstrap.php index e8ebdbbdd..b4c054e96 100644 --- a/app/vendor/squizlabs/php_codesniffer/tests/bootstrap.php +++ b/app/vendor/squizlabs/php_codesniffer/tests/bootstrap.php @@ -3,10 +3,15 @@ * Bootstrap file for PHP_CodeSniffer unit tests. * * @author Greg Sherwood - * @copyright 2006-2017 Squiz Pty Ltd (ABN 77 084 670 600) - * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence + * @copyright 2006-2023 Squiz Pty Ltd (ABN 77 084 670 600) + * @copyright 2023 PHPCSStandards and contributors + * @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/HEAD/licence.txt BSD Licence */ +use PHP_CodeSniffer\Autoload; +use PHP_CodeSniffer\Util\Standards; +use PHP_CodeSniffer\Util\Tokens; + if (defined('PHP_CODESNIFFER_IN_TESTS') === false) { define('PHP_CODESNIFFER_IN_TESTS', true); } @@ -27,10 +32,10 @@ $cbfMode = getenv('PHP_CODESNIFFER_CBF'); if ($cbfMode === '1') { define('PHP_CODESNIFFER_CBF', true); - echo 'Note: Tests are running in "CBF" mode'.PHP_EOL.PHP_EOL; + echo 'Note: Tests are running in "CBF" mode' . PHP_EOL . PHP_EOL; } else { define('PHP_CODESNIFFER_CBF', false); - echo 'Note: Tests are running in "CS" mode'.PHP_EOL.PHP_EOL; + echo 'Note: Tests are running in "CS" mode' . PHP_EOL . PHP_EOL; } } @@ -38,62 +43,12 @@ define('PHP_CODESNIFFER_VERBOSITY', 0); } -require_once __DIR__.'/../autoload.php'; - -$tokens = new \PHP_CodeSniffer\Util\Tokens(); - -// Compatibility for PHPUnit < 6 and PHPUnit 6+. -if (class_exists('PHPUnit_Framework_TestSuite') === true && class_exists('PHPUnit\Framework\TestSuite') === false) { - class_alias('PHPUnit_Framework_TestSuite', 'PHPUnit'.'\Framework\TestSuite'); -} - -if (class_exists('PHPUnit_Framework_TestCase') === true && class_exists('PHPUnit\Framework\TestCase') === false) { - class_alias('PHPUnit_Framework_TestCase', 'PHPUnit'.'\Framework\TestCase'); -} +require_once __DIR__ . '/../autoload.php'; -if (class_exists('PHPUnit_TextUI_TestRunner') === true && class_exists('PHPUnit\TextUI\TestRunner') === false) { - class_alias('PHPUnit_TextUI_TestRunner', 'PHPUnit'.'\TextUI\TestRunner'); +// Make sure all installed standards are autoloadable. +$installedStandards = Standards::getInstalledStandardDetails(); +foreach ($installedStandards as $standardDetails) { + Autoload::addSearchPath($standardDetails['path'], $standardDetails['namespace']); } -if (class_exists('PHPUnit_Framework_TestResult') === true && class_exists('PHPUnit\Framework\TestResult') === false) { - class_alias('PHPUnit_Framework_TestResult', 'PHPUnit'.'\Framework\TestResult'); -} - - -/** - * A global util function to help print unit test fixing data. - * - * @return void - */ -function printPHPCodeSnifferTestOutput() -{ - echo PHP_EOL.PHP_EOL; - - $output = 'The test files'; - $data = []; - - $codeCount = count($GLOBALS['PHP_CODESNIFFER_SNIFF_CODES']); - if (empty($GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES']) === false) { - $files = call_user_func_array('array_merge', $GLOBALS['PHP_CODESNIFFER_SNIFF_CASE_FILES']); - $files = array_unique($files); - $fileCount = count($files); - - $output = '%d sniff test files'; - $data[] = $fileCount; - } - - $output .= ' generated %d unique error codes'; - $data[] = $codeCount; - - if ($codeCount > 0) { - $fixes = count($GLOBALS['PHP_CODESNIFFER_FIXABLE_CODES']); - $percent = round(($fixes / $codeCount * 100), 2); - - $output .= '; %d were fixable (%d%%)'; - $data[] = $fixes; - $data[] = $percent; - } - - vprintf($output, $data); - -}//end printPHPCodeSnifferTestOutput() +$tokens = new Tokens(); diff --git a/app/vendor/symfony/config/Builder/ClassBuilder.php b/app/vendor/symfony/config/Builder/ClassBuilder.php deleted file mode 100644 index 5ae8bda16..000000000 --- a/app/vendor/symfony/config/Builder/ClassBuilder.php +++ /dev/null @@ -1,169 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Builder; - -/** - * Build PHP classes to generate config. - * - * @internal - * - * @author Tobias Nyholm - */ -class ClassBuilder -{ - private string $name; - - /** @var Property[] */ - private array $properties = []; - - /** @var Method[] */ - private array $methods = []; - private array $require = []; - private array $use = []; - private array $implements = []; - private bool $allowExtraKeys = false; - - public function __construct( - private string $namespace, - string $name, - ) { - $this->name = ucfirst($this->camelCase($name)).'Config'; - } - - public function getDirectory(): string - { - return str_replace('\\', \DIRECTORY_SEPARATOR, $this->namespace); - } - - public function getFilename(): string - { - return $this->name.'.php'; - } - - public function build(): string - { - $rootPath = explode(\DIRECTORY_SEPARATOR, $this->getDirectory()); - $require = ''; - foreach ($this->require as $class) { - // figure out relative path. - $path = explode(\DIRECTORY_SEPARATOR, $class->getDirectory()); - $path[] = $class->getFilename(); - foreach ($rootPath as $key => $value) { - if ($path[$key] !== $value) { - break; - } - unset($path[$key]); - } - $require .= \sprintf('require_once __DIR__.\DIRECTORY_SEPARATOR.\'%s\';', implode('\'.\DIRECTORY_SEPARATOR.\'', $path))."\n"; - } - $use = $require ? "\n" : ''; - foreach (array_keys($this->use) as $statement) { - $use .= \sprintf('use %s;', $statement)."\n"; - } - - $implements = [] === $this->implements ? '' : 'implements '.implode(', ', $this->implements); - $body = ''; - foreach ($this->properties as $property) { - $body .= ' '.$property->getContent()."\n"; - } - foreach ($this->methods as $method) { - $lines = explode("\n", $method->getContent()); - foreach ($lines as $line) { - $body .= ($line ? ' '.$line : '')."\n"; - } - } - - return strtr(' $this->namespace, 'REQUIRE' => $require, 'USE' => $use, 'CLASS' => $this->getName(), 'IMPLEMENTS' => $implements, 'BODY' => $body]); - } - - public function addRequire(self $class): void - { - $this->require[] = $class; - } - - public function addUse(string $class): void - { - $this->use[$class] = true; - } - - public function addImplements(string $interface): void - { - $this->implements[] = '\\'.ltrim($interface, '\\'); - } - - public function addMethod(string $name, string $body, array $params = []): void - { - $this->methods[] = new Method(strtr($body, ['NAME' => $this->camelCase($name)] + $params)); - } - - public function addProperty(string $name, ?string $classType = null, ?string $defaultValue = null): Property - { - $property = new Property($name, '_' !== $name[0] ? $this->camelCase($name) : $name); - if (null !== $classType) { - $property->setType($classType); - } - $this->properties[] = $property; - $defaultValue = null !== $defaultValue ? \sprintf(' = %s', $defaultValue) : ''; - $property->setContent(\sprintf('private $%s%s;', $property->getName(), $defaultValue)); - - return $property; - } - - public function getProperties(): array - { - return $this->properties; - } - - private function camelCase(string $input): string - { - $output = lcfirst(str_replace(' ', '', ucwords(str_replace('_', ' ', $input)))); - - return preg_replace('#\W#', '', $output); - } - - public function getName(): string - { - return $this->name; - } - - public function getNamespace(): string - { - return $this->namespace; - } - - public function getFqcn(): string - { - return '\\'.$this->namespace.'\\'.$this->name; - } - - public function setAllowExtraKeys(bool $allowExtraKeys): void - { - $this->allowExtraKeys = $allowExtraKeys; - } - - public function shouldAllowExtraKeys(): bool - { - return $this->allowExtraKeys; - } -} diff --git a/app/vendor/symfony/config/Builder/ConfigBuilderGenerator.php b/app/vendor/symfony/config/Builder/ConfigBuilderGenerator.php deleted file mode 100644 index d76899016..000000000 --- a/app/vendor/symfony/config/Builder/ConfigBuilderGenerator.php +++ /dev/null @@ -1,609 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Builder; - -use Symfony\Component\Config\Definition\ArrayNode; -use Symfony\Component\Config\Definition\BaseNode; -use Symfony\Component\Config\Definition\BooleanNode; -use Symfony\Component\Config\Definition\Builder\ExprBuilder; -use Symfony\Component\Config\Definition\ConfigurationInterface; -use Symfony\Component\Config\Definition\EnumNode; -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; -use Symfony\Component\Config\Definition\FloatNode; -use Symfony\Component\Config\Definition\IntegerNode; -use Symfony\Component\Config\Definition\NodeInterface; -use Symfony\Component\Config\Definition\PrototypedArrayNode; -use Symfony\Component\Config\Definition\ScalarNode; -use Symfony\Component\Config\Definition\VariableNode; -use Symfony\Component\Config\Loader\ParamConfigurator; - -/** - * Generate ConfigBuilders to help create valid config. - * - * @author Tobias Nyholm - */ -class ConfigBuilderGenerator implements ConfigBuilderGeneratorInterface -{ - /** - * @var ClassBuilder[] - */ - private array $classes = []; - - public function __construct( - private string $outputDir, - ) { - } - - /** - * @return \Closure that will return the root config class - */ - public function build(ConfigurationInterface $configuration): \Closure - { - $this->classes = []; - - $rootNode = $configuration->getConfigTreeBuilder()->buildTree(); - $rootClass = new ClassBuilder('Symfony\\Config', $rootNode->getName()); - - $path = $this->getFullPath($rootClass); - if (!is_file($path)) { - // Generate the class if the file not exists - $this->classes[] = $rootClass; - $this->buildNode($rootNode, $rootClass, $this->getSubNamespace($rootClass)); - $rootClass->addImplements(ConfigBuilderInterface::class); - $rootClass->addMethod('getExtensionAlias', ' -public function NAME(): string -{ - return \'ALIAS\'; -}', ['ALIAS' => $rootNode->getPath()]); - - $this->writeClasses(); - } - - return function () use ($path, $rootClass) { - require_once $path; - $className = $rootClass->getFqcn(); - - return new $className(); - }; - } - - private function getFullPath(ClassBuilder $class): string - { - $directory = $this->outputDir.\DIRECTORY_SEPARATOR.$class->getDirectory(); - if (!is_dir($directory)) { - @mkdir($directory, 0777, true); - } - - return $directory.\DIRECTORY_SEPARATOR.$class->getFilename(); - } - - private function writeClasses(): void - { - foreach ($this->classes as $class) { - $this->buildConstructor($class); - $this->buildToArray($class); - if ($class->getProperties()) { - $class->addProperty('_usedProperties', null, '[]'); - } - $this->buildSetExtraKey($class); - - file_put_contents($this->getFullPath($class), $class->build()); - } - - $this->classes = []; - } - - private function buildNode(NodeInterface $node, ClassBuilder $class, string $namespace): void - { - if (!$node instanceof ArrayNode) { - throw new \LogicException('The node was expected to be an ArrayNode. This Configuration includes an edge case not supported yet.'); - } - - foreach ($node->getChildren() as $child) { - match (true) { - $child instanceof ScalarNode => $this->handleScalarNode($child, $class), - $child instanceof PrototypedArrayNode => $this->handlePrototypedArrayNode($child, $class, $namespace), - $child instanceof VariableNode => $this->handleVariableNode($child, $class), - $child instanceof ArrayNode => $this->handleArrayNode($child, $class, $namespace), - default => throw new \RuntimeException(\sprintf('Unknown node "%s".', $child::class)), - }; - } - } - - private function handleArrayNode(ArrayNode $node, ClassBuilder $class, string $namespace): void - { - $childClass = new ClassBuilder($namespace, $node->getName()); - $childClass->setAllowExtraKeys($node->shouldIgnoreExtraKeys()); - $class->addRequire($childClass); - $this->classes[] = $childClass; - - $nodeTypes = $this->getParameterTypes($node); - $paramType = $this->getParamType($nodeTypes); - - $hasNormalizationClosures = $this->hasNormalizationClosures($node); - $comment = $this->getComment($node); - if ($hasNormalizationClosures && 'array' !== $paramType) { - $comment = \sprintf(" * @template TValue of %s\n * @param TValue \$value\n%s", $paramType, $comment); - $comment .= \sprintf(' * @return %s|$this'."\n", $childClass->getFqcn()); - $comment .= \sprintf(' * @psalm-return (TValue is array ? %s : static)'."\n ", $childClass->getFqcn()); - } - if ('' !== $comment) { - $comment = "/**\n$comment*/\n"; - } - - $property = $class->addProperty( - $node->getName(), - $this->getType($childClass->getFqcn(), $hasNormalizationClosures) - ); - $body = $hasNormalizationClosures && 'array' !== $paramType ? ' -COMMENTpublic function NAME(PARAM_TYPE $value = []): CLASS|static -{ - if (!\is_array($value)) { - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY = $value; - - return $this; - } - - if (!$this->PROPERTY instanceof CLASS) { - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY = new CLASS($value); - } elseif (0 < \func_num_args()) { - throw new InvalidConfigurationException(\'The node created by "NAME()" has already been initialized. You cannot pass values the second time you call NAME().\'); - } - - return $this->PROPERTY; -}' : ' -COMMENTpublic function NAME(array $value = []): CLASS -{ - if (null === $this->PROPERTY) { - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY = new CLASS($value); - } elseif (0 < \func_num_args()) { - throw new InvalidConfigurationException(\'The node created by "NAME()" has already been initialized. You cannot pass values the second time you call NAME().\'); - } - - return $this->PROPERTY; -}'; - $class->addUse(InvalidConfigurationException::class); - $class->addMethod($node->getName(), $body, [ - 'COMMENT' => $comment, - 'PROPERTY' => $property->getName(), - 'CLASS' => $childClass->getFqcn(), - 'PARAM_TYPE' => $paramType, - ]); - - $this->buildNode($node, $childClass, $this->getSubNamespace($childClass)); - } - - private function handleVariableNode(VariableNode $node, ClassBuilder $class): void - { - $comment = $this->getComment($node); - $property = $class->addProperty($node->getName()); - $class->addUse(ParamConfigurator::class); - - $body = ' -/** -COMMENT * - * @return $this - */ -public function NAME(mixed $valueDEFAULT): static -{ - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY = $value; - - return $this; -}'; - $class->addMethod($node->getName(), $body, [ - 'PROPERTY' => $property->getName(), - 'COMMENT' => $comment, - 'DEFAULT' => $node->hasDefaultValue() ? ' = '.var_export($node->getDefaultValue(), true) : '', - ]); - } - - private function handlePrototypedArrayNode(PrototypedArrayNode $node, ClassBuilder $class, string $namespace): void - { - $name = $this->getSingularName($node); - $prototype = $node->getPrototype(); - $methodName = $name; - $hasNormalizationClosures = $this->hasNormalizationClosures($node) || $this->hasNormalizationClosures($prototype); - - $nodeParameterTypes = $this->getParameterTypes($node); - $prototypeParameterTypes = $this->getParameterTypes($prototype); - $noKey = null === $key = $node->getKeyAttribute(); - if (!$prototype instanceof ArrayNode || ($prototype instanceof PrototypedArrayNode && $prototype->getPrototype() instanceof ScalarNode)) { - $class->addUse(ParamConfigurator::class); - $property = $class->addProperty($node->getName()); - if ($noKey) { - // This is an array of values; don't use singular name - $nodeTypesWithoutArray = array_filter($nodeParameterTypes, static fn ($type) => 'array' !== $type); - $body = ' -/** - * @param ParamConfigurator|listEXTRA_TYPE $value - * - * @return $this - */ -public function NAME(PARAM_TYPE $value): static -{ - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY = $value; - - return $this; -}'; - - $class->addMethod($node->getName(), $body, [ - 'PROPERTY' => $property->getName(), - 'PROTOTYPE_TYPE' => implode('|', $prototypeParameterTypes), - 'EXTRA_TYPE' => $nodeTypesWithoutArray ? '|'.implode('|', $nodeTypesWithoutArray) : '', - 'PARAM_TYPE' => $this->getParamType($nodeParameterTypes, true), - ]); - } else { - $body = ' -/** - * @return $this - */ -public function NAME(string $VAR, TYPE $VALUE): static -{ - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY[$VAR] = $VALUE; - - return $this; -}'; - - $class->addMethod($methodName, $body, [ - 'PROPERTY' => $property->getName(), - 'TYPE' => $this->getParamType($prototypeParameterTypes, true), - 'VAR' => '' === $key ? 'key' : $key, - 'VALUE' => 'value' === $key ? 'data' : 'value', - ]); - } - - return; - } - - $childClass = new ClassBuilder($namespace, $name); - if ($prototype instanceof ArrayNode) { - $childClass->setAllowExtraKeys($prototype->shouldIgnoreExtraKeys()); - } - $class->addRequire($childClass); - $this->classes[] = $childClass; - - $property = $class->addProperty( - $node->getName(), - $this->getType($childClass->getFqcn().'[]', $hasNormalizationClosures) - ); - - $paramType = $this->getParamType($noKey ? $nodeParameterTypes : $prototypeParameterTypes); - - $comment = $this->getComment($node); - if ($hasNormalizationClosures && 'array' !== $paramType) { - $comment = \sprintf(" * @template TValue of %s\n * @param TValue \$value\n%s", $paramType, $comment); - $comment .= \sprintf(' * @return %s|$this'."\n", $childClass->getFqcn()); - $comment .= \sprintf(' * @psalm-return (TValue is array ? %s : static)'."\n ", $childClass->getFqcn()); - } - if ('' !== $comment) { - $comment = "/**\n$comment*/\n"; - } - - if ($noKey) { - $body = $hasNormalizationClosures && 'array' !== $paramType ? ' -COMMENTpublic function NAME(PARAM_TYPE $value = []): CLASS|static -{ - $this->_usedProperties[\'PROPERTY\'] = true; - if (!\is_array($value)) { - $this->PROPERTY[] = $value; - - return $this; - } - - return $this->PROPERTY[] = new CLASS($value); -}' : ' -COMMENTpublic function NAME(array $value = []): CLASS -{ - $this->_usedProperties[\'PROPERTY\'] = true; - - return $this->PROPERTY[] = new CLASS($value); -}'; - $class->addMethod($methodName, $body, [ - 'COMMENT' => $comment, - 'PROPERTY' => $property->getName(), - 'CLASS' => $childClass->getFqcn(), - 'PARAM_TYPE' => $paramType, - ]); - } else { - $body = $hasNormalizationClosures && 'array' !== $paramType ? ' -COMMENTpublic function NAME(string $VAR, PARAM_TYPE $VALUE = []): CLASS|static -{ - if (!\is_array($VALUE)) { - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY[$VAR] = $VALUE; - - return $this; - } - - if (!isset($this->PROPERTY[$VAR]) || !$this->PROPERTY[$VAR] instanceof CLASS) { - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY[$VAR] = new CLASS($VALUE); - } elseif (1 < \func_num_args()) { - throw new InvalidConfigurationException(\'The node created by "NAME()" has already been initialized. You cannot pass values the second time you call NAME().\'); - } - - return $this->PROPERTY[$VAR]; -}' : ' -COMMENTpublic function NAME(string $VAR, array $VALUE = []): CLASS -{ - if (!isset($this->PROPERTY[$VAR])) { - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY[$VAR] = new CLASS($VALUE); - } elseif (1 < \func_num_args()) { - throw new InvalidConfigurationException(\'The node created by "NAME()" has already been initialized. You cannot pass values the second time you call NAME().\'); - } - - return $this->PROPERTY[$VAR]; -}'; - $class->addUse(InvalidConfigurationException::class); - $class->addMethod($methodName, str_replace('$value', '$VAR', $body), [ - 'COMMENT' => $comment, 'PROPERTY' => $property->getName(), - 'CLASS' => $childClass->getFqcn(), - 'VAR' => '' === $key ? 'key' : $key, - 'VALUE' => 'value' === $key ? 'data' : 'value', - 'PARAM_TYPE' => $paramType, - ]); - } - - $this->buildNode($prototype, $childClass, $namespace.'\\'.$childClass->getName()); - } - - private function handleScalarNode(ScalarNode $node, ClassBuilder $class): void - { - $comment = $this->getComment($node); - $property = $class->addProperty($node->getName()); - $class->addUse(ParamConfigurator::class); - - $body = ' -/** -COMMENT * @return $this - */ -public function NAME($value): static -{ - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY = $value; - - return $this; -}'; - - $class->addMethod($node->getName(), $body, ['PROPERTY' => $property->getName(), 'COMMENT' => $comment]); - } - - private function getParameterTypes(NodeInterface $node): array - { - $paramTypes = []; - if ($node instanceof BaseNode) { - $types = $node->getNormalizedTypes(); - if (\in_array(ExprBuilder::TYPE_ANY, $types, true)) { - $paramTypes[] = 'mixed'; - } - if (\in_array(ExprBuilder::TYPE_STRING, $types, true)) { - $paramTypes[] = 'string'; - } - } - if ($node instanceof BooleanNode) { - $paramTypes[] = 'bool'; - } elseif ($node instanceof IntegerNode) { - $paramTypes[] = 'int'; - } elseif ($node instanceof FloatNode) { - $paramTypes[] = 'float'; - } elseif ($node instanceof EnumNode) { - $paramTypes[] = 'mixed'; - } elseif ($node instanceof ArrayNode) { - $paramTypes[] = 'array'; - } elseif ($node instanceof VariableNode) { - $paramTypes[] = 'mixed'; - } - - return array_unique($paramTypes); - } - - private function getComment(BaseNode $node): string - { - $comment = ''; - if ('' !== $info = (string) $node->getInfo()) { - $comment .= $info."\n"; - } - - if (!$node instanceof ArrayNode) { - foreach ((array) ($node->getExample() ?? []) as $example) { - $comment .= '@example '.$example."\n"; - } - - if ('' !== $default = $node->getDefaultValue()) { - $comment .= '@default '.(null === $default ? 'null' : var_export($default, true))."\n"; - } - - if ($node instanceof EnumNode) { - $comment .= \sprintf('@param ParamConfigurator|%s $value', implode('|', array_unique(array_map(fn ($a) => !$a instanceof \UnitEnum ? var_export($a, true) : '\\'.ltrim(var_export($a, true), '\\'), $node->getValues()))))."\n"; - } else { - $parameterTypes = $this->getParameterTypes($node); - $comment .= '@param ParamConfigurator|'.implode('|', $parameterTypes).' $value'."\n"; - } - } else { - foreach ((array) ($node->getExample() ?? []) as $example) { - $comment .= '@example '.json_encode($example)."\n"; - } - - if ($node->hasDefaultValue() && [] != $default = $node->getDefaultValue()) { - $comment .= '@default '.json_encode($default)."\n"; - } - } - - if ($node->isDeprecated()) { - $comment .= '@deprecated '.$node->getDeprecation($node->getName(), $node->getParent()->getName())['message']."\n"; - } - - return $comment ? ' * '.str_replace("\n", "\n * ", rtrim($comment, "\n"))."\n" : ''; - } - - /** - * Pick a good singular name. - */ - private function getSingularName(PrototypedArrayNode $node): string - { - $name = $node->getName(); - if (!str_ends_with($name, 's')) { - return $name; - } - - $parent = $node->getParent(); - $mappings = $parent instanceof ArrayNode ? $parent->getXmlRemappings() : []; - foreach ($mappings as $map) { - if ($map[1] === $name) { - $name = $map[0]; - break; - } - } - - return $name; - } - - private function buildToArray(ClassBuilder $class): void - { - $body = '$output = [];'; - foreach ($class->getProperties() as $p) { - $code = '$this->PROPERTY'; - if (null !== $p->getType()) { - if ($p->isArray()) { - $code = $p->areScalarsAllowed() - ? 'array_map(fn ($v) => $v instanceof CLASS ? $v->toArray() : $v, $this->PROPERTY)' - : 'array_map(fn ($v) => $v->toArray(), $this->PROPERTY)' - ; - } else { - $code = $p->areScalarsAllowed() - ? '$this->PROPERTY instanceof CLASS ? $this->PROPERTY->toArray() : $this->PROPERTY' - : '$this->PROPERTY->toArray()' - ; - } - } - - $body .= strtr(' - if (isset($this->_usedProperties[\'PROPERTY\'])) { - $output[\'ORG_NAME\'] = '.$code.'; - }', ['PROPERTY' => $p->getName(), 'ORG_NAME' => $p->getOriginalName(), 'CLASS' => $p->getType()]); - } - - $extraKeys = $class->shouldAllowExtraKeys() ? ' + $this->_extraKeys' : ''; - - $class->addMethod('toArray', ' -public function NAME(): array -{ - '.$body.' - - return $output'.$extraKeys.'; -}'); - } - - private function buildConstructor(ClassBuilder $class): void - { - $body = ''; - foreach ($class->getProperties() as $p) { - $code = '$value[\'ORG_NAME\']'; - if (null !== $p->getType()) { - if ($p->isArray()) { - $code = $p->areScalarsAllowed() - ? 'array_map(fn ($v) => \is_array($v) ? new '.$p->getType().'($v) : $v, $value[\'ORG_NAME\'])' - : 'array_map(fn ($v) => new '.$p->getType().'($v), $value[\'ORG_NAME\'])' - ; - } else { - $code = $p->areScalarsAllowed() - ? '\is_array($value[\'ORG_NAME\']) ? new '.$p->getType().'($value[\'ORG_NAME\']) : $value[\'ORG_NAME\']' - : 'new '.$p->getType().'($value[\'ORG_NAME\'])' - ; - } - } - - $body .= strtr(' - if (array_key_exists(\'ORG_NAME\', $value)) { - $this->_usedProperties[\'PROPERTY\'] = true; - $this->PROPERTY = '.$code.'; - unset($value[\'ORG_NAME\']); - } -', ['PROPERTY' => $p->getName(), 'ORG_NAME' => $p->getOriginalName()]); - } - - if ($class->shouldAllowExtraKeys()) { - $body .= ' - $this->_extraKeys = $value; -'; - } else { - $body .= ' - if ([] !== $value) { - throw new InvalidConfigurationException(sprintf(\'The following keys are not supported by "%s": \', __CLASS__).implode(\', \', array_keys($value))); - }'; - - $class->addUse(InvalidConfigurationException::class); - } - - $class->addMethod('__construct', ' -public function __construct(array $value = []) -{'.$body.' -}'); - } - - private function buildSetExtraKey(ClassBuilder $class): void - { - if (!$class->shouldAllowExtraKeys()) { - return; - } - - $class->addUse(ParamConfigurator::class); - - $class->addProperty('_extraKeys'); - - $class->addMethod('set', ' -/** - * @param ParamConfigurator|mixed $value - * - * @return $this - */ -public function NAME(string $key, mixed $value): static -{ - $this->_extraKeys[$key] = $value; - - return $this; -}'); - } - - private function getSubNamespace(ClassBuilder $rootClass): string - { - return \sprintf('%s\\%s', $rootClass->getNamespace(), substr($rootClass->getName(), 0, -6)); - } - - private function hasNormalizationClosures(NodeInterface $node): bool - { - try { - $r = new \ReflectionProperty($node, 'normalizationClosures'); - } catch (\ReflectionException) { - return false; - } - - return [] !== $r->getValue($node); - } - - private function getType(string $classType, bool $hasNormalizationClosures): string - { - return $classType.($hasNormalizationClosures ? '|scalar' : ''); - } - - private function getParamType(array $types, bool $withParamConfigurator = false): string - { - return \in_array('mixed', $types, true) ? 'mixed' : ($withParamConfigurator ? 'ParamConfigurator|' : '').implode('|', $types); - } -} diff --git a/app/vendor/symfony/config/Builder/ConfigBuilderGeneratorInterface.php b/app/vendor/symfony/config/Builder/ConfigBuilderGeneratorInterface.php deleted file mode 100644 index c52c9e5d5..000000000 --- a/app/vendor/symfony/config/Builder/ConfigBuilderGeneratorInterface.php +++ /dev/null @@ -1,27 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Builder; - -use Symfony\Component\Config\Definition\ConfigurationInterface; - -/** - * Generates ConfigBuilders to help create valid config. - * - * @author Tobias Nyholm - */ -interface ConfigBuilderGeneratorInterface -{ - /** - * @return \Closure that will return the root config class - */ - public function build(ConfigurationInterface $configuration): \Closure; -} diff --git a/app/vendor/symfony/config/Builder/ConfigBuilderInterface.php b/app/vendor/symfony/config/Builder/ConfigBuilderInterface.php deleted file mode 100644 index fd3129c58..000000000 --- a/app/vendor/symfony/config/Builder/ConfigBuilderInterface.php +++ /dev/null @@ -1,30 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Builder; - -/** - * A ConfigBuilder provides helper methods to build a large complex array. - * - * @author Tobias Nyholm - */ -interface ConfigBuilderInterface -{ - /** - * Gets all configuration represented as an array. - */ - public function toArray(): array; - - /** - * Gets the alias for the extension which config we are building. - */ - public function getExtensionAlias(): string; -} diff --git a/app/vendor/symfony/config/Builder/Method.php b/app/vendor/symfony/config/Builder/Method.php deleted file mode 100644 index 8fba068a9..000000000 --- a/app/vendor/symfony/config/Builder/Method.php +++ /dev/null @@ -1,32 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Builder; - -/** - * Represents a method when building classes. - * - * @internal - * - * @author Tobias Nyholm - */ -class Method -{ - public function __construct( - private string $content, - ) { - } - - public function getContent(): string - { - return $this->content; - } -} diff --git a/app/vendor/symfony/config/Builder/Property.php b/app/vendor/symfony/config/Builder/Property.php deleted file mode 100644 index ede5351c7..000000000 --- a/app/vendor/symfony/config/Builder/Property.php +++ /dev/null @@ -1,84 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Builder; - -/** - * Represents a property when building classes. - * - * @internal - * - * @author Tobias Nyholm - */ -class Property -{ - private bool $array = false; - private bool $scalarsAllowed = false; - private ?string $type = null; - private ?string $content = null; - - public function __construct( - private string $originalName, - private string $name, - ) { - } - - public function getName(): string - { - return $this->name; - } - - public function getOriginalName(): string - { - return $this->originalName; - } - - public function setType(string $type): void - { - $this->array = false; - $this->type = $type; - - if (str_ends_with($type, '|scalar')) { - $this->scalarsAllowed = true; - $this->type = $type = substr($type, 0, -7); - } - - if (str_ends_with($type, '[]')) { - $this->array = true; - $this->type = substr($type, 0, -2); - } - } - - public function getType(): ?string - { - return $this->type; - } - - public function getContent(): ?string - { - return $this->content; - } - - public function setContent(string $content): void - { - $this->content = $content; - } - - public function isArray(): bool - { - return $this->array; - } - - public function areScalarsAllowed(): bool - { - return $this->scalarsAllowed; - } -} diff --git a/app/vendor/symfony/config/CHANGELOG.md b/app/vendor/symfony/config/CHANGELOG.md deleted file mode 100644 index 6ee63f82c..000000000 --- a/app/vendor/symfony/config/CHANGELOG.md +++ /dev/null @@ -1,183 +0,0 @@ -CHANGELOG -========= - -7.3 ---- - - * Add `ExprBuilder::ifFalse()` - * Add support for info on `ArrayNodeDefinition::canBeEnabled()` and `ArrayNodeDefinition::canBeDisabled()` - * Allow using an enum FQCN with `EnumNode` - * Add `NodeDefinition::docUrl()` - -7.2 ---- - - * Add `#[WhenNot]` attribute to prevent service from being registered in a specific environment - * Generate a meta file in JSON format for resource tracking - * Add `SkippingResourceChecker` - * Add support for `defaultNull()` on `BooleanNode` - * Add `StringNode` and `StringNodeDefinition` - * Add `ArrayNodeDefinition::stringPrototype()` method - * Add `NodeBuilder::stringNode()` method - -7.1 ---- - - * Allow custom meta location in `ResourceCheckerConfigCache` - * Allow custom meta location in `ConfigCache` - -7.0 ---- - - * Require explicit argument when calling `NodeBuilder::setParent()` - -6.3 ---- - - * Allow enum values in `EnumNode` - -6.2 ---- - - * Deprecate calling `NodeBuilder::setParent()` without any arguments - * Add a more accurate typehint in generated PHP config - -6.1 ---- - - * Allow using environment variables in `EnumNode` - * Add Node's information in generated Config - * Add `DefinitionFileLoader` class to load a TreeBuilder definition from an external file - * Add `DefinitionConfigurator` helper - -6.0 ---- - - * Remove `BaseNode::getDeprecationMessage()` - -5.3.0 ------ - - * Add support for generating `ConfigBuilder` for extensions - -5.1.0 ------ - - * updated the signature of method `NodeDefinition::setDeprecated()` to `NodeDefinition::setDeprecation(string $package, string $version, string $message)` - * updated the signature of method `BaseNode::setDeprecated()` to `BaseNode::setDeprecation(string $package, string $version, string $message)` - * deprecated passing a null message to `BaseNode::setDeprecated()` to un-deprecate a node - * deprecated `BaseNode::getDeprecationMessage()`, use `BaseNode::getDeprecation()` instead - -5.0.0 ------ - - * Dropped support for constructing a `TreeBuilder` without passing root node information. - * Removed the `root()` method in `TreeBuilder`, pass the root node information to the constructor instead - * Added method `getChildNodeDefinitions()` to ParentNodeDefinitionInterface - * Removed `FileLoaderLoadException`, use `LoaderLoadException` instead - -4.4.0 ------ - - * added a way to exclude patterns of resources from being imported by the `import()` method - -4.3.0 ------ - - * deprecated using environment variables with `cannotBeEmpty()` if the value is validated with `validate()` - * made `Resource\*` classes final and not implement `Serializable` anymore - * deprecated the `root()` method in `TreeBuilder`, pass the root node information to the constructor instead - -4.2.0 ------ - - * deprecated constructing a `TreeBuilder` without passing root node information - * renamed `FileLoaderLoadException` to `LoaderLoadException` - -4.1.0 ------ - - * added `setPathSeparator` method to `NodeBuilder` class - * added third `$pathSeparator` constructor argument to `BaseNode` - * the `Processor` class has been made final - -4.0.0 ------ - - * removed `ConfigCachePass` - -3.4.0 ------ - - * added `setDeprecated()` method to indicate a deprecated node - * added `XmlUtils::parse()` method to parse an XML string - * deprecated `ConfigCachePass` - -3.3.0 ------ - - * added `ReflectionClassResource` class - * added second `$exists` constructor argument to `ClassExistenceResource` - * made `ClassExistenceResource` work with interfaces and traits - * added `ConfigCachePass` (originally in FrameworkBundle) - * added `castToArray()` helper to turn any config value into an array - -3.0.0 ------ - - * removed `ReferenceDumper` class - * removed the `ResourceInterface::isFresh()` method - * removed `BCResourceInterfaceChecker` class - * removed `ResourceInterface::getResource()` method - -2.8.0 ------ - -The edge case of defining just one value for nodes of type Enum is now allowed: - -```php -$rootNode - ->children() - ->enumNode('variable') - ->values(['value']) - ->end() - ->end() -; -``` - -Before: `InvalidArgumentException` (variable must contain at least two -distinct elements). -After: the code will work as expected and it will restrict the values of the -`variable` option to just `value`. - - * deprecated the `ResourceInterface::isFresh()` method. If you implement custom resource types and they - can be validated that way, make them implement the new `SelfCheckingResourceInterface`. - * deprecated the getResource() method in ResourceInterface. You can still call this method - on concrete classes implementing the interface, but it does not make sense at the interface - level as you need to know about the particular type of resource at hand to understand the - semantics of the returned value. - -2.7.0 ------ - - * added `ConfigCacheInterface`, `ConfigCacheFactoryInterface` and a basic `ConfigCacheFactory` - implementation to delegate creation of ConfigCache instances - -2.2.0 ------ - - * added `ArrayNodeDefinition::canBeEnabled()` and `ArrayNodeDefinition::canBeDisabled()` - to ease configuration when some sections are respectively disabled / enabled - by default. - * added a `normalizeKeys()` method for array nodes (to avoid key normalization) - * added numerical type handling for config definitions - * added convenience methods for optional configuration sections to `ArrayNodeDefinition` - * added a utils class for XML manipulations - -2.1.0 ------ - - * added a way to add documentation on configuration - * implemented `Serializable` on resources - * `LoaderResolverInterface` is now used instead of `LoaderResolver` for type - hinting diff --git a/app/vendor/symfony/config/ConfigCache.php b/app/vendor/symfony/config/ConfigCache.php deleted file mode 100644 index cee286f48..000000000 --- a/app/vendor/symfony/config/ConfigCache.php +++ /dev/null @@ -1,67 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -use Symfony\Component\Config\Resource\ResourceInterface; -use Symfony\Component\Config\Resource\SelfCheckingResourceChecker; -use Symfony\Component\Config\Resource\SkippingResourceChecker; - -/** - * ConfigCache caches arbitrary content in files on disk. - * - * When in debug mode, those metadata resources that implement - * \Symfony\Component\Config\Resource\SelfCheckingResourceInterface will - * be used to check cache freshness. - * - * @author Fabien Potencier - * @author Matthias Pigulla - */ -class ConfigCache extends ResourceCheckerConfigCache -{ - /** - * @param string $file The absolute cache path - * @param bool $debug Whether debugging is enabled or not - * @param string|null $metaFile The absolute path to the meta file - * @param class-string[]|null $skippedResourceTypes - */ - public function __construct( - string $file, - private bool $debug, - ?string $metaFile = null, - ?array $skippedResourceTypes = null, - ) { - $checkers = []; - if ($this->debug) { - if (null !== $skippedResourceTypes) { - $checkers[] = new SkippingResourceChecker($skippedResourceTypes); - } - $checkers[] = new SelfCheckingResourceChecker(); - } - - parent::__construct($file, $checkers, $metaFile); - } - - /** - * Checks if the cache is still fresh. - * - * This implementation always returns true when debug is off and the - * cache file exists. - */ - public function isFresh(): bool - { - if (!$this->debug && is_file($this->getPath())) { - return true; - } - - return parent::isFresh(); - } -} diff --git a/app/vendor/symfony/config/ConfigCacheFactory.php b/app/vendor/symfony/config/ConfigCacheFactory.php deleted file mode 100644 index 27a18e751..000000000 --- a/app/vendor/symfony/config/ConfigCacheFactory.php +++ /dev/null @@ -1,42 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -/** - * Basic implementation of ConfigCacheFactoryInterface that - * creates an instance of the default ConfigCache. - * - * This factory and/or cache do not support cache validation - * by means of ResourceChecker instances (that is, service-based). - * - * @author Matthias Pigulla - */ -class ConfigCacheFactory implements ConfigCacheFactoryInterface -{ - /** - * @param bool $debug The debug flag to pass to ConfigCache - */ - public function __construct( - private bool $debug, - ) { - } - - public function cache(string $file, callable $callback): ConfigCacheInterface - { - $cache = new ConfigCache($file, $this->debug); - if (!$cache->isFresh()) { - $callback($cache); - } - - return $cache; - } -} diff --git a/app/vendor/symfony/config/ConfigCacheFactoryInterface.php b/app/vendor/symfony/config/ConfigCacheFactoryInterface.php deleted file mode 100644 index 01c90d1e3..000000000 --- a/app/vendor/symfony/config/ConfigCacheFactoryInterface.php +++ /dev/null @@ -1,30 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -/** - * Interface for a ConfigCache factory. This factory creates - * an instance of ConfigCacheInterface and initializes the - * cache if necessary. - * - * @author Matthias Pigulla - */ -interface ConfigCacheFactoryInterface -{ - /** - * Creates a cache instance and (re-)initializes it if necessary. - * - * @param string $file The absolute cache file path - * @param callable $callable The callable to be executed when the cache needs to be filled (i. e. is not fresh). The cache will be passed as the only parameter to this callback - */ - public function cache(string $file, callable $callable): ConfigCacheInterface; -} diff --git a/app/vendor/symfony/config/ConfigCacheInterface.php b/app/vendor/symfony/config/ConfigCacheInterface.php deleted file mode 100644 index 7b9d38897..000000000 --- a/app/vendor/symfony/config/ConfigCacheInterface.php +++ /dev/null @@ -1,45 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -use Symfony\Component\Config\Resource\ResourceInterface; - -/** - * Interface for ConfigCache. - * - * @author Matthias Pigulla - */ -interface ConfigCacheInterface -{ - /** - * Gets the cache file path. - */ - public function getPath(): string; - - /** - * Checks if the cache is still fresh. - * - * This check should take the metadata passed to the write() method into consideration. - */ - public function isFresh(): bool; - - /** - * Writes the given content into the cache file. Metadata will be stored - * independently and can be used to check cache freshness at a later time. - * - * @param string $content The content to write into the cache - * @param ResourceInterface[]|null $metadata An array of ResourceInterface instances - * - * @throws \RuntimeException When the cache file cannot be written - */ - public function write(string $content, ?array $metadata = null): void; -} diff --git a/app/vendor/symfony/config/Definition/ArrayNode.php b/app/vendor/symfony/config/Definition/ArrayNode.php deleted file mode 100644 index 5301b7243..000000000 --- a/app/vendor/symfony/config/Definition/ArrayNode.php +++ /dev/null @@ -1,379 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; -use Symfony\Component\Config\Definition\Exception\UnsetKeyException; - -/** - * Represents an Array node in the config tree. - * - * @author Johannes M. Schmitt - */ -class ArrayNode extends BaseNode implements PrototypeNodeInterface -{ - protected array $xmlRemappings = []; - protected array $children = []; - protected bool $allowFalse = false; - protected bool $allowNewKeys = true; - protected bool $addIfNotSet = false; - protected bool $performDeepMerging = true; - protected bool $ignoreExtraKeys = false; - protected bool $removeExtraKeys = true; - protected bool $normalizeKeys = true; - - public function setNormalizeKeys(bool $normalizeKeys): void - { - $this->normalizeKeys = $normalizeKeys; - } - - /** - * Namely, you mostly have foo_bar in YAML while you have foo-bar in XML. - * After running this method, all keys are normalized to foo_bar. - * - * If you have a mixed key like foo-bar_moo, it will not be altered. - * The key will also not be altered if the target key already exists. - */ - protected function preNormalize(mixed $value): mixed - { - if (!$this->normalizeKeys || !\is_array($value)) { - return $value; - } - - $normalized = []; - - foreach ($value as $k => $v) { - if (str_contains($k, '-') && !str_contains($k, '_') && !\array_key_exists($normalizedKey = str_replace('-', '_', $k), $value)) { - $normalized[$normalizedKey] = $v; - } else { - $normalized[$k] = $v; - } - } - - return $normalized; - } - - /** - * Retrieves the children of this node. - * - * @return array - */ - public function getChildren(): array - { - return $this->children; - } - - /** - * Sets the xml remappings that should be performed. - * - * @param array $remappings An array of the form [[string, string]] - */ - public function setXmlRemappings(array $remappings): void - { - $this->xmlRemappings = $remappings; - } - - /** - * Gets the xml remappings that should be performed. - * - * @return array an array of the form [[string, string]] - */ - public function getXmlRemappings(): array - { - return $this->xmlRemappings; - } - - /** - * Sets whether to add default values for this array if it has not been - * defined in any of the configuration files. - */ - public function setAddIfNotSet(bool $boolean): void - { - $this->addIfNotSet = $boolean; - } - - /** - * Sets whether false is allowed as value indicating that the array should be unset. - */ - public function setAllowFalse(bool $allow): void - { - $this->allowFalse = $allow; - } - - /** - * Sets whether new keys can be defined in subsequent configurations. - */ - public function setAllowNewKeys(bool $allow): void - { - $this->allowNewKeys = $allow; - } - - /** - * Sets if deep merging should occur. - */ - public function setPerformDeepMerging(bool $boolean): void - { - $this->performDeepMerging = $boolean; - } - - /** - * Whether extra keys should just be ignored without an exception. - * - * @param bool $boolean To allow extra keys - * @param bool $remove To remove extra keys - */ - public function setIgnoreExtraKeys(bool $boolean, bool $remove = true): void - { - $this->ignoreExtraKeys = $boolean; - $this->removeExtraKeys = $this->ignoreExtraKeys && $remove; - } - - /** - * Returns true when extra keys should be ignored without an exception. - */ - public function shouldIgnoreExtraKeys(): bool - { - return $this->ignoreExtraKeys; - } - - public function setName(string $name): void - { - $this->name = $name; - } - - public function hasDefaultValue(): bool - { - return $this->addIfNotSet; - } - - public function getDefaultValue(): mixed - { - if (!$this->hasDefaultValue()) { - throw new \RuntimeException(\sprintf('The node at path "%s" has no default value.', $this->getPath())); - } - - $defaults = []; - foreach ($this->children as $name => $child) { - if ($child->hasDefaultValue()) { - $defaults[$name] = $child->getDefaultValue(); - } - } - - return $defaults; - } - - /** - * Adds a child node. - * - * @throws \InvalidArgumentException when the child node has no name - * @throws \InvalidArgumentException when the child node's name is not unique - */ - public function addChild(NodeInterface $node): void - { - $name = $node->getName(); - if ('' === $name) { - throw new \InvalidArgumentException('Child nodes must be named.'); - } - if (isset($this->children[$name])) { - throw new \InvalidArgumentException(\sprintf('A child node named "%s" already exists.', $name)); - } - - $this->children[$name] = $node; - } - - /** - * @throws UnsetKeyException - * @throws InvalidConfigurationException if the node doesn't have enough children - */ - protected function finalizeValue(mixed $value): mixed - { - if (false === $value) { - throw new UnsetKeyException(\sprintf('Unsetting key for path "%s", value: false.', $this->getPath())); - } - - foreach ($this->children as $name => $child) { - if (!\array_key_exists($name, $value)) { - if ($child->isRequired()) { - $message = \sprintf('The child config "%s" under "%s" must be configured', $name, $this->getPath()); - if ($child->getInfo()) { - $message .= \sprintf(': %s', $child->getInfo()); - } else { - $message .= '.'; - } - $ex = new InvalidConfigurationException($message); - $ex->setPath($this->getPath()); - - throw $ex; - } - - if ($child->hasDefaultValue()) { - $value[$name] = $child->getDefaultValue(); - } - - continue; - } - - if ($child->isDeprecated()) { - $deprecation = $child->getDeprecation($name, $this->getPath()); - trigger_deprecation($deprecation['package'], $deprecation['version'], $deprecation['message']); - } - - try { - $value[$name] = $child->finalize($value[$name]); - } catch (UnsetKeyException) { - unset($value[$name]); - } - } - - return $value; - } - - protected function validateType(mixed $value): void - { - if (!\is_array($value) && (!$this->allowFalse || false !== $value)) { - $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "array", but got "%s"', $this->getPath(), get_debug_type($value))); - if ($hint = $this->getInfo()) { - $ex->addHint($hint); - } - $ex->setPath($this->getPath()); - - throw $ex; - } - } - - /** - * @throws InvalidConfigurationException - */ - protected function normalizeValue(mixed $value): mixed - { - if (false === $value) { - return $value; - } - - $value = $this->remapXml($value); - - $normalized = []; - foreach ($value as $name => $val) { - if (isset($this->children[$name])) { - try { - $normalized[$name] = $this->children[$name]->normalize($val); - } catch (UnsetKeyException) { - } - unset($value[$name]); - } elseif (!$this->removeExtraKeys) { - $normalized[$name] = $val; - } - } - - // if extra fields are present, throw exception - if (\count($value) && !$this->ignoreExtraKeys) { - $proposals = array_keys($this->children); - sort($proposals); - $guesses = []; - - foreach (array_keys($value) as $subject) { - $minScore = \INF; - foreach ($proposals as $proposal) { - $distance = levenshtein($subject, $proposal); - if ($distance <= $minScore && $distance < 3) { - $guesses[$proposal] = $distance; - $minScore = $distance; - } - } - } - - $msg = \sprintf('Unrecognized option%s "%s" under "%s"', 1 === \count($value) ? '' : 's', implode(', ', array_keys($value)), $this->getPath()); - - if (\count($guesses)) { - asort($guesses); - $msg .= \sprintf('. Did you mean "%s"?', implode('", "', array_keys($guesses))); - } else { - $msg .= \sprintf('. Available option%s %s "%s".', 1 === \count($proposals) ? '' : 's', 1 === \count($proposals) ? 'is' : 'are', implode('", "', $proposals)); - } - - $ex = new InvalidConfigurationException($msg); - $ex->setPath($this->getPath()); - - throw $ex; - } - - return $normalized; - } - - /** - * Remaps multiple singular values to a single plural value. - */ - protected function remapXml(array $value): array - { - foreach ($this->xmlRemappings as [$singular, $plural]) { - if (!isset($value[$singular])) { - continue; - } - - $value[$plural] = Processor::normalizeConfig($value, $singular, $plural); - unset($value[$singular]); - } - - return $value; - } - - /** - * @throws InvalidConfigurationException - * @throws \RuntimeException - */ - protected function mergeValues(mixed $leftSide, mixed $rightSide): mixed - { - if (false === $rightSide) { - // if this is still false after the last config has been merged the - // finalization pass will take care of removing this key entirely - return false; - } - - if (false === $leftSide || !$this->performDeepMerging) { - return $rightSide; - } - - foreach ($rightSide as $k => $v) { - // no conflict - if (!\array_key_exists($k, $leftSide)) { - if (!$this->allowNewKeys) { - $ex = new InvalidConfigurationException(\sprintf('You are not allowed to define new elements for path "%s". Please define all elements for this path in one config file. If you are trying to overwrite an element, make sure you redefine it with the same name.', $this->getPath())); - $ex->setPath($this->getPath()); - - throw $ex; - } - - $leftSide[$k] = $v; - continue; - } - - if (!isset($this->children[$k])) { - if (!$this->ignoreExtraKeys || $this->removeExtraKeys) { - throw new \RuntimeException('merge() expects a normalized config array.'); - } - - $leftSide[$k] = $v; - continue; - } - - $leftSide[$k] = $this->children[$k]->merge($leftSide[$k], $v); - } - - return $leftSide; - } - - protected function allowPlaceholders(): bool - { - return false; - } -} diff --git a/app/vendor/symfony/config/Definition/BaseNode.php b/app/vendor/symfony/config/Definition/BaseNode.php deleted file mode 100644 index 9cfd69239..000000000 --- a/app/vendor/symfony/config/Definition/BaseNode.php +++ /dev/null @@ -1,512 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\Exception; -use Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException; -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; -use Symfony\Component\Config\Definition\Exception\UnsetKeyException; - -/** - * The base node class. - * - * @author Johannes M. Schmitt - */ -abstract class BaseNode implements NodeInterface -{ - public const DEFAULT_PATH_SEPARATOR = '.'; - - private static array $placeholderUniquePrefixes = []; - private static array $placeholders = []; - - protected string $name; - protected array $normalizationClosures = []; - protected array $normalizedTypes = []; - protected array $finalValidationClosures = []; - protected bool $allowOverwrite = true; - protected bool $required = false; - protected array $deprecation = []; - protected array $equivalentValues = []; - protected array $attributes = []; - - private mixed $handlingPlaceholder = null; - - /** - * @throws \InvalidArgumentException if the name contains a period - */ - public function __construct( - ?string $name, - protected ?NodeInterface $parent = null, - protected string $pathSeparator = self::DEFAULT_PATH_SEPARATOR, - ) { - if (str_contains($name = (string) $name, $pathSeparator)) { - throw new \InvalidArgumentException('The name must not contain ".'.$pathSeparator.'".'); - } - - $this->name = $name; - } - - /** - * Register possible (dummy) values for a dynamic placeholder value. - * - * Matching configuration values will be processed with a provided value, one by one. After a provided value is - * successfully processed the configuration value is returned as is, thus preserving the placeholder. - * - * @internal - */ - public static function setPlaceholder(string $placeholder, array $values): void - { - if (!$values) { - throw new \InvalidArgumentException('At least one value must be provided.'); - } - - self::$placeholders[$placeholder] = $values; - } - - /** - * Adds a common prefix for dynamic placeholder values. - * - * Matching configuration values will be skipped from being processed and are returned as is, thus preserving the - * placeholder. An exact match provided by {@see setPlaceholder()} might take precedence. - * - * @internal - */ - public static function setPlaceholderUniquePrefix(string $prefix): void - { - self::$placeholderUniquePrefixes[] = $prefix; - } - - /** - * Resets all current placeholders available. - * - * @internal - */ - public static function resetPlaceholders(): void - { - self::$placeholderUniquePrefixes = []; - self::$placeholders = []; - } - - public function setAttribute(string $key, mixed $value): void - { - $this->attributes[$key] = $value; - } - - public function getAttribute(string $key, mixed $default = null): mixed - { - return $this->attributes[$key] ?? $default; - } - - public function hasAttribute(string $key): bool - { - return isset($this->attributes[$key]); - } - - public function getAttributes(): array - { - return $this->attributes; - } - - public function setAttributes(array $attributes): void - { - $this->attributes = $attributes; - } - - public function removeAttribute(string $key): void - { - unset($this->attributes[$key]); - } - - /** - * Sets an info message. - */ - public function setInfo(string $info): void - { - $this->setAttribute('info', $info); - } - - /** - * Returns info message. - */ - public function getInfo(): ?string - { - return $this->getAttribute('info'); - } - - /** - * Sets the example configuration for this node. - */ - public function setExample(string|array $example): void - { - $this->setAttribute('example', $example); - } - - /** - * Retrieves the example configuration for this node. - */ - public function getExample(): string|array|null - { - return $this->getAttribute('example'); - } - - /** - * Adds an equivalent value. - */ - public function addEquivalentValue(mixed $originalValue, mixed $equivalentValue): void - { - $this->equivalentValues[] = [$originalValue, $equivalentValue]; - } - - /** - * Set this node as required. - */ - public function setRequired(bool $boolean): void - { - $this->required = $boolean; - } - - /** - * Sets this node as deprecated. - * - * You can use %node% and %path% placeholders in your message to display, - * respectively, the node name and its complete path. - * - * @param string $package The name of the composer package that is triggering the deprecation - * @param string $version The version of the package that introduced the deprecation - * @param string $message the deprecation message to use - */ - public function setDeprecated(string $package, string $version, string $message = 'The child node "%node%" at path "%path%" is deprecated.'): void - { - $this->deprecation = [ - 'package' => $package, - 'version' => $version, - 'message' => $message, - ]; - } - - /** - * Sets if this node can be overridden. - */ - public function setAllowOverwrite(bool $allow): void - { - $this->allowOverwrite = $allow; - } - - /** - * Sets the closures used for normalization. - * - * @param \Closure[] $closures An array of Closures used for normalization - */ - public function setNormalizationClosures(array $closures): void - { - $this->normalizationClosures = $closures; - } - - /** - * Sets the list of types supported by normalization. - * - * see ExprBuilder::TYPE_* constants. - */ - public function setNormalizedTypes(array $types): void - { - $this->normalizedTypes = $types; - } - - /** - * Gets the list of types supported by normalization. - * - * see ExprBuilder::TYPE_* constants. - */ - public function getNormalizedTypes(): array - { - return $this->normalizedTypes; - } - - /** - * Sets the closures used for final validation. - * - * @param \Closure[] $closures An array of Closures used for final validation - */ - public function setFinalValidationClosures(array $closures): void - { - $this->finalValidationClosures = $closures; - } - - public function isRequired(): bool - { - return $this->required; - } - - /** - * Checks if this node is deprecated. - */ - public function isDeprecated(): bool - { - return (bool) $this->deprecation; - } - - /** - * @param string $node The configuration node name - * @param string $path The path of the node - */ - public function getDeprecation(string $node, string $path): array - { - return [ - 'package' => $this->deprecation['package'], - 'version' => $this->deprecation['version'], - 'message' => strtr($this->deprecation['message'], ['%node%' => $node, '%path%' => $path]), - ]; - } - - public function getName(): string - { - return $this->name; - } - - public function getPath(): string - { - if (null !== $this->parent) { - return $this->parent->getPath().$this->pathSeparator.$this->name; - } - - return $this->name; - } - - final public function merge(mixed $leftSide, mixed $rightSide): mixed - { - if (!$this->allowOverwrite) { - throw new ForbiddenOverwriteException(\sprintf('Configuration path "%s" cannot be overwritten. You have to define all options for this path, and any of its sub-paths in one configuration section.', $this->getPath())); - } - - if ($leftSide !== $leftPlaceholders = self::resolvePlaceholderValue($leftSide)) { - foreach ($leftPlaceholders as $leftPlaceholder) { - $this->handlingPlaceholder = $leftSide; - try { - $this->merge($leftPlaceholder, $rightSide); - } finally { - $this->handlingPlaceholder = null; - } - } - - return $rightSide; - } - - if ($rightSide !== $rightPlaceholders = self::resolvePlaceholderValue($rightSide)) { - foreach ($rightPlaceholders as $rightPlaceholder) { - $this->handlingPlaceholder = $rightSide; - try { - $this->merge($leftSide, $rightPlaceholder); - } finally { - $this->handlingPlaceholder = null; - } - } - - return $rightSide; - } - - $this->doValidateType($leftSide); - $this->doValidateType($rightSide); - - return $this->mergeValues($leftSide, $rightSide); - } - - final public function normalize(mixed $value): mixed - { - $value = $this->preNormalize($value); - - // run custom normalization closures - foreach ($this->normalizationClosures as $closure) { - $value = $closure($value); - } - - // resolve placeholder value - if ($value !== $placeholders = self::resolvePlaceholderValue($value)) { - foreach ($placeholders as $placeholder) { - $this->handlingPlaceholder = $value; - try { - $this->normalize($placeholder); - } finally { - $this->handlingPlaceholder = null; - } - } - - return $value; - } - - // replace value with their equivalent - foreach ($this->equivalentValues as $data) { - if ($data[0] === $value) { - $value = $data[1]; - } - } - - // validate type - $this->doValidateType($value); - - // normalize value - return $this->normalizeValue($value); - } - - /** - * Normalizes the value before any other normalization is applied. - */ - protected function preNormalize(mixed $value): mixed - { - return $value; - } - - /** - * Returns parent node for this node. - */ - public function getParent(): ?NodeInterface - { - return $this->parent; - } - - final public function finalize(mixed $value): mixed - { - if ($value !== $placeholders = self::resolvePlaceholderValue($value)) { - foreach ($placeholders as $placeholder) { - $this->handlingPlaceholder = $value; - try { - $this->finalize($placeholder); - } finally { - $this->handlingPlaceholder = null; - } - } - - return $value; - } - - $this->doValidateType($value); - - $value = $this->finalizeValue($value); - - // Perform validation on the final value if a closure has been set. - // The closure is also allowed to return another value. - foreach ($this->finalValidationClosures as $closure) { - try { - $value = $closure($value); - } catch (Exception $e) { - if ($e instanceof UnsetKeyException && null !== $this->handlingPlaceholder) { - continue; - } - - throw $e; - } catch (\Exception $e) { - throw new InvalidConfigurationException(\sprintf('Invalid configuration for path "%s": ', $this->getPath()).$e->getMessage(), $e->getCode(), $e); - } - } - - return $value; - } - - /** - * Validates the type of a Node. - * - * @throws InvalidTypeException when the value is invalid - */ - abstract protected function validateType(mixed $value): void; - - /** - * Normalizes the value. - */ - abstract protected function normalizeValue(mixed $value): mixed; - - /** - * Merges two values together. - */ - abstract protected function mergeValues(mixed $leftSide, mixed $rightSide): mixed; - - /** - * Finalizes a value. - */ - abstract protected function finalizeValue(mixed $value): mixed; - - /** - * Tests if placeholder values are allowed for this node. - */ - protected function allowPlaceholders(): bool - { - return true; - } - - /** - * Tests if a placeholder is being handled currently. - */ - protected function isHandlingPlaceholder(): bool - { - return null !== $this->handlingPlaceholder; - } - - /** - * Gets allowed dynamic types for this node. - */ - protected function getValidPlaceholderTypes(): array - { - return []; - } - - private static function resolvePlaceholderValue(mixed $value): mixed - { - if (\is_string($value)) { - if (isset(self::$placeholders[$value])) { - return self::$placeholders[$value]; - } - - foreach (self::$placeholderUniquePrefixes as $placeholderUniquePrefix) { - if (str_starts_with($value, $placeholderUniquePrefix)) { - return []; - } - } - } - - return $value; - } - - private function doValidateType(mixed $value): void - { - if (null !== $this->handlingPlaceholder && !$this->allowPlaceholders()) { - $e = new InvalidTypeException(\sprintf('A dynamic value is not compatible with a "%s" node type at path "%s".', static::class, $this->getPath())); - $e->setPath($this->getPath()); - - throw $e; - } - - if (null === $this->handlingPlaceholder || null === $value) { - $this->validateType($value); - - return; - } - - $knownTypes = array_keys(self::$placeholders[$this->handlingPlaceholder]); - $validTypes = $this->getValidPlaceholderTypes(); - - if ($validTypes && array_diff($knownTypes, $validTypes)) { - $e = new InvalidTypeException(\sprintf( - 'Invalid type for path "%s". Expected %s, but got %s.', - $this->getPath(), - 1 === \count($validTypes) ? '"'.reset($validTypes).'"' : 'one of "'.implode('", "', $validTypes).'"', - 1 === \count($knownTypes) ? '"'.reset($knownTypes).'"' : 'one of "'.implode('", "', $knownTypes).'"' - )); - if ($hint = $this->getInfo()) { - $e->addHint($hint); - } - $e->setPath($this->getPath()); - - throw $e; - } - - $this->validateType($value); - } -} diff --git a/app/vendor/symfony/config/Definition/BooleanNode.php b/app/vendor/symfony/config/Definition/BooleanNode.php deleted file mode 100644 index b4ed0f0eb..000000000 --- a/app/vendor/symfony/config/Definition/BooleanNode.php +++ /dev/null @@ -1,59 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; - -/** - * This node represents a Boolean value in the config tree. - * - * @author Johannes M. Schmitt - */ -class BooleanNode extends ScalarNode -{ - public function __construct( - ?string $name, - ?NodeInterface $parent = null, - string $pathSeparator = self::DEFAULT_PATH_SEPARATOR, - private bool $nullable = false, - ) { - parent::__construct($name, $parent, $pathSeparator); - } - - protected function validateType(mixed $value): void - { - if (!\is_bool($value)) { - if (null === $value && $this->nullable) { - return; - } - - $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "bool%s", but got "%s".', $this->getPath(), $this->nullable ? '" or "null' : '', get_debug_type($value))); - if ($hint = $this->getInfo()) { - $ex->addHint($hint); - } - $ex->setPath($this->getPath()); - - throw $ex; - } - } - - protected function isValueEmpty(mixed $value): bool - { - // a boolean value cannot be empty - return false; - } - - protected function getValidPlaceholderTypes(): array - { - return ['bool']; - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/ArrayNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/ArrayNodeDefinition.php deleted file mode 100644 index e9872d7ee..000000000 --- a/app/vendor/symfony/config/Definition/Builder/ArrayNodeDefinition.php +++ /dev/null @@ -1,528 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\ArrayNode; -use Symfony\Component\Config\Definition\Exception\InvalidDefinitionException; -use Symfony\Component\Config\Definition\NodeInterface; -use Symfony\Component\Config\Definition\PrototypedArrayNode; - -/** - * This class provides a fluent interface for defining an array node. - * - * @author Johannes M. Schmitt - */ -class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinitionInterface -{ - protected bool $performDeepMerging = true; - protected bool $ignoreExtraKeys = false; - protected bool $removeExtraKeys = true; - protected array $children = []; - protected NodeDefinition $prototype; - protected bool $atLeastOne = false; - protected bool $allowNewKeys = true; - protected ?string $key = null; - protected bool $removeKeyItem = false; - protected bool $addDefaults = false; - protected int|string|array|false|null $addDefaultChildren = false; - protected NodeBuilder $nodeBuilder; - protected bool $normalizeKeys = true; - - public function __construct(?string $name, ?NodeParentInterface $parent = null) - { - parent::__construct($name, $parent); - - $this->nullEquivalent = []; - $this->trueEquivalent = []; - } - - public function setBuilder(NodeBuilder $builder): void - { - $this->nodeBuilder = $builder; - } - - public function children(): NodeBuilder - { - return $this->getNodeBuilder(); - } - - /** - * Sets a prototype for child nodes. - */ - public function prototype(string $type): NodeDefinition - { - return $this->prototype = $this->getNodeBuilder()->node(null, $type)->setParent($this); - } - - public function variablePrototype(): VariableNodeDefinition - { - return $this->prototype('variable'); - } - - public function scalarPrototype(): ScalarNodeDefinition - { - return $this->prototype('scalar'); - } - - public function stringPrototype(): StringNodeDefinition - { - return $this->prototype('string'); - } - - public function booleanPrototype(): BooleanNodeDefinition - { - return $this->prototype('boolean'); - } - - public function integerPrototype(): IntegerNodeDefinition - { - return $this->prototype('integer'); - } - - public function floatPrototype(): FloatNodeDefinition - { - return $this->prototype('float'); - } - - public function arrayPrototype(): self - { - return $this->prototype('array'); - } - - public function enumPrototype(): EnumNodeDefinition - { - return $this->prototype('enum'); - } - - /** - * Adds the default value if the node is not set in the configuration. - * - * This method is applicable to concrete nodes only (not to prototype nodes). - * If this function has been called and the node is not set during the finalization - * phase, it's default value will be derived from its children default values. - * - * @return $this - */ - public function addDefaultsIfNotSet(): static - { - $this->addDefaults = true; - - return $this; - } - - /** - * Adds children with a default value when none are defined. - * - * This method is applicable to prototype nodes only. - * - * @param int|string|array|null $children The number of children|The child name|The children names to be added - * - * @return $this - */ - public function addDefaultChildrenIfNoneSet(int|string|array|null $children = null): static - { - $this->addDefaultChildren = $children; - - return $this; - } - - /** - * Requires the node to have at least one element. - * - * This method is applicable to prototype nodes only. - * - * @return $this - */ - public function requiresAtLeastOneElement(): static - { - $this->atLeastOne = true; - - return $this; - } - - /** - * Disallows adding news keys in a subsequent configuration. - * - * If used all keys have to be defined in the same configuration file. - * - * @return $this - */ - public function disallowNewKeysInSubsequentConfigs(): static - { - $this->allowNewKeys = false; - - return $this; - } - - /** - * Sets a normalization rule for XML configurations. - * - * @param string $singular The key to remap - * @param string|null $plural The plural of the key for irregular plurals - * - * @return $this - */ - public function fixXmlConfig(string $singular, ?string $plural = null): static - { - $this->normalization()->remap($singular, $plural); - - return $this; - } - - /** - * Sets the attribute which value is to be used as key. - * - * This is useful when you have an indexed array that should be an - * associative array. You can select an item from within the array - * to be the key of the particular item. For example, if "id" is the - * "key", then: - * - * [ - * ['id' => 'my_name', 'foo' => 'bar'], - * ]; - * - * becomes - * - * [ - * 'my_name' => ['foo' => 'bar'], - * ]; - * - * If you'd like "'id' => 'my_name'" to still be present in the resulting - * array, then you can set the second argument of this method to false. - * - * This method is applicable to prototype nodes only. - * - * @param string $name The name of the key - * @param bool $removeKeyItem Whether or not the key item should be removed - * - * @return $this - */ - public function useAttributeAsKey(string $name, bool $removeKeyItem = true): static - { - $this->key = $name; - $this->removeKeyItem = $removeKeyItem; - - return $this; - } - - /** - * Sets whether the node can be unset. - * - * @return $this - */ - public function canBeUnset(bool $allow = true): static - { - $this->merge()->allowUnset($allow); - - return $this; - } - - /** - * Adds an "enabled" boolean to enable the current section. - * - * By default, the section is disabled. If any configuration is specified then - * the node will be automatically enabled: - * - * enableableArrayNode: {enabled: true, ...} # The config is enabled & default values get overridden - * enableableArrayNode: ~ # The config is enabled & use the default values - * enableableArrayNode: true # The config is enabled & use the default values - * enableableArrayNode: {other: value, ...} # The config is enabled & default values get overridden - * enableableArrayNode: {enabled: false, ...} # The config is disabled - * enableableArrayNode: false # The config is disabled - * - * @param string|null $info A description of what happens when the node is enabled or disabled - * - * @return $this - */ - public function canBeEnabled(/* ?string $info = null */): static - { - $disabledNode = $this - ->addDefaultsIfNotSet() - ->treatFalseLike(['enabled' => false]) - ->treatTrueLike(['enabled' => true]) - ->treatNullLike(['enabled' => true]) - ->beforeNormalization() - ->ifArray() - ->then(function (array $v) { - $v['enabled'] ??= true; - - return $v; - }) - ->end() - ->children() - ->booleanNode('enabled') - ->defaultFalse() - ; - - $info = 1 <= \func_num_args() ? func_get_arg(0) : null; - if ($info) { - $disabledNode->info($info); - } - - return $this; - } - - /** - * Adds an "enabled" boolean to enable the current section. - * - * By default, the section is enabled. - * - * @param string|null $info A description of what happens when the node is enabled or disabled - * - * @return $this - */ - public function canBeDisabled(/* ?string $info = null */): static - { - $enabledNode = $this - ->addDefaultsIfNotSet() - ->treatFalseLike(['enabled' => false]) - ->treatTrueLike(['enabled' => true]) - ->treatNullLike(['enabled' => true]) - ->children() - ->booleanNode('enabled') - ->defaultTrue() - ; - - $info = 1 <= \func_num_args() ? func_get_arg(0) : null; - if ($info) { - $enabledNode->info($info); - } - - return $this; - } - - /** - * Disables the deep merging of the node. - * - * @return $this - */ - public function performNoDeepMerging(): static - { - $this->performDeepMerging = false; - - return $this; - } - - /** - * Allows extra config keys to be specified under an array without - * throwing an exception. - * - * Those config values are ignored and removed from the resulting - * array. This should be used only in special cases where you want - * to send an entire configuration array through a special tree that - * processes only part of the array. - * - * @param bool $remove Whether to remove the extra keys - * - * @return $this - */ - public function ignoreExtraKeys(bool $remove = true): static - { - $this->ignoreExtraKeys = true; - $this->removeExtraKeys = $remove; - - return $this; - } - - /** - * Sets whether to enable key normalization. - * - * @return $this - */ - public function normalizeKeys(bool $bool): static - { - $this->normalizeKeys = $bool; - - return $this; - } - - public function append(NodeDefinition $node): static - { - $this->children[$node->name] = $node->setParent($this); - - return $this; - } - - /** - * Returns a node builder to be used to add children and prototype. - */ - protected function getNodeBuilder(): NodeBuilder - { - $this->nodeBuilder ??= new NodeBuilder(); - - return $this->nodeBuilder->setParent($this); - } - - protected function createNode(): NodeInterface - { - if (!isset($this->prototype)) { - $node = new ArrayNode($this->name, $this->parent, $this->pathSeparator); - - $this->validateConcreteNode($node); - - $node->setAddIfNotSet($this->addDefaults); - - foreach ($this->children as $child) { - $child->parent = $node; - $node->addChild($child->getNode()); - } - } else { - $node = new PrototypedArrayNode($this->name, $this->parent, $this->pathSeparator); - - $this->validatePrototypeNode($node); - - if (null !== $this->key) { - $node->setKeyAttribute($this->key, $this->removeKeyItem); - } - - if (true === $this->atLeastOne || false === $this->allowEmptyValue) { - $node->setMinNumberOfElements(1); - } - - if ($this->default) { - if (!\is_array($this->defaultValue)) { - throw new \InvalidArgumentException(\sprintf('%s: the default value of an array node has to be an array.', $node->getPath())); - } - - $node->setDefaultValue($this->defaultValue); - } - - if (false !== $this->addDefaultChildren) { - $node->setAddChildrenIfNoneSet($this->addDefaultChildren); - if ($this->prototype instanceof static && !isset($this->prototype->prototype)) { - $this->prototype->addDefaultsIfNotSet(); - } - } - - $this->prototype->parent = $node; - $node->setPrototype($this->prototype->getNode()); - } - - $node->setAllowNewKeys($this->allowNewKeys); - $node->addEquivalentValue(null, $this->nullEquivalent); - $node->addEquivalentValue(true, $this->trueEquivalent); - $node->addEquivalentValue(false, $this->falseEquivalent); - $node->setPerformDeepMerging($this->performDeepMerging); - $node->setRequired($this->required); - $node->setIgnoreExtraKeys($this->ignoreExtraKeys, $this->removeExtraKeys); - $node->setNormalizeKeys($this->normalizeKeys); - - if ($this->deprecation) { - $node->setDeprecated($this->deprecation['package'], $this->deprecation['version'], $this->deprecation['message']); - } - - if (isset($this->normalization)) { - $node->setNormalizationClosures($this->normalization->before); - $node->setNormalizedTypes($this->normalization->declaredTypes); - $node->setXmlRemappings($this->normalization->remappings); - } - - if (isset($this->merge)) { - $node->setAllowOverwrite($this->merge->allowOverwrite); - $node->setAllowFalse($this->merge->allowFalse); - } - - if (isset($this->validation)) { - $node->setFinalValidationClosures($this->validation->rules); - } - - return $node; - } - - /** - * Validate the configuration of a concrete node. - * - * @throws InvalidDefinitionException - */ - protected function validateConcreteNode(ArrayNode $node): void - { - $path = $node->getPath(); - - if (null !== $this->key) { - throw new InvalidDefinitionException(\sprintf('->useAttributeAsKey() is not applicable to concrete nodes at path "%s".', $path)); - } - - if (false === $this->allowEmptyValue) { - throw new InvalidDefinitionException(\sprintf('->cannotBeEmpty() is not applicable to concrete nodes at path "%s".', $path)); - } - - if (true === $this->atLeastOne) { - throw new InvalidDefinitionException(\sprintf('->requiresAtLeastOneElement() is not applicable to concrete nodes at path "%s".', $path)); - } - - if ($this->default) { - throw new InvalidDefinitionException(\sprintf('->defaultValue() is not applicable to concrete nodes at path "%s".', $path)); - } - - if (false !== $this->addDefaultChildren) { - throw new InvalidDefinitionException(\sprintf('->addDefaultChildrenIfNoneSet() is not applicable to concrete nodes at path "%s".', $path)); - } - } - - /** - * Validate the configuration of a prototype node. - * - * @throws InvalidDefinitionException - */ - protected function validatePrototypeNode(PrototypedArrayNode $node): void - { - $path = $node->getPath(); - - if ($this->addDefaults) { - throw new InvalidDefinitionException(\sprintf('->addDefaultsIfNotSet() is not applicable to prototype nodes at path "%s".', $path)); - } - - if (false !== $this->addDefaultChildren) { - if ($this->default) { - throw new InvalidDefinitionException(\sprintf('A default value and default children might not be used together at path "%s".', $path)); - } - - if (null !== $this->key && (null === $this->addDefaultChildren || \is_int($this->addDefaultChildren) && $this->addDefaultChildren > 0)) { - throw new InvalidDefinitionException(\sprintf('->addDefaultChildrenIfNoneSet() should set default children names as ->useAttributeAsKey() is used at path "%s".', $path)); - } - - if (null === $this->key && (\is_string($this->addDefaultChildren) || \is_array($this->addDefaultChildren))) { - throw new InvalidDefinitionException(\sprintf('->addDefaultChildrenIfNoneSet() might not set default children names as ->useAttributeAsKey() is not used at path "%s".', $path)); - } - } - } - - /** - * @return NodeDefinition[] - */ - public function getChildNodeDefinitions(): array - { - return $this->children; - } - - /** - * Finds a node defined by the given $nodePath. - * - * @param string $nodePath The path of the node to find. e.g "doctrine.orm.mappings" - */ - public function find(string $nodePath): NodeDefinition - { - $firstPathSegment = (false === $pathSeparatorPos = strpos($nodePath, $this->pathSeparator)) - ? $nodePath - : substr($nodePath, 0, $pathSeparatorPos); - - if (null === $node = ($this->children[$firstPathSegment] ?? null)) { - throw new \RuntimeException(\sprintf('Node with name "%s" does not exist in the current node "%s".', $firstPathSegment, $this->name)); - } - - if (false === $pathSeparatorPos) { - return $node; - } - - return $node->find(substr($nodePath, $pathSeparatorPos + \strlen($this->pathSeparator))); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/BooleanNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/BooleanNodeDefinition.php deleted file mode 100644 index bc03c9c94..000000000 --- a/app/vendor/symfony/config/Definition/Builder/BooleanNodeDefinition.php +++ /dev/null @@ -1,62 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\BooleanNode; -use Symfony\Component\Config\Definition\Exception\InvalidDefinitionException; - -/** - * This class provides a fluent interface for defining a node. - * - * @author Johannes M. Schmitt - */ -class BooleanNodeDefinition extends ScalarNodeDefinition -{ - public function __construct(?string $name, ?NodeParentInterface $parent = null) - { - parent::__construct($name, $parent); - - $this->nullEquivalent = true; - } - - /** - * Instantiate a Node. - */ - protected function instantiateNode(): BooleanNode - { - return new BooleanNode($this->name, $this->parent, $this->pathSeparator, null === $this->nullEquivalent); - } - - /** - * @throws InvalidDefinitionException - */ - public function cannotBeEmpty(): static - { - throw new InvalidDefinitionException('->cannotBeEmpty() is not applicable to BooleanNodeDefinition.'); - } - - public function defaultNull(): static - { - $this->nullEquivalent = null; - - return parent::defaultNull(); - } - - public function defaultValue(mixed $value): static - { - if (null === $value) { - $this->nullEquivalent = null; - } - - return parent::defaultValue($value); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/BuilderAwareInterface.php b/app/vendor/symfony/config/Definition/Builder/BuilderAwareInterface.php deleted file mode 100644 index cf646a140..000000000 --- a/app/vendor/symfony/config/Definition/Builder/BuilderAwareInterface.php +++ /dev/null @@ -1,25 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -/** - * An interface that can be implemented by nodes which build other nodes. - * - * @author Roland Franssen - */ -interface BuilderAwareInterface -{ - /** - * Sets a custom children builder. - */ - public function setBuilder(NodeBuilder $builder): void; -} diff --git a/app/vendor/symfony/config/Definition/Builder/EnumNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/EnumNodeDefinition.php deleted file mode 100644 index a020c5f27..000000000 --- a/app/vendor/symfony/config/Definition/Builder/EnumNodeDefinition.php +++ /dev/null @@ -1,73 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\EnumNode; - -/** - * Enum Node Definition. - * - * @author Johannes M. Schmitt - */ -class EnumNodeDefinition extends ScalarNodeDefinition -{ - private array $values; - private string $enumFqcn; - - /** - * @return $this - */ - public function values(array $values): static - { - if (!$values) { - throw new \InvalidArgumentException('->values() must be called with at least one value.'); - } - - $this->values = $values; - - return $this; - } - - /** - * @param class-string<\UnitEnum> $enumFqcn - * - * @return $this - */ - public function enumFqcn(string $enumFqcn): static - { - if (!enum_exists($enumFqcn)) { - throw new \InvalidArgumentException(\sprintf('The enum class "%s" does not exist.', $enumFqcn)); - } - - $this->enumFqcn = $enumFqcn; - - return $this; - } - - /** - * Instantiate a Node. - * - * @throws \RuntimeException - */ - protected function instantiateNode(): EnumNode - { - if (!isset($this->values) && !isset($this->enumFqcn)) { - throw new \RuntimeException('You must call either ->values() or ->enumFqcn() on enum nodes.'); - } - - if (isset($this->values) && isset($this->enumFqcn)) { - throw new \RuntimeException('You must call either ->values() or ->enumFqcn() on enum nodes but not both.'); - } - - return new EnumNode($this->name, $this->parent, $this->values ?? [], $this->pathSeparator, $this->enumFqcn ?? null); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/ExprBuilder.php b/app/vendor/symfony/config/Definition/Builder/ExprBuilder.php deleted file mode 100644 index 624e22d5c..000000000 --- a/app/vendor/symfony/config/Definition/Builder/ExprBuilder.php +++ /dev/null @@ -1,265 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\Exception\UnsetKeyException; - -/** - * This class builds an if expression. - * - * @author Johannes M. Schmitt - * @author Christophe Coevoet - */ -class ExprBuilder -{ - public const TYPE_ANY = 'any'; - public const TYPE_STRING = 'string'; - public const TYPE_NULL = 'null'; - public const TYPE_ARRAY = 'array'; - - public string $allowedTypes; - public ?\Closure $ifPart = null; - public ?\Closure $thenPart = null; - - public function __construct( - protected NodeDefinition $node, - ) { - } - - /** - * Marks the expression as being always used. - * - * @return $this - */ - public function always(?\Closure $then = null): static - { - $this->ifPart = static fn () => true; - $this->allowedTypes = self::TYPE_ANY; - - if (null !== $then) { - $this->thenPart = $then; - } - - return $this; - } - - /** - * Sets a closure to use as tests. - * - * The default one tests if the value is true. - * - * @return $this - */ - public function ifTrue(?\Closure $closure = null): static - { - $this->ifPart = $closure ?? static fn ($v) => true === $v; - $this->allowedTypes = self::TYPE_ANY; - - return $this; - } - - /** - * Sets a closure to use as tests. - * - * The default one tests if the value is false. - * - * @return $this - */ - public function ifFalse(?\Closure $closure = null): static - { - $this->ifPart = $closure ? static fn ($v) => !$closure($v) : static fn ($v) => false === $v; - $this->allowedTypes = self::TYPE_ANY; - - return $this; - } - - /** - * Tests if the value is a string. - * - * @return $this - */ - public function ifString(): static - { - $this->ifPart = \is_string(...); - $this->allowedTypes = self::TYPE_STRING; - - return $this; - } - - /** - * Tests if the value is null. - * - * @return $this - */ - public function ifNull(): static - { - $this->ifPart = \is_null(...); - $this->allowedTypes = self::TYPE_NULL; - - return $this; - } - - /** - * Tests if the value is empty. - * - * @return $this - */ - public function ifEmpty(): static - { - $this->ifPart = static fn ($v) => !$v; - $this->allowedTypes = self::TYPE_ANY; - - return $this; - } - - /** - * Tests if the value is an array. - * - * @return $this - */ - public function ifArray(): static - { - $this->ifPart = \is_array(...); - $this->allowedTypes = self::TYPE_ARRAY; - - return $this; - } - - /** - * Tests if the value is in an array. - * - * @return $this - */ - public function ifInArray(array $array): static - { - $this->ifPart = static fn ($v) => \in_array($v, $array, true); - $this->allowedTypes = self::TYPE_ANY; - - return $this; - } - - /** - * Tests if the value is not in an array. - * - * @return $this - */ - public function ifNotInArray(array $array): static - { - $this->ifPart = static fn ($v) => !\in_array($v, $array, true); - $this->allowedTypes = self::TYPE_ANY; - - return $this; - } - - /** - * Transforms variables of any type into an array. - * - * @return $this - */ - public function castToArray(): static - { - $this->ifPart = static fn ($v) => !\is_array($v); - $this->allowedTypes = self::TYPE_ANY; - $this->thenPart = static fn ($v) => [$v]; - - return $this; - } - - /** - * Sets the closure to run if the test pass. - * - * @return $this - */ - public function then(\Closure $closure): static - { - $this->thenPart = $closure; - - return $this; - } - - /** - * Sets a closure returning an empty array. - * - * @return $this - */ - public function thenEmptyArray(): static - { - $this->thenPart = static fn () => []; - - return $this; - } - - /** - * Sets a closure marking the value as invalid at processing time. - * - * if you want to add the value of the node in your message just use a %s placeholder. - * - * @return $this - * - * @throws \InvalidArgumentException - */ - public function thenInvalid(string $message): static - { - $this->thenPart = static fn ($v) => throw new \InvalidArgumentException(\sprintf($message, json_encode($v))); - - return $this; - } - - /** - * Sets a closure unsetting this key of the array at processing time. - * - * @return $this - * - * @throws UnsetKeyException - */ - public function thenUnset(): static - { - $this->thenPart = static fn () => throw new UnsetKeyException('Unsetting key.'); - - return $this; - } - - /** - * Returns the related node. - * - * @throws \RuntimeException - */ - public function end(): NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition - { - if (null === $this->ifPart) { - throw new \RuntimeException('You must specify an if part.'); - } - if (null === $this->thenPart) { - throw new \RuntimeException('You must specify a then part.'); - } - - return $this->node; - } - - /** - * Builds the expressions. - * - * @param ExprBuilder[] $expressions An array of ExprBuilder instances to build - */ - public static function buildExpressions(array $expressions): array - { - foreach ($expressions as $k => $expr) { - if ($expr instanceof self) { - $if = $expr->ifPart; - $then = $expr->thenPart; - $expressions[$k] = static fn ($v) => $if($v) ? $then($v) : $v; - } - } - - return $expressions; - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/FloatNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/FloatNodeDefinition.php deleted file mode 100644 index 337e971bf..000000000 --- a/app/vendor/symfony/config/Definition/Builder/FloatNodeDefinition.php +++ /dev/null @@ -1,30 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\FloatNode; - -/** - * This class provides a fluent interface for defining a float node. - * - * @author Jeanmonod David - */ -class FloatNodeDefinition extends NumericNodeDefinition -{ - /** - * Instantiates a Node. - */ - protected function instantiateNode(): FloatNode - { - return new FloatNode($this->name, $this->parent, $this->min, $this->max, $this->pathSeparator); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/IntegerNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/IntegerNodeDefinition.php deleted file mode 100644 index 2af81df47..000000000 --- a/app/vendor/symfony/config/Definition/Builder/IntegerNodeDefinition.php +++ /dev/null @@ -1,30 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\IntegerNode; - -/** - * This class provides a fluent interface for defining an integer node. - * - * @author Jeanmonod David - */ -class IntegerNodeDefinition extends NumericNodeDefinition -{ - /** - * Instantiates a Node. - */ - protected function instantiateNode(): IntegerNode - { - return new IntegerNode($this->name, $this->parent, $this->min, $this->max, $this->pathSeparator); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/MergeBuilder.php b/app/vendor/symfony/config/Definition/Builder/MergeBuilder.php deleted file mode 100644 index b90865cfc..000000000 --- a/app/vendor/symfony/config/Definition/Builder/MergeBuilder.php +++ /dev/null @@ -1,60 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -/** - * This class builds merge conditions. - * - * @author Johannes M. Schmitt - */ -class MergeBuilder -{ - public bool $allowFalse = false; - public bool $allowOverwrite = true; - - public function __construct( - protected NodeDefinition $node, - ) { - } - - /** - * Sets whether the node can be unset. - * - * @return $this - */ - public function allowUnset(bool $allow = true): static - { - $this->allowFalse = $allow; - - return $this; - } - - /** - * Sets whether the node can be overwritten. - * - * @return $this - */ - public function denyOverwrite(bool $deny = true): static - { - $this->allowOverwrite = !$deny; - - return $this; - } - - /** - * Returns the related node. - */ - public function end(): NodeDefinition|ArrayNodeDefinition|VariableNodeDefinition - { - return $this->node; - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/NodeBuilder.php b/app/vendor/symfony/config/Definition/Builder/NodeBuilder.php deleted file mode 100644 index b3fa7bfd5..000000000 --- a/app/vendor/symfony/config/Definition/Builder/NodeBuilder.php +++ /dev/null @@ -1,208 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -/** - * This class provides a fluent interface for building a node. - * - * @author Johannes M. Schmitt - */ -class NodeBuilder implements NodeParentInterface -{ - protected (NodeDefinition&ParentNodeDefinitionInterface)|null $parent = null; - protected array $nodeMapping; - - public function __construct() - { - $this->nodeMapping = [ - 'variable' => VariableNodeDefinition::class, - 'scalar' => ScalarNodeDefinition::class, - 'boolean' => BooleanNodeDefinition::class, - 'integer' => IntegerNodeDefinition::class, - 'float' => FloatNodeDefinition::class, - 'array' => ArrayNodeDefinition::class, - 'enum' => EnumNodeDefinition::class, - 'string' => StringNodeDefinition::class, - ]; - } - - /** - * Set the parent node. - * - * @return $this - */ - public function setParent((NodeDefinition&ParentNodeDefinitionInterface)|null $parent): static - { - $this->parent = $parent; - - return $this; - } - - /** - * Creates a child array node. - */ - public function arrayNode(string $name): ArrayNodeDefinition - { - return $this->node($name, 'array'); - } - - /** - * Creates a child scalar node. - */ - public function scalarNode(string $name): ScalarNodeDefinition - { - return $this->node($name, 'scalar'); - } - - /** - * Creates a child Boolean node. - */ - public function booleanNode(string $name): BooleanNodeDefinition - { - return $this->node($name, 'boolean'); - } - - /** - * Creates a child integer node. - */ - public function integerNode(string $name): IntegerNodeDefinition - { - return $this->node($name, 'integer'); - } - - /** - * Creates a child float node. - */ - public function floatNode(string $name): FloatNodeDefinition - { - return $this->node($name, 'float'); - } - - /** - * Creates a child EnumNode. - */ - public function enumNode(string $name): EnumNodeDefinition - { - return $this->node($name, 'enum'); - } - - /** - * Creates a child variable node. - */ - public function variableNode(string $name): VariableNodeDefinition - { - return $this->node($name, 'variable'); - } - - /** - * Creates a child string node. - */ - public function stringNode(string $name): StringNodeDefinition - { - return $this->node($name, 'string'); - } - - /** - * Returns the parent node. - */ - public function end(): NodeDefinition&ParentNodeDefinitionInterface - { - return $this->parent; - } - - /** - * Creates a child node. - * - * @throws \RuntimeException When the node type is not registered - * @throws \RuntimeException When the node class is not found - */ - public function node(?string $name, string $type): NodeDefinition - { - $class = $this->getNodeClass($type); - - $node = new $class($name); - - $this->append($node); - - return $node; - } - - /** - * Appends a node definition. - * - * Usage: - * - * $node = new ArrayNodeDefinition('name') - * ->children() - * ->scalarNode('foo')->end() - * ->scalarNode('baz')->end() - * ->append($this->getBarNodeDefinition()) - * ->end() - * ; - * - * @return $this - */ - public function append(NodeDefinition $node): static - { - if ($node instanceof BuilderAwareInterface) { - $builder = clone $this; - $builder->setParent(null); - $node->setBuilder($builder); - } - - if (null !== $this->parent) { - $this->parent->append($node); - // Make this builder the node parent to allow for a fluid interface - $node->setParent($this); - } - - return $this; - } - - /** - * Adds or overrides a node Type. - * - * @param string $type The name of the type - * @param string $class The fully qualified name the node definition class - * - * @return $this - */ - public function setNodeClass(string $type, string $class): static - { - $this->nodeMapping[strtolower($type)] = $class; - - return $this; - } - - /** - * Returns the class name of the node definition. - * - * @throws \RuntimeException When the node type is not registered - * @throws \RuntimeException When the node class is not found - */ - protected function getNodeClass(string $type): string - { - $type = strtolower($type); - - if (!isset($this->nodeMapping[$type])) { - throw new \RuntimeException(\sprintf('The node type "%s" is not registered.', $type)); - } - - $class = $this->nodeMapping[$type]; - - if (!class_exists($class)) { - throw new \RuntimeException(\sprintf('The node class "%s" does not exist.', $class)); - } - - return $class; - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/NodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/NodeDefinition.php deleted file mode 100644 index fdfbdabd2..000000000 --- a/app/vendor/symfony/config/Definition/Builder/NodeDefinition.php +++ /dev/null @@ -1,359 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Composer\InstalledVersions; -use Symfony\Component\Config\Definition\BaseNode; -use Symfony\Component\Config\Definition\Exception\InvalidDefinitionException; -use Symfony\Component\Config\Definition\NodeInterface; - -/** - * This class provides a fluent interface for defining a node. - * - * @author Johannes M. Schmitt - */ -abstract class NodeDefinition implements NodeParentInterface -{ - protected ?string $name = null; - protected NormalizationBuilder $normalization; - protected ValidationBuilder $validation; - protected mixed $defaultValue; - protected bool $default = false; - protected bool $required = false; - protected array $deprecation = []; - protected MergeBuilder $merge; - protected bool $allowEmptyValue = true; - protected mixed $nullEquivalent = null; - protected mixed $trueEquivalent = true; - protected mixed $falseEquivalent = false; - protected string $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR; - protected NodeParentInterface|NodeInterface|null $parent; - protected array $attributes = []; - - public function __construct(?string $name, ?NodeParentInterface $parent = null) - { - $this->parent = $parent; - $this->name = $name; - } - - /** - * Sets the parent node. - * - * @return $this - */ - public function setParent(NodeParentInterface $parent): static - { - $this->parent = $parent; - - return $this; - } - - /** - * Sets info message. - * - * @return $this - */ - public function info(string $info): static - { - return $this->attribute('info', $info); - } - - /** - * Sets example configuration. - * - * @return $this - */ - public function example(string|array $example): static - { - return $this->attribute('example', $example); - } - - /** - * Sets the documentation URI, as usually put in the "@see" tag of a doc block. This - * can either be a URL or a file path. You can use the placeholders {package}, - * {version:major} and {version:minor} in the URI. - * - * @return $this - */ - public function docUrl(string $uri, ?string $package = null): static - { - if ($package) { - preg_match('/^(\d+)\.(\d+)\.(\d+)/', InstalledVersions::getVersion($package) ?? '', $m); - } - - return $this->attribute('docUrl', strtr($uri, [ - '{package}' => $package ?? '', - '{version:major}' => $m[1] ?? '', - '{version:minor}' => $m[2] ?? '', - ])); - } - - /** - * Sets an attribute on the node. - * - * @return $this - */ - public function attribute(string $key, mixed $value): static - { - $this->attributes[$key] = $value; - - return $this; - } - - /** - * Returns the parent node. - * - * @return NodeParentInterface|NodeBuilder|self|ArrayNodeDefinition|VariableNodeDefinition - */ - public function end(): NodeParentInterface - { - return $this->parent; - } - - /** - * Creates the node. - */ - public function getNode(bool $forceRootNode = false): NodeInterface - { - if ($forceRootNode) { - $this->parent = null; - } - - if (isset($this->normalization)) { - $allowedTypes = []; - foreach ($this->normalization->before as $expr) { - $allowedTypes[] = $expr->allowedTypes; - } - $allowedTypes = array_unique($allowedTypes); - $this->normalization->before = ExprBuilder::buildExpressions($this->normalization->before); - $this->normalization->declaredTypes = $allowedTypes; - } - - if (isset($this->validation)) { - $this->validation->rules = ExprBuilder::buildExpressions($this->validation->rules); - } - - $node = $this->createNode(); - if ($node instanceof BaseNode) { - $node->setAttributes($this->attributes); - } - - return $node; - } - - /** - * Sets the default value. - * - * @return $this - */ - public function defaultValue(mixed $value): static - { - $this->default = true; - $this->defaultValue = $value; - - return $this; - } - - /** - * Sets the node as required. - * - * @return $this - */ - public function isRequired(): static - { - $this->required = true; - - return $this; - } - - /** - * Sets the node as deprecated. - * - * @param string $package The name of the composer package that is triggering the deprecation - * @param string $version The version of the package that introduced the deprecation - * @param string $message the deprecation message to use - * - * You can use %node% and %path% placeholders in your message to display, - * respectively, the node name and its complete path - * - * @return $this - */ - public function setDeprecated(string $package, string $version, string $message = 'The child node "%node%" at path "%path%" is deprecated.'): static - { - $this->deprecation = [ - 'package' => $package, - 'version' => $version, - 'message' => $message, - ]; - - return $this; - } - - /** - * Sets the equivalent value used when the node contains null. - * - * @return $this - */ - public function treatNullLike(mixed $value): static - { - $this->nullEquivalent = $value; - - return $this; - } - - /** - * Sets the equivalent value used when the node contains true. - * - * @return $this - */ - public function treatTrueLike(mixed $value): static - { - $this->trueEquivalent = $value; - - return $this; - } - - /** - * Sets the equivalent value used when the node contains false. - * - * @return $this - */ - public function treatFalseLike(mixed $value): static - { - $this->falseEquivalent = $value; - - return $this; - } - - /** - * Sets null as the default value. - * - * @return $this - */ - public function defaultNull(): static - { - return $this->defaultValue(null); - } - - /** - * Sets true as the default value. - * - * @return $this - */ - public function defaultTrue(): static - { - return $this->defaultValue(true); - } - - /** - * Sets false as the default value. - * - * @return $this - */ - public function defaultFalse(): static - { - return $this->defaultValue(false); - } - - /** - * Sets an expression to run before the normalization. - */ - public function beforeNormalization(): ExprBuilder - { - return $this->normalization()->before(); - } - - /** - * Denies the node value being empty. - * - * @return $this - */ - public function cannotBeEmpty(): static - { - $this->allowEmptyValue = false; - - return $this; - } - - /** - * Sets an expression to run for the validation. - * - * The expression receives the value of the node and must return it. It can - * modify it. - * An exception should be thrown when the node is not valid. - */ - public function validate(): ExprBuilder - { - return $this->validation()->rule(); - } - - /** - * Sets whether the node can be overwritten. - * - * @return $this - */ - public function cannotBeOverwritten(bool $deny = true): static - { - $this->merge()->denyOverwrite($deny); - - return $this; - } - - /** - * Gets the builder for validation rules. - */ - protected function validation(): ValidationBuilder - { - return $this->validation ??= new ValidationBuilder($this); - } - - /** - * Gets the builder for merging rules. - */ - protected function merge(): MergeBuilder - { - return $this->merge ??= new MergeBuilder($this); - } - - /** - * Gets the builder for normalization rules. - */ - protected function normalization(): NormalizationBuilder - { - return $this->normalization ??= new NormalizationBuilder($this); - } - - /** - * Instantiate and configure the node according to this definition. - * - * @throws InvalidDefinitionException When the definition is invalid - */ - abstract protected function createNode(): NodeInterface; - - /** - * Set PathSeparator to use. - * - * @return $this - */ - public function setPathSeparator(string $separator): static - { - if ($this instanceof ParentNodeDefinitionInterface) { - foreach ($this->getChildNodeDefinitions() as $child) { - $child->setPathSeparator($separator); - } - } - - $this->pathSeparator = $separator; - - return $this; - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/NodeParentInterface.php b/app/vendor/symfony/config/Definition/Builder/NodeParentInterface.php deleted file mode 100644 index 305e99316..000000000 --- a/app/vendor/symfony/config/Definition/Builder/NodeParentInterface.php +++ /dev/null @@ -1,21 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -/** - * An interface that must be implemented by all node parents. - * - * @author Victor Berchet - */ -interface NodeParentInterface -{ -} diff --git a/app/vendor/symfony/config/Definition/Builder/NormalizationBuilder.php b/app/vendor/symfony/config/Definition/Builder/NormalizationBuilder.php deleted file mode 100644 index 8a8141c19..000000000 --- a/app/vendor/symfony/config/Definition/Builder/NormalizationBuilder.php +++ /dev/null @@ -1,60 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -/** - * This class builds normalization conditions. - * - * @author Johannes M. Schmitt - */ -class NormalizationBuilder -{ - public array $before = []; - public array $declaredTypes = []; - public array $remappings = []; - - public function __construct( - protected NodeDefinition $node, - ) { - } - - /** - * Registers a key to remap to its plural form. - * - * @param string $key The key to remap - * @param string|null $plural The plural of the key in case of irregular plural - * - * @return $this - */ - public function remap(string $key, ?string $plural = null): static - { - $this->remappings[] = [$key, null === $plural ? $key.'s' : $plural]; - - return $this; - } - - /** - * Registers a closure to run before the normalization or an expression builder to build it if null is provided. - * - * @return ExprBuilder|$this - */ - public function before(?\Closure $closure = null): ExprBuilder|static - { - if (null !== $closure) { - $this->before[] = $closure; - - return $this; - } - - return $this->before[] = new ExprBuilder($this->node); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/NumericNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/NumericNodeDefinition.php deleted file mode 100644 index 06dc97994..000000000 --- a/app/vendor/symfony/config/Definition/Builder/NumericNodeDefinition.php +++ /dev/null @@ -1,67 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\Exception\InvalidDefinitionException; - -/** - * Abstract class that contains common code of integer and float node definitions. - * - * @author David Jeanmonod - */ -abstract class NumericNodeDefinition extends ScalarNodeDefinition -{ - protected int|float|null $min = null; - protected int|float|null $max = null; - - /** - * Ensures that the value is smaller than the given reference. - * - * @return $this - * - * @throws \InvalidArgumentException when the constraint is inconsistent - */ - public function max(int|float $max): static - { - if (isset($this->min) && $this->min > $max) { - throw new \InvalidArgumentException(\sprintf('You cannot define a max(%s) as you already have a min(%s).', $max, $this->min)); - } - $this->max = $max; - - return $this; - } - - /** - * Ensures that the value is bigger than the given reference. - * - * @return $this - * - * @throws \InvalidArgumentException when the constraint is inconsistent - */ - public function min(int|float $min): static - { - if (isset($this->max) && $this->max < $min) { - throw new \InvalidArgumentException(\sprintf('You cannot define a min(%s) as you already have a max(%s).', $min, $this->max)); - } - $this->min = $min; - - return $this; - } - - /** - * @throws InvalidDefinitionException - */ - public function cannotBeEmpty(): static - { - throw new InvalidDefinitionException('->cannotBeEmpty() is not applicable to NumericNodeDefinition.'); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/ParentNodeDefinitionInterface.php b/app/vendor/symfony/config/Definition/Builder/ParentNodeDefinitionInterface.php deleted file mode 100644 index 7b8a7eb80..000000000 --- a/app/vendor/symfony/config/Definition/Builder/ParentNodeDefinitionInterface.php +++ /dev/null @@ -1,49 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -/** - * An interface that must be implemented by nodes which can have children. - * - * @author Victor Berchet - */ -interface ParentNodeDefinitionInterface extends BuilderAwareInterface -{ - /** - * Returns a builder to add children nodes. - */ - public function children(): NodeBuilder; - - /** - * Appends a node definition. - * - * Usage: - * - * $node = $parentNode - * ->children() - * ->scalarNode('foo')->end() - * ->scalarNode('baz')->end() - * ->append($this->getBarNodeDefinition()) - * ->end() - * ; - * - * @return $this - */ - public function append(NodeDefinition $node): static; - - /** - * Gets the child node definitions. - * - * @return NodeDefinition[] - */ - public function getChildNodeDefinitions(): array; -} diff --git a/app/vendor/symfony/config/Definition/Builder/ScalarNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/ScalarNodeDefinition.php deleted file mode 100644 index 37a0af02d..000000000 --- a/app/vendor/symfony/config/Definition/Builder/ScalarNodeDefinition.php +++ /dev/null @@ -1,30 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\ScalarNode; - -/** - * This class provides a fluent interface for defining a node. - * - * @author Johannes M. Schmitt - */ -class ScalarNodeDefinition extends VariableNodeDefinition -{ - /** - * Instantiate a Node. - */ - protected function instantiateNode(): ScalarNode - { - return new ScalarNode($this->name, $this->parent, $this->pathSeparator); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/StringNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/StringNodeDefinition.php deleted file mode 100644 index c86f1bfd7..000000000 --- a/app/vendor/symfony/config/Definition/Builder/StringNodeDefinition.php +++ /dev/null @@ -1,34 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\StringNode; - -/** - * This class provides a fluent interface for defining a node. - * - * @author Raffaele Carelle - */ -class StringNodeDefinition extends ScalarNodeDefinition -{ - public function __construct(?string $name, ?NodeParentInterface $parent = null) - { - parent::__construct($name, $parent); - - $this->nullEquivalent = ''; - } - - protected function instantiateNode(): StringNode - { - return new StringNode($this->name, $this->parent, $this->pathSeparator); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/TreeBuilder.php b/app/vendor/symfony/config/Definition/Builder/TreeBuilder.php deleted file mode 100644 index 5170e19d1..000000000 --- a/app/vendor/symfony/config/Definition/Builder/TreeBuilder.php +++ /dev/null @@ -1,57 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\NodeInterface; - -/** - * This is the entry class for building a config tree. - * - * @author Johannes M. Schmitt - */ -class TreeBuilder implements NodeParentInterface -{ - protected ?NodeInterface $tree = null; - protected ?NodeDefinition $root = null; - - public function __construct(string $name, string $type = 'array', ?NodeBuilder $builder = null) - { - $builder ??= new NodeBuilder(); - $this->root = $builder->node($name, $type)->setParent($this); - } - - /** - * @return NodeDefinition|ArrayNodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array') - */ - public function getRootNode(): NodeDefinition|ArrayNodeDefinition - { - return $this->root; - } - - /** - * Builds the tree. - * - * @throws \RuntimeException - */ - public function buildTree(): NodeInterface - { - return $this->tree ??= $this->root->getNode(true); - } - - public function setPathSeparator(string $separator): void - { - // unset last built as changing path separator changes all nodes - $this->tree = null; - - $this->root->setPathSeparator($separator); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/ValidationBuilder.php b/app/vendor/symfony/config/Definition/Builder/ValidationBuilder.php deleted file mode 100644 index ad2239349..000000000 --- a/app/vendor/symfony/config/Definition/Builder/ValidationBuilder.php +++ /dev/null @@ -1,43 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -/** - * This class builds validation conditions. - * - * @author Christophe Coevoet - */ -class ValidationBuilder -{ - public array $rules = []; - - public function __construct( - protected NodeDefinition $node, - ) { - } - - /** - * Registers a closure to run as normalization or an expression builder to build it if null is provided. - * - * @return ExprBuilder|$this - */ - public function rule(?\Closure $closure = null): ExprBuilder|static - { - if (null !== $closure) { - $this->rules[] = $closure; - - return $this; - } - - return $this->rules[] = new ExprBuilder($this->node); - } -} diff --git a/app/vendor/symfony/config/Definition/Builder/VariableNodeDefinition.php b/app/vendor/symfony/config/Definition/Builder/VariableNodeDefinition.php deleted file mode 100644 index a4cc53a55..000000000 --- a/app/vendor/symfony/config/Definition/Builder/VariableNodeDefinition.php +++ /dev/null @@ -1,64 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Builder; - -use Symfony\Component\Config\Definition\NodeInterface; -use Symfony\Component\Config\Definition\VariableNode; - -/** - * This class provides a fluent interface for defining a node. - * - * @author Johannes M. Schmitt - */ -class VariableNodeDefinition extends NodeDefinition -{ - /** - * Instantiate a Node. - */ - protected function instantiateNode(): VariableNode - { - return new VariableNode($this->name, $this->parent, $this->pathSeparator); - } - - protected function createNode(): NodeInterface - { - $node = $this->instantiateNode(); - - if (isset($this->normalization)) { - $node->setNormalizationClosures($this->normalization->before); - } - - if (isset($this->merge)) { - $node->setAllowOverwrite($this->merge->allowOverwrite); - } - - if (true === $this->default) { - $node->setDefaultValue($this->defaultValue); - } - - $node->setAllowEmptyValue($this->allowEmptyValue); - $node->addEquivalentValue(null, $this->nullEquivalent); - $node->addEquivalentValue(true, $this->trueEquivalent); - $node->addEquivalentValue(false, $this->falseEquivalent); - $node->setRequired($this->required); - - if ($this->deprecation) { - $node->setDeprecated($this->deprecation['package'], $this->deprecation['version'], $this->deprecation['message']); - } - - if (isset($this->validation)) { - $node->setFinalValidationClosures($this->validation->rules); - } - - return $node; - } -} diff --git a/app/vendor/symfony/config/Definition/ConfigurableInterface.php b/app/vendor/symfony/config/Definition/ConfigurableInterface.php deleted file mode 100644 index cd4646160..000000000 --- a/app/vendor/symfony/config/Definition/ConfigurableInterface.php +++ /dev/null @@ -1,25 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator; - -/** - * @author Yonel Ceruto - */ -interface ConfigurableInterface -{ - /** - * Generates the configuration tree builder. - */ - public function configure(DefinitionConfigurator $definition): void; -} diff --git a/app/vendor/symfony/config/Definition/Configuration.php b/app/vendor/symfony/config/Definition/Configuration.php deleted file mode 100644 index 32954a66a..000000000 --- a/app/vendor/symfony/config/Definition/Configuration.php +++ /dev/null @@ -1,45 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Builder\TreeBuilder; -use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator; -use Symfony\Component\Config\Definition\Loader\DefinitionFileLoader; -use Symfony\Component\Config\FileLocator; -use Symfony\Component\DependencyInjection\ContainerBuilder; - -/** - * @author Yonel Ceruto - * - * @final - */ -class Configuration implements ConfigurationInterface -{ - public function __construct( - private ConfigurableInterface $subject, - private ?ContainerBuilder $container, - private string $alias, - ) { - } - - public function getConfigTreeBuilder(): TreeBuilder - { - $treeBuilder = new TreeBuilder($this->alias); - $file = (new \ReflectionObject($this->subject))->getFileName(); - $loader = new DefinitionFileLoader($treeBuilder, new FileLocator(\dirname($file)), $this->container); - $configurator = new DefinitionConfigurator($treeBuilder, $loader, $file, $file); - - $this->subject->configure($configurator); - - return $treeBuilder; - } -} diff --git a/app/vendor/symfony/config/Definition/ConfigurationInterface.php b/app/vendor/symfony/config/Definition/ConfigurationInterface.php deleted file mode 100644 index 97a325bb6..000000000 --- a/app/vendor/symfony/config/Definition/ConfigurationInterface.php +++ /dev/null @@ -1,27 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Builder\TreeBuilder; - -/** - * Configuration interface. - * - * @author Victor Berchet - */ -interface ConfigurationInterface -{ - /** - * Generates the configuration tree builder. - */ - public function getConfigTreeBuilder(): TreeBuilder; -} diff --git a/app/vendor/symfony/config/Definition/Configurator/DefinitionConfigurator.php b/app/vendor/symfony/config/Definition/Configurator/DefinitionConfigurator.php deleted file mode 100644 index 13fe45ca4..000000000 --- a/app/vendor/symfony/config/Definition/Configurator/DefinitionConfigurator.php +++ /dev/null @@ -1,47 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Configurator; - -use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition; -use Symfony\Component\Config\Definition\Builder\NodeDefinition; -use Symfony\Component\Config\Definition\Builder\TreeBuilder; -use Symfony\Component\Config\Definition\Loader\DefinitionFileLoader; - -/** - * @author Yonel Ceruto - */ -class DefinitionConfigurator -{ - public function __construct( - private TreeBuilder $treeBuilder, - private DefinitionFileLoader $loader, - private string $path, - private string $file, - ) { - } - - public function import(string $resource, ?string $type = null, bool $ignoreErrors = false): void - { - $this->loader->setCurrentDir(\dirname($this->path)); - $this->loader->import($resource, $type, $ignoreErrors, $this->file); - } - - public function rootNode(): NodeDefinition|ArrayNodeDefinition - { - return $this->treeBuilder->getRootNode(); - } - - public function setPathSeparator(string $separator): void - { - $this->treeBuilder->setPathSeparator($separator); - } -} diff --git a/app/vendor/symfony/config/Definition/Dumper/XmlReferenceDumper.php b/app/vendor/symfony/config/Definition/Dumper/XmlReferenceDumper.php deleted file mode 100644 index 2131c7131..000000000 --- a/app/vendor/symfony/config/Definition/Dumper/XmlReferenceDumper.php +++ /dev/null @@ -1,293 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Dumper; - -use Symfony\Component\Config\Definition\ArrayNode; -use Symfony\Component\Config\Definition\BaseNode; -use Symfony\Component\Config\Definition\BooleanNode; -use Symfony\Component\Config\Definition\ConfigurationInterface; -use Symfony\Component\Config\Definition\EnumNode; -use Symfony\Component\Config\Definition\FloatNode; -use Symfony\Component\Config\Definition\IntegerNode; -use Symfony\Component\Config\Definition\NodeInterface; -use Symfony\Component\Config\Definition\PrototypedArrayNode; -use Symfony\Component\Config\Definition\ScalarNode; - -/** - * Dumps an XML reference configuration for the given configuration/node instance. - * - * @author Wouter J - */ -class XmlReferenceDumper -{ - private ?string $reference = null; - - public function dump(ConfigurationInterface $configuration, ?string $namespace = null): string - { - return $this->dumpNode($configuration->getConfigTreeBuilder()->buildTree(), $namespace); - } - - public function dumpNode(NodeInterface $node, ?string $namespace = null): string - { - $this->reference = ''; - $this->writeNode($node, 0, true, $namespace); - $ref = $this->reference; - $this->reference = null; - - return $ref; - } - - private function writeNode(NodeInterface $node, int $depth = 0, bool $root = false, ?string $namespace = null): void - { - $rootName = ($root ? 'config' : $node->getName()); - $rootNamespace = ($namespace ?: ($root ? 'http://example.org/schema/dic/'.$node->getName() : null)); - - // xml remapping - if ($node->getParent()) { - $remapping = array_filter($node->getParent()->getXmlRemappings(), fn (array $mapping) => $rootName === $mapping[1]); - - if (\count($remapping)) { - [$singular] = current($remapping); - $rootName = $singular; - } - } - $rootName = str_replace('_', '-', $rootName); - - $rootAttributes = []; - $rootAttributeComments = []; - $rootChildren = []; - $rootComments = []; - - if ($node instanceof ArrayNode) { - $children = $node->getChildren(); - - // comments about the root node - if ($rootInfo = $node->getInfo()) { - $rootComments[] = $rootInfo; - } - - if ($rootNamespace) { - $rootComments[] = 'Namespace: '.$rootNamespace; - } - - // render prototyped nodes - if ($node instanceof PrototypedArrayNode) { - $prototype = $node->getPrototype(); - - $info = 'prototype'; - if (null !== $prototype->getInfo()) { - $info .= ': '.$prototype->getInfo(); - } - array_unshift($rootComments, $info); - - if ($key = $node->getKeyAttribute()) { - $rootAttributes[$key] = str_replace('-', ' ', $rootName).' '.$key; - } - - if ($prototype instanceof PrototypedArrayNode) { - $prototype->setName($key ?? ''); - $children = [$key => $prototype]; - } elseif ($prototype instanceof ArrayNode) { - $children = $prototype->getChildren(); - } else { - if ($prototype->hasDefaultValue()) { - $prototypeValue = $prototype->getDefaultValue(); - } else { - $prototypeValue = match ($prototype::class) { - ScalarNode::class => 'scalar value', - FloatNode::class, - IntegerNode::class => 'numeric value', - BooleanNode::class => 'true|false', - EnumNode::class => $prototype->getPermissibleValues('|'), - default => 'value', - }; - } - } - } - - // get attributes and elements - foreach ($children as $child) { - if ($child instanceof ArrayNode) { - // get elements - $rootChildren[] = $child; - - continue; - } - - // get attributes - - // metadata - $name = str_replace('_', '-', $child->getName()); - $value = '%%%%not_defined%%%%'; // use a string which isn't used in the normal world - - // comments - $comments = []; - if ($child instanceof BaseNode && $info = $child->getInfo()) { - $comments[] = $info; - } - - if ($child instanceof BaseNode && $example = $child->getExample()) { - $comments[] = 'Example: '.(\is_array($example) ? implode(', ', $example) : $example); - } - - if ($child->isRequired()) { - $comments[] = 'Required'; - } - - if ($child instanceof BaseNode && $child->isDeprecated()) { - $deprecation = $child->getDeprecation($child->getName(), $node->getPath()); - $comments[] = \sprintf('Deprecated (%s)', ($deprecation['package'] || $deprecation['version'] ? "Since {$deprecation['package']} {$deprecation['version']}: " : '').$deprecation['message']); - } - - if ($child instanceof EnumNode) { - $comments[] = 'One of '.$child->getPermissibleValues('; '); - } - - if (\count($comments)) { - $rootAttributeComments[$name] = implode(";\n", $comments); - } - - // default values - if ($child->hasDefaultValue()) { - $value = $child->getDefaultValue(); - } - - // append attribute - $rootAttributes[$name] = $value; - } - } - - // render comments - - // root node comment - if (\count($rootComments)) { - foreach ($rootComments as $comment) { - $this->writeLine('', $depth); - } - } - - // attribute comments - if (\count($rootAttributeComments)) { - foreach ($rootAttributeComments as $attrName => $comment) { - $commentDepth = $depth + 4 + \strlen($attrName) + 2; - $commentLines = explode("\n", $comment); - $multiline = (\count($commentLines) > 1); - $comment = implode(\PHP_EOL.str_repeat(' ', $commentDepth), $commentLines); - - if ($multiline) { - $this->writeLine('', $depth); - } else { - $this->writeLine('', $depth); - } - } - } - - // render start tag + attributes - $rootIsVariablePrototype = isset($prototypeValue); - $rootIsEmptyTag = (0 === \count($rootChildren) && !$rootIsVariablePrototype); - $rootOpenTag = '<'.$rootName; - if (1 >= ($attributesCount = \count($rootAttributes))) { - if (1 === $attributesCount) { - $rootOpenTag .= \sprintf(' %s="%s"', current(array_keys($rootAttributes)), $this->writeValue(current($rootAttributes))); - } - - $rootOpenTag .= $rootIsEmptyTag ? ' />' : '>'; - - if ($rootIsVariablePrototype) { - $rootOpenTag .= $prototypeValue.''; - } - - $this->writeLine($rootOpenTag, $depth); - } else { - $this->writeLine($rootOpenTag, $depth); - - $i = 1; - - foreach ($rootAttributes as $attrName => $attrValue) { - $attr = \sprintf('%s="%s"', $attrName, $this->writeValue($attrValue)); - - $this->writeLine($attr, $depth + 4); - - if ($attributesCount === $i++) { - $this->writeLine($rootIsEmptyTag ? '/>' : '>', $depth); - - if ($rootIsVariablePrototype) { - $rootOpenTag .= $prototypeValue.''; - } - } - } - } - - // render children tags - foreach ($rootChildren as $child) { - $this->writeLine(''); - $this->writeNode($child, $depth + 4); - } - - // render end tag - if (!$rootIsEmptyTag && !$rootIsVariablePrototype) { - $this->writeLine(''); - - $rootEndTag = ''; - $this->writeLine($rootEndTag, $depth); - } - } - - /** - * Outputs a single config reference line. - */ - private function writeLine(string $text, int $indent = 0): void - { - $indent = \strlen($text) + $indent; - $format = '%'.$indent.'s'; - - $this->reference .= \sprintf($format, $text).\PHP_EOL; - } - - /** - * Renders the string conversion of the value. - */ - private function writeValue(mixed $value): string - { - if ('%%%%not_defined%%%%' === $value) { - return ''; - } - - if (\is_string($value) || is_numeric($value)) { - return $value; - } - - if (false === $value) { - return 'false'; - } - - if (true === $value) { - return 'true'; - } - - if (null === $value) { - return 'null'; - } - - if (!$value) { - return ''; - } - - if (\is_array($value)) { - return implode(',', $value); - } - - return ''; - } -} diff --git a/app/vendor/symfony/config/Definition/Dumper/YamlReferenceDumper.php b/app/vendor/symfony/config/Definition/Dumper/YamlReferenceDumper.php deleted file mode 100644 index 267444d92..000000000 --- a/app/vendor/symfony/config/Definition/Dumper/YamlReferenceDumper.php +++ /dev/null @@ -1,245 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Dumper; - -use Symfony\Component\Config\Definition\ArrayNode; -use Symfony\Component\Config\Definition\BaseNode; -use Symfony\Component\Config\Definition\ConfigurationInterface; -use Symfony\Component\Config\Definition\EnumNode; -use Symfony\Component\Config\Definition\NodeInterface; -use Symfony\Component\Config\Definition\PrototypedArrayNode; -use Symfony\Component\Config\Definition\ScalarNode; -use Symfony\Component\Yaml\Inline; - -/** - * Dumps a Yaml reference configuration for the given configuration/node instance. - * - * @author Kevin Bond - */ -class YamlReferenceDumper -{ - private ?string $reference = null; - - public function dump(ConfigurationInterface $configuration): string - { - return $this->dumpNode($configuration->getConfigTreeBuilder()->buildTree()); - } - - public function dumpAtPath(ConfigurationInterface $configuration, string $path): string - { - $rootNode = $node = $configuration->getConfigTreeBuilder()->buildTree(); - - foreach (explode('.', $path) as $step) { - if (!$node instanceof ArrayNode) { - throw new \UnexpectedValueException(\sprintf('Unable to find node at path "%s.%s".', $rootNode->getName(), $path)); - } - - /** @var NodeInterface[] $children */ - $children = $node instanceof PrototypedArrayNode ? $this->getPrototypeChildren($node) : $node->getChildren(); - - foreach ($children as $child) { - if ($child->getName() === $step) { - $node = $child; - - continue 2; - } - } - - throw new \UnexpectedValueException(\sprintf('Unable to find node at path "%s.%s".', $rootNode->getName(), $path)); - } - - return $this->dumpNode($node); - } - - public function dumpNode(NodeInterface $node): string - { - $this->reference = ''; - $this->writeNode($node); - $ref = $this->reference; - $this->reference = null; - - return $ref; - } - - private function writeNode(NodeInterface $node, ?NodeInterface $parentNode = null, int $depth = 0, bool $prototypedArray = false): void - { - $comments = []; - $default = ''; - $defaultArray = null; - $children = null; - $example = null; - if ($node instanceof BaseNode) { - $example = $node->getExample(); - } - - // defaults - if ($node instanceof ArrayNode) { - $children = $node->getChildren(); - - if ($node instanceof PrototypedArrayNode) { - $children = $this->getPrototypeChildren($node); - } - - if (!$children && !($node->hasDefaultValue() && \count($defaultArray = $node->getDefaultValue()))) { - $default = '[]'; - } - } elseif ($node instanceof EnumNode) { - $comments[] = 'One of '.$node->getPermissibleValues('; '); - $default = $node->hasDefaultValue() ? Inline::dump($node->getDefaultValue()) : '~'; - } else { - $default = '~'; - - if ($node->hasDefaultValue()) { - $default = $node->getDefaultValue(); - - if (\is_array($default)) { - if (\count($defaultArray = $node->getDefaultValue())) { - $default = ''; - } elseif (!\is_array($example)) { - $default = '[]'; - } - } else { - $default = Inline::dump($default); - } - } - } - - // required? - if ($node->isRequired()) { - $comments[] = 'Required'; - } - - // deprecated? - if ($node instanceof BaseNode && $node->isDeprecated()) { - $deprecation = $node->getDeprecation($node->getName(), $parentNode ? $parentNode->getPath() : $node->getPath()); - $comments[] = \sprintf('Deprecated (%s)', ($deprecation['package'] || $deprecation['version'] ? "Since {$deprecation['package']} {$deprecation['version']}: " : '').$deprecation['message']); - } - - // example - if ($example && !\is_array($example)) { - $comments[] = 'Example: '.Inline::dump($example); - } - - $default = '' != (string) $default ? ' '.$default : ''; - $comments = \count($comments) ? '# '.implode(', ', $comments) : ''; - - $key = $prototypedArray ? '-' : $node->getName().':'; - $text = rtrim(\sprintf('%-21s%s %s', $key, $default, $comments), ' '); - - if ($node instanceof BaseNode && $info = $node->getInfo()) { - $this->writeLine(''); - // indenting multi-line info - $info = str_replace("\n", \sprintf("\n%".($depth * 4).'s# ', ' '), $info); - $this->writeLine('# '.$info, $depth * 4); - } - - $this->writeLine($text, $depth * 4); - - // output defaults - if ($defaultArray) { - $this->writeLine(''); - - $message = \count($defaultArray) > 1 ? 'Defaults' : 'Default'; - - $this->writeLine('# '.$message.':', $depth * 4 + 4); - - $this->writeArray($defaultArray, $depth + 1); - } - - if (\is_array($example)) { - $this->writeLine(''); - - $message = \count($example) > 1 ? 'Examples' : 'Example'; - - $this->writeLine('# '.$message.':', $depth * 4 + 4); - - $this->writeArray(array_map(Inline::dump(...), $example), $depth + 1, true); - } - - if ($children) { - foreach ($children as $childNode) { - $this->writeNode($childNode, $node, $depth + 1, $node instanceof PrototypedArrayNode && !$node->getKeyAttribute()); - } - } - } - - /** - * Outputs a single config reference line. - */ - private function writeLine(string $text, int $indent = 0): void - { - $indent = \strlen($text) + $indent; - $format = '%'.$indent.'s'; - - $this->reference .= \sprintf($format, $text)."\n"; - } - - private function writeArray(array $array, int $depth, bool $asComment = false): void - { - $isIndexed = array_is_list($array); - - foreach ($array as $key => $value) { - if (\is_array($value)) { - $val = ''; - } else { - $val = $value; - } - - $prefix = $asComment ? '# ' : ''; - - if ($isIndexed) { - $this->writeLine($prefix.'- '.$val, $depth * 4); - } else { - $this->writeLine(\sprintf('%s%-20s %s', $prefix, $key.':', $val), $depth * 4); - } - - if (\is_array($value)) { - $this->writeArray($value, $depth + 1, $asComment); - } - } - } - - private function getPrototypeChildren(PrototypedArrayNode $node): array - { - $prototype = $node->getPrototype(); - $key = $node->getKeyAttribute(); - - // Do not expand prototype if it isn't an array node nor uses attribute as key - if (!$key && !$prototype instanceof ArrayNode) { - return $node->getChildren(); - } - - if ($prototype instanceof ArrayNode) { - $keyNode = new ArrayNode($key, $node); - $children = $prototype->getChildren(); - - if ($prototype instanceof PrototypedArrayNode && $prototype->getKeyAttribute()) { - $children = $this->getPrototypeChildren($prototype); - } - - // add children - foreach ($children as $childNode) { - $keyNode->addChild($childNode); - } - } else { - $keyNode = new ScalarNode($key, $node); - } - - $info = 'Prototype'; - if (null !== $prototype->getInfo()) { - $info .= ': '.$prototype->getInfo(); - } - $keyNode->setInfo($info); - - return [$key => $keyNode]; - } -} diff --git a/app/vendor/symfony/config/Definition/EnumNode.php b/app/vendor/symfony/config/Definition/EnumNode.php deleted file mode 100644 index 401bb48fc..000000000 --- a/app/vendor/symfony/config/Definition/EnumNode.php +++ /dev/null @@ -1,158 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; - -/** - * Node which only allows a finite set of values. - * - * @author Johannes M. Schmitt - */ -class EnumNode extends ScalarNode -{ - private array $values; - private ?string $enumFqcn = null; - - /** - * @param class-string<\UnitEnum>|null $enumFqcn - */ - public function __construct(?string $name, ?NodeInterface $parent = null, array $values = [], string $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR, ?string $enumFqcn = null) - { - if (!$values && !$enumFqcn) { - throw new \InvalidArgumentException('$values must contain at least one element.'); - } - - if ($values && $enumFqcn) { - throw new \InvalidArgumentException('$values or $enumFqcn cannot be both set.'); - } - - if (null !== $enumFqcn) { - if (!enum_exists($enumFqcn)) { - throw new \InvalidArgumentException(\sprintf('The "%s" enum does not exist.', $enumFqcn)); - } - - $values = $enumFqcn::cases(); - $this->enumFqcn = $enumFqcn; - } - - foreach ($values as $value) { - if (null === $value || \is_scalar($value)) { - continue; - } - - if (!$value instanceof \UnitEnum) { - throw new \InvalidArgumentException(\sprintf('"%s" only supports scalar, enum, or null values, "%s" given.', __CLASS__, get_debug_type($value))); - } - - if ($value::class !== ($enumClass ??= $value::class)) { - throw new \InvalidArgumentException(\sprintf('"%s" only supports one type of enum, "%s" and "%s" passed.', __CLASS__, $enumClass, $value::class)); - } - } - - parent::__construct($name, $parent, $pathSeparator); - $this->values = $values; - } - - public function getValues(): array - { - return $this->values; - } - - public function getEnumFqcn(): ?string - { - return $this->enumFqcn; - } - - /** - * @internal - */ - public function getPermissibleValues(string $separator): string - { - if (is_subclass_of($this->enumFqcn, \BackedEnum::class)) { - return implode($separator, array_column($this->enumFqcn::cases(), 'value')); - } - - return implode($separator, array_unique(array_map(static function (mixed $value): string { - if (!$value instanceof \UnitEnum) { - return json_encode($value); - } - - return ltrim(var_export($value, true), '\\'); - }, $this->values))); - } - - protected function validateType(mixed $value): void - { - if ($value instanceof \UnitEnum) { - return; - } - - parent::validateType($value); - } - - protected function finalizeValue(mixed $value): mixed - { - $value = parent::finalizeValue($value); - - if (!$this->enumFqcn) { - if (!\in_array($value, $this->values, true)) { - throw $this->createInvalidValueException($value); - } - - return $value; - } - - if ($value instanceof $this->enumFqcn) { - return $value; - } - - if (!is_subclass_of($this->enumFqcn, \BackedEnum::class)) { - // value is not an instance of the enum, and the enum is not - // backed, meaning no cast is possible - throw $this->createInvalidValueException($value); - } - - if ($value instanceof \UnitEnum && !$value instanceof $this->enumFqcn) { - throw new InvalidConfigurationException(\sprintf('The value should be part of the "%s" enum, got a value from the "%s" enum.', $this->enumFqcn, get_debug_type($value))); - } - - if (!\is_string($value) && !\is_int($value)) { - throw new InvalidConfigurationException(\sprintf('Only strings and integers can be cast to a case of the "%s" enum, got value of type "%s".', $this->enumFqcn, get_debug_type($value))); - } - - try { - return $this->enumFqcn::from($value); - } catch (\TypeError|\ValueError) { - throw $this->createInvalidValueException($value); - } - } - - private function createInvalidValueException(mixed $value): InvalidConfigurationException - { - $displayValue = match (true) { - \is_int($value) => $value, - \is_string($value) => \sprintf('"%s"', $value), - default => \sprintf('of type "%s"', get_debug_type($value)), - }; - - $message = \sprintf('The value %s is not allowed for path "%s". Permissible values: %s.', $displayValue, $this->getPath(), $this->getPermissibleValues(', ')); - if ($this->enumFqcn) { - $message = substr_replace($message, \sprintf(' (cases of the "%s" enum)', $this->enumFqcn), -1, 0); - } - - $e = new InvalidConfigurationException($message); - $e->setPath($this->getPath()); - - return $e; - } -} diff --git a/app/vendor/symfony/config/Definition/Exception/DuplicateKeyException.php b/app/vendor/symfony/config/Definition/Exception/DuplicateKeyException.php deleted file mode 100644 index 48dd9325e..000000000 --- a/app/vendor/symfony/config/Definition/Exception/DuplicateKeyException.php +++ /dev/null @@ -1,22 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Exception; - -/** - * This exception is thrown whenever the key of an array is not unique. This can - * only be the case if the configuration is coming from an XML file. - * - * @author Johannes M. Schmitt - */ -class DuplicateKeyException extends InvalidConfigurationException -{ -} diff --git a/app/vendor/symfony/config/Definition/Exception/Exception.php b/app/vendor/symfony/config/Definition/Exception/Exception.php deleted file mode 100644 index 8933a4923..000000000 --- a/app/vendor/symfony/config/Definition/Exception/Exception.php +++ /dev/null @@ -1,21 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Exception; - -/** - * Base exception for all configuration exceptions. - * - * @author Johannes M. Schmitt - */ -class Exception extends \RuntimeException -{ -} diff --git a/app/vendor/symfony/config/Definition/Exception/ForbiddenOverwriteException.php b/app/vendor/symfony/config/Definition/Exception/ForbiddenOverwriteException.php deleted file mode 100644 index 726c07fb8..000000000 --- a/app/vendor/symfony/config/Definition/Exception/ForbiddenOverwriteException.php +++ /dev/null @@ -1,22 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Exception; - -/** - * This exception is thrown when a configuration path is overwritten from a - * subsequent configuration file, but the entry node specifically forbids this. - * - * @author Johannes M. Schmitt - */ -class ForbiddenOverwriteException extends InvalidConfigurationException -{ -} diff --git a/app/vendor/symfony/config/Definition/Exception/InvalidConfigurationException.php b/app/vendor/symfony/config/Definition/Exception/InvalidConfigurationException.php deleted file mode 100644 index e3f29f8e6..000000000 --- a/app/vendor/symfony/config/Definition/Exception/InvalidConfigurationException.php +++ /dev/null @@ -1,47 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Exception; - -/** - * A very general exception which can be thrown whenever non of the more specific - * exceptions is suitable. - * - * @author Johannes M. Schmitt - */ -class InvalidConfigurationException extends Exception -{ - private ?string $path = null; - private bool $containsHints = false; - - public function setPath(string $path): void - { - $this->path = $path; - } - - public function getPath(): ?string - { - return $this->path; - } - - /** - * Adds extra information that is suffixed to the original exception message. - */ - public function addHint(string $hint): void - { - if (!$this->containsHints) { - $this->message .= "\nHint: ".$hint; - $this->containsHints = true; - } else { - $this->message .= ', '.$hint; - } - } -} diff --git a/app/vendor/symfony/config/Definition/Exception/InvalidDefinitionException.php b/app/vendor/symfony/config/Definition/Exception/InvalidDefinitionException.php deleted file mode 100644 index 98310dae0..000000000 --- a/app/vendor/symfony/config/Definition/Exception/InvalidDefinitionException.php +++ /dev/null @@ -1,21 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Exception; - -/** - * Thrown when an error is detected in a node Definition. - * - * @author Victor Berchet - */ -class InvalidDefinitionException extends Exception -{ -} diff --git a/app/vendor/symfony/config/Definition/Exception/InvalidTypeException.php b/app/vendor/symfony/config/Definition/Exception/InvalidTypeException.php deleted file mode 100644 index d7ca8c9d0..000000000 --- a/app/vendor/symfony/config/Definition/Exception/InvalidTypeException.php +++ /dev/null @@ -1,21 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Exception; - -/** - * This exception is thrown if an invalid type is encountered. - * - * @author Johannes M. Schmitt - */ -class InvalidTypeException extends InvalidConfigurationException -{ -} diff --git a/app/vendor/symfony/config/Definition/Exception/UnsetKeyException.php b/app/vendor/symfony/config/Definition/Exception/UnsetKeyException.php deleted file mode 100644 index 863181a33..000000000 --- a/app/vendor/symfony/config/Definition/Exception/UnsetKeyException.php +++ /dev/null @@ -1,22 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Exception; - -/** - * This exception is usually not encountered by the end-user, but only used - * internally to signal the parent scope to unset a key. - * - * @author Johannes M. Schmitt - */ -class UnsetKeyException extends Exception -{ -} diff --git a/app/vendor/symfony/config/Definition/FloatNode.php b/app/vendor/symfony/config/Definition/FloatNode.php deleted file mode 100644 index 8b922804b..000000000 --- a/app/vendor/symfony/config/Definition/FloatNode.php +++ /dev/null @@ -1,45 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; - -/** - * This node represents a float value in the config tree. - * - * @author Jeanmonod David - */ -class FloatNode extends NumericNode -{ - protected function validateType(mixed $value): void - { - // Integers are also accepted, we just cast them - if (\is_int($value)) { - $value = (float) $value; - } - - if (!\is_float($value)) { - $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "float", but got "%s".', $this->getPath(), get_debug_type($value))); - if ($hint = $this->getInfo()) { - $ex->addHint($hint); - } - $ex->setPath($this->getPath()); - - throw $ex; - } - } - - protected function getValidPlaceholderTypes(): array - { - return ['float']; - } -} diff --git a/app/vendor/symfony/config/Definition/IntegerNode.php b/app/vendor/symfony/config/Definition/IntegerNode.php deleted file mode 100644 index 6fa3e6032..000000000 --- a/app/vendor/symfony/config/Definition/IntegerNode.php +++ /dev/null @@ -1,40 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; - -/** - * This node represents an integer value in the config tree. - * - * @author Jeanmonod David - */ -class IntegerNode extends NumericNode -{ - protected function validateType(mixed $value): void - { - if (!\is_int($value)) { - $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "int", but got "%s".', $this->getPath(), get_debug_type($value))); - if ($hint = $this->getInfo()) { - $ex->addHint($hint); - } - $ex->setPath($this->getPath()); - - throw $ex; - } - } - - protected function getValidPlaceholderTypes(): array - { - return ['int']; - } -} diff --git a/app/vendor/symfony/config/Definition/Loader/DefinitionFileLoader.php b/app/vendor/symfony/config/Definition/Loader/DefinitionFileLoader.php deleted file mode 100644 index 09147f791..000000000 --- a/app/vendor/symfony/config/Definition/Loader/DefinitionFileLoader.php +++ /dev/null @@ -1,103 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition\Loader; - -use Symfony\Component\Config\Definition\Builder\TreeBuilder; -use Symfony\Component\Config\Definition\Configurator\DefinitionConfigurator; -use Symfony\Component\Config\FileLocatorInterface; -use Symfony\Component\Config\Loader\FileLoader; -use Symfony\Component\DependencyInjection\ContainerBuilder; - -/** - * DefinitionFileLoader loads config definitions from a PHP file. - * - * The PHP file is required. - * - * @author Yonel Ceruto - */ -class DefinitionFileLoader extends FileLoader -{ - public function __construct( - private TreeBuilder $treeBuilder, - FileLocatorInterface $locator, - private ?ContainerBuilder $container = null, - ) { - parent::__construct($locator); - } - - public function load(mixed $resource, ?string $type = null): mixed - { - // the loader variable is exposed to the included file below - $loader = $this; - - $path = $this->locator->locate($resource); - $this->setCurrentDir(\dirname($path)); - $this->container?->fileExists($path); - - // the closure forbids access to the private scope in the included file - $load = \Closure::bind(static function ($file) use ($loader) { - return include $file; - }, null, ProtectedDefinitionFileLoader::class); - - $callback = $load($path); - - if (\is_object($callback) && \is_callable($callback)) { - $this->executeCallback($callback, new DefinitionConfigurator($this->treeBuilder, $this, $path, $resource), $path); - } - - return null; - } - - public function supports(mixed $resource, ?string $type = null): bool - { - if (!\is_string($resource)) { - return false; - } - - if (null === $type && 'php' === pathinfo($resource, \PATHINFO_EXTENSION)) { - return true; - } - - return 'php' === $type; - } - - private function executeCallback(callable $callback, DefinitionConfigurator $configurator, string $path): void - { - $callback = $callback(...); - - $arguments = []; - $r = new \ReflectionFunction($callback); - - foreach ($r->getParameters() as $parameter) { - $reflectionType = $parameter->getType(); - - if (!$reflectionType instanceof \ReflectionNamedType) { - throw new \InvalidArgumentException(\sprintf('Could not resolve argument "$%s" for "%s". You must typehint it (for example with "%s").', $parameter->getName(), $path, DefinitionConfigurator::class)); - } - - $arguments[] = match ($reflectionType->getName()) { - DefinitionConfigurator::class => $configurator, - TreeBuilder::class => $this->treeBuilder, - FileLoader::class, self::class => $this, - }; - } - - $callback(...$arguments); - } -} - -/** - * @internal - */ -final class ProtectedDefinitionFileLoader extends DefinitionFileLoader -{ -} diff --git a/app/vendor/symfony/config/Definition/NodeInterface.php b/app/vendor/symfony/config/Definition/NodeInterface.php deleted file mode 100644 index d1715870a..000000000 --- a/app/vendor/symfony/config/Definition/NodeInterface.php +++ /dev/null @@ -1,77 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException; -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; - -/** - * Common Interface among all nodes. - * - * In most cases, it is better to inherit from BaseNode instead of implementing - * this interface yourself. - * - * @author Johannes M. Schmitt - */ -interface NodeInterface -{ - /** - * Returns the name of the node. - */ - public function getName(): string; - - /** - * Returns the path of the node. - */ - public function getPath(): string; - - /** - * Returns true when the node is required. - */ - public function isRequired(): bool; - - /** - * Returns true when the node has a default value. - */ - public function hasDefaultValue(): bool; - - /** - * Returns the default value of the node. - * - * @throws \RuntimeException if the node has no default value - */ - public function getDefaultValue(): mixed; - - /** - * Normalizes a value. - * - * @throws InvalidTypeException if the value type is invalid - */ - public function normalize(mixed $value): mixed; - - /** - * Merges two values together. - * - * @throws ForbiddenOverwriteException if the configuration path cannot be overwritten - * @throws InvalidTypeException if the value type is invalid - */ - public function merge(mixed $leftSide, mixed $rightSide): mixed; - - /** - * Finalizes a value. - * - * @throws InvalidTypeException if the value type is invalid - * @throws InvalidConfigurationException if the value is invalid configuration - */ - public function finalize(mixed $value): mixed; -} diff --git a/app/vendor/symfony/config/Definition/NumericNode.php b/app/vendor/symfony/config/Definition/NumericNode.php deleted file mode 100644 index a97850c9d..000000000 --- a/app/vendor/symfony/config/Definition/NumericNode.php +++ /dev/null @@ -1,58 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; - -/** - * This node represents a numeric value in the config tree. - * - * @author David Jeanmonod - */ -class NumericNode extends ScalarNode -{ - public function __construct( - ?string $name, - ?NodeInterface $parent = null, - protected int|float|null $min = null, - protected int|float|null $max = null, - string $pathSeparator = BaseNode::DEFAULT_PATH_SEPARATOR, - ) { - parent::__construct($name, $parent, $pathSeparator); - } - - protected function finalizeValue(mixed $value): mixed - { - $value = parent::finalizeValue($value); - - $errorMsg = null; - if (isset($this->min) && $value < $this->min) { - $errorMsg = \sprintf('The value %s is too small for path "%s". Should be greater than or equal to %s', $value, $this->getPath(), $this->min); - } - if (isset($this->max) && $value > $this->max) { - $errorMsg = \sprintf('The value %s is too big for path "%s". Should be less than or equal to %s', $value, $this->getPath(), $this->max); - } - if (isset($errorMsg)) { - $ex = new InvalidConfigurationException($errorMsg); - $ex->setPath($this->getPath()); - throw $ex; - } - - return $value; - } - - protected function isValueEmpty(mixed $value): bool - { - // a numeric value cannot be empty - return false; - } -} diff --git a/app/vendor/symfony/config/Definition/Processor.php b/app/vendor/symfony/config/Definition/Processor.php deleted file mode 100644 index 272ddcc44..000000000 --- a/app/vendor/symfony/config/Definition/Processor.php +++ /dev/null @@ -1,89 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -/** - * This class is the entry point for config normalization/merging/finalization. - * - * @author Johannes M. Schmitt - * - * @final - */ -class Processor -{ - /** - * Processes an array of configurations. - * - * @param array $configs An array of configuration items to process - */ - public function process(NodeInterface $configTree, array $configs): array - { - $currentConfig = []; - foreach ($configs as $config) { - $config = $configTree->normalize($config); - $currentConfig = $configTree->merge($currentConfig, $config); - } - - return $configTree->finalize($currentConfig); - } - - /** - * Processes an array of configurations. - * - * @param array $configs An array of configuration items to process - */ - public function processConfiguration(ConfigurationInterface $configuration, array $configs): array - { - return $this->process($configuration->getConfigTreeBuilder()->buildTree(), $configs); - } - - /** - * Normalizes a configuration entry. - * - * This method returns a normalize configuration array for a given key - * to remove the differences due to the original format (YAML and XML mainly). - * - * Here is an example. - * - * The configuration in XML: - * - * twig.extension.foo - * twig.extension.bar - * - * And the same configuration in YAML: - * - * extensions: ['twig.extension.foo', 'twig.extension.bar'] - * - * @param array $config A config array - * @param string $key The key to normalize - * @param string|null $plural The plural form of the key if it is irregular - */ - public static function normalizeConfig(array $config, string $key, ?string $plural = null): array - { - $plural ??= $key.'s'; - - if (isset($config[$plural])) { - return $config[$plural]; - } - - if (isset($config[$key])) { - if (\is_string($config[$key]) || !\is_int(key($config[$key]))) { - // only one - return [$config[$key]]; - } - - return $config[$key]; - } - - return []; - } -} diff --git a/app/vendor/symfony/config/Definition/PrototypeNodeInterface.php b/app/vendor/symfony/config/Definition/PrototypeNodeInterface.php deleted file mode 100644 index 109889f37..000000000 --- a/app/vendor/symfony/config/Definition/PrototypeNodeInterface.php +++ /dev/null @@ -1,25 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -/** - * This interface must be implemented by nodes which can be used as prototypes. - * - * @author Johannes M. Schmitt - */ -interface PrototypeNodeInterface extends NodeInterface -{ - /** - * Sets the name of the node. - */ - public function setName(string $name): void; -} diff --git a/app/vendor/symfony/config/Definition/PrototypedArrayNode.php b/app/vendor/symfony/config/Definition/PrototypedArrayNode.php deleted file mode 100644 index a901dab78..000000000 --- a/app/vendor/symfony/config/Definition/PrototypedArrayNode.php +++ /dev/null @@ -1,329 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\DuplicateKeyException; -use Symfony\Component\Config\Definition\Exception\Exception; -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; -use Symfony\Component\Config\Definition\Exception\UnsetKeyException; - -/** - * Represents a prototyped Array node in the config tree. - * - * @author Johannes M. Schmitt - */ -class PrototypedArrayNode extends ArrayNode -{ - protected PrototypeNodeInterface $prototype; - protected ?string $keyAttribute = null; - protected bool $removeKeyAttribute = false; - protected int $minNumberOfElements = 0; - protected array $defaultValue = []; - protected ?array $defaultChildren = null; - /** - * @var NodeInterface[] An array of the prototypes of the simplified value children - */ - private array $valuePrototypes = []; - - /** - * Sets the minimum number of elements that a prototype based node must - * contain. By default this is zero, meaning no elements. - */ - public function setMinNumberOfElements(int $number): void - { - $this->minNumberOfElements = $number; - } - - /** - * Sets the attribute which value is to be used as key. - * - * This is useful when you have an indexed array that should be an - * associative array. You can select an item from within the array - * to be the key of the particular item. For example, if "id" is the - * "key", then: - * - * [ - * ['id' => 'my_name', 'foo' => 'bar'], - * ]; - * - * becomes - * - * [ - * 'my_name' => ['foo' => 'bar'], - * ]; - * - * If you'd like "'id' => 'my_name'" to still be present in the resulting - * array, then you can set the second argument of this method to false. - * - * @param string $attribute The name of the attribute which value is to be used as a key - * @param bool $remove Whether or not to remove the key - */ - public function setKeyAttribute(string $attribute, bool $remove = true): void - { - $this->keyAttribute = $attribute; - $this->removeKeyAttribute = $remove; - } - - /** - * Retrieves the name of the attribute which value should be used as key. - */ - public function getKeyAttribute(): ?string - { - return $this->keyAttribute; - } - - /** - * Sets the default value of this node. - */ - public function setDefaultValue(array $value): void - { - $this->defaultValue = $value; - } - - public function hasDefaultValue(): bool - { - return true; - } - - /** - * Adds default children when none are set. - * - * @param int|string|array|null $children The number of children|The child name|The children names to be added - */ - public function setAddChildrenIfNoneSet(int|string|array|null $children = ['defaults']): void - { - if (null === $children) { - $this->defaultChildren = ['defaults']; - } else { - $this->defaultChildren = \is_int($children) && $children > 0 ? range(1, $children) : (array) $children; - } - } - - /** - * The default value could be either explicited or derived from the prototype - * default value. - */ - public function getDefaultValue(): mixed - { - if (null !== $this->defaultChildren) { - $default = $this->prototype->hasDefaultValue() ? $this->prototype->getDefaultValue() : []; - $defaults = []; - foreach (array_values($this->defaultChildren) as $i => $name) { - $defaults[null === $this->keyAttribute ? $i : $name] = $default; - } - - return $defaults; - } - - return $this->defaultValue; - } - - /** - * Sets the node prototype. - */ - public function setPrototype(PrototypeNodeInterface $node): void - { - $this->prototype = $node; - } - - /** - * Retrieves the prototype. - */ - public function getPrototype(): PrototypeNodeInterface - { - return $this->prototype; - } - - /** - * Disable adding concrete children for prototyped nodes. - * - * @throws Exception - */ - public function addChild(NodeInterface $node): never - { - throw new Exception('A prototyped array node cannot have concrete children.'); - } - - protected function finalizeValue(mixed $value): mixed - { - if (false === $value) { - throw new UnsetKeyException(\sprintf('Unsetting key for path "%s", value: false.', $this->getPath())); - } - - foreach ($value as $k => $v) { - $prototype = $this->getPrototypeForChild($k); - try { - $value[$k] = $prototype->finalize($v); - } catch (UnsetKeyException) { - unset($value[$k]); - } - } - - if (\count($value) < $this->minNumberOfElements) { - $ex = new InvalidConfigurationException(\sprintf('The path "%s" should have at least %d element(s) defined.', $this->getPath(), $this->minNumberOfElements)); - $ex->setPath($this->getPath()); - - throw $ex; - } - - return $value; - } - - /** - * @throws DuplicateKeyException - */ - protected function normalizeValue(mixed $value): mixed - { - if (false === $value) { - return $value; - } - - $value = $this->remapXml($value); - - $isList = array_is_list($value); - $normalized = []; - foreach ($value as $k => $v) { - if (null !== $this->keyAttribute && \is_array($v)) { - if (!isset($v[$this->keyAttribute]) && \is_int($k) && $isList) { - $ex = new InvalidConfigurationException(\sprintf('The attribute "%s" must be set for path "%s".', $this->keyAttribute, $this->getPath())); - $ex->setPath($this->getPath()); - - throw $ex; - } elseif (isset($v[$this->keyAttribute])) { - $k = $v[$this->keyAttribute]; - - if (\is_float($k)) { - $k = var_export($k, true); - } - - // remove the key attribute when required - if ($this->removeKeyAttribute) { - unset($v[$this->keyAttribute]); - } - - // if only "value" is left - if (array_keys($v) === ['value']) { - $v = $v['value']; - if ($this->prototype instanceof ArrayNode && ($children = $this->prototype->getChildren()) && \array_key_exists('value', $children)) { - $valuePrototype = current($this->valuePrototypes) ?: clone $children['value']; - $valuePrototype->parent = $this; - $originalClosures = $this->prototype->normalizationClosures; - $valuePrototypeClosures = $valuePrototype->normalizationClosures; - $valuePrototype->normalizationClosures = array_merge($originalClosures, $valuePrototypeClosures); - $this->valuePrototypes[$k] = $valuePrototype; - } - } - } - - if (\array_key_exists($k, $normalized)) { - $ex = new DuplicateKeyException(\sprintf('Duplicate key "%s" for path "%s".', $k, $this->getPath())); - $ex->setPath($this->getPath()); - - throw $ex; - } - } - - $prototype = $this->getPrototypeForChild($k); - if (null !== $this->keyAttribute || !$isList) { - $normalized[$k] = $prototype->normalize($v); - } else { - $normalized[] = $prototype->normalize($v); - } - } - - return $normalized; - } - - protected function mergeValues(mixed $leftSide, mixed $rightSide): mixed - { - if (false === $rightSide) { - // if this is still false after the last config has been merged the - // finalization pass will take care of removing this key entirely - return false; - } - - if (false === $leftSide || !$this->performDeepMerging) { - return $rightSide; - } - - $isList = array_is_list($rightSide); - foreach ($rightSide as $k => $v) { - // prototype, and key is irrelevant there are no named keys, append the element - if (null === $this->keyAttribute && $isList) { - $leftSide[] = $v; - continue; - } - - // no conflict - if (!\array_key_exists($k, $leftSide)) { - if (!$this->allowNewKeys) { - $ex = new InvalidConfigurationException(\sprintf('You are not allowed to define new elements for path "%s". Please define all elements for this path in one config file.', $this->getPath())); - $ex->setPath($this->getPath()); - - throw $ex; - } - - $leftSide[$k] = $v; - continue; - } - - $prototype = $this->getPrototypeForChild($k); - $leftSide[$k] = $prototype->merge($leftSide[$k], $v); - } - - return $leftSide; - } - - /** - * Returns a prototype for the child node that is associated to $key in the value array. - * For general child nodes, this will be $this->prototype. - * But if $this->removeKeyAttribute is true and there are only two keys in the child node: - * one is same as this->keyAttribute and the other is 'value', then the prototype will be different. - * - * For example, assume $this->keyAttribute is 'name' and the value array is as follows: - * - * [ - * [ - * 'name' => 'name001', - * 'value' => 'value001' - * ] - * ] - * - * Now, the key is 0 and the child node is: - * - * [ - * 'name' => 'name001', - * 'value' => 'value001' - * ] - * - * When normalizing the value array, the 'name' element will removed from the child node - * and its value becomes the new key of the child node: - * - * [ - * 'name001' => ['value' => 'value001'] - * ] - * - * Now only 'value' element is left in the child node which can be further simplified into a string: - * - * ['name001' => 'value001'] - * - * Now, the key becomes 'name001' and the child node becomes 'value001' and - * the prototype of child node 'name001' should be a ScalarNode instead of an ArrayNode instance. - */ - private function getPrototypeForChild(string $key): mixed - { - $prototype = $this->valuePrototypes[$key] ?? $this->prototype; - $prototype->setName($key); - - return $prototype; - } -} diff --git a/app/vendor/symfony/config/Definition/ScalarNode.php b/app/vendor/symfony/config/Definition/ScalarNode.php deleted file mode 100644 index 341769249..000000000 --- a/app/vendor/symfony/config/Definition/ScalarNode.php +++ /dev/null @@ -1,58 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; - -/** - * This node represents a scalar value in the config tree. - * - * The following values are considered scalars: - * * booleans - * * strings - * * null - * * integers - * * floats - * - * @author Johannes M. Schmitt - */ -class ScalarNode extends VariableNode -{ - protected function validateType(mixed $value): void - { - if (!\is_scalar($value) && null !== $value) { - $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "scalar", but got "%s".', $this->getPath(), get_debug_type($value))); - if ($hint = $this->getInfo()) { - $ex->addHint($hint); - } - $ex->setPath($this->getPath()); - - throw $ex; - } - } - - protected function isValueEmpty(mixed $value): bool - { - // assume environment variables are never empty (which in practice is likely to be true during runtime) - // not doing so breaks many configs that are valid today - if ($this->isHandlingPlaceholder()) { - return false; - } - - return null === $value || '' === $value; - } - - protected function getValidPlaceholderTypes(): array - { - return ['bool', 'int', 'float', 'string']; - } -} diff --git a/app/vendor/symfony/config/Definition/StringNode.php b/app/vendor/symfony/config/Definition/StringNode.php deleted file mode 100644 index 6687b8825..000000000 --- a/app/vendor/symfony/config/Definition/StringNode.php +++ /dev/null @@ -1,40 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidTypeException; - -/** - * This node represents a String value in the config tree. - * - * @author Raffaele Carelle - */ -class StringNode extends ScalarNode -{ - protected function validateType(mixed $value): void - { - if (!\is_string($value)) { - $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "string", but got "%s".', $this->getPath(), get_debug_type($value))); - if ($hint = $this->getInfo()) { - $ex->addHint($hint); - } - $ex->setPath($this->getPath()); - - throw $ex; - } - } - - protected function getValidPlaceholderTypes(): array - { - return ['string']; - } -} diff --git a/app/vendor/symfony/config/Definition/VariableNode.php b/app/vendor/symfony/config/Definition/VariableNode.php deleted file mode 100644 index ed1b903a1..000000000 --- a/app/vendor/symfony/config/Definition/VariableNode.php +++ /dev/null @@ -1,117 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Definition; - -use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; - -/** - * This node represents a value of variable type in the config tree. - * - * This node is intended for values of arbitrary type. - * Any PHP type is accepted as a value. - * - * @author Jeremy Mikola - */ -class VariableNode extends BaseNode implements PrototypeNodeInterface -{ - protected bool $defaultValueSet = false; - protected mixed $defaultValue = null; - protected bool $allowEmptyValue = true; - - public function setDefaultValue(mixed $value): void - { - $this->defaultValueSet = true; - $this->defaultValue = $value; - } - - public function hasDefaultValue(): bool - { - return $this->defaultValueSet; - } - - public function getDefaultValue(): mixed - { - $v = $this->defaultValue; - - return $v instanceof \Closure ? $v() : $v; - } - - /** - * Sets if this node is allowed to have an empty value. - * - * @param bool $boolean True if this entity will accept empty values - */ - public function setAllowEmptyValue(bool $boolean): void - { - $this->allowEmptyValue = $boolean; - } - - public function setName(string $name): void - { - $this->name = $name; - } - - protected function validateType(mixed $value): void - { - } - - protected function finalizeValue(mixed $value): mixed - { - // deny environment variables only when using custom validators - // this avoids ever passing an empty value to final validation closures - if (!$this->allowEmptyValue && $this->isHandlingPlaceholder() && $this->finalValidationClosures) { - $e = new InvalidConfigurationException(\sprintf('The path "%s" cannot contain an environment variable when empty values are not allowed by definition and are validated.', $this->getPath())); - if ($hint = $this->getInfo()) { - $e->addHint($hint); - } - $e->setPath($this->getPath()); - - throw $e; - } - - if (!$this->allowEmptyValue && $this->isValueEmpty($value)) { - $ex = new InvalidConfigurationException(\sprintf('The path "%s" cannot contain an empty value, but got %s.', $this->getPath(), json_encode($value))); - if ($hint = $this->getInfo()) { - $ex->addHint($hint); - } - $ex->setPath($this->getPath()); - - throw $ex; - } - - return $value; - } - - protected function normalizeValue(mixed $value): mixed - { - return $value; - } - - protected function mergeValues(mixed $leftSide, mixed $rightSide): mixed - { - return $rightSide; - } - - /** - * Evaluates if the given value is to be treated as empty. - * - * By default, PHP's empty() function is used to test for emptiness. This - * method may be overridden by subtypes to better match their understanding - * of empty data. - * - * @see finalizeValue() - */ - protected function isValueEmpty(mixed $value): bool - { - return !$value; - } -} diff --git a/app/vendor/symfony/config/Exception/FileLoaderImportCircularReferenceException.php b/app/vendor/symfony/config/Exception/FileLoaderImportCircularReferenceException.php deleted file mode 100644 index d39bde046..000000000 --- a/app/vendor/symfony/config/Exception/FileLoaderImportCircularReferenceException.php +++ /dev/null @@ -1,27 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Exception; - -/** - * Exception class for when a circular reference is detected when importing resources. - * - * @author Fabien Potencier - */ -class FileLoaderImportCircularReferenceException extends LoaderLoadException -{ - public function __construct(array $resources, int $code = 0, ?\Throwable $previous = null) - { - $message = \sprintf('Circular reference detected in "%s" ("%s" > "%s").', $this->varToString($resources[0]), implode('" > "', $resources), $resources[0]); - - \Exception::__construct($message, $code, $previous); - } -} diff --git a/app/vendor/symfony/config/Exception/FileLocatorFileNotFoundException.php b/app/vendor/symfony/config/Exception/FileLocatorFileNotFoundException.php deleted file mode 100644 index d9e5b4f36..000000000 --- a/app/vendor/symfony/config/Exception/FileLocatorFileNotFoundException.php +++ /dev/null @@ -1,34 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Exception; - -/** - * File locator exception if a file does not exist. - * - * @author Leo Feyer - */ -class FileLocatorFileNotFoundException extends \InvalidArgumentException -{ - public function __construct( - string $message = '', - int $code = 0, - ?\Throwable $previous = null, - private array $paths = [], - ) { - parent::__construct($message, $code, $previous); - } - - public function getPaths(): array - { - return $this->paths; - } -} diff --git a/app/vendor/symfony/config/Exception/LoaderLoadException.php b/app/vendor/symfony/config/Exception/LoaderLoadException.php deleted file mode 100644 index ce486a35f..000000000 --- a/app/vendor/symfony/config/Exception/LoaderLoadException.php +++ /dev/null @@ -1,112 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Exception; - -/** - * Exception class for when a resource cannot be loaded or imported. - * - * @author Ryan Weaver - */ -class LoaderLoadException extends \Exception -{ - /** - * @param mixed $resource The resource that could not be imported - * @param string|null $sourceResource The original resource importing the new resource - * @param int $code The error code - * @param \Throwable|null $previous A previous exception - * @param string|null $type The type of resource - */ - public function __construct(mixed $resource, ?string $sourceResource = null, int $code = 0, ?\Throwable $previous = null, ?string $type = null) - { - if (!\is_string($resource)) { - try { - $resource = json_encode($resource, \JSON_THROW_ON_ERROR); - } catch (\JsonException) { - $resource = \sprintf('resource of type "%s"', get_debug_type($resource)); - } - } - - $message = ''; - if ($previous) { - // Include the previous exception, to help the user see what might be the underlying cause - - // Trim the trailing period of the previous message. We only want 1 period remove so no rtrim... - if (str_ends_with($previous->getMessage(), '.')) { - $trimmedMessage = substr($previous->getMessage(), 0, -1); - $message .= \sprintf('%s', $trimmedMessage).' in '; - } else { - $message .= \sprintf('%s', $previous->getMessage()).' in '; - } - $message .= $resource.' '; - - // show tweaked trace to complete the human readable sentence - if (null === $sourceResource) { - $message .= \sprintf('(which is loaded in resource "%s")', $resource); - } else { - $message .= \sprintf('(which is being imported from "%s")', $sourceResource); - } - $message .= '.'; - - // if there's no previous message, present it the default way - } elseif (null === $sourceResource) { - $message .= \sprintf('Cannot load resource "%s".', $resource); - } else { - $message .= \sprintf('Cannot import resource "%s" from "%s".', $resource, $sourceResource); - } - - // Is the resource located inside a bundle? - if ('@' === $resource[0]) { - $parts = explode(\DIRECTORY_SEPARATOR, $resource); - $bundle = substr($parts[0], 1); - $message .= \sprintf(' Make sure the "%s" bundle is correctly registered and loaded in the application kernel class.', $bundle); - $message .= \sprintf(' If the bundle is registered, make sure the bundle path "%s" is not empty.', $resource); - } elseif (null !== $type) { - $message .= \sprintf(' Make sure there is a loader supporting the "%s" type.', $type); - } - - parent::__construct($message, $code, $previous); - } - - protected function varToString(mixed $var): string - { - if (\is_object($var)) { - return \sprintf('Object(%s)', $var::class); - } - - if (\is_array($var)) { - $a = []; - foreach ($var as $k => $v) { - $a[] = \sprintf('%s => %s', $k, $this->varToString($v)); - } - - return \sprintf('Array(%s)', implode(', ', $a)); - } - - if (\is_resource($var)) { - return \sprintf('Resource(%s)', get_resource_type($var)); - } - - if (null === $var) { - return 'null'; - } - - if (false === $var) { - return 'false'; - } - - if (true === $var) { - return 'true'; - } - - return (string) $var; - } -} diff --git a/app/vendor/symfony/config/Exception/LogicException.php b/app/vendor/symfony/config/Exception/LogicException.php deleted file mode 100644 index d227aece4..000000000 --- a/app/vendor/symfony/config/Exception/LogicException.php +++ /dev/null @@ -1,16 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Exception; - -class LogicException extends \LogicException -{ -} diff --git a/app/vendor/symfony/config/FileLocator.php b/app/vendor/symfony/config/FileLocator.php deleted file mode 100644 index 3a5064edc..000000000 --- a/app/vendor/symfony/config/FileLocator.php +++ /dev/null @@ -1,97 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException; - -/** - * FileLocator uses an array of pre-defined paths to find files. - * - * @author Fabien Potencier - */ -class FileLocator implements FileLocatorInterface -{ - protected array $paths; - - /** - * @param string|string[] $paths A path or an array of paths where to look for resources - */ - public function __construct(string|array $paths = []) - { - $this->paths = (array) $paths; - } - - /** - * @return string|string[] - * - * @psalm-return ($first is true ? string : string[]) - */ - public function locate(string $name, ?string $currentPath = null, bool $first = true): string|array - { - if ('' === $name) { - throw new \InvalidArgumentException('An empty file name is not valid to be located.'); - } - - if ($this->isAbsolutePath($name)) { - if (!file_exists($name)) { - throw new FileLocatorFileNotFoundException(\sprintf('The file "%s" does not exist.', $name), 0, null, [$name]); - } - - return $name; - } - - $paths = $this->paths; - - if (null !== $currentPath) { - array_unshift($paths, $currentPath); - } - - $paths = array_unique($paths); - $filepaths = $notfound = []; - - foreach ($paths as $path) { - if (@file_exists($file = $path.\DIRECTORY_SEPARATOR.$name)) { - if (true === $first) { - return $file; - } - $filepaths[] = $file; - } else { - $notfound[] = $file; - } - } - - if (!$filepaths) { - throw new FileLocatorFileNotFoundException(\sprintf('The file "%s" does not exist (in: "%s").', $name, implode('", "', $paths)), 0, null, $notfound); - } - - return $filepaths; - } - - /** - * Returns whether the file path is an absolute path. - */ - private function isAbsolutePath(string $file): bool - { - if ('/' === $file[0] || '\\' === $file[0] - || (\strlen($file) > 3 && ctype_alpha($file[0]) - && ':' === $file[1] - && ('\\' === $file[2] || '/' === $file[2]) - ) - || parse_url($file, \PHP_URL_SCHEME) - || str_starts_with($file, 'phar:///') // "parse_url()" doesn't handle absolute phar path, despite being valid - ) { - return true; - } - - return false; - } -} diff --git a/app/vendor/symfony/config/FileLocatorInterface.php b/app/vendor/symfony/config/FileLocatorInterface.php deleted file mode 100644 index 24bc70964..000000000 --- a/app/vendor/symfony/config/FileLocatorInterface.php +++ /dev/null @@ -1,36 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException; - -/** - * @author Fabien Potencier - */ -interface FileLocatorInterface -{ - /** - * Returns a full path for a given file name. - * - * @param string $name The file name to locate - * @param string|null $currentPath The current path - * @param bool $first Whether to return the first occurrence or an array of filenames - * - * @return string|string[] The full path to the file or an array of file paths - * - * @psalm-return ($first is true ? string : string[]) - * - * @throws \InvalidArgumentException If $name is empty - * @throws FileLocatorFileNotFoundException If a file is not found - */ - public function locate(string $name, ?string $currentPath = null, bool $first = true): string|array; -} diff --git a/app/vendor/symfony/config/LICENSE b/app/vendor/symfony/config/LICENSE deleted file mode 100644 index 0138f8f07..000000000 --- a/app/vendor/symfony/config/LICENSE +++ /dev/null @@ -1,19 +0,0 @@ -Copyright (c) 2004-present Fabien Potencier - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is furnished -to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. diff --git a/app/vendor/symfony/config/Loader/DelegatingLoader.php b/app/vendor/symfony/config/Loader/DelegatingLoader.php deleted file mode 100644 index 045a559e2..000000000 --- a/app/vendor/symfony/config/Loader/DelegatingLoader.php +++ /dev/null @@ -1,44 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -use Symfony\Component\Config\Exception\LoaderLoadException; - -/** - * DelegatingLoader delegates loading to other loaders using a loader resolver. - * - * This loader acts as an array of LoaderInterface objects - each having - * a chance to load a given resource (handled by the resolver) - * - * @author Fabien Potencier - */ -class DelegatingLoader extends Loader -{ - public function __construct(LoaderResolverInterface $resolver) - { - $this->resolver = $resolver; - } - - public function load(mixed $resource, ?string $type = null): mixed - { - if (false === $loader = $this->resolver->resolve($resource, $type)) { - throw new LoaderLoadException($resource, null, 0, null, $type); - } - - return $loader->load($resource, $type); - } - - public function supports(mixed $resource, ?string $type = null): bool - { - return false !== $this->resolver->resolve($resource, $type); - } -} diff --git a/app/vendor/symfony/config/Loader/DirectoryAwareLoaderInterface.php b/app/vendor/symfony/config/Loader/DirectoryAwareLoaderInterface.php deleted file mode 100644 index 87559cba9..000000000 --- a/app/vendor/symfony/config/Loader/DirectoryAwareLoaderInterface.php +++ /dev/null @@ -1,22 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -/** - * A loader that can be scoped to a given filesystem directory. - * - * @author Alexander M. Turek - */ -interface DirectoryAwareLoaderInterface -{ - public function forDirectory(string $currentDirectory): static; -} diff --git a/app/vendor/symfony/config/Loader/FileLoader.php b/app/vendor/symfony/config/Loader/FileLoader.php deleted file mode 100644 index 8d9d84627..000000000 --- a/app/vendor/symfony/config/Loader/FileLoader.php +++ /dev/null @@ -1,183 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -use Symfony\Component\Config\Exception\FileLoaderImportCircularReferenceException; -use Symfony\Component\Config\Exception\FileLocatorFileNotFoundException; -use Symfony\Component\Config\Exception\LoaderLoadException; -use Symfony\Component\Config\FileLocatorInterface; -use Symfony\Component\Config\Resource\FileExistenceResource; -use Symfony\Component\Config\Resource\GlobResource; - -/** - * FileLoader is the abstract class used by all built-in loaders that are file based. - * - * @author Fabien Potencier - */ -abstract class FileLoader extends Loader -{ - protected static array $loading = []; - - private ?string $currentDir = null; - - public function __construct( - protected FileLocatorInterface $locator, - ?string $env = null, - ) { - parent::__construct($env); - } - - /** - * Sets the current directory. - */ - public function setCurrentDir(string $dir): void - { - $this->currentDir = $dir; - } - - /** - * Returns the file locator used by this loader. - */ - public function getLocator(): FileLocatorInterface - { - return $this->locator; - } - - /** - * Imports a resource. - * - * @param mixed $resource A Resource - * @param string|null $type The resource type or null if unknown - * @param bool $ignoreErrors Whether to ignore import errors or not - * @param string|null $sourceResource The original resource importing the new resource - * @param string|string[]|null $exclude Glob patterns to exclude from the import - * - * @throws LoaderLoadException - * @throws FileLoaderImportCircularReferenceException - * @throws FileLocatorFileNotFoundException - */ - public function import(mixed $resource, ?string $type = null, bool $ignoreErrors = false, ?string $sourceResource = null, string|array|null $exclude = null): mixed - { - if (\is_string($resource) && \strlen($resource) !== ($i = strcspn($resource, '*?{[')) && !str_contains($resource, "\n")) { - $excluded = []; - foreach ((array) $exclude as $pattern) { - foreach ($this->glob($pattern, true, $_, false, true) as $path => $info) { - // normalize Windows slashes and remove trailing slashes - $excluded[rtrim(str_replace('\\', '/', $path), '/')] = true; - } - } - - $ret = []; - $isSubpath = 0 !== $i && str_contains(substr($resource, 0, $i), '/'); - foreach ($this->glob($resource, false, $_, $ignoreErrors || !$isSubpath, false, $excluded) as $path => $info) { - if (null !== $res = $this->doImport($path, 'glob' === $type ? null : $type, $ignoreErrors, $sourceResource)) { - $ret[] = $res; - } - $isSubpath = true; - } - - if ($isSubpath) { - return isset($ret[1]) ? $ret : ($ret[0] ?? null); - } - } - - return $this->doImport($resource, $type, $ignoreErrors, $sourceResource); - } - - /** - * @internal - */ - protected function glob(string $pattern, bool $recursive, array|GlobResource|null &$resource = null, bool $ignoreErrors = false, bool $forExclusion = false, array $excluded = []): iterable - { - if (\strlen($pattern) === $i = strcspn($pattern, '*?{[')) { - $prefix = $pattern; - $pattern = ''; - } elseif (0 === $i || !str_contains(substr($pattern, 0, $i), '/')) { - $prefix = '.'; - $pattern = '/'.$pattern; - } else { - $prefix = \dirname(substr($pattern, 0, 1 + $i)); - $pattern = substr($pattern, \strlen($prefix)); - } - - try { - $prefix = $this->locator->locate($prefix, $this->currentDir, true); - } catch (FileLocatorFileNotFoundException $e) { - if (!$ignoreErrors) { - throw $e; - } - - $resource = []; - foreach ($e->getPaths() as $path) { - $resource[] = new FileExistenceResource($path); - } - - return; - } - $resource = new GlobResource($prefix, $pattern, $recursive, $forExclusion, $excluded); - - yield from $resource; - } - - private function doImport(mixed $resource, ?string $type = null, bool $ignoreErrors = false, ?string $sourceResource = null): mixed - { - try { - $loader = $this->resolve($resource, $type); - - if ($loader instanceof DirectoryAwareLoaderInterface) { - $loader = $loader->forDirectory($this->currentDir); - } - - if (!$loader instanceof self) { - return $loader->load($resource, $type); - } - - if (null !== $this->currentDir) { - $resource = $loader->getLocator()->locate($resource, $this->currentDir, false); - } - - $resources = \is_array($resource) ? $resource : [$resource]; - for ($i = 0; $i < $resourcesCount = \count($resources); ++$i) { - if (isset(self::$loading[$resources[$i]])) { - if ($i == $resourcesCount - 1) { - throw new FileLoaderImportCircularReferenceException(array_keys(self::$loading)); - } - } else { - $resource = $resources[$i]; - break; - } - } - self::$loading[$resource] = true; - - try { - $ret = $loader->load($resource, $type); - } finally { - unset(self::$loading[$resource]); - } - - return $ret; - } catch (FileLoaderImportCircularReferenceException $e) { - throw $e; - } catch (\Exception $e) { - if (!$ignoreErrors) { - // prevent embedded imports from nesting multiple exceptions - if ($e instanceof LoaderLoadException) { - throw $e; - } - - throw new LoaderLoadException($resource, $sourceResource, 0, $e, $type); - } - } - - return null; - } -} diff --git a/app/vendor/symfony/config/Loader/GlobFileLoader.php b/app/vendor/symfony/config/Loader/GlobFileLoader.php deleted file mode 100644 index 31eebf69d..000000000 --- a/app/vendor/symfony/config/Loader/GlobFileLoader.php +++ /dev/null @@ -1,30 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -/** - * GlobFileLoader loads files from a glob pattern. - * - * @author Fabien Potencier - */ -class GlobFileLoader extends FileLoader -{ - public function load(mixed $resource, ?string $type = null): mixed - { - return $this->import($resource); - } - - public function supports(mixed $resource, ?string $type = null): bool - { - return 'glob' === $type; - } -} diff --git a/app/vendor/symfony/config/Loader/Loader.php b/app/vendor/symfony/config/Loader/Loader.php deleted file mode 100644 index 28e5877bf..000000000 --- a/app/vendor/symfony/config/Loader/Loader.php +++ /dev/null @@ -1,72 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -use Symfony\Component\Config\Exception\LoaderLoadException; -use Symfony\Component\Config\Exception\LogicException; - -/** - * Loader is the abstract class used by all built-in loaders. - * - * @author Fabien Potencier - */ -abstract class Loader implements LoaderInterface -{ - protected ?LoaderResolverInterface $resolver = null; - - public function __construct( - protected ?string $env = null, - ) { - } - - public function getResolver(): LoaderResolverInterface - { - if (null === $this->resolver) { - throw new LogicException('Cannot get a resolver if none was set.'); - } - - return $this->resolver; - } - - public function setResolver(LoaderResolverInterface $resolver): void - { - $this->resolver = $resolver; - } - - /** - * Imports a resource. - */ - public function import(mixed $resource, ?string $type = null): mixed - { - return $this->resolve($resource, $type)->load($resource, $type); - } - - /** - * Finds a loader able to load an imported resource. - * - * @throws LoaderLoadException If no loader is found - */ - public function resolve(mixed $resource, ?string $type = null): LoaderInterface - { - if ($this->supports($resource, $type)) { - return $this; - } - - $loader = null === $this->resolver ? false : $this->resolver->resolve($resource, $type); - - if (false === $loader) { - throw new LoaderLoadException($resource, null, 0, null, $type); - } - - return $loader; - } -} diff --git a/app/vendor/symfony/config/Loader/LoaderInterface.php b/app/vendor/symfony/config/Loader/LoaderInterface.php deleted file mode 100644 index 6ed1893a5..000000000 --- a/app/vendor/symfony/config/Loader/LoaderInterface.php +++ /dev/null @@ -1,44 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -/** - * LoaderInterface is the interface implemented by all loader classes. - * - * @author Fabien Potencier - */ -interface LoaderInterface -{ - /** - * Loads a resource. - * - * @throws \Exception If something went wrong - */ - public function load(mixed $resource, ?string $type = null): mixed; - - /** - * Returns whether this class supports the given resource. - * - * @param mixed $resource A resource - */ - public function supports(mixed $resource, ?string $type = null): bool; - - /** - * Gets the loader resolver. - */ - public function getResolver(): LoaderResolverInterface; - - /** - * Sets the loader resolver. - */ - public function setResolver(LoaderResolverInterface $resolver): void; -} diff --git a/app/vendor/symfony/config/Loader/LoaderResolver.php b/app/vendor/symfony/config/Loader/LoaderResolver.php deleted file mode 100644 index 8308d7e89..000000000 --- a/app/vendor/symfony/config/Loader/LoaderResolver.php +++ /dev/null @@ -1,65 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -/** - * LoaderResolver selects a loader for a given resource. - * - * A resource can be anything (e.g. a full path to a config file or a Closure). - * Each loader determines whether it can load a resource and how. - * - * @author Fabien Potencier - */ -class LoaderResolver implements LoaderResolverInterface -{ - /** - * @var LoaderInterface[] An array of LoaderInterface objects - */ - private array $loaders = []; - - /** - * @param LoaderInterface[] $loaders An array of loaders - */ - public function __construct(array $loaders = []) - { - foreach ($loaders as $loader) { - $this->addLoader($loader); - } - } - - public function resolve(mixed $resource, ?string $type = null): LoaderInterface|false - { - foreach ($this->loaders as $loader) { - if ($loader->supports($resource, $type)) { - return $loader; - } - } - - return false; - } - - public function addLoader(LoaderInterface $loader): void - { - $this->loaders[] = $loader; - $loader->setResolver($this); - } - - /** - * Returns the registered loaders. - * - * @return LoaderInterface[] - */ - public function getLoaders(): array - { - return $this->loaders; - } -} diff --git a/app/vendor/symfony/config/Loader/LoaderResolverInterface.php b/app/vendor/symfony/config/Loader/LoaderResolverInterface.php deleted file mode 100644 index a8bb3a437..000000000 --- a/app/vendor/symfony/config/Loader/LoaderResolverInterface.php +++ /dev/null @@ -1,27 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -/** - * LoaderResolverInterface selects a loader for a given resource. - * - * @author Fabien Potencier - */ -interface LoaderResolverInterface -{ - /** - * Returns a loader able to load the resource. - * - * @param string|null $type The resource type or null if unknown - */ - public function resolve(mixed $resource, ?string $type = null): LoaderInterface|false; -} diff --git a/app/vendor/symfony/config/Loader/ParamConfigurator.php b/app/vendor/symfony/config/Loader/ParamConfigurator.php deleted file mode 100644 index ed1045270..000000000 --- a/app/vendor/symfony/config/Loader/ParamConfigurator.php +++ /dev/null @@ -1,30 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Loader; - -/** - * Placeholder for a parameter. - * - * @author Tobias Nyholm - */ -class ParamConfigurator -{ - public function __construct( - private string $name, - ) { - } - - public function __toString(): string - { - return '%'.$this->name.'%'; - } -} diff --git a/app/vendor/symfony/config/README.md b/app/vendor/symfony/config/README.md deleted file mode 100644 index 10c2ddd05..000000000 --- a/app/vendor/symfony/config/README.md +++ /dev/null @@ -1,15 +0,0 @@ -Config Component -================ - -The Config component helps find, load, combine, autofill and validate -configuration values of any kind, whatever their source may be (YAML, XML, INI -files, or for instance a database). - -Resources ---------- - - * [Documentation](https://symfony.com/doc/current/components/config.html) - * [Contributing](https://symfony.com/doc/current/contributing/index.html) - * [Report issues](https://github.com/symfony/symfony/issues) and - [send Pull Requests](https://github.com/symfony/symfony/pulls) - in the [main Symfony repository](https://github.com/symfony/symfony) diff --git a/app/vendor/symfony/config/Resource/ClassExistenceResource.php b/app/vendor/symfony/config/Resource/ClassExistenceResource.php deleted file mode 100644 index e7851740c..000000000 --- a/app/vendor/symfony/config/Resource/ClassExistenceResource.php +++ /dev/null @@ -1,227 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -/** - * ClassExistenceResource represents a class existence. - * Freshness is only evaluated against resource existence. - * - * The resource must be a fully-qualified class name. - * - * @author Fabien Potencier - * - * @final - */ -class ClassExistenceResource implements SelfCheckingResourceInterface -{ - private ?array $exists = null; - - private static int $autoloadLevel = 0; - private static ?string $autoloadedClass = null; - private static array $existsCache = []; - - /** - * @param string $resource The fully-qualified class name - * @param bool|null $exists Boolean when the existence check has already been done - */ - public function __construct( - private string $resource, - ?bool $exists = null, - ) { - if (null !== $exists) { - $this->exists = [$exists, null]; - } - } - - public function __toString(): string - { - return $this->resource; - } - - public function getResource(): string - { - return $this->resource; - } - - /** - * @throws \ReflectionException when a parent class/interface/trait is not found - */ - public function isFresh(int $timestamp): bool - { - $loaded = class_exists($this->resource, false) || interface_exists($this->resource, false) || trait_exists($this->resource, false); - - if (null !== $exists = &self::$existsCache[$this->resource]) { - if ($loaded) { - $exists = [true, null]; - } elseif (0 >= $timestamp && !$exists[0] && null !== $exists[1]) { - throw new \ReflectionException($exists[1]); - } - } elseif ([false, null] === $exists = [$loaded, null]) { - if (!self::$autoloadLevel++) { - spl_autoload_register(__CLASS__.'::throwOnRequiredClass'); - } - $autoloadedClass = self::$autoloadedClass; - self::$autoloadedClass = ltrim($this->resource, '\\'); - - try { - $exists[0] = class_exists($this->resource) || interface_exists($this->resource, false) || trait_exists($this->resource, false); - } catch (\Exception $e) { - $exists[1] = $e->getMessage(); - - try { - self::throwOnRequiredClass($this->resource, $e); - } catch (\ReflectionException $e) { - if (0 >= $timestamp) { - throw $e; - } - } - } catch (\Throwable $e) { - $exists[1] = $e->getMessage(); - - throw $e; - } finally { - self::$autoloadedClass = $autoloadedClass; - if (!--self::$autoloadLevel) { - spl_autoload_unregister(__CLASS__.'::throwOnRequiredClass'); - } - } - } - - $this->exists ??= $exists; - - return $this->exists[0] xor !$exists[0]; - } - - /** - * @internal - */ - public function __sleep(): array - { - if (null === $this->exists) { - $this->isFresh(0); - } - - return ['resource', 'exists']; - } - - /** - * @internal - */ - public function __wakeup(): void - { - if (\is_bool($this->exists)) { - $this->exists = [$this->exists, null]; - } - } - - /** - * Throws a reflection exception when the passed class does not exist but is required. - * - * A class is considered "not required" when it's loaded as part of a "class_exists" or similar check. - * - * This function can be used as an autoload function to throw a reflection - * exception if the class was not found by previous autoload functions. - * - * A previous exception can be passed. In this case, the class is considered as being - * required totally, so if it doesn't exist, a reflection exception is always thrown. - * If it exists, the previous exception is rethrown. - * - * @throws \ReflectionException - * - * @internal - */ - public static function throwOnRequiredClass(string $class, ?\Exception $previous = null): void - { - // If the passed class is the resource being checked, we shouldn't throw. - if (null === $previous && self::$autoloadedClass === $class) { - return; - } - - if (class_exists($class, false) || interface_exists($class, false) || trait_exists($class, false)) { - if (null !== $previous) { - throw $previous; - } - - return; - } - - if ($previous instanceof \ReflectionException) { - throw $previous; - } - - $message = \sprintf('Class "%s" not found.', $class); - - if ($class !== (self::$autoloadedClass ?? $class)) { - $message = substr_replace($message, \sprintf(' while loading "%s"', self::$autoloadedClass), -1, 0); - } - - if (null !== $previous) { - $message = $previous->getMessage(); - } - - $e = new \ReflectionException($message, 0, $previous); - - if (null !== $previous) { - throw $e; - } - - $trace = debug_backtrace(); - $autoloadFrame = [ - 'function' => 'spl_autoload_call', - 'args' => [$class], - ]; - - if (isset($trace[1])) { - $callerFrame = $trace[1]; - $i = 2; - } elseif (false !== $i = array_search($autoloadFrame, $trace, true)) { - $callerFrame = $trace[++$i]; - } else { - throw $e; - } - - if (isset($callerFrame['function']) && !isset($callerFrame['class'])) { - switch ($callerFrame['function']) { - case 'get_class_methods': - case 'get_class_vars': - case 'get_parent_class': - case 'is_a': - case 'is_subclass_of': - case 'class_exists': - case 'class_implements': - case 'class_parents': - case 'trait_exists': - case 'defined': - case 'interface_exists': - case 'method_exists': - case 'property_exists': - case 'is_callable': - return; - } - - $props = [ - 'file' => $callerFrame['file'] ?? null, - 'line' => $callerFrame['line'] ?? null, - 'trace' => \array_slice($trace, 1 + $i), - ]; - - foreach ($props as $p => $v) { - if (null !== $v) { - $r = new \ReflectionProperty(\Exception::class, $p); - $r->setValue($e, $v); - } - } - } - - throw $e; - } -} diff --git a/app/vendor/symfony/config/Resource/ComposerResource.php b/app/vendor/symfony/config/Resource/ComposerResource.php deleted file mode 100644 index 834812253..000000000 --- a/app/vendor/symfony/config/Resource/ComposerResource.php +++ /dev/null @@ -1,64 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -/** - * ComposerResource tracks the PHP version and Composer dependencies. - * - * @author Nicolas Grekas - * - * @final - */ -class ComposerResource implements SelfCheckingResourceInterface -{ - private array $vendors; - - private static array $runtimeVendors; - - public function __construct() - { - self::refresh(); - $this->vendors = self::$runtimeVendors; - } - - public function getVendors(): array - { - return array_keys($this->vendors); - } - - public function __toString(): string - { - return __CLASS__; - } - - public function isFresh(int $timestamp): bool - { - self::refresh(); - - return array_values(self::$runtimeVendors) === array_values($this->vendors); - } - - private static function refresh(): void - { - self::$runtimeVendors = []; - - foreach (get_declared_classes() as $class) { - if ('C' === $class[0] && str_starts_with($class, 'ComposerAutoloaderInit')) { - $r = new \ReflectionClass($class); - $v = \dirname($r->getFileName(), 2); - if (is_file($v.'/composer/installed.json')) { - self::$runtimeVendors[$v] = @filemtime($v.'/composer/installed.json'); - } - } - } - } -} diff --git a/app/vendor/symfony/config/Resource/DirectoryResource.php b/app/vendor/symfony/config/Resource/DirectoryResource.php deleted file mode 100644 index 5fd5f65c9..000000000 --- a/app/vendor/symfony/config/Resource/DirectoryResource.php +++ /dev/null @@ -1,96 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -/** - * DirectoryResource represents a resources stored in a subdirectory tree. - * - * @author Fabien Potencier - * - * @final - */ -class DirectoryResource implements SelfCheckingResourceInterface -{ - private string $resource; - - /** - * @param string $resource The file path to the resource - * @param string|null $pattern A pattern to restrict monitored files - * - * @throws \InvalidArgumentException - */ - public function __construct( - string $resource, - private ?string $pattern = null, - ) { - $resolvedResource = realpath($resource) ?: (file_exists($resource) ? $resource : false); - - if (false === $resolvedResource || !is_dir($resolvedResource)) { - throw new \InvalidArgumentException(\sprintf('The directory "%s" does not exist.', $resource)); - } - - $this->resource = $resolvedResource; - } - - public function __toString(): string - { - return hash('xxh128', serialize([$this->resource, $this->pattern])); - } - - public function getResource(): string - { - return $this->resource; - } - - public function getPattern(): ?string - { - return $this->pattern; - } - - public function isFresh(int $timestamp): bool - { - if (!is_dir($this->resource)) { - return false; - } - - if ($timestamp < filemtime($this->resource)) { - return false; - } - - foreach (new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($this->resource), \RecursiveIteratorIterator::SELF_FIRST) as $file) { - // if regex filtering is enabled only check matching files - if ($this->pattern && $file->isFile() && !preg_match($this->pattern, $file->getBasename())) { - continue; - } - - // always monitor directories for changes, except the .. entries - // (otherwise deleted files wouldn't get detected) - if ($file->isDir() && str_ends_with($file, '/..')) { - continue; - } - - // for broken links - try { - $fileMTime = $file->getMTime(); - } catch (\RuntimeException) { - continue; - } - - // early return if a file's mtime exceeds the passed timestamp - if ($timestamp < $fileMTime) { - return false; - } - } - - return true; - } -} diff --git a/app/vendor/symfony/config/Resource/FileExistenceResource.php b/app/vendor/symfony/config/Resource/FileExistenceResource.php deleted file mode 100644 index 4722537d8..000000000 --- a/app/vendor/symfony/config/Resource/FileExistenceResource.php +++ /dev/null @@ -1,51 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -/** - * FileExistenceResource represents a resource stored on the filesystem. - * Freshness is only evaluated against resource creation or deletion. - * - * The resource can be a file or a directory. - * - * @author Charles-Henri Bruyand - * - * @final - */ -class FileExistenceResource implements SelfCheckingResourceInterface -{ - private bool $exists; - - /** - * @param string $resource The file path to the resource - */ - public function __construct( - private string $resource, - ) { - $this->exists = file_exists($resource); - } - - public function __toString(): string - { - return 'existence.'.$this->resource; - } - - public function getResource(): string - { - return $this->resource; - } - - public function isFresh(int $timestamp): bool - { - return file_exists($this->resource) === $this->exists; - } -} diff --git a/app/vendor/symfony/config/Resource/FileResource.php b/app/vendor/symfony/config/Resource/FileResource.php deleted file mode 100644 index 44e5bbc57..000000000 --- a/app/vendor/symfony/config/Resource/FileResource.php +++ /dev/null @@ -1,60 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -/** - * FileResource represents a resource stored on the filesystem. - * - * The resource can be a file or a directory. - * - * @author Fabien Potencier - * - * @final - */ -class FileResource implements SelfCheckingResourceInterface -{ - private string $resource; - - /** - * @param string $resource The file path to the resource - * - * @throws \InvalidArgumentException - */ - public function __construct(string $resource) - { - $resolvedResource = realpath($resource) ?: (file_exists($resource) ? $resource : false); - - if (false === $resolvedResource) { - throw new \InvalidArgumentException(\sprintf('The file "%s" does not exist.', $resource)); - } - - $this->resource = $resolvedResource; - } - - public function __toString(): string - { - return $this->resource; - } - - /** - * Returns the canonicalized, absolute path to the resource. - */ - public function getResource(): string - { - return $this->resource; - } - - public function isFresh(int $timestamp): bool - { - return false !== ($filemtime = @filemtime($this->resource)) && $filemtime <= $timestamp; - } -} diff --git a/app/vendor/symfony/config/Resource/GlobResource.php b/app/vendor/symfony/config/Resource/GlobResource.php deleted file mode 100644 index e6a348e11..000000000 --- a/app/vendor/symfony/config/Resource/GlobResource.php +++ /dev/null @@ -1,248 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -use Symfony\Component\Finder\Finder; -use Symfony\Component\Finder\Glob; - -/** - * GlobResource represents a set of resources stored on the filesystem. - * - * Only existence/removal is tracked (not mtimes.) - * - * @author Nicolas Grekas - * - * @final - * - * @implements \IteratorAggregate - */ -class GlobResource implements \IteratorAggregate, SelfCheckingResourceInterface -{ - private string $prefix; - private string $hash; - private array $excludedPrefixes; - private int $globBrace; - - /** - * @param string $prefix A directory prefix - * @param string $pattern A glob pattern - * @param bool $recursive Whether directories should be scanned recursively or not - * - * @throws \InvalidArgumentException - */ - public function __construct( - string $prefix, - private string $pattern, - private bool $recursive, - private bool $forExclusion = false, - array $excludedPrefixes = [], - ) { - ksort($excludedPrefixes); - $resolvedPrefix = realpath($prefix) ?: (file_exists($prefix) ? $prefix : false); - $this->excludedPrefixes = $excludedPrefixes; - $this->globBrace = \defined('GLOB_BRACE') ? \GLOB_BRACE : 0; - - if (false === $resolvedPrefix) { - throw new \InvalidArgumentException(\sprintf('The path "%s" does not exist.', $prefix)); - } - - $this->prefix = $resolvedPrefix; - } - - public function getPrefix(): string - { - return $this->prefix; - } - - public function __toString(): string - { - return 'glob.'.$this->prefix.(int) $this->recursive.$this->pattern.(int) $this->forExclusion.implode("\0", $this->excludedPrefixes); - } - - public function isFresh(int $timestamp): bool - { - $hash = $this->computeHash(); - $this->hash ??= $hash; - - return $this->hash === $hash; - } - - /** - * @internal - */ - public function __sleep(): array - { - $this->hash ??= $this->computeHash(); - - return ['prefix', 'pattern', 'recursive', 'hash', 'forExclusion', 'excludedPrefixes']; - } - - /** - * @internal - */ - public function __wakeup(): void - { - $this->globBrace = \defined('GLOB_BRACE') ? \GLOB_BRACE : 0; - } - - public function getIterator(): \Traversable - { - if ((!$this->recursive && '' === $this->pattern) || !file_exists($this->prefix)) { - return; - } - - if (is_file($prefix = str_replace('\\', '/', $this->prefix))) { - $prefix = \dirname($prefix); - $pattern = basename($prefix).$this->pattern; - } else { - $pattern = $this->pattern; - } - - if (class_exists(Finder::class)) { - $regex = Glob::toRegex($pattern); - if ($this->recursive) { - $regex = substr_replace($regex, '(/|$)', -2, 1); - } - } else { - $regex = null; - } - - $prefixLen = \strlen($prefix); - $paths = null; - - if ('' === $this->pattern && is_file($this->prefix)) { - $paths = [$this->prefix => null]; - } elseif (!str_starts_with($this->prefix, 'phar://') && (null !== $regex || !str_contains($this->pattern, '/**/'))) { - if (!str_contains($this->pattern, '/**/') && ($this->globBrace || !str_contains($this->pattern, '{'))) { - $paths = array_fill_keys(glob($this->prefix.$this->pattern, \GLOB_NOSORT | $this->globBrace), null); - } elseif (!str_contains($this->pattern, '\\') || !preg_match('/\\\\[,{}]/', $this->pattern)) { - $paths = []; - foreach ($this->expandGlob($this->pattern) as $p) { - if (false !== $i = strpos($p, '/**/')) { - $p = substr_replace($p, '/*', $i); - } - $paths += array_fill_keys(glob($this->prefix.$p, \GLOB_NOSORT), false !== $i ? $regex : null); - } - } - } - - if (null !== $paths) { - uksort($paths, 'strnatcmp'); - foreach ($paths as $path => $regex) { - if ($this->excludedPrefixes) { - $normalizedPath = str_replace('\\', '/', $path); - do { - if (isset($this->excludedPrefixes[$dirPath = $normalizedPath])) { - continue 2; - } - } while ($prefix !== $dirPath && $dirPath !== $normalizedPath = \dirname($dirPath)); - } - - if ((null === $regex || preg_match($regex, substr(str_replace('\\', '/', $path), $prefixLen))) && is_file($path)) { - yield $path => new \SplFileInfo($path); - } - if (!is_dir($path)) { - continue; - } - if ($this->forExclusion && (null === $regex || preg_match($regex, substr(str_replace('\\', '/', $path), $prefixLen)))) { - yield $path => new \SplFileInfo($path); - continue; - } - if (!($this->recursive || null !== $regex) || isset($this->excludedPrefixes[str_replace('\\', '/', $path)])) { - continue; - } - $files = iterator_to_array(new \RecursiveIteratorIterator( - new \RecursiveCallbackFilterIterator( - new \RecursiveDirectoryIterator($path, \FilesystemIterator::SKIP_DOTS | \FilesystemIterator::FOLLOW_SYMLINKS), - fn (\SplFileInfo $file, $path) => !isset($this->excludedPrefixes[$path = str_replace('\\', '/', $path)]) - && (null === $regex || preg_match($regex, substr($path, $prefixLen)) || $file->isDir()) - && '.' !== $file->getBasename()[0] - ), - \RecursiveIteratorIterator::LEAVES_ONLY - )); - uksort($files, 'strnatcmp'); - - foreach ($files as $path => $info) { - if ($info->isFile()) { - yield $path => $info; - } - } - } - - return; - } - - if (!class_exists(Finder::class)) { - throw new \LogicException('Extended glob patterns cannot be used as the Finder component is not installed. Try running "composer require symfony/finder".'); - } - - yield from (new Finder()) - ->followLinks() - ->filter(function (\SplFileInfo $info) use ($regex, $prefixLen, $prefix) { - $normalizedPath = str_replace('\\', '/', $info->getPathname()); - if (!preg_match($regex, substr($normalizedPath, $prefixLen)) || !$info->isFile()) { - return false; - } - if ($this->excludedPrefixes) { - do { - if (isset($this->excludedPrefixes[$dirPath = $normalizedPath])) { - return false; - } - } while ($prefix !== $dirPath && $dirPath !== $normalizedPath = \dirname($dirPath)); - } - }) - ->sortByName() - ->in($prefix) - ; - } - - private function computeHash(): string - { - $hash = hash_init('xxh128'); - - foreach ($this->getIterator() as $path => $info) { - hash_update($hash, $path."\n"); - } - - return hash_final($hash); - } - - private function expandGlob(string $pattern): array - { - $segments = preg_split('/\{([^{}]*+)\}/', $pattern, -1, \PREG_SPLIT_DELIM_CAPTURE); - $paths = [$segments[0]]; - $patterns = []; - - for ($i = 1; $i < \count($segments); $i += 2) { - $patterns = []; - - foreach (explode(',', $segments[$i]) as $s) { - foreach ($paths as $p) { - $patterns[] = $p.$s.$segments[1 + $i]; - } - } - - $paths = $patterns; - } - - $j = 0; - foreach ($patterns as $i => $p) { - if (str_contains($p, '{')) { - $p = $this->expandGlob($p); - array_splice($paths, $i + $j, 1, $p); - $j += \count($p) - 1; - } - } - - return $paths; - } -} diff --git a/app/vendor/symfony/config/Resource/ReflectionClassResource.php b/app/vendor/symfony/config/Resource/ReflectionClassResource.php deleted file mode 100644 index 5bf026639..000000000 --- a/app/vendor/symfony/config/Resource/ReflectionClassResource.php +++ /dev/null @@ -1,213 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -use Symfony\Component\EventDispatcher\EventSubscriberInterface; -use Symfony\Contracts\Service\ServiceSubscriberInterface; - -/** - * @author Nicolas Grekas - * - * @final - */ -class ReflectionClassResource implements SelfCheckingResourceInterface -{ - private array $files = []; - private string $className; - private array $excludedVendors = []; - private string $hash; - - public function __construct( - private \ReflectionClass $classReflector, - array $excludedVendors = [], - ) { - $this->className = $classReflector->name; - $this->excludedVendors = $excludedVendors; - } - - public function isFresh(int $timestamp): bool - { - if (!isset($this->hash)) { - $this->hash = $this->computeHash(); - $this->loadFiles($this->classReflector); - } - - foreach ($this->files as $file => $v) { - if (false === $filemtime = @filemtime($file)) { - return false; - } - - if ($filemtime > $timestamp) { - return $this->hash === $this->computeHash(); - } - } - - return true; - } - - public function __toString(): string - { - return 'reflection.'.$this->className; - } - - /** - * @internal - */ - public function __sleep(): array - { - if (!isset($this->hash)) { - $this->hash = $this->computeHash(); - $this->loadFiles($this->classReflector); - } - - return ['files', 'className', 'hash']; - } - - private function loadFiles(\ReflectionClass $class): void - { - foreach ($class->getInterfaces() as $v) { - $this->loadFiles($v); - } - do { - $file = $class->getFileName(); - if (false !== $file && is_file($file)) { - foreach ($this->excludedVendors as $vendor) { - if (\in_array($file[\strlen($vendor)] ?? '', ['/', \DIRECTORY_SEPARATOR], true) && str_starts_with($file, $vendor)) { - $file = false; - break; - } - } - if ($file) { - $this->files[$file] = null; - } - } - foreach ($class->getTraits() as $v) { - $this->loadFiles($v); - } - } while ($class = $class->getParentClass()); - } - - private function computeHash(): string - { - try { - $this->classReflector ??= new \ReflectionClass($this->className); - } catch (\ReflectionException) { - // the class does not exist anymore - return false; - } - $hash = hash_init('xxh128'); - - foreach ($this->generateSignature($this->classReflector) as $info) { - hash_update($hash, $info); - } - - return hash_final($hash); - } - - private function generateSignature(\ReflectionClass $class): iterable - { - $attributes = []; - foreach ($class->getAttributes() as $a) { - $attributes[] = [$a->getName(), (string) $a]; - } - yield print_r($attributes, true); - $attributes = []; - - yield $class->getDocComment() ?: ''; - yield (int) $class->isFinal(); - yield (int) $class->isAbstract(); - - if ($class->isTrait()) { - yield print_r(class_uses($class->name), true); - } else { - yield print_r(class_parents($class->name), true); - yield print_r(class_implements($class->name), true); - yield print_r($class->getConstants(), true); - } - - foreach ($class->getReflectionConstants() as $constant) { - foreach ($constant->getAttributes() as $a) { - $attributes[] = [$a->getName(), (string) $a]; - } - yield $constant->name.print_r($attributes, true); - $attributes = []; - } - - if (!$class->isInterface()) { - $defaults = $class->getDefaultProperties(); - - foreach ($class->getProperties(\ReflectionProperty::IS_PUBLIC | \ReflectionProperty::IS_PROTECTED) as $p) { - foreach ($p->getAttributes() as $a) { - $attributes[] = [$a->getName(), (string) $a]; - } - yield print_r($attributes, true); - $attributes = []; - - yield $p->getDocComment() ?: ''; - yield $p->isDefault() ? '' : ''; - yield $p->isPublic() ? 'public' : 'protected'; - yield $p->isStatic() ? 'static' : ''; - yield '$'.$p->name; - yield print_r(isset($defaults[$p->name]) && !\is_object($defaults[$p->name]) ? $defaults[$p->name] : null, true); - } - } - - foreach ($class->getMethods(\ReflectionMethod::IS_PUBLIC | \ReflectionMethod::IS_PROTECTED) as $m) { - foreach ($this->excludedVendors as $vendor) { - $file = $m->getFileName(); - if (\in_array($file[\strlen($vendor)] ?? '', ['/', \DIRECTORY_SEPARATOR], true) && str_starts_with($file, $vendor)) { - continue 2; - } - } - - foreach ($m->getAttributes() as $a) { - $attributes[] = [$a->getName(), (string) $a]; - } - yield print_r($attributes, true); - $attributes = []; - - $defaults = []; - foreach ($m->getParameters() as $p) { - foreach ($p->getAttributes() as $a) { - $attributes[] = [$a->getName(), (string) $a]; - } - yield print_r($attributes, true); - $attributes = []; - - if (!$p->isDefaultValueAvailable()) { - $defaults[$p->name] = null; - - continue; - } - - $defaults[$p->name] = (string) $p; - } - - yield preg_replace('/^ @@.*/m', '', $m); - yield print_r($defaults, true); - } - - if ($class->isAbstract() || $class->isInterface() || $class->isTrait()) { - return; - } - - if (interface_exists(EventSubscriberInterface::class, false) && $class->isSubclassOf(EventSubscriberInterface::class)) { - yield EventSubscriberInterface::class; - yield print_r($class->name::getSubscribedEvents(), true); - } - - if (interface_exists(ServiceSubscriberInterface::class, false) && $class->isSubclassOf(ServiceSubscriberInterface::class)) { - yield ServiceSubscriberInterface::class; - yield print_r($class->name::getSubscribedServices(), true); - } - } -} diff --git a/app/vendor/symfony/config/Resource/ResourceInterface.php b/app/vendor/symfony/config/Resource/ResourceInterface.php deleted file mode 100644 index a97671d14..000000000 --- a/app/vendor/symfony/config/Resource/ResourceInterface.php +++ /dev/null @@ -1,31 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -/** - * ResourceInterface is the interface that must be implemented by all Resource classes. - * - * @author Fabien Potencier - */ -interface ResourceInterface extends \Stringable -{ - /** - * Returns a string representation of the Resource. - * - * This method is necessary to allow for resource de-duplication, for example by means - * of array_unique(). The string returned need not have a particular meaning, but has - * to be identical for different ResourceInterface instances referring to the same - * resource; and it should be unlikely to collide with that of other, unrelated - * resource instances. - */ - public function __toString(): string; -} diff --git a/app/vendor/symfony/config/Resource/SelfCheckingResourceChecker.php b/app/vendor/symfony/config/Resource/SelfCheckingResourceChecker.php deleted file mode 100644 index 5abdbadd4..000000000 --- a/app/vendor/symfony/config/Resource/SelfCheckingResourceChecker.php +++ /dev/null @@ -1,46 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -use Symfony\Component\Config\ResourceCheckerInterface; - -/** - * Resource checker for instances of SelfCheckingResourceInterface. - * - * As these resources perform the actual check themselves, we can provide - * this class as a standard way of validating them. - * - * @author Matthias Pigulla - */ -class SelfCheckingResourceChecker implements ResourceCheckerInterface -{ - // Common shared cache, because this checker can be used in different - // situations. For example, when using the full stack framework, the router - // and the container have their own cache. But they may check the very same - // resources - private static array $cache = []; - - public function supports(ResourceInterface $metadata): bool - { - return $metadata instanceof SelfCheckingResourceInterface; - } - - /** - * @param SelfCheckingResourceInterface $resource - */ - public function isFresh(ResourceInterface $resource, int $timestamp): bool - { - $key = "$resource:$timestamp"; - - return self::$cache[$key] ??= $resource->isFresh($timestamp); - } -} diff --git a/app/vendor/symfony/config/Resource/SelfCheckingResourceInterface.php b/app/vendor/symfony/config/Resource/SelfCheckingResourceInterface.php deleted file mode 100644 index 197ff1f9b..000000000 --- a/app/vendor/symfony/config/Resource/SelfCheckingResourceInterface.php +++ /dev/null @@ -1,28 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -/** - * Interface for Resources that can check for freshness autonomously, - * without special support from external services. - * - * @author Matthias Pigulla - */ -interface SelfCheckingResourceInterface extends ResourceInterface -{ - /** - * Returns true if the resource has not been updated since the given timestamp. - * - * @param int $timestamp The last time the resource was loaded - */ - public function isFresh(int $timestamp): bool; -} diff --git a/app/vendor/symfony/config/Resource/SkippingResourceChecker.php b/app/vendor/symfony/config/Resource/SkippingResourceChecker.php deleted file mode 100644 index 0f0934c82..000000000 --- a/app/vendor/symfony/config/Resource/SkippingResourceChecker.php +++ /dev/null @@ -1,37 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Resource; - -use Symfony\Component\Config\ResourceCheckerInterface; - -class SkippingResourceChecker implements ResourceCheckerInterface -{ - private array $skippedResourceTypes; - - /** - * @param class-string[] $skippedResourceTypes - */ - public function __construct(array $skippedResourceTypes = []) - { - $this->skippedResourceTypes = array_flip($skippedResourceTypes); - } - - public function supports(ResourceInterface $metadata): bool - { - return !$this->skippedResourceTypes || isset($this->skippedResourceTypes[$metadata::class]); - } - - public function isFresh(ResourceInterface $resource, int $timestamp): bool - { - return true; - } -} diff --git a/app/vendor/symfony/config/ResourceCheckerConfigCache.php b/app/vendor/symfony/config/ResourceCheckerConfigCache.php deleted file mode 100644 index 955aee7e5..000000000 --- a/app/vendor/symfony/config/ResourceCheckerConfigCache.php +++ /dev/null @@ -1,183 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -use Symfony\Component\Config\Resource\ResourceInterface; -use Symfony\Component\Filesystem\Exception\IOException; -use Symfony\Component\Filesystem\Filesystem; - -/** - * ResourceCheckerConfigCache uses instances of ResourceCheckerInterface - * to check whether cached data is still fresh. - * - * @author Matthias Pigulla - */ -class ResourceCheckerConfigCache implements ConfigCacheInterface -{ - private string $metaFile; - - /** - * @param string $file The absolute cache path - * @param iterable $resourceCheckers The ResourceCheckers to use for the freshness check - * @param string|null $metaFile The absolute path to the meta file, defaults to $file.meta if null - */ - public function __construct( - private string $file, - private iterable $resourceCheckers = [], - ?string $metaFile = null, - ) { - $this->metaFile = $metaFile ?? $file.'.meta'; - } - - public function getPath(): string - { - return $this->file; - } - - /** - * Checks if the cache is still fresh. - * - * This implementation will make a decision solely based on the ResourceCheckers - * passed in the constructor. - * - * The first ResourceChecker that supports a given resource is considered authoritative. - * Resources with no matching ResourceChecker will silently be ignored and considered fresh. - */ - public function isFresh(): bool - { - if (!is_file($this->file)) { - return false; - } - - if ($this->resourceCheckers instanceof \Traversable && !$this->resourceCheckers instanceof \Countable) { - $this->resourceCheckers = iterator_to_array($this->resourceCheckers); - } - - if (!\count($this->resourceCheckers)) { - return true; // shortcut - if we don't have any checkers we don't need to bother with the meta file at all - } - - $metadata = $this->metaFile; - - if (!is_file($metadata)) { - return false; - } - - $meta = $this->safelyUnserialize($metadata); - - if (false === $meta) { - return false; - } - - $time = filemtime($this->file); - - foreach ($meta as $resource) { - foreach ($this->resourceCheckers as $checker) { - if (!$checker->supports($resource)) { - continue; // next checker - } - if ($checker->isFresh($resource, $time)) { - break; // no need to further check this resource - } - - return false; // cache is stale - } - // no suitable checker found, ignore this resource - } - - return true; - } - - /** - * Writes cache. - * - * @param string $content The content to write in the cache - * @param ResourceInterface[] $metadata An array of metadata - * - * @throws \RuntimeException When cache file can't be written - */ - public function write(string $content, ?array $metadata = null): void - { - $mode = 0666; - $umask = umask(); - $filesystem = new Filesystem(); - $filesystem->dumpFile($this->file, $content); - try { - $filesystem->chmod($this->file, $mode, $umask); - } catch (IOException) { - // discard chmod failure (some filesystem may not support it) - } - - if (null !== $metadata) { - $filesystem->dumpFile($this->metaFile, $ser = serialize($metadata)); - try { - $filesystem->chmod($this->metaFile, $mode, $umask); - } catch (IOException) { - // discard chmod failure (some filesystem may not support it) - } - - $ser = preg_replace_callback('/;O:(\d+):"/', static fn ($m) => ';O:'.(9 + $m[1]).':"Tracking\\', $ser); - $ser = preg_replace_callback('/s:(\d+):"\0[^\0]++\0/', static fn ($m) => 's:'.($m[1] - \strlen($m[0]) + 6).':"', $ser); - $ser = unserialize($ser, ['allowed_classes' => false]); - $ser = @json_encode($ser, \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE) ?: []; - $ser = str_replace('"__PHP_Incomplete_Class_Name":"Tracking\\\\', '"@type":"', $ser); - $ser = \sprintf('{"resources":%s}', $ser); - - $filesystem->dumpFile($this->metaFile.'.json', $ser); - try { - $filesystem->chmod($this->metaFile.'.json', $mode, $umask); - } catch (IOException) { - // discard chmod failure (some filesystem may not support it) - } - } - - if (\function_exists('opcache_invalidate') && filter_var(\ini_get('opcache.enable'), \FILTER_VALIDATE_BOOL)) { - @opcache_invalidate($this->file, true); - } - } - - private function safelyUnserialize(string $file): mixed - { - $meta = false; - $content = (new Filesystem())->readFile($file); - $signalingException = new \UnexpectedValueException(); - $prevUnserializeHandler = ini_set('unserialize_callback_func', self::class.'::handleUnserializeCallback'); - $prevErrorHandler = set_error_handler(function ($type, $msg, $file, $line, $context = []) use (&$prevErrorHandler, $signalingException) { - if (__FILE__ === $file && !\in_array($type, [\E_DEPRECATED, \E_USER_DEPRECATED], true)) { - throw $signalingException; - } - - return $prevErrorHandler ? $prevErrorHandler($type, $msg, $file, $line, $context) : false; - }); - - try { - $meta = unserialize($content); - } catch (\Throwable $e) { - if ($e !== $signalingException) { - throw $e; - } - } finally { - restore_error_handler(); - ini_set('unserialize_callback_func', $prevUnserializeHandler); - } - - return $meta; - } - - /** - * @internal - */ - public static function handleUnserializeCallback(string $class): void - { - trigger_error('Class not found: '.$class); - } -} diff --git a/app/vendor/symfony/config/ResourceCheckerConfigCacheFactory.php b/app/vendor/symfony/config/ResourceCheckerConfigCacheFactory.php deleted file mode 100644 index 595855ccb..000000000 --- a/app/vendor/symfony/config/ResourceCheckerConfigCacheFactory.php +++ /dev/null @@ -1,39 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -/** - * A ConfigCacheFactory implementation that validates the - * cache with an arbitrary set of ResourceCheckers. - * - * @author Matthias Pigulla - */ -class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface -{ - /** - * @param iterable $resourceCheckers - */ - public function __construct( - private iterable $resourceCheckers = [], - ) { - } - - public function cache(string $file, callable $callable): ConfigCacheInterface - { - $cache = new ResourceCheckerConfigCache($file, $this->resourceCheckers); - if (!$cache->isFresh()) { - $callable($cache); - } - - return $cache; - } -} diff --git a/app/vendor/symfony/config/ResourceCheckerInterface.php b/app/vendor/symfony/config/ResourceCheckerInterface.php deleted file mode 100644 index 13ae03f45..000000000 --- a/app/vendor/symfony/config/ResourceCheckerInterface.php +++ /dev/null @@ -1,41 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config; - -use Symfony\Component\Config\Resource\ResourceInterface; - -/** - * Interface for ResourceCheckers. - * - * When a ResourceCheckerConfigCache instance is checked for freshness, all its associated - * metadata resources are passed to ResourceCheckers. The ResourceCheckers - * can then inspect the resources and decide whether the cache can be considered - * fresh or not. - * - * @author Matthias Pigulla - * @author Benjamin Klotz - */ -interface ResourceCheckerInterface -{ - /** - * Queries the ResourceChecker whether it can validate a given - * resource or not. - */ - public function supports(ResourceInterface $metadata): bool; - - /** - * Validates the resource. - * - * @param int $timestamp The timestamp at which the cache associated with this resource was created - */ - public function isFresh(ResourceInterface $resource, int $timestamp): bool; -} diff --git a/app/vendor/symfony/config/Util/Exception/InvalidXmlException.php b/app/vendor/symfony/config/Util/Exception/InvalidXmlException.php deleted file mode 100644 index 155571cec..000000000 --- a/app/vendor/symfony/config/Util/Exception/InvalidXmlException.php +++ /dev/null @@ -1,22 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Util\Exception; - -/** - * Exception class for when XML parsing with an XSD schema file path or a callable validator produces errors unrelated - * to the actual XML parsing. - * - * @author Ole Rößner - */ -class InvalidXmlException extends XmlParsingException -{ -} diff --git a/app/vendor/symfony/config/Util/Exception/XmlParsingException.php b/app/vendor/symfony/config/Util/Exception/XmlParsingException.php deleted file mode 100644 index 9bceed660..000000000 --- a/app/vendor/symfony/config/Util/Exception/XmlParsingException.php +++ /dev/null @@ -1,21 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Util\Exception; - -/** - * Exception class for when XML cannot be parsed properly. - * - * @author Ole Rößner - */ -class XmlParsingException extends \InvalidArgumentException -{ -} diff --git a/app/vendor/symfony/config/Util/XmlUtils.php b/app/vendor/symfony/config/Util/XmlUtils.php deleted file mode 100644 index 02ebe7dbe..000000000 --- a/app/vendor/symfony/config/Util/XmlUtils.php +++ /dev/null @@ -1,270 +0,0 @@ - - * - * For the full copyright and license information, please view the LICENSE - * file that was distributed with this source code. - */ - -namespace Symfony\Component\Config\Util; - -use Symfony\Component\Config\Util\Exception\InvalidXmlException; -use Symfony\Component\Config\Util\Exception\XmlParsingException; -use Symfony\Component\Filesystem\Filesystem; - -/** - * XMLUtils is a bunch of utility methods to XML operations. - * - * This class contains static methods only and is not meant to be instantiated. - * - * @author Fabien Potencier - * @author Martin Hasoň - * @author Ole Rößner - */ -class XmlUtils -{ - /** - * This class should not be instantiated. - */ - private function __construct() - { - } - - /** - * Parses an XML string. - * - * @param string $content An XML string - * @param string|callable|null $schemaOrCallable An XSD schema file path, a callable, or null to disable validation - * - * @throws XmlParsingException When parsing of XML file returns error - * @throws InvalidXmlException When parsing of XML with schema or callable produces any errors unrelated to the XML parsing itself - * @throws \RuntimeException When DOM extension is missing - */ - public static function parse(string $content, string|callable|null $schemaOrCallable = null): \DOMDocument - { - if (!\extension_loaded('dom')) { - throw new \LogicException('Extension DOM is required.'); - } - - $internalErrors = libxml_use_internal_errors(true); - libxml_clear_errors(); - - $dom = new \DOMDocument(); - $dom->validateOnParse = true; - if (!$dom->loadXML($content, \LIBXML_NONET | \LIBXML_COMPACT)) { - throw new XmlParsingException(implode("\n", static::getXmlErrors($internalErrors))); - } - - $dom->normalizeDocument(); - - libxml_use_internal_errors($internalErrors); - - foreach ($dom->childNodes as $child) { - if (\XML_DOCUMENT_TYPE_NODE === $child->nodeType) { - throw new XmlParsingException('Document types are not allowed.'); - } - } - - if (null !== $schemaOrCallable) { - $internalErrors = libxml_use_internal_errors(true); - libxml_clear_errors(); - - $e = null; - if (\is_callable($schemaOrCallable)) { - try { - $valid = $schemaOrCallable($dom, $internalErrors); - } catch (\Exception $e) { - $valid = false; - } - } elseif (is_file($schemaOrCallable)) { - $schemaSource = (new Filesystem())->readFile($schemaOrCallable); - $valid = @$dom->schemaValidateSource($schemaSource); - } else { - libxml_use_internal_errors($internalErrors); - - throw new XmlParsingException(\sprintf('Invalid XSD file: "%s".', $schemaOrCallable)); - } - - if (!$valid) { - $messages = static::getXmlErrors($internalErrors); - if (!$messages) { - throw new InvalidXmlException('The XML is not valid.', 0, $e); - } - throw new XmlParsingException(implode("\n", $messages), 0, $e); - } - } - - libxml_clear_errors(); - libxml_use_internal_errors($internalErrors); - - return $dom; - } - - /** - * Loads an XML file. - * - * @param string $file An XML file path - * @param string|callable|null $schemaOrCallable An XSD schema file path, a callable, or null to disable validation - * - * @throws \InvalidArgumentException When loading of XML file returns error - * @throws XmlParsingException When XML parsing returns any errors - * @throws \RuntimeException When DOM extension is missing - */ - public static function loadFile(string $file, string|callable|null $schemaOrCallable = null): \DOMDocument - { - if (!is_file($file)) { - throw new \InvalidArgumentException(\sprintf('Resource "%s" is not a file.', $file)); - } - - if (!is_readable($file)) { - throw new \InvalidArgumentException(\sprintf('File "%s" is not readable.', $file)); - } - - $content = (new Filesystem())->readFile($file); - - if ('' === trim($content)) { - throw new \InvalidArgumentException(\sprintf('File "%s" does not contain valid XML, it is empty.', $file)); - } - - try { - return static::parse($content, $schemaOrCallable); - } catch (InvalidXmlException $e) { - throw new XmlParsingException(\sprintf('The XML file "%s" is not valid.', $file), 0, $e->getPrevious()); - } - } - - /** - * Converts a \DOMElement object to a PHP array. - * - * The following rules applies during the conversion: - * - * * Each tag is converted to a key value or an array - * if there is more than one "value" - * - * * The content of a tag is set under a "value" key (bar) - * if the tag also has some nested tags - * - * * The attributes are converted to keys () - * - * * The nested-tags are converted to keys (bar) - * - * @param \DOMElement $element A \DOMElement instance - * @param bool $checkPrefix Check prefix in an element or an attribute name - */ - public static function convertDomElementToArray(\DOMElement $element, bool $checkPrefix = true): mixed - { - $prefix = $element->prefix; - $empty = true; - $config = []; - foreach ($element->attributes as $name => $node) { - if ($checkPrefix && !\in_array((string) $node->prefix, ['', $prefix], true)) { - continue; - } - $config[$name] = static::phpize($node->value); - $empty = false; - } - - $nodeValue = false; - foreach ($element->childNodes as $node) { - if ($node instanceof \DOMText) { - if ('' !== trim($node->nodeValue)) { - $nodeValue = trim($node->nodeValue); - $empty = false; - } - } elseif ($checkPrefix && $prefix != $node->prefix) { - continue; - } elseif (!$node instanceof \DOMComment) { - $value = static::convertDomElementToArray($node, $checkPrefix); - - $key = $node->localName; - if (isset($config[$key])) { - if (!\is_array($config[$key]) || !\is_int(key($config[$key]))) { - $config[$key] = [$config[$key]]; - } - $config[$key][] = $value; - } else { - $config[$key] = $value; - } - - $empty = false; - } - } - - if (false !== $nodeValue) { - $value = static::phpize($nodeValue); - if (\count($config)) { - $config['value'] = $value; - } else { - $config = $value; - } - } - - return !$empty ? $config : null; - } - - /** - * Converts an xml value to a PHP type. - */ - public static function phpize(string|\Stringable $value): mixed - { - $value = (string) $value; - $lowercaseValue = strtolower($value); - - switch (true) { - case 'null' === $lowercaseValue: - return null; - case ctype_digit($value): - case isset($value[1]) && '-' === $value[0] && ctype_digit(substr($value, 1)): - $raw = $value; - $cast = (int) $value; - - return self::isOctal($value) ? \intval($value, 8) : (($raw === (string) $cast) ? $cast : $raw); - case 'true' === $lowercaseValue: - return true; - case 'false' === $lowercaseValue: - return false; - case isset($value[1]) && '0b' == $value[0].$value[1] && preg_match('/^0b[01]*$/', $value): - return bindec($value); - case is_numeric($value): - return '0x' === $value[0].$value[1] ? hexdec($value) : (float) $value; - case preg_match('/^0x[0-9a-f]++$/i', $value): - return hexdec($value); - case preg_match('/^[+-]?[0-9]+(\.[0-9]+)?$/', $value): - return (float) $value; - default: - return $value; - } - } - - protected static function getXmlErrors(bool $internalErrors): array - { - $errors = []; - foreach (libxml_get_errors() as $error) { - $errors[] = \sprintf('[%s %s] %s (in %s - line %d, column %d)', - \LIBXML_ERR_WARNING == $error->level ? 'WARNING' : 'ERROR', - $error->code, - trim($error->message), - $error->file ?: 'n/a', - $error->line, - $error->column - ); - } - - libxml_clear_errors(); - libxml_use_internal_errors($internalErrors); - - return $errors; - } - - private static function isOctal(string $str): bool - { - if ('-' === $str[0]) { - $str = substr($str, 1); - } - - return $str === '0'.decoct(\intval($str, 8)); - } -} diff --git a/app/vendor/symfony/config/composer.json b/app/vendor/symfony/config/composer.json deleted file mode 100644 index 37206042a..000000000 --- a/app/vendor/symfony/config/composer.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "name": "symfony/config", - "type": "library", - "description": "Helps you find, load, combine, autofill and validate configuration values of any kind", - "keywords": [], - "homepage": "https://symfony.com", - "license": "MIT", - "authors": [ - { - "name": "Fabien Potencier", - "email": "fabien@symfony.com" - }, - { - "name": "Symfony Community", - "homepage": "https://symfony.com/contributors" - } - ], - "require": { - "php": ">=8.2", - "symfony/deprecation-contracts": "^2.5|^3", - "symfony/filesystem": "^7.1", - "symfony/polyfill-ctype": "~1.8" - }, - "require-dev": { - "symfony/event-dispatcher": "^6.4|^7.0", - "symfony/finder": "^6.4|^7.0", - "symfony/messenger": "^6.4|^7.0", - "symfony/service-contracts": "^2.5|^3", - "symfony/yaml": "^6.4|^7.0" - }, - "conflict": { - "symfony/finder": "<6.4", - "symfony/service-contracts": "<2.5" - }, - "autoload": { - "psr-4": { "Symfony\\Component\\Config\\": "" }, - "exclude-from-classmap": [ - "/Tests/" - ] - }, - "minimum-stability": "dev" -} diff --git a/app/vendor/symfony/console/Application.php b/app/vendor/symfony/console/Application.php index 1ea644df0..43b7799e8 100644 --- a/app/vendor/symfony/console/Application.php +++ b/app/vendor/symfony/console/Application.php @@ -65,7 +65,7 @@ * Usage: * * $app = new Application('myapp', '1.0 (stable)'); - * $app->add(new SimpleCommand()); + * $app->addCommand(new SimpleCommand()); * $app->run(); * * @author Fabien Potencier @@ -186,7 +186,8 @@ public function run(?InputInterface $input = null, ?OutputInterface $output = nu } } - $prevShellVerbosity = getenv('SHELL_VERBOSITY'); + $empty = new \stdClass(); + $prevShellVerbosity = [$_ENV['SHELL_VERBOSITY'] ?? $empty, $_SERVER['SHELL_VERBOSITY'] ?? $empty, getenv('SHELL_VERBOSITY')]; try { $this->configureIO($input, $output); @@ -228,18 +229,14 @@ public function run(?InputInterface $input = null, ?OutputInterface $output = nu // SHELL_VERBOSITY is set by Application::configureIO so we need to unset/reset it // to its previous value to avoid one command verbosity to spread to other commands - if (false === $prevShellVerbosity) { - if (\function_exists('putenv')) { - @putenv('SHELL_VERBOSITY'); - } + if ($empty === $_ENV['SHELL_VERBOSITY'] = $prevShellVerbosity[0]) { unset($_ENV['SHELL_VERBOSITY']); + } + if ($empty === $_SERVER['SHELL_VERBOSITY'] = $prevShellVerbosity[1]) { unset($_SERVER['SHELL_VERBOSITY']); - } else { - if (\function_exists('putenv')) { - @putenv('SHELL_VERBOSITY='.$prevShellVerbosity); - } - $_ENV['SHELL_VERBOSITY'] = $prevShellVerbosity; - $_SERVER['SHELL_VERBOSITY'] = $prevShellVerbosity; + } + if (\function_exists('putenv')) { + @putenv('SHELL_VERBOSITY'.(false === ($prevShellVerbosity[2] ?? false) ? '' : '='.$prevShellVerbosity[2])); } } @@ -392,10 +389,7 @@ public function getDefinition(): InputDefinition $this->definition ??= $this->getDefaultInputDefinition(); if ($this->singleCommand) { - $inputDefinition = $this->definition; - $inputDefinition->setArguments(); - - return $inputDefinition; + $this->definition->setArguments(); } return $this->definition; @@ -427,6 +421,15 @@ public function complete(CompletionInput $input, CompletionSuggestions $suggesti if (CompletionInput::TYPE_OPTION_NAME === $input->getCompletionType()) { $suggestions->suggestOptions($this->getDefinition()->getOptions()); } + + if ( + CompletionInput::TYPE_OPTION_VALUE === $input->getCompletionType() + && ($definition = $this->getDefinition())->hasOption($input->getCompletionName()) + ) { + $definition->getOption($input->getCompletionName())->complete($input, $suggestions); + + return; + } } /** @@ -530,7 +533,7 @@ public function getLongVersion(): string */ public function register(string $name): Command { - return $this->add(new Command($name)); + return $this->addCommand(new Command($name)); } /** @@ -538,12 +541,12 @@ public function register(string $name): Command * * If a Command is not enabled it will not be added. * - * @param Command[] $commands An array of commands + * @param callable[]|Command[] $commands An array of commands */ public function addCommands(array $commands): void { foreach ($commands as $command) { - $this->add($command); + $this->addCommand($command); } } @@ -553,10 +556,14 @@ public function addCommands(array $commands): void * If a command with the same name already exists, it will be overridden. * If the command is not enabled it will not be added. */ - public function add(Command $command): ?Command + public function addCommand(callable|Command $command): ?Command { $this->init(); + if (!$command instanceof Command) { + $command = new Command(null, $command); + } + $command->setApplication($this); if (!$command->isEnabled()) { @@ -622,7 +629,7 @@ public function has(string $name): bool { $this->init(); - return isset($this->commands[$name]) || ($this->commandLoader?->has($name) && $this->add($this->commandLoader->get($name))); + return isset($this->commands[$name]) || ($this->commandLoader?->has($name) && $this->addCommand($this->commandLoader->get($name))); } /** @@ -729,15 +736,14 @@ public function find(string $name): Command $message = \sprintf('Command "%s" is not defined.', $name); if ($alternatives = $this->findAlternatives($name, $allCommands)) { - // remove hidden commands - $alternatives = array_filter($alternatives, fn ($name) => !$this->get($name)->isHidden()); + $wantHelps = $this->wantHelps; + $this->wantHelps = false; - if (1 == \count($alternatives)) { - $message .= "\n\nDid you mean this?\n "; - } else { - $message .= "\n\nDid you mean one of these?\n "; + // remove hidden commands + if ($alternatives = array_filter($alternatives, fn ($name) => !$this->get($name)->isHidden())) { + $message .= \sprintf("\n\nDid you mean %s?\n %s", 1 === \count($alternatives) ? 'this' : 'one of these', implode("\n ", $alternatives)); } - $message .= implode("\n ", $alternatives); + $this->wantHelps = $wantHelps; } throw new CommandNotFoundException($message, array_values($alternatives)); @@ -759,6 +765,21 @@ public function find(string $name): Command })); } + // check whether all commands left are aliases to the same one + if (\count($commands) > 1) { + $uniqueCommands = array_unique(array_map(function ($nameOrAlias) use (&$commandList) { + if (!$commandList[$nameOrAlias] instanceof Command) { + $commandList[$nameOrAlias] = $this->commandLoader->get($nameOrAlias); + } + + return $commandList[$nameOrAlias]->getName(); + }, $commands)); + + if (1 === \count($uniqueCommands)) { + $commands = [reset($uniqueCommands)]; + } + } + if (\count($commands) > 1) { $usableWidth = $this->terminal->getWidth() - 10; $abbrevs = array_values($commands); @@ -766,7 +787,7 @@ public function find(string $name): Command foreach ($abbrevs as $abbrev) { $maxLen = max(Helper::width($abbrev), $maxLen); } - $abbrevs = array_map(function ($cmd) use ($commandList, $usableWidth, $maxLen, &$commands) { + $abbrevs = array_map(static function ($cmd) use ($commandList, $usableWidth, $maxLen, &$commands) { if ($commandList[$cmd]->isHidden()) { unset($commands[array_search($cmd, $commands)]); @@ -785,9 +806,9 @@ public function find(string $name): Command } } - $command = $this->get(reset($commands)); + $command = $commands ? $this->get(reset($commands)) : null; - if ($command->isHidden()) { + if (!$command || $command->isHidden()) { throw new CommandNotFoundException(\sprintf('The command "%s" does not exist.', $name)); } @@ -881,7 +902,7 @@ protected function doRenderThrowable(\Throwable $e, OutputInterface $output): vo } if (str_contains($message, "@anonymous\0")) { - $message = preg_replace_callback('/[a-zA-Z_\x7f-\xff][\\\\a-zA-Z0-9_\x7f-\xff]*+@anonymous\x00.*?\.php(?:0x?|:[0-9]++\$)?[0-9a-fA-F]++/', fn ($m) => class_exists($m[0], false) ? (get_parent_class($m[0]) ?: key(class_implements($m[0])) ?: 'class').'@anonymous' : $m[0], $message); + $message = preg_replace_callback('/[a-zA-Z_\x7f-\xff][\\\\a-zA-Z0-9_\x7f-\xff]*+@anonymous\x00.*?\.php(?:0x?|:[0-9]++\$)?[0-9a-fA-F]++/', static fn ($m) => class_exists($m[0], false) ? (get_parent_class($m[0]) ?: key(class_implements($m[0])) ?: 'class').'@anonymous' : $m[0], $message); } $width = $this->terminal->getWidth() ? $this->terminal->getWidth() - 1 : \PHP_INT_MAX; @@ -945,57 +966,31 @@ protected function doRenderThrowable(\Throwable $e, OutputInterface $output): vo */ protected function configureIO(InputInterface $input, OutputInterface $output): void { - if (true === $input->hasParameterOption(['--ansi'], true)) { + if ($input->hasParameterOption(['--ansi'], true)) { $output->setDecorated(true); - } elseif (true === $input->hasParameterOption(['--no-ansi'], true)) { + } elseif ($input->hasParameterOption(['--no-ansi'], true)) { $output->setDecorated(false); } - if (true === $input->hasParameterOption(['--no-interaction', '-n'], true)) { - $input->setInteractive(false); - } - - switch ($shellVerbosity = (int) getenv('SHELL_VERBOSITY')) { - case -2: - $output->setVerbosity(OutputInterface::VERBOSITY_SILENT); - break; - case -1: - $output->setVerbosity(OutputInterface::VERBOSITY_QUIET); - break; - case 1: - $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE); - break; - case 2: - $output->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE); - break; - case 3: - $output->setVerbosity(OutputInterface::VERBOSITY_DEBUG); - break; - default: - $shellVerbosity = 0; - break; - } + $shellVerbosity = match (true) { + $input->hasParameterOption(['--silent'], true) => -2, + $input->hasParameterOption(['--quiet', '-q'], true) => -1, + $input->hasParameterOption('-vvv', true) || $input->hasParameterOption('--verbose=3', true) || 3 === $input->getParameterOption('--verbose', false, true) => 3, + $input->hasParameterOption('-vv', true) || $input->hasParameterOption('--verbose=2', true) || 2 === $input->getParameterOption('--verbose', false, true) => 2, + $input->hasParameterOption('-v', true) || $input->hasParameterOption('--verbose=1', true) || $input->hasParameterOption('--verbose', true) || $input->getParameterOption('--verbose', false, true) => 1, + default => (int) ($_ENV['SHELL_VERBOSITY'] ?? $_SERVER['SHELL_VERBOSITY'] ?? getenv('SHELL_VERBOSITY')), + }; - if (true === $input->hasParameterOption(['--silent'], true)) { - $output->setVerbosity(OutputInterface::VERBOSITY_SILENT); - $shellVerbosity = -2; - } elseif (true === $input->hasParameterOption(['--quiet', '-q'], true)) { - $output->setVerbosity(OutputInterface::VERBOSITY_QUIET); - $shellVerbosity = -1; - } else { - if ($input->hasParameterOption('-vvv', true) || $input->hasParameterOption('--verbose=3', true) || 3 === $input->getParameterOption('--verbose', false, true)) { - $output->setVerbosity(OutputInterface::VERBOSITY_DEBUG); - $shellVerbosity = 3; - } elseif ($input->hasParameterOption('-vv', true) || $input->hasParameterOption('--verbose=2', true) || 2 === $input->getParameterOption('--verbose', false, true)) { - $output->setVerbosity(OutputInterface::VERBOSITY_VERY_VERBOSE); - $shellVerbosity = 2; - } elseif ($input->hasParameterOption('-v', true) || $input->hasParameterOption('--verbose=1', true) || $input->hasParameterOption('--verbose', true) || $input->getParameterOption('--verbose', false, true)) { - $output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE); - $shellVerbosity = 1; - } - } + $output->setVerbosity(match ($shellVerbosity) { + -2 => OutputInterface::VERBOSITY_SILENT, + -1 => OutputInterface::VERBOSITY_QUIET, + 1 => OutputInterface::VERBOSITY_VERBOSE, + 2 => OutputInterface::VERBOSITY_VERY_VERBOSE, + 3 => OutputInterface::VERBOSITY_DEBUG, + default => ($shellVerbosity = 0) ?: $output->getVerbosity(), + }); - if (0 > $shellVerbosity) { + if (0 > $shellVerbosity || $input->hasParameterOption(['--no-interaction', '-n'], true)) { $input->setInteractive(false); } @@ -1022,16 +1017,12 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI } } + $registeredSignals = false; if (($commandSignals = $command->getSubscribedSignals()) || $this->dispatcher && $this->signalsToDispatchEvent) { $signalRegistry = $this->getSignalRegistry(); - if (Terminal::hasSttyAvailable()) { - $sttyMode = shell_exec('stty -g'); - - foreach ([\SIGINT, \SIGQUIT, \SIGTERM] as $signal) { - $signalRegistry->register($signal, static fn () => shell_exec('stty '.$sttyMode)); - } - } + $registeredSignals = true; + $this->getSignalRegistry()->pushCurrentHandlers(); if ($this->dispatcher) { // We register application signals, so that we can dispatch the event @@ -1089,7 +1080,13 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI } if (null === $this->dispatcher) { - return $command->run($input, $output); + try { + return $command->run($input, $output); + } finally { + if ($registeredSignals) { + $this->getSignalRegistry()->popPreviousHandlers(); + } + } } // bind before the console.command event, so the listeners have access to input options/arguments @@ -1119,6 +1116,10 @@ protected function doRunCommand(Command $command, InputInterface $input, OutputI if (0 === $exitCode = $event->getExitCode()) { $e = null; } + } finally { + if ($registeredSignals) { + $this->getSignalRegistry()->popPreviousHandlers(); + } } $event = new ConsoleTerminateEvent($command, $input, $output, $exitCode); @@ -1241,7 +1242,7 @@ private function findAlternatives(string $name, iterable $collection): array } } - $alternatives = array_filter($alternatives, fn ($lev) => $lev < 2 * $threshold); + $alternatives = array_filter($alternatives, static fn ($lev) => $lev < 2 * $threshold); ksort($alternatives, \SORT_NATURAL | \SORT_FLAG_CASE); return array_keys($alternatives); @@ -1340,7 +1341,7 @@ private function init(): void $this->initialized = true; foreach ($this->getDefaultCommands() as $command) { - $this->add($command); + $this->addCommand($command); } } } diff --git a/app/vendor/symfony/console/Attribute/Argument.php b/app/vendor/symfony/console/Attribute/Argument.php index e6a94d2f1..33b7a86b2 100644 --- a/app/vendor/symfony/console/Attribute/Argument.php +++ b/app/vendor/symfony/console/Attribute/Argument.php @@ -11,14 +11,16 @@ namespace Symfony\Component\Console\Attribute; +use Symfony\Component\Console\Attribute\Reflection\ReflectionMember; use Symfony\Component\Console\Completion\CompletionInput; use Symfony\Component\Console\Completion\Suggestion; +use Symfony\Component\Console\Exception\InvalidArgumentException; use Symfony\Component\Console\Exception\LogicException; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\String\UnicodeString; -#[\Attribute(\Attribute::TARGET_PARAMETER)] +#[\Attribute(\Attribute::TARGET_PARAMETER | \Attribute::TARGET_PROPERTY)] class Argument { private const ALLOWED_TYPES = ['string', 'bool', 'int', 'float', 'array']; @@ -26,7 +28,11 @@ class Argument private string|bool|int|float|array|null $default = null; private array|\Closure $suggestedValues; private ?int $mode = null; - private string $function = ''; + /** + * @var string|class-string<\BackedEnum> + */ + private string $typeName = ''; + private ?InteractiveAttributeInterface $interactiveAttribute = null; /** * Represents a console command definition. @@ -46,47 +52,56 @@ public function __construct( /** * @internal */ - public static function tryFrom(\ReflectionParameter $parameter): ?self + public static function tryFrom(\ReflectionParameter|\ReflectionProperty $member): ?self { - /** @var self $self */ - if (null === $self = ($parameter->getAttributes(self::class, \ReflectionAttribute::IS_INSTANCEOF)[0] ?? null)?->newInstance()) { - return null; - } + $reflection = new ReflectionMember($member); - if (($function = $parameter->getDeclaringFunction()) instanceof \ReflectionMethod) { - $self->function = $function->class.'::'.$function->name; - } else { - $self->function = $function->name; + if (!$self = $reflection->getAttribute(self::class)) { + return null; } - $type = $parameter->getType(); - $name = $parameter->getName(); + $type = $reflection->getType(); + $name = $reflection->getName(); if (!$type instanceof \ReflectionNamedType) { - throw new LogicException(\sprintf('The parameter "$%s" of "%s()" must have a named type. Untyped, Union or Intersection types are not supported for command arguments.', $name, $self->function)); + throw new LogicException(\sprintf('The %s "$%s" of "%s" must have a named type. Untyped, Union or Intersection types are not supported for command arguments.', $reflection->getMemberName(), $name, $reflection->getSourceName())); } - $parameterTypeName = $type->getName(); + $self->typeName = $type->getName(); + $isBackedEnum = is_subclass_of($self->typeName, \BackedEnum::class); - if (!\in_array($parameterTypeName, self::ALLOWED_TYPES, true)) { - throw new LogicException(\sprintf('The type "%s" on parameter "$%s" of "%s()" is not supported as a command argument. Only "%s" types are allowed.', $parameterTypeName, $name, $self->function, implode('", "', self::ALLOWED_TYPES))); + if (!\in_array($self->typeName, self::ALLOWED_TYPES, true) && !$isBackedEnum) { + throw new LogicException(\sprintf('The type "%s" on %s "$%s" of "%s" is not supported as a command argument. Only "%s" types and backed enums are allowed.', $self->typeName, $reflection->getMemberName(), $name, $reflection->getSourceName(), implode('", "', self::ALLOWED_TYPES))); } if (!$self->name) { $self->name = (new UnicodeString($name))->kebab(); } - $self->default = $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null; + $self->default = $reflection->hasDefaultValue() ? $reflection->getDefaultValue() : null; - $self->mode = $parameter->isDefaultValueAvailable() || $parameter->allowsNull() ? InputArgument::OPTIONAL : InputArgument::REQUIRED; - if ('array' === $parameterTypeName) { + $isOptional = $reflection->hasDefaultValue() || $reflection->isNullable(); + $self->mode = $isOptional ? InputArgument::OPTIONAL : InputArgument::REQUIRED; + if ('array' === $self->typeName) { $self->mode |= InputArgument::IS_ARRAY; } - if (\is_array($self->suggestedValues) && !\is_callable($self->suggestedValues) && 2 === \count($self->suggestedValues) && ($instance = $parameter->getDeclaringFunction()->getClosureThis()) && $instance::class === $self->suggestedValues[0] && \is_callable([$instance, $self->suggestedValues[1]])) { + if (\is_array($self->suggestedValues) && !\is_callable($self->suggestedValues) && 2 === \count($self->suggestedValues) && ($instance = $reflection->getSourceThis()) && $instance::class === $self->suggestedValues[0] && \is_callable([$instance, $self->suggestedValues[1]])) { + // In case that the callback is declared as a static method `[Foo::class, 'methodName']` - yet it is not callable, + // while non-static method `[Foo $instance, 'methodName']` would be callable, we transform the callback on the fly into a non-static version. $self->suggestedValues = [$instance, $self->suggestedValues[1]]; } + if ($isBackedEnum && !$self->suggestedValues) { + $self->suggestedValues = array_column($self->typeName::cases(), 'value'); + } + + $self->interactiveAttribute = Ask::tryFrom($member, $self->name); + + if ($self->interactiveAttribute && $isOptional) { + throw new LogicException(\sprintf('The %s "$%s" argument of "%s" cannot be both interactive and optional.', $reflection->getMemberName(), $self->name, $reflection->getSourceName())); + } + return $self; } @@ -105,6 +120,28 @@ public function toInputArgument(): InputArgument */ public function resolveValue(InputInterface $input): mixed { - return $input->getArgument($this->name); + $value = $input->getArgument($this->name); + + if (is_subclass_of($this->typeName, \BackedEnum::class) && (\is_string($value) || \is_int($value))) { + return $this->typeName::tryFrom($value) ?? throw InvalidArgumentException::fromEnumValue($this->name, $value, $this->suggestedValues); + } + + return $value; + } + + /** + * @internal + */ + public function getInteractiveAttribute(): ?InteractiveAttributeInterface + { + return $this->interactiveAttribute; + } + + /** + * @internal + */ + public function isRequired(): bool + { + return InputArgument::REQUIRED === (InputArgument::REQUIRED & $this->mode); } } diff --git a/app/vendor/symfony/console/Attribute/AsCommand.php b/app/vendor/symfony/console/Attribute/AsCommand.php index 767d46ebb..8b4cea9c8 100644 --- a/app/vendor/symfony/console/Attribute/AsCommand.php +++ b/app/vendor/symfony/console/Attribute/AsCommand.php @@ -13,11 +13,9 @@ /** * Service tag to autoconfigure commands. - * - * @final since Symfony 7.3 */ #[\Attribute(\Attribute::TARGET_CLASS)] -class AsCommand +final class AsCommand { /** * @param string $name The name of the command, used when calling it (i.e. "cache:clear") @@ -25,6 +23,7 @@ class AsCommand * @param string[] $aliases The list of aliases of the command. The command will be executed when using one of them (i.e. "cache:clean") * @param bool $hidden If true, the command won't be shown when listing all the available commands, but it can still be run as any other command * @param string|null $help The help content of the command, displayed with the help page + * @param string[] $usages The list of usage examples, displayed with the help page */ public function __construct( public string $name, @@ -32,6 +31,7 @@ public function __construct( array $aliases = [], bool $hidden = false, public ?string $help = null, + public array $usages = [], ) { if (!$hidden && !$aliases) { return; diff --git a/app/vendor/symfony/console/Attribute/Ask.php b/app/vendor/symfony/console/Attribute/Ask.php new file mode 100644 index 000000000..360a08421 --- /dev/null +++ b/app/vendor/symfony/console/Attribute/Ask.php @@ -0,0 +1,145 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Console\Attribute; + +use Symfony\Component\Console\Attribute\Reflection\ReflectionMember; +use Symfony\Component\Console\Exception\InvalidArgumentException; +use Symfony\Component\Console\Exception\LogicException; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Question\ConfirmationQuestion; +use Symfony\Component\Console\Question\Question; +use Symfony\Component\Console\Style\SymfonyStyle; + +#[\Attribute(\Attribute::TARGET_PARAMETER | \Attribute::TARGET_PROPERTY)] +class Ask implements InteractiveAttributeInterface +{ + public ?\Closure $normalizer; + public ?\Closure $validator; + private \Closure $closure; + + /** + * @param string $question The question to ask the user + * @param string|bool|int|float|null $default The default answer to return if the user enters nothing + * @param bool $hidden Whether the user response must be hidden or not + * @param bool $multiline Whether the user response should accept newline characters + * @param bool $trimmable Whether the user response must be trimmed or not + * @param int|null $timeout The maximum time the user has to answer the question in seconds + * @param callable|null $validator The validator for the question + * @param int|null $maxAttempts The maximum number of attempts allowed to answer the question. + * Null means an unlimited number of attempts + */ + public function __construct( + public string $question, + public string|bool|int|float|null $default = null, + public bool $hidden = false, + public bool $multiline = false, + public bool $trimmable = true, + public ?int $timeout = null, + ?callable $normalizer = null, + ?callable $validator = null, + public ?int $maxAttempts = null, + ) { + $this->normalizer = $normalizer ? $normalizer(...) : null; + $this->validator = $validator ? $validator(...) : null; + } + + /** + * @internal + */ + public static function tryFrom(\ReflectionParameter|\ReflectionProperty $member, string $name): ?self + { + $reflection = new ReflectionMember($member); + + if (!$self = $reflection->getAttribute(self::class)) { + return null; + } + + $type = $reflection->getType(); + + if (!$type instanceof \ReflectionNamedType) { + throw new LogicException(\sprintf('The %s "$%s" of "%s" must have a named type. Untyped, Union or Intersection types are not supported for interactive questions.', $reflection->getMemberName(), $name, $reflection->getSourceName())); + } + + $self->closure = function (SymfonyStyle $io, InputInterface $input) use ($self, $reflection, $name, $type) { + if ($reflection->isProperty() && isset($this->{$reflection->getName()})) { + return; + } + + if ($reflection->isParameter() && !\in_array($input->getArgument($name), [null, []], true)) { + return; + } + + if ('bool' === $type->getName()) { + $self->default ??= false; + + if (!\is_bool($self->default)) { + throw new LogicException(\sprintf('The "%s::$default" value for the %s "$%s" of "%s" must be a boolean.', self::class, $reflection->getMemberName(), $name, $reflection->getSourceName())); + } + + $question = new ConfirmationQuestion($self->question, $self->default); + } else { + $question = new Question($self->question, $self->default); + } + $question->setHidden($self->hidden); + $question->setMultiline($self->multiline); + $question->setTrimmable($self->trimmable); + $question->setTimeout($self->timeout); + + if (!$self->validator && $reflection->isProperty() && 'array' !== $type->getName()) { + $self->validator = fn (mixed $value): mixed => $this->{$reflection->getName()} = $value; + } + + $question->setValidator($self->validator); + $question->setMaxAttempts($self->maxAttempts); + + if ($self->normalizer) { + $question->setNormalizer($self->normalizer); + } elseif (is_subclass_of($type->getName(), \BackedEnum::class)) { + /** @var class-string<\BackedEnum> $backedType */ + $backedType = $reflection->getType()->getName(); + $question->setNormalizer(static fn (string|int $value) => $backedType::tryFrom($value) ?? throw InvalidArgumentException::fromEnumValue($reflection->getName(), $value, array_column($backedType::cases(), 'value'))); + } + + if ('array' === $type->getName()) { + $value = []; + while ($v = $io->askQuestion($question)) { + if ("\x4" === $v || \PHP_EOL === $v || ($question->isTrimmable() && '' === $v = trim($v))) { + break; + } + $value[] = $v; + } + } else { + $value = $io->askQuestion($question); + } + + if (null === $value && !$reflection->isNullable()) { + return; + } + + if ($reflection->isProperty()) { + $this->{$reflection->getName()} = $value; + } else { + $input->setArgument($name, $value); + } + }; + + return $self; + } + + /** + * @internal + */ + public function getFunction(object $instance): \ReflectionFunction + { + return new \ReflectionFunction($this->closure->bindTo($instance, $instance::class)); + } +} diff --git a/app/vendor/symfony/console/Attribute/Interact.php b/app/vendor/symfony/console/Attribute/Interact.php new file mode 100644 index 000000000..188071ff1 --- /dev/null +++ b/app/vendor/symfony/console/Attribute/Interact.php @@ -0,0 +1,51 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Console\Attribute; + +use Symfony\Component\Console\Exception\LogicException; + +#[\Attribute(\Attribute::TARGET_METHOD)] +class Interact implements InteractiveAttributeInterface +{ + private \ReflectionMethod $method; + + /** + * @internal + */ + public static function tryFrom(\ReflectionMethod $method): ?self + { + /** @var self|null $self */ + if (!$self = ($method->getAttributes(self::class)[0] ?? null)?->newInstance()) { + return null; + } + + if (!$method->isPublic() || $method->isStatic()) { + throw new LogicException(\sprintf('The interactive method "%s::%s()" must be public and non-static.', $method->getDeclaringClass()->getName(), $method->getName())); + } + + if ('__invoke' === $method->getName()) { + throw new LogicException(\sprintf('The "%s::__invoke()" method cannot be used as an interactive method.', $method->getDeclaringClass()->getName())); + } + + $self->method = $method; + + return $self; + } + + /** + * @internal + */ + public function getFunction(object $instance): \ReflectionFunction + { + return new \ReflectionFunction($this->method->getClosure($instance)); + } +} diff --git a/app/vendor/symfony/console/Attribute/InteractiveAttributeInterface.php b/app/vendor/symfony/console/Attribute/InteractiveAttributeInterface.php new file mode 100644 index 000000000..0b02d7d25 --- /dev/null +++ b/app/vendor/symfony/console/Attribute/InteractiveAttributeInterface.php @@ -0,0 +1,20 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Console\Attribute; + +/** + * @internal + */ +interface InteractiveAttributeInterface +{ + public function getFunction(object $instance): \ReflectionFunction; +} diff --git a/app/vendor/symfony/console/Attribute/MapInput.php b/app/vendor/symfony/console/Attribute/MapInput.php new file mode 100644 index 000000000..0b508361a --- /dev/null +++ b/app/vendor/symfony/console/Attribute/MapInput.php @@ -0,0 +1,188 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Console\Attribute; + +use Symfony\Component\Console\Attribute\Reflection\ReflectionMember; +use Symfony\Component\Console\Exception\LogicException; +use Symfony\Component\Console\Input\InputInterface; +use Symfony\Component\Console\Interaction\Interaction; + +/** + * Maps a command input into an object (DTO). + */ +#[\Attribute(\Attribute::TARGET_PARAMETER | \Attribute::TARGET_PROPERTY)] +final class MapInput +{ + /** + * @var array + */ + private array $definition = []; + + private \ReflectionClass $class; + + /** + * @var list + */ + private array $interactiveAttributes = []; + + /** + * @internal + */ + public static function tryFrom(\ReflectionParameter|\ReflectionProperty $member): ?self + { + $reflection = new ReflectionMember($member); + + if (!$self = $reflection->getAttribute(self::class)) { + return null; + } + + $type = $reflection->getType(); + + if (!$type instanceof \ReflectionNamedType) { + throw new LogicException(\sprintf('The input %s "%s" must have a named type.', $reflection->getMemberName(), $member->name)); + } + + if (!class_exists($class = $type->getName())) { + throw new LogicException(\sprintf('The input class "%s" does not exist.', $type->getName())); + } + + $self->class = new \ReflectionClass($class); + + foreach ($self->class->getProperties() as $property) { + if ($argument = Argument::tryFrom($property)) { + $self->definition[$property->name] = $argument; + } elseif ($option = Option::tryFrom($property)) { + $self->definition[$property->name] = $option; + } elseif ($input = self::tryFrom($property)) { + $self->definition[$property->name] = $input; + } + + if (isset($self->definition[$property->name]) && (!$property->isPublic() || $property->isStatic())) { + throw new LogicException(\sprintf('The input property "%s::$%s" must be public and non-static.', $self->class->name, $property->name)); + } + } + + if (!$self->definition) { + throw new LogicException(\sprintf('The input class "%s" must have at least one argument or option.', $self->class->name)); + } + + foreach ($self->class->getMethods() as $method) { + if ($attribute = Interact::tryFrom($method)) { + $self->interactiveAttributes[] = $attribute; + } + } + + return $self; + } + + /** + * @internal + */ + public function resolveValue(InputInterface $input): object + { + $instance = $this->class->newInstanceWithoutConstructor(); + + foreach ($this->definition as $name => $spec) { + // ignore required arguments that are not set yet (may happen in interactive mode) + if ($spec instanceof Argument && $spec->isRequired() && \in_array($input->getArgument($spec->name), [null, []], true)) { + continue; + } + + $instance->$name = $spec->resolveValue($input); + } + + return $instance; + } + + /** + * @internal + */ + public function setValue(InputInterface $input, object $object): void + { + foreach ($this->definition as $name => $spec) { + $property = $this->class->getProperty($name); + + if (!$property->isInitialized($object) || \in_array($value = $property->getValue($object), [null, []], true)) { + continue; + } + + match (true) { + $spec instanceof Argument => $input->setArgument($spec->name, $value), + $spec instanceof Option => $input->setOption($spec->name, $value), + $spec instanceof self => $spec->setValue($input, $value), + default => throw new LogicException('Unexpected specification type.'), + }; + } + } + + /** + * @return iterable + */ + public function getArguments(): iterable + { + foreach ($this->definition as $spec) { + if ($spec instanceof Argument) { + yield $spec; + } elseif ($spec instanceof self) { + yield from $spec->getArguments(); + } + } + } + + /** + * @return iterable