SPIP Code

Documentation du code de SPIP et de ses plugins

Nomenclatures officielles

Documentation

Table of Contents

Packages

SPIP
Application

Namespaces

Composer
Vicchi

Classes

ComposerAutoloaderInit4218fb8d9f32b0122bda013c584ba03f

Functions

isocode_declarer_tables_principales()  : array<string|int, mixed>
Déclaration des nouvelles tables de la base de données propres au plugin.
isocode_declarer_tables_interfaces()  : array<string|int, mixed>
Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.
isocode_erreur_codes_spip()  : array<string|int, mixed>
isocode_verifier_codes_spip()  : array<string|int, mixed>
isocode_verifier_iso639_5()  : array<string|int, mixed>
area_fr_arrondissements_item_completer()  : array<string|int, mixed>
Complète un item extrait de la source via le service `territory_fr_arrondissements` (avant son évolution en enregistrement de la table `infrasubdivisions`).
area_fr_epci_item_completer()  : array<string|int, mixed>
Complète un item extrait de la source via le service `territory_fr_epci` (avant son évolution en enregistrement de la table `infrasubdivisions`).
area_fr_communes_item_completer()  : array<string|int, mixed>
Complète un item extrait de la source via le service `area_fr_communes` (avant son évolution en enregistrement de la table `infrasubdivisions`).
area_fr_communes_record_list_completer()  : array<string|int, mixed>
Complète les enregistrements de base du feed `area_fr_communes`.
area_countries_record_list_completer()  : array<string|int, mixed>
Complète les enregistrements de base du feed `area_countries`.
area_subdivisions_record_completer()  : array<string|int, mixed>
Complète un enregistrement du feed `area_subdivisions`.
area_subdivisions_record_fusionner()  : array<string|int, mixed>
Fusionne un enregistrement avec un autre du feed `area_subdivisions` : cela est utile uniquement pour créer un multi du label.
area_subdivisions_record_list_completer()  : array<string|int, mixed>
Complète les enregistrements du `area_subdivisions`.
area_subdivisions_target_completer_consigne()  : array<string|int, mixed>
Complète la consigne de peuplement du feed `area_subdivisions`.
area_protected_areas_target_completer_consigne()  : array<string|int, mixed>
Complète la consigne de peuplement du feed `area_protected_areas`.
consigne_ajouter_hash_pays()  : array<string|int, mixed>
Complète la consigne de peuplement avec le hash par pays.
isocode_feed_categorie_lister()  : array<string|int, mixed>
Renvoie la liste des catégories et leur description.
isocode_feed_categorie_initialiser_defaut()  : string
Renvoie l'identifiant de la catégorie par défaut d'un plugin utilisateur.
iana_5646subtags_decoder()  : array<string|int, mixed>
Décodage spécifique de la source IANA des subtags RFC 5646.
lang_iso639_families_record_completer()  : array<string|int, mixed>
Complète un enregistrement de base du feed `lang_iso639_families` à partir d'une source qui est lue une fois et mise en stockage statique.
map_continents_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_continents`.
map_countries_item_completer()  : array<string|int, mixed>
Complète un item de la source du feed `map_countries`.
map_fr_regions_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_fr_regions`.
map_fr_departments_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_fr_departments`.
map_de_lander_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_de_lander`.
map_ch_cantons_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_ch_cantons`.
map_be_regions_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_be_regions`.
map_be_provinces_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_be_regions`.
map_us_states_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_us_states`.
map_nl_provinces_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_de_lander`.
map_pt_districts_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `map_us_states`.
pa_fr_marine_parks_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `pa_fr_marine_parks`.
pa_fr_national_parks_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `pa_fr_national_parks`.
pa_fr_regional_parks_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible du feed `pa_fr_regional_parks`.
opendatasoft_georef_record_completer()  : array<string|int, mixed>
Complète un enregistrement de la cible d'un feed de map provenant d'Opendatasoft d'une façon standardisée: - récupérer la latitude et la longitude à partir du champ geo_point_2d - imposer le format Right-Hand Rule au contour - encoder le champs des géométries.
misc_iso4217_currencies_record_completer()  : array<string|int, mixed>
Complète un enregistrement de base du feed `misc_iso4217_currencies` à partir d'une source qui est lue une fois et mise en stockage statique.
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`.
feed_repertorier_tables()  : array<string|int, mixed>
Retourne la liste des identifiants des tables utilisées par les feeds du plugin.
feed_compiler_hash()  : array<string|int, mixed>
Compile les hash des feeds ayant remplis les données de la colleciton à partir de la colonne `service` (toujours utilisée avec ce nom par Nomenclatures).
isocode_upgrade()  : void
Fonction d'installation et de mise à jour du plugin.
isocode_vider_tables()  : void
Fonction de désinstallation du plugin.
maj_11_colonne_service()  : void
Insertion du feed dans la nouvelle colonne service pour les feeds déjà chargés.
isocode_liste_ezcollection()  : array<string|int, mixed>
Déclare les collections accessibles via l'API ezREST.

