FilterEmptyNamespaces extends ApiDocumentationPass
FinalYes
Attributes
- #[Stage]
- 'phpdoc.pipeline.api_documentation.compile'
- 2000
- 'Filter empty namespaces'
Table of Contents
Methods
- __invoke() : CompilableSubject
- Executes a compiler pass.
- getDescription() : string
- Returns a textual description of what this pass does for output purposes.
- process() : ApiSetDescriptor
- Actual method executed by the compiler.
- checkForEmptyChildren() : void
Methods
__invoke()
Executes a compiler pass.
public
final __invoke(CompilableSubject $subject) : CompilableSubject
This method will execute the business logic associated with a given compiler pass and allow it to manipulate or consumer the Object Graph using the ProjectDescriptor object.
Parameters
- $subject : CompilableSubject
-
Representation of the Object Graph that can be manipulated.
Return values
CompilableSubjectgetDescription()
Returns a textual description of what this pass does for output purposes.
public
getDescription() : string
Please note that the command line will be truncated to 68 characters (
Return values
stringprocess()
Actual method executed by the compiler.
protected
process(ApiSetDescriptor $subject) : ApiSetDescriptor
Processes the given ApiSetDescriptor and returns the modified ApiSetDescriptor.
Parameters
- $subject : ApiSetDescriptor
Return values
ApiSetDescriptorcheckForEmptyChildren()
private
checkForEmptyChildren(NamespaceInterface $namespace, Collection<string|int, NamespaceInterface> $namespaces, Collection<string|int, NamespaceInterface> $index, Collection<string|int, ElementInterface> $elementsIndex) : void
Parameters
- $namespace : NamespaceInterface
- $namespaces : Collection<string|int, NamespaceInterface>
- $index : Collection<string|int, NamespaceInterface>
- $elementsIndex : Collection<string|int, ElementInterface>