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

Volume

class Volume extendsModel

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

Traits

HasJsonAttributes

Constants

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.

Properties

protectedarray $hidden The attributes hidden from the model's JSON form.
protectedarray $casts The attributes that should be casted to native types.
protectedarray $appends The accessors to append to the model's array form.

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
parseImagesQueryString(string$string)

Parses a comma separated list of image 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.

void
setMediaType(MediaType$mediaType)

Sets the media type of this volume.

void
setMediaTypeId(int$id)

Sets the media type of this volume to the media type with the given ID.

HasMany
images()

The images belonging to this volume.

HasMany
orderedImages()

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 a unique thumbnail for this volume.

string
getThumbnailUrlAttribute()

URL to the thumbnail image of this volume.

Collection
getThumbnailsAttribute()

Several images 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.

setVideoLinkAttribute(string$value)

Set the video_link attribute of this volume.

string
getVideoLinkAttribute()

Get the video_link attribute of this volume.

setGisLinkAttribute(string$value)

Set the gis_link attribute of this volume.

string
getGisLinkAttribute()

Get the gis_link attribute of this volume.

setDoiAttribute(string$value)

Set the doi attribute of this volume.

string
getDoiAttribute()

Get the doi attribute of this volume.

bool
hasTiledImages()

Check if the there are tiled images in this volume.

Details

inHasJsonAttributesat line16
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.

inHasJsonAttributesat line38
protectedmixed 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 line64
staticarray parseImagesQueryString(string$string)

Parses a comma separated list of image filenames to an array.

Parameters

string $string

Return Value

array

at line77
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 line97
BelongsTo creator()

The user that created the volume.

Return Value

BelongsTo

at line107
BelongsTo mediaType()

The media type of this volume.

Return Value

BelongsTo

at line118
void setMediaType(MediaType$mediaType)

Sets the media type of this volume.

Parameters

MediaType $mediaType

Return Value

void

at line129
void setMediaTypeId(int$id)

Sets the media type of this volume to the media type with the given ID.

Parameters

int $id media type ID

Return Value

void

at line143
HasMany images()

The images belonging to this volume.

Return Value

HasMany

at line153
HasMany orderedImages()

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

Return Value

HasMany

at line163
Builder users()

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

Return Value

Builder

at line182
BelongsToMany projects()

The project(s), this volume belongs to.

Return Value

BelongsToMany

at line192
HasMany annotationSessions()

The annotation sessions of this volume.

Return Value

HasMany

at line202
HasOne activeAnnotationSession()

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

Return Value

HasOne

at line222
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 line242
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 line271
bool isRemote()

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

Return Value

bool

at line281
Image getThumbnailAttribute()

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

Return Value

Image

at line293
string getThumbnailUrlAttribute()

URL to the thumbnail image of this volume.

Return Value

string

at line303
Collection getThumbnailsAttribute()

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

Return Value

Collection

at line327
array getThumbnailsUrlAttribute()

URLs to the thumbnail images of this volume.

Return Value

array

at line337
flushThumbnailCache()

Flush the cache that stores the volume thumbnail.

at line347
bool hasGeoInfo()

Check if the volume has some images with GPS coordinates.

Return Value

bool

at line357
flushGeoInfoCache()

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

at line370
setUrlAttribute(string$value)

Set the url attribute of this volume.

Parameters

string $value

at line380
setVideoLinkAttribute(string$value)

Set the video_link attribute of this volume.

Parameters

string $value

at line390
string getVideoLinkAttribute()

Get the video_link attribute of this volume.

Return Value

string

at line400
setGisLinkAttribute(string$value)

Set the gis_link attribute of this volume.

Parameters

string $value

at line410
string getGisLinkAttribute()

Get the gis_link attribute of this volume.

Return Value

string

at line420
setDoiAttribute(string$value)

Set the doi attribute of this volume.

Parameters

string $value

at line434
string getDoiAttribute()

Get the doi attribute of this volume.

Return Value

string

at line444
bool hasTiledImages()

Check if the there are tiled images in this volume.

Return Value

bool