PHP Class Phan\Issue

Public Methods

Method	Description
__construct ( string $type, integer $category, integer $severity, string $template, integer $remediation_difficulty, integer $type_id )
__invoke ( string $file, integer $line, array $template_parameters = [] ) : phan\IssueInstance
emit ( string $type, string $file, integer $line, variadic $template_parameters ) : void
emitInstance ( phan\IssueInstance $issue_instance ) : void
emitWithParameters ( string $type, string $file, integer $line, array $template_parameters ) : void
fromType ( string $type ) : Issue	return Issue
getCategory ( ) : integer
getNameForCategory ( integer $category ) : string
getRemediationDifficulty ( ) : integer
getSeverity ( ) : integer
getSeverityName ( ) : string
getTemplate ( ) : string
getType ( ) : string
getTypeId ( ) : integer
issueMap ( ) : Issue[]
maybeEmit ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, $parameters ) : void
maybeEmit ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, $parameters ) : void
maybeEmitInstance ( CodeBase $code_base, Context $context, phan\IssueInstance $issue_instance ) : void
maybeEmitInstance ( CodeBase $code_base, Context $context, phan\IssueInstance $issue_instance ) : void
maybeEmitWithParameters ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, array $parameters ) : void
maybeEmitWithParameters ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, array $parameters ) : void

public __construct ( string $type, integer $category, integer $severity, string $template, integer $remediation_difficulty, integer $type_id )
$type	string
$category	integer
$severity	integer
$template	string
$remediation_difficulty	integer
$type_id	integer	(unique integer id for $type)

public __invoke ( string $file, integer $line, array $template_parameters = [] ) : phan\IssueInstance
$file	string
$line	integer
$template_parameters	array
return	phan\IssueInstance

public static emit ( string $type, string $file, integer $line, variadic $template_parameters ) : void
$type	string	The type of the issue
$file	string	The name of the file where the issue was found
$line	integer	The line number (start) where the issue was found
$template_parameters	variadic	Any template parameters required for the issue message
return	void

public static emitInstance ( phan\IssueInstance $issue_instance ) : void
$issue_instance	phan\IssueInstance	An issue instance to emit
return	void

public static emitWithParameters ( string $type, string $file, integer $line, array $template_parameters ) : void
$type	string	The type of the issue
$file	string	The name of the file where the issue was found
$line	integer	The line number (start) where the issue was found
$template_parameters	array	Any template parameters required for the issue message
return	void

return Issue

public static fromType ( string $type ) : Issue
$type	string
return	Issue

public getCategory ( ) : integer
return	integer

public static getNameForCategory ( integer $category ) : string
$category	integer
return	string	The name of the category

public getRemediationDifficulty ( ) : integer
return	integer

public getSeverity ( ) : integer
return	integer

public getSeverityName ( ) : string
return	string	A descriptive name of the severity of hte issue

public getTemplate ( ) : string
return	string

public getType ( ) : string
return	string

public getTypeId ( ) : integer
return	integer	(Unique integer code corresponding to getType())

public static issueMap ( ) : Issue[]
return	Issue[]

public static maybeEmit ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, $parameters ) : void
$code_base	CodeBase	The code base within which we're operating
$context	Phan\Language\Context	The context in which the node we're going to be looking at exits.
$issue_type	string	The type of issue to emit such as Issue::ParentlessClass
$lineno	integer	The line number where the issue was found
return	void

public static maybeEmit ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, $parameters ) : void
$code_base	CodeBase	The code base within which we're operating
$context	Phan\Language\Context	The context in which the node we're going to be looking at exits.
$issue_type	string	The type of issue to emit such as Issue::ParentlessClass
$lineno	integer	The line number where the issue was found
return	void

public static maybeEmitInstance ( CodeBase $code_base, Context $context, phan\IssueInstance $issue_instance ) : void
$code_base	CodeBase	The code base within which we're operating
$context	Phan\Language\Context	The context in which the instance was found
$issue_instance	phan\IssueInstance	An issue instance to emit
return	void

public static maybeEmitInstance ( CodeBase $code_base, Context $context, phan\IssueInstance $issue_instance ) : void
$code_base	CodeBase	The code base within which we're operating
$context	Phan\Language\Context	The context in which the instance was found
$issue_instance	phan\IssueInstance	An issue instance to emit
return	void

public static maybeEmitWithParameters ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, array $parameters ) : void
$code_base	CodeBase	The code base within which we're operating
$context	Phan\Language\Context	The context in which the node we're going to be looking at exits.
$issue_type	string	The type of issue to emit such as Issue::ParentlessClass
$lineno	integer	The line number where the issue was found
$parameters	array
return	void

public static maybeEmitWithParameters ( CodeBase $code_base, Context $context, string $issue_type, integer $lineno, array $parameters ) : void
$code_base	CodeBase	The code base within which we're operating
$context	Phan\Language\Context	The context in which the node we're going to be looking at exits.
$issue_type	string	The type of issue to emit such as Issue::ParentlessClass
$lineno	integer	The line number where the issue was found
$parameters	array
return	void