PHPORM-275 PHPORM-276 Add `Query\Builder::search()` and `autocomplete()` #3232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

GromNaN merged 7 commits into mongodb:5.x from GromNaN:PHPORM-275

Jan 6, 2025

Merged

PHPORM-275 PHPORM-276 Add `Query\Builder::search()` and `autocomplete()` #3232

GromNaN merged 7 commits into mongodb:5.x from GromNaN:PHPORM-275

Jan 6, 2025

Conversation

@GromNaN

Copy link

Member

@GromNaN GromNaN commented Dec 23, 2024 •

edited

Loading

Fix PHPORM-275 and PHPORM-276

Checklist

Add tests and ensure they pass
Model::search() returns a collection of model instances
Rebase on PHPORM-274 List search indexes in Schema::getIndexes() introspection method #3233

@GromNaN GromNaN force-pushed the PHPORM-275 branch from 38d0ee4 to 7bf4f2d Compare

December 27, 2024 14:18

@GromNaN GromNaN mentioned this pull request

Dec 31, 2024

PHPORM-274 List search indexes in Schema::getIndexes() introspection method #3233

Merged

@GromNaN GromNaN force-pushed the PHPORM-275 branch from 74d3005 to 132a773 Compare

January 2, 2025 14:05

@GromNaN GromNaN changed the title ~~(削除) PHPORM-275 Add Builder::search() (削除ここまで)~~ (追記) PHPORM-275 PHPORM-276 Add Query\Builder::search() and autocomplete() (追記ここまで)

Jan 2, 2025

@GromNaN GromNaN marked this pull request as ready for review

January 2, 2025 14:38

@GromNaN GromNaN requested a review from a team as a code owner

January 2, 2025 14:38

@GromNaN GromNaN requested a review from jmikola

January 2, 2025 14:38

@GromNaN GromNaN force-pushed the PHPORM-275 branch from cdd7c53 to 905ee37 Compare

January 2, 2025 18:13

jmikola

jmikola reviewed

Jan 2, 2025

View reviewed changes

src/Eloquent/Builder.php Show resolved Hide resolved

src/Eloquent/Builder.php

?bool $returnStoredSource = null,

?array $tracking = null,

) {

$results = $this->toBase()->search($operator, $index, $highlight, $concurrent, $count, $searchAfter, $searchBefore, $scoreDetails, $sort, $returnStoredSource, $tracking);

Copy link

Member

@jmikola jmikola Jan 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noted the @method \MongoDB\Laravel\Query\Builder toBase() annotation on this class but I'm failing to see how toBase() actually returns this library's class instead of Illuminate\Database\Query\Builder. I imagine there's some magic or trait involved that isn't clear.

Noted this probably has nothing to do with the PR, so feel free to ignore this complaint.

src/Eloquent/Builder.php Outdated Show resolved Hide resolved

src/Query/Builder.php Outdated Show resolved Hide resolved

src/Query/Builder.php

}

/** @return Collection<string> */

public function autocomplete(string $path, string $query, bool|array $fuzzy = false, string $tokenOrder = 'any'): Collection

Copy link

Member

@jmikola jmikola Jan 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're going to document the search() params, it'd probably make sense to do so for these as well. Alternatively, link to https://www.mongodb.com/docs/atlas/atlas-search/autocomplete/ or some other relevant documentation.