Merge pull request #44 from compwright/php-84

Support PHP 8.4

.github/workflows/continuous-integration.yml

@@ -22,6 +22,7 @@ jobs:
           - '8.1'
           - '8.2'
           - '8.3'
+          - '8.4'
     steps:
       - name: Checkout
         uses: actions/checkout@v1

composer.json

@@ -15,6 +15,7 @@
         "php": "^7.2 || ^8.0"
     },
     "require-dev": {
+        "phpstan/phpstan": "^1.0 || ^2.0",
         "yoast/phpunit-polyfills": "^1.0.0"
     },
     "autoload": {
@@ -28,6 +29,7 @@
         }
     },
     "scripts": {
+        "analyze": "vendor/bin/phpstan analyse -c phpstan.neon",
         "test": "vendor/bin/phpunit"
     }
 }

phpstan.neon

@@ -0,0 +1,12 @@
+parameters:
+    level: 8
+    paths:
+        - src
+        - tests
+    universalObjectCratesClasses:
+        - Aura\Marshal\Manager
+        - Aura\Marshal\Entity\GenericEntity
+    inferPrivatePropertyTypeFromConstructor: true
+    checkFunctionNameCase: true
+    checkInternalClassCaseSensitivity: true
+    treatPhpDocTypesAsCertain: false

src/Collection/Builder.php

@@ -23,7 +23,7 @@ class Builder implements BuilderInterface
      *
      * The class to use for new instances.
      *
-     * @var string
+     * @var class-string<GenericCollection>
      *
      */
     protected $class = 'Aura\Marshal\Collection\GenericCollection';
@@ -32,7 +32,7 @@ class Builder implements BuilderInterface
      *
      * Creates a new collection object.
      *
-     * @param array $data Data to load into the collection.
+     * @param array<int|string, mixed> $data Data to load into the collection.
      *
      * @return GenericCollection
      *

src/Collection/BuilderInterface.php

@@ -10,8 +10,6 @@
  */
 namespace Aura\Marshal\Collection;
 
-use Aura\Marshal\Type\GenericType;
-
 /**
  *
  * An interface for collection builder objects.
@@ -25,7 +23,9 @@ interface BuilderInterface
      *
      * Creates a new collection object.
      *
-     * @param array $data Data to load into the collection.
+     * @param array<int|string, mixed> $data Data to load into the collection.
+     * 
+     * @return GenericCollection
      *
      */
     public function newInstance(array $data);

src/Collection/GenericCollection.php

@@ -31,7 +31,7 @@ class GenericCollection extends Data implements ToArrayInterface
      *
      * @param string $field The field name to retrieve values for.
      *
-     * @return array
+     * @return array<int|string, mixed>
      *
      */
     public function getFieldValues($field)

src/Data.php

@@ -24,6 +24,9 @@
  *   entities.
  *
  * @package Aura.Marshal
+ * 
+ * @implements \ArrayAccess<int|string, mixed>
+ * @implements \IteratorAggregate<int|string, mixed>
  *
  */
 class Data implements \ArrayAccess, \Countable, \IteratorAggregate
@@ -32,7 +35,7 @@ class Data implements \ArrayAccess, \Countable, \IteratorAggregate
      *
      * Key-value pairs of data.
      *
-     * @var array
+     * @var array<int|string, GenericEntity|mixed>
      *
      */
     protected $data = [];
@@ -41,7 +44,7 @@ class Data implements \ArrayAccess, \Countable, \IteratorAggregate
      *
      * Constructor.
      *
-     * @param array $data The data for this object.
+     * @param array<int|string, mixed> $data The data for this object.
      *
      */
     public function __construct(array $data = [])

src/DataIterator.php

@@ -17,6 +17,8 @@
  * An object to allow iteration over the elements of a Data object.
  *
  * @package Aura.Marshal
+ * 
+ * @implements \Iterator<int|string, mixed>
  *
  */
 class DataIterator implements \Iterator
