Package org.sonar.php.tree.symbols

Class DeclarationVisitor

java.lang.Object

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

org.sonar.php.tree.symbols.DeclarationVisitor

All Implemented Interfaces:

PHPCheck, VisitorCheck

public class DeclarationVisitor
extends PHPVisitorCheck

Field Summary

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

MAX_DEPTH

Method Summary

Modifier and Type	Method	Description
Collection<ClassSymbolData>	classSymbolData()
ClassSymbolIndex	classSymbolIndex()
SymbolQualifiedName	currentNamespace()
Collection<FunctionSymbolData>	functionSymbolData()
FunctionSymbolIndex	functionSymbolIndex()
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	visitClassDeclaration(ClassDeclarationTree tree)
void	visitCompilationUnit(CompilationUnitTree tree)
void	visitFunctionCall(FunctionCallTree tree)
void	visitFunctionDeclaration(FunctionDeclarationTree tree)
void	visitFunctionExpression(FunctionExpressionTree tree)
void	visitMethodDeclaration(MethodDeclarationTree tree)
void	visitNamespaceStatement(NamespaceStatementTree tree)
void	visitReturnStatement(ReturnStatementTree tree)
void	visitUseStatement(UseStatementTree tree)
void	visitYieldExpression(YieldExpressionTree 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, visitArrowFunctionExpression, visitAssignmentExpression, visitAttribute, visitAttributeGroup, visitBinaryExpression, visitBlock, visitBreakStatement, visitBuiltInType, visitCallArgument, visitCaseClause, visitCastExpression, visitCatchBlock, visitClassPropertyDeclaration, visitCompoundVariable, visitComputedVariable, visitConditionalExpression, visitConstDeclaration, visitContinueStatement, visitDeclareStatement, visitDefaultClause, visitDoWhileStatement, visitEchoTagStatement, visitElseClause, visitElseifClause, visitEmptyStatement, visitExecutionOperator, visitExpandableStringCharacters, visitExpandableStringLiteral, visitExpressionListStatement, visitExpressionStatement, visitForEachStatement, visitForStatement, visitGlobalStatement, visitGotoStatement, visitHeredoc, visitIfStatement, visitInlineHTML, visitLabel, visitLexicalVariables, visitListExpression, visitLiteral, visitMatchConditionClause, visitMatchDefaultClause, visitMatchExpression, visitMemberAccess, visitNameIdentifier, visitNamespaceName, visitNewExpression, visitParameter, visitParameterList, visitParenthesisedExpression, visitPostfixExpression, visitPrefixedCastExpression, visitPrefixExpression, visitReferenceVariable, visitReturnTypeClause, visitScript, visitSpreadArgument, visitStaticStatement, visitSwitchStatement, visitThrowExpression, visitThrowStatement, visitToken, visitTraitAlias, visitTraitMethodReference, visitTraitPrecedence, visitTrivia, visitTryStatement, visitType, visitUnionType, visitUnsetVariableStatement, visitUseClause, visitUseTraitDeclaration, visitVariableDeclaration, visitVariableIdentifier, visitVariableVariable, visitWhileStatement

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

Method Detail

visitCompilationUnit

public void visitCompilationUnit(CompilationUnitTree tree)

Specified by:

visitCompilationUnit in interface VisitorCheck

Overrides:

visitCompilationUnit in class PHPVisitorCheck

visitClassDeclaration

public void visitClassDeclaration(ClassDeclarationTree tree)

Specified by:

visitClassDeclaration in interface VisitorCheck

Overrides:

visitClassDeclaration in class PHPVisitorCheck

visitAnonymousClass

public void visitAnonymousClass(AnonymousClassTree tree)

Specified by:

visitAnonymousClass in interface VisitorCheck

Overrides:

visitAnonymousClass in class PHPVisitorCheck

visitMethodDeclaration

public void visitMethodDeclaration(MethodDeclarationTree tree)

Specified by:

visitMethodDeclaration in interface VisitorCheck

Overrides:

visitMethodDeclaration in class PHPVisitorCheck

visitFunctionDeclaration

public void visitFunctionDeclaration(FunctionDeclarationTree tree)

Specified by:

visitFunctionDeclaration in interface VisitorCheck

Overrides:

visitFunctionDeclaration in class PHPVisitorCheck

visitReturnStatement

public void visitReturnStatement(ReturnStatementTree tree)

Specified by:

visitReturnStatement in interface VisitorCheck

Overrides:

visitReturnStatement in class PHPVisitorCheck

visitYieldExpression

public void visitYieldExpression(YieldExpressionTree tree)

Specified by:

visitYieldExpression in interface VisitorCheck

Overrides:

visitYieldExpression in class PHPVisitorCheck

visitFunctionExpression

public void visitFunctionExpression(FunctionExpressionTree tree)

Specified by:

visitFunctionExpression in interface VisitorCheck

Overrides:

visitFunctionExpression in class PHPVisitorCheck

visitFunctionCall

public void visitFunctionCall(FunctionCallTree tree)

Specified by:

visitFunctionCall in interface VisitorCheck

Overrides:

visitFunctionCall in class PHPVisitorCheck

classSymbolData

public Collection<ClassSymbolData> classSymbolData()

classSymbolIndex

public ClassSymbolIndex classSymbolIndex()

functionSymbolData

public Collection<FunctionSymbolData> functionSymbolData()

functionSymbolIndex

public FunctionSymbolIndex functionSymbolIndex()

currentNamespace

public SymbolQualifiedName currentNamespace()

visitNamespaceStatement

public void visitNamespaceStatement(NamespaceStatementTree tree)

Specified by:

visitNamespaceStatement in interface VisitorCheck

Overrides:

visitNamespaceStatement in class PHPVisitorCheck

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