1. class
  2. Waterhole
  3. \
  4. Filters
  5. \
  6. Filter

Filter

abstract class Filter (View source)

Base class for a Filter.

A filter is a set of filtering or sorting criteria that can be applied to a feed query, like "Newest" or "Top".

Define a new filter by extending this class and implementing the methods. Use the PostFilters and CommentFilters extenders to register a filter for the appropriate feed types, making them available for configuration.

Methods

string
handle()

The handle for the filter, used in query parameters.

string
label()

The text label for the filter.

void
apply(Builder $query)

Apply the filter to the feed query builder.

Details

at line 24
string handle()

The handle for the filter, used in query parameters.

Return Value

string

at line 32
abstract string label()

The text label for the filter.

Return Value

string

at line 37
abstract void apply(Builder $query)

Apply the filter to the feed query builder.

Parameters

Builder $query

Return Value

void