add Afform Reports listing

[ufundo]

Overview

Adds a placement tag to designate certain (search) afforms as "Afform Reports". Add a listing for end users to open these reports.

Before

The only easy listing of Afforms is in the Form Builder GUI - aimed at form editors rather than users.

After

Afforms can be tagged as "Reports" using the Expose To option in Form Builder:

They are then shown in a simple listing for end users:

The listing is included in the Reports menu:

Technical Details

I've made this in a separate core extension called afform_reports.

I didn't include in the afform directory because it seems quite separate functionality - more akin to Admin UI or Search UI.

I toyed with including in civi_report - however I thought this may be useful for folks instead of standard CiviReport. I did add under the reports top menu for now.

cc @kcristiano is this what you had in mind?

[civibot]

🤖 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 🔗

[kcristiano]

Thanks @ufundo It looks like a good start. I am away this week but can test and detail out my results when I get back

[ufundo]

Added filtering on the base_module (Extension) and afform description .

If there are other filters that should be possible to add, it's just a case of specifying the right input_type in the Afform getFields metadata here: ab7699c

[ufundo]

I wanted to add an extension column to the listing. I can do it using the base_module key, but not the label for some reason.

@colemanw any idea why this doesn't work ufundo@25e97d0 ?

[colemanw]

any idea why this doesn't work

No, it certainly looks like it should. The pseudoconstant is there:

civicrm-core/ext/afform/core/Civi/Api4/Afform.php

Line 331 in 976f53f

'pseudoconstant' => ['callback' => ['CRM_Core_BAO_Managed', 'getBaseModules']],

The only other thing I can think of is that maybe the missing "suffixes" metadata is a problem? I didn't think it would be, but worth a shot to see if adding it helps:

--- a/ext/afform/core/Civi/Api4/Afform.php
+++ b/ext/afform/core/Civi/Api4/Afform.php
@@ -329,6 +329,7 @@ class Afform extends Generic\AbstractEntity {
           'description' => 'Name of extension which provides this form',
           'readonly' => TRUE,
           'pseudoconstant' => ['callback' => ['CRM_Core_BAO_Managed', 'getBaseModules']],
+          'suffixes' => ['name', 'label'],
         ];
         $fields[] = [
           'name' => 'search_displays',

[colemanw]

Nitpick: The title "Afform Reports" in the menu seems a bit programmer-ey (we don't use the word "Afform" in user-facing text). What about "Report Forms"?

[kcristiano]

Thanks for the work on this. In testing user created Search Forms have no base module and filtering on the primary Entity (contacts/participants/memberships etc) would be useful. As this list gets large we need a way for peoiple to find what they are looking for.