Functions

isocode_declarer_tables_principales()

Déclaration des nouvelles tables de la base de données propres au plugin.

isocode_declarer_tables_principales(array<string|int, mixed> $tables_principales) : array<string|int, mixed>

Le plugin déclare des tables ISO-639 issues de 2 bases de données (SIL et Library of Congress uniquement pour les familles de langues) :

  • spip_iso639codes, qui contient les codes ISO-639-3, 2 et 1,
  • spip_iso639names, qui contient les noms de langue,
  • spip_iso639macros, qui contient le mapping des macrolangues,
  • spip_iso639retirements, qui contient les langues retirées de la liste officielle,
  • spip_iso639families, qui contient les familles et groupes de langues ISO-639-5,

Le plugin déclare aussi une table spip_iso15924scripts qui contient les codets d'écriture à 4 lettres et leur définition en français et en anglais et une table spip_iana5646subtags qui contient les codes des sous-étiquettes des étiquettes de langue construites selon la RFC 5646.

Le plugin déclare aussi un ensemble de tables liées aux différents découpages géographiques, à savoir:

  • spip_geoipcontinents qui contient les indicatifs GeoIP des continents.
  • spip_m49regions qui contient les indicatifs M49 des zones géographiques englobant les pays.
  • spip_iso3166countries qui contient les indicatifs ISO-3166-1 des pays.
  • spip_iso3166subdivisions qui contient les indicatifs ISO-3166-2 des subdivisions des pays.
  • spip_wdpas qui contient les indicatifs WDPA des zones protégées des pays.
  • spip_infrasubdivisions qui contient les indicatifs nationaux des infra-subdivisions des pays.
  • spip_iso3166alternates qui contient des codes nationaux ou supranationaux alternatifs aux codes IS0 3166 (NUTS, INSEE...).

Le plugin déclare aussi la table spip_geoboundaries qui contient les contours de territoires.

Le plugin déclare enfin une table des devises ISO-4217, spip_iso4217currencies.

Parameters
$tables_principales : array<string|int, mixed>

Tableau global décrivant la structure des tables de la base de données

Tags
pipeline

declarer_tables_principales

Return values
array<string|int, mixed> —

Tableau fourni en entrée et mis à jour avec les nouvelles déclarations

isocode_declarer_tables_interfaces()

Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.

isocode_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>

Le plugin se contente de déclarer les alias des tables qu'il ajoute.

Parameters
$interfaces : array<string|int, mixed>

Tableau global des informations tierces sur les tables de la base de données

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed> —

Tableau fourni en entrée et mis à jour avec les nouvelles informations

isocode_erreur_codes_spip()

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

isocode_verifier_codes_spip()

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

isocode_verifier_iso639_5()

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

area_fr_arrondissements_item_completer()

Complète un item extrait de la source via le service `territory_fr_arrondissements` (avant son évolution en enregistrement de la table `infrasubdivisions`).

