Package org.sonar.php.tree.visitors

Class PHPCheckContext

java.lang.Object

org.sonar.php.tree.visitors.PHPCheckContext

All Implemented Interfaces:

RegexCheckContext, CheckContext

public class PHPCheckContext
extends Object
implements CheckContext, RegexCheckContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
CacheContext	cacheContext()
List<PhpIssue>	getIssues()
PhpFile	getPhpFile()
File	getWorkingDirectory()
FileIssue	newFileIssue(PHPCheck check, String message)	To add cost use FileIssue.cost(double).
PreciseIssue	newIssue(PhpRegexCheck check, org.sonarsource.analyzer.commons.regex.ast.RegexSyntaxElement regexTree, String message)
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).
PreciseIssue	newIssue(PHPCheck check, IssueLocation issueLocation)	Report an issue with precise issue location based on lines and columns without relaying on tree elements
LineIssue	newLineIssue(PHPCheck check, int line, String message)	To add cost use LineIssue.cost(double).
org.sonarsource.analyzer.commons.regex.RegexParseResult	regexForLiteral(org.sonarsource.analyzer.commons.regex.ast.FlagSet initialFlags, LiteralTree stringLiteral)
SymbolTable	symbolTable()
CompilationUnitTree	tree()

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.CheckContext

getFramework

Constructor Details

PHPCheckContext

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

PHPCheckContext

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

PHPCheckContext

public PHPCheckContext(PhpInputFileContext fileContext,
 CompilationUnitTree tree,
 SymbolTable symbolTable)

Method Details

tree

public CompilationUnitTree tree()

Specified by:

tree in interface CheckContext

Returns:

the top tree node of the current file AST representation.

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

newIssue

public PreciseIssue newIssue(PhpRegexCheck check,
 org.sonarsource.analyzer.commons.regex.ast.RegexSyntaxElement regexTree,
 String message)

Specified by:

newIssue in interface RegexCheckContext

newIssue

public PreciseIssue newIssue(PHPCheck check,
 IssueLocation issueLocation)

Description copied from interface: CheckContext

Report an issue with precise issue location based on lines and columns without relaying on tree elements

Specified by:

newIssue in interface CheckContext

Parameters:

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

issueLocation - issue location within a file including the location message

Returns:

issue with precise location

regexForLiteral

public org.sonarsource.analyzer.commons.regex.RegexParseResult regexForLiteral(org.sonarsource.analyzer.commons.regex.ast.FlagSet initialFlags,
 LiteralTree stringLiteral)

Specified by:

regexForLiteral in interface RegexCheckContext

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

cacheContext

public CacheContext cacheContext()

Specified by:

cacheContext in interface CheckContext