ApiCall
in package
Class ApiCall
Tags
Table of Contents
Constants
- API_KEY_HEADER_NAME = 'X-TYPESENSE-API-KEY'
Properties
- $logger : LoggerInterface
- $client : ClientInterface
- $config : Configuration
- $nearestNode : Node|null
- $nodeIndex : int
- $nodes : array<string|int, mixed>|array<string|int, Node>
Methods
- __construct() : mixed
- ApiCall constructor.
- delete() : array<string|int, mixed>
- get() : string|array<string|int, mixed>
- getException() : TypesenseClientError
- getLogger() : LoggerInterface
- getNode() : Node
- Returns a healthy host from the pool in a round-robin fashion Might return an unhealthy host periodically to check for recovery.
- patch() : array<string|int, mixed>
- post() : array<string|int, mixed>|string
- put() : array<string|int, mixed>
- setNodeHealthCheck() : void
- getRequestOptions() : array<string|int, mixed>
- initializeNodes() : void
- Initialize Nodes
- makeRequest() : string|array<string|int, mixed>
- Makes the actual http request, along with retries
- nodeDueForHealthCheck() : bool
Constants
API_KEY_HEADER_NAME
private
mixed
API_KEY_HEADER_NAME
= 'X-TYPESENSE-API-KEY'
Properties
$logger
public
LoggerInterface
$logger
$client
private
ClientInterface
$client
$config
private
Configuration
$config
$nearestNode
private
static Node|null
$nearestNode
$nodeIndex
private
int
$nodeIndex
$nodes
private
static array<string|int, mixed>|array<string|int, Node>
$nodes
Methods
__construct()
ApiCall constructor.
public
__construct(Configuration $config) : mixed
Parameters
- $config : Configuration
delete()
public
delete(string $endPoint[, bool $asJson = true ][, array<string|int, mixed> $queryParameters = [] ]) : array<string|int, mixed>
Parameters
- $endPoint : string
- $asJson : bool = true
- $queryParameters : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>get()
public
get(string $endPoint, array<string|int, mixed> $params[, bool $asJson = true ]) : string|array<string|int, mixed>
Parameters
- $endPoint : string
- $params : array<string|int, mixed>
- $asJson : bool = true
Tags
Return values
string|array<string|int, mixed>getException()
public
getException(int $httpCode) : TypesenseClientError
Parameters
- $httpCode : int
Return values
TypesenseClientErrorgetLogger()
public
getLogger() : LoggerInterface
Return values
LoggerInterfacegetNode()
Returns a healthy host from the pool in a round-robin fashion Might return an unhealthy host periodically to check for recovery.
public
getNode() : Node
Return values
Nodepatch()
public
patch(string $endPoint, array<string|int, mixed> $body[, bool $asJson = true ][, array<string|int, mixed> $queryParameters = [] ]) : array<string|int, mixed>
Parameters
- $endPoint : string
- $body : array<string|int, mixed>
- $asJson : bool = true
- $queryParameters : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>post()
public
post(string $endPoint, mixed $body[, bool $asJson = true ][, array<string|int, mixed> $queryParameters = [] ]) : array<string|int, mixed>|string
Parameters
- $endPoint : string
- $body : mixed
- $asJson : bool = true
- $queryParameters : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>|stringput()
public
put(string $endPoint, array<string|int, mixed> $body[, bool $asJson = true ][, array<string|int, mixed> $queryParameters = [] ]) : array<string|int, mixed>
Parameters
- $endPoint : string
- $body : array<string|int, mixed>
- $asJson : bool = true
- $queryParameters : array<string|int, mixed> = []
Tags
Return values
array<string|int, mixed>setNodeHealthCheck()
public
setNodeHealthCheck(Node $node, bool $isHealthy) : void
Parameters
- $node : Node
- $isHealthy : bool
getRequestOptions()
private
getRequestOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>initializeNodes()
Initialize Nodes
private
initializeNodes() : void
makeRequest()
Makes the actual http request, along with retries
private
makeRequest(string $method, string $endPoint, bool $asJson, array<string|int, mixed> $options) : string|array<string|int, mixed>
Parameters
- $method : string
- $endPoint : string
- $asJson : bool
- $options : array<string|int, mixed>
Tags
Return values
string|array<string|int, mixed>nodeDueForHealthCheck()
private
nodeDueForHealthCheck(Node $node) : bool
Parameters
- $node : Node