area_fr_arrondissements_item_completer(array<string|int, mixed> $item, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$item : array<string|int, mixed>

Item extrait de la source.

$feed : array<string|int, mixed>

Configuration du feed.

Return values
array<string|int, mixed> —

Item complété.

area_fr_epci_item_completer()

Complète un item extrait de la source via le service `territory_fr_epci` (avant son évolution en enregistrement de la table `infrasubdivisions`).

area_fr_epci_item_completer(array<string|int, mixed> $item, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$item : array<string|int, mixed>

Item extrait de la source.

$feed : array<string|int, mixed>

Configuration du feed.

Return values
array<string|int, mixed> —

Item complété.

area_fr_communes_item_completer()

Complète un item extrait de la source via le service `area_fr_communes` (avant son évolution en enregistrement de la table `infrasubdivisions`).

area_fr_communes_item_completer(array<string|int, mixed> $item, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$item : array<string|int, mixed>

Item extrait de la source.

$feed : array<string|int, mixed>

Configuration du feed.

Return values
array<string|int, mixed> —

Item complété.

area_fr_communes_record_list_completer()

Complète les enregistrements de base du feed `area_fr_communes`.

area_fr_communes_record_list_completer(array<string|int, mixed> $enregistrements, array<string|int, mixed> $feed) : array<string|int, mixed>

La fonction ajoute la latitude et la longitude du point central de chaque commune.

Parameters
$enregistrements : array<string|int, mixed>

Liste des enregistrements déjà remplis à partir de la source.

$feed : array<string|int, mixed>

Configuration du feed

Tags
throws
Exception
Return values
array<string|int, mixed> —

Liste des enregistrements complétés.

area_countries_record_list_completer()

Complète les enregistrements de base du feed `area_countries`.

area_countries_record_list_completer(array<string|int, mixed> $enregistrements, array<string|int, mixed> $feed) : array<string|int, mixed>

La fonction ajoute :

  • des informations sur le pays
  • le lien avec la région d'appartenance
  • des traductions si nécessaire.
Parameters
$enregistrements : array<string|int, mixed>

Liste des enregistrements déjà remplis à partir de la source.

$feed : array<string|int, mixed>

Configuration du feed

Tags
throws
Exception
Return values
array<string|int, mixed> —

Liste des enregistrements complétés.

area_subdivisions_record_completer()

Complète un enregistrement du feed `area_subdivisions`.

area_subdivisions_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

area_subdivisions_record_fusionner()

Fusionne un enregistrement avec un autre du feed `area_subdivisions` : cela est utile uniquement pour créer un multi du label.

area_subdivisions_record_fusionner(array<string|int, mixed> $enregistrement_en_cours, array<string|int, mixed> $enregistrement_en_liste, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$enregistrement_en_cours : array<string|int, mixed>

Enregistrement du dataset cible en cours de constitution

$enregistrement_en_liste : array<string|int, mixed>

Enregistrement du dataset cible déjà dans la liste

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

La liste des enregistrements mise à jour avec la fusion sur l'enregistrement concerné.

area_subdivisions_record_list_completer()

Complète les enregistrements du `area_subdivisions`.

area_subdivisions_record_list_completer(array<string|int, mixed> $enregistrements, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$enregistrements : array<string|int, mixed>

Liste des enregistrements déjà remplis à partir de la source.

$feed : array<string|int, mixed>

Configuration du feed

Tags
throws
Exception
Return values
array<string|int, mixed> —

Liste des enregistrements complétés.

area_subdivisions_target_completer_consigne()

Complète la consigne de peuplement du feed `area_subdivisions`.

area_subdivisions_target_completer_consigne(array<string|int, mixed> $consigne, array<string|int, mixed> $enregistrements, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$consigne : array<string|int, mixed>

Consigne initialisé par défaut par Mashup Factory

$enregistrements : array<string|int, mixed>

Liste des enregistrement du dataset cible

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Consigne éventuellement mise à jour.

area_protected_areas_target_completer_consigne()

Complète la consigne de peuplement du feed `area_protected_areas`.

area_protected_areas_target_completer_consigne(array<string|int, mixed> $consigne, array<string|int, mixed> $enregistrements, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$consigne : array<string|int, mixed>

Consigne initialisé par défaut par Mashup Factory

$enregistrements : array<string|int, mixed>

Liste des enregistrement du dataset cible

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Consigne éventuellement mise à jour.

consigne_ajouter_hash_pays()

Complète la consigne de peuplement avec le hash par pays.

consigne_ajouter_hash_pays(array<string|int, mixed> $consigne, array<string|int, mixed> $enregistrements) : array<string|int, mixed>
Parameters
$consigne : array<string|int, mixed>

Consigne initialisé par défaut par Mashup Factory

$enregistrements : array<string|int, mixed>

Liste des enregistrement du dataset cible

Return values
array<string|int, mixed> —

Enregistrement complété.

isocode_feed_categorie_lister()

Renvoie la liste des catégories et leur description.

isocode_feed_categorie_lister() : array<string|int, mixed>

Le plugin Mashup Factory fournit une liste limitée à la catégorie d'identifiant default.

Return values
array<string|int, mixed> —

Liste des catégories et de leur description au format [id] = tableau de description avec le nom (label), la description et l'icone.

isocode_feed_categorie_initialiser_defaut()

Renvoie l'identifiant de la catégorie par défaut d'un plugin utilisateur.

isocode_feed_categorie_initialiser_defaut() : string

Le plugin Mashup Factory choisit la première catégorie de la liste.

Return values
string —

Identifiant de la catégorie par défaut.

iana_5646subtags_decoder()

Décodage spécifique de la source IANA des subtags RFC 5646.

iana_5646subtags_decoder(string $contenu, array<string|int, mixed> $arguments, string $id_source, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$contenu : string

Chaine à décoder

$arguments : array<string|int, mixed>

Arguments de la fonction de décodage spécifique ou vide sinon

$id_source : string

Identifiant de la source en cours de décodage

$feed : array<string|int, mixed>

Configuration complète du feed

Return values
array<string|int, mixed> —

Source décodée sous la forme d'une liste d'items

lang_iso639_families_record_completer()

Complète un enregistrement de base du feed `lang_iso639_families` à partir d'une source qui est lue une fois et mise en stockage statique.

lang_iso639_families_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>

La fonction ajoute :

  • la traduction en français
  • le symbole
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Tags
throws
Exception
Return values
array<string|int, mixed> —

Enregistrement complété.

map_continents_record_completer()

Complète un enregistrement de la cible du feed `map_continents`.

map_continents_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_countries_item_completer()

Complète un item de la source du feed `map_countries`.

map_countries_item_completer(array<string|int, mixed> $item, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$item : array<string|int, mixed>

Item de la source

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Item complété.

map_fr_regions_record_completer()

Complète un enregistrement de la cible du feed `map_fr_regions`.

map_fr_regions_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_fr_departments_record_completer()

Complète un enregistrement de la cible du feed `map_fr_departments`.

map_fr_departments_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_de_lander_record_completer()

Complète un enregistrement de la cible du feed `map_de_lander`.

map_de_lander_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_ch_cantons_record_completer()

Complète un enregistrement de la cible du feed `map_ch_cantons`.

map_ch_cantons_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_be_regions_record_completer()

Complète un enregistrement de la cible du feed `map_be_regions`.

map_be_regions_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries
  • normaliser le code région.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_be_provinces_record_completer()

Complète un enregistrement de la cible du feed `map_be_regions`.

map_be_provinces_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries
  • normaliser le code région.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_us_states_record_completer()

Complète un enregistrement de la cible du feed `map_us_states`.

map_us_states_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries
  • normaliser le code en lui ajoutant le code ISO des US.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_nl_provinces_record_completer()

Complète un enregistrement de la cible du feed `map_de_lander`.

map_nl_provinces_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

map_pt_districts_record_completer()

Complète un enregistrement de la cible du feed `map_us_states`.

map_pt_districts_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
  • récupérer la latitude et la longitude à partir du champ geo_point_2d
  • imposer le format Right-Hand Rule au contour
  • encoder le champs des géométries
  • normaliser le code en lui ajoutant le code ISO du Portugal.
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

pa_fr_marine_parks_record_completer()

Complète un enregistrement de la cible du feed `pa_fr_marine_parks`.

pa_fr_marine_parks_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

pa_fr_national_parks_record_completer()

Complète un enregistrement de la cible du feed `pa_fr_national_parks`.

pa_fr_national_parks_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

pa_fr_regional_parks_record_completer()

Complète un enregistrement de la cible du feed `pa_fr_regional_parks`.

pa_fr_regional_parks_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Return values
array<string|int, mixed> —

Enregistrement complété.

opendatasoft_georef_record_completer()

Complète un enregistrement de la cible d'un feed de map provenant d'Opendatasoft d'une façon standardisée: - récupérer la latitude et la longitude à partir du champ geo_point_2d - imposer le format Right-Hand Rule au contour - encoder le champs des géométries.

opendatasoft_georef_record_completer(array<string|int, mixed> $enregistrement[, bool|null $avec_latlon = true ]) : array<string|int, mixed>
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$avec_latlon : bool|null = true
Return values
array<string|int, mixed> —

Enregistrement complété.

misc_iso4217_currencies_record_completer()

Complète un enregistrement de base du feed `misc_iso4217_currencies` à partir d'une source qui est lue une fois et mise en stockage statique.

misc_iso4217_currencies_record_completer(array<string|int, mixed> $enregistrement, array<string|int, mixed> $feed) : array<string|int, mixed>

La fonction ajoute :

  • la traduction en français
  • le symbole
Parameters
$enregistrement : array<string|int, mixed>

Enregistrement du dataset cible déjà rempli

$feed : array<string|int, mixed>

Configuration du feed

Tags
throws
Exception
Return values
array<string|int, mixed> —

Enregistrement complété.

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.

feed_repertorier_tables()

Retourne la liste des identifiants des tables utilisées par les feeds du plugin.

feed_repertorier_tables([null|array<string|int, mixed> $filtres = [] ]) : array<string|int, mixed>

Il est possible de filtrer cette liste selon des critères issus des champs des feeds.

Parameters
$filtres : null|array<string|int, mixed> = []

Tableau associatif [champ] = valeur de critères de filtres sur les descriptions de feed. Les opérateurs possibles sont l'égalité et la non égalité.

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

Liste des tables sans le préfixe spip_.

feed_compiler_hash()

Compile les hash des feeds ayant remplis les données de la colleciton à partir de la colonne `service` (toujours utilisée avec ce nom par Nomenclatures).

feed_compiler_hash(array<string|int, mixed> $donnees[, null|string $index = 'hash' ]) : array<string|int, mixed>
Parameters
$donnees : array<string|int, mixed>

Données requêtées

$index : null|string = 'hash'

Type de hash à compiler

Return values
array<string|int, mixed>

isocode_upgrade()

Fonction d'installation et de mise à jour du plugin.

isocode_upgrade(string $nom_meta_base_version, string $version_cible) : void

Le schéma du plugin est composé des tables spip_iso639xxxx et d'une configuration.

Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

$version_cible : string

Version du schéma de données (déclaré dans paquet.xml)

isocode_vider_tables()

Fonction de désinstallation du plugin.

isocode_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP.

Tags
throws
Exception

maj_11_colonne_service()

Insertion du feed dans la nouvelle colonne service pour les feeds déjà chargés.

maj_11_colonne_service() : void

isocode_liste_ezcollection()

Déclare les collections accessibles via l'API ezREST.

isocode_liste_ezcollection(array<string|int, mixed> $collections) : array<string|int, mixed>

Par défaut, le plugin propose une liste de collections.

Parameters
$collections : array<string|int, mixed>

Configuration des collections déjà déclarées.

Tags
pipeline

liste_ezcollection

Return values
array<string|int, mixed> —

Collections complétées.

Search results