Lizmap Web Client Master

ProjectMetadata
in package

Table of Contents

Properties

$data  : array<string|int, mixed>
The project metadata.

Methods

__construct()  : mixed
Construct the object.
countProjectCfgWarnings()  : int
Returns the count of warnings in the CFG file.
getAbstract()  : string
Get the project abstract.
getAcl()  : bool
Get the project access rights for the authenticated or anonymous user.
getAclGroups()  : string
The acl option which corresponds to authorized groups.
getBbox()  : mixed
Get the bounding box.
getData()  : mixed
Get any project property.
getFileTime()  : string
The project file time.
getHidden()  : bool
Get the project hidden flag.
getId()  : string
Get the project id.
getKeywordList()  : array<string|int, mixed>
List of keywords.
getLastSaveDateTime()  : string
The last save date time of the QGIS file.
getLayerCount()  : string
The number of layers in the QGIS project.
getLizmapPluginVersion()  : string
The version of the Desktop lizmap plugin.
getLizmapWebCLientTargetVersion()  : int
The target version written in the CFG file.
getMap()  : string
Get the project map.
getProj()  : mixed
FIXME what is the returned content ?
getQgisProjectVersion()  : string
The QGIS desktop project version.
getRepository()  : string
Get the project repository code.
getTitle()  : string
Get the project title.
getWMSGetCapabilitiesUrl()  : string
The url of WMS GetCapabilities.
getWMTSGetCapabilitiesUrl()  : string
The url of WMTS GetCapabilities.
needsUpdateError()  : bool
Check if the project needs an update which is critical.
needsUpdateWarning()  : bool
Check if the project needs an update which is not critical.
projectCfgWarnings()  : object
Returns the list of warnings in the CFG file.
qgisLizmapPluginUpdateNeeded()  : bool
If the QGIS desktop needs an update of the plugin.

Properties

$data

The project metadata.

protected array<string|int, mixed> $data

Methods

__construct()

Construct the object.

public __construct(Project $project) : mixed
Parameters
$project : Project

The Lizmap project instance

countProjectCfgWarnings()

Returns the count of warnings in the CFG file.

public countProjectCfgWarnings() : int
Return values
int

getAbstract()

Get the project abstract.

public getAbstract() : string
Return values
string —

the project abstract

getAcl()

Get the project access rights for the authenticated or anonymous user.

public getAcl() : bool
Return values
bool —

True if the user has the right to access the Lizmap project

getAclGroups()

The acl option which corresponds to authorized groups.

public getAclGroups() : string
Return values
string

getBbox()

Get the bounding box.

public getBbox() : mixed

FIXME what is the returned content ?

getData()

Get any project property.

public getData(string $key) : mixed

use other get* methods

Parameters
$key : string

The property to get

getFileTime()

The project file time.

public getFileTime() : string
Return values
string

getHidden()

Get the project hidden flag.

public getHidden() : bool
Return values
bool —

True if the project must be hidden in the landing page

getId()

Get the project id.

public getId() : string
Return values
string —

the project id

getKeywordList()

List of keywords.

public getKeywordList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getLastSaveDateTime()

The last save date time of the QGIS file.

public getLastSaveDateTime() : string
Return values
string —

the last saved date contained in the QGS file

getLayerCount()

The number of layers in the QGIS project.

public getLayerCount() : string
Return values
string

getLizmapPluginVersion()

The version of the Desktop lizmap plugin.

public getLizmapPluginVersion() : string
Return values
string

getLizmapWebCLientTargetVersion()

The target version written in the CFG file.

public getLizmapWebCLientTargetVersion() : int
Return values
int

getMap()

Get the project map.

public getMap() : string
Return values
string —

the project map

getProj()

FIXME what is the returned content ?

public getProj() : mixed

getQgisProjectVersion()

The QGIS desktop project version.

public getQgisProjectVersion() : string
Return values
string

getRepository()

Get the project repository code.

public getRepository() : string
Return values
string —

the project repository code

getTitle()

Get the project title.

public getTitle() : string
Return values
string —

the project title

getWMSGetCapabilitiesUrl()

The url of WMS GetCapabilities.

public getWMSGetCapabilitiesUrl() : string
Return values
string

getWMTSGetCapabilitiesUrl()

The url of WMTS GetCapabilities.

public getWMTSGetCapabilitiesUrl() : string
Return values
string

needsUpdateError()

Check if the project needs an update which is critical.

public needsUpdateError() : bool
Return values
bool —

true if the project needs an update

needsUpdateWarning()

Check if the project needs an update which is not critical.

public needsUpdateWarning() : bool
Return values
bool —

true if the project needs an update

projectCfgWarnings()

Returns the list of warnings in the CFG file.

public projectCfgWarnings() : object
Return values
object

qgisLizmapPluginUpdateNeeded()

If the QGIS desktop needs an update of the plugin.

public qgisLizmapPluginUpdateNeeded() : bool

The check is done only if the project has been edited recently compare to the date of the Lizmap Web Client.

Return values
bool —

If the plugin should be updated in QGIS Desktop


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results