Item
in package
Table of Contents
Properties
- $appContext : mixed
- $data : mixed
- $key : mixed
- $properties : mixed
- $recordKeys : mixed
Methods
- __construct() : mixed
- Construct the object, you should use the Log\Config::getLogItem() method which will call this constructor.
- getData() : mixed
- Return data for a log item.
- getKey() : mixed
- Return log item key.
- 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.
- setProperty() : mixed
Properties
$appContext
protected
mixed
$appContext
$data
private
mixed
$data
= array()
$key
private
mixed
$key
= ''
$properties
private
static mixed
$properties
= array('label', 'logCounter', 'logDetail', 'logIp', 'logEmail')
$recordKeys
private
static mixed
$recordKeys
= array('key', 'user', 'content', 'repository', 'project', 'ip', 'email')
Methods
__construct()
Construct the object, you should use the Log\Config::getLogItem() method which will call this constructor.
public
__construct(string $key, array<string|int, mixed> $iniSection, AppContextInterface $appContext) : mixed
Parameters
- $key : string
-
the name of the item
- $iniSection : 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
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([string $repository = '' ][, string $project = '' ][, string $profile = 'lizlog' ]) : mixed
Parameters
- $repository : string = ''
- $project : string = ''
- $profile : string = '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, the keys should be one of the RecordKeys (The key field is mandatory)
- $profile : mixed = 'lizlog'
setProperty()
public
setProperty(mixed $prop, mixed $value) : mixed
Parameters
- $prop : mixed
- $value : mixed