Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/algolia/algoliasearch-client-php
⚡️ A fully-featured and blazing-fast PHP API client to interact with Algolia.
https://github.com/algolia/algoliasearch-client-php
algolia algolia-search api-client faceted-search geo-search php search search-engine search-synonyms
Last synced: about 1 month ago
JSON representation
⚡️ A fully-featured and blazing-fast PHP API client to interact with Algolia.
- Host: GitHub
- URL: https://github.com/algolia/algoliasearch-client-php
- Owner: algolia
- License: mit
- Created: 2013-05-20T12:37:37.000Z (over 11 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T11:34:50.000Z (about 2 months ago)
- Last Synced: 2024-10-29T13:26:55.559Z (about 1 month ago)
- Topics: algolia, algolia-search, api-client, faceted-search, geo-search, php, search, search-engine, search-synonyms
- Language: PHP
- Homepage: https://www.algolia.com/doc/api-client/php/getting-started/
- Size: 43.3 MB
- Stars: 671
- Watchers: 88
- Forks: 116
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-blazingly-fast - algoliasearch-client-php - ⚡️ A fully-featured and blazing-fast PHP API client to interact with Algolia. (PHP)
README
The perfect starting point to integrate Algolia within your PHP project
Documentation •
Laravel •
Symfony •
Community Forum •
Stack Overflow •
Report a bug •
FAQ •
Support## ✨ Features
- Thin & minimal low-level HTTP client to interact with Algolia's API
- Supports php `^8.0`.## 💡 Getting Started
First, install Algolia PHP API Client via the [composer](https://getcomposer.org/) package manager:
```bash
composer require algolia/algoliasearch-client-php "^4.0"
```You can now import the Algolia API client in your project and play with it.
```php
use Algolia\AlgoliaSearch\Api\SearchClient;$client = SearchClient::create('', '');
// Add a new record to your Algolia index
$response = $client->saveObject(
'',
['objectID' => 'id',
'test' => 'val',
],
);// play with the response
var_dump($response);// Poll the task status to know when it has been indexed
$client->waitForTask('', $response['taskID']);// Fetch search results, with typo tolerance
$response = $client->search(
['requests' => [
['indexName' => '',
'query' => '',
'hitsPerPage' => 50,
],
],
],
);// play with the response
var_dump($response);
```For full documentation, visit the **[Algolia PHP API Client](https://www.algolia.com/doc/libraries/php/)**.
## ❓ Troubleshooting
Encountering an issue? Before reaching out to support, we recommend heading to our [FAQ](https://www.algolia.com/doc/api-client/troubleshooting/faq/php/) where you will find answers for the most common issues and gotchas with the client. You can also open [a GitHub issue](https://github.com/algolia/api-clients-automation/issues/new?assignees=&labels=&projects=&template=Bug_report.md)
## Contributing
This repository hosts the code of the generated Algolia API client for PHP, if you'd like to contribute, head over to the [main repository](https://github.com/algolia/api-clients-automation). You can also find contributing guides on [our documentation website](https://api-clients-automation.netlify.app/docs/introduction).
## 📄 License
The Algolia PHP API Client is an open-sourced software licensed under the [MIT license](LICENSE).