dev/core#1705 APIv4 - Support pseudoconstant lookups #17138
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Access field option lists via APIv4, works for both inputs and outputs (note that for APIv3 it only works for inputs).
See discussion at https://lab.civicrm.org/dev/core/-/issues/1705
Before
APIv4 could only input/output a field's raw value.
After
Adding a suffix beginning with
:
to a field name tells the api to convert the raw value to/from an option name or label. Currently supported suffixes are:name
,:label
, and:abbr
(abbr applies to a handful of fields like state_province).Technical Details
Tests include converting names of states based on the name of a country, which goes off the chainSelect metadata to tell the api which variables to replace first so e.g. we know the
country_id
before attempting to lookup the list of states.