Filter  

class Filter implements ExtenderInterface

Methods

__construct($filtererClass)

No description

Filter
addFilter(string $filterClass)

<p>Add a filter to run when the filtererClass is filtered.</p>

Filter
addFilterMutator(callable|string $callback)

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

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

No description

Details

at line 24
__construct($filtererClass)

Parameters

$filtererClass

at line 35
Filter addFilter(string $filterClass)

<p>Add a filter to run when the filtererClass is filtered.</p>

Parameters

string $filterClass

Return Value

Filter

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

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

Parameters

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

Return Value

Filter

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

Parameters

Container $container
Extension $extension