Documentation

RequirePass extends CodeCleanerPass
in package

Add runtime validation for `require` and `require_once` calls.

Table of Contents

$requireTypes  : mixed
afterTraverse()  : null|array<string|int, Node>
Called once after traversal.
beforeTraverse()  : null|array<string|int, Node>
Called once before traversal.
enterNode()  : mixed
{@inheritdoc}
leaveNode()  : null|int|Node|array<string|int, Node>
Called when leaving a node.
resolve()  : string
Runtime validation that $file can be resolved as an include path.
isRequireNode()  : mixed

Properties

$requireTypes

private static mixed $requireTypes = [PhpParserNodeExprInclude_::TYPE_REQUIRE, PhpParserNodeExprInclude_::TYPE_REQUIRE_ONCE]

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()

Called once before traversal.

public beforeTraverse(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

enterNode()

{@inheritdoc}

public enterNode(Node $origNode) : mixed
Parameters
$origNode : Node
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)

resolve()

Runtime validation that $file can be resolved as an include path.

public static resolve(string $file[, int $lineNumber = null ]) : string

If $file can be resolved, return $file. Otherwise throw a fatal error exception.

Parameters
$file : string
$lineNumber : int = null

Line number of the original require expression

Tags
throws
FatalErrorException

when unable to resolve include path for $file

throws
ErrorException

if $file is empty and E_WARNING is included in error_reporting level

Return values
string —

Exactly the same as $file

isRequireNode()

private isRequireNode(Node $node) : mixed
Parameters
$node : Node
Return values
mixed —

Search results