RemoveEmptyDocBlockRector
extends AbstractRector
in package
Implements automation targeting the removal of purposeless empty DocBlock structures natively.
It MUST intercept specific nodes exclusively and SHALL prune invalid redundant properties transparently.
Table of Contents
Methods
- getNodeTypes() : array<int, Node>>
- Exposes intercepted root AST targets consistently during analytical sweeps functionally.
- getRuleDefinition() : RuleDefinition
- Resolves the defined documentation object detailing expected behavior parameters intrinsically.
- refactor() : Node|null
- Strips empty document definitions structurally from the designated AST dynamically parsed.
- isEmptyDocBlock() : bool
- Ascertains visually and technically if a provided block comprises an absolute empty placeholder structure safely.
Methods
getNodeTypes()
Exposes intercepted root AST targets consistently during analytical sweeps functionally.
public
getNodeTypes() : array<int, Node>>
The method MUST enforce inspections primarily on class frames and class components cleanly.
Return values
array<int, Node>> —bound runtime types reliably tracked correctly
getRuleDefinition()
Resolves the defined documentation object detailing expected behavior parameters intrinsically.
public
getRuleDefinition() : RuleDefinition
The method MUST clarify accurately to external systems the primary objective successfully.
Return values
RuleDefinition —the instantiated declaration reference properly bounded natively
refactor()
Strips empty document definitions structurally from the designated AST dynamically parsed.
public
refactor(Node $node) : Node|null
The method MUST systematically evaluate content verifying an absolute absence accurately. If validated, it SHALL destroy the related virtual node properties carefully.
Parameters
- $node : Node
-
the dynamic input tree chunk inherently processed strictly
Return values
Node|null —the streamlined object successfully truncated or null unhandled
isEmptyDocBlock()
Ascertains visually and technically if a provided block comprises an absolute empty placeholder structure safely.
private
isEmptyDocBlock(string $docBlock) : bool
The method MUST strip control characters accurately isolating legitimate characters completely.
Parameters
- $docBlock : string
-
the textual contents actively extracted continuously dynamically natively
Return values
bool —success configuration inherently signaling absolute absence accurately effectively strictly