Filter

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.

package

Default

Methods

Constructs the filter and attaches the factory to it.

__construct(\phpDocumentor\Descriptor\Filter\ClassFactory $factory) 

Attaches a filter to a specific FQCN.

attach(string $fqcn, \Zend\Filter\FilterInterface $filter, integer $priority = self::DEFAULT_PRIORITY) : void

Arguments

$fqcn

string

$filter

\Zend\Filter\FilterInterface

$priority

integer

[1000]

Filters the given Descriptor and returns the altered object.

filter(\phpDocumentor\Descriptor\Filter\Filterable $descriptor) : \phpDocumentor\Descriptor\Filter\Filterable|null

Constants

DEFAULT_PRIORITY

DEFAULT_PRIORITY
var

default priority for a filter in the series of filters.

Properties

factory

factory : \phpDocumentor\Descriptor\Filter\ClassFactory