BookStack/app/Uploads/Image.php

66 lines
1.8 KiB
PHP
Raw Normal View History

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;
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;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Relations\HasMany;
/**
2021-06-26 11:23:15 -04:00
* @property int $id
* @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
*/
class Image extends Model
2015-07-13 16:52:56 -04:00
{
use HasFactory;
use HasCreatorAndUpdater;
2015-08-15 19:18:22 -04:00
protected $fillable = ['name'];
protected $hidden = [];
2015-08-15 19:18:22 -04: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');
}
/**
* Get a thumbnail for this image.
2021-06-26 11:23:15 -04:00
*
* @throws \Exception
*/
public function getThumb(?int $width, ?int $height, bool $keepRatio = false): string
{
return app()->make(ImageService::class)->getThumbnail($this, $width, $height, $keepRatio);
}
/**
* Get the page this image has been uploaded to.
* Only applicable to gallery or drawio image types.
*/
public function getPage(): ?Page
{
return $this->belongsTo(Page::class, 'uploaded_to')->first();
}
2015-07-13 16:52:56 -04:00
}