├── cache
    └── .gitkeep
├── .gitignore
├── .editorconfig
├── .github
    ├── dependabot.yml
    └── workflows
    │   └── checks.yml
├── phpstan.neon.dist
├── composer.json
├── licence.md
├── src
    └── Xml
    │   ├── XmlException.php
    │   └── XmlLoader.php
├── readme.md
├── tests
    └── XmlLoaderTest.phpt
├── composer.lock
└── phpcs.xml.dist


/cache/.gitkeep:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | /cache/*
3 | !/cache/.gitkeep
4 | /.idea
5 | /tests/output
6 | 


--------------------------------------------------------------------------------
/.editorconfig:
--------------------------------------------------------------------------------
1 | [*]
2 | charset = utf-8
3 | end_of_line = lf
4 | trim_trailing_whitespace = true
5 | insert_final_newline = true
6 | indent_style = space
7 | indent_size = 4
8 | 
9 | 


--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
 1 | version: 2
 2 | updates:
 3 |     -
 4 |         package-ecosystem: composer
 5 |         directory: "/"
 6 |         schedule:
 7 |             interval: monthly
 8 |         versioning-strategy: lockfile-only
 9 |         groups:
10 |             dev-dependencies:
11 |                 dependency-type: development
12 | 


--------------------------------------------------------------------------------
/phpstan.neon.dist:
--------------------------------------------------------------------------------
 1 | includes:
 2 |     - phar://phpstan.phar/conf/config.levelmax.neon
 3 |     - phar://phpstan.phar/conf/bleedingEdge.neon
 4 |     - ./vendor/phpstan/phpstan-strict-rules/rules.neon
 5 | 
 6 | parameters:
 7 |     paths:
 8 |         - src
 9 |         - tests
10 |     tmpDir: %rootDir%/../../../cache/phpstan/
11 |     checkMissingCallableSignature: true
12 |     checkUninitializedProperties: true
13 |     checkTooWideReturnTypesInProtectedAndPublicMethods: true
14 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "lightools/xml",
 3 |     "description": "Simple and safe parsing of XML and HTML sources.",
 4 |     "license": ["MIT"],
 5 |     "require": {
 6 |         "php": ">=8.0",
 7 |         "ext-dom": "*",
 8 |         "ext-libxml": "*"
 9 |     },
10 |     "require-dev": {
11 |         "editorconfig-checker/editorconfig-checker": "^10.4.0",
12 |         "nette/tester": "^v2.5.1",
13 |         "phpstan/phpstan": "^1.10.34",
14 |         "phpstan/phpstan-strict-rules": "^1.5.1",
15 |         "slevomat/coding-standard": "^8.13.4"
16 |     },
17 |     "config": {
18 |         "sort-packages": true,
19 |         "allow-plugins": {
20 |             "dealerdirect/phpcodesniffer-composer-installer": false
21 |         }
22 |     },
23 |     "autoload": {
24 |         "classmap": ["src/"]
25 |     },
26 |     "scripts": {
27 |         "check": "ec && phpcs && phpstan analyse -vvv && tester -C tests"
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/.github/workflows/checks.yml:
--------------------------------------------------------------------------------
 1 | name: Checks
 2 | on:
 3 |     pull_request:
 4 |     push:
 5 |         branches:
 6 |             - "master"
 7 |             - "v[0-9]"
 8 | jobs:
 9 |     checks:
10 |         runs-on: ubuntu-latest
11 |         strategy:
12 |             fail-fast: false
13 |             matrix:
14 |                 php-version: [ '8.0', '8.1', '8.2', '8.3', '8.4' ]
15 |         steps:
16 |             -
17 |                 name: Checkout code
18 |                 uses: actions/checkout@v4
19 |             -
20 |                 name: Setup PHP
21 |                 uses: shivammathur/setup-php@v2
22 |                 with:
23 |                     php-version: ${{ matrix.php-version }}
24 |             -
25 |                 name: Install dependencies
26 |                 run: composer install --no-progress --prefer-dist --no-interaction
27 |             -
28 |                 name: Run checks and tests
29 |                 run: composer check
30 | 


--------------------------------------------------------------------------------
/licence.md:
--------------------------------------------------------------------------------
 1 | ## License
 2 | 
 3 | The MIT License (MIT)
 4 | 
 5 | Copyright (c) 2016 Jan Nedbal
 6 | 
 7 | 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:
 8 | 
 9 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
10 | 
11 | 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.
12 | 


--------------------------------------------------------------------------------
/src/Xml/XmlException.php:
--------------------------------------------------------------------------------
 1 | <?php declare(strict_types = 1);
 2 | 
 3 | namespace Lightools\Xml;
 4 | 
 5 | use LibXMLError;
 6 | use RuntimeException;
 7 | use function trim;
 8 | use const LIBXML_ERR_ERROR;
 9 | use const LIBXML_ERR_FATAL;
10 | use const LIBXML_ERR_WARNING;
11 | 
12 | class XmlException extends RuntimeException
13 | {
14 | 
15 |     private LibXMLError $error;
16 | 
17 |     public function __construct(LibXMLError $error)
18 |     {
19 |         $this->error = $error;
20 |         $info = trim($error->message) . " on line $error->line and column $error->column";
21 | 
22 |         $errorMessage = match ($error->level) {
23 |             LIBXML_ERR_WARNING => "XML Warning #$error->code: $info",
24 |             LIBXML_ERR_ERROR => "XML Error #$error->code: $info",
25 |             LIBXML_ERR_FATAL => "XML Fatal Error #$error->code: $info",
26 |             default => "Unknown XML failure #$error->code: $info",
27 |         };
28 | 
29 |         parent::__construct($errorMessage, $error->code);
30 |     }
31 | 
32 |     public function getError(): LibXMLError
33 |     {
34 |         return $this->error;
35 |     }
36 | 
37 | }
38 | 


--------------------------------------------------------------------------------
/readme.md:
--------------------------------------------------------------------------------
 1 | ## Introduction
 2 | 
 3 | This library provides simple interface for loading XML or HTML strings to DomDocument object.
 4 | It prevents some known vulnerabilities and allows you to handle LibXML errors simply by catching XmlException as you can see below.
 5 | 
 6 | ## Installation
 7 | 
 8 | ```sh
 9 | $ composer require lightools/xml
10 | ```
11 | 
12 | ## Simple usage
13 | 
14 | Both loading methods (loadXml and loadHtml) return DomDocument.
15 | If you prefer working with SimpleXmlElement, you can use [simplexml_import_dom](https://secure.php.net/manual/en/function.simplexml-import-dom.php) function.
16 | 
17 | ```php
18 | $xml = '<?xml version="1.0"?><root>text</root>';
19 | $html = '<!doctype html><title>Foo</title>';
20 | 
21 | $loader = new Lightools\Xml\XmlLoader();
22 | 
23 | try {
24 |     $xmlDomDocument = $loader->loadXml($xml);
25 |     $htmlDomDocument = $loader->loadHtml($html);
26 | 
27 | } catch (Lightools\Xml\XmlException $e) {
28 |     // process exception
29 | }
30 | ```
31 | 
32 | ## How to run checks
33 | 
34 | ```sh
35 | $ composer check
36 | ```
37 | 
38 | 
39 | ## Versions
40 | 
41 | - v1.x is for PHP 5.4 and higher
42 | - v2.x is for PHP 7.1 and higher
43 | - v3.x is for PHP 8.0 and higher
44 | 


--------------------------------------------------------------------------------
/src/Xml/XmlLoader.php:
--------------------------------------------------------------------------------
 1 | <?php declare(strict_types = 1);
 2 | 
 3 | namespace Lightools\Xml;
 4 | 
 5 | use DOMDocument;
 6 | use LibXMLError;
 7 | use function libxml_clear_errors;
 8 | use function libxml_get_last_error;
 9 | use function libxml_use_internal_errors;
10 | use const LIBXML_ERR_FATAL;
11 | use const LIBXML_NOBLANKS;
12 | use const LIBXML_NONET;
13 | use const XML_DOCUMENT_TYPE_NODE;
14 | 
15 | class XmlLoader
16 | {
17 | 
18 |     private const LOAD_XML = 'xml';
19 |     private const LOAD_HTML = 'html';
20 | 
21 |     /**
22 |      * @throws XmlException When parsing fails
23 |      */
24 |     public function loadXml(string $xml): DOMDocument
25 |     {
26 |         $domDocument = $this->load($xml, self::LOAD_XML);
27 |         $this->checkDomDocumentChildren($domDocument);
28 |         return $domDocument;
29 |     }
30 | 
31 |     /**
32 |      * @throws XmlException When parsing fails
33 |      */
34 |     public function loadHtml(string $html): DOMDocument
35 |     {
36 |         return $this->load($html, self::LOAD_HTML);
37 |     }
38 | 
39 |     /**
40 |      * @throws XmlException
41 |      */
42 |     private function load(string $source, string $method): DOMDocument
43 |     {
44 |         if ($source === '') {
45 |             throw new XmlException($this->getCustomError('Empty string supplied as input'));
46 |         }
47 | 
48 |         $internalErrorsOld = libxml_use_internal_errors(true);
49 | 
50 |         $dom = new DOMDocument();
51 | 
52 |         if ($method === self::LOAD_XML) {
53 |             $success = $dom->loadXML($source, LIBXML_NONET | LIBXML_NOBLANKS);
54 |         } else {
55 |             $success = $dom->loadHTML($source, LIBXML_NONET | LIBXML_NOBLANKS);
56 |         }
57 | 
58 |         $error = libxml_get_last_error();
59 | 
60 |         libxml_clear_errors();
61 |         libxml_use_internal_errors($internalErrorsOld);
62 | 
63 |         if ($success === false) {
64 |             throw new XmlException($error !== false ? $error : $this->getCustomError('Unknown error'));
65 |         }
66 | 
67 |         return $dom;
68 |     }
69 | 
70 |     /**
71 |      * @see http://stackoverflow.com/a/10218526/1542616
72 |      * @throws XmlException
73 |      */
74 |     private function checkDomDocumentChildren(DOMDocument $dom): void
75 |     {
76 |         foreach ($dom->childNodes as $child) {
77 |             if ($child->nodeType === XML_DOCUMENT_TYPE_NODE) {
78 |                 throw new XmlException($this->getCustomError('Document types are not allowed'));
79 |             }
80 |         }
81 |     }
82 | 
83 |     private function getCustomError(string $message): LibXMLError
84 |     {
85 |         $err = new LibXMLError();
86 |         $err->level = LIBXML_ERR_FATAL;
87 |         $err->message = $message;
88 |         $err->code = 0;
89 |         $err->column = 0;
90 |         $err->line = 0;
91 |         $err->file = '';
92 |         return $err;
93 |     }
94 | 
95 | }
96 | 


