plugins/Goals/DataTable/Filter/AppendNameToColumnNames.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
57

<?php
/**
 * Matomo - 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\Goals\DataTable\Filter;

use Piwik\DataTable\BaseFilter;
use Piwik\DataTable;
use Piwik\Metrics;

/**
 * Appends a string to each column name in each row of a table. Please note this filter even appends the name to a
 * 'label' column. If you do not need this behaviour feel free to add a check to ignore label columns.
 */
class AppendNameToColumnNames extends BaseFilter
{
    protected $nameToAppend;

    /**
     * Constructor.
     *
     * @param DataTable $table     The table that will be eventually filtered.
     * @param string $nameToAppend The name that will be appended to each column
     */
    public function __construct($table, $nameToAppend)
    {
        parent::__construct($table);
        $this->nameToAppend = $nameToAppend;
    }

    /**
     * See {@link ReplaceColumnNames}.
     *
     * @param DataTable $table
     */
    public function filter($table)
    {
        if (!isset($this->nameToAppend) || '' === $this->nameToAppend || false === $this->nameToAppend) {
            return;
        }

        foreach ($table->getRows() as $row) {
            $columns = $row->getColumns();

            foreach ($columns as $column => $value) {
                $row->deleteColumn($column);
                $row->setColumn($column . $this->nameToAppend, $value);
            }

            $this->filterSubTable($row);
        }
    }
}