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.
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.
This library is compatible with PHP version 5.3 and later.
Install the package via Composer:
composer require algolia/algoliasearch-client-phpIf you don't use Composer, you can download the package and include it in your code.
require_once('algoliasearch-client-php-master/algoliasearch.php');We officially provide support for the Laravel and Symfony frameworks:
If you are using one of those 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 begin, you will need to initialize the client. In order to do this you will 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/algoliasearch.php';
$client = new \AlgoliaSearch\Client('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:
$index = $client->initIndex('contacts');
$batch = json_decode(file_get_contents('contacts.json'), true);
$index->addObjects($batch);Settings can be customized to fine tune the search behavior. For example, you can add a custom sort 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: The Algolia engine is designed to suggest results as you type, which means 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'
]
]
);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'));Warning: If you are building a web application, you may be more interested in using one of our frontend search UI libraries
The following example shows how to build a front-end search quickly using InstantSearch.js
<!doctype html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.css">
<!-- Always use `2.x` versions in production rather than `2` to mitigate any side effects on your website,
Find the latest version on InstantSearch.js website: https://community.algolia.com/instantsearch.js/v2/guides/usage.html -->
</head>
<body>
<header>
<div>
<input id="search-input" placeholder="Search for products">
<!-- We use a specific placeholder in the input to guides users in their search. -->
</header>
<main>
</main>
<script type="text/html" id="hit-template">
<p class="hit-name">{{{_highlightResult.firstname.value}}} {{{_highlightResult.lastname.value}}}</p>
</script>
<script src="https://cdn.jsdelivr.net/npm/instantsearch.js@2.3/dist/instantsearch.min.js"></script>
<script src="app.js"></script>
</body>var search = instantsearch({
// Replace with your own values
appId: 'YourApplicationID',
apiKey: 'YourSearchOnlyAPIKey', // search only API key, no ADMIN key
indexName: 'contacts',
urlSync: 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();- Create secured API Key
- Add API Key
- Update API Key
- Delete API Key
- Get API Key permissions
- List API Keys
- Save synonym
- Batch synonyms
- Delete synonym
- Clear all synonyms
- Get synonym
- Search synonyms
- Export Synonyms
- 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.
![@renovate[bot]](https://avatars.githubusercontent.com/in/2740?s=64&v=4){kind=small}
![@dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=64&v=4){kind=small}
