PHP Class AlgoliaSearch\ClientContext

Show file Open project: algolia/algoliasearch-client-php

Public Properties

Property Type Description
$adminAPIKey string
$algoliaUserToken string
$apiKey string
$applicationID string
$connectTimeout integer
$curlMHandle resource
$endUserIP string
$readHostsArray array
$writeHostsArray array

Public Methods

Method Description
__construct ( string $applicationID, string $apiKey, array $hostsArray, boolean $placesEnabled = false ) ClientContext constructor.
__destruct ( ) Closes eventually opened curl handles.
disableRateLimit ( ) Disables the rate limit.
getMHandle ( $curlHandle ) : resource
releaseMHandle ( $curlHandle )
setAlgoliaUserToken ( string $token )
setExtraHeader ( string $key, string $value )
setForwardedFor ( string $ip )
setRateLimit ( string $adminAPIKey, string $endUserIP, string $rateLimitAPIKey )

Private Methods

Method Description
getDefaultReadHosts ( boolean $placesEnabled ) : array
getDefaultWriteHosts ( ) : array

Method Details

__construct() public method

ClientContext constructor.
public __construct ( string $applicationID, string $apiKey, array $hostsArray, boolean $placesEnabled = false )
$applicationID string
$apiKey string
$hostsArray array
$placesEnabled boolean

__destruct() public method

Closes eventually opened curl handles.
public __destruct ( )

disableRateLimit() public method

Disables the rate limit.
public disableRateLimit ( )

getMHandle() public method

public getMHandle ( $curlHandle ) : resource
$curlHandle
return resource

releaseMHandle() public method

public releaseMHandle ( $curlHandle )
$curlHandle

setAlgoliaUserToken() public method

public setAlgoliaUserToken ( string $token )
$token string

setExtraHeader() public method

public setExtraHeader ( string $key, string $value )
$key string
$value string

setForwardedFor() public method

public setForwardedFor ( string $ip )
$ip string

setRateLimit() public method

public setRateLimit ( string $adminAPIKey, string $endUserIP, string $rateLimitAPIKey )
$adminAPIKey string
$endUserIP string
$rateLimitAPIKey string

Property Details

$adminAPIKey public property

public string $adminAPIKey
return string

$algoliaUserToken public property

public string $algoliaUserToken
return string

$apiKey public property

public string $apiKey
return string

$applicationID public property

public string $applicationID
return string

$connectTimeout public property

public int $connectTimeout
return integer

$curlMHandle public property

public resource $curlMHandle
return resource

$endUserIP public property

public string $endUserIP
return string

$readHostsArray public property

public array $readHostsArray
return array

$writeHostsArray public property

public array $writeHostsArray
return array