QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Static Public Member Functions | List of all members
QgsServerApiUtils Class Reference
server library

The QgsServerApiUtils class contains helper functions to handle common API operations. More...

#include <qgsserverapiutils.h>

Static Public Member Functions

static QString appendMapParameter (const QString &path, const QUrl &requestUrl)
 Appends MAP query string parameter from current requestUrl to the given path. More...
 
static QString crsToOgcUri (const QgsCoordinateReferenceSystem &crs)
 Returns a crs as OGC URI (format: http://www.opengis.net/def/crs/OGC/1.3/CRS84) Returns an empty string on failure. More...
 
static QString fieldName (const QString &name, const QgsVectorLayer *layer) SIP_THROW(QgsServerApiBadRequestException)
 Given a field name (or display name) and a layer returns the actual name of the field. More...
 
static json layerExtent (const QgsVectorLayer *layer)
 layerExtent returns json array with [xMin,yMin,xMax,yMax] CRS84 extent for the given layer More...
 
static QgsRectangle parseBbox (const QString &bbox)
 Parses a comma separated bbox into a (possibly empty) QgsRectangle. More...
 
static QgsCoordinateReferenceSystem parseCrs (const QString &bboxCrs)
 Parses the CRS URI bboxCrs (example: "http://www.opengis.net/def/crs/OGC/1.3/CRS84") into a QGIS CRS object. More...
 
static QgsDateRange parseTemporalDateInterval (const QString &interval) SIP_THROW(QgsServerApiBadRequestException)
 Parses a date interval and returns a QgsDateRange. More...
 
static QgsDateTimeRange parseTemporalDateTimeInterval (const QString &interval) SIP_THROW(QgsServerApiBadRequestException)
 Parses a datetime interval and returns a QgsDateTimeRange. More...
 
static QStringList publishedCrsList (const QgsProject *project)
 Returns the list of CRSs (format: http://www.opengis.net/def/crs/OGC/1.3/CRS84) available for this project. More...
 
static const QVector< QgsVectorLayer * > publishedWfsLayers (const QgsServerApiContext &context)
 Returns the list of layers accessible to the service for a given context. More...
 
template<typename T >
static const QVector< T > publishedWfsLayers (const QgsServerApiContext &context)
 Returns the list of layers of type T accessible to the WFS service for a given project. More...
 
static QString sanitizedFieldValue (const QString &value)
 Sanitizes the input value by removing URL encoding. More...
 
static QList< QgsServerWmsDimensionProperties::WmsDimensionInfo > temporalDimensions (const QgsVectorLayer *layer)
 Returns a list of temporal dimensions information for the given layer (either configured in wmsDimensions or the first date/datetime field) More...
 
static json temporalExtent (const QgsVectorLayer *layer)
 temporalExtent returns a json array with an array of [min, max] temporal extent for the given layer. More...
 
static QVariantList temporalExtentList (const QgsVectorLayer *layer)
 temporalExtent returns a json array with an array of [min, max] temporal extent for the given layer. More...
 
static QgsExpression temporalFilterExpression (const QgsVectorLayer *layer, const QString &interval)
 Parses the interval and constructs a (possibly invalid) temporal filter expression for the given layer. More...
 

Detailed Description

The QgsServerApiUtils class contains helper functions to handle common API operations.

Since
QGIS 3.10

Definition at line 53 of file qgsserverapiutils.h.

Member Function Documentation

◆ appendMapParameter()

QString QgsServerApiUtils::appendMapParameter ( const QString &  path,
const QUrl &  requestUrl 
)
static

Appends MAP query string parameter from current requestUrl to the given path.

Definition at line 649 of file qgsserverapiutils.cpp.

◆ crsToOgcUri()

QString QgsServerApiUtils::crsToOgcUri ( const QgsCoordinateReferenceSystem &  crs)
static

Returns a crs as OGC URI (format: http://www.opengis.net/def/crs/OGC/1.3/CRS84) Returns an empty string on failure.

Definition at line 626 of file qgsserverapiutils.cpp.

◆ fieldName()

QString QgsServerApiUtils::fieldName ( const QString &  name,
const QgsVectorLayer *  layer 
)
static

Given a field name (or display name) and a layer returns the actual name of the field.

Exceptions
QgsServerApiBadRequestExceptionif name is neither a field name or a display name.
Since
QGIS 3.28

Definition at line 584 of file qgsserverapiutils.cpp.

◆ layerExtent()

json QgsServerApiUtils::layerExtent ( const QgsVectorLayer *  layer)
static

layerExtent returns json array with [xMin,yMin,xMax,yMax] CRS84 extent for the given layer

Definition at line 445 of file qgsserverapiutils.cpp.

◆ parseBbox()

QgsRectangle QgsServerApiUtils::parseBbox ( const QString &  bbox)
static

Parses a comma separated bbox into a (possibly empty) QgsRectangle.

Note
Z values (i.e. a 6 elements bbox) are silently discarded

Definition at line 33 of file qgsserverapiutils.cpp.

◆ parseCrs()

QgsCoordinateReferenceSystem QgsServerApiUtils::parseCrs ( const QString &  bboxCrs)
static

Parses the CRS URI bboxCrs (example: "http://www.opengis.net/def/crs/OGC/1.3/CRS84") into a QGIS CRS object.

Definition at line 562 of file qgsserverapiutils.cpp.

◆ parseTemporalDateInterval()

QgsDateRange QgsServerApiUtils::parseTemporalDateInterval ( const QString &  interval)
static

Parses a date interval and returns a QgsDateRange.

Exceptions
QgsServerApiBadRequestExceptionif interval cannot be parsed
Since
QGIS 3.12

Definition at line 137 of file qgsserverapiutils.cpp.

◆ parseTemporalDateTimeInterval()

QgsDateTimeRange QgsServerApiUtils::parseTemporalDateTimeInterval ( const QString &  interval)
static

Parses a datetime interval and returns a QgsDateTimeRange.

Exceptions
QgsServerApiBadRequestExceptionif interval cannot be parsed
Since
QGIS 3.12

Definition at line 142 of file qgsserverapiutils.cpp.

◆ publishedCrsList()

QStringList QgsServerApiUtils::publishedCrsList ( const QgsProject *  project)
static

Returns the list of CRSs (format: http://www.opengis.net/def/crs/OGC/1.3/CRS84) available for this project.

Information is read from project WMS configuration.

Definition at line 607 of file qgsserverapiutils.cpp.

◆ publishedWfsLayers() [1/2]

const QVector< QgsVectorLayer * > QgsServerApiUtils::publishedWfsLayers ( const QgsServerApiContext &  context)
static

Returns the list of layers accessible to the service for a given context.

This method takes into account the ACL restrictions provided by QGIS Server Access Control plugins.

Definition at line 579 of file qgsserverapiutils.cpp.

◆ publishedWfsLayers() [2/2]

template<typename T >
static const QVector< T > QgsServerApiUtils::publishedWfsLayers ( const QgsServerApiContext &  context)
inlinestatic

Returns the list of layers of type T accessible to the WFS service for a given project.

Example: 

QVector<const QgsVectorLayer*> vectorLayers = publishedLayers<QgsVectorLayer>();
Note
not available in Python bindings

Definition at line 181 of file qgsserverapiutils.h.

◆ sanitizedFieldValue()

QString QgsServerApiUtils::sanitizedFieldValue ( const QString &  value)
static

Sanitizes the input value by removing URL encoding.

Note
the returned value is meant to become part of a QgsExpression filter

Definition at line 601 of file qgsserverapiutils.cpp.

◆ temporalDimensions()

QList< QgsMapLayerServerProperties::WmsDimensionInfo > QgsServerApiUtils::temporalDimensions ( const QgsVectorLayer *  layer)
static

Returns a list of temporal dimensions information for the given layer (either configured in wmsDimensions or the first date/datetime field)

Since
QGIS 3.12

Definition at line 70 of file qgsserverapiutils.cpp.

◆ temporalExtent()

json QgsServerApiUtils::temporalExtent ( const QgsVectorLayer *  layer)
static

temporalExtent returns a json array with an array of [min, max] temporal extent for the given layer.

In case multiple temporal dimensions are available in the layer, a union of all dimensions is returned.

From specifications: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/extent.yaml

One or more time intervals that describe the temporal extent of the dataset. The value null is supported and indicates an open time interval.

In the Core only a single time interval is supported. Extensions may support multiple intervals. If multiple intervals are provided, the union of the intervals describes the temporal extent.

Returns
An array of intervals
Note
not available in Python bindings
Since
QGIS 3.12

Definition at line 457 of file qgsserverapiutils.cpp.

◆ temporalExtentList()

QVariantList QgsServerApiUtils::temporalExtentList ( const QgsVectorLayer *  layer)
static

temporalExtent returns a json array with an array of [min, max] temporal extent for the given layer.

In case multiple temporal dimensions are available in the layer, a union of all dimensions is returned.

From specifications: http://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/extent.yaml

One or more time intervals that describe the temporal extent of the dataset. The value null is supported and indicates an open time interval.

In the Core only a single time interval is supported. Extensions may support multiple intervals. If multiple intervals are provided, the union of the intervals describes the temporal extent.

Returns
An array of intervals
Since
QGIS 3.12

Definition at line 555 of file qgsserverapiutils.cpp.

◆ temporalFilterExpression()

QgsExpression QgsServerApiUtils::temporalFilterExpression ( const QgsVectorLayer *  layer,
const QString &  interval 
)
static

Parses the interval and constructs a (possibly invalid) temporal filter expression for the given layer.

Interval syntax:

interval-closed = date-time "/" date-time interval-open-start = [".."] "/" date-time interval-open-end = date-time "/" [".."] interval = interval-closed / interval-open-start / interval-open-end datetime = date-time / interval

Since
QGIS 3.12

Definition at line 147 of file qgsserverapiutils.cpp.

The documentation for this class was generated from the following files:
Generated on Sat Oct 22 2022 16:10:47 for QGIS API Documentation by doxygen 1.9.4