AnnotationSession
class AnnotationSession extends Model
An annotation session groups multiple annotations of a volume based on their creation date.
Traits
Properties
| protected array<string,string> | $casts | The attributes that should be casted to native types. |
|
| protected array<int,string> | $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 47
Volume,$this>
volume()
The volume, this annotation session belongs to.
at line 57
User,$this>
users()
The users, this annotation session is restricted to.
at line 72
Generator
getVolumeFileAnnotations(VolumeFile $file, User $user, array $load = [])
Get the annotations of the file (with labels), filtered by the restrictions of this annotation session.
at line 127
ImageAnnotation>|VideoAnnotation>
annotations()
Get a query for all annotations that belong to this session.
This is not an Eloquent relation!
at line 143
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 164
setStartsAtAttribute(mixed $value)
Set the start date.
at line 178
setEndsAtAttribute(mixed $value)
Set the end date.
at line 192
string
getStartsAtIso8601Attribute()
Get the start date formatted as ISO8601 string.
at line 202
string
getEndsAtIso8601Attribute()
Get the end date formatted as ISO8601 string.
at line 214
Builder
imageAnnotations()
Get a query for all image annotations that belong to this session.
This is not an Eloquent relation!
at line 248
Builder
videoAnnotations()
Get a query for all video annotations that belong to this session.
This is not an Eloquent relation!