Piwik\DataTable\Filter\

Limit

Delete all rows from the table that are not in the given [offset, offset+limit) range.

Basic example usage

// delete all rows from 5 -> 15
$dataTable->filter('Limit', array(5, 10));

Properties

This class defines the following properties:

• $offset
• $limit
• $keepSummaryRow

$offset

Signature

• It is a int value.

$limit

Signature

• It is a int value.

$keepSummaryRow

Signature

• It is a bool value.

Methods

The class defines the following methods:

• __construct() — Constructor.
• filter() ash; See Limit.
• enableRecursive() ash; Enables/Disables recursive filtering. Inherited from BaseFilter
• filterSubTable() ash; Filters a row's subtable, if one exists and is loaded in memory. Inherited from BaseFilter

__construct()

Constructor.

Signature

• It accepts the following parameter(s):

  • $table (DataTable) —

  • $offset (int) — The starting row index to keep.

  • $limit (int) — Number of rows to keep (specify -1 to keep all rows).
  • $keepSummaryRow (bool) — Whether to keep the summary row or not.

filter()

See Limit.

Signature

• It accepts the following parameter(s):

  • $table (DataTable) —

• It does not return anything or a mixed result.

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 or a mixed result.

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 or a mixed result.