Fix PHP 8.1/8.4 deprecations

.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+name: CI
+
+on:
+  # Run on all pushes to master and on all pull requests.
+  push:
+    branches:
+      master
+  pull_request:
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+jobs:
+  test:
+    uses: "zetacomponents/.github/.github/workflows/ci.yml@master"

.github/workflows/coding-standard.yml

@@ -0,0 +1,14 @@
+name: Coding Standard
+
+on:
+  # Run on all pushes and on all pull requests.
+  push:
+    branches:
+      master
+  pull_request:
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+jobs:
+  test:
+    uses: "zetacomponents/.github/.github/workflows/coding-standard.yml@master"

ChangeLog

@@ -1,3 +1,23 @@
+1.8.2 - Thursday 20 February 2026
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+- Fixed: PHP 8.4 deprecation of implicit nullable parameter types in ezcPersistentSaveHandler::saveInternal().
+- Fixed: PHP 8.4 deprecation of implicit nullable parameter types in ezcPersistentObjectIdProperty::__construct().
+- Fixed: PHP 8.4 deprecation of implicit nullable parameter types in ezcPersistentObjectDefinition::__construct().
+- Fixed: PHP 8.4 deprecation of implicit nullable parameter types in ezcPersistentSessionIdentityDecorator::__construct().
+- Fixed: PHP 8.4 deprecation of implicit nullable parameter types in ezcPersistentIdentity::__construct().
+- Fixed: PHP 8.1 deprecation of non-covariant return types in ezcPersistentFindIterator::rewind(), current(), key(), next() and valid().
+- Fixed: PHP 8.1 deprecation of non-covariant return types in ezcPersistentIdentityFindIterator::next().
+- Fixed: PHP 8.1 deprecation of non-covariant return types in ezcPersistentRelationCollection::offsetSet(), exchangeArray(), setFlags() and append().
+- Fixed: PHP 8.1 deprecation of missing return types in ezcPersistentObjectRelations::offsetSet(), exchangeArray(), setFlags() and append().
+- Fixed: PHP 8.1 deprecation of missing return types in ezcPersistentObjectProperties::offsetSet(), exchangeArray(), setFlags() and append().
+- Fixed: PHP 8.1 deprecation of missing return types in ezcPersistentObjectColumns::offsetSet(), exchangeArray(), setFlags() and append().
+- Fixed: PHP 8.1 deprecation of missing return types in PHPUnit setUp() and tearDown() methods across all test classes.
+- Fixed: PHPUnit deprecation of getMock() replaced with getMockBuilder() in test classes.
+- Fixed: PHPUnit deprecation of readAttribute() replaced with a custom readPrivateAttribute() helper using Reflection.
+- Fixed: PHPUnit strict type assertion corrections (string to int) in ezcPersistentDatabaseTypeTest.
+
+
 1.8.1 - Friday 26 March 2021
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

src/find_iterator.php

