Entities: Got most queries back to working order

Author: ssddanbrown

app/Console/Commands/UpdateUrlCommand.php

@@ -45,10 +45,8 @@ public function handle(Connection $db): int
 
         $columnsToUpdateByTable = [
             'attachments' => ['path'],
-            'pages'       => ['html', 'text', 'markdown'],
-            'chapters'    => ['description_html'],
-            'books'       => ['description_html'],
-            'bookshelves' => ['description_html'],
+            'entity_page_contents' => ['html', 'text', 'markdown'],
+            'entity_container_contents' => ['description_html'],
             'page_revisions' => ['html', 'text', 'markdown'],
             'images'      => ['url'],
             'settings'    => ['value'],

app/Entities/Controllers/BookApiController.php

@@ -124,8 +124,8 @@ protected function forJsonDisplay(Book $book): Book
 
         $book->load(['tags']);
         $book->makeVisible(['cover', 'description_html'])
-            ->setAttribute('description_html', $book->description()->getHtml())
-            ->setAttribute('cover', $book->cover()->getImage());
+            ->setAttribute('description_html', $book->descriptionInfo()->getHtml())
+            ->setAttribute('cover', $book->coverInfo()->getImage());
 
         return $book;
     }

app/Entities/Controllers/BookshelfApiController.php

@@ -118,8 +118,8 @@ protected function forJsonDisplay(Bookshelf $shelf): Bookshelf
 
         $shelf->load(['tags']);
         $shelf->makeVisible(['cover', 'description_html'])
-            ->setAttribute('description_html', $shelf->description()->getHtml())
-            ->setAttribute('cover', $shelf->cover()->getImage());
+            ->setAttribute('description_html', $shelf->descriptionInfo()->getHtml())
+            ->setAttribute('cover', $shelf->coverInfo()->getImage());
 
         return $shelf;
     }

app/Entities/Controllers/BookshelfController.php

@@ -116,6 +116,7 @@ public function show(Request $request, ActivityQueries $activities, string $slug
         ]);
 
         $sort = $listOptions->getSort();
+
         $sortedVisibleShelfBooks = $shelf->visibleBooks()
             ->reorder($sort === 'default' ? 'order' : $sort, $listOptions->getOrder())
             ->get()

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->description()->getHtml());
+        $chapter->setAttribute('description_html', $chapter->descriptionInfo()->getHtml());
 
         /** @var Book $book */
         $book = $chapter->book()->first();

app/Entities/Models/Book.php

@@ -5,6 +5,7 @@
 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;
@@ -42,11 +43,6 @@ public function getUrl(string $path = ''): string
         return url('/books/' . implode('/', [urlencode($this->slug), trim($path, '/')]));
     }
 
-    public function cover(): EntityCover
-    {
-        return new EntityCover($this);
-    }
-
     /**
      * Get all pages within this book.
      * @return HasMany<Page, $this>
@@ -97,6 +93,16 @@ public function defaultTemplate(): EntityDefaultTemplate
         return new EntityDefaultTemplate($this);
     }
 
+    public function cover(): BelongsTo
+    {
+        return $this->belongsTo(Image::class, 'image_id');
+    }
+
+    public function coverInfo(): EntityCover
+    {
+        return new EntityCover($this);
+    }
+
     /**
      * Get the sort rule assigned to this container, if existing.
      */

app/Entities/Models/Bookshelf.php

@@ -3,7 +3,9 @@
 namespace BookStack\Entities\Models;
 
 use BookStack\Entities\Tools\EntityCover;
+use BookStack\Uploads\Image;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
 /**
@@ -26,6 +28,7 @@ class Bookshelf extends Entity implements HasDescriptionInterface, HasCoverInter
     public function books(): BelongsToMany
     {
         return $this->belongsToMany(Book::class, 'bookshelves_books', 'bookshelf_id', 'book_id')
+            ->select(['entities.*', 'entity_container_contents.*'])
             ->withPivot('order')
             ->orderBy('order', 'asc');
     }
@@ -67,8 +70,13 @@ public function appendBook(Book $book): void
         $this->books()->attach($book->id, ['order' => $maxOrder + 1]);
     }
 
-    public function cover(): EntityCover
+    public function coverInfo(): EntityCover
     {
         return new EntityCover($this);
     }
+
+    public function cover(): BelongsTo
+    {
+        return $this->belongsTo(Image::class, 'image_id');
+    }
 }

app/Entities/Models/ContainerTrait.php

@@ -10,7 +10,7 @@
  */
 trait ContainerTrait
 {
-    public function description(): EntityHtmlDescription
+    public function descriptionInfo(): EntityHtmlDescription
     {
         return new EntityHtmlDescription($this);
     }

app/Entities/Models/Entity.php

@@ -373,7 +373,7 @@ public function getParent(): ?self
     {
         if ($this instanceof Page) {
             /** @var BelongsTo<Chapter|Book, Page>  $builder */
-            $builder = $this->pageData->chapter_id ? $this->chapter() : $this->book();
+            $builder = $this->chapter_id ? $this->chapter() : $this->book();
             return $builder->withTrashed()->first();
         }
         if ($this instanceof Chapter) {

app/Entities/Models/HasCoverInterface.php

@@ -3,8 +3,16 @@
 namespace BookStack\Entities\Models;
 
 use BookStack\Entities\Tools\EntityCover;
+use BookStack\Uploads\Image;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
 
 interface HasCoverInterface
 {
-    public function cover(): EntityCover;
+    public function coverInfo(): EntityCover;
+
+    /**
+     * The cover image of this entity.
+     * @return BelongsTo<Image, $this>
+     */
+    public function cover(): BelongsTo;
 }