README

Algolia Search is a hosted full-text, numerical, and faceted 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.

API Documentation

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

Install
Quick Start
Getting Help

Getting Started

Install

With composer (Recommended)

Install the package via Composer:

composer require algolia/algoliasearch-client-php

Without composer

If you don't use Composer, you can download the package and include it in your code.

require_once('algoliasearch-client-php-master/algoliasearch.php');

Framework Integrations

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

Laravel: algolia/algoliasearch-laravel
Symfony: algolia/AlgoliaSearchBundle

Quick Start

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

Initialize the client

You first need to initialize the client. For that you need your Application ID and API Key. You can find both of them on your Algolia account.

// composer autoload
require __DIR__ . '/vendor/autoload.php';
// if you are not using composer: require_once 'path/to/algoliasearch.php';

$client = new \AlgoliaSearch\Client('YourApplicationID', 'YourAPIKey');

Push data

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

$index = $client->initIndex('contacts');
$batch = json_decode(file_get_contents('contacts.json'), true);
$index->addObjects($batch);

Search

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

// search by firstname
var_dump($index->search('jimmie'));

// search a firstname with typo
var_dump($index->search('jimie'));

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

// search for a firstname & company
var_dump($index->search('jimmie paint'));

Configure

Settings can be customized to tune the search behavior. For example, you can add a custom sort by number of followers to the already great built-in relevance:

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

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

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

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

Frontend search

Note: If you are building a web application, you may be more interested in using our JavaScript client to perform queries.

It brings two benefits:

Your users get a better response time by not going through your servers
It will offload unnecessary tasks from your servers

<script src="https://cdn.jsdelivr.net/algoliasearch/3/algoliasearch.min.js"></script>
<script>
var client = algoliasearch('ApplicationID', 'apiKey');
var index = client.initIndex('indexName');

// perform query "jim"
index.search('jim', searchCallback);

// the last optional argument can be used to add search parameters
index.search(
  'jim', {
    hitsPerPage: 5,
    facets: '*',
    maxValuesPerFacet: 10
  },
  searchCallback
);

function searchCallback(err, content) {
  if (err) {
    console.error(err);
    return;
  }

  console.log(content);
}
</script>

Running the tests

Add theses two environments variables from API Keys :

ALGOLIA_APPLICATION_ID=Application ID
ALGOLIA_API_KEY=Admin API Key

Then run:

php vendor/bin/phpunit

Getting Help

Need help? Ask a question to the Algolia Community or on Stack Overflow.
Found a bug? You can open a GitHub issue.

roukmoute / algoliasearch-client-php

Maintainers

Details