requeter_isocode.php
Ce fichier contient la fonction de requêtage des données du plugin Nomenclatures via son API REST.
Table of Contents
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.
Functions
- inc_requeter_isocode_dist() : array<string|int, mixed>
- Renvoie, à partir de l'url du service, le tableau des données demandées.
Constants
_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
Functions
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
0désigne la taille par défaut.
Tags
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.