more annottations

Author: ildyria

src/AncestorsRelation.php

@@ -5,7 +5,14 @@
 use Illuminate\Database\Eloquent\Model;
 
 /**
+ * @template Tmodelkey
+ * @template Tmodel of Model
+ * 
+ * @phpstan-type NodeModel Node<Tmodelkey,Tmodel>&Tmodel
+ * 
  * @disregard P1037
+ * 
+ * @extends BaseRelation<Tmodelkey,Tmodel>
  */
 class AncestorsRelation extends BaseRelation
 {
@@ -25,8 +32,8 @@ public function addConstraints()
 	}
 
 	/**
-	 * @param Model&Node $model
-	 * @param Node       $related
+	 * @param NodeModel $model
+	 * @param NodeModel $related
 	 *
 	 * @return bool
 	 */
@@ -36,8 +43,8 @@ protected function matches(Model $model, $related): bool
 	}
 
 	/**
-	 * @param QueryBuilder $query
-	 * @param Model        $model
+	 * @param QueryBuilder<Tmodelkey,Tmodel> $query
+	 * @param NodeModel        $model
 	 *
 	 * @return void
 	 */

src/BaseRelation.php

@@ -10,24 +10,26 @@
 
 /**
  * @template Tmodelkey
- * @template Tmodel of Model&Node<Tmodelkey,Model>
+ * @template Tmodel of Model
  *
- * @extends Relation<Tmodel>
+ * @phpstan-type NodeModel Node<Tmodelkey,Tmodel>&Tmodel
+ * 
+ * @extends Relation<NodeModel>
  *
- * @property Tmodel $related
- * @property Tmodel $parent
+ * @property NodeModel $related
+ * @property NodeModel $parent
  *
- * @method Tmodel getParent()
+ * @method NodeModel getParent()
  */
 abstract class BaseRelation extends Relation
 {
 	/**
-	 * @var QueryBuilder
+	 * @var QueryBuilder<Tmodelkey,Tmodel>
 	 */
 	protected $query;
 
 	/**
-	 * @var Node&Model
+	 * @var NodeModel
 	 */
 	protected $parent;
 
@@ -41,29 +43,29 @@ abstract class BaseRelation extends Relation
 	/**
 	 * AncestorsRelation constructor.
 	 *
-	 * @param QueryBuilder $builder
-	 * @param Model        $model
+	 * @param QueryBuilder<Tmodelkey,Tmodel> $builder
+	 * @param NodeModel        $model
 	 */
 	public function __construct(QueryBuilder $builder, Model $model)
 	{
 		if (!NestedSet::isNode($model)) {
 			throw new \InvalidArgumentException('Model must be node.');
 		}
-
+		/** @disregard P1006 */
 		parent::__construct($builder, $model);
 	}
 
 	/**
-	 * @param Model&Node $model
-	 * @param Node       $related
+	 * @param NodeModel $model
+	 * @param NodeModel $related
 	 *
 	 * @return bool
 	 */
 	abstract protected function matches(Model&Node $model, Node $related): bool;
 
 	/**
-	 * @param QueryBuilder $query
-	 * @param Model        $model
+	 * @param QueryBuilder<Tmodelkey,Tmodel> $query
+	 * @param NodeModel    $model
 	 *
 	 * @return void
 	 */
@@ -80,11 +82,11 @@ abstract protected function addEagerConstraint($query, $model);
 	abstract protected function relationExistenceCondition(string $hash, string $table, string $lft, string $rgt): string;
 
 	/**
-	 * @param EloquentBuilder $query
-	 * @param EloquentBuilder $parent
+	 * @param EloquentBuilder<NodeModel> $query
+	 * @param EloquentBuilder<NodeModel> $parent
 	 * @param mixed           $columns
 	 *
-	 * @return EloquentBuilder
+	 * @return EloquentBuilder<NodeModel>
 	 */
 	public function getRelationExistenceQuery(EloquentBuilder $query, EloquentBuilder $parent,
 		$columns = ['*']

src/Collection.php

@@ -7,9 +7,12 @@
 
 /**
  * @template TKey of array-key
- * @template TModel of Model&Node
+ * @template Tmodelkey
+ * @template Tmodel of Model
  *
- * @extends EloquentCollection<TKey, TModel>
+ * @phpstan-type NodeModel Node<Tmodelkey,Tmodel>&Tmodel
+ *
+ * @extends EloquentCollection<TKey,NodeModel>
  */
 final class Collection extends EloquentCollection
 {
@@ -26,17 +29,17 @@ public function linkNodes()
 			return $this;
 		}
 
-		/** @var Node */
+		/** @var NodeModel */
 		$first = $this->first();
 		$groupedNodes = $this->groupBy($first->getParentIdName());
 
-		/** @var Node&Model $node */
+		/** @var NodeModel $node */
 		foreach ($this->items as $node) {
 			if ($node->getParentId() === null) {
 				$node->setRelation('parent', null);
 			}
 
-			/** @var array<int,Model&Node> */
+			/** @var array<int,NodeModel> */
 			$children = $groupedNodes->get($node->getKey(), []);
 
 			foreach ($children as $child) {
@@ -58,7 +61,7 @@ public function linkNodes()
 	 *
 	 * @param mixed $root
 	 *
-	 * @return Collection
+	 * @return Collection<TKey,Tmodelkey,Tmodel>
 	 */
 	public function toTree($root = false)
 	{
@@ -72,7 +75,7 @@ public function toTree($root = false)
 
 		$root = $this->getRootNodeId($root);
 
-		/** @var Model&Node $node */
+		/** @var NodeModel $node */
 		foreach ($this->items as $node) {
 			if ($node->getParentId() === $root) {
 				$items[] = $node;
@@ -101,7 +104,7 @@ protected function getRootNodeId($root = false)
 		// least lft value as root node id.
 		$leastValue = null;
 
-		/** @var Model&Node $node */
+		/** @var NodeModel $node */
 		foreach ($this->items as $node) {
 			if ($leastValue === null || $node->getLft() < $leastValue) {
 				$leastValue = $node->getLft();
@@ -122,7 +125,7 @@ protected function getRootNodeId($root = false)
 	 *
 	 * @param bool $root
 	 *
-	 * @return Collection
+	 * @return Collection<TKey,Tmodelkey,Tmodel>
 	 */
 	public function toFlatTree($root = false): Collection
 	{
@@ -143,10 +146,10 @@ public function toFlatTree($root = false): Collection
 	/**
 	 * Flatten a tree into a non recursive array.
 	 *
-	 * @param Collection<int|string,TModel> $groupedNodes
+	 * @param Collection<int|string,Tmodelkey,Tmodel> $groupedNodes
 	 * @param int|string                    $parentId
 	 *
-	 * @return Collection
+	 * @return Collection<TKey,Tmodelkey,Tmodel>
 	 */
 	protected function flattenTree(Collection $groupedNodes, $parentId): Collection
 	{

src/DescendantsRelation.php

@@ -5,7 +5,14 @@
 use Illuminate\Database\Eloquent\Model;
 
 /**
+ * @template Tmodelkey
+ * @template Tmodel of Model
+ * 
+ * @phpstan-type NodeModel Node<Tmodelkey,Tmodel>&Tmodel
+ * 
  * @disregard P1037
+ * 
+ * @extends BaseRelation<Tmodelkey,Tmodel>
  */
 class DescendantsRelation extends BaseRelation
 {