The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content

PHP

PreviousLatestDescription
"algolia/algoliasearch-client-php": "^3.2""algolia/algoliasearch-client-php": "^4.0@alpha"During the beta phase, the clients are available under the package 4.x.x-alpha , you can find a full list here.
Algolia\AlgoliaSearchAlgolia\AlgoliaSearch\ApiExported clients have now the namespace suffixed by Api.
Algolia\AlgoliaSearch\Cache\FileCacheDriverremovedThis implementation of the CacheInterface is not available anymore in the Client. If you feel the need for it, please open an issue

Usage​

To get started, first uninstall the previously added clients.

bash
composer remove algolia/algoliasearch-client-php
bash
composer remove algolia/algoliasearch-client-php

You can now install the Algoliasearch clients.

bash
composer require algolia/algoliasearch-client-php "^4.0@alpha"
bash
composer require algolia/algoliasearch-client-php "^4.0@alpha"

You can continue this guide on our installation page.

Methods targeting an indexName​

Prior to the initIndex removal stated in the common breaking changes, all methods previously available at the initIndex level requires the indexName to be sent with the query.

php
use Algolia\AlgoliaSearch\Api\SearchClient;
$client = SearchClient::create(
    '<YOUR_APP_ID>',
    '<YOUR_API_KEY>'
);
// only query string
$searchResults = $client->search([
    'requests' => [
        ['indexName' => '<YOUR_INDEX_NAME>', 'query' =>'<YOUR_QUERY>'],
    ],
]);
$searchResults2 = $client->search([
    'requests' => [
        [
            'indexName' => '<YOUR_INDEX_NAME>', 
            'query' => '<YOUR_QUERY>',
            'attributesToRetrieve' => ['firstname', 'lastname'],
            'hitsPerPage' => 50,
        ],
    ],
]);
php
use Algolia\AlgoliaSearch\Api\SearchClient;
$client = SearchClient::create(
    '<YOUR_APP_ID>',
    '<YOUR_API_KEY>'
);
// only query string
$searchResults = $client->search([
    'requests' => [
        ['indexName' => '<YOUR_INDEX_NAME>', 'query' =>'<YOUR_QUERY>'],
    ],
]);
$searchResults2 = $client->search([
    'requests' => [
        [
            'indexName' => '<YOUR_INDEX_NAME>', 
            'query' => '<YOUR_QUERY>',
            'attributesToRetrieve' => ['firstname', 'lastname'],
            'hitsPerPage' => 50,
        ],
    ],
]);