Piwik\DataTable\Filter\

ColumnCallbackDeleteRow

Deletes all rows for which a callback returns true.

Basic usage example

$labelsToRemove = array('label1', 'label2', 'label2');
$dataTable->filter('ColumnCallbackDeleteRow', array('label', function ($label) use ($labelsToRemove) {
    return in_array($label, $labelsToRemove);
}));

Methods

The class defines the following methods:

__construct()

Constructor.

Signature

  • It accepts the following parameter(s):
    • $table (DataTable) — The DataTable that will be filtered eventually.
    • $columnsToFilter (array|string) — The column or array of columns that should be passed to the callback.
    • $function (Piwik\DataTable\Filter\callback) — The callback that determines whether a row should be deleted or not. Should return true if the row should be deleted.
    • $functionParams (array) — deprecated - use an anonymous function instead.

filter()

Filters the given data table

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.