]> BookStack Code Mirror - bookstack/blobdiff - app/Entities/Models/Chapter.php
Added testing coverage for tag index
[bookstack] / app / Entities / Models / Chapter.php
index d736e2108d405194d7f0c93f92056a0a2abf2172..75630832b46a77d626afba127f676d4b48f4a8b3 100644 (file)
@@ -1,13 +1,21 @@
-<?php namespace BookStack\Entities\Models;
+<?php
 
+namespace BookStack\Entities\Models;
+
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Relations\HasMany;
 use Illuminate\Support\Collection;
 
 /**
- * Class Chapter
+ * Class Chapter.
+ *
  * @property Collection<Page> $pages
+ * @property string $description
  */
 class Chapter extends BookChild
 {
+    use HasFactory;
+
     public $searchFactor = 1.3;
 
     protected $fillable = ['name', 'description', 'priority', 'book_id'];
@@ -15,10 +23,8 @@ class Chapter extends BookChild
 
     /**
      * Get the pages that this chapter contains.
-     * @param string $dir
-     * @return mixed
      */
-    public function pages($dir = 'ASC')
+    public function pages(string $dir = 'ASC'): HasMany
     {
         return $this->hasMany(Page::class)->orderBy('priority', $dir);
     }
@@ -26,11 +32,11 @@ class Chapter extends BookChild
     /**
      * Get the url of this chapter.
      */
-    public function getUrl($path = ''): string
+    public function getUrl(string $path = ''): string
     {
         $parts = [
             'books',
-            urlencode($this->getAttribute('bookSlug') ?? $this->book->slug),
+            urlencode($this->book_slug ?? $this->book->slug),
             'chapter',
             urlencode($this->slug),
             trim($path, '/'),
@@ -39,15 +45,6 @@ class Chapter extends BookChild
         return url('/' . implode('/', $parts));
     }
 
-    /**
-     * Check if this chapter has any child pages.
-     * @return bool
-     */
-    public function hasChildren()
-    {
-        return count($this->pages) > 0;
-    }
-
     /**
      * Get the visible pages in this chapter.
      */