Package org.sonar.php.tree.visitors

Class PHPCheckContext

java.lang.Object

org.sonar.php.tree.visitors.PHPCheckContext

All Implemented Interfaces:

CheckContext

public class PHPCheckContext
extends Object
implements CheckContext

Constructor Summary

Constructors

Constructor	Description
PHPCheckContext(PhpFile file, CompilationUnitTree tree, File workingDirectory)
PHPCheckContext(PhpFile file, CompilationUnitTree tree, File workingDirectory, SymbolTable symbolTable)

Method Summary

Modifier and Type	Method	Description
List<PhpIssue>	getIssues()
PhpFile	getPhpFile()
File	getWorkingDirectory()
FileIssue	newFileIssue(PHPCheck check, String message)	To add cost use FileIssue.cost(double).
LegacyIssue	newIssue(PHPCheck check, String message)	To set line and cost use Issue.line(int) and Issue.cost(double).
PreciseIssue	newIssue(PHPCheck check, Tree tree, String message)	To add secondary locations and cost use PreciseIssue.secondary(Tree, String) and PreciseIssue.cost(double).
PreciseIssue	newIssue(PHPCheck check, Tree startTree, Tree endTree, String message)	To add secondary locations and cost use PreciseIssue.secondary(Tree, String) and PreciseIssue.cost(double).
LineIssue	newLineIssue(PHPCheck check, int line, String message)	To add cost use LineIssue.cost(double).
SymbolTable	symbolTable()
CompilationUnitTree	tree()

Methods inherited from class java.lang.Object

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

Constructor Detail

PHPCheckContext

public PHPCheckContext(PhpFile file,
                       CompilationUnitTree tree,
                       @Nullable
                       File workingDirectory)

PHPCheckContext

public PHPCheckContext(PhpFile file,
                       CompilationUnitTree tree,
                       @Nullable
                       File workingDirectory,
                       SymbolTable symbolTable)

Method Detail

tree

public CompilationUnitTree tree()

Specified by:

tree in interface CheckContext

Returns:

the top tree node of the current file AST representation.

newIssue

public LegacyIssue newIssue(PHPCheck check,
                            String message)

Description copied from interface: CheckContext

To set line and cost use Issue.line(int) and Issue.cost(double). Note, that these calls could be chained.

   newIssue(myCheck, "Some message")
     .line(105)
     .cost(3);
 

Specified by:

newIssue in interface CheckContext

Parameters:

check - the instance of the rule for which issue should be created

message - message of the issue

Returns:

instance of Issue

newIssue

public PreciseIssue newIssue(PHPCheck check,
                             Tree tree,
                             String message)

Description copied from interface: CheckContext

To add secondary locations and cost use PreciseIssue.secondary(Tree, String) and PreciseIssue.cost(double). Note, that these calls could be chained.

   newIssue(myCheck, primaryTree, "Primary message")
     .secondary(secondaryTree1, "Secondary message")
     .secondary(secondaryTree2, null)
     .cost(3);
 

Specified by:

newIssue in interface CheckContext

Parameters:

check - the instance of the rule for which issue should be created

tree - primary location for issue

message - primary message of the issue

Returns:

issue with precise location

newIssue

public PreciseIssue newIssue(PHPCheck check,
                             Tree startTree,
                             Tree endTree,
                             String message)

Description copied from interface: CheckContext

To add secondary locations and cost use PreciseIssue.secondary(Tree, String) and PreciseIssue.cost(double). Note, that these calls could be chained.

   newIssue(myCheck, primaryLocationStartTree, primaryLocationEndTree, "Primary message")
     .secondary(secondaryTree1, "Secondary message")
     .secondary(secondaryTree2, null)
     .cost(3);
 

Specified by:

newIssue in interface CheckContext

Parameters:

check - the instance of the rule for which issue should be created

startTree - start of this tree will be the start of primary location of the issue

endTree - end of this tree will be the end of primary location of the issue

message - primary message of the issue

Returns:

issue with precise location

newLineIssue

public LineIssue newLineIssue(PHPCheck check,
                              int line,
                              String message)

Description copied from interface: CheckContext

To add cost use LineIssue.cost(double).

   newLineIssue(myCheck, 42, "Message")
     .cost(3);
 

Specified by:

newLineIssue in interface CheckContext

Parameters:

check - the instance of the rule for which issue should be created

line - position of the issue in the file

message - message of the issue

Returns:

issue with line location

newFileIssue

public FileIssue newFileIssue(PHPCheck check,
                              String message)

Description copied from interface: CheckContext

To add cost use FileIssue.cost(double).

   newFileIssue(myCheck, "Message")
     .cost(3);
 

Specified by:

newFileIssue in interface CheckContext

Parameters:

check - the instance of the rule for which issue should be created

message - message of the issue

Returns:

issue at file level

getPhpFile

public PhpFile getPhpFile()

Specified by:

getPhpFile in interface CheckContext

Returns:

the current file

getIssues

public List<PhpIssue> getIssues()

Specified by:

getIssues in interface CheckContext

symbolTable

public SymbolTable symbolTable()

Specified by:

symbolTable in interface CheckContext

getWorkingDirectory

public File getWorkingDirectory()

Specified by:

getWorkingDirectory in interface CheckContext