[11.x] afterQuery hook (#50587)

* Add afterQuery hook

* Fix linting

* Some more linting fixes

* Support belongstomany and hasmanythrough

* formatting

* formatting

* formatting

* Support cursor() and pluck()

* Extra tests

* More tests + formatting

* Support filtering on cursor

* Fix parameter name

---------

Co-authored-by: Taylor Otwell <[email protected]>

Author: gdebrauwer

src/Illuminate/Database/Eloquent/Builder.php

@@ -17,6 +17,7 @@
 use Illuminate\Database\UniqueConstraintViolationException;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\ForwardsCalls;
 use ReflectionClass;
@@ -137,6 +138,13 @@ class Builder implements BuilderContract
      */
     protected $removedScopes = [];
 
+    /**
+     * The callbacks that should be invoked after retrieving data from the database.
+     *
+     * @var array
+     */
+    protected $afterQueryCallbacks = [];
+
     /**
      * Create a new Eloquent query builder instance.
      *
@@ -723,7 +731,9 @@ public function get($columns = ['*'])
             $models = $builder->eagerLoadRelations($models);
         }
 
-        return $builder->getModel()->newCollection($models);
+        return $this->applyAfterQueryCallbacks(
+            $builder->getModel()->newCollection($models)
+        );
     }
 
     /**
@@ -852,6 +862,34 @@ protected function isNestedUnder($relation, $name)
         return str_contains($name, '.') && str_starts_with($name, $relation.'.');
     }
 
+    /**
+     * Register a closure to be invoked after the query is executed.
+     *
+     * @param  \Closure  $callback
+     * @return $this
+     */
+    public function afterQuery(Closure $callback)
+    {
+        $this->afterQueryCallbacks[] = $callback;
+
+        return $this;
+    }
+
+    /**
+     * Invoke the "after query" modification callbacks.
+     *
+     * @param  mixed  $result
+     * @return mixed
+     */
+    public function applyAfterQueryCallbacks($result)
+    {
+        foreach ($this->afterQueryCallbacks as $afterQueryCallback) {
+            $result = $afterQueryCallback($result) ?: $result;
+        }
+
+        return $result;
+    }
+
     /**
      * Get a lazy collection for the given query.
      *
@@ -860,8 +898,10 @@ protected function isNestedUnder($relation, $name)
     public function cursor()
     {
         return $this->applyScopes()->query->cursor()->map(function ($record) {
-            return $this->newModelInstance()->newFromBuilder($record);
-        });
+            $model = $this->newModelInstance()->newFromBuilder($record);
+
+            return $this->applyAfterQueryCallbacks($this->newModelInstance()->newCollection([$model]))->first();
+        })->reject(fn ($model) => is_null($model));
     }
 
     /**
@@ -900,9 +940,11 @@ public function pluck($column, $key = null)
             return $results;
         }
 
-        return $results->map(function ($value) use ($column) {
-            return $this->model->newFromBuilder([$column => $value])->{$column};
-        });
+        return $this->applyAfterQueryCallbacks(
+            $results->map(function ($value) use ($column) {
+                return $this->model->newFromBuilder([$column => $value])->{$column};
+            })
+        );
     }
 
     /**

src/Illuminate/Database/Eloquent/Relations/BelongsToMany.php

@@ -883,7 +883,9 @@ public function get($columns = ['*'])
             $models = $builder->eagerLoadRelations($models);
         }
 
-        return $this->related->newCollection($models);
+        return $this->query->applyAfterQueryCallbacks(
+            $this->related->newCollection($models)
+        );
     }
 
     /**

src/Illuminate/Database/Eloquent/Relations/HasManyThrough.php

@@ -505,7 +505,9 @@ public function get($columns = ['*'])
             $models = $builder->eagerLoadRelations($models);
         }
 
-        return $this->related->newCollection($models);
+        return $this->query->applyAfterQueryCallbacks(
+            $this->related->newCollection($models)
+        );
     }
 
     /**

src/Illuminate/Database/Query/Builder.php

@@ -208,6 +208,13 @@ class Builder implements BuilderContract
      */
     public $beforeQueryCallbacks = [];
 
+    /**
+     * The callbacks that should be invoked after retrieving data from the database.
+     *
+     * @var array
+     */
+    protected $afterQueryCallbacks = [];
+
     /**
      * All of the available clause operators.
      *
@@ -2770,6 +2777,34 @@ public function applyBeforeQueryCallbacks()
         $this->beforeQueryCallbacks = [];
     }
 
+    /**
+     * Register a closure to be invoked after the query is executed.
+     *
+     * @param  \Closure  $callback
+     * @return $this
+     */
+    public function afterQuery(Closure $callback)
+    {
+        $this->afterQueryCallbacks[] = $callback;
+
+        return $this;
+    }
+
+    /**
+     * Invoke the "after query" modification callbacks.
+     *
+     * @param  mixed  $result
+     * @return mixed
+     */
+    public function applyAfterQueryCallbacks($result)
+    {
+        foreach ($this->afterQueryCallbacks as $afterQueryCallback) {
+            $result = $afterQueryCallback($result) ?: $result;
+        }
+
+        return $result;
+    }
+
     /**
      * Get the SQL representation of the query.
      *
@@ -2884,9 +2919,9 @@ public function get($columns = ['*'])
             return $this->processor->processSelect($this, $this->runSelect());
         }));
 
-        return isset($this->groupLimit)
-            ? $this->withoutGroupLimitKeys($items)
-            : $items;
+        return $this->applyAfterQueryCallbacks(
+            isset($this->groupLimit) ? $this->withoutGroupLimitKeys($items) : $items
+        );
     }
 
     /**
@@ -3114,11 +3149,13 @@ public function cursor()
             $this->columns = ['*'];
         }
 
-        return new LazyCollection(function () {
+        return (new LazyCollection(function () {
             yield from $this->connection->cursor(
                 $this->toSql(), $this->getBindings(), ! $this->useWritePdo
             );
-        });
+        }))->map(function ($item) {
+            return $this->applyAfterQueryCallbacks(collect([$item]))->first();
+        })->reject(fn ($item) => is_null($item));
     }
 
     /**
@@ -3167,9 +3204,11 @@ function () {
 
         $key = $this->stripTableForPluck($key);
 
-        return is_array($queryResult[0])
+        return $this->applyAfterQueryCallbacks(
+            is_array($queryResult[0])
                     ? $this->pluckFromArrayColumn($queryResult, $column, $key)
-                    : $this->pluckFromObjectColumn($queryResult, $column, $key);
+                    : $this->pluckFromObjectColumn($queryResult, $column, $key)
+        );
     }
 
     /**