Optimized the PHPDoc for hyperf/database. (#7511)

Author: storyn26383

src/Concerns/BuildsQueries.php

@@ -23,7 +23,6 @@
 use Hyperf\Database\Exception\RecordsNotFoundException;
 use Hyperf\Database\Model\Builder;
 use Hyperf\Database\Model\Collection;
-use Hyperf\Database\Model\Model;
 use Hyperf\Database\Query\Expression;
 use Hyperf\Paginator\Contract\CursorPaginator as CursorPaginatorContract;
 use Hyperf\Paginator\Cursor;
@@ -36,7 +35,7 @@
 use function Hyperf\Collection\data_get;
 
 /**
- * @template TValue
+ * @template TValue of object
  * @mixin Builder
  * @mixin \Hyperf\Database\Query\Builder
  */
@@ -48,6 +47,7 @@ trait BuildsQueries
      * Chunk the results of the query.
      *
      * @param int $count
+     * @param callable(BaseCollection<int, TValue>, int): mixed $callback
      * @return bool
      */
     public function chunk($count, callable $callback)
@@ -85,6 +85,8 @@ public function chunk($count, callable $callback)
 
     /**
      * Run a map over each item while chunking.
+     *
+     * @param callable(TValue): mixed $callback
      */
     public function chunkMap(callable $callback, int $count = 1000): BaseCollection
     {
@@ -102,6 +104,7 @@ public function chunkMap(callable $callback, int $count = 1000): BaseCollection
     /**
      * Execute a callback over each item while chunking.
      *
+     * @param callable(TValue, int): mixed $callback
      * @param int $count
      * @return bool
      */
@@ -118,6 +121,8 @@ public function each(callable $callback, $count = 1000)
 
     /**
      * Query lazily, by chunks of the given size.
+     *
+     * @return LazyCollection<int, TValue>
      */
     public function lazy(int $chunkSize = 1000): LazyCollection
     {
@@ -146,6 +151,8 @@ public function lazy(int $chunkSize = 1000): LazyCollection
 
     /**
      * Query lazily, by chunking the results of a query by comparing IDs.
+     *
+     * @return LazyCollection<int, TValue>
      */
     public function lazyById(int $chunkSize = 1000, ?string $column = null, ?string $alias = null): LazyCollection
     {
@@ -154,6 +161,8 @@ public function lazyById(int $chunkSize = 1000, ?string $column = null, ?string
 
     /**
      * Query lazily, by chunking the results of a query by comparing IDs in descending order.
+     *
+     * @return LazyCollection<int, TValue>
      */
     public function lazyByIdDesc(int $chunkSize = 1000, ?string $column = null, ?string $alias = null): LazyCollection
     {
@@ -164,7 +173,7 @@ public function lazyByIdDesc(int $chunkSize = 1000, ?string $column = null, ?str
      * Execute the query and get the first result.
      *
      * @param array $columns
-     * @return null|Model|object|static
+     * @return null|TValue
      */
     public function first($columns = ['*'])
     {
@@ -173,6 +182,8 @@ public function first($columns = ['*'])
 
     /**
      * Execute a callback over each item while chunking by ID.
+     *
+     * @param callable(TValue, int): mixed $callback
      */
     public function eachById(callable $callback, int $count = 1000, ?string $column = null, ?string $alias = null): bool
     {
@@ -188,6 +199,8 @@ public function eachById(callable $callback, int $count = 1000, ?string $column
 
     /**
      * Chunk the results of a query by comparing IDs in a given order.
+     *
+     * @param callable(BaseCollection<int, TValue>, int): mixed $callback
      */
     public function orderedChunkById(int $count, callable $callback, ?string $column = null, ?string $alias = null, bool $descending = false): bool
     {
@@ -240,6 +253,8 @@ public function orderedChunkById(int $count, callable $callback, ?string $column
 
     /**
      * Chunk the results of a query by comparing IDs in descending order.
+     *
+     * @param callable(BaseCollection<int, TValue>, int): mixed $callback
      */
     public function chunkByIdDesc(int $count, callable $callback, ?string $column = null, ?string $alias = null): bool
     {