PHP 클래스 AlgoliaSearch\ClientContext

파일 보기 프로젝트 열기: algolia/algoliasearch-client-php

공개 프로퍼티들

프로퍼티 타입 설명
$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