]> BookStack Code Mirror - bookstack/blobdiff - app/Chapter.php
replace GPL diff lib with MIT lib
[bookstack] / app / Chapter.php
index 77c16138580c20d9b1d719fae49a2598c7663d43..08faef68e390e8bb2c547713826bdcee2d7ff0d0 100644 (file)
@@ -1,30 +1,47 @@
-<?php namespace Oxbow;
+<?php namespace BookStack;
 
-use Illuminate\Database\Eloquent\Model;
 
-class Chapter extends Model
+class Chapter extends Entity
 {
-
     protected $fillable = ['name', 'description', 'priority', 'book_id'];
 
+    /**
+     * Get the book this chapter is within.
+     * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
+     */
     public function book()
     {
-        return $this->belongsTo('Oxbow\Book');
+        return $this->belongsTo(Book::class);
     }
 
+    /**
+     * Get the pages that this chapter contains.
+     * @return mixed
+     */
     public function pages()
     {
-        return $this->hasMany('Oxbow\Page')->orderBy('priority', 'ASC');
+        return $this->hasMany(Page::class)->orderBy('priority', 'ASC');
     }
 
+    /**
+     * Get the url of this chapter.
+     * @return string
+     */
     public function getUrl()
     {
-        return '/books/' . $this->book->slug . '/chapter/' . $this->slug;
+        $bookSlug = $this->getAttribute('bookSlug') ? $this->getAttribute('bookSlug') : $this->book->slug;
+        return '/books/' . $bookSlug. '/chapter/' . $this->slug;
     }
 
+    /**
+     * Get an excerpt of this chapter's description to the specified length or less.
+     * @param int $length
+     * @return string
+     */
     public function getExcerpt($length = 100)
     {
-        return strlen($this->description) > $length ? substr($this->description, 0, $length-3) . '...' : $this->description;
+        $description = $this->description;
+        return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
     }
 
 }