SPIP Code

Documentation du code de SPIP et de ses plugins

Nomenclatures officielles

isocode.php

Ce fichier contient l'ensemble des fonctions implémentant l'API du plugin.

Table of Contents

isocode_charger()  : array<string|int, mixed>
Charge en base de données une table de nomenclatures peuplée par un service donné.
isocode_decharger()  : array<string|int, mixed>
Supprime en base de données, le contenu d'une table de nomenclatures peuplée par un service donné.
isocode_lister_types_service()  : array<string|int, mixed>
Retourne la liste des services disponibles pour le chargement des tables de nomenclatures.
isocode_lister_services()  : array<string|int, mixed>
Retourne la liste des services disponibles pour un type de service donné.
isocode_lister_tables()  : array<string|int, mixed>
Retourne la liste de toutes les tables gérées par un type de service donné.
isocode_trouver_service()  : array<string|int, mixed>
Détermine le ou les services associés au chargement de la table choisie.
isocode_trouver_table()  : array<string|int, mixed>
Détermine la ou les tables pouvant être peuplées par un service.
isocode_crediter()  : array<string|int, mixed>
Renvoie la configuration des crédits d'un service.
isocode_lire_consignation()  : array<string|int, mixed>
Indique si une table est déjà chargée ou pas en base de données.

Functions

isocode_charger()

Charge en base de données une table de nomenclatures peuplée par un service donné.

isocode_charger(string $type, string $service, string $table) : array<string|int, mixed>
Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

$service : string

Identifiant du service.

$table : string

Nom de la table sans le préfixe spip_.

Tags
uses
lire_source()
uses
isocode_decharger()
uses
inserer_enregistrements()
uses
consigner_chargement()
throws
Exception
Return values
array<string|int, mixed> —

Tableau associatif résultat de l'action de chargement:

  • erreur : identifiant de l'erreur, à savoir, ok, nok ou sha.
  • type : type de service.
  • service : identifiant du service.
  • table : nom de la table sans le préfixe spip_.

isocode_decharger()

Supprime en base de données, le contenu d'une table de nomenclatures peuplée par un service donné.

isocode_decharger(string $type, string $service, string $table) : array<string|int, mixed>

La meta concernant les informations de chargement de chaque table est aussi effacée.

Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

$service : string

Identifiant du service.

$table : string

Nom de la table sans le préfixe spip_.

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

Tableau associatif résultat de l'action de déchargement:

  • erreur : identifiant de l'erreur, à savoir, ok, nok ou sha.
  • type : type de service.
  • service : identifiant du service.
  • table : nom de la table sans le préfixe spip_.

isocode_lister_types_service()

Retourne la liste des services disponibles pour le chargement des tables de nomenclatures.

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

La fonction lit les sous-répertoires du répertoire services/ du plugin dont le nom correspond au type de service.

Return values
array<string|int, mixed> —

La liste des services disponibles ou tableau vide si aucun service n'est détecté.

isocode_lister_services()

Retourne la liste des services disponibles pour un type de service donné.

isocode_lister_services(string $type) : array<string|int, mixed>
Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

Return values
array<string|int, mixed> —

La liste des services disponibles ou tableau vide aucun service n'est détecté.

isocode_lister_tables()

Retourne la liste de toutes les tables gérées par un type de service donné.

isocode_lister_tables(string $type[, null|bool $avec_groupes = false ]) : array<string|int, mixed>

Il est possible, pour le type de service nomenclature de demander le regourpement des tables selon une logique de groupe définie dans la configuration (affichage uniquement).

Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

$avec_groupes : null|bool = false

Indique si la liste des tables doit être regroupée par groupe.

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

Liste des tables sans le préfixe spip_.

isocode_trouver_service()

Détermine le ou les services associés au chargement de la table choisie.

isocode_trouver_service(string $type, string $table) : array<string|int, mixed>
Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

$table : string

Nom d'une table sans le préfixe spip_.

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

Le ou les services associés à la table fournie suivant le type de service.

  • nomenclature : tableau du service unique permettant le chargement de la table ou tableau vide.
  • geometrie : tableau des services permettant le chargement de la table ou tableau vide.
  • infrasubdivision : tableau des services permettant le chargement de la table ou tableau vide.

isocode_trouver_table()

Détermine la ou les tables pouvant être peuplées par un service.

isocode_trouver_table(string $type, string $service) : array<string|int, mixed>
Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

$service : string

Identifiant du service.

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

Le ou les tables associées au service fourni suivant le type de service.

  • nomenclature : tableau des services permettant le chargement de la table ou tableau vide.
  • geometrie : tableau du service unique permettant le chargement de la table ou tableau vide.
  • infrasubdivision : tableau du service unique permettant le chargement de la table ou tableau vide.

isocode_crediter()

Renvoie la configuration des crédits d'un service.

isocode_crediter(string $type, string $service[, null|string $table = '' ]) : array<string|int, mixed>
Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

$service : string

Identifiant du service.

$table : null|string = ''

Nom de la table sans le préfixe spip_.

Return values
array<string|int, mixed> —

Tableau des données de crédits.

isocode_lire_consignation()

Indique si une table est déjà chargée ou pas en base de données.

isocode_lire_consignation(string $type, string $service, string $table) : array<string|int, mixed>

La fonction scrute la table spip_${table} et non la meta propre à la table.

Parameters
$type : string

Type de service. Prend les valeurs nomenclature, infra_subdivision ou geometrie.

$service : string

Identifiant du service.

$table : string

Nom de la table sans le préfixe spip_.

Return values
array<string|int, mixed> —

Tableau de la meta de consignation.

Search results