. */ declare(strict_types=1); namespace Fisharebest\Webtrees\Module; use Fisharebest\Webtrees\I18N; /** * Class GoogleWebmasterToolsModule - add support for Google webmaster tools. */ class GoogleWebmasterToolsModule 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™ webmaster tools'); } /** * Should this module be enabled when it is first installed? * * @return bool */ public function isEnabledByDefault(): bool { return false; } /** * Is this a tracker, as opposed to just a site-verification. * * @return bool */ public function isTracker(): bool { return false; } /** * Form fields to edit the parameters. * * @return string */ public function analyticsFormFields(): string { return view('modules/google-webmaster-tools/form', $this->analyticsParameters()); } /** * Home page for the service. * * @return string */ public function externalUrl(): string { return 'https://www.google.com/webmasters'; } /** * The parameters that need to be embedded in the snippet. * * @return array */ public function analyticsParameters(): array { return [ 'GOOGLE_WEBMASTER_ID' => $this->getPreference('GOOGLE_WEBMASTER_ID') ]; } /** * Embed placeholders in the snippet. * * @param array $parameters * * @return string */ public function analyticsSnippet(array $parameters): string { return view('modules/google-webmaster-tools/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 ''; } }