@@ -25,7 +27,7 @@ class DataIterator implements \Iterator
      *
      * The data over which we are iterating.
      *
-     * @var ArrayAccess
+     * @var ArrayAccess<int|string, mixed>
      *
      */
     protected $data;
@@ -34,7 +36,7 @@ class DataIterator implements \Iterator
      *
      * The keys to iterate over in the Data object.
      *
-     * @var array
+     * @var array<int|string>
      *
      */
     protected $keys;
@@ -52,9 +54,9 @@ class DataIterator implements \Iterator
      *
      * Constructor.
      *
-     * @param ArrayAccess $data The Data object over which to iterate.
+     * @param ArrayAccess<int|string, mixed> $data The Data object over which to iterate.
      *
-     * @param array $keys The keys in the Data object.
+     * @param array<int|string> $keys The keys in the Data object.
      *
      */
     public function __construct(ArrayAccess $data, array $keys = [])

src/Entity/Builder.php

@@ -10,8 +10,6 @@
  */
 namespace Aura\Marshal\Entity;
 
-use Aura\Marshal\Lazy\BuilderInterface as LazyBuilderInterface;
-
 /**
  *
  * Creates a new entity object for a type.
@@ -25,7 +23,7 @@ class Builder implements BuilderInterface
      *
      * The class to use for new instances.
      *
-     * @var string
+     * @var class-string<GenericEntity>
      *
      */
     protected $class = 'Aura\Marshal\Entity\GenericEntity';
@@ -34,7 +32,7 @@ class Builder implements BuilderInterface
      *
      * Creates a new entity object.
      *
-     * @param array|object $data Data to load into the entity.
+     * @param array<int|string, mixed> $data Data to load into the entity.
      *
      * @return GenericEntity
      *

src/Entity/BuilderInterface.php

@@ -10,8 +10,6 @@
  */
 namespace Aura\Marshal\Entity;
 
-use Aura\Marshal\Type\GenericType;
-
 /**
  *
  * An interface for EntityBuilder objects.
@@ -25,7 +23,9 @@ interface BuilderInterface
      *
      * Creates a new entity object.
      *
-     * @param array $data Data to load into the entity.
+     * @param array<int|string, mixed> $data Data to load into the entity.
+     * 
+     * @return GenericEntity
      *
      */
     public function newInstance(array $data);

src/Entity/GenericEntity.php

@@ -22,6 +22,7 @@
  * @package Aura.Marshal
  *
  */