--------------------------------------------------------------------------------
/tests/XmlLoaderTest.phpt:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Lightools\Tests;
  4 | 
  5 | use Lightools\Xml\XmlException;
  6 | use Lightools\Xml\XmlLoader;
  7 | use Tester\Assert;
  8 | use Tester\Environment;
  9 | use Tester\TestCase;
 10 | 
 11 | require __DIR__ . '/../vendor/autoload.php';
 12 | 
 13 | Environment::setup();
 14 | 
 15 | /**
 16 |  * @testCase
 17 |  */
 18 | class XmlLoaderTest extends TestCase {
 19 | 
 20 |     private const LIBXML_WITH_ENTITY_EXPANSION_PROTECTION = 21100; // https://github.com/GNOME/libxml2/commit/3f69fc805c9bea48f9339b1ce6c9db7a10f03f63#diff-e944513ca01df80ccaa2ddb8f845f0dee99c66e68cf56224c46de88a742fe7c3
 21 | 
 22 |     public function testBillionLaugh(): void {
 23 |         $source = trim('
 24 |         <?xml version="1.0"?>
 25 |         <!DOCTYPE lolz [
 26 |             <!ENTITY lol "lol">
 27 |             <!ENTITY lol1 "&lol;&lol;&lol;&lol;&lol;&lol;&lol;&lol;&lol;&lol;">
 28 |             <!ENTITY lol2 "&lol1;&lol1;&lol1;&lol1;&lol1;&lol1;&lol1;&lol1;&lol1;&lol1;">
 29 |             <!ENTITY lol3 "&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;&lol2;">
 30 |             <!ENTITY lol4 "&lol3;&lol3;&lol3;&lol3;&lol3;&lol3;&lol3;&lol3;&lol3;&lol3;">
 31 |             <!ENTITY lol5 "&lol4;&lol4;&lol4;&lol4;&lol4;&lol4;&lol4;&lol4;&lol4;&lol4;">
 32 |             <!ENTITY lol6 "&lol5;&lol5;&lol5;&lol5;&lol5;&lol5;&lol5;&lol5;&lol5;&lol5;">
 33 |             <!ENTITY lol7 "&lol6;&lol6;&lol6;&lol6;&lol6;&lol6;&lol6;&lol6;&lol6;&lol6;">
 34 |             <!ENTITY lol8 "&lol7;&lol7;&lol7;&lol7;&lol7;&lol7;&lol7;&lol7;&lol7;&lol7;">
 35 |             <!ENTITY lol9 "&lol8;&lol8;&lol8;&lol8;&lol8;&lol8;&lol8;&lol8;&lol8;&lol8;">
 36 |         ]>
 37 |         <lolz>&lol9;</lolz>
 38 |         ');
 39 | 
 40 |         if (LIBXML_VERSION >= self::LIBXML_WITH_ENTITY_EXPANSION_PROTECTION) {
 41 |             $error = 'XML Fatal Error #89: Maximum entity amplification factor exceeded on line 1 and column 25';
 42 |         } else {
 43 |             $error = 'XML Fatal Error #89: Detected an entity reference loop on line 14 and column 21';
 44 |         }
 45 | 
 46 |         Assert::exception(function () use ($source): void {
 47 |             $loader = new XmlLoader();
 48 |             $loader->loadXml($source);
 49 |         }, XmlException::class, $error);
 50 |     }
 51 | 
 52 |     public function testQuadraticBlowup(): void {
 53 |         $source = trim('
 54 |         <?xml version="1.0"?>
 55 |         <!DOCTYPE kaboom [
 56 |             <!ENTITY a "' . str_repeat('a', 100000) . '">
 57 |         ]>
 58 |         <kaboom>' . str_repeat('&a;', 100000) . '</kaboom>
 59 |         ');
 60 | 
 61 |         if (LIBXML_VERSION >= self::LIBXML_WITH_ENTITY_EXPANSION_PROTECTION) {
 62 |             $error = 'XML Fatal Error #89: Maximum entity amplification factor exceeded on line 5 and column 47';
 63 |         } else {
 64 |             $error = 'XML Fatal Error #0: Document types are not allowed on line 0 and column 0';
 65 |         }
 66 | 
 67 |         Assert::exception(function () use ($source): void {
 68 |             $loader = new XmlLoader();
 69 |             (string) $loader->loadXml($source);
 70 |         }, XmlException::class, $error);
 71 |     }
 72 | 
 73 |     public function testEmptySource(): void {
 74 |         Assert::exception(function () {
 75 |             $loader = new XmlLoader();
 76 |             $loader->loadXml('');
 77 |         }, XmlException::class, 'XML Fatal Error #0: Empty string supplied as input on line 0 and column 0');
 78 |     }
 79 | 
 80 |     public function testInvalidXml(): void {
 81 |         $source = trim('
 82 |         <?xml version="1.0"?>
 83 |         <invalid>
 84 |         ');
 85 | 
 86 |         if (LIBXML_VERSION < 20911) {
 87 |             $error = 'XML Fatal Error #74: EndTag: \'</\' not found on line 2 and column 18';
 88 |         } else {
 89 |             $error = 'XML Fatal Error #77: Premature end of data in tag invalid line 2 on line 2 and column 18';
 90 |         }
 91 | 
 92 |         Assert::exception(function () use ($source): void {
 93 |             $loader = new XmlLoader();
 94 |             $loader->loadXml($source);
 95 |         }, XmlException::class, $error);
 96 |     }
 97 | 
 98 |     public function testValidXml(): void {
 99 |         $source = trim('
100 |         <?xml version="1.0"?>
101 |         <note>
102 |             <to>John</to>
103 |             <from>Jack</from>
104 |             <heading>Reminder</heading>
105 |             <body>Don\'t forget me this weekend!</body>
106 |         </note>
107 |         ');
108 | 
109 |         $loader = new XmlLoader();
110 |         $xml = $loader->loadXml($source);
111 |         Assert::same('Jack', $xml->getElementsByTagName('from')->item(0)->nodeValue);
112 |     }
113 | 
114 |     public function testValidHtml(): void {
115 |         $source = trim('
116 |         <!doctype html>
117 |         <html lang=en>
118 |             <head>
119 |                 <meta charset=utf-8>
120 |                 <title>Foo</title>
121 |             </head>
122 |             <body>
123 |                 <p>I\'m the content</p>
124 |             </body>
125 |         </html>
126 |         ');
127 | 
128 |         $loader = new XmlLoader();
129 |         $xml = $loader->loadHtml($source);
130 |         Assert::same('Foo', $xml->getElementsByTagName('title')->item(0)->nodeValue);
131 |     }
132 | 
133 | }
134 | 
135 | (new XmlLoaderTest)->run();
136 | 


--------------------------------------------------------------------------------
/composer.lock:
--------------------------------------------------------------------------------
  1 | {
  2 |     "_readme": [
  3 |         "This file locks the dependencies of your project to a known state",
  4 |         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
  5 |         "This file is @generated automatically"
  6 |     ],
  7 |     "content-hash": "1a952dfc986e01ff06fafcd6bb1a2c47",
  8 |     "packages": [],
  9 |     "packages-dev": [
 10 |         {
 11 |             "name": "dealerdirect/phpcodesniffer-composer-installer",
 12 |             "version": "v1.0.0",
 13 |             "source": {
 14 |                 "type": "git",
 15 |                 "url": "https://github.com/PHPCSStandards/composer-installer.git",
 16 |                 "reference": "4be43904336affa5c2f70744a348312336afd0da"
 17 |             },
 18 |             "dist": {
 19 |                 "type": "zip",
 20 |                 "url": "https://api.github.com/repos/PHPCSStandards/composer-installer/zipball/4be43904336affa5c2f70744a348312336afd0da",
 21 |                 "reference": "4be43904336affa5c2f70744a348312336afd0da",
 22 |                 "shasum": ""
 23 |             },
 24 |             "require": {
 25 |                 "composer-plugin-api": "^1.0 || ^2.0",
 26 |                 "php": ">=5.4",
 27 |                 "squizlabs/php_codesniffer": "^2.0 || ^3.1.0 || ^4.0"
 28 |             },
 29 |             "require-dev": {
 30 |                 "composer/composer": "*",
 31 |                 "ext-json": "*",
 32 |                 "ext-zip": "*",
 33 |                 "php-parallel-lint/php-parallel-lint": "^1.3.1",
 34 |                 "phpcompatibility/php-compatibility": "^9.0",
 35 |                 "yoast/phpunit-polyfills": "^1.0"
 36 |             },
 37 |             "type": "composer-plugin",
 38 |             "extra": {
 39 |                 "class": "PHPCSStandards\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\Plugin"
 40 |             },
 41 |             "autoload": {
 42 |                 "psr-4": {
 43 |                     "PHPCSStandards\\Composer\\Plugin\\Installers\\PHPCodeSniffer\\": "src/"
 44 |                 }
 45 |             },
 46 |             "notification-url": "https://packagist.org/downloads/",
 47 |             "license": [
 48 |                 "MIT"
 49 |             ],
 50 |             "authors": [
 51 |                 {
 52 |                     "name": "Franck Nijhof",
 53 |                     "email": "franck.nijhof@dealerdirect.com",
 54 |                     "homepage": "http://www.frenck.nl",
 55 |                     "role": "Developer / IT Manager"
 56 |                 },
 57 |                 {
 58 |                     "name": "Contributors",
 59 |                     "homepage": "https://github.com/PHPCSStandards/composer-installer/graphs/contributors"
 60 |                 }
 61 |             ],
 62 |             "description": "PHP_CodeSniffer Standards Composer Installer Plugin",
 63 |             "homepage": "http://www.dealerdirect.com",
 64 |             "keywords": [
 65 |                 "PHPCodeSniffer",
 66 |                 "PHP_CodeSniffer",
 67 |                 "code quality",
 68 |                 "codesniffer",
 69 |                 "composer",
 70 |                 "installer",
 71 |                 "phpcbf",
 72 |                 "phpcs",
 73 |                 "plugin",
 74 |                 "qa",
 75 |                 "quality",
 76 |                 "standard",
 77 |                 "standards",
 78 |                 "style guide",
 79 |                 "stylecheck",
 80 |                 "tests"
 81 |             ],
 82 |             "support": {
 83 |                 "issues": "https://github.com/PHPCSStandards/composer-installer/issues",
 84 |                 "source": "https://github.com/PHPCSStandards/composer-installer"
 85 |             },
 86 |             "time": "2023-01-05T11:28:13+00:00"
 87 |         },
 88 |         {
 89 |             "name": "editorconfig-checker/editorconfig-checker",
 90 |             "version": "10.7.0",
 91 |             "source": {
 92 |                 "type": "git",
 93 |                 "url": "https://github.com/editorconfig-checker/editorconfig-checker.php.git",
 94 |                 "reference": "eb2581bee39d10e776e69048a88fb10a76a0cc9f"
 95 |             },
 96 |             "dist": {
 97 |                 "type": "zip",
 98 |                 "url": "https://api.github.com/repos/editorconfig-checker/editorconfig-checker.php/zipball/eb2581bee39d10e776e69048a88fb10a76a0cc9f",
 99 |                 "reference": "eb2581bee39d10e776e69048a88fb10a76a0cc9f",
100 |                 "shasum": ""
101 |             },
102 |             "require": {
103 |                 "php": "^7.2 || ^8.0"
104 |             },
105 |             "require-dev": {
106 |                 "php-coveralls/php-coveralls": "^2.1",
107 |                 "phpstan/phpstan": "^1.4",
108 |                 "phpunit/phpunit": "^8.5.23",
109 |                 "squizlabs/php_codesniffer": "^3.6"
110 |             },
111 |             "bin": [
112 |                 "bin/editorconfig-checker",
113 |                 "bin/ec"
114 |             ],
115 |             "type": "library",
116 |             "autoload": {
117 |                 "psr-4": {
118 |                     "EditorconfigChecker\\": "src/EditorconfigChecker"
119 |                 }
120 |             },
121 |             "notification-url": "https://packagist.org/downloads/",
122 |             "license": [
123 |                 "MIT"
124 |             ],
125 |             "authors": [
126 |                 {
127 |                     "name": "Max Strübing",
128 |                     "email": "mxstrbng@gmail.com",
129 |                     "homepage": "https://github.com/mstruebing",
130 |                     "role": "Maintainer"
131 |                 }
132 |             ],
133 |             "description": "A tool to verify that your files follow the rules of your .editorconfig",
134 |             "support": {
135 |                 "issues": "https://github.com/editorconfig-checker/editorconfig-checker.php/issues",
136 |                 "source": "https://github.com/editorconfig-checker/editorconfig-checker.php"
137 |             },
138 |             "time": "2025-03-17T14:59:08+00:00"
139 |         },
140 |         {
141 |             "name": "nette/tester",
142 |             "version": "v2.5.4",
143 |             "source": {
144 |                 "type": "git",
145 |                 "url": "https://github.com/nette/tester.git",
146 |                 "reference": "c11863785779e87b40adebf150364f2e5938c111"
147 |             },
148 |             "dist": {
149 |                 "type": "zip",
150 |                 "url": "https://api.github.com/repos/nette/tester/zipball/c11863785779e87b40adebf150364f2e5938c111",
151 |                 "reference": "c11863785779e87b40adebf150364f2e5938c111",
152 |                 "shasum": ""
153 |             },
154 |             "require": {
155 |                 "php": "8.0 - 8.4"
156 |             },
157 |             "require-dev": {
158 |                 "ext-simplexml": "*",
159 |                 "phpstan/phpstan": "^1.0"
160 |             },
161 |             "bin": [
162 |                 "src/tester"
163 |             ],
164 |             "type": "library",
165 |             "extra": {
166 |                 "branch-alias": {
167 |                     "dev-master": "2.5-dev"
168 |                 }
169 |             },
170 |             "autoload": {
171 |                 "classmap": [
172 |                     "src/"
173 |                 ]
174 |             },
175 |             "notification-url": "https://packagist.org/downloads/",
176 |             "license": [
177 |                 "BSD-3-Clause",
178 |                 "GPL-2.0-only",
179 |                 "GPL-3.0-only"
180 |             ],
181 |             "authors": [
182 |                 {
183 |                     "name": "David Grudl",
184 |                     "homepage": "https://davidgrudl.com"
185 |                 },
186 |                 {
187 |                     "name": "Miloslav Hůla",
188 |                     "homepage": "https://github.com/milo"
189 |                 },
190 |                 {
191 |                     "name": "Nette Community",
192 |                     "homepage": "https://nette.org/contributors"
193 |                 }
194 |             ],
195 |             "description": "Nette Tester: enjoyable unit testing in PHP with code coverage reporter. 🍏🍏🍎🍏",
196 |             "homepage": "https://tester.nette.org",
197 |             "keywords": [
198 |                 "Xdebug",
199 |                 "assertions",
200 |                 "clover",
201 |                 "code coverage",
202 |                 "nette",
203 |                 "pcov",
204 |                 "phpdbg",
205 |                 "phpunit",
206 |                 "testing",
207 |                 "unit"
208 |             ],
209 |             "support": {
210 |                 "issues": "https://github.com/nette/tester/issues",
211 |                 "source": "https://github.com/nette/tester/tree/v2.5.4"
212 |             },
213 |             "time": "2024-10-23T23:57:10+00:00"
214 |         },
215 |         {
216 |             "name": "phpstan/phpdoc-parser",
217 |             "version": "2.1.0",
218 |             "source": {
219 |                 "type": "git",
220 |                 "url": "https://github.com/phpstan/phpdoc-parser.git",
221 |                 "reference": "9b30d6fd026b2c132b3985ce6b23bec09ab3aa68"
222 |             },
223 |             "dist": {
224 |                 "type": "zip",
225 |                 "url": "https://api.github.com/repos/phpstan/phpdoc-parser/zipball/9b30d6fd026b2c132b3985ce6b23bec09ab3aa68",
226 |                 "reference": "9b30d6fd026b2c132b3985ce6b23bec09ab3aa68",
227 |                 "shasum": ""
228 |             },
229 |             "require": {
230 |                 "php": "^7.4 || ^8.0"
231 |             },
232 |             "require-dev": {
233 |                 "doctrine/annotations": "^2.0",
234 |                 "nikic/php-parser": "^5.3.0",
235 |                 "php-parallel-lint/php-parallel-lint": "^1.2",
236 |                 "phpstan/extension-installer": "^1.0",
237 |                 "phpstan/phpstan": "^2.0",
238 |                 "phpstan/phpstan-phpunit": "^2.0",
239 |                 "phpstan/phpstan-strict-rules": "^2.0",
240 |                 "phpunit/phpunit": "^9.6",
241 |                 "symfony/process": "^5.2"
242 |             },
243 |             "type": "library",
244 |             "autoload": {
245 |                 "psr-4": {
246 |                     "PHPStan\\PhpDocParser\\": [
247 |                         "src/"
248 |                     ]
249 |                 }
250 |             },
251 |             "notification-url": "https://packagist.org/downloads/",
252 |             "license": [
253 |                 "MIT"
254 |             ],
255 |             "description": "PHPDoc parser with support for nullable, intersection and generic types",
256 |             "support": {
257 |                 "issues": "https://github.com/phpstan/phpdoc-parser/issues",
258 |                 "source": "https://github.com/phpstan/phpdoc-parser/tree/2.1.0"
259 |             },
260 |             "time": "2025-02-19T13:28:12+00:00"
261 |         },
262 |         {
263 |             "name": "phpstan/phpstan",
264 |             "version": "1.12.7",
265 |             "source": {
266 |                 "type": "git",
267 |                 "url": "https://github.com/phpstan/phpstan.git",
268 |                 "reference": "dc2b9976bd8b0f84ec9b0e50cc35378551de7af0"
269 |             },
270 |             "dist": {
271 |                 "type": "zip",
272 |                 "url": "https://api.github.com/repos/phpstan/phpstan/zipball/dc2b9976bd8b0f84ec9b0e50cc35378551de7af0",
273 |                 "reference": "dc2b9976bd8b0f84ec9b0e50cc35378551de7af0",
274 |                 "shasum": ""
275 |             },
276 |             "require": {
277 |                 "php": "^7.2|^8.0"
278 |             },
279 |             "conflict": {
280 |                 "phpstan/phpstan-shim": "*"
281 |             },
282 |             "bin": [
283 |                 "phpstan",
284 |                 "phpstan.phar"
285 |             ],
286 |             "type": "library",
287 |             "autoload": {
288 |                 "files": [
289 |                     "bootstrap.php"
290 |                 ]
291 |             },
292 |             "notification-url": "https://packagist.org/downloads/",
293 |             "license": [
294 |                 "MIT"
295 |             ],
296 |             "description": "PHPStan - PHP Static Analysis Tool",
297 |             "keywords": [
298 |                 "dev",
299 |                 "static analysis"
300 |             ],
301 |             "support": {
302 |                 "docs": "https://phpstan.org/user-guide/getting-started",
303 |                 "forum": "https://github.com/phpstan/phpstan/discussions",
304 |                 "issues": "https://github.com/phpstan/phpstan/issues",
305 |                 "security": "https://github.com/phpstan/phpstan/security/policy",
306 |                 "source": "https://github.com/phpstan/phpstan-src"
307 |             },
308 |             "funding": [
309 |                 {
310 |                     "url": "https://github.com/ondrejmirtes",
311 |                     "type": "github"
312 |                 },
313 |                 {
314 |                     "url": "https://github.com/phpstan",
315 |                     "type": "github"
316 |                 }
317 |             ],
318 |             "time": "2024-10-18T11:12:07+00:00"
319 |         },
320 |         {
321 |             "name": "phpstan/phpstan-strict-rules",
322 |             "version": "1.6.1",
323 |             "source": {
324 |                 "type": "git",
325 |                 "url": "https://github.com/phpstan/phpstan-strict-rules.git",
326 |                 "reference": "daeec748b53de80a97498462513066834ec28f8b"
327 |             },
328 |             "dist": {
329 |                 "type": "zip",
330 |                 "url": "https://api.github.com/repos/phpstan/phpstan-strict-rules/zipball/daeec748b53de80a97498462513066834ec28f8b",
331 |                 "reference": "daeec748b53de80a97498462513066834ec28f8b",
332 |                 "shasum": ""
333 |             },
334 |             "require": {
335 |                 "php": "^7.2 || ^8.0",
336 |                 "phpstan/phpstan": "^1.12.4"
337 |             },
338 |             "require-dev": {
339 |                 "nikic/php-parser": "^4.13.0",
340 |                 "php-parallel-lint/php-parallel-lint": "^1.2",
341 |                 "phpstan/phpstan-deprecation-rules": "^1.1",
342 |                 "phpstan/phpstan-phpunit": "^1.0",
343 |                 "phpunit/phpunit": "^9.5"
344 |             },
345 |             "type": "phpstan-extension",
346 |             "extra": {
347 |                 "phpstan": {
348 |                     "includes": [
349 |                         "rules.neon"
350 |                     ]
351 |                 }
352 |             },
353 |             "autoload": {
354 |                 "psr-4": {
355 |                     "PHPStan\\": "src/"
356 |                 }
357 |             },
358 |             "notification-url": "https://packagist.org/downloads/",
359 |             "license": [
360 |                 "MIT"
361 |             ],
362 |             "description": "Extra strict and opinionated rules for PHPStan",
363 |             "support": {
364 |                 "issues": "https://github.com/phpstan/phpstan-strict-rules/issues",
365 |                 "source": "https://github.com/phpstan/phpstan-strict-rules/tree/1.6.1"
366 |             },
367 |             "time": "2024-09-20T14:04:44+00:00"
368 |         },
369 |         {
370 |             "name": "slevomat/coding-standard",
371 |             "version": "8.18.1",
372 |             "source": {
373 |                 "type": "git",
374 |                 "url": "https://github.com/slevomat/coding-standard.git",
375 |                 "reference": "06b18b3f64979ab31d27c37021838439f3ed5919"
376 |             },
377 |             "dist": {
378 |                 "type": "zip",
379 |                 "url": "https://api.github.com/repos/slevomat/coding-standard/zipball/06b18b3f64979ab31d27c37021838439f3ed5919",
380 |                 "reference": "06b18b3f64979ab31d27c37021838439f3ed5919",
381 |                 "shasum": ""
382 |             },
383 |             "require": {
384 |                 "dealerdirect/phpcodesniffer-composer-installer": "^0.6.2 || ^0.7 || ^1.0",
385 |                 "php": "^7.4 || ^8.0",
386 |                 "phpstan/phpdoc-parser": "^2.1.0",
387 |                 "squizlabs/php_codesniffer": "^3.13.0"
388 |             },
389 |             "require-dev": {
390 |                 "phing/phing": "3.0.1",
391 |                 "php-parallel-lint/php-parallel-lint": "1.4.0",
392 |                 "phpstan/phpstan": "2.1.17",
393 |                 "phpstan/phpstan-deprecation-rules": "2.0.3",
394 |                 "phpstan/phpstan-phpunit": "2.0.6",
395 |                 "phpstan/phpstan-strict-rules": "2.0.4",
396 |                 "phpunit/phpunit": "9.6.8|10.5.45|11.4.4|11.5.21|12.1.3"
397 |             },
398 |             "type": "phpcodesniffer-standard",
399 |             "extra": {
400 |                 "branch-alias": {
401 |                     "dev-master": "8.x-dev"
402 |                 }
403 |             },
404 |             "autoload": {
405 |                 "psr-4": {
406 |                     "SlevomatCodingStandard\\": "SlevomatCodingStandard/"
407 |                 }
408 |             },
409 |             "notification-url": "https://packagist.org/downloads/",
410 |             "license": [
411 |                 "MIT"
412 |             ],
413 |             "description": "Slevomat Coding Standard for PHP_CodeSniffer complements Consistence Coding Standard by providing sniffs with additional checks.",
414 |             "keywords": [
415 |                 "dev",
416 |                 "phpcs"
417 |             ],
418 |             "support": {
419 |                 "issues": "https://github.com/slevomat/coding-standard/issues",
420 |                 "source": "https://github.com/slevomat/coding-standard/tree/8.18.1"
421 |             },
422 |             "funding": [
423 |                 {
424 |                     "url": "https://github.com/kukulich",
425 |                     "type": "github"
426 |                 },
427 |                 {
428 |                     "url": "https://tidelift.com/funding/github/packagist/slevomat/coding-standard",
429 |                     "type": "tidelift"
430 |                 }
431 |             ],
432 |             "time": "2025-05-22T14:32:30+00:00"
433 |         },
434 |         {
435 |             "name": "squizlabs/php_codesniffer",
436 |             "version": "3.13.0",
437 |             "source": {
438 |                 "type": "git",
439 |                 "url": "https://github.com/PHPCSStandards/PHP_CodeSniffer.git",
440 |                 "reference": "65ff2489553b83b4597e89c3b8b721487011d186"
441 |             },
442 |             "dist": {
443 |                 "type": "zip",
444 |                 "url": "https://api.github.com/repos/PHPCSStandards/PHP_CodeSniffer/zipball/65ff2489553b83b4597e89c3b8b721487011d186",
445 |                 "reference": "65ff2489553b83b4597e89c3b8b721487011d186",
446 |                 "shasum": ""
447 |             },
448 |             "require": {
449 |                 "ext-simplexml": "*",
450 |                 "ext-tokenizer": "*",
451 |                 "ext-xmlwriter": "*",
452 |                 "php": ">=5.4.0"
453 |             },
454 |             "require-dev": {
455 |                 "phpunit/phpunit": "^4.0 || ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.3.4"
456 |             },
457 |             "bin": [
458 |                 "bin/phpcbf",
459 |                 "bin/phpcs"
460 |             ],
461 |             "type": "library",
462 |             "extra": {
463 |                 "branch-alias": {
464 |                     "dev-master": "3.x-dev"
465 |                 }
466 |             },
467 |             "notification-url": "https://packagist.org/downloads/",
468 |             "license": [
469 |                 "BSD-3-Clause"
470 |             ],
471 |             "authors": [
472 |                 {
473 |                     "name": "Greg Sherwood",
474 |                     "role": "Former lead"
475 |                 },
476 |                 {
477 |                     "name": "Juliette Reinders Folmer",
478 |                     "role": "Current lead"
479 |                 },
480 |                 {
481 |                     "name": "Contributors",
482 |                     "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer/graphs/contributors"
483 |                 }
484 |             ],
485 |             "description": "PHP_CodeSniffer tokenizes PHP, JavaScript and CSS files and detects violations of a defined set of coding standards.",
486 |             "homepage": "https://github.com/PHPCSStandards/PHP_CodeSniffer",
487 |             "keywords": [
488 |                 "phpcs",
489 |                 "standards",
490 |                 "static analysis"
491 |             ],
492 |             "support": {
493 |                 "issues": "https://github.com/PHPCSStandards/PHP_CodeSniffer/issues",
494 |                 "security": "https://github.com/PHPCSStandards/PHP_CodeSniffer/security/policy",
495 |                 "source": "https://github.com/PHPCSStandards/PHP_CodeSniffer",
496 |                 "wiki": "https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki"
497 |             },
498 |             "funding": [
499 |                 {
500 |                     "url": "https://github.com/PHPCSStandards",
501 |                     "type": "github"
502 |                 },
503 |                 {
504 |                     "url": "https://github.com/jrfnl",
505 |                     "type": "github"
506 |                 },
507 |                 {
508 |                     "url": "https://opencollective.com/php_codesniffer",
509 |                     "type": "open_collective"
510 |                 },
511 |                 {
512 |                     "url": "https://thanks.dev/u/gh/phpcsstandards",
513 |                     "type": "thanks_dev"
514 |                 }
515 |             ],
516 |             "time": "2025-05-11T03:36:00+00:00"
517 |         }
518 |     ],
519 |     "aliases": [],
520 |     "minimum-stability": "stable",
521 |     "stability-flags": [],
522 |     "prefer-stable": false,
523 |     "prefer-lowest": false,
524 |     "platform": {
525 |         "php": ">=8.0",
526 |         "ext-dom": "*",
527 |         "ext-libxml": "*"
528 |     },
529 |     "platform-dev": [],
530 |     "plugin-api-version": "2.3.0"
531 | }
532 | 


--------------------------------------------------------------------------------
/phpcs.xml.dist:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <ruleset
  3 |     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4 |     xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
  5 |     name="Coding Standard"
  6 | >
  7 |     <arg name="basepath" value="."/>
  8 |     <arg name="extensions" value="php"/>
  9 |     <arg name="parallel" value="80"/>
 10 |     <arg name="report-width" value="auto"/>
 11 |     <arg name="tab-width" value="4"/>
 12 |     <arg name="encoding" value="utf-8"/>
 13 |     <arg name="cache" value="cache/phpcs.cache"/>
 14 |     <arg name="colors"/>
 15 |     <arg value="p"/>
 16 |     <arg value="s"/>
 17 | 
 18 |     <file>src/</file>
 19 |     <file>tests/</file>
 20 | 
 21 |     <config name="installed_paths" value="../../slevomat/coding-standard"/>
 22 | 
 23 |     <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
 24 |     <rule ref="Generic.Classes.DuplicateClassName"/>
 25 |     <rule ref="Generic.CodeAnalysis.EmptyStatement">
 26 |         <exclude name="Generic.CodeAnalysis.EmptyStatement.DetectedCatch"/><!-- empty catch statements are allowed when commented -->
 27 |     </rule>
 28 |     <rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop"/>
 29 |     <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/>
 30 |     <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
 31 |     <rule ref="Generic.Commenting.Todo" />
 32 |     <rule ref="Generic.Files.ByteOrderMark"/>
 33 |     <rule ref="Generic.Files.EndFileNewline"/>
 34 |     <rule ref="Generic.Files.InlineHTML"/>
 35 |     <rule ref="Generic.Files.LineEndings"/>
 36 |     <rule ref="Generic.Files.OneClassPerFile"/>
 37 |     <rule ref="Generic.Files.OneInterfacePerFile"/>
 38 |     <rule ref="Generic.Files.OneTraitPerFile"/>
 39 |     <rule ref="Generic.Formatting.SpaceAfterNot">
 40 |         <properties>
 41 |             <property name="spacing" value="0"/>
 42 |         </properties>
 43 |     </rule>
 44 |     <rule ref="Generic.Formatting.SpaceAfterCast"/>
 45 |     <rule ref="Generic.Formatting.MultipleStatementAlignment">
 46 |         <properties>
 47 |             <property name="maxPadding" value="1"/>
 48 |         </properties>
 49 |     </rule>
 50 |     <rule ref="Generic.Functions.CallTimePassByReference"/>
 51 |     <rule ref="Generic.Functions.OpeningFunctionBraceBsdAllman"/>
 52 |     <rule ref="Generic.NamingConventions.ConstructorName"/>
 53 |     <rule ref="Generic.PHP.BacktickOperator"/>
 54 |     <rule ref="Generic.PHP.DiscourageGoto"/>
 55 |     <rule ref="Generic.PHP.LowerCaseKeyword"/>
 56 |     <rule ref="Generic.PHP.LowerCaseType"/>
 57 |     <rule ref="Generic.PHP.CharacterBeforePHPOpeningTag"/>
 58 |     <rule ref="Generic.PHP.DeprecatedFunctions"/>
 59 |     <rule ref="Generic.PHP.DisallowAlternativePHPTags"/>
 60 |     <rule ref="Generic.PHP.DisallowShortOpenTag"/>
 61 |     <rule ref="Generic.PHP.ForbiddenFunctions">
 62 |         <properties>
 63 |             <property
 64 |                 name="forbiddenFunctions"
 65 |                 type="array"
 66 |                 value="
 67 |                     mt_rand=>rand,
 68 |                     sizeof=>count,
 69 |                     delete=>unset,
 70 |                     print=>echo,
 71 |                     join=>implode,
 72 |                     split=>explode,
 73 |                     is_null=>null,
 74 |                     create_function=>null,
 75 |                     key_exists=>array_key_exists,
 76 |                     floatval=>null,
 77 |                     boolval=>null,
 78 |                     intval=>null,
 79 |                     strval=>null,
 80 |                     settype=>null,
 81 |                     exit=>null,
 82 |                     reset=>array_key_first
 83 |                 "
 84 |             />
 85 |         </properties>
 86 |     </rule>
 87 |     <rule ref="Generic.Strings.UnnecessaryStringConcat">
 88 |         <properties>
 89 |             <property name="allowMultiline" value="true"/>
 90 |         </properties>
 91 |     </rule>
 92 |     <rule ref="Generic.VersionControl.GitMergeConflict"/>
 93 |     <rule ref="Generic.WhiteSpace.IncrementDecrementSpacing"/>
 94 |     <rule ref="Generic.WhiteSpace.ScopeIndent">
 95 |         <properties>
 96 |             <property name="tabIndent" value="false"/>
 97 |         </properties>
 98 |     </rule>
 99 |     <rule ref="PEAR.Classes.ClassDeclaration"/>
100 |     <rule ref="PEAR.Commenting.InlineComment"/>
101 |     <rule ref="PEAR.Formatting.MultiLineAssignment"/>
102 |     <rule ref="PEAR.WhiteSpace.ObjectOperatorIndent"/>
103 |     <rule ref="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
104 |     <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps"/>
105 |     <rule ref="PSR2">
106 |         <exclude name="Generic.Files.LineLength"/><!-- can not be suppressed -->
107 |         <exclude name="Generic.WhiteSpace.DisallowTabIndent"/><!-- don't check indentation with spaces -->
108 |         <exclude name="PEAR.Functions.ValidDefaultValue"/><!-- we want to allow null as "default" value -->
109 |         <exclude name="PSR2.Classes.ClassDeclaration"/><!-- we want whitespace around class body and rules for extends and implements, using PEAR instead -->
110 |         <exclude name="PSR2.ControlStructures.ControlStructureSpacing.SpacingAfterOpenBrace"/><!-- we want to put first expression of multiline condition on next line -->
111 |         <exclude name="PSR2.ControlStructures.SwitchDeclaration.caseIndent"/><!-- checked by more generic Generic.WhiteSpace.ScopeIndent.Incorrect -->
112 |         <exclude name="PSR2.ControlStructures.SwitchDeclaration.defaultIndent"/><!-- checked by more generic Generic.WhiteSpace.ScopeIndent.Incorrect -->
113 |         <exclude name="Squiz.Functions.LowercaseFunctionKeywords"/><!-- checked by more generic Generic.PHP.LowerCaseKeyword -->
114 |         <exclude name="Squiz.ControlStructures.LowercaseDeclaration"/><!-- checked by more generic Generic.PHP.LowerCaseKeyword -->
115 |         <exclude name="Squiz.Functions.MultiLineFunctionDeclaration.NewlineBeforeOpenBrace"/><!-- clashes with OpeningFunctionBraceBsdAllman -->
116 |         <exclude name="Squiz.WhiteSpace.ControlStructureSpacing.SpacingAfterOpenBrace"/><!-- we want to put first expression of multiline condition on next line -->
117 |         <exclude name="Squiz.WhiteSpace.ControlStructureSpacing.SpacingBeforeClose"/><!-- we want to allow empty line in control structure e.g. in try blocks, where it can improve readability -->
118 |     </rule>
119 |     <rule ref="PSR12.Classes.ClassInstantiation"/>
120 |     <rule ref="PSR12.Functions.NullableTypeDeclaration"/>
121 |     <rule ref="PSR12.Keywords.ShortFormTypeKeywords"/>
122 |     <rule ref="PSR12.Operators.OperatorSpacing"/>
123 |     <rule ref="Squiz.Arrays.ArrayBracketSpacing"/>
124 |     <rule ref="Squiz.Arrays.ArrayDeclaration">
125 |         <exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNewLine"/><!-- does not handle wrapped content -->
126 |         <exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned"/><!-- expects closing brace at the same level as opening brace -->
127 |         <exclude name="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned"/><!-- we don't want spacing with alignment -->
128 |         <exclude name="Squiz.Arrays.ArrayDeclaration.FirstIndexNoNewline"/><!-- expects multi-value array always written on multiple lines -->
129 |         <exclude name="Squiz.Arrays.ArrayDeclaration.FirstValueNoNewline"/><!-- expects multi-value array always written on multiple lines -->
130 |         <exclude name="Squiz.Arrays.ArrayDeclaration.IndexNoNewline"/><!-- false positives in 3.5.5: https://github.com/squizlabs/PHP_CodeSniffer/issues/2937 -->
131 |         <exclude name="Squiz.Arrays.ArrayDeclaration.KeyNotAligned"/><!-- uses indentation of only single space -->
132 |         <exclude name="Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed"/><!-- even a single-value array can be written on multiple lines -->
133 |         <exclude name="Squiz.Arrays.ArrayDeclaration.NoCommaAfterLast"/><!-- expects multi-value array always written on multiple lines -->
134 |         <exclude name="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed"/><!-- multiple values can be written on a single line -->
135 |         <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNoNewline"/><!-- false positives in 3.5.5: https://github.com/squizlabs/PHP_CodeSniffer/issues/2937 -->
136 |         <exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned"/><!-- we don't want spacing with alignment -->
137 |     </rule>
138 |     <rule ref="Squiz.ControlStructures.InlineIfDeclaration">
139 |         <exclude name="Squiz.ControlStructures.InlineIfDeclaration.ElvisSpacing"/>
140 |         <exclude name="Squiz.ControlStructures.InlineIfDeclaration.NoBrackets"/>
141 |         <exclude name="Squiz.ControlStructures.InlineIfDeclaration.NotSingleLine"/>
142 |     </rule>
143 |     <rule ref="Squiz.Classes.ClassFileName"/>
144 |     <rule ref="Squiz.Classes.SelfMemberReference"/>
145 |     <rule ref="Squiz.Commenting.DocCommentAlignment">
146 |         <exclude name="Squiz.Commenting.DocCommentAlignment.SpaceAfterStar"/><!-- space needed for indented annotations -->
147 |     </rule>
148 |     <rule ref="Squiz.Commenting.EmptyCatchComment"/>
149 |     <rule ref="Squiz.Commenting.FunctionComment">
150 |         <exclude name="Squiz.Commenting.FunctionComment.MissingParamTag"/> <!-- we use params only when typehint is not possible -->
151 |         <exclude name="Squiz.Commenting.FunctionComment.ParamNameNoMatch"/> <!-- we use params only when typehint is not possible -->
152 |         <exclude name="Squiz.Commenting.FunctionComment.InvalidTypeHint"/> <!-- we use params only when typehint is not possible -->
153 |         <exclude name="Squiz.Commenting.FunctionComment.EmptyThrows"/> <!-- comment is not needed for throws phpdoc -->
154 |         <exclude name="Squiz.Commenting.FunctionComment.IncorrectParamVarName"/><!-- requires long boolean and integer parameters -->
155 |         <exclude name="Squiz.Commenting.FunctionComment.IncorrectTypeHint"/><!-- collection syntax such as string[] is not supported -->
156 |         <exclude name="Squiz.Commenting.FunctionComment.InvalidReturn"/><!-- enforces incorrect types -->
157 |         <exclude name="Squiz.Commenting.FunctionComment.InvalidReturnNotVoid"/><!-- is not able to detect return types such as string|null as correct -->
158 |         <exclude name="Squiz.Commenting.FunctionComment.Missing"/><!-- PHPDoc is not required on all methods -->
159 |         <exclude name="Squiz.Commenting.FunctionComment.MissingParamComment"/><!-- comments are not required for @param -->
160 |         <exclude name="Squiz.Commenting.FunctionComment.MissingReturn"/><!-- void type is not used -->
161 |         <exclude name="Squiz.Commenting.FunctionComment.ParamCommentFullStop"/><!-- comments don't have to be sentences -->
162 |         <exclude name="Squiz.Commenting.FunctionComment.ParamCommentNotCapital"/><!-- comments don't have to be sentences -->
163 |         <exclude name="Squiz.Commenting.FunctionComment.ScalarTypeHintMissing"/><!-- problematic when extending non-PHP7 classes -->
164 |         <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamName"/><!-- we don't want spacing with alignment -->
165 |         <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType"/><!-- we don't want spacing with alignment -->
166 |         <exclude name="Squiz.Commenting.FunctionComment.ThrowsNoFullStop"/><!-- comments don't have to be sentences -->
167 |         <exclude name="Squiz.Commenting.FunctionComment.ThrowsNotCapital"/><!-- comments don't have to be sentences -->
168 |         <exclude name="Squiz.Commenting.FunctionComment.TypeHintMissing"/><!-- doesn't work with self as typehint -->
169 |         <exclude name="Squiz.Commenting.FunctionComment.InvalidNoReturn"/><!-- doesn't work with exceptions (i.e. NotImplementedException) -->
170 |     </rule>
171 |     <rule ref="Squiz.Commenting.FunctionComment.InvalidThrows">
172 |         <message>Exception type missing for @throws annotation</message>
173 |     </rule>
174 |     <rule ref="Squiz.Commenting.FunctionComment.DuplicateReturn">
175 |         <message>Only 1 @return annotation is allowed in a function comment</message>
176 |     </rule>
177 |     <rule ref="Squiz.Commenting.FunctionComment.ExtraParamComment">
178 |         <message>Extra @param annotation</message>
179 |     </rule>
180 |     <rule ref="Squiz.Commenting.FunctionComment.MissingParamTag">
181 |         <message>@param annotation for parameter "%s" missing</message>
182 |     </rule>
183 |     <rule ref="Squiz.Commenting.InlineComment">
184 |         <exclude name="Squiz.Commenting.InlineComment.NotCapital"/> <!-- no need to write full sentence -->
185 |         <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar"/> <!-- no need to write full sentence -->
186 |         <exclude name="Squiz.Commenting.InlineComment.DocBlock"/> <!-- needed for inline phpdoc -->
187 |     </rule>
188 |     <rule ref="Squiz.Functions.GlobalFunction"/>
189 |     <rule ref="Squiz.Functions.FunctionDeclarationArgumentSpacing">
190 |         <properties>
191 |             <property name="equalsSpacing" value="1"/>
192 |         </properties>
193 |     </rule>
194 |     <rule ref="Squiz.Operators.IncrementDecrementUsage">
195 |         <exclude name="Squiz.Operators.IncrementDecrementUsage.NoBrackets"/><!-- there is no need for brackets -->
196 |     </rule>
197 |     <rule ref="Squiz.Operators.ValidLogicalOperators"/>
198 |     <rule ref="Squiz.PHP.CommentedOutCode"/>
199 |     <rule ref="Squiz.PHP.GlobalKeyword"/>
200 |     <rule ref="Squiz.PHP.Heredoc"/>
201 |     <rule ref="Squiz.PHP.InnerFunctions"/>
202 |     <rule ref="Squiz.PHP.LowercasePHPFunctions"/>
203 |     <rule ref="Squiz.PHP.NonExecutableCode"/>
204 |     <rule ref="Squiz.Scope.StaticThisUsage"/>
205 |     <rule ref="Squiz.Scope.MethodScope"/>
206 |     <rule ref="Squiz.Strings.ConcatenationSpacing">
207 |         <properties>
208 |             <property name="ignoreNewlines" value="true"/>
209 |             <property name="spacing" value="1"/>
210 |         </properties>
211 |     </rule>
212 |     <rule ref="Squiz.Strings.DoubleQuoteUsage">
213 |         <exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
214 |     </rule>
215 |     <rule ref="Squiz.Strings.EchoedStrings"/>
216 |     <rule ref="Squiz.WhiteSpace.CastSpacing"/>
217 |     <rule ref="Squiz.WhiteSpace.FunctionOpeningBraceSpace"/>
218 |     <rule ref="Squiz.WhiteSpace.FunctionSpacing">
219 |         <properties>
220 |             <property name="spacing" value="1"/>
221 |         </properties>
222 |     </rule>
223 |     <rule ref="Squiz.WhiteSpace.LanguageConstructSpacing"/>
224 |     <rule ref="Squiz.WhiteSpace.LogicalOperatorSpacing"/>
225 |     <rule ref="Squiz.WhiteSpace.MemberVarSpacing"/>
226 |     <rule ref="Squiz.WhiteSpace.ObjectOperatorSpacing">
227 |         <properties>
228 |             <property name="ignoreNewlines" value="true"/>
229 |         </properties>
230 |     </rule>
231 |     <rule ref="Squiz.WhiteSpace.OperatorSpacing">
232 |         <properties>
233 |             <property name="ignoreNewlines" value="true"/>
234 |         </properties>
235 |     </rule>
236 |     <rule ref="Squiz.WhiteSpace.SemicolonSpacing"/>
237 |     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace">
238 |         <properties>
239 |             <property name="ignoreBlankLines" value="false"/><!-- turned on by PSR2 -> turning off to be more general -->
240 |         </properties>
241 |     </rule>
242 |     <rule ref="Squiz.WhiteSpace.SuperfluousWhitespace.EmptyLines">
243 |         <severity>5</severity><!-- turned off by PSR2 -> turning on with default severity -->
244 |     </rule>
245 | 
246 |     <rule ref="SlevomatCodingStandard.Arrays.TrailingArrayComma"/>
247 |     <rule ref="SlevomatCodingStandard.Classes.ModernClassNameReference"/>
248 |     <rule ref="SlevomatCodingStandard.Classes.ClassConstantVisibility" />
249 |     <rule ref="SlevomatCodingStandard.Classes.ClassStructure">
250 |         <properties>
251 |             <property name="groups" type="array">
252 |                 <element value="uses"/>
253 |                 <element value="constants"/>
254 |                 <element value="enum cases"/>
255 |                 <element value="properties"/>
256 |                 <element value="constructor"/>
257 |                 <element value="destructor"/>
258 |                 <element value="methods"/>
259 |             </property>
260 |         </properties>
261 |     </rule>
262 |     <rule ref="SlevomatCodingStandard.Classes.UselessLateStaticBinding" />
263 |     <rule ref="SlevomatCodingStandard.Classes.DisallowLateStaticBindingForConstants" />
264 |     <rule ref="SlevomatCodingStandard.Classes.DisallowMultiConstantDefinition" />
265 |     <rule ref="SlevomatCodingStandard.Classes.DisallowMultiPropertyDefinition" />
266 |     <rule ref="SlevomatCodingStandard.Classes.MethodSpacing" />
267 |     <rule ref="SlevomatCodingStandard.Classes.EmptyLinesAroundClassBraces"/>
268 |     <rule ref="SlevomatCodingStandard.Classes.TraitUseDeclaration" />
269 |     <rule ref="SlevomatCodingStandard.Classes.TraitUseSpacing" />
270 |     <rule ref="SlevomatCodingStandard.Classes.DisallowConstructorPropertyPromotion" />
271 |     <rule ref="SlevomatCodingStandard.Commenting.DocCommentSpacing">
272 |         <properties>
273 |             <property name="linesCountBeforeFirstContent" value="0"/>
274 |             <property name="linesCountAfterLastContent" value="0"/>
275 |             <property name="linesCountBetweenDescriptionAndAnnotations" value="1"/>
276 |             <property name="linesCountBetweenAnnotationsGroups" value="1"/>
277 |         </properties>
278 |     </rule>
279 |     <rule ref="SlevomatCodingStandard.Commenting.EmptyComment"/>
280 |     <rule ref="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment"/>
281 |     <rule ref="SlevomatCodingStandard.Commenting.InlineDocCommentDeclaration"/>
282 |     <rule ref="SlevomatCodingStandard.Commenting.UselessInheritDocComment"/>
283 |     <rule ref="SlevomatCodingStandard.Commenting.ForbiddenComments">
284 |         <properties>
285 |             <property name="forbiddenCommentPatterns" type="array" value="~^[a-zA-Z0-9]+ constructor.?$~,~PhpStorm~,~^[GS]et [a-zA-Z0-9]+$~"/>
286 |         </properties>
287 |     </rule>
288 |     <rule ref="SlevomatCodingStandard.Commenting.ForbiddenAnnotations">
289 |         <properties>
290 |             <property name="forbiddenAnnotations" type="array" value="@author,@created,@version,@package,@copyright,@license,@since,@link,@group,@expectedException" />
291 |         </properties>
292 |     </rule>
293 |     <rule ref="SlevomatCodingStandard.ControlStructures.AssignmentInCondition"/>
294 |     <rule ref="SlevomatCodingStandard.ControlStructures.LanguageConstructWithParentheses"/>
295 |     <rule ref="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison"/>
296 |     <rule ref="SlevomatCodingStandard.ControlStructures.NewWithParentheses"/>
297 |     <rule ref="SlevomatCodingStandard.ControlStructures.RequireNullCoalesceOperator"/>
298 |     <rule ref="SlevomatCodingStandard.Exceptions.DeadCatch"/>
299 |     <rule ref="SlevomatCodingStandard.Exceptions.RequireNonCapturingCatch"/>
300 |     <rule ref="SlevomatCodingStandard.Exceptions.ReferenceThrowableOnly"/>
301 |     <rule ref="SlevomatCodingStandard.Functions.DisallowArrowFunction"/>
302 |     <rule ref="SlevomatCodingStandard.Functions.DisallowNamedArguments"/>
303 |     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
304 |     <rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall"/>
305 |     <rule ref="SlevomatCodingStandard.Functions.StaticClosure"/>
306 |     <rule ref="SlevomatCodingStandard.Functions.UselessParameterDefaultValue"/>
307 |     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure"/>
308 |     <rule ref="SlevomatCodingStandard.Functions.DisallowArrowFunction"/>
309 |     <rule ref="SlevomatCodingStandard.Namespaces.UseFromSameNamespace"/>
310 |     <rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses">
311 |         <properties>
312 |             <property name="caseSensitive" value="false"/>
313 |             <property name="psr12Compatible" value="true"/>
314 |         </properties>
315 |     </rule>
316 |     <rule ref="SlevomatCodingStandard.Namespaces.DisallowGroupUse"/>
317 |     <rule ref="SlevomatCodingStandard.Namespaces.NamespaceDeclaration"/>
318 |     <rule ref="SlevomatCodingStandard.Namespaces.NamespaceSpacing"/>
319 |     <rule ref="SlevomatCodingStandard.Namespaces.RequireOneNamespaceInFile"/>
320 |     <rule ref="SlevomatCodingStandard.Namespaces.MultipleUsesPerLine"/>
321 |     <rule ref="SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
322 |     <rule ref="SlevomatCodingStandard.Namespaces.UseSpacing"/>
323 |     <rule ref="SlevomatCodingStandard.Namespaces.UselessAlias"/>
324 |     <rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
325 |         <properties>
326 |             <property name="searchAnnotations" type="bool" value="true"/>
327 |         </properties>
328 |     </rule>
329 |     <rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly">
330 |         <properties>
331 |             <property name="allowFullyQualifiedGlobalFunctions" type="bool" value="false"/>
332 |             <property name="allowFullyQualifiedNameForCollidingFunctions" type="bool" value="false"/>
333 |             <property name="allowFallbackGlobalFunctions" type="bool" value="false"/>
334 | 
335 |             <property name="allowFullyQualifiedGlobalConstants" type="bool" value="false"/>
336 |             <property name="allowFullyQualifiedNameForCollidingConstants" type="bool" value="false"/>
337 |             <property name="allowFallbackGlobalConstants" type="bool" value="false"/>
338 | 
339 |             <property name="allowPartialUses" value="false"/>
340 |             <property name="searchAnnotations" value="true"/>
341 |         </properties>
342 |     </rule>
343 |     <rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly.PartialUse"/>
344 |     <rule ref="SlevomatCodingStandard.Numbers.RequireNumericLiteralSeparator" />
345 |     <rule ref="SlevomatCodingStandard.Operators.DisallowEqualOperators" />
346 |     <rule ref="SlevomatCodingStandard.Operators.SpreadOperatorSpacing" />
347 |     <rule ref="SlevomatCodingStandard.PHP.DisallowDirectMagicInvokeCall" />
348 |     <rule ref="SlevomatCodingStandard.PHP.ShortList"/>
349 |     <rule ref="SlevomatCodingStandard.PHP.TypeCast"/>
350 |     <rule ref="SlevomatCodingStandard.PHP.UselessSemicolon"/>
351 |     <rule ref="SlevomatCodingStandard.PHP.OptimizedFunctionsWithoutUnpacking"/>
352 |     <rule ref="SlevomatCodingStandard.PHP.ReferenceSpacing"/>
353 |     <rule ref="SlevomatCodingStandard.PHP.RequireNowdoc"/>
354 |     <rule ref="SlevomatCodingStandard.TypeHints.DeclareStrictTypes">
355 |         <properties>
356 |             <property name="declareOnFirstLine" value="true"/>
357 |         </properties>
358 |     </rule>
359 |     <rule ref="SlevomatCodingStandard.TypeHints.NullableTypeForNullDefaultValue" />
360 |     <rule ref="SlevomatCodingStandard.TypeHints.NullTypeHintOnLastPosition" />
361 |     <rule ref="SlevomatCodingStandard.TypeHints.UnionTypeHintFormat" />
362 |     <rule ref="SlevomatCodingStandard.TypeHints.UselessConstantTypeHint" />
363 |     <rule ref="SlevomatCodingStandard.TypeHints.PropertyTypeHint">
364 |         <properties>
365 |             <property name="enableNativeTypeHint" value="true"/>
366 |             <property name="traversableTypeHints" type="array" value="
367 |                 Generator,
368 |                 Traversable
369 |             "/>
370 |         </properties>
371 |     </rule>
372 | 
373 |     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint">
374 |         <properties>
375 |             <property name="traversableTypeHints" type="array" value="
376 |                 Generator,
377 |                 Traversable
378 |             "/>
379 |         </properties>
380 |     </rule>
381 |     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint">
382 |         <properties>
383 |             <property name="traversableTypeHints" type="array" value="
384 |                 Generator,
385 |                 Traversable
386 |             "/>
387 |         </properties>
388 |     </rule>
389 |     <rule ref="SlevomatCodingStandard.TypeHints.LongTypeHints"/>
390 |     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHintSpacing"/>
391 |     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHintSpacing"/>
392 |     <rule ref="SlevomatCodingStandard.Variables.DuplicateAssignmentToVariable"/>
393 |     <rule ref="SlevomatCodingStandard.Variables.UnusedVariable">
394 |         <properties>
395 |             <property name="ignoreUnusedValuesWhenOnlyKeysAreUsedInForeach" value="true"/>
396 |         </properties>
397 |     </rule>
398 |     <rule ref="SlevomatCodingStandard.Variables.UselessVariable"/>
399 |     <rule ref="SlevomatCodingStandard.ControlStructures.AssignmentInCondition"/>
400 |     <rule ref="SlevomatCodingStandard.ControlStructures.BlockControlStructureSpacing"/>
401 |     <rule ref="SlevomatCodingStandard.ControlStructures.DisallowContinueWithoutIntegerOperandInSwitch"/>
402 |     <rule ref="SlevomatCodingStandard.ControlStructures.UselessIfConditionWithReturn"/>
403 |     <rule ref="SlevomatCodingStandard.ControlStructures.UselessTernaryOperator"/>
404 |     <rule ref="SlevomatCodingStandard.ControlStructures.EarlyExit">
405 |         <exclude name="SlevomatCodingStandard.ControlStructures.EarlyExit.EarlyExitNotUsed"/> <!-- leads to less readable code in some cases -->
406 |     </rule>
407 | </ruleset>
408 | 


--------------------------------------------------------------------------------