List Observers for the Model

Author: mike-healy

src/Illuminate/Foundation/Console/ShowModelCommand.php

@@ -130,6 +130,7 @@ public function handle()
             $model->getConnection()->getTablePrefix().$model->getTable(),
             $this->getAttributes($model),
             $this->getRelations($model),
+            $this->getObservers($model),
         );
     }
 
@@ -247,6 +248,34 @@ protected function getRelations($model)
             ->values();
     }
 
+    /**
+     * Get the Observers watching this model.
+     * @return Illuminate\Support\Collection
+     */
+    protected function getObservers($model)
+    {
+        $listeners = $this->getLaravel()->make('events')->getRawListeners();
+
+        // Distill down to Eloquent observers relevant to this model.
+        $listeners = array_filter($listeners, function ($v, $key) use ($model) {
+            return Str::startsWith($key, 'eloquent.') && Str::endsWith($key, $model::class);
+        }, ARRAY_FILTER_USE_BOTH);
+
+        // Format as Eloquent verb => Observer methods
+        $extractVerb = function ($key) {
+            preg_match('/eloquent.([a-zA-Z]+)\: /', $key, $matches);
+            return $matches[1] ?? '?';
+        };
+
+        $formatted = [];
+
+        foreach($listeners as $key => $observerMethods) {
+            $formatted[] = ['event' => $extractVerb($key), 'observer' => $observerMethods];
+        }
+
+        return collect($formatted);
+    }
+
     /**
      * Render the model information.
      *
@@ -255,13 +284,14 @@ protected function getRelations($model)
      * @param  string  $table
      * @param  \Illuminate\Support\Collection  $attributes
      * @param  \Illuminate\Support\Collection  $relations
+     * @param  \Illuminate\Support\Collection  $observers
      * @return void
      */
-    protected function display($class, $database, $table, $attributes, $relations)
+    protected function display($class, $database, $table, $attributes, $relations, $observers)
     {
         $this->option('json')
-            ? $this->displayJson($class, $database, $table, $attributes, $relations)
-            : $this->displayCli($class, $database, $table, $attributes, $relations);
+            ? $this->displayJson($class, $database, $table, $attributes, $relations, $observers)
+            : $this->displayCli($class, $database, $table, $attributes, $relations, $observers);
     }
 
     /**
@@ -272,9 +302,10 @@ protected function display($class, $database, $table, $attributes, $relations)
      * @param  string  $table
      * @param  \Illuminate\Support\Collection  $attributes
      * @param  \Illuminate\Support\Collection  $relations
+     * @param  \Illuminate\Support\Collection  $observers
      * @return void
      */
-    protected function displayJson($class, $database, $table, $attributes, $relations)
+    protected function displayJson($class, $database, $table, $attributes, $relations, $observers)
     {
         $this->output->writeln(
             collect([
@@ -283,6 +314,7 @@ protected function displayJson($class, $database, $table, $attributes, $relation
                 'table' => $table,
                 'attributes' => $attributes,
                 'relations' => $relations,
+                'observers' => $observers,
             ])->toJson()
         );
     }
@@ -295,9 +327,10 @@ protected function displayJson($class, $database, $table, $attributes, $relation
      * @param  string  $table
      * @param  \Illuminate\Support\Collection  $attributes
      * @param  \Illuminate\Support\Collection  $relations
+     * @param  \Illuminate\Support\Collection  $observers
      * @return void
      */
-    protected function displayCli($class, $database, $table, $attributes, $relations)
+    protected function displayCli($class, $database, $table, $attributes, $relations, $observers)
     {
         $this->newLine();
 
@@ -339,6 +372,15 @@ protected function displayCli($class, $database, $table, $attributes, $relations
 
         $this->newLine();
 
+        $this->components->twoColumnDetail('<fg=green;options=bold>Eloquent Observers</>');
+
+        if ($observers->count()) foreach ($observers as $observer) {
+            $this->components->twoColumnDetail(
+                sprintf('%s', $observer['event']), implode(', ', $observer['observer']));
+        }
+
+        $this->newLine();
+
         $this->components->twoColumnDetail('<fg=green;options=bold>Relations</>');
 
         foreach ($relations as $relation) {