Indexes::search() improvements

[Guikingone]

Hi everyone 👋

As mentioned here: #119, here's the SearchResult class and the improvements that comes with it.

There's just a small "DX" way that I'm not sure about:

• When using SearchResult::filter() should the hits array be reset to 0 or stay as it?

IMO, the array could stays as it as we return a new SearchResult object but sometimes, it could be good idea to reset the keys from 0 (loops, etc) 🤔

Thanks for the feedback and have a great day 🙂

[curquiza]

Hello @Guikingone! So sorry for the delay!!!
The integration team is mostly ok with this change! 😄
I just need a final discussion with the developer relation manager before reviewing and merging this PR: indeed, we would apply this change in other SDKs (ruby, python...), that's why I want to be sure before taking this kind of decision that differs from Algolia!
Thanks again for your patience and your suggestion -> that's exactly the kind of solution I was looking for to help users managing their search results!

[Guikingone]

Hello @curquiza 👋

The checks are green after a small refactoring, feel free to review it when you have time, I've introduced the json() method as discussed 🙂

[curquiza]

Thank you so much @Guikingone!
I review it asap! 👍

[ppshobi]

Seems good to me. Real nice touch with the tests

[curquiza]

Thanks for this huge job, I just ask for small modifications!

About your question, yes let it as it is for the moment, it seems ok for me 🙂

Again, thank you so much for your work 🙏 Be sure we are going to extend this way of handling search result to our other SDKs.

FYI: I'm not going to release right after merging this PR. I indeed need to discuss naming with my team, and most of all, another breaking PR is planned so I will do the push to Packagist after all the breaking changes are done 😇

[curquiza]

Suggested change

	if (\array_key_exists('filteringHits', $options) && \is_callable($options['filteringHits'])) {
	$searchResult = $searchResult->filter($options['filteringHits']);
	if (\array_key_exists('transformHits', $options) && \is_callable($options['transformHits'])) {
	$searchResult = $searchResult->filter($options['transformHits']);

[curquiza]

I know this is "filtering" in PHP because we use the filter method. However, in the case of MeiliSearch, I'm afraid the users are confused with the filtering of MeiliSearch -> https://docs.meilisearch.com/guides/advanced_guides/filtering.html#filtering
That's why I suggest this name. Not sure this is the best, but we'll probably change it once all my team will come back from holidays and we can discuss the new naming 🙂 (I'm not going to push the package to Packagist before of course)

[Guikingone]

Improved 🙂

[curquiza]

Finally merging! Thanks a lot @Guikingone and also @ppshobi! 🎉

bors merge

[bors]

Build succeeded:

• integration-tests (PHP 8.0)
• integration-tests (PHP 7.2)
• integration-tests (PHP 7.4)
• integration-tests (PHP 7.3)
• linter-check