classReportAssets

packages/sql-catalog/src/Reporter/Html/ReportAssets.php:25

final class ReportAssets

Restricted visibility: declared "@visibility root". Code outside that scope must not name this declaration.

The stylesheets and the scripts the pages are read with.

The design is document-design's doc-ui, carried as the release the pages were written for — the unmodified stylesheet and script of one version, with the notice that says which and where from — rather than loaded from the network at whatever version is current: a report is read years after it is written, offline as often as not, and has to look then the way it looked when it was checked. The report's own script adds statement search and filtering; all styling comes from doc-ui.

The assets are written beside the pages rather than inlined into each of them: a report of a thousand statements is a hundred documents, and a stylesheet repeated a hundred times is a hundred copies to download and one to change.

Constants§

public const FILES = [\SqlCatalog\Reporter\Html\PageShell::DESIGN_STYLE => 'document-design-' . \Sql…

source §

The files the report carries, as the name each is written under and the resource it is read from.

Methods§

public function all(): array<string, string>

source §

The files the report carries, keyed by the name each is written under.

Returns

array<string, string>

Test cases 2

Called from 1

method-call SqlCatalog\Reporter\Html\HtmlReporter::render() packages/sql-catalog/src/Reporter/Html/HtmlReporter.php:76

Calls 2

class-const ReportAssets::FILES() line 45
method-call ReportAssets::read() line 46

public function read(string $name): string

source §

One asset read from the package's resources.

A missing asset is answered with nothing rather than with a warning: a report that lost its stylesheet is still a readable report, and a run that stops halfway through writing one is not.