Piwik\DataTable\Filter\

ColumnCallbackDeleteMetadata

Executes a callback for each row of a DataTable and removes the defined metadata column from each row.

Basic usage example

$dataTable->filter('ColumnCallbackDeleteMetadata', array('segmentValue'));

Methods

The class defines the following methods:

__construct()

Constructor.

Signature

  • It accepts the following parameter(s):
    • $table (DataTable) — The DataTable instance that will be filtered.
    • $metadataToRemove (string) — The name of the metadata field that will be removed from each row.

filter()

See ColumnCallbackDeleteMetadata.

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.