Territoires

UI

Functions

formulaires_editer_territoire_identifier_dist() : string: Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité.
formulaires_editer_territoire_charger_dist() : array<string|int, mixed>: Chargement du formulaire d'édition de territoire.
formulaires_editer_territoire_verifier_dist() : array<string|int, mixed>: Vérifications du formulaire d'édition de territoire.
formulaires_editer_territoire_traiter_dist() : array<string|int, mixed>: Traitement du formulaire d'édition de territoire.
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.
territoire_extra_afficher_valeur() : mixed: Formate la valeur d'un extra en fonction de sa nature.
territoire_extra_afficher_unite() : string: Détermine l'unité d'un extra en fonction de sa nature.

formulaires_editer_territoire_identifier_dist()

Identifier le formulaire en faisant abstraction des paramètres qui ne représentent pas l'objet edité.


    
                    formulaires_editer_territoire_identifier_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ][, int $lier_trad = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : string

Parameters

$id_territoire : int|string = 'new': Identifiant du territoire. 'new' pour un nouveau territoire.
$retour : string = '': URL de redirection après le traitement
$associer_objet : string = '': Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3
$lier_trad : int = 0: Identifiant éventuel d'un territoire source d'une traduction
$config_fonc : string = '': Nom de la fonction ajoutant des configurations particulières au formulaire
$row : array<string|int, mixed> = []: Valeurs de la ligne SQL du territoire, si connu
$hidden : string = '': Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values

string —

Hash du formulaire

formulaires_editer_territoire_charger_dist()

Chargement du formulaire d'édition de territoire.


    
                    formulaires_editer_territoire_charger_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ][, int $lier_trad = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>

Déclarer les champs postés et y intégrer les valeurs par défaut

Parameters

$id_territoire : int|string = 'new': Identifiant du territoire. 'new' pour un nouveau territoire.
$retour : string = '': URL de redirection après le traitement
$associer_objet : string = '': Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3
$lier_trad : int = 0: Identifiant éventuel d'un territoire source d'une traduction
$config_fonc : string = '': Nom de la fonction ajoutant des configurations particulières au formulaire
$row : array<string|int, mixed> = []: Valeurs de la ligne SQL du territoire, si connu
$hidden : string = '': Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values

array<string|int, mixed> —

Environnement du formulaire

formulaires_editer_territoire_verifier_dist()

Vérifications du formulaire d'édition de territoire.


    
                    formulaires_editer_territoire_verifier_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ][, int $lier_trad = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>

Vérifier les champs postés et signaler d'éventuelles erreurs

Parameters

$id_territoire : int|string = 'new': Identifiant du territoire. 'new' pour un nouveau territoire.
$retour : string = '': URL de redirection après le traitement
$associer_objet : string = '': Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3
$lier_trad : int = 0: Identifiant éventuel d'un territoire source d'une traduction
$config_fonc : string = '': Nom de la fonction ajoutant des configurations particulières au formulaire
$row : array<string|int, mixed> = []: Valeurs de la ligne SQL du territoire, si connu
$hidden : string = '': Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values

array<string|int, mixed> —

Tableau des erreurs

formulaires_editer_territoire_traiter_dist()

Traitement du formulaire d'édition de territoire.


    
                    formulaires_editer_territoire_traiter_dist([int|string $id_territoire = 'new' ][, string $retour = '' ][, string $associer_objet = '' ][, int $lier_trad = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, string $hidden = '' ]) : array<string|int, mixed>

Traiter les champs postés

Parameters

$id_territoire : int|string = 'new': Identifiant du territoire. 'new' pour un nouveau territoire.
$retour : string = '': URL de redirection après le traitement
$associer_objet : string = '': Éventuel objet|x indiquant de lier le territoire créé à cet objet, tel que article|3
$lier_trad : int = 0: Identifiant éventuel d'un territoire source d'une traduction
$config_fonc : string = '': Nom de la fonction ajoutant des configurations particulières au formulaire
$row : array<string|int, mixed> = []: Valeurs de la ligne SQL du territoire, si connu
$hidden : string = '': Contenu HTML ajouté en même temps que les champs cachés du formulaire.

Return values

array<string|int, mixed> —

Retours des traitements

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.

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.

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

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.

territoire_extra_afficher_valeur()

Formate la valeur d'un extra en fonction de sa nature.


    
                    territoire_extra_afficher_valeur(string $extra, mixed $valeur, string $type_extra) : mixed

Parameters

$extra : string: La nature de l'extra.
$valeur : mixed: La valeur de l'extra.
$type_extra : string: Le type d'extra, à savoir, info ou code.

Return values

mixed —

Valeur de l'extra formatée.

territoire_extra_afficher_unite()

Détermine l'unité d'un extra en fonction de sa nature.


    
                    territoire_extra_afficher_unite(string $extra, string $type_extra) : string

Parameters

$extra : string: La nature de l'extra.
$type_extra : string: Le type d'extra, à savoir, info ou code.

Return values

string —

Unité de l'extra ou vide sinon aucune.

UI

Table of Contents

Functions

Functions

formulaires_editer_territoire_identifier_dist()

Parameters

Return values

formulaires_editer_territoire_charger_dist()

Parameters

Tags

Return values

formulaires_editer_territoire_verifier_dist()

Parameters

Tags

Return values

formulaires_editer_territoire_traiter_dist()

Parameters

Tags

Return values

formulaires_peupler_territoires_charger()

Parameters

Tags

Return values

formulaires_peupler_territoires_verifier()

Parameters

Return values

formulaires_peupler_territoires_traiter()

Parameters

Tags

Return values

peupler_territoires_notifier()

Parameters

Tags

Return values

territoire_extra_afficher_valeur()

Parameters

Return values

territoire_extra_afficher_unite()

Parameters

Return values