SPIP Code

Documentation du code de SPIP et de ses plugins

Contours des territoires

OBJET

Table of Contents

Functions

formulaires_peupler_contours_charger()  : array<string|int, mixed>
Chargement des données : le formulaire propose les actions possibles sur les tables de contours, à savoir, charger ou vider et la liste des tables regroupées par service.
formulaires_peupler_contours_verifier()  : array<string|int, mixed>
Vérification des saisies : il est indispensable de choisir une action (`retirer` ou `ajouter`) et un pays.
formulaires_peupler_contours_traiter()  : array<string|int, mixed>
Exécution du formulaire : les pays choisis sont soit vidés, soit chargés.
formulaires_peupler_contours_notifier()  : array<string|int, mixed>
Formate les messages de succès et d'erreur résultant des actions de chargement ou de vidage des contours.

Functions

formulaires_peupler_contours_charger()

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

formulaires_peupler_contours_charger(string $groupe) : 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
$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
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_contour: (affichage) alias et libellés des actions possibles, peupler et depeupler
  • _actions_disable : (affichage) liste des actions désactivées (depeupler si aucun pays n`est chargé)
  • _action_defaut : (affichage) action sélectionnée par défaut, peupler
  • _contours : (affichage) la liste des services de géométrie disponibles.
  • _max_choix : (affichage) nombre maximum de choix.

formulaires_peupler_contours_verifier()

Vérification des saisies : il est indispensable de choisir une action (`retirer` ou `ajouter`) et un pays.

formulaires_peupler_contours_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_contours_traiter()

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

formulaires_peupler_contours_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_contour_charger()
uses
unite_peuplement_contour_vider()
uses
formulaires_peupler_contours_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.

formulaires_peupler_contours_notifier()

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

formulaires_peupler_contours_notifier(string $action, array<string|int, mixed> $statuts) : array<string|int, mixed>
Parameters
$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 les tables choisies:

  • ok : true si le vidage a réussi, false sinon.
  • nok : liste des pays en erreur ou tableau vide sinon.
  • sha : liste des pays inchangés (SHA identique) ou tableau vide sinon. Uniquement disponible pour l'action peupler.
Tags
used-by
formulaires_peupler_contours_traiter()
Return values
array<string|int, mixed> —

Tableau des messages à afficher sur le formulaire:

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

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results