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

Volume

class Volume extends Model

A volume is a collection of images. Volumes belong to one or many projects.

Traits

HasJsonAttributes
HasFactory
HasMetadataFile

Constants

IMAGE_FILE_REGEX

Regular expression that matches the supported image file extensions.

This regex allows optional HTTP query parameters after the file names, too. Example "image.jpg?raw=1". This may be required for remote images with services like Dropbox.
VIDEO_FILE_REGEX

Regular expression that matches the supported video file extensions.

This regex allows optional HTTP query parameters after the file names, too. Example "video.mp4?raw=1". This may be required for remote files with services like Dropbox.

Properties

protected list<string> $fillable

The attributes that are mass assignable.
protected list<string> $hidden

The attributes hidden from the model's JSON form.
protected array<string,string> $casts

The attributes that should be casted to native types.

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
getMetadataFileDisk()

{@inheritdoc}

bool
hasMetadata()

No description

from  HasMetadataFile
void
saveMetadata(UploadedFile $file)

No description

from  HasMetadataFile
VolumeMetadata|null
getMetadata()

No description

from  HasMetadataFile
void
deleteMetadata(bool $noUpdate = false)

No description

from  HasMetadataFile
static array
parseFilesQueryString(string $string)

Parses a comma separated list of filenames to an array.

Builder
scopeAccessibleBy(Builder $query, User $user)

Scope a query to all volumes that are accessible by a user.

User,$this>
creator()

The user that created the volume.

MediaType,$this>
mediaType()

The media type of this volume.

Image,$this>
images()

The images belonging to this volume.

Video,$this>
videos()

The videos belonging to this volume.

files()

The images or videos belonging to this volume.

orderedImages() deprecated

The images belonging to this volume ordered by filename (ascending).

orderedFiles()

The images belonging to this volume ordered by filename (ascending).

Builder
users()

Return a query for all users associated to this volume through projects.

Project,$this>
projects()

The project(s), this volume belongs to.

AnnotationSession,$this>
annotationSessions()

The annotation sessions of this volume.

AnnotationSession,$this>
activeAnnotationSession()

The active annotation sessions of this volume (if any).

AnnotationSession|null
getActiveAnnotationSession(User $user)

Returns the active annotation session of this volume for the given user.

bool
hasConflictingAnnotationSession(AnnotationSession $session)

Check if the given annotation session is in conflict with existing ones.

bool
isRemote()

Check if the images of this volume come from a remote URL.

Image|null
getThumbnailAttribute()

An image that can be used as unique thumbnail for this volume.

string|null
getThumbnailUrlAttribute()

URL to the thumbnail image of this volume.

Collection
getThumbnailsAttribute()

Several images or videos that can be used for the preview thumbnail of a volume.

Collection
getThumbnailsUrlAttribute()

URLs to the thumbnail images of this volume.

flushThumbnailCache()

Flush the cache that stores the volume thumbnail.

bool
hasGeoInfo()

Check if the volume has some images with GPS coordinates.

flushGeoInfoCache()

Flush the cached information if this volume has images with GPS coordinates.

setUrlAttribute(string|null $value)

Set the url attribute of this volume.

setCreatingAsyncAttribute(bool $value)

Set the creating_async attribute of this volume.

bool
getCreatingAsyncAttribute()

Get the creating_async attribute of this volume.

?array
getExportAreaAttribute()

Return the dynamic attribute for the export area.

setExportAreaAttribute(array|null $value)

Set or update the dynamic attribute for the export area.

bool
hasTiledImages()

Check if the there are tiled images in this volume.

bool
isImageVolume()

Specifies whether the volume is an image volume.

bool
isVideoVolume()

Specifies whether the volume is a video volume.

string
getThumbnailsCacheKey()

Get the cache key for volume thumbnails.

string
getGeoInfoCacheKey()

Get the cache key for volume geo info.

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 486
string getMetadataFileDisk()

{@inheritdoc}

Return Value

string

in HasMetadataFile at line 20
bool hasMetadata()

No description

Return Value

bool

in HasMetadataFile at line 25
void saveMetadata(UploadedFile $file)

No description

Parameters

UploadedFile $file

Return Value

void

in HasMetadataFile at line 35
VolumeMetadata|null getMetadata()

No description

Return Value

