AlgoliaSearch\ClientContext
Synopsis
class ClientContext
{
- // members
- public $applicationID;
- public $apiKey;
- public $readHostsArray;
- public $writeHostsArray;
- public $curlMHandle;
- public $adminAPIKey;
- public $endUserIP;
- public $algoliaUserToken;
- public $connectTimeout;
- private FailingHostsCache $failingHostsCache;
- // methods
- public void __construct()
- private array getDefaultReadHosts()
- private array getDefaultWriteHosts()
- public void __destruct()
- public resource getMHandle()
- public void releaseMHandle()
- public void setForwardedFor()
- public void setAlgoliaUserToken()
- public void setRateLimit()
- public void disableRateLimit()
- public void setExtraHeader()
- public void addFailingHost()
- public FailingHostsCache getFailingHostsCache()
- public void rotateHosts()
Members
private
- $failingHostsCache — AlgoliaSearch\FailingHostsCache
public
- $adminAPIKey — string
- $algoliaUserToken — string
- $apiKey — string
- $applicationID — string
- $connectTimeout — int
- $curlMHandle — resource
- $endUserIP — string
- $readHostsArray — array
- $writeHostsArray — array
Methods
private
public
- __construct()
- __destruct() — Closes eventually opened curl handles.
- addFailingHost()
- disableRateLimit() — Disables the rate limit.
- getFailingHostsCache()
- getMHandle()
- releaseMHandle()
- rotateHosts() — This method is called to pass on failing hosts.
- setAlgoliaUserToken()
- setExtraHeader()
- setForwardedFor()
- setRateLimit()