algolia/algoliasearch-client-php

API powering the features of Algolia.

4.11.2 2024-12-18 11:28 UTC

Requires

• php: >=8.1
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• guzzlehttp/psr7: ^2.0
• psr/http-message: ^1.1 || ^2.0
• psr/log: ^1.0 || ^2.0 || ^3.0
• psr/simple-cache: ^1.0 || ^2.0 || ^3.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.0 || ^3.5.0
• phpstan/phpstan: ^1.12
• phpunit/phpunit: ^11.0
• vlucas/phpdotenv: ^5.4

Suggests

• guzzlehttp/guzzle: If you prefer to use Guzzle HTTP client instead of the Http Client implementation provided by the package

MIT

• Algolia Team

• php
• api
• client
• search
• algolia

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 package manager:

composer require algolia/algoliasearch-client-php "^4.0"

You can now import the Algolia API client in your project and play with it.

use Algolia\AlgoliaSearch\Api\SearchClient;

$client = SearchClient::create('<YOUR_APP_ID>', '<YOUR_API_KEY>');

// Add a new record to your Algolia index
$response = $client->saveObject(
    '<YOUR_INDEX_NAME>',
    ['objectID' => 'id',
        'test' => 'val',
    ],
);

// play with the response
var_dump($response);

// Poll the task status to know when it has been indexed
$client->waitForTask('<YOUR_INDEX_NAME>', $response['taskID']);

// Fetch search results, with typo tolerance
$response = $client->search(
    ['requests' => [
        ['indexName' => '<YOUR_INDEX_NAME>',
            'query' => '<YOUR_QUERY>',
            'hitsPerPage' => 50,
        ],
    ],
    ],
);

// play with the response
var_dump($response);

For full documentation, visit the Algolia PHP API Client.

❓ Troubleshooting

Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue

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. You can also find contributing guides on our documentation website.

📄 License

The Algolia PHP API Client is an open-sourced software licensed under the MIT license.