SearchKit - Optionally remember filter values when user revisits sear…

…ch form

ext/afform/admin/ang/afGuiEditor/afGuiSearch.html

@@ -77,4 +77,12 @@
       </div>
     </div>
   </fieldset>
+
+  <fieldset>
+    <legend>{{:: ts('Options') }}</legend>
+    <label>{{:: ts('Remember Filters') }} <input type="checkbox" ng-model="$ctrl.display.fieldset['store-values']"></label>
+    <p class="help-block">
+      {{:: ts('Filter fields will retain their value when the same user revisits the form.') }}
+    </p>
+  </fieldset>
 </div>

ext/afform/core/ang/af/afField.component.js

@@ -120,6 +120,9 @@
           else if (urlArgs && (ctrl.fieldName in urlArgs)) {
             setValue(urlArgs[ctrl.fieldName]);
           }
+          else if (ctrl.afFieldset.getStoredValue(ctrl.fieldName) !== undefined) {
+            setValue(ctrl.afFieldset.getStoredValue(ctrl.fieldName));
+          }
           // Set default value based on field defn
           else if ('afform_default' in ctrl.defn) {
             setValue(ctrl.defn.afform_default);

ext/afform/core/ang/af/afFieldset.directive.js

@@ -5,7 +5,8 @@
       restrict: 'A',
       require: ['afFieldset', '?^^afForm'],
       bindToController: {
-        modelName: '@afFieldset'
+        modelName: '@afFieldset',
+        storeValues: '<'
       },
       link: function($scope, $el, $attr, ctrls) {
         var self = ctrls[0];
@@ -40,6 +41,26 @@
         this.getFormName = function() {
           return ctrl.afFormCtrl ? ctrl.afFormCtrl.getFormMeta().name : $scope.meta.name;
         };
+
+        // If `storeValue` setting is enabled, field values are cached in localStorage
+        function getCacheKey() {
+          return 'afform:' + ctrl.getFormName() + ctrl.getName();
+        }
+        this.getStoredValue = function(fieldName) {
+          if (!this.storeValues) {
+            return;
+          }
+          return CRM.cache.get(getCacheKey(), {})[fieldName];
+        };
+        this.$onInit = function() {
+          if (this.storeValues) {
+            $scope.$watch(ctrl.getFieldData, function(newVal, oldVal) {
+              if (typeof newVal === 'object' && typeof oldVal === 'object' && Object.keys(newVal).length) {
+                CRM.cache.set(getCacheKey(), newVal);
+              }
+            }, true);
+          }
+        };
       }
     };
   });