Piwik\DataTable\Filter\

AddSegmentByLabel

Executes a filter for each row of a DataTable and generates a segment filter for each row.

Basic usage example

$dataTable->filter('AddSegmentByLabel', array('segmentName'));
$dataTable->filter('AddSegmentByLabel', array(array('segmentName1', 'segment2'), ';');

Methods

The class defines the following methods:

__construct()

Generates a segment filter based on the label column and the given segment names

Signature

  • It accepts the following parameter(s):

    • $table (DataTable) —

    • $segmentOrSegments (string|array) — Either one segment or an array of segments. If more than one segment is given a delimter has to be defined.

    • $delimiter (string) — The delimiter by which the label should be splitted.

filter()

See AddSegmentByLabel.

Signature

  • It accepts the following parameter(s):

  • It does not return anything.

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.

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.