phpstan typing progress

LycheeOrg · Jun 8, 2024 · 5644895 · 5644895
1 parent ddcfb3d
commit 5644895
Show file tree

Hide file tree

Showing 9 changed files with 173 additions and 217 deletions.
diff --git a/phpstan.neon b/phpstan.neon
@@ -8,4 +8,5 @@ parameters:
 	excludePaths:
 	stubFiles:
 	ignoreErrors:
-		- identifier: missingType.generics
+		- identifier: missingType.generics
+		- '#Interface must be located in "Contract" or "Contracts" namespace#'
diff --git a/src/AncestorsRelation.php b/src/AncestorsRelation.php
@@ -4,6 +4,9 @@
 
 use Illuminate\Database\Eloquent\Model;
 
+/**
+ * @template T
+ */
 class AncestorsRelation extends BaseRelation
 {
 	/**
@@ -44,14 +47,9 @@ protected function addEagerConstraint($query, $model)
 	}
 
 	/**
-	 * @param $hash
-	 * @param $table
-	 * @param $lft
-	 * @param $rgt
-	 *
-	 * @return string
+	 * {@inheritdoc}
 	 */
-	protected function relationExistenceCondition($hash, $table, $lft, $rgt)
+	protected function relationExistenceCondition(string $hash, string $table, string $lft, string $rgt): string
 	{
 		$key = $this->getBaseQuery()->getGrammar()->wrap($this->parent->getKeyName());
 

diff --git a/src/BaseRelation.php b/src/BaseRelation.php
@@ -16,7 +16,7 @@ abstract class BaseRelation extends Relation
 	protected $query;
 
 	/**
-	 * @var NodeTrait|Model
+	 * @var Node&Model
 	 */
 	protected $parent;
 
@@ -59,19 +59,19 @@ abstract protected function matches(Model $model, $related);
 	abstract protected function addEagerConstraint($query, $model);
 
 	/**
-	 * @param $hash
-	 * @param $table
-	 * @param $lft
-	 * @param $rgt
+	 * @param string $hash
+	 * @param string $table
+	 * @param string $lft
+	 * @param string $rgt
 	 *
 	 * @return string
 	 */
-	abstract protected function relationExistenceCondition($hash, $table, $lft, $rgt);
+	abstract protected function relationExistenceCondition(string $hash, string $table, string $lft, string $rgt): string;
 
 	/**
 	 * @param EloquentBuilder $query
 	 * @param EloquentBuilder $parent
-	 * @param array           $columns
+	 * @param string[]        $columns
 	 *
 	 * @return mixed
 	 */

diff --git a/src/Collection.php b/src/Collection.php
@@ -22,15 +22,15 @@ public function linkNodes()
 
 		$groupedNodes = $this->groupBy($this->first()->getParentIdName());
 
-		/** @var NodeTrait|Model $node */
+		/** @var Node&Model $node */
 		foreach ($this->items as $node) {
-			if (!$node->getParentId()) {
+			if ($node->getParentId() === null) {
 				$node->setRelation('parent', null);
 			}
 
 			$children = $groupedNodes->get($node->getKey(), []);
 
-			/** @var Model|NodeTrait $child */
+			/** @var Model&Node $child */
 			foreach ($children as $child) {
 				$child->setRelation('parent', $node);
 			}
@@ -64,9 +64,9 @@ public function toTree($root = false)
 
 		$root = $this->getRootNodeId($root);
 
-		/** @var Model|NodeTrait $node */
+		/** @var Model&Node $node */
 		foreach ($this->items as $node) {
-			if ($node->getParentId() == $root) {
+			if ($node->getParentId() === $root) {
 				$items[] = $node;
 			}
 		}
@@ -77,7 +77,7 @@ public function toTree($root = false)
 	/**
 	 * @param mixed $root
 	 *
-	 * @return int
+	 * @return int|string|null
 	 */
 	protected function getRootNodeId($root = false)
 	{
@@ -93,7 +93,7 @@ protected function getRootNodeId($root = false)
 		// least lft value as root node id.
 		$leastValue = null;
 
-		/** @var Model|NodeTrait $node */
+		/** @var Model&Node $node */
 		foreach ($this->items as $node) {
 			if ($leastValue === null || $node->getLft() < $leastValue) {
 				$leastValue = $node->getLft();

diff --git a/src/DescendantsRelation.php b/src/DescendantsRelation.php
@@ -42,14 +42,9 @@ protected function matches(Model $model, $related)
 	}
 
 	/**
-	 * @param $hash
-	 * @param $table
-	 * @param $lft
-	 * @param $rgt
-	 *
-	 * @return string
+	 * {@inheritdoc}
 	 */
-	protected function relationExistenceCondition($hash, $table, $lft, $rgt)
+	protected function relationExistenceCondition(string $hash, string $table, string $lft, string $rgt): string
 	{
 		return "{$hash}.{$lft} between {$table}.{$lft} + 1 and {$table}.{$rgt}";
 	}

diff --git a/src/NestedSet.php b/src/NestedSet.php
@@ -36,7 +36,7 @@ class NestedSet
 	 *
 	 * @param \Illuminate\Database\Schema\Blueprint $table
 	 */
-	public static function columns(Blueprint $table)
+	public static function columns(Blueprint $table): void
 	{
 		$table->unsignedInteger(self::LFT)->default(0);
 		$table->unsignedInteger(self::RGT)->default(0);
@@ -50,7 +50,7 @@ public static function columns(Blueprint $table)
 	 *
 	 * @param \Illuminate\Database\Schema\Blueprint $table
 	 */
-	public static function dropColumns(Blueprint $table)
+	public static function dropColumns(Blueprint $table): void
 	{
 		$columns = static::getDefaultColumns();
 
@@ -61,9 +61,9 @@ public static function dropColumns(Blueprint $table)
 	/**
 	 * Get a list of default columns.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
-	public static function getDefaultColumns()
+	public static function getDefaultColumns(): array
 	{
 		return [static::LFT, static::RGT, static::PARENT_ID];
 	}
@@ -75,7 +75,7 @@ public static function getDefaultColumns()
 	 *
 	 * @return bool
 	 */
-	public static function isNode($node)
+	public static function isNode(mixed $node): bool
 	{
 		return $node instanceof Node;
 	}