QGIS API Documentation 3.99.0-Master (26c88405ac0)
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsServerParameters Class Reference
server library

Provides an interface to retrieve and manipulate global parameters received from the client. More...

#include <qgsserverparameters.h>

Inheritance diagram for QgsServerParameters:
Inheritance graph
[legend]

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

Detailed Description

Provides an interface to retrieve and manipulate global parameters received from the client.

Since
QGIS 3.4

Definition at line 259 of file qgsserverparameters.h.

Constructor & Destructor Documentation

◆ QgsServerParameters() [1/2]

QgsServerParameters::QgsServerParameters ( )

Constructor.

Definition at line 469 of file qgsserverparameters.cpp.

◆ QgsServerParameters() [2/2]

QgsServerParameters::QgsServerParameters ( const QUrlQuery & query)

Constructor.

Definition at line 478 of file qgsserverparameters.cpp.

◆ ~QgsServerParameters()

virtual QgsServerParameters::~QgsServerParameters ( )
virtualdefault

Member Function Documentation

◆ add()

void QgsServerParameters::add ( const QString & key,
const QString & value )

Adds a parameter.

Parameters
keythe name of the parameter
valuethe value of the parameter

Definition at line 490 of file qgsserverparameters.cpp.

◆ clear()

void QgsServerParameters::clear ( )

Removes all parameters.

Definition at line 654 of file qgsserverparameters.cpp.

◆ fileName()

QString QgsServerParameters::fileName ( ) const

Returns FILE_NAME parameter as a string or an empty string if not defined.

Returns
filename

Definition at line 547 of file qgsserverparameters.cpp.

◆ load()

void QgsServerParameters::load ( const QUrlQuery & query)

Loads new parameters.

Parameters
queryurl query

Definition at line 614 of file qgsserverparameters.cpp.

◆ loadParameter()

bool QgsServerParameters::loadParameter ( const QString & name,
const QString & value )
protectedvirtual

Loads a parameter with a specific value.

This method should be implemented in subclasses.

Definition at line 649 of file qgsserverparameters.cpp.

◆ map()

QString QgsServerParameters::map ( ) const

Returns MAP parameter as a string or an empty string if not defined.

Returns
map

Definition at line 537 of file qgsserverparameters.cpp.

◆ remove() [1/2]

void QgsServerParameters::remove ( const QString & key)

Removes a parameter.

Parameters
keythe name of the parameter

Definition at line 521 of file qgsserverparameters.cpp.

◆ remove() [2/2]

void QgsServerParameters::remove ( QgsServerParameter::Name name)

Removes a parameter.

Parameters
nameThe name of the parameter
Since
QGIS 3.4

Definition at line 516 of file qgsserverparameters.cpp.

◆ request()

QString QgsServerParameters::request ( ) const
virtual

Returns REQUEST parameter as a string or an empty string if not defined.

Returns
request

Reimplemented in QgsWms::QgsWmsParameters.

Definition at line 592 of file qgsserverparameters.cpp.

◆ service()

QString QgsServerParameters::service ( ) const

Returns SERVICE parameter as a string or an empty string if not defined.

Returns
service

Definition at line 552 of file qgsserverparameters.cpp.

◆ toMap()

QMap< QString, QString > QgsServerParameters::toMap ( ) const

Returns all parameters in a map.

Definition at line 569 of file qgsserverparameters.cpp.

◆ urlQuery()

QUrlQuery QgsServerParameters::urlQuery ( ) const

Returns a url query with underlying parameters.

Definition at line 497 of file qgsserverparameters.cpp.

◆ value()

QString QgsServerParameters::value ( const QString & key) const

Returns the value of a parameter.

Parameters
keythe name of the parameter

Definition at line 597 of file qgsserverparameters.cpp.

◆ version()

QString QgsServerParameters::version ( ) const
virtual

Returns VERSION parameter as a string or an empty string if not defined.

Returns
version

Reimplemented in QgsWms::QgsWmsParameters.

Definition at line 542 of file qgsserverparameters.cpp.

Member Data Documentation

◆ mUnmanagedParameters

QMap<QString, QString> QgsServerParameters::mUnmanagedParameters
protected

Definition at line 367 of file qgsserverparameters.h.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0