Piwik\DataTable\Filter\

PrependValueToMetadata

Executes a callback for each row of a DataTable and prepends the given value to each metadata entry but only if the given metadata entry exists.

Basic usage example

$dataTable->filter('PrependValueToMetadata', array('segment', 'segmentName==segmentValue'));

Methods

The class defines the following methods:

__construct()

Signature

  • It accepts the following parameter(s):

    • $table (DataTable) —

    • $metadataName (string) — The name of the metadata that should be prepended

    • $valueToPrepend (string) — The value to prepend if the metadata entry exists

filter()

See PrependValueToMetadata.

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.