Merge pull request #1 from azlydnev/azlydnev-yandex-metrica

Azlydnev yandex metrica
azlydnev · Oct 15, 2023 · 444e439 · 444e439
2 parents d2a58c8 + 4578149
commit 444e439
Show file tree

Hide file tree

Showing 5 changed files with 205 additions and 0 deletions.
diff --git a/app/Module/YandexMetrica.php b/app/Module/YandexMetrica.php
@@ -0,0 +1,122 @@
+<?php
+
+/**
+ * webtrees: online genealogy
+ * Copyright (C) 2023 webtrees development team
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace Fisharebest\Webtrees\Module;
+
+use Fisharebest\Webtrees\I18N;
+
+/**
+ * Class YandexMetrica - add support for Yandex Metrica.
+ */
+class YandexMetrica 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('Yandex Metrica');
+    }
+
+    /**
+     * 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/yandex-metrica/form', $this->analyticsParameters());
+    }
+
+    /**
+     * Home page for the service.
+     *
+     * @return string
+     */
+    public function externalUrl(): string
+    {
+        return 'https://metrika.yandex.ru';
+    }
+
+    /**
+     * The parameters that need to be embedded in the snippet.
+     *
+     * @return array<string>
+     */
+    public function analyticsParameters(): array
+    {
+        return [
+            'YANDEX_METRICA_ID' => $this->getPreference('YANDEX_METRICA_ID')
+        ];
+    }
+
+    /**
+     * Embed placeholders in the snippet.
+     *
+     * @param array<string> $parameters
+     *
+     * @return string
+     */
+    public function analyticsSnippet(array $parameters): string
+    {
+        return view('modules/yandex-metrica/snippet', $parameters);
+    }
+
+    /**
+     * Raw content, to be added at the end of the <head> element.
+     * Typically, this will be <link> and <meta> elements.
+     *
+     * @return string
+     */
+    public function headContent(): string
+    {
+        if ($this->analyticsCanShow()) {
+            return $this->analyticsSnippet($this->analyticsParameters());
+        }
+
+        return '';
+    }
+}
diff --git a/app/Services/ModuleService.php b/app/Services/ModuleService.php
@@ -255,6 +255,7 @@
 use Fisharebest\Webtrees\Module\WelcomeBlockModule;
 use Fisharebest\Webtrees\Module\XeneaTheme;
 use Fisharebest\Webtrees\Module\YahrzeitModule;
+use Fisharebest\Webtrees\Module\YandexMetrica;
 use Fisharebest\Webtrees\Registry;
 use Fisharebest\Webtrees\Tree;
 use Fisharebest\Webtrees\Webtrees;
@@ -380,6 +381,7 @@ class ModuleService
         'google-analytics'        => GoogleAnalyticsModule::class,
         'google-maps'             => GoogleMaps::class,
         'google-webmaster-tools'  => GoogleWebmasterToolsModule::class,
+        'yandex-metrica'          => YandexMetrica::class,
         'here-maps'               => HereMaps::class,
         'hit-counter'             => HitCountFooterModule::class,
         'hourglass_chart'         => HourglassChartModule::class,

diff --git a/resources/views/modules/yandex-metrica/form.phtml b/resources/views/modules/yandex-metrica/form.phtml
@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+use Fisharebest\Webtrees\I18N;
+
+?>
+
+<div class="row mb-3">
+    <label for="YANDEX_METRICA_ID" class="col-sm-3 col-form-label">
+        <?= /* I18N: A configuration setting */ I18N::translate('Yandex Metica') ?>
+        <span class="visually-hidden">Yandex Metrica</span>
+    </label>
+    <div class="col-sm-9">
+        <input type="text" class="form-control" id="YANDEX_METRICA_ID" name="YANDEX_METRICA_ID" value="<?= e($YANDEX_METRICA_ID ?? '') ?>" maxlength="255" pattern="[0-9]+">
+    </div>
+</div>
+
+<p>
+    <?= I18N::translate('Yandex Metrica') ?>
+</p>
diff --git a/resources/views/modules/yandex-metrica/snippet.phtml b/resources/views/modules/yandex-metrica/snippet.phtml
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @var string $YANDEX_METICA_ID,
+ */
+?>
+<!-- Yandex.Metrika counter -->
+<script type="text/javascript" >
+   (function(m,e,t,r,i,k,a){m[i]=m[i]||function(){(m[i].a=m[i].a||[]).push(arguments)};
+   m[i].l=1*new Date();
+   for (var j = 0; j < document.scripts.length; j++) {if (document.scripts[j].src === r) { return; }}
+   k=e.createElement(t),a=e.getElementsByTagName(t)[0],k.async=1,k.src=r,a.parentNode.insertBefore(k,a)})
+   (window, document, "script", "https://mc.yandex.ru/metrika/tag.js", "ym");
+
+   ym(<?= json_encode((int) ($YANDEX_METRICA_ID ?? ''), JSON_THROW_ON_ERROR) ?> , "init", {
+        clickmap:true,
+        trackLinks:true,
+        accurateTrackBounce:true,
+        webvisor:true
+   });
+</script>
+<noscript><div><img src="https://mc.yandex.ru/watch/<?= e($YANDEX_METRICA_ID ?? '') ?>" style="position:absolute; left:-9999px;" alt="" /></div></noscript>
+<!-- /Yandex.Metrika counter -->
diff --git a/tests/app/Module/YandexMetricaTest.php b/tests/app/Module/YandexMetricaTest.php
@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * webtrees: online genealogy
+ * Copyright (C) 2023 webtrees development team
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+declare(strict_types=1);
+
+namespace Fisharebest\Webtrees\Module;
+
+use Fisharebest\Webtrees\TestCase;
+
+/**
+ * Test harness for the class YandexMetrica
+ *
+ * @covers Fisharebest\Webtrees\Module\YandexMetrica
+ */
+class YandexMetricaTest extends TestCase
+{
+    public function testClass(): void
+    {
+        $this->assertTrue(class_exists(\Fisharebest\Webtrees\Module\YandexMetrica::class));
+    }
+}