lizmap/lizmap-openads-module

Jelix 模块，允许与 OpenADS 进行交互。

维护者

详细信息

github.com/3liz/lizmap-openads-module

主页

源代码

问题

资助包维护！
www.3liz.com/en/contacts.html

安装: 168

依赖关系: 0

建议者: 0

安全性: 0

星级: 3

关注者: 8

分支: 1

开放问题: 1

类型:jelix-module

1.1.2 2024-06-10 15:25 UTC

MPL-2.0 543872528e8a57c01c5b7e225ec4d63c4e65e634

  • 3Liz <info.woop@3liz.com>

modulejelixlizmapopenads

This package is auto-updated.

Last update: 2024-09-02 14:12:13 UTC

README

Tests 🎳 Packagist

用于连接 Lizmap 与软件 OpenADS 的 Lizmap 模块。

需要 Lizmap 3.5 或更高版本。

安装

建议使用 Composer，PHP 的包管理器，来安装模块。如果不能使用，请使用以下说明的手动方法。

注意：以下所有路径都是相对于 Lizmap Web Client 的目录。

使用 Composer 自动安装

  • 在 lizmap/my-packages 中，如果尚不存在，则创建 composer.json 文件，方法是复制 composer.json.dist 文件，然后使用 Composer 安装模块
cp -n lizmap/my-packages/composer.json.dist lizmap/my-packages/composer.json
composer require --working-dir=lizmap/my-packages "lizmap/lizmap-openads-module"
  • 然后进入 lizmap/install/ 目录以启动安装程序

如果您使用的是 Lizmap 3.6 及更高版本，请先运行以下命令

php configurator.php openads
  • 最后运行模块安装
php installer.php
./clean_vartmp.sh
./set_rights.sh

进入“配置”部分。

手动安装，不使用 Composer

  • 从 Github 版本页面 下载存档。

  • 解压存档，并将 openads 目录复制到 lizmap/lizmap-modules/。

  • 如果您使用的是 Lizmap 3.5，请编辑 lizmap/var/config/localconfig.ini.php 文件，在 [modules] 部分添加

openads.access=2
  • 如果您使用的是 Lizmap 3.6，请运行以下命令
php lizmap/install/configurator.php openads
  • 对于所有版本的 Lizmap，请运行安装程序
php lizmap/install/installer.php
./lizmap/install/clean_vartmp.sh
./lizmap/install/set_rights.sh

测试 API

以下所有请求都可以通过 单元测试 进行测试

您可以使用 curl 和基本身份验证进行测试。

# EXEMPLE
curl -u username:password https://exemple.com

以下示例中，我们使用的基本 URL 为 http://lizmap.localhost/

  • 定义 API 基础 URL
BASEURL="http://lizmap.localhost/openads.php"
  • 地块
# PARCELLES
###

# Test avec mauvais mot de passe
RESULT=$(curl -s -X GET -H 'Content-Type: application/json' -u admin:badpassword "$BASEURL/services/openads~openads/parcelles/800016000AK0145") && echo $RESULT

# Test avec bon login et bons ids_parcelles
RESULT=$(curl -s -X GET -H 'Content-Type: application/json' -u admin:admin "$BASEURL/services/openads~openads/parcelles/800016000AK0145") && echo $RESULT
# Exemple de résultat
# {"parcelles":[{"parcelle":"800016000AK0145","existe":"true","adresse":{"numero_voie":"0057  ","type_voie":"CHE","nom_voie":"CROISE DE LA JUSTICE      ","arrondissement":"016"}}]}

# Test avec bon login et mauvais ids_parcelle
RESULT=$(curl -s -X GET -H 'Content-Type: application/json' -u admin:admin "$BASEURL/services/openads~openads/parcelles/80016") && echo $RESULT
# Exemple de résultat
# {"parcelles":[{"parcelle":"800016000A","existe":"false"}]}

# COMMUNES

