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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
|
<?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\Http\RequestHandlers\ModulesAnalyticsPage;
use Fisharebest\Webtrees\Http\ViewResponseTrait;
use Fisharebest\Webtrees\I18N;
use Fisharebest\Webtrees\Registry;
use Fisharebest\Webtrees\Validator;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
/**
* Trait ModuleAnalyticsTrait - default implementation of ModuleAnalyticsInterface
*/
trait ModuleAnalyticsTrait
{
use ViewResponseTrait;
/**
* A unique internal name for this module (based on the installation folder).
*
* @return string
*/
abstract public function name(): string;
abstract public function title(): string;
/**
* Set a module setting.
*
* Since module settings are NOT NULL, setting a value to NULL will cause
* it to be deleted.
*
* @param string $setting_name
* @param string $setting_value
*
* @return void
*/
abstract public function setPreference(string $setting_name, string $setting_value): void;
/**
* Should we add this tracker?
*
* @return bool
*/
public function analyticsCanShow(): bool
{
$request = Registry::container()->get(ServerRequestInterface::class);
// If the browser sets the DNT header, then we won't use analytics.
if (Validator::serverParams($request)->boolean('HTTP_DNT', false)) {
return false;
}
foreach ($this->analyticsParameters() as $parameter) {
if ($parameter === '') {
return false;
}
}
return true;
}
/**
* The parameters that need to be embedded in the snippet.
*
* @return array<string>
*/
public function analyticsParameters(): array
{
return [];
}
public function description(): string
{
return I18N::translate('Tracking and analytics');
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function getAdminAction(ServerRequestInterface $request): ResponseInterface
{
$this->layout = 'layouts/administration';
return $this->viewResponse('admin/analytics-edit', [
'action' => route('module', ['module' => $this->name(), 'action' => 'Admin']),
'form_fields' => $this->analyticsFormFields(),
'preview' => $this->analyticsSnippet($this->analyticsParameters()),
'title' => $this->title(),
]);
}
/**
* Form fields to edit the parameters.
*
* @return string
*/
public function analyticsFormFields(): string
{
return '';
}
/**
* Embed placeholders in the snippet.
*
* @param array<string> $parameters
*
* @return string
*/
public function analyticsSnippet(array $parameters): string
{
return '';
}
/**
* Is this a tracker, as opposed to just a site-verification.
*
* @return bool
*/
public function isTracker(): bool
{
return true;
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function postAdminAction(ServerRequestInterface $request): ResponseInterface
{
foreach (array_keys($this->analyticsParameters()) as $parameter) {
$new_value = Validator::parsedBody($request)->string($parameter);
$this->setPreference($parameter, $new_value);
}
return redirect(route(ModulesAnalyticsPage::class));
}
}
|
