lizmap
in package
Table of Contents
Properties
- $appContext : null|JelixContext
- $lizmapConfig : mixed
- $lizmapLogConfig : mixed
- $lizmapLogConfigInstance : null|Config
- $lizmapServicesInstance : null|lizmapServices
- $logger : null|Logger
- $repositories : array<string|int, string>
- $repositoryInstances : array<string|int, Repository>
Methods
- constructRepositoryForm() : jFormsBase
- Get the jForm for a repository.
- createRepository() : null|Repository
- Create a repository.
- getAppContext() : JelixContext
- getLogConfig() : Config
- Get global configuration for logs.
- getLogger() : Logger
- getLogItem() : Item
- Get a log item.
- getLogItemList() : array<string|int, string>
- Get a list of log items names.
- getLogItemProperties() : array<string|int, string>
- Get the list of properties for a generic log item.
- getProject() : null|Project
- Get a project.
- getRepository() : null|Repository
- Get a repository.
- getRepositoryList() : array<string|int, Repository>|array<string|int, string>
- Get a list of repository names.
- getRepositoryProperties() : array<string|int, string>
- Get the list of properties for a generic repository.
- getRepositoryPropertiesOptions() : array<string, array<string, bool|string>>
- Get the list of properties options for a generic repository.
- getServices() : lizmapServices
- getTheme() : lizmapTheme
- logMetric() : mixed
- Send metrics to the logger.
- removeRepository() : bool
- Removes a repository.
- saveServices() : mixed
- startMetric() : mixed
- call it at the beginning of your controller if you want to call logMetric later.
- updateRepository() : bool
- Update a repository.
- __construct() : mixed
- this is a static class, so private constructor.
Properties
$appContext
protected
static null|JelixContext
$appContext
The jelixContext instance for the singleton
$lizmapConfig
protected
static mixed
$lizmapConfig
= 'config/lizmapConfig.ini.php'
$lizmapLogConfig
protected
static mixed
$lizmapLogConfig
= 'config/lizmapLogConfig.ini.php'
$lizmapLogConfigInstance
protected
static null|Config
$lizmapLogConfigInstance
The Lizmap Logger Config instance for the singleton
$lizmapServicesInstance
protected
static null|lizmapServices
$lizmapServicesInstance
The lizmapServices instance for the singleton
$logger
protected
static null|Logger
$logger
The logger instance
$repositories
protected
static array<string|int, string>
$repositories
= array()
List of repositories names
$repositoryInstances
protected
static array<string|int, Repository>
$repositoryInstances
= array()
list of repository instances. keys are repository names
Methods
constructRepositoryForm()
Get the jForm for a repository.
public
static constructRepositoryForm(null|Repository $rep, jFormsBase $form) : jFormsBase
Parameters
- $rep : null|Repository
- $form : jFormsBase
Return values
jFormsBasecreateRepository()
Create a repository.
public
static createRepository(string $key, array<string|int, mixed> $data) : null|Repository
Parameters
- $key : string
-
the repository name
- $data : array<string|int, mixed>
-
list of properties for the repository
Return values
null|RepositorygetAppContext()
public
static getAppContext() : JelixContext
Return values
JelixContext —The lizmap application jelixContext
getLogConfig()
Get global configuration for logs.
public
static getLogConfig() : Config
Return values
ConfiggetLogger()
public
static getLogger() : Logger
Return values
Logger —The logger instance
getLogItem()
Get a log item.
public
static 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
static getLogItemList() : array<string|int, string>
Return values
array<string|int, string> —list of names
getLogItemProperties()
Get the list of properties for a generic log item.
public
static getLogItemProperties() : array<string|int, string>
Return values
array<string|int, string> —list of properties name
getProject()
Get a project.
public
static getProject(string $key) : null|Project
Parameters
- $key : string
-
the project name
Tags
Return values
null|Project —null if it does not exist
getRepository()
Get a repository.
public
static getRepository(string $key) : null|Repository
Parameters
- $key : string
-
Key of the repository to get
Return values
null|RepositorygetRepositoryList()
Get a list of repository names.
public
static getRepositoryList([bool $asObject = false ]) : array<string|int, Repository>|array<string|int, string>
Parameters
- $asObject : bool = false
Return values
array<string|int, Repository>|array<string|int, string> —List of repositories names
getRepositoryProperties()
Get the list of properties for a generic repository.
public
static getRepositoryProperties() : array<string|int, string>
This method shouldn't be used, you should use Repository::getProperties() instead.
Return values
array<string|int, string> —List of properties names
getRepositoryPropertiesOptions()
Get the list of properties options for a generic repository.
public
static getRepositoryPropertiesOptions() : array<string, array<string, bool|string>>
This method shouldn't be used, you should use Repository::getPropertiesOptions() instead.
Return values
array<string, array<string, bool|string>>getServices()
public
static getServices() : lizmapServices
Return values
lizmapServicesgetTheme()
public
static getTheme() : lizmapTheme
Return values
lizmapThemelogMetric()
Send metrics to the logger.
public
static logMetric(string $label, string $service[, array<string|int, mixed> $payload = array() ]) : mixed
Metrics contains the time spent to do the action, since the call of startMetric()
Parameters
- $label : string
-
Name of the action to log
- $service : string
-
name of a service (could be a SIG service like WMD, WFS or any other service into Lizmap
- $payload : array<string|int, mixed> = array()
-
some values about the action
removeRepository()
Removes a repository.
public
static removeRepository(string $key) : bool
Parameters
- $key : string
-
the repository name
Return values
bool —true if the repository was known
saveServices()
public
static saveServices() : mixed
startMetric()
call it at the beginning of your controller if you want to call logMetric later.
public
static startMetric([float|string $start = 'now' ]) : mixed
Parameters
- $start : float|string = 'now'
-
indicate the start time. time in Milli-seconds, or 'now' for the current time, or 'request' for the PHP Http Request time.
updateRepository()
Update a repository.
public
static updateRepository(string $key, array<string|int, mixed> $data) : bool
Parameters
- $key : string
-
the repository name
- $data : array<string|int, mixed>
-
the repository data
Return values
bool —false if the repository corresponding to $key cannot be found or if there is no valid entry in $data
__construct()
this is a static class, so private constructor.
private
__construct() : mixed