Mondrian
\
Trismegiste
Mondrian
Algebra
Analysis
Strategy
Builder
Compiler
Statement
Command
Config
Graph
Parser
Plugin
Refactor
Transform
Format
Logger
Vertex
Visitor

\Trismegiste\Mondrian\VisitorPassCollector

PassCollector is an abstract compiler pass for visiting source code and build the graph with the help of a Context

It feels like a Mediator between the two Context and concrete PassCollector (It is not one because Context and concrete PassCollector do not share a common interface)

Summary

Methods
Properties
Constants
enterNode()
leaveNode()
beforeTraverse()
__construct()
No public properties found
No constants found
enterClassNode()
enterInterfaceNode()
enterTraitNode()
enterPublicMethodNode()
getCurrentMethodIndex()
extractAnnotation()
resolveClassName()
getNamespacedName()
getDeclaringClass()
isInterface()
isTrait()
findVertex()
findAllMethodSameName()
existsVertex()
findMethodInInheritanceTree()
getClassesUsingTraitForDeclaringMethod()
indicesVertex()
logFallbackCall()
getExcludedCall()
$currentClass
$currentMethod
$namespace
$aliases
$currentPhpFile
$graph
N/A
No private methods found
$reflection
$vertexDict
N/A

Properties

$currentClass

$currentClass :

Type

$currentMethod

$currentMethod :

Type

$namespace

$namespace : null|\Trismegiste\Mondrian\Visitor\PHPParser_Node_Name

Type

null|\Trismegiste\Mondrian\Visitor\PHPParser_Node_Name — Current namespace

$aliases

$aliases : array

Type

array — Currently defined namespace and class aliases

$currentPhpFile

$currentPhpFile :

current file

Type

$graph

$graph :

Type

$reflection

$reflection :

Type

$vertexDict

$vertexDict :

Type

Methods

enterNode()

enterNode(\PHPParser_Node  $node)

Parameters

\PHPParser_Node $node

leaveNode()

leaveNode(\PHPParser_Node  $node)

{@inheritDoc}

Parameters

\PHPParser_Node $node

beforeTraverse()

beforeTraverse(array  $nodes)

Parameters

array $nodes

enterClassNode()

enterClassNode(\PHPParser_Node_Stmt_Class  $node)

Visits a class node

Parameters

\PHPParser_Node_Stmt_Class $node

enterInterfaceNode()

enterInterfaceNode(\PHPParser_Node_Stmt_Interface  $node)

Visits an interface node

Parameters

\PHPParser_Node_Stmt_Interface $node

enterTraitNode()

enterTraitNode(\PHPParser_Node_Stmt_Trait  $node)

Visits an trait node

Parameters

\PHPParser_Node_Stmt_Trait $node

enterPublicMethodNode()

enterPublicMethodNode(\PHPParser_Node_Stmt_ClassMethod  $node)

Visits a public method node

Parameters

\PHPParser_Node_Stmt_ClassMethod $node

getCurrentMethodIndex()

getCurrentMethodIndex() : string

the vertex name for a MethodVertex

Returns

string

extractAnnotation()

extractAnnotation(\PHPParser_Node_Stmt  $node)

Extracts annotations in the comment of a statement and injects them in attribute of the node

Parameters

\PHPParser_Node_Stmt $node

resolveClassName()

resolveClassName(\PHPParser_Node_Name  $src) : \PHPParser_Node_Name|\PHPParser_Node_Name_FullyQualified

resolve the Name with current namespace and alias

Parameters

\PHPParser_Node_Name $src

Returns

\PHPParser_Node_Name|\PHPParser_Node_Name_FullyQualified

getNamespacedName()

getNamespacedName(\PHPParser_Node  $node) : string

Helper : get the FQCN of the given $node->name

Parameters

\PHPParser_Node $node

Returns

string

getDeclaringClass()

getDeclaringClass(string  $cls, string  $meth) : string

Finds the FQCN of the first declaring class/interface of a method

Parameters

string $cls

subclass name
string $meth

method name

Returns

string

isInterface()

isInterface(string  $cls) : boolean

Is FQCN an interface ?

Parameters

string $cls

FQCN

Returns

boolean

isTrait()

isTrait(string  $cls) : boolean

Is FQCN a trait ?

Parameters

string $cls

FQCN

Returns

boolean

findVertex()

findVertex(string  $type, string  $key) : \Trismegiste\Mondrian\Graph\Vertex

Find a vertex by its type and name

Parameters

string $type
string $key

Returns

\Trismegiste\Mondrian\Graph\Vertex —

or null

findAllMethodSameName()

findAllMethodSameName(  $method)

See Context

Parameters

$method

existsVertex()

existsVertex(  $type,   $key)

See Context

Parameters

$type
$key

findMethodInInheritanceTree()

findMethodInInheritanceTree(  $cls,   $method)

Check if the class exists before searching for the declaring class of the method, because class could be unknown, outside or code could be bugged

Parameters

$cls
$method

getClassesUsingTraitForDeclaringMethod()

getClassesUsingTraitForDeclaringMethod(string  $cls,   $method) : array

Returns a list of all classes using a trait for declaring a given method

Parameters

string $cls

FQCN of trait
$method

Returns

array

logFallbackCall()

logFallbackCall(  $class,   $method,   $called)

Parameters

$class
$method
$called

getExcludedCall()

getExcludedCall(  $class,   $method)

Parameters

$class
$method