Config
in package
Table of Contents
Properties
- $appContext : AppContextInterface
- $file : string
- $logItems : array<string|int, Item>
- $active : string
- $data : array<string|int, mixed>
- Lizmap log configuration data.
- $profile : string
- $properties : array<string|int, mixed>
- general properties.
Methods
- __construct() : mixed
- Constructs the object. This method shouldn't be called, you should call lizmap::getLogConfig() instead.
- getLogItem() : Item
- Get a log item.
- getLogItemList() : array<string|int, string>
- Get a list of log items names.
- getProperties() : array<string|int, string>
- modify() : mixed
- Modify the general options.
- save() : mixed
- save the global configuration data.
- update() : mixed
- Update the global config data. (modify and save).
- updateItem() : mixed
- Save the properties of a log Item in the ini file.
Properties
$appContext
protected
AppContextInterface
$appContext
$file
protected
string
$file
The location of the ini file
$logItems
protected
array<string|int, Item>
$logItems
= array()
list of log items of the ini file
$active
private
string
$active
= ''
If the log is active globally or not
$data
Lizmap log configuration data.
private
array<string|int, mixed>
$data
= array()
$profile
private
string
$profile
= ''
database profile
$properties
general properties.
private
array<string|int, mixed>
$properties
= array('active', 'profile')
Methods
__construct()
Constructs the object. This method shouldn't be called, you should call lizmap::getLogConfig() instead.
public
__construct(array<string|int, mixed> $configData, AppContextInterface $appContext, string $iniFilePath) : mixed
Parameters
- $configData : array<string|int, mixed>
-
An array containing the ini file
- $appContext : AppContextInterface
-
The context
- $iniFilePath : string
-
the path to the ini file folder
getLogItem()
Get a log item.
public
getLogItem(string $key) : Item
Parameters
- $key : string
-
Key of the log item to get
Return values
ItemgetLogItemList()
Get a list of log items names.
public
getLogItemList() : array<string|int, string>
Return values
array<string|int, string> —list of names
getProperties()
public
getProperties() : array<string|int, string>
Return values
array<string|int, string>modify()
Modify the general options.
public
modify(array<string|int, mixed> $data) : mixed
Parameters
- $data : array<string|int, mixed>
-
associative array containing the global config data
save()
save the global configuration data.
public
save([null|mixed $ini = null ]) : mixed
Parameters
- $ini : null|mixed = null
update()
Update the global config data. (modify and save).
public
update(mixed $profile, mixed $active[, null|mixed $ini = null ]) : mixed
Parameters
- $profile : mixed
- $active : mixed
- $ini : null|mixed = null
updateItem()
Save the properties of a log Item in the ini file.
public
updateItem(mixed $key) : mixed
Parameters
- $key : mixed