\phpDocumentor\Descriptor\FilterFilter

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.

Summary

Methods
Properties
Constants
__construct()
filter()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$pipeline
N/A

Properties

$pipeline

$pipeline : \League\Pipeline\Pipeline

Type

\League\Pipeline\Pipeline —

Methods

__construct()

__construct(iterable<int,\phpDocumentor\Descriptor\Filter\FilterInterface>  $filters) : mixed

Constructs the filter pipeline.

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

iterable $filters

Returns

mixed —

filter()

filter(\phpDocumentor\Descriptor\Filter\TDescriptor  $descriptor, \phpDocumentor\Configuration\ApiSpecification  $apiSpecification) : \phpDocumentor\Descriptor\Filter\TDescriptor|null

Filters the given Descriptor and returns the altered object.

Parameters

\phpDocumentor\Descriptor\Filter\TDescriptor $descriptor
\phpDocumentor\Configuration\ApiSpecification $apiSpecification

Returns

\phpDocumentor\Descriptor\Filter\TDescriptor|null —