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
123
124
125
126
127
|
<?php
/**
* webtrees: online genealogy
* Copyright (C) 2026 webtrees development team
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Tree;
use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ServerRequestInterface;
use function view;
/**
* Class GoogleAnalyticsModule - add support for Google analytics.
*/
class GoogleAnalyticsModule extends AbstractModule implements ModuleAnalyticsInterface, ModuleConfigInterface, ModuleExternalUrlInterface, ModuleGlobalInterface
{
use ModuleAnalyticsTrait;
use ModuleConfigTrait;
use ModuleExternalUrlTrait;
use ModuleGlobalTrait;
public function title(): string
{
return I18N::translate('Google™ analytics');
}
public function isEnabledByDefault(): bool
{
return false;
}
/**
* Form fields to edit the parameters.
*
* @return string
*/
public function analyticsFormFields(): string
{
return view('modules/google-analytics/form', $this->analyticsParameters());
}
/**
* Home page for the service.
*
* @return string
*/
public function externalUrl(): string
{
return 'https://www.google.com/analytics';
}
/**
* The parameters that need to be embedded in the snippet.
*
* @return array<string>
*/
public function analyticsParameters(): array
{
return [
'GOOGLE_ANALYTICS_ID' => $this->getPreference('GOOGLE_ANALYTICS_ID'),
];
}
/**
* Embed placeholders in the snippet.
*
* @param array<string> $parameters
*
* @return string
*/
public function analyticsSnippet(array $parameters): string
{
$request = Registry::container()->get(ServerRequestInterface::class);
// Add extra dimensions (i.e. filtering categories)
$tree = Validator::attributes($request)->treeOptional();
$user = Validator::attributes($request)->user();
if (str_starts_with($parameters['GOOGLE_ANALYTICS_ID'], 'UA-')) {
$parameters['dimensions'] = (object) [
'dimension1' => $tree instanceof Tree ? $tree->name() : '-',
'dimension2' => $tree instanceof Tree ? Auth::accessLevel($tree, $user) : '-',
];
return view('modules/google-analytics/snippet', $parameters);
}
$parameters['tree_name'] = $tree instanceof Tree ? $tree->name() : '-';
$parameters['access_level'] = $tree instanceof Tree ? Auth::accessLevel($tree, $user) : '-';
return view('modules/google-analytics/snippet-v4', $parameters);
}
/**
* Raw content, to be added at the end of the <head> element.
* Typically, this will be <link> and <meta> elements.
*
* @return string
*/
public function headContent(): string
{
if ($this->analyticsCanShow()) {
return $this->analyticsSnippet($this->analyticsParameters());
}
return '';
}
}
|
