Fix PHP 8.4 compatibility

Fixes PHP 8.4 compatibility in backwards compatible
fashion. Also updates testing suite to be
compatible with PHP 8.4, but doesn't yet
use it in CI as the run time, but it can
be executed locally.

PHP 8.4 is not released yet, and compatible
xdebug version is not yet available in PECL
repository.

Fixes #227

Author: gocom

.github/CONTRIBUTING.textile

@@ -51,7 +51,7 @@ h2. Running tests on different PHP versions and platforms
 The project comes with multiple different PHP versions that can be used to run the test suite. To run tests on different PHP version, first build the target image and then run tests using it:
 
 bc. $ make docker-build IMAGE=php_8_3
-$ make test
+$ make test IMAGE=php_8_3
 
 List of available images can be found by running:
 

CHANGELOG.textile

@@ -2,7 +2,9 @@ h1. Changelog
 
 Here's a summary of changes in each release. The list doesn't include some small changes or updates to test cases.
 
-h2. Version 4.2.0 - upcoming
+h2. Version 4.1.2 - upcoming
+
+* Fix PHP 8.4 compatibility issues (closes "#227":https://github.com/textile/php-textile/issues/227).
 
 h2. "Version 4.1.1 - 2024/06/07":https://github.com/textile/php-textile/releases/tag/v4.1.1
 

Makefile

@@ -29,6 +29,9 @@ test-unit: vendor
 repl: vendor
 	$(PHP) composer repl
 
+shell:
+	$(PHP) bash
+
 bump: vendor
 	$(PHP) composer project:bump
 
@@ -72,6 +75,9 @@ help:
 	@echo "  $$ make repl"
 	@echo "  Launch read-print-eval loop"
 	@echo ""
+	@echo "  $$ make shell"
+	@echo "  Login into the container"
+	@echo ""
 	@echo "  $$ make bump"
 	@echo "  Bump version"
 	@echo ""

composer.json

@@ -23,15 +23,15 @@
         "php": ">=5.3.0"
     },
     "require-dev": {
-        "phpstan/phpstan": "1.6.3",
+        "phpstan/phpstan": "1.12.0",
         "phpunit/phpunit": "^9.5.20",
         "squizlabs/php_codesniffer": "3.*",
-        "symfony/yaml": "^4.4.3",
-        "psy/psysh": "^0.11.2"
+        "symfony/yaml": "^5.4.40",
+        "psy/psysh": "^0.12.4"
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "4.2-dev"
+            "dev-master": "4.1-dev"
         }
     },
     "scripts": {

docker-compose.yml

@@ -13,6 +13,7 @@ services:
       - XDEBUG_MODE
       - XDEBUG_TRIGGER
       - PHP_IDE_CONFIG
+      - COMPOSER_ROOT_VERSION=dev-master
 
 networks:
   app:

docker/image/php_8_4/Dockerfile

@@ -0,0 +1,12 @@
+FROM php:8.4-rc-cli
+
+RUN apt-get update && apt-get install -y \
+    bash \
+    git \
+    libz-dev \
+    zip \
+    wget
+
+COPY --from=composer:2.7 /usr/bin/composer /usr/bin/composer
+
+WORKDIR /app

src/Netcarver/Textile/DataBag.php

@@ -64,7 +64,7 @@ class DataBag
      *
      * @param array<string, string|int>|null $data The initial data array stored in the bag
      */
-    public function __construct(array $data = null)
+    public function __construct($data = null)
     {
         $this->data = (array) $data;
     }

src/Netcarver/Textile/Parser.php

@@ -384,7 +384,7 @@ class Parser
      *
      * @var string
      */
-    protected $ver = '4.2.0-dev';
+    protected $ver = '4.1.2-dev';
 
     /**
      * Regular expression snippets.
@@ -3039,18 +3039,18 @@ protected function fTextileList($m)
 
         foreach ($list as $index => $m) {
             $start = '';
-            $content = trim($m['content']);
-            $ltype = $this->liType($m['tl']);
+            $content = trim((string) $m['content']);
+            $ltype = $this->liType((string) $m['tl']);
 
             if (isset($list[$index + 1])) {
                 $next = $list[$index + 1];
             } else {
                 $next = false;
             }
 
-            if (strpos($m['tl'], ';') !== false) {
+            if (strpos((string) $m['tl'], ';') !== false) {
                 $litem = 'dt';
-            } elseif (strpos($m['tl'], ':') !== false) {
+            } elseif (strpos((string) $m['tl'], ':') !== false) {
                 $litem = 'dd';
             } else {
                 $litem = 'li';
@@ -3080,12 +3080,16 @@ protected function fTextileList($m)
                 }
             }
 
-            if ($prev && $prev['tl'] && strpos($prev['tl'], ';') !== false && strpos($m['tl'], ':') !== false) {
+            if ($prev
+                && $prev['tl']
+                && strpos((string) $prev['tl'], ';') !== false
+                && strpos((string) $m['tl'], ':') !== false
+            ) {
                 $lists[$m['tl']] = 2;
             }
 
-            $tabs = str_repeat("\t", $m['level'] - 1);
-            $atts = $this->parseAttribs($m['atts']);
+            $tabs = str_repeat("\t", ((int) $m['level']) - 1);
+            $atts = $this->parseAttribs((string) $m['atts']);
 
             if (!isset($lists[$m['tl']])) {
                 $lists[$m['tl']] = 1;
@@ -3760,7 +3764,6 @@ protected function placeNoteLists($text)
                 ksort($o);
             }
 
-            // @phpstan-ignore-next-line
             $this->notes = $o;
         }
 
@@ -3955,6 +3958,7 @@ protected function fParseNoteRefs($m)
         // If we are referencing a note that hasn't had the definition parsed yet, then assign it an ID.
 
         if (empty($this->notes[$m['label']]['id'])) {
+            // @phpstan-ignore-next-line
             $id = $this->notes[$m['label']]['id'] = $this->linkPrefix . ($this->linkIndex++);
         } else {
             $id = $this->notes[$m['label']]['id'];
@@ -3964,6 +3968,7 @@ protected function fParseNoteRefs($m)
         $out = '<span id="noteref'.$refid.'">'.$num.'</span>';
 
         if (!$nolink) {
+            // @phpstan-ignore-next-line
             $out = '<a href="#note'.$id.'">'.$out.'</a>';
         }
 

src/Netcarver/Textile/Tag.php

@@ -83,7 +83,7 @@ class Tag extends DataBag
      * @param array<string, int|string> $attributes  An array of attributes
      * @param bool  $selfclosing Whether the tag is self-closing
      */
-    public function __construct($name, array $attributes = null, $selfclosing = true)
+    public function __construct($name, $attributes = null, $selfclosing = true)
     {
         parent::__construct($attributes);
         $this->tag = $name;