Lizmap Web Client Master

lizmapProject
in package

Verify this methods are not used in external modules so we can delete them without risk, otherwise, we have to implement them in Project and call it here

Table of Contents

Properties

$proj  : Project

Methods

__construct()  : mixed
constructor.
checkAcl()  : bool
Check acl rights on the project.
checkAclByUser()  : mixed
clearCache()  : mixed
findEditionLayerByLayerId()  : null|object
findEditionLayerByName()  : mixed
findLayerByAnyName()  : mixed
findLayerByLayerId()  : mixed
findLayerByName()  : mixed
findLayerByShortName()  : mixed
findLayerByTitle()  : mixed
findLayerByTypeName()  : mixed
findLayersByKeyword()  : array<string|int, qgisMapLayer>|array<string|int, qgisVectorLayer>
getAllProj4()  : mixed
getCanvasColor()  : mixed
getCfgFileTime()  : mixed
getData()  : mixed
getDatavizLayersConfig()  : array<string|int, mixed>|bool
getDefaultBottomDockable()  : array<string|int, lizmapMapDockItem>
getDefaultDockable()  : array<string|int, lizmapMapDockItem>
getDefaultMiniDockable()  : array<string|int, lizmapMapDockItem>
getEditionLayers()  : mixed
getEditionLayersForCurrentUser()  : mixed
getFileTime()  : mixed
getFormFilterLayersConfig()  : mixed
getFullCfg()  : object
getGoogleKey()  : string
getKey()  : mixed
getLayer()  : mixed
getLayerByKeyword()  : mixed
getLayerDefinition()  : mixed
getLayerNameByIdFromConfig()  : null|string
getLayers()  : mixed
getLoginFilter()  : array<string|int, mixed>
Get login filtered config with the build expression.
getLoginFilteredConfig()  : mixed
getLoginFilters()  : array<string|int, mixed>
Get login filtered configs with the build expressions.
getMetadata()  : ProjectMetadata
Get the minimum needed project information for some pages (landing page, admin project listing).
getOptions()  : mixed
getPath()  : mixed
getProj4()  : mixed
getProperties()  : mixed
getQgisPath()  : mixed
getQgisProjectVersion()  : mixed
getRelations()  : mixed
getRelativeQgisPath()  : mixed
getRepository()  : mixed
getThemes()  : mixed
getUpdatedConfig()  : object
getWMSInformation()  : mixed
getXmlLayer()  : array<string|int, SimpleXMLElement>
hasAtlasEnabled()  : mixed
hasAttributeLayers()  : mixed
hasEditionLayers()  : mixed
hasEditionLayersForCurrentUser()  : mixed
hasFormFilterLayers()  : mixed
hasFtsSearches()  : mixed
hasLocateByLayer()  : mixed
hasLoginFilteredLayers()  : bool
hasTimemanagerLayers()  : mixed
hasTooltipLayers()  : mixed
needsGoogle()  : bool
needsUpdateError()  : bool
Check if the project needs an update in the QGIS desktop plugin.
needsUpdateWarning()  : bool
Check if the project needs an update in the QGIS desktop plugin.

Properties

Methods

__construct()

constructor.

public __construct(string $key, Repository $rep, mixed $context, mixed $services) : mixed
Parameters
$key : string

: the project name

$rep : Repository

: the repository

$context : mixed
$services : mixed

checkAcl()

Check acl rights on the project.

public checkAcl() : bool
Return values
bool —

true if the current user as rights on the project

checkAclByUser()

public checkAclByUser(mixed $login) : mixed
Parameters
$login : mixed

findEditionLayerByLayerId()

public findEditionLayerByLayerId(string $layerId) : null|object
Parameters
$layerId : string
Return values
null|object

findEditionLayerByName()

public findEditionLayerByName(mixed $name) : mixed
Parameters
$name : mixed

findLayerByAnyName()

public findLayerByAnyName(mixed $name) : mixed
Parameters
$name : mixed

findLayerByLayerId()

public findLayerByLayerId(mixed $layerId) : mixed
Parameters
$layerId : mixed

findLayerByName()

public findLayerByName(mixed $name) : mixed
Parameters
$name : mixed

findLayerByShortName()

public findLayerByShortName(mixed $shortName) : mixed
Parameters
$shortName : mixed

findLayerByTitle()

public findLayerByTitle(mixed $title) : mixed
Parameters
$title : mixed

findLayerByTypeName()

public findLayerByTypeName(mixed $typeName) : mixed
Parameters
$typeName : mixed

getDatavizLayersConfig()

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

getFullCfg()

public getFullCfg() : object
Return values
object —

the full JSON object corresponding to the configuration

getLayerByKeyword()

public getLayerByKeyword(mixed $key) : mixed
Parameters
$key : mixed

getLayerDefinition()

public getLayerDefinition(mixed $layerId) : mixed
Parameters
$layerId : mixed

getLayerNameByIdFromConfig()

public getLayerNameByIdFromConfig(string $layerId) : null|string
Parameters
$layerId : string
Return values
null|string

getLoginFilter()

Get login filtered config with the build expression.

public getLoginFilter(string $layerName[, bool $edition = false ]) : array<string|int, mixed>
Parameters
$layerName : string

: layer's name

$edition : bool = false

: get login filters for edition

Return values
array<string|int, mixed> —

the login filtered config with build expression

getLoginFilteredConfig()

public getLoginFilteredConfig(mixed $layername) : mixed
Parameters
$layername : mixed

getLoginFilters()

Get login filtered configs with the build expressions.

public getLoginFilters(array<string|int, string> $layers[, bool $edition = false ]) : array<string|int, mixed>
Parameters
$layers : array<string|int, string>

: layers' name list

$edition : bool = false

: get login filters for edition

Return values
array<string|int, mixed> —

the login filtered configs with build expressions

getUpdatedConfig()

public getUpdatedConfig() : object
Return values
object —

the updated JSON object corresponding to the configuration

getXmlLayer()

public getXmlLayer(string $layerId) : array<string|int, SimpleXMLElement>
Parameters
$layerId : string
Return values
array<string|int, SimpleXMLElement>

hasAttributeLayers()

public hasAttributeLayers([mixed $onlyDisplayedLayers = false ]) : mixed
Parameters
$onlyDisplayedLayers : mixed = false

needsUpdateError()

Check if the project needs an update in the QGIS desktop plugin.

public needsUpdateError() : bool
Return values
bool —

true if the project needs an update

needsUpdateWarning()

Check if the project needs an update in the QGIS desktop plugin.

public needsUpdateWarning() : bool
Return values
bool —

true if the project needs an update


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results