-
-
Notifications
You must be signed in to change notification settings - Fork 827
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #19585 from colemanw/searchKitApi
Search Kit - Use wrapper api to run searches
- Loading branch information
Showing
24 changed files
with
523 additions
and
211 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
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
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,211 @@ | ||
| <?php | ||
|
|
||
| namespace Civi\Api4\Action\SearchDisplay; | ||
|
|
||
| use Civi\API\Exception\UnauthorizedException; | ||
| use Civi\Api4\SavedSearch; | ||
| use Civi\Api4\SearchDisplay; | ||
|
|
||
| /** | ||
| * Load the results for rendering a SearchDisplay. | ||
| * | ||
| * @package Civi\Api4\Action\SearchDisplay | ||
| */ | ||
| class Run extends \Civi\Api4\Generic\AbstractAction { | ||
|
|
||
| /** | ||
| * Either the name of the savedSearch or an array containing the savedSearch definition (for preview mode) | ||
| * @var string|array | ||
| * @required | ||
| */ | ||
| protected $savedSearch; | ||
|
|
||
| /** | ||
| * Either the name of the display or an array containing the display definition (for preview mode) | ||
| * @var string|array | ||
| * @required | ||
| */ | ||
| protected $display; | ||
|
|
||
| /** | ||
| * Array of fields to use for ordering the results | ||
| * @var array | ||
| */ | ||
| protected $sort; | ||
|
|
||
| /** | ||
| * Should this api call return a page of results or the row_count or the ids | ||
| * E.g. "page:1" or "row_count" or "id" | ||
| * @var string | ||
| */ | ||
| protected $return; | ||
|
|
||
| private $_selectQuery; | ||
|
|
||
| /** | ||
| * Search conditions that will be automatically added to the WHERE or HAVING clauses | ||
| * @var array | ||
| */ | ||
| protected $filters = []; | ||
|
|
||
| /** | ||
| * @param \Civi\Api4\Generic\Result $result | ||
| * @throws UnauthorizedException | ||
| * @throws \API_Exception | ||
| */ | ||
| public function _run(\Civi\Api4\Generic\Result $result) { | ||
| // Only administrators can use this in unsecured "preview mode" | ||
| if (!(is_string($this->savedSearch) && is_string($this->display)) && $this->checkPermissions && !\CRM_Core_Permission::check('administer CiviCRM')) { | ||
| throw new UnauthorizedException('Access denied'); | ||
| } | ||
| if (is_string($this->savedSearch)) { | ||
| $this->savedSearch = SavedSearch::get(FALSE) | ||
| ->addWhere('name', '=', $this->savedSearch) | ||
| ->execute()->first(); | ||
| } | ||
| if (is_string($this->display)) { | ||
| $this->display = SearchDisplay::get(FALSE) | ||
| ->addWhere('name', '=', $this->display) | ||
| ->addWhere('saved_search_id', '=', $this->savedSearch['id']) | ||
| ->execute()->first(); | ||
| } | ||
| $entityName = $this->savedSearch['api_entity']; | ||
| $apiParams =& $this->savedSearch['api_params']; | ||
| $settings = $this->display['settings']; | ||
| $page = NULL; | ||
|
|
||
| switch ($this->return) { | ||
| case 'row_count': | ||
| case 'id': | ||
| if (empty($apiParams['having'])) { | ||
| $apiParams['select'] = []; | ||
| } | ||
| if (!in_array($this->return, $apiParams)) { | ||
| $apiParams['select'][] = $this->return; | ||
| } | ||
| unset($apiParams['orderBy'], $apiParams['limit']); | ||
| break; | ||
|
|
||
| default: | ||
| if (!empty($settings['pager']) && preg_match('/^page:\d+$/', $this->return)) { | ||
| $page = explode(':', $this->return)[1]; | ||
| } | ||
| $apiParams['limit'] = $settings['limit'] ?? NULL; | ||
| $apiParams['offset'] = $page ? $apiParams['limit'] * ($page - 1) : 0; | ||
| $apiParams['orderBy'] = $this->getOrderByFromSort(); | ||
|
|
||
| // Select the ids of joined entities (helps with displaying links) | ||
| foreach ($apiParams['join'] ?? [] as $join) { | ||
| $joinEntity = explode(' AS ', $join[0])[1]; | ||
| $idField = $joinEntity . '.id'; | ||
| if (!in_array($idField, $apiParams['select']) && !$this->canAggregate('id', $joinEntity . '.')) { | ||
| $apiParams['select'][] = $idField; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| $this->applyFilters(); | ||
|
|
||
| $apiResult = civicrm_api4($entityName, 'get', $apiParams); | ||
|
|
||
| $result->rowCount = $apiResult->rowCount; | ||
| $result->exchangeArray($apiResult->getArrayCopy()); | ||
| } | ||
|
|
||
| /** | ||
| * Applies supplied filters to the where clause | ||
| */ | ||
| private function applyFilters() { | ||
| // Global setting determines if % wildcard should be added to both sides (default) or only the end of the search term | ||
| $prefixWithWildcard = \Civi::settings()->get('includeWildCardInName'); | ||
|
|
||
| foreach ($this->filters as $fieldName => $value) { | ||
| if ($value) { | ||
| $field = $this->getField($fieldName) ?? []; | ||
| $dataType = $field['data_type'] ?? NULL; | ||
|
|
||
| if (!empty($field['serialize'])) { | ||
| $this->savedSearch['api_params']['where'][] = [$fieldName, 'CONTAINS', $value]; | ||
| } | ||
| elseif (!empty($field['options']) || in_array($dataType, ['Integer', 'Boolean', 'Date', 'Timestamp'])) { | ||
| $this->savedSearch['api_params']['where'][] = [$fieldName, '=', $value]; | ||
| } | ||
| elseif ($prefixWithWildcard) { | ||
| $this->savedSearch['api_params']['where'][] = [$fieldName, 'CONTAINS', $value]; | ||
| } | ||
| else { | ||
| $this->savedSearch['api_params']['where'][] = [$fieldName, 'LIKE', $value . '%']; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Transforms the SORT param (which is expected to be an array of arrays) | ||
| * to the ORDER BY clause (which is an associative array of [field => DIR] | ||
| * | ||
| * @return array | ||
| */ | ||
| private function getOrderByFromSort() { | ||
| $defaultSort = $this->display['settings']['sort'] ?? []; | ||
| $currentSort = $this->sort; | ||
|
|
||
| // Validate that requested sort fields are part of the SELECT | ||
| foreach ($this->sort as $item) { | ||
| if (!in_array($item[0], $this->getSelectAliases())) { | ||
| $currentSort = NULL; | ||
| } | ||
| } | ||
|
|
||
| $orderBy = []; | ||
| foreach ($currentSort ?: $defaultSort as $item) { | ||
| $orderBy[$item[0]] = $item[1]; | ||
| } | ||
| return $orderBy; | ||
| } | ||
|
|
||
| /** | ||
| * Returns an array of field names or aliases from the SELECT clause | ||
| * @return string[] | ||
| */ | ||
| private function getSelectAliases() { | ||
| return array_map(function($select) { | ||
| return array_slice(explode(' AS ', $select), -1)[0]; | ||
| }, $this->savedSearch['api_params']['select']); | ||
| } | ||
|
|
||
| /** | ||
| * Determines if a column is eligible to use an aggregate function | ||
| * @param $fieldName | ||
| * @param $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 | ||
| * @return array|null | ||
| */ | ||
| private function getField($fieldName) { | ||
| if (!$this->_selectQuery) { | ||
| $api = \Civi\API\Request::create($this->savedSearch['api_entity'], 'get', $this->savedSearch['api_params']); | ||
| $this->_selectQuery = new \Civi\Api4\Query\Api4SelectQuery($api); | ||
| } | ||
| return $this->_selectQuery->getField($fieldName, FALSE); | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.