SearchKit - proper EntityRef joins #26192
Merged
Conversation
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
|
(Standard links)
|
MegaphoneJon
force-pushed
the
entity-ref-joins
branch
from
e596421 to
3325075
Compare
colemanw
reviewed
May 10, 2023
| @@ -366,6 +366,24 @@ public static function getJoins(array $allowedEntities):array { | |||
| } | |||
| } | |||
| } | |||
| // Custom EntityRef joins | |||
There was a problem hiding this comment.
@MegaphoneJon did you happen to notice what in the above code stops it from working for custom fields already? I would have thought their metadata would have triggered it to include them since they do declare a fk_entity like other fields.
There was a problem hiding this comment.
@colemanw I'm not sure which of places you mean by "above code", but:
- Line 329 references
fk_entitybut is in anif ($bridge)conditional. - Lines 273-319 handle non-bridge joins, but only loops through
$references. Since$referencescomes from$dao::getReferenceColumns()it doesn't handle custom fields. addImplicitFKFields()works correctly (because of your work on SearchKit - Fix handling of new Custom EntityReference fields #25927), but onlygetJoins()modifies$joins. This leaves a scenario where you can hackcivicrm_saved_search.api_paramsto retrieve the fields you want - but you can't select the joins in the SK UI.
There was a problem hiding this comment.
Ah, makes sense. Ok.
Thanks for adding a test.
|
This is planned to be released with 5.63.0, just noting for documentation. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
#25927 improved the state of EntityRef custom fields in SearchKit, but didn't allow displaying fields in the joined table other than the primary key. This allows a proper join to EntityRef records.
To replicate
Before
You can see only the ID and pseudoconstant lookup of the EntityRef.
After
You can join fully to the EntityRef record, and join to the referenced record as usual.
Comments
This join is in one direction only - because I don't see a good way to join to a custom field. You'd have to join from Contact to Contribution, then Contribution to custom field table.