wn-matomo-plugin/Plugin.php at main · wintercms/wn-matomo-plugin · 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
<?php namespace Winter\Matomo;

use Config;
use System\Classes\PluginBase;
use Winter\Matomo\Classes\ReportingAPI;

/**
 * Matomo Plugin Information File
 */
class Plugin extends PluginBase
{
    /**
     * Returns information about this plugin.
     *
     * @return array
     */
    public function pluginDetails()
    {
        return [
            'name'        => 'winter.matomo::lang.plugin.name',
            'description' => 'winter.matomo::lang.plugin.description',
            'author'      => 'Winter CMS',
            'icon'        => 'icon-area-chart'
        ];
    }

    public function boot()
    {
        $this->app->scoped(ReportingAPI::class, function () {
            $api = new ReportingAPI(
                Config::get('winter.matomo::server'),
                Config::get('winter.matomo::auth_token'),
                Config::get('winter.matomo::site_id')
            );
            $api->setCacheTtl(Config::get('winter.matomo::reportingapi_cache_ttl'));
            return $api;
        });
    }

    /**
     * Registers any frontend components implemented in this plugin.
     */
    public function registerComponents(): array
    {
        return [
            \Winter\Matomo\Components\Tracker::class => 'matomoTracker',
        ];
    }

    /**
     * Registers any backend permissions used by this plugin.
     */
    public function registerPermissions(): array
    {
        return [
            'winter.matomo.site.view' => [
                'tab' => 'winter.matomo::lang.plugin.name',
                'label' => 'winter.matomo::lang.permissions.site.view',
            ],
        ];
    }

    /**
     * Registers ReportWidgets provided by this plugin
     */
    public function registerReportWidgets(): array
    {
        return [
            \Winter\Matomo\ReportWidgets\EmbeddedDashboard::class => [
                'label' => 'winter.matomo::lang.reportwidgets.embedded_dashboard.title_default',
                'context' => 'dashboard',
                'permissions' => [
                    'winter.matomo.site.view',
                ],
            ],
            \Winter\Matomo\ReportWidgets\EmbeddedWidget::class => [
                'label' => 'winter.matomo::lang.reportwidgets.embedded_widget.label',
                'context' => 'dashboard',
                'permissions' => [
                    'winter.matomo.site.view',
                ],
            ],
        ];
    }
}