137eb8894SGreg Roach<?php 237eb8894SGreg Roach/** 337eb8894SGreg Roach * webtrees: online genealogy 437eb8894SGreg Roach * Copyright (C) 2019 webtrees development team 537eb8894SGreg Roach * This program is free software: you can redistribute it and/or modify 637eb8894SGreg Roach * it under the terms of the GNU General Public License as published by 737eb8894SGreg Roach * the Free Software Foundation, either version 3 of the License, or 837eb8894SGreg Roach * (at your option) any later version. 937eb8894SGreg Roach * This program is distributed in the hope that it will be useful, 1037eb8894SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of 1137eb8894SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1237eb8894SGreg Roach * GNU General Public License for more details. 1337eb8894SGreg Roach * You should have received a copy of the GNU General Public License 1437eb8894SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>. 1537eb8894SGreg Roach */ 1637eb8894SGreg Roachdeclare(strict_types=1); 1737eb8894SGreg Roach 1837eb8894SGreg Roachnamespace Fisharebest\Webtrees\Module; 1937eb8894SGreg Roach 2037eb8894SGreg Roach/** 2137eb8894SGreg Roach * Class MatomoAnalyticsModule - add support for Matomo analytics. 2237eb8894SGreg Roach */ 23abafa13cSGreg Roachclass MatomoAnalyticsModule extends AbstractModule implements ModuleAnalyticsInterface, ModuleConfigInterface, ModuleExternalUrlInterface, ModuleGlobalInterface 2437eb8894SGreg Roach{ 2537eb8894SGreg Roach use ModuleAnalyticsTrait; 268e5c5efeSGreg Roach use ModuleConfigTrait; 278e5c5efeSGreg Roach use ModuleExternalUrlTrait; 28abafa13cSGreg Roach use ModuleGlobalTrait; 2937eb8894SGreg Roach 3037eb8894SGreg Roach /** 310cfd6963SGreg Roach * How should this module be identified in the control panel, etc.? 3237eb8894SGreg Roach * 3337eb8894SGreg Roach * @return string 3437eb8894SGreg Roach */ 3537eb8894SGreg Roach public function title(): string 3637eb8894SGreg Roach { 3737eb8894SGreg Roach return 'Matomo™ / Piwik™ analytics'; 3837eb8894SGreg Roach } 3937eb8894SGreg Roach 4037eb8894SGreg Roach /** 41abafa13cSGreg Roach * Should this module be enabled when it is first installed? 42abafa13cSGreg Roach * 43abafa13cSGreg Roach * @return bool 44abafa13cSGreg Roach */ 45abafa13cSGreg Roach public function isEnabledByDefault(): bool 46abafa13cSGreg Roach { 47abafa13cSGreg Roach return false; 48abafa13cSGreg Roach } 49abafa13cSGreg Roach 50abafa13cSGreg Roach /** 5137eb8894SGreg Roach * Form fields to edit the parameters. 5237eb8894SGreg Roach * 5337eb8894SGreg Roach * @return string 5437eb8894SGreg Roach */ 5537eb8894SGreg Roach public function analyticsFormFields(): string 5637eb8894SGreg Roach { 578e5c5efeSGreg Roach return view('modules/matomo-analytics/form', $this->analyticsParameters()); 5837eb8894SGreg Roach } 5937eb8894SGreg Roach 6037eb8894SGreg Roach /** 6137eb8894SGreg Roach * Home page for the service. 6237eb8894SGreg Roach * 6337eb8894SGreg Roach * @return string 6437eb8894SGreg Roach */ 658e5c5efeSGreg Roach public function externalUrl(): string 6637eb8894SGreg Roach { 6737eb8894SGreg Roach return 'https://matomo.org'; 6837eb8894SGreg Roach } 6937eb8894SGreg Roach 7037eb8894SGreg Roach /** 7137eb8894SGreg Roach * The parameters that need to be embedded in the snippet. 7237eb8894SGreg Roach * 7337eb8894SGreg Roach * @return string[] 7437eb8894SGreg Roach */ 7537eb8894SGreg Roach public function analyticsParameters(): array 7637eb8894SGreg Roach { 7737eb8894SGreg Roach return [ 78*26420f84SGreg Roach 'MATOMO_SITE_ID' => $this->getPreference('MATOMO_SITE_ID'), 79*26420f84SGreg Roach 'MATOMO_URL' => $this->getPreference('MATOMO_URL'), 8037eb8894SGreg Roach ]; 8137eb8894SGreg Roach } 8237eb8894SGreg Roach 8337eb8894SGreg Roach /** 8437eb8894SGreg Roach * Embed placeholders in the snippet. 8537eb8894SGreg Roach * 8637eb8894SGreg Roach * @param string[] $parameters 8737eb8894SGreg Roach * 8837eb8894SGreg Roach * @return string 8937eb8894SGreg Roach */ 9037eb8894SGreg Roach public function analyticsSnippet(array $parameters): string 9137eb8894SGreg Roach { 928e5c5efeSGreg Roach return view('modules/matomo-analytics/snippet', $parameters); 9337eb8894SGreg Roach } 94abafa13cSGreg Roach 95abafa13cSGreg Roach /** 96abafa13cSGreg Roach * Raw content, to be added at the end of the <head> element. 97abafa13cSGreg Roach * Typically, this will be <link> and <meta> elements. 98abafa13cSGreg Roach * 99abafa13cSGreg Roach * @return string 100abafa13cSGreg Roach */ 101abafa13cSGreg Roach public function headContent(): string 102abafa13cSGreg Roach { 103abafa13cSGreg Roach if ($this->analyticsCanShow()) { 104abafa13cSGreg Roach return $this->analyticsSnippet($this->analyticsParameters()); 105abafa13cSGreg Roach } 106abafa13cSGreg Roach 107abafa13cSGreg Roach return ''; 108abafa13cSGreg Roach } 10937eb8894SGreg Roach} 110