Skip to content
PHP Ecosystem
Explore

AuditFinding

API reference › Foxy › Audit › AuditFinding

final readonly classFoxy\Audit\AuditFinding
Sourcesrc/Audit/AuditFinding.php

Represents one normalized frontend dependency security advisory.

PropertyTypeDescriptionDefined by
$advisoryId readonly constructorstringPreferred advisory identifier, such as a GHSA identifier.AuditFinding
$affectedVersions readonly constructorlist<string>Installed versions affected by the advisory. Default: [].AuditFinding
$cves readonly constructorlist<string>Associated CVE identifiers. Default: [].AuditFinding
$cveStatus readonly constructorCveStatusStatus of CVE resolution for this advisory. Default: \Foxy\Audit\CveStatus::NOT_REQUESTED.AuditFinding
$dependencyPaths readonly constructorlist<string>Dependency paths that include the vulnerable package. Default: [].AuditFinding
$package readonly constructorstringPackage affected by the advisory.AuditFinding
$severity readonly constructorSeverityNormalized advisory severity.AuditFinding
$sourceId readonly constructorstring|nullIdentifier reported by the package manager.AuditFinding
$title readonly constructorstringHuman-readable advisory title.AuditFinding
$url readonly constructorstring|nullAdvisory details URL. Default: null.AuditFinding
$vulnerableVersions readonly constructorstringVersion constraint reported as vulnerable.AuditFinding
MethodDescriptionDefined by
__construct()Creates an immutable audit finding.AuditFinding
withCveResolution()Returns a copy with the supplied CVE resolution.AuditFinding
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

ParameterTypeDescription
$packagestringPackage affected by the advisory.
$severitySeverityNormalized advisory severity.
$advisoryIdstringPreferred advisory identifier, such as a GHSA identifier.
$sourceIdstring|nullIdentifier reported by the package manager.
$titlestringHuman-readable advisory title.
$vulnerableVersionsstringVersion constraint reported as vulnerable.
$urlstring|nullAdvisory details URL.
$cveslist<string>Associated CVE identifiers.
$cveStatusCveStatusStatus of CVE resolution for this advisory.
$affectedVersionslist<string>Installed versions affected by the advisory.
$dependencyPathslist<string>Dependency paths that include the vulnerable package.
public function withCveResolution(list<string> $cves, Foxy\Audit\CveStatus $status): self

Returns a copy with the supplied CVE resolution.

Parameters

ParameterTypeDescription
$cveslist<string>Resolved CVE identifiers.
$statusCveStatus

Returns

self