Piwik\Metrics\Formatter\
Metrics formatter that formats for HTML output.
The class defines the following methods:
getPrettyNumber()
ash; Returns a prettified string representation of a number. Inherited from Formatter
getPrettyTimeFromSeconds()
ash; Returns a prettified time value (in seconds). Inherited from Formatter
getPrettySizeFromBytes()
ash; Returns a prettified memory size value. Inherited from Formatter
getPrettyMoney()
ash; Returns a pretty formatted monetary value using the currency associated with a site. Inherited from Formatter
getPrettyPercentFromQuotient()
ash; Returns a percent string from a quotient value. Inherited from Formatter
formatMetrics()
ash; Formats all metrics, including processed metrics, for a DataTable. Inherited from Formatter
getPrettyNumber()
Returns a prettified string representation of a number. The result will have
thousands separators and a decimal point specific to the current locale, eg,
'1,000,000.05'
or '1.000.000,05'
.
It accepts the following parameter(s):
$value
$precision
It returns a string
value.
getPrettyTimeFromSeconds()
Returns a prettified time value (in seconds).
$numberOfSeconds
(int
) —
The number of seconds.$displayTimeAsSentence
(bool
) —
If set to true, will output "5min 17s"
, if false "00:05:17"
.$round
(bool
) —
Whether to round to the nearest second or not.string
value.getPrettySizeFromBytes()
Returns a prettified memory size value.
It accepts the following parameter(s):
$size
(Piwik\Metrics\number
) —
The size in bytes.$unit
(string
) —
The specific unit to use, if any. If null, the unit is determined by $size.$precision
(int
) —
The precision to use when rounding.Returns: string
—
eg, '128 M'
or '256 K'
.
getPrettyMoney()
Returns a pretty formatted monetary value using the currency associated with a site.
$value
(int
|string
) —
The monetary value to format.$idSite
(int
) —
The ID of the site whose currency will be used.string
value.getPrettyPercentFromQuotient()
Returns a percent string from a quotient value. Forces the use of a '.' decimal place.
It accepts the following parameter(s):
$value
(float
) —It returns a string
value.
formatMetrics()
Formats all metrics, including processed metrics, for a DataTable. Metrics to format are found through report metadata and DataTable metadata.
$dataTable
(DataTable
) —
The table to format metrics for.$report
(Report
) —
The report the table belongs to.$metricsToFormat
(string[]
|null
) —
Allow a list of names of metrics to format.$formatAll
(boolean
) —
If true, will also apply formatting to non-processed metrics like revenue. This parameter is not currently supported and subject to change.