Skip to content
PHP Ecosystem
Explore

AuditReport

API reference › Foxy › Audit › AuditReport

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

Contains normalized findings and diagnostics from one package manager audit.

PropertyTypeDescriptionDefined by
$diagnostics readonly constructorstringDiagnostic output emitted by the package manager. Default: ''.AuditReport
$findings readonly constructorlist<AuditFinding>Normalized security findings.AuditReport
$manager readonly constructorstringPackage manager that produced the report.AuditReport
MethodDescriptionDefined 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
public function __construct(string $manager, list<Foxy\Audit\AuditFinding> $findings, string $diagnostics = '')

Creates an immutable audit report.

Parameters

ParameterTypeDescription
$managerstringPackage manager that produced the report.
$findingslist<AuditFinding>Normalized security findings.
$diagnosticsstringDiagnostic output emitted by the package manager.
public function countPackages(): int

Returns the number of distinct affected packages.

Returns

int

public function countSeverities(): array<string, int>

Counts findings for every supported severity.

Returns

array<string, int>

public function hasFindingAtLeast(Foxy\Audit\Severity $minimumSeverity): bool

Whether any finding meets or exceeds the minimum severity.

Parameters

ParameterTypeDescription
$minimumSeveritySeverity

Returns

bool

public function withFindings(list<Foxy\Audit\AuditFinding> $findings): self

Returns a copy with the supplied findings.

Parameters

ParameterTypeDescription
$findingslist<AuditFinding>Replacement findings.

Returns

self