Add Variables::EVENT_PARSE_VARIABLES to allow you to parse custom r…

…egistered variables
verbb · Jan 13, 2025 · eeb1315 · eeb1315
1 parent b302f42
commit eeb1315
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 6 deletions.
diff --git a/src/events/ParseVariablesEvent.php b/src/events/ParseVariablesEvent.php
@@ -0,0 +1,21 @@
+<?php
+namespace verbb\formie\events;
+
+use verbb\formie\elements\Form;
+use verbb\formie\elements\Submission;
+use verbb\formie\models\Notification;
+
+use yii\base\Event;
+
+class ParseVariablesEvent extends Event
+{
+    // Properties
+    // =========================================================================
+
+    public mixed $value;
+    public ?Submission $submission = null;
+    public ?Form $form = null;
+    public ?Notification $notification = null;
+    public array $variables = [];
+
+}
diff --git a/src/helpers/Variables.php b/src/helpers/Variables.php
@@ -5,6 +5,7 @@
 use verbb\formie\base\SubFieldInterface;
 use verbb\formie\elements\Form;
 use verbb\formie\elements\Submission;
+use verbb\formie\events\ParseVariablesEvent;
 use verbb\formie\events\RegisterVariablesEvent;
 use verbb\formie\fields\formfields;
 use verbb\formie\models\Notification;
@@ -33,6 +34,7 @@ class Variables
     // =========================================================================
 
     public const EVENT_REGISTER_VARIABLES = 'registerVariables';
+    public const EVENT_PARSE_VARIABLES = 'parseVariables';
 
 
     // Static Methods
@@ -230,7 +232,7 @@ public static function getParsedValue(mixed $value, Submission $submission = nul
             // Form Info
             $formName = $form->title ?? '';
 
-            Formie::$plugin->getRenderCache()->setGlobalVariables($cacheKey, [
+            $variables = [
                 'formName' => $formName,
                 'submissionUrl' => $submission->cpEditUrl ?? '',
                 'submissionId' => $submission->id ?? null,
@@ -259,14 +261,15 @@ public static function getParsedValue(mixed $value, Submission $submission = nul
                 'userFullName' => $userFullName,
                 'userFirstName' => $userFirstName,
                 'userLastName' => $userLastName,
-            ]);
+            ];
 
             // Add support for all global sets
             foreach (Craft::$app->getGlobals()->getAllSets() as $globalSet) {
-                Formie::$plugin->getRenderCache()->setGlobalVariables($cacheKey, [
-                    $globalSet->handle => $globalSet,
-                ]);
+                $variables[$globalSet->handle] = $globalSet;
             }
+
+            // Cache variables in-memory for better performance next parse
+            Formie::$plugin->getRenderCache()->setGlobalVariables($cacheKey, $variables);
         }
 
         $fieldVariables = [];
@@ -299,9 +302,19 @@ public static function getParsedValue(mixed $value, Submission $submission = nul
             }
         }
 
+        // Allow plugins to modify the variables
+        $event = new ParseVariablesEvent([
+            'submission' => $submission,
+            'form' => $form,
+            'notification' => $notification,
+            'value' => $value,
+            'variables' => $variables,
+        ]);
+        Event::trigger(self::class, self::EVENT_PARSE_VARIABLES, $event);
+
         // Try to parse submission + extra variables
         try {
-            return Formie::$plugin->getTemplates()->renderObjectTemplate($value, $submission, $variables);
+            return Formie::$plugin->getTemplates()->renderObjectTemplate($value, $submission, $event->variables);
         } catch (Throwable $e) {
             Formie::error(Craft::t('formie', 'Failed to render dynamic string “{value}”. Template error: “{message}” {file}:{line}', [
                 'value' => $originalValue,