+#[\AllowDynamicProperties]
 class GenericEntity extends Data implements ToArrayInterface
 {
     use MagicArrayAccessTrait;

src/Lazy/Builder.php

@@ -25,7 +25,7 @@ class Builder implements BuilderInterface
      *
      * The class to use for new instances.
      *
-     * @var string
+     * @var class-string<LazyInterface>
      *
      */
     protected $class = 'Aura\Marshal\Lazy\GenericLazy';
@@ -37,7 +37,7 @@ class Builder implements BuilderInterface
      * @param RelationInterface $relation The relationship object between the
      * native and foreign types.
      *
-     * @return Lazy
+     * @return LazyInterface
      *
      */
     public function newInstance(RelationInterface $relation)

src/Lazy/BuilderInterface.php

@@ -28,7 +28,7 @@ interface BuilderInterface
      * @param RelationInterface $relation The relationship object between the
      * native and foreign types.
      *
-     * @return Lazy
+     * @return LazyInterface
      *
      */
     public function newInstance(RelationInterface $relation);

src/Manager.php

@@ -46,7 +46,7 @@ class Manager
      * An array of type definition arrays, which are converted to type
      * objects as you request them.
      *
-     * @var array
+     * @var array<string, GenericType|array<string, mixed>>
      *
      */
     protected $types;
@@ -139,7 +139,7 @@ class Manager
      *
      * @param RelationBuilder $relation_builder A builder for relation objects.
      *
-     * @param array $types Type definitions.
+     * @param array<string, array<string, mixed>> $types Type definitions.
      *
      */
     public function __construct(
@@ -158,7 +158,7 @@ public function __construct(
      *
      * @param string $name The name to use for the type.
      *
-     * @param array $info An array of type definition information.
+     * @param array<string, mixed> $info An array of type definition information.
      *
      * @return void
      *
@@ -180,7 +180,7 @@ public function setType($name, array $info)
      *
      * @param string $name The name for the relation.
      *
-     * @param array $info The relation information.
+     * @param array<string, mixed> $info The relation information.
      *
      * @return void
      *
@@ -225,7 +225,10 @@ public function __get($name)
             $this->buildType($name);
         }
 
-        return $this->types[$name];
+        /** @var GenericType $type */
+        $type = $this->types[$name];
+
+        return $type;
     }
 
     /**
@@ -244,13 +247,17 @@ public function __get($name)
      *
      * @param string $name The type name to build.
      *
-     * @return GenericType
+     * @return void
      *
      */
     protected function buildType($name)
     {
-        // instantiate and retain the type object. if we don't do this before
-        // building related fields, then we enter a race condition.
+        /**
+         * Instantiate and retain the type object. if we don't do this before
+         * building related fields, then we enter a race condition.
+         * 
+         * @var array<string, mixed> $info
+         */
         $info = $this->types[$name];
         $this->types[$name] = $this->type_builder->newInstance($info);
 
@@ -266,7 +273,7 @@ protected function buildType($name)
      *
      * Returns the names of all types in the manager.
      *
-     * @return array
+     * @return string[]
      *
      */
     public function getTypes()
@@ -278,7 +285,7 @@ public function getTypes()
      *
      * Unsets all entities in all types in the manager.
      *
-     * @return null
+     * @return void
      *
      */
     public function clear()

src/Relation/AbstractRelation.php

@@ -63,7 +63,7 @@ abstract class AbstractRelation
      *
      * The through type object.
      *
-     * @var GenericType
+     * @var ?GenericType
      *
      */
     protected $through;
@@ -73,7 +73,7 @@ abstract class AbstractRelation
      * Native and foreign entities are mapped to each other through this
      * association type.
      *
-     * @var string
+     * @var ?string
      *
      */
     protected $through_type;
@@ -83,7 +83,7 @@ abstract class AbstractRelation
      * The field name for the native side of the association mapping in the
      * "through" type.
      *
-     * @var string
+     * @var ?string
      *
      */
     protected $through_native_field;
@@ -93,7 +93,7 @@ abstract class AbstractRelation
      * The field name for the foreign side of the association mapping in the
      * "through" type.
      *
-     * @var string
+     * @var ?string
      *
      */
     protected $through_foreign_field;
@@ -112,12 +112,12 @@ abstract class AbstractRelation
      *
      * @param GenericType $through The through type object.
      *
-     * @param string $through_type The manager name of the through type.
+     * @param ?string $through_type The manager name of the through type.
      *
-     * @param string $through_native_field The name of the native field in
+     * @param ?string $through_native_field The name of the native field in
      * the through type.
      *
-     * @param string $through_foreign_field The name of the foreign field in
+     * @param ?string $through_foreign_field The name of the foreign field in
      * the through type.
      *
      */
@@ -126,7 +126,7 @@ public function __construct(
         GenericType $foreign,
         $foreign_type,
         $foreign_field,
-        GenericType $through = null,
+        ?GenericType $through = null,
         $through_type = null,
         $through_native_field = null,
         $through_foreign_field = null

src/Relation/BelongsTo.php

@@ -10,6 +10,8 @@
  */
 namespace Aura\Marshal\Relation;
 
+use Aura\Marshal\Entity\GenericEntity;
+
 /**
  *
  * Represents a relationship where the native entity belongs to a foreign
@@ -26,7 +28,7 @@ class BelongsTo extends AbstractRelation implements RelationInterface
      *
      * @param mixed $entity The native entity.
      *
-     * @return GenericEntity
+     * @return ?object
      *
      */
     public function getForEntity($entity)