-
-
Notifications
You must be signed in to change notification settings - Fork 818
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move custom group block generation to CustomGroup api action;
add dynamic forms for editing and adding custom group data
- Loading branch information
Showing
5 changed files
with
321 additions
and
68 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
295 changes: 295 additions & 0 deletions
295
ext/afform/core/Civi/Api4/Action/CustomGroup/GetAfforms.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,295 @@ | ||
| <?php | ||
|
|
||
| namespace Civi\Api4\Action\CustomGroup; | ||
|
|
||
| use CRM_Afform_ExtensionUtil as E; | ||
|
|
||
| /** | ||
| * Get dynamic afforms for a custom group. | ||
| * | ||
| * For single value custom groups we generate: | ||
| * - a field block with all of the fields from the group | ||
| * - a submission form for editing these fields on a parent entity record | ||
| * | ||
| * For multi-value custom groups we generate: | ||
| * - a field block with all of the fields from the group | ||
| * - a submission form for adding a new Custom record to a parent entity record | ||
| * - a submission form for editing a particular Custom record | ||
| * - (not implemented yet) a search form for viewing all the Custom records | ||
| * | ||
| * @package Civi\Api4\Action\CustomGroup | ||
| */ | ||
| class GetAfforms extends \Civi\Api4\Generic\BasicBatchAction { | ||
|
|
||
| protected const FORM_TYPES = [ | ||
| 'afblockCustom', | ||
| 'afformUpdateCustom', | ||
| 'afformCreateCustom', | ||
| //'afsearchCustom', | ||
| ]; | ||
|
|
||
| /** | ||
| * Whether to generate the form layouts | ||
| * @var bool | ||
| */ | ||
| protected bool $getLayout = FALSE; | ||
|
|
||
| /** | ||
| * Limit to generating specific afform types | ||
| * | ||
| * Default to all | ||
| * | ||
| * @var array | ||
| */ | ||
| protected array $formTypes = ['block', 'form', 'search']; | ||
|
|
||
| protected function getSelect() { | ||
| return ['id', 'name', 'title', 'is_multiple', 'help_pre', 'help_post', 'extends']; | ||
| } | ||
|
|
||
| protected function doTask($item) { | ||
| $forms = []; | ||
|
|
||
| // get field names once, for use across all the generate actions | ||
| $item['field_names'] = \Civi\Api4\CustomField::get(FALSE) | ||
| ->addSelect('name') | ||
| ->addWhere('custom_group_id', '=', $item['id']) | ||
| ->addWhere('is_active', '=', TRUE) | ||
| ->execute() | ||
| ->column('name'); | ||
|
|
||
| // we also needs this for | ||
|
|
||
| foreach ($this->formTypes as $type) { | ||
| switch ($type) { | ||
| case 'block': | ||
| $forms[] = $this->generateFieldBlock($item); | ||
| break; | ||
|
|
||
| case 'form': | ||
| $forms[] = $this->generateUpdateForm($item); | ||
| if ($item['is_multiple']) { | ||
| $forms[] = $this->generateCreateForm($item); | ||
| } | ||
| break; | ||
|
|
||
| // TODO: implement search kit listings for multi value | ||
| // case 'search': | ||
| // if ($item['is_multiple']) { | ||
| // $forms[] = $this->generateSearchForm($item); | ||
| // } | ||
| // break; | ||
| } | ||
| } | ||
|
|
||
| return [ | ||
| 'id' => $item['id'], | ||
| 'forms' => $forms, | ||
| ]; | ||
| } | ||
|
|
||
| private function generateFieldBlock($item): array { | ||
| $afform = [ | ||
| 'name' => 'afblockCustom_' . $item['name'], | ||
| 'type' => 'block', | ||
| 'requires' => [], | ||
| 'title' => E::ts('%1 block', [1 => $item['title']]), | ||
| 'description' => '', | ||
| 'is_public' => FALSE, | ||
| 'permission' => ['access CiviCRM'], | ||
| 'entity_type' => $item['extends'], | ||
| ]; | ||
| if ($item['is_multiple']) { | ||
| $afform['join_entity'] = 'Custom_' . $item['name']; | ||
| } | ||
| if ($this->getLayout) { | ||
| $afform['layout'] = \CRM_Core_Smarty::singleton()->fetchWith( | ||
| 'afform/customGroups/afblock.tpl', | ||
| ['group' => $item] | ||
| ); | ||
| } | ||
| return $afform; | ||
| } | ||
|
|
||
| private function generateUpdateForm($item): array { | ||
| $afform = [ | ||
| 'name' => 'afformUpdateCustom_' . $item['name'], | ||
| 'type' => 'form', | ||
| 'title' => E::ts('Update %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'] . '/update', | ||
| ]; | ||
| 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/afform.tpl', | ||
| [ | ||
| 'formEntity' => $formEntity, | ||
| 'formActions' => [ | ||
| 'create' => FALSE, | ||
| 'update' => TRUE, | ||
| ], | ||
| 'urlAutofill' => TRUE, | ||
| 'blockDirective' => _afform_angular_module_name('afblockCustom_' . $item['name'], 'dash'), | ||
| ] | ||
| ); | ||
| } | ||
| return $afform; | ||
| } | ||
|
|
||
| private function generateCreateForm($item): array { | ||
| $afform = [ | ||
| 'name' => 'afformCreateCustom_' . $item['name'], | ||
| 'type' => 'form', | ||
| 'title' => E::ts('Add %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'] . '/create', | ||
| ]; | ||
| if ($this->getLayout) { | ||
| $formEntity = [ | ||
| 'type' => 'Custom_' . $item['name'], | ||
| 'name' => 'Record', | ||
| 'label' => $item['extends'] . ' ' . $item['title'], | ||
| 'parent_field' => 'entity_id', | ||
| 'parent_field_defn' => [ | ||
| 'input_type' => 'Hidden', | ||
| 'label' => FALSE, | ||
| ], | ||
| ]; | ||
| $afform['layout'] = \CRM_Core_Smarty::singleton()->fetchWith( | ||
| 'afform/customGroups/afform.tpl', | ||
| [ | ||
| 'formEntity' => $formEntity, | ||
| 'formActions' => [ | ||
| 'create' => TRUE, | ||
| 'update' => FALSE, | ||
| ], | ||
| 'urlAutofill' => FALSE, | ||
| 'blockDirective' => _afform_angular_module_name('afblockCustom_' . $item['name'], 'dash'), | ||
| ] | ||
| ); | ||
| } | ||
| return $afform; | ||
| } | ||
|
|
||
| public static function getCustomGroupAfforms($event) { | ||
| $formGenerate = \Civi\Api4\CustomGroup::getAfforms(FALSE) | ||
| ->addWhere('is_active', '=', TRUE); | ||
|
|
||
| // only generate layout if this is required by the Afform.get | ||
| $formGenerate->setGetLayout($event->getLayout); | ||
|
|
||
| // if the Afform.get is limited to specific form types | ||
| // we can limit to those | ||
| if ($event->getTypes) { | ||
| $formGenerate->setFormTypes($event->getTypes); | ||
| } | ||
|
|
||
| // if the Afform.get is limited to specific form names | ||
| // we can limit our action to specific custom groups | ||
| if ($event->getNames) { | ||
| $groupNames = self::parseGroupNamesFromAfformGetNames($event->getNames); | ||
| if (!$groupNames) { | ||
| // Afform.get is limited to specific form names, none of which | ||
| // correspond to a custom group form, so we can return early | ||
| return; | ||
| } | ||
|
|
||
| $formGenerate->addWhere('name', 'IN', $groupNames); | ||
| } | ||
|
|
||
| $formsByGroup = $formGenerate->execute()->column('forms'); | ||
|
|
||
| // add generated forms back to the hook event | ||
| // indexing by the form name | ||
| $forms = array_merge(...$formsByGroup); | ||
|
|
||
| foreach ($forms as $form) { | ||
| $event->afforms[$form['name']] = $form; | ||
| } | ||
| } | ||
|
|
||
| protected static function parseGroupNamesFromAfformGetNames(array $getNames): array { | ||
| // preserves previous logic when module_name or directive_name | ||
| // are specified | ||
| // | ||
| // I suspect we cannot more accurately parse kebab case names as special chars | ||
| // from group name may have been lost? | ||
| if ( | ||
| (!empty($getNames['module_name']) && !str_contains(implode(' ', $getNames['module_name']), 'afblockCustom')) | ||
| || (!empty($getNames['directive_name']) && !str_contains(implode(' ', $getNames['directive_name']), 'afblock-custom')) | ||
| ) { | ||
| return []; | ||
| } | ||
|
|
||
| $formNames = $getNames['name'] ?? []; | ||
|
|
||
| $groupNames = array_map(fn ($name) => self::parseGroupNameFromFormName($name), $formNames); | ||
|
|
||
| // filter nulls where form name didnt correspond to a group name | ||
| return array_filter($groupNames); | ||
| } | ||
|
|
||
| /** | ||
| * For afform base name, get the custom group name it corresponds to | ||
| * Or null if none | ||
| * | ||
| * @return ?string | ||
| */ | ||
| protected static function parseGroupNameFromFormName(string $name): ?string { | ||
| $prefixLength = strpos($name, '_'); | ||
|
|
||
| if (!$prefixLength) { | ||
| // no prefix | ||
| return NULL; | ||
| } | ||
| $prefix = substr($name, 0, $prefixLength); | ||
|
|
||
| if (!in_array($prefix, self::FORM_TYPES)) { | ||
| // prefix doesn't match our custom group | ||
| // form prefixes | ||
| return NULL; | ||
| } | ||
|
|
||
| // TODO the prefix tells us which types of forms we | ||
| // want - so we could further optimise by passing | ||
| // that along to the generate action | ||
|
|
||
| // we have a match - return everything after the '_' | ||
| return substr($name, $prefixLength + 1); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,13 @@ | ||
| {if $custom.help_pre} | ||
| <div class="af-markup">{$custom.help_pre}</div> | ||
| {if $group.help_pre} | ||
| <div class="af-markup">{$group.help_pre}</div> | ||
| {/if} | ||
|
|
||
| {foreach from=$custom.fields item=field} | ||
| {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 *} | ||
| <af-field name="{if !$custom.is_multiple}{$custom.name}.{/if}{$field.name}" /> | ||
| <af-field name="{if !$group.is_multiple}{$group.name}.{/if}{$field_name}" /> | ||
| {/foreach} | ||
|
|
||
| {if $custom.help_post} | ||
| <div class="af-markup">{$custom.help_post}</div> | ||
| {if $group.help_post} | ||
| <div class="af-markup">{$group.help_post}</div> | ||
| {/if} | ||
|
|
Oops, something went wrong.