Meilisearch PHP

Meilisearch | Documentation | Slack | Roadmap | Website | FAQ

⚡ The Meilisearch API client written for PHP 🐘

Meilisearch PHP is the Meilisearch API client for PHP developers.

Meilisearch is an open-source search engine. Discover what Meilisearch is!

🎃 Hacktoberfest
📖 Documentation
🔧 Installation
🚀 Getting Started
🤖 Compatibility with Meilisearch
💡 Learn More
🧰 HTTP Client Compatibilities
- Customize your HTTP Client
⚙️ Development Workflow and Contributing

🎃 Hacktoberfest

It’s Hacktoberfest 2022 @Meilisearch

Hacktoberfest is a celebration of the open-source community. This year, and for the third time in a row, Meilisearch is participating in this fantastic event.

You’d like to contribute? Don’t hesitate to check out our contributing guidelines.

📖 Documentation

See our Documentation or our API References.

🔧 Installation

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

💡 More HTTP client installations compatible with this package can be found in this section.

Run Meilisearch

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.

🚀 Getting Started

Add documents

<?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.

Basic Search

// 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
                )
        )
)

Custom Search

All the supported options are described in the search parameters section of the documentation.

💡 More about the 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"
}

Custom Search With Filters

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"
}

🤖 Compatibility with Meilisearch

This package only guarantees the compatibility with the version v0.29.0 of Meilisearch.

💡 Learn More

The following sections may interest you:

Manipulate documents: see the API references or read more about documents.
Search: see the API references or follow our guide on search parameters.
Manage the indexes: see the API references or read more about indexes.
Configure the index settings: see the API references or follow our guide on settings parameters.

🧰 HTTP Client Compatibilities

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:

with guzzlehttp/guzzle (Guzzle 7), run:

composer require meilisearch/meilisearch-php guzzlehttp/guzzle http-interop/http-factory-guzzle:^1.0

with 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

with symfony/http-client, run:

composer require meilisearch/meilisearch-php symfony/http-client nyholm/psr7:^1.0

with php-http/curl-client, run:

composer require meilisearch/meilisearch-php php-http/curl-client nyholm/psr7:^1.0

with kriswallsmith/buzz, run:

composer require meilisearch/meilisearch-php kriswallsmith/buzz nyholm/psr7:^1.0

Customize your HTTP Client

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]));

⚙️ Development Workflow and Contributing

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.

jonatanrdsantos/meilisearch-php