Filter  

class Filter implements ExtenderInterface

Methods

__construct(string $filtererClass)

No description

Filter
addFilter(string $filterClass)

Add a filter to run when the filtererClass is filtered.

Filter
addFilterMutator(callable|string $callback)

Add a callback through which to run all filter queries after filters have been applied.

extend( Container $container, Extension $extension = null)

No description

Details

at line 24
__construct(string $filtererClass)

Parameters

string $filtererClass : The ::class attribute of the filterer to extend.

at line 35
Filter addFilter(string $filterClass)

Add a filter to run when the filtererClass is filtered.

Parameters

string $filterClass : The ::class attribute of the filter you are adding.

Return Value

Filter

at line 55
Filter addFilterMutator(callable|string $callback)

Add a callback through which to run all filter queries after filters have been applied.

Parameters

callable|string $callback The callback can be a closure or an invokable class, and should accept: - Flarum\Filter\FilterState $filter - Flarum\Query\QueryCriteria $criteria The callable should return void.

Return Value

Filter

at line 62
extend( Container $container, Extension $extension = null)

Parameters

Container $container
Extension $extension