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 Symfony\Component\HttpFoundation\RedirectResponse; 21use Symfony\Component\HttpFoundation\Request; 22use Symfony\Component\HttpFoundation\Response; 23 24/** 25 * Interface ModuleAnalyticsInterface - Classes and libraries for module system 26 */ 27interface ModuleAnalyticsInterface extends ModuleInterface 28{ 29 /** 30 * Should we add this tracker? 31 * 32 * @return bool 33 */ 34 public function analyticsCanShow(): bool; 35 36 /** 37 * Form fields to edit the parameters. 38 * 39 * @return string 40 */ 41 public function analyticsFormFields(): string; 42 43 /** 44 * The parameters that need to be embedded in the snippet. 45 * 46 * @return string[] 47 */ 48 public function analyticsParameters(): array; 49 50 /** 51 * Embed placeholders in the snippet. 52 * 53 * @param string[] $parameters 54 * 55 * @return string 56 */ 57 public function analyticsSnippet(array $parameters): string; 58 59 /** 60 * @return Response 61 */ 62 public function getAdminAction(): Response; 63 64 /** 65 * @param Request $request 66 * 67 * @return RedirectResponse 68 */ 69 public function postAdminAction(Request $request): RedirectResponse; 70} 71