phpDocumentor

\phpDocumentor\Descriptor\FilterStripInternal

Filters a Descriptor when the @internal inline tag, or normal tag, is used.

When a Descriptor's description contains the inline tag @internal then the description of that tag should be included only when the visibility allows INTERNAL information. Otherwise it needs to be removed.

Similarly, whenever the normal @internal tag is used should this filter return null if the visibility does not allow INTERNAL information. This will remove this descriptor from the project.

Summary

Methods

Properties

Constants

__invoke()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

__invoke()

__invoke(
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
\phpDocumentor\Descriptor\Filter\FilterPayload  $payload) 
Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50
: \phpDocumentor\Descriptor\Filter\FilterPayload

If the ProjectDescriptor's settings allow internal tags then return the Descriptor, otherwise null to filter it.

Parameters

Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 \phpDocumentor\Descriptor\Filter\FilterPayload

$payload

Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50

Returns

Deprecated: Please use getType in /opt/phpdoc/src/phpDocumentor/Descriptor/Traits/CanHaveAType.php on line 50 \phpDocumentor\Descriptor\Filter\FilterPayload —