Piwik\DataTable\Filter\

ReplaceSummaryRowLabel

Replaces the label of the summary row with a supplied label.

This filter is only used to prettify the summary row label and so it should always be queued on a DataTable.

This filter always recurses. In other words, this filter will always apply itself to all subtables in the given DataTable's table hierarchy.

Basic example

$dataTable->queueFilter('ReplaceSummaryRowLabel', array(Piwik::translate('General_Others')));

Methods

The class defines the following methods:

• __construct() — Constructor.
• filter() ash; See ReplaceSummaryRowLabel.
• enableRecursive() ash; Enables/Disables recursive filtering. Inherited from BaseFilter
• filterSubTable() ash; Filters a row's subtable, if one exists and is loaded in memory. Inherited from BaseFilter

__construct()

Constructor.

Signature

• It accepts the following parameter(s):

  • $table (DataTable) —

  • $newLabel (string|null) — The new label for summary row. If null, defaults to Piwik::translate('General_Others').

filter()

See ReplaceSummaryRowLabel.

Signature

• It accepts the following parameter(s):

  • $table (DataTable) —

• It does not return anything or a mixed result.

enableRecursive()

Enables/Disables recursive filtering. Whether this property is actually used is up to the derived BaseFilter class.

Signature

• It accepts the following parameter(s):

  • $enable (bool) —

• It does not return anything or a mixed result.

filterSubTable()

Filters a row's subtable, if one exists and is loaded in memory.

Signature

• It accepts the following parameter(s):
  • $row (Row) — The row whose subtable should be filter.
• It does not return anything or a mixed result.