.
*/
declare(strict_types=1);
namespace Fisharebest\Webtrees\Module;
use Fisharebest\Webtrees\Auth;
/**
* Class MatomoAnalyticsModule - add support for Matomo analytics.
*/
class MatomoAnalyticsModule extends AbstractModule implements ModuleAnalyticsInterface, ModuleConfigInterface, ModuleExternalUrlInterface, ModuleGlobalInterface
{
use ModuleAnalyticsTrait;
use ModuleConfigTrait;
use ModuleExternalUrlTrait;
use ModuleGlobalTrait;
/**
* How should this module be identified in the control panel, etc.?
*
* @return string
*/
public function title(): string
{
return 'Matomo™ / Piwik™ analytics';
}
/**
* Should this module be enabled when it is first installed?
*
* @return bool
*/
public function isEnabledByDefault(): bool
{
return false;
}
/**
* Form fields to edit the parameters.
*
* @return string
*/
public function analyticsFormFields(): string
{
return view('modules/matomo-analytics/form', $this->analyticsParameters());
}
/**
* Home page for the service.
*
* @return string
*/
public function externalUrl(): string
{
return 'https://matomo.org';
}
/**
* The parameters that need to be embedded in the snippet.
*
* @return string[]
*/
public function analyticsParameters(): array
{
return [
'MATOMO_SITE_ID' => $this->getPreference('MATOMO_SITE_ID'),
'MATOMO_URL' => $this->getPreference('MATOMO_URL'),
];
}
/**
* Embed placeholders in the snippet.
*
* @param string[] $parameters
*
* @return string
*/
public function analyticsSnippet(array $parameters): string
{
$parameters['user'] = Auth::user();
return view('modules/matomo-analytics/snippet', $parameters);
}
/**
* Raw content, to be added at the end of the element.
* Typically, this will be and elements.
*
* @return string
*/
public function headContent(): string
{
if ($this->analyticsCanShow()) {
return $this->analyticsSnippet($this->analyticsParameters());
}
return '';
}
}