datatablesCtrl
extends jController
in package
Table of Contents
Properties
- $bbox : array<string|int, mixed>
- $DTColumns : mixed
- $DTLength : null|string
- $DTOrder : mixed
- $DTSearchBuilder : null|array<string|int, mixed>
- $DTStart : null|string
- $expFilter : null|string
- $filteredFeatureIDs : array<string|int, mixed>
- $layerId : null|string
- $project : null|string
- $repository : null|string
- $srsName : null|string
Methods
- filteredFeaturesExtent() : jResponseJson
- Gets features via WFS and calculates the total extent.
- index() : mixed
- selectFilteredFeatures() : jResponseBinary|jResponseJson
- Returns all features corresponding to the searching parameters, ignoring pagination.
- setErrorResponse() : jResponseJson
- Sets the error in the provided response object based on the given HTTP error code.
- getExpFilter() : null|string
- Return expression filter parameter.
- getProject() : null|Project
- Get the Lizmap project. If the project does not exist, the user does not have the right to access the project or the user does not have access to WFS data, set the error response.
- initClassProperties() : mixed
- Assign values to class instance property.
Properties
$bbox
private
array<string|int, mixed>
$bbox
bbox array
$DTColumns
private
mixed
$DTColumns
Array of columns name
$DTLength
private
null|string
$DTLength
Number of features per page
$DTOrder
private
mixed
$DTOrder
Array of columns order
$DTSearchBuilder
private
null|array<string|int, mixed>
$DTSearchBuilder
Array of search builder condition criteria
$DTStart
private
null|string
$DTStart
Pagination start
$expFilter
private
null|string
$expFilter
WFS expression filter
$filteredFeatureIDs
private
array<string|int, mixed>
$filteredFeatureIDs
Array of filtered features ids
$layerId
private
null|string
$layerId
The layer id
$project
private
null|string
$project
The qgis project key
$repository
private
null|string
$repository
The repository key string
$srsName
private
null|string
$srsName
srs code
Methods
filteredFeaturesExtent()
Gets features via WFS and calculates the total extent.
public
filteredFeaturesExtent() : jResponseJson
It basically use the same logic of the main endpoint but ignores pagination to get all filtered features.
Return values
jResponseJsonindex()
public
index() : mixed
selectFilteredFeatures()
Returns all features corresponding to the searching parameters, ignoring pagination.
public
selectFilteredFeatures() : jResponseBinary|jResponseJson
Return values
jResponseBinary|jResponseJsonsetErrorResponse()
Sets the error in the provided response object based on the given HTTP error code.
protected
setErrorResponse(jResponseJson $rep, int $code, string $errorMessage) : jResponseJson
Parameters
- $rep : jResponseJson
-
- the response object to which the error details will be assigned
- $code : int
-
- the HTTP error code
- $errorMessage : string
-
- the custom error message
Return values
jResponseJson —returns the updated response object containing the error details
getExpFilter()
Return expression filter parameter.
private
getExpFilter() : null|string
Return values
null|stringgetProject()
Get the Lizmap project. If the project does not exist, the user does not have the right to access the project or the user does not have access to WFS data, set the error response.
private
getProject(jResponseJson $rep) : null|Project
Parameters
- $rep : jResponseJson
-
- the response object to which the error details will be assigned
Return values
null|Project —- the Lizmap project or null
initClassProperties()
Assign values to class instance property.
private
initClassProperties() : mixed