2021-06-26 15:23:15 +00:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Uploads;
|
2015-07-13 21:52:56 +01:00
|
|
|
|
2020-11-22 00:17:45 +00:00
|
|
|
use BookStack\Entities\Models\Page;
|
2020-12-30 18:25:35 +00:00
|
|
|
use BookStack\Model;
|
|
|
|
use BookStack\Traits\HasCreatorAndUpdater;
|
2015-12-09 19:50:17 +00:00
|
|
|
|
2021-06-04 22:59:31 +01:00
|
|
|
/**
|
2021-06-26 15:23:15 +00:00
|
|
|
* @property int $id
|
2021-06-04 22:59:31 +01:00
|
|
|
* @property string $name
|
|
|
|
* @property string $url
|
|
|
|
* @property string $path
|
|
|
|
* @property string $type
|
2021-06-26 15:23:15 +00:00
|
|
|
* @property int $uploaded_to
|
|
|
|
* @property int $created_by
|
|
|
|
* @property int $updated_by
|
2021-06-04 22:59:31 +01:00
|
|
|
*/
|
2020-12-30 18:25:35 +00:00
|
|
|
class Image extends Model
|
2015-07-13 21:52:56 +01:00
|
|
|
{
|
2020-12-30 18:25:35 +00:00
|
|
|
use HasCreatorAndUpdater;
|
2015-08-16 00:18:22 +01:00
|
|
|
|
|
|
|
protected $fillable = ['name'];
|
2020-01-12 14:45:54 +00:00
|
|
|
protected $hidden = [];
|
2015-08-16 00:18:22 +01:00
|
|
|
|
2015-09-04 17:50:52 +01:00
|
|
|
/**
|
2015-12-09 19:50:17 +00:00
|
|
|
* Get a thumbnail for this image.
|
2021-06-26 15:23:15 +00:00
|
|
|
*
|
2018-05-13 12:07:38 +01:00
|
|
|
* @throws \Exception
|
2015-09-04 17:50:52 +01:00
|
|
|
*/
|
2021-05-24 18:45:08 +01:00
|
|
|
public function getThumb(int $width, int $height, bool $keepRatio = false): string
|
2015-09-04 17:50:52 +01:00
|
|
|
{
|
2021-05-24 18:45:08 +01:00
|
|
|
return app()->make(ImageService::class)->getThumbnail($this, $width, $height, $keepRatio);
|
2015-09-04 17:50:52 +01:00
|
|
|
}
|
2019-05-04 15:48:15 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the page this image has been uploaded to.
|
|
|
|
* Only applicable to gallery or drawio image types.
|
|
|
|
*/
|
2021-05-24 18:45:08 +01:00
|
|
|
public function getPage(): ?Page
|
2019-05-04 15:48:15 +01:00
|
|
|
{
|
|
|
|
return $this->belongsTo(Page::class, 'uploaded_to')->first();
|
|
|
|
}
|
2015-07-13 21:52:56 +01:00
|
|
|
}
|