AnnotationSession
class AnnotationSession extends Model
An annotation session groups multiple annotations of a volume based on their creation date.
Traits
Properties
| protected array | $casts | The attributes that should be casted to native types. |
|
| protected array | $appends | The accessors to append to the model's array form. |
Methods
The volume, this annotation session belongs to.
The users, this annotation session is restricted to.
Get the annotations of the file (with labels), filtered by the restrictions of this annotation session.
Get a query for all annotations that belong to this session.
Check if the given user is allowed to access the annotation if this annotation session is active.
Set the start date.
Set the end date.
Get the start date formatted as ISO8601 string.
Get the end date formatted as ISO8601 string.
Get a query for all image annotations that belong to this session.
Get a query for all video annotations that belong to this session.
Details
at line 46
BelongsTo
volume()
The volume, this annotation session belongs to.
at line 56
BelongsToMany
users()
The users, this annotation session is restricted to.
at line 70
Collection
getVolumeFileAnnotations(VolumeFile $file, User $user)
Get the annotations of the file (with labels), filtered by the restrictions of this annotation session.
at line 118
Builder
annotations()
Get a query for all annotations that belong to this session.
This is not an Eloquent relation!
at line 134
bool
allowsAccess(Annotation $annotation, User $user)
Check if the given user is allowed to access the annotation if this annotation session is active.
at line 155
setStartsAtAttribute(mixed $value)
Set the start date.
at line 169
setEndsAtAttribute(mixed $value)
Set the end date.
at line 183
string
getStartsAtIso8601Attribute()
Get the start date formatted as ISO8601 string.
at line 193
string
getEndsAtIso8601Attribute()
Get the end date formatted as ISO8601 string.
at line 205
Builder
imageAnnotations()
Get a query for all image annotations that belong to this session.
This is not an Eloquent relation!
at line 239
Builder
videoAnnotations()
Get a query for all video annotations that belong to this session.
This is not an Eloquent relation!