QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
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. | |
static Q_DECL_DEPRECATED 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. | |
static QString | fieldName (const QString &name, const QgsVectorLayer *layer) |
Given a field name (or display name) and a layer returns the actual name of the field. | |
static json | layerExtent (const QgsVectorLayer *layer) |
layerExtent returns json array with [xMin,yMin,xMax,yMax] CRS84 extent for the given layer | |
static QgsRectangle | parseBbox (const QString &bbox) |
Parses a comma separated bbox into a (possibly empty) QgsRectangle. | |
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. | |
static QgsDateRange | parseTemporalDateInterval (const QString &interval) |
Parses a date interval and returns a QgsDateRange. | |
static QgsDateTimeRange | parseTemporalDateTimeInterval (const QString &interval) |
Parses a datetime interval and returns a QgsDateTimeRange. | |
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. | |
static const QVector< QgsVectorLayer * > | publishedWfsLayers (const QgsServerApiContext &context) |
Returns the list of layers accessible to the service for a given context. | |
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. | |
static QString | sanitizedFieldValue (const QString &value) |
Sanitizes the input value by removing URL encoding. | |
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) | |
static json | temporalExtent (const QgsVectorLayer *layer) |
temporalExtent returns a json array with an array of [min, max] temporal extent for the given layer. | |
static QVariantList | temporalExtentList (const QgsVectorLayer *layer) |
temporalExtent returns a json array with an array of [min, max] temporal extent for the given layer. | |
static QgsExpression | temporalFilterExpression (const QgsVectorLayer *layer, const QString &interval) |
Parses the interval and constructs a (possibly invalid) temporal filter expression for the given layer. | |
The QgsServerApiUtils class contains helper functions to handle common API operations.
Definition at line 53 of file qgsserverapiutils.h.
|
static |
Appends MAP query string parameter from current requestUrl to the given path.
Definition at line 629 of file qgsserverapiutils.cpp.
|
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 624 of file qgsserverapiutils.cpp.
|
static |
Given a field name (or display name) and a layer returns the actual name of the field.
QgsServerApiBadRequestException | if name is neither a field name or a display name. |
Definition at line 582 of file qgsserverapiutils.cpp.
|
static |
layerExtent returns json array with [xMin,yMin,xMax,yMax] CRS84 extent for the given layer
Definition at line 443 of file qgsserverapiutils.cpp.
|
static |
Parses a comma separated bbox into a (possibly empty) QgsRectangle.
Definition at line 33 of file qgsserverapiutils.cpp.
|
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 560 of file qgsserverapiutils.cpp.
|
static |
Parses a date interval and returns a QgsDateRange.
QgsServerApiBadRequestException | if interval cannot be parsed |
Definition at line 134 of file qgsserverapiutils.cpp.
|
static |
Parses a datetime interval and returns a QgsDateTimeRange.
QgsServerApiBadRequestException | if interval cannot be parsed |
Definition at line 139 of file qgsserverapiutils.cpp.
|
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 605 of file qgsserverapiutils.cpp.
|
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 577 of file qgsserverapiutils.cpp.
|
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>();
Definition at line 181 of file qgsserverapiutils.h.
|
static |
Sanitizes the input value by removing URL encoding.
Definition at line 599 of file qgsserverapiutils.cpp.
|
static |
Returns a list of temporal dimensions information for the given layer (either configured in wmsDimensions or the first date/datetime field)
Definition at line 66 of file qgsserverapiutils.cpp.
|
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.
Definition at line 455 of file qgsserverapiutils.cpp.
|
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.
Definition at line 553 of file qgsserverapiutils.cpp.
|
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
Definition at line 144 of file qgsserverapiutils.cpp.