dev/core#5053 Afform - Add support for saving event location #30140

colemanw · 2024-05-06T23:58:35Z

Overview

Fulfills feature request from https://lab.civicrm.org/dev/core/-/issues/5053

Before

Not possible to save email/phone/address when creating an event via Afform

After

Support added for those fields, in the form of a block.

civibot · 2024-05-06T23:58:37Z

🤖 Thank you for contributing to CiviCRM! ❤️ We will need to test and review this PR. 👷

Introduction for new contributors...

If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
For more information about contributing, see CONTRIBUTING.md.

Quick links for reviewers...

➡️ PR Demo site (can be rebuilt with the command test this please).
📖 Review standards
🗒️ Review template (brief or verbose)

➡️ Online demo of this PR 🔗

civibot · 2024-05-06T23:58:41Z

The issue associated with the Pull Request can be viewed at https://lab.civicrm.org/dev/core/-/issues/5053

mattwire · 2024-05-07T11:12:50Z

Test fail is probably related:

api\v4\Afform\AfformCustomFieldUsageTest::testMultiRecordCustomBlock
Failed asserting that null matches expected 'One'.

/home/homer/buildkit/build/build-3/web/sites/all/modules/civicrm/ext/afform/mock/tests/phpunit/api/v4/Afform/AfformCustomFieldUsageTest.php:102
/home/homer/buildkit/extern/phpunit9/phpunit9.phar:2307

mattwire · 2024-05-07T11:13:45Z

Non-blocking comment but probably our only opportunity if we wanted to.. How hard would it be to rename the entity from LocBlock to LocationBlock?

colemanw · 2024-05-07T11:46:14Z

Non-blocking comment but probably our only opportunity if we wanted to.. How hard would it be to rename the entity from LocBlock to LocationBlock?

The LocBlock entity is a horrible design and the name is the least of its problems. I wouldn't bother renaming it since what it really needs is to be ripped out.

jitendrapurohit · 2024-05-14T06:19:24Z

ext/afform/core/Civi/Api4/Action/Afform/AbstractProcessor.php

+        'where' => [['id', '=', $mainEntityId]],
+        'select' => [$forwardFkField['name']],
+      ])->first();
+      return [$joinIdField, '=', $mainEntityJoinValue[$forwardFkField['name']] ?? 0];


@colemanw Should this return an array of current return value? I get the following error when trying to prefill the afform with event id in URL (happens only if location block is included).

TypeError: array_pad(): Argument #1 ($array) must be of type array, string given in array_pad() (line 303 of web/sites/all/modules/civicrm/Civi/Api4/Query/Api4SelectQuery.php).

Guydn · 2024-05-20T16:36:20Z

I have just started to test. On the back end there is a field to state whether it is a new location or not. This field does not exist in FB. Maybe I should add a custom field so that I display the existing location or not (cond rule).

I try to create an autocomplete on the addresses. It works well in SK (with address, postal code, town). In form builder, I can set the Search and the autocomplete display. But when i run the form, it only shows the ID and does not apply the criteria (to limit the number of addresses).

colemanw · 2024-05-20T16:45:46Z

Thanks for testing @Guydn
I should clarify that this PR exposes the entities to Afform but does not attempt to reproduce all the complex features of the "Location" tab on the "Event" screen.
If you let me know what are the most important features for you I can try to work on them.

Guydn · 2024-05-20T17:04:36Z

Yes sure. In the membership organisation, around 50 people are able to create events (and modify). They do not have access to CiviCRM but to a web logged in environment on WP. They are able to choose a event template (that brings a lot of information) and have to define a location (either select one or create one), description, title, dates, quota.
I have a quick form which has been working for 2,5 years now so it is not urgent.
The location date structure is complex and honestly, for events, I do not have a clear understanding (we have many duplicates...)

Hoping it clarifies.

It's already possible to read fields in this format so it makes sense to be able to write them this way too.

colemanw · 2024-08-10T17:41:49Z

@Guydn I've added support for autocomplete + autofill of location info. It was extremely challenging!

…f a matchField param

Guydn · 2024-08-10T20:04:37Z

@Guydn I've added support for autocomplete + autofill of location info. It was extremely challenging!

Thanks a lot @colemanw Yes i understand that it is a very very difficult development.

allinappliadmin · 2024-08-12T08:06:00Z

I can't merge patch on 5.76.1 as a file is missing

