Entities: Started logic change to new structure

Updated base entity class, and worked through BaseRepo.
Need to go through other repos next.

Removed a couple of redundant interfaces as part of this since we can
move the logic onto the shared ContainerData model as needed.

Author: ssddanbrown

app/Entities/Controllers/BookApiController.php

@@ -122,9 +122,10 @@ protected function forJsonDisplay(Book $book): Book
         $book = clone $book;
         $book->unsetRelations()->refresh();
 
-        $book->load(['tags', 'cover']);
-        $book->makeVisible('description_html')
-            ->setAttribute('description_html', $book->descriptionHtml());
+        $book->load(['tags']);
+        $book->makeVisible(['cover', 'description_html'])
+            ->setAttribute('description_html', $book->containerData->getDescriptionHtml())
+            ->setAttribute('cover', $book->containerData->cover);
 
         return $book;
     }

app/Entities/Controllers/BookshelfApiController.php

@@ -116,9 +116,10 @@ protected function forJsonDisplay(Bookshelf $shelf): Bookshelf
         $shelf = clone $shelf;
         $shelf->unsetRelations()->refresh();
 
-        $shelf->load(['tags', 'cover']);
-        $shelf->makeVisible('description_html')
-            ->setAttribute('description_html', $shelf->descriptionHtml());
+        $shelf->load(['tags']);
+        $shelf->makeVisible(['cover', 'description_html'])
+            ->setAttribute('description_html', $shelf->containerData->getDescriptionHtml())
+            ->setAttribute('cover', $shelf->containerData->cover);
 
         return $shelf;
     }

app/Entities/Controllers/ChapterApiController.php

@@ -144,7 +144,7 @@ protected function forJsonDisplay(Chapter $chapter): Chapter
 
         $chapter->load(['tags']);
         $chapter->makeVisible('description_html');
-        $chapter->setAttribute('description_html', $chapter->descriptionHtml());
+        $chapter->setAttribute('description_html', $chapter->containerData->getDescriptionHtml());
 
         /** @var Book $book */
         $book = $chapter->book()->first();

app/Entities/Models/Book.php

@@ -26,14 +26,12 @@
  * @property ?Page                                    $defaultTemplate
  * @property ?SortRule                                 $sortRule
  */
