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

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 array $hidden

The attributes hidden from the model's JSON form.
protected array $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
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.

BelongsTo
creator()

The user that created the volume.

BelongsTo
mediaType()

The media type of this volume.

HasMany
images()

The images belonging to this volume.

HasMany
videos()

The videos belonging to this volume.

HasMany
files()

The images or videos belonging to this volume.

HasMany
orderedImages() deprecated

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

HasMany
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.

BelongsToMany
projects()

The project(s), this volume belongs to.

HasMany
annotationSessions()

The annotation sessions of this volume.

HasOne
activeAnnotationSession()

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

AnnotationSession
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
getThumbnailAttribute()

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

string
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.

array
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 $value)

Set the url attribute of this volume.

setCreatingAsyncAttribute(string $value)

Set the creating_async attribute of this volume.

string
getCreatingAsyncAttribute()

Get the creating_async attribute of this volume.

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.

saveIfdo(UploadedFile $file)

Save an iFDO metadata file and link it with this volume.

bool
hasIfdo(bool $ignoreErrors = false)

Check if an iFDO metadata file is available for this volume.

deleteIfdo()

Delete the iFDO metadata file linked with this volume.

Response
downloadIfdo()

Download the iFDO that is attached to this volume.

array
getIfdo()

Get the content of the iFDO file associated with this volume.

string
getIfdoFilename()

Get the filename of the volume iFDO in storage.

string
getThumbnailsCacheKey()

Get the cache key for volume thumbnails.

string
getGeoInfoCacheKey()

Get the cache key for volume geo info.

string
getIfdoCacheKey()

Get the cache key for volume iFDO 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 72
static array parseFilesQueryString(string $string)

Parses a comma separated list of filenames to an array.

Parameters

string $string

Return Value

array

at line 86
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 106
BelongsTo creator()

The user that created the volume.

Return Value

BelongsTo

at line 116
BelongsTo mediaType()

The media type of this volume.

Return Value

BelongsTo

at line 126
HasMany images()

The images belonging to this volume.

Return Value

HasMany

at line 136
HasMany videos()

The videos belonging to this volume.

Return Value

HasMany

at line 146
HasMany files()

The images or videos belonging to this volume.

Return Value

HasMany

at line 161
HasMany orderedImages() deprecated

deprecated Use `orderedFiles` instead.

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

Return Value

HasMany

at line 171
HasMany orderedFiles()

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

Return Value

HasMany

at line 181
Builder users()

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

Return Value

Builder

at line 200
BelongsToMany projects()

The project(s), this volume belongs to.

Return Value

BelongsToMany

at line 210
HasMany annotationSessions()

The annotation sessions of this volume.

Return Value

HasMany

at line 220
HasOne activeAnnotationSession()

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

Return Value

HasOne

at line 240
AnnotationSession 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

at line 260
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 289
bool isRemote()

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

Return Value

bool

at line 299
Image getThumbnailAttribute()

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

Return Value

Image

at line 311
string getThumbnailUrlAttribute()

URL to the thumbnail image of this volume.

Return Value

string

at line 321
Collection getThumbnailsAttribute()

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

Return Value

Collection

at line 345
array getThumbnailsUrlAttribute()

URLs to the thumbnail images of this volume.

Return Value

array

at line 355
flushThumbnailCache()

Flush the cache that stores the volume thumbnail.

at line 365
bool hasGeoInfo()

Check if the volume has some images with GPS coordinates.

Return Value

bool

at line 375
flushGeoInfoCache()

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

at line 388
setUrlAttribute(string $value)

Set the url attribute of this volume.

Parameters

string $value

at line 403
setCreatingAsyncAttribute(string $value)

Set the creating_async attribute of this volume.

Parameters

string $value

at line 415
string getCreatingAsyncAttribute()

Get the creating_async attribute of this volume.

Return Value

string

at line 425
bool hasTiledImages()

Check if the there are tiled images in this volume.

Return Value

bool

at line 438
bool isImageVolume()

Specifies whether the volume is an image volume.

Return Value

bool

at line 448
bool isVideoVolume()

Specifies whether the volume is a video volume.

Return Value

bool

at line 459
saveIfdo(UploadedFile $file)

Save an iFDO metadata file and link it with this volume.

Parameters

UploadedFile $file

iFDO YAML file.

at line 472
bool hasIfdo(bool $ignoreErrors = false)

Check if an iFDO metadata file is available for this volume.

Parameters

bool $ignoreErrors

Set to true to ignore exceptions and return false if iFDO existence could not be determined.

Return Value

bool

at line 490
deleteIfdo()

Delete the iFDO metadata file linked with this volume.

at line 501
Response downloadIfdo()

Download the iFDO that is attached to this volume.

Return Value

Response

at line 517
array getIfdo()

Get the content of the iFDO file associated with this volume.

Return Value

array

at line 529
protected string getIfdoFilename()

Get the filename of the volume iFDO in storage.

Return Value

string

at line 539
protected string getThumbnailsCacheKey()

Get the cache key for volume thumbnails.

Return Value

string

at line 549
protected string getGeoInfoCacheKey()

Get the cache key for volume geo info.

Return Value

string

at line 559
protected string getIfdoCacheKey()

Get the cache key for volume iFDO info.

Return Value

string