diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-12-08 22:12:48 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-12-08 22:13:07 +0400 |
commit | 13297a804c38999aa790af93f1d599e3c809dc7d (patch) | |
tree | cdf7cb0b4df018853852a1af675041cd23944293 /core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php | |
parent | 54bb5200d2567e51ff5a77dcd4dfa89195c169d9 (diff) |
Fixes #4200, revised rest of @api classes/methods, closing ticket.
Diffstat (limited to 'core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php')
-rw-r--r-- | core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php b/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php index a36f7de04b..47d3825cb5 100644 --- a/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php +++ b/core/DataTable/Filter/ColumnCallbackAddColumnQuotient.php @@ -21,6 +21,10 @@ use Piwik\DataTable\Row; * This filter is used to calculate rate values (eg, `'bounce_rate'`), averages * (eg, `'avg_time_on_page'`) and other types of values. * + * **Basic usage example** + * + * $dataTable->queueFilter('ColumnCallbackAddColumnQuotient', array('bounce_rate', 'bounce_count', 'nb_visits', $precision = 2)); + * * @package Piwik * @subpackage DataTable * @api @@ -51,7 +55,8 @@ class ColumnCallbackAddColumnQuotient extends Filter * @param bool $getDivisorFromSummaryRow Whether to get the divisor from the summary row or the current * row iteration. */ - public function __construct($table, $columnNameToAdd, $columnValueToRead, $divisorValueOrDivisorColumnName, $quotientPrecision = 0, $shouldSkipRows = false, $getDivisorFromSummaryRow = false) + public function __construct($table, $columnNameToAdd, $columnValueToRead, $divisorValueOrDivisorColumnName, + $quotientPrecision = 0,$shouldSkipRows = false, $getDivisorFromSummaryRow = false) { parent::__construct($table); $this->table = $table; |