PHP Class PHPSA\Issue

Show file Open project: ovr/phpsa

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

Public Methods

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

Method Details

__construct() public method

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

getCheckName() public method

public getCheckName ( ) : string
return string

getDescription() public method

public getDescription ( ) : string
return string

getLocation() public method

public getLocation ( ) : IssueLocation
return IssueLocation

getType() public method

public getType ( ) : string
return string

toArray() public method

public toArray ( ) : array
return array

Property Details

$categories protected property

Required. At least one category indicating the nature of the issue being reported.
protected string $categories
return string

$checkName protected property

Required. A unique name representing the static analysis check that emitted this issue.
protected string $checkName
return string

$content protected property

Optional. A markdown snippet describing the issue, including deeper explanations and links to other resources.
protected string $content
return string

$description protected property

Required. A string explaining the issue that was detected.
protected string $description
return string

$location protected property

Required. A Location object representing the place in the source code where the issue was discovered.
protected IssueLocation,phpsa $location
return IssueLocation

$type protected property

Required. Must always be "issue".
protected string $type
return string