some annotations

Author: ildyria

src/Collection.php

@@ -13,6 +13,8 @@
  * @phpstan-type NodeModel \Kalnoy\Nestedset\Contracts\Node<Tmodel>&Model
  *
  * @extends EloquentCollection<array-key,NodeModel>
+ *
+ * @implements NestedSetCollection<Tmodel>
  */
 final class Collection extends EloquentCollection implements NestedSetCollection
 {

src/Contracts/NestedSetCollection.php

@@ -5,12 +5,12 @@
 /**
  * @template-covariant Tmodel of \Illuminate\Database\Eloquent\Model
  *
- * @phpstan-type NodeModel Node<Tmodel>
+ * @phpstan-type NodeModel Node<Tmodel>&Tmodel
  *
  * @require-extends \Illuminate\Database\Eloquent\Collection
  *
- * @method NestedSetCollection  groupBy(string $column)
- * @method array<int,NodeModel> all()
+ * @method NestedSetCollection<NodeModel> groupBy(string $column)
+ * @method array<int,NodeModel>           all()
  */
 interface NestedSetCollection
 {
@@ -19,7 +19,7 @@ interface NestedSetCollection
 	 *
 	 * This will overwrite any previously set relations.
 	 *
-	 * @return $this
+	 * @return NestedSetCollection<Tmodel>
 	 */
 	public function linkNodes();
 

src/Contracts/Node.php

@@ -27,15 +27,15 @@
  *
  * @require-extends \Illuminate\Database\Eloquent\Model
  *
- * @method mixed  getKey()
- * @method mixed  getKeyName()
- * @method Node   setRelation($relation, $value)
- * @method mixed  save()
- * @method string getTable()
- * @method mixed  getAttribute($key)
- * @method string getDeletedAtColumn()
- * @method Node   getRelationValue($key)
- * @method bool   usesSoftDelete()
+ * @method mixed        getKey()
+ * @method mixed        getKeyName()
+ * @method Node<Tmodel> setRelation($relation, $value)
+ * @method mixed        save()
+ * @method string       getTable()
+ * @method mixed        getAttribute($key)
+ * @method string       getDeletedAtColumn()
+ * @method Node<Tmodel> getRelationValue($key)
+ * @method bool         usesSoftDelete()
  */
 interface Node
 {

src/QueryBuilder.php

@@ -215,9 +215,9 @@ public function orWhereNodeBetween(array $values): NodeQueryBuilder
 	 * @since 2.0
 	 *
 	 * @param ?Node<Tmodel> $id
-	 * @param string     $boolean
-	 * @param bool       $not
-	 * @param bool       $andSelf
+	 * @param string        $boolean
+	 * @param bool          $not
+	 * @param bool          $andSelf
 	 *
 	 * @return QueryBuilder<Tmodel>
 	 */
@@ -271,8 +271,8 @@ public function orWhereNotDescendantOf(mixed $id): NodeQueryBuilder
 
 	/**
 	 * @param Node<Tmodel> $id
-	 * @param string    $boolean
-	 * @param bool      $not
+	 * @param string       $boolean
+	 * @param bool         $not
 	 *
 	 * @return QueryBuilder<Tmodel>
 	 */
@@ -868,7 +868,7 @@ public function fixTree($root = null): int
 
 		$dictionary = $this->model
 			->newNestedSetQuery()
-			->when($root !== null, function (self $query) use ($root) { 
+			->when($root !== null, function (self $query) use ($root) {
 				return $query->whereDescendantOf($root);
 			})
 			->defaultOrder()

tests/models/Category.php

@@ -11,13 +11,14 @@
 class Category extends Model implements Node
 {
 	use SoftDeletes;
+	/** @use NodeTrait<Category,int> */
 	use NodeTrait;
 
 	protected $fillable = ['name', 'parent_id'];
 
 	public $timestamps = false;
 
-	public static function resetActionsPerformed()
+	public static function resetActionsPerformed(): void
 	{
 		static::$actionsPerformed = 0;
 	}

tests/models/DuplicateCategory.php

@@ -9,6 +9,7 @@
  */
 class DuplicateCategory extends Model implements Node
 {
+	/** @use NodeTrait<DuplicateCategory,int> */
 	use NodeTrait;
 
 	protected $table = 'categories';

tests/models/MenuItem.php

@@ -9,18 +9,22 @@
  */
 class MenuItem extends Model implements Node
 {
+	/** @use NodeTrait<MenuItem,int> */
 	use NodeTrait;
 
 	public $timestamps = false;
 
 	protected $fillable = ['menu_id', 'parent_id'];
 
-	public static function resetActionsPerformed()
+	public static function resetActionsPerformed(): void
 	{
 		static::$actionsPerformed = 0;
 	}
 
-	protected function getScopeAttributes()
+	/**
+	 * @return list<string>
+	 */
+	protected function getScopeAttributes(): array
 	{
 		return ['menu_id'];
 	}