Package org.sonar.php.tree.symbols

Class SymbolVisitor

java.lang.Object

org.sonar.plugins.php.api.visitors.PHPVisitorCheck

org.sonar.php.tree.symbols.SymbolVisitor

All Implemented Interfaces:

PHPCheck, VisitorCheck

public class SymbolVisitor
extends PHPVisitorCheck

Field Summary

Fields inherited from class org.sonar.plugins.php.api.visitors.PHPVisitorCheck

MAX_DEPTH

Constructor Summary

Constructors

Constructor	Description
SymbolVisitor(SymbolTableImpl symbolTable)

Method Summary

Modifier and Type	Method	Description
SymbolQualifiedName	currentNamespace()
QualifiedName	getFullyQualifiedName(NamespaceNameTree name, Symbol.Kind kind)	Resolution rules are defined in http://php.net/manual/en/language.namespaces.rules.php
boolean	isBracketedNamespace(NamespaceStatementTree tree)
void	visitAnonymousClass(AnonymousClassTree tree)
void	visitArrowFunctionExpression(ArrowFunctionExpressionTree tree)
void	visitClassDeclaration(ClassDeclarationTree tree)
void	visitClassPropertyDeclaration(ClassPropertyDeclarationTree tree)
void	visitCompilationUnit(CompilationUnitTree tree)
void	visitCompoundVariable(CompoundVariableTree tree)
void	visitComputedVariable(ComputedVariableTree tree)
void	visitConstDeclaration(ConstantDeclarationTree tree)	[ START ] Statement
void	visitFunctionCall(FunctionCallTree tree)
void	visitFunctionDeclaration(FunctionDeclarationTree tree)
void	visitFunctionExpression(FunctionExpressionTree tree)
void	visitGlobalStatement(GlobalStatementTree tree)
void	visitLexicalVariables(LexicalVariablesTree tree)
void	visitMemberAccess(MemberAccessTree tree)
void	visitMethodDeclaration(MethodDeclarationTree tree)
void	visitNameIdentifier(NameIdentifierTree tree)
void	visitNamespaceStatement(NamespaceStatementTree tree)
void	visitNewExpression(NewExpressionTree tree)
void	visitParameter(ParameterTree tree)
void	visitParameterList(ParameterListTree tree)
void	visitStaticStatement(StaticStatementTree tree)
void	visitToken(SyntaxToken token)
void	visitUseStatement(UseStatementTree tree)
void	visitUseTraitDeclaration(UseTraitDeclarationTree tree)
void	visitVariableIdentifier(VariableIdentifierTree tree)

Methods inherited from class org.sonar.plugins.php.api.visitors.PHPVisitorCheck

analyze, analyze, analyze, context, getFullyQualifiedName, init, newIssue, scan, scan, visitArrayAccess, visitArrayAssignmentPattern, visitArrayAssignmentPatternElement, visitArrayInitializerBracket, visitArrayInitializerFunction, visitArrayPair, visitAssignmentExpression, visitAttribute, visitAttributeGroup, visitBinaryExpression, visitBlock, visitBreakStatement, visitBuiltInType, visitCallArgument, visitCaseClause, visitCastExpression, visitCatchBlock, visitConditionalExpression, visitContinueStatement, visitDeclareStatement, visitDefaultClause, visitDoWhileStatement, visitEchoTagStatement, visitElseClause, visitElseifClause, visitEmptyStatement, visitExecutionOperator, visitExpandableStringCharacters, visitExpandableStringLiteral, visitExpressionListStatement, visitExpressionStatement, visitForEachStatement, visitForStatement, visitGotoStatement, visitHeredoc, visitIfStatement, visitInlineHTML, visitLabel, visitListExpression, visitLiteral, visitMatchConditionClause, visitMatchDefaultClause, visitMatchExpression, visitNamespaceName, visitParenthesisedExpression, visitPostfixExpression, visitPrefixedCastExpression, visitPrefixExpression, visitReferenceVariable, visitReturnStatement, visitReturnTypeClause, visitScript, visitSpreadArgument, visitSwitchStatement, visitThrowExpression, visitThrowStatement, visitTraitAlias, visitTraitMethodReference, visitTraitPrecedence, visitTrivia, visitTryStatement, visitType, visitUnionType, visitUnsetVariableStatement, visitUseClause, visitVariableDeclaration, visitVariableVariable, visitWhileStatement, visitYieldExpression

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.sonar.plugins.php.api.visitors.PHPCheck

terminate

Constructor Detail

SymbolVisitor

public SymbolVisitor(SymbolTableImpl symbolTable)

Method Detail

visitCompilationUnit

public void visitCompilationUnit(CompilationUnitTree tree)

Specified by:

visitCompilationUnit in interface VisitorCheck

Overrides:

visitCompilationUnit in class PHPVisitorCheck

visitNamespaceStatement

public void visitNamespaceStatement(NamespaceStatementTree tree)

Specified by:

visitNamespaceStatement in interface VisitorCheck

visitFunctionDeclaration

public void visitFunctionDeclaration(FunctionDeclarationTree tree)

Specified by:

visitFunctionDeclaration in interface VisitorCheck

Overrides:

visitFunctionDeclaration in class PHPVisitorCheck

visitFunctionExpression

public void visitFunctionExpression(FunctionExpressionTree tree)

Specified by:

visitFunctionExpression in interface VisitorCheck

Overrides:

