BookStack Code Mirror - bookstack/blob - app/Chapter.php

   1 <?php namespace BookStack;
   2
   3
   4 class Chapter extends Entity
   5 {
   6     protected $fillable = ['name', 'description', 'priority', 'book_id'];
   7
   8     protected $with = ['book'];
   9
  10     /**
  11      * Get the book this chapter is within.
  12      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
  13      */
  14     public function book()
  15     {
  16         return $this->belongsTo(Book::class);
  17     }
  18
  19     /**
  20      * Get the pages that this chapter contains.
  21      * @return mixed
  22      */
  23     public function pages()
  24     {
  25         return $this->hasMany(Page::class)->orderBy('priority', 'ASC');
  26     }
  27
  28     /**
  29      * Get the url of this chapter.
  30      * @param string|bool $path
  31      * @return string
  32      */
  33     public function getUrl($path = false)
  34     {
  35         $bookSlug = $this->getAttribute('bookSlug') ? $this->getAttribute('bookSlug') : $this->book->slug;
  36         if ($path !== false) {
  37             return baseUrl('/books/' . urlencode($bookSlug) . '/chapter/' . urlencode($this->slug) . '/' . trim($path, '/'));
  38         }
  39         return baseUrl('/books/' . urlencode($bookSlug) . '/chapter/' . urlencode($this->slug));
  40     }
  41
  42     /**
  43      * Get an excerpt of this chapter's description to the specified length or less.
  44      * @param int $length
  45      * @return string
  46      */
  47     public function getExcerpt($length = 100)
  48     {
  49         $description = $this->description;
  50         return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
  51     }
  52
  53 }