SearchKit - Fix pager count return value

civicrm · Jul 16, 2021 · 65ebc07 · 65ebc07
1 parent 40a8501
commit 65ebc07
Showing 1 changed file with 14 additions and 75 deletions.
diff --git a/ext/search_kit/Civi/Api4/Action/SearchDisplay/Run.php b/ext/search_kit/Civi/Api4/Action/SearchDisplay/Run.php
@@ -113,7 +113,7 @@ public function _run(\Civi\Api4\Generic\Result $result) {
         if (empty($apiParams['having'])) {
           $apiParams['select'] = [];
         }
-        if (!in_array($this->return, $apiParams)) {
+        if (!in_array($this->return, $apiParams['select'], TRUE)) {
           $apiParams['select'][] = $this->return;
         }
         unset($apiParams['orderBy'], $apiParams['limit']);
@@ -281,27 +281,6 @@ private function getSelectAliases() {
     return $result;
   }
 
-  /**
-   * Determines if a column is eligible to use an aggregate function
-   * @param string $fieldName
-   * @param string $prefix
-   * @return bool
-   */
-  private function canAggregate($fieldName, $prefix = '') {
-    $apiParams = $this->savedSearch['api_params'];
-
-    // If the query does not use grouping, never
-    if (empty($apiParams['groupBy'])) {
-      return FALSE;
-    }
-    // If the column is used for a groupBy, no
-    if (in_array($prefix . $fieldName, $apiParams['groupBy'])) {
-      return FALSE;
-    }
-    // If the entity this column belongs to is being grouped by id, then also no
-    return !in_array($prefix . 'id', $apiParams['groupBy']);
-  }
-
   /**
    * Returns field definition for a given field or NULL if not found
    * @param $fieldName
@@ -376,70 +355,30 @@ private function loadAfform() {
   }
 
   /**
-   * Adds additional useful fields to the select clause
+   * Adds additional fields to the select clause required to render the display
    *
    * @param array $apiParams
    */
   private function augmentSelectClause(&$apiParams): void {
-    foreach ($this->getExtraEntityFields($this->savedSearch['api_entity']) as $extraFieldName) {
-      if (!in_array($extraFieldName, $apiParams['select']) && !$this->canAggregate($extraFieldName)) {
-        $apiParams['select'][] = $extraFieldName;
+    foreach ($this->display['settings']['columns'] ?? [] as $column) {
+      // Add fields referenced via token
+      $possibleTokens = ($column['rewrite'] ?? '') . ($column['link']['path'] ?? '');
+      if (!empty($column['links'])) {
+        $possibleTokens .= implode('', array_column($column['links'], 'path'));
       }
-    }
-    $joinAliases = [];
-    // Select the ids, etc. of explicitly joined entities (helps with displaying links)
-    foreach ($apiParams['join'] ?? [] as $join) {
-      [$joinEntity, $joinAlias] = explode(' AS ', $join[0]);
-      $joinAliases[] = $joinAlias;
-      foreach ($this->getExtraEntityFields($joinEntity) as $extraField) {
-        $extraFieldName = $joinAlias . '.' . $extraField;
-        if (!in_array($extraFieldName, $apiParams['select']) && !$this->canAggregate($extraField, $joinAlias . '.')) {
-          $apiParams['select'][] = $extraFieldName;
+      $tokens = [];
+      preg_match_all('/\\[([^]]+)\\]/', $possibleTokens, $tokens);
+      foreach ($tokens[1] ?? [] as $fieldName) {
+        if (!in_array($fieldName, $apiParams['select'])) {
+          $apiParams['select'][] = $fieldName;
         }
       }
-    }
-    // Select the ids of implicitly joined entities (helps with displaying links)
-    foreach ($apiParams['select'] as $fieldName) {
-      if (strstr($fieldName, '.') && !strstr($fieldName, ' AS ') && !strstr($fieldName, ':')) {
-        $idFieldName = $fieldNameWithoutPrefix = substr($fieldName, 0, strrpos($fieldName, '.'));
-        $idField = $this->getField($idFieldName);
-        $explicitJoin = '';
-        if (strstr($idFieldName, '.')) {
-          [$prefix, $fieldNameWithoutPrefix] = explode('.', $idFieldName, 2);
-          if (in_array($prefix, $joinAliases, TRUE)) {
-            $explicitJoin = $prefix . '.';
-          }
-        }
-        if (!in_array($idFieldName, $apiParams['select']) && !empty($idField['fk_entity']) && !$this->canAggregate($fieldNameWithoutPrefix, $explicitJoin)) {
-          $apiParams['select'][] = $idFieldName;
-        }
-      }
-    }
-    // Select value fields for in-place editing
-    foreach ($this->display['settings']['columns'] ?? [] as $column) {
+
+      // Select value fields for in-place editing
       if (isset($column['editable']['value']) && !in_array($column['editable']['value'], $apiParams['select'])) {
         $apiParams['select'][] = $column['editable']['value'];
       }
     }
   }
 
-  /**
-   * Get list of extra fields needed for displaying links for a given entity
-   *
-   * @param string $entityName
-   * @return array
-   */
-  private function getExtraEntityFields(string $entityName): array {
-    if (!isset($this->_extraEntityFields[$entityName])) {
-      $id = CoreUtil::getInfoItem($entityName, 'primary_key');
-      $this->_extraEntityFields[$entityName] = $id;
-      foreach (CoreUtil::getInfoItem($entityName, 'paths') ?? [] as $path) {
-        $matches = [];
-        preg_match_all('#\[(\w+)]#', $path, $matches);
-        $this->_extraEntityFields[$entityName] = array_unique(array_merge($this->_extraEntityFields[$entityName], $matches[1] ?? []));
-      }
-    }
-    return $this->_extraEntityFields[$entityName];
-  }
-
 }