SearchKit/Afform - Provide contextual titles to search Afforms in sta…

…ndalone mode When displaying a full-page search with contextual filters, e.g. submissions for a particular form, provides a contextual title based on the url filter arg, e.g. "My Great Form Submissions"
colemanw · Dec 26, 2021 · 007167d · 007167d
1 parent e3d2783
commit 007167d
Show file tree

Hide file tree

Showing 14 changed files with 128 additions and 22 deletions.
diff --git a/ang/crmUi.js b/ang/crmUi.js
@@ -1083,15 +1083,20 @@
           function update() {
             $timeout(function() {
               var newPageTitle = _.trim($el.html()),
-                newDocumentTitle = scope.crmDocumentTitle || $el.text();
+                newDocumentTitle = scope.crmDocumentTitle || $el.text(),
+                h1Count = 0;
               document.title = $('title').text().replace(documentTitle, newDocumentTitle);
               // If the CMS has already added title markup to the page, use it
               $('h1').not('.crm-container h1').each(function() {
-                if (_.trim($(this).html()) === pageTitle) {
+                if ($(this).hasClass('crm-page-title') || _.trim($(this).html()) === pageTitle) {
                   $(this).addClass('crm-page-title').html(newPageTitle);
                   $el.hide();
+                  ++h1Count;
                 }
               });
+              if (!h1Count) {
+                $el.show();
+              }
               pageTitle = newPageTitle;
               documentTitle = newDocumentTitle;
             });

diff --git a/ext/afform/admin/ang/afAdminFormSubmissionList.aff.html b/ext/afform/admin/ang/afAdminFormSubmissionList.aff.html
@@ -1,9 +1,3 @@
-<div
-  ng-if="routeParams.name"
-  af-api4="['Afform', 'get', {select: ['title'], where: [['name', '=', routeParams.name]]}, 0]"
-  af-api4-ctrl="api4">
-  <h2>{{ ts('%1 Submissions', {1: api4.result.title || ts('Loading')}) }}</h2>
-</div>
 <div af-fieldset="">
   <crm-search-display-table search-name="AfAdmin_Submission_List" display-name="AfAdmin_Submission_List_Display" filters="{afform_name: routeParams.name}">
   </crm-search-display-table>

diff --git a/ext/afform/admin/ang/afAdminFormSubmissionList.aff.json b/ext/afform/admin/ang/afAdminFormSubmissionList.aff.json
@@ -1,6 +1,6 @@
 {
     "type": "search",
-    "title": "Form Submissions",
+    "title": "Submissions",
     "server_route": "civicrm/admin/afform/submissions",
     "permission": "administer CiviCRM"
 }
diff --git a/ext/afform/core/CRM/Afform/Page/AfformBase.php b/ext/afform/core/CRM/Afform/Page/AfformBase.php
@@ -40,7 +40,6 @@ public function run() {
 
     if (!empty($afform['title'])) {
       $title = strip_tags($afform['title']);
-      CRM_Utils_System::setTitle($title);
       if (!$isFrontEndPage) {
         CRM_Utils_System::appendBreadCrumb([
           [

diff --git a/ext/afform/core/afform.php b/ext/afform/core/afform.php
@@ -337,7 +337,7 @@ function afform_civicrm_buildAsset($asset, $params, &$mimeType, &$content) {
   $moduleName = _afform_angular_module_name($params['name'], 'camel');
   $formMetaData = (array) civicrm_api4('Afform', 'get', [
     'checkPermissions' => FALSE,
-    'select' => ['redirect', 'name'],
+    'select' => ['redirect', 'name', 'title'],
     'where' => [['name', '=', $params['name']]],
   ], 0);
   $smarty = CRM_Core_Smarty::singleton();
@@ -366,7 +366,6 @@ function afform_civicrm_alterMenu(&$items) {
       $items[$meta['server_route']] = [
         'page_callback' => 'CRM_Afform_Page_AfformBase',
         'page_arguments' => 'afform=' . urlencode($name),
-        'title' => $meta['title'] ?? '',
         'access_arguments' => [["@afform:$name"], 'and'],
         'is_public' => $meta['is_public'],
       ];

diff --git a/ext/afform/core/ang/afCore.js b/ext/afform/core/ang/afCore.js
@@ -21,6 +21,14 @@
           $scope.$watch(function() {return $location.search();}, function(params) {
             $scope.routeParams = params;
           });
+
+          $scope.$parent.afformTitle = meta.title;
+
+          // Prepends a string to the afform title
+          // Provides contextual titles to search Afforms in standalone mode
+          $scope.addTitle = function(addition) {
+            $scope.$parent.afformTitle = addition + ' ' + meta.title;
+          };
         }
       };
       return d;

diff --git a/ext/afform/core/ang/afformStandalone.js b/ext/afform/core/ang/afformStandalone.js
@@ -1,5 +1,9 @@
 (function(angular, $, _) {
   // Empty module just loads all available modules.
-  angular.module('afformStandalone', CRM.angular.modules);
+  angular.module('afformStandalone', CRM.angular.modules)
+
+    .controller('AfformStandalonePageCtrl', function($scope) {
+      $scope.afformTitle = '';
+    });
 
 })(angular, CRM.$, CRM._);
diff --git a/ext/afform/core/templates/CRM/Afform/Page/AfformBase.tpl b/ext/afform/core/templates/CRM/Afform/Page/AfformBase.tpl
@@ -1,5 +1,8 @@
 <crm-angular-js modules="afformStandalone">
-  <form id="bootstrap-theme">
+  <form id="bootstrap-theme" ng-controller="AfformStandalonePageCtrl">
+    {literal}
+      <h1 style="display: none" crm-page-title ng-if="afformTitle">{{ afformTitle }}</h1>
+    {/literal}
     <{$directive}></{$directive}>
   </form>
 </crm-angular-js>
diff --git a/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php b/ext/search_kit/Civi/Api4/Action/SearchDisplay/AbstractRunAction.php
@@ -48,6 +48,14 @@ abstract class AbstractRunAction extends \Civi\Api4\Generic\AbstractAction {
    */
   protected $filters = [];
 
+  /**
+   * Filters passed directly into this display via Afform markup
+   * will have their labels appended to the Afform title.
+   *
+   * @var array
+   */
+  protected $filterLabels = [];
+
   /**
    * Integer used as a seed when ordering by RAND().
    * This keeps the order stable enough to use a pager with random sorting.
@@ -67,6 +75,14 @@ abstract class AbstractRunAction extends \Civi\Api4\Generic\AbstractAction {
    */
   private $_afform;
 
+  /**
+   * Override execute method to change the result object type
+   * @return \Civi\Api4\Result\SearchDisplayRunResult
+   */
+  public function execute() {
+    return parent::execute();
+  }
+
   /**
    * @param \Civi\Api4\Generic\Result $result
    * @throws UnauthorizedException
@@ -105,7 +121,7 @@ public function _run(\Civi\Api4\Generic\Result $result) {
     $this->processResult($result);
   }
 
-  abstract protected function processResult(\Civi\Api4\Generic\Result $result);
+  abstract protected function processResult(\Civi\Api4\Result\SearchDisplayRunResult $result);
 
   /**
    * Transforms each row into an array of raw data and an array of formatted columns
@@ -587,7 +603,8 @@ protected function formatViewValue($key, $rawValue) {
    */
   protected function applyFilters() {
     // Allow all filters that are included in SELECT clause or are fields on the Afform.
-    $allowedFilters = array_merge($this->getSelectAliases(), $this->getAfformFilters());
+    $afformFilters = $this->getAfformFilters();
+    $allowedFilters = array_merge($this->getSelectAliases(), $afformFilters);
 
     // Ignore empty strings
     $filters = array_filter($this->filters, [$this, 'hasValue']);
@@ -600,6 +617,9 @@ protected function applyFilters() {
       if (in_array($key, $allowedFilters, TRUE) || !array_diff($fieldNames, $allowedFilters)) {
         $this->applyFilter($fieldNames, $value);
       }
+      if (in_array($key, $afformFilters, TRUE)) {
+        $this->addFilterLabel($key, $value);
+      }
     }
   }
 
@@ -941,4 +961,45 @@ public static function getPseudoFields(): array {
     ];
   }
 
+  /**
+   * Sets $this->filterLabels to provide contextual titles to search Afforms
+   *
+   * @param $fieldName
+   * @param $value
+   * @throws \API_Exception
+   * @throws \Civi\API\Exception\NotImplementedException
+   */
+  private function addFilterLabel($fieldName, $value) {
+    $field = $this->getField($fieldName);
+    if (!$field || !$value) {
+      return;
+    }
+    $idField = CoreUtil::getIdFieldName($field['entity']);
+    if ($field['name'] === $idField) {
+      $field['fk_entity'] = $field['entity'];
+    }
+    if (!empty($field['options'])) {
+      $options = civicrm_api4($field['entity'], 'getFields', [
+        'loadOptions' => TRUE,
+        'where' => [['name', '=', $field['name']]],
+      ])->first()['options'] ?? [];
+      if (!empty($options[$value])) {
+        $this->filterLabels[] = $options[$value];
+      }
+    }
+    elseif (!empty($field['fk_entity'])) {
+      $idField = CoreUtil::getIdFieldName($field['fk_entity']);
+      $labelField = CoreUtil::getInfoItem($field['fk_entity'], 'label_field');
+      if ($labelField) {
+        $record = civicrm_api4($field['fk_entity'], 'get', [
+          'where' => [[$idField, '=', $value]],
+          'select' => [$labelField],
+        ])->first() ?? NULL;
+        if (isset($record[$labelField])) {
+          $this->filterLabels[] = $record[$labelField];
+        }
+      }
+    }
+  }
+
 }
diff --git a/ext/search_kit/Civi/Api4/Action/SearchDisplay/Download.php b/ext/search_kit/Civi/Api4/Action/SearchDisplay/Download.php
@@ -46,10 +46,10 @@ class Download extends AbstractRunAction {
   ];
 
   /**
-   * @param \Civi\Api4\Generic\Result $result
+   * @param \Civi\Api4\Result\SearchDisplayRunResult $result
    * @throws \API_Exception
    */
-  protected function processResult(\Civi\Api4\Generic\Result $result) {
+  protected function processResult(\Civi\Api4\Result\SearchDisplayRunResult $result) {
     $entityName = $this->savedSearch['api_entity'];
     $apiParams =& $this->_apiParams;
     $settings = $this->display['settings'];

diff --git a/ext/search_kit/Civi/Api4/Action/SearchDisplay/Run.php b/ext/search_kit/Civi/Api4/Action/SearchDisplay/Run.php
@@ -29,10 +29,10 @@ class Run extends AbstractRunAction {
   protected $limit;
 
   /**
-   * @param \Civi\Api4\Generic\Result $result
+   * @param \Civi\Api4\Result\SearchDisplayRunResult $result
    * @throws \API_Exception
    */
-  protected function processResult(\Civi\Api4\Generic\Result $result) {
+  protected function processResult(\Civi\Api4\Result\SearchDisplayRunResult $result) {
     $entityName = $this->savedSearch['api_entity'];
     $apiParams =& $this->_apiParams;
     $settings = $this->display['settings'];
@@ -77,6 +77,7 @@ protected function processResult(\Civi\Api4\Generic\Result $result) {
     }
     else {
       $result->exchangeArray($this->formatResult($apiResult));
+      $result->labels = $this->filterLabels;
     }
 
   }

diff --git a/ext/search_kit/Civi/Api4/Result/SearchDisplayRunResult.php b/ext/search_kit/Civi/Api4/Result/SearchDisplayRunResult.php
@@ -0,0 +1,26 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\Api4\Result;
+
+/**
+ * Class ReplaceResult
+ *
+ * @package Civi\Api4\Result
+ */
+class SearchDisplayRunResult extends \Civi\Api4\Generic\Result {
+  /**
+   * @var array
+   */
+  public $labels = [];
+
+}
diff --git a/ext/search_kit/ang/crmSearchDisplay/traits/searchDisplayBaseTrait.service.js b/ext/search_kit/ang/crmSearchDisplay/traits/searchDisplayBaseTrait.service.js
@@ -62,6 +62,12 @@
 
         if (this.afFieldset) {
           $scope.$watch(this.afFieldset.getFieldData, onChangeFilters, true);
+          // Add filter title to Afform
+          this.onPostRun.push(function(results) {
+            if (results.labels && results.labels.length && $scope.$parent.addTitle) {
+              $scope.$parent.addTitle(results.labels.join(' '));
+            }
+          });
         }
         if (this.settings.pager && this.settings.pager.expose_limit) {
           $scope.$watch('$ctrl.limit', onChangePageSize);

diff --git a/ext/search_kit/ang/crmSearchTasks/traits/searchDisplayTasksTrait.service.js b/ext/search_kit/ang/crmSearchTasks/traits/searchDisplayTasksTrait.service.js
@@ -59,14 +59,14 @@
         this.runSearch();
       },
 
-      // Overwrite empty onChangeFilters array from searchDisplayBaseTrait
+      // Add onChangeFilters callback (gets merged with others via angular.extend)
       onChangeFilters: [function() {
         // Reset selection when filters are changed
         this.selectedRows.length = 0;
         this.allRowsSelected = false;
       }],
 
-      // Overwrite empty onPostRun array from searchDisplayBaseTrait
+      // Add onPostRun callback (gets merged with others via angular.extend)
       onPostRun: [function(results, status, editedRow) {
         if (editedRow && status === 'success') {
           // If edited row disappears (because edits cause it to not meet search criteria), deselect it