Documentation

Algolia Search API Client for PHP

Algolia Search is a hosted search engine capable of delivering realtime results from the first keystroke.

The Algolia Search API Client for PHP lets you easily use the Algolia Search REST API from your PHP code.

Build Status Latest Stable Version Coverage Status

If you're a Symfony or Laravel user, you're probably looking for the following integrations:

API Documentation

You can find the full reference on Algolia's website.

  1. Supported platforms

  2. Install

  3. Quick Start

  4. Push data

  5. Configure

  6. Search

  7. Search UI

  8. List of available methods

Getting Started

Supported platforms

The API client is compatible with PHP version 5.3 and later.

Install

With Composer (recommended)

Install the package via Composer:

composer require algolia/algoliasearch-client-php

Without Composer

  1. Download the client from GitHub and unzip it in your project
  2. Inside the client root folder, execute ./bin/install-dependencies-without-composer
  3. In your code, require the autoload.php in the client root folder

Framework integrations

We officially provide support for the Laravel and Symfony frameworks. If you're using one of these two frameworks, have a look at our Laravel documentation or Symfony documentation.

Quick Start

In 30 seconds, this quick start tutorial will show you how to index and search objects.

Initialize the client

To start, you need to initialize the client. To do this, you need your Application ID and API Key. You can find both on your Algolia account.

// composer autoload
require __DIR__ . '/vendor/autoload.php';

// if you are not using composer
// require_once 'path/to/algolia/folder/autoload.php';

$client = Algolia\AlgoliaSearch\SearchClient::create(
  'YourApplicationID',
  'YourAdminAPIKey'
);

$index = $client->initIndex('your_index_name');

Push data

Without any prior configuration, you can start indexing 500 contacts in the contacts index using the following code:

$client = \Algolia\AlgoliaSearch\SearchClient::create('YourApplicationID', 'YourAPIKey');
$index = $client->initIndex('contacts');
$batch = json_decode(file_get_contents('contacts.json'), true);
$index->saveObjects($batch, ['autoGenerateObjectIDIfNotExist' => true]);

Configure

You can customize settings to fine tune the search behavior. For example, you can add a custom ranking by number of followers to further enhance the built-in relevance:

$index->setSettings(['customRanking' => ['desc(followers)']]);

You can also configure the list of attributes you want to index by order of importance (most important first).

Note: Algolia is designed to suggest results as you type, which means you'll generally search by prefix. In this case, the order of attributes is crucial to decide which hit is the best.

$index->setSettings(
  [
    'searchableAttributes' => [
      'lastname',
      'firstname',
      'company',
      'email',
      'city',
      'address'
    ]
  ]
);

Search

You can now search for contacts by firstname, lastname, company, etc. (even with typos):

// Search for a first name
var_dump($index->search('jimmie'));

// Search for a first name with typo
var_dump($index->search('jimie'));

// Search for a company
var_dump($index->search('california paint'));

// Search for a first name and a company
var_dump($index->search('jimmie paint'));

Search UI

Warning: If you're building a web application, you may be interested in using one of our front-end search UI libraries.

The following example shows how to quickly build a front-end search using InstantSearch.js

index.html

<!doctype html>
<head>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.css@7.1.0/themes/algolia.css" />
</head>
<body>
  <header>
    <div>
       <input id="search-input" placeholder="Search for products">
       <!-- We use a specific placeholder in the input to guide users in their search. -->
    
  </header>
  <main>
      
      
  </main>

  <script type="text/html" id="hit-template">
    
      <p class="hit-name">
        {}{ "attribute": "firstname" }{{/helpers.highlight}}
        {}{ "attribute": "lastname" }{{/helpers.highlight}}
      </p>
    
  </script>

  <script src="https://cdn.jsdelivr.net/npm/instantsearch.js@3.0.0"></script>
  <script src="app.js"></script>
</body>

app.js

// Replace with your own values
var searchClient = algoliasearch(
  'YourApplicationID',
  'YourAPIKey' // search only API key, no ADMIN key
);

var search = instantsearch({
  indexName: 'instant_search',
  searchClient: searchClient,
  routing: true,
  searchParameters: {
    hitsPerPage: 10
  }
});

search.addWidget(
  instantsearch.widgets.searchBox({
    container: '#search-input'
  })
);

search.addWidget(
  instantsearch.widgets.hits({
    container: '#hits',
    templates: {
      item: document.getElementById('hit-template').innerHTML,
      empty: "We didn't find any results for the search <em>\"{{query}}\"</em>"
    }
  })
);

search.start();

List of available methods

Personalization

Search

Indexing

Settings

Manage indices

API keys

Synonyms

Query rules

A/B Test

Insights

MultiClusters

Advanced

Getting Help