meilisearch/meilisearch-php

PHP wrapper for the MeiliSearch API

v0.15.1 2020-11-04 16:56 UTC

README

MeiliSearch-PHP

MeiliSearch PHP

MeiliSearch | Documentation | Roadmap | Website | Blog | Twitter | FAQ

Latest Stable Version Test License Slack Bors enabled

⚡ The MeiliSearch API client written for PHP 🐘

MeiliSearch PHP is the MeiliSearch API client for PHP developers. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, facets, and synonyms are provided out-of-the-box.

Table of Contents

📖 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, if you use Docker:

$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT.

🚀 Getting Started

Add documents

<?php

require_once __DIR__ . '/vendor/autoload.php';

use MeiliSearch\Client;

$client = new Client('http://127.0.0.1:7700', 'masterKey');
$index = $client->createIndex('books'); // If your index does not exist
$index = $client->getIndex('books');    // If you already created your index

$documents = [
    ['book_id' => 123,  'title' => 'Pride and Prejudice', 'author' => 'Jane Austen'],
    ['book_id' => 456,  'title' => 'Le Petit Prince', 'author' => 'Antoine de Saint-Exupéry'],
    ['book_id' => 1,    'title' => 'Alice In Wonderland', 'author' => 'Lewis Carroll'],
    ['book_id' => 1344, 'title' => 'The Hobbit', 'author' => 'J. R. R. Tolkien'],
    ['book_id' => 4,    'title' => 'Harry Potter and the Half-Blood Prince', 'author' => 'J. K. Rowling'],
    ['book_id' => 42,   'title' => 'The Hitchhiker\'s Guide to the Galaxy', 'author' => 'Douglas Adams, Eoin Colfer, Thomas Tidholm'],
];

$index->addDocuments($documents); // => { "updateId": 0 }

With the updateId, you can check the status (enqueued, processed or failed) of your documents addition using the update endpoint.

Basic Search

// MeiliSearch is typo-tolerant:
print_r($index->search('harry pottre'));

Output:

Array
(
    [hits] => Array
        (
            [0] => Array
                (
                    [id] => 4
                    [title] => Harry Potter and the Half-Blood Prince
                )

        )

    [offset] => 0
    [limit] => 20
    [processingTimeMs] => 1
    [query] => harry pottre
)

Custom Search

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

$index->search('prince',
    [
        'attributesToHighlight' => ['*'],
        'filters' => 'book_id > 10'
    ]
);
{
    "hits": [
        {
            "book_id": 456,
            "title": "Le Petit Prince"
        }
    ],
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 10,
    "query": "prince"
}

With filters, both single and double quotes are supported.

// Enclosing with double quotes
$index->search('prince', ['filters' => "title = 'Le Petit Prince' OR author = 'J. R. R. Tolkien'"]);

// Enclosing with single quotes
$index->search('hobbit', ['filters' => 'title = "The Hitchhiker\'s Guide to the Galaxy" OR author = "J. R. R. Tolkien"']);

🤖 Compatibility with MeiliSearch

This package only guarantees the compatibility with the version v0.16.0 of MeiliSearch.

💡 Learn More

The following sections may interest you:

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