1 <?php namespace BookStack;
3 class Book extends Entity
5 public $searchFactor = 2;
7 protected $fillable = ['name', 'description', 'image_id'];
10 * Get the url for this book.
11 * @param string|bool $path
14 public function getUrl($path = false)
16 if ($path !== false) {
17 return baseUrl('/books/' . urlencode($this->slug) . '/' . trim($path, '/'));
19 return baseUrl('/books/' . urlencode($this->slug));
23 * Returns book cover image, if book cover not exists return default cover image.
24 * @param int $width - Width of the image
25 * @param int $height - Height of the image
28 public function getBookCover($width = 440, $height = 250)
30 $default = baseUrl('/book_default_cover.png');
31 if (!$this->image_id) {
36 $cover = $this->cover ? baseUrl($this->cover->getThumb($width, $height, false)) : $default;
37 } catch (\Exception $err) {
44 * Get the cover image of the book
45 * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
47 public function cover()
49 return $this->belongsTo(Image::class, 'image_id');
53 * Get all pages within this book.
54 * @return \Illuminate\Database\Eloquent\Relations\HasMany
56 public function pages()
58 return $this->hasMany(Page::class);
62 * Get all chapters within this book.
63 * @return \Illuminate\Database\Eloquent\Relations\HasMany
65 public function chapters()
67 return $this->hasMany(Chapter::class);
71 * Get an excerpt of this book's description to the specified length or less.
75 public function getExcerpt($length = 100)
77 $description = $this->description;
78 return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
82 * Return a generalised, common raw query that can be 'unioned' across entities.
85 public function entityRawQuery()
87 return "'BookStack\\\\Book' as entity_type, id, id as entity_id, slug, name, {$this->textField} as text,'' as html, '0' as book_id, '0' as priority, '0' as chapter_id, '0' as draft, created_by, updated_by, updated_at, created_at";