-class Book extends Entity implements CoverImageInterface, HtmlDescriptionInterface
+class Book extends Entity
 {
     use HasFactory;
-    use HtmlDescriptionTrait;
 
     public float $searchFactor = 1.2;
 
-    protected $fillable = ['name'];
     protected $hidden = ['pivot', 'image_id', 'deleted_at', 'description_html'];
 
     /**
@@ -50,33 +48,17 @@ public function getUrl(string $path = ''): string
     public function getBookCover(int $width = 440, int $height = 250): string
     {
         $default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==';
-        if (!$this->image_id || !$this->cover) {
+        if (!$this->containerData->image_id || !$this->containerData->cover) {
             return $default;
         }
 
         try {
-            return $this->cover->getThumb($width, $height, false) ?? $default;
+            return $this->containerData->cover->getThumb($width, $height, false) ?? $default;
         } catch (Exception $err) {
             return $default;
         }
     }
 
-    /**
-     * Get the cover image of the book.
-     */
-    public function cover(): BelongsTo
-    {
-        return $this->belongsTo(Image::class, 'image_id');
-    }
-
-    /**
-     * Get the type of the image model that is used when storing a cover image.
-     */
-    public function coverImageTypeKey(): string
-    {
-        return 'cover_book';
-    }
-
     /**
      * Get the Page that is used as default template for newly created pages within this Book.
      */

app/Entities/Models/Bookshelf.php

@@ -2,26 +2,21 @@
 
 namespace BookStack\Entities\Models;
 
-use BookStack\Uploads\Image;
 use Exception;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
-class Bookshelf extends Entity implements CoverImageInterface, HtmlDescriptionInterface
+class Bookshelf extends Entity
 {
     use HasFactory;
-    use HtmlDescriptionTrait;
 
     public float $searchFactor = 1.2;
 
-    protected $fillable = ['name', 'description', 'image_id'];
-
     protected $hidden = ['image_id', 'deleted_at', 'description_html'];
 
     /**
      * Get the books in this shelf.
-     * Should not be used directly since does not take into account permissions.
+     * Should not be used directly since it does not take into account permissions.
      */
     public function books(): BelongsToMany
     {
@@ -53,34 +48,17 @@ public function getBookCover(int $width = 440, int $height = 250): string
     {
         // TODO - Make generic, focused on books right now, Perhaps set-up a better image
         $default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==';
-        if (!$this->image_id || !$this->cover) {
+        if (!$this->containerData->image_id || !$this->containerData->cover) {
             return $default;
         }
 
         try {
-            return $this->cover->getThumb($width, $height, false) ?? $default;
+            return $this->containerData->cover->getThumb($width, $height, false) ?? $default;
         } catch (Exception $err) {
             return $default;
         }
     }
 
-    /**
-     * Get the cover image of the shelf.
-     * @return BelongsTo<Image, $this>
-     */
-    public function cover(): BelongsTo
-    {
-        return $this->belongsTo(Image::class, 'image_id');
-    }
-
-    /**
-     * Get the type of the image model that is used when storing a cover image.
-     */
-    public function coverImageTypeKey(): string
-    {
-        return 'cover_bookshelf';
-    }
-
     /**
      * Check if this shelf contains the given book.
      */
@@ -92,7 +70,7 @@ public function contains(Book $book): bool
     /**
      * Add a book to the end of this shelf.
      */
-    public function appendBook(Book $book)
+    public function appendBook(Book $book): void
     {
         if ($this->contains($book)) {
             return;

app/Entities/Models/Chapter.php

@@ -14,14 +14,11 @@
  * @property ?int             $default_template_id
  * @property ?Page            $defaultTemplate
  */
-class Chapter extends BookChild implements HtmlDescriptionInterface
+class Chapter extends BookChild
 {
     use HasFactory;
-    use HtmlDescriptionTrait;
 
     public float $searchFactor = 1.2;
-
-    protected $fillable = ['name', 'description', 'priority'];
     protected $hidden = ['pivot', 'deleted_at', 'description_html'];
 
     /**

app/Entities/Models/CoverImageInterface.php

@@ -28,6 +28,7 @@
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
@@ -47,6 +48,8 @@
  * @property int        $owned_by
  * @property Collection $tags
  *
+ * @property ?EntityContainerData $containerData
+ *
  * @method static Entity|Builder visible()
  * @method static Builder withLastView()
  * @method static Builder withViewCount()
@@ -90,6 +93,22 @@ protected static function booted(): void
         static::addGlobalScope('entity', new EntityScope());
     }
 
+    public function shouldHaveContainerData(): bool
+    {
+        return $this instanceof Bookshelf ||
+            $this instanceof Book ||
+            $this instanceof Chapter;
+    }
+
+    /**
+     * Get the container-specific data for this page.
+     */
+    public function containerData(): HasOne
+    {
+        return $this->hasOne(EntityContainerData::class, 'id', 'entity_id')
+            ->where('entity_type', '=', $this->getMorphClass());
+    }
+
     /**
      * Get the entities that are visible to the current user.
      */

app/Entities/Models/Entity.php

@@ -2,14 +2,34 @@
 
 namespace BookStack\Entities\Models;
 
+use BookStack\Uploads\Image;
 use BookStack\Util\HtmlContentFilter;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\HasOne;
 
 /**
  * @property string $description
  * @property string $description_html
+ * @property ?int    $default_template_id
+ * @property ?int    $image_id
+ * @property ?int    $sort_rule_id
  */
-trait HtmlDescriptionTrait
+class EntityContainerData extends Model
 {
+    public $timestamps = false;
+
+    /**
+     * Relation for the cover image for this entity.
+     * @return HasOne<Image, $this>
+     */
+    public function cover(): HasOne
+    {
+        return $this->hasOne(Image::class, 'image_id');
+    }
+
+    /**
+     * Get the description as a cleaned/handled HTML string.
+     */
     public function descriptionHtml(bool $raw = false): string
     {
         $html = $this->description_html ?: '<p>' . nl2br(e($this->description)) . '</p>';
@@ -20,6 +40,10 @@ public function descriptionHtml(bool $raw = false): string
         return HtmlContentFilter::removeScriptsFromHtmlString($html);
     }
 
+    /**
+     * Update the description from HTML code.
+     * Optionally takes plaintext to use for the model also.
+     */
     public function setDescriptionHtml(string $html, string|null $plaintext = null): void
     {
         $this->description_html = $html;

…Entities/Models/HtmlDescriptionTrait.php …/Entities/Models/EntityContainerData.phpapp/Entities/Models/HtmlDescriptionTrait.php renamed to app/Entities/Models/EntityContainerData.php app/Entities/Models/HtmlDescriptionTrait.php renamed to app/Entities/Models/EntityContainerData.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace BookStack\Entities\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+class EntityPageData extends Model
+{
+    public $timestamps = false;
+}