QGIS API Documentation  3.14.0-Pi (9f7028fd23)
Public Member Functions | Static Public Member Functions | List of all members
QgsConfigCache Class Reference

Cache for server configuration. More...

#include <qgsconfigcache.h>

Inheritance diagram for QgsConfigCache:
Inheritance graph

Public Member Functions

const QgsProjectproject (const QString &path, QgsServerSettings *settings=nullptr)
 If the project is not cached yet, then the project is read from the path. More...
void removeEntry (const QString &path)
 Removes an entry from cache. More...

Static Public Member Functions

static QgsConfigCacheinstance ()
 Returns the current instance. More...

Detailed Description

Cache for server configuration.

QGIS 2.8

Definition at line 38 of file qgsconfigcache.h.

Member Function Documentation

◆ instance()

QgsConfigCache * QgsConfigCache::instance ( )

Returns the current instance.

Definition at line 26 of file qgsconfigcache.cpp.

◆ project()

const QgsProject * QgsConfigCache::project ( const QString &  path,
QgsServerSettings settings = nullptr 

If the project is not cached yet, then the project is read from the path.

If the project is not available, then nullptr is returned. If the project contains any bad layer it is considered unavailable unless the server configuration variable QGIS_SERVER_IGNORE_BAD_LAYERS passed in the optional settings argument is set to true (the default value is false).

paththe filename of the QGIS project
settingsQGIS server settings
the project or nullptr if an error happened
QGIS 3.0

Definition at line 42 of file qgsconfigcache.cpp.

◆ removeEntry()

void QgsConfigCache::removeEntry ( const QString &  path)

Removes an entry from cache.

pathThe path of the project

Definition at line 153 of file qgsconfigcache.cpp.

The documentation for this class was generated from the following files: