plugin-CustomVariablesExtended/CustomVariableDimension.php at 5.x · MichaelRoosz/plugin-CustomVariablesExtended · GitHub

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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link http://matomo.org
 * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 *
 */
namespace Piwik\Plugins\CustomVariablesExtended;

use Exception;
use Piwik\Piwik;
use Piwik\Columns\Dimension;
use Piwik\Columns\DimensionSegmentFactory;
use Piwik\Columns\Join;
use Piwik\Columns\Discriminator;
use Piwik\Plugins\CustomVariablesExtended\Columns\Join\CustomVariableLinkVisitActionJoin;
use Piwik\Plugins\CustomVariablesExtended\Columns\Join\CustomVariableVisitJoin;
use Piwik\Segment\SegmentsList;
use Piwik\Plugins\CustomVariablesExtended\Segment;
use Piwik\Plugins\CustomVariablesExtended\CustomVariablesExtended;

class CustomVariableDimension extends Dimension {
    /** @var string $type */
    protected $type = self::TYPE_TEXT;

    /** @var string $id */
    private $id = 'CustomVariablesExtended.CustomVariable';

    /** @var string $cvScope */
    private $cvScope;

    /** @var int $cvIndex */
    private $cvIndex;

    public function getId(): string {
        return $this->id;
    }

    public function getName(): string {
        return Piwik::translate('CustomVariablesExtended_ColumnCustomVariableValue');
    }

    public function initCustomDimension(string $scope, int $index): void {
        $this->cvScope = $scope;
        $this->cvIndex = $index;

        $category = $this->getScopeDescription();

        $this->id = 'CustomVariablesExtended.CustomVariable' . $this->getScopeName() . $index;
        $this->nameSingular = Piwik::translate('CustomVariablesExtended_ColumnCustomVariableValue') . ' ' . $index . ' (' . $category . ')';
        $this->category = 'CustomVariablesExtended_CustomVariables';
    }

    public function configureSegments(SegmentsList $segmentsList, DimensionSegmentFactory $dimensionSegmentFactory): void {
        if ($this->cvScope === CustomVariablesExtended::SCOPE_CONVERSION) {
            return;
        }

        $baseName = 'customVariable';
        if ($this->cvScope === CustomVariablesExtended::SCOPE_PAGE) {
            $baseName .= 'Page';
        }

        if ($this->cvScope === CustomVariablesExtended::SCOPE_VISIT) {
            $sqlSegment = 'log_visit.idvisit';
        } else {
            $sqlSegment = 'log_link_visit_action.idlink_va';
        }

        $segment = new Segment();
        $segment->setSegment($baseName . 'Name' . $this->cvIndex);
        $segment->setSqlSegment($sqlSegment);
        $segment->setName(Piwik::translate('CustomVariablesExtended_ColumnCustomVariableName') . ' ' . $this->cvIndex
                . ' (' . Piwik::translate('CustomVariablesExtended_Scope' . $this->getScopeName()) . ')');
        $segmentsList->addSegment($dimensionSegmentFactory->createSegment($segment));

        $segment = new Segment();
        $segment->setSegment($baseName . 'Value' . $this->cvIndex);
        $segment->setSqlSegment($sqlSegment);
        $segment->setName(Piwik::translate('CustomVariablesExtended_ColumnCustomVariableValue') . ' ' . $this->cvIndex
                . ' (' . Piwik::translate('CustomVariablesExtended_Scope' . $this->getScopeName()) . ')');
        $segmentsList->addSegment($dimensionSegmentFactory->createSegment($segment));
    }

    public function getDbColumnJoin(): Join {
        if ($this->cvScope === CustomVariablesExtended::SCOPE_VISIT) {
            return new CustomVariableVisitJoin();
        } elseif ($this->cvScope === CustomVariablesExtended::SCOPE_PAGE) {
            return new CustomVariableLinkVisitActionJoin();
        } else {
            throw new Exception('Unsupported scope for db column join: ' . $this->cvScope);
        }
    }

    public function getDbDiscriminator(): Discriminator {
        if ($this->cvScope === CustomVariablesExtended::SCOPE_VISIT) {
            return new Discriminator('log_custom_variable_visit', 'index', $this->cvIndex);
        } elseif ($this->cvScope === CustomVariablesExtended::SCOPE_PAGE) {
            return new Discriminator('log_custom_variable_link_va', 'index', $this->cvIndex);
        } else {
            throw new Exception('Unsupported scope for db discriminator: ' . $this->cvScope);
        }
    }

    private function getScopeName(): string {
        return ucfirst($this->cvScope);
    }

    private function getScopeDescription(): string {
        switch ($this->cvScope) {
            case CustomVariablesExtended::SCOPE_PAGE:
                return Piwik::translate('CustomVariablesExtended_ScopePage');
            case CustomVariablesExtended::SCOPE_VISIT:
                return Piwik::translate('CustomVariablesExtended_ScopeVisit');
            case CustomVariablesExtended::SCOPE_CONVERSION:
                return Piwik::translate('CustomVariablesExtended_ScopeConversion');
        }

        return ucfirst($this->cvScope);
    }
}