ApiOpenStudio PHPDoc

Config
in package

Class Config

ApiOpenStudio config.

Table of Contents

$conf  : array<string|int, mixed>
Internal config array.
__construct()  : mixed
Config constructor.
__get()  : string|null
Get a config value.
all()  : array<string|int, mixed>
Fetch all config values.

Properties

$conf

Internal config array.

private array<string|int, mixed> $conf

Methods

__construct()

Config constructor.

public __construct([string $settingsFile = '' ]) : mixed
Parameters
$settingsFile : string = ''

Optional path to the settings file.

Return values
mixed

__get()

Get a config value.

public __get(array<string|int, mixed>|string $key) : string|null
Parameters
$key : array<string|int, mixed>|string

The key of the config value.

Tags
throws
ApiException

Invalid config defined.

Return values
string|null

The value of the config key or NULL.

all()

Fetch all config values.

public all() : array<string|int, mixed>
Return values
array<string|int, mixed>

Config file values.

Search results