| Property | Type | Description | |
|---|---|---|---|
| $indexName | string |
| Method | Description | |
|---|---|---|
| __call ( string $name, array $arguments ) : mixed | ||
|
__construct ( |
Index initialization (You should not instantiate this yourself). | |
| addObject ( array $content, string | null $objectID = null ) : mixed | Add an object in this index. | |
| addObjects ( array $objects, string $objectIDKey = 'objectID' ) : mixed | Add several objects. | |
| addUserKey ( array $obj, integer $validity, integer $maxQueriesPerIPPerHour, integer $maxHitsPerQuery ) : mixed | Create a new user key associated to this index. | |
| batch ( array $requests ) : mixed | Send a batch request. | |
| batchObjects ( array $objects, string $objectIDKey = 'objectID', string $objectActionKey = 'objectAction' ) : mixed | Perform batch operation on several objects. | |
| batchSynonyms ( $objects, boolean $forwardToReplicas = false, boolean $replaceExistingSynonyms = false ) : mixed | ||
| browseFrom ( string $query, array | null $params = null, $cursor = null ) : mixed | ||
| clearIndex ( ) : mixed | This function deletes the index content. Settings and index specific API keys are kept untouched. | |
| clearSynonyms ( boolean $forwardToReplicas = false ) : mixed | ||
| deleteByQuery ( string $query, array $args = [], boolean $waitLastCall = true ) : integer | Delete all objects matching a query. | |
| deleteObject ( integer | string $objectID ) : mixed | Delete an object from the index. | |
| deleteObjects ( array $objects ) : mixed | Delete several objects. | |
| deleteSynonym ( $objectID, $forwardToReplicas = false ) : mixed | ||
| deleteUserKey ( string $key ) : mixed | Delete an existing user key associated to this index. | |
| getObject ( $objectID, $attributesToRetrieve = null ) : mixed | Get an object from this index. | |
| getObjects ( array $objectIDs ) : mixed | Get several objects from this index. | |
| getSettings ( ) : mixed | Get settings of this index. | |
| getSynonym ( $objectID ) : mixed | ||
| getTaskStatus ( string $taskID ) : mixed | get the status of a task on the server. | |
| getUserKeyACL ( string $key ) : mixed | Get ACL of a user key associated to this index. | |
| listUserKeys ( ) : mixed | List all existing user keys associated to this index with their associated ACLs. | |
| partialUpdateObject ( array $partialObject, boolean $createIfNotExists = true ) : mixed | Update partially an object (only update attributes passed in argument). | |
| partialUpdateObjects ( array $objects, string $objectIDKey = 'objectID', boolean $createIfNotExists = true ) : mixed | Partially Override the content of several objects. | |
| saveObject ( array $object, string $objectIDKey = 'objectID' ) : mixed | Override the content of object. | |
| saveObjects ( array $objects, string $objectIDKey = 'objectID' ) : mixed | Override the content of several objects. | |
| saveSynonym ( $objectID, $content, boolean $forwardToReplicas = false ) : mixed | ||
| search ( string $query, mixed $args = null ) : mixed | Search inside the index. | |
| searchDisjunctiveFaceting ( string $query, array $disjunctive_facets, array $params = [], array $refinements = [] ) : mixed | Perform a search with disjunctive facets generating as many queries as number of disjunctive facets. | |
| searchFacet ( $facetName, $facetQuery, array $query = [] ) : mixed | Perform a search inside facets. | |
| searchSynonyms ( $query, array $synonymType = [], null $page = null, null $hitsPerPage = null ) : mixed | ||
| setSettings ( mixed $settings, boolean $forwardToReplicas = false ) : mixed | Set settings for this index. | |
| updateUserKey ( string $key, array $obj, integer $validity, integer $maxQueriesPerIPPerHour, integer $maxHitsPerQuery ) : mixed | Update a user key associated to this index. | |
| waitTask ( string $taskID, integer $timeBeforeRetry = 100 ) : mixed | Wait the publication of a task on the server. |
| Method | Description | |
|---|---|---|
| buildBatch ( string $action, array $objects, string $withObjectID, string $objectIDKey = 'objectID' ) : array | Build a batch request. | |
| doBcBrowse ( integer $page, integer $hitsPerPage = 1000 ) : mixed | Browse all index content. | |
|
doBrowse ( string $query, array | null $params = null ) : |
|
public __construct ( |
||
| $context | ||
| $client | ||
| $indexName | string | |
| public addObject ( array $content, string | null $objectID = null ) : mixed | ||
| $content | array | contains the object to add inside the index. The object is represented by an associative array |
| $objectID | string | null | (optional) an objectID you want to attribute to this object (if the attribute already exist the old object will be overwrite) |
| return | mixed | |
| public addUserKey ( array $obj, integer $validity, integer $maxQueriesPerIPPerHour, integer $maxHitsPerQuery ) : mixed | ||
| $obj | array | can be two different parameters: The list of parameters for this key. Defined by a array that can contains the following values: - acl: array of string - indices: array of string - validity: int - referers: array of string - description: string - maxHitsPerQuery: integer - queryParameters: string - maxQueriesPerIPPerHour: integer Or the list of ACL for this key. Defined by an array of NSString that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only) |
| $validity | integer | the number of seconds after which the key will be automatically removed (0 means no time limit for this key) |
| $maxQueriesPerIPPerHour | integer | Specify the maximum number of API calls allowed from an IP address per hour. Defaults to 0 (no rate limit). |
| $maxHitsPerQuery | integer | Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited) |
| return | mixed | |
| public batchObjects ( array $objects, string $objectIDKey = 'objectID', string $objectActionKey = 'objectAction' ) : mixed | ||
| $objects | array | contains an array of objects to update (each object must contains an objectID attribute) |
| $objectIDKey | string | the key in each object that contains the objectID |
| $objectActionKey | string | the key in each object that contains the action to perform (addObject, updateObject, deleteObject or partialUpdateObject) |
| return | mixed | |
| public clearIndex ( ) : mixed | ||
| return | mixed | |
| public clearSynonyms ( boolean $forwardToReplicas = false ) : mixed | ||
| $forwardToReplicas | boolean | |
| return | mixed | |
| public deleteByQuery ( string $query, array $args = [], boolean $waitLastCall = true ) : integer | ||
| $query | string | the query string |
| $args | array | the optional query parameters |
| $waitLastCall | boolean | /!\ Be safe with "waitLastCall" In really rare cases you can have the number of hits smaller than the hitsPerPage param if you trigger the timeout of the search, in that case you won't remove all the records |
| return | integer | the number of delete operations |
| public deleteObjects ( array $objects ) : mixed | ||
| $objects | array | contains an array of objectIDs to delete. If the object contains an objectID |
| return | mixed | |
| public deleteSynonym ( $objectID, $forwardToReplicas = false ) : mixed | ||
| $objectID | ||
| $forwardToReplicas | ||
| return | mixed | |
| public deleteUserKey ( string $key ) : mixed | ||
| $key | string | |
| return | mixed | |
| public getObjects ( array $objectIDs ) : mixed | ||
| $objectIDs | array | the array of unique identifier of objects to retrieve |
| return | mixed | |
| public getTaskStatus ( string $taskID ) : mixed | ||
| $taskID | string | the id of the task returned by server |
| return | mixed | |
| public getUserKeyACL ( string $key ) : mixed | ||
| $key | string | |
| return | mixed | |
| public listUserKeys ( ) : mixed | ||
| return | mixed | |
| public saveSynonym ( $objectID, $content, boolean $forwardToReplicas = false ) : mixed | ||
| $objectID | ||
| $content | ||
| $forwardToReplicas | boolean | |
| return | mixed | |
| public search ( string $query, mixed $args = null ) : mixed | ||
| $query | string | the full text query |
| $args | mixed | (optional) if set, contains an associative array with query parameters: - page: (integer) Pagination parameter used to select the page to retrieve. Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9 - hitsPerPage: (integer) Pagination parameter used to select the number of hits per page. Defaults to 20. - attributesToRetrieve: a string that contains the list of object attributes you want to retrieve (let you minimize the answer size). Attributes are separated with a comma (for example "name,address"). You can also use a string array encoding (for example ["name","address"]). By default, all attributes are retrieved. You can also use '*' to retrieve all values when an attributesToRetrieve setting is specified for your index. - attributesToHighlight: a string that contains the list of attributes you want to highlight according to the query. Attributes are separated by a comma. You can also use a string array encoding (for example ["name","address"]). If an attribute has no match for the query, the raw value is returned. By default all indexed text attributes are highlighted. You can use `*` if you want to highlight all textual attributes. Numerical attributes are not highlighted. A matchLevel is returned for each highlighted attribute and can contain: - full: if all the query terms were found in the attribute, - partial: if only some of the query terms were found, - none: if none of the query terms were found. - attributesToSnippet: a string that contains the list of attributes to snippet alongside the number of words to return (syntax is `attributeName:nbWords`). Attributes are separated by a comma (Example: attributesToSnippet=name:10,content:10). You can also use a string array encoding (Example: attributesToSnippet: ["name:10","content:10"]). By default no snippet is computed. - minWordSizefor1Typo: the minimum number of characters in a query word to accept one typo in this word. Defaults to 3. - minWordSizefor2Typos: the minimum number of characters in a query word to accept two typos in this word. Defaults to 7. - getRankingInfo: if set to 1, the result hits will contain ranking information in _rankingInfo attribute. - aroundLatLng: search for entries around a given latitude/longitude (specified as two floats separated by a comma). For example aroundLatLng=47.316669,5.016670). You can specify the maximum distance in meters with the aroundRadius parameter (in meters) and the precision for ranking with aroundPrecision (for example if you set aroundPrecision=100, two objects that are distant of less than 100m will be considered as identical for "geo" ranking parameter). At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}}) - insideBoundingBox: search entries inside a given area defined by the two extreme points of a rectangle (defined by 4 floats: p1Lat,p1Lng,p2Lat,p2Lng). For example insideBoundingBox=47.3165,4.9665,47.3424,5.0201). At indexing, you should specify geoloc of an object with the _geoloc attribute (in the form {"_geoloc":{"lat":48.853409, "lng":2.348800}}) - numericFilters: a string that contains the list of numeric filters you want to apply separated by a comma. The syntax of one filter is `attributeName` followed by `operand` followed by `value`. Supported operands are `<`, `<=`, `=`, `>` and `>=`. You can have multiple conditions on one attribute like for example numericFilters=price>100,price<1000. You can also use a string array encoding (for example numericFilters: ["price>100","price<1000"]). - tagFilters: filter the query by a set of tags. You can AND tags by separating them by commas. To OR tags, you must add parentheses. For example, tags=tag1,(tag2,tag3) means tag1 AND (tag2 OR tag3). You can also use a string array encoding, for example tagFilters: ["tag1",["tag2","tag3"]] means tag1 AND (tag2 OR tag3). At indexing, tags should be added in the _tags** attribute of objects (for example {"_tags":["tag1","tag2"]}). - facetFilters: filter the query by a list of facets. Facets are separated by commas and each facet is encoded as `attributeName:value`. For example: `facetFilters=category:Book,author:John%20Doe`. You can also use a string array encoding (for example `["category:Book","author:John%20Doe"]`). - facets: List of object attributes that you want to use for faceting. Attributes are separated with a comma (for example `"category,author"` ). You can also use a JSON string array encoding (for example ["category","author"]). Only attributes that have been added in **attributesForFaceting** index setting can be used in this parameter. You can also use `*` to perform faceting on all attributes specified in **attributesForFaceting**. - queryType: select how the query words are interpreted, it can be one of the following value: - prefixAll: all query words are interpreted as prefixes, - prefixLast: only the last word is interpreted as a prefix (default behavior), - prefixNone: no query word is interpreted as a prefix. This option is not recommended. - optionalWords: a string that contains the list of words that should be considered as optional when found in the query. The list of words is comma separated. - distinct: If set to 1, enable the distinct feature (disabled by default) if the attributeForDistinct index setting is set. This feature is similar to the SQL "distinct" keyword: when enabled in a query with the distinct=1 parameter, all hits containing a duplicate value for the attributeForDistinct attribute are removed from results. For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the best one is kept and others are removed. |
| return | mixed | |
| public searchDisjunctiveFaceting ( string $query, array $disjunctive_facets, array $params = [], array $refinements = [] ) : mixed | ||
| $query | string | the query |
| $disjunctive_facets | array | the array of disjunctive facets |
| $params | array | a hash representing the regular query parameters |
| $refinements | array | a hash ("string" -> ["array", "of", "refined", "values"]) representing the current refinements ex: { "my_facet1" => ["my_value1", ["my_value2"], "my_disjunctive_facet1" => ["my_value1", "my_value2"] } |
| return | mixed | |
| public searchFacet ( $facetName, $facetQuery, array $query = [] ) : mixed | ||
| $facetName | ||
| $facetQuery | ||
| $query | array | |
| return | mixed | |
| public setSettings ( mixed $settings, boolean $forwardToReplicas = false ) : mixed | ||
| $settings | mixed | the settings object that can contains : - minWordSizefor1Typo: (integer) the minimum number of characters to accept one typo (default = 3). - minWordSizefor2Typos: (integer) the minimum number of characters to accept two typos (default = 7). - hitsPerPage: (integer) the number of hits per page (default = 10). - attributesToRetrieve: (array of strings) default list of attributes to retrieve in objects. If set to null, all attributes are retrieved. - attributesToHighlight: (array of strings) default list of attributes to highlight. If set to null, all indexed attributes are highlighted. - attributesToSnippet**: (array of strings) default list of attributes to snippet alongside the number of words to return (syntax is attributeName:nbWords). By default no snippet is computed. If set to null, no snippet is computed. - searchableAttributes (formerly named attributesToIndex): (array of strings) the list of fields you want to index. If set to null, all textual and numerical attributes of your objects are indexed, but you should update it to get optimal results. This parameter has two important uses: - Limit the attributes to index: For example if you store a binary image in base64, you want to store it and be able to retrieve it but you don't want to search in the base64 string. - Control part of the ranking*: (see the ranking parameter for full explanation) Matches in attributes at the beginning of the list will be considered more important than matches in attributes further down the list. In one attribute, matching text at the beginning of the attribute will be considered more important than text after, you can disable this behavior if you add your attribute inside `unordered(AttributeName)`, for example searchableAttributes: ["title", "unordered(text)"]. - attributesForFaceting: (array of strings) The list of fields you want to use for faceting. All strings in the attribute selected for faceting are extracted and added as a facet. If set to null, no attribute is used for faceting. - attributeForDistinct: (string) The attribute name used for the Distinct feature. This feature is similar to the SQL "distinct" keyword: when enabled in query with the distinct=1 parameter, all hits containing a duplicate value for this attribute are removed from results. For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the best one is kept and others are removed. - ranking: (array of strings) controls the way results are sorted. We have six available criteria: - typo: sort according to number of typos, - geo: sort according to decreassing distance when performing a geo-location based search, - proximity: sort according to the proximity of query words in hits, - attribute: sort according to the order of attributes defined by searchableAttributes, - exact: - if the user query contains one word: sort objects having an attribute that is exactly the query word before others. For example if you search for the "V" TV show, you want to find it with the "V" query and avoid to have all popular TV show starting by the v letter before it. - if the user query contains multiple words: sort according to the number of words that matched exactly (and not as a prefix). - custom: sort according to a user defined formula set in **customRanking** attribute. The standard order is ["typo", "geo", "proximity", "attribute", "exact", "custom"] - customRanking: (array of strings) lets you specify part of the ranking. The syntax of this condition is an array of strings containing attributes prefixed by asc (ascending order) or desc (descending order) operator. For example `"customRanking" => ["desc(population)", "asc(name)"]` - queryType: Select how the query words are interpreted, it can be one of the following value: - prefixAll: all query words are interpreted as prefixes, - prefixLast: only the last word is interpreted as a prefix (default behavior), - prefixNone: no query word is interpreted as a prefix. This option is not recommended. - highlightPreTag: (string) Specify the string that is inserted before the highlighted parts in the query result (default to ""). - highlightPostTag: (string) Specify the string that is inserted after the highlighted parts in the query result (default to ""). - optionalWords: (array of strings) Specify a list of words that should be considered as optional when found in the query. |
| $forwardToReplicas | boolean | |
| return | mixed | |
| public updateUserKey ( string $key, array $obj, integer $validity, integer $maxQueriesPerIPPerHour, integer $maxHitsPerQuery ) : mixed | ||
| $key | string | |
| $obj | array | can be two different parameters: The list of parameters for this key. Defined by a array that can contains the following values: - acl: array of string - indices: array of string - validity: int - referers: array of string - description: string - maxHitsPerQuery: integer - queryParameters: string - maxQueriesPerIPPerHour: integer Or the list of ACL for this key. Defined by an array of NSString that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only) |
| $validity | integer | the number of seconds after which the key will be automatically removed (0 means no time limit for this key) |
| $maxQueriesPerIPPerHour | integer | Specify the maximum number of API calls allowed from an IP address per hour. Defaults to 0 (no rate limit). |
| $maxHitsPerQuery | integer | Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited) |
| return | mixed | |
