Filters.php

Constructor.

If discoverFilters is enabled in Config then system will try to auto-discover custom filters files in namespaces and allow access to the config object via the variable $filters as with the routes file. Sample: $filters->aliases['custom-auth'] = \Acme\Blob\Filters\BlobAuth::class;

Set the response explicitly.

Runs through all the filters (except "Required Filters") for the specified URI and position.

Returns the "Required Filters" class list.

Runs "Required Filters" for the specified position.

Returns "Required Filters" for the specified position.

Set the toolbar filter to the last position to be executed.

Runs through our list of filters provided by the configuration object to get them ready for use, including getting uri masks to proper regex, removing those we can from the possibilities based on HTTP method, etc. The resulting $this->filters is an array of only filters that should be applied to this request. We go ahead and process the entire tree because we'll need to run through both a before and after and don't want to double process the rows. call this in your app.

Restores instance to its pre-initialized state. Most useful for testing so the service can be re-initialized to a different path.

Returns the processed filters array. This does not include "Required Filters". before: list<string>, after: list<string> }

Returns the filtersClass array. This does not include "Required Filters". before: list<array{0: class-string, 1: list<string>}>, after: list<array{0: class-string, 1: list<string>}> }

Adds a new alias to the config file. MUST be called prior to initialize(); Intended for use within routes files.

Ensures that a specific filter is on and enabled for the current request. Filters can have "arguments". This is done by placing a colon immediately after the filter name, followed by a comma-separated list of arguments that are passed to the filter when executed. or filter classname.

Get clean name and arguments

Ensures that specific filters are on and enabled for the current request. Filters can have "arguments". This is done by placing a colon immediately after the filter name, followed by a comma-separated list of arguments that are passed to the filter when executed.

Returns the arguments for a specified key, or all.

Add any applicable (not excluded) global filter settings to the mix.

Add any method-specific filters to the mix.

Add any applicable configured filters to the mix.

Maps filter aliases to the equivalent filter classes

Check paths for match for URI

Check except paths

Check the URI path as pseudo-regex