Lizmap Web Client Master

ProjectMainData
in package

Table of Contents

Properties

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

Methods

__construct()  : mixed
constructor.
getAbstract()  : string
Get the project abstract.
getAcl()  : bool
Get the project access rights for the authenticated or anonymous user.
getBbox()  : mixed
Get the bounding box.
getData()  : array<string|int, mixed>
The main data.
getHidden()  : bool
Get the project hidden flag.
getId()  : string
Get the project id.
getKeywordList()  : array<string|int, mixed>
List of keywords.
getProj()  : mixed
FIXME what is the returned content ?
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.
checkAcl()  : bool
Check acl rights on the project.
getBboxOption()  : string
Get option bbox in a Lizmap config content.
getHiddenOption()  : bool
Get option hide project in a Lizmap config content.
getNeedsUpdateError()  : bool
Check if the project needs an update which lead to an error.
getProjOption()  : string
Get option projection reference in a Lizmap config content.
readCachedData()  : array<string|int, mixed>
Read project main data from project cached data.
readCfgProject()  : array<string|int, mixed>
Read main data from lizmap config file.
readValues()  : array<string|int, mixed>
Parse <value> elements.
readXmlProject()  : array<string|int, mixed>
Read main data from QGIS file.
readXmlProperties()  : array<string|int, mixed>
Parse <properties> element.

Properties

$data

The project main data.

protected array<string|int, mixed> $data

Methods

__construct()

constructor.

public __construct(string $repository, string $id, string $file, int $requiredTargetLwcVersion, AppContextInterface $appContext) : mixed
Parameters
$repository : string
  • the lizmap repository key
$id : string
  • the project id
$file : string
  • the QGIS project path
$requiredTargetLwcVersion : int
  • the configured required target Lizmap Web Client version
$appContext : AppContextInterface
  • the application context

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

getBbox()

Get the bounding box.

public getBbox() : mixed

FIXME what is the returned content ?

getData()

The main data.

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

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>

getProj()

FIXME what is the returned content ?

public getProj() : mixed

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

checkAcl()

Check acl rights on the project.

protected checkAcl(object $cfgContent, AppContextInterface $appContext) : bool
Parameters
$cfgContent : object
  • the Lizmap config content
$appContext : AppContextInterface
  • the application context
Return values
bool —

true if the current user as rights on the project

getBboxOption()

Get option bbox in a Lizmap config content.

protected getBboxOption(object $cfgContent) : string
Parameters
$cfgContent : object
  • the Lizmap config content
Return values
string

getHiddenOption()

Get option hide project in a Lizmap config content.

protected getHiddenOption(object $cfgContent) : bool
Parameters
$cfgContent : object
  • the Lizmap config content
Return values
bool

getNeedsUpdateError()

Check if the project needs an update which lead to an error.

protected getNeedsUpdateError(object $cfgContent, int $requiredTargetLwcVersion) : bool
Parameters
$cfgContent : object
  • the Lizmap config content
$requiredTargetLwcVersion : int
  • the configured required target Lizmap Web Client version
Return values
bool —

true if the project needs to be updated in the QGIS desktop plugin

getProjOption()

Get option projection reference in a Lizmap config content.

protected getProjOption(object $cfgContent) : string
Parameters
$cfgContent : object
  • the Lizmap config content
Return values
string

readCachedData()

Read project main data from project cached data.

protected readCachedData(array<string|int, mixed> $cachedData, int $requiredTargetLwcVersion, AppContextInterface $appContext) : array<string|int, mixed>
Parameters
$cachedData : array<string|int, mixed>
  • the Lizmap project cached data
$requiredTargetLwcVersion : int
  • the configured required target Lizmap Web Client version
$appContext : AppContextInterface
  • the application context
Return values
array<string|int, mixed>

readCfgProject()

Read main data from lizmap config file.

protected readCfgProject(string $qgs_path, int $requiredTargetLwcVersion, AppContextInterface $appContext) : array<string|int, mixed>
Parameters
$qgs_path : string
  • the QGIS Project path
$requiredTargetLwcVersion : int
  • the configured required target Lizmap Web Client version
$appContext : AppContextInterface
  • the application context
Return values
array<string|int, mixed>

readValues()

Parse <value> elements.

protected readValues(XMLReader $oXmlReader) : array<string|int, mixed>
Parameters
$oXmlReader : XMLReader

An XMLReader instance at parent elements

Return values
array<string|int, mixed> —

the result of the parsing

readXmlProject()

Read main data from QGIS file.

protected readXmlProject(string $qgs_path) : array<string|int, mixed>
Parameters
$qgs_path : string
  • the QGIS Project path
Return values
array<string|int, mixed>

readXmlProperties()

Parse <properties> element.

protected readXmlProperties(XMLReader $oXmlReader) : array<string|int, mixed>
Parameters
$oXmlReader : XMLReader

An XMLReader instance at element

Return values
array<string|int, mixed> —

the result of the parsing


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results