. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\Auth; use Fisharebest\Webtrees\I18N; use Fisharebest\Webtrees\Registry; use Fisharebest\Webtrees\Tree; use Fisharebest\Webtrees\Validator; use Psr\Http\Message\ServerRequestInterface; use function view; /** * Class GoogleAnalyticsModule - add support for Google analytics. */ class GoogleAnalyticsModule 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 I18N::translate('Google™ 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/google-analytics/form', $this->analyticsParameters()); } /** * Home page for the service. * * @return string */ public function externalUrl(): string { return 'https://www.google.com/analytics'; } /** * The parameters that need to be embedded in the snippet. * * @return array */ public function analyticsParameters(): array { return [ 'GOOGLE_ANALYTICS_ID' => $this->getPreference('GOOGLE_ANALYTICS_ID'), ]; } /** * Embed placeholders in the snippet. * * @param array $parameters * * @return string */ public function analyticsSnippet(array $parameters): string { $request = Registry::container()->get(ServerRequestInterface::class); // Add extra dimensions (i.e. filtering categories) $tree = Validator::attributes($request)->treeOptional(); $user = Validator::attributes($request)->user(); if (str_starts_with($parameters['GOOGLE_ANALYTICS_ID'], 'UA-')) { $parameters['dimensions'] = (object) [ 'dimension1' => $tree instanceof Tree ? $tree->name() : '-', 'dimension2' => $tree instanceof Tree ? Auth::accessLevel($tree, $user) : '-', ]; return view('modules/google-analytics/snippet', $parameters); } $parameters['tree_name'] = $tree instanceof Tree ? $tree->name() : '-'; $parameters['access_level'] = $tree instanceof Tree ? Auth::accessLevel($tree, $user) : '-'; return view('modules/google-analytics/snippet-v4', $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 ''; } }