Lizmap Web Client Master

lizmapServices

in package

• Application

Manage and give access to lizmap configuration.

Tags

author

3liz

copyright

2012-2022 3liz

see

http://3liz.com

license

Mozilla Public License : http://www.mozilla.org/MPL/

Table of Contents

Properties

$adminContactEmail  : string

Admin contact email.

$adminSenderEmail  : string

Administrator sender email.

$adminSenderName  : string

Administrator sender name.

$allInMap  : mixed

Display all project in maps.

$allowUserAccountRequests  : mixed

If we allow to view the form to request an account.

$appName  : string

Application name.

$cacheExpiration  : string

Cache expiration.

$cacheRedisDb  : string

Redis DB.

$cacheRedisHost  : string

Redis host.

$cacheRedisKeyPrefix  : string

Redis key prefix.

$cacheRedisKeyPrefixFlushMethod  : string

Method to flush keys when $cacheRedisKeyPrefix is set.

$cacheRedisPort  : string

Redis port.

$cacheRootDirectory  : string

Cache root directory.

$cacheStorageType  : string

Map cache server type.

$debugMode  : mixed

Debug mode : none or log.

$defaultProject  : string

Default project in default repository.

$defaultRepository  : string

Default repository.

$googleAnalyticsID  : string

Application ID for Google Analytics.

$lizmapPluginAPIURL  : string

URL to the API exposed by the Lizmap plugin for QGIS Server.

$onlyMaps  : mixed

Do not display Lizmap projects page.

$projectSwitcher  : mixed

Show projects switcher in maps page.

$proxyHttpBackend  : string

backend to use to do http request : use curl ('curl') or file_get_contents ('php').

$qgisProjectsPrivateDataFolder  : string

Root folder of QGIS project inspection data output files (qgis-project-validator).

$qgisServerVersion  : string

QGIS Server version For external modules only, which are still using the variable.

$relativeWMSPath  : string

Does the server use relative Path from root folder?

$requestProxyEnabled  : bool

Map cache server.

$requestProxyHost  : string

Proxy host.

$requestProxyNotForDomain  : string

List of domains separated by a comma, to which the proxy is not used.

$requestProxyPassword  : string

Proxy password.

$requestProxyPort  : string

Proxy port.

$requestProxyType  : string

Proxy type: 'http' or 'socks5'. Only used with the curl proxyHttpBackend.

$requestProxyUser  : string

Proxy user.

$rootRepositories  : string

Root folder of repositories.

$uploadedImageMaxWidthHeight  : int

Uploaded image maximum width and height.

$wmsMaxHeight  : int

WMS max height.

$wmsMaxWidth  : int

WMS max width.

$wmsPublicUrlList  : string

Public WMS list.

$wmsServerHeaders  : array<string|int, mixed>

Headers to send to WMS map server.

$wmsServerURL  : string

QGIS Server URL.

$appContext  : mixed

$data  : mixed

Lizmap configuration data from lizmapConfig.ini.php This allow to access to configuration properties that are not exposed via properties member for this class.

$globalConfig  : mixed

$globalConfigProperties  : array<string|int, mixed>

List of properties mapped to a parameter of the main configuration of Jelix.

$isUsingLdap  : mixed

$metricsEnabled  : bool|int

$notEditableProperties  : array<string|int, string>

List of properties that are not editable at all.

$properties  : mixed

List of all properties of lizmapServices that are editable in the configuration form of Lizmap.

$sensitiveProperties  : mixed

services properties to not display into the configuration form, when hideSensitiveServicesProperties is set to 1.

$varPath  : mixed

Methods

__construct()  : mixed

constructor method.

areMetricsEnabled()  : bool|int

getLizmapRepository()  : lizmapRepository

This method will create and return a lizmapRepository instance.

getProperties()  : mixed

getQgisProjectsPrivateDataFolder()  : string

Get the path where the inspection data generated by qgis-project-validator tool are stored. If not found, use the rootRepositories folder.

getRootRepositories()  : mixed

getSensitiveProperties()  : mixed

hideSensitiveProperties()  : mixed

isLdapEnabled()  : mixed

isRelativeWMSPath()  : mixed

isSmtpEnabled()  : mixed

modify()  : mixed

Modify the services.

saveIntoIni()  : mixed

sendNotificationEmail()  : mixed