AuditFinding
API reference › Foxy › Audit › AuditFinding
Represents one normalized frontend dependency security advisory.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$advisoryId readonly constructor | string | Preferred advisory identifier, such as a GHSA identifier. | AuditFinding |
$affectedVersions readonly constructor | list<string> | Installed versions affected by the advisory. Default: []. | AuditFinding |
$cves readonly constructor | list<string> | Associated CVE identifiers. Default: []. | AuditFinding |
$cveStatus readonly constructor | CveStatus | Status of CVE resolution for this advisory. Default: \. | AuditFinding |
$dependencyPaths readonly constructor | list<string> | Dependency paths that include the vulnerable package. Default: []. | AuditFinding |
$package readonly constructor | string | Package affected by the advisory. | AuditFinding |
$severity readonly constructor | Severity | Normalized advisory severity. | AuditFinding |
$sourceId readonly constructor | string| | Identifier reported by the package manager. | AuditFinding |
$title readonly constructor | string | Human-readable advisory title. | AuditFinding |
$url readonly constructor | string| | Advisory details URL. Default: null. | AuditFinding |
$vulnerableVersions readonly constructor | string | Version constraint reported as vulnerable. | AuditFinding |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Creates an immutable audit finding. | AuditFinding |
withCveResolution() | Returns a copy with the supplied CVE resolution. | AuditFinding |
Method details
Section titled “Method details”__construct()
Section titled “__construct() ”public function __construct(string $package, Foxy\Audit\Severity $severity, string $advisoryId, string|null $sourceId, string $title, string $vulnerableVersions, string|null $url = null, list<string> $cves = [], Foxy\Audit\CveStatus $cveStatus = \Foxy\Audit\CveStatus::NOT_REQUESTED, list<string> $affectedVersions = [], list<string> $dependencyPaths = [])Creates an immutable audit finding.
Parameters
| Parameter | Type | Description |
|---|---|---|
$package | string | Package affected by the advisory. |
$severity | Severity | Normalized advisory severity. |
$advisoryId | string | Preferred advisory identifier, such as a GHSA identifier. |
$sourceId | string| | Identifier reported by the package manager. |
$title | string | Human-readable advisory title. |
$vulnerableVersions | string | Version constraint reported as vulnerable. |
$url | string| | Advisory details URL. |
$cves | list<string> | Associated CVE identifiers. |
$cveStatus | CveStatus | Status of CVE resolution for this advisory. |
$affectedVersions | list<string> | Installed versions affected by the advisory. |
$dependencyPaths | list<string> | Dependency paths that include the vulnerable package. |
withCveResolution()
Section titled “withCveResolution() ”public function withCveResolution(list<string> $cves, Foxy\Audit\CveStatus $status): selfReturns a copy with the supplied CVE resolution.
Parameters
| Parameter | Type | Description |
|---|---|---|
$cves | list<string> | Resolved CVE identifiers. |
$status | CveStatus |
Returns
self