StripInternal
in package
implements
FilterInterface
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.
Tags
Interfaces, Classes and Traits
Table of Contents
- __invoke() : FilterPayload
- If the ProjectDescriptor's settings allow internal tags then return the Descriptor, otherwise null to filter it.
Methods
__invoke()
If the ProjectDescriptor's settings allow internal tags then return the Descriptor, otherwise null to filter it.
public
__invoke(FilterPayload $payload) : FilterPayload
Parameters
- $payload : FilterPayload