137eb8894SGreg Roach<?php 23976b470SGreg Roach 337eb8894SGreg Roach/** 437eb8894SGreg Roach * webtrees: online genealogy 537eb8894SGreg Roach * Copyright (C) 2019 webtrees development team 637eb8894SGreg Roach * This program is free software: you can redistribute it and/or modify 737eb8894SGreg Roach * it under the terms of the GNU General Public License as published by 837eb8894SGreg Roach * the Free Software Foundation, either version 3 of the License, or 937eb8894SGreg Roach * (at your option) any later version. 1037eb8894SGreg Roach * This program is distributed in the hope that it will be useful, 1137eb8894SGreg Roach * but WITHOUT ANY WARRANTY; without even the implied warranty of 1237eb8894SGreg Roach * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1337eb8894SGreg Roach * GNU General Public License for more details. 1437eb8894SGreg Roach * You should have received a copy of the GNU General Public License 1537eb8894SGreg Roach * along with this program. If not, see <http://www.gnu.org/licenses/>. 1637eb8894SGreg Roach */ 17*fcfa147eSGreg Roach 1837eb8894SGreg Roachdeclare(strict_types=1); 1937eb8894SGreg Roach 2037eb8894SGreg Roachnamespace Fisharebest\Webtrees\Module; 2137eb8894SGreg Roach 2276fa3e53SGreg Roachuse Fisharebest\Webtrees\Auth; 2376fa3e53SGreg Roach 2437eb8894SGreg Roach/** 2537eb8894SGreg Roach * Class MatomoAnalyticsModule - add support for Matomo analytics. 2637eb8894SGreg Roach */ 27abafa13cSGreg Roachclass MatomoAnalyticsModule extends AbstractModule implements ModuleAnalyticsInterface, ModuleConfigInterface, ModuleExternalUrlInterface, ModuleGlobalInterface 2837eb8894SGreg Roach{ 2937eb8894SGreg Roach use ModuleAnalyticsTrait; 308e5c5efeSGreg Roach use ModuleConfigTrait; 318e5c5efeSGreg Roach use ModuleExternalUrlTrait; 32abafa13cSGreg Roach use ModuleGlobalTrait; 3337eb8894SGreg Roach 3437eb8894SGreg Roach /** 350cfd6963SGreg Roach * How should this module be identified in the control panel, etc.? 3637eb8894SGreg Roach * 3737eb8894SGreg Roach * @return string 3837eb8894SGreg Roach */ 3937eb8894SGreg Roach public function title(): string 4037eb8894SGreg Roach { 4137eb8894SGreg Roach return 'Matomo™ / Piwik™ analytics'; 4237eb8894SGreg Roach } 4337eb8894SGreg Roach 4437eb8894SGreg Roach /** 45abafa13cSGreg Roach * Should this module be enabled when it is first installed? 46abafa13cSGreg Roach * 47abafa13cSGreg Roach * @return bool 48abafa13cSGreg Roach */ 49abafa13cSGreg Roach public function isEnabledByDefault(): bool 50abafa13cSGreg Roach { 51abafa13cSGreg Roach return false; 52abafa13cSGreg Roach } 53abafa13cSGreg Roach 54abafa13cSGreg Roach /** 5537eb8894SGreg Roach * Form fields to edit the parameters. 5637eb8894SGreg Roach * 5737eb8894SGreg Roach * @return string 5837eb8894SGreg Roach */ 5937eb8894SGreg Roach public function analyticsFormFields(): string 6037eb8894SGreg Roach { 618e5c5efeSGreg Roach return view('modules/matomo-analytics/form', $this->analyticsParameters()); 6237eb8894SGreg Roach } 6337eb8894SGreg Roach 6437eb8894SGreg Roach /** 6537eb8894SGreg Roach * Home page for the service. 6637eb8894SGreg Roach * 6737eb8894SGreg Roach * @return string 6837eb8894SGreg Roach */ 698e5c5efeSGreg Roach public function externalUrl(): string 7037eb8894SGreg Roach { 7137eb8894SGreg Roach return 'https://matomo.org'; 7237eb8894SGreg Roach } 7337eb8894SGreg Roach 7437eb8894SGreg Roach /** 7537eb8894SGreg Roach * The parameters that need to be embedded in the snippet. 7637eb8894SGreg Roach * 7737eb8894SGreg Roach * @return string[] 7837eb8894SGreg Roach */ 7937eb8894SGreg Roach public function analyticsParameters(): array 8037eb8894SGreg Roach { 8137eb8894SGreg Roach return [ 8226420f84SGreg Roach 'MATOMO_SITE_ID' => $this->getPreference('MATOMO_SITE_ID'), 8326420f84SGreg Roach 'MATOMO_URL' => $this->getPreference('MATOMO_URL'), 8437eb8894SGreg Roach ]; 8537eb8894SGreg Roach } 8637eb8894SGreg Roach 8737eb8894SGreg Roach /** 8837eb8894SGreg Roach * Embed placeholders in the snippet. 8937eb8894SGreg Roach * 9037eb8894SGreg Roach * @param string[] $parameters 9137eb8894SGreg Roach * 9237eb8894SGreg Roach * @return string 9337eb8894SGreg Roach */ 9437eb8894SGreg Roach public function analyticsSnippet(array $parameters): string 9537eb8894SGreg Roach { 9676fa3e53SGreg Roach $parameters['user'] = Auth::user(); 9776fa3e53SGreg Roach 988e5c5efeSGreg Roach return view('modules/matomo-analytics/snippet', $parameters); 9937eb8894SGreg Roach } 100abafa13cSGreg Roach 101abafa13cSGreg Roach /** 102abafa13cSGreg Roach * Raw content, to be added at the end of the <head> element. 103abafa13cSGreg Roach * Typically, this will be <link> and <meta> elements. 104abafa13cSGreg Roach * 105abafa13cSGreg Roach * @return string 106abafa13cSGreg Roach */ 107abafa13cSGreg Roach public function headContent(): string 108abafa13cSGreg Roach { 109abafa13cSGreg Roach if ($this->analyticsCanShow()) { 110abafa13cSGreg Roach return $this->analyticsSnippet($this->analyticsParameters()); 111abafa13cSGreg Roach } 112abafa13cSGreg Roach 113abafa13cSGreg Roach return ''; 114abafa13cSGreg Roach } 11537eb8894SGreg Roach} 116