territoires_contours_unite_peuplement.php
API du plugin Contours.
Table of Contents
Functions
- unite_peuplement_contour_charger() : array<string|int, mixed>
- Ajoute des contours géolocalisés aux territoires.
- unite_peuplement_contour_vider() : array<string|int, mixed>
- Supprime des contours géolocalisés de territoires.
Functions
unite_peuplement_contour_charger()
Ajoute des contours géolocalisés aux territoires.
unite_peuplement_contour_charger(string $type, string $pays, string $service) : array<string|int, mixed>
Les territoires sont identifiés par groupe via le couple (type, pays).
Parameters
- $type : string
-
Type de territoires à peupler. Prends les valeurs
zone
,country
ousubdivision
. - $pays : string
-
Code ISO 3166-1 alpha2 du pays dont on veut peupler les subdivisions. N'est utilisé que si le type choisi est
subdivision
. - $service : string
-
Identifiant du service Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide
Tags
Return values
array<string|int, mixed> —Tableau retour de la fonction permettant de connaitre le résultat du traitement (utile pour l'affichage du message dans le formulaire de peuplement).
unite_peuplement_contour_vider()
Supprime des contours géolocalisés de territoires.
unite_peuplement_contour_vider(string $type, string $pays, string $service) : array<string|int, mixed>
Les territoires sont identifiés par groupe via le couple (type, pays).
Parameters
- $type : string
-
Type de territoires à peupler. Prends les valeurs
zone
,country
ousubdivision
. - $pays : string
-
Code ISO 3166-1 alpha2 du pays dont on veut peupler les subdivisions. N'est utilisé que si le type choisi est
subdivision
, sinon vaut chaine vide. - $service : string
-
Identifiant du service Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide
Tags
Return values
array<string|int, mixed> —Liste des code ISO 3166-1 alpha2 des pays chargés sous la forme [code] = nom multi.