Fixes for CodeStyle vol.2

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

diff --git a/app/Entities/Models/Book.php b/app/Entities/Models/Book.php
index 6c56767655c894b22c548e7ff552a07f36940ea6..df30c1c714abb4fff2ddd9d92e2b3c4fa6119623 100644 (file)
--- a/app/Entities/Models/Book.php
+++ b/app/Entities/Models/Book.php
@@ -1,4 +1,6 @@
-<?php namespace BookStack\Entities\Models;
+<?php
+
+namespace BookStack\Entities\Models;

 
 use BookStack\Uploads\Image;
 use Exception;
 
 use BookStack\Uploads\Image;
 use Exception;


@@ -8,9 +10,10 @@ use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
 
 /**
 use Illuminate\Support\Collection;
 
 /**

- * Class Book
- * @property string $description
- * @property int $image_id
+ * Class Book.
+ *
+ * @property string     $description
+ * @property int        $image_id

  * @property Image|null $cover
  */
 class Book extends Entity implements HasCoverImage
  * @property Image|null $cover
  */
 class Book extends Entity implements HasCoverImage


@@ -30,8 +33,10 @@ 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 $width  - Width of the image

      * @param int $height - Height of the image
      * @param int $height - Height of the image

+     *

      * @return string
      */
     public function getBookCover($width = 440, $height = 250)
      * @return string
      */
     public function getBookCover($width = 440, $height = 250)


@@ -46,11 +51,12 @@ class Book extends Entity implements HasCoverImage
         } catch (Exception $err) {
             $cover = $default;
         }
         } catch (Exception $err) {
             $cover = $default;
         }

+

         return $cover;
     }
 
     /**
         return $cover;
     }
 
     /**

-     * Get the cover image of the book
+     * Get the cover image of the book.

      */
     public function cover(): BelongsTo
     {
      */
     public function cover(): BelongsTo
     {


@@ -67,6 +73,7 @@ class Book extends Entity implements HasCoverImage
 
     /**
      * Get all pages within this book.
 
     /**
      * Get all pages within this book.

+     *

      * @return HasMany
      */
     public function pages()
      * @return HasMany
      */
     public function pages()


@@ -76,6 +83,7 @@ class Book extends Entity implements HasCoverImage
 
     /**
      * Get the direct child pages of this book.
 
     /**
      * Get the direct child pages of this book.

+     *

      * @return HasMany
      */
     public function directPages()
      * @return HasMany
      */
     public function directPages()


@@ -85,6 +93,7 @@ class Book extends Entity implements HasCoverImage
 
     /**
      * Get all chapters within this book.
 
     /**
      * Get all chapters within this book.

+     *

      * @return HasMany
      */
     public function chapters()
      * @return HasMany
      */
     public function chapters()


@@ -94,6 +103,7 @@ class Book extends Entity implements HasCoverImage
 
     /**
      * Get the shelves this book is contained within.
 
     /**
      * Get the shelves this book is contained within.

+     *

      * @return BelongsToMany
      */
     public function shelves()
      * @return BelongsToMany
      */
     public function shelves()


@@ -103,12 +113,14 @@ class Book extends Entity implements HasCoverImage
 
     /**
      * Get the direct child items within this book.
 
     /**
      * Get the direct child items within this book.

+     *

      * @return Collection
      */
     public function getDirectChildren(): Collection
     {
         $pages = $this->directPages()->visible()->get();
         $chapters = $this->chapters()->visible()->get();
      * @return Collection
      */
     public function getDirectChildren(): Collection
     {
         $pages = $this->directPages()->visible()->get();
         $chapters = $this->chapters()->visible()->get();

+

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