[12.x] isSoftDeletable(), isPrunable(), and isMassPrunable() to model class (#56060)

* feat(database): ✨ Add isSoftDeletable(), isPrunable(), and isMassPrunable() to model class

* fix(database): 🐛 Call model method instead of command method

* Restore "only check for soft deletes once when mass-pruning"

Co-authored-by: Luke Kuzmish <[email protected]>

See laravel/framework#55274

See laravel/framework#56060 (comment)

* Fix typo

Follow-up to 07520f2225a78a183c6d02da11f662ddf207657d

* formatting

* fix test

---------

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

Author: shaedrich

Console/PruneCommand.php

@@ -4,9 +4,6 @@
 
 use Illuminate\Console\Command;
 use Illuminate\Contracts\Events\Dispatcher;
-use Illuminate\Database\Eloquent\MassPrunable;
-use Illuminate\Database\Eloquent\Prunable;
-use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Database\Events\ModelPruningFinished;
 use Illuminate\Database\Events\ModelPruningStarting;
 use Illuminate\Database\Events\ModelsPruned;
@@ -101,7 +98,7 @@ protected function pruneModel(string $model)
             ? $instance->prunableChunkSize
             : $this->option('chunk');
 
-        $total = $this->isPrunable($model)
+        $total = $model::isPrunable()
             ? $instance->pruneAll($chunkSize)
             : 0;
 
@@ -141,7 +138,7 @@ protected function models()
             })
             ->when(! empty($except), fn ($models) => $models->reject(fn ($model) => in_array($model, $except)))
             ->filter(fn ($model) => class_exists($model))
-            ->filter(fn ($model) => $this->isPrunable($model))
+            ->filter(fn ($model) => $model::isPrunable())
             ->values();
     }
 
@@ -161,31 +158,18 @@ protected function getPath()
         return app_path('Models');
     }
 
-    /**
-     * Determine if the given model class is prunable.
-     *
-     * @param  string  $model
-     * @return bool
-     */
-    protected function isPrunable($model)
-    {
-        $uses = class_uses_recursive($model);
-
-        return in_array(Prunable::class, $uses) || in_array(MassPrunable::class, $uses);
-    }
-
     /**
      * Display how many models will be pruned.
      *
-     * @param  string  $model
+     * @param  class-string  $model
      * @return void
      */
     protected function pretendToPrune($model)
     {
         $instance = new $model;
 
         $count = $instance->prunable()
-            ->when(in_array(SoftDeletes::class, class_uses_recursive(get_class($instance))), function ($query) {
+            ->when($model::isSoftDeletable(), function ($query) {
                 $query->withTrashed();
             })->count();
 

Eloquent/Factories/Factory.php

@@ -8,7 +8,6 @@
 use Illuminate\Contracts\Foundation\Application;
 use Illuminate\Database\Eloquent\Collection as EloquentCollection;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Support\Carbon;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Enumerable;
@@ -971,7 +970,7 @@ public function __call($method, $parameters)
             return $this->macroCall($method, $parameters);
         }
 
-        if ($method === 'trashed' && in_array(SoftDeletes::class, class_uses_recursive($this->modelName()))) {
+        if ($method === 'trashed' && $this->modelName()::isSoftDeletable()) {
             return $this->state([
                 $this->newModel()->getDeletedAtColumn() => $parameters[0] ?? Carbon::now()->subDay(),
             ]);

Eloquent/MassPrunable.php

@@ -23,7 +23,7 @@ public function pruneAll(int $chunkSize = 1000)
 
         $total = 0;
 
-        $softDeletable = in_array(SoftDeletes::class, class_uses_recursive(get_class($this)));
+        $softDeletable = static::isSoftDeletable();
 
         do {
             $total += $count = $softDeletable

Eloquent/Model.php

@@ -2289,6 +2289,30 @@ public function setPerPage($perPage)
         return $this;
     }
 
+    /**
+     * Determine if the model is soft deletable.
+     */
+    public static function isSoftDeletable(): bool
+    {
+        return in_array(SoftDeletes::class, class_uses_recursive(static::class));
+    }
+
+    /**
+     * Determine if the model is prunable.
+     */
+    protected function isPrunable(): bool
+    {
+        return in_array(Prunable::class, class_uses_recursive(static::class)) || static::isMassPrunable();
+    }
+
+    /**
+     * Determine if the model is mass prunable.
+     */
+    protected function isMassPrunable(): bool
+    {
+        return in_array(MassPrunable::class, class_uses_recursive(static::class));
+    }
+
     /**
      * Determine if lazy loading is disabled.
      *

Eloquent/Prunable.php

@@ -20,7 +20,7 @@ public function pruneAll(int $chunkSize = 1000)
         $total = 0;
 
         $this->prunable()
-            ->when(in_array(SoftDeletes::class, class_uses_recursive(static::class)), function ($query) {
+            ->when(static::isSoftDeletable(), function ($query) {
                 $query->withTrashed();
             })->chunkById($chunkSize, function ($models) use (&$total) {
                 $models->each(function ($model) use (&$total) {
@@ -64,7 +64,7 @@ public function prune()
     {
         $this->pruning();
 
-        return in_array(SoftDeletes::class, class_uses_recursive(static::class))
+        return static::isSoftDeletable()
             ? $this->forceDelete()
             : $this->delete();
     }

Eloquent/Relations/HasOneOrManyThrough.php

@@ -9,7 +9,6 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Illuminate\Database\Eloquent\Relations\Concerns\InteractsWithDictionary;
-use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Database\Query\Grammars\MySqlGrammar;
 use Illuminate\Database\UniqueConstraintViolationException;
 
@@ -146,7 +145,7 @@ public function getQualifiedParentKeyName()
      */
     public function throughParentSoftDeletes()
     {
-        return in_array(SoftDeletes::class, class_uses_recursive($this->throughParent));
+        return $this->throughParent::isSoftDeletable();
     }
 
     /**