QgsServerParameters Class Reference

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

#include <qgsserverparameters.h>

Inheritance diagram for QgsServerParameters:

Public Member Functions
	QgsServerParameters ()
	Constructor. More...
	QgsServerParameters (const QUrlQuery &query)
	Constructor. More...
virtual	~QgsServerParameters ()=default
void	add (const QString &key, const QString &value)
	Adds a parameter. More...
void	clear ()
	Removes all parameters. More...
QString	fileName () const
	Returns FILE_NAME parameter as a string or an empty string if not defined. More...
void	load (const QUrlQuery &query)
	Loads new parameters. More...
QString	map () const
	Returns MAP parameter as a string or an empty string if not defined. More...
void	remove (const QString &key)
	Removes a parameter. More...
void	remove (QgsServerParameter::Name name)
	Removes a parameter. More...
virtual QString	request () const
	Returns REQUEST parameter as a string or an empty string if not defined. More...
QString	service () const
	Returns SERVICE parameter as a string or an empty string if not defined. More...
QMap< QString, QString >	toMap () const
	Returns all parameters in a map. More...
QUrlQuery	urlQuery () const
	Returns a url query with underlying parameters. More...
QString	value (const QString &key) const
	Returns the value of a parameter. More...
virtual QString	version () const
	Returns VERSION parameter as a string or an empty string if not defined. More...

Protected Member Functions
virtual bool	loadParameter (const QString &name, const QString &value)
	Loads a parameter with a specific value. More...

Protected Attributes
QMap< QString, QString >	mUnmanagedParameters

Detailed Description

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

Since

QGIS 3.4

Definition at line 242 of file qgsserverparameters.h.

Constructor & Destructor Documentation

QgsServerParameters() [1/2]

QgsServerParameters::QgsServerParameters

(

)

Constructor.

Definition at line 457 of file qgsserverparameters.cpp.

QgsServerParameters() [2/2]

QgsServerParameters::QgsServerParameters

(

const QUrlQuery &

query

)

Constructor.

Definition at line 466 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

key	the name of the parameter
value	the value of the parameter

Definition at line 478 of file qgsserverparameters.cpp.

clear()

void QgsServerParameters::clear

(

)

Removes all parameters.

Definition at line 642 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 535 of file qgsserverparameters.cpp.

load()

void QgsServerParameters::load

(

const QUrlQuery &

query

)

Loads new parameters.

Parameters

query

url query

Definition at line 602 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 637 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 525 of file qgsserverparameters.cpp.

remove() [1/2]

void QgsServerParameters::remove

(

const QString &

key

)

Removes a parameter.

Parameters

key	the name of the parameter

Definition at line 509 of file qgsserverparameters.cpp.

remove() [2/2]

void QgsServerParameters::remove

(

QgsServerParameter::Name

name

)

Removes a parameter.

Parameters

name	The name of the parameter

Since

QGIS 3.4

Definition at line 504 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 580 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 540 of file qgsserverparameters.cpp.

toMap()

QMap< QString, QString > QgsServerParameters::toMap

(

)

const

Returns all parameters in a map.

Definition at line 557 of file qgsserverparameters.cpp.

urlQuery()

QUrlQuery QgsServerParameters::urlQuery

(

)

const

Returns a url query with underlying parameters.

Definition at line 485 of file qgsserverparameters.cpp.

value()

QString QgsServerParameters::value

(

const QString &

key

)

const

Returns the value of a parameter.

Parameters

key	the name of the parameter

Definition at line 585 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 530 of file qgsserverparameters.cpp.

Member Data Documentation

mUnmanagedParameters

QMap<QString, QString> QgsServerParameters::mUnmanagedParameters

protected

Definition at line 350 of file qgsserverparameters.h.

---

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

• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/server/qgsserverparameters.h
• /build/qgis-3.37.0+git20240325+fdefdf9c27f+17bookworm/src/server/qgsserverparameters.cpp