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