diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-22 14:07:30 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-22 14:07:30 +0400 |
commit | 28d107b0d05f607a2ac9038cd0b52d8d223f098b (patch) | |
tree | 11727b009f6de233817edf254bed9e6e02e07702 /core/DataTable/Filter/Limit.php | |
parent | fe631813a815510a5a9a96a476deaab9444cb614 (diff) |
Refs #4200, removed Null filter and documented many more filters.
Diffstat (limited to 'core/DataTable/Filter/Limit.php')
-rw-r--r-- | core/DataTable/Filter/Limit.php | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/core/DataTable/Filter/Limit.php b/core/DataTable/Filter/Limit.php index d54edd472d..dc5b5d02db 100644 --- a/core/DataTable/Filter/Limit.php +++ b/core/DataTable/Filter/Limit.php @@ -14,19 +14,25 @@ use Piwik\DataTable; use Piwik\DataTable\Filter; /** - * Delete all rows from the table that are not in the offset,offset+limit range + * 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)); * * @package Piwik * @subpackage DataTable + * @api */ class Limit extends Filter { /** - * Filter constructor. + * Constructor. * - * @param DataTable $table - * @param int $offset Starting row (indexed from 0) - * @param int $limit Number of rows to keep (specify -1 to keep all rows) + * @param DataTable $table The DataTable that will be filtered eventually. + * @param int $offset The starting row index to keep. + * @param int $limit Number of rows to keep (specify -1 to keep all rows). * @param bool $keepSummaryRow Whether to keep the summary row or not. */ public function __construct($table, $offset, $limit = -1, $keepSummaryRow = false) @@ -39,7 +45,7 @@ class Limit extends Filter } /** - * Limits the given data table + * See [Limit](#). * * @param DataTable $table */ @@ -64,4 +70,4 @@ class Limit extends Filter $table->addSummaryRow($summaryRow); } } -} +}
\ No newline at end of file |