BookStack/app/Entities/Bookshelf.php

121 lines
3.3 KiB
PHP
Raw Normal View History

<?php namespace BookStack\Entities;
use BookStack\Uploads\Image;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
2018-06-24 08:38:19 -04:00
class Bookshelf extends Entity implements HasCoverImage
2018-06-24 08:38:19 -04:00
{
protected $table = 'bookshelves';
public $searchFactor = 3;
protected $fillable = ['name', 'description', 'image_id'];
/**
* Get the books in this shelf.
* Should not be used directly since does not take into account permissions.
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function books()
{
return $this->belongsToMany(Book::class, 'bookshelves_books', 'bookshelf_id', 'book_id')
->withPivot('order')
->orderBy('order', 'asc');
}
/**
* Related books that are visible to the current user.
*/
public function visibleBooks(): BelongsToMany
{
return $this->books()->visible();
}
2018-06-24 08:38:19 -04:00
/**
* Get the url for this bookshelf.
* @param string|bool $path
* @return string
*/
public function getUrl($path = false)
{
if ($path !== false) {
return url('/shelves/' . urlencode($this->slug) . '/' . trim($path, '/'));
2018-06-24 08:38:19 -04:00
}
return url('/shelves/' . urlencode($this->slug));
2018-06-24 08:38:19 -04:00
}
/**
* Returns BookShelf cover image, if cover does not exists return default cover image.
* @param int $width - Width of the image
* @param int $height - Height of the image
* @return string
*/
public function getBookCover($width = 440, $height = 250)
{
// TODO - Make generic, focused on books right now, Perhaps set-up a better image
$default = 'data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw==';
2018-06-24 08:38:19 -04:00
if (!$this->image_id) {
return $default;
}
try {
$cover = $this->cover ? url($this->cover->getThumb($width, $height, false)) : $default;
2018-06-24 08:38:19 -04:00
} catch (\Exception $err) {
$cover = $default;
}
return $cover;
}
/**
* Get the cover image of the shelf
2018-06-24 08:38:19 -04:00
*/
public function cover(): BelongsTo
2018-06-24 08:38:19 -04:00
{
return $this->belongsTo(Image::class, 'image_id');
}
/**
* Get the type of the image model that is used when storing a cover image.
2018-06-24 08:38:19 -04:00
*/
public function coverImageTypeKey(): string
2018-06-24 08:38:19 -04:00
{
return 'cover_shelf';
2018-06-24 08:38:19 -04:00
}
/**
* Get an excerpt of this book's description to the specified length or less.
* @param int $length
2018-06-24 08:38:19 -04:00
* @return string
*/
public function getExcerpt(int $length = 100)
2018-06-24 08:38:19 -04:00
{
$description = $this->description;
return mb_strlen($description) > $length ? mb_substr($description, 0, $length-3) . '...' : $description;
2018-06-24 08:38:19 -04:00
}
/**
* Check if this shelf contains the given book.
* @param Book $book
* @return bool
*/
public function contains(Book $book): bool
{
return $this->books()->where('id', '=', $book->id)->count() > 0;
}
2019-09-19 13:20:09 -04:00
/**
* Add a book to the end of this shelf.
* @param Book $book
*/
public function appendBook(Book $book)
{
if ($this->contains($book)) {
return;
}
2019-09-19 13:20:09 -04:00
$maxOrder = $this->books()->max('order');
$this->books()->attach($book->id, ['order' => $maxOrder + 1]);
2019-09-19 13:20:09 -04:00
}
2018-06-24 08:38:19 -04:00
}