visitFunctionExpression in class PHPVisitorCheck

visitArrowFunctionExpression

public void visitArrowFunctionExpression(ArrowFunctionExpressionTree tree)

Specified by:

visitArrowFunctionExpression in interface VisitorCheck

Overrides:

visitArrowFunctionExpression in class PHPVisitorCheck

visitMethodDeclaration

public void visitMethodDeclaration(MethodDeclarationTree tree)

Specified by:

visitMethodDeclaration in interface VisitorCheck

Overrides:

visitMethodDeclaration in class PHPVisitorCheck

visitClassPropertyDeclaration

public void visitClassPropertyDeclaration(ClassPropertyDeclarationTree tree)

Specified by:

visitClassPropertyDeclaration in interface VisitorCheck

Overrides:

visitClassPropertyDeclaration in class PHPVisitorCheck

visitParameterList

public void visitParameterList(ParameterListTree tree)

Specified by:

visitParameterList in interface VisitorCheck

Overrides:

visitParameterList in class PHPVisitorCheck

visitClassDeclaration

public void visitClassDeclaration(ClassDeclarationTree tree)

Specified by:

visitClassDeclaration in interface VisitorCheck

Overrides:

visitClassDeclaration in class PHPVisitorCheck

visitUseTraitDeclaration

public void visitUseTraitDeclaration(UseTraitDeclarationTree tree)

Specified by:

visitUseTraitDeclaration in interface VisitorCheck

Overrides:

visitUseTraitDeclaration in class PHPVisitorCheck

visitAnonymousClass

public void visitAnonymousClass(AnonymousClassTree tree)

Specified by:

visitAnonymousClass in interface VisitorCheck

Overrides:

visitAnonymousClass in class PHPVisitorCheck

visitConstDeclaration

public void visitConstDeclaration(ConstantDeclarationTree tree)

Description copied from interface: VisitorCheck

[ START ] Statement

Specified by:

visitConstDeclaration in interface VisitorCheck

Overrides:

visitConstDeclaration in class PHPVisitorCheck

visitVariableIdentifier

public void visitVariableIdentifier(VariableIdentifierTree tree)

Specified by:

visitVariableIdentifier in interface VisitorCheck

Overrides:

visitVariableIdentifier in class PHPVisitorCheck

visitToken

public void visitToken(SyntaxToken token)

Specified by:

visitToken in interface VisitorCheck

Overrides:

visitToken in class PHPVisitorCheck

visitNameIdentifier

public void visitNameIdentifier(NameIdentifierTree tree)

Specified by:

visitNameIdentifier in interface VisitorCheck

Overrides:

visitNameIdentifier in class PHPVisitorCheck

visitCompoundVariable

public void visitCompoundVariable(CompoundVariableTree tree)

Specified by:

visitCompoundVariable in interface VisitorCheck

Overrides:

visitCompoundVariable in class PHPVisitorCheck

visitParameter

public void visitParameter(ParameterTree tree)

Specified by:

visitParameter in interface VisitorCheck

Overrides:

visitParameter in class PHPVisitorCheck

visitGlobalStatement

public void visitGlobalStatement(GlobalStatementTree tree)

Specified by:

visitGlobalStatement in interface VisitorCheck

Overrides:

visitGlobalStatement in class PHPVisitorCheck

visitStaticStatement

public void visitStaticStatement(StaticStatementTree tree)

Specified by:

visitStaticStatement in interface VisitorCheck

Overrides:

visitStaticStatement in class PHPVisitorCheck

visitLexicalVariables

public void visitLexicalVariables(LexicalVariablesTree tree)

Specified by:

visitLexicalVariables in interface VisitorCheck

Overrides:

visitLexicalVariables in class PHPVisitorCheck

visitNewExpression

public void visitNewExpression(NewExpressionTree tree)

Specified by:

visitNewExpression in interface VisitorCheck

Overrides:

visitNewExpression in class PHPVisitorCheck

visitFunctionCall

public void visitFunctionCall(FunctionCallTree tree)

Specified by:

visitFunctionCall in interface VisitorCheck

Overrides:

visitFunctionCall in class PHPVisitorCheck

visitMemberAccess

public void visitMemberAccess(MemberAccessTree tree)

Specified by:

visitMemberAccess in interface VisitorCheck

Overrides:

visitMemberAccess in class PHPVisitorCheck

visitComputedVariable

public void visitComputedVariable(ComputedVariableTree tree)

Specified by:

visitComputedVariable in interface VisitorCheck

Overrides:

visitComputedVariable in class PHPVisitorCheck

currentNamespace

public SymbolQualifiedName currentNamespace()

isBracketedNamespace

public boolean isBracketedNamespace(NamespaceStatementTree tree)

visitUseStatement

public void visitUseStatement(UseStatementTree tree)

Specified by:

visitUseStatement in interface VisitorCheck

Overrides:

visitUseStatement in class PHPVisitorCheck

getFullyQualifiedName

public QualifiedName getFullyQualifiedName(NamespaceNameTree name,
                                           Symbol.Kind kind)

Resolution rules are defined in http://php.net/manual/en/language.namespaces.rules.php

If unqualified name (see above link for definition) is a class symbol we resolve it in the current namespace. If it's a function we check if it's declared in current namespace, and if not we resolve as if it was in global namespace. This is imprecise heuristics, because function could be declared in current namespace, but in another source file, thus we will incorrectly consider such functions to be in the global namespace