patching file Civi/Api4/Action/LocBlock/Create.php
patching file Civi/Api4/Action/LocBlock/LocBlockSaveTrait.php
patching file Civi/Api4/Action/LocBlock/Save.php
patching file Civi/Api4/Action/LocBlock/Update.php
patching file Civi/Api4/Generic/Traits/DAOActionTrait.php
patching file Civi/Api4/LocBlock.php
patching file Civi/Api4/Utils/CoreUtil.php
patching file ext/afform/admin/Civi/AfformAdmin/AfformAdminMeta.php
patching file ext/afform/admin/afformEntities/LocBlock.php
patching file ext/afform/admin/ang/afGuiEditor/afGuiEntity.component.js
Hunk #1 succeeded at 104 (offset -4 lines).
patching file ext/afform/admin/ang/afGuiEditor/elements/afGuiContainer.component.js
patching file ext/afform/admin/ang/afGuiEditor/elements/afGuiContainer.html
patching file ext/afform/core/Civi/Afform/Behavior/ContactAutofill.php
can't find file to patch at input line 379
Perhaps you used the wrong -p or --strip option?
The text leading up to this was:
--------------------------
|diff --git a/ext/afform/core/Civi/Afform/Behavior/GroupSubscription.php b/ext/afform/core/Civi/Afform/Behavior/GroupSubscription.php
|index c6b42fdb601e..557fc01ac721 100644
|--- a/ext/afform/core/Civi/Afform/Behavior/GroupSubscription.php
|+++ b/ext/afform/core/Civi/Afform/Behavior/GroupSubscription.php
--------------------------
File to patch: ext/afform/core/Civi/Afform/Behavior/GroupSubscription.php
ext/afform/core/Civi/Afform/Behavior/GroupSubscription.php: No such file or directory

and on 5.78.1 I'm blocked a bit afterwards

patching file ext/afform/mock/tests/phpunit/api/v4/Afform/AfformUsageTestCase.php
patching file tests/phpunit/api/v4/Entity/LocBlockTest.php
can't find file to patch at input line 1256
Perhaps you used the wrong -p or --strip option?
The text leading up to this was:
--------------------------
|diff --git a/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php b/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php
|index f5ed0e2af178..9e4e1b3f54a9 100644
|--- a/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php
|+++ b/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php
--------------------------

colemanw · 2024-08-12T13:24:17Z

@allinappliadmin that file exists in the RC but not your version. I don't think it's critical to this PR so you could just ignore it.

@civicrm-builder retest this please

allinappliadmin · 2024-08-12T13:32:30Z

should the test work on the 5.76.1?

colemanw · 2024-08-14T19:44:57Z

@allinappliadmin I think so. One or more files will not patch, but that's probably ok.

Guydn · 2024-08-15T12:31:50Z

There is now a "block address" that is available in the event fields in FB. There are 3 main display possibilities: "autocompletion"," id. location", "select location form".

I prepared an autocompletion search (on entity address "with" address addresses "with" event location, "grouped by" id. address). When i select autocompletion, i try to select my search but I cannot see it and therefore cannot see my autocompletion display. I'm missing something. -> fixed ! :-) my search is now entity address (with a map) with address location, with event location.
There is a possibility to select a quick add but none are available and I do not see how I can create one.
Actually the global idea is very interesting :-): search in a list of addresses, select one and keep the option to create a new one through a quick add.

If I select "id. location", it is an integer. I do not see how this option can be used.

If i select "select location form", i do not understand how to use it. If I want to customize the options then the whole FB edit screen is frozen.

colemanw · 2024-08-15T15:45:31Z

@Guydn I'm not entirely sure what you mean. Could you add a screenshot to illustrate what you mean by "quick add" and "id. location is an integer" and also "select location form". Thanks.

Guydn · 2024-08-15T16:05:29Z

Yes I get directly the french translation ...

The Id location

The select location form

colemanw · 2024-08-17T21:30:28Z

@Guydn ok, I see the confusion. That field is "address_id" and it should not be there. I'm removing it. Sorry for the confusion.
The field you want is "Existing Location" - it is the first field in the list. Dragging a location block onto the form should now look like this:

allinappliadmin · 2024-08-19T08:01:01Z

applying the patch on 5.76.1 leads to fatal error. Many files to be patched were lacking. Should I upgrade to RC (5.77)?

colemanw · 2024-08-19T18:38:10Z

@allinappliadmin yes upgrading to the RC should help you apply the patch.

allinappliadmin · 2024-08-20T13:30:39Z

@allinappliadmin yes upgrading to the RC should help you apply the patch.

Still having a missing file notice while patching the RC

|diff --git a/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php b/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php
|index f5ed0e2af178..9e4e1b3f54a9 100644
|--- a/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php
|+++ b/tools/extensions/phpstorm/Civi/PhpStorm/Api4Generator.php

@Guydn can you test and confirm it works as expected?

colemanw · 2024-08-20T13:38:39Z

@allinappliadmin that file is not important. You can just delete it from the patch.

Guydn · 2024-08-20T14:08:22Z

I cannot input anything in the field "location Id" (5.77 beta1, WP 6.6.1)

Guydn · 2024-08-21T06:54:01Z

On another environment (Civi 5.73, WP 6.6) managed by @mlutfy the patch works (good news !) but this patch was complex to implement.

