QGIS API Documentation 3.27.0-Master (1d7a28cfd2)
Public Slots | 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
[legend]

Public Slots

void removeChangedEntries ()
 Remove all changed cache entries. More...
 
void removeChangedEntry (const QString &path)
 Remove cache entry. More...
 

Public Member Functions

 QgsConfigCache (QgsAbstractCacheStrategy *strategy)
 Initialize with a strategy implementation. More...
 
 QgsConfigCache (QgsServerSettings *settings)
 Initialize from settings. More...
 
const QgsProjectproject (const QString &path, const 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...
 
QString strategyName () const
 Returns the name of the current strategy. More...
 

Static Public Member Functions

static void initialize (QgsServerSettings *settings)
 Initialize from settings. More...
 
static QgsConfigCacheinstance ()
 Returns the current instance. More...
 

Detailed Description

Cache for server configuration.

Since
QGIS 2.8

Definition at line 77 of file qgsconfigcache.h.

Constructor & Destructor Documentation

◆ QgsConfigCache() [1/2]

QgsConfigCache::QgsConfigCache ( QgsServerSettings settings)

Initialize from settings.

Definition at line 80 of file qgsconfigcache.cpp.

◆ QgsConfigCache() [2/2]

QgsConfigCache::QgsConfigCache ( QgsAbstractCacheStrategy strategy)

Initialize with a strategy implementation.

Definition at line 86 of file qgsconfigcache.cpp.

Member Function Documentation

◆ initialize()

void QgsConfigCache::initialize ( QgsServerSettings settings)
static

Initialize from settings.

This method must be called prior any call to QgsConfigCache::instance

Definition at line 57 of file qgsconfigcache.cpp.

◆ instance()

QgsConfigCache * QgsConfigCache::instance ( )
static

Returns the current instance.

Definition at line 70 of file qgsconfigcache.cpp.

◆ project()

const QgsProject * QgsConfigCache::project ( const QString &  path,
const 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).

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

Definition at line 97 of file qgsconfigcache.cpp.

◆ removeChangedEntries

void QgsConfigCache::removeChangedEntries ( )
slot

Remove all changed cache entries.

Definition at line 249 of file qgsconfigcache.cpp.

◆ removeChangedEntry

void QgsConfigCache::removeChangedEntry ( const QString &  path)
slot

Remove cache entry.

Definition at line 243 of file qgsconfigcache.cpp.

◆ removeEntry()

void QgsConfigCache::removeEntry ( const QString &  path)

Removes an entry from cache.

Parameters
pathThe path of the project

Definition at line 231 of file qgsconfigcache.cpp.

◆ strategyName()

QString QgsConfigCache::strategyName ( ) const
inline

Returns the name of the current strategy.

Since
QGIS 3.26

Definition at line 118 of file qgsconfigcache.h.


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