Class Yate\Api\Config

`implements`	`ConfigInterface`

Base Config impementation to use out-of-the-box

You may extend with constructor which will take Yate core location and secrets from whereever you want: file, environments, e.t.c.

Located at Yate/Api/Config.php

Methods


					
	public

withNode(string[] $nodes, string $uri, string $secret): self

Setup Yate API node records for one host/server

Usual, multiple yate 'nodes' may reside on one host and share one API entry point.

Then, we need each api entry point to be registered in the config with a lost of 'nodes' and it's access secret.

Mind that each 'node' may only be registered once, mean if you include a 'node', say, 'hss' in two cosecutive calls of the methid, only last record will survive.

Parameters

`$nodes`	Node's list of component installed, like ['hss','smsc','ucn']
`$uri`	Node's api entry point, full URI like `'http://10.3.2.5/api.php'`
`$secret`	Node's secret to authorise access

Returns

For method chaining


					
	public

withNodeList(array[] $nodes): self

Setup Yate API nodes for multiple hosts/seervers

In fact, it is a shorthand for iteration over array and send each array element to withNode() as:

withNode(...$element);

So, it is expected that each elemen is an array too and it's content match withNode() args by order, and, for future PHP versions, by key names.

Parameters

$nodes

array of withNode() argument arrays

Returns

For chaining


					
	public

getNodeUri(string $node): string

Provides API URI for given node

Should return API URI for e given node as string. If there no URI for a node configured, YateConfigException must be thrown.

Throws

Yate\Api\Exception\YateConfigException

Implements

Yate\Api\ConfigInterface::getNodeUri()


					
	public

getNodeSecret(string $node): string

Provides access secret for given node

Should return access secret for a given node as string. If there no secret for a node configured, YateConfigException must be thrown.

Throws

Yate\Api\Exception\YateConfigException

Implements

Yate\Api\ConfigInterface::getNodeSecret()

Properties
`protected`	`array`	`$uris = []`	#
`protected`	`array`	`$secrets = []`	#

Namespaces

Classes

Interfaces

Class Yate\Api\Config

Parameters

Returns

Parameters

Returns

Throws

Implements

Throws

Implements