BookStack Code Mirror - bookstack/blob - app/Entities/Models/Deletion.php

   1 <?php namespace BookStack\Entities;
   2
   3 use BookStack\Auth\User;
   4 use BookStack\Interfaces\Loggable;
   5 use Illuminate\Database\Eloquent\Model;
   6 use Illuminate\Database\Eloquent\Relations\BelongsTo;
   7 use Illuminate\Database\Eloquent\Relations\MorphTo;
   8
   9 class Deletion extends Model implements Loggable
  10 {
  11
  12     /**
  13      * Get the related deletable record.
  14      */
  15     public function deletable(): MorphTo
  16     {
  17         return $this->morphTo('deletable')->withTrashed();
  18     }
  19
  20     /**
  21      * The the user that performed the deletion.
  22      */
  23     public function deleter(): BelongsTo
  24     {
  25         return $this->belongsTo(User::class, 'deleted_by');
  26     }
  27
  28     /**
  29      * Create a new deletion record for the provided entity.
  30      */
  31     public static function createForEntity(Entity $entity): Deletion
  32     {
  33         $record = (new self())->forceFill([
  34             'deleted_by' => user()->id,
  35             'deletable_type' => $entity->getMorphClass(),
  36             'deletable_id' => $entity->id,
  37         ]);
  38         $record->save();
  39         return $record;
  40     }
  41
  42     public function logDescriptor(): string
  43     {
  44         $deletable = $this->deletable()->first();
  45         return "Deletion ({$this->id}) for {$deletable->getType()} ({$deletable->id}) {$deletable->name}";
  46     }
  47 }