PHP Класс AlgoliaSearch\ClientContext

Показать файл Открыть проект

Открытые свойства

Свойство Тип Описание
$adminAPIKey string
$algoliaUserToken string
$apiKey string
$applicationID string
$connectTimeout integer
$curlMHandle resource
$endUserIP string
$readHostsArray array
$writeHostsArray array

Открытые методы

Метод Описание
__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 )

Приватные методы

Метод Описание
getDefaultReadHosts ( boolean $placesEnabled ) : array
getDefaultWriteHosts ( ) : array

Описание методов

__construct() публичный метод

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

__destruct() публичный метод

Closes eventually opened curl handles.
public __destruct ( )

disableRateLimit() публичный метод

Disables the rate limit.
public disableRateLimit ( )

getMHandle() публичный метод

public getMHandle ( $curlHandle ) : resource
$curlHandle
Результат resource

releaseMHandle() публичный метод

public releaseMHandle ( $curlHandle )
$curlHandle

setAlgoliaUserToken() публичный метод

public setAlgoliaUserToken ( string $token )
$token string

setExtraHeader() публичный метод

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

setForwardedFor() публичный метод

public setForwardedFor ( string $ip )
$ip string

setRateLimit() публичный метод

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

Описание свойств

$adminAPIKey публичное свойство

public string $adminAPIKey
Результат string

$algoliaUserToken публичное свойство

public string $algoliaUserToken
Результат string

$apiKey публичное свойство

public string $apiKey
Результат string

$applicationID публичное свойство

public string $applicationID
Результат string

$connectTimeout публичное свойство

public int $connectTimeout
Результат integer

$curlMHandle публичное свойство

public resource $curlMHandle
Результат resource

$endUserIP публичное свойство

public string $endUserIP
Результат string

$readHostsArray публичное свойство

public array $readHostsArray
Результат array

$writeHostsArray публичное свойство

public array $writeHostsArray
Результат array