BookStack/app/Entities/Models/Bookshelf.php

122 lines
3.2 KiB
PHP
Raw Normal View History

2021-06-26 11:23:15 -04:00
<?php
namespace BookStack\Entities\Models;
use BookStack\Uploads\Image;
use Illuminate\Database\Eloquent\Factories\HasFactory;
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
{
use HasFactory;
2018-06-24 08:38:19 -04:00
protected $table = 'bookshelves';
public $searchFactor = 1.2;
2018-06-24 08:38:19 -04:00
protected $fillable = ['name', 'description', 'image_id'];
protected $hidden = ['restricted', 'image_id', 'deleted_at'];
/**
* Get the books in this shelf.
* Should not be used directly since does not take into account permissions.
2021-06-26 11:23:15 -04:00
*
* @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()->scopes('visible');
}
2018-06-24 08:38:19 -04:00
/**
* Get the url for this bookshelf.
*/
public function getUrl(string $path = ''): string
2018-06-24 08:38:19 -04:00
{
return url('/shelves/' . implode('/', [urlencode($this->slug), trim($path, '/')]));
2018-06-24 08:38:19 -04:00
}
/**
* Returns BookShelf cover image, if cover does not exists return default cover image.
2021-06-26 11:23:15 -04:00
*
* @param int $width - Width of the image
2018-06-24 08:38:19 -04:00
* @param int $height - Height of the image
2021-06-26 11:23:15 -04:00
*
2018-06-24 08:38:19 -04:00
* @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;
}
2021-06-26 11:23:15 -04:00
2018-06-24 08:38:19 -04:00
return $cover;
}
/**
2021-06-26 11:23:15 -04:00
* 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_bookshelf';
2018-06-24 08:38:19 -04:00
}
/**
* Check if this shelf contains the given book.
*/
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.
*/
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
}
/**
* Get a visible shelf by its slug.
* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
*/
public static function getBySlug(string $slug): self
{
return static::visible()->where('slug', '=', $slug)->firstOrFail();
}
2018-06-24 08:38:19 -04:00
}