Territoires

API Documentation

Constants

_EXTRAIRE_MULTI = '@<multi>(.*?)</multi>@sS': Restaure cette constante à partir de SPIP 4.2.
_TERRITOIRES_COEFF_MAX_DISTANT = 8: Coefficient multiplicateur de la constante SPIP `_INC_DISTANT_MAX_SIZE` permettant de calculer la taille max d'une réponse à `recuperer_url()` si aucune taille n'est précisée dans l'appel.
_TERRITOIRES_COMPATIBILITE_ISOCODE = ['vmin' => '2.0.1']: Endpoint de l'API REST hébergeant les données de Nomenclatures.
_TERRITOIRES_TIME_OUT_PEUPLEMENT = 20: Time-out par défaut du traitement de peuplement asynchrone.
_TERRITOIRES_URL_BASE_ISOCODE = 'https://contrib.spip.net/http.api/ezrest': Endpoint de l'API REST hébergeant les données de Nomenclatures.

Functions

action_peupler_territoires_dist() : void: Cette action permet peupler certains ensembles de territoires contenant un nombre important d'éléments.
action_recharger_config_territoires_dist() : void: Cette action permet à l'utilisateur de recharger en meta, de façon sécurisée, la configuration statique du plugin.
territoires_declarer_tables_interfaces() : array<string|int, mixed>: Déclaration des alias de tables et filtres automatiques de champs.
territoires_declarer_tables_objets_sql() : array<string|int, mixed>: Déclaration des objets éditoriaux.
territoires_declarer_tables_auxiliaires() : array<string|int, mixed>: Déclaration des tables secondaires (liaisons).
territoires_cache_configurer() : array<string, mixed>: Renvoie la configuration spécifique des caches de Rainette.
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.
inc_requeter_isocode_dist() : array<string|int, mixed>: Renvoie, à partir de l'url du service, le tableau des données demandées.
territoire_repertorier() : array<string|int, mixed>: Renvoie, une liste de descriptions de territoires éventuellement filtrée sur certains champs.
territoire_lire_ascendance() : array<string|int, mixed>: Fournit l'ascendance géographique d'un territoire, par consultation dans la base de données.
territoire_lire_extras() : array<string|int, mixed>|string: Fournit, pour un territoire donné, tout ou partie des informations extras disponibles dans la table spip_territoires_extras.
unite_peuplement_charger() : array<string|int, mixed>: Peuple soit les régions du monde, soit les pays ou soit les subdivisions, au sens large, d'un pays.
unite_peuplement_charger_asynchrone() : array<string|int, mixed>: Appelle la fonction de peuplement de territoires en asynchrone.
unite_peuplement_vider() : array<string|int, mixed>: Supprime de la base soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.
unite_peuplement_extra_est_charge() : bool: Teste si les codes alternatifs ou les caractéristiques additionnelles d’un type de territoire sont chargées en base.
unite_peuplement_serveur_est_compatible() : bool: Vérifie si le serveur configuré pour récupérer les informations sur les territoires est compatible avec le plugin utilisateur passé en argument.
unite_peuplement_est_chargee() : string: Teste, pour un plugin utilisateur donné, si une unité de peuplement est chargée en base.
unite_peuplement_est_obsolete() : bool: Teste, pour un plugin utilisateur donné, si une unité de peuplement chargée est obsolète.
unite_peuplement_consigne_identifier() : string: Identifie la variable de consignation d'un peuplement.
unite_peuplement_acquerir() : array<string|int, mixed>: Acquiert les données de territoires disponibles dans Nomenclatures.
unite_peuplement_informer_feeds() : array<string|int, mixed>: Liste les feeds fournissant des nomenclatures de territoires pour l'unité de peuplement requise.
unite_peuplement_retablir_liens() : void: Rétablit les liens d'un type d'objet avec les territoires peuplés ou repeuplés.
territoires_serveur_definir_compatibilite() : array<string|int, mixed>: Renvoie, pour le plugin appelant, les bornes de compatibilité avec le serveur fournissant une nature d'informations donnée sur les territoires.
territoires_configuration_recharger() : void: Recharge la configuration du plugin.
territoires_feed_initialiser_url_base() : string: Renvoie l'URL de base du serveur Nomenclatures fournissant des informations sur les territoires.
territoires_feed_categorie_lister() : array<string|int, mixed>: Renvoie la liste des catégories de feed de Nomenclatures correspondant à la nature des informations demandées.
territoires_feed_indexer_hash() : string: Renvoie, pour la collection `feeds`, l'index du hash permettant de savoir si le ou les feeds récupérés sont obsolètes.
territoires_feed_acquerir() : array<string|int, mixed>: Liste les feeds fournissant des informations de territoires d'une nature donnée exprimée sous la forme de catégories.
territoires_unite_peuplement_definir_collection() : string: Renvoie la collection de Nomenclatures à requêter en fonction de l’unité de peuplement concernée.
territoires_unite_peuplement_definir_filtre() : array<string|int, mixed>: Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction de l’unité de peuplement voire du service concerné.
territoires_upgrade() : void: Fonction d'installation et de mise à jour du plugin Territoires.
territoires_vider_tables() : void: Fonction de désinstallation du plugin Territoires.
territoires_configurer() : array<string|int, mixed>: Renvoie la configuration du plugin, soit statique (non modifiable), soit utilisateur (modifiable).
territoires_adapter_config_statique() : void: Fonction de mise à jour de la config statique du plugin.
territoires_chargement_initial() : void: Lance le chargement initial des unités de peuplement des régions du monde, des pays et des subdivisions et des infra-subbdivisions françaises.
territoires_maj_8_meta_peuplement() : void: Transfert de la meta de peuplement vers n metas, une par type.
territoires_maj_9_unite() : void: Prise en compte des nouveaux paramètres pour les unités.
territoires_maj_12_info() : void: Prise en compte des nouveaux paramètres pour les unités.
territoires_autoriser() : mixed: Fonction d'appel pour le pipeline.
autoriser_territoires_voir_dist() : bool: Autorisation de voir la liste des territoires (page territoires).
autoriser_territoires_menu_dist() : bool: Autorisation de voir l'élément de menu menant à la page des territoires.
autoriser_territoires_configurer_dist() : bool: Autorisation de configurer le plugin (page configurer_territoires).
autoriser_territoires_peupler_dist() : bool: Autorisation de peupler ou dépeupler des territoires.
autoriser_territoire_voir_dist() : bool: Autorisation de voir (territoire).
autoriser_territoire_creer_dist() : bool: Autorisation de créer un territoire.
autoriser_territoire_modifier_dist() : bool: Autorisation de modifier un territoire.
autoriser_territoire_supprimer_dist() : bool: Autorisation de supprimer un territoire.
autoriser_associerterritoires_dist() : bool: Autorisation de lier/délier un territoire.
balise_TERRITOIRE_ASCENDANCE_dist() : Champ: Compile la balise `#TERRITOIRE_ASCENDANCE` qui renvoie l'ascendance d'un territoire donné désigne par son identifiant primaire.
balise_TERRITOIRE_EXTRAS_dist() : Champ: Compile la balise `#TERRITOIRE_EXTRAS` qui renvoie tout ou partie des informations extras d'un territoire donné désigne par son identifiant primaire.
territoires_affiche_milieu() : array<string|int, mixed>: Ajout de contenu sur certaines pages, notamment des formulaires de liaisons entre objets.
territoires_affiche_gauche() : array<string|int, mixed>: Ajout de contenu dans la colonne « gauche » des pages de l’espace privé, notamment « la fiche objet » Territoires ajoute le bloc des codes alternatifs.
territoires_exclure_id_conditionnel() : array<string|int, mixed>: Enlever l'id_territoire de la liste des critères conditionnels pour la table `spip_territoires` car cela peut renvoyer une liste vide si l'env contient déjà l'id du territoire.
territoires_pre_edition() : array<string|int, mixed>: Complète l'action `modifier` d'un territoire avant modification: - en positionnant l'indicateur d'édition à `oui`afin que les modifications manuelles soient préservées lors d'un prochain rechargement.
territoires_optimiser_base_disparus() : array<string|int, mixed>: Optimiser la base de données Supprime les liens orphelins de l'objet vers quelqu'un et de quelqu'un vers l'objet.

