Stars: 355
Forks: 65
Pull Requests: 323
Issues: 105
Watchers: 11
Last Updated: 2022-12-16 17:15:52
PHP wrapper for the Meilisearch API
License: MIT License
Languages: PHP, Shell, Dockerfile
Meilisearch PHP is the Meilisearch API client for PHP developers.
Meilisearch is an open-source search engine. Learn more about Meilisearch.
To learn more about Meilisearch PHP, refer to the in-depth Meilisearch PHP Documentation. To learn more about Meilisearch in general, refer to our documentation or our API reference.
To get started, simply require the project using Composer.
You will also need to install packages that "provide" psr/http-client-implementation
and psr/http-factory-implementation
.
A list with compatible HTTP clients and client adapters can be found at php-http.org.
If you don't know which HTTP client to use, we recommend using Guzzle 7:
composer require meilisearch/meilisearch-php guzzlehttp/guzzle http-interop/http-factory-guzzle:^1.0
Here is an example of installation with the symfony/http-client
:
composer require meilisearch/meilisearch-php symfony/http-client nyholm/psr7:^1.0
There are many easy ways to download and run a Meilisearch instance.
For example, using the curl
command in your Terminal:
#Install Meilisearch
curl -L https://install.meilisearch.com | sh
# Launch Meilisearch
./meilisearch --master-key=masterKey
NB: you can also download Meilisearch from Homebrew or APT or even run it using Docker.
<?php
require_once __DIR__ . '/vendor/autoload.php';
use Meilisearch\Client;
$client = new Client('http://127.0.0.1:7700', 'masterKey');
# An index is where the documents are stored.
$index = $client->index('movies');
$documents = [
['id' => 1, 'title' => 'Carol', 'genres' => ['Romance, Drama']],
['id' => 2, 'title' => 'Wonder Woman', 'genres' => ['Action, Adventure']],
['id' => 3, 'title' => 'Life of Pi', 'genres' => ['Adventure, Drama']],
['id' => 4, 'title' => 'Mad Max: Fury Road', 'genres' => ['Adventure, Science Fiction']],
['id' => 5, 'title' => 'Moana', 'genres' => ['Fantasy, Action']],
['id' => 6, 'title' => 'Philadelphia', 'genres' => ['Drama']],
];
# If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
$index->addDocuments($documents); // => { "uid": 0 }
With the uid
, you can check the status (enqueued
, processing
, succeeded
or failed
) of your documents addition using the task.
// Meilisearch is typo-tolerant:
$hits = $index->search('wondre woman')->getHits();
print_r($hits);
Output:
Array
(
[0] => Array
(
[id] => 2
[title] => Wonder Woman
[genres] => Array
(
[0] => Action, Adventure
)
)
)
All the supported options are described in the search parameters section of the documentation.
search()
method in the Wiki.
$index->search(
'phil',
[
'attributesToHighlight' => ['*'],
]
)->getRaw(); // Return in Array format
JSON output:
{
"hits": [
{
"id": 6,
"title": "Philadelphia",
"genre": ["Drama"],
"_formatted": {
"id": 6,
"title": "<em>Phil</em>adelphia",
"genre": ["Drama"]
}
}
],
"offset": 0,
"limit": 20,
"processingTimeMs": 0,
"query": "phil"
}
If you want to enable filtering, you must add your attributes to the filterableAttributes
index setting.
$index->updateFilterableAttributes([
'id',
'genres'
]);
You only need to perform this operation once.
Note that Meilisearch will rebuild your index whenever you update filterableAttributes
. Depending on the size of your dataset, this might take time. You can track the process using the tasks).
Then, you can perform the search:
$index->search(
'wonder',
[
'filter' => ['id > 1 AND genres = Action']
]
);
{
"hits": [
{
"id": 2,
"title": "Wonder Woman",
"genres": ["Action","Adventure"]
}
],
"offset": 0,
"limit": 20,
"estimatedTotalHits": 1,
"processingTimeMs": 0,
"query": "wonder"
}
This package only guarantees the compatibility with the version v0.30.0 of Meilisearch.
The following sections in our main documentation website may interest you:
You could use any PSR-18 compatible client to use with this SDK. No additional configurations are required.
A list of compatible HTTP clients and client adapters can be found at php-http.org.
If you want to use this meilisearch-php
:
guzzlehttp/guzzle
(Guzzle 7), run:composer require meilisearch/meilisearch-php guzzlehttp/guzzle http-interop/http-factory-guzzle:^1.0
php-http/guzzle6-adapter
(Guzzle < 7), run:composer require meilisearch/meilisearch-php php-http/guzzle6-adapter:^2.0 http-interop/http-factory-guzzle:^1.0
symfony/http-client
, run:composer require meilisearch/meilisearch-php symfony/http-client nyholm/psr7:^1.0
php-http/curl-client
, run:composer require meilisearch/meilisearch-php php-http/curl-client nyholm/psr7:^1.0
kriswallsmith/buzz
, run:composer require meilisearch/meilisearch-php kriswallsmith/buzz nyholm/psr7:^1.0
For some reason, you might want to pass a custom configuration to your own HTTP client.
Make sure you have a PSR-18 compatible client when you initialize the Meilisearch client.
Following the example in the Getting started section, with the Guzzle HTTP client:
new Client('http://127.0.0.1:7700', 'masterKey', new GuzzleHttpClient(['timeout' => 2]));
Any new contribution is more than welcome in this project!
If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!
Meilisearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.