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