2018-09-25 13:30:50 +02:00
|
|
|
<?php namespace BookStack\Entities;
|
|
|
|
|
|
|
|
use BookStack\Uploads\Image;
|
2019-10-05 13:55:01 +02:00
|
|
|
use Exception;
|
|
|
|
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
|
|
|
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
|
|
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
|
|
use Illuminate\Support\Collection;
|
2015-07-12 21:01:42 +02:00
|
|
|
|
2019-09-19 19:03:17 +02:00
|
|
|
/**
|
|
|
|
* Class Book
|
|
|
|
* @property string $description
|
|
|
|
* @property int $image_id
|
|
|
|
* @property Image|null $cover
|
|
|
|
* @package BookStack\Entities
|
|
|
|
*/
|
2019-10-05 13:55:01 +02:00
|
|
|
class Book extends Entity implements HasCoverImage
|
2015-07-12 21:01:42 +02:00
|
|
|
{
|
2018-03-24 19:46:31 +01:00
|
|
|
public $searchFactor = 2;
|
2015-07-12 21:01:42 +02:00
|
|
|
|
2017-09-04 16:57:52 +02:00
|
|
|
protected $fillable = ['name', 'description', 'image_id'];
|
2015-07-12 21:01:42 +02:00
|
|
|
|
2016-05-01 22:20:50 +02:00
|
|
|
/**
|
|
|
|
* Get the url for this book.
|
2016-08-14 13:29:35 +02:00
|
|
|
* @param string|bool $path
|
2016-05-01 22:20:50 +02:00
|
|
|
* @return string
|
|
|
|
*/
|
2016-08-14 13:29:35 +02:00
|
|
|
public function getUrl($path = false)
|
2015-07-12 21:01:42 +02:00
|
|
|
{
|
2016-08-14 13:29:35 +02:00
|
|
|
if ($path !== false) {
|
2019-08-04 15:26:39 +02:00
|
|
|
return url('/books/' . urlencode($this->slug) . '/' . trim($path, '/'));
|
2016-08-14 13:29:35 +02:00
|
|
|
}
|
2019-08-04 15:26:39 +02:00
|
|
|
return url('/books/' . urlencode($this->slug));
|
2015-07-12 21:01:42 +02:00
|
|
|
}
|
2017-12-06 18:32:29 +01:00
|
|
|
|
2017-09-04 16:57:52 +02:00
|
|
|
/**
|
|
|
|
* Returns book cover image, if book cover not exists return default cover image.
|
2017-12-06 17:34:26 +01:00
|
|
|
* @param int $width - Width of the image
|
2017-12-06 18:32:29 +01:00
|
|
|
* @param int $height - Height of the image
|
2017-12-06 17:34:26 +01:00
|
|
|
* @return string
|
2017-09-04 16:57:52 +02:00
|
|
|
*/
|
2017-12-06 18:32:29 +01:00
|
|
|
public function getBookCover($width = 440, $height = 250)
|
2017-07-07 12:59:38 +02:00
|
|
|
{
|
2019-02-16 18:13:01 +01:00
|
|
|
$default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==';
|
2018-01-28 17:58:52 +01:00
|
|
|
if (!$this->image_id) {
|
|
|
|
return $default;
|
|
|
|
}
|
2017-12-06 17:34:26 +01:00
|
|
|
|
2017-07-07 12:59:38 +02:00
|
|
|
try {
|
2019-08-04 15:26:39 +02:00
|
|
|
$cover = $this->cover ? url($this->cover->getThumb($width, $height, false)) : $default;
|
2019-10-05 13:55:01 +02:00
|
|
|
} catch (Exception $err) {
|
2017-07-07 12:59:38 +02:00
|
|
|
$cover = $default;
|
|
|
|
}
|
|
|
|
return $cover;
|
|
|
|
}
|
2017-12-06 18:32:29 +01:00
|
|
|
|
2017-09-04 16:57:52 +02:00
|
|
|
/**
|
|
|
|
* Get the cover image of the book
|
|
|
|
*/
|
2019-10-05 13:55:01 +02:00
|
|
|
public function cover(): BelongsTo
|
2017-07-07 12:59:38 +02:00
|
|
|
{
|
2017-09-04 16:57:52 +02:00
|
|
|
return $this->belongsTo(Image::class, 'image_id');
|
2017-07-07 12:59:38 +02:00
|
|
|
}
|
2015-07-12 21:01:42 +02:00
|
|
|
|
2019-10-05 13:55:01 +02:00
|
|
|
/**
|
|
|
|
* Get the type of the image model that is used when storing a cover image.
|
|
|
|
*/
|
|
|
|
public function coverImageTypeKey(): string
|
|
|
|
{
|
|
|
|
return 'cover_book';
|
|
|
|
}
|
|
|
|
|
2016-05-01 22:20:50 +02:00
|
|
|
/**
|
|
|
|
* Get all pages within this book.
|
2019-10-05 13:55:01 +02:00
|
|
|
* @return HasMany
|
2016-05-01 22:20:50 +02:00
|
|
|
*/
|
2015-07-12 22:31:15 +02:00
|
|
|
public function pages()
|
|
|
|
{
|
2016-05-01 22:20:50 +02:00
|
|
|
return $this->hasMany(Page::class);
|
2015-07-12 22:31:15 +02:00
|
|
|
}
|
|
|
|
|
2019-02-24 16:57:35 +01:00
|
|
|
/**
|
|
|
|
* Get the direct child pages of this book.
|
2019-10-05 13:55:01 +02:00
|
|
|
* @return HasMany
|
2019-02-24 16:57:35 +01:00
|
|
|
*/
|
|
|
|
public function directPages()
|
|
|
|
{
|
|
|
|
return $this->pages()->where('chapter_id', '=', '0');
|
|
|
|
}
|
|
|
|
|
2016-05-01 22:20:50 +02:00
|
|
|
/**
|
|
|
|
* Get all chapters within this book.
|
2019-10-05 13:55:01 +02:00
|
|
|
* @return HasMany
|
2016-05-01 22:20:50 +02:00
|
|
|
*/
|
2015-07-27 21:17:08 +02:00
|
|
|
public function chapters()
|
|
|
|
{
|
2016-05-01 22:20:50 +02:00
|
|
|
return $this->hasMany(Chapter::class);
|
2015-07-27 21:17:08 +02:00
|
|
|
}
|
|
|
|
|
2018-09-20 16:27:30 +02:00
|
|
|
/**
|
|
|
|
* Get the shelves this book is contained within.
|
2019-10-05 13:55:01 +02:00
|
|
|
* @return BelongsToMany
|
2018-09-20 16:27:30 +02:00
|
|
|
*/
|
|
|
|
public function shelves()
|
|
|
|
{
|
|
|
|
return $this->belongsToMany(Bookshelf::class, 'bookshelves_books', 'book_id', 'bookshelf_id');
|
|
|
|
}
|
|
|
|
|
2016-05-01 22:20:50 +02:00
|
|
|
/**
|
2019-10-05 13:55:01 +02:00
|
|
|
* Get the direct child items within this book.
|
|
|
|
* @return Collection
|
2016-05-01 22:20:50 +02:00
|
|
|
*/
|
2019-10-05 13:55:01 +02:00
|
|
|
public function getDirectChildren(): Collection
|
2015-08-31 21:11:44 +02:00
|
|
|
{
|
2019-10-05 13:55:01 +02:00
|
|
|
$pages = $this->directPages()->visible()->get();
|
|
|
|
$chapters = $this->chapters()->visible()->get();
|
|
|
|
return $pages->contact($chapters)->sortBy('priority')->sortByDesc('draft');
|
2015-08-31 21:11:44 +02:00
|
|
|
}
|
|
|
|
|
2017-03-19 13:48:44 +01:00
|
|
|
/**
|
2019-10-05 13:55:01 +02:00
|
|
|
* Get an excerpt of this book's description to the specified length or less.
|
|
|
|
* @param int $length
|
2017-03-19 13:48:44 +01:00
|
|
|
* @return string
|
|
|
|
*/
|
2019-10-05 13:55:01 +02:00
|
|
|
public function getExcerpt(int $length = 100)
|
2017-03-19 13:48:44 +01:00
|
|
|
{
|
2019-10-05 13:55:01 +02:00
|
|
|
$description = $this->description;
|
|
|
|
return mb_strlen($description) > $length ? mb_substr($description, 0, $length-3) . '...' : $description;
|
2017-03-19 13:48:44 +01:00
|
|
|
}
|
2015-07-12 21:01:42 +02:00
|
|
|
}
|