Territoires

SERVICES

Constants

_TERRITOIRES_COEFF_MAX_DISTANT = 8: Coefficient multiplicateur de la constante SPIP `_INC_DISTANT_MAX_SIZE` permettant de calculer la taille max d'une réponse à `recuperer_url()` si aucune taille n'est précisée dans l'appel.
_TERRITOIRES_COMPATIBILITE_ISOCODE = ['vmin' => '2.0.1']: Endpoint de l'API REST hébergeant les données de Nomenclatures.
_TERRITOIRES_URL_BASE_ISOCODE = 'https://contrib.spip.net/http.api/ezrest': Endpoint de l'API REST hébergeant les données de Nomenclatures.

Functions

inc_requeter_isocode_dist() : array<string|int, mixed>: Renvoie, à partir de l'url du service, le tableau des données demandées.
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_configuration_recharger() : void: Recharge la configuration du plugin.
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 de l’unité de peuplement concernée.
territoires_unite_peuplement_definir_filtre() : array<string|int, mixed>: Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction de l’unité de peuplement voire du service concerné.

_TERRITOIRES_COEFF_MAX_DISTANT

Coefficient multiplicateur de la constante SPIP `_INC_DISTANT_MAX_SIZE` permettant de calculer la taille max d'une réponse à `recuperer_url()` si aucune taille n'est précisée dans l'appel.


    public
        mixed
    _TERRITOIRES_COEFF_MAX_DISTANT
    = 8

_TERRITOIRES_COMPATIBILITE_ISOCODE

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


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

_TERRITOIRES_URL_BASE_ISOCODE

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


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

inc_requeter_isocode_dist()

Renvoie, à partir de l'url du service, le tableau des données demandées.


    
                    inc_requeter_isocode_dist(string $url_base[, null|string $collection = '' ][, null|array<string|int, mixed> $filtres = [] ][, null|int $taille_max = 0 ]) : array<string|int, mixed>

Le service utilise dans ce cas une chaine JSON qui est décodée pour fournir le tableau de sortie. Le flux retourné par le service est systématiquement transcodé dans le charset du site avant d'être décodé.

Parameters

$url_base : string: Endpoint du serveur
$collection : null|string = '': Nom de la collection ou vide si on veut récupérer l'index des collections du serveur.
$filtres : null|array<string|int, mixed> = []: Tableau des filtres à appliquer à la collection
$taille_max : null|int = 0: Taille maximale du flux récupéré suite à la requête. La valeur entière 0 désigne la taille par défaut.

Return values

array<string|int, mixed> —

Tableau de la réponse. Si l'index erreur['status'] indique le statut de la réponse. La valeur 200 permet de tester une requête réussie et dans ce cas l'index page du flux reçu est retourné après décodage JSON.

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.

Return values

array<string|int, mixed> —

Bornes de compatibilité avec le serveur.

territoires_configuration_recharger()

Recharge la configuration du plugin.


    
                    territoires_configuration_recharger(string $plugin) : void

Le service appelle un pipeline homonyme permettant de prolonger l'action au-delà du plugin utilisateur.

Le plugin Territoires recharge sa propre configuration statique.

Parameters

$plugin : string: Préfixe du plugin utilisateur

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.

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.

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_area ou infrasubdivision.

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.

Return values

array<string|int, mixed> —

Liste des feeds.

territoires_unite_peuplement_definir_collection()

Renvoie la collection de Nomenclatures à requêter en fonction de l’unité de peuplement concernée.


    
                    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_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_unite_peuplement_definir_filtre()

Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction de l’unité de peuplement voire du service concerné.


    
                    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_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.

SERVICES

Table of Contents

Constants

Functions

Constants

_TERRITOIRES_COEFF_MAX_DISTANT

_TERRITOIRES_COMPATIBILITE_ISOCODE

_TERRITOIRES_URL_BASE_ISOCODE

Functions

inc_requeter_isocode_dist()

Parameters

Tags

Return values

territoires_serveur_definir_compatibilite()

Parameters

Tags

Return values

territoires_configuration_recharger()

Parameters

Tags

territoires_feed_initialiser_url_base()

Parameters

Tags

Return values

territoires_feed_categorie_lister()

Parameters

Tags

Return values

territoires_feed_indexer_hash()

Parameters

Tags

Return values

territoires_feed_acquerir()

Parameters

Tags

Return values

territoires_unite_peuplement_definir_collection()

Parameters

Tags

Return values

territoires_unite_peuplement_definir_filtre()

Parameters

Tags

Return values