Customization: Added parent tag classes

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

diff --git a/app/Entities/Models/Book.php b/app/Entities/Models/Book.php
index 735d25a991e0835ccd7a7c8dbe2b1453d7972ee3..ede4fc7d5a670e5a1f5af8e36475b598e837e389 100644 (file)
--- a/app/Entities/Models/Book.php
+++ b/app/Entities/Models/Book.php
@@ -2,6 +2,7 @@
 
 namespace BookStack\Entities\Models;
 
 
 namespace BookStack\Entities\Models;
 

+use BookStack\Sorting\SortRule;

 use BookStack\Uploads\Image;
 use Exception;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use BookStack\Uploads\Image;
 use Exception;
 use Illuminate\Database\Eloquent\Factories\HasFactory;


@@ -15,19 +16,25 @@ use Illuminate\Support\Collection;
  *
  * @property string                                   $description
  * @property int                                      $image_id
  *
  * @property string                                   $description
  * @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 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

  */
 class Book extends Entity implements HasCoverImage
 {
     use HasFactory;
  */
 class Book extends Entity implements HasCoverImage
 {
     use HasFactory;

+    use HasHtmlDescription;

 
 

-    public $searchFactor = 1.2;
+    public float $searchFactor = 1.2;

 
 

-    protected $fillable = ['name', 'description'];
-    protected $hidden = ['restricted', 'pivot', 'image_id', 'deleted_at'];
+    protected $fillable = ['name'];
+    protected $hidden = ['pivot', 'image_id', 'deleted_at', 'description_html'];

 
     /**
      * Get the url for this book.
 
     /**
      * Get the url for this book.


@@ -39,26 +46,19 @@ class Book extends Entity implements HasCoverImage
 
     /**
      * Returns book cover image, if book cover not exists return default cover image.
 
     /**
      * Returns book cover image, if book cover not exists return default cover image.

-     *
-     * @param int $width  - Width of the image
-     * @param int $height - Height of the image
-     *
-     * @return string

      */
      */

-    public function getBookCover($width = 440, $height = 250)
+    public function getBookCover(int $width = 440, int $height = 250): string

     {
         $default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==';
     {
         $default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==';

-        if (!$this->image_id) {
+        if (!$this->image_id || !$this->cover) {

             return $default;
         }
 
         try {
             return $default;
         }
 
         try {

-            $cover = $this->cover ? url($this->cover->getThumb($width, $height, false)) : $default;
+            return $this->cover->getThumb($width, $height, false) ?? $default;

         } catch (Exception $err) {
         } catch (Exception $err) {

-            $cover = $default;
+            return $default;

         }
         }

-
-        return $cover;

     }
 
     /**
     }
 
     /**


@@ -77,55 +77,61 @@ class Book extends Entity implements HasCoverImage
         return 'cover_book';
     }
 
         return 'cover_book';
     }
 

+    /**
+     * Get the Page that is used as default template for newly created pages within this Book.
+     */
+    public function defaultTemplate(): BelongsTo
+    {
+        return $this->belongsTo(Page::class, 'default_template_id');
+    }
+
+    /**
+     * Get the sort set assigned to this book, if existing.
+     */
+    public function sortRule(): BelongsTo
+    {
+        return $this->belongsTo(SortRule::class);
+    }
+

     /**
      * Get all pages within this book.
     /**
      * Get all pages within this book.

-     *
-     * @return HasMany

      */
      */

-    public function pages()
+    public function pages(): HasMany

     {
         return $this->hasMany(Page::class);
     }
 
     /**
      * Get the direct child pages of this book.
     {
         return $this->hasMany(Page::class);
     }
 
     /**
      * Get the direct child pages of this book.

-     *
-     * @return HasMany

      */
      */

-    public function directPages()
+    public function directPages(): HasMany

     {
         return $this->pages()->where('chapter_id', '=', '0');
     }
 
     /**
      * Get all chapters within this book.
     {
         return $this->pages()->where('chapter_id', '=', '0');
     }
 
     /**
      * Get all chapters within this book.

-     *
-     * @return HasMany

      */
      */

-    public function chapters()
+    public function chapters(): HasMany

     {
         return $this->hasMany(Chapter::class);
     }
 
     /**
      * Get the shelves this book is contained within.
     {
         return $this->hasMany(Chapter::class);
     }
 
     /**
      * Get the shelves this book is contained within.

-     *
-     * @return BelongsToMany

      */
      */

-    public function shelves()
+    public function shelves(): BelongsToMany

     {
         return $this->belongsToMany(Bookshelf::class, 'bookshelves_books', 'book_id', 'bookshelf_id');
     }
 
     /**
      * Get the direct child items within this book.
     {
         return $this->belongsToMany(Bookshelf::class, 'bookshelves_books', 'book_id', 'bookshelf_id');
     }
 
     /**
      * Get the direct child items within this book.

-     *
-     * @return Collection

      */
      */

-    public function getDirectChildren(): Collection
+    public function getDirectVisibleChildren(): Collection

     {
     {

-        $pages = $this->directPages()->visible()->get();
-        $chapters = $this->chapters()->visible()->get();
+        $pages = $this->directPages()->scopes('visible')->get();
+        $chapters = $this->chapters()->scopes('visible')->get();

 
         return $pages->concat($chapters)->sortBy('priority')->sortByDesc('draft');
     }
 
         return $pages->concat($chapters)->sortBy('priority')->sortByDesc('draft');
     }