AVRO-4194: remove PHP EOL versions and use new language features (#3528)

* remove PHP EOL version, add PHP cs fixer and fix test directory

* add license to .php-cs-fixer.dist.php

* fix missing quote in test-lang-php.yml

* apply automatic changes to lib files and update AvroIO

* update composer version in Dockerfile

* add phpstan, initial cleanup of lib directory

* Remove invalid covers annotations

* fix build.sh

* phpstan.neon license

* improve AvroProtocol code & tests, add/fix types

* fix AvroProtocol due to missing json_validate in php < 8.3

* add other types

* add types and checks

* remove squizlabs/php_codesniffer

* fix some bugs and update static analysis to level 3

* add missing license

* review - fixes

* review - apply lint on lib

* review - apply lint on lib

* add doc field for fixed schemas

Author: mattiabasone

.github/workflows/test-lang-php.yml

@@ -42,9 +42,6 @@ jobs:
           - ubuntu-latest
           - ubuntu-24.04-arm
         php:
-          - '7.3'
-          - '7.4'
-          - '8.0'
           - '8.1'
           - '8.2'
           - '8.3'
@@ -71,8 +68,12 @@ jobs:
             ${{ runner.os }}-composer-
 
       - name: Lint
+        if: matrix.php == '8.1'
         run: ./build.sh lint
 
+      - name: Static analysis
+        run: ./build.sh phpstan
+
       - name: Test
         run: ./build.sh test
 
@@ -84,9 +85,6 @@ jobs:
           - ubuntu-latest
           - ubuntu-24.04-arm
         php:
-          - '7.3'
-          - '7.4'
-          - '8.0'
           - '8.1'
           - '8.2'
           - '8.3'

composer.json

@@ -23,20 +23,21 @@
     "issues": "https://issues.apache.org/jira/browse/AVRO"
   },
   "require": {
-    "php": "^7.3 || ^8.0"
+    "php": "^8.1"
   },
   "deps": [
-    "vendor/phpunit/phpunit",
-    "vendor/squizlabs/php_codesniffer"
+    "vendor/phpunit/phpunit"
   ],
   "require-dev": {
-    "phpunit/phpunit": "^7.5 || ^8.5 || ^9.5",
-    "squizlabs/php_codesniffer": "3.*",
+    "phpunit/phpunit": "^10.5",
     "php-mock/php-mock-phpunit": "^2.10",
     "ext-json": "*",
     "ext-xml": "*",
     "ext-curl": "*",
-    "ext-pcntl": "*"
+    "ext-pcntl": "*",
+    "rector/rector": "^2.2",
+    "friendsofphp/php-cs-fixer": "^3.89",
+    "phpstan/phpstan": "^2.1"
   },
   "autoload": {
     "psr-4": {

lang/php/.gitignore

@@ -1,3 +1,5 @@
 pkg
 vendor
 .phpunit.result.cache
+.phpunit.cache
+.php-cs-fixer.cache

lang/php/.php-cs-fixer.dist.php

@@ -0,0 +1,103 @@
+<?php
+
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+use PhpCsFixer\Runner\Parallel\ParallelConfigFactory;
+
+/**
+ * PHP CS Fixer documentation:
+ * - Homepage: https://cs.symfony.com/
+ * - List of all available rules: https://cs.symfony.com/doc/rules/index.html
+ * - List of all available rule sets: https://cs.symfony.com/doc/ruleSets/index.html
+ *
+ * To inspect a specific rule (e.g. `blank_line_before_statement`), run:
+ *
+ * ```console
+ * > php-cs-fixer describe blank_line_before_statement
+ * ```
+ */
+$finder = PhpCsFixer\Finder::create()
+    ->in(['lib', 'test'])
+    ->append(['.php-cs-fixer.dist.php']);
+
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setParallelConfig(ParallelConfigFactory::detect())
+    ->setRules([
+        // —— CS Rule Sets —————————————————————————————————————————————————————
+        '@Symfony' => true,
+        '@PHP8x0Migration' => true,
+
+        // —— Overriden rules ——————————————————————————————————————————————————
+
+        // @Symfony: `['statements' => ['return']]`
+        // Here using: default, `['statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try']]`
+        'blank_line_before_statement' => true,
+
+        // @Symfony: `['tokens' => [['attribute', 'case', 'continue', 'curly_brace_block', 'default', 'extra', 'parenthesis_brace_block', 'square_brace_block', 'switch', 'throw', 'use']]]`
+        // Here using: default, `['tokens' => ['extra']]`
+        'no_extra_blank_lines' => true,
+
+        // @Symfony: `['allow_hidden_params' => true, 'remove_inheritdoc' => true]`
+        'no_superfluous_phpdoc_tags' => ['allow_mixed' => true, 'allow_unused_params' => true, 'remove_inheritdoc' => false],
+
+        // @Symfony: `['after_heredoc' => true]`
+        // Here using: default, `['after_heredoc' => false]`
+        'no_whitespace_before_comma_in_array' => true,
+
+        // @Symfony: `['order' => ['use_trait']]`
+        // Here using: default, `['order' => ['use_trait', 'case', 'constant_public', 'constant_protected', 'constant_private', 'property_public', 'property_protected', 'property_private', 'construct', 'destruct', 'magic', 'phpunit', 'method_public', 'method_protected', 'method_private']]`)
+        'ordered_class_elements' => true,
+
+        // @Symfony: `['imports_order' => ['class', 'function', 'const'], 'sort_algorithm' => 'alpha']`
+        // Here using: default, all import types (classes, functions, and constants) are sorted together alphabetically without grouping them by type
+        'ordered_imports' => true,
+
+        // @Symfony: `['order' => ['param', 'return', 'throws']]`
+        // Here using: default, `['param', 'throws', 'return']`
+        'phpdoc_order' => true,
+
+        // @Symfony: `['null_adjustment' => 'always_last', 'sort_algorithm' => 'none']`
+        'phpdoc_types_order' => ['null_adjustment' => 'always_first'],
+
+        // @Symfony: `['case' => 'camel_case']`
+        'php_unit_method_casing' => ['case' => 'snake_case'],
+
+        // —— Overriden rules (disabled) ————————————————————————————————————————
+        // @Symfony
+        'increment_style' => false,
+        'phpdoc_align' => false,
+        'phpdoc_separation' => false,
+        'phpdoc_summary' => false,
+        'phpdoc_to_comment' => false,
+        'single_line_comment_style' => false,
+        'single_line_throw' => false,
+        'single_quote' => false,
+
+        // —— Additional rules ——————————————————————————————————————————————————
+        'no_useless_else' => true,
+        'phpdoc_add_missing_param_annotation' => true,
+        'phpdoc_annotation_without_dot' => false,
+        'protected_to_private' => true,
+        'psr_autoloading' => true,
+    ])
+    ->setFinder($finder)
+;

lang/php/README.md

@@ -8,14 +8,14 @@ A library for using [Avro](https://avro.apache.org/) with PHP.
 
 Requirements
 ============
- * PHP 7.3+
+ * PHP 8.1+
  * On 32-bit platforms, the [GMP PHP extension](https://php.net/gmp)
  * For Zstandard compression, [ext-zstd](https://github.com/kjdev/php-ext-zstd)
  * For Snappy compression, [ext-snappy](https://github.com/kjdev/php-ext-snappy)
  * For testing, [PHPUnit](https://www.phpunit.de/)
 
 Both GMP and PHPUnit are often available via package management
-systems as `php7-gmp` and `phpunit`, respectively.
+systems as `php8.1-gmp` and `phpunit`, respectively.
 
 
 Getting started

lang/php/build.sh

@@ -59,13 +59,22 @@ do
 
     lint)
       composer install -d "../.."
-      find . -name "*.php" -print0 | xargs -0 -n1 -P8 php -l
-      ../../vendor/bin/phpcs --standard=PSR12 lib
+      ../../vendor/bin/php-cs-fixer fix --dry-run --show-progress=dots --verbose --diff --no-interaction
+      ;;
+
+    lint-fix)
+      composer install -d "../.."
+      ../../vendor/bin/php-cs-fixer fix --show-progress=dots --verbose --diff
+      ;;
+
+    phpstan)
+      composer install -d "../.."
+      ../../vendor/bin/phpstan
       ;;
 
     test)
       composer install -d "../.."
-      ../../vendor/bin/phpunit -v
+      ../../vendor/bin/phpunit
       ;;
 
     dist)
@@ -77,7 +86,7 @@ do
       ;;
 
     *)
-      echo "Usage: $0 {interop-data-generate|test-interop|lint|test|dist|clean}"
+      echo "Usage: $0 {interop-data-generate|test-interop|lint|lint-fix|test|dist|clean}"
   esac
 done
 

lang/php/examples/write_read.php

@@ -37,9 +37,9 @@
            {"name":"member_name", "type":"string"}]}
 _JSON;
 
