Typesense PHP Client
Official PHP client for the Typesense API: https://github.com/typesense/typesense
Installation
$ composer require php-http/curl-client typesense/typesense-php
You can also add typesense/typesense-php to your project's composer.json.
Typesense uses HTTPlug as an abstraction layer for an HTTP client. You'll find the List of supported HTTP clients & adapters here. Please be sure to install a supported client.
Usage
Read the documentation here: https://typesense.org/api/
Here are some examples that walk you through how to use the client: doc/examples
Compatibility
| Typesense Server | typesense-php |
|---|---|
| >= v0.21.0 | >= v4.7.0 |
| >= v0.20.0 | >= v4.6.0 |
| >= v0.19.0 | >= v4.5.0 |
| >= v0.18.0 | >= v4.4.0 |
| >= v0.17.0 | >= v4.2.0 |
| >= v0.16.0 | >= v4.1.0 |
| >= v0.15.0 | >= v4.0.0 |
Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/typesense/typesense-php].
Development
Run linter:
composer run-script lint:fixRun Typesense Server:
composer run-script typesenseServerCredits
This client was originally developed by Abdullah Al-Faqeir from DevLoops and was adopted as the official PHP client library for Typesense in Oct 2020.
Ongoing development and support is now provided by Typesense, in addition to our collaborators.