QgsAccessControl Class Reference

A helper class that centralizes restrictions given by all the access control filter plugins. More...

#include <qgsaccesscontrol.h>

Inheritance diagram for QgsAccessControl:

Public Member Functions
	QgsAccessControl ()
	Constructor. More...
	QgsAccessControl (const QgsAccessControl &copy)
	Constructor. More...
	~QgsAccessControl () override
bool	allowToEdit (const QgsVectorLayer *layer, const QgsFeature &feature) const
	Are we authorized to modify the following geometry. More...
QgsFeatureFilterProvider *	clone () const override
	Returns a clone of the object. More...
QString	extraSubsetString (const QgsVectorLayer *layer) const
	Returns an additional subset string (typically SQL) filter. More...
bool	fillCacheKey (QStringList &cacheKey) const
	Fill the capabilities caching key. More...
void	filterFeatures (const QgsVectorLayer *layer, QgsFeatureRequest &filterFeatures) const override
	Filter the features of the layer. More...
QStringList	layerAttributes (const QgsVectorLayer *layer, const QStringList &attributes) const
	Returns the authorized layer attributes. More...
bool	layerDeletePermission (const QgsVectorLayer *layer) const
	Returns the layer delete right. More...
bool	layerInsertPermission (const QgsVectorLayer *layer) const
	Returns the layer insert right. More...
bool	layerReadPermission (const QgsMapLayer *layer) const
	Returns the layer read right. More...
bool	layerUpdatePermission (const QgsVectorLayer *layer) const
	Returns the layer update right. More...
void	registerAccessControl (QgsAccessControlFilter *accessControl, int priority=0)
	Register an access control filter. More...
void	resolveFilterFeatures (const QList< QgsMapLayer *> &layers)
	Resolve features' filter of layers. More...
Public Member Functions inherited from QgsFeatureFilterProvider
	QgsFeatureFilterProvider ()=default
	Constructor. More...
virtual	~QgsFeatureFilterProvider ()=default

Detailed Description

A helper class that centralizes restrictions given by all the access control filter plugins.

Since

QGIS 2.14

Definition at line 36 of file qgsaccesscontrol.h.

Constructor & Destructor Documentation

QgsAccessControl() [1/2]

QgsAccessControl::QgsAccessControl ( )

inline

Constructor.

Definition at line 44 of file qgsaccesscontrol.h.

QgsAccessControl() [2/2]

QgsAccessControl::QgsAccessControl ( const QgsAccessControl &  copy )

inline

Constructor.

Definition at line 51 of file qgsaccesscontrol.h.

~QgsAccessControl()

QgsAccessControl::~QgsAccessControl ( )

inlineoverride

Definition at line 59 of file qgsaccesscontrol.h.

Member Function Documentation

allowToEdit()

bool QgsAccessControl::allowToEdit	(	const QgsVectorLayer *	layer,
		const QgsFeature &	feature
	)		const

Are we authorized to modify the following geometry.

Parameters

layer	the layer to control
feature	the concerned feature

Returns

true if we are allowed to edit the feature

Definition at line 173 of file qgsaccesscontrol.cpp.

clone()

QgsFeatureFilterProvider * QgsAccessControl::clone ( ) const

overridevirtual

Returns a clone of the object.

Clone the object.

Returns

A clone

Implements QgsFeatureFilterProvider.

Definition at line 83 of file qgsaccesscontrol.cpp.

extraSubsetString()

QString QgsAccessControl::extraSubsetString

(

const QgsVectorLayer *

layer

)

const

Returns an additional subset string (typically SQL) filter.

Parameters

layer

the layer to control

Returns

the subset string to use

Definition at line 89 of file qgsaccesscontrol.cpp.

fillCacheKey()

bool QgsAccessControl::fillCacheKey

(

QStringList &

cacheKey

)

const

Fill the capabilities caching key.

Parameters

cacheKey

the list to fill with a cache variant

Returns

false if we can't create a cache

Definition at line 187 of file qgsaccesscontrol.cpp.

filterFeatures()

void QgsAccessControl::filterFeatures ( const QgsVectorLayer *  layer, QgsFeatureRequest &  filterFeatures  ) const

overridevirtual

Filter the features of the layer.

Parameters

layer	the layer to control
filterFeatures	the request to fill

Implements QgsFeatureFilterProvider.

Definition at line 62 of file qgsaccesscontrol.cpp.

layerAttributes()

QStringList QgsAccessControl::layerAttributes	(	const QgsVectorLayer *	layer,
		const QStringList &	attributes
	)		const

Returns the authorized layer attributes.

Parameters

layer	the layer to control
attributes	the list of attribute

Returns

the list of visible attributes

Definition at line 161 of file qgsaccesscontrol.cpp.

layerDeletePermission()

bool QgsAccessControl::layerDeletePermission

(

const QgsVectorLayer *

layer

)

const

Returns the layer delete right.

Parameters

layer

the layer to control

Returns

true if we can do a delete

Definition at line 147 of file qgsaccesscontrol.cpp.

layerInsertPermission()

bool QgsAccessControl::layerInsertPermission

(

const QgsVectorLayer *

layer

)

const

Returns the layer insert right.

Parameters

layer

the layer to control

Returns

true if we can insert on it

Definition at line 119 of file qgsaccesscontrol.cpp.

layerReadPermission()

bool QgsAccessControl::layerReadPermission

(

const QgsMapLayer *

layer

)

const

Returns the layer read right.

Parameters

layer

the layer to control

Returns

true if it can be read

Definition at line 105 of file qgsaccesscontrol.cpp.

layerUpdatePermission()

bool QgsAccessControl::layerUpdatePermission

(

const QgsVectorLayer *

layer

)

const

Returns the layer update right.

Parameters

layer

the layer to control

Returns

true if we can do an update

Definition at line 133 of file qgsaccesscontrol.cpp.

registerAccessControl()

void QgsAccessControl::registerAccessControl	(	QgsAccessControlFilter *	accessControl,
		int	priority = 0
	)

Register an access control filter.

Register a new access control filter.

Parameters

accessControl	the access control to add
priority	the priority used to define the order

Definition at line 204 of file qgsaccesscontrol.cpp.

resolveFilterFeatures()

void QgsAccessControl::resolveFilterFeatures

(

const QList< QgsMapLayer *> &

layers

)

Resolve features' filter of layers.

Parameters

layers

to filter

Definition at line 24 of file qgsaccesscontrol.cpp.

---

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

• /tmp/buildd/qgis-3.6.0+99unstable/src/server/qgsaccesscontrol.h
• /tmp/buildd/qgis-3.6.0+99unstable/src/server/qgsaccesscontrol.cpp