Entities: Removed use of contents system for data access

Author: ssddanbrown

app/Entities/Models/Book.php

@@ -3,9 +3,10 @@
 namespace BookStack\Entities\Models;
 
 use BookStack\Entities\Tools\EntityCover;
+use BookStack\Entities\Tools\EntityDefaultTemplate;
 use BookStack\Sorting\SortRule;
-use BookStack\Uploads\Image;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
@@ -18,15 +19,13 @@
  * @property int                                      $image_id
  * @property ?int                                     $default_template_id
  * @property ?int                                     $sort_rule_id
- * @property Image|null                               $cover
  * @property \Illuminate\Database\Eloquent\Collection $chapters
  * @property \Illuminate\Database\Eloquent\Collection $pages
  * @property \Illuminate\Database\Eloquent\Collection $directPages
  * @property \Illuminate\Database\Eloquent\Collection $shelves
- * @property ?Page                                    $defaultTemplate
- * @property ?SortRule                                 $sortRule
+ * @property ?SortRule                                $sortRule
  */
-class Book extends Entity implements DescriptionInterface, CoverInterface
+class Book extends Entity implements HasDescriptionInterface, HasCoverInterface, HasDefaultTemplateInterface
 {
     use HasFactory;
     use ContainerTrait;
@@ -43,15 +42,6 @@ public function getUrl(string $path = ''): string
         return url('/books/' . implode('/', [urlencode($this->slug), trim($path, '/')]));
     }
 
-    /**
-     * Returns a book cover image URL or a default URL if no cover image set.
-     * TODO - Delete
-     */
-    public function getCover(int $width = 440, int $height = 250): string
-    {
-        return $this->contents()->getCoverUrl($width, $height);
-    }
-
     public function cover(): EntityCover
     {
         return new EntityCover($this);
@@ -101,4 +91,17 @@ public function getDirectVisibleChildren(): Collection
 
         return $pages->concat($chapters)->sortBy('priority')->sortByDesc('draft');
     }
+
+    public function defaultTemplate(): EntityDefaultTemplate
+    {
+        return new EntityDefaultTemplate($this);
+    }
+
+    /**
+     * Get the sort rule assigned to this container, if existing.
+     */
+    public function sortRule(): BelongsTo
+    {
+        return $this->belongsTo(SortRule::class);
+    }
 }

app/Entities/Models/Bookshelf.php

@@ -10,7 +10,7 @@
  * @property string $description
  * @property string $description_html
  */
-class Bookshelf extends Entity implements DescriptionInterface, CoverInterface
+class Bookshelf extends Entity implements HasDescriptionInterface, HasCoverInterface
 {
     use HasFactory;
     use ContainerTrait;

app/Entities/Models/Chapter.php

@@ -2,18 +2,18 @@
 
 namespace BookStack\Entities\Models;
 
+use BookStack\Entities\Tools\EntityDefaultTemplate;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
 
 /**
  * @property Collection<Page> $pages
  * @property ?int             $default_template_id
- * @property ?Page            $defaultTemplate
- * @property string $description
- * @property string $description_html
+ * @property string           $description
+ * @property string           $description_html
  */
-class Chapter extends BookChild implements DescriptionInterface
+class Chapter extends BookChild implements HasDescriptionInterface, HasDefaultTemplateInterface
 {
     use HasFactory;
     use ContainerTrait;
@@ -59,4 +59,9 @@ public function getVisiblePages(): Collection
         ->orderBy('priority', 'asc')
         ->get();
     }
+
+    public function defaultTemplate(): EntityDefaultTemplate
+    {
+        return new EntityDefaultTemplate($this);
+    }
 }

app/Entities/Models/ContainerTrait.php

@@ -23,26 +23,4 @@ public function relatedData(): HasOne
         return $this->hasOne(EntityContainerContents::class, 'entity_id', 'id')
             ->where('entity_type', '=', $this->getMorphClass());
     }
-
-    public function contents(): EntityContainerContents
-    {
-        $data = parent::contents();
-        if ($data instanceof EntityContainerContents) {
-            return $data;
-        }
-
-        /** @var EntityContainerContents $data */
-        $data = $this->relatedData()->newModelInstance();
-        $data->setRawAttributes([
-            'entity_id' => $this->id,
-            'entity_type' => $this->getMorphClass(),
-            'description' => '',
-            'description_html' => '',
-            'default_template_id' => null,
-            'image_id' => null,
-            'sort_rule_id' => null,
-        ]);
-
-        return $data;
-    }
 }

app/Entities/Models/Entity.php

@@ -104,8 +104,6 @@ abstract class Entity extends Model implements
         'owned_by',
     ];
 
-    // TODO - To Remove, reduce contents/relatedData to just one of them.
-    // TODO - Update/remove existing usages of contents/relatedData
     // TODO - Review usages of query-time update or mass insert of entity model data since those will still need to consider the multi-table layout.
 
     /**
@@ -468,21 +466,4 @@ protected function getContentsAttributes(): array
 
         return $contentFields;
     }
-
-    /**
-     * Get the contents model of this entity.
-     * Should only really be used if accessing the methods of the contents model
-     * since the properties would already be part of the fetched entity model.
-     */
-    public function contents(): EntityContainerContents|EntityPageContents
-    {
-        $contentsData = $this->getContentsAttributes();
-
-        /**
-         * @var EntityContainerContents|EntityPageContents $instance
-         */
-        $instance = $this->relatedData()->newModelInstance()->newFromBuilder($contentsData, $this->getConnection());
-
-        return $instance;
-    }
 }

