AuditReport
API reference › Foxy › Audit › AuditReport
Contains normalized findings and diagnostics from one package manager audit.
Properties
Section titled “Properties”| Property | Type | Description | Defined by |
|---|---|---|---|
$diagnostics readonly constructor | string | Diagnostic output emitted by the package manager. Default: ''. | AuditReport |
$findings readonly constructor | list<AuditFinding> | Normalized security findings. | AuditReport |
$manager readonly constructor | string | Package manager that produced the report. | AuditReport |
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
__construct() | Creates an immutable audit report. | AuditReport |
countPackages() | Returns the number of distinct affected packages. | AuditReport |
countSeverities() | Counts findings for every supported severity. | AuditReport |
hasFindingAtLeast() | Whether any finding meets or exceeds the minimum severity. | AuditReport |
withFindings() | Returns a copy with the supplied findings. | AuditReport |
Method details
Section titled “Method details”__construct()
Section titled “__construct() ”public function __construct(string $manager, list<Foxy\Audit\AuditFinding> $findings, string $diagnostics = '')Creates an immutable audit report.
Parameters
| Parameter | Type | Description |
|---|---|---|
$manager | string | Package manager that produced the report. |
$findings | list<AuditFinding> | Normalized security findings. |
$diagnostics | string | Diagnostic output emitted by the package manager. |
countPackages()
Section titled “countPackages() ”public function countPackages(): intReturns the number of distinct affected packages.
Returns
int
countSeverities()
Section titled “countSeverities() ”public function countSeverities(): array<string, int>Counts findings for every supported severity.
Returns
array<string, int>
hasFindingAtLeast()
Section titled “hasFindingAtLeast() ”public function hasFindingAtLeast(Foxy\Audit\Severity $minimumSeverity): boolWhether any finding meets or exceeds the minimum severity.
withFindings()
Section titled “withFindings() ”public function withFindings(list<Foxy\Audit\AuditFinding> $findings): selfReturns a copy with the supplied findings.