xref: /webtrees/app/Module/ModuleAnalyticsInterface.php (revision b13a72db028c9d47e5a3437c318773ad07d13be0) 
1<?php
2
3/**
4 * webtrees: online genealogy
5 * Copyright (C) 2022 webtrees development team
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
16 */
17
18declare(strict_types=1);
19
20namespace Fisharebest\Webtrees\Module;
21
22use Psr\Http\Message\ResponseInterface;
23use Psr\Http\Message\ServerRequestInterface;
24
25/**
26 * Interface ModuleAnalyticsInterface - Classes and libraries for module system
27 */
28interface ModuleAnalyticsInterface extends ModuleInterface
29{
30    /**
31     * Should we add this tracker?
32     *
33     * @return bool
34     */
35    public function analyticsCanShow(): bool;
36
37    /**
38     * Form fields to edit the parameters.
39     *
40     * @return string
41     */
42    public function analyticsFormFields(): string;
43
44    /**
45     * The parameters that need to be embedded in the snippet.
46     *
47     * @return array<string>
48     */
49    public function analyticsParameters(): array;
50
51    /**
52     * Embed placeholders in the snippet.
53     *
54     * @param array<string> $parameters
55     *
56     * @return string
57     */
58    public function analyticsSnippet(array $parameters): string;
59
60    /**
61     * Is this a tracker, as opposed to just a site-verification.
62     *
63     * @return bool
64     */
65    public function isTracker(): bool;
66
67    /**
68     * @param ServerRequestInterface $request
69     *
70     * @return ResponseInterface
71     */
72    public function getAdminAction(ServerRequestInterface $request): ResponseInterface;
73
74    /**
75     * @param ServerRequestInterface $request
76     *
77     * @return ResponseInterface
78     */
79    public function postAdminAction(ServerRequestInterface $request): ResponseInterface;
80}
81