AlgoliaSearch\Index
Synopsis
class Index
{
- // members
- private ClientContext $context;
- private Client $client;
- public $indexName;
- private $urlIndexName;
- // methods
- public void __construct()
- public mixed batchObjects()
- public mixed addObject()
- public mixed addObjects()
- public mixed getObject()
- public mixed getObjects()
- public mixed partialUpdateObject()
- public mixed partialUpdateObjects()
- public mixed saveObject()
- public mixed saveObjects()
- public mixed deleteObject()
- public mixed deleteObjects()
- public int deleteByQuery()
- public mixed search()
- private mixed searchWithDisjunctiveFaceting()
- private array getDisjunctiveQueries()
- private array getAlgoliaFiltersArrayWithoutCurrentRefinement()
- public mixed searchForFacetValues()
- public mixed searchDisjunctiveFaceting()
- private mixed doBcBrowse()
- public mixed waitTask()
- public mixed getTaskStatus()
- public mixed getSettings()
- public mixed clearIndex()
- public mixed setSettings()
- public mixed listApiKeys()
- public mixed listUserKeys()
- public mixed getUserKeyACL()
- public mixed getApiKey()
- public mixed deleteApiKey()
- public mixed deleteUserKey()
- public mixed addApiKey()
- public mixed addUserKey()
- public mixed updateApiKey()
- public mixed updateUserKey()
- public mixed batch()
- private array buildBatch()
- private IndexBrowser doBrowse()
- public mixed browseFrom()
- public mixed searchSynonyms()
- public mixed getSynonym()
- public mixed deleteSynonym()
- public mixed clearSynonyms()
- public mixed batchSynonyms()
- public mixed saveSynonym()
- public mixed searchFacet()
- public mixed __call()
Members
private
- $client — AlgoliaSearch\Client
- $context — AlgoliaSearch\ClientContext
- $urlIndexName — string
public
- $indexName — string
Methods
private
- buildBatch() — Build a batch request.
- doBcBrowse() — Browse all index content.
- doBrowse()
- getAlgoliaFiltersArrayWithoutCurrentRefinement()
- getDisjunctiveQueries()
- searchWithDisjunctiveFaceting()
public
- __construct() — Index initialization (You should not instantiate this yourself).
- __call()
- addApiKey() — Create a new API key associated to this index.
- addObject() — Add an object in this index.
- addObjects() — Add several objects.
- addUserKey()
- batch() — Send a batch request.
- batchObjects() — Perform batch operation on several objects.
- batchSynonyms()
- browseFrom()
- clearIndex() — This function deletes the index content. Settings and index specific API keys are kept untouched.
- clearSynonyms()
- deleteApiKey() — Delete an existing API key associated to this index.
- deleteByQuery() — Delete all objects matching a query.
- deleteObject() — Delete an object from the index.
- deleteObjects() — Delete several objects.
- deleteSynonym()
- deleteUserKey()
- getApiKey() — Get ACL of a API key associated to this index.
- getObject() — Get an object from this index.
- getObjects() — Get several objects from this index.
- getSettings() — Get settings of this index.
- getSynonym()
- getTaskStatus() — get the status of a task on the server.
- getUserKeyACL()
- listApiKeys() — List all existing API keys associated to this index with their associated ACLs.
- listUserKeys()
- partialUpdateObject() — Update partially an object (only update attributes passed in argument).
- partialUpdateObjects() — Partially Override the content of several objects.
- saveObject() — Override the content of object.
- saveObjects() — Override the content of several objects.
- saveSynonym()
- search() — Search inside the index.
- searchDisjunctiveFaceting() — Perform a search with disjunctive facets generating as many queries as number of disjunctive facets.
- searchFacet()
- searchForFacetValues() — Perform a search inside facets.
- searchSynonyms()
- setSettings() — Set settings for this index.
- updateApiKey() — Update an API key associated to this index.
- updateUserKey()
- waitTask() — Wait the publication of a task on the server.