Server
in package
Table of Contents
Properties
- $metadata : array<string|int, mixed>
Methods
- __construct() : mixed
- constructor.
- getLizmapPluginDesktopVersion() : string
- Get the current recommended/required Lizmap desktop plugin.
- getLizmapPluginServerVersion() : null|string
- Get the current Lizmap server version.
- getMetadata() : mixed
- Get the server metadata.
- getQgisServerVersion() : null|string
- Get the current QGIS server version.
- pluginServerNeedsUpdate() : bool
- Check if a QGIS server plugin needs to be updated.
- versionCompare() : bool
- Compare two versions and return true if the second parameter is greater or equal to the first parameter.
- getAclGroups() : array<string|int, mixed>
- Get the data on Lizmap groups of users.
- getLizmapMetadata() : array<string|int, mixed>
- Get Lizmap Web Client metadata.
- getLizmapRepositories() : array<string|int, mixed>
- Get the data on Lizmap repositories.
- getModules() : array<string|int, mixed>
- Get the list of modules.
- getQgisServerMetadata() : array<string|int, mixed>
- Get QGIS Server status and metadata.
- getRepositoryAuthorizedGroupsForRight() : array<string|int, mixed>
- Get the list of groups having the given right for the given repository.
- tryQgisServer() : array<string|int, mixed>
- Try QGIS Server with a WMS GetCapabilities without MAP parameter.
Properties
$metadata
protected
array<string|int, mixed>
$metadata
Metadata about LWC installation & QGIS Server status and configuration
Methods
__construct()
constructor.
public
__construct() : mixed
getLizmapPluginDesktopVersion()
Get the current recommended/required Lizmap desktop plugin.
public
getLizmapPluginDesktopVersion() : string
This value is only forward to the plugin thanks to the server metadata. The plugin will decide if it's recommended or required.
This is experimental for now on the plugin side.
Return values
string —String containing the version
getLizmapPluginServerVersion()
Get the current Lizmap server version.
public
getLizmapPluginServerVersion() : null|string
Return values
null|string —String containing the current Lizmap QGIS server version or null
getMetadata()
Get the server metadata.
public
getMetadata() : mixed
getQgisServerVersion()
Get the current QGIS server version.
public
getQgisServerVersion() : null|string
Return values
null|string —String containing the current QGIS server version or null
pluginServerNeedsUpdate()
Check if a QGIS server plugin needs to be updated.
public
pluginServerNeedsUpdate(string $currentVersion, string $requiredVersion) : bool
Parameters
- $currentVersion : string
-
The current version to check
- $requiredVersion : string
-
The minimum required version
Return values
bool —boolean If the plugin needs to be updated
versionCompare()
Compare two versions and return true if the second parameter is greater or equal to the first parameter.
public
versionCompare(null|string $currentVersion, string $requiredVersion) : bool
Parameters
- $currentVersion : null|string
-
The current version to check
- $requiredVersion : string
-
The minimum required version
Return values
bool —boolean If the software needs to be updated or True if the current version is null
getAclGroups()
Get the data on Lizmap groups of users.
private
getAclGroups() : array<string|int, mixed>
Fetch the key and label of the user groups
Return values
array<string|int, mixed> —List of groups of users
getLizmapMetadata()
Get Lizmap Web Client metadata.
private
getLizmapMetadata() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array containing the Lizmap Web Client installation metadata
getLizmapRepositories()
Get the data on Lizmap repositories.
private
getLizmapRepositories() : array<string|int, mixed>
Fetch the key, label and relative path
Return values
array<string|int, mixed> —List of Lizmap repositories
getModules()
Get the list of modules.
private
getModules() : array<string|int, mixed>
Return values
array<string|int, mixed> —List of modules
getQgisServerMetadata()
Get QGIS Server status and metadata.
private
getQgisServerMetadata() : array<string|int, mixed>
We use the new entrypoint /lizmap/server.json.
Return values
array<string|int, mixed> —QGIS Server and plugins metadata. In case of error, it contains a 'error' key.
getRepositoryAuthorizedGroupsForRight()
Get the list of groups having the given right for the given repository.
private
getRepositoryAuthorizedGroupsForRight(string $repositoryKey, string $rightSubject) : array<string|int, mixed>
It helps to list all the groups which can edit or view the projects for a repository
Parameters
- $repositoryKey : string
-
The repository key
- $rightSubject : string
-
The right subject key
Return values
array<string|int, mixed> —The list of groups
tryQgisServer()
Try QGIS Server with a WMS GetCapabilities without MAP parameter.
private
tryQgisServer() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array containing try information