_EXTRAIRE_MULTI

Restaure cette constante à partir de SPIP 4.2.


    public
        mixed
    _EXTRAIRE_MULTI
    = '@<multi>(.*?)</multi>@sS'

_TERRITOIRES_COEFF_MAX_DISTANT

Coefficient multiplicateur de la constante SPIP `_INC_DISTANT_MAX_SIZE` permettant de calculer la taille max d'une réponse à `recuperer_url()` si aucune taille n'est précisée dans l'appel.


    public
        mixed
    _TERRITOIRES_COEFF_MAX_DISTANT
    = 8

_TERRITOIRES_COMPATIBILITE_ISOCODE

Endpoint de l'API REST hébergeant les données de Nomenclatures.


    public
        mixed
    _TERRITOIRES_COMPATIBILITE_ISOCODE
    = ['vmin' => '2.0.1']

_TERRITOIRES_TIME_OUT_PEUPLEMENT

Time-out par défaut du traitement de peuplement asynchrone.


    public
        mixed
    _TERRITOIRES_TIME_OUT_PEUPLEMENT
    = 20

_TERRITOIRES_URL_BASE_ISOCODE

Endpoint de l'API REST hébergeant les données de Nomenclatures.


    public
        mixed
    _TERRITOIRES_URL_BASE_ISOCODE
    = 'https://contrib.spip.net/http.api/ezrest'

