SPIP Code

Documentation du code de SPIP et de ses plugins

Contours des territoires

territoires_contours.php

Ce fichier contient les fonctions de service spécifiques du plugin Contours et nécessitées par l'utilisation du plugin `Territoires`.

Table of Contents

Constants

_TERRITOIRES_CONTOURS_COMPATIBILITE_ISOCODE  = ['vmin' => '2.0.1']
Endpoint de l'API REST hébergeant les données de Nomenclatures.
_TERRITOIRES_CONTOURS_URL_BASE_ISOCODE  = 'https://contrib.spip.net/http.api/ezrest'
Endpoint de l'API REST hébergeant les données de Nomenclatures.

Functions

territoires_contours_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_contours_feed_initialiser_url_base()  : string
Renvoie l'URL de base du serveur Nomenclatures fournissant des informations sur les territoires.
territoires_contours_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_contours_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_contours_unite_peuplement_definir_collection()  : string
Renvoie, la collection de Nomenclatures à requêter en fonction du type de territoires concerné.
territoires_contours_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

_TERRITOIRES_CONTOURS_COMPATIBILITE_ISOCODE

Endpoint de l'API REST hébergeant les données de Nomenclatures.

public mixed _TERRITOIRES_CONTOURS_COMPATIBILITE_ISOCODE = ['vmin' => '2.0.1']

_TERRITOIRES_CONTOURS_URL_BASE_ISOCODE

Endpoint de l'API REST hébergeant les données de Nomenclatures.

public mixed _TERRITOIRES_CONTOURS_URL_BASE_ISOCODE = 'https://contrib.spip.net/http.api/ezrest'

Functions

territoires_contours_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_contours_serveur_definir_compatibilite() : 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.).

Tags
uses
territoires_chercher_service()
Return values
array<string|int, mixed> —

Bornes de compatibilité avec le serveur.

territoires_contours_feed_initialiser_url_base()

Renvoie l'URL de base du serveur Nomenclatures fournissant des informations sur les territoires.

territoires_contours_feed_initialiser_url_base() : string
Return values
string —

URL de base du serveur REST

territoires_contours_feed_categorie_lister()

Renvoie la liste des catégories de feed de Nomenclatures correspondant à la nature des informations demandées.

territoires_contours_feed_categorie_lister() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Liste des catégories de feeds de Nomenclatures utilisées par le plugin appelant.

territoires_contours_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_contours_feed_indexer_hash(string $type) : string
Parameters
$type : string

Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.

Return values
string —

Index du hash dans la réponse à la requête REST.

territoires_contours_unite_peuplement_definir_collection()

Renvoie, la collection de Nomenclatures à requêter en fonction du type de territoires concerné.

territoires_contours_unite_peuplement_definir_collection(string $type[, null|string $pays = '' ][, null|string $service = '' ]) : string

Pour le plugin Contours, seule la collection contours est utilisée.

Parameters
$type : string

Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.

$pays : null|string = ''

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon 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.

Return values
string —

Identifiant de la collection.

territoires_contours_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_contours_unite_peuplement_definir_filtre(string $type[, null|string $pays = '' ][, null|string $service = '' ]) : array<string|int, mixed>
Parameters
$type : string

Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.

$pays : null|string = ''

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon 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.

Return values
array<string|int, mixed> —

Filtres à appliquer à la collection.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results