BookStack/app/Entities/Book.php

132 lines
3.4 KiB
PHP
Raw Normal View History

<?php namespace BookStack\Entities;
use BookStack\Uploads\Image;
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 15:01:42 -04:00
/**
* Class Book
* @property string $description
* @property int $image_id
* @property Image|null $cover
* @package BookStack\Entities
*/
class Book extends Entity implements HasCoverImage
2015-07-12 15:01:42 -04:00
{
public $searchFactor = 2;
2015-07-12 15:01:42 -04:00
protected $fillable = ['name', 'description'];
2020-05-22 19:28:41 -04:00
protected $hidden = ['restricted', 'pivot', 'image_id'];
2015-07-12 15:01:42 -04:00
/**
* Get the url for this book.
* @param string|bool $path
* @return string
*/
public function getUrl($path = false)
2015-07-12 15:01:42 -04:00
{
if ($path !== false) {
return url('/books/' . urlencode($this->slug) . '/' . trim($path, '/'));
}
return url('/books/' . urlencode($this->slug));
2015-07-12 15:01:42 -04:00
}
2017-09-04 10:57:52 -04:00
/**
* Returns book cover image, if book cover not exists return default cover image.
* @param int $width - Width of the image
* @param int $height - Height of the image
* @return string
2017-09-04 10:57:52 -04:00
*/
public function getBookCover($width = 440, $height = 250)
{
$default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==';
if (!$this->image_id) {
return $default;
}
try {
$cover = $this->cover ? url($this->cover->getThumb($width, $height, false)) : $default;
} catch (Exception $err) {
$cover = $default;
}
return $cover;
}
2017-09-04 10:57:52 -04:00
/**
* Get the cover image of the book
*/
public function cover(): BelongsTo
{
2017-09-04 10:57:52 -04:00
return $this->belongsTo(Image::class, 'image_id');
}
2015-07-12 15:01:42 -04:00
/**
* Get the type of the image model that is used when storing a cover image.
*/
public function coverImageTypeKey(): string
{
return 'cover_book';
}
/**
* Get all pages within this book.
* @return HasMany
*/
2015-07-12 16:31:15 -04:00
public function pages()
{
return $this->hasMany(Page::class);
2015-07-12 16:31:15 -04:00
}
/**
* Get the direct child pages of this book.
* @return HasMany
*/
public function directPages()
{
return $this->pages()->where('chapter_id', '=', '0');
}
/**
* Get all chapters within this book.
* @return HasMany
*/
2015-07-27 15:17:08 -04:00
public function chapters()
{
return $this->hasMany(Chapter::class);
2015-07-27 15:17:08 -04:00
}
/**
* Get the shelves this book is contained within.
* @return BelongsToMany
*/
public function shelves()
{
return $this->belongsToMany(Bookshelf::class, 'bookshelves_books', 'book_id', 'bookshelf_id');
}
/**
* Get the direct child items within this book.
* @return Collection
*/
public function getDirectChildren(): Collection
{
$pages = $this->directPages()->visible()->get();
$chapters = $this->chapters()->visible()->get();
return $pages->concat($chapters)->sortBy('priority')->sortByDesc('draft');
}
/**
* Get an excerpt of this book's description to the specified length or less.
* @param int $length
* @return string
*/
public function getExcerpt(int $length = 100)
{
$description = $this->description;
return mb_strlen($description) > $length ? mb_substr($description, 0, $length-3) . '...' : $description;
}
2015-07-12 15:01:42 -04:00
}