PHP Class PHPSA\Issue

Afficher le fichier Open project: ovr/phpsa

Protected Properties

Свойство 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".

Méthodes publiques

Méthode 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 méthode

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

getCheckName() public méthode

public getCheckName ( ) : string
Résultat string

getDescription() public méthode

public getDescription ( ) : string
Résultat string

getLocation() public méthode

public getLocation ( ) : IssueLocation
Résultat IssueLocation

getType() public méthode

public getType ( ) : string
Résultat string

toArray() public méthode

public toArray ( ) : array
Résultat array

Property Details

$categories protected_oe property

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

$checkName protected_oe property

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

$content protected_oe property

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

$description protected_oe property

Required. A string explaining the issue that was detected.
protected string $description
Résultat string

$location protected_oe property

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

$type protected_oe property

Required. Must always be "issue".
protected string $type
Résultat string