Documentation du code de SPIP et de ses plugins

Nomenclatures officielles

isocode_peupler.php

Gestion du formulaire de chargement ou de vidage des tables de codes ISO.

Table of Contents

formulaires_isocode_peupler_charger()  : array<string|int, mixed>
Chargement des données : le formulaire propose les actions possibles sur les tables de codes ISO, à savoir, charger ou vider et la liste des tables regroupées par service.
formulaires_isocode_peupler_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir une action (`decharger` ou `charger`) et une table.
formulaires_isocode_peupler_traiter()  : array<string|int, mixed>
Exécution du formulaire : les tables choisies sont soit vidées, soit chargées.
isocode_peupler_notifier()  : array<string|int, mixed>
Formate les messages de succès et d'erreur résultant des actions de chargement ou de vidage des tables de codes ISO.

Functions

formulaires_isocode_peupler_charger()

Chargement des données : le formulaire propose les actions possibles sur les tables de codes ISO, à savoir, charger ou vider et la liste des tables regroupées par service.

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

L'action vider s'appelle décharger car il existe dékà une fonction d'administration de vidage des tables.

Parameters
$type : string

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

Return values
array<string|int, mixed>

Tableau des données à charger par le formulaire (affichage). Aucune donnée chargée n'est un champ de saisie, celle-ci sont systématiquement remises à zéro.

  • _actions_tables : (affichage) alias et libellés des actions possibles sur une table, charger et decharger
  • _actions_disable : (affichage) liste des actions désactivées (decharger si aucune table n`est chargée)
  • _action_defaut : (affichage) action sélectionnée par défaut, charger
  • _tables : (affichage) noms des tables sans le préfixe spip_

formulaires_isocode_peupler_verifier()

Vérification des saisies : il est indispensable de choisir une action (`decharger` ou `charger`) et une table.

formulaires_isocode_peupler_verifier(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>

Tableau des erreurs sur l'action et/ou la table ou tableau vide si aucune erreur.

formulaires_isocode_peupler_traiter()

Exécution du formulaire : les tables choisies sont soit vidées, soit chargées.

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

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

Tags
uses
isocode_charger_tables()
uses
isocode_decharger_tables()
uses
formater_message()
Return values
array<string|int, mixed>

Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.

isocode_peupler_notifier()

Formate les messages de succès et d'erreur résultant des actions de chargement ou de vidage des tables de codes ISO.

isocode_peupler_notifier(string $type, string $action, array<string|int, mixed> $statuts) : array<string|int, mixed>
Parameters
$type : string

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

$action : string

Action venant d'être appliquée à certaines tables. Peut prendre les valeurs charger et decharger.

$statuts : array<string|int, mixed>

Tableau résultant de l'action sur les tables choisies:

  • 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_.
Return values
array<string|int, mixed>

Tableau des messages à afficher sur le formulaire:

  • message_ok : message sur les tables ayant été traitées avec succès ou tableau vide sinon.
  • message_erreur : message sur les tables en erreur ou tableau vide sinon.

Search results