From cd83df5c575520f56f8def198f17ff6cffb415cb Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 13:23:40 +0000 Subject: [PATCH 1/9] rename is_multiple to allow_is_multiple in cg_extends --- CRM/Core/BAO/CustomGroup.php | 30 ++++++++++++++--------------- CRM/Custom/Form/Group.php | 2 +- templates/CRM/Custom/Form/Group.tpl | 4 ++-- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index ce33dbc2802b..62e5e709f2a6 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -2137,7 +2137,7 @@ public static function getEntityFromExtends(string $extends): string { * Returns a mix of hard-coded array and `cg_extend_objects` OptionValues. * - 'id' return key (maps to `cg_extend_objects.value`). * - 'grouping' key refers to the entity field used to select a sub-type. - * - 'is_multiple' (@internal, not returned by getFields.loadOptions) (maps to `cg_extend_objects.filter`) + * - 'allow_is_multiple' (@internal, not returned by getFields.loadOptions) (maps to `cg_extend_objects.filter`) * controls whether the entity supports multi-record custom groups. * - 'table_name' (@internal, not returned by getFields.loadOptions) (maps to `cg_extend_objects.name`). * We don't return it as the 'name' in getFields because it is not always unique (since contact types are pseudo-entities). @@ -2151,14 +2151,14 @@ public static function getCustomGroupExtendsOptions() { 'label' => ts('Activities'), 'grouping' => 'activity_type_id', 'table_name' => 'civicrm_activity', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], [ 'id' => 'Relationship', 'label' => ts('Relationships'), 'grouping' => 'relationship_type_id', 'table_name' => 'civicrm_relationship', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], // TODO: Move to civi_contribute extension (example: OptionValue_cg_extends_objects_grant.mgd.php) [ @@ -2166,21 +2166,21 @@ public static function getCustomGroupExtendsOptions() { 'label' => ts('Contributions'), 'grouping' => 'financial_type_id', 'table_name' => 'civicrm_contribution', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], [ 'id' => 'ContributionRecur', 'label' => ts('Recurring Contributions'), 'grouping' => NULL, 'table_name' => 'civicrm_contribution_recur', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], [ 'id' => 'Group', 'label' => ts('Groups'), 'grouping' => NULL, 'table_name' => 'civicrm_group', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], // TODO: Move to civi_member extension (example: OptionValue_cg_extends_objects_grant.mgd.php) [ @@ -2188,7 +2188,7 @@ public static function getCustomGroupExtendsOptions() { 'label' => ts('Memberships'), 'grouping' => 'membership_type_id', 'table_name' => 'civicrm_membership', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], // TODO: Move to civi_event extension (example: OptionValue_cg_extends_objects_grant.mgd.php) [ @@ -2196,14 +2196,14 @@ public static function getCustomGroupExtendsOptions() { 'label' => ts('Events'), 'grouping' => 'event_type_id', 'table_name' => 'civicrm_event', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], [ 'id' => 'Participant', 'label' => ts('Participants'), 'grouping' => NULL, 'table_name' => 'civicrm_participant', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], // TODO: Move to civi_pledge extension (example: OptionValue_cg_extends_objects_grant.mgd.php) [ @@ -2211,14 +2211,14 @@ public static function getCustomGroupExtendsOptions() { 'label' => ts('Pledges'), 'grouping' => NULL, 'table_name' => 'civicrm_pledge', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], [ 'id' => 'Address', 'label' => ts('Addresses'), 'grouping' => NULL, 'table_name' => 'civicrm_address', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], // TODO: Move to civi_campaign extension (example: OptionValue_cg_extends_objects_grant.mgd.php) [ @@ -2226,14 +2226,14 @@ public static function getCustomGroupExtendsOptions() { 'label' => ts('Campaigns'), 'grouping' => 'campaign_type_id', 'table_name' => 'civicrm_campaign', - 'is_multiple' => FALSE, + 'allow_is_multiple' => FALSE, ], [ 'id' => 'Contact', 'label' => ts('Contacts'), 'grouping' => NULL, 'table_name' => 'civicrm_contact', - 'is_multiple' => TRUE, + 'allow_is_multiple' => TRUE, ], ]; // `CustomGroup.extends` stores contact type as if it were an entity. @@ -2243,7 +2243,7 @@ public static function getCustomGroupExtendsOptions() { 'label' => $contactInfo['label'], 'grouping' => 'contact_sub_type', 'table_name' => 'civicrm_contact', - 'is_multiple' => TRUE, + 'allow_is_multiple' => TRUE, 'icon' => $contactInfo['icon'], ]; } @@ -2255,7 +2255,7 @@ public static function getCustomGroupExtendsOptions() { 'label' => $ogValue['label'], 'grouping' => $ogValue['grouping'] ?? NULL, 'table_name' => $ogValue['name'], - 'is_multiple' => !empty($ogValue['filter']), + 'allow_is_multiple' => !empty($ogValue['filter']), ]; } foreach ($options as &$option) { diff --git a/CRM/Custom/Form/Group.php b/CRM/Custom/Form/Group.php index 0c1dd26f6c24..74436dd0f71d 100644 --- a/CRM/Custom/Form/Group.php +++ b/CRM/Custom/Form/Group.php @@ -167,7 +167,7 @@ public function buildQuickForm() { // Assign data for use by js chain-selects $this->assign('entityColumnIdOptions', $entityColumnIdOptions); // List of entities that allow `is_multiple` - $this->assign('allowMultiple', array_column($extendsOptions, 'is_multiple', 'id')); + $this->assign('allowMultiple', array_column($extendsOptions, 'allow_is_multiple', 'id')); // Used by warnDataLoss $this->assign('defaultSubtypes', $this->_values['extends_entity_column_value'] ?? []); // Used to initially hide selects with no options diff --git a/templates/CRM/Custom/Form/Group.tpl b/templates/CRM/Custom/Form/Group.tpl index 2064a1d32965..7aa8180d3da9 100644 --- a/templates/CRM/Custom/Form/Group.tpl +++ b/templates/CRM/Custom/Form/Group.tpl @@ -83,7 +83,7 @@ CRM.$(function($) { const {/literal} $form = $('form.{$form.formClass}'), entityColumnIdOptions = {$entityColumnIdOptions|@json_encode}, - allMultiple = {$allowMultiple|@json_encode}, + allowMultiple = {$allowMultiple|@json_encode}, defaultSubtypes = {$defaultSubtypes|@json_encode}; {literal} let tabWithTableOption; @@ -151,7 +151,7 @@ CRM.$(function($) { // When changing or initializing the primary `extends` field function handleExtends() { - let multiAllowed = $(this).val() && allMultiple[$(this).val()]; + let multiAllowed = $(this).val() && allowMultiple[$(this).val()]; if (multiAllowed) { $('tr.field-style, tr.field-is_multiple', $form).show(); From ce1c91452278f2c4797140fe8b7d81136195fb7b Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 13:24:48 +0000 Subject: [PATCH 2/9] allow_is_multiple for Event CustomGroups --- CRM/Core/BAO/CustomGroup.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CRM/Core/BAO/CustomGroup.php b/CRM/Core/BAO/CustomGroup.php index 62e5e709f2a6..c91ef28109df 100644 --- a/CRM/Core/BAO/CustomGroup.php +++ b/CRM/Core/BAO/CustomGroup.php @@ -2196,7 +2196,7 @@ public static function getCustomGroupExtendsOptions() { 'label' => ts('Events'), 'grouping' => 'event_type_id', 'table_name' => 'civicrm_event', - 'allow_is_multiple' => FALSE, + 'allow_is_multiple' => TRUE, ], [ 'id' => 'Participant', From 2a763315acc174ecb0a04d1152eba4d6fac9afce Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 13:25:22 +0000 Subject: [PATCH 3/9] update Custom Group create is_multiple help text to not assume contact, remove old report related guidance --- templates/CRM/Custom/Form/Group.hlp | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/templates/CRM/Custom/Form/Group.hlp b/templates/CRM/Custom/Form/Group.hlp index 3e9df92edeaa..71f314beb121 100644 --- a/templates/CRM/Custom/Form/Group.hlp +++ b/templates/CRM/Custom/Form/Group.hlp @@ -43,17 +43,10 @@ {ts}Allow Multiple Records{/ts} {/htxt} {htxt id="id-is_multiple"} -

{ts}Checking this box allows you to enter multiple sets of values for a given contact.{/ts}

+

{ts}Checking this box allows you to enter multiple sets of values for a given record.{/ts}

{ts}EXAMPLE: When creating a set of custom fields used to collect Employment History - you might have fields for Job Title, Start Date, End Date, and Reason for Leaving. Checking the "multiple records" box allows you to collect information for multiple jobs.{/ts}

{ts}You can also set the maximum number of records which can be recorded per contact. Using the previous example, you might only want data for the three most recent jobs.{/ts}

-

{ts 1=$importMultipleURL}Use the Multi-value Custom Data Import tool to import data into multiple record custom fields (contact records must already exist).{/ts}

-

- {ts}CAUTION: The following features are NOT available for custom fields in 'multiple record' custom set:{/ts} -

    -
  • {ts}They can not be Exported{/ts}
    • -
  • {ts}If they are included in a report as a display column, only the first set of values are shown.{/ts}
    • -
-

+

{ts 1=$importMultipleURL}Use the Multi-value Custom Data Import tool to import data into multiple record custom fields (the parent records should already exist).{/ts}

{/htxt} {htxt id="id-max_multiple-title"} From 2e4ce31e4d74de093a769f34602da1dcc59c96df Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 15:10:09 +0000 Subject: [PATCH 4/9] generalise contact_id filter to entity_id for tabset afforms --- ang/afform/afsearchTabNote.aff.html | 2 +- ang/afform/afsearchTabRel.aff.html | 4 ++-- ext/afform/core/afform.php | 12 ++++++++++-- ext/afform/core/templates/afform/InlineAfform.tpl | 5 +++++ .../templates/afform/contactSummary/AfformTab.tpl | 5 ----- .../templates/afform/customGroups/afsearchTab.tpl | 2 +- ext/civicrm_admin_ui/ang/afformTabMember.aff.html | 6 +++--- .../ang/afsearchTabActivity.aff.html | 2 +- ext/civicrm_admin_ui/ang/afsearchTabMember.aff.html | 4 ++-- .../ang/afsearchTabParticipant.aff.html | 2 +- ext/civigrant/ang/afsearchTabGrant.aff.html | 2 +- templates/CRM/Contact/Page/View/Summary.tpl | 9 +++++++-- templates/CRM/common/TabHeader.tpl | 7 ++++++- 13 files changed, 40 insertions(+), 22 deletions(-) create mode 100644 ext/afform/core/templates/afform/InlineAfform.tpl delete mode 100644 ext/afform/core/templates/afform/contactSummary/AfformTab.tpl diff --git a/ang/afform/afsearchTabNote.aff.html b/ang/afform/afsearchTabNote.aff.html index 626cea7f6b1b..44a0f4fe0a66 100644 --- a/ang/afform/afsearchTabNote.aff.html +++ b/ang/afform/afsearchTabNote.aff.html @@ -1,3 +1,3 @@
- +
diff --git a/ang/afform/afsearchTabRel.aff.html b/ang/afform/afsearchTabRel.aff.html index d29687ff18d0..c25275153df5 100644 --- a/ang/afform/afsearchTabRel.aff.html +++ b/ang/afform/afsearchTabRel.aff.html @@ -1,8 +1,8 @@
- +

{{:: ts('Inactive Relationships') }}

{{:: ts('These relationships are Disabled OR have a past End Date.') }}
- +
{{:: ts('Permissioned Relationships:') }} {{:: ts('This contact can be viewed by the other.') }} diff --git a/ext/afform/core/afform.php b/ext/afform/core/afform.php index fccaeb396f69..d46aded2fbfa 100644 --- a/ext/afform/core/afform.php +++ b/ext/afform/core/afform.php @@ -194,12 +194,20 @@ function afform_civicrm_tabset($tabsetName, &$tabs, $context) { 'icon' => 'crm-i ' . ($afform['icon'] ?: 'fa-list-alt'), 'is_active' => TRUE, 'contact_type' => _afform_get_contact_types($summaryContactType) ?: NULL, - 'template' => 'afform/contactSummary/AfformTab.tpl', + 'template' => 'afform/InlineAfform.tpl', 'module' => $afform['module_name'], 'directive' => $afform['directive_name'], ]; - // If this is the real contact summary page (and not a callback from ContactLayoutEditor), load module. + // If this is the real contact summary page (and not a callback from ContactLayoutEditor), load module + // and assign contact id to required smarty variable if (empty($context['caller'])) { + // note we assign the contact id to entity_id as preferred key + // but also contact_id to maintain backwards compatibility with older + // afforms + CRM_Core_Smarty::singleton()->assign('afformOptions', [ + 'entity_id' => $context['contact_id'], + 'contact_id' => $context['contact_id'], + ]); Civi::service('angularjs.loader')->addModules($afform['module_name']); } } diff --git a/ext/afform/core/templates/afform/InlineAfform.tpl b/ext/afform/core/templates/afform/InlineAfform.tpl new file mode 100644 index 000000000000..42977db4c9ac --- /dev/null +++ b/ext/afform/core/templates/afform/InlineAfform.tpl @@ -0,0 +1,5 @@ + +
+ <{$afform.directive} options='{$afformOptions|@json_encode}'> +
+ diff --git a/ext/afform/core/templates/afform/contactSummary/AfformTab.tpl b/ext/afform/core/templates/afform/contactSummary/AfformTab.tpl deleted file mode 100644 index d0f4eac9a1cb..000000000000 --- a/ext/afform/core/templates/afform/contactSummary/AfformTab.tpl +++ /dev/null @@ -1,5 +0,0 @@ - -
- <{$tabValue.directive} options="{ldelim}contact_id: {$contactId}{rdelim}"> -
- diff --git a/ext/afform/core/templates/afform/customGroups/afsearchTab.tpl b/ext/afform/core/templates/afform/customGroups/afsearchTab.tpl index fb76f8af1ce2..54618fe5a09a 100644 --- a/ext/afform/core/templates/afform/customGroups/afsearchTab.tpl +++ b/ext/afform/core/templates/afform/customGroups/afsearchTab.tpl @@ -2,6 +2,6 @@
diff --git a/ext/civicrm_admin_ui/ang/afformTabMember.aff.html b/ext/civicrm_admin_ui/ang/afformTabMember.aff.html index 76fb8a693fe6..8d66bbf6449e 100644 --- a/ext/civicrm_admin_ui/ang/afformTabMember.aff.html +++ b/ext/civicrm_admin_ui/ang/afformTabMember.aff.html @@ -1,11 +1,11 @@
- +

{{:: ts('Pending and Inactive Memberships') }}

- +
- +
diff --git a/ext/civicrm_admin_ui/ang/afsearchTabActivity.aff.html b/ext/civicrm_admin_ui/ang/afsearchTabActivity.aff.html index 59087354c7ed..cf9e7f47e3f8 100644 --- a/ext/civicrm_admin_ui/ang/afsearchTabActivity.aff.html +++ b/ext/civicrm_admin_ui/ang/afsearchTabActivity.aff.html @@ -5,5 +5,5 @@
- + diff --git a/ext/civicrm_admin_ui/ang/afsearchTabMember.aff.html b/ext/civicrm_admin_ui/ang/afsearchTabMember.aff.html index 0d7df1854385..4ce6c394ad4d 100644 --- a/ext/civicrm_admin_ui/ang/afsearchTabMember.aff.html +++ b/ext/civicrm_admin_ui/ang/afsearchTabMember.aff.html @@ -1,5 +1,5 @@
- +

{{:: ts('Pending and Inactive Memberships') }}

- +
diff --git a/ext/civicrm_admin_ui/ang/afsearchTabParticipant.aff.html b/ext/civicrm_admin_ui/ang/afsearchTabParticipant.aff.html index 74fccae75756..502d4833061f 100644 --- a/ext/civicrm_admin_ui/ang/afsearchTabParticipant.aff.html +++ b/ext/civicrm_admin_ui/ang/afsearchTabParticipant.aff.html @@ -1,3 +1,3 @@
- +
diff --git a/ext/civigrant/ang/afsearchTabGrant.aff.html b/ext/civigrant/ang/afsearchTabGrant.aff.html index ac44d8a34958..17e194abf93f 100644 --- a/ext/civigrant/ang/afsearchTabGrant.aff.html +++ b/ext/civigrant/ang/afsearchTabGrant.aff.html @@ -1,3 +1,3 @@
- +
diff --git a/templates/CRM/Contact/Page/View/Summary.tpl b/templates/CRM/Contact/Page/View/Summary.tpl index 338369b960b0..beb28d67fce2 100644 --- a/templates/CRM/Contact/Page/View/Summary.tpl +++ b/templates/CRM/Contact/Page/View/Summary.tpl @@ -116,9 +116,14 @@ {foreach from=$allTabs item=tabValue} - {if !empty($tabValue.template)} + {if $tabValue.template}
- {include file=$tabValue.template} + {if $tabValue.module} + + {include file=$tabValue.template afform=$tabValue} + {else} + {include file=$tabValue.template} + {/if}
{/if} {/foreach} diff --git a/templates/CRM/common/TabHeader.tpl b/templates/CRM/common/TabHeader.tpl index 83fdd282147d..9689ebcf3c16 100644 --- a/templates/CRM/common/TabHeader.tpl +++ b/templates/CRM/common/TabHeader.tpl @@ -29,7 +29,12 @@ {foreach from=$tabHeader key=tabName item=tabValue} {if $tabValue.template}
- {include file=$tabValue.template} + {if $tabValue.module} + + {include file=$tabValue.template afform=$tabValue} + {else} + {include file=$tabValue.template} + {/if}
{/if} {/foreach} From a8867bee1c27b37644e0cb9325cd34a2b04af531 Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 15:14:36 +0000 Subject: [PATCH 5/9] enable tab afforms for non-contact is_multiple CustomGroups --- .../Api4/Action/CustomGroup/GetAfforms.php | 8 +- .../Api4/Action/CustomGroup/GetSearchKit.php | 3 +- ext/civicrm_admin_ui/civicrm_admin_ui.php | 74 +++++++++++++++++++ 3 files changed, 79 insertions(+), 6 deletions(-) diff --git a/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php b/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php index 6a2ab0a98680..60e05e6df98f 100644 --- a/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php +++ b/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php @@ -83,11 +83,9 @@ protected function doTask($item) { case 'search': // TODO: // 1. tabs with grid display - // 2. tabs for other entities (e.g. Event) if ( $item['is_multiple'] && ($item['style'] === 'Tab with table') - && CoreUtil::isContact($item['extends']) ) { $forms[] = $this->generateTabForm($item); } @@ -225,7 +223,7 @@ private function generateTabForm($item): array { $afform = [ // name required to replace the existing tab 'name' => 'afsearchTabCustom_' . $item['name'], - 'description' => E::ts('Contact summary tab display for %1', [1 => $item['title']]), + 'description' => E::ts('%1 tab display for %2', [1 => $item['extends'], 2 => $item['title']]), 'type' => 'search', 'is_public' => FALSE, // Q: should this be more permissive if user has access @@ -243,7 +241,9 @@ private function generateTabForm($item): array { $afform['summary_contact_type'] = [$item['extends']]; } else { - // TODO implement tabs for other tabsets + // tabs for other entities are placed without any + // additional afform meta + // @see civicrm_admin_ui_civicrm_tabset } if ($this->getLayout) { // TODO: the template should be a table or grid depending diff --git a/ext/civicrm_admin_ui/Civi/Api4/Action/CustomGroup/GetSearchKit.php b/ext/civicrm_admin_ui/Civi/Api4/Action/CustomGroup/GetSearchKit.php index 650525e1a58a..16c319833fa2 100644 --- a/ext/civicrm_admin_ui/Civi/Api4/Action/CustomGroup/GetSearchKit.php +++ b/ext/civicrm_admin_ui/Civi/Api4/Action/CustomGroup/GetSearchKit.php @@ -218,12 +218,11 @@ protected function getButtonColumn($group) { } public static function getAllManaged() { - // for now we only fetch for Groups that have a Tab with table on the contact summary + // for now we only fetch for Groups that have a Tab $all = \Civi\Api4\CustomGroup::getSearchKit(FALSE) ->addWhere('is_active', '=', TRUE) ->addWhere('is_multiple', '=', TRUE) ->addWhere('style', 'IN', ['Tab', 'Tab with table']) - ->addWhere('extends', 'IN', ['Contact', 'Individual', 'Household', 'Organization']) ->execute() ->column('managed'); diff --git a/ext/civicrm_admin_ui/civicrm_admin_ui.php b/ext/civicrm_admin_ui/civicrm_admin_ui.php index b6b2c161cef8..a7e506359cae 100644 --- a/ext/civicrm_admin_ui/civicrm_admin_ui.php +++ b/ext/civicrm_admin_ui/civicrm_admin_ui.php @@ -73,3 +73,77 @@ function civicrm_admin_ui_civicrm_managed(&$entities, $modules) { $entities[] = $record; } } + +/** + * Implements hook_civicrm_tabset(). + * + * Adds afforms as contact summary tabs. + */ +function civicrm_admin_ui_civicrm_tabset($tabsetName, &$tabs, $context) { + $entities = []; + $tabsetTemplate = NULL; + + switch ($tabsetName) { + + case 'civicrm/event/manage': + $entities = ['Event']; + \CRM_Core_Smarty::singleton()->assign('afformOptions', [ + 'entity_id' => $context['event_id'] ?? NULL, + ]); + break; + + // NOTE: contact custom group tabs are added by + // admin_civicrm_tabset using the contact_summary_tab + // afform meta key + // case 'civicrm/contact/view': + // $entities = \Civi\Api4\Generic\CoreUtil::contactEntityNames(); + // break; + } + + if (!$entities) { + return; + } + + $groups = \Civi\Api4\CustomGroup::get(FALSE) + ->addWhere('extends', 'IN', $entities) + ->addWhere('is_multiple', '=', TRUE) + ->addWhere('style', 'IN', ['Tab', 'Tab with table']) + ->addOrderBy('title') + ->addSelect('name') + ->execute(); + + $weight = 100; + + foreach ($groups as $group) { + $tabName = 'custom_' . $group['name']; + $tabFormName = 'afsearchTabCustom_' . $group['name']; + $afform = Civi\Api4\Afform::get(FALSE) + ->addSelect('name', 'title', 'icon', 'module_name', 'directive_name') + ->addWhere('name', '=', $tabFormName) + ->execute() + ->first(); + + if (!$afform) { + // form may be disabled? + continue; + } + + $tabs[$tabName] = [ + 'title' => $afform['title'], + // after core tabs + 'weight' => $weight++, + 'icon' => 'crm-i ' . ($afform['icon'] ?: 'fa-list-alt'), + 'active' => TRUE, + 'valid' => TRUE, + 'template' => 'afform/InlineAfform.tpl', + 'module' => $afform['module_name'], + 'directive' => $afform['directive_name'], + ]; + + // If this is the real contact summary page (and not a callback from ContactLayoutEditor), load module. + if (empty($context['caller'])) { + Civi::service('angularjs.loader')->addModules($afform['module_name']); + } + } + +} From c934814fac85ae79ec98cba6555f396d827bddff Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 19:34:39 +0000 Subject: [PATCH 6/9] get Entity Label using CoreUtil::getInfoItem --- ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php b/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php index 60e05e6df98f..7f7f9dc6f258 100644 --- a/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php +++ b/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php @@ -220,10 +220,11 @@ private function generateCreateForm($item): array { } private function generateTabForm($item): array { + $extendsLabel = CoreUtil::getInfoItem($item['extends'], 'title'); $afform = [ // name required to replace the existing tab 'name' => 'afsearchTabCustom_' . $item['name'], - 'description' => E::ts('%1 tab display for %2', [1 => $item['extends'], 2 => $item['title']]), + 'description' => E::ts('%1 tab display for %2', [1 => $extendsLabel, 2 => $item['title']]), 'type' => 'search', 'is_public' => FALSE, // Q: should this be more permissive if user has access From 9aabbef4fd72630be0d190380f2e176ad5bc383e Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 20:40:03 +0000 Subject: [PATCH 7/9] Event Dashboard - use selectedChild param rather than dedicated route for settings tab links --- templates/CRM/Event/Page/DashBoard.tpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/templates/CRM/Event/Page/DashBoard.tpl b/templates/CRM/Event/Page/DashBoard.tpl index 19d258b7eb38..38a431d60d18 100644 --- a/templates/CRM/Event/Page/DashBoard.tpl +++ b/templates/CRM/Event/Page/DashBoard.tpl @@ -105,7 +105,7 @@ href="{crmURL p="`$v.url`" q="reset=1&action=browse&setTab=1&id=`$id`"}">{$v.title} {else}
  • {$v.title}
    • + href="{crmURL p="civicrm/event/manage/settings" q="reset=1&action=update&id=`$id`&selectedChild=`$k`"}">{$v.title} {/if} {/foreach} From ecd8552d161941ddf2a2eb87842be00143e4e8e7 Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 20:53:57 +0000 Subject: [PATCH 8/9] custom afform generation - correct afblock comment --- ext/afform/core/templates/afform/customGroups/afblock.tpl | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ext/afform/core/templates/afform/customGroups/afblock.tpl b/ext/afform/core/templates/afform/customGroups/afblock.tpl index 785631766ad1..f8745449b2d2 100644 --- a/ext/afform/core/templates/afform/customGroups/afblock.tpl +++ b/ext/afform/core/templates/afform/customGroups/afblock.tpl @@ -4,7 +4,7 @@ {foreach from=$group.field_names item=field_name} {* for multiple record fields there is no need to prepend - the group name because it is provided as the join_entity above *} + the group name because it will be the form entity itself *} {/foreach} From b985d820fc7d95f9bf2a17c2cd509643ba282a69 Mon Sep 17 00:00:00 2001 From: benjamin Date: Mon, 16 Dec 2024 20:54:37 +0000 Subject: [PATCH 9/9] add custom view-only afform --- .../Api4/Action/CustomGroup/GetAfforms.php | 56 ++++++++++++++++++- .../{afform.tpl => afformEdit.tpl} | 0 .../afform/customGroups/afformView.tpl | 22 ++++++++ .../Subscriber/CustomGroupEntityLinks.php | 1 + 4 files changed, 77 insertions(+), 2 deletions(-) rename ext/afform/core/templates/afform/customGroups/{afform.tpl => afformEdit.tpl} (100%) create mode 100644 ext/afform/core/templates/afform/customGroups/afformView.tpl diff --git a/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php b/ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php index 7f7f9dc6f258..9cd1d5a0950b 100644 --- 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', ]; @@ -74,6 +75,7 @@ protected function doTask($item) { break; case 'form': + $forms[] = $this->generateViewForm($item); $forms[] = $this->generateUpdateForm($item); if ($item['is_multiple']) { $forms[] = $this->generateCreateForm($item); @@ -123,6 +125,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'], @@ -163,7 +215,7 @@ private function generateUpdateForm($item): array { ]; $afform['layout'] = \CRM_Core_Smarty::singleton()->fetchWith( - 'afform/customGroups/afform.tpl', + 'afform/customGroups/afformEdit.tpl', [ 'formEntity' => $formEntity, 'formActions' => [ @@ -204,7 +256,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/ext/afform/core/templates/afform/customGroups/afform.tpl b/ext/afform/core/templates/afform/customGroups/afformEdit.tpl similarity index 100% rename from ext/afform/core/templates/afform/customGroups/afform.tpl rename to ext/afform/core/templates/afform/customGroups/afformEdit.tpl diff --git a/ext/afform/core/templates/afform/customGroups/afformView.tpl b/ext/afform/core/templates/afform/customGroups/afformView.tpl new file mode 100644 index 000000000000..783dbd22e044 --- /dev/null +++ b/ext/afform/core/templates/afform/customGroups/afformView.tpl @@ -0,0 +1,22 @@ + + + +
    + + {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 *} + + {/foreach} +
    +     diff --git a/ext/civicrm_admin_ui/Civi/Api4/Event/Subscriber/CustomGroupEntityLinks.php b/ext/civicrm_admin_ui/Civi/Api4/Event/Subscriber/CustomGroupEntityLinks.php index 246ce6e87123..704cd4762fe3 100644 --- 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]"; } } }