Piwik\DataTable\Filter\

AddSegmentBySegmentValue

Converts for each row of a DataTable a segmentValue to a segment (expression).

The name of the segment is automatically detected based on the given report.

Basic usage example

$dataTable->filter('AddSegmentBySegmentValue', array($reportInstance));

Methods

The class defines the following methods:

__construct()

Signature

  • It accepts the following parameter(s):

    • $table (DataTable) —

    • $report (Piwik\DataTable\Filter\$report) —

filter()

See AddSegmentBySegmentValue.

Signature

  • It accepts the following parameter(s):

  • Returns: int — The number of deleted rows.

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.