Add support for custom range key and refactor addRange in a trait #2227
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
|
Hi @SosthenG Sorry for the late reply. I'm currently on holidays but try to take a look at this rather soonish. |
ruflin
approved these changes
Oct 21, 2024
| * | ||
| * @return $this | ||
| */ | ||
| public function addRange(?string $fromValue = null, ?string $toValue = null): self | ||
| public function addMaskRange(string $mask, ?string $key = null): self |
There was a problem hiding this comment.
This is an additional change not directly tied to the trait is my understanding?
There was a problem hiding this comment.
Yes I did that as well because my original goal was to add support for the key option and the mask range was missing it too.
|
Thanks for the contribution! |
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.
IpRange and GeoDistance aggregations were missing the ability to specify a custom key for a range.
As it was already done for the Range aggregation, I moved that to a trait that is now used everywhere we need
addRange.For the IpRange aggregation, I also added the key option to the
addMaskRangemethod.The only drawback with this refactoring is that the arguments of the trait have to allow string|int|float|null to be usable everywhere and we loose some phpdoc details on the arguments. In my opinion, people using this should already know what format is expected and can always check the doc so I personally prefer to have the code deduplicated, but if you disagree I can change it back to add the key everywhere without using a common trait.