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()
attach()
filter()

No public properties found

DEFAULT_PRIORITY

No protected methods found

$factory

N/A

No private methods found

No private properties found

N/A

File: phpDocumentor/Descriptor/Filter/Filter.php
Package: Default
Class hierarchy: \phpDocumentor\Descriptor\Filter\Filter

Constants

DEFAULT_PRIORITY

DEFAULT_PRIORITY = 1000 : integer

Properties

$factory

$factory : \phpDocumentor\Descriptor\Filter\ClassFactory

Type

\phpDocumentor\Descriptor\Filter\ClassFactory

Methods

__construct()

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

Constructs the filter and attaches the factory to it.

Parameters

\phpDocumentor\Descriptor\Filter\ClassFactory

$factory

attach()

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

Attaches a filter to a specific FQCN.

Parameters

string	$fqcn
\Zend\Filter\FilterInterface	$filter
integer	$priority	[1000]

filter()

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

Filters the given Descriptor and returns the altered object.

Parameters

\phpDocumentor\Descriptor\Filter\Filterable

$descriptor

Returns

\phpDocumentor\Descriptor\Filter\Filterable|null