1. class
  2. Biigle
  3. \
  4. Image

Image

class Image extends VolumeFile

This model stores information on an image file in the file system.

Traits

HasJsonAttributes
HasFactory

Constants

MIMES

Allowed image MIME types.

Properties

int $id from  VolumeFile
int $volume_id from  VolumeFile
string $filename from  VolumeFile
string $uuid from  VolumeFile

Methods

setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')

Set a dynamic JSON attribute.

from  HasJsonAttributes
mixed
getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')

Get a dynamic JSON attribute.

from  HasJsonAttributes
string
getUrlAttribute()

Adds the url attribute to the model. The url is the absolute path to the original file.

from  VolumeFile
string
getUrl()

Get the file URL.

from  VolumeFile
VolumeFile>
volume()

The volume this video belongs to.

from  VolumeFile
setMetadataAttribute(array|null $value)

Set the metadata attribute.

from  VolumeFile
array|null
getMetadataAttribute()

Get the metadata attribute.

from  VolumeFile
setWidthAttribute(int $value)

Set the width attribute.

from  VolumeFile
int|null
getWidthAttribute()

Get the width attribute.

from  VolumeFile
setHeightAttribute(int $value)

Set the height attribute.

from  VolumeFile
int|null
getHeightAttribute()

Get the height attribute.

from  VolumeFile
setSizeAttribute(int $value)

Set the size attribute.

from  VolumeFile
int|null
getSizeAttribute()

Get the size attribute.

from  VolumeFile
string
getMimeTypeAttribute()

Get the mimeType attribute.

from  VolumeFile
setMimeTypeAttribute(string $value)

Set the mimeType attribute.

from  VolumeFile
string
getThumbnailUrlAttribute()

URL to the thumbnail of this image.

VolumeFileLabel, $this>
labels()

The labels, this image got attached by the users.

Annotation, $this>
annotations()

The annotations on this image.

array
casts()

Get the attributes that should be cast.

array<string, mixed>|RedirectResponse|StreamedResponse
getFile()

Get the original image as download response.

setTilingInProgressAttribute(bool $value)

Set the tilingInProgress attribute.

bool|null
getTilingInProgressAttribute()

Get the tilingInProgress attribute.

Details

in HasJsonAttributes at line 16
protected setJsonAttr(string $key, mixed $value, string $attrs = 'attrs')

Set a dynamic JSON attribute.

Parameters

string $key

Key of the attribute in the JSON.
mixed $value

Value of the attribute in the JSON.
string $attrs

Name of the JSON column of the model.

in HasJsonAttributes at line 38
protected mixed getJsonAttr(string $key, mixed $default = null, string $attrs = 'attrs')

Get a dynamic JSON attribute.

Parameters

string $key

Key of the attribute in the JSON.
mixed $default

Default value.
string $attrs

Name of the JSON column of the model.

Return Value

mixed

in VolumeFile at line 28
string getUrlAttribute()

Adds the url attribute to the model. The url is the absolute path to the original file.

Return Value

string

in VolumeFile at line 36
string getUrl()

Get the file URL.

This may be a remote URL starting with "http://" or "https://", or a storage disk path starting with "[disk-name]://".

Return Value

string

in VolumeFile at line 46
VolumeFile> volume()

The volume this video belongs to.

Return Value

VolumeFile>

in VolumeFile at line 54
setMetadataAttribute(array|null $value)

Set the metadata attribute.

Parameters

array|null $value

in VolumeFile at line 62
array|null getMetadataAttribute()

Get the metadata attribute.

Return Value

array|null

in VolumeFile at line 72
setWidthAttribute(int $value)

Set the width attribute.

Parameters

int $value

in VolumeFile at line 82
int|null getWidthAttribute()

Get the width attribute.

Return Value

int|null

in VolumeFile at line 92
setHeightAttribute(int $value)

Set the height attribute.

Parameters

int $value

in VolumeFile at line 102
int|null getHeightAttribute()

Get the height attribute.

Return Value

int|null

in VolumeFile at line 112
setSizeAttribute(int $value)

Set the size attribute.

Parameters

int $value

in VolumeFile at line 122
int|null getSizeAttribute()

Get the size attribute.

Return Value

int|null

in VolumeFile at line 132
string getMimeTypeAttribute()

Get the mimeType attribute.

Return Value

string

in VolumeFile at line 142
setMimeTypeAttribute(string $value)

Set the mimeType attribute.

Parameters

string $value

at line 150
string getThumbnailUrlAttribute()

URL to the thumbnail of this image.

Return Value

string

at line 66
VolumeFileLabel, $this> labels()

The labels, this image got attached by the users.

Return Value

VolumeFileLabel, $this>

at line 56
Annotation, $this> annotations()

The annotations on this image.

Return Value

Annotation, $this>

at line 40
protected array casts()

Get the attributes that should be cast.

Return Value

array

at line 76
array<string, mixed>|RedirectResponse|StreamedResponse getFile()

Get the original image as download response.

Return Value

array<string, mixed>|RedirectResponse|StreamedResponse

at line 130
setTilingInProgressAttribute(bool $value)

Set the tilingInProgress attribute.

Parameters

bool $value

at line 140
bool|null getTilingInProgressAttribute()

Get the tilingInProgress attribute.

Return Value

bool|null