1. trait
  2. Biigle
  3. \
  4. Modules
  5. \
  6. Reports
  7. \
  8. Traits
  9. \
  10. RestrictsToExportArea

RestrictsToExportArea

trait RestrictsToExportArea

Methods

Builder
restrictToExportAreaQuery(Builder $query)

Callback to be used in a when query statement that restricts the resulting annotations to the export area of the reansect of this report (if there is any).

bool
isRestrictedToExportArea()

Should this report be restricted to the export area?

array
getSkipIds()

Returns the annotation IDs to skip as outside of the volume export area.

Details

at line 16
Builder restrictToExportAreaQuery(Builder $query)

Callback to be used in a when query statement that restricts the resulting annotations to the export area of the reansect of this report (if there is any).

Parameters

Builder $query

Return Value

Builder

at line 26
protected bool isRestrictedToExportArea()

Should this report be restricted to the export area?

Return Value

bool

at line 39
protected array getSkipIds()

Returns the annotation IDs to skip as outside of the volume export area.

We collect the IDs to skip rather than the IDs to include since there are probably fewer annotations outside of the export area.

Return Value

array

Annotation IDs