app/Entities/Models/EntityContainerContents.php

@@ -2,19 +2,14 @@
 
 namespace BookStack\Entities\Models;
 
-use BookStack\Sorting\SortRule;
-use BookStack\Uploads\Image;
-use Exception;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Model;
-use Illuminate\Database\Eloquent\Relations\BelongsTo;
-use Illuminate\Database\Eloquent\Relations\HasOne;
 
 /**
- * @property int $entity_id
- * @property string $entity_type
- * @property string $description
- * @property string $description_html
+ * @property int     $entity_id
+ * @property string  $entity_type
+ * @property string  $description
+ * @property string  $description_html
  * @property ?int    $default_template_id
  * @property ?int    $image_id
  * @property ?int    $sort_rule_id
@@ -25,9 +20,6 @@ class EntityContainerContents extends Model
     protected $primaryKey = 'entity_id';
     public $incrementing = false;
 
-    // TODO - Should put the entity methods and relations back onto the original models
-    //    if we're going back to mostly keeping to the models.
-
     /**
      * Override the default set keys for save query method to make it work with composite keys.
      */
@@ -40,7 +32,7 @@ public function setKeysForSaveQuery($query): Builder
     }
 
     /**
-     * Override the default set keys for select query method to make it work with composite keys.
+     * Override the default set keys for a select query method to make it work with composite keys.
      */
     protected function setKeysForSelectQuery($query): Builder
     {
@@ -49,66 +41,4 @@ protected function setKeysForSelectQuery($query): Builder
 
         return $query;
     }
-
-    /**
-     * Relation for the cover image for this entity.
-     * @return HasOne<Image, $this>
-     */
-    public function cover(): HasOne
-    {
-        return $this->hasOne(Image::class, 'image_id');
-    }
-
-    public function getCover(): Image|null
-    {
-        return $this->cover()->first();
-    }
-
-    /**
-     * Returns a shelf cover image URL, if cover not exists return default cover image.
-     */
-    public function getCoverUrl(int $width = 440, int $height = 250, string|null $default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=='): string|null
-    {
-        if (!$this->image_id) {
-            return $default;
-        }
-
-        try {
-            return $this->getCover()?->getThumb($width, $height, false) ?? $default;
-        } catch (Exception $err) {
-            return $default;
-        }
-    }
-
-    /**
-     * Check if this data supports having a default template assigned.
-     */
-    public function supportsDefaultTemplate(): bool
-    {
-        return in_array($this->entity_type, ['book', 'chapter']);
-    }
-
-    /**
-     * Check this data supports having a cover image assigned.
-     */
-    public function supportsCoverImage(): bool
-    {
-        return in_array($this->entity_type, ['book', 'bookshelf']);
-    }
-
-    /**
-     * Get the Page used as a default template to be used for new items within this container.
-     */
-    public function defaultTemplate(): BelongsTo
-    {
-        return $this->belongsTo(Page::class, 'default_template_id');
-    }
-
-    /**
-     * Get the sort rule assigned to this container, if existing.
-     */
-    public function sortRule(): BelongsTo
-    {
-        return $this->belongsTo(SortRule::class);
-    }
 }

app/Entities/Models/CoverInterface.php app/Entities/Models/HasCoverInterface.phpapp/Entities/Models/CoverInterface.php renamed to app/Entities/Models/HasCoverInterface.php

@@ -4,7 +4,7 @@
 
 use BookStack\Entities\Tools\EntityCover;
 
-interface CoverInterface
+interface HasCoverInterface
 {
     public function cover(): EntityCover;
 }

app/Entities/Models/HasDefaultTemplateInterface.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace BookStack\Entities\Models;
+
+use BookStack\Entities\Tools\EntityDefaultTemplate;
+
+interface HasDefaultTemplateInterface
+{
+    public function defaultTemplate(): EntityDefaultTemplate;
+}

…Entities/Models/DescriptionInterface.php …ities/Models/HasDescriptionInterface.phpapp/Entities/Models/DescriptionInterface.php renamed to app/Entities/Models/HasDescriptionInterface.php app/Entities/Models/DescriptionInterface.php renamed to app/Entities/Models/HasDescriptionInterface.php

@@ -4,7 +4,7 @@
 
 use BookStack\Entities\Tools\EntityHtmlDescription;
 
-interface DescriptionInterface
+interface HasDescriptionInterface
 {
     public function description(): EntityHtmlDescription;
 }

app/Entities/Models/Page.php

@@ -153,28 +153,4 @@ public function relatedData(): HasOne
     {
         return $this->hasOne(EntityPageContents::class, 'page_id', 'id');
     }
-
-    public function contents(): EntityPageContents
-    {
-        $data = parent::contents();
-        if ($data instanceof EntityPageContents) {
-            return $data;
-        }
-
-        /** @var EntityPageContents $data */
-        $data = $this->relatedData()->newModelInstance();
-        $data->setRawAttributes([
-            'page_id' => $this->id,
-            'chapter_id' => null,
-            'draft' => false,
-            'template' => false,
-            'revision_count' => 0,
-            'editor' => PageEditorType::WysiwygTinymce->value,
-            'html' => '',
-            'text' => '',
-            'markdown' => '',
-        ]);
-
-        return $data;
-    }
 }