HistoryComparison

API reference › Debug › widgets › history › HistoryComparison

final readonly class	yii\debug\widgets\history\HistoryComparison
Source	src/widgets/history/HistoryComparison.php

Builds a privacy-preserving comparison of two immutable debugger snapshots.

Summary metrics expose already-redacted manifest data. Panel payloads are compared structurally, retaining only counts of added, removed, changed, and unchanged JSON leaves instead of copying their values into the overview.

Properties

Property	Type	Description	Defined by
$baseline readonly	PHPForge\Debug\Storage\DebugSnapshot	Baseline snapshot.	HistoryComparison
$metrics readonly	list<PHPForge\Debug\Comparison\SummaryMetricComparison>	Request-summary metric comparisons in canonical history order.	HistoryComparison
$panels readonly	list<PHPForge\Debug\Comparison\PanelComparison>	Per-panel structural comparisons in configured display order.	HistoryComparison
$target readonly	PHPForge\Debug\Storage\DebugSnapshot	Target snapshot.	HistoryComparison

Methods

Method	Description	Defined by
fromSnapshots() static	Creates a comparison from two snapshots.	HistoryComparison
hasDifferences()	Returns whether either summary metrics or panel payloads differ.	HistoryComparison

Method details

fromSnapshots()

public static function fromSnapshots(PHPForge\Debug\Storage\DebugSnapshot $baseline, PHPForge\Debug\Storage\DebugSnapshot $target, array<string, string> $panelLabels = []): self

Creates a comparison from two snapshots.

Parameters

Parameter	Type	Description
$baseline	PHPForge\Debug\Storage\DebugSnapshot	Capture used as the reference side of the comparison.
$target	PHPForge\Debug\Storage\DebugSnapshot	Capture compared against the baseline.
$panelLabels	array<string, string>	Display names indexed by stable panel ID.

Returns

self: Comparison holding the metric and panel differences between both captures.

hasDifferences()

public function hasDifferences(): bool

Returns whether either summary metrics or panel payloads differ.

Returns

bool: true when metrics or panel payloads differ; false when the captures match.