]> BookStack Code Mirror - bookstack/blob - app/Entities/Bookshelf.php
switch spaces to tabs
[bookstack] / app / Entities / Bookshelf.php
1 <?php namespace BookStack\Entities;
2
3 use BookStack\Uploads\Image;
4
5 class Bookshelf extends Entity
6 {
7     protected $table = 'bookshelves';
8
9     public $searchFactor = 3;
10
11     protected $fillable = ['name', 'description', 'image_id'];
12
13     /**
14      * Get the morph class for this model.
15      * @return string
16      */
17     public function getMorphClass()
18     {
19         return 'BookStack\\Bookshelf';
20     }
21
22     /**
23      * Get the books in this shelf.
24      * Should not be used directly since does not take into account permissions.
25      * @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
26      */
27     public function books()
28     {
29         return $this->belongsToMany(Book::class, 'bookshelves_books', 'bookshelf_id', 'book_id')->orderBy('order', 'asc');
30     }
31
32     /**
33      * Get the url for this bookshelf.
34      * @param string|bool $path
35      * @return string
36      */
37     public function getUrl($path = false)
38     {
39         if ($path !== false) {
40             return baseUrl('/shelves/' . urlencode($this->slug) . '/' . trim($path, '/'));
41         }
42         return baseUrl('/shelves/' . urlencode($this->slug));
43     }
44
45     /**
46      * Returns BookShelf cover image, if cover does not exists return default cover image.
47      * @param int $width - Width of the image
48      * @param int $height - Height of the image
49      * @return string
50      */
51     public function getBookCover($width = 440, $height = 250)
52     {
53         $default = baseUrl('/book_default_cover.png');
54         if (!$this->image_id) {
55             return $default;
56         }
57
58         try {
59             $cover = $this->cover ? baseUrl($this->cover->getThumb($width, $height, false)) : $default;
60         } catch (\Exception $err) {
61             $cover = $default;
62         }
63         return $cover;
64     }
65
66     /**
67      * Get the cover image of the book
68      * @return \Illuminate\Database\Eloquent\Relations\BelongsTo
69      */
70     public function cover()
71     {
72         return $this->belongsTo(Image::class, 'image_id');
73     }
74
75     /**
76      * Get an excerpt of this book's description to the specified length or less.
77      * @param int $length
78      * @return string
79      */
80     public function getExcerpt($length = 100)
81     {
82         $description = $this->description;
83         return strlen($description) > $length ? substr($description, 0, $length-3) . '...' : $description;
84     }
85
86     /**
87      * Return a generalised, common raw query that can be 'unioned' across entities.
88      * @return string
89      */
90     public function entityRawQuery()
91     {
92         return "'BookStack\\\\BookShelf' 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";
93     }
94 }