SPIP Code

Documentation du code de SPIP et de ses plugins

Territoires

peupler_territoires.php

Gestion du formulaire de chargement ou de vidage des unités de peuplement de territoires.

Table of Contents

Functions

formulaires_peupler_territoires_charger()  : array<string|int, mixed>
Chargement des données : le formulaire propose les actions possibles sur les territoires, à savoir, charger ou vider.
formulaires_peupler_territoires_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir une action (`charger` ou `vider`) et au moins un ensemble de territoire.
formulaires_peupler_territoires_traiter()  : array<string|int, mixed>
Exécution du formulaire : les territoires choisis sont soit vidés, soit chargés.
peupler_territoires_notifier()  : array<string|int, mixed>
Formate les messages de succès et d'erreur résultant des actions de chargement ou de vidage des territoires.

Functions

formulaires_peupler_territoires_charger()

Chargement des données : le formulaire propose les actions possibles sur les territoires, à savoir, charger ou vider.

formulaires_peupler_territoires_charger(string $groupe) : array<string|int, mixed>
Parameters
$groupe : string

Groupe de peuplement : représente les types de territoires à présenter dans un même formulaire.

Tags
uses
unite_peuplement_serveur_est_compatible()
uses
unite_peuplement_informer_feeds()
uses
territoire_repertorier()
uses
unite_peuplement_est_chargee()
uses
unite_peuplement_est_obsolete()
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_territoire: (affichage) alias et libellés des actions possibles, charger et vider
  • _actions_disable : (affichage) liste des actions désactivées (vider si aucun pays n`est chargé)
  • _action_defaut : (affichage) action sélectionnée par défaut, charger
  • _donnees : (affichage) liste des ensembles de territoires pouvant être chargés.
  • _explication_infra : (affichage) explication sur les infrasubdivisions.
  • _classe_conteneur : (affichage) classe pour forcer un conteneur flex pour les checkbox.
  • _max_choix : (affichage) limiter le nombre de choix à 1 pour les infrasubdivisions.

formulaires_peupler_territoires_verifier()

Vérification des saisies : il est indispensable de choisir une action (`charger` ou `vider`) et au moins un ensemble de territoire.

formulaires_peupler_territoires_verifier(string $groupe) : array<string|int, mixed>
Parameters
$groupe : string

Groupe de peuplement : représente les types de territoires à présenter dans un même formulaire.

Return values
array<string|int, mixed> —

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

formulaires_peupler_territoires_traiter()

Exécution du formulaire : les territoires choisis sont soit vidés, soit chargés.

formulaires_peupler_territoires_traiter(string $groupe) : array<string|int, mixed>
Parameters
$groupe : string

Groupe de peuplement : représente les types de territoires à présenter dans un même formulaire.

Tags
uses
unite_peuplement_charger()
uses
unite_peuplement_vider()
uses
peupler_territoires_notifier()
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.

peupler_territoires_notifier()

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

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

Type de territoire.

$messages : array<string|int, mixed>

Tableau des messages ok et nok à compléter.

$action : string

Action venant d'être appliquée à certains pays. Peut prendre les valeurs peupler et depeupler.

$statuts : array<string|int, mixed>

Tableau résultant de l'action sur le type choisi. Peut-êre un tableau de statut pour les subdivisions (plusieurs pays).

  • ok : true si l'action ou la lancement du job a complètement réussi, false sinon (au moins une erreur).
  • sha : indique une sha identique donc pas chargement effectué.
  • arg : indique que le couple (type, pays) eest invalide (pas possible avec le formulaire).
  • type : type de territoire.
  • pays : code ISO alpha2 du pays si le type est subdivision.
  • sync : indique si le peuplement est synchrone ou asynchrone
  • job : id du job si asynchrone
Tags
used-by
formulaires_peupler_territoires_traiter()
Return values
array<string|int, mixed> —

Tableau des messages à afficher sur le formulaire:

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

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results