Documentation

NamespaceAwarePass extends CodeCleanerPass
in package

Abstract namespace-aware code cleaner pass.

Table of Contents

$currentScope  : mixed
$namespace  : mixed
afterTraverse()  : null|array<string|int, Node>
Called once after traversal.
beforeTraverse()  : mixed
enterNode()  : mixed
leaveNode()  : null|int|Node|array<string|int, Node>
Called when leaving a node.
getFullyQualifiedName()  : string
Get a fully-qualified name (class, function, interface, etc).

Properties

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) : mixed
Parameters
$nodes : array<string|int, mixed>
Tags
todo

should this be final? Extending classes should be sure to either use afterTraverse or call parent::beforeTraverse() when overloading.

Reset the namespace and the current scope before beginning analysis

Return values
mixed —

enterNode()

public enterNode(Node $node) : mixed
Parameters
$node : Node
Tags
todo

should this be final? Extending classes should be sure to either use leaveNode or call parent::enterNode() when overloading

Return values
mixed —

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)

getFullyQualifiedName()

Get a fully-qualified name (class, function, interface, etc).

protected getFullyQualifiedName(mixed $name) : string
Parameters
$name : mixed
Return values
string —

Search results