xref: /webtrees/app/Module/StatcounterModule.php (revision ad7270802ba57a28d195fc58fcc55f26458a779a) 
1<?php
2/**
3 * webtrees: online genealogy
4 * Copyright (C) 2019 webtrees development team
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16declare(strict_types=1);
17
18namespace Fisharebest\Webtrees\Module;
19
20/**
21 * Class StatcounterModule - add support for statcounter.
22 */
23class StatcounterModule extends AbstractModule implements ModuleAnalyticsInterface, ModuleConfigInterface, ModuleExternalUrlInterface
24{
25    use ModuleAnalyticsTrait;
26    use ModuleConfigTrait;
27    use ModuleExternalUrlTrait;
28
29    /**
30     * How should this module be labelled on tabs, menus, etc.?
31     *
32     * @return string
33     */
34    public function title(): string
35    {
36        return 'Statcounter™';
37    }
38
39    /**
40     * Form fields to edit the parameters.
41     *
42     * @return string
43     */
44    public function analyticsFormFields(): string
45    {
46        return view('modules/statcounter/form', $this->analyticsParameters());
47    }
48
49    /**
50     * Home page for the service.
51     *
52     * @return string
53     */
54    public function externalUrl(): string
55    {
56        return 'https://statcounter.com';
57    }
58
59    /**
60     * The parameters that need to be embedded in the snippet.
61     *
62     * @return string[]
63     */
64    public function analyticsParameters(): array
65    {
66        return [
67            'STATCOUNTER_PROJECT_ID' => $this->getPreference('STATCOUNTER_PROJECT_ID'),
68            'STATCOUNTER_SECURITY_ID' => $this->getPreference('STATCOUNTER_SECURITY_ID'),
69        ];
70    }
71
72    /**
73     * Embed placeholders in the snippet.
74     *
75     * @param string[] $parameters
76     *
77     * @return string
78     */
79    public function analyticsSnippet(array $parameters): string
80    {
81        return view('modules/statcounter/snippet', $parameters);
82    }
83}
84