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.

Properties

protected$factory  : \phpDocumentor\Descriptor\Filter\ClassFactory                

Methods

Constructs the filter and attaches the factory to it.

public__construct(ClassFactory $factory) : mixed

Parameters

$factory : ClassFactory

Returns

mixed

publicattachDefaults(ProjectDescriptorBuilder $descriptorBuilder) : void

Parameters

$descriptorBuilder : ProjectDescriptorBuilder

Attaches a filter to a specific FQCN.

publicattach(string $fqcn, FilterInterface $filter) : void

Parameters

$fqcn : string
$filter : FilterInterface

Filters the given Descriptor and returns the altered object.

publicfilter(Filterable $descriptor) : Filterable|null

Parameters

$descriptor : Filterable

Returns

Filterable|null