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.
If you're a Symfony or Laravel user, you're probably looking for the following integrations:
- Laravel: Laravel Scout
- Symfony: algolia/AlgoliaSearchBundle
You can find the full reference on Algolia's website.
The API client is compatible with PHP version 5.3 and later.
Install the package via Composer:
composer require algolia/algoliasearch-client-php- Download the client from GitHub and unzip it in your project
- Inside the client root folder, execute
./bin/install-dependencies-without-composer - In your code, require the
autoload.phpin the client root folder
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.
In 30 seconds, this quick start tutorial will show you how to index and search objects.
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');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]);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'
]
]
);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'));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
<!doctype html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/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/[email protected]"></script>
<script src="app.js"></script>
</body>// 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();- Add objects
- Save objects
- Partial update objects
- Delete objects
- Replace all objects
- Delete by
- Clear objects
- Get objects
- Custom batch
- Create secured API Key
- Add API Key
- Update API Key
- Delete API Key
- Restore API Key
- Get API Key permissions
- List API Keys
- Save synonym
- Batch synonyms
- Delete synonym
- Clear all synonyms
- Get synonym
- Search synonyms
- Replace all synonyms
- Copy synonyms
- Export Synonyms
- Save rule
- Batch rules
- Get rule
- Delete rule
- Clear rules
- Search rules
- Replace all rules
- Copy rules
- Export rules
- Clicked Object IDs After Search
- Clicked Object IDs
- Clicked Filters
- Converted Objects IDs After Search
- Converted Object IDs
- Converted Filters
- Viewed Object IDs
- Viewed Filters
- Assign or Move userID
- Get top userID
- Get userID
- List clusters
- List userIDs
- Remove userID
- Search userID
- Need help? Ask a question to the Algolia Community or on Stack Overflow.
- Found a bug? You can open a GitHub issue.