diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 00ef5d23..cbe6308c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -109,6 +109,53 @@ jobs: php_version: ${{ matrix.php }} path: src/ + phpmd: + runs-on: ubuntu-latest + needs: [ composer ] + strategy: + matrix: + php: [ 8.1, 8.2 ] + + steps: + - uses: actions/download-artifact@v3 + with: + name: build-artifact + path: /tmp/github-actions + + - name: Extract build archive + run: tar -xvf /tmp/github-actions/build.tar ./ + + - name: PHP Mess Detector + uses: php-actions/phpmd@v1 + with: + php_version: ${{ matrix.php }} + path: src/ + output: text + ruleset: phpmd.xml + + phpcs: + runs-on: ubuntu-latest + needs: [ composer ] + strategy: + matrix: + php: [ 8.1, 8.2 ] + + steps: + - uses: actions/download-artifact@v3 + with: + name: build-artifact + path: /tmp/github-actions + + - name: Extract build archive + run: tar -xvf /tmp/github-actions/build.tar ./ + + - name: PHP Code Sniffer + uses: php-actions/phpcs@v1 + with: + php_version: ${{ matrix.php }} + path: src/ + standard: phpcs.xml + remove_old_artifacts: runs-on: ubuntu-latest diff --git a/composer.json b/composer.json index 89d5fcc7..0fc74948 100644 --- a/composer.json +++ b/composer.json @@ -15,7 +15,9 @@ "require-dev": { "phpstan/phpstan": "^1.9", - "phpunit/phpunit": "^10.0" + "phpunit/phpunit": "^10.0", + "phpmd/phpmd": "^2.13", + "squizlabs/php_codesniffer": "^3.7" }, "license": "MIT", diff --git a/composer.lock b/composer.lock index c4c0ca13..85eccb98 100644 --- a/composer.lock +++ b/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": "a715731fe758b167340d97dabec17756", + "content-hash": "0b7c6369094fa01f2e26c0c4dc578be7", "packages": [ { "name": "phpgt/cssxpath", @@ -167,6 +167,143 @@ } ], "packages-dev": [ + { + "name": "composer/pcre", + "version": "3.1.0", + "source": { + "type": "git", + "url": "https://github.com/composer/pcre.git", + "reference": "4bff79ddd77851fe3cdd11616ed3f92841ba5bd2" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/composer/pcre/zipball/4bff79ddd77851fe3cdd11616ed3f92841ba5bd2", + "reference": "4bff79ddd77851fe3cdd11616ed3f92841ba5bd2", + "shasum": "" + }, + "require": { + "php": "^7.4 || ^8.0" + }, + "require-dev": { + "phpstan/phpstan": "^1.3", + "phpstan/phpstan-strict-rules": "^1.1", + "symfony/phpunit-bridge": "^5" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "3.x-dev" + } + }, + "autoload": { + "psr-4": { + "Composer\\Pcre\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Jordi Boggiano", + "email": "j.boggiano@seld.be", + "homepage": "http://seld.be" + } + ], + "description": "PCRE wrapping library that offers type-safe preg_* replacements.", + "keywords": [ + "PCRE", + "preg", + "regex", + "regular expression" + ], + "support": { + "issues": "https://github.com/composer/pcre/issues", + "source": "https://github.com/composer/pcre/tree/3.1.0" + }, + "funding": [ + { + "url": "https://packagist.com", + "type": "custom" + }, + { + "url": "https://github.com/composer", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/composer/composer", + "type": "tidelift" + } + ], + "time": "2022-11-17T09:50:14+00:00" + }, + { + "name": "composer/xdebug-handler", + "version": "3.0.3", + "source": { + "type": "git", + "url": "https://github.com/composer/xdebug-handler.git", + "reference": "ced299686f41dce890debac69273b47ffe98a40c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/composer/xdebug-handler/zipball/ced299686f41dce890debac69273b47ffe98a40c", + "reference": "ced299686f41dce890debac69273b47ffe98a40c", + "shasum": "" + }, + "require": { + "composer/pcre": "^1 || ^2 || ^3", + "php": "^7.2.5 || ^8.0", + "psr/log": "^1 || ^2 || ^3" + }, + "require-dev": { + "phpstan/phpstan": "^1.0", + "phpstan/phpstan-strict-rules": "^1.1", + "symfony/phpunit-bridge": "^6.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Composer\\XdebugHandler\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "John Stevenson", + "email": "john-stevenson@blueyonder.co.uk" + } + ], + "description": "Restarts a process without Xdebug.", + "keywords": [ + "Xdebug", + "performance" + ], + "support": { + "irc": "irc://irc.freenode.org/composer", + "issues": "https://github.com/composer/xdebug-handler/issues", + "source": "https://github.com/composer/xdebug-handler/tree/3.0.3" + }, + "funding": [ + { + "url": "https://packagist.com", + "type": "custom" + }, + { + "url": "https://github.com/composer", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/composer/composer", + "type": "tidelift" + } + ], + "time": "2022-02-25T21:32:43+00:00" + }, { "name": "myclabs/deep-copy", "version": "1.11.0", @@ -282,6 +419,63 @@ }, "time": "2023-01-16T22:05:37+00:00" }, + { + "name": "pdepend/pdepend", + "version": "2.13.0", + "source": { + "type": "git", + "url": "https://github.com/pdepend/pdepend.git", + "reference": "31be7cd4f305f3f7b52af99c1cb13fc938d1cfad" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/pdepend/pdepend/zipball/31be7cd4f305f3f7b52af99c1cb13fc938d1cfad", + "reference": "31be7cd4f305f3f7b52af99c1cb13fc938d1cfad", + "shasum": "" + }, + "require": { + "php": ">=5.3.7", + "symfony/config": "^2.3.0|^3|^4|^5|^6.0", + "symfony/dependency-injection": "^2.3.0|^3|^4|^5|^6.0", + "symfony/filesystem": "^2.3.0|^3|^4|^5|^6.0" + }, + "require-dev": { + "easy-doc/easy-doc": "0.0.0|^1.2.3", + "gregwar/rst": "^1.0", + "phpunit/phpunit": "^4.8.36|^5.7.27", + "squizlabs/php_codesniffer": "^2.0.0" + }, + "bin": [ + "src/bin/pdepend" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.x-dev" + } + }, + "autoload": { + "psr-4": { + "PDepend\\": "src/main/php/PDepend" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "description": "Official version of pdepend to be handled with Composer", + "support": { + "issues": "https://github.com/pdepend/pdepend/issues", + "source": "https://github.com/pdepend/pdepend/tree/2.13.0" + }, + "funding": [ + { + "url": "https://tidelift.com/funding/github/packagist/pdepend/pdepend", + "type": "tidelift" + } + ], + "time": "2023-02-28T20:56:15+00:00" + }, { "name": "phar-io/manifest", "version": "2.0.3", @@ -393,18 +587,101 @@ }, "time": "2022-02-21T01:04:05+00:00" }, + { + "name": "phpmd/phpmd", + "version": "2.13.0", + "source": { + "type": "git", + "url": "https://github.com/phpmd/phpmd.git", + "reference": "dad0228156856b3ad959992f9748514fa943f3e3" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/phpmd/phpmd/zipball/dad0228156856b3ad959992f9748514fa943f3e3", + "reference": "dad0228156856b3ad959992f9748514fa943f3e3", + "shasum": "" + }, + "require": { + "composer/xdebug-handler": "^1.0 || ^2.0 || ^3.0", + "ext-xml": "*", + "pdepend/pdepend": "^2.12.1", + "php": ">=5.3.9" + }, + "require-dev": { + "easy-doc/easy-doc": "0.0.0 || ^1.3.2", + "ext-json": "*", + "ext-simplexml": "*", + "gregwar/rst": "^1.0", + "mikey179/vfsstream": "^1.6.8", + "phpunit/phpunit": "^4.8.36 || ^5.7.27", + "squizlabs/php_codesniffer": "^2.0" + }, + "bin": [ + "src/bin/phpmd" + ], + "type": "library", + "autoload": { + "psr-0": { + "PHPMD\\": "src/main/php" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Manuel Pichler", + "email": "github@manuel-pichler.de", + "homepage": "https://github.com/manuelpichler", + "role": "Project Founder" + }, + { + "name": "Marc Würth", + "email": "ravage@bluewin.ch", + "homepage": "https://github.com/ravage84", + "role": "Project Maintainer" + }, + { + "name": "Other contributors", + "homepage": "https://github.com/phpmd/phpmd/graphs/contributors", + "role": "Contributors" + } + ], + "description": "PHPMD is a spin-off project of PHP Depend and aims to be a PHP equivalent of the well known Java tool PMD.", + "homepage": "https://phpmd.org/", + "keywords": [ + "mess detection", + "mess detector", + "pdepend", + "phpmd", + "pmd" + ], + "support": { + "irc": "irc://irc.freenode.org/phpmd", + "issues": "https://github.com/phpmd/phpmd/issues", + "source": "https://github.com/phpmd/phpmd/tree/2.13.0" + }, + "funding": [ + { + "url": "https://tidelift.com/funding/github/packagist/phpmd/phpmd", + "type": "tidelift" + } + ], + "time": "2022-09-10T08:44:15+00:00" + }, { "name": "phpstan/phpstan", - "version": "1.9.17", + "version": "1.10.3", "source": { "type": "git", "url": "https://github.com/phpstan/phpstan.git", - "reference": "204e459e7822f2c586463029f5ecec31bb45a1f2" + "reference": "5419375b5891add97dc74be71e6c1c34baaddf64" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/phpstan/phpstan/zipball/204e459e7822f2c586463029f5ecec31bb45a1f2", - "reference": "204e459e7822f2c586463029f5ecec31bb45a1f2", + "url": "https://api.github.com/repos/phpstan/phpstan/zipball/5419375b5891add97dc74be71e6c1c34baaddf64", + "reference": "5419375b5891add97dc74be71e6c1c34baaddf64", "shasum": "" }, "require": { @@ -434,7 +711,7 @@ ], "support": { "issues": "https://github.com/phpstan/phpstan/issues", - "source": "https://github.com/phpstan/phpstan/tree/1.9.17" + "source": "https://github.com/phpstan/phpstan/tree/1.10.3" }, "funding": [ { @@ -450,27 +727,27 @@ "type": "tidelift" } ], - "time": "2023-02-08T12:25:00+00:00" + "time": "2023-02-25T14:47:13+00:00" }, { "name": "phpunit/php-code-coverage", - "version": "10.0.0", + "version": "10.0.1", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/php-code-coverage.git", - "reference": "bf4fbc9c13af7da12b3ea807574fb460f255daba" + "reference": "b9c21a93dd8c8eed79879374884ee733259475cc" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/bf4fbc9c13af7da12b3ea807574fb460f255daba", - "reference": "bf4fbc9c13af7da12b3ea807574fb460f255daba", + "url": "https://api.github.com/repos/sebastianbergmann/php-code-coverage/zipball/b9c21a93dd8c8eed79879374884ee733259475cc", + "reference": "b9c21a93dd8c8eed79879374884ee733259475cc", "shasum": "" }, "require": { "ext-dom": "*", "ext-libxml": "*", "ext-xmlwriter": "*", - "nikic/php-parser": "^4.14", + "nikic/php-parser": "^4.15", "php": ">=8.1", "phpunit/php-file-iterator": "^4.0", "phpunit/php-text-template": "^3.0", @@ -519,7 +796,7 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/php-code-coverage/issues", - "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/10.0.0" + "source": "https://github.com/sebastianbergmann/php-code-coverage/tree/10.0.1" }, "funding": [ { @@ -527,7 +804,7 @@ "type": "github" } ], - "time": "2023-02-03T07:14:34+00:00" + "time": "2023-02-25T05:35:03+00:00" }, { "name": "phpunit/php-file-iterator", @@ -772,16 +1049,16 @@ }, { "name": "phpunit/phpunit", - "version": "10.0.7", + "version": "10.0.14", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "a6f61c5629dd95db79af72f1e94d56702187479a" + "reference": "7065dbebcb0f66cf16a45fc9cfc28c2351e06169" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/a6f61c5629dd95db79af72f1e94d56702187479a", - "reference": "a6f61c5629dd95db79af72f1e94d56702187479a", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/7065dbebcb0f66cf16a45fc9cfc28c2351e06169", + "reference": "7065dbebcb0f66cf16a45fc9cfc28c2351e06169", "shasum": "" }, "require": { @@ -852,7 +1129,7 @@ ], "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", - "source": "https://github.com/sebastianbergmann/phpunit/tree/10.0.7" + "source": "https://github.com/sebastianbergmann/phpunit/tree/10.0.14" }, "funding": [ { @@ -868,7 +1145,110 @@ "type": "tidelift" } ], - "time": "2023-02-08T15:16:31+00:00" + "time": "2023-03-01T05:37:49+00:00" + }, + { + "name": "psr/container", + "version": "2.0.2", + "source": { + "type": "git", + "url": "https://github.com/php-fig/container.git", + "reference": "c71ecc56dfe541dbd90c5360474fbc405f8d5963" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/container/zipball/c71ecc56dfe541dbd90c5360474fbc405f8d5963", + "reference": "c71ecc56dfe541dbd90c5360474fbc405f8d5963", + "shasum": "" + }, + "require": { + "php": ">=7.4.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "2.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\Container\\": "src/" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common Container Interface (PHP FIG PSR-11)", + "homepage": "https://github.com/php-fig/container", + "keywords": [ + "PSR-11", + "container", + "container-interface", + "container-interop", + "psr" + ], + "support": { + "issues": "https://github.com/php-fig/container/issues", + "source": "https://github.com/php-fig/container/tree/2.0.2" + }, + "time": "2021-11-05T16:47:00+00:00" + }, + { + "name": "psr/log", + "version": "3.0.0", + "source": { + "type": "git", + "url": "https://github.com/php-fig/log.git", + "reference": "fe5ea303b0887d5caefd3d431c3e61ad47037001" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/php-fig/log/zipball/fe5ea303b0887d5caefd3d431c3e61ad47037001", + "reference": "fe5ea303b0887d5caefd3d431c3e61ad47037001", + "shasum": "" + }, + "require": { + "php": ">=8.0.0" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.x-dev" + } + }, + "autoload": { + "psr-4": { + "Psr\\Log\\": "src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "PHP-FIG", + "homepage": "https://www.php-fig.org/" + } + ], + "description": "Common interface for logging libraries", + "homepage": "https://github.com/php-fig/log", + "keywords": [ + "log", + "psr", + "psr-3" + ], + "support": { + "source": "https://github.com/php-fig/log/tree/3.0.0" + }, + "time": "2021-07-14T16:46:02+00:00" }, { "name": "sebastian/cli-parser", @@ -1778,6 +2158,681 @@ ], "time": "2023-02-07T11:34:05+00:00" }, + { + "name": "squizlabs/php_codesniffer", + "version": "3.7.2", + "source": { + "type": "git", + "url": "https://github.com/squizlabs/PHP_CodeSniffer.git", + "reference": "ed8e00df0a83aa96acf703f8c2979ff33341f879" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/ed8e00df0a83aa96acf703f8c2979ff33341f879", + "reference": "ed8e00df0a83aa96acf703f8c2979ff33341f879", + "shasum": "" + }, + "require": { + "ext-simplexml": "*", + "ext-tokenizer": "*", + "ext-xmlwriter": "*", + "php": ">=5.4.0" + }, + "require-dev": { + "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0" + }, + "bin": [ + "bin/phpcs", + "bin/phpcbf" + ], + "type": "library", + "extra": { + "branch-alias": { + "dev-master": "3.x-dev" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "BSD-3-Clause" + ], + "authors": [ + { + "name": "Greg Sherwood", + "role": "lead" + } + ], + "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.", + "homepage": "https://github.com/squizlabs/PHP_CodeSniffer", + "keywords": [ + "phpcs", + "standards", + "static analysis" + ], + "support": { + "issues": "https://github.com/squizlabs/PHP_CodeSniffer/issues", + "source": "https://github.com/squizlabs/PHP_CodeSniffer", + "wiki": "https://github.com/squizlabs/PHP_CodeSniffer/wiki" + }, + "time": "2023-02-22T23:07:41+00:00" + }, + { + "name": "symfony/config", + "version": "v6.2.7", + "source": { + "type": "git", + "url": "https://github.com/symfony/config.git", + "reference": "249271da6f545d6579e0663374f8249a80be2893" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/config/zipball/249271da6f545d6579e0663374f8249a80be2893", + "reference": "249271da6f545d6579e0663374f8249a80be2893", + "shasum": "" + }, + "require": { + "php": ">=8.1", + "symfony/deprecation-contracts": "^2.1|^3", + "symfony/filesystem": "^5.4|^6.0", + "symfony/polyfill-ctype": "~1.8" + }, + "conflict": { + "symfony/finder": "<5.4" + }, + "require-dev": { + "symfony/event-dispatcher": "^5.4|^6.0", + "symfony/finder": "^5.4|^6.0", + "symfony/messenger": "^5.4|^6.0", + "symfony/service-contracts": "^1.1|^2|^3", + "symfony/yaml": "^5.4|^6.0" + }, + "suggest": { + "symfony/yaml": "To use the yaml reference dumper" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Config\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Helps you find, load, combine, autofill and validate configuration values of any kind", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/config/tree/v6.2.7" + }, + "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": "2023-02-14T08:44:56+00:00" + }, + { + "name": "symfony/dependency-injection", + "version": "v6.2.7", + "source": { + "type": "git", + "url": "https://github.com/symfony/dependency-injection.git", + "reference": "83369dd4ec84bba9673524d25b79dfbde9e6e84c" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/dependency-injection/zipball/83369dd4ec84bba9673524d25b79dfbde9e6e84c", + "reference": "83369dd4ec84bba9673524d25b79dfbde9e6e84c", + "shasum": "" + }, + "require": { + "php": ">=8.1", + "psr/container": "^1.1|^2.0", + "symfony/deprecation-contracts": "^2.1|^3", + "symfony/service-contracts": "^1.1.6|^2.0|^3.0", + "symfony/var-exporter": "^6.2.7" + }, + "conflict": { + "ext-psr": "<1.1|>=2", + "symfony/config": "<6.1", + "symfony/finder": "<5.4", + "symfony/proxy-manager-bridge": "<6.2", + "symfony/yaml": "<5.4" + }, + "provide": { + "psr/container-implementation": "1.1|2.0", + "symfony/service-implementation": "1.1|2.0|3.0" + }, + "require-dev": { + "symfony/config": "^6.1", + "symfony/expression-language": "^5.4|^6.0", + "symfony/yaml": "^5.4|^6.0" + }, + "suggest": { + "symfony/config": "", + "symfony/expression-language": "For using expressions in service container configuration", + "symfony/finder": "For using double-star glob patterns or when GLOB_BRACE portability is required", + "symfony/yaml": "" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\DependencyInjection\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Allows you to standardize and centralize the way objects are constructed in your application", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/dependency-injection/tree/v6.2.7" + }, + "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": "2023-02-16T14:11:02+00:00" + }, + { + "name": "symfony/deprecation-contracts", + "version": "v3.2.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/deprecation-contracts.git", + "reference": "e2d1534420bd723d0ef5aec58a22c5fe60ce6f5e" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/e2d1534420bd723d0ef5aec58a22c5fe60ce6f5e", + "reference": "e2d1534420bd723d0ef5aec58a22c5fe60ce6f5e", + "shasum": "" + }, + "require": { + "php": ">=8.1" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "3.3-dev" + }, + "thanks": { + "name": "symfony/contracts", + "url": "https://github.com/symfony/contracts" + } + }, + "autoload": { + "files": [ + "function.php" + ] + }, + "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 generic function and convention to trigger deprecation notices", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/deprecation-contracts/tree/v3.2.1" + }, + "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": "2023-03-01T10:25:55+00:00" + }, + { + "name": "symfony/filesystem", + "version": "v6.2.7", + "source": { + "type": "git", + "url": "https://github.com/symfony/filesystem.git", + "reference": "82b6c62b959f642d000456f08c6d219d749215b3" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/filesystem/zipball/82b6c62b959f642d000456f08c6d219d749215b3", + "reference": "82b6c62b959f642d000456f08c6d219d749215b3", + "shasum": "" + }, + "require": { + "php": ">=8.1", + "symfony/polyfill-ctype": "~1.8", + "symfony/polyfill-mbstring": "~1.8" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\Filesystem\\": "" + }, + "exclude-from-classmap": [ + "/Tests/" + ] + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Fabien Potencier", + "email": "fabien@symfony.com" + }, + { + "name": "Symfony Community", + "homepage": "https://symfony.com/contributors" + } + ], + "description": "Provides basic utilities for the filesystem", + "homepage": "https://symfony.com", + "support": { + "source": "https://github.com/symfony/filesystem/tree/v6.2.7" + }, + "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": "2023-02-14T08:44:56+00:00" + }, + { + "name": "symfony/polyfill-ctype", + "version": "v1.27.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-ctype.git", + "reference": "5bbc823adecdae860bb64756d639ecfec17b050a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/5bbc823adecdae860bb64756d639ecfec17b050a", + "reference": "5bbc823adecdae860bb64756d639ecfec17b050a", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "provide": { + "ext-ctype": "*" + }, + "suggest": { + "ext-ctype": "For best performance" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.27-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/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.27.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": "2022-11-03T14:55:06+00:00" + }, + { + "name": "symfony/polyfill-mbstring", + "version": "v1.27.0", + "source": { + "type": "git", + "url": "https://github.com/symfony/polyfill-mbstring.git", + "reference": "8ad114f6b39e2c98a8b0e3bd907732c207c2b534" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/polyfill-mbstring/zipball/8ad114f6b39e2c98a8b0e3bd907732c207c2b534", + "reference": "8ad114f6b39e2c98a8b0e3bd907732c207c2b534", + "shasum": "" + }, + "require": { + "php": ">=7.1" + }, + "provide": { + "ext-mbstring": "*" + }, + "suggest": { + "ext-mbstring": "For best performance" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "1.27-dev" + }, + "thanks": { + "name": "symfony/polyfill", + "url": "https://github.com/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.27.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": "2022-11-03T14:55:06+00:00" + }, + { + "name": "symfony/service-contracts", + "version": "v3.2.1", + "source": { + "type": "git", + "url": "https://github.com/symfony/service-contracts.git", + "reference": "a8c9cedf55f314f3a186041d19537303766df09a" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/service-contracts/zipball/a8c9cedf55f314f3a186041d19537303766df09a", + "reference": "a8c9cedf55f314f3a186041d19537303766df09a", + "shasum": "" + }, + "require": { + "php": ">=8.1", + "psr/container": "^2.0" + }, + "conflict": { + "ext-psr": "<1.1|>=2" + }, + "suggest": { + "symfony/service-implementation": "" + }, + "type": "library", + "extra": { + "branch-alias": { + "dev-main": "3.3-dev" + }, + "thanks": { + "name": "symfony/contracts", + "url": "https://github.com/symfony/contracts" + } + }, + "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.2.1" + }, + "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": "2023-03-01T10:32:47+00:00" + }, + { + "name": "symfony/var-exporter", + "version": "v6.2.7", + "source": { + "type": "git", + "url": "https://github.com/symfony/var-exporter.git", + "reference": "86062dd0103530e151588c8f60f5b85a139f1442" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/symfony/var-exporter/zipball/86062dd0103530e151588c8f60f5b85a139f1442", + "reference": "86062dd0103530e151588c8f60f5b85a139f1442", + "shasum": "" + }, + "require": { + "php": ">=8.1" + }, + "require-dev": { + "symfony/var-dumper": "^5.4|^6.0" + }, + "type": "library", + "autoload": { + "psr-4": { + "Symfony\\Component\\VarExporter\\": "" + }, + "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": "Allows exporting any serializable PHP data structure to plain PHP code", + "homepage": "https://symfony.com", + "keywords": [ + "clone", + "construct", + "export", + "hydrate", + "instantiate", + "lazy loading", + "proxy", + "serialize" + ], + "support": { + "source": "https://github.com/symfony/var-exporter/tree/v6.2.7" + }, + "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": "2023-02-24T10:42:00+00:00" + }, { "name": "theseer/tokenizer", "version": "1.2.1", diff --git a/phpcs.xml b/phpcs.xml new file mode 100644 index 00000000..bff466c6 --- /dev/null +++ b/phpcs.xml @@ -0,0 +1,65 @@ + + + Created from PHP.Gt/Styleguide + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/phpmd.xml b/phpmd.xml new file mode 100644 index 00000000..63c4a821 --- /dev/null +++ b/phpmd.xml @@ -0,0 +1,51 @@ + + + Custom ruleset + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + + + + + + + + + + + diff --git a/src/DOMTokenList.php b/src/DOMTokenList.php index a14a121a..fcf4a90d 100644 --- a/src/DOMTokenList.php +++ b/src/DOMTokenList.php @@ -236,8 +236,10 @@ public function forEach(callable $callback):void { * @link https://developer.mozilla.org/en-US/docs/Web/API/DOMTokenList/keys */ public function keys():iterable { - foreach($this as $key => $value) { - yield $key; + $this->rewind(); + while($this->valid()) { + yield $this->key(); + $this->next(); } } @@ -250,7 +252,7 @@ public function keys():iterable { * @link https://developer.mozilla.org/en-US/docs/Web/API/DOMTokenList/values */ public function values():iterable { - foreach($this as $key => $value) { + foreach($this as $value) { yield $value; } } diff --git a/src/Document.php b/src/Document.php index a5a44ed4..919e631a 100644 --- a/src/Document.php +++ b/src/Document.php @@ -19,9 +19,7 @@ use Gt\Dom\Exception\HTMLDocumentDoesNotSupportCDATASectionException; use Gt\Dom\Exception\InvalidCharacterException; use Gt\Dom\Exception\NotSupportedException; -use JetBrains\PhpStorm\Internal\LanguageLevelTypeAware; use Psr\Http\Message\StreamInterface; -use ReturnTypeWillChange; use Stringable; /** @@ -37,7 +35,7 @@ abstract class Document extends DOMDocument implements Stringable, StreamInterfa use ParentNode; use RegisteredNodeClass; - const NodeClassLookup = [ + const NODE_CLASS_LOOKUP = [ DOMDocument::class => Document::class, DOMAttr::class => Attr::class, DOMCdataSection::class => CdataSection::class, @@ -251,9 +249,9 @@ public function createProcessingInstruction( throw new InvalidCharacterException($closingTag); } - /** @var ProcessingInstruction $processingInstruction */ - $processingInstruction = parent::createProcessingInstruction($target, $data); - return $processingInstruction; + /** @var ProcessingInstruction $procInstruction */ + $procInstruction = parent::createProcessingInstruction($target, $data); + return $procInstruction; } /** @@ -358,7 +356,7 @@ public function writeln($line):int { } private function registerNodeClasses():void { - foreach(self::NodeClassLookup as $nativeClass => $gtClass) { + foreach(self::NODE_CLASS_LOOKUP as $nativeClass => $gtClass) { $this->registerNodeClass($nativeClass, $gtClass); } } diff --git a/src/Element.php b/src/Element.php index c84a7cc7..31e42538 100644 --- a/src/Element.php +++ b/src/Element.php @@ -60,6 +60,7 @@ protected function __prop_set_className(string $className):void { $this->setAttribute("class", $className); } + // phpcs:ignore public function __prop_get_elementType():ElementType { return match($this->tagName) { "a" => ElementType::HTMLAnchorElement, diff --git a/src/HTMLCollection.php b/src/HTMLCollection.php index 511183cc..5be55acc 100644 --- a/src/HTMLCollection.php +++ b/src/HTMLCollection.php @@ -137,7 +137,7 @@ public function namedItem(string $nameOrId):Element|RadioNodeList|null { "name" => [], ]; - foreach($matches as $attribute => $list) { + foreach(array_keys($matches) as $attribute) { foreach($this as $element) { if($element->getAttribute($attribute) === $nameOrId) { array_push($matches[$attribute], $element); diff --git a/src/HTMLElement.php b/src/HTMLElement.php index 89b665bc..65a53578 100644 --- a/src/HTMLElement.php +++ b/src/HTMLElement.php @@ -296,6 +296,7 @@ public function count():int { * Builds and returns a URL string from the existing href attribute * value with the newly supplied overrides. */ + // phpcs:ignore Generic.Metrics.CyclomaticComplexity private function buildUrl( string $scheme = null, string $user = null, @@ -2261,7 +2262,7 @@ protected function __prop_set_open(bool $value):void { ); if($value) { - $this->setAttribute("open",""); + $this->setAttribute("open", ""); } else { $this->removeAttribute("open"); @@ -4235,6 +4236,7 @@ public function deleteCaption():void { * @link https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableElement/insertRow * @link https://html.spec.whatwg.org/multipage/#htmltableelement */ + // phpcs:ignore public function insertRow(int $index = null):Element { $this->allowTypes( ElementType::HTMLTableElement, @@ -4388,6 +4390,7 @@ protected function __prop_get_cells():HTMLCollection { /** * @link https://developer.mozilla.org/en-US/docs/Web/API/HTMLTableRowElement/rowIndex */ + // phpcs:ignore Generic.Metrics.CyclomaticComplexity protected function __prop_get_rowIndex():int { $this->allowTypes( ElementType::HTMLTableRowElement, @@ -4409,7 +4412,7 @@ protected function __prop_get_rowIndex():int { $headCount = 0; foreach($table?->querySelectorAll("thead>tr") ?? [] as $headIndex => $headChild) { - $headCount ++; + $headCount++; if($headChild === $this) { return $headIndex; } @@ -4417,7 +4420,7 @@ protected function __prop_get_rowIndex():int { $bodyCount = 0; foreach($table?->querySelectorAll("tbody>tr") ?? [] as $bodyIndex => $headChild) { - $bodyCount ++; + $bodyCount++; if($headChild === $this) { return $headCount + $bodyIndex; } diff --git a/src/NodeList.php b/src/NodeList.php index 5ec409a1..e624fef0 100644 --- a/src/NodeList.php +++ b/src/NodeList.php @@ -211,8 +211,10 @@ public function forEach(callable $callback):void { * @link https://developer.mozilla.org/en-US/docs/Web/API/NodeList/keys */ public function keys():Traversable { - foreach($this as $key => $value) { - yield $key; + $this->rewind(); + while($this->valid()) { + yield $this->key(); + $this->next(); } } diff --git a/src/ParentNode.php b/src/ParentNode.php index 70aa3e15..d84c6505 100644 --- a/src/ParentNode.php +++ b/src/ParentNode.php @@ -258,7 +258,9 @@ public function getElementsByTagName(string $qualifiedName):HTMLCollection { * The removeChild() method of the Node interface removes a child node * from the DOM and returns the removed node. */ - public function removeChild(Node|Element|Text|Comment|DOMNode|ProcessingInstruction $child):Node|Element|Text|Comment|CdataSection|ProcessingInstruction { + public function removeChild( + Node|Element|Text|Comment|DOMNode|ProcessingInstruction $child + ):Node|Element|Text|Comment|CdataSection|ProcessingInstruction { try { /** @var Node|Element|Text|Comment $removed */ $removed = parent::removeChild($child); @@ -275,7 +277,10 @@ public function removeChild(Node|Element|Text|Comment|DOMNode|ProcessingInstruct * within the given (parent) node. * @return Node|Element|Text|Comment the replaced node */ - public function replaceChild(Node|Element|DOMNode $node, Node|Element|DOMNode $child):Node|Element|Text|Comment { + public function replaceChild( + Node|Element|DOMNode $node, + Node|Element|DOMNode $child + ):Node|Element|Text|Comment { try { /** @var Node|Element|Text|Comment|false $replaced */ $replaced = parent::replaceChild($node, $child); diff --git a/src/RegisteredNodeClass.php b/src/RegisteredNodeClass.php index 8c5634f0..65302e0a 100644 --- a/src/RegisteredNodeClass.php +++ b/src/RegisteredNodeClass.php @@ -27,6 +27,7 @@ trait RegisteredNodeClass { * @return bool * @link https://developer.mozilla.org/en-US/docs/Web/API/Node/isEqualNode */ + // phpcs:ignore public function isEqualNode(Node|Element|Document|DocumentType|Attr|ProcessingInstruction|DOMNode $otherNode):bool { if($otherNode instanceof Document) { $otherNode = $otherNode->documentElement; @@ -166,7 +167,10 @@ public function compareDocumentPosition(DOMNode|Node|Element $otherNode):int { * @return bool * @link https://developer.mozilla.org/en-US/docs/Web/API/Node/contains */ - public function contains(Node|Element|Text|ProcessingInstruction|DocumentType|DocumentFragment|Document|Comment|CdataSection|Attr $otherNode):bool { + public function contains( + Node|Element|Text|ProcessingInstruction|DocumentType|DocumentFragment + |Document|Comment|CdataSection|Attr $otherNode + ):bool { $context = $otherNode; while($context = $context->parentNode) { diff --git a/src/Traversal.php b/src/Traversal.php index abbecf70..55402ccb 100644 --- a/src/Traversal.php +++ b/src/Traversal.php @@ -6,12 +6,15 @@ trait Traversal { use MagicProp; - private Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $pRoot; + private Node|Element|Text|Attr|ProcessingInstruction|Comment|Document + |DocumentType|DocumentFragment $pRoot; private int $pWhatToShow; - private Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $pCurrentNode; + private Node|Element|Text|Attr|ProcessingInstruction|Comment|Document + |DocumentType|DocumentFragment $pCurrentNode; private NodeFilter $pFilter; private int $iteratorIndex; - private null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $validity; + private null|Node|Element|Text|Attr|ProcessingInstruction|Comment + |Document|DocumentType|DocumentFragment $validity; protected function __construct( Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $root, @@ -26,11 +29,15 @@ protected function __construct( $this->validity = null; if(!$filter) { - $filter = fn(Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node) => $this->filterFunction($node); + $filter = fn(Node|Element|Text|Attr|ProcessingInstruction + |Comment|Document|DocumentType|DocumentFragment $node) => $this->filterFunction($node); } if(is_callable($filter)) { - $filter = new class($filter, fn(Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node) => $this->filterFunction($node)) extends NodeFilter { + $filter = new class($filter, fn( + Node|Element|Text|Attr|ProcessingInstruction + |Comment|Document|DocumentType|DocumentFragment $node + ) => $this->filterFunction($node)) extends NodeFilter { /** @var callable */ private $callback; /** @var callable */ @@ -38,13 +45,16 @@ protected function __construct( public function __construct( callable $callback, - callable $defaultFilterFunction + callable $defaultCallback ) { $this->callback = $callback; - $this->defaultCallback = $defaultFilterFunction; + $this->defaultCallback = $defaultCallback; } - public function acceptNode(Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node):int { + public function acceptNode( + Node|Element|Text|Attr|ProcessingInstruction + |Comment|Document|DocumentType|DocumentFragment $node + ):int { $showFilter = call_user_func( $this->defaultCallback, $node @@ -66,7 +76,8 @@ public function acceptNode(Node|Element|Text|Attr|ProcessingInstruction|Comment| } /** @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/root */ - protected function __prop_get_root():Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + protected function __prop_get_root( + ):Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $this->pRoot; } @@ -81,7 +92,8 @@ protected function __prop_get_filter():NodeFilter { } /** @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/currentNode */ - protected function __prop_get_currentNode():Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + protected function __prop_get_currentNode( + ):Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $this->pCurrentNode; } @@ -95,7 +107,8 @@ protected function __prop_get_currentNode():Node|Element|Text|Attr|ProcessingIns * @return null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment * @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/parentNode */ - public function parentNode():null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function parentNode( + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { $node = $this->pCurrentNode; while($node && $node !== $this->pRoot) { @@ -122,7 +135,8 @@ public function parentNode():null|Node|Element|Text|Attr|ProcessingInstruction|C * @return null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment * @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/firstChild */ - public function firstChild():null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function firstChild( + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $this->traverseChildren("first"); } @@ -135,7 +149,8 @@ public function firstChild():null|Node|Element|Text|Attr|ProcessingInstruction|C * @return null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment * @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/lastChild */ - public function lastChild():null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function lastChild( + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $this->traverseChildren("last"); } @@ -148,7 +163,8 @@ public function lastChild():null|Node|Element|Text|Attr|ProcessingInstruction|Co * @return null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment * @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/previousSibling */ - public function previousSibling():null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function previousSibling( + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $this->traverseSiblings("previous"); } @@ -160,7 +176,8 @@ public function previousSibling():null|Node|Element|Text|Attr|ProcessingInstruct * @return null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment * @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/nextSibling */ - public function nextSibling():null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function nextSibling( + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $this->traverseSiblings("next"); } @@ -174,7 +191,8 @@ public function nextSibling():null|Node|Element|Text|Attr|ProcessingInstruction| * @return null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment * @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/previousNode */ - public function previousNode():null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function previousNode( + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { /** @var null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node */ $node = $this->pCurrentNode; @@ -229,7 +247,8 @@ public function previousNode():null|Node|Element|Text|Attr|ProcessingInstruction * @return null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment * @link https://developer.mozilla.org/en-US/docs/Web/API/TreeWalker/nextNode */ - public function nextNode():null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function nextNode( + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { if($node = $this->getNextNode($this->pCurrentNode)) { /** @var Node $node */ $this->pCurrentNode = $node; @@ -239,7 +258,9 @@ public function nextNode():null|Node|Element|Text|Attr|ProcessingInstruction|Com return null; } - private function getNextNode(Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + private function getNextNode( + Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { $result = NodeFilter::FILTER_ACCEPT; while(true) { @@ -276,7 +297,8 @@ private function getNextNode(Node|Element|Text|Attr|ProcessingInstruction|Commen return null; } - public function current():Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + public function current( + ):Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $this->pCurrentNode; } @@ -300,7 +322,9 @@ public function rewind():void { $this->pCurrentNode = $this->pRoot; } - private function traverseChildren(string $direction):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + private function traverseChildren( + string $direction + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { $node = $this->matchChild($this->pCurrentNode, $direction); if(!$node) { return null; @@ -336,7 +360,9 @@ private function recurseTraverseChildren( return $node; } - private function traverseSiblings(string $direction):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + private function traverseSiblings( + string $direction + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { $node = $this->pCurrentNode; if($node === $this->pRoot) { @@ -359,7 +385,10 @@ private function traverseSiblings(string $direction):null|Node|Element|Text|Attr return $node; } - private function matchChild(Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node, string $direction):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + private function matchChild( + Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node, + string $direction + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { $result = match($direction) { "first" => $node->firstChild, "last", "next", "previous" => $node->lastChild, @@ -368,7 +397,10 @@ private function matchChild(Node|Element|Text|Attr|ProcessingInstruction|Comment return $this->hintNullableNodeType($result); } - private function matchSibling(Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node, string $direction):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + private function matchSibling( + Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node, + string $direction + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { $result = match($direction) { "next" => $node->nextSibling, "previous" => $node->previousSibling, @@ -404,7 +436,10 @@ private function nextSkippingChildren( return null; } - private function filterFunction(Node|Element|Attr|Text|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node):int { + // phpcs:ignore + private function filterFunction( + Node|Element|Attr|Text|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $node + ):int { $show = $this->pWhatToShow; if($show === NodeFilter::SHOW_ALL) { return NodeFilter::FILTER_ACCEPT; @@ -447,7 +482,9 @@ private function filterFunction(Node|Element|Attr|Text|ProcessingInstruction|Com * correct types at runtime. It also helps PHPStan understand the * correct types that are in use. */ - private function hintNodeType(Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $input):Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + private function hintNodeType( + Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $input + ):Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $input; } @@ -457,7 +494,9 @@ private function hintNodeType(Node|Element|Text|Attr|ProcessingInstruction|Comme * correct types at runtime. It also helps PHPStan understand the * correct types that are in use. */ - private function hintNullableNodeType(null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $input):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { + private function hintNullableNodeType( + null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment $input + ):null|Node|Element|Text|Attr|ProcessingInstruction|Comment|Document|DocumentType|DocumentFragment { return $input; } } diff --git a/src/XPathResult.php b/src/XPathResult.php index df3d4b2f..b1d57627 100644 --- a/src/XPathResult.php +++ b/src/XPathResult.php @@ -1,6 +1,7 @@ query($query, $context); if(!$result) {