]> BookStack Code Mirror - bookstack/blob - app/Book.php
Started work on bookshelves
[bookstack] / app / Book.php
1 <?php namespace BookStack;
2
3 class Book extends Entity
4 {
5     public $searchFactor = 2;
6
7     protected $fillable = ['name', 'description', 'image_id'];
8
9     /**
10      * Get the url for this book.
11      * @param string|bool $path
12      * @return string
13      */
14     public function getUrl($path = false)
15     {
16         if ($path !== false) {
17             return baseUrl('/books/' . urlencode($this->slug) . '/' . trim($path, '/'));
18         }
19         return baseUrl('/books/' . urlencode($this->slug));
20     }
21
22     /**
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
26      * @return string
27      */
28     public function getBookCover($width = 440, $height = 250)
29     {
30         $default = baseUrl('/book_default_cover.png');
31         if (!$this->image_id) {
32             return $default;
33         }
34
35         try {
36             $cover = $this->cover ? baseUrl($this->cover->getThumb($width, $height, false)) : $default;
37         } catch (\Exception $err) {
38             $cover = $default;
39         }
40         return $cover;
41     }
42
43     /**
44      * Get the cover image of the book
45      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
46      */
47     public function cover()
48     {
49         return $this->belongsTo(Image::class, 'image_id');
50     }
51
52     /**
53      * Get all pages within this book.
54      * @return \Illuminate\Database\Eloquent\Relations\HasMany
55      */
56     public function pages()
57     {
58         return $this->hasMany(Page::class);
59     }
60
61     /**
62      * Get all chapters within this book.
63      * @return \Illuminate\Database\Eloquent\Relations\HasMany
64      */
65     public function chapters()
66     {
67         return $this->hasMany(Chapter::class);
68     }
69
70     /**
71      * Get an excerpt of this book's description to the specified length or less.
72      * @param int $length
73      * @return string
74      */
75     public function getExcerpt($length = 100)
76     {
77         $description = $this->description;
78         return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
79     }
80
81     /**
82      * Return a generalised, common raw query that can be 'unioned' across entities.
83      * @return string
84      */
85     public function entityRawQuery()
86     {
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";
88     }
89 }