xref: /webtrees/app/Module/ModuleAnalyticsTrait.php (revision 0010d42b5dcc725e166945c3345a365d5aa115e3) 
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
20use Fisharebest\Webtrees\I18N;
21use Illuminate\Support\Collection;
22
23/**
24 * Trait ModuleAnalyticsTrait - default implementation of ModuleAnalyticsInterface
25 */
26trait ModuleAnalyticsTrait
27{
28    /**
29     * Should we add this tracker?
30     *
31     * @return bool
32     */
33    public function analyticsCanShow(): bool
34    {
35        foreach ($this->analyticsParameters() as $parameter) {
36            if ($parameter === '') {
37                return false;
38            }
39        }
40
41        return true;
42    }
43
44    /**
45     * A sentence describing what this module does.
46     *
47     * @return string
48     */
49    public function description(): string
50    {
51        return I18N::translate('Tracking and analytics');
52    }
53
54    /**
55     * Form fields to edit the parameters.
56     *
57     * @return string
58     */
59    public function analyticsFormFields(): string
60    {
61        return '';
62    }
63
64    /**
65     * Home page for the service.
66     *
67     * @return string
68     */
69    public function analyticsHomePageURL(): string
70    {
71        return '';
72    }
73
74    /**
75     * The parameters that need to be embedded in the snippet.
76     *
77     * @return string[]
78     */
79    public function analyticsParameters(): array
80    {
81        return [];
82    }
83
84    /**
85     * Embed placeholders in the snippet.
86     *
87     * @param string[] $parameters
88     *
89     * @return string
90     */
91    public function analyticsSnippet(array $parameters): string
92    {
93        return '';
94    }
95}
96