Report Renderers¶
Reports are rendered to an output medium using classes
implementing the PhpBench\Report\RendererInterface
.
The configuration for a renderer is known here as an output. The user may define new outputs either in the configuration file or on the CLI. The renderer may also supply default outputs.
console
¶
Renders directly to the console.
Options:
- table_style:
Type(s):
[null, scalar]
, Default:NULL
This is option does nothing and will be removed in PHPBench 2.0
delimited
¶
The delimited renderer outputs the report as a delimited value list (for example a tab separated list of values). Such data can be easily imported into applications such as GNUPlot.
Options:
- delimiter:
- Type(s):
string
, Default: `` ``
- file:
- Type(s):
[null, string]
, Default:NULL
- header:
- Type(s):
bool
, Default:true
html
¶
Render the report to a HTML document.
Options:
- title:
Type(s):
string
, Default:PHPBench Report
Title of document
- path:
Type(s):
string
, Default:.phpbench/html/index.html
Path to output document