1<?php 2 3/** 4 * webtrees: online genealogy 5 * Copyright (C) 2019 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 <http://www.gnu.org/licenses/>. 16 */ 17declare(strict_types=1); 18 19namespace Fisharebest\Webtrees\Module; 20 21use Psr\Http\Message\ResponseInterface; 22use Psr\Http\Message\ServerRequestInterface; 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 * @param ServerRequestInterface $request 61 * 62 * @return ResponseInterface 63 */ 64 public function getAdminAction(ServerRequestInterface $request): ResponseInterface; 65 66 /** 67 * @param ServerRequestInterface $request 68 * 69 * @return ResponseInterface 70 */ 71 public function postAdminAction(ServerRequestInterface $request): ResponseInterface; 72} 73