Implement hook support on Models

laravel · inxilpro · Dec 8, 2021 · Dec 8, 2021 · Dec 8, 2021 · Dec 8, 2021
commit 40a91568c7a2d3cc001a15a07e801de79cd057cd
diff --git a/src/Illuminate/Contracts/Support/Hook.php b/src/Illuminate/Contracts/Support/Hook.php
@@ -40,4 +40,18 @@ public function run($instance, array $arguments = []);
      * @param  array  $arguments
      */
     public function cleanup($instance, array $arguments = []);
+
+    /**
+     * Get the name of the hook.
+     *
+     * @return string
+     */
+    public function getName();
+
+    /**
+     * Get the priority of the hook.
+     *
+     * @return int
+     */
+    public function getPriority();
 }
diff --git a/src/Illuminate/Database/Eloquent/Model.php b/src/Illuminate/Database/Eloquent/Model.php
@@ -18,6 +18,8 @@
 use Illuminate\Database\Eloquent\Relations\Pivot;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection as BaseCollection;
+use Illuminate\Support\Hookable;
+use Illuminate\Support\Hooks\TraitHook;
 use Illuminate\Support\Str;
 use Illuminate\Support\Traits\ForwardsCalls;
 use JsonSerializable;
@@ -32,7 +34,8 @@ abstract class Model implements Arrayable, ArrayAccess, CanBeEscapedWhenCastToSt
         Concerns\HasTimestamps,
         Concerns\HidesAttributes,
         Concerns\GuardsAttributes,
-        ForwardsCalls;
+        ForwardsCalls,
+        Hookable;
 
     /**
      * The connection name for the model.
@@ -252,37 +255,34 @@ protected static function boot()
         static::bootTraits();
     }
 
+    /**
+     * Register hook for `bootX` trait methods.
+     *
+     * @return \Illuminate\Support\Hooks\TraitHook
+     */
+    public static function registerBootHook(): TraitHook
+    {
+        return new TraitHook('boot');
+    }
+
+    /**
+     * Register hook for `initializeX` trait methods.
+     *
+     * @return \Illuminate\Support\Hooks\TraitHook
+     */
+    public static function registerInitializeHook(): TraitHook
+    {
+        return new TraitHook('initialize');
+    }
+
     /**
      * Boot all of the bootable traits on the model.
      *
      * @return void
      */
     protected static function bootTraits()
     {
-        $class = static::class;
-
-        $booted = [];
-
-        static::$traitInitializers[$class] = [];
-
-        // TODO: Switch to Hookable
-        foreach (class_uses_recursive($class) as $trait) {
-            $method = 'boot'.class_basename($trait);
-
-            if (method_exists($class, $method) && ! in_array($method, $booted)) {
-                forward_static_call([$class, $method]);
-
-                $booted[] = $method;
-            }
-
-            if (method_exists($class, $method = 'initialize'.class_basename($trait))) {
-                static::$traitInitializers[$class][] = $method;
-
-                static::$traitInitializers[$class] = array_unique(
-                    static::$traitInitializers[$class]
-                );
-            }
-        }
+        static::runStaticHooks('boot');
     }
 
     /**
@@ -292,9 +292,7 @@ protected static function bootTraits()
      */
     protected function initializeTraits()
     {
-        foreach (static::$traitInitializers[static::class] as $method) {
-            $this->{$method}();
-        }
+        $this->runHooks('initialize');
     }
 
     /**

diff --git a/src/Illuminate/Support/Hooks/Hook.php b/src/Illuminate/Support/Hooks/Hook.php
@@ -91,6 +91,22 @@ public function cleanup($instance, array $arguments = [])
         $this->runCallback($this->cleanup, $instance, $arguments);
     }
 
+    /**
+     * @inheritdoc
+     */
+    public function getName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPriority()
+    {
+        return $this->priority;
+    }
+
     /**
      * Run a callback that may or may not be static.
      *

diff --git a/src/Illuminate/Support/Hooks/HookCollection.php b/src/Illuminate/Support/Hooks/HookCollection.php
@@ -3,6 +3,7 @@
 namespace Illuminate\Support\Hooks;
 
 use Closure;
+use Illuminate\Contracts\Support\Hook;
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use ReflectionClass;
@@ -102,8 +103,8 @@ public function run($name, $instance, $arguments = [], Closure $callback = null)
 
         $hooks = $this->onlyStatic(! is_object($instance))
             ->resolve($instance)
-            ->where('name', $name)
-            ->sortBy('priority');
+            ->filter(fn(Hook $hook) => $hook->getName() === $name)
+            ->sortBy(fn(Hook $hook) => $hook->getPriority());
 
         $hooks->each(fn (Hook $hook) => $hook->run($instance, $arguments));
 

diff --git a/src/Illuminate/Support/Hooks/PendingHook.php b/src/Illuminate/Support/Hooks/PendingHook.php
@@ -3,6 +3,7 @@
 namespace Illuminate\Support\Hooks;
 
 use Closure;
+use Illuminate\Contracts\Support\Hook;
 use RuntimeException;
 
 class PendingHook

diff --git a/src/Illuminate/Support/Hooks/TraitHook.php b/src/Illuminate/Support/Hooks/TraitHook.php
@@ -45,4 +45,20 @@ public function cleanup($instance, array $arguments = [])
     {
         // No cleanup is necessary
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function getName()
+    {
+        return $this->prefix;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getPriority()
+    {
+        return $this->priority;
+    }
 }