1 <?php namespace BookStack;
3 class Book extends Entity
6 protected $fillable = ['name', 'description', 'image_id'];
9 * Get the url for this book.
10 * @param string|bool $path
13 public function getUrl($path = false)
15 if ($path !== false) {
16 return baseUrl('/books/' . urlencode($this->slug) . '/' . trim($path, '/'));
18 return baseUrl('/books/' . urlencode($this->slug));
22 * Returns book cover image, if book cover not exists return default cover image.
23 * @param int $height - Height of the image
24 * @param type $width - Width of the image
27 public function getBookCover($height = 170, $width = 300)
29 $default = baseUrl('/book_default_cover.png');
30 $image = $this->image_id;
31 if ($image === 0 || $image === '0' || $image === null)
34 $cover = $this->cover ? baseUrl($this->cover->getThumb($width, $height, false)) : $default;
35 } catch (\Exception $err) {
42 * Get an excerpt of this book's name to the specified length or less.
46 public function getHeadingExcerpt($length = 35)
48 $bookHeading = $this->name;
49 return strlen($bookHeading) > $length ? substr($bookHeading, 0, $length-3) . '...' : $bookHeading;
53 * Get the cover image of the book
54 * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
56 public function cover()
58 return $this->belongsTo(Image::class, 'image_id');
61 * Get the edit url for this book.
64 public function getEditUrl()
66 return $this->getUrl() . '/edit';
70 * Get all pages within this book.
71 * @return \Illuminate\Database\Eloquent\Relations\HasMany
73 public function pages()
75 return $this->hasMany(Page::class);
79 * Get all chapters within this book.
80 * @return \Illuminate\Database\Eloquent\Relations\HasMany
82 public function chapters()
84 return $this->hasMany(Chapter::class);
88 * Get an excerpt of this book's description to the specified length or less.
92 public function getExcerpt($length = 100)
94 $description = $this->description;
95 return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
99 * Return a generalised, common raw query that can be 'unioned' across entities.
102 public function entityRawQuery()
104 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";
108 * Get the user that created the page revision
109 * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
111 public function createdBy()
113 return $this->belongsTo(User::class, 'created_by');