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

VolumeFile

abstract class VolumeFile extends Model implements File

Traits

HasJsonAttributes
HasFactory

Properties

bool $timestamps

Don't maintain timestamps for this model.

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.

string
getUrl()

Get the file URL.

BelongsTo
volume()

The volume this video belongs to.

setMetadataAttribute(array $value)

Set the metadata attribute.

array
getMetadataAttribute()

Get the metadata attribute.

setWidthAttribute(int $value)

Set the width attribute.

int|null
getWidthAttribute()

Get the width attribute.

setHeightAttribute(int $value)

Set the height attribute.

int|null
getHeightAttribute()

Get the height attribute.

setSizeAttribute(int $value)

Set the size attribute.

int|null
getSizeAttribute()

Get the size attribute.

string
getMimeTypeAttribute()

Get the mimeType attribute.

setMimeTypeAttribute(string $value)

Set the mimeType attribute.

string
getThumbnailUrlAttribute()

URL to the thumbnail of this file.

HasMany
labels()

The labels, this volume file got attached by the users.

HasMany
annotations()

The annotations that belong to this file.

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

at line 27
string getUrlAttribute()

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

Return Value

string

at line 35
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

at line 44
BelongsTo volume()

The volume this video belongs to.

Return Value

BelongsTo

at line 54
setMetadataAttribute(array $value)

Set the metadata attribute.

Parameters

array $value

at line 64
array getMetadataAttribute()

Get the metadata attribute.

Return Value

array

at line 74
setWidthAttribute(int $value)

Set the width attribute.

Parameters

int $value

at line 84
int|null getWidthAttribute()

Get the width attribute.

Return Value

int|null

at line 94
setHeightAttribute(int $value)

Set the height attribute.

Parameters

int $value

at line 104
int|null getHeightAttribute()

Get the height attribute.

Return Value

int|null

at line 114
setSizeAttribute(int $value)

Set the size attribute.

Parameters

int $value

at line 124
int|null getSizeAttribute()

Get the size attribute.

Return Value

int|null

at line 134
string getMimeTypeAttribute()

Get the mimeType attribute.

Return Value

string

at line 144
setMimeTypeAttribute(string $value)

Set the mimeType attribute.

Parameters

string $value

at line 154
abstract string getThumbnailUrlAttribute()

URL to the thumbnail of this file.

Return Value

string

at line 161
abstract HasMany labels()

The labels, this volume file got attached by the users.

Return Value

HasMany

at line 168
abstract HasMany annotations()

The annotations that belong to this file.

Return Value

HasMany