# Test requête communes avec code insee
RESULT=$(curl -s -X GET -H 'Content-Type: application/json' -u admin:admin "$BASEURL/services/openads~openads/communes/80016/contraintes") && echo $RESULT
# Exemple de résultat
# {"contraintes":[{"contrainte":"64","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Uec","texte":"Secteur urbain \u00e9conomique"},{"contrainte":"63","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Uco","texte":"Secteur urbain de commerce"},{"contrainte":"51","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"1AUm","texte":"Zone \u00e0 urbaniser mixte habitat \/ \u00e9conomie"},{"contrainte":"57","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"2AUec","texte":"Zone \u00e0 urbaniser \u00e0 vocation \u00e9conomique"},{"contrainte":"36","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Up","texte":"Secteur urbain en p\u00e9riph\u00e9rie du centre-ville et des anciens faubourgs d'Albert"},{"contrainte":"37","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Nzh","texte":"Secteur naturel concern\u00e9 par des Zones \u00e0 Dominante Humide du SDAGE Artois-Picardie"},{"contrainte":"44","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"N","texte":"Zone naturelle"},{"contrainte":"43","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Uag","texte":"Secteur urbain avec enjeux agricoles"},{"contrainte":"33","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Ueq","texte":"Secteur urbain d'\u00e9quipements publics"},{"contrainte":"42","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"A","texte":"Zone agricole"},{"contrainte":"53","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Uc","texte":"Secteur urbain compos\u00e9 majoritairement d'extensions r\u00e9centes"},{"contrainte":"62","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Azh","texte":"Secteur agricole concern\u00e9 par des Zones \u00e0 Dominante Humide du SDAGE Artois-Picardie"},{"contrainte":"50","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"2AUh","texte":"Zone \u00e0 urbaniser \u00e0 vocation principale d'habitat"},{"contrainte":"52","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Ap","texte":"Secteur agricole prot\u00e9g\u00e9"},{"contrainte":"46","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"1AUco","texte":"Zone \u00e0 urbaniser \u00e0 vocation commerciale"},{"contrainte":"45","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Uf","texte":"Secteur urbain des anciens faubourgs autour du centre-ville d'Albert"},{"contrainte":"60","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Uv","texte":"Secteur urbain du centre-ville d'Albert"},{"contrainte":"34","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Neq","texte":"Secteur naturel d'\u00e9quipements publics"},{"contrainte":"41","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"1AUh","texte":"Zone \u00e0 urbaniser \u00e0 vocation principale d'habitat"}]}

# DOSSIERS

# Test du calcul de l'emprise
RESULT=$(curl -s -X POST -H 'Content-Type: application/json' -d '{"parcelles":["800016000AT0031", "800016000AO0179"]}' -u admin:admin "$BASEURL/services/openads~openads/dossiers/444444/emprise") && echo $RESULT
# Exemple de résultat
# {"emprise":{"statut_calcul_emprise":"true"}}

# Test du calcul du centroïde
RESULT=$(curl -s -X POST -H 'Content-Type: application/json' -u admin:admin "$BASEURL/services/openads~openads/dossiers/444444/centroide") && echo $RESULT
# Exemple de résultat
# {"centroide":{"statut_calcul_centroide":"true","x":"674251.814403417","y":"6988657.01009032"}}

# Test de récupération des contraintes
RESULT=$(curl -s -X GET -H 'Content-Type: application/json' -u admin:admin "$BASEURL/services/openads~openads/dossiers/444444/contraintes") && echo $RESULT
# Exemple de résultat
# {"contraintes":[{"contrainte":"36","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Up","texte":"Secteur urbain en p\u00e9riph\u00e9rie du centre-ville et des anciens faubourgs d'Albert"},{"contrainte":"45","groupe_contrainte":"Zonage","sous_groupe_contrainte":"ZOne urba","libelle":"Uf","texte":"Secteur urbain des anciens faubourgs autour du centre-ville d'Albert"}]}