PHP Class PHPSA\Issue

Protected Properties

Property	Type	Description
$categories	string	Required. At least one category indicating the nature of the issue being reported.
$checkName	string	Required. A unique name representing the static analysis check that emitted this issue.
$content	string	Optional. A markdown snippet describing the issue, including deeper explanations and links to other resources.
$description	string	Required. A string explaining the issue that was detected.
$location	IssueLocation	Required. A Location object representing the place in the source code where the issue was discovered.
$type	string	Required. Must always be "issue".

Method	Description
__construct ( string $checkName, string $description, IssueLocation $location, array $categories = [self::CATEGORY_BUG_RISK] )
getCheckName ( ) : string
getDescription ( ) : string
getLocation ( ) : IssueLocation
getType ( ) : string
toArray ( ) : array

public __construct ( string $checkName, string $description, IssueLocation $location, array $categories = [self::CATEGORY_BUG_RISK] )
$checkName	string
$description	string
$location	IssueLocation
$categories	array

public getCheckName ( ) : string
return	string

public getDescription ( ) : string
return	string

public getLocation ( ) : IssueLocation
return	IssueLocation

public getType ( ) : string
return	string

public toArray ( ) : array
return	array

Required. At least one category indicating the nature of the issue being reported.

protected string $categories
return	string

Required. A unique name representing the static analysis check that emitted this issue.

protected string $checkName
return	string

Optional. A markdown snippet describing the issue, including deeper explanations and links to other resources.

protected string $content
return	string

Required. A string explaining the issue that was detected.

protected string $description
return	string

Required. A Location object representing the place in the source code where the issue was discovered.

protected IssueLocation,phpsa $location
return	IssueLocation

Required. Must always be "issue".

protected string $type
return	string