X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/f7a5a0705bba304a705df74b1e7e724827900a0c..refs/pull/2023/head:/app/Entities/Bookshelf.php

diff --git a/app/Entities/Bookshelf.php b/app/Entities/Bookshelf.php
index 1db348b6b..c7ba840e0 100644
--- a/app/Entities/Bookshelf.php
+++ b/app/Entities/Bookshelf.php
@@ -1,8 +1,10 @@
 <?php namespace BookStack\Entities;
 
 use BookStack\Uploads\Image;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 
-class Bookshelf extends Entity
+class Bookshelf extends Entity implements HasCoverImage
 {
     protected $table = 'bookshelves';
 
@@ -10,14 +12,7 @@ class Bookshelf extends Entity
 
     protected $fillable = ['name', 'description', 'image_id'];
 
-    /**
-     * Get the morph class for this model.
-     * @return string
-     */
-    public function getMorphClass()
-    {
-        return 'BookStack\\Bookshelf';
-    }
+    protected $hidden = ['restricted'];
 
     /**
      * Get the books in this shelf.
@@ -31,6 +26,14 @@ class Bookshelf extends Entity
             ->orderBy('order', 'asc');
     }
 
+    /**
+     * Related books that are visible to the current user.
+     */
+    public function visibleBooks(): BelongsToMany
+    {
+        return $this->books()->visible();
+    }
+
     /**
      * Get the url for this bookshelf.
      * @param string|bool $path
@@ -68,31 +71,29 @@ class Bookshelf extends Entity
 
     /**
      * Get the cover image of the shelf
-     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
      */
-    public function cover()
+    public function cover(): BelongsTo
     {
         return $this->belongsTo(Image::class, 'image_id');
     }
 
     /**
-     * Get an excerpt of this book's description to the specified length or less.
-     * @param int $length
-     * @return string
+     * Get the type of the image model that is used when storing a cover image.
      */
-    public function getExcerpt(int $length = 100)
+    public function coverImageTypeKey(): string
     {
-        $description = $this->description;
-        return mb_strlen($description) > $length ? mb_substr($description, 0, $length-3) . '...' : $description;
+        return 'cover_shelf';
     }
 
     /**
-     * Return a generalised, common raw query that can be 'unioned' across entities.
+     * Get an excerpt of this book's description to the specified length or less.
+     * @param int $length
      * @return string
      */
-    public function entityRawQuery()
+    public function getExcerpt(int $length = 100)
     {
-        return "'BookStack\\\\BookShelf' as entity_type, id, id as entity_id, slug, name, {$this->textField} as text,'' as html, '0' as book_id, '0' as priority, '0' as chapter_id, '0' as draft, created_by, updated_by, updated_at, created_at";
+        $description = $this->description;
+        return mb_strlen($description) > $length ? mb_substr($description, 0, $length-3) . '...' : $description;
     }
 
     /**
@@ -100,7 +101,7 @@ class Bookshelf extends Entity
      * @param Book $book
      * @return bool
      */
-    public function contains(Book $book): bool 
+    public function contains(Book $book): bool
     {
         return $this->books()->where('id', '=', $book->id)->count() > 0;
     }
@@ -111,11 +112,11 @@ class Bookshelf extends Entity
      */
     public function appendBook(Book $book)
     {
-       if (!$this->contains($book)) {
-           return;
-       }
+        if ($this->contains($book)) {
+            return;
+        }
 
-       $maxOrder = $this->books()->max('order');
-       $this->books()->attach($book->id, ['order' => $maxOrder + 1]);
+        $maxOrder = $this->books()->max('order');
+        $this->books()->attach($book->id, ['order' => $maxOrder + 1]);
     }
 }