Afform - Use filter instead of grouping to indicate placement require…

…s url This leaves grouping open for other uses, like storing the entityType
civicrm · Feb 11, 2025 · e86e458 · e86e458
1 parent 5ca888b
commit e86e458
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/CRM/Utils/Array.php b/CRM/Utils/Array.php
@@ -1421,7 +1421,7 @@ public static function formatForSelect2(array $options, string $label = 'label',
       if (!empty($option['children'])) {
         $option['children'] = self::formatForSelect2($option['children'], $label, $id);
       }
-      $option = array_intersect_key($option, array_flip(['id', 'text', 'children', 'color', 'icon', 'description', 'grouping']));
+      $option = array_intersect_key($option, array_flip(['id', 'text', 'children', 'color', 'icon', 'description', 'grouping', 'filter']));
     }
     return $options;
   }

diff --git a/ext/afform/admin/Civi/AfformAdmin/AfformAdminMeta.php b/ext/afform/admin/Civi/AfformAdmin/AfformAdminMeta.php
@@ -14,7 +14,7 @@ class AfformAdminMeta {
    */
   public static function getAdminSettings() {
     $afformPlacement = \CRM_Utils_Array::formatForSelect2((array) \Civi\Api4\OptionValue::get(FALSE)
-      ->addSelect('value', 'label', 'icon', 'description', 'grouping')
+      ->addSelect('value', 'label', 'icon', 'description', 'grouping', 'filter')
       ->addWhere('is_active', '=', TRUE)
       ->addWhere('option_group_id:name', '=', 'afform_placement')
       ->addOrderBy('weight')

diff --git a/ext/afform/admin/ang/afGuiEditor/afGuiEditor.component.js b/ext/afform/admin/ang/afGuiEditor/afGuiEditor.component.js
@@ -362,7 +362,7 @@
         let requiresServerRoute = false;
         editor.afform.placement.forEach(function(placement) {
           const item = editor.meta.afform_placement.find(item => item.id === placement);
-          if (item && item.grouping === 'server_route') {
+          if (item && item.filter) {
             requiresServerRoute = item.text;
           }
         });

diff --git a/ext/afform/core/managed/AfformPlacement.mgd.php b/ext/afform/core/managed/AfformPlacement.mgd.php
@@ -102,7 +102,7 @@
         'is_active' => TRUE,
         'icon' => 'fa-bars',
         // Indicates that a server_route is required for this placement
-        'grouping' => 'server_route',
+        'filter' => 1,
         'description' => E::ts('Add to the contact summary actions menu.'),
       ],
       'match' => ['option_group_id', 'name'],