Filter
in package
Filter used to manipulate a descriptor after being build.
This class is used during the building of descriptors. It passes the descriptor to each individual sub-filter, which may change data in the descriptor or even remove it from the building process by returning null.
Table of Contents
Properties
- $pipeline : Pipeline
Methods
- __construct() : mixed
- Constructs the filter pipeline.
- filter() : TDescriptor|null
- Filters the given Descriptor and returns the altered object.
Properties
$pipeline read-only
private
Pipeline
$pipeline
Methods
__construct()
Constructs the filter pipeline.
public
__construct(iterable<int, FilterInterface> $filters) : mixed
Filters are allowed to return null when a elements needs to be removed. Therefor a default InterruptibleProcessor processor is applied which prevents the errors in these situations.
Parameters
- $filters : iterable<int, FilterInterface>
filter()
Filters the given Descriptor and returns the altered object.
public
filter(TDescriptor $descriptor, ApiSpecification $apiSpecification) : TDescriptor|null
Parameters
- $descriptor : TDescriptor
- $apiSpecification : ApiSpecification