class StoreVolumeLargoSession extends StoreLargoSession

Properties

bool $force

The force request attribute.

from  StoreLargoSession
array $dismissedImageAnnotations

The dismissed_image_annotations request attribute.

from  StoreLargoSession
array $changedImageAnnotations

The changed_image_annotations request attribute.

from  StoreLargoSession
array $dismissedVideoAnnotations

The dismissed_video_annotations request attribute.

from  StoreLargoSession
array $changedVideoAnnotations

The changed_video_annotations request attribute.

from  StoreLargoSession
bool $emptyRequest

Specifies whether the request is empty.

from  StoreLargoSession
Volume $volume

The volume to store the Largo session for.

Methods

bool
authorize()

Determine if the user is authorized to make this request.

array
rules()

Get the validation rules that apply to the request.

array
getAffectedAnnotations(array $dismissed, array $changed)

Get a list of unique annotation IDs that are either dismissed or changed.

bool
imageAnotationsBelongToVolumes(array $annotations, array $volumes)

Check if all given image annotations belong to the given volumes.

bool
videoAnotationsBelongToVolumes(array $annotations, array $volumes)

Check if all given video annotations belong to the given volumes.

array
getRequiredLabelTrees(array $changed)

Returns the IDs of all label trees that must be available to apply the changes.

void
withValidator(Validator $validator)

Configure the validator instance.

validateImageVolume(Validator $validator)

Validate the request for an image volume.

validateVideoVolume(Validator $validator)

Validate the request for an video volume.

Collection
getAvailableLabelTrees(Volume $volume)

Get label trees of projects that the requesting user and the volume have in common.

Details

at line 24
bool authorize()

Determine if the user is authorized to make this request.

Return Value

bool

in StoreLargoSession at line 73
array rules()

Get the validation rules that apply to the request.

Return Value

array

in StoreLargoSession at line 92
protected array getAffectedAnnotations(array $dismissed, array $changed)

Get a list of unique annotation IDs that are either dismissed or changed.

Parameters

array $dismissed

Array of all dismissed annotation IDs for each label

array $changed

Array of all changed annotation IDs for each label

Return Value

array

in StoreLargoSession at line 113
protected bool imageAnotationsBelongToVolumes(array $annotations, array $volumes)

Check if all given image annotations belong to the given volumes.

Parameters

array $annotations

ImageAnnotation IDs

array $volumes

Volume IDs

Return Value

bool

in StoreLargoSession at line 137
protected bool videoAnotationsBelongToVolumes(array $annotations, array $volumes)

Check if all given video annotations belong to the given volumes.

Parameters

array $annotations

VideoAnnotation IDs

array $volumes

Volume IDs

Return Value

bool

in StoreLargoSession at line 159
protected array getRequiredLabelTrees(array $changed)

Returns the IDs of all label trees that must be available to apply the changes.

Parameters

array $changed

Array of all changed annotation IDs for each label

Return Value

array

at line 54
void withValidator(Validator $validator)

Configure the validator instance.

Parameters

Validator $validator

Return Value

void

at line 76
protected validateImageVolume(Validator $validator)

Validate the request for an image volume.

Parameters

Validator $validator

at line 97
protected validateVideoVolume(Validator $validator)

Validate the request for an video volume.

Parameters

Validator $validator

at line 121
protected Collection getAvailableLabelTrees(Volume $volume)

Get label trees of projects that the requesting user and the volume have in common.

Parameters

Volume $volume

Return Value

Collection