Php

Getting Started

Install

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.

<?php
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

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.

<?php
// 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');

The api key that is displayed here is your ADMIN API Key, never use it in your frontend nor give it to anyone.

In your frontend, you should use the SEARCH ONLY API Key or any other key that has search rights only

Push data

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

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

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

<?php
// 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:

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

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

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:

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

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>

Getting Help

Did you find this page helpful?

We're always looking for advice to help improve our documentation! Please let us know what's working (or what's not!) - we're constantly iterating thanks to the feedback we receive.

Send us your suggestions!