action_peupler_territoires_dist()

Cette action permet peupler certains ensembles de territoires contenant un nombre important d'éléments.


    
                    action_peupler_territoires_dist() : void

Elle est appelée par l'API unite_peuplement_charger_asynchrone().

Elle nécessite les mêmes arguments que la fonction de peuplement.

action_recharger_config_territoires_dist()

Cette action permet à l'utilisateur de recharger en meta, de façon sécurisée, la configuration statique du plugin.


    
                    action_recharger_config_territoires_dist() : void

Cette action est réservée aux utilisateurs pouvant configurer le plugin Elle ne nécessite aucun argument.

territoires_declarer_tables_interfaces()

Déclaration des alias de tables et filtres automatiques de champs.


    
                    territoires_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>

Parameters

$interfaces : array<string|int, mixed>: Déclarations d'interface pour le compilateur

Return values

array<string|int, mixed> —

Déclarations d'interface mis à jour

territoires_declarer_tables_objets_sql()

Déclaration des objets éditoriaux.


    
                    territoires_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>

Le plugin Territoires déclare 1 nouvelle table objet, spip_territoires.

Parameters

$tables : array<string|int, mixed>: Description des tables d'objet

Return values

array<string|int, mixed> —

Description complétée des tables d'objet

territoires_declarer_tables_auxiliaires()

Déclaration des tables secondaires (liaisons).


    
                    territoires_declarer_tables_auxiliaires(array<string|int, mixed> $tables) : array<string|int, mixed>

Le plugin Territoires déclare 2 nouvelle tables auxilliaire:

celle des liens, spip_territoires_liens
celle des caractéristiques complémentaires, spip_territoires_extras.

Parameters

$tables : array<string|int, mixed>: Description des tables auxilliaires

Return values

array<string|int, mixed> —

Description complétée des tables auxilliaires

territoires_cache_configurer()

Renvoie la configuration spécifique des caches de Rainette.


    
                    territoires_cache_configurer(string $plugin) : array<string, mixed>

Parameters

$plugin : string: Préfixe du plugin, à savoir, territoires.

Return values

array<string, mixed> —

Tableau de la configuration brute du plugin Territoires

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
_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) est 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.

inc_requeter_isocode_dist()

Renvoie, à partir de l'url du service, le tableau des données demandées.


    
                    inc_requeter_isocode_dist(string $url_base[, null|string $collection = '' ][, null|array<string|int, mixed> $filtres = [] ][, null|int $taille_max = 0 ]) : array<string|int, mixed>

Le service utilise dans ce cas une chaine JSON qui est décodée pour fournir le tableau de sortie. Le flux retourné par le service est systématiquement transcodé dans le charset du site avant d'être décodé.

Parameters

$url_base : string: Endpoint du serveur
$collection : null|string = '': Nom de la collection ou vide si on veut récupérer l'index des collections du serveur.
$filtres : null|array<string|int, mixed> = []: Tableau des filtres à appliquer à la collection
$taille_max : null|int = 0: Taille maximale du flux récupéré suite à la requête. La valeur entière 0 désigne la taille par défaut.

Return values

array<string|int, mixed> —

Tableau de la réponse. Si l'index erreur['status'] indique le statut de la réponse. La valeur 200 permet de tester une requête réussie et dans ce cas l'index page du flux reçu est retourné après décodage JSON.

territoire_repertorier()

