Contours des territoires

Géolocaliser des territoires

Version 1.1.1 (2e1e42d)

Packages

Application

SPIP / CONTOURS

API
OBJET

Reports

Deprecated

Errors

Markers

Indices

Files

Documentation générée le 25 12 2023 à 08h15

Documentation

Packages

Application
SPIP

Constants

_CONTOUR_COMPATIBILITE_ISOCODE = ['vmin' => '2.0.1']: Endpoint de l'API REST hébergeant les données de Nomenclatures.
_CONTOUR_URL_BASE_ISOCODE = 'https://contrib.spip.net/http.api/ezrest': Endpoint de l'API REST hébergeant les données de Nomenclatures.

Functions

contours_upgrade() : void: Fonction d'installation et de mise à jour du plugin.
contours_vider_tables() : void: Fonction de désinstallation du plugin.
contours_maj_2() : void: Transfert de la meta de peuplement vers 4 metas, une par type et suppression des contours.
contours_affiche_milieu() : array<string|int, mixed>: Ajout de contenu sur la partie centrale, en fin de page.
contours_afficher_contenu_objet() : array<string|int, mixed>: Insertion dans le bloc wysiwyg d'une fiche objet.
contours_post_peupler_territoire() : array<string|int, mixed>: Complément à la fonction de peuplement des territoires.
contours_post_preserver_territoire() : array<string|int, mixed>: Complément à la fonction de préservation des liens et des éditions de territoires.
contours_post_depeupler_territoire() : array<string|int, mixed>: Complément à la fonction de dépeuplement des territoires.
contours_gis_modele_parametres_autorises() : array<string|int, mixed>: Déclaration des arguments supplémentaires utilisables dans le modele pour gis.
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.
unite_peuplement_contour_charger() : array<string|int, mixed>: Ajoute des contours géolocalisés aux territoires.
unite_peuplement_contour_vider() : array<string|int, mixed>: Supprime des contours géolocalisés de territoires.
contours_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.
contours_feed_initialiser_url_base() : string: Renvoie l'URL de base du serveur Nomenclatures fournissant des informations sur les territoires.
contours_feed_categorie_lister() : array<string|int, mixed>: Renvoie la liste des catégories de feed de Nomenclatures correspondant à la nature des informations demandées.
contours_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.
contours_unite_peuplement_definir_collection() : string: Renvoie, la collection de Nomenclatures à requêter en fonction du type de territoires concerné.
contours_unite_peuplement_definir_filtre() : array<string|int, mixed>: Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction du type de territoires, du pays voire du service concernés.

_CONTOUR_COMPATIBILITE_ISOCODE

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


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

_CONTOUR_URL_BASE_ISOCODE

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


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

contours_upgrade()

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


    
                    contours_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)

contours_vider_tables()

Fonction de désinstallation du plugin.


    
                    contours_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

contours_maj_2()

Transfert de la meta de peuplement vers 4 metas, une par type et suppression des contours.


    
                    contours_maj_2() : void

contours_affiche_milieu()

Ajout de contenu sur la partie centrale, en fin de page.


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

Contours rajoute un formulaire de peuplement des contours dans la page de peuplement de Territoires.

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.

contours_afficher_contenu_objet()

Insertion dans le bloc wysiwyg d'une fiche objet.


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

Le plugin Contours ajoute la carte du territoire si elle existe sans référence à l'objet GIS.

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.

contours_post_peupler_territoire()

Complément à la fonction de peuplement des territoires.


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

Contours rétablit les éventuels liens entre les territoires concernés et les contours GIS qui existaient avant le chargement (spip_gis_liens).

Parameters

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

Return values

array<string|int, mixed> —

Données du pipeline telles que reçues.

contours_post_preserver_territoire()

Complément à la fonction de préservation des liens et des éditions de territoires.


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

Contours sauvegarde les éventuels liens entre les territoires concernés et des contours GIS (spip_gis_liens).

Parameters

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

Return values

array<string|int, mixed> —

Données du pipeline modifiées en rajoutant la liste des liens à préserver.

contours_post_depeupler_territoire()

Complément à la fonction de dépeuplement des territoires.


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

Contours supprime les liens éventuels entre les territoires concernés et des objets GIS (spip_gis_liens).

