]> BookStack Code Mirror - bookstack/blob - app/Entities/Models/PageRevision.php
Updated minimum php version from 7.3 to 7.4
[bookstack] / app / Entities / Models / PageRevision.php
1 <?php
2
3 namespace BookStack\Entities\Models;
4
5 use BookStack\Auth\User;
6 use BookStack\Model;
7 use Carbon\Carbon;
8 use Illuminate\Database\Eloquent\Relations\BelongsTo;
9
10 /**
11  * Class PageRevision.
12  *
13  * @property int    $page_id
14  * @property string $slug
15  * @property string $book_slug
16  * @property int    $created_by
17  * @property Carbon $created_at
18  * @property Carbon $updated_at
19  * @property string $type
20  * @property string $summary
21  * @property string $markdown
22  * @property string $html
23  * @property int    $revision_number
24  * @property Page   $page
25  * @property-read ?User $createdBy
26  */
27 class PageRevision extends Model
28 {
29     protected $fillable = ['name', 'html', 'text', 'markdown', 'summary'];
30
31     /**
32      * Get the user that created the page revision.
33      */
34     public function createdBy(): BelongsTo
35     {
36         return $this->belongsTo(User::class, 'created_by');
37     }
38
39     /**
40      * Get the page this revision originates from.
41      */
42     public function page(): BelongsTo
43     {
44         return $this->belongsTo(Page::class);
45     }
46
47     /**
48      * Get the url for this revision.
49      */
50     public function getUrl(string $path = ''): string
51     {
52         return $this->page->getUrl('/revisions/' . $this->id . '/' . ltrim($path, '/'));
53     }
54
55     /**
56      * Get the previous revision for the same page if existing.
57      */
58     public function getPrevious(): ?PageRevision
59     {
60         $id = static::newQuery()->where('page_id', '=', $this->page_id)
61             ->where('id', '<', $this->id)
62             ->max('id');
63
64         if ($id) {
65             return static::query()->find($id);
66         }
67
68         return null;
69     }
70
71     /**
72      * Allows checking of the exact class, Used to check entity type.
73      * Included here to align with entities in similar use cases.
74      * (Yup, Bit of an awkward hack).
75      *
76      * @deprecated Use instanceof instead.
77      */
78     public static function isA(string $type): bool
79     {
80         return $type === 'revision';
81     }
82 }