Layout: Converted tri-layout component to ts

[bookstack] / app / Entities / Models / PageRevision.php

diff --git a/app/Entities/Models/PageRevision.php b/app/Entities/Models/PageRevision.php
index 76a3b15ffd44ea64e176eb1020773dc0ca41ec70..10ff6d901c438a87d9d3fbb241636d3ec44b1233 100644 (file)
--- a/app/Entities/Models/PageRevision.php
+++ b/app/Entities/Models/PageRevision.php
@@ -1,64 +1,66 @@
-<?php namespace BookStack\Entities\Models;
+<?php
 
-use BookStack\Auth\User;
-use BookStack\Entities\Models\Page;
-use BookStack\Model;
+namespace BookStack\Entities\Models;
+
+use BookStack\Activity\Models\Loggable;
+use BookStack\App\Model;
+use BookStack\Users\Models\User;
 use Carbon\Carbon;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 /**
- * Class PageRevision
- * @property int $page_id
+ * Class PageRevision.
+ *
+ * @property mixed  $id
+ * @property int    $page_id
+ * @property string $name
  * @property string $slug
  * @property string $book_slug
- * @property int $created_by
+ * @property int    $created_by
  * @property Carbon $created_at
+ * @property Carbon $updated_at
  * @property string $type
  * @property string $summary
  * @property string $markdown
  * @property string $html
- * @property int $revision_number
+ * @property string $text
+ * @property int    $revision_number
+ * @property Page   $page
+ * @property-read ?User $createdBy
  */
-class PageRevision extends Model
+class PageRevision extends Model implements Loggable
 {
-    protected $fillable = ['name', 'html', 'text', 'markdown', 'summary'];
+    protected $fillable = ['name', 'text', 'summary'];
+    protected $hidden = ['html', 'markdown', 'text'];
 
     /**
-     * Get the user that created the page revision
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     * Get the user that created the page revision.
      */
-    public function createdBy()
+    public function createdBy(): BelongsTo
     {
         return $this->belongsTo(User::class, 'created_by');
     }
 
     /**
      * Get the page this revision originates from.
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
-    public function page()
+    public function page(): BelongsTo
     {
         return $this->belongsTo(Page::class);
     }
 
     /**
      * Get the url for this revision.
-     * @param null|string $path
-     * @return string
      */
-    public function getUrl($path = null)
+    public function getUrl(string $path = ''): string
     {
-        $url = $this->page->getUrl() . '/revisions/' . $this->id;
-        if ($path) {
-            return $url . '/' . trim($path, '/');
-        }
-        return $url;
+        return $this->page->getUrl('/revisions/' . $this->id . '/' . ltrim($path, '/'));
     }
 
     /**
-     * Get the previous revision for the same page if existing
-     * @return \BookStack\Entities\PageRevision|null
+     * Get the previous revision for the same page if existing.
      */
-    public function getPrevious()
+    public function getPrevious(): ?PageRevision
     {
         $id = static::newQuery()->where('page_id', '=', $this->page_id)
             ->where('id', '<', $this->id)
@@ -74,12 +76,17 @@ class PageRevision extends Model
     /**
      * Allows checking of the exact class, Used to check entity type.
      * Included here to align with entities in similar use cases.
-     * (Yup, Bit of an awkward hack)
-     * @param $type
-     * @return bool
+     * (Yup, Bit of an awkward hack).
+     *
+     * @deprecated Use instanceof instead.
      */
-    public static function isA($type)
+    public static function isA(string $type): bool
     {
         return $type === 'revision';
     }
+
+    public function logDescriptor(): string
+    {
+        return "Revision #{$this->revision_number} (ID: {$this->id}) for page ID {$this->page_id}";
+    }
 }