PHPStan lvl 4 & Fix/issue 233 followup

phpstan.neon.dist

@@ -2,7 +2,7 @@ includes:
     - ./vendor/larastan/larastan/extension.neon
     - ./vendor/phpstan/phpstan-mockery/extension.neon
 parameters:
-    level: 2
+    level: 4
     paths:
         - src
         - tests
@@ -14,3 +14,5 @@ parameters:
         - '#Call to an undefined method TModel of Illuminate\\Database\\Eloquent\\Model#'
         - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Model::#'
         - '#Call to an undefined method Illuminate\\Database\\Eloquent\\Builder#'
+        - identifier: expr.resultUnused
+          path: tests

src/Eloquent/Graph/Collection.php

@@ -16,7 +16,8 @@ class Collection extends Base
      * Generate a nested tree.
      *
      * @param string $childrenRelation
-     * @return $this<int, TModel>
+     * @return static<TKey, TModel>
+     * @phpstan-ignore return.phpDocType
      */
     public function toTree(string $childrenRelation = 'children'): static
     {

src/Eloquent/Relations/BelongsToManyOfDescendants.php

@@ -23,8 +23,8 @@ class BelongsToManyOfDescendants extends BelongsToMany
      * Create a new belongs to many of descendants relationship instance.
      *
      * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
-     * @param string $table
+     * @param TRelatedModel $parent
+     * @param string|class-string<TRelatedModel> $table
      * @param string $foreignPivotKey
      * @param string $relatedPivotKey
      * @param string $parentKey

src/Eloquent/Relations/Bloodline.php

@@ -15,8 +15,8 @@ class Bloodline extends Descendants
     /**
      * Create a new bloodline relationship instance.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
+     * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
+     * @param TRelatedModel $parent
      * @param string $foreignKey
      * @param string $localKey
      * @return void

src/Eloquent/Relations/Descendants.php

@@ -47,7 +47,7 @@ public function addConstraints()
     /**
      * Set the constraints for an eager load of the relation.
      *
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraints(array $models)
@@ -68,8 +68,8 @@ public function addEagerConstraints(array $models)
     /**
      * Match the eagerly loaded results to their parents.
      *
-     * @param array $models
-     * @param \Illuminate\Database\Eloquent\Collection $results
+     * @param \Illuminate\Database\Eloquent\Model[] $models
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
      * @param string $relation
      * @return array
      */
@@ -93,8 +93,8 @@ public function match(array $models, Collection $results, $relation)
     /**
      * Build model dictionary.
      *
-     * @param \Illuminate\Database\Eloquent\Collection $results
-     * @return array
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
+     * @return array<string, \Illuminate\Database\Eloquent\Model[]>
      */
     protected function buildDictionary(Collection $results)
     {

src/Eloquent/Relations/Graph/Ancestors.php

@@ -47,7 +47,7 @@ public function addConstraints()
     /**
      * Set the constraints for an eager load of the relation.
      *
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraints(array $models)
@@ -60,8 +60,8 @@ public function addEagerConstraints(array $models)
     /**
      * Build model dictionary.
      *
-     * @param \Illuminate\Database\Eloquent\Collection $results
-     * @return array
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
+     * @return array<string, \Illuminate\Database\Eloquent\Model[]>
      */
     protected function buildDictionary(Collection $results)
     {

src/Eloquent/Relations/Graph/Descendants.php

@@ -47,7 +47,7 @@ public function addConstraints()
     /**
      * Set the constraints for an eager load of the relation.
      *
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraints(array $models)
@@ -60,8 +60,8 @@ public function addEagerConstraints(array $models)
     /**
      * Build model dictionary.
      *
-     * @param \Illuminate\Database\Eloquent\Collection $results
-     * @return array
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
+     * @return array<string, \Illuminate\Database\Eloquent\Model[]>
      */
     protected function buildDictionary(Collection $results)
     {

src/Eloquent/Relations/Graph/Traits/Concatenation/IsConcatenableRelation.php

@@ -99,7 +99,7 @@ protected function replacePathSeparator(Collection $models, string $column, stri
      * Set the constraints for an eager load of the deep relation.
      *
      * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraintsToDeepRelationship(Builder $query, array $models): void
@@ -140,8 +140,8 @@ protected function mergeExpressions(Builder $query, Builder $from): Builder
     /**
      * Match the eagerly loaded results for a deep relationship to their parents.
      *
-     * @param array $models
-     * @param \Illuminate\Database\Eloquent\Collection $results
+     * @param \Illuminate\Database\Eloquent\Model[] $models
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
      * @param string $relation
      * @param string $type
      * @return array
@@ -174,8 +174,8 @@ public function matchResultsForDeepRelationship(
     /**
      * Build the model dictionary for a deep relation.
      *
-     * @param \Illuminate\Database\Eloquent\Collection $results
-     * @return array
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
+     * @return array<string, \Illuminate\Database\Eloquent\Model[]>
      */
     protected function buildDictionaryForDeepRelationship(Collection $results): array
     {

src/Eloquent/Relations/Graph/Traits/IsRecursiveRelation.php

@@ -47,7 +47,7 @@ public function __construct(
     /**
      * Add the recursive expression for an eager load of the relation.
      *
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @param string $column
      * @return void
      */
@@ -75,8 +75,8 @@ protected function addEagerExpression(array $models, string $column): void
     /**
      * Build model dictionary.
      *
-     * @param \Illuminate\Database\Eloquent\Collection $results
-     * @return array
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
+     * @return array<string, \Illuminate\Database\Eloquent\Model[]>
      */
     protected function buildDictionary(Collection $results)
     {

src/Eloquent/Relations/HasManyOfDescendants.php

@@ -20,7 +20,7 @@ class HasManyOfDescendants extends HasMany
      * Create a new has many of descendants relationship instance.
      *
      * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
+     * @param TRelatedModel $parent
      * @param string $foreignKey
      * @param string $localKey
      * @param bool $andSelf

src/Eloquent/Relations/MorphToManyOfDescendants.php

@@ -22,7 +22,7 @@ class MorphToManyOfDescendants extends BelongsToManyOfDescendants
     /**
      * The class name of the morph type constraint.
      *
-     * @var string
+     * @var class-string<TRelatedModel>
      */
     protected $morphClass;
 
@@ -41,7 +41,7 @@ class MorphToManyOfDescendants extends BelongsToManyOfDescendants
      * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
      * @param \Illuminate\Database\Eloquent\Model $parent
      * @param string $name
-     * @param string $table
+     * @param string|class-string<TRelatedModel> $table
      * @param string $foreignPivotKey
      * @param string $relatedPivotKey
      * @param string $parentKey
@@ -97,7 +97,7 @@ protected function addExpressionWhereConstraints(Builder $query)
      * Set the where clause on the recursive expression query for an eager load of the relation.
      *
      * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerExpressionWhereConstraints(Builder $query, array $models)

src/Eloquent/Relations/RootAncestor.php

@@ -22,8 +22,8 @@ class RootAncestor extends HasOne
     /**
      * Create a new root ancestor relationship instance.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
+     * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
+     * @param TRelatedModel $parent
      * @param string $foreignKey
      * @param string $localKey
      * @return void

src/Eloquent/Relations/RootAncestorOrSelf.php

@@ -15,8 +15,8 @@ class RootAncestorOrSelf extends RootAncestor
     /**
      * Create a new root ancestor or self relationship instance.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
+     * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
+     * @param TRelatedModel $parent
      * @param string $foreignKey
      * @param string $localKey
      * @return void

src/Eloquent/Relations/Siblings.php

@@ -24,8 +24,8 @@
     /**
      * Create a new siblings relationship instance.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Model $parent
+     * @param \Illuminate\Database\Eloquent\Builder<TRelatedModel> $query
+     * @param TRelatedModel $parent
      * @param string $foreignKey
      * @param string $localKey
      * @param bool $andSelf
@@ -65,7 +65,7 @@
     /**
      * Set the constraints for an eager load of the relation.
      *
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraints(array $models)
@@ -76,7 +76,7 @@
             function (Builder $query) use ($keys) {
                 $query->whereIn($this->foreignKey, $keys);
 
                 if (in_array(null, $keys, true)) {
                     $query->orWhereNull($this->foreignKey);
                 }
             }
@@ -86,8 +86,8 @@
     /**
      * Match the eagerly loaded results to their parents.
      *
-     * @param array $models
-     * @param \Illuminate\Database\Eloquent\Collection $results
+     * @param \Illuminate\Database\Eloquent\Model[] $models
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
      * @param string $relation
      * @return array
      */

src/Eloquent/Relations/Traits/Concatenation/IsConcatenableAncestorsRelation.php

@@ -14,7 +14,7 @@ trait IsConcatenableAncestorsRelation
      * Set the constraints for an eager load of the deep relation.
      *
      * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraintsToDeepRelationship(Builder $query, array $models): void
@@ -27,8 +27,8 @@ public function addEagerConstraintsToDeepRelationship(Builder $query, array $mod
     /**
      * Match the eagerly loaded results for a deep relationship to their parents.
      *
-     * @param array $models
-     * @param \Illuminate\Database\Eloquent\Collection $results
+     * @param \Illuminate\Database\Eloquent\Model[] $models
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
      * @param string $relation
      * @param string $type
      * @return array
@@ -61,8 +61,8 @@ public function matchResultsForDeepRelationship(
     /**
      * Build the model dictionary for a deep relation.
      *
-     * @param \Illuminate\Database\Eloquent\Collection $results
-     * @return array
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
+     * @return array<string, \Illuminate\Database\Eloquent\Model[]>
      */
     protected function buildDictionaryForDeepRelationship(Collection $results): array
     {

src/Eloquent/Relations/Traits/Concatenation/IsConcatenableDescendantsRelation.php

@@ -14,7 +14,7 @@ trait IsConcatenableDescendantsRelation
      * Set the constraints for an eager load of the deep relation.
      *
      * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraintsToDeepRelationship(Builder $query, array $models): void
@@ -33,8 +33,8 @@ public function addEagerConstraintsToDeepRelationship(Builder $query, array $mod
     /**
      * Match the eagerly loaded results for a deep relationship to their parents.
      *
-     * @param array $models
-     * @param \Illuminate\Database\Eloquent\Collection $results
+     * @param \Illuminate\Database\Eloquent\Model[] $models
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
      * @param string $relation
      * @param string $type
      * @return array
@@ -65,8 +65,8 @@ public function matchResultsForDeepRelationship(
     /**
      * Build the model dictionary for a deep relation.
      *
-     * @param \Illuminate\Database\Eloquent\Collection $results
-     * @return array
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
+     * @return array<string, \Illuminate\Database\Eloquent\Model[]>
      */
     protected function buildDictionaryForDeepRelationship(Collection $results): array
     {

src/Eloquent/Relations/Traits/IsAncestorRelation.php

@@ -31,7 +31,7 @@ public function addConstraints()
     /**
      * Set the constraints for an eager load of the relation.
      *
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @return void
      */
     public function addEagerConstraints(array $models)
@@ -52,7 +52,7 @@ public function addEagerConstraints(array $models)
     /**
      * Get all of the primary keys for an array of models.
      *
-     * @param array $models
+     * @param \Illuminate\Database\Eloquent\Model[] $models
      * @param string $key
      * @return array
      */
@@ -68,8 +68,8 @@ protected function getKeys(array $models, $key = null)
     /**
      * Match the eagerly loaded results to their many parents.
      *
-     * @param array $models
-     * @param \Illuminate\Database\Eloquent\Collection $results
+     * @param \Illuminate\Database\Eloquent\Model[] $models
+     * @param \Illuminate\Database\Eloquent\Collection<array-key, \Illuminate\Database\Eloquent\Model> $results
      * @param string $relation
      * @param string $type
      * @return array
@@ -96,10 +96,10 @@ public function matchOneOrMany(array $models, Collection $results, $relation, $t
     /**
      * Add the constraints for a relationship query.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Builder $parentQuery
+     * @param \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model> $query
+     * @param \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model> $parentQuery
      * @param array|mixed $columns
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model>
      */
     public function getRelationExistenceQuery(Builder $query, Builder $parentQuery, $columns = ['*'])
     {
@@ -123,10 +123,10 @@ public function getRelationExistenceQuery(Builder $query, Builder $parentQuery,
     /**
      * Add the constraints for a relationship query on the same table.
      *
-     * @param \Illuminate\Database\Eloquent\Builder $query
-     * @param \Illuminate\Database\Eloquent\Builder $parentQuery
+     * @param \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model> $query
+     * @param \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model> $parentQuery
      * @param array|mixed $columns
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model>
      */
     public function getRelationExistenceQueryForSelfRelation(Builder $query, Builder $parentQuery, $columns = ['*'])
     {
@@ -157,9 +157,9 @@ public function getRelationExistenceQueryForSelfRelation(Builder $query, Builder
      * Add a recursive expression to the query.
      *
      * @param callable $constraint
-     * @param \Illuminate\Database\Eloquent\Builder|null $query
+     * @param \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model>|null $query
      * @param string|null $from
-     * @return \Illuminate\Database\Eloquent\Builder
+     * @return \Staudenmeir\LaravelAdjacencyList\Eloquent\Builder<\Illuminate\Database\Eloquent\Model>
      */
     protected function addExpression(callable $constraint, ?Builder $query = null, $from = null)
     {