Piwik\DataTable\Filter\

PatternRecursive

Deletes rows that do not contain a column that matches a regex pattern and do not contain a subtable that contains a column that matches a regex pattern.

Example

// only display index pageviews in Actions.getPageUrls
$dataTable->filter('PatternRecursive', array('label', 'index'));

Methods

The class defines the following methods:

__construct()

Constructor.

Signature

  • It accepts the following parameter(s):
    • $table (DataTable) — The table to eventually filter.
    • $columnToFilter (string) — The column to match with the $patternToSearch pattern.
    • $patternToSearch (string) — The regex pattern to use.

filter()

See PatternRecursive.

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.