Refactor for PHP8+

- Use constructor property promotion whenever possible
- Add some missing type hints that are now supported
- Amend some documentation
- Fix order of declared namespaces in generated repositories

psalm-baseline.xml

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.7.3@38c452ae584467e939d55377aaf83b5a26f19dd1">
+<files psalm-version="v4.15.0@a1b5e489e6fcebe40cb804793d964e99fc347820">
   <file src="src/MultiRepositoryReadOnly.php">
     <MissingConstructor occurrences="2">
       <code>$db</code>

src/Attribute/Entity.php

@@ -5,21 +5,12 @@
 #[\Attribute(\Attribute::TARGET_CLASS)]
 class Entity
 {
-    /**
-     * @var string Name of the SQL table
-     */
-    private string $name = '';
-
-    /**
-     * @var string Database connection - if empty the default connection is used
-     */
-    private string $connection = '';
-
-    public function __construct(string $name, string $connection = '')
-    {
-        $this->name = $name;
-        $this->connection = $connection;
-
+    public function __construct(
+        /** @var string Name of the SQL table */
+        private string $name,
+        /** @var string Database connection - if empty the default connection is used */
+        private string $connection = '',
+    ) {
         if (\strlen($this->name) === 0) {
             throw new \InvalidArgumentException('No name provided for entity');
         }

src/Attribute/EntityProcessor.php

@@ -13,7 +13,7 @@ class EntityProcessor
     /**
      * Processes a class according to its attributes
      *
-     * @psalm-param object|class-string $class
+     * @param object|class-string $class
      */
     public function process(object|string $class): ?RepositoryConfigInterface
     {

src/Attribute/Field.php

@@ -5,27 +5,14 @@
 #[\Attribute(\Attribute::TARGET_PROPERTY)]
 class Field
 {
-    /**
-     * @var string Name of the field in the SQL table
-     */
-    private string $name = '';
-
-    /**
-     * @var bool Whether this is the autoincrement field for the table - only one per table is legal!
-     */
-    private bool $autoincrement = false;
-
-    /**
-     * @var bool Whether this is a blob field (binary large object) - needed for Postgres compatibility
-     */
-    private bool $blob = false;
-
-    public function __construct(string $name, bool $autoincrement = false, bool $blob = false)
-    {
-        $this->name = $name;
-        $this->autoincrement = $autoincrement;
-        $this->blob = $blob;
-
+    public function __construct(
+        /** @var string Name of the field in the SQL table */
+        private string $name,
+        /** @var bool Whether this is the autoincrement field for the table - only one per table is legal! */
+        private bool $autoincrement = false,
+        /** @var bool Whether this is a blob field (binary large object) - needed for Postgres compatibility */
+        private bool $blob = false,
+    ) {
         if (\strlen($this->name) === 0) {
             throw new \InvalidArgumentException('No name provided for field');
         }

src/Builder/CountEntries.php

@@ -10,8 +10,6 @@
  */
 class CountEntries implements BuilderInterface
 {
-    private RepositoryReadOnlyInterface $repository;
-
     /**
      * @var array<int|string,mixed> WHERE restrictions in query
      */
@@ -22,9 +20,9 @@ class CountEntries implements BuilderInterface
      */
     private bool $blocking = false;
 
-    public function __construct(RepositoryReadOnlyInterface $repository)
-    {
-        $this->repository = $repository;
+    public function __construct(
+        private RepositoryReadOnlyInterface $repository,
+    ) {
     }
 
     /**

src/Builder/DeleteEntries.php

@@ -12,8 +12,6 @@
  */
 class DeleteEntries implements BuilderInterface
 {
-    private RepositoryWriteableInterface $repository;
-
     /**
      * @var array<int|string,mixed> WHERE restrictions in query
      */
@@ -24,9 +22,9 @@ class DeleteEntries implements BuilderInterface
      */
     private bool $confirmNoWhere = false;
 
-    public function __construct(RepositoryWriteableInterface $repository)
-    {
-        $this->repository = $repository;
+    public function __construct(
+        private RepositoryWriteableInterface $repository,
+    ) {
     }
 
     /**

src/Builder/InsertEntry.php

@@ -10,16 +10,14 @@
  */
 class InsertEntry implements BuilderInterface
 {
-    private RepositoryWriteableInterface $repository;
-
     /**
      * @var array<string,mixed> VALUES clauses for the query
      */
     private array $values = [];
 
-    public function __construct(RepositoryWriteableInterface $repository)
-    {
-        $this->repository = $repository;
+    public function __construct(
+        private RepositoryWriteableInterface $repository,
+    ) {
     }
 
     /**

src/Builder/InsertOrUpdateEntry.php

@@ -10,8 +10,6 @@
  */
 class InsertOrUpdateEntry implements BuilderInterface
 {
-    private RepositoryWriteableInterface $repository;
-
     /**
      * @var array<string,mixed> VALUES clauses for the query
      */
@@ -27,9 +25,9 @@ class InsertOrUpdateEntry implements BuilderInterface
      */
     private ?array $valuesOnUpdate = null;
 
-    public function __construct(RepositoryWriteableInterface $repository)
-    {
-        $this->repository = $repository;
+    public function __construct(
+        private RepositoryWriteableInterface $repository,
+    ) {
     }
 
     /**

src/Builder/MultiCountEntries.php

@@ -12,8 +12,6 @@
  */
 class MultiCountEntries implements BuilderInterface
 {
-    private MultiRepositoryReadOnlyInterface $queryHandler;
-
     /**
      * @var array<string,RepositoryBuilderReadOnlyInterface|RepositoryReadOnlyInterface> Repositories used in the multi query
      */
@@ -34,9 +32,9 @@ class MultiCountEntries implements BuilderInterface
      */
     private bool $blocking = false;
 
-    public function __construct(MultiRepositoryReadOnlyInterface $queryHandler)
-    {
-        $this->queryHandler = $queryHandler;
+    public function __construct(
+        private MultiRepositoryReadOnlyInterface $queryHandler,
+    ) {
     }
 
     /**

src/Builder/MultiSelectEntries.php

@@ -17,8 +17,6 @@ class MultiSelectEntries implements BuilderInterface, \IteratorAggregate
 {
     use FlattenedFieldsWithTypeTrait;
 
-    private MultiRepositoryReadOnlyInterface $queryHandler;
-
     /**
      * @var array<int|string,string> Only retrieve these fields of the repositories
      */
@@ -64,9 +62,9 @@ class MultiSelectEntries implements BuilderInterface, \IteratorAggregate
      */
     private bool $blocking = false;
 
-    public function __construct(MultiRepositoryReadOnlyInterface $queryHandler)
-    {
-        $this->queryHandler = $queryHandler;
+    public function __construct(
+        private MultiRepositoryReadOnlyInterface $queryHandler,
+    ) {
     }
 
     public function field(string $getThisField): self

src/Builder/MultiSelectEntriesFreeform.php

@@ -19,8 +19,6 @@ class MultiSelectEntriesFreeform implements BuilderInterface, \IteratorAggregate
 {
     use FlattenedFieldsWithTypeTrait;
 
-    private MultiRepositoryReadOnlyInterface $queryHandler;
-
     /**
      * @var array<int|string,string> Only retrieve these fields of the repositories
      */
@@ -46,9 +44,9 @@ class MultiSelectEntriesFreeform implements BuilderInterface, \IteratorAggregate
      */
     private bool $confirmBadPractice = false;
 
-    public function __construct(MultiRepositoryReadOnlyInterface $queryHandler)
-    {
-        $this->queryHandler = $queryHandler;
+    public function __construct(
+        private MultiRepositoryReadOnlyInterface $queryHandler,
+    ) {
     }
 
     public function field(string $getThisField): self

src/Builder/MultiSelectIterator.php

@@ -16,13 +16,13 @@ class MultiSelectIterator implements \Iterator, BuilderInterface
 {
     use SelectIteratorTrait;
 
-    private MultiRepositoryReadOnlyInterface $source;
     private ?MultiRepositorySelectQueryInterface $selectReference = null;
     private ?array $lastResult = null;
 
-    public function __construct(MultiRepositoryReadOnlyInterface $repository, array $query)
-    {
-        $this->source = $repository;
+    public function __construct(
+        private MultiRepositoryReadOnlyInterface $source,
+        array $query,
+    ) {
         $this->query = $query;
     }
 

src/Builder/MultiUpdateEntriesFreeform.php

@@ -14,8 +14,6 @@
  */
 class MultiUpdateEntriesFreeform implements BuilderInterface
 {
-    private MultiRepositoryWriteableInterface $queryHandler;
-
     /**
      * @var array<string,RepositoryBuilderWriteableInterface|RepositoryWriteableInterface> Repositories used in the multi query
      */
@@ -36,9 +34,9 @@ class MultiUpdateEntriesFreeform implements BuilderInterface
      */
     private bool $confirmBadPractice = false;
 
-    public function __construct(MultiRepositoryWriteableInterface $queryHandler)
-    {
-        $this->queryHandler = $queryHandler;
+    public function __construct(
+        private MultiRepositoryWriteableInterface $queryHandler,
+    ) {
     }
 
     /**

src/Builder/SelectIterator.php

@@ -16,13 +16,13 @@ class SelectIterator implements \Iterator, BuilderInterface
 {
     use SelectIteratorTrait;
 
-    private RepositoryReadOnlyInterface $source;
     private ?RepositorySelectQueryInterface $selectReference = null;
     private ?object $lastResult = null;
 
-    public function __construct(RepositoryReadOnlyInterface $repository, array $query)
-    {
-        $this->source = $repository;
+    public function __construct(
+        private RepositoryReadOnlyInterface $source,
+        array $query,
+    ) {
         $this->query = $query;
     }
 

src/Builder/UpdateEntries.php

@@ -12,8 +12,6 @@
  */
 class UpdateEntries implements BuilderInterface
 {
-    private RepositoryWriteableInterface $repository;
-
     /**
      * @var array<int|string,mixed> SET clauses for the query
      */
@@ -29,9 +27,9 @@ class UpdateEntries implements BuilderInterface
      */
     private bool $confirmNoWhere = false;
 
-    public function __construct(RepositoryWriteableInterface $repository)
-    {
-        $this->repository = $repository;
+    public function __construct(
+        private RepositoryWriteableInterface $repository,
+    ) {
     }
 
     /**

src/Generate/RepositoriesGenerateCommand.php

@@ -13,7 +13,7 @@ class RepositoriesGenerateCommand
     private array $repositoryPhpFileBlueprint = [
         'ReadOnly' => <<<'EOD'
 <?php
-// phpcs:ignoreFile -- created by SquirrelPHP library, do not alter
+// phpcs:ignoreFile -- created by SquirrelPHP entities library, do not alter
 /*
  * THIS FILE IS AUTOMATICALLY CREATED - DO NOT EDIT, DO NOT COMMIT TO VCS
  *
@@ -26,28 +26,6 @@ class RepositoriesGenerateCommand
  */
 // @codeCoverageIgnoreStart
 
-namespace {namespaceOfEntity} {
-    use Squirrel\Entities\RepositoryBuilderReadOnlyInterface;
-    use Squirrel\Entities\RepositoryReadOnlyInterface;
-
-    class {classOfEntity}RepositoryReadOnly implements RepositoryBuilderReadOnlyInterface
-    {
-        public function __construct(private RepositoryReadOnlyInterface $repository)
-        {
-        }
-
-        public function count(): \Squirrel\Entities\Builder\CountEntries
-        {
-            return new \Squirrel\Entities\Builder\CountEntries($this->repository);
-        }
-
-        public function select(): \{namespaceOfBuilders}\SelectEntries
-        {
-            return new \{namespaceOfBuilders}\SelectEntries($this->repository);
-        }
-    }
-}
-
 namespace {namespaceOfBuilders} {
     /**
      * @implements \Iterator<int,\{namespaceOfEntity}\{classOfEntity}>
@@ -116,6 +94,28 @@ public function getIterator(): SelectIterator
         }
     }
 }
+
+namespace {namespaceOfEntity} {
+    use Squirrel\Entities\RepositoryBuilderReadOnlyInterface;
+    use Squirrel\Entities\RepositoryReadOnlyInterface;
+
+    class {classOfEntity}RepositoryReadOnly implements RepositoryBuilderReadOnlyInterface
+    {
+        public function __construct(private RepositoryReadOnlyInterface $repository)
+        {
+        }
+
+        public function count(): \Squirrel\Entities\Builder\CountEntries
+        {
+            return new \Squirrel\Entities\Builder\CountEntries($this->repository);
+        }
+
+        public function select(): \{namespaceOfBuilders}\SelectEntries
+        {
+            return new \{namespaceOfBuilders}\SelectEntries($this->repository);
+        }
+    }
+}
 // @codeCoverageIgnoreEnd
 
 EOD

src/MultiRepositoryBuilderWriteable.php

@@ -16,6 +16,7 @@ public function __construct(?MultiRepositoryWriteableInterface $multiRepositoryW
         }
 
         $this->multiRepositoryWriteable = $multiRepositoryWriteable;
+
         parent::__construct($multiRepositoryWriteable);
     }