QGIS API Documentation 3.41.0-Master (af5edcb665c)
|
QgsServerParameters provides an interface to retrieve and manipulate global parameters received from the client. More...
#include <qgsserverparameters.h>
Public Member Functions | |
QgsServerParameters () | |
Constructor. | |
QgsServerParameters (const QUrlQuery &query) | |
Constructor. | |
virtual | ~QgsServerParameters ()=default |
void | add (const QString &key, const QString &value) |
Adds a parameter. | |
void | clear () |
Removes all parameters. | |
QString | fileName () const |
Returns FILE_NAME parameter as a string or an empty string if not defined. | |
void | load (const QUrlQuery &query) |
Loads new parameters. | |
QString | map () const |
Returns MAP parameter as a string or an empty string if not defined. | |
void | remove (const QString &key) |
Removes a parameter. | |
void | remove (QgsServerParameter::Name name) |
Removes a parameter. | |
virtual QString | request () const |
Returns REQUEST parameter as a string or an empty string if not defined. | |
QString | service () const |
Returns SERVICE parameter as a string or an empty string if not defined. | |
QMap< QString, QString > | toMap () const |
Returns all parameters in a map. | |
QUrlQuery | urlQuery () const |
Returns a url query with underlying parameters. | |
QString | value (const QString &key) const |
Returns the value of a parameter. | |
virtual QString | version () const |
Returns VERSION parameter as a string or an empty string if not defined. | |
Protected Member Functions | |
virtual bool | loadParameter (const QString &name, const QString &value) |
Loads a parameter with a specific value. | |
Protected Attributes | |
QMap< QString, QString > | mUnmanagedParameters |
QgsServerParameters provides an interface to retrieve and manipulate global parameters received from the client.
Definition at line 253 of file qgsserverparameters.h.
QgsServerParameters::QgsServerParameters | ( | ) |
Constructor.
Definition at line 466 of file qgsserverparameters.cpp.
QgsServerParameters::QgsServerParameters | ( | const QUrlQuery & | query | ) |
Constructor.
Definition at line 475 of file qgsserverparameters.cpp.
|
virtualdefault |
void QgsServerParameters::add | ( | const QString & | key, |
const QString & | value | ||
) |
Adds a parameter.
key | the name of the parameter |
value | the value of the parameter |
Definition at line 487 of file qgsserverparameters.cpp.
void QgsServerParameters::clear | ( | ) |
Removes all parameters.
Definition at line 651 of file qgsserverparameters.cpp.
QString QgsServerParameters::fileName | ( | ) | const |
Returns FILE_NAME parameter as a string or an empty string if not defined.
Definition at line 544 of file qgsserverparameters.cpp.
void QgsServerParameters::load | ( | const QUrlQuery & | query | ) |
Loads new parameters.
query | url query |
Definition at line 611 of file qgsserverparameters.cpp.
|
protectedvirtual |
Loads a parameter with a specific value.
This method should be implemented in subclasses.
Definition at line 646 of file qgsserverparameters.cpp.
QString QgsServerParameters::map | ( | ) | const |
Returns MAP parameter as a string or an empty string if not defined.
Definition at line 534 of file qgsserverparameters.cpp.
void QgsServerParameters::remove | ( | const QString & | key | ) |
Removes a parameter.
key | the name of the parameter |
Definition at line 518 of file qgsserverparameters.cpp.
void QgsServerParameters::remove | ( | QgsServerParameter::Name | name | ) |
Removes a parameter.
name | The name of the parameter |
Definition at line 513 of file qgsserverparameters.cpp.
|
virtual |
Returns REQUEST parameter as a string or an empty string if not defined.
Reimplemented in QgsWms::QgsWmsParameters.
Definition at line 589 of file qgsserverparameters.cpp.
QString QgsServerParameters::service | ( | ) | const |
Returns SERVICE parameter as a string or an empty string if not defined.
Definition at line 549 of file qgsserverparameters.cpp.
QMap< QString, QString > QgsServerParameters::toMap | ( | ) | const |
Returns all parameters in a map.
Definition at line 566 of file qgsserverparameters.cpp.
QUrlQuery QgsServerParameters::urlQuery | ( | ) | const |
Returns a url query with underlying parameters.
Definition at line 494 of file qgsserverparameters.cpp.
QString QgsServerParameters::value | ( | const QString & | key | ) | const |
Returns the value of a parameter.
key | the name of the parameter |
Definition at line 594 of file qgsserverparameters.cpp.
|
virtual |
Returns VERSION parameter as a string or an empty string if not defined.
Reimplemented in QgsWms::QgsWmsParameters.
Definition at line 539 of file qgsserverparameters.cpp.
|
protected |
Definition at line 359 of file qgsserverparameters.h.