2021-06-26 11:23:15 -04:00
|
|
|
<?php
|
|
|
|
|
|
|
|
namespace BookStack\Uploads;
|
2015-07-13 16:52:56 -04:00
|
|
|
|
2023-05-17 12:56:55 -04:00
|
|
|
use BookStack\App\Model;
|
2020-11-21 19:17:45 -05:00
|
|
|
use BookStack\Entities\Models\Page;
|
2023-05-17 12:56:55 -04:00
|
|
|
use BookStack\Permissions\Models\JointPermission;
|
|
|
|
use BookStack\Permissions\PermissionApplicator;
|
|
|
|
use BookStack\Users\Models\HasCreatorAndUpdater;
|
2023-03-14 08:19:19 -04:00
|
|
|
use Illuminate\Database\Eloquent\Builder;
|
2021-10-30 16:29:59 -04:00
|
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
2023-01-24 14:04:32 -05:00
|
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
2015-12-09 14:50:17 -05:00
|
|
|
|
2021-06-04 17:59:31 -04:00
|
|
|
/**
|
2021-06-26 11:23:15 -04:00
|
|
|
* @property int $id
|
2021-06-04 17:59:31 -04:00
|
|
|
* @property string $name
|
|
|
|
* @property string $url
|
|
|
|
* @property string $path
|
|
|
|
* @property string $type
|
2021-06-26 11:23:15 -04:00
|
|
|
* @property int $uploaded_to
|
|
|
|
* @property int $created_by
|
|
|
|
* @property int $updated_by
|
2021-06-04 17:59:31 -04:00
|
|
|
*/
|
2020-12-30 13:25:35 -05:00
|
|
|
class Image extends Model
|
2015-07-13 16:52:56 -04:00
|
|
|
{
|
2021-10-30 16:29:59 -04:00
|
|
|
use HasFactory;
|
2020-12-30 13:25:35 -05:00
|
|
|
use HasCreatorAndUpdater;
|
2015-08-15 19:18:22 -04:00
|
|
|
|
|
|
|
protected $fillable = ['name'];
|
2020-01-12 09:45:54 -05:00
|
|
|
protected $hidden = [];
|
2015-08-15 19:18:22 -04:00
|
|
|
|
2023-01-24 14:04:32 -05:00
|
|
|
public function jointPermissions(): HasMany
|
|
|
|
{
|
|
|
|
return $this->hasMany(JointPermission::class, 'entity_id', 'uploaded_to')
|
|
|
|
->where('joint_permissions.entity_type', '=', 'page');
|
|
|
|
}
|
|
|
|
|
2023-03-14 08:19:19 -04:00
|
|
|
/**
|
|
|
|
* Scope the query to just the images visible to the user based upon the
|
|
|
|
* user visibility of the uploaded_to page.
|
|
|
|
*/
|
|
|
|
public function scopeVisible(Builder $query): Builder
|
|
|
|
{
|
|
|
|
return app()->make(PermissionApplicator::class)->restrictPageRelationQuery($query, 'images', 'uploaded_to');
|
|
|
|
}
|
|
|
|
|
2015-09-04 12:50:52 -04:00
|
|
|
/**
|
2015-12-09 14:50:17 -05:00
|
|
|
* Get a thumbnail for this image.
|
2021-06-26 11:23:15 -04:00
|
|
|
*
|
2018-05-13 07:07:38 -04:00
|
|
|
* @throws \Exception
|
2015-09-04 12:50:52 -04:00
|
|
|
*/
|
2023-03-14 15:29:08 -04:00
|
|
|
public function getThumb(?int $width, ?int $height, bool $keepRatio = false): string
|
2015-09-04 12:50:52 -04:00
|
|
|
{
|
2021-05-24 13:45:08 -04:00
|
|
|
return app()->make(ImageService::class)->getThumbnail($this, $width, $height, $keepRatio);
|
2015-09-04 12:50:52 -04:00
|
|
|
}
|
2019-05-04 10:48:15 -04:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the page this image has been uploaded to.
|
|
|
|
* Only applicable to gallery or drawio image types.
|
|
|
|
*/
|
2021-05-24 13:45:08 -04:00
|
|
|
public function getPage(): ?Page
|
2019-05-04 10:48:15 -04:00
|
|
|
{
|
|
|
|
return $this->belongsTo(Page::class, 'uploaded_to')->first();
|
|
|
|
}
|
2015-07-13 16:52:56 -04:00
|
|
|
}
|