• 홈
• AlgoliaSearch
• Client

PHP 클래스 AlgoliaSearch\Client

You should instantiate a Client object with your ApplicationID, ApiKey and Hosts to start using Algolia Search API 파일 보기 프로젝트 열기: algolia/algoliasearch-client-php 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$caInfoPath	string
$context	ClientContext
$curlConstants	array
$curlOptions	array
$placesEnabled	boolean

공개 메소드들

메소드	설명
__construct ( string $applicationID, string $apiKey, array | null $hostsArray = null, array $options = [] )	Algolia Search initialization.
__destruct ( )	Release curl handle.
addUserKey ( array $obj, integer $validity, integer $maxQueriesPerIPPerHour, integer $maxHitsPerQuery, array | null $indexes = null ) : mixed	Create a new user key.
batch ( array $requests ) : mixed	Send a batch request targeting multiple indices.
buildQuery ( array $args ) : string
copyIndex ( string $srcIndexName, string $dstIndexName ) : mixed	Copy an existing index.
deleteIndex ( string $indexName ) : mixed	Delete an index.
deleteUserKey ( string $key ) : mixed	Delete an existing user key.
disableRateLimitForward ( )	Disable IP rate limit enabled with enableRateLimitForward() function.
doRequest ( ClientContext $context, string $method, string $host, string $path, array $params, array $data, integer $connectTimeout, integer $readTimeout ) : mixed
enableRateLimitForward ( string $adminAPIKey, string $endUserIP, string $rateLimitAPIKey )	Allow to use IP rate limit when you have a proxy between end-user and Algolia.
generateSecuredApiKey ( string $privateApiKey, mixed $query, string | null $userToken = null ) : string	Generate a secured and public API Key from a list of query parameters and an optional user token identifying the current user.
getLogs ( integer $offset, integer $length = 10, mixed $type = 'all' ) : mixed	Return last logs entries.
getUserKeyACL ( string $key ) : mixed	Get ACL of a user key.
initIndex ( string $indexName ) : Index	Get the index object initialized (no server call needed for initialization).
initPlaces ( string $appId, string $apiKey, array $hostsArray = null, array $options = [] ) : PlacesIndex
isAlive ( )	Call isAlive.
listIndexes ( ) : mixed	List all existing indexes return an object in the form: array( "items" => array( array("name" => "contacts", "createdAt" => "2013-01-18T15:33:13.556Z"), array("name" => "notes", "createdAt" => "2013-01-18T15:33:13.556Z") ) ).
listUserKeys ( ) : mixed	List all existing user keys with their associated ACLs.
moveIndex ( string $srcIndexName, string $dstIndexName ) : mixed	Move an existing index.
multipleQueries ( array $queries, string $indexNameKey = 'indexName', string $strategy = 'none' ) : mixed	This method allows to query multiple indexes with one API call.
request ( ClientContext $context, string $method, string $path, array $params, array $data, array $hostsArray, integer $connectTimeout, integer $readTimeout ) : mixed
setAlgoliaUserToken ( string $token )	It's possible to use the following token to track users that have the same IP or to track users that use different devices.
setConnectTimeout ( integer $connectTimeout, integer $timeout = 30, integer $searchTimeout = 5 )	Change the default connect timeout of 2s to a custom value (only useful if your server has a very slow connectivity to Algolia backend).
setExtraHeader ( string $key, string $value )	Allow to set custom headers.
setForwardedFor ( string $ip )	The aggregation of the queries to retrieve the latest query uses the IP or the user token to work efficiently.
updateUserKey ( string $key, array $obj, integer $validity, integer $maxQueriesPerIPPerHour, integer $maxHitsPerQuery, array | null $indexes = null ) : mixed	Update a user key.

보호된 메소드들

메소드	설명
checkCurlOptions ( array $curlOptions ) : array	Checks if curl option passed are valid curl options.
getCurlConstants ( ) : array	Get all php curl available options.
invalidOptions ( array $curlOptions = [], string $errorMsg = '' )	throw clear Exception when bad curl option is set.

비공개 메소드들

메소드	설명
getPlacesIndex ( ) : PlacesIndex

메소드 상세

프로퍼티 상세