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('BookStack\Book');
+ return $this->belongsTo(Book::class);
}
+ /**
+ * Get the pages that this chapter contains.
+ * @return mixed
+ */
public function pages()
{
- return $this->hasMany('BookStack\Page')->orderBy('priority', 'ASC');
+ return $this->hasMany(Page::class)->orderBy('priority', 'ASC');
}
- public function getUrl()
+ /**
+ * Get the url of this chapter.
+ * @param string|bool $path
+ * @return string
+ */
+ public function getUrl($path = false)
{
- $bookSlug = isset($this->bookSlug) ? $this->bookSlug : $this->book->slug;
- return '/books/' . $bookSlug. '/chapter/' . $this->slug;
+ $bookSlug = $this->getAttribute('bookSlug') ? $this->getAttribute('bookSlug') : $this->book->slug;
+ if ($path !== false) {
+ return baseUrl('/books/' . urlencode($bookSlug) . '/chapter/' . urlencode($this->slug) . '/' . trim($path, '/'));
+ }
+ return baseUrl('/books/' . urlencode($bookSlug) . '/chapter/' . urlencode($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;
}
}