File: CustomActionDimension.php

package info (click to toggle)
matomo 5.5.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 73,596 kB
  • sloc: php: 231,041; javascript: 102,286; python: 202; xml: 189; sh: 172; makefile: 20; sql: 10
file content (46 lines) | stat: -rw-r--r-- 1,338 bytes parent folder | download | duplicates (2)
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
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\CustomDimensions\Dimension;

use Piwik\Plugin\Dimension\ActionDimension;
use Piwik\Plugins\CustomDimensions\Tracker\CustomDimensionsRequestProcessor;

/**
 * We do not put this one in columns directory of the plugin since we do not want to have it automatically detected.
 * We create instances of it dynamically when needed instead.
 */
class CustomActionDimension extends ActionDimension
{
    protected $idDimension = null;
    protected $actualName = null;

    public function __construct($column, $name, $idDimension)
    {
        $this->columnName = $column;
        $this->actualName = $name;
        $this->nameSingular = $name;
        $this->idDimension = $idDimension;
        $this->segmentName = CustomDimensionsRequestProcessor::buildCustomDimensionTrackingApiName($idDimension);
    }

    /**
     * The name of the dimension which will be visible for instance in the UI of a related report and in the mobile app.
     * @return string
     */
    public function getName()
    {
        return $this->actualName;
    }

    public function getId()
    {
        return 'CustomDimension.CustomDimension' . $this->idDimension;
    }
}