Parameters

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

Return values

array<string|int, mixed> —

Données du pipeline telles que reçues.

contours_gis_modele_parametres_autorises()

Déclaration des arguments supplémentaires utilisables dans le modele pour gis.


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

Les arguments iso_parent, iso_pays pourront être passés au modèle.

Parameters

$flux : array<string|int, mixed>: Arguments acceptés pour le modèle

Return values

array<string|int, mixed> —

Arguments acceptés pour le modèle complétés.

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.

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.

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.

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.

unite_peuplement_contour_charger()

Ajoute des contours géolocalisés aux territoires.


    
                    unite_peuplement_contour_charger(string $type, string $pays, string $service) : array<string|int, mixed>

Les territoires sont identifiés par groupe via le couple (type, pays).

Parameters

$type : string: Type de territoires à peupler. Prends les valeurs zone, country ou subdivision.
$pays : string: Code ISO 3166-1 alpha2 du pays dont on veut peupler les subdivisions. N'est utilisé que si le type choisi est subdivision.
$service : string: Identifiant du service 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> —

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_contour_vider()

Supprime des contours géolocalisés de territoires.


    
                    unite_peuplement_contour_vider(string $type, string $pays, string $service) : array<string|int, mixed>

Les territoires sont identifiés par groupe via le couple (type, pays).

Parameters

$type : string: Type de territoires à peupler. Prends les valeurs zone, country ou subdivision.
$pays : string: Code ISO 3166-1 alpha2 du pays dont on veut peupler les subdivisions. N'est utilisé que si le type choisi est subdivision, sinon vaut chaine vide.
$service : string: Identifiant du service 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> —

Liste des code ISO 3166-1 alpha2 des pays chargés sous la forme [code] = nom multi.

contours_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.


    
                    contours_serveur_definir_compatibilite() : 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.).

Return values

array<string|int, mixed> —

Bornes de compatibilité avec le serveur.

contours_feed_initialiser_url_base()

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


    
                    contours_feed_initialiser_url_base() : string

Return values

string —

URL de base du serveur REST

contours_feed_categorie_lister()

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


    
                    contours_feed_categorie_lister() : array<string|int, mixed>

Return values

array<string|int, mixed> —

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

contours_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.


    
                    contours_feed_indexer_hash(string $type) : string

Parameters

$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.

contours_unite_peuplement_definir_collection()

Renvoie, la collection de Nomenclatures à requêter en fonction du type de territoires concerné.


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

Pour le plugin Contours, seule la collection contours est utilisée.

Parameters

$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.

contours_unite_peuplement_definir_filtre()

Renvoie, les filtres à appliquer à la requête Nomenclatures en fonction du type de territoires, du pays voire du service concernés.


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

Parameters

$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.

Documentation

Table of Contents

Packages

Constants

Functions

Constants

_CONTOUR_COMPATIBILITE_ISOCODE

_CONTOUR_URL_BASE_ISOCODE

Functions

contours_upgrade()

Parameters

contours_vider_tables()

Parameters

contours_maj_2()

contours_affiche_milieu()

Parameters

Tags

Return values

contours_afficher_contenu_objet()

Parameters

Return values

contours_post_peupler_territoire()

Parameters

Tags

Return values

contours_post_preserver_territoire()

Parameters

Tags

Return values

contours_post_depeupler_territoire()

Parameters

Tags

Return values

contours_gis_modele_parametres_autorises()

Parameters

Return values

formulaires_peupler_contours_charger()

Parameters

Tags

Return values

formulaires_peupler_contours_verifier()

Parameters

Return values

formulaires_peupler_contours_traiter()

Parameters

Tags

Return values

formulaires_peupler_contours_notifier()

Parameters

Tags

Return values

unite_peuplement_contour_charger()

Parameters

Tags

Return values

unite_peuplement_contour_vider()

Parameters

Tags

Return values

contours_serveur_definir_compatibilite()

Tags

Return values

contours_feed_initialiser_url_base()

Return values

contours_feed_categorie_lister()

Return values

contours_feed_indexer_hash()

Parameters

Return values

contours_unite_peuplement_definir_collection()

Parameters

Return values

contours_unite_peuplement_definir_filtre()

Parameters

Return values