Renvoie, une liste de descriptions de territoires éventuellement filtrée sur certains champs.


    
                    territoire_repertorier([null|array<string|int, mixed> $filtres = [] ]) : array<string|int, mixed>

Parameters

$filtres : null|array<string|int, mixed> = []: Tableau associatif [champ] = valeur de critères de filtres sur les descriptions de feed. Les opérateurs possibles sont l'égalité, l'appartenance et leurs négation.

Return values

array<string|int, mixed> —

Tableau des descriptions des feeds indexé par l'id du feed ou tableau vide sinon.

territoire_lire_ascendance()

Fournit l'ascendance géographique d'un territoire, par consultation dans la base de données.


    
                    territoire_lire_ascendance(string $iso_territoire[, null|string $iso_parent = null ][, null|string $ordre = 'descendant' ]) : array<string|int, mixed>

Parameters

$iso_territoire : string: Code ISO principal du territoire
$iso_parent : null|string = null: Code ISO principal du parent direct du territoire concerné ou chaine vide sinon
$ordre : null|string = 'descendant': Classement de la liste : descendant(défaut) ou ascendant.

Return values

array<string|int, mixed> —

Liste des territoires ascendants.

territoire_lire_extras()

Fournit, pour un territoire donné, tout ou partie des informations extras disponibles dans la table spip_territoires_extras.


    
                    territoire_lire_extras(string $iso_territoire[, null|string $information = '' ]) : array<string|int, mixed>|string

Cette fonction ne renvoie pas les champs du territoire lui-même (table spip_territoires).

Parameters

$iso_territoire : string: Code ISO principal du territoire
$information : null|string = '': Type d'information à renvoyer depuis la table spip_territoires_extras ou vide si on veut toutes les informations.

Return values

array<string|int, mixed>|string —

Information ou liste des informations.

unite_peuplement_charger()

