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