display matomo metrics field (#4497)

alchemy-fr · Apr 18, 2024 · 14ed50a · 14ed50a
1 parent 7763be1
commit 14ed50a
Show file tree

Hide file tree

Showing 10 changed files with 616 additions and 249 deletions.
diff --git a/lib/Alchemy/Phrasea/Core/Provider/TwigServiceProvider.php b/lib/Alchemy/Phrasea/Core/Provider/TwigServiceProvider.php
@@ -22,6 +22,8 @@
 class TwigServiceProvider implements ServiceProviderInterface
 {
 
+    private $metricTrans;
+
     /**
      * Registers services on the given app.
      *
@@ -61,7 +63,27 @@ public function register(Application $app)
 
             $twig->addGlobal('current_date', new \DateTime());
 
+            $this->metricTrans = [
+                'nb_plays'                      => $app['translator']->trans('matomomediametrics:: nb_plays'),
+                'nb_unique_visitors_plays'      => $app['translator']->trans('matomomediametrics:: nb_unique_visitors_plays'),
+                'nb_impressions'                => $app['translator']->trans('matomomediametrics:: nb_impressions'),
+                'nb_unique_visitors_impressions'=> $app['translator']->trans('matomomediametrics:: nb_unique_visitors_impressions'),
+                'nb_finishes'                   => $app['translator']->trans('matomomediametrics:: nb_finishes'),
+                'sum_time_progress'             => $app['translator']->trans('matomomediametrics:: sum_time_progress'),
+                'nb_plays_with_tip'             => $app['translator']->trans('matomomediametrics:: nb_plays_with_tip'),
+                'nb_plays_with_ml'              => $app['translator']->trans('matomomediametrics:: nb_plays_with_ml'),
+                'sum_fullscreen_plays'          => $app['translator']->trans('matomomediametrics:: sum_fullscreen_plays'),
+                'play_rate'                     => $app['translator']->trans('matomomediametrics:: play_rate'),
+                'finish_rate'                   => $app['translator']->trans('matomomediametrics:: finish_rate'),
+                'fullscreen_rate'               => $app['translator']->trans('matomomediametrics:: fullscreen_rate'),
+                'avg_time_watched'              => $app['translator']->trans('matomomediametrics:: avg_time_watched'),
+                'avg_completion_rate'           => $app['translator']->trans('matomomediametrics:: avg_completion_rate'),
+                'avg_time_to_play'              => $app['translator']->trans('matomomediametrics:: avg_time_to_play'),
+                'avg_media_length'              => $app['translator']->trans('matomomediametrics:: avg_media_length'),
+            ];
+
             $this->registerExtensions($twig, $app);
+
             $this->registerFilters($twig, $app);
 
             return $twig;
@@ -144,6 +166,25 @@ private function registerFilters(\Twig_Environment $twig, Application $app)
             return implode('; ', $stringArr);
         }, ['needs_environment' => true, 'is_safe' => ['html']]));
 
+        $twig->addFilter(new \Twig_SimpleFilter('mediaMetricsInfo', function (\Twig_Environment $twig, $string) use ($app) {
+            $metricInfo = $string;
+
+            if (!empty($string)) {
+                $metricsInfos = json_decode(html_entity_decode(trim($string)), true);
+                if ($metricsInfos != null) {
+                    $metricInfo = [];
+                    foreach ($metricsInfos as $key => $value) {
+                        if (isset($this->metricTrans[trim($key)])) {
+                            $metricInfo[] = '<i>' .$this->metricTrans[trim($key)] . ' </i>: ' . $value;
+                        }
+                    }
+                    $metricInfo = implode('<br>', $metricInfo);
+                }
+            }
+
+            return $metricInfo;
+        }, ['needs_environment' => true, 'is_safe' => ['html']]));
+
         $twig->addFilter(new \Twig_SimpleFilter('bounce',
             function (\Twig_Environment $twig, $fieldValue, $fieldName, $searchRequest, $sbasId) {
                 // bounce value if it is present in thesaurus as well

diff --git a/resources/locales/messages.de.xlf b/resources/locales/messages.de.xlf
diff --git a/resources/locales/messages.en.xlf b/resources/locales/messages.en.xlf
diff --git a/resources/locales/messages.fr.xlf b/resources/locales/messages.fr.xlf
diff --git a/resources/locales/messages.nl.xlf b/resources/locales/messages.nl.xlf
diff --git a/resources/locales/validators.de.xlf b/resources/locales/validators.de.xlf
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:jms="urn:jms:translation" version="1.2">
-  <file date="2024-03-07T15:14:33Z" source-language="en" target-language="de" datatype="plaintext" original="not.available">
+  <file date="2024-04-17T13:04:48Z" source-language="en" target-language="de" datatype="plaintext" original="not.available">
     <header>
       <tool tool-id="JMSTranslationBundle" tool-name="JMSTranslationBundle" tool-version="1.1.0-DEV"/>
       <note>The source node in most cases contains the sample message as written by the developer. If it looks like a dot-delimitted string such as "form.label.firstname", then the developer has not provided a default message.</note>

diff --git a/resources/locales/validators.en.xlf b/resources/locales/validators.en.xlf
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:jms="urn:jms:translation" version="1.2">
-  <file date="2024-03-07T15:14:49Z" source-language="en" target-language="en" datatype="plaintext" original="not.available">
+  <file date="2024-04-17T13:05:04Z" source-language="en" target-language="en" datatype="plaintext" original="not.available">
     <header>
       <tool tool-id="JMSTranslationBundle" tool-name="JMSTranslationBundle" tool-version="1.1.0-DEV"/>
       <note>The source node in most cases contains the sample message as written by the developer. If it looks like a dot-delimitted string such as "form.label.firstname", then the developer has not provided a default message.</note>

diff --git a/resources/locales/validators.fr.xlf b/resources/locales/validators.fr.xlf
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:jms="urn:jms:translation" version="1.2">
-  <file date="2024-03-07T15:15:10Z" source-language="en" target-language="fr" datatype="plaintext" original="not.available">
+  <file date="2024-04-17T13:05:24Z" source-language="en" target-language="fr" datatype="plaintext" original="not.available">
     <header>
       <tool tool-id="JMSTranslationBundle" tool-name="JMSTranslationBundle" tool-version="1.1.0-DEV"/>
       <note>The source node in most cases contains the sample message as written by the developer. If it looks like a dot-delimitted string such as "form.label.firstname", then the developer has not provided a default message.</note>

diff --git a/resources/locales/validators.nl.xlf b/resources/locales/validators.nl.xlf
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <xliff xmlns="urn:oasis:names:tc:xliff:document:1.2" xmlns:jms="urn:jms:translation" version="1.2">
-  <file date="2024-03-07T15:15:34Z" source-language="en" target-language="nl" datatype="plaintext" original="not.available">
+  <file date="2024-04-17T13:05:47Z" source-language="en" target-language="nl" datatype="plaintext" original="not.available">
     <header>
       <tool tool-id="JMSTranslationBundle" tool-name="JMSTranslationBundle" tool-version="1.1.0-DEV"/>
       <note>The source node in most cases contains the sample message as written by the developer. If it looks like a dot-delimitted string such as "form.label.firstname", then the developer has not provided a default message.</note>

diff --git a/templates/web/common/macro_caption.html.twig b/templates/web/common/macro_caption.html.twig
@@ -1,9 +1,15 @@
 {% macro caption(record, can_see_business, display_exif, limitedWidth = false) %}
-    <dl class="{% if limitedWidth %}{% else %}dl-horizontal{% endif %}">
+    <dl class="{% if limitedWidth %}dl-horizontal{% else %}dl-horizontal{% endif %}">
         {% for name, value in record.getCaption(caption_field_order(record, can_see_business)) %}
            {% if caption_field_gui_visible(record, name) == 1 %}
                 <dt>{{ caption_field_label(record, name) }}</dt>
-                <dd>{{ caption_field(record, name, value)|e|highlight|linkify|parseColor }}</dd>
+                <dd>
+                    {% if name == 'MatomoMediaMetrics' %}
+                        {{ caption_field(record, name, value)|e|highlight|linkify|parseColor|mediaMetricsInfo }}
+                    {% else %}
+                        {{ caption_field(record, name, value)|e|highlight|linkify|parseColor }}
+                    {% endif %}
+                </dd>
            {% endif %}
         {% endfor %}
     </dl>