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