colemanw · 2024-08-21T12:22:37Z

Ok great, thanks @Guydn and @mlutfy. Indeed this is a big changeset, but it includes lots of test coverage so let's get this merged so you don't have to deal with complex patches anymore!

Guydn · 2024-08-22T07:22:37Z

Thanks a lot @colemanw it works well now on wpmaster :-) !

Guydn · 2024-09-16T08:06:53Z

I have discovered a issue (Wpmaster 5.79 Alpha1) that is critical to use the feature https://lab.civicrm.org/dev/core/-/issues/5465

civibot bot added the master label May 6, 2024

colemanw force-pushed the afformLocBlock branch from cd045df to 7da67b6 Compare May 7, 2024 11:57

jitendrapurohit reviewed May 14, 2024

View reviewed changes

colemanw added 4 commits August 6, 2024 13:33

APIv4 - Add getRefCountTotal() helper function

da8d6c7

APIv4 - LocBlock: enable saving joined entities using dot notation

0dc932d

It's already possible to read fields in this format so it makes sense to be able to write them this way too.

Afform - fix test teardown

b350452

Afform - Add support for saving event location

95975f4

colemanw force-pushed the afformLocBlock branch 2 times, most recently from 7fdff5c to e5dbfd5 Compare August 10, 2024 17:40

colemanw added 2 commits August 10, 2024 16:36

Afform - Refactor prefill to use arrays keyed by matchField instead o…

cce210b

…f a matchField param

Afform - Support autocomplete+prefill of joined entities

e5dbfd5

Afform - Exclude LocBlock fields that will be replaced by joins

ce7d792

colemanw force-pushed the afformLocBlock branch from 8dca139 to ce7d792 Compare August 18, 2024 10:35

colemanw added the has-test label Aug 21, 2024

colemanw merged commit b390236 into civicrm:master Aug 21, 2024
1 check passed

colemanw deleted the afformLocBlock branch August 21, 2024 12:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

dev/core#5053 Afform - Add support for saving event location #30140

dev/core#5053 Afform - Add support for saving event location #30140

colemanw commented May 6, 2024

civibot bot commented May 6, 2024

civibot bot commented May 6, 2024

mattwire commented May 7, 2024

mattwire commented May 7, 2024

colemanw commented May 7, 2024

jitendrapurohit May 14, 2024

Guydn commented May 20, 2024

colemanw commented May 20, 2024

Guydn commented May 20, 2024

colemanw commented Aug 10, 2024

Guydn commented Aug 10, 2024

allinappliadmin commented Aug 12, 2024 •

edited

Loading

colemanw commented Aug 12, 2024

allinappliadmin commented Aug 12, 2024

colemanw commented Aug 14, 2024

Guydn commented Aug 15, 2024 •

edited

Loading

colemanw commented Aug 15, 2024

Guydn commented Aug 15, 2024 •

edited

Loading

colemanw commented Aug 17, 2024

allinappliadmin commented Aug 19, 2024

colemanw commented Aug 19, 2024

allinappliadmin commented Aug 20, 2024

colemanw commented Aug 20, 2024

Guydn commented Aug 20, 2024

Guydn commented Aug 21, 2024

colemanw commented Aug 21, 2024

Guydn commented Aug 22, 2024

Guydn commented Sep 16, 2024

dev/core#5053 Afform - Add support for saving event location #30140

dev/core#5053 Afform - Add support for saving event location #30140

Conversation

colemanw commented May 6, 2024

Overview

Before

After

civibot bot commented May 6, 2024

civibot bot commented May 6, 2024

mattwire commented May 7, 2024

mattwire commented May 7, 2024

colemanw commented May 7, 2024

jitendrapurohit May 14, 2024

Choose a reason for hiding this comment

Guydn commented May 20, 2024

colemanw commented May 20, 2024

Guydn commented May 20, 2024

colemanw commented Aug 10, 2024

Guydn commented Aug 10, 2024

allinappliadmin commented Aug 12, 2024 • edited Loading

colemanw commented Aug 12, 2024

allinappliadmin commented Aug 12, 2024

colemanw commented Aug 14, 2024

Guydn commented Aug 15, 2024 • edited Loading

colemanw commented Aug 15, 2024

Guydn commented Aug 15, 2024 • edited Loading

colemanw commented Aug 17, 2024

allinappliadmin commented Aug 19, 2024

colemanw commented Aug 19, 2024

allinappliadmin commented Aug 20, 2024

colemanw commented Aug 20, 2024

Guydn commented Aug 20, 2024

Guydn commented Aug 21, 2024

colemanw commented Aug 21, 2024

Guydn commented Aug 22, 2024

Guydn commented Sep 16, 2024

allinappliadmin commented Aug 12, 2024 •

edited

Loading

Guydn commented Aug 15, 2024 •

edited

Loading

Guydn commented Aug 15, 2024 •

edited

Loading