Documentation

Configuration
in package

Class Configuration

Tags
date

4/5/20

author

Abdullah Al-Faqeir abdullah@devloops.net

Table of Contents

Properties

$apiKey  : string
$client  : null|ClientInterface
$healthCheckIntervalSeconds  : int
$logger  : LoggerInterface
$logLevel  : int
$nearestNode  : Node|null
$nodes  : array<string|int, Node>
$numRetries  : float
$retryIntervalSeconds  : float

Methods

__construct()  : mixed
Configuration constructor.
getApiKey()  : mixed|string
getClient()  : ClientInterface
getHealthCheckIntervalSeconds()  : float|mixed
getLogger()  : LoggerInterface
getNearestNode()  : Node
getNodes()  : array<string|int, Node>
getNumRetries()  : float
getRetryIntervalSeconds()  : float
validateNodeFields()  : bool
validateConfigArray()  : void

Properties

$healthCheckIntervalSeconds

private int $healthCheckIntervalSeconds

Methods

__construct()

Configuration constructor.

public __construct(array<string|int, mixed> $config) : mixed
Parameters
$config : array<string|int, mixed>
Tags
throws
ConfigError

getApiKey()

public getApiKey() : mixed|string
Return values
mixed|string

getHealthCheckIntervalSeconds()

public getHealthCheckIntervalSeconds() : float|mixed
Return values
float|mixed

getNumRetries()

public getNumRetries() : float
Return values
float

getRetryIntervalSeconds()

public getRetryIntervalSeconds() : float
Return values
float

validateNodeFields()

public validateNodeFields(array<string|int, mixed> $node) : bool
Parameters
$node : array<string|int, mixed>
Return values
bool

validateConfigArray()

private validateConfigArray(array<string|int, mixed> $config) : void
Parameters
$config : array<string|int, mixed>
Tags
throws
ConfigError

        
On this page

Search results