Download the PHP package meilisearch/meilisearch-php without Composer

On this page you can find all versions of the php package meilisearch/meilisearch-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of meilisearch/meilisearch-php

Informations about the package meilisearch-php

Meilisearch-PHP

Meilisearch PHP

Meilisearch | Meilisearch Cloud | Documentation | Discord | Roadmap | Website | FAQ

Codecov coverage Latest Stable Version Test License Bors enabled

⚡ The Meilisearch API client written for PHP 🐘

Meilisearch PHP is the Meilisearch API client for PHP developers.

Meilisearch is an open-source search engine. Learn more about Meilisearch.

Table of Contents

📖 Documentation

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.

⚡ Supercharge your Meilisearch experience

Say goodbye to server deployment and manual updates with Meilisearch Cloud. Get started with a 14-day free trial! No credit card required.

🔧 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:

Here is an example of installation with the symfony/http-client:

💡 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:

NB: you can also download Meilisearch from Homebrew or APT or even run it using Docker.

🚀 Getting started

Add documents

With the uid, you can check the status (enqueued, canceled, processing, succeeded or failed) of your documents addition using the task.

Basic Search

Output:

Custom Search

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

💡 More about the search() method in the Wiki.

JSON output:

Custom Search With Filters

If you want to enable filtering, you must add your attributes to the filterableAttributes index setting.

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:

🤖 Compatibility with Meilisearch

This package guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.

💡 Learn more

The following sections in our main documentation website 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:

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:

⚙️ 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.

All versions of meilisearch-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-json Version *
php-http/discovery Version ^1.7
psr/http-client Version ^1.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package meilisearch/meilisearch-php contains the following files

Loading the files please wait ....