isocode.php
Ce fichier contient l'ensemble des fonctions de service spécifiques à une ou plusieurs collections.
Table of Contents
Functions
- continents_collectionner() : array<string|int, mixed>
- Récupère la liste des régions du monde de la table spip_m49regions éventuellement filtrées par les critères additionnels positionnés dans la requête.
- zones_collectionner() : array<string|int, mixed>
- Récupère la liste des régions du monde de la table spip_m49regions éventuellement filtrées par les critères additionnels positionnés dans la requête.
- pays_collectionner() : array<string|int, mixed>
- Récupère la liste des pays de la table spip_iso3166countries éventuellement filtrés par les critères additionnels positionnés dans la requête.
- pays_verifier_filtre_zone() : bool
- Détermine si la valeur du critère de région d'appartenance du pays est valide.
- pays_verifier_filtre_continent() : bool
- Détermine si la valeur du continent d'appartenance du pays est valide.
- subdivisions_collectionner() : array<string|int, mixed>
- Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
- subdivisions_conditionner_pays() : string
- Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
- protected_areas_collectionner() : array<string|int, mixed>
- Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
- protected_areas_conditionner_pays() : string
- Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
- infrasubdivisions_collectionner() : array<string|int, mixed>
- Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
- infrasubdivisions_conditionner_pays() : string
- Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
- contours_collectionner() : array<string|int, mixed>
- Récupère la liste des contours géographiques de la table spip_boundaries.
- contours_conditionner_service() : string
- Calcule la condition du filtre service pour lequel il est possible de passer une liste de services séparés par une virgule.
- isocode_reponse_expliquer_erreur() : array<string, mixed>
- Complète le bloc d'erreur éventuellement retourné par les vérifications concernant le critère `zone` ou `continent`.
Functions
continents_collectionner()
Récupère la liste des régions du monde de la table spip_m49regions éventuellement filtrées par les critères additionnels positionnés dans la requête.
continents_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des plugins dont l'index est le préfixe du plugin. Les champs de type id ou maj ne sont pas renvoyés.
zones_collectionner()
Récupère la liste des régions du monde de la table spip_m49regions éventuellement filtrées par les critères additionnels positionnés dans la requête.
zones_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des plugins dont l'index est le préfixe du plugin. Les champs de type id ou maj ne sont pas renvoyés.
pays_collectionner()
Récupère la liste des pays de la table spip_iso3166countries éventuellement filtrés par les critères additionnels positionnés dans la requête.
pays_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des plugins dont l'index est le préfixe du plugin. Les champs de type id ou maj ne sont pas renvoyés.
pays_verifier_filtre_zone()
Détermine si la valeur du critère de région d'appartenance du pays est valide.
pays_verifier_filtre_zone(string $zone, array<string|int, mixed> &$erreur) : bool
La fonction compare uniquement la structure de la chaine passée qui doit être cohérente avec un code à 3 chiffres.
Parameters
- $zone : string
-
La valeur du critère région, soit son code ISO 3166-1 numérique (3 chiffres).
- $erreur : array<string|int, mixed>
-
Bloc d'erreur préparé au cas où la vérification retourne une erreur. Dans ce cas, le bloc et complété et renvoyé.
Return values
bool —true si la valeur est valide, false sinon.
pays_verifier_filtre_continent()
Détermine si la valeur du continent d'appartenance du pays est valide.
pays_verifier_filtre_continent(string $continent, array<string|int, mixed> &$erreur) : bool
La fonction compare uniquement la structure de la chaine passée qui doit être cohérente avec une code à deux lettres majuscules.
Parameters
- $continent : string
-
La valeur du critère région, soit son code ISO 3166-1 numérique (3 chiffres).
- $erreur : array<string|int, mixed>
-
Bloc d'erreur préparé au cas où la vérification retourne une erreur. Dans ce cas, le bloc et complété et renvoyé.
Return values
bool —true si la valeur est valide, false sinon.
subdivisions_collectionner()
Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
subdivisions_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.
subdivisions_conditionner_pays()
Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
subdivisions_conditionner_pays(string $valeur) : string
Parameters
- $valeur : string
-
Valeur du critère
country.
Return values
string —La condition SQL sur le champ country.
protected_areas_collectionner()
Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
protected_areas_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.
protected_areas_conditionner_pays()
Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
protected_areas_conditionner_pays(string $valeur) : string
Parameters
- $valeur : string
-
Valeur du critère
country.
Return values
string —La condition SQL sur le champ country.
infrasubdivisions_collectionner()
Récupère la liste des subdivisions de la table spip_iso3166subdivisions éventuellement filtrés par les critères additionnels positionnés dans la requête.
infrasubdivisions_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.
infrasubdivisions_conditionner_pays()
Calcule la condition du filtre pays pour lequel il est possible de passer une liste de codes de pays séparés par une virgule.
infrasubdivisions_conditionner_pays(string $valeur) : string
Parameters
- $valeur : string
-
Valeur du critère
country.
Return values
string —La condition SQL sur le champ country.
contours_collectionner()
Récupère la liste des contours géographiques de la table spip_boundaries.
contours_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Il est obligatoire de choisir à minima un type de territoire de façon à limiter le transfert d'informations via l'API REST. Un critère facultatif permet de filtrer sur le service ce qui est recommandé.
Parameters
- $conditions : array<string|int, mixed>
-
Conditions à appliquer au select
- $filtres : array<string|int, mixed>
-
Tableau des critères de filtrage additionnels à appliquer au select.
- $configuration : array<string|int, mixed>
-
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Return values
array<string|int, mixed> —Tableau des subdivisions et par défaut des codes alternatifs et de la liste des pays.
contours_conditionner_service()
Calcule la condition du filtre service pour lequel il est possible de passer une liste de services séparés par une virgule.
contours_conditionner_service(string $valeur) : string
Parameters
- $valeur : string
-
Valeur du critère
service.
Return values
string —La condition SQL sur le champ service.
isocode_reponse_expliquer_erreur()
Complète le bloc d'erreur éventuellement retourné par les vérifications concernant le critère `zone` ou `continent`.
isocode_reponse_expliquer_erreur(array<string, mixed> $erreur) : array<string, mixed>
Parameters
- $erreur : array<string, mixed>
-
Tableau initialisé avec les éléments de base de l'erreur.
Return values
array<string, mixed> —Tableau de l'erreur complété avec le titre et le détail.