ImplicitReturnPass
extends CodeCleanerPass
in package
Add an implicit "return" to the last statement, provided it can be returned.
Table of Contents
- afterTraverse() : null|array<string|int, Node>
- Called once after traversal.
- beforeTraverse() : array<string|int, mixed>
- enterNode() : null|int|Node
- Called when entering a node.
- leaveNode() : null|int|Node|array<string|int, Node>
- Called when leaving a node.
- addImplicitReturn() : array<string|int, mixed>
- isNonExpressionStmt() : bool
- Check whether a given node is a non-expression statement.
Methods
afterTraverse()
Called once after traversal.
public
afterTraverse(array<string|int, mixed> $nodes) : null|array<string|int, Node>
Return value semantics:
- null: $nodes stays as-is
- otherwise: $nodes is set to the return value
Parameters
- $nodes : array<string|int, mixed>
-
Array of nodes
Return values
null|array<string|int, Node> —Array of nodes
beforeTraverse()
public
beforeTraverse(array<string|int, mixed> $nodes) : array<string|int, mixed>
Parameters
- $nodes : array<string|int, mixed>
Return values
array<string|int, mixed> —enterNode()
Called when entering a node.
public
enterNode(Node $node) : null|int|Node
Return value semantics:
- null => $node stays as-is
- NodeTraverser::DONT_TRAVERSE_CHILDREN => Children of $node are not traversed. $node stays as-is
- NodeTraverser::STOP_TRAVERSAL => Traversal is aborted. $node stays as-is
- otherwise => $node is set to the return value
Parameters
- $node : Node
-
Node
Return values
null|int|Node —Replacement node (or special return value)
leaveNode()
Called when leaving a node.
public
leaveNode(Node $node) : null|int|Node|array<string|int, Node>
Return value semantics:
- null => $node stays as-is
- NodeTraverser::REMOVE_NODE => $node is removed from the parent array
- NodeTraverser::STOP_TRAVERSAL => Traversal is aborted. $node stays as-is
- array (of Nodes) => The return value is merged into the parent array (at the position of the $node)
- otherwise => $node is set to the return value
Parameters
- $node : Node
-
Node
Return values
null|int|Node|array<string|int, Node> —Replacement node (or special return value)
addImplicitReturn()
private
addImplicitReturn(array<string|int, mixed> $nodes) : array<string|int, mixed>
Parameters
- $nodes : array<string|int, mixed>
Return values
array<string|int, mixed> —isNonExpressionStmt()
Check whether a given node is a non-expression statement.
private
static isNonExpressionStmt(Node $node) : bool
As of PHP Parser 4.x, Expressions are now instances of Stmt as well, so we'll exclude them here.
Parameters
- $node : Node