Peuple soit les régions du monde, soit les pays ou soit les subdivisions, au sens large, d'un pays.


    
                    unite_peuplement_charger(string $type, null|string $pays[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

La fonction utilise les données fournies par Nomenclatures.

Parameters

$type : string

Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.

$pays : null|string

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.

$options : null|array<string|int, mixed> = []

Tableau des options de peuplement:

force : si true force le repeuplement même si le sha est identique (false par défaut).
extras: tableau des types d'extras à peupler soit code pour les codes alternatifs mais d'autres valeurs sont possibles (plugins complémentaires)

Return values

array<string|int, mixed> —

Tableau retour de la fonction permettant de connaitre le résultat du traitement (utile pour l'affichage du message dans le formulaire de peuplement).

unite_peuplement_charger_asynchrone()

Appelle la fonction de peuplement de territoires en asynchrone.


    
                    unite_peuplement_charger_asynchrone(string $type, string $pays[, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

$type : string

Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.

$pays : string

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.

$options : null|array<string|int, mixed> = []

Tableau des options de peuplement:

force : si true force le repeuplement même si le sha est identique (false par défaut).
extras: tableau des types d'extras à peupler soit code pour les codes alternatifs mais d'autres valeurs sont possibles (plugins complémentaires)

Return values

array<string|int, mixed> —

Tableau retour de la fonction permettant de connaitre le résultat du traitement (utile pour l'affichage du message dans le formulaire de peuplement).

unite_peuplement_vider()

Supprime de la base soit les régions du monde, soit les pays ou soit les subdivisions d'un pays.


    
                    unite_peuplement_vider(string $type[, null|string $pays = '' ][, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

$type : string

Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.

$pays : null|string = ''

Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.

$options : null|array<string|int, mixed> = []

Tableau des options de dépeuplement:

force : si true force le vidage même si la meta n'est pas présente (cas d'erreur sur timeout par exemple). La valeur par défaut est false.

Return values

array<string|int, mixed> —

Tableau retour de la fonction permettant de connaitre le résultat du traitement (utile pour l'affichage du message dans le formulaire de peuplement).

unite_peuplement_extra_est_charge()

Teste si les codes alternatifs ou les caractéristiques additionnelles d’un type de territoire sont chargées en base.


    
                    unite_peuplement_extra_est_charge(string $type, string $pays, string $type_extra) : bool

La fonction lit la meta de chargement et non la table spip_territoires_extras.

Parameters

$type : string: Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.
$pays : string: Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$type_extra : string: Type d'extra. Prends la valeur code uniquement pour Territoires mais d'autres valeurs possibles via des plugins complémentaires.

Return values

bool —

true si le territoire est chargé, false sinon.

unite_peuplement_serveur_est_compatible()

Vérifie si le serveur configuré pour récupérer les informations sur les territoires est compatible avec le plugin utilisateur passé en argument.


    
                    unite_peuplement_serveur_est_compatible(string $plugin) : bool

Parameters

$plugin : string: Préfixe du plugin appelant.

Return values

bool —

true si le serveur est compatible avec la version du plugin appelant ou false sinon.

unite_peuplement_est_chargee()

Teste, pour un plugin utilisateur donné, si une unité de peuplement est chargée en base.


    
                    unite_peuplement_est_chargee(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : string

Cette fonction lit la consignation en meta et non la table spip_territoires.

Est utilisable pour la nomenclature des territoires et les contours.

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.

Return values

string

unite_peuplement_est_obsolete()

Teste, pour un plugin utilisateur donné, si une unité de peuplement chargée est obsolète.


    
                    unite_peuplement_est_obsolete(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ][, null|array<string|int, mixed> $feeds = [] ]) : bool

Cette fonction lit le sha de la consignation en meta et le compare au hash du feed correspondant sur le serveur configuré.

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.
$feeds : null|array<string|int, mixed> = []: Liste des feeds disponibles pour le type donné.

Return values

bool —

true si le sha passé en argument est identique au sha stocké pour la table choisie, false sinon.

unite_peuplement_consigne_identifier()

Identifie la variable de consignation d'un peuplement.


    
                    unite_peuplement_consigne_identifier(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : string

Est utilisable pour la nomenclature des territoires et les contours.

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.

Return values

string

unite_peuplement_acquerir()

Acquiert les données de territoires disponibles dans Nomenclatures.


    
                    unite_peuplement_acquerir(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ][, null|array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

La fonction utilise l'API REST de Nomenclatures.

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.
$options : null|array<string|int, mixed> = []: L'option cacher_synchrone à true permet d'utiliser un cache pour limiter les requêtes au serveur et accélérer la fourniture des données. L'option cacher_asynchrone à true permet de mettre la collection récupérée dans un cache temporaire pour être utilisée lors des itérations en mode asynchrone dans une fonction idoine.

Return values

array<string|int, mixed> —

Liste des données de territoires telles que fournies par l'API REST

unite_peuplement_informer_feeds()

Liste les feeds fournissant des nomenclatures de territoires pour l'unité de peuplement requise.


    
                    unite_peuplement_informer_feeds(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ][, null|string $information = '' ]) : array<string|int, mixed>

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer
$information : null|string = '': Information précise à renvoyer seule ou tout si vide. Les valeurs possibles sont feed, pays, hash ou credit.

Return values

array<string|int, mixed> —

Liste des feeds.

unite_peuplement_retablir_liens()

Rétablit les liens d'un type d'objet avec les territoires peuplés ou repeuplés.


    
                    unite_peuplement_retablir_liens(string $type_lien, array<string|int, mixed> $sauvegardes, array<string|int, mixed> $ids_crees, array<string|int, mixed> $config_lien) : void

Parameters

$type_lien : string

Type de liens à restaurer : liens, logos ou autre.

$sauvegardes : array<string|int, mixed>

Tableau des sauvegardes dans lequel puiser les liens existants

$ids_crees : array<string|int, mixed>

Tableau des nouveaux id des territoires.

$config_lien : array<string|int, mixed>

Tableau de configuration de la table de liens concernée composé des index:

table : nom complet de la table spip
id_table : nom du champ id du territoire

territoires_serveur_definir_compatibilite()

Renvoie, pour le plugin appelant, les bornes de compatibilité avec le serveur fournissant une nature d'informations donnée sur les territoires.


    
                    territoires_serveur_definir_compatibilite(string $plugin) : array<string|int, mixed>

En fait, la nature d'information est liée au plugin appelant (nomenclatures pour Territoires, contours géographiques pour le plugin Contours de territoires, etc.).

Parameters

$plugin : string: Préfixe du plugin appelant.

Return values

array<string|int, mixed> —

Bornes de compatibilité avec le serveur.

territoires_configuration_recharger()

Recharge la configuration du plugin.


    
                    territoires_configuration_recharger(string $plugin) : void

Le service appelle un pipeline homonyme permettant de prolonger l'action au-delà du plugin utilisateur.

Le plugin Territoires recharge sa propre configuration statique.

Parameters

$plugin : string: Préfixe du plugin utilisateur

territoires_feed_initialiser_url_base()

Renvoie l'URL de base du serveur Nomenclatures fournissant des informations sur les territoires.


    
                    territoires_feed_initialiser_url_base(string $plugin) : string

Parameters

$plugin : string: Préfixe du plugin appelant.

Return values

string —

URL de base du serveur REST

territoires_feed_categorie_lister()

Renvoie la liste des catégories de feed de Nomenclatures correspondant à la nature des informations demandées.


    
                    territoires_feed_categorie_lister(string $plugin) : array<string|int, mixed>

Pour Territoires, la nomenclature est fournie au travers de la catégorie de feed nommée territory.

Parameters

$plugin : string: Préfixe du plugin appelant.

Return values

array<string|int, mixed> —

Liste des catégories de feeds de Nomenclatures utilisées par le plugin appelant.

territoires_feed_indexer_hash()

Renvoie, pour la collection `feeds`, l'index du hash permettant de savoir si le ou les feeds récupérés sont obsolètes.


    
                    territoires_feed_indexer_hash(string $plugin, string $type) : string

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.

Return values

string —

Index du hash dans la réponse à la requête REST.

territoires_feed_acquerir()

Liste les feeds fournissant des informations de territoires d'une nature donnée exprimée sous la forme de catégories.


    
                    territoires_feed_acquerir(string $plugin, array<string|int, mixed> $categories_feed) : array<string|int, mixed>

Parameters

$plugin : string: Préfixe du plugin appelant.
$categories_feed : array<string|int, mixed>: Liste des catégories de feeds à acquérir.

Return values

array<string|int, mixed> —

Liste des feeds.

territoires_unite_peuplement_definir_collection()

Renvoie la collection de Nomenclatures à requêter en fonction de l’unité de peuplement concernée.


    
                    territoires_unite_peuplement_definir_collection(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : string

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.

Return values

string —

Identifiant de la collection.

territoires_unite_peuplement_definir_filtre()

Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction de l’unité de peuplement voire du service concerné.


    
                    territoires_unite_peuplement_definir_filtre(string $plugin, string $type[, null|string $pays = '' ][, null|string $service = '' ]) : array<string|int, mixed>

Parameters

$plugin : string: Préfixe du plugin appelant.
$type : string: Type de territoires. Prends les valeurs zone, country, subdivision, protected_area ou infrasubdivision.
$pays : null|string = '': Code ISO 3166-1 alpha2 du pays si le type est subdivision ou infrasubdivision sinon une chaine vide.
$service : null|string = '': Identifiant du feed Nomenclatures ayant permis le chargement. Est utilisé pour indexer la consignation dans le cas des contours uniquement. Sinon vaut chaine vide.

Return values

array<string|int, mixed> —

Filtres à appliquer à la collection.

territoires_upgrade()

Fonction d'installation et de mise à jour du plugin Territoires.


    
                    territoires_upgrade(string $nom_meta_base_version, string $version_cible) : void

Parameters

$nom_meta_base_version : string: Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP
$version_cible : string: Version du schéma de données dans ce plugin (déclaré dans paquet.xml)

territoires_vider_tables()

Fonction de désinstallation du plugin Territoires.


    
                    territoires_vider_tables(string $nom_meta_base_version) : void

Parameters

$nom_meta_base_version : string: Nom de la meta informant de la version du schéma de données du plugin installé dans SPIP

territoires_configurer()

Renvoie la configuration du plugin, soit statique (non modifiable), soit utilisateur (modifiable).


    
                    territoires_configurer([null|string $type_configuration = 'statique' ]) : array<string|int, mixed>

Parameters

$type_configuration : null|string = 'statique': Type de configuration. Prend les valeurs statique ou utilisateur.

Return values

array<string|int, mixed> —

Tableau de la configuration demandée.

territoires_adapter_config_statique()

Fonction de mise à jour de la config statique du plugin.


    
                    territoires_adapter_config_statique(array<string|int, mixed> $config_statique, array<string|int, mixed> $config_modifiable) : void

Parameters

$config_statique : array<string|int, mixed>: Nouvelle configuration statique
$config_modifiable : array<string|int, mixed>: Initialisation de la configuration modifiable (paramétrage)

territoires_chargement_initial()

Lance le chargement initial des unités de peuplement des régions du monde, des pays et des subdivisions et des infra-subbdivisions françaises.


    
                    territoires_chargement_initial() : void

territoires_maj_8_meta_peuplement()

Transfert de la meta de peuplement vers n metas, une par type.


    
                    territoires_maj_8_meta_peuplement() : void

territoires_maj_9_unite()

Prise en compte des nouveaux paramètres pour les unités.


    
                    territoires_maj_9_unite(array<string|int, mixed> $config_modifiable) : void

Parameters

$config_modifiable : array<string|int, mixed>

territoires_maj_12_info()

Prise en compte des nouveaux paramètres pour les unités.


    
                    territoires_maj_12_info(array<string|int, mixed> $config_statique, array<string|int, mixed> $config_modifiable) : void

Parameters

$config_statique : array<string|int, mixed>: Nouvelle configuration statique
$config_modifiable : array<string|int, mixed>: Initialisation de la configuration modifiable (paramétrage)

territoires_autoriser()

Fonction d'appel pour le pipeline.


    
                    territoires_autoriser() : mixed

autoriser_territoires_voir_dist()

Autorisation de voir la liste des territoires (page territoires).


    
                    autoriser_territoires_voir_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Tout le monde y est autorisé.

Parameters

$faire : string

Action demandée : voir

$type : string

Type d'objet sur lequel appliquer l'action : _territoires (ce n'est pas un objet au sens SPIP)

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_territoires_menu_dist()

Autorisation de voir l'élément de menu menant à la page des territoires.


    
                    autoriser_territoires_menu_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut être autorisé à voir la liste des territoires.

Parameters

$faire : string

Action demandée : menu

$type : string

Type d'objet sur lequel appliquer l'action : _territoires (ce n'est pas un objet au sens SPIP)

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_territoires_configurer_dist()

Autorisation de configurer le plugin (page configurer_territoires).


    
                    autoriser_territoires_configurer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut posséder l'autorisation standard de configuration.

Parameters

$faire : string

Action demandée : configurer

$type : string

Type d'objet sur lequel appliquer l'action : _territoires (ce n'est pas un objet au sens SPIP)

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_territoires_peupler_dist()

Autorisation de peupler ou dépeupler des territoires.


    
                    autoriser_territoires_peupler_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut posséder l'autorisation standard de configuration.

Parameters

$faire : string

Action demandée : peupler (idem que depleupler)

$type : string

Type d'objet sur lequel appliquer l'action : _territoires (ce n'est pas un objet au sens SPIP)

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_territoire_voir_dist()

Autorisation de voir (territoire).


    
                    autoriser_territoire_voir_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Tout le monde y est autorisé.

Parameters

$faire : string

Action demandée : voir

$type : string

Type d'objet sur lequel appliquer l'action : objet territoire

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_territoire_creer_dist()

Autorisation de créer un territoire.


    
                    autoriser_territoire_creer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il n'est pas possible de créer un territoire, seule la fonction de peuplement le peut.

Parameters

$faire : string

Action demandée : creer

$type : string

Type d'objet sur lequel appliquer l'action : objet territoire

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_territoire_modifier_dist()

Autorisation de modifier un territoire.


    
                    autoriser_territoire_modifier_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut être administrateur ou rédacteur pour être autorisé.

Parameters

$faire : string

Action demandée : modifier

$type : string

Type d'objet sur lequel appliquer l'action : objet territoire

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_territoire_supprimer_dist()

Autorisation de supprimer un territoire.


    
                    autoriser_territoire_supprimer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il n'est pas possible de supprimer un territoire, seule la fonction de dépeuplement le peut.

Parameters

$faire : string

Action demandée : supprimer

$type : string

Type d'objet sur lequel appliquer l'action : objet territoire

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_associerterritoires_dist()

Autorisation de lier/délier un territoire.


    
                    autoriser_associerterritoires_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut être un administrateur complet.

Parameters

$faire : string

Action demandée : associerterritoires

$type : string

Type d'objet sur lequel appliquer l'action : aucun

$id : int

Identifiant de l'objet : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

si null on prend alors visiteur_session
un id_auteur (on regarde dans la base)
un tableau auteur complet, y compris [restreint]

$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values

bool —

truesi l'auteur est autorisée à exécuter l'action, false sinon.

balise_TERRITOIRE_ASCENDANCE_dist()

Compile la balise `#TERRITOIRE_ASCENDANCE` qui renvoie l'ascendance d'un territoire donné désigne par son identifiant primaire.


    
                    balise_TERRITOIRE_ASCENDANCE_dist(Champ $p) : Champ

La signature de la balise est : #TERRITOIRE_ASCENDANCE{iso_territoire[, parent, ordre]}.

Parameters

$p : Champ: Pile au niveau de la balise.

Return values

Champ —

Pile complétée par le code à générer.

balise_TERRITOIRE_EXTRAS_dist()

Compile la balise `#TERRITOIRE_EXTRAS` qui renvoie tout ou partie des informations extras d'un territoire donné désigne par son identifiant primaire.


    
                    balise_TERRITOIRE_EXTRAS_dist(Champ $p) : Champ

La signature de la balise est : #TERRITOIRE_EXTRAS{iso_territoire[, information]}.

Parameters

$p : Champ: Pile au niveau de la balise.

Return values

Champ —

Pile complétée par le code à générer.

territoires_affiche_milieu()

Ajout de contenu sur certaines pages, notamment des formulaires de liaisons entre objets.


    
                    territoires_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>

Territoires ajoute les éventuels caractéristiques complémentaires et le formulaire d'association.

Parameters

$flux : array<string|int, mixed>: Données du pipeline

Return values

array<string|int, mixed> —

Données du pipeline modifiées pour refléter le traitement.

territoires_affiche_gauche()

Ajout de contenu dans la colonne « gauche » des pages de l’espace privé, notamment « la fiche objet » Territoires ajoute le bloc des codes alternatifs.


    
                    territoires_affiche_gauche(array<string|int, mixed> $flux) : array<string|int, mixed>

Parameters

$flux : array<string|int, mixed>: Données du pipeline

Return values

array<string|int, mixed> —

Données du pipeline modifiées pour refléter le traitement.

territoires_exclure_id_conditionnel()

Enlever l'id_territoire de la liste des critères conditionnels pour la table `spip_territoires` car cela peut renvoyer une liste vide si l'env contient déjà l'id du territoire.


    
                    territoires_exclure_id_conditionnel(array<string|int, mixed> $flux) : array<string|int, mixed>

Parameters

$flux : array<string|int, mixed>: Données du pipeline

Return values

array<string|int, mixed> —

Données du pipeline modifiées pour refléter le traitement.

territoires_pre_edition()

Complète l'action `modifier` d'un territoire avant modification: - en positionnant l'indicateur d'édition à `oui`afin que les modifications manuelles soient préservées lors d'un prochain rechargement.


    
                    territoires_pre_edition(array<string|int, mixed> $flux) : array<string|int, mixed>

Parameters

$flux : array<string|int, mixed>: Données du pipeline fournie en entrée (chaque pipeline possède une structure de donnée propre).

Return values

array<string|int, mixed> —

Données du pipeline modifiées pour refléter le traitement.

territoires_optimiser_base_disparus()

Optimiser la base de données Supprime les liens orphelins de l'objet vers quelqu'un et de quelqu'un vers l'objet.


    
                    territoires_optimiser_base_disparus(array<string|int, mixed> $flux) : array<string|int, mixed>

Parameters

$flux : array<string|int, mixed>: Données du pipeline

Return values

array<string|int, mixed> —

Données du pipeline modifiées pour refléter le traitement.

API Documentation

Table of Contents

Constants

Functions

Constants

_EXTRAIRE_MULTI

_TERRITOIRES_COEFF_MAX_DISTANT

_TERRITOIRES_COMPATIBILITE_ISOCODE

_TERRITOIRES_TIME_OUT_PEUPLEMENT

_TERRITOIRES_URL_BASE_ISOCODE

Functions

action_peupler_territoires_dist()

Tags

action_recharger_config_territoires_dist()

Tags

territoires_declarer_tables_interfaces()

Parameters

Tags

Return values

territoires_declarer_tables_objets_sql()

Parameters

Tags

Return values

territoires_declarer_tables_auxiliaires()

Parameters

Tags

Return values

territoires_cache_configurer()

Parameters

Return values

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

inc_requeter_isocode_dist()

Parameters

Tags

Return values

territoire_repertorier()

Parameters

Tags

Return values

territoire_lire_ascendance()

Parameters

Return values

territoire_lire_extras()

Parameters

Return values

unite_peuplement_charger()

Parameters

Tags

Return values

unite_peuplement_charger_asynchrone()

Parameters