Skip to content
PHP Ecosystem
Explore

HistoryComparisonRenderer

API reference › Yii3 Debug › Web › HistoryComparisonRenderer

final classYii3\Debug\Web\HistoryComparisonRenderer
Sourcesrc/Web/HistoryComparisonRenderer.php

Renders capture-comparison selection and results with the shared Debug Core primitives.

MethodDescriptionDefined by
render() staticRenders the comparison page for two captures.HistoryComparisonRenderer
renderForm() staticRenders the capture-selection form of the comparison page.HistoryComparisonRenderer
renderHistoryForm() staticRenders the compact comparison form embedded in the history page.HistoryComparisonRenderer
renderWithPanels() staticRenders links only for panels registered by the current adapter.HistoryComparisonRenderer
public static function render(Yii3\Debug\Comparison\HistoryComparison $comparison, array<string, PHPForge\Debug\Storage\RequestSummary> $manifest, string $routePrefix): string

Renders the comparison page for two captures.

Parameters

ParameterTypeDescription
$comparisonYii3\Debug\Comparison\HistoryComparisonDifferences between the two captures.
$manifestarray<string, PHPForge\Debug\Storage\RequestSummary>Captured request summaries keyed by tag.
$routePrefixstringBase route used to generate debugger URLs.

Returns

string: Rendered comparison page.

public static function renderForm(array<string, PHPForge\Debug\Storage\RequestSummary> $manifest, string $baseline, string $target, string $routePrefix): string

Renders the capture-selection form of the comparison page.

Parameters

ParameterTypeDescription
$manifestarray<string, PHPForge\Debug\Storage\RequestSummary>Captured request summaries keyed by tag.
$baselinestringTag currently selected as the baseline.
$targetstringTag currently selected as the target.
$routePrefixstringBase route used to generate debugger URLs.

Returns

string: Rendered form.

public static function renderHistoryForm(array<string, PHPForge\Debug\Storage\RequestSummary> $manifest, string $routePrefix): string

Renders the compact comparison form embedded in the history page.

Parameters

ParameterTypeDescription
$manifestarray<string, PHPForge\Debug\Storage\RequestSummary>Captured request summaries keyed by tag.
$routePrefixstringBase route used to generate debugger URLs.

Returns

string: Rendered form, or '' when fewer than two captures are available.

public static function renderWithPanels(Yii3\Debug\Comparison\HistoryComparison $comparison, array<string, PHPForge\Debug\Storage\RequestSummary> $manifest, string $routePrefix, array<string, string> $panelLabels): string

Renders links only for panels registered by the current adapter.

Parameters

ParameterTypeDescription
$comparisonYii3\Debug\Comparison\HistoryComparisonDifferences between the two captures.
$manifestarray<string, PHPForge\Debug\Storage\RequestSummary>Captured request summaries keyed by tag.
$routePrefixstringBase route used to generate debugger URLs.
$panelLabelsarray<string, string>Registered display names indexed by panel ID.

Returns

string: Rendered comparison page.