67 lines
1.9 KiB
PHP
67 lines
1.9 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Uploads;
|
|
|
|
use BookStack\App\Model;
|
|
use BookStack\Entities\Models\Page;
|
|
use BookStack\Permissions\Models\JointPermission;
|
|
use BookStack\Permissions\PermissionApplicator;
|
|
use BookStack\Users\Models\HasCreatorAndUpdater;
|
|
use Illuminate\Database\Eloquent\Builder;
|
|
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
|
use Illuminate\Database\Eloquent\Relations\HasMany;
|
|
|
|
/**
|
|
* @property int $id
|
|
* @property string $name
|
|
* @property string $url
|
|
* @property string $path
|
|
* @property string $type
|
|
* @property int $uploaded_to
|
|
* @property int $created_by
|
|
* @property int $updated_by
|
|
*/
|
|
class Image extends Model
|
|
{
|
|
use HasFactory;
|
|
use HasCreatorAndUpdater;
|
|
|
|
protected $fillable = ['name'];
|
|
protected $hidden = [];
|
|
|
|
public function jointPermissions(): HasMany
|
|
{
|
|
return $this->hasMany(JointPermission::class, 'entity_id', 'uploaded_to')
|
|
->where('joint_permissions.entity_type', '=', 'page');
|
|
}
|
|
|
|
/**
|
|
* 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 URL for this image.
|
|
* Attempts to generate the thumbnail if not already existing.
|
|
*
|
|
* @throws \Exception
|
|
*/
|
|
public function getThumb(?int $width, ?int $height, bool $keepRatio = false): ?string
|
|
{
|
|
return app()->make(ImageResizer::class)->resizeToThumbnailUrl($this, $width, $height, $keepRatio, false);
|
|
}
|
|
|
|
/**
|
|
* 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();
|
|
}
|
|
}
|