@@ -101,7 +101,7 @@ public function __construct( PDOStatement $stmt, ezcPersistentObjectDefinition $
      *
      * @return void
      */
-    public function rewind()
+    public function rewind(): void
     {
         if ( $this->object === null )
         {
@@ -116,7 +116,7 @@ public function rewind()
      *
      * @return object
      */
-    public function current()
+    public function current(): mixed
     {
         return $this->object;
     }
@@ -129,7 +129,7 @@ public function current()
      *
      * @return null
      */
-    public function key()
+    public function key(): mixed
     {
         return null;
     }
@@ -143,6 +143,7 @@ public function key()
      *
      * @return object
      */
+    #[\ReturnTypeWillChange]
     public function next()
     {
         $row = false;
@@ -153,7 +154,7 @@ public function next()
         catch ( PDOException $e ) // MySQL 5.0 throws this if the statement is not executed.
         {
             $this->object = null;
-            return;
+            return null;
         }
 
         // SQLite returns empty array on faulty statement!
@@ -193,7 +194,7 @@ private function checkDef()
      *
      * @return bool
      */
-    public function valid()
+    public function valid(): bool
     {
         return $this->object !== null ? true : false;
     }

src/handlers/save_handler.php

@@ -295,7 +295,7 @@ public function updateFromQuery( ezcQueryUpdate $query )
     private function saveInternal(
         $object,
         $doPersistenceCheck = true,
-        ezcPersistentIdentifierGenerator $idGenerator = null 
+        ?ezcPersistentIdentifierGenerator $idGenerator = null
     )
     {
         $class = get_class( $object );

src/object/persistent_object_columns.php

@@ -60,7 +60,7 @@ public function __construct()
      * @param ezcPersistentObjectProperty $value 
      * @return void
      */
-    public function offsetSet( $offset, $value )
+    public function offsetSet( $offset, $value ): void
     {
         if ( ( $value instanceof ezcPersistentObjectProperty ) === false && ( $value instanceof ezcPersistentObjectIdProperty ) === false )
         {
@@ -78,9 +78,9 @@ public function offsetSet( $offset, $value )
      * Performs additional value checks on the array.
      * 
      * @param array(ezcPersistentObjectProperty) $array New relations array.
-     * @return void
+     * @return array the old array.
      */
-    public function exchangeArray( $array )
+    public function exchangeArray( $array ): array
     {
         foreach ( $array as $offset => $value )
         {
@@ -93,7 +93,7 @@ public function exchangeArray( $array )
                 throw new ezcBaseValueException( 'offset', $offset, 'string, length > 0' );
             }
         }
-        parent::exchangeArray( $array );
+        return parent::exchangeArray( $array );
     }
 
     /**
@@ -103,7 +103,7 @@ public function exchangeArray( $array )
      * @param int $flags Must be 0.
      * @return void
      */
-    public function setFlags( $flags )
+    public function setFlags( $flags ): void
     {
         if ( $flags !== 0 )
         {
@@ -112,12 +112,12 @@ public function setFlags( $flags )
     }
 
     /**
-     * Appending is not supported. 
-     * 
-     * @param mixed $value 
+     * Appending is not supported.
+     *
+     * @param mixed $value
      * @return void
      */
-    public function append( $value )
+    public function append( $value ): void
     {
         throw new Exception( 'Operation append is not supported by this object.' );
     }

src/object/persistent_object_definition.php

@@ -82,7 +82,7 @@ public function __construct( $table = '',
                                  $class = '',
                                  array $properties = array(),
                                  array $relations = array(),
-                                 ezcPersistentObjectIdProperty $idProperty = null )
+                                 ?ezcPersistentObjectIdProperty $idProperty = null )
     {
         $this->table      = $table;
         $this->class      = $class;

src/object/persistent_object_id_property.php

@@ -93,7 +93,7 @@ public function __construct(
         $columnName = null,
         $propertyName = null,
         $visibility = null,
-        ezcPersistentGeneratorDefinition $generator = null,
+        ?ezcPersistentGeneratorDefinition $generator = null,
         $propertyType = ezcPersistentObjectProperty::PHP_TYPE_INT,
         $databaseType = PDO::PARAM_STR
     )

src/object/persistent_object_properties.php

@@ -60,7 +60,7 @@ public function __construct()
      * @param ezcPersistentObjectProperty $value 
      * @return void
      */
-    public function offsetSet( $offset, $value )
+    public function offsetSet( $offset, $value ): void
     {
         if ( ( $value instanceof ezcPersistentObjectProperty ) === false )
         {
@@ -78,9 +78,9 @@ public function offsetSet( $offset, $value )
      * Performs additional value checks on the array.
      * 
      * @param array(ezcPersistentObjectProperty) $array New properties array.
-     * @return void
+     * @return array the old array.
      */
-    public function exchangeArray( $array )
+    public function exchangeArray( $array ): array
     {
         foreach ( $array as $offset => $value )
         {
@@ -93,7 +93,7 @@ public function exchangeArray( $array )
                 throw new ezcBaseValueException( 'offset', $offset, 'string, length > 0' );
             }
         }
-        parent::exchangeArray( $array );
+        return parent::exchangeArray( $array );
     }
 
     /**
@@ -103,7 +103,7 @@ public function exchangeArray( $array )
      * @param int $flags Must be 0.
      * @return void
      */
-    public function setFlags( $flags )
+    public function setFlags( $flags ): void
     {
         if ( $flags !== 0 )
         {
@@ -112,12 +112,12 @@ public function setFlags( $flags )
     }
 
     /**
-     * Appending is not supported. 
-     * 
-     * @param mixed $value 
+     * Appending is not supported.
+     *
+     * @param mixed $value
      * @return void
      */
-    public function append( $value )
+    public function append( $value ): void
     {
         throw new Exception( 'Operation append is not supported by this object.' );
     }

src/object/persistent_object_relations.php

@@ -60,7 +60,7 @@ public function __construct()
      * @param ezcPersistentRelation $value 
      * @return void
      */
-    public function offsetSet( $offset, $value )
+    public function offsetSet( $offset, $value ): void
     {
         if ( !( $value instanceof ezcPersistentRelation ) && !( $value instanceof ezcPersistentRelationCollection ) )
         {
@@ -78,9 +78,9 @@ public function offsetSet( $offset, $value )
      * Performs additional value checks on the array.
      * 
      * @param array(ezcPersistentRelation) $array New relations array.
-     * @return void
+     * @return array the old array.
      */
-    public function exchangeArray( $array )
+    public function exchangeArray( $array ): array
     {
         foreach ( $array as $offset => $value )
         {
@@ -93,7 +93,7 @@ public function exchangeArray( $array )
                 throw new ezcBaseValueException( 'offset', $offset, 'string, length > 0' );
             }
         }
-        parent::exchangeArray( $array );
+        return parent::exchangeArray( $array );
     }
 
     /**
@@ -103,7 +103,7 @@ public function exchangeArray( $array )
      * @param int $flags Must be 0.
      * @return void
      */
-    public function setFlags( $flags )
+    public function setFlags( $flags ): void
     {
         if ( $flags !== 0 )
         {
@@ -112,12 +112,12 @@ public function setFlags( $flags )
     }
 
     /**
-     * Appending is not supported. 
-     * 
-     * @param mixed $value 
+     * Appending is not supported.
+     *
+     * @param mixed $value
      * @return void
      */
-    public function append( $value )
+    public function append( $value ): void
     {
         throw new Exception( 'Operation append is not supported by this object.' );
     }

src/object/relation_collection.php

@@ -60,7 +60,7 @@ public function __construct()
      * @param ezcPersistentRelation $value 
      * @return void
      */
-    public function offsetSet( $offset, $value )
+    public function offsetSet( $offset, $value ): void
     {
         if ( ( $value instanceof ezcPersistentRelation ) === false )
         {
@@ -80,7 +80,7 @@ public function offsetSet( $offset, $value )
      * @param array(ezcPersistentRelation) $array New relations array.
      * @return void
      */
-    public function exchangeArray( $array )
+    public function exchangeArray( $array ): array
     {
         foreach ( $array as $offset => $value )
         {
@@ -93,7 +93,7 @@ public function exchangeArray( $array )
                 throw new ezcBaseValueException( 'offset', $offset, 'string, length > 0' );
             }
         }
-        parent::exchangeArray( $array );
+        return parent::exchangeArray( $array );
     }
 
     /**
@@ -103,7 +103,7 @@ public function exchangeArray( $array )
      * @param int $flags Must be 0.
      * @return void
      */
-    public function setFlags( $flags )
+    public function setFlags( $flags ): void
     {
         if ( $flags !== 0 )
         {
@@ -117,7 +117,7 @@ public function setFlags( $flags )
      * @param mixed $value 
      * @return void
      */
-    public function append( $value )
+    public function append( $value ): void
     {
         throw new Exception( 'Operation append is not supported by this object.' );
     }

src/session_decorators/identity.php

@@ -127,7 +127,7 @@ class ezcPersistentSessionIdentityDecorator implements ezcPersistentSessionFound
      * @param ezcPersistentIdentityMap $identityMap 
      * @param ezcPersistentSessionIdentityDecoratorOptions $options
      */
-    public function __construct( ezcPersistentSession $session, ezcPersistentIdentityMap $identityMap, ezcPersistentSessionIdentityDecoratorOptions $options = null )
+    public function __construct( ezcPersistentSession $session, ezcPersistentIdentityMap $identityMap, ?ezcPersistentSessionIdentityDecoratorOptions $options = null )
     {
         $this->session                   = $session;
         $this->properties['identityMap'] = $identityMap;

src/session_decorators/identity/find_iterator.php

@@ -110,6 +110,7 @@ public function __construct(
      *
      * @return object
      */
+    #[\ReturnTypeWillChange]
     public function next()
     {
         $object = parent::next();

src/structs/identity.php

@@ -122,7 +122,7 @@ public function __construct(
         $object = null,
         array $relatedObjects = array(),
         array $namedRelatedObjectSets = array(),
-        SplObjectStorage $references = null
+        ?SplObjectStorage $references = null
     )
     {
         $this->object                 = $object;

tests/basic_identity_map_test.php

@@ -44,14 +44,14 @@ public static function suite()
         return new \PHPUnit\Framework\TestSuite( __CLASS__ );
     }
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->definitionManager = new ezcPersistentCodeManager(
             dirname( __FILE__ ) . '/data'
         );
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
     }