Skip to main content
Back to packages
399 GitHub stars

Jeroen-G/Explorer

View on GitHub

Description

Next-gen Elasticsearch driver for Laravel Scout with the power of Elasticsearch's queries.

You may either define the mapping for you index in the config file:

return [
'indexes' => [
'posts_index' => [
'properties' => [
'id' => 'keyword',
'title' => 'text',
],
]
]
];

Or you may define the model for the index, and the rest will be decided for you:

return [
'indexes' => [
\App\Models\Post::class
],
];

In the last case you may implement the Explored interface and overwrite the mapping with the mappableAs() function.

Essentially this means that it is up to you whether you like having it all together in the model, or separately in the config file.

Advanced queries

The documentation of Laravel Scout states that "more advanced "where" clauses are not currently supported". Only a simple check for ID is possible besides the standard fuzzy term search:

$posts = Post::search('lorem ipsum')->get();

Explorer expands your possibilities using query builders to write more complex queries.

For example, to get all posts that:

  • are published
  • have "lorem" somewhere in the document
  • have "ipsum" in the title
  • maybe have a tag "featured", if so boost its score by 2

You could execute this search query:

$posts = Post::search('lorem')
->must(new Matching('title', 'ipsum'))
->should(new Terms('tags', ['featured'], 2))
->filter(new Term('published', true))
->get();

Recent Courses on Laravel Daily

We'd Love Your Feedback

Tell us what you like or what we can improve

Feel free to share anything you like or dislike about this page or the platform in general.