VolumeMetadata|null

in HasMetadataFile at line 67
void deleteMetadata(bool $noUpdate = false)

No description

Parameters

bool $noUpdate

Do not set metadata_file_path to null.

Return Value

void

at line 84
static array parseFilesQueryString(string $string)

Parses a comma separated list of filenames to an array.

Parameters

string $string

Return Value

array

at line 98
Builder scopeAccessibleBy(Builder $query, User $user)

Scope a query to all volumes that are accessible by a user.

Parameters

Builder $query
User $user

Return Value

Builder

at line 116
User,$this> creator()

The user that created the volume.

Return Value

User,$this>

at line 126
MediaType,$this> mediaType()

The media type of this volume.

Return Value

MediaType,$this>

at line 136
Image,$this> images()

The images belonging to this volume.

Return Value

Image,$this>

at line 146
Video,$this> videos()

The videos belonging to this volume.

Return Value

Video,$this>

at line 156
files()

The images or videos belonging to this volume.

at line 171
orderedImages() deprecated

deprecated Use `orderedFiles` instead.

The images belonging to this volume ordered by filename (ascending).

at line 181
orderedFiles()

The images belonging to this volume ordered by filename (ascending).

at line 191
Builder users()

Return a query for all users associated to this volume through projects.

Return Value

Builder

at line 210
Project,$this> projects()

The project(s), this volume belongs to.

Return Value

Project,$this>

at line 220
AnnotationSession,$this> annotationSessions()

The annotation sessions of this volume.

Return Value

AnnotationSession,$this>

at line 230
AnnotationSession,$this> activeAnnotationSession()

The active annotation sessions of this volume (if any).

Return Value

AnnotationSession,$this>

at line 250
AnnotationSession|null getActiveAnnotationSession(User $user)

Returns the active annotation session of this volume for the given user.

An annotation session may be active for a volume but it is only also active for a user, if the user belongs to the set of restricted users of the annotation session.

Parameters

User $user

Return Value

AnnotationSession|null

at line 270
bool hasConflictingAnnotationSession(AnnotationSession $session)

Check if the given annotation session is in conflict with existing ones.

A conflict exists if the active time period of two sessions overlaps.

Parameters

AnnotationSession $session

The annotation session to check

Return Value

bool

at line 297
bool isRemote()

Check if the images of this volume come from a remote URL.

Return Value

bool

at line 307
Image|null getThumbnailAttribute()

An image that can be used as unique thumbnail for this volume.

Return Value

Image|null

at line 319
string|null getThumbnailUrlAttribute()

URL to the thumbnail image of this volume.

Return Value

string|null

at line 329
Collection getThumbnailsAttribute()

Several images or videos that can be used for the preview thumbnail of a volume.

Return Value

Collection

at line 353
Collection getThumbnailsUrlAttribute()

URLs to the thumbnail images of this volume.

Return Value

Collection

at line 361
flushThumbnailCache()

Flush the cache that stores the volume thumbnail.

at line 371
bool hasGeoInfo()

Check if the volume has some images with GPS coordinates.

Return Value

bool

at line 379
flushGeoInfoCache()

Flush the cached information if this volume has images with GPS coordinates.

at line 390
setUrlAttribute(string|null $value)

Set the url attribute of this volume.

Parameters

string|null $value

at line 405
setCreatingAsyncAttribute(bool $value)

Set the creating_async attribute of this volume.

Parameters

bool $value

at line 417
bool getCreatingAsyncAttribute()

Get the creating_async attribute of this volume.

Return Value

bool

at line 427
?array getExportAreaAttribute()

Return the dynamic attribute for the export area.

Return Value

?array

at line 435
setExportAreaAttribute(array|null $value)

Set or update the dynamic attribute for the export area.

Parameters

array|null $value

at line 457
bool hasTiledImages()

Check if the there are tiled images in this volume.

Return Value

bool

at line 468
bool isImageVolume()

Specifies whether the volume is an image volume.

Return Value

bool

at line 478
bool isVideoVolume()

Specifies whether the volume is a video volume.

Return Value

bool

at line 496
protected string getThumbnailsCacheKey()

Get the cache key for volume thumbnails.

Return Value

string

at line 506
protected string getGeoInfoCacheKey()

Get the cache key for volume geo info.

Return Value

string