territoires.php
Ce fichier contient les fonctions de service nécessitées par l'utilisation du plugin `Territoires`.
Table of Contents
Constants
- _TERRITOIRE_COMPATIBILITE_ISOCODE = ['vmin' => '2.0.1']
- Endpoint de l'API REST hébergeant les données de Nomenclatures.
- _TERRITOIRE_URL_BASE_ISOCODE = 'https://contrib.spip.net/http.api/ezrest'
- Endpoint de l'API REST hébergeant les données de Nomenclatures.
Functions
- territoires_serveur_definir_compatibilite() : array<string|int, mixed>
- Renvoie, pour le plugin appelant, les bornes de compatibilité avec le serveur fournissant une nature d'informations donnée sur les territoires.
- territoires_feed_initialiser_url_base() : string
- Renvoie l'URL de base du serveur Nomenclatures fournissant des informations sur les territoires.
- territoires_feed_categorie_lister() : array<string|int, mixed>
- Renvoie la liste des catégories de feed de Nomenclatures correspondant à la nature des informations demandées.
- territoires_feed_indexer_hash() : string
- Renvoie, pour la collection `feeds`, l'index du hash permettant de savoir si le ou les feeds récupérés sont obsolètes.
- territoires_feed_acquerir() : array<string|int, mixed>
- Liste les feeds fournissant des informations de territoires d'une nature donnée exprimée sous la forme de catégories.
- territoires_unite_peuplement_definir_collection() : string
- Renvoie, la collection de Nomenclatures à requêter en fonction du type de territoires concerné.
- territoires_unite_peuplement_definir_filtre() : array<string|int, mixed>
- Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction du type de territoires, du pays voire du service concernés.
Constants
_TERRITOIRE_COMPATIBILITE_ISOCODE
Endpoint de l'API REST hébergeant les données de Nomenclatures.
public
mixed
_TERRITOIRE_COMPATIBILITE_ISOCODE
= ['vmin' => '2.0.1']
_TERRITOIRE_URL_BASE_ISOCODE
Endpoint de l'API REST hébergeant les données de Nomenclatures.
public
mixed
_TERRITOIRE_URL_BASE_ISOCODE
= 'https://contrib.spip.net/http.api/ezrest'
Functions
territoires_serveur_definir_compatibilite()
Renvoie, pour le plugin appelant, les bornes de compatibilité avec le serveur fournissant une nature d'informations donnée sur les territoires.
territoires_serveur_definir_compatibilite(string $plugin) : array<string|int, mixed>
En fait, la nature d'information est liée au plugin appelant (nomenclatures pour Territoires, contours géographiques pour le plugin Contours de territoires, etc.).
Parameters
- $plugin : string
-
Préfixe du plugin appelant.
Tags
Return values
array<string|int, mixed> —Bornes de compatibilité avec le serveur.
territoires_feed_initialiser_url_base()
Renvoie l'URL de base du serveur Nomenclatures fournissant des informations sur les territoires.
territoires_feed_initialiser_url_base(string $plugin) : string
Parameters
- $plugin : string
-
Préfixe du plugin appelant.
Tags
Return values
string —URL de base du serveur REST
territoires_feed_categorie_lister()
Renvoie la liste des catégories de feed de Nomenclatures correspondant à la nature des informations demandées.
territoires_feed_categorie_lister(string $plugin) : array<string|int, mixed>
Pour Territoires, la nomenclature est fournie au travers de la catégorie de feed nommée territory.
Parameters
- $plugin : string
-
Préfixe du plugin appelant.
Tags
Return values
array<string|int, mixed> —Liste des catégories de feeds de Nomenclatures utilisées par le plugin appelant.
territoires_feed_indexer_hash()
Renvoie, pour la collection `feeds`, l'index du hash permettant de savoir si le ou les feeds récupérés sont obsolètes.
territoires_feed_indexer_hash(string $plugin, string $type) : string
Parameters
- $plugin : string
-
Préfixe du plugin appelant.
- $type : string
-
Type de territoires. Prends les valeurs
zone,country,subdivision,protected_areaouinfrasubdivision.
Tags
Return values
string —Index du hash dans la réponse à la requête REST.
territoires_feed_acquerir()
Liste les feeds fournissant des informations de territoires d'une nature donnée exprimée sous la forme de catégories.
territoires_feed_acquerir(string $plugin, array<string|int, mixed> $categories_feed) : array<string|int, mixed>
Parameters
- $plugin : string
-
Préfixe du plugin appelant.
- $categories_feed : array<string|int, mixed>
-
Liste des catégories de feeds à acquérir.
Tags
Return values
array<string|int, mixed> —Liste des feeds.
territoires_unite_peuplement_definir_collection()
Renvoie, la collection de Nomenclatures à requêter en fonction du type de territoires concerné.
territoires_unite_peuplement_definir_collection(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : string
Parameters
- $plugin : string
-
Préfixe du plugin appelant.
- $type : string
-
Type de territoires. Prends les valeurs
zone,country,subdivision,protected_areaouinfrasubdivision. - $pays : null|string = ''
-
Code ISO 3166-1 alpha2 du pays si le type est
subdivisionouinfrasubdivisionsinon une chaine vide. - $service : null|string = ''
-
Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.
Tags
Return values
string —Identifiant de la collection.
territoires_unite_peuplement_definir_filtre()
Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction du type de territoires, du pays voire du service concernés.
territoires_unite_peuplement_definir_filtre(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : array<string|int, mixed>
Parameters
- $plugin : string
-
Préfixe du plugin appelant.
- $type : string
-
Type de territoires. Prends les valeurs
zone,country,subdivision,protected_areaouinfrasubdivision. - $pays : null|string = ''
-
Code ISO 3166-1 alpha2 du pays si le type est
subdivisionouinfrasubdivisionsinon une chaine vide. - $service : null|string = ''
-
Identifiant du feed 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> —Filtres à appliquer à la collection.