lizmapLogItem
in package
Table of Contents
Properties
- $item : Item
Methods
- __construct() : mixed
- Construct the object, you should use the lizmapLogConfig::getLogItem() method which will call this constructor.
- getData() : mixed
- Return data for a log item.
- getKey() : mixed
- Return log item key.
- getProperties() : array<string|int, string>
- getRecordKeys() : array<string|int, string>
- getSProperties() : array<string|int, string>
- increaseLogCounter() : mixed
- Increase counter for this log item.
- insertLogDetail() : mixed
- Insert a new line of log for this item.
- update() : bool
- Update the data for the log item in the ini file.
Properties
$item
protected
Item
$item
Methods
__construct()
Construct the object, you should use the lizmapLogConfig::getLogItem() method which will call this constructor.
public
__construct(string $key, array<string|int, mixed> $readConfigPath, AppContextInterface $appContext) : mixed
Parameters
- $key : string
-
the name of the item
- $readConfigPath : array<string|int, mixed>
-
the array containing the fields of lizmapLogConfig.ini.php
- $appContext : AppContextInterface
getData()
Return data for a log item.
public
getData(string $key) : mixed
Parameters
- $key : string
-
Key of the log item
getKey()
Return log item key.
public
getKey() : mixed
getProperties()
public
getProperties() : array<string|int, string>
Return values
array<string|int, string> —list of properties name
getRecordKeys()
public
getRecordKeys() : array<string|int, string>
Return values
array<string|int, string> —list of record keys
getSProperties()
public
static getSProperties() : array<string|int, string>
Return values
array<string|int, string> —list of properties name
increaseLogCounter()
Increase counter for this log item.
public
increaseLogCounter([mixed $repository = '' ][, mixed $project = '' ][, mixed $profile = 'lizlog' ]) : mixed
Parameters
- $repository : mixed = ''
- $project : mixed = ''
- $profile : mixed = 'lizlog'
insertLogDetail()
Insert a new line of log for this item.
public
insertLogDetail(array<string|int, mixed> $data[, mixed $profile = 'lizlog' ]) : mixed
Parameters
- $data : array<string|int, mixed>
-
list of details to save
- $profile : mixed = 'lizlog'
update()
Update the data for the log item in the ini file.
public
update(mixed $data) : bool
Parameters
- $data : mixed
Return values
bool —true if there were some modifications