-$jose = array('member_id' => 1392, 'member_name' => 'Jose');
-$maria = array('member_id' => 1642, 'member_name' => 'Maria');
-$data = array($jose, $maria);
+$jose = ['member_id' => 1392, 'member_name' => 'Jose'];
+$maria = ['member_id' => 1642, 'member_name' => 'Maria'];
+$data = [$jose, $maria];
 
 $file_name = 'data.avr';
 // Open $file_name for writing, using the given writer's schema

lang/php/lib/Avro.php

@@ -27,8 +27,6 @@
  *
  * This port is an implementation of the
  * {@link https://avro.apache.org/docs/1.3.3/spec.html Avro 1.3.3 Specification}
- *
- * @package Avro
  */
 class Avro
 {
@@ -46,49 +44,47 @@ class Avro
     private const GMP_BIGINTEGER_MODE = 0x01;
     /**#@-*/
     /**
-     * @var int
      * Mode used to handle bigintegers. After Avro::check64Bit() has been called,
      * (usually via a call to Avro::checkPlatform(), set to
      * self::GMP_BIGINTEGER_MODE on 32-bit platforms that have GMP available,
      * and to self::PHP_BIGINTEGER_MODE otherwise.
      */
-    private static $biginteger_mode;
+    private static int $biginteger_mode;
 
     /**
      * Wrapper method to call each required check.
-     *
      */
     public static function checkPlatform()
     {
         self::check64Bit();
     }
 
+    /**
+     * @returns bool true if the PHP GMP extension is used and false otherwise.
+     * @internal Requires Avro::check64Bit() (exposed via Avro::checkPlatform())
+     *           to have been called to set Avro::$biginteger_mode.
+     */
+    public static function usesGmp(): bool
+    {
+        return self::GMP_BIGINTEGER_MODE === self::$biginteger_mode;
+    }
+
     /**
      * Determines if the host platform can encode and decode long integer data.
      *
      * @throws AvroException if the platform cannot handle long integers.
      */
     private static function check64Bit()
     {
-        if (8 != PHP_INT_SIZE) {
+        if (8 !== PHP_INT_SIZE) {
             if (extension_loaded('gmp')) {
                 self::$biginteger_mode = self::GMP_BIGINTEGER_MODE;
             } else {
                 throw new AvroException('This platform cannot handle a 64-bit operations. '
-                    . 'Please install the GMP PHP extension.');
+                    .'Please install the GMP PHP extension.');
             }
         } else {
             self::$biginteger_mode = self::PHP_BIGINTEGER_MODE;
         }
     }
-
-    /**
-     * @returns boolean true if the PHP GMP extension is used and false otherwise.
-     * @internal Requires Avro::check64Bit() (exposed via Avro::checkPlatform())
-     *           to have been called to set Avro::$biginteger_mode.
-     */
-    public static function usesGmp()
-    {
-        return self::GMP_BIGINTEGER_MODE === self::$biginteger_mode;
-    }
 }