add docblock

ousid · ousid · commit 6b8145f7f774 · 2022-09-17T14:49:15.000+01:00
diff --git a/src/Scopes/ImportScope.php b/src/Scopes/ImportScope.php
@@ -27,7 +27,12 @@ public function scopeUnCompleted(Builder $builder): Builder
         return $builder->whereNull('completed_at');
     }
 
-    public function percentageComplete()
+    /**
+     * Get the percentage of the model completion
+     * 
+     * @return int
+     */
+    public function percentageComplete(): int
     {
         return floor(($this->processed_rows / $this->total_rows) * 100);
     }

Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,12 @@ public function scopeUnCompleted(Builder $builder): Builder`
`27`	`27`	`return $builder->whereNull('completed_at');`
`28`	`28`	`}`
`29`	`29`
`30`		`- public function percentageComplete()`
	`30`	`+ /**`
	`31`	`+ * Get the percentage of the model completion`
	`32`	`+ *`
	`33`	`+ * @return int`
	`34`	`+ */`
	`35`	`+ public function percentageComplete(): int`
`31`	`36`	`{`
`32`	`37`	`return floor(($this->processed_rows / $this->total_rows) * 100);`
`33`	`38`	`}`