add custom view-only afform

civicrm · Dec 17, 2024 · 7d51ae3 · 7d51ae3
1 parent f6a64d1
commit 7d51ae3
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 2 deletions.
diff --git a/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php b/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php
@@ -26,6 +26,7 @@ class GetAfforms extends \Civi\Api4\Generic\BasicBatchAction {
     'afblockCustom',
     'afformUpdateCustom',
     'afformCreateCustom',
+    'afformViewCustom',
     'afsearchTabCustom',
   ];
 
@@ -70,6 +71,7 @@ protected function doTask($item) {
           break;
 
         case 'form':
+          $forms[] = $this->generateViewForm($item);
           $forms[] = $this->generateUpdateForm($item);
           if ($item['is_multiple']) {
             $forms[] = $this->generateCreateForm($item);
@@ -119,6 +121,56 @@ private function generateFieldBlock($item): array {
     return $afform;
   }
 
+  private function generateViewForm($item): array {
+    $afform = [
+      'name' => 'afformViewCustom_' . $item['name'],
+      'type' => 'form',
+      'title' => E::ts('View %1', [1 => $item['title']]),
+      'description' => '',
+      'is_public' => FALSE,
+      // NOTE: we will use RBAC for entities to ensure
+      // this form does not allow folks who shouldn't
+      // to edit contacts
+      'permission' => ['access CiviCRM'],
+      'server_route' => 'civicrm/af/custom/' . $item['name'] . '/view',
+      'icon' => $item['icon'],
+    ];
+    if ($this->getLayout) {
+
+      // form entity depends on whether this is a multirecord custom group
+      $formEntity = $item['is_multiple'] ?
+        [
+          'type' => 'Custom_' . $item['name'],
+          'name' => 'Record',
+          'label' => $item['extends'] . ' ' . $item['title'],
+          'parent_field' => 'entity_id',
+          'parent_field_defn' => [
+            'input_type' => 'Hidden',
+            'label' => FALSE,
+          ],
+        ] :
+        [
+          'type' => $item['extends'],
+          'name' => $item['extends'] . '1',
+          'label' => $item['extends'],
+          'parent_field' => 'id',
+          'parent_field_defn' => [
+            'input_type' => 'Hidden',
+            'label' => FALSE,
+          ],
+        ];
+
+      $afform['layout'] = \CRM_Core_Smarty::singleton()->fetchWith(
+        'afform/customGroups/afformView.tpl',
+        [
+          'formEntity' => $formEntity,
+          'group' => $item,
+        ]
+      );
+    }
+    return $afform;
+  }
+
   private function generateUpdateForm($item): array {
     $afform = [
       'name' => 'afformUpdateCustom_' . $item['name'],
@@ -159,7 +211,7 @@ private function generateUpdateForm($item): array {
         ];
 
       $afform['layout'] = \CRM_Core_Smarty::singleton()->fetchWith(
-        'afform/customGroups/afform.tpl',
+        'afform/customGroups/afformEdit.tpl',
         [
           'formEntity' => $formEntity,
           'formActions' => [
@@ -200,7 +252,7 @@ private function generateCreateForm($item): array {
         ],
       ];
       $afform['layout'] = \CRM_Core_Smarty::singleton()->fetchWith(
-        'afform/customGroups/afform.tpl',
+        'afform/customGroups/afformEdit.tpl',
         [
           'formEntity' => $formEntity,
           'formActions' => [

diff --git a/.../templates/afform/customGroups/afform.tpl → ...plates/afform/customGroups/afformEdit.tpl b/.../templates/afform/customGroups/afform.tpl → ...plates/afform/customGroups/afformEdit.tpl
diff --git a/ext/afform/core/templates/afform/customGroups/afformView.tpl b/ext/afform/core/templates/afform/customGroups/afformView.tpl
@@ -0,0 +1,22 @@
+<af-form ctrl="afform">
+  <af-entity
+    type="{$formEntity.type}"
+    name="{$formEntity.name}"
+    label="{$formEntity.label}"
+    actions='{ldelim}create: false, update: true{rdelim}'
+    security="RBAC"
+    url-autofill="1"
+    />
+
+  <fieldset af-fieldset="{$formEntity.name}" class="af-container">
+    <af-field
+        name="{$formEntity.parent_field}"
+        defn='{$formEntity.parent_field_defn|@json_encode}'
+        />
+    {foreach from=$group.field_names item=field_name}
+      {* for multiple record fields there is no need to prepend
+      the group name because it  will be the form entity itself *}
+      <af-field name="{if !$group.is_multiple}{$group.name}.{/if}{$field_name}" defn="{ldelim}input_type: 'DisplayOnly'{rdelim}" />
+    {/foreach}
+  </fieldset>
+</af-form>
diff --git a/ext/civicrm_admin_ui/Civi/Api4/Event/Subscriber/CustomGroupEntityLinks.php b/ext/civicrm_admin_ui/Civi/Api4/Event/Subscriber/CustomGroupEntityLinks.php
@@ -34,6 +34,7 @@ public function addCustomGroupLinks(\Civi\Core\Event\GenericHookEvent $event) {
         $groupName = substr($name, 7);
         $event->entities[$name]['paths']['add'] = "civicrm/af/custom/{$groupName}/create#?entity_id=[entity_id]";
         $event->entities[$name]['paths']['update'] = "civicrm/af/custom/{$groupName}/update#?Record=[id]";
+        $event->entities[$name]['paths']['view'] = "civicrm/af/custom/{$groupName}/view#?Record=[id]";
       }
     }
   }