1. class
  2. Biigle
  3. \
  4. Http
  5. \
  6. Controllers
  7. \
  8. Api
  9. \
  10. Volumes
  11. \
  12. FilterVideoAnnotationsByLabelController

FilterVideoAnnotationsByLabelController

class FilterVideoAnnotationsByLabelController extends Controller

Traits

CompileFilters
AuthorizesRequests
ValidatesRequests

Methods

bool
isAutomatedRequest(Request $request = null)

Determines if the request was done by an automated script (with API token or ajax).

from  Controller
RedirectResponse
fuzzyRedirect()

Redirects to the _redirect URL, to a route or else back.

from  Controller
void
compileFilterConditions(Builder $query, bool $union, array $filters)

Compile Largo filter(s) that were requested and add them to the query

from  CompileFilters
Collection
index(Request $request, int $vid, int $lid)

Show all video annotations of the volume that have a specific label attached.

Details

in Controller at line 21
bool isAutomatedRequest(Request $request = null)

Determines if the request was done by an automated script (with API token or ajax).

Parameters

Request $request

Return Value

bool

in Controller at line 15
protected RedirectResponse fuzzyRedirect()

Redirects to the _redirect URL, to a route or else back.

Return Value

RedirectResponse

in CompileFilters at line 14
private void compileFilterConditions(Builder $query, bool $union, array $filters)

Compile Largo filter(s) that were requested and add them to the query

Parameters

Builder $query

Query to add filters to
bool $union

Whether filters are considered inclusive (OR) or exclusive (AND)
array $filters

Array of filters to add to the query in the form filterName => filterValue

Return Value

void

at line 35
Collection index(Request $request, int $vid, int $lid)

Show all video annotations of the volume that have a specific label attached.

Parameters

Request $request
int $vid

Volume ID
int $lid

Label ID

Return Value

Collection