APIv3 - Improve array-based apis to support sorting and operators #19690
Conversation
|
(Standard links)
|
api/v3/utils.php
Outdated
| if (is_array($searchValue) && count($searchValue) === 1 && in_array(array_keys($searchValue)[0], CRM_Core_DAO::acceptedSQLOperators())) { | ||
| $operator = array_keys($searchValue)[0]; | ||
| $searchValue = array_values($searchValue)[0]; | ||
| return \Civi\Api4\Generic\Traits\ArrayQueryActionTrait::filterCompare($record, [$key, $operator, $searchValue]); |
There was a problem hiding this comment.
I don't love converting this to static - could we instantiate an instance & call it with $this-> ?
There was a problem hiding this comment.
Not really, no. It's a trait. And traits can't be instantiated, nor can they be used by classless APIv3 files.
There was a problem hiding this comment.
One alternative would be copy & paste, if you're worried about future APIv4 refactoring affecting v3. But IMO we can cross that bridge later & this is ok for now.
There was a problem hiding this comment.
@colemanw honestly I'd prefer copy & paste - it's kinda contaminating the structure of what we are building for apiv4 with the needs of our legacy api
|
@eileenmcnaughton ok, copy-paste it is then. |
|
It would be an understatement to say I don't love backporting this stuff to apiv3. However, we have enough test cover specifically on this and the api in general I think the risk factor is OK and I appreciate that we just aren't quite there to run every widget on apiv4 yet |
…ators This backports some APIv4 code to v3, for the purpose of supporting entityRef widgets for Afform.
Overview
This backports some APIv4 code to v3, for the purpose of supporting entityRef widgets for Afform.
PR broken off from #19687 for easier review.
Before
Array-based apis such as Afform would have very limited support for searching and sorting.
After
Full range of search operators supported. Sorting supported.
Comments
Adds some corresponding unit test coverage.