Config
in package
Table of Contents
Properties
- $parameters : array<string|int, mixed>
- $publicParameters : array<string|int, mixed>
Methods
- __construct() : mixed
- all() : array<string|int, mixed>
- allPublic() : array<string|int, mixed>
- Returns the public (non-server) parameters, which are also meant for clients (Admin, Front).
- get() : mixed
- path() : string
- Returns a path from a parameter shaped `{abs, rel}`.
- value() : mixed
- Returns the parameter `params.<module>.<key>` (modules are numbers), or `$default` when missing or null.
Properties
$parameters
private
array<string|int, mixed>
$parameters
= []
$publicParameters
private
array<string|int, mixed>
$publicParameters
= []
Methods
__construct()
public
__construct([array<string|int, mixed> $parameters = [] ][, array<string|int, mixed> $publicParameters = [] ]) : mixed
Parameters
- $parameters : array<string|int, mixed> = []
-
server parameters (
%params%): directories, absolute paths, infrastructure. Meant for the Api, never sent to clients. - $publicParameters : array<string|int, mixed> = []
-
public parameters (
%publicParams%), non-server (page id and the like). Merged with the DB and sent to clients.
all()
public
all() : array<string|int, mixed>
Return values
array<string|int, mixed>allPublic()
Returns the public (non-server) parameters, which are also meant for clients (Admin, Front).
public
allPublic() : array<string|int, mixed>
Return values
array<string|int, mixed>get()
public
get(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
- $default : mixed = null
path()
Returns a path from a parameter shaped `{abs, rel}`.
public
path(int $module, string $key[, string $variant = 'abs' ]) : string
A missing key, variant, or a non-string value yields ''; the caller must handle the
empty path itself (usually by throwing). Mirrors SettingContext::path().
Parameters
- $module : int
- $key : string
- $variant : string = 'abs'
Return values
stringvalue()
Returns the parameter `params.<module>.<key>` (modules are numbers), or `$default` when missing or null.
public
value(int $module, string $key[, mixed $default = null ]) : mixed
Parameters
- $module : int
- $key : string
- $default : mixed = null