phpDocumentor

ConfigurationStorageRepository
in

Interface ConfigurationStorageRepository

Table of Contents

delete()  : void
Deletes a configuration from namespace by using the given key.
deleteAll()  : void
Deletes all configurations from namespace.
get()  : string
Returns the configuration value of the given key.
getAll()  : array<string|int, mixed>
Returns a list of all configurations in the current namespace.
getAllTree()  : array<string|int, mixed>
Returns a list of all configurations in the current namespace.
is()  : bool
Checks if configuration value of given key represents true boolean.
set()  : void
Sets a configuration with the given value.
setAll()  : void
Updates a list of configurations.

Methods

delete()

Deletes a configuration from namespace by using the given key.

public delete(string $key) : void
Parameters
$key : string
Return values
void —

deleteAll()

Deletes all configurations from namespace.

public deleteAll([string $prefix = '' ]) : void

It is possible to restrict the delete command by providing a prefix.

Parameters
$prefix : string = ''
Return values
void —

get()

Returns the configuration value of the given key.

public get(string $key) : string
Parameters
$key : string
Return values
string —

getAll()

Returns a list of all configurations in the current namespace.

public getAll([string $prefix = '' ]) : array<string|int, mixed>

Additionally, it is possible to use a prefix for further filtering. The format of the returned array is flat (one dimensional array).

Parameters
$prefix : string = ''
Return values
array<string|int, mixed> —

getAllTree()

Returns a list of all configurations in the current namespace.

public getAllTree([string $prefix = '' ]) : array<string|int, mixed>

Additionally, it is possible to use a prefix for further filtering. The format of the returned array is a tree (multi dimensional array).

Parameters
$prefix : string = ''
Return values
array<string|int, mixed> —

is()

Checks if configuration value of given key represents true boolean.

public is(string $key) : bool
Parameters
$key : string
Return values
bool —

set()

Sets a configuration with the given value.

public set(string $key, string $value) : void
Parameters
$key : string
$value : string
Return values
void —

setAll()

Updates a list of configurations.

public setAll(array<string|int, mixed> $configTree) : void

The data array will be flattened, so it is possible to use a tree array.

Parameters
$configTree : array<string|int, mixed>
Return values
void —

Search results