plugins/Insights/DataTable/Filter/ExcludeLowValue.php


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

<?php
/**
 * Piwik - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */
namespace Piwik\Plugins\Insights\DataTable\Filter;

use Piwik\DataTable;

/**
 * Removes all rows whose value is too low.
 */
class ExcludeLowValue extends DataTable\BaseFilter
{
    private $minimumValue;
    private $columnToRead;
    private $columnToCheckToBeTrue;

    /**
     * @param DataTable $table
     * @param string $columnToRead
     * @param int    $minimumValue
     * @param string $columnToCheckToBeTrue  if set, we will delete a row only if this column evaluates to true. If
     *                                       column does not evaluate to true we will not delete the row even if
     *                                       the value is lower than the minimumValue.
     */
    public function __construct($table, $columnToRead, $minimumValue, $columnToCheckToBeTrue = '')
    {
        $this->columnToRead = $columnToRead;
        $this->minimumValue = $minimumValue;
        $this->columnToCheckToBeTrue = $columnToCheckToBeTrue;
    }

    public function filter($table)
    {
        if (!$this->minimumValue) {
            return;
        }

        foreach ($table->getRows() as $key => $row) {

            if ($this->columnToCheckToBeTrue && !$row->getColumn($this->columnToCheckToBeTrue)) {
                continue;
            }

            $value = $row->getColumn($this->columnToRead);

            if ($this->minimumValue > abs($value)) {
                $table->deleteRow($key);
            }
        }
    }
}